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 0101 /* 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 #define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */ 56 57 int vm_create(const char *name); 58 struct vmctx *vm_open(const char *name); 59 void vm_destroy(struct vmctx *ctx); 60 int vm_parse_memsize(const char *optarg, size_t *memsize); 61 int vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len, 62 int *wired); 63 int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s); 64 void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len); 65 int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num); 66 int vm_gla2gpa(struct vmctx *, int vcpuid, struct vm_guest_paging *paging, 67 uint64_t gla, int prot, uint64_t *gpa); 68 uint32_t vm_get_lowmem_limit(struct vmctx *ctx); 69 void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit); 70 void vm_set_memflags(struct vmctx *ctx, int flags); 71 size_t vm_get_lowmem_size(struct vmctx *ctx); 72 size_t vm_get_highmem_size(struct vmctx *ctx); 73 int vm_set_desc(struct vmctx *ctx, int vcpu, int reg, 74 uint64_t base, uint32_t limit, uint32_t access); 75 int vm_get_desc(struct vmctx *ctx, int vcpu, int reg, 76 uint64_t *base, uint32_t *limit, uint32_t *access); 77 int vm_get_seg_desc(struct vmctx *ctx, int vcpu, int reg, 78 struct seg_desc *seg_desc); 79 int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val); 80 int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval); 81 int vm_run(struct vmctx *ctx, int vcpu, struct vm_exit *ret_vmexit); 82 int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how); 83 int vm_reinit(struct vmctx *ctx); 84 int vm_apicid2vcpu(struct vmctx *ctx, int apicid); 85 int vm_inject_exception(struct vmctx *ctx, int vcpu, int vector, 86 int errcode_valid, uint32_t errcode, int restart_instruction); 87 int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector); 88 int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector); 89 int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg); 90 int vm_ioapic_assert_irq(struct vmctx *ctx, int irq); 91 int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq); 92 int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq); 93 int vm_ioapic_pincount(struct vmctx *ctx, int *pincount); 94 int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 95 int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 96 int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 97 int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq, 98 enum vm_intr_trigger trigger); 99 int vm_inject_nmi(struct vmctx *ctx, int vcpu); 100 int vm_capability_name2type(const char *capname); 101 const char *vm_capability_type2name(int type); 102 int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 103 int *retval); 104 int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 105 int val); 106 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 107 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 108 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 109 vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 110 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot, 111 int func, uint64_t addr, uint64_t msg, int numvec); 112 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot, 113 int func, int idx, uint64_t addr, uint64_t msg, 114 uint32_t vector_control); 115 116 int vm_get_intinfo(struct vmctx *ctx, int vcpu, uint64_t *i1, uint64_t *i2); 117 int vm_set_intinfo(struct vmctx *ctx, int vcpu, uint64_t exit_intinfo); 118 119 /* 120 * Return a pointer to the statistics buffer. Note that this is not MT-safe. 121 */ 122 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv, 123 int *ret_entries); 124 const char *vm_get_stat_desc(struct vmctx *ctx, int index); 125 126 int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s); 127 int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s); 128 129 int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities); 130 131 /* 132 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'. 133 * The 'iovcnt' should be big enough to accomodate all GPA segments. 134 * Returns 0 on success, 1 on a guest fault condition and -1 otherwise. 135 */ 136 int vm_copy_setup(struct vmctx *ctx, int vcpu, struct vm_guest_paging *pg, 137 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt); 138 void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov, 139 void *host_dst, size_t len); 140 void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src, 141 struct iovec *guest_iov, size_t len); 142 void vm_copy_teardown(struct vmctx *ctx, int vcpu, struct iovec *iov, 143 int iovcnt); 144 145 /* RTC */ 146 int vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value); 147 int vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval); 148 int vm_rtc_settime(struct vmctx *ctx, time_t secs); 149 int vm_rtc_gettime(struct vmctx *ctx, time_t *secs); 150 151 /* Reset vcpu register state */ 152 int vcpu_reset(struct vmctx *ctx, int vcpu); 153 154 int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus); 155 int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus); 156 int vm_activate_cpu(struct vmctx *ctx, int vcpu); 157 158 /* 159 * FreeBSD specific APIs 160 */ 161 int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu, 162 uint64_t rip, uint64_t cr3, uint64_t gdtbase, 163 uint64_t rsp); 164 int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu, 165 uint32_t eip, uint32_t gdtbase, 166 uint32_t esp); 167 void vm_setup_freebsd_gdt(uint64_t *gdtr); 168 #endif /* _VMMAPI_H_ */ 169