lib/libvmmapi/vmmapi.h

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