2016-01-12 10:16:15 +00:00
|
|
|
.\" Copyright (c) 2015 Christian Brueffer
|
|
|
|
|
.\" 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 THE AUTHOR AND CONTRIBUTORS ``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 THE AUTHOR 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$
|
|
|
|
|
.\"
|
2020-12-19 13:21:40 +00:00
|
|
|
.Dd May 4, 2020
|
2016-01-12 10:16:15 +00:00
|
|
|
.Dt BHYVECTL 8
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm bhyvectl
|
|
|
|
|
.Nd "control utility for bhyve instances"
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Nm
|
|
|
|
|
.Fl -vm= Ns Ar <vmname>
|
|
|
|
|
.Op Fl -create
|
|
|
|
|
.Op Fl -destroy
|
|
|
|
|
.Op Fl -get-stats
|
|
|
|
|
.Op Fl -inject-nmi
|
|
|
|
|
.Op Fl -force-reset
|
|
|
|
|
.Op Fl -force-poweroff
|
Initial support for bhyve save and restore.
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
2020-05-05 00:02:04 +00:00
|
|
|
.Op Fl -checkpoint= Ns Ar <filename>
|
|
|
|
|
.Op Fl -suspend= Ns Ar <filename>
|
2016-01-12 10:16:15 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
command is a control utility for active
|
|
|
|
|
.Xr bhyve 8
|
|
|
|
|
virtual machine instances.
|
|
|
|
|
.Pp
|
|
|
|
|
.Em Note :
|
|
|
|
|
Most
|
|
|
|
|
.Nm
|
|
|
|
|
flags are intended for querying and setting the state of an active instance.
|
|
|
|
|
These commands are intended for development purposes, and are not documented here.
|
|
|
|
|
A complete list can be obtained by executing
|
|
|
|
|
.Nm
|
|
|
|
|
without any arguments.
|
|
|
|
|
.Pp
|
|
|
|
|
The user-facing options are as follows:
|
|
|
|
|
.Bl -tag -width ".Fl d Ar argument"
|
|
|
|
|
.It Fl -vm= Ns Ar <vmname>
|
|
|
|
|
Operate on the virtual machine
|
|
|
|
|
.Ar <vmname> .
|
|
|
|
|
.It Fl -create
|
|
|
|
|
Create the specified VM.
|
|
|
|
|
.It Fl -destroy
|
|
|
|
|
Destroy the specified VM.
|
2016-11-13 17:55:27 +00:00
|
|
|
.It Fl -get-stats
|
2016-01-12 10:16:15 +00:00
|
|
|
Retrieve statistics for the specified VM.
|
|
|
|
|
.It Fl -inject-nmi
|
|
|
|
|
Inject a non-maskable interrupt (NMI) into the VM.
|
|
|
|
|
.It Fl -force-reset
|
|
|
|
|
Force the VM to reset.
|
|
|
|
|
.It Fl -force-poweroff
|
|
|
|
|
Force the VM to power off.
|
Initial support for bhyve save and restore.
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
2020-05-05 00:02:04 +00:00
|
|
|
.It Fl -checkpoint= Ns Ar <filename>
|
|
|
|
|
Save a snapshot of a virtual machine.
|
|
|
|
|
The guest memory contents are saved in the file given in
|
|
|
|
|
.Ar <filename> .
|
|
|
|
|
The guest device and vCPU state are saved in the file
|
|
|
|
|
.Ar <filename>.kern .
|
|
|
|
|
.It Fl -suspend= Ns Ar <filename>
|
|
|
|
|
Save a snapshot of a virtual machine similar to
|
|
|
|
|
.Fl -checkpoint .
|
|
|
|
|
The virtual machine will terminate after the snapshot has been
|
|
|
|
|
saved.
|
2016-01-12 10:16:15 +00:00
|
|
|
.El
|
|
|
|
|
.Sh EXIT STATUS
|
|
|
|
|
.Ex -std
|
|
|
|
|
.Sh EXAMPLES
|
|
|
|
|
Destroy the VM called fbsd10:
|
|
|
|
|
.Pp
|
|
|
|
|
.Dl "bhyvectl --vm=fbsd10 --destroy"
|
Initial support for bhyve save and restore.
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
2020-05-05 00:02:04 +00:00
|
|
|
.Sh COMPATIBILITY
|
|
|
|
|
The snapshot file format is not yet stable and is subject to future changes.
|
|
|
|
|
Backwards compatibility support for the current snapshot file format is not
|
|
|
|
|
guaranteed when future changes are made.
|
2016-01-12 10:16:15 +00:00
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr bhyve 8 ,
|
|
|
|
|
.Xr bhyveload 8
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
command first appeared in
|
|
|
|
|
.Fx 10.1 .
|
|
|
|
|
.Sh AUTHORS
|
|
|
|
|
.An -nosplit
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
utility was written by
|
|
|
|
|
.An Peter Grehan
|
|
|
|
|
and
|
|
|
|
|
.An Neel Natu .
|
