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