net: cadence_gem: Set initial MAC address
[qemu/ar7.git] / qemu-doc.texi
blob3126abdcd3e05f7749078f2152c1d5acd6897a41
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename qemu-doc.info
5 @documentlanguage en
6 @documentencoding UTF-8
8 @settitle QEMU Emulator User Documentation
9 @exampleindent 0
10 @paragraphindent 0
11 @c %**end of header
13 @ifinfo
14 @direntry
15 * QEMU: (qemu-doc).    The QEMU Emulator User Documentation.
16 @end direntry
17 @end ifinfo
19 @iftex
20 @titlepage
21 @sp 7
22 @center @titlefont{QEMU Emulator}
23 @sp 1
24 @center @titlefont{User Documentation}
25 @sp 3
26 @end titlepage
27 @end iftex
29 @ifnottex
30 @node Top
31 @top
33 @menu
34 * Introduction::
35 * Installation::
36 * QEMU PC System emulator::
37 * QEMU System emulator for non PC targets::
38 * QEMU User space emulator::
39 * compilation:: Compilation from the sources
40 * License::
41 * Index::
42 @end menu
43 @end ifnottex
45 @contents
47 @node Introduction
48 @chapter Introduction
50 @menu
51 * intro_features:: Features
52 @end menu
54 @node intro_features
55 @section Features
57 QEMU is a FAST! processor emulator using dynamic translation to
58 achieve good emulation speed.
60 QEMU has two operating modes:
62 @itemize
63 @cindex operating modes
65 @item
66 @cindex system emulation
67 Full system emulation. In this mode, QEMU emulates a full system (for
68 example a PC), including one or several processors and various
69 peripherals. It can be used to launch different Operating Systems
70 without rebooting the PC or to debug system code.
72 @item
73 @cindex user mode emulation
74 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{http://www.winehq.org}) or
77 to ease cross-compilation and cross-debugging.
79 @end itemize
81 QEMU can run without a host kernel driver and yet gives acceptable
82 performance.
84 For system emulation, the following hardware targets are supported:
85 @itemize
86 @cindex emulated target systems
87 @cindex supported target systems
88 @item PC (x86 or x86_64 processor)
89 @item ISA PC (old style PC without PCI bus)
90 @item PREP (PowerPC processor)
91 @item G3 Beige PowerMac (PowerPC processor)
92 @item Mac99 PowerMac (PowerPC processor, in progress)
93 @item Sun4m/Sun4c/Sun4d (32-bit Sparc processor)
94 @item Sun4u/Sun4v (64-bit Sparc processor, in progress)
95 @item Malta board (32-bit and 64-bit MIPS processors)
96 @item MIPS Magnum (64-bit MIPS processor)
97 @item ARM Integrator/CP (ARM)
98 @item ARM Versatile baseboard (ARM)
99 @item ARM RealView Emulation/Platform baseboard (ARM)
100 @item Spitz, Akita, Borzoi, Terrier and Tosa PDAs (PXA270 processor)
101 @item Luminary Micro LM3S811EVB (ARM Cortex-M3)
102 @item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
103 @item Freescale MCF5208EVB (ColdFire V2).
104 @item Arnewsh MCF5206 evaluation board (ColdFire V2).
105 @item Palm Tungsten|E PDA (OMAP310 processor)
106 @item N800 and N810 tablets (OMAP2420 processor)
107 @item MusicPal (MV88W8618 ARM processor)
108 @item Gumstix "Connex" and "Verdex" motherboards (PXA255/270).
109 @item Siemens SX1 smartphone (OMAP310 processor)
110 @item AXIS-Devboard88 (CRISv32 ETRAX-FS).
111 @item Petalogix Spartan 3aDSP1800 MMU ref design (MicroBlaze).
112 @item Avnet LX60/LX110/LX200 boards (Xtensa)
113 @end itemize
115 @cindex supported user mode targets
116 For user emulation, x86 (32 and 64 bit), PowerPC (32 and 64 bit),
117 ARM, MIPS (32 bit only), Sparc (32 and 64 bit),
118 Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
120 @node Installation
121 @chapter Installation
123 If you want to compile QEMU yourself, see @ref{compilation}.
125 @menu
126 * install_linux::   Linux
127 * install_windows:: Windows
128 * install_mac::     Macintosh
129 @end menu
131 @node install_linux
132 @section Linux
133 @cindex installation (Linux)
135 If a precompiled package is available for your distribution - you just
136 have to install it. Otherwise, see @ref{compilation}.
138 @node install_windows
139 @section Windows
140 @cindex installation (Windows)
142 Download the experimental binary installer at
143 @url{http://www.free.oszoo.org/@/download.html}.
144 TODO (no longer available)
146 @node install_mac
147 @section Mac OS X
149 Download the experimental binary installer at
150 @url{http://www.free.oszoo.org/@/download.html}.
151 TODO (no longer available)
153 @node QEMU PC System emulator
154 @chapter QEMU PC System emulator
155 @cindex system emulation (PC)
157 @menu
158 * pcsys_introduction:: Introduction
159 * pcsys_quickstart::   Quick Start
160 * sec_invocation::     Invocation
161 * pcsys_keys::         Keys
162 * pcsys_monitor::      QEMU Monitor
163 * disk_images::        Disk Images
164 * pcsys_network::      Network emulation
165 * pcsys_other_devs::   Other Devices
166 * direct_linux_boot::  Direct Linux Boot
167 * pcsys_usb::          USB emulation
168 * vnc_security::       VNC security
169 * gdb_usage::          GDB usage
170 * pcsys_os_specific::  Target OS specific information
171 @end menu
173 @node pcsys_introduction
174 @section Introduction
176 @c man begin DESCRIPTION
178 The QEMU PC System emulator simulates the
179 following peripherals:
181 @itemize @minus
182 @item
183 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
184 @item
185 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
186 extensions (hardware level, including all non standard modes).
187 @item
188 PS/2 mouse and keyboard
189 @item
190 2 PCI IDE interfaces with hard disk and CD-ROM support
191 @item
192 Floppy disk
193 @item
194 PCI and ISA network adapters
195 @item
196 Serial ports
197 @item
198 Creative SoundBlaster 16 sound card
199 @item
200 ENSONIQ AudioPCI ES1370 sound card
201 @item
202 Intel 82801AA AC97 Audio compatible sound card
203 @item
204 Intel HD Audio Controller and HDA codec
205 @item
206 Adlib (OPL2) - Yamaha YM3812 compatible chip
207 @item
208 Gravis Ultrasound GF1 sound card
209 @item
210 CS4231A compatible sound card
211 @item
212 PCI UHCI USB controller and a virtual USB hub.
213 @end itemize
215 SMP is supported with up to 255 CPUs.
217 QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL
218 VGA BIOS.
220 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
222 QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
223 by Tibor "TS" Schütz.
225 Note that, by default, GUS shares IRQ(7) with parallel ports and so
226 QEMU must be told to not have parallel ports to have working GUS.
228 @example
229 qemu-system-i386 dos.img -soundhw gus -parallel none
230 @end example
232 Alternatively:
233 @example
234 qemu-system-i386 dos.img -device gus,irq=5
235 @end example
237 Or some other unclaimed IRQ.
239 CS4231A is the chip used in Windows Sound System and GUSMAX products
241 @c man end
243 @node pcsys_quickstart
244 @section Quick Start
245 @cindex quick start
247 Download and uncompress the linux image (@file{linux.img}) and type:
249 @example
250 qemu-system-i386 linux.img
251 @end example
253 Linux should boot and give you a prompt.
255 @node sec_invocation
256 @section Invocation
258 @example
259 @c man begin SYNOPSIS
260 usage: qemu-system-i386 [options] [@var{disk_image}]
261 @c man end
262 @end example
264 @c man begin OPTIONS
265 @var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
266 targets do not need a disk image.
268 @include qemu-options.texi
270 @c man end
272 @node pcsys_keys
273 @section Keys
275 @c man begin OPTIONS
277 During the graphical emulation, you can use special key combinations to change
278 modes. The default key mappings are shown below, but if you use @code{-alt-grab}
279 then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use
280 @code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt):
282 @table @key
283 @item Ctrl-Alt-f
284 @kindex Ctrl-Alt-f
285 Toggle full screen
287 @item Ctrl-Alt-+
288 @kindex Ctrl-Alt-+
289 Enlarge the screen
291 @item Ctrl-Alt--
292 @kindex Ctrl-Alt--
293 Shrink the screen
295 @item Ctrl-Alt-u
296 @kindex Ctrl-Alt-u
297 Restore the screen's un-scaled dimensions
299 @item Ctrl-Alt-n
300 @kindex Ctrl-Alt-n
301 Switch to virtual console 'n'. Standard console mappings are:
302 @table @emph
303 @item 1
304 Target system display
305 @item 2
306 Monitor
307 @item 3
308 Serial port
309 @end table
311 @item Ctrl-Alt
312 @kindex Ctrl-Alt
313 Toggle mouse and keyboard grab.
314 @end table
316 @kindex Ctrl-Up
317 @kindex Ctrl-Down
318 @kindex Ctrl-PageUp
319 @kindex Ctrl-PageDown
320 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
321 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
323 @kindex Ctrl-a h
324 During emulation, if you are using the @option{-nographic} option, use
325 @key{Ctrl-a h} to get terminal commands:
327 @table @key
328 @item Ctrl-a h
329 @kindex Ctrl-a h
330 @item Ctrl-a ?
331 @kindex Ctrl-a ?
332 Print this help
333 @item Ctrl-a x
334 @kindex Ctrl-a x
335 Exit emulator
336 @item Ctrl-a s
337 @kindex Ctrl-a s
338 Save disk data back to file (if -snapshot)
339 @item Ctrl-a t
340 @kindex Ctrl-a t
341 Toggle console timestamps
342 @item Ctrl-a b
343 @kindex Ctrl-a b
344 Send break (magic sysrq in Linux)
345 @item Ctrl-a c
346 @kindex Ctrl-a c
347 Switch between console and monitor
348 @item Ctrl-a Ctrl-a
349 @kindex Ctrl-a a
350 Send Ctrl-a
351 @end table
352 @c man end
354 @ignore
356 @c man begin SEEALSO
357 The HTML documentation of QEMU for more precise information and Linux
358 user mode emulator invocation.
359 @c man end
361 @c man begin AUTHOR
362 Fabrice Bellard
363 @c man end
365 @end ignore
367 @node pcsys_monitor
368 @section QEMU Monitor
369 @cindex QEMU monitor
371 The QEMU monitor is used to give complex commands to the QEMU
372 emulator. You can use it to:
374 @itemize @minus
376 @item
377 Remove or insert removable media images
378 (such as CD-ROM or floppies).
380 @item
381 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
382 from a disk file.
384 @item Inspect the VM state without an external debugger.
386 @end itemize
388 @subsection Commands
390 The following commands are available:
392 @include qemu-monitor.texi
394 @include qemu-monitor-info.texi
396 @subsection Integer expressions
398 The monitor understands integers expressions for every integer
399 argument. You can use register names to get the value of specifics
400 CPU registers by prefixing them with @emph{$}.
402 @node disk_images
403 @section Disk Images
405 Since version 0.6.1, QEMU supports many disk image formats, including
406 growable disk images (their size increase as non empty sectors are
407 written), compressed and encrypted disk images. Version 0.8.3 added
408 the new qcow2 disk image format which is essential to support VM
409 snapshots.
411 @menu
412 * disk_images_quickstart::    Quick start for disk image creation
413 * disk_images_snapshot_mode:: Snapshot mode
414 * vm_snapshots::              VM snapshots
415 * qemu_img_invocation::       qemu-img Invocation
416 * qemu_nbd_invocation::       qemu-nbd Invocation
417 * qemu_ga_invocation::        qemu-ga Invocation
418 * disk_images_formats::       Disk image file formats
419 * host_drives::               Using host drives
420 * disk_images_fat_images::    Virtual FAT disk images
421 * disk_images_nbd::           NBD access
422 * disk_images_sheepdog::      Sheepdog disk images
423 * disk_images_iscsi::         iSCSI LUNs
424 * disk_images_gluster::       GlusterFS disk images
425 * disk_images_ssh::           Secure Shell (ssh) disk images
426 @end menu
428 @node disk_images_quickstart
429 @subsection Quick start for disk image creation
431 You can create a disk image with the command:
432 @example
433 qemu-img create myimage.img mysize
434 @end example
435 where @var{myimage.img} is the disk image filename and @var{mysize} is its
436 size in kilobytes. You can add an @code{M} suffix to give the size in
437 megabytes and a @code{G} suffix for gigabytes.
439 See @ref{qemu_img_invocation} for more information.
441 @node disk_images_snapshot_mode
442 @subsection Snapshot mode
444 If you use the option @option{-snapshot}, all disk images are
445 considered as read only. When sectors in written, they are written in
446 a temporary file created in @file{/tmp}. You can however force the
447 write back to the raw disk images by using the @code{commit} monitor
448 command (or @key{C-a s} in the serial console).
450 @node vm_snapshots
451 @subsection VM snapshots
453 VM snapshots are snapshots of the complete virtual machine including
454 CPU state, RAM, device state and the content of all the writable
455 disks. In order to use VM snapshots, you must have at least one non
456 removable and writable block device using the @code{qcow2} disk image
457 format. Normally this device is the first virtual hard drive.
459 Use the monitor command @code{savevm} to create a new VM snapshot or
460 replace an existing one. A human readable name can be assigned to each
461 snapshot in addition to its numerical ID.
463 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
464 a VM snapshot. @code{info snapshots} lists the available snapshots
465 with their associated information:
467 @example
468 (qemu) info snapshots
469 Snapshot devices: hda
470 Snapshot list (from hda):
471 ID        TAG                 VM SIZE                DATE       VM CLOCK
472 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
473 2                                 40M 2006-08-06 12:43:29   00:00:18.633
474 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
475 @end example
477 A VM snapshot is made of a VM state info (its size is shown in
478 @code{info snapshots}) and a snapshot of every writable disk image.
479 The VM state info is stored in the first @code{qcow2} non removable
480 and writable block device. The disk image snapshots are stored in
481 every disk image. The size of a snapshot in a disk image is difficult
482 to evaluate and is not shown by @code{info snapshots} because the
483 associated disk sectors are shared among all the snapshots to save
484 disk space (otherwise each snapshot would need a full copy of all the
485 disk images).
487 When using the (unrelated) @code{-snapshot} option
488 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
489 but they are deleted as soon as you exit QEMU.
491 VM snapshots currently have the following known limitations:
492 @itemize
493 @item
494 They cannot cope with removable devices if they are removed or
495 inserted after a snapshot is done.
496 @item
497 A few device drivers still have incomplete snapshot support so their
498 state is not saved or restored properly (in particular USB).
499 @end itemize
501 @node qemu_img_invocation
502 @subsection @code{qemu-img} Invocation
504 @include qemu-img.texi
506 @node qemu_nbd_invocation
507 @subsection @code{qemu-nbd} Invocation
509 @include qemu-nbd.texi
511 @node qemu_ga_invocation
512 @subsection @code{qemu-ga} Invocation
514 @include qemu-ga.texi
516 @node disk_images_formats
517 @subsection Disk image file formats
519 QEMU supports many image file formats that can be used with VMs as well as with
520 any of the tools (like @code{qemu-img}). This includes the preferred formats
521 raw and qcow2 as well as formats that are supported for compatibility with
522 older QEMU versions or other hypervisors.
524 Depending on the image format, different options can be passed to
525 @code{qemu-img create} and @code{qemu-img convert} using the @code{-o} option.
526 This section describes each format and the options that are supported for it.
528 @table @option
529 @item raw
531 Raw disk image format. This format has the advantage of
532 being simple and easily exportable to all other emulators. If your
533 file system supports @emph{holes} (for example in ext2 or ext3 on
534 Linux or NTFS on Windows), then only the written sectors will reserve
535 space. Use @code{qemu-img info} to know the real size used by the
536 image or @code{ls -ls} on Unix/Linux.
538 Supported options:
539 @table @code
540 @item preallocation
541 Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
542 @code{falloc} mode preallocates space for image by calling posix_fallocate().
543 @code{full} mode preallocates space for image by writing zeros to underlying
544 storage.
545 @end table
547 @item qcow2
548 QEMU image format, the most versatile format. Use it to have smaller
549 images (useful if your filesystem does not supports holes, for example
550 on Windows), zlib based compression and support of multiple VM
551 snapshots.
553 Supported options:
554 @table @code
555 @item compat
556 Determines the qcow2 version to use. @code{compat=0.10} uses the
557 traditional image format that can be read by any QEMU since 0.10.
558 @code{compat=1.1} enables image format extensions that only QEMU 1.1 and
559 newer understand (this is the default). Amongst others, this includes
560 zero clusters, which allow efficient copy-on-read for sparse images.
562 @item backing_file
563 File name of a base image (see @option{create} subcommand)
564 @item backing_fmt
565 Image format of the base image
566 @item encryption
567 If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
569 The use of encryption in qcow and qcow2 images is considered to be flawed by
570 modern cryptography standards, suffering from a number of design problems:
572 @itemize @minus
573 @item The AES-CBC cipher is used with predictable initialization vectors based
574 on the sector number. This makes it vulnerable to chosen plaintext attacks
575 which can reveal the existence of encrypted data.
576 @item The user passphrase is directly used as the encryption key. A poorly
577 chosen or short passphrase will compromise the security of the encryption.
578 @item In the event of the passphrase being compromised there is no way to
579 change the passphrase to protect data in any qcow images. The files must
580 be cloned, using a different encryption passphrase in the new file. The
581 original file must then be securely erased using a program like shred,
582 though even this is ineffective with many modern storage technologies.
583 @end itemize
585 Use of qcow / qcow2 encryption with QEMU is deprecated, and support for
586 it will go away in a future release.  Users are recommended to use an
587 alternative encryption technology such as the Linux dm-crypt / LUKS
588 system.
590 @item cluster_size
591 Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
592 sizes can improve the image file size whereas larger cluster sizes generally
593 provide better performance.
595 @item preallocation
596 Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
597 @code{full}). An image with preallocated metadata is initially larger but can
598 improve performance when the image needs to grow. @code{falloc} and @code{full}
599 preallocations are like the same options of @code{raw} format, but sets up
600 metadata also.
602 @item lazy_refcounts
603 If this option is set to @code{on}, reference count updates are postponed with
604 the goal of avoiding metadata I/O and improving performance. This is
605 particularly interesting with @option{cache=writethrough} which doesn't batch
606 metadata updates. The tradeoff is that after a host crash, the reference count
607 tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
608 check -r all} is required, which may take some time.
610 This option can only be enabled if @code{compat=1.1} is specified.
612 @item nocow
613 If this option is set to @code{on}, it will turn off COW of the file. It's only
614 valid on btrfs, no effect on other file systems.
616 Btrfs has low performance when hosting a VM image file, even more when the guest
617 on the VM also using btrfs as file system. Turning off COW is a way to mitigate
618 this bad performance. Generally there are two ways to turn off COW on btrfs:
619 a) Disable it by mounting with nodatacow, then all newly created files will be
620 NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
621 does.
623 Note: this option is only valid to new or empty files. If there is an existing
624 file which is COW and has data blocks already, it couldn't be changed to NOCOW
625 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
626 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
628 @end table
630 @item qed
631 Old QEMU image format with support for backing files and compact image files
632 (when your filesystem or transport medium does not support holes).
634 When converting QED images to qcow2, you might want to consider using the
635 @code{lazy_refcounts=on} option to get a more QED-like behaviour.
637 Supported options:
638 @table @code
639 @item backing_file
640 File name of a base image (see @option{create} subcommand).
641 @item backing_fmt
642 Image file format of backing file (optional).  Useful if the format cannot be
643 autodetected because it has no header, like some vhd/vpc files.
644 @item cluster_size
645 Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller
646 cluster sizes can improve the image file size whereas larger cluster sizes
647 generally provide better performance.
648 @item table_size
649 Changes the number of clusters per L1/L2 table (must be power-of-2 between 1
650 and 16).  There is normally no need to change this value but this option can be
651 used for performance benchmarking.
652 @end table
654 @item qcow
655 Old QEMU image format with support for backing files, compact image files,
656 encryption and compression.
658 Supported options:
659 @table @code
660 @item backing_file
661 File name of a base image (see @option{create} subcommand)
662 @item encryption
663 If this option is set to @code{on}, the image is encrypted.
664 @end table
666 @item vdi
667 VirtualBox 1.1 compatible image format.
668 Supported options:
669 @table @code
670 @item static
671 If this option is set to @code{on}, the image is created with metadata
672 preallocation.
673 @end table
675 @item vmdk
676 VMware 3 and 4 compatible image format.
678 Supported options:
679 @table @code
680 @item backing_file
681 File name of a base image (see @option{create} subcommand).
682 @item compat6
683 Create a VMDK version 6 image (instead of version 4)
684 @item subformat
685 Specifies which VMDK subformat to use. Valid options are
686 @code{monolithicSparse} (default),
687 @code{monolithicFlat},
688 @code{twoGbMaxExtentSparse},
689 @code{twoGbMaxExtentFlat} and
690 @code{streamOptimized}.
691 @end table
693 @item vpc
694 VirtualPC compatible image format (VHD).
695 Supported options:
696 @table @code
697 @item subformat
698 Specifies which VHD subformat to use. Valid options are
699 @code{dynamic} (default) and @code{fixed}.
700 @end table
702 @item VHDX
703 Hyper-V compatible image format (VHDX).
704 Supported options:
705 @table @code
706 @item subformat
707 Specifies which VHDX subformat to use. Valid options are
708 @code{dynamic} (default) and @code{fixed}.
709 @item block_state_zero
710 Force use of payload blocks of type 'ZERO'.  Can be set to @code{on} (default)
711 or @code{off}.  When set to @code{off}, new blocks will be created as
712 @code{PAYLOAD_BLOCK_NOT_PRESENT}, which means parsers are free to return
713 arbitrary data for those blocks.  Do not set to @code{off} when using
714 @code{qemu-img convert} with @code{subformat=dynamic}.
715 @item block_size
716 Block size; min 1 MB, max 256 MB.  0 means auto-calculate based on image size.
717 @item log_size
718 Log size; min 1 MB.
719 @end table
720 @end table
722 @subsubsection Read-only formats
723 More disk image file formats are supported in a read-only mode.
724 @table @option
725 @item bochs
726 Bochs images of @code{growing} type.
727 @item cloop
728 Linux Compressed Loop image, useful only to reuse directly compressed
729 CD-ROM images present for example in the Knoppix CD-ROMs.
730 @item dmg
731 Apple disk image.
732 @item parallels
733 Parallels disk image format.
734 @end table
737 @node host_drives
738 @subsection Using host drives
740 In addition to disk image files, QEMU can directly access host
741 devices. We describe here the usage for QEMU version >= 0.8.3.
743 @subsubsection Linux
745 On Linux, you can directly use the host device filename instead of a
746 disk image filename provided you have enough privileges to access
747 it. For example, use @file{/dev/cdrom} to access to the CDROM.
749 @table @code
750 @item CD
751 You can specify a CDROM device even if no CDROM is loaded. QEMU has
752 specific code to detect CDROM insertion or removal. CDROM ejection by
753 the guest OS is supported. Currently only data CDs are supported.
754 @item Floppy
755 You can specify a floppy device even if no floppy is loaded. Floppy
756 removal is currently not detected accurately (if you change floppy
757 without doing floppy access while the floppy is not loaded, the guest
758 OS will think that the same floppy is loaded).
759 Use of the host's floppy device is deprecated, and support for it will
760 be removed in a future release.
761 @item Hard disks
762 Hard disks can be used. Normally you must specify the whole disk
763 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
764 see it as a partitioned disk. WARNING: unless you know what you do, it
765 is better to only make READ-ONLY accesses to the hard disk otherwise
766 you may corrupt your host data (use the @option{-snapshot} command
767 line option or modify the device permissions accordingly).
768 @end table
770 @subsubsection Windows
772 @table @code
773 @item CD
774 The preferred syntax is the drive letter (e.g. @file{d:}). The
775 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
776 supported as an alias to the first CDROM drive.
778 Currently there is no specific code to handle removable media, so it
779 is better to use the @code{change} or @code{eject} monitor commands to
780 change or eject media.
781 @item Hard disks
782 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
783 where @var{N} is the drive number (0 is the first hard disk).
785 WARNING: unless you know what you do, it is better to only make
786 READ-ONLY accesses to the hard disk otherwise you may corrupt your
787 host data (use the @option{-snapshot} command line so that the
788 modifications are written in a temporary file).
789 @end table
792 @subsubsection Mac OS X
794 @file{/dev/cdrom} is an alias to the first CDROM.
796 Currently there is no specific code to handle removable media, so it
797 is better to use the @code{change} or @code{eject} monitor commands to
798 change or eject media.
800 @node disk_images_fat_images
801 @subsection Virtual FAT disk images
803 QEMU can automatically create a virtual FAT disk image from a
804 directory tree. In order to use it, just type:
806 @example
807 qemu-system-i386 linux.img -hdb fat:/my_directory
808 @end example
810 Then you access access to all the files in the @file{/my_directory}
811 directory without having to copy them in a disk image or to export
812 them via SAMBA or NFS. The default access is @emph{read-only}.
814 Floppies can be emulated with the @code{:floppy:} option:
816 @example
817 qemu-system-i386 linux.img -fda fat:floppy:/my_directory
818 @end example
820 A read/write support is available for testing (beta stage) with the
821 @code{:rw:} option:
823 @example
824 qemu-system-i386 linux.img -fda fat:floppy:rw:/my_directory
825 @end example
827 What you should @emph{never} do:
828 @itemize
829 @item use non-ASCII filenames ;
830 @item use "-snapshot" together with ":rw:" ;
831 @item expect it to work when loadvm'ing ;
832 @item write to the FAT directory on the host system while accessing it with the guest system.
833 @end itemize
835 @node disk_images_nbd
836 @subsection NBD access
838 QEMU can access directly to block device exported using the Network Block Device
839 protocol.
841 @example
842 qemu-system-i386 linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/
843 @end example
845 If the NBD server is located on the same host, you can use an unix socket instead
846 of an inet socket:
848 @example
849 qemu-system-i386 linux.img -hdb nbd+unix://?socket=/tmp/my_socket
850 @end example
852 In this case, the block device must be exported using qemu-nbd:
854 @example
855 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
856 @end example
858 The use of qemu-nbd allows sharing of a disk between several guests:
859 @example
860 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
861 @end example
863 @noindent
864 and then you can use it with two guests:
865 @example
866 qemu-system-i386 linux1.img -hdb nbd+unix://?socket=/tmp/my_socket
867 qemu-system-i386 linux2.img -hdb nbd+unix://?socket=/tmp/my_socket
868 @end example
870 If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's
871 own embedded NBD server), you must specify an export name in the URI:
872 @example
873 qemu-system-i386 -cdrom nbd://localhost/debian-500-ppc-netinst
874 qemu-system-i386 -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst
875 @end example
877 The URI syntax for NBD is supported since QEMU 1.3.  An alternative syntax is
878 also available.  Here are some example of the older syntax:
879 @example
880 qemu-system-i386 linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
881 qemu-system-i386 linux2.img -hdb nbd:unix:/tmp/my_socket
882 qemu-system-i386 -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst
883 @end example
885 @node disk_images_sheepdog
886 @subsection Sheepdog disk images
888 Sheepdog is a distributed storage system for QEMU.  It provides highly
889 available block level storage volumes that can be attached to
890 QEMU-based virtual machines.
892 You can create a Sheepdog disk image with the command:
893 @example
894 qemu-img create sheepdog:///@var{image} @var{size}
895 @end example
896 where @var{image} is the Sheepdog image name and @var{size} is its
897 size.
899 To import the existing @var{filename} to Sheepdog, you can use a
900 convert command.
901 @example
902 qemu-img convert @var{filename} sheepdog:///@var{image}
903 @end example
905 You can boot from the Sheepdog disk image with the command:
906 @example
907 qemu-system-i386 sheepdog:///@var{image}
908 @end example
910 You can also create a snapshot of the Sheepdog image like qcow2.
911 @example
912 qemu-img snapshot -c @var{tag} sheepdog:///@var{image}
913 @end example
914 where @var{tag} is a tag name of the newly created snapshot.
916 To boot from the Sheepdog snapshot, specify the tag name of the
917 snapshot.
918 @example
919 qemu-system-i386 sheepdog:///@var{image}#@var{tag}
920 @end example
922 You can create a cloned image from the existing snapshot.
923 @example
924 qemu-img create -b sheepdog:///@var{base}#@var{tag} sheepdog:///@var{image}
925 @end example
926 where @var{base} is a image name of the source snapshot and @var{tag}
927 is its tag name.
929 You can use an unix socket instead of an inet socket:
931 @example
932 qemu-system-i386 sheepdog+unix:///@var{image}?socket=@var{path}
933 @end example
935 If the Sheepdog daemon doesn't run on the local host, you need to
936 specify one of the Sheepdog servers to connect to.
937 @example
938 qemu-img create sheepdog://@var{hostname}:@var{port}/@var{image} @var{size}
939 qemu-system-i386 sheepdog://@var{hostname}:@var{port}/@var{image}
940 @end example
942 @node disk_images_iscsi
943 @subsection iSCSI LUNs
945 iSCSI is a popular protocol used to access SCSI devices across a computer
946 network.
948 There are two different ways iSCSI devices can be used by QEMU.
950 The first method is to mount the iSCSI LUN on the host, and make it appear as
951 any other ordinary SCSI device on the host and then to access this device as a
952 /dev/sd device from QEMU. How to do this differs between host OSes.
954 The second method involves using the iSCSI initiator that is built into
955 QEMU. This provides a mechanism that works the same way regardless of which
956 host OS you are running QEMU on. This section will describe this second method
957 of using iSCSI together with QEMU.
959 In QEMU, iSCSI devices are described using special iSCSI URLs
961 @example
962 URL syntax:
963 iscsi://[<username>[%<password>]@@]<host>[:<port>]/<target-iqn-name>/<lun>
964 @end example
966 Username and password are optional and only used if your target is set up
967 using CHAP authentication for access control.
968 Alternatively the username and password can also be set via environment
969 variables to have these not show up in the process list
971 @example
972 export LIBISCSI_CHAP_USERNAME=<username>
973 export LIBISCSI_CHAP_PASSWORD=<password>
974 iscsi://<host>/<target-iqn-name>/<lun>
975 @end example
977 Various session related parameters can be set via special options, either
978 in a configuration file provided via '-readconfig' or directly on the
979 command line.
981 If the initiator-name is not specified qemu will use a default name
982 of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
983 virtual machine.
986 @example
987 Setting a specific initiator name to use when logging in to the target
988 -iscsi initiator-name=iqn.qemu.test:my-initiator
989 @end example
991 @example
992 Controlling which type of header digest to negotiate with the target
993 -iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
994 @end example
996 These can also be set via a configuration file
997 @example
998 [iscsi]
999   user = "CHAP username"
1000   password = "CHAP password"
1001   initiator-name = "iqn.qemu.test:my-initiator"
1002   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
1003   header-digest = "CRC32C"
1004 @end example
1007 Setting the target name allows different options for different targets
1008 @example
1009 [iscsi "iqn.target.name"]
1010   user = "CHAP username"
1011   password = "CHAP password"
1012   initiator-name = "iqn.qemu.test:my-initiator"
1013   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
1014   header-digest = "CRC32C"
1015 @end example
1018 Howto use a configuration file to set iSCSI configuration options:
1019 @example
1020 cat >iscsi.conf <<EOF
1021 [iscsi]
1022   user = "me"
1023   password = "my password"
1024   initiator-name = "iqn.qemu.test:my-initiator"
1025   header-digest = "CRC32C"
1028 qemu-system-i386 -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1029     -readconfig iscsi.conf
1030 @end example
1033 Howto set up a simple iSCSI target on loopback and accessing it via QEMU:
1034 @example
1035 This example shows how to set up an iSCSI target with one CDROM and one DISK
1036 using the Linux STGT software target. This target is available on Red Hat based
1037 systems as the package 'scsi-target-utils'.
1039 tgtd --iscsi portal=127.0.0.1:3260
1040 tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
1041 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \
1042     -b /IMAGES/disk.img --device-type=disk
1043 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \
1044     -b /IMAGES/cd.iso --device-type=cd
1045 tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
1047 qemu-system-i386 -iscsi initiator-name=iqn.qemu.test:my-initiator \
1048     -boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1049     -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
1050 @end example
1052 @node disk_images_gluster
1053 @subsection GlusterFS disk images
1055 GlusterFS is an user space distributed file system.
1057 You can boot from the GlusterFS disk image with the command:
1058 @example
1059 qemu-system-x86_64 -drive file=gluster[+@var{transport}]://[@var{server}[:@var{port}]]/@var{volname}/@var{image}[?socket=...]
1060 @end example
1062 @var{gluster} is the protocol.
1064 @var{transport} specifies the transport type used to connect to gluster
1065 management daemon (glusterd). Valid transport types are
1066 tcp, unix and rdma. If a transport type isn't specified, then tcp
1067 type is assumed.
1069 @var{server} specifies the server where the volume file specification for
1070 the given volume resides. This can be either hostname, ipv4 address
1071 or ipv6 address. ipv6 address needs to be within square brackets [ ].
1072 If transport type is unix, then @var{server} field should not be specified.
1073 Instead @var{socket} field needs to be populated with the path to unix domain
1074 socket.
1076 @var{port} is the port number on which glusterd is listening. This is optional
1077 and if not specified, QEMU will send 0 which will make gluster to use the
1078 default port. If the transport type is unix, then @var{port} should not be
1079 specified.
1081 @var{volname} is the name of the gluster volume which contains the disk image.
1083 @var{image} is the path to the actual disk image that resides on gluster volume.
1085 You can create a GlusterFS disk image with the command:
1086 @example
1087 qemu-img create gluster://@var{server}/@var{volname}/@var{image} @var{size}
1088 @end example
1090 Examples
1091 @example
1092 qemu-system-x86_64 -drive file=gluster://1.2.3.4/testvol/a.img
1093 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4/testvol/a.img
1094 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
1095 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
1096 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
1097 qemu-system-x86_64 -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
1098 qemu-system-x86_64 -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
1099 qemu-system-x86_64 -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
1100 @end example
1102 @node disk_images_ssh
1103 @subsection Secure Shell (ssh) disk images
1105 You can access disk images located on a remote ssh server
1106 by using the ssh protocol:
1108 @example
1109 qemu-system-x86_64 -drive file=ssh://[@var{user}@@]@var{server}[:@var{port}]/@var{path}[?host_key_check=@var{host_key_check}]
1110 @end example
1112 Alternative syntax using properties:
1114 @example
1115 qemu-system-x86_64 -drive file.driver=ssh[,file.user=@var{user}],file.host=@var{server}[,file.port=@var{port}],file.path=@var{path}[,file.host_key_check=@var{host_key_check}]
1116 @end example
1118 @var{ssh} is the protocol.
1120 @var{user} is the remote user.  If not specified, then the local
1121 username is tried.
1123 @var{server} specifies the remote ssh server.  Any ssh server can be
1124 used, but it must implement the sftp-server protocol.  Most Unix/Linux
1125 systems should work without requiring any extra configuration.
1127 @var{port} is the port number on which sshd is listening.  By default
1128 the standard ssh port (22) is used.
1130 @var{path} is the path to the disk image.
1132 The optional @var{host_key_check} parameter controls how the remote
1133 host's key is checked.  The default is @code{yes} which means to use
1134 the local @file{.ssh/known_hosts} file.  Setting this to @code{no}
1135 turns off known-hosts checking.  Or you can check that the host key
1136 matches a specific fingerprint:
1137 @code{host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8}
1138 (@code{sha1:} can also be used as a prefix, but note that OpenSSH
1139 tools only use MD5 to print fingerprints).
1141 Currently authentication must be done using ssh-agent.  Other
1142 authentication methods may be supported in future.
1144 Note: Many ssh servers do not support an @code{fsync}-style operation.
1145 The ssh driver cannot guarantee that disk flush requests are
1146 obeyed, and this causes a risk of disk corruption if the remote
1147 server or network goes down during writes.  The driver will
1148 print a warning when @code{fsync} is not supported:
1150 warning: ssh server @code{ssh.example.com:22} does not support fsync
1152 With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is
1153 supported.
1155 @node pcsys_network
1156 @section Network emulation
1158 QEMU can simulate several network cards (PCI or ISA cards on the PC
1159 target) and can connect them to an arbitrary number of Virtual Local
1160 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1161 VLAN. VLAN can be connected between separate instances of QEMU to
1162 simulate large networks. For simpler usage, a non privileged user mode
1163 network stack can replace the TAP device to have a basic network
1164 connection.
1166 @subsection VLANs
1168 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1169 connection between several network devices. These devices can be for
1170 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1171 (TAP devices).
1173 @subsection Using TAP network interfaces
1175 This is the standard way to connect QEMU to a real network. QEMU adds
1176 a virtual network device on your host (called @code{tapN}), and you
1177 can then configure it as if it was a real ethernet card.
1179 @subsubsection Linux host
1181 As an example, you can download the @file{linux-test-xxx.tar.gz}
1182 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1183 configure properly @code{sudo} so that the command @code{ifconfig}
1184 contained in @file{qemu-ifup} can be executed as root. You must verify
1185 that your host kernel supports the TAP network interfaces: the
1186 device @file{/dev/net/tun} must be present.
1188 See @ref{sec_invocation} to have examples of command lines using the
1189 TAP network interfaces.
1191 @subsubsection Windows host
1193 There is a virtual ethernet driver for Windows 2000/XP systems, called
1194 TAP-Win32. But it is not included in standard QEMU for Windows,
1195 so you will need to get it separately. It is part of OpenVPN package,
1196 so download OpenVPN from : @url{http://openvpn.net/}.
1198 @subsection Using the user mode network stack
1200 By using the option @option{-net user} (default configuration if no
1201 @option{-net} option is specified), QEMU uses a completely user mode
1202 network stack (you don't need root privilege to use the virtual
1203 network). The virtual network configuration is the following:
1205 @example
1207          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1208                            |          (10.0.2.2)
1209                            |
1210                            ---->  DNS server (10.0.2.3)
1211                            |
1212                            ---->  SMB server (10.0.2.4)
1213 @end example
1215 The QEMU VM behaves as if it was behind a firewall which blocks all
1216 incoming connections. You can use a DHCP client to automatically
1217 configure the network in the QEMU VM. The DHCP server assign addresses
1218 to the hosts starting from 10.0.2.15.
1220 In order to check that the user mode network is working, you can ping
1221 the address 10.0.2.2 and verify that you got an address in the range
1222 10.0.2.x from the QEMU virtual DHCP server.
1224 Note that ICMP traffic in general does not work with user mode networking.
1225 @code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work,
1226 however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP
1227 ping sockets to allow @code{ping} to the Internet. The host admin has to set
1228 the ping_group_range in order to grant access to those sockets. To allow ping
1229 for GID 100 (usually users group):
1231 @example
1232 echo 100 100 > /proc/sys/net/ipv4/ping_group_range
1233 @end example
1235 When using the built-in TFTP server, the router is also the TFTP
1236 server.
1238 When using the @option{-redir} option, TCP or UDP connections can be
1239 redirected from the host to the guest. It allows for example to
1240 redirect X11, telnet or SSH connections.
1242 @subsection Connecting VLANs between QEMU instances
1244 Using the @option{-net socket} option, it is possible to make VLANs
1245 that span several QEMU instances. See @ref{sec_invocation} to have a
1246 basic example.
1248 @node pcsys_other_devs
1249 @section Other Devices
1251 @subsection Inter-VM Shared Memory device
1253 With KVM enabled on a Linux host, a shared memory device is available.  Guests
1254 map a POSIX shared memory region into the guest as a PCI device that enables
1255 zero-copy communication to the application level of the guests.  The basic
1256 syntax is:
1258 @example
1259 qemu-system-i386 -device ivshmem,size=<size in format accepted by -m>[,shm=<shm name>]
1260 @end example
1262 If desired, interrupts can be sent between guest VMs accessing the same shared
1263 memory region.  Interrupt support requires using a shared memory server and
1264 using a chardev socket to connect to it.  The code for the shared memory server
1265 is qemu.git/contrib/ivshmem-server.  An example syntax when using the shared
1266 memory server is:
1268 @example
1269 # First start the ivshmem server once and for all
1270 ivshmem-server -p <pidfile> -S <path> -m <shm name> -l <shm size> -n <vectors n>
1272 # Then start your qemu instances with matching arguments
1273 qemu-system-i386 -device ivshmem,size=<shm size>,vectors=<vectors n>,chardev=<id>
1274                  [,msi=on][,ioeventfd=on][,role=peer|master]
1275                  -chardev socket,path=<path>,id=<id>
1276 @end example
1278 When using the server, the guest will be assigned a VM ID (>=0) that allows guests
1279 using the same server to communicate via interrupts.  Guests can read their
1280 VM ID from a device register (see example code).  Since receiving the shared
1281 memory region from the server is asynchronous, there is a (small) chance the
1282 guest may boot before the shared memory is attached.  To allow an application
1283 to ensure shared memory is attached, the VM ID register will return -1 (an
1284 invalid VM ID) until the memory is attached.  Once the shared memory is
1285 attached, the VM ID will return the guest's valid VM ID.  With these semantics,
1286 the guest application can check to ensure the shared memory is attached to the
1287 guest before proceeding.
1289 The @option{role} argument can be set to either master or peer and will affect
1290 how the shared memory is migrated.  With @option{role=master}, the guest will
1291 copy the shared memory on migration to the destination host.  With
1292 @option{role=peer}, the guest will not be able to migrate with the device attached.
1293 With the @option{peer} case, the device should be detached and then reattached
1294 after migration using the PCI hotplug support.
1296 @subsubsection ivshmem and hugepages
1298 Instead of specifying the <shm size> using POSIX shm, you may specify
1299 a memory backend that has hugepage support:
1301 @example
1302 qemu-system-i386 -object memory-backend-file,size=1G,mem-path=/mnt/hugepages,id=mb1
1303                  -device ivshmem,memdev=mb1
1304 @end example
1306 ivshmem-server also supports hugepages mount points with the
1307 @option{-m} memory path argument.
1309 @node direct_linux_boot
1310 @section Direct Linux Boot
1312 This section explains how to launch a Linux kernel inside QEMU without
1313 having to make a full bootable image. It is very useful for fast Linux
1314 kernel testing.
1316 The syntax is:
1317 @example
1318 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1319 @end example
1321 Use @option{-kernel} to provide the Linux kernel image and
1322 @option{-append} to give the kernel command line arguments. The
1323 @option{-initrd} option can be used to provide an INITRD image.
1325 When using the direct Linux boot, a disk image for the first hard disk
1326 @file{hda} is required because its boot sector is used to launch the
1327 Linux kernel.
1329 If you do not need graphical output, you can disable it and redirect
1330 the virtual serial port and the QEMU monitor to the console with the
1331 @option{-nographic} option. The typical command line is:
1332 @example
1333 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1334                  -append "root=/dev/hda console=ttyS0" -nographic
1335 @end example
1337 Use @key{Ctrl-a c} to switch between the serial console and the
1338 monitor (@pxref{pcsys_keys}).
1340 @node pcsys_usb
1341 @section USB emulation
1343 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1344 virtual USB devices or real host USB devices (experimental, works only
1345 on Linux hosts).  QEMU will automatically create and connect virtual USB hubs
1346 as necessary to connect multiple USB devices.
1348 @menu
1349 * usb_devices::
1350 * host_usb_devices::
1351 @end menu
1352 @node usb_devices
1353 @subsection Connecting USB devices
1355 USB devices can be connected with the @option{-usbdevice} commandline option
1356 or the @code{usb_add} monitor command.  Available devices are:
1358 @table @code
1359 @item mouse
1360 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1361 @item tablet
1362 Pointer device that uses absolute coordinates (like a touchscreen).
1363 This means QEMU is able to report the mouse position without having
1364 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1365 @item disk:@var{file}
1366 Mass storage device based on @var{file} (@pxref{disk_images})
1367 @item host:@var{bus.addr}
1368 Pass through the host device identified by @var{bus.addr}
1369 (Linux only)
1370 @item host:@var{vendor_id:product_id}
1371 Pass through the host device identified by @var{vendor_id:product_id}
1372 (Linux only)
1373 @item wacom-tablet
1374 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
1375 above but it can be used with the tslib library because in addition to touch
1376 coordinates it reports touch pressure.
1377 @item keyboard
1378 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1379 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1380 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1381 device @var{dev}. The available character devices are the same as for the
1382 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1383 used to override the default 0403:6001. For instance,
1384 @example
1385 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1386 @end example
1387 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1388 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1389 @item braille
1390 Braille device.  This will use BrlAPI to display the braille output on a real
1391 or fake device.
1392 @item net:@var{options}
1393 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
1394 specifies NIC options as with @code{-net nic,}@var{options} (see description).
1395 For instance, user-mode networking can be used with
1396 @example
1397 qemu-system-i386 [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
1398 @end example
1399 Currently this cannot be used in machines that support PCI NICs.
1400 @item bt[:@var{hci-type}]
1401 Bluetooth dongle whose type is specified in the same format as with
1402 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
1403 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
1404 This USB device implements the USB Transport Layer of HCI.  Example
1405 usage:
1406 @example
1407 qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
1408 @end example
1409 @end table
1411 @node host_usb_devices
1412 @subsection Using host USB devices on a Linux host
1414 WARNING: this is an experimental feature. QEMU will slow down when
1415 using it. USB devices requiring real time streaming (i.e. USB Video
1416 Cameras) are not supported yet.
1418 @enumerate
1419 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1420 is actually using the USB device. A simple way to do that is simply to
1421 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1422 to @file{mydriver.o.disabled}.
1424 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1425 @example
1426 ls /proc/bus/usb
1427 001  devices  drivers
1428 @end example
1430 @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:
1431 @example
1432 chown -R myuid /proc/bus/usb
1433 @end example
1435 @item Launch QEMU and do in the monitor:
1436 @example
1437 info usbhost
1438   Device 1.2, speed 480 Mb/s
1439     Class 00: USB device 1234:5678, USB DISK
1440 @end example
1441 You should see the list of the devices you can use (Never try to use
1442 hubs, it won't work).
1444 @item Add the device in QEMU by using:
1445 @example
1446 usb_add host:1234:5678
1447 @end example
1449 Normally the guest OS should report that a new USB device is
1450 plugged. You can use the option @option{-usbdevice} to do the same.
1452 @item Now you can try to use the host USB device in QEMU.
1454 @end enumerate
1456 When relaunching QEMU, you may have to unplug and plug again the USB
1457 device to make it work again (this is a bug).
1459 @node vnc_security
1460 @section VNC security
1462 The VNC server capability provides access to the graphical console
1463 of the guest VM across the network. This has a number of security
1464 considerations depending on the deployment scenarios.
1466 @menu
1467 * vnc_sec_none::
1468 * vnc_sec_password::
1469 * vnc_sec_certificate::
1470 * vnc_sec_certificate_verify::
1471 * vnc_sec_certificate_pw::
1472 * vnc_sec_sasl::
1473 * vnc_sec_certificate_sasl::
1474 * vnc_generate_cert::
1475 * vnc_setup_sasl::
1476 @end menu
1477 @node vnc_sec_none
1478 @subsection Without passwords
1480 The simplest VNC server setup does not include any form of authentication.
1481 For this setup it is recommended to restrict it to listen on a UNIX domain
1482 socket only. For example
1484 @example
1485 qemu-system-i386 [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1486 @end example
1488 This ensures that only users on local box with read/write access to that
1489 path can access the VNC server. To securely access the VNC server from a
1490 remote machine, a combination of netcat+ssh can be used to provide a secure
1491 tunnel.
1493 @node vnc_sec_password
1494 @subsection With passwords
1496 The VNC protocol has limited support for password based authentication. Since
1497 the protocol limits passwords to 8 characters it should not be considered
1498 to provide high security. The password can be fairly easily brute-forced by
1499 a client making repeat connections. For this reason, a VNC server using password
1500 authentication should be restricted to only listen on the loopback interface
1501 or UNIX domain sockets. Password authentication is not supported when operating
1502 in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password
1503 authentication is requested with the @code{password} option, and then once QEMU
1504 is running the password is set with the monitor. Until the monitor is used to
1505 set the password all clients will be rejected.
1507 @example
1508 qemu-system-i386 [...OPTIONS...] -vnc :1,password -monitor stdio
1509 (qemu) change vnc password
1510 Password: ********
1511 (qemu)
1512 @end example
1514 @node vnc_sec_certificate
1515 @subsection With x509 certificates
1517 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1518 TLS for encryption of the session, and x509 certificates for authentication.
1519 The use of x509 certificates is strongly recommended, because TLS on its
1520 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1521 support provides a secure session, but no authentication. This allows any
1522 client to connect, and provides an encrypted session.
1524 @example
1525 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1526 @end example
1528 In the above example @code{/etc/pki/qemu} should contain at least three files,
1529 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1530 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1531 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1532 only be readable by the user owning it.
1534 @node vnc_sec_certificate_verify
1535 @subsection With x509 certificates and client verification
1537 Certificates can also provide a means to authenticate the client connecting.
1538 The server will request that the client provide a certificate, which it will
1539 then validate against the CA certificate. This is a good choice if deploying
1540 in an environment with a private internal certificate authority.
1542 @example
1543 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1544 @end example
1547 @node vnc_sec_certificate_pw
1548 @subsection With x509 certificates, client verification and passwords
1550 Finally, the previous method can be combined with VNC password authentication
1551 to provide two layers of authentication for clients.
1553 @example
1554 qemu-system-i386 [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1555 (qemu) change vnc password
1556 Password: ********
1557 (qemu)
1558 @end example
1561 @node vnc_sec_sasl
1562 @subsection With SASL authentication
1564 The SASL authentication method is a VNC extension, that provides an
1565 easily extendable, pluggable authentication method. This allows for
1566 integration with a wide range of authentication mechanisms, such as
1567 PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1568 The strength of the authentication depends on the exact mechanism
1569 configured. If the chosen mechanism also provides a SSF layer, then
1570 it will encrypt the datastream as well.
1572 Refer to the later docs on how to choose the exact SASL mechanism
1573 used for authentication, but assuming use of one supporting SSF,
1574 then QEMU can be launched with:
1576 @example
1577 qemu-system-i386 [...OPTIONS...] -vnc :1,sasl -monitor stdio
1578 @end example
1580 @node vnc_sec_certificate_sasl
1581 @subsection With x509 certificates and SASL authentication
1583 If the desired SASL authentication mechanism does not supported
1584 SSF layers, then it is strongly advised to run it in combination
1585 with TLS and x509 certificates. This provides securely encrypted
1586 data stream, avoiding risk of compromising of the security
1587 credentials. This can be enabled, by combining the 'sasl' option
1588 with the aforementioned TLS + x509 options:
1590 @example
1591 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1592 @end example
1595 @node vnc_generate_cert
1596 @subsection Generating certificates for VNC
1598 The GNU TLS packages provides a command called @code{certtool} which can
1599 be used to generate certificates and keys in PEM format. At a minimum it
1600 is necessary to setup a certificate authority, and issue certificates to
1601 each server. If using certificates for authentication, then each client
1602 will also need to be issued a certificate. The recommendation is for the
1603 server to keep its certificates in either @code{/etc/pki/qemu} or for
1604 unprivileged users in @code{$HOME/.pki/qemu}.
1606 @menu
1607 * vnc_generate_ca::
1608 * vnc_generate_server::
1609 * vnc_generate_client::
1610 @end menu
1611 @node vnc_generate_ca
1612 @subsubsection Setup the Certificate Authority
1614 This step only needs to be performed once per organization / organizational
1615 unit. First the CA needs a private key. This key must be kept VERY secret
1616 and secure. If this key is compromised the entire trust chain of the certificates
1617 issued with it is lost.
1619 @example
1620 # certtool --generate-privkey > ca-key.pem
1621 @end example
1623 A CA needs to have a public certificate. For simplicity it can be a self-signed
1624 certificate, or one issue by a commercial certificate issuing authority. To
1625 generate a self-signed certificate requires one core piece of information, the
1626 name of the organization.
1628 @example
1629 # cat > ca.info <<EOF
1630 cn = Name of your organization
1632 cert_signing_key
1634 # certtool --generate-self-signed \
1635            --load-privkey ca-key.pem
1636            --template ca.info \
1637            --outfile ca-cert.pem
1638 @end example
1640 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1641 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1643 @node vnc_generate_server
1644 @subsubsection Issuing server certificates
1646 Each server (or host) needs to be issued with a key and certificate. When connecting
1647 the certificate is sent to the client which validates it against the CA certificate.
1648 The core piece of information for a server certificate is the hostname. This should
1649 be the fully qualified hostname that the client will connect with, since the client
1650 will typically also verify the hostname in the certificate. On the host holding the
1651 secure CA private key:
1653 @example
1654 # cat > server.info <<EOF
1655 organization = Name  of your organization
1656 cn = server.foo.example.com
1657 tls_www_server
1658 encryption_key
1659 signing_key
1661 # certtool --generate-privkey > server-key.pem
1662 # certtool --generate-certificate \
1663            --load-ca-certificate ca-cert.pem \
1664            --load-ca-privkey ca-key.pem \
1665            --load-privkey server-key.pem \
1666            --template server.info \
1667            --outfile server-cert.pem
1668 @end example
1670 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1671 to the server for which they were generated. The @code{server-key.pem} is security
1672 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1674 @node vnc_generate_client
1675 @subsubsection Issuing client certificates
1677 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1678 certificates as its authentication mechanism, each client also needs to be issued
1679 a certificate. The client certificate contains enough metadata to uniquely identify
1680 the client, typically organization, state, city, building, etc. On the host holding
1681 the secure CA private key:
1683 @example
1684 # cat > client.info <<EOF
1685 country = GB
1686 state = London
1687 locality = London
1688 organization = Name of your organization
1689 cn = client.foo.example.com
1690 tls_www_client
1691 encryption_key
1692 signing_key
1694 # certtool --generate-privkey > client-key.pem
1695 # certtool --generate-certificate \
1696            --load-ca-certificate ca-cert.pem \
1697            --load-ca-privkey ca-key.pem \
1698            --load-privkey client-key.pem \
1699            --template client.info \
1700            --outfile client-cert.pem
1701 @end example
1703 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1704 copied to the client for which they were generated.
1707 @node vnc_setup_sasl
1709 @subsection Configuring SASL mechanisms
1711 The following documentation assumes use of the Cyrus SASL implementation on a
1712 Linux host, but the principals should apply to any other SASL impl. When SASL
1713 is enabled, the mechanism configuration will be loaded from system default
1714 SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1715 unprivileged user, an environment variable SASL_CONF_PATH can be used
1716 to make it search alternate locations for the service config.
1718 The default configuration might contain
1720 @example
1721 mech_list: digest-md5
1722 sasldb_path: /etc/qemu/passwd.db
1723 @end example
1725 This says to use the 'Digest MD5' mechanism, which is similar to the HTTP
1726 Digest-MD5 mechanism. The list of valid usernames & passwords is maintained
1727 in the /etc/qemu/passwd.db file, and can be updated using the saslpasswd2
1728 command. While this mechanism is easy to configure and use, it is not
1729 considered secure by modern standards, so only suitable for developers /
1730 ad-hoc testing.
1732 A more serious deployment might use Kerberos, which is done with the 'gssapi'
1733 mechanism
1735 @example
1736 mech_list: gssapi
1737 keytab: /etc/qemu/krb5.tab
1738 @end example
1740 For this to work the administrator of your KDC must generate a Kerberos
1741 principal for the server, with a name of  'qemu/somehost.example.com@@EXAMPLE.COM'
1742 replacing 'somehost.example.com' with the fully qualified host name of the
1743 machine running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm.
1745 Other configurations will be left as an exercise for the reader. It should
1746 be noted that only Digest-MD5 and GSSAPI provides a SSF layer for data
1747 encryption. For all other mechanisms, VNC should always be configured to
1748 use TLS and x509 certificates to protect security credentials from snooping.
1750 @node gdb_usage
1751 @section GDB usage
1753 QEMU has a primitive support to work with gdb, so that you can do
1754 'Ctrl-C' while the virtual machine is running and inspect its state.
1756 In order to use gdb, launch QEMU with the '-s' option. It will wait for a
1757 gdb connection:
1758 @example
1759 qemu-system-i386 -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1760                     -append "root=/dev/hda"
1761 Connected to host network interface: tun0
1762 Waiting gdb connection on port 1234
1763 @end example
1765 Then launch gdb on the 'vmlinux' executable:
1766 @example
1767 > gdb vmlinux
1768 @end example
1770 In gdb, connect to QEMU:
1771 @example
1772 (gdb) target remote localhost:1234
1773 @end example
1775 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1776 @example
1777 (gdb) c
1778 @end example
1780 Here are some useful tips in order to use gdb on system code:
1782 @enumerate
1783 @item
1784 Use @code{info reg} to display all the CPU registers.
1785 @item
1786 Use @code{x/10i $eip} to display the code at the PC position.
1787 @item
1788 Use @code{set architecture i8086} to dump 16 bit code. Then use
1789 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1790 @end enumerate
1792 Advanced debugging options:
1794 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:
1795 @table @code
1796 @item maintenance packet qqemu.sstepbits
1798 This will display the MASK bits used to control the single stepping IE:
1799 @example
1800 (gdb) maintenance packet qqemu.sstepbits
1801 sending: "qqemu.sstepbits"
1802 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1803 @end example
1804 @item maintenance packet qqemu.sstep
1806 This will display the current value of the mask used when single stepping IE:
1807 @example
1808 (gdb) maintenance packet qqemu.sstep
1809 sending: "qqemu.sstep"
1810 received: "0x7"
1811 @end example
1812 @item maintenance packet Qqemu.sstep=HEX_VALUE
1814 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1815 @example
1816 (gdb) maintenance packet Qqemu.sstep=0x5
1817 sending: "qemu.sstep=0x5"
1818 received: "OK"
1819 @end example
1820 @end table
1822 @node pcsys_os_specific
1823 @section Target OS specific information
1825 @subsection Linux
1827 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1828 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1829 color depth in the guest and the host OS.
1831 When using a 2.6 guest Linux kernel, you should add the option
1832 @code{clock=pit} on the kernel command line because the 2.6 Linux
1833 kernels make very strict real time clock checks by default that QEMU
1834 cannot simulate exactly.
1836 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1837 not activated because QEMU is slower with this patch. The QEMU
1838 Accelerator Module is also much slower in this case. Earlier Fedora
1839 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1840 patch by default. Newer kernels don't have it.
1842 @subsection Windows
1844 If you have a slow host, using Windows 95 is better as it gives the
1845 best speed. Windows 2000 is also a good choice.
1847 @subsubsection SVGA graphic modes support
1849 QEMU emulates a Cirrus Logic GD5446 Video
1850 card. All Windows versions starting from Windows 95 should recognize
1851 and use this graphic card. For optimal performances, use 16 bit color
1852 depth in the guest and the host OS.
1854 If you are using Windows XP as guest OS and if you want to use high
1855 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1856 1280x1024x16), then you should use the VESA VBE virtual graphic card
1857 (option @option{-std-vga}).
1859 @subsubsection CPU usage reduction
1861 Windows 9x does not correctly use the CPU HLT
1862 instruction. The result is that it takes host CPU cycles even when
1863 idle. You can install the utility from
1864 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1865 problem. Note that no such tool is needed for NT, 2000 or XP.
1867 @subsubsection Windows 2000 disk full problem
1869 Windows 2000 has a bug which gives a disk full problem during its
1870 installation. When installing it, use the @option{-win2k-hack} QEMU
1871 option to enable a specific workaround. After Windows 2000 is
1872 installed, you no longer need this option (this option slows down the
1873 IDE transfers).
1875 @subsubsection Windows 2000 shutdown
1877 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1878 can. It comes from the fact that Windows 2000 does not automatically
1879 use the APM driver provided by the BIOS.
1881 In order to correct that, do the following (thanks to Struan
1882 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1883 Add/Troubleshoot a device => Add a new device & Next => No, select the
1884 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1885 (again) a few times. Now the driver is installed and Windows 2000 now
1886 correctly instructs QEMU to shutdown at the appropriate moment.
1888 @subsubsection Share a directory between Unix and Windows
1890 See @ref{sec_invocation} about the help of the option @option{-smb}.
1892 @subsubsection Windows XP security problem
1894 Some releases of Windows XP install correctly but give a security
1895 error when booting:
1896 @example
1897 A problem is preventing Windows from accurately checking the
1898 license for this computer. Error code: 0x800703e6.
1899 @end example
1901 The workaround is to install a service pack for XP after a boot in safe
1902 mode. Then reboot, and the problem should go away. Since there is no
1903 network while in safe mode, its recommended to download the full
1904 installation of SP1 or SP2 and transfer that via an ISO or using the
1905 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1907 @subsection MS-DOS and FreeDOS
1909 @subsubsection CPU usage reduction
1911 DOS does not correctly use the CPU HLT instruction. The result is that
1912 it takes host CPU cycles even when idle. You can install the utility
1913 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1914 problem.
1916 @node QEMU System emulator for non PC targets
1917 @chapter QEMU System emulator for non PC targets
1919 QEMU is a generic emulator and it emulates many non PC
1920 machines. Most of the options are similar to the PC emulator. The
1921 differences are mentioned in the following sections.
1923 @menu
1924 * PowerPC System emulator::
1925 * Sparc32 System emulator::
1926 * Sparc64 System emulator::
1927 * MIPS System emulator::
1928 * ARM System emulator::
1929 * ColdFire System emulator::
1930 * Cris System emulator::
1931 * Microblaze System emulator::
1932 * SH4 System emulator::
1933 * Xtensa System emulator::
1934 @end menu
1936 @node PowerPC System emulator
1937 @section PowerPC System emulator
1938 @cindex system emulation (PowerPC)
1940 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1941 or PowerMac PowerPC system.
1943 QEMU emulates the following PowerMac peripherals:
1945 @itemize @minus
1946 @item
1947 UniNorth or Grackle PCI Bridge
1948 @item
1949 PCI VGA compatible card with VESA Bochs Extensions
1950 @item
1951 2 PMAC IDE interfaces with hard disk and CD-ROM support
1952 @item
1953 NE2000 PCI adapters
1954 @item
1955 Non Volatile RAM
1956 @item
1957 VIA-CUDA with ADB keyboard and mouse.
1958 @end itemize
1960 QEMU emulates the following PREP peripherals:
1962 @itemize @minus
1963 @item
1964 PCI Bridge
1965 @item
1966 PCI VGA compatible card with VESA Bochs Extensions
1967 @item
1968 2 IDE interfaces with hard disk and CD-ROM support
1969 @item
1970 Floppy disk
1971 @item
1972 NE2000 network adapters
1973 @item
1974 Serial port
1975 @item
1976 PREP Non Volatile RAM
1977 @item
1978 PC compatible keyboard and mouse.
1979 @end itemize
1981 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1982 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1984 Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
1985 for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
1986 v2) portable firmware implementation. The goal is to implement a 100%
1987 IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
1989 @c man begin OPTIONS
1991 The following options are specific to the PowerPC emulation:
1993 @table @option
1995 @item -g @var{W}x@var{H}[x@var{DEPTH}]
1997 Set the initial VGA graphic mode. The default is 800x600x32.
1999 @item -prom-env @var{string}
2001 Set OpenBIOS variables in NVRAM, for example:
2003 @example
2004 qemu-system-ppc -prom-env 'auto-boot?=false' \
2005  -prom-env 'boot-device=hd:2,\yaboot' \
2006  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
2007 @end example
2009 These variables are not used by Open Hack'Ware.
2011 @end table
2013 @c man end
2016 More information is available at
2017 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2019 @node Sparc32 System emulator
2020 @section Sparc32 System emulator
2021 @cindex system emulation (Sparc32)
2023 Use the executable @file{qemu-system-sparc} to simulate the following
2024 Sun4m architecture machines:
2025 @itemize @minus
2026 @item
2027 SPARCstation 4
2028 @item
2029 SPARCstation 5
2030 @item
2031 SPARCstation 10
2032 @item
2033 SPARCstation 20
2034 @item
2035 SPARCserver 600MP
2036 @item
2037 SPARCstation LX
2038 @item
2039 SPARCstation Voyager
2040 @item
2041 SPARCclassic
2042 @item
2043 SPARCbook
2044 @end itemize
2046 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
2047 but Linux limits the number of usable CPUs to 4.
2049 QEMU emulates the following sun4m peripherals:
2051 @itemize @minus
2052 @item
2053 IOMMU
2054 @item
2055 TCX or cgthree Frame buffer
2056 @item
2057 Lance (Am7990) Ethernet
2058 @item
2059 Non Volatile RAM M48T02/M48T08
2060 @item
2061 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2062 and power/reset logic
2063 @item
2064 ESP SCSI controller with hard disk and CD-ROM support
2065 @item
2066 Floppy drive (not on SS-600MP)
2067 @item
2068 CS4231 sound device (only on SS-5, not working yet)
2069 @end itemize
2071 The number of peripherals is fixed in the architecture.  Maximum
2072 memory size depends on the machine type, for SS-5 it is 256MB and for
2073 others 2047MB.
2075 Since version 0.8.2, QEMU uses OpenBIOS
2076 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2077 firmware implementation. The goal is to implement a 100% IEEE
2078 1275-1994 (referred to as Open Firmware) compliant firmware.
2080 A sample Linux 2.6 series kernel and ram disk image are available on
2081 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
2082 most kernel versions work. Please note that currently older Solaris kernels
2083 don't work probably due to interface issues between OpenBIOS and
2084 Solaris.
2086 @c man begin OPTIONS
2088 The following options are specific to the Sparc32 emulation:
2090 @table @option
2092 @item -g @var{W}x@var{H}x[x@var{DEPTH}]
2094 Set the initial graphics mode. For TCX, the default is 1024x768x8 with the
2095 option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
2096 of 1152x900x8 for people who wish to use OBP.
2098 @item -prom-env @var{string}
2100 Set OpenBIOS variables in NVRAM, for example:
2102 @example
2103 qemu-system-sparc -prom-env 'auto-boot?=false' \
2104  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2105 @end example
2107 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]
2109 Set the emulated machine type. Default is SS-5.
2111 @end table
2113 @c man end
2115 @node Sparc64 System emulator
2116 @section Sparc64 System emulator
2117 @cindex system emulation (Sparc64)
2119 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
2120 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
2121 Niagara (T1) machine. The Sun4u emulator is mostly complete, being
2122 able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The
2123 Sun4v and Niagara emulators are still a work in progress.
2125 QEMU emulates the following peripherals:
2127 @itemize @minus
2128 @item
2129 UltraSparc IIi APB PCI Bridge
2130 @item
2131 PCI VGA compatible card with VESA Bochs Extensions
2132 @item
2133 PS/2 mouse and keyboard
2134 @item
2135 Non Volatile RAM M48T59
2136 @item
2137 PC-compatible serial ports
2138 @item
2139 2 PCI IDE interfaces with hard disk and CD-ROM support
2140 @item
2141 Floppy disk
2142 @end itemize
2144 @c man begin OPTIONS
2146 The following options are specific to the Sparc64 emulation:
2148 @table @option
2150 @item -prom-env @var{string}
2152 Set OpenBIOS variables in NVRAM, for example:
2154 @example
2155 qemu-system-sparc64 -prom-env 'auto-boot?=false'
2156 @end example
2158 @item -M [sun4u|sun4v|Niagara]
2160 Set the emulated machine type. The default is sun4u.
2162 @end table
2164 @c man end
2166 @node MIPS System emulator
2167 @section MIPS System emulator
2168 @cindex system emulation (MIPS)
2170 Four executables cover simulation of 32 and 64-bit MIPS systems in
2171 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2172 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2173 Five different machine types are emulated:
2175 @itemize @minus
2176 @item
2177 A generic ISA PC-like machine "mips"
2178 @item
2179 The MIPS Malta prototype board "malta"
2180 @item
2181 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2182 @item
2183 MIPS emulator pseudo board "mipssim"
2184 @item
2185 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2186 @end itemize
2188 The generic emulation is supported by Debian 'Etch' and is able to
2189 install Debian into a virtual disk image. The following devices are
2190 emulated:
2192 @itemize @minus
2193 @item
2194 A range of MIPS CPUs, default is the 24Kf
2195 @item
2196 PC style serial port
2197 @item
2198 PC style IDE disk
2199 @item
2200 NE2000 network card
2201 @end itemize
2203 The Malta emulation supports the following devices:
2205 @itemize @minus
2206 @item
2207 Core board with MIPS 24Kf CPU and Galileo system controller
2208 @item
2209 PIIX4 PCI/USB/SMbus controller
2210 @item
2211 The Multi-I/O chip's serial device
2212 @item
2213 PCI network cards (PCnet32 and others)
2214 @item
2215 Malta FPGA serial device
2216 @item
2217 Cirrus (default) or any other PCI VGA graphics card
2218 @end itemize
2220 The ACER Pica emulation supports:
2222 @itemize @minus
2223 @item
2224 MIPS R4000 CPU
2225 @item
2226 PC-style IRQ and DMA controllers
2227 @item
2228 PC Keyboard
2229 @item
2230 IDE controller
2231 @end itemize
2233 The mipssim pseudo board emulation provides an environment similar
2234 to what the proprietary MIPS emulator uses for running Linux.
2235 It supports:
2237 @itemize @minus
2238 @item
2239 A range of MIPS CPUs, default is the 24Kf
2240 @item
2241 PC style serial port
2242 @item
2243 MIPSnet network emulation
2244 @end itemize
2246 The MIPS Magnum R4000 emulation supports:
2248 @itemize @minus
2249 @item
2250 MIPS R4000 CPU
2251 @item
2252 PC-style IRQ controller
2253 @item
2254 PC Keyboard
2255 @item
2256 SCSI controller
2257 @item
2258 G364 framebuffer
2259 @end itemize
2262 @node ARM System emulator
2263 @section ARM System emulator
2264 @cindex system emulation (ARM)
2266 Use the executable @file{qemu-system-arm} to simulate a ARM
2267 machine. The ARM Integrator/CP board is emulated with the following
2268 devices:
2270 @itemize @minus
2271 @item
2272 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2273 @item
2274 Two PL011 UARTs
2275 @item
2276 SMC 91c111 Ethernet adapter
2277 @item
2278 PL110 LCD controller
2279 @item
2280 PL050 KMI with PS/2 keyboard and mouse.
2281 @item
2282 PL181 MultiMedia Card Interface with SD card.
2283 @end itemize
2285 The ARM Versatile baseboard is emulated with the following devices:
2287 @itemize @minus
2288 @item
2289 ARM926E, ARM1136 or Cortex-A8 CPU
2290 @item
2291 PL190 Vectored Interrupt Controller
2292 @item
2293 Four PL011 UARTs
2294 @item
2295 SMC 91c111 Ethernet adapter
2296 @item
2297 PL110 LCD controller
2298 @item
2299 PL050 KMI with PS/2 keyboard and mouse.
2300 @item
2301 PCI host bridge.  Note the emulated PCI bridge only provides access to
2302 PCI memory space.  It does not provide access to PCI IO space.
2303 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2304 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2305 mapped control registers.
2306 @item
2307 PCI OHCI USB controller.
2308 @item
2309 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2310 @item
2311 PL181 MultiMedia Card Interface with SD card.
2312 @end itemize
2314 Several variants of the ARM RealView baseboard are emulated,
2315 including the EB, PB-A8 and PBX-A9.  Due to interactions with the
2316 bootloader, only certain Linux kernel configurations work out
2317 of the box on these boards.
2319 Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2320 enabled in the kernel, and expect 512M RAM.  Kernels for The PBX-A9 board
2321 should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2322 disabled and expect 1024M RAM.
2324 The following devices are emulated:
2326 @itemize @minus
2327 @item
2328 ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
2329 @item
2330 ARM AMBA Generic/Distributed Interrupt Controller
2331 @item
2332 Four PL011 UARTs
2333 @item
2334 SMC 91c111 or SMSC LAN9118 Ethernet adapter
2335 @item
2336 PL110 LCD controller
2337 @item
2338 PL050 KMI with PS/2 keyboard and mouse
2339 @item
2340 PCI host bridge
2341 @item
2342 PCI OHCI USB controller
2343 @item
2344 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2345 @item
2346 PL181 MultiMedia Card Interface with SD card.
2347 @end itemize
2349 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2350 and "Terrier") emulation includes the following peripherals:
2352 @itemize @minus
2353 @item
2354 Intel PXA270 System-on-chip (ARM V5TE core)
2355 @item
2356 NAND Flash memory
2357 @item
2358 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2359 @item
2360 On-chip OHCI USB controller
2361 @item
2362 On-chip LCD controller
2363 @item
2364 On-chip Real Time Clock
2365 @item
2366 TI ADS7846 touchscreen controller on SSP bus
2367 @item
2368 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2369 @item
2370 GPIO-connected keyboard controller and LEDs
2371 @item
2372 Secure Digital card connected to PXA MMC/SD host
2373 @item
2374 Three on-chip UARTs
2375 @item
2376 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2377 @end itemize
2379 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2380 following elements:
2382 @itemize @minus
2383 @item
2384 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2385 @item
2386 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2387 @item
2388 On-chip LCD controller
2389 @item
2390 On-chip Real Time Clock
2391 @item
2392 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2393 CODEC, connected through MicroWire and I@math{^2}S busses
2394 @item
2395 GPIO-connected matrix keypad
2396 @item
2397 Secure Digital card connected to OMAP MMC/SD host
2398 @item
2399 Three on-chip UARTs
2400 @end itemize
2402 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2403 emulation supports the following elements:
2405 @itemize @minus
2406 @item
2407 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2408 @item
2409 RAM and non-volatile OneNAND Flash memories
2410 @item
2411 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2412 display controller and a LS041y3 MIPI DBI-C controller
2413 @item
2414 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2415 driven through SPI bus
2416 @item
2417 National Semiconductor LM8323-controlled qwerty keyboard driven
2418 through I@math{^2}C bus
2419 @item
2420 Secure Digital card connected to OMAP MMC/SD host
2421 @item
2422 Three OMAP on-chip UARTs and on-chip STI debugging console
2423 @item
2424 A Bluetooth(R) transceiver and HCI connected to an UART
2425 @item
2426 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2427 TUSB6010 chip - only USB host mode is supported
2428 @item
2429 TI TMP105 temperature sensor driven through I@math{^2}C bus
2430 @item
2431 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2432 @item
2433 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2434 through CBUS
2435 @end itemize
2437 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2438 devices:
2440 @itemize @minus
2441 @item
2442 Cortex-M3 CPU core.
2443 @item
2444 64k Flash and 8k SRAM.
2445 @item
2446 Timers, UARTs, ADC and I@math{^2}C interface.
2447 @item
2448 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2449 @end itemize
2451 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2452 devices:
2454 @itemize @minus
2455 @item
2456 Cortex-M3 CPU core.
2457 @item
2458 256k Flash and 64k SRAM.
2459 @item
2460 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2461 @item
2462 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2463 @end itemize
2465 The Freecom MusicPal internet radio emulation includes the following
2466 elements:
2468 @itemize @minus
2469 @item
2470 Marvell MV88W8618 ARM core.
2471 @item
2472 32 MB RAM, 256 KB SRAM, 8 MB flash.
2473 @item
2474 Up to 2 16550 UARTs
2475 @item
2476 MV88W8xx8 Ethernet controller
2477 @item
2478 MV88W8618 audio controller, WM8750 CODEC and mixer
2479 @item
2480 128×64 display with brightness control
2481 @item
2482 2 buttons, 2 navigation wheels with button function
2483 @end itemize
2485 The Siemens SX1 models v1 and v2 (default) basic emulation.
2486 The emulation includes the following elements:
2488 @itemize @minus
2489 @item
2490 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2491 @item
2492 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2494 1 Flash of 16MB and 1 Flash of 8MB
2496 1 Flash of 32MB
2497 @item
2498 On-chip LCD controller
2499 @item
2500 On-chip Real Time Clock
2501 @item
2502 Secure Digital card connected to OMAP MMC/SD host
2503 @item
2504 Three on-chip UARTs
2505 @end itemize
2507 A Linux 2.6 test image is available on the QEMU web site. More
2508 information is available in the QEMU mailing-list archive.
2510 @c man begin OPTIONS
2512 The following options are specific to the ARM emulation:
2514 @table @option
2516 @item -semihosting
2517 Enable semihosting syscall emulation.
2519 On ARM this implements the "Angel" interface.
2521 Note that this allows guest direct access to the host filesystem,
2522 so should only be used with trusted guest OS.
2524 @end table
2526 @node ColdFire System emulator
2527 @section ColdFire System emulator
2528 @cindex system emulation (ColdFire)
2529 @cindex system emulation (M68K)
2531 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2532 The emulator is able to boot a uClinux kernel.
2534 The M5208EVB emulation includes the following devices:
2536 @itemize @minus
2537 @item
2538 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2539 @item
2540 Three Two on-chip UARTs.
2541 @item
2542 Fast Ethernet Controller (FEC)
2543 @end itemize
2545 The AN5206 emulation includes the following devices:
2547 @itemize @minus
2548 @item
2549 MCF5206 ColdFire V2 Microprocessor.
2550 @item
2551 Two on-chip UARTs.
2552 @end itemize
2554 @c man begin OPTIONS
2556 The following options are specific to the ColdFire emulation:
2558 @table @option
2560 @item -semihosting
2561 Enable semihosting syscall emulation.
2563 On M68K this implements the "ColdFire GDB" interface used by libgloss.
2565 Note that this allows guest direct access to the host filesystem,
2566 so should only be used with trusted guest OS.
2568 @end table
2570 @node Cris System emulator
2571 @section Cris System emulator
2572 @cindex system emulation (Cris)
2574 TODO
2576 @node Microblaze System emulator
2577 @section Microblaze System emulator
2578 @cindex system emulation (Microblaze)
2580 TODO
2582 @node SH4 System emulator
2583 @section SH4 System emulator
2584 @cindex system emulation (SH4)
2586 TODO
2588 @node Xtensa System emulator
2589 @section Xtensa System emulator
2590 @cindex system emulation (Xtensa)
2592 Two executables cover simulation of both Xtensa endian options,
2593 @file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}.
2594 Two different machine types are emulated:
2596 @itemize @minus
2597 @item
2598 Xtensa emulator pseudo board "sim"
2599 @item
2600 Avnet LX60/LX110/LX200 board
2601 @end itemize
2603 The sim pseudo board emulation provides an environment similar
2604 to one provided by the proprietary Tensilica ISS.
2605 It supports:
2607 @itemize @minus
2608 @item
2609 A range of Xtensa CPUs, default is the DC232B
2610 @item
2611 Console and filesystem access via semihosting calls
2612 @end itemize
2614 The Avnet LX60/LX110/LX200 emulation supports:
2616 @itemize @minus
2617 @item
2618 A range of Xtensa CPUs, default is the DC232B
2619 @item
2620 16550 UART
2621 @item
2622 OpenCores 10/100 Mbps Ethernet MAC
2623 @end itemize
2625 @c man begin OPTIONS
2627 The following options are specific to the Xtensa emulation:
2629 @table @option
2631 @item -semihosting
2632 Enable semihosting syscall emulation.
2634 Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select.
2635 Tensilica baremetal libc for ISS and linux platform "sim" use this interface.
2637 Note that this allows guest direct access to the host filesystem,
2638 so should only be used with trusted guest OS.
2640 @end table
2641 @node QEMU User space emulator
2642 @chapter QEMU User space emulator
2644 @menu
2645 * Supported Operating Systems ::
2646 * Linux User space emulator::
2647 * BSD User space emulator ::
2648 @end menu
2650 @node Supported Operating Systems
2651 @section Supported Operating Systems
2653 The following OS are supported in user space emulation:
2655 @itemize @minus
2656 @item
2657 Linux (referred as qemu-linux-user)
2658 @item
2659 BSD (referred as qemu-bsd-user)
2660 @end itemize
2662 @node Linux User space emulator
2663 @section Linux User space emulator
2665 @menu
2666 * Quick Start::
2667 * Wine launch::
2668 * Command line options::
2669 * Other binaries::
2670 @end menu
2672 @node Quick Start
2673 @subsection Quick Start
2675 In order to launch a Linux process, QEMU needs the process executable
2676 itself and all the target (x86) dynamic libraries used by it.
2678 @itemize
2680 @item On x86, you can just try to launch any process by using the native
2681 libraries:
2683 @example
2684 qemu-i386 -L / /bin/ls
2685 @end example
2687 @code{-L /} tells that the x86 dynamic linker must be searched with a
2688 @file{/} prefix.
2690 @item Since QEMU is also a linux process, you can launch QEMU with
2691 QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
2693 @example
2694 qemu-i386 -L / qemu-i386 -L / /bin/ls
2695 @end example
2697 @item On non x86 CPUs, you need first to download at least an x86 glibc
2698 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2699 @code{LD_LIBRARY_PATH} is not set:
2701 @example
2702 unset LD_LIBRARY_PATH
2703 @end example
2705 Then you can launch the precompiled @file{ls} x86 executable:
2707 @example
2708 qemu-i386 tests/i386/ls
2709 @end example
2710 You can look at @file{scripts/qemu-binfmt-conf.sh} so that
2711 QEMU is automatically launched by the Linux kernel when you try to
2712 launch x86 executables. It requires the @code{binfmt_misc} module in the
2713 Linux kernel.
2715 @item The x86 version of QEMU is also included. You can try weird things such as:
2716 @example
2717 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2718           /usr/local/qemu-i386/bin/ls-i386
2719 @end example
2721 @end itemize
2723 @node Wine launch
2724 @subsection Wine launch
2726 @itemize
2728 @item Ensure that you have a working QEMU with the x86 glibc
2729 distribution (see previous section). In order to verify it, you must be
2730 able to do:
2732 @example
2733 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2734 @end example
2736 @item Download the binary x86 Wine install
2737 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2739 @item Configure Wine on your account. Look at the provided script
2740 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2741 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2743 @item Then you can try the example @file{putty.exe}:
2745 @example
2746 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2747           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2748 @end example
2750 @end itemize
2752 @node Command line options
2753 @subsection Command line options
2755 @example
2756 usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
2757 @end example
2759 @table @option
2760 @item -h
2761 Print the help
2762 @item -L path
2763 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2764 @item -s size
2765 Set the x86 stack size in bytes (default=524288)
2766 @item -cpu model
2767 Select CPU model (-cpu help for list and additional feature selection)
2768 @item -E @var{var}=@var{value}
2769 Set environment @var{var} to @var{value}.
2770 @item -U @var{var}
2771 Remove @var{var} from the environment.
2772 @item -B offset
2773 Offset guest address by the specified number of bytes.  This is useful when
2774 the address region required by guest applications is reserved on the host.
2775 This option is currently only supported on some hosts.
2776 @item -R size
2777 Pre-allocate a guest virtual address space of the given size (in bytes).
2778 "G", "M", and "k" suffixes may be used when specifying the size.
2779 @end table
2781 Debug options:
2783 @table @option
2784 @item -d item1,...
2785 Activate logging of the specified items (use '-d help' for a list of log items)
2786 @item -p pagesize
2787 Act as if the host page size was 'pagesize' bytes
2788 @item -g port
2789 Wait gdb connection to port
2790 @item -singlestep
2791 Run the emulation in single step mode.
2792 @end table
2794 Environment variables:
2796 @table @env
2797 @item QEMU_STRACE
2798 Print system calls and arguments similar to the 'strace' program
2799 (NOTE: the actual 'strace' program will not work because the user
2800 space emulator hasn't implemented ptrace).  At the moment this is
2801 incomplete.  All system calls that don't have a specific argument
2802 format are printed with information for six arguments.  Many
2803 flag-style arguments don't have decoders and will show up as numbers.
2804 @end table
2806 @node Other binaries
2807 @subsection Other binaries
2809 @cindex user mode (Alpha)
2810 @command{qemu-alpha} TODO.
2812 @cindex user mode (ARM)
2813 @command{qemu-armeb} TODO.
2815 @cindex user mode (ARM)
2816 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2817 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2818 configurations), and arm-uclinux bFLT format binaries.
2820 @cindex user mode (ColdFire)
2821 @cindex user mode (M68K)
2822 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2823 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2824 coldfire uClinux bFLT format binaries.
2826 The binary format is detected automatically.
2828 @cindex user mode (Cris)
2829 @command{qemu-cris} TODO.
2831 @cindex user mode (i386)
2832 @command{qemu-i386} TODO.
2833 @command{qemu-x86_64} TODO.
2835 @cindex user mode (Microblaze)
2836 @command{qemu-microblaze} TODO.
2838 @cindex user mode (MIPS)
2839 @command{qemu-mips} TODO.
2840 @command{qemu-mipsel} TODO.
2842 @cindex user mode (PowerPC)
2843 @command{qemu-ppc64abi32} TODO.
2844 @command{qemu-ppc64} TODO.
2845 @command{qemu-ppc} TODO.
2847 @cindex user mode (SH4)
2848 @command{qemu-sh4eb} TODO.
2849 @command{qemu-sh4} TODO.
2851 @cindex user mode (SPARC)
2852 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2854 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2855 (Sparc64 CPU, 32 bit ABI).
2857 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2858 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2860 @node BSD User space emulator
2861 @section BSD User space emulator
2863 @menu
2864 * BSD Status::
2865 * BSD Quick Start::
2866 * BSD Command line options::
2867 @end menu
2869 @node BSD Status
2870 @subsection BSD Status
2872 @itemize @minus
2873 @item
2874 target Sparc64 on Sparc64: Some trivial programs work.
2875 @end itemize
2877 @node BSD Quick Start
2878 @subsection Quick Start
2880 In order to launch a BSD process, QEMU needs the process executable
2881 itself and all the target dynamic libraries used by it.
2883 @itemize
2885 @item On Sparc64, you can just try to launch any process by using the native
2886 libraries:
2888 @example
2889 qemu-sparc64 /bin/ls
2890 @end example
2892 @end itemize
2894 @node BSD Command line options
2895 @subsection Command line options
2897 @example
2898 usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
2899 @end example
2901 @table @option
2902 @item -h
2903 Print the help
2904 @item -L path
2905 Set the library root path (default=/)
2906 @item -s size
2907 Set the stack size in bytes (default=524288)
2908 @item -ignore-environment
2909 Start with an empty environment. Without this option,
2910 the initial environment is a copy of the caller's environment.
2911 @item -E @var{var}=@var{value}
2912 Set environment @var{var} to @var{value}.
2913 @item -U @var{var}
2914 Remove @var{var} from the environment.
2915 @item -bsd type
2916 Set the type of the emulated BSD Operating system. Valid values are
2917 FreeBSD, NetBSD and OpenBSD (default).
2918 @end table
2920 Debug options:
2922 @table @option
2923 @item -d item1,...
2924 Activate logging of the specified items (use '-d help' for a list of log items)
2925 @item -p pagesize
2926 Act as if the host page size was 'pagesize' bytes
2927 @item -singlestep
2928 Run the emulation in single step mode.
2929 @end table
2931 @node compilation
2932 @chapter Compilation from the sources
2934 @menu
2935 * Linux/Unix::
2936 * Windows::
2937 * Cross compilation for Windows with Linux::
2938 * Mac OS X::
2939 * Make targets::
2940 @end menu
2942 @node Linux/Unix
2943 @section Linux/Unix
2945 @subsection Compilation
2947 First you must decompress the sources:
2948 @example
2949 cd /tmp
2950 tar zxvf qemu-x.y.z.tar.gz
2951 cd qemu-x.y.z
2952 @end example
2954 Then you configure QEMU and build it (usually no options are needed):
2955 @example
2956 ./configure
2957 make
2958 @end example
2960 Then type as root user:
2961 @example
2962 make install
2963 @end example
2964 to install QEMU in @file{/usr/local}.
2966 @node Windows
2967 @section Windows
2969 @itemize
2970 @item Install the current versions of MSYS and MinGW from
2971 @url{http://www.mingw.org/}. You can find detailed installation
2972 instructions in the download section and the FAQ.
2974 @item Download
2975 the MinGW development library of SDL 1.2.x
2976 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2977 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2978 edit the @file{sdl-config} script so that it gives the
2979 correct SDL directory when invoked.
2981 @item Install the MinGW version of zlib and make sure
2982 @file{zlib.h} and @file{libz.dll.a} are in
2983 MinGW's default header and linker search paths.
2985 @item Extract the current version of QEMU.
2987 @item Start the MSYS shell (file @file{msys.bat}).
2989 @item Change to the QEMU directory. Launch @file{./configure} and
2990 @file{make}.  If you have problems using SDL, verify that
2991 @file{sdl-config} can be launched from the MSYS command line.
2993 @item You can install QEMU in @file{Program Files/QEMU} by typing
2994 @file{make install}. Don't forget to copy @file{SDL.dll} in
2995 @file{Program Files/QEMU}.
2997 @end itemize
2999 @node Cross compilation for Windows with Linux
3000 @section Cross compilation for Windows with Linux
3002 @itemize
3003 @item
3004 Install the MinGW cross compilation tools available at
3005 @url{http://www.mingw.org/}.
3007 @item Download
3008 the MinGW development library of SDL 1.2.x
3009 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
3010 @url{http://www.libsdl.org}. Unpack it in a temporary place and
3011 edit the @file{sdl-config} script so that it gives the
3012 correct SDL directory when invoked.  Set up the @code{PATH} environment
3013 variable so that @file{sdl-config} can be launched by
3014 the QEMU configuration script.
3016 @item Install the MinGW version of zlib and make sure
3017 @file{zlib.h} and @file{libz.dll.a} are in
3018 MinGW's default header and linker search paths.
3020 @item
3021 Configure QEMU for Windows cross compilation:
3022 @example
3023 PATH=/usr/i686-pc-mingw32/sys-root/mingw/bin:$PATH ./configure --cross-prefix='i686-pc-mingw32-'
3024 @end example
3025 The example assumes @file{sdl-config} is installed under @file{/usr/i686-pc-mingw32/sys-root/mingw/bin} and
3026 MinGW cross compilation tools have names like @file{i686-pc-mingw32-gcc} and @file{i686-pc-mingw32-strip}.
3027 We set the @code{PATH} environment variable to ensure the MinGW version of @file{sdl-config} is used and
3028 use --cross-prefix to specify the name of the cross compiler.
3029 You can also use --prefix to set the Win32 install path which defaults to @file{c:/Program Files/QEMU}.
3031 Under Fedora Linux, you can run:
3032 @example
3033 yum -y install mingw32-gcc mingw32-SDL mingw32-zlib
3034 @end example
3035 to get a suitable cross compilation environment.
3037 @item You can install QEMU in the installation directory by typing
3038 @code{make install}. Don't forget to copy @file{SDL.dll} and @file{zlib1.dll} into the
3039 installation directory.
3041 @end itemize
3043 Wine can be used to launch the resulting qemu-system-i386.exe
3044 and all other qemu-system-@var{target}.exe compiled for Win32.
3046 @node Mac OS X
3047 @section Mac OS X
3049 System Requirements:
3050 @itemize
3051 @item Mac OS 10.5 or higher
3052 @item The clang compiler shipped with Xcode 4.2 or higher,
3053 or GCC 4.3 or higher
3054 @end itemize
3056 Additional Requirements (install in order):
3057 @enumerate
3058 @item libffi: @uref{https://sourceware.org/libffi/}
3059 @item gettext: @uref{http://www.gnu.org/software/gettext/}
3060 @item glib: @uref{http://ftp.gnome.org/pub/GNOME/sources/glib/}
3061 @item pkg-config: @uref{http://www.freedesktop.org/wiki/Software/pkg-config/}
3062 @item autoconf: @uref{http://www.gnu.org/software/autoconf/autoconf.html}
3063 @item automake: @uref{http://www.gnu.org/software/automake/}
3064 @item libtool: @uref{http://www.gnu.org/software/libtool/}
3065 @item pixman: @uref{http://www.pixman.org/}
3066 @end enumerate
3068 * You may find it easiest to get these from a third-party packager
3069 such as Homebrew, Macports, or Fink.
3071 After downloading the QEMU source code, double-click it to expand it.
3073 Then configure and make QEMU:
3074 @example
3075 ./configure
3076 make
3077 @end example
3079 If you have a recent version of Mac OS X (OSX 10.7 or better
3080 with Xcode 4.2 or better) we recommend building QEMU with the
3081 default compiler provided by Apple, for your version of Mac OS X
3082 (which will be 'clang'). The configure script will
3083 automatically pick this.
3085 Note: If after the configure step you see a message like this:
3086 @example
3087 ERROR: Your compiler does not support the __thread specifier for
3088        Thread-Local Storage (TLS). Please upgrade to a version that does.
3089 @end example
3090 you may have to build your own version of gcc from source. Expect that to take
3091 several hours. More information can be found here:
3092 @uref{https://gcc.gnu.org/install/} @*
3094 These are some of the third party binaries of gcc available for download:
3095 @itemize
3096 @item Homebrew: @uref{http://brew.sh/}
3097 @item @uref{https://www.litebeam.net/gcc/gcc_472.pkg}
3098 @item @uref{http://www.macports.org/ports.php?by=name&substr=gcc}
3099 @end itemize
3101 You can have several versions of GCC on your system. To specify a certain version,
3102 use the --cc and --cxx options.
3103 @example
3104 ./configure --cxx=<path of your c++ compiler> --cc=<path of your c compiler> <other options>
3105 @end example
3107 @node Make targets
3108 @section Make targets
3110 @table @code
3112 @item make
3113 @item make all
3114 Make everything which is typically needed.
3116 @item install
3117 TODO
3119 @item install-doc
3120 TODO
3122 @item make clean
3123 Remove most files which were built during make.
3125 @item make distclean
3126 Remove everything which was built during make.
3128 @item make dvi
3129 @item make html
3130 @item make info
3131 @item make pdf
3132 Create documentation in dvi, html, info or pdf format.
3134 @item make cscope
3135 TODO
3137 @item make defconfig
3138 (Re-)create some build configuration files.
3139 User made changes will be overwritten.
3141 @item tar
3142 @item tarbin
3143 TODO
3145 @end table
3147 @node License
3148 @appendix License
3150 QEMU is a trademark of Fabrice Bellard.
3152 QEMU is released under the GNU General Public License (TODO: add link).
3153 Parts of QEMU have specific licenses, see file LICENSE.
3155 TODO (refer to file LICENSE, include it, include the GPL?)
3157 @node Index
3158 @appendix Index
3159 @menu
3160 * Concept Index::
3161 * Function Index::
3162 * Keystroke Index::
3163 * Program Index::
3164 * Data Type Index::
3165 * Variable Index::
3166 @end menu
3168 @node Concept Index
3169 @section Concept Index
3170 This is the main index. Should we combine all keywords in one index? TODO
3171 @printindex cp
3173 @node Function Index
3174 @section Function Index
3175 This index could be used for command line options and monitor functions.
3176 @printindex fn
3178 @node Keystroke Index
3179 @section Keystroke Index
3181 This is a list of all keystrokes which have a special function
3182 in system emulation.
3184 @printindex ky
3186 @node Program Index
3187 @section Program Index
3188 @printindex pg
3190 @node Data Type Index
3191 @section Data Type Index
3193 This index could be used for qdev device names and options.
3195 @printindex tp
3197 @node Variable Index
3198 @section Variable Index
3199 @printindex vr
3201 @bye