Commit fdaca560 authored by Mingwei Zhang's avatar Mingwei Zhang Committed by Sean Christopherson
Browse files

KVM: Documentation: Update the field name gfns and its description in kvm_mmu_page 



Update the field 'gfns' in kvm_mmu_page to 'shadowed_translation' to be
consistent with the code. Also update the corresponding 'gfns' in the
comments. The more detailed description of 'shadowed_translation' is
already inlined in the data structure definition, so no need to duplicate
the text but simply just update the names.

Signed-off-by: default avatarMingwei Zhang <mizhang@google.com>
Reviewed-by: default avatarKai Huang <kai.huang@intel.com>
Link: https://lore.kernel.org/r/20230912184553.1887764-3-mizhang@google.com


Signed-off-by: default avatarSean Christopherson <seanjc@google.com>
parent b207cfbc

Documentation/virt/kvm/x86/mmu.rst

+8 −5
Original line number Diff line number Diff line
@@ -221,11 +221,14 @@ Shadow pages contain the following information: 
    at __pa(sp2->spt).  sp2 will point back at sp1 through parent_pte.

    The spt array forms a DAG structure with the shadow page as a node, and

    guest pages as leaves.

  gfns:

    An array of 512 guest frame numbers, one for each present pte.  Used to

    perform a reverse map from a pte to a gfn. When role.direct is set, any

    element of this array can be calculated from the gfn field when used, in

    this case, the array of gfns is not allocated. See role.direct and gfn.

  shadowed_translation:

    An array of 512 shadow translation entries, one for each present pte. Used

    to perform a reverse map from a pte to a gfn as well as its access

    permission. When role.direct is set, the shadow_translation array is not

    allocated. This is because the gfn contained in any element of this array

    can be calculated from the gfn field when used.  In addition, when

    role.direct is set, KVM does not track access permission for each of the

    gfn. See role.direct and gfn.

  root_count:

    A counter keeping track of how many hardware registers (guest cr3 or

    pdptrs) are now pointing at the page.  While this counter is nonzero, the