]> asedeno.scripts.mit.edu Git - linux.git/blob - Documentation/virtual/kvm/api.txt
KVM: MIPS/VZ: Support guest segmentation control
[linux.git] / Documentation / virtual / kvm / api.txt
1 The Definitive KVM (Kernel-based Virtual Machine) API Documentation
2 ===================================================================
3
4 1. General description
5 ----------------------
6
7 The kvm API is a set of ioctls that are issued to control various aspects
8 of a virtual machine.  The ioctls belong to three classes
9
10  - System ioctls: These query and set global attributes which affect the
11    whole kvm subsystem.  In addition a system ioctl is used to create
12    virtual machines
13
14  - VM ioctls: These query and set attributes that affect an entire virtual
15    machine, for example memory layout.  In addition a VM ioctl is used to
16    create virtual cpus (vcpus).
17
18    Only run VM ioctls from the same process (address space) that was used
19    to create the VM.
20
21  - vcpu ioctls: These query and set attributes that control the operation
22    of a single virtual cpu.
23
24    Only run vcpu ioctls from the same thread that was used to create the
25    vcpu.
26
27
28 2. File descriptors
29 -------------------
30
31 The kvm API is centered around file descriptors.  An initial
32 open("/dev/kvm") obtains a handle to the kvm subsystem; this handle
33 can be used to issue system ioctls.  A KVM_CREATE_VM ioctl on this
34 handle will create a VM file descriptor which can be used to issue VM
35 ioctls.  A KVM_CREATE_VCPU ioctl on a VM fd will create a virtual cpu
36 and return a file descriptor pointing to it.  Finally, ioctls on a vcpu
37 fd can be used to control the vcpu, including the important task of
38 actually running guest code.
39
40 In general file descriptors can be migrated among processes by means
41 of fork() and the SCM_RIGHTS facility of unix domain socket.  These
42 kinds of tricks are explicitly not supported by kvm.  While they will
43 not cause harm to the host, their actual behavior is not guaranteed by
44 the API.  The only supported use is one virtual machine per process,
45 and one vcpu per thread.
46
47
48 3. Extensions
49 -------------
50
51 As of Linux 2.6.22, the KVM ABI has been stabilized: no backward
52 incompatible change are allowed.  However, there is an extension
53 facility that allows backward-compatible extensions to the API to be
54 queried and used.
55
56 The extension mechanism is not based on the Linux version number.
57 Instead, kvm defines extension identifiers and a facility to query
58 whether a particular extension identifier is available.  If it is, a
59 set of ioctls is available for application use.
60
61
62 4. API description
63 ------------------
64
65 This section describes ioctls that can be used to control kvm guests.
66 For each ioctl, the following information is provided along with a
67 description:
68
69   Capability: which KVM extension provides this ioctl.  Can be 'basic',
70       which means that is will be provided by any kernel that supports
71       API version 12 (see section 4.1), a KVM_CAP_xyz constant, which
72       means availability needs to be checked with KVM_CHECK_EXTENSION
73       (see section 4.4), or 'none' which means that while not all kernels
74       support this ioctl, there's no capability bit to check its
75       availability: for kernels that don't support the ioctl,
76       the ioctl returns -ENOTTY.
77
78   Architectures: which instruction set architectures provide this ioctl.
79       x86 includes both i386 and x86_64.
80
81   Type: system, vm, or vcpu.
82
83   Parameters: what parameters are accepted by the ioctl.
84
85   Returns: the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
86       are not detailed, but errors with specific meanings are.
87
88
89 4.1 KVM_GET_API_VERSION
90
91 Capability: basic
92 Architectures: all
93 Type: system ioctl
94 Parameters: none
95 Returns: the constant KVM_API_VERSION (=12)
96
97 This identifies the API version as the stable kvm API. It is not
98 expected that this number will change.  However, Linux 2.6.20 and
99 2.6.21 report earlier versions; these are not documented and not
100 supported.  Applications should refuse to run if KVM_GET_API_VERSION
101 returns a value other than 12.  If this check passes, all ioctls
102 described as 'basic' will be available.
103
104
105 4.2 KVM_CREATE_VM
106
107 Capability: basic
108 Architectures: all
109 Type: system ioctl
110 Parameters: machine type identifier (KVM_VM_*)
111 Returns: a VM fd that can be used to control the new virtual machine.
112
113 The new VM has no virtual cpus and no memory.  An mmap() of a VM fd
114 will access the virtual machine's physical address space; offset zero
115 corresponds to guest physical address zero.  Use of mmap() on a VM fd
116 is discouraged if userspace memory allocation (KVM_CAP_USER_MEMORY) is
117 available.
118 You probably want to use 0 as machine type.
119
120 In order to create user controlled virtual machines on S390, check
121 KVM_CAP_S390_UCONTROL and use the flag KVM_VM_S390_UCONTROL as
122 privileged user (CAP_SYS_ADMIN).
123
124 To use hardware assisted virtualization on MIPS (VZ ASE) rather than
125 the default trap & emulate implementation (which changes the virtual
126 memory layout to fit in user mode), check KVM_CAP_MIPS_VZ and use the
127 flag KVM_VM_MIPS_VZ.
128
129
130 4.3 KVM_GET_MSR_INDEX_LIST
131
132 Capability: basic
133 Architectures: x86
134 Type: system
135 Parameters: struct kvm_msr_list (in/out)
136 Returns: 0 on success; -1 on error
137 Errors:
138   E2BIG:     the msr index list is to be to fit in the array specified by
139              the user.
140
141 struct kvm_msr_list {
142         __u32 nmsrs; /* number of msrs in entries */
143         __u32 indices[0];
144 };
145
146 This ioctl returns the guest msrs that are supported.  The list varies
147 by kvm version and host processor, but does not change otherwise.  The
148 user fills in the size of the indices array in nmsrs, and in return
149 kvm adjusts nmsrs to reflect the actual number of msrs and fills in
150 the indices array with their numbers.
151
152 Note: if kvm indicates supports MCE (KVM_CAP_MCE), then the MCE bank MSRs are
153 not returned in the MSR list, as different vcpus can have a different number
154 of banks, as set via the KVM_X86_SETUP_MCE ioctl.
155
156
157 4.4 KVM_CHECK_EXTENSION
158
159 Capability: basic, KVM_CAP_CHECK_EXTENSION_VM for vm ioctl
160 Architectures: all
161 Type: system ioctl, vm ioctl
162 Parameters: extension identifier (KVM_CAP_*)
163 Returns: 0 if unsupported; 1 (or some other positive integer) if supported
164
165 The API allows the application to query about extensions to the core
166 kvm API.  Userspace passes an extension identifier (an integer) and
167 receives an integer that describes the extension availability.
168 Generally 0 means no and 1 means yes, but some extensions may report
169 additional information in the integer return value.
170
171 Based on their initialization different VMs may have different capabilities.
172 It is thus encouraged to use the vm ioctl to query for capabilities (available
173 with KVM_CAP_CHECK_EXTENSION_VM on the vm fd)
174
175 4.5 KVM_GET_VCPU_MMAP_SIZE
176
177 Capability: basic
178 Architectures: all
179 Type: system ioctl
180 Parameters: none
181 Returns: size of vcpu mmap area, in bytes
182
183 The KVM_RUN ioctl (cf.) communicates with userspace via a shared
184 memory region.  This ioctl returns the size of that region.  See the
185 KVM_RUN documentation for details.
186
187
188 4.6 KVM_SET_MEMORY_REGION
189
190 Capability: basic
191 Architectures: all
192 Type: vm ioctl
193 Parameters: struct kvm_memory_region (in)
194 Returns: 0 on success, -1 on error
195
196 This ioctl is obsolete and has been removed.
197
198
199 4.7 KVM_CREATE_VCPU
200
201 Capability: basic
202 Architectures: all
203 Type: vm ioctl
204 Parameters: vcpu id (apic id on x86)
205 Returns: vcpu fd on success, -1 on error
206
207 This API adds a vcpu to a virtual machine. No more than max_vcpus may be added.
208 The vcpu id is an integer in the range [0, max_vcpu_id).
209
210 The recommended max_vcpus value can be retrieved using the KVM_CAP_NR_VCPUS of
211 the KVM_CHECK_EXTENSION ioctl() at run-time.
212 The maximum possible value for max_vcpus can be retrieved using the
213 KVM_CAP_MAX_VCPUS of the KVM_CHECK_EXTENSION ioctl() at run-time.
214
215 If the KVM_CAP_NR_VCPUS does not exist, you should assume that max_vcpus is 4
216 cpus max.
217 If the KVM_CAP_MAX_VCPUS does not exist, you should assume that max_vcpus is
218 same as the value returned from KVM_CAP_NR_VCPUS.
219
220 The maximum possible value for max_vcpu_id can be retrieved using the
221 KVM_CAP_MAX_VCPU_ID of the KVM_CHECK_EXTENSION ioctl() at run-time.
222
223 If the KVM_CAP_MAX_VCPU_ID does not exist, you should assume that max_vcpu_id
224 is the same as the value returned from KVM_CAP_MAX_VCPUS.
225
226 On powerpc using book3s_hv mode, the vcpus are mapped onto virtual
227 threads in one or more virtual CPU cores.  (This is because the
228 hardware requires all the hardware threads in a CPU core to be in the
229 same partition.)  The KVM_CAP_PPC_SMT capability indicates the number
230 of vcpus per virtual core (vcore).  The vcore id is obtained by
231 dividing the vcpu id by the number of vcpus per vcore.  The vcpus in a
232 given vcore will always be in the same physical core as each other
233 (though that might be a different physical core from time to time).
234 Userspace can control the threading (SMT) mode of the guest by its
235 allocation of vcpu ids.  For example, if userspace wants
236 single-threaded guest vcpus, it should make all vcpu ids be a multiple
237 of the number of vcpus per vcore.
238
239 For virtual cpus that have been created with S390 user controlled virtual
240 machines, the resulting vcpu fd can be memory mapped at page offset
241 KVM_S390_SIE_PAGE_OFFSET in order to obtain a memory map of the virtual
242 cpu's hardware control block.
243
244
245 4.8 KVM_GET_DIRTY_LOG (vm ioctl)
246
247 Capability: basic
248 Architectures: x86
249 Type: vm ioctl
250 Parameters: struct kvm_dirty_log (in/out)
251 Returns: 0 on success, -1 on error
252
253 /* for KVM_GET_DIRTY_LOG */
254 struct kvm_dirty_log {
255         __u32 slot;
256         __u32 padding;
257         union {
258                 void __user *dirty_bitmap; /* one bit per page */
259                 __u64 padding;
260         };
261 };
262
263 Given a memory slot, return a bitmap containing any pages dirtied
264 since the last call to this ioctl.  Bit 0 is the first page in the
265 memory slot.  Ensure the entire structure is cleared to avoid padding
266 issues.
267
268 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 specifies
269 the address space for which you want to return the dirty bitmap.
270 They must be less than the value that KVM_CHECK_EXTENSION returns for
271 the KVM_CAP_MULTI_ADDRESS_SPACE capability.
272
273
274 4.9 KVM_SET_MEMORY_ALIAS
275
276 Capability: basic
277 Architectures: x86
278 Type: vm ioctl
279 Parameters: struct kvm_memory_alias (in)
280 Returns: 0 (success), -1 (error)
281
282 This ioctl is obsolete and has been removed.
283
284
285 4.10 KVM_RUN
286
287 Capability: basic
288 Architectures: all
289 Type: vcpu ioctl
290 Parameters: none
291 Returns: 0 on success, -1 on error
292 Errors:
293   EINTR:     an unmasked signal is pending
294
295 This ioctl is used to run a guest virtual cpu.  While there are no
296 explicit parameters, there is an implicit parameter block that can be
297 obtained by mmap()ing the vcpu fd at offset 0, with the size given by
298 KVM_GET_VCPU_MMAP_SIZE.  The parameter block is formatted as a 'struct
299 kvm_run' (see below).
300
301
302 4.11 KVM_GET_REGS
303
304 Capability: basic
305 Architectures: all except ARM, arm64
306 Type: vcpu ioctl
307 Parameters: struct kvm_regs (out)
308 Returns: 0 on success, -1 on error
309
310 Reads the general purpose registers from the vcpu.
311
312 /* x86 */
313 struct kvm_regs {
314         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
315         __u64 rax, rbx, rcx, rdx;
316         __u64 rsi, rdi, rsp, rbp;
317         __u64 r8,  r9,  r10, r11;
318         __u64 r12, r13, r14, r15;
319         __u64 rip, rflags;
320 };
321
322 /* mips */
323 struct kvm_regs {
324         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
325         __u64 gpr[32];
326         __u64 hi;
327         __u64 lo;
328         __u64 pc;
329 };
330
331
332 4.12 KVM_SET_REGS
333
334 Capability: basic
335 Architectures: all except ARM, arm64
336 Type: vcpu ioctl
337 Parameters: struct kvm_regs (in)
338 Returns: 0 on success, -1 on error
339
340 Writes the general purpose registers into the vcpu.
341
342 See KVM_GET_REGS for the data structure.
343
344
345 4.13 KVM_GET_SREGS
346
347 Capability: basic
348 Architectures: x86, ppc
349 Type: vcpu ioctl
350 Parameters: struct kvm_sregs (out)
351 Returns: 0 on success, -1 on error
352
353 Reads special registers from the vcpu.
354
355 /* x86 */
356 struct kvm_sregs {
357         struct kvm_segment cs, ds, es, fs, gs, ss;
358         struct kvm_segment tr, ldt;
359         struct kvm_dtable gdt, idt;
360         __u64 cr0, cr2, cr3, cr4, cr8;
361         __u64 efer;
362         __u64 apic_base;
363         __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
364 };
365
366 /* ppc -- see arch/powerpc/include/uapi/asm/kvm.h */
367
368 interrupt_bitmap is a bitmap of pending external interrupts.  At most
369 one bit may be set.  This interrupt has been acknowledged by the APIC
370 but not yet injected into the cpu core.
371
372
373 4.14 KVM_SET_SREGS
374
375 Capability: basic
376 Architectures: x86, ppc
377 Type: vcpu ioctl
378 Parameters: struct kvm_sregs (in)
379 Returns: 0 on success, -1 on error
380
381 Writes special registers into the vcpu.  See KVM_GET_SREGS for the
382 data structures.
383
384
385 4.15 KVM_TRANSLATE
386
387 Capability: basic
388 Architectures: x86
389 Type: vcpu ioctl
390 Parameters: struct kvm_translation (in/out)
391 Returns: 0 on success, -1 on error
392
393 Translates a virtual address according to the vcpu's current address
394 translation mode.
395
396 struct kvm_translation {
397         /* in */
398         __u64 linear_address;
399
400         /* out */
401         __u64 physical_address;
402         __u8  valid;
403         __u8  writeable;
404         __u8  usermode;
405         __u8  pad[5];
406 };
407
408
409 4.16 KVM_INTERRUPT
410
411 Capability: basic
412 Architectures: x86, ppc, mips
413 Type: vcpu ioctl
414 Parameters: struct kvm_interrupt (in)
415 Returns: 0 on success, negative on failure.
416
417 Queues a hardware interrupt vector to be injected.
418
419 /* for KVM_INTERRUPT */
420 struct kvm_interrupt {
421         /* in */
422         __u32 irq;
423 };
424
425 X86:
426
427 Returns: 0 on success,
428          -EEXIST if an interrupt is already enqueued
429          -EINVAL the the irq number is invalid
430          -ENXIO if the PIC is in the kernel
431          -EFAULT if the pointer is invalid
432
433 Note 'irq' is an interrupt vector, not an interrupt pin or line. This
434 ioctl is useful if the in-kernel PIC is not used.
435
436 PPC:
437
438 Queues an external interrupt to be injected. This ioctl is overleaded
439 with 3 different irq values:
440
441 a) KVM_INTERRUPT_SET
442
443   This injects an edge type external interrupt into the guest once it's ready
444   to receive interrupts. When injected, the interrupt is done.
445
446 b) KVM_INTERRUPT_UNSET
447
448   This unsets any pending interrupt.
449
450   Only available with KVM_CAP_PPC_UNSET_IRQ.
451
452 c) KVM_INTERRUPT_SET_LEVEL
453
454   This injects a level type external interrupt into the guest context. The
455   interrupt stays pending until a specific ioctl with KVM_INTERRUPT_UNSET
456   is triggered.
457
458   Only available with KVM_CAP_PPC_IRQ_LEVEL.
459
460 Note that any value for 'irq' other than the ones stated above is invalid
461 and incurs unexpected behavior.
462
463 MIPS:
464
465 Queues an external interrupt to be injected into the virtual CPU. A negative
466 interrupt number dequeues the interrupt.
467
468
469 4.17 KVM_DEBUG_GUEST
470
471 Capability: basic
472 Architectures: none
473 Type: vcpu ioctl
474 Parameters: none)
475 Returns: -1 on error
476
477 Support for this has been removed.  Use KVM_SET_GUEST_DEBUG instead.
478
479
480 4.18 KVM_GET_MSRS
481
482 Capability: basic
483 Architectures: x86
484 Type: vcpu ioctl
485 Parameters: struct kvm_msrs (in/out)
486 Returns: 0 on success, -1 on error
487
488 Reads model-specific registers from the vcpu.  Supported msr indices can
489 be obtained using KVM_GET_MSR_INDEX_LIST.
490
491 struct kvm_msrs {
492         __u32 nmsrs; /* number of msrs in entries */
493         __u32 pad;
494
495         struct kvm_msr_entry entries[0];
496 };
497
498 struct kvm_msr_entry {
499         __u32 index;
500         __u32 reserved;
501         __u64 data;
502 };
503
504 Application code should set the 'nmsrs' member (which indicates the
505 size of the entries array) and the 'index' member of each array entry.
506 kvm will fill in the 'data' member.
507
508
509 4.19 KVM_SET_MSRS
510
511 Capability: basic
512 Architectures: x86
513 Type: vcpu ioctl
514 Parameters: struct kvm_msrs (in)
515 Returns: 0 on success, -1 on error
516
517 Writes model-specific registers to the vcpu.  See KVM_GET_MSRS for the
518 data structures.
519
520 Application code should set the 'nmsrs' member (which indicates the
521 size of the entries array), and the 'index' and 'data' members of each
522 array entry.
523
524
525 4.20 KVM_SET_CPUID
526
527 Capability: basic
528 Architectures: x86
529 Type: vcpu ioctl
530 Parameters: struct kvm_cpuid (in)
531 Returns: 0 on success, -1 on error
532
533 Defines the vcpu responses to the cpuid instruction.  Applications
534 should use the KVM_SET_CPUID2 ioctl if available.
535
536
537 struct kvm_cpuid_entry {
538         __u32 function;
539         __u32 eax;
540         __u32 ebx;
541         __u32 ecx;
542         __u32 edx;
543         __u32 padding;
544 };
545
546 /* for KVM_SET_CPUID */
547 struct kvm_cpuid {
548         __u32 nent;
549         __u32 padding;
550         struct kvm_cpuid_entry entries[0];
551 };
552
553
554 4.21 KVM_SET_SIGNAL_MASK
555
556 Capability: basic
557 Architectures: all
558 Type: vcpu ioctl
559 Parameters: struct kvm_signal_mask (in)
560 Returns: 0 on success, -1 on error
561
562 Defines which signals are blocked during execution of KVM_RUN.  This
563 signal mask temporarily overrides the threads signal mask.  Any
564 unblocked signal received (except SIGKILL and SIGSTOP, which retain
565 their traditional behaviour) will cause KVM_RUN to return with -EINTR.
566
567 Note the signal will only be delivered if not blocked by the original
568 signal mask.
569
570 /* for KVM_SET_SIGNAL_MASK */
571 struct kvm_signal_mask {
572         __u32 len;
573         __u8  sigset[0];
574 };
575
576
577 4.22 KVM_GET_FPU
578
579 Capability: basic
580 Architectures: x86
581 Type: vcpu ioctl
582 Parameters: struct kvm_fpu (out)
583 Returns: 0 on success, -1 on error
584
585 Reads the floating point state from the vcpu.
586
587 /* for KVM_GET_FPU and KVM_SET_FPU */
588 struct kvm_fpu {
589         __u8  fpr[8][16];
590         __u16 fcw;
591         __u16 fsw;
592         __u8  ftwx;  /* in fxsave format */
593         __u8  pad1;
594         __u16 last_opcode;
595         __u64 last_ip;
596         __u64 last_dp;
597         __u8  xmm[16][16];
598         __u32 mxcsr;
599         __u32 pad2;
600 };
601
602
603 4.23 KVM_SET_FPU
604
605 Capability: basic
606 Architectures: x86
607 Type: vcpu ioctl
608 Parameters: struct kvm_fpu (in)
609 Returns: 0 on success, -1 on error
610
611 Writes the floating point state to the vcpu.
612
613 /* for KVM_GET_FPU and KVM_SET_FPU */
614 struct kvm_fpu {
615         __u8  fpr[8][16];
616         __u16 fcw;
617         __u16 fsw;
618         __u8  ftwx;  /* in fxsave format */
619         __u8  pad1;
620         __u16 last_opcode;
621         __u64 last_ip;
622         __u64 last_dp;
623         __u8  xmm[16][16];
624         __u32 mxcsr;
625         __u32 pad2;
626 };
627
628
629 4.24 KVM_CREATE_IRQCHIP
630
631 Capability: KVM_CAP_IRQCHIP, KVM_CAP_S390_IRQCHIP (s390)
632 Architectures: x86, ARM, arm64, s390
633 Type: vm ioctl
634 Parameters: none
635 Returns: 0 on success, -1 on error
636
637 Creates an interrupt controller model in the kernel.
638 On x86, creates a virtual ioapic, a virtual PIC (two PICs, nested), and sets up
639 future vcpus to have a local APIC.  IRQ routing for GSIs 0-15 is set to both
640 PIC and IOAPIC; GSI 16-23 only go to the IOAPIC.
641 On ARM/arm64, a GICv2 is created. Any other GIC versions require the usage of
642 KVM_CREATE_DEVICE, which also supports creating a GICv2.  Using
643 KVM_CREATE_DEVICE is preferred over KVM_CREATE_IRQCHIP for GICv2.
644 On s390, a dummy irq routing table is created.
645
646 Note that on s390 the KVM_CAP_S390_IRQCHIP vm capability needs to be enabled
647 before KVM_CREATE_IRQCHIP can be used.
648
649
650 4.25 KVM_IRQ_LINE
651
652 Capability: KVM_CAP_IRQCHIP
653 Architectures: x86, arm, arm64
654 Type: vm ioctl
655 Parameters: struct kvm_irq_level
656 Returns: 0 on success, -1 on error
657
658 Sets the level of a GSI input to the interrupt controller model in the kernel.
659 On some architectures it is required that an interrupt controller model has
660 been previously created with KVM_CREATE_IRQCHIP.  Note that edge-triggered
661 interrupts require the level to be set to 1 and then back to 0.
662
663 On real hardware, interrupt pins can be active-low or active-high.  This
664 does not matter for the level field of struct kvm_irq_level: 1 always
665 means active (asserted), 0 means inactive (deasserted).
666
667 x86 allows the operating system to program the interrupt polarity
668 (active-low/active-high) for level-triggered interrupts, and KVM used
669 to consider the polarity.  However, due to bitrot in the handling of
670 active-low interrupts, the above convention is now valid on x86 too.
671 This is signaled by KVM_CAP_X86_IOAPIC_POLARITY_IGNORED.  Userspace
672 should not present interrupts to the guest as active-low unless this
673 capability is present (or unless it is not using the in-kernel irqchip,
674 of course).
675
676
677 ARM/arm64 can signal an interrupt either at the CPU level, or at the
678 in-kernel irqchip (GIC), and for in-kernel irqchip can tell the GIC to
679 use PPIs designated for specific cpus.  The irq field is interpreted
680 like this:
681
682  Â bits:  | 31 ... 24 | 23  ... 16 | 15    ...    0 |
683   field: | irq_type  | vcpu_index |     irq_id     |
684
685 The irq_type field has the following values:
686 - irq_type[0]: out-of-kernel GIC: irq_id 0 is IRQ, irq_id 1 is FIQ
687 - irq_type[1]: in-kernel GIC: SPI, irq_id between 32 and 1019 (incl.)
688                (the vcpu_index field is ignored)
689 - irq_type[2]: in-kernel GIC: PPI, irq_id between 16 and 31 (incl.)
690
691 (The irq_id field thus corresponds nicely to the IRQ ID in the ARM GIC specs)
692
693 In both cases, level is used to assert/deassert the line.
694
695 struct kvm_irq_level {
696         union {
697                 __u32 irq;     /* GSI */
698                 __s32 status;  /* not used for KVM_IRQ_LEVEL */
699         };
700         __u32 level;           /* 0 or 1 */
701 };
702
703
704 4.26 KVM_GET_IRQCHIP
705
706 Capability: KVM_CAP_IRQCHIP
707 Architectures: x86
708 Type: vm ioctl
709 Parameters: struct kvm_irqchip (in/out)
710 Returns: 0 on success, -1 on error
711
712 Reads the state of a kernel interrupt controller created with
713 KVM_CREATE_IRQCHIP into a buffer provided by the caller.
714
715 struct kvm_irqchip {
716         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
717         __u32 pad;
718         union {
719                 char dummy[512];  /* reserving space */
720                 struct kvm_pic_state pic;
721                 struct kvm_ioapic_state ioapic;
722         } chip;
723 };
724
725
726 4.27 KVM_SET_IRQCHIP
727
728 Capability: KVM_CAP_IRQCHIP
729 Architectures: x86
730 Type: vm ioctl
731 Parameters: struct kvm_irqchip (in)
732 Returns: 0 on success, -1 on error
733
734 Sets the state of a kernel interrupt controller created with
735 KVM_CREATE_IRQCHIP from a buffer provided by the caller.
736
737 struct kvm_irqchip {
738         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
739         __u32 pad;
740         union {
741                 char dummy[512];  /* reserving space */
742                 struct kvm_pic_state pic;
743                 struct kvm_ioapic_state ioapic;
744         } chip;
745 };
746
747
748 4.28 KVM_XEN_HVM_CONFIG
749
750 Capability: KVM_CAP_XEN_HVM
751 Architectures: x86
752 Type: vm ioctl
753 Parameters: struct kvm_xen_hvm_config (in)
754 Returns: 0 on success, -1 on error
755
756 Sets the MSR that the Xen HVM guest uses to initialize its hypercall
757 page, and provides the starting address and size of the hypercall
758 blobs in userspace.  When the guest writes the MSR, kvm copies one
759 page of a blob (32- or 64-bit, depending on the vcpu mode) to guest
760 memory.
761
762 struct kvm_xen_hvm_config {
763         __u32 flags;
764         __u32 msr;
765         __u64 blob_addr_32;
766         __u64 blob_addr_64;
767         __u8 blob_size_32;
768         __u8 blob_size_64;
769         __u8 pad2[30];
770 };
771
772
773 4.29 KVM_GET_CLOCK
774
775 Capability: KVM_CAP_ADJUST_CLOCK
776 Architectures: x86
777 Type: vm ioctl
778 Parameters: struct kvm_clock_data (out)
779 Returns: 0 on success, -1 on error
780
781 Gets the current timestamp of kvmclock as seen by the current guest. In
782 conjunction with KVM_SET_CLOCK, it is used to ensure monotonicity on scenarios
783 such as migration.
784
785 When KVM_CAP_ADJUST_CLOCK is passed to KVM_CHECK_EXTENSION, it returns the
786 set of bits that KVM can return in struct kvm_clock_data's flag member.
787
788 The only flag defined now is KVM_CLOCK_TSC_STABLE.  If set, the returned
789 value is the exact kvmclock value seen by all VCPUs at the instant
790 when KVM_GET_CLOCK was called.  If clear, the returned value is simply
791 CLOCK_MONOTONIC plus a constant offset; the offset can be modified
792 with KVM_SET_CLOCK.  KVM will try to make all VCPUs follow this clock,
793 but the exact value read by each VCPU could differ, because the host
794 TSC is not stable.
795
796 struct kvm_clock_data {
797         __u64 clock;  /* kvmclock current value */
798         __u32 flags;
799         __u32 pad[9];
800 };
801
802
803 4.30 KVM_SET_CLOCK
804
805 Capability: KVM_CAP_ADJUST_CLOCK
806 Architectures: x86
807 Type: vm ioctl
808 Parameters: struct kvm_clock_data (in)
809 Returns: 0 on success, -1 on error
810
811 Sets the current timestamp of kvmclock to the value specified in its parameter.
812 In conjunction with KVM_GET_CLOCK, it is used to ensure monotonicity on scenarios
813 such as migration.
814
815 struct kvm_clock_data {
816         __u64 clock;  /* kvmclock current value */
817         __u32 flags;
818         __u32 pad[9];
819 };
820
821
822 4.31 KVM_GET_VCPU_EVENTS
823
824 Capability: KVM_CAP_VCPU_EVENTS
825 Extended by: KVM_CAP_INTR_SHADOW
826 Architectures: x86
827 Type: vm ioctl
828 Parameters: struct kvm_vcpu_event (out)
829 Returns: 0 on success, -1 on error
830
831 Gets currently pending exceptions, interrupts, and NMIs as well as related
832 states of the vcpu.
833
834 struct kvm_vcpu_events {
835         struct {
836                 __u8 injected;
837                 __u8 nr;
838                 __u8 has_error_code;
839                 __u8 pad;
840                 __u32 error_code;
841         } exception;
842         struct {
843                 __u8 injected;
844                 __u8 nr;
845                 __u8 soft;
846                 __u8 shadow;
847         } interrupt;
848         struct {
849                 __u8 injected;
850                 __u8 pending;
851                 __u8 masked;
852                 __u8 pad;
853         } nmi;
854         __u32 sipi_vector;
855         __u32 flags;
856         struct {
857                 __u8 smm;
858                 __u8 pending;
859                 __u8 smm_inside_nmi;
860                 __u8 latched_init;
861         } smi;
862 };
863
864 Only two fields are defined in the flags field:
865
866 - KVM_VCPUEVENT_VALID_SHADOW may be set in the flags field to signal that
867   interrupt.shadow contains a valid state.
868
869 - KVM_VCPUEVENT_VALID_SMM may be set in the flags field to signal that
870   smi contains a valid state.
871
872 4.32 KVM_SET_VCPU_EVENTS
873
874 Capability: KVM_CAP_VCPU_EVENTS
875 Extended by: KVM_CAP_INTR_SHADOW
876 Architectures: x86
877 Type: vm ioctl
878 Parameters: struct kvm_vcpu_event (in)
879 Returns: 0 on success, -1 on error
880
881 Set pending exceptions, interrupts, and NMIs as well as related states of the
882 vcpu.
883
884 See KVM_GET_VCPU_EVENTS for the data structure.
885
886 Fields that may be modified asynchronously by running VCPUs can be excluded
887 from the update. These fields are nmi.pending, sipi_vector, smi.smm,
888 smi.pending. Keep the corresponding bits in the flags field cleared to
889 suppress overwriting the current in-kernel state. The bits are:
890
891 KVM_VCPUEVENT_VALID_NMI_PENDING - transfer nmi.pending to the kernel
892 KVM_VCPUEVENT_VALID_SIPI_VECTOR - transfer sipi_vector
893 KVM_VCPUEVENT_VALID_SMM         - transfer the smi sub-struct.
894
895 If KVM_CAP_INTR_SHADOW is available, KVM_VCPUEVENT_VALID_SHADOW can be set in
896 the flags field to signal that interrupt.shadow contains a valid state and
897 shall be written into the VCPU.
898
899 KVM_VCPUEVENT_VALID_SMM can only be set if KVM_CAP_X86_SMM is available.
900
901
902 4.33 KVM_GET_DEBUGREGS
903
904 Capability: KVM_CAP_DEBUGREGS
905 Architectures: x86
906 Type: vm ioctl
907 Parameters: struct kvm_debugregs (out)
908 Returns: 0 on success, -1 on error
909
910 Reads debug registers from the vcpu.
911
912 struct kvm_debugregs {
913         __u64 db[4];
914         __u64 dr6;
915         __u64 dr7;
916         __u64 flags;
917         __u64 reserved[9];
918 };
919
920
921 4.34 KVM_SET_DEBUGREGS
922
923 Capability: KVM_CAP_DEBUGREGS
924 Architectures: x86
925 Type: vm ioctl
926 Parameters: struct kvm_debugregs (in)
927 Returns: 0 on success, -1 on error
928
929 Writes debug registers into the vcpu.
930
931 See KVM_GET_DEBUGREGS for the data structure. The flags field is unused
932 yet and must be cleared on entry.
933
934
935 4.35 KVM_SET_USER_MEMORY_REGION
936
937 Capability: KVM_CAP_USER_MEM
938 Architectures: all
939 Type: vm ioctl
940 Parameters: struct kvm_userspace_memory_region (in)
941 Returns: 0 on success, -1 on error
942
943 struct kvm_userspace_memory_region {
944         __u32 slot;
945         __u32 flags;
946         __u64 guest_phys_addr;
947         __u64 memory_size; /* bytes */
948         __u64 userspace_addr; /* start of the userspace allocated memory */
949 };
950
951 /* for kvm_memory_region::flags */
952 #define KVM_MEM_LOG_DIRTY_PAGES (1UL << 0)
953 #define KVM_MEM_READONLY        (1UL << 1)
954
955 This ioctl allows the user to create or modify a guest physical memory
956 slot.  When changing an existing slot, it may be moved in the guest
957 physical memory space, or its flags may be modified.  It may not be
958 resized.  Slots may not overlap in guest physical address space.
959 Bits 0-15 of "slot" specifies the slot id and this value should be
960 less than the maximum number of user memory slots supported per VM.
961 The maximum allowed slots can be queried using KVM_CAP_NR_MEMSLOTS,
962 if this capability is supported by the architecture.
963
964 If KVM_CAP_MULTI_ADDRESS_SPACE is available, bits 16-31 of "slot"
965 specifies the address space which is being modified.  They must be
966 less than the value that KVM_CHECK_EXTENSION returns for the
967 KVM_CAP_MULTI_ADDRESS_SPACE capability.  Slots in separate address spaces
968 are unrelated; the restriction on overlapping slots only applies within
969 each address space.
970
971 Memory for the region is taken starting at the address denoted by the
972 field userspace_addr, which must point at user addressable memory for
973 the entire memory slot size.  Any object may back this memory, including
974 anonymous memory, ordinary files, and hugetlbfs.
975
976 It is recommended that the lower 21 bits of guest_phys_addr and userspace_addr
977 be identical.  This allows large pages in the guest to be backed by large
978 pages in the host.
979
980 The flags field supports two flags: KVM_MEM_LOG_DIRTY_PAGES and
981 KVM_MEM_READONLY.  The former can be set to instruct KVM to keep track of
982 writes to memory within the slot.  See KVM_GET_DIRTY_LOG ioctl to know how to
983 use it.  The latter can be set, if KVM_CAP_READONLY_MEM capability allows it,
984 to make a new slot read-only.  In this case, writes to this memory will be
985 posted to userspace as KVM_EXIT_MMIO exits.
986
987 When the KVM_CAP_SYNC_MMU capability is available, changes in the backing of
988 the memory region are automatically reflected into the guest.  For example, an
989 mmap() that affects the region will be made visible immediately.  Another
990 example is madvise(MADV_DROP).
991
992 It is recommended to use this API instead of the KVM_SET_MEMORY_REGION ioctl.
993 The KVM_SET_MEMORY_REGION does not allow fine grained control over memory
994 allocation and is deprecated.
995
996
997 4.36 KVM_SET_TSS_ADDR
998
999 Capability: KVM_CAP_SET_TSS_ADDR
1000 Architectures: x86
1001 Type: vm ioctl
1002 Parameters: unsigned long tss_address (in)
1003 Returns: 0 on success, -1 on error
1004
1005 This ioctl defines the physical address of a three-page region in the guest
1006 physical address space.  The region must be within the first 4GB of the
1007 guest physical address space and must not conflict with any memory slot
1008 or any mmio address.  The guest may malfunction if it accesses this memory
1009 region.
1010
1011 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
1012 because of a quirk in the virtualization implementation (see the internals
1013 documentation when it pops into existence).
1014
1015
1016 4.37 KVM_ENABLE_CAP
1017
1018 Capability: KVM_CAP_ENABLE_CAP, KVM_CAP_ENABLE_CAP_VM
1019 Architectures: x86 (only KVM_CAP_ENABLE_CAP_VM),
1020                mips (only KVM_CAP_ENABLE_CAP), ppc, s390
1021 Type: vcpu ioctl, vm ioctl (with KVM_CAP_ENABLE_CAP_VM)
1022 Parameters: struct kvm_enable_cap (in)
1023 Returns: 0 on success; -1 on error
1024
1025 +Not all extensions are enabled by default. Using this ioctl the application
1026 can enable an extension, making it available to the guest.
1027
1028 On systems that do not support this ioctl, it always fails. On systems that
1029 do support it, it only works for extensions that are supported for enablement.
1030
1031 To check if a capability can be enabled, the KVM_CHECK_EXTENSION ioctl should
1032 be used.
1033
1034 struct kvm_enable_cap {
1035        /* in */
1036        __u32 cap;
1037
1038 The capability that is supposed to get enabled.
1039
1040        __u32 flags;
1041
1042 A bitfield indicating future enhancements. Has to be 0 for now.
1043
1044        __u64 args[4];
1045
1046 Arguments for enabling a feature. If a feature needs initial values to
1047 function properly, this is the place to put them.
1048
1049        __u8  pad[64];
1050 };
1051
1052 The vcpu ioctl should be used for vcpu-specific capabilities, the vm ioctl
1053 for vm-wide capabilities.
1054
1055 4.38 KVM_GET_MP_STATE
1056
1057 Capability: KVM_CAP_MP_STATE
1058 Architectures: x86, s390, arm, arm64
1059 Type: vcpu ioctl
1060 Parameters: struct kvm_mp_state (out)
1061 Returns: 0 on success; -1 on error
1062
1063 struct kvm_mp_state {
1064         __u32 mp_state;
1065 };
1066
1067 Returns the vcpu's current "multiprocessing state" (though also valid on
1068 uniprocessor guests).
1069
1070 Possible values are:
1071
1072  - KVM_MP_STATE_RUNNABLE:        the vcpu is currently running [x86,arm/arm64]
1073  - KVM_MP_STATE_UNINITIALIZED:   the vcpu is an application processor (AP)
1074                                  which has not yet received an INIT signal [x86]
1075  - KVM_MP_STATE_INIT_RECEIVED:   the vcpu has received an INIT signal, and is
1076                                  now ready for a SIPI [x86]
1077  - KVM_MP_STATE_HALTED:          the vcpu has executed a HLT instruction and
1078                                  is waiting for an interrupt [x86]
1079  - KVM_MP_STATE_SIPI_RECEIVED:   the vcpu has just received a SIPI (vector
1080                                  accessible via KVM_GET_VCPU_EVENTS) [x86]
1081  - KVM_MP_STATE_STOPPED:         the vcpu is stopped [s390,arm/arm64]
1082  - KVM_MP_STATE_CHECK_STOP:      the vcpu is in a special error state [s390]
1083  - KVM_MP_STATE_OPERATING:       the vcpu is operating (running or halted)
1084                                  [s390]
1085  - KVM_MP_STATE_LOAD:            the vcpu is in a special load/startup state
1086                                  [s390]
1087
1088 On x86, this ioctl is only useful after KVM_CREATE_IRQCHIP. Without an
1089 in-kernel irqchip, the multiprocessing state must be maintained by userspace on
1090 these architectures.
1091
1092 For arm/arm64:
1093
1094 The only states that are valid are KVM_MP_STATE_STOPPED and
1095 KVM_MP_STATE_RUNNABLE which reflect if the vcpu is paused or not.
1096
1097 4.39 KVM_SET_MP_STATE
1098
1099 Capability: KVM_CAP_MP_STATE
1100 Architectures: x86, s390, arm, arm64
1101 Type: vcpu ioctl
1102 Parameters: struct kvm_mp_state (in)
1103 Returns: 0 on success; -1 on error
1104
1105 Sets the vcpu's current "multiprocessing state"; see KVM_GET_MP_STATE for
1106 arguments.
1107
1108 On x86, this ioctl is only useful after KVM_CREATE_IRQCHIP. Without an
1109 in-kernel irqchip, the multiprocessing state must be maintained by userspace on
1110 these architectures.
1111
1112 For arm/arm64:
1113
1114 The only states that are valid are KVM_MP_STATE_STOPPED and
1115 KVM_MP_STATE_RUNNABLE which reflect if the vcpu should be paused or not.
1116
1117 4.40 KVM_SET_IDENTITY_MAP_ADDR
1118
1119 Capability: KVM_CAP_SET_IDENTITY_MAP_ADDR
1120 Architectures: x86
1121 Type: vm ioctl
1122 Parameters: unsigned long identity (in)
1123 Returns: 0 on success, -1 on error
1124
1125 This ioctl defines the physical address of a one-page region in the guest
1126 physical address space.  The region must be within the first 4GB of the
1127 guest physical address space and must not conflict with any memory slot
1128 or any mmio address.  The guest may malfunction if it accesses this memory
1129 region.
1130
1131 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
1132 because of a quirk in the virtualization implementation (see the internals
1133 documentation when it pops into existence).
1134
1135
1136 4.41 KVM_SET_BOOT_CPU_ID
1137
1138 Capability: KVM_CAP_SET_BOOT_CPU_ID
1139 Architectures: x86
1140 Type: vm ioctl
1141 Parameters: unsigned long vcpu_id
1142 Returns: 0 on success, -1 on error
1143
1144 Define which vcpu is the Bootstrap Processor (BSP).  Values are the same
1145 as the vcpu id in KVM_CREATE_VCPU.  If this ioctl is not called, the default
1146 is vcpu 0.
1147
1148
1149 4.42 KVM_GET_XSAVE
1150
1151 Capability: KVM_CAP_XSAVE
1152 Architectures: x86
1153 Type: vcpu ioctl
1154 Parameters: struct kvm_xsave (out)
1155 Returns: 0 on success, -1 on error
1156
1157 struct kvm_xsave {
1158         __u32 region[1024];
1159 };
1160
1161 This ioctl would copy current vcpu's xsave struct to the userspace.
1162
1163
1164 4.43 KVM_SET_XSAVE
1165
1166 Capability: KVM_CAP_XSAVE
1167 Architectures: x86
1168 Type: vcpu ioctl
1169 Parameters: struct kvm_xsave (in)
1170 Returns: 0 on success, -1 on error
1171
1172 struct kvm_xsave {
1173         __u32 region[1024];
1174 };
1175
1176 This ioctl would copy userspace's xsave struct to the kernel.
1177
1178
1179 4.44 KVM_GET_XCRS
1180
1181 Capability: KVM_CAP_XCRS
1182 Architectures: x86
1183 Type: vcpu ioctl
1184 Parameters: struct kvm_xcrs (out)
1185 Returns: 0 on success, -1 on error
1186
1187 struct kvm_xcr {
1188         __u32 xcr;
1189         __u32 reserved;
1190         __u64 value;
1191 };
1192
1193 struct kvm_xcrs {
1194         __u32 nr_xcrs;
1195         __u32 flags;
1196         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1197         __u64 padding[16];
1198 };
1199
1200 This ioctl would copy current vcpu's xcrs to the userspace.
1201
1202
1203 4.45 KVM_SET_XCRS
1204
1205 Capability: KVM_CAP_XCRS
1206 Architectures: x86
1207 Type: vcpu ioctl
1208 Parameters: struct kvm_xcrs (in)
1209 Returns: 0 on success, -1 on error
1210
1211 struct kvm_xcr {
1212         __u32 xcr;
1213         __u32 reserved;
1214         __u64 value;
1215 };
1216
1217 struct kvm_xcrs {
1218         __u32 nr_xcrs;
1219         __u32 flags;
1220         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1221         __u64 padding[16];
1222 };
1223
1224 This ioctl would set vcpu's xcr to the value userspace specified.
1225
1226
1227 4.46 KVM_GET_SUPPORTED_CPUID
1228
1229 Capability: KVM_CAP_EXT_CPUID
1230 Architectures: x86
1231 Type: system ioctl
1232 Parameters: struct kvm_cpuid2 (in/out)
1233 Returns: 0 on success, -1 on error
1234
1235 struct kvm_cpuid2 {
1236         __u32 nent;
1237         __u32 padding;
1238         struct kvm_cpuid_entry2 entries[0];
1239 };
1240
1241 #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX         BIT(0)
1242 #define KVM_CPUID_FLAG_STATEFUL_FUNC            BIT(1)
1243 #define KVM_CPUID_FLAG_STATE_READ_NEXT          BIT(2)
1244
1245 struct kvm_cpuid_entry2 {
1246         __u32 function;
1247         __u32 index;
1248         __u32 flags;
1249         __u32 eax;
1250         __u32 ebx;
1251         __u32 ecx;
1252         __u32 edx;
1253         __u32 padding[3];
1254 };
1255
1256 This ioctl returns x86 cpuid features which are supported by both the hardware
1257 and kvm.  Userspace can use the information returned by this ioctl to
1258 construct cpuid information (for KVM_SET_CPUID2) that is consistent with
1259 hardware, kernel, and userspace capabilities, and with user requirements (for
1260 example, the user may wish to constrain cpuid to emulate older hardware,
1261 or for feature consistency across a cluster).
1262
1263 Userspace invokes KVM_GET_SUPPORTED_CPUID by passing a kvm_cpuid2 structure
1264 with the 'nent' field indicating the number of entries in the variable-size
1265 array 'entries'.  If the number of entries is too low to describe the cpu
1266 capabilities, an error (E2BIG) is returned.  If the number is too high,
1267 the 'nent' field is adjusted and an error (ENOMEM) is returned.  If the
1268 number is just right, the 'nent' field is adjusted to the number of valid
1269 entries in the 'entries' array, which is then filled.
1270
1271 The entries returned are the host cpuid as returned by the cpuid instruction,
1272 with unknown or unsupported features masked out.  Some features (for example,
1273 x2apic), may not be present in the host cpu, but are exposed by kvm if it can
1274 emulate them efficiently. The fields in each entry are defined as follows:
1275
1276   function: the eax value used to obtain the entry
1277   index: the ecx value used to obtain the entry (for entries that are
1278          affected by ecx)
1279   flags: an OR of zero or more of the following:
1280         KVM_CPUID_FLAG_SIGNIFCANT_INDEX:
1281            if the index field is valid
1282         KVM_CPUID_FLAG_STATEFUL_FUNC:
1283            if cpuid for this function returns different values for successive
1284            invocations; there will be several entries with the same function,
1285            all with this flag set
1286         KVM_CPUID_FLAG_STATE_READ_NEXT:
1287            for KVM_CPUID_FLAG_STATEFUL_FUNC entries, set if this entry is
1288            the first entry to be read by a cpu
1289    eax, ebx, ecx, edx: the values returned by the cpuid instruction for
1290          this function/index combination
1291
1292 The TSC deadline timer feature (CPUID leaf 1, ecx[24]) is always returned
1293 as false, since the feature depends on KVM_CREATE_IRQCHIP for local APIC
1294 support.  Instead it is reported via
1295
1296   ioctl(KVM_CHECK_EXTENSION, KVM_CAP_TSC_DEADLINE_TIMER)
1297
1298 if that returns true and you use KVM_CREATE_IRQCHIP, or if you emulate the
1299 feature in userspace, then you can enable the feature for KVM_SET_CPUID2.
1300
1301
1302 4.47 KVM_PPC_GET_PVINFO
1303
1304 Capability: KVM_CAP_PPC_GET_PVINFO
1305 Architectures: ppc
1306 Type: vm ioctl
1307 Parameters: struct kvm_ppc_pvinfo (out)
1308 Returns: 0 on success, !0 on error
1309
1310 struct kvm_ppc_pvinfo {
1311         __u32 flags;
1312         __u32 hcall[4];
1313         __u8  pad[108];
1314 };
1315
1316 This ioctl fetches PV specific information that need to be passed to the guest
1317 using the device tree or other means from vm context.
1318
1319 The hcall array defines 4 instructions that make up a hypercall.
1320
1321 If any additional field gets added to this structure later on, a bit for that
1322 additional piece of information will be set in the flags bitmap.
1323
1324 The flags bitmap is defined as:
1325
1326    /* the host supports the ePAPR idle hcall
1327    #define KVM_PPC_PVINFO_FLAGS_EV_IDLE   (1<<0)
1328
1329 4.48 KVM_ASSIGN_PCI_DEVICE (deprecated)
1330
1331 Capability: none
1332 Architectures: x86
1333 Type: vm ioctl
1334 Parameters: struct kvm_assigned_pci_dev (in)
1335 Returns: 0 on success, -1 on error
1336
1337 Assigns a host PCI device to the VM.
1338
1339 struct kvm_assigned_pci_dev {
1340         __u32 assigned_dev_id;
1341         __u32 busnr;
1342         __u32 devfn;
1343         __u32 flags;
1344         __u32 segnr;
1345         union {
1346                 __u32 reserved[11];
1347         };
1348 };
1349
1350 The PCI device is specified by the triple segnr, busnr, and devfn.
1351 Identification in succeeding service requests is done via assigned_dev_id. The
1352 following flags are specified:
1353
1354 /* Depends on KVM_CAP_IOMMU */
1355 #define KVM_DEV_ASSIGN_ENABLE_IOMMU     (1 << 0)
1356 /* The following two depend on KVM_CAP_PCI_2_3 */
1357 #define KVM_DEV_ASSIGN_PCI_2_3          (1 << 1)
1358 #define KVM_DEV_ASSIGN_MASK_INTX        (1 << 2)
1359
1360 If KVM_DEV_ASSIGN_PCI_2_3 is set, the kernel will manage legacy INTx interrupts
1361 via the PCI-2.3-compliant device-level mask, thus enable IRQ sharing with other
1362 assigned devices or host devices. KVM_DEV_ASSIGN_MASK_INTX specifies the
1363 guest's view on the INTx mask, see KVM_ASSIGN_SET_INTX_MASK for details.
1364
1365 The KVM_DEV_ASSIGN_ENABLE_IOMMU flag is a mandatory option to ensure
1366 isolation of the device.  Usages not specifying this flag are deprecated.
1367
1368 Only PCI header type 0 devices with PCI BAR resources are supported by
1369 device assignment.  The user requesting this ioctl must have read/write
1370 access to the PCI sysfs resource files associated with the device.
1371
1372 Errors:
1373   ENOTTY: kernel does not support this ioctl
1374
1375   Other error conditions may be defined by individual device types or
1376   have their standard meanings.
1377
1378
1379 4.49 KVM_DEASSIGN_PCI_DEVICE (deprecated)
1380
1381 Capability: none
1382 Architectures: x86
1383 Type: vm ioctl
1384 Parameters: struct kvm_assigned_pci_dev (in)
1385 Returns: 0 on success, -1 on error
1386
1387 Ends PCI device assignment, releasing all associated resources.
1388
1389 See KVM_ASSIGN_PCI_DEVICE for the data structure. Only assigned_dev_id is
1390 used in kvm_assigned_pci_dev to identify the device.
1391
1392 Errors:
1393   ENOTTY: kernel does not support this ioctl
1394
1395   Other error conditions may be defined by individual device types or
1396   have their standard meanings.
1397
1398 4.50 KVM_ASSIGN_DEV_IRQ (deprecated)
1399
1400 Capability: KVM_CAP_ASSIGN_DEV_IRQ
1401 Architectures: x86
1402 Type: vm ioctl
1403 Parameters: struct kvm_assigned_irq (in)
1404 Returns: 0 on success, -1 on error
1405
1406 Assigns an IRQ to a passed-through device.
1407
1408 struct kvm_assigned_irq {
1409         __u32 assigned_dev_id;
1410         __u32 host_irq; /* ignored (legacy field) */
1411         __u32 guest_irq;
1412         __u32 flags;
1413         union {
1414                 __u32 reserved[12];
1415         };
1416 };
1417
1418 The following flags are defined:
1419
1420 #define KVM_DEV_IRQ_HOST_INTX    (1 << 0)
1421 #define KVM_DEV_IRQ_HOST_MSI     (1 << 1)
1422 #define KVM_DEV_IRQ_HOST_MSIX    (1 << 2)
1423
1424 #define KVM_DEV_IRQ_GUEST_INTX   (1 << 8)
1425 #define KVM_DEV_IRQ_GUEST_MSI    (1 << 9)
1426 #define KVM_DEV_IRQ_GUEST_MSIX   (1 << 10)
1427
1428 It is not valid to specify multiple types per host or guest IRQ. However, the
1429 IRQ type of host and guest can differ or can even be null.
1430
1431 Errors:
1432   ENOTTY: kernel does not support this ioctl
1433
1434   Other error conditions may be defined by individual device types or
1435   have their standard meanings.
1436
1437
1438 4.51 KVM_DEASSIGN_DEV_IRQ (deprecated)
1439
1440 Capability: KVM_CAP_ASSIGN_DEV_IRQ
1441 Architectures: x86
1442 Type: vm ioctl
1443 Parameters: struct kvm_assigned_irq (in)
1444 Returns: 0 on success, -1 on error
1445
1446 Ends an IRQ assignment to a passed-through device.
1447
1448 See KVM_ASSIGN_DEV_IRQ for the data structure. The target device is specified
1449 by assigned_dev_id, flags must correspond to the IRQ type specified on
1450 KVM_ASSIGN_DEV_IRQ. Partial deassignment of host or guest IRQ is allowed.
1451
1452
1453 4.52 KVM_SET_GSI_ROUTING
1454
1455 Capability: KVM_CAP_IRQ_ROUTING
1456 Architectures: x86 s390 arm arm64
1457 Type: vm ioctl
1458 Parameters: struct kvm_irq_routing (in)
1459 Returns: 0 on success, -1 on error
1460
1461 Sets the GSI routing table entries, overwriting any previously set entries.
1462
1463 On arm/arm64, GSI routing has the following limitation:
1464 - GSI routing does not apply to KVM_IRQ_LINE but only to KVM_IRQFD.
1465
1466 struct kvm_irq_routing {
1467         __u32 nr;
1468         __u32 flags;
1469         struct kvm_irq_routing_entry entries[0];
1470 };
1471
1472 No flags are specified so far, the corresponding field must be set to zero.
1473
1474 struct kvm_irq_routing_entry {
1475         __u32 gsi;
1476         __u32 type;
1477         __u32 flags;
1478         __u32 pad;
1479         union {
1480                 struct kvm_irq_routing_irqchip irqchip;
1481                 struct kvm_irq_routing_msi msi;
1482                 struct kvm_irq_routing_s390_adapter adapter;
1483                 struct kvm_irq_routing_hv_sint hv_sint;
1484                 __u32 pad[8];
1485         } u;
1486 };
1487
1488 /* gsi routing entry types */
1489 #define KVM_IRQ_ROUTING_IRQCHIP 1
1490 #define KVM_IRQ_ROUTING_MSI 2
1491 #define KVM_IRQ_ROUTING_S390_ADAPTER 3
1492 #define KVM_IRQ_ROUTING_HV_SINT 4
1493
1494 flags:
1495 - KVM_MSI_VALID_DEVID: used along with KVM_IRQ_ROUTING_MSI routing entry
1496   type, specifies that the devid field contains a valid value.  The per-VM
1497   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
1498   the device ID.  If this capability is not available, userspace should
1499   never set the KVM_MSI_VALID_DEVID flag as the ioctl might fail.
1500 - zero otherwise
1501
1502 struct kvm_irq_routing_irqchip {
1503         __u32 irqchip;
1504         __u32 pin;
1505 };
1506
1507 struct kvm_irq_routing_msi {
1508         __u32 address_lo;
1509         __u32 address_hi;
1510         __u32 data;
1511         union {
1512                 __u32 pad;
1513                 __u32 devid;
1514         };
1515 };
1516
1517 If KVM_MSI_VALID_DEVID is set, devid contains a unique device identifier
1518 for the device that wrote the MSI message.  For PCI, this is usually a
1519 BFD identifier in the lower 16 bits.
1520
1521 On x86, address_hi is ignored unless the KVM_X2APIC_API_USE_32BIT_IDS
1522 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
1523 address_hi bits 31-8 provide bits 31-8 of the destination id.  Bits 7-0 of
1524 address_hi must be zero.
1525
1526 struct kvm_irq_routing_s390_adapter {
1527         __u64 ind_addr;
1528         __u64 summary_addr;
1529         __u64 ind_offset;
1530         __u32 summary_offset;
1531         __u32 adapter_id;
1532 };
1533
1534 struct kvm_irq_routing_hv_sint {
1535         __u32 vcpu;
1536         __u32 sint;
1537 };
1538
1539 4.53 KVM_ASSIGN_SET_MSIX_NR (deprecated)
1540
1541 Capability: none
1542 Architectures: x86
1543 Type: vm ioctl
1544 Parameters: struct kvm_assigned_msix_nr (in)
1545 Returns: 0 on success, -1 on error
1546
1547 Set the number of MSI-X interrupts for an assigned device. The number is
1548 reset again by terminating the MSI-X assignment of the device via
1549 KVM_DEASSIGN_DEV_IRQ. Calling this service more than once at any earlier
1550 point will fail.
1551
1552 struct kvm_assigned_msix_nr {
1553         __u32 assigned_dev_id;
1554         __u16 entry_nr;
1555         __u16 padding;
1556 };
1557
1558 #define KVM_MAX_MSIX_PER_DEV            256
1559
1560
1561 4.54 KVM_ASSIGN_SET_MSIX_ENTRY (deprecated)
1562
1563 Capability: none
1564 Architectures: x86
1565 Type: vm ioctl
1566 Parameters: struct kvm_assigned_msix_entry (in)
1567 Returns: 0 on success, -1 on error
1568
1569 Specifies the routing of an MSI-X assigned device interrupt to a GSI. Setting
1570 the GSI vector to zero means disabling the interrupt.
1571
1572 struct kvm_assigned_msix_entry {
1573         __u32 assigned_dev_id;
1574         __u32 gsi;
1575         __u16 entry; /* The index of entry in the MSI-X table */
1576         __u16 padding[3];
1577 };
1578
1579 Errors:
1580   ENOTTY: kernel does not support this ioctl
1581
1582   Other error conditions may be defined by individual device types or
1583   have their standard meanings.
1584
1585
1586 4.55 KVM_SET_TSC_KHZ
1587
1588 Capability: KVM_CAP_TSC_CONTROL
1589 Architectures: x86
1590 Type: vcpu ioctl
1591 Parameters: virtual tsc_khz
1592 Returns: 0 on success, -1 on error
1593
1594 Specifies the tsc frequency for the virtual machine. The unit of the
1595 frequency is KHz.
1596
1597
1598 4.56 KVM_GET_TSC_KHZ
1599
1600 Capability: KVM_CAP_GET_TSC_KHZ
1601 Architectures: x86
1602 Type: vcpu ioctl
1603 Parameters: none
1604 Returns: virtual tsc-khz on success, negative value on error
1605
1606 Returns the tsc frequency of the guest. The unit of the return value is
1607 KHz. If the host has unstable tsc this ioctl returns -EIO instead as an
1608 error.
1609
1610
1611 4.57 KVM_GET_LAPIC
1612
1613 Capability: KVM_CAP_IRQCHIP
1614 Architectures: x86
1615 Type: vcpu ioctl
1616 Parameters: struct kvm_lapic_state (out)
1617 Returns: 0 on success, -1 on error
1618
1619 #define KVM_APIC_REG_SIZE 0x400
1620 struct kvm_lapic_state {
1621         char regs[KVM_APIC_REG_SIZE];
1622 };
1623
1624 Reads the Local APIC registers and copies them into the input argument.  The
1625 data format and layout are the same as documented in the architecture manual.
1626
1627 If KVM_X2APIC_API_USE_32BIT_IDS feature of KVM_CAP_X2APIC_API is
1628 enabled, then the format of APIC_ID register depends on the APIC mode
1629 (reported by MSR_IA32_APICBASE) of its VCPU.  x2APIC stores APIC ID in
1630 the APIC_ID register (bytes 32-35).  xAPIC only allows an 8-bit APIC ID
1631 which is stored in bits 31-24 of the APIC register, or equivalently in
1632 byte 35 of struct kvm_lapic_state's regs field.  KVM_GET_LAPIC must then
1633 be called after MSR_IA32_APICBASE has been set with KVM_SET_MSR.
1634
1635 If KVM_X2APIC_API_USE_32BIT_IDS feature is disabled, struct kvm_lapic_state
1636 always uses xAPIC format.
1637
1638
1639 4.58 KVM_SET_LAPIC
1640
1641 Capability: KVM_CAP_IRQCHIP
1642 Architectures: x86
1643 Type: vcpu ioctl
1644 Parameters: struct kvm_lapic_state (in)
1645 Returns: 0 on success, -1 on error
1646
1647 #define KVM_APIC_REG_SIZE 0x400
1648 struct kvm_lapic_state {
1649         char regs[KVM_APIC_REG_SIZE];
1650 };
1651
1652 Copies the input argument into the Local APIC registers.  The data format
1653 and layout are the same as documented in the architecture manual.
1654
1655 The format of the APIC ID register (bytes 32-35 of struct kvm_lapic_state's
1656 regs field) depends on the state of the KVM_CAP_X2APIC_API capability.
1657 See the note in KVM_GET_LAPIC.
1658
1659
1660 4.59 KVM_IOEVENTFD
1661
1662 Capability: KVM_CAP_IOEVENTFD
1663 Architectures: all
1664 Type: vm ioctl
1665 Parameters: struct kvm_ioeventfd (in)
1666 Returns: 0 on success, !0 on error
1667
1668 This ioctl attaches or detaches an ioeventfd to a legal pio/mmio address
1669 within the guest.  A guest write in the registered address will signal the
1670 provided event instead of triggering an exit.
1671
1672 struct kvm_ioeventfd {
1673         __u64 datamatch;
1674         __u64 addr;        /* legal pio/mmio address */
1675         __u32 len;         /* 0, 1, 2, 4, or 8 bytes    */
1676         __s32 fd;
1677         __u32 flags;
1678         __u8  pad[36];
1679 };
1680
1681 For the special case of virtio-ccw devices on s390, the ioevent is matched
1682 to a subchannel/virtqueue tuple instead.
1683
1684 The following flags are defined:
1685
1686 #define KVM_IOEVENTFD_FLAG_DATAMATCH (1 << kvm_ioeventfd_flag_nr_datamatch)
1687 #define KVM_IOEVENTFD_FLAG_PIO       (1 << kvm_ioeventfd_flag_nr_pio)
1688 #define KVM_IOEVENTFD_FLAG_DEASSIGN  (1 << kvm_ioeventfd_flag_nr_deassign)
1689 #define KVM_IOEVENTFD_FLAG_VIRTIO_CCW_NOTIFY \
1690         (1 << kvm_ioeventfd_flag_nr_virtio_ccw_notify)
1691
1692 If datamatch flag is set, the event will be signaled only if the written value
1693 to the registered address is equal to datamatch in struct kvm_ioeventfd.
1694
1695 For virtio-ccw devices, addr contains the subchannel id and datamatch the
1696 virtqueue index.
1697
1698 With KVM_CAP_IOEVENTFD_ANY_LENGTH, a zero length ioeventfd is allowed, and
1699 the kernel will ignore the length of guest write and may get a faster vmexit.
1700 The speedup may only apply to specific architectures, but the ioeventfd will
1701 work anyway.
1702
1703 4.60 KVM_DIRTY_TLB
1704
1705 Capability: KVM_CAP_SW_TLB
1706 Architectures: ppc
1707 Type: vcpu ioctl
1708 Parameters: struct kvm_dirty_tlb (in)
1709 Returns: 0 on success, -1 on error
1710
1711 struct kvm_dirty_tlb {
1712         __u64 bitmap;
1713         __u32 num_dirty;
1714 };
1715
1716 This must be called whenever userspace has changed an entry in the shared
1717 TLB, prior to calling KVM_RUN on the associated vcpu.
1718
1719 The "bitmap" field is the userspace address of an array.  This array
1720 consists of a number of bits, equal to the total number of TLB entries as
1721 determined by the last successful call to KVM_CONFIG_TLB, rounded up to the
1722 nearest multiple of 64.
1723
1724 Each bit corresponds to one TLB entry, ordered the same as in the shared TLB
1725 array.
1726
1727 The array is little-endian: the bit 0 is the least significant bit of the
1728 first byte, bit 8 is the least significant bit of the second byte, etc.
1729 This avoids any complications with differing word sizes.
1730
1731 The "num_dirty" field is a performance hint for KVM to determine whether it
1732 should skip processing the bitmap and just invalidate everything.  It must
1733 be set to the number of set bits in the bitmap.
1734
1735
1736 4.61 KVM_ASSIGN_SET_INTX_MASK (deprecated)
1737
1738 Capability: KVM_CAP_PCI_2_3
1739 Architectures: x86
1740 Type: vm ioctl
1741 Parameters: struct kvm_assigned_pci_dev (in)
1742 Returns: 0 on success, -1 on error
1743
1744 Allows userspace to mask PCI INTx interrupts from the assigned device.  The
1745 kernel will not deliver INTx interrupts to the guest between setting and
1746 clearing of KVM_ASSIGN_SET_INTX_MASK via this interface.  This enables use of
1747 and emulation of PCI 2.3 INTx disable command register behavior.
1748
1749 This may be used for both PCI 2.3 devices supporting INTx disable natively and
1750 older devices lacking this support. Userspace is responsible for emulating the
1751 read value of the INTx disable bit in the guest visible PCI command register.
1752 When modifying the INTx disable state, userspace should precede updating the
1753 physical device command register by calling this ioctl to inform the kernel of
1754 the new intended INTx mask state.
1755
1756 Note that the kernel uses the device INTx disable bit to internally manage the
1757 device interrupt state for PCI 2.3 devices.  Reads of this register may
1758 therefore not match the expected value.  Writes should always use the guest
1759 intended INTx disable value rather than attempting to read-copy-update the
1760 current physical device state.  Races between user and kernel updates to the
1761 INTx disable bit are handled lazily in the kernel.  It's possible the device
1762 may generate unintended interrupts, but they will not be injected into the
1763 guest.
1764
1765 See KVM_ASSIGN_DEV_IRQ for the data structure.  The target device is specified
1766 by assigned_dev_id.  In the flags field, only KVM_DEV_ASSIGN_MASK_INTX is
1767 evaluated.
1768
1769
1770 4.62 KVM_CREATE_SPAPR_TCE
1771
1772 Capability: KVM_CAP_SPAPR_TCE
1773 Architectures: powerpc
1774 Type: vm ioctl
1775 Parameters: struct kvm_create_spapr_tce (in)
1776 Returns: file descriptor for manipulating the created TCE table
1777
1778 This creates a virtual TCE (translation control entry) table, which
1779 is an IOMMU for PAPR-style virtual I/O.  It is used to translate
1780 logical addresses used in virtual I/O into guest physical addresses,
1781 and provides a scatter/gather capability for PAPR virtual I/O.
1782
1783 /* for KVM_CAP_SPAPR_TCE */
1784 struct kvm_create_spapr_tce {
1785         __u64 liobn;
1786         __u32 window_size;
1787 };
1788
1789 The liobn field gives the logical IO bus number for which to create a
1790 TCE table.  The window_size field specifies the size of the DMA window
1791 which this TCE table will translate - the table will contain one 64
1792 bit TCE entry for every 4kiB of the DMA window.
1793
1794 When the guest issues an H_PUT_TCE hcall on a liobn for which a TCE
1795 table has been created using this ioctl(), the kernel will handle it
1796 in real mode, updating the TCE table.  H_PUT_TCE calls for other
1797 liobns will cause a vm exit and must be handled by userspace.
1798
1799 The return value is a file descriptor which can be passed to mmap(2)
1800 to map the created TCE table into userspace.  This lets userspace read
1801 the entries written by kernel-handled H_PUT_TCE calls, and also lets
1802 userspace update the TCE table directly which is useful in some
1803 circumstances.
1804
1805
1806 4.63 KVM_ALLOCATE_RMA
1807
1808 Capability: KVM_CAP_PPC_RMA
1809 Architectures: powerpc
1810 Type: vm ioctl
1811 Parameters: struct kvm_allocate_rma (out)
1812 Returns: file descriptor for mapping the allocated RMA
1813
1814 This allocates a Real Mode Area (RMA) from the pool allocated at boot
1815 time by the kernel.  An RMA is a physically-contiguous, aligned region
1816 of memory used on older POWER processors to provide the memory which
1817 will be accessed by real-mode (MMU off) accesses in a KVM guest.
1818 POWER processors support a set of sizes for the RMA that usually
1819 includes 64MB, 128MB, 256MB and some larger powers of two.
1820
1821 /* for KVM_ALLOCATE_RMA */
1822 struct kvm_allocate_rma {
1823         __u64 rma_size;
1824 };
1825
1826 The return value is a file descriptor which can be passed to mmap(2)
1827 to map the allocated RMA into userspace.  The mapped area can then be
1828 passed to the KVM_SET_USER_MEMORY_REGION ioctl to establish it as the
1829 RMA for a virtual machine.  The size of the RMA in bytes (which is
1830 fixed at host kernel boot time) is returned in the rma_size field of
1831 the argument structure.
1832
1833 The KVM_CAP_PPC_RMA capability is 1 or 2 if the KVM_ALLOCATE_RMA ioctl
1834 is supported; 2 if the processor requires all virtual machines to have
1835 an RMA, or 1 if the processor can use an RMA but doesn't require it,
1836 because it supports the Virtual RMA (VRMA) facility.
1837
1838
1839 4.64 KVM_NMI
1840
1841 Capability: KVM_CAP_USER_NMI
1842 Architectures: x86
1843 Type: vcpu ioctl
1844 Parameters: none
1845 Returns: 0 on success, -1 on error
1846
1847 Queues an NMI on the thread's vcpu.  Note this is well defined only
1848 when KVM_CREATE_IRQCHIP has not been called, since this is an interface
1849 between the virtual cpu core and virtual local APIC.  After KVM_CREATE_IRQCHIP
1850 has been called, this interface is completely emulated within the kernel.
1851
1852 To use this to emulate the LINT1 input with KVM_CREATE_IRQCHIP, use the
1853 following algorithm:
1854
1855   - pause the vcpu
1856   - read the local APIC's state (KVM_GET_LAPIC)
1857   - check whether changing LINT1 will queue an NMI (see the LVT entry for LINT1)
1858   - if so, issue KVM_NMI
1859   - resume the vcpu
1860
1861 Some guests configure the LINT1 NMI input to cause a panic, aiding in
1862 debugging.
1863
1864
1865 4.65 KVM_S390_UCAS_MAP
1866
1867 Capability: KVM_CAP_S390_UCONTROL
1868 Architectures: s390
1869 Type: vcpu ioctl
1870 Parameters: struct kvm_s390_ucas_mapping (in)
1871 Returns: 0 in case of success
1872
1873 The parameter is defined like this:
1874         struct kvm_s390_ucas_mapping {
1875                 __u64 user_addr;
1876                 __u64 vcpu_addr;
1877                 __u64 length;
1878         };
1879
1880 This ioctl maps the memory at "user_addr" with the length "length" to
1881 the vcpu's address space starting at "vcpu_addr". All parameters need to
1882 be aligned by 1 megabyte.
1883
1884
1885 4.66 KVM_S390_UCAS_UNMAP
1886
1887 Capability: KVM_CAP_S390_UCONTROL
1888 Architectures: s390
1889 Type: vcpu ioctl
1890 Parameters: struct kvm_s390_ucas_mapping (in)
1891 Returns: 0 in case of success
1892
1893 The parameter is defined like this:
1894         struct kvm_s390_ucas_mapping {
1895                 __u64 user_addr;
1896                 __u64 vcpu_addr;
1897                 __u64 length;
1898         };
1899
1900 This ioctl unmaps the memory in the vcpu's address space starting at
1901 "vcpu_addr" with the length "length". The field "user_addr" is ignored.
1902 All parameters need to be aligned by 1 megabyte.
1903
1904
1905 4.67 KVM_S390_VCPU_FAULT
1906
1907 Capability: KVM_CAP_S390_UCONTROL
1908 Architectures: s390
1909 Type: vcpu ioctl
1910 Parameters: vcpu absolute address (in)
1911 Returns: 0 in case of success
1912
1913 This call creates a page table entry on the virtual cpu's address space
1914 (for user controlled virtual machines) or the virtual machine's address
1915 space (for regular virtual machines). This only works for minor faults,
1916 thus it's recommended to access subject memory page via the user page
1917 table upfront. This is useful to handle validity intercepts for user
1918 controlled virtual machines to fault in the virtual cpu's lowcore pages
1919 prior to calling the KVM_RUN ioctl.
1920
1921
1922 4.68 KVM_SET_ONE_REG
1923
1924 Capability: KVM_CAP_ONE_REG
1925 Architectures: all
1926 Type: vcpu ioctl
1927 Parameters: struct kvm_one_reg (in)
1928 Returns: 0 on success, negative value on failure
1929
1930 struct kvm_one_reg {
1931        __u64 id;
1932        __u64 addr;
1933 };
1934
1935 Using this ioctl, a single vcpu register can be set to a specific value
1936 defined by user space with the passed in struct kvm_one_reg, where id
1937 refers to the register identifier as described below and addr is a pointer
1938 to a variable with the respective size. There can be architecture agnostic
1939 and architecture specific registers. Each have their own range of operation
1940 and their own constants and width. To keep track of the implemented
1941 registers, find a list below:
1942
1943   Arch  |           Register            | Width (bits)
1944         |                               |
1945   PPC   | KVM_REG_PPC_HIOR              | 64
1946   PPC   | KVM_REG_PPC_IAC1              | 64
1947   PPC   | KVM_REG_PPC_IAC2              | 64
1948   PPC   | KVM_REG_PPC_IAC3              | 64
1949   PPC   | KVM_REG_PPC_IAC4              | 64
1950   PPC   | KVM_REG_PPC_DAC1              | 64
1951   PPC   | KVM_REG_PPC_DAC2              | 64
1952   PPC   | KVM_REG_PPC_DABR              | 64
1953   PPC   | KVM_REG_PPC_DSCR              | 64
1954   PPC   | KVM_REG_PPC_PURR              | 64
1955   PPC   | KVM_REG_PPC_SPURR             | 64
1956   PPC   | KVM_REG_PPC_DAR               | 64
1957   PPC   | KVM_REG_PPC_DSISR             | 32
1958   PPC   | KVM_REG_PPC_AMR               | 64
1959   PPC   | KVM_REG_PPC_UAMOR             | 64
1960   PPC   | KVM_REG_PPC_MMCR0             | 64
1961   PPC   | KVM_REG_PPC_MMCR1             | 64
1962   PPC   | KVM_REG_PPC_MMCRA             | 64
1963   PPC   | KVM_REG_PPC_MMCR2             | 64
1964   PPC   | KVM_REG_PPC_MMCRS             | 64
1965   PPC   | KVM_REG_PPC_SIAR              | 64
1966   PPC   | KVM_REG_PPC_SDAR              | 64
1967   PPC   | KVM_REG_PPC_SIER              | 64
1968   PPC   | KVM_REG_PPC_PMC1              | 32
1969   PPC   | KVM_REG_PPC_PMC2              | 32
1970   PPC   | KVM_REG_PPC_PMC3              | 32
1971   PPC   | KVM_REG_PPC_PMC4              | 32
1972   PPC   | KVM_REG_PPC_PMC5              | 32
1973   PPC   | KVM_REG_PPC_PMC6              | 32
1974   PPC   | KVM_REG_PPC_PMC7              | 32
1975   PPC   | KVM_REG_PPC_PMC8              | 32
1976   PPC   | KVM_REG_PPC_FPR0              | 64
1977           ...
1978   PPC   | KVM_REG_PPC_FPR31             | 64
1979   PPC   | KVM_REG_PPC_VR0               | 128
1980           ...
1981   PPC   | KVM_REG_PPC_VR31              | 128
1982   PPC   | KVM_REG_PPC_VSR0              | 128
1983           ...
1984   PPC   | KVM_REG_PPC_VSR31             | 128
1985   PPC   | KVM_REG_PPC_FPSCR             | 64
1986   PPC   | KVM_REG_PPC_VSCR              | 32
1987   PPC   | KVM_REG_PPC_VPA_ADDR          | 64
1988   PPC   | KVM_REG_PPC_VPA_SLB           | 128
1989   PPC   | KVM_REG_PPC_VPA_DTL           | 128
1990   PPC   | KVM_REG_PPC_EPCR              | 32
1991   PPC   | KVM_REG_PPC_EPR               | 32
1992   PPC   | KVM_REG_PPC_TCR               | 32
1993   PPC   | KVM_REG_PPC_TSR               | 32
1994   PPC   | KVM_REG_PPC_OR_TSR            | 32
1995   PPC   | KVM_REG_PPC_CLEAR_TSR         | 32
1996   PPC   | KVM_REG_PPC_MAS0              | 32
1997   PPC   | KVM_REG_PPC_MAS1              | 32
1998   PPC   | KVM_REG_PPC_MAS2              | 64
1999   PPC   | KVM_REG_PPC_MAS7_3            | 64
2000   PPC   | KVM_REG_PPC_MAS4              | 32
2001   PPC   | KVM_REG_PPC_MAS6              | 32
2002   PPC   | KVM_REG_PPC_MMUCFG            | 32
2003   PPC   | KVM_REG_PPC_TLB0CFG           | 32
2004   PPC   | KVM_REG_PPC_TLB1CFG           | 32
2005   PPC   | KVM_REG_PPC_TLB2CFG           | 32
2006   PPC   | KVM_REG_PPC_TLB3CFG           | 32
2007   PPC   | KVM_REG_PPC_TLB0PS            | 32
2008   PPC   | KVM_REG_PPC_TLB1PS            | 32
2009   PPC   | KVM_REG_PPC_TLB2PS            | 32
2010   PPC   | KVM_REG_PPC_TLB3PS            | 32
2011   PPC   | KVM_REG_PPC_EPTCFG            | 32
2012   PPC   | KVM_REG_PPC_ICP_STATE         | 64
2013   PPC   | KVM_REG_PPC_TB_OFFSET         | 64
2014   PPC   | KVM_REG_PPC_SPMC1             | 32
2015   PPC   | KVM_REG_PPC_SPMC2             | 32
2016   PPC   | KVM_REG_PPC_IAMR              | 64
2017   PPC   | KVM_REG_PPC_TFHAR             | 64
2018   PPC   | KVM_REG_PPC_TFIAR             | 64
2019   PPC   | KVM_REG_PPC_TEXASR            | 64
2020   PPC   | KVM_REG_PPC_FSCR              | 64
2021   PPC   | KVM_REG_PPC_PSPB              | 32
2022   PPC   | KVM_REG_PPC_EBBHR             | 64
2023   PPC   | KVM_REG_PPC_EBBRR             | 64
2024   PPC   | KVM_REG_PPC_BESCR             | 64
2025   PPC   | KVM_REG_PPC_TAR               | 64
2026   PPC   | KVM_REG_PPC_DPDES             | 64
2027   PPC   | KVM_REG_PPC_DAWR              | 64
2028   PPC   | KVM_REG_PPC_DAWRX             | 64
2029   PPC   | KVM_REG_PPC_CIABR             | 64
2030   PPC   | KVM_REG_PPC_IC                | 64
2031   PPC   | KVM_REG_PPC_VTB               | 64
2032   PPC   | KVM_REG_PPC_CSIGR             | 64
2033   PPC   | KVM_REG_PPC_TACR              | 64
2034   PPC   | KVM_REG_PPC_TCSCR             | 64
2035   PPC   | KVM_REG_PPC_PID               | 64
2036   PPC   | KVM_REG_PPC_ACOP              | 64
2037   PPC   | KVM_REG_PPC_VRSAVE            | 32
2038   PPC   | KVM_REG_PPC_LPCR              | 32
2039   PPC   | KVM_REG_PPC_LPCR_64           | 64
2040   PPC   | KVM_REG_PPC_PPR               | 64
2041   PPC   | KVM_REG_PPC_ARCH_COMPAT       | 32
2042   PPC   | KVM_REG_PPC_DABRX             | 32
2043   PPC   | KVM_REG_PPC_WORT              | 64
2044   PPC   | KVM_REG_PPC_SPRG9             | 64
2045   PPC   | KVM_REG_PPC_DBSR              | 32
2046   PPC   | KVM_REG_PPC_TIDR              | 64
2047   PPC   | KVM_REG_PPC_PSSCR             | 64
2048   PPC   | KVM_REG_PPC_TM_GPR0           | 64
2049           ...
2050   PPC   | KVM_REG_PPC_TM_GPR31          | 64
2051   PPC   | KVM_REG_PPC_TM_VSR0           | 128
2052           ...
2053   PPC   | KVM_REG_PPC_TM_VSR63          | 128
2054   PPC   | KVM_REG_PPC_TM_CR             | 64
2055   PPC   | KVM_REG_PPC_TM_LR             | 64
2056   PPC   | KVM_REG_PPC_TM_CTR            | 64
2057   PPC   | KVM_REG_PPC_TM_FPSCR          | 64
2058   PPC   | KVM_REG_PPC_TM_AMR            | 64
2059   PPC   | KVM_REG_PPC_TM_PPR            | 64
2060   PPC   | KVM_REG_PPC_TM_VRSAVE         | 64
2061   PPC   | KVM_REG_PPC_TM_VSCR           | 32
2062   PPC   | KVM_REG_PPC_TM_DSCR           | 64
2063   PPC   | KVM_REG_PPC_TM_TAR            | 64
2064   PPC   | KVM_REG_PPC_TM_XER            | 64
2065         |                               |
2066   MIPS  | KVM_REG_MIPS_R0               | 64
2067           ...
2068   MIPS  | KVM_REG_MIPS_R31              | 64
2069   MIPS  | KVM_REG_MIPS_HI               | 64
2070   MIPS  | KVM_REG_MIPS_LO               | 64
2071   MIPS  | KVM_REG_MIPS_PC               | 64
2072   MIPS  | KVM_REG_MIPS_CP0_INDEX        | 32
2073   MIPS  | KVM_REG_MIPS_CP0_ENTRYLO0     | 64
2074   MIPS  | KVM_REG_MIPS_CP0_ENTRYLO1     | 64
2075   MIPS  | KVM_REG_MIPS_CP0_CONTEXT      | 64
2076   MIPS  | KVM_REG_MIPS_CP0_CONTEXTCONFIG| 32
2077   MIPS  | KVM_REG_MIPS_CP0_USERLOCAL    | 64
2078   MIPS  | KVM_REG_MIPS_CP0_XCONTEXTCONFIG| 64
2079   MIPS  | KVM_REG_MIPS_CP0_PAGEMASK     | 32
2080   MIPS  | KVM_REG_MIPS_CP0_PAGEGRAIN    | 32
2081   MIPS  | KVM_REG_MIPS_CP0_SEGCTL0      | 64
2082   MIPS  | KVM_REG_MIPS_CP0_SEGCTL1      | 64
2083   MIPS  | KVM_REG_MIPS_CP0_SEGCTL2      | 64
2084   MIPS  | KVM_REG_MIPS_CP0_WIRED        | 32
2085   MIPS  | KVM_REG_MIPS_CP0_HWRENA       | 32
2086   MIPS  | KVM_REG_MIPS_CP0_BADVADDR     | 64
2087   MIPS  | KVM_REG_MIPS_CP0_BADINSTR     | 32
2088   MIPS  | KVM_REG_MIPS_CP0_BADINSTRP    | 32
2089   MIPS  | KVM_REG_MIPS_CP0_COUNT        | 32
2090   MIPS  | KVM_REG_MIPS_CP0_ENTRYHI      | 64
2091   MIPS  | KVM_REG_MIPS_CP0_COMPARE      | 32
2092   MIPS  | KVM_REG_MIPS_CP0_STATUS       | 32
2093   MIPS  | KVM_REG_MIPS_CP0_INTCTL       | 32
2094   MIPS  | KVM_REG_MIPS_CP0_CAUSE        | 32
2095   MIPS  | KVM_REG_MIPS_CP0_EPC          | 64
2096   MIPS  | KVM_REG_MIPS_CP0_PRID         | 32
2097   MIPS  | KVM_REG_MIPS_CP0_EBASE        | 64
2098   MIPS  | KVM_REG_MIPS_CP0_CONFIG       | 32
2099   MIPS  | KVM_REG_MIPS_CP0_CONFIG1      | 32
2100   MIPS  | KVM_REG_MIPS_CP0_CONFIG2      | 32
2101   MIPS  | KVM_REG_MIPS_CP0_CONFIG3      | 32
2102   MIPS  | KVM_REG_MIPS_CP0_CONFIG4      | 32
2103   MIPS  | KVM_REG_MIPS_CP0_CONFIG5      | 32
2104   MIPS  | KVM_REG_MIPS_CP0_CONFIG7      | 32
2105   MIPS  | KVM_REG_MIPS_CP0_XCONTEXT     | 64
2106   MIPS  | KVM_REG_MIPS_CP0_ERROREPC     | 64
2107   MIPS  | KVM_REG_MIPS_CP0_KSCRATCH1    | 64
2108   MIPS  | KVM_REG_MIPS_CP0_KSCRATCH2    | 64
2109   MIPS  | KVM_REG_MIPS_CP0_KSCRATCH3    | 64
2110   MIPS  | KVM_REG_MIPS_CP0_KSCRATCH4    | 64
2111   MIPS  | KVM_REG_MIPS_CP0_KSCRATCH5    | 64
2112   MIPS  | KVM_REG_MIPS_CP0_KSCRATCH6    | 64
2113   MIPS  | KVM_REG_MIPS_COUNT_CTL        | 64
2114   MIPS  | KVM_REG_MIPS_COUNT_RESUME     | 64
2115   MIPS  | KVM_REG_MIPS_COUNT_HZ         | 64
2116   MIPS  | KVM_REG_MIPS_FPR_32(0..31)    | 32
2117   MIPS  | KVM_REG_MIPS_FPR_64(0..31)    | 64
2118   MIPS  | KVM_REG_MIPS_VEC_128(0..31)   | 128
2119   MIPS  | KVM_REG_MIPS_FCR_IR           | 32
2120   MIPS  | KVM_REG_MIPS_FCR_CSR          | 32
2121   MIPS  | KVM_REG_MIPS_MSA_IR           | 32
2122   MIPS  | KVM_REG_MIPS_MSA_CSR          | 32
2123
2124 ARM registers are mapped using the lower 32 bits.  The upper 16 of that
2125 is the register group type, or coprocessor number:
2126
2127 ARM core registers have the following id bit patterns:
2128   0x4020 0000 0010 <index into the kvm_regs struct:16>
2129
2130 ARM 32-bit CP15 registers have the following id bit patterns:
2131   0x4020 0000 000F <zero:1> <crn:4> <crm:4> <opc1:4> <opc2:3>
2132
2133 ARM 64-bit CP15 registers have the following id bit patterns:
2134   0x4030 0000 000F <zero:1> <zero:4> <crm:4> <opc1:4> <zero:3>
2135
2136 ARM CCSIDR registers are demultiplexed by CSSELR value:
2137   0x4020 0000 0011 00 <csselr:8>
2138
2139 ARM 32-bit VFP control registers have the following id bit patterns:
2140   0x4020 0000 0012 1 <regno:12>
2141
2142 ARM 64-bit FP registers have the following id bit patterns:
2143   0x4030 0000 0012 0 <regno:12>
2144
2145
2146 arm64 registers are mapped using the lower 32 bits. The upper 16 of
2147 that is the register group type, or coprocessor number:
2148
2149 arm64 core/FP-SIMD registers have the following id bit patterns. Note
2150 that the size of the access is variable, as the kvm_regs structure
2151 contains elements ranging from 32 to 128 bits. The index is a 32bit
2152 value in the kvm_regs structure seen as a 32bit array.
2153   0x60x0 0000 0010 <index into the kvm_regs struct:16>
2154
2155 arm64 CCSIDR registers are demultiplexed by CSSELR value:
2156   0x6020 0000 0011 00 <csselr:8>
2157
2158 arm64 system registers have the following id bit patterns:
2159   0x6030 0000 0013 <op0:2> <op1:3> <crn:4> <crm:4> <op2:3>
2160
2161
2162 MIPS registers are mapped using the lower 32 bits.  The upper 16 of that is
2163 the register group type:
2164
2165 MIPS core registers (see above) have the following id bit patterns:
2166   0x7030 0000 0000 <reg:16>
2167
2168 MIPS CP0 registers (see KVM_REG_MIPS_CP0_* above) have the following id bit
2169 patterns depending on whether they're 32-bit or 64-bit registers:
2170   0x7020 0000 0001 00 <reg:5> <sel:3>   (32-bit)
2171   0x7030 0000 0001 00 <reg:5> <sel:3>   (64-bit)
2172
2173 Note: KVM_REG_MIPS_CP0_ENTRYLO0 and KVM_REG_MIPS_CP0_ENTRYLO1 are the MIPS64
2174 versions of the EntryLo registers regardless of the word size of the host
2175 hardware, host kernel, guest, and whether XPA is present in the guest, i.e.
2176 with the RI and XI bits (if they exist) in bits 63 and 62 respectively, and
2177 the PFNX field starting at bit 30.
2178
2179 MIPS KVM control registers (see above) have the following id bit patterns:
2180   0x7030 0000 0002 <reg:16>
2181
2182 MIPS FPU registers (see KVM_REG_MIPS_FPR_{32,64}() above) have the following
2183 id bit patterns depending on the size of the register being accessed. They are
2184 always accessed according to the current guest FPU mode (Status.FR and
2185 Config5.FRE), i.e. as the guest would see them, and they become unpredictable
2186 if the guest FPU mode is changed. MIPS SIMD Architecture (MSA) vector
2187 registers (see KVM_REG_MIPS_VEC_128() above) have similar patterns as they
2188 overlap the FPU registers:
2189   0x7020 0000 0003 00 <0:3> <reg:5> (32-bit FPU registers)
2190   0x7030 0000 0003 00 <0:3> <reg:5> (64-bit FPU registers)
2191   0x7040 0000 0003 00 <0:3> <reg:5> (128-bit MSA vector registers)
2192
2193 MIPS FPU control registers (see KVM_REG_MIPS_FCR_{IR,CSR} above) have the
2194 following id bit patterns:
2195   0x7020 0000 0003 01 <0:3> <reg:5>
2196
2197 MIPS MSA control registers (see KVM_REG_MIPS_MSA_{IR,CSR} above) have the
2198 following id bit patterns:
2199   0x7020 0000 0003 02 <0:3> <reg:5>
2200
2201
2202 4.69 KVM_GET_ONE_REG
2203
2204 Capability: KVM_CAP_ONE_REG
2205 Architectures: all
2206 Type: vcpu ioctl
2207 Parameters: struct kvm_one_reg (in and out)
2208 Returns: 0 on success, negative value on failure
2209
2210 This ioctl allows to receive the value of a single register implemented
2211 in a vcpu. The register to read is indicated by the "id" field of the
2212 kvm_one_reg struct passed in. On success, the register value can be found
2213 at the memory location pointed to by "addr".
2214
2215 The list of registers accessible using this interface is identical to the
2216 list in 4.68.
2217
2218
2219 4.70 KVM_KVMCLOCK_CTRL
2220
2221 Capability: KVM_CAP_KVMCLOCK_CTRL
2222 Architectures: Any that implement pvclocks (currently x86 only)
2223 Type: vcpu ioctl
2224 Parameters: None
2225 Returns: 0 on success, -1 on error
2226
2227 This signals to the host kernel that the specified guest is being paused by
2228 userspace.  The host will set a flag in the pvclock structure that is checked
2229 from the soft lockup watchdog.  The flag is part of the pvclock structure that
2230 is shared between guest and host, specifically the second bit of the flags
2231 field of the pvclock_vcpu_time_info structure.  It will be set exclusively by
2232 the host and read/cleared exclusively by the guest.  The guest operation of
2233 checking and clearing the flag must an atomic operation so
2234 load-link/store-conditional, or equivalent must be used.  There are two cases
2235 where the guest will clear the flag: when the soft lockup watchdog timer resets
2236 itself or when a soft lockup is detected.  This ioctl can be called any time
2237 after pausing the vcpu, but before it is resumed.
2238
2239
2240 4.71 KVM_SIGNAL_MSI
2241
2242 Capability: KVM_CAP_SIGNAL_MSI
2243 Architectures: x86 arm arm64
2244 Type: vm ioctl
2245 Parameters: struct kvm_msi (in)
2246 Returns: >0 on delivery, 0 if guest blocked the MSI, and -1 on error
2247
2248 Directly inject a MSI message. Only valid with in-kernel irqchip that handles
2249 MSI messages.
2250
2251 struct kvm_msi {
2252         __u32 address_lo;
2253         __u32 address_hi;
2254         __u32 data;
2255         __u32 flags;
2256         __u32 devid;
2257         __u8  pad[12];
2258 };
2259
2260 flags: KVM_MSI_VALID_DEVID: devid contains a valid value.  The per-VM
2261   KVM_CAP_MSI_DEVID capability advertises the requirement to provide
2262   the device ID.  If this capability is not available, userspace
2263   should never set the KVM_MSI_VALID_DEVID flag as the ioctl might fail.
2264
2265 If KVM_MSI_VALID_DEVID is set, devid contains a unique device identifier
2266 for the device that wrote the MSI message.  For PCI, this is usually a
2267 BFD identifier in the lower 16 bits.
2268
2269 On x86, address_hi is ignored unless the KVM_X2APIC_API_USE_32BIT_IDS
2270 feature of KVM_CAP_X2APIC_API capability is enabled.  If it is enabled,
2271 address_hi bits 31-8 provide bits 31-8 of the destination id.  Bits 7-0 of
2272 address_hi must be zero.
2273
2274
2275 4.71 KVM_CREATE_PIT2
2276
2277 Capability: KVM_CAP_PIT2
2278 Architectures: x86
2279 Type: vm ioctl
2280 Parameters: struct kvm_pit_config (in)
2281 Returns: 0 on success, -1 on error
2282
2283 Creates an in-kernel device model for the i8254 PIT. This call is only valid
2284 after enabling in-kernel irqchip support via KVM_CREATE_IRQCHIP. The following
2285 parameters have to be passed:
2286
2287 struct kvm_pit_config {
2288         __u32 flags;
2289         __u32 pad[15];
2290 };
2291
2292 Valid flags are:
2293
2294 #define KVM_PIT_SPEAKER_DUMMY     1 /* emulate speaker port stub */
2295
2296 PIT timer interrupts may use a per-VM kernel thread for injection. If it
2297 exists, this thread will have a name of the following pattern:
2298
2299 kvm-pit/<owner-process-pid>
2300
2301 When running a guest with elevated priorities, the scheduling parameters of
2302 this thread may have to be adjusted accordingly.
2303
2304 This IOCTL replaces the obsolete KVM_CREATE_PIT.
2305
2306
2307 4.72 KVM_GET_PIT2
2308
2309 Capability: KVM_CAP_PIT_STATE2
2310 Architectures: x86
2311 Type: vm ioctl
2312 Parameters: struct kvm_pit_state2 (out)
2313 Returns: 0 on success, -1 on error
2314
2315 Retrieves the state of the in-kernel PIT model. Only valid after
2316 KVM_CREATE_PIT2. The state is returned in the following structure:
2317
2318 struct kvm_pit_state2 {
2319         struct kvm_pit_channel_state channels[3];
2320         __u32 flags;
2321         __u32 reserved[9];
2322 };
2323
2324 Valid flags are:
2325
2326 /* disable PIT in HPET legacy mode */
2327 #define KVM_PIT_FLAGS_HPET_LEGACY  0x00000001
2328
2329 This IOCTL replaces the obsolete KVM_GET_PIT.
2330
2331
2332 4.73 KVM_SET_PIT2
2333
2334 Capability: KVM_CAP_PIT_STATE2
2335 Architectures: x86
2336 Type: vm ioctl
2337 Parameters: struct kvm_pit_state2 (in)
2338 Returns: 0 on success, -1 on error
2339
2340 Sets the state of the in-kernel PIT model. Only valid after KVM_CREATE_PIT2.
2341 See KVM_GET_PIT2 for details on struct kvm_pit_state2.
2342
2343 This IOCTL replaces the obsolete KVM_SET_PIT.
2344
2345
2346 4.74 KVM_PPC_GET_SMMU_INFO
2347
2348 Capability: KVM_CAP_PPC_GET_SMMU_INFO
2349 Architectures: powerpc
2350 Type: vm ioctl
2351 Parameters: None
2352 Returns: 0 on success, -1 on error
2353
2354 This populates and returns a structure describing the features of
2355 the "Server" class MMU emulation supported by KVM.
2356 This can in turn be used by userspace to generate the appropriate
2357 device-tree properties for the guest operating system.
2358
2359 The structure contains some global information, followed by an
2360 array of supported segment page sizes:
2361
2362       struct kvm_ppc_smmu_info {
2363              __u64 flags;
2364              __u32 slb_size;
2365              __u32 pad;
2366              struct kvm_ppc_one_seg_page_size sps[KVM_PPC_PAGE_SIZES_MAX_SZ];
2367       };
2368
2369 The supported flags are:
2370
2371     - KVM_PPC_PAGE_SIZES_REAL:
2372         When that flag is set, guest page sizes must "fit" the backing
2373         store page sizes. When not set, any page size in the list can
2374         be used regardless of how they are backed by userspace.
2375
2376     - KVM_PPC_1T_SEGMENTS
2377         The emulated MMU supports 1T segments in addition to the
2378         standard 256M ones.
2379
2380 The "slb_size" field indicates how many SLB entries are supported
2381
2382 The "sps" array contains 8 entries indicating the supported base
2383 page sizes for a segment in increasing order. Each entry is defined
2384 as follow:
2385
2386    struct kvm_ppc_one_seg_page_size {
2387         __u32 page_shift;       /* Base page shift of segment (or 0) */
2388         __u32 slb_enc;          /* SLB encoding for BookS */
2389         struct kvm_ppc_one_page_size enc[KVM_PPC_PAGE_SIZES_MAX_SZ];
2390    };
2391
2392 An entry with a "page_shift" of 0 is unused. Because the array is
2393 organized in increasing order, a lookup can stop when encoutering
2394 such an entry.
2395
2396 The "slb_enc" field provides the encoding to use in the SLB for the
2397 page size. The bits are in positions such as the value can directly
2398 be OR'ed into the "vsid" argument of the slbmte instruction.
2399
2400 The "enc" array is a list which for each of those segment base page
2401 size provides the list of supported actual page sizes (which can be
2402 only larger or equal to the base page size), along with the
2403 corresponding encoding in the hash PTE. Similarly, the array is
2404 8 entries sorted by increasing sizes and an entry with a "0" shift
2405 is an empty entry and a terminator:
2406
2407    struct kvm_ppc_one_page_size {
2408         __u32 page_shift;       /* Page shift (or 0) */
2409         __u32 pte_enc;          /* Encoding in the HPTE (>>12) */
2410    };
2411
2412 The "pte_enc" field provides a value that can OR'ed into the hash
2413 PTE's RPN field (ie, it needs to be shifted left by 12 to OR it
2414 into the hash PTE second double word).
2415
2416 4.75 KVM_IRQFD
2417
2418 Capability: KVM_CAP_IRQFD
2419 Architectures: x86 s390 arm arm64
2420 Type: vm ioctl
2421 Parameters: struct kvm_irqfd (in)
2422 Returns: 0 on success, -1 on error
2423
2424 Allows setting an eventfd to directly trigger a guest interrupt.
2425 kvm_irqfd.fd specifies the file descriptor to use as the eventfd and
2426 kvm_irqfd.gsi specifies the irqchip pin toggled by this event.  When
2427 an event is triggered on the eventfd, an interrupt is injected into
2428 the guest using the specified gsi pin.  The irqfd is removed using
2429 the KVM_IRQFD_FLAG_DEASSIGN flag, specifying both kvm_irqfd.fd
2430 and kvm_irqfd.gsi.
2431
2432 With KVM_CAP_IRQFD_RESAMPLE, KVM_IRQFD supports a de-assert and notify
2433 mechanism allowing emulation of level-triggered, irqfd-based
2434 interrupts.  When KVM_IRQFD_FLAG_RESAMPLE is set the user must pass an
2435 additional eventfd in the kvm_irqfd.resamplefd field.  When operating
2436 in resample mode, posting of an interrupt through kvm_irq.fd asserts
2437 the specified gsi in the irqchip.  When the irqchip is resampled, such
2438 as from an EOI, the gsi is de-asserted and the user is notified via
2439 kvm_irqfd.resamplefd.  It is the user's responsibility to re-queue
2440 the interrupt if the device making use of it still requires service.
2441 Note that closing the resamplefd is not sufficient to disable the
2442 irqfd.  The KVM_IRQFD_FLAG_RESAMPLE is only necessary on assignment
2443 and need not be specified with KVM_IRQFD_FLAG_DEASSIGN.
2444
2445 On arm/arm64, gsi routing being supported, the following can happen:
2446 - in case no routing entry is associated to this gsi, injection fails
2447 - in case the gsi is associated to an irqchip routing entry,
2448   irqchip.pin + 32 corresponds to the injected SPI ID.
2449 - in case the gsi is associated to an MSI routing entry, the MSI
2450   message and device ID are translated into an LPI (support restricted
2451   to GICv3 ITS in-kernel emulation).
2452
2453 4.76 KVM_PPC_ALLOCATE_HTAB
2454
2455 Capability: KVM_CAP_PPC_ALLOC_HTAB
2456 Architectures: powerpc
2457 Type: vm ioctl
2458 Parameters: Pointer to u32 containing hash table order (in/out)
2459 Returns: 0 on success, -1 on error
2460
2461 This requests the host kernel to allocate an MMU hash table for a
2462 guest using the PAPR paravirtualization interface.  This only does
2463 anything if the kernel is configured to use the Book 3S HV style of
2464 virtualization.  Otherwise the capability doesn't exist and the ioctl
2465 returns an ENOTTY error.  The rest of this description assumes Book 3S
2466 HV.
2467
2468 There must be no vcpus running when this ioctl is called; if there
2469 are, it will do nothing and return an EBUSY error.
2470
2471 The parameter is a pointer to a 32-bit unsigned integer variable
2472 containing the order (log base 2) of the desired size of the hash
2473 table, which must be between 18 and 46.  On successful return from the
2474 ioctl, the value will not be changed by the kernel.
2475
2476 If no hash table has been allocated when any vcpu is asked to run
2477 (with the KVM_RUN ioctl), the host kernel will allocate a
2478 default-sized hash table (16 MB).
2479
2480 If this ioctl is called when a hash table has already been allocated,
2481 with a different order from the existing hash table, the existing hash
2482 table will be freed and a new one allocated.  If this is ioctl is
2483 called when a hash table has already been allocated of the same order
2484 as specified, the kernel will clear out the existing hash table (zero
2485 all HPTEs).  In either case, if the guest is using the virtualized
2486 real-mode area (VRMA) facility, the kernel will re-create the VMRA
2487 HPTEs on the next KVM_RUN of any vcpu.
2488
2489 4.77 KVM_S390_INTERRUPT
2490
2491 Capability: basic
2492 Architectures: s390
2493 Type: vm ioctl, vcpu ioctl
2494 Parameters: struct kvm_s390_interrupt (in)
2495 Returns: 0 on success, -1 on error
2496
2497 Allows to inject an interrupt to the guest. Interrupts can be floating
2498 (vm ioctl) or per cpu (vcpu ioctl), depending on the interrupt type.
2499
2500 Interrupt parameters are passed via kvm_s390_interrupt:
2501
2502 struct kvm_s390_interrupt {
2503         __u32 type;
2504         __u32 parm;
2505         __u64 parm64;
2506 };
2507
2508 type can be one of the following:
2509
2510 KVM_S390_SIGP_STOP (vcpu) - sigp stop; optional flags in parm
2511 KVM_S390_PROGRAM_INT (vcpu) - program check; code in parm
2512 KVM_S390_SIGP_SET_PREFIX (vcpu) - sigp set prefix; prefix address in parm
2513 KVM_S390_RESTART (vcpu) - restart
2514 KVM_S390_INT_CLOCK_COMP (vcpu) - clock comparator interrupt
2515 KVM_S390_INT_CPU_TIMER (vcpu) - CPU timer interrupt
2516 KVM_S390_INT_VIRTIO (vm) - virtio external interrupt; external interrupt
2517                            parameters in parm and parm64
2518 KVM_S390_INT_SERVICE (vm) - sclp external interrupt; sclp parameter in parm
2519 KVM_S390_INT_EMERGENCY (vcpu) - sigp emergency; source cpu in parm
2520 KVM_S390_INT_EXTERNAL_CALL (vcpu) - sigp external call; source cpu in parm
2521 KVM_S390_INT_IO(ai,cssid,ssid,schid) (vm) - compound value to indicate an
2522     I/O interrupt (ai - adapter interrupt; cssid,ssid,schid - subchannel);
2523     I/O interruption parameters in parm (subchannel) and parm64 (intparm,
2524     interruption subclass)
2525 KVM_S390_MCHK (vm, vcpu) - machine check interrupt; cr 14 bits in parm,
2526                            machine check interrupt code in parm64 (note that
2527                            machine checks needing further payload are not
2528                            supported by this ioctl)
2529
2530 Note that the vcpu ioctl is asynchronous to vcpu execution.
2531
2532 4.78 KVM_PPC_GET_HTAB_FD
2533
2534 Capability: KVM_CAP_PPC_HTAB_FD
2535 Architectures: powerpc
2536 Type: vm ioctl
2537 Parameters: Pointer to struct kvm_get_htab_fd (in)
2538 Returns: file descriptor number (>= 0) on success, -1 on error
2539
2540 This returns a file descriptor that can be used either to read out the
2541 entries in the guest's hashed page table (HPT), or to write entries to
2542 initialize the HPT.  The returned fd can only be written to if the
2543 KVM_GET_HTAB_WRITE bit is set in the flags field of the argument, and
2544 can only be read if that bit is clear.  The argument struct looks like
2545 this:
2546
2547 /* For KVM_PPC_GET_HTAB_FD */
2548 struct kvm_get_htab_fd {
2549         __u64   flags;
2550         __u64   start_index;
2551         __u64   reserved[2];
2552 };
2553
2554 /* Values for kvm_get_htab_fd.flags */
2555 #define KVM_GET_HTAB_BOLTED_ONLY        ((__u64)0x1)
2556 #define KVM_GET_HTAB_WRITE              ((__u64)0x2)
2557
2558 The `start_index' field gives the index in the HPT of the entry at
2559 which to start reading.  It is ignored when writing.
2560
2561 Reads on the fd will initially supply information about all
2562 "interesting" HPT entries.  Interesting entries are those with the
2563 bolted bit set, if the KVM_GET_HTAB_BOLTED_ONLY bit is set, otherwise
2564 all entries.  When the end of the HPT is reached, the read() will
2565 return.  If read() is called again on the fd, it will start again from
2566 the beginning of the HPT, but will only return HPT entries that have
2567 changed since they were last read.
2568
2569 Data read or written is structured as a header (8 bytes) followed by a
2570 series of valid HPT entries (16 bytes) each.  The header indicates how
2571 many valid HPT entries there are and how many invalid entries follow
2572 the valid entries.  The invalid entries are not represented explicitly
2573 in the stream.  The header format is:
2574
2575 struct kvm_get_htab_header {
2576         __u32   index;
2577         __u16   n_valid;
2578         __u16   n_invalid;
2579 };
2580
2581 Writes to the fd create HPT entries starting at the index given in the
2582 header; first `n_valid' valid entries with contents from the data
2583 written, then `n_invalid' invalid entries, invalidating any previously
2584 valid entries found.
2585
2586 4.79 KVM_CREATE_DEVICE
2587
2588 Capability: KVM_CAP_DEVICE_CTRL
2589 Type: vm ioctl
2590 Parameters: struct kvm_create_device (in/out)
2591 Returns: 0 on success, -1 on error
2592 Errors:
2593   ENODEV: The device type is unknown or unsupported
2594   EEXIST: Device already created, and this type of device may not
2595           be instantiated multiple times
2596
2597   Other error conditions may be defined by individual device types or
2598   have their standard meanings.
2599
2600 Creates an emulated device in the kernel.  The file descriptor returned
2601 in fd can be used with KVM_SET/GET/HAS_DEVICE_ATTR.
2602
2603 If the KVM_CREATE_DEVICE_TEST flag is set, only test whether the
2604 device type is supported (not necessarily whether it can be created
2605 in the current vm).
2606
2607 Individual devices should not define flags.  Attributes should be used
2608 for specifying any behavior that is not implied by the device type
2609 number.
2610
2611 struct kvm_create_device {
2612         __u32   type;   /* in: KVM_DEV_TYPE_xxx */
2613         __u32   fd;     /* out: device handle */
2614         __u32   flags;  /* in: KVM_CREATE_DEVICE_xxx */
2615 };
2616
2617 4.80 KVM_SET_DEVICE_ATTR/KVM_GET_DEVICE_ATTR
2618
2619 Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
2620   KVM_CAP_VCPU_ATTRIBUTES for vcpu device
2621 Type: device ioctl, vm ioctl, vcpu ioctl
2622 Parameters: struct kvm_device_attr
2623 Returns: 0 on success, -1 on error
2624 Errors:
2625   ENXIO:  The group or attribute is unknown/unsupported for this device
2626           or hardware support is missing.
2627   EPERM:  The attribute cannot (currently) be accessed this way
2628           (e.g. read-only attribute, or attribute that only makes
2629           sense when the device is in a different state)
2630
2631   Other error conditions may be defined by individual device types.
2632
2633 Gets/sets a specified piece of device configuration and/or state.  The
2634 semantics are device-specific.  See individual device documentation in
2635 the "devices" directory.  As with ONE_REG, the size of the data
2636 transferred is defined by the particular attribute.
2637
2638 struct kvm_device_attr {
2639         __u32   flags;          /* no flags currently defined */
2640         __u32   group;          /* device-defined */
2641         __u64   attr;           /* group-defined */
2642         __u64   addr;           /* userspace address of attr data */
2643 };
2644
2645 4.81 KVM_HAS_DEVICE_ATTR
2646
2647 Capability: KVM_CAP_DEVICE_CTRL, KVM_CAP_VM_ATTRIBUTES for vm device,
2648   KVM_CAP_VCPU_ATTRIBUTES for vcpu device
2649 Type: device ioctl, vm ioctl, vcpu ioctl
2650 Parameters: struct kvm_device_attr
2651 Returns: 0 on success, -1 on error
2652 Errors:
2653   ENXIO:  The group or attribute is unknown/unsupported for this device
2654           or hardware support is missing.
2655
2656 Tests whether a device supports a particular attribute.  A successful
2657 return indicates the attribute is implemented.  It does not necessarily
2658 indicate that the attribute can be read or written in the device's
2659 current state.  "addr" is ignored.
2660
2661 4.82 KVM_ARM_VCPU_INIT
2662
2663 Capability: basic
2664 Architectures: arm, arm64
2665 Type: vcpu ioctl
2666 Parameters: struct kvm_vcpu_init (in)
2667 Returns: 0 on success; -1 on error
2668 Errors:
2669  Â EINVAL: Â Â Â the target is unknown, or the combination of features is invalid.
2670  Â ENOENT: Â Â Â a features bit specified is unknown.
2671
2672 This tells KVM what type of CPU to present to the guest, and what
2673 optional features it should have. Â This will cause a reset of the cpu
2674 registers to their initial values. Â If this is not called, KVM_RUN will
2675 return ENOEXEC for that vcpu.
2676
2677 Note that because some registers reflect machine topology, all vcpus
2678 should be created before this ioctl is invoked.
2679
2680 Userspace can call this function multiple times for a given vcpu, including
2681 after the vcpu has been run. This will reset the vcpu to its initial
2682 state. All calls to this function after the initial call must use the same
2683 target and same set of feature flags, otherwise EINVAL will be returned.
2684
2685 Possible features:
2686         - KVM_ARM_VCPU_POWER_OFF: Starts the CPU in a power-off state.
2687           Depends on KVM_CAP_ARM_PSCI.  If not set, the CPU will be powered on
2688           and execute guest code when KVM_RUN is called.
2689         - KVM_ARM_VCPU_EL1_32BIT: Starts the CPU in a 32bit mode.
2690           Depends on KVM_CAP_ARM_EL1_32BIT (arm64 only).
2691         - KVM_ARM_VCPU_PSCI_0_2: Emulate PSCI v0.2 for the CPU.
2692           Depends on KVM_CAP_ARM_PSCI_0_2.
2693         - KVM_ARM_VCPU_PMU_V3: Emulate PMUv3 for the CPU.
2694           Depends on KVM_CAP_ARM_PMU_V3.
2695
2696
2697 4.83 KVM_ARM_PREFERRED_TARGET
2698
2699 Capability: basic
2700 Architectures: arm, arm64
2701 Type: vm ioctl
2702 Parameters: struct struct kvm_vcpu_init (out)
2703 Returns: 0 on success; -1 on error
2704 Errors:
2705   ENODEV:    no preferred target available for the host
2706
2707 This queries KVM for preferred CPU target type which can be emulated
2708 by KVM on underlying host.
2709
2710 The ioctl returns struct kvm_vcpu_init instance containing information
2711 about preferred CPU target type and recommended features for it.  The
2712 kvm_vcpu_init->features bitmap returned will have feature bits set if
2713 the preferred target recommends setting these features, but this is
2714 not mandatory.
2715
2716 The information returned by this ioctl can be used to prepare an instance
2717 of struct kvm_vcpu_init for KVM_ARM_VCPU_INIT ioctl which will result in
2718 in VCPU matching underlying host.
2719
2720
2721 4.84 KVM_GET_REG_LIST
2722
2723 Capability: basic
2724 Architectures: arm, arm64, mips
2725 Type: vcpu ioctl
2726 Parameters: struct kvm_reg_list (in/out)
2727 Returns: 0 on success; -1 on error
2728 Errors:
2729  Â E2BIG: Â Â Â Â the reg index list is too big to fit in the array specified by
2730  Â Â Â Â Â Â Â Â Â Â Â Â the user (the number required will be written into n).
2731
2732 struct kvm_reg_list {
2733         __u64 n; /* number of registers in reg[] */
2734         __u64 reg[0];
2735 };
2736
2737 This ioctl returns the guest registers that are supported for the
2738 KVM_GET_ONE_REG/KVM_SET_ONE_REG calls.
2739
2740
2741 4.85 KVM_ARM_SET_DEVICE_ADDR (deprecated)
2742
2743 Capability: KVM_CAP_ARM_SET_DEVICE_ADDR
2744 Architectures: arm, arm64
2745 Type: vm ioctl
2746 Parameters: struct kvm_arm_device_address (in)
2747 Returns: 0 on success, -1 on error
2748 Errors:
2749   ENODEV: The device id is unknown
2750   ENXIO:  Device not supported on current system
2751   EEXIST: Address already set
2752   E2BIG:  Address outside guest physical address space
2753   EBUSY:  Address overlaps with other device range
2754
2755 struct kvm_arm_device_addr {
2756         __u64 id;
2757         __u64 addr;
2758 };
2759
2760 Specify a device address in the guest's physical address space where guests
2761 can access emulated or directly exposed devices, which the host kernel needs
2762 to know about. The id field is an architecture specific identifier for a
2763 specific device.
2764
2765 ARM/arm64 divides the id field into two parts, a device id and an
2766 address type id specific to the individual device.
2767
2768  Â bits:  | 63        ...       32 | 31    ...    16 | 15    ...    0 |
2769   field: |        0x00000000      |     device id   |  addr type id  |
2770
2771 ARM/arm64 currently only require this when using the in-kernel GIC
2772 support for the hardware VGIC features, using KVM_ARM_DEVICE_VGIC_V2
2773 as the device id.  When setting the base address for the guest's
2774 mapping of the VGIC virtual CPU and distributor interface, the ioctl
2775 must be called after calling KVM_CREATE_IRQCHIP, but before calling
2776 KVM_RUN on any of the VCPUs.  Calling this ioctl twice for any of the
2777 base addresses will return -EEXIST.
2778
2779 Note, this IOCTL is deprecated and the more flexible SET/GET_DEVICE_ATTR API
2780 should be used instead.
2781
2782
2783 4.86 KVM_PPC_RTAS_DEFINE_TOKEN
2784
2785 Capability: KVM_CAP_PPC_RTAS
2786 Architectures: ppc
2787 Type: vm ioctl
2788 Parameters: struct kvm_rtas_token_args
2789 Returns: 0 on success, -1 on error
2790
2791 Defines a token value for a RTAS (Run Time Abstraction Services)
2792 service in order to allow it to be handled in the kernel.  The
2793 argument struct gives the name of the service, which must be the name
2794 of a service that has a kernel-side implementation.  If the token
2795 value is non-zero, it will be associated with that service, and
2796 subsequent RTAS calls by the guest specifying that token will be
2797 handled by the kernel.  If the token value is 0, then any token
2798 associated with the service will be forgotten, and subsequent RTAS
2799 calls by the guest for that service will be passed to userspace to be
2800 handled.
2801
2802 4.87 KVM_SET_GUEST_DEBUG
2803
2804 Capability: KVM_CAP_SET_GUEST_DEBUG
2805 Architectures: x86, s390, ppc, arm64
2806 Type: vcpu ioctl
2807 Parameters: struct kvm_guest_debug (in)
2808 Returns: 0 on success; -1 on error
2809
2810 struct kvm_guest_debug {
2811        __u32 control;
2812        __u32 pad;
2813        struct kvm_guest_debug_arch arch;
2814 };
2815
2816 Set up the processor specific debug registers and configure vcpu for
2817 handling guest debug events. There are two parts to the structure, the
2818 first a control bitfield indicates the type of debug events to handle
2819 when running. Common control bits are:
2820
2821   - KVM_GUESTDBG_ENABLE:        guest debugging is enabled
2822   - KVM_GUESTDBG_SINGLESTEP:    the next run should single-step
2823
2824 The top 16 bits of the control field are architecture specific control
2825 flags which can include the following:
2826
2827   - KVM_GUESTDBG_USE_SW_BP:     using software breakpoints [x86, arm64]
2828   - KVM_GUESTDBG_USE_HW_BP:     using hardware breakpoints [x86, s390, arm64]
2829   - KVM_GUESTDBG_INJECT_DB:     inject DB type exception [x86]
2830   - KVM_GUESTDBG_INJECT_BP:     inject BP type exception [x86]
2831   - KVM_GUESTDBG_EXIT_PENDING:  trigger an immediate guest exit [s390]
2832
2833 For example KVM_GUESTDBG_USE_SW_BP indicates that software breakpoints
2834 are enabled in memory so we need to ensure breakpoint exceptions are
2835 correctly trapped and the KVM run loop exits at the breakpoint and not
2836 running off into the normal guest vector. For KVM_GUESTDBG_USE_HW_BP
2837 we need to ensure the guest vCPUs architecture specific registers are
2838 updated to the correct (supplied) values.
2839
2840 The second part of the structure is architecture specific and
2841 typically contains a set of debug registers.
2842
2843 For arm64 the number of debug registers is implementation defined and
2844 can be determined by querying the KVM_CAP_GUEST_DEBUG_HW_BPS and
2845 KVM_CAP_GUEST_DEBUG_HW_WPS capabilities which return a positive number
2846 indicating the number of supported registers.
2847
2848 When debug events exit the main run loop with the reason
2849 KVM_EXIT_DEBUG with the kvm_debug_exit_arch part of the kvm_run
2850 structure containing architecture specific debug information.
2851
2852 4.88 KVM_GET_EMULATED_CPUID
2853
2854 Capability: KVM_CAP_EXT_EMUL_CPUID
2855 Architectures: x86
2856 Type: system ioctl
2857 Parameters: struct kvm_cpuid2 (in/out)
2858 Returns: 0 on success, -1 on error
2859
2860 struct kvm_cpuid2 {
2861         __u32 nent;
2862         __u32 flags;
2863         struct kvm_cpuid_entry2 entries[0];
2864 };
2865
2866 The member 'flags' is used for passing flags from userspace.
2867
2868 #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX         BIT(0)
2869 #define KVM_CPUID_FLAG_STATEFUL_FUNC            BIT(1)
2870 #define KVM_CPUID_FLAG_STATE_READ_NEXT          BIT(2)
2871
2872 struct kvm_cpuid_entry2 {
2873         __u32 function;
2874         __u32 index;
2875         __u32 flags;
2876         __u32 eax;
2877         __u32 ebx;
2878         __u32 ecx;
2879         __u32 edx;
2880         __u32 padding[3];
2881 };
2882
2883 This ioctl returns x86 cpuid features which are emulated by
2884 kvm.Userspace can use the information returned by this ioctl to query
2885 which features are emulated by kvm instead of being present natively.
2886
2887 Userspace invokes KVM_GET_EMULATED_CPUID by passing a kvm_cpuid2
2888 structure with the 'nent' field indicating the number of entries in
2889 the variable-size array 'entries'. If the number of entries is too low
2890 to describe the cpu capabilities, an error (E2BIG) is returned. If the
2891 number is too high, the 'nent' field is adjusted and an error (ENOMEM)
2892 is returned. If the number is just right, the 'nent' field is adjusted
2893 to the number of valid entries in the 'entries' array, which is then
2894 filled.
2895
2896 The entries returned are the set CPUID bits of the respective features
2897 which kvm emulates, as returned by the CPUID instruction, with unknown
2898 or unsupported feature bits cleared.
2899
2900 Features like x2apic, for example, may not be present in the host cpu
2901 but are exposed by kvm in KVM_GET_SUPPORTED_CPUID because they can be
2902 emulated efficiently and thus not included here.
2903
2904 The fields in each entry are defined as follows:
2905
2906   function: the eax value used to obtain the entry
2907   index: the ecx value used to obtain the entry (for entries that are
2908          affected by ecx)
2909   flags: an OR of zero or more of the following:
2910         KVM_CPUID_FLAG_SIGNIFCANT_INDEX:
2911            if the index field is valid
2912         KVM_CPUID_FLAG_STATEFUL_FUNC:
2913            if cpuid for this function returns different values for successive
2914            invocations; there will be several entries with the same function,
2915            all with this flag set
2916         KVM_CPUID_FLAG_STATE_READ_NEXT:
2917            for KVM_CPUID_FLAG_STATEFUL_FUNC entries, set if this entry is
2918            the first entry to be read by a cpu
2919    eax, ebx, ecx, edx: the values returned by the cpuid instruction for
2920          this function/index combination
2921
2922 4.89 KVM_S390_MEM_OP
2923
2924 Capability: KVM_CAP_S390_MEM_OP
2925 Architectures: s390
2926 Type: vcpu ioctl
2927 Parameters: struct kvm_s390_mem_op (in)
2928 Returns: = 0 on success,
2929          < 0 on generic error (e.g. -EFAULT or -ENOMEM),
2930          > 0 if an exception occurred while walking the page tables
2931
2932 Read or write data from/to the logical (virtual) memory of a VCPU.
2933
2934 Parameters are specified via the following structure:
2935
2936 struct kvm_s390_mem_op {
2937         __u64 gaddr;            /* the guest address */
2938         __u64 flags;            /* flags */
2939         __u32 size;             /* amount of bytes */
2940         __u32 op;               /* type of operation */
2941         __u64 buf;              /* buffer in userspace */
2942         __u8 ar;                /* the access register number */
2943         __u8 reserved[31];      /* should be set to 0 */
2944 };
2945
2946 The type of operation is specified in the "op" field. It is either
2947 KVM_S390_MEMOP_LOGICAL_READ for reading from logical memory space or
2948 KVM_S390_MEMOP_LOGICAL_WRITE for writing to logical memory space. The
2949 KVM_S390_MEMOP_F_CHECK_ONLY flag can be set in the "flags" field to check
2950 whether the corresponding memory access would create an access exception
2951 (without touching the data in the memory at the destination). In case an
2952 access exception occurred while walking the MMU tables of the guest, the
2953 ioctl returns a positive error number to indicate the type of exception.
2954 This exception is also raised directly at the corresponding VCPU if the
2955 flag KVM_S390_MEMOP_F_INJECT_EXCEPTION is set in the "flags" field.
2956
2957 The start address of the memory region has to be specified in the "gaddr"
2958 field, and the length of the region in the "size" field. "buf" is the buffer
2959 supplied by the userspace application where the read data should be written
2960 to for KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written
2961 is stored for a KVM_S390_MEMOP_LOGICAL_WRITE. "buf" is unused and can be NULL
2962 when KVM_S390_MEMOP_F_CHECK_ONLY is specified. "ar" designates the access
2963 register number to be used.
2964
2965 The "reserved" field is meant for future extensions. It is not used by
2966 KVM with the currently defined set of flags.
2967
2968 4.90 KVM_S390_GET_SKEYS
2969
2970 Capability: KVM_CAP_S390_SKEYS
2971 Architectures: s390
2972 Type: vm ioctl
2973 Parameters: struct kvm_s390_skeys
2974 Returns: 0 on success, KVM_S390_GET_KEYS_NONE if guest is not using storage
2975          keys, negative value on error
2976
2977 This ioctl is used to get guest storage key values on the s390
2978 architecture. The ioctl takes parameters via the kvm_s390_skeys struct.
2979
2980 struct kvm_s390_skeys {
2981         __u64 start_gfn;
2982         __u64 count;
2983         __u64 skeydata_addr;
2984         __u32 flags;
2985         __u32 reserved[9];
2986 };
2987
2988 The start_gfn field is the number of the first guest frame whose storage keys
2989 you want to get.
2990
2991 The count field is the number of consecutive frames (starting from start_gfn)
2992 whose storage keys to get. The count field must be at least 1 and the maximum
2993 allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
2994 will cause the ioctl to return -EINVAL.
2995
2996 The skeydata_addr field is the address to a buffer large enough to hold count
2997 bytes. This buffer will be filled with storage key data by the ioctl.
2998
2999 4.91 KVM_S390_SET_SKEYS
3000
3001 Capability: KVM_CAP_S390_SKEYS
3002 Architectures: s390
3003 Type: vm ioctl
3004 Parameters: struct kvm_s390_skeys
3005 Returns: 0 on success, negative value on error
3006
3007 This ioctl is used to set guest storage key values on the s390
3008 architecture. The ioctl takes parameters via the kvm_s390_skeys struct.
3009 See section on KVM_S390_GET_SKEYS for struct definition.
3010
3011 The start_gfn field is the number of the first guest frame whose storage keys
3012 you want to set.
3013
3014 The count field is the number of consecutive frames (starting from start_gfn)
3015 whose storage keys to get. The count field must be at least 1 and the maximum
3016 allowed value is defined as KVM_S390_SKEYS_ALLOC_MAX. Values outside this range
3017 will cause the ioctl to return -EINVAL.
3018
3019 The skeydata_addr field is the address to a buffer containing count bytes of
3020 storage keys. Each byte in the buffer will be set as the storage key for a
3021 single frame starting at start_gfn for count frames.
3022
3023 Note: If any architecturally invalid key value is found in the given data then
3024 the ioctl will return -EINVAL.
3025
3026 4.92 KVM_S390_IRQ
3027
3028 Capability: KVM_CAP_S390_INJECT_IRQ
3029 Architectures: s390
3030 Type: vcpu ioctl
3031 Parameters: struct kvm_s390_irq (in)
3032 Returns: 0 on success, -1 on error
3033 Errors:
3034   EINVAL: interrupt type is invalid
3035           type is KVM_S390_SIGP_STOP and flag parameter is invalid value
3036           type is KVM_S390_INT_EXTERNAL_CALL and code is bigger
3037             than the maximum of VCPUs
3038   EBUSY:  type is KVM_S390_SIGP_SET_PREFIX and vcpu is not stopped
3039           type is KVM_S390_SIGP_STOP and a stop irq is already pending
3040           type is KVM_S390_INT_EXTERNAL_CALL and an external call interrupt
3041             is already pending
3042
3043 Allows to inject an interrupt to the guest.
3044
3045 Using struct kvm_s390_irq as a parameter allows
3046 to inject additional payload which is not
3047 possible via KVM_S390_INTERRUPT.
3048
3049 Interrupt parameters are passed via kvm_s390_irq:
3050
3051 struct kvm_s390_irq {
3052         __u64 type;
3053         union {
3054                 struct kvm_s390_io_info io;
3055                 struct kvm_s390_ext_info ext;
3056                 struct kvm_s390_pgm_info pgm;
3057                 struct kvm_s390_emerg_info emerg;
3058                 struct kvm_s390_extcall_info extcall;
3059                 struct kvm_s390_prefix_info prefix;
3060                 struct kvm_s390_stop_info stop;
3061                 struct kvm_s390_mchk_info mchk;
3062                 char reserved[64];
3063         } u;
3064 };
3065
3066 type can be one of the following:
3067
3068 KVM_S390_SIGP_STOP - sigp stop; parameter in .stop
3069 KVM_S390_PROGRAM_INT - program check; parameters in .pgm
3070 KVM_S390_SIGP_SET_PREFIX - sigp set prefix; parameters in .prefix
3071 KVM_S390_RESTART - restart; no parameters
3072 KVM_S390_INT_CLOCK_COMP - clock comparator interrupt; no parameters
3073 KVM_S390_INT_CPU_TIMER - CPU timer interrupt; no parameters
3074 KVM_S390_INT_EMERGENCY - sigp emergency; parameters in .emerg
3075 KVM_S390_INT_EXTERNAL_CALL - sigp external call; parameters in .extcall
3076 KVM_S390_MCHK - machine check interrupt; parameters in .mchk
3077
3078
3079 Note that the vcpu ioctl is asynchronous to vcpu execution.
3080
3081 4.94 KVM_S390_GET_IRQ_STATE
3082
3083 Capability: KVM_CAP_S390_IRQ_STATE
3084 Architectures: s390
3085 Type: vcpu ioctl
3086 Parameters: struct kvm_s390_irq_state (out)
3087 Returns: >= number of bytes copied into buffer,
3088          -EINVAL if buffer size is 0,
3089          -ENOBUFS if buffer size is too small to fit all pending interrupts,
3090          -EFAULT if the buffer address was invalid
3091
3092 This ioctl allows userspace to retrieve the complete state of all currently
3093 pending interrupts in a single buffer. Use cases include migration
3094 and introspection. The parameter structure contains the address of a
3095 userspace buffer and its length:
3096
3097 struct kvm_s390_irq_state {
3098         __u64 buf;
3099         __u32 flags;
3100         __u32 len;
3101         __u32 reserved[4];
3102 };
3103
3104 Userspace passes in the above struct and for each pending interrupt a
3105 struct kvm_s390_irq is copied to the provided buffer.
3106
3107 If -ENOBUFS is returned the buffer provided was too small and userspace
3108 may retry with a bigger buffer.
3109
3110 4.95 KVM_S390_SET_IRQ_STATE
3111
3112 Capability: KVM_CAP_S390_IRQ_STATE
3113 Architectures: s390
3114 Type: vcpu ioctl
3115 Parameters: struct kvm_s390_irq_state (in)
3116 Returns: 0 on success,
3117          -EFAULT if the buffer address was invalid,
3118          -EINVAL for an invalid buffer length (see below),
3119          -EBUSY if there were already interrupts pending,
3120          errors occurring when actually injecting the
3121           interrupt. See KVM_S390_IRQ.
3122
3123 This ioctl allows userspace to set the complete state of all cpu-local
3124 interrupts currently pending for the vcpu. It is intended for restoring
3125 interrupt state after a migration. The input parameter is a userspace buffer
3126 containing a struct kvm_s390_irq_state:
3127
3128 struct kvm_s390_irq_state {
3129         __u64 buf;
3130         __u32 len;
3131         __u32 pad;
3132 };
3133
3134 The userspace memory referenced by buf contains a struct kvm_s390_irq
3135 for each interrupt to be injected into the guest.
3136 If one of the interrupts could not be injected for some reason the
3137 ioctl aborts.
3138
3139 len must be a multiple of sizeof(struct kvm_s390_irq). It must be > 0
3140 and it must not exceed (max_vcpus + 32) * sizeof(struct kvm_s390_irq),
3141 which is the maximum number of possibly pending cpu-local interrupts.
3142
3143 4.96 KVM_SMI
3144
3145 Capability: KVM_CAP_X86_SMM
3146 Architectures: x86
3147 Type: vcpu ioctl
3148 Parameters: none
3149 Returns: 0 on success, -1 on error
3150
3151 Queues an SMI on the thread's vcpu.
3152
3153 4.97 KVM_CAP_PPC_MULTITCE
3154
3155 Capability: KVM_CAP_PPC_MULTITCE
3156 Architectures: ppc
3157 Type: vm
3158
3159 This capability means the kernel is capable of handling hypercalls
3160 H_PUT_TCE_INDIRECT and H_STUFF_TCE without passing those into the user
3161 space. This significantly accelerates DMA operations for PPC KVM guests.
3162 User space should expect that its handlers for these hypercalls
3163 are not going to be called if user space previously registered LIOBN
3164 in KVM (via KVM_CREATE_SPAPR_TCE or similar calls).
3165
3166 In order to enable H_PUT_TCE_INDIRECT and H_STUFF_TCE use in the guest,
3167 user space might have to advertise it for the guest. For example,
3168 IBM pSeries (sPAPR) guest starts using them if "hcall-multi-tce" is
3169 present in the "ibm,hypertas-functions" device-tree property.
3170
3171 The hypercalls mentioned above may or may not be processed successfully
3172 in the kernel based fast path. If they can not be handled by the kernel,
3173 they will get passed on to user space. So user space still has to have
3174 an implementation for these despite the in kernel acceleration.
3175
3176 This capability is always enabled.
3177
3178 4.98 KVM_CREATE_SPAPR_TCE_64
3179
3180 Capability: KVM_CAP_SPAPR_TCE_64
3181 Architectures: powerpc
3182 Type: vm ioctl
3183 Parameters: struct kvm_create_spapr_tce_64 (in)
3184 Returns: file descriptor for manipulating the created TCE table
3185
3186 This is an extension for KVM_CAP_SPAPR_TCE which only supports 32bit
3187 windows, described in 4.62 KVM_CREATE_SPAPR_TCE
3188
3189 This capability uses extended struct in ioctl interface:
3190
3191 /* for KVM_CAP_SPAPR_TCE_64 */
3192 struct kvm_create_spapr_tce_64 {
3193         __u64 liobn;
3194         __u32 page_shift;
3195         __u32 flags;
3196         __u64 offset;   /* in pages */
3197         __u64 size;     /* in pages */
3198 };
3199
3200 The aim of extension is to support an additional bigger DMA window with
3201 a variable page size.
3202 KVM_CREATE_SPAPR_TCE_64 receives a 64bit window size, an IOMMU page shift and
3203 a bus offset of the corresponding DMA window, @size and @offset are numbers
3204 of IOMMU pages.
3205
3206 @flags are not used at the moment.
3207
3208 The rest of functionality is identical to KVM_CREATE_SPAPR_TCE.
3209
3210 4.99 KVM_REINJECT_CONTROL
3211
3212 Capability: KVM_CAP_REINJECT_CONTROL
3213 Architectures: x86
3214 Type: vm ioctl
3215 Parameters: struct kvm_reinject_control (in)
3216 Returns: 0 on success,
3217          -EFAULT if struct kvm_reinject_control cannot be read,
3218          -ENXIO if KVM_CREATE_PIT or KVM_CREATE_PIT2 didn't succeed earlier.
3219
3220 i8254 (PIT) has two modes, reinject and !reinject.  The default is reinject,
3221 where KVM queues elapsed i8254 ticks and monitors completion of interrupt from
3222 vector(s) that i8254 injects.  Reinject mode dequeues a tick and injects its
3223 interrupt whenever there isn't a pending interrupt from i8254.
3224 !reinject mode injects an interrupt as soon as a tick arrives.
3225
3226 struct kvm_reinject_control {
3227         __u8 pit_reinject;
3228         __u8 reserved[31];
3229 };
3230
3231 pit_reinject = 0 (!reinject mode) is recommended, unless running an old
3232 operating system that uses the PIT for timing (e.g. Linux 2.4.x).
3233
3234 4.100 KVM_PPC_CONFIGURE_V3_MMU
3235
3236 Capability: KVM_CAP_PPC_RADIX_MMU or KVM_CAP_PPC_HASH_MMU_V3
3237 Architectures: ppc
3238 Type: vm ioctl
3239 Parameters: struct kvm_ppc_mmuv3_cfg (in)
3240 Returns: 0 on success,
3241          -EFAULT if struct kvm_ppc_mmuv3_cfg cannot be read,
3242          -EINVAL if the configuration is invalid
3243
3244 This ioctl controls whether the guest will use radix or HPT (hashed
3245 page table) translation, and sets the pointer to the process table for
3246 the guest.
3247
3248 struct kvm_ppc_mmuv3_cfg {
3249         __u64   flags;
3250         __u64   process_table;
3251 };
3252
3253 There are two bits that can be set in flags; KVM_PPC_MMUV3_RADIX and
3254 KVM_PPC_MMUV3_GTSE.  KVM_PPC_MMUV3_RADIX, if set, configures the guest
3255 to use radix tree translation, and if clear, to use HPT translation.
3256 KVM_PPC_MMUV3_GTSE, if set and if KVM permits it, configures the guest
3257 to be able to use the global TLB and SLB invalidation instructions;
3258 if clear, the guest may not use these instructions.
3259
3260 The process_table field specifies the address and size of the guest
3261 process table, which is in the guest's space.  This field is formatted
3262 as the second doubleword of the partition table entry, as defined in
3263 the Power ISA V3.00, Book III section 5.7.6.1.
3264
3265 4.101 KVM_PPC_GET_RMMU_INFO
3266
3267 Capability: KVM_CAP_PPC_RADIX_MMU
3268 Architectures: ppc
3269 Type: vm ioctl
3270 Parameters: struct kvm_ppc_rmmu_info (out)
3271 Returns: 0 on success,
3272          -EFAULT if struct kvm_ppc_rmmu_info cannot be written,
3273          -EINVAL if no useful information can be returned
3274
3275 This ioctl returns a structure containing two things: (a) a list
3276 containing supported radix tree geometries, and (b) a list that maps
3277 page sizes to put in the "AP" (actual page size) field for the tlbie
3278 (TLB invalidate entry) instruction.
3279
3280 struct kvm_ppc_rmmu_info {
3281         struct kvm_ppc_radix_geom {
3282                 __u8    page_shift;
3283                 __u8    level_bits[4];
3284                 __u8    pad[3];
3285         }       geometries[8];
3286         __u32   ap_encodings[8];
3287 };
3288
3289 The geometries[] field gives up to 8 supported geometries for the
3290 radix page table, in terms of the log base 2 of the smallest page
3291 size, and the number of bits indexed at each level of the tree, from
3292 the PTE level up to the PGD level in that order.  Any unused entries
3293 will have 0 in the page_shift field.
3294
3295 The ap_encodings gives the supported page sizes and their AP field
3296 encodings, encoded with the AP value in the top 3 bits and the log
3297 base 2 of the page size in the bottom 6 bits.
3298
3299 4.102 KVM_PPC_RESIZE_HPT_PREPARE
3300
3301 Capability: KVM_CAP_SPAPR_RESIZE_HPT
3302 Architectures: powerpc
3303 Type: vm ioctl
3304 Parameters: struct kvm_ppc_resize_hpt (in)
3305 Returns: 0 on successful completion,
3306          >0 if a new HPT is being prepared, the value is an estimated
3307              number of milliseconds until preparation is complete
3308          -EFAULT if struct kvm_reinject_control cannot be read,
3309          -EINVAL if the supplied shift or flags are invalid
3310          -ENOMEM if unable to allocate the new HPT
3311          -ENOSPC if there was a hash collision when moving existing
3312                   HPT entries to the new HPT
3313          -EIO on other error conditions
3314
3315 Used to implement the PAPR extension for runtime resizing of a guest's
3316 Hashed Page Table (HPT).  Specifically this starts, stops or monitors
3317 the preparation of a new potential HPT for the guest, essentially
3318 implementing the H_RESIZE_HPT_PREPARE hypercall.
3319
3320 If called with shift > 0 when there is no pending HPT for the guest,
3321 this begins preparation of a new pending HPT of size 2^(shift) bytes.
3322 It then returns a positive integer with the estimated number of
3323 milliseconds until preparation is complete.
3324
3325 If called when there is a pending HPT whose size does not match that
3326 requested in the parameters, discards the existing pending HPT and
3327 creates a new one as above.
3328
3329 If called when there is a pending HPT of the size requested, will:
3330   * If preparation of the pending HPT is already complete, return 0
3331   * If preparation of the pending HPT has failed, return an error
3332     code, then discard the pending HPT.
3333   * If preparation of the pending HPT is still in progress, return an
3334     estimated number of milliseconds until preparation is complete.
3335
3336 If called with shift == 0, discards any currently pending HPT and
3337 returns 0 (i.e. cancels any in-progress preparation).
3338
3339 flags is reserved for future expansion, currently setting any bits in
3340 flags will result in an -EINVAL.
3341
3342 Normally this will be called repeatedly with the same parameters until
3343 it returns <= 0.  The first call will initiate preparation, subsequent
3344 ones will monitor preparation until it completes or fails.
3345
3346 struct kvm_ppc_resize_hpt {
3347         __u64 flags;
3348         __u32 shift;
3349         __u32 pad;
3350 };
3351
3352 4.103 KVM_PPC_RESIZE_HPT_COMMIT
3353
3354 Capability: KVM_CAP_SPAPR_RESIZE_HPT
3355 Architectures: powerpc
3356 Type: vm ioctl
3357 Parameters: struct kvm_ppc_resize_hpt (in)
3358 Returns: 0 on successful completion,
3359          -EFAULT if struct kvm_reinject_control cannot be read,
3360          -EINVAL if the supplied shift or flags are invalid
3361          -ENXIO is there is no pending HPT, or the pending HPT doesn't
3362                  have the requested size
3363          -EBUSY if the pending HPT is not fully prepared
3364          -ENOSPC if there was a hash collision when moving existing
3365                   HPT entries to the new HPT
3366          -EIO on other error conditions
3367
3368 Used to implement the PAPR extension for runtime resizing of a guest's
3369 Hashed Page Table (HPT).  Specifically this requests that the guest be
3370 transferred to working with the new HPT, essentially implementing the
3371 H_RESIZE_HPT_COMMIT hypercall.
3372
3373 This should only be called after KVM_PPC_RESIZE_HPT_PREPARE has
3374 returned 0 with the same parameters.  In other cases
3375 KVM_PPC_RESIZE_HPT_COMMIT will return an error (usually -ENXIO or
3376 -EBUSY, though others may be possible if the preparation was started,
3377 but failed).
3378
3379 This will have undefined effects on the guest if it has not already
3380 placed itself in a quiescent state where no vcpu will make MMU enabled
3381 memory accesses.
3382
3383 On succsful completion, the pending HPT will become the guest's active
3384 HPT and the previous HPT will be discarded.
3385
3386 On failure, the guest will still be operating on its previous HPT.
3387
3388 struct kvm_ppc_resize_hpt {
3389         __u64 flags;
3390         __u32 shift;
3391         __u32 pad;
3392 };
3393
3394 5. The kvm_run structure
3395 ------------------------
3396
3397 Application code obtains a pointer to the kvm_run structure by
3398 mmap()ing a vcpu fd.  From that point, application code can control
3399 execution by changing fields in kvm_run prior to calling the KVM_RUN
3400 ioctl, and obtain information about the reason KVM_RUN returned by
3401 looking up structure members.
3402
3403 struct kvm_run {
3404         /* in */
3405         __u8 request_interrupt_window;
3406
3407 Request that KVM_RUN return when it becomes possible to inject external
3408 interrupts into the guest.  Useful in conjunction with KVM_INTERRUPT.
3409
3410         __u8 immediate_exit;
3411
3412 This field is polled once when KVM_RUN starts; if non-zero, KVM_RUN
3413 exits immediately, returning -EINTR.  In the common scenario where a
3414 signal is used to "kick" a VCPU out of KVM_RUN, this field can be used
3415 to avoid usage of KVM_SET_SIGNAL_MASK, which has worse scalability.
3416 Rather than blocking the signal outside KVM_RUN, userspace can set up
3417 a signal handler that sets run->immediate_exit to a non-zero value.
3418
3419 This field is ignored if KVM_CAP_IMMEDIATE_EXIT is not available.
3420
3421         __u8 padding1[6];
3422
3423         /* out */
3424         __u32 exit_reason;
3425
3426 When KVM_RUN has returned successfully (return value 0), this informs
3427 application code why KVM_RUN has returned.  Allowable values for this
3428 field are detailed below.
3429
3430         __u8 ready_for_interrupt_injection;
3431
3432 If request_interrupt_window has been specified, this field indicates
3433 an interrupt can be injected now with KVM_INTERRUPT.
3434
3435         __u8 if_flag;
3436
3437 The value of the current interrupt flag.  Only valid if in-kernel
3438 local APIC is not used.
3439
3440         __u16 flags;
3441
3442 More architecture-specific flags detailing state of the VCPU that may
3443 affect the device's behavior.  The only currently defined flag is
3444 KVM_RUN_X86_SMM, which is valid on x86 machines and is set if the
3445 VCPU is in system management mode.
3446
3447         /* in (pre_kvm_run), out (post_kvm_run) */
3448         __u64 cr8;
3449
3450 The value of the cr8 register.  Only valid if in-kernel local APIC is
3451 not used.  Both input and output.
3452
3453         __u64 apic_base;
3454
3455 The value of the APIC BASE msr.  Only valid if in-kernel local
3456 APIC is not used.  Both input and output.
3457
3458         union {
3459                 /* KVM_EXIT_UNKNOWN */
3460                 struct {
3461                         __u64 hardware_exit_reason;
3462                 } hw;
3463
3464 If exit_reason is KVM_EXIT_UNKNOWN, the vcpu has exited due to unknown
3465 reasons.  Further architecture-specific information is available in
3466 hardware_exit_reason.
3467
3468                 /* KVM_EXIT_FAIL_ENTRY */
3469                 struct {
3470                         __u64 hardware_entry_failure_reason;
3471                 } fail_entry;
3472
3473 If exit_reason is KVM_EXIT_FAIL_ENTRY, the vcpu could not be run due
3474 to unknown reasons.  Further architecture-specific information is
3475 available in hardware_entry_failure_reason.
3476
3477                 /* KVM_EXIT_EXCEPTION */
3478                 struct {
3479                         __u32 exception;
3480                         __u32 error_code;
3481                 } ex;
3482
3483 Unused.
3484
3485                 /* KVM_EXIT_IO */
3486                 struct {
3487 #define KVM_EXIT_IO_IN  0
3488 #define KVM_EXIT_IO_OUT 1
3489                         __u8 direction;
3490                         __u8 size; /* bytes */
3491                         __u16 port;
3492                         __u32 count;
3493                         __u64 data_offset; /* relative to kvm_run start */
3494                 } io;
3495
3496 If exit_reason is KVM_EXIT_IO, then the vcpu has
3497 executed a port I/O instruction which could not be satisfied by kvm.
3498 data_offset describes where the data is located (KVM_EXIT_IO_OUT) or
3499 where kvm expects application code to place the data for the next
3500 KVM_RUN invocation (KVM_EXIT_IO_IN).  Data format is a packed array.
3501
3502                 /* KVM_EXIT_DEBUG */
3503                 struct {
3504                         struct kvm_debug_exit_arch arch;
3505                 } debug;
3506
3507 If the exit_reason is KVM_EXIT_DEBUG, then a vcpu is processing a debug event
3508 for which architecture specific information is returned.
3509
3510                 /* KVM_EXIT_MMIO */
3511                 struct {
3512                         __u64 phys_addr;
3513                         __u8  data[8];
3514                         __u32 len;
3515                         __u8  is_write;
3516                 } mmio;
3517
3518 If exit_reason is KVM_EXIT_MMIO, then the vcpu has
3519 executed a memory-mapped I/O instruction which could not be satisfied
3520 by kvm.  The 'data' member contains the written data if 'is_write' is
3521 true, and should be filled by application code otherwise.
3522
3523 The 'data' member contains, in its first 'len' bytes, the value as it would
3524 appear if the VCPU performed a load or store of the appropriate width directly
3525 to the byte array.
3526
3527 NOTE: For KVM_EXIT_IO, KVM_EXIT_MMIO, KVM_EXIT_OSI, KVM_EXIT_PAPR and
3528       KVM_EXIT_EPR the corresponding
3529 operations are complete (and guest state is consistent) only after userspace
3530 has re-entered the kernel with KVM_RUN.  The kernel side will first finish
3531 incomplete operations and then check for pending signals.  Userspace
3532 can re-enter the guest with an unmasked signal pending to complete
3533 pending operations.
3534
3535                 /* KVM_EXIT_HYPERCALL */
3536                 struct {
3537                         __u64 nr;
3538                         __u64 args[6];
3539                         __u64 ret;
3540                         __u32 longmode;
3541                         __u32 pad;
3542                 } hypercall;
3543
3544 Unused.  This was once used for 'hypercall to userspace'.  To implement
3545 such functionality, use KVM_EXIT_IO (x86) or KVM_EXIT_MMIO (all except s390).
3546 Note KVM_EXIT_IO is significantly faster than KVM_EXIT_MMIO.
3547
3548                 /* KVM_EXIT_TPR_ACCESS */
3549                 struct {
3550                         __u64 rip;
3551                         __u32 is_write;
3552                         __u32 pad;
3553                 } tpr_access;
3554
3555 To be documented (KVM_TPR_ACCESS_REPORTING).
3556
3557                 /* KVM_EXIT_S390_SIEIC */
3558                 struct {
3559                         __u8 icptcode;
3560                         __u64 mask; /* psw upper half */
3561                         __u64 addr; /* psw lower half */
3562                         __u16 ipa;
3563                         __u32 ipb;
3564                 } s390_sieic;
3565
3566 s390 specific.
3567
3568                 /* KVM_EXIT_S390_RESET */
3569 #define KVM_S390_RESET_POR       1
3570 #define KVM_S390_RESET_CLEAR     2
3571 #define KVM_S390_RESET_SUBSYSTEM 4
3572 #define KVM_S390_RESET_CPU_INIT  8
3573 #define KVM_S390_RESET_IPL       16
3574                 __u64 s390_reset_flags;
3575
3576 s390 specific.
3577
3578                 /* KVM_EXIT_S390_UCONTROL */
3579                 struct {
3580                         __u64 trans_exc_code;
3581                         __u32 pgm_code;
3582                 } s390_ucontrol;
3583
3584 s390 specific. A page fault has occurred for a user controlled virtual
3585 machine (KVM_VM_S390_UNCONTROL) on it's host page table that cannot be
3586 resolved by the kernel.
3587 The program code and the translation exception code that were placed
3588 in the cpu's lowcore are presented here as defined by the z Architecture
3589 Principles of Operation Book in the Chapter for Dynamic Address Translation
3590 (DAT)
3591
3592                 /* KVM_EXIT_DCR */
3593                 struct {
3594                         __u32 dcrn;
3595                         __u32 data;
3596                         __u8  is_write;
3597                 } dcr;
3598
3599 Deprecated - was used for 440 KVM.
3600
3601                 /* KVM_EXIT_OSI */
3602                 struct {
3603                         __u64 gprs[32];
3604                 } osi;
3605
3606 MOL uses a special hypercall interface it calls 'OSI'. To enable it, we catch
3607 hypercalls and exit with this exit struct that contains all the guest gprs.
3608
3609 If exit_reason is KVM_EXIT_OSI, then the vcpu has triggered such a hypercall.
3610 Userspace can now handle the hypercall and when it's done modify the gprs as
3611 necessary. Upon guest entry all guest GPRs will then be replaced by the values
3612 in this struct.
3613
3614                 /* KVM_EXIT_PAPR_HCALL */
3615                 struct {
3616                         __u64 nr;
3617                         __u64 ret;
3618                         __u64 args[9];
3619                 } papr_hcall;
3620
3621 This is used on 64-bit PowerPC when emulating a pSeries partition,
3622 e.g. with the 'pseries' machine type in qemu.  It occurs when the
3623 guest does a hypercall using the 'sc 1' instruction.  The 'nr' field
3624 contains the hypercall number (from the guest R3), and 'args' contains
3625 the arguments (from the guest R4 - R12).  Userspace should put the
3626 return code in 'ret' and any extra returned values in args[].
3627 The possible hypercalls are defined in the Power Architecture Platform
3628 Requirements (PAPR) document available from www.power.org (free
3629 developer registration required to access it).
3630
3631                 /* KVM_EXIT_S390_TSCH */
3632                 struct {
3633                         __u16 subchannel_id;
3634                         __u16 subchannel_nr;
3635                         __u32 io_int_parm;
3636                         __u32 io_int_word;
3637                         __u32 ipb;
3638                         __u8 dequeued;
3639                 } s390_tsch;
3640
3641 s390 specific. This exit occurs when KVM_CAP_S390_CSS_SUPPORT has been enabled
3642 and TEST SUBCHANNEL was intercepted. If dequeued is set, a pending I/O
3643 interrupt for the target subchannel has been dequeued and subchannel_id,
3644 subchannel_nr, io_int_parm and io_int_word contain the parameters for that
3645 interrupt. ipb is needed for instruction parameter decoding.
3646
3647                 /* KVM_EXIT_EPR */
3648                 struct {
3649                         __u32 epr;
3650                 } epr;
3651
3652 On FSL BookE PowerPC chips, the interrupt controller has a fast patch
3653 interrupt acknowledge path to the core. When the core successfully
3654 delivers an interrupt, it automatically populates the EPR register with
3655 the interrupt vector number and acknowledges the interrupt inside
3656 the interrupt controller.
3657
3658 In case the interrupt controller lives in user space, we need to do
3659 the interrupt acknowledge cycle through it to fetch the next to be
3660 delivered interrupt vector using this exit.
3661
3662 It gets triggered whenever both KVM_CAP_PPC_EPR are enabled and an
3663 external interrupt has just been delivered into the guest. User space
3664 should put the acknowledged interrupt vector into the 'epr' field.
3665
3666                 /* KVM_EXIT_SYSTEM_EVENT */
3667                 struct {
3668 #define KVM_SYSTEM_EVENT_SHUTDOWN       1
3669 #define KVM_SYSTEM_EVENT_RESET          2
3670 #define KVM_SYSTEM_EVENT_CRASH          3
3671                         __u32 type;
3672                         __u64 flags;
3673                 } system_event;
3674
3675 If exit_reason is KVM_EXIT_SYSTEM_EVENT then the vcpu has triggered
3676 a system-level event using some architecture specific mechanism (hypercall
3677 or some special instruction). In case of ARM/ARM64, this is triggered using
3678 HVC instruction based PSCI call from the vcpu. The 'type' field describes
3679 the system-level event type. The 'flags' field describes architecture
3680 specific flags for the system-level event.
3681
3682 Valid values for 'type' are:
3683   KVM_SYSTEM_EVENT_SHUTDOWN -- the guest has requested a shutdown of the
3684    VM. Userspace is not obliged to honour this, and if it does honour
3685    this does not need to destroy the VM synchronously (ie it may call
3686    KVM_RUN again before shutdown finally occurs).
3687   KVM_SYSTEM_EVENT_RESET -- the guest has requested a reset of the VM.
3688    As with SHUTDOWN, userspace can choose to ignore the request, or
3689    to schedule the reset to occur in the future and may call KVM_RUN again.
3690   KVM_SYSTEM_EVENT_CRASH -- the guest crash occurred and the guest
3691    has requested a crash condition maintenance. Userspace can choose
3692    to ignore the request, or to gather VM memory core dump and/or
3693    reset/shutdown of the VM.
3694
3695                 /* KVM_EXIT_IOAPIC_EOI */
3696                 struct {
3697                         __u8 vector;
3698                 } eoi;
3699
3700 Indicates that the VCPU's in-kernel local APIC received an EOI for a
3701 level-triggered IOAPIC interrupt.  This exit only triggers when the
3702 IOAPIC is implemented in userspace (i.e. KVM_CAP_SPLIT_IRQCHIP is enabled);
3703 the userspace IOAPIC should process the EOI and retrigger the interrupt if
3704 it is still asserted.  Vector is the LAPIC interrupt vector for which the
3705 EOI was received.
3706
3707                 struct kvm_hyperv_exit {
3708 #define KVM_EXIT_HYPERV_SYNIC          1
3709 #define KVM_EXIT_HYPERV_HCALL          2
3710                         __u32 type;
3711                         union {
3712                                 struct {
3713                                         __u32 msr;
3714                                         __u64 control;
3715                                         __u64 evt_page;
3716                                         __u64 msg_page;
3717                                 } synic;
3718                                 struct {
3719                                         __u64 input;
3720                                         __u64 result;
3721                                         __u64 params[2];
3722                                 } hcall;
3723                         } u;
3724                 };
3725                 /* KVM_EXIT_HYPERV */
3726                 struct kvm_hyperv_exit hyperv;
3727 Indicates that the VCPU exits into userspace to process some tasks
3728 related to Hyper-V emulation.
3729 Valid values for 'type' are:
3730         KVM_EXIT_HYPERV_SYNIC -- synchronously notify user-space about
3731 Hyper-V SynIC state change. Notification is used to remap SynIC
3732 event/message pages and to enable/disable SynIC messages/events processing
3733 in userspace.
3734
3735                 /* Fix the size of the union. */
3736                 char padding[256];
3737         };
3738
3739         /*
3740          * shared registers between kvm and userspace.
3741          * kvm_valid_regs specifies the register classes set by the host
3742          * kvm_dirty_regs specified the register classes dirtied by userspace
3743          * struct kvm_sync_regs is architecture specific, as well as the
3744          * bits for kvm_valid_regs and kvm_dirty_regs
3745          */
3746         __u64 kvm_valid_regs;
3747         __u64 kvm_dirty_regs;
3748         union {
3749                 struct kvm_sync_regs regs;
3750                 char padding[1024];
3751         } s;
3752
3753 If KVM_CAP_SYNC_REGS is defined, these fields allow userspace to access
3754 certain guest registers without having to call SET/GET_*REGS. Thus we can
3755 avoid some system call overhead if userspace has to handle the exit.
3756 Userspace can query the validity of the structure by checking
3757 kvm_valid_regs for specific bits. These bits are architecture specific
3758 and usually define the validity of a groups of registers. (e.g. one bit
3759  for general purpose registers)
3760
3761 Please note that the kernel is allowed to use the kvm_run structure as the
3762 primary storage for certain register types. Therefore, the kernel may use the
3763 values in kvm_run even if the corresponding bit in kvm_dirty_regs is not set.
3764
3765 };
3766
3767
3768
3769 6. Capabilities that can be enabled on vCPUs
3770 --------------------------------------------
3771
3772 There are certain capabilities that change the behavior of the virtual CPU or
3773 the virtual machine when enabled. To enable them, please see section 4.37.
3774 Below you can find a list of capabilities and what their effect on the vCPU or
3775 the virtual machine is when enabling them.
3776
3777 The following information is provided along with the description:
3778
3779   Architectures: which instruction set architectures provide this ioctl.
3780       x86 includes both i386 and x86_64.
3781
3782   Target: whether this is a per-vcpu or per-vm capability.
3783
3784   Parameters: what parameters are accepted by the capability.
3785
3786   Returns: the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
3787       are not detailed, but errors with specific meanings are.
3788
3789
3790 6.1 KVM_CAP_PPC_OSI
3791
3792 Architectures: ppc
3793 Target: vcpu
3794 Parameters: none
3795 Returns: 0 on success; -1 on error
3796
3797 This capability enables interception of OSI hypercalls that otherwise would
3798 be treated as normal system calls to be injected into the guest. OSI hypercalls
3799 were invented by Mac-on-Linux to have a standardized communication mechanism
3800 between the guest and the host.
3801
3802 When this capability is enabled, KVM_EXIT_OSI can occur.
3803
3804
3805 6.2 KVM_CAP_PPC_PAPR
3806
3807 Architectures: ppc
3808 Target: vcpu
3809 Parameters: none
3810 Returns: 0 on success; -1 on error
3811
3812 This capability enables interception of PAPR hypercalls. PAPR hypercalls are
3813 done using the hypercall instruction "sc 1".
3814
3815 It also sets the guest privilege level to "supervisor" mode. Usually the guest
3816 runs in "hypervisor" privilege mode with a few missing features.
3817
3818 In addition to the above, it changes the semantics of SDR1. In this mode, the
3819 HTAB address part of SDR1 contains an HVA instead of a GPA, as PAPR keeps the
3820 HTAB invisible to the guest.
3821
3822 When this capability is enabled, KVM_EXIT_PAPR_HCALL can occur.
3823
3824
3825 6.3 KVM_CAP_SW_TLB
3826
3827 Architectures: ppc
3828 Target: vcpu
3829 Parameters: args[0] is the address of a struct kvm_config_tlb
3830 Returns: 0 on success; -1 on error
3831
3832 struct kvm_config_tlb {
3833         __u64 params;
3834         __u64 array;
3835         __u32 mmu_type;
3836         __u32 array_len;
3837 };
3838
3839 Configures the virtual CPU's TLB array, establishing a shared memory area
3840 between userspace and KVM.  The "params" and "array" fields are userspace
3841 addresses of mmu-type-specific data structures.  The "array_len" field is an
3842 safety mechanism, and should be set to the size in bytes of the memory that
3843 userspace has reserved for the array.  It must be at least the size dictated
3844 by "mmu_type" and "params".
3845
3846 While KVM_RUN is active, the shared region is under control of KVM.  Its
3847 contents are undefined, and any modification by userspace results in
3848 boundedly undefined behavior.
3849
3850 On return from KVM_RUN, the shared region will reflect the current state of
3851 the guest's TLB.  If userspace makes any changes, it must call KVM_DIRTY_TLB
3852 to tell KVM which entries have been changed, prior to calling KVM_RUN again
3853 on this vcpu.
3854
3855 For mmu types KVM_MMU_FSL_BOOKE_NOHV and KVM_MMU_FSL_BOOKE_HV:
3856  - The "params" field is of type "struct kvm_book3e_206_tlb_params".
3857  - The "array" field points to an array of type "struct
3858    kvm_book3e_206_tlb_entry".
3859  - The array consists of all entries in the first TLB, followed by all
3860    entries in the second TLB.
3861  - Within a TLB, entries are ordered first by increasing set number.  Within a
3862    set, entries are ordered by way (increasing ESEL).
3863  - The hash for determining set number in TLB0 is: (MAS2 >> 12) & (num_sets - 1)
3864    where "num_sets" is the tlb_sizes[] value divided by the tlb_ways[] value.
3865  - The tsize field of mas1 shall be set to 4K on TLB0, even though the
3866    hardware ignores this value for TLB0.
3867
3868 6.4 KVM_CAP_S390_CSS_SUPPORT
3869
3870 Architectures: s390
3871 Target: vcpu
3872 Parameters: none
3873 Returns: 0 on success; -1 on error
3874
3875 This capability enables support for handling of channel I/O instructions.
3876
3877 TEST PENDING INTERRUPTION and the interrupt portion of TEST SUBCHANNEL are
3878 handled in-kernel, while the other I/O instructions are passed to userspace.
3879
3880 When this capability is enabled, KVM_EXIT_S390_TSCH will occur on TEST
3881 SUBCHANNEL intercepts.
3882
3883 Note that even though this capability is enabled per-vcpu, the complete
3884 virtual machine is affected.
3885
3886 6.5 KVM_CAP_PPC_EPR
3887
3888 Architectures: ppc
3889 Target: vcpu
3890 Parameters: args[0] defines whether the proxy facility is active
3891 Returns: 0 on success; -1 on error
3892
3893 This capability enables or disables the delivery of interrupts through the
3894 external proxy facility.
3895
3896 When enabled (args[0] != 0), every time the guest gets an external interrupt
3897 delivered, it automatically exits into user space with a KVM_EXIT_EPR exit
3898 to receive the topmost interrupt vector.
3899
3900 When disabled (args[0] == 0), behavior is as if this facility is unsupported.
3901
3902 When this capability is enabled, KVM_EXIT_EPR can occur.
3903
3904 6.6 KVM_CAP_IRQ_MPIC
3905
3906 Architectures: ppc
3907 Parameters: args[0] is the MPIC device fd
3908             args[1] is the MPIC CPU number for this vcpu
3909
3910 This capability connects the vcpu to an in-kernel MPIC device.
3911
3912 6.7 KVM_CAP_IRQ_XICS
3913
3914 Architectures: ppc
3915 Target: vcpu
3916 Parameters: args[0] is the XICS device fd
3917             args[1] is the XICS CPU number (server ID) for this vcpu
3918
3919 This capability connects the vcpu to an in-kernel XICS device.
3920
3921 6.8 KVM_CAP_S390_IRQCHIP
3922
3923 Architectures: s390
3924 Target: vm
3925 Parameters: none
3926
3927 This capability enables the in-kernel irqchip for s390. Please refer to
3928 "4.24 KVM_CREATE_IRQCHIP" for details.
3929
3930 6.9 KVM_CAP_MIPS_FPU
3931
3932 Architectures: mips
3933 Target: vcpu
3934 Parameters: args[0] is reserved for future use (should be 0).
3935
3936 This capability allows the use of the host Floating Point Unit by the guest. It
3937 allows the Config1.FP bit to be set to enable the FPU in the guest. Once this is
3938 done the KVM_REG_MIPS_FPR_* and KVM_REG_MIPS_FCR_* registers can be accessed
3939 (depending on the current guest FPU register mode), and the Status.FR,
3940 Config5.FRE bits are accessible via the KVM API and also from the guest,
3941 depending on them being supported by the FPU.
3942
3943 6.10 KVM_CAP_MIPS_MSA
3944
3945 Architectures: mips
3946 Target: vcpu
3947 Parameters: args[0] is reserved for future use (should be 0).
3948
3949 This capability allows the use of the MIPS SIMD Architecture (MSA) by the guest.
3950 It allows the Config3.MSAP bit to be set to enable the use of MSA by the guest.
3951 Once this is done the KVM_REG_MIPS_VEC_* and KVM_REG_MIPS_MSA_* registers can be
3952 accessed, and the Config5.MSAEn bit is accessible via the KVM API and also from
3953 the guest.
3954
3955 7. Capabilities that can be enabled on VMs
3956 ------------------------------------------
3957
3958 There are certain capabilities that change the behavior of the virtual
3959 machine when enabled. To enable them, please see section 4.37. Below
3960 you can find a list of capabilities and what their effect on the VM
3961 is when enabling them.
3962
3963 The following information is provided along with the description:
3964
3965   Architectures: which instruction set architectures provide this ioctl.
3966       x86 includes both i386 and x86_64.
3967
3968   Parameters: what parameters are accepted by the capability.
3969
3970   Returns: the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
3971       are not detailed, but errors with specific meanings are.
3972
3973
3974 7.1 KVM_CAP_PPC_ENABLE_HCALL
3975
3976 Architectures: ppc
3977 Parameters: args[0] is the sPAPR hcall number
3978             args[1] is 0 to disable, 1 to enable in-kernel handling
3979
3980 This capability controls whether individual sPAPR hypercalls (hcalls)
3981 get handled by the kernel or not.  Enabling or disabling in-kernel
3982 handling of an hcall is effective across the VM.  On creation, an
3983 initial set of hcalls are enabled for in-kernel handling, which
3984 consists of those hcalls for which in-kernel handlers were implemented
3985 before this capability was implemented.  If disabled, the kernel will
3986 not to attempt to handle the hcall, but will always exit to userspace
3987 to handle it.  Note that it may not make sense to enable some and
3988 disable others of a group of related hcalls, but KVM does not prevent
3989 userspace from doing that.
3990
3991 If the hcall number specified is not one that has an in-kernel
3992 implementation, the KVM_ENABLE_CAP ioctl will fail with an EINVAL
3993 error.
3994
3995 7.2 KVM_CAP_S390_USER_SIGP
3996
3997 Architectures: s390
3998 Parameters: none
3999
4000 This capability controls which SIGP orders will be handled completely in user
4001 space. With this capability enabled, all fast orders will be handled completely
4002 in the kernel:
4003 - SENSE
4004 - SENSE RUNNING
4005 - EXTERNAL CALL
4006 - EMERGENCY SIGNAL
4007 - CONDITIONAL EMERGENCY SIGNAL
4008
4009 All other orders will be handled completely in user space.
4010
4011 Only privileged operation exceptions will be checked for in the kernel (or even
4012 in the hardware prior to interception). If this capability is not enabled, the
4013 old way of handling SIGP orders is used (partially in kernel and user space).
4014
4015 7.3 KVM_CAP_S390_VECTOR_REGISTERS
4016
4017 Architectures: s390
4018 Parameters: none
4019 Returns: 0 on success, negative value on error
4020
4021 Allows use of the vector registers introduced with z13 processor, and
4022 provides for the synchronization between host and user space.  Will
4023 return -EINVAL if the machine does not support vectors.
4024
4025 7.4 KVM_CAP_S390_USER_STSI
4026
4027 Architectures: s390
4028 Parameters: none
4029
4030 This capability allows post-handlers for the STSI instruction. After
4031 initial handling in the kernel, KVM exits to user space with
4032 KVM_EXIT_S390_STSI to allow user space to insert further data.
4033
4034 Before exiting to userspace, kvm handlers should fill in s390_stsi field of
4035 vcpu->run:
4036 struct {
4037         __u64 addr;
4038         __u8 ar;
4039         __u8 reserved;
4040         __u8 fc;
4041         __u8 sel1;
4042         __u16 sel2;
4043 } s390_stsi;
4044
4045 @addr - guest address of STSI SYSIB
4046 @fc   - function code
4047 @sel1 - selector 1
4048 @sel2 - selector 2
4049 @ar   - access register number
4050
4051 KVM handlers should exit to userspace with rc = -EREMOTE.
4052
4053 7.5 KVM_CAP_SPLIT_IRQCHIP
4054
4055 Architectures: x86
4056 Parameters: args[0] - number of routes reserved for userspace IOAPICs
4057 Returns: 0 on success, -1 on error
4058
4059 Create a local apic for each processor in the kernel. This can be used
4060 instead of KVM_CREATE_IRQCHIP if the userspace VMM wishes to emulate the
4061 IOAPIC and PIC (and also the PIT, even though this has to be enabled
4062 separately).
4063
4064 This capability also enables in kernel routing of interrupt requests;
4065 when KVM_CAP_SPLIT_IRQCHIP only routes of KVM_IRQ_ROUTING_MSI type are
4066 used in the IRQ routing table.  The first args[0] MSI routes are reserved
4067 for the IOAPIC pins.  Whenever the LAPIC receives an EOI for these routes,
4068 a KVM_EXIT_IOAPIC_EOI vmexit will be reported to userspace.
4069
4070 Fails if VCPU has already been created, or if the irqchip is already in the
4071 kernel (i.e. KVM_CREATE_IRQCHIP has already been called).
4072
4073 7.6 KVM_CAP_S390_RI
4074
4075 Architectures: s390
4076 Parameters: none
4077
4078 Allows use of runtime-instrumentation introduced with zEC12 processor.
4079 Will return -EINVAL if the machine does not support runtime-instrumentation.
4080 Will return -EBUSY if a VCPU has already been created.
4081
4082 7.7 KVM_CAP_X2APIC_API
4083
4084 Architectures: x86
4085 Parameters: args[0] - features that should be enabled
4086 Returns: 0 on success, -EINVAL when args[0] contains invalid features
4087
4088 Valid feature flags in args[0] are
4089
4090 #define KVM_X2APIC_API_USE_32BIT_IDS            (1ULL << 0)
4091 #define KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK  (1ULL << 1)
4092
4093 Enabling KVM_X2APIC_API_USE_32BIT_IDS changes the behavior of
4094 KVM_SET_GSI_ROUTING, KVM_SIGNAL_MSI, KVM_SET_LAPIC, and KVM_GET_LAPIC,
4095 allowing the use of 32-bit APIC IDs.  See KVM_CAP_X2APIC_API in their
4096 respective sections.
4097
4098 KVM_X2APIC_API_DISABLE_BROADCAST_QUIRK must be enabled for x2APIC to work
4099 in logical mode or with more than 255 VCPUs.  Otherwise, KVM treats 0xff
4100 as a broadcast even in x2APIC mode in order to support physical x2APIC
4101 without interrupt remapping.  This is undesirable in logical mode,
4102 where 0xff represents CPUs 0-7 in cluster 0.
4103
4104 7.8 KVM_CAP_S390_USER_INSTR0
4105
4106 Architectures: s390
4107 Parameters: none
4108
4109 With this capability enabled, all illegal instructions 0x0000 (2 bytes) will
4110 be intercepted and forwarded to user space. User space can use this
4111 mechanism e.g. to realize 2-byte software breakpoints. The kernel will
4112 not inject an operating exception for these instructions, user space has
4113 to take care of that.
4114
4115 This capability can be enabled dynamically even if VCPUs were already
4116 created and are running.
4117
4118 8. Other capabilities.
4119 ----------------------
4120
4121 This section lists capabilities that give information about other
4122 features of the KVM implementation.
4123
4124 8.1 KVM_CAP_PPC_HWRNG
4125
4126 Architectures: ppc
4127
4128 This capability, if KVM_CHECK_EXTENSION indicates that it is
4129 available, means that that the kernel has an implementation of the
4130 H_RANDOM hypercall backed by a hardware random-number generator.
4131 If present, the kernel H_RANDOM handler can be enabled for guest use
4132 with the KVM_CAP_PPC_ENABLE_HCALL capability.
4133
4134 8.2 KVM_CAP_HYPERV_SYNIC
4135
4136 Architectures: x86
4137 This capability, if KVM_CHECK_EXTENSION indicates that it is
4138 available, means that that the kernel has an implementation of the
4139 Hyper-V Synthetic interrupt controller(SynIC). Hyper-V SynIC is
4140 used to support Windows Hyper-V based guest paravirt drivers(VMBus).
4141
4142 In order to use SynIC, it has to be activated by setting this
4143 capability via KVM_ENABLE_CAP ioctl on the vcpu fd. Note that this
4144 will disable the use of APIC hardware virtualization even if supported
4145 by the CPU, as it's incompatible with SynIC auto-EOI behavior.
4146
4147 8.3 KVM_CAP_PPC_RADIX_MMU
4148
4149 Architectures: ppc
4150
4151 This capability, if KVM_CHECK_EXTENSION indicates that it is
4152 available, means that that the kernel can support guests using the
4153 radix MMU defined in Power ISA V3.00 (as implemented in the POWER9
4154 processor).
4155
4156 8.4 KVM_CAP_PPC_HASH_MMU_V3
4157
4158 Architectures: ppc
4159
4160 This capability, if KVM_CHECK_EXTENSION indicates that it is
4161 available, means that that the kernel can support guests using the
4162 hashed page table MMU defined in Power ISA V3.00 (as implemented in
4163 the POWER9 processor), including in-memory segment tables.
4164
4165 8.5 KVM_CAP_MIPS_VZ
4166
4167 Architectures: mips
4168
4169 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
4170 it is available, means that full hardware assisted virtualization capabilities
4171 of the hardware are available for use through KVM. An appropriate
4172 KVM_VM_MIPS_* type must be passed to KVM_CREATE_VM to create a VM which
4173 utilises it.
4174
4175 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
4176 available, it means that the VM is using full hardware assisted virtualization
4177 capabilities of the hardware. This is useful to check after creating a VM with
4178 KVM_VM_MIPS_DEFAULT.
4179
4180 The value returned by KVM_CHECK_EXTENSION should be compared against known
4181 values (see below). All other values are reserved. This is to allow for the
4182 possibility of other hardware assisted virtualization implementations which
4183 may be incompatible with the MIPS VZ ASE.
4184
4185  0: The trap & emulate implementation is in use to run guest code in user
4186     mode. Guest virtual memory segments are rearranged to fit the guest in the
4187     user mode address space.
4188
4189  1: The MIPS VZ ASE is in use, providing full hardware assisted
4190     virtualization, including standard guest virtual memory segments.
4191
4192 8.6 KVM_CAP_MIPS_TE
4193
4194 Architectures: mips
4195
4196 This capability, if KVM_CHECK_EXTENSION on the main kvm handle indicates that
4197 it is available, means that the trap & emulate implementation is available to
4198 run guest code in user mode, even if KVM_CAP_MIPS_VZ indicates that hardware
4199 assisted virtualisation is also available. KVM_VM_MIPS_TE (0) must be passed
4200 to KVM_CREATE_VM to create a VM which utilises it.
4201
4202 If KVM_CHECK_EXTENSION on a kvm VM handle indicates that this capability is
4203 available, it means that the VM is using trap & emulate.
4204
4205 8.7 KVM_CAP_MIPS_64BIT
4206
4207 Architectures: mips
4208
4209 This capability indicates the supported architecture type of the guest, i.e. the
4210 supported register and address width.
4211
4212 The values returned when this capability is checked by KVM_CHECK_EXTENSION on a
4213 kvm VM handle correspond roughly to the CP0_Config.AT register field, and should
4214 be checked specifically against known values (see below). All other values are
4215 reserved.
4216
4217  0: MIPS32 or microMIPS32.
4218     Both registers and addresses are 32-bits wide.
4219     It will only be possible to run 32-bit guest code.
4220
4221  1: MIPS64 or microMIPS64 with access only to 32-bit compatibility segments.
4222     Registers are 64-bits wide, but addresses are 32-bits wide.
4223     64-bit guest code may run but cannot access MIPS64 memory segments.
4224     It will also be possible to run 32-bit guest code.
4225
4226  2: MIPS64 or microMIPS64 with access to all address segments.
4227     Both registers and addresses are 64-bits wide.
4228     It will be possible to run 64-bit or 32-bit guest code.