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