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