vmmapi.h revision 284894
1326941Sdim/*- 2326941Sdim * Copyright (c) 2011 NetApp, Inc. 3353358Sdim * All rights reserved. 4353358Sdim * 5353358Sdim * Redistribution and use in source and binary forms, with or without 6326941Sdim * modification, are permitted provided that the following conditions 7326941Sdim * are met: 8326941Sdim * 1. Redistributions of source code must retain the above copyright 9326941Sdim * notice, this list of conditions and the following disclaimer. 10326941Sdim * 2. Redistributions in binary form must reproduce the above copyright 11326941Sdim * notice, this list of conditions and the following disclaimer in the 12326941Sdim * documentation and/or other materials provided with the distribution. 13326941Sdim * 14326941Sdim * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 15326941Sdim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16326941Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17326941Sdim * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 18326941Sdim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19326941Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20326941Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21326941Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22326941Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23326941Sdim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24326941Sdim * SUCH DAMAGE. 25326941Sdim * 26326941Sdim * $FreeBSD: stable/10/lib/libvmmapi/vmmapi.h 284894 2015-06-27 22:48:22Z neel $ 27326941Sdim */ 28326941Sdim 29326941Sdim#ifndef _VMMAPI_H_ 30326941Sdim#define _VMMAPI_H_ 31326941Sdim 32326941Sdim#include <sys/param.h> 33326941Sdim#include <sys/cpuset.h> 34326941Sdim 35326941Sdim/* 36326941Sdim * API version for out-of-tree consumers like grub-bhyve for making compile 37326941Sdim * time decisions. 38326941Sdim */ 39326941Sdim#define VMMAPI_VERSION 0101 /* 2 digit major followed by 2 digit minor */ 40326941Sdim 41326941Sdimstruct iovec; 42326941Sdimstruct vmctx; 43326941Sdimenum x2apic_state; 44326941Sdim 45326941Sdim/* 46326941Sdim * Different styles of mapping the memory assigned to a VM into the address 47326941Sdim * space of the controlling process. 48326941Sdim */ 49326941Sdimenum vm_mmap_style { 50326941Sdim VM_MMAP_NONE, /* no mapping */ 51326941Sdim VM_MMAP_ALL, /* fully and statically mapped */ 52326941Sdim VM_MMAP_SPARSE, /* mappings created on-demand */ 53326941Sdim}; 54326941Sdim 55326941Sdim#define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */ 56326941Sdim 57326941Sdimint vm_create(const char *name); 58326941Sdimstruct vmctx *vm_open(const char *name); 59326941Sdimvoid vm_destroy(struct vmctx *ctx); 60326941Sdimint vm_parse_memsize(const char *optarg, size_t *memsize); 61326941Sdimint vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len, 62326941Sdim int *wired); 63326941Sdimint vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s); 64326941Sdimvoid *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len); 65326941Sdimint vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num); 66326941Sdimuint32_t vm_get_lowmem_limit(struct vmctx *ctx); 67326941Sdimvoid vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit); 68326941Sdimvoid vm_set_memflags(struct vmctx *ctx, int flags); 69326941Sdimsize_t vm_get_lowmem_size(struct vmctx *ctx); 70326941Sdimsize_t vm_get_highmem_size(struct vmctx *ctx); 71326941Sdimint vm_set_desc(struct vmctx *ctx, int vcpu, int reg, 72326941Sdim uint64_t base, uint32_t limit, uint32_t access); 73326941Sdimint vm_get_desc(struct vmctx *ctx, int vcpu, int reg, 74326941Sdim uint64_t *base, uint32_t *limit, uint32_t *access); 75326941Sdimint vm_get_seg_desc(struct vmctx *ctx, int vcpu, int reg, 76326941Sdim struct seg_desc *seg_desc); 77326941Sdimint vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val); 78326941Sdimint vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval); 79326941Sdimint vm_run(struct vmctx *ctx, int vcpu, struct vm_exit *ret_vmexit); 80326941Sdimint vm_suspend(struct vmctx *ctx, enum vm_suspend_how how); 81326941Sdimint vm_reinit(struct vmctx *ctx); 82326941Sdimint vm_apicid2vcpu(struct vmctx *ctx, int apicid); 83326941Sdimint vm_inject_exception(struct vmctx *ctx, int vcpu, int vector, 84326941Sdim int errcode_valid, uint32_t errcode, int restart_instruction); 85326941Sdimint vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector); 86326941Sdimint vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector); 87326941Sdimint vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg); 88326941Sdimint vm_ioapic_assert_irq(struct vmctx *ctx, int irq); 89326941Sdimint vm_ioapic_deassert_irq(struct vmctx *ctx, int irq); 90326941Sdimint vm_ioapic_pulse_irq(struct vmctx *ctx, int irq); 91326941Sdimint vm_ioapic_pincount(struct vmctx *ctx, int *pincount); 92326941Sdimint vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 93326941Sdimint vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 94int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 95int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq, 96 enum vm_intr_trigger trigger); 97int vm_inject_nmi(struct vmctx *ctx, int vcpu); 98int vm_capability_name2type(const char *capname); 99const char *vm_capability_type2name(int type); 100int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 101 int *retval); 102int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 103 int val); 104int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 105int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 106int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 107 vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 108int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot, 109 int func, uint64_t addr, uint64_t msg, int numvec); 110int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot, 111 int func, int idx, uint64_t addr, uint64_t msg, 112 uint32_t vector_control); 113 114int vm_get_intinfo(struct vmctx *ctx, int vcpu, uint64_t *i1, uint64_t *i2); 115int vm_set_intinfo(struct vmctx *ctx, int vcpu, uint64_t exit_intinfo); 116 117/* 118 * Return a pointer to the statistics buffer. Note that this is not MT-safe. 119 */ 120uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv, 121 int *ret_entries); 122const char *vm_get_stat_desc(struct vmctx *ctx, int index); 123 124int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s); 125int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s); 126 127int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities); 128 129/* 130 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'. 131 * The 'iovcnt' should be big enough to accomodate all GPA segments. 132 * Returns 0 on success, 1 on a guest fault condition and -1 otherwise. 133 */ 134int vm_copy_setup(struct vmctx *ctx, int vcpu, struct vm_guest_paging *pg, 135 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt); 136void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov, 137 void *host_dst, size_t len); 138void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src, 139 struct iovec *guest_iov, size_t len); 140void vm_copy_teardown(struct vmctx *ctx, int vcpu, struct iovec *iov, 141 int iovcnt); 142 143/* RTC */ 144int vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value); 145int vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval); 146int vm_rtc_settime(struct vmctx *ctx, time_t secs); 147int vm_rtc_gettime(struct vmctx *ctx, time_t *secs); 148 149/* Reset vcpu register state */ 150int vcpu_reset(struct vmctx *ctx, int vcpu); 151 152int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus); 153int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus); 154int vm_activate_cpu(struct vmctx *ctx, int vcpu); 155 156/* 157 * FreeBSD specific APIs 158 */ 159int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu, 160 uint64_t rip, uint64_t cr3, uint64_t gdtbase, 161 uint64_t rsp); 162int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu, 163 uint32_t eip, uint32_t gdtbase, 164 uint32_t esp); 165void vm_setup_freebsd_gdt(uint64_t *gdtr); 166#endif /* _VMMAPI_H_ */ 167