xref: /freebsd-11-stable/lib/libvmmapi/vmmapi.h

/*-
 * Copyright (c) 2011 NetApp, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef _VMMAPI_H_
#define	_VMMAPI_H_

struct vmctx;

int	vm_create(const char *name);
struct vmctx *vm_open(const char *name);
void	vm_destroy(struct vmctx *ctx);
int	vm_get_memory_seg(struct vmctx *ctx, vm_paddr_t gpa,
			  vm_paddr_t *ret_hpa, size_t *ret_len);
/*
 * Create a memory segment of 'len' bytes in the guest physical address space
 * at offset 'gpa'.
 *
 * If 'mapaddr' is not NULL then this region is mmap'ed into the address
 * space of the calling process. If there is an mmap error then *mapaddr
 * will be set to MAP_FAILED.
 */

int	vm_setup_memory(struct vmctx *ctx, vm_paddr_t gpa, size_t len,
		      char **mapaddr);
char *  vm_map_memory(struct vmctx *ctx, vm_paddr_t gpa, size_t len);
int	vm_set_desc(struct vmctx *ctx, int vcpu, int reg,
		    uint64_t base, uint32_t limit, uint32_t access);
int	vm_get_desc(struct vmctx *ctx, int vcpu, int reg,
		    uint64_t *base, uint32_t *limit, uint32_t *access);
int	vm_set_register(struct vmctx *ctx, int vcpu, int reg, uint64_t val);
int	vm_get_register(struct vmctx *ctx, int vcpu, int reg, uint64_t *retval);
int	vm_get_pinning(struct vmctx *ctx, int vcpu, int *host_cpuid);
int	vm_set_pinning(struct vmctx *ctx, int vcpu, int host_cpuid);
int	vm_run(struct vmctx *ctx, int vcpu, uint64_t rip,
	       struct vm_exit *ret_vmexit);
int	vm_build_tables(struct vmctx *ctxt, int ncpus, void *oemtbl,
			int oemtblsz);
int	vm_apicid2vcpu(struct vmctx *ctx, int apicid);
int	vm_inject_event(struct vmctx *ctx, int vcpu, enum vm_event_type type,
			int vector);
int	vm_inject_event2(struct vmctx *ctx, int vcpu, enum vm_event_type type,
			 int vector, int error_code);
int	vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
int	vm_inject_nmi(struct vmctx *ctx, int vcpu);
int	vm_capability_name2type(const char *capname);
int	vm_get_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
			  int *retval);
int	vm_set_capability(struct vmctx *ctx, int vcpu, enum vm_cap_type cap,
			  int val);
int	vm_assign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
int	vm_unassign_pptdev(struct vmctx *ctx, int bus, int slot, int func);
int	vm_map_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
			   vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
int	vm_setup_msi(struct vmctx *ctx, int vcpu, int bus, int slot, int func,
		     int dest, int vector, int numvec);
int	vm_setup_msix(struct vmctx *ctx, int vcpu, int bus, int slot, int func,
		      int idx, uint32_t msg, uint32_t vector_control, uint64_t addr);

/*
 * Return a pointer to the statistics buffer. Note that this is not MT-safe.
 */
uint64_t *vm_get_stats(struct vmctx *ctx, int vcpu, struct timeval *ret_tv,
		       int *ret_entries);
const char *vm_get_stat_desc(struct vmctx *ctx, int index);

/* Reset vcpu register state */
int	vcpu_reset(struct vmctx *ctx, int vcpu);

/*
 * FreeBSD specific APIs
 */
int	vm_setup_freebsd_registers(struct vmctx *ctx, int vcpu,
				uint64_t rip, uint64_t cr3, uint64_t gdtbase,
				uint64_t rsp);
void	vm_setup_freebsd_gdt(uint64_t *gdtr);
#endif	/* _VMMAPI_H_ */