Commit e2a0fcac authored by Paolo Bonzini's avatar Paolo Bonzini
Browse files

Documentation: kvm: fix messy conversion from .txt to .rst 



Building the documentation gives a warning that the KVM_PPC_RESIZE_HPT_PREPARE
label is defined twice.  The root cause is that the KVM_PPC_RESIZE_HPT_PREPARE
API is present twice, the second being a mix of the prepare and commit APIs.
Fix it.

Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 2df8d380

Documentation/virt/kvm/api.rst

+16 −53
Original line number Diff line number Diff line
@@ -3856,49 +3856,20 @@ base 2 of the page size in the bottom 6 bits. 
         -EFAULT if struct kvm_reinject_control cannot be read,

	 -EINVAL if the supplied shift or flags are invalid,

	 -ENOMEM if unable to allocate the new HPT,

	 -ENOSPC if there was a hash collision



::



  struct kvm_ppc_rmmu_info {

	struct kvm_ppc_radix_geom {

		__u8	page_shift;

		__u8	level_bits[4];

		__u8	pad[3];

	}	geometries[8];

	__u32	ap_encodings[8];

  };



The geometries[] field gives up to 8 supported geometries for the

radix page table, in terms of the log base 2 of the smallest page

size, and the number of bits indexed at each level of the tree, from

the PTE level up to the PGD level in that order.  Any unused entries

will have 0 in the page_shift field.



The ap_encodings gives the supported page sizes and their AP field

encodings, encoded with the AP value in the top 3 bits and the log

base 2 of the page size in the bottom 6 bits.



4.102 KVM_PPC_RESIZE_HPT_PREPARE

--------------------------------



:Capability: KVM_CAP_SPAPR_RESIZE_HPT

:Architectures: powerpc

:Type: vm ioctl

:Parameters: struct kvm_ppc_resize_hpt (in)

:Returns: 0 on successful completion,

	 >0 if a new HPT is being prepared, the value is an estimated

         number of milliseconds until preparation is complete,

         -EFAULT if struct kvm_reinject_control cannot be read,

	 -EINVAL if the supplied shift or flags are invalid,when moving existing

         HPT entries to the new HPT,

	 -EIO on other error conditions



Used to implement the PAPR extension for runtime resizing of a guest's

Hashed Page Table (HPT).  Specifically this starts, stops or monitors

the preparation of a new potential HPT for the guest, essentially

implementing the H_RESIZE_HPT_PREPARE hypercall.



::



  struct kvm_ppc_resize_hpt {

	__u64 flags;

	__u32 shift;

	__u32 pad;

  };



If called with shift > 0 when there is no pending HPT for the guest,

this begins preparation of a new pending HPT of size 2^(shift) bytes.

It then returns a positive integer with the estimated number of
@@ -3926,14 +3897,6 @@ Normally this will be called repeatedly with the same parameters until 
it returns <= 0.  The first call will initiate preparation, subsequent

ones will monitor preparation until it completes or fails.



::



  struct kvm_ppc_resize_hpt {

	__u64 flags;

	__u32 shift;

	__u32 pad;

  };



4.103 KVM_PPC_RESIZE_HPT_COMMIT

-------------------------------
@@ -3956,6 +3919,14 @@ Hashed Page Table (HPT). Specifically this requests that the guest be 
transferred to working with the new HPT, essentially implementing the

H_RESIZE_HPT_COMMIT hypercall.



::



  struct kvm_ppc_resize_hpt {

	__u64 flags;

	__u32 shift;

	__u32 pad;

  };



This should only be called after KVM_PPC_RESIZE_HPT_PREPARE has

returned 0 with the same parameters.  In other cases

KVM_PPC_RESIZE_HPT_COMMIT will return an error (usually -ENXIO or
@@ -3971,14 +3942,6 @@ HPT and the previous HPT will be discarded. 


On failure, the guest will still be operating on its previous HPT.



::



  struct kvm_ppc_resize_hpt {

	__u64 flags;

	__u32 shift;

	__u32 pad;

  };



4.104 KVM_X86_GET_MCE_CAP_SUPPORTED

-----------------------------------