483d953a86
Save and restore (also known as suspend and resume) permits a snapshot to be taken of a guest's state that can later be resumed. In the current implementation, bhyve(8) creates a UNIX domain socket that is used by bhyvectl(8) to send a request to save a snapshot (and optionally exit after the snapshot has been taken). A snapshot currently consists of two files: the first holds a copy of guest RAM, and the second file holds other guest state such as vCPU register values and device model state. To resume a guest, bhyve(8) must be started with a matching pair of command line arguments to instantiate the same set of device models as well as a pointer to the saved snapshot. While the current implementation is useful for several uses cases, it has a few limitations. The file format for saving the guest state is tied to the ABI of internal bhyve structures and is not self-describing (in that it does not communicate the set of device models present in the system). In addition, the state saved for some device models closely matches the internal data structures which might prove a challenge for compatibility of snapshot files across a range of bhyve versions. The file format also does not currently support versioning of individual chunks of state. As a result, the current file format is not a fixed binary format and future revisions to save and restore will break binary compatiblity of snapshot files. The goal is to move to a more flexible format that adds versioning, etc. and at that point to commit to providing a reasonable level of compatibility. As a result, the current implementation is not enabled by default. It can be enabled via the WITH_BHYVE_SNAPSHOT=yes option for userland builds, and the kernel option BHYVE_SHAPSHOT. Submitted by: Mihai Tiganus, Flavius Anton, Darius Mihai Submitted by: Elena Mihailescu, Mihai Carabas, Sergiu Weisz Relnotes: yes Sponsored by: University Politehnica of Bucharest Sponsored by: Matthew Grooms (student scholarships) Sponsored by: iXsystems Differential Revision: https://reviews.freebsd.org/D19495
119 lines
4.5 KiB
C
119 lines
4.5 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 _VLAPIC_H_
|
|
#define _VLAPIC_H_
|
|
|
|
struct vm;
|
|
struct vm_snapshot_meta;
|
|
enum x2apic_state;
|
|
|
|
int vlapic_write(struct vlapic *vlapic, int mmio_access, uint64_t offset,
|
|
uint64_t data, bool *retu);
|
|
int vlapic_read(struct vlapic *vlapic, int mmio_access, uint64_t offset,
|
|
uint64_t *data, bool *retu);
|
|
|
|
/*
|
|
* Returns 0 if there is no eligible vector that can be delivered to the
|
|
* guest at this time and non-zero otherwise.
|
|
*
|
|
* If an eligible vector number is found and 'vecptr' is not NULL then it will
|
|
* be stored in the location pointed to by 'vecptr'.
|
|
*
|
|
* Note that the vector does not automatically transition to the ISR as a
|
|
* result of calling this function.
|
|
*/
|
|
int vlapic_pending_intr(struct vlapic *vlapic, int *vecptr);
|
|
|
|
/*
|
|
* Transition 'vector' from IRR to ISR. This function is called with the
|
|
* vector returned by 'vlapic_pending_intr()' when the guest is able to
|
|
* accept this interrupt (i.e. RFLAGS.IF = 1 and no conditions exist that
|
|
* block interrupt delivery).
|
|
*/
|
|
void vlapic_intr_accepted(struct vlapic *vlapic, int vector);
|
|
|
|
/*
|
|
* Returns 1 if the vcpu needs to be notified of the interrupt and 0 otherwise.
|
|
*/
|
|
int vlapic_set_intr_ready(struct vlapic *vlapic, int vector, bool level);
|
|
|
|
/*
|
|
* Post an interrupt to the vcpu running on 'hostcpu'. This will use a
|
|
* hardware assist if available (e.g. Posted Interrupt) or fall back to
|
|
* sending an 'ipinum' to interrupt the 'hostcpu'.
|
|
*/
|
|
void vlapic_post_intr(struct vlapic *vlapic, int hostcpu, int ipinum);
|
|
|
|
void vlapic_fire_cmci(struct vlapic *vlapic);
|
|
int vlapic_trigger_lvt(struct vlapic *vlapic, int vector);
|
|
|
|
void vlapic_sync_tpr(struct vlapic *vlapic);
|
|
|
|
uint64_t vlapic_get_apicbase(struct vlapic *vlapic);
|
|
int vlapic_set_apicbase(struct vlapic *vlapic, uint64_t val);
|
|
void vlapic_set_x2apic_state(struct vm *vm, int vcpuid, enum x2apic_state s);
|
|
bool vlapic_enabled(struct vlapic *vlapic);
|
|
|
|
void vlapic_deliver_intr(struct vm *vm, bool level, uint32_t dest, bool phys,
|
|
int delmode, int vec);
|
|
|
|
/* Reset the trigger-mode bits for all vectors to be edge-triggered */
|
|
void vlapic_reset_tmr(struct vlapic *vlapic);
|
|
|
|
/*
|
|
* Set the trigger-mode bit associated with 'vector' to level-triggered if
|
|
* the (dest,phys,delmode) tuple resolves to an interrupt being delivered to
|
|
* this 'vlapic'.
|
|
*/
|
|
void vlapic_set_tmr_level(struct vlapic *vlapic, uint32_t dest, bool phys,
|
|
int delmode, int vector);
|
|
|
|
void vlapic_set_cr8(struct vlapic *vlapic, uint64_t val);
|
|
uint64_t vlapic_get_cr8(struct vlapic *vlapic);
|
|
|
|
/* APIC write handlers */
|
|
void vlapic_id_write_handler(struct vlapic *vlapic);
|
|
void vlapic_ldr_write_handler(struct vlapic *vlapic);
|
|
void vlapic_dfr_write_handler(struct vlapic *vlapic);
|
|
void vlapic_svr_write_handler(struct vlapic *vlapic);
|
|
void vlapic_esr_write_handler(struct vlapic *vlapic);
|
|
int vlapic_icrlo_write_handler(struct vlapic *vlapic, bool *retu);
|
|
void vlapic_icrtmr_write_handler(struct vlapic *vlapic);
|
|
void vlapic_dcr_write_handler(struct vlapic *vlapic);
|
|
void vlapic_lvt_write_handler(struct vlapic *vlapic, uint32_t offset);
|
|
void vlapic_self_ipi_handler(struct vlapic *vlapic, uint64_t val);
|
|
|
|
#ifdef BHYVE_SNAPSHOT
|
|
int vlapic_snapshot(struct vm *vm, struct vm_snapshot_meta *meta);
|
|
#endif
|
|
|
|
#endif /* _VLAPIC_H_ */
|