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