usr.sbin/bhyve/bhyve.8

   1 .\" Copyright (c) 2013 Peter Grehan
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd August 7, 2015
  28 .Dt BHYVE 8
  29 .Os
  30 .Sh NAME
  31 .Nm bhyve
  32 .Nd "run a guest operating system inside a virtual machine"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl abehuwxACHPWY
  36 .Op Fl c Ar numcpus
  37 .Op Fl g Ar gdbport
  38 .Op Fl l Ar lpcdev Ns Op , Ns Ar conf
  39 .Op Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t
  40 .Op Fl p Ar vcpu:hostcpu
  41 .Op Fl s Ar slot,emulation Ns Op , Ns Ar conf
  42 .Op Fl U Ar uuid
  43 .Ar vmname
  44 .Sh DESCRIPTION
  45 .Nm
  46 is a hypervisor that runs guest operating systems inside a
  47 virtual machine.
  48 .Pp
  49 Parameters such as the number of virtual CPUs, amount of guest memory, and
  50 I/O connectivity can be specified with command-line parameters.
  51 .Pp
  52 The guest operating system must be loaded with
  53 .Xr bhyveload 8
  54 or a similar boot loader before running
  55 .Nm .
  56 .Pp
  57 .Nm
  58 runs until the guest operating system reboots or an unhandled hypervisor
  59 exit is detected.
  60 .Sh OPTIONS
  61 .Bl -tag -width 10n
  62 .It Fl a
  63 The guest's local APIC is configured in xAPIC mode.
  64 The xAPIC mode is the default setting so this option is redundant.
  65 It will be deprecated in a future version.
  66 .It Fl A
  67 Generate ACPI tables.
  68 Required for
  69 .Fx Ns /amd64
  70 guests.
  71 .It Fl b
  72 Enable a low-level console device supported by
  73 .Fx
  74 kernels compiled with
  75 .Cd "device bvmconsole" .
  76 This option will be deprecated in a future version.
  77 .It Fl c Ar numcpus
  78 Number of guest virtual CPUs.
  79 The default is 1 and the maximum is 16.
  80 .It Fl C
  81 Include guest memory in core file.
  82 .It Fl e
  83 Force
  84 .Nm
  85 to exit when a guest issues an access to an I/O port that is not emulated.
  86 This is intended for debug purposes.
  87 .It Fl g Ar gdbport
  88 For
  89 .Fx
  90 kernels compiled with
  91 .Cd "device bvmdebug" ,
  92 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
  93 via a local IPv4 address and this port.
  94 This option will be deprecated in a future version.
  95 .It Fl h
  96 Print help message and exit.
  97 .It Fl H
  98 Yield the virtual CPU thread when a HLT instruction is detected.
  99 If this option is not specified, virtual CPUs will use 100% of a host CPU.
 100 .It Fl l Ar lpcdev Ns Op , Ns Ar conf
 101 Allow devices behind the LPC PCI-ISA bridge to be configured.
 102 The only supported devices are the TTY-class devices,
 103 .Li com1
 104 and
 105 .Li com2 .
 106 .It Fl m Ar size Ns Op Ar K|k|M|m|G|g|T|t
 107 Guest physical memory size in bytes.
 108 This must be the same size that was given to
 109 .Xr bhyveload 8 .
 110 .Pp
 111 The size argument may be suffixed with one of K, M, G or T (either upper
 112 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
 113 or terabytes.
 114 If no suffix is given, the value is assumed to be in megabytes.
 115 .It Fl p Ar vcpu:hostcpu
 116 Pin guest's virtual CPU
 117 .Em vcpu
 118 to
 119 .Em hostcpu .
 120 .It Fl P
 121 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
 122 .It Fl s Ar slot,emulation Ns Op , Ns Ar conf
 123 Configure a virtual PCI slot and function.
 124 .Pp
 125 .Nm
 126 provides PCI bus emulation and virtual devices that can be attached to
 127 slots on the bus.
 128 There are 32 available slots, with the option of providing up to 8 functions
 129 per slot.
 130 .Bl -tag -width 10n
 131 .It Ar slot
 132 .Ar pcislot[:function]
 133 .Ar bus:pcislot:function
 134 .Pp
 135 The
 136 .Ar pcislot
 137 value is 0 to 31.
 138 The optional
 139 .Ar function
 140 value is 0 to 7.
 141 The optional
 142 .Ar bus
 143 value is 0 to 255.
 144 If not specified, the
 145 .Ar function
 146 value defaults to 0.
 147 If not specified, the
 148 .Ar bus
 149 value defaults to 0.
 150 .It Ar emulation
 151 .Bl -tag -width 10n
 152 .It Li hostbridge | Li amd_hostbridge
 153 .Pp
 154 Provide a simple host bridge.
 155 This is usually configured at slot 0, and is required by most guest
 156 operating systems.
 157 The
 158 .Li amd_hostbridge
 159 emulation is identical but uses a PCI vendor ID of
 160 .Li AMD .
 161 .It Li passthru
 162 PCI pass-through device.
 163 .It Li virtio-net
 164 Virtio network interface.
 165 .It Li virtio-blk
 166 Virtio block storage interface.
 167 .It Li virtio-rnd
 168 Virtio RNG interface.
 169 .It Li ahci-cd
 170 AHCI controller attached to an ATAPI CD/DVD.
 171 .It Li ahci-hd
 172 AHCI controller attached to a SATA hard-drive.
 173 .It Li uart
 174 PCI 16550 serial device.
 175 .It Li lpc
 176 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports. The LPC bridge
 177 emulation can only be configured on bus 0.
 178 .El
 179 .It Op Ar conf
 180 This optional parameter describes the backend for device emulations.
 181 If
 182 .Ar conf
 183 is not specified, the device emulation has no backend and can be
 184 considered unconnected.
 185 .Pp
 186 Network devices:
 187 .Bl -tag -width 10n
 188 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 189 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 190 .Pp
 191 If
 192 .Ar mac
 193 is not specified, the MAC address is derived from a fixed OUI and the
 194 remaining bytes from an MD5 hash of the slot and function numbers and
 195 the device name.
 196 .Pp
 197 The MAC address is an ASCII string in
 198 .Xr ethers 5
 199 format.
 200 .El
 201 .Pp
 202 Block storage devices:
 203 .Bl -tag -width 10n
 204 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
 205 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
 206 .El
 207 .Pp
 208 The
 209 .Ar block-device-options
 210 are:
 211 .Bl -tag -width 8n
 212 .It Li nocache
 213 Open the file with
 214 .Dv O_DIRECT .
 215 .It Li direct
 216 Open the file using
 217 .Dv O_SYNC .
 218 .It Li ro
 219 Force the file to be opened read-only.
 220 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
 221 Specify the logical and physical sector sizes of the emulated disk.
 222 The physical sector size is optional and is equal to the logical sector size
 223 if not explicitly specified.
 224 .El
 225 .Pp
 226 TTY devices:
 227 .Bl -tag -width 10n
 228 .It Li stdio
 229 Connect the serial port to the standard input and output of
 230 the
 231 .Nm
 232 process.
 233 .It Pa /dev/xxx
 234 Use the host TTY device for serial port I/O.
 235 .El
 236 .Pp
 237 Pass-through devices:
 238 .Bl -tag -width 10n
 239 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
 240 Connect to a PCI device on the host at the selector described by
 241 .Ar slot ,
 242 .Ar bus ,
 243 and
 244 .Ar function
 245 numbers.
 246 .El
 247 .Pp
 248 The host device must have been reserved at boot-time using the
 249 .Va pptdev
 250 loader variable as described in
 251 .Xr vmm 4 .
 252 .El
 253 .It Fl u
 254 RTC keeps UTC time.
 255 .It Fl U Ar uuid
 256 Set the universally unique identifier
 257 .Pq UUID
 258 in the guest's System Management BIOS System Information structure.
 259 By default a UUID is generated from the host's hostname and
 260 .Ar vmname .
 261 .It Fl w
 262 Ignore accesses to unimplemented Model Specific Registers (MSRs).
 263 This is intended for debug purposes.
 264 .It Fl W
 265 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
 266 interrupts.
 267 .It Fl x
 268 The guest's local APIC is configured in x2APIC mode.
 269 .It Fl Y
 270 Disable MPtable generation.
 271 .It Ar vmname
 272 Alphanumeric name of the guest.
 273 This should be the same as that created by
 274 .Xr bhyveload 8 .
 275 .El
 276 .Sh EXAMPLES
 277 The guest operating system must have been loaded with
 278 .Xr bhyveload 8
 279 or a similar boot loader before
 280 .Xr bhyve 4
 281 can be run.
 282 .Pp
 283 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
 284 block device backed by the
 285 .Pa /my/image
 286 filesystem image, and a serial port for the console:
 287 .Bd -literal -offset indent
 288 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
 289   -l com1,stdio -A -H -P -m 1G vm1
 290 .Ed
 291 .Pp
 292 Run a 24GB single-CPU virtual machine with three network ports, one of which
 293 has a MAC address specified:
 294 .Bd -literal -offset indent
 295 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
 296   -s 2:1,virtio-net,tap1 \\
 297   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
 298   -s 3,virtio-blk,/my/image -l com1,stdio \\
 299   -A -H -P -m 24G bigvm
 300 .Ed
 301 .Pp
 302 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
 303 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
 304 port connected to an
 305 .Xr nmdm 4
 306 null-modem device.
 307 .Bd -literal -offset indent
 308 bhyve -c 4 \\
 309   -s 0,amd_hostbridge -s 1,lpc \\
 310   -s 1:0,ahci-hd,/images/disk.1 \\
 311   -s 1:1,ahci-hd,/images/disk.2 \\
 312   -s 1:2,ahci-hd,/images/disk.3 \\
 313   -s 1:3,ahci-hd,/images/disk.4 \\
 314   -s 1:4,ahci-hd,/images/disk.5 \\
 315   -s 1:5,ahci-hd,/images/disk.6 \\
 316   -s 1:6,ahci-hd,/images/disk.7 \\
 317   -s 1:7,ahci-hd,/images/disk.8 \\
 318   -s 2,ahci-cd,/images/install.iso \\
 319   -s 3,virtio-net,tap0 \\
 320   -l com1,/dev/nmdm0A \\
 321   -A -H -P -m 8G
 322 .Ed
 323 .Sh SEE ALSO
 324 .Xr bhyve 4 ,
 325 .Xr nmdm 4 ,
 326 .Xr vmm 4 ,
 327 .Xr ethers 5 ,
 328 .Xr bhyvectl 8 ,
 329 .Xr bhyveload 8
 330 .Sh HISTORY
 331 .Nm
 332 first appeared in
 333 .Fx 10.0 .
 334 .Sh AUTHORS
 335 .An Neel Natu Aq neel@freebsd.org
 336 .An Peter Grehan Aq grehan@freebsd.org