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