Commit ef1ead0c authored by David Gibson's avatar David Gibson Committed by Paul Mackerras
Browse files

KVM: PPC: Book3S HV: HPT resizing documentation and reserved numbers 



This adds a new powerpc-specific KVM_CAP_SPAPR_RESIZE_HPT capability to
advertise whether KVM is capable of handling the PAPR extensions for
resizing the hashed page table during guest runtime.  It also adds
definitions for two new VM ioctl()s to implement this extension, and
documentation of the same.

Note that, HPT resizing is already possible with KVM PR without kernel
modification, since the HPT is managed within userspace (qemu).  The
capability defined here will only be set where an in-kernel implementation
of resizing is necessary, i.e. for KVM HV.  To determine if the userspace
resize implementation can be used, it's necessary to check
KVM_CAP_PPC_ALLOC_HTAB.  Unfortunately older kernels incorrectly set
KVM_CAP_PPC_ALLOC_HTAB even with KVM PR.  If userspace it want to support
resizing with KVM PR on such kernels, it will need a workaround.

Signed-off-by: default avatarDavid Gibson <david@gibson.dropbear.id.au>
Signed-off-by: default avatarPaul Mackerras <paulus@ozlabs.org>
parent ccc4df4e

Documentation/virtual/kvm/api.txt

+95 −0
Original line number Diff line number Diff line
@@ -3266,6 +3266,101 @@ 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

	 -ENOMEM if unable to allocate the new HPT

	 -ENOSPC if there was a hash collision 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.



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

milliseconds until preparation is complete.



If called when there is a pending HPT whose size does not match that

requested in the parameters, discards the existing pending HPT and

creates a new one as above.



If called when there is a pending HPT of the size requested, will:

  * If preparation of the pending HPT is already complete, return 0

  * If preparation of the pending HPT has failed, return an error

    code, then discard the pending HPT.

  * If preparation of the pending HPT is still in progress, return an

    estimated number of milliseconds until preparation is complete.



If called with shift == 0, discards any currently pending HPT and

returns 0 (i.e. cancels any in-progress preparation).



flags is reserved for future expansion, currently setting any bits in

flags will result in an -EINVAL.



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



Capability: KVM_CAP_SPAPR_RESIZE_HPT

Architectures: powerpc

Type: vm ioctl

Parameters: struct kvm_ppc_resize_hpt (in)

Returns: 0 on successful completion,

         -EFAULT if struct kvm_reinject_control cannot be read,

	 -EINVAL if the supplied shift or flags are invalid

	 -ENXIO is there is no pending HPT, or the pending HPT doesn't

                 have the requested size

	 -EBUSY if the pending HPT is not fully prepared

	 -ENOSPC if there was a hash collision 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 requests that the guest be

transferred to working with the new HPT, essentially implementing the

H_RESIZE_HPT_COMMIT hypercall.



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

-EBUSY, though others may be possible if the preparation was started,

but failed).



This will have undefined effects on the guest if it has not already

placed itself in a quiescent state where no vcpu will make MMU enabled

memory accesses.



On succsful completion, the pending HPT will become the guest's active

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;

};



5. The kvm_run structure

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

include/uapi/linux/kvm.h

+11 −0
Original line number Diff line number Diff line
@@ -685,6 +685,13 @@ struct kvm_ppc_smmu_info { 
	struct kvm_ppc_one_seg_page_size sps[KVM_PPC_PAGE_SIZES_MAX_SZ];

};



/* for KVM_PPC_RESIZE_HPT_{PREPARE,COMMIT} */

struct kvm_ppc_resize_hpt {

	__u64 flags;

	__u32 shift;

	__u32 pad;

};



#define KVMIO 0xAE



/* machine type bits, to be used as argument to KVM_CREATE_VM */
@@ -871,6 +878,7 @@ struct kvm_ppc_smmu_info { 
#define KVM_CAP_S390_USER_INSTR0 130

#define KVM_CAP_MSI_DEVID 131

#define KVM_CAP_PPC_HTM 132

#define KVM_CAP_SPAPR_RESIZE_HPT 133

#define KVM_CAP_PPC_MMU_RADIX 134

#define KVM_CAP_PPC_MMU_HASH_V3 135
@@ -1189,6 +1197,9 @@ struct kvm_s390_ucas_mapping { 
#define KVM_ARM_SET_DEVICE_ADDR	  _IOW(KVMIO,  0xab, struct kvm_arm_device_addr)

/* Available with KVM_CAP_PPC_RTAS */

#define KVM_PPC_RTAS_DEFINE_TOKEN _IOW(KVMIO,  0xac, struct kvm_rtas_token_args)

/* Available with KVM_CAP_SPAPR_RESIZE_HPT */

#define KVM_PPC_RESIZE_HPT_PREPARE _IOR(KVMIO, 0xad, struct kvm_ppc_resize_hpt)

#define KVM_PPC_RESIZE_HPT_COMMIT  _IOR(KVMIO, 0xae, struct kvm_ppc_resize_hpt)

/* Available with KVM_CAP_PPC_RADIX_MMU or KVM_CAP_PPC_HASH_MMU_V3 */

#define KVM_PPC_CONFIGURE_V3_MMU  _IOW(KVMIO,  0xaf, struct kvm_ppc_mmuv3_cfg)

/* Available with KVM_CAP_PPC_RADIX_MMU */

CRA Git | Maintained and supported by SUSTech CRA and CCSE