include/linux/kvm.h

   1 #ifndef __LINUX_KVM_H
   2 #define __LINUX_KVM_H
   3
   4 /*
   5  * Userspace interface for /dev/kvm - kernel based virtual machine
   6  *
   7  * Note: this interface is considered experimental and may change without
   8  *       notice.
   9  */
  10
  11 #include <asm/types.h>
  12 #include <linux/ioctl.h>
  13
  14 #define KVM_API_VERSION 9
  15
  16 /*
  17  * Architectural interrupt line count, and the size of the bitmap needed
  18  * to hold them.
  19  */
  20 #define KVM_NR_INTERRUPTS 256
  21 #define KVM_IRQ_BITMAP_SIZE_BYTES    ((KVM_NR_INTERRUPTS + 7) / 8)
  22 #define KVM_IRQ_BITMAP_SIZE(type)    (KVM_IRQ_BITMAP_SIZE_BYTES / sizeof(type))
  23
  24
  25 /* for KVM_CREATE_MEMORY_REGION */
  26 struct kvm_memory_region {
  27         __u32 slot;
  28         __u32 flags;
  29         __u64 guest_phys_addr;
  30         __u64 memory_size; /* bytes */
  31 };
  32
  33 /* for kvm_memory_region::flags */
  34 #define KVM_MEM_LOG_DIRTY_PAGES  1UL
  35
  36
  37 enum kvm_exit_reason {
  38         KVM_EXIT_UNKNOWN          = 0,
  39         KVM_EXIT_EXCEPTION        = 1,
  40         KVM_EXIT_IO               = 2,
  41         KVM_EXIT_HYPERCALL        = 3,
  42         KVM_EXIT_DEBUG            = 4,
  43         KVM_EXIT_HLT              = 5,
  44         KVM_EXIT_MMIO             = 6,
  45         KVM_EXIT_IRQ_WINDOW_OPEN  = 7,
  46         KVM_EXIT_SHUTDOWN         = 8,
  47         KVM_EXIT_FAIL_ENTRY       = 9,
  48         KVM_EXIT_INTR             = 10,
  49 };
  50
  51 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
  52 struct kvm_run {
  53         /* in */
  54         __u32 io_completed; /* mmio/pio request completed */
  55         __u8 request_interrupt_window;
  56         __u8 padding1[3];
  57
  58         /* out */
  59         __u32 exit_reason;
  60         __u32 instruction_length;
  61         __u8 ready_for_interrupt_injection;
  62         __u8 if_flag;
  63         __u8 padding2[6];
  64
  65         /* in (pre_kvm_run), out (post_kvm_run) */
  66         __u64 cr8;
  67         __u64 apic_base;
  68
  69         union {
  70                 /* KVM_EXIT_UNKNOWN */
  71                 struct {
  72                         __u64 hardware_exit_reason;
  73                 } hw;
  74                 /* KVM_EXIT_FAIL_ENTRY */
  75                 struct {
  76                         __u64 hardware_entry_failure_reason;
  77                 } fail_entry;
  78                 /* KVM_EXIT_EXCEPTION */
  79                 struct {
  80                         __u32 exception;
  81                         __u32 error_code;
  82                 } ex;
  83                 /* KVM_EXIT_IO */
  84                 struct kvm_io {
  85 #define KVM_EXIT_IO_IN  0
  86 #define KVM_EXIT_IO_OUT 1
  87                         __u8 direction;
  88                         __u8 size; /* bytes */
  89                         __u16 port;
  90                         __u32 count;
  91                         __u64 data_offset; /* relative to kvm_run start */
  92                 } io;
  93                 struct {
  94                 } debug;
  95                 /* KVM_EXIT_MMIO */
  96                 struct {
  97                         __u64 phys_addr;
  98                         __u8  data[8];
  99                         __u32 len;
 100                         __u8  is_write;
 101                 } mmio;
 102                 /* KVM_EXIT_HYPERCALL */
 103                 struct {
 104                         __u64 args[6];
 105                         __u64 ret;
 106                         __u32 longmode;
 107                         __u32 pad;
 108                 } hypercall;
 109         };
 110 };
 111
 112 /* for KVM_GET_REGS and KVM_SET_REGS */
 113 struct kvm_regs {
 114         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
 115         __u64 rax, rbx, rcx, rdx;
 116         __u64 rsi, rdi, rsp, rbp;
 117         __u64 r8,  r9,  r10, r11;
 118         __u64 r12, r13, r14, r15;
 119         __u64 rip, rflags;
 120 };
 121
 122 struct kvm_segment {
 123         __u64 base;
 124         __u32 limit;
 125         __u16 selector;
 126         __u8  type;
 127         __u8  present, dpl, db, s, l, g, avl;
 128         __u8  unusable;
 129         __u8  padding;
 130 };
 131
 132 struct kvm_dtable {
 133         __u64 base;
 134         __u16 limit;
 135         __u16 padding[3];
 136 };
 137
 138 /* for KVM_GET_SREGS and KVM_SET_SREGS */
 139 struct kvm_sregs {
 140         /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
 141         struct kvm_segment cs, ds, es, fs, gs, ss;
 142         struct kvm_segment tr, ldt;
 143         struct kvm_dtable gdt, idt;
 144         __u64 cr0, cr2, cr3, cr4, cr8;
 145         __u64 efer;
 146         __u64 apic_base;
 147         __u64 interrupt_bitmap[KVM_IRQ_BITMAP_SIZE(__u64)];
 148 };
 149
 150 struct kvm_msr_entry {
 151         __u32 index;
 152         __u32 reserved;
 153         __u64 data;
 154 };
 155
 156 /* for KVM_GET_MSRS and KVM_SET_MSRS */
 157 struct kvm_msrs {
 158         __u32 nmsrs; /* number of msrs in entries */
 159         __u32 pad;
 160
 161         struct kvm_msr_entry entries[0];
 162 };
 163
 164 /* for KVM_GET_MSR_INDEX_LIST */
 165 struct kvm_msr_list {
 166         __u32 nmsrs; /* number of msrs in entries */
 167         __u32 indices[0];
 168 };
 169
 170 /* for KVM_TRANSLATE */
 171 struct kvm_translation {
 172         /* in */
 173         __u64 linear_address;
 174
 175         /* out */
 176         __u64 physical_address;
 177         __u8  valid;
 178         __u8  writeable;
 179         __u8  usermode;
 180         __u8  pad[5];
 181 };
 182
 183 /* for KVM_INTERRUPT */
 184 struct kvm_interrupt {
 185         /* in */
 186         __u32 irq;
 187 };
 188
 189 struct kvm_breakpoint {
 190         __u32 enabled;
 191         __u32 padding;
 192         __u64 address;
 193 };
 194
 195 /* for KVM_DEBUG_GUEST */
 196 struct kvm_debug_guest {
 197         /* int */
 198         __u32 enabled;
 199         __u32 pad;
 200         struct kvm_breakpoint breakpoints[4];
 201         __u32 singlestep;
 202 };
 203
 204 /* for KVM_GET_DIRTY_LOG */
 205 struct kvm_dirty_log {
 206         __u32 slot;
 207         __u32 padding;
 208         union {
 209                 void __user *dirty_bitmap; /* one bit per page */
 210                 __u64 padding;
 211         };
 212 };
 213
 214 struct kvm_cpuid_entry {
 215         __u32 function;
 216         __u32 eax;
 217         __u32 ebx;
 218         __u32 ecx;
 219         __u32 edx;
 220         __u32 padding;
 221 };
 222
 223 /* for KVM_SET_CPUID */
 224 struct kvm_cpuid {
 225         __u32 nent;
 226         __u32 padding;
 227         struct kvm_cpuid_entry entries[0];
 228 };
 229
 230 /* for KVM_SET_SIGNAL_MASK */
 231 struct kvm_signal_mask {
 232         __u32 len;
 233         __u8  sigset[0];
 234 };
 235
 236 #define KVMIO 0xAE
 237
 238 /*
 239  * ioctls for /dev/kvm fds:
 240  */
 241 #define KVM_GET_API_VERSION       _IO(KVMIO,   0x00)
 242 #define KVM_CREATE_VM             _IO(KVMIO,   0x01) /* returns a VM fd */
 243 #define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 0x02, struct kvm_msr_list)
 244 /*
 245  * Check if a kvm extension is available.  Argument is extension number,
 246  * return is 1 (yes) or 0 (no, sorry).
 247  */
 248 #define KVM_CHECK_EXTENSION       _IO(KVMIO,   0x03)
 249 /*
 250  * Get size for mmap(vcpu_fd)
 251  */
 252 #define KVM_GET_VCPU_MMAP_SIZE    _IO(KVMIO,   0x04) /* in bytes */
 253
 254 /*
 255  * ioctls for VM fds
 256  */
 257 #define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 0x40, struct kvm_memory_region)
 258 /*
 259  * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
 260  * a vcpu fd.
 261  */
 262 #define KVM_CREATE_VCPU           _IO(KVMIO,  0x41)
 263 #define KVM_GET_DIRTY_LOG         _IOW(KVMIO, 0x42, struct kvm_dirty_log)
 264
 265 /*
 266  * ioctls for vcpu fds
 267  */
 268 #define KVM_RUN                   _IO(KVMIO,   0x80)
 269 #define KVM_GET_REGS              _IOR(KVMIO,  0x81, struct kvm_regs)
 270 #define KVM_SET_REGS              _IOW(KVMIO,  0x82, struct kvm_regs)
 271 #define KVM_GET_SREGS             _IOR(KVMIO,  0x83, struct kvm_sregs)
 272 #define KVM_SET_SREGS             _IOW(KVMIO,  0x84, struct kvm_sregs)
 273 #define KVM_TRANSLATE             _IOWR(KVMIO, 0x85, struct kvm_translation)
 274 #define KVM_INTERRUPT             _IOW(KVMIO,  0x86, struct kvm_interrupt)
 275 #define KVM_DEBUG_GUEST           _IOW(KVMIO,  0x87, struct kvm_debug_guest)
 276 #define KVM_GET_MSRS              _IOWR(KVMIO, 0x88, struct kvm_msrs)
 277 #define KVM_SET_MSRS              _IOW(KVMIO,  0x89, struct kvm_msrs)
 278 #define KVM_SET_CPUID             _IOW(KVMIO,  0x8a, struct kvm_cpuid)
 279 #define KVM_SET_SIGNAL_MASK       _IOW(KVMIO,  0x8b, struct kvm_signal_mask)
 280
 281 #endif