Revert "KVM: MMU: lazily drop large spte"
[linux-3.10.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 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), or a KVM_CAP_xyz constant, which
72       means availability needs to be checked with KVM_CHECK_EXTENSION
73       (see section 4.4).
74
75   Architectures: which instruction set architectures provide this ioctl.
76       x86 includes both i386 and x86_64.
77
78   Type: system, vm, or vcpu.
79
80   Parameters: what parameters are accepted by the ioctl.
81
82   Returns: the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
83       are not detailed, but errors with specific meanings are.
84
85
86 4.1 KVM_GET_API_VERSION
87
88 Capability: basic
89 Architectures: all
90 Type: system ioctl
91 Parameters: none
92 Returns: the constant KVM_API_VERSION (=12)
93
94 This identifies the API version as the stable kvm API. It is not
95 expected that this number will change.  However, Linux 2.6.20 and
96 2.6.21 report earlier versions; these are not documented and not
97 supported.  Applications should refuse to run if KVM_GET_API_VERSION
98 returns a value other than 12.  If this check passes, all ioctls
99 described as 'basic' will be available.
100
101
102 4.2 KVM_CREATE_VM
103
104 Capability: basic
105 Architectures: all
106 Type: system ioctl
107 Parameters: machine type identifier (KVM_VM_*)
108 Returns: a VM fd that can be used to control the new virtual machine.
109
110 The new VM has no virtual cpus and no memory.  An mmap() of a VM fd
111 will access the virtual machine's physical address space; offset zero
112 corresponds to guest physical address zero.  Use of mmap() on a VM fd
113 is discouraged if userspace memory allocation (KVM_CAP_USER_MEMORY) is
114 available.
115 You most certainly want to use 0 as machine type.
116
117 In order to create user controlled virtual machines on S390, check
118 KVM_CAP_S390_UCONTROL and use the flag KVM_VM_S390_UCONTROL as
119 privileged user (CAP_SYS_ADMIN).
120
121
122 4.3 KVM_GET_MSR_INDEX_LIST
123
124 Capability: basic
125 Architectures: x86
126 Type: system
127 Parameters: struct kvm_msr_list (in/out)
128 Returns: 0 on success; -1 on error
129 Errors:
130   E2BIG:     the msr index list is to be to fit in the array specified by
131              the user.
132
133 struct kvm_msr_list {
134         __u32 nmsrs; /* number of msrs in entries */
135         __u32 indices[0];
136 };
137
138 This ioctl returns the guest msrs that are supported.  The list varies
139 by kvm version and host processor, but does not change otherwise.  The
140 user fills in the size of the indices array in nmsrs, and in return
141 kvm adjusts nmsrs to reflect the actual number of msrs and fills in
142 the indices array with their numbers.
143
144 Note: if kvm indicates supports MCE (KVM_CAP_MCE), then the MCE bank MSRs are
145 not returned in the MSR list, as different vcpus can have a different number
146 of banks, as set via the KVM_X86_SETUP_MCE ioctl.
147
148
149 4.4 KVM_CHECK_EXTENSION
150
151 Capability: basic
152 Architectures: all
153 Type: system ioctl
154 Parameters: extension identifier (KVM_CAP_*)
155 Returns: 0 if unsupported; 1 (or some other positive integer) if supported
156
157 The API allows the application to query about extensions to the core
158 kvm API.  Userspace passes an extension identifier (an integer) and
159 receives an integer that describes the extension availability.
160 Generally 0 means no and 1 means yes, but some extensions may report
161 additional information in the integer return value.
162
163
164 4.5 KVM_GET_VCPU_MMAP_SIZE
165
166 Capability: basic
167 Architectures: all
168 Type: system ioctl
169 Parameters: none
170 Returns: size of vcpu mmap area, in bytes
171
172 The KVM_RUN ioctl (cf.) communicates with userspace via a shared
173 memory region.  This ioctl returns the size of that region.  See the
174 KVM_RUN documentation for details.
175
176
177 4.6 KVM_SET_MEMORY_REGION
178
179 Capability: basic
180 Architectures: all
181 Type: vm ioctl
182 Parameters: struct kvm_memory_region (in)
183 Returns: 0 on success, -1 on error
184
185 This ioctl is obsolete and has been removed.
186
187
188 4.7 KVM_CREATE_VCPU
189
190 Capability: basic
191 Architectures: all
192 Type: vm ioctl
193 Parameters: vcpu id (apic id on x86)
194 Returns: vcpu fd on success, -1 on error
195
196 This API adds a vcpu to a virtual machine.  The vcpu id is a small integer
197 in the range [0, max_vcpus).
198
199 The recommended max_vcpus value can be retrieved using the KVM_CAP_NR_VCPUS of
200 the KVM_CHECK_EXTENSION ioctl() at run-time.
201 The maximum possible value for max_vcpus can be retrieved using the
202 KVM_CAP_MAX_VCPUS of the KVM_CHECK_EXTENSION ioctl() at run-time.
203
204 If the KVM_CAP_NR_VCPUS does not exist, you should assume that max_vcpus is 4
205 cpus max.
206 If the KVM_CAP_MAX_VCPUS does not exist, you should assume that max_vcpus is
207 same as the value returned from KVM_CAP_NR_VCPUS.
208
209 On powerpc using book3s_hv mode, the vcpus are mapped onto virtual
210 threads in one or more virtual CPU cores.  (This is because the
211 hardware requires all the hardware threads in a CPU core to be in the
212 same partition.)  The KVM_CAP_PPC_SMT capability indicates the number
213 of vcpus per virtual core (vcore).  The vcore id is obtained by
214 dividing the vcpu id by the number of vcpus per vcore.  The vcpus in a
215 given vcore will always be in the same physical core as each other
216 (though that might be a different physical core from time to time).
217 Userspace can control the threading (SMT) mode of the guest by its
218 allocation of vcpu ids.  For example, if userspace wants
219 single-threaded guest vcpus, it should make all vcpu ids be a multiple
220 of the number of vcpus per vcore.
221
222 For virtual cpus that have been created with S390 user controlled virtual
223 machines, the resulting vcpu fd can be memory mapped at page offset
224 KVM_S390_SIE_PAGE_OFFSET in order to obtain a memory map of the virtual
225 cpu's hardware control block.
226
227
228 4.8 KVM_GET_DIRTY_LOG (vm ioctl)
229
230 Capability: basic
231 Architectures: x86
232 Type: vm ioctl
233 Parameters: struct kvm_dirty_log (in/out)
234 Returns: 0 on success, -1 on error
235
236 /* for KVM_GET_DIRTY_LOG */
237 struct kvm_dirty_log {
238         __u32 slot;
239         __u32 padding;
240         union {
241                 void __user *dirty_bitmap; /* one bit per page */
242                 __u64 padding;
243         };
244 };
245
246 Given a memory slot, return a bitmap containing any pages dirtied
247 since the last call to this ioctl.  Bit 0 is the first page in the
248 memory slot.  Ensure the entire structure is cleared to avoid padding
249 issues.
250
251
252 4.9 KVM_SET_MEMORY_ALIAS
253
254 Capability: basic
255 Architectures: x86
256 Type: vm ioctl
257 Parameters: struct kvm_memory_alias (in)
258 Returns: 0 (success), -1 (error)
259
260 This ioctl is obsolete and has been removed.
261
262
263 4.10 KVM_RUN
264
265 Capability: basic
266 Architectures: all
267 Type: vcpu ioctl
268 Parameters: none
269 Returns: 0 on success, -1 on error
270 Errors:
271   EINTR:     an unmasked signal is pending
272
273 This ioctl is used to run a guest virtual cpu.  While there are no
274 explicit parameters, there is an implicit parameter block that can be
275 obtained by mmap()ing the vcpu fd at offset 0, with the size given by
276 KVM_GET_VCPU_MMAP_SIZE.  The parameter block is formatted as a 'struct
277 kvm_run' (see below).
278
279
280 4.11 KVM_GET_REGS
281
282 Capability: basic
283 Architectures: all
284 Type: vcpu ioctl
285 Parameters: struct kvm_regs (out)
286 Returns: 0 on success, -1 on error
287
288 Reads the general purpose registers from the vcpu.
289
290 /* x86 */
291 struct kvm_regs {
292         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
293         __u64 rax, rbx, rcx, rdx;
294         __u64 rsi, rdi, rsp, rbp;
295         __u64 r8,  r9,  r10, r11;
296         __u64 r12, r13, r14, r15;
297         __u64 rip, rflags;
298 };
299
300
301 4.12 KVM_SET_REGS
302
303 Capability: basic
304 Architectures: all
305 Type: vcpu ioctl
306 Parameters: struct kvm_regs (in)
307 Returns: 0 on success, -1 on error
308
309 Writes the general purpose registers into the vcpu.
310
311 See KVM_GET_REGS for the data structure.
312
313
314 4.13 KVM_GET_SREGS
315
316 Capability: basic
317 Architectures: x86, ppc
318 Type: vcpu ioctl
319 Parameters: struct kvm_sregs (out)
320 Returns: 0 on success, -1 on error
321
322 Reads special registers from the vcpu.
323
324 /* x86 */
325 struct kvm_sregs {
326         struct kvm_segment cs, ds, es, fs, gs, ss;
327         struct kvm_segment tr, ldt;
328         struct kvm_dtable gdt, idt;
329         __u64 cr0, cr2, cr3, cr4, cr8;
330         __u64 efer;
331         __u64 apic_base;
332         __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
333 };
334
335 /* ppc -- see arch/powerpc/include/uapi/asm/kvm.h */
336
337 interrupt_bitmap is a bitmap of pending external interrupts.  At most
338 one bit may be set.  This interrupt has been acknowledged by the APIC
339 but not yet injected into the cpu core.
340
341
342 4.14 KVM_SET_SREGS
343
344 Capability: basic
345 Architectures: x86, ppc
346 Type: vcpu ioctl
347 Parameters: struct kvm_sregs (in)
348 Returns: 0 on success, -1 on error
349
350 Writes special registers into the vcpu.  See KVM_GET_SREGS for the
351 data structures.
352
353
354 4.15 KVM_TRANSLATE
355
356 Capability: basic
357 Architectures: x86
358 Type: vcpu ioctl
359 Parameters: struct kvm_translation (in/out)
360 Returns: 0 on success, -1 on error
361
362 Translates a virtual address according to the vcpu's current address
363 translation mode.
364
365 struct kvm_translation {
366         /* in */
367         __u64 linear_address;
368
369         /* out */
370         __u64 physical_address;
371         __u8  valid;
372         __u8  writeable;
373         __u8  usermode;
374         __u8  pad[5];
375 };
376
377
378 4.16 KVM_INTERRUPT
379
380 Capability: basic
381 Architectures: x86, ppc
382 Type: vcpu ioctl
383 Parameters: struct kvm_interrupt (in)
384 Returns: 0 on success, -1 on error
385
386 Queues a hardware interrupt vector to be injected.  This is only
387 useful if in-kernel local APIC or equivalent is not used.
388
389 /* for KVM_INTERRUPT */
390 struct kvm_interrupt {
391         /* in */
392         __u32 irq;
393 };
394
395 X86:
396
397 Note 'irq' is an interrupt vector, not an interrupt pin or line.
398
399 PPC:
400
401 Queues an external interrupt to be injected. This ioctl is overleaded
402 with 3 different irq values:
403
404 a) KVM_INTERRUPT_SET
405
406   This injects an edge type external interrupt into the guest once it's ready
407   to receive interrupts. When injected, the interrupt is done.
408
409 b) KVM_INTERRUPT_UNSET
410
411   This unsets any pending interrupt.
412
413   Only available with KVM_CAP_PPC_UNSET_IRQ.
414
415 c) KVM_INTERRUPT_SET_LEVEL
416
417   This injects a level type external interrupt into the guest context. The
418   interrupt stays pending until a specific ioctl with KVM_INTERRUPT_UNSET
419   is triggered.
420
421   Only available with KVM_CAP_PPC_IRQ_LEVEL.
422
423 Note that any value for 'irq' other than the ones stated above is invalid
424 and incurs unexpected behavior.
425
426
427 4.17 KVM_DEBUG_GUEST
428
429 Capability: basic
430 Architectures: none
431 Type: vcpu ioctl
432 Parameters: none)
433 Returns: -1 on error
434
435 Support for this has been removed.  Use KVM_SET_GUEST_DEBUG instead.
436
437
438 4.18 KVM_GET_MSRS
439
440 Capability: basic
441 Architectures: x86
442 Type: vcpu ioctl
443 Parameters: struct kvm_msrs (in/out)
444 Returns: 0 on success, -1 on error
445
446 Reads model-specific registers from the vcpu.  Supported msr indices can
447 be obtained using KVM_GET_MSR_INDEX_LIST.
448
449 struct kvm_msrs {
450         __u32 nmsrs; /* number of msrs in entries */
451         __u32 pad;
452
453         struct kvm_msr_entry entries[0];
454 };
455
456 struct kvm_msr_entry {
457         __u32 index;
458         __u32 reserved;
459         __u64 data;
460 };
461
462 Application code should set the 'nmsrs' member (which indicates the
463 size of the entries array) and the 'index' member of each array entry.
464 kvm will fill in the 'data' member.
465
466
467 4.19 KVM_SET_MSRS
468
469 Capability: basic
470 Architectures: x86
471 Type: vcpu ioctl
472 Parameters: struct kvm_msrs (in)
473 Returns: 0 on success, -1 on error
474
475 Writes model-specific registers to the vcpu.  See KVM_GET_MSRS for the
476 data structures.
477
478 Application code should set the 'nmsrs' member (which indicates the
479 size of the entries array), and the 'index' and 'data' members of each
480 array entry.
481
482
483 4.20 KVM_SET_CPUID
484
485 Capability: basic
486 Architectures: x86
487 Type: vcpu ioctl
488 Parameters: struct kvm_cpuid (in)
489 Returns: 0 on success, -1 on error
490
491 Defines the vcpu responses to the cpuid instruction.  Applications
492 should use the KVM_SET_CPUID2 ioctl if available.
493
494
495 struct kvm_cpuid_entry {
496         __u32 function;
497         __u32 eax;
498         __u32 ebx;
499         __u32 ecx;
500         __u32 edx;
501         __u32 padding;
502 };
503
504 /* for KVM_SET_CPUID */
505 struct kvm_cpuid {
506         __u32 nent;
507         __u32 padding;
508         struct kvm_cpuid_entry entries[0];
509 };
510
511
512 4.21 KVM_SET_SIGNAL_MASK
513
514 Capability: basic
515 Architectures: x86
516 Type: vcpu ioctl
517 Parameters: struct kvm_signal_mask (in)
518 Returns: 0 on success, -1 on error
519
520 Defines which signals are blocked during execution of KVM_RUN.  This
521 signal mask temporarily overrides the threads signal mask.  Any
522 unblocked signal received (except SIGKILL and SIGSTOP, which retain
523 their traditional behaviour) will cause KVM_RUN to return with -EINTR.
524
525 Note the signal will only be delivered if not blocked by the original
526 signal mask.
527
528 /* for KVM_SET_SIGNAL_MASK */
529 struct kvm_signal_mask {
530         __u32 len;
531         __u8  sigset[0];
532 };
533
534
535 4.22 KVM_GET_FPU
536
537 Capability: basic
538 Architectures: x86
539 Type: vcpu ioctl
540 Parameters: struct kvm_fpu (out)
541 Returns: 0 on success, -1 on error
542
543 Reads the floating point state from the vcpu.
544
545 /* for KVM_GET_FPU and KVM_SET_FPU */
546 struct kvm_fpu {
547         __u8  fpr[8][16];
548         __u16 fcw;
549         __u16 fsw;
550         __u8  ftwx;  /* in fxsave format */
551         __u8  pad1;
552         __u16 last_opcode;
553         __u64 last_ip;
554         __u64 last_dp;
555         __u8  xmm[16][16];
556         __u32 mxcsr;
557         __u32 pad2;
558 };
559
560
561 4.23 KVM_SET_FPU
562
563 Capability: basic
564 Architectures: x86
565 Type: vcpu ioctl
566 Parameters: struct kvm_fpu (in)
567 Returns: 0 on success, -1 on error
568
569 Writes the floating point state to the vcpu.
570
571 /* for KVM_GET_FPU and KVM_SET_FPU */
572 struct kvm_fpu {
573         __u8  fpr[8][16];
574         __u16 fcw;
575         __u16 fsw;
576         __u8  ftwx;  /* in fxsave format */
577         __u8  pad1;
578         __u16 last_opcode;
579         __u64 last_ip;
580         __u64 last_dp;
581         __u8  xmm[16][16];
582         __u32 mxcsr;
583         __u32 pad2;
584 };
585
586
587 4.24 KVM_CREATE_IRQCHIP
588
589 Capability: KVM_CAP_IRQCHIP
590 Architectures: x86, ia64
591 Type: vm ioctl
592 Parameters: none
593 Returns: 0 on success, -1 on error
594
595 Creates an interrupt controller model in the kernel.  On x86, creates a virtual
596 ioapic, a virtual PIC (two PICs, nested), and sets up future vcpus to have a
597 local APIC.  IRQ routing for GSIs 0-15 is set to both PIC and IOAPIC; GSI 16-23
598 only go to the IOAPIC.  On ia64, a IOSAPIC is created.
599
600
601 4.25 KVM_IRQ_LINE
602
603 Capability: KVM_CAP_IRQCHIP
604 Architectures: x86, ia64
605 Type: vm ioctl
606 Parameters: struct kvm_irq_level
607 Returns: 0 on success, -1 on error
608
609 Sets the level of a GSI input to the interrupt controller model in the kernel.
610 Requires that an interrupt controller model has been previously created with
611 KVM_CREATE_IRQCHIP.  Note that edge-triggered interrupts require the level
612 to be set to 1 and then back to 0.
613
614 struct kvm_irq_level {
615         union {
616                 __u32 irq;     /* GSI */
617                 __s32 status;  /* not used for KVM_IRQ_LEVEL */
618         };
619         __u32 level;           /* 0 or 1 */
620 };
621
622
623 4.26 KVM_GET_IRQCHIP
624
625 Capability: KVM_CAP_IRQCHIP
626 Architectures: x86, ia64
627 Type: vm ioctl
628 Parameters: struct kvm_irqchip (in/out)
629 Returns: 0 on success, -1 on error
630
631 Reads the state of a kernel interrupt controller created with
632 KVM_CREATE_IRQCHIP into a buffer provided by the caller.
633
634 struct kvm_irqchip {
635         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
636         __u32 pad;
637         union {
638                 char dummy[512];  /* reserving space */
639                 struct kvm_pic_state pic;
640                 struct kvm_ioapic_state ioapic;
641         } chip;
642 };
643
644
645 4.27 KVM_SET_IRQCHIP
646
647 Capability: KVM_CAP_IRQCHIP
648 Architectures: x86, ia64
649 Type: vm ioctl
650 Parameters: struct kvm_irqchip (in)
651 Returns: 0 on success, -1 on error
652
653 Sets the state of a kernel interrupt controller created with
654 KVM_CREATE_IRQCHIP from a buffer provided by the caller.
655
656 struct kvm_irqchip {
657         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
658         __u32 pad;
659         union {
660                 char dummy[512];  /* reserving space */
661                 struct kvm_pic_state pic;
662                 struct kvm_ioapic_state ioapic;
663         } chip;
664 };
665
666
667 4.28 KVM_XEN_HVM_CONFIG
668
669 Capability: KVM_CAP_XEN_HVM
670 Architectures: x86
671 Type: vm ioctl
672 Parameters: struct kvm_xen_hvm_config (in)
673 Returns: 0 on success, -1 on error
674
675 Sets the MSR that the Xen HVM guest uses to initialize its hypercall
676 page, and provides the starting address and size of the hypercall
677 blobs in userspace.  When the guest writes the MSR, kvm copies one
678 page of a blob (32- or 64-bit, depending on the vcpu mode) to guest
679 memory.
680
681 struct kvm_xen_hvm_config {
682         __u32 flags;
683         __u32 msr;
684         __u64 blob_addr_32;
685         __u64 blob_addr_64;
686         __u8 blob_size_32;
687         __u8 blob_size_64;
688         __u8 pad2[30];
689 };
690
691
692 4.29 KVM_GET_CLOCK
693
694 Capability: KVM_CAP_ADJUST_CLOCK
695 Architectures: x86
696 Type: vm ioctl
697 Parameters: struct kvm_clock_data (out)
698 Returns: 0 on success, -1 on error
699
700 Gets the current timestamp of kvmclock as seen by the current guest. In
701 conjunction with KVM_SET_CLOCK, it is used to ensure monotonicity on scenarios
702 such as migration.
703
704 struct kvm_clock_data {
705         __u64 clock;  /* kvmclock current value */
706         __u32 flags;
707         __u32 pad[9];
708 };
709
710
711 4.30 KVM_SET_CLOCK
712
713 Capability: KVM_CAP_ADJUST_CLOCK
714 Architectures: x86
715 Type: vm ioctl
716 Parameters: struct kvm_clock_data (in)
717 Returns: 0 on success, -1 on error
718
719 Sets the current timestamp of kvmclock to the value specified in its parameter.
720 In conjunction with KVM_GET_CLOCK, it is used to ensure monotonicity on scenarios
721 such as migration.
722
723 struct kvm_clock_data {
724         __u64 clock;  /* kvmclock current value */
725         __u32 flags;
726         __u32 pad[9];
727 };
728
729
730 4.31 KVM_GET_VCPU_EVENTS
731
732 Capability: KVM_CAP_VCPU_EVENTS
733 Extended by: KVM_CAP_INTR_SHADOW
734 Architectures: x86
735 Type: vm ioctl
736 Parameters: struct kvm_vcpu_event (out)
737 Returns: 0 on success, -1 on error
738
739 Gets currently pending exceptions, interrupts, and NMIs as well as related
740 states of the vcpu.
741
742 struct kvm_vcpu_events {
743         struct {
744                 __u8 injected;
745                 __u8 nr;
746                 __u8 has_error_code;
747                 __u8 pad;
748                 __u32 error_code;
749         } exception;
750         struct {
751                 __u8 injected;
752                 __u8 nr;
753                 __u8 soft;
754                 __u8 shadow;
755         } interrupt;
756         struct {
757                 __u8 injected;
758                 __u8 pending;
759                 __u8 masked;
760                 __u8 pad;
761         } nmi;
762         __u32 sipi_vector;
763         __u32 flags;
764 };
765
766 KVM_VCPUEVENT_VALID_SHADOW may be set in the flags field to signal that
767 interrupt.shadow contains a valid state. Otherwise, this field is undefined.
768
769
770 4.32 KVM_SET_VCPU_EVENTS
771
772 Capability: KVM_CAP_VCPU_EVENTS
773 Extended by: KVM_CAP_INTR_SHADOW
774 Architectures: x86
775 Type: vm ioctl
776 Parameters: struct kvm_vcpu_event (in)
777 Returns: 0 on success, -1 on error
778
779 Set pending exceptions, interrupts, and NMIs as well as related states of the
780 vcpu.
781
782 See KVM_GET_VCPU_EVENTS for the data structure.
783
784 Fields that may be modified asynchronously by running VCPUs can be excluded
785 from the update. These fields are nmi.pending and sipi_vector. Keep the
786 corresponding bits in the flags field cleared to suppress overwriting the
787 current in-kernel state. The bits are:
788
789 KVM_VCPUEVENT_VALID_NMI_PENDING - transfer nmi.pending to the kernel
790 KVM_VCPUEVENT_VALID_SIPI_VECTOR - transfer sipi_vector
791
792 If KVM_CAP_INTR_SHADOW is available, KVM_VCPUEVENT_VALID_SHADOW can be set in
793 the flags field to signal that interrupt.shadow contains a valid state and
794 shall be written into the VCPU.
795
796
797 4.33 KVM_GET_DEBUGREGS
798
799 Capability: KVM_CAP_DEBUGREGS
800 Architectures: x86
801 Type: vm ioctl
802 Parameters: struct kvm_debugregs (out)
803 Returns: 0 on success, -1 on error
804
805 Reads debug registers from the vcpu.
806
807 struct kvm_debugregs {
808         __u64 db[4];
809         __u64 dr6;
810         __u64 dr7;
811         __u64 flags;
812         __u64 reserved[9];
813 };
814
815
816 4.34 KVM_SET_DEBUGREGS
817
818 Capability: KVM_CAP_DEBUGREGS
819 Architectures: x86
820 Type: vm ioctl
821 Parameters: struct kvm_debugregs (in)
822 Returns: 0 on success, -1 on error
823
824 Writes debug registers into the vcpu.
825
826 See KVM_GET_DEBUGREGS for the data structure. The flags field is unused
827 yet and must be cleared on entry.
828
829
830 4.35 KVM_SET_USER_MEMORY_REGION
831
832 Capability: KVM_CAP_USER_MEM
833 Architectures: all
834 Type: vm ioctl
835 Parameters: struct kvm_userspace_memory_region (in)
836 Returns: 0 on success, -1 on error
837
838 struct kvm_userspace_memory_region {
839         __u32 slot;
840         __u32 flags;
841         __u64 guest_phys_addr;
842         __u64 memory_size; /* bytes */
843         __u64 userspace_addr; /* start of the userspace allocated memory */
844 };
845
846 /* for kvm_memory_region::flags */
847 #define KVM_MEM_LOG_DIRTY_PAGES (1UL << 0)
848 #define KVM_MEM_READONLY        (1UL << 1)
849
850 This ioctl allows the user to create or modify a guest physical memory
851 slot.  When changing an existing slot, it may be moved in the guest
852 physical memory space, or its flags may be modified.  It may not be
853 resized.  Slots may not overlap in guest physical address space.
854
855 Memory for the region is taken starting at the address denoted by the
856 field userspace_addr, which must point at user addressable memory for
857 the entire memory slot size.  Any object may back this memory, including
858 anonymous memory, ordinary files, and hugetlbfs.
859
860 It is recommended that the lower 21 bits of guest_phys_addr and userspace_addr
861 be identical.  This allows large pages in the guest to be backed by large
862 pages in the host.
863
864 The flags field supports two flags: KVM_MEM_LOG_DIRTY_PAGES and
865 KVM_MEM_READONLY.  The former can be set to instruct KVM to keep track of
866 writes to memory within the slot.  See KVM_GET_DIRTY_LOG ioctl to know how to
867 use it.  The latter can be set, if KVM_CAP_READONLY_MEM capability allows it,
868 to make a new slot read-only.  In this case, writes to this memory will be
869 posted to userspace as KVM_EXIT_MMIO exits.
870
871 When the KVM_CAP_SYNC_MMU capability is available, changes in the backing of
872 the memory region are automatically reflected into the guest.  For example, an
873 mmap() that affects the region will be made visible immediately.  Another
874 example is madvise(MADV_DROP).
875
876 It is recommended to use this API instead of the KVM_SET_MEMORY_REGION ioctl.
877 The KVM_SET_MEMORY_REGION does not allow fine grained control over memory
878 allocation and is deprecated.
879
880
881 4.36 KVM_SET_TSS_ADDR
882
883 Capability: KVM_CAP_SET_TSS_ADDR
884 Architectures: x86
885 Type: vm ioctl
886 Parameters: unsigned long tss_address (in)
887 Returns: 0 on success, -1 on error
888
889 This ioctl defines the physical address of a three-page region in the guest
890 physical address space.  The region must be within the first 4GB of the
891 guest physical address space and must not conflict with any memory slot
892 or any mmio address.  The guest may malfunction if it accesses this memory
893 region.
894
895 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
896 because of a quirk in the virtualization implementation (see the internals
897 documentation when it pops into existence).
898
899
900 4.37 KVM_ENABLE_CAP
901
902 Capability: KVM_CAP_ENABLE_CAP
903 Architectures: ppc, s390
904 Type: vcpu ioctl
905 Parameters: struct kvm_enable_cap (in)
906 Returns: 0 on success; -1 on error
907
908 +Not all extensions are enabled by default. Using this ioctl the application
909 can enable an extension, making it available to the guest.
910
911 On systems that do not support this ioctl, it always fails. On systems that
912 do support it, it only works for extensions that are supported for enablement.
913
914 To check if a capability can be enabled, the KVM_CHECK_EXTENSION ioctl should
915 be used.
916
917 struct kvm_enable_cap {
918        /* in */
919        __u32 cap;
920
921 The capability that is supposed to get enabled.
922
923        __u32 flags;
924
925 A bitfield indicating future enhancements. Has to be 0 for now.
926
927        __u64 args[4];
928
929 Arguments for enabling a feature. If a feature needs initial values to
930 function properly, this is the place to put them.
931
932        __u8  pad[64];
933 };
934
935
936 4.38 KVM_GET_MP_STATE
937
938 Capability: KVM_CAP_MP_STATE
939 Architectures: x86, ia64
940 Type: vcpu ioctl
941 Parameters: struct kvm_mp_state (out)
942 Returns: 0 on success; -1 on error
943
944 struct kvm_mp_state {
945         __u32 mp_state;
946 };
947
948 Returns the vcpu's current "multiprocessing state" (though also valid on
949 uniprocessor guests).
950
951 Possible values are:
952
953  - KVM_MP_STATE_RUNNABLE:        the vcpu is currently running
954  - KVM_MP_STATE_UNINITIALIZED:   the vcpu is an application processor (AP)
955                                  which has not yet received an INIT signal
956  - KVM_MP_STATE_INIT_RECEIVED:   the vcpu has received an INIT signal, and is
957                                  now ready for a SIPI
958  - KVM_MP_STATE_HALTED:          the vcpu has executed a HLT instruction and
959                                  is waiting for an interrupt
960  - KVM_MP_STATE_SIPI_RECEIVED:   the vcpu has just received a SIPI (vector
961                                  accessible via KVM_GET_VCPU_EVENTS)
962
963 This ioctl is only useful after KVM_CREATE_IRQCHIP.  Without an in-kernel
964 irqchip, the multiprocessing state must be maintained by userspace.
965
966
967 4.39 KVM_SET_MP_STATE
968
969 Capability: KVM_CAP_MP_STATE
970 Architectures: x86, ia64
971 Type: vcpu ioctl
972 Parameters: struct kvm_mp_state (in)
973 Returns: 0 on success; -1 on error
974
975 Sets the vcpu's current "multiprocessing state"; see KVM_GET_MP_STATE for
976 arguments.
977
978 This ioctl is only useful after KVM_CREATE_IRQCHIP.  Without an in-kernel
979 irqchip, the multiprocessing state must be maintained by userspace.
980
981
982 4.40 KVM_SET_IDENTITY_MAP_ADDR
983
984 Capability: KVM_CAP_SET_IDENTITY_MAP_ADDR
985 Architectures: x86
986 Type: vm ioctl
987 Parameters: unsigned long identity (in)
988 Returns: 0 on success, -1 on error
989
990 This ioctl defines the physical address of a one-page region in the guest
991 physical address space.  The region must be within the first 4GB of the
992 guest physical address space and must not conflict with any memory slot
993 or any mmio address.  The guest may malfunction if it accesses this memory
994 region.
995
996 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
997 because of a quirk in the virtualization implementation (see the internals
998 documentation when it pops into existence).
999
1000
1001 4.41 KVM_SET_BOOT_CPU_ID
1002
1003 Capability: KVM_CAP_SET_BOOT_CPU_ID
1004 Architectures: x86, ia64
1005 Type: vm ioctl
1006 Parameters: unsigned long vcpu_id
1007 Returns: 0 on success, -1 on error
1008
1009 Define which vcpu is the Bootstrap Processor (BSP).  Values are the same
1010 as the vcpu id in KVM_CREATE_VCPU.  If this ioctl is not called, the default
1011 is vcpu 0.
1012
1013
1014 4.42 KVM_GET_XSAVE
1015
1016 Capability: KVM_CAP_XSAVE
1017 Architectures: x86
1018 Type: vcpu ioctl
1019 Parameters: struct kvm_xsave (out)
1020 Returns: 0 on success, -1 on error
1021
1022 struct kvm_xsave {
1023         __u32 region[1024];
1024 };
1025
1026 This ioctl would copy current vcpu's xsave struct to the userspace.
1027
1028
1029 4.43 KVM_SET_XSAVE
1030
1031 Capability: KVM_CAP_XSAVE
1032 Architectures: x86
1033 Type: vcpu ioctl
1034 Parameters: struct kvm_xsave (in)
1035 Returns: 0 on success, -1 on error
1036
1037 struct kvm_xsave {
1038         __u32 region[1024];
1039 };
1040
1041 This ioctl would copy userspace's xsave struct to the kernel.
1042
1043
1044 4.44 KVM_GET_XCRS
1045
1046 Capability: KVM_CAP_XCRS
1047 Architectures: x86
1048 Type: vcpu ioctl
1049 Parameters: struct kvm_xcrs (out)
1050 Returns: 0 on success, -1 on error
1051
1052 struct kvm_xcr {
1053         __u32 xcr;
1054         __u32 reserved;
1055         __u64 value;
1056 };
1057
1058 struct kvm_xcrs {
1059         __u32 nr_xcrs;
1060         __u32 flags;
1061         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1062         __u64 padding[16];
1063 };
1064
1065 This ioctl would copy current vcpu's xcrs to the userspace.
1066
1067
1068 4.45 KVM_SET_XCRS
1069
1070 Capability: KVM_CAP_XCRS
1071 Architectures: x86
1072 Type: vcpu ioctl
1073 Parameters: struct kvm_xcrs (in)
1074 Returns: 0 on success, -1 on error
1075
1076 struct kvm_xcr {
1077         __u32 xcr;
1078         __u32 reserved;
1079         __u64 value;
1080 };
1081
1082 struct kvm_xcrs {
1083         __u32 nr_xcrs;
1084         __u32 flags;
1085         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1086         __u64 padding[16];
1087 };
1088
1089 This ioctl would set vcpu's xcr to the value userspace specified.
1090
1091
1092 4.46 KVM_GET_SUPPORTED_CPUID
1093
1094 Capability: KVM_CAP_EXT_CPUID
1095 Architectures: x86
1096 Type: system ioctl
1097 Parameters: struct kvm_cpuid2 (in/out)
1098 Returns: 0 on success, -1 on error
1099
1100 struct kvm_cpuid2 {
1101         __u32 nent;
1102         __u32 padding;
1103         struct kvm_cpuid_entry2 entries[0];
1104 };
1105
1106 #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX 1
1107 #define KVM_CPUID_FLAG_STATEFUL_FUNC    2
1108 #define KVM_CPUID_FLAG_STATE_READ_NEXT  4
1109
1110 struct kvm_cpuid_entry2 {
1111         __u32 function;
1112         __u32 index;
1113         __u32 flags;
1114         __u32 eax;
1115         __u32 ebx;
1116         __u32 ecx;
1117         __u32 edx;
1118         __u32 padding[3];
1119 };
1120
1121 This ioctl returns x86 cpuid features which are supported by both the hardware
1122 and kvm.  Userspace can use the information returned by this ioctl to
1123 construct cpuid information (for KVM_SET_CPUID2) that is consistent with
1124 hardware, kernel, and userspace capabilities, and with user requirements (for
1125 example, the user may wish to constrain cpuid to emulate older hardware,
1126 or for feature consistency across a cluster).
1127
1128 Userspace invokes KVM_GET_SUPPORTED_CPUID by passing a kvm_cpuid2 structure
1129 with the 'nent' field indicating the number of entries in the variable-size
1130 array 'entries'.  If the number of entries is too low to describe the cpu
1131 capabilities, an error (E2BIG) is returned.  If the number is too high,
1132 the 'nent' field is adjusted and an error (ENOMEM) is returned.  If the
1133 number is just right, the 'nent' field is adjusted to the number of valid
1134 entries in the 'entries' array, which is then filled.
1135
1136 The entries returned are the host cpuid as returned by the cpuid instruction,
1137 with unknown or unsupported features masked out.  Some features (for example,
1138 x2apic), may not be present in the host cpu, but are exposed by kvm if it can
1139 emulate them efficiently. The fields in each entry are defined as follows:
1140
1141   function: the eax value used to obtain the entry
1142   index: the ecx value used to obtain the entry (for entries that are
1143          affected by ecx)
1144   flags: an OR of zero or more of the following:
1145         KVM_CPUID_FLAG_SIGNIFCANT_INDEX:
1146            if the index field is valid
1147         KVM_CPUID_FLAG_STATEFUL_FUNC:
1148            if cpuid for this function returns different values for successive
1149            invocations; there will be several entries with the same function,
1150            all with this flag set
1151         KVM_CPUID_FLAG_STATE_READ_NEXT:
1152            for KVM_CPUID_FLAG_STATEFUL_FUNC entries, set if this entry is
1153            the first entry to be read by a cpu
1154    eax, ebx, ecx, edx: the values returned by the cpuid instruction for
1155          this function/index combination
1156
1157 The TSC deadline timer feature (CPUID leaf 1, ecx[24]) is always returned
1158 as false, since the feature depends on KVM_CREATE_IRQCHIP for local APIC
1159 support.  Instead it is reported via
1160
1161   ioctl(KVM_CHECK_EXTENSION, KVM_CAP_TSC_DEADLINE_TIMER)
1162
1163 if that returns true and you use KVM_CREATE_IRQCHIP, or if you emulate the
1164 feature in userspace, then you can enable the feature for KVM_SET_CPUID2.
1165
1166
1167 4.47 KVM_PPC_GET_PVINFO
1168
1169 Capability: KVM_CAP_PPC_GET_PVINFO
1170 Architectures: ppc
1171 Type: vm ioctl
1172 Parameters: struct kvm_ppc_pvinfo (out)
1173 Returns: 0 on success, !0 on error
1174
1175 struct kvm_ppc_pvinfo {
1176         __u32 flags;
1177         __u32 hcall[4];
1178         __u8  pad[108];
1179 };
1180
1181 This ioctl fetches PV specific information that need to be passed to the guest
1182 using the device tree or other means from vm context.
1183
1184 The hcall array defines 4 instructions that make up a hypercall.
1185
1186 If any additional field gets added to this structure later on, a bit for that
1187 additional piece of information will be set in the flags bitmap.
1188
1189 The flags bitmap is defined as:
1190
1191    /* the host supports the ePAPR idle hcall
1192    #define KVM_PPC_PVINFO_FLAGS_EV_IDLE   (1<<0)
1193
1194 4.48 KVM_ASSIGN_PCI_DEVICE
1195
1196 Capability: KVM_CAP_DEVICE_ASSIGNMENT
1197 Architectures: x86 ia64
1198 Type: vm ioctl
1199 Parameters: struct kvm_assigned_pci_dev (in)
1200 Returns: 0 on success, -1 on error
1201
1202 Assigns a host PCI device to the VM.
1203
1204 struct kvm_assigned_pci_dev {
1205         __u32 assigned_dev_id;
1206         __u32 busnr;
1207         __u32 devfn;
1208         __u32 flags;
1209         __u32 segnr;
1210         union {
1211                 __u32 reserved[11];
1212         };
1213 };
1214
1215 The PCI device is specified by the triple segnr, busnr, and devfn.
1216 Identification in succeeding service requests is done via assigned_dev_id. The
1217 following flags are specified:
1218
1219 /* Depends on KVM_CAP_IOMMU */
1220 #define KVM_DEV_ASSIGN_ENABLE_IOMMU     (1 << 0)
1221 /* The following two depend on KVM_CAP_PCI_2_3 */
1222 #define KVM_DEV_ASSIGN_PCI_2_3          (1 << 1)
1223 #define KVM_DEV_ASSIGN_MASK_INTX        (1 << 2)
1224
1225 If KVM_DEV_ASSIGN_PCI_2_3 is set, the kernel will manage legacy INTx interrupts
1226 via the PCI-2.3-compliant device-level mask, thus enable IRQ sharing with other
1227 assigned devices or host devices. KVM_DEV_ASSIGN_MASK_INTX specifies the
1228 guest's view on the INTx mask, see KVM_ASSIGN_SET_INTX_MASK for details.
1229
1230 The KVM_DEV_ASSIGN_ENABLE_IOMMU flag is a mandatory option to ensure
1231 isolation of the device.  Usages not specifying this flag are deprecated.
1232
1233 Only PCI header type 0 devices with PCI BAR resources are supported by
1234 device assignment.  The user requesting this ioctl must have read/write
1235 access to the PCI sysfs resource files associated with the device.
1236
1237
1238 4.49 KVM_DEASSIGN_PCI_DEVICE
1239
1240 Capability: KVM_CAP_DEVICE_DEASSIGNMENT
1241 Architectures: x86 ia64
1242 Type: vm ioctl
1243 Parameters: struct kvm_assigned_pci_dev (in)
1244 Returns: 0 on success, -1 on error
1245
1246 Ends PCI device assignment, releasing all associated resources.
1247
1248 See KVM_CAP_DEVICE_ASSIGNMENT for the data structure. Only assigned_dev_id is
1249 used in kvm_assigned_pci_dev to identify the device.
1250
1251
1252 4.50 KVM_ASSIGN_DEV_IRQ
1253
1254 Capability: KVM_CAP_ASSIGN_DEV_IRQ
1255 Architectures: x86 ia64
1256 Type: vm ioctl
1257 Parameters: struct kvm_assigned_irq (in)
1258 Returns: 0 on success, -1 on error
1259
1260 Assigns an IRQ to a passed-through device.
1261
1262 struct kvm_assigned_irq {
1263         __u32 assigned_dev_id;
1264         __u32 host_irq; /* ignored (legacy field) */
1265         __u32 guest_irq;
1266         __u32 flags;
1267         union {
1268                 __u32 reserved[12];
1269         };
1270 };
1271
1272 The following flags are defined:
1273
1274 #define KVM_DEV_IRQ_HOST_INTX    (1 << 0)
1275 #define KVM_DEV_IRQ_HOST_MSI     (1 << 1)
1276 #define KVM_DEV_IRQ_HOST_MSIX    (1 << 2)
1277
1278 #define KVM_DEV_IRQ_GUEST_INTX   (1 << 8)
1279 #define KVM_DEV_IRQ_GUEST_MSI    (1 << 9)
1280 #define KVM_DEV_IRQ_GUEST_MSIX   (1 << 10)
1281
1282 It is not valid to specify multiple types per host or guest IRQ. However, the
1283 IRQ type of host and guest can differ or can even be null.
1284
1285
1286 4.51 KVM_DEASSIGN_DEV_IRQ
1287
1288 Capability: KVM_CAP_ASSIGN_DEV_IRQ
1289 Architectures: x86 ia64
1290 Type: vm ioctl
1291 Parameters: struct kvm_assigned_irq (in)
1292 Returns: 0 on success, -1 on error
1293
1294 Ends an IRQ assignment to a passed-through device.
1295
1296 See KVM_ASSIGN_DEV_IRQ for the data structure. The target device is specified
1297 by assigned_dev_id, flags must correspond to the IRQ type specified on
1298 KVM_ASSIGN_DEV_IRQ. Partial deassignment of host or guest IRQ is allowed.
1299
1300
1301 4.52 KVM_SET_GSI_ROUTING
1302
1303 Capability: KVM_CAP_IRQ_ROUTING
1304 Architectures: x86 ia64
1305 Type: vm ioctl
1306 Parameters: struct kvm_irq_routing (in)
1307 Returns: 0 on success, -1 on error
1308
1309 Sets the GSI routing table entries, overwriting any previously set entries.
1310
1311 struct kvm_irq_routing {
1312         __u32 nr;
1313         __u32 flags;
1314         struct kvm_irq_routing_entry entries[0];
1315 };
1316
1317 No flags are specified so far, the corresponding field must be set to zero.
1318
1319 struct kvm_irq_routing_entry {
1320         __u32 gsi;
1321         __u32 type;
1322         __u32 flags;
1323         __u32 pad;
1324         union {
1325                 struct kvm_irq_routing_irqchip irqchip;
1326                 struct kvm_irq_routing_msi msi;
1327                 __u32 pad[8];
1328         } u;
1329 };
1330
1331 /* gsi routing entry types */
1332 #define KVM_IRQ_ROUTING_IRQCHIP 1
1333 #define KVM_IRQ_ROUTING_MSI 2
1334
1335 No flags are specified so far, the corresponding field must be set to zero.
1336
1337 struct kvm_irq_routing_irqchip {
1338         __u32 irqchip;
1339         __u32 pin;
1340 };
1341
1342 struct kvm_irq_routing_msi {
1343         __u32 address_lo;
1344         __u32 address_hi;
1345         __u32 data;
1346         __u32 pad;
1347 };
1348
1349
1350 4.53 KVM_ASSIGN_SET_MSIX_NR
1351
1352 Capability: KVM_CAP_DEVICE_MSIX
1353 Architectures: x86 ia64
1354 Type: vm ioctl
1355 Parameters: struct kvm_assigned_msix_nr (in)
1356 Returns: 0 on success, -1 on error
1357
1358 Set the number of MSI-X interrupts for an assigned device. The number is
1359 reset again by terminating the MSI-X assignment of the device via
1360 KVM_DEASSIGN_DEV_IRQ. Calling this service more than once at any earlier
1361 point will fail.
1362
1363 struct kvm_assigned_msix_nr {
1364         __u32 assigned_dev_id;
1365         __u16 entry_nr;
1366         __u16 padding;
1367 };
1368
1369 #define KVM_MAX_MSIX_PER_DEV            256
1370
1371
1372 4.54 KVM_ASSIGN_SET_MSIX_ENTRY
1373
1374 Capability: KVM_CAP_DEVICE_MSIX
1375 Architectures: x86 ia64
1376 Type: vm ioctl
1377 Parameters: struct kvm_assigned_msix_entry (in)
1378 Returns: 0 on success, -1 on error
1379
1380 Specifies the routing of an MSI-X assigned device interrupt to a GSI. Setting
1381 the GSI vector to zero means disabling the interrupt.
1382
1383 struct kvm_assigned_msix_entry {
1384         __u32 assigned_dev_id;
1385         __u32 gsi;
1386         __u16 entry; /* The index of entry in the MSI-X table */
1387         __u16 padding[3];
1388 };
1389
1390
1391 4.55 KVM_SET_TSC_KHZ
1392
1393 Capability: KVM_CAP_TSC_CONTROL
1394 Architectures: x86
1395 Type: vcpu ioctl
1396 Parameters: virtual tsc_khz
1397 Returns: 0 on success, -1 on error
1398
1399 Specifies the tsc frequency for the virtual machine. The unit of the
1400 frequency is KHz.
1401
1402
1403 4.56 KVM_GET_TSC_KHZ
1404
1405 Capability: KVM_CAP_GET_TSC_KHZ
1406 Architectures: x86
1407 Type: vcpu ioctl
1408 Parameters: none
1409 Returns: virtual tsc-khz on success, negative value on error
1410
1411 Returns the tsc frequency of the guest. The unit of the return value is
1412 KHz. If the host has unstable tsc this ioctl returns -EIO instead as an
1413 error.
1414
1415
1416 4.57 KVM_GET_LAPIC
1417
1418 Capability: KVM_CAP_IRQCHIP
1419 Architectures: x86
1420 Type: vcpu ioctl
1421 Parameters: struct kvm_lapic_state (out)
1422 Returns: 0 on success, -1 on error
1423
1424 #define KVM_APIC_REG_SIZE 0x400
1425 struct kvm_lapic_state {
1426         char regs[KVM_APIC_REG_SIZE];
1427 };
1428
1429 Reads the Local APIC registers and copies them into the input argument.  The
1430 data format and layout are the same as documented in the architecture manual.
1431
1432
1433 4.58 KVM_SET_LAPIC
1434
1435 Capability: KVM_CAP_IRQCHIP
1436 Architectures: x86
1437 Type: vcpu ioctl
1438 Parameters: struct kvm_lapic_state (in)
1439 Returns: 0 on success, -1 on error
1440
1441 #define KVM_APIC_REG_SIZE 0x400
1442 struct kvm_lapic_state {
1443         char regs[KVM_APIC_REG_SIZE];
1444 };
1445
1446 Copies the input argument into the the Local APIC registers.  The data format
1447 and layout are the same as documented in the architecture manual.
1448
1449
1450 4.59 KVM_IOEVENTFD
1451
1452 Capability: KVM_CAP_IOEVENTFD
1453 Architectures: all
1454 Type: vm ioctl
1455 Parameters: struct kvm_ioeventfd (in)
1456 Returns: 0 on success, !0 on error
1457
1458 This ioctl attaches or detaches an ioeventfd to a legal pio/mmio address
1459 within the guest.  A guest write in the registered address will signal the
1460 provided event instead of triggering an exit.
1461
1462 struct kvm_ioeventfd {
1463         __u64 datamatch;
1464         __u64 addr;        /* legal pio/mmio address */
1465         __u32 len;         /* 1, 2, 4, or 8 bytes    */
1466         __s32 fd;
1467         __u32 flags;
1468         __u8  pad[36];
1469 };
1470
1471 The following flags are defined:
1472
1473 #define KVM_IOEVENTFD_FLAG_DATAMATCH (1 << kvm_ioeventfd_flag_nr_datamatch)
1474 #define KVM_IOEVENTFD_FLAG_PIO       (1 << kvm_ioeventfd_flag_nr_pio)
1475 #define KVM_IOEVENTFD_FLAG_DEASSIGN  (1 << kvm_ioeventfd_flag_nr_deassign)
1476
1477 If datamatch flag is set, the event will be signaled only if the written value
1478 to the registered address is equal to datamatch in struct kvm_ioeventfd.
1479
1480
1481 4.60 KVM_DIRTY_TLB
1482
1483 Capability: KVM_CAP_SW_TLB
1484 Architectures: ppc
1485 Type: vcpu ioctl
1486 Parameters: struct kvm_dirty_tlb (in)
1487 Returns: 0 on success, -1 on error
1488
1489 struct kvm_dirty_tlb {
1490         __u64 bitmap;
1491         __u32 num_dirty;
1492 };
1493
1494 This must be called whenever userspace has changed an entry in the shared
1495 TLB, prior to calling KVM_RUN on the associated vcpu.
1496
1497 The "bitmap" field is the userspace address of an array.  This array
1498 consists of a number of bits, equal to the total number of TLB entries as
1499 determined by the last successful call to KVM_CONFIG_TLB, rounded up to the
1500 nearest multiple of 64.
1501
1502 Each bit corresponds to one TLB entry, ordered the same as in the shared TLB
1503 array.
1504
1505 The array is little-endian: the bit 0 is the least significant bit of the
1506 first byte, bit 8 is the least significant bit of the second byte, etc.
1507 This avoids any complications with differing word sizes.
1508
1509 The "num_dirty" field is a performance hint for KVM to determine whether it
1510 should skip processing the bitmap and just invalidate everything.  It must
1511 be set to the number of set bits in the bitmap.
1512
1513
1514 4.61 KVM_ASSIGN_SET_INTX_MASK
1515
1516 Capability: KVM_CAP_PCI_2_3
1517 Architectures: x86
1518 Type: vm ioctl
1519 Parameters: struct kvm_assigned_pci_dev (in)
1520 Returns: 0 on success, -1 on error
1521
1522 Allows userspace to mask PCI INTx interrupts from the assigned device.  The
1523 kernel will not deliver INTx interrupts to the guest between setting and
1524 clearing of KVM_ASSIGN_SET_INTX_MASK via this interface.  This enables use of
1525 and emulation of PCI 2.3 INTx disable command register behavior.
1526
1527 This may be used for both PCI 2.3 devices supporting INTx disable natively and
1528 older devices lacking this support. Userspace is responsible for emulating the
1529 read value of the INTx disable bit in the guest visible PCI command register.
1530 When modifying the INTx disable state, userspace should precede updating the
1531 physical device command register by calling this ioctl to inform the kernel of
1532 the new intended INTx mask state.
1533
1534 Note that the kernel uses the device INTx disable bit to internally manage the
1535 device interrupt state for PCI 2.3 devices.  Reads of this register may
1536 therefore not match the expected value.  Writes should always use the guest
1537 intended INTx disable value rather than attempting to read-copy-update the
1538 current physical device state.  Races between user and kernel updates to the
1539 INTx disable bit are handled lazily in the kernel.  It's possible the device
1540 may generate unintended interrupts, but they will not be injected into the
1541 guest.
1542
1543 See KVM_ASSIGN_DEV_IRQ for the data structure.  The target device is specified
1544 by assigned_dev_id.  In the flags field, only KVM_DEV_ASSIGN_MASK_INTX is
1545 evaluated.
1546
1547
1548 4.62 KVM_CREATE_SPAPR_TCE
1549
1550 Capability: KVM_CAP_SPAPR_TCE
1551 Architectures: powerpc
1552 Type: vm ioctl
1553 Parameters: struct kvm_create_spapr_tce (in)
1554 Returns: file descriptor for manipulating the created TCE table
1555
1556 This creates a virtual TCE (translation control entry) table, which
1557 is an IOMMU for PAPR-style virtual I/O.  It is used to translate
1558 logical addresses used in virtual I/O into guest physical addresses,
1559 and provides a scatter/gather capability for PAPR virtual I/O.
1560
1561 /* for KVM_CAP_SPAPR_TCE */
1562 struct kvm_create_spapr_tce {
1563         __u64 liobn;
1564         __u32 window_size;
1565 };
1566
1567 The liobn field gives the logical IO bus number for which to create a
1568 TCE table.  The window_size field specifies the size of the DMA window
1569 which this TCE table will translate - the table will contain one 64
1570 bit TCE entry for every 4kiB of the DMA window.
1571
1572 When the guest issues an H_PUT_TCE hcall on a liobn for which a TCE
1573 table has been created using this ioctl(), the kernel will handle it
1574 in real mode, updating the TCE table.  H_PUT_TCE calls for other
1575 liobns will cause a vm exit and must be handled by userspace.
1576
1577 The return value is a file descriptor which can be passed to mmap(2)
1578 to map the created TCE table into userspace.  This lets userspace read
1579 the entries written by kernel-handled H_PUT_TCE calls, and also lets
1580 userspace update the TCE table directly which is useful in some
1581 circumstances.
1582
1583
1584 4.63 KVM_ALLOCATE_RMA
1585
1586 Capability: KVM_CAP_PPC_RMA
1587 Architectures: powerpc
1588 Type: vm ioctl
1589 Parameters: struct kvm_allocate_rma (out)
1590 Returns: file descriptor for mapping the allocated RMA
1591
1592 This allocates a Real Mode Area (RMA) from the pool allocated at boot
1593 time by the kernel.  An RMA is a physically-contiguous, aligned region
1594 of memory used on older POWER processors to provide the memory which
1595 will be accessed by real-mode (MMU off) accesses in a KVM guest.
1596 POWER processors support a set of sizes for the RMA that usually
1597 includes 64MB, 128MB, 256MB and some larger powers of two.
1598
1599 /* for KVM_ALLOCATE_RMA */
1600 struct kvm_allocate_rma {
1601         __u64 rma_size;
1602 };
1603
1604 The return value is a file descriptor which can be passed to mmap(2)
1605 to map the allocated RMA into userspace.  The mapped area can then be
1606 passed to the KVM_SET_USER_MEMORY_REGION ioctl to establish it as the
1607 RMA for a virtual machine.  The size of the RMA in bytes (which is
1608 fixed at host kernel boot time) is returned in the rma_size field of
1609 the argument structure.
1610
1611 The KVM_CAP_PPC_RMA capability is 1 or 2 if the KVM_ALLOCATE_RMA ioctl
1612 is supported; 2 if the processor requires all virtual machines to have
1613 an RMA, or 1 if the processor can use an RMA but doesn't require it,
1614 because it supports the Virtual RMA (VRMA) facility.
1615
1616
1617 4.64 KVM_NMI
1618
1619 Capability: KVM_CAP_USER_NMI
1620 Architectures: x86
1621 Type: vcpu ioctl
1622 Parameters: none
1623 Returns: 0 on success, -1 on error
1624
1625 Queues an NMI on the thread's vcpu.  Note this is well defined only
1626 when KVM_CREATE_IRQCHIP has not been called, since this is an interface
1627 between the virtual cpu core and virtual local APIC.  After KVM_CREATE_IRQCHIP
1628 has been called, this interface is completely emulated within the kernel.
1629
1630 To use this to emulate the LINT1 input with KVM_CREATE_IRQCHIP, use the
1631 following algorithm:
1632
1633   - pause the vpcu
1634   - read the local APIC's state (KVM_GET_LAPIC)
1635   - check whether changing LINT1 will queue an NMI (see the LVT entry for LINT1)
1636   - if so, issue KVM_NMI
1637   - resume the vcpu
1638
1639 Some guests configure the LINT1 NMI input to cause a panic, aiding in
1640 debugging.
1641
1642
1643 4.65 KVM_S390_UCAS_MAP
1644
1645 Capability: KVM_CAP_S390_UCONTROL
1646 Architectures: s390
1647 Type: vcpu ioctl
1648 Parameters: struct kvm_s390_ucas_mapping (in)
1649 Returns: 0 in case of success
1650
1651 The parameter is defined like this:
1652         struct kvm_s390_ucas_mapping {
1653                 __u64 user_addr;
1654                 __u64 vcpu_addr;
1655                 __u64 length;
1656         };
1657
1658 This ioctl maps the memory at "user_addr" with the length "length" to
1659 the vcpu's address space starting at "vcpu_addr". All parameters need to
1660 be alligned by 1 megabyte.
1661
1662
1663 4.66 KVM_S390_UCAS_UNMAP
1664
1665 Capability: KVM_CAP_S390_UCONTROL
1666 Architectures: s390
1667 Type: vcpu ioctl
1668 Parameters: struct kvm_s390_ucas_mapping (in)
1669 Returns: 0 in case of success
1670
1671 The parameter is defined like this:
1672         struct kvm_s390_ucas_mapping {
1673                 __u64 user_addr;
1674                 __u64 vcpu_addr;
1675                 __u64 length;
1676         };
1677
1678 This ioctl unmaps the memory in the vcpu's address space starting at
1679 "vcpu_addr" with the length "length". The field "user_addr" is ignored.
1680 All parameters need to be alligned by 1 megabyte.
1681
1682
1683 4.67 KVM_S390_VCPU_FAULT
1684
1685 Capability: KVM_CAP_S390_UCONTROL
1686 Architectures: s390
1687 Type: vcpu ioctl
1688 Parameters: vcpu absolute address (in)
1689 Returns: 0 in case of success
1690
1691 This call creates a page table entry on the virtual cpu's address space
1692 (for user controlled virtual machines) or the virtual machine's address
1693 space (for regular virtual machines). This only works for minor faults,
1694 thus it's recommended to access subject memory page via the user page
1695 table upfront. This is useful to handle validity intercepts for user
1696 controlled virtual machines to fault in the virtual cpu's lowcore pages
1697 prior to calling the KVM_RUN ioctl.
1698
1699
1700 4.68 KVM_SET_ONE_REG
1701
1702 Capability: KVM_CAP_ONE_REG
1703 Architectures: all
1704 Type: vcpu ioctl
1705 Parameters: struct kvm_one_reg (in)
1706 Returns: 0 on success, negative value on failure
1707
1708 struct kvm_one_reg {
1709        __u64 id;
1710        __u64 addr;
1711 };
1712
1713 Using this ioctl, a single vcpu register can be set to a specific value
1714 defined by user space with the passed in struct kvm_one_reg, where id
1715 refers to the register identifier as described below and addr is a pointer
1716 to a variable with the respective size. There can be architecture agnostic
1717 and architecture specific registers. Each have their own range of operation
1718 and their own constants and width. To keep track of the implemented
1719 registers, find a list below:
1720
1721   Arch  |       Register        | Width (bits)
1722         |                       |
1723   PPC   | KVM_REG_PPC_HIOR      | 64
1724   PPC   | KVM_REG_PPC_IAC1      | 64
1725   PPC   | KVM_REG_PPC_IAC2      | 64
1726   PPC   | KVM_REG_PPC_IAC3      | 64
1727   PPC   | KVM_REG_PPC_IAC4      | 64
1728   PPC   | KVM_REG_PPC_DAC1      | 64
1729   PPC   | KVM_REG_PPC_DAC2      | 64
1730   PPC   | KVM_REG_PPC_DABR      | 64
1731   PPC   | KVM_REG_PPC_DSCR      | 64
1732   PPC   | KVM_REG_PPC_PURR      | 64
1733   PPC   | KVM_REG_PPC_SPURR     | 64
1734   PPC   | KVM_REG_PPC_DAR       | 64
1735   PPC   | KVM_REG_PPC_DSISR     | 32
1736   PPC   | KVM_REG_PPC_AMR       | 64
1737   PPC   | KVM_REG_PPC_UAMOR     | 64
1738   PPC   | KVM_REG_PPC_MMCR0     | 64
1739   PPC   | KVM_REG_PPC_MMCR1     | 64
1740   PPC   | KVM_REG_PPC_MMCRA     | 64
1741   PPC   | KVM_REG_PPC_PMC1      | 32
1742   PPC   | KVM_REG_PPC_PMC2      | 32
1743   PPC   | KVM_REG_PPC_PMC3      | 32
1744   PPC   | KVM_REG_PPC_PMC4      | 32
1745   PPC   | KVM_REG_PPC_PMC5      | 32
1746   PPC   | KVM_REG_PPC_PMC6      | 32
1747   PPC   | KVM_REG_PPC_PMC7      | 32
1748   PPC   | KVM_REG_PPC_PMC8      | 32
1749   PPC   | KVM_REG_PPC_FPR0      | 64
1750           ...
1751   PPC   | KVM_REG_PPC_FPR31     | 64
1752   PPC   | KVM_REG_PPC_VR0       | 128
1753           ...
1754   PPC   | KVM_REG_PPC_VR31      | 128
1755   PPC   | KVM_REG_PPC_VSR0      | 128
1756           ...
1757   PPC   | KVM_REG_PPC_VSR31     | 128
1758   PPC   | KVM_REG_PPC_FPSCR     | 64
1759   PPC   | KVM_REG_PPC_VSCR      | 32
1760   PPC   | KVM_REG_PPC_VPA_ADDR  | 64
1761   PPC   | KVM_REG_PPC_VPA_SLB   | 128
1762   PPC   | KVM_REG_PPC_VPA_DTL   | 128
1763   PPC   | KVM_REG_PPC_EPCR      | 32
1764   PPC   | KVM_REG_PPC_EPR       | 32
1765
1766 4.69 KVM_GET_ONE_REG
1767
1768 Capability: KVM_CAP_ONE_REG
1769 Architectures: all
1770 Type: vcpu ioctl
1771 Parameters: struct kvm_one_reg (in and out)
1772 Returns: 0 on success, negative value on failure
1773
1774 This ioctl allows to receive the value of a single register implemented
1775 in a vcpu. The register to read is indicated by the "id" field of the
1776 kvm_one_reg struct passed in. On success, the register value can be found
1777 at the memory location pointed to by "addr".
1778
1779 The list of registers accessible using this interface is identical to the
1780 list in 4.68.
1781
1782
1783 4.70 KVM_KVMCLOCK_CTRL
1784
1785 Capability: KVM_CAP_KVMCLOCK_CTRL
1786 Architectures: Any that implement pvclocks (currently x86 only)
1787 Type: vcpu ioctl
1788 Parameters: None
1789 Returns: 0 on success, -1 on error
1790
1791 This signals to the host kernel that the specified guest is being paused by
1792 userspace.  The host will set a flag in the pvclock structure that is checked
1793 from the soft lockup watchdog.  The flag is part of the pvclock structure that
1794 is shared between guest and host, specifically the second bit of the flags
1795 field of the pvclock_vcpu_time_info structure.  It will be set exclusively by
1796 the host and read/cleared exclusively by the guest.  The guest operation of
1797 checking and clearing the flag must an atomic operation so
1798 load-link/store-conditional, or equivalent must be used.  There are two cases
1799 where the guest will clear the flag: when the soft lockup watchdog timer resets
1800 itself or when a soft lockup is detected.  This ioctl can be called any time
1801 after pausing the vcpu, but before it is resumed.
1802
1803
1804 4.71 KVM_SIGNAL_MSI
1805
1806 Capability: KVM_CAP_SIGNAL_MSI
1807 Architectures: x86
1808 Type: vm ioctl
1809 Parameters: struct kvm_msi (in)
1810 Returns: >0 on delivery, 0 if guest blocked the MSI, and -1 on error
1811
1812 Directly inject a MSI message. Only valid with in-kernel irqchip that handles
1813 MSI messages.
1814
1815 struct kvm_msi {
1816         __u32 address_lo;
1817         __u32 address_hi;
1818         __u32 data;
1819         __u32 flags;
1820         __u8  pad[16];
1821 };
1822
1823 No flags are defined so far. The corresponding field must be 0.
1824
1825
1826 4.71 KVM_CREATE_PIT2
1827
1828 Capability: KVM_CAP_PIT2
1829 Architectures: x86
1830 Type: vm ioctl
1831 Parameters: struct kvm_pit_config (in)
1832 Returns: 0 on success, -1 on error
1833
1834 Creates an in-kernel device model for the i8254 PIT. This call is only valid
1835 after enabling in-kernel irqchip support via KVM_CREATE_IRQCHIP. The following
1836 parameters have to be passed:
1837
1838 struct kvm_pit_config {
1839         __u32 flags;
1840         __u32 pad[15];
1841 };
1842
1843 Valid flags are:
1844
1845 #define KVM_PIT_SPEAKER_DUMMY     1 /* emulate speaker port stub */
1846
1847 PIT timer interrupts may use a per-VM kernel thread for injection. If it
1848 exists, this thread will have a name of the following pattern:
1849
1850 kvm-pit/<owner-process-pid>
1851
1852 When running a guest with elevated priorities, the scheduling parameters of
1853 this thread may have to be adjusted accordingly.
1854
1855 This IOCTL replaces the obsolete KVM_CREATE_PIT.
1856
1857
1858 4.72 KVM_GET_PIT2
1859
1860 Capability: KVM_CAP_PIT_STATE2
1861 Architectures: x86
1862 Type: vm ioctl
1863 Parameters: struct kvm_pit_state2 (out)
1864 Returns: 0 on success, -1 on error
1865
1866 Retrieves the state of the in-kernel PIT model. Only valid after
1867 KVM_CREATE_PIT2. The state is returned in the following structure:
1868
1869 struct kvm_pit_state2 {
1870         struct kvm_pit_channel_state channels[3];
1871         __u32 flags;
1872         __u32 reserved[9];
1873 };
1874
1875 Valid flags are:
1876
1877 /* disable PIT in HPET legacy mode */
1878 #define KVM_PIT_FLAGS_HPET_LEGACY  0x00000001
1879
1880 This IOCTL replaces the obsolete KVM_GET_PIT.
1881
1882
1883 4.73 KVM_SET_PIT2
1884
1885 Capability: KVM_CAP_PIT_STATE2
1886 Architectures: x86
1887 Type: vm ioctl
1888 Parameters: struct kvm_pit_state2 (in)
1889 Returns: 0 on success, -1 on error
1890
1891 Sets the state of the in-kernel PIT model. Only valid after KVM_CREATE_PIT2.
1892 See KVM_GET_PIT2 for details on struct kvm_pit_state2.
1893
1894 This IOCTL replaces the obsolete KVM_SET_PIT.
1895
1896
1897 4.74 KVM_PPC_GET_SMMU_INFO
1898
1899 Capability: KVM_CAP_PPC_GET_SMMU_INFO
1900 Architectures: powerpc
1901 Type: vm ioctl
1902 Parameters: None
1903 Returns: 0 on success, -1 on error
1904
1905 This populates and returns a structure describing the features of
1906 the "Server" class MMU emulation supported by KVM.
1907 This can in turn be used by userspace to generate the appropariate
1908 device-tree properties for the guest operating system.
1909
1910 The structure contains some global informations, followed by an
1911 array of supported segment page sizes:
1912
1913       struct kvm_ppc_smmu_info {
1914              __u64 flags;
1915              __u32 slb_size;
1916              __u32 pad;
1917              struct kvm_ppc_one_seg_page_size sps[KVM_PPC_PAGE_SIZES_MAX_SZ];
1918       };
1919
1920 The supported flags are:
1921
1922     - KVM_PPC_PAGE_SIZES_REAL:
1923         When that flag is set, guest page sizes must "fit" the backing
1924         store page sizes. When not set, any page size in the list can
1925         be used regardless of how they are backed by userspace.
1926
1927     - KVM_PPC_1T_SEGMENTS
1928         The emulated MMU supports 1T segments in addition to the
1929         standard 256M ones.
1930
1931 The "slb_size" field indicates how many SLB entries are supported
1932
1933 The "sps" array contains 8 entries indicating the supported base
1934 page sizes for a segment in increasing order. Each entry is defined
1935 as follow:
1936
1937    struct kvm_ppc_one_seg_page_size {
1938         __u32 page_shift;       /* Base page shift of segment (or 0) */
1939         __u32 slb_enc;          /* SLB encoding for BookS */
1940         struct kvm_ppc_one_page_size enc[KVM_PPC_PAGE_SIZES_MAX_SZ];
1941    };
1942
1943 An entry with a "page_shift" of 0 is unused. Because the array is
1944 organized in increasing order, a lookup can stop when encoutering
1945 such an entry.
1946
1947 The "slb_enc" field provides the encoding to use in the SLB for the
1948 page size. The bits are in positions such as the value can directly
1949 be OR'ed into the "vsid" argument of the slbmte instruction.
1950
1951 The "enc" array is a list which for each of those segment base page
1952 size provides the list of supported actual page sizes (which can be
1953 only larger or equal to the base page size), along with the
1954 corresponding encoding in the hash PTE. Similarily, the array is
1955 8 entries sorted by increasing sizes and an entry with a "0" shift
1956 is an empty entry and a terminator:
1957
1958    struct kvm_ppc_one_page_size {
1959         __u32 page_shift;       /* Page shift (or 0) */
1960         __u32 pte_enc;          /* Encoding in the HPTE (>>12) */
1961    };
1962
1963 The "pte_enc" field provides a value that can OR'ed into the hash
1964 PTE's RPN field (ie, it needs to be shifted left by 12 to OR it
1965 into the hash PTE second double word).
1966
1967 4.75 KVM_IRQFD
1968
1969 Capability: KVM_CAP_IRQFD
1970 Architectures: x86
1971 Type: vm ioctl
1972 Parameters: struct kvm_irqfd (in)
1973 Returns: 0 on success, -1 on error
1974
1975 Allows setting an eventfd to directly trigger a guest interrupt.
1976 kvm_irqfd.fd specifies the file descriptor to use as the eventfd and
1977 kvm_irqfd.gsi specifies the irqchip pin toggled by this event.  When
1978 an event is tiggered on the eventfd, an interrupt is injected into
1979 the guest using the specified gsi pin.  The irqfd is removed using
1980 the KVM_IRQFD_FLAG_DEASSIGN flag, specifying both kvm_irqfd.fd
1981 and kvm_irqfd.gsi.
1982
1983 With KVM_CAP_IRQFD_RESAMPLE, KVM_IRQFD supports a de-assert and notify
1984 mechanism allowing emulation of level-triggered, irqfd-based
1985 interrupts.  When KVM_IRQFD_FLAG_RESAMPLE is set the user must pass an
1986 additional eventfd in the kvm_irqfd.resamplefd field.  When operating
1987 in resample mode, posting of an interrupt through kvm_irq.fd asserts
1988 the specified gsi in the irqchip.  When the irqchip is resampled, such
1989 as from an EOI, the gsi is de-asserted and the user is notifed via
1990 kvm_irqfd.resamplefd.  It is the user's responsibility to re-queue
1991 the interrupt if the device making use of it still requires service.
1992 Note that closing the resamplefd is not sufficient to disable the
1993 irqfd.  The KVM_IRQFD_FLAG_RESAMPLE is only necessary on assignment
1994 and need not be specified with KVM_IRQFD_FLAG_DEASSIGN.
1995
1996 4.76 KVM_PPC_ALLOCATE_HTAB
1997
1998 Capability: KVM_CAP_PPC_ALLOC_HTAB
1999 Architectures: powerpc
2000 Type: vm ioctl
2001 Parameters: Pointer to u32 containing hash table order (in/out)
2002 Returns: 0 on success, -1 on error
2003
2004 This requests the host kernel to allocate an MMU hash table for a
2005 guest using the PAPR paravirtualization interface.  This only does
2006 anything if the kernel is configured to use the Book 3S HV style of
2007 virtualization.  Otherwise the capability doesn't exist and the ioctl
2008 returns an ENOTTY error.  The rest of this description assumes Book 3S
2009 HV.
2010
2011 There must be no vcpus running when this ioctl is called; if there
2012 are, it will do nothing and return an EBUSY error.
2013
2014 The parameter is a pointer to a 32-bit unsigned integer variable
2015 containing the order (log base 2) of the desired size of the hash
2016 table, which must be between 18 and 46.  On successful return from the
2017 ioctl, it will have been updated with the order of the hash table that
2018 was allocated.
2019
2020 If no hash table has been allocated when any vcpu is asked to run
2021 (with the KVM_RUN ioctl), the host kernel will allocate a
2022 default-sized hash table (16 MB).
2023
2024 If this ioctl is called when a hash table has already been allocated,
2025 the kernel will clear out the existing hash table (zero all HPTEs) and
2026 return the hash table order in the parameter.  (If the guest is using
2027 the virtualized real-mode area (VRMA) facility, the kernel will
2028 re-create the VMRA HPTEs on the next KVM_RUN of any vcpu.)
2029
2030 4.77 KVM_S390_INTERRUPT
2031
2032 Capability: basic
2033 Architectures: s390
2034 Type: vm ioctl, vcpu ioctl
2035 Parameters: struct kvm_s390_interrupt (in)
2036 Returns: 0 on success, -1 on error
2037
2038 Allows to inject an interrupt to the guest. Interrupts can be floating
2039 (vm ioctl) or per cpu (vcpu ioctl), depending on the interrupt type.
2040
2041 Interrupt parameters are passed via kvm_s390_interrupt:
2042
2043 struct kvm_s390_interrupt {
2044         __u32 type;
2045         __u32 parm;
2046         __u64 parm64;
2047 };
2048
2049 type can be one of the following:
2050
2051 KVM_S390_SIGP_STOP (vcpu) - sigp restart
2052 KVM_S390_PROGRAM_INT (vcpu) - program check; code in parm
2053 KVM_S390_SIGP_SET_PREFIX (vcpu) - sigp set prefix; prefix address in parm
2054 KVM_S390_RESTART (vcpu) - restart
2055 KVM_S390_INT_VIRTIO (vm) - virtio external interrupt; external interrupt
2056                            parameters in parm and parm64
2057 KVM_S390_INT_SERVICE (vm) - sclp external interrupt; sclp parameter in parm
2058 KVM_S390_INT_EMERGENCY (vcpu) - sigp emergency; source cpu in parm
2059 KVM_S390_INT_EXTERNAL_CALL (vcpu) - sigp external call; source cpu in parm
2060 KVM_S390_INT_IO(ai,cssid,ssid,schid) (vm) - compound value to indicate an
2061     I/O interrupt (ai - adapter interrupt; cssid,ssid,schid - subchannel);
2062     I/O interruption parameters in parm (subchannel) and parm64 (intparm,
2063     interruption subclass)
2064 KVM_S390_MCHK (vm, vcpu) - machine check interrupt; cr 14 bits in parm,
2065                            machine check interrupt code in parm64 (note that
2066                            machine checks needing further payload are not
2067                            supported by this ioctl)
2068
2069 Note that the vcpu ioctl is asynchronous to vcpu execution.
2070
2071 4.78 KVM_PPC_GET_HTAB_FD
2072
2073 Capability: KVM_CAP_PPC_HTAB_FD
2074 Architectures: powerpc
2075 Type: vm ioctl
2076 Parameters: Pointer to struct kvm_get_htab_fd (in)
2077 Returns: file descriptor number (>= 0) on success, -1 on error
2078
2079 This returns a file descriptor that can be used either to read out the
2080 entries in the guest's hashed page table (HPT), or to write entries to
2081 initialize the HPT.  The returned fd can only be written to if the
2082 KVM_GET_HTAB_WRITE bit is set in the flags field of the argument, and
2083 can only be read if that bit is clear.  The argument struct looks like
2084 this:
2085
2086 /* For KVM_PPC_GET_HTAB_FD */
2087 struct kvm_get_htab_fd {
2088         __u64   flags;
2089         __u64   start_index;
2090         __u64   reserved[2];
2091 };
2092
2093 /* Values for kvm_get_htab_fd.flags */
2094 #define KVM_GET_HTAB_BOLTED_ONLY        ((__u64)0x1)
2095 #define KVM_GET_HTAB_WRITE              ((__u64)0x2)
2096
2097 The `start_index' field gives the index in the HPT of the entry at
2098 which to start reading.  It is ignored when writing.
2099
2100 Reads on the fd will initially supply information about all
2101 "interesting" HPT entries.  Interesting entries are those with the
2102 bolted bit set, if the KVM_GET_HTAB_BOLTED_ONLY bit is set, otherwise
2103 all entries.  When the end of the HPT is reached, the read() will
2104 return.  If read() is called again on the fd, it will start again from
2105 the beginning of the HPT, but will only return HPT entries that have
2106 changed since they were last read.
2107
2108 Data read or written is structured as a header (8 bytes) followed by a
2109 series of valid HPT entries (16 bytes) each.  The header indicates how
2110 many valid HPT entries there are and how many invalid entries follow
2111 the valid entries.  The invalid entries are not represented explicitly
2112 in the stream.  The header format is:
2113
2114 struct kvm_get_htab_header {
2115         __u32   index;
2116         __u16   n_valid;
2117         __u16   n_invalid;
2118 };
2119
2120 Writes to the fd create HPT entries starting at the index given in the
2121 header; first `n_valid' valid entries with contents from the data
2122 written, then `n_invalid' invalid entries, invalidating any previously
2123 valid entries found.
2124
2125
2126 5. The kvm_run structure
2127 ------------------------
2128
2129 Application code obtains a pointer to the kvm_run structure by
2130 mmap()ing a vcpu fd.  From that point, application code can control
2131 execution by changing fields in kvm_run prior to calling the KVM_RUN
2132 ioctl, and obtain information about the reason KVM_RUN returned by
2133 looking up structure members.
2134
2135 struct kvm_run {
2136         /* in */
2137         __u8 request_interrupt_window;
2138
2139 Request that KVM_RUN return when it becomes possible to inject external
2140 interrupts into the guest.  Useful in conjunction with KVM_INTERRUPT.
2141
2142         __u8 padding1[7];
2143
2144         /* out */
2145         __u32 exit_reason;
2146
2147 When KVM_RUN has returned successfully (return value 0), this informs
2148 application code why KVM_RUN has returned.  Allowable values for this
2149 field are detailed below.
2150
2151         __u8 ready_for_interrupt_injection;
2152
2153 If request_interrupt_window has been specified, this field indicates
2154 an interrupt can be injected now with KVM_INTERRUPT.
2155
2156         __u8 if_flag;
2157
2158 The value of the current interrupt flag.  Only valid if in-kernel
2159 local APIC is not used.
2160
2161         __u8 padding2[2];
2162
2163         /* in (pre_kvm_run), out (post_kvm_run) */
2164         __u64 cr8;
2165
2166 The value of the cr8 register.  Only valid if in-kernel local APIC is
2167 not used.  Both input and output.
2168
2169         __u64 apic_base;
2170
2171 The value of the APIC BASE msr.  Only valid if in-kernel local
2172 APIC is not used.  Both input and output.
2173
2174         union {
2175                 /* KVM_EXIT_UNKNOWN */
2176                 struct {
2177                         __u64 hardware_exit_reason;
2178                 } hw;
2179
2180 If exit_reason is KVM_EXIT_UNKNOWN, the vcpu has exited due to unknown
2181 reasons.  Further architecture-specific information is available in
2182 hardware_exit_reason.
2183
2184                 /* KVM_EXIT_FAIL_ENTRY */
2185                 struct {
2186                         __u64 hardware_entry_failure_reason;
2187                 } fail_entry;
2188
2189 If exit_reason is KVM_EXIT_FAIL_ENTRY, the vcpu could not be run due
2190 to unknown reasons.  Further architecture-specific information is
2191 available in hardware_entry_failure_reason.
2192
2193                 /* KVM_EXIT_EXCEPTION */
2194                 struct {
2195                         __u32 exception;
2196                         __u32 error_code;
2197                 } ex;
2198
2199 Unused.
2200
2201                 /* KVM_EXIT_IO */
2202                 struct {
2203 #define KVM_EXIT_IO_IN  0
2204 #define KVM_EXIT_IO_OUT 1
2205                         __u8 direction;
2206                         __u8 size; /* bytes */
2207                         __u16 port;
2208                         __u32 count;
2209                         __u64 data_offset; /* relative to kvm_run start */
2210                 } io;
2211
2212 If exit_reason is KVM_EXIT_IO, then the vcpu has
2213 executed a port I/O instruction which could not be satisfied by kvm.
2214 data_offset describes where the data is located (KVM_EXIT_IO_OUT) or
2215 where kvm expects application code to place the data for the next
2216 KVM_RUN invocation (KVM_EXIT_IO_IN).  Data format is a packed array.
2217
2218                 struct {
2219                         struct kvm_debug_exit_arch arch;
2220                 } debug;
2221
2222 Unused.
2223
2224                 /* KVM_EXIT_MMIO */
2225                 struct {
2226                         __u64 phys_addr;
2227                         __u8  data[8];
2228                         __u32 len;
2229                         __u8  is_write;
2230                 } mmio;
2231
2232 If exit_reason is KVM_EXIT_MMIO, then the vcpu has
2233 executed a memory-mapped I/O instruction which could not be satisfied
2234 by kvm.  The 'data' member contains the written data if 'is_write' is
2235 true, and should be filled by application code otherwise.
2236
2237 NOTE: For KVM_EXIT_IO, KVM_EXIT_MMIO, KVM_EXIT_OSI, KVM_EXIT_DCR,
2238       KVM_EXIT_PAPR and KVM_EXIT_EPR the corresponding
2239 operations are complete (and guest state is consistent) only after userspace
2240 has re-entered the kernel with KVM_RUN.  The kernel side will first finish
2241 incomplete operations and then check for pending signals.  Userspace
2242 can re-enter the guest with an unmasked signal pending to complete
2243 pending operations.
2244
2245                 /* KVM_EXIT_HYPERCALL */
2246                 struct {
2247                         __u64 nr;
2248                         __u64 args[6];
2249                         __u64 ret;
2250                         __u32 longmode;
2251                         __u32 pad;
2252                 } hypercall;
2253
2254 Unused.  This was once used for 'hypercall to userspace'.  To implement
2255 such functionality, use KVM_EXIT_IO (x86) or KVM_EXIT_MMIO (all except s390).
2256 Note KVM_EXIT_IO is significantly faster than KVM_EXIT_MMIO.
2257
2258                 /* KVM_EXIT_TPR_ACCESS */
2259                 struct {
2260                         __u64 rip;
2261                         __u32 is_write;
2262                         __u32 pad;
2263                 } tpr_access;
2264
2265 To be documented (KVM_TPR_ACCESS_REPORTING).
2266
2267                 /* KVM_EXIT_S390_SIEIC */
2268                 struct {
2269                         __u8 icptcode;
2270                         __u64 mask; /* psw upper half */
2271                         __u64 addr; /* psw lower half */
2272                         __u16 ipa;
2273                         __u32 ipb;
2274                 } s390_sieic;
2275
2276 s390 specific.
2277
2278                 /* KVM_EXIT_S390_RESET */
2279 #define KVM_S390_RESET_POR       1
2280 #define KVM_S390_RESET_CLEAR     2
2281 #define KVM_S390_RESET_SUBSYSTEM 4
2282 #define KVM_S390_RESET_CPU_INIT  8
2283 #define KVM_S390_RESET_IPL       16
2284                 __u64 s390_reset_flags;
2285
2286 s390 specific.
2287
2288                 /* KVM_EXIT_S390_UCONTROL */
2289                 struct {
2290                         __u64 trans_exc_code;
2291                         __u32 pgm_code;
2292                 } s390_ucontrol;
2293
2294 s390 specific. A page fault has occurred for a user controlled virtual
2295 machine (KVM_VM_S390_UNCONTROL) on it's host page table that cannot be
2296 resolved by the kernel.
2297 The program code and the translation exception code that were placed
2298 in the cpu's lowcore are presented here as defined by the z Architecture
2299 Principles of Operation Book in the Chapter for Dynamic Address Translation
2300 (DAT)
2301
2302                 /* KVM_EXIT_DCR */
2303                 struct {
2304                         __u32 dcrn;
2305                         __u32 data;
2306                         __u8  is_write;
2307                 } dcr;
2308
2309 powerpc specific.
2310
2311                 /* KVM_EXIT_OSI */
2312                 struct {
2313                         __u64 gprs[32];
2314                 } osi;
2315
2316 MOL uses a special hypercall interface it calls 'OSI'. To enable it, we catch
2317 hypercalls and exit with this exit struct that contains all the guest gprs.
2318
2319 If exit_reason is KVM_EXIT_OSI, then the vcpu has triggered such a hypercall.
2320 Userspace can now handle the hypercall and when it's done modify the gprs as
2321 necessary. Upon guest entry all guest GPRs will then be replaced by the values
2322 in this struct.
2323
2324                 /* KVM_EXIT_PAPR_HCALL */
2325                 struct {
2326                         __u64 nr;
2327                         __u64 ret;
2328                         __u64 args[9];
2329                 } papr_hcall;
2330
2331 This is used on 64-bit PowerPC when emulating a pSeries partition,
2332 e.g. with the 'pseries' machine type in qemu.  It occurs when the
2333 guest does a hypercall using the 'sc 1' instruction.  The 'nr' field
2334 contains the hypercall number (from the guest R3), and 'args' contains
2335 the arguments (from the guest R4 - R12).  Userspace should put the
2336 return code in 'ret' and any extra returned values in args[].
2337 The possible hypercalls are defined in the Power Architecture Platform
2338 Requirements (PAPR) document available from www.power.org (free
2339 developer registration required to access it).
2340
2341                 /* KVM_EXIT_S390_TSCH */
2342                 struct {
2343                         __u16 subchannel_id;
2344                         __u16 subchannel_nr;
2345                         __u32 io_int_parm;
2346                         __u32 io_int_word;
2347                         __u32 ipb;
2348                         __u8 dequeued;
2349                 } s390_tsch;
2350
2351 s390 specific. This exit occurs when KVM_CAP_S390_CSS_SUPPORT has been enabled
2352 and TEST SUBCHANNEL was intercepted. If dequeued is set, a pending I/O
2353 interrupt for the target subchannel has been dequeued and subchannel_id,
2354 subchannel_nr, io_int_parm and io_int_word contain the parameters for that
2355 interrupt. ipb is needed for instruction parameter decoding.
2356
2357                 /* KVM_EXIT_EPR */
2358                 struct {
2359                         __u32 epr;
2360                 } epr;
2361
2362 On FSL BookE PowerPC chips, the interrupt controller has a fast patch
2363 interrupt acknowledge path to the core. When the core successfully
2364 delivers an interrupt, it automatically populates the EPR register with
2365 the interrupt vector number and acknowledges the interrupt inside
2366 the interrupt controller.
2367
2368 In case the interrupt controller lives in user space, we need to do
2369 the interrupt acknowledge cycle through it to fetch the next to be
2370 delivered interrupt vector using this exit.
2371
2372 It gets triggered whenever both KVM_CAP_PPC_EPR are enabled and an
2373 external interrupt has just been delivered into the guest. User space
2374 should put the acknowledged interrupt vector into the 'epr' field.
2375
2376                 /* Fix the size of the union. */
2377                 char padding[256];
2378         };
2379
2380         /*
2381          * shared registers between kvm and userspace.
2382          * kvm_valid_regs specifies the register classes set by the host
2383          * kvm_dirty_regs specified the register classes dirtied by userspace
2384          * struct kvm_sync_regs is architecture specific, as well as the
2385          * bits for kvm_valid_regs and kvm_dirty_regs
2386          */
2387         __u64 kvm_valid_regs;
2388         __u64 kvm_dirty_regs;
2389         union {
2390                 struct kvm_sync_regs regs;
2391                 char padding[1024];
2392         } s;
2393
2394 If KVM_CAP_SYNC_REGS is defined, these fields allow userspace to access
2395 certain guest registers without having to call SET/GET_*REGS. Thus we can
2396 avoid some system call overhead if userspace has to handle the exit.
2397 Userspace can query the validity of the structure by checking
2398 kvm_valid_regs for specific bits. These bits are architecture specific
2399 and usually define the validity of a groups of registers. (e.g. one bit
2400  for general purpose registers)
2401
2402 };
2403
2404
2405 6. Capabilities that can be enabled
2406 -----------------------------------
2407
2408 There are certain capabilities that change the behavior of the virtual CPU when
2409 enabled. To enable them, please see section 4.37. Below you can find a list of
2410 capabilities and what their effect on the vCPU is when enabling them.
2411
2412 The following information is provided along with the description:
2413
2414   Architectures: which instruction set architectures provide this ioctl.
2415       x86 includes both i386 and x86_64.
2416
2417   Parameters: what parameters are accepted by the capability.
2418
2419   Returns: the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
2420       are not detailed, but errors with specific meanings are.
2421
2422
2423 6.1 KVM_CAP_PPC_OSI
2424
2425 Architectures: ppc
2426 Parameters: none
2427 Returns: 0 on success; -1 on error
2428
2429 This capability enables interception of OSI hypercalls that otherwise would
2430 be treated as normal system calls to be injected into the guest. OSI hypercalls
2431 were invented by Mac-on-Linux to have a standardized communication mechanism
2432 between the guest and the host.
2433
2434 When this capability is enabled, KVM_EXIT_OSI can occur.
2435
2436
2437 6.2 KVM_CAP_PPC_PAPR
2438
2439 Architectures: ppc
2440 Parameters: none
2441 Returns: 0 on success; -1 on error
2442
2443 This capability enables interception of PAPR hypercalls. PAPR hypercalls are
2444 done using the hypercall instruction "sc 1".
2445
2446 It also sets the guest privilege level to "supervisor" mode. Usually the guest
2447 runs in "hypervisor" privilege mode with a few missing features.
2448
2449 In addition to the above, it changes the semantics of SDR1. In this mode, the
2450 HTAB address part of SDR1 contains an HVA instead of a GPA, as PAPR keeps the
2451 HTAB invisible to the guest.
2452
2453 When this capability is enabled, KVM_EXIT_PAPR_HCALL can occur.
2454
2455
2456 6.3 KVM_CAP_SW_TLB
2457
2458 Architectures: ppc
2459 Parameters: args[0] is the address of a struct kvm_config_tlb
2460 Returns: 0 on success; -1 on error
2461
2462 struct kvm_config_tlb {
2463         __u64 params;
2464         __u64 array;
2465         __u32 mmu_type;
2466         __u32 array_len;
2467 };
2468
2469 Configures the virtual CPU's TLB array, establishing a shared memory area
2470 between userspace and KVM.  The "params" and "array" fields are userspace
2471 addresses of mmu-type-specific data structures.  The "array_len" field is an
2472 safety mechanism, and should be set to the size in bytes of the memory that
2473 userspace has reserved for the array.  It must be at least the size dictated
2474 by "mmu_type" and "params".
2475
2476 While KVM_RUN is active, the shared region is under control of KVM.  Its
2477 contents are undefined, and any modification by userspace results in
2478 boundedly undefined behavior.
2479
2480 On return from KVM_RUN, the shared region will reflect the current state of
2481 the guest's TLB.  If userspace makes any changes, it must call KVM_DIRTY_TLB
2482 to tell KVM which entries have been changed, prior to calling KVM_RUN again
2483 on this vcpu.
2484
2485 For mmu types KVM_MMU_FSL_BOOKE_NOHV and KVM_MMU_FSL_BOOKE_HV:
2486  - The "params" field is of type "struct kvm_book3e_206_tlb_params".
2487  - The "array" field points to an array of type "struct
2488    kvm_book3e_206_tlb_entry".
2489  - The array consists of all entries in the first TLB, followed by all
2490    entries in the second TLB.
2491  - Within a TLB, entries are ordered first by increasing set number.  Within a
2492    set, entries are ordered by way (increasing ESEL).
2493  - The hash for determining set number in TLB0 is: (MAS2 >> 12) & (num_sets - 1)
2494    where "num_sets" is the tlb_sizes[] value divided by the tlb_ways[] value.
2495  - The tsize field of mas1 shall be set to 4K on TLB0, even though the
2496    hardware ignores this value for TLB0.
2497
2498 6.4 KVM_CAP_S390_CSS_SUPPORT
2499
2500 Architectures: s390
2501 Parameters: none
2502 Returns: 0 on success; -1 on error
2503
2504 This capability enables support for handling of channel I/O instructions.
2505
2506 TEST PENDING INTERRUPTION and the interrupt portion of TEST SUBCHANNEL are
2507 handled in-kernel, while the other I/O instructions are passed to userspace.
2508
2509 When this capability is enabled, KVM_EXIT_S390_TSCH will occur on TEST
2510 SUBCHANNEL intercepts.
2511
2512 6.5 KVM_CAP_PPC_EPR
2513
2514 Architectures: ppc
2515 Parameters: args[0] defines whether the proxy facility is active
2516 Returns: 0 on success; -1 on error
2517
2518 This capability enables or disables the delivery of interrupts through the
2519 external proxy facility.
2520
2521 When enabled (args[0] != 0), every time the guest gets an external interrupt
2522 delivered, it automatically exits into user space with a KVM_EXIT_EPR exit
2523 to receive the topmost interrupt vector.
2524
2525 When disabled (args[0] == 0), behavior is as if this facility is unsupported.
2526
2527 When this capability is enabled, KVM_EXIT_EPR can occur.