kvm.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443
  1. #ifndef __LINUX_KVM_H
  2. #define __LINUX_KVM_H
  3. /*
  4. * Userspace interface for /dev/kvm - kernel based virtual machine
  5. *
  6. * Note: you must update KVM_API_VERSION if you change this interface.
  7. */
  8. #include <asm/types.h>
  9. #include <linux/compiler.h>
  10. #include <linux/ioctl.h>
  11. #include <asm/kvm.h>
  12. #define KVM_API_VERSION 12
  13. /* for KVM_TRACE_ENABLE */
  14. struct kvm_user_trace_setup {
  15. __u32 buf_size; /* sub_buffer size of each per-cpu */
  16. __u32 buf_nr; /* the number of sub_buffers of each per-cpu */
  17. };
  18. /* for KVM_CREATE_MEMORY_REGION */
  19. struct kvm_memory_region {
  20. __u32 slot;
  21. __u32 flags;
  22. __u64 guest_phys_addr;
  23. __u64 memory_size; /* bytes */
  24. };
  25. /* for KVM_SET_USER_MEMORY_REGION */
  26. struct kvm_userspace_memory_region {
  27. __u32 slot;
  28. __u32 flags;
  29. __u64 guest_phys_addr;
  30. __u64 memory_size; /* bytes */
  31. __u64 userspace_addr; /* start of the userspace allocated memory */
  32. };
  33. /* for kvm_memory_region::flags */
  34. #define KVM_MEM_LOG_DIRTY_PAGES 1UL
  35. /* for KVM_IRQ_LINE */
  36. struct kvm_irq_level {
  37. /*
  38. * ACPI gsi notion of irq.
  39. * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
  40. * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
  41. */
  42. __u32 irq;
  43. __u32 level;
  44. };
  45. struct kvm_irqchip {
  46. __u32 chip_id;
  47. __u32 pad;
  48. union {
  49. char dummy[512]; /* reserving space */
  50. #ifdef CONFIG_X86
  51. struct kvm_pic_state pic;
  52. #endif
  53. #if defined(CONFIG_X86) || defined(CONFIG_IA64)
  54. struct kvm_ioapic_state ioapic;
  55. #endif
  56. } chip;
  57. };
  58. #define KVM_EXIT_UNKNOWN 0
  59. #define KVM_EXIT_EXCEPTION 1
  60. #define KVM_EXIT_IO 2
  61. #define KVM_EXIT_HYPERCALL 3
  62. #define KVM_EXIT_DEBUG 4
  63. #define KVM_EXIT_HLT 5
  64. #define KVM_EXIT_MMIO 6
  65. #define KVM_EXIT_IRQ_WINDOW_OPEN 7
  66. #define KVM_EXIT_SHUTDOWN 8
  67. #define KVM_EXIT_FAIL_ENTRY 9
  68. #define KVM_EXIT_INTR 10
  69. #define KVM_EXIT_SET_TPR 11
  70. #define KVM_EXIT_TPR_ACCESS 12
  71. #define KVM_EXIT_S390_SIEIC 13
  72. #define KVM_EXIT_S390_RESET 14
  73. #define KVM_EXIT_DCR 15
  74. /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
  75. struct kvm_run {
  76. /* in */
  77. __u8 request_interrupt_window;
  78. __u8 padding1[7];
  79. /* out */
  80. __u32 exit_reason;
  81. __u8 ready_for_interrupt_injection;
  82. __u8 if_flag;
  83. __u8 padding2[2];
  84. /* in (pre_kvm_run), out (post_kvm_run) */
  85. __u64 cr8;
  86. __u64 apic_base;
  87. union {
  88. /* KVM_EXIT_UNKNOWN */
  89. struct {
  90. __u64 hardware_exit_reason;
  91. } hw;
  92. /* KVM_EXIT_FAIL_ENTRY */
  93. struct {
  94. __u64 hardware_entry_failure_reason;
  95. } fail_entry;
  96. /* KVM_EXIT_EXCEPTION */
  97. struct {
  98. __u32 exception;
  99. __u32 error_code;
  100. } ex;
  101. /* KVM_EXIT_IO */
  102. struct kvm_io {
  103. #define KVM_EXIT_IO_IN 0
  104. #define KVM_EXIT_IO_OUT 1
  105. __u8 direction;
  106. __u8 size; /* bytes */
  107. __u16 port;
  108. __u32 count;
  109. __u64 data_offset; /* relative to kvm_run start */
  110. } io;
  111. struct {
  112. } debug;
  113. /* KVM_EXIT_MMIO */
  114. struct {
  115. __u64 phys_addr;
  116. __u8 data[8];
  117. __u32 len;
  118. __u8 is_write;
  119. } mmio;
  120. /* KVM_EXIT_HYPERCALL */
  121. struct {
  122. __u64 nr;
  123. __u64 args[6];
  124. __u64 ret;
  125. __u32 longmode;
  126. __u32 pad;
  127. } hypercall;
  128. /* KVM_EXIT_TPR_ACCESS */
  129. struct {
  130. __u64 rip;
  131. __u32 is_write;
  132. __u32 pad;
  133. } tpr_access;
  134. /* KVM_EXIT_S390_SIEIC */
  135. struct {
  136. __u8 icptcode;
  137. __u64 mask; /* psw upper half */
  138. __u64 addr; /* psw lower half */
  139. __u16 ipa;
  140. __u32 ipb;
  141. } s390_sieic;
  142. /* KVM_EXIT_S390_RESET */
  143. #define KVM_S390_RESET_POR 1
  144. #define KVM_S390_RESET_CLEAR 2
  145. #define KVM_S390_RESET_SUBSYSTEM 4
  146. #define KVM_S390_RESET_CPU_INIT 8
  147. #define KVM_S390_RESET_IPL 16
  148. __u64 s390_reset_flags;
  149. /* KVM_EXIT_DCR */
  150. struct {
  151. __u32 dcrn;
  152. __u32 data;
  153. __u8 is_write;
  154. } dcr;
  155. /* Fix the size of the union. */
  156. char padding[256];
  157. };
  158. };
  159. /* for KVM_REGISTER_COALESCED_MMIO / KVM_UNREGISTER_COALESCED_MMIO */
  160. struct kvm_coalesced_mmio_zone {
  161. __u64 addr;
  162. __u32 size;
  163. __u32 pad;
  164. };
  165. struct kvm_coalesced_mmio {
  166. __u64 phys_addr;
  167. __u32 len;
  168. __u32 pad;
  169. __u8 data[8];
  170. };
  171. struct kvm_coalesced_mmio_ring {
  172. __u32 first, last;
  173. struct kvm_coalesced_mmio coalesced_mmio[0];
  174. };
  175. #define KVM_COALESCED_MMIO_MAX \
  176. ((PAGE_SIZE - sizeof(struct kvm_coalesced_mmio_ring)) / \
  177. sizeof(struct kvm_coalesced_mmio))
  178. /* for KVM_TRANSLATE */
  179. struct kvm_translation {
  180. /* in */
  181. __u64 linear_address;
  182. /* out */
  183. __u64 physical_address;
  184. __u8 valid;
  185. __u8 writeable;
  186. __u8 usermode;
  187. __u8 pad[5];
  188. };
  189. /* for KVM_INTERRUPT */
  190. struct kvm_interrupt {
  191. /* in */
  192. __u32 irq;
  193. };
  194. struct kvm_breakpoint {
  195. __u32 enabled;
  196. __u32 padding;
  197. __u64 address;
  198. };
  199. /* for KVM_DEBUG_GUEST */
  200. struct kvm_debug_guest {
  201. /* int */
  202. __u32 enabled;
  203. __u32 pad;
  204. struct kvm_breakpoint breakpoints[4];
  205. __u32 singlestep;
  206. };
  207. /* for KVM_GET_DIRTY_LOG */
  208. struct kvm_dirty_log {
  209. __u32 slot;
  210. __u32 padding;
  211. union {
  212. void __user *dirty_bitmap; /* one bit per page */
  213. __u64 padding;
  214. };
  215. };
  216. /* for KVM_SET_SIGNAL_MASK */
  217. struct kvm_signal_mask {
  218. __u32 len;
  219. __u8 sigset[0];
  220. };
  221. /* for KVM_TPR_ACCESS_REPORTING */
  222. struct kvm_tpr_access_ctl {
  223. __u32 enabled;
  224. __u32 flags;
  225. __u32 reserved[8];
  226. };
  227. /* for KVM_SET_VAPIC_ADDR */
  228. struct kvm_vapic_addr {
  229. __u64 vapic_addr;
  230. };
  231. /* for KVM_SET_MPSTATE */
  232. #define KVM_MP_STATE_RUNNABLE 0
  233. #define KVM_MP_STATE_UNINITIALIZED 1
  234. #define KVM_MP_STATE_INIT_RECEIVED 2
  235. #define KVM_MP_STATE_HALTED 3
  236. #define KVM_MP_STATE_SIPI_RECEIVED 4
  237. struct kvm_mp_state {
  238. __u32 mp_state;
  239. };
  240. struct kvm_s390_psw {
  241. __u64 mask;
  242. __u64 addr;
  243. };
  244. /* valid values for type in kvm_s390_interrupt */
  245. #define KVM_S390_SIGP_STOP 0xfffe0000u
  246. #define KVM_S390_PROGRAM_INT 0xfffe0001u
  247. #define KVM_S390_SIGP_SET_PREFIX 0xfffe0002u
  248. #define KVM_S390_RESTART 0xfffe0003u
  249. #define KVM_S390_INT_VIRTIO 0xffff2603u
  250. #define KVM_S390_INT_SERVICE 0xffff2401u
  251. #define KVM_S390_INT_EMERGENCY 0xffff1201u
  252. struct kvm_s390_interrupt {
  253. __u32 type;
  254. __u32 parm;
  255. __u64 parm64;
  256. };
  257. #define KVM_TRC_SHIFT 16
  258. /*
  259. * kvm trace categories
  260. */
  261. #define KVM_TRC_ENTRYEXIT (1 << KVM_TRC_SHIFT)
  262. #define KVM_TRC_HANDLER (1 << (KVM_TRC_SHIFT + 1)) /* only 12 bits */
  263. /*
  264. * kvm trace action
  265. */
  266. #define KVM_TRC_VMENTRY (KVM_TRC_ENTRYEXIT + 0x01)
  267. #define KVM_TRC_VMEXIT (KVM_TRC_ENTRYEXIT + 0x02)
  268. #define KVM_TRC_PAGE_FAULT (KVM_TRC_HANDLER + 0x01)
  269. #define KVM_TRC_HEAD_SIZE 12
  270. #define KVM_TRC_CYCLE_SIZE 8
  271. #define KVM_TRC_EXTRA_MAX 7
  272. /* This structure represents a single trace buffer record. */
  273. struct kvm_trace_rec {
  274. __u32 event:28;
  275. __u32 extra_u32:3;
  276. __u32 cycle_in:1;
  277. __u32 pid;
  278. __u32 vcpu_id;
  279. union {
  280. struct {
  281. __u64 cycle_u64;
  282. __u32 extra_u32[KVM_TRC_EXTRA_MAX];
  283. } __attribute__((packed)) cycle;
  284. struct {
  285. __u32 extra_u32[KVM_TRC_EXTRA_MAX];
  286. } nocycle;
  287. } u;
  288. };
  289. #define KVMIO 0xAE
  290. /*
  291. * ioctls for /dev/kvm fds:
  292. */
  293. #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
  294. #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
  295. #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
  296. #define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
  297. /*
  298. * Check if a kvm extension is available. Argument is extension number,
  299. * return is 1 (yes) or 0 (no, sorry).
  300. */
  301. #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
  302. /*
  303. * Get size for mmap(vcpu_fd)
  304. */
  305. #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
  306. #define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
  307. /*
  308. * ioctls for kvm trace
  309. */
  310. #define KVM_TRACE_ENABLE _IOW(KVMIO, 0x06, struct kvm_user_trace_setup)
  311. #define KVM_TRACE_PAUSE _IO(KVMIO, 0x07)
  312. #define KVM_TRACE_DISABLE _IO(KVMIO, 0x08)
  313. /*
  314. * Extension capability list.
  315. */
  316. #define KVM_CAP_IRQCHIP 0
  317. #define KVM_CAP_HLT 1
  318. #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
  319. #define KVM_CAP_USER_MEMORY 3
  320. #define KVM_CAP_SET_TSS_ADDR 4
  321. #define KVM_CAP_VAPIC 6
  322. #define KVM_CAP_EXT_CPUID 7
  323. #define KVM_CAP_CLOCKSOURCE 8
  324. #define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
  325. #define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
  326. #define KVM_CAP_PIT 11
  327. #define KVM_CAP_NOP_IO_DELAY 12
  328. #define KVM_CAP_PV_MMU 13
  329. #define KVM_CAP_MP_STATE 14
  330. #define KVM_CAP_COALESCED_MMIO 15
  331. #define KVM_CAP_SYNC_MMU 16 /* Changes to host mmap are reflected in guest */
  332. /*
  333. * ioctls for VM fds
  334. */
  335. #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
  336. #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
  337. #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
  338. #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
  339. struct kvm_userspace_memory_region)
  340. #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
  341. /*
  342. * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
  343. * a vcpu fd.
  344. */
  345. #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
  346. #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
  347. #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
  348. /* Device model IOC */
  349. #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
  350. #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
  351. #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
  352. #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
  353. #define KVM_CREATE_PIT _IO(KVMIO, 0x64)
  354. #define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
  355. #define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
  356. #define KVM_REGISTER_COALESCED_MMIO \
  357. _IOW(KVMIO, 0x67, struct kvm_coalesced_mmio_zone)
  358. #define KVM_UNREGISTER_COALESCED_MMIO \
  359. _IOW(KVMIO, 0x68, struct kvm_coalesced_mmio_zone)
  360. /*
  361. * ioctls for vcpu fds
  362. */
  363. #define KVM_RUN _IO(KVMIO, 0x80)
  364. #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
  365. #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
  366. #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
  367. #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
  368. #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
  369. #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
  370. #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
  371. #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
  372. #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
  373. #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
  374. #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
  375. #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
  376. #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
  377. #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
  378. #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
  379. #define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
  380. #define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
  381. /* Available with KVM_CAP_VAPIC */
  382. #define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
  383. /* Available with KVM_CAP_VAPIC */
  384. #define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
  385. /* valid for virtual machine (for floating interrupt)_and_ vcpu */
  386. #define KVM_S390_INTERRUPT _IOW(KVMIO, 0x94, struct kvm_s390_interrupt)
  387. /* store status for s390 */
  388. #define KVM_S390_STORE_STATUS_NOADDR (-1ul)
  389. #define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
  390. #define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
  391. /* initial ipl psw for s390 */
  392. #define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
  393. /* initial reset for s390 */
  394. #define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)
  395. #define KVM_GET_MP_STATE _IOR(KVMIO, 0x98, struct kvm_mp_state)
  396. #define KVM_SET_MP_STATE _IOW(KVMIO, 0x99, struct kvm_mp_state)
  397. #endif