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