2 * Copyright (c) 2011 NetApp, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
36 * Different styles of mapping the memory assigned to a VM into the address
37 * space of the controlling process.
40 VM_MMAP_NONE, /* no mapping */
41 VM_MMAP_ALL, /* fully and statically mapped */
42 VM_MMAP_SPARSE, /* mappings created on-demand */
45 #define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */
47 int vm_create(const char *name);
48 struct vmctx *vm_open(const char *name);
49 void vm_destroy(struct vmctx *ctx);
50 int vm_parse_memsize(const char *optarg, size_t *memsize);
51 int vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len,
53 int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
54 void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
55 int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
56 uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
57 void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
58 void vm_set_memflags(struct vmctx *ctx, int flags);
59 int vm_set_desc(struct vmctx *ctx, int vcpu, int reg,
60 uint64_t base, uint32_t limit, uint32_t access);
61 int vm_get_desc(struct vmctx *ctx, int vcpu, int reg,
62 uint64_t *base, uint32_t *limit, uint32_t *access);
63 int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val);
64 int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval);
65 int vm_run(struct vmctx *ctx, int vcpu, uint64_t rip,
66 struct vm_exit *ret_vmexit);
67 int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how);
68 int vm_apicid2vcpu(struct vmctx *ctx, int apicid);
69 int vm_inject_exception(struct vmctx *ctx, int vcpu, int vec);
70 int vm_inject_exception2(struct vmctx *ctx, int vcpu, int vec, int errcode);
71 int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
72 int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector);
73 int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
74 int vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
75 int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
76 int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
77 int vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
78 int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
79 int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
80 int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
81 int vm_inject_nmi(struct vmctx *ctx, int vcpu);
82 int vm_capability_name2type(const char *capname);
83 const char *vm_capability_type2name(int type);
84 int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
86 int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
88 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
89 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
90 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
91 vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
92 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot,
93 int func, uint64_t addr, uint64_t msg, int numvec);
94 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot,
95 int func, int idx, uint64_t addr, uint64_t msg,
96 uint32_t vector_control);
99 * Return a pointer to the statistics buffer. Note that this is not MT-safe.
101 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv,
103 const char *vm_get_stat_desc(struct vmctx *ctx, int index);
105 int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s);
106 int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s);
108 int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
110 /* Reset vcpu register state */
111 int vcpu_reset(struct vmctx *ctx, int vcpu);
114 * FreeBSD specific APIs
116 int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu,
117 uint64_t rip, uint64_t cr3, uint64_t gdtbase,
119 int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu,
120 uint32_t eip, uint32_t gdtbase,
122 void vm_setup_freebsd_gdt(uint64_t *gdtr);
123 #endif /* _VMMAPI_H_ */