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