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