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 6
  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 #define KVM_EXIT_TYPE_FAIL_ENTRY 1
  38 #define KVM_EXIT_TYPE_VM_EXIT    2
  39
  40 enum kvm_exit_reason {
  41         KVM_EXIT_UNKNOWN          = 0,
  42         KVM_EXIT_EXCEPTION        = 1,
  43         KVM_EXIT_IO               = 2,
  44         KVM_EXIT_DEBUG            = 4,
  45         KVM_EXIT_HLT              = 5,
  46         KVM_EXIT_MMIO             = 6,
  47         KVM_EXIT_IRQ_WINDOW_OPEN  = 7,
  48         KVM_EXIT_SHUTDOWN         = 8,
  49 };
  50
  51 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
  52 struct kvm_run {
  53         /* in */
  54         __u32 emulated;  /* skip current instruction */
  55         __u32 io_completed; /* mmio/pio request completed */
  56         __u8 request_interrupt_window;
  57         __u8 padding1[7];
  58
  59         /* out */
  60         __u32 exit_type;
  61         __u32 exit_reason;
  62         __u32 instruction_length;
  63         __u8 ready_for_interrupt_injection;
  64         __u8 if_flag;
  65         __u16 padding2;
  66
  67         /* in (pre_kvm_run), out (post_kvm_run) */
  68         __u64 cr8;
  69         __u64 apic_base;
  70
  71         union {
  72                 /* KVM_EXIT_UNKNOWN */
  73                 struct {
  74                         __u32 hardware_exit_reason;
  75                 } hw;
  76                 /* KVM_EXIT_EXCEPTION */
  77                 struct {
  78                         __u32 exception;
  79                         __u32 error_code;
  80                 } ex;
  81                 /* KVM_EXIT_IO */
  82                 struct kvm_io {
  83 #define KVM_EXIT_IO_IN  0
  84 #define KVM_EXIT_IO_OUT 1
  85                         __u8 direction;
  86                         __u8 size; /* bytes */
  87                         __u8 string;
  88                         __u8 string_down;
  89                         __u8 rep;
  90                         __u8 pad;
  91                         __u16 port;
  92                         __u64 count;
  93                         union {
  94                                 __u64 address;
  95                                 __u32 value;
  96                         };
  97                 } io;
  98                 struct {
  99                 } debug;
 100                 /* KVM_EXIT_MMIO */
 101                 struct {
 102                         __u64 phys_addr;
 103                         __u8  data[8];
 104                         __u32 len;
 105                         __u8  is_write;
 106                 } mmio;
 107         };
 108 };
 109
 110 /* for KVM_GET_REGS and KVM_SET_REGS */
 111 struct kvm_regs {
 112         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
 113         __u64 rax, rbx, rcx, rdx;
 114         __u64 rsi, rdi, rsp, rbp;
 115         __u64 r8,  r9,  r10, r11;
 116         __u64 r12, r13, r14, r15;
 117         __u64 rip, rflags;
 118 };
 119
 120 struct kvm_segment {
 121         __u64 base;
 122         __u32 limit;
 123         __u16 selector;
 124         __u8  type;
 125         __u8  present, dpl, db, s, l, g, avl;
 126         __u8  unusable;
 127         __u8  padding;
 128 };
 129
 130 struct kvm_dtable {
 131         __u64 base;
 132         __u16 limit;
 133         __u16 padding[3];
 134 };
 135
 136 /* for KVM_GET_SREGS and KVM_SET_SREGS */
 137 struct kvm_sregs {
 138         /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
 139         struct kvm_segment cs, ds, es, fs, gs, ss;
 140         struct kvm_segment tr, ldt;
 141         struct kvm_dtable gdt, idt;
 142         __u64 cr0, cr2, cr3, cr4, cr8;
 143         __u64 efer;
 144         __u64 apic_base;
 145         __u64 interrupt_bitmap[KVM_IRQ_BITMAP_SIZE(__u64)];
 146 };
 147
 148 struct kvm_msr_entry {
 149         __u32 index;
 150         __u32 reserved;
 151         __u64 data;
 152 };
 153
 154 /* for KVM_GET_MSRS and KVM_SET_MSRS */
 155 struct kvm_msrs {
 156         __u32 nmsrs; /* number of msrs in entries */
 157         __u32 pad;
 158
 159         struct kvm_msr_entry entries[0];
 160 };
 161
 162 /* for KVM_GET_MSR_INDEX_LIST */
 163 struct kvm_msr_list {
 164         __u32 nmsrs; /* number of msrs in entries */
 165         __u32 indices[0];
 166 };
 167
 168 /* for KVM_TRANSLATE */
 169 struct kvm_translation {
 170         /* in */
 171         __u64 linear_address;
 172
 173         /* out */
 174         __u64 physical_address;
 175         __u8  valid;
 176         __u8  writeable;
 177         __u8  usermode;
 178         __u8  pad[5];
 179 };
 180
 181 /* for KVM_INTERRUPT */
 182 struct kvm_interrupt {
 183         /* in */
 184         __u32 irq;
 185 };
 186
 187 struct kvm_breakpoint {
 188         __u32 enabled;
 189         __u32 padding;
 190         __u64 address;
 191 };
 192
 193 /* for KVM_DEBUG_GUEST */
 194 struct kvm_debug_guest {
 195         /* int */
 196         __u32 enabled;
 197         __u32 pad;
 198         struct kvm_breakpoint breakpoints[4];
 199         __u32 singlestep;
 200 };
 201
 202 /* for KVM_GET_DIRTY_LOG */
 203 struct kvm_dirty_log {
 204         __u32 slot;
 205         __u32 padding;
 206         union {
 207                 void __user *dirty_bitmap; /* one bit per page */
 208                 __u64 padding;
 209         };
 210 };
 211
 212 struct kvm_cpuid_entry {
 213         __u32 function;
 214         __u32 eax;
 215         __u32 ebx;
 216         __u32 ecx;
 217         __u32 edx;
 218         __u32 padding;
 219 };
 220
 221 /* for KVM_SET_CPUID */
 222 struct kvm_cpuid {
 223         __u32 nent;
 224         __u32 padding;
 225         struct kvm_cpuid_entry entries[0];
 226 };
 227
 228 #define KVMIO 0xAE
 229
 230 /*
 231  * ioctls for /dev/kvm fds:
 232  */
 233 #define KVM_GET_API_VERSION       _IO(KVMIO, 1)
 234 #define KVM_CREATE_VM             _IO(KVMIO, 2) /* returns a VM fd */
 235 #define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 15, struct kvm_msr_list)
 236
 237 /*
 238  * ioctls for VM fds
 239  */
 240 #define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 10, struct kvm_memory_region)
 241 /*
 242  * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
 243  * a vcpu fd.
 244  */
 245 #define KVM_CREATE_VCPU           _IOW(KVMIO, 11, int)
 246 #define KVM_GET_DIRTY_LOG         _IOW(KVMIO, 12, struct kvm_dirty_log)
 247
 248 /*
 249  * ioctls for vcpu fds
 250  */
 251 #define KVM_RUN                   _IO(KVMIO, 16)
 252 #define KVM_GET_REGS              _IOR(KVMIO, 3, struct kvm_regs)
 253 #define KVM_SET_REGS              _IOW(KVMIO, 4, struct kvm_regs)
 254 #define KVM_GET_SREGS             _IOR(KVMIO, 5, struct kvm_sregs)
 255 #define KVM_SET_SREGS             _IOW(KVMIO, 6, struct kvm_sregs)
 256 #define KVM_TRANSLATE             _IOWR(KVMIO, 7, struct kvm_translation)
 257 #define KVM_INTERRUPT             _IOW(KVMIO, 8, struct kvm_interrupt)
 258 #define KVM_DEBUG_GUEST           _IOW(KVMIO, 9, struct kvm_debug_guest)
 259 #define KVM_GET_MSRS              _IOWR(KVMIO, 13, struct kvm_msrs)
 260 #define KVM_SET_MSRS              _IOW(KVMIO, 14, struct kvm_msrs)
 261 #define KVM_SET_CPUID             _IOW(KVMIO, 17, struct kvm_cpuid)
 262
 263 #endif