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: you must update KVM_API_VERSION if you change this interface.
   8  */
   9
  10 #include <asm/types.h>
  11 #include <linux/ioctl.h>
  12 #include <asm/kvm.h>
  13
  14 #define KVM_API_VERSION 12
  15
  16 /* Architectural interrupt line count. */
  17 #define KVM_NR_INTERRUPTS 256
  18
  19 /* for KVM_CREATE_MEMORY_REGION */
  20 struct kvm_memory_region {
  21         __u32 slot;
  22         __u32 flags;
  23         __u64 guest_phys_addr;
  24         __u64 memory_size; /* bytes */
  25 };
  26
  27 /* for KVM_SET_USER_MEMORY_REGION */
  28 struct kvm_userspace_memory_region {
  29         __u32 slot;
  30         __u32 flags;
  31         __u64 guest_phys_addr;
  32         __u64 memory_size; /* bytes */
  33         __u64 userspace_addr; /* start of the userspace allocated memory */
  34 };
  35
  36 /* for kvm_memory_region::flags */
  37 #define KVM_MEM_LOG_DIRTY_PAGES  1UL
  38
  39
  40 /* for KVM_IRQ_LINE */
  41 struct kvm_irq_level {
  42         /*
  43          * ACPI gsi notion of irq.
  44          * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
  45          * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
  46          */
  47         __u32 irq;
  48         __u32 level;
  49 };
  50
  51
  52 struct kvm_irqchip {
  53         __u32 chip_id;
  54         __u32 pad;
  55         union {
  56                 char dummy[512];  /* reserving space */
  57                 struct kvm_pic_state pic;
  58                 struct kvm_ioapic_state ioapic;
  59         } chip;
  60 };
  61
  62 #define KVM_EXIT_UNKNOWN          0
  63 #define KVM_EXIT_EXCEPTION        1
  64 #define KVM_EXIT_IO               2
  65 #define KVM_EXIT_HYPERCALL        3
  66 #define KVM_EXIT_DEBUG            4
  67 #define KVM_EXIT_HLT              5
  68 #define KVM_EXIT_MMIO             6
  69 #define KVM_EXIT_IRQ_WINDOW_OPEN  7
  70 #define KVM_EXIT_SHUTDOWN         8
  71 #define KVM_EXIT_FAIL_ENTRY       9
  72 #define KVM_EXIT_INTR             10
  73 #define KVM_EXIT_SET_TPR          11
  74
  75 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
  76 struct kvm_run {
  77         /* in */
  78         __u8 request_interrupt_window;
  79         __u8 padding1[7];
  80
  81         /* out */
  82         __u32 exit_reason;
  83         __u8 ready_for_interrupt_injection;
  84         __u8 if_flag;
  85         __u8 padding2[2];
  86
  87         /* in (pre_kvm_run), out (post_kvm_run) */
  88         __u64 cr8;
  89         __u64 apic_base;
  90
  91         union {
  92                 /* KVM_EXIT_UNKNOWN */
  93                 struct {
  94                         __u64 hardware_exit_reason;
  95                 } hw;
  96                 /* KVM_EXIT_FAIL_ENTRY */
  97                 struct {
  98                         __u64 hardware_entry_failure_reason;
  99                 } fail_entry;
 100                 /* KVM_EXIT_EXCEPTION */
 101                 struct {
 102                         __u32 exception;
 103                         __u32 error_code;
 104                 } ex;
 105                 /* KVM_EXIT_IO */
 106                 struct kvm_io {
 107 #define KVM_EXIT_IO_IN  0
 108 #define KVM_EXIT_IO_OUT 1
 109                         __u8 direction;
 110                         __u8 size; /* bytes */
 111                         __u16 port;
 112                         __u32 count;
 113                         __u64 data_offset; /* relative to kvm_run start */
 114                 } io;
 115                 struct {
 116                 } debug;
 117                 /* KVM_EXIT_MMIO */
 118                 struct {
 119                         __u64 phys_addr;
 120                         __u8  data[8];
 121                         __u32 len;
 122                         __u8  is_write;
 123                 } mmio;
 124                 /* KVM_EXIT_HYPERCALL */
 125                 struct {
 126                         __u64 nr;
 127                         __u64 args[6];
 128                         __u64 ret;
 129                         __u32 longmode;
 130                         __u32 pad;
 131                 } hypercall;
 132                 /* Fix the size of the union. */
 133                 char padding[256];
 134         };
 135 };
 136
 137 /* for KVM_GET_REGS and KVM_SET_REGS */
 138 struct kvm_regs {
 139         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
 140         __u64 rax, rbx, rcx, rdx;
 141         __u64 rsi, rdi, rsp, rbp;
 142         __u64 r8,  r9,  r10, r11;
 143         __u64 r12, r13, r14, r15;
 144         __u64 rip, rflags;
 145 };
 146
 147 /* for KVM_GET_FPU and KVM_SET_FPU */
 148 struct kvm_fpu {
 149         __u8  fpr[8][16];
 150         __u16 fcw;
 151         __u16 fsw;
 152         __u8  ftwx;  /* in fxsave format */
 153         __u8  pad1;
 154         __u16 last_opcode;
 155         __u64 last_ip;
 156         __u64 last_dp;
 157         __u8  xmm[16][16];
 158         __u32 mxcsr;
 159         __u32 pad2;
 160 };
 161
 162 /* for KVM_GET_LAPIC and KVM_SET_LAPIC */
 163 #define KVM_APIC_REG_SIZE 0x400
 164 struct kvm_lapic_state {
 165         char regs[KVM_APIC_REG_SIZE];
 166 };
 167
 168 struct kvm_segment {
 169         __u64 base;
 170         __u32 limit;
 171         __u16 selector;
 172         __u8  type;
 173         __u8  present, dpl, db, s, l, g, avl;
 174         __u8  unusable;
 175         __u8  padding;
 176 };
 177
 178 struct kvm_dtable {
 179         __u64 base;
 180         __u16 limit;
 181         __u16 padding[3];
 182 };
 183
 184 /* for KVM_GET_SREGS and KVM_SET_SREGS */
 185 struct kvm_sregs {
 186         /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
 187         struct kvm_segment cs, ds, es, fs, gs, ss;
 188         struct kvm_segment tr, ldt;
 189         struct kvm_dtable gdt, idt;
 190         __u64 cr0, cr2, cr3, cr4, cr8;
 191         __u64 efer;
 192         __u64 apic_base;
 193         __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
 194 };
 195
 196 struct kvm_msr_entry {
 197         __u32 index;
 198         __u32 reserved;
 199         __u64 data;
 200 };
 201
 202 /* for KVM_GET_MSRS and KVM_SET_MSRS */
 203 struct kvm_msrs {
 204         __u32 nmsrs; /* number of msrs in entries */
 205         __u32 pad;
 206
 207         struct kvm_msr_entry entries[0];
 208 };
 209
 210 /* for KVM_GET_MSR_INDEX_LIST */
 211 struct kvm_msr_list {
 212         __u32 nmsrs; /* number of msrs in entries */
 213         __u32 indices[0];
 214 };
 215
 216 /* for KVM_TRANSLATE */
 217 struct kvm_translation {
 218         /* in */
 219         __u64 linear_address;
 220
 221         /* out */
 222         __u64 physical_address;
 223         __u8  valid;
 224         __u8  writeable;
 225         __u8  usermode;
 226         __u8  pad[5];
 227 };
 228
 229 /* for KVM_INTERRUPT */
 230 struct kvm_interrupt {
 231         /* in */
 232         __u32 irq;
 233 };
 234
 235 struct kvm_breakpoint {
 236         __u32 enabled;
 237         __u32 padding;
 238         __u64 address;
 239 };
 240
 241 /* for KVM_DEBUG_GUEST */
 242 struct kvm_debug_guest {
 243         /* int */
 244         __u32 enabled;
 245         __u32 pad;
 246         struct kvm_breakpoint breakpoints[4];
 247         __u32 singlestep;
 248 };
 249
 250 /* for KVM_GET_DIRTY_LOG */
 251 struct kvm_dirty_log {
 252         __u32 slot;
 253         __u32 padding;
 254         union {
 255                 void __user *dirty_bitmap; /* one bit per page */
 256                 __u64 padding;
 257         };
 258 };
 259
 260 struct kvm_cpuid_entry {
 261         __u32 function;
 262         __u32 eax;
 263         __u32 ebx;
 264         __u32 ecx;
 265         __u32 edx;
 266         __u32 padding;
 267 };
 268
 269 /* for KVM_SET_CPUID */
 270 struct kvm_cpuid {
 271         __u32 nent;
 272         __u32 padding;
 273         struct kvm_cpuid_entry entries[0];
 274 };
 275
 276 /* for KVM_SET_SIGNAL_MASK */
 277 struct kvm_signal_mask {
 278         __u32 len;
 279         __u8  sigset[0];
 280 };
 281
 282 #define KVMIO 0xAE
 283
 284 /*
 285  * ioctls for /dev/kvm fds:
 286  */
 287 #define KVM_GET_API_VERSION       _IO(KVMIO,   0x00)
 288 #define KVM_CREATE_VM             _IO(KVMIO,   0x01) /* returns a VM fd */
 289 #define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 0x02, struct kvm_msr_list)
 290 /*
 291  * Check if a kvm extension is available.  Argument is extension number,
 292  * return is 1 (yes) or 0 (no, sorry).
 293  */
 294 #define KVM_CHECK_EXTENSION       _IO(KVMIO,   0x03)
 295 /*
 296  * Get size for mmap(vcpu_fd)
 297  */
 298 #define KVM_GET_VCPU_MMAP_SIZE    _IO(KVMIO,   0x04) /* in bytes */
 299
 300 /*
 301  * Extension capability list.
 302  */
 303 #define KVM_CAP_IRQCHIP   0
 304 #define KVM_CAP_HLT       1
 305 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
 306 #define KVM_CAP_USER_MEMORY 3
 307 #define KVM_CAP_SET_TSS_ADDR 4
 308
 309 /*
 310  * ioctls for VM fds
 311  */
 312 #define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 0x40, struct kvm_memory_region)
 313 #define KVM_SET_NR_MMU_PAGES      _IO(KVMIO, 0x44)
 314 #define KVM_GET_NR_MMU_PAGES      _IO(KVMIO, 0x45)
 315 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
 316                                         struct kvm_userspace_memory_region)
 317 #define KVM_SET_TSS_ADDR          _IO(KVMIO, 0x47)
 318 /*
 319  * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
 320  * a vcpu fd.
 321  */
 322 #define KVM_CREATE_VCPU           _IO(KVMIO,  0x41)
 323 #define KVM_GET_DIRTY_LOG         _IOW(KVMIO, 0x42, struct kvm_dirty_log)
 324 #define KVM_SET_MEMORY_ALIAS      _IOW(KVMIO, 0x43, struct kvm_memory_alias)
 325 /* Device model IOC */
 326 #define KVM_CREATE_IRQCHIP        _IO(KVMIO,  0x60)
 327 #define KVM_IRQ_LINE              _IOW(KVMIO, 0x61, struct kvm_irq_level)
 328 #define KVM_GET_IRQCHIP           _IOWR(KVMIO, 0x62, struct kvm_irqchip)
 329 #define KVM_SET_IRQCHIP           _IOR(KVMIO,  0x63, struct kvm_irqchip)
 330
 331 /*
 332  * ioctls for vcpu fds
 333  */
 334 #define KVM_RUN                   _IO(KVMIO,   0x80)
 335 #define KVM_GET_REGS              _IOR(KVMIO,  0x81, struct kvm_regs)
 336 #define KVM_SET_REGS              _IOW(KVMIO,  0x82, struct kvm_regs)
 337 #define KVM_GET_SREGS             _IOR(KVMIO,  0x83, struct kvm_sregs)
 338 #define KVM_SET_SREGS             _IOW(KVMIO,  0x84, struct kvm_sregs)
 339 #define KVM_TRANSLATE             _IOWR(KVMIO, 0x85, struct kvm_translation)
 340 #define KVM_INTERRUPT             _IOW(KVMIO,  0x86, struct kvm_interrupt)
 341 #define KVM_DEBUG_GUEST           _IOW(KVMIO,  0x87, struct kvm_debug_guest)
 342 #define KVM_GET_MSRS              _IOWR(KVMIO, 0x88, struct kvm_msrs)
 343 #define KVM_SET_MSRS              _IOW(KVMIO,  0x89, struct kvm_msrs)
 344 #define KVM_SET_CPUID             _IOW(KVMIO,  0x8a, struct kvm_cpuid)
 345 #define KVM_SET_SIGNAL_MASK       _IOW(KVMIO,  0x8b, struct kvm_signal_mask)
 346 #define KVM_GET_FPU               _IOR(KVMIO,  0x8c, struct kvm_fpu)
 347 #define KVM_SET_FPU               _IOW(KVMIO,  0x8d, struct kvm_fpu)
 348 #define KVM_GET_LAPIC             _IOR(KVMIO,  0x8e, struct kvm_lapic_state)
 349 #define KVM_SET_LAPIC             _IOW(KVMIO,  0x8f, struct kvm_lapic_state)
 350
 351 #endif