xref: /freebsd/lib/libvmmapi/vmmapi.h (revision a0b956f5ac5e0941f9e74e24c1c53e05ad061a38)
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 #ifndef _VMMAPI_H_
32 #define	_VMMAPI_H_
33 
34 #include <sys/param.h>
35 #include <sys/cpuset.h>
36 #include <machine/vmm.h>
37 #include <machine/vmm_dev.h>
38 
39 #include <stdbool.h>
40 
41 /*
42  * API version for out-of-tree consumers like grub-bhyve for making compile
43  * time decisions.
44  */
45 #define	VMMAPI_VERSION	0103	/* 2 digit major followed by 2 digit minor */
46 
47 struct iovec;
48 struct vmctx;
49 struct vm_snapshot_meta;
50 enum x2apic_state;
51 
52 /*
53  * Different styles of mapping the memory assigned to a VM into the address
54  * space of the controlling process.
55  */
56 enum vm_mmap_style {
57 	VM_MMAP_NONE,		/* no mapping */
58 	VM_MMAP_ALL,		/* fully and statically mapped */
59 	VM_MMAP_SPARSE,		/* mappings created on-demand */
60 };
61 
62 /*
63  * 'flags' value passed to 'vm_set_memflags()'.
64  */
65 #define	VM_MEM_F_INCORE	0x01	/* include guest memory in core file */
66 #define	VM_MEM_F_WIRED	0x02	/* guest memory is wired */
67 
68 /*
69  * Identifiers for memory segments:
70  * - vm_setup_memory() uses VM_SYSMEM for the system memory segment.
71  * - the remaining identifiers can be used to create devmem segments.
72  */
73 enum {
74 	VM_SYSMEM,
75 	VM_BOOTROM,
76 	VM_FRAMEBUFFER,
77 	VM_PCIROM,
78 };
79 
80 /*
81  * Get the length and name of the memory segment identified by 'segid'.
82  * Note that system memory segments are identified with a nul name.
83  *
84  * Returns 0 on success and non-zero otherwise.
85  */
86 int	vm_get_memseg(struct vmctx *ctx, int ident, size_t *lenp, char *name,
87 	    size_t namesiz);
88 
89 /*
90  * Iterate over the guest address space. This function finds an address range
91  * that starts at an address >= *gpa.
92  *
93  * Returns 0 if the next address range was found and non-zero otherwise.
94  */
95 int	vm_mmap_getnext(struct vmctx *ctx, vm_paddr_t *gpa, int *segid,
96 	    vm_ooffset_t *segoff, size_t *len, int *prot, int *flags);
97 
98 int	vm_get_guestmem_from_ctx(struct vmctx *ctx, char **guest_baseaddr,
99 				 size_t *lowmem_size, size_t *highmem_size);
100 
101 /*
102  * Create a device memory segment identified by 'segid'.
103  *
104  * Returns a pointer to the memory segment on success and MAP_FAILED otherwise.
105  */
106 void	*vm_create_devmem(struct vmctx *ctx, int segid, const char *name,
107 	    size_t len);
108 
109 /*
110  * Map the memory segment identified by 'segid' into the guest address space
111  * at [gpa,gpa+len) with protection 'prot'.
112  */
113 int	vm_mmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, int segid,
114 	    vm_ooffset_t segoff, size_t len, int prot);
115 
116 int	vm_munmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, size_t len);
117 
118 int	vm_create(const char *name);
119 int	vm_get_device_fd(struct vmctx *ctx);
120 struct vmctx *vm_open(const char *name);
121 void	vm_close(struct vmctx *ctx);
122 void	vm_destroy(struct vmctx *ctx);
123 int	vm_parse_memsize(const char *optarg, size_t *memsize);
124 int	vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
125 void	*vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
126 /* inverse operation to vm_map_gpa - extract guest address from host pointer */
127 vm_paddr_t vm_rev_map_gpa(struct vmctx *ctx, void *addr);
128 int	vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
129 int	vm_gla2gpa(struct vmctx *, int vcpuid, struct vm_guest_paging *paging,
130 		   uint64_t gla, int prot, uint64_t *gpa, int *fault);
131 int	vm_gla2gpa_nofault(struct vmctx *, int vcpuid,
132 		   struct vm_guest_paging *paging, uint64_t gla, int prot,
133 		   uint64_t *gpa, int *fault);
134 uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
135 void	vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
136 void	vm_set_memflags(struct vmctx *ctx, int flags);
137 int	vm_get_memflags(struct vmctx *ctx);
138 const char *vm_get_name(struct vmctx *ctx);
139 size_t	vm_get_lowmem_size(struct vmctx *ctx);
140 size_t	vm_get_highmem_size(struct vmctx *ctx);
141 int	vm_set_desc(struct vmctx *ctx, int vcpu, int reg,
142 		    uint64_t base, uint32_t limit, uint32_t access);
143 int	vm_get_desc(struct vmctx *ctx, int vcpu, int reg,
144 		    uint64_t *base, uint32_t *limit, uint32_t *access);
145 int	vm_get_seg_desc(struct vmctx *ctx, int vcpu, int reg,
146 			struct seg_desc *seg_desc);
147 int	vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val);
148 int	vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval);
149 int	vm_set_register_set(struct vmctx *ctx, int vcpu, unsigned int count,
150     const int *regnums, uint64_t *regvals);
151 int	vm_get_register_set(struct vmctx *ctx, int vcpu, unsigned int count,
152     const int *regnums, uint64_t *regvals);
153 int	vm_run(struct vmctx *ctx, int vcpu, struct vm_exit *ret_vmexit);
154 int	vm_suspend(struct vmctx *ctx, enum vm_suspend_how how);
155 int	vm_reinit(struct vmctx *ctx);
156 int	vm_apicid2vcpu(struct vmctx *ctx, int apicid);
157 int	vm_inject_exception(struct vmctx *ctx, int vcpu, int vector,
158     int errcode_valid, uint32_t errcode, int restart_instruction);
159 int	vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
160 int	vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector);
161 int	vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
162 int	vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
163 int	vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
164 int	vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
165 int	vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
166 int	vm_readwrite_kernemu_device(struct vmctx *ctx, int vcpu,
167 	    vm_paddr_t gpa, bool write, int size, uint64_t *value);
168 int	vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
169 int	vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
170 int	vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
171 int	vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq,
172 	    enum vm_intr_trigger trigger);
173 int	vm_inject_nmi(struct vmctx *ctx, int vcpu);
174 int	vm_capability_name2type(const char *capname);
175 const char *vm_capability_type2name(int type);
176 int	vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
177 			  int *retval);
178 int	vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
179 			  int val);
180 int	vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
181 int	vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
182 int	vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
183 			   vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
184 int	vm_unmap_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
185 			     vm_paddr_t gpa, size_t len);
186 int	vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot,
187 	    int func, uint64_t addr, uint64_t msg, int numvec);
188 int	vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot,
189 	    int func, int idx, uint64_t addr, uint64_t msg,
190 	    uint32_t vector_control);
191 int	vm_disable_pptdev_msix(struct vmctx *ctx, int bus, int slot, int func);
192 
193 int	vm_get_intinfo(struct vmctx *ctx, int vcpu, uint64_t *i1, uint64_t *i2);
194 int	vm_set_intinfo(struct vmctx *ctx, int vcpu, uint64_t exit_intinfo);
195 
196 const cap_ioctl_t *vm_get_ioctls(size_t *len);
197 
198 /*
199  * Return a pointer to the statistics buffer. Note that this is not MT-safe.
200  */
201 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv,
202 		       int *ret_entries);
203 const char *vm_get_stat_desc(struct vmctx *ctx, int index);
204 
205 int	vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s);
206 int	vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s);
207 
208 int	vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
209 
210 /*
211  * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'.
212  * The 'iovcnt' should be big enough to accommodate all GPA segments.
213  *
214  * retval	fault		Interpretation
215  *   0		  0		Success
216  *   0		  1		An exception was injected into the guest
217  * EFAULT	 N/A		Error
218  */
219 int	vm_copy_setup(struct vmctx *ctx, int vcpu, struct vm_guest_paging *pg,
220 	    uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt,
221 	    int *fault);
222 void	vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov,
223 	    void *host_dst, size_t len);
224 void	vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src,
225 	    struct iovec *guest_iov, size_t len);
226 void	vm_copy_teardown(struct vmctx *ctx, int vcpu, struct iovec *iov,
227 	    int iovcnt);
228 
229 /* RTC */
230 int	vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value);
231 int	vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval);
232 int	vm_rtc_settime(struct vmctx *ctx, time_t secs);
233 int	vm_rtc_gettime(struct vmctx *ctx, time_t *secs);
234 
235 /* Reset vcpu register state */
236 int	vcpu_reset(struct vmctx *ctx, int vcpu);
237 
238 int	vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus);
239 int	vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus);
240 int	vm_debug_cpus(struct vmctx *ctx, cpuset_t *cpus);
241 int	vm_activate_cpu(struct vmctx *ctx, int vcpu);
242 int	vm_suspend_cpu(struct vmctx *ctx, int vcpu);
243 int	vm_resume_cpu(struct vmctx *ctx, int vcpu);
244 
245 /* CPU topology */
246 int	vm_set_topology(struct vmctx *ctx, uint16_t sockets, uint16_t cores,
247 	    uint16_t threads, uint16_t maxcpus);
248 int	vm_get_topology(struct vmctx *ctx, uint16_t *sockets, uint16_t *cores,
249 	    uint16_t *threads, uint16_t *maxcpus);
250 
251 /*
252  * FreeBSD specific APIs
253  */
254 int	vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu,
255 				uint64_t rip, uint64_t cr3, uint64_t gdtbase,
256 				uint64_t rsp);
257 int	vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu,
258 					uint32_t eip, uint32_t gdtbase,
259 					uint32_t esp);
260 void	vm_setup_freebsd_gdt(uint64_t *gdtr);
261 
262 /*
263  * Save and restore
264  */
265 int	vm_snapshot_req(struct vm_snapshot_meta *meta);
266 int	vm_restore_time(struct vmctx *ctx);
267 
268 #endif	/* _VMMAPI_H_ */
269