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 /* for KVM_GET_IRQCHIP and KVM_SET_IRQCHIP */
  52 struct kvm_pic_state {
  53         __u8 last_irr;  /* edge detection */
  54         __u8 irr;               /* interrupt request register */
  55         __u8 imr;               /* interrupt mask register */
  56         __u8 isr;               /* interrupt service register */
  57         __u8 priority_add;      /* highest irq priority */
  58         __u8 irq_base;
  59         __u8 read_reg_select;
  60         __u8 poll;
  61         __u8 special_mask;
  62         __u8 init_state;
  63         __u8 auto_eoi;
  64         __u8 rotate_on_auto_eoi;
  65         __u8 special_fully_nested_mode;
  66         __u8 init4;             /* true if 4 byte init */
  67         __u8 elcr;              /* PIIX edge/trigger selection */
  68         __u8 elcr_mask;
  69 };
  70
  71 #define KVM_IOAPIC_NUM_PINS  24
  72 struct kvm_ioapic_state {
  73         __u64 base_address;
  74         __u32 ioregsel;
  75         __u32 id;
  76         __u32 irr;
  77         __u32 pad;
  78         union {
  79                 __u64 bits;
  80                 struct {
  81                         __u8 vector;
  82                         __u8 delivery_mode:3;
  83                         __u8 dest_mode:1;
  84                         __u8 delivery_status:1;
  85                         __u8 polarity:1;
  86                         __u8 remote_irr:1;
  87                         __u8 trig_mode:1;
  88                         __u8 mask:1;
  89                         __u8 reserve:7;
  90                         __u8 reserved[4];
  91                         __u8 dest_id;
  92                 } fields;
  93         } redirtbl[KVM_IOAPIC_NUM_PINS];
  94 };
  95
  96 #define KVM_IRQCHIP_PIC_MASTER   0
  97 #define KVM_IRQCHIP_PIC_SLAVE    1
  98 #define KVM_IRQCHIP_IOAPIC       2
  99
 100 struct kvm_irqchip {
 101         __u32 chip_id;
 102         __u32 pad;
 103         union {
 104                 char dummy[512];  /* reserving space */
 105                 struct kvm_pic_state pic;
 106                 struct kvm_ioapic_state ioapic;
 107         } chip;
 108 };
 109
 110 #define KVM_EXIT_UNKNOWN          0
 111 #define KVM_EXIT_EXCEPTION        1
 112 #define KVM_EXIT_IO               2
 113 #define KVM_EXIT_HYPERCALL        3
 114 #define KVM_EXIT_DEBUG            4
 115 #define KVM_EXIT_HLT              5
 116 #define KVM_EXIT_MMIO             6
 117 #define KVM_EXIT_IRQ_WINDOW_OPEN  7
 118 #define KVM_EXIT_SHUTDOWN         8
 119 #define KVM_EXIT_FAIL_ENTRY       9
 120 #define KVM_EXIT_INTR             10
 121 #define KVM_EXIT_SET_TPR          11
 122
 123 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
 124 struct kvm_run {
 125         /* in */
 126         __u8 request_interrupt_window;
 127         __u8 padding1[7];
 128
 129         /* out */
 130         __u32 exit_reason;
 131         __u8 ready_for_interrupt_injection;
 132         __u8 if_flag;
 133         __u8 padding2[2];
 134
 135         /* in (pre_kvm_run), out (post_kvm_run) */
 136         __u64 cr8;
 137         __u64 apic_base;
 138
 139         union {
 140                 /* KVM_EXIT_UNKNOWN */
 141                 struct {
 142                         __u64 hardware_exit_reason;
 143                 } hw;
 144                 /* KVM_EXIT_FAIL_ENTRY */
 145                 struct {
 146                         __u64 hardware_entry_failure_reason;
 147                 } fail_entry;
 148                 /* KVM_EXIT_EXCEPTION */
 149                 struct {
 150                         __u32 exception;
 151                         __u32 error_code;
 152                 } ex;
 153                 /* KVM_EXIT_IO */
 154                 struct kvm_io {
 155 #define KVM_EXIT_IO_IN  0
 156 #define KVM_EXIT_IO_OUT 1
 157                         __u8 direction;
 158                         __u8 size; /* bytes */
 159                         __u16 port;
 160                         __u32 count;
 161                         __u64 data_offset; /* relative to kvm_run start */
 162                 } io;
 163                 struct {
 164                 } debug;
 165                 /* KVM_EXIT_MMIO */
 166                 struct {
 167                         __u64 phys_addr;
 168                         __u8  data[8];
 169                         __u32 len;
 170                         __u8  is_write;
 171                 } mmio;
 172                 /* KVM_EXIT_HYPERCALL */
 173                 struct {
 174                         __u64 nr;
 175                         __u64 args[6];
 176                         __u64 ret;
 177                         __u32 longmode;
 178                         __u32 pad;
 179                 } hypercall;
 180                 /* Fix the size of the union. */
 181                 char padding[256];
 182         };
 183 };
 184
 185 /* for KVM_GET_REGS and KVM_SET_REGS */
 186 struct kvm_regs {
 187         /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
 188         __u64 rax, rbx, rcx, rdx;
 189         __u64 rsi, rdi, rsp, rbp;
 190         __u64 r8,  r9,  r10, r11;
 191         __u64 r12, r13, r14, r15;
 192         __u64 rip, rflags;
 193 };
 194
 195 /* for KVM_GET_FPU and KVM_SET_FPU */
 196 struct kvm_fpu {
 197         __u8  fpr[8][16];
 198         __u16 fcw;
 199         __u16 fsw;
 200         __u8  ftwx;  /* in fxsave format */
 201         __u8  pad1;
 202         __u16 last_opcode;
 203         __u64 last_ip;
 204         __u64 last_dp;
 205         __u8  xmm[16][16];
 206         __u32 mxcsr;
 207         __u32 pad2;
 208 };
 209
 210 /* for KVM_GET_LAPIC and KVM_SET_LAPIC */
 211 #define KVM_APIC_REG_SIZE 0x400
 212 struct kvm_lapic_state {
 213         char regs[KVM_APIC_REG_SIZE];
 214 };
 215
 216 struct kvm_segment {
 217         __u64 base;
 218         __u32 limit;
 219         __u16 selector;
 220         __u8  type;
 221         __u8  present, dpl, db, s, l, g, avl;
 222         __u8  unusable;
 223         __u8  padding;
 224 };
 225
 226 struct kvm_dtable {
 227         __u64 base;
 228         __u16 limit;
 229         __u16 padding[3];
 230 };
 231
 232 /* for KVM_GET_SREGS and KVM_SET_SREGS */
 233 struct kvm_sregs {
 234         /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
 235         struct kvm_segment cs, ds, es, fs, gs, ss;
 236         struct kvm_segment tr, ldt;
 237         struct kvm_dtable gdt, idt;
 238         __u64 cr0, cr2, cr3, cr4, cr8;
 239         __u64 efer;
 240         __u64 apic_base;
 241         __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
 242 };
 243
 244 struct kvm_msr_entry {
 245         __u32 index;
 246         __u32 reserved;
 247         __u64 data;
 248 };
 249
 250 /* for KVM_GET_MSRS and KVM_SET_MSRS */
 251 struct kvm_msrs {
 252         __u32 nmsrs; /* number of msrs in entries */
 253         __u32 pad;
 254
 255         struct kvm_msr_entry entries[0];
 256 };
 257
 258 /* for KVM_GET_MSR_INDEX_LIST */
 259 struct kvm_msr_list {
 260         __u32 nmsrs; /* number of msrs in entries */
 261         __u32 indices[0];
 262 };
 263
 264 /* for KVM_TRANSLATE */
 265 struct kvm_translation {
 266         /* in */
 267         __u64 linear_address;
 268
 269         /* out */
 270         __u64 physical_address;
 271         __u8  valid;
 272         __u8  writeable;
 273         __u8  usermode;
 274         __u8  pad[5];
 275 };
 276
 277 /* for KVM_INTERRUPT */
 278 struct kvm_interrupt {
 279         /* in */
 280         __u32 irq;
 281 };
 282
 283 struct kvm_breakpoint {
 284         __u32 enabled;
 285         __u32 padding;
 286         __u64 address;
 287 };
 288
 289 /* for KVM_DEBUG_GUEST */
 290 struct kvm_debug_guest {
 291         /* int */
 292         __u32 enabled;
 293         __u32 pad;
 294         struct kvm_breakpoint breakpoints[4];
 295         __u32 singlestep;
 296 };
 297
 298 /* for KVM_GET_DIRTY_LOG */
 299 struct kvm_dirty_log {
 300         __u32 slot;
 301         __u32 padding;
 302         union {
 303                 void __user *dirty_bitmap; /* one bit per page */
 304                 __u64 padding;
 305         };
 306 };
 307
 308 struct kvm_cpuid_entry {
 309         __u32 function;
 310         __u32 eax;
 311         __u32 ebx;
 312         __u32 ecx;
 313         __u32 edx;
 314         __u32 padding;
 315 };
 316
 317 /* for KVM_SET_CPUID */
 318 struct kvm_cpuid {
 319         __u32 nent;
 320         __u32 padding;
 321         struct kvm_cpuid_entry entries[0];
 322 };
 323
 324 /* for KVM_SET_SIGNAL_MASK */
 325 struct kvm_signal_mask {
 326         __u32 len;
 327         __u8  sigset[0];
 328 };
 329
 330 #define KVMIO 0xAE
 331
 332 /*
 333  * ioctls for /dev/kvm fds:
 334  */
 335 #define KVM_GET_API_VERSION       _IO(KVMIO,   0x00)
 336 #define KVM_CREATE_VM             _IO(KVMIO,   0x01) /* returns a VM fd */
 337 #define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 0x02, struct kvm_msr_list)
 338 /*
 339  * Check if a kvm extension is available.  Argument is extension number,
 340  * return is 1 (yes) or 0 (no, sorry).
 341  */
 342 #define KVM_CHECK_EXTENSION       _IO(KVMIO,   0x03)
 343 /*
 344  * Get size for mmap(vcpu_fd)
 345  */
 346 #define KVM_GET_VCPU_MMAP_SIZE    _IO(KVMIO,   0x04) /* in bytes */
 347
 348 /*
 349  * Extension capability list.
 350  */
 351 #define KVM_CAP_IRQCHIP   0
 352 #define KVM_CAP_HLT       1
 353 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
 354 #define KVM_CAP_USER_MEMORY 3
 355 #define KVM_CAP_SET_TSS_ADDR 4
 356
 357 /*
 358  * ioctls for VM fds
 359  */
 360 #define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 0x40, struct kvm_memory_region)
 361 #define KVM_SET_NR_MMU_PAGES      _IO(KVMIO, 0x44)
 362 #define KVM_GET_NR_MMU_PAGES      _IO(KVMIO, 0x45)
 363 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
 364                                         struct kvm_userspace_memory_region)
 365 #define KVM_SET_TSS_ADDR          _IO(KVMIO, 0x47)
 366 /*
 367  * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
 368  * a vcpu fd.
 369  */
 370 #define KVM_CREATE_VCPU           _IO(KVMIO,  0x41)
 371 #define KVM_GET_DIRTY_LOG         _IOW(KVMIO, 0x42, struct kvm_dirty_log)
 372 #define KVM_SET_MEMORY_ALIAS      _IOW(KVMIO, 0x43, struct kvm_memory_alias)
 373 /* Device model IOC */
 374 #define KVM_CREATE_IRQCHIP        _IO(KVMIO,  0x60)
 375 #define KVM_IRQ_LINE              _IOW(KVMIO, 0x61, struct kvm_irq_level)
 376 #define KVM_GET_IRQCHIP           _IOWR(KVMIO, 0x62, struct kvm_irqchip)
 377 #define KVM_SET_IRQCHIP           _IOR(KVMIO,  0x63, struct kvm_irqchip)
 378
 379 /*
 380  * ioctls for vcpu fds
 381  */
 382 #define KVM_RUN                   _IO(KVMIO,   0x80)
 383 #define KVM_GET_REGS              _IOR(KVMIO,  0x81, struct kvm_regs)
 384 #define KVM_SET_REGS              _IOW(KVMIO,  0x82, struct kvm_regs)
 385 #define KVM_GET_SREGS             _IOR(KVMIO,  0x83, struct kvm_sregs)
 386 #define KVM_SET_SREGS             _IOW(KVMIO,  0x84, struct kvm_sregs)
 387 #define KVM_TRANSLATE             _IOWR(KVMIO, 0x85, struct kvm_translation)
 388 #define KVM_INTERRUPT             _IOW(KVMIO,  0x86, struct kvm_interrupt)
 389 #define KVM_DEBUG_GUEST           _IOW(KVMIO,  0x87, struct kvm_debug_guest)
 390 #define KVM_GET_MSRS              _IOWR(KVMIO, 0x88, struct kvm_msrs)
 391 #define KVM_SET_MSRS              _IOW(KVMIO,  0x89, struct kvm_msrs)
 392 #define KVM_SET_CPUID             _IOW(KVMIO,  0x8a, struct kvm_cpuid)
 393 #define KVM_SET_SIGNAL_MASK       _IOW(KVMIO,  0x8b, struct kvm_signal_mask)
 394 #define KVM_GET_FPU               _IOR(KVMIO,  0x8c, struct kvm_fpu)
 395 #define KVM_SET_FPU               _IOW(KVMIO,  0x8d, struct kvm_fpu)
 396 #define KVM_GET_LAPIC             _IOR(KVMIO,  0x8e, struct kvm_lapic_state)
 397 #define KVM_SET_LAPIC             _IOW(KVMIO,  0x8f, struct kvm_lapic_state)
 398
 399 #endif