freebsd-skq/usr.sbin/bhyveload/bhyveload.8

.\"
.\" Copyright (c) 2012 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 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$
.\"
.Dd June 24, 2016
.Dt BHYVELOAD 8
.Os
.Sh NAME
.Nm bhyveload
.Nd load a
.Fx
guest inside a bhyve virtual machine
.Sh SYNOPSIS
.Nm
.Op Fl C
.Op Fl S
.Op Fl c Ar cons-dev
.Op Fl d Ar disk-path
.Op Fl e Ar name=value
.Op Fl h Ar host-path
.Op Fl l Ar os-loader
.Op Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
.Ar vmname
.Sh DESCRIPTION
.Nm
is used to load a
.Fx
guest inside a
.Xr bhyve 4
virtual machine.
.Pp
.Nm
is based on
.Xr loader 8
and will present an interface identical to the
.Fx
loader on the user's terminal.
This behavior can be changed by specifying a different OS loader.
.Pp
The virtual machine is identified as
.Ar vmname
and will be created if it does not already exist.
.Sh OPTIONS
The following options are available:
.Bl -tag -width indent
.It Fl c Ar cons-dev
.Ar cons-dev
is a
.Xr tty 4
device to use for
.Nm
terminal I/O.
.Pp
The text string "stdio" is also accepted and selects the use of
unbuffered standard I/O. This is the default value.
.It Fl d Ar disk-path
The
.Ar disk-path
is the pathname of the guest's boot disk image.
.It Fl e Ar name=value
Set the
.Fx
loader environment variable
.Ar name
to
.Ar value .
.Pp
The option may be used more than once to set more than one environment
variable.
.It Fl h Ar host-path
The
.Ar host-path
is the directory at the top of the guest's boot filesystem.
.It Fl l Ar os-loader
Specify a different OS loader.
By default
.Nm
will use
.Pa /boot/userboot.so ,
which presents a standard
.Fx
loader.
.It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
.Ar memsize
is the amount of memory allocated to the guest.
.Pp
The
.Ar memsize
argument may be suffixed with one of
.Cm K ,
.Cm M ,
.Cm G
or
.Cm T
(either upper or lower case) to indicate a multiple of
Kilobytes, Megabytes, Gigabytes or Terabytes
respectively.
.Pp
.Ar memsize
defaults to 256M.
.It Fl C
Include guest memory in the core file when
.Nm
dumps core.
This is intended for debugging an OS loader as it allows inspection of
the guest memory.
.It Fl S
Wire guest memory.
.El
.Sh EXAMPLES
To create a virtual machine named
.Ar freebsd-vm
that boots off the ISO image
.Pa /freebsd/release.iso
and has 1GB memory allocated to it:
.Pp
.Dl "bhyveload -m 1G -d /freebsd/release.iso freebsd-vm"
.Pp
To create a virtual machine named
.Ar test-vm
with 256MB of memory allocated, the guest root filesystem under the host
directory
.Pa /user/images/test
and terminal I/O sent to the
.Xr nmdm 4
device
.Pa /dev/nmdm1B
.Pp
.Dl "bhyveload -m 256MB -h /usr/images/test -c /dev/nmdm1B test-vm"
.Sh SEE ALSO
.Xr bhyve 4 ,
.Xr nmdm 4 ,
.Xr vmm 4 ,
.Xr bhyve 8 ,
.Xr loader 8
.Sh HISTORY
.Nm
first appeared in
.Fx 10.0 ,
and was developed at NetApp Inc.
.Sh AUTHORS
.Nm
was developed by
.An -nosplit
.An Neel Natu Aq Mt neel@FreeBSD.org
at NetApp Inc with a lot of help from
.An Doug Rabson Aq Mt dfr@FreeBSD.org .
.Sh BUGS
.Nm
can only load
.Fx
as a guest.
Fix missing . Approved by: re (blanket) 2013-10-09 20:00:04 +00:00			`.\"`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.\" Copyright (c) 2012 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 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$`
			`.\"`
