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 */ 43 44 #ifndef _VMMAPI_H_ 45 #define _VMMAPI_H_ 46 47 #include <sys/param.h> 48 #include <sys/cpuset.h> 49 #include <x86/segments.h> 50 51 #include <stdbool.h> 52 53 /* 54 * API version for out-of-tree consumers like grub-bhyve for making compile 55 * time decisions. 56 */ 57 #define VMMAPI_VERSION 0103 /* 2 digit major followed by 2 digit minor */ 58 59 struct iovec; 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 }; 94 95 /* 96 * Get the length and name of the memory segment identified by 'segid'. 97 * Note that system memory segments are identified with a nul name. 98 * 99 * Returns 0 on success and non-zero otherwise. 100 */ 101 int vm_get_memseg(struct vmctx *ctx, int ident, size_t *lenp, char *name, 102 size_t namesiz); 103 104 /* 105 * Iterate over the guest address space. This function finds an address range 106 * that starts at an address >= *gpa. 107 * 108 * Returns 0 if the next address range was found and non-zero otherwise. 109 */ 110 int vm_mmap_getnext(struct vmctx *ctx, vm_paddr_t *gpa, int *segid, 111 vm_ooffset_t *segoff, size_t *len, int *prot, int *flags); 112 /* 113 * Create a device memory segment identified by 'segid'. 114 * 115 * Returns a pointer to the memory segment on success and MAP_FAILED otherwise. 116 */ 117 void *vm_create_devmem(struct vmctx *ctx, int segid, const char *name, 118 size_t len); 119 120 #ifndef __FreeBSD__ 121 /* 122 * Return the map offset for the device memory segment 'segid'. 123 */ 124 int vm_get_devmem_offset(struct vmctx *ctx, int segid, off_t *mapoff); 125 #endif 126 127 /* 128 * Map the memory segment identified by 'segid' into the guest address space 129 * at [gpa,gpa+len) with protection 'prot'. 130 */ 131 int vm_mmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, int segid, 132 vm_ooffset_t segoff, size_t len, int prot); 133 134 int vm_create(const char *name); 135 int vm_get_device_fd(struct vmctx *ctx); 136 struct vmctx *vm_open(const char *name); 137 #ifndef __FreeBSD__ 138 void vm_close(struct vmctx *ctx); 139 #endif 140 void vm_destroy(struct vmctx *ctx); 141 int vm_parse_memsize(const char *optarg, size_t *memsize); 142 int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s); 143 void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len); 144 int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num); 145 int vm_gla2gpa(struct vmctx *, int vcpuid, struct vm_guest_paging *paging, 146 uint64_t gla, int prot, uint64_t *gpa, int *fault); 147 int vm_gla2gpa_nofault(struct vmctx *, int vcpuid, 148 struct vm_guest_paging *paging, uint64_t gla, int prot, 149 uint64_t *gpa, int *fault); 150 uint32_t vm_get_lowmem_limit(struct vmctx *ctx); 151 void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit); 152 void vm_set_memflags(struct vmctx *ctx, int flags); 153 int vm_get_memflags(struct vmctx *ctx); 154 size_t vm_get_lowmem_size(struct vmctx *ctx); 155 size_t vm_get_highmem_size(struct vmctx *ctx); 156 int vm_set_desc(struct vmctx *ctx, int vcpu, int reg, 157 uint64_t base, uint32_t limit, uint32_t access); 158 int vm_get_desc(struct vmctx *ctx, int vcpu, int reg, 159 uint64_t *base, uint32_t *limit, uint32_t *access); 160 int vm_get_seg_desc(struct vmctx *ctx, int vcpu, int reg, 161 struct seg_desc *seg_desc); 162 int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val); 163 int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval); 164 int vm_set_register_set(struct vmctx *ctx, int vcpu, unsigned int count, 165 const int *regnums, uint64_t *regvals); 166 int vm_get_register_set(struct vmctx *ctx, int vcpu, unsigned int count, 167 const int *regnums, uint64_t *regvals); 168 int vm_run(struct vmctx *ctx, int vcpu, const struct vm_entry *vm_entry, 169 struct vm_exit *vm_exit); 170 int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how); 171 int vm_reinit(struct vmctx *ctx); 172 int vm_apicid2vcpu(struct vmctx *ctx, int apicid); 173 int vm_inject_exception(struct vmctx *ctx, int vcpu, int vector, 174 int errcode_valid, uint32_t errcode, int restart_instruction); 175 #ifndef __FreeBSD__ 176 void vm_inject_fault(struct vmctx *ctx, int vcpu, int vector, 177 int errcode_valid, int errcode); 178 179 static __inline void 180 vm_inject_gp(struct vmctx *ctx, int vcpuid) 181 { 182 vm_inject_fault(ctx, vcpuid, IDT_GP, 1, 0); 183 } 184 185 static __inline void 186 vm_inject_ac(struct vmctx *ctx, int vcpuid, int errcode) 187 { 188 vm_inject_fault(ctx, vcpuid, IDT_AC, 1, errcode); 189 } 190 static __inline void 191 vm_inject_ss(struct vmctx *ctx, int vcpuid, int errcode) 192 { 193 vm_inject_fault(ctx, vcpuid, IDT_SS, 1, errcode); 194 } 195 #endif 196 int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector); 197 int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector); 198 int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg); 199 int vm_ioapic_assert_irq(struct vmctx *ctx, int irq); 200 int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq); 201 int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq); 202 int vm_ioapic_pincount(struct vmctx *ctx, int *pincount); 203 int vm_readwrite_kernemu_device(struct vmctx *ctx, int vcpu, 204 vm_paddr_t gpa, bool write, int size, uint64_t *value); 205 int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 206 int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 207 int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 208 int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq, 209 enum vm_intr_trigger trigger); 210 int vm_inject_nmi(struct vmctx *ctx, int vcpu); 211 int vm_capability_name2type(const char *capname); 212 const char *vm_capability_type2name(int type); 213 int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 214 int *retval); 215 int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 216 int val); 217 #ifdef __FreeBSD__ 218 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 219 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 220 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 221 vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 222 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot, 223 int func, uint64_t addr, uint64_t msg, int numvec); 224 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot, 225 int func, int idx, uint64_t addr, uint64_t msg, 226 uint32_t vector_control); 227 int vm_get_pptdev_limits(struct vmctx *ctx, int bus, int slot, int func, 228 int *msi_limit, int *msix_limit); 229 #else /* __FreeBSD__ */ 230 int vm_assign_pptdev(struct vmctx *ctx, int pptfd); 231 int vm_unassign_pptdev(struct vmctx *ctx, int pptfd); 232 int vm_map_pptdev_mmio(struct vmctx *ctx, int pptfd, vm_paddr_t gpa, 233 size_t len, vm_paddr_t hpa); 234 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int pptfd, 235 uint64_t addr, uint64_t msg, int numvec); 236 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int pptfd, 237 int idx, uint64_t addr, uint64_t msg, uint32_t vector_control); 238 int vm_get_pptdev_limits(struct vmctx *ctx, int pptfd, int *msi_limit, 239 int *msix_limit); 240 #endif /* __FreeBSD__ */ 241 242 int vm_get_intinfo(struct vmctx *ctx, int vcpu, uint64_t *i1, uint64_t *i2); 243 int vm_set_intinfo(struct vmctx *ctx, int vcpu, uint64_t exit_intinfo); 244 245 #ifdef __FreeBSD__ 246 const cap_ioctl_t *vm_get_ioctls(size_t *len); 247 #endif 248 249 /* 250 * Return a pointer to the statistics buffer. Note that this is not MT-safe. 251 */ 252 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv, 253 int *ret_entries); 254 const char *vm_get_stat_desc(struct vmctx *ctx, int index); 255 256 int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s); 257 int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s); 258 259 int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities); 260 261 /* 262 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'. 263 * The 'iovcnt' should be big enough to accommodate all GPA segments. 264 * 265 * retval fault Interpretation 266 * 0 0 Success 267 * 0 1 An exception was injected into the guest 268 * EFAULT N/A Error 269 */ 270 int vm_copy_setup(struct vmctx *ctx, int vcpu, struct vm_guest_paging *pg, 271 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt, 272 int *fault); 273 void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov, 274 void *host_dst, size_t len); 275 void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src, 276 struct iovec *guest_iov, size_t len); 277 void vm_copy_teardown(struct vmctx *ctx, int vcpu, struct iovec *iov, 278 int iovcnt); 279 280 /* RTC */ 281 int vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value); 282 int vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval); 283 int vm_rtc_settime(struct vmctx *ctx, time_t secs); 284 int vm_rtc_gettime(struct vmctx *ctx, time_t *secs); 285 286 /* Reset vcpu register state */ 287 int vcpu_reset(struct vmctx *ctx, int vcpu); 288 289 int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus); 290 int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus); 291 int vm_debug_cpus(struct vmctx *ctx, cpuset_t *cpus); 292 int vm_activate_cpu(struct vmctx *ctx, int vcpu); 293 int vm_suspend_cpu(struct vmctx *ctx, int vcpu); 294 int vm_resume_cpu(struct vmctx *ctx, int vcpu); 295 296 /* CPU topology */ 297 int vm_set_topology(struct vmctx *ctx, uint16_t sockets, uint16_t cores, 298 uint16_t threads, uint16_t maxcpus); 299 int vm_get_topology(struct vmctx *ctx, uint16_t *sockets, uint16_t *cores, 300 uint16_t *threads, uint16_t *maxcpus); 301 302 #ifndef __FreeBSD__ 303 /* illumos-specific APIs */ 304 int vm_wrlock_cycle(struct vmctx *ctx); 305 #endif /* __FreeBSD__ */ 306 307 #ifdef __FreeBSD__ 308 /* 309 * FreeBSD specific APIs 310 */ 311 int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu, 312 uint64_t rip, uint64_t cr3, uint64_t gdtbase, 313 uint64_t rsp); 314 int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu, 315 uint32_t eip, uint32_t gdtbase, 316 uint32_t esp); 317 void vm_setup_freebsd_gdt(uint64_t *gdtr); 318 #endif 319 #endif /* _VMMAPI_H_ */ 320