balloon: Allow multiple inhibit users
[qemu/ar7.git] / qemu-doc.texi
blobf74542a0e9a8c8fa20c00c00e98896cf1ed7a022
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename qemu-doc.info
4 @include version.texi
6 @documentlanguage en
7 @documentencoding UTF-8
9 @settitle QEMU version @value{VERSION} User Documentation
10 @exampleindent 0
11 @paragraphindent 0
12 @c %**end of header
14 @ifinfo
15 @direntry
16 * QEMU: (qemu-doc).    The QEMU Emulator User Documentation.
17 @end direntry
18 @end ifinfo
20 @iftex
21 @titlepage
22 @sp 7
23 @center @titlefont{QEMU version @value{VERSION}}
24 @sp 1
25 @center @titlefont{User Documentation}
26 @sp 3
27 @end titlepage
28 @end iftex
30 @ifnottex
31 @node Top
32 @top
34 @menu
35 * Introduction::
36 * QEMU PC System emulator::
37 * QEMU System emulator for non PC targets::
38 * QEMU Guest Agent::
39 * QEMU User space emulator::
40 * Implementation notes::
41 * Deprecated features::
42 * Supported build platforms::
43 * License::
44 * Index::
45 @end menu
46 @end ifnottex
48 @contents
50 @node Introduction
51 @chapter Introduction
53 @menu
54 * intro_features:: Features
55 @end menu
57 @node intro_features
58 @section Features
60 QEMU is a FAST! processor emulator using dynamic translation to
61 achieve good emulation speed.
63 @cindex operating modes
64 QEMU has two operating modes:
66 @itemize
67 @cindex system emulation
68 @item Full system emulation. In this mode, QEMU emulates a full system (for
69 example a PC), including one or several processors and various
70 peripherals. It can be used to launch different Operating Systems
71 without rebooting the PC or to debug system code.
73 @cindex user mode emulation
74 @item User mode emulation. In this mode, QEMU can launch
75 processes compiled for one CPU on another CPU. It can be used to
76 launch the Wine Windows API emulator (@url{https://www.winehq.org}) or
77 to ease cross-compilation and cross-debugging.
79 @end itemize
81 QEMU has the following features:
83 @itemize
84 @item QEMU can run without a host kernel driver and yet gives acceptable
85 performance.  It uses dynamic translation to native code for reasonable speed,
86 with support for self-modifying code and precise exceptions.
88 @item It is portable to several operating systems (GNU/Linux, *BSD, Mac OS X,
89 Windows) and architectures.
91 @item It performs accurate software emulation of the FPU.
92 @end itemize
94 QEMU user mode emulation has the following features:
95 @itemize
96 @item Generic Linux system call converter, including most ioctls.
98 @item clone() emulation using native CPU clone() to use Linux scheduler for threads.
100 @item Accurate signal handling by remapping host signals to target signals.
101 @end itemize
103 QEMU full system emulation has the following features:
104 @itemize
105 @item
106 QEMU uses a full software MMU for maximum portability.
108 @item
109 QEMU can optionally use an in-kernel accelerator, like kvm. The accelerators
110 execute most of the guest code natively, while
111 continuing to emulate the rest of the machine.
113 @item
114 Various hardware devices can be emulated and in some cases, host
115 devices (e.g. serial and parallel ports, USB, drives) can be used
116 transparently by the guest Operating System. Host device passthrough
117 can be used for talking to external physical peripherals (e.g. a
118 webcam, modem or tape drive).
120 @item
121 Symmetric multiprocessing (SMP) support.  Currently, an in-kernel
122 accelerator is required to use more than one host CPU for emulation.
124 @end itemize
127 @node QEMU PC System emulator
128 @chapter QEMU PC System emulator
129 @cindex system emulation (PC)
131 @menu
132 * pcsys_introduction:: Introduction
133 * pcsys_quickstart::   Quick Start
134 * sec_invocation::     Invocation
135 * pcsys_keys::         Keys in the graphical frontends
136 * mux_keys::           Keys in the character backend multiplexer
137 * pcsys_monitor::      QEMU Monitor
138 * cpu_models::         CPU models
139 * disk_images::        Disk Images
140 * pcsys_network::      Network emulation
141 * pcsys_other_devs::   Other Devices
142 * direct_linux_boot::  Direct Linux Boot
143 * pcsys_usb::          USB emulation
144 * vnc_security::       VNC security
145 * network_tls::        TLS setup for network services
146 * gdb_usage::          GDB usage
147 * pcsys_os_specific::  Target OS specific information
148 @end menu
150 @node pcsys_introduction
151 @section Introduction
153 @c man begin DESCRIPTION
155 The QEMU PC System emulator simulates the
156 following peripherals:
158 @itemize @minus
159 @item
160 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
161 @item
162 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
163 extensions (hardware level, including all non standard modes).
164 @item
165 PS/2 mouse and keyboard
166 @item
167 2 PCI IDE interfaces with hard disk and CD-ROM support
168 @item
169 Floppy disk
170 @item
171 PCI and ISA network adapters
172 @item
173 Serial ports
174 @item
175 IPMI BMC, either and internal or external one
176 @item
177 Creative SoundBlaster 16 sound card
178 @item
179 ENSONIQ AudioPCI ES1370 sound card
180 @item
181 Intel 82801AA AC97 Audio compatible sound card
182 @item
183 Intel HD Audio Controller and HDA codec
184 @item
185 Adlib (OPL2) - Yamaha YM3812 compatible chip
186 @item
187 Gravis Ultrasound GF1 sound card
188 @item
189 CS4231A compatible sound card
190 @item
191 PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 hub.
192 @end itemize
194 SMP is supported with up to 255 CPUs.
196 QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL
197 VGA BIOS.
199 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
201 QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
202 by Tibor "TS" Schütz.
204 Note that, by default, GUS shares IRQ(7) with parallel ports and so
205 QEMU must be told to not have parallel ports to have working GUS.
207 @example
208 qemu-system-i386 dos.img -soundhw gus -parallel none
209 @end example
211 Alternatively:
212 @example
213 qemu-system-i386 dos.img -device gus,irq=5
214 @end example
216 Or some other unclaimed IRQ.
218 CS4231A is the chip used in Windows Sound System and GUSMAX products
220 @c man end
222 @node pcsys_quickstart
223 @section Quick Start
224 @cindex quick start
226 Download and uncompress the linux image (@file{linux.img}) and type:
228 @example
229 qemu-system-i386 linux.img
230 @end example
232 Linux should boot and give you a prompt.
234 @node sec_invocation
235 @section Invocation
237 @example
238 @c man begin SYNOPSIS
239 @command{qemu-system-i386} [@var{options}] [@var{disk_image}]
240 @c man end
241 @end example
243 @c man begin OPTIONS
244 @var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
245 targets do not need a disk image.
247 @include qemu-options.texi
249 @c man end
251 @subsection Device URL Syntax
252 @c TODO merge this with section Disk Images
254 @c man begin NOTES
256 In addition to using normal file images for the emulated storage devices,
257 QEMU can also use networked resources such as iSCSI devices. These are
258 specified using a special URL syntax.
260 @table @option
261 @item iSCSI
262 iSCSI support allows QEMU to access iSCSI resources directly and use as
263 images for the guest storage. Both disk and cdrom images are supported.
265 Syntax for specifying iSCSI LUNs is
266 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
268 By default qemu will use the iSCSI initiator-name
269 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
270 line or a configuration file.
272 Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect
273 stalled requests and force a reestablishment of the session. The timeout
274 is specified in seconds. The default is 0 which means no timeout. Libiscsi
275 1.15.0 or greater is required for this feature.
277 Example (without authentication):
278 @example
279 qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
280                  -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
281                  -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
282 @end example
284 Example (CHAP username/password via URL):
285 @example
286 qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
287 @end example
289 Example (CHAP username/password via environment variables):
290 @example
291 LIBISCSI_CHAP_USERNAME="user" \
292 LIBISCSI_CHAP_PASSWORD="password" \
293 qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
294 @end example
296 @item NBD
297 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
298 as Unix Domain Sockets.
300 Syntax for specifying a NBD device using TCP
301 ``nbd:<server-ip>:<port>[:exportname=<export>]''
303 Syntax for specifying a NBD device using Unix Domain Sockets
304 ``nbd:unix:<domain-socket>[:exportname=<export>]''
306 Example for TCP
307 @example
308 qemu-system-i386 --drive file=nbd:192.0.2.1:30000
309 @end example
311 Example for Unix Domain Sockets
312 @example
313 qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
314 @end example
316 @item SSH
317 QEMU supports SSH (Secure Shell) access to remote disks.
319 Examples:
320 @example
321 qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
322 qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
323 @end example
325 Currently authentication must be done using ssh-agent.  Other
326 authentication methods may be supported in future.
328 @item Sheepdog
329 Sheepdog is a distributed storage system for QEMU.
330 QEMU supports using either local sheepdog devices or remote networked
331 devices.
333 Syntax for specifying a sheepdog device
334 @example
335 sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
336 @end example
338 Example
339 @example
340 qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
341 @end example
343 See also @url{https://sheepdog.github.io/sheepdog/}.
345 @item GlusterFS
346 GlusterFS is a user space distributed file system.
347 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
348 TCP, Unix Domain Sockets and RDMA transport protocols.
350 Syntax for specifying a VM disk image on GlusterFS volume is
351 @example
353 URI:
354 gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...]
356 JSON:
357 'json:@{"driver":"qcow2","file":@{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...",
358 @                                 "server":[@{"type":"tcp","host":"...","port":"..."@},
359 @                                           @{"type":"unix","socket":"..."@}]@}@}'
360 @end example
363 Example
364 @example
365 URI:
366 qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img,
367 @                               file.debug=9,file.logfile=/var/log/qemu-gluster.log
369 JSON:
370 qemu-system-x86_64 'json:@{"driver":"qcow2",
371 @                          "file":@{"driver":"gluster",
372 @                                   "volume":"testvol","path":"a.img",
373 @                                   "debug":9,"logfile":"/var/log/qemu-gluster.log",
374 @                                   "server":[@{"type":"tcp","host":"1.2.3.4","port":24007@},
375 @                                             @{"type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}'
376 qemu-system-x86_64 -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
377 @                                      file.debug=9,file.logfile=/var/log/qemu-gluster.log,
378 @                                      file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
379 @                                      file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
380 @end example
382 See also @url{http://www.gluster.org}.
384 @item HTTP/HTTPS/FTP/FTPS
385 QEMU supports read-only access to files accessed over http(s) and ftp(s).
387 Syntax using a single filename:
388 @example
389 <protocol>://[<username>[:<password>]@@]<host>/<path>
390 @end example
392 where:
393 @table @option
394 @item protocol
395 'http', 'https', 'ftp', or 'ftps'.
397 @item username
398 Optional username for authentication to the remote server.
400 @item password
401 Optional password for authentication to the remote server.
403 @item host
404 Address of the remote server.
406 @item path
407 Path on the remote server, including any query string.
408 @end table
410 The following options are also supported:
411 @table @option
412 @item url
413 The full URL when passing options to the driver explicitly.
415 @item readahead
416 The amount of data to read ahead with each range request to the remote server.
417 This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
418 does not have a suffix, it will be assumed to be in bytes. The value must be a
419 multiple of 512 bytes. It defaults to 256k.
421 @item sslverify
422 Whether to verify the remote server's certificate when connecting over SSL. It
423 can have the value 'on' or 'off'. It defaults to 'on'.
425 @item cookie
426 Send this cookie (it can also be a list of cookies separated by ';') with
427 each outgoing request.  Only supported when using protocols such as HTTP
428 which support cookies, otherwise ignored.
430 @item timeout
431 Set the timeout in seconds of the CURL connection. This timeout is the time
432 that CURL waits for a response from the remote server to get the size of the
433 image to be downloaded. If not set, the default timeout of 5 seconds is used.
434 @end table
436 Note that when passing options to qemu explicitly, @option{driver} is the value
437 of <protocol>.
439 Example: boot from a remote Fedora 20 live ISO image
440 @example
441 qemu-system-x86_64 --drive media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
443 qemu-system-x86_64 --drive media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
444 @end example
446 Example: boot from a remote Fedora 20 cloud image using a local overlay for
447 writes, copy-on-read, and a readahead of 64k
448 @example
449 qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2
451 qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
452 @end example
454 Example: boot from an image stored on a VMware vSphere server with a self-signed
455 certificate using a local overlay for writes, a readahead of 64k and a timeout
456 of 10 seconds.
457 @example
458 qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2
460 qemu-system-x86_64 -drive file=/tmp/test.qcow2
461 @end example
463 @end table
465 @c man end
467 @node pcsys_keys
468 @section Keys in the graphical frontends
470 @c man begin OPTIONS
472 During the graphical emulation, you can use special key combinations to change
473 modes. The default key mappings are shown below, but if you use @code{-alt-grab}
474 then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use
475 @code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt):
477 @table @key
478 @item Ctrl-Alt-f
479 @kindex Ctrl-Alt-f
480 Toggle full screen
482 @item Ctrl-Alt-+
483 @kindex Ctrl-Alt-+
484 Enlarge the screen
486 @item Ctrl-Alt--
487 @kindex Ctrl-Alt--
488 Shrink the screen
490 @item Ctrl-Alt-u
491 @kindex Ctrl-Alt-u
492 Restore the screen's un-scaled dimensions
494 @item Ctrl-Alt-n
495 @kindex Ctrl-Alt-n
496 Switch to virtual console 'n'. Standard console mappings are:
497 @table @emph
498 @item 1
499 Target system display
500 @item 2
501 Monitor
502 @item 3
503 Serial port
504 @end table
506 @item Ctrl-Alt
507 @kindex Ctrl-Alt
508 Toggle mouse and keyboard grab.
509 @end table
511 @kindex Ctrl-Up
512 @kindex Ctrl-Down
513 @kindex Ctrl-PageUp
514 @kindex Ctrl-PageDown
515 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
516 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
518 @c man end
520 @node mux_keys
521 @section Keys in the character backend multiplexer
523 @c man begin OPTIONS
525 During emulation, if you are using a character backend multiplexer
526 (which is the default if you are using @option{-nographic}) then
527 several commands are available via an escape sequence. These
528 key sequences all start with an escape character, which is @key{Ctrl-a}
529 by default, but can be changed with @option{-echr}. The list below assumes
530 you're using the default.
532 @table @key
533 @item Ctrl-a h
534 @kindex Ctrl-a h
535 Print this help
536 @item Ctrl-a x
537 @kindex Ctrl-a x
538 Exit emulator
539 @item Ctrl-a s
540 @kindex Ctrl-a s
541 Save disk data back to file (if -snapshot)
542 @item Ctrl-a t
543 @kindex Ctrl-a t
544 Toggle console timestamps
545 @item Ctrl-a b
546 @kindex Ctrl-a b
547 Send break (magic sysrq in Linux)
548 @item Ctrl-a c
549 @kindex Ctrl-a c
550 Rotate between the frontends connected to the multiplexer (usually
551 this switches between the monitor and the console)
552 @item Ctrl-a Ctrl-a
553 @kindex Ctrl-a Ctrl-a
554 Send the escape character to the frontend
555 @end table
556 @c man end
558 @ignore
560 @c man begin SEEALSO
561 The HTML documentation of QEMU for more precise information and Linux
562 user mode emulator invocation.
563 @c man end
565 @c man begin AUTHOR
566 Fabrice Bellard
567 @c man end
569 @end ignore
571 @node pcsys_monitor
572 @section QEMU Monitor
573 @cindex QEMU monitor
575 The QEMU monitor is used to give complex commands to the QEMU
576 emulator. You can use it to:
578 @itemize @minus
580 @item
581 Remove or insert removable media images
582 (such as CD-ROM or floppies).
584 @item
585 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
586 from a disk file.
588 @item Inspect the VM state without an external debugger.
590 @end itemize
592 @subsection Commands
594 The following commands are available:
596 @include qemu-monitor.texi
598 @include qemu-monitor-info.texi
600 @subsection Integer expressions
602 The monitor understands integers expressions for every integer
603 argument. You can use register names to get the value of specifics
604 CPU registers by prefixing them with @emph{$}.
606 @node cpu_models
607 @section CPU models
609 @include docs/qemu-cpu-models.texi
611 @node disk_images
612 @section Disk Images
614 QEMU supports many disk image formats, including growable disk images
615 (their size increase as non empty sectors are written), compressed and
616 encrypted disk images.
618 @menu
619 * disk_images_quickstart::    Quick start for disk image creation
620 * disk_images_snapshot_mode:: Snapshot mode
621 * vm_snapshots::              VM snapshots
622 * qemu_img_invocation::       qemu-img Invocation
623 * qemu_nbd_invocation::       qemu-nbd Invocation
624 * disk_images_formats::       Disk image file formats
625 * host_drives::               Using host drives
626 * disk_images_fat_images::    Virtual FAT disk images
627 * disk_images_nbd::           NBD access
628 * disk_images_sheepdog::      Sheepdog disk images
629 * disk_images_iscsi::         iSCSI LUNs
630 * disk_images_gluster::       GlusterFS disk images
631 * disk_images_ssh::           Secure Shell (ssh) disk images
632 * disk_images_nvme::          NVMe userspace driver
633 * disk_image_locking::        Disk image file locking
634 @end menu
636 @node disk_images_quickstart
637 @subsection Quick start for disk image creation
639 You can create a disk image with the command:
640 @example
641 qemu-img create myimage.img mysize
642 @end example
643 where @var{myimage.img} is the disk image filename and @var{mysize} is its
644 size in kilobytes. You can add an @code{M} suffix to give the size in
645 megabytes and a @code{G} suffix for gigabytes.
647 See @ref{qemu_img_invocation} for more information.
649 @node disk_images_snapshot_mode
650 @subsection Snapshot mode
652 If you use the option @option{-snapshot}, all disk images are
653 considered as read only. When sectors in written, they are written in
654 a temporary file created in @file{/tmp}. You can however force the
655 write back to the raw disk images by using the @code{commit} monitor
656 command (or @key{C-a s} in the serial console).
658 @node vm_snapshots
659 @subsection VM snapshots
661 VM snapshots are snapshots of the complete virtual machine including
662 CPU state, RAM, device state and the content of all the writable
663 disks. In order to use VM snapshots, you must have at least one non
664 removable and writable block device using the @code{qcow2} disk image
665 format. Normally this device is the first virtual hard drive.
667 Use the monitor command @code{savevm} to create a new VM snapshot or
668 replace an existing one. A human readable name can be assigned to each
669 snapshot in addition to its numerical ID.
671 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
672 a VM snapshot. @code{info snapshots} lists the available snapshots
673 with their associated information:
675 @example
676 (qemu) info snapshots
677 Snapshot devices: hda
678 Snapshot list (from hda):
679 ID        TAG                 VM SIZE                DATE       VM CLOCK
680 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
681 2                                 40M 2006-08-06 12:43:29   00:00:18.633
682 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
683 @end example
685 A VM snapshot is made of a VM state info (its size is shown in
686 @code{info snapshots}) and a snapshot of every writable disk image.
687 The VM state info is stored in the first @code{qcow2} non removable
688 and writable block device. The disk image snapshots are stored in
689 every disk image. The size of a snapshot in a disk image is difficult
690 to evaluate and is not shown by @code{info snapshots} because the
691 associated disk sectors are shared among all the snapshots to save
692 disk space (otherwise each snapshot would need a full copy of all the
693 disk images).
695 When using the (unrelated) @code{-snapshot} option
696 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
697 but they are deleted as soon as you exit QEMU.
699 VM snapshots currently have the following known limitations:
700 @itemize
701 @item
702 They cannot cope with removable devices if they are removed or
703 inserted after a snapshot is done.
704 @item
705 A few device drivers still have incomplete snapshot support so their
706 state is not saved or restored properly (in particular USB).
707 @end itemize
709 @node qemu_img_invocation
710 @subsection @code{qemu-img} Invocation
712 @include qemu-img.texi
714 @node qemu_nbd_invocation
715 @subsection @code{qemu-nbd} Invocation
717 @include qemu-nbd.texi
719 @include docs/qemu-block-drivers.texi
721 @node pcsys_network
722 @section Network emulation
724 QEMU can simulate several network cards (e.g. PCI or ISA cards on the PC
725 target) and can connect them to a network backend on the host or an emulated
726 hub. The various host network backends can either be used to connect the NIC of
727 the guest to a real network (e.g. by using a TAP devices or the non-privileged
728 user mode network stack), or to other guest instances running in another QEMU
729 process (e.g. by using the socket host network backend).
731 @subsection Using TAP network interfaces
733 This is the standard way to connect QEMU to a real network. QEMU adds
734 a virtual network device on your host (called @code{tapN}), and you
735 can then configure it as if it was a real ethernet card.
737 @subsubsection Linux host
739 As an example, you can download the @file{linux-test-xxx.tar.gz}
740 archive and copy the script @file{qemu-ifup} in @file{/etc} and
741 configure properly @code{sudo} so that the command @code{ifconfig}
742 contained in @file{qemu-ifup} can be executed as root. You must verify
743 that your host kernel supports the TAP network interfaces: the
744 device @file{/dev/net/tun} must be present.
746 See @ref{sec_invocation} to have examples of command lines using the
747 TAP network interfaces.
749 @subsubsection Windows host
751 There is a virtual ethernet driver for Windows 2000/XP systems, called
752 TAP-Win32. But it is not included in standard QEMU for Windows,
753 so you will need to get it separately. It is part of OpenVPN package,
754 so download OpenVPN from : @url{https://openvpn.net/}.
756 @subsection Using the user mode network stack
758 By using the option @option{-net user} (default configuration if no
759 @option{-net} option is specified), QEMU uses a completely user mode
760 network stack (you don't need root privilege to use the virtual
761 network). The virtual network configuration is the following:
763 @example
765      guest (10.0.2.15)  <------>  Firewall/DHCP server <-----> Internet
766                            |          (10.0.2.2)
767                            |
768                            ---->  DNS server (10.0.2.3)
769                            |
770                            ---->  SMB server (10.0.2.4)
771 @end example
773 The QEMU VM behaves as if it was behind a firewall which blocks all
774 incoming connections. You can use a DHCP client to automatically
775 configure the network in the QEMU VM. The DHCP server assign addresses
776 to the hosts starting from 10.0.2.15.
778 In order to check that the user mode network is working, you can ping
779 the address 10.0.2.2 and verify that you got an address in the range
780 10.0.2.x from the QEMU virtual DHCP server.
782 Note that ICMP traffic in general does not work with user mode networking.
783 @code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work,
784 however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP
785 ping sockets to allow @code{ping} to the Internet. The host admin has to set
786 the ping_group_range in order to grant access to those sockets. To allow ping
787 for GID 100 (usually users group):
789 @example
790 echo 100 100 > /proc/sys/net/ipv4/ping_group_range
791 @end example
793 When using the built-in TFTP server, the router is also the TFTP
794 server.
796 When using the @option{'-netdev user,hostfwd=...'} option, TCP or UDP
797 connections can be redirected from the host to the guest. It allows for
798 example to redirect X11, telnet or SSH connections.
800 @subsection Hubs
802 QEMU can simulate several hubs. A hub can be thought of as a virtual connection
803 between several network devices. These devices can be for example QEMU virtual
804 ethernet cards or virtual Host ethernet devices (TAP devices). You can connect
805 guest NICs or host network backends to such a hub using the @option{-netdev
806 hubport} or @option{-nic hubport} options. The legacy @option{-net} option
807 also connects the given device to the emulated hub with ID 0 (i.e. the default
808 hub) unless you specify a netdev with @option{-net nic,netdev=xxx} here.
810 @subsection Connecting emulated networks between QEMU instances
812 Using the @option{-netdev socket} (or @option{-nic socket} or
813 @option{-net socket}) option, it is possible to create emulated
814 networks that span several QEMU instances.
815 See the description of the @option{-netdev socket} option in the
816 @ref{sec_invocation,,Invocation chapter} to have a basic example.
818 @node pcsys_other_devs
819 @section Other Devices
821 @subsection Inter-VM Shared Memory device
823 On Linux hosts, a shared memory device is available.  The basic syntax
826 @example
827 qemu-system-x86_64 -device ivshmem-plain,memdev=@var{hostmem}
828 @end example
830 where @var{hostmem} names a host memory backend.  For a POSIX shared
831 memory backend, use something like
833 @example
834 -object memory-backend-file,size=1M,share,mem-path=/dev/shm/ivshmem,id=@var{hostmem}
835 @end example
837 If desired, interrupts can be sent between guest VMs accessing the same shared
838 memory region.  Interrupt support requires using a shared memory server and
839 using a chardev socket to connect to it.  The code for the shared memory server
840 is qemu.git/contrib/ivshmem-server.  An example syntax when using the shared
841 memory server is:
843 @example
844 # First start the ivshmem server once and for all
845 ivshmem-server -p @var{pidfile} -S @var{path} -m @var{shm-name} -l @var{shm-size} -n @var{vectors}
847 # Then start your qemu instances with matching arguments
848 qemu-system-x86_64 -device ivshmem-doorbell,vectors=@var{vectors},chardev=@var{id}
849                  -chardev socket,path=@var{path},id=@var{id}
850 @end example
852 When using the server, the guest will be assigned a VM ID (>=0) that allows guests
853 using the same server to communicate via interrupts.  Guests can read their
854 VM ID from a device register (see ivshmem-spec.txt).
856 @subsubsection Migration with ivshmem
858 With device property @option{master=on}, the guest will copy the shared
859 memory on migration to the destination host.  With @option{master=off},
860 the guest will not be able to migrate with the device attached.  In the
861 latter case, the device should be detached and then reattached after
862 migration using the PCI hotplug support.
864 At most one of the devices sharing the same memory can be master.  The
865 master must complete migration before you plug back the other devices.
867 @subsubsection ivshmem and hugepages
869 Instead of specifying the <shm size> using POSIX shm, you may specify
870 a memory backend that has hugepage support:
872 @example
873 qemu-system-x86_64 -object memory-backend-file,size=1G,mem-path=/dev/hugepages/my-shmem-file,share,id=mb1
874                  -device ivshmem-plain,memdev=mb1
875 @end example
877 ivshmem-server also supports hugepages mount points with the
878 @option{-m} memory path argument.
880 @node direct_linux_boot
881 @section Direct Linux Boot
883 This section explains how to launch a Linux kernel inside QEMU without
884 having to make a full bootable image. It is very useful for fast Linux
885 kernel testing.
887 The syntax is:
888 @example
889 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
890 @end example
892 Use @option{-kernel} to provide the Linux kernel image and
893 @option{-append} to give the kernel command line arguments. The
894 @option{-initrd} option can be used to provide an INITRD image.
896 When using the direct Linux boot, a disk image for the first hard disk
897 @file{hda} is required because its boot sector is used to launch the
898 Linux kernel.
900 If you do not need graphical output, you can disable it and redirect
901 the virtual serial port and the QEMU monitor to the console with the
902 @option{-nographic} option. The typical command line is:
903 @example
904 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
905                  -append "root=/dev/hda console=ttyS0" -nographic
906 @end example
908 Use @key{Ctrl-a c} to switch between the serial console and the
909 monitor (@pxref{pcsys_keys}).
911 @node pcsys_usb
912 @section USB emulation
914 QEMU can emulate a PCI UHCI, OHCI, EHCI or XHCI USB controller. You can
915 plug virtual USB devices or real host USB devices (only works with certain
916 host operating systems). QEMU will automatically create and connect virtual
917 USB hubs as necessary to connect multiple USB devices.
919 @menu
920 * usb_devices::
921 * host_usb_devices::
922 @end menu
923 @node usb_devices
924 @subsection Connecting USB devices
926 USB devices can be connected with the @option{-device usb-...} command line
927 option or the @code{device_add} monitor command. Available devices are:
929 @table @code
930 @item usb-mouse
931 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
932 @item usb-tablet
933 Pointer device that uses absolute coordinates (like a touchscreen).
934 This means QEMU is able to report the mouse position without having
935 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
936 @item usb-storage,drive=@var{drive_id}
937 Mass storage device backed by @var{drive_id} (@pxref{disk_images})
938 @item usb-uas
939 USB attached SCSI device, see
940 @url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt}
941 for details
942 @item usb-bot
943 Bulk-only transport storage device, see
944 @url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=docs/usb-storage.txt,usb-storage.txt}
945 for details here, too
946 @item usb-mtp,x-root=@var{dir}
947 Media transfer protocol device, using @var{dir} as root of the file tree
948 that is presented to the guest.
949 @item usb-host,hostbus=@var{bus},hostaddr=@var{addr}
950 Pass through the host device identified by @var{bus} and @var{addr}
951 @item usb-host,vendorid=@var{vendor},productid=@var{product}
952 Pass through the host device identified by @var{vendor} and @var{product} ID
953 @item usb-wacom-tablet
954 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
955 above but it can be used with the tslib library because in addition to touch
956 coordinates it reports touch pressure.
957 @item usb-kbd
958 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
959 @item usb-serial,chardev=@var{id}
960 Serial converter. This emulates an FTDI FT232BM chip connected to host character
961 device @var{id}.
962 @item usb-braille,chardev=@var{id}
963 Braille device.  This will use BrlAPI to display the braille output on a real
964 or fake device referenced by @var{id}.
965 @item usb-net[,netdev=@var{id}]
966 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{id}
967 specifies a netdev defined with @code{-netdev @dots{},id=@var{id}}.
968 For instance, user-mode networking can be used with
969 @example
970 qemu-system-i386 [...] -netdev user,id=net0 -device usb-net,netdev=net0
971 @end example
972 @item usb-ccid
973 Smartcard reader device
974 @item usb-audio
975 USB audio device
976 @item usb-bt-dongle
977 Bluetooth dongle for the transport layer of HCI. It is connected to HCI
978 scatternet 0 by default (corresponds to @code{-bt hci,vlan=0}).
979 Note that the syntax for the @code{-device usb-bt-dongle} option is not as
980 useful yet as it was with the legacy @code{-usbdevice} option. So to
981 configure an USB bluetooth device, you might need to use
982 "@code{-usbdevice bt}[:@var{hci-type}]" instead. This configures a
983 bluetooth dongle whose type is specified in the same format as with
984 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
985 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
986 This USB device implements the USB Transport Layer of HCI.  Example
987 usage:
988 @example
989 @command{qemu-system-i386} [...@var{OPTIONS}...] @option{-usbdevice} bt:hci,vlan=3 @option{-bt} device:keyboard,vlan=3
990 @end example
991 @end table
993 @node host_usb_devices
994 @subsection Using host USB devices on a Linux host
996 WARNING: this is an experimental feature. QEMU will slow down when
997 using it. USB devices requiring real time streaming (i.e. USB Video
998 Cameras) are not supported yet.
1000 @enumerate
1001 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1002 is actually using the USB device. A simple way to do that is simply to
1003 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1004 to @file{mydriver.o.disabled}.
1006 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1007 @example
1008 ls /proc/bus/usb
1009 001  devices  drivers
1010 @end example
1012 @item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices:
1013 @example
1014 chown -R myuid /proc/bus/usb
1015 @end example
1017 @item Launch QEMU and do in the monitor:
1018 @example
1019 info usbhost
1020   Device 1.2, speed 480 Mb/s
1021     Class 00: USB device 1234:5678, USB DISK
1022 @end example
1023 You should see the list of the devices you can use (Never try to use
1024 hubs, it won't work).
1026 @item Add the device in QEMU by using:
1027 @example
1028 device_add usb-host,vendorid=0x1234,productid=0x5678
1029 @end example
1031 Normally the guest OS should report that a new USB device is plugged.
1032 You can use the option @option{-device usb-host,...} to do the same.
1034 @item Now you can try to use the host USB device in QEMU.
1036 @end enumerate
1038 When relaunching QEMU, you may have to unplug and plug again the USB
1039 device to make it work again (this is a bug).
1041 @node vnc_security
1042 @section VNC security
1044 The VNC server capability provides access to the graphical console
1045 of the guest VM across the network. This has a number of security
1046 considerations depending on the deployment scenarios.
1048 @menu
1049 * vnc_sec_none::
1050 * vnc_sec_password::
1051 * vnc_sec_certificate::
1052 * vnc_sec_certificate_verify::
1053 * vnc_sec_certificate_pw::
1054 * vnc_sec_sasl::
1055 * vnc_sec_certificate_sasl::
1056 * vnc_setup_sasl::
1057 @end menu
1058 @node vnc_sec_none
1059 @subsection Without passwords
1061 The simplest VNC server setup does not include any form of authentication.
1062 For this setup it is recommended to restrict it to listen on a UNIX domain
1063 socket only. For example
1065 @example
1066 qemu-system-i386 [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1067 @end example
1069 This ensures that only users on local box with read/write access to that
1070 path can access the VNC server. To securely access the VNC server from a
1071 remote machine, a combination of netcat+ssh can be used to provide a secure
1072 tunnel.
1074 @node vnc_sec_password
1075 @subsection With passwords
1077 The VNC protocol has limited support for password based authentication. Since
1078 the protocol limits passwords to 8 characters it should not be considered
1079 to provide high security. The password can be fairly easily brute-forced by
1080 a client making repeat connections. For this reason, a VNC server using password
1081 authentication should be restricted to only listen on the loopback interface
1082 or UNIX domain sockets. Password authentication is not supported when operating
1083 in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password
1084 authentication is requested with the @code{password} option, and then once QEMU
1085 is running the password is set with the monitor. Until the monitor is used to
1086 set the password all clients will be rejected.
1088 @example
1089 qemu-system-i386 [...OPTIONS...] -vnc :1,password -monitor stdio
1090 (qemu) change vnc password
1091 Password: ********
1092 (qemu)
1093 @end example
1095 @node vnc_sec_certificate
1096 @subsection With x509 certificates
1098 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1099 TLS for encryption of the session, and x509 certificates for authentication.
1100 The use of x509 certificates is strongly recommended, because TLS on its
1101 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1102 support provides a secure session, but no authentication. This allows any
1103 client to connect, and provides an encrypted session.
1105 @example
1106 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1107 @end example
1109 In the above example @code{/etc/pki/qemu} should contain at least three files,
1110 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1111 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1112 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1113 only be readable by the user owning it.
1115 @node vnc_sec_certificate_verify
1116 @subsection With x509 certificates and client verification
1118 Certificates can also provide a means to authenticate the client connecting.
1119 The server will request that the client provide a certificate, which it will
1120 then validate against the CA certificate. This is a good choice if deploying
1121 in an environment with a private internal certificate authority.
1123 @example
1124 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1125 @end example
1128 @node vnc_sec_certificate_pw
1129 @subsection With x509 certificates, client verification and passwords
1131 Finally, the previous method can be combined with VNC password authentication
1132 to provide two layers of authentication for clients.
1134 @example
1135 qemu-system-i386 [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1136 (qemu) change vnc password
1137 Password: ********
1138 (qemu)
1139 @end example
1142 @node vnc_sec_sasl
1143 @subsection With SASL authentication
1145 The SASL authentication method is a VNC extension, that provides an
1146 easily extendable, pluggable authentication method. This allows for
1147 integration with a wide range of authentication mechanisms, such as
1148 PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1149 The strength of the authentication depends on the exact mechanism
1150 configured. If the chosen mechanism also provides a SSF layer, then
1151 it will encrypt the datastream as well.
1153 Refer to the later docs on how to choose the exact SASL mechanism
1154 used for authentication, but assuming use of one supporting SSF,
1155 then QEMU can be launched with:
1157 @example
1158 qemu-system-i386 [...OPTIONS...] -vnc :1,sasl -monitor stdio
1159 @end example
1161 @node vnc_sec_certificate_sasl
1162 @subsection With x509 certificates and SASL authentication
1164 If the desired SASL authentication mechanism does not supported
1165 SSF layers, then it is strongly advised to run it in combination
1166 with TLS and x509 certificates. This provides securely encrypted
1167 data stream, avoiding risk of compromising of the security
1168 credentials. This can be enabled, by combining the 'sasl' option
1169 with the aforementioned TLS + x509 options:
1171 @example
1172 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1173 @end example
1175 @node vnc_setup_sasl
1177 @subsection Configuring SASL mechanisms
1179 The following documentation assumes use of the Cyrus SASL implementation on a
1180 Linux host, but the principles should apply to any other SASL implementation
1181 or host. When SASL is enabled, the mechanism configuration will be loaded from
1182 system default SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1183 unprivileged user, an environment variable SASL_CONF_PATH can be used to make
1184 it search alternate locations for the service config file.
1186 If the TLS option is enabled for VNC, then it will provide session encryption,
1187 otherwise the SASL mechanism will have to provide encryption. In the latter
1188 case the list of possible plugins that can be used is drastically reduced. In
1189 fact only the GSSAPI SASL mechanism provides an acceptable level of security
1190 by modern standards. Previous versions of QEMU referred to the DIGEST-MD5
1191 mechanism, however, it has multiple serious flaws described in detail in
1192 RFC 6331 and thus should never be used any more. The SCRAM-SHA-1 mechanism
1193 provides a simple username/password auth facility similar to DIGEST-MD5, but
1194 does not support session encryption, so can only be used in combination with
1195 TLS.
1197 When not using TLS the recommended configuration is
1199 @example
1200 mech_list: gssapi
1201 keytab: /etc/qemu/krb5.tab
1202 @end example
1204 This says to use the 'GSSAPI' mechanism with the Kerberos v5 protocol, with
1205 the server principal stored in /etc/qemu/krb5.tab. For this to work the
1206 administrator of your KDC must generate a Kerberos principal for the server,
1207 with a name of 'qemu/somehost.example.com@@EXAMPLE.COM' replacing
1208 'somehost.example.com' with the fully qualified host name of the machine
1209 running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm.
1211 When using TLS, if username+password authentication is desired, then a
1212 reasonable configuration is
1214 @example
1215 mech_list: scram-sha-1
1216 sasldb_path: /etc/qemu/passwd.db
1217 @end example
1219 The @code{saslpasswd2} program can be used to populate the @code{passwd.db}
1220 file with accounts.
1222 Other SASL configurations will be left as an exercise for the reader. Note that
1223 all mechanisms, except GSSAPI, should be combined with use of TLS to ensure a
1224 secure data channel.
1227 @node network_tls
1228 @section TLS setup for network services
1230 Almost all network services in QEMU have the ability to use TLS for
1231 session data encryption, along with x509 certificates for simple
1232 client authentication. What follows is a description of how to
1233 generate certificates suitable for usage with QEMU, and applies to
1234 the VNC server, character devices with the TCP backend, NBD server
1235 and client, and migration server and client.
1237 At a high level, QEMU requires certificates and private keys to be
1238 provided in PEM format. Aside from the core fields, the certificates
1239 should include various extension data sets, including v3 basic
1240 constraints data, key purpose, key usage and subject alt name.
1242 The GnuTLS package includes a command called @code{certtool} which can
1243 be used to easily generate certificates and keys in the required format
1244 with expected data present. Alternatively a certificate management
1245 service may be used.
1247 At a minimum it is necessary to setup a certificate authority, and
1248 issue certificates to each server. If using x509 certificates for
1249 authentication, then each client will also need to be issued a
1250 certificate.
1252 Assuming that the QEMU network services will only ever be exposed to
1253 clients on a private intranet, there is no need to use a commercial
1254 certificate authority to create certificates. A self-signed CA is
1255 sufficient, and in fact likely to be more secure since it removes
1256 the ability of malicious 3rd parties to trick the CA into mis-issuing
1257 certs for impersonating your services. The only likely exception
1258 where a commercial CA might be desirable is if enabling the VNC
1259 websockets server and exposing it directly to remote browser clients.
1260 In such a case it might be useful to use a commercial CA to avoid
1261 needing to install custom CA certs in the web browsers.
1263 The recommendation is for the server to keep its certificates in either
1264 @code{/etc/pki/qemu} or for unprivileged users in @code{$HOME/.pki/qemu}.
1266 @menu
1267 * tls_generate_ca::
1268 * tls_generate_server::
1269 * tls_generate_client::
1270 * tls_creds_setup::
1271 * tls_psk::
1272 @end menu
1273 @node tls_generate_ca
1274 @subsection Setup the Certificate Authority
1276 This step only needs to be performed once per organization / organizational
1277 unit. First the CA needs a private key. This key must be kept VERY secret
1278 and secure. If this key is compromised the entire trust chain of the certificates
1279 issued with it is lost.
1281 @example
1282 # certtool --generate-privkey > ca-key.pem
1283 @end example
1285 To generate a self-signed certificate requires one core piece of information,
1286 the name of the organization. A template file @code{ca.info} should be
1287 populated with the desired data to avoid having to deal with interactive
1288 prompts from certtool:
1289 @example
1290 # cat > ca.info <<EOF
1291 cn = Name of your organization
1293 cert_signing_key
1295 # certtool --generate-self-signed \
1296            --load-privkey ca-key.pem
1297            --template ca.info \
1298            --outfile ca-cert.pem
1299 @end example
1301 The @code{ca} keyword in the template sets the v3 basic constraints extension
1302 to indicate this certificate is for a CA, while @code{cert_signing_key} sets
1303 the key usage extension to indicate this will be used for signing other keys.
1304 The generated @code{ca-cert.pem} file should be copied to all servers and
1305 clients wishing to utilize TLS support in the VNC server. The @code{ca-key.pem}
1306 must not be disclosed/copied anywhere except the host responsible for issuing
1307 certificates.
1309 @node tls_generate_server
1310 @subsection Issuing server certificates
1312 Each server (or host) needs to be issued with a key and certificate. When connecting
1313 the certificate is sent to the client which validates it against the CA certificate.
1314 The core pieces of information for a server certificate are the hostnames and/or IP
1315 addresses that will be used by clients when connecting. The hostname / IP address
1316 that the client specifies when connecting will be validated against the hostname(s)
1317 and IP address(es) recorded in the server certificate, and if no match is found
1318 the client will close the connection.
1320 Thus it is recommended that the server certificate include both the fully qualified
1321 and unqualified hostnames. If the server will have permanently assigned IP address(es),
1322 and clients are likely to use them when connecting, they may also be included in the
1323 certificate. Both IPv4 and IPv6 addresses are supported. Historically certificates
1324 only included 1 hostname in the @code{CN} field, however, usage of this field for
1325 validation is now deprecated. Instead modern TLS clients will validate against the
1326 Subject Alt Name extension data, which allows for multiple entries. In the future
1327 usage of the @code{CN} field may be discontinued entirely, so providing SAN
1328 extension data is strongly recommended.
1330 On the host holding the CA, create template files containing the information
1331 for each server, and use it to issue server certificates.
1333 @example
1334 # cat > server-hostNNN.info <<EOF
1335 organization = Name  of your organization
1336 cn = hostNNN.foo.example.com
1337 dns_name = hostNNN
1338 dns_name = hostNNN.foo.example.com
1339 ip_address = 10.0.1.87
1340 ip_address = 192.8.0.92
1341 ip_address = 2620:0:cafe::87
1342 ip_address = 2001:24::92
1343 tls_www_server
1344 encryption_key
1345 signing_key
1347 # certtool --generate-privkey > server-hostNNN-key.pem
1348 # certtool --generate-certificate \
1349            --load-ca-certificate ca-cert.pem \
1350            --load-ca-privkey ca-key.pem \
1351            --load-privkey server-hostNNN-key.pem \
1352            --template server-hostNNN.info \
1353            --outfile server-hostNNN-cert.pem
1354 @end example
1356 The @code{dns_name} and @code{ip_address} fields in the template are setting
1357 the subject alt name extension data. The @code{tls_www_server} keyword is the
1358 key purpose extension to indicate this certificate is intended for usage in
1359 a web server. Although QEMU network services are not in fact HTTP servers
1360 (except for VNC websockets), setting this key purpose is still recommended.
1361 The @code{encryption_key} and @code{signing_key} keyword is the key usage
1362 extension to indicate this certificate is intended for usage in the data
1363 session.
1365 The @code{server-hostNNN-key.pem} and @code{server-hostNNN-cert.pem} files
1366 should now be securely copied to the server for which they were generated,
1367 and renamed to @code{server-key.pem} and @code{server-cert.pem} when added
1368 to the @code{/etc/pki/qemu} directory on the target host. The @code{server-key.pem}
1369 file is security sensitive and should be kept protected with file mode 0600
1370 to prevent disclosure.
1372 @node tls_generate_client
1373 @subsection Issuing client certificates
1375 The QEMU x509 TLS credential setup defaults to enabling client verification
1376 using certificates, providing a simple authentication mechanism. If this
1377 default is used, each client also needs to be issued a certificate. The client
1378 certificate contains enough metadata to uniquely identify the client with the
1379 scope of the certificate authority. The client certificate would typically
1380 include fields for organization, state, city, building, etc.
1382 Once again on the host holding the CA, create template files containing the
1383 information for each client, and use it to issue client certificates.
1386 @example
1387 # cat > client-hostNNN.info <<EOF
1388 country = GB
1389 state = London
1390 locality = City Of London
1391 organization = Name of your organization
1392 cn = hostNNN.foo.example.com
1393 tls_www_client
1394 encryption_key
1395 signing_key
1397 # certtool --generate-privkey > client-hostNNN-key.pem
1398 # certtool --generate-certificate \
1399            --load-ca-certificate ca-cert.pem \
1400            --load-ca-privkey ca-key.pem \
1401            --load-privkey client-hostNNN-key.pem \
1402            --template client-hostNNN.info \
1403            --outfile client-hostNNN-cert.pem
1404 @end example
1406 The subject alt name extension data is not required for clients, so the
1407 the @code{dns_name} and @code{ip_address} fields are not included.
1408 The @code{tls_www_client} keyword is the key purpose extension to indicate
1409 this certificate is intended for usage in a web client. Although QEMU
1410 network clients are not in fact HTTP clients, setting this key purpose is
1411 still recommended. The @code{encryption_key} and @code{signing_key} keyword
1412 is the key usage extension to indicate this certificate is intended for
1413 usage in the data session.
1415 The @code{client-hostNNN-key.pem} and @code{client-hostNNN-cert.pem} files
1416 should now be securely copied to the client for which they were generated,
1417 and renamed to @code{client-key.pem} and @code{client-cert.pem} when added
1418 to the @code{/etc/pki/qemu} directory on the target host. The @code{client-key.pem}
1419 file is security sensitive and should be kept protected with file mode 0600
1420 to prevent disclosure.
1422 If a single host is going to be using TLS in both a client and server
1423 role, it is possible to create a single certificate to cover both roles.
1424 This would be quite common for the migration and NBD services, where a
1425 QEMU process will be started by accepting a TLS protected incoming migration,
1426 and later itself be migrated out to another host. To generate a single
1427 certificate, simply include the template data from both the client and server
1428 instructions in one.
1430 @example
1431 # cat > both-hostNNN.info <<EOF
1432 country = GB
1433 state = London
1434 locality = City Of London
1435 organization = Name of your organization
1436 cn = hostNNN.foo.example.com
1437 dns_name = hostNNN
1438 dns_name = hostNNN.foo.example.com
1439 ip_address = 10.0.1.87
1440 ip_address = 192.8.0.92
1441 ip_address = 2620:0:cafe::87
1442 ip_address = 2001:24::92
1443 tls_www_server
1444 tls_www_client
1445 encryption_key
1446 signing_key
1448 # certtool --generate-privkey > both-hostNNN-key.pem
1449 # certtool --generate-certificate \
1450            --load-ca-certificate ca-cert.pem \
1451            --load-ca-privkey ca-key.pem \
1452            --load-privkey both-hostNNN-key.pem \
1453            --template both-hostNNN.info \
1454            --outfile both-hostNNN-cert.pem
1455 @end example
1457 When copying the PEM files to the target host, save them twice,
1458 once as @code{server-cert.pem} and @code{server-key.pem}, and
1459 again as @code{client-cert.pem} and @code{client-key.pem}.
1461 @node tls_creds_setup
1462 @subsection TLS x509 credential configuration
1464 QEMU has a standard mechanism for loading x509 credentials that will be
1465 used for network services and clients. It requires specifying the
1466 @code{tls-creds-x509} class name to the @code{--object} command line
1467 argument for the system emulators.  Each set of credentials loaded should
1468 be given a unique string identifier via the @code{id} parameter. A single
1469 set of TLS credentials can be used for multiple network backends, so VNC,
1470 migration, NBD, character devices can all share the same credentials. Note,
1471 however, that credentials for use in a client endpoint must be loaded
1472 separately from those used in a server endpoint.
1474 When specifying the object, the @code{dir} parameters specifies which
1475 directory contains the credential files. This directory is expected to
1476 contain files with the names mentioned previously, @code{ca-cert.pem},
1477 @code{server-key.pem}, @code{server-cert.pem}, @code{client-key.pem}
1478 and @code{client-cert.pem} as appropriate. It is also possible to
1479 include a set of pre-generated Diffie-Hellman (DH) parameters in a file
1480 @code{dh-params.pem}, which can be created using the
1481 @code{certtool --generate-dh-params} command. If omitted, QEMU will
1482 dynamically generate DH parameters when loading the credentials.
1484 The @code{endpoint} parameter indicates whether the credentials will
1485 be used for a network client or server, and determines which PEM
1486 files are loaded.
1488 The @code{verify} parameter determines whether x509 certificate
1489 validation should be performed. This defaults to enabled, meaning
1490 clients will always validate the server hostname against the
1491 certificate subject alt name fields and/or CN field. It also
1492 means that servers will request that clients provide a certificate
1493 and validate them. Verification should never be turned off for
1494 client endpoints, however, it may be turned off for server endpoints
1495 if an alternative mechanism is used to authenticate clients. For
1496 example, the VNC server can use SASL to authenticate clients
1497 instead.
1499 To load server credentials with client certificate validation
1500 enabled
1502 @example
1503 $QEMU -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=server
1504 @end example
1506 while to load client credentials use
1508 @example
1509 $QEMU -object tls-creds-x509,id=tls0,dir=/etc/pki/qemu,endpoint=client
1510 @end example
1512 Network services which support TLS will all have a @code{tls-creds}
1513 parameter which expects the ID of the TLS credentials object. For
1514 example with VNC:
1516 @example
1517 $QEMU -vnc 0.0.0.0:0,tls-creds=tls0
1518 @end example
1520 @node tls_psk
1521 @subsection TLS Pre-Shared Keys (PSK)
1523 Instead of using certificates, you may also use TLS Pre-Shared Keys
1524 (TLS-PSK).  This can be simpler to set up than certificates but is
1525 less scalable.
1527 Use the GnuTLS @code{psktool} program to generate a @code{keys.psk}
1528 file containing one or more usernames and random keys:
1530 @example
1531 mkdir -m 0700 /tmp/keys
1532 psktool -u rich -p /tmp/keys/keys.psk
1533 @end example
1535 TLS-enabled servers such as qemu-nbd can use this directory like so:
1537 @example
1538 qemu-nbd \
1539   -t -x / \
1540   --object tls-creds-psk,id=tls0,endpoint=server,dir=/tmp/keys \
1541   --tls-creds tls0 \
1542   image.qcow2
1543 @end example
1545 When connecting from a qemu-based client you must specify the
1546 directory containing @code{keys.psk} and an optional @var{username}
1547 (defaults to ``qemu''):
1549 @example
1550 qemu-img info \
1551   --object tls-creds-psk,id=tls0,dir=/tmp/keys,username=rich,endpoint=client \
1552   --image-opts \
1553   file.driver=nbd,file.host=localhost,file.port=10809,file.tls-creds=tls0,file.export=/
1554 @end example
1556 @node gdb_usage
1557 @section GDB usage
1559 QEMU has a primitive support to work with gdb, so that you can do
1560 'Ctrl-C' while the virtual machine is running and inspect its state.
1562 In order to use gdb, launch QEMU with the '-s' option. It will wait for a
1563 gdb connection:
1564 @example
1565 qemu-system-i386 -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1566                     -append "root=/dev/hda"
1567 Connected to host network interface: tun0
1568 Waiting gdb connection on port 1234
1569 @end example
1571 Then launch gdb on the 'vmlinux' executable:
1572 @example
1573 > gdb vmlinux
1574 @end example
1576 In gdb, connect to QEMU:
1577 @example
1578 (gdb) target remote localhost:1234
1579 @end example
1581 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1582 @example
1583 (gdb) c
1584 @end example
1586 Here are some useful tips in order to use gdb on system code:
1588 @enumerate
1589 @item
1590 Use @code{info reg} to display all the CPU registers.
1591 @item
1592 Use @code{x/10i $eip} to display the code at the PC position.
1593 @item
1594 Use @code{set architecture i8086} to dump 16 bit code. Then use
1595 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1596 @end enumerate
1598 Advanced debugging options:
1600 The default single stepping behavior is step with the IRQs and timer service routines off.  It is set this way because when gdb executes a single step it expects to advance beyond the current instruction.  With the IRQs and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed.  Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB.  There are three commands you can query and set the single step behavior:
1601 @table @code
1602 @item maintenance packet qqemu.sstepbits
1604 This will display the MASK bits used to control the single stepping IE:
1605 @example
1606 (gdb) maintenance packet qqemu.sstepbits
1607 sending: "qqemu.sstepbits"
1608 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1609 @end example
1610 @item maintenance packet qqemu.sstep
1612 This will display the current value of the mask used when single stepping IE:
1613 @example
1614 (gdb) maintenance packet qqemu.sstep
1615 sending: "qqemu.sstep"
1616 received: "0x7"
1617 @end example
1618 @item maintenance packet Qqemu.sstep=HEX_VALUE
1620 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1621 @example
1622 (gdb) maintenance packet Qqemu.sstep=0x5
1623 sending: "qemu.sstep=0x5"
1624 received: "OK"
1625 @end example
1626 @end table
1628 @node pcsys_os_specific
1629 @section Target OS specific information
1631 @subsection Linux
1633 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1634 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1635 color depth in the guest and the host OS.
1637 When using a 2.6 guest Linux kernel, you should add the option
1638 @code{clock=pit} on the kernel command line because the 2.6 Linux
1639 kernels make very strict real time clock checks by default that QEMU
1640 cannot simulate exactly.
1642 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1643 not activated because QEMU is slower with this patch. The QEMU
1644 Accelerator Module is also much slower in this case. Earlier Fedora
1645 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1646 patch by default. Newer kernels don't have it.
1648 @subsection Windows
1650 If you have a slow host, using Windows 95 is better as it gives the
1651 best speed. Windows 2000 is also a good choice.
1653 @subsubsection SVGA graphic modes support
1655 QEMU emulates a Cirrus Logic GD5446 Video
1656 card. All Windows versions starting from Windows 95 should recognize
1657 and use this graphic card. For optimal performances, use 16 bit color
1658 depth in the guest and the host OS.
1660 If you are using Windows XP as guest OS and if you want to use high
1661 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1662 1280x1024x16), then you should use the VESA VBE virtual graphic card
1663 (option @option{-std-vga}).
1665 @subsubsection CPU usage reduction
1667 Windows 9x does not correctly use the CPU HLT
1668 instruction. The result is that it takes host CPU cycles even when
1669 idle. You can install the utility from
1670 @url{https://web.archive.org/web/20060212132151/http://www.user.cityline.ru/~maxamn/amnhltm.zip}
1671 to solve this problem. Note that no such tool is needed for NT, 2000 or XP.
1673 @subsubsection Windows 2000 disk full problem
1675 Windows 2000 has a bug which gives a disk full problem during its
1676 installation. When installing it, use the @option{-win2k-hack} QEMU
1677 option to enable a specific workaround. After Windows 2000 is
1678 installed, you no longer need this option (this option slows down the
1679 IDE transfers).
1681 @subsubsection Windows 2000 shutdown
1683 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1684 can. It comes from the fact that Windows 2000 does not automatically
1685 use the APM driver provided by the BIOS.
1687 In order to correct that, do the following (thanks to Struan
1688 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1689 Add/Troubleshoot a device => Add a new device & Next => No, select the
1690 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1691 (again) a few times. Now the driver is installed and Windows 2000 now
1692 correctly instructs QEMU to shutdown at the appropriate moment.
1694 @subsubsection Share a directory between Unix and Windows
1696 See @ref{sec_invocation} about the help of the option
1697 @option{'-netdev user,smb=...'}.
1699 @subsubsection Windows XP security problem
1701 Some releases of Windows XP install correctly but give a security
1702 error when booting:
1703 @example
1704 A problem is preventing Windows from accurately checking the
1705 license for this computer. Error code: 0x800703e6.
1706 @end example
1708 The workaround is to install a service pack for XP after a boot in safe
1709 mode. Then reboot, and the problem should go away. Since there is no
1710 network while in safe mode, its recommended to download the full
1711 installation of SP1 or SP2 and transfer that via an ISO or using the
1712 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1714 @subsection MS-DOS and FreeDOS
1716 @subsubsection CPU usage reduction
1718 DOS does not correctly use the CPU HLT instruction. The result is that
1719 it takes host CPU cycles even when idle. You can install the utility from
1720 @url{https://web.archive.org/web/20051222085335/http://www.vmware.com/software/dosidle210.zip}
1721 to solve this problem.
1723 @node QEMU System emulator for non PC targets
1724 @chapter QEMU System emulator for non PC targets
1726 QEMU is a generic emulator and it emulates many non PC
1727 machines. Most of the options are similar to the PC emulator. The
1728 differences are mentioned in the following sections.
1730 @menu
1731 * PowerPC System emulator::
1732 * Sparc32 System emulator::
1733 * Sparc64 System emulator::
1734 * MIPS System emulator::
1735 * ARM System emulator::
1736 * ColdFire System emulator::
1737 * Cris System emulator::
1738 * Microblaze System emulator::
1739 * SH4 System emulator::
1740 * Xtensa System emulator::
1741 @end menu
1743 @node PowerPC System emulator
1744 @section PowerPC System emulator
1745 @cindex system emulation (PowerPC)
1747 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1748 or PowerMac PowerPC system.
1750 QEMU emulates the following PowerMac peripherals:
1752 @itemize @minus
1753 @item
1754 UniNorth or Grackle PCI Bridge
1755 @item
1756 PCI VGA compatible card with VESA Bochs Extensions
1757 @item
1758 2 PMAC IDE interfaces with hard disk and CD-ROM support
1759 @item
1760 NE2000 PCI adapters
1761 @item
1762 Non Volatile RAM
1763 @item
1764 VIA-CUDA with ADB keyboard and mouse.
1765 @end itemize
1767 QEMU emulates the following PREP peripherals:
1769 @itemize @minus
1770 @item
1771 PCI Bridge
1772 @item
1773 PCI VGA compatible card with VESA Bochs Extensions
1774 @item
1775 2 IDE interfaces with hard disk and CD-ROM support
1776 @item
1777 Floppy disk
1778 @item
1779 NE2000 network adapters
1780 @item
1781 Serial port
1782 @item
1783 PREP Non Volatile RAM
1784 @item
1785 PC compatible keyboard and mouse.
1786 @end itemize
1788 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1789 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1791 Since version 0.9.1, QEMU uses OpenBIOS @url{https://www.openbios.org/}
1792 for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
1793 v2) portable firmware implementation. The goal is to implement a 100%
1794 IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
1796 @c man begin OPTIONS
1798 The following options are specific to the PowerPC emulation:
1800 @table @option
1802 @item -g @var{W}x@var{H}[x@var{DEPTH}]
1804 Set the initial VGA graphic mode. The default is 800x600x32.
1806 @item -prom-env @var{string}
1808 Set OpenBIOS variables in NVRAM, for example:
1810 @example
1811 qemu-system-ppc -prom-env 'auto-boot?=false' \
1812  -prom-env 'boot-device=hd:2,\yaboot' \
1813  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
1814 @end example
1816 These variables are not used by Open Hack'Ware.
1818 @end table
1820 @c man end
1823 More information is available at
1824 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1826 @node Sparc32 System emulator
1827 @section Sparc32 System emulator
1828 @cindex system emulation (Sparc32)
1830 Use the executable @file{qemu-system-sparc} to simulate the following
1831 Sun4m architecture machines:
1832 @itemize @minus
1833 @item
1834 SPARCstation 4
1835 @item
1836 SPARCstation 5
1837 @item
1838 SPARCstation 10
1839 @item
1840 SPARCstation 20
1841 @item
1842 SPARCserver 600MP
1843 @item
1844 SPARCstation LX
1845 @item
1846 SPARCstation Voyager
1847 @item
1848 SPARCclassic
1849 @item
1850 SPARCbook
1851 @end itemize
1853 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
1854 but Linux limits the number of usable CPUs to 4.
1856 QEMU emulates the following sun4m peripherals:
1858 @itemize @minus
1859 @item
1860 IOMMU
1861 @item
1862 TCX or cgthree Frame buffer
1863 @item
1864 Lance (Am7990) Ethernet
1865 @item
1866 Non Volatile RAM M48T02/M48T08
1867 @item
1868 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1869 and power/reset logic
1870 @item
1871 ESP SCSI controller with hard disk and CD-ROM support
1872 @item
1873 Floppy drive (not on SS-600MP)
1874 @item
1875 CS4231 sound device (only on SS-5, not working yet)
1876 @end itemize
1878 The number of peripherals is fixed in the architecture.  Maximum
1879 memory size depends on the machine type, for SS-5 it is 256MB and for
1880 others 2047MB.
1882 Since version 0.8.2, QEMU uses OpenBIOS
1883 @url{https://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1884 firmware implementation. The goal is to implement a 100% IEEE
1885 1275-1994 (referred to as Open Firmware) compliant firmware.
1887 A sample Linux 2.6 series kernel and ram disk image are available on
1888 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
1889 most kernel versions work. Please note that currently older Solaris kernels
1890 don't work probably due to interface issues between OpenBIOS and
1891 Solaris.
1893 @c man begin OPTIONS
1895 The following options are specific to the Sparc32 emulation:
1897 @table @option
1899 @item -g @var{W}x@var{H}x[x@var{DEPTH}]
1901 Set the initial graphics mode. For TCX, the default is 1024x768x8 with the
1902 option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
1903 of 1152x900x8 for people who wish to use OBP.
1905 @item -prom-env @var{string}
1907 Set OpenBIOS variables in NVRAM, for example:
1909 @example
1910 qemu-system-sparc -prom-env 'auto-boot?=false' \
1911  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
1912 @end example
1914 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]
1916 Set the emulated machine type. Default is SS-5.
1918 @end table
1920 @c man end
1922 @node Sparc64 System emulator
1923 @section Sparc64 System emulator
1924 @cindex system emulation (Sparc64)
1926 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
1927 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
1928 Niagara (T1) machine. The Sun4u emulator is mostly complete, being
1929 able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The
1930 Sun4v emulator is still a work in progress.
1932 The Niagara T1 emulator makes use of firmware and OS binaries supplied in the S10image/ directory
1933 of the OpenSPARC T1 project @url{http://download.oracle.com/technetwork/systems/opensparc/OpenSPARCT1_Arch.1.5.tar.bz2}
1934 and is able to boot the disk.s10hw2 Solaris image.
1935 @example
1936 qemu-system-sparc64 -M niagara -L /path-to/S10image/ \
1937                     -nographic -m 256 \
1938                     -drive if=pflash,readonly=on,file=/S10image/disk.s10hw2
1939 @end example
1942 QEMU emulates the following peripherals:
1944 @itemize @minus
1945 @item
1946 UltraSparc IIi APB PCI Bridge
1947 @item
1948 PCI VGA compatible card with VESA Bochs Extensions
1949 @item
1950 PS/2 mouse and keyboard
1951 @item
1952 Non Volatile RAM M48T59
1953 @item
1954 PC-compatible serial ports
1955 @item
1956 2 PCI IDE interfaces with hard disk and CD-ROM support
1957 @item
1958 Floppy disk
1959 @end itemize
1961 @c man begin OPTIONS
1963 The following options are specific to the Sparc64 emulation:
1965 @table @option
1967 @item -prom-env @var{string}
1969 Set OpenBIOS variables in NVRAM, for example:
1971 @example
1972 qemu-system-sparc64 -prom-env 'auto-boot?=false'
1973 @end example
1975 @item -M [sun4u|sun4v|niagara]
1977 Set the emulated machine type. The default is sun4u.
1979 @end table
1981 @c man end
1983 @node MIPS System emulator
1984 @section MIPS System emulator
1985 @cindex system emulation (MIPS)
1987 Four executables cover simulation of 32 and 64-bit MIPS systems in
1988 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
1989 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
1990 Five different machine types are emulated:
1992 @itemize @minus
1993 @item
1994 A generic ISA PC-like machine "mips"
1995 @item
1996 The MIPS Malta prototype board "malta"
1997 @item
1998 An ACER Pica "pica61". This machine needs the 64-bit emulator.
1999 @item
2000 MIPS emulator pseudo board "mipssim"
2001 @item
2002 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2003 @end itemize
2005 The generic emulation is supported by Debian 'Etch' and is able to
2006 install Debian into a virtual disk image. The following devices are
2007 emulated:
2009 @itemize @minus
2010 @item
2011 A range of MIPS CPUs, default is the 24Kf
2012 @item
2013 PC style serial port
2014 @item
2015 PC style IDE disk
2016 @item
2017 NE2000 network card
2018 @end itemize
2020 The Malta emulation supports the following devices:
2022 @itemize @minus
2023 @item
2024 Core board with MIPS 24Kf CPU and Galileo system controller
2025 @item
2026 PIIX4 PCI/USB/SMbus controller
2027 @item
2028 The Multi-I/O chip's serial device
2029 @item
2030 PCI network cards (PCnet32 and others)
2031 @item
2032 Malta FPGA serial device
2033 @item
2034 Cirrus (default) or any other PCI VGA graphics card
2035 @end itemize
2037 The ACER Pica emulation supports:
2039 @itemize @minus
2040 @item
2041 MIPS R4000 CPU
2042 @item
2043 PC-style IRQ and DMA controllers
2044 @item
2045 PC Keyboard
2046 @item
2047 IDE controller
2048 @end itemize
2050 The mipssim pseudo board emulation provides an environment similar
2051 to what the proprietary MIPS emulator uses for running Linux.
2052 It supports:
2054 @itemize @minus
2055 @item
2056 A range of MIPS CPUs, default is the 24Kf
2057 @item
2058 PC style serial port
2059 @item
2060 MIPSnet network emulation
2061 @end itemize
2063 The MIPS Magnum R4000 emulation supports:
2065 @itemize @minus
2066 @item
2067 MIPS R4000 CPU
2068 @item
2069 PC-style IRQ controller
2070 @item
2071 PC Keyboard
2072 @item
2073 SCSI controller
2074 @item
2075 G364 framebuffer
2076 @end itemize
2079 @node ARM System emulator
2080 @section ARM System emulator
2081 @cindex system emulation (ARM)
2083 Use the executable @file{qemu-system-arm} to simulate a ARM
2084 machine. The ARM Integrator/CP board is emulated with the following
2085 devices:
2087 @itemize @minus
2088 @item
2089 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2090 @item
2091 Two PL011 UARTs
2092 @item
2093 SMC 91c111 Ethernet adapter
2094 @item
2095 PL110 LCD controller
2096 @item
2097 PL050 KMI with PS/2 keyboard and mouse.
2098 @item
2099 PL181 MultiMedia Card Interface with SD card.
2100 @end itemize
2102 The ARM Versatile baseboard is emulated with the following devices:
2104 @itemize @minus
2105 @item
2106 ARM926E, ARM1136 or Cortex-A8 CPU
2107 @item
2108 PL190 Vectored Interrupt Controller
2109 @item
2110 Four PL011 UARTs
2111 @item
2112 SMC 91c111 Ethernet adapter
2113 @item
2114 PL110 LCD controller
2115 @item
2116 PL050 KMI with PS/2 keyboard and mouse.
2117 @item
2118 PCI host bridge.  Note the emulated PCI bridge only provides access to
2119 PCI memory space.  It does not provide access to PCI IO space.
2120 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2121 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2122 mapped control registers.
2123 @item
2124 PCI OHCI USB controller.
2125 @item
2126 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2127 @item
2128 PL181 MultiMedia Card Interface with SD card.
2129 @end itemize
2131 Several variants of the ARM RealView baseboard are emulated,
2132 including the EB, PB-A8 and PBX-A9.  Due to interactions with the
2133 bootloader, only certain Linux kernel configurations work out
2134 of the box on these boards.
2136 Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2137 enabled in the kernel, and expect 512M RAM.  Kernels for The PBX-A9 board
2138 should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2139 disabled and expect 1024M RAM.
2141 The following devices are emulated:
2143 @itemize @minus
2144 @item
2145 ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
2146 @item
2147 ARM AMBA Generic/Distributed Interrupt Controller
2148 @item
2149 Four PL011 UARTs
2150 @item
2151 SMC 91c111 or SMSC LAN9118 Ethernet adapter
2152 @item
2153 PL110 LCD controller
2154 @item
2155 PL050 KMI with PS/2 keyboard and mouse
2156 @item
2157 PCI host bridge
2158 @item
2159 PCI OHCI USB controller
2160 @item
2161 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2162 @item
2163 PL181 MultiMedia Card Interface with SD card.
2164 @end itemize
2166 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2167 and "Terrier") emulation includes the following peripherals:
2169 @itemize @minus
2170 @item
2171 Intel PXA270 System-on-chip (ARM V5TE core)
2172 @item
2173 NAND Flash memory
2174 @item
2175 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2176 @item
2177 On-chip OHCI USB controller
2178 @item
2179 On-chip LCD controller
2180 @item
2181 On-chip Real Time Clock
2182 @item
2183 TI ADS7846 touchscreen controller on SSP bus
2184 @item
2185 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2186 @item
2187 GPIO-connected keyboard controller and LEDs
2188 @item
2189 Secure Digital card connected to PXA MMC/SD host
2190 @item
2191 Three on-chip UARTs
2192 @item
2193 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2194 @end itemize
2196 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2197 following elements:
2199 @itemize @minus
2200 @item
2201 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2202 @item
2203 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2204 @item
2205 On-chip LCD controller
2206 @item
2207 On-chip Real Time Clock
2208 @item
2209 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2210 CODEC, connected through MicroWire and I@math{^2}S busses
2211 @item
2212 GPIO-connected matrix keypad
2213 @item
2214 Secure Digital card connected to OMAP MMC/SD host
2215 @item
2216 Three on-chip UARTs
2217 @end itemize
2219 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2220 emulation supports the following elements:
2222 @itemize @minus
2223 @item
2224 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2225 @item
2226 RAM and non-volatile OneNAND Flash memories
2227 @item
2228 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2229 display controller and a LS041y3 MIPI DBI-C controller
2230 @item
2231 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2232 driven through SPI bus
2233 @item
2234 National Semiconductor LM8323-controlled qwerty keyboard driven
2235 through I@math{^2}C bus
2236 @item
2237 Secure Digital card connected to OMAP MMC/SD host
2238 @item
2239 Three OMAP on-chip UARTs and on-chip STI debugging console
2240 @item
2241 A Bluetooth(R) transceiver and HCI connected to an UART
2242 @item
2243 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2244 TUSB6010 chip - only USB host mode is supported
2245 @item
2246 TI TMP105 temperature sensor driven through I@math{^2}C bus
2247 @item
2248 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2249 @item
2250 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2251 through CBUS
2252 @end itemize
2254 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2255 devices:
2257 @itemize @minus
2258 @item
2259 Cortex-M3 CPU core.
2260 @item
2261 64k Flash and 8k SRAM.
2262 @item
2263 Timers, UARTs, ADC and I@math{^2}C interface.
2264 @item
2265 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2266 @end itemize
2268 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2269 devices:
2271 @itemize @minus
2272 @item
2273 Cortex-M3 CPU core.
2274 @item
2275 256k Flash and 64k SRAM.
2276 @item
2277 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2278 @item
2279 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2280 @end itemize
2282 The Freecom MusicPal internet radio emulation includes the following
2283 elements:
2285 @itemize @minus
2286 @item
2287 Marvell MV88W8618 ARM core.
2288 @item
2289 32 MB RAM, 256 KB SRAM, 8 MB flash.
2290 @item
2291 Up to 2 16550 UARTs
2292 @item
2293 MV88W8xx8 Ethernet controller
2294 @item
2295 MV88W8618 audio controller, WM8750 CODEC and mixer
2296 @item
2297 128×64 display with brightness control
2298 @item
2299 2 buttons, 2 navigation wheels with button function
2300 @end itemize
2302 The Siemens SX1 models v1 and v2 (default) basic emulation.
2303 The emulation includes the following elements:
2305 @itemize @minus
2306 @item
2307 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2308 @item
2309 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2311 1 Flash of 16MB and 1 Flash of 8MB
2313 1 Flash of 32MB
2314 @item
2315 On-chip LCD controller
2316 @item
2317 On-chip Real Time Clock
2318 @item
2319 Secure Digital card connected to OMAP MMC/SD host
2320 @item
2321 Three on-chip UARTs
2322 @end itemize
2324 A Linux 2.6 test image is available on the QEMU web site. More
2325 information is available in the QEMU mailing-list archive.
2327 @c man begin OPTIONS
2329 The following options are specific to the ARM emulation:
2331 @table @option
2333 @item -semihosting
2334 Enable semihosting syscall emulation.
2336 On ARM this implements the "Angel" interface.
2338 Note that this allows guest direct access to the host filesystem,
2339 so should only be used with trusted guest OS.
2341 @end table
2343 @c man end
2345 @node ColdFire System emulator
2346 @section ColdFire System emulator
2347 @cindex system emulation (ColdFire)
2348 @cindex system emulation (M68K)
2350 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2351 The emulator is able to boot a uClinux kernel.
2353 The M5208EVB emulation includes the following devices:
2355 @itemize @minus
2356 @item
2357 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2358 @item
2359 Three Two on-chip UARTs.
2360 @item
2361 Fast Ethernet Controller (FEC)
2362 @end itemize
2364 The AN5206 emulation includes the following devices:
2366 @itemize @minus
2367 @item
2368 MCF5206 ColdFire V2 Microprocessor.
2369 @item
2370 Two on-chip UARTs.
2371 @end itemize
2373 @c man begin OPTIONS
2375 The following options are specific to the ColdFire emulation:
2377 @table @option
2379 @item -semihosting
2380 Enable semihosting syscall emulation.
2382 On M68K this implements the "ColdFire GDB" interface used by libgloss.
2384 Note that this allows guest direct access to the host filesystem,
2385 so should only be used with trusted guest OS.
2387 @end table
2389 @c man end
2391 @node Cris System emulator
2392 @section Cris System emulator
2393 @cindex system emulation (Cris)
2395 TODO
2397 @node Microblaze System emulator
2398 @section Microblaze System emulator
2399 @cindex system emulation (Microblaze)
2401 TODO
2403 @node SH4 System emulator
2404 @section SH4 System emulator
2405 @cindex system emulation (SH4)
2407 TODO
2409 @node Xtensa System emulator
2410 @section Xtensa System emulator
2411 @cindex system emulation (Xtensa)
2413 Two executables cover simulation of both Xtensa endian options,
2414 @file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}.
2415 Two different machine types are emulated:
2417 @itemize @minus
2418 @item
2419 Xtensa emulator pseudo board "sim"
2420 @item
2421 Avnet LX60/LX110/LX200 board
2422 @end itemize
2424 The sim pseudo board emulation provides an environment similar
2425 to one provided by the proprietary Tensilica ISS.
2426 It supports:
2428 @itemize @minus
2429 @item
2430 A range of Xtensa CPUs, default is the DC232B
2431 @item
2432 Console and filesystem access via semihosting calls
2433 @end itemize
2435 The Avnet LX60/LX110/LX200 emulation supports:
2437 @itemize @minus
2438 @item
2439 A range of Xtensa CPUs, default is the DC232B
2440 @item
2441 16550 UART
2442 @item
2443 OpenCores 10/100 Mbps Ethernet MAC
2444 @end itemize
2446 @c man begin OPTIONS
2448 The following options are specific to the Xtensa emulation:
2450 @table @option
2452 @item -semihosting
2453 Enable semihosting syscall emulation.
2455 Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select.
2456 Tensilica baremetal libc for ISS and linux platform "sim" use this interface.
2458 Note that this allows guest direct access to the host filesystem,
2459 so should only be used with trusted guest OS.
2461 @end table
2463 @c man end
2465 @node QEMU Guest Agent
2466 @chapter QEMU Guest Agent invocation
2468 @include qemu-ga.texi
2470 @node QEMU User space emulator
2471 @chapter QEMU User space emulator
2473 @menu
2474 * Supported Operating Systems ::
2475 * Features::
2476 * Linux User space emulator::
2477 * BSD User space emulator ::
2478 @end menu
2480 @node Supported Operating Systems
2481 @section Supported Operating Systems
2483 The following OS are supported in user space emulation:
2485 @itemize @minus
2486 @item
2487 Linux (referred as qemu-linux-user)
2488 @item
2489 BSD (referred as qemu-bsd-user)
2490 @end itemize
2492 @node Features
2493 @section Features
2495 QEMU user space emulation has the following notable features:
2497 @table @strong
2498 @item System call translation:
2499 QEMU includes a generic system call translator.  This means that
2500 the parameters of the system calls can be converted to fix
2501 endianness and 32/64-bit mismatches between hosts and targets.
2502 IOCTLs can be converted too.
2504 @item POSIX signal handling:
2505 QEMU can redirect to the running program all signals coming from
2506 the host (such as @code{SIGALRM}), as well as synthesize signals from
2507 virtual CPU exceptions (for example @code{SIGFPE} when the program
2508 executes a division by zero).
2510 QEMU relies on the host kernel to emulate most signal system
2511 calls, for example to emulate the signal mask.  On Linux, QEMU
2512 supports both normal and real-time signals.
2514 @item Threading:
2515 On Linux, QEMU can emulate the @code{clone} syscall and create a real
2516 host thread (with a separate virtual CPU) for each emulated thread.
2517 Note that not all targets currently emulate atomic operations correctly.
2518 x86 and ARM use a global lock in order to preserve their semantics.
2519 @end table
2521 QEMU was conceived so that ultimately it can emulate itself. Although
2522 it is not very useful, it is an important test to show the power of the
2523 emulator.
2525 @node Linux User space emulator
2526 @section Linux User space emulator
2528 @menu
2529 * Quick Start::
2530 * Wine launch::
2531 * Command line options::
2532 * Other binaries::
2533 @end menu
2535 @node Quick Start
2536 @subsection Quick Start
2538 In order to launch a Linux process, QEMU needs the process executable
2539 itself and all the target (x86) dynamic libraries used by it.
2541 @itemize
2543 @item On x86, you can just try to launch any process by using the native
2544 libraries:
2546 @example
2547 qemu-i386 -L / /bin/ls
2548 @end example
2550 @code{-L /} tells that the x86 dynamic linker must be searched with a
2551 @file{/} prefix.
2553 @item Since QEMU is also a linux process, you can launch QEMU with
2554 QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
2556 @example
2557 qemu-i386 -L / qemu-i386 -L / /bin/ls
2558 @end example
2560 @item On non x86 CPUs, you need first to download at least an x86 glibc
2561 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2562 @code{LD_LIBRARY_PATH} is not set:
2564 @example
2565 unset LD_LIBRARY_PATH
2566 @end example
2568 Then you can launch the precompiled @file{ls} x86 executable:
2570 @example
2571 qemu-i386 tests/i386/ls
2572 @end example
2573 You can look at @file{scripts/qemu-binfmt-conf.sh} so that
2574 QEMU is automatically launched by the Linux kernel when you try to
2575 launch x86 executables. It requires the @code{binfmt_misc} module in the
2576 Linux kernel.
2578 @item The x86 version of QEMU is also included. You can try weird things such as:
2579 @example
2580 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2581           /usr/local/qemu-i386/bin/ls-i386
2582 @end example
2584 @end itemize
2586 @node Wine launch
2587 @subsection Wine launch
2589 @itemize
2591 @item Ensure that you have a working QEMU with the x86 glibc
2592 distribution (see previous section). In order to verify it, you must be
2593 able to do:
2595 @example
2596 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2597 @end example
2599 @item Download the binary x86 Wine install
2600 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2602 @item Configure Wine on your account. Look at the provided script
2603 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2604 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2606 @item Then you can try the example @file{putty.exe}:
2608 @example
2609 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2610           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2611 @end example
2613 @end itemize
2615 @node Command line options
2616 @subsection Command line options
2618 @example
2619 @command{qemu-i386} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-cpu} @var{model}] [@option{-g} @var{port}] [@option{-B} @var{offset}] [@option{-R} @var{size}] @var{program} [@var{arguments}...]
2620 @end example
2622 @table @option
2623 @item -h
2624 Print the help
2625 @item -L path
2626 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2627 @item -s size
2628 Set the x86 stack size in bytes (default=524288)
2629 @item -cpu model
2630 Select CPU model (-cpu help for list and additional feature selection)
2631 @item -E @var{var}=@var{value}
2632 Set environment @var{var} to @var{value}.
2633 @item -U @var{var}
2634 Remove @var{var} from the environment.
2635 @item -B offset
2636 Offset guest address by the specified number of bytes.  This is useful when
2637 the address region required by guest applications is reserved on the host.
2638 This option is currently only supported on some hosts.
2639 @item -R size
2640 Pre-allocate a guest virtual address space of the given size (in bytes).
2641 "G", "M", and "k" suffixes may be used when specifying the size.
2642 @end table
2644 Debug options:
2646 @table @option
2647 @item -d item1,...
2648 Activate logging of the specified items (use '-d help' for a list of log items)
2649 @item -p pagesize
2650 Act as if the host page size was 'pagesize' bytes
2651 @item -g port
2652 Wait gdb connection to port
2653 @item -singlestep
2654 Run the emulation in single step mode.
2655 @end table
2657 Environment variables:
2659 @table @env
2660 @item QEMU_STRACE
2661 Print system calls and arguments similar to the 'strace' program
2662 (NOTE: the actual 'strace' program will not work because the user
2663 space emulator hasn't implemented ptrace).  At the moment this is
2664 incomplete.  All system calls that don't have a specific argument
2665 format are printed with information for six arguments.  Many
2666 flag-style arguments don't have decoders and will show up as numbers.
2667 @end table
2669 @node Other binaries
2670 @subsection Other binaries
2672 @cindex user mode (Alpha)
2673 @command{qemu-alpha} TODO.
2675 @cindex user mode (ARM)
2676 @command{qemu-armeb} TODO.
2678 @cindex user mode (ARM)
2679 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2680 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2681 configurations), and arm-uclinux bFLT format binaries.
2683 @cindex user mode (ColdFire)
2684 @cindex user mode (M68K)
2685 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2686 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2687 coldfire uClinux bFLT format binaries.
2689 The binary format is detected automatically.
2691 @cindex user mode (Cris)
2692 @command{qemu-cris} TODO.
2694 @cindex user mode (i386)
2695 @command{qemu-i386} TODO.
2696 @command{qemu-x86_64} TODO.
2698 @cindex user mode (Microblaze)
2699 @command{qemu-microblaze} TODO.
2701 @cindex user mode (MIPS)
2702 @command{qemu-mips} executes 32-bit big endian MIPS binaries (MIPS O32 ABI).
2704 @command{qemu-mipsel} executes 32-bit little endian MIPS binaries (MIPS O32 ABI).
2706 @command{qemu-mips64} executes 64-bit big endian MIPS binaries (MIPS N64 ABI).
2708 @command{qemu-mips64el} executes 64-bit little endian MIPS binaries (MIPS N64 ABI).
2710 @command{qemu-mipsn32} executes 32-bit big endian MIPS binaries (MIPS N32 ABI).
2712 @command{qemu-mipsn32el} executes 32-bit little endian MIPS binaries (MIPS N32 ABI).
2714 @cindex user mode (NiosII)
2715 @command{qemu-nios2} TODO.
2717 @cindex user mode (PowerPC)
2718 @command{qemu-ppc64abi32} TODO.
2719 @command{qemu-ppc64} TODO.
2720 @command{qemu-ppc} TODO.
2722 @cindex user mode (SH4)
2723 @command{qemu-sh4eb} TODO.
2724 @command{qemu-sh4} TODO.
2726 @cindex user mode (SPARC)
2727 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2729 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2730 (Sparc64 CPU, 32 bit ABI).
2732 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2733 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2735 @node BSD User space emulator
2736 @section BSD User space emulator
2738 @menu
2739 * BSD Status::
2740 * BSD Quick Start::
2741 * BSD Command line options::
2742 @end menu
2744 @node BSD Status
2745 @subsection BSD Status
2747 @itemize @minus
2748 @item
2749 target Sparc64 on Sparc64: Some trivial programs work.
2750 @end itemize
2752 @node BSD Quick Start
2753 @subsection Quick Start
2755 In order to launch a BSD process, QEMU needs the process executable
2756 itself and all the target dynamic libraries used by it.
2758 @itemize
2760 @item On Sparc64, you can just try to launch any process by using the native
2761 libraries:
2763 @example
2764 qemu-sparc64 /bin/ls
2765 @end example
2767 @end itemize
2769 @node BSD Command line options
2770 @subsection Command line options
2772 @example
2773 @command{qemu-sparc64} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-bsd} @var{type}] @var{program} [@var{arguments}...]
2774 @end example
2776 @table @option
2777 @item -h
2778 Print the help
2779 @item -L path
2780 Set the library root path (default=/)
2781 @item -s size
2782 Set the stack size in bytes (default=524288)
2783 @item -ignore-environment
2784 Start with an empty environment. Without this option,
2785 the initial environment is a copy of the caller's environment.
2786 @item -E @var{var}=@var{value}
2787 Set environment @var{var} to @var{value}.
2788 @item -U @var{var}
2789 Remove @var{var} from the environment.
2790 @item -bsd type
2791 Set the type of the emulated BSD Operating system. Valid values are
2792 FreeBSD, NetBSD and OpenBSD (default).
2793 @end table
2795 Debug options:
2797 @table @option
2798 @item -d item1,...
2799 Activate logging of the specified items (use '-d help' for a list of log items)
2800 @item -p pagesize
2801 Act as if the host page size was 'pagesize' bytes
2802 @item -singlestep
2803 Run the emulation in single step mode.
2804 @end table
2807 @include qemu-tech.texi
2809 @include qemu-deprecated.texi
2811 @node Supported build platforms
2812 @appendix Supported build platforms
2814 QEMU aims to support building and executing on multiple host OS platforms.
2815 This appendix outlines which platforms are the major build targets. These
2816 platforms are used as the basis for deciding upon the minimum required
2817 versions of 3rd party software QEMU depends on. The supported platforms
2818 are the targets for automated testing performed by the project when patches
2819 are submitted for review, and tested before and after merge.
2821 If a platform is not listed here, it does not imply that QEMU won't work.
2822 If an unlisted platform has comparable software versions to a listed platform,
2823 there is every expectation that it will work. Bug reports are welcome for
2824 problems encountered on unlisted platforms unless they are clearly older
2825 vintage than what is described here.
2827 Note that when considering software versions shipped in distros as support
2828 targets, QEMU considers only the version number, and assumes the features in
2829 that distro match the upstream release with the same version. In other words,
2830 if a distro backports extra features to the software in their distro, QEMU
2831 upstream code will not add explicit support for those backports, unless the
2832 feature is auto-detectable in a manner that works for the upstream releases
2833 too.
2835 The Repology site @url{https://repology.org} is a useful resource to identify
2836 currently shipped versions of software in various operating systems, though
2837 it does not cover all distros listed below.
2839 @section Linux OS
2841 For distributions with frequent, short-lifetime releases, the project will
2842 aim to support all versions that are not end of life by their respective
2843 vendors. For the purposes of identifying supported software versions, the
2844 project will look at Fedora, Ubuntu, and openSUSE distros. Other short-
2845 lifetime distros will be assumed to ship similar software versions.
2847 For distributions with long-lifetime releases, the project will aim to support
2848 the most recent major version at all times. Support for the previous major
2849 version will be dropped 2 years after the new major version is released. For
2850 the purposes of identifying supported software versions, the project will look
2851 at RHEL, Debian, Ubuntu LTS, and SLES distros. Other long-lifetime distros will
2852 be assumed to ship similar software versions.
2854 @section Windows
2856 The project supports building with current versions of the MinGW toolchain,
2857 hosted on Linux.
2859 @section macOS
2861 The project supports building with the two most recent versions of macOS, with
2862 the current homebrew package set available.
2864 @section FreeBSD
2866 The project aims to support the all the versions which are not end of life.
2868 @section NetBSD
2870 The project aims to support the most recent major version at all times. Support
2871 for the previous major version will be dropped 2 years after the new major
2872 version is released.
2874 @section OpenBSD
2876 The project aims to support the all the versions which are not end of life.
2878 @node License
2879 @appendix License
2881 QEMU is a trademark of Fabrice Bellard.
2883 QEMU is released under the
2884 @url{https://www.gnu.org/licenses/gpl-2.0.txt,GNU General Public License},
2885 version 2. Parts of QEMU have specific licenses, see file
2886 @url{https://git.qemu.org/?p=qemu.git;a=blob_plain;f=LICENSE,LICENSE}.
2888 @node Index
2889 @appendix Index
2890 @menu
2891 * Concept Index::
2892 * Function Index::
2893 * Keystroke Index::
2894 * Program Index::
2895 * Data Type Index::
2896 * Variable Index::
2897 @end menu
2899 @node Concept Index
2900 @section Concept Index
2901 This is the main index. Should we combine all keywords in one index? TODO
2902 @printindex cp
2904 @node Function Index
2905 @section Function Index
2906 This index could be used for command line options and monitor functions.
2907 @printindex fn
2909 @node Keystroke Index
2910 @section Keystroke Index
2912 This is a list of all keystrokes which have a special function
2913 in system emulation.
2915 @printindex ky
2917 @node Program Index
2918 @section Program Index
2919 @printindex pg
2921 @node Data Type Index
2922 @section Data Type Index
2924 This index could be used for qdev device names and options.
2926 @printindex tp
2928 @node Variable Index
2929 @section Variable Index
2930 @printindex vr
2932 @bye