Documentation/virt/kvm/api.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 ===================================================================
   4 The Definitive KVM (Kernel-based Virtual Machine) API Documentation
   5 ===================================================================
   6
   7 1. General description
   8 ======================
   9
  10 The kvm API is a set of ioctls that are issued to control various aspects
  11 of a virtual machine.  The ioctls belong to the following classes:
  12
  13  - System ioctls: These query and set global attributes which affect the
  14    whole kvm subsystem.  In addition a system ioctl is used to create
  15    virtual machines.
  16
  17  - VM ioctls: These query and set attributes that affect an entire virtual
  18    machine, for example memory layout.  In addition a VM ioctl is used to
  19    create virtual cpus (vcpus) and devices.
  20
  21    VM ioctls must be issued from the same process (address space) that was
  22    used to create the VM.
  23
  24  - vcpu ioctls: These query and set attributes that control the operation
  25    of a single virtual cpu.
  26
  27    vcpu ioctls should be issued from the same thread that was used to create
  28    the vcpu, except for asynchronous vcpu ioctl that are marked as such in
  29    the documentation.  Otherwise, the first ioctl after switching threads
  30    could see a performance impact.
  31
  32  - device ioctls: These query and set attributes that control the operation
  33    of a single device.
  34
  35    device ioctls must be issued from the same process (address space) that
  36    was used to create the VM.
  37
  38 2. File descriptors
  39 ===================
  40
  41 The kvm API is centered around file descriptors.  An initial
  42 open("/dev/kvm") obtains a handle to the kvm subsystem; this handle
  43 can be used to issue system ioctls.  A KVM_CREATE_VM ioctl on this
  44 handle will create a VM file descriptor which can be used to issue VM
  45 ioctls.  A KVM_CREATE_VCPU or KVM_CREATE_DEVICE ioctl on a VM fd will
  46 create a virtual cpu or device and return a file descriptor pointing to
  47 the new resource.  Finally, ioctls on a vcpu or device fd can be used
  48 to control the vcpu or device.  For vcpus, this includes the important
  49 task of actually running guest code.
  50
  51 In general file descriptors can be migrated among processes by means
  52 of fork() and the SCM_RIGHTS facility of unix domain socket.  These
  53 kinds of tricks are explicitly not supported by kvm.  While they will
  54 not cause harm to the host, their actual behavior is not guaranteed by
  55 the API.  See "General description" for details on the ioctl usage
  56 model that is supported by KVM.
  57
  58 It is important to note that although VM ioctls may only be issued from
  59 the process that created the VM, a VM's lifecycle is associated with its
  60 file descriptor, not its creator (process).  In other words, the VM and
  61 its resources, *including the associated address space*, are not freed
  62 until the last reference to the VM's file descriptor has been released.
  63 For example, if fork() is issued after ioctl(KVM_CREATE_VM), the VM will
  64 not be freed until both the parent (original) process and its child have
  65 put their references to the VM's file descriptor.
  66
  67 Because a VM's resources are not freed until the last reference to its
  68 file descriptor is released, creating additional references to a VM
  69 via fork(), dup(), etc... without careful consideration is strongly
  70 discouraged and may have unwanted side effects, e.g. memory allocated
  71 by and on behalf of the VM's process may not be freed/unaccounted when
  72 the VM is shut down.
  73
  74
  75 3. Extensions
  76 =============
  77
  78 As of Linux 2.6.22, the KVM ABI has been stabilized: no backward
  79 incompatible change are allowed.  However, there is an extension
  80 facility that allows backward-compatible extensions to the API to be
  81 queried and used.
  82
  83 The extension mechanism is not based on the Linux version number.
  84 Instead, kvm defines extension identifiers and a facility to query
  85 whether a particular extension identifier is available.  If it is, a
  86 set of ioctls is available for application use.
  87
  88
  89 4. API description
  90 ==================
  91
  92 This section describes ioctls that can be used to control kvm guests.
  93 For each ioctl, the following information is provided along with a
  94 description:
  95
  96   Capability:
  97       which KVM extension provides this ioctl.  Can be 'basic',
  98       which means that is will be provided by any kernel that supports
  99       API version 12 (see section 4.1), a KVM_CAP_xyz constant, which
 100       means availability needs to be checked with KVM_CHECK_EXTENSION
 101       (see section 4.4), or 'none' which means that while not all kernels
 102       support this ioctl, there's no capability bit to check its
 103       availability: for kernels that don't support the ioctl,
 104       the ioctl returns -ENOTTY.
 105
 106   Architectures:
 107       which instruction set architectures provide this ioctl.
 108       x86 includes both i386 and x86_64.
 109
 110   Type:
 111       system, vm, or vcpu.
 112
 113   Parameters:
 114       what parameters are accepted by the ioctl.
 115
 116   Returns:
 117       the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
 118       are not detailed, but errors with specific meanings are.
 119
 120
 121 4.1 KVM_GET_API_VERSION
 122 -----------------------
 123
 124 :Capability: basic
 125 :Architectures: all
 126 :Type: system ioctl
 127 :Parameters: none
 128 :Returns: the constant KVM_API_VERSION (=12)
 129
 130 This identifies the API version as the stable kvm API. It is not
 131 expected that this number will change.  However, Linux 2.6.20 and
 132 2.6.21 report earlier versions; these are not documented and not
 133 supported.  Applications should refuse to run if KVM_GET_API_VERSION
 134 returns a value other than 12.  If this check passes, all ioctls
 135 described as 'basic' will be available.
 136
 137
 138 4.2 KVM_CREATE_VM
 139 -----------------
 140
 141 :Capability: basic
 142 :Architectures: all
 143 :Type: system ioctl
 144 :Parameters: machine type identifier (KVM_VM_*)
 145 :Returns: a VM fd that can be used to control the new virtual machine.
 146
 147 The new VM has no virtual cpus and no memory.
 148 You probably want to use 0 as machine type.
 149
 150 In order to create user controlled virtual machines on S390, check
 151 KVM_CAP_S390_UCONTROL and use the flag KVM_VM_S390_UCONTROL as
 152 privileged user (CAP_SYS_ADMIN).
 153
 154 To use hardware assisted virtualization on MIPS (VZ ASE) rather than
 155 the default trap & emulate implementation (which changes the virtual
 156 memory layout to fit in user mode), check KVM_CAP_MIPS_VZ and use the
 157 flag KVM_VM_MIPS_VZ.
 158
 159
 160 On arm64, the physical address size for a VM (IPA Size limit) is limited
 161 to 40bits by default. The limit can be configured if the host supports the
 162 extension KVM_CAP_ARM_VM_IPA_SIZE. When supported, use
 163 KVM_VM_TYPE_ARM_IPA_SIZE(IPA_Bits) to set the size in the machine type
 164 identifier, where IPA_Bits is the maximum width of any physical
 165 address used by the VM. The IPA_Bits is encoded in bits[7-0] of the
 166 machine type identifier.
 167
 168 e.g, to configure a guest to use 48bit physical address size::
 169
 170     vm_fd = ioctl(dev_fd, KVM_CREATE_VM, KVM_VM_TYPE_ARM_IPA_SIZE(48));
 171
 172 The requested size (IPA_Bits) must be:
 173
 174  ==   =========================================================
 175   0   Implies default size, 40bits (for backward compatibility)
 176   N   Implies N bits, where N is a positive integer such that,
 177       32 <= N <= Host_IPA_Limit
 178  ==   =========================================================
 179
 180 Host_IPA_Limit is the maximum possible value for IPA_Bits on the host and
 181 is dependent on the CPU capability and the kernel configuration. The limit can
 182 be retrieved using KVM_CAP_ARM_VM_IPA_SIZE of the KVM_CHECK_EXTENSION
 183 ioctl() at run-time.
 184
 185 Creation of the VM will fail if the requested IPA size (whether it is
 186 implicit or explicit) is unsupported on the host.
 187
 188 Please note that configuring the IPA size does not affect the capability
 189 exposed by the guest CPUs in ID_AA64MMFR0_EL1[PARange]. It only affects
 190 size of the address translated by the stage2 level (guest physical to
 191 host physical address translations).
 192
 193
 194 4.3 KVM_GET_MSR_INDEX_LIST, KVM_GET_MSR_FEATURE_INDEX_LIST
 195 ----------------------------------------------------------
 196
 197 :Capability: basic, KVM_CAP_GET_MSR_FEATURES for KVM_GET_MSR_FEATURE_INDEX_LIST
 198 :Architectures: x86
 199 :Type: system ioctl
 200 :Parameters: struct kvm_msr_list (in/out)
 201 :Returns: 0 on success; -1 on error
 202
 203 Errors:
 204
 205   ======     ============================================================
 206   EFAULT     the msr index list cannot be read from or written to
 207   E2BIG      the msr index list is too big to fit in the array specified by
 208              the user.
 209   ======     ============================================================
 210
 211 ::
 212
 213   struct kvm_msr_list {
 214         __u32 nmsrs; /* number of msrs in entries */
 215         __u32 indices[0];
 216   };
 217
 218 The user fills in the size of the indices array in nmsrs, and in return
 219 kvm adjusts nmsrs to reflect the actual number of msrs and fills in the
 220 indices array with their numbers.
 221
 222 KVM_GET_MSR_INDEX_LIST returns the guest msrs that are supported.  The list
 223 varies by kvm version and host processor, but does not change otherwise.
 224
 225 Note: if kvm indicates supports MCE (KVM_CAP_MCE), then the MCE bank MSRs are
 226 not returned in the MSR list, as different vcpus can have a different number
 227 of banks, as set via the KVM_X86_SETUP_MCE ioctl.
 228
 229 KVM_GET_MSR_FEATURE_INDEX_LIST returns the list of MSRs that can be passed
 230 to the KVM_GET_MSRS system ioctl.  This lets userspace probe host capabilities
 231 and processor features that are exposed via MSRs (e.g., VMX capabilities).
 232 This list also varies by kvm version and host processor, but does not change
 233 otherwise.
 234
 235
 236 4.4 KVM_CHECK_EXTENSION
 237 -----------------------
 238
 239 :Capability: basic, KVM_CAP_CHECK_EXTENSION_VM for vm ioctl
 240 :Architectures: all
 241 :Type: system ioctl, vm ioctl
 242 :Parameters: extension identifier (KVM_CAP_*)
 243 :Returns: 0 if unsupported; 1 (or some other positive integer) if supported
 244
 245 The API allows the application to query about extensions to the core
 246 kvm API.  Userspace passes an extension identifier (an integer) and
 247 receives an integer that describes the extension availability.
 248 Generally 0 means no and 1 means yes, but some extensions may report
 249 additional information in the integer return value.
 250
 251 Based on their initialization different VMs may have different capabilities.
 252 It is thus encouraged to use the vm ioctl to query for capabilities (available
 253 with KVM_CAP_CHECK_EXTENSION_VM on the vm fd)
 254
 255 4.5 KVM_GET_VCPU_MMAP_SIZE
 256 --------------------------
 257
 258 :Capability: basic
 259 :Architectures: all
 260 :Type: system ioctl
 261 :Parameters: none
 262 :Returns: size of vcpu mmap area, in bytes
 263
 264 The KVM_RUN ioctl (cf.) communicates with userspace via a shared
 265 memory region.  This ioctl returns the size of that region.  See the
 266 KVM_RUN documentation for details.
 267
 268 Besides the size of the KVM_RUN communication region, other areas of
 269 the VCPU file descriptor can be mmap-ed, including:
 270
 271 - if KVM_CAP_COALESCED_MMIO is available, a page at
 272   KVM_COALESCED_MMIO_PAGE_OFFSET * PAGE_SIZE; for historical reasons,
 273   this page is included in the result of KVM_GET_VCPU_MMAP_SIZE.
 274   KVM_CAP_COALESCED_MMIO is not documented yet.
 275
 276 - if KVM_CAP_DIRTY_LOG_RING is available, a number of pages at
 277   KVM_DIRTY_LOG_PAGE_OFFSET * PAGE_SIZE.  For more information on
 278   KVM_CAP_DIRTY_LOG_RING, see section 8.3.
 279
 280
 281 4.6 KVM_SET_MEMORY_REGION
 282 -------------------------
 283
 284 :Capability: basic
 285 :Architectures: all
 286 :Type: vm ioctl
 287 :Parameters: struct kvm_memory_region (in)
 288 :Returns: 0 on success, -1 on error
 289
 290 This ioctl is obsolete and has been removed.
 291
 292
 293 4.7 KVM_CREATE_VCPU
 294 -------------------
 295
 296 :Capability: basic
 297 :Architectures: all
 298 :Type: vm ioctl
 299 :Parameters: vcpu id (apic id on x86)
 300 :Returns: vcpu fd on success, -1 on error
 301
 302 This API adds a vcpu to a virtual machine. No more than max_vcpus may be added.
 303 The vcpu id is an integer in the range [0, max_vcpu_id).
 304
 305 The recommended max_vcpus value can be retrieved using the KVM_CAP_NR_VCPUS of
 306 the KVM_CHECK_EXTENSION ioctl() at run-time.
 307 The maximum possible value for max_vcpus can be retrieved using the
 308 KVM_CAP_MAX_VCPUS of the KVM_CHECK_EXTENSION ioctl() at run-time.
 309
 310 If the KVM_CAP_NR_VCPUS does not exist, you should assume that max_vcpus is 4
 311 cpus max.
 312 If the KVM_CAP_MAX_VCPUS does not exist, you should assume that max_vcpus is
 313 same as the value returned from KVM_CAP_NR_VCPUS.
 314
 315 The maximum possible value for max_vcpu_id can be retrieved using the
 316 KVM_CAP_MAX_VCPU_ID of the KVM_CHECK_EXTENSION ioctl() at run-time.
 317
 318 If the KVM_CAP_MAX_VCPU_ID does not exist, you should assume that max_vcpu_id
 319 is the same as the value returned from KVM_CAP_MAX_VCPUS.
 320
 321 On powerpc using book3s_hv mode, the vcpus are mapped onto virtual
 322 threads in one or more virtual CPU cores.  (This is because the
 323 hardware requires all the hardware threads in a CPU core to be in the
 324 same partition.)  The KVM_CAP_PPC_SMT capability indicates the number
 325 of vcpus per virtual core (vcore).  The vcore id is obtained by
 326 dividing the vcpu id by the number of vcpus per vcore.  The vcpus in a
 327 given vcore will always be in the same physical core as each other
 328 (though that might be a different physical core from time to time).
 329 Userspace can control the threading (SMT) mode of the guest by its
 330 allocation of vcpu ids.  For example, if userspace wants
 331 single-threaded guest vcpus, it should make all vcpu ids be a multiple
 332 of the number of vcpus per vcore.
 333
 334 For virtual cpus that have been created with S390 user controlled virtual
 335 machines, the resulting vcpu fd can be memory mapped at page offset
 336 KVM_S390_SIE_PAGE_OFFSET in order to obtain a memory map of the virtual
 337 cpu's hardware control block.
 338
 339
 340 4.8 KVM_GET_DIRTY_LOG (vm ioctl)
 341 --------------------------------
 342
 343 :Capability: basic
 344 :Architectures: all
 345 :Type: vm ioctl
 346 :Parameters: struct kvm_dirty_log (in/out)
 347 :Returns: 0 on success, -1 on error
 348
 349 ::
 350
 351   /* for KVM_GET_DIRTY_LOG */
 352   struct kvm_dirty_log {
 353         __u32 slot;
 354         __u32 padding;
 355         union {
 356                 void __user *dirty_bitmap; /* one bit per page */
 357                 __u64 padding;
 358         };
 359   };
 360
 361 Given a memory slot, return a bitmap containing any pages dirtied
 362 since the last call to this ioctl.  Bit 0 is the first page in the
 363 memory slot.  Ensure the entire structure is cleared to avoid padding
 364 issues.
 365
 366 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies
 367 the address space for which you want to return the dirty bitmap.  See
 368 KVM_SET_USER_MEMORY_REGION for details on the usage of slot field.
 369
 370 The bits in the dirty bitmap are cleared before the ioctl returns, unless
 371 KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 is enabled.  For more information,
 372 see the description of the capability.
 373
 374 4.9 KVM_SET_MEMORY_ALIAS
 375 ------------------------
 376
 377 :Capability: basic
 378 :Architectures: x86
 379 :Type: vm ioctl
 380 :Parameters: struct kvm_memory_alias (in)
 381 :Returns: 0 (success), -1 (error)
 382
 383 This ioctl is obsolete and has been removed.
 384
 385
 386 4.10 KVM_RUN
 387 ------------
 388
 389 :Capability: basic
 390 :Architectures: all
 391 :Type: vcpu ioctl
 392 :Parameters: none
 393 :Returns: 0 on success, -1 on error
 394
 395 Errors:
 396
 397   =======    ==============================================================
 398   EINTR      an unmasked signal is pending
 399   ENOEXEC    the vcpu hasn't been initialized or the guest tried to execute
 400              instructions from device memory (arm64)
 401   ENOSYS     data abort outside memslots with no syndrome info and
 402              KVM_CAP_ARM_NISV_TO_USER not enabled (arm64)
 403   EPERM      SVE feature set but not finalized (arm64)
 404   =======    ==============================================================
 405
 406 This ioctl is used to run a guest virtual cpu.  While there are no
 407 explicit parameters, there is an implicit parameter block that can be
 408 obtained by mmap()ing the vcpu fd at offset 0, with the size given by
 409 KVM_GET_VCPU_MMAP_SIZE.  The parameter block is formatted as a 'struct
 410 kvm_run' (see below).
 411
 412
 413 4.11 KVM_GET_REGS
 414 -----------------
 415
 416 :Capability: basic
 417 :Architectures: all except ARM, arm64
 418 :Type: vcpu ioctl
 419 :Parameters: struct kvm_regs (out)
 420 :Returns: 0 on success, -1 on error
 421
 422 Reads the general purpose registers from the vcpu.
 423
 424 ::
 425
 426   /* x86 */
 427   struct kvm_regs {
 428         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
 429         __u64 rax, rbx, rcx, rdx;
 430         __u64 rsi, rdi, rsp, rbp;
 431         __u64 r8,  r9,  r10, r11;
 432         __u64 r12, r13, r14, r15;
 433         __u64 rip, rflags;
 434   };
 435
 436   /* mips */
 437   struct kvm_regs {
 438         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
 439         __u64 gpr[32];
 440         __u64 hi;
 441         __u64 lo;
 442         __u64 pc;
 443   };
 444
 445
 446 4.12 KVM_SET_REGS
 447 -----------------
 448
 449 :Capability: basic
 450 :Architectures: all except ARM, arm64
 451 :Type: vcpu ioctl
 452 :Parameters: struct kvm_regs (in)
 453 :Returns: 0 on success, -1 on error
 454
 455 Writes the general purpose registers into the vcpu.
 456
 457 See KVM_GET_REGS for the data structure.
 458
 459
 460 4.13 KVM_GET_SREGS
 461 ------------------
 462
 463 :Capability: basic
 464 :Architectures: x86, ppc
 465 :Type: vcpu ioctl
 466 :Parameters: struct kvm_sregs (out)
 467 :Returns: 0 on success, -1 on error
 468
 469 Reads special registers from the vcpu.
 470
 471 ::
 472
 473   /* x86 */
 474   struct kvm_sregs {
 475         struct kvm_segment cs, ds, es, fs, gs, ss;
 476         struct kvm_segment tr, ldt;
 477         struct kvm_dtable gdt, idt;
 478         __u64 cr0, cr2, cr3, cr4, cr8;
 479         __u64 efer;
 480         __u64 apic_base;
 481         __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
 482   };
 483
 484   /* ppc -- see arch/powerpc/include/uapi/asm/kvm.h */
 485
 486 interrupt_bitmap is a bitmap of pending external interrupts.  At most
 487 one bit may be set.  This interrupt has been acknowledged by the APIC
 488 but not yet injected into the cpu core.
 489
 490
 491 4.14 KVM_SET_SREGS
 492 ------------------
 493
 494 :Capability: basic
 495 :Architectures: x86, ppc
 496 :Type: vcpu ioctl
 497 :Parameters: struct kvm_sregs (in)
 498 :Returns: 0 on success, -1 on error
 499
 500 Writes special registers into the vcpu.  See KVM_GET_SREGS for the
 501 data structures.
 502
 503
 504 4.15 KVM_TRANSLATE
 505 ------------------
 506
 507 :Capability: basic
 508 :Architectures: x86
 509 :Type: vcpu ioctl
 510 :Parameters: struct kvm_translation (in/out)
 511 :Returns: 0 on success, -1 on error
 512
 513 Translates a virtual address according to the vcpu's current address
 514 translation mode.
 515
 516 ::
 517
 518   struct kvm_translation {
 519         /* in */
 520         __u64 linear_address;
 521
 522         /* out */
 523         __u64 physical_address;
 524         __u8  valid;
 525         __u8  writeable;
 526         __u8  usermode;
 527         __u8  pad[5];
 528   };
 529
 530
 531 4.16 KVM_INTERRUPT
 532 ------------------
 533
 534 :Capability: basic
 535 :Architectures: x86, ppc, mips
 536 :Type: vcpu ioctl
 537 :Parameters: struct kvm_interrupt (in)
 538 :Returns: 0 on success, negative on failure.
 539
 540 Queues a hardware interrupt vector to be injected.
 541
 542 ::
 543
 544   /* for KVM_INTERRUPT */
 545   struct kvm_interrupt {
 546         /* in */
 547         __u32 irq;
 548   };
 549
 550 X86:
 551 ^^^^
 552
 553 :Returns:
 554
 555         ========= ===================================
 556           0       on success,
 557          -EEXIST  if an interrupt is already enqueued
 558          -EINVAL  the irq number is invalid
 559          -ENXIO   if the PIC is in the kernel
 560          -EFAULT  if the pointer is invalid
 561         ========= ===================================
 562
 563 Note 'irq' is an interrupt vector, not an interrupt pin or line. This
 564 ioctl is useful if the in-kernel PIC is not used.
 565
 566 PPC:
 567 ^^^^
 568
 569 Queues an external interrupt to be injected. This ioctl is overleaded
 570 with 3 different irq values:
 571
 572 a) KVM_INTERRUPT_SET
 573
 574    This injects an edge type external interrupt into the guest once it's ready
 575    to receive interrupts. When injected, the interrupt is done.
 576
 577 b) KVM_INTERRUPT_UNSET
 578
 579    This unsets any pending interrupt.
 580
 581    Only available with KVM_CAP_PPC_UNSET_IRQ.
 582
 583 c) KVM_INTERRUPT_SET_LEVEL
 584
 585    This injects a level type external interrupt into the guest context. The
 586    interrupt stays pending until a specific ioctl with KVM_INTERRUPT_UNSET
 587    is triggered.
 588
 589    Only available with KVM_CAP_PPC_IRQ_LEVEL.
 590
 591 Note that any value for 'irq' other than the ones stated above is invalid
 592 and incurs unexpected behavior.
 593
 594 This is an asynchronous vcpu ioctl and can be invoked from any thread.
 595
 596 MIPS:
 597 ^^^^^
 598
 599 Queues an external interrupt to be injected into the virtual CPU. A negative
 600 interrupt number dequeues the interrupt.
 601
 602 This is an asynchronous vcpu ioctl and can be invoked from any thread.
 603
 604
 605 4.17 KVM_DEBUG_GUEST
 606 --------------------
 607
 608 :Capability: basic
 609 :Architectures: none
 610 :Type: vcpu ioctl
 611 :Parameters: none)
 612 :Returns: -1 on error
 613
 614 Support for this has been removed.  Use KVM_SET_GUEST_DEBUG instead.
 615
 616
 617 4.18 KVM_GET_MSRS
 618 -----------------
 619
 620 :Capability: basic (vcpu), KVM_CAP_GET_MSR_FEATURES (system)
 621 :Architectures: x86
 622 :Type: system ioctl, vcpu ioctl
 623 :Parameters: struct kvm_msrs (in/out)
 624 :Returns: number of msrs successfully returned;
 625           -1 on error
 626
 627 When used as a system ioctl:
 628 Reads the values of MSR-based features that are available for the VM.  This
 629 is similar to KVM_GET_SUPPORTED_CPUID, but it returns MSR indices and values.
 630 The list of msr-based features can be obtained using KVM_GET_MSR_FEATURE_INDEX_LIST
 631 in a system ioctl.
 632
 633 When used as a vcpu ioctl:
 634 Reads model-specific registers from the vcpu.  Supported msr indices can
 635 be obtained using KVM_GET_MSR_INDEX_LIST in a system ioctl.
 636
 637 ::
 638
 639   struct kvm_msrs {
 640         __u32 nmsrs; /* number of msrs in entries */
 641         __u32 pad;
 642
 643         struct kvm_msr_entry entries[0];
 644   };
 645
 646   struct kvm_msr_entry {
 647         __u32 index;
 648         __u32 reserved;
 649         __u64 data;
 650   };
 651
 652 Application code should set the 'nmsrs' member (which indicates the
 653 size of the entries array) and the 'index' member of each array entry.
 654 kvm will fill in the 'data' member.
 655
 656
 657 4.19 KVM_SET_MSRS
 658 -----------------
 659
 660 :Capability: basic
 661 :Architectures: x86
 662 :Type: vcpu ioctl
 663 :Parameters: struct kvm_msrs (in)
 664 :Returns: number of msrs successfully set (see below), -1 on error
 665
 666 Writes model-specific registers to the vcpu.  See KVM_GET_MSRS for the
 667 data structures.
 668
 669 Application code should set the 'nmsrs' member (which indicates the
 670 size of the entries array), and the 'index' and 'data' members of each
 671 array entry.
 672
 673 It tries to set the MSRs in array entries[] one by one. If setting an MSR
 674 fails, e.g., due to setting reserved bits, the MSR isn't supported/emulated
 675 by KVM, etc..., it stops processing the MSR list and returns the number of
 676 MSRs that have been set successfully.
 677
 678
 679 4.20 KVM_SET_CPUID
 680 ------------------
 681
 682 :Capability: basic
 683 :Architectures: x86
 684 :Type: vcpu ioctl
 685 :Parameters: struct kvm_cpuid (in)
 686 :Returns: 0 on success, -1 on error
 687
 688 Defines the vcpu responses to the cpuid instruction.  Applications
 689 should use the KVM_SET_CPUID2 ioctl if available.
 690
 691 Caveat emptor:
 692   - If this IOCTL fails, KVM gives no guarantees that previous valid CPUID
 693     configuration (if there is) is not corrupted. Userspace can get a copy
 694     of the resulting CPUID configuration through KVM_GET_CPUID2 in case.
 695   - Using KVM_SET_CPUID{,2} after KVM_RUN, i.e. changing the guest vCPU model
 696     after running the guest, may cause guest instability.
 697   - Using heterogeneous CPUID configurations, modulo APIC IDs, topology, etc...
 698     may cause guest instability.
 699
 700 ::
 701
 702   struct kvm_cpuid_entry {
 703         __u32 function;
 704         __u32 eax;
 705         __u32 ebx;
 706         __u32 ecx;
 707         __u32 edx;
 708         __u32 padding;
 709   };
 710
 711   /* for KVM_SET_CPUID */
 712   struct kvm_cpuid {
 713         __u32 nent;
 714         __u32 padding;
 715         struct kvm_cpuid_entry entries[0];
 716   };
 717
 718
 719 4.21 KVM_SET_SIGNAL_MASK
 720 ------------------------
 721
 722 :Capability: basic
 723 :Architectures: all
 724 :Type: vcpu ioctl
 725 :Parameters: struct kvm_signal_mask (in)
 726 :Returns: 0 on success, -1 on error
 727
 728 Defines which signals are blocked during execution of KVM_RUN.  This
 729 signal mask temporarily overrides the threads signal mask.  Any
 730 unblocked signal received (except SIGKILL and SIGSTOP, which retain
 731 their traditional behaviour) will cause KVM_RUN to return with -EINTR.
 732
 733 Note the signal will only be delivered if not blocked by the original
 734 signal mask.
 735
 736 ::
 737
 738   /* for KVM_SET_SIGNAL_MASK */
 739   struct kvm_signal_mask {
 740         __u32 len;
 741         __u8  sigset[0];
 742   };
 743
 744
 745 4.22 KVM_GET_FPU
 746 ----------------
 747
 748 :Capability: basic
 749 :Architectures: x86
 750 :Type: vcpu ioctl
 751 :Parameters: struct kvm_fpu (out)
 752 :Returns: 0 on success, -1 on error
 753
 754 Reads the floating point state from the vcpu.
 755
 756 ::
 757
 758   /* for KVM_GET_FPU and KVM_SET_FPU */
 759   struct kvm_fpu {
 760         __u8  fpr[8][16];
 761         __u16 fcw;
 762         __u16 fsw;
 763         __u8  ftwx;  /* in fxsave format */
 764         __u8  pad1;
 765         __u16 last_opcode;
 766         __u64 last_ip;
 767         __u64 last_dp;
 768         __u8  xmm[16][16];
 769         __u32 mxcsr;
 770         __u32 pad2;
 771   };
 772
 773
 774 4.23 KVM_SET_FPU
 775 ----------------
 776
 777 :Capability: basic
 778 :Architectures: x86
 779 :Type: vcpu ioctl
 780 :Parameters: struct kvm_fpu (in)
 781 :Returns: 0 on success, -1 on error
 782
 783 Writes the floating point state to the vcpu.
 784
 785 ::
 786
 787   /* for KVM_GET_FPU and KVM_SET_FPU */
 788   struct kvm_fpu {
 789         __u8  fpr[8][16];
 790         __u16 fcw;
 791         __u16 fsw;
 792         __u8  ftwx;  /* in fxsave format */
 793         __u8  pad1;
 794         __u16 last_opcode;
 795         __u64 last_ip;
 796         __u64 last_dp;
 797         __u8  xmm[16][16];
 798         __u32 mxcsr;
 799         __u32 pad2;
 800   };
 801
 802
 803 4.24 KVM_CREATE_IRQCHIP
 804 -----------------------
 805
 806 :Capability: KVM_CAP_IRQCHIP, KVM_CAP_S390_IRQCHIP (s390)
 807 :Architectures: x86, ARM, arm64, s390
 808 :Type: vm ioctl
 809 :Parameters: none
 810 :Returns: 0 on success, -1 on error
 811
 812 Creates an interrupt controller model in the kernel.
 813 On x86, creates a virtual ioapic, a virtual PIC (two PICs, nested), and sets up
 814 future vcpus to have a local APIC.  IRQ routing for GSIs 0-15 is set to both
 815 PIC and IOAPIC; GSI 16-23 only go to the IOAPIC.
 816 On ARM/arm64, a GICv2 is created. Any other GIC versions require the usage of
 817 KVM_CREATE_DEVICE, which also supports creating a GICv2.  Using
 818 KVM_CREATE_DEVICE is preferred over KVM_CREATE_IRQCHIP for GICv2.
 819 On s390, a dummy irq routing table is created.
 820
 821 Note that on s390 the KVM_CAP_S390_IRQCHIP vm capability needs to be enabled
 822 before KVM_CREATE_IRQCHIP can be used.
 823
 824
 825 4.25 KVM_IRQ_LINE
 826 -----------------
 827
 828 :Capability: KVM_CAP_IRQCHIP
 829 :Architectures: x86, arm, arm64
 830 :Type: vm ioctl
 831 :Parameters: struct kvm_irq_level
 832 :Returns: 0 on success, -1 on error
 833
 834 Sets the level of a GSI input to the interrupt controller model in the kernel.
 835 On some architectures it is required that an interrupt controller model has
 836 been previously created with KVM_CREATE_IRQCHIP.  Note that edge-triggered
 837 interrupts require the level to be set to 1 and then back to 0.
 838
 839 On real hardware, interrupt pins can be active-low or active-high.  This
 840 does not matter for the level field of struct kvm_irq_level: 1 always
 841 means active (asserted), 0 means inactive (deasserted).
 842
 843 x86 allows the operating system to program the interrupt polarity
 844 (active-low/active-high) for level-triggered interrupts, and KVM used
 845 to consider the polarity.  However, due to bitrot in the handling of
 846 active-low interrupts, the above convention is now valid on x86 too.
 847 This is signaled by KVM_CAP_X86_IOAPIC_POLARITY_IGNORED.  Userspace
 848 should not present interrupts to the guest as active-low unless this
 849 capability is present (or unless it is not using the in-kernel irqchip,
 850 of course).
 851
 852
 853 ARM/arm64 can signal an interrupt either at the CPU level, or at the
 854 in-kernel irqchip (GIC), and for in-kernel irqchip can tell the GIC to
 855 use PPIs designated for specific cpus.  The irq field is interpreted
 856 like this::
 857
 858   bits:  |  31 ... 28  | 27 ... 24 | 23  ... 16 | 15 ... 0 |
 859   field: | vcpu2_index | irq_type  | vcpu_index |  irq_id  |
 860
 861 The irq_type field has the following values:
 862
 863 - irq_type[0]:
 864                out-of-kernel GIC: irq_id 0 is IRQ, irq_id 1 is FIQ
 865 - irq_type[1]:
 866                in-kernel GIC: SPI, irq_id between 32 and 1019 (incl.)
 867                (the vcpu_index field is ignored)
 868 - irq_type[2]:
 869                in-kernel GIC: PPI, irq_id between 16 and 31 (incl.)
 870
 871 (The irq_id field thus corresponds nicely to the IRQ ID in the ARM GIC specs)
 872
 873 In both cases, level is used to assert/deassert the line.
 874
 875 When KVM_CAP_ARM_IRQ_LINE_LAYOUT_2 is supported, the target vcpu is
 876 identified as (256 * vcpu2_index + vcpu_index). Otherwise, vcpu2_index
 877 must be zero.
 878
 879 Note that on arm/arm64, the KVM_CAP_IRQCHIP capability only conditions
 880 injection of interrupts for the in-kernel irqchip. KVM_IRQ_LINE can always
 881 be used for a userspace interrupt controller.
 882
 883 ::
 884
 885   struct kvm_irq_level {
 886         union {
 887                 __u32 irq;     /* GSI */
 888                 __s32 status;  /* not used for KVM_IRQ_LEVEL */
 889         };
 890         __u32 level;           /* 0 or 1 */
 891   };
 892
 893
 894 4.26 KVM_GET_IRQCHIP
 895 --------------------
 896
 897 :Capability: KVM_CAP_IRQCHIP
 898 :Architectures: x86
 899 :Type: vm ioctl
 900 :Parameters: struct kvm_irqchip (in/out)
 901 :Returns: 0 on success, -1 on error
 902
 903 Reads the state of a kernel interrupt controller created with
 904 KVM_CREATE_IRQCHIP into a buffer provided by the caller.
 905
 906 ::
 907
 908   struct kvm_irqchip {
 909         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
 910         __u32 pad;
 911         union {
 912                 char dummy[512];  /* reserving space */
 913                 struct kvm_pic_state pic;
 914                 struct kvm_ioapic_state ioapic;
 915         } chip;
 916   };
 917
 918
 919 4.27 KVM_SET_IRQCHIP
 920 --------------------
 921
 922 :Capability: KVM_CAP_IRQCHIP
 923 :Architectures: x86
 924 :Type: vm ioctl
 925 :Parameters: struct kvm_irqchip (in)
 926 :Returns: 0 on success, -1 on error
 927
 928 Sets the state of a kernel interrupt controller created with
 929 KVM_CREATE_IRQCHIP from a buffer provided by the caller.
 930
 931 ::
 932
 933   struct kvm_irqchip {
 934         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
 935         __u32 pad;
 936         union {
 937                 char dummy[512];  /* reserving space */
 938                 struct kvm_pic_state pic;
 939                 struct kvm_ioapic_state ioapic;
 940         } chip;
 941   };
 942
 943
 944 4.28 KVM_XEN_HVM_CONFIG
 945 -----------------------
 946
 947 :Capability: KVM_CAP_XEN_HVM
 948 :Architectures: x86
 949 :Type: vm ioctl
 950 :Parameters: struct kvm_xen_hvm_config (in)
 951 :Returns: 0 on success, -1 on error
 952
 953 Sets the MSR that the Xen HVM guest uses to initialize its hypercall
 954 page, and provides the starting address and size of the hypercall
 955 blobs in userspace.  When the guest writes the MSR, kvm copies one
 956 page of a blob (32- or 64-bit, depending on the vcpu mode) to guest
 957 memory.
 958
 959 ::
 960
 961   struct kvm_xen_hvm_config {
 962         __u32 flags;
 963         __u32 msr;
 964         __u64 blob_addr_32;
 965         __u64 blob_addr_64;
 966         __u8 blob_size_32;
 967         __u8 blob_size_64;
 968         __u8 pad2[30];
 969   };
 970
 971 If the KVM_XEN_HVM_CONFIG_INTERCEPT_HCALL flag is returned from the
 972 KVM_CAP_XEN_HVM check, it may be set in the flags field of this ioctl.
 973 This requests KVM to generate the contents of the hypercall page
 974 automatically; hypercalls will be intercepted and passed to userspace
 975 through KVM_EXIT_XEN.  In this case, all of the blob size and address
 976 fields must be zero.
 977
 978 No other flags are currently valid in the struct kvm_xen_hvm_config.
 979
 980 4.29 KVM_GET_CLOCK
 981 ------------------
 982
 983 :Capability: KVM_CAP_ADJUST_CLOCK
 984 :Architectures: x86
 985 :Type: vm ioctl
 986 :Parameters: struct kvm_clock_data (out)
 987 :Returns: 0 on success, -1 on error
 988
 989 Gets the current timestamp of kvmclock as seen by the current guest. In
 990 conjunction with KVM_SET_CLOCK, it is used to ensure monotonicity on scenarios
 991 such as migration.
 992
 993 When KVM_CAP_ADJUST_CLOCK is passed to KVM_CHECK_EXTENSION, it returns the
 994 set of bits that KVM can return in struct kvm_clock_data's flag member.
 995
 996 The only flag defined now is KVM_CLOCK_TSC_STABLE.  If set, the returned
 997 value is the exact kvmclock value seen by all VCPUs at the instant
 998 when KVM_GET_CLOCK was called.  If clear, the returned value is simply
 999 CLOCK_MONOTONIC plus a constant offset; the offset can be modified
