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 vm_paddr_t vm_get_highmem_base(struct vmctx *ctx); 184 size_t vm_get_highmem_size(struct vmctx *ctx); 185 int vm_set_desc(struct vcpu *vcpu, int reg, 186 uint64_t base, uint32_t limit, uint32_t access); 187 int vm_get_desc(struct vcpu *vcpu, int reg, 188 uint64_t *base, uint32_t *limit, uint32_t *access); 189 int vm_get_seg_desc(struct vcpu *vcpu, int reg, struct seg_desc *seg_desc); 190 int vm_set_register(struct vcpu *vcpu, int reg, uint64_t val); 191 int vm_get_register(struct vcpu *vcpu, int reg, uint64_t *retval); 192 int vm_set_register_set(struct vcpu *vcpu, unsigned int count, 193 const int *regnums, uint64_t *regvals); 194 int vm_get_register_set(struct vcpu *vcpu, unsigned int count, 195 const int *regnums, uint64_t *regvals); 196 #ifdef __FreeBSD__ 197 int vm_run(struct vcpu *vcpu, struct vm_exit *ret_vmexit); 198 #else 199 int vm_run(struct vcpu *vcpu, const struct vm_entry *vm_entry, 200 struct vm_exit *vm_exit); 201 #endif 202 int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how); 203 #ifdef __FreeBSD__ 204 int vm_reinit(struct vmctx *ctx); 205 #else 206 int vm_reinit(struct vmctx *ctx, uint64_t); 207 #endif 208 int vm_apicid2vcpu(struct vmctx *ctx, int apicid); 209 int vm_inject_exception(struct vcpu *vcpu, int vector, 210 int errcode_valid, uint32_t errcode, int restart_instruction); 211 #ifndef __FreeBSD__ 212 void vm_inject_fault(struct vcpu *vcpu, int vector, 213 int errcode_valid, int errcode); 214 215 static __inline void 216 vm_inject_gp(struct vcpu *vcpu) 217 { 218 vm_inject_fault(vcpu, IDT_GP, 1, 0); 219 } 220 221 static __inline void 222 vm_inject_ac(struct vcpu *vcpu, int errcode) 223 { 224 vm_inject_fault(vcpu, IDT_AC, 1, errcode); 225 } 226 static __inline void 227 vm_inject_ss(struct vcpu *vcpu, int errcode) 228 { 229 vm_inject_fault(vcpu, IDT_SS, 1, errcode); 230 } 231 #endif 232 int vm_lapic_irq(struct vcpu *vcpu, int vector); 233 int vm_lapic_local_irq(struct vcpu *vcpu, int vector); 234 int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg); 235 int vm_ioapic_assert_irq(struct vmctx *ctx, int irq); 236 int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq); 237 int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq); 238 int vm_ioapic_pincount(struct vmctx *ctx, int *pincount); 239 int vm_readwrite_kernemu_device(struct vcpu *vcpu, 240 vm_paddr_t gpa, bool write, int size, uint64_t *value); 241 int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 242 int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 243 int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 244 int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq, 245 enum vm_intr_trigger trigger); 246 int vm_inject_nmi(struct vcpu *vcpu); 247 int vm_capability_name2type(const char *capname); 248 const char *vm_capability_type2name(int type); 249 int vm_get_capability(struct vcpu *vcpu, enum vm_cap_type cap, 250 int *retval); 251 int vm_set_capability(struct vcpu *vcpu, enum vm_cap_type cap, 252 int val); 253 #ifdef __FreeBSD__ 254 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 255 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 256 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 257 vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 258 int vm_unmap_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 259 vm_paddr_t gpa, size_t len); 260 int vm_setup_pptdev_msi(struct vmctx *ctx, int bus, int slot, 261 int func, uint64_t addr, uint64_t msg, int numvec); 262 int vm_setup_pptdev_msix(struct vmctx *ctx, int bus, int slot, 263 int func, int idx, uint64_t addr, uint64_t msg, 264 uint32_t vector_control); 265 int vm_disable_pptdev_msix(struct vmctx *ctx, int bus, int slot, int func); 266 #else /* __FreeBSD__ */ 267 int vm_assign_pptdev(struct vmctx *ctx, int pptfd); 268 int vm_unassign_pptdev(struct vmctx *ctx, int pptfd); 269 int vm_map_pptdev_mmio(struct vmctx *ctx, int pptfd, vm_paddr_t gpa, 270 size_t len, vm_paddr_t hpa); 271 int vm_unmap_pptdev_mmio(struct vmctx *ctx, int pptfd, vm_paddr_t gpa, 272 size_t len); 273 int vm_setup_pptdev_msi(struct vmctx *ctx, int pptfd, uint64_t addr, 274 uint64_t msg, int numvec); 275 int vm_setup_pptdev_msix(struct vmctx *ctx, int pptfd, int idx, uint64_t 276 addr, uint64_t msg, uint32_t vector_control); 277 int vm_disable_pptdev_msix(struct vmctx *ctx, int pptfd); 278 int vm_get_pptdev_limits(struct vmctx *ctx, int pptfd, int *msi_limit, 279 int *msix_limit); 280 #endif /* __FreeBSD__ */ 281 282 int vm_get_intinfo(struct vcpu *vcpu, uint64_t *i1, uint64_t *i2); 283 int vm_set_intinfo(struct vcpu *vcpu, uint64_t exit_intinfo); 284 285 /* 286 * Return a pointer to the statistics buffer. Note that this is not MT-safe. 287 */ 288 uint64_t *vm_get_stats(struct vcpu *vcpu, struct timeval *ret_tv, 289 int *ret_entries); 290 const char *vm_get_stat_desc(struct vmctx *ctx, int index); 291 292 int vm_get_x2apic_state(struct vcpu *vcpu, enum x2apic_state *s); 293 int vm_set_x2apic_state(struct vcpu *vcpu, enum x2apic_state s); 294 295 int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities); 296 297 /* 298 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'. 299 * The 'iovcnt' should be big enough to accommodate all GPA segments. 300 * 301 * retval fault Interpretation 302 * 0 0 Success 303 * 0 1 An exception was injected into the guest 304 * EFAULT N/A Error 305 */ 306 int vm_copy_setup(struct vcpu *vcpu, struct vm_guest_paging *pg, 307 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt, 308 int *fault); 309 void vm_copyin(struct iovec *guest_iov, void *host_dst, size_t len); 310 void vm_copyout(const void *host_src, struct iovec *guest_iov, size_t len); 311 void vm_copy_teardown(struct iovec *iov, int iovcnt); 312 313 /* RTC */ 314 int vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value); 315 int vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval); 316 #ifdef __FreeBSD__ 317 int vm_rtc_settime(struct vmctx *ctx, time_t secs); 318 int vm_rtc_gettime(struct vmctx *ctx, time_t *secs); 319 #else /* __FreeBSD__ */ 320 int vm_rtc_settime(struct vmctx *ctx, const timespec_t *); 321 int vm_rtc_gettime(struct vmctx *ctx, timespec_t *); 322 #endif /* __FreeBSD__ */ 323 324 /* Reset vcpu register state */ 325 int vcpu_reset(struct vcpu *vcpu); 326 327 int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus); 328 #ifdef __FreeBSD__ 329 int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus); 330 #endif /* __FreeBSD__ */ 331 int vm_debug_cpus(struct vmctx *ctx, cpuset_t *cpus); 332 int vm_activate_cpu(struct vcpu *vcpu); 333 int vm_suspend_all_cpus(struct vmctx *ctx); 334 int vm_suspend_cpu(struct vcpu *vcpu); 335 int vm_resume_all_cpus(struct vmctx *ctx); 336 int vm_resume_cpu(struct vcpu *vcpu); 337 338 /* CPU topology */ 339 int vm_set_topology(struct vmctx *ctx, uint16_t sockets, uint16_t cores, 340 uint16_t threads, uint16_t maxcpus); 341 int vm_get_topology(struct vmctx *ctx, uint16_t *sockets, uint16_t *cores, 342 uint16_t *threads, uint16_t *maxcpus); 343 344 #ifndef __FreeBSD__ 345 /* illumos-specific APIs */ 346 int vm_pmtmr_set_location(struct vmctx *ctx, uint16_t ioport); 347 int vm_wrlock_cycle(struct vmctx *ctx); 348 int vm_get_run_state(struct vcpu *vcpu, enum vcpu_run_state *state, 349 uint8_t *sipi_vector); 350 int vm_set_run_state(struct vcpu *vcpu, enum vcpu_run_state state, 351 uint8_t sipi_vector); 352 int vm_vcpu_barrier(struct vcpu *vcpu); 353 #endif /* __FreeBSD__ */ 354 355 #ifdef __FreeBSD__ 356 /* 357 * FreeBSD specific APIs 358 */ 359 int vm_setup_freebsd_registers(struct vcpu *vcpu, 360 uint64_t rip, uint64_t cr3, uint64_t gdtbase, 361 uint64_t rsp); 362 int vm_setup_freebsd_registers_i386(struct vcpu *vcpu, 363 uint32_t eip, uint32_t gdtbase, 364 uint32_t esp); 365 void vm_setup_freebsd_gdt(uint64_t *gdtr); 366 #endif 367 368 /* 369 * Deprecated interfaces, do not use them in new code. 370 */ 371 int vm_get_device_fd(struct vmctx *ctx); 372 #ifdef __FreeBSD__ 373 const cap_ioctl_t *vm_get_ioctls(size_t *len); 374 #endif 375 376 #ifdef __cplusplus 377 } 378 #endif 379 380 #endif /* _VMMAPI_H_ */ 381