lib/libvmmapi/vmmapi.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2011 NetApp, Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _VMMAPI_H_
  32 #define _VMMAPI_H_
  33
  34 #include <sys/cdefs.h>
  35 #include <sys/param.h>
  36 #include <sys/cpuset.h>
  37 #include <machine/vmm.h>
  38 #include <machine/vmm_dev.h>
  39
  40 #include <stdbool.h>
  41
  42 /*
  43  * API version for out-of-tree consumers like grub-bhyve for making compile
  44  * time decisions.
  45  */
  46 #define VMMAPI_VERSION  0200    /* 2 digit major followed by 2 digit minor */
  47
  48 struct iovec;
  49 struct vcpu;
  50 struct vmctx;
  51 struct vm_snapshot_meta;
  52 enum x2apic_state;
  53
  54 /*
  55  * Different styles of mapping the memory assigned to a VM into the address
  56  * space of the controlling process.
  57  */
  58 enum vm_mmap_style {
  59         VM_MMAP_NONE,           /* no mapping */
  60         VM_MMAP_ALL,            /* fully and statically mapped */
  61         VM_MMAP_SPARSE,         /* mappings created on-demand */
  62 };
  63
  64 /*
  65  * 'flags' value passed to 'vm_set_memflags()'.
  66  */
  67 #define VM_MEM_F_INCORE 0x01    /* include guest memory in core file */
  68 #define VM_MEM_F_WIRED  0x02    /* guest memory is wired */
  69
  70 /*
  71  * Identifiers for memory segments:
  72  * - vm_setup_memory() uses VM_SYSMEM for the system memory segment.
  73  * - the remaining identifiers can be used to create devmem segments.
  74  */
  75 enum {
  76         VM_SYSMEM,
  77         VM_BOOTROM,
  78         VM_FRAMEBUFFER,
  79         VM_PCIROM,
  80 };
  81
  82 __BEGIN_DECLS
  83 /*
  84  * Get the length and name of the memory segment identified by 'segid'.
  85  * Note that system memory segments are identified with a nul name.
  86  *
  87  * Returns 0 on success and non-zero otherwise.
  88  */
  89 int     vm_get_memseg(struct vmctx *ctx, int ident, size_t *lenp, char *name,
  90             size_t namesiz);
  91
  92 /*
  93  * Iterate over the guest address space. This function finds an address range
  94  * that starts at an address >= *gpa.
  95  *
  96  * Returns 0 if the next address range was found and non-zero otherwise.
  97  */
  98 int     vm_mmap_getnext(struct vmctx *ctx, vm_paddr_t *gpa, int *segid,
  99             vm_ooffset_t *segoff, size_t *len, int *prot, int *flags);
 100
 101 int     vm_get_guestmem_from_ctx(struct vmctx *ctx, char **guest_baseaddr,
 102                                  size_t *lowmem_size, size_t *highmem_size);
 103
 104 /*
 105  * Create a device memory segment identified by 'segid'.
 106  *
 107  * Returns a pointer to the memory segment on success and MAP_FAILED otherwise.
 108  */
 109 void    *vm_create_devmem(struct vmctx *ctx, int segid, const char *name,
 110             size_t len);
 111
 112 /*
 113  * Map the memory segment identified by 'segid' into the guest address space
 114  * at [gpa,gpa+len) with protection 'prot'.
 115  */
 116 int     vm_mmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, int segid,
 117             vm_ooffset_t segoff, size_t len, int prot);
 118
 119 int     vm_munmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, size_t len);
 120
 121 int     vm_create(const char *name);
 122 struct vmctx *vm_open(const char *name);
 123 void    vm_close(struct vmctx *ctx);
 124 void    vm_destroy(struct vmctx *ctx);
 125 int     vm_limit_rights(struct vmctx *ctx);
 126 struct vcpu *vm_vcpu_open(struct vmctx *ctx, int vcpuid);
 127 void    vm_vcpu_close(struct vcpu *vcpu);
 128 int     vcpu_id(struct vcpu *vcpu);
 129 int     vm_parse_memsize(const char *optarg, size_t *memsize);
 130 int     vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
 131 void    *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
 132 /* inverse operation to vm_map_gpa - extract guest address from host pointer */
 133 vm_paddr_t vm_rev_map_gpa(struct vmctx *ctx, void *addr);
 134 int     vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
 135 int     vm_gla2gpa(struct vcpu *vcpu, struct vm_guest_paging *paging,
 136                    uint64_t gla, int prot, uint64_t *gpa, int *fault);
 137 int     vm_gla2gpa_nofault(struct vcpu *vcpu,
 138                    struct vm_guest_paging *paging, uint64_t gla, int prot,
 139                    uint64_t *gpa, int *fault);
 140 uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
 141 void    vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
 142 void    vm_set_memflags(struct vmctx *ctx, int flags);
 143 int     vm_get_memflags(struct vmctx *ctx);
 144 const char *vm_get_name(struct vmctx *ctx);
 145 size_t  vm_get_lowmem_size(struct vmctx *ctx);
 146 size_t  vm_get_highmem_size(struct vmctx *ctx);
 147 int     vm_set_desc(struct vcpu *vcpu, int reg,
 148                     uint64_t base, uint32_t limit, uint32_t access);
 149 int     vm_get_desc(struct vcpu *vcpu, int reg,
 150                     uint64_t *base, uint32_t *limit, uint32_t *access);
 151 int     vm_get_seg_desc(struct vcpu *vcpu, int reg, struct seg_desc *seg_desc);
 152 int     vm_set_register(struct vcpu *vcpu, int reg, uint64_t val);
 153 int     vm_get_register(struct vcpu *vcpu, int reg, uint64_t *retval);
 154 int     vm_set_register_set(struct vcpu *vcpu, unsigned int count,
 155     const int *regnums, uint64_t *regvals);
 156 int     vm_get_register_set(struct vcpu *vcpu, unsigned int count,
 157     const int *regnums, uint64_t *regvals);
 158 int     vm_run(struct vcpu *vcpu, struct vm_run *vmrun);
 159 int     vm_suspend(struct vmctx *ctx, enum vm_suspend_how how);
 160 int     vm_reinit(struct vmctx *ctx);
 161 int     vm_apicid2vcpu(struct vmctx *ctx, int apicid);
 162 int     vm_inject_exception(struct vcpu *vcpu, int vector,
 163     int errcode_valid, uint32_t errcode, int restart_instruction);
 164 int     vm_lapic_irq(struct vcpu *vcpu, int vector);
 165 int     vm_lapic_local_irq(struct vcpu *vcpu, int vector);
 166 int     vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
 167 int     vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
 168 int     vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
 169 int     vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
 170 int     vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
 171 int     vm_readwrite_kernemu_device(struct vcpu *vcpu,
 172             vm_paddr_t gpa, bool write, int size, uint64_t *value);
 173 int     vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
 174 int     vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
 175 int     vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
 176 int     vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq,
 177             enum vm_intr_trigger trigger);
 178 int     vm_inject_nmi(struct vcpu *vcpu);
 179 int     vm_capability_name2type(const char *capname);
 180 const char *vm_capability_type2name(int type);
 181 int     vm_get_capability(struct vcpu *vcpu, enum vm_cap_type cap,
 182                           int *retval);
 183 int     vm_set_capability(struct vcpu *vcpu, enum vm_cap_type cap,
 184                           int val);
 185 int     vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
 186 int     vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
 187 int     vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
 188                            vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
 189 int     vm_unmap_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
 190                              vm_paddr_t gpa, size_t len);
 191 int     vm_setup_pptdev_msi(struct vmctx *ctx, int bus, int slot,
 192             int func, uint64_t addr, uint64_t msg, int numvec);
 193 int     vm_setup_pptdev_msix(struct vmctx *ctx, int bus, int slot,
 194             int func, int idx, uint64_t addr, uint64_t msg,
 195             uint32_t vector_control);
 196 int     vm_disable_pptdev_msix(struct vmctx *ctx, int bus, int slot, int func);
 197
 198 int     vm_get_intinfo(struct vcpu *vcpu, uint64_t *i1, uint64_t *i2);
 199 int     vm_set_intinfo(struct vcpu *vcpu, uint64_t exit_intinfo);
 200
 201 /*
 202  * Return a pointer to the statistics buffer. Note that this is not MT-safe.
 203  */
 204 uint64_t *vm_get_stats(struct vcpu *vcpu, struct timeval *ret_tv,
 205                        int *ret_entries);
 206 const char *vm_get_stat_desc(struct vmctx *ctx, int index);
 207
 208 int     vm_get_x2apic_state(struct vcpu *vcpu, enum x2apic_state *s);
 209 int     vm_set_x2apic_state(struct vcpu *vcpu, enum x2apic_state s);
 210
 211 int     vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
 212
 213 /*
 214  * Translate the GLA range [gla,gla+len) into GPA segments in 'iov'.
 215  * The 'iovcnt' should be big enough to accommodate all GPA segments.
 216  *
 217  * retval       fault           Interpretation
 218  *   0            0             Success
 219  *   0            1             An exception was injected into the guest
 220  * EFAULT        N/A            Error
 221  */
 222 int     vm_copy_setup(struct vcpu *vcpu, struct vm_guest_paging *pg,
 223             uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt,
 224             int *fault);
 225 void    vm_copyin(struct iovec *guest_iov, void *host_dst, size_t len);
 226 void    vm_copyout(const void *host_src, struct iovec *guest_iov, size_t len);
 227 void    vm_copy_teardown(struct iovec *iov, int iovcnt);
 228
 229 /* RTC */
 230 int     vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value);
 231 int     vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval);
 232 int     vm_rtc_settime(struct vmctx *ctx, time_t secs);
 233 int     vm_rtc_gettime(struct vmctx *ctx, time_t *secs);
 234
 235 /* Reset vcpu register state */
 236 int     vcpu_reset(struct vcpu *vcpu);
 237
 238 int     vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus);
 239 int     vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus);
 240 int     vm_debug_cpus(struct vmctx *ctx, cpuset_t *cpus);
 241 int     vm_activate_cpu(struct vcpu *vcpu);
 242 int     vm_suspend_all_cpus(struct vmctx *ctx);
 243 int     vm_suspend_cpu(struct vcpu *vcpu);
 244 int     vm_resume_all_cpus(struct vmctx *ctx);
 245 int     vm_resume_cpu(struct vcpu *vcpu);
 246 int     vm_restart_instruction(struct vcpu *vcpu);
 247
 248 /* CPU topology */
 249 int     vm_set_topology(struct vmctx *ctx, uint16_t sockets, uint16_t cores,
 250             uint16_t threads, uint16_t maxcpus);
 251 int     vm_get_topology(struct vmctx *ctx, uint16_t *sockets, uint16_t *cores,
 252             uint16_t *threads, uint16_t *maxcpus);
 253
 254 /*
 255  * FreeBSD specific APIs
 256  */
 257 int     vm_setup_freebsd_registers(struct vcpu *vcpu,
 258                                 uint64_t rip, uint64_t cr3, uint64_t gdtbase,
 259                                 uint64_t rsp);
 260 int     vm_setup_freebsd_registers_i386(struct vcpu *vcpu,
 261                                         uint32_t eip, uint32_t gdtbase,
 262                                         uint32_t esp);
 263 void    vm_setup_freebsd_gdt(uint64_t *gdtr);
 264
 265 /*
 266  * Save and restore
 267  */
 268 int     vm_snapshot_req(struct vmctx *ctx, struct vm_snapshot_meta *meta);
 269 int     vm_restore_time(struct vmctx *ctx);
 270
 271 /*
 272  * Deprecated interfaces, do not use them in new code.
 273  */
 274 int     vm_get_device_fd(struct vmctx *ctx);
 275 const cap_ioctl_t *vm_get_ioctls(size_t *len);
 276
 277 __END_DECLS
 278
 279 #endif  /* _VMMAPI_H_ */