1000 with KVM_SET_CLOCK.  KVM will try to make all VCPUs follow this clock,
1001 but the exact value read by each VCPU could differ, because the host
1002 TSC is not stable.
1003
1004 ::
1005
1006   struct kvm_clock_data {
1007         __u64 clock;  /* kvmclock current value */
1008         __u32 flags;
1009         __u32 pad[9];
1010   };
1011
1012
1013 4.30 KVM_SET_CLOCK
1014 ------------------
1015
1016 :Capability: KVM_CAP_ADJUST_CLOCK
1017 :Architectures: x86
1018 :Type: vm ioctl
1019 :Parameters: struct kvm_clock_data (in)
1020 :Returns: 0 on success, -1 on error
1021
1022 Sets the current timestamp of kvmclock to the value specified in its parameter.
1023 In conjunction with KVM_GET_CLOCK, it is used to ensure monotonicity on scenarios
1024 such as migration.
1025
1026 ::
1027
1028   struct kvm_clock_data {
1029         __u64 clock;  /* kvmclock current value */
1030         __u32 flags;
1031         __u32 pad[9];
1032   };
1033
1034
1035 4.31 KVM_GET_VCPU_EVENTS
1036 ------------------------
1037
1038 :Capability: KVM_CAP_VCPU_EVENTS
1039 :Extended by: KVM_CAP_INTR_SHADOW
1040 :Architectures: x86, arm, arm64
1041 :Type: vcpu ioctl
1042 :Parameters: struct kvm_vcpu_event (out)
1043 :Returns: 0 on success, -1 on error
1044
1045 X86:
1046 ^^^^
1047
1048 Gets currently pending exceptions, interrupts, and NMIs as well as related
1049 states of the vcpu.
1050
1051 ::
1052
1053   struct kvm_vcpu_events {
1054         struct {
1055                 __u8 injected;
1056                 __u8 nr;
1057                 __u8 has_error_code;
1058                 __u8 pending;
1059                 __u32 error_code;
1060         } exception;
1061         struct {
1062                 __u8 injected;
1063                 __u8 nr;
1064                 __u8 soft;
1065                 __u8 shadow;
1066         } interrupt;
1067         struct {
1068                 __u8 injected;
1069                 __u8 pending;
1070                 __u8 masked;
1071                 __u8 pad;
1072         } nmi;
1073         __u32 sipi_vector;
1074         __u32 flags;
1075         struct {
1076                 __u8 smm;
1077                 __u8 pending;
1078                 __u8 smm_inside_nmi;
1079                 __u8 latched_init;
1080         } smi;
1081         __u8 reserved[27];
1082         __u8 exception_has_payload;
1083         __u64 exception_payload;
1084   };
1085
1086 The following bits are defined in the flags field:
1087
1088 - KVM_VCPUEVENT_VALID_SHADOW may be set to signal that
1089   interrupt.shadow contains a valid state.
1090
1091 - KVM_VCPUEVENT_VALID_SMM may be set to signal that smi contains a
1092   valid state.
1093
1094 - KVM_VCPUEVENT_VALID_PAYLOAD may be set to signal that the
1095   exception_has_payload, exception_payload, and exception.pending
1096   fields contain a valid state. This bit will be set whenever
1097   KVM_CAP_EXCEPTION_PAYLOAD is enabled.
1098
1099 ARM/ARM64:
1100 ^^^^^^^^^^
1101
1102 If the guest accesses a device that is being emulated by the host kernel in
1103 such a way that a real device would generate a physical SError, KVM may make
1104 a virtual SError pending for that VCPU. This system error interrupt remains
1105 pending until the guest takes the exception by unmasking PSTATE.A.
1106
1107 Running the VCPU may cause it to take a pending SError, or make an access that
1108 causes an SError to become pending. The event's description is only valid while
1109 the VPCU is not running.
1110
1111 This API provides a way to read and write the pending 'event' state that is not
1112 visible to the guest. To save, restore or migrate a VCPU the struct representing
1113 the state can be read then written using this GET/SET API, along with the other
1114 guest-visible registers. It is not possible to 'cancel' an SError that has been
1115 made pending.
1116
1117 A device being emulated in user-space may also wish to generate an SError. To do
1118 this the events structure can be populated by user-space. The current state
1119 should be read first, to ensure no existing SError is pending. If an existing
1120 SError is pending, the architecture's 'Multiple SError interrupts' rules should
1121 be followed. (2.5.3 of DDI0587.a "ARM Reliability, Availability, and
1122 Serviceability (RAS) Specification").
1123
1124 SError exceptions always have an ESR value. Some CPUs have the ability to
1125 specify what the virtual SError's ESR value should be. These systems will
1126 advertise KVM_CAP_ARM_INJECT_SERROR_ESR. In this case exception.has_esr will
1127 always have a non-zero value when read, and the agent making an SError pending
1128 should specify the ISS field in the lower 24 bits of exception.serror_esr. If
1129 the system supports KVM_CAP_ARM_INJECT_SERROR_ESR, but user-space sets the events
1130 with exception.has_esr as zero, KVM will choose an ESR.
1131
1132 Specifying exception.has_esr on a system that does not support it will return
1133 -EINVAL. Setting anything other than the lower 24bits of exception.serror_esr
1134 will return -EINVAL.
1135
1136 It is not possible to read back a pending external abort (injected via
1137 KVM_SET_VCPU_EVENTS or otherwise) because such an exception is always delivered
1138 directly to the virtual CPU).
1139
1140 ::
1141
1142   struct kvm_vcpu_events {
1143         struct {
1144                 __u8 serror_pending;
1145                 __u8 serror_has_esr;
1146                 __u8 ext_dabt_pending;
1147                 /* Align it to 8 bytes */
1148                 __u8 pad[5];
1149                 __u64 serror_esr;
1150         } exception;
1151         __u32 reserved[12];
1152   };
1153
1154 4.32 KVM_SET_VCPU_EVENTS
1155 ------------------------
1156
1157 :Capability: KVM_CAP_VCPU_EVENTS
1158 :Extended by: KVM_CAP_INTR_SHADOW
1159 :Architectures: x86, arm, arm64
1160 :Type: vcpu ioctl
1161 :Parameters: struct kvm_vcpu_event (in)
1162 :Returns: 0 on success, -1 on error
1163
1164 X86:
1165 ^^^^
1166
1167 Set pending exceptions, interrupts, and NMIs as well as related states of the
1168 vcpu.
1169
1170 See KVM_GET_VCPU_EVENTS for the data structure.
1171
1172 Fields that may be modified asynchronously by running VCPUs can be excluded
1173 from the update. These fields are nmi.pending, sipi_vector, smi.smm,
1174 smi.pending. Keep the corresponding bits in the flags field cleared to
1175 suppress overwriting the current in-kernel state. The bits are:
1176
1177 ===============================  ==================================
1178 KVM_VCPUEVENT_VALID_NMI_PENDING  transfer nmi.pending to the kernel
1179 KVM_VCPUEVENT_VALID_SIPI_VECTOR  transfer sipi_vector
1180 KVM_VCPUEVENT_VALID_SMM          transfer the smi sub-struct.
1181 ===============================  ==================================
1182
1183 If KVM_CAP_INTR_SHADOW is available, KVM_VCPUEVENT_VALID_SHADOW can be set in
1184 the flags field to signal that interrupt.shadow contains a valid state and
1185 shall be written into the VCPU.
1186
1187 KVM_VCPUEVENT_VALID_SMM can only be set if KVM_CAP_X86_SMM is available.
1188
1189 If KVM_CAP_EXCEPTION_PAYLOAD is enabled, KVM_VCPUEVENT_VALID_PAYLOAD
1190 can be set in the flags field to signal that the
1191 exception_has_payload, exception_payload, and exception.pending fields
1192 contain a valid state and shall be written into the VCPU.
1193
1194 ARM/ARM64:
1195 ^^^^^^^^^^
1196
1197 User space may need to inject several types of events to the guest.
1198
1199 Set the pending SError exception state for this VCPU. It is not possible to
1200 'cancel' an Serror that has been made pending.
1201
1202 If the guest performed an access to I/O memory which could not be handled by
1203 userspace, for example because of missing instruction syndrome decode
1204 information or because there is no device mapped at the accessed IPA, then
1205 userspace can ask the kernel to inject an external abort using the address
1206 from the exiting fault on the VCPU. It is a programming error to set
1207 ext_dabt_pending after an exit which was not either KVM_EXIT_MMIO or
1208 KVM_EXIT_ARM_NISV. This feature is only available if the system supports
1209 KVM_CAP_ARM_INJECT_EXT_DABT. This is a helper which provides commonality in
1210 how userspace reports accesses for the above cases to guests, across different
1211 userspace implementations. Nevertheless, userspace can still emulate all Arm
1212 exceptions by manipulating individual registers using the KVM_SET_ONE_REG API.
1213
1214 See KVM_GET_VCPU_EVENTS for the data structure.
1215
1216
1217 4.33 KVM_GET_DEBUGREGS
1218 ----------------------
1219
1220 :Capability: KVM_CAP_DEBUGREGS
1221 :Architectures: x86
1222 :Type: vm ioctl
1223 :Parameters: struct kvm_debugregs (out)
1224 :Returns: 0 on success, -1 on error
1225
1226 Reads debug registers from the vcpu.
1227
1228 ::
1229
1230   struct kvm_debugregs {
1231         __u64 db[4];
1232         __u64 dr6;
1233         __u64 dr7;
1234         __u64 flags;
1235         __u64 reserved[9];
1236   };
1237
1238
1239 4.34 KVM_SET_DEBUGREGS
1240 ----------------------
1241
1242 :Capability: KVM_CAP_DEBUGREGS
1243 :Architectures: x86
1244 :Type: vm ioctl
1245 :Parameters: struct kvm_debugregs (in)
1246 :Returns: 0 on success, -1 on error
1247
1248 Writes debug registers into the vcpu.
1249
1250 See KVM_GET_DEBUGREGS for the data structure. The flags field is unused
1251 yet and must be cleared on entry.
1252
1253
1254 4.35 KVM_SET_USER_MEMORY_REGION
1255 -------------------------------
1256
1257 :Capability: KVM_CAP_USER_MEMORY
1258 :Architectures: all
1259 :Type: vm ioctl
1260 :Parameters: struct kvm_userspace_memory_region (in)
1261 :Returns: 0 on success, -1 on error
1262
1263 ::
1264
1265   struct kvm_userspace_memory_region {
1266         __u32 slot;
1267         __u32 flags;
1268         __u64 guest_phys_addr;
1269         __u64 memory_size; /* bytes */
1270         __u64 userspace_addr; /* start of the userspace allocated memory */
1271   };
1272
1273   /* for kvm_memory_region::flags */
1274   #define KVM_MEM_LOG_DIRTY_PAGES       (1UL << 0)
1275   #define KVM_MEM_READONLY      (1UL << 1)
1276
1277 This ioctl allows the user to create, modify or delete a guest physical
1278 memory slot.  Bits 0-15 of "slot" specify the slot id and this value
1279 should be less than the maximum number of user memory slots supported per
1280 VM.  The maximum allowed slots can be queried using KVM_CAP_NR_MEMSLOTS.
1281 Slots may not overlap in guest physical address space.
1282
1283 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of "slot"
1284 specifies the address space which is being modified.  They must be
1285 less than the value that KVM_CHECK_EXTENSION returns for the
1286 KVM_CAP_MULTI_ADDRESS_SPACE capability.  Slots in separate address spaces
1287 are unrelated; the restriction on overlapping slots only applies within
1288 each address space.
1289
1290 Deleting a slot is done by passing zero for memory_size.  When changing
1291 an existing slot, it may be moved in the guest physical memory space,
1292 or its flags may be modified, but it may not be resized.
1293
1294 Memory for the region is taken starting at the address denoted by the
1295 field userspace_addr, which must point at user addressable memory for
1296 the entire memory slot size.  Any object may back this memory, including
1297 anonymous memory, ordinary files, and hugetlbfs.
1298
1299 On architectures that support a form of address tagging, userspace_addr must
1300 be an untagged address.
1301
1302 It is recommended that the lower 21 bits of guest_phys_addr and userspace_addr
1303 be identical.  This allows large pages in the guest to be backed by large
1304 pages in the host.
1305
1306 The flags field supports two flags: KVM_MEM_LOG_DIRTY_PAGES and
1307 KVM_MEM_READONLY.  The former can be set to instruct KVM to keep track of
1308 writes to memory within the slot.  See KVM_GET_DIRTY_LOG ioctl to know how to
1309 use it.  The latter can be set, if KVM_CAP_READONLY_MEM capability allows it,
1310 to make a new slot read-only.  In this case, writes to this memory will be
1311 posted to userspace as KVM_EXIT_MMIO exits.
1312
1313 When the KVM_CAP_SYNC_MMU capability is available, changes in the backing of
1314 the memory region are automatically reflected into the guest.  For example, an
1315 mmap() that affects the region will be made visible immediately.  Another
1316 example is madvise(MADV_DROP).
1317
1318 It is recommended to use this API instead of the KVM_SET_MEMORY_REGION ioctl.
1319 The KVM_SET_MEMORY_REGION does not allow fine grained control over memory
1320 allocation and is deprecated.
1321
1322
1323 4.36 KVM_SET_TSS_ADDR
1324 ---------------------
1325
1326 :Capability: KVM_CAP_SET_TSS_ADDR
1327 :Architectures: x86
1328 :Type: vm ioctl
1329 :Parameters: unsigned long tss_address (in)
1330 :Returns: 0 on success, -1 on error
1331
1332 This ioctl defines the physical address of a three-page region in the guest
1333 physical address space.  The region must be within the first 4GB of the
1334 guest physical address space and must not conflict with any memory slot
1335 or any mmio address.  The guest may malfunction if it accesses this memory
1336 region.
1337
1338 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
1339 because of a quirk in the virtualization implementation (see the internals
1340 documentation when it pops into existence).
1341
1342
1343 4.37 KVM_ENABLE_CAP
1344 -------------------
1345
1346 :Capability: KVM_CAP_ENABLE_CAP
1347 :Architectures: mips, ppc, s390
1348 :Type: vcpu ioctl
1349 :Parameters: struct kvm_enable_cap (in)
1350 :Returns: 0 on success; -1 on error
1351
1352 :Capability: KVM_CAP_ENABLE_CAP_VM
1353 :Architectures: all
1354 :Type: vm ioctl
1355 :Parameters: struct kvm_enable_cap (in)
1356 :Returns: 0 on success; -1 on error
1357
1358 .. note::
1359
1360    Not all extensions are enabled by default. Using this ioctl the application
1361    can enable an extension, making it available to the guest.
1362
1363 On systems that do not support this ioctl, it always fails. On systems that
1364 do support it, it only works for extensions that are supported for enablement.
1365
1366 To check if a capability can be enabled, the KVM_CHECK_EXTENSION ioctl should
1367 be used.
1368
1369 ::
1370
1371   struct kvm_enable_cap {
1372        /* in */
1373        __u32 cap;
1374
1375 The capability that is supposed to get enabled.
1376
1377 ::
1378
1379        __u32 flags;
1380
1381 A bitfield indicating future enhancements. Has to be 0 for now.
1382
1383 ::
1384
1385        __u64 args[4];
1386
1387 Arguments for enabling a feature. If a feature needs initial values to
1388 function properly, this is the place to put them.
1389
1390 ::
1391
1392        __u8  pad[64];
1393   };
1394
1395 The vcpu ioctl should be used for vcpu-specific capabilities, the vm ioctl
1396 for vm-wide capabilities.
1397
1398 4.38 KVM_GET_MP_STATE
1399 ---------------------
1400
1401 :Capability: KVM_CAP_MP_STATE
1402 :Architectures: x86, s390, arm, arm64
1403 :Type: vcpu ioctl
1404 :Parameters: struct kvm_mp_state (out)
1405 :Returns: 0 on success; -1 on error
1406
1407 ::
1408
1409   struct kvm_mp_state {
1410         __u32 mp_state;
1411   };
1412
1413 Returns the vcpu's current "multiprocessing state" (though also valid on
1414 uniprocessor guests).
1415
1416 Possible values are:
1417
1418    ==========================    ===============================================
1419    KVM_MP_STATE_RUNNABLE         the vcpu is currently running [x86,arm/arm64]
1420    KVM_MP_STATE_UNINITIALIZED    the vcpu is an application processor (AP)
1421                                  which has not yet received an INIT signal [x86]
1422    KVM_MP_STATE_INIT_RECEIVED    the vcpu has received an INIT signal, and is
1423                                  now ready for a SIPI [x86]
1424    KVM_MP_STATE_HALTED           the vcpu has executed a HLT instruction and
1425                                  is waiting for an interrupt [x86]
1426    KVM_MP_STATE_SIPI_RECEIVED    the vcpu has just received a SIPI (vector
1427                                  accessible via KVM_GET_VCPU_EVENTS) [x86]
1428    KVM_MP_STATE_STOPPED          the vcpu is stopped [s390,arm/arm64]
1429    KVM_MP_STATE_CHECK_STOP       the vcpu is in a special error state [s390]
1430    KVM_MP_STATE_OPERATING        the vcpu is operating (running or halted)
1431                                  [s390]
1432    KVM_MP_STATE_LOAD             the vcpu is in a special load/startup state
1433                                  [s390]
1434    ==========================    ===============================================
1435
1436 On x86, this ioctl is only useful after KVM_CREATE_IRQCHIP. Without an
1437 in-kernel irqchip, the multiprocessing state must be maintained by userspace on
1438 these architectures.
1439
1440 For arm/arm64:
1441 ^^^^^^^^^^^^^^
1442
1443 The only states that are valid are KVM_MP_STATE_STOPPED and
1444 KVM_MP_STATE_RUNNABLE which reflect if the vcpu is paused or not.
1445
1446 4.39 KVM_SET_MP_STATE
1447 ---------------------
1448
1449 :Capability: KVM_CAP_MP_STATE
1450 :Architectures: x86, s390, arm, arm64
1451 :Type: vcpu ioctl
1452 :Parameters: struct kvm_mp_state (in)
1453 :Returns: 0 on success; -1 on error
1454
1455 Sets the vcpu's current "multiprocessing state"; see KVM_GET_MP_STATE for
1456 arguments.
1457
1458 On x86, this ioctl is only useful after KVM_CREATE_IRQCHIP. Without an
1459 in-kernel irqchip, the multiprocessing state must be maintained by userspace on
1460 these architectures.
1461
1462 For arm/arm64:
1463 ^^^^^^^^^^^^^^
1464
1465 The only states that are valid are KVM_MP_STATE_STOPPED and
1466 KVM_MP_STATE_RUNNABLE which reflect if the vcpu should be paused or not.
1467
1468 4.40 KVM_SET_IDENTITY_MAP_ADDR
1469 ------------------------------
1470
1471 :Capability: KVM_CAP_SET_IDENTITY_MAP_ADDR
1472 :Architectures: x86
1473 :Type: vm ioctl
1474 :Parameters: unsigned long identity (in)
1475 :Returns: 0 on success, -1 on error
1476
1477 This ioctl defines the physical address of a one-page region in the guest
1478 physical address space.  The region must be within the first 4GB of the
1479 guest physical address space and must not conflict with any memory slot
1480 or any mmio address.  The guest may malfunction if it accesses this memory
1481 region.
1482
1483 Setting the address to 0 will result in resetting the address to its default
1484 (0xfffbc000).
1485
1486 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
1487 because of a quirk in the virtualization implementation (see the internals
1488 documentation when it pops into existence).
1489
1490 Fails if any VCPU has already been created.
1491
1492 4.41 KVM_SET_BOOT_CPU_ID
1493 ------------------------
1494
1495 :Capability: KVM_CAP_SET_BOOT_CPU_ID
1496 :Architectures: x86
1497 :Type: vm ioctl
1498 :Parameters: unsigned long vcpu_id
1499 :Returns: 0 on success, -1 on error
1500
1501 Define which vcpu is the Bootstrap Processor (BSP).  Values are the same
1502 as the vcpu id in KVM_CREATE_VCPU.  If this ioctl is not called, the default
1503 is vcpu 0. This ioctl has to be called before vcpu creation,
1504 otherwise it will return EBUSY error.
1505
1506
1507 4.42 KVM_GET_XSAVE
1508 ------------------
1509
1510 :Capability: KVM_CAP_XSAVE
1511 :Architectures: x86
1512 :Type: vcpu ioctl
1513 :Parameters: struct kvm_xsave (out)
1514 :Returns: 0 on success, -1 on error
1515
1516
1517 ::
1518
1519   struct kvm_xsave {
1520         __u32 region[1024];
1521   };
1522
1523 This ioctl would copy current vcpu's xsave struct to the userspace.
1524
1525
1526 4.43 KVM_SET_XSAVE
1527 ------------------
1528
1529 :Capability: KVM_CAP_XSAVE
1530 :Architectures: x86
1531 :Type: vcpu ioctl
1532 :Parameters: struct kvm_xsave (in)
1533 :Returns: 0 on success, -1 on error
1534
1535 ::
1536
1537
1538   struct kvm_xsave {
1539         __u32 region[1024];
1540   };
1541
1542 This ioctl would copy userspace's xsave struct to the kernel.
1543
1544
1545 4.44 KVM_GET_XCRS
1546 -----------------
1547
1548 :Capability: KVM_CAP_XCRS
1549 :Architectures: x86
1550 :Type: vcpu ioctl
1551 :Parameters: struct kvm_xcrs (out)
1552 :Returns: 0 on success, -1 on error
1553
1554 ::
1555
1556   struct kvm_xcr {
1557         __u32 xcr;
1558         __u32 reserved;
1559         __u64 value;
1560   };
1561
1562   struct kvm_xcrs {
1563         __u32 nr_xcrs;
1564         __u32 flags;
1565         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1566         __u64 padding[16];
1567   };
1568
1569 This ioctl would copy current vcpu's xcrs to the userspace.
1570
1571
1572 4.45 KVM_SET_XCRS
1573 -----------------
1574
1575 :Capability: KVM_CAP_XCRS
1576 :Architectures: x86
1577 :Type: vcpu ioctl
1578 :Parameters: struct kvm_xcrs (in)
1579 :Returns: 0 on success, -1 on error
1580
1581 ::
1582
1583   struct kvm_xcr {
1584         __u32 xcr;
1585         __u32 reserved;
1586         __u64 value;
1587   };
1588
1589   struct kvm_xcrs {
1590         __u32 nr_xcrs;
1591         __u32 flags;
1592         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1593         __u64 padding[16];
1594   };
1595
1596 This ioctl would set vcpu's xcr to the value userspace specified.
1597
1598
1599 4.46 KVM_GET_SUPPORTED_CPUID
1600 ----------------------------
1601
1602 :Capability: KVM_CAP_EXT_CPUID
1603 :Architectures: x86
1604 :Type: system ioctl
1605 :Parameters: struct kvm_cpuid2 (in/out)
1606 :Returns: 0 on success, -1 on error
1607
1608 ::
1609
1610   struct kvm_cpuid2 {
1611         __u32 nent;
1612         __u32 padding;
1613         struct kvm_cpuid_entry2 entries[0];
1614   };
1615
1616   #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX               BIT(0)
1617   #define KVM_CPUID_FLAG_STATEFUL_FUNC          BIT(1) /* deprecated */
1618   #define KVM_CPUID_FLAG_STATE_READ_NEXT                BIT(2) /* deprecated */
1619
1620   struct kvm_cpuid_entry2 {
1621         __u32 function;
1622         __u32 index;
1623         __u32 flags;
1624         __u32 eax;
1625         __u32 ebx;
1626         __u32 ecx;
1627         __u32 edx;
1628         __u32 padding[3];
1629   };
1630
1631 This ioctl returns x86 cpuid features which are supported by both the
1632 hardware and kvm in its default configuration.  Userspace can use the
1633 information returned by this ioctl to construct cpuid information (for
1634 KVM_SET_CPUID2) that is consistent with hardware, kernel, and
1635 userspace capabilities, and with user requirements (for example, the
1636 user may wish to constrain cpuid to emulate older hardware, or for
1637 feature consistency across a cluster).
1638
1639 Note that certain capabilities, such as KVM_CAP_X86_DISABLE_EXITS, may
1640 expose cpuid features (e.g. MONITOR) which are not supported by kvm in
1641 its default configuration. If userspace enables such capabilities, it
1642 is responsible for modifying the results of this ioctl appropriately.
1643
1644 Userspace invokes KVM_GET_SUPPORTED_CPUID by passing a kvm_cpuid2 structure
1645 with the 'nent' field indicating the number of entries in the variable-size
1646 array 'entries'.  If the number of entries is too low to describe the cpu
1647 capabilities, an error (E2BIG) is returned.  If the number is too high,
1648 the 'nent' field is adjusted and an error (ENOMEM) is returned.  If the
1649 number is just right, the 'nent' field is adjusted to the number of valid
1650 entries in the 'entries' array, which is then filled.
1651
1652 The entries returned are the host cpuid as returned by the cpuid instruction,
1653 with unknown or unsupported features masked out.  Some features (for example,
1654 x2apic), may not be present in the host cpu, but are exposed by kvm if it can
1655 emulate them efficiently. The fields in each entry are defined as follows:
1656
1657   function:
1658          the eax value used to obtain the entry
1659
1660   index:
1661          the ecx value used to obtain the entry (for entries that are
1662          affected by ecx)
1663
1664   flags:
1665      an OR of zero or more of the following:
1666
1667         KVM_CPUID_FLAG_SIGNIFCANT_INDEX:
1668            if the index field is valid
1669
1670    eax, ebx, ecx, edx:
1671          the values returned by the cpuid instruction for
1672          this function/index combination
1673
1674 The TSC deadline timer feature (CPUID leaf 1, ecx[24]) is always returned
1675 as false, since the feature depends on KVM_CREATE_IRQCHIP for local APIC
1676 support.  Instead it is reported via::
1677
1678   ioctl(KVM_CHECK_EXTENSION, KVM_CAP_TSC_DEADLINE_TIMER)
1679
1680 if that returns true and you use KVM_CREATE_IRQCHIP, or if you emulate the
1681 feature in userspace, then you can enable the feature for KVM_SET_CPUID2.
1682
1683
1684 4.47 KVM_PPC_GET_PVINFO
1685 -----------------------
1686
1687 :Capability: KVM_CAP_PPC_GET_PVINFO
1688 :Architectures: ppc
1689 :Type: vm ioctl
1690 :Parameters: struct kvm_ppc_pvinfo (out)
1691 :Returns: 0 on success, !0 on error
1692
1693 ::
1694
1695   struct kvm_ppc_pvinfo {
1696         __u32 flags;
1697         __u32 hcall[4];
1698         __u8  pad[108];
1699   };
1700
1701 This ioctl fetches PV specific information that need to be passed to the guest
1702 using the device tree or other means from vm context.
1703
1704 The hcall array defines 4 instructions that make up a hypercall.
1705
1706 If any additional field gets added to this structure later on, a bit for that
1707 additional piece of information will be set in the flags bitmap.
1708
1709 The flags bitmap is defined as::
1710
1711    /* the host supports the ePAPR idle hcall
1712    #define KVM_PPC_PVINFO_FLAGS_EV_IDLE   (1<<0)
1713
1714 4.52 KVM_SET_GSI_ROUTING
1715 ------------------------
1716
1717 :Capability: KVM_CAP_IRQ_ROUTING
1718 :Architectures: x86 s390 arm arm64
1719 :Type: vm ioctl
1720 :Parameters: struct kvm_irq_routing (in)
1721 :Returns: 0 on success, -1 on error
1722
1723 Sets the GSI routing table entries, overwriting any previously set entries.
1724
1725 On arm/arm64, GSI routing has the following limitation:
1726
1727 - GSI routing does not apply to KVM_IRQ_LINE but only to KVM_IRQFD.
1728
1729 ::
1730
1731   struct kvm_irq_routing {
1732         __u32 nr;
1733         __u32 flags;
1734         struct kvm_irq_routing_entry entries[0];
1735   };
1736
1737 No flags are specified so far, the corresponding field must be set to zero.
1738
1739 ::
1740
1741   struct kvm_irq_routing_entry {
1742         __u32 gsi;
1743         __u32 type;
1744         __u32 flags;
1745         __u32 pad;
1746         union {
1747                 struct kvm_irq_routing_irqchip irqchip;
1748                 struct kvm_irq_routing_msi msi;
1749                 struct kvm_irq_routing_s390_adapter adapter;
1750                 struct kvm_irq_routing_hv_sint hv_sint;
1751                 __u32 pad[8];
1752         } u;
1753   };
1754
1755   /* gsi routing entry types */
1756   #define KVM_IRQ_ROUTING_IRQCHIP 1
1757   #define KVM_IRQ_ROUTING_MSI 2
1758   #define KVM_IRQ_ROUTING_S390_ADAPTER 3
1759   #define KVM_IRQ_ROUTING_HV_SINT 4
1760
1761 flags:
1762
1763 - KVM_MSI_VALID_DEVID: used along with KVM_IRQ_ROUTING_MSI routing entry
1764   type, specifies that the devid field contains a valid value.  The per-VM
1765   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
1766   the device ID.  If this capability is not available, userspace should
1767   never set the KVM_MSI_VALID_DEVID flag as the ioctl might fail.
1768 - zero otherwise
1769
1770 ::
1771
1772   struct kvm_irq_routing_irqchip {
1773         __u32 irqchip;
1774         __u32 pin;
1775   };
1776
1777   struct kvm_irq_routing_msi {
1778         __u32 address_lo;
1779         __u32 address_hi;
1780         __u32 data;
1781         union {
1782                 __u32 pad;
1783                 __u32 devid;
1784         };
1785   };
1786
1787 If KVM_MSI_VALID_DEVID is set, devid contains a unique device identifier
1788 for the device that wrote the MSI message.  For PCI, this is usually a
1789 BFD identifier in the lower 16 bits.
1790
1791 On x86, address_hi is ignored unless the KVM_X2APIC_API_USE_32BIT_IDS
1792 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
1793 address_hi bits 31-8 provide bits 31-8 of the destination id.  Bits 7-0 of
1794 address_hi must be zero.
1795
1796 ::
1797
1798   struct kvm_irq_routing_s390_adapter {
1799         __u64 ind_addr;
1800         __u64 summary_addr;
1801         __u64 ind_offset;
1802         __u32 summary_offset;
1803         __u32 adapter_id;
1804   };
1805
1806   struct kvm_irq_routing_hv_sint {
1807         __u32 vcpu;
1808         __u32 sint;
1809   };
1810
1811
1812 4.55 KVM_SET_TSC_KHZ
1813 --------------------
1814
1815 :Capability: KVM_CAP_TSC_CONTROL
1816 :Architectures: x86
1817 :Type: vcpu ioctl
1818 :Parameters: virtual tsc_khz
1819 :Returns: 0 on success, -1 on error
1820
1821 Specifies the tsc frequency for the virtual machine. The unit of the
1822 frequency is KHz.
1823
1824
1825 4.56 KVM_GET_TSC_KHZ
1826 --------------------
1827
1828 :Capability: KVM_CAP_GET_TSC_KHZ
1829 :Architectures: x86
1830 :Type: vcpu ioctl
1831 :Parameters: none
1832 :Returns: virtual tsc-khz on success, negative value on error
1833
1834 Returns the tsc frequency of the guest. The unit of the return value is
1835 KHz. If the host has unstable tsc this ioctl returns -EIO instead as an
1836 error.
1837
1838
1839 4.57 KVM_GET_LAPIC
1840 ------------------
1841
1842 :Capability: KVM_CAP_IRQCHIP
1843 :Architectures: x86
1844 :Type: vcpu ioctl
1845 :Parameters: struct kvm_lapic_state (out)
1846 :Returns: 0 on success, -1 on error
1847
1848 ::
1849
1850   #define KVM_APIC_REG_SIZE 0x400
1851   struct kvm_lapic_state {
1852         char regs[KVM_APIC_REG_SIZE];
1853   };
1854
1855 Reads the Local APIC registers and copies them into the input argument.  The
1856 data format and layout are the same as documented in the architecture manual.
1857
1858 If KVM_X2APIC_API_USE_32BIT_IDS feature of KVM_CAP_X2APIC_API is
1859 enabled, then the format of APIC_ID register depends on the APIC mode
1860 (reported by MSR_IA32_APICBASE) of its VCPU.  x2APIC stores APIC ID in
1861 the APIC_ID register (bytes 32-35).  xAPIC only allows an 8-bit APIC ID
1862 which is stored in bits 31-24 of the APIC register, or equivalently in
1863 byte 35 of struct kvm_lapic_state's regs field.  KVM_GET_LAPIC must then
1864 be called after MSR_IA32_APICBASE has been set with KVM_SET_MSR.
1865
1866 If KVM_X2APIC_API_USE_32BIT_IDS feature is disabled, struct kvm_lapic_state
1867 always uses xAPIC format.
1868
1869
1870 4.58 KVM_SET_LAPIC
1871 ------------------
1872
1873 :Capability: KVM_CAP_IRQCHIP
1874 :Architectures: x86
1875 :Type: vcpu ioctl
1876 :Parameters: struct kvm_lapic_state (in)
1877 :Returns: 0 on success, -1 on error
1878
1879 ::
1880
1881   #define KVM_APIC_REG_SIZE 0x400
1882   struct kvm_lapic_state {
1883         char regs[KVM_APIC_REG_SIZE];
1884   };
1885
1886 Copies the input argument into the Local APIC registers.  The data format
1887 and layout are the same as documented in the architecture manual.
1888
1889 The format of the APIC ID register (bytes 32-35 of struct kvm_lapic_state's
1890 regs field) depends on the state of the KVM_CAP_X2APIC_API capability.
1891 See the note in KVM_GET_LAPIC.
1892
1893
1894 4.59 KVM_IOEVENTFD
1895 ------------------
1896
1897 :Capability: KVM_CAP_IOEVENTFD
1898 :Architectures: all
1899 :Type: vm ioctl
1900 :Parameters: struct kvm_ioeventfd (in)
1901 :Returns: 0 on success, !0 on error
1902
1903 This ioctl attaches or detaches an ioeventfd to a legal pio/mmio address
1904 within the guest.  A guest write in the registered address will signal the
1905 provided event instead of triggering an exit.
1906
1907 ::
1908
1909   struct kvm_ioeventfd {
1910         __u64 datamatch;
1911         __u64 addr;        /* legal pio/mmio address */
1912         __u32 len;         /* 0, 1, 2, 4, or 8 bytes    */
1913         __s32 fd;
1914         __u32 flags;
1915         __u8  pad[36];
1916   };
1917
1918 For the special case of virtio-ccw devices on s390, the ioevent is matched
1919 to a subchannel/virtqueue tuple instead.
1920
1921 The following flags are defined::
1922
1923   #define KVM_IOEVENTFD_FLAG_DATAMATCH (1 << kvm_ioeventfd_flag_nr_datamatch)
1924   #define KVM_IOEVENTFD_FLAG_PIO       (1 << kvm_ioeventfd_flag_nr_pio)
1925   #define KVM_IOEVENTFD_FLAG_DEASSIGN  (1 << kvm_ioeventfd_flag_nr_deassign)
1926   #define KVM_IOEVENTFD_FLAG_VIRTIO_CCW_NOTIFY \
1927         (1 << kvm_ioeventfd_flag_nr_virtio_ccw_notify)
1928
1929 If datamatch flag is set, the event will be signaled only if the written value
1930 to the registered address is equal to datamatch in struct kvm_ioeventfd.
1931
1932 For virtio-ccw devices, addr contains the subchannel id and datamatch the
1933 virtqueue index.
1934
1935 With KVM_CAP_IOEVENTFD_ANY_LENGTH, a zero length ioeventfd is allowed, and
1936 the kernel will ignore the length of guest write and may get a faster vmexit.
1937 The speedup may only apply to specific architectures, but the ioeventfd will
1938 work anyway.
1939
1940 4.60 KVM_DIRTY_TLB
1941 ------------------
1942
1943 :Capability: KVM_CAP_SW_TLB
1944 :Architectures: ppc
1945 :Type: vcpu ioctl
1946 :Parameters: struct kvm_dirty_tlb (in)
1947 :Returns: 0 on success, -1 on error
1948
1949 ::
1950
1951   struct kvm_dirty_tlb {
1952         __u64 bitmap;
1953         __u32 num_dirty;
1954   };
1955
1956 This must be called whenever userspace has changed an entry in the shared
1957 TLB, prior to calling KVM_RUN on the associated vcpu.
1958
1959 The "bitmap" field is the userspace address of an array.  This array
1960 consists of a number of bits, equal to the total number of TLB entries as
1961 determined by the last successful call to KVM_CONFIG_TLB, rounded up to the
1962 nearest multiple of 64.
1963
1964 Each bit corresponds to one TLB entry, ordered the same as in the shared TLB
1965 array.
1966
1967 The array is little-endian: the bit 0 is the least significant bit of the
1968 first byte, bit 8 is the least significant bit of the second byte, etc.
1969 This avoids any complications with differing word sizes.
1970
1971 The "num_dirty" field is a performance hint for KVM to determine whether it
1972 should skip processing the bitmap and just invalidate everything.  It must
1973 be set to the number of set bits in the bitmap.
1974
1975
1976 4.62 KVM_CREATE_SPAPR_TCE
1977 -------------------------
1978
1979 :Capability: KVM_CAP_SPAPR_TCE
1980 :Architectures: powerpc
1981 :Type: vm ioctl
1982 :Parameters: struct kvm_create_spapr_tce (in)
1983 :Returns: file descriptor for manipulating the created TCE table
1984
1985 This creates a virtual TCE (translation control entry) table, which
1986 is an IOMMU for PAPR-style virtual I/O.  It is used to translate
1987 logical addresses used in virtual I/O into guest physical addresses,
1988 and provides a scatter/gather capability for PAPR virtual I/O.
1989
1990 ::
1991
1992   /* for KVM_CAP_SPAPR_TCE */
1993   struct kvm_create_spapr_tce {
1994         __u64 liobn;
1995         __u32 window_size;
1996   };
1997
1998 The liobn field gives the logical IO bus number for which to create a
1999 TCE table.  The window_size field specifies the size of the DMA window
2000 which this TCE table will translate - the table will contain one 64
2001 bit TCE entry for every 4kiB of the DMA window.
2002
2003 When the guest issues an H_PUT_TCE hcall on a liobn for which a TCE
2004 table has been created using this ioctl(), the kernel will handle it
2005 in real mode, updating the TCE table.  H_PUT_TCE calls for other
2006 liobns will cause a vm exit and must be handled by userspace.
2007
2008 The return value is a file descriptor which can be passed to mmap(2)
2009 to map the created TCE table into userspace.  This lets userspace read
2010 the entries written by kernel-handled H_PUT_TCE calls, and also lets
2011 userspace update the TCE table directly which is useful in some
2012 circumstances.
2013
2014
2015 4.63 KVM_ALLOCATE_RMA
2016 ---------------------
2017
2018 :Capability: KVM_CAP_PPC_RMA
2019 :Architectures: powerpc
2020 :Type: vm ioctl
2021 :Parameters: struct kvm_allocate_rma (out)
2022 :Returns: file descriptor for mapping the allocated RMA
2023
2024 This allocates a Real Mode Area (RMA) from the pool allocated at boot
2025 time by the kernel.  An RMA is a physically-contiguous, aligned region
2026 of memory used on older POWER processors to provide the memory which
2027 will be accessed by real-mode (MMU off) accesses in a KVM guest.
2028 POWER processors support a set of sizes for the RMA that usually
2029 includes 64MB, 128MB, 256MB and some larger powers of two.
2030
2031 ::
2032
2033   /* for KVM_ALLOCATE_RMA */
2034   struct kvm_allocate_rma {
2035         __u64 rma_size;
2036   };
2037
2038 The return value is a file descriptor which can be passed to mmap(2)
2039 to map the allocated RMA into userspace.  The mapped area can then be
2040 passed to the KVM_SET_USER_MEMORY_REGION ioctl to establish it as the
2041 RMA for a virtual machine.  The size of the RMA in bytes (which is
2042 fixed at host kernel boot time) is returned in the rma_size field of
2043 the argument structure.
2044
2045 The KVM_CAP_PPC_RMA capability is 1 or 2 if the KVM_ALLOCATE_RMA ioctl
2046 is supported; 2 if the processor requires all virtual machines to have
2047 an RMA, or 1 if the processor can use an RMA but doesn't require it,
2048 because it supports the Virtual RMA (VRMA) facility.
2049
2050
2051 4.64 KVM_NMI
2052 ------------
2053
2054 :Capability: KVM_CAP_USER_NMI
2055 :Architectures: x86
2056 :Type: vcpu ioctl
2057 :Parameters: none
2058 :Returns: 0 on success, -1 on error
2059
2060 Queues an NMI on the thread's vcpu.  Note this is well defined only
2061 when KVM_CREATE_IRQCHIP has not been called, since this is an interface
2062 between the virtual cpu core and virtual local APIC.  After KVM_CREATE_IRQCHIP
2063 has been called, this interface is completely emulated within the kernel.
2064
2065 To use this to emulate the LINT1 input with KVM_CREATE_IRQCHIP, use the
2066 following algorithm:
2067
2068   - pause the vcpu
2069   - read the local APIC's state (KVM_GET_LAPIC)
2070   - check whether changing LINT1 will queue an NMI (see the LVT entry for LINT1)
2071   - if so, issue KVM_NMI
2072   - resume the vcpu
2073
2074 Some guests configure the LINT1 NMI input to cause a panic, aiding in
2075 debugging.
2076
2077
2078 4.65 KVM_S390_UCAS_MAP
2079 ----------------------
2080
2081 :Capability: KVM_CAP_S390_UCONTROL
2082 :Architectures: s390
2083 :Type: vcpu ioctl
2084 :Parameters: struct kvm_s390_ucas_mapping (in)
2085 :Returns: 0 in case of success
2086
2087 The parameter is defined like this::
2088
2089         struct kvm_s390_ucas_mapping {
2090                 __u64 user_addr;
2091                 __u64 vcpu_addr;
2092                 __u64 length;
2093         };
2094
2095 This ioctl maps the memory at "user_addr" with the length "length" to
2096 the vcpu's address space starting at "vcpu_addr". All parameters need to
2097 be aligned by 1 megabyte.
2098
2099
2100 4.66 KVM_S390_UCAS_UNMAP
2101 ------------------------
2102
2103 :Capability: KVM_CAP_S390_UCONTROL
2104 :Architectures: s390
2105 :Type: vcpu ioctl
2106 :Parameters: struct kvm_s390_ucas_mapping (in)
2107 :Returns: 0 in case of success
2108
2109 The parameter is defined like this::
2110
2111         struct kvm_s390_ucas_mapping {
2112                 __u64 user_addr;
2113                 __u64 vcpu_addr;
2114                 __u64 length;
2115         };
2116
2117 This ioctl unmaps the memory in the vcpu's address space starting at
2118 "vcpu_addr" with the length "length". The field "user_addr" is ignored.
2119 All parameters need to be aligned by 1 megabyte.
2120
2121
2122 4.67 KVM_S390_VCPU_FAULT
2123 ------------------------
2124
2125 :Capability: KVM_CAP_S390_UCONTROL
2126 :Architectures: s390
2127 :Type: vcpu ioctl
2128 :Parameters: vcpu absolute address (in)
2129 :Returns: 0 in case of success
2130
2131 This call creates a page table entry on the virtual cpu's address space
2132 (for user controlled virtual machines) or the virtual machine's address
2133 space (for regular virtual machines). This only works for minor faults,
2134 thus it's recommended to access subject memory page via the user page
2135 table upfront. This is useful to handle validity intercepts for user
2136 controlled virtual machines to fault in the virtual cpu's lowcore pages
2137 prior to calling the KVM_RUN ioctl.
2138
2139
2140 4.68 KVM_SET_ONE_REG
2141 --------------------
2142
2143 :Capability: KVM_CAP_ONE_REG
2144 :Architectures: all
2145 :Type: vcpu ioctl
2146 :Parameters: struct kvm_one_reg (in)
2147 :Returns: 0 on success, negative value on failure
2148
2149 Errors:
2150
2151   ======   ============================================================
2152   ENOENT   no such register
2153   EINVAL   invalid register ID, or no such register or used with VMs in
2154            protected virtualization mode on s390
2155   EPERM    (arm64) register access not allowed before vcpu finalization
2156   ======   ============================================================
2157
2158 (These error codes are indicative only: do not rely on a specific error
2159 code being returned in a specific situation.)
2160
2161 ::
2162
2163   struct kvm_one_reg {
2164        __u64 id;
2165        __u64 addr;
2166  };
2167
2168 Using this ioctl, a single vcpu register can be set to a specific value
2169 defined by user space with the passed in struct kvm_one_reg, where id
2170 refers to the register identifier as described below and addr is a pointer
2171 to a variable with the respective size. There can be architecture agnostic
2172 and architecture specific registers. Each have their own range of operation
2173 and their own constants and width. To keep track of the implemented
2174 registers, find a list below:
2175
2176   ======= =============================== ============
2177   Arch              Register              Width (bits)
2178   ======= =============================== ============
2179   PPC     KVM_REG_PPC_HIOR                64
2180   PPC     KVM_REG_PPC_IAC1                64
2181   PPC     KVM_REG_PPC_IAC2                64
2182   PPC     KVM_REG_PPC_IAC3                64
2183   PPC     KVM_REG_PPC_IAC4                64
2184   PPC     KVM_REG_PPC_DAC1                64
2185   PPC     KVM_REG_PPC_DAC2                64
2186   PPC     KVM_REG_PPC_DABR                64
2187   PPC     KVM_REG_PPC_DSCR                64
2188   PPC     KVM_REG_PPC_PURR                64
2189   PPC     KVM_REG_PPC_SPURR               64
2190   PPC     KVM_REG_PPC_DAR                 64
2191   PPC     KVM_REG_PPC_DSISR               32
2192   PPC     KVM_REG_PPC_AMR                 64
2193   PPC     KVM_REG_PPC_UAMOR               64
2194   PPC     KVM_REG_PPC_MMCR0               64
2195   PPC     KVM_REG_PPC_MMCR1               64
2196   PPC     KVM_REG_PPC_MMCRA               64
2197   PPC     KVM_REG_PPC_MMCR2               64
2198   PPC     KVM_REG_PPC_MMCRS               64
2199   PPC     KVM_REG_PPC_MMCR3               64
2200   PPC     KVM_REG_PPC_SIAR                64
2201   PPC     KVM_REG_PPC_SDAR                64
2202   PPC     KVM_REG_PPC_SIER                64
2203   PPC     KVM_REG_PPC_SIER2               64
2204   PPC     KVM_REG_PPC_SIER3               64
2205   PPC     KVM_REG_PPC_PMC1                32
2206   PPC     KVM_REG_PPC_PMC2                32
2207   PPC     KVM_REG_PPC_PMC3                32
2208   PPC     KVM_REG_PPC_PMC4                32
2209   PPC     KVM_REG_PPC_PMC5                32
2210   PPC     KVM_REG_PPC_PMC6                32
2211   PPC     KVM_REG_PPC_PMC7                32
2212   PPC     KVM_REG_PPC_PMC8                32
2213   PPC     KVM_REG_PPC_FPR0                64
2214   ...
2215   PPC     KVM_REG_PPC_FPR31               64
2216   PPC     KVM_REG_PPC_VR0                 128
2217   ...
2218   PPC     KVM_REG_PPC_VR31                128
2219   PPC     KVM_REG_PPC_VSR0                128
2220   ...
2221   PPC     KVM_REG_PPC_VSR31               128
2222   PPC     KVM_REG_PPC_FPSCR               64
2223   PPC     KVM_REG_PPC_VSCR                32
2224   PPC     KVM_REG_PPC_VPA_ADDR            64
2225   PPC     KVM_REG_PPC_VPA_SLB             128
2226   PPC     KVM_REG_PPC_VPA_DTL             128
2227   PPC     KVM_REG_PPC_EPCR                32
2228   PPC     KVM_REG_PPC_EPR                 32
2229   PPC     KVM_REG_PPC_TCR                 32
2230   PPC     KVM_REG_PPC_TSR                 32
2231   PPC     KVM_REG_PPC_OR_TSR              32
2232   PPC     KVM_REG_PPC_CLEAR_TSR           32
2233   PPC     KVM_REG_PPC_MAS0                32
2234   PPC     KVM_REG_PPC_MAS1                32
2235   PPC     KVM_REG_PPC_MAS2                64
2236   PPC     KVM_REG_PPC_MAS7_3              64
2237   PPC     KVM_REG_PPC_MAS4                32
2238   PPC     KVM_REG_PPC_MAS6                32
2239   PPC     KVM_REG_PPC_MMUCFG              32
2240   PPC     KVM_REG_PPC_TLB0CFG             32
2241   PPC     KVM_REG_PPC_TLB1CFG             32
2242   PPC     KVM_REG_PPC_TLB2CFG             32
2243   PPC     KVM_REG_PPC_TLB3CFG             32
2244   PPC     KVM_REG_PPC_TLB0PS              32
2245   PPC     KVM_REG_PPC_TLB1PS              32
2246   PPC     KVM_REG_PPC_TLB2PS              32
2247   PPC     KVM_REG_PPC_TLB3PS              32
2248   PPC     KVM_REG_PPC_EPTCFG              32
2249   PPC     KVM_REG_PPC_ICP_STATE           64
2250   PPC     KVM_REG_PPC_VP_STATE            128
2251   PPC     KVM_REG_PPC_TB_OFFSET           64
2252   PPC     KVM_REG_PPC_SPMC1               32
2253   PPC     KVM_REG_PPC_SPMC2               32
2254   PPC     KVM_REG_PPC_IAMR                64
2255   PPC     KVM_REG_PPC_TFHAR               64
2256   PPC     KVM_REG_PPC_TFIAR               64
2257   PPC     KVM_REG_PPC_TEXASR              64
2258   PPC     KVM_REG_PPC_FSCR                64
2259   PPC     KVM_REG_PPC_PSPB                32
2260   PPC     KVM_REG_PPC_EBBHR               64
2261   PPC     KVM_REG_PPC_EBBRR               64
2262   PPC     KVM_REG_PPC_BESCR               64
2263   PPC     KVM_REG_PPC_TAR                 64
2264   PPC     KVM_REG_PPC_DPDES               64
2265   PPC     KVM_REG_PPC_DAWR                64
2266   PPC     KVM_REG_PPC_DAWRX               64
2267   PPC     KVM_REG_PPC_CIABR               64
2268   PPC     KVM_REG_PPC_IC                  64
2269   PPC     KVM_REG_PPC_VTB                 64
2270   PPC     KVM_REG_PPC_CSIGR               64
2271   PPC     KVM_REG_PPC_TACR                64
2272   PPC     KVM_REG_PPC_TCSCR               64
2273   PPC     KVM_REG_PPC_PID                 64
2274   PPC     KVM_REG_PPC_ACOP                64
2275   PPC     KVM_REG_PPC_VRSAVE              32
2276   PPC     KVM_REG_PPC_LPCR                32
2277   PPC     KVM_REG_PPC_LPCR_64             64
2278   PPC     KVM_REG_PPC_PPR                 64
2279   PPC     KVM_REG_PPC_ARCH_COMPAT         32
2280   PPC     KVM_REG_PPC_DABRX               32
2281   PPC     KVM_REG_PPC_WORT                64
2282   PPC     KVM_REG_PPC_SPRG9               64
2283   PPC     KVM_REG_PPC_DBSR                32
2284   PPC     KVM_REG_PPC_TIDR                64
2285   PPC     KVM_REG_PPC_PSSCR               64
2286   PPC     KVM_REG_PPC_DEC_EXPIRY          64
2287   PPC     KVM_REG_PPC_PTCR                64
2288   PPC     KVM_REG_PPC_DAWR1               64
2289   PPC     KVM_REG_PPC_DAWRX1              64
2290   PPC     KVM_REG_PPC_TM_GPR0             64
2291   ...
2292   PPC     KVM_REG_PPC_TM_GPR31            64
2293   PPC     KVM_REG_PPC_TM_VSR0             128
2294   ...
2295   PPC     KVM_REG_PPC_TM_VSR63            128
2296   PPC     KVM_REG_PPC_TM_CR               64
2297   PPC     KVM_REG_PPC_TM_LR               64
2298   PPC     KVM_REG_PPC_TM_CTR              64
2299   PPC     KVM_REG_PPC_TM_FPSCR            64
2300   PPC     KVM_REG_PPC_TM_AMR              64
2301   PPC     KVM_REG_PPC_TM_PPR              64
2302   PPC     KVM_REG_PPC_TM_VRSAVE           64
2303   PPC     KVM_REG_PPC_TM_VSCR             32
2304   PPC     KVM_REG_PPC_TM_DSCR             64
2305   PPC     KVM_REG_PPC_TM_TAR              64
2306   PPC     KVM_REG_PPC_TM_XER              64
2307
2308   MIPS    KVM_REG_MIPS_R0                 64
2309   ...
2310   MIPS    KVM_REG_MIPS_R31                64
2311   MIPS    KVM_REG_MIPS_HI                 64
2312   MIPS    KVM_REG_MIPS_LO                 64
2313   MIPS    KVM_REG_MIPS_PC                 64
2314   MIPS    KVM_REG_MIPS_CP0_INDEX          32
2315   MIPS    KVM_REG_MIPS_CP0_ENTRYLO0       64
2316   MIPS    KVM_REG_MIPS_CP0_ENTRYLO1       64
2317   MIPS    KVM_REG_MIPS_CP0_CONTEXT        64
2318   MIPS    KVM_REG_MIPS_CP0_CONTEXTCONFIG  32
2319   MIPS    KVM_REG_MIPS_CP0_USERLOCAL      64
2320   MIPS    KVM_REG_MIPS_CP0_XCONTEXTCONFIG 64
2321   MIPS    KVM_REG_MIPS_CP0_PAGEMASK       32
2322   MIPS    KVM_REG_MIPS_CP0_PAGEGRAIN      32
2323   MIPS    KVM_REG_MIPS_CP0_SEGCTL0        64
2324   MIPS    KVM_REG_MIPS_CP0_SEGCTL1        64
2325   MIPS    KVM_REG_MIPS_CP0_SEGCTL2        64
2326   MIPS    KVM_REG_MIPS_CP0_PWBASE         64
2327   MIPS    KVM_REG_MIPS_CP0_PWFIELD        64
2328   MIPS    KVM_REG_MIPS_CP0_PWSIZE         64
2329   MIPS    KVM_REG_MIPS_CP0_WIRED          32
2330   MIPS    KVM_REG_MIPS_CP0_PWCTL          32
2331   MIPS    KVM_REG_MIPS_CP0_HWRENA         32
2332   MIPS    KVM_REG_MIPS_CP0_BADVADDR       64
2333   MIPS    KVM_REG_MIPS_CP0_BADINSTR       32
2334   MIPS    KVM_REG_MIPS_CP0_BADINSTRP      32
2335   MIPS    KVM_REG_MIPS_CP0_COUNT          32
2336   MIPS    KVM_REG_MIPS_CP0_ENTRYHI        64
2337   MIPS    KVM_REG_MIPS_CP0_COMPARE        32
2338   MIPS    KVM_REG_MIPS_CP0_STATUS         32
2339   MIPS    KVM_REG_MIPS_CP0_INTCTL         32
2340   MIPS    KVM_REG_MIPS_CP0_CAUSE          32
2341   MIPS    KVM_REG_MIPS_CP0_EPC            64
2342   MIPS    KVM_REG_MIPS_CP0_PRID           32
2343   MIPS    KVM_REG_MIPS_CP0_EBASE          64
2344   MIPS    KVM_REG_MIPS_CP0_CONFIG         32
2345   MIPS    KVM_REG_MIPS_CP0_CONFIG1        32
2346   MIPS    KVM_REG_MIPS_CP0_CONFIG2        32
2347   MIPS    KVM_REG_MIPS_CP0_CONFIG3        32
2348   MIPS    KVM_REG_MIPS_CP0_CONFIG4        32
2349   MIPS    KVM_REG_MIPS_CP0_CONFIG5        32
2350   MIPS    KVM_REG_MIPS_CP0_CONFIG7        32
2351   MIPS    KVM_REG_MIPS_CP0_XCONTEXT       64
2352   MIPS    KVM_REG_MIPS_CP0_ERROREPC       64
2353   MIPS    KVM_REG_MIPS_CP0_KSCRATCH1      64
2354   MIPS    KVM_REG_MIPS_CP0_KSCRATCH2      64
2355   MIPS    KVM_REG_MIPS_CP0_KSCRATCH3      64
2356   MIPS    KVM_REG_MIPS_CP0_KSCRATCH4      64
2357   MIPS    KVM_REG_MIPS_CP0_KSCRATCH5      64
2358   MIPS    KVM_REG_MIPS_CP0_KSCRATCH6      64
2359   MIPS    KVM_REG_MIPS_CP0_MAAR(0..63)    64
2360   MIPS    KVM_REG_MIPS_COUNT_CTL          64
2361   MIPS    KVM_REG_MIPS_COUNT_RESUME       64
2362   MIPS    KVM_REG_MIPS_COUNT_HZ           64
2363   MIPS    KVM_REG_MIPS_FPR_32(0..31)      32
2364   MIPS    KVM_REG_MIPS_FPR_64(0..31)      64
2365   MIPS    KVM_REG_MIPS_VEC_128(0..31)     128
2366   MIPS    KVM_REG_MIPS_FCR_IR             32
2367   MIPS    KVM_REG_MIPS_FCR_CSR            32
2368   MIPS    KVM_REG_MIPS_MSA_IR             32
2369   MIPS    KVM_REG_MIPS_MSA_CSR            32
2370   ======= =============================== ============
2371
2372 ARM registers are mapped using the lower 32 bits.  The upper 16 of that
2373 is the register group type, or coprocessor number:
2374
2375 ARM core registers have the following id bit patterns::
2376
2377   0x4020 0000 0010 <index into the kvm_regs struct:16>
2378
2379 ARM 32-bit CP15 registers have the following id bit patterns::
2380
2381   0x4020 0000 000F <zero:1> <crn:4> <crm:4> <opc1:4> <opc2:3>
2382
2383 ARM 64-bit CP15 registers have the following id bit patterns::
2384
2385   0x4030 0000 000F <zero:1> <zero:4> <crm:4> <opc1:4> <zero:3>
2386
2387 ARM CCSIDR registers are demultiplexed by CSSELR value::
2388
2389   0x4020 0000 0011 00 <csselr:8>
2390
2391 ARM 32-bit VFP control registers have the following id bit patterns::
2392
2393   0x4020 0000 0012 1 <regno:12>
2394
2395 ARM 64-bit FP registers have the following id bit patterns::
2396
2397   0x4030 0000 0012 0 <regno:12>
2398
2399 ARM firmware pseudo-registers have the following bit pattern::
2400
2401   0x4030 0000 0014 <regno:16>
2402
2403
2404 arm64 registers are mapped using the lower 32 bits. The upper 16 of
2405 that is the register group type, or coprocessor number:
2406
2407 arm64 core/FP-SIMD registers have the following id bit patterns. Note
2408 that the size of the access is variable, as the kvm_regs structure
2409 contains elements ranging from 32 to 128 bits. The index is a 32bit
2410 value in the kvm_regs structure seen as a 32bit array::
2411
2412   0x60x0 0000 0010 <index into the kvm_regs struct:16>
2413
2414 Specifically:
2415
2416 ======================= ========= ===== =======================================
2417     Encoding            Register  Bits  kvm_regs member
2418 ======================= ========= ===== =======================================
2419   0x6030 0000 0010 0000 X0          64  regs.regs[0]
2420   0x6030 0000 0010 0002 X1          64  regs.regs[1]
2421   ...
2422   0x6030 0000 0010 003c X30         64  regs.regs[30]
2423   0x6030 0000 0010 003e SP          64  regs.sp
2424   0x6030 0000 0010 0040 PC          64  regs.pc
2425   0x6030 0000 0010 0042 PSTATE      64  regs.pstate
2426   0x6030 0000 0010 0044 SP_EL1      64  sp_el1
2427   0x6030 0000 0010 0046 ELR_EL1     64  elr_el1
2428   0x6030 0000 0010 0048 SPSR_EL1    64  spsr[KVM_SPSR_EL1] (alias SPSR_SVC)
2429   0x6030 0000 0010 004a SPSR_ABT    64  spsr[KVM_SPSR_ABT]
2430   0x6030 0000 0010 004c SPSR_UND    64  spsr[KVM_SPSR_UND]
2431   0x6030 0000 0010 004e SPSR_IRQ    64  spsr[KVM_SPSR_IRQ]
2432   0x6060 0000 0010 0050 SPSR_FIQ    64  spsr[KVM_SPSR_FIQ]
2433   0x6040 0000 0010 0054 V0         128  fp_regs.vregs[0]    [1]_
2434   0x6040 0000 0010 0058 V1         128  fp_regs.vregs[1]    [1]_
2435   ...
2436   0x6040 0000 0010 00d0 V31        128  fp_regs.vregs[31]   [1]_
2437   0x6020 0000 0010 00d4 FPSR        32  fp_regs.fpsr
2438   0x6020 0000 0010 00d5 FPCR        32  fp_regs.fpcr
2439 ======================= ========= ===== =======================================
2440
2441 .. [1] These encodings are not accepted for SVE-enabled vcpus.  See
2442        KVM_ARM_VCPU_INIT.
2443
2444        The equivalent register content can be accessed via bits [127:0] of
2445        the corresponding SVE Zn registers instead for vcpus that have SVE
2446        enabled (see below).
2447
2448 arm64 CCSIDR registers are demultiplexed by CSSELR value::
2449
2450   0x6020 0000 0011 00 <csselr:8>
2451
2452 arm64 system registers have the following id bit patterns::
2453
2454   0x6030 0000 0013 <op0:2> <op1:3> <crn:4> <crm:4> <op2:3>
2455
2456 .. warning::
2457
2458      Two system register IDs do not follow the specified pattern.  These
2459      are KVM_REG_ARM_TIMER_CVAL and KVM_REG_ARM_TIMER_CNT, which map to
2460      system registers CNTV_CVAL_EL0 and CNTVCT_EL0 respectively.  These
2461      two had their values accidentally swapped, which means TIMER_CVAL is
2462      derived from the register encoding for CNTVCT_EL0 and TIMER_CNT is
2463      derived from the register encoding for CNTV_CVAL_EL0.  As this is
2464      API, it must remain this way.
2465
2466 arm64 firmware pseudo-registers have the following bit pattern::
2467
2468   0x6030 0000 0014 <regno:16>
2469
2470 arm64 SVE registers have the following bit patterns::
2471
2472   0x6080 0000 0015 00 <n:5> <slice:5>   Zn bits[2048*slice + 2047 : 2048*slice]
2473   0x6050 0000 0015 04 <n:4> <slice:5>   Pn bits[256*slice + 255 : 256*slice]
2474   0x6050 0000 0015 060 <slice:5>        FFR bits[256*slice + 255 : 256*slice]
2475   0x6060 0000 0015 ffff                 KVM_REG_ARM64_SVE_VLS pseudo-register
2476
2477 Access to register IDs where 2048 * slice >= 128 * max_vq will fail with
2478 ENOENT.  max_vq is the vcpu's maximum supported vector length in 128-bit
2479 quadwords: see [2]_ below.
2480
2481 These registers are only accessible on vcpus for which SVE is enabled.
2482 See KVM_ARM_VCPU_INIT for details.
2483
2484 In addition, except for KVM_REG_ARM64_SVE_VLS, these registers are not
2485 accessible until the vcpu's SVE configuration has been finalized
2486 using KVM_ARM_VCPU_FINALIZE(KVM_ARM_VCPU_SVE).  See KVM_ARM_VCPU_INIT
2487 and KVM_ARM_VCPU_FINALIZE for more information about this procedure.
2488
2489 KVM_REG_ARM64_SVE_VLS is a pseudo-register that allows the set of vector
2490 lengths supported by the vcpu to be discovered and configured by
2491 userspace.  When transferred to or from user memory via KVM_GET_ONE_REG
2492 or KVM_SET_ONE_REG, the value of this register is of type
2493 __u64[KVM_ARM64_SVE_VLS_WORDS], and encodes the set of vector lengths as
2494 follows::
2495
2496   __u64 vector_lengths[KVM_ARM64_SVE_VLS_WORDS];
2497
2498   if (vq >= SVE_VQ_MIN && vq <= SVE_VQ_MAX &&
2499       ((vector_lengths[(vq - KVM_ARM64_SVE_VQ_MIN) / 64] >>
2500                 ((vq - KVM_ARM64_SVE_VQ_MIN) % 64)) & 1))
2501         /* Vector length vq * 16 bytes supported */
2502   else
2503         /* Vector length vq * 16 bytes not supported */
2504
2505 .. [2] The maximum value vq for which the above condition is true is
2506        max_vq.  This is the maximum vector length available to the guest on
2507        this vcpu, and determines which register slices are visible through
2508        this ioctl interface.
2509
2510 (See Documentation/arm64/sve.rst for an explanation of the "vq"
2511 nomenclature.)
2512
2513 KVM_REG_ARM64_SVE_VLS is only accessible after KVM_ARM_VCPU_INIT.
2514 KVM_ARM_VCPU_INIT initialises it to the best set of vector lengths that
2515 the host supports.
2516
2517 Userspace may subsequently modify it if desired until the vcpu's SVE
2518 configuration is finalized using KVM_ARM_VCPU_FINALIZE(KVM_ARM_VCPU_SVE).
2519
2520 Apart from simply removing all vector lengths from the host set that
2521 exceed some value, support for arbitrarily chosen sets of vector lengths
2522 is hardware-dependent and may not be available.  Attempting to configure
2523 an invalid set of vector lengths via KVM_SET_ONE_REG will fail with
2524 EINVAL.
2525
2526 After the vcpu's SVE configuration is finalized, further attempts to
2527 write this register will fail with EPERM.
2528
2529
2530 MIPS registers are mapped using the lower 32 bits.  The upper 16 of that is
2531 the register group type:
2532
2533 MIPS core registers (see above) have the following id bit patterns::
2534
2535   0x7030 0000 0000 <reg:16>
2536
2537 MIPS CP0 registers (see KVM_REG_MIPS_CP0_* above) have the following id bit
2538 patterns depending on whether they're 32-bit or 64-bit registers::
2539
2540   0x7020 0000 0001 00 <reg:5> <sel:3>   (32-bit)
2541   0x7030 0000 0001 00 <reg:5> <sel:3>   (64-bit)
2542
2543 Note: KVM_REG_MIPS_CP0_ENTRYLO0 and KVM_REG_MIPS_CP0_ENTRYLO1 are the MIPS64
2544 versions of the EntryLo registers regardless of the word size of the host
2545 hardware, host kernel, guest, and whether XPA is present in the guest, i.e.
2546 with the RI and XI bits (if they exist) in bits 63 and 62 respectively, and
2547 the PFNX field starting at bit 30.
2548
2549 MIPS MAARs (see KVM_REG_MIPS_CP0_MAAR(*) above) have the following id bit
2550 patterns::
2551
2552   0x7030 0000 0001 01 <reg:8>
2553
2554 MIPS KVM control registers (see above) have the following id bit patterns::
2555
2556   0x7030 0000 0002 <reg:16>
2557
2558 MIPS FPU registers (see KVM_REG_MIPS_FPR_{32,64}() above) have the following
2559 id bit patterns depending on the size of the register being accessed. They are
2560 always accessed according to the current guest FPU mode (Status.FR and
2561 Config5.FRE), i.e. as the guest would see them, and they become unpredictable
2562 if the guest FPU mode is changed. MIPS SIMD Architecture (MSA) vector
2563 registers (see KVM_REG_MIPS_VEC_128() above) have similar patterns as they
2564 overlap the FPU registers::
2565
2566   0x7020 0000 0003 00 <0:3> <reg:5> (32-bit FPU registers)
2567   0x7030 0000 0003 00 <0:3> <reg:5> (64-bit FPU registers)
2568   0x7040 0000 0003 00 <0:3> <reg:5> (128-bit MSA vector registers)
2569
2570 MIPS FPU control registers (see KVM_REG_MIPS_FCR_{IR,CSR} above) have the
2571 following id bit patterns::
2572
2573   0x7020 0000 0003 01 <0:3> <reg:5>
2574
2575 MIPS MSA control registers (see KVM_REG_MIPS_MSA_{IR,CSR} above) have the
2576 following id bit patterns::
2577
2578   0x7020 0000 0003 02 <0:3> <reg:5>
2579
2580
2581 4.69 KVM_GET_ONE_REG
2582 --------------------
2583
2584 :Capability: KVM_CAP_ONE_REG
2585 :Architectures: all
2586 :Type: vcpu ioctl
2587 :Parameters: struct kvm_one_reg (in and out)
2588 :Returns: 0 on success, negative value on failure
2589
2590 Errors include:
2591
2592   ======== ============================================================
2593   ENOENT   no such register
2594   EINVAL   invalid register ID, or no such register or used with VMs in
2595            protected virtualization mode on s390
2596   EPERM    (arm64) register access not allowed before vcpu finalization
2597   ======== ============================================================
2598
2599 (These error codes are indicative only: do not rely on a specific error
2600 code being returned in a specific situation.)
2601
2602 This ioctl allows to receive the value of a single register implemented
2603 in a vcpu. The register to read is indicated by the "id" field of the
2604 kvm_one_reg struct passed in. On success, the register value can be found
2605 at the memory location pointed to by "addr".
2606
2607 The list of registers accessible using this interface is identical to the
2608 list in 4.68.
2609
2610
2611 4.70 KVM_KVMCLOCK_CTRL
2612 ----------------------
2613
2614 :Capability: KVM_CAP_KVMCLOCK_CTRL
2615 :Architectures: Any that implement pvclocks (currently x86 only)
2616 :Type: vcpu ioctl
2617 :Parameters: None
2618 :Returns: 0 on success, -1 on error
2619
2620 This ioctl sets a flag accessible to the guest indicating that the specified
2621 vCPU has been paused by the host userspace.
2622
2623 The host will set a flag in the pvclock structure that is checked from the
2624 soft lockup watchdog.  The flag is part of the pvclock structure that is
2625 shared between guest and host, specifically the second bit of the flags
2626 field of the pvclock_vcpu_time_info structure.  It will be set exclusively by
2627 the host and read/cleared exclusively by the guest.  The guest operation of
2628 checking and clearing the flag must be an atomic operation so
2629 load-link/store-conditional, or equivalent must be used.  There are two cases
2630 where the guest will clear the flag: when the soft lockup watchdog timer resets
2631 itself or when a soft lockup is detected.  This ioctl can be called any time
2632 after pausing the vcpu, but before it is resumed.
2633
2634
2635 4.71 KVM_SIGNAL_MSI
2636 -------------------
2637
2638 :Capability: KVM_CAP_SIGNAL_MSI
2639 :Architectures: x86 arm arm64
2640 :Type: vm ioctl
2641 :Parameters: struct kvm_msi (in)
2642 :Returns: >0 on delivery, 0 if guest blocked the MSI, and -1 on error
2643
2644 Directly inject a MSI message. Only valid with in-kernel irqchip that handles
2645 MSI messages.
2646
2647 ::
2648
2649   struct kvm_msi {
2650         __u32 address_lo;
2651         __u32 address_hi;
2652         __u32 data;
2653         __u32 flags;
2654         __u32 devid;
2655         __u8  pad[12];
2656   };
2657
2658 flags:
2659   KVM_MSI_VALID_DEVID: devid contains a valid value.  The per-VM
2660   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
2661   the device ID.  If this capability is not available, userspace
2662   should never set the KVM_MSI_VALID_DEVID flag as the ioctl might fail.
2663
2664 If KVM_MSI_VALID_DEVID is set, devid contains a unique device identifier
2665 for the device that wrote the MSI message.  For PCI, this is usually a
2666 BFD identifier in the lower 16 bits.
2667
2668 On x86, address_hi is ignored unless the KVM_X2APIC_API_USE_32BIT_IDS
2669 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
2670 address_hi bits 31-8 provide bits 31-8 of the destination id.  Bits 7-0 of
2671 address_hi must be zero.
2672
2673
2674 4.71 KVM_CREATE_PIT2
2675 --------------------
2676
2677 :Capability: KVM_CAP_PIT2
2678 :Architectures: x86
2679 :Type: vm ioctl
2680 :Parameters: struct kvm_pit_config (in)
2681 :Returns: 0 on success, -1 on error
2682
2683 Creates an in-kernel device model for the i8254 PIT. This call is only valid
2684 after enabling in-kernel irqchip support via KVM_CREATE_IRQCHIP. The following
2685 parameters have to be passed::
2686
2687   struct kvm_pit_config {
2688         __u32 flags;
2689         __u32 pad[15];
2690   };
2691
2692 Valid flags are::
2693
2694   #define KVM_PIT_SPEAKER_DUMMY     1 /* emulate speaker port stub */
2695
2696 PIT timer interrupts may use a per-VM kernel thread for injection. If it
2697 exists, this thread will have a name of the following pattern::
2698
2699   kvm-pit/<owner-process-pid>
2700
2701 When running a guest with elevated priorities, the scheduling parameters of
2702 this thread may have to be adjusted accordingly.
2703
2704 This IOCTL replaces the obsolete KVM_CREATE_PIT.
2705
2706
2707 4.72 KVM_GET_PIT2
2708 -----------------
2709
2710 :Capability: KVM_CAP_PIT_STATE2
2711 :Architectures: x86
2712 :Type: vm ioctl
2713 :Parameters: struct kvm_pit_state2 (out)
2714 :Returns: 0 on success, -1 on error
2715
2716 Retrieves the state of the in-kernel PIT model. Only valid after
2717 KVM_CREATE_PIT2. The state is returned in the following structure::
2718
2719   struct kvm_pit_state2 {
2720         struct kvm_pit_channel_state channels[3];
2721         __u32 flags;
2722         __u32 reserved[9];
2723   };
2724
2725 Valid flags are::
2726
2727   /* disable PIT in HPET legacy mode */
2728   #define KVM_PIT_FLAGS_HPET_LEGACY  0x00000001
2729
2730 This IOCTL replaces the obsolete KVM_GET_PIT.
2731
2732
2733 4.73 KVM_SET_PIT2
2734 -----------------
2735
2736 :Capability: KVM_CAP_PIT_STATE2
2737 :Architectures: x86
2738 :Type: vm ioctl
2739 :Parameters: struct kvm_pit_state2 (in)
2740 :Returns: 0 on success, -1 on error
2741
2742 Sets the state of the in-kernel PIT model. Only valid after KVM_CREATE_PIT2.
2743 See KVM_GET_PIT2 for details on struct kvm_pit_state2.
2744
2745 This IOCTL replaces the obsolete KVM_SET_PIT.
2746
2747
2748 4.74 KVM_PPC_GET_SMMU_INFO
2749 --------------------------
2750
2751 :Capability: KVM_CAP_PPC_GET_SMMU_INFO
2752 :Architectures: powerpc
2753 :Type: vm ioctl
2754 :Parameters: None
2755 :Returns: 0 on success, -1 on error
2756
2757 This populates and returns a structure describing the features of
2758 the "Server" class MMU emulation supported by KVM.
2759 This can in turn be used by userspace to generate the appropriate
2760 device-tree properties for the guest operating system.
2761
2762 The structure contains some global information, followed by an
2763 array of supported segment page sizes::
2764
2765       struct kvm_ppc_smmu_info {
2766              __u64 flags;
2767              __u32 slb_size;
2768              __u32 pad;
2769              struct kvm_ppc_one_seg_page_size sps[KVM_PPC_PAGE_SIZES_MAX_SZ];
2770       };
2771
2772 The supported flags are:
2773
2774     - KVM_PPC_PAGE_SIZES_REAL:
2775         When that flag is set, guest page sizes must "fit" the backing
2776         store page sizes. When not set, any page size in the list can
2777         be used regardless of how they are backed by userspace.
2778
2779     - KVM_PPC_1T_SEGMENTS
2780         The emulated MMU supports 1T segments in addition to the
2781         standard 256M ones.
2782
2783     - KVM_PPC_NO_HASH
2784         This flag indicates that HPT guests are not supported by KVM,
2785         thus all guests must use radix MMU mode.
2786
2787 The "slb_size" field indicates how many SLB entries are supported
2788
2789 The "sps" array contains 8 entries indicating the supported base
2790 page sizes for a segment in increasing order. Each entry is defined
2791 as follow::
2792
2793    struct kvm_ppc_one_seg_page_size {
2794         __u32 page_shift;       /* Base page shift of segment (or 0) */
2795         __u32 slb_enc;          /* SLB encoding for BookS */
2796         struct kvm_ppc_one_page_size enc[KVM_PPC_PAGE_SIZES_MAX_SZ];
2797    };
2798
2799 An entry with a "page_shift" of 0 is unused. Because the array is
2800 organized in increasing order, a lookup can stop when encoutering
2801 such an entry.
2802
2803 The "slb_enc" field provides the encoding to use in the SLB for the
2804 page size. The bits are in positions such as the value can directly
2805 be OR'ed into the "vsid" argument of the slbmte instruction.
2806
2807 The "enc" array is a list which for each of those segment base page
2808 size provides the list of supported actual page sizes (which can be
2809 only larger or equal to the base page size), along with the
2810 corresponding encoding in the hash PTE. Similarly, the array is
2811 8 entries sorted by increasing sizes and an entry with a "0" shift
2812 is an empty entry and a terminator::
2813
2814    struct kvm_ppc_one_page_size {
2815         __u32 page_shift;       /* Page shift (or 0) */
2816         __u32 pte_enc;          /* Encoding in the HPTE (>>12) */
2817    };
2818
2819 The "pte_enc" field provides a value that can OR'ed into the hash
2820 PTE's RPN field (ie, it needs to be shifted left by 12 to OR it
2821 into the hash PTE second double word).
2822
2823 4.75 KVM_IRQFD
2824 --------------
2825
2826 :Capability: KVM_CAP_IRQFD
2827 :Architectures: x86 s390 arm arm64
2828 :Type: vm ioctl
2829 :Parameters: struct kvm_irqfd (in)
2830 :Returns: 0 on success, -1 on error
2831
2832 Allows setting an eventfd to directly trigger a guest interrupt.
2833 kvm_irqfd.fd specifies the file descriptor to use as the eventfd and
2834 kvm_irqfd.gsi specifies the irqchip pin toggled by this event.  When
2835 an event is triggered on the eventfd, an interrupt is injected into
2836 the guest using the specified gsi pin.  The irqfd is removed using
2837 the KVM_IRQFD_FLAG_DEASSIGN flag, specifying both kvm_irqfd.fd
2838 and kvm_irqfd.gsi.
2839
2840 With KVM_CAP_IRQFD_RESAMPLE, KVM_IRQFD supports a de-assert and notify
2841 mechanism allowing emulation of level-triggered, irqfd-based
2842 interrupts.  When KVM_IRQFD_FLAG_RESAMPLE is set the user must pass an
2843 additional eventfd in the kvm_irqfd.resamplefd field.  When operating
2844 in resample mode, posting of an interrupt through kvm_irq.fd asserts
2845 the specified gsi in the irqchip.  When the irqchip is resampled, such
2846 as from an EOI, the gsi is de-asserted and the user is notified via
2847 kvm_irqfd.resamplefd.  It is the user's responsibility to re-queue
2848 the interrupt if the device making use of it still requires service.
2849 Note that closing the resamplefd is not sufficient to disable the
2850 irqfd.  The KVM_IRQFD_FLAG_RESAMPLE is only necessary on assignment
2851 and need not be specified with KVM_IRQFD_FLAG_DEASSIGN.
2852
2853 On arm/arm64, gsi routing being supported, the following can happen:
2854
2855 - in case no routing entry is associated to this gsi, injection fails
2856 - in case the gsi is associated to an irqchip routing entry,
2857   irqchip.pin + 32 corresponds to the injected SPI ID.
2858 - in case the gsi is associated to an MSI routing entry, the MSI
2859   message and device ID are translated into an LPI (support restricted
2860   to GICv3 ITS in-kernel emulation).
2861
2862 4.76 KVM_PPC_ALLOCATE_HTAB
2863 --------------------------
2864
2865 :Capability: KVM_CAP_PPC_ALLOC_HTAB
2866 :Architectures: powerpc
2867 :Type: vm ioctl
2868 :Parameters: Pointer to u32 containing hash table order (in/out)
2869 :Returns: 0 on success, -1 on error
2870
2871 This requests the host kernel to allocate an MMU hash table for a
2872 guest using the PAPR paravirtualization interface.  This only does
2873 anything if the kernel is configured to use the Book 3S HV style of
2874 virtualization.  Otherwise the capability doesn't exist and the ioctl
2875 returns an ENOTTY error.  The rest of this description assumes Book 3S
2876 HV.
2877
2878 There must be no vcpus running when this ioctl is called; if there
2879 are, it will do nothing and return an EBUSY error.
2880
2881 The parameter is a pointer to a 32-bit unsigned integer variable
2882 containing the order (log base 2) of the desired size of the hash
2883 table, which must be between 18 and 46.  On successful return from the
2884 ioctl, the value will not be changed by the kernel.
2885
2886 If no hash table has been allocated when any vcpu is asked to run
2887 (with the KVM_RUN ioctl), the host kernel will allocate a
2888 default-sized hash table (16 MB).
2889
2890 If this ioctl is called when a hash table has already been allocated,
2891 with a different order from the existing hash table, the existing hash
2892 table will be freed and a new one allocated.  If this is ioctl is
2893 called when a hash table has already been allocated of the same order
2894 as specified, the kernel will clear out the existing hash table (zero
2895 all HPTEs).  In either case, if the guest is using the virtualized
2896 real-mode area (VRMA) facility, the kernel will re-create the VMRA
2897 HPTEs on the next KVM_RUN of any vcpu.
2898
2899 4.77 KVM_S390_INTERRUPT
2900 -----------------------
2901
2902 :Capability: basic
2903 :Architectures: s390
2904 :Type: vm ioctl, vcpu ioctl
2905 :Parameters: struct kvm_s390_interrupt (in)
2906 :Returns: 0 on success, -1 on error
2907
2908 Allows to inject an interrupt to the guest. Interrupts can be floating
2909 (vm ioctl) or per cpu (vcpu ioctl), depending on the interrupt type.
2910
2911 Interrupt parameters are passed via kvm_s390_interrupt::
2912
2913   struct kvm_s390_interrupt {
2914         __u32 type;
2915         __u32 parm;
2916         __u64 parm64;
2917   };
2918
2919 type can be one of the following:
2920
2921 KVM_S390_SIGP_STOP (vcpu)
2922     - sigp stop; optional flags in parm
2923 KVM_S390_PROGRAM_INT (vcpu)
2924     - program check; code in parm
2925 KVM_S390_SIGP_SET_PREFIX (vcpu)
2926     - sigp set prefix; prefix address in parm
2927 KVM_S390_RESTART (vcpu)
2928     - restart
2929 KVM_S390_INT_CLOCK_COMP (vcpu)
2930     - clock comparator interrupt
2931 KVM_S390_INT_CPU_TIMER (vcpu)
2932     - CPU timer interrupt
2933 KVM_S390_INT_VIRTIO (vm)
2934     - virtio external interrupt; external interrupt
2935       parameters in parm and parm64
2936 KVM_S390_INT_SERVICE (vm)
2937     - sclp external interrupt; sclp parameter in parm
2938 KVM_S390_INT_EMERGENCY (vcpu)
2939     - sigp emergency; source cpu in parm
2940 KVM_S390_INT_EXTERNAL_CALL (vcpu)
2941     - sigp external call; source cpu in parm
2942 KVM_S390_INT_IO(ai,cssid,ssid,schid) (vm)
2943     - compound value to indicate an
2944       I/O interrupt (ai - adapter interrupt; cssid,ssid,schid - subchannel);
2945       I/O interruption parameters in parm (subchannel) and parm64 (intparm,
2946       interruption subclass)
2947 KVM_S390_MCHK (vm, vcpu)
2948     - machine check interrupt; cr 14 bits in parm, machine check interrupt
2949       code in parm64 (note that machine checks needing further payload are not
2950       supported by this ioctl)
2951
2952 This is an asynchronous vcpu ioctl and can be invoked from any thread.
2953
2954 4.78 KVM_PPC_GET_HTAB_FD
2955 ------------------------
2956
2957 :Capability: KVM_CAP_PPC_HTAB_FD
2958 :Architectures: powerpc
2959 :Type: vm ioctl
2960 :Parameters: Pointer to struct kvm_get_htab_fd (in)
2961 :Returns: file descriptor number (>= 0) on success, -1 on error
2962
2963 This returns a file descriptor that can be used either to read out the
2964 entries in the guest's hashed page table (HPT), or to write entries to
2965 initialize the HPT.  The returned fd can only be written to if the
2966 KVM_GET_HTAB_WRITE bit is set in the flags field of the argument, and
2967 can only be read if that bit is clear.  The argument struct looks like
2968 this::
2969
2970   /* For KVM_PPC_GET_HTAB_FD */
2971   struct kvm_get_htab_fd {
2972         __u64   flags;
2973         __u64   start_index;
2974         __u64   reserved[2];
2975   };
2976
2977   /* Values for kvm_get_htab_fd.flags */
2978   #define KVM_GET_HTAB_BOLTED_ONLY      ((__u64)0x1)
2979   #define KVM_GET_HTAB_WRITE            ((__u64)0x2)
2980
2981 The 'start_index' field gives the index in the HPT of the entry at
2982 which to start reading.  It is ignored when writing.
2983
2984 Reads on the fd will initially supply information about all
2985 "interesting" HPT entries.  Interesting entries are those with the
2986 bolted bit set, if the KVM_GET_HTAB_BOLTED_ONLY bit is set, otherwise
2987 all entries.  When the end of the HPT is reached, the read() will
2988 return.  If read() is called again on the fd, it will start again from
2989 the beginning of the HPT, but will only return HPT entries that have
2990 changed since they were last read.
2991
2992 Data read or written is structured as a header (8 bytes) followed by a
2993 series of valid HPT entries (16 bytes) each.  The header indicates how
2994 many valid HPT entries there are and how many invalid entries follow
2995 the valid entries.  The invalid entries are not represented explicitly
2996 in the stream.  The header format is::
2997
2998   struct kvm_get_htab_header {
2999         __u32   index;
3000         __u16   n_valid;
3001         __u16   n_invalid;
3002   };
3003
3004 Writes to the fd create HPT entries starting at the index given in the
3005 header; first 'n_valid' valid entries with contents from the data
3006 written, then 'n_invalid' invalid entries, invalidating any previously
3007 valid entries found.
3008
3009 4.79 KVM_CREATE_DEVICE
3010 ----------------------
3011
3012 :Capability: KVM_CAP_DEVICE_CTRL
3013 :Type: vm ioctl
3014 :Parameters: struct kvm_create_device (in/out)
3015 :Returns: 0 on success, -1 on error
3016
3017 Errors:
3018
3019   ======  =======================================================
3020   ENODEV  The device type is unknown or unsupported
3021   EEXIST  Device already created, and this type of device may not
3022           be instantiated multiple times
3023   ======  =======================================================
3024
3025   Other error conditions may be defined by individual device types or
3026   have their standard meanings.
3027
3028 Creates an emulated device in the kernel.  The file descriptor returned
3029 in fd can be used with KVM_SET/GET/HAS_DEVICE_ATTR.
3030
3031 If the KVM_CREATE_DEVICE_TEST flag is set, only test whether the
3032 device type is supported (not necessarily whether it can be created
3033 in the current vm).
3034
3035 Individual devices should not define flags.  Attributes should be used
3036 for specifying any behavior that is not implied by the device type
3037 number.
3038
3039 ::
3040
3041   struct kvm_create_device {
3042         __u32   type;   /* in: KVM_DEV_TYPE_xxx */
3043         __u32   fd;     /* out: device handle */
3044         __u32   flags;  /* in: KVM_CREATE_DEVICE_xxx */
3045   };
3046
3047 4.80 KVM_SET_DEVICE_ATTR/KVM_GET_DEVICE_ATTR
3048 --------------------------------------------
3049
3050 :Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
3051              KVM_CAP_VCPU_ATTRIBUTES for vcpu device
3052 :Type: device ioctl, vm ioctl, vcpu ioctl
3053 :Parameters: struct kvm_device_attr
3054 :Returns: 0 on success, -1 on error
3055
3056 Errors:
3057
3058   =====   =============================================================
3059   ENXIO   The group or attribute is unknown/unsupported for this device
3060           or hardware support is missing.
3061   EPERM   The attribute cannot (currently) be accessed this way
3062           (e.g. read-only attribute, or attribute that only makes
3063           sense when the device is in a different state)
3064   =====   =============================================================
3065
3066   Other error conditions may be defined by individual device types.
3067
3068 Gets/sets a specified piece of device configuration and/or state.  The
3069 semantics are device-specific.  See individual device documentation in
3070 the "devices" directory.  As with ONE_REG, the size of the data
3071 transferred is defined by the particular attribute.
3072
3073 ::
3074
3075   struct kvm_device_attr {
3076         __u32   flags;          /* no flags currently defined */
3077         __u32   group;          /* device-defined */
3078         __u64   attr;           /* group-defined */
3079         __u64   addr;           /* userspace address of attr data */
3080   };
3081
3082 4.81 KVM_HAS_DEVICE_ATTR
3083 ------------------------
3084
3085 :Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
3086              KVM_CAP_VCPU_ATTRIBUTES for vcpu device
3087 :Type: device ioctl, vm ioctl, vcpu ioctl
3088 :Parameters: struct kvm_device_attr
3089 :Returns: 0 on success, -1 on error
3090
3091 Errors:
3092
3093   =====   =============================================================
3094   ENXIO   The group or attribute is unknown/unsupported for this device
3095           or hardware support is missing.
3096   =====   =============================================================
3097
3098 Tests whether a device supports a particular attribute.  A successful
3099 return indicates the attribute is implemented.  It does not necessarily
3100 indicate that the attribute can be read or written in the device's
3101 current state.  "addr" is ignored.
3102
3103 4.82 KVM_ARM_VCPU_INIT
3104 ----------------------
3105
3106 :Capability: basic
3107 :Architectures: arm, arm64
3108 :Type: vcpu ioctl
3109 :Parameters: struct kvm_vcpu_init (in)
3110 :Returns: 0 on success; -1 on error
3111
3112 Errors:
3113
3114   ======     =================================================================
3115   EINVAL     the target is unknown, or the combination of features is invalid.
3116   ENOENT     a features bit specified is unknown.
3117   ======     =================================================================
3118
3119 This tells KVM what type of CPU to present to the guest, and what
3120 optional features it should have.  This will cause a reset of the cpu
3121 registers to their initial values.  If this is not called, KVM_RUN will
3122 return ENOEXEC for that vcpu.
3123
3124 The initial values are defined as:
3125         - Processor state:
3126                 * AArch64: EL1h, D, A, I and F bits set. All other bits
3127                   are cleared.
3128                 * AArch32: SVC, A, I and F bits set. All other bits are
3129                   cleared.
3130         - General Purpose registers, including PC and SP: set to 0
3131         - FPSIMD/NEON registers: set to 0
3132         - SVE registers: set to 0
3133         - System registers: Reset to their architecturally defined
3134           values as for a warm reset to EL1 (resp. SVC)
3135
3136 Note that because some registers reflect machine topology, all vcpus
3137 should be created before this ioctl is invoked.
3138
3139 Userspace can call this function multiple times for a given vcpu, including
3140 after the vcpu has been run. This will reset the vcpu to its initial
3141 state. All calls to this function after the initial call must use the same
3142 target and same set of feature flags, otherwise EINVAL will be returned.
3143
3144 Possible features:
3145
3146         - KVM_ARM_VCPU_POWER_OFF: Starts the CPU in a power-off state.
3147           Depends on KVM_CAP_ARM_PSCI.  If not set, the CPU will be powered on
3148           and execute guest code when KVM_RUN is called.
3149         - KVM_ARM_VCPU_EL1_32BIT: Starts the CPU in a 32bit mode.
3150           Depends on KVM_CAP_ARM_EL1_32BIT (arm64 only).
3151         - KVM_ARM_VCPU_PSCI_0_2: Emulate PSCI v0.2 (or a future revision
3152           backward compatible with v0.2) for the CPU.
3153           Depends on KVM_CAP_ARM_PSCI_0_2.
3154         - KVM_ARM_VCPU_PMU_V3: Emulate PMUv3 for the CPU.
3155           Depends on KVM_CAP_ARM_PMU_V3.
3156
3157         - KVM_ARM_VCPU_PTRAUTH_ADDRESS: Enables Address Pointer authentication
3158           for arm64 only.
3159           Depends on KVM_CAP_ARM_PTRAUTH_ADDRESS.
3160           If KVM_CAP_ARM_PTRAUTH_ADDRESS and KVM_CAP_ARM_PTRAUTH_GENERIC are
3161           both present, then both KVM_ARM_VCPU_PTRAUTH_ADDRESS and
3162           KVM_ARM_VCPU_PTRAUTH_GENERIC must be requested or neither must be
3163           requested.
3164
3165         - KVM_ARM_VCPU_PTRAUTH_GENERIC: Enables Generic Pointer authentication
3166           for arm64 only.
3167           Depends on KVM_CAP_ARM_PTRAUTH_GENERIC.
3168           If KVM_CAP_ARM_PTRAUTH_ADDRESS and KVM_CAP_ARM_PTRAUTH_GENERIC are
3169           both present, then both KVM_ARM_VCPU_PTRAUTH_ADDRESS and
3170           KVM_ARM_VCPU_PTRAUTH_GENERIC must be requested or neither must be
3171           requested.
3172
3173         - KVM_ARM_VCPU_SVE: Enables SVE for the CPU (arm64 only).
3174           Depends on KVM_CAP_ARM_SVE.
3175           Requires KVM_ARM_VCPU_FINALIZE(KVM_ARM_VCPU_SVE):
3176
3177            * After KVM_ARM_VCPU_INIT:
3178
3179               - KVM_REG_ARM64_SVE_VLS may be read using KVM_GET_ONE_REG: the
3180                 initial value of this pseudo-register indicates the best set of
3181                 vector lengths possible for a vcpu on this host.
3182
3183            * Before KVM_ARM_VCPU_FINALIZE(KVM_ARM_VCPU_SVE):
3184
3185               - KVM_RUN and KVM_GET_REG_LIST are not available;
3186
3187               - KVM_GET_ONE_REG and KVM_SET_ONE_REG cannot be used to access
3188                 the scalable archietctural SVE registers
3189                 KVM_REG_ARM64_SVE_ZREG(), KVM_REG_ARM64_SVE_PREG() or
3190                 KVM_REG_ARM64_SVE_FFR;
3191
3192               - KVM_REG_ARM64_SVE_VLS may optionally be written using
3193                 KVM_SET_ONE_REG, to modify the set of vector lengths available
3194                 for the vcpu.
3195
3196            * After KVM_ARM_VCPU_FINALIZE(KVM_ARM_VCPU_SVE):
3197
3198               - the KVM_REG_ARM64_SVE_VLS pseudo-register is immutable, and can
3199                 no longer be written using KVM_SET_ONE_REG.
3200
3201 4.83 KVM_ARM_PREFERRED_TARGET
3202 -----------------------------
3203
3204 :Capability: basic
3205 :Architectures: arm, arm64
3206 :Type: vm ioctl
3207 :Parameters: struct kvm_vcpu_init (out)
3208 :Returns: 0 on success; -1 on error
3209
3210 Errors:
3211
3212   ======     ==========================================
3213   ENODEV     no preferred target available for the host
3214   ======     ==========================================
3215
3216 This queries KVM for preferred CPU target type which can be emulated
3217 by KVM on underlying host.
3218
3219 The ioctl returns struct kvm_vcpu_init instance containing information
3220 about preferred CPU target type and recommended features for it.  The
3221 kvm_vcpu_init->features bitmap returned will have feature bits set if
3222 the preferred target recommends setting these features, but this is
3223 not mandatory.
3224
3225 The information returned by this ioctl can be used to prepare an instance
3226 of struct kvm_vcpu_init for KVM_ARM_VCPU_INIT ioctl which will result in
3227 VCPU matching underlying host.
3228
3229
3230 4.84 KVM_GET_REG_LIST
3231 ---------------------
3232
3233 :Capability: basic
3234 :Architectures: arm, arm64, mips
3235 :Type: vcpu ioctl
3236 :Parameters: struct kvm_reg_list (in/out)
3237 :Returns: 0 on success; -1 on error
3238
3239 Errors:
3240
3241   =====      ==============================================================
3242   E2BIG      the reg index list is too big to fit in the array specified by
3243              the user (the number required will be written into n).
3244   =====      ==============================================================
3245
3246 ::
3247
3248   struct kvm_reg_list {
3249         __u64 n; /* number of registers in reg[] */
3250         __u64 reg[0];
3251   };
3252
3253 This ioctl returns the guest registers that are supported for the
3254 KVM_GET_ONE_REG/KVM_SET_ONE_REG calls.
3255
3256
3257 4.85 KVM_ARM_SET_DEVICE_ADDR (deprecated)
3258 -----------------------------------------
3259
3260 :Capability: KVM_CAP_ARM_SET_DEVICE_ADDR
3261 :Architectures: arm, arm64
3262 :Type: vm ioctl
3263 :Parameters: struct kvm_arm_device_address (in)
3264 :Returns: 0 on success, -1 on error
3265
3266 Errors:
3267
3268   ======  ============================================
3269   ENODEV  The device id is unknown
3270   ENXIO   Device not supported on current system
3271   EEXIST  Address already set
3272   E2BIG   Address outside guest physical address space
3273   EBUSY   Address overlaps with other device range
3274   ======  ============================================
3275
3276 ::
3277
3278   struct kvm_arm_device_addr {
3279         __u64 id;
3280         __u64 addr;
3281   };
3282
3283 Specify a device address in the guest's physical address space where guests
3284 can access emulated or directly exposed devices, which the host kernel needs
3285 to know about. The id field is an architecture specific identifier for a
3286 specific device.
3287
3288 ARM/arm64 divides the id field into two parts, a device id and an
3289 address type id specific to the individual device::
3290
3291   bits:  | 63        ...       32 | 31    ...    16 | 15    ...    0 |
3292   field: |        0x00000000      |     device id   |  addr type id  |
3293
3294 ARM/arm64 currently only require this when using the in-kernel GIC
3295 support for the hardware VGIC features, using KVM_ARM_DEVICE_VGIC_V2
3296 as the device id.  When setting the base address for the guest's
3297 mapping of the VGIC virtual CPU and distributor interface, the ioctl
3298 must be called after calling KVM_CREATE_IRQCHIP, but before calling
3299 KVM_RUN on any of the VCPUs.  Calling this ioctl twice for any of the
3300 base addresses will return -EEXIST.
3301
3302 Note, this IOCTL is deprecated and the more flexible SET/GET_DEVICE_ATTR API
3303 should be used instead.
3304
3305
3306 4.86 KVM_PPC_RTAS_DEFINE_TOKEN
3307 ------------------------------
3308
3309 :Capability: KVM_CAP_PPC_RTAS
3310 :Architectures: ppc
3311 :Type: vm ioctl
3312 :Parameters: struct kvm_rtas_token_args
3313 :Returns: 0 on success, -1 on error
3314
3315 Defines a token value for a RTAS (Run Time Abstraction Services)
3316 service in order to allow it to be handled in the kernel.  The
3317 argument struct gives the name of the service, which must be the name
3318 of a service that has a kernel-side implementation.  If the token
3319 value is non-zero, it will be associated with that service, and
3320 subsequent RTAS calls by the guest specifying that token will be
3321 handled by the kernel.  If the token value is 0, then any token
3322 associated with the service will be forgotten, and subsequent RTAS
3323 calls by the guest for that service will be passed to userspace to be
3324 handled.
3325
3326 4.87 KVM_SET_GUEST_DEBUG
3327 ------------------------
3328
3329 :Capability: KVM_CAP_SET_GUEST_DEBUG
3330 :Architectures: x86, s390, ppc, arm64
3331 :Type: vcpu ioctl
3332 :Parameters: struct kvm_guest_debug (in)
3333 :Returns: 0 on success; -1 on error
3334
3335 ::
3336
3337   struct kvm_guest_debug {
3338        __u32 control;
3339        __u32 pad;
3340        struct kvm_guest_debug_arch arch;
3341   };
3342
3343 Set up the processor specific debug registers and configure vcpu for
3344 handling guest debug events. There are two parts to the structure, the
3345 first a control bitfield indicates the type of debug events to handle
3346 when running. Common control bits are:
3347
3348   - KVM_GUESTDBG_ENABLE:        guest debugging is enabled
3349   - KVM_GUESTDBG_SINGLESTEP:    the next run should single-step
3350
3351 The top 16 bits of the control field are architecture specific control
3352 flags which can include the following:
3353
3354   - KVM_GUESTDBG_USE_SW_BP:     using software breakpoints [x86, arm64]
3355   - KVM_GUESTDBG_USE_HW_BP:     using hardware breakpoints [x86, s390]
3356   - KVM_GUESTDBG_USE_HW:        using hardware debug events [arm64]
3357   - KVM_GUESTDBG_INJECT_DB:     inject DB type exception [x86]
3358   - KVM_GUESTDBG_INJECT_BP:     inject BP type exception [x86]
3359   - KVM_GUESTDBG_EXIT_PENDING:  trigger an immediate guest exit [s390]
3360   - KVM_GUESTDBG_BLOCKIRQ:      avoid injecting interrupts/NMI/SMI [x86]
3361
3362 For example KVM_GUESTDBG_USE_SW_BP indicates that software breakpoints
3363 are enabled in memory so we need to ensure breakpoint exceptions are
3364 correctly trapped and the KVM run loop exits at the breakpoint and not
3365 running off into the normal guest vector. For KVM_GUESTDBG_USE_HW_BP
3366 we need to ensure the guest vCPUs architecture specific registers are
3367 updated to the correct (supplied) values.
3368
3369 The second part of the structure is architecture specific and
3370 typically contains a set of debug registers.
3371
3372 For arm64 the number of debug registers is implementation defined and
3373 can be determined by querying the KVM_CAP_GUEST_DEBUG_HW_BPS and
3374 KVM_CAP_GUEST_DEBUG_HW_WPS capabilities which return a positive number
3375 indicating the number of supported registers.
3376
3377 For ppc, the KVM_CAP_PPC_GUEST_DEBUG_SSTEP capability indicates whether
3378 the single-step debug event (KVM_GUESTDBG_SINGLESTEP) is supported.
3379
3380 Also when supported, KVM_CAP_SET_GUEST_DEBUG2 capability indicates the
3381 supported KVM_GUESTDBG_* bits in the control field.
3382
3383 When debug events exit the main run loop with the reason
3384 KVM_EXIT_DEBUG with the kvm_debug_exit_arch part of the kvm_run
3385 structure containing architecture specific debug information.
3386
3387 4.88 KVM_GET_EMULATED_CPUID
3388 ---------------------------
3389
3390 :Capability: KVM_CAP_EXT_EMUL_CPUID
3391 :Architectures: x86
3392 :Type: system ioctl
3393 :Parameters: struct kvm_cpuid2 (in/out)
3394 :Returns: 0 on success, -1 on error
3395
3396 ::
3397
3398   struct kvm_cpuid2 {
3399         __u32 nent;
3400         __u32 flags;
3401         struct kvm_cpuid_entry2 entries[0];
3402   };
3403
3404 The member 'flags' is used for passing flags from userspace.
3405
3406 ::
3407
3408   #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX               BIT(0)
3409   #define KVM_CPUID_FLAG_STATEFUL_FUNC          BIT(1) /* deprecated */
3410   #define KVM_CPUID_FLAG_STATE_READ_NEXT                BIT(2) /* deprecated */
3411
3412   struct kvm_cpuid_entry2 {
3413         __u32 function;
3414         __u32 index;
3415         __u32 flags;
3416         __u32 eax;
3417         __u32 ebx;
3418         __u32 ecx;
3419         __u32 edx;
3420         __u32 padding[3];
3421   };
3422
3423 This ioctl returns x86 cpuid features which are emulated by
3424 kvm.Userspace can use the information returned by this ioctl to query
3425 which features are emulated by kvm instead of being present natively.
3426
3427 Userspace invokes KVM_GET_EMULATED_CPUID by passing a kvm_cpuid2
3428 structure with the 'nent' field indicating the number of entries in
3429 the variable-size array 'entries'. If the number of entries is too low
3430 to describe the cpu capabilities, an error (E2BIG) is returned. If the
3431 number is too high, the 'nent' field is adjusted and an error (ENOMEM)
3432 is returned. If the number is just right, the 'nent' field is adjusted
3433 to the number of valid entries in the 'entries' array, which is then
3434 filled.
3435
3436 The entries returned are the set CPUID bits of the respective features
3437 which kvm emulates, as returned by the CPUID instruction, with unknown
3438 or unsupported feature bits cleared.
3439
3440 Features like x2apic, for example, may not be present in the host cpu
3441 but are exposed by kvm in KVM_GET_SUPPORTED_CPUID because they can be
3442 emulated efficiently and thus not included here.
3443
3444 The fields in each entry are defined as follows:
3445
3446   function:
3447          the eax value used to obtain the entry
3448   index:
3449          the ecx value used to obtain the entry (for entries that are
3450          affected by ecx)
3451   flags:
3452     an OR of zero or more of the following:
3453
3454         KVM_CPUID_FLAG_SIGNIFCANT_INDEX:
3455            if the index field is valid
3456
3457    eax, ebx, ecx, edx:
3458
3459          the values returned by the cpuid instruction for
3460          this function/index combination
3461
3462 4.89 KVM_S390_MEM_OP
3463 --------------------
3464
3465 :Capability: KVM_CAP_S390_MEM_OP
3466 :Architectures: s390
3467 :Type: vcpu ioctl
3468 :Parameters: struct kvm_s390_mem_op (in)
3469 :Returns: = 0 on success,
3470           < 0 on generic error (e.g. -EFAULT or -ENOMEM),
3471           > 0 if an exception occurred while walking the page tables
3472
3473 Read or write data from/to the logical (virtual) memory of a VCPU.
3474
3475 Parameters are specified via the following structure::
3476
3477   struct kvm_s390_mem_op {
3478         __u64 gaddr;            /* the guest address */
3479         __u64 flags;            /* flags */
3480         __u32 size;             /* amount of bytes */
3481         __u32 op;               /* type of operation */
3482         __u64 buf;              /* buffer in userspace */
3483         __u8 ar;                /* the access register number */
3484         __u8 reserved[31];      /* should be set to 0 */
3485   };
3486
3487 The type of operation is specified in the "op" field. It is either
3488 KVM_S390_MEMOP_LOGICAL_READ for reading from logical memory space or
3489 KVM_S390_MEMOP_LOGICAL_WRITE for writing to logical memory space. The
3490 KVM_S390_MEMOP_F_CHECK_ONLY flag can be set in the "flags" field to check
3491 whether the corresponding memory access would create an access exception
3492 (without touching the data in the memory at the destination). In case an
3493 access exception occurred while walking the MMU tables of the guest, the
3494 ioctl returns a positive error number to indicate the type of exception.
3495 This exception is also raised directly at the corresponding VCPU if the
3496 flag KVM_S390_MEMOP_F_INJECT_EXCEPTION is set in the "flags" field.
3497
3498 The start address of the memory region has to be specified in the "gaddr"
3499 field, and the length of the region in the "size" field (which must not
3500 be 0). The maximum value for "size" can be obtained by checking the
3501 KVM_CAP_S390_MEM_OP capability. "buf" is the buffer supplied by the
3502 userspace application where the read data should be written to for
3503 KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written is
3504 stored for a KVM_S390_MEMOP_LOGICAL_WRITE. When KVM_S390_MEMOP_F_CHECK_ONLY
3505 is specified, "buf" is unused and can be NULL. "ar" designates the access
3506 register number to be used; the valid range is 0..15.
3507
3508 The "reserved" field is meant for future extensions. It is not used by
3509 KVM with the currently defined set of flags.
3510
3511 4.90 KVM_S390_GET_SKEYS
3512 -----------------------
3513
3514 :Capability: KVM_CAP_S390_SKEYS
3515 :Architectures: s390
3516 :Type: vm ioctl
3517 :Parameters: struct kvm_s390_skeys
3518 :Returns: 0 on success, KVM_S390_GET_KEYS_NONE if guest is not using storage
3519           keys, negative value on error
3520
3521 This ioctl is used to get guest storage key values on the s390
3522 architecture. The ioctl takes parameters via the kvm_s390_skeys struct::
3523
3524   struct kvm_s390_skeys {
3525         __u64 start_gfn;
3526         __u64 count;
3527         __u64 skeydata_addr;
3528         __u32 flags;
3529         __u32 reserved[9];
3530   };
3531
3532 The start_gfn field is the number of the first guest frame whose storage keys
3533 you want to get.
3534
3535 The count field is the number of consecutive frames (starting from start_gfn)
3536 whose storage keys to get. The count field must be at least 1 and the maximum
3537 allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
3538 will cause the ioctl to return -EINVAL.
3539
3540 The skeydata_addr field is the address to a buffer large enough to hold count
3541 bytes. This buffer will be filled with storage key data by the ioctl.
3542
3543 4.91 KVM_S390_SET_SKEYS
3544 -----------------------
3545
3546 :Capability: KVM_CAP_S390_SKEYS
3547 :Architectures: s390
3548 :Type: vm ioctl
3549 :Parameters: struct kvm_s390_skeys
3550 :Returns: 0 on success, negative value on error
3551
3552 This ioctl is used to set guest storage key values on the s390
3553 architecture. The ioctl takes parameters via the kvm_s390_skeys struct.
3554 See section on KVM_S390_GET_SKEYS for struct definition.
3555
3556 The start_gfn field is the number of the first guest frame whose storage keys
3557 you want to set.
3558
3559 The count field is the number of consecutive frames (starting from start_gfn)
3560 whose storage keys to get. The count field must be at least 1 and the maximum
3561 allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
3562 will cause the ioctl to return -EINVAL.
3563
3564 The skeydata_addr field is the address to a buffer containing count bytes of
3565 storage keys. Each byte in the buffer will be set as the storage key for a
3566 single frame starting at start_gfn for count frames.
3567
3568 Note: If any architecturally invalid key value is found in the given data then
3569 the ioctl will return -EINVAL.
3570
3571 4.92 KVM_S390_IRQ
3572 -----------------
3573
3574 :Capability: KVM_CAP_S390_INJECT_IRQ
3575 :Architectures: s390
3576 :Type: vcpu ioctl
3577 :Parameters: struct kvm_s390_irq (in)
3578 :Returns: 0 on success, -1 on error
3579
3580 Errors:
3581
3582
3583   ======  =================================================================
3584   EINVAL  interrupt type is invalid
3585           type is KVM_S390_SIGP_STOP and flag parameter is invalid value,
3586           type is KVM_S390_INT_EXTERNAL_CALL and code is bigger
3587           than the maximum of VCPUs
3588   EBUSY   type is KVM_S390_SIGP_SET_PREFIX and vcpu is not stopped,
3589           type is KVM_S390_SIGP_STOP and a stop irq is already pending,
3590           type is KVM_S390_INT_EXTERNAL_CALL and an external call interrupt
3591           is already pending
3592   ======  =================================================================
3593
3594 Allows to inject an interrupt to the guest.
3595
3596 Using struct kvm_s390_irq as a parameter allows
3597 to inject additional payload which is not
3598 possible via KVM_S390_INTERRUPT.
3599
3600 Interrupt parameters are passed via kvm_s390_irq::
3601
3602   struct kvm_s390_irq {
3603         __u64 type;
3604         union {
3605                 struct kvm_s390_io_info io;
3606                 struct kvm_s390_ext_info ext;
3607                 struct kvm_s390_pgm_info pgm;
3608                 struct kvm_s390_emerg_info emerg;
3609                 struct kvm_s390_extcall_info extcall;
3610                 struct kvm_s390_prefix_info prefix;
3611                 struct kvm_s390_stop_info stop;
3612                 struct kvm_s390_mchk_info mchk;
3613                 char reserved[64];
3614         } u;
3615   };
3616
3617 type can be one of the following:
3618
3619 - KVM_S390_SIGP_STOP - sigp stop; parameter in .stop
3620 - KVM_S390_PROGRAM_INT - program check; parameters in .pgm
3621 - KVM_S390_SIGP_SET_PREFIX - sigp set prefix; parameters in .prefix
3622 - KVM_S390_RESTART - restart; no parameters
3623 - KVM_S390_INT_CLOCK_COMP - clock comparator interrupt; no parameters
3624 - KVM_S390_INT_CPU_TIMER - CPU timer interrupt; no parameters
3625 - KVM_S390_INT_EMERGENCY - sigp emergency; parameters in .emerg
3626 - KVM_S390_INT_EXTERNAL_CALL - sigp external call; parameters in .extcall
3627 - KVM_S390_MCHK - machine check interrupt; parameters in .mchk
3628
3629 This is an asynchronous vcpu ioctl and can be invoked from any thread.
3630
3631 4.94 KVM_S390_GET_IRQ_STATE
3632 ---------------------------
3633
3634 :Capability: KVM_CAP_S390_IRQ_STATE
3635 :Architectures: s390
3636 :Type: vcpu ioctl
3637 :Parameters: struct kvm_s390_irq_state (out)
3638 :Returns: >= number of bytes copied into buffer,
3639           -EINVAL if buffer size is 0,
3640           -ENOBUFS if buffer size is too small to fit all pending interrupts,
3641           -EFAULT if the buffer address was invalid
3642
3643 This ioctl allows userspace to retrieve the complete state of all currently
3644 pending interrupts in a single buffer. Use cases include migration
3645 and introspection. The parameter structure contains the address of a
3646 userspace buffer and its length::
3647
3648   struct kvm_s390_irq_state {
3649         __u64 buf;
3650         __u32 flags;        /* will stay unused for compatibility reasons */
3651         __u32 len;
3652         __u32 reserved[4];  /* will stay unused for compatibility reasons */
3653   };
3654
3655 Userspace passes in the above struct and for each pending interrupt a
3656 struct kvm_s390_irq is copied to the provided buffer.
3657
3658 The structure contains a flags and a reserved field for future extensions. As
3659 the kernel never checked for flags == 0 and QEMU never pre-zeroed flags and
3660 reserved, these fields can not be used in the future without breaking
3661 compatibility.
3662
3663 If -ENOBUFS is returned the buffer provided was too small and userspace
3664 may retry with a bigger buffer.
3665
3666 4.95 KVM_S390_SET_IRQ_STATE
3667 ---------------------------
3668
3669 :Capability: KVM_CAP_S390_IRQ_STATE
3670 :Architectures: s390
3671 :Type: vcpu ioctl
3672 :Parameters: struct kvm_s390_irq_state (in)
3673 :Returns: 0 on success,
3674           -EFAULT if the buffer address was invalid,
3675           -EINVAL for an invalid buffer length (see below),
3676           -EBUSY if there were already interrupts pending,
3677           errors occurring when actually injecting the
3678           interrupt. See KVM_S390_IRQ.
3679
3680 This ioctl allows userspace to set the complete state of all cpu-local
3681 interrupts currently pending for the vcpu. It is intended for restoring
3682 interrupt state after a migration. The input parameter is a userspace buffer
3683 containing a struct kvm_s390_irq_state::
3684
3685   struct kvm_s390_irq_state {
3686         __u64 buf;
3687         __u32 flags;        /* will stay unused for compatibility reasons */
3688         __u32 len;
3689         __u32 reserved[4];  /* will stay unused for compatibility reasons */
3690   };
3691
3692 The restrictions for flags and reserved apply as well.
3693 (see KVM_S390_GET_IRQ_STATE)
3694
3695 The userspace memory referenced by buf contains a struct kvm_s390_irq
3696 for each interrupt to be injected into the guest.
3697 If one of the interrupts could not be injected for some reason the
3698 ioctl aborts.
3699
3700 len must be a multiple of sizeof(struct kvm_s390_irq). It must be > 0
3701 and it must not exceed (max_vcpus + 32) * sizeof(struct kvm_s390_irq),
3702 which is the maximum number of possibly pending cpu-local interrupts.
3703
3704 4.96 KVM_SMI
3705 ------------
3706
3707 :Capability: KVM_CAP_X86_SMM
3708 :Architectures: x86
3709 :Type: vcpu ioctl
3710 :Parameters: none
3711 :Returns: 0 on success, -1 on error
3712
3713 Queues an SMI on the thread's vcpu.
3714
3715 4.97 KVM_X86_SET_MSR_FILTER
3716 ----------------------------
3717
3718 :Capability: KVM_X86_SET_MSR_FILTER
3719 :Architectures: x86
3720 :Type: vm ioctl
3721 :Parameters: struct kvm_msr_filter
3722 :Returns: 0 on success, < 0 on error
3723
3724 ::
3725
3726   struct kvm_msr_filter_range {
3727   #define KVM_MSR_FILTER_READ  (1 << 0)
3728   #define KVM_MSR_FILTER_WRITE (1 << 1)
3729         __u32 flags;
3730         __u32 nmsrs; /* number of msrs in bitmap */
3731         __u32 base;  /* MSR index the bitmap starts at */
3732         __u8 *bitmap; /* a 1 bit allows the operations in flags, 0 denies */
3733   };
3734
3735   #define KVM_MSR_FILTER_MAX_RANGES 16
3736   struct kvm_msr_filter {
3737   #define KVM_MSR_FILTER_DEFAULT_ALLOW (0 << 0)
3738   #define KVM_MSR_FILTER_DEFAULT_DENY  (1 << 0)
3739         __u32 flags;
3740         struct kvm_msr_filter_range ranges[KVM_MSR_FILTER_MAX_RANGES];
3741   };
3742
3743 flags values for ``struct kvm_msr_filter_range``:
3744
3745 ``KVM_MSR_FILTER_READ``
3746
3747   Filter read accesses to MSRs using the given bitmap. A 0 in the bitmap
3748   indicates that a read should immediately fail, while a 1 indicates that
3749   a read for a particular MSR should be handled regardless of the default
3750   filter action.
3751
3752 ``KVM_MSR_FILTER_WRITE``
3753
3754   Filter write accesses to MSRs using the given bitmap. A 0 in the bitmap
3755   indicates that a write should immediately fail, while a 1 indicates that
3756   a write for a particular MSR should be handled regardless of the default
3757   filter action.
3758
3759 ``KVM_MSR_FILTER_READ | KVM_MSR_FILTER_WRITE``
3760
3761   Filter both read and write accesses to MSRs using the given bitmap. A 0
3762   in the bitmap indicates that both reads and writes should immediately fail,
3763   while a 1 indicates that reads and writes for a particular MSR are not
3764   filtered by this range.
3765
3766 flags values for ``struct kvm_msr_filter``:
3767
3768 ``KVM_MSR_FILTER_DEFAULT_ALLOW``
3769
3770   If no filter range matches an MSR index that is getting accessed, KVM will
3771   fall back to allowing access to the MSR.
3772
3773 ``KVM_MSR_FILTER_DEFAULT_DENY``
3774
3775   If no filter range matches an MSR index that is getting accessed, KVM will
3776   fall back to rejecting access to the MSR. In this mode, all MSRs that should
3777   be processed by KVM need to explicitly be marked as allowed in the bitmaps.
3778
3779 This ioctl allows user space to define up to 16 bitmaps of MSR ranges to
3780 specify whether a certain MSR access should be explicitly filtered for or not.
3781
3782 If this ioctl has never been invoked, MSR accesses are not guarded and the
3783 default KVM in-kernel emulation behavior is fully preserved.
3784
3785 Calling this ioctl with an empty set of ranges (all nmsrs == 0) disables MSR
3786 filtering. In that mode, ``KVM_MSR_FILTER_DEFAULT_DENY`` is invalid and causes
3787 an error.
3788
3789 As soon as the filtering is in place, every MSR access is processed through
3790 the filtering except for accesses to the x2APIC MSRs (from 0x800 to 0x8ff);
3791 x2APIC MSRs are always allowed, independent of the ``default_allow`` setting,
3792 and their behavior depends on the ``X2APIC_ENABLE`` bit of the APIC base
3793 register.
3794
3795 If a bit is within one of the defined ranges, read and write accesses are
3796 guarded by the bitmap's value for the MSR index if the kind of access
3797 is included in the ``struct kvm_msr_filter_range`` flags.  If no range
3798 cover this particular access, the behavior is determined by the flags
3799 field in the kvm_msr_filter struct: ``KVM_MSR_FILTER_DEFAULT_ALLOW``
3800 and ``KVM_MSR_FILTER_DEFAULT_DENY``.
3801
3802 Each bitmap range specifies a range of MSRs to potentially allow access on.
3803 The range goes from MSR index [base .. base+nmsrs]. The flags field
3804 indicates whether reads, writes or both reads and writes are filtered
3805 by setting a 1 bit in the bitmap for the corresponding MSR index.
3806
3807 If an MSR access is not permitted through the filtering, it generates a
3808 #GP inside the guest. When combined with KVM_CAP_X86_USER_SPACE_MSR, that
3809 allows user space to deflect and potentially handle various MSR accesses
3810 into user space.
3811
3812 If a vCPU is in running state while this ioctl is invoked, the vCPU may
3813 experience inconsistent filtering behavior on MSR accesses.
3814
3815 4.98 KVM_CREATE_SPAPR_TCE_64
3816 ----------------------------
3817
3818 :Capability: KVM_CAP_SPAPR_TCE_64
3819 :Architectures: powerpc
3820 :Type: vm ioctl
3821 :Parameters: struct kvm_create_spapr_tce_64 (in)
3822 :Returns: file descriptor for manipulating the created TCE table
3823
3824 This is an extension for KVM_CAP_SPAPR_TCE which only supports 32bit
3825 windows, described in 4.62 KVM_CREATE_SPAPR_TCE
3826
3827 This capability uses extended struct in ioctl interface::
3828
3829   /* for KVM_CAP_SPAPR_TCE_64 */
3830   struct kvm_create_spapr_tce_64 {
3831         __u64 liobn;
3832         __u32 page_shift;
3833         __u32 flags;
3834         __u64 offset;   /* in pages */
3835         __u64 size;     /* in pages */
3836   };
3837
3838 The aim of extension is to support an additional bigger DMA window with
3839 a variable page size.
3840 KVM_CREATE_SPAPR_TCE_64 receives a 64bit window size, an IOMMU page shift and
3841 a bus offset of the corresponding DMA window, @size and @offset are numbers
3842 of IOMMU pages.
3843
3844 @flags are not used at the moment.
3845
3846 The rest of functionality is identical to KVM_CREATE_SPAPR_TCE.
3847
3848 4.99 KVM_REINJECT_CONTROL
3849 -------------------------
3850
3851 :Capability: KVM_CAP_REINJECT_CONTROL
3852 :Architectures: x86
3853 :Type: vm ioctl
3854 :Parameters: struct kvm_reinject_control (in)
3855 :Returns: 0 on success,
3856          -EFAULT if struct kvm_reinject_control cannot be read,
3857          -ENXIO if KVM_CREATE_PIT or KVM_CREATE_PIT2 didn't succeed earlier.
3858
3859 i8254 (PIT) has two modes, reinject and !reinject.  The default is reinject,
3860 where KVM queues elapsed i8254 ticks and monitors completion of interrupt from
3861 vector(s) that i8254 injects.  Reinject mode dequeues a tick and injects its
3862 interrupt whenever there isn't a pending interrupt from i8254.
3863 !reinject mode injects an interrupt as soon as a tick arrives.
3864
3865 ::
3866
3867   struct kvm_reinject_control {
3868         __u8 pit_reinject;
3869         __u8 reserved[31];
3870   };
3871
3872 pit_reinject = 0 (!reinject mode) is recommended, unless running an old
3873 operating system that uses the PIT for timing (e.g. Linux 2.4.x).
3874
3875 4.100 KVM_PPC_CONFIGURE_V3_MMU
3876 ------------------------------
3877
3878 :Capability: KVM_CAP_PPC_RADIX_MMU or KVM_CAP_PPC_HASH_MMU_V3
3879 :Architectures: ppc
3880 :Type: vm ioctl
3881 :Parameters: struct kvm_ppc_mmuv3_cfg (in)
3882 :Returns: 0 on success,
3883          -EFAULT if struct kvm_ppc_mmuv3_cfg cannot be read,
3884          -EINVAL if the configuration is invalid
3885
3886 This ioctl controls whether the guest will use radix or HPT (hashed
3887 page table) translation, and sets the pointer to the process table for
3888 the guest.
3889
3890 ::
3891
3892   struct kvm_ppc_mmuv3_cfg {
3893         __u64   flags;
3894         __u64   process_table;
3895   };
3896
3897 There are two bits that can be set in flags; KVM_PPC_MMUV3_RADIX and
3898 KVM_PPC_MMUV3_GTSE.  KVM_PPC_MMUV3_RADIX, if set, configures the guest
3899 to use radix tree translation, and if clear, to use HPT translation.
3900 KVM_PPC_MMUV3_GTSE, if set and if KVM permits it, configures the guest
3901 to be able to use the global TLB and SLB invalidation instructions;
3902 if clear, the guest may not use these instructions.
3903
3904 The process_table field specifies the address and size of the guest
3905 process table, which is in the guest's space.  This field is formatted
3906 as the second doubleword of the partition table entry, as defined in
3907 the Power ISA V3.00, Book III section 5.7.6.1.
3908
3909 4.101 KVM_PPC_GET_RMMU_INFO
3910 ---------------------------
3911
3912 :Capability: KVM_CAP_PPC_RADIX_MMU
3913 :Architectures: ppc
3914 :Type: vm ioctl
3915 :Parameters: struct kvm_ppc_rmmu_info (out)
3916 :Returns: 0 on success,
3917          -EFAULT if struct kvm_ppc_rmmu_info cannot be written,
3918          -EINVAL if no useful information can be returned
3919
3920 This ioctl returns a structure containing two things: (a) a list
3921 containing supported radix tree geometries, and (b) a list that maps
3922 page sizes to put in the "AP" (actual page size) field for the tlbie
3923 (TLB invalidate entry) instruction.
3924
3925 ::
3926
3927   struct kvm_ppc_rmmu_info {
3928         struct kvm_ppc_radix_geom {
3929                 __u8    page_shift;
3930                 __u8    level_bits[4];
3931                 __u8    pad[3];
3932         }       geometries[8];
3933         __u32   ap_encodings[8];
3934   };
3935
3936 The geometries[] field gives up to 8 supported geometries for the
3937 radix page table, in terms of the log base 2 of the smallest page
3938 size, and the number of bits indexed at each level of the tree, from
3939 the PTE level up to the PGD level in that order.  Any unused entries
3940 will have 0 in the page_shift field.
3941
3942 The ap_encodings gives the supported page sizes and their AP field
3943 encodings, encoded with the AP value in the top 3 bits and the log
3944 base 2 of the page size in the bottom 6 bits.
3945
3946 4.102 KVM_PPC_RESIZE_HPT_PREPARE
3947 --------------------------------
3948
3949 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
3950 :Architectures: powerpc
3951 :Type: vm ioctl
3952 :Parameters: struct kvm_ppc_resize_hpt (in)
3953 :Returns: 0 on successful completion,
3954          >0 if a new HPT is being prepared, the value is an estimated
3955          number of milliseconds until preparation is complete,
3956          -EFAULT if struct kvm_reinject_control cannot be read,
3957          -EINVAL if the supplied shift or flags are invalid,
3958          -ENOMEM if unable to allocate the new HPT,
3959
3960 Used to implement the PAPR extension for runtime resizing of a guest's
3961 Hashed Page Table (HPT).  Specifically this starts, stops or monitors
3962 the preparation of a new potential HPT for the guest, essentially
3963 implementing the H_RESIZE_HPT_PREPARE hypercall.
3964
3965 ::
3966
3967   struct kvm_ppc_resize_hpt {
3968         __u64 flags;
3969         __u32 shift;
3970         __u32 pad;
3971   };
3972
3973 If called with shift > 0 when there is no pending HPT for the guest,
3974 this begins preparation of a new pending HPT of size 2^(shift) bytes.
3975 It then returns a positive integer with the estimated number of
3976 milliseconds until preparation is complete.
3977
3978 If called when there is a pending HPT whose size does not match that
3979 requested in the parameters, discards the existing pending HPT and
3980 creates a new one as above.
3981
3982 If called when there is a pending HPT of the size requested, will:
3983
3984   * If preparation of the pending HPT is already complete, return 0
3985   * If preparation of the pending HPT has failed, return an error
3986     code, then discard the pending HPT.
3987   * If preparation of the pending HPT is still in progress, return an
3988     estimated number of milliseconds until preparation is complete.
3989
3990 If called with shift == 0, discards any currently pending HPT and
3991 returns 0 (i.e. cancels any in-progress preparation).
3992
3993 flags is reserved for future expansion, currently setting any bits in
3994 flags will result in an -EINVAL.
3995
3996 Normally this will be called repeatedly with the same parameters until
3997 it returns <= 0.  The first call will initiate preparation, subsequent
3998 ones will monitor preparation until it completes or fails.
3999
4000 4.103 KVM_PPC_RESIZE_HPT_COMMIT
4001 -------------------------------
4002
4003 :Capability: KVM_CAP_SPAPR_RESIZE_HPT
4004 :Architectures: powerpc
4005 :Type: vm ioctl
4006 :Parameters: struct kvm_ppc_resize_hpt (in)
4007 :Returns: 0 on successful completion,
4008          -EFAULT if struct kvm_reinject_control cannot be read,
4009          -EINVAL if the supplied shift or flags are invalid,
4010          -ENXIO is there is no pending HPT, or the pending HPT doesn't
4011          have the requested size,
4012          -EBUSY if the pending HPT is not fully prepared,
4013          -ENOSPC if there was a hash collision when moving existing
4014          HPT entries to the new HPT,
4015          -EIO on other error conditions
4016
4017 Used to implement the PAPR extension for runtime resizing of a guest's
4018 Hashed Page Table (HPT).  Specifically this requests that the guest be
4019 transferred to working with the new HPT, essentially implementing the
4020 H_RESIZE_HPT_COMMIT hypercall.
4021
4022 ::
4023
4024   struct kvm_ppc_resize_hpt {
4025         __u64 flags;
4026         __u32 shift;
4027         __u32 pad;
4028   };
4029
4030 This should only be called after KVM_PPC_RESIZE_HPT_PREPARE has
4031 returned 0 with the same parameters.  In other cases
4032 KVM_PPC_RESIZE_HPT_COMMIT will return an error (usually -ENXIO or
4033 -EBUSY, though others may be possible if the preparation was started,
4034 but failed).
4035
4036 This will have undefined effects on the guest if it has not already
4037 placed itself in a quiescent state where no vcpu will make MMU enabled
4038 memory accesses.
4039
4040 On succsful completion, the pending HPT will become the guest's active
4041 HPT and the previous HPT will be discarded.
4042
4043 On failure, the guest will still be operating on its previous HPT.
4044
4045 4.104 KVM_X86_GET_MCE_CAP_SUPPORTED
4046 -----------------------------------
4047
4048 :Capability: KVM_CAP_MCE
4049 :Architectures: x86
4050 :Type: system ioctl
4051 :Parameters: u64 mce_cap (out)
4052 :Returns: 0 on success, -1 on error
4053
4054 Returns supported MCE capabilities. The u64 mce_cap parameter
4055 has the same format as the MSR_IA32_MCG_CAP register. Supported
4056 capabilities will have the corresponding bits set.
4057
4058 4.105 KVM_X86_SETUP_MCE
4059 -----------------------
4060
4061 :Capability: KVM_CAP_MCE
4062 :Architectures: x86
4063 :Type: vcpu ioctl
4064 :Parameters: u64 mcg_cap (in)
4065 :Returns: 0 on success,
4066          -EFAULT if u64 mcg_cap cannot be read,
4067          -EINVAL if the requested number of banks is invalid,
4068          -EINVAL if requested MCE capability is not supported.
4069
4070 Initializes MCE support for use. The u64 mcg_cap parameter
4071 has the same format as the MSR_IA32_MCG_CAP register and
4072 specifies which capabilities should be enabled. The maximum
4073 supported number of error-reporting banks can be retrieved when
4074 checking for KVM_CAP_MCE. The supported capabilities can be
4075 retrieved with KVM_X86_GET_MCE_CAP_SUPPORTED.
4076
4077 4.106 KVM_X86_SET_MCE
4078 ---------------------
4079
4080 :Capability: KVM_CAP_MCE
4081 :Architectures: x86
4082 :Type: vcpu ioctl
4083 :Parameters: struct kvm_x86_mce (in)
4084 :Returns: 0 on success,
4085          -EFAULT if struct kvm_x86_mce cannot be read,
4086          -EINVAL if the bank number is invalid,
4087          -EINVAL if VAL bit is not set in status field.
4088
4089 Inject a machine check error (MCE) into the guest. The input
4090 parameter is::
4091
4092   struct kvm_x86_mce {
4093         __u64 status;
4094         __u64 addr;
4095         __u64 misc;
4096         __u64 mcg_status;
4097         __u8 bank;
4098         __u8 pad1[7];
4099         __u64 pad2[3];
4100   };
4101
4102 If the MCE being reported is an uncorrected error, KVM will
4103 inject it as an MCE exception into the guest. If the guest
4104 MCG_STATUS register reports that an MCE is in progress, KVM
4105 causes an KVM_EXIT_SHUTDOWN vmexit.
4106
4107 Otherwise, if the MCE is a corrected error, KVM will just
4108 store it in the corresponding bank (provided this bank is
4109 not holding a previously reported uncorrected error).
4110
4111 4.107 KVM_S390_GET_CMMA_BITS
4112 ----------------------------
4113
4114 :Capability: KVM_CAP_S390_CMMA_MIGRATION
4115 :Architectures: s390
4116 :Type: vm ioctl
4117 :Parameters: struct kvm_s390_cmma_log (in, out)
4118 :Returns: 0 on success, a negative value on error
4119
4120 This ioctl is used to get the values of the CMMA bits on the s390
4121 architecture. It is meant to be used in two scenarios:
4122
4123 - During live migration to save the CMMA values. Live migration needs
4124   to be enabled via the KVM_REQ_START_MIGRATION VM property.
4125 - To non-destructively peek at the CMMA values, with the flag
4126   KVM_S390_CMMA_PEEK set.
4127
4128 The ioctl takes parameters via the kvm_s390_cmma_log struct. The desired
4129 values are written to a buffer whose location is indicated via the "values"
4130 member in the kvm_s390_cmma_log struct.  The values in the input struct are
4131 also updated as needed.
4132
4133 Each CMMA value takes up one byte.
4134
4135 ::
4136
4137   struct kvm_s390_cmma_log {
4138         __u64 start_gfn;
4139         __u32 count;
4140         __u32 flags;
4141         union {
4142                 __u64 remaining;
4143                 __u64 mask;
4144         };
4145         __u64 values;
4146   };
4147
4148 start_gfn is the number of the first guest frame whose CMMA values are
4149 to be retrieved,
4150
4151 count is the length of the buffer in bytes,
4152
4153 values points to the buffer where the result will be written to.
4154
4155 If count is greater than KVM_S390_SKEYS_MAX, then it is considered to be
4156 KVM_S390_SKEYS_MAX. KVM_S390_SKEYS_MAX is re-used for consistency with
4157 other ioctls.
4158
4159 The result is written in the buffer pointed to by the field values, and
4160 the values of the input parameter are updated as follows.
4161
4162 Depending on the flags, different actions are performed. The only
4163 supported flag so far is KVM_S390_CMMA_PEEK.
4164
4165 The default behaviour if KVM_S390_CMMA_PEEK is not set is:
4166 start_gfn will indicate the first page frame whose CMMA bits were dirty.
4167 It is not necessarily the same as the one passed as input, as clean pages
4168 are skipped.
4169
4170 count will indicate the number of bytes actually written in the buffer.
4171 It can (and very often will) be smaller than the input value, since the
4172 buffer is only filled until 16 bytes of clean values are found (which
4173 are then not copied in the buffer). Since a CMMA migration block needs
4174 the base address and the length, for a total of 16 bytes, we will send
4175 back some clean data if there is some dirty data afterwards, as long as
4176 the size of the clean data does not exceed the size of the header. This
4177 allows to minimize the amount of data to be saved or transferred over
4178 the network at the expense of more roundtrips to userspace. The next
4179 invocation of the ioctl will skip over all the clean values, saving
4180 potentially more than just the 16 bytes we found.
4181
4182 If KVM_S390_CMMA_PEEK is set:
4183 the existing storage attributes are read even when not in migration
4184 mode, and no other action is performed;
4185
4186 the output start_gfn will be equal to the input start_gfn,
4187
4188 the output count will be equal to the input count, except if the end of
4189 memory has been reached.
4190
4191 In both cases:
4192 the field "remaining" will indicate the total number of dirty CMMA values
4193 still remaining, or 0 if KVM_S390_CMMA_PEEK is set and migration mode is
4194 not enabled.
4195
4196 mask is unused.
4197
4198 values points to the userspace buffer where the result will be stored.
4199
4200 This ioctl can fail with -ENOMEM if not enough memory can be allocated to
4201 complete the task, with -ENXIO if CMMA is not enabled, with -EINVAL if
4202 KVM_S390_CMMA_PEEK is not set but migration mode was not enabled, with
4203 -EFAULT if the userspace address is invalid or if no page table is
4204 present for the addresses (e.g. when using hugepages).
4205
4206 4.108 KVM_S390_SET_CMMA_BITS
4207 ----------------------------
4208
4209 :Capability: KVM_CAP_S390_CMMA_MIGRATION
4210 :Architectures: s390
4211 :Type: vm ioctl
4212 :Parameters: struct kvm_s390_cmma_log (in)
4213 :Returns: 0 on success, a negative value on error
4214
4215 This ioctl is used to set the values of the CMMA bits on the s390
4216 architecture. It is meant to be used during live migration to restore
4217 the CMMA values, but there are no restrictions on its use.
4218 The ioctl takes parameters via the kvm_s390_cmma_values struct.
4219 Each CMMA value takes up one byte.
4220
4221 ::
4222
4223   struct kvm_s390_cmma_log {
4224         __u64 start_gfn;
4225         __u32 count;
4226         __u32 flags;
4227         union {
4228                 __u64 remaining;
4229                 __u64 mask;
4230         };
4231         __u64 values;
4232   };
4233
4234 start_gfn indicates the starting guest frame number,
4235
4236 count indicates how many values are to be considered in the buffer,
4237
4238 flags is not used and must be 0.
4239
4240 mask indicates which PGSTE bits are to be considered.
4241
4242 remaining is not used.
4243
4244 values points to the buffer in userspace where to store the values.
4245
4246 This ioctl can fail with -ENOMEM if not enough memory can be allocated to
4247 complete the task, with -ENXIO if CMMA is not enabled, with -EINVAL if
4248 the count field is too large (e.g. more than KVM_S390_CMMA_SIZE_MAX) or
4249 if the flags field was not 0, with -EFAULT if the userspace address is
4250 invalid, if invalid pages are written to (e.g. after the end of memory)
4251 or if no page table is present for the addresses (e.g. when using
4252 hugepages).
4253
4254 4.109 KVM_PPC_GET_CPU_CHAR
4255 --------------------------
4256
4257 :Capability: KVM_CAP_PPC_GET_CPU_CHAR
4258 :Architectures: powerpc
4259 :Type: vm ioctl
4260 :Parameters: struct kvm_ppc_cpu_char (out)
4261 :Returns: 0 on successful completion,
4262          -EFAULT if struct kvm_ppc_cpu_char cannot be written
4263
4264 This ioctl gives userspace information about certain characteristics
4265 of the CPU relating to speculative execution of instructions and
4266 possible information leakage resulting from speculative execution (see
4267 CVE-2017-5715, CVE-2017-5753 and CVE-2017-5754).  The information is
4268 returned in struct kvm_ppc_cpu_char, which looks like this::
4269
4270   struct kvm_ppc_cpu_char {
4271         __u64   character;              /* characteristics of the CPU */
4272         __u64   behaviour;              /* recommended software behaviour */
4273         __u64   character_mask;         /* valid bits in character */
4274         __u64   behaviour_mask;         /* valid bits in behaviour */
4275   };
4276
4277 For extensibility, the character_mask and behaviour_mask fields
4278 indicate which bits of character and behaviour have been filled in by
4279 the kernel.  If the set of defined bits is extended in future then
4280 userspace will be able to tell whether it is running on a kernel that
4281 knows about the new bits.
4282
4283 The character field describes attributes of the CPU which can help
4284 with preventing inadvertent information disclosure - specifically,
4285 whether there is an instruction to flash-invalidate the L1 data cache
4286 (ori 30,30,0 or mtspr SPRN_TRIG2,rN), whether the L1 data cache is set
4287 to a mode where entries can only be used by the thread that created
4288 them, whether the bcctr[l] instruction prevents speculation, and
4289 whether a speculation barrier instruction (ori 31,31,0) is provided.
4290
4291 The behaviour field describes actions that software should take to
4292 prevent inadvertent information disclosure, and thus describes which
4293 vulnerabilities the hardware is subject to; specifically whether the
4294 L1 data cache should be flushed when returning to user mode from the
4295 kernel, and whether a speculation barrier should be placed between an
4296 array bounds check and the array access.
4297
4298 These fields use the same bit definitions as the new
4299 H_GET_CPU_CHARACTERISTICS hypercall.
4300
4301 4.110 KVM_MEMORY_ENCRYPT_OP
4302 ---------------------------
4303
4304 :Capability: basic
4305 :Architectures: x86
4306 :Type: vm
4307 :Parameters: an opaque platform specific structure (in/out)
4308 :Returns: 0 on success; -1 on error
4309
4310 If the platform supports creating encrypted VMs then this ioctl can be used
4311 for issuing platform-specific memory encryption commands to manage those
4312 encrypted VMs.
4313
4314 Currently, this ioctl is used for issuing Secure Encrypted Virtualization
4315 (SEV) commands on AMD Processors. The SEV commands are defined in
4316 Documentation/virt/kvm/amd-memory-encryption.rst.
4317
4318 4.111 KVM_MEMORY_ENCRYPT_REG_REGION
4319 -----------------------------------
4320
4321 :Capability: basic
4322 :Architectures: x86
4323 :Type: system
4324 :Parameters: struct kvm_enc_region (in)
4325 :Returns: 0 on success; -1 on error
4326
4327 This ioctl can be used to register a guest memory region which may
4328 contain encrypted data (e.g. guest RAM, SMRAM etc).
4329
4330 It is used in the SEV-enabled guest. When encryption is enabled, a guest
4331 memory region may contain encrypted data. The SEV memory encryption
4332 engine uses a tweak such that two identical plaintext pages, each at
4333 different locations will have differing ciphertexts. So swapping or
4334 moving ciphertext of those pages will not result in plaintext being
4335 swapped. So relocating (or migrating) physical backing pages for the SEV
4336 guest will require some additional steps.
4337
4338 Note: The current SEV key management spec does not provide commands to
4339 swap or migrate (move) ciphertext pages. Hence, for now we pin the guest
4340 memory region registered with the ioctl.
4341
4342 4.112 KVM_MEMORY_ENCRYPT_UNREG_REGION
4343 -------------------------------------
4344
4345 :Capability: basic
4346 :Architectures: x86
4347 :Type: system
4348 :Parameters: struct kvm_enc_region (in)
4349 :Returns: 0 on success; -1 on error
4350
4351 This ioctl can be used to unregister the guest memory region registered
4352 with KVM_MEMORY_ENCRYPT_REG_REGION ioctl above.
4353
4354 4.113 KVM_HYPERV_EVENTFD
4355 ------------------------
4356
4357 :Capability: KVM_CAP_HYPERV_EVENTFD
4358 :Architectures: x86
4359 :Type: vm ioctl
4360 :Parameters: struct kvm_hyperv_eventfd (in)
4361
4362 This ioctl (un)registers an eventfd to receive notifications from the guest on
4363 the specified Hyper-V connection id through the SIGNAL_EVENT hypercall, without
4364 causing a user exit.  SIGNAL_EVENT hypercall with non-zero event flag number
4365 (bits 24-31) still triggers a KVM_EXIT_HYPERV_HCALL user exit.
4366
4367 ::
4368
4369   struct kvm_hyperv_eventfd {
4370         __u32 conn_id;
4371         __s32 fd;
4372         __u32 flags;
4373         __u32 padding[3];
4374   };
4375
4376 The conn_id field should fit within 24 bits::
4377
4378   #define KVM_HYPERV_CONN_ID_MASK               0x00ffffff
4379
4380 The acceptable values for the flags field are::
4381
4382   #define KVM_HYPERV_EVENTFD_DEASSIGN   (1 << 0)
4383
4384 :Returns: 0 on success,
4385           -EINVAL if conn_id or flags is outside the allowed range,
4386           -ENOENT on deassign if the conn_id isn't registered,
4387           -EEXIST on assign if the conn_id is already registered
4388
4389 4.114 KVM_GET_NESTED_STATE
4390 --------------------------
4391
4392 :Capability: KVM_CAP_NESTED_STATE
4393 :Architectures: x86
4394 :Type: vcpu ioctl
4395 :Parameters: struct kvm_nested_state (in/out)
4396 :Returns: 0 on success, -1 on error
4397
4398 Errors:
4399
4400   =====      =============================================================
4401   E2BIG      the total state size exceeds the value of 'size' specified by
4402              the user; the size required will be written into size.
4403   =====      =============================================================
4404
4405 ::
4406
4407   struct kvm_nested_state {
4408         __u16 flags;
4409         __u16 format;
4410         __u32 size;
4411
4412         union {
4413                 struct kvm_vmx_nested_state_hdr vmx;
4414                 struct kvm_svm_nested_state_hdr svm;
4415
4416                 /* Pad the header to 128 bytes.  */
4417                 __u8 pad[120];
4418         } hdr;
4419
4420         union {
4421                 struct kvm_vmx_nested_state_data vmx[0];
4422                 struct kvm_svm_nested_state_data svm[0];
4423         } data;
4424   };
4425
4426   #define KVM_STATE_NESTED_GUEST_MODE           0x00000001
4427   #define KVM_STATE_NESTED_RUN_PENDING          0x00000002
4428   #define KVM_STATE_NESTED_EVMCS                0x00000004
4429
4430   #define KVM_STATE_NESTED_FORMAT_VMX           0
4431   #define KVM_STATE_NESTED_FORMAT_SVM           1
4432
4433   #define KVM_STATE_NESTED_VMX_VMCS_SIZE        0x1000
4434
4435   #define KVM_STATE_NESTED_VMX_SMM_GUEST_MODE   0x00000001
4436   #define KVM_STATE_NESTED_VMX_SMM_VMXON        0x00000002
4437
4438   #define KVM_STATE_VMX_PREEMPTION_TIMER_DEADLINE 0x00000001
4439
4440   struct kvm_vmx_nested_state_hdr {
4441         __u64 vmxon_pa;
4442         __u64 vmcs12_pa;
4443
4444         struct {
4445                 __u16 flags;
4446         } smm;
4447
4448         __u32 flags;
4449         __u64 preemption_timer_deadline;
4450   };
4451
4452   struct kvm_vmx_nested_state_data {
4453         __u8 vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
4454         __u8 shadow_vmcs12[KVM_STATE_NESTED_VMX_VMCS_SIZE];
4455   };
4456
4457 This ioctl copies the vcpu's nested virtualization state from the kernel to
4458 userspace.
4459
4460 The maximum size of the state can be retrieved by passing KVM_CAP_NESTED_STATE
4461 to the KVM_CHECK_EXTENSION ioctl().
4462
4463 4.115 KVM_SET_NESTED_STATE
4464 --------------------------
4465
4466 :Capability: KVM_CAP_NESTED_STATE
4467 :Architectures: x86
4468 :Type: vcpu ioctl
4469 :Parameters: struct kvm_nested_state (in)
4470 :Returns: 0 on success, -1 on error
4471
4472 This copies the vcpu's kvm_nested_state struct from userspace to the kernel.
4473 For the definition of struct kvm_nested_state, see KVM_GET_NESTED_STATE.
4474
4475 4.116 KVM_(UN)REGISTER_COALESCED_MMIO
4476 -------------------------------------
4477
4478 :Capability: KVM_CAP_COALESCED_MMIO (for coalesced mmio)
4479              KVM_CAP_COALESCED_PIO (for coalesced pio)
4480 :Architectures: all
4481 :Type: vm ioctl
4482 :Parameters: struct kvm_coalesced_mmio_zone
4483 :Returns: 0 on success, < 0 on error
4484
4485 Coalesced I/O is a performance optimization that defers hardware
4486 register write emulation so that userspace exits are avoided.  It is
4487 typically used to reduce the overhead of emulating frequently accessed
4488 hardware registers.
4489
4490 When a hardware register is configured for coalesced I/O, write accesses
4491 do not exit to userspace and their value is recorded in a ring buffer
4492 that is shared between kernel and userspace.
4493
4494 Coalesced I/O is used if one or more write accesses to a hardware
4495 register can be deferred until a read or a write to another hardware
4496 register on the same device.  This last access will cause a vmexit and
4497 userspace will process accesses from the ring buffer before emulating
4498 it. That will avoid exiting to userspace on repeated writes.
4499
4500 Coalesced pio is based on coalesced mmio. There is little difference
4501 between coalesced mmio and pio except that coalesced pio records accesses
4502 to I/O ports.
4503
4504 4.117 KVM_CLEAR_DIRTY_LOG (vm ioctl)
4505 ------------------------------------
4506
4507 :Capability: KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
4508 :Architectures: x86, arm, arm64, mips
4509 :Type: vm ioctl
4510 :Parameters: struct kvm_clear_dirty_log (in)
4511 :Returns: 0 on success, -1 on error
4512
4513 ::
4514
4515   /* for KVM_CLEAR_DIRTY_LOG */
4516   struct kvm_clear_dirty_log {
4517         __u32 slot;
4518         __u32 num_pages;
4519         __u64 first_page;
4520         union {
4521                 void __user *dirty_bitmap; /* one bit per page */
4522                 __u64 padding;
4523         };
4524   };
4525
4526 The ioctl clears the dirty status of pages in a memory slot, according to
4527 the bitmap that is passed in struct kvm_clear_dirty_log's dirty_bitmap
4528 field.  Bit 0 of the bitmap corresponds to page "first_page" in the
4529 memory slot, and num_pages is the size in bits of the input bitmap.
4530 first_page must be a multiple of 64; num_pages must also be a multiple of
4531 64 unless first_page + num_pages is the size of the memory slot.  For each
4532 bit that is set in the input bitmap, the corresponding page is marked "clean"
4533 in KVM's dirty bitmap, and dirty tracking is re-enabled for that page
4534 (for example via write-protection, or by clearing the dirty bit in
4535 a page table entry).
4536
4537 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of slot field specifies
4538 the address space for which you want to clear the dirty status.  See
4539 KVM_SET_USER_MEMORY_REGION for details on the usage of slot field.
4540
4541 This ioctl is mostly useful when KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
4542 is enabled; for more information, see the description of the capability.
4543 However, it can always be used as long as KVM_CHECK_EXTENSION confirms
4544 that KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 is present.
4545
4546 4.118 KVM_GET_SUPPORTED_HV_CPUID
4547 --------------------------------
4548
4549 :Capability: KVM_CAP_HYPERV_CPUID (vcpu), KVM_CAP_SYS_HYPERV_CPUID (system)
4550 :Architectures: x86
4551 :Type: system ioctl, vcpu ioctl
4552 :Parameters: struct kvm_cpuid2 (in/out)
4553 :Returns: 0 on success, -1 on error
4554
4555 ::
4556
4557   struct kvm_cpuid2 {
4558         __u32 nent;
4559         __u32 padding;
4560         struct kvm_cpuid_entry2 entries[0];
4561   };
4562
4563   struct kvm_cpuid_entry2 {
4564         __u32 function;
4565         __u32 index;
4566         __u32 flags;
4567         __u32 eax;
4568         __u32 ebx;
4569         __u32 ecx;
4570         __u32 edx;
4571         __u32 padding[3];
4572   };
4573
4574 This ioctl returns x86 cpuid features leaves related to Hyper-V emulation in
4575 KVM.  Userspace can use the information returned by this ioctl to construct
4576 cpuid information presented to guests consuming Hyper-V enlightenments (e.g.
4577 Windows or Hyper-V guests).
4578
4579 CPUID feature leaves returned by this ioctl are defined by Hyper-V Top Level
4580 Functional Specification (TLFS). These leaves can't be obtained with
4581 KVM_GET_SUPPORTED_CPUID ioctl because some of them intersect with KVM feature
4582 leaves (0x40000000, 0x40000001).
4583
4584 Currently, the following list of CPUID leaves are returned:
4585
4586  - HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS
4587  - HYPERV_CPUID_INTERFACE
4588  - HYPERV_CPUID_VERSION
4589  - HYPERV_CPUID_FEATURES
4590  - HYPERV_CPUID_ENLIGHTMENT_INFO
4591  - HYPERV_CPUID_IMPLEMENT_LIMITS
4592  - HYPERV_CPUID_NESTED_FEATURES
4593  - HYPERV_CPUID_SYNDBG_VENDOR_AND_MAX_FUNCTIONS
4594  - HYPERV_CPUID_SYNDBG_INTERFACE
4595  - HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES
4596
4597 Userspace invokes KVM_GET_SUPPORTED_HV_CPUID by passing a kvm_cpuid2 structure
4598 with the 'nent' field indicating the number of entries in the variable-size
4599 array 'entries'.  If the number of entries is too low to describe all Hyper-V
4600 feature leaves, an error (E2BIG) is returned. If the number is more or equal
4601 to the number of Hyper-V feature leaves, the 'nent' field is adjusted to the
4602 number of valid entries in the 'entries' array, which is then filled.
4603
4604 'index' and 'flags' fields in 'struct kvm_cpuid_entry2' are currently reserved,
4605 userspace should not expect to get any particular value there.
4606
4607 Note, vcpu version of KVM_GET_SUPPORTED_HV_CPUID is currently deprecated. Unlike
4608 system ioctl which exposes all supported feature bits unconditionally, vcpu
4609 version has the following quirks:
4610
4611 - HYPERV_CPUID_NESTED_FEATURES leaf and HV_X64_ENLIGHTENED_VMCS_RECOMMENDED
4612   feature bit are only exposed when Enlightened VMCS was previously enabled
4613   on the corresponding vCPU (KVM_CAP_HYPERV_ENLIGHTENED_VMCS).
4614 - HV_STIMER_DIRECT_MODE_AVAILABLE bit is only exposed with in-kernel LAPIC.
4615   (presumes KVM_CREATE_IRQCHIP has already been called).
4616
4617 4.119 KVM_ARM_VCPU_FINALIZE
4618 ---------------------------
4619
4620 :Architectures: arm, arm64
4621 :Type: vcpu ioctl
4622 :Parameters: int feature (in)
4623 :Returns: 0 on success, -1 on error
4624
4625 Errors:
4626
4627   ======     ==============================================================
4628   EPERM      feature not enabled, needs configuration, or already finalized
4629   EINVAL     feature unknown or not present
4630   ======     ==============================================================
4631
4632 Recognised values for feature:
4633
4634   =====      ===========================================
4635   arm64      KVM_ARM_VCPU_SVE (requires KVM_CAP_ARM_SVE)
4636   =====      ===========================================
4637
4638 Finalizes the configuration of the specified vcpu feature.
4639
4640 The vcpu must already have been initialised, enabling the affected feature, by
4641 means of a successful KVM_ARM_VCPU_INIT call with the appropriate flag set in
4642 features[].
4643
4644 For affected vcpu features, this is a mandatory step that must be performed
4645 before the vcpu is fully usable.
4646
4647 Between KVM_ARM_VCPU_INIT and KVM_ARM_VCPU_FINALIZE, the feature may be
4648 configured by use of ioctls such as KVM_SET_ONE_REG.  The exact configuration
4649 that should be performaned and how to do it are feature-dependent.
4650
4651 Other calls that depend on a particular feature being finalized, such as
4652 KVM_RUN, KVM_GET_REG_LIST, KVM_GET_ONE_REG and KVM_SET_ONE_REG, will fail with
4653 -EPERM unless the feature has already been finalized by means of a
4654 KVM_ARM_VCPU_FINALIZE call.
4655
4656 See KVM_ARM_VCPU_INIT for details of vcpu features that require finalization
4657 using this ioctl.
4658
4659 4.120 KVM_SET_PMU_EVENT_FILTER
4660 ------------------------------
4661
4662 :Capability: KVM_CAP_PMU_EVENT_FILTER
4663 :Architectures: x86
4664 :Type: vm ioctl
4665 :Parameters: struct kvm_pmu_event_filter (in)
4666 :Returns: 0 on success, -1 on error
4667
4668 ::
4669
4670   struct kvm_pmu_event_filter {
4671         __u32 action;
4672         __u32 nevents;
4673         __u32 fixed_counter_bitmap;
4674         __u32 flags;
4675         __u32 pad[4];
4676         __u64 events[0];
4677   };
4678
4679 This ioctl restricts the set of PMU events that the guest can program.
4680 The argument holds a list of events which will be allowed or denied.
4681 The eventsel+umask of each event the guest attempts to program is compared
4682 against the events field to determine whether the guest should have access.
4683 The events field only controls general purpose counters; fixed purpose
4684 counters are controlled by the fixed_counter_bitmap.
4685
4686 No flags are defined yet, the field must be zero.
4687
4688 Valid values for 'action'::
4689
4690   #define KVM_PMU_EVENT_ALLOW 0
4691   #define KVM_PMU_EVENT_DENY 1
4692
4693 4.121 KVM_PPC_SVM_OFF
4694 ---------------------
4695
4696 :Capability: basic
4697 :Architectures: powerpc
4698 :Type: vm ioctl
4699 :Parameters: none
4700 :Returns: 0 on successful completion,
4701
4702 Errors:
4703
4704   ======     ================================================================
4705   EINVAL     if ultravisor failed to terminate the secure guest
4706   ENOMEM     if hypervisor failed to allocate new radix page tables for guest
4707   ======     ================================================================
4708
4709 This ioctl is used to turn off the secure mode of the guest or transition
4710 the guest from secure mode to normal mode. This is invoked when the guest
4711 is reset. This has no effect if called for a normal guest.
4712
4713 This ioctl issues an ultravisor call to terminate the secure guest,
4714 unpins the VPA pages and releases all the device pages that are used to
4715 track the secure pages by hypervisor.
4716
4717 4.122 KVM_S390_NORMAL_RESET
4718 ---------------------------
4719
4720 :Capability: KVM_CAP_S390_VCPU_RESETS
4721 :Architectures: s390
4722 :Type: vcpu ioctl
4723 :Parameters: none
4724 :Returns: 0
4725
4726 This ioctl resets VCPU registers and control structures according to
4727 the cpu reset definition in the POP (Principles Of Operation).
4728
4729 4.123 KVM_S390_INITIAL_RESET
4730 ----------------------------
4731
4732 :Capability: none
4733 :Architectures: s390
4734 :Type: vcpu ioctl
4735 :Parameters: none
4736 :Returns: 0
4737
4738 This ioctl resets VCPU registers and control structures according to
4739 the initial cpu reset definition in the POP. However, the cpu is not
4740 put into ESA mode. This reset is a superset of the normal reset.
4741
4742 4.124 KVM_S390_CLEAR_RESET
4743 --------------------------
4744
4745 :Capability: KVM_CAP_S390_VCPU_RESETS
4746 :Architectures: s390
4747 :Type: vcpu ioctl
4748 :Parameters: none
4749 :Returns: 0
4750
4751 This ioctl resets VCPU registers and control structures according to
4752 the clear cpu reset definition in the POP. However, the cpu is not put
4753 into ESA mode. This reset is a superset of the initial reset.
4754
4755
4756 4.125 KVM_S390_PV_COMMAND
4757 -------------------------
4758
4759 :Capability: KVM_CAP_S390_PROTECTED
4760 :Architectures: s390
4761 :Type: vm ioctl
4762 :Parameters: struct kvm_pv_cmd
4763 :Returns: 0 on success, < 0 on error
4764
4765 ::
4766
4767   struct kvm_pv_cmd {
4768         __u32 cmd;      /* Command to be executed */
4769         __u16 rc;       /* Ultravisor return code */
4770         __u16 rrc;      /* Ultravisor return reason code */
4771         __u64 data;     /* Data or address */
4772         __u32 flags;    /* flags for future extensions. Must be 0 for now */
4773         __u32 reserved[3];
4774   };
4775
4776 cmd values:
4777
4778 KVM_PV_ENABLE
4779   Allocate memory and register the VM with the Ultravisor, thereby
4780   donating memory to the Ultravisor that will become inaccessible to
4781   KVM. All existing CPUs are converted to protected ones. After this
4782   command has succeeded, any CPU added via hotplug will become
4783   protected during its creation as well.
4784
4785   Errors:
4786
4787   =====      =============================
4788   EINTR      an unmasked signal is pending
4789   =====      =============================
4790
4791 KVM_PV_DISABLE
4792
4793   Deregister the VM from the Ultravisor and reclaim the memory that
4794   had been donated to the Ultravisor, making it usable by the kernel
4795   again.  All registered VCPUs are converted back to non-protected
4796   ones.
4797
4798 KVM_PV_VM_SET_SEC_PARMS
4799   Pass the image header from VM memory to the Ultravisor in
4800   preparation of image unpacking and verification.
4801
4802 KVM_PV_VM_UNPACK
4803   Unpack (protect and decrypt) a page of the encrypted boot image.
4804
4805 KVM_PV_VM_VERIFY
4806   Verify the integrity of the unpacked image. Only if this succeeds,
4807   KVM is allowed to start protected VCPUs.
4808
4809 4.126 KVM_X86_SET_MSR_FILTER
4810 ----------------------------
4811
4812 :Capability: KVM_CAP_X86_MSR_FILTER
4813 :Architectures: x86
4814 :Type: vm ioctl
4815 :Parameters: struct kvm_msr_filter
4816 :Returns: 0 on success, < 0 on error
4817
4818 ::
4819
4820   struct kvm_msr_filter_range {
4821   #define KVM_MSR_FILTER_READ  (1 << 0)
4822   #define KVM_MSR_FILTER_WRITE (1 << 1)
4823         __u32 flags;
4824         __u32 nmsrs; /* number of msrs in bitmap */
4825         __u32 base;  /* MSR index the bitmap starts at */
4826         __u8 *bitmap; /* a 1 bit allows the operations in flags, 0 denies */
4827   };
4828
4829   #define KVM_MSR_FILTER_MAX_RANGES 16
4830   struct kvm_msr_filter {
4831   #define KVM_MSR_FILTER_DEFAULT_ALLOW (0 << 0)
4832   #define KVM_MSR_FILTER_DEFAULT_DENY  (1 << 0)
4833         __u32 flags;
4834         struct kvm_msr_filter_range ranges[KVM_MSR_FILTER_MAX_RANGES];
4835   };
4836
4837 flags values for ``struct kvm_msr_filter_range``:
4838
4839 ``KVM_MSR_FILTER_READ``
4840
4841   Filter read accesses to MSRs using the given bitmap. A 0 in the bitmap
4842   indicates that a read should immediately fail, while a 1 indicates that
4843   a read for a particular MSR should be handled regardless of the default
4844   filter action.
4845
4846 ``KVM_MSR_FILTER_WRITE``
4847
4848   Filter write accesses to MSRs using the given bitmap. A 0 in the bitmap
4849   indicates that a write should immediately fail, while a 1 indicates that
4850   a write for a particular MSR should be handled regardless of the default
4851   filter action.
4852
4853 ``KVM_MSR_FILTER_READ | KVM_MSR_FILTER_WRITE``
4854
4855   Filter both read and write accesses to MSRs using the given bitmap. A 0
4856   in the bitmap indicates that both reads and writes should immediately fail,
4857   while a 1 indicates that reads and writes for a particular MSR are not
4858   filtered by this range.
4859
4860 flags values for ``struct kvm_msr_filter``:
4861
4862 ``KVM_MSR_FILTER_DEFAULT_ALLOW``
4863
4864   If no filter range matches an MSR index that is getting accessed, KVM will
4865   fall back to allowing access to the MSR.
4866
4867 ``KVM_MSR_FILTER_DEFAULT_DENY``
4868
4869   If no filter range matches an MSR index that is getting accessed, KVM will
4870   fall back to rejecting access to the MSR. In this mode, all MSRs that should
4871   be processed by KVM need to explicitly be marked as allowed in the bitmaps.
4872
4873 This ioctl allows user space to define up to 16 bitmaps of MSR ranges to
4874 specify whether a certain MSR access should be explicitly filtered for or not.
4875
4876 If this ioctl has never been invoked, MSR accesses are not guarded and the
4877 default KVM in-kernel emulation behavior is fully preserved.
4878
4879 Calling this ioctl with an empty set of ranges (all nmsrs == 0) disables MSR
4880 filtering. In that mode, ``KVM_MSR_FILTER_DEFAULT_DENY`` is invalid and causes
4881 an error.
4882
4883 As soon as the filtering is in place, every MSR access is processed through
4884 the filtering except for accesses to the x2APIC MSRs (from 0x800 to 0x8ff);
4885 x2APIC MSRs are always allowed, independent of the ``default_allow`` setting,
4886 and their behavior depends on the ``X2APIC_ENABLE`` bit of the APIC base
4887 register.
4888
4889 If a bit is within one of the defined ranges, read and write accesses are
4890 guarded by the bitmap's value for the MSR index if the kind of access
4891 is included in the ``struct kvm_msr_filter_range`` flags.  If no range
4892 cover this particular access, the behavior is determined by the flags
4893 field in the kvm_msr_filter struct: ``KVM_MSR_FILTER_DEFAULT_ALLOW``
4894 and ``KVM_MSR_FILTER_DEFAULT_DENY``.
4895
4896 Each bitmap range specifies a range of MSRs to potentially allow access on.
4897 The range goes from MSR index [base .. base+nmsrs]. The flags field
4898 indicates whether reads, writes or both reads and writes are filtered
4899 by setting a 1 bit in the bitmap for the corresponding MSR index.
4900
4901 If an MSR access is not permitted through the filtering, it generates a
4902 #GP inside the guest. When combined with KVM_CAP_X86_USER_SPACE_MSR, that
4903 allows user space to deflect and potentially handle various MSR accesses
4904 into user space.
4905
4906 Note, invoking this ioctl with a vCPU is running is inherently racy.  However,
4907 KVM does guarantee that vCPUs will see either the previous filter or the new
4908 filter, e.g. MSRs with identical settings in both the old and new filter will
4909 have deterministic behavior.
4910
4911 4.127 KVM_XEN_HVM_SET_ATTR
4912 --------------------------
4913
4914 :Capability: KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO
4915 :Architectures: x86
4916 :Type: vm ioctl
4917 :Parameters: struct kvm_xen_hvm_attr
4918 :Returns: 0 on success, < 0 on error
4919
4920 ::
4921
4922   struct kvm_xen_hvm_attr {
4923         __u16 type;
4924         __u16 pad[3];
4925         union {
4926                 __u8 long_mode;
4927                 __u8 vector;
4928                 struct {
4929                         __u64 gfn;
4930                 } shared_info;
4931                 __u64 pad[4];
4932         } u;
4933   };
4934
4935 type values:
4936
4937 KVM_XEN_ATTR_TYPE_LONG_MODE
4938   Sets the ABI mode of the VM to 32-bit or 64-bit (long mode). This
4939   determines the layout of the shared info pages exposed to the VM.
4940
4941 KVM_XEN_ATTR_TYPE_SHARED_INFO
4942   Sets the guest physical frame number at which the Xen "shared info"
4943   page resides. Note that although Xen places vcpu_info for the first
4944   32 vCPUs in the shared_info page, KVM does not automatically do so
4945   and instead requires that KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO be used
4946   explicitly even when the vcpu_info for a given vCPU resides at the
4947   "default" location in the shared_info page. This is because KVM is
4948   not aware of the Xen CPU id which is used as the index into the
4949   vcpu_info[] array, so cannot know the correct default location.
4950
4951 KVM_XEN_ATTR_TYPE_UPCALL_VECTOR
4952   Sets the exception vector used to deliver Xen event channel upcalls.
4953
4954 4.127 KVM_XEN_HVM_GET_ATTR
4955 --------------------------
4956
4957 :Capability: KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO
4958 :Architectures: x86
4959 :Type: vm ioctl
4960 :Parameters: struct kvm_xen_hvm_attr
4961 :Returns: 0 on success, < 0 on error
4962
4963 Allows Xen VM attributes to be read. For the structure and types,
4964 see KVM_XEN_HVM_SET_ATTR above.
4965
4966 4.128 KVM_XEN_VCPU_SET_ATTR
4967 ---------------------------
4968
4969 :Capability: KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO
4970 :Architectures: x86
4971 :Type: vcpu ioctl
4972 :Parameters: struct kvm_xen_vcpu_attr
4973 :Returns: 0 on success, < 0 on error
4974
4975 ::
4976
4977   struct kvm_xen_vcpu_attr {
4978         __u16 type;
4979         __u16 pad[3];
4980         union {
4981                 __u64 gpa;
4982                 __u64 pad[4];
4983                 struct {
4984                         __u64 state;
4985                         __u64 state_entry_time;
4986                         __u64 time_running;
4987                         __u64 time_runnable;
4988                         __u64 time_blocked;
4989                         __u64 time_offline;
4990                 } runstate;
4991         } u;
4992   };
4993
4994 type values:
4995
4996 KVM_XEN_VCPU_ATTR_TYPE_VCPU_INFO
4997   Sets the guest physical address of the vcpu_info for a given vCPU.
4998
4999 KVM_XEN_VCPU_ATTR_TYPE_VCPU_TIME_INFO
5000   Sets the guest physical address of an additional pvclock structure
5001   for a given vCPU. This is typically used for guest vsyscall support.
5002
5003 KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADDR
5004   Sets the guest physical address of the vcpu_runstate_info for a given
5005   vCPU. This is how a Xen guest tracks CPU state such as steal time.
5006
5007 KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_CURRENT
5008   Sets the runstate (RUNSTATE_running/_runnable/_blocked/_offline) of
5009   the given vCPU from the .u.runstate.state member of the structure.
5010   KVM automatically accounts running and runnable time but blocked
5011   and offline states are only entered explicitly.
5012
5013 KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_DATA
5014   Sets all fields of the vCPU runstate data from the .u.runstate member
5015   of the structure, including the current runstate. The state_entry_time
5016   must equal the sum of the other four times.
5017
5018 KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST
5019   This *adds* the contents of the .u.runstate members of the structure
5020   to the corresponding members of the given vCPU's runstate data, thus
5021   permitting atomic adjustments to the runstate times. The adjustment
5022   to the state_entry_time must equal the sum of the adjustments to the
5023   other four times. The state field must be set to -1, or to a valid
5024   runstate value (RUNSTATE_running, RUNSTATE_runnable, RUNSTATE_blocked
5025   or RUNSTATE_offline) to set the current accounted state as of the
5026   adjusted state_entry_time.
5027
5028 4.129 KVM_XEN_VCPU_GET_ATTR
5029 ---------------------------
5030
5031 :Capability: KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_SHARED_INFO
5032 :Architectures: x86
5033 :Type: vcpu ioctl
5034 :Parameters: struct kvm_xen_vcpu_attr
5035 :Returns: 0 on success, < 0 on error
5036
5037 Allows Xen vCPU attributes to be read. For the structure and types,
5038 see KVM_XEN_VCPU_SET_ATTR above.
5039
5040 The KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST type may not be used
5041 with the KVM_XEN_VCPU_GET_ATTR ioctl.
5042
5043 4.130 KVM_ARM_MTE_COPY_TAGS
5044 ---------------------------
5045
5046 :Capability: KVM_CAP_ARM_MTE
5047 :Architectures: arm64
5048 :Type: vm ioctl
5049 :Parameters: struct kvm_arm_copy_mte_tags
5050 :Returns: number of bytes copied, < 0 on error (-EINVAL for incorrect
5051           arguments, -EFAULT if memory cannot be accessed).
5052
5053 ::
5054
5055   struct kvm_arm_copy_mte_tags {
5056         __u64 guest_ipa;
5057         __u64 length;
5058         void __user *addr;
5059         __u64 flags;
5060         __u64 reserved[2];
5061   };
5062
5063 Copies Memory Tagging Extension (MTE) tags to/from guest tag memory. The
5064 ``guest_ipa`` and ``length`` fields must be ``PAGE_SIZE`` aligned. The ``addr``
5065 field must point to a buffer which the tags will be copied to or from.
5066
5067 ``flags`` specifies the direction of copy, either ``KVM_ARM_TAGS_TO_GUEST`` or
5068 ``KVM_ARM_TAGS_FROM_GUEST``.
5069
5070 The size of the buffer to store the tags is ``(length / 16)`` bytes
5071 (granules in MTE are 16 bytes long). Each byte contains a single tag
5072 value. This matches the format of ``PTRACE_PEEKMTETAGS`` and
5073 ``PTRACE_POKEMTETAGS``.
5074
5075 If an error occurs before any data is copied then a negative error code is
5076 returned. If some tags have been copied before an error occurs then the number
5077 of bytes successfully copied is returned. If the call completes successfully
5078 then ``length`` is returned.
5079
5080 4.131 KVM_GET_SREGS2
5081 --------------------
5082
5083 :Capability: KVM_CAP_SREGS2
5084 :Architectures: x86
5085 :Type: vcpu ioctl
5086 :Parameters: struct kvm_sregs2 (out)
5087 :Returns: 0 on success, -1 on error
5088
5089 Reads special registers from the vcpu.
5090 This ioctl (when supported) replaces the KVM_GET_SREGS.
5091
5092 ::
5093
5094         struct kvm_sregs2 {
5095                 /* out (KVM_GET_SREGS2) / in (KVM_SET_SREGS2) */
5096                 struct kvm_segment cs, ds, es, fs, gs, ss;
5097                 struct kvm_segment tr, ldt;
5098                 struct kvm_dtable gdt, idt;
5099                 __u64 cr0, cr2, cr3, cr4, cr8;
5100                 __u64 efer;
5101                 __u64 apic_base;
5102                 __u64 flags;
5103                 __u64 pdptrs[4];
5104         };
5105
5106 flags values for ``kvm_sregs2``:
5107
5108 ``KVM_SREGS2_FLAGS_PDPTRS_VALID``
5109
5110   Indicates thats the struct contain valid PDPTR values.
5111
5112
5113 4.132 KVM_SET_SREGS2
5114 --------------------
5115
5116 :Capability: KVM_CAP_SREGS2
5117 :Architectures: x86
5118 :Type: vcpu ioctl
5119 :Parameters: struct kvm_sregs2 (in)
5120 :Returns: 0 on success, -1 on error
5121
5122 Writes special registers into the vcpu.
5123 See KVM_GET_SREGS2 for the data structures.
5124 This ioctl (when supported) replaces the KVM_SET_SREGS.
5125
5126 4.133 KVM_GET_STATS_FD
5127 ----------------------
5128
5129 :Capability: KVM_CAP_STATS_BINARY_FD
5130 :Architectures: all
5131 :Type: vm ioctl, vcpu ioctl
5132 :Parameters: none
5133 :Returns: statistics file descriptor on success, < 0 on error
5134
5135 Errors:
5136
5137   ======     ======================================================
5138   ENOMEM     if the fd could not be created due to lack of memory
5139   EMFILE     if the number of opened files exceeds the limit
5140   ======     ======================================================
5141
5142 The returned file descriptor can be used to read VM/vCPU statistics data in
5143 binary format. The data in the file descriptor consists of four blocks
5144 organized as follows:
5145
5146 +-------------+
5147 |   Header    |
5148 +-------------+
5149 |  id string  |
5150 +-------------+
5151 | Descriptors |
5152 +-------------+
5153 | Stats Data  |
5154 +-------------+
5155
5156 Apart from the header starting at offset 0, please be aware that it is
5157 not guaranteed that the four blocks are adjacent or in the above order;
5158 the offsets of the id, descriptors and data blocks are found in the
5159 header.  However, all four blocks are aligned to 64 bit offsets in the
5160 file and they do not overlap.
5161
5162 All blocks except the data block are immutable.  Userspace can read them
5163 only one time after retrieving the file descriptor, and then use ``pread`` or
5164 ``lseek`` to read the statistics repeatedly.
5165
5166 All data is in system endianness.
5167
5168 The format of the header is as follows::
5169
5170         struct kvm_stats_header {
5171                 __u32 flags;
5172                 __u32 name_size;
5173                 __u32 num_desc;
5174                 __u32 id_offset;
5175                 __u32 desc_offset;
5176                 __u32 data_offset;
5177         };
5178
5179 The ``flags`` field is not used at the moment. It is always read as 0.
5180
5181 The ``name_size`` field is the size (in byte) of the statistics name string
5182 (including trailing '\0') which is contained in the "id string" block and
5183 appended at the end of every descriptor.
5184
5185 The ``num_desc`` field is the number of descriptors that are included in the
5186 descriptor block.  (The actual number of values in the data block may be
5187 larger, since each descriptor may comprise more than one value).
5188
5189 The ``id_offset`` field is the offset of the id string from the start of the
5190 file indicated by the file descriptor. It is a multiple of 8.
5191
5192 The ``desc_offset`` field is the offset of the Descriptors block from the start
5193 of the file indicated by the file descriptor. It is a multiple of 8.
5194
5195 The ``data_offset`` field is the offset of the Stats Data block from the start
5196 of the file indicated by the file descriptor. It is a multiple of 8.
5197
5198 The id string block contains a string which identifies the file descriptor on
5199 which KVM_GET_STATS_FD was invoked.  The size of the block, including the
5200 trailing ``'\0'``, is indicated by the ``name_size`` field in the header.
5201
5202 The descriptors block is only needed to be read once for the lifetime of the
5203 file descriptor contains a sequence of ``struct kvm_stats_desc``, each followed
5204 by a string of size ``name_size``.
5205 ::
5206
5207         #define KVM_STATS_TYPE_SHIFT            0
5208         #define KVM_STATS_TYPE_MASK             (0xF << KVM_STATS_TYPE_SHIFT)
5209         #define KVM_STATS_TYPE_CUMULATIVE       (0x0 << KVM_STATS_TYPE_SHIFT)
5210         #define KVM_STATS_TYPE_INSTANT          (0x1 << KVM_STATS_TYPE_SHIFT)
5211         #define KVM_STATS_TYPE_PEAK             (0x2 << KVM_STATS_TYPE_SHIFT)
5212         #define KVM_STATS_TYPE_LINEAR_HIST      (0x3 << KVM_STATS_TYPE_SHIFT)
5213         #define KVM_STATS_TYPE_LOG_HIST         (0x4 << KVM_STATS_TYPE_SHIFT)
5214         #define KVM_STATS_TYPE_MAX              KVM_STATS_TYPE_LOG_HIST
5215
5216         #define KVM_STATS_UNIT_SHIFT            4
5217         #define KVM_STATS_UNIT_MASK             (0xF << KVM_STATS_UNIT_SHIFT)
5218         #define KVM_STATS_UNIT_NONE             (0x0 << KVM_STATS_UNIT_SHIFT)
5219         #define KVM_STATS_UNIT_BYTES            (0x1 << KVM_STATS_UNIT_SHIFT)
5220         #define KVM_STATS_UNIT_SECONDS          (0x2 << KVM_STATS_UNIT_SHIFT)
5221         #define KVM_STATS_UNIT_CYCLES           (0x3 << KVM_STATS_UNIT_SHIFT)
5222         #define KVM_STATS_UNIT_MAX              KVM_STATS_UNIT_CYCLES
5223
5224         #define KVM_STATS_BASE_SHIFT            8
5225         #define KVM_STATS_BASE_MASK             (0xF << KVM_STATS_BASE_SHIFT)
5226         #define KVM_STATS_BASE_POW10            (0x0 << KVM_STATS_BASE_SHIFT)
5227         #define KVM_STATS_BASE_POW2             (0x1 << KVM_STATS_BASE_SHIFT)
5228         #define KVM_STATS_BASE_MAX              KVM_STATS_BASE_POW2
5229
5230         struct kvm_stats_desc {
5231                 __u32 flags;
5232                 __s16 exponent;
5233                 __u16 size;
5234                 __u32 offset;
5235                 __u32 bucket_size;
5236                 char name[];
5237         };
5238
5239 The ``flags`` field contains the type and unit of the statistics data described
5240 by this descriptor. Its endianness is CPU native.
5241 The following flags are supported:
5242
5243 Bits 0-3 of ``flags`` encode the type:
5244
5245   * ``KVM_STATS_TYPE_CUMULATIVE``
5246     The statistics reports a cumulative count. The value of data can only be increased.
5247     Most of the counters used in KVM are of this type.
5248     The corresponding ``size`` field for this type is always 1.
5249     All cumulative statistics data are read/write.
5250   * ``KVM_STATS_TYPE_INSTANT``
5251     The statistics reports an instantaneous value. Its value can be increased or
5252     decreased. This type is usually used as a measurement of some resources,
5253     like the number of dirty pages, the number of large pages, etc.
5254     All instant statistics are read only.
5255     The corresponding ``size`` field for this type is always 1.
5256   * ``KVM_STATS_TYPE_PEAK``
5257     The statistics data reports a peak value, for example the maximum number
5258     of items in a hash table bucket, the longest time waited and so on.
5259     The value of data can only be increased.
5260     The corresponding ``size`` field for this type is always 1.
5261   * ``KVM_STATS_TYPE_LINEAR_HIST``
5262     The statistic is reported as a linear histogram. The number of
5263     buckets is specified by the ``size`` field. The size of buckets is specified
5264     by the ``hist_param`` field. The range of the Nth bucket (1 <= N < ``size``)
5265     is [``hist_param``*(N-1), ``hist_param``*N), while the range of the last
5266     bucket is [``hist_param``*(``size``-1), +INF). (+INF means positive infinity
5267     value.) The bucket value indicates how many samples fell in the bucket's range.
5268   * ``KVM_STATS_TYPE_LOG_HIST``
5269     The statistic is reported as a logarithmic histogram. The number of
5270     buckets is specified by the ``size`` field. The range of the first bucket is
5271     [0, 1), while the range of the last bucket is [pow(2, ``size``-2), +INF).
5272     Otherwise, The Nth bucket (1 < N < ``size``) covers
5273     [pow(2, N-2), pow(2, N-1)). The bucket value indicates how many samples fell
5274     in the bucket's range.
5275
5276 Bits 4-7 of ``flags`` encode the unit:
5277
5278   * ``KVM_STATS_UNIT_NONE``
5279     There is no unit for the value of statistics data. This usually means that
5280     the value is a simple counter of an event.
5281   * ``KVM_STATS_UNIT_BYTES``
5282     It indicates that the statistics data is used to measure memory size, in the
5283     unit of Byte, KiByte, MiByte, GiByte, etc. The unit of the data is
5284     determined by the ``exponent`` field in the descriptor.
5285   * ``KVM_STATS_UNIT_SECONDS``
5286     It indicates that the statistics data is used to measure time or latency.
5287   * ``KVM_STATS_UNIT_CYCLES``
5288     It indicates that the statistics data is used to measure CPU clock cycles.
5289
5290 Bits 8-11 of ``flags``, together with ``exponent``, encode the scale of the
5291 unit:
5292
5293   * ``KVM_STATS_BASE_POW10``
5294     The scale is based on power of 10. It is used for measurement of time and
5295     CPU clock cycles.  For example, an exponent of -9 can be used with
5296     ``KVM_STATS_UNIT_SECONDS`` to express that the unit is nanoseconds.
5297   * ``KVM_STATS_BASE_POW2``
5298     The scale is based on power of 2. It is used for measurement of memory size.
5299     For example, an exponent of 20 can be used with ``KVM_STATS_UNIT_BYTES`` to
5300     express that the unit is MiB.
5301
5302 The ``size`` field is the number of values of this statistics data. Its
5303 value is usually 1 for most of simple statistics. 1 means it contains an
5304 unsigned 64bit data.
5305
5306 The ``offset`` field is the offset from the start of Data Block to the start of
5307 the corresponding statistics data.
5308
5309 The ``bucket_size`` field is used as a parameter for histogram statistics data.
5310 It is only used by linear histogram statistics data, specifying the size of a
5311 bucket.
5312
5313 The ``name`` field is the name string of the statistics data. The name string
5314 starts at the end of ``struct kvm_stats_desc``.  The maximum length including
5315 the trailing ``'\0'``, is indicated by ``name_size`` in the header.
5316
5317 The Stats Data block contains an array of 64-bit values in the same order
5318 as the descriptors in Descriptors block.
5319
5320 5. The kvm_run structure
5321 ========================
5322
5323 Application code obtains a pointer to the kvm_run structure by
5324 mmap()ing a vcpu fd.  From that point, application code can control
5325 execution by changing fields in kvm_run prior to calling the KVM_RUN
5326 ioctl, and obtain information about the reason KVM_RUN returned by
5327 looking up structure members.
5328
5329 ::
5330
5331   struct kvm_run {
5332         /* in */
5333         __u8 request_interrupt_window;
5334
5335 Request that KVM_RUN return when it becomes possible to inject external
5336 interrupts into the guest.  Useful in conjunction with KVM_INTERRUPT.
5337
5338 ::
5339
5340         __u8 immediate_exit;
5341
5342 This field is polled once when KVM_RUN starts; if non-zero, KVM_RUN
5343 exits immediately, returning -EINTR.  In the common scenario where a
5344 signal is used to "kick" a VCPU out of KVM_RUN, this field can be used
5345 to avoid usage of KVM_SET_SIGNAL_MASK, which has worse scalability.
5346 Rather than blocking the signal outside KVM_RUN, userspace can set up
5347 a signal handler that sets run->immediate_exit to a non-zero value.
5348
5349 This field is ignored if KVM_CAP_IMMEDIATE_EXIT is not available.
5350
5351 ::
5352
5353         __u8 padding1[6];
5354
5355         /* out */
5356         __u32 exit_reason;
5357
5358 When KVM_RUN has returned successfully (return value 0), this informs
5359 application code why KVM_RUN has returned.  Allowable values for this
5360 field are detailed below.
5361
5362 ::
5363
5364         __u8 ready_for_interrupt_injection;
5365
5366 If request_interrupt_window has been specified, this field indicates
5367 an interrupt can be injected now with KVM_INTERRUPT.
5368
5369 ::
5370
5371         __u8 if_flag;
5372
5373 The value of the current interrupt flag.  Only valid if in-kernel
5374 local APIC is not used.
5375
5376 ::
5377
5378         __u16 flags;
5379
5380 More architecture-specific flags detailing state of the VCPU that may
5381 affect the device's behavior. Current defined flags::
5382
5383   /* x86, set if the VCPU is in system management mode */
5384   #define KVM_RUN_X86_SMM     (1 << 0)
5385   /* x86, set if bus lock detected in VM */
5386   #define KVM_RUN_BUS_LOCK    (1 << 1)
5387
5388 ::
5389
5390         /* in (pre_kvm_run), out (post_kvm_run) */
5391         __u64 cr8;
5392
5393 The value of the cr8 register.  Only valid if in-kernel local APIC is
5394 not used.  Both input and output.
5395
5396 ::
5397
5398         __u64 apic_base;
5399
5400 The value of the APIC BASE msr.  Only valid if in-kernel local
5401 APIC is not used.  Both input and output.
5402
5403 ::
5404
5405         union {
5406                 /* KVM_EXIT_UNKNOWN */
5407                 struct {
5408                         __u64 hardware_exit_reason;
5409                 } hw;
5410
5411 If exit_reason is KVM_EXIT_UNKNOWN, the vcpu has exited due to unknown
5412 reasons.  Further architecture-specific information is available in
5413 hardware_exit_reason.
5414
5415 ::
5416
5417                 /* KVM_EXIT_FAIL_ENTRY */
5418                 struct {
5419                         __u64 hardware_entry_failure_reason;
5420                         __u32 cpu; /* if KVM_LAST_CPU */
5421                 } fail_entry;
5422
5423 If exit_reason is KVM_EXIT_FAIL_ENTRY, the vcpu could not be run due
5424 to unknown reasons.  Further architecture-specific information is
5425 available in hardware_entry_failure_reason.
5426
5427 ::
5428
5429                 /* KVM_EXIT_EXCEPTION */
5430                 struct {
5431                         __u32 exception;
5432                         __u32 error_code;
5433                 } ex;
5434
5435 Unused.
5436
5437 ::
5438
5439                 /* KVM_EXIT_IO */
5440                 struct {
5441   #define KVM_EXIT_IO_IN  0
5442   #define KVM_EXIT_IO_OUT 1
5443                         __u8 direction;
5444                         __u8 size; /* bytes */
5445                         __u16 port;
5446                         __u32 count;
5447                         __u64 data_offset; /* relative to kvm_run start */
5448                 } io;
5449
5450 If exit_reason is KVM_EXIT_IO, then the vcpu has
5451 executed a port I/O instruction which could not be satisfied by kvm.
5452 data_offset describes where the data is located (KVM_EXIT_IO_OUT) or
5453 where kvm expects application code to place the data for the next
5454 KVM_RUN invocation (KVM_EXIT_IO_IN).  Data format is a packed array.
5455
5456 ::
5457
5458                 /* KVM_EXIT_DEBUG */
5459                 struct {
5460                         struct kvm_debug_exit_arch arch;
5461                 } debug;
5462
5463 If the exit_reason is KVM_EXIT_DEBUG, then a vcpu is processing a debug event
5464 for which architecture specific information is returned.
5465
5466 ::
5467
5468                 /* KVM_EXIT_MMIO */
5469                 struct {
5470                         __u64 phys_addr;
5471                         __u8  data[8];
5472                         __u32 len;
5473                         __u8  is_write;
5474                 } mmio;
5475
5476 If exit_reason is KVM_EXIT_MMIO, then the vcpu has
5477 executed a memory-mapped I/O instruction which could not be satisfied
5478 by kvm.  The 'data' member contains the written data if 'is_write' is
5479 true, and should be filled by application code otherwise.
5480
5481 The 'data' member contains, in its first 'len' bytes, the value as it would
5482 appear if the VCPU performed a load or store of the appropriate width directly
5483 to the byte array.
5484
5485 .. note::
5486
5487       For KVM_EXIT_IO, KVM_EXIT_MMIO, KVM_EXIT_OSI, KVM_EXIT_PAPR, KVM_EXIT_XEN,
5488       KVM_EXIT_EPR, KVM_EXIT_X86_RDMSR and KVM_EXIT_X86_WRMSR the corresponding
5489       operations are complete (and guest state is consistent) only after userspace
5490       has re-entered the kernel with KVM_RUN.  The kernel side will first finish
5491       incomplete operations and then check for pending signals.
5492
5493       The pending state of the operation is not preserved in state which is
5494       visible to userspace, thus userspace should ensure that the operation is
5495       completed before performing a live migration.  Userspace can re-enter the
5496       guest with an unmasked signal pending or with the immediate_exit field set
5497       to complete pending operations without allowing any further instructions
5498       to be executed.
5499
5500 ::
5501
5502                 /* KVM_EXIT_HYPERCALL */
5503                 struct {
5504                         __u64 nr;
5505                         __u64 args[6];
5506                         __u64 ret;
5507                         __u32 longmode;
5508                         __u32 pad;
5509                 } hypercall;
5510
5511 Unused.  This was once used for 'hypercall to userspace'.  To implement
5512 such functionality, use KVM_EXIT_IO (x86) or KVM_EXIT_MMIO (all except s390).
5513
5514 .. note:: KVM_EXIT_IO is significantly faster than KVM_EXIT_MMIO.
5515
5516 ::
5517
5518                 /* KVM_EXIT_TPR_ACCESS */
5519                 struct {
5520                         __u64 rip;
5521                         __u32 is_write;
5522                         __u32 pad;
5523                 } tpr_access;
5524
5525 To be documented (KVM_TPR_ACCESS_REPORTING).
5526
5527 ::
5528
5529                 /* KVM_EXIT_S390_SIEIC */
5530                 struct {
5531                         __u8 icptcode;
5532                         __u64 mask; /* psw upper half */
5533                         __u64 addr; /* psw lower half */
5534                         __u16 ipa;
5535                         __u32 ipb;
5536                 } s390_sieic;
5537
5538 s390 specific.
5539
5540 ::
5541
5542                 /* KVM_EXIT_S390_RESET */
5543   #define KVM_S390_RESET_POR       1
5544   #define KVM_S390_RESET_CLEAR     2
5545   #define KVM_S390_RESET_SUBSYSTEM 4
5546   #define KVM_S390_RESET_CPU_INIT  8
5547   #define KVM_S390_RESET_IPL       16
5548                 __u64 s390_reset_flags;
5549
5550 s390 specific.
5551
5552 ::
5553
5554                 /* KVM_EXIT_S390_UCONTROL */
5555                 struct {
5556                         __u64 trans_exc_code;
5557                         __u32 pgm_code;
5558                 } s390_ucontrol;
5559
5560 s390 specific. A page fault has occurred for a user controlled virtual
5561 machine (KVM_VM_S390_UNCONTROL) on it's host page table that cannot be
5562 resolved by the kernel.
5563 The program code and the translation exception code that were placed
5564 in the cpu's lowcore are presented here as defined by the z Architecture
5565 Principles of Operation Book in the Chapter for Dynamic Address Translation
5566 (DAT)
5567
5568 ::
5569
5570                 /* KVM_EXIT_DCR */
5571                 struct {
5572                         __u32 dcrn;
5573                         __u32 data;
5574                         __u8  is_write;
5575                 } dcr;
5576
5577 Deprecated - was used for 440 KVM.
5578
5579 ::
5580
5581                 /* KVM_EXIT_OSI */
5582                 struct {
5583                         __u64 gprs[32];
5584                 } osi;
5585
5586 MOL uses a special hypercall interface it calls 'OSI'. To enable it, we catch
5587 hypercalls and exit with this exit struct that contains all the guest gprs.
5588
5589 If exit_reason is KVM_EXIT_OSI, then the vcpu has triggered such a hypercall.
5590 Userspace can now handle the hypercall and when it's done modify the gprs as
5591 necessary. Upon guest entry all guest GPRs will then be replaced by the values
5592 in this struct.
5593
5594 ::
5595
5596                 /* KVM_EXIT_PAPR_HCALL */
5597                 struct {
5598                         __u64 nr;
5599                         __u64 ret;
5600                         __u64 args[9];
5601                 } papr_hcall;
5602
5603 This is used on 64-bit PowerPC when emulating a pSeries partition,
5604 e.g. with the 'pseries' machine type in qemu.  It occurs when the
5605 guest does a hypercall using the 'sc 1' instruction.  The 'nr' field
5606 contains the hypercall number (from the guest R3), and 'args' contains
5607 the arguments (from the guest R4 - R12).  Userspace should put the
5608 return code in 'ret' and any extra returned values in args[].
5609 The possible hypercalls are defined in the Power Architecture Platform
5610 Requirements (PAPR) document available from www.power.org (free
5611 developer registration required to access it).
5612
5613 ::
5614
5615                 /* KVM_EXIT_S390_TSCH */
5616                 struct {
5617                         __u16 subchannel_id;
5618                         __u16 subchannel_nr;
5619                         __u32 io_int_parm;
5620                         __u32 io_int_word;
5621                         __u32 ipb;
5622                         __u8 dequeued;
5623                 } s390_tsch;
5624
5625 s390 specific. This exit occurs when KVM_CAP_S390_CSS_SUPPORT has been enabled
5626 and TEST SUBCHANNEL was intercepted. If dequeued is set, a pending I/O
5627 interrupt for the target subchannel has been dequeued and subchannel_id,
5628 subchannel_nr, io_int_parm and io_int_word contain the parameters for that
5629 interrupt. ipb is needed for instruction parameter decoding.
5630
5631 ::
5632
5633                 /* KVM_EXIT_EPR */
5634                 struct {
5635                         __u32 epr;
5636                 } epr;
5637
5638 On FSL BookE PowerPC chips, the interrupt controller has a fast patch
5639 interrupt acknowledge path to the core. When the core successfully
5640 delivers an interrupt, it automatically populates the EPR register with
5641 the interrupt vector number and acknowledges the interrupt inside
5642 the interrupt controller.
5643
5644 In case the interrupt controller lives in user space, we need to do
5645 the interrupt acknowledge cycle through it to fetch the next to be
5646 delivered interrupt vector using this exit.
5647
5648 It gets triggered whenever both KVM_CAP_PPC_EPR are enabled and an
5649 external interrupt has just been delivered into the guest. User space
5650 should put the acknowledged interrupt vector into the 'epr' field.
5651
5652 ::
5653
5654                 /* KVM_EXIT_SYSTEM_EVENT */
5655                 struct {
5656   #define KVM_SYSTEM_EVENT_SHUTDOWN       1
5657   #define KVM_SYSTEM_EVENT_RESET          2
5658   #define KVM_SYSTEM_EVENT_CRASH          3
5659                         __u32 type;
5660                         __u64 flags;
5661                 } system_event;
5662
5663 If exit_reason is KVM_EXIT_SYSTEM_EVENT then the vcpu has triggered
5664 a system-level event using some architecture specific mechanism (hypercall
5665 or some special instruction). In case of ARM/ARM64, this is triggered using
5666 HVC instruction based PSCI call from the vcpu. The 'type' field describes
5667 the system-level event type. The 'flags' field describes architecture
5668 specific flags for the system-level event.
5669
5670 Valid values for 'type' are:
5671
5672  - KVM_SYSTEM_EVENT_SHUTDOWN -- the guest has requested a shutdown of the
5673    VM. Userspace is not obliged to honour this, and if it does honour
5674    this does not need to destroy the VM synchronously (ie it may call
5675    KVM_RUN again before shutdown finally occurs).
5676  - KVM_SYSTEM_EVENT_RESET -- the guest has requested a reset of the VM.
5677    As with SHUTDOWN, userspace can choose to ignore the request, or
5678    to schedule the reset to occur in the future and may call KVM_RUN again.
5679  - KVM_SYSTEM_EVENT_CRASH -- the guest crash occurred and the guest
5680    has requested a crash condition maintenance. Userspace can choose
5681    to ignore the request, or to gather VM memory core dump and/or
5682    reset/shutdown of the VM.
5683
5684 ::
5685
5686                 /* KVM_EXIT_IOAPIC_EOI */
5687                 struct {
5688                         __u8 vector;
5689                 } eoi;
5690
5691 Indicates that the VCPU's in-kernel local APIC received an EOI for a
5692 level-triggered IOAPIC interrupt.  This exit only triggers when the
5693 IOAPIC is implemented in userspace (i.e. KVM_CAP_SPLIT_IRQCHIP is enabled);
5694 the userspace IOAPIC should process the EOI and retrigger the interrupt if
5695 it is still asserted.  Vector is the LAPIC interrupt vector for which the
5696 EOI was received.
5697
5698 ::
5699
5700                 struct kvm_hyperv_exit {
5701   #define KVM_EXIT_HYPERV_SYNIC          1
5702   #define KVM_EXIT_HYPERV_HCALL          2
5703   #define KVM_EXIT_HYPERV_SYNDBG         3
5704                         __u32 type;
5705                         __u32 pad1;
5706                         union {
5707                                 struct {
5708                                         __u32 msr;
5709                                         __u32 pad2;
5710                                         __u64 control;
5711                                         __u64 evt_page;
5712                                         __u64 msg_page;
5713                                 } synic;
5714                                 struct {
5715                                         __u64 input;
5716                                         __u64 result;
5717                                         __u64 params[2];
5718                                 } hcall;
5719                                 struct {
5720                                         __u32 msr;
5721                                         __u32 pad2;
5722                                         __u64 control;
5723                                         __u64 status;
5724                                         __u64 send_page;
5725                                         __u64 recv_page;
5726                                         __u64 pending_page;
5727                                 } syndbg;
5728                         } u;
5729                 };
5730                 /* KVM_EXIT_HYPERV */
5731                 struct kvm_hyperv_exit hyperv;
5732
5733 Indicates that the VCPU exits into userspace to process some tasks
5734 related to Hyper-V emulation.
5735
5736 Valid values for 'type' are:
5737
5738         - KVM_EXIT_HYPERV_SYNIC -- synchronously notify user-space about
5739
5740 Hyper-V SynIC state change. Notification is used to remap SynIC
5741 event/message pages and to enable/disable SynIC messages/events processing
5742 in userspace.
5743
5744         - KVM_EXIT_HYPERV_SYNDBG -- synchronously notify user-space about
5745
5746 Hyper-V Synthetic debugger state change. Notification is used to either update
5747 the pending_page location or to send a control command (send the buffer located
5748 in send_page or recv a buffer to recv_page).
5749
5750 ::
5751
5752                 /* KVM_EXIT_ARM_NISV */
5753                 struct {
5754                         __u64 esr_iss;
5755                         __u64 fault_ipa;
5756                 } arm_nisv;
5757
5758 Used on arm and arm64 systems. If a guest accesses memory not in a memslot,
5759 KVM will typically return to userspace and ask it to do MMIO emulation on its
5760 behalf. However, for certain classes of instructions, no instruction decode
5761 (direction, length of memory access) is provided, and fetching and decoding
5762 the instruction from the VM is overly complicated to live in the kernel.
5763
5764 Historically, when this situation occurred, KVM would print a warning and kill
5765 the VM. KVM assumed that if the guest accessed non-memslot memory, it was
5766 trying to do I/O, which just couldn't be emulated, and the warning message was
5767 phrased accordingly. However, what happened more often was that a guest bug
5768 caused access outside the guest memory areas which should lead to a more
5769 meaningful warning message and an external abort in the guest, if the access
5770 did not fall within an I/O window.
5771
5772 Userspace implementations can query for KVM_CAP_ARM_NISV_TO_USER, and enable
5773 this capability at VM creation. Once this is done, these types of errors will
5774 instead return to userspace with KVM_EXIT_ARM_NISV, with the valid bits from
5775 the HSR (arm) and ESR_EL2 (arm64) in the esr_iss field, and the faulting IPA
5776 in the fault_ipa field. Userspace can either fix up the access if it's
5777 actually an I/O access by decoding the instruction from guest memory (if it's
5778 very brave) and continue executing the guest, or it can decide to suspend,
5779 dump, or restart the guest.
5780
5781 Note that KVM does not skip the faulting instruction as it does for
5782 KVM_EXIT_MMIO, but userspace has to emulate any change to the processing state
5783 if it decides to decode and emulate the instruction.
5784
5785 ::
5786
5787                 /* KVM_EXIT_X86_RDMSR / KVM_EXIT_X86_WRMSR */
5788                 struct {
5789                         __u8 error; /* user -> kernel */
5790                         __u8 pad[7];
5791                         __u32 reason; /* kernel -> user */
5792                         __u32 index; /* kernel -> user */
5793                         __u64 data; /* kernel <-> user */
5794                 } msr;
5795
5796 Used on x86 systems. When the VM capability KVM_CAP_X86_USER_SPACE_MSR is
5797 enabled, MSR accesses to registers that would invoke a #GP by KVM kernel code
5798 will instead trigger a KVM_EXIT_X86_RDMSR exit for reads and KVM_EXIT_X86_WRMSR
5799 exit for writes.
5800
5801 The "reason" field specifies why the MSR trap occurred. User space will only
5802 receive MSR exit traps when a particular reason was requested during through
5803 ENABLE_CAP. Currently valid exit reasons are:
5804
5805         KVM_MSR_EXIT_REASON_UNKNOWN - access to MSR that is unknown to KVM
5806         KVM_MSR_EXIT_REASON_INVAL - access to invalid MSRs or reserved bits
5807         KVM_MSR_EXIT_REASON_FILTER - access blocked by KVM_X86_SET_MSR_FILTER
5808
5809 For KVM_EXIT_X86_RDMSR, the "index" field tells user space which MSR the guest
5810 wants to read. To respond to this request with a successful read, user space
5811 writes the respective data into the "data" field and must continue guest
5812 execution to ensure the read data is transferred into guest register state.
5813
5814 If the RDMSR request was unsuccessful, user space indicates that with a "1" in
5815 the "error" field. This will inject a #GP into the guest when the VCPU is
5816 executed again.
5817
5818 For KVM_EXIT_X86_WRMSR, the "index" field tells user space which MSR the guest
5819 wants to write. Once finished processing the event, user space must continue
5820 vCPU execution. If the MSR write was unsuccessful, user space also sets the
5821 "error" field to "1".
5822
5823 ::
5824
5825
5826                 struct kvm_xen_exit {
5827   #define KVM_EXIT_XEN_HCALL          1
5828                         __u32 type;
5829                         union {
5830                                 struct {
5831                                         __u32 longmode;
5832                                         __u32 cpl;
5833                                         __u64 input;
5834                                         __u64 result;
5835                                         __u64 params[6];
5836                                 } hcall;
5837                         } u;
5838                 };
5839                 /* KVM_EXIT_XEN */
5840                 struct kvm_hyperv_exit xen;
5841
5842 Indicates that the VCPU exits into userspace to process some tasks
5843 related to Xen emulation.
5844
5845 Valid values for 'type' are:
5846
5847   - KVM_EXIT_XEN_HCALL -- synchronously notify user-space about Xen hypercall.
5848     Userspace is expected to place the hypercall result into the appropriate
5849     field before invoking KVM_RUN again.
5850
5851 ::
5852
5853                 /* Fix the size of the union. */
5854                 char padding[256];
5855         };
5856
5857         /*
5858          * shared registers between kvm and userspace.
5859          * kvm_valid_regs specifies the register classes set by the host
5860          * kvm_dirty_regs specified the register classes dirtied by userspace
5861          * struct kvm_sync_regs is architecture specific, as well as the
5862          * bits for kvm_valid_regs and kvm_dirty_regs
5863          */
5864         __u64 kvm_valid_regs;
5865         __u64 kvm_dirty_regs;
5866         union {
5867                 struct kvm_sync_regs regs;
5868                 char padding[SYNC_REGS_SIZE_BYTES];
5869         } s;
5870
5871 If KVM_CAP_SYNC_REGS is defined, these fields allow userspace to access
5872 certain guest registers without having to call SET/GET_*REGS. Thus we can
5873 avoid some system call overhead if userspace has to handle the exit.
5874 Userspace can query the validity of the structure by checking
5875 kvm_valid_regs for specific bits. These bits are architecture specific
5876 and usually define the validity of a groups of registers. (e.g. one bit
5877 for general purpose registers)
5878
5879 Please note that the kernel is allowed to use the kvm_run structure as the
5880 primary storage for certain register types. Therefore, the kernel may use the
5881 values in kvm_run even if the corresponding bit in kvm_dirty_regs is not set.
5882
5883 ::
5884
5885   };
5886
5887
5888
5889 6. Capabilities that can be enabled on vCPUs
5890 ============================================
5891
5892 There are certain capabilities that change the behavior of the virtual CPU or
5893 the virtual machine when enabled. To enable them, please see section 4.37.
5894 Below you can find a list of capabilities and what their effect on the vCPU or
5895 the virtual machine is when enabling them.
5896
5897 The following information is provided along with the description:
5898
5899   Architectures:
5900       which instruction set architectures provide this ioctl.
5901       x86 includes both i386 and x86_64.
5902
5903   Target:
5904       whether this is a per-vcpu or per-vm capability.
5905
5906   Parameters:
5907       what parameters are accepted by the capability.
5908
5909   Returns:
5910       the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
5911       are not detailed, but errors with specific meanings are.
5912
5913
5914 6.1 KVM_CAP_PPC_OSI
5915 -------------------
5916
5917 :Architectures: ppc
5918 :Target: vcpu
5919 :Parameters: none
5920 :Returns: 0 on success; -1 on error
5921
5922 This capability enables interception of OSI hypercalls that otherwise would
5923 be treated as normal system calls to be injected into the guest. OSI hypercalls
5924 were invented by Mac-on-Linux to have a standardized communication mechanism
5925 between the guest and the host.
5926
5927 When this capability is enabled, KVM_EXIT_OSI can occur.
5928
5929
5930 6.2 KVM_CAP_PPC_PAPR
5931 --------------------
5932
5933 :Architectures: ppc
5934 :Target: vcpu
5935 :Parameters: none
5936 :Returns: 0 on success; -1 on error
5937
5938 This capability enables interception of PAPR hypercalls. PAPR hypercalls are
5939 done using the hypercall instruction "sc 1".
5940
5941 It also sets the guest privilege level to "supervisor" mode. Usually the guest
5942 runs in "hypervisor" privilege mode with a few missing features.
5943
5944 In addition to the above, it changes the semantics of SDR1. In this mode, the
5945 HTAB address part of SDR1 contains an HVA instead of a GPA, as PAPR keeps the
5946 HTAB invisible to the guest.
5947
5948 When this capability is enabled, KVM_EXIT_PAPR_HCALL can occur.
5949
5950
5951 6.3 KVM_CAP_SW_TLB
5952 ------------------
5953
5954 :Architectures: ppc
5955 :Target: vcpu
5956 :Parameters: args[0] is the address of a struct kvm_config_tlb
5957 :Returns: 0 on success; -1 on error
5958
5959 ::
5960
5961   struct kvm_config_tlb {
5962         __u64 params;
5963         __u64 array;
5964         __u32 mmu_type;
5965         __u32 array_len;
5966   };
5967
5968 Configures the virtual CPU's TLB array, establishing a shared memory area
5969 between userspace and KVM.  The "params" and "array" fields are userspace
5970 addresses of mmu-type-specific data structures.  The "array_len" field is an
5971 safety mechanism, and should be set to the size in bytes of the memory that
5972 userspace has reserved for the array.  It must be at least the size dictated
5973 by "mmu_type" and "params".
5974
5975 While KVM_RUN is active, the shared region is under control of KVM.  Its
5976 contents are undefined, and any modification by userspace results in
5977 boundedly undefined behavior.
5978
5979 On return from KVM_RUN, the shared region will reflect the current state of
5980 the guest's TLB.  If userspace makes any changes, it must call KVM_DIRTY_TLB
5981 to tell KVM which entries have been changed, prior to calling KVM_RUN again
5982 on this vcpu.
5983
5984 For mmu types KVM_MMU_FSL_BOOKE_NOHV and KVM_MMU_FSL_BOOKE_HV:
5985
5986  - The "params" field is of type "struct kvm_book3e_206_tlb_params".
5987  - The "array" field points to an array of type "struct
5988    kvm_book3e_206_tlb_entry".
5989  - The array consists of all entries in the first TLB, followed by all
5990    entries in the second TLB.
5991  - Within a TLB, entries are ordered first by increasing set number.  Within a
5992    set, entries are ordered by way (increasing ESEL).
5993  - The hash for determining set number in TLB0 is: (MAS2 >> 12) & (num_sets - 1)
5994    where "num_sets" is the tlb_sizes[] value divided by the tlb_ways[] value.
5995  - The tsize field of mas1 shall be set to 4K on TLB0, even though the
5996    hardware ignores this value for TLB0.
5997
5998 6.4 KVM_CAP_S390_CSS_SUPPORT
5999 ----------------------------
6000
6001 :Architectures: s390
6002 :Target: vcpu
6003 :Parameters: none
6004 :Returns: 0 on success; -1 on error
6005
6006 This capability enables support for handling of channel I/O instructions.
6007
6008 TEST PENDING INTERRUPTION and the interrupt portion of TEST SUBCHANNEL are
6009 handled in-kernel, while the other I/O instructions are passed to userspace.
6010
6011 When this capability is enabled, KVM_EXIT_S390_TSCH will occur on TEST
6012 SUBCHANNEL intercepts.
6013
6014 Note that even though this capability is enabled per-vcpu, the complete
6015 virtual machine is affected.
6016
6017 6.5 KVM_CAP_PPC_EPR
6018 -------------------
6019
6020 :Architectures: ppc
6021 :Target: vcpu
6022 :Parameters: args[0] defines whether the proxy facility is active
6023 :Returns: 0 on success; -1 on error
6024
6025 This capability enables or disables the delivery of interrupts through the
6026 external proxy facility.
6027
6028 When enabled (args[0] != 0), every time the guest gets an external interrupt
6029 delivered, it automatically exits into user space with a KVM_EXIT_EPR exit
6030 to receive the topmost interrupt vector.
6031
6032 When disabled (args[0] == 0), behavior is as if this facility is unsupported.
6033
6034 When this capability is enabled, KVM_EXIT_EPR can occur.
6035
6036 6.6 KVM_CAP_IRQ_MPIC
6037 --------------------
6038
6039 :Architectures: ppc
6040 :Parameters: args[0] is the MPIC device fd;
6041              args[1] is the MPIC CPU number for this vcpu
6042
6043 This capability connects the vcpu to an in-kernel MPIC device.
6044
6045 6.7 KVM_CAP_IRQ_XICS
6046 --------------------
6047
6048 :Architectures: ppc
6049 :Target: vcpu
6050 :Parameters: args[0] is the XICS device fd;
6051              args[1] is the XICS CPU number (server ID) for this vcpu
6052
6053 This capability connects the vcpu to an in-kernel XICS device.
6054
6055 6.8 KVM_CAP_S390_IRQCHIP
6056 ------------------------
6057
6058 :Architectures: s390
6059 :Target: vm
6060 :Parameters: none
6061
6062 This capability enables the in-kernel irqchip for s390. Please refer to
6063 "4.24 KVM_CREATE_IRQCHIP" for details.
6064
6065 6.9 KVM_CAP_MIPS_FPU
6066 --------------------
6067
6068 :Architectures: mips
6069 :Target: vcpu
6070 :Parameters: args[0] is reserved for future use (should be 0).
6071
6072 This capability allows the use of the host Floating Point Unit by the guest. It
6073 allows the Config1.FP bit to be set to enable the FPU in the guest. Once this is
6074 done the ``KVM_REG_MIPS_FPR_*`` and ``KVM_REG_MIPS_FCR_*`` registers can be
6075 accessed (depending on the current guest FPU register mode), and the Status.FR,
6076 Config5.FRE bits are accessible via the KVM API and also from the guest,
6077 depending on them being supported by the FPU.
6078
6079 6.10 KVM_CAP_MIPS_MSA
6080 ---------------------
6081
6082 :Architectures: mips
6083 :Target: vcpu
6084 :Parameters: args[0] is reserved for future use (should be 0).
6085
6086 This capability allows the use of the MIPS SIMD Architecture (MSA) by the guest.
6087 It allows the Config3.MSAP bit to be set to enable the use of MSA by the guest.
6088 Once this is done the ``KVM_REG_MIPS_VEC_*`` and ``KVM_REG_MIPS_MSA_*``
6089 registers can be accessed, and the Config5.MSAEn bit is accessible via the
6090 KVM API and also from the guest.
6091
6092 6.74 KVM_CAP_SYNC_REGS
6093 ----------------------
6094
6095 :Architectures: s390, x86
6096 :Target: s390: always enabled, x86: vcpu
6097 :Parameters: none
6098 :Returns: x86: KVM_CHECK_EXTENSION returns a bit-array indicating which register
6099           sets are supported
6100           (bitfields defined in arch/x86/include/uapi/asm/kvm.h).
6101
6102 As described above in the kvm_sync_regs struct info in section 5 (kvm_run):
6103 KVM_CAP_SYNC_REGS "allow[s] userspace to access certain guest registers
6104 without having to call SET/GET_*REGS". This reduces overhead by eliminating
6105 repeated ioctl calls for setting and/or getting register values. This is
6106 particularly important when userspace is making synchronous guest state
6107 modifications, e.g. when emulating and/or intercepting instructions in
6108 userspace.
6109
6110 For s390 specifics, please refer to the source code.
6111
6112 For x86:
6113
6114 - the register sets to be copied out to kvm_run are selectable
6115   by userspace (rather that all sets being copied out for every exit).
6116 - vcpu_events are available in addition to regs and sregs.
6117
6118 For x86, the 'kvm_valid_regs' field of struct kvm_run is overloaded to
6119 function as an input bit-array field set by userspace to indicate the
6120 specific register sets to be copied out on the next exit.
6121
6122 To indicate when userspace has modified values that should be copied into
6123 the vCPU, the all architecture bitarray field, 'kvm_dirty_regs' must be set.
6124 This is done using the same bitflags as for the 'kvm_valid_regs' field.
6125 If the dirty bit is not set, then the register set values will not be copied
6126 into the vCPU even if they've been modified.
6127
6128 Unused bitfields in the bitarrays must be set to zero.
6129
6130 ::
6131
6132   struct kvm_sync_regs {
6133         struct kvm_regs regs;
6134         struct kvm_sregs sregs;
6135         struct kvm_vcpu_events events;
6136   };
6137
6138 6.75 KVM_CAP_PPC_IRQ_XIVE
6139 -------------------------
6140
6141 :Architectures: ppc
6142 :Target: vcpu
6143 :Parameters: args[0] is the XIVE device fd;
6144              args[1] is the XIVE CPU number (server ID) for this vcpu
6145
6146 This capability connects the vcpu to an in-kernel XIVE device.
6147
6148 7. Capabilities that can be enabled on VMs
6149 ==========================================
6150
6151 There are certain capabilities that change the behavior of the virtual
6152 machine when enabled. To enable them, please see section 4.37. Below
6153 you can find a list of capabilities and what their effect on the VM
6154 is when enabling them.
6155
6156 The following information is provided along with the description:
6157
6158   Architectures:
6159       which instruction set architectures provide this ioctl.
6160       x86 includes both i386 and x86_64.
6161
6162   Parameters:
6163       what parameters are accepted by the capability.
6164
6165   Returns:
6166       the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
6167       are not detailed, but errors with specific meanings are.
6168
6169
6170 7.1 KVM_CAP_PPC_ENABLE_HCALL
6171 ----------------------------
6172
6173 :Architectures: ppc
6174 :Parameters: args[0] is the sPAPR hcall number;
6175              args[1] is 0 to disable, 1 to enable in-kernel handling
6176
6177 This capability controls whether individual sPAPR hypercalls (hcalls)
6178 get handled by the kernel or not.  Enabling or disabling in-kernel
6179 handling of an hcall is effective across the VM.  On creation, an
6180 initial set of hcalls are enabled for in-kernel handling, which
6181 consists of those hcalls for which in-kernel handlers were implemented
6182 before this capability was implemented.  If disabled, the kernel will
6183 not to attempt to handle the hcall, but will always exit to userspace
6184 to handle it.  Note that it may not make sense to enable some and
6185 disable others of a group of related hcalls, but KVM does not prevent
6186 userspace from doing that.
6187
6188 If the hcall number specified is not one that has an in-kernel
6189 implementation, the KVM_ENABLE_CAP ioctl will fail with an EINVAL
6190 error.
6191
6192 7.2 KVM_CAP_S390_USER_SIGP
6193 --------------------------
6194
6195 :Architectures: s390
6196 :Parameters: none
6197
6198 This capability controls which SIGP orders will be handled completely in user
6199 space. With this capability enabled, all fast orders will be handled completely
6200 in the kernel:
6201
6202 - SENSE
6203 - SENSE RUNNING
6204 - EXTERNAL CALL
6205 - EMERGENCY SIGNAL
6206 - CONDITIONAL EMERGENCY SIGNAL
6207
6208 All other orders will be handled completely in user space.
6209
6210 Only privileged operation exceptions will be checked for in the kernel (or even
6211 in the hardware prior to interception). If this capability is not enabled, the
6212 old way of handling SIGP orders is used (partially in kernel and user space).
6213
6214 7.3 KVM_CAP_S390_VECTOR_REGISTERS
6215 ---------------------------------
6216
6217 :Architectures: s390
6218 :Parameters: none
6219 :Returns: 0 on success, negative value on error
6220
6221 Allows use of the vector registers introduced with z13 processor, and
6222 provides for the synchronization between host and user space.  Will
6223 return -EINVAL if the machine does not support vectors.
6224
6225 7.4 KVM_CAP_S390_USER_STSI
6226 --------------------------
6227
6228 :Architectures: s390
6229 :Parameters: none
6230
6231 This capability allows post-handlers for the STSI instruction. After
6232 initial handling in the kernel, KVM exits to user space with
6233 KVM_EXIT_S390_STSI to allow user space to insert further data.
6234
6235 Before exiting to userspace, kvm handlers should fill in s390_stsi field of
6236 vcpu->run::
6237
6238   struct {
6239         __u64 addr;
6240         __u8 ar;
6241         __u8 reserved;
6242         __u8 fc;
6243         __u8 sel1;
6244         __u16 sel2;
6245   } s390_stsi;
6246
6247   @addr - guest address of STSI SYSIB
6248   @fc   - function code
6249   @sel1 - selector 1
6250   @sel2 - selector 2
6251   @ar   - access register number
6252
6253 KVM handlers should exit to userspace with rc = -EREMOTE.
6254
6255 7.5 KVM_CAP_SPLIT_IRQCHIP
6256 -------------------------
6257
6258 :Architectures: x86
6259 :Parameters: args[0] - number of routes reserved for userspace IOAPICs
6260 :Returns: 0 on success, -1 on error
6261
6262 Create a local apic for each processor in the kernel. This can be used
6263 instead of KVM_CREATE_IRQCHIP if the userspace VMM wishes to emulate the
6264 IOAPIC and PIC (and also the PIT, even though this has to be enabled
6265 separately).
6266
6267 This capability also enables in kernel routing of interrupt requests;
6268 when KVM_CAP_SPLIT_IRQCHIP only routes of KVM_IRQ_ROUTING_MSI type are
6269 used in the IRQ routing table.  The first args[0] MSI routes are reserved
6270 for the IOAPIC pins.  Whenever the LAPIC receives an EOI for these routes,
6271 a KVM_EXIT_IOAPIC_EOI vmexit will be reported to userspace.
6272
6273 Fails if VCPU has already been created, or if the irqchip is already in the
6274 kernel (i.e. KVM_CREATE_IRQCHIP has already been called).
6275
6276 7.6 KVM_CAP_S390_RI
6277 -------------------
6278
6279 :Architectures: s390
6280 :Parameters: none
6281
6282 Allows use of runtime-instrumentation introduced with zEC12 processor.
6283 Will return -EINVAL if the machine does not support runtime-instrumentation.
6284 Will return -EBUSY if a VCPU has already been created.
6285
6286 7.7 KVM_CAP_X2APIC_API
6287 ----------------------
6288
6289 :Architectures: x86
6290 :Parameters: args[0] - features that should be enabled
6291 :Returns: 0 on success, -EINVAL when args[0] contains invalid features
6292
6293 Valid feature flags in args[0] are::
6294
6295   #define KVM_X2APIC_API_USE_32BIT_IDS            (1ULL << 0)
6296   #define KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK  (1ULL << 1)
6297
6298 Enabling KVM_X2APIC_API_USE_32BIT_IDS changes the behavior of
6299 KVM_SET_GSI_ROUTING, KVM_SIGNAL_MSI, KVM_SET_LAPIC, and KVM_GET_LAPIC,
6300 allowing the use of 32-bit APIC IDs.  See KVM_CAP_X2APIC_API in their
6301 respective sections.
6302
6303 KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK must be enabled for x2APIC to work
6304 in logical mode or with more than 255 VCPUs.  Otherwise, KVM treats 0xff
6305 as a broadcast even in x2APIC mode in order to support physical x2APIC
6306 without interrupt remapping.  This is undesirable in logical mode,
6307 where 0xff represents CPUs 0-7 in cluster 0.
6308
6309 7.8 KVM_CAP_S390_USER_INSTR0
6310 ----------------------------
6311
6312 :Architectures: s390
6313 :Parameters: none
6314
6315 With this capability enabled, all illegal instructions 0x0000 (2 bytes) will
6316 be intercepted and forwarded to user space. User space can use this
6317 mechanism e.g. to realize 2-byte software breakpoints. The kernel will
6318 not inject an operating exception for these instructions, user space has
6319 to take care of that.
6320
6321 This capability can be enabled dynamically even if VCPUs were already
6322 created and are running.
6323
6324 7.9 KVM_CAP_S390_GS
6325 -------------------
6326
6327 :Architectures: s390
6328 :Parameters: none
6329 :Returns: 0 on success; -EINVAL if the machine does not support
6330           guarded storage; -EBUSY if a VCPU has already been created.
6331
6332 Allows use of guarded storage for the KVM guest.
6333
6334 7.10 KVM_CAP_S390_AIS
6335 ---------------------
6336
6337 :Architectures: s390
6338 :Parameters: none
6339
6340 Allow use of adapter-interruption suppression.
6341 :Returns: 0 on success; -EBUSY if a VCPU has already been created.
6342
6343 7.11 KVM_CAP_PPC_SMT
6344 --------------------
6345
6346 :Architectures: ppc
6347 :Parameters: vsmt_mode, flags
6348
6349 Enabling this capability on a VM provides userspace with a way to set
6350 the desired virtual SMT mode (i.e. the number of virtual CPUs per
6351 virtual core).  The virtual SMT mode, vsmt_mode, must be a power of 2
6352 between 1 and 8.  On POWER8, vsmt_mode must also be no greater than
6353 the number of threads per subcore for the host.  Currently flags must
6354 be 0.  A successful call to enable this capability will result in
6355 vsmt_mode being returned when the KVM_CAP_PPC_SMT capability is
6356 subsequently queried for the VM.  This capability is only supported by
6357 HV KVM, and can only be set before any VCPUs have been created.
6358 The KVM_CAP_PPC_SMT_POSSIBLE capability indicates which virtual SMT
6359 modes are available.
6360
6361 7.12 KVM_CAP_PPC_FWNMI
6362 ----------------------
6363
6364 :Architectures: ppc
6365 :Parameters: none
6366
6367 With this capability a machine check exception in the guest address
6368 space will cause KVM to exit the guest with NMI exit reason. This
6369 enables QEMU to build error log and branch to guest kernel registered
6370 machine check handling routine. Without this capability KVM will
6371 branch to guests' 0x200 interrupt vector.
6372
6373 7.13 KVM_CAP_X86_DISABLE_EXITS
6374 ------------------------------
6375
6376 :Architectures: x86
6377 :Parameters: args[0] defines which exits are disabled
6378 :Returns: 0 on success, -EINVAL when args[0] contains invalid exits
6379
6380 Valid bits in args[0] are::
6381
6382   #define KVM_X86_DISABLE_EXITS_MWAIT            (1 << 0)
6383   #define KVM_X86_DISABLE_EXITS_HLT              (1 << 1)
6384   #define KVM_X86_DISABLE_EXITS_PAUSE            (1 << 2)
6385   #define KVM_X86_DISABLE_EXITS_CSTATE           (1 << 3)
6386
6387 Enabling this capability on a VM provides userspace with a way to no
6388 longer intercept some instructions for improved latency in some
6389 workloads, and is suggested when vCPUs are associated to dedicated
6390 physical CPUs.  More bits can be added in the future; userspace can
6391 just pass the KVM_CHECK_EXTENSION result to KVM_ENABLE_CAP to disable
6392 all such vmexits.
6393
6394 Do not enable KVM_FEATURE_PV_UNHALT if you disable HLT exits.
6395
6396 7.14 KVM_CAP_S390_HPAGE_1M
6397 --------------------------
6398
6399 :Architectures: s390
6400 :Parameters: none
6401 :Returns: 0 on success, -EINVAL if hpage module parameter was not set
6402           or cmma is enabled, or the VM has the KVM_VM_S390_UCONTROL
6403           flag set
6404
6405 With this capability the KVM support for memory backing with 1m pages
6406 through hugetlbfs can be enabled for a VM. After the capability is
6407 enabled, cmma can't be enabled anymore and pfmfi and the storage key
6408 interpretation are disabled. If cmma has already been enabled or the
6409 hpage module parameter is not set to 1, -EINVAL is returned.
6410
6411 While it is generally possible to create a huge page backed VM without
6412 this capability, the VM will not be able to run.
6413
6414 7.15 KVM_CAP_MSR_PLATFORM_INFO
6415 ------------------------------
6416
6417 :Architectures: x86
6418 :Parameters: args[0] whether feature should be enabled or not
6419
6420 With this capability, a guest may read the MSR_PLATFORM_INFO MSR. Otherwise,
6421 a #GP would be raised when the guest tries to access. Currently, this
6422 capability does not enable write permissions of this MSR for the guest.
6423
6424 7.16 KVM_CAP_PPC_NESTED_HV
6425 --------------------------
6426
6427 :Architectures: ppc
6428 :Parameters: none
6429 :Returns: 0 on success, -EINVAL when the implementation doesn't support
6430           nested-HV virtualization.
6431
6432 HV-KVM on POWER9 and later systems allows for "nested-HV"
6433 virtualization, which provides a way for a guest VM to run guests that
6434 can run using the CPU's supervisor mode (privileged non-hypervisor
6435 state).  Enabling this capability on a VM depends on the CPU having
6436 the necessary functionality and on the facility being enabled with a
6437 kvm-hv module parameter.
6438
6439 7.17 KVM_CAP_EXCEPTION_PAYLOAD
6440 ------------------------------
6441
6442 :Architectures: x86
6443 :Parameters: args[0] whether feature should be enabled or not
6444
6445 With this capability enabled, CR2 will not be modified prior to the
6446 emulated VM-exit when L1 intercepts a #PF exception that occurs in
6447 L2. Similarly, for kvm-intel only, DR6 will not be modified prior to
6448 the emulated VM-exit when L1 intercepts a #DB exception that occurs in
6449 L2. As a result, when KVM_GET_VCPU_EVENTS reports a pending #PF (or
6450 #DB) exception for L2, exception.has_payload will be set and the
6451 faulting address (or the new DR6 bits*) will be reported in the
6452 exception_payload field. Similarly, when userspace injects a #PF (or
6453 #DB) into L2 using KVM_SET_VCPU_EVENTS, it is expected to set
6454 exception.has_payload and to put the faulting address - or the new DR6
6455 bits\ [#]_ - in the exception_payload field.
6456
6457 This capability also enables exception.pending in struct
6458 kvm_vcpu_events, which allows userspace to distinguish between pending
6459 and injected exceptions.
6460
6461
6462 .. [#] For the new DR6 bits, note that bit 16 is set iff the #DB exception
6463        will clear DR6.RTM.
6464
6465 7.18 KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
6466
6467 :Architectures: x86, arm, arm64, mips
6468 :Parameters: args[0] whether feature should be enabled or not
6469
6470 Valid flags are::
6471
6472   #define KVM_DIRTY_LOG_MANUAL_PROTECT_ENABLE   (1 << 0)
6473   #define KVM_DIRTY_LOG_INITIALLY_SET           (1 << 1)
6474
6475 With KVM_DIRTY_LOG_MANUAL_PROTECT_ENABLE is set, KVM_GET_DIRTY_LOG will not
6476 automatically clear and write-protect all pages that are returned as dirty.
6477 Rather, userspace will have to do this operation separately using
6478 KVM_CLEAR_DIRTY_LOG.
6479
6480 At the cost of a slightly more complicated operation, this provides better
6481 scalability and responsiveness for two reasons.  First,
6482 KVM_CLEAR_DIRTY_LOG ioctl can operate on a 64-page granularity rather
6483 than requiring to sync a full memslot; this ensures that KVM does not
6484 take spinlocks for an extended period of time.  Second, in some cases a
6485 large amount of time can pass between a call to KVM_GET_DIRTY_LOG and
6486 userspace actually using the data in the page.  Pages can be modified
6487 during this time, which is inefficient for both the guest and userspace:
6488 the guest will incur a higher penalty due to write protection faults,
6489 while userspace can see false reports of dirty pages.  Manual reprotection
6490 helps reducing this time, improving guest performance and reducing the
6491 number of dirty log false positives.
6492
6493 With KVM_DIRTY_LOG_INITIALLY_SET set, all the bits of the dirty bitmap
6494 will be initialized to 1 when created.  This also improves performance because
6495 dirty logging can be enabled gradually in small chunks on the first call
6496 to KVM_CLEAR_DIRTY_LOG.  KVM_DIRTY_LOG_INITIALLY_SET depends on
6497 KVM_DIRTY_LOG_MANUAL_PROTECT_ENABLE (it is also only available on
6498 x86 and arm64 for now).
6499
6500 KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 was previously available under the name
6501 KVM_CAP_MANUAL_DIRTY_LOG_PROTECT, but the implementation had bugs that make
6502 it hard or impossible to use it correctly.  The availability of
6503 KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 signals that those bugs are fixed.
6504 Userspace should not try to use KVM_CAP_MANUAL_DIRTY_LOG_PROTECT.
6505
6506 7.19 KVM_CAP_PPC_SECURE_GUEST
6507 ------------------------------
6508
6509 :Architectures: ppc
6510
6511 This capability indicates that KVM is running on a host that has
6512 ultravisor firmware and thus can support a secure guest.  On such a
6513 system, a guest can ask the ultravisor to make it a secure guest,
6514 one whose memory is inaccessible to the host except for pages which
6515 are explicitly requested to be shared with the host.  The ultravisor
6516 notifies KVM when a guest requests to become a secure guest, and KVM
6517 has the opportunity to veto the transition.
6518
6519 If present, this capability can be enabled for a VM, meaning that KVM
6520 will allow the transition to secure guest mode.  Otherwise KVM will
6521 veto the transition.
6522
6523 7.20 KVM_CAP_HALT_POLL
6524 ----------------------
6525
6526 :Architectures: all
6527 :Target: VM
6528 :Parameters: args[0] is the maximum poll time in nanoseconds
6529 :Returns: 0 on success; -1 on error
6530
6531 This capability overrides the kvm module parameter halt_poll_ns for the
6532 target VM.
6533
6534 VCPU polling allows a VCPU to poll for wakeup events instead of immediately
6535 scheduling during guest halts. The maximum time a VCPU can spend polling is
6536 controlled by the kvm module parameter halt_poll_ns. This capability allows
6537 the maximum halt time to specified on a per-VM basis, effectively overriding
6538 the module parameter for the target VM.
6539
6540 7.21 KVM_CAP_X86_USER_SPACE_MSR
6541 -------------------------------
6542
6543 :Architectures: x86
6544 :Target: VM
6545 :Parameters: args[0] contains the mask of KVM_MSR_EXIT_REASON_* events to report
6546 :Returns: 0 on success; -1 on error
6547
6548 This capability enables trapping of #GP invoking RDMSR and WRMSR instructions
6549 into user space.
6550
6551 When a guest requests to read or write an MSR, KVM may not implement all MSRs
6552 that are relevant to a respective system. It also does not differentiate by
6553 CPU type.
6554
6555 To allow more fine grained control over MSR handling, user space may enable
6556 this capability. With it enabled, MSR accesses that match the mask specified in
6557 args[0] and trigger a #GP event inside the guest by KVM will instead trigger
6558 KVM_EXIT_X86_RDMSR and KVM_EXIT_X86_WRMSR exit notifications which user space
6559 can then handle to implement model specific MSR handling and/or user notifications
6560 to inform a user that an MSR was not handled.
6561
6562 7.22 KVM_CAP_X86_BUS_LOCK_EXIT
6563 -------------------------------
6564
6565 :Architectures: x86
6566 :Target: VM
6567 :Parameters: args[0] defines the policy used when bus locks detected in guest
6568 :Returns: 0 on success, -EINVAL when args[0] contains invalid bits
6569
6570 Valid bits in args[0] are::
6571
6572   #define KVM_BUS_LOCK_DETECTION_OFF      (1 << 0)
6573   #define KVM_BUS_LOCK_DETECTION_EXIT     (1 << 1)
6574
6575 Enabling this capability on a VM provides userspace with a way to select
6576 a policy to handle the bus locks detected in guest. Userspace can obtain
6577 the supported modes from the result of KVM_CHECK_EXTENSION and define it
6578 through the KVM_ENABLE_CAP.
6579
6580 KVM_BUS_LOCK_DETECTION_OFF and KVM_BUS_LOCK_DETECTION_EXIT are supported
6581 currently and mutually exclusive with each other. More bits can be added in
6582 the future.
6583
6584 With KVM_BUS_LOCK_DETECTION_OFF set, bus locks in guest will not cause vm exits
6585 so that no additional actions are needed. This is the default mode.
6586
6587 With KVM_BUS_LOCK_DETECTION_EXIT set, vm exits happen when bus lock detected
6588 in VM. KVM just exits to userspace when handling them. Userspace can enforce
6589 its own throttling or other policy based mitigations.
6590
6591 This capability is aimed to address the thread that VM can exploit bus locks to
6592 degree the performance of the whole system. Once the userspace enable this
6593 capability and select the KVM_BUS_LOCK_DETECTION_EXIT mode, KVM will set the
6594 KVM_RUN_BUS_LOCK flag in vcpu-run->flags field and exit to userspace. Concerning
6595 the bus lock vm exit can be preempted by a higher priority VM exit, the exit
6596 notifications to userspace can be KVM_EXIT_BUS_LOCK or other reasons.
6597 KVM_RUN_BUS_LOCK flag is used to distinguish between them.
6598
6599 7.23 KVM_CAP_PPC_DAWR1
6600 ----------------------
6601
6602 :Architectures: ppc
6603 :Parameters: none
6604 :Returns: 0 on success, -EINVAL when CPU doesn't support 2nd DAWR
6605
6606 This capability can be used to check / enable 2nd DAWR feature provided
6607 by POWER10 processor.
6608
6609
6610 7.24 KVM_CAP_VM_COPY_ENC_CONTEXT_FROM
6611 -------------------------------------
6612
6613 Architectures: x86 SEV enabled
6614 Type: vm
6615 Parameters: args[0] is the fd of the source vm
6616 Returns: 0 on success; ENOTTY on error
6617
6618 This capability enables userspace to copy encryption context from the vm
6619 indicated by the fd to the vm this is called on.
6620
6621 This is intended to support in-guest workloads scheduled by the host. This
6622 allows the in-guest workload to maintain its own NPTs and keeps the two vms
6623 from accidentally clobbering each other with interrupts and the like (separate
6624 APIC/MSRs/etc).
6625
6626 7.25 KVM_CAP_SGX_ATTRIBUTE
6627 --------------------------
6628
6629 :Architectures: x86
6630 :Target: VM
6631 :Parameters: args[0] is a file handle of a SGX attribute file in securityfs
6632 :Returns: 0 on success, -EINVAL if the file handle is invalid or if a requested
6633           attribute is not supported by KVM.
6634
6635 KVM_CAP_SGX_ATTRIBUTE enables a userspace VMM to grant a VM access to one or
6636 more priveleged enclave attributes.  args[0] must hold a file handle to a valid
6637 SGX attribute file corresponding to an attribute that is supported/restricted
6638 by KVM (currently only PROVISIONKEY).
6639
6640 The SGX subsystem restricts access to a subset of enclave attributes to provide
6641 additional security for an uncompromised kernel, e.g. use of the PROVISIONKEY
6642 is restricted to deter malware from using the PROVISIONKEY to obtain a stable
6643 system fingerprint.  To prevent userspace from circumventing such restrictions
6644 by running an enclave in a VM, KVM prevents access to privileged attributes by
6645 default.
6646
6647 See Documentation/x86/sgx.rst for more details.
6648
6649 7.26 KVM_CAP_PPC_RPT_INVALIDATE
6650 -------------------------------
6651
6652 :Capability: KVM_CAP_PPC_RPT_INVALIDATE
6653 :Architectures: ppc
6654 :Type: vm
6655
6656 This capability indicates that the kernel is capable of handling
6657 H_RPT_INVALIDATE hcall.
6658
6659 In order to enable the use of H_RPT_INVALIDATE in the guest,
6660 user space might have to advertise it for the guest. For example,
6661 IBM pSeries (sPAPR) guest starts using it if "hcall-rpt-invalidate" is
6662 present in the "ibm,hypertas-functions" device-tree property.
6663
6664 This capability is enabled for hypervisors on platforms like POWER9
6665 that support radix MMU.
6666
6667 7.27 KVM_CAP_EXIT_ON_EMULATION_FAILURE
6668 --------------------------------------
6669
6670 :Architectures: x86
6671 :Parameters: args[0] whether the feature should be enabled or not
6672
6673 When this capability is enabled, an emulation failure will result in an exit
6674 to userspace with KVM_INTERNAL_ERROR (except when the emulator was invoked
6675 to handle a VMware backdoor instruction). Furthermore, KVM will now provide up
6676 to 15 instruction bytes for any exit to userspace resulting from an emulation
6677 failure.  When these exits to userspace occur use the emulation_failure struct
6678 instead of the internal struct.  They both have the same layout, but the
6679 emulation_failure struct matches the content better.  It also explicitly
6680 defines the 'flags' field which is used to describe the fields in the struct
6681 that are valid (ie: if KVM_INTERNAL_ERROR_EMULATION_FLAG_INSTRUCTION_BYTES is
6682 set in the 'flags' field then both 'insn_size' and 'insn_bytes' have valid data
6683 in them.)
6684
6685 7.28 KVM_CAP_ARM_MTE
6686 --------------------
6687
6688 :Architectures: arm64
6689 :Parameters: none
6690
6691 This capability indicates that KVM (and the hardware) supports exposing the
6692 Memory Tagging Extensions (MTE) to the guest. It must also be enabled by the
6693 VMM before creating any VCPUs to allow the guest access. Note that MTE is only
6694 available to a guest running in AArch64 mode and enabling this capability will
6695 cause attempts to create AArch32 VCPUs to fail.
6696
6697 When enabled the guest is able to access tags associated with any memory given
6698 to the guest. KVM will ensure that the tags are maintained during swap or
6699 hibernation of the host; however the VMM needs to manually save/restore the
6700 tags as appropriate if the VM is migrated.
6701
6702 When this capability is enabled all memory in memslots must be mapped as
6703 not-shareable (no MAP_SHARED), attempts to create a memslot with a
6704 MAP_SHARED mmap will result in an -EINVAL return.
6705
6706 When enabled the VMM may make use of the ``KVM_ARM_MTE_COPY_TAGS`` ioctl to
6707 perform a bulk copy of tags to/from the guest.
6708
6709 8. Other capabilities.
6710 ======================
6711
6712 This section lists capabilities that give information about other
6713 features of the KVM implementation.
6714
6715 8.1 KVM_CAP_PPC_HWRNG
6716 ---------------------
6717
6718 :Architectures: ppc
6719
6720 This capability, if KVM_CHECK_EXTENSION indicates that it is
6721 available, means that the kernel has an implementation of the
6722 H_RANDOM hypercall backed by a hardware random-number generator.
6723 If present, the kernel H_RANDOM handler can be enabled for guest use
6724 with the KVM_CAP_PPC_ENABLE_HCALL capability.
6725
6726 8.2 KVM_CAP_HYPERV_SYNIC
6727 ------------------------
6728
6729 :Architectures: x86
6730
6731 This capability, if KVM_CHECK_EXTENSION indicates that it is
6732 available, means that the kernel has an implementation of the
6733 Hyper-V Synthetic interrupt controller(SynIC). Hyper-V SynIC is
6734 used to support Windows Hyper-V based guest paravirt drivers(VMBus).
6735
6736 In order to use SynIC, it has to be activated by setting this
6737 capability via KVM_ENABLE_CAP ioctl on the vcpu fd. Note that this
6738 will disable the use of APIC hardware virtualization even if supported
6739 by the CPU, as it's incompatible with SynIC auto-EOI behavior.
6740
6741 8.3 KVM_CAP_PPC_RADIX_MMU
6742 -------------------------
6743
6744 :Architectures: ppc
6745
6746 This capability, if KVM_CHECK_EXTENSION indicates that it is
6747 available, means that the kernel can support guests using the
6748 radix MMU defined in Power ISA V3.00 (as implemented in the POWER9
6749 processor).
6750
6751 8.4 KVM_CAP_PPC_HASH_MMU_V3
6752 ---------------------------
6753
6754 :Architectures: ppc
6755
6756 This capability, if KVM_CHECK_EXTENSION indicates that it is
6757 available, means that the kernel can support guests using the
6758 hashed page table MMU defined in Power ISA V3.00 (as implemented in
6759 the POWER9 processor), including in-memory segment tables.
6760
6761 8.5 KVM_CAP_MIPS_VZ
6762 -------------------
6763
6764 :Architectures: mips
6765
6766 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
6767 it is available, means that full hardware assisted virtualization capabilities
6768 of the hardware are available for use through KVM. An appropriate
6769 KVM_VM_MIPS_* type must be passed to KVM_CREATE_VM to create a VM which
6770 utilises it.
6771
6772 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
6773 available, it means that the VM is using full hardware assisted virtualization
6774 capabilities of the hardware. This is useful to check after creating a VM with
6775 KVM_VM_MIPS_DEFAULT.
6776
6777 The value returned by KVM_CHECK_EXTENSION should be compared against known
6778 values (see below). All other values are reserved. This is to allow for the
6779 possibility of other hardware assisted virtualization implementations which
6780 may be incompatible with the MIPS VZ ASE.
6781
6782 ==  ==========================================================================
6783  0  The trap & emulate implementation is in use to run guest code in user
6784     mode. Guest virtual memory segments are rearranged to fit the guest in the
6785     user mode address space.
6786
6787  1  The MIPS VZ ASE is in use, providing full hardware assisted
6788     virtualization, including standard guest virtual memory segments.
6789 ==  ==========================================================================
6790
6791 8.6 KVM_CAP_MIPS_TE
6792 -------------------
6793
6794 :Architectures: mips
6795
6796 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
6797 it is available, means that the trap & emulate implementation is available to
6798 run guest code in user mode, even if KVM_CAP_MIPS_VZ indicates that hardware
6799 assisted virtualisation is also available. KVM_VM_MIPS_TE (0) must be passed
6800 to KVM_CREATE_VM to create a VM which utilises it.
6801
6802 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
6803 available, it means that the VM is using trap & emulate.
6804
6805 8.7 KVM_CAP_MIPS_64BIT
6806 ----------------------
6807
6808 :Architectures: mips
6809
6810 This capability indicates the supported architecture type of the guest, i.e. the
6811 supported register and address width.
6812
6813 The values returned when this capability is checked by KVM_CHECK_EXTENSION on a
6814 kvm VM handle correspond roughly to the CP0_Config.AT register field, and should
6815 be checked specifically against known values (see below). All other values are
6816 reserved.
6817
6818 ==  ========================================================================
6819  0  MIPS32 or microMIPS32.
6820     Both registers and addresses are 32-bits wide.
6821     It will only be possible to run 32-bit guest code.
6822
6823  1  MIPS64 or microMIPS64 with access only to 32-bit compatibility segments.
6824     Registers are 64-bits wide, but addresses are 32-bits wide.
6825     64-bit guest code may run but cannot access MIPS64 memory segments.
6826     It will also be possible to run 32-bit guest code.
6827
6828  2  MIPS64 or microMIPS64 with access to all address segments.
6829     Both registers and addresses are 64-bits wide.
6830     It will be possible to run 64-bit or 32-bit guest code.
6831 ==  ========================================================================
6832
6833 8.9 KVM_CAP_ARM_USER_IRQ
6834 ------------------------
6835
6836 :Architectures: arm, arm64
6837
6838 This capability, if KVM_CHECK_EXTENSION indicates that it is available, means
6839 that if userspace creates a VM without an in-kernel interrupt controller, it
6840 will be notified of changes to the output level of in-kernel emulated devices,
6841 which can generate virtual interrupts, presented to the VM.
6842 For such VMs, on every return to userspace, the kernel
6843 updates the vcpu's run->s.regs.device_irq_level field to represent the actual
6844 output level of the device.
6845
6846 Whenever kvm detects a change in the device output level, kvm guarantees at
6847 least one return to userspace before running the VM.  This exit could either
6848 be a KVM_EXIT_INTR or any other exit event, like KVM_EXIT_MMIO. This way,
6849 userspace can always sample the device output level and re-compute the state of
6850 the userspace interrupt controller.  Userspace should always check the state
6851 of run->s.regs.device_irq_level on every kvm exit.
6852 The value in run->s.regs.device_irq_level can represent both level and edge
6853 triggered interrupt signals, depending on the device.  Edge triggered interrupt
6854 signals will exit to userspace with the bit in run->s.regs.device_irq_level
6855 set exactly once per edge signal.
6856
6857 The field run->s.regs.device_irq_level is available independent of
6858 run->kvm_valid_regs or run->kvm_dirty_regs bits.
6859
6860 If KVM_CAP_ARM_USER_IRQ is supported, the KVM_CHECK_EXTENSION ioctl returns a
6861 number larger than 0 indicating the version of this capability is implemented
6862 and thereby which bits in run->s.regs.device_irq_level can signal values.
6863
6864 Currently the following bits are defined for the device_irq_level bitmap::
6865
6866   KVM_CAP_ARM_USER_IRQ >= 1:
6867
6868     KVM_ARM_DEV_EL1_VTIMER -  EL1 virtual timer
6869     KVM_ARM_DEV_EL1_PTIMER -  EL1 physical timer
6870     KVM_ARM_DEV_PMU        -  ARM PMU overflow interrupt signal
6871
6872 Future versions of kvm may implement additional events. These will get
6873 indicated by returning a higher number from KVM_CHECK_EXTENSION and will be
6874 listed above.
6875
6876 8.10 KVM_CAP_PPC_SMT_POSSIBLE
6877 -----------------------------
6878
6879 :Architectures: ppc
6880
6881 Querying this capability returns a bitmap indicating the possible
6882 virtual SMT modes that can be set using KVM_CAP_PPC_SMT.  If bit N
6883 (counting from the right) is set, then a virtual SMT mode of 2^N is
6884 available.
6885
6886 8.11 KVM_CAP_HYPERV_SYNIC2
6887 --------------------------
6888
6889 :Architectures: x86
6890
6891 This capability enables a newer version of Hyper-V Synthetic interrupt
6892 controller (SynIC).  The only difference with KVM_CAP_HYPERV_SYNIC is that KVM
6893 doesn't clear SynIC message and event flags pages when they are enabled by
6894 writing to the respective MSRs.
6895
6896 8.12 KVM_CAP_HYPERV_VP_INDEX
6897 ----------------------------
6898
6899 :Architectures: x86
6900
6901 This capability indicates that userspace can load HV_X64_MSR_VP_INDEX msr.  Its
6902 value is used to denote the target vcpu for a SynIC interrupt.  For
6903 compatibilty, KVM initializes this msr to KVM's internal vcpu index.  When this
6904 capability is absent, userspace can still query this msr's value.
6905
6906 8.13 KVM_CAP_S390_AIS_MIGRATION
6907 -------------------------------
6908
6909 :Architectures: s390
6910 :Parameters: none
6911
6912 This capability indicates if the flic device will be able to get/set the
6913 AIS states for migration via the KVM_DEV_FLIC_AISM_ALL attribute and allows
6914 to discover this without having to create a flic device.
6915
6916 8.14 KVM_CAP_S390_PSW
6917 ---------------------
6918
6919 :Architectures: s390
6920
6921 This capability indicates that the PSW is exposed via the kvm_run structure.
6922
6923 8.15 KVM_CAP_S390_GMAP
6924 ----------------------
6925
6926 :Architectures: s390
6927
6928 This capability indicates that the user space memory used as guest mapping can
6929 be anywhere in the user memory address space, as long as the memory slots are
6930 aligned and sized to a segment (1MB) boundary.
6931
6932 8.16 KVM_CAP_S390_COW
6933 ---------------------
6934
6935 :Architectures: s390
6936
6937 This capability indicates that the user space memory used as guest mapping can
6938 use copy-on-write semantics as well as dirty pages tracking via read-only page
6939 tables.
6940
6941 8.17 KVM_CAP_S390_BPB
6942 ---------------------
6943
6944 :Architectures: s390
6945
6946 This capability indicates that kvm will implement the interfaces to handle
6947 reset, migration and nested KVM for branch prediction blocking. The stfle
6948 facility 82 should not be provided to the guest without this capability.
6949
6950 8.18 KVM_CAP_HYPERV_TLBFLUSH
6951 ----------------------------
6952
6953 :Architectures: x86
6954
6955 This capability indicates that KVM supports paravirtualized Hyper-V TLB Flush
6956 hypercalls:
6957 HvFlushVirtualAddressSpace, HvFlushVirtualAddressSpaceEx,
6958 HvFlushVirtualAddressList, HvFlushVirtualAddressListEx.
6959
6960 8.19 KVM_CAP_ARM_INJECT_SERROR_ESR
6961 ----------------------------------
6962
6963 :Architectures: arm, arm64
6964
6965 This capability indicates that userspace can specify (via the
6966 KVM_SET_VCPU_EVENTS ioctl) the syndrome value reported to the guest when it
6967 takes a virtual SError interrupt exception.
6968 If KVM advertises this capability, userspace can only specify the ISS field for
6969 the ESR syndrome. Other parts of the ESR, such as the EC are generated by the
6970 CPU when the exception is taken. If this virtual SError is taken to EL1 using
6971 AArch64, this value will be reported in the ISS field of ESR_ELx.
6972
6973 See KVM_CAP_VCPU_EVENTS for more details.
6974
6975 8.20 KVM_CAP_HYPERV_SEND_IPI
6976 ----------------------------
6977
6978 :Architectures: x86
6979
6980 This capability indicates that KVM supports paravirtualized Hyper-V IPI send
6981 hypercalls:
6982 HvCallSendSyntheticClusterIpi, HvCallSendSyntheticClusterIpiEx.
6983
6984 8.21 KVM_CAP_HYPERV_DIRECT_TLBFLUSH
6985 -----------------------------------
6986
6987 :Architectures: x86
6988
6989 This capability indicates that KVM running on top of Hyper-V hypervisor
6990 enables Direct TLB flush for its guests meaning that TLB flush
6991 hypercalls are handled by Level 0 hypervisor (Hyper-V) bypassing KVM.
6992 Due to the different ABI for hypercall parameters between Hyper-V and
6993 KVM, enabling this capability effectively disables all hypercall
6994 handling by KVM (as some KVM hypercall may be mistakenly treated as TLB
6995 flush hypercalls by Hyper-V) so userspace should disable KVM identification
6996 in CPUID and only exposes Hyper-V identification. In this case, guest
6997 thinks it's running on Hyper-V and only use Hyper-V hypercalls.
6998
6999 8.22 KVM_CAP_S390_VCPU_RESETS
7000 -----------------------------
7001
7002 :Architectures: s390
7003
7004 This capability indicates that the KVM_S390_NORMAL_RESET and
7005 KVM_S390_CLEAR_RESET ioctls are available.
7006
7007 8.23 KVM_CAP_S390_PROTECTED
7008 ---------------------------
7009
7010 :Architectures: s390
7011
7012 This capability indicates that the Ultravisor has been initialized and
7013 KVM can therefore start protected VMs.
7014 This capability governs the KVM_S390_PV_COMMAND ioctl and the
7015 KVM_MP_STATE_LOAD MP_STATE. KVM_SET_MP_STATE can fail for protected
7016 guests when the state change is invalid.
7017
7018 8.24 KVM_CAP_STEAL_TIME
7019 -----------------------
7020
7021 :Architectures: arm64, x86
7022
7023 This capability indicates that KVM supports steal time accounting.
7024 When steal time accounting is supported it may be enabled with
7025 architecture-specific interfaces.  This capability and the architecture-
7026 specific interfaces must be consistent, i.e. if one says the feature
7027 is supported, than the other should as well and vice versa.  For arm64
7028 see Documentation/virt/kvm/devices/vcpu.rst "KVM_ARM_VCPU_PVTIME_CTRL".
7029 For x86 see Documentation/virt/kvm/msr.rst "MSR_KVM_STEAL_TIME".
7030
7031 8.25 KVM_CAP_S390_DIAG318
7032 -------------------------
7033
7034 :Architectures: s390
7035
7036 This capability enables a guest to set information about its control program
7037 (i.e. guest kernel type and version). The information is helpful during
7038 system/firmware service events, providing additional data about the guest
7039 environments running on the machine.
7040
7041 The information is associated with the DIAGNOSE 0x318 instruction, which sets
7042 an 8-byte value consisting of a one-byte Control Program Name Code (CPNC) and
7043 a 7-byte Control Program Version Code (CPVC). The CPNC determines what
7044 environment the control program is running in (e.g. Linux, z/VM...), and the
7045 CPVC is used for information specific to OS (e.g. Linux version, Linux
7046 distribution...)
7047
7048 If this capability is available, then the CPNC and CPVC can be synchronized
7049 between KVM and userspace via the sync regs mechanism (KVM_SYNC_DIAG318).
7050
7051 8.26 KVM_CAP_X86_USER_SPACE_MSR
7052 -------------------------------
7053
7054 :Architectures: x86
7055
7056 This capability indicates that KVM supports deflection of MSR reads and
7057 writes to user space. It can be enabled on a VM level. If enabled, MSR
7058 accesses that would usually trigger a #GP by KVM into the guest will
7059 instead get bounced to user space through the KVM_EXIT_X86_RDMSR and
7060 KVM_EXIT_X86_WRMSR exit notifications.
7061
7062 8.27 KVM_CAP_X86_MSR_FILTER
7063 ---------------------------
7064
7065 :Architectures: x86
7066
7067 This capability indicates that KVM supports that accesses to user defined MSRs
7068 may be rejected. With this capability exposed, KVM exports new VM ioctl
7069 KVM_X86_SET_MSR_FILTER which user space can call to specify bitmaps of MSR
7070 ranges that KVM should reject access to.
7071
7072 In combination with KVM_CAP_X86_USER_SPACE_MSR, this allows user space to
7073 trap and emulate MSRs that are outside of the scope of KVM as well as
7074 limit the attack surface on KVM's MSR emulation code.
7075
7076 8.28 KVM_CAP_ENFORCE_PV_FEATURE_CPUID
7077 -----------------------------
7078
7079 Architectures: x86
7080
7081 When enabled, KVM will disable paravirtual features provided to the
7082 guest according to the bits in the KVM_CPUID_FEATURES CPUID leaf
7083 (0x40000001). Otherwise, a guest may use the paravirtual features
7084 regardless of what has actually been exposed through the CPUID leaf.
7085
7086 8.29 KVM_CAP_DIRTY_LOG_RING
7087 ---------------------------
7088
7089 :Architectures: x86
7090 :Parameters: args[0] - size of the dirty log ring
7091
7092 KVM is capable of tracking dirty memory using ring buffers that are
7093 mmaped into userspace; there is one dirty ring per vcpu.
7094
7095 The dirty ring is available to userspace as an array of
7096 ``struct kvm_dirty_gfn``.  Each dirty entry it's defined as::
7097
7098   struct kvm_dirty_gfn {
7099           __u32 flags;
7100           __u32 slot; /* as_id | slot_id */
7101           __u64 offset;
7102   };
7103
7104 The following values are defined for the flags field to define the
7105 current state of the entry::
7106
7107   #define KVM_DIRTY_GFN_F_DIRTY           BIT(0)
7108   #define KVM_DIRTY_GFN_F_RESET           BIT(1)
7109   #define KVM_DIRTY_GFN_F_MASK            0x3
7110
7111 Userspace should call KVM_ENABLE_CAP ioctl right after KVM_CREATE_VM
7112 ioctl to enable this capability for the new guest and set the size of
7113 the rings.  Enabling the capability is only allowed before creating any
7114 vCPU, and the size of the ring must be a power of two.  The larger the
7115 ring buffer, the less likely the ring is full and the VM is forced to
7116 exit to userspace. The optimal size depends on the workload, but it is
7117 recommended that it be at least 64 KiB (4096 entries).
7118
7119 Just like for dirty page bitmaps, the buffer tracks writes to
7120 all user memory regions for which the KVM_MEM_LOG_DIRTY_PAGES flag was
7121 set in KVM_SET_USER_MEMORY_REGION.  Once a memory region is registered
7122 with the flag set, userspace can start harvesting dirty pages from the
7123 ring buffer.
7124
7125 An entry in the ring buffer can be unused (flag bits ``00``),
7126 dirty (flag bits ``01``) or harvested (flag bits ``1X``).  The
7127 state machine for the entry is as follows::
7128
7129           dirtied         harvested        reset
7130      00 -----------> 01 -------------> 1X -------+
7131       ^                                          |
7132       |                                          |
7133       +------------------------------------------+
7134
7135 To harvest the dirty pages, userspace accesses the mmaped ring buffer
7136 to read the dirty GFNs.  If the flags has the DIRTY bit set (at this stage
7137 the RESET bit must be cleared), then it means this GFN is a dirty GFN.
7138 The userspace should harvest this GFN and mark the flags from state
7139 ``01b`` to ``1Xb`` (bit 0 will be ignored by KVM, but bit 1 must be set
7140 to show that this GFN is harvested and waiting for a reset), and move
7141 on to the next GFN.  The userspace should continue to do this until the
7142 flags of a GFN have the DIRTY bit cleared, meaning that it has harvested
7143 all the dirty GFNs that were available.
7144
7145 It's not necessary for userspace to harvest the all dirty GFNs at once.
7146 However it must collect the dirty GFNs in sequence, i.e., the userspace
7147 program cannot skip one dirty GFN to collect the one next to it.
7148
7149 After processing one or more entries in the ring buffer, userspace
7150 calls the VM ioctl KVM_RESET_DIRTY_RINGS to notify the kernel about
7151 it, so that the kernel will reprotect those collected GFNs.
7152 Therefore, the ioctl must be called *before* reading the content of
7153 the dirty pages.
7154
7155 The dirty ring can get full.  When it happens, the KVM_RUN of the
7156 vcpu will return with exit reason KVM_EXIT_DIRTY_LOG_FULL.
7157
7158 The dirty ring interface has a major difference comparing to the
7159 KVM_GET_DIRTY_LOG interface in that, when reading the dirty ring from
7160 userspace, it's still possible that the kernel has not yet flushed the
7161 processor's dirty page buffers into the kernel buffer (with dirty bitmaps, the
7162 flushing is done by the KVM_GET_DIRTY_LOG ioctl).  To achieve that, one
7163 needs to kick the vcpu out of KVM_RUN using a signal.  The resulting
7164 vmexit ensures that all dirty GFNs are flushed to the dirty rings.
7165
7166 NOTE: the capability KVM_CAP_DIRTY_LOG_RING and the corresponding
7167 ioctl KVM_RESET_DIRTY_RINGS are mutual exclusive to the existing ioctls
7168 KVM_GET_DIRTY_LOG and KVM_CLEAR_DIRTY_LOG.  After enabling
7169 KVM_CAP_DIRTY_LOG_RING with an acceptable dirty ring size, the virtual
7170 machine will switch to ring-buffer dirty page tracking and further
7171 KVM_GET_DIRTY_LOG or KVM_CLEAR_DIRTY_LOG ioctls will fail.
7172
7173 8.30 KVM_CAP_XEN_HVM
7174 --------------------
7175
7176 :Architectures: x86
7177
7178 This capability indicates the features that Xen supports for hosting Xen
7179 PVHVM guests. Valid flags are::
7180
7181   #define KVM_XEN_HVM_CONFIG_HYPERCALL_MSR      (1 << 0)
7182   #define KVM_XEN_HVM_CONFIG_INTERCEPT_HCALL    (1 << 1)
7183   #define KVM_XEN_HVM_CONFIG_SHARED_INFO        (1 << 2)
7184   #define KVM_XEN_HVM_CONFIG_RUNSTATE           (1 << 2)
7185
7186 The KVM_XEN_HVM_CONFIG_HYPERCALL_MSR flag indicates that the KVM_XEN_HVM_CONFIG
7187 ioctl is available, for the guest to set its hypercall page.
7188
7189 If KVM_XEN_HVM_CONFIG_INTERCEPT_HCALL is also set, the same flag may also be
7190 provided in the flags to KVM_XEN_HVM_CONFIG, without providing hypercall page
7191 contents, to request that KVM generate hypercall page content automatically
7192 and also enable interception of guest hypercalls with KVM_EXIT_XEN.
7193
7194 The KVM_XEN_HVM_CONFIG_SHARED_INFO flag indicates the availability of the
7195 KVM_XEN_HVM_SET_ATTR, KVM_XEN_HVM_GET_ATTR, KVM_XEN_VCPU_SET_ATTR and
7196 KVM_XEN_VCPU_GET_ATTR ioctls, as well as the delivery of exception vectors
7197 for event channel upcalls when the evtchn_upcall_pending field of a vcpu's
7198 vcpu_info is set.
7199
7200 The KVM_XEN_HVM_CONFIG_RUNSTATE flag indicates that the runstate-related
7201 features KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADDR/_CURRENT/_DATA/_ADJUST are
7202 supported by the KVM_XEN_VCPU_SET_ATTR/KVM_XEN_VCPU_GET_ATTR ioctls.
7203
7204 8.31 KVM_CAP_PPC_MULTITCE
7205 -------------------------
7206
7207 :Capability: KVM_CAP_PPC_MULTITCE
7208 :Architectures: ppc
7209 :Type: vm
7210
7211 This capability means the kernel is capable of handling hypercalls
7212 H_PUT_TCE_INDIRECT and H_STUFF_TCE without passing those into the user
7213 space. This significantly accelerates DMA operations for PPC KVM guests.
7214 User space should expect that its handlers for these hypercalls
7215 are not going to be called if user space previously registered LIOBN
7216 in KVM (via KVM_CREATE_SPAPR_TCE or similar calls).
7217
7218 In order to enable H_PUT_TCE_INDIRECT and H_STUFF_TCE use in the guest,
7219 user space might have to advertise it for the guest. For example,
7220 IBM pSeries (sPAPR) guest starts using them if "hcall-multi-tce" is
7221 present in the "ibm,hypertas-functions" device-tree property.
7222
7223 The hypercalls mentioned above may or may not be processed successfully
7224 in the kernel based fast path. If they can not be handled by the kernel,
7225 they will get passed on to user space. So user space still has to have
7226 an implementation for these despite the in kernel acceleration.
7227
7228 This capability is always enabled.
7229
7230 8.32 KVM_CAP_PTP_KVM
7231 --------------------
7232
7233 :Architectures: arm64
7234
7235 This capability indicates that the KVM virtual PTP service is
7236 supported in the host. A VMM can check whether the service is
7237 available to the guest on migration.
7238
7239 8.33 KVM_CAP_HYPERV_ENFORCE_CPUID
7240 ---------------------------------
7241
7242 Architectures: x86
7243
7244 When enabled, KVM will disable emulated Hyper-V features provided to the
7245 guest according to the bits Hyper-V CPUID feature leaves. Otherwise, all
7246 currently implmented Hyper-V features are provided unconditionally when
7247 Hyper-V identification is set in the HYPERV_CPUID_INTERFACE (0x40000001)
7248 leaf.
7249
7250 8.34 KVM_CAP_EXIT_HYPERCALL
7251 ---------------------------
7252
7253 :Capability: KVM_CAP_EXIT_HYPERCALL
7254 :Architectures: x86
7255 :Type: vm
7256
7257 This capability, if enabled, will cause KVM to exit to userspace
7258 with KVM_EXIT_HYPERCALL exit reason to process some hypercalls.
7259
7260 Calling KVM_CHECK_EXTENSION for this capability will return a bitmask
7261 of hypercalls that can be configured to exit to userspace.
7262 Right now, the only such hypercall is KVM_HC_MAP_GPA_RANGE.
7263
7264 The argument to KVM_ENABLE_CAP is also a bitmask, and must be a subset
7265 of the result of KVM_CHECK_EXTENSION.  KVM will forward to userspace
7266 the hypercalls whose corresponding bit is in the argument, and return
7267 ENOSYS for the others.