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 processor)
43 @item PREP (PowerPC processor)
44 @item PowerMac (PowerPC processor, in progress)
45 @item Sun4m (Sparc processor, in progress)
48 For user emulation, x86, PowerPC, ARM, and SPARC CPUs are supported.
52 If you want to compile QEMU yourself, see @ref{compilation}.
56 If a precompiled package is available for your distribution - you just
57 have to install it. Otherwise, see @ref{compilation}.
61 Download the experimental binary installer at
62 @url{http://www.freeoszoo.org/download.php}.
66 Download the experimental binary installer at
67 @url{http://www.freeoszoo.org/download.php}.
69 @chapter QEMU PC System emulator invocation
73 @c man begin DESCRIPTION
75 The QEMU System emulator simulates the
76 following PC peripherals:
80 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
82 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
83 extensions (hardware level, including all non standard modes).
85 PS/2 mouse and keyboard
87 2 PCI IDE interfaces with hard disk and CD-ROM support
91 NE2000 PCI network adapters
98 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
105 Download and uncompress the linux image (@file{linux.img}) and type:
111 Linux should boot and give you a prompt.
116 @c man begin SYNOPSIS
117 usage: qemu [options] [disk_image]
122 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
128 Use @var{file} as floppy disk 0/1 image (@xref{disk_images}). You can
129 use the host floppy by using @file{/dev/fd0} as filename.
135 Use @var{file} as hard disk 0, 1, 2 or 3 image (@xref{disk_images}).
138 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
139 @option{-cdrom} at the same time). You can use the host CD-ROM by
140 using @file{/dev/cdrom} as filename.
143 Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
147 Write to temporary files instead of disk image files. In this case,
148 the raw disk image you use is not written back. You can however force
149 the write back by pressing @key{C-a s} (@xref{disk_images}).
152 Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
156 Normally, QEMU uses SDL to display the VGA output. With this option,
157 you can totally disable graphical output so that QEMU is a simple
158 command line application. The emulated serial port is redirected on
159 the console. Therefore, you can still use QEMU to debug a Linux kernel
160 with a serial console.
164 Use keyboard layout @var{language} (for example @code{fr} for
165 French). This option is only needed where it is not easy to get raw PC
166 keycodes (e.g. on Macs or with some X11 servers). You don't need to
167 use it on PC/Linux or PC/Windows hosts.
169 The available layouts are:
171 ar de-ch es fo fr-ca hu ja mk no pt-br sv
172 da en-gb et fr fr-ch is lt nl pl ru th
173 de en-us fi fr-be hr it lv nl-be pt sl tr
176 The default is @code{en-us}.
180 The SB16 emulation is disabled by default as it may give problems with
181 Windows. You can enable it manually with this option.
184 Set the real time clock to local time (the default is to UTC
185 time). This option is needed to have correct date in MS-DOS or
189 Start in full screen.
192 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
202 Set TUN/TAP network init script [default=/etc/qemu-ifup]. This script
203 is launched to configure the host network interface (usually tun0)
204 corresponding to the virtual NE2000 card.
208 Simulate @var{n} network cards (the default is 1).
212 Set the mac address of the first interface (the format is
213 aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each
214 new network interface.
217 Assumes @var{fd} talks to a tap/tun host network interface and use
218 it. Read @url{http://bellard.org/qemu/tetrinet.html} to have an
222 Use the user mode network stack. This is the default if no tun/tap
223 network init script is found.
226 When using the user mode network stack, activate a built-in TFTP
227 server. All filenames beginning with @var{prefix} can be downloaded
228 from the host to the guest using a TFTP client. The TFTP client on the
229 guest must be configured in binary mode (use the command @code{bin} of
230 the Unix TFTP client). The host IP address on the guest is as usual
234 When using the user mode network stack, activate a built-in SMB
235 server so that Windows OSes can access to the host files in @file{dir}
238 In the guest Windows OS, the line:
242 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
243 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
245 Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
247 Note that a SAMBA server must be installed on the host OS in
248 @file{/usr/sbin/smbd}. QEMU was tested succesfully with smbd version
249 2.2.7a from the Red Hat 9.
251 @item -redir [tcp|udp]:host-port:[guest-host]:guest-port
253 When using the user mode network stack, redirect incoming TCP or UDP
254 connections to the host port @var{host-port} to the guest
255 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
256 is not specified, its value is 10.0.2.15 (default address given by the
257 built-in DHCP server).
259 For example, to redirect host X11 connection from screen 1 to guest
260 screen 0, use the following:
264 qemu -redir tcp:6001::6000 [...]
265 # this host xterm should open in the guest X11 server
269 To redirect telnet connections from host port 5555 to telnet port on
270 the guest, use the following:
274 qemu -redir tcp:5555::23 [...]
275 telnet localhost 5555
278 Then when you use on the host @code{telnet localhost 5555}, you
279 connect to the guest telnet server.
282 Use the dummy network stack: no packet will be received by the network
287 Linux boot specific. When using this options, you can use a given
288 Linux kernel without installing it in the disk image. It can be useful
289 for easier testing of various kernels.
293 @item -kernel bzImage
294 Use @var{bzImage} as kernel image.
296 @item -append cmdline
297 Use @var{cmdline} as kernel command line
300 Use @var{file} as initial ram disk.
304 Debug/Expert options:
308 Redirect the virtual serial port to host device @var{dev}. Available
314 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
318 [Unix only] standard input/output
320 The default device is @code{vc} in graphical mode and @code{stdio} in
323 This option can be used several times to simulate up to 4 serials
327 Redirect the monitor to host device @var{dev} (same devices as the
329 The default device is @code{vc} in graphical mode and @code{stdio} in
333 Wait gdb connection to port 1234 (@xref{gdb_usage}).
335 Change gdb connection port.
337 Do not start CPU at startup (you must type 'c' in the monitor).
339 Output log in /tmp/qemu.log
340 @item -hdachs c,h,s,[,t]
341 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
342 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
343 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
344 all thoses parameters. This option is useful for old MS-DOS disk
348 Simulate an ISA-only system (default is PCI system).
350 Simulate a standard VGA card with Bochs VBE extensions (default is
351 Cirrus Logic GD5446 PCI VGA)
353 Start right away with a saved state (@code{loadvm} in monitor)
362 During the graphical emulation, you can use the following keys:
368 Switch to virtual console 'n'. Standard console mappings are:
371 Target system display
379 Toggle mouse and keyboard grab.
382 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
383 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
385 During emulation, if you are using the @option{-nographic} option, use
386 @key{Ctrl-a h} to get terminal commands:
394 Save disk data back to file (if -snapshot)
396 Send break (magic sysrq in Linux)
398 Switch between console and monitor
407 @settitle QEMU System Emulator
410 The HTML documentation of QEMU for more precise information and Linux
411 user mode emulator invocation.
422 @section QEMU Monitor
424 The QEMU monitor is used to give complex commands to the QEMU
425 emulator. You can use it to:
430 Remove or insert removable medias images
431 (such as CD-ROM or floppies)
434 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
437 @item Inspect the VM state without an external debugger.
443 The following commands are available:
447 @item help or ? [cmd]
448 Show the help for all commands or just for command @var{cmd}.
451 Commit changes to the disk images (if -snapshot is used)
453 @item info subcommand
454 show various information about the system state
458 show the network state
460 show the block devices
462 show the cpu registers
464 show the command line history
470 @item eject [-f] device
471 Eject a removable media (use -f to force it).
473 @item change device filename
474 Change a removable media.
476 @item screendump filename
477 Save screen into PPM image @var{filename}.
479 @item log item1[,...]
480 Activate logging of the specified items to @file{/tmp/qemu.log}.
482 @item savevm filename
483 Save the whole virtual machine state to @var{filename}.
485 @item loadvm filename
486 Restore the whole virtual machine state from @var{filename}.
494 @item gdbserver [port]
495 Start gdbserver session (default port=1234)
498 Virtual memory dump starting at @var{addr}.
501 Physical memory dump starting at @var{addr}.
503 @var{fmt} is a format which tells the command how to format the
504 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
508 is the number of items to be dumped.
511 can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
512 c (char) or i (asm instruction).
515 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
516 @code{h} or @code{w} can be specified with the @code{i} format to
517 respectively select 16 or 32 bit code instruction size.
524 Dump 10 instructions at the current instruction pointer:
529 0x90107065: lea 0x0(%esi,1),%esi
530 0x90107069: lea 0x0(%edi,1),%edi
532 0x90107071: jmp 0x90107080
540 Dump 80 16 bit values at the start of the video memory.
542 (qemu) xp/80hx 0xb8000
543 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
544 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
545 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
546 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
547 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
548 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
549 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
550 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
551 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
552 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
556 @item p or print/fmt expr
558 Print expression value. Only the @var{format} part of @var{fmt} is
563 Send @var{keys} to the emulator. Use @code{-} to press several keys
564 simultaneously. Example:
569 This command is useful to send keys that your graphical user interface
570 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
578 @subsection Integer expressions
580 The monitor understands integers expressions for every integer
581 argument. You can use register names to get the value of specifics
582 CPU registers by prefixing them with @emph{$}.
587 Since version 0.6.1, QEMU supports many disk image formats, including
588 growable disk images (their size increase as non empty sectors are
589 written), compressed and encrypted disk images.
591 @subsection Quick start for disk image creation
593 You can create a disk image with the command:
595 qemu-img create myimage.img mysize
597 where @var{myimage.img} is the disk image filename and @var{mysize} is its
598 size in kilobytes. You can add an @code{M} suffix to give the size in
599 megabytes and a @code{G} suffix for gigabytes.
601 @xref{qemu_img_invocation} for more information.
603 @subsection Snapshot mode
605 If you use the option @option{-snapshot}, all disk images are
606 considered as read only. When sectors in written, they are written in
607 a temporary file created in @file{/tmp}. You can however force the
608 write back to the raw disk images by using the @code{commit} monitor
609 command (or @key{C-a s} in the serial console).
611 @node qemu_img_invocation
612 @subsection @code{qemu-img} Invocation
614 @include qemu-img.texi
616 @section Network emulation
618 QEMU simulates up to 6 networks cards (NE2000 boards). Each card can
619 be connected to a specific host network interface.
621 @subsection Using tun/tap network interface
623 This is the standard way to emulate network. QEMU adds a virtual
624 network device on your host (called @code{tun0}), and you can then
625 configure it as if it was a real ethernet card.
627 As an example, you can download the @file{linux-test-xxx.tar.gz}
628 archive and copy the script @file{qemu-ifup} in @file{/etc} and
629 configure properly @code{sudo} so that the command @code{ifconfig}
630 contained in @file{qemu-ifup} can be executed as root. You must verify
631 that your host kernel supports the TUN/TAP network interfaces: the
632 device @file{/dev/net/tun} must be present.
634 See @ref{direct_linux_boot} to have an example of network use with a
637 @subsection Using the user mode network stack
639 By using the option @option{-user-net} or if you have no tun/tap init
640 script, QEMU uses a completely user mode network stack (you don't need
641 root priviledge to use the virtual network). The virtual network
642 configuration is the following:
646 QEMU Virtual Machine <------> Firewall/DHCP server <-----> Internet
647 (10.0.2.x) | (10.0.2.2)
649 ----> DNS server (10.0.2.3)
651 ----> SMB server (10.0.2.4)
654 The QEMU VM behaves as if it was behind a firewall which blocks all
655 incoming connections. You can use a DHCP client to automatically
656 configure the network in the QEMU VM.
658 In order to check that the user mode network is working, you can ping
659 the address 10.0.2.2 and verify that you got an address in the range
660 10.0.2.x from the QEMU virtual DHCP server.
662 Note that @code{ping} is not supported reliably to the internet as it
663 would require root priviledges. It means you can only ping the local
666 When using the built-in TFTP server, the router is also the TFTP
669 When using the @option{-redir} option, TCP or UDP connections can be
670 redirected from the host to the guest. It allows for example to
671 redirect X11, telnet or SSH connections.
673 @node direct_linux_boot
674 @section Direct Linux Boot
676 This section explains how to launch a Linux kernel inside QEMU without
677 having to make a full bootable image. It is very useful for fast Linux
678 kernel testing. The QEMU network configuration is also explained.
682 Download the archive @file{linux-test-xxx.tar.gz} containing a Linux
683 kernel and a disk image.
685 @item Optional: If you want network support (for example to launch X11 examples), you
686 must copy the script @file{qemu-ifup} in @file{/etc} and configure
687 properly @code{sudo} so that the command @code{ifconfig} contained in
688 @file{qemu-ifup} can be executed as root. You must verify that your host
689 kernel supports the TUN/TAP network interfaces: the device
690 @file{/dev/net/tun} must be present.
692 When network is enabled, there is a virtual network connection between
693 the host kernel and the emulated kernel. The emulated kernel is seen
694 from the host kernel at IP address 172.20.0.2 and the host kernel is
695 seen from the emulated kernel at IP address 172.20.0.1.
697 @item Launch @code{qemu.sh}. You should have the following output:
701 Connected to host network interface: tun0
702 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
703 BIOS-provided physical RAM map:
704 BIOS-e801: 0000000000000000 - 000000000009f000 (usable)
705 BIOS-e801: 0000000000100000 - 0000000002000000 (usable)
706 32MB LOWMEM available.
707 On node 0 totalpages: 8192
711 Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe console=ttyS0
712 ide_setup: ide2=noprobe
713 ide_setup: ide3=noprobe
714 ide_setup: ide4=noprobe
715 ide_setup: ide5=noprobe
717 Detected 2399.621 MHz processor.
718 Console: colour EGA 80x25
719 Calibrating delay loop... 4744.80 BogoMIPS
720 Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, 0k highmem)
721 Dentry cache hash table entries: 4096 (order: 3, 32768 bytes)
722 Inode cache hash table entries: 2048 (order: 2, 16384 bytes)
723 Mount cache hash table entries: 512 (order: 0, 4096 bytes)
724 Buffer-cache hash table entries: 1024 (order: 0, 4096 bytes)
725 Page-cache hash table entries: 8192 (order: 3, 32768 bytes)
726 CPU: Intel Pentium Pro stepping 03
727 Checking 'hlt' instruction... OK.
728 POSIX conformance testing by UNIFIX
729 Linux NET4.0 for Linux 2.4
730 Based upon Swansea University Computer Society NET3.039
731 Initializing RT netlink socket
734 Journalled Block Device driver loaded
735 Detected PS/2 Mouse Port.
736 pty: 256 Unix98 ptys configured
737 Serial driver version 5.05c (2001-07-08) with no serial options enabled
738 ttyS00 at 0x03f8 (irq = 4) is a 16450
739 ne.c:v1.10 9/23/94 Donald Becker (becker@scyld.com)
740 Last modified Nov 1, 2000 by Paul Gortmaker
741 NE*000 ethercard probe at 0x300: 52 54 00 12 34 56
742 eth0: NE2000 found at 0x300, using IRQ 9.
743 RAMDISK driver initialized: 16 RAM disks of 4096K size 1024 blocksize
744 Uniform Multi-Platform E-IDE driver Revision: 7.00beta4-2.4
745 ide: Assuming 50MHz system bus speed for PIO modes; override with idebus=xx
746 hda: QEMU HARDDISK, ATA DISK drive
747 ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
748 hda: attached ide-disk driver.
749 hda: 20480 sectors (10 MB) w/256KiB Cache, CHS=20/16/63
752 Soundblaster audio driver Copyright (C) by Hannu Savolainen 1993-1996
753 NET4: Linux TCP/IP 1.0 for NET4.0
754 IP Protocols: ICMP, UDP, TCP, IGMP
755 IP: routing cache hash table of 512 buckets, 4Kbytes
756 TCP: Hash tables configured (established 2048 bind 4096)
757 NET4: Unix domain sockets 1.0/SMP for Linux NET4.0.
758 EXT2-fs warning: mounting unchecked fs, running e2fsck is recommended
759 VFS: Mounted root (ext2 filesystem).
760 Freeing unused kernel memory: 64k freed
762 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
764 QEMU Linux test distribution (based on Redhat 9)
766 Type 'exit' to halt the system
772 Then you can play with the kernel inside the virtual serial console. You
773 can launch @code{ls} for example. Type @key{Ctrl-a h} to have an help
774 about the keys you can type inside the virtual serial console. In
775 particular, use @key{Ctrl-a x} to exit QEMU and use @key{Ctrl-a b} as
779 If the network is enabled, launch the script @file{/etc/linuxrc} in the
780 emulator (don't forget the leading dot):
785 Then enable X11 connections on your PC from the emulated Linux:
790 You can now launch @file{xterm} or @file{xlogo} and verify that you have
791 a real Virtual Linux system !
798 A 2.5.74 kernel is also included in the archive. Just
799 replace the bzImage in qemu.sh to try it.
802 In order to exit cleanly from qemu, you can do a @emph{shutdown} inside
803 qemu. qemu will automatically exit when the Linux shutdown is done.
806 You can boot slightly faster by disabling the probe of non present IDE
807 interfaces. To do so, add the following options on the kernel command
810 ide1=noprobe ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe
814 The example disk image is a modified version of the one made by Kevin
815 Lawton for the plex86 Project (@url{www.plex86.org}).
822 QEMU has a primitive support to work with gdb, so that you can do
823 'Ctrl-C' while the virtual machine is running and inspect its state.
825 In order to use gdb, launch qemu with the '-s' option. It will wait for a
828 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
829 Connected to host network interface: tun0
830 Waiting gdb connection on port 1234
833 Then launch gdb on the 'vmlinux' executable:
838 In gdb, connect to QEMU:
840 (gdb) target remote localhost:1234
843 Then you can use gdb normally. For example, type 'c' to launch the kernel:
848 Here are some useful tips in order to use gdb on system code:
852 Use @code{info reg} to display all the CPU registers.
854 Use @code{x/10i $eip} to display the code at the PC position.
856 Use @code{set architecture i8086} to dump 16 bit code. Then use
857 @code{x/10i $cs*16+*eip} to dump the code at the PC position.
860 @section Target OS specific information
864 To have access to SVGA graphic modes under X11, use the @code{vesa} or
865 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
866 color depth in the guest and the host OS.
868 When using a 2.6 guest Linux kernel, you should add the option
869 @code{clock=pit} on the kernel command line because the 2.6 Linux
870 kernels make very strict real time clock checks by default that QEMU
871 cannot simulate exactly.
873 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
874 not activated because QEMU is slower with this patch. The QEMU
875 Accelerator Module is also much slower in this case. Earlier Fedora
876 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
877 patch by default. Newer kernels don't have it.
881 If you have a slow host, using Windows 95 is better as it gives the
882 best speed. Windows 2000 is also a good choice.
884 @subsubsection SVGA graphic modes support
886 QEMU emulates a Cirrus Logic GD5446 Video
887 card. All Windows versions starting from Windows 95 should recognize
888 and use this graphic card. For optimal performances, use 16 bit color
889 depth in the guest and the host OS.
891 @subsubsection CPU usage reduction
893 Windows 9x does not correctly use the CPU HLT
894 instruction. The result is that it takes host CPU cycles even when
895 idle. You can install the utility from
896 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
897 problem. Note that no such tool is needed for NT, 2000 or XP.
899 @subsubsection Windows 2000 disk full problems
901 Currently (release 0.6.0) QEMU has a bug which gives a @code{disk
902 full} error during installation of some releases of Windows 2000. The
903 workaround is to stop QEMU as soon as you notice that your disk image
904 size is growing too fast (monitor it with @code{ls -ls}). Then
905 relaunch QEMU to continue the installation. If you still experience
906 the problem, relaunch QEMU again.
908 Future QEMU releases are likely to correct this bug.
910 @subsubsection Windows XP security problems
912 Some releases of Windows XP install correctly but give a security
915 A problem is preventing Windows from accurately checking the
916 license for this computer. Error code: 0x800703e6.
918 The only known workaround is to boot in Safe mode
919 without networking support.
921 Future QEMU releases are likely to correct this bug.
923 @subsection MS-DOS and FreeDOS
925 @subsubsection CPU usage reduction
927 DOS does not correctly use the CPU HLT instruction. The result is that
928 it takes host CPU cycles even when idle. You can install the utility
929 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
932 @chapter QEMU PowerPC System emulator invocation
934 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
935 or PowerMac PowerPC system.
937 QEMU emulates the following PowerMac peripherals:
943 PCI VGA compatible card with VESA Bochs Extensions
945 2 PMAC IDE interfaces with hard disk and CD-ROM support
951 VIA-CUDA with ADB keyboard and mouse.
954 QEMU emulates the following PREP peripherals:
960 PCI VGA compatible card with VESA Bochs Extensions
962 2 IDE interfaces with hard disk and CD-ROM support
966 NE2000 network adapters
970 PREP Non Volatile RAM
972 PC compatible keyboard and mouse.
975 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
976 @url{http://site.voila.fr/jmayer/OpenHackWare/index.htm}.
978 You can read the qemu PC system emulation chapter to have more
979 informations about QEMU usage.
983 The following options are specific to the PowerPC emulation:
988 Simulate a PREP system (default is PowerMAC)
992 Set the initial VGA graphic mode. The default is 800x600x15.
999 More information is available at
1000 @url{http://jocelyn.mayer.free.fr/qemu-ppc/}.
1002 @chapter Sparc System emulator invocation
1004 Use the executable @file{qemu-system-sparc} to simulate a JavaStation
1005 (sun4m architecture). The emulation is far from complete.
1007 QEMU emulates the following sun4m peripherals:
1015 Lance (Am7990) Ethernet
1017 Non Volatile RAM M48T08
1019 Slave I/O: timers, interrupt controllers, Zilog serial ports
1022 QEMU uses the Proll, a PROM replacement available at
1023 @url{http://people.redhat.com/zaitcev/linux/}.
1025 A sample Linux kernel and ram disk image are available on the QEMU web
1028 @chapter QEMU User space emulator invocation
1030 @section Quick Start
1032 In order to launch a Linux process, QEMU needs the process executable
1033 itself and all the target (x86) dynamic libraries used by it.
1037 @item On x86, you can just try to launch any process by using the native
1041 qemu-i386 -L / /bin/ls
1044 @code{-L /} tells that the x86 dynamic linker must be searched with a
1047 @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):
1050 qemu-i386 -L / qemu-i386 -L / /bin/ls
1053 @item On non x86 CPUs, you need first to download at least an x86 glibc
1054 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1055 @code{LD_LIBRARY_PATH} is not set:
1058 unset LD_LIBRARY_PATH
1061 Then you can launch the precompiled @file{ls} x86 executable:
1064 qemu-i386 tests/i386/ls
1066 You can look at @file{qemu-binfmt-conf.sh} so that
1067 QEMU is automatically launched by the Linux kernel when you try to
1068 launch x86 executables. It requires the @code{binfmt_misc} module in the
1071 @item The x86 version of QEMU is also included. You can try weird things such as:
1073 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1078 @section Wine launch
1082 @item Ensure that you have a working QEMU with the x86 glibc
1083 distribution (see previous section). In order to verify it, you must be
1087 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1090 @item Download the binary x86 Wine install
1091 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
1093 @item Configure Wine on your account. Look at the provided script
1094 @file{/usr/local/qemu-i386/bin/wine-conf.sh}. Your previous
1095 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1097 @item Then you can try the example @file{putty.exe}:
1100 qemu-i386 /usr/local/qemu-i386/wine/bin/wine /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1105 @section Command line options
1108 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1115 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1117 Set the x86 stack size in bytes (default=524288)
1124 Activate log (logfile=/tmp/qemu.log)
1126 Act as if the host page size was 'pagesize' bytes
1130 @chapter Compilation from the sources
1134 @subsection Compilation
1136 First you must decompress the sources:
1139 tar zxvf qemu-x.y.z.tar.gz
1143 Then you configure QEMU and build it (usually no options are needed):
1149 Then type as root user:
1153 to install QEMU in @file{/usr/local}.
1155 @subsection Tested tool versions
1157 In order to compile QEMU succesfully, it is very important that you
1158 have the right tools. The most important one is gcc. I cannot guaranty
1159 that QEMU works if you do not use a tested gcc version. Look at
1160 'configure' and 'Makefile' if you want to make a different gcc
1164 host gcc binutils glibc linux distribution
1165 ----------------------------------------------------------------------
1166 x86 3.2 2.13.2 2.1.3 2.4.18
1167 2.96 2.11.93.0.2 2.2.5 2.4.18 Red Hat 7.3
1168 3.2.2 2.13.90.0.18 2.3.2 2.4.20 Red Hat 9
1170 PowerPC 3.3 [4] 2.13.90.0.18 2.3.1 2.4.20briq
1173 Alpha 3.3 [1] 2.14.90.0.4 2.2.5 2.2.20 [2] Debian 3.0
1175 Sparc32 2.95.4 2.12.90.0.1 2.2.5 2.4.18 Debian 3.0
1177 ARM 2.95.4 2.12.90.0.1 2.2.5 2.4.9 [3] Debian 3.0
1179 [1] On Alpha, QEMU needs the gcc 'visibility' attribute only available
1180 for gcc version >= 3.3.
1181 [2] Linux >= 2.4.20 is necessary for precise exception support
1183 [3] 2.4.9-ac10-rmk2-np1-cerf2
1185 [4] gcc 2.95.x generates invalid code when using too many register
1186 variables. You must use gcc 3.x on PowerPC.
1192 @item Install the current versions of MSYS and MinGW from
1193 @url{http://www.mingw.org/}. You can find detailed installation
1194 instructions in the download section and the FAQ.
1197 the MinGW development library of SDL 1.2.x
1198 (@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
1199 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
1200 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1201 directory. Edit the @file{sdl-config} script so that it gives the
1202 correct SDL directory when invoked.
1204 @item Extract the current version of QEMU.
1206 @item Start the MSYS shell (file @file{msys.bat}).
1208 @item Change to the QEMU directory. Launch @file{./configure} and
1209 @file{make}. If you have problems using SDL, verify that
1210 @file{sdl-config} can be launched from the MSYS command line.
1212 @item You can install QEMU in @file{Program Files/Qemu} by typing
1213 @file{make install}. Don't forget to copy @file{SDL.dll} in
1214 @file{Program Files/Qemu}.
1218 @section Cross compilation for Windows with Linux
1222 Install the MinGW cross compilation tools available at
1223 @url{http://www.mingw.org/}.
1226 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1227 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1228 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1229 the QEMU configuration script.
1232 Configure QEMU for Windows cross compilation:
1234 ./configure --enable-mingw32
1236 If necessary, you can change the cross-prefix according to the prefix
1237 choosen for the MinGW tools with --cross-prefix. You can also use
1238 --prefix to set the Win32 install path.
1240 @item You can install QEMU in the installation directory by typing
1241 @file{make install}. Don't forget to copy @file{SDL.dll} in the
1242 installation directory.
1246 Note: Currently, Wine does not seem able to launch
1251 The Mac OS X patches are not fully merged in QEMU, so you should look
1252 at the QEMU mailing list archive to have all the necessary