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