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 vmctx;
  33 enum 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  */
  39 enum 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
  45 int     vm_create(const char *name);
  46 struct vmctx *vm_open(const char *name);
  47 void    vm_destroy(struct vmctx *ctx);
  48 int     vm_parse_memsize(const char *optarg, size_t *memsize);
  49 int     vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa, size_t *ret_len,
  50                           int *wired);
  51 int     vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
  52 void    *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
  53 int     vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
  54 uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
  55 void    vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
  56 int     vm_set_desc(struct vmctx *ctx, int vcpu, int reg,
  57                     uint64_t base, uint32_t limit, uint32_t access);
  58 int     vm_get_desc(struct vmctx *ctx, int vcpu, int reg,
  59                     uint64_t *base, uint32_t *limit, uint32_t *access);
  60 int     vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val);
  61 int     vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval);
  62 int     vm_run(struct vmctx *ctx, int vcpu, uint64_t rip,
  63                struct vm_exit *ret_vmexit);
  64 int     vm_apicid2vcpu(struct vmctx *ctx, int apicid);
  65 int     vm_inject_event(struct vmctx *ctx, int vcpu, enum vm_event_type type,
  66                         int vector);
  67 int     vm_inject_event2(struct vmctx *ctx, int vcpu, enum vm_event_type type,
  68                          int vector, int error_code);
  69 int     vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
  70 int     vm_inject_nmi(struct vmctx *ctx, int vcpu);
  71 int     vm_capability_name2type(const char *capname);
  72 const char *vm_capability_type2name(int type);
  73 int     vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
  74                           int *retval);
  75 int     vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
  76                           int val);
  77 int     vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
  78 int     vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
  79 int     vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
  80                            vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
  81 int     vm_setup_msi(struct vmctx *ctx, int vcpu, int bus, int slot, int func,
  82                      int dest, int vector, int numvec);
  83 int     vm_setup_msix(struct vmctx *ctx, int vcpu, int bus, int slot, int func,
  84                       int idx, uint32_t msg, uint32_t vector_control, uint64_t addr);
  85
  86 /*
  87  * Return a pointer to the statistics buffer. Note that this is not MT-safe.
  88  */
  89 uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv,
  90                        int *ret_entries);
  91 const char *vm_get_stat_desc(struct vmctx *ctx, int index);
  92
  93 int     vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s);
  94 int     vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s);
  95
  96 /* Reset vcpu register state */
  97 int     vcpu_reset(struct vmctx *ctx, int vcpu);
  98
  99 /*
 100  * FreeBSD specific APIs
 101  */
 102 int     vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu,
 103                                 uint64_t rip, uint64_t cr3, uint64_t gdtbase,
 104                                 uint64_t rsp);
 105 void    vm_setup_freebsd_gdt(uint64_t *gdtr);
 106 #endif  /* _VMMAPI_H_ */