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