vmm.h revision 277360
150276Speter/*-
2176187Srafan * Copyright (c) 2011 NetApp, Inc.
350276Speter * All rights reserved.
450276Speter *
550276Speter * Redistribution and use in source and binary forms, with or without
650276Speter * modification, are permitted provided that the following conditions
750276Speter * are met:
850276Speter * 1. Redistributions of source code must retain the above copyright
950276Speter *    notice, this list of conditions and the following disclaimer.
1050276Speter * 2. Redistributions in binary form must reproduce the above copyright
1150276Speter *    notice, this list of conditions and the following disclaimer in the
1250276Speter *    documentation and/or other materials provided with the distribution.
1350276Speter *
1450276Speter * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
1550276Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1650276Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1750276Speter * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
1850276Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1950276Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2050276Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2150276Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2250276Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2350276Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2450276Speter * SUCH DAMAGE.
2550276Speter *
2650276Speter * $FreeBSD: head/sys/amd64/include/vmm.h 277360 2015-01-19 06:53:31Z neel $
2750276Speter */
2850276Speter
2950276Speter#ifndef _VMM_H_
3050276Speter#define	_VMM_H_
3150276Speter
32174993Srafan#include <x86/segments.h>
3350276Speter
3450276Speterenum vm_suspend_how {
3550276Speter	VM_SUSPEND_NONE,
3650276Speter	VM_SUSPEND_RESET,
3750276Speter	VM_SUSPEND_POWEROFF,
3850276Speter	VM_SUSPEND_HALT,
3950276Speter	VM_SUSPEND_TRIPLEFAULT,
4050276Speter	VM_SUSPEND_LAST
4150276Speter};
4250276Speter
4362449Speter/*
4450276Speter * Identifiers for architecturally defined registers.
4550276Speter */
4666963Speterenum vm_reg_name {
4750276Speter	VM_REG_GUEST_RAX,
4850276Speter	VM_REG_GUEST_RBX,
4950276Speter	VM_REG_GUEST_RCX,
50166124Srafan	VM_REG_GUEST_RDX,
51166124Srafan	VM_REG_GUEST_RSI,
52166124Srafan	VM_REG_GUEST_RDI,
53166124Srafan	VM_REG_GUEST_RBP,
5462449Speter	VM_REG_GUEST_R8,
5550276Speter	VM_REG_GUEST_R9,
56184989Srafan	VM_REG_GUEST_R10,
5750276Speter	VM_REG_GUEST_R11,
5850276Speter	VM_REG_GUEST_R12,
5950276Speter	VM_REG_GUEST_R13,
6050276Speter	VM_REG_GUEST_R14,
6150276Speter	VM_REG_GUEST_R15,
6250276Speter	VM_REG_GUEST_CR0,
6350276Speter	VM_REG_GUEST_CR3,
6450276Speter	VM_REG_GUEST_CR4,
6550276Speter	VM_REG_GUEST_DR7,
6650276Speter	VM_REG_GUEST_RSP,
6750276Speter	VM_REG_GUEST_RIP,
6850276Speter	VM_REG_GUEST_RFLAGS,
6950276Speter	VM_REG_GUEST_ES,
7050276Speter	VM_REG_GUEST_CS,
7150276Speter	VM_REG_GUEST_SS,
7250276Speter	VM_REG_GUEST_DS,
7350276Speter	VM_REG_GUEST_FS,
7450276Speter	VM_REG_GUEST_GS,
7550276Speter	VM_REG_GUEST_LDTR,
7650276Speter	VM_REG_GUEST_TR,
7750276Speter	VM_REG_GUEST_IDTR,
7850276Speter	VM_REG_GUEST_GDTR,
7950276Speter	VM_REG_GUEST_EFER,
80166124Srafan	VM_REG_GUEST_CR2,
81166124Srafan	VM_REG_GUEST_PDPTE0,
82166124Srafan	VM_REG_GUEST_PDPTE1,
83166124Srafan	VM_REG_GUEST_PDPTE2,
8450276Speter	VM_REG_GUEST_PDPTE3,
8550276Speter	VM_REG_GUEST_INTR_SHADOW,
8650276Speter	VM_REG_LAST
8750276Speter};
8850276Speter
8950276Speterenum x2apic_state {
9050276Speter	X2APIC_DISABLED,
9150276Speter	X2APIC_ENABLED,
9250276Speter	X2APIC_STATE_LAST
9350276Speter};
9450276Speter
9550276Speter#define	VM_INTINFO_VECTOR(info)	((info) & 0xff)
9650276Speter#define	VM_INTINFO_DEL_ERRCODE	0x800
9750276Speter#define	VM_INTINFO_RSVD		0x7ffff000
9850276Speter#define	VM_INTINFO_VALID	0x80000000
9950276Speter#define	VM_INTINFO_TYPE		0x700
10050276Speter#define	VM_INTINFO_HWINTR	(0 << 8)
10150276Speter#define	VM_INTINFO_NMI		(2 << 8)
102176187Srafan#define	VM_INTINFO_HWEXCEPTION	(3 << 8)
103184989Srafan#define	VM_INTINFO_SWINTR	(4 << 8)
104184989Srafan
105184989Srafan#ifdef _KERNEL
106184989Srafan
107184989Srafan#define	VM_MAX_NAMELEN	32
108184989Srafan
109176187Srafanstruct vm;
110176187Srafanstruct vm_exception;
111174993Srafanstruct vm_memory_segment;
112174993Srafanstruct seg_desc;
113174993Srafanstruct vm_exit;
114174993Srafanstruct vm_run;
115174993Srafanstruct vhpet;
116174993Srafanstruct vioapic;
117174993Srafanstruct vlapic;
118184989Srafanstruct vmspace;
119184989Srafanstruct vm_object;
120184989Srafanstruct vm_guest_paging;
121184989Srafanstruct pmap;
122184989Srafan
123174993Srafantypedef int	(*vmm_init_func_t)(int ipinum);
124174993Srafantypedef int	(*vmm_cleanup_func_t)(void);
125174993Srafantypedef void	(*vmm_resume_func_t)(void);
126184989Srafantypedef void *	(*vmi_init_func_t)(struct vm *vm, struct pmap *pmap);
127174993Srafantypedef int	(*vmi_run_func_t)(void *vmi, int vcpu, register_t rip,
128184989Srafan				  struct pmap *pmap, void *rendezvous_cookie,
129184989Srafan				  void *suspend_cookie);
130184989Srafantypedef void	(*vmi_cleanup_func_t)(void *vmi);
131184989Srafantypedef int	(*vmi_get_register_t)(void *vmi, int vcpu, int num,
132184989Srafan				      uint64_t *retval);
133174993Srafantypedef int	(*vmi_set_register_t)(void *vmi, int vcpu, int num,
134174993Srafan				      uint64_t val);
135174993Srafantypedef int	(*vmi_get_desc_t)(void *vmi, int vcpu, int num,
136184989Srafan				  struct seg_desc *desc);
137174993Srafantypedef int	(*vmi_set_desc_t)(void *vmi, int vcpu, int num,
138174993Srafan				  struct seg_desc *desc);
139174993Srafantypedef int	(*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval);
140174993Srafantypedef int	(*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val);
141174993Srafantypedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max);
142174993Srafantypedef void	(*vmi_vmspace_free)(struct vmspace *vmspace);
143174993Srafantypedef struct vlapic * (*vmi_vlapic_init)(void *vmi, int vcpu);
144166124Srafantypedef void	(*vmi_vlapic_cleanup)(void *vmi, struct vlapic *vlapic);
145166124Srafan
146166124Srafanstruct vmm_ops {
147166124Srafan	vmm_init_func_t		init;		/* module wide initialization */
148174993Srafan	vmm_cleanup_func_t	cleanup;
149166124Srafan	vmm_resume_func_t	resume;
150176187Srafan
151176187Srafan	vmi_init_func_t		vminit;		/* vm-specific initialization */
152176187Srafan	vmi_run_func_t		vmrun;
153176187Srafan	vmi_cleanup_func_t	vmcleanup;
154176187Srafan	vmi_get_register_t	vmgetreg;
155176187Srafan	vmi_set_register_t	vmsetreg;
156176187Srafan	vmi_get_desc_t		vmgetdesc;
157176187Srafan	vmi_set_desc_t		vmsetdesc;
158176187Srafan	vmi_get_cap_t		vmgetcap;
159176187Srafan	vmi_set_cap_t		vmsetcap;
160176187Srafan	vmi_vmspace_alloc	vmspace_alloc;
161176187Srafan	vmi_vmspace_free	vmspace_free;
162176187Srafan	vmi_vlapic_init		vlapic_init;
163176187Srafan	vmi_vlapic_cleanup	vlapic_cleanup;
164176187Srafan};
165176187Srafan
166176187Srafanextern struct vmm_ops vmm_ops_intel;
167176187Srafanextern struct vmm_ops vmm_ops_amd;
168166124Srafan
169174993Srafanint vm_create(const char *name, struct vm **retvm);
170174993Srafanvoid vm_destroy(struct vm *vm);
171174993Srafanint vm_reinit(struct vm *vm);
172174993Srafanconst char *vm_name(struct vm *vm);
173178866Srafanint vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len);
174166124Srafanint vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
175166124Srafanint vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len);
17650276Spetervoid *vm_gpa_hold(struct vm *, vm_paddr_t gpa, size_t len, int prot,
177174993Srafan		  void **cookie);
178174993Srafanvoid vm_gpa_release(void *cookie);
179174993Srafanint vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase,
180178866Srafan	      struct vm_memory_segment *seg);
181174993Srafanint vm_get_memobj(struct vm *vm, vm_paddr_t gpa, size_t len,
182166124Srafan		  vm_offset_t *offset, struct vm_object **object);
183166124Srafanboolean_t vm_mem_allocated(struct vm *vm, vm_paddr_t gpa);
184166124Srafanint vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval);
185178866Srafanint vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val);
186166124Srafanint vm_get_seg_desc(struct vm *vm, int vcpu, int reg,
187166124Srafan		    struct seg_desc *ret_desc);
188166124Srafanint vm_set_seg_desc(struct vm *vm, int vcpu, int reg,
189166124Srafan		    struct seg_desc *desc);
19076726Speterint vm_run(struct vm *vm, struct vm_run *vmrun);
19162449Speterint vm_suspend(struct vm *vm, enum vm_suspend_how how);
19250276Speterint vm_inject_nmi(struct vm *vm, int vcpu);
19397049Speterint vm_nmi_pending(struct vm *vm, int vcpuid);
194174993Srafanvoid vm_nmi_clear(struct vm *vm, int vcpuid);
19597049Speterint vm_inject_extint(struct vm *vm, int vcpu);
19650276Speterint vm_extint_pending(struct vm *vm, int vcpuid);
19750276Spetervoid vm_extint_clear(struct vm *vm, int vcpuid);
198174993Srafanstruct vlapic *vm_lapic(struct vm *vm, int cpu);
199178866Srafanstruct vioapic *vm_ioapic(struct vm *vm);
20050276Speterstruct vhpet *vm_hpet(struct vm *vm);
20150276Speterint vm_get_capability(struct vm *vm, int vcpu, int type, int *val);
202184989Srafanint vm_set_capability(struct vm *vm, int vcpu, int type, int val);
203174993Srafanint vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state);
204174993Srafanint vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state);
20562449Speterint vm_apicid2vcpuid(struct vm *vm, int apicid);
20662449Speterint vm_activate_cpu(struct vm *vm, int vcpu);
20750276Spetercpuset_t vm_active_cpus(struct vm *vm);
208174993Srafancpuset_t vm_suspended_cpus(struct vm *vm);
20962449Speterstruct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid);
21062449Spetervoid vm_exit_suspended(struct vm *vm, int vcpuid, uint64_t rip);
21162449Spetervoid vm_exit_rendezvous(struct vm *vm, int vcpuid, uint64_t rip);
21262449Spetervoid vm_exit_astpending(struct vm *vm, int vcpuid, uint64_t rip);
21350276Speter
21462449Speter/*
21550276Speter * Rendezvous all vcpus specified in 'dest' and execute 'func(arg)'.
21662449Speter * The rendezvous 'func(arg)' is not allowed to do anything that will
21762449Speter * cause the thread to be put to sleep.
21862449Speter *
21962449Speter * If the rendezvous is being initiated from a vcpu context then the
22062449Speter * 'vcpuid' must refer to that vcpu, otherwise it should be set to -1.
22162449Speter *
22262449Speter * The caller cannot hold any locks when initiating the rendezvous.
22362449Speter *
22450276Speter * The implementation of this API may cause vcpus other than those specified
22550276Speter * by 'dest' to be stalled. The caller should not rely on any vcpus making
22662449Speter * forward progress when the rendezvous is in progress.
22762449Speter */
22862449Spetertypedef void (*vm_rendezvous_func_t)(struct vm *vm, int vcpuid, void *arg);
22962449Spetervoid vm_smp_rendezvous(struct vm *vm, int vcpuid, cpuset_t dest,
23062449Speter    vm_rendezvous_func_t func, void *arg);
23162449Speter
23276726Speterstatic __inline int
23362449Spetervcpu_rendezvous_pending(void *rendezvous_cookie)
23450276Speter{
23550276Speter
23662449Speter	return (*(uintptr_t *)rendezvous_cookie != 0);
23762449Speter}
23862449Speter
23962449Speterstatic __inline int
24050276Spetervcpu_suspended(void *suspend_cookie)
24162449Speter{
24262449Speter
24362449Speter	return (*(int *)suspend_cookie);
24462449Speter}
24562449Speter
24662449Speter/*
24762449Speter * Return 1 if device indicated by bus/slot/func is supposed to be a
24850276Speter * pci passthrough device.
24962449Speter *
25062449Speter * Return 0 otherwise.
25162449Speter */
25262449Speterint vmm_is_pptdev(int bus, int slot, int func);
25362449Speter
254178866Srafanvoid *vm_iommu_domain(struct vm *vm);
25562449Speter
25662449Speterenum vcpu_state {
25750276Speter	VCPU_IDLE,
25862449Speter	VCPU_FROZEN,
25962449Speter	VCPU_RUNNING,
26062449Speter	VCPU_SLEEPING,
26150276Speter};
26250276Speter
26362449Speterint vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state,
26476726Speter    bool from_idle);
26576726Speterenum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu);
26676726Speter
26776726Speterstatic int __inline
26876726Spetervcpu_is_running(struct vm *vm, int vcpu, int *hostcpu)
26976726Speter{
27050276Speter	return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING);
27162449Speter}
27297049Speter
27362449Speter#ifdef _SYS_PROC_H_
27497049Speterstatic int __inline
27597049Spetervcpu_should_yield(struct vm *vm, int vcpu)
27662449Speter{
27750276Speter	return (curthread->td_flags & (TDF_ASTPENDING | TDF_NEEDRESCHED));
27850276Speter}
27962449Speter#endif
28062449Speter
28162449Spetervoid *vcpu_stats(struct vm *vm, int vcpu);
28262449Spetervoid vcpu_notify_event(struct vm *vm, int vcpuid, bool lapic_intr);
28362449Speterstruct vmspace *vm_get_vmspace(struct vm *vm);
28462449Speterint vm_assign_pptdev(struct vm *vm, int bus, int slot, int func);
28562449Speterint vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func);
28650276Speterstruct vatpic *vm_atpic(struct vm *vm);
28762449Speterstruct vatpit *vm_atpit(struct vm *vm);
28850276Speterstruct vpmtmr *vm_pmtmr(struct vm *vm);
28962449Speterstruct vrtc *vm_rtc(struct vm *vm);
290174993Srafan
29162449Speter/*
292174993Srafan * Inject exception 'vector' into the guest vcpu. This function returns 0 on
293174993Srafan * success and non-zero on failure.
294174993Srafan *
295178866Srafan * Wrapper functions like 'vm_inject_gp()' should be preferred to calling
296178866Srafan * this function directly because they enforce the trap-like or fault-like
297174993Srafan * behavior of an exception.
298174993Srafan *
299174993Srafan * This function should only be called in the context of the thread that is
30062449Speter * executing this vcpu.
30150276Speter */
30250276Speterint vm_inject_exception(struct vm *vm, int vcpuid, int vector, int err_valid,
30350276Speter    uint32_t errcode, int restart_instruction);
30476726Speter
305178866Srafan/*
30650276Speter * This function is called after a VM-exit that occurred during exception or
307184989Srafan * interrupt delivery through the IDT. The format of 'intinfo' is described
308166124Srafan * in Figure 15-1, "EXITINTINFO for All Intercepts", APM, Vol 2.
309166124Srafan *
310166124Srafan * If a VM-exit handler completes the event delivery successfully then it
311166124Srafan * should call vm_exit_intinfo() to extinguish the pending event. For e.g.,
31250276Speter * if the task switch emulation is triggered via a task gate then it should
313178866Srafan * call this function with 'intinfo=0' to indicate that the external event
314166124Srafan * is not pending anymore.
315166124Srafan *
316166124Srafan * Return value is 0 on success and non-zero on failure.
317166124Srafan */
318166124Srafanint vm_exit_intinfo(struct vm *vm, int vcpuid, uint64_t intinfo);
319166124Srafan
320178866Srafan/*
321178866Srafan * This function is called before every VM-entry to retrieve a pending
322166124Srafan * event that should be injected into the guest. This function combines
323178866Srafan * nested events into a double or triple fault.
324178866Srafan *
325166124Srafan * Returns 0 if there are no events that need to be injected into the guest
32650276Speter * and non-zero otherwise.
32750276Speter */
32850276Speterint vm_entry_intinfo(struct vm *vm, int vcpuid, uint64_t *info);
32950276Speter
33050276Speterint vm_get_intinfo(struct vm *vm, int vcpuid, uint64_t *info1, uint64_t *info2);
33150276Speter
33250276Speterenum vm_reg_name vm_segment_name(int seg_encoding);
33350276Speter
33450276Speterstruct vm_copyinfo {
33550276Speter	uint64_t	gpa;
33650276Speter	size_t		len;
33750276Speter	void		*hva;
33850276Speter	void		*cookie;
33950276Speter};
34050276Speter
34150276Speter/*
34250276Speter * Set up 'copyinfo[]' to copy to/from guest linear address space starting
34350276Speter * at 'gla' and 'len' bytes long. The 'prot' should be set to PROT_READ for
34450276Speter * a copyin or PROT_WRITE for a copyout.
34550276Speter *
34650276Speter * Returns 0 on success.
34750276Speter * Returns 1 if an exception was injected into the guest.
34850276Speter * Returns -1 otherwise.
34950276Speter *
35050276Speter * The 'copyinfo[]' can be passed to 'vm_copyin()' or 'vm_copyout()' only if
35197049Speter * the return value is 0. The 'copyinfo[]' resources should be freed by calling
352166124Srafan * 'vm_copy_teardown()' after the copy is done.
353166124Srafan */
354166124Srafanint vm_copy_setup(struct vm *vm, int vcpuid, struct vm_guest_paging *paging,
355166124Srafan    uint64_t gla, size_t len, int prot, struct vm_copyinfo *copyinfo,
35662449Speter    int num_copyinfo);
357166124Srafanvoid vm_copy_teardown(struct vm *vm, int vcpuid, struct vm_copyinfo *copyinfo,
35850276Speter    int num_copyinfo);
35962449Spetervoid vm_copyin(struct vm *vm, int vcpuid, struct vm_copyinfo *copyinfo,
360166124Srafan    void *kaddr, size_t len);
36150276Spetervoid vm_copyout(struct vm *vm, int vcpuid, const void *kaddr,
36262449Speter    struct vm_copyinfo *copyinfo, size_t len);
36362449Speter
36462449Speterint vcpu_trace_exceptions(struct vm *vm, int vcpuid);
36562449Speter#endif	/* KERNEL */
36662449Speter
36762449Speter#define	VM_MAXCPU	16			/* maximum virtual cpus */
368166124Srafan
369166124Srafan/*
37076726Speter * Identifiers for optional vmm capabilities
37162449Speter */
37276726Speterenum vm_cap_type {
37376726Speter	VM_CAP_HALT_EXIT,
37476726Speter	VM_CAP_MTRAP_EXIT,
37562449Speter	VM_CAP_PAUSE_EXIT,
37676726Speter	VM_CAP_UNRESTRICTED_GUEST,
37776726Speter	VM_CAP_ENABLE_INVPCID,
37862449Speter	VM_CAP_MAX
37962449Speter};
38050276Speter
38150276Speterenum vm_intr_trigger {
38250276Speter	EDGE_TRIGGER,
383166124Srafan	LEVEL_TRIGGER
384166124Srafan};
385166124Srafan
386166124Srafan/*
387166124Srafan * The 'access' field has the format specified in Table 21-2 of the Intel
388166124Srafan * Architecture Manual vol 3b.
389166124Srafan *
390184989Srafan * XXX The contents of the 'access' field are architecturally defined except
391166124Srafan * bit 16 - Segment Unusable.
392184989Srafan */
393166124Srafanstruct seg_desc {
394166124Srafan	uint64_t	base;
395166124Srafan	uint32_t	limit;
39650276Speter	uint32_t	access;
397184989Srafan};
398184989Srafan#define	SEG_DESC_TYPE(access)		((access) & 0x001f)
399184989Srafan#define	SEG_DESC_DPL(access)		(((access) >> 5) & 0x3)
400166124Srafan#define	SEG_DESC_PRESENT(access)	(((access) & 0x0080) ? 1 : 0)
401184989Srafan#define	SEG_DESC_DEF32(access)		(((access) & 0x4000) ? 1 : 0)
402184989Srafan#define	SEG_DESC_GRANULARITY(access)	(((access) & 0x8000) ? 1 : 0)
403184989Srafan#define	SEG_DESC_UNUSABLE(access)	(((access) & 0x10000) ? 1 : 0)
404184989Srafan
405184989Srafanenum vm_cpu_mode {
406184989Srafan	CPU_MODE_REAL,
407166124Srafan	CPU_MODE_PROTECTED,
408166124Srafan	CPU_MODE_COMPATIBILITY,		/* IA-32E mode (CS.L = 0) */
409166124Srafan	CPU_MODE_64BIT,			/* IA-32E mode (CS.L = 1) */
410166124Srafan};
41150276Speter
412166124Srafanenum vm_paging_mode {
41350276Speter	PAGING_MODE_FLAT,
414166124Srafan	PAGING_MODE_32,
415166124Srafan	PAGING_MODE_PAE,
416166124Srafan	PAGING_MODE_64,
417166124Srafan};
418166124Srafan
419166124Srafanstruct vm_guest_paging {
420166124Srafan	uint64_t	cr3;
421166124Srafan	int		cpl;
422166124Srafan	enum vm_cpu_mode cpu_mode;
423166124Srafan	enum vm_paging_mode paging_mode;
424166124Srafan};
425166124Srafan
426166124Srafan/*
427166124Srafan * The data structures 'vie' and 'vie_op' are meant to be opaque to the
428166124Srafan * consumers of instruction decoding. The only reason why their contents
429166124Srafan * need to be exposed is because they are part of the 'vm_exit' structure.
430166124Srafan */
431166124Srafanstruct vie_op {
432166124Srafan	uint8_t		op_byte;	/* actual opcode byte */
433166124Srafan	uint8_t		op_type;	/* type of operation (e.g. MOV) */
43450276Speter	uint16_t	op_flags;
435166124Srafan};
436166124Srafan
437166124Srafan#define	VIE_INST_SIZE	15
43876726Speterstruct vie {
439166124Srafan	uint8_t		inst[VIE_INST_SIZE];	/* instruction bytes */
44050276Speter	uint8_t		num_valid;		/* size of the instruction */
441166124Srafan	uint8_t		num_processed;
442166124Srafan
443166124Srafan	uint8_t		addrsize:4, opsize:4;	/* address and operand sizes */
444166124Srafan	uint8_t		rex_w:1,		/* REX prefix */
445166124Srafan			rex_r:1,
446166124Srafan			rex_x:1,
447166124Srafan			rex_b:1,
448166124Srafan			rex_present:1,
449166124Srafan			repz_present:1,		/* REP/REPE/REPZ prefix */
450166124Srafan			repnz_present:1,	/* REPNE/REPNZ prefix */
451166124Srafan			opsize_override:1,	/* Operand size override */
452166124Srafan			addrsize_override:1,	/* Address size override */
453166124Srafan			segment_override:1;	/* Segment override */
454166124Srafan
455166124Srafan	uint8_t		mod:2,			/* ModRM byte */
456166124Srafan			reg:4,
457166124Srafan			rm:4;
458166124Srafan
459166124Srafan	uint8_t		ss:2,			/* SIB byte */
460166124Srafan			index:4,
461166124Srafan			base:4;
462166124Srafan
463166124Srafan	uint8_t		disp_bytes;
464166124Srafan	uint8_t		imm_bytes;
465166124Srafan
466184989Srafan	uint8_t		scale;
467166124Srafan	int		base_register;		/* VM_REG_GUEST_xyz */
468166124Srafan	int		index_register;		/* VM_REG_GUEST_xyz */
469166124Srafan	int		segment_register;	/* VM_REG_GUEST_xyz */
470166124Srafan
471166124Srafan	int64_t		displacement;		/* optional addr displacement */
472166124Srafan	int64_t		immediate;		/* optional immediate operand */
473166124Srafan
474166124Srafan	uint8_t		decoded;	/* set to 1 if successfully decoded */
475166124Srafan
476166124Srafan	struct vie_op	op;			/* opcode description */
477166124Srafan};
478166124Srafan
479166124Srafanenum vm_exitcode {
480166124Srafan	VM_EXITCODE_INOUT,
481166124Srafan	VM_EXITCODE_VMX,
482166124Srafan	VM_EXITCODE_BOGUS,
483166124Srafan	VM_EXITCODE_RDMSR,
484166124Srafan	VM_EXITCODE_WRMSR,
485166124Srafan	VM_EXITCODE_HLT,
486166124Srafan	VM_EXITCODE_MTRAP,
487166124Srafan	VM_EXITCODE_PAUSE,
488166124Srafan	VM_EXITCODE_PAGING,
489166124Srafan	VM_EXITCODE_INST_EMUL,
490166124Srafan	VM_EXITCODE_SPINUP_AP,
491166124Srafan	VM_EXITCODE_DEPRECATED1,	/* used to be SPINDOWN_CPU */
492166124Srafan	VM_EXITCODE_RENDEZVOUS,
493166124Srafan	VM_EXITCODE_IOAPIC_EOI,
494166124Srafan	VM_EXITCODE_SUSPENDED,
495166124Srafan	VM_EXITCODE_INOUT_STR,
496184989Srafan	VM_EXITCODE_TASK_SWITCH,
49762449Speter	VM_EXITCODE_MONITOR,
49850276Speter	VM_EXITCODE_MWAIT,
499166124Srafan	VM_EXITCODE_SVM,
50062449Speter	VM_EXITCODE_MAX
50150276Speter};
50262449Speter
50362449Speterstruct vm_inout {
50462449Speter	uint16_t	bytes:3;	/* 1 or 2 or 4 */
505166124Srafan	uint16_t	in:1;
50650276Speter	uint16_t	string:1;
50762449Speter	uint16_t	rep:1;
508166124Srafan	uint16_t	port;
50962449Speter	uint32_t	eax;		/* valid for out */
510166124Srafan};
511166124Srafan
51276726Speterstruct vm_inout_str {
51362449Speter	struct vm_inout	inout;		/* must be the first element */
51450276Speter	struct vm_guest_paging paging;
51562449Speter	uint64_t	rflags;
51650276Speter	uint64_t	cr0;
517166124Srafan	uint64_t	index;
518166124Srafan	uint64_t	count;		/* rep=1 (%rcx), rep=0 (1) */
519166124Srafan	int		addrsize;
520166124Srafan	enum vm_reg_name seg_name;
521166124Srafan	struct seg_desc seg_desc;
522166124Srafan};
52350276Speter
524166124Srafanenum task_switch_reason {
525166124Srafan	TSR_CALL,
526166124Srafan	TSR_IRET,
527166124Srafan	TSR_JMP,
528166124Srafan	TSR_IDT_GATE,	/* task gate in IDT */
529166124Srafan};
530166124Srafan
531166124Srafanstruct vm_task_switch {
532166124Srafan	uint16_t	tsssel;		/* new TSS selector */
533166124Srafan	int		ext;		/* task switch due to external event */
534166124Srafan	uint32_t	errcode;
535166124Srafan	int		errcode_valid;	/* push 'errcode' on the new stack */
536166124Srafan	enum task_switch_reason reason;
537166124Srafan	struct vm_guest_paging paging;
538166124Srafan};
539166124Srafan
540166124Srafanstruct vm_exit {
541184989Srafan	enum vm_exitcode	exitcode;
542184989Srafan	int			inst_length;	/* 0 means unknown */
543184989Srafan	uint64_t		rip;
544184989Srafan	union {
545184989Srafan		struct vm_inout	inout;
546166124Srafan		struct vm_inout_str inout_str;
547166124Srafan		struct {
548166124Srafan			uint64_t	gpa;
549184989Srafan			int		fault_type;
550166124Srafan		} paging;
551184989Srafan		struct {
552166124Srafan			uint64_t	gpa;
553166124Srafan			uint64_t	gla;
554166124Srafan			int		cs_d;		/* CS.D */
55597049Speter			struct vm_guest_paging paging;
556184989Srafan			struct vie	vie;
55750276Speter		} inst_emul;
558166124Srafan		/*
55950276Speter		 * VMX specific payload. Used when there is no "better"
56050276Speter		 * exitcode to represent the VM-exit.
561166124Srafan		 */
562166124Srafan		struct {
563166124Srafan			int		status;		/* vmx inst status */
56450276Speter			/*
565166124Srafan			 * 'exit_reason' and 'exit_qualification' are valid
566184989Srafan			 * only if 'status' is zero.
567166124Srafan			 */
568166124Srafan			uint32_t	exit_reason;
56950276Speter			uint64_t	exit_qualification;
57050276Speter			/*
571166124Srafan			 * 'inst_error' and 'inst_type' are valid
572184989Srafan			 * only if 'status' is non-zero.
573166124Srafan			 */
574166124Srafan			int		inst_type;
575166124Srafan			int		inst_error;
576166124Srafan		} vmx;
577166124Srafan		/*
578166124Srafan		 * SVM specific payload.
579174993Srafan		 */
580184989Srafan		struct {
581166124Srafan			uint64_t	exitcode;
582174993Srafan			uint64_t	exitinfo1;
58350276Speter			uint64_t	exitinfo2;
584184989Srafan		} svm;
585184989Srafan		struct {
58650276Speter			uint32_t	code;		/* ecx value */
587184989Srafan			uint64_t	wval;
588184989Srafan		} msr;
589184989Srafan		struct {
590184989Srafan			int		vcpu;
591184989Srafan			uint64_t	rip;
592166124Srafan		} spinup_ap;
593166124Srafan		struct {
594166124Srafan			uint64_t	rflags;
595166124Srafan		} hlt;
596166124Srafan		struct {
597166124Srafan			int		vector;
598166124Srafan		} ioapic_eoi;
599166124Srafan		struct {
600166124Srafan			enum vm_suspend_how how;
601166124Srafan		} suspended;
602166124Srafan		struct vm_task_switch task_switch;
603166124Srafan	} u;
60462449Speter};
605166124Srafan
60662449Speter/* APIs to inject faults into the guest */
607184989Srafanvoid vm_inject_fault(void *vm, int vcpuid, int vector, int errcode_valid,
60850276Speter    int errcode);
60962449Speter
610166124Srafanstatic __inline void
61150276Spetervm_inject_ud(void *vm, int vcpuid)
61262449Speter{
613166124Srafan	vm_inject_fault(vm, vcpuid, IDT_UD, 0, 0);
61462449Speter}
61562449Speter
616166124Srafanstatic __inline void
61762449Spetervm_inject_gp(void *vm, int vcpuid)
61862449Speter{
61950276Speter	vm_inject_fault(vm, vcpuid, IDT_GP, 1, 0);
62050276Speter}
62150276Speter
622166124Srafanstatic __inline void
623166124Srafanvm_inject_ac(void *vm, int vcpuid, int errcode)
624166124Srafan{
625166124Srafan	vm_inject_fault(vm, vcpuid, IDT_AC, 1, errcode);
626166124Srafan}
627166124Srafan
628166124Srafanstatic __inline void
62950276Spetervm_inject_ss(void *vm, int vcpuid, int errcode)
630166124Srafan{
63150276Speter	vm_inject_fault(vm, vcpuid, IDT_SS, 1, errcode);
632}
633
634void vm_inject_pf(void *vm, int vcpuid, int error_code, uint64_t cr2);
635
636int vm_restart_instruction(void *vm, int vcpuid);
637
638#endif	/* _VMM_H_ */
639