simpletrace: fix process() argument count
[qemu.git] / qemu-doc.texi
blob31199f6004f414cd380eee45715c72913f96ba04
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename qemu-doc.info
5 @documentlanguage en
6 @documentencoding UTF-8
8 @settitle QEMU Emulator User Documentation
9 @exampleindent 0
10 @paragraphindent 0
11 @c %**end of header
13 @ifinfo
14 @direntry
15 * QEMU: (qemu-doc).    The QEMU Emulator User Documentation.
16 @end direntry
17 @end ifinfo
19 @iftex
20 @titlepage
21 @sp 7
22 @center @titlefont{QEMU Emulator}
23 @sp 1
24 @center @titlefont{User Documentation}
25 @sp 3
26 @end titlepage
27 @end iftex
29 @ifnottex
30 @node Top
31 @top
33 @menu
34 * Introduction::
35 * Installation::
36 * QEMU PC System emulator::
37 * QEMU System emulator for non PC targets::
38 * QEMU User space emulator::
39 * compilation:: Compilation from the sources
40 * License::
41 * Index::
42 @end menu
43 @end ifnottex
45 @contents
47 @node Introduction
48 @chapter Introduction
50 @menu
51 * intro_features:: Features
52 @end menu
54 @node intro_features
55 @section Features
57 QEMU is a FAST! processor emulator using dynamic translation to
58 achieve good emulation speed.
60 QEMU has two operating modes:
62 @itemize
63 @cindex operating modes
65 @item
66 @cindex system emulation
67 Full system emulation. In this mode, QEMU emulates a full system (for
68 example a PC), including one or several processors and various
69 peripherals. It can be used to launch different Operating Systems
70 without rebooting the PC or to debug system code.
72 @item
73 @cindex user mode emulation
74 User mode emulation. In this mode, QEMU can launch
75 processes compiled for one CPU on another CPU. It can be used to
76 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
77 to ease cross-compilation and cross-debugging.
79 @end itemize
81 QEMU can run without an host kernel driver and yet gives acceptable
82 performance.
84 For system emulation, the following hardware targets are supported:
85 @itemize
86 @cindex emulated target systems
87 @cindex supported target systems
88 @item PC (x86 or x86_64 processor)
89 @item ISA PC (old style PC without PCI bus)
90 @item PREP (PowerPC processor)
91 @item G3 Beige PowerMac (PowerPC processor)
92 @item Mac99 PowerMac (PowerPC processor, in progress)
93 @item Sun4m/Sun4c/Sun4d (32-bit Sparc processor)
94 @item Sun4u/Sun4v (64-bit Sparc processor, in progress)
95 @item Malta board (32-bit and 64-bit MIPS processors)
96 @item MIPS Magnum (64-bit MIPS processor)
97 @item ARM Integrator/CP (ARM)
98 @item ARM Versatile baseboard (ARM)
99 @item ARM RealView Emulation/Platform baseboard (ARM)
100 @item Spitz, Akita, Borzoi, Terrier and Tosa PDAs (PXA270 processor)
101 @item Luminary Micro LM3S811EVB (ARM Cortex-M3)
102 @item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
103 @item Freescale MCF5208EVB (ColdFire V2).
104 @item Arnewsh MCF5206 evaluation board (ColdFire V2).
105 @item Palm Tungsten|E PDA (OMAP310 processor)
106 @item N800 and N810 tablets (OMAP2420 processor)
107 @item MusicPal (MV88W8618 ARM processor)
108 @item Gumstix "Connex" and "Verdex" motherboards (PXA255/270).
109 @item Siemens SX1 smartphone (OMAP310 processor)
110 @item Syborg SVP base model (ARM Cortex-A8).
111 @item AXIS-Devboard88 (CRISv32 ETRAX-FS).
112 @item Petalogix Spartan 3aDSP1800 MMU ref design (MicroBlaze).
113 @end itemize
115 @cindex supported user mode targets
116 For user emulation, x86 (32 and 64 bit), PowerPC (32 and 64 bit),
117 ARM, MIPS (32 bit only), Sparc (32 and 64 bit),
118 Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
120 @node Installation
121 @chapter Installation
123 If you want to compile QEMU yourself, see @ref{compilation}.
125 @menu
126 * install_linux::   Linux
127 * install_windows:: Windows
128 * install_mac::     Macintosh
129 @end menu
131 @node install_linux
132 @section Linux
133 @cindex installation (Linux)
135 If a precompiled package is available for your distribution - you just
136 have to install it. Otherwise, see @ref{compilation}.
138 @node install_windows
139 @section Windows
140 @cindex installation (Windows)
142 Download the experimental binary installer at
143 @url{http://www.free.oszoo.org/@/download.html}.
144 TODO (no longer available)
146 @node install_mac
147 @section Mac OS X
149 Download the experimental binary installer at
150 @url{http://www.free.oszoo.org/@/download.html}.
151 TODO (no longer available)
153 @node QEMU PC System emulator
154 @chapter QEMU PC System emulator
155 @cindex system emulation (PC)
157 @menu
158 * pcsys_introduction:: Introduction
159 * pcsys_quickstart::   Quick Start
160 * sec_invocation::     Invocation
161 * pcsys_keys::         Keys
162 * pcsys_monitor::      QEMU Monitor
163 * disk_images::        Disk Images
164 * pcsys_network::      Network emulation
165 * pcsys_other_devs::   Other Devices
166 * direct_linux_boot::  Direct Linux Boot
167 * pcsys_usb::          USB emulation
168 * vnc_security::       VNC security
169 * gdb_usage::          GDB usage
170 * pcsys_os_specific::  Target OS specific information
171 @end menu
173 @node pcsys_introduction
174 @section Introduction
176 @c man begin DESCRIPTION
178 The QEMU PC System emulator simulates the
179 following peripherals:
181 @itemize @minus
182 @item
183 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
184 @item
185 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
186 extensions (hardware level, including all non standard modes).
187 @item
188 PS/2 mouse and keyboard
189 @item
190 2 PCI IDE interfaces with hard disk and CD-ROM support
191 @item
192 Floppy disk
193 @item
194 PCI and ISA network adapters
195 @item
196 Serial ports
197 @item
198 Creative SoundBlaster 16 sound card
199 @item
200 ENSONIQ AudioPCI ES1370 sound card
201 @item
202 Intel 82801AA AC97 Audio compatible sound card
203 @item
204 Intel HD Audio Controller and HDA codec
205 @item
206 Adlib (OPL2) - Yamaha YM3812 compatible chip
207 @item
208 Gravis Ultrasound GF1 sound card
209 @item
210 CS4231A compatible sound card
211 @item
212 PCI UHCI USB controller and a virtual USB hub.
213 @end itemize
215 SMP is supported with up to 255 CPUs.
217 Note that adlib, gus and cs4231a are only available when QEMU was
218 configured with --audio-card-list option containing the name(s) of
219 required card(s).
221 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
222 VGA BIOS.
224 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
226 QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
227 by Tibor "TS" Schütz.
229 Not that, by default, GUS shares IRQ(7) with parallel ports and so
230 qemu must be told to not have parallel ports to have working GUS
232 @example
233 qemu dos.img -soundhw gus -parallel none
234 @end example
236 Alternatively:
237 @example
238 qemu dos.img -device gus,irq=5
239 @end example
241 Or some other unclaimed IRQ.
243 CS4231A is the chip used in Windows Sound System and GUSMAX products
245 @c man end
247 @node pcsys_quickstart
248 @section Quick Start
249 @cindex quick start
251 Download and uncompress the linux image (@file{linux.img}) and type:
253 @example
254 qemu linux.img
255 @end example
257 Linux should boot and give you a prompt.
259 @node sec_invocation
260 @section Invocation
262 @example
263 @c man begin SYNOPSIS
264 usage: qemu [options] [@var{disk_image}]
265 @c man end
266 @end example
268 @c man begin OPTIONS
269 @var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
270 targets do not need a disk image.
272 @include qemu-options.texi
274 @c man end
276 @node pcsys_keys
277 @section Keys
279 @c man begin OPTIONS
281 During the graphical emulation, you can use special key combinations to change
282 modes. The default key mappings are shown below, but if you use @code{-alt-grab}
283 then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use
284 @code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt):
286 @table @key
287 @item Ctrl-Alt-f
288 @kindex Ctrl-Alt-f
289 Toggle full screen
291 @item Ctrl-Alt-+
292 @kindex Ctrl-Alt-+
293 Enlarge the screen
295 @item Ctrl-Alt--
296 @kindex Ctrl-Alt--
297 Shrink the screen
299 @item Ctrl-Alt-u
300 @kindex Ctrl-Alt-u
301 Restore the screen's un-scaled dimensions
303 @item Ctrl-Alt-n
304 @kindex Ctrl-Alt-n
305 Switch to virtual console 'n'. Standard console mappings are:
306 @table @emph
307 @item 1
308 Target system display
309 @item 2
310 Monitor
311 @item 3
312 Serial port
313 @end table
315 @item Ctrl-Alt
316 @kindex Ctrl-Alt
317 Toggle mouse and keyboard grab.
318 @end table
320 @kindex Ctrl-Up
321 @kindex Ctrl-Down
322 @kindex Ctrl-PageUp
323 @kindex Ctrl-PageDown
324 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
325 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
327 @kindex Ctrl-a h
328 During emulation, if you are using the @option{-nographic} option, use
329 @key{Ctrl-a h} to get terminal commands:
331 @table @key
332 @item Ctrl-a h
333 @kindex Ctrl-a h
334 @item Ctrl-a ?
335 @kindex Ctrl-a ?
336 Print this help
337 @item Ctrl-a x
338 @kindex Ctrl-a x
339 Exit emulator
340 @item Ctrl-a s
341 @kindex Ctrl-a s
342 Save disk data back to file (if -snapshot)
343 @item Ctrl-a t
344 @kindex Ctrl-a t
345 Toggle console timestamps
346 @item Ctrl-a b
347 @kindex Ctrl-a b
348 Send break (magic sysrq in Linux)
349 @item Ctrl-a c
350 @kindex Ctrl-a c
351 Switch between console and monitor
352 @item Ctrl-a Ctrl-a
353 @kindex Ctrl-a a
354 Send Ctrl-a
355 @end table
356 @c man end
358 @ignore
360 @c man begin SEEALSO
361 The HTML documentation of QEMU for more precise information and Linux
362 user mode emulator invocation.
363 @c man end
365 @c man begin AUTHOR
366 Fabrice Bellard
367 @c man end
369 @end ignore
371 @node pcsys_monitor
372 @section QEMU Monitor
373 @cindex QEMU monitor
375 The QEMU monitor is used to give complex commands to the QEMU
376 emulator. You can use it to:
378 @itemize @minus
380 @item
381 Remove or insert removable media images
382 (such as CD-ROM or floppies).
384 @item
385 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
386 from a disk file.
388 @item Inspect the VM state without an external debugger.
390 @end itemize
392 @subsection Commands
394 The following commands are available:
396 @include qemu-monitor.texi
398 @subsection Integer expressions
400 The monitor understands integers expressions for every integer
401 argument. You can use register names to get the value of specifics
402 CPU registers by prefixing them with @emph{$}.
404 @node disk_images
405 @section Disk Images
407 Since version 0.6.1, QEMU supports many disk image formats, including
408 growable disk images (their size increase as non empty sectors are
409 written), compressed and encrypted disk images. Version 0.8.3 added
410 the new qcow2 disk image format which is essential to support VM
411 snapshots.
413 @menu
414 * disk_images_quickstart::    Quick start for disk image creation
415 * disk_images_snapshot_mode:: Snapshot mode
416 * vm_snapshots::              VM snapshots
417 * qemu_img_invocation::       qemu-img Invocation
418 * qemu_nbd_invocation::       qemu-nbd Invocation
419 * host_drives::               Using host drives
420 * disk_images_fat_images::    Virtual FAT disk images
421 * disk_images_nbd::           NBD access
422 * disk_images_sheepdog::      Sheepdog disk images
423 @end menu
425 @node disk_images_quickstart
426 @subsection Quick start for disk image creation
428 You can create a disk image with the command:
429 @example
430 qemu-img create myimage.img mysize
431 @end example
432 where @var{myimage.img} is the disk image filename and @var{mysize} is its
433 size in kilobytes. You can add an @code{M} suffix to give the size in
434 megabytes and a @code{G} suffix for gigabytes.
436 See @ref{qemu_img_invocation} for more information.
438 @node disk_images_snapshot_mode
439 @subsection Snapshot mode
441 If you use the option @option{-snapshot}, all disk images are
442 considered as read only. When sectors in written, they are written in
443 a temporary file created in @file{/tmp}. You can however force the
444 write back to the raw disk images by using the @code{commit} monitor
445 command (or @key{C-a s} in the serial console).
447 @node vm_snapshots
448 @subsection VM snapshots
450 VM snapshots are snapshots of the complete virtual machine including
451 CPU state, RAM, device state and the content of all the writable
452 disks. In order to use VM snapshots, you must have at least one non
453 removable and writable block device using the @code{qcow2} disk image
454 format. Normally this device is the first virtual hard drive.
456 Use the monitor command @code{savevm} to create a new VM snapshot or
457 replace an existing one. A human readable name can be assigned to each
458 snapshot in addition to its numerical ID.
460 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
461 a VM snapshot. @code{info snapshots} lists the available snapshots
462 with their associated information:
464 @example
465 (qemu) info snapshots
466 Snapshot devices: hda
467 Snapshot list (from hda):
468 ID        TAG                 VM SIZE                DATE       VM CLOCK
469 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
470 2                                 40M 2006-08-06 12:43:29   00:00:18.633
471 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
472 @end example
474 A VM snapshot is made of a VM state info (its size is shown in
475 @code{info snapshots}) and a snapshot of every writable disk image.
476 The VM state info is stored in the first @code{qcow2} non removable
477 and writable block device. The disk image snapshots are stored in
478 every disk image. The size of a snapshot in a disk image is difficult
479 to evaluate and is not shown by @code{info snapshots} because the
480 associated disk sectors are shared among all the snapshots to save
481 disk space (otherwise each snapshot would need a full copy of all the
482 disk images).
484 When using the (unrelated) @code{-snapshot} option
485 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
486 but they are deleted as soon as you exit QEMU.
488 VM snapshots currently have the following known limitations:
489 @itemize
490 @item
491 They cannot cope with removable devices if they are removed or
492 inserted after a snapshot is done.
493 @item
494 A few device drivers still have incomplete snapshot support so their
495 state is not saved or restored properly (in particular USB).
496 @end itemize
498 @node qemu_img_invocation
499 @subsection @code{qemu-img} Invocation
501 @include qemu-img.texi
503 @node qemu_nbd_invocation
504 @subsection @code{qemu-nbd} Invocation
506 @include qemu-nbd.texi
508 @node host_drives
509 @subsection Using host drives
511 In addition to disk image files, QEMU can directly access host
512 devices. We describe here the usage for QEMU version >= 0.8.3.
514 @subsubsection Linux
516 On Linux, you can directly use the host device filename instead of a
517 disk image filename provided you have enough privileges to access
518 it. For example, use @file{/dev/cdrom} to access to the CDROM or
519 @file{/dev/fd0} for the floppy.
521 @table @code
522 @item CD
523 You can specify a CDROM device even if no CDROM is loaded. QEMU has
524 specific code to detect CDROM insertion or removal. CDROM ejection by
525 the guest OS is supported. Currently only data CDs are supported.
526 @item Floppy
527 You can specify a floppy device even if no floppy is loaded. Floppy
528 removal is currently not detected accurately (if you change floppy
529 without doing floppy access while the floppy is not loaded, the guest
530 OS will think that the same floppy is loaded).
531 @item Hard disks
532 Hard disks can be used. Normally you must specify the whole disk
533 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
534 see it as a partitioned disk. WARNING: unless you know what you do, it
535 is better to only make READ-ONLY accesses to the hard disk otherwise
536 you may corrupt your host data (use the @option{-snapshot} command
537 line option or modify the device permissions accordingly).
538 @end table
540 @subsubsection Windows
542 @table @code
543 @item CD
544 The preferred syntax is the drive letter (e.g. @file{d:}). The
545 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
546 supported as an alias to the first CDROM drive.
548 Currently there is no specific code to handle removable media, so it
549 is better to use the @code{change} or @code{eject} monitor commands to
550 change or eject media.
551 @item Hard disks
552 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
553 where @var{N} is the drive number (0 is the first hard disk).
555 WARNING: unless you know what you do, it is better to only make
556 READ-ONLY accesses to the hard disk otherwise you may corrupt your
557 host data (use the @option{-snapshot} command line so that the
558 modifications are written in a temporary file).
559 @end table
562 @subsubsection Mac OS X
564 @file{/dev/cdrom} is an alias to the first CDROM.
566 Currently there is no specific code to handle removable media, so it
567 is better to use the @code{change} or @code{eject} monitor commands to
568 change or eject media.
570 @node disk_images_fat_images
571 @subsection Virtual FAT disk images
573 QEMU can automatically create a virtual FAT disk image from a
574 directory tree. In order to use it, just type:
576 @example
577 qemu linux.img -hdb fat:/my_directory
578 @end example
580 Then you access access to all the files in the @file{/my_directory}
581 directory without having to copy them in a disk image or to export
582 them via SAMBA or NFS. The default access is @emph{read-only}.
584 Floppies can be emulated with the @code{:floppy:} option:
586 @example
587 qemu linux.img -fda fat:floppy:/my_directory
588 @end example
590 A read/write support is available for testing (beta stage) with the
591 @code{:rw:} option:
593 @example
594 qemu linux.img -fda fat:floppy:rw:/my_directory
595 @end example
597 What you should @emph{never} do:
598 @itemize
599 @item use non-ASCII filenames ;
600 @item use "-snapshot" together with ":rw:" ;
601 @item expect it to work when loadvm'ing ;
602 @item write to the FAT directory on the host system while accessing it with the guest system.
603 @end itemize
605 @node disk_images_nbd
606 @subsection NBD access
608 QEMU can access directly to block device exported using the Network Block Device
609 protocol.
611 @example
612 qemu linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
613 @end example
615 If the NBD server is located on the same host, you can use an unix socket instead
616 of an inet socket:
618 @example
619 qemu linux.img -hdb nbd:unix:/tmp/my_socket
620 @end example
622 In this case, the block device must be exported using qemu-nbd:
624 @example
625 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
626 @end example
628 The use of qemu-nbd allows to share a disk between several guests:
629 @example
630 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
631 @end example
633 and then you can use it with two guests:
634 @example
635 qemu linux1.img -hdb nbd:unix:/tmp/my_socket
636 qemu linux2.img -hdb nbd:unix:/tmp/my_socket
637 @end example
639 If the nbd-server uses named exports (since NBD 2.9.18), you must use the
640 "exportname" option:
641 @example
642 qemu -cdrom nbd:localhost:exportname=debian-500-ppc-netinst
643 qemu -cdrom nbd:localhost:exportname=openSUSE-11.1-ppc-netinst
644 @end example
646 @node disk_images_sheepdog
647 @subsection Sheepdog disk images
649 Sheepdog is a distributed storage system for QEMU.  It provides highly
650 available block level storage volumes that can be attached to
651 QEMU-based virtual machines.
653 You can create a Sheepdog disk image with the command:
654 @example
655 qemu-img create sheepdog:@var{image} @var{size}
656 @end example
657 where @var{image} is the Sheepdog image name and @var{size} is its
658 size.
660 To import the existing @var{filename} to Sheepdog, you can use a
661 convert command.
662 @example
663 qemu-img convert @var{filename} sheepdog:@var{image}
664 @end example
666 You can boot from the Sheepdog disk image with the command:
667 @example
668 qemu sheepdog:@var{image}
669 @end example
671 You can also create a snapshot of the Sheepdog image like qcow2.
672 @example
673 qemu-img snapshot -c @var{tag} sheepdog:@var{image}
674 @end example
675 where @var{tag} is a tag name of the newly created snapshot.
677 To boot from the Sheepdog snapshot, specify the tag name of the
678 snapshot.
679 @example
680 qemu sheepdog:@var{image}:@var{tag}
681 @end example
683 You can create a cloned image from the existing snapshot.
684 @example
685 qemu-img create -b sheepdog:@var{base}:@var{tag} sheepdog:@var{image}
686 @end example
687 where @var{base} is a image name of the source snapshot and @var{tag}
688 is its tag name.
690 If the Sheepdog daemon doesn't run on the local host, you need to
691 specify one of the Sheepdog servers to connect to.
692 @example
693 qemu-img create sheepdog:@var{hostname}:@var{port}:@var{image} @var{size}
694 qemu sheepdog:@var{hostname}:@var{port}:@var{image}
695 @end example
697 @node pcsys_network
698 @section Network emulation
700 QEMU can simulate several network cards (PCI or ISA cards on the PC
701 target) and can connect them to an arbitrary number of Virtual Local
702 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
703 VLAN. VLAN can be connected between separate instances of QEMU to
704 simulate large networks. For simpler usage, a non privileged user mode
705 network stack can replace the TAP device to have a basic network
706 connection.
708 @subsection VLANs
710 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
711 connection between several network devices. These devices can be for
712 example QEMU virtual Ethernet cards or virtual Host ethernet devices
713 (TAP devices).
715 @subsection Using TAP network interfaces
717 This is the standard way to connect QEMU to a real network. QEMU adds
718 a virtual network device on your host (called @code{tapN}), and you
719 can then configure it as if it was a real ethernet card.
721 @subsubsection Linux host
723 As an example, you can download the @file{linux-test-xxx.tar.gz}
724 archive and copy the script @file{qemu-ifup} in @file{/etc} and
725 configure properly @code{sudo} so that the command @code{ifconfig}
726 contained in @file{qemu-ifup} can be executed as root. You must verify
727 that your host kernel supports the TAP network interfaces: the
728 device @file{/dev/net/tun} must be present.
730 See @ref{sec_invocation} to have examples of command lines using the
731 TAP network interfaces.
733 @subsubsection Windows host
735 There is a virtual ethernet driver for Windows 2000/XP systems, called
736 TAP-Win32. But it is not included in standard QEMU for Windows,
737 so you will need to get it separately. It is part of OpenVPN package,
738 so download OpenVPN from : @url{http://openvpn.net/}.
740 @subsection Using the user mode network stack
742 By using the option @option{-net user} (default configuration if no
743 @option{-net} option is specified), QEMU uses a completely user mode
744 network stack (you don't need root privilege to use the virtual
745 network). The virtual network configuration is the following:
747 @example
749          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
750                            |          (10.0.2.2)
751                            |
752                            ---->  DNS server (10.0.2.3)
753                            |
754                            ---->  SMB server (10.0.2.4)
755 @end example
757 The QEMU VM behaves as if it was behind a firewall which blocks all
758 incoming connections. You can use a DHCP client to automatically
759 configure the network in the QEMU VM. The DHCP server assign addresses
760 to the hosts starting from 10.0.2.15.
762 In order to check that the user mode network is working, you can ping
763 the address 10.0.2.2 and verify that you got an address in the range
764 10.0.2.x from the QEMU virtual DHCP server.
766 Note that @code{ping} is not supported reliably to the internet as it
767 would require root privileges. It means you can only ping the local
768 router (10.0.2.2).
770 When using the built-in TFTP server, the router is also the TFTP
771 server.
773 When using the @option{-redir} option, TCP or UDP connections can be
774 redirected from the host to the guest. It allows for example to
775 redirect X11, telnet or SSH connections.
777 @subsection Connecting VLANs between QEMU instances
779 Using the @option{-net socket} option, it is possible to make VLANs
780 that span several QEMU instances. See @ref{sec_invocation} to have a
781 basic example.
783 @node pcsys_other_devs
784 @section Other Devices
786 @subsection Inter-VM Shared Memory device
788 With KVM enabled on a Linux host, a shared memory device is available.  Guests
789 map a POSIX shared memory region into the guest as a PCI device that enables
790 zero-copy communication to the application level of the guests.  The basic
791 syntax is:
793 @example
794 qemu -device ivshmem,size=<size in format accepted by -m>[,shm=<shm name>]
795 @end example
797 If desired, interrupts can be sent between guest VMs accessing the same shared
798 memory region.  Interrupt support requires using a shared memory server and
799 using a chardev socket to connect to it.  The code for the shared memory server
800 is qemu.git/contrib/ivshmem-server.  An example syntax when using the shared
801 memory server is:
803 @example
804 qemu -device ivshmem,size=<size in format accepted by -m>[,chardev=<id>]
805                         [,msi=on][,ioeventfd=on][,vectors=n][,role=peer|master]
806 qemu -chardev socket,path=<path>,id=<id>
807 @end example
809 When using the server, the guest will be assigned a VM ID (>=0) that allows guests
810 using the same server to communicate via interrupts.  Guests can read their
811 VM ID from a device register (see example code).  Since receiving the shared
812 memory region from the server is asynchronous, there is a (small) chance the
813 guest may boot before the shared memory is attached.  To allow an application
814 to ensure shared memory is attached, the VM ID register will return -1 (an
815 invalid VM ID) until the memory is attached.  Once the shared memory is
816 attached, the VM ID will return the guest's valid VM ID.  With these semantics,
817 the guest application can check to ensure the shared memory is attached to the
818 guest before proceeding.
820 The @option{role} argument can be set to either master or peer and will affect
821 how the shared memory is migrated.  With @option{role=master}, the guest will
822 copy the shared memory on migration to the destination host.  With
823 @option{role=peer}, the guest will not be able to migrate with the device attached.
824 With the @option{peer} case, the device should be detached and then reattached
825 after migration using the PCI hotplug support.
827 @node direct_linux_boot
828 @section Direct Linux Boot
830 This section explains how to launch a Linux kernel inside QEMU without
831 having to make a full bootable image. It is very useful for fast Linux
832 kernel testing.
834 The syntax is:
835 @example
836 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
837 @end example
839 Use @option{-kernel} to provide the Linux kernel image and
840 @option{-append} to give the kernel command line arguments. The
841 @option{-initrd} option can be used to provide an INITRD image.
843 When using the direct Linux boot, a disk image for the first hard disk
844 @file{hda} is required because its boot sector is used to launch the
845 Linux kernel.
847 If you do not need graphical output, you can disable it and redirect
848 the virtual serial port and the QEMU monitor to the console with the
849 @option{-nographic} option. The typical command line is:
850 @example
851 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
852      -append "root=/dev/hda console=ttyS0" -nographic
853 @end example
855 Use @key{Ctrl-a c} to switch between the serial console and the
856 monitor (@pxref{pcsys_keys}).
858 @node pcsys_usb
859 @section USB emulation
861 QEMU emulates a PCI UHCI USB controller. You can virtually plug
862 virtual USB devices or real host USB devices (experimental, works only
863 on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
864 as necessary to connect multiple USB devices.
866 @menu
867 * usb_devices::
868 * host_usb_devices::
869 @end menu
870 @node usb_devices
871 @subsection Connecting USB devices
873 USB devices can be connected with the @option{-usbdevice} commandline option
874 or the @code{usb_add} monitor command.  Available devices are:
876 @table @code
877 @item mouse
878 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
879 @item tablet
880 Pointer device that uses absolute coordinates (like a touchscreen).
881 This means qemu is able to report the mouse position without having
882 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
883 @item disk:@var{file}
884 Mass storage device based on @var{file} (@pxref{disk_images})
885 @item host:@var{bus.addr}
886 Pass through the host device identified by @var{bus.addr}
887 (Linux only)
888 @item host:@var{vendor_id:product_id}
889 Pass through the host device identified by @var{vendor_id:product_id}
890 (Linux only)
891 @item wacom-tablet
892 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
893 above but it can be used with the tslib library because in addition to touch
894 coordinates it reports touch pressure.
895 @item keyboard
896 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
897 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
898 Serial converter. This emulates an FTDI FT232BM chip connected to host character
899 device @var{dev}. The available character devices are the same as for the
900 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
901 used to override the default 0403:6001. For instance,
902 @example
903 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
904 @end example
905 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
906 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
907 @item braille
908 Braille device.  This will use BrlAPI to display the braille output on a real
909 or fake device.
910 @item net:@var{options}
911 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
912 specifies NIC options as with @code{-net nic,}@var{options} (see description).
913 For instance, user-mode networking can be used with
914 @example
915 qemu [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
916 @end example
917 Currently this cannot be used in machines that support PCI NICs.
918 @item bt[:@var{hci-type}]
919 Bluetooth dongle whose type is specified in the same format as with
920 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
921 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
922 This USB device implements the USB Transport Layer of HCI.  Example
923 usage:
924 @example
925 qemu [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
926 @end example
927 @end table
929 @node host_usb_devices
930 @subsection Using host USB devices on a Linux host
932 WARNING: this is an experimental feature. QEMU will slow down when
933 using it. USB devices requiring real time streaming (i.e. USB Video
934 Cameras) are not supported yet.
936 @enumerate
937 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
938 is actually using the USB device. A simple way to do that is simply to
939 disable the corresponding kernel module by renaming it from @file{mydriver.o}
940 to @file{mydriver.o.disabled}.
942 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
943 @example
944 ls /proc/bus/usb
945 001  devices  drivers
946 @end example
948 @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:
949 @example
950 chown -R myuid /proc/bus/usb
951 @end example
953 @item Launch QEMU and do in the monitor:
954 @example
955 info usbhost
956   Device 1.2, speed 480 Mb/s
957     Class 00: USB device 1234:5678, USB DISK
958 @end example
959 You should see the list of the devices you can use (Never try to use
960 hubs, it won't work).
962 @item Add the device in QEMU by using:
963 @example
964 usb_add host:1234:5678
965 @end example
967 Normally the guest OS should report that a new USB device is
968 plugged. You can use the option @option{-usbdevice} to do the same.
970 @item Now you can try to use the host USB device in QEMU.
972 @end enumerate
974 When relaunching QEMU, you may have to unplug and plug again the USB
975 device to make it work again (this is a bug).
977 @node vnc_security
978 @section VNC security
980 The VNC server capability provides access to the graphical console
981 of the guest VM across the network. This has a number of security
982 considerations depending on the deployment scenarios.
984 @menu
985 * vnc_sec_none::
986 * vnc_sec_password::
987 * vnc_sec_certificate::
988 * vnc_sec_certificate_verify::
989 * vnc_sec_certificate_pw::
990 * vnc_sec_sasl::
991 * vnc_sec_certificate_sasl::
992 * vnc_generate_cert::
993 * vnc_setup_sasl::
994 @end menu
995 @node vnc_sec_none
996 @subsection Without passwords
998 The simplest VNC server setup does not include any form of authentication.
999 For this setup it is recommended to restrict it to listen on a UNIX domain
1000 socket only. For example
1002 @example
1003 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1004 @end example
1006 This ensures that only users on local box with read/write access to that
1007 path can access the VNC server. To securely access the VNC server from a
1008 remote machine, a combination of netcat+ssh can be used to provide a secure
1009 tunnel.
1011 @node vnc_sec_password
1012 @subsection With passwords
1014 The VNC protocol has limited support for password based authentication. Since
1015 the protocol limits passwords to 8 characters it should not be considered
1016 to provide high security. The password can be fairly easily brute-forced by
1017 a client making repeat connections. For this reason, a VNC server using password
1018 authentication should be restricted to only listen on the loopback interface
1019 or UNIX domain sockets. Password authentication is requested with the @code{password}
1020 option, and then once QEMU is running the password is set with the monitor. Until
1021 the monitor is used to set the password all clients will be rejected.
1023 @example
1024 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1025 (qemu) change vnc password
1026 Password: ********
1027 (qemu)
1028 @end example
1030 @node vnc_sec_certificate
1031 @subsection With x509 certificates
1033 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1034 TLS for encryption of the session, and x509 certificates for authentication.
1035 The use of x509 certificates is strongly recommended, because TLS on its
1036 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1037 support provides a secure session, but no authentication. This allows any
1038 client to connect, and provides an encrypted session.
1040 @example
1041 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1042 @end example
1044 In the above example @code{/etc/pki/qemu} should contain at least three files,
1045 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1046 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1047 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1048 only be readable by the user owning it.
1050 @node vnc_sec_certificate_verify
1051 @subsection With x509 certificates and client verification
1053 Certificates can also provide a means to authenticate the client connecting.
1054 The server will request that the client provide a certificate, which it will
1055 then validate against the CA certificate. This is a good choice if deploying
1056 in an environment with a private internal certificate authority.
1058 @example
1059 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1060 @end example
1063 @node vnc_sec_certificate_pw
1064 @subsection With x509 certificates, client verification and passwords
1066 Finally, the previous method can be combined with VNC password authentication
1067 to provide two layers of authentication for clients.
1069 @example
1070 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1071 (qemu) change vnc password
1072 Password: ********
1073 (qemu)
1074 @end example
1077 @node vnc_sec_sasl
1078 @subsection With SASL authentication
1080 The SASL authentication method is a VNC extension, that provides an
1081 easily extendable, pluggable authentication method. This allows for
1082 integration with a wide range of authentication mechanisms, such as
1083 PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1084 The strength of the authentication depends on the exact mechanism
1085 configured. If the chosen mechanism also provides a SSF layer, then
1086 it will encrypt the datastream as well.
1088 Refer to the later docs on how to choose the exact SASL mechanism
1089 used for authentication, but assuming use of one supporting SSF,
1090 then QEMU can be launched with:
1092 @example
1093 qemu [...OPTIONS...] -vnc :1,sasl -monitor stdio
1094 @end example
1096 @node vnc_sec_certificate_sasl
1097 @subsection With x509 certificates and SASL authentication
1099 If the desired SASL authentication mechanism does not supported
1100 SSF layers, then it is strongly advised to run it in combination
1101 with TLS and x509 certificates. This provides securely encrypted
1102 data stream, avoiding risk of compromising of the security
1103 credentials. This can be enabled, by combining the 'sasl' option
1104 with the aforementioned TLS + x509 options:
1106 @example
1107 qemu [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1108 @end example
1111 @node vnc_generate_cert
1112 @subsection Generating certificates for VNC
1114 The GNU TLS packages provides a command called @code{certtool} which can
1115 be used to generate certificates and keys in PEM format. At a minimum it
1116 is necessary to setup a certificate authority, and issue certificates to
1117 each server. If using certificates for authentication, then each client
1118 will also need to be issued a certificate. The recommendation is for the
1119 server to keep its certificates in either @code{/etc/pki/qemu} or for
1120 unprivileged users in @code{$HOME/.pki/qemu}.
1122 @menu
1123 * vnc_generate_ca::
1124 * vnc_generate_server::
1125 * vnc_generate_client::
1126 @end menu
1127 @node vnc_generate_ca
1128 @subsubsection Setup the Certificate Authority
1130 This step only needs to be performed once per organization / organizational
1131 unit. First the CA needs a private key. This key must be kept VERY secret
1132 and secure. If this key is compromised the entire trust chain of the certificates
1133 issued with it is lost.
1135 @example
1136 # certtool --generate-privkey > ca-key.pem
1137 @end example
1139 A CA needs to have a public certificate. For simplicity it can be a self-signed
1140 certificate, or one issue by a commercial certificate issuing authority. To
1141 generate a self-signed certificate requires one core piece of information, the
1142 name of the organization.
1144 @example
1145 # cat > ca.info <<EOF
1146 cn = Name of your organization
1148 cert_signing_key
1150 # certtool --generate-self-signed \
1151            --load-privkey ca-key.pem
1152            --template ca.info \
1153            --outfile ca-cert.pem
1154 @end example
1156 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1157 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1159 @node vnc_generate_server
1160 @subsubsection Issuing server certificates
1162 Each server (or host) needs to be issued with a key and certificate. When connecting
1163 the certificate is sent to the client which validates it against the CA certificate.
1164 The core piece of information for a server certificate is the hostname. This should
1165 be the fully qualified hostname that the client will connect with, since the client
1166 will typically also verify the hostname in the certificate. On the host holding the
1167 secure CA private key:
1169 @example
1170 # cat > server.info <<EOF
1171 organization = Name  of your organization
1172 cn = server.foo.example.com
1173 tls_www_server
1174 encryption_key
1175 signing_key
1177 # certtool --generate-privkey > server-key.pem
1178 # certtool --generate-certificate \
1179            --load-ca-certificate ca-cert.pem \
1180            --load-ca-privkey ca-key.pem \
1181            --load-privkey server server-key.pem \
1182            --template server.info \
1183            --outfile server-cert.pem
1184 @end example
1186 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1187 to the server for which they were generated. The @code{server-key.pem} is security
1188 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1190 @node vnc_generate_client
1191 @subsubsection Issuing client certificates
1193 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1194 certificates as its authentication mechanism, each client also needs to be issued
1195 a certificate. The client certificate contains enough metadata to uniquely identify
1196 the client, typically organization, state, city, building, etc. On the host holding
1197 the secure CA private key:
1199 @example
1200 # cat > client.info <<EOF
1201 country = GB
1202 state = London
1203 locality = London
1204 organiazation = Name of your organization
1205 cn = client.foo.example.com
1206 tls_www_client
1207 encryption_key
1208 signing_key
1210 # certtool --generate-privkey > client-key.pem
1211 # certtool --generate-certificate \
1212            --load-ca-certificate ca-cert.pem \
1213            --load-ca-privkey ca-key.pem \
1214            --load-privkey client-key.pem \
1215            --template client.info \
1216            --outfile client-cert.pem
1217 @end example
1219 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1220 copied to the client for which they were generated.
1223 @node vnc_setup_sasl
1225 @subsection Configuring SASL mechanisms
1227 The following documentation assumes use of the Cyrus SASL implementation on a
1228 Linux host, but the principals should apply to any other SASL impl. When SASL
1229 is enabled, the mechanism configuration will be loaded from system default
1230 SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1231 unprivileged user, an environment variable SASL_CONF_PATH can be used
1232 to make it search alternate locations for the service config.
1234 The default configuration might contain
1236 @example
1237 mech_list: digest-md5
1238 sasldb_path: /etc/qemu/passwd.db
1239 @end example
1241 This says to use the 'Digest MD5' mechanism, which is similar to the HTTP
1242 Digest-MD5 mechanism. The list of valid usernames & passwords is maintained
1243 in the /etc/qemu/passwd.db file, and can be updated using the saslpasswd2
1244 command. While this mechanism is easy to configure and use, it is not
1245 considered secure by modern standards, so only suitable for developers /
1246 ad-hoc testing.
1248 A more serious deployment might use Kerberos, which is done with the 'gssapi'
1249 mechanism
1251 @example
1252 mech_list: gssapi
1253 keytab: /etc/qemu/krb5.tab
1254 @end example
1256 For this to work the administrator of your KDC must generate a Kerberos
1257 principal for the server, with a name of  'qemu/somehost.example.com@@EXAMPLE.COM'
1258 replacing 'somehost.example.com' with the fully qualified host name of the
1259 machine running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm.
1261 Other configurations will be left as an exercise for the reader. It should
1262 be noted that only Digest-MD5 and GSSAPI provides a SSF layer for data
1263 encryption. For all other mechanisms, VNC should always be configured to
1264 use TLS and x509 certificates to protect security credentials from snooping.
1266 @node gdb_usage
1267 @section GDB usage
1269 QEMU has a primitive support to work with gdb, so that you can do
1270 'Ctrl-C' while the virtual machine is running and inspect its state.
1272 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1273 gdb connection:
1274 @example
1275 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1276        -append "root=/dev/hda"
1277 Connected to host network interface: tun0
1278 Waiting gdb connection on port 1234
1279 @end example
1281 Then launch gdb on the 'vmlinux' executable:
1282 @example
1283 > gdb vmlinux
1284 @end example
1286 In gdb, connect to QEMU:
1287 @example
1288 (gdb) target remote localhost:1234
1289 @end example
1291 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1292 @example
1293 (gdb) c
1294 @end example
1296 Here are some useful tips in order to use gdb on system code:
1298 @enumerate
1299 @item
1300 Use @code{info reg} to display all the CPU registers.
1301 @item
1302 Use @code{x/10i $eip} to display the code at the PC position.
1303 @item
1304 Use @code{set architecture i8086} to dump 16 bit code. Then use
1305 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1306 @end enumerate
1308 Advanced debugging options:
1310 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:
1311 @table @code
1312 @item maintenance packet qqemu.sstepbits
1314 This will display the MASK bits used to control the single stepping IE:
1315 @example
1316 (gdb) maintenance packet qqemu.sstepbits
1317 sending: "qqemu.sstepbits"
1318 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1319 @end example
1320 @item maintenance packet qqemu.sstep
1322 This will display the current value of the mask used when single stepping IE:
1323 @example
1324 (gdb) maintenance packet qqemu.sstep
1325 sending: "qqemu.sstep"
1326 received: "0x7"
1327 @end example
1328 @item maintenance packet Qqemu.sstep=HEX_VALUE
1330 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1331 @example
1332 (gdb) maintenance packet Qqemu.sstep=0x5
1333 sending: "qemu.sstep=0x5"
1334 received: "OK"
1335 @end example
1336 @end table
1338 @node pcsys_os_specific
1339 @section Target OS specific information
1341 @subsection Linux
1343 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1344 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1345 color depth in the guest and the host OS.
1347 When using a 2.6 guest Linux kernel, you should add the option
1348 @code{clock=pit} on the kernel command line because the 2.6 Linux
1349 kernels make very strict real time clock checks by default that QEMU
1350 cannot simulate exactly.
1352 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1353 not activated because QEMU is slower with this patch. The QEMU
1354 Accelerator Module is also much slower in this case. Earlier Fedora
1355 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1356 patch by default. Newer kernels don't have it.
1358 @subsection Windows
1360 If you have a slow host, using Windows 95 is better as it gives the
1361 best speed. Windows 2000 is also a good choice.
1363 @subsubsection SVGA graphic modes support
1365 QEMU emulates a Cirrus Logic GD5446 Video
1366 card. All Windows versions starting from Windows 95 should recognize
1367 and use this graphic card. For optimal performances, use 16 bit color
1368 depth in the guest and the host OS.
1370 If you are using Windows XP as guest OS and if you want to use high
1371 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1372 1280x1024x16), then you should use the VESA VBE virtual graphic card
1373 (option @option{-std-vga}).
1375 @subsubsection CPU usage reduction
1377 Windows 9x does not correctly use the CPU HLT
1378 instruction. The result is that it takes host CPU cycles even when
1379 idle. You can install the utility from
1380 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1381 problem. Note that no such tool is needed for NT, 2000 or XP.
1383 @subsubsection Windows 2000 disk full problem
1385 Windows 2000 has a bug which gives a disk full problem during its
1386 installation. When installing it, use the @option{-win2k-hack} QEMU
1387 option to enable a specific workaround. After Windows 2000 is
1388 installed, you no longer need this option (this option slows down the
1389 IDE transfers).
1391 @subsubsection Windows 2000 shutdown
1393 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1394 can. It comes from the fact that Windows 2000 does not automatically
1395 use the APM driver provided by the BIOS.
1397 In order to correct that, do the following (thanks to Struan
1398 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1399 Add/Troubleshoot a device => Add a new device & Next => No, select the
1400 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1401 (again) a few times. Now the driver is installed and Windows 2000 now
1402 correctly instructs QEMU to shutdown at the appropriate moment.
1404 @subsubsection Share a directory between Unix and Windows
1406 See @ref{sec_invocation} about the help of the option @option{-smb}.
1408 @subsubsection Windows XP security problem
1410 Some releases of Windows XP install correctly but give a security
1411 error when booting:
1412 @example
1413 A problem is preventing Windows from accurately checking the
1414 license for this computer. Error code: 0x800703e6.
1415 @end example
1417 The workaround is to install a service pack for XP after a boot in safe
1418 mode. Then reboot, and the problem should go away. Since there is no
1419 network while in safe mode, its recommended to download the full
1420 installation of SP1 or SP2 and transfer that via an ISO or using the
1421 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1423 @subsection MS-DOS and FreeDOS
1425 @subsubsection CPU usage reduction
1427 DOS does not correctly use the CPU HLT instruction. The result is that
1428 it takes host CPU cycles even when idle. You can install the utility
1429 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1430 problem.
1432 @node QEMU System emulator for non PC targets
1433 @chapter QEMU System emulator for non PC targets
1435 QEMU is a generic emulator and it emulates many non PC
1436 machines. Most of the options are similar to the PC emulator. The
1437 differences are mentioned in the following sections.
1439 @menu
1440 * PowerPC System emulator::
1441 * Sparc32 System emulator::
1442 * Sparc64 System emulator::
1443 * MIPS System emulator::
1444 * ARM System emulator::
1445 * ColdFire System emulator::
1446 * Cris System emulator::
1447 * Microblaze System emulator::
1448 * SH4 System emulator::
1449 @end menu
1451 @node PowerPC System emulator
1452 @section PowerPC System emulator
1453 @cindex system emulation (PowerPC)
1455 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1456 or PowerMac PowerPC system.
1458 QEMU emulates the following PowerMac peripherals:
1460 @itemize @minus
1461 @item
1462 UniNorth or Grackle PCI Bridge
1463 @item
1464 PCI VGA compatible card with VESA Bochs Extensions
1465 @item
1466 2 PMAC IDE interfaces with hard disk and CD-ROM support
1467 @item
1468 NE2000 PCI adapters
1469 @item
1470 Non Volatile RAM
1471 @item
1472 VIA-CUDA with ADB keyboard and mouse.
1473 @end itemize
1475 QEMU emulates the following PREP peripherals:
1477 @itemize @minus
1478 @item
1479 PCI Bridge
1480 @item
1481 PCI VGA compatible card with VESA Bochs Extensions
1482 @item
1483 2 IDE interfaces with hard disk and CD-ROM support
1484 @item
1485 Floppy disk
1486 @item
1487 NE2000 network adapters
1488 @item
1489 Serial port
1490 @item
1491 PREP Non Volatile RAM
1492 @item
1493 PC compatible keyboard and mouse.
1494 @end itemize
1496 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1497 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1499 Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
1500 for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
1501 v2) portable firmware implementation. The goal is to implement a 100%
1502 IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
1504 @c man begin OPTIONS
1506 The following options are specific to the PowerPC emulation:
1508 @table @option
1510 @item -g @var{W}x@var{H}[x@var{DEPTH}]
1512 Set the initial VGA graphic mode. The default is 800x600x15.
1514 @item -prom-env @var{string}
1516 Set OpenBIOS variables in NVRAM, for example:
1518 @example
1519 qemu-system-ppc -prom-env 'auto-boot?=false' \
1520  -prom-env 'boot-device=hd:2,\yaboot' \
1521  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
1522 @end example
1524 These variables are not used by Open Hack'Ware.
1526 @end table
1528 @c man end
1531 More information is available at
1532 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1534 @node Sparc32 System emulator
1535 @section Sparc32 System emulator
1536 @cindex system emulation (Sparc32)
1538 Use the executable @file{qemu-system-sparc} to simulate the following
1539 Sun4m architecture machines:
1540 @itemize @minus
1541 @item
1542 SPARCstation 4
1543 @item
1544 SPARCstation 5
1545 @item
1546 SPARCstation 10
1547 @item
1548 SPARCstation 20
1549 @item
1550 SPARCserver 600MP
1551 @item
1552 SPARCstation LX
1553 @item
1554 SPARCstation Voyager
1555 @item
1556 SPARCclassic
1557 @item
1558 SPARCbook
1559 @end itemize
1561 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
1562 but Linux limits the number of usable CPUs to 4.
1564 It's also possible to simulate a SPARCstation 2 (sun4c architecture),
1565 SPARCserver 1000, or SPARCcenter 2000 (sun4d architecture), but these
1566 emulators are not usable yet.
1568 QEMU emulates the following sun4m/sun4c/sun4d peripherals:
1570 @itemize @minus
1571 @item
1572 IOMMU or IO-UNITs
1573 @item
1574 TCX Frame buffer
1575 @item
1576 Lance (Am7990) Ethernet
1577 @item
1578 Non Volatile RAM M48T02/M48T08
1579 @item
1580 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1581 and power/reset logic
1582 @item
1583 ESP SCSI controller with hard disk and CD-ROM support
1584 @item
1585 Floppy drive (not on SS-600MP)
1586 @item
1587 CS4231 sound device (only on SS-5, not working yet)
1588 @end itemize
1590 The number of peripherals is fixed in the architecture.  Maximum
1591 memory size depends on the machine type, for SS-5 it is 256MB and for
1592 others 2047MB.
1594 Since version 0.8.2, QEMU uses OpenBIOS
1595 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1596 firmware implementation. The goal is to implement a 100% IEEE
1597 1275-1994 (referred to as Open Firmware) compliant firmware.
1599 A sample Linux 2.6 series kernel and ram disk image are available on
1600 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
1601 some kernel versions work. Please note that currently Solaris kernels
1602 don't work probably due to interface issues between OpenBIOS and
1603 Solaris.
1605 @c man begin OPTIONS
1607 The following options are specific to the Sparc32 emulation:
1609 @table @option
1611 @item -g @var{W}x@var{H}x[x@var{DEPTH}]
1613 Set the initial TCX graphic mode. The default is 1024x768x8, currently
1614 the only other possible mode is 1024x768x24.
1616 @item -prom-env @var{string}
1618 Set OpenBIOS variables in NVRAM, for example:
1620 @example
1621 qemu-system-sparc -prom-env 'auto-boot?=false' \
1622  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
1623 @end example
1625 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook|SS-2|SS-1000|SS-2000]
1627 Set the emulated machine type. Default is SS-5.
1629 @end table
1631 @c man end
1633 @node Sparc64 System emulator
1634 @section Sparc64 System emulator
1635 @cindex system emulation (Sparc64)
1637 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
1638 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
1639 Niagara (T1) machine. The emulator is not usable for anything yet, but
1640 it can launch some kernels.
1642 QEMU emulates the following peripherals:
1644 @itemize @minus
1645 @item
1646 UltraSparc IIi APB PCI Bridge
1647 @item
1648 PCI VGA compatible card with VESA Bochs Extensions
1649 @item
1650 PS/2 mouse and keyboard
1651 @item
1652 Non Volatile RAM M48T59
1653 @item
1654 PC-compatible serial ports
1655 @item
1656 2 PCI IDE interfaces with hard disk and CD-ROM support
1657 @item
1658 Floppy disk
1659 @end itemize
1661 @c man begin OPTIONS
1663 The following options are specific to the Sparc64 emulation:
1665 @table @option
1667 @item -prom-env @var{string}
1669 Set OpenBIOS variables in NVRAM, for example:
1671 @example
1672 qemu-system-sparc64 -prom-env 'auto-boot?=false'
1673 @end example
1675 @item -M [sun4u|sun4v|Niagara]
1677 Set the emulated machine type. The default is sun4u.
1679 @end table
1681 @c man end
1683 @node MIPS System emulator
1684 @section MIPS System emulator
1685 @cindex system emulation (MIPS)
1687 Four executables cover simulation of 32 and 64-bit MIPS systems in
1688 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
1689 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
1690 Five different machine types are emulated:
1692 @itemize @minus
1693 @item
1694 A generic ISA PC-like machine "mips"
1695 @item
1696 The MIPS Malta prototype board "malta"
1697 @item
1698 An ACER Pica "pica61". This machine needs the 64-bit emulator.
1699 @item
1700 MIPS emulator pseudo board "mipssim"
1701 @item
1702 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
1703 @end itemize
1705 The generic emulation is supported by Debian 'Etch' and is able to
1706 install Debian into a virtual disk image. The following devices are
1707 emulated:
1709 @itemize @minus
1710 @item
1711 A range of MIPS CPUs, default is the 24Kf
1712 @item
1713 PC style serial port
1714 @item
1715 PC style IDE disk
1716 @item
1717 NE2000 network card
1718 @end itemize
1720 The Malta emulation supports the following devices:
1722 @itemize @minus
1723 @item
1724 Core board with MIPS 24Kf CPU and Galileo system controller
1725 @item
1726 PIIX4 PCI/USB/SMbus controller
1727 @item
1728 The Multi-I/O chip's serial device
1729 @item
1730 PCI network cards (PCnet32 and others)
1731 @item
1732 Malta FPGA serial device
1733 @item
1734 Cirrus (default) or any other PCI VGA graphics card
1735 @end itemize
1737 The ACER Pica emulation supports:
1739 @itemize @minus
1740 @item
1741 MIPS R4000 CPU
1742 @item
1743 PC-style IRQ and DMA controllers
1744 @item
1745 PC Keyboard
1746 @item
1747 IDE controller
1748 @end itemize
1750 The mipssim pseudo board emulation provides an environment similiar
1751 to what the proprietary MIPS emulator uses for running Linux.
1752 It supports:
1754 @itemize @minus
1755 @item
1756 A range of MIPS CPUs, default is the 24Kf
1757 @item
1758 PC style serial port
1759 @item
1760 MIPSnet network emulation
1761 @end itemize
1763 The MIPS Magnum R4000 emulation supports:
1765 @itemize @minus
1766 @item
1767 MIPS R4000 CPU
1768 @item
1769 PC-style IRQ controller
1770 @item
1771 PC Keyboard
1772 @item
1773 SCSI controller
1774 @item
1775 G364 framebuffer
1776 @end itemize
1779 @node ARM System emulator
1780 @section ARM System emulator
1781 @cindex system emulation (ARM)
1783 Use the executable @file{qemu-system-arm} to simulate a ARM
1784 machine. The ARM Integrator/CP board is emulated with the following
1785 devices:
1787 @itemize @minus
1788 @item
1789 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
1790 @item
1791 Two PL011 UARTs
1792 @item
1793 SMC 91c111 Ethernet adapter
1794 @item
1795 PL110 LCD controller
1796 @item
1797 PL050 KMI with PS/2 keyboard and mouse.
1798 @item
1799 PL181 MultiMedia Card Interface with SD card.
1800 @end itemize
1802 The ARM Versatile baseboard is emulated with the following devices:
1804 @itemize @minus
1805 @item
1806 ARM926E, ARM1136 or Cortex-A8 CPU
1807 @item
1808 PL190 Vectored Interrupt Controller
1809 @item
1810 Four PL011 UARTs
1811 @item
1812 SMC 91c111 Ethernet adapter
1813 @item
1814 PL110 LCD controller
1815 @item
1816 PL050 KMI with PS/2 keyboard and mouse.
1817 @item
1818 PCI host bridge.  Note the emulated PCI bridge only provides access to
1819 PCI memory space.  It does not provide access to PCI IO space.
1820 This means some devices (eg. ne2k_pci NIC) are not usable, and others
1821 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
1822 mapped control registers.
1823 @item
1824 PCI OHCI USB controller.
1825 @item
1826 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1827 @item
1828 PL181 MultiMedia Card Interface with SD card.
1829 @end itemize
1831 Several variants of the ARM RealView baseboard are emulated,
1832 including the EB, PB-A8 and PBX-A9.  Due to interactions with the
1833 bootloader, only certain Linux kernel configurations work out
1834 of the box on these boards.
1836 Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
1837 enabled in the kernel, and expect 512M RAM.  Kernels for The PBX-A9 board
1838 should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
1839 disabled and expect 1024M RAM.
1841 The following devices are emulated:
1843 @itemize @minus
1844 @item
1845 ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
1846 @item
1847 ARM AMBA Generic/Distributed Interrupt Controller
1848 @item
1849 Four PL011 UARTs
1850 @item
1851 SMC 91c111 or SMSC LAN9118 Ethernet adapter
1852 @item
1853 PL110 LCD controller
1854 @item
1855 PL050 KMI with PS/2 keyboard and mouse
1856 @item
1857 PCI host bridge
1858 @item
1859 PCI OHCI USB controller
1860 @item
1861 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
1862 @item
1863 PL181 MultiMedia Card Interface with SD card.
1864 @end itemize
1866 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
1867 and "Terrier") emulation includes the following peripherals:
1869 @itemize @minus
1870 @item
1871 Intel PXA270 System-on-chip (ARM V5TE core)
1872 @item
1873 NAND Flash memory
1874 @item
1875 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
1876 @item
1877 On-chip OHCI USB controller
1878 @item
1879 On-chip LCD controller
1880 @item
1881 On-chip Real Time Clock
1882 @item
1883 TI ADS7846 touchscreen controller on SSP bus
1884 @item
1885 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
1886 @item
1887 GPIO-connected keyboard controller and LEDs
1888 @item
1889 Secure Digital card connected to PXA MMC/SD host
1890 @item
1891 Three on-chip UARTs
1892 @item
1893 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
1894 @end itemize
1896 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
1897 following elements:
1899 @itemize @minus
1900 @item
1901 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
1902 @item
1903 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
1904 @item
1905 On-chip LCD controller
1906 @item
1907 On-chip Real Time Clock
1908 @item
1909 TI TSC2102i touchscreen controller / analog-digital converter / Audio
1910 CODEC, connected through MicroWire and I@math{^2}S busses
1911 @item
1912 GPIO-connected matrix keypad
1913 @item
1914 Secure Digital card connected to OMAP MMC/SD host
1915 @item
1916 Three on-chip UARTs
1917 @end itemize
1919 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
1920 emulation supports the following elements:
1922 @itemize @minus
1923 @item
1924 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
1925 @item
1926 RAM and non-volatile OneNAND Flash memories
1927 @item
1928 Display connected to EPSON remote framebuffer chip and OMAP on-chip
1929 display controller and a LS041y3 MIPI DBI-C controller
1930 @item
1931 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
1932 driven through SPI bus
1933 @item
1934 National Semiconductor LM8323-controlled qwerty keyboard driven
1935 through I@math{^2}C bus
1936 @item
1937 Secure Digital card connected to OMAP MMC/SD host
1938 @item
1939 Three OMAP on-chip UARTs and on-chip STI debugging console
1940 @item
1941 A Bluetooth(R) transceiver and HCI connected to an UART
1942 @item
1943 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
1944 TUSB6010 chip - only USB host mode is supported
1945 @item
1946 TI TMP105 temperature sensor driven through I@math{^2}C bus
1947 @item
1948 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
1949 @item
1950 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
1951 through CBUS
1952 @end itemize
1954 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
1955 devices:
1957 @itemize @minus
1958 @item
1959 Cortex-M3 CPU core.
1960 @item
1961 64k Flash and 8k SRAM.
1962 @item
1963 Timers, UARTs, ADC and I@math{^2}C interface.
1964 @item
1965 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
1966 @end itemize
1968 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
1969 devices:
1971 @itemize @minus
1972 @item
1973 Cortex-M3 CPU core.
1974 @item
1975 256k Flash and 64k SRAM.
1976 @item
1977 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
1978 @item
1979 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
1980 @end itemize
1982 The Freecom MusicPal internet radio emulation includes the following
1983 elements:
1985 @itemize @minus
1986 @item
1987 Marvell MV88W8618 ARM core.
1988 @item
1989 32 MB RAM, 256 KB SRAM, 8 MB flash.
1990 @item
1991 Up to 2 16550 UARTs
1992 @item
1993 MV88W8xx8 Ethernet controller
1994 @item
1995 MV88W8618 audio controller, WM8750 CODEC and mixer
1996 @item
1997 128×64 display with brightness control
1998 @item
1999 2 buttons, 2 navigation wheels with button function
2000 @end itemize
2002 The Siemens SX1 models v1 and v2 (default) basic emulation.
2003 The emulation includes the following elements:
2005 @itemize @minus
2006 @item
2007 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2008 @item
2009 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2011 1 Flash of 16MB and 1 Flash of 8MB
2013 1 Flash of 32MB
2014 @item
2015 On-chip LCD controller
2016 @item
2017 On-chip Real Time Clock
2018 @item
2019 Secure Digital card connected to OMAP MMC/SD host
2020 @item
2021 Three on-chip UARTs
2022 @end itemize
2024 The "Syborg" Symbian Virtual Platform base model includes the following
2025 elements:
2027 @itemize @minus
2028 @item
2029 ARM Cortex-A8 CPU
2030 @item
2031 Interrupt controller
2032 @item
2033 Timer
2034 @item
2035 Real Time Clock
2036 @item
2037 Keyboard
2038 @item
2039 Framebuffer
2040 @item
2041 Touchscreen
2042 @item
2043 UARTs
2044 @end itemize
2046 A Linux 2.6 test image is available on the QEMU web site. More
2047 information is available in the QEMU mailing-list archive.
2049 @c man begin OPTIONS
2051 The following options are specific to the ARM emulation:
2053 @table @option
2055 @item -semihosting
2056 Enable semihosting syscall emulation.
2058 On ARM this implements the "Angel" interface.
2060 Note that this allows guest direct access to the host filesystem,
2061 so should only be used with trusted guest OS.
2063 @end table
2065 @node ColdFire System emulator
2066 @section ColdFire System emulator
2067 @cindex system emulation (ColdFire)
2068 @cindex system emulation (M68K)
2070 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2071 The emulator is able to boot a uClinux kernel.
2073 The M5208EVB emulation includes the following devices:
2075 @itemize @minus
2076 @item
2077 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2078 @item
2079 Three Two on-chip UARTs.
2080 @item
2081 Fast Ethernet Controller (FEC)
2082 @end itemize
2084 The AN5206 emulation includes the following devices:
2086 @itemize @minus
2087 @item
2088 MCF5206 ColdFire V2 Microprocessor.
2089 @item
2090 Two on-chip UARTs.
2091 @end itemize
2093 @c man begin OPTIONS
2095 The following options are specific to the ColdFire emulation:
2097 @table @option
2099 @item -semihosting
2100 Enable semihosting syscall emulation.
2102 On M68K this implements the "ColdFire GDB" interface used by libgloss.
2104 Note that this allows guest direct access to the host filesystem,
2105 so should only be used with trusted guest OS.
2107 @end table
2109 @node Cris System emulator
2110 @section Cris System emulator
2111 @cindex system emulation (Cris)
2113 TODO
2115 @node Microblaze System emulator
2116 @section Microblaze System emulator
2117 @cindex system emulation (Microblaze)
2119 TODO
2121 @node SH4 System emulator
2122 @section SH4 System emulator
2123 @cindex system emulation (SH4)
2125 TODO
2127 @node QEMU User space emulator
2128 @chapter QEMU User space emulator
2130 @menu
2131 * Supported Operating Systems ::
2132 * Linux User space emulator::
2133 * Mac OS X/Darwin User space emulator ::
2134 * BSD User space emulator ::
2135 @end menu
2137 @node Supported Operating Systems
2138 @section Supported Operating Systems
2140 The following OS are supported in user space emulation:
2142 @itemize @minus
2143 @item
2144 Linux (referred as qemu-linux-user)
2145 @item
2146 Mac OS X/Darwin (referred as qemu-darwin-user)
2147 @item
2148 BSD (referred as qemu-bsd-user)
2149 @end itemize
2151 @node Linux User space emulator
2152 @section Linux User space emulator
2154 @menu
2155 * Quick Start::
2156 * Wine launch::
2157 * Command line options::
2158 * Other binaries::
2159 @end menu
2161 @node Quick Start
2162 @subsection Quick Start
2164 In order to launch a Linux process, QEMU needs the process executable
2165 itself and all the target (x86) dynamic libraries used by it.
2167 @itemize
2169 @item On x86, you can just try to launch any process by using the native
2170 libraries:
2172 @example
2173 qemu-i386 -L / /bin/ls
2174 @end example
2176 @code{-L /} tells that the x86 dynamic linker must be searched with a
2177 @file{/} prefix.
2179 @item Since QEMU is also a linux process, you can launch qemu with
2180 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2182 @example
2183 qemu-i386 -L / qemu-i386 -L / /bin/ls
2184 @end example
2186 @item On non x86 CPUs, you need first to download at least an x86 glibc
2187 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2188 @code{LD_LIBRARY_PATH} is not set:
2190 @example
2191 unset LD_LIBRARY_PATH
2192 @end example
2194 Then you can launch the precompiled @file{ls} x86 executable:
2196 @example
2197 qemu-i386 tests/i386/ls
2198 @end example
2199 You can look at @file{scripts/qemu-binfmt-conf.sh} so that
2200 QEMU is automatically launched by the Linux kernel when you try to
2201 launch x86 executables. It requires the @code{binfmt_misc} module in the
2202 Linux kernel.
2204 @item The x86 version of QEMU is also included. You can try weird things such as:
2205 @example
2206 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2207           /usr/local/qemu-i386/bin/ls-i386
2208 @end example
2210 @end itemize
2212 @node Wine launch
2213 @subsection Wine launch
2215 @itemize
2217 @item Ensure that you have a working QEMU with the x86 glibc
2218 distribution (see previous section). In order to verify it, you must be
2219 able to do:
2221 @example
2222 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2223 @end example
2225 @item Download the binary x86 Wine install
2226 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2228 @item Configure Wine on your account. Look at the provided script
2229 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2230 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2232 @item Then you can try the example @file{putty.exe}:
2234 @example
2235 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2236           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2237 @end example
2239 @end itemize
2241 @node Command line options
2242 @subsection Command line options
2244 @example
2245 usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
2246 @end example
2248 @table @option
2249 @item -h
2250 Print the help
2251 @item -L path
2252 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2253 @item -s size
2254 Set the x86 stack size in bytes (default=524288)
2255 @item -cpu model
2256 Select CPU model (-cpu ? for list and additional feature selection)
2257 @item -ignore-environment
2258 Start with an empty environment. Without this option,
2259 the initial environment is a copy of the caller's environment.
2260 @item -E @var{var}=@var{value}
2261 Set environment @var{var} to @var{value}.
2262 @item -U @var{var}
2263 Remove @var{var} from the environment.
2264 @item -B offset
2265 Offset guest address by the specified number of bytes.  This is useful when
2266 the address region required by guest applications is reserved on the host.
2267 This option is currently only supported on some hosts.
2268 @item -R size
2269 Pre-allocate a guest virtual address space of the given size (in bytes).
2270 "G", "M", and "k" suffixes may be used when specifying the size.
2271 @end table
2273 Debug options:
2275 @table @option
2276 @item -d
2277 Activate log (logfile=/tmp/qemu.log)
2278 @item -p pagesize
2279 Act as if the host page size was 'pagesize' bytes
2280 @item -g port
2281 Wait gdb connection to port
2282 @item -singlestep
2283 Run the emulation in single step mode.
2284 @end table
2286 Environment variables:
2288 @table @env
2289 @item QEMU_STRACE
2290 Print system calls and arguments similar to the 'strace' program
2291 (NOTE: the actual 'strace' program will not work because the user
2292 space emulator hasn't implemented ptrace).  At the moment this is
2293 incomplete.  All system calls that don't have a specific argument
2294 format are printed with information for six arguments.  Many
2295 flag-style arguments don't have decoders and will show up as numbers.
2296 @end table
2298 @node Other binaries
2299 @subsection Other binaries
2301 @cindex user mode (Alpha)
2302 @command{qemu-alpha} TODO.
2304 @cindex user mode (ARM)
2305 @command{qemu-armeb} TODO.
2307 @cindex user mode (ARM)
2308 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2309 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2310 configurations), and arm-uclinux bFLT format binaries.
2312 @cindex user mode (ColdFire)
2313 @cindex user mode (M68K)
2314 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2315 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2316 coldfire uClinux bFLT format binaries.
2318 The binary format is detected automatically.
2320 @cindex user mode (Cris)
2321 @command{qemu-cris} TODO.
2323 @cindex user mode (i386)
2324 @command{qemu-i386} TODO.
2325 @command{qemu-x86_64} TODO.
2327 @cindex user mode (Microblaze)
2328 @command{qemu-microblaze} TODO.
2330 @cindex user mode (MIPS)
2331 @command{qemu-mips} TODO.
2332 @command{qemu-mipsel} TODO.
2334 @cindex user mode (PowerPC)
2335 @command{qemu-ppc64abi32} TODO.
2336 @command{qemu-ppc64} TODO.
2337 @command{qemu-ppc} TODO.
2339 @cindex user mode (SH4)
2340 @command{qemu-sh4eb} TODO.
2341 @command{qemu-sh4} TODO.
2343 @cindex user mode (SPARC)
2344 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2346 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2347 (Sparc64 CPU, 32 bit ABI).
2349 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2350 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2352 @node Mac OS X/Darwin User space emulator
2353 @section Mac OS X/Darwin User space emulator
2355 @menu
2356 * Mac OS X/Darwin Status::
2357 * Mac OS X/Darwin Quick Start::
2358 * Mac OS X/Darwin Command line options::
2359 @end menu
2361 @node Mac OS X/Darwin Status
2362 @subsection Mac OS X/Darwin Status
2364 @itemize @minus
2365 @item
2366 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2367 @item
2368 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2369 @item
2370 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
2371 @item
2372 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2373 @end itemize
2375 [1] If you're host commpage can be executed by qemu.
2377 @node Mac OS X/Darwin Quick Start
2378 @subsection Quick Start
2380 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2381 itself and all the target dynamic libraries used by it. If you don't have the FAT
2382 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2383 CD or compile them by hand.
2385 @itemize
2387 @item On x86, you can just try to launch any process by using the native
2388 libraries:
2390 @example
2391 qemu-i386 /bin/ls
2392 @end example
2394 or to run the ppc version of the executable:
2396 @example
2397 qemu-ppc /bin/ls
2398 @end example
2400 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2401 are installed:
2403 @example
2404 qemu-i386 -L /opt/x86_root/ /bin/ls
2405 @end example
2407 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2408 @file{/opt/x86_root/usr/bin/dyld}.
2410 @end itemize
2412 @node Mac OS X/Darwin Command line options
2413 @subsection Command line options
2415 @example
2416 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2417 @end example
2419 @table @option
2420 @item -h
2421 Print the help
2422 @item -L path
2423 Set the library root path (default=/)
2424 @item -s size
2425 Set the stack size in bytes (default=524288)
2426 @end table
2428 Debug options:
2430 @table @option
2431 @item -d
2432 Activate log (logfile=/tmp/qemu.log)
2433 @item -p pagesize
2434 Act as if the host page size was 'pagesize' bytes
2435 @item -singlestep
2436 Run the emulation in single step mode.
2437 @end table
2439 @node BSD User space emulator
2440 @section BSD User space emulator
2442 @menu
2443 * BSD Status::
2444 * BSD Quick Start::
2445 * BSD Command line options::
2446 @end menu
2448 @node BSD Status
2449 @subsection BSD Status
2451 @itemize @minus
2452 @item
2453 target Sparc64 on Sparc64: Some trivial programs work.
2454 @end itemize
2456 @node BSD Quick Start
2457 @subsection Quick Start
2459 In order to launch a BSD process, QEMU needs the process executable
2460 itself and all the target dynamic libraries used by it.
2462 @itemize
2464 @item On Sparc64, you can just try to launch any process by using the native
2465 libraries:
2467 @example
2468 qemu-sparc64 /bin/ls
2469 @end example
2471 @end itemize
2473 @node BSD Command line options
2474 @subsection Command line options
2476 @example
2477 usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
2478 @end example
2480 @table @option
2481 @item -h
2482 Print the help
2483 @item -L path
2484 Set the library root path (default=/)
2485 @item -s size
2486 Set the stack size in bytes (default=524288)
2487 @item -ignore-environment
2488 Start with an empty environment. Without this option,
2489 the initial environment is a copy of the caller's environment.
2490 @item -E @var{var}=@var{value}
2491 Set environment @var{var} to @var{value}.
2492 @item -U @var{var}
2493 Remove @var{var} from the environment.
2494 @item -bsd type
2495 Set the type of the emulated BSD Operating system. Valid values are
2496 FreeBSD, NetBSD and OpenBSD (default).
2497 @end table
2499 Debug options:
2501 @table @option
2502 @item -d
2503 Activate log (logfile=/tmp/qemu.log)
2504 @item -p pagesize
2505 Act as if the host page size was 'pagesize' bytes
2506 @item -singlestep
2507 Run the emulation in single step mode.
2508 @end table
2510 @node compilation
2511 @chapter Compilation from the sources
2513 @menu
2514 * Linux/Unix::
2515 * Windows::
2516 * Cross compilation for Windows with Linux::
2517 * Mac OS X::
2518 * Make targets::
2519 @end menu
2521 @node Linux/Unix
2522 @section Linux/Unix
2524 @subsection Compilation
2526 First you must decompress the sources:
2527 @example
2528 cd /tmp
2529 tar zxvf qemu-x.y.z.tar.gz
2530 cd qemu-x.y.z
2531 @end example
2533 Then you configure QEMU and build it (usually no options are needed):
2534 @example
2535 ./configure
2536 make
2537 @end example
2539 Then type as root user:
2540 @example
2541 make install
2542 @end example
2543 to install QEMU in @file{/usr/local}.
2545 @node Windows
2546 @section Windows
2548 @itemize
2549 @item Install the current versions of MSYS and MinGW from
2550 @url{http://www.mingw.org/}. You can find detailed installation
2551 instructions in the download section and the FAQ.
2553 @item Download
2554 the MinGW development library of SDL 1.2.x
2555 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2556 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2557 edit the @file{sdl-config} script so that it gives the
2558 correct SDL directory when invoked.
2560 @item Install the MinGW version of zlib and make sure
2561 @file{zlib.h} and @file{libz.dll.a} are in
2562 MinGW's default header and linker search paths.
2564 @item Extract the current version of QEMU.
2566 @item Start the MSYS shell (file @file{msys.bat}).
2568 @item Change to the QEMU directory. Launch @file{./configure} and
2569 @file{make}.  If you have problems using SDL, verify that
2570 @file{sdl-config} can be launched from the MSYS command line.
2572 @item You can install QEMU in @file{Program Files/Qemu} by typing
2573 @file{make install}. Don't forget to copy @file{SDL.dll} in
2574 @file{Program Files/Qemu}.
2576 @end itemize
2578 @node Cross compilation for Windows with Linux
2579 @section Cross compilation for Windows with Linux
2581 @itemize
2582 @item
2583 Install the MinGW cross compilation tools available at
2584 @url{http://www.mingw.org/}.
2586 @item Download
2587 the MinGW development library of SDL 1.2.x
2588 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2589 @url{http://www.libsdl.org}. Unpack it in a temporary place and
2590 edit the @file{sdl-config} script so that it gives the
2591 correct SDL directory when invoked.  Set up the @code{PATH} environment
2592 variable so that @file{sdl-config} can be launched by
2593 the QEMU configuration script.
2595 @item Install the MinGW version of zlib and make sure
2596 @file{zlib.h} and @file{libz.dll.a} are in
2597 MinGW's default header and linker search paths.
2599 @item
2600 Configure QEMU for Windows cross compilation:
2601 @example
2602 PATH=/usr/i686-pc-mingw32/sys-root/mingw/bin:$PATH ./configure --cross-prefix='i686-pc-mingw32-'
2603 @end example
2604 The example assumes @file{sdl-config} is installed under @file{/usr/i686-pc-mingw32/sys-root/mingw/bin} and
2605 MinGW cross compilation tools have names like @file{i686-pc-mingw32-gcc} and @file{i686-pc-mingw32-strip}.
2606 We set the @code{PATH} environment variable to ensure the MinGW version of @file{sdl-config} is used and
2607 use --cross-prefix to specify the name of the cross compiler.
2608 You can also use --prefix to set the Win32 install path which defaults to @file{c:/Program Files/Qemu}.
2610 Under Fedora Linux, you can run:
2611 @example
2612 yum -y install mingw32-gcc mingw32-SDL mingw32-zlib
2613 @end example
2614 to get a suitable cross compilation environment.
2616 @item You can install QEMU in the installation directory by typing
2617 @code{make install}. Don't forget to copy @file{SDL.dll} and @file{zlib1.dll} into the
2618 installation directory.
2620 @end itemize
2622 Wine can be used to launch the resulting qemu.exe compiled for Win32.
2624 @node Mac OS X
2625 @section Mac OS X
2627 The Mac OS X patches are not fully merged in QEMU, so you should look
2628 at the QEMU mailing list archive to have all the necessary
2629 information.
2631 @node Make targets
2632 @section Make targets
2634 @table @code
2636 @item make
2637 @item make all
2638 Make everything which is typically needed.
2640 @item install
2641 TODO
2643 @item install-doc
2644 TODO
2646 @item make clean
2647 Remove most files which were built during make.
2649 @item make distclean
2650 Remove everything which was built during make.
2652 @item make dvi
2653 @item make html
2654 @item make info
2655 @item make pdf
2656 Create documentation in dvi, html, info or pdf format.
2658 @item make cscope
2659 TODO
2661 @item make defconfig
2662 (Re-)create some build configuration files.
2663 User made changes will be overwritten.
2665 @item tar
2666 @item tarbin
2667 TODO
2669 @end table
2671 @node License
2672 @appendix License
2674 QEMU is a trademark of Fabrice Bellard.
2676 QEMU is released under the GNU General Public License (TODO: add link).
2677 Parts of QEMU have specific licenses, see file LICENSE.
2679 TODO (refer to file LICENSE, include it, include the GPL?)
2681 @node Index
2682 @appendix Index
2683 @menu
2684 * Concept Index::
2685 * Function Index::
2686 * Keystroke Index::
2687 * Program Index::
2688 * Data Type Index::
2689 * Variable Index::
2690 @end menu
2692 @node Concept Index
2693 @section Concept Index
2694 This is the main index. Should we combine all keywords in one index? TODO
2695 @printindex cp
2697 @node Function Index
2698 @section Function Index
2699 This index could be used for command line options and monitor functions.
2700 @printindex fn
2702 @node Keystroke Index
2703 @section Keystroke Index
2705 This is a list of all keystrokes which have a special function
2706 in system emulation.
2708 @printindex ky
2710 @node Program Index
2711 @section Program Index
2712 @printindex pg
2714 @node Data Type Index
2715 @section Data Type Index
2717 This index could be used for qdev device names and options.
2719 @printindex tp
2721 @node Variable Index
2722 @section Variable Index
2723 @printindex vr
2725 @bye