bhyve: improve memory size documentation A couple of minor memory size option related nits: - use common name 'memsize' (instead of 'max-size' or just 'size') - bhyve: update usage with memsize unit suffix, drop legacy "MB" unit - bhyveload: update usage with memsize unit suffix - bhyve(8): document default size - bhyveload(8): use memsize formatting like it's done in bhyve(8) Reviewed by: wblock, grehan Approved by: re (kib), wblock, grehan Differential Revision: https://reviews.freebsd.org/D6952 2016-06-26 14:44:01 +00:00			`.Dd June 24, 2016`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Dt BHYVELOAD 8`
			`.Os`
			`.Sh NAME`
			`.Nm bhyveload`
			`.Nd load a`
			`.Fx`
			`guest inside a bhyve virtual machine`
			`.Sh SYNOPSIS`
			`.Nm`
Add option -C to have the guest memory included in core files. This aids in debugging OS loaders. 2016-02-26 16:15:02 +00:00			`.Op Fl C`
Restructure memory allocation in bhyve to support "devmem". devmem is used to represent MMIO devices like the boot ROM or a VESA framebuffer where doing a trap-and-emulate for every access is impractical. devmem is a hybrid of system memory (sysmem) and emulated device models. devmem is mapped in the guest address space via nested page tables similar to sysmem. However the address range where devmem is mapped may be changed by the guest at runtime (e.g. by reprogramming a PCI BAR). Also devmem is usually mapped RO or RW as compared to RWX mappings for sysmem. Each devmem segment is named (e.g. "bootrom") and this name is used to create a device node for the devmem segment (e.g. /dev/vmm/testvm.bootrom). The device node supports mmap(2) and this decouples the host mapping of devmem from its mapping in the guest address space (which can change). Reviewed by: tychon Discussed with: grehan Differential Revision: https://reviews.freebsd.org/D2762 MFC after: 4 weeks 2015-06-18 06:00:17 +00:00			`.Op Fl S`
Sort command flags in usage output and the manpages. 2014-06-27 15:20:34 +00:00			`.Op Fl c Ar cons-dev`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Op Fl d Ar disk-path`
Add an option to bhyveload(8) that allows setting a loader environment variable from the command line. The option syntax is "-e <name=value>". It may be used multiple times to set multiple environment variables. Reviewed by: grehan Requested by: alfred 2013-10-17 00:28:35 +00:00			`.Op Fl e Ar name=value`
Sort command flags in usage output and the manpages. 2014-06-27 15:20:34 +00:00			`.Op Fl h Ar host-path`
Add option -l for specifying which OS loader to dlopen(3). By default this is /boot/userboot.so. This option allows for the development and use of other OS loaders. 2015-10-08 02:28:22 +00:00			`.Op Fl l Ar os-loader`
bhyve: improve memory size documentation A couple of minor memory size option related nits: - use common name 'memsize' (instead of 'max-size' or just 'size') - bhyve: update usage with memsize unit suffix, drop legacy "MB" unit - bhyveload: update usage with memsize unit suffix - bhyve(8): document default size - bhyveload(8): use memsize formatting like it's done in bhyve(8) Reviewed by: wblock, grehan Approved by: re (kib), wblock, grehan Differential Revision: https://reviews.freebsd.org/D6952 2016-06-26 14:44:01 +00:00			`.Op Fl m Ar memsize Ns Op Ar K\|k\|M\|m\|G\|g\|T\|t`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Ar vmname`
			`.Sh DESCRIPTION`
			`.Nm`
			`is used to load a`
			`.Fx`
			`guest inside a`
			`.Xr bhyve 4`
			`virtual machine.`
			`.Pp`
			`.Nm`
			`is based on`
			`.Xr loader 8`
Minor mdoc fixes. 2013-01-19 07:04:30 +00:00			`and will present an interface identical to the`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Fx`
			`loader on the user's terminal.`
Add option -l for specifying which OS loader to dlopen(3). By default this is /boot/userboot.so. This option allows for the development and use of other OS loaders. 2015-10-08 02:28:22 +00:00			`This behavior can be changed by specifying a different OS loader.`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Pp`
			`The virtual machine is identified as`
			`.Ar vmname`
			`and will be created if it does not already exist.`
			`.Sh OPTIONS`
			`The following options are available:`
			`.Bl -tag -width indent`
Sort command flags in usage output and the manpages. 2014-06-27 15:20:34 +00:00			`.It Fl c Ar cons-dev`
			`.Ar cons-dev`
			`is a`
			`.Xr tty 4`
			`device to use for`
			`.Nm`
			`terminal I/O.`
			`.Pp`
			`The text string "stdio" is also accepted and selects the use of`
			`unbuffered standard I/O. This is the default value.`
			`.It Fl d Ar disk-path`
			`The`
			`.Ar disk-path`
			`is the pathname of the guest's boot disk image.`
			`.It Fl e Ar name=value`
