vmmapi.h revision 270070
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: stable/10/lib/libvmmapi/vmmapi.h 270070 2014-08-17 00:52:07Z grehan $ 27 */ 28 29#ifndef _VMMAPI_H_ 30#define _VMMAPI_H_ 31 32#include <sys/param.h> 33#include <sys/cpuset.h> 34 35struct iovec; 36struct vmctx; 37enum x2apic_state; 38 39/* 40 * Different styles of mapping the memory assigned to a VM into the address 41 * space of the controlling process. 42 */ 43enum vm_mmap_style { 44 VM_MMAP_NONE, /* no mapping */ 45 VM_MMAP_ALL, /* fully and statically mapped */ 46 VM_MMAP_SPARSE, /* mappings created on-demand */ 47}; 48 49#define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */ 50 51int vm_create(const char *name); 52struct vmctx *vm_open(const char *name); 53void vm_destroy(struct vmctx *ctx); 54int vm_parse_memsize(const char *optarg, size_t *memsize); 55int vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len, 56 int *wired); 57int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s); 58void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len); 59int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num); 60uint32_t vm_get_lowmem_limit(struct vmctx *ctx); 61void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit); 62void vm_set_memflags(struct vmctx *ctx, int flags); 63int vm_set_desc(struct vmctx *ctx, int vcpu, int reg, 64 uint64_t base, uint32_t limit, uint32_t access); 65int vm_get_desc(struct vmctx *ctx, int vcpu, int reg, 66 uint64_t *base, uint32_t *limit, uint32_t *access); 67int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val); 68int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval); 69int vm_run(struct vmctx *ctx, int vcpu, uint64_t rip, 70 struct vm_exit *ret_vmexit); 71int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how); 72int vm_apicid2vcpu(struct vmctx *ctx, int apicid); 73int vm_inject_exception(struct vmctx *ctx, int vcpu, int vec); 74int vm_inject_exception2(struct vmctx *ctx, int vcpu, int vec, int errcode); 75int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector); 76int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector); 77int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg); 78int vm_ioapic_assert_irq(struct vmctx *ctx, int irq); 79int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq); 80int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq); 81int vm_ioapic_pincount(struct vmctx *ctx, int *pincount); 82int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 83int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 84int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq); 85int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq, 86 enum vm_intr_trigger trigger); 87int vm_inject_nmi(struct vmctx *ctx, int vcpu); 88int vm_capability_name2type(const char *capname); 89const char *vm_capability_type2name(int type); 90int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 91 int *retval); 92int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 93 int val); 94int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 95int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 96int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 97 vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 98int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot, 99 int func, uint64_t addr, uint64_t msg, int numvec); 100int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot, 101 int func, int idx, uint64_t addr, uint64_t msg, 102 uint32_t vector_control); 103 104/* 105 * Return a pointer to the statistics buffer. Note that this is not MT-safe. 106 */ 107uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv, 108 int *ret_entries); 109const char *vm_get_stat_desc(struct vmctx *ctx, int index); 110 111int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s); 112int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s); 113 114int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities); 115 116/* 117 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'. 118 * The 'iovcnt' should be big enough to accomodate all GPA segments. 119 * Returns 0 on success, 1 on a guest fault condition and -1 otherwise. 120 */ 121int vm_gla2gpa(struct vmctx *ctx, int vcpu, struct vm_guest_paging *paging, 122 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt); 123void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov, 124 void *host_dst, size_t len); 125void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src, 126 struct iovec *guest_iov, size_t len); 127 128/* Reset vcpu register state */ 129int vcpu_reset(struct vmctx *ctx, int vcpu); 130 131int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus); 132int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus); 133int vm_activate_cpu(struct vmctx *ctx, int vcpu); 134 135/* 136 * FreeBSD specific APIs 137 */ 138int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu, 139 uint64_t rip, uint64_t cr3, uint64_t gdtbase, 140 uint64_t rsp); 141int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu, 142 uint32_t eip, uint32_t gdtbase, 143 uint32_t esp); 144void vm_setup_freebsd_gdt(uint64_t *gdtr); 145#endif /* _VMMAPI_H_ */ 146