9b1aa8d622
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
161 lines
3.8 KiB
Groff
161 lines
3.8 KiB
Groff
.\"
|
|
.\" 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 January 7, 2012
|
|
.Dt BHYVELOAD 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm bhyveload
|
|
.Nd load a
|
|
.Fx
|
|
guest inside a bhyve virtual machine
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.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 m Ar mem-size
|
|
.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.
|
|
.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 FreeBSD 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 m Ar mem-size Xo
|
|
.Sm off
|
|
.Op Cm K | k | M | m | G | g | T | t
|
|
.Xc
|
|
.Sm on
|
|
.Ar mem-size
|
|
is the amount of memory allocated to the guest.
|
|
.Pp
|
|
The
|
|
.Ar mem-size
|
|
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
|
|
The default value of
|
|
.Ar mem-size
|
|
is 256M.
|
|
.It Fl S
|
|
Wire guest memory.
|
|
.Sh EXAMPLES
|
|
.El
|
|
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.
|