vmmapi.h revision 267393 
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 267393 2014-06-12 13:13:15Z jhb $
27 */
28
29#ifndef _VMMAPI_H_
30#define	_VMMAPI_H_
31
32struct vmctx;
33enum x2apic_state;
34
35/*
36 * Different styles of mapping the memory assigned to a VM into the address
37 * space of the controlling process.
38 */
39enum vm_mmap_style {
40	VM_MMAP_NONE,		/* no mapping */
41	VM_MMAP_ALL,		/* fully and statically mapped */
42	VM_MMAP_SPARSE,		/* mappings created on-demand */
43};
44
45int	vm_create(const char *name);
46struct vmctx *vm_open(const char *name);
47void	vm_destroy(struct vmctx *ctx);
48int	vm_parse_memsize(const char *optarg, size_t *memsize);
49int	vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len,
50			  int *wired);
51int	vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
52void	*vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
53int	vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
54uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
55void	vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
56int	vm_set_desc(struct vmctx *ctx, int vcpu, int reg,
57		    uint64_t base, uint32_t limit, uint32_t access);
58int	vm_get_desc(struct vmctx *ctx, int vcpu, int reg,
59		    uint64_t *base, uint32_t *limit, uint32_t *access);
60int	vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val);
61int	vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval);
62int	vm_run(struct vmctx *ctx, int vcpu, uint64_t rip,
63	       struct vm_exit *ret_vmexit);
64int	vm_apicid2vcpu(struct vmctx *ctx, int apicid);
65int	vm_inject_event(struct vmctx *ctx, int vcpu, enum vm_event_type type,
66			int vector);
67int	vm_inject_event2(struct vmctx *ctx, int vcpu, enum vm_event_type type,
68			 int vector, int error_code);
69int	vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
70int	vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector);
71int	vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
72int	vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
73int	vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
74int	vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
75int	vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
76int	vm_inject_nmi(struct vmctx *ctx, int vcpu);
77int	vm_capability_name2type(const char *capname);
78const char *vm_capability_type2name(int type);
79int	vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
80			  int *retval);
81int	vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
82			  int val);
83int	vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
84int	vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
85int	vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
86			   vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
87int	vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot,
88	    int func, uint64_t addr, uint64_t msg, int numvec);
89int	vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot,
90	    int func, int idx, uint64_t addr, uint64_t msg,
91	    uint32_t vector_control);
92
93/*
94 * Return a pointer to the statistics buffer. Note that this is not MT-safe.
95 */
96uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv,
97		       int *ret_entries);
98const char *vm_get_stat_desc(struct vmctx *ctx, int index);
99
100int	vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s);
101int	vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s);
102
103int	vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
104
105/* Reset vcpu register state */
106int	vcpu_reset(struct vmctx *ctx, int vcpu);
107
108/*
109 * FreeBSD specific APIs
110 */
111int	vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu,
112				uint64_t rip, uint64_t cr3, uint64_t gdtbase,
113				uint64_t rsp);
114void	vm_setup_freebsd_gdt(uint64_t *gdtr);
115#endif	/* _VMMAPI_H_ */
116