Update version for v2.3.0-rc0 release
[qemu-kvm.git] / qemu-doc.texi
blob8aa6dbf5d7bc8ceb2c3e305f0d8dff9f24c8e03c
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename qemu-doc.info
5 @documentlanguage en
6 @documentencoding UTF-8
8 @settitle QEMU Emulator User Documentation
9 @exampleindent 0
10 @paragraphindent 0
11 @c %**end of header
13 @ifinfo
14 @direntry
15 * QEMU: (qemu-doc).    The QEMU Emulator User Documentation.
16 @end direntry
17 @end ifinfo
19 @iftex
20 @titlepage
21 @sp 7
22 @center @titlefont{QEMU Emulator}
23 @sp 1
24 @center @titlefont{User Documentation}
25 @sp 3
26 @end titlepage
27 @end iftex
29 @ifnottex
30 @node Top
31 @top
33 @menu
34 * Introduction::
35 * Installation::
36 * QEMU PC System emulator::
37 * QEMU System emulator for non PC targets::
38 * QEMU User space emulator::
39 * compilation:: Compilation from the sources
40 * License::
41 * Index::
42 @end menu
43 @end ifnottex
45 @contents
47 @node Introduction
48 @chapter Introduction
50 @menu
51 * intro_features:: Features
52 @end menu
54 @node intro_features
55 @section Features
57 QEMU is a FAST! processor emulator using dynamic translation to
58 achieve good emulation speed.
60 QEMU has two operating modes:
62 @itemize
63 @cindex operating modes
65 @item
66 @cindex system emulation
67 Full system emulation. In this mode, QEMU emulates a full system (for
68 example a PC), including one or several processors and various
69 peripherals. It can be used to launch different Operating Systems
70 without rebooting the PC or to debug system code.
72 @item
73 @cindex user mode emulation
74 User mode emulation. In this mode, QEMU can launch
75 processes compiled for one CPU on another CPU. It can be used to
76 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
77 to ease cross-compilation and cross-debugging.
79 @end itemize
81 QEMU can run without a host kernel driver and yet gives acceptable
82 performance.
84 For system emulation, the following hardware targets are supported:
85 @itemize
86 @cindex emulated target systems
87 @cindex supported target systems
88 @item PC (x86 or x86_64 processor)
89 @item ISA PC (old style PC without PCI bus)
90 @item PREP (PowerPC processor)
91 @item G3 Beige PowerMac (PowerPC processor)
92 @item Mac99 PowerMac (PowerPC processor, in progress)
93 @item Sun4m/Sun4c/Sun4d (32-bit Sparc processor)
94 @item Sun4u/Sun4v (64-bit Sparc processor, in progress)
95 @item Malta board (32-bit and 64-bit MIPS processors)
96 @item MIPS Magnum (64-bit MIPS processor)
97 @item ARM Integrator/CP (ARM)
98 @item ARM Versatile baseboard (ARM)
99 @item ARM RealView Emulation/Platform baseboard (ARM)
100 @item Spitz, Akita, Borzoi, Terrier and Tosa PDAs (PXA270 processor)
101 @item Luminary Micro LM3S811EVB (ARM Cortex-M3)
102 @item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
103 @item Freescale MCF5208EVB (ColdFire V2).
104 @item Arnewsh MCF5206 evaluation board (ColdFire V2).
105 @item Palm Tungsten|E PDA (OMAP310 processor)
106 @item N800 and N810 tablets (OMAP2420 processor)
107 @item MusicPal (MV88W8618 ARM processor)
108 @item Gumstix "Connex" and "Verdex" motherboards (PXA255/270).
109 @item Siemens SX1 smartphone (OMAP310 processor)
110 @item AXIS-Devboard88 (CRISv32 ETRAX-FS).
111 @item Petalogix Spartan 3aDSP1800 MMU ref design (MicroBlaze).
112 @item Avnet LX60/LX110/LX200 boards (Xtensa)
113 @end itemize
115 @cindex supported user mode targets
116 For user emulation, x86 (32 and 64 bit), PowerPC (32 and 64 bit),
117 ARM, MIPS (32 bit only), Sparc (32 and 64 bit),
118 Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
120 @node Installation
121 @chapter Installation
123 If you want to compile QEMU yourself, see @ref{compilation}.
125 @menu
126 * install_linux::   Linux
127 * install_windows:: Windows
128 * install_mac::     Macintosh
129 @end menu
131 @node install_linux
132 @section Linux
133 @cindex installation (Linux)
135 If a precompiled package is available for your distribution - you just
136 have to install it. Otherwise, see @ref{compilation}.
138 @node install_windows
139 @section Windows
140 @cindex installation (Windows)
142 Download the experimental binary installer at
143 @url{http://www.free.oszoo.org/@/download.html}.
144 TODO (no longer available)
146 @node install_mac
147 @section Mac OS X
149 Download the experimental binary installer at
150 @url{http://www.free.oszoo.org/@/download.html}.
151 TODO (no longer available)
153 @node QEMU PC System emulator
154 @chapter QEMU PC System emulator
155 @cindex system emulation (PC)
157 @menu
158 * pcsys_introduction:: Introduction
159 * pcsys_quickstart::   Quick Start
160 * sec_invocation::     Invocation
161 * pcsys_keys::         Keys
162 * pcsys_monitor::      QEMU Monitor
163 * disk_images::        Disk Images
164 * pcsys_network::      Network emulation
165 * pcsys_other_devs::   Other Devices
166 * direct_linux_boot::  Direct Linux Boot
167 * pcsys_usb::          USB emulation
168 * vnc_security::       VNC security
169 * gdb_usage::          GDB usage
170 * pcsys_os_specific::  Target OS specific information
171 @end menu
173 @node pcsys_introduction
174 @section Introduction
176 @c man begin DESCRIPTION
178 The QEMU PC System emulator simulates the
179 following peripherals:
181 @itemize @minus
182 @item
183 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
184 @item
185 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
186 extensions (hardware level, including all non standard modes).
187 @item
188 PS/2 mouse and keyboard
189 @item
190 2 PCI IDE interfaces with hard disk and CD-ROM support
191 @item
192 Floppy disk
193 @item
194 PCI and ISA network adapters
195 @item
196 Serial ports
197 @item
198 Creative SoundBlaster 16 sound card
199 @item
200 ENSONIQ AudioPCI ES1370 sound card
201 @item
202 Intel 82801AA AC97 Audio compatible sound card
203 @item
204 Intel HD Audio Controller and HDA codec
205 @item
206 Adlib (OPL2) - Yamaha YM3812 compatible chip
207 @item
208 Gravis Ultrasound GF1 sound card
209 @item
210 CS4231A compatible sound card
211 @item
212 PCI UHCI USB controller and a virtual USB hub.
213 @end itemize
215 SMP is supported with up to 255 CPUs.
217 QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL
218 VGA BIOS.
220 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
222 QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
223 by Tibor "TS" Schütz.
225 Note that, by default, GUS shares IRQ(7) with parallel ports and so
226 QEMU must be told to not have parallel ports to have working GUS.
228 @example
229 qemu-system-i386 dos.img -soundhw gus -parallel none
230 @end example
232 Alternatively:
233 @example
234 qemu-system-i386 dos.img -device gus,irq=5
235 @end example
237 Or some other unclaimed IRQ.
239 CS4231A is the chip used in Windows Sound System and GUSMAX products
241 @c man end
243 @node pcsys_quickstart
244 @section Quick Start
245 @cindex quick start
247 Download and uncompress the linux image (@file{linux.img}) and type:
249 @example
250 qemu-system-i386 linux.img
251 @end example
253 Linux should boot and give you a prompt.
255 @node sec_invocation
256 @section Invocation
258 @example
259 @c man begin SYNOPSIS
260 usage: qemu-system-i386 [options] [@var{disk_image}]
261 @c man end
262 @end example
264 @c man begin OPTIONS
265 @var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
266 targets do not need a disk image.
268 @include qemu-options.texi
270 @c man end
272 @node pcsys_keys
273 @section Keys
275 @c man begin OPTIONS
277 During the graphical emulation, you can use special key combinations to change
278 modes. The default key mappings are shown below, but if you use @code{-alt-grab}
279 then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use
280 @code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt):
282 @table @key
283 @item Ctrl-Alt-f
284 @kindex Ctrl-Alt-f
285 Toggle full screen
287 @item Ctrl-Alt-+
288 @kindex Ctrl-Alt-+
289 Enlarge the screen
291 @item Ctrl-Alt--
292 @kindex Ctrl-Alt--
293 Shrink the screen
295 @item Ctrl-Alt-u
296 @kindex Ctrl-Alt-u
297 Restore the screen's un-scaled dimensions
299 @item Ctrl-Alt-n
300 @kindex Ctrl-Alt-n
301 Switch to virtual console 'n'. Standard console mappings are:
302 @table @emph
303 @item 1
304 Target system display
305 @item 2
306 Monitor
307 @item 3
308 Serial port
309 @end table
311 @item Ctrl-Alt
312 @kindex Ctrl-Alt
313 Toggle mouse and keyboard grab.
314 @end table
316 @kindex Ctrl-Up
317 @kindex Ctrl-Down
318 @kindex Ctrl-PageUp
319 @kindex Ctrl-PageDown
320 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
321 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
323 @kindex Ctrl-a h
324 During emulation, if you are using the @option{-nographic} option, use
325 @key{Ctrl-a h} to get terminal commands:
327 @table @key
328 @item Ctrl-a h
329 @kindex Ctrl-a h
330 @item Ctrl-a ?
331 @kindex Ctrl-a ?
332 Print this help
333 @item Ctrl-a x
334 @kindex Ctrl-a x
335 Exit emulator
336 @item Ctrl-a s
337 @kindex Ctrl-a s
338 Save disk data back to file (if -snapshot)
339 @item Ctrl-a t
340 @kindex Ctrl-a t
341 Toggle console timestamps
342 @item Ctrl-a b
343 @kindex Ctrl-a b
344 Send break (magic sysrq in Linux)
345 @item Ctrl-a c
346 @kindex Ctrl-a c
347 Switch between console and monitor
348 @item Ctrl-a Ctrl-a
349 @kindex Ctrl-a a
350 Send Ctrl-a
351 @end table
352 @c man end
354 @ignore
356 @c man begin SEEALSO
357 The HTML documentation of QEMU for more precise information and Linux
358 user mode emulator invocation.
359 @c man end
361 @c man begin AUTHOR
362 Fabrice Bellard
363 @c man end
365 @end ignore
367 @node pcsys_monitor
368 @section QEMU Monitor
369 @cindex QEMU monitor
371 The QEMU monitor is used to give complex commands to the QEMU
372 emulator. You can use it to:
374 @itemize @minus
376 @item
377 Remove or insert removable media images
378 (such as CD-ROM or floppies).
380 @item
381 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
382 from a disk file.
384 @item Inspect the VM state without an external debugger.
386 @end itemize
388 @subsection Commands
390 The following commands are available:
392 @include qemu-monitor.texi
394 @subsection Integer expressions
396 The monitor understands integers expressions for every integer
397 argument. You can use register names to get the value of specifics
398 CPU registers by prefixing them with @emph{$}.
400 @node disk_images
401 @section Disk Images
403 Since version 0.6.1, QEMU supports many disk image formats, including
404 growable disk images (their size increase as non empty sectors are
405 written), compressed and encrypted disk images. Version 0.8.3 added
406 the new qcow2 disk image format which is essential to support VM
407 snapshots.
409 @menu
410 * disk_images_quickstart::    Quick start for disk image creation
411 * disk_images_snapshot_mode:: Snapshot mode
412 * vm_snapshots::              VM snapshots
413 * qemu_img_invocation::       qemu-img Invocation
414 * qemu_nbd_invocation::       qemu-nbd Invocation
415 * disk_images_formats::       Disk image file formats
416 * host_drives::               Using host drives
417 * disk_images_fat_images::    Virtual FAT disk images
418 * disk_images_nbd::           NBD access
419 * disk_images_sheepdog::      Sheepdog disk images
420 * disk_images_iscsi::         iSCSI LUNs
421 * disk_images_gluster::       GlusterFS disk images
422 * disk_images_ssh::           Secure Shell (ssh) disk images
423 @end menu
425 @node disk_images_quickstart
426 @subsection Quick start for disk image creation
428 You can create a disk image with the command:
429 @example
430 qemu-img create myimage.img mysize
431 @end example
432 where @var{myimage.img} is the disk image filename and @var{mysize} is its
433 size in kilobytes. You can add an @code{M} suffix to give the size in
434 megabytes and a @code{G} suffix for gigabytes.
436 See @ref{qemu_img_invocation} for more information.
438 @node disk_images_snapshot_mode
439 @subsection Snapshot mode
441 If you use the option @option{-snapshot}, all disk images are
442 considered as read only. When sectors in written, they are written in
443 a temporary file created in @file{/tmp}. You can however force the
444 write back to the raw disk images by using the @code{commit} monitor
445 command (or @key{C-a s} in the serial console).
447 @node vm_snapshots
448 @subsection VM snapshots
450 VM snapshots are snapshots of the complete virtual machine including
451 CPU state, RAM, device state and the content of all the writable
452 disks. In order to use VM snapshots, you must have at least one non
453 removable and writable block device using the @code{qcow2} disk image
454 format. Normally this device is the first virtual hard drive.
456 Use the monitor command @code{savevm} to create a new VM snapshot or
457 replace an existing one. A human readable name can be assigned to each
458 snapshot in addition to its numerical ID.
460 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
461 a VM snapshot. @code{info snapshots} lists the available snapshots
462 with their associated information:
464 @example
465 (qemu) info snapshots
466 Snapshot devices: hda
467 Snapshot list (from hda):
468 ID        TAG                 VM SIZE                DATE       VM CLOCK
469 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
470 2                                 40M 2006-08-06 12:43:29   00:00:18.633
471 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
472 @end example
474 A VM snapshot is made of a VM state info (its size is shown in
475 @code{info snapshots}) and a snapshot of every writable disk image.
476 The VM state info is stored in the first @code{qcow2} non removable
477 and writable block device. The disk image snapshots are stored in
478 every disk image. The size of a snapshot in a disk image is difficult
479 to evaluate and is not shown by @code{info snapshots} because the
480 associated disk sectors are shared among all the snapshots to save
481 disk space (otherwise each snapshot would need a full copy of all the
482 disk images).
484 When using the (unrelated) @code{-snapshot} option
485 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
486 but they are deleted as soon as you exit QEMU.
488 VM snapshots currently have the following known limitations:
489 @itemize
490 @item
491 They cannot cope with removable devices if they are removed or
492 inserted after a snapshot is done.
493 @item
494 A few device drivers still have incomplete snapshot support so their
495 state is not saved or restored properly (in particular USB).
496 @end itemize
498 @node qemu_img_invocation
499 @subsection @code{qemu-img} Invocation
501 @include qemu-img.texi
503 @node qemu_nbd_invocation
504 @subsection @code{qemu-nbd} Invocation
506 @include qemu-nbd.texi
508 @node disk_images_formats
509 @subsection Disk image file formats
511 QEMU supports many image file formats that can be used with VMs as well as with
512 any of the tools (like @code{qemu-img}). This includes the preferred formats
513 raw and qcow2 as well as formats that are supported for compatibility with
514 older QEMU versions or other hypervisors.
516 Depending on the image format, different options can be passed to
517 @code{qemu-img create} and @code{qemu-img convert} using the @code{-o} option.
518 This section describes each format and the options that are supported for it.
520 @table @option
521 @item raw
523 Raw disk image format. This format has the advantage of
524 being simple and easily exportable to all other emulators. If your
525 file system supports @emph{holes} (for example in ext2 or ext3 on
526 Linux or NTFS on Windows), then only the written sectors will reserve
527 space. Use @code{qemu-img info} to know the real size used by the
528 image or @code{ls -ls} on Unix/Linux.
530 Supported options:
531 @table @code
532 @item preallocation
533 Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
534 @code{falloc} mode preallocates space for image by calling posix_fallocate().
535 @code{full} mode preallocates space for image by writing zeros to underlying
536 storage.
537 @end table
539 @item qcow2
540 QEMU image format, the most versatile format. Use it to have smaller
541 images (useful if your filesystem does not supports holes, for example
542 on Windows), zlib based compression and support of multiple VM
543 snapshots.
545 Supported options:
546 @table @code
547 @item compat
548 Determines the qcow2 version to use. @code{compat=0.10} uses the
549 traditional image format that can be read by any QEMU since 0.10.
550 @code{compat=1.1} enables image format extensions that only QEMU 1.1 and
551 newer understand (this is the default). Amongst others, this includes
552 zero clusters, which allow efficient copy-on-read for sparse images.
554 @item backing_file
555 File name of a base image (see @option{create} subcommand)
556 @item backing_fmt
557 Image format of the base image
558 @item encryption
559 If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
561 The use of encryption in qcow and qcow2 images is considered to be flawed by
562 modern cryptography standards, suffering from a number of design problems:
564 @itemize @minus
565 @item The AES-CBC cipher is used with predictable initialization vectors based
566 on the sector number. This makes it vulnerable to chosen plaintext attacks
567 which can reveal the existence of encrypted data.
568 @item The user passphrase is directly used as the encryption key. A poorly
569 chosen or short passphrase will compromise the security of the encryption.
570 @item In the event of the passphrase being compromised there is no way to
571 change the passphrase to protect data in any qcow images. The files must
572 be cloned, using a different encryption passphrase in the new file. The
573 original file must then be securely erased using a program like shred,
574 though even this is ineffective with many modern storage technologies.
575 @end itemize
577 Use of qcow / qcow2 encryption with QEMU is deprecated, and support for
578 it will go away in a future release.  Users are recommended to use an
579 alternative encryption technology such as the Linux dm-crypt / LUKS
580 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'.  Can be set to @code{on} (default)
703 or @code{off}.  When set to @code{off}, new blocks will be created as
704 @code{PAYLOAD_BLOCK_NOT_PRESENT}, which means parsers are free to return
705 arbitrary data for those blocks.  Do not set to @code{off} when using
706 @code{qemu-img convert} with @code{subformat=dynamic}.
707 @item block_size
708 Block size; min 1 MB, max 256 MB.  0 means auto-calculate based on image size.
709 @item log_size
710 Log size; min 1 MB.
711 @end table
712 @end table
714 @subsubsection Read-only formats
715 More disk image file formats are supported in a read-only mode.
716 @table @option
717 @item bochs
718 Bochs images of @code{growing} type.
719 @item cloop
720 Linux Compressed Loop image, useful only to reuse directly compressed
721 CD-ROM images present for example in the Knoppix CD-ROMs.
722 @item dmg
723 Apple disk image.
724 @item parallels
725 Parallels disk image format.
726 @end table
729 @node host_drives
730 @subsection Using host drives
732 In addition to disk image files, QEMU can directly access host
733 devices. We describe here the usage for QEMU version >= 0.8.3.
735 @subsubsection Linux
737 On Linux, you can directly use the host device filename instead of a
738 disk image filename provided you have enough privileges to access
739 it. For example, use @file{/dev/cdrom} to access to the CDROM or
740 @file{/dev/fd0} for the floppy.
742 @table @code
743 @item CD
744 You can specify a CDROM device even if no CDROM is loaded. QEMU has
745 specific code to detect CDROM insertion or removal. CDROM ejection by
746 the guest OS is supported. Currently only data CDs are supported.
747 @item Floppy
748 You can specify a floppy device even if no floppy is loaded. Floppy
749 removal is currently not detected accurately (if you change floppy
750 without doing floppy access while the floppy is not loaded, the guest
751 OS will think that the same floppy is loaded).
752 @item Hard disks
753 Hard disks can be used. Normally you must specify the whole disk
754 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
755 see it as a partitioned disk. WARNING: unless you know what you do, it
756 is better to only make READ-ONLY accesses to the hard disk otherwise
757 you may corrupt your host data (use the @option{-snapshot} command
758 line option or modify the device permissions accordingly).
759 @end table
761 @subsubsection Windows
763 @table @code
764 @item CD
765 The preferred syntax is the drive letter (e.g. @file{d:}). The
766 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
767 supported as an alias to the first CDROM drive.
769 Currently there is no specific code to handle removable media, so it
770 is better to use the @code{change} or @code{eject} monitor commands to
771 change or eject media.
772 @item Hard disks
773 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
774 where @var{N} is the drive number (0 is the first hard disk).
776 WARNING: unless you know what you do, it is better to only make
777 READ-ONLY accesses to the hard disk otherwise you may corrupt your
778 host data (use the @option{-snapshot} command line so that the
779 modifications are written in a temporary file).
780 @end table
783 @subsubsection Mac OS X
785 @file{/dev/cdrom} is an alias to the first CDROM.
787 Currently there is no specific code to handle removable media, so it
788 is better to use the @code{change} or @code{eject} monitor commands to
789 change or eject media.
791 @node disk_images_fat_images
792 @subsection Virtual FAT disk images
794 QEMU can automatically create a virtual FAT disk image from a
795 directory tree. In order to use it, just type:
797 @example
798 qemu-system-i386 linux.img -hdb fat:/my_directory
799 @end example
801 Then you access access to all the files in the @file{/my_directory}
802 directory without having to copy them in a disk image or to export
803 them via SAMBA or NFS. The default access is @emph{read-only}.
805 Floppies can be emulated with the @code{:floppy:} option:
807 @example
808 qemu-system-i386 linux.img -fda fat:floppy:/my_directory
809 @end example
811 A read/write support is available for testing (beta stage) with the
812 @code{:rw:} option:
814 @example
815 qemu-system-i386 linux.img -fda fat:floppy:rw:/my_directory
816 @end example
818 What you should @emph{never} do:
819 @itemize
820 @item use non-ASCII filenames ;
821 @item use "-snapshot" together with ":rw:" ;
822 @item expect it to work when loadvm'ing ;
823 @item write to the FAT directory on the host system while accessing it with the guest system.
824 @end itemize
826 @node disk_images_nbd
827 @subsection NBD access
829 QEMU can access directly to block device exported using the Network Block Device
830 protocol.
832 @example
833 qemu-system-i386 linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/
834 @end example
836 If the NBD server is located on the same host, you can use an unix socket instead
837 of an inet socket:
839 @example
840 qemu-system-i386 linux.img -hdb nbd+unix://?socket=/tmp/my_socket
841 @end example
843 In this case, the block device must be exported using qemu-nbd:
845 @example
846 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
847 @end example
849 The use of qemu-nbd allows sharing of a disk between several guests:
850 @example
851 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
852 @end example
854 @noindent
855 and then you can use it with two guests:
856 @example
857 qemu-system-i386 linux1.img -hdb nbd+unix://?socket=/tmp/my_socket
858 qemu-system-i386 linux2.img -hdb nbd+unix://?socket=/tmp/my_socket
859 @end example
861 If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's
862 own embedded NBD server), you must specify an export name in the URI:
863 @example
864 qemu-system-i386 -cdrom nbd://localhost/debian-500-ppc-netinst
865 qemu-system-i386 -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst
866 @end example
868 The URI syntax for NBD is supported since QEMU 1.3.  An alternative syntax is
869 also available.  Here are some example of the older syntax:
870 @example
871 qemu-system-i386 linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
872 qemu-system-i386 linux2.img -hdb nbd:unix:/tmp/my_socket
873 qemu-system-i386 -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst
874 @end example
876 @node disk_images_sheepdog
877 @subsection Sheepdog disk images
879 Sheepdog is a distributed storage system for QEMU.  It provides highly
880 available block level storage volumes that can be attached to
881 QEMU-based virtual machines.
883 You can create a Sheepdog disk image with the command:
884 @example
885 qemu-img create sheepdog:///@var{image} @var{size}
886 @end example
887 where @var{image} is the Sheepdog image name and @var{size} is its
888 size.
890 To import the existing @var{filename} to Sheepdog, you can use a
891 convert command.
892 @example
893 qemu-img convert @var{filename} sheepdog:///@var{image}
894 @end example
896 You can boot from the Sheepdog disk image with the command:
897 @example
898 qemu-system-i386 sheepdog:///@var{image}
899 @end example
901 You can also create a snapshot of the Sheepdog image like qcow2.
902 @example
903 qemu-img snapshot -c @var{tag} sheepdog:///@var{image}
904 @end example
905 where @var{tag} is a tag name of the newly created snapshot.
907 To boot from the Sheepdog snapshot, specify the tag name of the
908 snapshot.
909 @example
910 qemu-system-i386 sheepdog:///@var{image}#@var{tag}
911 @end example
913 You can create a cloned image from the existing snapshot.
914 @example
915 qemu-img create -b sheepdog:///@var{base}#@var{tag} sheepdog:///@var{image}
916 @end example
917 where @var{base} is a image name of the source snapshot and @var{tag}
918 is its tag name.
920 You can use an unix socket instead of an inet socket:
922 @example
923 qemu-system-i386 sheepdog+unix:///@var{image}?socket=@var{path}
924 @end example
926 If the Sheepdog daemon doesn't run on the local host, you need to
927 specify one of the Sheepdog servers to connect to.
928 @example
929 qemu-img create sheepdog://@var{hostname}:@var{port}/@var{image} @var{size}
930 qemu-system-i386 sheepdog://@var{hostname}:@var{port}/@var{image}
931 @end example
933 @node disk_images_iscsi
934 @subsection iSCSI LUNs
936 iSCSI is a popular protocol used to access SCSI devices across a computer
937 network.
939 There are two different ways iSCSI devices can be used by QEMU.
941 The first method is to mount the iSCSI LUN on the host, and make it appear as
942 any other ordinary SCSI device on the host and then to access this device as a
943 /dev/sd device from QEMU. How to do this differs between host OSes.
945 The second method involves using the iSCSI initiator that is built into
946 QEMU. This provides a mechanism that works the same way regardless of which
947 host OS you are running QEMU on. This section will describe this second method
948 of using iSCSI together with QEMU.
950 In QEMU, iSCSI devices are described using special iSCSI URLs
952 @example
953 URL syntax:
954 iscsi://[<username>[%<password>]@@]<host>[:<port>]/<target-iqn-name>/<lun>
955 @end example
957 Username and password are optional and only used if your target is set up
958 using CHAP authentication for access control.
959 Alternatively the username and password can also be set via environment
960 variables to have these not show up in the process list
962 @example
963 export LIBISCSI_CHAP_USERNAME=<username>
964 export LIBISCSI_CHAP_PASSWORD=<password>
965 iscsi://<host>/<target-iqn-name>/<lun>
966 @end example
968 Various session related parameters can be set via special options, either
969 in a configuration file provided via '-readconfig' or directly on the
970 command line.
972 If the initiator-name is not specified qemu will use a default name
973 of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
974 virtual machine.
977 @example
978 Setting a specific initiator name to use when logging in to the target
979 -iscsi initiator-name=iqn.qemu.test:my-initiator
980 @end example
982 @example
983 Controlling which type of header digest to negotiate with the target
984 -iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
985 @end example
987 These can also be set via a configuration file
988 @example
989 [iscsi]
990   user = "CHAP username"
991   password = "CHAP password"
992   initiator-name = "iqn.qemu.test:my-initiator"
993   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
994   header-digest = "CRC32C"
995 @end example
998 Setting the target name allows different options for different targets
999 @example
1000 [iscsi "iqn.target.name"]
1001   user = "CHAP username"
1002   password = "CHAP password"
1003   initiator-name = "iqn.qemu.test:my-initiator"
1004   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
1005   header-digest = "CRC32C"
1006 @end example
1009 Howto use a configuration file to set iSCSI configuration options:
1010 @example
1011 cat >iscsi.conf <<EOF
1012 [iscsi]
1013   user = "me"
1014   password = "my password"
1015   initiator-name = "iqn.qemu.test:my-initiator"
1016   header-digest = "CRC32C"
1019 qemu-system-i386 -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1020     -readconfig iscsi.conf
1021 @end example
1024 Howto set up a simple iSCSI target on loopback and accessing it via QEMU:
1025 @example
1026 This example shows how to set up an iSCSI target with one CDROM and one DISK
1027 using the Linux STGT software target. This target is available on Red Hat based
1028 systems as the package 'scsi-target-utils'.
1030 tgtd --iscsi portal=127.0.0.1:3260
1031 tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
1032 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \
1033     -b /IMAGES/disk.img --device-type=disk
1034 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \
1035     -b /IMAGES/cd.iso --device-type=cd
1036 tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
1038 qemu-system-i386 -iscsi initiator-name=iqn.qemu.test:my-initiator \
1039     -boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1040     -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
1041 @end example
1043 @node disk_images_gluster
1044 @subsection GlusterFS disk images
1046 GlusterFS is an user space distributed file system.
1048 You can boot from the GlusterFS disk image with the command:
1049 @example
1050 qemu-system-x86_64 -drive file=gluster[+@var{transport}]://[@var{server}[:@var{port}]]/@var{volname}/@var{image}[?socket=...]
1051 @end example
1053 @var{gluster} is the protocol.
1055 @var{transport} specifies the transport type used to connect to gluster
1056 management daemon (glusterd). Valid transport types are
1057 tcp, unix and rdma. If a transport type isn't specified, then tcp
1058 type is assumed.
1060 @var{server} specifies the server where the volume file specification for
1061 the given volume resides. This can be either hostname, ipv4 address
1062 or ipv6 address. ipv6 address needs to be within square brackets [ ].
1063 If transport type is unix, then @var{server} field should not be specifed.
1064 Instead @var{socket} field needs to be populated with the path to unix domain
1065 socket.
1067 @var{port} is the port number on which glusterd is listening. This is optional
1068 and if not specified, QEMU will send 0 which will make gluster to use the
1069 default port. If the transport type is unix, then @var{port} should not be
1070 specified.
1072 @var{volname} is the name of the gluster volume which contains the disk image.
1074 @var{image} is the path to the actual disk image that resides on gluster volume.
1076 You can create a GlusterFS disk image with the command:
1077 @example
1078 qemu-img create gluster://@var{server}/@var{volname}/@var{image} @var{size}
1079 @end example
1081 Examples
1082 @example
1083 qemu-system-x86_64 -drive file=gluster://1.2.3.4/testvol/a.img
1084 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4/testvol/a.img
1085 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
1086 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
1087 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
1088 qemu-system-x86_64 -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
1089 qemu-system-x86_64 -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
1090 qemu-system-x86_64 -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
1091 @end example
1093 @node disk_images_ssh
1094 @subsection Secure Shell (ssh) disk images
1096 You can access disk images located on a remote ssh server
1097 by using the ssh protocol:
1099 @example
1100 qemu-system-x86_64 -drive file=ssh://[@var{user}@@]@var{server}[:@var{port}]/@var{path}[?host_key_check=@var{host_key_check}]
1101 @end example
1103 Alternative syntax using properties:
1105 @example
1106 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}]
1107 @end example
1109 @var{ssh} is the protocol.
1111 @var{user} is the remote user.  If not specified, then the local
1112 username is tried.
1114 @var{server} specifies the remote ssh server.  Any ssh server can be
1115 used, but it must implement the sftp-server protocol.  Most Unix/Linux
1116 systems should work without requiring any extra configuration.
1118 @var{port} is the port number on which sshd is listening.  By default
1119 the standard ssh port (22) is used.
1121 @var{path} is the path to the disk image.
1123 The optional @var{host_key_check} parameter controls how the remote
1124 host's key is checked.  The default is @code{yes} which means to use
1125 the local @file{.ssh/known_hosts} file.  Setting this to @code{no}
1126 turns off known-hosts checking.  Or you can check that the host key
1127 matches a specific fingerprint:
1128 @code{host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8}
1129 (@code{sha1:} can also be used as a prefix, but note that OpenSSH
1130 tools only use MD5 to print fingerprints).
1132 Currently authentication must be done using ssh-agent.  Other
1133 authentication methods may be supported in future.
1135 Note: Many ssh servers do not support an @code{fsync}-style operation.
1136 The ssh driver cannot guarantee that disk flush requests are
1137 obeyed, and this causes a risk of disk corruption if the remote
1138 server or network goes down during writes.  The driver will
1139 print a warning when @code{fsync} is not supported:
1141 warning: ssh server @code{ssh.example.com:22} does not support fsync
1143 With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is
1144 supported.
1146 @node pcsys_network
1147 @section Network emulation
1149 QEMU can simulate several network cards (PCI or ISA cards on the PC
1150 target) and can connect them to an arbitrary number of Virtual Local
1151 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1152 VLAN. VLAN can be connected between separate instances of QEMU to
1153 simulate large networks. For simpler usage, a non privileged user mode
1154 network stack can replace the TAP device to have a basic network
1155 connection.
1157 @subsection VLANs
1159 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1160 connection between several network devices. These devices can be for
1161 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1162 (TAP devices).
1164 @subsection Using TAP network interfaces
1166 This is the standard way to connect QEMU to a real network. QEMU adds
1167 a virtual network device on your host (called @code{tapN}), and you
1168 can then configure it as if it was a real ethernet card.
1170 @subsubsection Linux host
1172 As an example, you can download the @file{linux-test-xxx.tar.gz}
1173 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1174 configure properly @code{sudo} so that the command @code{ifconfig}
1175 contained in @file{qemu-ifup} can be executed as root. You must verify
1176 that your host kernel supports the TAP network interfaces: the
1177 device @file{/dev/net/tun} must be present.
1179 See @ref{sec_invocation} to have examples of command lines using the
1180 TAP network interfaces.
1182 @subsubsection Windows host
1184 There is a virtual ethernet driver for Windows 2000/XP systems, called
1185 TAP-Win32. But it is not included in standard QEMU for Windows,
1186 so you will need to get it separately. It is part of OpenVPN package,
1187 so download OpenVPN from : @url{http://openvpn.net/}.
1189 @subsection Using the user mode network stack
1191 By using the option @option{-net user} (default configuration if no
1192 @option{-net} option is specified), QEMU uses a completely user mode
1193 network stack (you don't need root privilege to use the virtual
1194 network). The virtual network configuration is the following:
1196 @example
1198          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1199                            |          (10.0.2.2)
1200                            |
1201                            ---->  DNS server (10.0.2.3)
1202                            |
1203                            ---->  SMB server (10.0.2.4)
1204 @end example
1206 The QEMU VM behaves as if it was behind a firewall which blocks all
1207 incoming connections. You can use a DHCP client to automatically
1208 configure the network in the QEMU VM. The DHCP server assign addresses
1209 to the hosts starting from 10.0.2.15.
1211 In order to check that the user mode network is working, you can ping
1212 the address 10.0.2.2 and verify that you got an address in the range
1213 10.0.2.x from the QEMU virtual DHCP server.
1215 Note that ICMP traffic in general does not work with user mode networking.
1216 @code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work,
1217 however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP
1218 ping sockets to allow @code{ping} to the Internet. The host admin has to set
1219 the ping_group_range in order to grant access to those sockets. To allow ping
1220 for GID 100 (usually users group):
1222 @example
1223 echo 100 100 > /proc/sys/net/ipv4/ping_group_range
1224 @end example
1226 When using the built-in TFTP server, the router is also the TFTP
1227 server.
1229 When using the @option{-redir} option, TCP or UDP connections can be
1230 redirected from the host to the guest. It allows for example to
1231 redirect X11, telnet or SSH connections.
1233 @subsection Connecting VLANs between QEMU instances
1235 Using the @option{-net socket} option, it is possible to make VLANs
1236 that span several QEMU instances. See @ref{sec_invocation} to have a
1237 basic example.
1239 @node pcsys_other_devs
1240 @section Other Devices
1242 @subsection Inter-VM Shared Memory device
1244 With KVM enabled on a Linux host, a shared memory device is available.  Guests
1245 map a POSIX shared memory region into the guest as a PCI device that enables
1246 zero-copy communication to the application level of the guests.  The basic
1247 syntax is:
1249 @example
1250 qemu-system-i386 -device ivshmem,size=<size in format accepted by -m>[,shm=<shm name>]
1251 @end example
1253 If desired, interrupts can be sent between guest VMs accessing the same shared
1254 memory region.  Interrupt support requires using a shared memory server and
1255 using a chardev socket to connect to it.  The code for the shared memory server
1256 is qemu.git/contrib/ivshmem-server.  An example syntax when using the shared
1257 memory server is:
1259 @example
1260 qemu-system-i386 -device ivshmem,size=<size in format accepted by -m>[,chardev=<id>]
1261                  [,msi=on][,ioeventfd=on][,vectors=n][,role=peer|master]
1262 qemu-system-i386 -chardev socket,path=<path>,id=<id>
1263 @end example
1265 When using the server, the guest will be assigned a VM ID (>=0) that allows guests
1266 using the same server to communicate via interrupts.  Guests can read their
1267 VM ID from a device register (see example code).  Since receiving the shared
1268 memory region from the server is asynchronous, there is a (small) chance the
1269 guest may boot before the shared memory is attached.  To allow an application
1270 to ensure shared memory is attached, the VM ID register will return -1 (an
1271 invalid VM ID) until the memory is attached.  Once the shared memory is
1272 attached, the VM ID will return the guest's valid VM ID.  With these semantics,
1273 the guest application can check to ensure the shared memory is attached to the
1274 guest before proceeding.
1276 The @option{role} argument can be set to either master or peer and will affect
1277 how the shared memory is migrated.  With @option{role=master}, the guest will
1278 copy the shared memory on migration to the destination host.  With
1279 @option{role=peer}, the guest will not be able to migrate with the device attached.
1280 With the @option{peer} case, the device should be detached and then reattached
1281 after migration using the PCI hotplug support.
1283 @node direct_linux_boot
1284 @section Direct Linux Boot
1286 This section explains how to launch a Linux kernel inside QEMU without
1287 having to make a full bootable image. It is very useful for fast Linux
1288 kernel testing.
1290 The syntax is:
1291 @example
1292 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1293 @end example
1295 Use @option{-kernel} to provide the Linux kernel image and
1296 @option{-append} to give the kernel command line arguments. The
1297 @option{-initrd} option can be used to provide an INITRD image.
1299 When using the direct Linux boot, a disk image for the first hard disk
1300 @file{hda} is required because its boot sector is used to launch the
1301 Linux kernel.
1303 If you do not need graphical output, you can disable it and redirect
1304 the virtual serial port and the QEMU monitor to the console with the
1305 @option{-nographic} option. The typical command line is:
1306 @example
1307 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1308                  -append "root=/dev/hda console=ttyS0" -nographic
1309 @end example
1311 Use @key{Ctrl-a c} to switch between the serial console and the
1312 monitor (@pxref{pcsys_keys}).
1314 @node pcsys_usb
1315 @section USB emulation
1317 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1318 virtual USB devices or real host USB devices (experimental, works only
1319 on Linux hosts).  QEMU will automatically create and connect virtual USB hubs
1320 as necessary to connect multiple USB devices.
1322 @menu
1323 * usb_devices::
1324 * host_usb_devices::
1325 @end menu
1326 @node usb_devices
1327 @subsection Connecting USB devices
1329 USB devices can be connected with the @option{-usbdevice} commandline option
1330 or the @code{usb_add} monitor command.  Available devices are:
1332 @table @code
1333 @item mouse
1334 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1335 @item tablet
1336 Pointer device that uses absolute coordinates (like a touchscreen).
1337 This means QEMU is able to report the mouse position without having
1338 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1339 @item disk:@var{file}
1340 Mass storage device based on @var{file} (@pxref{disk_images})
1341 @item host:@var{bus.addr}
1342 Pass through the host device identified by @var{bus.addr}
1343 (Linux only)
1344 @item host:@var{vendor_id:product_id}
1345 Pass through the host device identified by @var{vendor_id:product_id}
1346 (Linux only)
1347 @item wacom-tablet
1348 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
1349 above but it can be used with the tslib library because in addition to touch
1350 coordinates it reports touch pressure.
1351 @item keyboard
1352 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1353 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1354 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1355 device @var{dev}. The available character devices are the same as for the
1356 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1357 used to override the default 0403:6001. For instance,
1358 @example
1359 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1360 @end example
1361 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1362 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1363 @item braille
1364 Braille device.  This will use BrlAPI to display the braille output on a real
1365 or fake device.
1366 @item net:@var{options}
1367 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
1368 specifies NIC options as with @code{-net nic,}@var{options} (see description).
1369 For instance, user-mode networking can be used with
1370 @example
1371 qemu-system-i386 [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
1372 @end example
1373 Currently this cannot be used in machines that support PCI NICs.
1374 @item bt[:@var{hci-type}]
1375 Bluetooth dongle whose type is specified in the same format as with
1376 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
1377 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
1378 This USB device implements the USB Transport Layer of HCI.  Example
1379 usage:
1380 @example
1381 qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
1382 @end example
1383 @end table
1385 @node host_usb_devices
1386 @subsection Using host USB devices on a Linux host
1388 WARNING: this is an experimental feature. QEMU will slow down when
1389 using it. USB devices requiring real time streaming (i.e. USB Video
1390 Cameras) are not supported yet.
1392 @enumerate
1393 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1394 is actually using the USB device. A simple way to do that is simply to
1395 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1396 to @file{mydriver.o.disabled}.
1398 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1399 @example
1400 ls /proc/bus/usb
1401 001  devices  drivers
1402 @end example
1404 @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:
1405 @example
1406 chown -R myuid /proc/bus/usb
1407 @end example
1409 @item Launch QEMU and do in the monitor:
1410 @example
1411 info usbhost
1412   Device 1.2, speed 480 Mb/s
1413     Class 00: USB device 1234:5678, USB DISK
1414 @end example
1415 You should see the list of the devices you can use (Never try to use
1416 hubs, it won't work).
1418 @item Add the device in QEMU by using:
1419 @example
1420 usb_add host:1234:5678
1421 @end example
1423 Normally the guest OS should report that a new USB device is
1424 plugged. You can use the option @option{-usbdevice} to do the same.
1426 @item Now you can try to use the host USB device in QEMU.
1428 @end enumerate
1430 When relaunching QEMU, you may have to unplug and plug again the USB
1431 device to make it work again (this is a bug).
1433 @node vnc_security
1434 @section VNC security
1436 The VNC server capability provides access to the graphical console
1437 of the guest VM across the network. This has a number of security
1438 considerations depending on the deployment scenarios.
1440 @menu
1441 * vnc_sec_none::
1442 * vnc_sec_password::
1443 * vnc_sec_certificate::
1444 * vnc_sec_certificate_verify::
1445 * vnc_sec_certificate_pw::
1446 * vnc_sec_sasl::
1447 * vnc_sec_certificate_sasl::
1448 * vnc_generate_cert::
1449 * vnc_setup_sasl::
1450 @end menu
1451 @node vnc_sec_none
1452 @subsection Without passwords
1454 The simplest VNC server setup does not include any form of authentication.
1455 For this setup it is recommended to restrict it to listen on a UNIX domain
1456 socket only. For example
1458 @example
1459 qemu-system-i386 [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1460 @end example
1462 This ensures that only users on local box with read/write access to that
1463 path can access the VNC server. To securely access the VNC server from a
1464 remote machine, a combination of netcat+ssh can be used to provide a secure
1465 tunnel.
1467 @node vnc_sec_password
1468 @subsection With passwords
1470 The VNC protocol has limited support for password based authentication. Since
1471 the protocol limits passwords to 8 characters it should not be considered
1472 to provide high security. The password can be fairly easily brute-forced by
1473 a client making repeat connections. For this reason, a VNC server using password
1474 authentication should be restricted to only listen on the loopback interface
1475 or UNIX domain sockets. Password authentication is not supported when operating
1476 in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password
1477 authentication is requested with the @code{password} option, and then once QEMU
1478 is running the password is set with the monitor. Until the monitor is used to
1479 set the password all clients will be rejected.
1481 @example
1482 qemu-system-i386 [...OPTIONS...] -vnc :1,password -monitor stdio
1483 (qemu) change vnc password
1484 Password: ********
1485 (qemu)
1486 @end example
1488 @node vnc_sec_certificate
1489 @subsection With x509 certificates
1491 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1492 TLS for encryption of the session, and x509 certificates for authentication.
1493 The use of x509 certificates is strongly recommended, because TLS on its
1494 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1495 support provides a secure session, but no authentication. This allows any
1496 client to connect, and provides an encrypted session.
1498 @example
1499 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1500 @end example
1502 In the above example @code{/etc/pki/qemu} should contain at least three files,
1503 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1504 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1505 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1506 only be readable by the user owning it.
1508 @node vnc_sec_certificate_verify
1509 @subsection With x509 certificates and client verification
1511 Certificates can also provide a means to authenticate the client connecting.
1512 The server will request that the client provide a certificate, which it will
1513 then validate against the CA certificate. This is a good choice if deploying
1514 in an environment with a private internal certificate authority.
1516 @example
1517 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1518 @end example
1521 @node vnc_sec_certificate_pw
1522 @subsection With x509 certificates, client verification and passwords
1524 Finally, the previous method can be combined with VNC password authentication
1525 to provide two layers of authentication for clients.
1527 @example
1528 qemu-system-i386 [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1529 (qemu) change vnc password
1530 Password: ********
1531 (qemu)
1532 @end example
1535 @node vnc_sec_sasl
1536 @subsection With SASL authentication
1538 The SASL authentication method is a VNC extension, that provides an
1539 easily extendable, pluggable authentication method. This allows for
1540 integration with a wide range of authentication mechanisms, such as
1541 PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1542 The strength of the authentication depends on the exact mechanism
1543 configured. If the chosen mechanism also provides a SSF layer, then
1544 it will encrypt the datastream as well.
1546 Refer to the later docs on how to choose the exact SASL mechanism
1547 used for authentication, but assuming use of one supporting SSF,
1548 then QEMU can be launched with:
1550 @example
1551 qemu-system-i386 [...OPTIONS...] -vnc :1,sasl -monitor stdio
1552 @end example
1554 @node vnc_sec_certificate_sasl
1555 @subsection With x509 certificates and SASL authentication
1557 If the desired SASL authentication mechanism does not supported
1558 SSF layers, then it is strongly advised to run it in combination
1559 with TLS and x509 certificates. This provides securely encrypted
1560 data stream, avoiding risk of compromising of the security
1561 credentials. This can be enabled, by combining the 'sasl' option
1562 with the aforementioned TLS + x509 options:
1564 @example
1565 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1566 @end example
1569 @node vnc_generate_cert
1570 @subsection Generating certificates for VNC
1572 The GNU TLS packages provides a command called @code{certtool} which can
1573 be used to generate certificates and keys in PEM format. At a minimum it
1574 is necessary to setup a certificate authority, and issue certificates to
1575 each server. If using certificates for authentication, then each client
1576 will also need to be issued a certificate. The recommendation is for the
1577 server to keep its certificates in either @code{/etc/pki/qemu} or for
1578 unprivileged users in @code{$HOME/.pki/qemu}.
1580 @menu
1581 * vnc_generate_ca::
1582 * vnc_generate_server::
1583 * vnc_generate_client::
1584 @end menu
1585 @node vnc_generate_ca
1586 @subsubsection Setup the Certificate Authority
1588 This step only needs to be performed once per organization / organizational
1589 unit. First the CA needs a private key. This key must be kept VERY secret
1590 and secure. If this key is compromised the entire trust chain of the certificates
1591 issued with it is lost.
1593 @example
1594 # certtool --generate-privkey > ca-key.pem
1595 @end example
1597 A CA needs to have a public certificate. For simplicity it can be a self-signed
1598 certificate, or one issue by a commercial certificate issuing authority. To
1599 generate a self-signed certificate requires one core piece of information, the
1600 name of the organization.
1602 @example
1603 # cat > ca.info <<EOF
1604 cn = Name of your organization
1606 cert_signing_key
1608 # certtool --generate-self-signed \
1609            --load-privkey ca-key.pem
1610            --template ca.info \
1611            --outfile ca-cert.pem
1612 @end example
1614 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1615 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1617 @node vnc_generate_server
1618 @subsubsection Issuing server certificates
1620 Each server (or host) needs to be issued with a key and certificate. When connecting
1621 the certificate is sent to the client which validates it against the CA certificate.
1622 The core piece of information for a server certificate is the hostname. This should
1623 be the fully qualified hostname that the client will connect with, since the client
1624 will typically also verify the hostname in the certificate. On the host holding the
1625 secure CA private key:
1627 @example
1628 # cat > server.info <<EOF
1629 organization = Name  of your organization
1630 cn = server.foo.example.com
1631 tls_www_server
1632 encryption_key
1633 signing_key
1635 # certtool --generate-privkey > server-key.pem
1636 # certtool --generate-certificate \
1637            --load-ca-certificate ca-cert.pem \
1638            --load-ca-privkey ca-key.pem \
1639            --load-privkey server-key.pem \
1640            --template server.info \
1641            --outfile server-cert.pem
1642 @end example
1644 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1645 to the server for which they were generated. The @code{server-key.pem} is security
1646 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1648 @node vnc_generate_client
1649 @subsubsection Issuing client certificates
1651 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1652 certificates as its authentication mechanism, each client also needs to be issued
1653 a certificate. The client certificate contains enough metadata to uniquely identify
1654 the client, typically organization, state, city, building, etc. On the host holding
1655 the secure CA private key:
1657 @example
1658 # cat > client.info <<EOF
1659 country = GB
1660 state = London
1661 locality = London
1662 organization = Name of your organization
1663 cn = client.foo.example.com
1664 tls_www_client
1665 encryption_key
1666 signing_key
1668 # certtool --generate-privkey > client-key.pem
1669 # certtool --generate-certificate \
1670            --load-ca-certificate ca-cert.pem \
1671            --load-ca-privkey ca-key.pem \
1672            --load-privkey client-key.pem \
1673            --template client.info \
1674            --outfile client-cert.pem
1675 @end example
1677 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1678 copied to the client for which they were generated.
1681 @node vnc_setup_sasl
1683 @subsection Configuring SASL mechanisms
1685 The following documentation assumes use of the Cyrus SASL implementation on a
1686 Linux host, but the principals should apply to any other SASL impl. When SASL
1687 is enabled, the mechanism configuration will be loaded from system default
1688 SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1689 unprivileged user, an environment variable SASL_CONF_PATH can be used
1690 to make it search alternate locations for the service config.
1692 The default configuration might contain
1694 @example
1695 mech_list: digest-md5
1696 sasldb_path: /etc/qemu/passwd.db
1697 @end example
1699 This says to use the 'Digest MD5' mechanism, which is similar to the HTTP
1700 Digest-MD5 mechanism. The list of valid usernames & passwords is maintained
1701 in the /etc/qemu/passwd.db file, and can be updated using the saslpasswd2
1702 command. While this mechanism is easy to configure and use, it is not
1703 considered secure by modern standards, so only suitable for developers /
1704 ad-hoc testing.
1706 A more serious deployment might use Kerberos, which is done with the 'gssapi'
1707 mechanism
1709 @example
1710 mech_list: gssapi
1711 keytab: /etc/qemu/krb5.tab
1712 @end example
1714 For this to work the administrator of your KDC must generate a Kerberos
1715 principal for the server, with a name of  'qemu/somehost.example.com@@EXAMPLE.COM'
1716 replacing 'somehost.example.com' with the fully qualified host name of the
1717 machine running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm.
1719 Other configurations will be left as an exercise for the reader. It should
1720 be noted that only Digest-MD5 and GSSAPI provides a SSF layer for data
1721 encryption. For all other mechanisms, VNC should always be configured to
1722 use TLS and x509 certificates to protect security credentials from snooping.
1724 @node gdb_usage
1725 @section GDB usage
1727 QEMU has a primitive support to work with gdb, so that you can do
1728 'Ctrl-C' while the virtual machine is running and inspect its state.
1730 In order to use gdb, launch QEMU with the '-s' option. It will wait for a
1731 gdb connection:
1732 @example
1733 qemu-system-i386 -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1734                     -append "root=/dev/hda"
1735 Connected to host network interface: tun0
1736 Waiting gdb connection on port 1234
1737 @end example
1739 Then launch gdb on the 'vmlinux' executable:
1740 @example
1741 > gdb vmlinux
1742 @end example
1744 In gdb, connect to QEMU:
1745 @example
1746 (gdb) target remote localhost:1234
1747 @end example
1749 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1750 @example
1751 (gdb) c
1752 @end example
1754 Here are some useful tips in order to use gdb on system code:
1756 @enumerate
1757 @item
1758 Use @code{info reg} to display all the CPU registers.
1759 @item
1760 Use @code{x/10i $eip} to display the code at the PC position.
1761 @item
1762 Use @code{set architecture i8086} to dump 16 bit code. Then use
1763 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1764 @end enumerate
1766 Advanced debugging options:
1768 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:
1769 @table @code
1770 @item maintenance packet qqemu.sstepbits
1772 This will display the MASK bits used to control the single stepping IE:
1773 @example
1774 (gdb) maintenance packet qqemu.sstepbits
1775 sending: "qqemu.sstepbits"
1776 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1777 @end example
1778 @item maintenance packet qqemu.sstep
1780 This will display the current value of the mask used when single stepping IE:
1781 @example
1782 (gdb) maintenance packet qqemu.sstep
1783 sending: "qqemu.sstep"
1784 received: "0x7"
1785 @end example
1786 @item maintenance packet Qqemu.sstep=HEX_VALUE
1788 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1789 @example
1790 (gdb) maintenance packet Qqemu.sstep=0x5
1791 sending: "qemu.sstep=0x5"
1792 received: "OK"
1793 @end example
1794 @end table
1796 @node pcsys_os_specific
1797 @section Target OS specific information
1799 @subsection Linux
1801 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1802 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1803 color depth in the guest and the host OS.
1805 When using a 2.6 guest Linux kernel, you should add the option
1806 @code{clock=pit} on the kernel command line because the 2.6 Linux
1807 kernels make very strict real time clock checks by default that QEMU
1808 cannot simulate exactly.
1810 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1811 not activated because QEMU is slower with this patch. The QEMU
1812 Accelerator Module is also much slower in this case. Earlier Fedora
1813 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1814 patch by default. Newer kernels don't have it.
1816 @subsection Windows
1818 If you have a slow host, using Windows 95 is better as it gives the
1819 best speed. Windows 2000 is also a good choice.
1821 @subsubsection SVGA graphic modes support
1823 QEMU emulates a Cirrus Logic GD5446 Video
1824 card. All Windows versions starting from Windows 95 should recognize
1825 and use this graphic card. For optimal performances, use 16 bit color
1826 depth in the guest and the host OS.
1828 If you are using Windows XP as guest OS and if you want to use high
1829 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1830 1280x1024x16), then you should use the VESA VBE virtual graphic card
1831 (option @option{-std-vga}).
1833 @subsubsection CPU usage reduction
1835 Windows 9x does not correctly use the CPU HLT
1836 instruction. The result is that it takes host CPU cycles even when
1837 idle. You can install the utility from
1838 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1839 problem. Note that no such tool is needed for NT, 2000 or XP.
1841 @subsubsection Windows 2000 disk full problem
1843 Windows 2000 has a bug which gives a disk full problem during its
1844 installation. When installing it, use the @option{-win2k-hack} QEMU
1845 option to enable a specific workaround. After Windows 2000 is
1846 installed, you no longer need this option (this option slows down the
1847 IDE transfers).
1849 @subsubsection Windows 2000 shutdown
1851 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1852 can. It comes from the fact that Windows 2000 does not automatically
1853 use the APM driver provided by the BIOS.
1855 In order to correct that, do the following (thanks to Struan
1856 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1857 Add/Troubleshoot a device => Add a new device & Next => No, select the
1858 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1859 (again) a few times. Now the driver is installed and Windows 2000 now
1860 correctly instructs QEMU to shutdown at the appropriate moment.
1862 @subsubsection Share a directory between Unix and Windows
1864 See @ref{sec_invocation} about the help of the option @option{-smb}.
1866 @subsubsection Windows XP security problem
1868 Some releases of Windows XP install correctly but give a security
1869 error when booting:
1870 @example
1871 A problem is preventing Windows from accurately checking the
1872 license for this computer. Error code: 0x800703e6.
1873 @end example
1875 The workaround is to install a service pack for XP after a boot in safe
1876 mode. Then reboot, and the problem should go away. Since there is no
1877 network while in safe mode, its recommended to download the full
1878 installation of SP1 or SP2 and transfer that via an ISO or using the
1879 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1881 @subsection MS-DOS and FreeDOS
1883 @subsubsection CPU usage reduction
1885 DOS does not correctly use the CPU HLT instruction. The result is that
1886 it takes host CPU cycles even when idle. You can install the utility
1887 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1888 problem.
1890 @node QEMU System emulator for non PC targets
1891 @chapter QEMU System emulator for non PC targets
1893 QEMU is a generic emulator and it emulates many non PC
1894 machines. Most of the options are similar to the PC emulator. The
1895 differences are mentioned in the following sections.
1897 @menu
1898 * PowerPC System emulator::
1899 * Sparc32 System emulator::
1900 * Sparc64 System emulator::
1901 * MIPS System emulator::
1902 * ARM System emulator::
1903 * ColdFire System emulator::
1904 * Cris System emulator::
1905 * Microblaze System emulator::
1906 * SH4 System emulator::
1907 * Xtensa System emulator::
1908 @end menu
1910 @node PowerPC System emulator
1911 @section PowerPC System emulator
1912 @cindex system emulation (PowerPC)
1914 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1915 or PowerMac PowerPC system.
1917 QEMU emulates the following PowerMac peripherals:
1919 @itemize @minus
1920 @item
1921 UniNorth or Grackle PCI Bridge
1922 @item
1923 PCI VGA compatible card with VESA Bochs Extensions
1924 @item
1925 2 PMAC IDE interfaces with hard disk and CD-ROM support
1926 @item
1927 NE2000 PCI adapters
1928 @item
1929 Non Volatile RAM
1930 @item
1931 VIA-CUDA with ADB keyboard and mouse.
1932 @end itemize
1934 QEMU emulates the following PREP peripherals:
1936 @itemize @minus
1937 @item
1938 PCI Bridge
1939 @item
1940 PCI VGA compatible card with VESA Bochs Extensions
1941 @item
1942 2 IDE interfaces with hard disk and CD-ROM support
1943 @item
1944 Floppy disk
1945 @item
1946 NE2000 network adapters
1947 @item
1948 Serial port
1949 @item
1950 PREP Non Volatile RAM
1951 @item
1952 PC compatible keyboard and mouse.
1953 @end itemize
1955 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1956 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1958 Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
1959 for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
1960 v2) portable firmware implementation. The goal is to implement a 100%
1961 IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
1963 @c man begin OPTIONS
1965 The following options are specific to the PowerPC emulation:
1967 @table @option
1969 @item -g @var{W}x@var{H}[x@var{DEPTH}]
1971 Set the initial VGA graphic mode. The default is 800x600x32.
1973 @item -prom-env @var{string}
1975 Set OpenBIOS variables in NVRAM, for example:
1977 @example
1978 qemu-system-ppc -prom-env 'auto-boot?=false' \
1979  -prom-env 'boot-device=hd:2,\yaboot' \
1980  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
1981 @end example
1983 These variables are not used by Open Hack'Ware.
1985 @end table
1987 @c man end
1990 More information is available at
1991 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1993 @node Sparc32 System emulator
1994 @section Sparc32 System emulator
1995 @cindex system emulation (Sparc32)
1997 Use the executable @file{qemu-system-sparc} to simulate the following
1998 Sun4m architecture machines:
1999 @itemize @minus
2000 @item
2001 SPARCstation 4
2002 @item
2003 SPARCstation 5
2004 @item
2005 SPARCstation 10
2006 @item
2007 SPARCstation 20
2008 @item
2009 SPARCserver 600MP
2010 @item
2011 SPARCstation LX
2012 @item
2013 SPARCstation Voyager
2014 @item
2015 SPARCclassic
2016 @item
2017 SPARCbook
2018 @end itemize
2020 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
2021 but Linux limits the number of usable CPUs to 4.
2023 QEMU emulates the following sun4m peripherals:
2025 @itemize @minus
2026 @item
2027 IOMMU
2028 @item
2029 TCX or cgthree Frame buffer
2030 @item
2031 Lance (Am7990) Ethernet
2032 @item
2033 Non Volatile RAM M48T02/M48T08
2034 @item
2035 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2036 and power/reset logic
2037 @item
2038 ESP SCSI controller with hard disk and CD-ROM support
2039 @item
2040 Floppy drive (not on SS-600MP)
2041 @item
2042 CS4231 sound device (only on SS-5, not working yet)
2043 @end itemize
2045 The number of peripherals is fixed in the architecture.  Maximum
2046 memory size depends on the machine type, for SS-5 it is 256MB and for
2047 others 2047MB.
2049 Since version 0.8.2, QEMU uses OpenBIOS
2050 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2051 firmware implementation. The goal is to implement a 100% IEEE
2052 1275-1994 (referred to as Open Firmware) compliant firmware.
2054 A sample Linux 2.6 series kernel and ram disk image are available on
2055 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
2056 most kernel versions work. Please note that currently older Solaris kernels
2057 don't work probably due to interface issues between OpenBIOS and
2058 Solaris.
2060 @c man begin OPTIONS
2062 The following options are specific to the Sparc32 emulation:
2064 @table @option
2066 @item -g @var{W}x@var{H}x[x@var{DEPTH}]
2068 Set the initial graphics mode. For TCX, the default is 1024x768x8 with the
2069 option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
2070 of 1152x900x8 for people who wish to use OBP.
2072 @item -prom-env @var{string}
2074 Set OpenBIOS variables in NVRAM, for example:
2076 @example
2077 qemu-system-sparc -prom-env 'auto-boot?=false' \
2078  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2079 @end example
2081 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]
2083 Set the emulated machine type. Default is SS-5.
2085 @end table
2087 @c man end
2089 @node Sparc64 System emulator
2090 @section Sparc64 System emulator
2091 @cindex system emulation (Sparc64)
2093 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
2094 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
2095 Niagara (T1) machine. The Sun4u emulator is mostly complete, being
2096 able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The
2097 Sun4v and Niagara emulators are still a work in progress.
2099 QEMU emulates the following peripherals:
2101 @itemize @minus
2102 @item
2103 UltraSparc IIi APB PCI Bridge
2104 @item
2105 PCI VGA compatible card with VESA Bochs Extensions
2106 @item
2107 PS/2 mouse and keyboard
2108 @item
2109 Non Volatile RAM M48T59
2110 @item
2111 PC-compatible serial ports
2112 @item
2113 2 PCI IDE interfaces with hard disk and CD-ROM support
2114 @item
2115 Floppy disk
2116 @end itemize
2118 @c man begin OPTIONS
2120 The following options are specific to the Sparc64 emulation:
2122 @table @option
2124 @item -prom-env @var{string}
2126 Set OpenBIOS variables in NVRAM, for example:
2128 @example
2129 qemu-system-sparc64 -prom-env 'auto-boot?=false'
2130 @end example
2132 @item -M [sun4u|sun4v|Niagara]
2134 Set the emulated machine type. The default is sun4u.
2136 @end table
2138 @c man end
2140 @node MIPS System emulator
2141 @section MIPS System emulator
2142 @cindex system emulation (MIPS)
2144 Four executables cover simulation of 32 and 64-bit MIPS systems in
2145 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2146 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2147 Five different machine types are emulated:
2149 @itemize @minus
2150 @item
2151 A generic ISA PC-like machine "mips"
2152 @item
2153 The MIPS Malta prototype board "malta"
2154 @item
2155 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2156 @item
2157 MIPS emulator pseudo board "mipssim"
2158 @item
2159 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2160 @end itemize
2162 The generic emulation is supported by Debian 'Etch' and is able to
2163 install Debian into a virtual disk image. The following devices are
2164 emulated:
2166 @itemize @minus
2167 @item
2168 A range of MIPS CPUs, default is the 24Kf
2169 @item
2170 PC style serial port
2171 @item
2172 PC style IDE disk
2173 @item
2174 NE2000 network card
2175 @end itemize
2177 The Malta emulation supports the following devices:
2179 @itemize @minus
2180 @item
2181 Core board with MIPS 24Kf CPU and Galileo system controller
2182 @item
2183 PIIX4 PCI/USB/SMbus controller
2184 @item
2185 The Multi-I/O chip's serial device
2186 @item
2187 PCI network cards (PCnet32 and others)
2188 @item
2189 Malta FPGA serial device
2190 @item
2191 Cirrus (default) or any other PCI VGA graphics card
2192 @end itemize
2194 The ACER Pica emulation supports:
2196 @itemize @minus
2197 @item
2198 MIPS R4000 CPU
2199 @item
2200 PC-style IRQ and DMA controllers
2201 @item
2202 PC Keyboard
2203 @item
2204 IDE controller
2205 @end itemize
2207 The mipssim pseudo board emulation provides an environment similar
2208 to what the proprietary MIPS emulator uses for running Linux.
2209 It supports:
2211 @itemize @minus
2212 @item
2213 A range of MIPS CPUs, default is the 24Kf
2214 @item
2215 PC style serial port
2216 @item
2217 MIPSnet network emulation
2218 @end itemize
2220 The MIPS Magnum R4000 emulation supports:
2222 @itemize @minus
2223 @item
2224 MIPS R4000 CPU
2225 @item
2226 PC-style IRQ controller
2227 @item
2228 PC Keyboard
2229 @item
2230 SCSI controller
2231 @item
2232 G364 framebuffer
2233 @end itemize
2236 @node ARM System emulator
2237 @section ARM System emulator
2238 @cindex system emulation (ARM)
2240 Use the executable @file{qemu-system-arm} to simulate a ARM
2241 machine. The ARM Integrator/CP board is emulated with the following
2242 devices:
2244 @itemize @minus
2245 @item
2246 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2247 @item
2248 Two PL011 UARTs
2249 @item
2250 SMC 91c111 Ethernet adapter
2251 @item
2252 PL110 LCD controller
2253 @item
2254 PL050 KMI with PS/2 keyboard and mouse.
2255 @item
2256 PL181 MultiMedia Card Interface with SD card.
2257 @end itemize
2259 The ARM Versatile baseboard is emulated with the following devices:
2261 @itemize @minus
2262 @item
2263 ARM926E, ARM1136 or Cortex-A8 CPU
2264 @item
2265 PL190 Vectored Interrupt Controller
2266 @item
2267 Four PL011 UARTs
2268 @item
2269 SMC 91c111 Ethernet adapter
2270 @item
2271 PL110 LCD controller
2272 @item
2273 PL050 KMI with PS/2 keyboard and mouse.
2274 @item
2275 PCI host bridge.  Note the emulated PCI bridge only provides access to
2276 PCI memory space.  It does not provide access to PCI IO space.
2277 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2278 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2279 mapped control registers.
2280 @item
2281 PCI OHCI USB controller.
2282 @item
2283 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2284 @item
2285 PL181 MultiMedia Card Interface with SD card.
2286 @end itemize
2288 Several variants of the ARM RealView baseboard are emulated,
2289 including the EB, PB-A8 and PBX-A9.  Due to interactions with the
2290 bootloader, only certain Linux kernel configurations work out
2291 of the box on these boards.
2293 Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2294 enabled in the kernel, and expect 512M RAM.  Kernels for The PBX-A9 board
2295 should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2296 disabled and expect 1024M RAM.
2298 The following devices are emulated:
2300 @itemize @minus
2301 @item
2302 ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
2303 @item
2304 ARM AMBA Generic/Distributed Interrupt Controller
2305 @item
2306 Four PL011 UARTs
2307 @item
2308 SMC 91c111 or SMSC LAN9118 Ethernet adapter
2309 @item
2310 PL110 LCD controller
2311 @item
2312 PL050 KMI with PS/2 keyboard and mouse
2313 @item
2314 PCI host bridge
2315 @item
2316 PCI OHCI USB controller
2317 @item
2318 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2319 @item
2320 PL181 MultiMedia Card Interface with SD card.
2321 @end itemize
2323 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2324 and "Terrier") emulation includes the following peripherals:
2326 @itemize @minus
2327 @item
2328 Intel PXA270 System-on-chip (ARM V5TE core)
2329 @item
2330 NAND Flash memory
2331 @item
2332 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2333 @item
2334 On-chip OHCI USB controller
2335 @item
2336 On-chip LCD controller
2337 @item
2338 On-chip Real Time Clock
2339 @item
2340 TI ADS7846 touchscreen controller on SSP bus
2341 @item
2342 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2343 @item
2344 GPIO-connected keyboard controller and LEDs
2345 @item
2346 Secure Digital card connected to PXA MMC/SD host
2347 @item
2348 Three on-chip UARTs
2349 @item
2350 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2351 @end itemize
2353 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2354 following elements:
2356 @itemize @minus
2357 @item
2358 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2359 @item
2360 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2361 @item
2362 On-chip LCD controller
2363 @item
2364 On-chip Real Time Clock
2365 @item
2366 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2367 CODEC, connected through MicroWire and I@math{^2}S busses
2368 @item
2369 GPIO-connected matrix keypad
2370 @item
2371 Secure Digital card connected to OMAP MMC/SD host
2372 @item
2373 Three on-chip UARTs
2374 @end itemize
2376 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2377 emulation supports the following elements:
2379 @itemize @minus
2380 @item
2381 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2382 @item
2383 RAM and non-volatile OneNAND Flash memories
2384 @item
2385 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2386 display controller and a LS041y3 MIPI DBI-C controller
2387 @item
2388 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2389 driven through SPI bus
2390 @item
2391 National Semiconductor LM8323-controlled qwerty keyboard driven
2392 through I@math{^2}C bus
2393 @item
2394 Secure Digital card connected to OMAP MMC/SD host
2395 @item
2396 Three OMAP on-chip UARTs and on-chip STI debugging console
2397 @item
2398 A Bluetooth(R) transceiver and HCI connected to an UART
2399 @item
2400 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2401 TUSB6010 chip - only USB host mode is supported
2402 @item
2403 TI TMP105 temperature sensor driven through I@math{^2}C bus
2404 @item
2405 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2406 @item
2407 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2408 through CBUS
2409 @end itemize
2411 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2412 devices:
2414 @itemize @minus
2415 @item
2416 Cortex-M3 CPU core.
2417 @item
2418 64k Flash and 8k SRAM.
2419 @item
2420 Timers, UARTs, ADC and I@math{^2}C interface.
2421 @item
2422 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2423 @end itemize
2425 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2426 devices:
2428 @itemize @minus
2429 @item
2430 Cortex-M3 CPU core.
2431 @item
2432 256k Flash and 64k SRAM.
2433 @item
2434 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2435 @item
2436 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2437 @end itemize
2439 The Freecom MusicPal internet radio emulation includes the following
2440 elements:
2442 @itemize @minus
2443 @item
2444 Marvell MV88W8618 ARM core.
2445 @item
2446 32 MB RAM, 256 KB SRAM, 8 MB flash.
2447 @item
2448 Up to 2 16550 UARTs
2449 @item
2450 MV88W8xx8 Ethernet controller
2451 @item
2452 MV88W8618 audio controller, WM8750 CODEC and mixer
2453 @item
2454 128×64 display with brightness control
2455 @item
2456 2 buttons, 2 navigation wheels with button function
2457 @end itemize
2459 The Siemens SX1 models v1 and v2 (default) basic emulation.
2460 The emulation includes the following elements:
2462 @itemize @minus
2463 @item
2464 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2465 @item
2466 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2468 1 Flash of 16MB and 1 Flash of 8MB
2470 1 Flash of 32MB
2471 @item
2472 On-chip LCD controller
2473 @item
2474 On-chip Real Time Clock
2475 @item
2476 Secure Digital card connected to OMAP MMC/SD host
2477 @item
2478 Three on-chip UARTs
2479 @end itemize
2481 A Linux 2.6 test image is available on the QEMU web site. More
2482 information is available in the QEMU mailing-list archive.
2484 @c man begin OPTIONS
2486 The following options are specific to the ARM emulation:
2488 @table @option
2490 @item -semihosting
2491 Enable semihosting syscall emulation.
2493 On ARM this implements the "Angel" interface.
2495 Note that this allows guest direct access to the host filesystem,
2496 so should only be used with trusted guest OS.
2498 @end table
2500 @node ColdFire System emulator
2501 @section ColdFire System emulator
2502 @cindex system emulation (ColdFire)
2503 @cindex system emulation (M68K)
2505 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2506 The emulator is able to boot a uClinux kernel.
2508 The M5208EVB emulation includes the following devices:
2510 @itemize @minus
2511 @item
2512 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2513 @item
2514 Three Two on-chip UARTs.
2515 @item
2516 Fast Ethernet Controller (FEC)
2517 @end itemize
2519 The AN5206 emulation includes the following devices:
2521 @itemize @minus
2522 @item
2523 MCF5206 ColdFire V2 Microprocessor.
2524 @item
2525 Two on-chip UARTs.
2526 @end itemize
2528 @c man begin OPTIONS
2530 The following options are specific to the ColdFire emulation:
2532 @table @option
2534 @item -semihosting
2535 Enable semihosting syscall emulation.
2537 On M68K this implements the "ColdFire GDB" interface used by libgloss.
2539 Note that this allows guest direct access to the host filesystem,
2540 so should only be used with trusted guest OS.
2542 @end table
2544 @node Cris System emulator
2545 @section Cris System emulator
2546 @cindex system emulation (Cris)
2548 TODO
2550 @node Microblaze System emulator
2551 @section Microblaze System emulator
2552 @cindex system emulation (Microblaze)
2554 TODO
2556 @node SH4 System emulator
2557 @section SH4 System emulator
2558 @cindex system emulation (SH4)
2560 TODO
2562 @node Xtensa System emulator
2563 @section Xtensa System emulator
2564 @cindex system emulation (Xtensa)
2566 Two executables cover simulation of both Xtensa endian options,
2567 @file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}.
2568 Two different machine types are emulated:
2570 @itemize @minus
2571 @item
2572 Xtensa emulator pseudo board "sim"
2573 @item
2574 Avnet LX60/LX110/LX200 board
2575 @end itemize
2577 The sim pseudo board emulation provides an environment similar
2578 to one provided by the proprietary Tensilica ISS.
2579 It supports:
2581 @itemize @minus
2582 @item
2583 A range of Xtensa CPUs, default is the DC232B
2584 @item
2585 Console and filesystem access via semihosting calls
2586 @end itemize
2588 The Avnet LX60/LX110/LX200 emulation supports:
2590 @itemize @minus
2591 @item
2592 A range of Xtensa CPUs, default is the DC232B
2593 @item
2594 16550 UART
2595 @item
2596 OpenCores 10/100 Mbps Ethernet MAC
2597 @end itemize
2599 @c man begin OPTIONS
2601 The following options are specific to the Xtensa emulation:
2603 @table @option
2605 @item -semihosting
2606 Enable semihosting syscall emulation.
2608 Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select.
2609 Tensilica baremetal libc for ISS and linux platform "sim" use this interface.
2611 Note that this allows guest direct access to the host filesystem,
2612 so should only be used with trusted guest OS.
2614 @end table
2615 @node QEMU User space emulator
2616 @chapter QEMU User space emulator
2618 @menu
2619 * Supported Operating Systems ::
2620 * Linux User space emulator::
2621 * BSD User space emulator ::
2622 @end menu
2624 @node Supported Operating Systems
2625 @section Supported Operating Systems
2627 The following OS are supported in user space emulation:
2629 @itemize @minus
2630 @item
2631 Linux (referred as qemu-linux-user)
2632 @item
2633 BSD (referred as qemu-bsd-user)
2634 @end itemize
2636 @node Linux User space emulator
2637 @section Linux User space emulator
2639 @menu
2640 * Quick Start::
2641 * Wine launch::
2642 * Command line options::
2643 * Other binaries::
2644 @end menu
2646 @node Quick Start
2647 @subsection Quick Start
2649 In order to launch a Linux process, QEMU needs the process executable
2650 itself and all the target (x86) dynamic libraries used by it.
2652 @itemize
2654 @item On x86, you can just try to launch any process by using the native
2655 libraries:
2657 @example
2658 qemu-i386 -L / /bin/ls
2659 @end example
2661 @code{-L /} tells that the x86 dynamic linker must be searched with a
2662 @file{/} prefix.
2664 @item Since QEMU is also a linux process, you can launch QEMU with
2665 QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
2667 @example
2668 qemu-i386 -L / qemu-i386 -L / /bin/ls
2669 @end example
2671 @item On non x86 CPUs, you need first to download at least an x86 glibc
2672 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2673 @code{LD_LIBRARY_PATH} is not set:
2675 @example
2676 unset LD_LIBRARY_PATH
2677 @end example
2679 Then you can launch the precompiled @file{ls} x86 executable:
2681 @example
2682 qemu-i386 tests/i386/ls
2683 @end example
2684 You can look at @file{scripts/qemu-binfmt-conf.sh} so that
2685 QEMU is automatically launched by the Linux kernel when you try to
2686 launch x86 executables. It requires the @code{binfmt_misc} module in the
2687 Linux kernel.
2689 @item The x86 version of QEMU is also included. You can try weird things such as:
2690 @example
2691 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2692           /usr/local/qemu-i386/bin/ls-i386
2693 @end example
2695 @end itemize
2697 @node Wine launch
2698 @subsection Wine launch
2700 @itemize
2702 @item Ensure that you have a working QEMU with the x86 glibc
2703 distribution (see previous section). In order to verify it, you must be
2704 able to do:
2706 @example
2707 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2708 @end example
2710 @item Download the binary x86 Wine install
2711 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2713 @item Configure Wine on your account. Look at the provided script
2714 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2715 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2717 @item Then you can try the example @file{putty.exe}:
2719 @example
2720 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2721           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2722 @end example
2724 @end itemize
2726 @node Command line options
2727 @subsection Command line options
2729 @example
2730 usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
2731 @end example
2733 @table @option
2734 @item -h
2735 Print the help
2736 @item -L path
2737 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2738 @item -s size
2739 Set the x86 stack size in bytes (default=524288)
2740 @item -cpu model
2741 Select CPU model (-cpu help for list and additional feature selection)
2742 @item -E @var{var}=@var{value}
2743 Set environment @var{var} to @var{value}.
2744 @item -U @var{var}
2745 Remove @var{var} from the environment.
2746 @item -B offset
2747 Offset guest address by the specified number of bytes.  This is useful when
2748 the address region required by guest applications is reserved on the host.
2749 This option is currently only supported on some hosts.
2750 @item -R size
2751 Pre-allocate a guest virtual address space of the given size (in bytes).
2752 "G", "M", and "k" suffixes may be used when specifying the size.
2753 @end table
2755 Debug options:
2757 @table @option
2758 @item -d item1,...
2759 Activate logging of the specified items (use '-d help' for a list of log items)
2760 @item -p pagesize
2761 Act as if the host page size was 'pagesize' bytes
2762 @item -g port
2763 Wait gdb connection to port
2764 @item -singlestep
2765 Run the emulation in single step mode.
2766 @end table
2768 Environment variables:
2770 @table @env
2771 @item QEMU_STRACE
2772 Print system calls and arguments similar to the 'strace' program
2773 (NOTE: the actual 'strace' program will not work because the user
2774 space emulator hasn't implemented ptrace).  At the moment this is
2775 incomplete.  All system calls that don't have a specific argument
2776 format are printed with information for six arguments.  Many
2777 flag-style arguments don't have decoders and will show up as numbers.
2778 @end table
2780 @node Other binaries
2781 @subsection Other binaries
2783 @cindex user mode (Alpha)
2784 @command{qemu-alpha} TODO.
2786 @cindex user mode (ARM)
2787 @command{qemu-armeb} TODO.
2789 @cindex user mode (ARM)
2790 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2791 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2792 configurations), and arm-uclinux bFLT format binaries.
2794 @cindex user mode (ColdFire)
2795 @cindex user mode (M68K)
2796 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2797 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2798 coldfire uClinux bFLT format binaries.
2800 The binary format is detected automatically.
2802 @cindex user mode (Cris)
2803 @command{qemu-cris} TODO.
2805 @cindex user mode (i386)
2806 @command{qemu-i386} TODO.
2807 @command{qemu-x86_64} TODO.
2809 @cindex user mode (Microblaze)
2810 @command{qemu-microblaze} TODO.
2812 @cindex user mode (MIPS)
2813 @command{qemu-mips} TODO.
2814 @command{qemu-mipsel} TODO.
2816 @cindex user mode (PowerPC)
2817 @command{qemu-ppc64abi32} TODO.
2818 @command{qemu-ppc64} TODO.
2819 @command{qemu-ppc} TODO.
2821 @cindex user mode (SH4)
2822 @command{qemu-sh4eb} TODO.
2823 @command{qemu-sh4} TODO.
2825 @cindex user mode (SPARC)
2826 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2828 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2829 (Sparc64 CPU, 32 bit ABI).
2831 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2832 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2834 @node BSD User space emulator
2835 @section BSD User space emulator
2837 @menu
2838 * BSD Status::
2839 * BSD Quick Start::
2840 * BSD Command line options::
2841 @end menu
2843 @node BSD Status
2844 @subsection BSD Status
2846 @itemize @minus
2847 @item
2848 target Sparc64 on Sparc64: Some trivial programs work.
2849 @end itemize
2851 @node BSD Quick Start
2852 @subsection Quick Start
2854 In order to launch a BSD process, QEMU needs the process executable
2855 itself and all the target dynamic libraries used by it.
2857 @itemize
2859 @item On Sparc64, you can just try to launch any process by using the native
2860 libraries:
2862 @example
2863 qemu-sparc64 /bin/ls
2864 @end example
2866 @end itemize
2868 @node BSD Command line options
2869 @subsection Command line options
2871 @example
2872 usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
2873 @end example
2875 @table @option
2876 @item -h
2877 Print the help
2878 @item -L path
2879 Set the library root path (default=/)
2880 @item -s size
2881 Set the stack size in bytes (default=524288)
2882 @item -ignore-environment
2883 Start with an empty environment. Without this option,
2884 the initial environment is a copy of the caller's environment.
2885 @item -E @var{var}=@var{value}
2886 Set environment @var{var} to @var{value}.
2887 @item -U @var{var}
2888 Remove @var{var} from the environment.
2889 @item -bsd type
2890 Set the type of the emulated BSD Operating system. Valid values are
2891 FreeBSD, NetBSD and OpenBSD (default).
2892 @end table
2894 Debug options:
2896 @table @option
2897 @item -d item1,...
2898 Activate logging of the specified items (use '-d help' for a list of log items)
2899 @item -p pagesize
2900 Act as if the host page size was 'pagesize' bytes
2901 @item -singlestep
2902 Run the emulation in single step mode.
2903 @end table
2905 @node compilation
2906 @chapter Compilation from the sources
2908 @menu
2909 * Linux/Unix::
2910 * Windows::
2911 * Cross compilation for Windows with Linux::
2912 * Mac OS X::
2913 * Make targets::
2914 @end menu
2916 @node Linux/Unix
2917 @section Linux/Unix
2919 @subsection Compilation
2921 First you must decompress the sources:
2922 @example
2923 cd /tmp
2924 tar zxvf qemu-x.y.z.tar.gz
2925 cd qemu-x.y.z
2926 @end example
2928 Then you configure QEMU and build it (usually no options are needed):
2929 @example
2930 ./configure
2931 make
2932 @end example
2934 Then type as root user:
2935 @example
2936 make install
2937 @end example
2938 to install QEMU in @file{/usr/local}.
2940 @node Windows
2941 @section Windows
2943 @itemize
2944 @item Install the current versions of MSYS and MinGW from
2945 @url{http://www.mingw.org/}. You can find detailed installation
2946 instructions in the download section and the FAQ.
2948 @item Download
2949 the MinGW development library of SDL 1.2.x
2950 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2951 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2952 edit the @file{sdl-config} script so that it gives the
2953 correct SDL directory when invoked.
2955 @item Install the MinGW version of zlib and make sure
2956 @file{zlib.h} and @file{libz.dll.a} are in
2957 MinGW's default header and linker search paths.
2959 @item Extract the current version of QEMU.
2961 @item Start the MSYS shell (file @file{msys.bat}).
2963 @item Change to the QEMU directory. Launch @file{./configure} and
2964 @file{make}.  If you have problems using SDL, verify that
2965 @file{sdl-config} can be launched from the MSYS command line.
2967 @item You can install QEMU in @file{Program Files/QEMU} by typing
2968 @file{make install}. Don't forget to copy @file{SDL.dll} in
2969 @file{Program Files/QEMU}.
2971 @end itemize
2973 @node Cross compilation for Windows with Linux
2974 @section Cross compilation for Windows with Linux
2976 @itemize
2977 @item
2978 Install the MinGW cross compilation tools available at
2979 @url{http://www.mingw.org/}.
2981 @item Download
2982 the MinGW development library of SDL 1.2.x
2983 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2984 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2985 edit the @file{sdl-config} script so that it gives the
2986 correct SDL directory when invoked.  Set up the @code{PATH} environment
2987 variable so that @file{sdl-config} can be launched by
2988 the QEMU configuration script.
2990 @item Install the MinGW version of zlib and make sure
2991 @file{zlib.h} and @file{libz.dll.a} are in
2992 MinGW's default header and linker search paths.
2994 @item
2995 Configure QEMU for Windows cross compilation:
2996 @example
2997 PATH=/usr/i686-pc-mingw32/sys-root/mingw/bin:$PATH ./configure --cross-prefix='i686-pc-mingw32-'
2998 @end example
2999 The example assumes @file{sdl-config} is installed under @file{/usr/i686-pc-mingw32/sys-root/mingw/bin} and
3000 MinGW cross compilation tools have names like @file{i686-pc-mingw32-gcc} and @file{i686-pc-mingw32-strip}.
3001 We set the @code{PATH} environment variable to ensure the MinGW version of @file{sdl-config} is used and
3002 use --cross-prefix to specify the name of the cross compiler.
3003 You can also use --prefix to set the Win32 install path which defaults to @file{c:/Program Files/QEMU}.
3005 Under Fedora Linux, you can run:
3006 @example
3007 yum -y install mingw32-gcc mingw32-SDL mingw32-zlib
3008 @end example
3009 to get a suitable cross compilation environment.
3011 @item You can install QEMU in the installation directory by typing
3012 @code{make install}. Don't forget to copy @file{SDL.dll} and @file{zlib1.dll} into the
3013 installation directory.
3015 @end itemize
3017 Wine can be used to launch the resulting qemu-system-i386.exe
3018 and all other qemu-system-@var{target}.exe compiled for Win32.
3020 @node Mac OS X
3021 @section Mac OS X
3023 The Mac OS X patches are not fully merged in QEMU, so you should look
3024 at the QEMU mailing list archive to have all the necessary
3025 information.
3027 @node Make targets
3028 @section Make targets
3030 @table @code
3032 @item make
3033 @item make all
3034 Make everything which is typically needed.
3036 @item install
3037 TODO
3039 @item install-doc
3040 TODO
3042 @item make clean
3043 Remove most files which were built during make.
3045 @item make distclean
3046 Remove everything which was built during make.
3048 @item make dvi
3049 @item make html
3050 @item make info
3051 @item make pdf
3052 Create documentation in dvi, html, info or pdf format.
3054 @item make cscope
3055 TODO
3057 @item make defconfig
3058 (Re-)create some build configuration files.
3059 User made changes will be overwritten.
3061 @item tar
3062 @item tarbin
3063 TODO
3065 @end table
3067 @node License
3068 @appendix License
3070 QEMU is a trademark of Fabrice Bellard.
3072 QEMU is released under the GNU General Public License (TODO: add link).
3073 Parts of QEMU have specific licenses, see file LICENSE.
3075 TODO (refer to file LICENSE, include it, include the GPL?)
3077 @node Index
3078 @appendix Index
3079 @menu
3080 * Concept Index::
3081 * Function Index::
3082 * Keystroke Index::
3083 * Program Index::
3084 * Data Type Index::
3085 * Variable Index::
3086 @end menu
3088 @node Concept Index
3089 @section Concept Index
3090 This is the main index. Should we combine all keywords in one index? TODO
3091 @printindex cp
3093 @node Function Index
3094 @section Function Index
3095 This index could be used for command line options and monitor functions.
3096 @printindex fn
3098 @node Keystroke Index
3099 @section Keystroke Index
3101 This is a list of all keystrokes which have a special function
3102 in system emulation.
3104 @printindex ky
3106 @node Program Index
3107 @section Program Index
3108 @printindex pg
3110 @node Data Type Index
3111 @section Data Type Index
3113 This index could be used for qdev device names and options.
3115 @printindex tp
3117 @node Variable Index
3118 @section Variable Index
3119 @printindex vr
3121 @bye