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