xref: /openbmc/qemu/linux-headers/linux/kvm.h (revision c5614ee3)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef __LINUX_KVM_H
3 #define __LINUX_KVM_H
4 
5 /*
6  * Userspace interface for /dev/kvm - kernel based virtual machine
7  *
8  * Note: you must update KVM_API_VERSION if you change this interface.
9  */
10 
11 #include <linux/const.h>
12 #include <linux/types.h>
13 
14 #include <linux/ioctl.h>
15 #include <asm/kvm.h>
16 
17 #define KVM_API_VERSION 12
18 
19 /*
20  * Backwards-compatible definitions.
21  */
22 #define __KVM_HAVE_GUEST_DEBUG
23 
24 /* for KVM_SET_USER_MEMORY_REGION */
25 struct kvm_userspace_memory_region {
26 	__u32 slot;
27 	__u32 flags;
28 	__u64 guest_phys_addr;
29 	__u64 memory_size; /* bytes */
30 	__u64 userspace_addr; /* start of the userspace allocated memory */
31 };
32 
33 /* for KVM_SET_USER_MEMORY_REGION2 */
34 struct kvm_userspace_memory_region2 {
35 	__u32 slot;
36 	__u32 flags;
37 	__u64 guest_phys_addr;
38 	__u64 memory_size;
39 	__u64 userspace_addr;
40 	__u64 guest_memfd_offset;
41 	__u32 guest_memfd;
42 	__u32 pad1;
43 	__u64 pad2[14];
44 };
45 
46 /*
47  * The bit 0 ~ bit 15 of kvm_userspace_memory_region::flags are visible for
48  * userspace, other bits are reserved for kvm internal use which are defined
49  * in include/linux/kvm_host.h.
50  */
51 #define KVM_MEM_LOG_DIRTY_PAGES	(1UL << 0)
52 #define KVM_MEM_READONLY	(1UL << 1)
53 #define KVM_MEM_GUEST_MEMFD	(1UL << 2)
54 
55 /* for KVM_IRQ_LINE */
56 struct kvm_irq_level {
57 	/*
58 	 * ACPI gsi notion of irq.
59 	 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
60 	 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
61 	 * For ARM: See Documentation/virt/kvm/api.rst
62 	 */
63 	union {
64 		__u32 irq;
65 		__s32 status;
66 	};
67 	__u32 level;
68 };
69 
70 
71 struct kvm_irqchip {
72 	__u32 chip_id;
73 	__u32 pad;
74         union {
75 		char dummy[512];  /* reserving space */
76 #ifdef __KVM_HAVE_PIT
77 		struct kvm_pic_state pic;
78 #endif
79 #ifdef __KVM_HAVE_IOAPIC
80 		struct kvm_ioapic_state ioapic;
81 #endif
82 	} chip;
83 };
84 
85 /* for KVM_CREATE_PIT2 */
86 struct kvm_pit_config {
87 	__u32 flags;
88 	__u32 pad[15];
89 };
90 
91 #define KVM_PIT_SPEAKER_DUMMY     1
92 
93 struct kvm_hyperv_exit {
94 #define KVM_EXIT_HYPERV_SYNIC          1
95 #define KVM_EXIT_HYPERV_HCALL          2
96 #define KVM_EXIT_HYPERV_SYNDBG         3
97 	__u32 type;
98 	__u32 pad1;
99 	union {
100 		struct {
101 			__u32 msr;
102 			__u32 pad2;
103 			__u64 control;
104 			__u64 evt_page;
105 			__u64 msg_page;
106 		} synic;
107 		struct {
108 			__u64 input;
109 			__u64 result;
110 			__u64 params[2];
111 		} hcall;
112 		struct {
113 			__u32 msr;
114 			__u32 pad2;
115 			__u64 control;
116 			__u64 status;
117 			__u64 send_page;
118 			__u64 recv_page;
119 			__u64 pending_page;
120 		} syndbg;
121 	} u;
122 };
123 
124 struct kvm_xen_exit {
125 #define KVM_EXIT_XEN_HCALL          1
126 	__u32 type;
127 	union {
128 		struct {
129 			__u32 longmode;
130 			__u32 cpl;
131 			__u64 input;
132 			__u64 result;
133 			__u64 params[6];
134 		} hcall;
135 	} u;
136 };
137 
138 #define KVM_S390_GET_SKEYS_NONE   1
139 #define KVM_S390_SKEYS_MAX        1048576
140 
141 #define KVM_EXIT_UNKNOWN          0
142 #define KVM_EXIT_EXCEPTION        1
143 #define KVM_EXIT_IO               2
144 #define KVM_EXIT_HYPERCALL        3
145 #define KVM_EXIT_DEBUG            4
146 #define KVM_EXIT_HLT              5
147 #define KVM_EXIT_MMIO             6
148 #define KVM_EXIT_IRQ_WINDOW_OPEN  7
149 #define KVM_EXIT_SHUTDOWN         8
150 #define KVM_EXIT_FAIL_ENTRY       9
151 #define KVM_EXIT_INTR             10
152 #define KVM_EXIT_SET_TPR          11
153 #define KVM_EXIT_TPR_ACCESS       12
154 #define KVM_EXIT_S390_SIEIC       13
155 #define KVM_EXIT_S390_RESET       14
156 #define KVM_EXIT_DCR              15 /* deprecated */
157 #define KVM_EXIT_NMI              16
158 #define KVM_EXIT_INTERNAL_ERROR   17
159 #define KVM_EXIT_OSI              18
160 #define KVM_EXIT_PAPR_HCALL	  19
161 #define KVM_EXIT_S390_UCONTROL	  20
162 #define KVM_EXIT_WATCHDOG         21
163 #define KVM_EXIT_S390_TSCH        22
164 #define KVM_EXIT_EPR              23
165 #define KVM_EXIT_SYSTEM_EVENT     24
166 #define KVM_EXIT_S390_STSI        25
167 #define KVM_EXIT_IOAPIC_EOI       26
168 #define KVM_EXIT_HYPERV           27
169 #define KVM_EXIT_ARM_NISV         28
170 #define KVM_EXIT_X86_RDMSR        29
171 #define KVM_EXIT_X86_WRMSR        30
172 #define KVM_EXIT_DIRTY_RING_FULL  31
173 #define KVM_EXIT_AP_RESET_HOLD    32
174 #define KVM_EXIT_X86_BUS_LOCK     33
175 #define KVM_EXIT_XEN              34
176 #define KVM_EXIT_RISCV_SBI        35
177 #define KVM_EXIT_RISCV_CSR        36
178 #define KVM_EXIT_NOTIFY           37
179 #define KVM_EXIT_LOONGARCH_IOCSR  38
180 #define KVM_EXIT_MEMORY_FAULT     39
181 
182 /* For KVM_EXIT_INTERNAL_ERROR */
183 /* Emulate instruction failed. */
184 #define KVM_INTERNAL_ERROR_EMULATION	1
185 /* Encounter unexpected simultaneous exceptions. */
186 #define KVM_INTERNAL_ERROR_SIMUL_EX	2
187 /* Encounter unexpected vm-exit due to delivery event. */
188 #define KVM_INTERNAL_ERROR_DELIVERY_EV	3
189 /* Encounter unexpected vm-exit reason */
190 #define KVM_INTERNAL_ERROR_UNEXPECTED_EXIT_REASON	4
191 
192 /* Flags that describe what fields in emulation_failure hold valid data. */
193 #define KVM_INTERNAL_ERROR_EMULATION_FLAG_INSTRUCTION_BYTES (1ULL << 0)
194 
195 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
196 struct kvm_run {
197 	/* in */
198 	__u8 request_interrupt_window;
199 	__u8 immediate_exit;
200 	__u8 padding1[6];
201 
202 	/* out */
203 	__u32 exit_reason;
204 	__u8 ready_for_interrupt_injection;
205 	__u8 if_flag;
206 	__u16 flags;
207 
208 	/* in (pre_kvm_run), out (post_kvm_run) */
209 	__u64 cr8;
210 	__u64 apic_base;
211 
212 #ifdef __KVM_S390
213 	/* the processor status word for s390 */
214 	__u64 psw_mask; /* psw upper half */
215 	__u64 psw_addr; /* psw lower half */
216 #endif
217 	union {
218 		/* KVM_EXIT_UNKNOWN */
219 		struct {
220 			__u64 hardware_exit_reason;
221 		} hw;
222 		/* KVM_EXIT_FAIL_ENTRY */
223 		struct {
224 			__u64 hardware_entry_failure_reason;
225 			__u32 cpu;
226 		} fail_entry;
227 		/* KVM_EXIT_EXCEPTION */
228 		struct {
229 			__u32 exception;
230 			__u32 error_code;
231 		} ex;
232 		/* KVM_EXIT_IO */
233 		struct {
234 #define KVM_EXIT_IO_IN  0
235 #define KVM_EXIT_IO_OUT 1
236 			__u8 direction;
237 			__u8 size; /* bytes */
238 			__u16 port;
239 			__u32 count;
240 			__u64 data_offset; /* relative to kvm_run start */
241 		} io;
242 		/* KVM_EXIT_DEBUG */
243 		struct {
244 			struct kvm_debug_exit_arch arch;
245 		} debug;
246 		/* KVM_EXIT_MMIO */
247 		struct {
248 			__u64 phys_addr;
249 			__u8  data[8];
250 			__u32 len;
251 			__u8  is_write;
252 		} mmio;
253 		/* KVM_EXIT_LOONGARCH_IOCSR */
254 		struct {
255 			__u64 phys_addr;
256 			__u8  data[8];
257 			__u32 len;
258 			__u8  is_write;
259 		} iocsr_io;
260 		/* KVM_EXIT_HYPERCALL */
261 		struct {
262 			__u64 nr;
263 			__u64 args[6];
264 			__u64 ret;
265 
266 			union {
267 				__u32 longmode;
268 				__u64 flags;
269 			};
270 		} hypercall;
271 		/* KVM_EXIT_TPR_ACCESS */
272 		struct {
273 			__u64 rip;
274 			__u32 is_write;
275 			__u32 pad;
276 		} tpr_access;
277 		/* KVM_EXIT_S390_SIEIC */
278 		struct {
279 			__u8 icptcode;
280 			__u16 ipa;
281 			__u32 ipb;
282 		} s390_sieic;
283 		/* KVM_EXIT_S390_RESET */
284 		__u64 s390_reset_flags;
285 		/* KVM_EXIT_S390_UCONTROL */
286 		struct {
287 			__u64 trans_exc_code;
288 			__u32 pgm_code;
289 		} s390_ucontrol;
290 		/* KVM_EXIT_DCR (deprecated) */
291 		struct {
292 			__u32 dcrn;
293 			__u32 data;
294 			__u8  is_write;
295 		} dcr;
296 		/* KVM_EXIT_INTERNAL_ERROR */
297 		struct {
298 			__u32 suberror;
299 			/* Available with KVM_CAP_INTERNAL_ERROR_DATA: */
300 			__u32 ndata;
301 			__u64 data[16];
302 		} internal;
303 		/*
304 		 * KVM_INTERNAL_ERROR_EMULATION
305 		 *
306 		 * "struct emulation_failure" is an overlay of "struct internal"
307 		 * that is used for the KVM_INTERNAL_ERROR_EMULATION sub-type of
308 		 * KVM_EXIT_INTERNAL_ERROR.  Note, unlike other internal error
309 		 * sub-types, this struct is ABI!  It also needs to be backwards
310 		 * compatible with "struct internal".  Take special care that
311 		 * "ndata" is correct, that new fields are enumerated in "flags",
312 		 * and that each flag enumerates fields that are 64-bit aligned
313 		 * and sized (so that ndata+internal.data[] is valid/accurate).
314 		 *
315 		 * Space beyond the defined fields may be used to store arbitrary
316 		 * debug information relating to the emulation failure. It is
317 		 * accounted for in "ndata" but the format is unspecified and is
318 		 * not represented in "flags". Any such information is *not* ABI!
319 		 */
320 		struct {
321 			__u32 suberror;
322 			__u32 ndata;
323 			__u64 flags;
324 			union {
325 				struct {
326 					__u8  insn_size;
327 					__u8  insn_bytes[15];
328 				};
329 			};
330 			/* Arbitrary debug data may follow. */
331 		} emulation_failure;
332 		/* KVM_EXIT_OSI */
333 		struct {
334 			__u64 gprs[32];
335 		} osi;
336 		/* KVM_EXIT_PAPR_HCALL */
337 		struct {
338 			__u64 nr;
339 			__u64 ret;
340 			__u64 args[9];
341 		} papr_hcall;
342 		/* KVM_EXIT_S390_TSCH */
343 		struct {
344 			__u16 subchannel_id;
345 			__u16 subchannel_nr;
346 			__u32 io_int_parm;
347 			__u32 io_int_word;
348 			__u32 ipb;
349 			__u8 dequeued;
350 		} s390_tsch;
351 		/* KVM_EXIT_EPR */
352 		struct {
353 			__u32 epr;
354 		} epr;
355 		/* KVM_EXIT_SYSTEM_EVENT */
356 		struct {
357 #define KVM_SYSTEM_EVENT_SHUTDOWN       1
358 #define KVM_SYSTEM_EVENT_RESET          2
359 #define KVM_SYSTEM_EVENT_CRASH          3
360 #define KVM_SYSTEM_EVENT_WAKEUP         4
361 #define KVM_SYSTEM_EVENT_SUSPEND        5
362 #define KVM_SYSTEM_EVENT_SEV_TERM       6
363 			__u32 type;
364 			__u32 ndata;
365 			union {
366 				__u64 flags;
367 				__u64 data[16];
368 			};
369 		} system_event;
370 		/* KVM_EXIT_S390_STSI */
371 		struct {
372 			__u64 addr;
373 			__u8 ar;
374 			__u8 reserved;
375 			__u8 fc;
376 			__u8 sel1;
377 			__u16 sel2;
378 		} s390_stsi;
379 		/* KVM_EXIT_IOAPIC_EOI */
380 		struct {
381 			__u8 vector;
382 		} eoi;
383 		/* KVM_EXIT_HYPERV */
384 		struct kvm_hyperv_exit hyperv;
385 		/* KVM_EXIT_ARM_NISV */
386 		struct {
387 			__u64 esr_iss;
388 			__u64 fault_ipa;
389 		} arm_nisv;
390 		/* KVM_EXIT_X86_RDMSR / KVM_EXIT_X86_WRMSR */
391 		struct {
392 			__u8 error; /* user -> kernel */
393 			__u8 pad[7];
394 #define KVM_MSR_EXIT_REASON_INVAL	(1 << 0)
395 #define KVM_MSR_EXIT_REASON_UNKNOWN	(1 << 1)
396 #define KVM_MSR_EXIT_REASON_FILTER	(1 << 2)
397 #define KVM_MSR_EXIT_REASON_VALID_MASK	(KVM_MSR_EXIT_REASON_INVAL   |	\
398 					 KVM_MSR_EXIT_REASON_UNKNOWN |	\
399 					 KVM_MSR_EXIT_REASON_FILTER)
400 			__u32 reason; /* kernel -> user */
401 			__u32 index; /* kernel -> user */
402 			__u64 data; /* kernel <-> user */
403 		} msr;
404 		/* KVM_EXIT_XEN */
405 		struct kvm_xen_exit xen;
406 		/* KVM_EXIT_RISCV_SBI */
407 		struct {
408 			unsigned long extension_id;
409 			unsigned long function_id;
410 			unsigned long args[6];
411 			unsigned long ret[2];
412 		} riscv_sbi;
413 		/* KVM_EXIT_RISCV_CSR */
414 		struct {
415 			unsigned long csr_num;
416 			unsigned long new_value;
417 			unsigned long write_mask;
418 			unsigned long ret_value;
419 		} riscv_csr;
420 		/* KVM_EXIT_NOTIFY */
421 		struct {
422 #define KVM_NOTIFY_CONTEXT_INVALID	(1 << 0)
423 			__u32 flags;
424 		} notify;
425 		/* KVM_EXIT_MEMORY_FAULT */
426 		struct {
427 #define KVM_MEMORY_EXIT_FLAG_PRIVATE	(1ULL << 3)
428 			__u64 flags;
429 			__u64 gpa;
430 			__u64 size;
431 		} memory_fault;
432 		/* Fix the size of the union. */
433 		char padding[256];
434 	};
435 
436 	/* 2048 is the size of the char array used to bound/pad the size
437 	 * of the union that holds sync regs.
438 	 */
439 	#define SYNC_REGS_SIZE_BYTES 2048
440 	/*
441 	 * shared registers between kvm and userspace.
442 	 * kvm_valid_regs specifies the register classes set by the host
443 	 * kvm_dirty_regs specified the register classes dirtied by userspace
444 	 * struct kvm_sync_regs is architecture specific, as well as the
445 	 * bits for kvm_valid_regs and kvm_dirty_regs
446 	 */
447 	__u64 kvm_valid_regs;
448 	__u64 kvm_dirty_regs;
449 	union {
450 		struct kvm_sync_regs regs;
451 		char padding[SYNC_REGS_SIZE_BYTES];
452 	} s;
453 };
454 
455 /* for KVM_REGISTER_COALESCED_MMIO / KVM_UNREGISTER_COALESCED_MMIO */
456 
457 struct kvm_coalesced_mmio_zone {
458 	__u64 addr;
459 	__u32 size;
460 	union {
461 		__u32 pad;
462 		__u32 pio;
463 	};
464 };
465 
466 struct kvm_coalesced_mmio {
467 	__u64 phys_addr;
468 	__u32 len;
469 	union {
470 		__u32 pad;
471 		__u32 pio;
472 	};
473 	__u8  data[8];
474 };
475 
476 struct kvm_coalesced_mmio_ring {
477 	__u32 first, last;
478 	struct kvm_coalesced_mmio coalesced_mmio[];
479 };
480 
481 #define KVM_COALESCED_MMIO_MAX \
482 	((PAGE_SIZE - sizeof(struct kvm_coalesced_mmio_ring)) / \
483 	 sizeof(struct kvm_coalesced_mmio))
484 
485 /* for KVM_TRANSLATE */
486 struct kvm_translation {
487 	/* in */
488 	__u64 linear_address;
489 
490 	/* out */
491 	__u64 physical_address;
492 	__u8  valid;
493 	__u8  writeable;
494 	__u8  usermode;
495 	__u8  pad[5];
496 };
497 
498 /* for KVM_INTERRUPT */
499 struct kvm_interrupt {
500 	/* in */
501 	__u32 irq;
502 };
503 
504 /* for KVM_GET_DIRTY_LOG */
505 struct kvm_dirty_log {
506 	__u32 slot;
507 	__u32 padding1;
508 	union {
509 		void *dirty_bitmap; /* one bit per page */
510 		__u64 padding2;
511 	};
512 };
513 
514 /* for KVM_CLEAR_DIRTY_LOG */
515 struct kvm_clear_dirty_log {
516 	__u32 slot;
517 	__u32 num_pages;
518 	__u64 first_page;
519 	union {
520 		void *dirty_bitmap; /* one bit per page */
521 		__u64 padding2;
522 	};
523 };
524 
525 /* for KVM_SET_SIGNAL_MASK */
526 struct kvm_signal_mask {
527 	__u32 len;
528 	__u8  sigset[];
529 };
530 
531 /* for KVM_TPR_ACCESS_REPORTING */
532 struct kvm_tpr_access_ctl {
533 	__u32 enabled;
534 	__u32 flags;
535 	__u32 reserved[8];
536 };
537 
538 /* for KVM_SET_VAPIC_ADDR */
539 struct kvm_vapic_addr {
540 	__u64 vapic_addr;
541 };
542 
543 /* for KVM_SET_MP_STATE */
544 
545 /* not all states are valid on all architectures */
546 #define KVM_MP_STATE_RUNNABLE          0
547 #define KVM_MP_STATE_UNINITIALIZED     1
548 #define KVM_MP_STATE_INIT_RECEIVED     2
549 #define KVM_MP_STATE_HALTED            3
550 #define KVM_MP_STATE_SIPI_RECEIVED     4
551 #define KVM_MP_STATE_STOPPED           5
552 #define KVM_MP_STATE_CHECK_STOP        6
553 #define KVM_MP_STATE_OPERATING         7
554 #define KVM_MP_STATE_LOAD              8
555 #define KVM_MP_STATE_AP_RESET_HOLD     9
556 #define KVM_MP_STATE_SUSPENDED         10
557 
558 struct kvm_mp_state {
559 	__u32 mp_state;
560 };
561 
562 /* for KVM_SET_GUEST_DEBUG */
563 
564 #define KVM_GUESTDBG_ENABLE		0x00000001
565 #define KVM_GUESTDBG_SINGLESTEP		0x00000002
566 
567 struct kvm_guest_debug {
568 	__u32 control;
569 	__u32 pad;
570 	struct kvm_guest_debug_arch arch;
571 };
572 
573 enum {
574 	kvm_ioeventfd_flag_nr_datamatch,
575 	kvm_ioeventfd_flag_nr_pio,
576 	kvm_ioeventfd_flag_nr_deassign,
577 	kvm_ioeventfd_flag_nr_virtio_ccw_notify,
578 	kvm_ioeventfd_flag_nr_fast_mmio,
579 	kvm_ioeventfd_flag_nr_max,
580 };
581 
582 #define KVM_IOEVENTFD_FLAG_DATAMATCH (1 << kvm_ioeventfd_flag_nr_datamatch)
583 #define KVM_IOEVENTFD_FLAG_PIO       (1 << kvm_ioeventfd_flag_nr_pio)
584 #define KVM_IOEVENTFD_FLAG_DEASSIGN  (1 << kvm_ioeventfd_flag_nr_deassign)
585 #define KVM_IOEVENTFD_FLAG_VIRTIO_CCW_NOTIFY \
586 	(1 << kvm_ioeventfd_flag_nr_virtio_ccw_notify)
587 
588 #define KVM_IOEVENTFD_VALID_FLAG_MASK  ((1 << kvm_ioeventfd_flag_nr_max) - 1)
589 
590 struct kvm_ioeventfd {
591 	__u64 datamatch;
592 	__u64 addr;        /* legal pio/mmio address */
593 	__u32 len;         /* 1, 2, 4, or 8 bytes; or 0 to ignore length */
594 	__s32 fd;
595 	__u32 flags;
596 	__u8  pad[36];
597 };
598 
599 #define KVM_X86_DISABLE_EXITS_MWAIT          (1 << 0)
600 #define KVM_X86_DISABLE_EXITS_HLT            (1 << 1)
601 #define KVM_X86_DISABLE_EXITS_PAUSE          (1 << 2)
602 #define KVM_X86_DISABLE_EXITS_CSTATE         (1 << 3)
603 #define KVM_X86_DISABLE_VALID_EXITS          (KVM_X86_DISABLE_EXITS_MWAIT | \
604                                               KVM_X86_DISABLE_EXITS_HLT | \
605                                               KVM_X86_DISABLE_EXITS_PAUSE | \
606                                               KVM_X86_DISABLE_EXITS_CSTATE)
607 
608 /* for KVM_ENABLE_CAP */
609 struct kvm_enable_cap {
610 	/* in */
611 	__u32 cap;
612 	__u32 flags;
613 	__u64 args[4];
614 	__u8  pad[64];
615 };
616 
617 #define KVMIO 0xAE
618 
619 /* machine type bits, to be used as argument to KVM_CREATE_VM */
620 #define KVM_VM_S390_UCONTROL	1
621 
622 /* on ppc, 0 indicate default, 1 should force HV and 2 PR */
623 #define KVM_VM_PPC_HV 1
624 #define KVM_VM_PPC_PR 2
625 
626 /* on MIPS, 0 indicates auto, 1 forces VZ ASE, 2 forces trap & emulate */
627 #define KVM_VM_MIPS_AUTO	0
628 #define KVM_VM_MIPS_VZ		1
629 #define KVM_VM_MIPS_TE		2
630 
631 #define KVM_S390_SIE_PAGE_OFFSET 1
632 
633 /*
634  * On arm64, machine type can be used to request the physical
635  * address size for the VM. Bits[7-0] are reserved for the guest
636  * PA size shift (i.e, log2(PA_Size)). For backward compatibility,
637  * value 0 implies the default IPA size, 40bits.
638  */
639 #define KVM_VM_TYPE_ARM_IPA_SIZE_MASK	0xffULL
640 #define KVM_VM_TYPE_ARM_IPA_SIZE(x)		\
641 	((x) & KVM_VM_TYPE_ARM_IPA_SIZE_MASK)
642 /*
643  * ioctls for /dev/kvm fds:
644  */
645 #define KVM_GET_API_VERSION       _IO(KVMIO,   0x00)
646 #define KVM_CREATE_VM             _IO(KVMIO,   0x01) /* returns a VM fd */
647 #define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 0x02, struct kvm_msr_list)
648 
649 #define KVM_S390_ENABLE_SIE       _IO(KVMIO,   0x06)
650 /*
651  * Check if a kvm extension is available.  Argument is extension number,
652  * return is 1 (yes) or 0 (no, sorry).
653  */
654 #define KVM_CHECK_EXTENSION       _IO(KVMIO,   0x03)
655 /*
656  * Get size for mmap(vcpu_fd)
657  */
658 #define KVM_GET_VCPU_MMAP_SIZE    _IO(KVMIO,   0x04) /* in bytes */
659 #define KVM_GET_SUPPORTED_CPUID   _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
660 #define KVM_GET_EMULATED_CPUID	  _IOWR(KVMIO, 0x09, struct kvm_cpuid2)
661 #define KVM_GET_MSR_FEATURE_INDEX_LIST    _IOWR(KVMIO, 0x0a, struct kvm_msr_list)
662 
663 /*
664  * Extension capability list.
665  */
666 #define KVM_CAP_IRQCHIP	  0
667 #define KVM_CAP_HLT	  1
668 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
669 #define KVM_CAP_USER_MEMORY 3
670 #define KVM_CAP_SET_TSS_ADDR 4
671 #define KVM_CAP_VAPIC 6
672 #define KVM_CAP_EXT_CPUID 7
673 #define KVM_CAP_CLOCKSOURCE 8
674 #define KVM_CAP_NR_VCPUS 9       /* returns recommended max vcpus per vm */
675 #define KVM_CAP_NR_MEMSLOTS 10   /* returns max memory slots per vm */
676 #define KVM_CAP_PIT 11
677 #define KVM_CAP_NOP_IO_DELAY 12
678 #define KVM_CAP_PV_MMU 13
679 #define KVM_CAP_MP_STATE 14
680 #define KVM_CAP_COALESCED_MMIO 15
681 #define KVM_CAP_SYNC_MMU 16  /* Changes to host mmap are reflected in guest */
682 #define KVM_CAP_IOMMU 18
683 /* Bug in KVM_SET_USER_MEMORY_REGION fixed: */
684 #define KVM_CAP_DESTROY_MEMORY_REGION_WORKS 21
685 #define KVM_CAP_USER_NMI 22
686 #define KVM_CAP_SET_GUEST_DEBUG 23
687 #ifdef __KVM_HAVE_PIT
688 #define KVM_CAP_REINJECT_CONTROL 24
689 #endif
690 #define KVM_CAP_IRQ_ROUTING 25
691 #define KVM_CAP_IRQ_INJECT_STATUS 26
692 #define KVM_CAP_ASSIGN_DEV_IRQ 29
693 /* Another bug in KVM_SET_USER_MEMORY_REGION fixed: */
694 #define KVM_CAP_JOIN_MEMORY_REGIONS_WORKS 30
695 #ifdef __KVM_HAVE_MCE
696 #define KVM_CAP_MCE 31
697 #endif
698 #define KVM_CAP_IRQFD 32
699 #ifdef __KVM_HAVE_PIT
700 #define KVM_CAP_PIT2 33
701 #endif
702 #define KVM_CAP_SET_BOOT_CPU_ID 34
703 #ifdef __KVM_HAVE_PIT_STATE2
704 #define KVM_CAP_PIT_STATE2 35
705 #endif
706 #define KVM_CAP_IOEVENTFD 36
707 #define KVM_CAP_SET_IDENTITY_MAP_ADDR 37
708 #ifdef __KVM_HAVE_XEN_HVM
709 #define KVM_CAP_XEN_HVM 38
710 #endif
711 #define KVM_CAP_ADJUST_CLOCK 39
712 #define KVM_CAP_INTERNAL_ERROR_DATA 40
713 #ifdef __KVM_HAVE_VCPU_EVENTS
714 #define KVM_CAP_VCPU_EVENTS 41
715 #endif
716 #define KVM_CAP_S390_PSW 42
717 #define KVM_CAP_PPC_SEGSTATE 43
718 #define KVM_CAP_HYPERV 44
719 #define KVM_CAP_HYPERV_VAPIC 45
720 #define KVM_CAP_HYPERV_SPIN 46
721 #define KVM_CAP_PCI_SEGMENT 47
722 #define KVM_CAP_PPC_PAIRED_SINGLES 48
723 #define KVM_CAP_INTR_SHADOW 49
724 #ifdef __KVM_HAVE_DEBUGREGS
725 #define KVM_CAP_DEBUGREGS 50
726 #endif
727 #define KVM_CAP_X86_ROBUST_SINGLESTEP 51
728 #define KVM_CAP_PPC_OSI 52
729 #define KVM_CAP_PPC_UNSET_IRQ 53
730 #define KVM_CAP_ENABLE_CAP 54
731 #ifdef __KVM_HAVE_XSAVE
732 #define KVM_CAP_XSAVE 55
733 #endif
734 #ifdef __KVM_HAVE_XCRS
735 #define KVM_CAP_XCRS 56
736 #endif
737 #define KVM_CAP_PPC_GET_PVINFO 57
738 #define KVM_CAP_PPC_IRQ_LEVEL 58
739 #define KVM_CAP_ASYNC_PF 59
740 #define KVM_CAP_TSC_CONTROL 60
741 #define KVM_CAP_GET_TSC_KHZ 61
742 #define KVM_CAP_PPC_BOOKE_SREGS 62
743 #define KVM_CAP_SPAPR_TCE 63
744 #define KVM_CAP_PPC_SMT 64
745 #define KVM_CAP_PPC_RMA	65
746 #define KVM_CAP_MAX_VCPUS 66       /* returns max vcpus per vm */
747 #define KVM_CAP_PPC_HIOR 67
748 #define KVM_CAP_PPC_PAPR 68
749 #define KVM_CAP_SW_TLB 69
750 #define KVM_CAP_ONE_REG 70
751 #define KVM_CAP_S390_GMAP 71
752 #define KVM_CAP_TSC_DEADLINE_TIMER 72
753 #define KVM_CAP_S390_UCONTROL 73
754 #define KVM_CAP_SYNC_REGS 74
755 #define KVM_CAP_PCI_2_3 75
756 #define KVM_CAP_KVMCLOCK_CTRL 76
757 #define KVM_CAP_SIGNAL_MSI 77
758 #define KVM_CAP_PPC_GET_SMMU_INFO 78
759 #define KVM_CAP_S390_COW 79
760 #define KVM_CAP_PPC_ALLOC_HTAB 80
761 #define KVM_CAP_READONLY_MEM 81
762 #define KVM_CAP_IRQFD_RESAMPLE 82
763 #define KVM_CAP_PPC_BOOKE_WATCHDOG 83
764 #define KVM_CAP_PPC_HTAB_FD 84
765 #define KVM_CAP_S390_CSS_SUPPORT 85
766 #define KVM_CAP_PPC_EPR 86
767 #define KVM_CAP_ARM_PSCI 87
768 #define KVM_CAP_ARM_SET_DEVICE_ADDR 88
769 #define KVM_CAP_DEVICE_CTRL 89
770 #define KVM_CAP_IRQ_MPIC 90
771 #define KVM_CAP_PPC_RTAS 91
772 #define KVM_CAP_IRQ_XICS 92
773 #define KVM_CAP_ARM_EL1_32BIT 93
774 #define KVM_CAP_SPAPR_MULTITCE 94
775 #define KVM_CAP_EXT_EMUL_CPUID 95
776 #define KVM_CAP_HYPERV_TIME 96
777 #define KVM_CAP_IOAPIC_POLARITY_IGNORED 97
778 #define KVM_CAP_ENABLE_CAP_VM 98
779 #define KVM_CAP_S390_IRQCHIP 99
780 #define KVM_CAP_IOEVENTFD_NO_LENGTH 100
781 #define KVM_CAP_VM_ATTRIBUTES 101
782 #define KVM_CAP_ARM_PSCI_0_2 102
783 #define KVM_CAP_PPC_FIXUP_HCALL 103
784 #define KVM_CAP_PPC_ENABLE_HCALL 104
785 #define KVM_CAP_CHECK_EXTENSION_VM 105
786 #define KVM_CAP_S390_USER_SIGP 106
787 #define KVM_CAP_S390_VECTOR_REGISTERS 107
788 #define KVM_CAP_S390_MEM_OP 108
789 #define KVM_CAP_S390_USER_STSI 109
790 #define KVM_CAP_S390_SKEYS 110
791 #define KVM_CAP_MIPS_FPU 111
792 #define KVM_CAP_MIPS_MSA 112
793 #define KVM_CAP_S390_INJECT_IRQ 113
794 #define KVM_CAP_S390_IRQ_STATE 114
795 #define KVM_CAP_PPC_HWRNG 115
796 #define KVM_CAP_DISABLE_QUIRKS 116
797 #define KVM_CAP_X86_SMM 117
798 #define KVM_CAP_MULTI_ADDRESS_SPACE 118
799 #define KVM_CAP_GUEST_DEBUG_HW_BPS 119
800 #define KVM_CAP_GUEST_DEBUG_HW_WPS 120
801 #define KVM_CAP_SPLIT_IRQCHIP 121
802 #define KVM_CAP_IOEVENTFD_ANY_LENGTH 122
803 #define KVM_CAP_HYPERV_SYNIC 123
804 #define KVM_CAP_S390_RI 124
805 #define KVM_CAP_SPAPR_TCE_64 125
806 #define KVM_CAP_ARM_PMU_V3 126
807 #define KVM_CAP_VCPU_ATTRIBUTES 127
808 #define KVM_CAP_MAX_VCPU_ID 128
809 #define KVM_CAP_X2APIC_API 129
810 #define KVM_CAP_S390_USER_INSTR0 130
811 #define KVM_CAP_MSI_DEVID 131
812 #define KVM_CAP_PPC_HTM 132
813 #define KVM_CAP_SPAPR_RESIZE_HPT 133
814 #define KVM_CAP_PPC_MMU_RADIX 134
815 #define KVM_CAP_PPC_MMU_HASH_V3 135
816 #define KVM_CAP_IMMEDIATE_EXIT 136
817 #define KVM_CAP_MIPS_VZ 137
818 #define KVM_CAP_MIPS_TE 138
819 #define KVM_CAP_MIPS_64BIT 139
820 #define KVM_CAP_S390_GS 140
821 #define KVM_CAP_S390_AIS 141
822 #define KVM_CAP_SPAPR_TCE_VFIO 142
823 #define KVM_CAP_X86_DISABLE_EXITS 143
824 #define KVM_CAP_ARM_USER_IRQ 144
825 #define KVM_CAP_S390_CMMA_MIGRATION 145
826 #define KVM_CAP_PPC_FWNMI 146
827 #define KVM_CAP_PPC_SMT_POSSIBLE 147
828 #define KVM_CAP_HYPERV_SYNIC2 148
829 #define KVM_CAP_HYPERV_VP_INDEX 149
830 #define KVM_CAP_S390_AIS_MIGRATION 150
831 #define KVM_CAP_PPC_GET_CPU_CHAR 151
832 #define KVM_CAP_S390_BPB 152
833 #define KVM_CAP_GET_MSR_FEATURES 153
834 #define KVM_CAP_HYPERV_EVENTFD 154
835 #define KVM_CAP_HYPERV_TLBFLUSH 155
836 #define KVM_CAP_S390_HPAGE_1M 156
837 #define KVM_CAP_NESTED_STATE 157
838 #define KVM_CAP_ARM_INJECT_SERROR_ESR 158
839 #define KVM_CAP_MSR_PLATFORM_INFO 159
840 #define KVM_CAP_PPC_NESTED_HV 160
841 #define KVM_CAP_HYPERV_SEND_IPI 161
842 #define KVM_CAP_COALESCED_PIO 162
843 #define KVM_CAP_HYPERV_ENLIGHTENED_VMCS 163
844 #define KVM_CAP_EXCEPTION_PAYLOAD 164
845 #define KVM_CAP_ARM_VM_IPA_SIZE 165
846 #define KVM_CAP_MANUAL_DIRTY_LOG_PROTECT 166 /* Obsolete */
847 #define KVM_CAP_HYPERV_CPUID 167
848 #define KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2 168
849 #define KVM_CAP_PPC_IRQ_XIVE 169
850 #define KVM_CAP_ARM_SVE 170
851 #define KVM_CAP_ARM_PTRAUTH_ADDRESS 171
852 #define KVM_CAP_ARM_PTRAUTH_GENERIC 172
853 #define KVM_CAP_PMU_EVENT_FILTER 173
854 #define KVM_CAP_ARM_IRQ_LINE_LAYOUT_2 174
855 #define KVM_CAP_HYPERV_DIRECT_TLBFLUSH 175
856 #define KVM_CAP_PPC_GUEST_DEBUG_SSTEP 176
857 #define KVM_CAP_ARM_NISV_TO_USER 177
858 #define KVM_CAP_ARM_INJECT_EXT_DABT 178
859 #define KVM_CAP_S390_VCPU_RESETS 179
860 #define KVM_CAP_S390_PROTECTED 180
861 #define KVM_CAP_PPC_SECURE_GUEST 181
862 #define KVM_CAP_HALT_POLL 182
863 #define KVM_CAP_ASYNC_PF_INT 183
864 #define KVM_CAP_LAST_CPU 184
865 #define KVM_CAP_SMALLER_MAXPHYADDR 185
866 #define KVM_CAP_S390_DIAG318 186
867 #define KVM_CAP_STEAL_TIME 187
868 #define KVM_CAP_X86_USER_SPACE_MSR 188
869 #define KVM_CAP_X86_MSR_FILTER 189
870 #define KVM_CAP_ENFORCE_PV_FEATURE_CPUID 190
871 #define KVM_CAP_SYS_HYPERV_CPUID 191
872 #define KVM_CAP_DIRTY_LOG_RING 192
873 #define KVM_CAP_X86_BUS_LOCK_EXIT 193
874 #define KVM_CAP_PPC_DAWR1 194
875 #define KVM_CAP_SET_GUEST_DEBUG2 195
876 #define KVM_CAP_SGX_ATTRIBUTE 196
877 #define KVM_CAP_VM_COPY_ENC_CONTEXT_FROM 197
878 #define KVM_CAP_PTP_KVM 198
879 #define KVM_CAP_HYPERV_ENFORCE_CPUID 199
880 #define KVM_CAP_SREGS2 200
881 #define KVM_CAP_EXIT_HYPERCALL 201
882 #define KVM_CAP_PPC_RPT_INVALIDATE 202
883 #define KVM_CAP_BINARY_STATS_FD 203
884 #define KVM_CAP_EXIT_ON_EMULATION_FAILURE 204
885 #define KVM_CAP_ARM_MTE 205
886 #define KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM 206
887 #define KVM_CAP_VM_GPA_BITS 207
888 #define KVM_CAP_XSAVE2 208
889 #define KVM_CAP_SYS_ATTRIBUTES 209
890 #define KVM_CAP_PPC_AIL_MODE_3 210
891 #define KVM_CAP_S390_MEM_OP_EXTENSION 211
892 #define KVM_CAP_PMU_CAPABILITY 212
893 #define KVM_CAP_DISABLE_QUIRKS2 213
894 #define KVM_CAP_VM_TSC_CONTROL 214
895 #define KVM_CAP_SYSTEM_EVENT_DATA 215
896 #define KVM_CAP_ARM_SYSTEM_SUSPEND 216
897 #define KVM_CAP_S390_PROTECTED_DUMP 217
898 #define KVM_CAP_X86_TRIPLE_FAULT_EVENT 218
899 #define KVM_CAP_X86_NOTIFY_VMEXIT 219
900 #define KVM_CAP_VM_DISABLE_NX_HUGE_PAGES 220
901 #define KVM_CAP_S390_ZPCI_OP 221
902 #define KVM_CAP_S390_CPU_TOPOLOGY 222
903 #define KVM_CAP_DIRTY_LOG_RING_ACQ_REL 223
904 #define KVM_CAP_S390_PROTECTED_ASYNC_DISABLE 224
905 #define KVM_CAP_DIRTY_LOG_RING_WITH_BITMAP 225
906 #define KVM_CAP_PMU_EVENT_MASKED_EVENTS 226
907 #define KVM_CAP_COUNTER_OFFSET 227
908 #define KVM_CAP_ARM_EAGER_SPLIT_CHUNK_SIZE 228
909 #define KVM_CAP_ARM_SUPPORTED_BLOCK_SIZES 229
910 #define KVM_CAP_ARM_SUPPORTED_REG_MASK_RANGES 230
911 #define KVM_CAP_USER_MEMORY2 231
912 #define KVM_CAP_MEMORY_FAULT_INFO 232
913 #define KVM_CAP_MEMORY_ATTRIBUTES 233
914 #define KVM_CAP_GUEST_MEMFD 234
915 #define KVM_CAP_VM_TYPES 235
916 
917 struct kvm_irq_routing_irqchip {
918 	__u32 irqchip;
919 	__u32 pin;
920 };
921 
922 struct kvm_irq_routing_msi {
923 	__u32 address_lo;
924 	__u32 address_hi;
925 	__u32 data;
926 	union {
927 		__u32 pad;
928 		__u32 devid;
929 	};
930 };
931 
932 struct kvm_irq_routing_s390_adapter {
933 	__u64 ind_addr;
934 	__u64 summary_addr;
935 	__u64 ind_offset;
936 	__u32 summary_offset;
937 	__u32 adapter_id;
938 };
939 
940 struct kvm_irq_routing_hv_sint {
941 	__u32 vcpu;
942 	__u32 sint;
943 };
944 
945 struct kvm_irq_routing_xen_evtchn {
946 	__u32 port;
947 	__u32 vcpu;
948 	__u32 priority;
949 };
950 
951 #define KVM_IRQ_ROUTING_XEN_EVTCHN_PRIO_2LEVEL ((__u32)(-1))
952 
953 /* gsi routing entry types */
954 #define KVM_IRQ_ROUTING_IRQCHIP 1
955 #define KVM_IRQ_ROUTING_MSI 2
956 #define KVM_IRQ_ROUTING_S390_ADAPTER 3
957 #define KVM_IRQ_ROUTING_HV_SINT 4
958 #define KVM_IRQ_ROUTING_XEN_EVTCHN 5
959 
960 struct kvm_irq_routing_entry {
961 	__u32 gsi;
962 	__u32 type;
963 	__u32 flags;
964 	__u32 pad;
965 	union {
966 		struct kvm_irq_routing_irqchip irqchip;
967 		struct kvm_irq_routing_msi msi;
968 		struct kvm_irq_routing_s390_adapter adapter;
969 		struct kvm_irq_routing_hv_sint hv_sint;
970 		struct kvm_irq_routing_xen_evtchn xen_evtchn;
971 		__u32 pad[8];
972 	} u;
973 };
974 
975 struct kvm_irq_routing {
976 	__u32 nr;
977 	__u32 flags;
978 	struct kvm_irq_routing_entry entries[];
979 };
980 
981 #define KVM_IRQFD_FLAG_DEASSIGN (1 << 0)
982 /*
983  * Available with KVM_CAP_IRQFD_RESAMPLE
984  *
985  * KVM_IRQFD_FLAG_RESAMPLE indicates resamplefd is valid and specifies
986  * the irqfd to operate in resampling mode for level triggered interrupt
987  * emulation.  See Documentation/virt/kvm/api.rst.
988  */
989 #define KVM_IRQFD_FLAG_RESAMPLE (1 << 1)
990 
991 struct kvm_irqfd {
992 	__u32 fd;
993 	__u32 gsi;
994 	__u32 flags;
995 	__u32 resamplefd;
996 	__u8  pad[16];
997 };
998 
999 /* For KVM_CAP_ADJUST_CLOCK */
1000 
1001 /* Do not use 1, KVM_CHECK_EXTENSION returned it before we had flags.  */
1002 #define KVM_CLOCK_TSC_STABLE		2
1003 #define KVM_CLOCK_REALTIME		(1 << 2)
1004 #define KVM_CLOCK_HOST_TSC		(1 << 3)
1005 
1006 struct kvm_clock_data {
1007 	__u64 clock;
1008 	__u32 flags;
1009 	__u32 pad0;
1010 	__u64 realtime;
1011 	__u64 host_tsc;
1012 	__u32 pad[4];
1013 };
1014 
1015 /* For KVM_CAP_SW_TLB */
1016 
1017 #define KVM_MMU_FSL_BOOKE_NOHV		0
1018 #define KVM_MMU_FSL_BOOKE_HV		1
1019 
1020 struct kvm_config_tlb {
1021 	__u64 params;
1022 	__u64 array;
1023 	__u32 mmu_type;
1024 	__u32 array_len;
1025 };
1026 
1027 struct kvm_dirty_tlb {
1028 	__u64 bitmap;
1029 	__u32 num_dirty;
1030 };
1031 
1032 /* Available with KVM_CAP_ONE_REG */
1033 
1034 #define KVM_REG_ARCH_MASK	0xff00000000000000ULL
1035 #define KVM_REG_GENERIC		0x0000000000000000ULL
1036 
1037 /*
1038  * Architecture specific registers are to be defined in arch headers and
1039  * ORed with the arch identifier.
1040  */
1041 #define KVM_REG_PPC		0x1000000000000000ULL
1042 #define KVM_REG_X86		0x2000000000000000ULL
1043 #define KVM_REG_IA64		0x3000000000000000ULL
1044 #define KVM_REG_ARM		0x4000000000000000ULL
1045 #define KVM_REG_S390		0x5000000000000000ULL
1046 #define KVM_REG_ARM64		0x6000000000000000ULL
1047 #define KVM_REG_MIPS		0x7000000000000000ULL
1048 #define KVM_REG_RISCV		0x8000000000000000ULL
1049 #define KVM_REG_LOONGARCH	0x9000000000000000ULL
1050 
1051 #define KVM_REG_SIZE_SHIFT	52
1052 #define KVM_REG_SIZE_MASK	0x00f0000000000000ULL
1053 #define KVM_REG_SIZE_U8		0x0000000000000000ULL
1054 #define KVM_REG_SIZE_U16	0x0010000000000000ULL
1055 #define KVM_REG_SIZE_U32	0x0020000000000000ULL
1056 #define KVM_REG_SIZE_U64	0x0030000000000000ULL
1057 #define KVM_REG_SIZE_U128	0x0040000000000000ULL
1058 #define KVM_REG_SIZE_U256	0x0050000000000000ULL
1059 #define KVM_REG_SIZE_U512	0x0060000000000000ULL
1060 #define KVM_REG_SIZE_U1024	0x0070000000000000ULL
1061 #define KVM_REG_SIZE_U2048	0x0080000000000000ULL
1062 
1063 struct kvm_reg_list {
1064 	__u64 n; /* number of regs */
1065 	__u64 reg[];
1066 };
1067 
1068 struct kvm_one_reg {
1069 	__u64 id;
1070 	__u64 addr;
1071 };
1072 
1073 #define KVM_MSI_VALID_DEVID	(1U << 0)
1074 struct kvm_msi {
1075 	__u32 address_lo;
1076 	__u32 address_hi;
1077 	__u32 data;
1078 	__u32 flags;
1079 	__u32 devid;
1080 	__u8  pad[12];
1081 };
1082 
1083 struct kvm_arm_device_addr {
1084 	__u64 id;
1085 	__u64 addr;
1086 };
1087 
1088 /*
1089  * Device control API, available with KVM_CAP_DEVICE_CTRL
1090  */
1091 #define KVM_CREATE_DEVICE_TEST		1
1092 
1093 struct kvm_create_device {
1094 	__u32	type;	/* in: KVM_DEV_TYPE_xxx */
1095 	__u32	fd;	/* out: device handle */
1096 	__u32	flags;	/* in: KVM_CREATE_DEVICE_xxx */
1097 };
1098 
1099 struct kvm_device_attr {
1100 	__u32	flags;		/* no flags currently defined */
1101 	__u32	group;		/* device-defined */
1102 	__u64	attr;		/* group-defined */
1103 	__u64	addr;		/* userspace address of attr data */
1104 };
1105 
1106 #define  KVM_DEV_VFIO_FILE			1
1107 
1108 #define   KVM_DEV_VFIO_FILE_ADD			1
1109 #define   KVM_DEV_VFIO_FILE_DEL			2
1110 
1111 /* KVM_DEV_VFIO_GROUP aliases are for compile time uapi compatibility */
1112 #define  KVM_DEV_VFIO_GROUP	KVM_DEV_VFIO_FILE
1113 
1114 #define   KVM_DEV_VFIO_GROUP_ADD	KVM_DEV_VFIO_FILE_ADD
1115 #define   KVM_DEV_VFIO_GROUP_DEL	KVM_DEV_VFIO_FILE_DEL
1116 #define   KVM_DEV_VFIO_GROUP_SET_SPAPR_TCE		3
1117 
1118 enum kvm_device_type {
1119 	KVM_DEV_TYPE_FSL_MPIC_20	= 1,
1120 #define KVM_DEV_TYPE_FSL_MPIC_20	KVM_DEV_TYPE_FSL_MPIC_20
1121 	KVM_DEV_TYPE_FSL_MPIC_42,
1122 #define KVM_DEV_TYPE_FSL_MPIC_42	KVM_DEV_TYPE_FSL_MPIC_42
1123 	KVM_DEV_TYPE_XICS,
1124 #define KVM_DEV_TYPE_XICS		KVM_DEV_TYPE_XICS
1125 	KVM_DEV_TYPE_VFIO,
1126 #define KVM_DEV_TYPE_VFIO		KVM_DEV_TYPE_VFIO
1127 	KVM_DEV_TYPE_ARM_VGIC_V2,
1128 #define KVM_DEV_TYPE_ARM_VGIC_V2	KVM_DEV_TYPE_ARM_VGIC_V2
1129 	KVM_DEV_TYPE_FLIC,
1130 #define KVM_DEV_TYPE_FLIC		KVM_DEV_TYPE_FLIC
1131 	KVM_DEV_TYPE_ARM_VGIC_V3,
1132 #define KVM_DEV_TYPE_ARM_VGIC_V3	KVM_DEV_TYPE_ARM_VGIC_V3
1133 	KVM_DEV_TYPE_ARM_VGIC_ITS,
1134 #define KVM_DEV_TYPE_ARM_VGIC_ITS	KVM_DEV_TYPE_ARM_VGIC_ITS
1135 	KVM_DEV_TYPE_XIVE,
1136 #define KVM_DEV_TYPE_XIVE		KVM_DEV_TYPE_XIVE
1137 	KVM_DEV_TYPE_ARM_PV_TIME,
1138 #define KVM_DEV_TYPE_ARM_PV_TIME	KVM_DEV_TYPE_ARM_PV_TIME
1139 	KVM_DEV_TYPE_RISCV_AIA,
1140 #define KVM_DEV_TYPE_RISCV_AIA		KVM_DEV_TYPE_RISCV_AIA
1141 	KVM_DEV_TYPE_MAX,
1142 };
1143 
1144 struct kvm_vfio_spapr_tce {
1145 	__s32	groupfd;
1146 	__s32	tablefd;
1147 };
1148 
1149 /*
1150  * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
1151  * a vcpu fd.
1152  */
1153 #define KVM_CREATE_VCPU           _IO(KVMIO,   0x41)
1154 #define KVM_GET_DIRTY_LOG         _IOW(KVMIO,  0x42, struct kvm_dirty_log)
1155 #define KVM_SET_NR_MMU_PAGES      _IO(KVMIO,   0x44)
1156 #define KVM_GET_NR_MMU_PAGES      _IO(KVMIO,   0x45)  /* deprecated */
1157 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46, \
1158 					struct kvm_userspace_memory_region)
1159 #define KVM_SET_TSS_ADDR          _IO(KVMIO,   0x47)
1160 #define KVM_SET_IDENTITY_MAP_ADDR _IOW(KVMIO,  0x48, __u64)
1161 #define KVM_SET_USER_MEMORY_REGION2 _IOW(KVMIO, 0x49, \
1162 					 struct kvm_userspace_memory_region2)
1163 
1164 /* enable ucontrol for s390 */
1165 #define KVM_S390_UCAS_MAP        _IOW(KVMIO, 0x50, struct kvm_s390_ucas_mapping)
1166 #define KVM_S390_UCAS_UNMAP      _IOW(KVMIO, 0x51, struct kvm_s390_ucas_mapping)
1167 #define KVM_S390_VCPU_FAULT	 _IOW(KVMIO, 0x52, unsigned long)
1168 
1169 /* Device model IOC */
1170 #define KVM_CREATE_IRQCHIP        _IO(KVMIO,   0x60)
1171 #define KVM_IRQ_LINE              _IOW(KVMIO,  0x61, struct kvm_irq_level)
1172 #define KVM_GET_IRQCHIP           _IOWR(KVMIO, 0x62, struct kvm_irqchip)
1173 #define KVM_SET_IRQCHIP           _IOR(KVMIO,  0x63, struct kvm_irqchip)
1174 #define KVM_CREATE_PIT            _IO(KVMIO,   0x64)
1175 #define KVM_GET_PIT               _IOWR(KVMIO, 0x65, struct kvm_pit_state)
1176 #define KVM_SET_PIT               _IOR(KVMIO,  0x66, struct kvm_pit_state)
1177 #define KVM_IRQ_LINE_STATUS       _IOWR(KVMIO, 0x67, struct kvm_irq_level)
1178 #define KVM_REGISTER_COALESCED_MMIO \
1179 			_IOW(KVMIO,  0x67, struct kvm_coalesced_mmio_zone)
1180 #define KVM_UNREGISTER_COALESCED_MMIO \
1181 			_IOW(KVMIO,  0x68, struct kvm_coalesced_mmio_zone)
1182 #define KVM_SET_GSI_ROUTING       _IOW(KVMIO,  0x6a, struct kvm_irq_routing)
1183 #define KVM_REINJECT_CONTROL      _IO(KVMIO,   0x71)
1184 #define KVM_IRQFD                 _IOW(KVMIO,  0x76, struct kvm_irqfd)
1185 #define KVM_CREATE_PIT2		  _IOW(KVMIO,  0x77, struct kvm_pit_config)
1186 #define KVM_SET_BOOT_CPU_ID       _IO(KVMIO,   0x78)
1187 #define KVM_IOEVENTFD             _IOW(KVMIO,  0x79, struct kvm_ioeventfd)
1188 #define KVM_XEN_HVM_CONFIG        _IOW(KVMIO,  0x7a, struct kvm_xen_hvm_config)
1189 #define KVM_SET_CLOCK             _IOW(KVMIO,  0x7b, struct kvm_clock_data)
1190 #define KVM_GET_CLOCK             _IOR(KVMIO,  0x7c, struct kvm_clock_data)
1191 /* Available with KVM_CAP_PIT_STATE2 */
1192 #define KVM_GET_PIT2              _IOR(KVMIO,  0x9f, struct kvm_pit_state2)
1193 #define KVM_SET_PIT2              _IOW(KVMIO,  0xa0, struct kvm_pit_state2)
1194 /* Available with KVM_CAP_PPC_GET_PVINFO */
1195 #define KVM_PPC_GET_PVINFO	  _IOW(KVMIO,  0xa1, struct kvm_ppc_pvinfo)
1196 /* Available with KVM_CAP_TSC_CONTROL for a vCPU, or with
1197 *  KVM_CAP_VM_TSC_CONTROL to set defaults for a VM */
1198 #define KVM_SET_TSC_KHZ           _IO(KVMIO,  0xa2)
1199 #define KVM_GET_TSC_KHZ           _IO(KVMIO,  0xa3)
1200 /* Available with KVM_CAP_SIGNAL_MSI */
1201 #define KVM_SIGNAL_MSI            _IOW(KVMIO,  0xa5, struct kvm_msi)
1202 /* Available with KVM_CAP_PPC_GET_SMMU_INFO */
1203 #define KVM_PPC_GET_SMMU_INFO	  _IOR(KVMIO,  0xa6, struct kvm_ppc_smmu_info)
1204 /* Available with KVM_CAP_PPC_ALLOC_HTAB */
1205 #define KVM_PPC_ALLOCATE_HTAB	  _IOWR(KVMIO, 0xa7, __u32)
1206 #define KVM_CREATE_SPAPR_TCE	  _IOW(KVMIO,  0xa8, struct kvm_create_spapr_tce)
1207 #define KVM_CREATE_SPAPR_TCE_64	  _IOW(KVMIO,  0xa8, \
1208 				       struct kvm_create_spapr_tce_64)
1209 /* Available with KVM_CAP_RMA */
1210 #define KVM_ALLOCATE_RMA	  _IOR(KVMIO,  0xa9, struct kvm_allocate_rma)
1211 /* Available with KVM_CAP_PPC_HTAB_FD */
1212 #define KVM_PPC_GET_HTAB_FD	  _IOW(KVMIO,  0xaa, struct kvm_get_htab_fd)
1213 /* Available with KVM_CAP_ARM_SET_DEVICE_ADDR */
1214 #define KVM_ARM_SET_DEVICE_ADDR	  _IOW(KVMIO,  0xab, struct kvm_arm_device_addr)
1215 /* Available with KVM_CAP_PPC_RTAS */
1216 #define KVM_PPC_RTAS_DEFINE_TOKEN _IOW(KVMIO,  0xac, struct kvm_rtas_token_args)
1217 /* Available with KVM_CAP_SPAPR_RESIZE_HPT */
1218 #define KVM_PPC_RESIZE_HPT_PREPARE _IOR(KVMIO, 0xad, struct kvm_ppc_resize_hpt)
1219 #define KVM_PPC_RESIZE_HPT_COMMIT  _IOR(KVMIO, 0xae, struct kvm_ppc_resize_hpt)
1220 /* Available with KVM_CAP_PPC_MMU_RADIX or KVM_CAP_PPC_MMU_HASH_V3 */
1221 #define KVM_PPC_CONFIGURE_V3_MMU  _IOW(KVMIO,  0xaf, struct kvm_ppc_mmuv3_cfg)
1222 /* Available with KVM_CAP_PPC_MMU_RADIX */
1223 #define KVM_PPC_GET_RMMU_INFO	  _IOW(KVMIO,  0xb0, struct kvm_ppc_rmmu_info)
1224 /* Available with KVM_CAP_PPC_GET_CPU_CHAR */
1225 #define KVM_PPC_GET_CPU_CHAR	  _IOR(KVMIO,  0xb1, struct kvm_ppc_cpu_char)
1226 /* Available with KVM_CAP_PMU_EVENT_FILTER */
1227 #define KVM_SET_PMU_EVENT_FILTER  _IOW(KVMIO,  0xb2, struct kvm_pmu_event_filter)
1228 #define KVM_PPC_SVM_OFF		  _IO(KVMIO,  0xb3)
1229 #define KVM_ARM_MTE_COPY_TAGS	  _IOR(KVMIO,  0xb4, struct kvm_arm_copy_mte_tags)
1230 /* Available with KVM_CAP_COUNTER_OFFSET */
1231 #define KVM_ARM_SET_COUNTER_OFFSET _IOW(KVMIO,  0xb5, struct kvm_arm_counter_offset)
1232 #define KVM_ARM_GET_REG_WRITABLE_MASKS _IOR(KVMIO,  0xb6, struct reg_mask_range)
1233 
1234 /* ioctl for vm fd */
1235 #define KVM_CREATE_DEVICE	  _IOWR(KVMIO,  0xe0, struct kvm_create_device)
1236 
1237 /* ioctls for fds returned by KVM_CREATE_DEVICE */
1238 #define KVM_SET_DEVICE_ATTR	  _IOW(KVMIO,  0xe1, struct kvm_device_attr)
1239 #define KVM_GET_DEVICE_ATTR	  _IOW(KVMIO,  0xe2, struct kvm_device_attr)
1240 #define KVM_HAS_DEVICE_ATTR	  _IOW(KVMIO,  0xe3, struct kvm_device_attr)
1241 
1242 /*
1243  * ioctls for vcpu fds
1244  */
1245 #define KVM_RUN                   _IO(KVMIO,   0x80)
1246 #define KVM_GET_REGS              _IOR(KVMIO,  0x81, struct kvm_regs)
1247 #define KVM_SET_REGS              _IOW(KVMIO,  0x82, struct kvm_regs)
1248 #define KVM_GET_SREGS             _IOR(KVMIO,  0x83, struct kvm_sregs)
1249 #define KVM_SET_SREGS             _IOW(KVMIO,  0x84, struct kvm_sregs)
1250 #define KVM_TRANSLATE             _IOWR(KVMIO, 0x85, struct kvm_translation)
1251 #define KVM_INTERRUPT             _IOW(KVMIO,  0x86, struct kvm_interrupt)
1252 #define KVM_GET_MSRS              _IOWR(KVMIO, 0x88, struct kvm_msrs)
1253 #define KVM_SET_MSRS              _IOW(KVMIO,  0x89, struct kvm_msrs)
1254 #define KVM_SET_CPUID             _IOW(KVMIO,  0x8a, struct kvm_cpuid)
1255 #define KVM_SET_SIGNAL_MASK       _IOW(KVMIO,  0x8b, struct kvm_signal_mask)
1256 #define KVM_GET_FPU               _IOR(KVMIO,  0x8c, struct kvm_fpu)
1257 #define KVM_SET_FPU               _IOW(KVMIO,  0x8d, struct kvm_fpu)
1258 #define KVM_GET_LAPIC             _IOR(KVMIO,  0x8e, struct kvm_lapic_state)
1259 #define KVM_SET_LAPIC             _IOW(KVMIO,  0x8f, struct kvm_lapic_state)
1260 #define KVM_SET_CPUID2            _IOW(KVMIO,  0x90, struct kvm_cpuid2)
1261 #define KVM_GET_CPUID2            _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
1262 /* Available with KVM_CAP_VAPIC */
1263 #define KVM_TPR_ACCESS_REPORTING  _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
1264 /* Available with KVM_CAP_VAPIC */
1265 #define KVM_SET_VAPIC_ADDR        _IOW(KVMIO,  0x93, struct kvm_vapic_addr)
1266 /* valid for virtual machine (for floating interrupt)_and_ vcpu */
1267 #define KVM_S390_INTERRUPT        _IOW(KVMIO,  0x94, struct kvm_s390_interrupt)
1268 /* store status for s390 */
1269 #define KVM_S390_STORE_STATUS_NOADDR    (-1ul)
1270 #define KVM_S390_STORE_STATUS_PREFIXED  (-2ul)
1271 #define KVM_S390_STORE_STATUS	  _IOW(KVMIO,  0x95, unsigned long)
1272 /* initial ipl psw for s390 */
1273 #define KVM_S390_SET_INITIAL_PSW  _IOW(KVMIO,  0x96, struct kvm_s390_psw)
1274 /* initial reset for s390 */
1275 #define KVM_S390_INITIAL_RESET    _IO(KVMIO,   0x97)
1276 #define KVM_GET_MP_STATE          _IOR(KVMIO,  0x98, struct kvm_mp_state)
1277 #define KVM_SET_MP_STATE          _IOW(KVMIO,  0x99, struct kvm_mp_state)
1278 /* Available with KVM_CAP_USER_NMI */
1279 #define KVM_NMI                   _IO(KVMIO,   0x9a)
1280 /* Available with KVM_CAP_SET_GUEST_DEBUG */
1281 #define KVM_SET_GUEST_DEBUG       _IOW(KVMIO,  0x9b, struct kvm_guest_debug)
1282 /* MCE for x86 */
1283 #define KVM_X86_SETUP_MCE         _IOW(KVMIO,  0x9c, __u64)
1284 #define KVM_X86_GET_MCE_CAP_SUPPORTED _IOR(KVMIO,  0x9d, __u64)
1285 #define KVM_X86_SET_MCE           _IOW(KVMIO,  0x9e, struct kvm_x86_mce)
1286 /* Available with KVM_CAP_VCPU_EVENTS */
1287 #define KVM_GET_VCPU_EVENTS       _IOR(KVMIO,  0x9f, struct kvm_vcpu_events)
1288 #define KVM_SET_VCPU_EVENTS       _IOW(KVMIO,  0xa0, struct kvm_vcpu_events)
1289 /* Available with KVM_CAP_DEBUGREGS */
1290 #define KVM_GET_DEBUGREGS         _IOR(KVMIO,  0xa1, struct kvm_debugregs)
1291 #define KVM_SET_DEBUGREGS         _IOW(KVMIO,  0xa2, struct kvm_debugregs)
1292 /*
1293  * vcpu version available with KVM_CAP_ENABLE_CAP
1294  * vm version available with KVM_CAP_ENABLE_CAP_VM
1295  */
1296 #define KVM_ENABLE_CAP            _IOW(KVMIO,  0xa3, struct kvm_enable_cap)
1297 /* Available with KVM_CAP_XSAVE */
1298 #define KVM_GET_XSAVE		  _IOR(KVMIO,  0xa4, struct kvm_xsave)
1299 #define KVM_SET_XSAVE		  _IOW(KVMIO,  0xa5, struct kvm_xsave)
1300 /* Available with KVM_CAP_XCRS */
1301 #define KVM_GET_XCRS		  _IOR(KVMIO,  0xa6, struct kvm_xcrs)
1302 #define KVM_SET_XCRS		  _IOW(KVMIO,  0xa7, struct kvm_xcrs)
1303 /* Available with KVM_CAP_SW_TLB */
1304 #define KVM_DIRTY_TLB		  _IOW(KVMIO,  0xaa, struct kvm_dirty_tlb)
1305 /* Available with KVM_CAP_ONE_REG */
1306 #define KVM_GET_ONE_REG		  _IOW(KVMIO,  0xab, struct kvm_one_reg)
1307 #define KVM_SET_ONE_REG		  _IOW(KVMIO,  0xac, struct kvm_one_reg)
1308 /* VM is being stopped by host */
1309 #define KVM_KVMCLOCK_CTRL	  _IO(KVMIO,   0xad)
1310 #define KVM_ARM_VCPU_INIT	  _IOW(KVMIO,  0xae, struct kvm_vcpu_init)
1311 #define KVM_ARM_PREFERRED_TARGET  _IOR(KVMIO,  0xaf, struct kvm_vcpu_init)
1312 #define KVM_GET_REG_LIST	  _IOWR(KVMIO, 0xb0, struct kvm_reg_list)
1313 /* Available with KVM_CAP_S390_MEM_OP */
1314 #define KVM_S390_MEM_OP		  _IOW(KVMIO,  0xb1, struct kvm_s390_mem_op)
1315 /* Available with KVM_CAP_S390_SKEYS */
1316 #define KVM_S390_GET_SKEYS      _IOW(KVMIO, 0xb2, struct kvm_s390_skeys)
1317 #define KVM_S390_SET_SKEYS      _IOW(KVMIO, 0xb3, struct kvm_s390_skeys)
1318 /* Available with KVM_CAP_S390_INJECT_IRQ */
1319 #define KVM_S390_IRQ              _IOW(KVMIO,  0xb4, struct kvm_s390_irq)
1320 /* Available with KVM_CAP_S390_IRQ_STATE */
1321 #define KVM_S390_SET_IRQ_STATE	  _IOW(KVMIO, 0xb5, struct kvm_s390_irq_state)
1322 #define KVM_S390_GET_IRQ_STATE	  _IOW(KVMIO, 0xb6, struct kvm_s390_irq_state)
1323 /* Available with KVM_CAP_X86_SMM */
1324 #define KVM_SMI                   _IO(KVMIO,   0xb7)
1325 /* Available with KVM_CAP_S390_CMMA_MIGRATION */
1326 #define KVM_S390_GET_CMMA_BITS      _IOWR(KVMIO, 0xb8, struct kvm_s390_cmma_log)
1327 #define KVM_S390_SET_CMMA_BITS      _IOW(KVMIO, 0xb9, struct kvm_s390_cmma_log)
1328 /* Memory Encryption Commands */
1329 #define KVM_MEMORY_ENCRYPT_OP      _IOWR(KVMIO, 0xba, unsigned long)
1330 
1331 struct kvm_enc_region {
1332 	__u64 addr;
1333 	__u64 size;
1334 };
1335 
1336 #define KVM_MEMORY_ENCRYPT_REG_REGION    _IOR(KVMIO, 0xbb, struct kvm_enc_region)
1337 #define KVM_MEMORY_ENCRYPT_UNREG_REGION  _IOR(KVMIO, 0xbc, struct kvm_enc_region)
1338 
1339 /* Available with KVM_CAP_HYPERV_EVENTFD */
1340 #define KVM_HYPERV_EVENTFD        _IOW(KVMIO,  0xbd, struct kvm_hyperv_eventfd)
1341 
1342 /* Available with KVM_CAP_NESTED_STATE */
1343 #define KVM_GET_NESTED_STATE         _IOWR(KVMIO, 0xbe, struct kvm_nested_state)
1344 #define KVM_SET_NESTED_STATE         _IOW(KVMIO,  0xbf, struct kvm_nested_state)
1345 
1346 /* Available with KVM_CAP_MANUAL_DIRTY_LOG_PROTECT_2 */
1347 #define KVM_CLEAR_DIRTY_LOG          _IOWR(KVMIO, 0xc0, struct kvm_clear_dirty_log)
1348 
1349 /* Available with KVM_CAP_HYPERV_CPUID (vcpu) / KVM_CAP_SYS_HYPERV_CPUID (system) */
1350 #define KVM_GET_SUPPORTED_HV_CPUID _IOWR(KVMIO, 0xc1, struct kvm_cpuid2)
1351 
1352 /* Available with KVM_CAP_ARM_SVE */
1353 #define KVM_ARM_VCPU_FINALIZE	  _IOW(KVMIO,  0xc2, int)
1354 
1355 /* Available with  KVM_CAP_S390_VCPU_RESETS */
1356 #define KVM_S390_NORMAL_RESET	_IO(KVMIO,   0xc3)
1357 #define KVM_S390_CLEAR_RESET	_IO(KVMIO,   0xc4)
1358 
1359 /* Available with KVM_CAP_S390_PROTECTED */
1360 #define KVM_S390_PV_COMMAND		_IOWR(KVMIO, 0xc5, struct kvm_pv_cmd)
1361 
1362 /* Available with KVM_CAP_X86_MSR_FILTER */
1363 #define KVM_X86_SET_MSR_FILTER	_IOW(KVMIO,  0xc6, struct kvm_msr_filter)
1364 
1365 /* Available with KVM_CAP_DIRTY_LOG_RING */
1366 #define KVM_RESET_DIRTY_RINGS		_IO(KVMIO, 0xc7)
1367 
1368 /* Per-VM Xen attributes */
1369 #define KVM_XEN_HVM_GET_ATTR	_IOWR(KVMIO, 0xc8, struct kvm_xen_hvm_attr)
1370 #define KVM_XEN_HVM_SET_ATTR	_IOW(KVMIO,  0xc9, struct kvm_xen_hvm_attr)
1371 
1372 /* Per-vCPU Xen attributes */
1373 #define KVM_XEN_VCPU_GET_ATTR	_IOWR(KVMIO, 0xca, struct kvm_xen_vcpu_attr)
1374 #define KVM_XEN_VCPU_SET_ATTR	_IOW(KVMIO,  0xcb, struct kvm_xen_vcpu_attr)
1375 
1376 /* Available with KVM_CAP_XEN_HVM / KVM_XEN_HVM_CONFIG_EVTCHN_SEND */
1377 #define KVM_XEN_HVM_EVTCHN_SEND	_IOW(KVMIO,  0xd0, struct kvm_irq_routing_xen_evtchn)
1378 
1379 #define KVM_GET_SREGS2             _IOR(KVMIO,  0xcc, struct kvm_sregs2)
1380 #define KVM_SET_SREGS2             _IOW(KVMIO,  0xcd, struct kvm_sregs2)
1381 
1382 #define KVM_DIRTY_LOG_MANUAL_PROTECT_ENABLE    (1 << 0)
1383 #define KVM_DIRTY_LOG_INITIALLY_SET            (1 << 1)
1384 
1385 /*
1386  * Arch needs to define the macro after implementing the dirty ring
1387  * feature.  KVM_DIRTY_LOG_PAGE_OFFSET should be defined as the
1388  * starting page offset of the dirty ring structures.
1389  */
1390 #ifndef KVM_DIRTY_LOG_PAGE_OFFSET
1391 #define KVM_DIRTY_LOG_PAGE_OFFSET 0
1392 #endif
1393 
1394 /*
1395  * KVM dirty GFN flags, defined as:
1396  *
1397  * |---------------+---------------+--------------|
1398  * | bit 1 (reset) | bit 0 (dirty) | Status       |
1399  * |---------------+---------------+--------------|
1400  * |             0 |             0 | Invalid GFN  |
1401  * |             0 |             1 | Dirty GFN    |
1402  * |             1 |             X | GFN to reset |
1403  * |---------------+---------------+--------------|
1404  *
1405  * Lifecycle of a dirty GFN goes like:
1406  *
1407  *      dirtied         harvested        reset
1408  * 00 -----------> 01 -------------> 1X -------+
1409  *  ^                                          |
1410  *  |                                          |
1411  *  +------------------------------------------+
1412  *
1413  * The userspace program is only responsible for the 01->1X state
1414  * conversion after harvesting an entry.  Also, it must not skip any
1415  * dirty bits, so that dirty bits are always harvested in sequence.
1416  */
1417 #define KVM_DIRTY_GFN_F_DIRTY           _BITUL(0)
1418 #define KVM_DIRTY_GFN_F_RESET           _BITUL(1)
1419 #define KVM_DIRTY_GFN_F_MASK            0x3
1420 
1421 /*
1422  * KVM dirty rings should be mapped at KVM_DIRTY_LOG_PAGE_OFFSET of
1423  * per-vcpu mmaped regions as an array of struct kvm_dirty_gfn.  The
1424  * size of the gfn buffer is decided by the first argument when
1425  * enabling KVM_CAP_DIRTY_LOG_RING.
1426  */
1427 struct kvm_dirty_gfn {
1428 	__u32 flags;
1429 	__u32 slot;
1430 	__u64 offset;
1431 };
1432 
1433 #define KVM_BUS_LOCK_DETECTION_OFF             (1 << 0)
1434 #define KVM_BUS_LOCK_DETECTION_EXIT            (1 << 1)
1435 
1436 #define KVM_PMU_CAP_DISABLE                    (1 << 0)
1437 
1438 /**
1439  * struct kvm_stats_header - Header of per vm/vcpu binary statistics data.
1440  * @flags: Some extra information for header, always 0 for now.
1441  * @name_size: The size in bytes of the memory which contains statistics
1442  *             name string including trailing '\0'. The memory is allocated
1443  *             at the send of statistics descriptor.
1444  * @num_desc: The number of statistics the vm or vcpu has.
1445  * @id_offset: The offset of the vm/vcpu stats' id string in the file pointed
1446  *             by vm/vcpu stats fd.
1447  * @desc_offset: The offset of the vm/vcpu stats' descriptor block in the file
1448  *               pointd by vm/vcpu stats fd.
1449  * @data_offset: The offset of the vm/vcpu stats' data block in the file
1450  *               pointed by vm/vcpu stats fd.
1451  *
1452  * This is the header userspace needs to read from stats fd before any other
1453  * readings. It is used by userspace to discover all the information about the
1454  * vm/vcpu's binary statistics.
1455  * Userspace reads this header from the start of the vm/vcpu's stats fd.
1456  */
1457 struct kvm_stats_header {
1458 	__u32 flags;
1459 	__u32 name_size;
1460 	__u32 num_desc;
1461 	__u32 id_offset;
1462 	__u32 desc_offset;
1463 	__u32 data_offset;
1464 };
1465 
1466 #define KVM_STATS_TYPE_SHIFT		0
1467 #define KVM_STATS_TYPE_MASK		(0xF << KVM_STATS_TYPE_SHIFT)
1468 #define KVM_STATS_TYPE_CUMULATIVE	(0x0 << KVM_STATS_TYPE_SHIFT)
1469 #define KVM_STATS_TYPE_INSTANT		(0x1 << KVM_STATS_TYPE_SHIFT)
1470 #define KVM_STATS_TYPE_PEAK		(0x2 << KVM_STATS_TYPE_SHIFT)
1471 #define KVM_STATS_TYPE_LINEAR_HIST	(0x3 << KVM_STATS_TYPE_SHIFT)
1472 #define KVM_STATS_TYPE_LOG_HIST		(0x4 << KVM_STATS_TYPE_SHIFT)
1473 #define KVM_STATS_TYPE_MAX		KVM_STATS_TYPE_LOG_HIST
1474 
1475 #define KVM_STATS_UNIT_SHIFT		4
1476 #define KVM_STATS_UNIT_MASK		(0xF << KVM_STATS_UNIT_SHIFT)
1477 #define KVM_STATS_UNIT_NONE		(0x0 << KVM_STATS_UNIT_SHIFT)
1478 #define KVM_STATS_UNIT_BYTES		(0x1 << KVM_STATS_UNIT_SHIFT)
1479 #define KVM_STATS_UNIT_SECONDS		(0x2 << KVM_STATS_UNIT_SHIFT)
1480 #define KVM_STATS_UNIT_CYCLES		(0x3 << KVM_STATS_UNIT_SHIFT)
1481 #define KVM_STATS_UNIT_BOOLEAN		(0x4 << KVM_STATS_UNIT_SHIFT)
1482 #define KVM_STATS_UNIT_MAX		KVM_STATS_UNIT_BOOLEAN
1483 
1484 #define KVM_STATS_BASE_SHIFT		8
1485 #define KVM_STATS_BASE_MASK		(0xF << KVM_STATS_BASE_SHIFT)
1486 #define KVM_STATS_BASE_POW10		(0x0 << KVM_STATS_BASE_SHIFT)
1487 #define KVM_STATS_BASE_POW2		(0x1 << KVM_STATS_BASE_SHIFT)
1488 #define KVM_STATS_BASE_MAX		KVM_STATS_BASE_POW2
1489 
1490 /**
1491  * struct kvm_stats_desc - Descriptor of a KVM statistics.
1492  * @flags: Annotations of the stats, like type, unit, etc.
1493  * @exponent: Used together with @flags to determine the unit.
1494  * @size: The number of data items for this stats.
1495  *        Every data item is of type __u64.
1496  * @offset: The offset of the stats to the start of stat structure in
1497  *          structure kvm or kvm_vcpu.
1498  * @bucket_size: A parameter value used for histogram stats. It is only used
1499  *		for linear histogram stats, specifying the size of the bucket;
1500  * @name: The name string for the stats. Its size is indicated by the
1501  *        &kvm_stats_header->name_size.
1502  */
1503 struct kvm_stats_desc {
1504 	__u32 flags;
1505 	__s16 exponent;
1506 	__u16 size;
1507 	__u32 offset;
1508 	__u32 bucket_size;
1509 	char name[];
1510 };
1511 
1512 #define KVM_GET_STATS_FD  _IO(KVMIO,  0xce)
1513 
1514 /* Available with KVM_CAP_XSAVE2 */
1515 #define KVM_GET_XSAVE2		  _IOR(KVMIO,  0xcf, struct kvm_xsave)
1516 
1517 /* Available with KVM_CAP_S390_PROTECTED_DUMP */
1518 #define KVM_S390_PV_CPU_COMMAND	_IOWR(KVMIO, 0xd0, struct kvm_pv_cmd)
1519 
1520 /* Available with KVM_CAP_X86_NOTIFY_VMEXIT */
1521 #define KVM_X86_NOTIFY_VMEXIT_ENABLED		(1ULL << 0)
1522 #define KVM_X86_NOTIFY_VMEXIT_USER		(1ULL << 1)
1523 
1524 /* Available with KVM_CAP_S390_ZPCI_OP */
1525 #define KVM_S390_ZPCI_OP         _IOW(KVMIO,  0xd1, struct kvm_s390_zpci_op)
1526 
1527 /* Available with KVM_CAP_MEMORY_ATTRIBUTES */
1528 #define KVM_SET_MEMORY_ATTRIBUTES              _IOW(KVMIO,  0xd2, struct kvm_memory_attributes)
1529 
1530 struct kvm_memory_attributes {
1531 	__u64 address;
1532 	__u64 size;
1533 	__u64 attributes;
1534 	__u64 flags;
1535 };
1536 
1537 #define KVM_MEMORY_ATTRIBUTE_PRIVATE           (1ULL << 3)
1538 
1539 #define KVM_CREATE_GUEST_MEMFD	_IOWR(KVMIO,  0xd4, struct kvm_create_guest_memfd)
1540 
1541 struct kvm_create_guest_memfd {
1542 	__u64 size;
1543 	__u64 flags;
1544 	__u64 reserved[6];
1545 };
1546 
1547 #endif /* __LINUX_KVM_H */
1548