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