f8a6ec2d57
We want to allow the UEFI firmware to enumerate and assign addresses to PCI devices so we can boot from NVMe[1]. Address assignment of PCI BARs is properly handled by the PCI emulation code in general, but a few specific cases need additional support. fbuf and passthru map additional objects into the guest physical address space and so need to handle address updates. Here we add a callback to emulated PCI devices to inform them of a BAR configuration change. fbuf and passthru then watch for these BAR changes and relocate the frame buffer memory segment and passthru device mmio area respectively. We also add new VM_MUNMAP_MEMSEG and VM_UNMAP_PPTDEV_MMIO ioctls to vmm(4) to facilitate the unmapping needed for addres updates. [1]: https://github.com/freebsd/uefi-edk2/pull/9/ Originally by: scottph MFC After: 1 week Sponsored by: Intel Corporation Reviewed by: grehan Approved by: philip (mentor) Differential Revision: https://reviews.freebsd.org/D24066
266 lines
10 KiB
C
266 lines
10 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
*
|
|
* 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_
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/cpuset.h>
|
|
#include <machine/vmm_dev.h>
|
|
|
|
#include <stdbool.h>
|
|
|
|
/*
|
|
* API version for out-of-tree consumers like grub-bhyve for making compile
|
|
* time decisions.
|
|
*/
|
|
#define VMMAPI_VERSION 0103 /* 2 digit major followed by 2 digit minor */
|
|
|
|
struct iovec;
|
|
struct vmctx;
|
|
struct vm_snapshot_meta;
|
|
enum x2apic_state;
|
|
|
|
/*
|
|
* Different styles of mapping the memory assigned to a VM into the address
|
|
* space of the controlling process.
|
|
*/
|
|
enum vm_mmap_style {
|
|
VM_MMAP_NONE, /* no mapping */
|
|
VM_MMAP_ALL, /* fully and statically mapped */
|
|
VM_MMAP_SPARSE, /* mappings created on-demand */
|
|
};
|
|
|
|
/*
|
|
* 'flags' value passed to 'vm_set_memflags()'.
|
|
*/
|
|
#define VM_MEM_F_INCORE 0x01 /* include guest memory in core file */
|
|
#define VM_MEM_F_WIRED 0x02 /* guest memory is wired */
|
|
|
|
/*
|
|
* Identifiers for memory segments:
|
|
* - vm_setup_memory() uses VM_SYSMEM for the system memory segment.
|
|
* - the remaining identifiers can be used to create devmem segments.
|
|
*/
|
|
enum {
|
|
VM_SYSMEM,
|
|
VM_BOOTROM,
|
|
VM_FRAMEBUFFER,
|
|
};
|
|
|
|
/*
|
|
* Get the length and name of the memory segment identified by 'segid'.
|
|
* Note that system memory segments are identified with a nul name.
|
|
*
|
|
* Returns 0 on success and non-zero otherwise.
|
|
*/
|
|
int vm_get_memseg(struct vmctx *ctx, int ident, size_t *lenp, char *name,
|
|
size_t namesiz);
|
|
|
|
/*
|
|
* Iterate over the guest address space. This function finds an address range
|
|
* that starts at an address >= *gpa.
|
|
*
|
|
* Returns 0 if the next address range was found and non-zero otherwise.
|
|
*/
|
|
int vm_mmap_getnext(struct vmctx *ctx, vm_paddr_t *gpa, int *segid,
|
|
vm_ooffset_t *segoff, size_t *len, int *prot, int *flags);
|
|
|
|
int vm_get_guestmem_from_ctx(struct vmctx *ctx, char **guest_baseaddr,
|
|
size_t *lowmem_size, size_t *highmem_size);
|
|
|
|
/*
|
|
* Create a device memory segment identified by 'segid'.
|
|
*
|
|
* Returns a pointer to the memory segment on success and MAP_FAILED otherwise.
|
|
*/
|
|
void *vm_create_devmem(struct vmctx *ctx, int segid, const char *name,
|
|
size_t len);
|
|
|
|
/*
|
|
* Map the memory segment identified by 'segid' into the guest address space
|
|
* at [gpa,gpa+len) with protection 'prot'.
|
|
*/
|
|
int vm_mmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, int segid,
|
|
vm_ooffset_t segoff, size_t len, int prot);
|
|
|
|
int vm_munmap_memseg(struct vmctx *ctx, vm_paddr_t gpa, size_t len);
|
|
|
|
int vm_create(const char *name);
|
|
int vm_get_device_fd(struct vmctx *ctx);
|
|
struct vmctx *vm_open(const char *name);
|
|
void vm_destroy(struct vmctx *ctx);
|
|
int vm_parse_memsize(const char *optarg, size_t *memsize);
|
|
int vm_setup_memory(struct vmctx *ctx, size_t len, enum vm_mmap_style s);
|
|
void *vm_map_gpa(struct vmctx *ctx, vm_paddr_t gaddr, size_t len);
|
|
/* inverse operation to vm_map_gpa - extract guest address from host pointer */
|
|
vm_paddr_t vm_rev_map_gpa(struct vmctx *ctx, void *addr);
|
|
int vm_get_gpa_pmap(struct vmctx *, uint64_t gpa, uint64_t *pte, int *num);
|
|
int vm_gla2gpa(struct vmctx *, int vcpuid, struct vm_guest_paging *paging,
|
|
uint64_t gla, int prot, uint64_t *gpa, int *fault);
|
|
int vm_gla2gpa_nofault(struct vmctx *, int vcpuid,
|
|
struct vm_guest_paging *paging, uint64_t gla, int prot,
|
|
uint64_t *gpa, int *fault);
|
|
uint32_t vm_get_lowmem_limit(struct vmctx *ctx);
|
|
void vm_set_lowmem_limit(struct vmctx *ctx, uint32_t limit);
|
|
void vm_set_memflags(struct vmctx *ctx, int flags);
|
|
int vm_get_memflags(struct vmctx *ctx);
|
|
int vm_get_name(struct vmctx *ctx, char *buffer, size_t max_len);
|
|
size_t vm_get_lowmem_size(struct vmctx *ctx);
|
|
size_t vm_get_highmem_size(struct vmctx *ctx);
|
|
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_get_seg_desc(struct vmctx *ctx, int vcpu, int reg,
|
|
struct seg_desc *seg_desc);
|
|
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_set_register_set(struct vmctx *ctx, int vcpu, unsigned int count,
|
|
const int *regnums, uint64_t *regvals);
|
|
int vm_get_register_set(struct vmctx *ctx, int vcpu, unsigned int count,
|
|
const int *regnums, uint64_t *regvals);
|
|
int vm_run(struct vmctx *ctx, int vcpu, struct vm_exit *ret_vmexit);
|
|
int vm_suspend(struct vmctx *ctx, enum vm_suspend_how how);
|
|
int vm_reinit(struct vmctx *ctx);
|
|
int vm_apicid2vcpu(struct vmctx *ctx, int apicid);
|
|
int vm_inject_exception(struct vmctx *ctx, int vcpu, int vector,
|
|
int errcode_valid, uint32_t errcode, int restart_instruction);
|
|
int vm_lapic_irq(struct vmctx *ctx, int vcpu, int vector);
|
|
int vm_lapic_local_irq(struct vmctx *ctx, int vcpu, int vector);
|
|
int vm_lapic_msi(struct vmctx *ctx, uint64_t addr, uint64_t msg);
|
|
int vm_ioapic_assert_irq(struct vmctx *ctx, int irq);
|
|
int vm_ioapic_deassert_irq(struct vmctx *ctx, int irq);
|
|
int vm_ioapic_pulse_irq(struct vmctx *ctx, int irq);
|
|
int vm_ioapic_pincount(struct vmctx *ctx, int *pincount);
|
|
int vm_readwrite_kernemu_device(struct vmctx *ctx, int vcpu,
|
|
vm_paddr_t gpa, bool write, int size, uint64_t *value);
|
|
int vm_isa_assert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
|
|
int vm_isa_deassert_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
|
|
int vm_isa_pulse_irq(struct vmctx *ctx, int atpic_irq, int ioapic_irq);
|
|
int vm_isa_set_irq_trigger(struct vmctx *ctx, int atpic_irq,
|
|
enum vm_intr_trigger trigger);
|
|
int vm_inject_nmi(struct vmctx *ctx, int vcpu);
|
|
int vm_capability_name2type(const char *capname);
|
|
const char *vm_capability_type2name(int type);
|
|
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_unmap_pptdev_mmio(struct vmctx *ctx, int bus, int slot, int func,
|
|
vm_paddr_t gpa, size_t len);
|
|
int vm_setup_pptdev_msi(struct vmctx *ctx, int vcpu, int bus, int slot,
|
|
int func, uint64_t addr, uint64_t msg, int numvec);
|
|
int vm_setup_pptdev_msix(struct vmctx *ctx, int vcpu, int bus, int slot,
|
|
int func, int idx, uint64_t addr, uint64_t msg,
|
|
uint32_t vector_control);
|
|
int vm_disable_pptdev_msix(struct vmctx *ctx, int bus, int slot, int func);
|
|
|
|
int vm_get_intinfo(struct vmctx *ctx, int vcpu, uint64_t *i1, uint64_t *i2);
|
|
int vm_set_intinfo(struct vmctx *ctx, int vcpu, uint64_t exit_intinfo);
|
|
|
|
const cap_ioctl_t *vm_get_ioctls(size_t *len);
|
|
|
|
/*
|
|
* 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);
|
|
|
|
int vm_get_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state *s);
|
|
int vm_set_x2apic_state(struct vmctx *ctx, int vcpu, enum x2apic_state s);
|
|
|
|
int vm_get_hpet_capabilities(struct vmctx *ctx, uint32_t *capabilities);
|
|
|
|
/*
|
|
* Translate the GLA range [gla,gla+len) into GPA segments in 'iov'.
|
|
* The 'iovcnt' should be big enough to accommodate all GPA segments.
|
|
*
|
|
* retval fault Interpretation
|
|
* 0 0 Success
|
|
* 0 1 An exception was injected into the guest
|
|
* EFAULT N/A Error
|
|
*/
|
|
int vm_copy_setup(struct vmctx *ctx, int vcpu, struct vm_guest_paging *pg,
|
|
uint64_t gla, size_t len, int prot, struct iovec *iov, int iovcnt,
|
|
int *fault);
|
|
void vm_copyin(struct vmctx *ctx, int vcpu, struct iovec *guest_iov,
|
|
void *host_dst, size_t len);
|
|
void vm_copyout(struct vmctx *ctx, int vcpu, const void *host_src,
|
|
struct iovec *guest_iov, size_t len);
|
|
void vm_copy_teardown(struct vmctx *ctx, int vcpu, struct iovec *iov,
|
|
int iovcnt);
|
|
|
|
/* RTC */
|
|
int vm_rtc_write(struct vmctx *ctx, int offset, uint8_t value);
|
|
int vm_rtc_read(struct vmctx *ctx, int offset, uint8_t *retval);
|
|
int vm_rtc_settime(struct vmctx *ctx, time_t secs);
|
|
int vm_rtc_gettime(struct vmctx *ctx, time_t *secs);
|
|
|
|
/* Reset vcpu register state */
|
|
int vcpu_reset(struct vmctx *ctx, int vcpu);
|
|
|
|
int vm_active_cpus(struct vmctx *ctx, cpuset_t *cpus);
|
|
int vm_suspended_cpus(struct vmctx *ctx, cpuset_t *cpus);
|
|
int vm_debug_cpus(struct vmctx *ctx, cpuset_t *cpus);
|
|
int vm_activate_cpu(struct vmctx *ctx, int vcpu);
|
|
int vm_suspend_cpu(struct vmctx *ctx, int vcpu);
|
|
int vm_resume_cpu(struct vmctx *ctx, int vcpu);
|
|
|
|
/* CPU topology */
|
|
int vm_set_topology(struct vmctx *ctx, uint16_t sockets, uint16_t cores,
|
|
uint16_t threads, uint16_t maxcpus);
|
|
int vm_get_topology(struct vmctx *ctx, uint16_t *sockets, uint16_t *cores,
|
|
uint16_t *threads, uint16_t *maxcpus);
|
|
|
|
/*
|
|
* 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);
|
|
int vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu,
|
|
uint32_t eip, uint32_t gdtbase,
|
|
uint32_t esp);
|
|
void vm_setup_freebsd_gdt(uint64_t *gdtr);
|
|
|
|
/*
|
|
* Save and restore
|
|
*/
|
|
int vm_snapshot_req(struct vm_snapshot_meta *meta);
|
|
int vm_restore_time(struct vmctx *ctx);
|
|
|
|
#endif /* _VMMAPI_H_ */
|