xen/pt: Log xen_host_pci_get/set errors in MSI code.
[qemu/ar7.git] / qemu-doc.texi
blobea9b3fbfca52d40aa7e49bbe9485e7917e6650d2
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 * qemu_ga_invocation::        qemu-ga Invocation
416 * disk_images_formats::       Disk image file formats
417 * host_drives::               Using host drives
418 * disk_images_fat_images::    Virtual FAT disk images
419 * disk_images_nbd::           NBD access
420 * disk_images_sheepdog::      Sheepdog disk images
421 * disk_images_iscsi::         iSCSI LUNs
422 * disk_images_gluster::       GlusterFS disk images
423 * disk_images_ssh::           Secure Shell (ssh) disk images
424 @end menu
426 @node disk_images_quickstart
427 @subsection Quick start for disk image creation
429 You can create a disk image with the command:
430 @example
431 qemu-img create myimage.img mysize
432 @end example
433 where @var{myimage.img} is the disk image filename and @var{mysize} is its
434 size in kilobytes. You can add an @code{M} suffix to give the size in
435 megabytes and a @code{G} suffix for gigabytes.
437 See @ref{qemu_img_invocation} for more information.
439 @node disk_images_snapshot_mode
440 @subsection Snapshot mode
442 If you use the option @option{-snapshot}, all disk images are
443 considered as read only. When sectors in written, they are written in
444 a temporary file created in @file{/tmp}. You can however force the
445 write back to the raw disk images by using the @code{commit} monitor
446 command (or @key{C-a s} in the serial console).
448 @node vm_snapshots
449 @subsection VM snapshots
451 VM snapshots are snapshots of the complete virtual machine including
452 CPU state, RAM, device state and the content of all the writable
453 disks. In order to use VM snapshots, you must have at least one non
454 removable and writable block device using the @code{qcow2} disk image
455 format. Normally this device is the first virtual hard drive.
457 Use the monitor command @code{savevm} to create a new VM snapshot or
458 replace an existing one. A human readable name can be assigned to each
459 snapshot in addition to its numerical ID.
461 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
462 a VM snapshot. @code{info snapshots} lists the available snapshots
463 with their associated information:
465 @example
466 (qemu) info snapshots
467 Snapshot devices: hda
468 Snapshot list (from hda):
469 ID        TAG                 VM SIZE                DATE       VM CLOCK
470 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
471 2                                 40M 2006-08-06 12:43:29   00:00:18.633
472 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
473 @end example
475 A VM snapshot is made of a VM state info (its size is shown in
476 @code{info snapshots}) and a snapshot of every writable disk image.
477 The VM state info is stored in the first @code{qcow2} non removable
478 and writable block device. The disk image snapshots are stored in
479 every disk image. The size of a snapshot in a disk image is difficult
480 to evaluate and is not shown by @code{info snapshots} because the
481 associated disk sectors are shared among all the snapshots to save
482 disk space (otherwise each snapshot would need a full copy of all the
483 disk images).
485 When using the (unrelated) @code{-snapshot} option
486 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
487 but they are deleted as soon as you exit QEMU.
489 VM snapshots currently have the following known limitations:
490 @itemize
491 @item
492 They cannot cope with removable devices if they are removed or
493 inserted after a snapshot is done.
494 @item
495 A few device drivers still have incomplete snapshot support so their
496 state is not saved or restored properly (in particular USB).
497 @end itemize
499 @node qemu_img_invocation
500 @subsection @code{qemu-img} Invocation
502 @include qemu-img.texi
504 @node qemu_nbd_invocation
505 @subsection @code{qemu-nbd} Invocation
507 @include qemu-nbd.texi
509 @node qemu_ga_invocation
510 @subsection @code{qemu-ga} Invocation
512 @include qemu-ga.texi
514 @node disk_images_formats
515 @subsection Disk image file formats
517 QEMU supports many image file formats that can be used with VMs as well as with
518 any of the tools (like @code{qemu-img}). This includes the preferred formats
519 raw and qcow2 as well as formats that are supported for compatibility with
520 older QEMU versions or other hypervisors.
522 Depending on the image format, different options can be passed to
523 @code{qemu-img create} and @code{qemu-img convert} using the @code{-o} option.
524 This section describes each format and the options that are supported for it.
526 @table @option
527 @item raw
529 Raw disk image format. This format has the advantage of
530 being simple and easily exportable to all other emulators. If your
531 file system supports @emph{holes} (for example in ext2 or ext3 on
532 Linux or NTFS on Windows), then only the written sectors will reserve
533 space. Use @code{qemu-img info} to know the real size used by the
534 image or @code{ls -ls} on Unix/Linux.
536 Supported options:
537 @table @code
538 @item preallocation
539 Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
540 @code{falloc} mode preallocates space for image by calling posix_fallocate().
541 @code{full} mode preallocates space for image by writing zeros to underlying
542 storage.
543 @end table
545 @item qcow2
546 QEMU image format, the most versatile format. Use it to have smaller
547 images (useful if your filesystem does not supports holes, for example
548 on Windows), zlib based compression and support of multiple VM
549 snapshots.
551 Supported options:
552 @table @code
553 @item compat
554 Determines the qcow2 version to use. @code{compat=0.10} uses the
555 traditional image format that can be read by any QEMU since 0.10.
556 @code{compat=1.1} enables image format extensions that only QEMU 1.1 and
557 newer understand (this is the default). Amongst others, this includes
558 zero clusters, which allow efficient copy-on-read for sparse images.
560 @item backing_file
561 File name of a base image (see @option{create} subcommand)
562 @item backing_fmt
563 Image format of the base image
564 @item encryption
565 If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
567 The use of encryption in qcow and qcow2 images is considered to be flawed by
568 modern cryptography standards, suffering from a number of design problems:
570 @itemize @minus
571 @item The AES-CBC cipher is used with predictable initialization vectors based
572 on the sector number. This makes it vulnerable to chosen plaintext attacks
573 which can reveal the existence of encrypted data.
574 @item The user passphrase is directly used as the encryption key. A poorly
575 chosen or short passphrase will compromise the security of the encryption.
576 @item In the event of the passphrase being compromised there is no way to
577 change the passphrase to protect data in any qcow images. The files must
578 be cloned, using a different encryption passphrase in the new file. The
579 original file must then be securely erased using a program like shred,
580 though even this is ineffective with many modern storage technologies.
581 @end itemize
583 Use of qcow / qcow2 encryption with QEMU is deprecated, and support for
584 it will go away in a future release.  Users are recommended to use an
585 alternative encryption technology such as the Linux dm-crypt / LUKS
586 system.
588 @item cluster_size
589 Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
590 sizes can improve the image file size whereas larger cluster sizes generally
591 provide better performance.
593 @item preallocation
594 Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
595 @code{full}). An image with preallocated metadata is initially larger but can
596 improve performance when the image needs to grow. @code{falloc} and @code{full}
597 preallocations are like the same options of @code{raw} format, but sets up
598 metadata also.
600 @item lazy_refcounts
601 If this option is set to @code{on}, reference count updates are postponed with
602 the goal of avoiding metadata I/O and improving performance. This is
603 particularly interesting with @option{cache=writethrough} which doesn't batch
604 metadata updates. The tradeoff is that after a host crash, the reference count
605 tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
606 check -r all} is required, which may take some time.
608 This option can only be enabled if @code{compat=1.1} is specified.
610 @item nocow
611 If this option is set to @code{on}, it will turn off COW of the file. It's only
612 valid on btrfs, no effect on other file systems.
614 Btrfs has low performance when hosting a VM image file, even more when the guest
615 on the VM also using btrfs as file system. Turning off COW is a way to mitigate
616 this bad performance. Generally there are two ways to turn off COW on btrfs:
617 a) Disable it by mounting with nodatacow, then all newly created files will be
618 NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
619 does.
621 Note: this option is only valid to new or empty files. If there is an existing
622 file which is COW and has data blocks already, it couldn't be changed to NOCOW
623 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
624 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
626 @end table
628 @item qed
629 Old QEMU image format with support for backing files and compact image files
630 (when your filesystem or transport medium does not support holes).
632 When converting QED images to qcow2, you might want to consider using the
633 @code{lazy_refcounts=on} option to get a more QED-like behaviour.
635 Supported options:
636 @table @code
637 @item backing_file
638 File name of a base image (see @option{create} subcommand).
639 @item backing_fmt
640 Image file format of backing file (optional).  Useful if the format cannot be
641 autodetected because it has no header, like some vhd/vpc files.
642 @item cluster_size
643 Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller
644 cluster sizes can improve the image file size whereas larger cluster sizes
645 generally provide better performance.
646 @item table_size
647 Changes the number of clusters per L1/L2 table (must be power-of-2 between 1
648 and 16).  There is normally no need to change this value but this option can be
649 used for performance benchmarking.
650 @end table
652 @item qcow
653 Old QEMU image format with support for backing files, compact image files,
654 encryption and compression.
656 Supported options:
657 @table @code
658 @item backing_file
659 File name of a base image (see @option{create} subcommand)
660 @item encryption
661 If this option is set to @code{on}, the image is encrypted.
662 @end table
664 @item vdi
665 VirtualBox 1.1 compatible image format.
666 Supported options:
667 @table @code
668 @item static
669 If this option is set to @code{on}, the image is created with metadata
670 preallocation.
671 @end table
673 @item vmdk
674 VMware 3 and 4 compatible image format.
676 Supported options:
677 @table @code
678 @item backing_file
679 File name of a base image (see @option{create} subcommand).
680 @item compat6
681 Create a VMDK version 6 image (instead of version 4)
682 @item subformat
683 Specifies which VMDK subformat to use. Valid options are
684 @code{monolithicSparse} (default),
685 @code{monolithicFlat},
686 @code{twoGbMaxExtentSparse},
687 @code{twoGbMaxExtentFlat} and
688 @code{streamOptimized}.
689 @end table
691 @item vpc
692 VirtualPC compatible image format (VHD).
693 Supported options:
694 @table @code
695 @item subformat
696 Specifies which VHD subformat to use. Valid options are
697 @code{dynamic} (default) and @code{fixed}.
698 @end table
700 @item VHDX
701 Hyper-V compatible image format (VHDX).
702 Supported options:
703 @table @code
704 @item subformat
705 Specifies which VHDX subformat to use. Valid options are
706 @code{dynamic} (default) and @code{fixed}.
707 @item block_state_zero
708 Force use of payload blocks of type 'ZERO'.  Can be set to @code{on} (default)
709 or @code{off}.  When set to @code{off}, new blocks will be created as
710 @code{PAYLOAD_BLOCK_NOT_PRESENT}, which means parsers are free to return
711 arbitrary data for those blocks.  Do not set to @code{off} when using
712 @code{qemu-img convert} with @code{subformat=dynamic}.
713 @item block_size
714 Block size; min 1 MB, max 256 MB.  0 means auto-calculate based on image size.
715 @item log_size
716 Log size; min 1 MB.
717 @end table
718 @end table
720 @subsubsection Read-only formats
721 More disk image file formats are supported in a read-only mode.
722 @table @option
723 @item bochs
724 Bochs images of @code{growing} type.
725 @item cloop
726 Linux Compressed Loop image, useful only to reuse directly compressed
727 CD-ROM images present for example in the Knoppix CD-ROMs.
728 @item dmg
729 Apple disk image.
730 @item parallels
731 Parallels disk image format.
732 @end table
735 @node host_drives
736 @subsection Using host drives
738 In addition to disk image files, QEMU can directly access host
739 devices. We describe here the usage for QEMU version >= 0.8.3.
741 @subsubsection Linux
743 On Linux, you can directly use the host device filename instead of a
744 disk image filename provided you have enough privileges to access
745 it. For example, use @file{/dev/cdrom} to access to the CDROM.
747 @table @code
748 @item CD
749 You can specify a CDROM device even if no CDROM is loaded. QEMU has
750 specific code to detect CDROM insertion or removal. CDROM ejection by
751 the guest OS is supported. Currently only data CDs are supported.
752 @item Floppy
753 You can specify a floppy device even if no floppy is loaded. Floppy
754 removal is currently not detected accurately (if you change floppy
755 without doing floppy access while the floppy is not loaded, the guest
756 OS will think that the same floppy is loaded).
757 Use of the host's floppy device is deprecated, and support for it will
758 be removed in a future release.
759 @item Hard disks
760 Hard disks can be used. Normally you must specify the whole disk
761 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
762 see it as a partitioned disk. WARNING: unless you know what you do, it
763 is better to only make READ-ONLY accesses to the hard disk otherwise
764 you may corrupt your host data (use the @option{-snapshot} command
765 line option or modify the device permissions accordingly).
766 @end table
768 @subsubsection Windows
770 @table @code
771 @item CD
772 The preferred syntax is the drive letter (e.g. @file{d:}). The
773 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
774 supported as an alias to the first CDROM drive.
776 Currently there is no specific code to handle removable media, so it
777 is better to use the @code{change} or @code{eject} monitor commands to
778 change or eject media.
779 @item Hard disks
780 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
781 where @var{N} is the drive number (0 is the first hard disk).
783 WARNING: unless you know what you do, it is better to only make
784 READ-ONLY accesses to the hard disk otherwise you may corrupt your
785 host data (use the @option{-snapshot} command line so that the
786 modifications are written in a temporary file).
787 @end table
790 @subsubsection Mac OS X
792 @file{/dev/cdrom} is an alias to the first CDROM.
794 Currently there is no specific code to handle removable media, so it
795 is better to use the @code{change} or @code{eject} monitor commands to
796 change or eject media.
798 @node disk_images_fat_images
799 @subsection Virtual FAT disk images
801 QEMU can automatically create a virtual FAT disk image from a
802 directory tree. In order to use it, just type:
804 @example
805 qemu-system-i386 linux.img -hdb fat:/my_directory
806 @end example
808 Then you access access to all the files in the @file{/my_directory}
809 directory without having to copy them in a disk image or to export
810 them via SAMBA or NFS. The default access is @emph{read-only}.
812 Floppies can be emulated with the @code{:floppy:} option:
814 @example
815 qemu-system-i386 linux.img -fda fat:floppy:/my_directory
816 @end example
818 A read/write support is available for testing (beta stage) with the
819 @code{:rw:} option:
821 @example
822 qemu-system-i386 linux.img -fda fat:floppy:rw:/my_directory
823 @end example
825 What you should @emph{never} do:
826 @itemize
827 @item use non-ASCII filenames ;
828 @item use "-snapshot" together with ":rw:" ;
829 @item expect it to work when loadvm'ing ;
830 @item write to the FAT directory on the host system while accessing it with the guest system.
831 @end itemize
833 @node disk_images_nbd
834 @subsection NBD access
836 QEMU can access directly to block device exported using the Network Block Device
837 protocol.
839 @example
840 qemu-system-i386 linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/
841 @end example
843 If the NBD server is located on the same host, you can use an unix socket instead
844 of an inet socket:
846 @example
847 qemu-system-i386 linux.img -hdb nbd+unix://?socket=/tmp/my_socket
848 @end example
850 In this case, the block device must be exported using qemu-nbd:
852 @example
853 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
854 @end example
856 The use of qemu-nbd allows sharing of a disk between several guests:
857 @example
858 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
859 @end example
861 @noindent
862 and then you can use it with two guests:
863 @example
864 qemu-system-i386 linux1.img -hdb nbd+unix://?socket=/tmp/my_socket
865 qemu-system-i386 linux2.img -hdb nbd+unix://?socket=/tmp/my_socket
866 @end example
868 If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's
869 own embedded NBD server), you must specify an export name in the URI:
870 @example
871 qemu-system-i386 -cdrom nbd://localhost/debian-500-ppc-netinst
872 qemu-system-i386 -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst
873 @end example
875 The URI syntax for NBD is supported since QEMU 1.3.  An alternative syntax is
876 also available.  Here are some example of the older syntax:
877 @example
878 qemu-system-i386 linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
879 qemu-system-i386 linux2.img -hdb nbd:unix:/tmp/my_socket
880 qemu-system-i386 -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst
881 @end example
883 @node disk_images_sheepdog
884 @subsection Sheepdog disk images
886 Sheepdog is a distributed storage system for QEMU.  It provides highly
887 available block level storage volumes that can be attached to
888 QEMU-based virtual machines.
890 You can create a Sheepdog disk image with the command:
891 @example
892 qemu-img create sheepdog:///@var{image} @var{size}
893 @end example
894 where @var{image} is the Sheepdog image name and @var{size} is its
895 size.
897 To import the existing @var{filename} to Sheepdog, you can use a
898 convert command.
899 @example
900 qemu-img convert @var{filename} sheepdog:///@var{image}
901 @end example
903 You can boot from the Sheepdog disk image with the command:
904 @example
905 qemu-system-i386 sheepdog:///@var{image}
906 @end example
908 You can also create a snapshot of the Sheepdog image like qcow2.
909 @example
910 qemu-img snapshot -c @var{tag} sheepdog:///@var{image}
911 @end example
912 where @var{tag} is a tag name of the newly created snapshot.
914 To boot from the Sheepdog snapshot, specify the tag name of the
915 snapshot.
916 @example
917 qemu-system-i386 sheepdog:///@var{image}#@var{tag}
918 @end example
920 You can create a cloned image from the existing snapshot.
921 @example
922 qemu-img create -b sheepdog:///@var{base}#@var{tag} sheepdog:///@var{image}
923 @end example
924 where @var{base} is a image name of the source snapshot and @var{tag}
925 is its tag name.
927 You can use an unix socket instead of an inet socket:
929 @example
930 qemu-system-i386 sheepdog+unix:///@var{image}?socket=@var{path}
931 @end example
933 If the Sheepdog daemon doesn't run on the local host, you need to
934 specify one of the Sheepdog servers to connect to.
935 @example
936 qemu-img create sheepdog://@var{hostname}:@var{port}/@var{image} @var{size}
937 qemu-system-i386 sheepdog://@var{hostname}:@var{port}/@var{image}
938 @end example
940 @node disk_images_iscsi
941 @subsection iSCSI LUNs
943 iSCSI is a popular protocol used to access SCSI devices across a computer
944 network.
946 There are two different ways iSCSI devices can be used by QEMU.
948 The first method is to mount the iSCSI LUN on the host, and make it appear as
949 any other ordinary SCSI device on the host and then to access this device as a
950 /dev/sd device from QEMU. How to do this differs between host OSes.
952 The second method involves using the iSCSI initiator that is built into
953 QEMU. This provides a mechanism that works the same way regardless of which
954 host OS you are running QEMU on. This section will describe this second method
955 of using iSCSI together with QEMU.
957 In QEMU, iSCSI devices are described using special iSCSI URLs
959 @example
960 URL syntax:
961 iscsi://[<username>[%<password>]@@]<host>[:<port>]/<target-iqn-name>/<lun>
962 @end example
964 Username and password are optional and only used if your target is set up
965 using CHAP authentication for access control.
966 Alternatively the username and password can also be set via environment
967 variables to have these not show up in the process list
969 @example
970 export LIBISCSI_CHAP_USERNAME=<username>
971 export LIBISCSI_CHAP_PASSWORD=<password>
972 iscsi://<host>/<target-iqn-name>/<lun>
973 @end example
975 Various session related parameters can be set via special options, either
976 in a configuration file provided via '-readconfig' or directly on the
977 command line.
979 If the initiator-name is not specified qemu will use a default name
980 of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
981 virtual machine.
984 @example
985 Setting a specific initiator name to use when logging in to the target
986 -iscsi initiator-name=iqn.qemu.test:my-initiator
987 @end example
989 @example
990 Controlling which type of header digest to negotiate with the target
991 -iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
992 @end example
994 These can also be set via a configuration file
995 @example
996 [iscsi]
997   user = "CHAP username"
998   password = "CHAP password"
999   initiator-name = "iqn.qemu.test:my-initiator"
1000   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
1001   header-digest = "CRC32C"
1002 @end example
1005 Setting the target name allows different options for different targets
1006 @example
1007 [iscsi "iqn.target.name"]
1008   user = "CHAP username"
1009   password = "CHAP password"
1010   initiator-name = "iqn.qemu.test:my-initiator"
1011   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
1012   header-digest = "CRC32C"
1013 @end example
1016 Howto use a configuration file to set iSCSI configuration options:
1017 @example
1018 cat >iscsi.conf <<EOF
1019 [iscsi]
1020   user = "me"
1021   password = "my password"
1022   initiator-name = "iqn.qemu.test:my-initiator"
1023   header-digest = "CRC32C"
1026 qemu-system-i386 -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1027     -readconfig iscsi.conf
1028 @end example
1031 Howto set up a simple iSCSI target on loopback and accessing it via QEMU:
1032 @example
1033 This example shows how to set up an iSCSI target with one CDROM and one DISK
1034 using the Linux STGT software target. This target is available on Red Hat based
1035 systems as the package 'scsi-target-utils'.
1037 tgtd --iscsi portal=127.0.0.1:3260
1038 tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
1039 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \
1040     -b /IMAGES/disk.img --device-type=disk
1041 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \
1042     -b /IMAGES/cd.iso --device-type=cd
1043 tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
1045 qemu-system-i386 -iscsi initiator-name=iqn.qemu.test:my-initiator \
1046     -boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1047     -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
1048 @end example
1050 @node disk_images_gluster
1051 @subsection GlusterFS disk images
1053 GlusterFS is an user space distributed file system.
1055 You can boot from the GlusterFS disk image with the command:
1056 @example
1057 qemu-system-x86_64 -drive file=gluster[+@var{transport}]://[@var{server}[:@var{port}]]/@var{volname}/@var{image}[?socket=...]
1058 @end example
1060 @var{gluster} is the protocol.
1062 @var{transport} specifies the transport type used to connect to gluster
1063 management daemon (glusterd). Valid transport types are
1064 tcp, unix and rdma. If a transport type isn't specified, then tcp
1065 type is assumed.
1067 @var{server} specifies the server where the volume file specification for
1068 the given volume resides. This can be either hostname, ipv4 address
1069 or ipv6 address. ipv6 address needs to be within square brackets [ ].
1070 If transport type is unix, then @var{server} field should not be specified.
1071 Instead @var{socket} field needs to be populated with the path to unix domain
1072 socket.
1074 @var{port} is the port number on which glusterd is listening. This is optional
1075 and if not specified, QEMU will send 0 which will make gluster to use the
1076 default port. If the transport type is unix, then @var{port} should not be
1077 specified.
1079 @var{volname} is the name of the gluster volume which contains the disk image.
1081 @var{image} is the path to the actual disk image that resides on gluster volume.
1083 You can create a GlusterFS disk image with the command:
1084 @example
1085 qemu-img create gluster://@var{server}/@var{volname}/@var{image} @var{size}
1086 @end example
1088 Examples
1089 @example
1090 qemu-system-x86_64 -drive file=gluster://1.2.3.4/testvol/a.img
1091 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4/testvol/a.img
1092 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
1093 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
1094 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
1095 qemu-system-x86_64 -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
1096 qemu-system-x86_64 -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
1097 qemu-system-x86_64 -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
1098 @end example
1100 @node disk_images_ssh
1101 @subsection Secure Shell (ssh) disk images
1103 You can access disk images located on a remote ssh server
1104 by using the ssh protocol:
1106 @example
1107 qemu-system-x86_64 -drive file=ssh://[@var{user}@@]@var{server}[:@var{port}]/@var{path}[?host_key_check=@var{host_key_check}]
1108 @end example
1110 Alternative syntax using properties:
1112 @example
1113 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}]
1114 @end example
1116 @var{ssh} is the protocol.
1118 @var{user} is the remote user.  If not specified, then the local
1119 username is tried.
1121 @var{server} specifies the remote ssh server.  Any ssh server can be
1122 used, but it must implement the sftp-server protocol.  Most Unix/Linux
1123 systems should work without requiring any extra configuration.
1125 @var{port} is the port number on which sshd is listening.  By default
1126 the standard ssh port (22) is used.
1128 @var{path} is the path to the disk image.
1130 The optional @var{host_key_check} parameter controls how the remote
1131 host's key is checked.  The default is @code{yes} which means to use
1132 the local @file{.ssh/known_hosts} file.  Setting this to @code{no}
1133 turns off known-hosts checking.  Or you can check that the host key
1134 matches a specific fingerprint:
1135 @code{host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8}
1136 (@code{sha1:} can also be used as a prefix, but note that OpenSSH
1137 tools only use MD5 to print fingerprints).
1139 Currently authentication must be done using ssh-agent.  Other
1140 authentication methods may be supported in future.
1142 Note: Many ssh servers do not support an @code{fsync}-style operation.
1143 The ssh driver cannot guarantee that disk flush requests are
1144 obeyed, and this causes a risk of disk corruption if the remote
1145 server or network goes down during writes.  The driver will
1146 print a warning when @code{fsync} is not supported:
1148 warning: ssh server @code{ssh.example.com:22} does not support fsync
1150 With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is
1151 supported.
1153 @node pcsys_network
1154 @section Network emulation
1156 QEMU can simulate several network cards (PCI or ISA cards on the PC
1157 target) and can connect them to an arbitrary number of Virtual Local
1158 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1159 VLAN. VLAN can be connected between separate instances of QEMU to
1160 simulate large networks. For simpler usage, a non privileged user mode
1161 network stack can replace the TAP device to have a basic network
1162 connection.
1164 @subsection VLANs
1166 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1167 connection between several network devices. These devices can be for
1168 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1169 (TAP devices).
1171 @subsection Using TAP network interfaces
1173 This is the standard way to connect QEMU to a real network. QEMU adds
1174 a virtual network device on your host (called @code{tapN}), and you
1175 can then configure it as if it was a real ethernet card.
1177 @subsubsection Linux host
1179 As an example, you can download the @file{linux-test-xxx.tar.gz}
1180 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1181 configure properly @code{sudo} so that the command @code{ifconfig}
1182 contained in @file{qemu-ifup} can be executed as root. You must verify
1183 that your host kernel supports the TAP network interfaces: the
1184 device @file{/dev/net/tun} must be present.
1186 See @ref{sec_invocation} to have examples of command lines using the
1187 TAP network interfaces.
1189 @subsubsection Windows host
1191 There is a virtual ethernet driver for Windows 2000/XP systems, called
1192 TAP-Win32. But it is not included in standard QEMU for Windows,
1193 so you will need to get it separately. It is part of OpenVPN package,
1194 so download OpenVPN from : @url{http://openvpn.net/}.
1196 @subsection Using the user mode network stack
1198 By using the option @option{-net user} (default configuration if no
1199 @option{-net} option is specified), QEMU uses a completely user mode
1200 network stack (you don't need root privilege to use the virtual
1201 network). The virtual network configuration is the following:
1203 @example
1205          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1206                            |          (10.0.2.2)
1207                            |
1208                            ---->  DNS server (10.0.2.3)
1209                            |
1210                            ---->  SMB server (10.0.2.4)
1211 @end example
1213 The QEMU VM behaves as if it was behind a firewall which blocks all
1214 incoming connections. You can use a DHCP client to automatically
1215 configure the network in the QEMU VM. The DHCP server assign addresses
1216 to the hosts starting from 10.0.2.15.
1218 In order to check that the user mode network is working, you can ping
1219 the address 10.0.2.2 and verify that you got an address in the range
1220 10.0.2.x from the QEMU virtual DHCP server.
1222 Note that ICMP traffic in general does not work with user mode networking.
1223 @code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work,
1224 however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP
1225 ping sockets to allow @code{ping} to the Internet. The host admin has to set
1226 the ping_group_range in order to grant access to those sockets. To allow ping
1227 for GID 100 (usually users group):
1229 @example
1230 echo 100 100 > /proc/sys/net/ipv4/ping_group_range
1231 @end example
1233 When using the built-in TFTP server, the router is also the TFTP
1234 server.
1236 When using the @option{-redir} option, TCP or UDP connections can be
1237 redirected from the host to the guest. It allows for example to
1238 redirect X11, telnet or SSH connections.
1240 @subsection Connecting VLANs between QEMU instances
1242 Using the @option{-net socket} option, it is possible to make VLANs
1243 that span several QEMU instances. See @ref{sec_invocation} to have a
1244 basic example.
1246 @node pcsys_other_devs
1247 @section Other Devices
1249 @subsection Inter-VM Shared Memory device
1251 With KVM enabled on a Linux host, a shared memory device is available.  Guests
1252 map a POSIX shared memory region into the guest as a PCI device that enables
1253 zero-copy communication to the application level of the guests.  The basic
1254 syntax is:
1256 @example
1257 qemu-system-i386 -device ivshmem,size=<size in format accepted by -m>[,shm=<shm name>]
1258 @end example
1260 If desired, interrupts can be sent between guest VMs accessing the same shared
1261 memory region.  Interrupt support requires using a shared memory server and
1262 using a chardev socket to connect to it.  The code for the shared memory server
1263 is qemu.git/contrib/ivshmem-server.  An example syntax when using the shared
1264 memory server is:
1266 @example
1267 qemu-system-i386 -device ivshmem,size=<size in format accepted by -m>[,chardev=<id>]
1268                  [,msi=on][,ioeventfd=on][,vectors=n][,role=peer|master]
1269 qemu-system-i386 -chardev socket,path=<path>,id=<id>
1270 @end example
1272 When using the server, the guest will be assigned a VM ID (>=0) that allows guests
1273 using the same server to communicate via interrupts.  Guests can read their
1274 VM ID from a device register (see example code).  Since receiving the shared
1275 memory region from the server is asynchronous, there is a (small) chance the
1276 guest may boot before the shared memory is attached.  To allow an application
1277 to ensure shared memory is attached, the VM ID register will return -1 (an
1278 invalid VM ID) until the memory is attached.  Once the shared memory is
1279 attached, the VM ID will return the guest's valid VM ID.  With these semantics,
1280 the guest application can check to ensure the shared memory is attached to the
1281 guest before proceeding.
1283 The @option{role} argument can be set to either master or peer and will affect
1284 how the shared memory is migrated.  With @option{role=master}, the guest will
1285 copy the shared memory on migration to the destination host.  With
1286 @option{role=peer}, the guest will not be able to migrate with the device attached.
1287 With the @option{peer} case, the device should be detached and then reattached
1288 after migration using the PCI hotplug support.
1290 @node direct_linux_boot
1291 @section Direct Linux Boot
1293 This section explains how to launch a Linux kernel inside QEMU without
1294 having to make a full bootable image. It is very useful for fast Linux
1295 kernel testing.
1297 The syntax is:
1298 @example
1299 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1300 @end example
1302 Use @option{-kernel} to provide the Linux kernel image and
1303 @option{-append} to give the kernel command line arguments. The
1304 @option{-initrd} option can be used to provide an INITRD image.
1306 When using the direct Linux boot, a disk image for the first hard disk
1307 @file{hda} is required because its boot sector is used to launch the
1308 Linux kernel.
1310 If you do not need graphical output, you can disable it and redirect
1311 the virtual serial port and the QEMU monitor to the console with the
1312 @option{-nographic} option. The typical command line is:
1313 @example
1314 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1315                  -append "root=/dev/hda console=ttyS0" -nographic
1316 @end example
1318 Use @key{Ctrl-a c} to switch between the serial console and the
1319 monitor (@pxref{pcsys_keys}).
1321 @node pcsys_usb
1322 @section USB emulation
1324 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1325 virtual USB devices or real host USB devices (experimental, works only
1326 on Linux hosts).  QEMU will automatically create and connect virtual USB hubs
1327 as necessary to connect multiple USB devices.
1329 @menu
1330 * usb_devices::
1331 * host_usb_devices::
1332 @end menu
1333 @node usb_devices
1334 @subsection Connecting USB devices
1336 USB devices can be connected with the @option{-usbdevice} commandline option
1337 or the @code{usb_add} monitor command.  Available devices are:
1339 @table @code
1340 @item mouse
1341 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1342 @item tablet
1343 Pointer device that uses absolute coordinates (like a touchscreen).
1344 This means QEMU is able to report the mouse position without having
1345 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1346 @item disk:@var{file}
1347 Mass storage device based on @var{file} (@pxref{disk_images})
1348 @item host:@var{bus.addr}
1349 Pass through the host device identified by @var{bus.addr}
1350 (Linux only)
1351 @item host:@var{vendor_id:product_id}
1352 Pass through the host device identified by @var{vendor_id:product_id}
1353 (Linux only)
1354 @item wacom-tablet
1355 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
1356 above but it can be used with the tslib library because in addition to touch
1357 coordinates it reports touch pressure.
1358 @item keyboard
1359 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1360 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1361 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1362 device @var{dev}. The available character devices are the same as for the
1363 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1364 used to override the default 0403:6001. For instance,
1365 @example
1366 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1367 @end example
1368 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1369 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1370 @item braille
1371 Braille device.  This will use BrlAPI to display the braille output on a real
1372 or fake device.
1373 @item net:@var{options}
1374 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
1375 specifies NIC options as with @code{-net nic,}@var{options} (see description).
1376 For instance, user-mode networking can be used with
1377 @example
1378 qemu-system-i386 [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
1379 @end example
1380 Currently this cannot be used in machines that support PCI NICs.
1381 @item bt[:@var{hci-type}]
1382 Bluetooth dongle whose type is specified in the same format as with
1383 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
1384 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
1385 This USB device implements the USB Transport Layer of HCI.  Example
1386 usage:
1387 @example
1388 qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
1389 @end example
1390 @end table
1392 @node host_usb_devices
1393 @subsection Using host USB devices on a Linux host
1395 WARNING: this is an experimental feature. QEMU will slow down when
1396 using it. USB devices requiring real time streaming (i.e. USB Video
1397 Cameras) are not supported yet.
1399 @enumerate
1400 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1401 is actually using the USB device. A simple way to do that is simply to
1402 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1403 to @file{mydriver.o.disabled}.
1405 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1406 @example
1407 ls /proc/bus/usb
1408 001  devices  drivers
1409 @end example
1411 @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:
1412 @example
1413 chown -R myuid /proc/bus/usb
1414 @end example
1416 @item Launch QEMU and do in the monitor:
1417 @example
1418 info usbhost
1419   Device 1.2, speed 480 Mb/s
1420     Class 00: USB device 1234:5678, USB DISK
1421 @end example
1422 You should see the list of the devices you can use (Never try to use
1423 hubs, it won't work).
1425 @item Add the device in QEMU by using:
1426 @example
1427 usb_add host:1234:5678
1428 @end example
1430 Normally the guest OS should report that a new USB device is
1431 plugged. You can use the option @option{-usbdevice} to do the same.
1433 @item Now you can try to use the host USB device in QEMU.
1435 @end enumerate
1437 When relaunching QEMU, you may have to unplug and plug again the USB
1438 device to make it work again (this is a bug).
1440 @node vnc_security
1441 @section VNC security
1443 The VNC server capability provides access to the graphical console
1444 of the guest VM across the network. This has a number of security
1445 considerations depending on the deployment scenarios.
1447 @menu
1448 * vnc_sec_none::
1449 * vnc_sec_password::
1450 * vnc_sec_certificate::
1451 * vnc_sec_certificate_verify::
1452 * vnc_sec_certificate_pw::
1453 * vnc_sec_sasl::
1454 * vnc_sec_certificate_sasl::
1455 * vnc_generate_cert::
1456 * vnc_setup_sasl::
1457 @end menu
1458 @node vnc_sec_none
1459 @subsection Without passwords
1461 The simplest VNC server setup does not include any form of authentication.
1462 For this setup it is recommended to restrict it to listen on a UNIX domain
1463 socket only. For example
1465 @example
1466 qemu-system-i386 [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1467 @end example
1469 This ensures that only users on local box with read/write access to that
1470 path can access the VNC server. To securely access the VNC server from a
1471 remote machine, a combination of netcat+ssh can be used to provide a secure
1472 tunnel.
1474 @node vnc_sec_password
1475 @subsection With passwords
1477 The VNC protocol has limited support for password based authentication. Since
1478 the protocol limits passwords to 8 characters it should not be considered
1479 to provide high security. The password can be fairly easily brute-forced by
1480 a client making repeat connections. For this reason, a VNC server using password
1481 authentication should be restricted to only listen on the loopback interface
1482 or UNIX domain sockets. Password authentication is not supported when operating
1483 in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password
1484 authentication is requested with the @code{password} option, and then once QEMU
1485 is running the password is set with the monitor. Until the monitor is used to
1486 set the password all clients will be rejected.
1488 @example
1489 qemu-system-i386 [...OPTIONS...] -vnc :1,password -monitor stdio
1490 (qemu) change vnc password
1491 Password: ********
1492 (qemu)
1493 @end example
1495 @node vnc_sec_certificate
1496 @subsection With x509 certificates
1498 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1499 TLS for encryption of the session, and x509 certificates for authentication.
1500 The use of x509 certificates is strongly recommended, because TLS on its
1501 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1502 support provides a secure session, but no authentication. This allows any
1503 client to connect, and provides an encrypted session.
1505 @example
1506 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1507 @end example
1509 In the above example @code{/etc/pki/qemu} should contain at least three files,
1510 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1511 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1512 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1513 only be readable by the user owning it.
1515 @node vnc_sec_certificate_verify
1516 @subsection With x509 certificates and client verification
1518 Certificates can also provide a means to authenticate the client connecting.
1519 The server will request that the client provide a certificate, which it will
1520 then validate against the CA certificate. This is a good choice if deploying
1521 in an environment with a private internal certificate authority.
1523 @example
1524 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1525 @end example
1528 @node vnc_sec_certificate_pw
1529 @subsection With x509 certificates, client verification and passwords
1531 Finally, the previous method can be combined with VNC password authentication
1532 to provide two layers of authentication for clients.
1534 @example
1535 qemu-system-i386 [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1536 (qemu) change vnc password
1537 Password: ********
1538 (qemu)
1539 @end example
1542 @node vnc_sec_sasl
1543 @subsection With SASL authentication
1545 The SASL authentication method is a VNC extension, that provides an
1546 easily extendable, pluggable authentication method. This allows for
1547 integration with a wide range of authentication mechanisms, such as
1548 PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1549 The strength of the authentication depends on the exact mechanism
1550 configured. If the chosen mechanism also provides a SSF layer, then
1551 it will encrypt the datastream as well.
1553 Refer to the later docs on how to choose the exact SASL mechanism
1554 used for authentication, but assuming use of one supporting SSF,
1555 then QEMU can be launched with:
1557 @example
1558 qemu-system-i386 [...OPTIONS...] -vnc :1,sasl -monitor stdio
1559 @end example
1561 @node vnc_sec_certificate_sasl
1562 @subsection With x509 certificates and SASL authentication
1564 If the desired SASL authentication mechanism does not supported
1565 SSF layers, then it is strongly advised to run it in combination
1566 with TLS and x509 certificates. This provides securely encrypted
1567 data stream, avoiding risk of compromising of the security
1568 credentials. This can be enabled, by combining the 'sasl' option
1569 with the aforementioned TLS + x509 options:
1571 @example
1572 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1573 @end example
1576 @node vnc_generate_cert
1577 @subsection Generating certificates for VNC
1579 The GNU TLS packages provides a command called @code{certtool} which can
1580 be used to generate certificates and keys in PEM format. At a minimum it
1581 is necessary to setup a certificate authority, and issue certificates to
1582 each server. If using certificates for authentication, then each client
1583 will also need to be issued a certificate. The recommendation is for the
1584 server to keep its certificates in either @code{/etc/pki/qemu} or for
1585 unprivileged users in @code{$HOME/.pki/qemu}.
1587 @menu
1588 * vnc_generate_ca::
1589 * vnc_generate_server::
1590 * vnc_generate_client::
1591 @end menu
1592 @node vnc_generate_ca
1593 @subsubsection Setup the Certificate Authority
1595 This step only needs to be performed once per organization / organizational
1596 unit. First the CA needs a private key. This key must be kept VERY secret
1597 and secure. If this key is compromised the entire trust chain of the certificates
1598 issued with it is lost.
1600 @example
1601 # certtool --generate-privkey > ca-key.pem
1602 @end example
1604 A CA needs to have a public certificate. For simplicity it can be a self-signed
1605 certificate, or one issue by a commercial certificate issuing authority. To
1606 generate a self-signed certificate requires one core piece of information, the
1607 name of the organization.
1609 @example
1610 # cat > ca.info <<EOF
1611 cn = Name of your organization
1613 cert_signing_key
1615 # certtool --generate-self-signed \
1616            --load-privkey ca-key.pem
1617            --template ca.info \
1618            --outfile ca-cert.pem
1619 @end example
1621 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1622 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1624 @node vnc_generate_server
1625 @subsubsection Issuing server certificates
1627 Each server (or host) needs to be issued with a key and certificate. When connecting
1628 the certificate is sent to the client which validates it against the CA certificate.
1629 The core piece of information for a server certificate is the hostname. This should
1630 be the fully qualified hostname that the client will connect with, since the client
1631 will typically also verify the hostname in the certificate. On the host holding the
1632 secure CA private key:
1634 @example
1635 # cat > server.info <<EOF
1636 organization = Name  of your organization
1637 cn = server.foo.example.com
1638 tls_www_server
1639 encryption_key
1640 signing_key
1642 # certtool --generate-privkey > server-key.pem
1643 # certtool --generate-certificate \
1644            --load-ca-certificate ca-cert.pem \
1645            --load-ca-privkey ca-key.pem \
1646            --load-privkey server-key.pem \
1647            --template server.info \
1648            --outfile server-cert.pem
1649 @end example
1651 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1652 to the server for which they were generated. The @code{server-key.pem} is security
1653 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1655 @node vnc_generate_client
1656 @subsubsection Issuing client certificates
1658 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1659 certificates as its authentication mechanism, each client also needs to be issued
1660 a certificate. The client certificate contains enough metadata to uniquely identify
1661 the client, typically organization, state, city, building, etc. On the host holding
1662 the secure CA private key:
1664 @example
1665 # cat > client.info <<EOF
1666 country = GB
1667 state = London
1668 locality = London
1669 organization = Name of your organization
1670 cn = client.foo.example.com
1671 tls_www_client
1672 encryption_key
1673 signing_key
1675 # certtool --generate-privkey > client-key.pem
1676 # certtool --generate-certificate \
1677            --load-ca-certificate ca-cert.pem \
1678            --load-ca-privkey ca-key.pem \
1679            --load-privkey client-key.pem \
1680            --template client.info \
1681            --outfile client-cert.pem
1682 @end example
1684 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1685 copied to the client for which they were generated.
1688 @node vnc_setup_sasl
1690 @subsection Configuring SASL mechanisms
1692 The following documentation assumes use of the Cyrus SASL implementation on a
1693 Linux host, but the principals should apply to any other SASL impl. When SASL
1694 is enabled, the mechanism configuration will be loaded from system default
1695 SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1696 unprivileged user, an environment variable SASL_CONF_PATH can be used
1697 to make it search alternate locations for the service config.
1699 The default configuration might contain
1701 @example
1702 mech_list: digest-md5
1703 sasldb_path: /etc/qemu/passwd.db
1704 @end example
1706 This says to use the 'Digest MD5' mechanism, which is similar to the HTTP
1707 Digest-MD5 mechanism. The list of valid usernames & passwords is maintained
1708 in the /etc/qemu/passwd.db file, and can be updated using the saslpasswd2
1709 command. While this mechanism is easy to configure and use, it is not
1710 considered secure by modern standards, so only suitable for developers /
1711 ad-hoc testing.
1713 A more serious deployment might use Kerberos, which is done with the 'gssapi'
1714 mechanism
1716 @example
1717 mech_list: gssapi
1718 keytab: /etc/qemu/krb5.tab
1719 @end example
1721 For this to work the administrator of your KDC must generate a Kerberos
1722 principal for the server, with a name of  'qemu/somehost.example.com@@EXAMPLE.COM'
1723 replacing 'somehost.example.com' with the fully qualified host name of the
1724 machine running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm.
1726 Other configurations will be left as an exercise for the reader. It should
1727 be noted that only Digest-MD5 and GSSAPI provides a SSF layer for data
1728 encryption. For all other mechanisms, VNC should always be configured to
1729 use TLS and x509 certificates to protect security credentials from snooping.
1731 @node gdb_usage
1732 @section GDB usage
1734 QEMU has a primitive support to work with gdb, so that you can do
1735 'Ctrl-C' while the virtual machine is running and inspect its state.
1737 In order to use gdb, launch QEMU with the '-s' option. It will wait for a
1738 gdb connection:
1739 @example
1740 qemu-system-i386 -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1741                     -append "root=/dev/hda"
1742 Connected to host network interface: tun0
1743 Waiting gdb connection on port 1234
1744 @end example
1746 Then launch gdb on the 'vmlinux' executable:
1747 @example
1748 > gdb vmlinux
1749 @end example
1751 In gdb, connect to QEMU:
1752 @example
1753 (gdb) target remote localhost:1234
1754 @end example
1756 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1757 @example
1758 (gdb) c
1759 @end example
1761 Here are some useful tips in order to use gdb on system code:
1763 @enumerate
1764 @item
1765 Use @code{info reg} to display all the CPU registers.
1766 @item
1767 Use @code{x/10i $eip} to display the code at the PC position.
1768 @item
1769 Use @code{set architecture i8086} to dump 16 bit code. Then use
1770 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1771 @end enumerate
1773 Advanced debugging options:
1775 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:
1776 @table @code
1777 @item maintenance packet qqemu.sstepbits
1779 This will display the MASK bits used to control the single stepping IE:
1780 @example
1781 (gdb) maintenance packet qqemu.sstepbits
1782 sending: "qqemu.sstepbits"
1783 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1784 @end example
1785 @item maintenance packet qqemu.sstep
1787 This will display the current value of the mask used when single stepping IE:
1788 @example
1789 (gdb) maintenance packet qqemu.sstep
1790 sending: "qqemu.sstep"
1791 received: "0x7"
1792 @end example
1793 @item maintenance packet Qqemu.sstep=HEX_VALUE
1795 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1796 @example
1797 (gdb) maintenance packet Qqemu.sstep=0x5
1798 sending: "qemu.sstep=0x5"
1799 received: "OK"
1800 @end example
1801 @end table
1803 @node pcsys_os_specific
1804 @section Target OS specific information
1806 @subsection Linux
1808 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1809 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1810 color depth in the guest and the host OS.
1812 When using a 2.6 guest Linux kernel, you should add the option
1813 @code{clock=pit} on the kernel command line because the 2.6 Linux
1814 kernels make very strict real time clock checks by default that QEMU
1815 cannot simulate exactly.
1817 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1818 not activated because QEMU is slower with this patch. The QEMU
1819 Accelerator Module is also much slower in this case. Earlier Fedora
1820 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1821 patch by default. Newer kernels don't have it.
1823 @subsection Windows
1825 If you have a slow host, using Windows 95 is better as it gives the
1826 best speed. Windows 2000 is also a good choice.
1828 @subsubsection SVGA graphic modes support
1830 QEMU emulates a Cirrus Logic GD5446 Video
1831 card. All Windows versions starting from Windows 95 should recognize
1832 and use this graphic card. For optimal performances, use 16 bit color
1833 depth in the guest and the host OS.
1835 If you are using Windows XP as guest OS and if you want to use high
1836 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1837 1280x1024x16), then you should use the VESA VBE virtual graphic card
1838 (option @option{-std-vga}).
1840 @subsubsection CPU usage reduction
1842 Windows 9x does not correctly use the CPU HLT
1843 instruction. The result is that it takes host CPU cycles even when
1844 idle. You can install the utility from
1845 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1846 problem. Note that no such tool is needed for NT, 2000 or XP.
1848 @subsubsection Windows 2000 disk full problem
1850 Windows 2000 has a bug which gives a disk full problem during its
1851 installation. When installing it, use the @option{-win2k-hack} QEMU
1852 option to enable a specific workaround. After Windows 2000 is
1853 installed, you no longer need this option (this option slows down the
1854 IDE transfers).
1856 @subsubsection Windows 2000 shutdown
1858 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1859 can. It comes from the fact that Windows 2000 does not automatically
1860 use the APM driver provided by the BIOS.
1862 In order to correct that, do the following (thanks to Struan
1863 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1864 Add/Troubleshoot a device => Add a new device & Next => No, select the
1865 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1866 (again) a few times. Now the driver is installed and Windows 2000 now
1867 correctly instructs QEMU to shutdown at the appropriate moment.
1869 @subsubsection Share a directory between Unix and Windows
1871 See @ref{sec_invocation} about the help of the option @option{-smb}.
1873 @subsubsection Windows XP security problem
1875 Some releases of Windows XP install correctly but give a security
1876 error when booting:
1877 @example
1878 A problem is preventing Windows from accurately checking the
1879 license for this computer. Error code: 0x800703e6.
1880 @end example
1882 The workaround is to install a service pack for XP after a boot in safe
1883 mode. Then reboot, and the problem should go away. Since there is no
1884 network while in safe mode, its recommended to download the full
1885 installation of SP1 or SP2 and transfer that via an ISO or using the
1886 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1888 @subsection MS-DOS and FreeDOS
1890 @subsubsection CPU usage reduction
1892 DOS does not correctly use the CPU HLT instruction. The result is that
1893 it takes host CPU cycles even when idle. You can install the utility
1894 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1895 problem.
1897 @node QEMU System emulator for non PC targets
1898 @chapter QEMU System emulator for non PC targets
1900 QEMU is a generic emulator and it emulates many non PC
1901 machines. Most of the options are similar to the PC emulator. The
1902 differences are mentioned in the following sections.
1904 @menu
1905 * PowerPC System emulator::
1906 * Sparc32 System emulator::
1907 * Sparc64 System emulator::
1908 * MIPS System emulator::
1909 * ARM System emulator::
1910 * ColdFire System emulator::
1911 * Cris System emulator::
1912 * Microblaze System emulator::
1913 * SH4 System emulator::
1914 * Xtensa System emulator::
1915 @end menu
1917 @node PowerPC System emulator
1918 @section PowerPC System emulator
1919 @cindex system emulation (PowerPC)
1921 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1922 or PowerMac PowerPC system.
1924 QEMU emulates the following PowerMac peripherals:
1926 @itemize @minus
1927 @item
1928 UniNorth or Grackle PCI Bridge
1929 @item
1930 PCI VGA compatible card with VESA Bochs Extensions
1931 @item
1932 2 PMAC IDE interfaces with hard disk and CD-ROM support
1933 @item
1934 NE2000 PCI adapters
1935 @item
1936 Non Volatile RAM
1937 @item
1938 VIA-CUDA with ADB keyboard and mouse.
1939 @end itemize
1941 QEMU emulates the following PREP peripherals:
1943 @itemize @minus
1944 @item
1945 PCI Bridge
1946 @item
1947 PCI VGA compatible card with VESA Bochs Extensions
1948 @item
1949 2 IDE interfaces with hard disk and CD-ROM support
1950 @item
1951 Floppy disk
1952 @item
1953 NE2000 network adapters
1954 @item
1955 Serial port
1956 @item
1957 PREP Non Volatile RAM
1958 @item
1959 PC compatible keyboard and mouse.
1960 @end itemize
1962 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1963 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1965 Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
1966 for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
1967 v2) portable firmware implementation. The goal is to implement a 100%
1968 IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
1970 @c man begin OPTIONS
1972 The following options are specific to the PowerPC emulation:
1974 @table @option
1976 @item -g @var{W}x@var{H}[x@var{DEPTH}]
1978 Set the initial VGA graphic mode. The default is 800x600x32.
1980 @item -prom-env @var{string}
1982 Set OpenBIOS variables in NVRAM, for example:
1984 @example
1985 qemu-system-ppc -prom-env 'auto-boot?=false' \
1986  -prom-env 'boot-device=hd:2,\yaboot' \
1987  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
1988 @end example
1990 These variables are not used by Open Hack'Ware.
1992 @end table
1994 @c man end
1997 More information is available at
1998 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2000 @node Sparc32 System emulator
2001 @section Sparc32 System emulator
2002 @cindex system emulation (Sparc32)
2004 Use the executable @file{qemu-system-sparc} to simulate the following
2005 Sun4m architecture machines:
2006 @itemize @minus
2007 @item
2008 SPARCstation 4
2009 @item
2010 SPARCstation 5
2011 @item
2012 SPARCstation 10
2013 @item
2014 SPARCstation 20
2015 @item
2016 SPARCserver 600MP
2017 @item
2018 SPARCstation LX
2019 @item
2020 SPARCstation Voyager
2021 @item
2022 SPARCclassic
2023 @item
2024 SPARCbook
2025 @end itemize
2027 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
2028 but Linux limits the number of usable CPUs to 4.
2030 QEMU emulates the following sun4m peripherals:
2032 @itemize @minus
2033 @item
2034 IOMMU
2035 @item
2036 TCX or cgthree Frame buffer
2037 @item
2038 Lance (Am7990) Ethernet
2039 @item
2040 Non Volatile RAM M48T02/M48T08
2041 @item
2042 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2043 and power/reset logic
2044 @item
2045 ESP SCSI controller with hard disk and CD-ROM support
2046 @item
2047 Floppy drive (not on SS-600MP)
2048 @item
2049 CS4231 sound device (only on SS-5, not working yet)
2050 @end itemize
2052 The number of peripherals is fixed in the architecture.  Maximum
2053 memory size depends on the machine type, for SS-5 it is 256MB and for
2054 others 2047MB.
2056 Since version 0.8.2, QEMU uses OpenBIOS
2057 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2058 firmware implementation. The goal is to implement a 100% IEEE
2059 1275-1994 (referred to as Open Firmware) compliant firmware.
2061 A sample Linux 2.6 series kernel and ram disk image are available on
2062 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
2063 most kernel versions work. Please note that currently older Solaris kernels
2064 don't work probably due to interface issues between OpenBIOS and
2065 Solaris.
2067 @c man begin OPTIONS
2069 The following options are specific to the Sparc32 emulation:
2071 @table @option
2073 @item -g @var{W}x@var{H}x[x@var{DEPTH}]
2075 Set the initial graphics mode. For TCX, the default is 1024x768x8 with the
2076 option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
2077 of 1152x900x8 for people who wish to use OBP.
2079 @item -prom-env @var{string}
2081 Set OpenBIOS variables in NVRAM, for example:
2083 @example
2084 qemu-system-sparc -prom-env 'auto-boot?=false' \
2085  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2086 @end example
2088 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]
2090 Set the emulated machine type. Default is SS-5.
2092 @end table
2094 @c man end
2096 @node Sparc64 System emulator
2097 @section Sparc64 System emulator
2098 @cindex system emulation (Sparc64)
2100 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
2101 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
2102 Niagara (T1) machine. The Sun4u emulator is mostly complete, being
2103 able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The
2104 Sun4v and Niagara emulators are still a work in progress.
2106 QEMU emulates the following peripherals:
2108 @itemize @minus
2109 @item
2110 UltraSparc IIi APB PCI Bridge
2111 @item
2112 PCI VGA compatible card with VESA Bochs Extensions
2113 @item
2114 PS/2 mouse and keyboard
2115 @item
2116 Non Volatile RAM M48T59
2117 @item
2118 PC-compatible serial ports
2119 @item
2120 2 PCI IDE interfaces with hard disk and CD-ROM support
2121 @item
2122 Floppy disk
2123 @end itemize
2125 @c man begin OPTIONS
2127 The following options are specific to the Sparc64 emulation:
2129 @table @option
2131 @item -prom-env @var{string}
2133 Set OpenBIOS variables in NVRAM, for example:
2135 @example
2136 qemu-system-sparc64 -prom-env 'auto-boot?=false'
2137 @end example
2139 @item -M [sun4u|sun4v|Niagara]
2141 Set the emulated machine type. The default is sun4u.
2143 @end table
2145 @c man end
2147 @node MIPS System emulator
2148 @section MIPS System emulator
2149 @cindex system emulation (MIPS)
2151 Four executables cover simulation of 32 and 64-bit MIPS systems in
2152 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2153 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2154 Five different machine types are emulated:
2156 @itemize @minus
2157 @item
2158 A generic ISA PC-like machine "mips"
2159 @item
2160 The MIPS Malta prototype board "malta"
2161 @item
2162 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2163 @item
2164 MIPS emulator pseudo board "mipssim"
2165 @item
2166 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2167 @end itemize
2169 The generic emulation is supported by Debian 'Etch' and is able to
2170 install Debian into a virtual disk image. The following devices are
2171 emulated:
2173 @itemize @minus
2174 @item
2175 A range of MIPS CPUs, default is the 24Kf
2176 @item
2177 PC style serial port
2178 @item
2179 PC style IDE disk
2180 @item
2181 NE2000 network card
2182 @end itemize
2184 The Malta emulation supports the following devices:
2186 @itemize @minus
2187 @item
2188 Core board with MIPS 24Kf CPU and Galileo system controller
2189 @item
2190 PIIX4 PCI/USB/SMbus controller
2191 @item
2192 The Multi-I/O chip's serial device
2193 @item
2194 PCI network cards (PCnet32 and others)
2195 @item
2196 Malta FPGA serial device
2197 @item
2198 Cirrus (default) or any other PCI VGA graphics card
2199 @end itemize
2201 The ACER Pica emulation supports:
2203 @itemize @minus
2204 @item
2205 MIPS R4000 CPU
2206 @item
2207 PC-style IRQ and DMA controllers
2208 @item
2209 PC Keyboard
2210 @item
2211 IDE controller
2212 @end itemize
2214 The mipssim pseudo board emulation provides an environment similar
2215 to what the proprietary MIPS emulator uses for running Linux.
2216 It supports:
2218 @itemize @minus
2219 @item
2220 A range of MIPS CPUs, default is the 24Kf
2221 @item
2222 PC style serial port
2223 @item
2224 MIPSnet network emulation
2225 @end itemize
2227 The MIPS Magnum R4000 emulation supports:
2229 @itemize @minus
2230 @item
2231 MIPS R4000 CPU
2232 @item
2233 PC-style IRQ controller
2234 @item
2235 PC Keyboard
2236 @item
2237 SCSI controller
2238 @item
2239 G364 framebuffer
2240 @end itemize
2243 @node ARM System emulator
2244 @section ARM System emulator
2245 @cindex system emulation (ARM)
2247 Use the executable @file{qemu-system-arm} to simulate a ARM
2248 machine. The ARM Integrator/CP board is emulated with the following
2249 devices:
2251 @itemize @minus
2252 @item
2253 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2254 @item
2255 Two PL011 UARTs
2256 @item
2257 SMC 91c111 Ethernet adapter
2258 @item
2259 PL110 LCD controller
2260 @item
2261 PL050 KMI with PS/2 keyboard and mouse.
2262 @item
2263 PL181 MultiMedia Card Interface with SD card.
2264 @end itemize
2266 The ARM Versatile baseboard is emulated with the following devices:
2268 @itemize @minus
2269 @item
2270 ARM926E, ARM1136 or Cortex-A8 CPU
2271 @item
2272 PL190 Vectored Interrupt Controller
2273 @item
2274 Four PL011 UARTs
2275 @item
2276 SMC 91c111 Ethernet adapter
2277 @item
2278 PL110 LCD controller
2279 @item
2280 PL050 KMI with PS/2 keyboard and mouse.
2281 @item
2282 PCI host bridge.  Note the emulated PCI bridge only provides access to
2283 PCI memory space.  It does not provide access to PCI IO space.
2284 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2285 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2286 mapped control registers.
2287 @item
2288 PCI OHCI USB controller.
2289 @item
2290 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2291 @item
2292 PL181 MultiMedia Card Interface with SD card.
2293 @end itemize
2295 Several variants of the ARM RealView baseboard are emulated,
2296 including the EB, PB-A8 and PBX-A9.  Due to interactions with the
2297 bootloader, only certain Linux kernel configurations work out
2298 of the box on these boards.
2300 Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2301 enabled in the kernel, and expect 512M RAM.  Kernels for The PBX-A9 board
2302 should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2303 disabled and expect 1024M RAM.
2305 The following devices are emulated:
2307 @itemize @minus
2308 @item
2309 ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
2310 @item
2311 ARM AMBA Generic/Distributed Interrupt Controller
2312 @item
2313 Four PL011 UARTs
2314 @item
2315 SMC 91c111 or SMSC LAN9118 Ethernet adapter
2316 @item
2317 PL110 LCD controller
2318 @item
2319 PL050 KMI with PS/2 keyboard and mouse
2320 @item
2321 PCI host bridge
2322 @item
2323 PCI OHCI USB controller
2324 @item
2325 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2326 @item
2327 PL181 MultiMedia Card Interface with SD card.
2328 @end itemize
2330 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2331 and "Terrier") emulation includes the following peripherals:
2333 @itemize @minus
2334 @item
2335 Intel PXA270 System-on-chip (ARM V5TE core)
2336 @item
2337 NAND Flash memory
2338 @item
2339 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2340 @item
2341 On-chip OHCI USB controller
2342 @item
2343 On-chip LCD controller
2344 @item
2345 On-chip Real Time Clock
2346 @item
2347 TI ADS7846 touchscreen controller on SSP bus
2348 @item
2349 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2350 @item
2351 GPIO-connected keyboard controller and LEDs
2352 @item
2353 Secure Digital card connected to PXA MMC/SD host
2354 @item
2355 Three on-chip UARTs
2356 @item
2357 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2358 @end itemize
2360 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2361 following elements:
2363 @itemize @minus
2364 @item
2365 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2366 @item
2367 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2368 @item
2369 On-chip LCD controller
2370 @item
2371 On-chip Real Time Clock
2372 @item
2373 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2374 CODEC, connected through MicroWire and I@math{^2}S busses
2375 @item
2376 GPIO-connected matrix keypad
2377 @item
2378 Secure Digital card connected to OMAP MMC/SD host
2379 @item
2380 Three on-chip UARTs
2381 @end itemize
2383 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2384 emulation supports the following elements:
2386 @itemize @minus
2387 @item
2388 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2389 @item
2390 RAM and non-volatile OneNAND Flash memories
2391 @item
2392 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2393 display controller and a LS041y3 MIPI DBI-C controller
2394 @item
2395 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2396 driven through SPI bus
2397 @item
2398 National Semiconductor LM8323-controlled qwerty keyboard driven
2399 through I@math{^2}C bus
2400 @item
2401 Secure Digital card connected to OMAP MMC/SD host
2402 @item
2403 Three OMAP on-chip UARTs and on-chip STI debugging console
2404 @item
2405 A Bluetooth(R) transceiver and HCI connected to an UART
2406 @item
2407 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2408 TUSB6010 chip - only USB host mode is supported
2409 @item
2410 TI TMP105 temperature sensor driven through I@math{^2}C bus
2411 @item
2412 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2413 @item
2414 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2415 through CBUS
2416 @end itemize
2418 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2419 devices:
2421 @itemize @minus
2422 @item
2423 Cortex-M3 CPU core.
2424 @item
2425 64k Flash and 8k SRAM.
2426 @item
2427 Timers, UARTs, ADC and I@math{^2}C interface.
2428 @item
2429 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2430 @end itemize
2432 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2433 devices:
2435 @itemize @minus
2436 @item
2437 Cortex-M3 CPU core.
2438 @item
2439 256k Flash and 64k SRAM.
2440 @item
2441 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2442 @item
2443 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2444 @end itemize
2446 The Freecom MusicPal internet radio emulation includes the following
2447 elements:
2449 @itemize @minus
2450 @item
2451 Marvell MV88W8618 ARM core.
2452 @item
2453 32 MB RAM, 256 KB SRAM, 8 MB flash.
2454 @item
2455 Up to 2 16550 UARTs
2456 @item
2457 MV88W8xx8 Ethernet controller
2458 @item
2459 MV88W8618 audio controller, WM8750 CODEC and mixer
2460 @item
2461 128×64 display with brightness control
2462 @item
2463 2 buttons, 2 navigation wheels with button function
2464 @end itemize
2466 The Siemens SX1 models v1 and v2 (default) basic emulation.
2467 The emulation includes the following elements:
2469 @itemize @minus
2470 @item
2471 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2472 @item
2473 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2475 1 Flash of 16MB and 1 Flash of 8MB
2477 1 Flash of 32MB
2478 @item
2479 On-chip LCD controller
2480 @item
2481 On-chip Real Time Clock
2482 @item
2483 Secure Digital card connected to OMAP MMC/SD host
2484 @item
2485 Three on-chip UARTs
2486 @end itemize
2488 A Linux 2.6 test image is available on the QEMU web site. More
2489 information is available in the QEMU mailing-list archive.
2491 @c man begin OPTIONS
2493 The following options are specific to the ARM emulation:
2495 @table @option
2497 @item -semihosting
2498 Enable semihosting syscall emulation.
2500 On ARM this implements the "Angel" interface.
2502 Note that this allows guest direct access to the host filesystem,
2503 so should only be used with trusted guest OS.
2505 @end table
2507 @node ColdFire System emulator
2508 @section ColdFire System emulator
2509 @cindex system emulation (ColdFire)
2510 @cindex system emulation (M68K)
2512 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2513 The emulator is able to boot a uClinux kernel.
2515 The M5208EVB emulation includes the following devices:
2517 @itemize @minus
2518 @item
2519 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2520 @item
2521 Three Two on-chip UARTs.
2522 @item
2523 Fast Ethernet Controller (FEC)
2524 @end itemize
2526 The AN5206 emulation includes the following devices:
2528 @itemize @minus
2529 @item
2530 MCF5206 ColdFire V2 Microprocessor.
2531 @item
2532 Two on-chip UARTs.
2533 @end itemize
2535 @c man begin OPTIONS
2537 The following options are specific to the ColdFire emulation:
2539 @table @option
2541 @item -semihosting
2542 Enable semihosting syscall emulation.
2544 On M68K this implements the "ColdFire GDB" interface used by libgloss.
2546 Note that this allows guest direct access to the host filesystem,
2547 so should only be used with trusted guest OS.
2549 @end table
2551 @node Cris System emulator
2552 @section Cris System emulator
2553 @cindex system emulation (Cris)
2555 TODO
2557 @node Microblaze System emulator
2558 @section Microblaze System emulator
2559 @cindex system emulation (Microblaze)
2561 TODO
2563 @node SH4 System emulator
2564 @section SH4 System emulator
2565 @cindex system emulation (SH4)
2567 TODO
2569 @node Xtensa System emulator
2570 @section Xtensa System emulator
2571 @cindex system emulation (Xtensa)
2573 Two executables cover simulation of both Xtensa endian options,
2574 @file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}.
2575 Two different machine types are emulated:
2577 @itemize @minus
2578 @item
2579 Xtensa emulator pseudo board "sim"
2580 @item
2581 Avnet LX60/LX110/LX200 board
2582 @end itemize
2584 The sim pseudo board emulation provides an environment similar
2585 to one provided by the proprietary Tensilica ISS.
2586 It supports:
2588 @itemize @minus
2589 @item
2590 A range of Xtensa CPUs, default is the DC232B
2591 @item
2592 Console and filesystem access via semihosting calls
2593 @end itemize
2595 The Avnet LX60/LX110/LX200 emulation supports:
2597 @itemize @minus
2598 @item
2599 A range of Xtensa CPUs, default is the DC232B
2600 @item
2601 16550 UART
2602 @item
2603 OpenCores 10/100 Mbps Ethernet MAC
2604 @end itemize
2606 @c man begin OPTIONS
2608 The following options are specific to the Xtensa emulation:
2610 @table @option
2612 @item -semihosting
2613 Enable semihosting syscall emulation.
2615 Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select.
2616 Tensilica baremetal libc for ISS and linux platform "sim" use this interface.
2618 Note that this allows guest direct access to the host filesystem,
2619 so should only be used with trusted guest OS.
2621 @end table
2622 @node QEMU User space emulator
2623 @chapter QEMU User space emulator
2625 @menu
2626 * Supported Operating Systems ::
2627 * Linux User space emulator::
2628 * BSD User space emulator ::
2629 @end menu
2631 @node Supported Operating Systems
2632 @section Supported Operating Systems
2634 The following OS are supported in user space emulation:
2636 @itemize @minus
2637 @item
2638 Linux (referred as qemu-linux-user)
2639 @item
2640 BSD (referred as qemu-bsd-user)
2641 @end itemize
2643 @node Linux User space emulator
2644 @section Linux User space emulator
2646 @menu
2647 * Quick Start::
2648 * Wine launch::
2649 * Command line options::
2650 * Other binaries::
2651 @end menu
2653 @node Quick Start
2654 @subsection Quick Start
2656 In order to launch a Linux process, QEMU needs the process executable
2657 itself and all the target (x86) dynamic libraries used by it.
2659 @itemize
2661 @item On x86, you can just try to launch any process by using the native
2662 libraries:
2664 @example
2665 qemu-i386 -L / /bin/ls
2666 @end example
2668 @code{-L /} tells that the x86 dynamic linker must be searched with a
2669 @file{/} prefix.
2671 @item Since QEMU is also a linux process, you can launch QEMU with
2672 QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
2674 @example
2675 qemu-i386 -L / qemu-i386 -L / /bin/ls
2676 @end example
2678 @item On non x86 CPUs, you need first to download at least an x86 glibc
2679 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2680 @code{LD_LIBRARY_PATH} is not set:
2682 @example
2683 unset LD_LIBRARY_PATH
2684 @end example
2686 Then you can launch the precompiled @file{ls} x86 executable:
2688 @example
2689 qemu-i386 tests/i386/ls
2690 @end example
2691 You can look at @file{scripts/qemu-binfmt-conf.sh} so that
2692 QEMU is automatically launched by the Linux kernel when you try to
2693 launch x86 executables. It requires the @code{binfmt_misc} module in the
2694 Linux kernel.
2696 @item The x86 version of QEMU is also included. You can try weird things such as:
2697 @example
2698 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2699           /usr/local/qemu-i386/bin/ls-i386
2700 @end example
2702 @end itemize
2704 @node Wine launch
2705 @subsection Wine launch
2707 @itemize
2709 @item Ensure that you have a working QEMU with the x86 glibc
2710 distribution (see previous section). In order to verify it, you must be
2711 able to do:
2713 @example
2714 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2715 @end example
2717 @item Download the binary x86 Wine install
2718 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2720 @item Configure Wine on your account. Look at the provided script
2721 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2722 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2724 @item Then you can try the example @file{putty.exe}:
2726 @example
2727 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2728           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2729 @end example
2731 @end itemize
2733 @node Command line options
2734 @subsection Command line options
2736 @example
2737 usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
2738 @end example
2740 @table @option
2741 @item -h
2742 Print the help
2743 @item -L path
2744 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2745 @item -s size
2746 Set the x86 stack size in bytes (default=524288)
2747 @item -cpu model
2748 Select CPU model (-cpu help for list and additional feature selection)
2749 @item -E @var{var}=@var{value}
2750 Set environment @var{var} to @var{value}.
2751 @item -U @var{var}
2752 Remove @var{var} from the environment.
2753 @item -B offset
2754 Offset guest address by the specified number of bytes.  This is useful when
2755 the address region required by guest applications is reserved on the host.
2756 This option is currently only supported on some hosts.
2757 @item -R size
2758 Pre-allocate a guest virtual address space of the given size (in bytes).
2759 "G", "M", and "k" suffixes may be used when specifying the size.
2760 @end table
2762 Debug options:
2764 @table @option
2765 @item -d item1,...
2766 Activate logging of the specified items (use '-d help' for a list of log items)
2767 @item -p pagesize
2768 Act as if the host page size was 'pagesize' bytes
2769 @item -g port
2770 Wait gdb connection to port
2771 @item -singlestep
2772 Run the emulation in single step mode.
2773 @end table
2775 Environment variables:
2777 @table @env
2778 @item QEMU_STRACE
2779 Print system calls and arguments similar to the 'strace' program
2780 (NOTE: the actual 'strace' program will not work because the user
2781 space emulator hasn't implemented ptrace).  At the moment this is
2782 incomplete.  All system calls that don't have a specific argument
2783 format are printed with information for six arguments.  Many
2784 flag-style arguments don't have decoders and will show up as numbers.
2785 @end table
2787 @node Other binaries
2788 @subsection Other binaries
2790 @cindex user mode (Alpha)
2791 @command{qemu-alpha} TODO.
2793 @cindex user mode (ARM)
2794 @command{qemu-armeb} TODO.
2796 @cindex user mode (ARM)
2797 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2798 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2799 configurations), and arm-uclinux bFLT format binaries.
2801 @cindex user mode (ColdFire)
2802 @cindex user mode (M68K)
2803 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2804 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2805 coldfire uClinux bFLT format binaries.
2807 The binary format is detected automatically.
2809 @cindex user mode (Cris)
2810 @command{qemu-cris} TODO.
2812 @cindex user mode (i386)
2813 @command{qemu-i386} TODO.
2814 @command{qemu-x86_64} TODO.
2816 @cindex user mode (Microblaze)
2817 @command{qemu-microblaze} TODO.
2819 @cindex user mode (MIPS)
2820 @command{qemu-mips} TODO.
2821 @command{qemu-mipsel} TODO.
2823 @cindex user mode (PowerPC)
2824 @command{qemu-ppc64abi32} TODO.
2825 @command{qemu-ppc64} TODO.
2826 @command{qemu-ppc} TODO.
2828 @cindex user mode (SH4)
2829 @command{qemu-sh4eb} TODO.
2830 @command{qemu-sh4} TODO.
2832 @cindex user mode (SPARC)
2833 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2835 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2836 (Sparc64 CPU, 32 bit ABI).
2838 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2839 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2841 @node BSD User space emulator
2842 @section BSD User space emulator
2844 @menu
2845 * BSD Status::
2846 * BSD Quick Start::
2847 * BSD Command line options::
2848 @end menu
2850 @node BSD Status
2851 @subsection BSD Status
2853 @itemize @minus
2854 @item
2855 target Sparc64 on Sparc64: Some trivial programs work.
2856 @end itemize
2858 @node BSD Quick Start
2859 @subsection Quick Start
2861 In order to launch a BSD process, QEMU needs the process executable
2862 itself and all the target dynamic libraries used by it.
2864 @itemize
2866 @item On Sparc64, you can just try to launch any process by using the native
2867 libraries:
2869 @example
2870 qemu-sparc64 /bin/ls
2871 @end example
2873 @end itemize
2875 @node BSD Command line options
2876 @subsection Command line options
2878 @example
2879 usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
2880 @end example
2882 @table @option
2883 @item -h
2884 Print the help
2885 @item -L path
2886 Set the library root path (default=/)
2887 @item -s size
2888 Set the stack size in bytes (default=524288)
2889 @item -ignore-environment
2890 Start with an empty environment. Without this option,
2891 the initial environment is a copy of the caller's environment.
2892 @item -E @var{var}=@var{value}
2893 Set environment @var{var} to @var{value}.
2894 @item -U @var{var}
2895 Remove @var{var} from the environment.
2896 @item -bsd type
2897 Set the type of the emulated BSD Operating system. Valid values are
2898 FreeBSD, NetBSD and OpenBSD (default).
2899 @end table
2901 Debug options:
2903 @table @option
2904 @item -d item1,...
2905 Activate logging of the specified items (use '-d help' for a list of log items)
2906 @item -p pagesize
2907 Act as if the host page size was 'pagesize' bytes
2908 @item -singlestep
2909 Run the emulation in single step mode.
2910 @end table
2912 @node compilation
2913 @chapter Compilation from the sources
2915 @menu
2916 * Linux/Unix::
2917 * Windows::
2918 * Cross compilation for Windows with Linux::
2919 * Mac OS X::
2920 * Make targets::
2921 @end menu
2923 @node Linux/Unix
2924 @section Linux/Unix
2926 @subsection Compilation
2928 First you must decompress the sources:
2929 @example
2930 cd /tmp
2931 tar zxvf qemu-x.y.z.tar.gz
2932 cd qemu-x.y.z
2933 @end example
2935 Then you configure QEMU and build it (usually no options are needed):
2936 @example
2937 ./configure
2938 make
2939 @end example
2941 Then type as root user:
2942 @example
2943 make install
2944 @end example
2945 to install QEMU in @file{/usr/local}.
2947 @node Windows
2948 @section Windows
2950 @itemize
2951 @item Install the current versions of MSYS and MinGW from
2952 @url{http://www.mingw.org/}. You can find detailed installation
2953 instructions in the download section and the FAQ.
2955 @item Download
2956 the MinGW development library of SDL 1.2.x
2957 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2958 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2959 edit the @file{sdl-config} script so that it gives the
2960 correct SDL directory when invoked.
2962 @item Install the MinGW version of zlib and make sure
2963 @file{zlib.h} and @file{libz.dll.a} are in
2964 MinGW's default header and linker search paths.
2966 @item Extract the current version of QEMU.
2968 @item Start the MSYS shell (file @file{msys.bat}).
2970 @item Change to the QEMU directory. Launch @file{./configure} and
2971 @file{make}.  If you have problems using SDL, verify that
2972 @file{sdl-config} can be launched from the MSYS command line.
2974 @item You can install QEMU in @file{Program Files/QEMU} by typing
2975 @file{make install}. Don't forget to copy @file{SDL.dll} in
2976 @file{Program Files/QEMU}.
2978 @end itemize
2980 @node Cross compilation for Windows with Linux
2981 @section Cross compilation for Windows with Linux
2983 @itemize
2984 @item
2985 Install the MinGW cross compilation tools available at
2986 @url{http://www.mingw.org/}.
2988 @item Download
2989 the MinGW development library of SDL 1.2.x
2990 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2991 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2992 edit the @file{sdl-config} script so that it gives the
2993 correct SDL directory when invoked.  Set up the @code{PATH} environment
2994 variable so that @file{sdl-config} can be launched by
2995 the QEMU configuration script.
2997 @item Install the MinGW version of zlib and make sure
2998 @file{zlib.h} and @file{libz.dll.a} are in
2999 MinGW's default header and linker search paths.
3001 @item
3002 Configure QEMU for Windows cross compilation:
3003 @example
3004 PATH=/usr/i686-pc-mingw32/sys-root/mingw/bin:$PATH ./configure --cross-prefix='i686-pc-mingw32-'
3005 @end example
3006 The example assumes @file{sdl-config} is installed under @file{/usr/i686-pc-mingw32/sys-root/mingw/bin} and
3007 MinGW cross compilation tools have names like @file{i686-pc-mingw32-gcc} and @file{i686-pc-mingw32-strip}.
3008 We set the @code{PATH} environment variable to ensure the MinGW version of @file{sdl-config} is used and
3009 use --cross-prefix to specify the name of the cross compiler.
3010 You can also use --prefix to set the Win32 install path which defaults to @file{c:/Program Files/QEMU}.
3012 Under Fedora Linux, you can run:
3013 @example
3014 yum -y install mingw32-gcc mingw32-SDL mingw32-zlib
3015 @end example
3016 to get a suitable cross compilation environment.
3018 @item You can install QEMU in the installation directory by typing
3019 @code{make install}. Don't forget to copy @file{SDL.dll} and @file{zlib1.dll} into the
3020 installation directory.
3022 @end itemize
3024 Wine can be used to launch the resulting qemu-system-i386.exe
3025 and all other qemu-system-@var{target}.exe compiled for Win32.
3027 @node Mac OS X
3028 @section Mac OS X
3030 System Requirements:
3031 @itemize
3032 @item Mac OS 10.5 or higher
3033 @item The clang compiler shipped with Xcode 4.2 or higher,
3034 or GCC 4.3 or higher
3035 @end itemize
3037 Additional Requirements (install in order):
3038 @enumerate
3039 @item libffi: @uref{https://sourceware.org/libffi/}
3040 @item gettext: @uref{http://www.gnu.org/software/gettext/}
3041 @item glib: @uref{http://ftp.gnome.org/pub/GNOME/sources/glib/}
3042 @item pkg-config: @uref{http://www.freedesktop.org/wiki/Software/pkg-config/}
3043 @item autoconf: @uref{http://www.gnu.org/software/autoconf/autoconf.html}
3044 @item automake: @uref{http://www.gnu.org/software/automake/}
3045 @item libtool: @uref{http://www.gnu.org/software/libtool/}
3046 @item pixman: @uref{http://www.pixman.org/}
3047 @end enumerate
3049 * You may find it easiest to get these from a third-party packager
3050 such as Homebrew, Macports, or Fink.
3052 After downloading the QEMU source code, double-click it to expand it.
3054 Then configure and make QEMU:
3055 @example
3056 ./configure
3057 make
3058 @end example
3060 If you have a recent version of Mac OS X (OSX 10.7 or better
3061 with Xcode 4.2 or better) we recommend building QEMU with the
3062 default compiler provided by Apple, for your version of Mac OS X
3063 (which will be 'clang'). The configure script will
3064 automatically pick this.
3066 Note: If after the configure step you see a message like this:
3067 @example
3068 ERROR: Your compiler does not support the __thread specifier for
3069        Thread-Local Storage (TLS). Please upgrade to a version that does.
3070 @end example
3071 you may have to build your own version of gcc from source. Expect that to take
3072 several hours. More information can be found here:
3073 @uref{https://gcc.gnu.org/install/} @*
3075 These are some of the third party binaries of gcc available for download:
3076 @itemize
3077 @item Homebrew: @uref{http://brew.sh/}
3078 @item @uref{https://www.litebeam.net/gcc/gcc_472.pkg}
3079 @item @uref{http://www.macports.org/ports.php?by=name&substr=gcc}
3080 @end itemize
3082 You can have several versions of GCC on your system. To specify a certain version,
3083 use the --cc and --cxx options.
3084 @example
3085 ./configure --cxx=<path of your c++ compiler> --cc=<path of your c compiler> <other options>
3086 @end example
3088 @node Make targets
3089 @section Make targets
3091 @table @code
3093 @item make
3094 @item make all
3095 Make everything which is typically needed.
3097 @item install
3098 TODO
3100 @item install-doc
3101 TODO
3103 @item make clean
3104 Remove most files which were built during make.
3106 @item make distclean
3107 Remove everything which was built during make.
3109 @item make dvi
3110 @item make html
3111 @item make info
3112 @item make pdf
3113 Create documentation in dvi, html, info or pdf format.
3115 @item make cscope
3116 TODO
3118 @item make defconfig
3119 (Re-)create some build configuration files.
3120 User made changes will be overwritten.
3122 @item tar
3123 @item tarbin
3124 TODO
3126 @end table
3128 @node License
3129 @appendix License
3131 QEMU is a trademark of Fabrice Bellard.
3133 QEMU is released under the GNU General Public License (TODO: add link).
3134 Parts of QEMU have specific licenses, see file LICENSE.
3136 TODO (refer to file LICENSE, include it, include the GPL?)
3138 @node Index
3139 @appendix Index
3140 @menu
3141 * Concept Index::
3142 * Function Index::
3143 * Keystroke Index::
3144 * Program Index::
3145 * Data Type Index::
3146 * Variable Index::
3147 @end menu
3149 @node Concept Index
3150 @section Concept Index
3151 This is the main index. Should we combine all keywords in one index? TODO
3152 @printindex cp
3154 @node Function Index
3155 @section Function Index
3156 This index could be used for command line options and monitor functions.
3157 @printindex fn
3159 @node Keystroke Index
3160 @section Keystroke Index
3162 This is a list of all keystrokes which have a special function
3163 in system emulation.
3165 @printindex ky
3167 @node Program Index
3168 @section Program Index
3169 @printindex pg
3171 @node Data Type Index
3172 @section Data Type Index
3174 This index could be used for qdev device names and options.
3176 @printindex tp
3178 @node Variable Index
3179 @section Variable Index
3180 @printindex vr
3182 @bye