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