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
185 Please note that configuring the IPA size does not affect the capability
194 :Capability: basic, KVM_CAP_GET_MSR_FEATURES for KVM_GET_MSR_FEATURE_INDEX_LIST
236 :Capability: basic, KVM_CAP_CHECK_EXTENSION_VM for vm ioctl
255 :Capability: basic
269 :Capability: basic
281 :Capability: basic
309 same partition.)  The KVM_CAP_PPC_SMT capability indicates the number
328 :Capability: basic
354 the KVM_CAP_MULTI_ADDRESS_SPACE capability.
358 see the description of the capability.
363 :Capability: basic
375 :Capability: basic
397 :Capability: basic
430 :Capability: basic
444 :Capability: basic
475 :Capability: basic
488 :Capability: basic
515 :Capability: basic
589 :Capability: basic
601 :Capability: basic (vcpu), KVM_CAP_GET_MSR_FEATURES (system)
641 :Capability: basic
663 :Capability: basic
698 :Capability: basic
724 :Capability: basic
753 :Capability: basic
782 :Capability: KVM_CAP_IRQCHIP, KVM_CAP_S390_IRQCHIP (s390)
797 Note that on s390 the KVM_CAP_S390_IRQCHIP vm capability needs to be enabled
804 :Capability: KVM_CAP_IRQCHIP
825 capability is present (or unless it is not using the in-kernel irqchip,
855 Note that on arm/arm64, the KVM_CAP_IRQCHIP capability only conditions
873 :Capability: KVM_CAP_IRQCHIP
898 :Capability: KVM_CAP_IRQCHIP
923 :Capability: KVM_CAP_XEN_HVM
951 :Capability: KVM_CAP_ADJUST_CLOCK
984 :Capability: KVM_CAP_ADJUST_CLOCK
1006 :Capability: KVM_CAP_VCPU_EVENTS
1125 :Capability: KVM_CAP_VCPU_EVENTS
1188 :Capability: KVM_CAP_DEBUGREGS
1210 :Capability: KVM_CAP_DEBUGREGS
1225 :Capability: KVM_CAP_USER_MEMORY
1254 KVM_CAP_MULTI_ADDRESS_SPACE capability.  Slots in separate address spaces
1274 use it.  The latter can be set, if KVM_CAP_READONLY_MEM capability allows it,
1278 When the KVM_CAP_SYNC_MMU capability is available, changes in the backing of
1291 :Capability: KVM_CAP_SET_TSS_ADDR
1311 :Capability: KVM_CAP_ENABLE_CAP
1317 :Capability: KVM_CAP_ENABLE_CAP_VM
1331 To check if a capability can be enabled, the KVM_CHECK_EXTENSION ioctl should
1340 The capability that is supposed to get enabled.
1366 :Capability: KVM_CAP_MP_STATE
1414 :Capability: KVM_CAP_MP_STATE
1436 :Capability: KVM_CAP_SET_IDENTITY_MAP_ADDR
1460 :Capability: KVM_CAP_SET_BOOT_CPU_ID
1474 :Capability: KVM_CAP_XSAVE
1493 :Capability: KVM_CAP_XSAVE
1512 :Capability: KVM_CAP_XCRS
1539 :Capability: KVM_CAP_XCRS
1566 :Capability: KVM_CAP_EXT_CPUID
1651 :Capability: KVM_CAP_PPC_GET_PVINFO
1681 :Capability: KVM_CAP_IRQ_ROUTING
1729   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
1730   the device ID.  If this capability is not available, userspace should
1756 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
1779 :Capability: KVM_CAP_TSC_CONTROL
1792 :Capability: KVM_CAP_GET_TSC_KHZ
1806 :Capability: KVM_CAP_IRQCHIP
1837 :Capability: KVM_CAP_IRQCHIP
1854 regs field) depends on the state of the KVM_CAP_X2APIC_API capability.
1861 :Capability: KVM_CAP_IOEVENTFD
1907 :Capability: KVM_CAP_SW_TLB
1943 :Capability: KVM_CAP_SPAPR_TCE
1952 and provides a scatter/gather capability for PAPR virtual I/O.
1982 :Capability: KVM_CAP_PPC_RMA
2009 The KVM_CAP_PPC_RMA capability is 1 or 2 if the KVM_ALLOCATE_RMA ioctl
2018 :Capability: KVM_CAP_USER_NMI
2045 :Capability: KVM_CAP_S390_UCONTROL
2067 :Capability: KVM_CAP_S390_UCONTROL
2089 :Capability: KVM_CAP_S390_UCONTROL
2107 :Capability: KVM_CAP_ONE_REG
2546 :Capability: KVM_CAP_ONE_REG
2576 :Capability: KVM_CAP_KVMCLOCK_CTRL
2600 :Capability: KVM_CAP_SIGNAL_MSI
2622   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
2623   the device ID.  If this capability is not available, userspace
2631 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
2639 :Capability: KVM_CAP_PIT2
2672 :Capability: KVM_CAP_PIT_STATE2
2698 :Capability: KVM_CAP_PIT_STATE2
2713 :Capability: KVM_CAP_PPC_GET_SMMU_INFO
2788 :Capability: KVM_CAP_IRQFD
2827 :Capability: KVM_CAP_PPC_ALLOC_HTAB
2836 virtualization.  Otherwise the capability doesn't exist and the ioctl
2864 :Capability: basic
2919 :Capability: KVM_CAP_PPC_HTAB_FD
2974 :Capability: KVM_CAP_DEVICE_CTRL
3012 :Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
3047 :Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
3068 :Capability: basic
3154 :Capability: basic
3183 :Capability: basic
3210 :Capability: KVM_CAP_ARM_SET_DEVICE_ADDR
3259 :Capability: KVM_CAP_PPC_RTAS
3279 :Capability: KVM_CAP_SET_GUEST_DEBUG
3325 For ppc, the KVM_CAP_PPC_GUEST_DEBUG_SSTEP capability indicates whether
3335 :Capability: KVM_CAP_EXT_EMUL_CPUID
3410 :Capability: KVM_CAP_S390_MEM_OP
3446 KVM_CAP_S390_MEM_OP capability. "buf" is the buffer supplied by the
3459 :Capability: KVM_CAP_S390_SKEYS
3491 :Capability: KVM_CAP_S390_SKEYS
3519 :Capability: KVM_CAP_S390_INJECT_IRQ
3579 :Capability: KVM_CAP_S390_IRQ_STATE
3614 :Capability: KVM_CAP_S390_IRQ_STATE
3652 :Capability: KVM_CAP_X86_SMM
3663 :Capability: KVM_CAP_PPC_MULTITCE
3667 This capability means the kernel is capable of handling hypercalls
3684 This capability is always enabled.
3689 :Capability: KVM_CAP_SPAPR_TCE_64
3698 This capability uses extended struct in ioctl interface::
3722 :Capability: KVM_CAP_REINJECT_CONTROL
3749 :Capability: KVM_CAP_PPC_RADIX_MMU or KVM_CAP_PPC_HASH_MMU_V3
3783 :Capability: KVM_CAP_PPC_RADIX_MMU
3820 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
3856 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
3911 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
3956 :Capability: KVM_CAP_MCE
3969 :Capability: KVM_CAP_MCE
3976          -EINVAL if requested MCE capability is not supported.
3988 :Capability: KVM_CAP_MCE
4022 :Capability: KVM_CAP_S390_CMMA_MIGRATION
4117 :Capability: KVM_CAP_S390_CMMA_MIGRATION
4165 :Capability: KVM_CAP_PPC_GET_CPU_CHAR
4212 :Capability: basic
4229 :Capability: basic
4253 :Capability: basic
4265 :Capability: KVM_CAP_HYPERV_EVENTFD
4300 :Capability: KVM_CAP_NESTED_STATE
4374 :Capability: KVM_CAP_NESTED_STATE
4386 :Capability: KVM_CAP_COALESCED_MMIO (for coalesced mmio)
4415 :Capability: KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
4448 the KVM_CAP_MULTI_ADDRESS_SPACE capability.
4451 is enabled; for more information, see the description of the capability.
4458 :Capability: KVM_CAP_HYPERV_CPUID
4563 :Capability: KVM_CAP_PMU_EVENT_FILTER
4597 :Capability: basic
4621 :Capability: KVM_CAP_S390_VCPU_RESETS
4633 :Capability: none
4646 :Capability: KVM_CAP_S390_VCPU_RESETS
4660 :Capability: KVM_CAP_S390_PROTECTED
4713 :Capability: KVM_X86_SET_MSR_FILTER
5256 this capability at VM creation. Once this is done, these types of errors will
5279 Used on x86 systems. When the VM capability KVM_CAP_X86_USER_SPACE_MSR is
5359       whether this is a per-vcpu or per-vm capability.
5362       what parameters are accepted by the capability.
5377 This capability enables interception of OSI hypercalls that otherwise would
5382 When this capability is enabled, KVM_EXIT_OSI can occur.
5393 This capability enables interception of PAPR hypercalls. PAPR hypercalls are
5403 When this capability is enabled, KVM_EXIT_PAPR_HCALL can occur.
5461 This capability enables support for handling of channel I/O instructions.
5466 When this capability is enabled, KVM_EXIT_S390_TSCH will occur on TEST
5469 Note that even though this capability is enabled per-vcpu, the complete
5480 This capability enables or disables the delivery of interrupts through the
5489 When this capability is enabled, KVM_EXIT_EPR can occur.
5498 This capability connects the vcpu to an in-kernel MPIC device.
5508 This capability connects the vcpu to an in-kernel XICS device.
5517 This capability enables the in-kernel irqchip for s390. Please refer to
5527 This capability allows the use of the host Floating Point Unit by the guest. It
5541 This capability allows the use of the MIPS SIMD Architecture (MSA) by the guest.
5601 This capability connects the vcpu to an in-kernel XIVE device.
5618       what parameters are accepted by the capability.
5632 This capability controls whether individual sPAPR hypercalls (hcalls)
5637 before this capability was implemented.  If disabled, the kernel will
5653 This capability controls which SIGP orders will be handled completely in user
5654 space. With this capability enabled, all fast orders will be handled completely
5666 in the hardware prior to interception). If this capability is not enabled, the
5686 This capability allows post-handlers for the STSI instruction. After
5722 This capability also enables in kernel routing of interrupt requests;
5770 With this capability enabled, all illegal instructions 0x0000 (2 bytes) will
5776 This capability can be enabled dynamically even if VCPUs were already
5804 Enabling this capability on a VM provides userspace with a way to set
5809 be 0.  A successful call to enable this capability will result in
5810 vsmt_mode being returned when the KVM_CAP_PPC_SMT capability is
5811 subsequently queried for the VM.  This capability is only supported by
5813 The KVM_CAP_PPC_SMT_POSSIBLE capability indicates which virtual SMT
5822 With this capability a machine check exception in the guest address
5825 machine check handling routine. Without this capability KVM will
5842 Enabling this capability on a VM provides userspace with a way to no
5860 With this capability the KVM support for memory backing with 1m pages
5861 through hugetlbfs can be enabled for a VM. After the capability is
5867 this capability, the VM will not be able to run.
5875 With this capability, a guest may read the MSR_PLATFORM_INFO MSR. Otherwise,
5877 capability does not enable write permissions of this MSR for the guest.
5890 state).  Enabling this capability on a VM depends on the CPU having
5900 With this capability enabled, CR2 will not be modified prior to the
5912 This capability also enables exception.pending in struct
5966 This capability indicates that KVM is running on a host that has
5974 If present, this capability can be enabled for a VM, meaning that KVM
5986 This capability overrides the kvm module parameter halt_poll_ns for the
5991 controlled by the kvm module parameter halt_poll_ns. This capability allows
6003 This capability enables trapping of #GP invoking RDMSR and WRMSR instructions
6011 this capability. With it enabled, MSR accesses that match the mask specified in
6028 This capability, if KVM_CHECK_EXTENSION indicates that it is
6032 with the KVM_CAP_PPC_ENABLE_HCALL capability.
6039 This capability, if KVM_CHECK_EXTENSION indicates that it is
6045 capability via KVM_ENABLE_CAP ioctl on the vcpu fd. Note that this
6054 This capability, if KVM_CHECK_EXTENSION indicates that it is
6064 This capability, if KVM_CHECK_EXTENSION indicates that it is
6074 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
6080 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
6104 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
6110 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
6118 This capability indicates the supported architecture type of the guest, i.e. the
6121 The values returned when this capability is checked by KVM_CHECK_EXTENSION on a
6146 This capability, if KVM_CHECK_EXTENSION indicates that it is available, means
6169 number larger than 0 indicating the version of this capability is implemented
6189 Querying this capability returns a bitmap indicating the possible
6199 This capability enables a newer version of Hyper-V Synthetic interrupt
6209 This capability indicates that userspace can load HV_X64_MSR_VP_INDEX msr.  Its
6212 capability is absent, userspace can still query this msr's value.
6220 This capability indicates if the flic device will be able to get/set the
6229 This capability indicates that the PSW is exposed via the kvm_run structure.
6236 This capability indicates that the user space memory used as guest mapping can
6245 This capability indicates that the user space memory used as guest mapping can
6254 This capability indicates that kvm will implement the interfaces to handle
6256 facility 82 should not be provided to the guest without this capability.
6263 This capability indicates that KVM supports paravirtualized Hyper-V TLB Flush
6273 This capability indicates that userspace can specify (via the
6276 If KVM advertises this capability, userspace can only specify the ISS field for
6288 This capability indicates that KVM supports paravirtualized Hyper-V IPI send
6297 This capability indicates that KVM running on top of Hyper-V hypervisor
6301 KVM, enabling this capability effectively disables all hypercall
6312 This capability indicates that the KVM_S390_NORMAL_RESET and
6320 This capability indicates that the Ultravisor has been initialized and
6322 This capability governs the KVM_S390_PV_COMMAND ioctl and the
6331 This capability indicates that KVM supports steal time accounting.
6333 architecture-specific interfaces.  This capability and the architecture-
6344 This capability enables a guest to set information about its control program
6356 If this capability is available, then the CPNC and CPVC can be synchronized
6364 This capability indicates that KVM supports deflection of MSR reads and
6375 This capability indicates that KVM supports that accesses to user defined MSRs
6376 may be rejected. With this capability exposed, KVM exports new VM ioctl