1 /*- 2 * Copyright (c) 2011 NetApp, Inc. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #ifndef _VMMAPI_H_ 30 #define _VMMAPI_H_ 31 32 #include <sys/param.h> 33 #include <sys/cpuset.h> 34 35 /* 36 * API version for out-of-tree consumers like grub-bhyve for making compile 37 * time decisions. 38 */ 39 #define VMMAPI_VERSION 0102 /* 2 digit major followed by 2 digit minor */ 40 41 struct iovec; 42 struct vmctx; 43 enum x2apic_state; 44 45 /* 46 * Different styles of mapping the memory assigned to a VM into the address 47 * space of the controlling process. 48 */ 49 enum vm_mmap_style { 50 VM_MMAP_NONE, /* no mapping */ 51 VM_MMAP_ALL, /* fully and statically mapped */ 52 VM_MMAP_SPARSE, /* mappings created on-demand */ 53 }; 54 55 /* 56 * 'flags' value passed to 'vm_set_memflags()'. 57 */ 58 #define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */ 59 #define VM_MEM_F_WIRED 0x02 /* guest memory is wired */ 60 61 /* 62 * Identifiers for memory segments: 63 * - vm_setup_memory() uses VM_SYSMEM for the system memory segment. 64 * - the remaining identifiers can be used to create devmem segments. 65 */ 66 enum { 67 VM_SYSMEM, 68 VM_BOOTROM, 69 VM_FRAMEBUFFER, 70 }; 71 72 /* 73 * Get the length and name of the memory segment identified by 'segid'. 74 * Note that system memory segments are identified with a nul name. 75 * 76 * Returns 0 on success and non-zero otherwise. 77 */ 78 int vm_get_memseg(struct vmctx *ctx, int ident, size_t *lenp, char *name, 79 size_t namesiz); 80 81 /* 82 * Iterate over the guest address space. This function finds an address range 83 * that starts at an address >= *gpa. 84 * 85 * Returns 0 if the next address range was found and non-zero otherwise. 86 */ 87 int vm_mmap_getnext(struct vmctx *ctx, vm_paddr_t *gpa, int *segid, 88 vm_ooffset_t *segoff, size_t *len, int *prot, int *flags); 89 /* 90 * Create a device memory segment identified by 'segid'. 91 * 92 * Returns a pointer to the memory segment on success and MAP_FAILED otherwise. 93 */ 94 void *vm_create_devmem(struct vmctx *ctx, int segid, const char *name, 95 size_t len); 96 97 /* 98 * Map the memory segment identified by 'segid' into the guest address space 99 * at [gpa,gpa+len) with protection 'prot'. 100 */ 101 int vm_mmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, int segid, 102 vm_ooffset_t segoff, size_t len, int prot); 103 104 int vm_create(const char *name); 105 struct vmctx *vm_open(const char *name); 106 void vm_destroy(struct vmctx *ctx); 107 int vm_parse_memsize(const char *optarg, size_t *memsize); 108 int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s); 109 void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len); 110 int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num); 111 int vm_gla2gpa(struct vmctx *, int vcpuid, struct vm_guest_paging *paging, 112 uint64_t gla, int prot, uint64_t *gpa, int *fault); 113 uint32_t vm_get_lowmem_limit(struct vmctx *ctx); 114 void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit); 115 void vm_set_memflags(struct vmctx *ctx, int flags); 116 int vm_get_memflags(struct vmctx *ctx); 117 size_t vm_get_lowmem_size(struct vmctx *ctx); 118 size_t vm_get_highmem_size(struct vmctx *ctx); 119 int vm_set_desc(struct vmctx *ctx, int vcpu, int reg, 120 uint64_t base, uint32_t limit, uint32_t access); 121 int vm_get_desc(struct vmctx *ctx, int vcpu, int reg, 122 uint64_t *base, uint32_t *limit, uint32_t *access); 123 int vm_get_seg_desc(struct vmctx *ctx, int vcpu, int reg, 124 struct seg_desc *seg_desc); 125 int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val); 126 int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval); 127 int vm_run(struct vmctx *ctx, int vcpu, struct vm_exit *ret_vmexit); 128 int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how); 129 int vm_reinit(struct vmctx *ctx); 130 int vm_apicid2vcpu(struct vmctx *ctx, int apicid); 131 int vm_inject_exception(struct vmctx *ctx, int vcpu, int vector, 132 int errcode_valid, uint32_t errcode, int restart_instruction); 133 int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector); 134 int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector); 135 int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg); 136 int vm_ioapic_assert_irq(struct vmctx *ctx, int irq); 137 int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq); 138 int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq); 139 int vm_ioapic_pincount(struct vmctx *ctx, int *pincount); 140 int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 141 int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 142 int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 143 int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq, 144 enum vm_intr_trigger trigger); 145 int vm_inject_nmi(struct vmctx *ctx, int vcpu); 146 int vm_capability_name2type(const char *capname); 147 const char *vm_capability_type2name(int type); 148 int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 149 int *retval); 150 int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 151 int val); 152 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 153 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 154 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 155 vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 156 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot, 157 int func, uint64_t addr, uint64_t msg, int numvec); 158 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot, 159 int func, int idx, uint64_t addr, uint64_t msg, 160 uint32_t vector_control); 161 162 int vm_get_intinfo(struct vmctx *ctx, int vcpu, uint64_t *i1, uint64_t *i2); 163 int vm_set_intinfo(struct vmctx *ctx, int vcpu, uint64_t exit_intinfo); 164 165 /* 166 * Return a pointer to the statistics buffer. Note that this is not MT-safe. 167 */ 168 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv, 169 int *ret_entries); 170 const char *vm_get_stat_desc(struct vmctx *ctx, int index); 171 172 int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s); 173 int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s); 174 175 int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities); 176 177 /* 178 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'. 179 * The 'iovcnt' should be big enough to accomodate all GPA segments. 180 * 181 * retval fault Interpretation 182 * 0 0 Success 183 * 0 1 An exception was injected into the guest 184 * EFAULT N/A Error 185 */ 186 int vm_copy_setup(struct vmctx *ctx, int vcpu, struct vm_guest_paging *pg, 187 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt, 188 int *fault); 189 void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov, 190 void *host_dst, size_t len); 191 void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src, 192 struct iovec *guest_iov, size_t len); 193 void vm_copy_teardown(struct vmctx *ctx, int vcpu, struct iovec *iov, 194 int iovcnt); 195 196 /* RTC */ 197 int vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value); 198 int vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval); 199 int vm_rtc_settime(struct vmctx *ctx, time_t secs); 200 int vm_rtc_gettime(struct vmctx *ctx, time_t *secs); 201 202 /* Reset vcpu register state */ 203 int vcpu_reset(struct vmctx *ctx, int vcpu); 204 205 int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus); 206 int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus); 207 int vm_activate_cpu(struct vmctx *ctx, int vcpu); 208 209 /* 210 * FreeBSD specific APIs 211 */ 212 int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu, 213 uint64_t rip, uint64_t cr3, uint64_t gdtbase, 214 uint64_t rsp); 215 int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu, 216 uint32_t eip, uint32_t gdtbase, 217 uint32_t esp); 218 void vm_setup_freebsd_gdt(uint64_t *gdtr); 219 #endif /* _VMMAPI_H_ */ 220