vmmapi.h revision 241486
1221828Sgrehan/*- 2221828Sgrehan * Copyright (c) 2011 NetApp, Inc. 3221828Sgrehan * All rights reserved. 4221828Sgrehan * 5221828Sgrehan * Redistribution and use in source and binary forms, with or without 6221828Sgrehan * modification, are permitted provided that the following conditions 7221828Sgrehan * are met: 8221828Sgrehan * 1. Redistributions of source code must retain the above copyright 9221828Sgrehan * notice, this list of conditions and the following disclaimer. 10221828Sgrehan * 2. Redistributions in binary form must reproduce the above copyright 11221828Sgrehan * notice, this list of conditions and the following disclaimer in the 12221828Sgrehan * documentation and/or other materials provided with the distribution. 13221828Sgrehan * 14221828Sgrehan * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 15221828Sgrehan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16221828Sgrehan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17221828Sgrehan * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 18221828Sgrehan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19221828Sgrehan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20221828Sgrehan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21221828Sgrehan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22221828Sgrehan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23221828Sgrehan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24221828Sgrehan * SUCH DAMAGE. 25221828Sgrehan * 26221828Sgrehan * $FreeBSD$ 27221828Sgrehan */ 28221828Sgrehan 29221828Sgrehan#ifndef _VMMAPI_H_ 30221828Sgrehan#define _VMMAPI_H_ 31221828Sgrehan 32221828Sgrehanstruct vmctx; 33240922Sneelenum x2apic_state; 34221828Sgrehan 35221828Sgrehanint vm_create(const char *name); 36221828Sgrehanstruct vmctx *vm_open(const char *name); 37221828Sgrehanvoid vm_destroy(struct vmctx *ctx); 38239700Sgrehansize_t vmm_get_mem_total(void); 39239700Sgrehansize_t vmm_get_mem_free(void); 40241179Sneelint vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len); 41221828Sgrehan/* 42221828Sgrehan * Create a memory segment of 'len' bytes in the guest physical address space 43221828Sgrehan * at offset 'gpa'. 44221828Sgrehan * 45221828Sgrehan * If 'mapaddr' is not NULL then this region is mmap'ed into the address 46221828Sgrehan * space of the calling process. If there is an mmap error then *mapaddr 47221828Sgrehan * will be set to MAP_FAILED. 48221828Sgrehan */ 49221828Sgrehan 50221828Sgrehanint vm_setup_memory(struct vmctx *ctx, vm_paddr_t gpa, size_t len, 51221828Sgrehan char **mapaddr); 52221828Sgrehanchar * vm_map_memory(struct vmctx *ctx, vm_paddr_t gpa, size_t len); 53221828Sgrehanint vm_set_desc(struct vmctx *ctx, int vcpu, int reg, 54221828Sgrehan uint64_t base, uint32_t limit, uint32_t access); 55221828Sgrehanint vm_get_desc(struct vmctx *ctx, int vcpu, int reg, 56221828Sgrehan uint64_t *base, uint32_t *limit, uint32_t *access); 57221828Sgrehanint vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val); 58221828Sgrehanint vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval); 59221828Sgrehanint vm_get_pinning(struct vmctx *ctx, int vcpu, int *host_cpuid); 60221828Sgrehanint vm_set_pinning(struct vmctx *ctx, int vcpu, int host_cpuid); 61221828Sgrehanint vm_run(struct vmctx *ctx, int vcpu, uint64_t rip, 62221828Sgrehan struct vm_exit *ret_vmexit); 63239042Sneelint vm_build_tables(struct vmctx *ctxt, int ncpus, int ioapic, 64239042Sneel void *oemtbl, int oemtblsz); 65239026Sneelint vm_apicid2vcpu(struct vmctx *ctx, int apicid); 66221828Sgrehanint vm_inject_event(struct vmctx *ctx, int vcpu, enum vm_event_type type, 67221828Sgrehan int vector); 68221828Sgrehanint vm_inject_event2(struct vmctx *ctx, int vcpu, enum vm_event_type type, 69221828Sgrehan int vector, int error_code); 70221828Sgrehanint vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector); 71221828Sgrehanint vm_inject_nmi(struct vmctx *ctx, int vcpu); 72221828Sgrehanint vm_capability_name2type(const char *capname); 73241486Sneelconst char *vm_capability_type2name(int type); 74221828Sgrehanint vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 75221828Sgrehan int *retval); 76221828Sgrehanint vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap, 77221828Sgrehan int val); 78221828Sgrehanint vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 79221828Sgrehanint vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func); 80221828Sgrehanint vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func, 81221828Sgrehan vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 82221828Sgrehanint vm_setup_msi(struct vmctx *ctx, int vcpu, int bus, int slot, int func, 83221828Sgrehan int dest, int vector, int numvec); 84234761Sgrehanint vm_setup_msix(struct vmctx *ctx, int vcpu, int bus, int slot, int func, 85234761Sgrehan int idx, uint32_t msg, uint32_t vector_control, uint64_t addr); 86221828Sgrehan 87221828Sgrehan/* 88221828Sgrehan * Return a pointer to the statistics buffer. Note that this is not MT-safe. 89221828Sgrehan */ 90221828Sgrehanuint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv, 91221828Sgrehan int *ret_entries); 92221828Sgrehanconst char *vm_get_stat_desc(struct vmctx *ctx, int index); 93221828Sgrehan 94240922Sneelint vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s); 95240922Sneelint vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s); 96240922Sneel 97221828Sgrehan/* Reset vcpu register state */ 98221828Sgrehanint vcpu_reset(struct vmctx *ctx, int vcpu); 99221828Sgrehan 100221828Sgrehan/* 101221828Sgrehan * FreeBSD specific APIs 102221828Sgrehan */ 103221828Sgrehanint vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu, 104221828Sgrehan uint64_t rip, uint64_t cr3, uint64_t gdtbase, 105221828Sgrehan uint64_t rsp); 106221828Sgrehanvoid vm_setup_freebsd_gdt(uint64_t *gdtr); 107221828Sgrehan#endif /* _VMMAPI_H_ */ 108