Add option -l for specifying which OS loader to dlopen(3). By default this is /boot/userboot.so. This option allows for the development and use of other OS loaders. 2015-10-08 02:28:22 +00:00			`Set the`
			`.Fx`
			`loader environment variable`
Sort command flags in usage output and the manpages. 2014-06-27 15:20:34 +00:00			`.Ar name`
			`to`
			`.Ar value .`
			`.Pp`
			`The option may be used more than once to set more than one environment`
			`variable.`
			`.It Fl h Ar host-path`
			`The`
			`.Ar host-path`
			`is the directory at the top of the guest's boot filesystem.`
Add option -l for specifying which OS loader to dlopen(3). By default this is /boot/userboot.so. This option allows for the development and use of other OS loaders. 2015-10-08 02:28:22 +00:00			`.It Fl l Ar os-loader`
			`Specify a different OS loader.`
			`By default`
			`.Nm`
			`will use`
			`.Pa /boot/userboot.so ,`
			`which presents a standard`
			`.Fx`
			`loader.`
bhyve: improve memory size documentation A couple of minor memory size option related nits: - use common name 'memsize' (instead of 'max-size' or just 'size') - bhyve: update usage with memsize unit suffix, drop legacy "MB" unit - bhyveload: update usage with memsize unit suffix - bhyve(8): document default size - bhyveload(8): use memsize formatting like it's done in bhyve(8) Reviewed by: wblock, grehan Approved by: re (kib), wblock, grehan Differential Revision: https://reviews.freebsd.org/D6952 2016-06-26 14:44:01 +00:00			`.It Fl m Ar memsize Ns Op Ar K\|k\|M\|m\|G\|g\|T\|t`
			`.Ar memsize`
Parse the memory size parameter using expand_number() to allow specifying the memory size more intuitively (e.g. 512M, 4G etc). Submitted by: rodrigc Reviewed by: grehan Approved by: re (blanket) 2013-10-09 03:56:07 +00:00			`is the amount of memory allocated to the guest.`
			`.Pp`
			`The`
