1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2011 NetApp, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD$
29 */
30 /*
31 * This file and its contents are supplied under the terms of the
32 * Common Development and Distribution License ("CDDL"), version 1.0.
33 * You may only use this file in accordance with the terms of version
34 * 1.0 of the CDDL.
35 *
36 * A full copy of the text of the CDDL should have accompanied this
37 * source. A copy of the CDDL is also available via the Internet at
38 * http://www.illumos.org/license/CDDL.
39 *
40 * Copyright 2015 Pluribus Networks Inc.
41 * Copyright 2019 Joyent, Inc.
42 * Copyright 2020 Oxide Computer Company
43 */
44
45 #ifndef _VMMAPI_H_
46 #define _VMMAPI_H_
47
48 #include <sys/param.h>
49 #include <sys/cpuset.h>
50 #include <x86/segments.h>
51
52 #include <stdbool.h>
53
54 /*
55 * API version for out-of-tree consumers like grub-bhyve for making compile
56 * time decisions.
57 */
58 #define VMMAPI_VERSION 0103 /* 2 digit major followed by 2 digit minor */
59
60 struct iovec;
61 struct vmctx;
62 enum x2apic_state;
63
64 /*
65 * Different styles of mapping the memory assigned to a VM into the address
66 * space of the controlling process.
67 */
68 enum vm_mmap_style {
69 VM_MMAP_NONE, /* no mapping */
70 VM_MMAP_ALL, /* fully and statically mapped */
71 VM_MMAP_SPARSE, /* mappings created on-demand */
72 };
73
74 /*
75 * 'flags' value passed to 'vm_set_memflags()'.
76 */
77 #define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */
78 #define VM_MEM_F_WIRED 0x02 /* guest memory is wired */
79
80 /*
81 * Identifiers for memory segments:
82 * - vm_setup_memory() uses VM_SYSMEM for the system memory segment.
83 * - the remaining identifiers can be used to create devmem segments.
84 */
85 enum {
86 #ifdef __FreeBSD__
87 VM_SYSMEM,
88 #else
89 VM_LOWMEM,
90 VM_HIGHMEM,
91 #endif
92 VM_BOOTROM,
93 VM_FRAMEBUFFER,
94 };
95
96 /*
97 * Get the length and name of the memory segment identified by 'segid'.
98 * Note that system memory segments are identified with a nul name.
99 *
100 * Returns 0 on success and non-zero otherwise.
101 */
102 int vm_get_memseg(struct vmctx *ctx, int ident, size_t *lenp, char *name,
103 size_t namesiz);
104
105 /*
106 * Iterate over the guest address space. This function finds an address range
107 * that starts at an address >= *gpa.
108 *
109 * Returns 0 if the next address range was found and non-zero otherwise.
110 */
111 int vm_mmap_getnext(struct vmctx *ctx, vm_paddr_t *gpa, int *segid,
112 vm_ooffset_t *segoff, size_t *len, int *prot, int *flags);
113 /*
114 * Create a device memory segment identified by 'segid'.
115 *
116 * Returns a pointer to the memory segment on success and MAP_FAILED otherwise.
117 */
118 void *vm_create_devmem(struct vmctx *ctx, int segid, const char *name,
119 size_t len);
120
121 #ifndef __FreeBSD__
122 /*
123 * Return the map offset for the device memory segment 'segid'.
124 */
125 int vm_get_devmem_offset(struct vmctx *ctx, int segid, off_t *mapoff);
126 #endif
127
128 /*
129 * Map the memory segment identified by 'segid' into the guest address space
130 * at [gpa,gpa+len) with protection 'prot'.
131 */
132 int vm_mmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, int segid,
133 vm_ooffset_t segoff, size_t len, int prot);
134
135 int vm_create(const char *name);
136 int vm_get_device_fd(struct vmctx *ctx);
137 struct vmctx *vm_open(const char *name);
138 #ifndef __FreeBSD__
139 void vm_close(struct vmctx *ctx);
140 #endif
141 void vm_destroy(struct vmctx *ctx);
142 int vm_parse_memsize(const char *optarg, size_t *memsize);
143 int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
144 void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
145 int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
146 int vm_gla2gpa(struct vmctx *, int vcpuid, struct vm_guest_paging *paging,
147 uint64_t gla, int prot, uint64_t *gpa, int *fault);
148 int vm_gla2gpa_nofault(struct vmctx *, int vcpuid,
149 struct vm_guest_paging *paging, uint64_t gla, int prot,
150 uint64_t *gpa, int *fault);
151 uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
152 void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
153 void vm_set_memflags(struct vmctx *ctx, int flags);
154 int vm_get_memflags(struct vmctx *ctx);
155 size_t vm_get_lowmem_size(struct vmctx *ctx);
156 size_t vm_get_highmem_size(struct vmctx *ctx);
157 int vm_set_desc(struct vmctx *ctx, int vcpu, int reg,
158 uint64_t base, uint32_t limit, uint32_t access);
159 int vm_get_desc(struct vmctx *ctx, int vcpu, int reg,
160 uint64_t *base, uint32_t *limit, uint32_t *access);
161 int vm_get_seg_desc(struct vmctx *ctx, int vcpu, int reg,
162 struct seg_desc *seg_desc);
163 int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val);
164 int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval);
165 int vm_set_register_set(struct vmctx *ctx, int vcpu, unsigned int count,
166 const int *regnums, uint64_t *regvals);
167 int vm_get_register_set(struct vmctx *ctx, int vcpu, unsigned int count,
168 const int *regnums, uint64_t *regvals);
169 int vm_run(struct vmctx *ctx, int vcpu, const struct vm_entry *vm_entry,
170 struct vm_exit *vm_exit);
171 int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how);
172 int vm_reinit(struct vmctx *ctx);
173 int vm_apicid2vcpu(struct vmctx *ctx, int apicid);
174 int vm_inject_exception(struct vmctx *ctx, int vcpu, int vector,
175 int errcode_valid, uint32_t errcode, int restart_instruction);
176 #ifndef __FreeBSD__
177 void vm_inject_fault(struct vmctx *ctx, int vcpu, int vector,
178 int errcode_valid, int errcode);
179
180 static __inline void
181 vm_inject_gp(struct vmctx *ctx, int vcpuid)
182 {
183 vm_inject_fault(ctx, vcpuid, IDT_GP, 1, 0);
184 }
185
186 static __inline void
187 vm_inject_ac(struct vmctx *ctx, int vcpuid, int errcode)
188 {
189 vm_inject_fault(ctx, vcpuid, IDT_AC, 1, errcode);
190 }
191 static __inline void
192 vm_inject_ss(struct vmctx *ctx, int vcpuid, int errcode)
193 {
194 vm_inject_fault(ctx, vcpuid, IDT_SS, 1, errcode);
195 }
196 #endif
197 int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
198 int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector);
199 int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
200 int vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
201 int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
202 int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
203 int vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
204 int vm_readwrite_kernemu_device(struct vmctx *ctx, int vcpu,
205 vm_paddr_t gpa, bool write, int size, uint64_t *value);
206 int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
207 int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
208 int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
209 int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq,
210 enum vm_intr_trigger trigger);
211 int vm_inject_nmi(struct vmctx *ctx, int vcpu);
212 int vm_capability_name2type(const char *capname);
213 const char *vm_capability_type2name(int type);
214 int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
215 int *retval);
216 int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
217 int val);
218 #ifdef __FreeBSD__
219 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
220 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
221 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
222 vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
223 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot,
224 int func, uint64_t addr, uint64_t msg, int numvec);
225 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot,
226 int func, int idx, uint64_t addr, uint64_t msg,
227 uint32_t vector_control);
228 int vm_get_pptdev_limits(struct vmctx *ctx, int bus, int slot, int func,
229 int *msi_limit, int *msix_limit);
230 #else /* __FreeBSD__ */
231 int vm_assign_pptdev(struct vmctx *ctx, int pptfd);
232 int vm_unassign_pptdev(struct vmctx *ctx, int pptfd);
233 int vm_map_pptdev_mmio(struct vmctx *ctx, int pptfd, vm_paddr_t gpa,
234 size_t len, vm_paddr_t hpa);
235 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int pptfd,
236 uint64_t addr, uint64_t msg, int numvec);
237 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int pptfd,
238 int idx, uint64_t addr, uint64_t msg, uint32_t vector_control);
239 int vm_get_pptdev_limits(struct vmctx *ctx, int pptfd, int *msi_limit,
240 int *msix_limit);
241 #endif /* __FreeBSD__ */
242
243 int vm_get_intinfo(struct vmctx *ctx, int vcpu, uint64_t *i1, uint64_t *i2);
244 int vm_set_intinfo(struct vmctx *ctx, int vcpu, uint64_t exit_intinfo);
245
246 #ifdef __FreeBSD__
247 const cap_ioctl_t *vm_get_ioctls(size_t *len);
248 #endif
249
250 /*
251 * Return a pointer to the statistics buffer. Note that this is not MT-safe.
252 */
253 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv,
254 int *ret_entries);
255 const char *vm_get_stat_desc(struct vmctx *ctx, int index);
256
257 int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s);
258 int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s);
259
260 int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
261
262 /*
263 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'.
264 * The 'iovcnt' should be big enough to accommodate all GPA segments.
265 *
266 * retval fault Interpretation
267 * 0 0 Success
268 * 0 1 An exception was injected into the guest
269 * EFAULT N/A Error
270 */
271 int vm_copy_setup(struct vmctx *ctx, int vcpu, struct vm_guest_paging *pg,
272 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt,
273 int *fault);
274 void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov,
275 void *host_dst, size_t len);
276 void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src,
277 struct iovec *guest_iov, size_t len);
278 void vm_copy_teardown(struct vmctx *ctx, int vcpu, struct iovec *iov,
279 int iovcnt);
280
281 /* RTC */
282 int vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value);
283 int vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval);
284 int vm_rtc_settime(struct vmctx *ctx, time_t secs);
285 int vm_rtc_gettime(struct vmctx *ctx, time_t *secs);
286
287 /* Reset vcpu register state */
288 int vcpu_reset(struct vmctx *ctx, int vcpu);
289
290 int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus);
291 int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus);
292 int vm_debug_cpus(struct vmctx *ctx, cpuset_t *cpus);
293 int vm_activate_cpu(struct vmctx *ctx, int vcpu);
294 int vm_suspend_cpu(struct vmctx *ctx, int vcpu);
295 int vm_resume_cpu(struct vmctx *ctx, int vcpu);
296
297 /* CPU topology */
298 int vm_set_topology(struct vmctx *ctx, uint16_t sockets, uint16_t cores,
299 uint16_t threads, uint16_t maxcpus);
300 int vm_get_topology(struct vmctx *ctx, uint16_t *sockets, uint16_t *cores,
301 uint16_t *threads, uint16_t *maxcpus);
302
303 #ifndef __FreeBSD__
304 /* illumos-specific APIs */
305 int vm_pmtmr_set_location(struct vmctx *ctx, uint16_t ioport);
306 int vm_wrlock_cycle(struct vmctx *ctx);
307 #endif /* __FreeBSD__ */
308
309 #ifdef __FreeBSD__
310 /*
311 * FreeBSD specific APIs
312 */
313 int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu,
314 uint64_t rip, uint64_t cr3, uint64_t gdtbase,
315 uint64_t rsp);
316 int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu,
317 uint32_t eip, uint32_t gdtbase,
318 uint32_t esp);
319 void vm_setup_freebsd_gdt(uint64_t *gdtr);
320 #endif
321 #endif /* _VMMAPI_H_ */