KVM: s390: ucontrol: export SIE control block to user
[linux-2.6.git] / Documentation / virtual / kvm / api.txt
1 The Definitive KVM (Kernel-based Virtual Machine) API Documentation
2 ===================================================================
3
4 1. General description
5
6 The kvm API is a set of ioctls that are issued to control various aspects
7 of a virtual machine.  The ioctls belong to three classes
8
9  - System ioctls: These query and set global attributes which affect the
10    whole kvm subsystem.  In addition a system ioctl is used to create
11    virtual machines
12
13  - VM ioctls: These query and set attributes that affect an entire virtual
14    machine, for example memory layout.  In addition a VM ioctl is used to
15    create virtual cpus (vcpus).
16
17    Only run VM ioctls from the same process (address space) that was used
18    to create the VM.
19
20  - vcpu ioctls: These query and set attributes that control the operation
21    of a single virtual cpu.
22
23    Only run vcpu ioctls from the same thread that was used to create the
24    vcpu.
25
26 2. File descriptors
27
28 The kvm API is centered around file descriptors.  An initial
29 open("/dev/kvm") obtains a handle to the kvm subsystem; this handle
30 can be used to issue system ioctls.  A KVM_CREATE_VM ioctl on this
31 handle will create a VM file descriptor which can be used to issue VM
32 ioctls.  A KVM_CREATE_VCPU ioctl on a VM fd will create a virtual cpu
33 and return a file descriptor pointing to it.  Finally, ioctls on a vcpu
34 fd can be used to control the vcpu, including the important task of
35 actually running guest code.
36
37 In general file descriptors can be migrated among processes by means
38 of fork() and the SCM_RIGHTS facility of unix domain socket.  These
39 kinds of tricks are explicitly not supported by kvm.  While they will
40 not cause harm to the host, their actual behavior is not guaranteed by
41 the API.  The only supported use is one virtual machine per process,
42 and one vcpu per thread.
43
44 3. Extensions
45
46 As of Linux 2.6.22, the KVM ABI has been stabilized: no backward
47 incompatible change are allowed.  However, there is an extension
48 facility that allows backward-compatible extensions to the API to be
49 queried and used.
50
51 The extension mechanism is not based on on the Linux version number.
52 Instead, kvm defines extension identifiers and a facility to query
53 whether a particular extension identifier is available.  If it is, a
54 set of ioctls is available for application use.
55
56 4. API description
57
58 This section describes ioctls that can be used to control kvm guests.
59 For each ioctl, the following information is provided along with a
60 description:
61
62   Capability: which KVM extension provides this ioctl.  Can be 'basic',
63       which means that is will be provided by any kernel that supports
64       API version 12 (see section 4.1), or a KVM_CAP_xyz constant, which
65       means availability needs to be checked with KVM_CHECK_EXTENSION
66       (see section 4.4).
67
68   Architectures: which instruction set architectures provide this ioctl.
69       x86 includes both i386 and x86_64.
70
71   Type: system, vm, or vcpu.
72
73   Parameters: what parameters are accepted by the ioctl.
74
75   Returns: the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
76       are not detailed, but errors with specific meanings are.
77
78 4.1 KVM_GET_API_VERSION
79
80 Capability: basic
81 Architectures: all
82 Type: system ioctl
83 Parameters: none
84 Returns: the constant KVM_API_VERSION (=12)
85
86 This identifies the API version as the stable kvm API. It is not
87 expected that this number will change.  However, Linux 2.6.20 and
88 2.6.21 report earlier versions; these are not documented and not
89 supported.  Applications should refuse to run if KVM_GET_API_VERSION
90 returns a value other than 12.  If this check passes, all ioctls
91 described as 'basic' will be available.
92
93 4.2 KVM_CREATE_VM
94
95 Capability: basic
96 Architectures: all
97 Type: system ioctl
98 Parameters: machine type identifier (KVM_VM_*)
99 Returns: a VM fd that can be used to control the new virtual machine.
100
101 The new VM has no virtual cpus and no memory.  An mmap() of a VM fd
102 will access the virtual machine's physical address space; offset zero
103 corresponds to guest physical address zero.  Use of mmap() on a VM fd
104 is discouraged if userspace memory allocation (KVM_CAP_USER_MEMORY) is
105 available.
106 You most certainly want to use 0 as machine type.
107
108 In order to create user controlled virtual machines on S390, check
109 KVM_CAP_S390_UCONTROL and use the flag KVM_VM_S390_UCONTROL as
110 privileged user (CAP_SYS_ADMIN).
111
112 4.3 KVM_GET_MSR_INDEX_LIST
113
114 Capability: basic
115 Architectures: x86
116 Type: system
117 Parameters: struct kvm_msr_list (in/out)
118 Returns: 0 on success; -1 on error
119 Errors:
120   E2BIG:     the msr index list is to be to fit in the array specified by
121              the user.
122
123 struct kvm_msr_list {
124         __u32 nmsrs; /* number of msrs in entries */
125         __u32 indices[0];
126 };
127
128 This ioctl returns the guest msrs that are supported.  The list varies
129 by kvm version and host processor, but does not change otherwise.  The
130 user fills in the size of the indices array in nmsrs, and in return
131 kvm adjusts nmsrs to reflect the actual number of msrs and fills in
132 the indices array with their numbers.
133
134 Note: if kvm indicates supports MCE (KVM_CAP_MCE), then the MCE bank MSRs are
135 not returned in the MSR list, as different vcpus can have a different number
136 of banks, as set via the KVM_X86_SETUP_MCE ioctl.
137
138 4.4 KVM_CHECK_EXTENSION
139
140 Capability: basic
141 Architectures: all
142 Type: system ioctl
143 Parameters: extension identifier (KVM_CAP_*)
144 Returns: 0 if unsupported; 1 (or some other positive integer) if supported
145
146 The API allows the application to query about extensions to the core
147 kvm API.  Userspace passes an extension identifier (an integer) and
148 receives an integer that describes the extension availability.
149 Generally 0 means no and 1 means yes, but some extensions may report
150 additional information in the integer return value.
151
152 4.5 KVM_GET_VCPU_MMAP_SIZE
153
154 Capability: basic
155 Architectures: all
156 Type: system ioctl
157 Parameters: none
158 Returns: size of vcpu mmap area, in bytes
159
160 The KVM_RUN ioctl (cf.) communicates with userspace via a shared
161 memory region.  This ioctl returns the size of that region.  See the
162 KVM_RUN documentation for details.
163
164 4.6 KVM_SET_MEMORY_REGION
165
166 Capability: basic
167 Architectures: all
168 Type: vm ioctl
169 Parameters: struct kvm_memory_region (in)
170 Returns: 0 on success, -1 on error
171
172 This ioctl is obsolete and has been removed.
173
174 4.7 KVM_CREATE_VCPU
175
176 Capability: basic
177 Architectures: all
178 Type: vm ioctl
179 Parameters: vcpu id (apic id on x86)
180 Returns: vcpu fd on success, -1 on error
181
182 This API adds a vcpu to a virtual machine.  The vcpu id is a small integer
183 in the range [0, max_vcpus).
184
185 The recommended max_vcpus value can be retrieved using the KVM_CAP_NR_VCPUS of
186 the KVM_CHECK_EXTENSION ioctl() at run-time.
187 The maximum possible value for max_vcpus can be retrieved using the
188 KVM_CAP_MAX_VCPUS of the KVM_CHECK_EXTENSION ioctl() at run-time.
189
190 If the KVM_CAP_NR_VCPUS does not exist, you should assume that max_vcpus is 4
191 cpus max.
192 If the KVM_CAP_MAX_VCPUS does not exist, you should assume that max_vcpus is
193 same as the value returned from KVM_CAP_NR_VCPUS.
194
195 On powerpc using book3s_hv mode, the vcpus are mapped onto virtual
196 threads in one or more virtual CPU cores.  (This is because the
197 hardware requires all the hardware threads in a CPU core to be in the
198 same partition.)  The KVM_CAP_PPC_SMT capability indicates the number
199 of vcpus per virtual core (vcore).  The vcore id is obtained by
200 dividing the vcpu id by the number of vcpus per vcore.  The vcpus in a
201 given vcore will always be in the same physical core as each other
202 (though that might be a different physical core from time to time).
203 Userspace can control the threading (SMT) mode of the guest by its
204 allocation of vcpu ids.  For example, if userspace wants
205 single-threaded guest vcpus, it should make all vcpu ids be a multiple
206 of the number of vcpus per vcore.
207
208 On powerpc using book3s_hv mode, the vcpus are mapped onto virtual
209 threads in one or more virtual CPU cores.  (This is because the
210 hardware requires all the hardware threads in a CPU core to be in the
211 same partition.)  The KVM_CAP_PPC_SMT capability indicates the number
212 of vcpus per virtual core (vcore).  The vcore id is obtained by
213 dividing the vcpu id by the number of vcpus per vcore.  The vcpus in a
214 given vcore will always be in the same physical core as each other
215 (though that might be a different physical core from time to time).
216 Userspace can control the threading (SMT) mode of the guest by its
217 allocation of vcpu ids.  For example, if userspace wants
218 single-threaded guest vcpus, it should make all vcpu ids be a multiple
219 of the number of vcpus per vcore.
220
221 For virtual cpus that have been created with S390 user controlled virtual
222 machines, the resulting vcpu fd can be memory mapped at page offset
223 KVM_S390_SIE_PAGE_OFFSET in order to obtain a memory map of the virtual
224 cpu's hardware control block.
225
226 4.8 KVM_GET_DIRTY_LOG (vm ioctl)
227
228 Capability: basic
229 Architectures: x86
230 Type: vm ioctl
231 Parameters: struct kvm_dirty_log (in/out)
232 Returns: 0 on success, -1 on error
233
234 /* for KVM_GET_DIRTY_LOG */
235 struct kvm_dirty_log {
236         __u32 slot;
237         __u32 padding;
238         union {
239                 void __user *dirty_bitmap; /* one bit per page */
240                 __u64 padding;
241         };
242 };
243
244 Given a memory slot, return a bitmap containing any pages dirtied
245 since the last call to this ioctl.  Bit 0 is the first page in the
246 memory slot.  Ensure the entire structure is cleared to avoid padding
247 issues.
248
249 4.9 KVM_SET_MEMORY_ALIAS
250
251 Capability: basic
252 Architectures: x86
253 Type: vm ioctl
254 Parameters: struct kvm_memory_alias (in)
255 Returns: 0 (success), -1 (error)
256
257 This ioctl is obsolete and has been removed.
258
259 4.10 KVM_RUN
260
261 Capability: basic
262 Architectures: all
263 Type: vcpu ioctl
264 Parameters: none
265 Returns: 0 on success, -1 on error
266 Errors:
267   EINTR:     an unmasked signal is pending
268
269 This ioctl is used to run a guest virtual cpu.  While there are no
270 explicit parameters, there is an implicit parameter block that can be
271 obtained by mmap()ing the vcpu fd at offset 0, with the size given by
272 KVM_GET_VCPU_MMAP_SIZE.  The parameter block is formatted as a 'struct
273 kvm_run' (see below).
274
275 4.11 KVM_GET_REGS
276
277 Capability: basic
278 Architectures: all
279 Type: vcpu ioctl
280 Parameters: struct kvm_regs (out)
281 Returns: 0 on success, -1 on error
282
283 Reads the general purpose registers from the vcpu.
284
285 /* x86 */
286 struct kvm_regs {
287         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
288         __u64 rax, rbx, rcx, rdx;
289         __u64 rsi, rdi, rsp, rbp;
290         __u64 r8,  r9,  r10, r11;
291         __u64 r12, r13, r14, r15;
292         __u64 rip, rflags;
293 };
294
295 4.12 KVM_SET_REGS
296
297 Capability: basic
298 Architectures: all
299 Type: vcpu ioctl
300 Parameters: struct kvm_regs (in)
301 Returns: 0 on success, -1 on error
302
303 Writes the general purpose registers into the vcpu.
304
305 See KVM_GET_REGS for the data structure.
306
307 4.13 KVM_GET_SREGS
308
309 Capability: basic
310 Architectures: x86, ppc
311 Type: vcpu ioctl
312 Parameters: struct kvm_sregs (out)
313 Returns: 0 on success, -1 on error
314
315 Reads special registers from the vcpu.
316
317 /* x86 */
318 struct kvm_sregs {
319         struct kvm_segment cs, ds, es, fs, gs, ss;
320         struct kvm_segment tr, ldt;
321         struct kvm_dtable gdt, idt;
322         __u64 cr0, cr2, cr3, cr4, cr8;
323         __u64 efer;
324         __u64 apic_base;
325         __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
326 };
327
328 /* ppc -- see arch/powerpc/include/asm/kvm.h */
329
330 interrupt_bitmap is a bitmap of pending external interrupts.  At most
331 one bit may be set.  This interrupt has been acknowledged by the APIC
332 but not yet injected into the cpu core.
333
334 4.14 KVM_SET_SREGS
335
336 Capability: basic
337 Architectures: x86, ppc
338 Type: vcpu ioctl
339 Parameters: struct kvm_sregs (in)
340 Returns: 0 on success, -1 on error
341
342 Writes special registers into the vcpu.  See KVM_GET_SREGS for the
343 data structures.
344
345 4.15 KVM_TRANSLATE
346
347 Capability: basic
348 Architectures: x86
349 Type: vcpu ioctl
350 Parameters: struct kvm_translation (in/out)
351 Returns: 0 on success, -1 on error
352
353 Translates a virtual address according to the vcpu's current address
354 translation mode.
355
356 struct kvm_translation {
357         /* in */
358         __u64 linear_address;
359
360         /* out */
361         __u64 physical_address;
362         __u8  valid;
363         __u8  writeable;
364         __u8  usermode;
365         __u8  pad[5];
366 };
367
368 4.16 KVM_INTERRUPT
369
370 Capability: basic
371 Architectures: x86, ppc
372 Type: vcpu ioctl
373 Parameters: struct kvm_interrupt (in)
374 Returns: 0 on success, -1 on error
375
376 Queues a hardware interrupt vector to be injected.  This is only
377 useful if in-kernel local APIC or equivalent is not used.
378
379 /* for KVM_INTERRUPT */
380 struct kvm_interrupt {
381         /* in */
382         __u32 irq;
383 };
384
385 X86:
386
387 Note 'irq' is an interrupt vector, not an interrupt pin or line.
388
389 PPC:
390
391 Queues an external interrupt to be injected. This ioctl is overleaded
392 with 3 different irq values:
393
394 a) KVM_INTERRUPT_SET
395
396   This injects an edge type external interrupt into the guest once it's ready
397   to receive interrupts. When injected, the interrupt is done.
398
399 b) KVM_INTERRUPT_UNSET
400
401   This unsets any pending interrupt.
402
403   Only available with KVM_CAP_PPC_UNSET_IRQ.
404
405 c) KVM_INTERRUPT_SET_LEVEL
406
407   This injects a level type external interrupt into the guest context. The
408   interrupt stays pending until a specific ioctl with KVM_INTERRUPT_UNSET
409   is triggered.
410
411   Only available with KVM_CAP_PPC_IRQ_LEVEL.
412
413 Note that any value for 'irq' other than the ones stated above is invalid
414 and incurs unexpected behavior.
415
416 4.17 KVM_DEBUG_GUEST
417
418 Capability: basic
419 Architectures: none
420 Type: vcpu ioctl
421 Parameters: none)
422 Returns: -1 on error
423
424 Support for this has been removed.  Use KVM_SET_GUEST_DEBUG instead.
425
426 4.18 KVM_GET_MSRS
427
428 Capability: basic
429 Architectures: x86
430 Type: vcpu ioctl
431 Parameters: struct kvm_msrs (in/out)
432 Returns: 0 on success, -1 on error
433
434 Reads model-specific registers from the vcpu.  Supported msr indices can
435 be obtained using KVM_GET_MSR_INDEX_LIST.
436
437 struct kvm_msrs {
438         __u32 nmsrs; /* number of msrs in entries */
439         __u32 pad;
440
441         struct kvm_msr_entry entries[0];
442 };
443
444 struct kvm_msr_entry {
445         __u32 index;
446         __u32 reserved;
447         __u64 data;
448 };
449
450 Application code should set the 'nmsrs' member (which indicates the
451 size of the entries array) and the 'index' member of each array entry.
452 kvm will fill in the 'data' member.
453
454 4.19 KVM_SET_MSRS
455
456 Capability: basic
457 Architectures: x86
458 Type: vcpu ioctl
459 Parameters: struct kvm_msrs (in)
460 Returns: 0 on success, -1 on error
461
462 Writes model-specific registers to the vcpu.  See KVM_GET_MSRS for the
463 data structures.
464
465 Application code should set the 'nmsrs' member (which indicates the
466 size of the entries array), and the 'index' and 'data' members of each
467 array entry.
468
469 4.20 KVM_SET_CPUID
470
471 Capability: basic
472 Architectures: x86
473 Type: vcpu ioctl
474 Parameters: struct kvm_cpuid (in)
475 Returns: 0 on success, -1 on error
476
477 Defines the vcpu responses to the cpuid instruction.  Applications
478 should use the KVM_SET_CPUID2 ioctl if available.
479
480
481 struct kvm_cpuid_entry {
482         __u32 function;
483         __u32 eax;
484         __u32 ebx;
485         __u32 ecx;
486         __u32 edx;
487         __u32 padding;
488 };
489
490 /* for KVM_SET_CPUID */
491 struct kvm_cpuid {
492         __u32 nent;
493         __u32 padding;
494         struct kvm_cpuid_entry entries[0];
495 };
496
497 4.21 KVM_SET_SIGNAL_MASK
498
499 Capability: basic
500 Architectures: x86
501 Type: vcpu ioctl
502 Parameters: struct kvm_signal_mask (in)
503 Returns: 0 on success, -1 on error
504
505 Defines which signals are blocked during execution of KVM_RUN.  This
506 signal mask temporarily overrides the threads signal mask.  Any
507 unblocked signal received (except SIGKILL and SIGSTOP, which retain
508 their traditional behaviour) will cause KVM_RUN to return with -EINTR.
509
510 Note the signal will only be delivered if not blocked by the original
511 signal mask.
512
513 /* for KVM_SET_SIGNAL_MASK */
514 struct kvm_signal_mask {
515         __u32 len;
516         __u8  sigset[0];
517 };
518
519 4.22 KVM_GET_FPU
520
521 Capability: basic
522 Architectures: x86
523 Type: vcpu ioctl
524 Parameters: struct kvm_fpu (out)
525 Returns: 0 on success, -1 on error
526
527 Reads the floating point state from the vcpu.
528
529 /* for KVM_GET_FPU and KVM_SET_FPU */
530 struct kvm_fpu {
531         __u8  fpr[8][16];
532         __u16 fcw;
533         __u16 fsw;
534         __u8  ftwx;  /* in fxsave format */
535         __u8  pad1;
536         __u16 last_opcode;
537         __u64 last_ip;
538         __u64 last_dp;
539         __u8  xmm[16][16];
540         __u32 mxcsr;
541         __u32 pad2;
542 };
543
544 4.23 KVM_SET_FPU
545
546 Capability: basic
547 Architectures: x86
548 Type: vcpu ioctl
549 Parameters: struct kvm_fpu (in)
550 Returns: 0 on success, -1 on error
551
552 Writes the floating point state to the vcpu.
553
554 /* for KVM_GET_FPU and KVM_SET_FPU */
555 struct kvm_fpu {
556         __u8  fpr[8][16];
557         __u16 fcw;
558         __u16 fsw;
559         __u8  ftwx;  /* in fxsave format */
560         __u8  pad1;
561         __u16 last_opcode;
562         __u64 last_ip;
563         __u64 last_dp;
564         __u8  xmm[16][16];
565         __u32 mxcsr;
566         __u32 pad2;
567 };
568
569 4.24 KVM_CREATE_IRQCHIP
570
571 Capability: KVM_CAP_IRQCHIP
572 Architectures: x86, ia64
573 Type: vm ioctl
574 Parameters: none
575 Returns: 0 on success, -1 on error
576
577 Creates an interrupt controller model in the kernel.  On x86, creates a virtual
578 ioapic, a virtual PIC (two PICs, nested), and sets up future vcpus to have a
579 local APIC.  IRQ routing for GSIs 0-15 is set to both PIC and IOAPIC; GSI 16-23
580 only go to the IOAPIC.  On ia64, a IOSAPIC is created.
581
582 4.25 KVM_IRQ_LINE
583
584 Capability: KVM_CAP_IRQCHIP
585 Architectures: x86, ia64
586 Type: vm ioctl
587 Parameters: struct kvm_irq_level
588 Returns: 0 on success, -1 on error
589
590 Sets the level of a GSI input to the interrupt controller model in the kernel.
591 Requires that an interrupt controller model has been previously created with
592 KVM_CREATE_IRQCHIP.  Note that edge-triggered interrupts require the level
593 to be set to 1 and then back to 0.
594
595 struct kvm_irq_level {
596         union {
597                 __u32 irq;     /* GSI */
598                 __s32 status;  /* not used for KVM_IRQ_LEVEL */
599         };
600         __u32 level;           /* 0 or 1 */
601 };
602
603 4.26 KVM_GET_IRQCHIP
604
605 Capability: KVM_CAP_IRQCHIP
606 Architectures: x86, ia64
607 Type: vm ioctl
608 Parameters: struct kvm_irqchip (in/out)
609 Returns: 0 on success, -1 on error
610
611 Reads the state of a kernel interrupt controller created with
612 KVM_CREATE_IRQCHIP into a buffer provided by the caller.
613
614 struct kvm_irqchip {
615         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
616         __u32 pad;
617         union {
618                 char dummy[512];  /* reserving space */
619                 struct kvm_pic_state pic;
620                 struct kvm_ioapic_state ioapic;
621         } chip;
622 };
623
624 4.27 KVM_SET_IRQCHIP
625
626 Capability: KVM_CAP_IRQCHIP
627 Architectures: x86, ia64
628 Type: vm ioctl
629 Parameters: struct kvm_irqchip (in)
630 Returns: 0 on success, -1 on error
631
632 Sets the state of a kernel interrupt controller created with
633 KVM_CREATE_IRQCHIP from a buffer provided by the caller.
634
635 struct kvm_irqchip {
636         __u32 chip_id;  /* 0 = PIC1, 1 = PIC2, 2 = IOAPIC */
637         __u32 pad;
638         union {
639                 char dummy[512];  /* reserving space */
640                 struct kvm_pic_state pic;
641                 struct kvm_ioapic_state ioapic;
642         } chip;
643 };
644
645 4.28 KVM_XEN_HVM_CONFIG
646
647 Capability: KVM_CAP_XEN_HVM
648 Architectures: x86
649 Type: vm ioctl
650 Parameters: struct kvm_xen_hvm_config (in)
651 Returns: 0 on success, -1 on error
652
653 Sets the MSR that the Xen HVM guest uses to initialize its hypercall
654 page, and provides the starting address and size of the hypercall
655 blobs in userspace.  When the guest writes the MSR, kvm copies one
656 page of a blob (32- or 64-bit, depending on the vcpu mode) to guest
657 memory.
658
659 struct kvm_xen_hvm_config {
660         __u32 flags;
661         __u32 msr;
662         __u64 blob_addr_32;
663         __u64 blob_addr_64;
664         __u8 blob_size_32;
665         __u8 blob_size_64;
666         __u8 pad2[30];
667 };
668
669 4.29 KVM_GET_CLOCK
670
671 Capability: KVM_CAP_ADJUST_CLOCK
672 Architectures: x86
673 Type: vm ioctl
674 Parameters: struct kvm_clock_data (out)
675 Returns: 0 on success, -1 on error
676
677 Gets the current timestamp of kvmclock as seen by the current guest. In
678 conjunction with KVM_SET_CLOCK, it is used to ensure monotonicity on scenarios
679 such as migration.
680
681 struct kvm_clock_data {
682         __u64 clock;  /* kvmclock current value */
683         __u32 flags;
684         __u32 pad[9];
685 };
686
687 4.30 KVM_SET_CLOCK
688
689 Capability: KVM_CAP_ADJUST_CLOCK
690 Architectures: x86
691 Type: vm ioctl
692 Parameters: struct kvm_clock_data (in)
693 Returns: 0 on success, -1 on error
694
695 Sets the current timestamp of kvmclock to the value specified in its parameter.
696 In conjunction with KVM_GET_CLOCK, it is used to ensure monotonicity on scenarios
697 such as migration.
698
699 struct kvm_clock_data {
700         __u64 clock;  /* kvmclock current value */
701         __u32 flags;
702         __u32 pad[9];
703 };
704
705 4.31 KVM_GET_VCPU_EVENTS
706
707 Capability: KVM_CAP_VCPU_EVENTS
708 Extended by: KVM_CAP_INTR_SHADOW
709 Architectures: x86
710 Type: vm ioctl
711 Parameters: struct kvm_vcpu_event (out)
712 Returns: 0 on success, -1 on error
713
714 Gets currently pending exceptions, interrupts, and NMIs as well as related
715 states of the vcpu.
716
717 struct kvm_vcpu_events {
718         struct {
719                 __u8 injected;
720                 __u8 nr;
721                 __u8 has_error_code;
722                 __u8 pad;
723                 __u32 error_code;
724         } exception;
725         struct {
726                 __u8 injected;
727                 __u8 nr;
728                 __u8 soft;
729                 __u8 shadow;
730         } interrupt;
731         struct {
732                 __u8 injected;
733                 __u8 pending;
734                 __u8 masked;
735                 __u8 pad;
736         } nmi;
737         __u32 sipi_vector;
738         __u32 flags;
739 };
740
741 KVM_VCPUEVENT_VALID_SHADOW may be set in the flags field to signal that
742 interrupt.shadow contains a valid state. Otherwise, this field is undefined.
743
744 4.32 KVM_SET_VCPU_EVENTS
745
746 Capability: KVM_CAP_VCPU_EVENTS
747 Extended by: KVM_CAP_INTR_SHADOW
748 Architectures: x86
749 Type: vm ioctl
750 Parameters: struct kvm_vcpu_event (in)
751 Returns: 0 on success, -1 on error
752
753 Set pending exceptions, interrupts, and NMIs as well as related states of the
754 vcpu.
755
756 See KVM_GET_VCPU_EVENTS for the data structure.
757
758 Fields that may be modified asynchronously by running VCPUs can be excluded
759 from the update. These fields are nmi.pending and sipi_vector. Keep the
760 corresponding bits in the flags field cleared to suppress overwriting the
761 current in-kernel state. The bits are:
762
763 KVM_VCPUEVENT_VALID_NMI_PENDING - transfer nmi.pending to the kernel
764 KVM_VCPUEVENT_VALID_SIPI_VECTOR - transfer sipi_vector
765
766 If KVM_CAP_INTR_SHADOW is available, KVM_VCPUEVENT_VALID_SHADOW can be set in
767 the flags field to signal that interrupt.shadow contains a valid state and
768 shall be written into the VCPU.
769
770 4.33 KVM_GET_DEBUGREGS
771
772 Capability: KVM_CAP_DEBUGREGS
773 Architectures: x86
774 Type: vm ioctl
775 Parameters: struct kvm_debugregs (out)
776 Returns: 0 on success, -1 on error
777
778 Reads debug registers from the vcpu.
779
780 struct kvm_debugregs {
781         __u64 db[4];
782         __u64 dr6;
783         __u64 dr7;
784         __u64 flags;
785         __u64 reserved[9];
786 };
787
788 4.34 KVM_SET_DEBUGREGS
789
790 Capability: KVM_CAP_DEBUGREGS
791 Architectures: x86
792 Type: vm ioctl
793 Parameters: struct kvm_debugregs (in)
794 Returns: 0 on success, -1 on error
795
796 Writes debug registers into the vcpu.
797
798 See KVM_GET_DEBUGREGS for the data structure. The flags field is unused
799 yet and must be cleared on entry.
800
801 4.35 KVM_SET_USER_MEMORY_REGION
802
803 Capability: KVM_CAP_USER_MEM
804 Architectures: all
805 Type: vm ioctl
806 Parameters: struct kvm_userspace_memory_region (in)
807 Returns: 0 on success, -1 on error
808
809 struct kvm_userspace_memory_region {
810         __u32 slot;
811         __u32 flags;
812         __u64 guest_phys_addr;
813         __u64 memory_size; /* bytes */
814         __u64 userspace_addr; /* start of the userspace allocated memory */
815 };
816
817 /* for kvm_memory_region::flags */
818 #define KVM_MEM_LOG_DIRTY_PAGES  1UL
819
820 This ioctl allows the user to create or modify a guest physical memory
821 slot.  When changing an existing slot, it may be moved in the guest
822 physical memory space, or its flags may be modified.  It may not be
823 resized.  Slots may not overlap in guest physical address space.
824
825 Memory for the region is taken starting at the address denoted by the
826 field userspace_addr, which must point at user addressable memory for
827 the entire memory slot size.  Any object may back this memory, including
828 anonymous memory, ordinary files, and hugetlbfs.
829
830 It is recommended that the lower 21 bits of guest_phys_addr and userspace_addr
831 be identical.  This allows large pages in the guest to be backed by large
832 pages in the host.
833
834 The flags field supports just one flag, KVM_MEM_LOG_DIRTY_PAGES, which
835 instructs kvm to keep track of writes to memory within the slot.  See
836 the KVM_GET_DIRTY_LOG ioctl.
837
838 When the KVM_CAP_SYNC_MMU capability, changes in the backing of the memory
839 region are automatically reflected into the guest.  For example, an mmap()
840 that affects the region will be made visible immediately.  Another example
841 is madvise(MADV_DROP).
842
843 It is recommended to use this API instead of the KVM_SET_MEMORY_REGION ioctl.
844 The KVM_SET_MEMORY_REGION does not allow fine grained control over memory
845 allocation and is deprecated.
846
847 4.36 KVM_SET_TSS_ADDR
848
849 Capability: KVM_CAP_SET_TSS_ADDR
850 Architectures: x86
851 Type: vm ioctl
852 Parameters: unsigned long tss_address (in)
853 Returns: 0 on success, -1 on error
854
855 This ioctl defines the physical address of a three-page region in the guest
856 physical address space.  The region must be within the first 4GB of the
857 guest physical address space and must not conflict with any memory slot
858 or any mmio address.  The guest may malfunction if it accesses this memory
859 region.
860
861 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
862 because of a quirk in the virtualization implementation (see the internals
863 documentation when it pops into existence).
864
865 4.37 KVM_ENABLE_CAP
866
867 Capability: KVM_CAP_ENABLE_CAP
868 Architectures: ppc
869 Type: vcpu ioctl
870 Parameters: struct kvm_enable_cap (in)
871 Returns: 0 on success; -1 on error
872
873 +Not all extensions are enabled by default. Using this ioctl the application
874 can enable an extension, making it available to the guest.
875
876 On systems that do not support this ioctl, it always fails. On systems that
877 do support it, it only works for extensions that are supported for enablement.
878
879 To check if a capability can be enabled, the KVM_CHECK_EXTENSION ioctl should
880 be used.
881
882 struct kvm_enable_cap {
883        /* in */
884        __u32 cap;
885
886 The capability that is supposed to get enabled.
887
888        __u32 flags;
889
890 A bitfield indicating future enhancements. Has to be 0 for now.
891
892        __u64 args[4];
893
894 Arguments for enabling a feature. If a feature needs initial values to
895 function properly, this is the place to put them.
896
897        __u8  pad[64];
898 };
899
900 4.38 KVM_GET_MP_STATE
901
902 Capability: KVM_CAP_MP_STATE
903 Architectures: x86, ia64
904 Type: vcpu ioctl
905 Parameters: struct kvm_mp_state (out)
906 Returns: 0 on success; -1 on error
907
908 struct kvm_mp_state {
909         __u32 mp_state;
910 };
911
912 Returns the vcpu's current "multiprocessing state" (though also valid on
913 uniprocessor guests).
914
915 Possible values are:
916
917  - KVM_MP_STATE_RUNNABLE:        the vcpu is currently running
918  - KVM_MP_STATE_UNINITIALIZED:   the vcpu is an application processor (AP)
919                                  which has not yet received an INIT signal
920  - KVM_MP_STATE_INIT_RECEIVED:   the vcpu has received an INIT signal, and is
921                                  now ready for a SIPI
922  - KVM_MP_STATE_HALTED:          the vcpu has executed a HLT instruction and
923                                  is waiting for an interrupt
924  - KVM_MP_STATE_SIPI_RECEIVED:   the vcpu has just received a SIPI (vector
925                                  accessible via KVM_GET_VCPU_EVENTS)
926
927 This ioctl is only useful after KVM_CREATE_IRQCHIP.  Without an in-kernel
928 irqchip, the multiprocessing state must be maintained by userspace.
929
930 4.39 KVM_SET_MP_STATE
931
932 Capability: KVM_CAP_MP_STATE
933 Architectures: x86, ia64
934 Type: vcpu ioctl
935 Parameters: struct kvm_mp_state (in)
936 Returns: 0 on success; -1 on error
937
938 Sets the vcpu's current "multiprocessing state"; see KVM_GET_MP_STATE for
939 arguments.
940
941 This ioctl is only useful after KVM_CREATE_IRQCHIP.  Without an in-kernel
942 irqchip, the multiprocessing state must be maintained by userspace.
943
944 4.40 KVM_SET_IDENTITY_MAP_ADDR
945
946 Capability: KVM_CAP_SET_IDENTITY_MAP_ADDR
947 Architectures: x86
948 Type: vm ioctl
949 Parameters: unsigned long identity (in)
950 Returns: 0 on success, -1 on error
951
952 This ioctl defines the physical address of a one-page region in the guest
953 physical address space.  The region must be within the first 4GB of the
954 guest physical address space and must not conflict with any memory slot
955 or any mmio address.  The guest may malfunction if it accesses this memory
956 region.
957
958 This ioctl is required on Intel-based hosts.  This is needed on Intel hardware
959 because of a quirk in the virtualization implementation (see the internals
960 documentation when it pops into existence).
961
962 4.41 KVM_SET_BOOT_CPU_ID
963
964 Capability: KVM_CAP_SET_BOOT_CPU_ID
965 Architectures: x86, ia64
966 Type: vm ioctl
967 Parameters: unsigned long vcpu_id
968 Returns: 0 on success, -1 on error
969
970 Define which vcpu is the Bootstrap Processor (BSP).  Values are the same
971 as the vcpu id in KVM_CREATE_VCPU.  If this ioctl is not called, the default
972 is vcpu 0.
973
974 4.42 KVM_GET_XSAVE
975
976 Capability: KVM_CAP_XSAVE
977 Architectures: x86
978 Type: vcpu ioctl
979 Parameters: struct kvm_xsave (out)
980 Returns: 0 on success, -1 on error
981
982 struct kvm_xsave {
983         __u32 region[1024];
984 };
985
986 This ioctl would copy current vcpu's xsave struct to the userspace.
987
988 4.43 KVM_SET_XSAVE
989
990 Capability: KVM_CAP_XSAVE
991 Architectures: x86
992 Type: vcpu ioctl
993 Parameters: struct kvm_xsave (in)
994 Returns: 0 on success, -1 on error
995
996 struct kvm_xsave {
997         __u32 region[1024];
998 };
999
1000 This ioctl would copy userspace's xsave struct to the kernel.
1001
1002 4.44 KVM_GET_XCRS
1003
1004 Capability: KVM_CAP_XCRS
1005 Architectures: x86
1006 Type: vcpu ioctl
1007 Parameters: struct kvm_xcrs (out)
1008 Returns: 0 on success, -1 on error
1009
1010 struct kvm_xcr {
1011         __u32 xcr;
1012         __u32 reserved;
1013         __u64 value;
1014 };
1015
1016 struct kvm_xcrs {
1017         __u32 nr_xcrs;
1018         __u32 flags;
1019         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1020         __u64 padding[16];
1021 };
1022
1023 This ioctl would copy current vcpu's xcrs to the userspace.
1024
1025 4.45 KVM_SET_XCRS
1026
1027 Capability: KVM_CAP_XCRS
1028 Architectures: x86
1029 Type: vcpu ioctl
1030 Parameters: struct kvm_xcrs (in)
1031 Returns: 0 on success, -1 on error
1032
1033 struct kvm_xcr {
1034         __u32 xcr;
1035         __u32 reserved;
1036         __u64 value;
1037 };
1038
1039 struct kvm_xcrs {
1040         __u32 nr_xcrs;
1041         __u32 flags;
1042         struct kvm_xcr xcrs[KVM_MAX_XCRS];
1043         __u64 padding[16];
1044 };
1045
1046 This ioctl would set vcpu's xcr to the value userspace specified.
1047
1048 4.46 KVM_GET_SUPPORTED_CPUID
1049
1050 Capability: KVM_CAP_EXT_CPUID
1051 Architectures: x86
1052 Type: system ioctl
1053 Parameters: struct kvm_cpuid2 (in/out)
1054 Returns: 0 on success, -1 on error
1055
1056 struct kvm_cpuid2 {
1057         __u32 nent;
1058         __u32 padding;
1059         struct kvm_cpuid_entry2 entries[0];
1060 };
1061
1062 #define KVM_CPUID_FLAG_SIGNIFCANT_INDEX 1
1063 #define KVM_CPUID_FLAG_STATEFUL_FUNC    2
1064 #define KVM_CPUID_FLAG_STATE_READ_NEXT  4
1065
1066 struct kvm_cpuid_entry2 {
1067         __u32 function;
1068         __u32 index;
1069         __u32 flags;
1070         __u32 eax;
1071         __u32 ebx;
1072         __u32 ecx;
1073         __u32 edx;
1074         __u32 padding[3];
1075 };
1076
1077 This ioctl returns x86 cpuid features which are supported by both the hardware
1078 and kvm.  Userspace can use the information returned by this ioctl to
1079 construct cpuid information (for KVM_SET_CPUID2) that is consistent with
1080 hardware, kernel, and userspace capabilities, and with user requirements (for
1081 example, the user may wish to constrain cpuid to emulate older hardware,
1082 or for feature consistency across a cluster).
1083
1084 Userspace invokes KVM_GET_SUPPORTED_CPUID by passing a kvm_cpuid2 structure
1085 with the 'nent' field indicating the number of entries in the variable-size
1086 array 'entries'.  If the number of entries is too low to describe the cpu
1087 capabilities, an error (E2BIG) is returned.  If the number is too high,
1088 the 'nent' field is adjusted and an error (ENOMEM) is returned.  If the
1089 number is just right, the 'nent' field is adjusted to the number of valid
1090 entries in the 'entries' array, which is then filled.
1091
1092 The entries returned are the host cpuid as returned by the cpuid instruction,
1093 with unknown or unsupported features masked out.  Some features (for example,
1094 x2apic), may not be present in the host cpu, but are exposed by kvm if it can
1095 emulate them efficiently. The fields in each entry are defined as follows:
1096
1097   function: the eax value used to obtain the entry
1098   index: the ecx value used to obtain the entry (for entries that are
1099          affected by ecx)
1100   flags: an OR of zero or more of the following:
1101         KVM_CPUID_FLAG_SIGNIFCANT_INDEX:
1102            if the index field is valid
1103         KVM_CPUID_FLAG_STATEFUL_FUNC:
1104            if cpuid for this function returns different values for successive
1105            invocations; there will be several entries with the same function,
1106            all with this flag set
1107         KVM_CPUID_FLAG_STATE_READ_NEXT:
1108            for KVM_CPUID_FLAG_STATEFUL_FUNC entries, set if this entry is
1109            the first entry to be read by a cpu
1110    eax, ebx, ecx, edx: the values returned by the cpuid instruction for
1111          this function/index combination
1112
1113 The TSC deadline timer feature (CPUID leaf 1, ecx[24]) is always returned
1114 as false, since the feature depends on KVM_CREATE_IRQCHIP for local APIC
1115 support.  Instead it is reported via
1116
1117   ioctl(KVM_CHECK_EXTENSION, KVM_CAP_TSC_DEADLINE_TIMER)
1118
1119 if that returns true and you use KVM_CREATE_IRQCHIP, or if you emulate the
1120 feature in userspace, then you can enable the feature for KVM_SET_CPUID2.
1121
1122 4.47 KVM_PPC_GET_PVINFO
1123
1124 Capability: KVM_CAP_PPC_GET_PVINFO
1125 Architectures: ppc
1126 Type: vm ioctl
1127 Parameters: struct kvm_ppc_pvinfo (out)
1128 Returns: 0 on success, !0 on error
1129
1130 struct kvm_ppc_pvinfo {
1131         __u32 flags;
1132         __u32 hcall[4];
1133         __u8  pad[108];
1134 };
1135
1136 This ioctl fetches PV specific information that need to be passed to the guest
1137 using the device tree or other means from vm context.
1138
1139 For now the only implemented piece of information distributed here is an array
1140 of 4 instructions that make up a hypercall.
1141
1142 If any additional field gets added to this structure later on, a bit for that
1143 additional piece of information will be set in the flags bitmap.
1144
1145 4.48 KVM_ASSIGN_PCI_DEVICE
1146
1147 Capability: KVM_CAP_DEVICE_ASSIGNMENT
1148 Architectures: x86 ia64
1149 Type: vm ioctl
1150 Parameters: struct kvm_assigned_pci_dev (in)
1151 Returns: 0 on success, -1 on error
1152
1153 Assigns a host PCI device to the VM.
1154
1155 struct kvm_assigned_pci_dev {
1156         __u32 assigned_dev_id;
1157         __u32 busnr;
1158         __u32 devfn;
1159         __u32 flags;
1160         __u32 segnr;
1161         union {
1162                 __u32 reserved[11];
1163         };
1164 };
1165
1166 The PCI device is specified by the triple segnr, busnr, and devfn.
1167 Identification in succeeding service requests is done via assigned_dev_id. The
1168 following flags are specified:
1169
1170 /* Depends on KVM_CAP_IOMMU */
1171 #define KVM_DEV_ASSIGN_ENABLE_IOMMU     (1 << 0)
1172
1173 The KVM_DEV_ASSIGN_ENABLE_IOMMU flag is a mandatory option to ensure
1174 isolation of the device.  Usages not specifying this flag are deprecated.
1175
1176 Only PCI header type 0 devices with PCI BAR resources are supported by
1177 device assignment.  The user requesting this ioctl must have read/write
1178 access to the PCI sysfs resource files associated with the device.
1179
1180 4.49 KVM_DEASSIGN_PCI_DEVICE
1181
1182 Capability: KVM_CAP_DEVICE_DEASSIGNMENT
1183 Architectures: x86 ia64
1184 Type: vm ioctl
1185 Parameters: struct kvm_assigned_pci_dev (in)
1186 Returns: 0 on success, -1 on error
1187
1188 Ends PCI device assignment, releasing all associated resources.
1189
1190 See KVM_CAP_DEVICE_ASSIGNMENT for the data structure. Only assigned_dev_id is
1191 used in kvm_assigned_pci_dev to identify the device.
1192
1193 4.50 KVM_ASSIGN_DEV_IRQ
1194
1195 Capability: KVM_CAP_ASSIGN_DEV_IRQ
1196 Architectures: x86 ia64
1197 Type: vm ioctl
1198 Parameters: struct kvm_assigned_irq (in)
1199 Returns: 0 on success, -1 on error
1200
1201 Assigns an IRQ to a passed-through device.
1202
1203 struct kvm_assigned_irq {
1204         __u32 assigned_dev_id;
1205         __u32 host_irq; /* ignored (legacy field) */
1206         __u32 guest_irq;
1207         __u32 flags;
1208         union {
1209                 __u32 reserved[12];
1210         };
1211 };
1212
1213 The following flags are defined:
1214
1215 #define KVM_DEV_IRQ_HOST_INTX    (1 << 0)
1216 #define KVM_DEV_IRQ_HOST_MSI     (1 << 1)
1217 #define KVM_DEV_IRQ_HOST_MSIX    (1 << 2)
1218
1219 #define KVM_DEV_IRQ_GUEST_INTX   (1 << 8)
1220 #define KVM_DEV_IRQ_GUEST_MSI    (1 << 9)
1221 #define KVM_DEV_IRQ_GUEST_MSIX   (1 << 10)
1222
1223 It is not valid to specify multiple types per host or guest IRQ. However, the
1224 IRQ type of host and guest can differ or can even be null.
1225
1226 4.51 KVM_DEASSIGN_DEV_IRQ
1227
1228 Capability: KVM_CAP_ASSIGN_DEV_IRQ
1229 Architectures: x86 ia64
1230 Type: vm ioctl
1231 Parameters: struct kvm_assigned_irq (in)
1232 Returns: 0 on success, -1 on error
1233
1234 Ends an IRQ assignment to a passed-through device.
1235
1236 See KVM_ASSIGN_DEV_IRQ for the data structure. The target device is specified
1237 by assigned_dev_id, flags must correspond to the IRQ type specified on
1238 KVM_ASSIGN_DEV_IRQ. Partial deassignment of host or guest IRQ is allowed.
1239
1240 4.52 KVM_SET_GSI_ROUTING
1241
1242 Capability: KVM_CAP_IRQ_ROUTING
1243 Architectures: x86 ia64
1244 Type: vm ioctl
1245 Parameters: struct kvm_irq_routing (in)
1246 Returns: 0 on success, -1 on error
1247
1248 Sets the GSI routing table entries, overwriting any previously set entries.
1249
1250 struct kvm_irq_routing {
1251         __u32 nr;
1252         __u32 flags;
1253         struct kvm_irq_routing_entry entries[0];
1254 };
1255
1256 No flags are specified so far, the corresponding field must be set to zero.
1257
1258 struct kvm_irq_routing_entry {
1259         __u32 gsi;
1260         __u32 type;
1261         __u32 flags;
1262         __u32 pad;
1263         union {
1264                 struct kvm_irq_routing_irqchip irqchip;
1265                 struct kvm_irq_routing_msi msi;
1266                 __u32 pad[8];
1267         } u;
1268 };
1269
1270 /* gsi routing entry types */
1271 #define KVM_IRQ_ROUTING_IRQCHIP 1
1272 #define KVM_IRQ_ROUTING_MSI 2
1273
1274 No flags are specified so far, the corresponding field must be set to zero.
1275
1276 struct kvm_irq_routing_irqchip {
1277         __u32 irqchip;
1278         __u32 pin;
1279 };
1280
1281 struct kvm_irq_routing_msi {
1282         __u32 address_lo;
1283         __u32 address_hi;
1284         __u32 data;
1285         __u32 pad;
1286 };
1287
1288 4.53 KVM_ASSIGN_SET_MSIX_NR
1289
1290 Capability: KVM_CAP_DEVICE_MSIX
1291 Architectures: x86 ia64
1292 Type: vm ioctl
1293 Parameters: struct kvm_assigned_msix_nr (in)
1294 Returns: 0 on success, -1 on error
1295
1296 Set the number of MSI-X interrupts for an assigned device. The number is
1297 reset again by terminating the MSI-X assignment of the device via
1298 KVM_DEASSIGN_DEV_IRQ. Calling this service more than once at any earlier
1299 point will fail.
1300
1301 struct kvm_assigned_msix_nr {
1302         __u32 assigned_dev_id;
1303         __u16 entry_nr;
1304         __u16 padding;
1305 };
1306
1307 #define KVM_MAX_MSIX_PER_DEV            256
1308
1309 4.54 KVM_ASSIGN_SET_MSIX_ENTRY
1310
1311 Capability: KVM_CAP_DEVICE_MSIX
1312 Architectures: x86 ia64
1313 Type: vm ioctl
1314 Parameters: struct kvm_assigned_msix_entry (in)
1315 Returns: 0 on success, -1 on error
1316
1317 Specifies the routing of an MSI-X assigned device interrupt to a GSI. Setting
1318 the GSI vector to zero means disabling the interrupt.
1319
1320 struct kvm_assigned_msix_entry {
1321         __u32 assigned_dev_id;
1322         __u32 gsi;
1323         __u16 entry; /* The index of entry in the MSI-X table */
1324         __u16 padding[3];
1325 };
1326
1327 4.54 KVM_SET_TSC_KHZ
1328
1329 Capability: KVM_CAP_TSC_CONTROL
1330 Architectures: x86
1331 Type: vcpu ioctl
1332 Parameters: virtual tsc_khz
1333 Returns: 0 on success, -1 on error
1334
1335 Specifies the tsc frequency for the virtual machine. The unit of the
1336 frequency is KHz.
1337
1338 4.55 KVM_GET_TSC_KHZ
1339
1340 Capability: KVM_CAP_GET_TSC_KHZ
1341 Architectures: x86
1342 Type: vcpu ioctl
1343 Parameters: none
1344 Returns: virtual tsc-khz on success, negative value on error
1345
1346 Returns the tsc frequency of the guest. The unit of the return value is
1347 KHz. If the host has unstable tsc this ioctl returns -EIO instead as an
1348 error.
1349
1350 4.56 KVM_GET_LAPIC
1351
1352 Capability: KVM_CAP_IRQCHIP
1353 Architectures: x86
1354 Type: vcpu ioctl
1355 Parameters: struct kvm_lapic_state (out)
1356 Returns: 0 on success, -1 on error
1357
1358 #define KVM_APIC_REG_SIZE 0x400
1359 struct kvm_lapic_state {
1360         char regs[KVM_APIC_REG_SIZE];
1361 };
1362
1363 Reads the Local APIC registers and copies them into the input argument.  The
1364 data format and layout are the same as documented in the architecture manual.
1365
1366 4.57 KVM_SET_LAPIC
1367
1368 Capability: KVM_CAP_IRQCHIP
1369 Architectures: x86
1370 Type: vcpu ioctl
1371 Parameters: struct kvm_lapic_state (in)
1372 Returns: 0 on success, -1 on error
1373
1374 #define KVM_APIC_REG_SIZE 0x400
1375 struct kvm_lapic_state {
1376         char regs[KVM_APIC_REG_SIZE];
1377 };
1378
1379 Copies the input argument into the the Local APIC registers.  The data format
1380 and layout are the same as documented in the architecture manual.
1381
1382 4.58 KVM_IOEVENTFD
1383
1384 Capability: KVM_CAP_IOEVENTFD
1385 Architectures: all
1386 Type: vm ioctl
1387 Parameters: struct kvm_ioeventfd (in)
1388 Returns: 0 on success, !0 on error
1389
1390 This ioctl attaches or detaches an ioeventfd to a legal pio/mmio address
1391 within the guest.  A guest write in the registered address will signal the
1392 provided event instead of triggering an exit.
1393
1394 struct kvm_ioeventfd {
1395         __u64 datamatch;
1396         __u64 addr;        /* legal pio/mmio address */
1397         __u32 len;         /* 1, 2, 4, or 8 bytes    */
1398         __s32 fd;
1399         __u32 flags;
1400         __u8  pad[36];
1401 };
1402
1403 The following flags are defined:
1404
1405 #define KVM_IOEVENTFD_FLAG_DATAMATCH (1 << kvm_ioeventfd_flag_nr_datamatch)
1406 #define KVM_IOEVENTFD_FLAG_PIO       (1 << kvm_ioeventfd_flag_nr_pio)
1407 #define KVM_IOEVENTFD_FLAG_DEASSIGN  (1 << kvm_ioeventfd_flag_nr_deassign)
1408
1409 If datamatch flag is set, the event will be signaled only if the written value
1410 to the registered address is equal to datamatch in struct kvm_ioeventfd.
1411
1412 4.62 KVM_CREATE_SPAPR_TCE
1413
1414 Capability: KVM_CAP_SPAPR_TCE
1415 Architectures: powerpc
1416 Type: vm ioctl
1417 Parameters: struct kvm_create_spapr_tce (in)
1418 Returns: file descriptor for manipulating the created TCE table
1419
1420 This creates a virtual TCE (translation control entry) table, which
1421 is an IOMMU for PAPR-style virtual I/O.  It is used to translate
1422 logical addresses used in virtual I/O into guest physical addresses,
1423 and provides a scatter/gather capability for PAPR virtual I/O.
1424
1425 /* for KVM_CAP_SPAPR_TCE */
1426 struct kvm_create_spapr_tce {
1427         __u64 liobn;
1428         __u32 window_size;
1429 };
1430
1431 The liobn field gives the logical IO bus number for which to create a
1432 TCE table.  The window_size field specifies the size of the DMA window
1433 which this TCE table will translate - the table will contain one 64
1434 bit TCE entry for every 4kiB of the DMA window.
1435
1436 When the guest issues an H_PUT_TCE hcall on a liobn for which a TCE
1437 table has been created using this ioctl(), the kernel will handle it
1438 in real mode, updating the TCE table.  H_PUT_TCE calls for other
1439 liobns will cause a vm exit and must be handled by userspace.
1440
1441 The return value is a file descriptor which can be passed to mmap(2)
1442 to map the created TCE table into userspace.  This lets userspace read
1443 the entries written by kernel-handled H_PUT_TCE calls, and also lets
1444 userspace update the TCE table directly which is useful in some
1445 circumstances.
1446
1447 4.63 KVM_ALLOCATE_RMA
1448
1449 Capability: KVM_CAP_PPC_RMA
1450 Architectures: powerpc
1451 Type: vm ioctl
1452 Parameters: struct kvm_allocate_rma (out)
1453 Returns: file descriptor for mapping the allocated RMA
1454
1455 This allocates a Real Mode Area (RMA) from the pool allocated at boot
1456 time by the kernel.  An RMA is a physically-contiguous, aligned region
1457 of memory used on older POWER processors to provide the memory which
1458 will be accessed by real-mode (MMU off) accesses in a KVM guest.
1459 POWER processors support a set of sizes for the RMA that usually
1460 includes 64MB, 128MB, 256MB and some larger powers of two.
1461
1462 /* for KVM_ALLOCATE_RMA */
1463 struct kvm_allocate_rma {
1464         __u64 rma_size;
1465 };
1466
1467 The return value is a file descriptor which can be passed to mmap(2)
1468 to map the allocated RMA into userspace.  The mapped area can then be
1469 passed to the KVM_SET_USER_MEMORY_REGION ioctl to establish it as the
1470 RMA for a virtual machine.  The size of the RMA in bytes (which is
1471 fixed at host kernel boot time) is returned in the rma_size field of
1472 the argument structure.
1473
1474 The KVM_CAP_PPC_RMA capability is 1 or 2 if the KVM_ALLOCATE_RMA ioctl
1475 is supported; 2 if the processor requires all virtual machines to have
1476 an RMA, or 1 if the processor can use an RMA but doesn't require it,
1477 because it supports the Virtual RMA (VRMA) facility.
1478
1479 4.64 KVM_NMI
1480
1481 Capability: KVM_CAP_USER_NMI
1482 Architectures: x86
1483 Type: vcpu ioctl
1484 Parameters: none
1485 Returns: 0 on success, -1 on error
1486
1487 Queues an NMI on the thread's vcpu.  Note this is well defined only
1488 when KVM_CREATE_IRQCHIP has not been called, since this is an interface
1489 between the virtual cpu core and virtual local APIC.  After KVM_CREATE_IRQCHIP
1490 has been called, this interface is completely emulated within the kernel.
1491
1492 To use this to emulate the LINT1 input with KVM_CREATE_IRQCHIP, use the
1493 following algorithm:
1494
1495   - pause the vpcu
1496   - read the local APIC's state (KVM_GET_LAPIC)
1497   - check whether changing LINT1 will queue an NMI (see the LVT entry for LINT1)
1498   - if so, issue KVM_NMI
1499   - resume the vcpu
1500
1501 Some guests configure the LINT1 NMI input to cause a panic, aiding in
1502 debugging.
1503
1504 4.64 KVM_S390_UCAS_MAP
1505
1506 Capability: KVM_CAP_S390_UCONTROL
1507 Architectures: s390
1508 Type: vcpu ioctl
1509 Parameters: struct kvm_s390_ucas_mapping (in)
1510 Returns: 0 in case of success
1511
1512 The parameter is defined like this:
1513         struct kvm_s390_ucas_mapping {
1514                 __u64 user_addr;
1515                 __u64 vcpu_addr;
1516                 __u64 length;
1517         };
1518
1519 This ioctl maps the memory at "user_addr" with the length "length" to
1520 the vcpu's address space starting at "vcpu_addr". All parameters need to
1521 be alligned by 1 megabyte.
1522
1523 4.65 KVM_S390_UCAS_UNMAP
1524
1525 Capability: KVM_CAP_S390_UCONTROL
1526 Architectures: s390
1527 Type: vcpu ioctl
1528 Parameters: struct kvm_s390_ucas_mapping (in)
1529 Returns: 0 in case of success
1530
1531 The parameter is defined like this:
1532         struct kvm_s390_ucas_mapping {
1533                 __u64 user_addr;
1534                 __u64 vcpu_addr;
1535                 __u64 length;
1536         };
1537
1538 This ioctl unmaps the memory in the vcpu's address space starting at
1539 "vcpu_addr" with the length "length". The field "user_addr" is ignored.
1540 All parameters need to be alligned by 1 megabyte.
1541
1542 5. The kvm_run structure
1543
1544 Application code obtains a pointer to the kvm_run structure by
1545 mmap()ing a vcpu fd.  From that point, application code can control
1546 execution by changing fields in kvm_run prior to calling the KVM_RUN
1547 ioctl, and obtain information about the reason KVM_RUN returned by
1548 looking up structure members.
1549
1550 struct kvm_run {
1551         /* in */
1552         __u8 request_interrupt_window;
1553
1554 Request that KVM_RUN return when it becomes possible to inject external
1555 interrupts into the guest.  Useful in conjunction with KVM_INTERRUPT.
1556
1557         __u8 padding1[7];
1558
1559         /* out */
1560         __u32 exit_reason;
1561
1562 When KVM_RUN has returned successfully (return value 0), this informs
1563 application code why KVM_RUN has returned.  Allowable values for this
1564 field are detailed below.
1565
1566         __u8 ready_for_interrupt_injection;
1567
1568 If request_interrupt_window has been specified, this field indicates
1569 an interrupt can be injected now with KVM_INTERRUPT.
1570
1571         __u8 if_flag;
1572
1573 The value of the current interrupt flag.  Only valid if in-kernel
1574 local APIC is not used.
1575
1576         __u8 padding2[2];
1577
1578         /* in (pre_kvm_run), out (post_kvm_run) */
1579         __u64 cr8;
1580
1581 The value of the cr8 register.  Only valid if in-kernel local APIC is
1582 not used.  Both input and output.
1583
1584         __u64 apic_base;
1585
1586 The value of the APIC BASE msr.  Only valid if in-kernel local
1587 APIC is not used.  Both input and output.
1588
1589         union {
1590                 /* KVM_EXIT_UNKNOWN */
1591                 struct {
1592                         __u64 hardware_exit_reason;
1593                 } hw;
1594
1595 If exit_reason is KVM_EXIT_UNKNOWN, the vcpu has exited due to unknown
1596 reasons.  Further architecture-specific information is available in
1597 hardware_exit_reason.
1598
1599                 /* KVM_EXIT_FAIL_ENTRY */
1600                 struct {
1601                         __u64 hardware_entry_failure_reason;
1602                 } fail_entry;
1603
1604 If exit_reason is KVM_EXIT_FAIL_ENTRY, the vcpu could not be run due
1605 to unknown reasons.  Further architecture-specific information is
1606 available in hardware_entry_failure_reason.
1607
1608                 /* KVM_EXIT_EXCEPTION */
1609                 struct {
1610                         __u32 exception;
1611                         __u32 error_code;
1612                 } ex;
1613
1614 Unused.
1615
1616                 /* KVM_EXIT_IO */
1617                 struct {
1618 #define KVM_EXIT_IO_IN  0
1619 #define KVM_EXIT_IO_OUT 1
1620                         __u8 direction;
1621                         __u8 size; /* bytes */
1622                         __u16 port;
1623                         __u32 count;
1624                         __u64 data_offset; /* relative to kvm_run start */
1625                 } io;
1626
1627 If exit_reason is KVM_EXIT_IO, then the vcpu has
1628 executed a port I/O instruction which could not be satisfied by kvm.
1629 data_offset describes where the data is located (KVM_EXIT_IO_OUT) or
1630 where kvm expects application code to place the data for the next
1631 KVM_RUN invocation (KVM_EXIT_IO_IN).  Data format is a packed array.
1632
1633                 struct {
1634                         struct kvm_debug_exit_arch arch;
1635                 } debug;
1636
1637 Unused.
1638
1639                 /* KVM_EXIT_MMIO */
1640                 struct {
1641                         __u64 phys_addr;
1642                         __u8  data[8];
1643                         __u32 len;
1644                         __u8  is_write;
1645                 } mmio;
1646
1647 If exit_reason is KVM_EXIT_MMIO, then the vcpu has
1648 executed a memory-mapped I/O instruction which could not be satisfied
1649 by kvm.  The 'data' member contains the written data if 'is_write' is
1650 true, and should be filled by application code otherwise.
1651
1652 NOTE: For KVM_EXIT_IO, KVM_EXIT_MMIO and KVM_EXIT_OSI, the corresponding
1653 operations are complete (and guest state is consistent) only after userspace
1654 has re-entered the kernel with KVM_RUN.  The kernel side will first finish
1655 incomplete operations and then check for pending signals.  Userspace
1656 can re-enter the guest with an unmasked signal pending to complete
1657 pending operations.
1658
1659                 /* KVM_EXIT_HYPERCALL */
1660                 struct {
1661                         __u64 nr;
1662                         __u64 args[6];
1663                         __u64 ret;
1664                         __u32 longmode;
1665                         __u32 pad;
1666                 } hypercall;
1667
1668 Unused.  This was once used for 'hypercall to userspace'.  To implement
1669 such functionality, use KVM_EXIT_IO (x86) or KVM_EXIT_MMIO (all except s390).
1670 Note KVM_EXIT_IO is significantly faster than KVM_EXIT_MMIO.
1671
1672                 /* KVM_EXIT_TPR_ACCESS */
1673                 struct {
1674                         __u64 rip;
1675                         __u32 is_write;
1676                         __u32 pad;
1677                 } tpr_access;
1678
1679 To be documented (KVM_TPR_ACCESS_REPORTING).
1680
1681                 /* KVM_EXIT_S390_SIEIC */
1682                 struct {
1683                         __u8 icptcode;
1684                         __u64 mask; /* psw upper half */
1685                         __u64 addr; /* psw lower half */
1686                         __u16 ipa;
1687                         __u32 ipb;
1688                 } s390_sieic;
1689
1690 s390 specific.
1691
1692                 /* KVM_EXIT_S390_RESET */
1693 #define KVM_S390_RESET_POR       1
1694 #define KVM_S390_RESET_CLEAR     2
1695 #define KVM_S390_RESET_SUBSYSTEM 4
1696 #define KVM_S390_RESET_CPU_INIT  8
1697 #define KVM_S390_RESET_IPL       16
1698                 __u64 s390_reset_flags;
1699
1700 s390 specific.
1701
1702                 /* KVM_EXIT_S390_UCONTROL */
1703                 struct {
1704                         __u64 trans_exc_code;
1705                         __u32 pgm_code;
1706                 } s390_ucontrol;
1707
1708 s390 specific. A page fault has occurred for a user controlled virtual
1709 machine (KVM_VM_S390_UNCONTROL) on it's host page table that cannot be
1710 resolved by the kernel.
1711 The program code and the translation exception code that were placed
1712 in the cpu's lowcore are presented here as defined by the z Architecture
1713 Principles of Operation Book in the Chapter for Dynamic Address Translation
1714 (DAT)
1715
1716                 /* KVM_EXIT_DCR */
1717                 struct {
1718                         __u32 dcrn;
1719                         __u32 data;
1720                         __u8  is_write;
1721                 } dcr;
1722
1723 powerpc specific.
1724
1725                 /* KVM_EXIT_OSI */
1726                 struct {
1727                         __u64 gprs[32];
1728                 } osi;
1729
1730 MOL uses a special hypercall interface it calls 'OSI'. To enable it, we catch
1731 hypercalls and exit with this exit struct that contains all the guest gprs.
1732
1733 If exit_reason is KVM_EXIT_OSI, then the vcpu has triggered such a hypercall.
1734 Userspace can now handle the hypercall and when it's done modify the gprs as
1735 necessary. Upon guest entry all guest GPRs will then be replaced by the values
1736 in this struct.
1737
1738                 /* KVM_EXIT_PAPR_HCALL */
1739                 struct {
1740                         __u64 nr;
1741                         __u64 ret;
1742                         __u64 args[9];
1743                 } papr_hcall;
1744
1745 This is used on 64-bit PowerPC when emulating a pSeries partition,
1746 e.g. with the 'pseries' machine type in qemu.  It occurs when the
1747 guest does a hypercall using the 'sc 1' instruction.  The 'nr' field
1748 contains the hypercall number (from the guest R3), and 'args' contains
1749 the arguments (from the guest R4 - R12).  Userspace should put the
1750 return code in 'ret' and any extra returned values in args[].
1751 The possible hypercalls are defined in the Power Architecture Platform
1752 Requirements (PAPR) document available from www.power.org (free
1753 developer registration required to access it).
1754
1755                 /* Fix the size of the union. */
1756                 char padding[256];
1757         };
1758 };
1759
1760 6. Capabilities that can be enabled
1761
1762 There are certain capabilities that change the behavior of the virtual CPU when
1763 enabled. To enable them, please see section 4.37. Below you can find a list of
1764 capabilities and what their effect on the vCPU is when enabling them.
1765
1766 The following information is provided along with the description:
1767
1768   Architectures: which instruction set architectures provide this ioctl.
1769       x86 includes both i386 and x86_64.
1770
1771   Parameters: what parameters are accepted by the capability.
1772
1773   Returns: the return value.  General error numbers (EBADF, ENOMEM, EINVAL)
1774       are not detailed, but errors with specific meanings are.
1775
1776 6.1 KVM_CAP_PPC_OSI
1777
1778 Architectures: ppc
1779 Parameters: none
1780 Returns: 0 on success; -1 on error
1781
1782 This capability enables interception of OSI hypercalls that otherwise would
1783 be treated as normal system calls to be injected into the guest. OSI hypercalls
1784 were invented by Mac-on-Linux to have a standardized communication mechanism
1785 between the guest and the host.
1786
1787 When this capability is enabled, KVM_EXIT_OSI can occur.
1788
1789 6.2 KVM_CAP_PPC_PAPR
1790
1791 Architectures: ppc
1792 Parameters: none
1793 Returns: 0 on success; -1 on error
1794
1795 This capability enables interception of PAPR hypercalls. PAPR hypercalls are
1796 done using the hypercall instruction "sc 1".
1797
1798 It also sets the guest privilege level to "supervisor" mode. Usually the guest
1799 runs in "hypervisor" privilege mode with a few missing features.
1800
1801 In addition to the above, it changes the semantics of SDR1. In this mode, the
1802 HTAB address part of SDR1 contains an HVA instead of a GPA, as PAPR keeps the
1803 HTAB invisible to the guest.
1804
1805 When this capability is enabled, KVM_EXIT_PAPR_HCALL can occur.