bhyve: improve memory size documentation A couple of minor memory size option related nits: - use common name 'memsize' (instead of 'max-size' or just 'size') - bhyve: update usage with memsize unit suffix, drop legacy "MB" unit - bhyveload: update usage with memsize unit suffix - bhyve(8): document default size - bhyveload(8): use memsize formatting like it's done in bhyve(8) Reviewed by: wblock, grehan Approved by: re (kib), wblock, grehan Differential Revision: https://reviews.freebsd.org/D6952 2016-06-26 14:44:01 +00:00			`.Ar memsize`
Parse the memory size parameter using expand_number() to allow specifying the memory size more intuitively (e.g. 512M, 4G etc). Submitted by: rodrigc Reviewed by: grehan Approved by: re (blanket) 2013-10-09 03:56:07 +00:00			`argument may be suffixed with one of`
			`.Cm K ,`
			`.Cm M ,`
			`.Cm G`
			`or`
			`.Cm T`
			`(either upper or lower case) to indicate a multiple of`
			`Kilobytes, Megabytes, Gigabytes or Terabytes`
			`respectively.`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Pp`
bhyve: improve memory size documentation A couple of minor memory size option related nits: - use common name 'memsize' (instead of 'max-size' or just 'size') - bhyve: update usage with memsize unit suffix, drop legacy "MB" unit - bhyveload: update usage with memsize unit suffix - bhyve(8): document default size - bhyveload(8): use memsize formatting like it's done in bhyve(8) Reviewed by: wblock, grehan Approved by: re (kib), wblock, grehan Differential Revision: https://reviews.freebsd.org/D6952 2016-06-26 14:44:01 +00:00			`.Ar memsize`
			`defaults to 256M.`
Add option -C to have the guest memory included in core files. This aids in debugging OS loaders. 2016-02-26 16:15:02 +00:00			`.It Fl C`
			`Include guest memory in the core file when`
			`.Nm`
			`dumps core.`
			`This is intended for debugging an OS loader as it allows inspection of`
			`the guest memory.`
Restructure memory allocation in bhyve to support "devmem". devmem is used to represent MMIO devices like the boot ROM or a VESA framebuffer where doing a trap-and-emulate for every access is impractical. devmem is a hybrid of system memory (sysmem) and emulated device models. devmem is mapped in the guest address space via nested page tables similar to sysmem. However the address range where devmem is mapped may be changed by the guest at runtime (e.g. by reprogramming a PCI BAR). Also devmem is usually mapped RO or RW as compared to RWX mappings for sysmem. Each devmem segment is named (e.g. "bootrom") and this name is used to create a device node for the devmem segment (e.g. /dev/vmm/testvm.bootrom). The device node supports mmap(2) and this decouples the host mapping of devmem from its mapping in the guest address space (which can change). Reviewed by: tychon Discussed with: grehan Differential Revision: https://reviews.freebsd.org/D2762 MFC after: 4 weeks 2015-06-18 06:00:17 +00:00			`.It Fl S`
			`Wire guest memory.`
			`.El`
Fix issues detected by 'mandoc -Tlint bhyveload.8' Pointed out by: wblock Differential Revision: https://reviews.freebsd.org/D2762 2015-06-27 18:24:23 +00:00			`.Sh EXAMPLES`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`To create a virtual machine named`
Remove EOL whitespace. 2013-01-19 07:07:05 +00:00			`.Ar freebsd-vm`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`that boots off the ISO image`
Remove EOL whitespace. 2013-01-19 07:07:05 +00:00			`.Pa /freebsd/release.iso`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`and has 1GB memory allocated to it:`
Minor mdoc fixes. 2013-01-19 07:04:30 +00:00			`.Pp`
Parse the memory size parameter using expand_number() to allow specifying the memory size more intuitively (e.g. 512M, 4G etc). Submitted by: rodrigc Reviewed by: grehan Approved by: re (blanket) 2013-10-09 03:56:07 +00:00			`.Dl "bhyveload -m 1G -d /freebsd/release.iso freebsd-vm"`
Allow bhyve and bhyveload to attach to tty devices. bhyveload: introduce the -c <device> parameter to select a tty for output (or "stdio") bhyve: allow the puc and lpc-com backends to accept a tty in addition to "stdio" When used in conjunction with the null-modem device, nmdm(4), this allows attach/detach to the guest console and multiple concurrent serial ports. kgdb on a serial port is now functional. Reviewed by: neel Requested by: Almost everyone that has used bhyve MFC after: 10.0 2013-11-27 00:21:37 +00:00			`.Pp`
			`To create a virtual machine named`
			`.Ar test-vm`
			`with 256MB of memory allocated, the guest root filesystem under the host`
			`directory`
			`.Pa /user/images/test`
			`and terminal I/O sent to the`
			`.Xr nmdm 4`
			`device`
			`.Pa /dev/nmdm1B`
			`.Pp`
mdoc: quote string properly. 2013-12-02 19:49:52 +00:00			`.Dl "bhyveload -m 256MB -h /usr/images/test -c /dev/nmdm1B test-vm"`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Sh SEE ALSO`
			`.Xr bhyve 4 ,`
o Fix typo, sort .Xrs. PR: docs/186191 Submitted by: Andrew (typo fix) MFC after: 1 week 2014-01-28 12:26:38 +00:00			`.Xr nmdm 4 ,`
			`.Xr vmm 4 ,`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Xr bhyve 8 ,`
o Fix typo, sort .Xrs. PR: docs/186191 Submitted by: Andrew (typo fix) MFC after: 1 week 2014-01-28 12:26:38 +00:00			`.Xr loader 8`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Sh HISTORY`
			`.Nm`
			`first appeared in`
			`.Fx 10.0 ,`
			`and was developed at NetApp Inc.`
			`.Sh AUTHORS`
			`.Nm`
			`was developed by`
			`.An -nosplit`
use .Mt to mark up email addresses consistently (part2) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> 2014-06-20 09:57:27 +00:00			`.An Neel Natu Aq Mt neel@FreeBSD.org`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`at NetApp Inc with a lot of help from`
use .Mt to mark up email addresses consistently (part2) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> 2014-06-20 09:57:27 +00:00			`.An Doug Rabson Aq Mt dfr@FreeBSD.org .`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Sh BUGS`
			`.Nm`
Minor mdoc fixes. 2013-01-19 07:04:30 +00:00			`can only load`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Fx`
			`as a guest.`