sys/amd64/include/vmm.h

   1 /*-
   2  * Copyright (c) 2011 NetApp, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _VMM_H_
  30 #define _VMM_H_
  31
  32 #include <x86/segments.h>
  33
  34 enum vm_suspend_how {
  35         VM_SUSPEND_NONE,
  36         VM_SUSPEND_RESET,
  37         VM_SUSPEND_POWEROFF,
  38         VM_SUSPEND_HALT,
  39         VM_SUSPEND_TRIPLEFAULT,
  40         VM_SUSPEND_LAST
  41 };
  42
  43 /*
  44  * Identifiers for architecturally defined registers.
  45  */
  46 enum vm_reg_name {
  47         VM_REG_GUEST_RAX,
  48         VM_REG_GUEST_RBX,
  49         VM_REG_GUEST_RCX,
  50         VM_REG_GUEST_RDX,
  51         VM_REG_GUEST_RSI,
  52         VM_REG_GUEST_RDI,
  53         VM_REG_GUEST_RBP,
  54         VM_REG_GUEST_R8,
  55         VM_REG_GUEST_R9,
  56         VM_REG_GUEST_R10,
  57         VM_REG_GUEST_R11,
  58         VM_REG_GUEST_R12,
  59         VM_REG_GUEST_R13,
  60         VM_REG_GUEST_R14,
  61         VM_REG_GUEST_R15,
  62         VM_REG_GUEST_CR0,
  63         VM_REG_GUEST_CR3,
  64         VM_REG_GUEST_CR4,
  65         VM_REG_GUEST_DR7,
  66         VM_REG_GUEST_RSP,
  67         VM_REG_GUEST_RIP,
  68         VM_REG_GUEST_RFLAGS,
  69         VM_REG_GUEST_ES,
  70         VM_REG_GUEST_CS,
  71         VM_REG_GUEST_SS,
  72         VM_REG_GUEST_DS,
  73         VM_REG_GUEST_FS,
  74         VM_REG_GUEST_GS,
  75         VM_REG_GUEST_LDTR,
  76         VM_REG_GUEST_TR,
  77         VM_REG_GUEST_IDTR,
  78         VM_REG_GUEST_GDTR,
  79         VM_REG_GUEST_EFER,
  80         VM_REG_GUEST_CR2,
  81         VM_REG_GUEST_PDPTE0,
  82         VM_REG_GUEST_PDPTE1,
  83         VM_REG_GUEST_PDPTE2,
  84         VM_REG_GUEST_PDPTE3,
  85         VM_REG_GUEST_INTR_SHADOW,
  86         VM_REG_LAST
  87 };
  88
  89 enum x2apic_state {
  90         X2APIC_DISABLED,
  91         X2APIC_ENABLED,
  92         X2APIC_STATE_LAST
  93 };
  94
  95 #define VM_INTINFO_VECTOR(info) ((info) & 0xff)
  96 #define VM_INTINFO_DEL_ERRCODE  0x800
  97 #define VM_INTINFO_RSVD         0x7ffff000
  98 #define VM_INTINFO_VALID        0x80000000
  99 #define VM_INTINFO_TYPE         0x700
 100 #define VM_INTINFO_HWINTR       (0 << 8)
 101 #define VM_INTINFO_NMI          (2 << 8)
 102 #define VM_INTINFO_HWEXCEPTION  (3 << 8)
 103 #define VM_INTINFO_SWINTR       (4 << 8)
 104
 105 #ifdef _KERNEL
 106
 107 #define VM_MAX_NAMELEN  32
 108
 109 struct vm;
 110 struct vm_exception;
 111 struct vm_memory_segment;
 112 struct seg_desc;
 113 struct vm_exit;
 114 struct vm_run;
 115 struct vhpet;
 116 struct vioapic;
 117 struct vlapic;
 118 struct vmspace;
 119 struct vm_object;
 120 struct vm_guest_paging;
 121 struct pmap;
 122
 123 typedef int     (*vmm_init_func_t)(int ipinum);
 124 typedef int     (*vmm_cleanup_func_t)(void);
 125 typedef void    (*vmm_resume_func_t)(void);
 126 typedef void *  (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap);
 127 typedef int     (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip,
 128                                   struct pmap *pmap, void *rendezvous_cookie,
 129                                   void *suspend_cookie);
 130 typedef void    (*vmi_cleanup_func_t)(void *vmi);
 131 typedef int     (*vmi_get_register_t)(void *vmi, int vcpu, int num,
 132                                       uint64_t *retval);
 133 typedef int     (*vmi_set_register_t)(void *vmi, int vcpu, int num,
 134                                       uint64_t val);
 135 typedef int     (*vmi_get_desc_t)(void *vmi, int vcpu, int num,
 136                                   struct seg_desc *desc);
 137 typedef int     (*vmi_set_desc_t)(void *vmi, int vcpu, int num,
 138                                   struct seg_desc *desc);
 139 typedef int     (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval);
 140 typedef int     (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val);
 141 typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max);
 142 typedef void    (*vmi_vmspace_free)(struct vmspace *vmspace);
 143 typedef struct vlapic * (*vmi_vlapic_init)(void *vmi, int vcpu);
 144 typedef void    (*vmi_vlapic_cleanup)(void *vmi, struct vlapic *vlapic);
 145
 146 struct vmm_ops {
 147         vmm_init_func_t         init;           /* module wide initialization */
 148         vmm_cleanup_func_t      cleanup;
 149         vmm_resume_func_t       resume;
 150
 151         vmi_init_func_t         vminit;         /* vm-specific initialization */
 152         vmi_run_func_t          vmrun;
 153         vmi_cleanup_func_t      vmcleanup;
 154         vmi_get_register_t      vmgetreg;
 155         vmi_set_register_t      vmsetreg;
 156         vmi_get_desc_t          vmgetdesc;
 157         vmi_set_desc_t          vmsetdesc;
 158         vmi_get_cap_t           vmgetcap;
 159         vmi_set_cap_t           vmsetcap;
 160         vmi_vmspace_alloc       vmspace_alloc;
 161         vmi_vmspace_free        vmspace_free;
 162         vmi_vlapic_init         vlapic_init;
 163         vmi_vlapic_cleanup      vlapic_cleanup;
 164 };
 165
 166 extern struct vmm_ops vmm_ops_intel;
 167 extern struct vmm_ops vmm_ops_amd;
 168
 169 int vm_create(const char *name, struct vm **retvm);
 170 void vm_destroy(struct vm *vm);
 171 int vm_reinit(struct vm *vm);
 172 const char *vm_name(struct vm *vm);
 173 int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len);
 174 int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
 175 int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len);
 176 void *vm_gpa_hold(struct vm *, vm_paddr_t gpa, size_t len, int prot,
 177                   void **cookie);
 178 void vm_gpa_release(void *cookie);
 179 int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase,
 180               struct vm_memory_segment *seg);
 181 int vm_get_memobj(struct vm *vm, vm_paddr_t gpa, size_t len,
 182                   vm_offset_t *offset, struct vm_object **object);
 183 boolean_t vm_mem_allocated(struct vm *vm, vm_paddr_t gpa);
 184 int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval);
 185 int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val);
 186 int vm_get_seg_desc(struct vm *vm, int vcpu, int reg,
 187                     struct seg_desc *ret_desc);
 188 int vm_set_seg_desc(struct vm *vm, int vcpu, int reg,
 189                     struct seg_desc *desc);
 190 int vm_run(struct vm *vm, struct vm_run *vmrun);
 191 int vm_suspend(struct vm *vm, enum vm_suspend_how how);
 192 int vm_inject_nmi(struct vm *vm, int vcpu);
 193 int vm_nmi_pending(struct vm *vm, int vcpuid);
 194 void vm_nmi_clear(struct vm *vm, int vcpuid);
 195 int vm_inject_extint(struct vm *vm, int vcpu);
 196 int vm_extint_pending(struct vm *vm, int vcpuid);
 197 void vm_extint_clear(struct vm *vm, int vcpuid);
 198 struct vlapic *vm_lapic(struct vm *vm, int cpu);
 199 struct vioapic *vm_ioapic(struct vm *vm);
 200 struct vhpet *vm_hpet(struct vm *vm);
 201 int vm_get_capability(struct vm *vm, int vcpu, int type, int *val);
 202 int vm_set_capability(struct vm *vm, int vcpu, int type, int val);
 203 int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state);
 204 int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state);
 205 int vm_apicid2vcpuid(struct vm *vm, int apicid);
 206 int vm_activate_cpu(struct vm *vm, int vcpu);
 207 cpuset_t vm_active_cpus(struct vm *vm);
 208 cpuset_t vm_suspended_cpus(struct vm *vm);
 209 struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid);
 210 void vm_exit_suspended(struct vm *vm, int vcpuid, uint64_t rip);
 211 void vm_exit_rendezvous(struct vm *vm, int vcpuid, uint64_t rip);
 212 void vm_exit_astpending(struct vm *vm, int vcpuid, uint64_t rip);
 213
 214 /*
 215  * Rendezvous all vcpus specified in 'dest' and execute 'func(arg)'.
 216  * The rendezvous 'func(arg)' is not allowed to do anything that will
 217  * cause the thread to be put to sleep.
 218  *
 219  * If the rendezvous is being initiated from a vcpu context then the
 220  * 'vcpuid' must refer to that vcpu, otherwise it should be set to -1.
 221  *
 222  * The caller cannot hold any locks when initiating the rendezvous.
 223  *
 224  * The implementation of this API may cause vcpus other than those specified
 225  * by 'dest' to be stalled. The caller should not rely on any vcpus making
 226  * forward progress when the rendezvous is in progress.
 227  */
 228 typedef void (*vm_rendezvous_func_t)(struct vm *vm, int vcpuid, void *arg);
 229 void vm_smp_rendezvous(struct vm *vm, int vcpuid, cpuset_t dest,
 230     vm_rendezvous_func_t func, void *arg);
 231
 232 static __inline int
 233 vcpu_rendezvous_pending(void *rendezvous_cookie)
 234 {
 235
 236         return (*(uintptr_t *)rendezvous_cookie != 0);
 237 }
 238
 239 static __inline int
 240 vcpu_suspended(void *suspend_cookie)
 241 {
 242
 243         return (*(int *)suspend_cookie);
 244 }
 245
 246 /*
 247  * Return 1 if device indicated by bus/slot/func is supposed to be a
 248  * pci passthrough device.
 249  *
 250  * Return 0 otherwise.
 251  */
 252 int vmm_is_pptdev(int bus, int slot, int func);
 253
 254 void *vm_iommu_domain(struct vm *vm);
 255
 256 enum vcpu_state {
 257         VCPU_IDLE,
 258         VCPU_FROZEN,
 259         VCPU_RUNNING,
 260         VCPU_SLEEPING,
 261 };
 262
 263 int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state,
 264     bool from_idle);
 265 enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu);
 266
 267 static int __inline
 268 vcpu_is_running(struct vm *vm, int vcpu, int *hostcpu)
 269 {
 270         return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING);
 271 }
 272
 273 #ifdef _SYS_PROC_H_
 274 static int __inline
 275 vcpu_should_yield(struct vm *vm, int vcpu)
 276 {
 277         return (curthread->td_flags & (TDF_ASTPENDING | TDF_NEEDRESCHED));
 278 }
 279 #endif
 280
 281 void *vcpu_stats(struct vm *vm, int vcpu);
 282 void vcpu_notify_event(struct vm *vm, int vcpuid, bool lapic_intr);
 283 struct vmspace *vm_get_vmspace(struct vm *vm);
 284 int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func);
 285 int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func);
 286 struct vatpic *vm_atpic(struct vm *vm);
 287 struct vatpit *vm_atpit(struct vm *vm);
 288 struct vpmtmr *vm_pmtmr(struct vm *vm);
 289
 290 /*
 291  * Inject exception 'vme' into the guest vcpu. This function returns 0 on
 292  * success and non-zero on failure.
 293  *
 294  * Wrapper functions like 'vm_inject_gp()' should be preferred to calling
 295  * this function directly because they enforce the trap-like or fault-like
 296  * behavior of an exception.
 297  *
 298  * This function should only be called in the context of the thread that is
 299  * executing this vcpu.
 300  */
 301 int vm_inject_exception(struct vm *vm, int vcpuid, struct vm_exception *vme);
 302
 303 /*
 304  * This function is called after a VM-exit that occurred during exception or
 305  * interrupt delivery through the IDT. The format of 'intinfo' is described
 306  * in Figure 15-1, "EXITINTINFO for All Intercepts", APM, Vol 2.
 307  *
 308  * If a VM-exit handler completes the event delivery successfully then it
 309  * should call vm_exit_intinfo() to extinguish the pending event. For e.g.,
 310  * if the task switch emulation is triggered via a task gate then it should
 311  * call this function with 'intinfo=0' to indicate that the external event
 312  * is not pending anymore.
 313  *
 314  * Return value is 0 on success and non-zero on failure.
 315  */
 316 int vm_exit_intinfo(struct vm *vm, int vcpuid, uint64_t intinfo);
 317
 318 /*
 319  * This function is called before every VM-entry to retrieve a pending
 320  * event that should be injected into the guest. This function combines
 321  * nested events into a double or triple fault.
 322  *
 323  * Returns 0 if there are no events that need to be injected into the guest
 324  * and non-zero otherwise.
 325  */
 326 int vm_entry_intinfo(struct vm *vm, int vcpuid, uint64_t *info);
 327
 328 int vm_get_intinfo(struct vm *vm, int vcpuid, uint64_t *info1, uint64_t *info2);
 329
 330 enum vm_reg_name vm_segment_name(int seg_encoding);
 331
 332 struct vm_copyinfo {
 333         uint64_t        gpa;
 334         size_t          len;
 335         void            *hva;
 336         void            *cookie;
 337 };
 338
 339 /*
 340  * Set up 'copyinfo[]' to copy to/from guest linear address space starting
 341  * at 'gla' and 'len' bytes long. The 'prot' should be set to PROT_READ for
 342  * a copyin or PROT_WRITE for a copyout.
 343  *
 344  * Returns 0 on success.
 345  * Returns 1 if an exception was injected into the guest.
 346  * Returns -1 otherwise.
 347  *
 348  * The 'copyinfo[]' can be passed to 'vm_copyin()' or 'vm_copyout()' only if
 349  * the return value is 0. The 'copyinfo[]' resources should be freed by calling
 350  * 'vm_copy_teardown()' after the copy is done.
 351  */
 352 int vm_copy_setup(struct vm *vm, int vcpuid, struct vm_guest_paging *paging,
 353     uint64_t gla, size_t len, int prot, struct vm_copyinfo *copyinfo,
 354     int num_copyinfo);
 355 void vm_copy_teardown(struct vm *vm, int vcpuid, struct vm_copyinfo *copyinfo,
 356     int num_copyinfo);
 357 void vm_copyin(struct vm *vm, int vcpuid, struct vm_copyinfo *copyinfo,
 358     void *kaddr, size_t len);
 359 void vm_copyout(struct vm *vm, int vcpuid, const void *kaddr,
 360     struct vm_copyinfo *copyinfo, size_t len);
 361
 362 int vcpu_trace_exceptions(struct vm *vm, int vcpuid);
 363 #endif  /* KERNEL */
 364
 365 #define VM_MAXCPU       16                      /* maximum virtual cpus */
 366
 367 /*
 368  * Identifiers for optional vmm capabilities
 369  */
 370 enum vm_cap_type {
 371         VM_CAP_HALT_EXIT,
 372         VM_CAP_MTRAP_EXIT,
 373         VM_CAP_PAUSE_EXIT,
 374         VM_CAP_UNRESTRICTED_GUEST,
 375         VM_CAP_ENABLE_INVPCID,
 376         VM_CAP_MAX
 377 };
 378
 379 enum vm_intr_trigger {
 380         EDGE_TRIGGER,
 381         LEVEL_TRIGGER
 382 };
 383
 384 /*
 385  * The 'access' field has the format specified in Table 21-2 of the Intel
 386  * Architecture Manual vol 3b.
 387  *
 388  * XXX The contents of the 'access' field are architecturally defined except
 389  * bit 16 - Segment Unusable.
 390  */
 391 struct seg_desc {
 392         uint64_t        base;
 393         uint32_t        limit;
 394         uint32_t        access;
 395 };
 396 #define SEG_DESC_TYPE(access)           ((access) & 0x001f)
 397 #define SEG_DESC_DPL(access)            (((access) >> 5) & 0x3)
 398 #define SEG_DESC_PRESENT(access)        (((access) & 0x0080) ? 1 : 0)
 399 #define SEG_DESC_DEF32(access)          (((access) & 0x4000) ? 1 : 0)
 400 #define SEG_DESC_GRANULARITY(access)    (((access) & 0x8000) ? 1 : 0)
 401 #define SEG_DESC_UNUSABLE(access)       (((access) & 0x10000) ? 1 : 0)
 402
 403 enum vm_cpu_mode {
 404         CPU_MODE_REAL,
 405         CPU_MODE_PROTECTED,
 406         CPU_MODE_COMPATIBILITY,         /* IA-32E mode (CS.L = 0) */
 407         CPU_MODE_64BIT,                 /* IA-32E mode (CS.L = 1) */
 408 };
 409
 410 enum vm_paging_mode {
 411         PAGING_MODE_FLAT,
 412         PAGING_MODE_32,
 413         PAGING_MODE_PAE,
 414         PAGING_MODE_64,
 415 };
 416
 417 struct vm_guest_paging {
 418         uint64_t        cr3;
 419         int             cpl;
 420         enum vm_cpu_mode cpu_mode;
 421         enum vm_paging_mode paging_mode;
 422 };
 423
 424 /*
 425  * The data structures 'vie' and 'vie_op' are meant to be opaque to the
 426  * consumers of instruction decoding. The only reason why their contents
 427  * need to be exposed is because they are part of the 'vm_exit' structure.
 428  */
 429 struct vie_op {
 430         uint8_t         op_byte;        /* actual opcode byte */
 431         uint8_t         op_type;        /* type of operation (e.g. MOV) */
 432         uint16_t        op_flags;
 433 };
 434
 435 #define VIE_INST_SIZE   15
 436 struct vie {
 437         uint8_t         inst[VIE_INST_SIZE];    /* instruction bytes */
 438         uint8_t         num_valid;              /* size of the instruction */
 439         uint8_t         num_processed;
 440
 441         uint8_t         addrsize:4, opsize:4;   /* address and operand sizes */
 442         uint8_t         rex_w:1,                /* REX prefix */
 443                         rex_r:1,
 444                         rex_x:1,
 445                         rex_b:1,
 446                         rex_present:1,
 447                         opsize_override:1,      /* Operand size override */
 448                         addrsize_override:1;    /* Address size override */
 449
 450         uint8_t         mod:2,                  /* ModRM byte */
 451                         reg:4,
 452                         rm:4;
 453
 454         uint8_t         ss:2,                   /* SIB byte */
 455                         index:4,
 456                         base:4;
 457
 458         uint8_t         disp_bytes;
 459         uint8_t         imm_bytes;
 460
 461         uint8_t         scale;
 462         int             base_register;          /* VM_REG_GUEST_xyz */
 463         int             index_register;         /* VM_REG_GUEST_xyz */
 464
 465         int64_t         displacement;           /* optional addr displacement */
 466         int64_t         immediate;              /* optional immediate operand */
 467
 468         uint8_t         decoded;        /* set to 1 if successfully decoded */
 469
 470         struct vie_op   op;                     /* opcode description */
 471 };
 472
 473 enum vm_exitcode {
 474         VM_EXITCODE_INOUT,
 475         VM_EXITCODE_VMX,
 476         VM_EXITCODE_BOGUS,
 477         VM_EXITCODE_RDMSR,
 478         VM_EXITCODE_WRMSR,
 479         VM_EXITCODE_HLT,
 480         VM_EXITCODE_MTRAP,
 481         VM_EXITCODE_PAUSE,
 482         VM_EXITCODE_PAGING,
 483         VM_EXITCODE_INST_EMUL,
 484         VM_EXITCODE_SPINUP_AP,
 485         VM_EXITCODE_DEPRECATED1,        /* used to be SPINDOWN_CPU */
 486         VM_EXITCODE_RENDEZVOUS,
 487         VM_EXITCODE_IOAPIC_EOI,
 488         VM_EXITCODE_SUSPENDED,
 489         VM_EXITCODE_INOUT_STR,
 490         VM_EXITCODE_TASK_SWITCH,
 491         VM_EXITCODE_MONITOR,
 492         VM_EXITCODE_MWAIT,
 493         VM_EXITCODE_SVM,
 494         VM_EXITCODE_MAX
 495 };
 496
 497 struct vm_inout {
 498         uint16_t        bytes:3;        /* 1 or 2 or 4 */
 499         uint16_t        in:1;
 500         uint16_t        string:1;
 501         uint16_t        rep:1;
 502         uint16_t        port;
 503         uint32_t        eax;            /* valid for out */
 504 };
 505
 506 struct vm_inout_str {
 507         struct vm_inout inout;          /* must be the first element */
 508         struct vm_guest_paging paging;
 509         uint64_t        rflags;
 510         uint64_t        cr0;
 511         uint64_t        index;
 512         uint64_t        count;          /* rep=1 (%rcx), rep=0 (1) */
 513         int             addrsize;
 514         enum vm_reg_name seg_name;
 515         struct seg_desc seg_desc;
 516 };
 517
 518 enum task_switch_reason {
 519         TSR_CALL,
 520         TSR_IRET,
 521         TSR_JMP,
 522         TSR_IDT_GATE,   /* task gate in IDT */
 523 };
 524
 525 struct vm_task_switch {
 526         uint16_t        tsssel;         /* new TSS selector */
 527         int             ext;            /* task switch due to external event */
 528         uint32_t        errcode;
 529         int             errcode_valid;  /* push 'errcode' on the new stack */
 530         enum task_switch_reason reason;
 531         struct vm_guest_paging paging;
 532 };
 533
 534 struct vm_exit {
 535         enum vm_exitcode        exitcode;
 536         int                     inst_length;    /* 0 means unknown */
 537         uint64_t                rip;
 538         union {
 539                 struct vm_inout inout;
 540                 struct vm_inout_str inout_str;
 541                 struct {
 542                         uint64_t        gpa;
 543                         int             fault_type;
 544                 } paging;
 545                 struct {
 546                         uint64_t        gpa;
 547                         uint64_t        gla;
 548                         int             cs_d;           /* CS.D */
 549                         struct vm_guest_paging paging;
 550                         struct vie      vie;
 551                 } inst_emul;
 552                 /*
 553                  * VMX specific payload. Used when there is no "better"
 554                  * exitcode to represent the VM-exit.
 555                  */
 556                 struct {
 557                         int             status;         /* vmx inst status */
 558                         /*
 559                          * 'exit_reason' and 'exit_qualification' are valid
 560                          * only if 'status' is zero.
 561                          */
 562                         uint32_t        exit_reason;
 563                         uint64_t        exit_qualification;
 564                         /*
 565                          * 'inst_error' and 'inst_type' are valid
 566                          * only if 'status' is non-zero.
 567                          */
 568                         int             inst_type;
 569                         int             inst_error;
 570                 } vmx;
 571                 /*
 572                  * SVM specific payload.
 573                  */
 574                 struct {
 575                         uint64_t        exitcode;
 576                         uint64_t        exitinfo1;
 577                         uint64_t        exitinfo2;
 578                 } svm;
 579                 struct {
 580                         uint32_t        code;           /* ecx value */
 581                         uint64_t        wval;
 582                 } msr;
 583                 struct {
 584                         int             vcpu;
 585                         uint64_t        rip;
 586                 } spinup_ap;
 587                 struct {
 588                         uint64_t        rflags;
 589                 } hlt;
 590                 struct {
 591                         int             vector;
 592                 } ioapic_eoi;
 593                 struct {
 594                         enum vm_suspend_how how;
 595                 } suspended;
 596                 struct vm_task_switch task_switch;
 597         } u;
 598 };
 599
 600 /* APIs to inject faults into the guest */
 601 void vm_inject_fault(void *vm, int vcpuid, int vector, int errcode_valid,
 602     int errcode);
 603
 604 static __inline void
 605 vm_inject_ud(void *vm, int vcpuid)
 606 {
 607         vm_inject_fault(vm, vcpuid, IDT_UD, 0, 0);
 608 }
 609
 610 static __inline void
 611 vm_inject_gp(void *vm, int vcpuid)
 612 {
 613         vm_inject_fault(vm, vcpuid, IDT_GP, 1, 0);
 614 }
 615
 616 static __inline void
 617 vm_inject_ac(void *vm, int vcpuid, int errcode)
 618 {
 619         vm_inject_fault(vm, vcpuid, IDT_AC, 1, errcode);
 620 }
 621
 622 static __inline void
 623 vm_inject_ss(void *vm, int vcpuid, int errcode)
 624 {
 625         vm_inject_fault(vm, vcpuid, IDT_SS, 1, errcode);
 626 }
 627
 628 void vm_inject_pf(void *vm, int vcpuid, int error_code, uint64_t cr2);
 629
 630 #endif  /* _VMM_H_ */