2 * Copyright (c) 2011 NetApp, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
34 #define VM_MAX_NAMELEN 32
37 struct vm_memory_segment;
45 typedef int (*vmm_init_func_t)(void);
46 typedef int (*vmm_cleanup_func_t)(void);
47 typedef void * (*vmi_init_func_t)(struct vm *vm); /* instance specific apis */
48 typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip);
49 typedef void (*vmi_cleanup_func_t)(void *vmi);
50 typedef int (*vmi_mmap_set_func_t)(void *vmi, vm_paddr_t gpa,
51 vm_paddr_t hpa, size_t length,
52 vm_memattr_t attr, int prot,
53 boolean_t superpages_ok);
54 typedef vm_paddr_t (*vmi_mmap_get_func_t)(void *vmi, vm_paddr_t gpa);
55 typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num,
57 typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num,
59 typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num,
60 struct seg_desc *desc);
61 typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num,
62 struct seg_desc *desc);
63 typedef int (*vmi_inject_event_t)(void *vmi, int vcpu,
65 uint32_t code, int code_valid);
66 typedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval);
67 typedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val);
70 vmm_init_func_t init; /* module wide initialization */
71 vmm_cleanup_func_t cleanup;
73 vmi_init_func_t vminit; /* vm-specific initialization */
75 vmi_cleanup_func_t vmcleanup;
76 vmi_mmap_set_func_t vmmmap_set;
77 vmi_mmap_get_func_t vmmmap_get;
78 vmi_get_register_t vmgetreg;
79 vmi_set_register_t vmsetreg;
80 vmi_get_desc_t vmgetdesc;
81 vmi_set_desc_t vmsetdesc;
82 vmi_inject_event_t vminject;
83 vmi_get_cap_t vmgetcap;
84 vmi_set_cap_t vmsetcap;
87 extern struct vmm_ops vmm_ops_intel;
88 extern struct vmm_ops vmm_ops_amd;
90 struct vm *vm_create(const char *name);
91 void vm_destroy(struct vm *vm);
92 const char *vm_name(struct vm *vm);
93 int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len);
94 int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
95 int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len);
96 vm_paddr_t vm_gpa2hpa(struct vm *vm, vm_paddr_t gpa, size_t size);
97 int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase,
98 struct vm_memory_segment *seg);
99 int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval);
100 int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val);
101 int vm_get_seg_desc(struct vm *vm, int vcpu, int reg,
102 struct seg_desc *ret_desc);
103 int vm_set_seg_desc(struct vm *vm, int vcpu, int reg,
104 struct seg_desc *desc);
105 int vm_run(struct vm *vm, struct vm_run *vmrun);
106 int vm_inject_event(struct vm *vm, int vcpu, int type,
107 int vector, uint32_t error_code, int error_code_valid);
108 int vm_inject_nmi(struct vm *vm, int vcpu);
109 int vm_nmi_pending(struct vm *vm, int vcpuid);
110 void vm_nmi_clear(struct vm *vm, int vcpuid);
111 uint64_t *vm_guest_msrs(struct vm *vm, int cpu);
112 struct vlapic *vm_lapic(struct vm *vm, int cpu);
113 int vm_get_capability(struct vm *vm, int vcpu, int type, int *val);
114 int vm_set_capability(struct vm *vm, int vcpu, int type, int val);
115 int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state);
116 int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state);
117 void vm_activate_cpu(struct vm *vm, int vcpu);
118 cpuset_t vm_active_cpus(struct vm *vm);
119 struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid);
122 * Return 1 if device indicated by bus/slot/func is supposed to be a
123 * pci passthrough device.
125 * Return 0 otherwise.
127 int vmm_is_pptdev(int bus, int slot, int func);
129 void *vm_iommu_domain(struct vm *vm);
137 int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state);
138 enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu);
141 vcpu_is_running(struct vm *vm, int vcpu)
143 return (vcpu_get_state(vm, vcpu) == VCPU_RUNNING);
146 void *vcpu_stats(struct vm *vm, int vcpu);
147 void vm_interrupt_hostcpu(struct vm *vm, int vcpu);
151 #include <machine/vmm_instruction_emul.h>
153 #define VM_MAXCPU 8 /* maximum virtual cpus */
156 * Identifiers for events that can be injected into the VM
164 VM_PRIV_SW_EXCEPTION,
170 * Identifiers for architecturally defined registers.
210 * Identifiers for optional vmm capabilities
216 VM_CAP_UNRESTRICTED_GUEST,
228 * The 'access' field has the format specified in Table 21-2 of the Intel
229 * Architecture Manual vol 3b.
231 * XXX The contents of the 'access' field are architecturally defined except
232 * bit 16 - Segment Unusable.
250 VM_EXITCODE_SPINUP_AP,
255 enum vm_exitcode exitcode;
256 int inst_length; /* 0 means unknown */
260 uint16_t bytes:3; /* 1 or 2 or 4 */
261 uint16_t in:1; /* out is 0, in is 1 */
265 uint32_t eax; /* valid for out */
272 * VMX specific payload. Used when there is no "better"
273 * exitcode to represent the VM-exit.
276 int error; /* vmx inst error */
277 uint32_t exit_reason;
278 uint64_t exit_qualification;
281 uint32_t code; /* ecx value */