Lines Matching +full:ipa +full:- +full:clock +full:- +full:enabled
1 .. SPDX-License-Identifier: GPL-2.0
4 The Definitive KVM (Kernel-based Virtual Machine) API Documentation
24 - System ioctls: These query and set global attributes which affect the
28 - VM ioctls: These query and set attributes that affect an entire virtual
35 - vcpu ioctls: These query and set attributes that control the operation
43 - device ioctls: These query and set attributes that control the operation
56 capabilities also need to be enabled for VMs or VCPUs where their
92 facility that allows backward-compatible extensions to the API to be
133 -----------------------
150 -----------------
184 On arm64, the physical address size for a VM (IPA Size limit) is limited
189 address used by the VM. The IPA_Bits is encoded in bits[7-0] of the
207 ioctl() at run-time.
209 Creation of the VM will fail if the requested IPA size (whether it is
212 Please note that configuring the IPA size does not affect the capability
219 ----------------------------------------------------------
225 :Returns: 0 on success; -1 on error
263 -----------------------
282 --------------------------
295 the VCPU file descriptor can be mmap-ed, including:
297 - if KVM_CAP_COALESCED_MMIO is available, a page at
302 - if KVM_CAP_DIRTY_LOG_RING is available, a number of pages at
308 -------------------
314 :Returns: vcpu fd on success, -1 on error
320 the KVM_CHECK_EXTENSION ioctl() at run-time.
322 KVM_CAP_MAX_VCPUS of the KVM_CHECK_EXTENSION ioctl() at run-time.
330 KVM_CAP_MAX_VCPU_ID of the KVM_CHECK_EXTENSION ioctl() at run-time.
345 single-threaded guest vcpus, it should make all vcpu ids be a multiple
355 ---------------------
361 :Returns: 0 on success, -1 on error
380 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies
385 KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 is enabled. For more information,
393 ------------
399 :Returns: 0 on success, -1 on error
408 KVM_CAP_ARM_NISV_TO_USER not enabled (arm64)
420 -----------------
426 :Returns: 0 on success, -1 on error
460 -----------------
466 :Returns: 0 on success, -1 on error
474 ------------------
480 :Returns: 0 on success, -1 on error
497 /* ppc -- see arch/powerpc/include/uapi/asm/kvm.h */
505 ------------------
511 :Returns: 0 on success, -1 on error
518 ------------------
524 :Returns: 0 on success, -1 on error
545 ------------------
570 -EEXIST if an interrupt is already enqueued
571 -EINVAL the irq number is invalid
572 -ENXIO if the PIC is in the kernel
573 -EFAULT if the pointer is invalid
577 ioctl is useful if the in-kernel PIC is not used.
617 RISC-V:
644 -----------------
651 -1 on error
654 Reads the values of MSR-based features that are available for the VM. This
656 The list of msr-based features can be obtained using KVM_GET_MSR_FEATURE_INDEX_LIST
660 Reads model-specific registers from the vcpu. Supported msr indices can
684 -----------------
690 :Returns: number of msrs successfully set (see below), -1 on error
692 Writes model-specific registers to the vcpu. See KVM_GET_MSRS for the
706 ------------------
712 :Returns: 0 on success, -1 on error
718 - If this IOCTL fails, KVM gives no guarantees that previous valid CPUID
721 - Using KVM_SET_CPUID{,2} after KVM_RUN, i.e. changing the guest vCPU model
723 - Using heterogeneous CPUID configurations, modulo APIC IDs, topology, etc...
746 ------------------------
752 :Returns: 0 on success, -1 on error
757 their traditional behaviour) will cause KVM_RUN to return with -EINTR.
772 ----------------
778 :Returns: 0 on success, -1 on error
810 ----------------
816 :Returns: 0 on success, -1 on error
848 -----------------------
854 :Returns: 0 on success, -1 on error
858 future vcpus to have a local APIC. IRQ routing for GSIs 0-15 is set to both
859 PIC and IOAPIC; GSI 16-23 only go to the IOAPIC.
865 Note that on s390 the KVM_CAP_S390_IRQCHIP vm capability needs to be enabled
870 -----------------
876 :Returns: 0 on success, -1 on error
880 been previously created with KVM_CREATE_IRQCHIP. Note that edge-triggered
883 On real hardware, interrupt pins can be active-low or active-high. This
888 (active-low/active-high) for level-triggered interrupts, and KVM used
890 active-low interrupts, the above convention is now valid on x86 too.
892 should not present interrupts to the guest as active-low unless this
893 capability is present (or unless it is not using the in-kernel irqchip,
898 in-kernel irqchip (GIC), and for in-kernel irqchip can tell the GIC to
907 - KVM_ARM_IRQ_TYPE_CPU:
908 out-of-kernel GIC: irq_id 0 is IRQ, irq_id 1 is FIQ
909 - KVM_ARM_IRQ_TYPE_SPI:
910 in-kernel GIC: SPI, irq_id between 32 and 1019 (incl.)
912 - KVM_ARM_IRQ_TYPE_PPI:
913 in-kernel GIC: PPI, irq_id between 16 and 31 (incl.)
924 injection of interrupts for the in-kernel irqchip. KVM_IRQ_LINE can always
939 --------------------
945 :Returns: 0 on success, -1 on error
964 --------------------
970 :Returns: 0 on success, -1 on error
989 -----------------------
995 :Returns: 0 on success, -1 on error
1000 page of a blob (32- or 64-bit, depending on the vcpu mode) to guest
1035 ------------------
1041 :Returns: 0 on success, -1 on error
1057 to make all VCPUs follow this clock, but the exact value read by each
1075 __u64 clock; /* kvmclock current value */
1085 ------------------
1091 :Returns: 0 on success, -1 on error
1110 __u64 clock; /* kvmclock current value */
1120 ------------------------
1127 :Returns: 0 on success, -1 on error
1172 - KVM_VCPUEVENT_VALID_SHADOW may be set to signal that
1175 - KVM_VCPUEVENT_VALID_SMM may be set to signal that smi contains a
1178 - KVM_VCPUEVENT_VALID_PAYLOAD may be set to signal that the
1181 KVM_CAP_EXCEPTION_PAYLOAD is enabled.
1183 - KVM_VCPUEVENT_VALID_TRIPLE_FAULT may be set to signal that the
1185 be set whenever KVM_CAP_X86_TRIPLE_FAULT_EVENT is enabled.
1202 guest-visible registers. It is not possible to 'cancel' an SError that has been
1205 A device being emulated in user-space may also wish to generate an SError. To do
1206 this the events structure can be populated by user-space. The current state
1215 always have a non-zero value when read, and the agent making an SError pending
1217 the system supports KVM_CAP_ARM_INJECT_SERROR_ESR, but user-space sets the events
1221 -EINVAL. Setting anything other than the lower 24bits of exception.serror_esr
1222 will return -EINVAL.
1243 ------------------------
1250 :Returns: 0 on success, -1 on error
1263 suppress overwriting the current in-kernel state. The bits are:
1268 KVM_VCPUEVENT_VALID_SMM transfer the smi sub-struct.
1277 If KVM_CAP_EXCEPTION_PAYLOAD is enabled, KVM_VCPUEVENT_VALID_PAYLOAD
1282 If KVM_CAP_X86_TRIPLE_FAULT_EVENT is enabled, KVM_VCPUEVENT_VALID_TRIPLE_FAULT
1296 information or because there is no device mapped at the accessed IPA, then
1310 ----------------------
1316 :Returns: 0 on success, -1 on error
1332 ----------------------
1338 :Returns: 0 on success, -1 on error
1347 -------------------------------
1353 :Returns: 0 on success, -1 on error
1370 memory slot. Bits 0-15 of "slot" specify the slot id and this value
1375 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of "slot"
1402 to make a new slot read-only. In this case, writes to this memory will be
1410 Note: On arm64, a write generated by the page-table walker (to update
1414 page-table walker, making it impossible to emulate the access.
1415 Instead, an abort (data abort if the cause of the page-table update
1422 Returns -EINVAL or -EEXIST if the VM has the KVM_VM_S390_UCONTROL flag set.
1423 Returns -EINVAL if called on a protected VM.
1426 ---------------------
1432 :Returns: 0 on success, -1 on error
1434 This ioctl defines the physical address of a three-page region in the guest
1440 This ioctl is required on Intel-based hosts. This is needed on Intel hardware
1448 -------------------
1454 :Returns: 0 on success; -1 on error
1460 :Returns: 0 on success; -1 on error
1464 Not all extensions are enabled by default. Using this ioctl the application
1470 To check if a capability can be enabled, the KVM_CHECK_EXTENSION ioctl should
1479 The capability that is supposed to get enabled.
1499 The vcpu ioctl should be used for vcpu-specific capabilities, the vm ioctl
1500 for vm-wide capabilities.
1503 ---------------------
1509 :Returns: 0 on success; -1 on error
1544 in-kernel irqchip, the multiprocessing state must be maintained by userspace on
1584 ---------------------
1590 :Returns: 0 on success; -1 on error
1596 in-kernel irqchip, the multiprocessing state must be maintained by userspace on
1609 ------------------------------
1615 :Returns: 0 on success, -1 on error
1617 This ioctl defines the physical address of a one-page region in the guest
1626 This ioctl is required on Intel-based hosts. This is needed on Intel hardware
1633 ------------------------
1639 :Returns: 0 on success, -1 on error
1648 ------------------
1654 :Returns: 0 on success, -1 on error
1668 ------------------
1674 :Returns: 0 on success, -1 on error
1689 enabled with ``arch_prctl()``, but this may change in the future.
1696 -----------------
1702 :Returns: 0 on success, -1 on error
1723 -----------------
1729 :Returns: 0 on success, -1 on error
1750 ----------------------------
1756 :Returns: 0 on success, -1 on error
1789 Dynamically-enabled feature bits need to be requested with
1799 with the 'nent' field indicating the number of entries in the variable-size
1829 may be returned as true, but they depend on KVM_CREATE_IRQCHIP for in-kernel
1842 -----------------------
1872 ------------------------
1878 :Returns: 0 on success, -1 on error
1884 - GSI routing does not apply to KVM_IRQ_LINE but only to KVM_IRQFD.
1921 error -EINVAL.
1925 - KVM_MSI_VALID_DEVID: used along with KVM_IRQ_ROUTING_MSI routing entry
1926 type, specifies that the devid field contains a valid value. The per-VM
1930 - zero otherwise
1954 feature of KVM_CAP_X2APIC_API capability is enabled. If it is enabled,
1955 address_hi bits 31-8 provide bits 31-8 of the destination id. Bits 7-0 of
1989 --------------------
1995 :Returns: 0 on success, -1 on error
2005 --------------------
2011 :Returns: virtual tsc-khz on success, negative value on error
2014 KHz. If the host has unstable tsc this ioctl returns -EIO instead as an
2019 ------------------
2025 :Returns: 0 on success, -1 on error
2038 enabled, then the format of APIC_ID register depends on the APIC mode
2040 the APIC_ID register (bytes 32-35). xAPIC only allows an 8-bit APIC ID
2041 which is stored in bits 31-24 of the APIC register, or equivalently in
2050 ------------------
2056 :Returns: 0 on success, -1 on error
2068 The format of the APIC ID register (bytes 32-35 of struct kvm_lapic_state's
2074 ------------------
2097 For the special case of virtio-ccw devices on s390, the ioevent is matched
2111 For virtio-ccw devices, addr contains the subchannel id and datamatch the
2120 ------------------
2126 :Returns: 0 on success, -1 on error
2146 The array is little-endian: the bit 0 is the least significant bit of the
2156 -------------------------
2165 is an IOMMU for PAPR-style virtual I/O. It is used to translate
2179 which this TCE table will translate - the table will contain one 64
2189 the entries written by kernel-handled H_PUT_TCE calls, and also lets
2195 ------------
2201 :Returns: 0 on success, -1 on error
2211 - pause the vcpu
2212 - read the local APIC's state (KVM_GET_LAPIC)
2213 - check whether changing LINT1 will queue an NMI (see the LVT entry for LINT1)
2214 - if so, issue KVM_NMI
2215 - resume the vcpu
2222 ----------------------
2244 ------------------------
2266 ------------------------
2284 --------------------
2527 ARM 32-bit CP15 registers have the following id bit patterns::
2531 ARM 64-bit CP15 registers have the following id bit patterns::
2539 ARM 32-bit VFP control registers have the following id bit patterns::
2543 ARM 64-bit FP registers have the following id bit patterns::
2547 ARM firmware pseudo-registers have the following bit pattern::
2555 arm64 core/FP-SIMD registers have the following id bit patterns. Note
2589 .. [1] These encodings are not accepted for SVE-enabled vcpus. See
2594 enabled (see below).
2614 arm64 firmware pseudo-registers have the following bit pattern::
2623 0x6060 0000 0015 ffff KVM_REG_ARM64_SVE_VLS pseudo-register
2626 ENOENT. max_vq is the vcpu's maximum supported vector length in 128-bit
2629 These registers are only accessible on vcpus for which SVE is enabled.
2637 KVM_REG_ARM64_SVE_VLS is a pseudo-register that allows the set of vector
2647 ((vector_lengths[(vq - KVM_ARM64_SVE_VQ_MIN) / 64] >>
2648 ((vq - KVM_ARM64_SVE_VQ_MIN) % 64)) & 1))
2670 is hardware-dependent and may not be available. Attempting to configure
2677 arm64 bitmap feature firmware pseudo-registers have the following bit pattern::
2691 a -EBUSY to userspace.
2704 patterns depending on whether they're 32-bit or 64-bit registers::
2706 0x7020 0000 0001 00 <reg:5> <sel:3> (32-bit)
2707 0x7030 0000 0001 00 <reg:5> <sel:3> (64-bit)
2732 0x7020 0000 0003 00 <0:3> <reg:5> (32-bit FPU registers)
2733 0x7030 0000 0003 00 <0:3> <reg:5> (64-bit FPU registers)
2734 0x7040 0000 0003 00 <0:3> <reg:5> (128-bit MSA vector registers)
2746 RISC-V registers are mapped using the lower 32 bits. The upper 8 bits of
2749 RISC-V config registers are meant for configuring a Guest VCPU and it has
2755 Following are the RISC-V config registers:
2767 RISC-V core registers represent the general execution state of a Guest VCPU
2773 Following are the RISC-V core registers:
2810 0x80x0 0000 0200 0020 mode Privilege mode (1 = S-mode or 0 = U-mode)
2813 RISC-V csr registers represent the supervisor mode control/status registers
2819 Following are the RISC-V csr registers:
2835 RISC-V timer registers represent the timer state of a Guest VCPU and it has
2840 Following are the RISC-V timer registers:
2845 0x8030 0000 0400 0000 frequency Time base frequency (read-only)
2851 RISC-V F-extension registers represent the single precision floating point
2856 Following are the RISC-V F-extension registers:
2867 RISC-V D-extension registers represent the double precision floating point
2871 0x8030 0000 06 <index into the __riscv_d_ext_state struct:24> (non-fcsr)
2873 Following are the RISC-V D-extension registers:
2890 0x9030 0000 0001 00 <reg:5> <sel:3> (64-bit)
2899 --------------------
2929 ----------------------
2935 :Returns: 0 on success, -1 on error
2946 load-link/store-conditional, or equivalent must be used. There are two cases
2953 -------------------
2959 :Returns: >0 on delivery, 0 if guest blocked the MSI, and -1 on error
2961 Directly inject a MSI message. Only valid with in-kernel irqchip that handles
2976 KVM_MSI_VALID_DEVID: devid contains a valid value. The per-VM
2986 feature of KVM_CAP_X2APIC_API capability is enabled. If it is enabled,
2987 address_hi bits 31-8 provide bits 31-8 of the destination id. Bits 7-0 of
2992 --------------------
2998 :Returns: 0 on success, -1 on error
3000 Creates an in-kernel device model for the i8254 PIT. This call is only valid
3001 after enabling in-kernel irqchip support via KVM_CREATE_IRQCHIP. The following
3013 PIT timer interrupts may use a per-VM kernel thread for injection. If it
3016 kvm-pit/<owner-process-pid>
3025 -----------------
3031 :Returns: 0 on success, -1 on error
3033 Retrieves the state of the in-kernel PIT model. Only valid after
3046 /* speaker port data bit enabled */
3053 -----------------
3059 :Returns: 0 on success, -1 on error
3061 Sets the state of the in-kernel PIT model. Only valid after KVM_CREATE_PIT2.
3068 --------------------------
3074 :Returns: 0 on success, -1 on error
3079 device-tree properties for the guest operating system.
3093 - KVM_PPC_PAGE_SIZES_REAL:
3098 - KVM_PPC_1T_SEGMENTS
3102 - KVM_PPC_NO_HASH
3143 --------------
3149 :Returns: 0 on success, -1 on error
3159 With KVM_CAP_IRQFD_RESAMPLE, KVM_IRQFD supports a de-assert and notify
3160 mechanism allowing emulation of level-triggered, irqfd-based
3165 as from an EOI, the gsi is de-asserted and the user is notified via
3166 kvm_irqfd.resamplefd. It is the user's responsibility to re-queue
3174 - in case no routing entry is associated to this gsi, injection fails
3175 - in case the gsi is associated to an irqchip routing entry,
3177 - in case the gsi is associated to an MSI routing entry, the MSI
3179 to GICv3 ITS in-kernel emulation).
3182 --------------------------
3188 :Returns: 0 on success, -1 on error
3200 The parameter is a pointer to a 32-bit unsigned integer variable
3207 default-sized hash table (16 MB).
3215 real-mode area (VRMA) facility, the kernel will re-create the VMRA
3219 -----------------------
3225 :Returns: 0 on success, -1 on error
3241 - sigp stop; optional flags in parm
3243 - program check; code in parm
3245 - sigp set prefix; prefix address in parm
3247 - restart
3249 - clock comparator interrupt
3251 - CPU timer interrupt
3253 - virtio external interrupt; external interrupt
3256 - sclp external interrupt; sclp parameter in parm
3258 - sigp emergency; source cpu in parm
3260 - sigp external call; source cpu in parm
3262 - compound value to indicate an
3263 I/O interrupt (ai - adapter interrupt; cssid,ssid,schid - subchannel);
3267 - machine check interrupt; cr 14 bits in parm, machine check interrupt
3274 ------------------------
3280 :Returns: file descriptor number (>= 0) on success, -1 on error
3329 ----------------------
3335 :Returns: 0 on success, -1 on error
3368 --------------------------------------------
3376 :Returns: 0 on success, -1 on error
3384 (e.g. read-only attribute, or attribute that only makes
3391 semantics are device-specific. See individual device documentation in
3399 __u32 group; /* device-defined */
3400 __u64 attr; /* group-defined */
3405 ------------------------
3412 :Returns: 0 on success, -1 on error
3429 ----------------------
3435 :Returns: 0 on success; -1 on error
3450 - Processor state:
3455 - General Purpose registers, including PC and SP: set to 0
3456 - FPSIMD/NEON registers: set to 0
3457 - SVE registers: set to 0
3458 - System registers: Reset to their architecturally defined
3471 - KVM_ARM_VCPU_POWER_OFF: Starts the CPU in a power-off state.
3474 - KVM_ARM_VCPU_EL1_32BIT: Starts the CPU in a 32bit mode.
3476 - KVM_ARM_VCPU_PSCI_0_2: Emulate PSCI v0.2 (or a future revision
3479 - KVM_ARM_VCPU_PMU_V3: Emulate PMUv3 for the CPU.
3482 - KVM_ARM_VCPU_PTRAUTH_ADDRESS: Enables Address Pointer authentication
3490 - KVM_ARM_VCPU_PTRAUTH_GENERIC: Enables Generic Pointer authentication
3498 - KVM_ARM_VCPU_SVE: Enables SVE for the CPU (arm64 only).
3504 - KVM_REG_ARM64_SVE_VLS may be read using KVM_GET_ONE_REG: the
3505 initial value of this pseudo-register indicates the best set of
3510 - KVM_RUN and KVM_GET_REG_LIST are not available;
3512 - KVM_GET_ONE_REG and KVM_SET_ONE_REG cannot be used to access
3517 - KVM_REG_ARM64_SVE_VLS may optionally be written using
3523 - the KVM_REG_ARM64_SVE_VLS pseudo-register is immutable, and can
3527 -----------------------------
3533 :Returns: 0 on success; -1 on error
3546 kvm_vcpu_init->features bitmap returned will have feature bits set if
3556 ---------------------
3562 :Returns: 0 on success; -1 on error
3584 - KVM_REG_S390_TODPR
3586 - KVM_REG_S390_EPOCHDIFF
3588 - KVM_REG_S390_CPU_TIMER
3590 - KVM_REG_S390_CLOCK_COMP
3592 - KVM_REG_S390_PFTOKEN
3594 - KVM_REG_S390_PFCOMPARE
3596 - KVM_REG_S390_PFSELECT
3598 - KVM_REG_S390_PP
3600 - KVM_REG_S390_GBEA
3604 -----------------------------------------
3610 :Returns: 0 on success, -1 on error
3640 arm64 currently only require this when using the in-kernel GIC
3646 base addresses will return -EEXIST.
3653 ------------------------------
3659 :Returns: 0 on success, -1 on error
3664 of a service that has a kernel-side implementation. If the token
3665 value is non-zero, it will be associated with that service, and
3673 ------------------------
3679 :Returns: 0 on success; -1 on error
3694 - KVM_GUESTDBG_ENABLE: guest debugging is enabled
3695 - KVM_GUESTDBG_SINGLESTEP: the next run should single-step
3700 - KVM_GUESTDBG_USE_SW_BP: using software breakpoints [x86, arm64]
3701 - KVM_GUESTDBG_USE_HW_BP: using hardware breakpoints [x86, s390]
3702 - KVM_GUESTDBG_USE_HW: using hardware debug events [arm64]
3703 - KVM_GUESTDBG_INJECT_DB: inject DB type exception [x86]
3704 - KVM_GUESTDBG_INJECT_BP: inject BP type exception [x86]
3705 - KVM_GUESTDBG_EXIT_PENDING: trigger an immediate guest exit [s390]
3706 - KVM_GUESTDBG_BLOCKIRQ: avoid injecting interrupts/NMI/SMI [x86]
3709 are enabled in memory so we need to ensure breakpoint exceptions are
3724 the single-step debug event (KVM_GUESTDBG_SINGLESTEP) is supported.
3734 ---------------------------
3740 :Returns: 0 on success, -1 on error
3775 the variable-size array 'entries'. If the number of entries is too low
3809 --------------------
3816 < 0 on generic error (e.g. -EFAULT or -ENOMEM),
3874 Logical accesses are permitted for non-protected guests only.
3892 translation-exception identifier (TEID) indicates suppression.
3915 Absolute accesses are permitted for non-protected guests only.
3954 -----------------------
3980 will cause the ioctl to return -EINVAL.
3986 -----------------------
4004 will cause the ioctl to return -EINVAL.
4011 the ioctl will return -EINVAL.
4014 -----------------
4020 :Returns: 0 on success, -1 on error
4061 - KVM_S390_SIGP_STOP - sigp stop; parameter in .stop
4062 - KVM_S390_PROGRAM_INT - program check; parameters in .pgm
4063 - KVM_S390_SIGP_SET_PREFIX - sigp set prefix; parameters in .prefix
4064 - KVM_S390_RESTART - restart; no parameters
4065 - KVM_S390_INT_CLOCK_COMP - clock comparator interrupt; no parameters
4066 - KVM_S390_INT_CPU_TIMER - CPU timer interrupt; no parameters
4067 - KVM_S390_INT_EMERGENCY - sigp emergency; parameters in .emerg
4068 - KVM_S390_INT_EXTERNAL_CALL - sigp external call; parameters in .extcall
4069 - KVM_S390_MCHK - machine check interrupt; parameters in .mchk
4074 ---------------------------
4081 -EINVAL if buffer size is 0,
4082 -ENOBUFS if buffer size is too small to fit all pending interrupts,
4083 -EFAULT if the buffer address was invalid
4101 the kernel never checked for flags == 0 and QEMU never pre-zeroed flags and
4105 If -ENOBUFS is returned the buffer provided was too small and userspace
4109 ---------------------------
4116 -EFAULT if the buffer address was invalid,
4117 -EINVAL for an invalid buffer length (see below),
4118 -EBUSY if there were already interrupts pending,
4122 This ioctl allows userspace to set the complete state of all cpu-local
4144 which is the maximum number of possibly pending cpu-local interrupts.
4147 ------------
4153 :Returns: 0 on success, -1 on error
4158 ----------------------------
4220 enabled. If KVM_MSR_EXIT_REASON_FILTER is enabled, KVM will exit to userspace
4222 KVM_MSR_EXIT_REASON_FILTER is not enabled, KVM will inject a #GP into the guest
4247 part of VM-Enter/VM-Exit emulation.
4250 of VM-Enter/VM-Exit emulation. If an MSR access is denied on VM-Enter, KVM
4251 synthesizes a consistency check VM-Exit(EXIT_REASON_MSR_LOAD_FAIL). If an
4252 MSR access is denied on VM-Exit, KVM synthesizes a VM-Abort. In short, KVM
4254 the VM-Enter/VM-Exit MSR list. It is platform owner's responsibility to
4266 KVM_MSR_EXIT_REASON_FILTER must be enabled before activating any filters, and
4267 left enabled until after all filters are deactivated. Failure to do so may
4271 ----------------------------
4304 -------------------------
4311 -EFAULT if struct kvm_reinject_control cannot be read,
4312 -ENXIO if KVM_CREATE_PIT or KVM_CREATE_PIT2 didn't succeed earlier.
4331 ------------------------------
4338 -EFAULT if struct kvm_ppc_mmuv3_cfg cannot be read,
4339 -EINVAL if the configuration is invalid
4365 ---------------------------
4372 -EFAULT if struct kvm_ppc_rmmu_info cannot be written,
4373 -EINVAL if no useful information can be returned
4402 --------------------------------
4411 -EFAULT if struct kvm_reinject_control cannot be read,
4412 -EINVAL if the supplied shift or flags are invalid,
4413 -ENOMEM if unable to allocate the new HPT,
4446 returns 0 (i.e. cancels any in-progress preparation).
4449 flags will result in an -EINVAL.
4456 -------------------------------
4463 -EFAULT if struct kvm_reinject_control cannot be read,
4464 -EINVAL if the supplied shift or flags are invalid,
4465 -ENXIO is there is no pending HPT, or the pending HPT doesn't
4467 -EBUSY if the pending HPT is not fully prepared,
4468 -ENOSPC if there was a hash collision when moving existing
4470 -EIO on other error conditions
4487 KVM_PPC_RESIZE_HPT_COMMIT will return an error (usually -ENXIO or
4488 -EBUSY, though others may be possible if the preparation was started,
4492 placed itself in a quiescent state where no vcpu will make MMU enabled
4501 -----------------------------------
4507 :Returns: 0 on success, -1 on error
4514 -----------------------
4521 -EFAULT if u64 mcg_cap cannot be read,
4522 -EINVAL if the requested number of banks is invalid,
4523 -EINVAL if requested MCE capability is not supported.
4527 specifies which capabilities should be enabled. The maximum
4528 supported number of error-reporting banks can be retrieved when
4533 ---------------------
4540 -EFAULT if struct kvm_x86_mce cannot be read,
4541 -EINVAL if the bank number is invalid,
4542 -EINVAL if VAL bit is not set in status field.
4567 ----------------------------
4579 ENXIO if CMMA is not enabled
4580 EINVAL if KVM_S390_CMMA_PEEK is not set but migration mode was not enabled
4590 - During live migration to save the CMMA values. Live migration needs
4591 to be enabled via the KVM_REQ_START_MIGRATION VM property.
4592 - To non-destructively peek at the CMMA values, with the flag
4623 KVM_S390_SKEYS_MAX. KVM_S390_SKEYS_MAX is re-used for consistency with
4661 not enabled.
4668 ----------------------------
4707 This ioctl can fail with -ENOMEM if not enough memory can be allocated to
4708 complete the task, with -ENXIO if CMMA is not enabled, with -EINVAL if
4710 if the flags field was not 0, with -EFAULT if the userspace address is
4716 --------------------------
4723 -EFAULT if struct kvm_ppc_cpu_char cannot be written
4728 CVE-2017-5715, CVE-2017-5753 and CVE-2017-5754). The information is
4745 with preventing inadvertent information disclosure - specifically,
4746 whether there is an instruction to flash-invalidate the L1 data cache
4763 ---------------------------
4769 :Returns: 0 on success; -1 on error
4772 for issuing platform-specific memory encryption commands to manage those
4777 Documentation/virt/kvm/x86/amd-memory-encryption.rst.
4780 -----------------------------------
4786 :Returns: 0 on success; -1 on error
4791 It is used in the SEV-enabled guest. When encryption is enabled, a guest
4804 -------------------------------------
4810 :Returns: 0 on success; -1 on error
4816 ------------------------
4824 the specified Hyper-V connection id through the SIGNAL_EVENT hypercall, without
4825 causing a user exit. SIGNAL_EVENT hypercall with non-zero event flag number
4826 (bits 24-31) still triggers a KVM_EXIT_HYPERV_HCALL user exit.
4846 -EINVAL if conn_id or flags is outside the allowed range,
4847 -ENOENT on deassign if the conn_id isn't registered,
4848 -EEXIST on assign if the conn_id is already registered
4851 --------------------------
4857 :Returns: 0 on success, -1 on error
4925 --------------------------
4931 :Returns: 0 on success, -1 on error
4937 -------------------------------------
4966 -------------------------
4972 :Returns: 0 on success, -1 on error
4994 in KVM's dirty bitmap, and dirty tracking is re-enabled for that page
4995 (for example via write-protection, or by clearing the dirty bit in
4998 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies
5003 is enabled; for more information, see the description of the capability.
5008 --------------------------------
5014 :Returns: 0 on success, -1 on error
5035 This ioctl returns x86 cpuid features leaves related to Hyper-V emulation in
5037 cpuid information presented to guests consuming Hyper-V enlightenments (e.g.
5038 Windows or Hyper-V guests).
5040 CPUID feature leaves returned by this ioctl are defined by Hyper-V Top Level
5047 - HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS
5048 - HYPERV_CPUID_INTERFACE
5049 - HYPERV_CPUID_VERSION
5050 - HYPERV_CPUID_FEATURES
5051 - HYPERV_CPUID_ENLIGHTMENT_INFO
5052 - HYPERV_CPUID_IMPLEMENT_LIMITS
5053 - HYPERV_CPUID_NESTED_FEATURES
5054 - HYPERV_CPUID_SYNDBG_VENDOR_AND_MAX_FUNCTIONS
5055 - HYPERV_CPUID_SYNDBG_INTERFACE
5056 - HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES
5059 with the 'nent' field indicating the number of entries in the variable-size
5060 array 'entries'. If the number of entries is too low to describe all Hyper-V
5062 to the number of Hyper-V feature leaves, the 'nent' field is adjusted to the
5072 - HYPERV_CPUID_NESTED_FEATURES leaf and HV_X64_ENLIGHTENED_VMCS_RECOMMENDED
5073 feature bit are only exposed when Enlightened VMCS was previously enabled
5075 - HV_STIMER_DIRECT_MODE_AVAILABLE bit is only exposed with in-kernel LAPIC.
5079 ---------------------------
5084 :Returns: 0 on success, -1 on error
5089 EPERM feature not enabled, needs configuration, or already finalized
5110 that should be performed and how to do it are feature-dependent.
5114 -EPERM unless the feature has already been finalized by means of a
5121 ------------------------------
5127 :Returns: 0 on success, -1 on error
5180 ---- -----------
5209 When setting a new pmu event filter, -EINVAL will be returned if any of the
5221 Specifically, KVM follows the following pseudo-code when determining whether to
5222 allow the guest FixCtr[i] to count its pre-defined fixed event::
5237 ---------------------
5261 ---------------------------
5273 ----------------------------
5286 --------------------------
5300 -------------------------
5345 All registered VCPUs are converted back to non-protected ones. If a
5446 not succeed all other subcommands will fail with -EINVAL. This
5447 subcommand will return -EINVAL if a dump process has not yet been
5478 resume execution immediately as non-protected. There can be at most
5503 --------------------------
5549 Sets the ABI mode of the VM to 32-bit or 64-bit (long mode). This
5583 re-mapped in guest physical address space.
5589 This is the HVM-wide vector injected directly by the hypervisor
5611 the 32-bit version code returned to the guest when it invokes the
5626 --------------------------
5639 ---------------------------
5678 dirtied at any time if event channel interrupt delivery is enabled, so
5724 other four times. The state field must be set to -1, or to a valid
5732 vCPU ID of the given vCPU, to allow timer-related VCPU operations to
5745 per-vCPU local APIC upcall vector, configured by a Xen guest with
5747 used by Windows guests, and is distinct from the HVM-wide upcall
5753 ---------------------------
5768 ---------------------------
5774 :Returns: number of bytes copied, < 0 on error (-EINVAL for incorrect
5775 arguments, -EFAULT if memory cannot be accessed).
5789 ``length`` must not be bigger than 2^31 - PAGE_SIZE bytes. The ``addr``
5806 --------------------
5812 :Returns: 0 on success, -1 on error
5839 --------------------
5845 :Returns: 0 on success, -1 on error
5852 ----------------------
5871 +-------------+
5873 +-------------+
5875 +-------------+
5877 +-------------+
5879 +-------------+
5969 Bits 0-3 of ``flags`` encode the type:
5991 is [``hist_param``*(N-1), ``hist_param``*N), while the range of the last
5992 bucket is [``hist_param``*(``size``-1), +INF). (+INF means positive infinity
5997 [0, 1), while the range of the last bucket is [pow(2, ``size``-2), +INF).
5999 [pow(2, N-2), pow(2, N-1)).
6001 Bits 4-7 of ``flags`` encode the unit:
6013 It indicates that the statistics data is used to measure CPU clock cycles.
6024 Bits 8-11 of ``flags``, together with ``exponent``, encode the scale of the
6029 CPU clock cycles. For example, an exponent of -9 can be used with
6045 bucket in the unit expressed by bits 4-11 of ``flags`` together with ``exponent``.
6051 The Stats Data block contains an array of 64-bit values in the same order
6055 --------------------
6061 :Returns: 0 on success, -1 on error
6076 enabled with ``arch_prctl()``, but this may change in the future.
6082 -----------------------------
6102 -----------------------------
6111 for vcpus. It re-uses the kvm_s390_pv_dmp struct and hence also shares
6127 ----------------------
6135 Used to manage hardware-assisted virtualization features for zPCI devices.
6174 --------------------------------
6182 This capability indicates that userspace is able to apply a single VM-wide
6203 (-EINVAL) being returned. This ioctl can also return -EBUSY if any vcpu
6214 ------------------------------------
6253 op0==3, op1=={0, 1, 3}, CRn==0, CRm=={0-7}, op2=={0-7}.
6262 ---------------------------------
6268 :Returns: 0 on success, -1 on error
6298 on-demand.
6309 Returns -EINVAL if the VM has the KVM_VM_S390_UCONTROL flag set.
6310 Returns -EINVAL if called on a protected VM.
6313 -------------------------------
6349 ----------------------------
6392 ---------------------------
6424 KVM_PRE_FAULT_MEMORY populates KVM's stage-2 page tables used to map memory
6426 stage-2 read page fault, e.g. faults in memory as needed, but doesn't break
6427 CoW. However, KVM does not mark any newly created stage-2 PTE as Accessed.
6476 This field is polled once when KVM_RUN starts; if non-zero, KVM_RUN
6477 exits immediately, returning -EINTR. In the common scenario where a
6481 a signal handler that sets run->immediate_exit to a non-zero value.
6507 The value of the current interrupt flag. Only valid if in-kernel
6514 More architecture-specific flags detailing state of the VCPU that may
6532 The value of the cr8 register. Only valid if in-kernel local APIC is
6539 The value of the APIC BASE msr. Only valid if in-kernel local
6551 reasons. Further architecture-specific information is available in
6563 to unknown reasons. Further architecture-specific information is
6616 executed a memory-mapped I/O instruction which could not be satisfied
6629 has re-entered the kernel with KVM_RUN. The kernel side will first finish
6634 completed before performing a live migration. Userspace can re-enter the
6657 ----------
6659 SMCCC exits can be enabled depending on the configuration of the SMCCC
6668 - ``KVM_HYPERCALL_EXIT_SMC``: Indicates that the guest used the SMC
6672 - ``KVM_HYPERCALL_EXIT_16BIT``: Indicates that the guest used a 16bit
6698 __u16 ipa;
6741 Deprecated - was used for 440 KVM.
6767 This is used on 64-bit PowerPC when emulating a pSeries partition,
6771 the arguments (from the guest R4 - R12). Userspace should put the
6789 s390 specific. This exit occurs when KVM_CAP_S390_CSS_SUPPORT has been enabled
6812 It gets triggered whenever both KVM_CAP_PPC_EPR are enabled and an
6832 a system-level event using some architecture specific mechanism (hypercall
6836 The 'type' field describes the system-level event type.
6839 - KVM_SYSTEM_EVENT_SHUTDOWN -- the guest has requested a shutdown of the
6843 - KVM_SYSTEM_EVENT_RESET -- the guest has requested a reset of the VM.
6846 - KVM_SYSTEM_EVENT_CRASH -- the guest crash occurred and the guest
6850 - KVM_SYSTEM_EVENT_SEV_TERM -- an AMD SEV guest requested termination.
6852 - KVM_SYSTEM_EVENT_WAKEUP -- the exiting vCPU is in a suspended state and
6855 - KVM_SYSTEM_EVENT_SUSPEND -- the guest has requested a suspension of
6859 architecture specific information for the system-level event. Only
6862 - for arm64, data[0] is set to KVM_SYSTEM_EVENT_RESET_FLAG_PSCI_RESET2 if
6866 - for arm64, data[0] is set to KVM_SYSTEM_EVENT_SHUTDOWN_FLAG_PSCI_OFF2
6870 - for RISC-V, data[0] is set to the value of the second argument of the
6878 --------------
6880 KVM_SYSTEM_EVENT_SUSPEND exits are enabled with the
6888 the call parameters are left in-place in the vCPU registers.
6893 - Honor the guest request to suspend the VM. Userspace can request
6894 in-kernel emulation of suspension by setting the calling vCPU's
6900 - Deny the guest request to suspend the VM. See ARM DEN0022D.b 5.19.2
6903 Hibernation using the PSCI SYSTEM_OFF2 call is enabled when PSCI v1.3
6904 is enabled. If a guest invokes the PSCI SYSTEM_OFF2 function, KVM will
6916 Indicates that the VCPU's in-kernel local APIC received an EOI for a
6917 level-triggered IOAPIC interrupt. This exit only triggers when the
6918 IOAPIC is implemented in userspace (i.e. KVM_CAP_SPLIT_IRQCHIP is enabled);
6959 related to Hyper-V emulation.
6963 - KVM_EXIT_HYPERV_SYNIC -- synchronously notify user-space about
6965 Hyper-V SynIC state change. Notification is used to remap SynIC
6969 - KVM_EXIT_HYPERV_SYNDBG -- synchronously notify user-space about
6971 Hyper-V Synthetic debugger state change. Notification is used to either update
6990 the VM. KVM assumed that if the guest accessed non-memslot memory, it was
7000 the ESR_EL2 in the esr_iss field, and the faulting IPA in the fault_ipa field.
7020 __u8 error; /* user -> kernel */
7022 __u32 reason; /* kernel -> user */
7023 __u32 index; /* kernel -> user */
7024 __u64 data; /* kernel <-> user */
7028 enabled, MSR accesses to registers that would invoke a #GP by KVM kernel code
7082 - KVM_EXIT_XEN_HCALL -- synchronously notify user-space about Xen hypercall.
7097 done a SBI call which is not handled by KVM RISC-V kernel module. The details
7103 values of SBI call before resuming the VCPU. For more details on RISC-V SBI
7104 spec refer, https://github.com/riscv/riscv-sbi-doc.
7121 - KVM_MEMORY_EXIT_FLAG_PRIVATE - When set, indicates the memory fault occurred
7126 accompanies a return code of '-1', not '0'! errno will always be set to EFAULT
7139 enabled, a VM exit generated if no event window occurs in VM non-root mode
7147 - KVM_NOTIFY_CONTEXT_INVALID -- the VM context is corrupted and not valid
7185 6. Capabilities that can be enabled on vCPUs
7189 the virtual machine when enabled. To enable them, please see
7202 whether this is a per-vcpu or per-vm capability.
7213 -------------------
7218 :Returns: 0 on success; -1 on error
7222 were invented by Mac-on-Linux to have a standardized communication mechanism
7225 When this capability is enabled, KVM_EXIT_OSI can occur.
7229 --------------------
7234 :Returns: 0 on success; -1 on error
7246 When this capability is enabled, KVM_EXIT_PAPR_HCALL can occur.
7250 ------------------
7255 :Returns: 0 on success; -1 on error
7268 addresses of mmu-type-specific data structures. The "array_len" field is an
7284 - The "params" field is of type "struct kvm_book3e_206_tlb_params".
7285 - The "array" field points to an array of type "struct
7287 - The array consists of all entries in the first TLB, followed by all
7289 - Within a TLB, entries are ordered first by increasing set number. Within a
7291 - The hash for determining set number in TLB0 is: (MAS2 >> 12) & (num_sets - 1)
7293 - The tsize field of mas1 shall be set to 4K on TLB0, even though the
7297 ----------------------------
7302 :Returns: 0 on success; -1 on error
7307 handled in-kernel, while the other I/O instructions are passed to userspace.
7309 When this capability is enabled, KVM_EXIT_S390_TSCH will occur on TEST
7312 Note that even though this capability is enabled per-vcpu, the complete
7316 -------------------
7321 :Returns: 0 on success; -1 on error
7326 When enabled (args[0] != 0), every time the guest gets an external interrupt
7332 When this capability is enabled, KVM_EXIT_EPR can occur.
7335 --------------------
7341 This capability connects the vcpu to an in-kernel MPIC device.
7344 --------------------
7351 This capability connects the vcpu to an in-kernel XICS device.
7354 ------------------------
7360 This capability enables the in-kernel irqchip for s390. Please refer to
7364 --------------------
7378 ---------------------
7391 ----------------------
7394 :Target: s390: always enabled, x86: vcpu
7396 :Returns: x86: KVM_CHECK_EXTENSION returns a bit-array indicating which register
7412 - the register sets to be copied out to kvm_run are selectable
7414 - vcpu_events are available in addition to regs and sregs.
7417 function as an input bit-array field set by userspace to indicate the
7437 -------------------------
7444 This capability connects the vcpu to an in-kernel XIVE device.
7448 7. Capabilities that can be enabled on VMs
7452 machine when enabled. To enable them, please see section
7471 ----------------------------
7475 args[1] is 0 to disable, 1 to enable in-kernel handling
7478 get handled by the kernel or not. Enabling or disabling in-kernel
7480 initial set of hcalls are enabled for in-kernel handling, which
7481 consists of those hcalls for which in-kernel handlers were implemented
7488 If the hcall number specified is not one that has an in-kernel
7493 --------------------------
7499 space. With this capability enabled, all fast orders will be handled completely
7502 - SENSE
7503 - SENSE RUNNING
7504 - EXTERNAL CALL
7505 - EMERGENCY SIGNAL
7506 - CONDITIONAL EMERGENCY SIGNAL
7511 in the hardware prior to interception). If this capability is not enabled, the
7515 ---------------------------------
7523 return -EINVAL if the machine does not support vectors.
7526 --------------------------
7531 This capability allows post-handlers for the STSI instruction. After
7536 vcpu->run::
7547 @addr - guest address of STSI SYSIB
7548 @fc - function code
7549 @sel1 - selector 1
7550 @sel2 - selector 2
7551 @ar - access register number
7553 KVM handlers should exit to userspace with rc = -EREMOTE.
7556 -------------------------
7559 :Parameters: args[0] - number of routes reserved for userspace IOAPICs
7560 :Returns: 0 on success, -1 on error
7564 IOAPIC and PIC (and also the PIT, even though this has to be enabled
7577 -------------------
7582 Allows use of runtime-instrumentation introduced with zEC12 processor.
7583 Will return -EINVAL if the machine does not support runtime-instrumentation.
7584 Will return -EBUSY if a VCPU has already been created.
7587 ----------------------
7590 :Parameters: args[0] - features that should be enabled
7591 :Returns: 0 on success, -EINVAL when args[0] contains invalid features
7600 allowing the use of 32-bit APIC IDs. See KVM_CAP_X2APIC_API in their
7603 KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK must be enabled for x2APIC to work
7607 where 0xff represents CPUs 0-7 in cluster 0.
7610 ----------------------------
7615 With this capability enabled, all illegal instructions 0x0000 (2 bytes) will
7617 mechanism e.g. to realize 2-byte software breakpoints. The kernel will
7621 This capability can be enabled dynamically even if VCPUs were already
7625 -------------------
7629 :Returns: 0 on success; -EINVAL if the machine does not support
7630 guarded storage; -EBUSY if a VCPU has already been created.
7635 ---------------------
7640 Allow use of adapter-interruption suppression.
7641 :Returns: 0 on success; -EBUSY if a VCPU has already been created.
7644 --------------------
7662 ----------------------
7674 ------------------------------
7678 :Returns: 0 on success, -EINVAL when args[0] contains invalid exits
7698 --------------------------
7702 :Returns: 0 on success, -EINVAL if hpage module parameter was not set
7703 or cmma is enabled, or the VM has the KVM_VM_S390_UCONTROL
7707 through hugetlbfs can be enabled for a VM. After the capability is
7708 enabled, cmma can't be enabled anymore and pfmfi and the storage key
7709 interpretation are disabled. If cmma has already been enabled or the
7710 hpage module parameter is not set to 1, -EINVAL is returned.
7716 ------------------------------
7719 :Parameters: args[0] whether feature should be enabled or not
7726 --------------------------
7730 :Returns: 0 on success, -EINVAL when the implementation doesn't support
7731 nested-HV virtualization.
7733 HV-KVM on POWER9 and later systems allows for "nested-HV"
7735 can run using the CPU's supervisor mode (privileged non-hypervisor
7737 the necessary functionality and on the facility being enabled with a
7738 kvm-hv module parameter.
7741 ------------------------------
7744 :Parameters: args[0] whether feature should be enabled or not
7746 With this capability enabled, CR2 will not be modified prior to the
7747 emulated VM-exit when L1 intercepts a #PF exception that occurs in
7748 L2. Similarly, for kvm-intel only, DR6 will not be modified prior to
7749 the emulated VM-exit when L1 intercepts a #DB exception that occurs in
7755 exception.has_payload and to put the faulting address - or the new DR6
7756 bits\ [#]_ - in the exception_payload field.
7767 --------------------------------------
7770 :Parameters: args[0] whether feature should be enabled or not
7778 automatically clear and write-protect all pages that are returned as dirty.
7784 KVM_CLEAR_DIRTY_LOG ioctl can operate on a 64-page granularity rather
7797 dirty logging can be enabled gradually in small chunks on the first call
7809 ------------------------------
7821 If present, this capability can be enabled for a VM, meaning that KVM
7826 ----------------------
7831 :Returns: 0 on success; -1 on error
7834 maximum halt-polling time for all vCPUs in the target VM. This capability can
7836 maximum halt-polling time.
7838 See Documentation/virt/kvm/halt-polling.rst for more information on halt
7842 -------------------------------
7847 :Returns: 0 on success; -1 on error
7857 this capability. With it enabled, MSR accesses that match the mask specified in
7874 -------------------------------
7879 :Returns: 0 on success, -EINVAL when args[0] contains invalid bits
7889 the KVM_ENABLE_CAP. The supported modes are mutually-exclusive.
7892 guest, irrespective whether or not the host has enabled split-lock detection
7898 exit, although the host kernel's split-lock #AC detection still applies, if
7899 enabled.
7904 apply some other policy-based mitigation. When exiting to userspace, KVM sets
7905 KVM_RUN_X86_BUS_LOCK in vcpu-run->flags, and conditionally sets the exit_reason
7913 ----------------------
7917 :Returns: 0 on success, -EINVAL when CPU doesn't support 2nd DAWR
7924 -------------------------------------
7926 Architectures: x86 SEV enabled
7934 This is intended to support in-guest workloads scheduled by the host. This
7935 allows the in-guest workload to maintain its own NPTs and keeps the two vms
7940 --------------------------
7945 :Returns: 0 on success, -EINVAL if the file handle is invalid or if a requested
7963 -------------------------------
7974 IBM pSeries (sPAPR) guest starts using it if "hcall-rpt-invalidate" is
7975 present in the "ibm,hypertas-functions" device-tree property.
7977 This capability is enabled for hypervisors on platforms like POWER9
7981 --------------------------------------
7984 :Parameters: args[0] whether the feature should be enabled or not
7986 When this capability is enabled, an emulation failure will result in an exit
7999 --------------------
8005 Memory Tagging Extensions (MTE) to the guest. It must also be enabled by the
8010 When enabled the guest is able to access tags associated with any memory given
8015 When this capability is enabled all memory in memslots must be mapped as
8016 ``MAP_ANONYMOUS`` or with a RAM-based file mapping (``tmpfs``, ``memfd``),
8018 -EINVAL return.
8020 When enabled the VMM may make use of the ``KVM_ARM_MTE_COPY_TAGS`` ioctl to
8024 -------------------------------------
8026 :Architectures: x86 SEV enabled
8034 This is intended to support intra-host migration of VMs between userspace VMMs,
8038 -------------------------------
8048 This capability allows a guest kernel to use a better-performance mode for
8052 ----------------------------
8055 :Parameters: args[0] - set of KVM quirks to disable
8059 This capability, if enabled, will cause KVM to disable some behavior
8091 KVM_X86_QUIRK_OUT_7E_INC_RIP By default, KVM pre-increments %rip before
8094 KVM does not pre-increment %rip before
8160 ------------------------
8164 :Parameters: args[0] - maximum APIC ID value set for current VM
8165 :Returns: 0 on success, -EINVAL if args[0] is beyond KVM_MAX_VCPU_IDS
8181 ------------------------------
8186 :Returns: 0 on success, -EINVAL if args[0] contains invalid flags or notify
8196 in per-VM scope during VM creation. Notify VM exit is disabled by default.
8199 a VM exit if no event window occurs in VM non-root mode for a specified of
8210 ------------------------------
8213 :Returns: Informational only, -EINVAL on direct KVM_ENABLE_CAP.
8216 kvm_run.memory_fault if KVM cannot resolve a guest page fault VM-Exit, e.g. if
8231 -----------------------------------
8235 :Parameters: args[0] is the desired APIC bus clock rate, in nanoseconds
8236 :Returns: 0 on success, -EINVAL if args[0] contains an invalid value for the
8237 frequency or if any vCPUs have been created, -ENXIO if a virtual
8240 This capability sets the VM's APIC bus clock frequency, used by KVM's in-kernel
8245 core crystal clock frequency, if a non-zero CPUID 0x15 is exposed to the guest.
8248 ------------------------------
8251 :Returns: Informational only, -EINVAL on direct KVM_ENABLE_CAP.
8268 ---------------------
8274 H_RANDOM hypercall backed by a hardware random-number generator.
8275 If present, the kernel H_RANDOM handler can be enabled for guest use
8279 ------------------------
8285 Hyper-V Synthetic interrupt controller(SynIC). Hyper-V SynIC is
8286 used to support Windows Hyper-V based guest paravirt drivers(VMBus).
8291 by the CPU, as it's incompatible with SynIC auto-EOI behavior.
8294 -------------------------
8304 ---------------------------
8311 the POWER9 processor), including in-memory segment tables.
8314 -------------------
8344 -------------------
8358 ----------------------
8372 Both registers and addresses are 32-bits wide.
8373 It will only be possible to run 32-bit guest code.
8375 1 MIPS64 or microMIPS64 with access only to 32-bit compatibility segments.
8376 Registers are 64-bits wide, but addresses are 32-bits wide.
8377 64-bit guest code may run but cannot access MIPS64 memory segments.
8378 It will also be possible to run 32-bit guest code.
8381 Both registers and addresses are 64-bits wide.
8382 It will be possible to run 64-bit or 32-bit guest code.
8386 ------------------------
8391 that if userspace creates a VM without an in-kernel interrupt controller, it
8392 will be notified of changes to the output level of in-kernel emulated devices,
8395 updates the vcpu's run->s.regs.device_irq_level field to represent the actual
8401 userspace can always sample the device output level and re-compute the state of
8403 of run->s.regs.device_irq_level on every kvm exit.
8404 The value in run->s.regs.device_irq_level can represent both level and edge
8406 signals will exit to userspace with the bit in run->s.regs.device_irq_level
8409 The field run->s.regs.device_irq_level is available independent of
8410 run->kvm_valid_regs or run->kvm_dirty_regs bits.
8414 and thereby which bits in run->s.regs.device_irq_level can signal values.
8420 KVM_ARM_DEV_EL1_VTIMER - EL1 virtual timer
8421 KVM_ARM_DEV_EL1_PTIMER - EL1 physical timer
8422 KVM_ARM_DEV_PMU - ARM PMU overflow interrupt signal
8429 -----------------------------
8439 --------------------------
8443 This capability enables a newer version of Hyper-V Synthetic interrupt
8445 doesn't clear SynIC message and event flags pages when they are enabled by
8449 ----------------------------
8459 -------------------------------
8469 ---------------------
8476 ----------------------
8485 ---------------------
8490 use copy-on-write semantics as well as dirty pages tracking via read-only page
8494 ---------------------
8503 ----------------------------
8507 This capability indicates that KVM supports paravirtualized Hyper-V TLB Flush
8513 ----------------------------------
8528 ----------------------------
8532 This capability indicates that KVM supports paravirtualized Hyper-V IPI send
8537 -----------------------------------
8541 This capability indicates that KVM running on top of Hyper-V hypervisor
8543 hypercalls are handled by Level 0 hypervisor (Hyper-V) bypassing KVM.
8544 Due to the different ABI for hypercall parameters between Hyper-V and
8547 flush hypercalls by Hyper-V) so userspace should disable KVM identification
8548 in CPUID and only exposes Hyper-V identification. In this case, guest
8549 thinks it's running on Hyper-V and only use Hyper-V hypercalls.
8552 -----------------------------
8560 ---------------------------
8571 -----------------------
8576 When steal time accounting is supported it may be enabled with
8577 architecture-specific interfaces. This capability and the architecture-
8584 -------------------------
8594 an 8-byte value consisting of a one-byte Control Program Name Code (CPNC) and
8595 a 7-byte Control Program Version Code (CPVC). The CPNC determines what
8604 -------------------------------
8609 writes to user space. It can be enabled on a VM level. If enabled, MSR
8615 ---------------------------
8629 -------------------------------------
8633 When enabled, KVM will disable paravirtual features provided to the
8641 ----------------------------------------------------------
8644 :Parameters: args[0] - size of the dirty log ring
8684 00 -----------> 01 -------------> 1X -------+
8687 +------------------------------------------+
8701 using load-acquire/store-release accessors when available, or any
8729 Architecture with TSO-like ordering (such as x86) are allowed to
8735 ring structures can be backed by per-slot bitmaps. With this capability
8739 can't be enabled if the capability of KVM_CAP_DIRTY_LOG_RING_ACQ_REL
8740 hasn't been enabled, or any memslot has been existing.
8745 context. Otherwise, the stand-alone per-slot bitmap mechanism needs to
8758 KVM device "kvm-arm-vgic-its". (2) restore vgic/its tables through
8760 "kvm-arm-vgic-its". VGICv3 LPI pending status is restored. (3) save
8762 command on KVM device "kvm-arm-vgic-v3".
8765 --------------------
8795 The KVM_XEN_HVM_CONFIG_RUNSTATE flag indicates that the runstate-related
8820 specifically enabled (by the guest making the hypercall, causing the VMM
8829 -------------------------
8844 IBM pSeries (sPAPR) guest starts using them if "hcall-multi-tce" is
8845 present in the "ibm,hypertas-functions" device-tree property.
8852 This capability is always enabled.
8855 --------------------
8864 ---------------------------------
8868 When enabled, KVM will disable emulated Hyper-V features provided to the
8869 guest according to the bits Hyper-V CPUID feature leaves. Otherwise, all
8870 currently implemented Hyper-V features are provided unconditionally when
8871 Hyper-V identification is set in the HYPERV_CPUID_INTERFACE (0x40000001)
8875 ---------------------------
8881 This capability, if enabled, will cause KVM to exit to userspace
8894 ---------------------------
8900 :Returns: 0 on success, -EINVAL when arg[0] contains invalid bits
8916 -------------------------------
8922 When enabled, KVM will exit to userspace with KVM_EXIT_SYSTEM_EVENT of
8926 --------------------------------
8939 -------------------------------------
8945 :Returns: 0 on success, -EPERM if the userspace process does not
8946 have CAP_SYS_BOOT, -EINVAL if args[0] is not 0 or any vCPUs have been
8956 ------------------------------
8977 When getting the Modified Change Topology Report value, the attr->addr
8981 ---------------------------------------
8987 :Returns: 0 on success, -EINVAL if any memslot was already created.
8991 Eager Page Splitting improves the performance of dirty-logging (used
8992 in live migrations) when guest memory is backed by huge-pages. It
8993 avoids splitting huge-pages (into PAGE_SIZE pages) on fault, by doing
9004 64-bit bitmap (each bit describing a block size). The default value is
9008 ---------------------
9014 This capability returns a bitmap of support VM types. The 1-setting of bit @n
9024 production. The behavior and effective ABI for software-protected VMs is
9038 --------
9051 but it can only be enabled if ``KVM_CREATE_IRQCHIP`` or
9052 ``KVM_ENABLE_CAP(KVM_CAP_IRQCHIP_SPLIT)`` are used to enable in-kernel emulation of
9058 It can be enabled if ``KVM_CAP_TSC_DEADLINE_TIMER`` is present and the kernel
9059 has enabled in-kernel emulation of the local APIC.