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 peripherials. 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 As QEMU requires no host kernel driver to run, it is very safe and
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)
47 For user emulation, x86, PowerPC, ARM, and SPARC CPUs are supported.
51 If you want to compile QEMU yourself, see @ref{compilation}.
55 Download the binary distribution (@file{qemu-XXX-i386.tar.gz}) and
56 untar it as root in @file{/}:
61 tar zxvf /tmp/qemu-XXX-i386.tar.gz
66 Download the experimental binary installer at
67 @url{http://www.freeoszoo.org/download.php}.
71 Download the experimental binary installer at
72 @url{http://www.freeoszoo.org/download.php}.
74 @chapter QEMU PC System emulator invocation
78 @c man begin DESCRIPTION
80 The QEMU System emulator simulates a complete PC.
82 In order to meet specific user needs, two versions of QEMU are
88 @code{qemu-fast} uses the host Memory Management Unit (MMU) to
89 simulate the x86 MMU. It is @emph{fast} but has limitations because
90 the whole 4 GB address space cannot be used and some memory mapped
91 peripherials cannot be emulated accurately yet. Therefore, a specific
92 guest Linux kernel can be used (@xref{linux_compile}) as guest
95 Moreover there is no separation between the host and target address
96 spaces, so it offers no security (the target OS can modify the
97 @code{qemu-fast} code by writing at the right addresses).
100 @code{qemu} uses a software MMU. It is about @emph{two times slower}
101 but gives a more accurate emulation and a complete separation between
102 the host and target address spaces.
106 QEMU emulates the following PC peripherials:
110 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
112 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
113 extensions (hardware level, including all non standard modes).
115 PS/2 mouse and keyboard
117 2 PCI IDE interfaces with hard disk and CD-ROM support
121 NE2000 PCI network adapters
128 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
135 Download and uncompress the linux image (@file{linux.img}) and type:
141 Linux should boot and give you a prompt.
146 @c man begin SYNOPSIS
147 usage: qemu [options] [disk_image]
152 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
158 Use @var{file} as floppy disk 0/1 image (@xref{disk_images}). You can
159 use the host floppy by using @file{/dev/fd0} as filename.
165 Use @var{file} as hard disk 0, 1, 2 or 3 image (@xref{disk_images}).
168 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
169 @option{-cdrom} at the same time). You can use the host CD-ROM by
170 using @file{/dev/cdrom} as filename.
173 Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
177 Write to temporary files instead of disk image files. In this case,
178 the raw disk image you use is not written back. You can however force
179 the write back by pressing @key{C-a s} (@xref{disk_images}).
182 Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
186 Normally, QEMU uses SDL to display the VGA output. With this option,
187 you can totally disable graphical output so that QEMU is a simple
188 command line application. The emulated serial port is redirected on
189 the console. Therefore, you can still use QEMU to debug a Linux kernel
190 with a serial console.
194 The SB16 emulation is disabled by default as it may give problems with
195 Windows. You can enable it manually with this option.
198 Set the real time clock to local time (the default is to UTC
199 time). This option is needed to have correct date in MS-DOS or
209 Set TUN/TAP network init script [default=/etc/qemu-ifup]. This script
210 is launched to configure the host network interface (usually tun0)
211 corresponding to the virtual NE2000 card.
215 Set the mac address of the first interface (the format is
216 aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each
217 new network interface.
220 Assumes @var{fd} talks to a tap/tun host network interface and use
221 it. Read @url{http://bellard.org/qemu/tetrinet.html} to have an
225 Use the user mode network stack. This is the default if no tun/tap
226 network init script is found.
229 When using the user mode network stack, activate a built-in TFTP
230 server. All filenames beginning with @var{prefix} can be downloaded
231 from the host to the guest using a TFTP client. The TFTP client on the
232 guest must be configured in binary mode (use the command @code{bin} of
233 the Unix TFTP client). The host IP address on the guest is as usual
236 @item -redir [tcp|udp]:host-port:[guest-host]:guest-port
238 When using the user mode network stack, redirect incoming TCP or UDP
239 connections to the host port @var{host-port} to the guest
240 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
241 is not specified, its value is 10.0.2.15 (default address given by the
242 built-in DHCP server).
244 For example, to redirect host X11 connection from screen 1 to guest
245 screen 0, use the following:
249 qemu -redir tcp:6001::6000 [...]
250 # this host xterm should open in the guest X11 server
254 To redirect telnet connections from host port 5555 to telnet port on
255 the guest, use the following:
259 qemu -redir tcp:5555::23 [...]
260 telnet localhost 5555
263 Then when you use on the host @code{telnet localhost 5555}, you
264 connect to the guest telnet server.
267 Use the dummy network stack: no packet will be received by the network
272 Linux boot specific. When using this options, you can use a given
273 Linux kernel without installing it in the disk image. It can be useful
274 for easier testing of various kernels.
278 @item -kernel bzImage
279 Use @var{bzImage} as kernel image.
281 @item -append cmdline
282 Use @var{cmdline} as kernel command line
285 Use @var{file} as initial ram disk.
289 Debug/Expert options:
293 Redirect the virtual serial port to host device @var{dev}. Available
299 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
303 [Unix only] standard input/output
305 The default device is @code{vc} in graphical mode and @code{stdio} in
308 This option can be used several times to simulate up to 4 serials
312 Redirect the monitor to host device @var{dev} (same devices as the
314 The default device is @code{vc} in graphical mode and @code{stdio} in
318 Wait gdb connection to port 1234 (@xref{gdb_usage}).
320 Change gdb connection port.
322 Do not start CPU at startup (you must type 'c' in the monitor).
324 Output log in /tmp/qemu.log
326 Simulate an ISA-only system (default is PCI system).
328 Simulate a standard VGA card with Bochs VBE extensions (default is
329 Cirrus Logic GD5446 PCI VGA)
339 During the graphical emulation, you can use the following keys:
345 Switch to virtual console 'n'. Standard console mappings are:
348 Target system display
356 Toggle mouse and keyboard grab.
359 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
360 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
362 During emulation, if you are using the @option{-nographic} option, use
363 @key{Ctrl-a h} to get terminal commands:
371 Save disk data back to file (if -snapshot)
373 Send break (magic sysrq in Linux)
375 Switch between console and monitor
384 @settitle QEMU System Emulator
387 The HTML documentation of QEMU for more precise information and Linux
388 user mode emulator invocation.
400 @section QEMU Monitor
402 The QEMU monitor is used to give complex commands to the QEMU
403 emulator. You can use it to:
408 Remove or insert removable medias images
409 (such as CD-ROM or floppies)
412 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
415 @item Inspect the VM state without an external debugger.
421 The following commands are available:
425 @item help or ? [cmd]
426 Show the help for all commands or just for command @var{cmd}.
429 Commit changes to the disk images (if -snapshot is used)
431 @item info subcommand
432 show various information about the system state
436 show the network state
438 show the block devices
440 show the cpu registers
442 show the command line history
448 @item eject [-f] device
449 Eject a removable media (use -f to force it).
451 @item change device filename
452 Change a removable media.
454 @item screendump filename
455 Save screen into PPM image @var{filename}.
457 @item log item1[,...]
458 Activate logging of the specified items to @file{/tmp/qemu.log}.
460 @item savevm filename
461 Save the whole virtual machine state to @var{filename}.
463 @item loadvm filename
464 Restore the whole virtual machine state from @var{filename}.
472 @item gdbserver [port]
473 Start gdbserver session (default port=1234)
476 Virtual memory dump starting at @var{addr}.
479 Physical memory dump starting at @var{addr}.
481 @var{fmt} is a format which tells the command how to format the
482 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
486 is the number of items to be dumped.
489 can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
490 c (char) or i (asm instruction).
493 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
494 @code{h} or @code{w} can be specified with the @code{i} format to
495 respectively select 16 or 32 bit code instruction size.
502 Dump 10 instructions at the current instruction pointer:
507 0x90107065: lea 0x0(%esi,1),%esi
508 0x90107069: lea 0x0(%edi,1),%edi
510 0x90107071: jmp 0x90107080
518 Dump 80 16 bit values at the start of the video memory.
520 (qemu) xp/80hx 0xb8000
521 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
522 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
523 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
524 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
525 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
526 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
527 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
528 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
529 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
530 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
534 @item p or print/fmt expr
536 Print expression value. Only the @var{format} part of @var{fmt} is
541 Send @var{keys} to the emulator. Use @code{-} to press several keys
542 simultaneously. Example:
547 This command is useful to send keys that your graphical user interface
548 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
556 @subsection Integer expressions
558 The monitor understands integers expressions for every integer
559 argument. You can use register names to get the value of specifics
560 CPU registers by prefixing them with @emph{$}.
565 @subsection Raw disk images
567 The disk images can simply be raw images of the hard disk. You can
568 create them with the command:
570 dd of=myimage bs=1024 seek=mysize count=0
572 where @var{myimage} is the image filename and @var{mysize} is its size
575 @subsection Snapshot mode
577 If you use the option @option{-snapshot}, all disk images are
578 considered as read only. When sectors in written, they are written in
579 a temporary file created in @file{/tmp}. You can however force the
580 write back to the raw disk images by pressing @key{C-a s}.
582 NOTE: The snapshot mode only works with raw disk images.
584 @subsection Copy On Write disk images
586 QEMU also supports user mode Linux
587 (@url{http://user-mode-linux.sourceforge.net/}) Copy On Write (COW)
588 disk images. The COW disk images are much smaller than normal images
589 as they store only modified sectors. They also permit the use of the
590 same disk image template for many users.
592 To create a COW disk images, use the command:
595 qemu-mkcow -f myrawimage.bin mycowimage.cow
598 @file{myrawimage.bin} is a raw image you want to use as original disk
599 image. It will never be written to.
601 @file{mycowimage.cow} is the COW disk image which is created by
602 @code{qemu-mkcow}. You can use it directly with the @option{-hdx}
603 options. You must not modify the original raw disk image if you use
604 COW images, as COW images only store the modified sectors from the raw
605 disk image. QEMU stores the original raw disk image name and its
606 modified time in the COW disk image so that chances of mistakes are
609 If the raw disk image is not read-only, by pressing @key{C-a s} you
610 can flush the COW disk image back into the raw disk image, as in
613 COW disk images can also be created without a corresponding raw disk
614 image. It is useful to have a big initial virtual disk image without
615 using much disk space. Use:
618 qemu-mkcow mycowimage.cow 1024
621 to create a 1 gigabyte empty COW disk image.
626 COW disk images must be created on file systems supporting
627 @emph{holes} such as ext2 or ext3.
629 Since holes are used, the displayed size of the COW disk image is not
630 the real one. To know it, use the @code{ls -ls} command.
633 @subsection Convert VMware disk images to raw disk images
635 You can use the tool @file{vmdk2raw} to convert VMware disk images to
636 raw disk images directly usable by QEMU. The syntax is:
638 vmdk2raw vmware_image output_image
641 @section Network emulation
643 QEMU simulates up to 6 networks cards (NE2000 boards). Each card can
644 be connected to a specific host network interface.
646 @subsection Using tun/tap network interface
648 This is the standard way to emulate network. QEMU adds a virtual
649 network device on your host (called @code{tun0}), and you can then
650 configure it as if it was a real ethernet card.
652 As an example, you can download the @file{linux-test-xxx.tar.gz}
653 archive and copy the script @file{qemu-ifup} in @file{/etc} and
654 configure properly @code{sudo} so that the command @code{ifconfig}
655 contained in @file{qemu-ifup} can be executed as root. You must verify
656 that your host kernel supports the TUN/TAP network interfaces: the
657 device @file{/dev/net/tun} must be present.
659 See @ref{direct_linux_boot} to have an example of network use with a
662 @subsection Using the user mode network stack
664 By using the option @option{-user-net} or if you have no tun/tap init
665 script, QEMU uses a completely user mode network stack (you don't need
666 root priviledge to use the virtual network). The virtual network
667 configuration is the following:
671 QEMU Virtual Machine <------> Firewall/DHCP server <-----> Internet
672 (10.0.2.x) | (10.0.2.2)
678 The QEMU VM behaves as if it was behind a firewall which blocks all
679 incoming connections. You can use a DHCP client to automatically
680 configure the network in the QEMU VM.
682 In order to check that the user mode network is working, you can ping
683 the address 10.0.2.2 and verify that you got an address in the range
684 10.0.2.x from the QEMU virtual DHCP server.
686 Note that @code{ping} is not supported reliably to the internet as it
687 would require root priviledges. It means you can only ping the local
690 When using the built-in TFTP server, the router is also the TFTP
693 When using the @option{-redir} option, TCP or UDP connections can be
694 redirected from the host to the guest. It allows for example to
695 redirect X11, telnet or SSH connections.
697 @node direct_linux_boot
698 @section Direct Linux Boot
700 This section explains how to launch a Linux kernel inside QEMU without
701 having to make a full bootable image. It is very useful for fast Linux
702 kernel testing. The QEMU network configuration is also explained.
706 Download the archive @file{linux-test-xxx.tar.gz} containing a Linux
707 kernel and a disk image.
709 @item Optional: If you want network support (for example to launch X11 examples), you
710 must copy the script @file{qemu-ifup} in @file{/etc} and configure
711 properly @code{sudo} so that the command @code{ifconfig} contained in
712 @file{qemu-ifup} can be executed as root. You must verify that your host
713 kernel supports the TUN/TAP network interfaces: the device
714 @file{/dev/net/tun} must be present.
716 When network is enabled, there is a virtual network connection between
717 the host kernel and the emulated kernel. The emulated kernel is seen
718 from the host kernel at IP address 172.20.0.2 and the host kernel is
719 seen from the emulated kernel at IP address 172.20.0.1.
721 @item Launch @code{qemu.sh}. You should have the following output:
725 Connected to host network interface: tun0
726 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
727 BIOS-provided physical RAM map:
728 BIOS-e801: 0000000000000000 - 000000000009f000 (usable)
729 BIOS-e801: 0000000000100000 - 0000000002000000 (usable)
730 32MB LOWMEM available.
731 On node 0 totalpages: 8192
735 Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe console=ttyS0
736 ide_setup: ide2=noprobe
737 ide_setup: ide3=noprobe
738 ide_setup: ide4=noprobe
739 ide_setup: ide5=noprobe
741 Detected 2399.621 MHz processor.
742 Console: colour EGA 80x25
743 Calibrating delay loop... 4744.80 BogoMIPS
744 Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, 0k highmem)
745 Dentry cache hash table entries: 4096 (order: 3, 32768 bytes)
746 Inode cache hash table entries: 2048 (order: 2, 16384 bytes)
747 Mount cache hash table entries: 512 (order: 0, 4096 bytes)
748 Buffer-cache hash table entries: 1024 (order: 0, 4096 bytes)
749 Page-cache hash table entries: 8192 (order: 3, 32768 bytes)
750 CPU: Intel Pentium Pro stepping 03
751 Checking 'hlt' instruction... OK.
752 POSIX conformance testing by UNIFIX
753 Linux NET4.0 for Linux 2.4
754 Based upon Swansea University Computer Society NET3.039
755 Initializing RT netlink socket
758 Journalled Block Device driver loaded
759 Detected PS/2 Mouse Port.
760 pty: 256 Unix98 ptys configured
761 Serial driver version 5.05c (2001-07-08) with no serial options enabled
762 ttyS00 at 0x03f8 (irq = 4) is a 16450
763 ne.c:v1.10 9/23/94 Donald Becker (becker@scyld.com)
764 Last modified Nov 1, 2000 by Paul Gortmaker
765 NE*000 ethercard probe at 0x300: 52 54 00 12 34 56
766 eth0: NE2000 found at 0x300, using IRQ 9.
767 RAMDISK driver initialized: 16 RAM disks of 4096K size 1024 blocksize
768 Uniform Multi-Platform E-IDE driver Revision: 7.00beta4-2.4
769 ide: Assuming 50MHz system bus speed for PIO modes; override with idebus=xx
770 hda: QEMU HARDDISK, ATA DISK drive
771 ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
772 hda: attached ide-disk driver.
773 hda: 20480 sectors (10 MB) w/256KiB Cache, CHS=20/16/63
776 Soundblaster audio driver Copyright (C) by Hannu Savolainen 1993-1996
777 NET4: Linux TCP/IP 1.0 for NET4.0
778 IP Protocols: ICMP, UDP, TCP, IGMP
779 IP: routing cache hash table of 512 buckets, 4Kbytes
780 TCP: Hash tables configured (established 2048 bind 4096)
781 NET4: Unix domain sockets 1.0/SMP for Linux NET4.0.
782 EXT2-fs warning: mounting unchecked fs, running e2fsck is recommended
783 VFS: Mounted root (ext2 filesystem).
784 Freeing unused kernel memory: 64k freed
786 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
788 QEMU Linux test distribution (based on Redhat 9)
790 Type 'exit' to halt the system
796 Then you can play with the kernel inside the virtual serial console. You
797 can launch @code{ls} for example. Type @key{Ctrl-a h} to have an help
798 about the keys you can type inside the virtual serial console. In
799 particular, use @key{Ctrl-a x} to exit QEMU and use @key{Ctrl-a b} as
803 If the network is enabled, launch the script @file{/etc/linuxrc} in the
804 emulator (don't forget the leading dot):
809 Then enable X11 connections on your PC from the emulated Linux:
814 You can now launch @file{xterm} or @file{xlogo} and verify that you have
815 a real Virtual Linux system !
822 A 2.5.74 kernel is also included in the archive. Just
823 replace the bzImage in qemu.sh to try it.
826 qemu-fast creates a temporary file in @var{$QEMU_TMPDIR} (@file{/tmp} is the
827 default) containing all the simulated PC memory. If possible, try to use
828 a temporary directory using the tmpfs filesystem to avoid too many
829 unnecessary disk accesses.
832 In order to exit cleanly from qemu, you can do a @emph{shutdown} inside
833 qemu. qemu will automatically exit when the Linux shutdown is done.
836 You can boot slightly faster by disabling the probe of non present IDE
837 interfaces. To do so, add the following options on the kernel command
840 ide1=noprobe ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe
844 The example disk image is a modified version of the one made by Kevin
845 Lawton for the plex86 Project (@url{www.plex86.org}).
850 @section Linux Kernel Compilation
852 You can use any linux kernel with QEMU. However, if you want to use
853 @code{qemu-fast} to get maximum performances, you must use a modified
854 guest kernel. If you are using a 2.6 guest kernel, you can use
855 directly the patch @file{linux-2.6-qemu-fast.patch} made by Rusty
856 Russel available in the QEMU source archive. Otherwise, you can make the
857 following changes @emph{by hand} to the Linux kernel:
861 The kernel must be mapped at 0x90000000 (the default is
862 0xc0000000). You must modify only two lines in the kernel source:
864 In @file{include/asm/page.h}, replace
866 #define __PAGE_OFFSET (0xc0000000)
870 #define __PAGE_OFFSET (0x90000000)
873 And in @file{arch/i386/vmlinux.lds}, replace
875 . = 0xc0000000 + 0x100000;
879 . = 0x90000000 + 0x100000;
883 If you want to enable SMP (Symmetric Multi-Processing) support, you
884 must make the following change in @file{include/asm/fixmap.h}. Replace
886 #define FIXADDR_TOP (0xffffX000UL)
890 #define FIXADDR_TOP (0xa7ffX000UL)
892 (X is 'e' or 'f' depending on the kernel version). Although you can
893 use an SMP kernel with QEMU, it only supports one CPU.
896 If you are not using a 2.6 kernel as host kernel but if you use a target
897 2.6 kernel, you must also ensure that the 'HZ' define is set to 100
898 (1000 is the default) as QEMU cannot currently emulate timers at
899 frequencies greater than 100 Hz on host Linux systems < 2.6. In
900 @file{include/asm/param.h}, replace:
903 # define HZ 1000 /* Internal kernel timer frequency */
907 # define HZ 100 /* Internal kernel timer frequency */
912 The file config-2.x.x gives the configuration of the example kernels.
919 As you would do to make a real kernel. Then you can use with QEMU
920 exactly the same kernel as you would boot on your PC (in
921 @file{arch/i386/boot/bzImage}).
926 QEMU has a primitive support to work with gdb, so that you can do
927 'Ctrl-C' while the virtual machine is running and inspect its state.
929 In order to use gdb, launch qemu with the '-s' option. It will wait for a
932 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
933 Connected to host network interface: tun0
934 Waiting gdb connection on port 1234
937 Then launch gdb on the 'vmlinux' executable:
942 In gdb, connect to QEMU:
944 (gdb) target remote localhost:1234
947 Then you can use gdb normally. For example, type 'c' to launch the kernel:
952 Here are some useful tips in order to use gdb on system code:
956 Use @code{info reg} to display all the CPU registers.
958 Use @code{x/10i $eip} to display the code at the PC position.
960 Use @code{set architecture i8086} to dump 16 bit code. Then use
961 @code{x/10i $cs*16+*eip} to dump the code at the PC position.
964 @section Target OS specific information
968 To have access to SVGA graphic modes under X11, use the @code{vesa} or
969 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
970 color depth in the guest and the host OS.
972 When using a 2.6 guest Linux kernel, you should add the option
973 @code{clock=pit} on the kernel command line because the 2.6 Linux
974 kernels make very strict real time clock checks by default that QEMU
975 cannot simulate exactly.
979 If you have a slow host, using Windows 95 is better as it gives the
980 best speed. Windows 2000 is also a good choice.
982 @subsubsection SVGA graphic modes support
984 QEMU emulates a Cirrus Logic GD5446 Video
985 card. All Windows versions starting from Windows 95 should recognize
986 and use this graphic card. For optimal performances, use 16 bit color
987 depth in the guest and the host OS.
989 @subsubsection CPU usage reduction
991 Windows 9x does not correctly use the CPU HLT
992 instruction. The result is that it takes host CPU cycles even when
993 idle. You can install the utility from
994 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
995 problem. Note that no such tool is needed for NT, 2000 or XP.
997 @subsubsection Windows 2000 disk full problems
999 Currently (release 0.6.0) QEMU has a bug which gives a @code{disk
1000 full} error during installation of some releases of Windows 2000. The
1001 workaround is to stop QEMU as soon as you notice that your disk image
1002 size is growing too fast (monitor it with @code{ls -ls}). Then
1003 relaunch QEMU to continue the installation. If you still experience
1004 the problem, relaunch QEMU again.
1006 Future QEMU releases are likely to correct this bug.
1008 @subsubsection Windows XP security problems
1010 Some releases of Windows XP install correctly but give a security
1013 A problem is preventing Windows from accurately checking the
1014 license for this computer. Error code: 0x800703e6.
1016 The only known workaround is to boot in Safe mode
1017 without networking support.
1019 Future QEMU releases are likely to correct this bug.
1021 @subsection MS-DOS and FreeDOS
1023 @subsubsection CPU usage reduction
1025 DOS does not correctly use the CPU HLT instruction. The result is that
1026 it takes host CPU cycles even when idle. You can install the utility
1027 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1030 @chapter QEMU PowerPC System emulator invocation
1032 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1033 or PowerMac PowerPC system.
1035 QEMU emulates the following PowerMac peripherials:
1041 PCI VGA compatible card with VESA Bochs Extensions
1043 2 PMAC IDE interfaces with hard disk and CD-ROM support
1049 VIA-CUDA with ADB keyboard and mouse.
1052 QEMU emulates the following PREP peripherials:
1058 PCI VGA compatible card with VESA Bochs Extensions
1060 2 IDE interfaces with hard disk and CD-ROM support
1064 NE2000 network adapters
1068 PREP Non Volatile RAM
1070 PC compatible keyboard and mouse.
1073 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1074 @url{http://site.voila.fr/jmayer/OpenHackWare/index.htm}.
1076 You can read the qemu PC system emulation chapter to have more
1077 informations about QEMU usage.
1079 @c man begin OPTIONS
1081 The following options are specific to the PowerPC emulation:
1086 Simulate a PREP system (default is PowerMAC)
1088 @item -g WxH[xDEPTH]
1090 Set the initial VGA graphic mode. The default is 800x600x15.
1097 More information is available at
1098 @url{http://jocelyn.mayer.free.fr/qemu-ppc/}.
1100 @chapter QEMU User space emulator invocation
1102 @section Quick Start
1104 In order to launch a Linux process, QEMU needs the process executable
1105 itself and all the target (x86) dynamic libraries used by it.
1109 @item On x86, you can just try to launch any process by using the native
1113 qemu-i386 -L / /bin/ls
1116 @code{-L /} tells that the x86 dynamic linker must be searched with a
1119 @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):
1122 qemu-i386 -L / qemu-i386 -L / /bin/ls
1125 @item On non x86 CPUs, you need first to download at least an x86 glibc
1126 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1127 @code{LD_LIBRARY_PATH} is not set:
1130 unset LD_LIBRARY_PATH
1133 Then you can launch the precompiled @file{ls} x86 executable:
1136 qemu-i386 tests/i386/ls
1138 You can look at @file{qemu-binfmt-conf.sh} so that
1139 QEMU is automatically launched by the Linux kernel when you try to
1140 launch x86 executables. It requires the @code{binfmt_misc} module in the
1143 @item The x86 version of QEMU is also included. You can try weird things such as:
1145 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1150 @section Wine launch
1154 @item Ensure that you have a working QEMU with the x86 glibc
1155 distribution (see previous section). In order to verify it, you must be
1159 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1162 @item Download the binary x86 Wine install
1163 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
1165 @item Configure Wine on your account. Look at the provided script
1166 @file{/usr/local/qemu-i386/bin/wine-conf.sh}. Your previous
1167 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1169 @item Then you can try the example @file{putty.exe}:
1172 qemu-i386 /usr/local/qemu-i386/wine/bin/wine /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1177 @section Command line options
1180 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1187 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1189 Set the x86 stack size in bytes (default=524288)
1196 Activate log (logfile=/tmp/qemu.log)
1198 Act as if the host page size was 'pagesize' bytes
1202 @chapter Compilation from the sources
1206 Read the @file{README} which gives the related information.
1211 @item Install the current versions of MSYS and MinGW from
1212 @url{http://www.mingw.org/}. You can find detailed installation
1213 instructions in the download section and the FAQ.
1216 the MinGW development library of SDL 1.2.x
1217 (@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
1218 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
1219 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1220 directory. Edit the @file{sdl-config} script so that it gives the
1221 correct SDL directory when invoked.
1223 @item Extract the current version of QEMU.
1225 @item Start the MSYS shell (file @file{msys.bat}).
1227 @item Change to the QEMU directory. Launch @file{./configure} and
1228 @file{make}. If you have problems using SDL, verify that
1229 @file{sdl-config} can be launched from the MSYS command line.
1231 @item You can install QEMU in @file{Program Files/Qemu} by typing
1232 @file{make install}. Don't forget to copy @file{SDL.dll} in
1233 @file{Program Files/Qemu}.
1237 @section Cross compilation for Windows with Linux
1241 Install the MinGW cross compilation tools available at
1242 @url{http://www.mingw.org/}.
1245 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1246 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1247 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1248 the QEMU configuration script.
1251 Configure QEMU for Windows cross compilation:
1253 ./configure --enable-mingw32
1255 If necessary, you can change the cross-prefix according to the prefix
1256 choosen for the MinGW tools with --cross-prefix. You can also use
1257 --prefix to set the Win32 install path.
1259 @item You can install QEMU in the installation directory by typing
1260 @file{make install}. Don't forget to copy @file{SDL.dll} in the
1261 installation directory.
1265 Note: Currently, Wine does not seem able to launch
1270 The Mac OS X patches are not fully merged in QEMU, so you should look
1271 at the QEMU mailing list archive to have all the necessary