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