virt/kvm/api.rst

96   Capability:
102       support this ioctl, there's no capability bit to check its
124 :Capability: basic
141 :Capability: basic
181 is dependent on the CPU capability and the kernel configuration. The limit can
188 Please note that configuring the IPA size does not affect the capability
197 :Capability: basic, KVM_CAP_GET_MSR_FEATURES for KVM_GET_MSR_FEATURE_INDEX_LIST
239 :Capability: basic, KVM_CAP_CHECK_EXTENSION_VM for vm ioctl
258 :Capability: basic
272 :Capability: basic
284 :Capability: basic
312 same partition.)  The KVM_CAP_PPC_SMT capability indicates the number
331 :Capability: basic
357 the KVM_CAP_MULTI_ADDRESS_SPACE capability.
361 see the description of the capability.
366 :Capability: basic
378 :Capability: basic
405 :Capability: basic
438 :Capability: basic
452 :Capability: basic
483 :Capability: basic
496 :Capability: basic
523 :Capability: basic
597 :Capability: basic
609 :Capability: basic (vcpu), KVM_CAP_GET_MSR_FEATURES (system)
649 :Capability: basic
671 :Capability: basic
706 :Capability: basic
732 :Capability: basic
761 :Capability: basic
790 :Capability: KVM_CAP_IRQCHIP, KVM_CAP_S390_IRQCHIP (s390)
805 Note that on s390 the KVM_CAP_S390_IRQCHIP vm capability needs to be enabled
812 :Capability: KVM_CAP_IRQCHIP
833 capability is present (or unless it is not using the in-kernel irqchip,
863 Note that on arm/arm64, the KVM_CAP_IRQCHIP capability only conditions
881 :Capability: KVM_CAP_IRQCHIP
906 :Capability: KVM_CAP_IRQCHIP
931 :Capability: KVM_CAP_XEN_HVM
959 :Capability: KVM_CAP_ADJUST_CLOCK
992 :Capability: KVM_CAP_ADJUST_CLOCK
1014 :Capability: KVM_CAP_VCPU_EVENTS
1133 :Capability: KVM_CAP_VCPU_EVENTS
1196 :Capability: KVM_CAP_DEBUGREGS
1218 :Capability: KVM_CAP_DEBUGREGS
1233 :Capability: KVM_CAP_USER_MEMORY
1262 KVM_CAP_MULTI_ADDRESS_SPACE capability.  Slots in separate address spaces
1285 use it.  The latter can be set, if KVM_CAP_READONLY_MEM capability allows it,
1289 When the KVM_CAP_SYNC_MMU capability is available, changes in the backing of
1302 :Capability: KVM_CAP_SET_TSS_ADDR
1322 :Capability: KVM_CAP_ENABLE_CAP
1328 :Capability: KVM_CAP_ENABLE_CAP_VM
1342 To check if a capability can be enabled, the KVM_CHECK_EXTENSION ioctl should
1351 The capability that is supposed to get enabled.
1377 :Capability: KVM_CAP_MP_STATE
1425 :Capability: KVM_CAP_MP_STATE
1447 :Capability: KVM_CAP_SET_IDENTITY_MAP_ADDR
1471 :Capability: KVM_CAP_SET_BOOT_CPU_ID
1485 :Capability: KVM_CAP_XSAVE
1504 :Capability: KVM_CAP_XSAVE
1523 :Capability: KVM_CAP_XCRS
1550 :Capability: KVM_CAP_XCRS
1577 :Capability: KVM_CAP_EXT_CPUID
1662 :Capability: KVM_CAP_PPC_GET_PVINFO
1692 :Capability: KVM_CAP_IRQ_ROUTING
1740   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
1741   the device ID.  If this capability is not available, userspace should
1767 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
1790 :Capability: KVM_CAP_TSC_CONTROL
1803 :Capability: KVM_CAP_GET_TSC_KHZ
1817 :Capability: KVM_CAP_IRQCHIP
1848 :Capability: KVM_CAP_IRQCHIP
1865 regs field) depends on the state of the KVM_CAP_X2APIC_API capability.
1872 :Capability: KVM_CAP_IOEVENTFD
1918 :Capability: KVM_CAP_SW_TLB
1954 :Capability: KVM_CAP_SPAPR_TCE
1963 and provides a scatter/gather capability for PAPR virtual I/O.
1993 :Capability: KVM_CAP_PPC_RMA
2020 The KVM_CAP_PPC_RMA capability is 1 or 2 if the KVM_ALLOCATE_RMA ioctl
2029 :Capability: KVM_CAP_USER_NMI
2056 :Capability: KVM_CAP_S390_UCONTROL
2078 :Capability: KVM_CAP_S390_UCONTROL
2100 :Capability: KVM_CAP_S390_UCONTROL
2118 :Capability: KVM_CAP_ONE_REG
2557 :Capability: KVM_CAP_ONE_REG
2587 :Capability: KVM_CAP_KVMCLOCK_CTRL
2611 :Capability: KVM_CAP_SIGNAL_MSI
2633   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
2634   the device ID.  If this capability is not available, userspace
2642 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
2650 :Capability: KVM_CAP_PIT2
2683 :Capability: KVM_CAP_PIT_STATE2
2709 :Capability: KVM_CAP_PIT_STATE2
2724 :Capability: KVM_CAP_PPC_GET_SMMU_INFO
2799 :Capability: KVM_CAP_IRQFD
2838 :Capability: KVM_CAP_PPC_ALLOC_HTAB
2847 virtualization.  Otherwise the capability doesn't exist and the ioctl
2875 :Capability: basic
2930 :Capability: KVM_CAP_PPC_HTAB_FD
2985 :Capability: KVM_CAP_DEVICE_CTRL
3023 :Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
3058 :Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
3079 :Capability: basic
3165 :Capability: basic
3194 :Capability: basic
3221 :Capability: KVM_CAP_ARM_SET_DEVICE_ADDR
3270 :Capability: KVM_CAP_PPC_RTAS
3290 :Capability: KVM_CAP_SET_GUEST_DEBUG
3336 For ppc, the KVM_CAP_PPC_GUEST_DEBUG_SSTEP capability indicates whether
3346 :Capability: KVM_CAP_EXT_EMUL_CPUID
3421 :Capability: KVM_CAP_S390_MEM_OP
3457 KVM_CAP_S390_MEM_OP capability. "buf" is the buffer supplied by the
3470 :Capability: KVM_CAP_S390_SKEYS
3502 :Capability: KVM_CAP_S390_SKEYS
3530 :Capability: KVM_CAP_S390_INJECT_IRQ
3590 :Capability: KVM_CAP_S390_IRQ_STATE
3625 :Capability: KVM_CAP_S390_IRQ_STATE
3663 :Capability: KVM_CAP_X86_SMM
3674 :Capability: KVM_CAP_PPC_MULTITCE
3678 This capability means the kernel is capable of handling hypercalls
3695 This capability is always enabled.
3700 :Capability: KVM_CAP_SPAPR_TCE_64
3709 This capability uses extended struct in ioctl interface::
3733 :Capability: KVM_CAP_REINJECT_CONTROL
3760 :Capability: KVM_CAP_PPC_RADIX_MMU or KVM_CAP_PPC_HASH_MMU_V3
3794 :Capability: KVM_CAP_PPC_RADIX_MMU
3831 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
3867 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
3922 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
3967 :Capability: KVM_CAP_MCE
3980 :Capability: KVM_CAP_MCE
3987          -EINVAL if requested MCE capability is not supported.
3999 :Capability: KVM_CAP_MCE
4033 :Capability: KVM_CAP_S390_CMMA_MIGRATION
4128 :Capability: KVM_CAP_S390_CMMA_MIGRATION
4176 :Capability: KVM_CAP_PPC_GET_CPU_CHAR
4223 :Capability: basic
4240 :Capability: basic
4264 :Capability: basic
4276 :Capability: KVM_CAP_HYPERV_EVENTFD
4311 :Capability: KVM_CAP_NESTED_STATE
4385 :Capability: KVM_CAP_NESTED_STATE
4397 :Capability: KVM_CAP_COALESCED_MMIO (for coalesced mmio)
4426 :Capability: KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
4459 the KVM_CAP_MULTI_ADDRESS_SPACE capability.
4462 is enabled; for more information, see the description of the capability.
4469 :Capability: KVM_CAP_HYPERV_CPUID
4574 :Capability: KVM_CAP_PMU_EVENT_FILTER
4608 :Capability: basic
4632 :Capability: KVM_CAP_S390_VCPU_RESETS
4644 :Capability: none
4657 :Capability: KVM_CAP_S390_VCPU_RESETS
4671 :Capability: KVM_CAP_S390_PROTECTED
4724 :Capability: KVM_X86_SET_MSR_FILTER
5269 this capability at VM creation. Once this is done, these types of errors will
5292 Used on x86 systems. When the VM capability KVM_CAP_X86_USER_SPACE_MSR is
5372       whether this is a per-vcpu or per-vm capability.
5375       what parameters are accepted by the capability.
5390 This capability enables interception of OSI hypercalls that otherwise would
5395 When this capability is enabled, KVM_EXIT_OSI can occur.
5406 This capability enables interception of PAPR hypercalls. PAPR hypercalls are
5416 When this capability is enabled, KVM_EXIT_PAPR_HCALL can occur.
5474 This capability enables support for handling of channel I/O instructions.
5479 When this capability is enabled, KVM_EXIT_S390_TSCH will occur on TEST
5482 Note that even though this capability is enabled per-vcpu, the complete
5493 This capability enables or disables the delivery of interrupts through the
5502 When this capability is enabled, KVM_EXIT_EPR can occur.
5511 This capability connects the vcpu to an in-kernel MPIC device.
5521 This capability connects the vcpu to an in-kernel XICS device.
5530 This capability enables the in-kernel irqchip for s390. Please refer to
5540 This capability allows the use of the host Floating Point Unit by the guest. It
5554 This capability allows the use of the MIPS SIMD Architecture (MSA) by the guest.
5614 This capability connects the vcpu to an in-kernel XIVE device.
5631       what parameters are accepted by the capability.
5645 This capability controls whether individual sPAPR hypercalls (hcalls)
5650 before this capability was implemented.  If disabled, the kernel will
5666 This capability controls which SIGP orders will be handled completely in user
5667 space. With this capability enabled, all fast orders will be handled completely
5679 in the hardware prior to interception). If this capability is not enabled, the
5699 This capability allows post-handlers for the STSI instruction. After
5735 This capability also enables in kernel routing of interrupt requests;
5783 With this capability enabled, all illegal instructions 0x0000 (2 bytes) will
5789 This capability can be enabled dynamically even if VCPUs were already
5817 Enabling this capability on a VM provides userspace with a way to set
5822 be 0.  A successful call to enable this capability will result in
5823 vsmt_mode being returned when the KVM_CAP_PPC_SMT capability is
5824 subsequently queried for the VM.  This capability is only supported by
5826 The KVM_CAP_PPC_SMT_POSSIBLE capability indicates which virtual SMT
5835 With this capability a machine check exception in the guest address
5838 machine check handling routine. Without this capability KVM will
5855 Enabling this capability on a VM provides userspace with a way to no
5873 With this capability the KVM support for memory backing with 1m pages
5874 through hugetlbfs can be enabled for a VM. After the capability is
5880 this capability, the VM will not be able to run.
5888 With this capability, a guest may read the MSR_PLATFORM_INFO MSR. Otherwise,
5890 capability does not enable write permissions of this MSR for the guest.
5903 state).  Enabling this capability on a VM depends on the CPU having
5913 With this capability enabled, CR2 will not be modified prior to the
5925 This capability also enables exception.pending in struct
5979 This capability indicates that KVM is running on a host that has
5987 If present, this capability can be enabled for a VM, meaning that KVM
5999 This capability overrides the kvm module parameter halt_poll_ns for the
6004 controlled by the kvm module parameter halt_poll_ns. This capability allows
6016 This capability enables trapping of #GP invoking RDMSR and WRMSR instructions
6024 this capability. With it enabled, MSR accesses that match the mask specified in
6041 This capability, if KVM_CHECK_EXTENSION indicates that it is
6045 with the KVM_CAP_PPC_ENABLE_HCALL capability.
6052 This capability, if KVM_CHECK_EXTENSION indicates that it is
6058 capability via KVM_ENABLE_CAP ioctl on the vcpu fd. Note that this
6067 This capability, if KVM_CHECK_EXTENSION indicates that it is
6077 This capability, if KVM_CHECK_EXTENSION indicates that it is
6087 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
6093 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
6117 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
6123 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
6131 This capability indicates the supported architecture type of the guest, i.e. the
6134 The values returned when this capability is checked by KVM_CHECK_EXTENSION on a
6159 This capability, if KVM_CHECK_EXTENSION indicates that it is available, means
6182 number larger than 0 indicating the version of this capability is implemented
6202 Querying this capability returns a bitmap indicating the possible
6212 This capability enables a newer version of Hyper-V Synthetic interrupt
6222 This capability indicates that userspace can load HV_X64_MSR_VP_INDEX msr.  Its
6225 capability is absent, userspace can still query this msr's value.
6233 This capability indicates if the flic device will be able to get/set the
6242 This capability indicates that the PSW is exposed via the kvm_run structure.
6249 This capability indicates that the user space memory used as guest mapping can
6258 This capability indicates that the user space memory used as guest mapping can
6267 This capability indicates that kvm will implement the interfaces to handle
6269 facility 82 should not be provided to the guest without this capability.
6276 This capability indicates that KVM supports paravirtualized Hyper-V TLB Flush
6286 This capability indicates that userspace can specify (via the
6289 If KVM advertises this capability, userspace can only specify the ISS field for
6301 This capability indicates that KVM supports paravirtualized Hyper-V IPI send
6310 This capability indicates that KVM running on top of Hyper-V hypervisor
6314 KVM, enabling this capability effectively disables all hypercall
6325 This capability indicates that the KVM_S390_NORMAL_RESET and
6333 This capability indicates that the Ultravisor has been initialized and
6335 This capability governs the KVM_S390_PV_COMMAND ioctl and the
6344 This capability indicates that KVM supports steal time accounting.
6346 architecture-specific interfaces.  This capability and the architecture-
6357 This capability enables a guest to set information about its control program
6369 If this capability is available, then the CPNC and CPVC can be synchronized
6377 This capability indicates that KVM supports deflection of MSR reads and
6388 This capability indicates that KVM supports that accesses to user defined MSRs
6389 may be rejected. With this capability exposed, KVM exports new VM ioctl