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
32 #include <sys/param.h>
33 #include <sys/cpuset.h>
40 * Different styles of mapping the memory assigned to a VM into the address
41 * space of the controlling process.
44 VM_MMAP_NONE, /* no mapping */
45 VM_MMAP_ALL, /* fully and statically mapped */
46 VM_MMAP_SPARSE, /* mappings created on-demand */
49 #define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */
51 int vm_create(const char *name);
52 struct vmctx *vm_open(const char *name);
53 void vm_destroy(struct vmctx *ctx);
54 int vm_parse_memsize(const char *optarg, size_t *memsize);
55 int vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len,
57 int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
58 void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
59 int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
60 uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
61 void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
62 void vm_set_memflags(struct vmctx *ctx, int flags);
63 size_t vm_get_lowmem_size(struct vmctx *ctx);
64 size_t vm_get_highmem_size(struct vmctx *ctx);
65 int vm_set_desc(struct vmctx *ctx, int vcpu, int reg,
66 uint64_t base, uint32_t limit, uint32_t access);
67 int vm_get_desc(struct vmctx *ctx, int vcpu, int reg,
68 uint64_t *base, uint32_t *limit, uint32_t *access);
69 int vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val);
70 int vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval);
71 int vm_run(struct vmctx *ctx, int vcpu, uint64_t rip,
72 struct vm_exit *ret_vmexit);
73 int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how);
74 int vm_reinit(struct vmctx *ctx);
75 int vm_apicid2vcpu(struct vmctx *ctx, int apicid);
76 int vm_inject_exception(struct vmctx *ctx, int vcpu, int vec);
77 int vm_inject_exception2(struct vmctx *ctx, int vcpu, int vec, int errcode);
78 int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
79 int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector);
80 int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
81 int vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
82 int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
83 int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
84 int vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
85 int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
86 int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
87 int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
88 int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq,
89 enum vm_intr_trigger trigger);
90 int vm_inject_nmi(struct vmctx *ctx, int vcpu);
91 int vm_capability_name2type(const char *capname);
92 const char *vm_capability_type2name(int type);
93 int vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
95 int vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
97 int vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
98 int vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
99 int vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
100 vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
101 int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot,
102 int func, uint64_t addr, uint64_t msg, int numvec);
103 int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot,
104 int func, int idx, uint64_t addr, uint64_t msg,
105 uint32_t vector_control);
108 * Return a pointer to the statistics buffer. Note that this is not MT-safe.
110 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv,
112 const char *vm_get_stat_desc(struct vmctx *ctx, int index);
114 int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s);
115 int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s);
117 int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
120 * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'.
121 * The 'iovcnt' should be big enough to accomodate all GPA segments.
122 * Returns 0 on success, 1 on a guest fault condition and -1 otherwise.
124 int vm_gla2gpa(struct vmctx *ctx, int vcpu, struct vm_guest_paging *paging,
125 uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt);
126 void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov,
127 void *host_dst, size_t len);
128 void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src,
129 struct iovec *guest_iov, size_t len);
131 /* Reset vcpu register state */
132 int vcpu_reset(struct vmctx *ctx, int vcpu);
134 int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus);
135 int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus);
136 int vm_activate_cpu(struct vmctx *ctx, int vcpu);
139 * FreeBSD specific APIs
141 int vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu,
142 uint64_t rip, uint64_t cr3, uint64_t gdtbase,
144 int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu,
145 uint32_t eip, uint32_t gdtbase,
147 void vm_setup_freebsd_gdt(uint64_t *gdtr);
148 #endif /* _VMMAPI_H_ */