Fix compilation (missing API fix in last merge)
[qemu/ar7.git] / qemu-doc.texi
blob9013713c67bbc53d70e7f25cc918f09b4b6fd5a9
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
148 @cindex installation (Mac OS X)
150 Download the experimental binary installer at
151 @url{http://www.free.oszoo.org/@/download.html}.
152 TODO (no longer available)
154 @node QEMU PC System emulator
155 @chapter QEMU PC System emulator
156 @cindex system emulation (PC)
158 @menu
159 * pcsys_introduction:: Introduction
160 * pcsys_quickstart::   Quick Start
161 * sec_invocation::     Invocation
162 * pcsys_keys::         Keys
163 * pcsys_monitor::      QEMU Monitor
164 * disk_images::        Disk Images
165 * pcsys_network::      Network emulation
166 * pcsys_other_devs::   Other Devices
167 * direct_linux_boot::  Direct Linux Boot
168 * pcsys_usb::          USB emulation
169 * vnc_security::       VNC security
170 * gdb_usage::          GDB usage
171 * pcsys_os_specific::  Target OS specific information
172 @end menu
174 @node pcsys_introduction
175 @section Introduction
177 @c man begin DESCRIPTION
179 The QEMU PC System emulator simulates the
180 following peripherals:
182 @itemize @minus
183 @item
184 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
185 @item
186 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
187 extensions (hardware level, including all non standard modes).
188 @item
189 PS/2 mouse and keyboard
190 @item
191 2 PCI IDE interfaces with hard disk and CD-ROM support
192 @item
193 Floppy disk
194 @item
195 PCI and ISA network adapters
196 @item
197 Serial ports
198 @item
199 Creative SoundBlaster 16 sound card
200 @item
201 ENSONIQ AudioPCI ES1370 sound card
202 @item
203 Intel 82801AA AC97 Audio compatible sound card
204 @item
205 Intel HD Audio Controller and HDA codec
206 @item
207 Adlib (OPL2) - Yamaha YM3812 compatible chip
208 @item
209 Gravis Ultrasound GF1 sound card
210 @item
211 CS4231A compatible sound card
212 @item
213 PCI UHCI USB controller and a virtual USB hub.
214 @end itemize
216 SMP is supported with up to 255 CPUs.
218 QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL
219 VGA BIOS.
221 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
223 QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
224 by Tibor "TS" Schütz.
226 Note that, by default, GUS shares IRQ(7) with parallel ports and so
227 QEMU must be told to not have parallel ports to have working GUS.
229 @example
230 qemu-system-i386 dos.img -soundhw gus -parallel none
231 @end example
233 Alternatively:
234 @example
235 qemu-system-i386 dos.img -device gus,irq=5
236 @end example
238 Or some other unclaimed IRQ.
240 CS4231A is the chip used in Windows Sound System and GUSMAX products
242 @c man end
244 @node pcsys_quickstart
245 @section Quick Start
246 @cindex quick start
248 Download and uncompress the linux image (@file{linux.img}) and type:
250 @example
251 qemu-system-i386 linux.img
252 @end example
254 Linux should boot and give you a prompt.
256 @node sec_invocation
257 @section Invocation
259 @example
260 @c man begin SYNOPSIS
261 usage: qemu-system-i386 [options] [@var{disk_image}]
262 @c man end
263 @end example
265 @c man begin OPTIONS
266 @var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
267 targets do not need a disk image.
269 @include qemu-options.texi
271 @c man end
273 @node pcsys_keys
274 @section Keys
276 @c man begin OPTIONS
278 During the graphical emulation, you can use special key combinations to change
279 modes. The default key mappings are shown below, but if you use @code{-alt-grab}
280 then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use
281 @code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt):
283 @table @key
284 @item Ctrl-Alt-f
285 @kindex Ctrl-Alt-f
286 Toggle full screen
288 @item Ctrl-Alt-+
289 @kindex Ctrl-Alt-+
290 Enlarge the screen
292 @item Ctrl-Alt--
293 @kindex Ctrl-Alt--
294 Shrink the screen
296 @item Ctrl-Alt-u
297 @kindex Ctrl-Alt-u
298 Restore the screen's un-scaled dimensions
300 @item Ctrl-Alt-n
301 @kindex Ctrl-Alt-n
302 Switch to virtual console 'n'. Standard console mappings are:
303 @table @emph
304 @item 1
305 Target system display
306 @item 2
307 Monitor
308 @item 3
309 Serial port
310 @end table
312 @item Ctrl-Alt
313 @kindex Ctrl-Alt
314 Toggle mouse and keyboard grab.
315 @end table
317 @kindex Ctrl-Up
318 @kindex Ctrl-Down
319 @kindex Ctrl-PageUp
320 @kindex Ctrl-PageDown
321 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
322 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
324 @kindex Ctrl-a h
325 During emulation, if you are using the @option{-nographic} option, use
326 @key{Ctrl-a h} to get terminal commands:
328 @table @key
329 @item Ctrl-a h
330 @kindex Ctrl-a h
331 @item Ctrl-a ?
332 @kindex Ctrl-a ?
333 Print this help
334 @item Ctrl-a x
335 @kindex Ctrl-a x
336 Exit emulator
337 @item Ctrl-a s
338 @kindex Ctrl-a s
339 Save disk data back to file (if -snapshot)
340 @item Ctrl-a t
341 @kindex Ctrl-a t
342 Toggle console timestamps
343 @item Ctrl-a b
344 @kindex Ctrl-a b
345 Send break (magic sysrq in Linux)
346 @item Ctrl-a c
347 @kindex Ctrl-a c
348 Switch between console and monitor
349 @item Ctrl-a Ctrl-a
350 @kindex Ctrl-a a
351 Send Ctrl-a
352 @end table
353 @c man end
355 @ignore
357 @c man begin SEEALSO
358 The HTML documentation of QEMU for more precise information and Linux
359 user mode emulator invocation.
360 @c man end
362 @c man begin AUTHOR
363 Fabrice Bellard
364 @c man end
366 @end ignore
368 @node pcsys_monitor
369 @section QEMU Monitor
370 @cindex QEMU monitor
372 The QEMU monitor is used to give complex commands to the QEMU
373 emulator. You can use it to:
375 @itemize @minus
377 @item
378 Remove or insert removable media images
379 (such as CD-ROM or floppies).
381 @item
382 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
383 from a disk file.
385 @item Inspect the VM state without an external debugger.
387 @end itemize
389 @subsection Commands
391 The following commands are available:
393 @include qemu-monitor.texi
395 @subsection Integer expressions
397 The monitor understands integers expressions for every integer
398 argument. You can use register names to get the value of specifics
399 CPU registers by prefixing them with @emph{$}.
401 @node disk_images
402 @section Disk Images
404 Since version 0.6.1, QEMU supports many disk image formats, including
405 growable disk images (their size increase as non empty sectors are
406 written), compressed and encrypted disk images. Version 0.8.3 added
407 the new qcow2 disk image format which is essential to support VM
408 snapshots.
410 @menu
411 * disk_images_quickstart::    Quick start for disk image creation
412 * disk_images_snapshot_mode:: Snapshot mode
413 * vm_snapshots::              VM snapshots
414 * qemu_img_invocation::       qemu-img Invocation
415 * qemu_nbd_invocation::       qemu-nbd Invocation
416 * disk_images_formats::       Disk image file formats
417 * host_drives::               Using host drives
418 * disk_images_fat_images::    Virtual FAT disk images
419 * disk_images_nbd::           NBD access
420 * disk_images_sheepdog::      Sheepdog disk images
421 * disk_images_iscsi::         iSCSI LUNs
422 * disk_images_gluster::       GlusterFS disk images
423 * disk_images_ssh::           Secure Shell (ssh) disk images
424 @end menu
426 @node disk_images_quickstart
427 @subsection Quick start for disk image creation
429 You can create a disk image with the command:
430 @example
431 qemu-img create myimage.img mysize
432 @end example
433 where @var{myimage.img} is the disk image filename and @var{mysize} is its
434 size in kilobytes. You can add an @code{M} suffix to give the size in
435 megabytes and a @code{G} suffix for gigabytes.
437 See @ref{qemu_img_invocation} for more information.
439 @node disk_images_snapshot_mode
440 @subsection Snapshot mode
442 If you use the option @option{-snapshot}, all disk images are
443 considered as read only. When sectors in written, they are written in
444 a temporary file created in @file{/tmp}. You can however force the
445 write back to the raw disk images by using the @code{commit} monitor
446 command (or @key{C-a s} in the serial console).
448 @node vm_snapshots
449 @subsection VM snapshots
451 VM snapshots are snapshots of the complete virtual machine including
452 CPU state, RAM, device state and the content of all the writable
453 disks. In order to use VM snapshots, you must have at least one non
454 removable and writable block device using the @code{qcow2} disk image
455 format. Normally this device is the first virtual hard drive.
457 Use the monitor command @code{savevm} to create a new VM snapshot or
458 replace an existing one. A human readable name can be assigned to each
459 snapshot in addition to its numerical ID.
461 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
462 a VM snapshot. @code{info snapshots} lists the available snapshots
463 with their associated information:
465 @example
466 (qemu) info snapshots
467 Snapshot devices: hda
468 Snapshot list (from hda):
469 ID        TAG                 VM SIZE                DATE       VM CLOCK
470 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
471 2                                 40M 2006-08-06 12:43:29   00:00:18.633
472 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
473 @end example
475 A VM snapshot is made of a VM state info (its size is shown in
476 @code{info snapshots}) and a snapshot of every writable disk image.
477 The VM state info is stored in the first @code{qcow2} non removable
478 and writable block device. The disk image snapshots are stored in
479 every disk image. The size of a snapshot in a disk image is difficult
480 to evaluate and is not shown by @code{info snapshots} because the
481 associated disk sectors are shared among all the snapshots to save
482 disk space (otherwise each snapshot would need a full copy of all the
483 disk images).
485 When using the (unrelated) @code{-snapshot} option
486 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
487 but they are deleted as soon as you exit QEMU.
489 VM snapshots currently have the following known limitations:
490 @itemize
491 @item
492 They cannot cope with removable devices if they are removed or
493 inserted after a snapshot is done.
494 @item
495 A few device drivers still have incomplete snapshot support so their
496 state is not saved or restored properly (in particular USB).
497 @end itemize
499 @node qemu_img_invocation
500 @subsection @code{qemu-img} Invocation
502 @include qemu-img.texi
504 @node qemu_nbd_invocation
505 @subsection @code{qemu-nbd} Invocation
507 @include qemu-nbd.texi
509 @node disk_images_formats
510 @subsection Disk image file formats
512 QEMU supports many image file formats that can be used with VMs as well as with
513 any of the tools (like @code{qemu-img}). This includes the preferred formats
514 raw and qcow2 as well as formats that are supported for compatibility with
515 older QEMU versions or other hypervisors.
517 Depending on the image format, different options can be passed to
518 @code{qemu-img create} and @code{qemu-img convert} using the @code{-o} option.
519 This section describes each format and the options that are supported for it.
521 @table @option
522 @item raw
524 Raw disk image format. This format has the advantage of
525 being simple and easily exportable to all other emulators. If your
526 file system supports @emph{holes} (for example in ext2 or ext3 on
527 Linux or NTFS on Windows), then only the written sectors will reserve
528 space. Use @code{qemu-img info} to know the real size used by the
529 image or @code{ls -ls} on Unix/Linux.
531 Supported options:
532 @table @code
533 @item preallocation
534 Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
535 @code{falloc} mode preallocates space for image by calling posix_fallocate().
536 @code{full} mode preallocates space for image by writing zeros to underlying
537 storage.
538 @end table
540 @item qcow2
541 QEMU image format, the most versatile format. Use it to have smaller
542 images (useful if your filesystem does not supports holes, for example
543 on Windows), optional AES encryption, zlib based compression and
544 support of multiple VM snapshots.
546 Supported options:
547 @table @code
548 @item compat
549 Determines the qcow2 version to use. @code{compat=0.10} uses the
550 traditional image format that can be read by any QEMU since 0.10.
551 @code{compat=1.1} enables image format extensions that only QEMU 1.1 and
552 newer understand (this is the default). Amongst others, this includes
553 zero clusters, which allow efficient copy-on-read for sparse images.
555 @item backing_file
556 File name of a base image (see @option{create} subcommand)
557 @item backing_fmt
558 Image format of the base image
559 @item encryption
560 If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
562 The use of encryption in qcow and qcow2 images is considered to be flawed by
563 modern cryptography standards, suffering from a number of design problems:
565 @itemize @minus
566 @item The AES-CBC cipher is used with predictable initialization vectors based
567 on the sector number. This makes it vulnerable to chosen plaintext attacks
568 which can reveal the existence of encrypted data.
569 @item The user passphrase is directly used as the encryption key. A poorly
570 chosen or short passphrase will compromise the security of the encryption.
571 @item In the event of the passphrase being compromised there is no way to
572 change the passphrase to protect data in any qcow images. The files must
573 be cloned, using a different encryption passphrase in the new file. The
574 original file must then be securely erased using a program like shred,
575 though even this is ineffective with many modern storage technologies.
576 @end itemize
578 Use of qcow / qcow2 encryption is thus strongly discouraged. Users are
579 recommended to use an alternative encryption technology such as the
580 Linux dm-crypt / LUKS system.
582 @item cluster_size
583 Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
584 sizes can improve the image file size whereas larger cluster sizes generally
585 provide better performance.
587 @item preallocation
588 Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
589 @code{full}). An image with preallocated metadata is initially larger but can
590 improve performance when the image needs to grow. @code{falloc} and @code{full}
591 preallocations are like the same options of @code{raw} format, but sets up
592 metadata also.
594 @item lazy_refcounts
595 If this option is set to @code{on}, reference count updates are postponed with
596 the goal of avoiding metadata I/O and improving performance. This is
597 particularly interesting with @option{cache=writethrough} which doesn't batch
598 metadata updates. The tradeoff is that after a host crash, the reference count
599 tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
600 check -r all} is required, which may take some time.
602 This option can only be enabled if @code{compat=1.1} is specified.
604 @item nocow
605 If this option is set to @code{on}, it will turn off COW of the file. It's only
606 valid on btrfs, no effect on other file systems.
608 Btrfs has low performance when hosting a VM image file, even more when the guest
609 on the VM also using btrfs as file system. Turning off COW is a way to mitigate
610 this bad performance. Generally there are two ways to turn off COW on btrfs:
611 a) Disable it by mounting with nodatacow, then all newly created files will be
612 NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
613 does.
615 Note: this option is only valid to new or empty files. If there is an existing
616 file which is COW and has data blocks already, it couldn't be changed to NOCOW
617 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
618 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
620 @end table
622 @item qed
623 Old QEMU image format with support for backing files and compact image files
624 (when your filesystem or transport medium does not support holes).
626 When converting QED images to qcow2, you might want to consider using the
627 @code{lazy_refcounts=on} option to get a more QED-like behaviour.
629 Supported options:
630 @table @code
631 @item backing_file
632 File name of a base image (see @option{create} subcommand).
633 @item backing_fmt
634 Image file format of backing file (optional).  Useful if the format cannot be
635 autodetected because it has no header, like some vhd/vpc files.
636 @item cluster_size
637 Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller
638 cluster sizes can improve the image file size whereas larger cluster sizes
639 generally provide better performance.
640 @item table_size
641 Changes the number of clusters per L1/L2 table (must be power-of-2 between 1
642 and 16).  There is normally no need to change this value but this option can be
643 used for performance benchmarking.
644 @end table
646 @item qcow
647 Old QEMU image format with support for backing files, compact image files,
648 encryption and compression.
650 Supported options:
651 @table @code
652 @item backing_file
653 File name of a base image (see @option{create} subcommand)
654 @item encryption
655 If this option is set to @code{on}, the image is encrypted.
656 @end table
658 @item vdi
659 VirtualBox 1.1 compatible image format.
660 Supported options:
661 @table @code
662 @item static
663 If this option is set to @code{on}, the image is created with metadata
664 preallocation.
665 @end table
667 @item vmdk
668 VMware 3 and 4 compatible image format.
670 Supported options:
671 @table @code
672 @item backing_file
673 File name of a base image (see @option{create} subcommand).
674 @item compat6
675 Create a VMDK version 6 image (instead of version 4)
676 @item subformat
677 Specifies which VMDK subformat to use. Valid options are
678 @code{monolithicSparse} (default),
679 @code{monolithicFlat},
680 @code{twoGbMaxExtentSparse},
681 @code{twoGbMaxExtentFlat} and
682 @code{streamOptimized}.
683 @end table
685 @item vpc
686 VirtualPC compatible image format (VHD).
687 Supported options:
688 @table @code
689 @item subformat
690 Specifies which VHD subformat to use. Valid options are
691 @code{dynamic} (default) and @code{fixed}.
692 @end table
694 @item VHDX
695 Hyper-V compatible image format (VHDX).
696 Supported options:
697 @table @code
698 @item subformat
699 Specifies which VHDX subformat to use. Valid options are
700 @code{dynamic} (default) and @code{fixed}.
701 @item block_state_zero
702 Force use of payload blocks of type 'ZERO'.
703 @item block_size
704 Block size; min 1 MB, max 256 MB.  0 means auto-calculate based on image size.
705 @item log_size
706 Log size; min 1 MB.
707 @end table
708 @end table
710 @subsubsection Read-only formats
711 More disk image file formats are supported in a read-only mode.
712 @table @option
713 @item bochs
714 Bochs images of @code{growing} type.
715 @item cloop
716 Linux Compressed Loop image, useful only to reuse directly compressed
717 CD-ROM images present for example in the Knoppix CD-ROMs.
718 @item dmg
719 Apple disk image.
720 @item parallels
721 Parallels disk image format.
722 @end table
725 @node host_drives
726 @subsection Using host drives
728 In addition to disk image files, QEMU can directly access host
729 devices. We describe here the usage for QEMU version >= 0.8.3.
731 @subsubsection Linux
733 On Linux, you can directly use the host device filename instead of a
734 disk image filename provided you have enough privileges to access
735 it. For example, use @file{/dev/cdrom} to access to the CDROM or
736 @file{/dev/fd0} for the floppy.
738 @table @code
739 @item CD
740 You can specify a CDROM device even if no CDROM is loaded. QEMU has
741 specific code to detect CDROM insertion or removal. CDROM ejection by
742 the guest OS is supported. Currently only data CDs are supported.
743 @item Floppy
744 You can specify a floppy device even if no floppy is loaded. Floppy
745 removal is currently not detected accurately (if you change floppy
746 without doing floppy access while the floppy is not loaded, the guest
747 OS will think that the same floppy is loaded).
748 @item Hard disks
749 Hard disks can be used. Normally you must specify the whole disk
750 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
751 see it as a partitioned disk. WARNING: unless you know what you do, it
752 is better to only make READ-ONLY accesses to the hard disk otherwise
753 you may corrupt your host data (use the @option{-snapshot} command
754 line option or modify the device permissions accordingly).
755 @end table
757 @subsubsection Windows
759 @table @code
760 @item CD
761 The preferred syntax is the drive letter (e.g. @file{d:}). The
762 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
763 supported as an alias to the first CDROM drive.
765 Currently there is no specific code to handle removable media, so it
766 is better to use the @code{change} or @code{eject} monitor commands to
767 change or eject media.
768 @item Hard disks
769 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
770 where @var{N} is the drive number (0 is the first hard disk).
771 @file{/dev/hda} is supported as an alias to
772 the first hard disk drive @file{\\.\PhysicalDrive0}.
774 WARNING: unless you know what you do, it is better to only make
775 READ-ONLY accesses to the hard disk otherwise you may corrupt your
776 host data (use the @option{-snapshot} command line so that the
777 modifications are written in a temporary file).
778 @end table
781 @subsubsection Mac OS X
783 @file{/dev/cdrom} is an alias to the first CDROM.
785 Currently there is no specific code to handle removable media, so it
786 is better to use the @code{change} or @code{eject} monitor commands to
787 change or eject media.
789 @node disk_images_fat_images
790 @subsection Virtual FAT disk images
792 QEMU can automatically create a virtual FAT disk image from a
793 directory tree. In order to use it, just type:
795 @example
796 qemu-system-i386 linux.img -hdb fat:/my_directory
797 @end example
799 Then you access access to all the files in the @file{/my_directory}
800 directory without having to copy them in a disk image or to export
801 them via SAMBA or NFS. The default access is @emph{read-only}.
803 Floppies can be emulated with the @code{:floppy:} option:
805 @example
806 qemu-system-i386 linux.img -fda fat:floppy:/my_directory
807 @end example
809 A read/write support is available for testing (beta stage) with the
810 @code{:rw:} option:
812 @example
813 qemu-system-i386 linux.img -fda fat:floppy:rw:/my_directory
814 @end example
816 What you should @emph{never} do:
817 @itemize
818 @item use non-ASCII filenames ;
819 @item use "-snapshot" together with ":rw:" ;
820 @item expect it to work when loadvm'ing ;
821 @item write to the FAT directory on the host system while accessing it with the guest system.
822 @end itemize
824 @node disk_images_nbd
825 @subsection NBD access
827 QEMU can access directly to block device exported using the Network Block Device
828 protocol.
830 @example
831 qemu-system-i386 linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/
832 @end example
834 If the NBD server is located on the same host, you can use an unix socket instead
835 of an inet socket:
837 @example
838 qemu-system-i386 linux.img -hdb nbd+unix://?socket=/tmp/my_socket
839 @end example
841 In this case, the block device must be exported using qemu-nbd:
843 @example
844 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
845 @end example
847 The use of qemu-nbd allows sharing of a disk between several guests:
848 @example
849 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
850 @end example
852 @noindent
853 and then you can use it with two guests:
854 @example
855 qemu-system-i386 linux1.img -hdb nbd+unix://?socket=/tmp/my_socket
856 qemu-system-i386 linux2.img -hdb nbd+unix://?socket=/tmp/my_socket
857 @end example
859 If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's
860 own embedded NBD server), you must specify an export name in the URI:
861 @example
862 qemu-system-i386 -cdrom nbd://localhost/debian-500-ppc-netinst
863 qemu-system-i386 -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst
864 @end example
866 The URI syntax for NBD is supported since QEMU 1.3.  An alternative syntax is
867 also available.  Here are some example of the older syntax:
868 @example
869 qemu-system-i386 linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
870 qemu-system-i386 linux2.img -hdb nbd:unix:/tmp/my_socket
871 qemu-system-i386 -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst
872 @end example
874 @node disk_images_sheepdog
875 @subsection Sheepdog disk images
877 Sheepdog is a distributed storage system for QEMU.  It provides highly
878 available block level storage volumes that can be attached to
879 QEMU-based virtual machines.
881 You can create a Sheepdog disk image with the command:
882 @example
883 qemu-img create sheepdog:///@var{image} @var{size}
884 @end example
885 where @var{image} is the Sheepdog image name and @var{size} is its
886 size.
888 To import the existing @var{filename} to Sheepdog, you can use a
889 convert command.
890 @example
891 qemu-img convert @var{filename} sheepdog:///@var{image}
892 @end example
894 You can boot from the Sheepdog disk image with the command:
895 @example
896 qemu-system-i386 sheepdog:///@var{image}
897 @end example
899 You can also create a snapshot of the Sheepdog image like qcow2.
900 @example
901 qemu-img snapshot -c @var{tag} sheepdog:///@var{image}
902 @end example
903 where @var{tag} is a tag name of the newly created snapshot.
905 To boot from the Sheepdog snapshot, specify the tag name of the
906 snapshot.
907 @example
908 qemu-system-i386 sheepdog:///@var{image}#@var{tag}
909 @end example
911 You can create a cloned image from the existing snapshot.
912 @example
913 qemu-img create -b sheepdog:///@var{base}#@var{tag} sheepdog:///@var{image}
914 @end example
915 where @var{base} is a image name of the source snapshot and @var{tag}
916 is its tag name.
918 You can use an unix socket instead of an inet socket:
920 @example
921 qemu-system-i386 sheepdog+unix:///@var{image}?socket=@var{path}
922 @end example
924 If the Sheepdog daemon doesn't run on the local host, you need to
925 specify one of the Sheepdog servers to connect to.
926 @example
927 qemu-img create sheepdog://@var{hostname}:@var{port}/@var{image} @var{size}
928 qemu-system-i386 sheepdog://@var{hostname}:@var{port}/@var{image}
929 @end example
931 @node disk_images_iscsi
932 @subsection iSCSI LUNs
934 iSCSI is a popular protocol used to access SCSI devices across a computer
935 network.
937 There are two different ways iSCSI devices can be used by QEMU.
939 The first method is to mount the iSCSI LUN on the host, and make it appear as
940 any other ordinary SCSI device on the host and then to access this device as a
941 /dev/sd device from QEMU. How to do this differs between host OSes.
943 The second method involves using the iSCSI initiator that is built into
944 QEMU. This provides a mechanism that works the same way regardless of which
945 host OS you are running QEMU on. This section will describe this second method
946 of using iSCSI together with QEMU.
948 In QEMU, iSCSI devices are described using special iSCSI URLs
950 @example
951 URL syntax:
952 iscsi://[<username>[%<password>]@@]<host>[:<port>]/<target-iqn-name>/<lun>
953 @end example
955 Username and password are optional and only used if your target is set up
956 using CHAP authentication for access control.
957 Alternatively the username and password can also be set via environment
958 variables to have these not show up in the process list
960 @example
961 export LIBISCSI_CHAP_USERNAME=<username>
962 export LIBISCSI_CHAP_PASSWORD=<password>
963 iscsi://<host>/<target-iqn-name>/<lun>
964 @end example
966 Various session related parameters can be set via special options, either
967 in a configuration file provided via '-readconfig' or directly on the
968 command line.
970 If the initiator-name is not specified qemu will use a default name
971 of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
972 virtual machine.
975 @example
976 Setting a specific initiator name to use when logging in to the target
977 -iscsi initiator-name=iqn.qemu.test:my-initiator
978 @end example
980 @example
981 Controlling which type of header digest to negotiate with the target
982 -iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
983 @end example
985 These can also be set via a configuration file
986 @example
987 [iscsi]
988   user = "CHAP username"
989   password = "CHAP password"
990   initiator-name = "iqn.qemu.test:my-initiator"
991   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
992   header-digest = "CRC32C"
993 @end example
996 Setting the target name allows different options for different targets
997 @example
998 [iscsi "iqn.target.name"]
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 Howto use a configuration file to set iSCSI configuration options:
1008 @example
1009 cat >iscsi.conf <<EOF
1010 [iscsi]
1011   user = "me"
1012   password = "my password"
1013   initiator-name = "iqn.qemu.test:my-initiator"
1014   header-digest = "CRC32C"
1017 qemu-system-i386 -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1018     -readconfig iscsi.conf
1019 @end example
1022 Howto set up a simple iSCSI target on loopback and accessing it via QEMU:
1023 @example
1024 This example shows how to set up an iSCSI target with one CDROM and one DISK
1025 using the Linux STGT software target. This target is available on Red Hat based
1026 systems as the package 'scsi-target-utils'.
1028 tgtd --iscsi portal=127.0.0.1:3260
1029 tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
1030 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \
1031     -b /IMAGES/disk.img --device-type=disk
1032 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \
1033     -b /IMAGES/cd.iso --device-type=cd
1034 tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
1036 qemu-system-i386 -iscsi initiator-name=iqn.qemu.test:my-initiator \
1037     -boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1038     -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
1039 @end example
1041 @node disk_images_gluster
1042 @subsection GlusterFS disk images
1044 GlusterFS is an user space distributed file system.
1046 You can boot from the GlusterFS disk image with the command:
1047 @example
1048 qemu-system-x86_64 -drive file=gluster[+@var{transport}]://[@var{server}[:@var{port}]]/@var{volname}/@var{image}[?socket=...]
1049 @end example
1051 @var{gluster} is the protocol.
1053 @var{transport} specifies the transport type used to connect to gluster
1054 management daemon (glusterd). Valid transport types are
1055 tcp, unix and rdma. If a transport type isn't specified, then tcp
1056 type is assumed.
1058 @var{server} specifies the server where the volume file specification for
1059 the given volume resides. This can be either hostname, ipv4 address
1060 or ipv6 address. ipv6 address needs to be within square brackets [ ].
1061 If transport type is unix, then @var{server} field should not be specifed.
1062 Instead @var{socket} field needs to be populated with the path to unix domain
1063 socket.
1065 @var{port} is the port number on which glusterd is listening. This is optional
1066 and if not specified, QEMU will send 0 which will make gluster to use the
1067 default port. If the transport type is unix, then @var{port} should not be
1068 specified.
1070 @var{volname} is the name of the gluster volume which contains the disk image.
1072 @var{image} is the path to the actual disk image that resides on gluster volume.
1074 You can create a GlusterFS disk image with the command:
1075 @example
1076 qemu-img create gluster://@var{server}/@var{volname}/@var{image} @var{size}
1077 @end example
1079 Examples
1080 @example
1081 qemu-system-x86_64 -drive file=gluster://1.2.3.4/testvol/a.img
1082 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4/testvol/a.img
1083 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
1084 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
1085 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
1086 qemu-system-x86_64 -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
1087 qemu-system-x86_64 -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
1088 qemu-system-x86_64 -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
1089 @end example
1091 @node disk_images_ssh
1092 @subsection Secure Shell (ssh) disk images
1094 You can access disk images located on a remote ssh server
1095 by using the ssh protocol:
1097 @example
1098 qemu-system-x86_64 -drive file=ssh://[@var{user}@@]@var{server}[:@var{port}]/@var{path}[?host_key_check=@var{host_key_check}]
1099 @end example
1101 Alternative syntax using properties:
1103 @example
1104 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}]
1105 @end example
1107 @var{ssh} is the protocol.
1109 @var{user} is the remote user.  If not specified, then the local
1110 username is tried.
1112 @var{server} specifies the remote ssh server.  Any ssh server can be
1113 used, but it must implement the sftp-server protocol.  Most Unix/Linux
1114 systems should work without requiring any extra configuration.
1116 @var{port} is the port number on which sshd is listening.  By default
1117 the standard ssh port (22) is used.
1119 @var{path} is the path to the disk image.
1121 The optional @var{host_key_check} parameter controls how the remote
1122 host's key is checked.  The default is @code{yes} which means to use
1123 the local @file{.ssh/known_hosts} file.  Setting this to @code{no}
1124 turns off known-hosts checking.  Or you can check that the host key
1125 matches a specific fingerprint:
1126 @code{host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8}
1127 (@code{sha1:} can also be used as a prefix, but note that OpenSSH
1128 tools only use MD5 to print fingerprints).
1130 Currently authentication must be done using ssh-agent.  Other
1131 authentication methods may be supported in future.
1133 Note: Many ssh servers do not support an @code{fsync}-style operation.
1134 The ssh driver cannot guarantee that disk flush requests are
1135 obeyed, and this causes a risk of disk corruption if the remote
1136 server or network goes down during writes.  The driver will
1137 print a warning when @code{fsync} is not supported:
1139 warning: ssh server @code{ssh.example.com:22} does not support fsync
1141 With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is
1142 supported.
1144 @node pcsys_network
1145 @section Network emulation
1147 QEMU can simulate several network cards (PCI or ISA cards on the PC
1148 target) and can connect them to an arbitrary number of Virtual Local
1149 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1150 VLAN. VLAN can be connected between separate instances of QEMU to
1151 simulate large networks. For simpler usage, a non privileged user mode
1152 network stack can replace the TAP device to have a basic network
1153 connection.
1155 @subsection VLANs
1157 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1158 connection between several network devices. These devices can be for
1159 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1160 (TAP devices).
1162 @subsection Using TAP network interfaces
1164 This is the standard way to connect QEMU to a real network. QEMU adds
1165 a virtual network device on your host (called @code{tapN}), and you
1166 can then configure it as if it was a real ethernet card.
1168 @subsubsection Linux host
1170 As an example, you can download the @file{linux-test-xxx.tar.gz}
1171 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1172 configure properly @code{sudo} so that the command @code{ifconfig}
1173 contained in @file{qemu-ifup} can be executed as root. You must verify
1174 that your host kernel supports the TAP network interfaces: the
1175 device @file{/dev/net/tun} must be present.
1177 See @ref{sec_invocation} to have examples of command lines using the
1178 TAP network interfaces.
1180 @subsubsection Windows host
1182 There is a virtual ethernet driver for Windows 2000/XP systems, called
1183 TAP-Win32. But it is not included in standard QEMU for Windows,
1184 so you will need to get it separately. It is part of OpenVPN package,
1185 so download OpenVPN from : @url{http://openvpn.net/}.
1187 @subsection Using the user mode network stack
1189 By using the option @option{-net user} (default configuration if no
1190 @option{-net} option is specified), QEMU uses a completely user mode
1191 network stack (you don't need root privilege to use the virtual
1192 network). The virtual network configuration is the following:
1194 @example
1196          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1197                            |          (10.0.2.2)
1198                            |
1199                            ---->  DNS server (10.0.2.3)
1200                            |
1201                            ---->  SMB server (10.0.2.4)
1202 @end example
1204 The QEMU VM behaves as if it was behind a firewall which blocks all
1205 incoming connections. You can use a DHCP client to automatically
1206 configure the network in the QEMU VM. The DHCP server assign addresses
1207 to the hosts starting from 10.0.2.15.
1209 In order to check that the user mode network is working, you can ping
1210 the address 10.0.2.2 and verify that you got an address in the range
1211 10.0.2.x from the QEMU virtual DHCP server.
1213 Note that ICMP traffic in general does not work with user mode networking.
1214 @code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work,
1215 however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP
1216 ping sockets to allow @code{ping} to the Internet. The host admin has to set
1217 the ping_group_range in order to grant access to those sockets. To allow ping
1218 for GID 100 (usually users group):
1220 @example
1221 echo 100 100 > /proc/sys/net/ipv4/ping_group_range
1222 @end example
1224 When using the built-in TFTP server, the router is also the TFTP
1225 server.
1227 When using the @option{-redir} option, TCP or UDP connections can be
1228 redirected from the host to the guest. It allows for example to
1229 redirect X11, telnet or SSH connections.
1231 @subsection Connecting VLANs between QEMU instances
1233 Using the @option{-net socket} option, it is possible to make VLANs
1234 that span several QEMU instances. See @ref{sec_invocation} to have a
1235 basic example.
1237 @node pcsys_other_devs
1238 @section Other Devices
1240 @subsection Inter-VM Shared Memory device
1242 With KVM enabled on a Linux host, a shared memory device is available.  Guests
1243 map a POSIX shared memory region into the guest as a PCI device that enables
1244 zero-copy communication to the application level of the guests.  The basic
1245 syntax is:
1247 @example
1248 qemu-system-i386 -device ivshmem,size=<size in format accepted by -m>[,shm=<shm name>]
1249 @end example
1251 If desired, interrupts can be sent between guest VMs accessing the same shared
1252 memory region.  Interrupt support requires using a shared memory server and
1253 using a chardev socket to connect to it.  The code for the shared memory server
1254 is qemu.git/contrib/ivshmem-server.  An example syntax when using the shared
1255 memory server is:
1257 @example
1258 qemu-system-i386 -device ivshmem,size=<size in format accepted by -m>[,chardev=<id>]
1259                  [,msi=on][,ioeventfd=on][,vectors=n][,role=peer|master]
1260 qemu-system-i386 -chardev socket,path=<path>,id=<id>
1261 @end example
1263 When using the server, the guest will be assigned a VM ID (>=0) that allows guests
1264 using the same server to communicate via interrupts.  Guests can read their
1265 VM ID from a device register (see example code).  Since receiving the shared
1266 memory region from the server is asynchronous, there is a (small) chance the
1267 guest may boot before the shared memory is attached.  To allow an application
1268 to ensure shared memory is attached, the VM ID register will return -1 (an
1269 invalid VM ID) until the memory is attached.  Once the shared memory is
1270 attached, the VM ID will return the guest's valid VM ID.  With these semantics,
1271 the guest application can check to ensure the shared memory is attached to the
1272 guest before proceeding.
1274 The @option{role} argument can be set to either master or peer and will affect
1275 how the shared memory is migrated.  With @option{role=master}, the guest will
1276 copy the shared memory on migration to the destination host.  With
1277 @option{role=peer}, the guest will not be able to migrate with the device attached.
1278 With the @option{peer} case, the device should be detached and then reattached
1279 after migration using the PCI hotplug support.
1281 @node direct_linux_boot
1282 @section Direct Linux Boot
1284 This section explains how to launch a Linux kernel inside QEMU without
1285 having to make a full bootable image. It is very useful for fast Linux
1286 kernel testing.
1288 The syntax is:
1289 @example
1290 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1291 @end example
1293 Use @option{-kernel} to provide the Linux kernel image and
1294 @option{-append} to give the kernel command line arguments. The
1295 @option{-initrd} option can be used to provide an INITRD image.
1297 When using the direct Linux boot, a disk image for the first hard disk
1298 @file{hda} is required because its boot sector is used to launch the
1299 Linux kernel.
1301 If you do not need graphical output, you can disable it and redirect
1302 the virtual serial port and the QEMU monitor to the console with the
1303 @option{-nographic} option. The typical command line is:
1304 @example
1305 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1306                  -append "root=/dev/hda console=ttyS0" -nographic
1307 @end example
1309 Use @key{Ctrl-a c} to switch between the serial console and the
1310 monitor (@pxref{pcsys_keys}).
1312 @node pcsys_usb
1313 @section USB emulation
1315 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1316 virtual USB devices or real host USB devices (experimental, works only
1317 on Linux hosts).  QEMU will automatically create and connect virtual USB hubs
1318 as necessary to connect multiple USB devices.
1320 @menu
1321 * usb_devices::
1322 * host_usb_devices::
1323 @end menu
1324 @node usb_devices
1325 @subsection Connecting USB devices
1327 USB devices can be connected with the @option{-usbdevice} commandline option
1328 or the @code{usb_add} monitor command.  Available devices are:
1330 @table @code
1331 @item mouse
1332 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1333 @item tablet
1334 Pointer device that uses absolute coordinates (like a touchscreen).
1335 This means QEMU is able to report the mouse position without having
1336 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1337 @item disk:@var{file}
1338 Mass storage device based on @var{file} (@pxref{disk_images})
1339 @item host:@var{bus.addr}
1340 Pass through the host device identified by @var{bus.addr}
1341 (Linux only)
1342 @item host:@var{vendor_id:product_id}
1343 Pass through the host device identified by @var{vendor_id:product_id}
1344 (Linux only)
1345 @item wacom-tablet
1346 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
1347 above but it can be used with the tslib library because in addition to touch
1348 coordinates it reports touch pressure.
1349 @item keyboard
1350 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1351 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1352 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1353 device @var{dev}. The available character devices are the same as for the
1354 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1355 used to override the default 0403:6001. For instance,
1356 @example
1357 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1358 @end example
1359 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1360 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1361 @item braille
1362 Braille device.  This will use BrlAPI to display the braille output on a real
1363 or fake device.
1364 @item net:@var{options}
1365 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
1366 specifies NIC options as with @code{-net nic,}@var{options} (see description).
1367 For instance, user-mode networking can be used with
1368 @example
1369 qemu-system-i386 [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
1370 @end example
1371 Currently this cannot be used in machines that support PCI NICs.
1372 @item bt[:@var{hci-type}]
1373 Bluetooth dongle whose type is specified in the same format as with
1374 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
1375 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
1376 This USB device implements the USB Transport Layer of HCI.  Example
1377 usage:
1378 @example
1379 qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
1380 @end example
1381 @end table
1383 @node host_usb_devices
1384 @subsection Using host USB devices on a Linux host
1386 WARNING: this is an experimental feature. QEMU will slow down when
1387 using it. USB devices requiring real time streaming (i.e. USB Video
1388 Cameras) are not supported yet.
1390 @enumerate
1391 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1392 is actually using the USB device. A simple way to do that is simply to
1393 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1394 to @file{mydriver.o.disabled}.
1396 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1397 @example
1398 ls /proc/bus/usb
1399 001  devices  drivers
1400 @end example
1402 @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:
1403 @example
1404 chown -R myuid /proc/bus/usb
1405 @end example
1407 @item Launch QEMU and do in the monitor:
1408 @example
1409 info usbhost
1410   Device 1.2, speed 480 Mb/s
1411     Class 00: USB device 1234:5678, USB DISK
1412 @end example
1413 You should see the list of the devices you can use (Never try to use
1414 hubs, it won't work).
1416 @item Add the device in QEMU by using:
1417 @example
1418 usb_add host:1234:5678
1419 @end example
1421 Normally the guest OS should report that a new USB device is
1422 plugged. You can use the option @option{-usbdevice} to do the same.
1424 @item Now you can try to use the host USB device in QEMU.
1426 @end enumerate
1428 When relaunching QEMU, you may have to unplug and plug again the USB
1429 device to make it work again (this is a bug).
1431 @node vnc_security
1432 @section VNC security
1434 The VNC server capability provides access to the graphical console
1435 of the guest VM across the network. This has a number of security
1436 considerations depending on the deployment scenarios.
1438 @menu
1439 * vnc_sec_none::
1440 * vnc_sec_password::
1441 * vnc_sec_certificate::
1442 * vnc_sec_certificate_verify::
1443 * vnc_sec_certificate_pw::
1444 * vnc_sec_sasl::
1445 * vnc_sec_certificate_sasl::
1446 * vnc_generate_cert::
1447 * vnc_setup_sasl::
1448 @end menu
1449 @node vnc_sec_none
1450 @subsection Without passwords
1452 The simplest VNC server setup does not include any form of authentication.
1453 For this setup it is recommended to restrict it to listen on a UNIX domain
1454 socket only. For example
1456 @example
1457 qemu-system-i386 [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1458 @end example
1460 This ensures that only users on local box with read/write access to that
1461 path can access the VNC server. To securely access the VNC server from a
1462 remote machine, a combination of netcat+ssh can be used to provide a secure
1463 tunnel.
1465 @node vnc_sec_password
1466 @subsection With passwords
1468 The VNC protocol has limited support for password based authentication. Since
1469 the protocol limits passwords to 8 characters it should not be considered
1470 to provide high security. The password can be fairly easily brute-forced by
1471 a client making repeat connections. For this reason, a VNC server using password
1472 authentication should be restricted to only listen on the loopback interface
1473 or UNIX domain sockets. Password authentication is not supported when operating
1474 in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password
1475 authentication is requested with the @code{password} option, and then once QEMU
1476 is running the password is set with the monitor. Until the monitor is used to
1477 set the password all clients will be rejected.
1479 @example
1480 qemu-system-i386 [...OPTIONS...] -vnc :1,password -monitor stdio
1481 (qemu) change vnc password
1482 Password: ********
1483 (qemu)
1484 @end example
1486 @node vnc_sec_certificate
1487 @subsection With x509 certificates
1489 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1490 TLS for encryption of the session, and x509 certificates for authentication.
1491 The use of x509 certificates is strongly recommended, because TLS on its
1492 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1493 support provides a secure session, but no authentication. This allows any
1494 client to connect, and provides an encrypted session.
1496 @example
1497 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1498 @end example
1500 In the above example @code{/etc/pki/qemu} should contain at least three files,
1501 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1502 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1503 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1504 only be readable by the user owning it.
1506 @node vnc_sec_certificate_verify
1507 @subsection With x509 certificates and client verification
1509 Certificates can also provide a means to authenticate the client connecting.
1510 The server will request that the client provide a certificate, which it will
1511 then validate against the CA certificate. This is a good choice if deploying
1512 in an environment with a private internal certificate authority.
1514 @example
1515 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1516 @end example
1519 @node vnc_sec_certificate_pw
1520 @subsection With x509 certificates, client verification and passwords
1522 Finally, the previous method can be combined with VNC password authentication
1523 to provide two layers of authentication for clients.
1525 @example
1526 qemu-system-i386 [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1527 (qemu) change vnc password
1528 Password: ********
1529 (qemu)
1530 @end example
1533 @node vnc_sec_sasl
1534 @subsection With SASL authentication
1536 The SASL authentication method is a VNC extension, that provides an
1537 easily extendable, pluggable authentication method. This allows for
1538 integration with a wide range of authentication mechanisms, such as
1539 PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1540 The strength of the authentication depends on the exact mechanism
1541 configured. If the chosen mechanism also provides a SSF layer, then
1542 it will encrypt the datastream as well.
1544 Refer to the later docs on how to choose the exact SASL mechanism
1545 used for authentication, but assuming use of one supporting SSF,
1546 then QEMU can be launched with:
1548 @example
1549 qemu-system-i386 [...OPTIONS...] -vnc :1,sasl -monitor stdio
1550 @end example
1552 @node vnc_sec_certificate_sasl
1553 @subsection With x509 certificates and SASL authentication
1555 If the desired SASL authentication mechanism does not supported
1556 SSF layers, then it is strongly advised to run it in combination
1557 with TLS and x509 certificates. This provides securely encrypted
1558 data stream, avoiding risk of compromising of the security
1559 credentials. This can be enabled, by combining the 'sasl' option
1560 with the aforementioned TLS + x509 options:
1562 @example
1563 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1564 @end example
1567 @node vnc_generate_cert
1568 @subsection Generating certificates for VNC
1570 The GNU TLS packages provides a command called @code{certtool} which can
1571 be used to generate certificates and keys in PEM format. At a minimum it
1572 is necessary to setup a certificate authority, and issue certificates to
1573 each server. If using certificates for authentication, then each client
1574 will also need to be issued a certificate. The recommendation is for the
1575 server to keep its certificates in either @code{/etc/pki/qemu} or for
1576 unprivileged users in @code{$HOME/.pki/qemu}.
1578 @menu
1579 * vnc_generate_ca::
1580 * vnc_generate_server::
1581 * vnc_generate_client::
1582 @end menu
1583 @node vnc_generate_ca
1584 @subsubsection Setup the Certificate Authority
1586 This step only needs to be performed once per organization / organizational
1587 unit. First the CA needs a private key. This key must be kept VERY secret
1588 and secure. If this key is compromised the entire trust chain of the certificates
1589 issued with it is lost.
1591 @example
1592 # certtool --generate-privkey > ca-key.pem
1593 @end example
1595 A CA needs to have a public certificate. For simplicity it can be a self-signed
1596 certificate, or one issue by a commercial certificate issuing authority. To
1597 generate a self-signed certificate requires one core piece of information, the
1598 name of the organization.
1600 @example
1601 # cat > ca.info <<EOF
1602 cn = Name of your organization
1604 cert_signing_key
1606 # certtool --generate-self-signed \
1607            --load-privkey ca-key.pem
1608            --template ca.info \
1609            --outfile ca-cert.pem
1610 @end example
1612 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1613 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1615 @node vnc_generate_server
1616 @subsubsection Issuing server certificates
1618 Each server (or host) needs to be issued with a key and certificate. When connecting
1619 the certificate is sent to the client which validates it against the CA certificate.
1620 The core piece of information for a server certificate is the hostname. This should
1621 be the fully qualified hostname that the client will connect with, since the client
1622 will typically also verify the hostname in the certificate. On the host holding the
1623 secure CA private key:
1625 @example
1626 # cat > server.info <<EOF
1627 organization = Name  of your organization
1628 cn = server.foo.example.com
1629 tls_www_server
1630 encryption_key
1631 signing_key
1633 # certtool --generate-privkey > server-key.pem
1634 # certtool --generate-certificate \
1635            --load-ca-certificate ca-cert.pem \
1636            --load-ca-privkey ca-key.pem \
1637            --load-privkey server server-key.pem \
1638            --template server.info \
1639            --outfile server-cert.pem
1640 @end example
1642 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1643 to the server for which they were generated. The @code{server-key.pem} is security
1644 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1646 @node vnc_generate_client
1647 @subsubsection Issuing client certificates
1649 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1650 certificates as its authentication mechanism, each client also needs to be issued
1651 a certificate. The client certificate contains enough metadata to uniquely identify
1652 the client, typically organization, state, city, building, etc. On the host holding
1653 the secure CA private key:
1655 @example
1656 # cat > client.info <<EOF
1657 country = GB
1658 state = London
1659 locality = London
1660 organiazation = Name of your organization
1661 cn = client.foo.example.com
1662 tls_www_client
1663 encryption_key
1664 signing_key
1666 # certtool --generate-privkey > client-key.pem
1667 # certtool --generate-certificate \
1668            --load-ca-certificate ca-cert.pem \
1669            --load-ca-privkey ca-key.pem \
1670            --load-privkey client-key.pem \
1671            --template client.info \
1672            --outfile client-cert.pem
1673 @end example
1675 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1676 copied to the client for which they were generated.
1679 @node vnc_setup_sasl
1681 @subsection Configuring SASL mechanisms
1683 The following documentation assumes use of the Cyrus SASL implementation on a
1684 Linux host, but the principals should apply to any other SASL impl. When SASL
1685 is enabled, the mechanism configuration will be loaded from system default
1686 SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1687 unprivileged user, an environment variable SASL_CONF_PATH can be used
1688 to make it search alternate locations for the service config.
1690 The default configuration might contain
1692 @example
1693 mech_list: digest-md5
1694 sasldb_path: /etc/qemu/passwd.db
1695 @end example
1697 This says to use the 'Digest MD5' mechanism, which is similar to the HTTP
1698 Digest-MD5 mechanism. The list of valid usernames & passwords is maintained
1699 in the /etc/qemu/passwd.db file, and can be updated using the saslpasswd2
1700 command. While this mechanism is easy to configure and use, it is not
1701 considered secure by modern standards, so only suitable for developers /
1702 ad-hoc testing.
1704 A more serious deployment might use Kerberos, which is done with the 'gssapi'
1705 mechanism
1707 @example
1708 mech_list: gssapi
1709 keytab: /etc/qemu/krb5.tab
1710 @end example
1712 For this to work the administrator of your KDC must generate a Kerberos
1713 principal for the server, with a name of  'qemu/somehost.example.com@@EXAMPLE.COM'
1714 replacing 'somehost.example.com' with the fully qualified host name of the
1715 machine running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm.
1717 Other configurations will be left as an exercise for the reader. It should
1718 be noted that only Digest-MD5 and GSSAPI provides a SSF layer for data
1719 encryption. For all other mechanisms, VNC should always be configured to
1720 use TLS and x509 certificates to protect security credentials from snooping.
1722 @node gdb_usage
1723 @section GDB usage
1725 QEMU has a primitive support to work with gdb, so that you can do
1726 'Ctrl-C' while the virtual machine is running and inspect its state.
1728 In order to use gdb, launch QEMU with the '-s' option. It will wait for a
1729 gdb connection:
1730 @example
1731 qemu-system-i386 -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1732                     -append "root=/dev/hda"
1733 Connected to host network interface: tun0
1734 Waiting gdb connection on port 1234
1735 @end example
1737 Then launch gdb on the 'vmlinux' executable:
1738 @example
1739 > gdb vmlinux
1740 @end example
1742 In gdb, connect to QEMU:
1743 @example
1744 (gdb) target remote localhost:1234
1745 @end example
1747 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1748 @example
1749 (gdb) c
1750 @end example
1752 Here are some useful tips in order to use gdb on system code:
1754 @enumerate
1755 @item
1756 Use @code{info reg} to display all the CPU registers.
1757 @item
1758 Use @code{x/10i $eip} to display the code at the PC position.
1759 @item
1760 Use @code{set architecture i8086} to dump 16 bit code. Then use
1761 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1762 @end enumerate
1764 Advanced debugging options:
1766 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 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:
1767 @table @code
1768 @item maintenance packet qqemu.sstepbits
1770 This will display the MASK bits used to control the single stepping IE:
1771 @example
1772 (gdb) maintenance packet qqemu.sstepbits
1773 sending: "qqemu.sstepbits"
1774 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1775 @end example
1776 @item maintenance packet qqemu.sstep
1778 This will display the current value of the mask used when single stepping IE:
1779 @example
1780 (gdb) maintenance packet qqemu.sstep
1781 sending: "qqemu.sstep"
1782 received: "0x7"
1783 @end example
1784 @item maintenance packet Qqemu.sstep=HEX_VALUE
1786 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1787 @example
1788 (gdb) maintenance packet Qqemu.sstep=0x5
1789 sending: "qemu.sstep=0x5"
1790 received: "OK"
1791 @end example
1792 @end table
1794 @node pcsys_os_specific
1795 @section Target OS specific information
1797 @subsection Linux
1799 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1800 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1801 color depth in the guest and the host OS.
1803 When using a 2.6 guest Linux kernel, you should add the option
1804 @code{clock=pit} on the kernel command line because the 2.6 Linux
1805 kernels make very strict real time clock checks by default that QEMU
1806 cannot simulate exactly.
1808 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1809 not activated because QEMU is slower with this patch. The QEMU
1810 Accelerator Module is also much slower in this case. Earlier Fedora
1811 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1812 patch by default. Newer kernels don't have it.
1814 @subsection Windows
1816 If you have a slow host, using Windows 95 is better as it gives the
1817 best speed. Windows 2000 is also a good choice.
1819 @subsubsection SVGA graphic modes support
1821 QEMU emulates a Cirrus Logic GD5446 Video
1822 card. All Windows versions starting from Windows 95 should recognize
1823 and use this graphic card. For optimal performances, use 16 bit color
1824 depth in the guest and the host OS.
1826 If you are using Windows XP as guest OS and if you want to use high
1827 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1828 1280x1024x16), then you should use the VESA VBE virtual graphic card
1829 (option @option{-std-vga}).
1831 @subsubsection CPU usage reduction
1833 Windows 9x does not correctly use the CPU HLT
1834 instruction. The result is that it takes host CPU cycles even when
1835 idle. You can install the utility from
1836 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1837 problem. Note that no such tool is needed for NT, 2000 or XP.
1839 @subsubsection Windows 2000 disk full problem
1841 Windows 2000 has a bug which gives a disk full problem during its
1842 installation. When installing it, use the @option{-win2k-hack} QEMU
1843 option to enable a specific workaround. After Windows 2000 is
1844 installed, you no longer need this option (this option slows down the
1845 IDE transfers).
1847 @subsubsection Windows 2000 shutdown
1849 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1850 can. It comes from the fact that Windows 2000 does not automatically
1851 use the APM driver provided by the BIOS.
1853 In order to correct that, do the following (thanks to Struan
1854 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1855 Add/Troubleshoot a device => Add a new device & Next => No, select the
1856 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1857 (again) a few times. Now the driver is installed and Windows 2000 now
1858 correctly instructs QEMU to shutdown at the appropriate moment.
1860 @subsubsection Share a directory between Unix and Windows
1862 See @ref{sec_invocation} about the help of the option @option{-smb}.
1864 @subsubsection Windows XP security problem
1866 Some releases of Windows XP install correctly but give a security
1867 error when booting:
1868 @example
1869 A problem is preventing Windows from accurately checking the
1870 license for this computer. Error code: 0x800703e6.
1871 @end example
1873 The workaround is to install a service pack for XP after a boot in safe
1874 mode. Then reboot, and the problem should go away. Since there is no
1875 network while in safe mode, its recommended to download the full
1876 installation of SP1 or SP2 and transfer that via an ISO or using the
1877 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1879 @subsection MS-DOS and FreeDOS
1881 @subsubsection CPU usage reduction
1883 DOS does not correctly use the CPU HLT instruction. The result is that
1884 it takes host CPU cycles even when idle. You can install the utility
1885 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1886 problem.
1888 @node QEMU System emulator for non PC targets
1889 @chapter QEMU System emulator for non PC targets
1891 QEMU is a generic emulator and it emulates many non PC
1892 machines. Most of the options are similar to the PC emulator. The
1893 differences are mentioned in the following sections.
1895 @menu
1896 * PowerPC System emulator::
1897 * Sparc32 System emulator::
1898 * Sparc64 System emulator::
1899 * MIPS System emulator::
1900 * ARM System emulator::
1901 * ColdFire System emulator::
1902 * Cris System emulator::
1903 * Microblaze System emulator::
1904 * SH4 System emulator::
1905 * Xtensa System emulator::
1906 @end menu
1908 @node PowerPC System emulator
1909 @section PowerPC System emulator
1910 @cindex system emulation (PowerPC)
1912 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1913 or PowerMac PowerPC system.
1915 QEMU emulates the following PowerMac peripherals:
1917 @itemize @minus
1918 @item
1919 UniNorth or Grackle PCI Bridge
1920 @item
1921 PCI VGA compatible card with VESA Bochs Extensions
1922 @item
1923 2 PMAC IDE interfaces with hard disk and CD-ROM support
1924 @item
1925 NE2000 PCI adapters
1926 @item
1927 Non Volatile RAM
1928 @item
1929 VIA-CUDA with ADB keyboard and mouse.
1930 @end itemize
1932 QEMU emulates the following PREP peripherals:
1934 @itemize @minus
1935 @item
1936 PCI Bridge
1937 @item
1938 PCI VGA compatible card with VESA Bochs Extensions
1939 @item
1940 2 IDE interfaces with hard disk and CD-ROM support
1941 @item
1942 Floppy disk
1943 @item
1944 NE2000 network adapters
1945 @item
1946 Serial port
1947 @item
1948 PREP Non Volatile RAM
1949 @item
1950 PC compatible keyboard and mouse.
1951 @end itemize
1953 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS.
1955 Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
1956 for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
1957 v2) portable firmware implementation. The goal is to implement a 100%
1958 IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
1960 @c man begin OPTIONS
1962 The following options are specific to the PowerPC emulation:
1964 @table @option
1966 @item -g @var{W}x@var{H}[x@var{DEPTH}]
1968 Set the initial VGA graphic mode. The default is 800x600x32.
1970 @item -prom-env @var{string}
1972 Set OpenBIOS variables in NVRAM, for example:
1974 @example
1975 qemu-system-ppc -prom-env 'auto-boot?=false' \
1976  -prom-env 'boot-device=hd:2,\yaboot' \
1977  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
1978 @end example
1980 These variables are not used by Open Hack'Ware.
1982 @end table
1984 @c man end
1986 @node Sparc32 System emulator
1987 @section Sparc32 System emulator
1988 @cindex system emulation (Sparc32)
1990 Use the executable @file{qemu-system-sparc} to simulate the following
1991 Sun4m architecture machines:
1992 @itemize @minus
1993 @item
1994 SPARCstation 4
1995 @item
1996 SPARCstation 5
1997 @item
1998 SPARCstation 10
1999 @item
2000 SPARCstation 20
2001 @item
2002 SPARCserver 600MP
2003 @item
2004 SPARCstation LX
2005 @item
2006 SPARCstation Voyager
2007 @item
2008 SPARCclassic
2009 @item
2010 SPARCbook
2011 @end itemize
2013 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
2014 but Linux limits the number of usable CPUs to 4.
2016 QEMU emulates the following sun4m peripherals:
2018 @itemize @minus
2019 @item
2020 IOMMU
2021 @item
2022 TCX or cgthree Frame buffer
2023 @item
2024 Lance (Am7990) Ethernet
2025 @item
2026 Non Volatile RAM M48T02/M48T08
2027 @item
2028 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2029 and power/reset logic
2030 @item
2031 ESP SCSI controller with hard disk and CD-ROM support
2032 @item
2033 Floppy drive (not on SS-600MP)
2034 @item
2035 CS4231 sound device (only on SS-5, not working yet)
2036 @end itemize
2038 The number of peripherals is fixed in the architecture.  Maximum
2039 memory size depends on the machine type, for SS-5 it is 256MB and for
2040 others 2047MB.
2042 Since version 0.8.2, QEMU uses OpenBIOS
2043 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2044 firmware implementation. The goal is to implement a 100% IEEE
2045 1275-1994 (referred to as Open Firmware) compliant firmware.
2047 A sample Linux 2.6 series kernel and ram disk image are available on
2048 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
2049 some kernel versions work. Please note that currently older Solaris kernels
2050 don't work probably due to interface issues between OpenBIOS and
2051 Solaris.
2053 @c man begin OPTIONS
2055 The following options are specific to the Sparc32 emulation:
2057 @table @option
2059 @item -g @var{W}x@var{H}x[x@var{DEPTH}]
2061 Set the initial graphics mode. For TCX, the default is 1024x768x8 with the
2062 option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
2063 of 1152x900x8 for people who wish to use OBP.
2065 @item -prom-env @var{string}
2067 Set OpenBIOS variables in NVRAM, for example:
2069 @example
2070 qemu-system-sparc -prom-env 'auto-boot?=false' \
2071  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2072 @end example
2074 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]
2076 Set the emulated machine type. Default is SS-5.
2078 @end table
2080 @c man end
2082 @node Sparc64 System emulator
2083 @section Sparc64 System emulator
2084 @cindex system emulation (Sparc64)
2086 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
2087 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
2088 Niagara (T1) machine. The emulator is not usable for anything yet, but
2089 it can launch some kernels.
2091 QEMU emulates the following peripherals:
2093 @itemize @minus
2094 @item
2095 UltraSparc IIi APB PCI Bridge
2096 @item
2097 PCI VGA compatible card with VESA Bochs Extensions
2098 @item
2099 PS/2 mouse and keyboard
2100 @item
2101 Non Volatile RAM M48T59
2102 @item
2103 PC-compatible serial ports
2104 @item
2105 2 PCI IDE interfaces with hard disk and CD-ROM support
2106 @item
2107 Floppy disk
2108 @end itemize
2110 @c man begin OPTIONS
2112 The following options are specific to the Sparc64 emulation:
2114 @table @option
2116 @item -prom-env @var{string}
2118 Set OpenBIOS variables in NVRAM, for example:
2120 @example
2121 qemu-system-sparc64 -prom-env 'auto-boot?=false'
2122 @end example
2124 @item -M [sun4u|sun4v|Niagara]
2126 Set the emulated machine type. The default is sun4u.
2128 @end table
2130 @c man end
2132 @node MIPS System emulator
2133 @section MIPS System emulator
2134 @cindex system emulation (MIPS)
2136 Four executables cover simulation of 32 and 64-bit MIPS systems in
2137 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2138 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2139 Five different machine types are emulated:
2141 @itemize @minus
2142 @item
2143 A generic ISA PC-like machine "mips"
2144 @item
2145 The MIPS Malta prototype board "malta"
2146 @item
2147 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2148 @item
2149 MIPS emulator pseudo board "mipssim"
2150 @item
2151 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2152 @end itemize
2154 The generic emulation is supported by Debian 'Etch' and is able to
2155 install Debian into a virtual disk image. The following devices are
2156 emulated:
2158 @itemize @minus
2159 @item
2160 A range of MIPS CPUs, default is the 24Kf
2161 @item
2162 PC style serial port
2163 @item
2164 PC style IDE disk
2165 @item
2166 NE2000 network card
2167 @end itemize
2169 The Malta emulation supports the following devices:
2171 @itemize @minus
2172 @item
2173 Core board with MIPS 24Kf CPU and Galileo system controller
2174 @item
2175 PIIX4 PCI/USB/SMbus controller
2176 @item
2177 The Multi-I/O chip's serial device
2178 @item
2179 PCI network cards (PCnet32 and others)
2180 @item
2181 Malta FPGA serial device
2182 @item
2183 Cirrus (default) or any other PCI VGA graphics card
2184 @end itemize
2186 The ACER Pica emulation supports:
2188 @itemize @minus
2189 @item
2190 MIPS R4000 CPU
2191 @item
2192 PC-style IRQ and DMA controllers
2193 @item
2194 PC Keyboard
2195 @item
2196 IDE controller
2197 @end itemize
2199 The mipssim pseudo board emulation provides an environment similar
2200 to what the proprietary MIPS emulator uses for running Linux.
2201 It supports:
2203 @itemize @minus
2204 @item
2205 A range of MIPS CPUs, default is the 24Kf
2206 @item
2207 PC style serial port
2208 @item
2209 MIPSnet network emulation
2210 @end itemize
2212 The MIPS Magnum R4000 emulation supports:
2214 @itemize @minus
2215 @item
2216 MIPS R4000 CPU
2217 @item
2218 PC-style IRQ controller
2219 @item
2220 PC Keyboard
2221 @item
2222 SCSI controller
2223 @item
2224 G364 framebuffer
2225 @end itemize
2228 @node ARM System emulator
2229 @section ARM System emulator
2230 @cindex system emulation (ARM)
2232 Use the executable @file{qemu-system-arm} to simulate a ARM
2233 machine. The ARM Integrator/CP board is emulated with the following
2234 devices:
2236 @itemize @minus
2237 @item
2238 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2239 @item
2240 Two PL011 UARTs
2241 @item
2242 SMC 91c111 Ethernet adapter
2243 @item
2244 PL110 LCD controller
2245 @item
2246 PL050 KMI with PS/2 keyboard and mouse.
2247 @item
2248 PL181 MultiMedia Card Interface with SD card.
2249 @end itemize
2251 The ARM Versatile baseboard is emulated with the following devices:
2253 @itemize @minus
2254 @item
2255 ARM926E, ARM1136 or Cortex-A8 CPU
2256 @item
2257 PL190 Vectored Interrupt Controller
2258 @item
2259 Four PL011 UARTs
2260 @item
2261 SMC 91c111 Ethernet adapter
2262 @item
2263 PL110 LCD controller
2264 @item
2265 PL050 KMI with PS/2 keyboard and mouse.
2266 @item
2267 PCI host bridge.  Note the emulated PCI bridge only provides access to
2268 PCI memory space.  It does not provide access to PCI IO space.
2269 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2270 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2271 mapped control registers.
2272 @item
2273 PCI OHCI USB controller.
2274 @item
2275 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2276 @item
2277 PL181 MultiMedia Card Interface with SD card.
2278 @end itemize
2280 Several variants of the ARM RealView baseboard are emulated,
2281 including the EB, PB-A8 and PBX-A9.  Due to interactions with the
2282 bootloader, only certain Linux kernel configurations work out
2283 of the box on these boards.
2285 Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2286 enabled in the kernel, and expect 512M RAM.  Kernels for The PBX-A9 board
2287 should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2288 disabled and expect 1024M RAM.
2290 The following devices are emulated:
2292 @itemize @minus
2293 @item
2294 ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
2295 @item
2296 ARM AMBA Generic/Distributed Interrupt Controller
2297 @item
2298 Four PL011 UARTs
2299 @item
2300 SMC 91c111 or SMSC LAN9118 Ethernet adapter
2301 @item
2302 PL110 LCD controller
2303 @item
2304 PL050 KMI with PS/2 keyboard and mouse
2305 @item
2306 PCI host bridge
2307 @item
2308 PCI OHCI USB controller
2309 @item
2310 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2311 @item
2312 PL181 MultiMedia Card Interface with SD card.
2313 @end itemize
2315 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2316 and "Terrier") emulation includes the following peripherals:
2318 @itemize @minus
2319 @item
2320 Intel PXA270 System-on-chip (ARM V5TE core)
2321 @item
2322 NAND Flash memory
2323 @item
2324 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2325 @item
2326 On-chip OHCI USB controller
2327 @item
2328 On-chip LCD controller
2329 @item
2330 On-chip Real Time Clock
2331 @item
2332 TI ADS7846 touchscreen controller on SSP bus
2333 @item
2334 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2335 @item
2336 GPIO-connected keyboard controller and LEDs
2337 @item
2338 Secure Digital card connected to PXA MMC/SD host
2339 @item
2340 Three on-chip UARTs
2341 @item
2342 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2343 @end itemize
2345 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2346 following elements:
2348 @itemize @minus
2349 @item
2350 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2351 @item
2352 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2353 @item
2354 On-chip LCD controller
2355 @item
2356 On-chip Real Time Clock
2357 @item
2358 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2359 CODEC, connected through MicroWire and I@math{^2}S busses
2360 @item
2361 GPIO-connected matrix keypad
2362 @item
2363 Secure Digital card connected to OMAP MMC/SD host
2364 @item
2365 Three on-chip UARTs
2366 @end itemize
2368 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2369 emulation supports the following elements:
2371 @itemize @minus
2372 @item
2373 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2374 @item
2375 RAM and non-volatile OneNAND Flash memories
2376 @item
2377 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2378 display controller and a LS041y3 MIPI DBI-C controller
2379 @item
2380 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2381 driven through SPI bus
2382 @item
2383 National Semiconductor LM8323-controlled qwerty keyboard driven
2384 through I@math{^2}C bus
2385 @item
2386 Secure Digital card connected to OMAP MMC/SD host
2387 @item
2388 Three OMAP on-chip UARTs and on-chip STI debugging console
2389 @item
2390 A Bluetooth(R) transceiver and HCI connected to an UART
2391 @item
2392 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2393 TUSB6010 chip - only USB host mode is supported
2394 @item
2395 TI TMP105 temperature sensor driven through I@math{^2}C bus
2396 @item
2397 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2398 @item
2399 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2400 through CBUS
2401 @end itemize
2403 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2404 devices:
2406 @itemize @minus
2407 @item
2408 Cortex-M3 CPU core.
2409 @item
2410 64k Flash and 8k SRAM.
2411 @item
2412 Timers, UARTs, ADC and I@math{^2}C interface.
2413 @item
2414 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2415 @end itemize
2417 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2418 devices:
2420 @itemize @minus
2421 @item
2422 Cortex-M3 CPU core.
2423 @item
2424 256k Flash and 64k SRAM.
2425 @item
2426 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2427 @item
2428 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2429 @end itemize
2431 The Freecom MusicPal internet radio emulation includes the following
2432 elements:
2434 @itemize @minus
2435 @item
2436 Marvell MV88W8618 ARM core.
2437 @item
2438 32 MB RAM, 256 KB SRAM, 8 MB flash.
2439 @item
2440 Up to 2 16550 UARTs
2441 @item
2442 MV88W8xx8 Ethernet controller
2443 @item
2444 MV88W8618 audio controller, WM8750 CODEC and mixer
2445 @item
2446 128×64 display with brightness control
2447 @item
2448 2 buttons, 2 navigation wheels with button function
2449 @end itemize
2451 The Siemens SX1 models v1 and v2 (default) basic emulation.
2452 The emulation includes the following elements:
2454 @itemize @minus
2455 @item
2456 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2457 @item
2458 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2460 1 Flash of 16MB and 1 Flash of 8MB
2462 1 Flash of 32MB
2463 @item
2464 On-chip LCD controller
2465 @item
2466 On-chip Real Time Clock
2467 @item
2468 Secure Digital card connected to OMAP MMC/SD host
2469 @item
2470 Three on-chip UARTs
2471 @end itemize
2473 A Linux 2.6 test image is available on the QEMU web site. More
2474 information is available in the QEMU mailing-list archive.
2476 @c man begin OPTIONS
2478 The following options are specific to the ARM emulation:
2480 @table @option
2482 @item -semihosting
2483 Enable semihosting syscall emulation.
2485 On ARM this implements the "Angel" interface.
2487 Note that this allows guest direct access to the host filesystem,
2488 so should only be used with trusted guest OS.
2490 @end table
2492 @node ColdFire System emulator
2493 @section ColdFire System emulator
2494 @cindex system emulation (ColdFire)
2495 @cindex system emulation (M68K)
2497 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2498 The emulator is able to boot a uClinux kernel.
2500 The M5208EVB emulation includes the following devices:
2502 @itemize @minus
2503 @item
2504 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2505 @item
2506 Three Two on-chip UARTs.
2507 @item
2508 Fast Ethernet Controller (FEC)
2509 @end itemize
2511 The AN5206 emulation includes the following devices:
2513 @itemize @minus
2514 @item
2515 MCF5206 ColdFire V2 Microprocessor.
2516 @item
2517 Two on-chip UARTs.
2518 @end itemize
2520 @c man begin OPTIONS
2522 The following options are specific to the ColdFire emulation:
2524 @table @option
2526 @item -semihosting
2527 Enable semihosting syscall emulation.
2529 On M68K this implements the "ColdFire GDB" interface used by libgloss.
2531 Note that this allows guest direct access to the host filesystem,
2532 so should only be used with trusted guest OS.
2534 @end table
2536 @node Cris System emulator
2537 @section Cris System emulator
2538 @cindex system emulation (Cris)
2540 TODO
2542 @node Microblaze System emulator
2543 @section Microblaze System emulator
2544 @cindex system emulation (Microblaze)
2546 TODO
2548 @node SH4 System emulator
2549 @section SH4 System emulator
2550 @cindex system emulation (SH4)
2552 TODO
2554 @node Xtensa System emulator
2555 @section Xtensa System emulator
2556 @cindex system emulation (Xtensa)
2558 Two executables cover simulation of both Xtensa endian options,
2559 @file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}.
2560 Two different machine types are emulated:
2562 @itemize @minus
2563 @item
2564 Xtensa emulator pseudo board "sim"
2565 @item
2566 Avnet LX60/LX110/LX200 board
2567 @end itemize
2569 The sim pseudo board emulation provides an environment similar
2570 to one provided by the proprietary Tensilica ISS.
2571 It supports:
2573 @itemize @minus
2574 @item
2575 A range of Xtensa CPUs, default is the DC232B
2576 @item
2577 Console and filesystem access via semihosting calls
2578 @end itemize
2580 The Avnet LX60/LX110/LX200 emulation supports:
2582 @itemize @minus
2583 @item
2584 A range of Xtensa CPUs, default is the DC232B
2585 @item
2586 16550 UART
2587 @item
2588 OpenCores 10/100 Mbps Ethernet MAC
2589 @end itemize
2591 @c man begin OPTIONS
2593 The following options are specific to the Xtensa emulation:
2595 @table @option
2597 @item -semihosting
2598 Enable semihosting syscall emulation.
2600 Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select.
2601 Tensilica baremetal libc for ISS and linux platform "sim" use this interface.
2603 Note that this allows guest direct access to the host filesystem,
2604 so should only be used with trusted guest OS.
2606 @end table
2607 @node QEMU User space emulator
2608 @chapter QEMU User space emulator
2610 @menu
2611 * Supported Operating Systems ::
2612 * Linux User space emulator::
2613 * BSD User space emulator ::
2614 @end menu
2616 @node Supported Operating Systems
2617 @section Supported Operating Systems
2619 The following OS are supported in user space emulation:
2621 @itemize @minus
2622 @item
2623 Linux (referred as qemu-linux-user)
2624 @item
2625 BSD (referred as qemu-bsd-user)
2626 @end itemize
2628 @node Linux User space emulator
2629 @section Linux User space emulator
2631 @menu
2632 * Quick Start::
2633 * Wine launch::
2634 * Command line options::
2635 * Other binaries::
2636 @end menu
2638 @node Quick Start
2639 @subsection Quick Start
2641 In order to launch a Linux process, QEMU needs the process executable
2642 itself and all the target (x86) dynamic libraries used by it.
2644 @itemize
2646 @item On x86, you can just try to launch any process by using the native
2647 libraries:
2649 @example
2650 qemu-i386 -L / /bin/ls
2651 @end example
2653 @code{-L /} tells that the x86 dynamic linker must be searched with a
2654 @file{/} prefix.
2656 @item Since QEMU is also a linux process, you can launch QEMU with
2657 QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
2659 @example
2660 qemu-i386 -L / qemu-i386 -L / /bin/ls
2661 @end example
2663 @item On non x86 CPUs, you need first to download at least an x86 glibc
2664 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2665 @code{LD_LIBRARY_PATH} is not set:
2667 @example
2668 unset LD_LIBRARY_PATH
2669 @end example
2671 Then you can launch the precompiled @file{ls} x86 executable:
2673 @example
2674 qemu-i386 tests/i386/ls
2675 @end example
2676 You can look at @file{scripts/qemu-binfmt-conf.sh} so that
2677 QEMU is automatically launched by the Linux kernel when you try to
2678 launch x86 executables. It requires the @code{binfmt_misc} module in the
2679 Linux kernel.
2681 @item The x86 version of QEMU is also included. You can try weird things such as:
2682 @example
2683 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2684           /usr/local/qemu-i386/bin/ls-i386
2685 @end example
2687 @end itemize
2689 @node Wine launch
2690 @subsection Wine launch
2692 @itemize
2694 @item Ensure that you have a working QEMU with the x86 glibc
2695 distribution (see previous section). In order to verify it, you must be
2696 able to do:
2698 @example
2699 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2700 @end example
2702 @item Download the binary x86 Wine install
2703 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2705 @item Configure Wine on your account. Look at the provided script
2706 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2707 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2709 @item Then you can try the example @file{putty.exe}:
2711 @example
2712 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2713           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2714 @end example
2716 @end itemize
2718 @node Command line options
2719 @subsection Command line options
2721 @example
2722 usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
2723 @end example
2725 @table @option
2726 @item -h
2727 Print the help
2728 @item -L path
2729 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2730 @item -s size
2731 Set the x86 stack size in bytes (default=524288)
2732 @item -cpu model
2733 Select CPU model (-cpu help for list and additional feature selection)
2734 @item -E @var{var}=@var{value}
2735 Set environment @var{var} to @var{value}.
2736 @item -U @var{var}
2737 Remove @var{var} from the environment.
2738 @item -B offset
2739 Offset guest address by the specified number of bytes.  This is useful when
2740 the address region required by guest applications is reserved on the host.
2741 This option is currently only supported on some hosts.
2742 @item -R size
2743 Pre-allocate a guest virtual address space of the given size (in bytes).
2744 "G", "M", and "k" suffixes may be used when specifying the size.
2745 @end table
2747 Debug options:
2749 @table @option
2750 @item -d item1,...
2751 Activate logging of the specified items (use '-d help' for a list of log items)
2752 @item -p pagesize
2753 Act as if the host page size was 'pagesize' bytes
2754 @item -g port
2755 Wait gdb connection to port
2756 @item -singlestep
2757 Run the emulation in single step mode.
2758 @end table
2760 Environment variables:
2762 @table @env
2763 @item QEMU_STRACE
2764 Print system calls and arguments similar to the 'strace' program
2765 (NOTE: the actual 'strace' program will not work because the user
2766 space emulator hasn't implemented ptrace).  At the moment this is
2767 incomplete.  All system calls that don't have a specific argument
2768 format are printed with information for six arguments.  Many
2769 flag-style arguments don't have decoders and will show up as numbers.
2770 @end table
2772 @node Other binaries
2773 @subsection Other binaries
2775 @cindex user mode (Alpha)
2776 @command{qemu-alpha} TODO.
2778 @cindex user mode (ARM)
2779 @command{qemu-armeb} TODO.
2781 @cindex user mode (ARM)
2782 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2783 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2784 configurations), and arm-uclinux bFLT format binaries.
2786 @cindex user mode (ColdFire)
2787 @cindex user mode (M68K)
2788 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2789 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2790 coldfire uClinux bFLT format binaries.
2792 The binary format is detected automatically.
2794 @cindex user mode (Cris)
2795 @command{qemu-cris} TODO.
2797 @cindex user mode (i386)
2798 @command{qemu-i386} TODO.
2799 @command{qemu-x86_64} TODO.
2801 @cindex user mode (Microblaze)
2802 @command{qemu-microblaze} TODO.
2804 @cindex user mode (MIPS)
2805 @command{qemu-mips} TODO.
2806 @command{qemu-mipsel} TODO.
2808 @cindex user mode (PowerPC)
2809 @command{qemu-ppc64abi32} TODO.
2810 @command{qemu-ppc64} TODO.
2811 @command{qemu-ppc} TODO.
2813 @cindex user mode (SH4)
2814 @command{qemu-sh4eb} TODO.
2815 @command{qemu-sh4} TODO.
2817 @cindex user mode (SPARC)
2818 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2820 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2821 (Sparc64 CPU, 32 bit ABI).
2823 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2824 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2826 @node BSD User space emulator
2827 @section BSD User space emulator
2829 @menu
2830 * BSD Status::
2831 * BSD Quick Start::
2832 * BSD Command line options::
2833 @end menu
2835 @node BSD Status
2836 @subsection BSD Status
2838 @itemize @minus
2839 @item
2840 target Sparc64 on Sparc64: Some trivial programs work.
2841 @end itemize
2843 @node BSD Quick Start
2844 @subsection Quick Start
2846 In order to launch a BSD process, QEMU needs the process executable
2847 itself and all the target dynamic libraries used by it.
2849 @itemize
2851 @item On Sparc64, you can just try to launch any process by using the native
2852 libraries:
2854 @example
2855 qemu-sparc64 /bin/ls
2856 @end example
2858 @end itemize
2860 @node BSD Command line options
2861 @subsection Command line options
2863 @example
2864 usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
2865 @end example
2867 @table @option
2868 @item -h
2869 Print the help
2870 @item -L path
2871 Set the library root path (default=/)
2872 @item -s size
2873 Set the stack size in bytes (default=524288)
2874 @item -ignore-environment
2875 Start with an empty environment. Without this option,
2876 the initial environment is a copy of the caller's environment.
2877 @item -E @var{var}=@var{value}
2878 Set environment @var{var} to @var{value}.
2879 @item -U @var{var}
2880 Remove @var{var} from the environment.
2881 @item -bsd type
2882 Set the type of the emulated BSD Operating system. Valid values are
2883 FreeBSD, NetBSD and OpenBSD (default).
2884 @end table
2886 Debug options:
2888 @table @option
2889 @item -d item1,...
2890 Activate logging of the specified items (use '-d help' for a list of log items)
2891 @item -p pagesize
2892 Act as if the host page size was 'pagesize' bytes
2893 @item -singlestep
2894 Run the emulation in single step mode.
2895 @end table
2897 @node compilation
2898 @chapter Compilation from the sources
2900 @menu
2901 * Linux/Unix::
2902 * Windows::
2903 * Cross compilation for Windows with Linux::
2904 * Mac OS X::
2905 * Make targets::
2906 @end menu
2908 @node Linux/Unix
2909 @section Linux/Unix
2911 @subsection Compilation
2913 First you must decompress the sources:
2914 @example
2915 cd /tmp
2916 tar zxvf qemu-x.y.z.tar.gz
2917 cd qemu-x.y.z
2918 @end example
2920 Then you configure QEMU and build it (usually no options are needed):
2921 @example
2922 ./configure
2923 make
2924 @end example
2926 Then type as root user:
2927 @example
2928 make install
2929 @end example
2930 to install QEMU in @file{/usr/local}.
2932 @node Windows
2933 @section Windows
2935 @itemize
2936 @item Install the current versions of MSYS and MinGW from
2937 @url{http://www.mingw.org/}. You can find detailed installation
2938 instructions in the download section and the FAQ.
2940 @item Download
2941 the MinGW development library of SDL 1.2.x
2942 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2943 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2944 edit the @file{sdl-config} script so that it gives the
2945 correct SDL directory when invoked.
2947 @item Install the MinGW version of zlib and make sure
2948 @file{zlib.h} and @file{libz.dll.a} are in
2949 MinGW's default header and linker search paths.
2951 @item Extract the current version of QEMU.
2953 @item Start the MSYS shell (file @file{msys.bat}).
2955 @item Change to the QEMU directory. Launch @file{./configure} and
2956 @file{make}.  If you have problems using SDL, verify that
2957 @file{sdl-config} can be launched from the MSYS command line.
2959 @item You can install QEMU in @file{Program Files/QEMU} by typing
2960 @file{make install}. Don't forget to copy @file{SDL.dll} in
2961 @file{Program Files/QEMU}.
2963 @end itemize
2965 @node Cross compilation for Windows with Linux
2966 @section Cross compilation for Windows with Linux
2968 @itemize
2969 @item
2970 Install the MinGW cross compilation tools available at
2971 @url{http://www.mingw.org/}.
2973 @item Download
2974 the MinGW development library of SDL 1.2.x
2975 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2976 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2977 edit the @file{sdl-config} script so that it gives the
2978 correct SDL directory when invoked.  Set up the @code{PATH} environment
2979 variable so that @file{sdl-config} can be launched by
2980 the QEMU configuration script.
2982 @item Install the MinGW version of zlib and make sure
2983 @file{zlib.h} and @file{libz.dll.a} are in
2984 MinGW's default header and linker search paths.
2986 @item
2987 Configure QEMU for Windows cross compilation:
2988 @example
2989 PATH=/usr/i686-pc-mingw32/sys-root/mingw/bin:$PATH ./configure --cross-prefix='i686-pc-mingw32-'
2990 @end example
2991 The example assumes @file{sdl-config} is installed under @file{/usr/i686-pc-mingw32/sys-root/mingw/bin} and
2992 MinGW cross compilation tools have names like @file{i686-pc-mingw32-gcc} and @file{i686-pc-mingw32-strip}.
2993 We set the @code{PATH} environment variable to ensure the MinGW version of @file{sdl-config} is used and
2994 use --cross-prefix to specify the name of the cross compiler.
2995 You can also use --prefix to set the Win32 install path which defaults to @file{c:/Program Files/QEMU}.
2997 Under Fedora Linux, you can run:
2998 @example
2999 yum -y install mingw32-gcc mingw32-SDL mingw32-zlib
3000 @end example
3001 to get a suitable cross compilation environment.
3003 @item You can install QEMU in the installation directory by typing
3004 @code{make install}. Don't forget to copy @file{SDL.dll} and @file{zlib1.dll} into the
3005 installation directory.
3007 @end itemize
3009 @cindex wine, starting system emulation
3010 Wine can be used to launch the resulting qemu-system-i386.exe
3011 and all other qemu-system-@var{target}.exe compiled for Win32.
3012 @example
3013 wine qemu-system-i386
3014 @end example
3016 @node Mac OS X
3017 @section Mac OS X
3019 The Mac OS X patches are not fully merged in QEMU, so you should look
3020 at the QEMU mailing list archive to have all the necessary
3021 information. (TODO: is this still true?)
3023 @node Make targets
3024 @section Make targets
3026 @table @code
3028 @item make
3029 @item make all
3030 Make everything which is typically needed.
3032 @item install
3033 TODO
3035 @item install-doc
3036 TODO
3038 @item make clean
3039 Remove most files which were built during make.
3041 @item make distclean
3042 Remove everything which was built during make.
3044 @item make dvi
3045 @item make html
3046 @item make info
3047 @item make pdf
3048 Create documentation in dvi, html, info or pdf format.
3050 @item make cscope
3051 TODO
3053 @item make defconfig
3054 (Re-)create some build configuration files.
3055 User made changes will be overwritten.
3057 @item tar
3058 @item tarbin
3059 TODO
3061 @end table
3063 @node License
3064 @appendix License
3066 QEMU is a trademark of Fabrice Bellard.
3068 QEMU is released under the GNU General Public License (TODO: add link).
3069 Parts of QEMU have specific licenses, see file LICENSE.
3071 TODO (refer to file LICENSE, include it, include the GPL?)
3073 @node Index
3074 @appendix Index
3075 @menu
3076 * Concept Index::
3077 * Function Index::
3078 * Keystroke Index::
3079 * Program Index::
3080 * Data Type Index::
3081 * Variable Index::
3082 @end menu
3084 @node Concept Index
3085 @section Concept Index
3086 This is the main index. Should we combine all keywords in one index? TODO
3087 @printindex cp
3089 @node Function Index
3090 @section Function Index
3091 This index could be used for command line options and monitor functions.
3092 @printindex fn
3094 @node Keystroke Index
3095 @section Keystroke Index
3097 This is a list of all keystrokes which have a special function
3098 in system emulation.
3100 @printindex ky
3102 @node Program Index
3103 @section Program Index
3104 @printindex pg
3106 @node Data Type Index
3107 @section Data Type Index
3109 This index could be used for qdev device names and options.
3111 @printindex tp
3113 @node Variable Index
3114 @section Variable Index
3115 @printindex vr
3117 @bye