1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 /*
29  * This file and its contents are supplied under the terms of the
30  * Common Development and Distribution License ("CDDL"), version 1.0.
31  * You may only use this file in accordance with the terms of version
32  * 1.0 of the CDDL.
33  *
34  * A full copy of the text of the CDDL should have accompanied this
35  * source.  A copy of the CDDL is also available via the Internet at
36  * http://www.illumos.org/license/CDDL.
37  *
38  * Copyright 2015 Pluribus Networks Inc.
39  * Copyright 2019 Joyent, Inc.
40  * Copyright 2023 Oxide Computer Company
41  */
42 
43 #ifndef _VMMAPI_H_
44 #define	_VMMAPI_H_
45 
46 #include <sys/param.h>
47 #include <sys/cpuset.h>
48 #include <x86/segments.h>
49 
50 #include <stdbool.h>
51 
52 /*
53  * API version for out-of-tree consumers like grub-bhyve for making compile
54  * time decisions.
55  */
56 #define	VMMAPI_VERSION	0200	/* 2 digit major followed by 2 digit minor */
57 
58 struct iovec;
59 struct vcpu;
60 struct vmctx;
61 enum x2apic_state;
62 
63 /*
64  * Different styles of mapping the memory assigned to a VM into the address
65  * space of the controlling process.
66  */
67 enum vm_mmap_style {
68 	VM_MMAP_NONE,		/* no mapping */
69 	VM_MMAP_ALL,		/* fully and statically mapped */
70 	VM_MMAP_SPARSE,		/* mappings created on-demand */
71 };
72 
73 /*
74  * 'flags' value passed to 'vm_set_memflags()'.
75  */
76 #define	VM_MEM_F_INCORE	0x01	/* include guest memory in core file */
77 #define	VM_MEM_F_WIRED	0x02	/* guest memory is wired */
78 
79 /*
80  * Identifiers for memory segments:
81  * - vm_setup_memory() uses VM_SYSMEM for the system memory segment.
82  * - the remaining identifiers can be used to create devmem segments.
83  */
84 enum {
85 #ifdef __FreeBSD__
86 	VM_SYSMEM,
87 #else
88 	VM_LOWMEM,
89 	VM_HIGHMEM,
90 #endif
91 	VM_BOOTROM,
92 	VM_FRAMEBUFFER,
93 	VM_PCIROM,
94 };
95 
96 #ifdef	__cplusplus
97 extern "C" {
98 #endif
99 
100 /*
101  * Get the length and name of the memory segment identified by 'segid'.
102  * Note that system memory segments are identified with a nul name.
103  *
104  * Returns 0 on success and non-zero otherwise.
105  */
106 int	vm_get_memseg(struct vmctx *ctx, int ident, size_t *lenp, char *name,
107 	    size_t namesiz);
108 
109 /*
110  * Iterate over the guest address space. This function finds an address range
111  * that starts at an address >= *gpa.
112  *
113  * Returns 0 if the next address range was found and non-zero otherwise.
114  */
115 int	vm_mmap_getnext(struct vmctx *ctx, vm_paddr_t *gpa, int *segid,
116 	    vm_ooffset_t *segoff, size_t *len, int *prot, int *flags);
117 
118 #ifdef	__FreeBSD__
119 int	vm_get_guestmem_from_ctx(struct vmctx *ctx, char **guest_baseaddr,
120 				 size_t *lowmem_size, size_t *highmem_size);
121 #endif
122 
123 /*
124  * Create a device memory segment identified by 'segid'.
125  *
126  * Returns a pointer to the memory segment on success and MAP_FAILED otherwise.
127  */
128 void	*vm_create_devmem(struct vmctx *ctx, int segid, const char *name,
129 	    size_t len);
130 
131 #ifndef __FreeBSD__
132 /*
133  * Return the map offset for the device memory segment 'segid'.
134  */
135 int	vm_get_devmem_offset(struct vmctx *ctx, int segid, off_t *mapoff);
136 #endif
137 
138 /*
139  * Map the memory segment identified by 'segid' into the guest address space
140  * at [gpa,gpa+len) with protection 'prot'.
141  */
142 int	vm_mmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, int segid,
143 	    vm_ooffset_t segoff, size_t len, int prot);
144 
145 int	vm_munmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, size_t len);
146 
147 #ifdef __FreeBSD__
148 int	vm_create(const char *name);
149 #else
150 int	vm_create(const char *name, uint64_t flags);
151 #endif /* __FreeBSD__ */
152 struct vmctx *vm_open(const char *name);
153 void	vm_close(struct vmctx *ctx);
154 void	vm_destroy(struct vmctx *ctx);
155 #ifdef	__FreeBSD__
156 int	vm_limit_rights(struct vmctx *ctx);
157 #endif
158 struct vcpu *vm_vcpu_open(struct vmctx *ctx, int vcpuid);
159 void	vm_vcpu_close(struct vcpu *vcpu);
160 int	vcpu_id(struct vcpu *vcpu);
161 #ifndef	__FreeBSD__
162 struct vmctx *vcpu_ctx(struct vcpu *vcpu);
163 #endif
164 int	vm_parse_memsize(const char *optarg, size_t *memsize);
165 int	vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
166 void	*vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
167 #ifdef	__FreeBSD__
168 /* inverse operation to vm_map_gpa - extract guest address from host pointer */
169 vm_paddr_t vm_rev_map_gpa(struct vmctx *ctx, void *addr);
170 #endif
171 int	vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
172 int	vm_gla2gpa(struct vcpu *vcpu, struct vm_guest_paging *paging,
173 		   uint64_t gla, int prot, uint64_t *gpa, int *fault);
174 int	vm_gla2gpa_nofault(struct vcpu *vcpu,
175 		   struct vm_guest_paging *paging, uint64_t gla, int prot,
176 		   uint64_t *gpa, int *fault);
177 uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
178 void	vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
179 void	vm_set_memflags(struct vmctx *ctx, int flags);
180 int	vm_get_memflags(struct vmctx *ctx);
181 const char *vm_get_name(struct vmctx *ctx);
182 size_t	vm_get_lowmem_size(struct vmctx *ctx);
183 size_t	vm_get_highmem_size(struct vmctx *ctx);
184 int	vm_set_desc(struct vcpu *vcpu, int reg,
185 		    uint64_t base, uint32_t limit, uint32_t access);
186 int	vm_get_desc(struct vcpu *vcpu, int reg,
187 		    uint64_t *base, uint32_t *limit, uint32_t *access);
188 int	vm_get_seg_desc(struct vcpu *vcpu, int reg, struct seg_desc *seg_desc);
189 int	vm_set_register(struct vcpu *vcpu, int reg, uint64_t val);
190 int	vm_get_register(struct vcpu *vcpu, int reg, uint64_t *retval);
191 int	vm_set_register_set(struct vcpu *vcpu, unsigned int count,
192     const int *regnums, uint64_t *regvals);
193 int	vm_get_register_set(struct vcpu *vcpu, unsigned int count,
194     const int *regnums, uint64_t *regvals);
195 #ifdef	__FreeBSD__
196 int	vm_run(struct vcpu *vcpu, struct vm_exit *ret_vmexit);
197 #else
198 int	vm_run(struct vcpu *vcpu, const struct vm_entry *vm_entry,
199     struct vm_exit *vm_exit);
200 #endif
201 int	vm_suspend(struct vmctx *ctx, enum vm_suspend_how how);
202 #ifdef __FreeBSD__
203 int	vm_reinit(struct vmctx *ctx);
204 #else
205 int	vm_reinit(struct vmctx *ctx, uint64_t);
206 #endif
207 int	vm_apicid2vcpu(struct vmctx *ctx, int apicid);
208 int	vm_inject_exception(struct vcpu *vcpu, int vector,
209     int errcode_valid, uint32_t errcode, int restart_instruction);
210 #ifndef __FreeBSD__
211 void	vm_inject_fault(struct vcpu *vcpu, int vector,
212     int errcode_valid, int errcode);
213 
214 static __inline void
vm_inject_gp(struct vcpu * vcpu)215 vm_inject_gp(struct vcpu *vcpu)
216 {
217 	vm_inject_fault(vcpu, IDT_GP, 1, 0);
218 }
219 
220 static __inline void
vm_inject_ac(struct vcpu * vcpu,int errcode)221 vm_inject_ac(struct vcpu *vcpu, int errcode)
222 {
223 	vm_inject_fault(vcpu, IDT_AC, 1, errcode);
224 }
225 static __inline void
vm_inject_ss(struct vcpu * vcpu,int errcode)226 vm_inject_ss(struct vcpu *vcpu, int errcode)
227 {
228 	vm_inject_fault(vcpu, IDT_SS, 1, errcode);
229 }
230 #endif
231 int	vm_lapic_irq(struct vcpu *vcpu, int vector);
232 int	vm_lapic_local_irq(struct vcpu *vcpu, int vector);
233 int	vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
234 int	vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
235 int	vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
236 int	vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
237 int	vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
238 int	vm_readwrite_kernemu_device(struct vcpu *vcpu,
239 	    vm_paddr_t gpa, bool write, int size, uint64_t *value);
240 int	vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
241 int	vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
242 int	vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
243 int	vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq,
244 	    enum vm_intr_trigger trigger);
245 int	vm_inject_nmi(struct vcpu *vcpu);
246 int	vm_capability_name2type(const char *capname);
247 const char *vm_capability_type2name(int type);
248 int	vm_get_capability(struct vcpu *vcpu, enum vm_cap_type cap,
249 			  int *retval);
250 int	vm_set_capability(struct vcpu *vcpu, enum vm_cap_type cap,
251 			  int val);
252 #ifdef __FreeBSD__
253 int	vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
254 int	vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
255 int	vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
256 			   vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
257 int	vm_unmap_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
258 			     vm_paddr_t gpa, size_t len);
259 int	vm_setup_pptdev_msi(struct vmctx *ctx, int bus, int slot,
260 	    int func, uint64_t addr, uint64_t msg, int numvec);
261 int	vm_setup_pptdev_msix(struct vmctx *ctx, int bus, int slot,
262 	    int func, int idx, uint64_t addr, uint64_t msg,
263 	    uint32_t vector_control);
264 int	vm_disable_pptdev_msix(struct vmctx *ctx, int bus, int slot, int func);
265 #else /* __FreeBSD__ */
266 int	vm_assign_pptdev(struct vmctx *ctx, int pptfd);
267 int	vm_unassign_pptdev(struct vmctx *ctx, int pptfd);
268 int	vm_map_pptdev_mmio(struct vmctx *ctx, int pptfd, vm_paddr_t gpa,
269     size_t len, vm_paddr_t hpa);
270 int	vm_unmap_pptdev_mmio(struct vmctx *ctx, int pptfd, vm_paddr_t gpa,
271     size_t len);
272 int	vm_setup_pptdev_msi(struct vmctx *ctx, int pptfd, uint64_t addr,
273     uint64_t msg, int numvec);
274 int	vm_setup_pptdev_msix(struct vmctx *ctx, int pptfd, int idx, uint64_t
275     addr, uint64_t msg, uint32_t vector_control);
276 int	vm_disable_pptdev_msix(struct vmctx *ctx, int pptfd);
277 int	vm_get_pptdev_limits(struct vmctx *ctx, int pptfd, int *msi_limit,
278     int *msix_limit);
279 #endif /* __FreeBSD__ */
280 
281 int	vm_get_intinfo(struct vcpu *vcpu, uint64_t *i1, uint64_t *i2);
282 int	vm_set_intinfo(struct vcpu *vcpu, uint64_t exit_intinfo);
283 
284 /*
285  * Return a pointer to the statistics buffer. Note that this is not MT-safe.
286  */
287 uint64_t *vm_get_stats(struct vcpu *vcpu, struct timeval *ret_tv,
288 		       int *ret_entries);
289 const char *vm_get_stat_desc(struct vmctx *ctx, int index);
290 
291 int	vm_get_x2apic_state(struct vcpu *vcpu, enum x2apic_state *s);
292 int	vm_set_x2apic_state(struct vcpu *vcpu, enum x2apic_state s);
293 
294 int	vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
295 
296 /*
297  * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'.
298  * The 'iovcnt' should be big enough to accommodate all GPA segments.
299  *
300  * retval	fault		Interpretation
301  *   0		  0		Success
302  *   0		  1		An exception was injected into the guest
303  * EFAULT	 N/A		Error
304  */
305 int	vm_copy_setup(struct vcpu *vcpu, struct vm_guest_paging *pg,
306 	    uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt,
307 	    int *fault);
308 void	vm_copyin(struct iovec *guest_iov, void *host_dst, size_t len);
309 void	vm_copyout(const void *host_src, struct iovec *guest_iov, size_t len);
310 void	vm_copy_teardown(struct iovec *iov, int iovcnt);
311 
312 /* RTC */
313 int	vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value);
314 int	vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval);
315 #ifdef __FreeBSD__
316 int	vm_rtc_settime(struct vmctx *ctx, time_t secs);
317 int	vm_rtc_gettime(struct vmctx *ctx, time_t *secs);
318 #else /* __FreeBSD__ */
319 int	vm_rtc_settime(struct vmctx *ctx, const timespec_t *);
320 int	vm_rtc_gettime(struct vmctx *ctx, timespec_t *);
321 #endif /* __FreeBSD__ */
322 
323 /* Reset vcpu register state */
324 int	vcpu_reset(struct vcpu *vcpu);
325 
326 int	vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus);
327 #ifdef	__FreeBSD__
328 int	vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus);
329 #endif	/* __FreeBSD__ */
330 int	vm_debug_cpus(struct vmctx *ctx, cpuset_t *cpus);
331 int	vm_activate_cpu(struct vcpu *vcpu);
332 int	vm_suspend_all_cpus(struct vmctx *ctx);
333 int	vm_suspend_cpu(struct vcpu *vcpu);
334 int	vm_resume_all_cpus(struct vmctx *ctx);
335 int	vm_resume_cpu(struct vcpu *vcpu);
336 
337 /* CPU topology */
338 int	vm_set_topology(struct vmctx *ctx, uint16_t sockets, uint16_t cores,
339 	    uint16_t threads, uint16_t maxcpus);
340 int	vm_get_topology(struct vmctx *ctx, uint16_t *sockets, uint16_t *cores,
341 	    uint16_t *threads, uint16_t *maxcpus);
342 
343 #ifndef	__FreeBSD__
344 /* illumos-specific APIs */
345 int	vm_pmtmr_set_location(struct vmctx *ctx, uint16_t ioport);
346 int	vm_wrlock_cycle(struct vmctx *ctx);
347 int vm_get_run_state(struct vcpu *vcpu, enum vcpu_run_state *state,
348     uint8_t *sipi_vector);
349 int vm_set_run_state(struct vcpu *vcpu, enum vcpu_run_state state,
350     uint8_t sipi_vector);
351 int vm_vcpu_barrier(struct vcpu *vcpu);
352 #endif	/* __FreeBSD__ */
353 
354 #ifdef	__FreeBSD__
355 /*
356  * FreeBSD specific APIs
357  */
358 int	vm_setup_freebsd_registers(struct vcpu *vcpu,
359 				uint64_t rip, uint64_t cr3, uint64_t gdtbase,
360 				uint64_t rsp);
361 int	vm_setup_freebsd_registers_i386(struct vcpu *vcpu,
362 					uint32_t eip, uint32_t gdtbase,
363 					uint32_t esp);
364 void	vm_setup_freebsd_gdt(uint64_t *gdtr);
365 #endif
366 
367 /*
368  * Deprecated interfaces, do not use them in new code.
369  */
370 int	vm_get_device_fd(struct vmctx *ctx);
371 #ifdef	__FreeBSD__
372 const cap_ioctl_t *vm_get_ioctls(size_t *len);
373 #endif
374 
375 #ifdef	__cplusplus
376 }
377 #endif
378 
379 #endif	/* _VMMAPI_H_ */
380