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 struct vmctx; 33 enum x2apic_state; 34 35 int vm_create(const char *name); 36 struct vmctx *vm_open(const char *name); 37 void vm_destroy(struct vmctx *ctx); 38 size_t vmm_get_mem_total(void); 39 size_t vmm_get_mem_free(void); 40 int vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len); 41 /* 42 * Create a memory segment of 'len' bytes in the guest physical address space 43 * at offset 'gpa'. 44 * 45 * If 'mapaddr' is not NULL then this region is mmap'ed into the address 46 * space of the calling process. If there is an mmap error then *mapaddr 47 * will be set to MAP_FAILED. 48 */ 49 50 int vm_setup_memory(struct vmctx *ctx, vm_paddr_t gpa, size_t len, 51 char **mapaddr); 52 char * vm_map_memory(struct vmctx *ctx, vm_paddr_t gpa, size_t len); 53 int vm_set_desc(struct vmctx *ctx, int vcpu, int reg, 54 uint64_t base, uint32_t limit, uint32_t access); 55 int vm_get_desc(struct vmctx *ctx, int vcpu, int reg, 56 uint64_t *base, uint32_t *limit, uint32_t *access); 57 int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val); 58 int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval); 59 int vm_get_pinning(struct vmctx *ctx, int vcpu, int *host_cpuid); 60 int vm_set_pinning(struct vmctx *ctx, int vcpu, int host_cpuid); 61 int vm_run(struct vmctx *ctx, int vcpu, uint64_t rip, 62 struct vm_exit *ret_vmexit); 63 int vm_apicid2vcpu(struct vmctx *ctx, int apicid); 64 int vm_inject_event(struct vmctx *ctx, int vcpu, enum vm_event_type type, 65 int vector); 66 int vm_inject_event2(struct vmctx *ctx, int vcpu, enum vm_event_type type, 67 int vector, int error_code); 68 int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector); 69 int vm_inject_nmi(struct vmctx *ctx, int vcpu); 70 int vm_capability_name2type(const char *capname); 71 const char *vm_capability_type2name(int type); 72 int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 73 int *retval); 74 int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 75 int val); 76 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 77 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 78 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 79 vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 80 int vm_setup_msi(struct vmctx *ctx, int vcpu, int bus, int slot, int func, 81 int dest, int vector, int numvec); 82 int vm_setup_msix(struct vmctx *ctx, int vcpu, int bus, int slot, int func, 83 int idx, uint32_t msg, uint32_t vector_control, uint64_t addr); 84 85 /* 86 * Return a pointer to the statistics buffer. Note that this is not MT-safe. 87 */ 88 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv, 89 int *ret_entries); 90 const char *vm_get_stat_desc(struct vmctx *ctx, int index); 91 92 int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s); 93 int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s); 94 95 /* Reset vcpu register state */ 96 int vcpu_reset(struct vmctx *ctx, int vcpu); 97 98 /* 99 * FreeBSD specific APIs 100 */ 101 int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu, 102 uint64_t rip, uint64_t cr3, uint64_t gdtbase, 103 uint64_t rsp); 104 void vm_setup_freebsd_gdt(uint64_t *gdtr); 105 #endif /* _VMMAPI_H_ */ 106