1 \input texinfo @c -*- texinfo -*-
4 @settitle QEMU CPU Emulator User Documentation
7 @center @titlefont{QEMU CPU Emulator User Documentation}
16 QEMU is a FAST! processor emulator using dynamic translation to
17 achieve good emulation speed.
19 QEMU has two operating modes:
24 Full system emulation. In this mode, QEMU emulates a full system (for
25 example a PC), including a processor and various peripherals. It can
26 be used to launch different Operating Systems without rebooting the
27 PC or to debug system code.
30 User mode emulation (Linux host only). In this mode, QEMU can launch
31 Linux processes compiled for one CPU on another CPU. It can be used to
32 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
33 to ease cross-compilation and cross-debugging.
37 QEMU can run without an host kernel driver and yet gives acceptable
40 For system emulation, the following hardware targets are supported:
42 @item PC (x86 or x86_64 processor)
43 @item PREP (PowerPC processor)
44 @item G3 BW PowerMac (PowerPC processor)
45 @item Mac99 PowerMac (PowerPC processor, in progress)
46 @item Sun4m (32-bit Sparc processor)
47 @item Sun4u (64-bit Sparc processor, in progress)
48 @item Malta board (32-bit MIPS processor, in progress)
51 For user emulation, x86, PowerPC, ARM, and Sparc32/64 CPUs are supported.
55 If you want to compile QEMU yourself, see @ref{compilation}.
59 If a precompiled package is available for your distribution - you just
60 have to install it. Otherwise, see @ref{compilation}.
64 Download the experimental binary installer at
65 @url{http://www.freeoszoo.org/download.php}.
69 Download the experimental binary installer at
70 @url{http://www.freeoszoo.org/download.php}.
72 @chapter QEMU PC System emulator invocation
76 @c man begin DESCRIPTION
78 The QEMU System emulator simulates the
79 following PC peripherals:
83 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
85 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
86 extensions (hardware level, including all non standard modes).
88 PS/2 mouse and keyboard
90 2 PCI IDE interfaces with hard disk and CD-ROM support
94 NE2000 PCI network adapters
98 Creative SoundBlaster 16 sound card
100 ENSONIQ AudioPCI ES1370 sound card
102 Adlib(OPL2) - Yamaha YM3812 compatible chip
104 PCI UHCI USB controller and a virtual USB hub.
107 Note that adlib is only available when QEMU was configured with
110 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
113 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
119 Download and uncompress the linux image (@file{linux.img}) and type:
125 Linux should boot and give you a prompt.
131 @c man begin SYNOPSIS
132 usage: qemu [options] [disk_image]
137 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
142 Select the emulated machine (@code{-M ?} for list)
146 Use @var{file} as floppy disk 0/1 image (@xref{disk_images}). You can
147 use the host floppy by using @file{/dev/fd0} as filename.
153 Use @var{file} as hard disk 0, 1, 2 or 3 image (@xref{disk_images}).
156 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
157 @option{-cdrom} at the same time). You can use the host CD-ROM by
158 using @file{/dev/cdrom} as filename.
161 Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
165 Write to temporary files instead of disk image files. In this case,
166 the raw disk image you use is not written back. You can however force
167 the write back by pressing @key{C-a s} (@xref{disk_images}).
170 Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
174 Normally, QEMU uses SDL to display the VGA output. With this option,
175 you can totally disable graphical output so that QEMU is a simple
176 command line application. The emulated serial port is redirected on
177 the console. Therefore, you can still use QEMU to debug a Linux kernel
178 with a serial console.
182 Use keyboard layout @var{language} (for example @code{fr} for
183 French). This option is only needed where it is not easy to get raw PC
184 keycodes (e.g. on Macs or with some X11 servers). You don't need to
185 use it on PC/Linux or PC/Windows hosts.
187 The available layouts are:
189 ar de-ch es fo fr-ca hu ja mk no pt-br sv
190 da en-gb et fr fr-ch is lt nl pl ru th
191 de en-us fi fr-be hr it lv nl-be pt sl tr
194 The default is @code{en-us}.
198 Will enable audio and all the sound hardware QEMU was built with.
202 Will show the audio subsystem help: list of drivers, tunable
205 @item -soundhw card1,card2,...
207 Enable audio and selected sound hardware. Use ? to print all
208 available sound hardware.
211 qemu -soundhw sb16,adlib hda
212 qemu -soundhw es1370 hda
217 Set the real time clock to local time (the default is to UTC
218 time). This option is needed to have correct date in MS-DOS or
222 Start in full screen.
225 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
229 Use it when installing Windows 2000 to avoid a disk full bug. After
230 Windows 2000 is installed, you no longer need this option (this option
231 slows down the IDE transfers).
239 Enable the USB driver (will be the default soon)
241 @item -usbdevice devname
242 Add the USB device @var{devname}. See the monitor command
243 @code{usb_add} to have more information.
251 Set TUN/TAP network init script [default=/etc/qemu-ifup]. This script
252 is launched to configure the host network interface (usually tun0)
253 corresponding to the virtual NE2000 card.
257 Simulate @var{n} network cards (the default is 1).
261 Set the mac address of the first interface (the format is
262 aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each
263 new network interface.
266 Assumes @var{fd} talks to a tap/tun host network interface and use
267 it. Read @url{http://bellard.org/qemu/tetrinet.html} to have an
271 Use the user mode network stack. This is the default if no tun/tap
272 network init script is found.
275 When using the user mode network stack, activate a built-in TFTP
276 server. All filenames beginning with @var{prefix} can be downloaded
277 from the host to the guest using a TFTP client. The TFTP client on the
278 guest must be configured in binary mode (use the command @code{bin} of
279 the Unix TFTP client). The host IP address on the guest is as usual
283 When using the user mode network stack, activate a built-in SMB
284 server so that Windows OSes can access to the host files in @file{dir}
287 In the guest Windows OS, the line:
291 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
292 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
294 Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
296 Note that a SAMBA server must be installed on the host OS in
297 @file{/usr/sbin/smbd}. QEMU was tested succesfully with smbd version
298 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
300 @item -redir [tcp|udp]:host-port:[guest-host]:guest-port
302 When using the user mode network stack, redirect incoming TCP or UDP
303 connections to the host port @var{host-port} to the guest
304 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
305 is not specified, its value is 10.0.2.15 (default address given by the
306 built-in DHCP server).
308 For example, to redirect host X11 connection from screen 1 to guest
309 screen 0, use the following:
313 qemu -redir tcp:6001::6000 [...]
314 # this host xterm should open in the guest X11 server
318 To redirect telnet connections from host port 5555 to telnet port on
319 the guest, use the following:
323 qemu -redir tcp:5555::23 [...]
324 telnet localhost 5555
327 Then when you use on the host @code{telnet localhost 5555}, you
328 connect to the guest telnet server.
331 Use the dummy network stack: no packet will be received by the network
336 Linux boot specific. When using this options, you can use a given
337 Linux kernel without installing it in the disk image. It can be useful
338 for easier testing of various kernels.
342 @item -kernel bzImage
343 Use @var{bzImage} as kernel image.
345 @item -append cmdline
346 Use @var{cmdline} as kernel command line
349 Use @var{file} as initial ram disk.
353 Debug/Expert options:
357 Redirect the virtual serial port to host device @var{dev}. Available
363 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
367 [Linux only]Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
368 parameters are set according to the emulated ones.
370 Write output to filename. No character can be read.
372 [Unix only] standard input/output
374 [Unix only] name pipe @var{filename}
376 The default device is @code{vc} in graphical mode and @code{stdio} in
379 This option can be used several times to simulate up to 4 serials
383 Redirect the monitor to host device @var{dev} (same devices as the
385 The default device is @code{vc} in graphical mode and @code{stdio} in
389 Wait gdb connection to port 1234 (@xref{gdb_usage}).
391 Change gdb connection port.
393 Do not start CPU at startup (you must type 'c' in the monitor).
395 Output log in /tmp/qemu.log
396 @item -hdachs c,h,s,[,t]
397 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
398 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
399 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
400 all thoses parameters. This option is useful for old MS-DOS disk
404 Simulate a standard VGA card with Bochs VBE extensions (default is
405 Cirrus Logic GD5446 PCI VGA)
407 Start right away with a saved state (@code{loadvm} in monitor)
416 During the graphical emulation, you can use the following keys:
422 Switch to virtual console 'n'. Standard console mappings are:
425 Target system display
433 Toggle mouse and keyboard grab.
436 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
437 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
439 During emulation, if you are using the @option{-nographic} option, use
440 @key{Ctrl-a h} to get terminal commands:
448 Save disk data back to file (if -snapshot)
450 Send break (magic sysrq in Linux)
452 Switch between console and monitor
461 @settitle QEMU System Emulator
464 The HTML documentation of QEMU for more precise information and Linux
465 user mode emulator invocation.
476 @section QEMU Monitor
478 The QEMU monitor is used to give complex commands to the QEMU
479 emulator. You can use it to:
484 Remove or insert removable medias images
485 (such as CD-ROM or floppies)
488 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
491 @item Inspect the VM state without an external debugger.
497 The following commands are available:
501 @item help or ? [cmd]
502 Show the help for all commands or just for command @var{cmd}.
505 Commit changes to the disk images (if -snapshot is used)
507 @item info subcommand
508 show various information about the system state
512 show the network state
514 show the block devices
516 show the cpu registers
518 show the command line history
520 show emulated PCI device
522 show USB devices plugged on the virtual USB hub
524 show all USB host devices
530 @item eject [-f] device
531 Eject a removable media (use -f to force it).
533 @item change device filename
534 Change a removable media.
536 @item screendump filename
537 Save screen into PPM image @var{filename}.
539 @item log item1[,...]
540 Activate logging of the specified items to @file{/tmp/qemu.log}.
542 @item savevm filename
543 Save the whole virtual machine state to @var{filename}.
545 @item loadvm filename
546 Restore the whole virtual machine state from @var{filename}.
554 @item gdbserver [port]
555 Start gdbserver session (default port=1234)
558 Virtual memory dump starting at @var{addr}.
561 Physical memory dump starting at @var{addr}.
563 @var{fmt} is a format which tells the command how to format the
564 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
568 is the number of items to be dumped.
571 can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
572 c (char) or i (asm instruction).
575 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
576 @code{h} or @code{w} can be specified with the @code{i} format to
577 respectively select 16 or 32 bit code instruction size.
584 Dump 10 instructions at the current instruction pointer:
589 0x90107065: lea 0x0(%esi,1),%esi
590 0x90107069: lea 0x0(%edi,1),%edi
592 0x90107071: jmp 0x90107080
600 Dump 80 16 bit values at the start of the video memory.
602 (qemu) xp/80hx 0xb8000
603 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
604 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
605 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
606 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
607 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
608 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
609 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
610 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
611 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
612 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
616 @item p or print/fmt expr
618 Print expression value. Only the @var{format} part of @var{fmt} is
623 Send @var{keys} to the emulator. Use @code{-} to press several keys
624 simultaneously. Example:
629 This command is useful to send keys that your graphical user interface
630 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
636 @item usb_add devname
638 Plug the USB device devname to the QEMU virtual USB hub. @var{devname}
639 is either a virtual device name (for example @code{mouse}) or a host
640 USB device identifier. Host USB device identifiers have the following
641 syntax: @code{host:bus.addr} or @code{host:vendor_id:product_id}.
643 @item usb_del devname
645 Remove the USB device @var{devname} from the QEMU virtual USB
646 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
647 command @code{info usb} to see the devices you can remove.
651 @subsection Integer expressions
653 The monitor understands integers expressions for every integer
654 argument. You can use register names to get the value of specifics
655 CPU registers by prefixing them with @emph{$}.
660 Since version 0.6.1, QEMU supports many disk image formats, including
661 growable disk images (their size increase as non empty sectors are
662 written), compressed and encrypted disk images.
664 @subsection Quick start for disk image creation
666 You can create a disk image with the command:
668 qemu-img create myimage.img mysize
670 where @var{myimage.img} is the disk image filename and @var{mysize} is its
671 size in kilobytes. You can add an @code{M} suffix to give the size in
672 megabytes and a @code{G} suffix for gigabytes.
674 @xref{qemu_img_invocation} for more information.
676 @subsection Snapshot mode
678 If you use the option @option{-snapshot}, all disk images are
679 considered as read only. When sectors in written, they are written in
680 a temporary file created in @file{/tmp}. You can however force the
681 write back to the raw disk images by using the @code{commit} monitor
682 command (or @key{C-a s} in the serial console).
684 @node qemu_img_invocation
685 @subsection @code{qemu-img} Invocation
687 @include qemu-img.texi
689 @section Network emulation
691 QEMU simulates up to 6 networks cards (NE2000 boards). Each card can
692 be connected to a specific host network interface.
694 @subsection Using tun/tap network interface
696 This is the standard way to emulate network. QEMU adds a virtual
697 network device on your host (called @code{tun0}), and you can then
698 configure it as if it was a real ethernet card.
700 As an example, you can download the @file{linux-test-xxx.tar.gz}
701 archive and copy the script @file{qemu-ifup} in @file{/etc} and
702 configure properly @code{sudo} so that the command @code{ifconfig}
703 contained in @file{qemu-ifup} can be executed as root. You must verify
704 that your host kernel supports the TUN/TAP network interfaces: the
705 device @file{/dev/net/tun} must be present.
707 See @ref{direct_linux_boot} to have an example of network use with a
710 @subsection Using the user mode network stack
712 By using the option @option{-user-net} or if you have no tun/tap init
713 script, QEMU uses a completely user mode network stack (you don't need
714 root priviledge to use the virtual network). The virtual network
715 configuration is the following:
719 QEMU Virtual Machine <------> Firewall/DHCP server <-----> Internet
720 (10.0.2.x) | (10.0.2.2)
722 ----> DNS server (10.0.2.3)
724 ----> SMB server (10.0.2.4)
727 The QEMU VM behaves as if it was behind a firewall which blocks all
728 incoming connections. You can use a DHCP client to automatically
729 configure the network in the QEMU VM.
731 In order to check that the user mode network is working, you can ping
732 the address 10.0.2.2 and verify that you got an address in the range
733 10.0.2.x from the QEMU virtual DHCP server.
735 Note that @code{ping} is not supported reliably to the internet as it
736 would require root priviledges. It means you can only ping the local
739 When using the built-in TFTP server, the router is also the TFTP
742 When using the @option{-redir} option, TCP or UDP connections can be
743 redirected from the host to the guest. It allows for example to
744 redirect X11, telnet or SSH connections.
746 @node direct_linux_boot
747 @section Direct Linux Boot
749 This section explains how to launch a Linux kernel inside QEMU without
750 having to make a full bootable image. It is very useful for fast Linux
751 kernel testing. The QEMU network configuration is also explained.
755 Download the archive @file{linux-test-xxx.tar.gz} containing a Linux
756 kernel and a disk image.
758 @item Optional: If you want network support (for example to launch X11 examples), you
759 must copy the script @file{qemu-ifup} in @file{/etc} and configure
760 properly @code{sudo} so that the command @code{ifconfig} contained in
761 @file{qemu-ifup} can be executed as root. You must verify that your host
762 kernel supports the TUN/TAP network interfaces: the device
763 @file{/dev/net/tun} must be present.
765 When network is enabled, there is a virtual network connection between
766 the host kernel and the emulated kernel. The emulated kernel is seen
767 from the host kernel at IP address 172.20.0.2 and the host kernel is
768 seen from the emulated kernel at IP address 172.20.0.1.
770 @item Launch @code{qemu.sh}. You should have the following output:
774 Connected to host network interface: tun0
775 Linux version 2.4.21 (bellard@voyager.localdomain) (gcc version 3.2.2 20030222 (Red Hat Linux 3.2.2-5)) #5 Tue Nov 11 18:18:53 CET 2003
776 BIOS-provided physical RAM map:
777 BIOS-e801: 0000000000000000 - 000000000009f000 (usable)
778 BIOS-e801: 0000000000100000 - 0000000002000000 (usable)
779 32MB LOWMEM available.
780 On node 0 totalpages: 8192
784 Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe console=ttyS0
785 ide_setup: ide2=noprobe
786 ide_setup: ide3=noprobe
787 ide_setup: ide4=noprobe
788 ide_setup: ide5=noprobe
790 Detected 2399.621 MHz processor.
791 Console: colour EGA 80x25
792 Calibrating delay loop... 4744.80 BogoMIPS
793 Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, 0k highmem)
794 Dentry cache hash table entries: 4096 (order: 3, 32768 bytes)
795 Inode cache hash table entries: 2048 (order: 2, 16384 bytes)
796 Mount cache hash table entries: 512 (order: 0, 4096 bytes)
797 Buffer-cache hash table entries: 1024 (order: 0, 4096 bytes)
798 Page-cache hash table entries: 8192 (order: 3, 32768 bytes)
799 CPU: Intel Pentium Pro stepping 03
800 Checking 'hlt' instruction... OK.
801 POSIX conformance testing by UNIFIX
802 Linux NET4.0 for Linux 2.4
803 Based upon Swansea University Computer Society NET3.039
804 Initializing RT netlink socket
807 Journalled Block Device driver loaded
808 Detected PS/2 Mouse Port.
809 pty: 256 Unix98 ptys configured
810 Serial driver version 5.05c (2001-07-08) with no serial options enabled
811 ttyS00 at 0x03f8 (irq = 4) is a 16450
812 ne.c:v1.10 9/23/94 Donald Becker (becker@scyld.com)
813 Last modified Nov 1, 2000 by Paul Gortmaker
814 NE*000 ethercard probe at 0x300: 52 54 00 12 34 56
815 eth0: NE2000 found at 0x300, using IRQ 9.
816 RAMDISK driver initialized: 16 RAM disks of 4096K size 1024 blocksize
817 Uniform Multi-Platform E-IDE driver Revision: 7.00beta4-2.4
818 ide: Assuming 50MHz system bus speed for PIO modes; override with idebus=xx
819 hda: QEMU HARDDISK, ATA DISK drive
820 ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
821 hda: attached ide-disk driver.
822 hda: 20480 sectors (10 MB) w/256KiB Cache, CHS=20/16/63
825 Soundblaster audio driver Copyright (C) by Hannu Savolainen 1993-1996
826 NET4: Linux TCP/IP 1.0 for NET4.0
827 IP Protocols: ICMP, UDP, TCP, IGMP
828 IP: routing cache hash table of 512 buckets, 4Kbytes
829 TCP: Hash tables configured (established 2048 bind 4096)
830 NET4: Unix domain sockets 1.0/SMP for Linux NET4.0.
831 EXT2-fs warning: mounting unchecked fs, running e2fsck is recommended
832 VFS: Mounted root (ext2 filesystem).
833 Freeing unused kernel memory: 64k freed
835 Linux version 2.4.21 (bellard@voyager.localdomain) (gcc version 3.2.2 20030222 (Red Hat Linux 3.2.2-5)) #5 Tue Nov 11 18:18:53 CET 2003
837 QEMU Linux test distribution (based on Redhat 9)
839 Type 'exit' to halt the system
845 Then you can play with the kernel inside the virtual serial console. You
846 can launch @code{ls} for example. Type @key{Ctrl-a h} to have an help
847 about the keys you can type inside the virtual serial console. In
848 particular, use @key{Ctrl-a x} to exit QEMU and use @key{Ctrl-a b} as
852 If the network is enabled, launch the script @file{/etc/linuxrc} in the
853 emulator (don't forget the leading dot):
858 Then enable X11 connections on your PC from the emulated Linux:
863 You can now launch @file{xterm} or @file{xlogo} and verify that you have
864 a real Virtual Linux system !
871 A 2.5.74 kernel is also included in the archive. Just
872 replace the bzImage in qemu.sh to try it.
875 In order to exit cleanly from qemu, you can do a @emph{shutdown} inside
876 qemu. qemu will automatically exit when the Linux shutdown is done.
879 You can boot slightly faster by disabling the probe of non present IDE
880 interfaces. To do so, add the following options on the kernel command
883 ide1=noprobe ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe
887 The example disk image is a modified version of the one made by Kevin
888 Lawton for the plex86 Project (@url{www.plex86.org}).
892 @section USB emulation
894 QEMU emulates a PCI UHCI USB controller and a 8 port USB hub connected
895 to it. You can virtually plug to the hub virtual USB devices or real
896 host USB devices (experimental, works only on Linux hosts).
898 @subsection Using virtual USB devices
900 A virtual USB mouse device is available for testing in QEMU.
902 You can try it with the following monitor commands:
905 # add the mouse device
908 # show the virtual USB devices plugged on the QEMU Virtual USB hub
910 Device 0.3, speed 12 Mb/s
912 # after some time you can try to remove the mouse
916 The option @option{-usbdevice} is similar to the monitor command
919 @subsection Using host USB devices on a Linux host
921 WARNING: this is an experimental feature. QEMU will slow down when
922 using it. USB devices requiring real time streaming (i.e. USB Video
923 Cameras) are not supported yet.
926 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
927 is actually using the USB device. A simple way to do that is simply to
928 disable the corresponding kernel module by renaming it from @file{mydriver.o}
929 to @file{mydriver.o.disabled}.
931 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
937 @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:
939 chown -R myuid /proc/bus/usb
942 @item Launch QEMU and do in the monitor:
945 Device 1.2, speed 480 Mb/s
946 Class 00: USB device 1234:5678, USB DISK
948 You should see the list of the devices you can use (Never try to use
949 hubs, it won't work).
951 @item Add the device in QEMU by using:
953 usb_add host:1234:5678
956 Normally the guest OS should report that a new USB device is
957 plugged. You can use the option @option{-usbdevice} to do the same.
959 @item Now you can try to use the host USB device in QEMU.
963 When relaunching QEMU, you may have to unplug and plug again the USB
964 device to make it work again (this is a bug).
969 QEMU has a primitive support to work with gdb, so that you can do
970 'Ctrl-C' while the virtual machine is running and inspect its state.
972 In order to use gdb, launch qemu with the '-s' option. It will wait for a
975 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
976 Connected to host network interface: tun0
977 Waiting gdb connection on port 1234
980 Then launch gdb on the 'vmlinux' executable:
985 In gdb, connect to QEMU:
987 (gdb) target remote localhost:1234
990 Then you can use gdb normally. For example, type 'c' to launch the kernel:
995 Here are some useful tips in order to use gdb on system code:
999 Use @code{info reg} to display all the CPU registers.
1001 Use @code{x/10i $eip} to display the code at the PC position.
1003 Use @code{set architecture i8086} to dump 16 bit code. Then use
1004 @code{x/10i $cs*16+*eip} to dump the code at the PC position.
1007 @section Target OS specific information
1011 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1012 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1013 color depth in the guest and the host OS.
1015 When using a 2.6 guest Linux kernel, you should add the option
1016 @code{clock=pit} on the kernel command line because the 2.6 Linux
1017 kernels make very strict real time clock checks by default that QEMU
1018 cannot simulate exactly.
1020 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1021 not activated because QEMU is slower with this patch. The QEMU
1022 Accelerator Module is also much slower in this case. Earlier Fedora
1023 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
1024 patch by default. Newer kernels don't have it.
1028 If you have a slow host, using Windows 95 is better as it gives the
1029 best speed. Windows 2000 is also a good choice.
1031 @subsubsection SVGA graphic modes support
1033 QEMU emulates a Cirrus Logic GD5446 Video
1034 card. All Windows versions starting from Windows 95 should recognize
1035 and use this graphic card. For optimal performances, use 16 bit color
1036 depth in the guest and the host OS.
1038 @subsubsection CPU usage reduction
1040 Windows 9x does not correctly use the CPU HLT
1041 instruction. The result is that it takes host CPU cycles even when
1042 idle. You can install the utility from
1043 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1044 problem. Note that no such tool is needed for NT, 2000 or XP.
1046 @subsubsection Windows 2000 disk full problem
1048 Windows 2000 has a bug which gives a disk full problem during its
1049 installation. When installing it, use the @option{-win2k-hack} QEMU
1050 option to enable a specific workaround. After Windows 2000 is
1051 installed, you no longer need this option (this option slows down the
1054 @subsubsection Windows 2000 shutdown
1056 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1057 can. It comes from the fact that Windows 2000 does not automatically
1058 use the APM driver provided by the BIOS.
1060 In order to correct that, do the following (thanks to Struan
1061 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1062 Add/Troubleshoot a device => Add a new device & Next => No, select the
1063 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1064 (again) a few times. Now the driver is installed and Windows 2000 now
1065 correctly instructs QEMU to shutdown at the appropriate moment.
1067 @subsubsection Share a directory between Unix and Windows
1069 See @ref{sec_invocation} about the help of the option @option{-smb}.
1071 @subsubsection Windows XP security problems
1073 Some releases of Windows XP install correctly but give a security
1076 A problem is preventing Windows from accurately checking the
1077 license for this computer. Error code: 0x800703e6.
1079 The only known workaround is to boot in Safe mode
1080 without networking support.
1082 Future QEMU releases are likely to correct this bug.
1084 @subsection MS-DOS and FreeDOS
1086 @subsubsection CPU usage reduction
1088 DOS does not correctly use the CPU HLT instruction. The result is that
1089 it takes host CPU cycles even when idle. You can install the utility
1090 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1093 @chapter QEMU PowerPC System emulator invocation
1095 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1096 or PowerMac PowerPC system.
1098 QEMU emulates the following PowerMac peripherals:
1104 PCI VGA compatible card with VESA Bochs Extensions
1106 2 PMAC IDE interfaces with hard disk and CD-ROM support
1112 VIA-CUDA with ADB keyboard and mouse.
1115 QEMU emulates the following PREP peripherals:
1121 PCI VGA compatible card with VESA Bochs Extensions
1123 2 IDE interfaces with hard disk and CD-ROM support
1127 NE2000 network adapters
1131 PREP Non Volatile RAM
1133 PC compatible keyboard and mouse.
1136 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1137 @url{http://site.voila.fr/jmayer/OpenHackWare/index.htm}.
1139 You can read the qemu PC system emulation chapter to have more
1140 informations about QEMU usage.
1142 @c man begin OPTIONS
1144 The following options are specific to the PowerPC emulation:
1148 @item -g WxH[xDEPTH]
1150 Set the initial VGA graphic mode. The default is 800x600x15.
1157 More information is available at
1158 @url{http://jocelyn.mayer.free.fr/qemu-ppc/}.
1160 @chapter Sparc32 System emulator invocation
1162 Use the executable @file{qemu-system-sparc} to simulate a JavaStation
1163 (sun4m architecture). The emulation is somewhat complete.
1165 QEMU emulates the following sun4m peripherals:
1173 Lance (Am7990) Ethernet
1175 Non Volatile RAM M48T08
1177 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1178 and power/reset logic
1180 ESP SCSI controller with hard disk and CD-ROM support
1185 The number of peripherals is fixed in the architecture.
1187 QEMU uses the Proll, a PROM replacement available at
1188 @url{http://people.redhat.com/zaitcev/linux/}. The required
1189 QEMU-specific patches are included with the sources.
1191 A sample Linux 2.6 series kernel and ram disk image are available on
1192 the QEMU web site. Please note that currently neither Linux 2.4
1193 series, NetBSD, nor OpenBSD kernels work.
1195 @c man begin OPTIONS
1197 The following options are specific to the Sparc emulation:
1203 Set the initial TCX graphic mode. The default is 1024x768.
1209 @chapter Sparc64 System emulator invocation
1211 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
1212 The emulator is not usable for anything yet.
1214 QEMU emulates the following sun4u peripherals:
1218 UltraSparc IIi APB PCI Bridge
1220 PCI VGA compatible card with VESA Bochs Extensions
1222 Non Volatile RAM M48T59
1224 PC-compatible serial ports
1227 @chapter MIPS System emulator invocation
1229 Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
1230 The emulator begins to launch a Linux kernel.
1232 @chapter QEMU User space emulator invocation
1234 @section Quick Start
1236 In order to launch a Linux process, QEMU needs the process executable
1237 itself and all the target (x86) dynamic libraries used by it.
1241 @item On x86, you can just try to launch any process by using the native
1245 qemu-i386 -L / /bin/ls
1248 @code{-L /} tells that the x86 dynamic linker must be searched with a
1251 @item Since QEMU is also a linux process, you can launch qemu with qemu (NOTE: you can only do that if you compiled QEMU from the sources):
1254 qemu-i386 -L / qemu-i386 -L / /bin/ls
1257 @item On non x86 CPUs, you need first to download at least an x86 glibc
1258 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1259 @code{LD_LIBRARY_PATH} is not set:
1262 unset LD_LIBRARY_PATH
1265 Then you can launch the precompiled @file{ls} x86 executable:
1268 qemu-i386 tests/i386/ls
1270 You can look at @file{qemu-binfmt-conf.sh} so that
1271 QEMU is automatically launched by the Linux kernel when you try to
1272 launch x86 executables. It requires the @code{binfmt_misc} module in the
1275 @item The x86 version of QEMU is also included. You can try weird things such as:
1277 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1282 @section Wine launch
1286 @item Ensure that you have a working QEMU with the x86 glibc
1287 distribution (see previous section). In order to verify it, you must be
1291 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1294 @item Download the binary x86 Wine install
1295 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
1297 @item Configure Wine on your account. Look at the provided script
1298 @file{/usr/local/qemu-i386/bin/wine-conf.sh}. Your previous
1299 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1301 @item Then you can try the example @file{putty.exe}:
1304 qemu-i386 /usr/local/qemu-i386/wine/bin/wine /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1309 @section Command line options
1312 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1319 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1321 Set the x86 stack size in bytes (default=524288)
1328 Activate log (logfile=/tmp/qemu.log)
1330 Act as if the host page size was 'pagesize' bytes
1334 @chapter Compilation from the sources
1338 @subsection Compilation
1340 First you must decompress the sources:
1343 tar zxvf qemu-x.y.z.tar.gz
1347 Then you configure QEMU and build it (usually no options are needed):
1353 Then type as root user:
1357 to install QEMU in @file{/usr/local}.
1359 @subsection Tested tool versions
1361 In order to compile QEMU succesfully, it is very important that you
1362 have the right tools. The most important one is gcc. I cannot guaranty
1363 that QEMU works if you do not use a tested gcc version. Look at
1364 'configure' and 'Makefile' if you want to make a different gcc
1368 host gcc binutils glibc linux distribution
1369 ----------------------------------------------------------------------
1370 x86 3.2 2.13.2 2.1.3 2.4.18
1371 2.96 2.11.93.0.2 2.2.5 2.4.18 Red Hat 7.3
1372 3.2.2 2.13.90.0.18 2.3.2 2.4.20 Red Hat 9
1374 PowerPC 3.3 [4] 2.13.90.0.18 2.3.1 2.4.20briq
1377 Alpha 3.3 [1] 2.14.90.0.4 2.2.5 2.2.20 [2] Debian 3.0
1379 Sparc32 2.95.4 2.12.90.0.1 2.2.5 2.4.18 Debian 3.0
1381 ARM 2.95.4 2.12.90.0.1 2.2.5 2.4.9 [3] Debian 3.0
1383 [1] On Alpha, QEMU needs the gcc 'visibility' attribute only available
1384 for gcc version >= 3.3.
1385 [2] Linux >= 2.4.20 is necessary for precise exception support
1387 [3] 2.4.9-ac10-rmk2-np1-cerf2
1389 [4] gcc 2.95.x generates invalid code when using too many register
1390 variables. You must use gcc 3.x on PowerPC.
1396 @item Install the current versions of MSYS and MinGW from
1397 @url{http://www.mingw.org/}. You can find detailed installation
1398 instructions in the download section and the FAQ.
1401 the MinGW development library of SDL 1.2.x
1402 (@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
1403 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
1404 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1405 directory. Edit the @file{sdl-config} script so that it gives the
1406 correct SDL directory when invoked.
1408 @item Extract the current version of QEMU.
1410 @item Start the MSYS shell (file @file{msys.bat}).
1412 @item Change to the QEMU directory. Launch @file{./configure} and
1413 @file{make}. If you have problems using SDL, verify that
1414 @file{sdl-config} can be launched from the MSYS command line.
1416 @item You can install QEMU in @file{Program Files/Qemu} by typing
1417 @file{make install}. Don't forget to copy @file{SDL.dll} in
1418 @file{Program Files/Qemu}.
1422 @section Cross compilation for Windows with Linux
1426 Install the MinGW cross compilation tools available at
1427 @url{http://www.mingw.org/}.
1430 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1431 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1432 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1433 the QEMU configuration script.
1436 Configure QEMU for Windows cross compilation:
1438 ./configure --enable-mingw32
1440 If necessary, you can change the cross-prefix according to the prefix
1441 choosen for the MinGW tools with --cross-prefix. You can also use
1442 --prefix to set the Win32 install path.
1444 @item You can install QEMU in the installation directory by typing
1445 @file{make install}. Don't forget to copy @file{SDL.dll} in the
1446 installation directory.
1450 Note: Currently, Wine does not seem able to launch
1455 The Mac OS X patches are not fully merged in QEMU, so you should look
1456 at the QEMU mailing list archive to have all the necessary