]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.sbin/bhyve/bhyve.8
MFV r360158:
[FreeBSD/FreeBSD.git] / 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 April 22, 2020
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 AabCeHhPSuWwxY
36 .Oo
37 .Sm off
38 .Fl c\~
39 .Oo
40 .Op Cm cpus=
41 .Ar numcpus
42 .Oc
43 .Op Cm ,sockets= Ar n
44 .Op Cm ,cores= Ar n
45 .Op Cm ,threads= Ar n
46 .Oc
47 .Sm on
48 .Op Fl G Ar port
49 .Op Fl g Ar gdbport
50 .Oo Fl l
51 .Sm off
52 .Cm help | Ar lpcdev Op Cm \&, Ar conf
53 .Sm on
54 .Oc
55 .Oo Fl m
56 .Sm off
57 .Ar memsize
58 .Oo
59 .Cm K No | Cm k No | Cm M No | Cm m No | Cm G No | Cm g No | Cm T No | Cm t
60 .Oc
61 .Sm on
62 .Oc
63 .Op Fl p Ar vcpu Ns Cm \&: Ns Ar hostcpu
64 .Oo Fl s
65 .Sm off
66 .Cm help | Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf
67 .Sm on
68 .Oc
69 .Op Fl U Ar uuid
70 .Ar vmname
71 .Sh DESCRIPTION
72 .Nm
73 is a hypervisor that runs guest operating systems inside a
74 virtual machine.
75 .Pp
76 Parameters such as the number of virtual CPUs, amount of guest memory, and
77 I/O connectivity can be specified with command-line parameters.
78 .Pp
79 If not using a boot ROM, the guest operating system must be loaded with
80 .Xr bhyveload 8
81 or a similar boot loader before running
82 .Nm ,
83 otherwise, it is enough to run
84 .Nm
85 with a boot ROM of choice.
86 .Pp
87 .Nm
88 runs until the guest operating system reboots or an unhandled hypervisor
89 exit is detected.
90 .Sh OPTIONS
91 .Bl -tag -width 10n
92 .It Fl a
93 The guest's local APIC is configured in xAPIC mode.
94 The xAPIC mode is the default setting so this option is redundant.
95 It will be deprecated in a future version.
96 .It Fl A
97 Generate ACPI tables.
98 Required for
99 .Fx Ns /amd64
100 guests.
101 .It Fl b
102 Enable a low-level console device supported by
103 .Fx
104 kernels compiled with
105 .Cd "device bvmconsole" .
106 This option will be deprecated in a future version.
107 .It Fl c Op Ar setting ...
108 Number of guest virtual CPUs
109 and/or the CPU topology.
110 The default value for each of
111 .Ar numcpus ,
112 .Ar sockets ,
113 .Ar cores ,
114 and
115 .Ar threads
116 is 1.
117 The current maximum number of guest virtual CPUs is 16.
118 If
119 .Ar numcpus
120 is not specified then it will be calculated from the other arguments.
121 The topology must be consistent in that the
122 .Ar numcpus
123 must equal the product of
124 .Ar sockets ,
125 .Ar cores ,
126 and
127 .Ar threads .
128 If a
129 .Ar setting
130 is specified more than once the last one has precedence.
131 .It Fl C
132 Include guest memory in core file.
133 .It Fl e
134 Force
135 .Nm
136 to exit when a guest issues an access to an I/O port that is not emulated.
137 This is intended for debug purposes.
138 .It Fl g Ar gdbport
139 For
140 .Fx
141 kernels compiled with
142 .Cd "device bvmdebug" ,
143 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
144 via a local IPv4 address and this port.
145 This option will be deprecated in a future version.
146 .It Fl G Ar port
147 Start a debug server that uses the GDB protocol to export guest state to a
148 debugger.
149 An IPv4 TCP socket will be bound to the supplied
150 .Ar port
151 to listen for debugger connections.
152 Only a single debugger may be attached to the debug server at a time.
153 If
154 .Ar port
155 begins with
156 .Sq w ,
157 .Nm
158 will pause execution at the first instruction waiting for a debugger to attach.
159 .It Fl h
160 Print help message and exit.
161 .It Fl H
162 Yield the virtual CPU thread when a HLT instruction is detected.
163 If this option is not specified, virtual CPUs will use 100% of a host CPU.
164 .It Fl l Op Ar help|lpcdev Ns Op , Ns Ar conf
165 Allow devices behind the LPC PCI-ISA bridge to be configured.
166 The only supported devices are the TTY-class devices
167 .Ar com1
168 and
169 .Ar com2
170 and the boot ROM device
171 .Ar bootrom .
172 .Pp
173 .Ar help
174 print a list of supported LPC devices.
175 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
176 Guest physical memory size in bytes.
177 This must be the same size that was given to
178 .Xr bhyveload 8 .
179 .Pp
180 The size argument may be suffixed with one of K, M, G or T (either upper
181 or lower case) to indicate a multiple of kilobytes, megabytes, gigabytes,
182 or terabytes.
183 If no suffix is given, the value is assumed to be in megabytes.
184 .Pp
185 .Ar memsize
186 defaults to 256M.
187 .It Fl p Ar vcpu:hostcpu
188 Pin guest's virtual CPU
189 .Em vcpu
190 to
191 .Em hostcpu .
192 .It Fl P
193 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
194 .It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf
195 Configure a virtual PCI slot and function.
196 .Pp
197 .Nm
198 provides PCI bus emulation and virtual devices that can be attached to
199 slots on the bus.
200 There are 32 available slots, with the option of providing up to 8 functions
201 per slot.
202 .Bl -tag -width 10n
203 .It Ar help
204 print a list of supported PCI devices.
205 .It Ar slot
206 .Ar pcislot[:function]
207 .Ar bus:pcislot:function
208 .Pp
209 The
210 .Ar pcislot
211 value is 0 to 31.
212 The optional
213 .Ar function
214 value is 0 to 7.
215 The optional
216 .Ar bus
217 value is 0 to 255.
218 If not specified, the
219 .Ar function
220 value defaults to 0.
221 If not specified, the
222 .Ar bus
223 value defaults to 0.
224 .It Ar emulation
225 .Bl -tag -width 10n
226 .It Li hostbridge | Li amd_hostbridge
227 .Pp
228 Provide a simple host bridge.
229 This is usually configured at slot 0, and is required by most guest
230 operating systems.
231 The
232 .Li amd_hostbridge
233 emulation is identical but uses a PCI vendor ID of
234 .Li AMD .
235 .It Li passthru
236 PCI pass-through device.
237 .It Li virtio-net
238 Virtio network interface.
239 .It Li virtio-blk
240 Virtio block storage interface.
241 .It Li virtio-scsi
242 Virtio SCSI interface.
243 .It Li virtio-rnd
244 Virtio RNG interface.
245 .It Li virtio-console
246 Virtio console interface, which exposes multiple ports
247 to the guest in the form of simple char devices for simple IO
248 between the guest and host userspaces.
249 .It Li ahci
250 AHCI controller attached to arbitrary devices.
251 .It Li ahci-cd
252 AHCI controller attached to an ATAPI CD/DVD.
253 .It Li ahci-hd
254 AHCI controller attached to a SATA hard-drive.
255 .It Li e1000
256 Intel e82545 network interface.
257 .It Li uart
258 PCI 16550 serial device.
259 .It Li lpc
260 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
261 The LPC bridge emulation can only be configured on bus 0.
262 .It Li fbuf
263 Raw framebuffer device attached to VNC server.
264 .It Li xhci
265 eXtensible Host Controller Interface (xHCI) USB controller.
266 .It Li nvme
267 NVM Express (NVMe) controller.
268 .It Li hda
269 High Definition Audio Controller.
270 .El
271 .It Op Ar conf
272 This optional parameter describes the backend for device emulations.
273 If
274 .Ar conf
275 is not specified, the device emulation has no backend and can be
276 considered unconnected.
277 .Pp
278 Network devices:
279 .Bl -tag -width 10n
280 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
281 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
282 .Pp
283 If
284 .Ar mac
285 is not specified, the MAC address is derived from a fixed OUI and the
286 remaining bytes from an MD5 hash of the slot and function numbers and
287 the device name.
288 .Pp
289 The MAC address is an ASCII string in
290 .Xr ethers 5
291 format.
292 .El
293 .Pp
294 Block storage devices:
295 .Bl -tag -width 10n
296 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
297 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
298 .El
299 .Pp
300 The
301 .Ar block-device-options
302 are:
303 .Bl -tag -width 8n
304 .It Li nocache
305 Open the file with
306 .Dv O_DIRECT .
307 .It Li direct
308 Open the file using
309 .Dv O_SYNC .
310 .It Li ro
311 Force the file to be opened read-only.
312 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
313 Specify the logical and physical sector sizes of the emulated disk.
314 The physical sector size is optional and is equal to the logical sector size
315 if not explicitly specified.
316 .El
317 .Pp
318 SCSI devices:
319 .Bl -tag -width 10n
320 .It Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc Ns Oo , Ns Ar scsi-device-options Oc
321 .El
322 .Pp
323 The
324 .Ar scsi-device-options
325 are:
326 .Bl -tag -width 10n
327 .It Li iid= Ns Ar IID
328 Initiator ID to use when sending requests to specified CTL port.
329 The default value is 0.
330 .El
331 .Pp
332 TTY devices:
333 .Bl -tag -width 10n
334 .It Li stdio
335 Connect the serial port to the standard input and output of
336 the
337 .Nm
338 process.
339 .It Pa /dev/xxx
340 Use the host TTY device for serial port I/O.
341 .El
342 .Pp
343 Boot ROM device:
344 .Bl -tag -width 10n
345 .It Pa romfile
346 Map
347 .Ar romfile
348 in the guest address space reserved for boot firmware.
349 .El
350 .Pp
351 Pass-through devices:
352 .Bl -tag -width 10n
353 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
354 Connect to a PCI device on the host at the selector described by
355 .Ar slot ,
356 .Ar bus ,
357 and
358 .Ar function
359 numbers.
360 .El
361 .Pp
362 Guest memory must be wired using the
363 .Fl S
364 option when a pass-through device is configured.
365 .Pp
366 The host device must have been reserved at boot-time using the
367 .Va pptdevs
368 loader variable as described in
369 .Xr vmm 4 .
370 .Pp
371 Virtio console devices:
372 .Bl -tag -width 10n
373 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
374 A maximum of 16 ports per device can be created.
375 Every port is named and corresponds to a Unix domain socket created by
376 .Nm .
377 .Nm
378 accepts at most one connection per port at a time.
379 .Pp
380 Limitations:
381 .Bl -bullet -offset 2n
382 .It
383 Due to lack of destructors in
384 .Nm ,
385 sockets on the filesystem must be cleaned up manually after
386 .Nm
387 exits.
388 .It
389 There is no way to use the "console port" feature, nor the console port
390 resize at present.
391 .It
392 Emergency write is advertised, but no-op at present.
393 .El
394 .El
395 .Pp
396 Framebuffer devices:
397 .Bl -tag -width 10n
398 .It Xo
399 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
400 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
401 .Ar password Oc
402 .Xc
403 .Bl -tag -width 8n
404 .It Ar IPv4:port No or Ar [IPv6%zone]:port
405 An
406 .Ar IP
407 address and a
408 .Ar port
409 VNC should listen on.
410 The default is to listen on localhost IPv4 address and default VNC port 5900.
411 An IPv6 address must be enclosed in square brackets and may contain an
412 optional zone identifier.
413 .It Ar width No and Ar height
414 A display resolution, width and height, respectively.
415 If not specified, a default resolution of 1024x768 pixels will be used.
416 Minimal supported resolution is 640x480 pixels,
417 and maximum is 1920x1200 pixels.
418 .It Ar vgaconf
419 Possible values for this option are
420 .Dq io
421 (default),
422 .Dq on
423 , and
424 .Dq off .
425 PCI graphics cards have a dual personality in that they are
426 standard PCI devices with BAR addressing, but may also
427 implicitly decode legacy VGA I/O space
428 .Pq Ad 0x3c0-3df
429 and memory space
430 .Pq 64KB at Ad 0xA0000 .
431 The default
432 .Dq io
433 option should be used for guests that attempt to issue BIOS calls which result
434 in I/O port queries, and fail to boot if I/O decode is disabled.
435 .Pp
436 The
437 .Dq on
438 option should be used along with the CSM BIOS capability in UEFI
439 to boot traditional BIOS guests that require the legacy VGA I/O and
440 memory regions to be available.
441 .Pp
442 The
443 .Dq off
444 option should be used for the UEFI guests that assume that
445 VGA adapter is present if they detect the I/O ports.
446 An example of such a guest is
447 .Ox
448 in UEFI mode.
449 .Pp
450 Please refer to the
451 .Nm
452 .Fx
453 wiki page
454 .Pq Lk https://wiki.freebsd.org/bhyve
455 for configuration notes of particular guests.
456 .It wait
457 Instruct
458 .Nm
459 to only boot upon the initiation of a VNC connection, simplifying the
460 installation of operating systems that require immediate keyboard input.
461 This can be removed for post-installation use.
462 .It password
463 This type of authentication is known to be cryptographically weak and is not
464 intended for use on untrusted networks.
465 Many implementations will want to use stronger security, such as running
466 the session over an encrypted channel provided by IPsec or SSH.
467 .El
468 .El
469 .Pp
470 xHCI USB devices:
471 .Bl -tag -width 10n
472 .It Li tablet
473 A USB tablet device which provides precise cursor synchronization
474 when using VNC.
475 .El
476 .Pp
477 NVMe devices:
478 .Bl -tag -width 10n
479 .It Li devpath
480 Accepted device paths are:
481 .Ar /dev/blockdev
482 or
483 .Ar /path/to/image
484 or
485 .Ar ram=size_in_MiB .
486 .It Li maxq
487 Max number of queues.
488 .It Li qsz
489 Max elements in each queue.
490 .It Li ioslots
491 Max number of concurrent I/O requests.
492 .It Li sectsz
493 Sector size (defaults to blockif sector size).
494 .It Li ser
495 Serial number with maximum 20 characters.
496 .El
497 .Pp
498 HD Audio devices:
499 .Bl -tag -width 10n
500 .It Li play
501 Playback device, typically
502 .Ar /dev/dsp0 .
503 .It Li rec
504 Recording device, typically
505 .Ar /dev/dsp0 .
506 .El
507 .El
508 .It Fl S
509 Wire guest memory.
510 .It Fl u
511 RTC keeps UTC time.
512 .It Fl U Ar uuid
513 Set the universally unique identifier
514 .Pq UUID
515 in the guest's System Management BIOS System Information structure.
516 By default a UUID is generated from the host's hostname and
517 .Ar vmname .
518 .It Fl w
519 Ignore accesses to unimplemented Model Specific Registers (MSRs).
520 This is intended for debug purposes.
521 .It Fl W
522 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
523 interrupts.
524 .It Fl x
525 The guest's local APIC is configured in x2APIC mode.
526 .It Fl Y
527 Disable MPtable generation.
528 .It Ar vmname
529 Alphanumeric name of the guest.
530 This should be the same as that created by
531 .Xr bhyveload 8 .
532 .El
533 .Sh DEBUG SERVER
534 The current debug server provides limited support for debuggers.
535 .Ss Registers
536 Each virtual CPU is exposed to the debugger as a thread.
537 .Pp
538 General purpose registers can be queried for each virtual CPU, but other
539 registers such as floating-point and system registers cannot be queried.
540 .Ss Memory
541 Memory (including memory mapped I/O regions) can be read and written by the debugger.
542 Memory operations use virtual addresses that are resolved to physical addresses
543 via the current virtual CPU's active address translation.
544 .Ss Control
545 The running guest can be interrupted by the debugger at any time
546 .Pq for example, by pressing Ctrl-C in the debugger .
547 .Pp
548 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
549 .Pp
550 Breakpoints are supported on Intel CPUs that support single stepping.
551 Note that continuing from a breakpoint while interrupts are enabled in the
552 guest may not work as expected due to timer interrupts firing while single
553 stepping over the breakpoint.
554 .Sh SIGNAL HANDLING
555 .Nm
556 deals with the following signals:
557 .Pp
558 .Bl -tag -width indent -compact
559 .It SIGTERM
560 Trigger ACPI poweroff for a VM
561 .El
562 .Sh EXIT STATUS
563 Exit status indicates how the VM was terminated:
564 .Pp
565 .Bl -tag -width indent -compact
566 .It 0
567 rebooted
568 .It 1
569 powered off
570 .It 2
571 halted
572 .It 3
573 triple fault
574 .It 4
575 exited due to an error
576 .El
577 .Sh EXAMPLES
578 If not using a boot ROM, the guest operating system must have been loaded with
579 .Xr bhyveload 8
580 or a similar boot loader before
581 .Xr bhyve 4
582 can be run.
583 Otherwise, the boot loader is not needed.
584 .Pp
585 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
586 block device backed by the
587 .Pa /my/image
588 filesystem image, and a serial port for the console:
589 .Bd -literal -offset indent
590 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
591   -l com1,stdio -A -H -P -m 1G vm1
592 .Ed
593 .Pp
594 Run a 24GB single-CPU virtual machine with three network ports, one of which
595 has a MAC address specified:
596 .Bd -literal -offset indent
597 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
598   -s 2:1,virtio-net,tap1 \\
599   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
600   -s 3,virtio-blk,/my/image -l com1,stdio \\
601   -A -H -P -m 24G bigvm
602 .Ed
603 .Pp
604 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
605 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
606 port connected to an
607 .Xr nmdm 4
608 null-modem device.
609 .Bd -literal -offset indent
610 bhyve -c 4 \\
611   -s 0,amd_hostbridge -s 1,lpc \\
612   -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
613 hd:/images/disk.3,hd:/images/disk.4,\\
614 hd:/images/disk.5,hd:/images/disk.6,\\
615 hd:/images/disk.7,hd:/images/disk.8,\\
616 cd:/images/install.iso \\
617   -s 3,virtio-net,tap0 \\
618   -l com1,/dev/nmdm0A \\
619   -A -H -P -m 8G
620 .Ed
621 .Pp
622 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
623 that can be accessed via VNC at: 0.0.0.0:5900.
624 .Bd -literal -offset indent
625 bhyve -c 2 -m 4G -w -H \\
626   -s 0,hostbridge \\
627   -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
628   -s 4,ahci-hd,disk.img \\
629   -s 5,virtio-net,tap0 \\
630   -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
631   -s 30,xhci,tablet \\
632   -s 31,lpc -l com1,stdio \\
633   -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
634    uefivm
635 .Ed
636 .Pp
637 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
638 addresses on port 5900.
639 .Bd -literal -offset indent
640 bhyve -c 2 -m 4G -w -H \\
641   -s 0,hostbridge \\
642   -s 4,ahci-hd,disk.img \\
643   -s 5,virtio-net,tap0 \\
644   -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
645   -s 30,xhci,tablet \\
646   -s 31,lpc -l com1,stdio \\
647   -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
648    uefivm
649 .Ed
650 .Sh SEE ALSO
651 .Xr bhyve 4 ,
652 .Xr nmdm 4 ,
653 .Xr vmm 4 ,
654 .Xr ethers 5 ,
655 .Xr bhyvectl 8 ,
656 .Xr bhyveload 8
657 .Pp
658 .Rs
659 .%A Intel
660 .%B 64 and IA-32 Architectures Software Developer’s Manual
661 .%V Volume 3
662 .Re
663 .Sh HISTORY
664 .Nm
665 first appeared in
666 .Fx 10.0 .
667 .Sh AUTHORS
668 .An Neel Natu Aq Mt neel@freebsd.org
669 .An Peter Grehan Aq Mt grehan@freebsd.org