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