1 \input texinfo @c -*- texinfo -*-
3 @setfilename qemu-doc.info
4 @settitle QEMU Emulator User Documentation
12 @center @titlefont{QEMU Emulator}
14 @center @titlefont{User Documentation}
26 * QEMU PC System emulator::
27 * QEMU System emulator for non PC targets::
28 * QEMU Linux User space emulator::
29 * compilation:: Compilation from the sources
40 * intro_features:: Features
46 QEMU is a FAST! processor emulator using dynamic translation to
47 achieve good emulation speed.
49 QEMU has two operating modes:
54 Full system emulation. In this mode, QEMU emulates a full system (for
55 example a PC), including one or several processors and various
56 peripherals. It can be used to launch different Operating Systems
57 without rebooting the PC or to debug system code.
60 User mode emulation (Linux host only). In this mode, QEMU can launch
61 Linux processes compiled for one CPU on another CPU. It can be used to
62 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
63 to ease cross-compilation and cross-debugging.
67 QEMU can run without an host kernel driver and yet gives acceptable
70 For system emulation, the following hardware targets are supported:
72 @item PC (x86 or x86_64 processor)
73 @item ISA PC (old style PC without PCI bus)
74 @item PREP (PowerPC processor)
75 @item G3 BW PowerMac (PowerPC processor)
76 @item Mac99 PowerMac (PowerPC processor, in progress)
77 @item Sun4m (32-bit Sparc processor)
78 @item Sun4u (64-bit Sparc processor, in progress)
79 @item Malta board (32-bit MIPS processor)
80 @item ARM Integrator/CP (ARM926E or 1026E processor)
81 @item ARM Versatile baseboard (ARM926E)
84 For user emulation, x86, PowerPC, ARM, MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
89 If you want to compile QEMU yourself, see @ref{compilation}.
92 * install_linux:: Linux
93 * install_windows:: Windows
94 * install_mac:: Macintosh
100 If a precompiled package is available for your distribution - you just
101 have to install it. Otherwise, see @ref{compilation}.
103 @node install_windows
106 Download the experimental binary installer at
107 @url{http://www.free.oszoo.org/@/download.html}.
112 Download the experimental binary installer at
113 @url{http://www.free.oszoo.org/@/download.html}.
115 @node QEMU PC System emulator
116 @chapter QEMU PC System emulator
119 * pcsys_introduction:: Introduction
120 * pcsys_quickstart:: Quick Start
121 * sec_invocation:: Invocation
123 * pcsys_monitor:: QEMU Monitor
124 * disk_images:: Disk Images
125 * pcsys_network:: Network emulation
126 * direct_linux_boot:: Direct Linux Boot
127 * pcsys_usb:: USB emulation
128 * gdb_usage:: GDB usage
129 * pcsys_os_specific:: Target OS specific information
132 @node pcsys_introduction
133 @section Introduction
135 @c man begin DESCRIPTION
137 The QEMU PC System emulator simulates the
138 following peripherals:
142 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
144 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
145 extensions (hardware level, including all non standard modes).
147 PS/2 mouse and keyboard
149 2 PCI IDE interfaces with hard disk and CD-ROM support
153 NE2000 PCI network adapters
157 Creative SoundBlaster 16 sound card
159 ENSONIQ AudioPCI ES1370 sound card
161 Adlib(OPL2) - Yamaha YM3812 compatible chip
163 PCI UHCI USB controller and a virtual USB hub.
166 SMP is supported with up to 255 CPUs.
168 Note that adlib is only available when QEMU was configured with
171 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
174 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
178 @node pcsys_quickstart
181 Download and uncompress the linux image (@file{linux.img}) and type:
187 Linux should boot and give you a prompt.
193 @c man begin SYNOPSIS
194 usage: qemu [options] [disk_image]
199 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
204 Select the emulated machine (@code{-M ?} for list)
208 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
209 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
215 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
218 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
219 @option{-cdrom} at the same time). You can use the host CD-ROM by
220 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
223 Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
227 Write to temporary files instead of disk image files. In this case,
228 the raw disk image you use is not written back. You can however force
229 the write back by pressing @key{C-a s} (@pxref{disk_images}).
232 Disable boot signature checking for floppy disks in Bochs BIOS. It may
233 be needed to boot from old floppy disks.
236 Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
239 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
244 Normally, QEMU uses SDL to display the VGA output. With this option,
245 you can totally disable graphical output so that QEMU is a simple
246 command line application. The emulated serial port is redirected on
247 the console. Therefore, you can still use QEMU to debug a Linux kernel
248 with a serial console.
252 Normally, QEMU uses SDL to display the VGA output. With this option,
253 you can have QEMU listen on VNC display @var{display} and redirect the VGA
254 display over the VNC session. It is very useful to enable the usb
255 tablet device when using this option (option @option{-usbdevice
256 tablet}). When using the VNC display, you must use the @option{-k}
257 option to set the keyboard layout if you are not using en-us.
259 @var{display} may be in the form @var{interface:d}, in which case connections
260 will only be allowed from @var{interface} on display @var{d}. Optionally,
261 @var{interface} can be omitted. @var{display} can also be in the form
262 @var{unix:path} where @var{path} is the location of a unix socket to listen for
268 Use keyboard layout @var{language} (for example @code{fr} for
269 French). This option is only needed where it is not easy to get raw PC
270 keycodes (e.g. on Macs, with some X11 servers or with a VNC
271 display). You don't normally need to use it on PC/Linux or PC/Windows
274 The available layouts are:
276 ar de-ch es fo fr-ca hu ja mk no pt-br sv
277 da en-gb et fr fr-ch is lt nl pl ru th
278 de en-us fi fr-be hr it lv nl-be pt sl tr
281 The default is @code{en-us}.
285 Will show the audio subsystem help: list of drivers, tunable
288 @item -soundhw card1,card2,... or -soundhw all
290 Enable audio and selected sound hardware. Use ? to print all
291 available sound hardware.
294 qemu -soundhw sb16,adlib hda
295 qemu -soundhw es1370 hda
296 qemu -soundhw all hda
301 Set the real time clock to local time (the default is to UTC
302 time). This option is needed to have correct date in MS-DOS or
306 Start in full screen.
309 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
313 Daemonize the QEMU process after initialization. QEMU will not detach from
314 standard IO until it is ready to receive connections on any of its devices.
315 This option is a useful way for external programs to launch QEMU without having
316 to cope with initialization race conditions.
319 Use it when installing Windows 2000 to avoid a disk full bug. After
320 Windows 2000 is installed, you no longer need this option (this option
321 slows down the IDE transfers).
329 Enable the USB driver (will be the default soon)
331 @item -usbdevice devname
332 Add the USB device @var{devname}. @xref{usb_devices}.
339 @item -net nic[,vlan=n][,macaddr=addr][,model=type]
340 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
341 = 0 is the default). The NIC is currently an NE2000 on the PC
342 target. Optionally, the MAC address can be changed. If no
343 @option{-net} option is specified, a single NIC is created.
344 Qemu can emulate several different models of network card. Valid values for
345 @var{type} are @code{ne2k_pci}, @code{ne2k_isa}, @code{rtl8139},
346 @code{smc91c111} and @code{lance}. Not all devices are supported on all
349 @item -net user[,vlan=n][,hostname=name]
350 Use the user mode network stack which requires no administrator
351 priviledge to run. @option{hostname=name} can be used to specify the client
352 hostname reported by the builtin DHCP server.
354 @item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
355 Connect the host TAP network interface @var{name} to VLAN @var{n} and
356 use the network script @var{file} to configure it. The default
357 network script is @file{/etc/qemu-ifup}. If @var{name} is not
358 provided, the OS automatically provides one. @option{fd=h} can be
359 used to specify the handle of an already opened host TAP interface. Example:
362 qemu linux.img -net nic -net tap
365 More complicated example (two NICs, each one connected to a TAP device)
367 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
368 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
372 @item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
374 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
375 machine using a TCP socket connection. If @option{listen} is
376 specified, QEMU waits for incoming connections on @var{port}
377 (@var{host} is optional). @option{connect} is used to connect to
378 another QEMU instance using the @option{listen} option. @option{fd=h}
379 specifies an already opened TCP socket.
383 # launch a first QEMU instance
384 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
385 -net socket,listen=:1234
386 # connect the VLAN 0 of this instance to the VLAN 0
387 # of the first instance
388 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
389 -net socket,connect=127.0.0.1:1234
392 @item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]
394 Create a VLAN @var{n} shared with another QEMU virtual
395 machines using a UDP multicast socket, effectively making a bus for
396 every QEMU with same multicast address @var{maddr} and @var{port}.
400 Several QEMU can be running on different hosts and share same bus (assuming
401 correct multicast setup for these hosts).
403 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
404 @url{http://user-mode-linux.sf.net}.
405 @item Use @option{fd=h} to specify an already opened UDP multicast socket.
410 # launch one QEMU instance
411 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
412 -net socket,mcast=230.0.0.1:1234
413 # launch another QEMU instance on same "bus"
414 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
415 -net socket,mcast=230.0.0.1:1234
416 # launch yet another QEMU instance on same "bus"
417 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
418 -net socket,mcast=230.0.0.1:1234
421 Example (User Mode Linux compat.):
423 # launch QEMU instance (note mcast address selected
425 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
426 -net socket,mcast=239.192.168.1:1102
428 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
432 Indicate that no network devices should be configured. It is used to
433 override the default configuration (@option{-net nic -net user}) which
434 is activated if no @option{-net} options are provided.
437 When using the user mode network stack, activate a built-in TFTP
438 server. All filenames beginning with @var{prefix} can be downloaded
439 from the host to the guest using a TFTP client. The TFTP client on the
440 guest must be configured in binary mode (use the command @code{bin} of
441 the Unix TFTP client). The host IP address on the guest is as usual
445 When using the user mode network stack, activate a built-in SMB
446 server so that Windows OSes can access to the host files in @file{dir}
449 In the guest Windows OS, the line:
453 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
454 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
456 Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
458 Note that a SAMBA server must be installed on the host OS in
459 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
460 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
462 @item -redir [tcp|udp]:host-port:[guest-host]:guest-port
464 When using the user mode network stack, redirect incoming TCP or UDP
465 connections to the host port @var{host-port} to the guest
466 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
467 is not specified, its value is 10.0.2.15 (default address given by the
468 built-in DHCP server).
470 For example, to redirect host X11 connection from screen 1 to guest
471 screen 0, use the following:
475 qemu -redir tcp:6001::6000 [...]
476 # this host xterm should open in the guest X11 server
480 To redirect telnet connections from host port 5555 to telnet port on
481 the guest, use the following:
485 qemu -redir tcp:5555::23 [...]
486 telnet localhost 5555
489 Then when you use on the host @code{telnet localhost 5555}, you
490 connect to the guest telnet server.
494 Linux boot specific: When using these options, you can use a given
495 Linux kernel without installing it in the disk image. It can be useful
496 for easier testing of various kernels.
500 @item -kernel bzImage
501 Use @var{bzImage} as kernel image.
503 @item -append cmdline
504 Use @var{cmdline} as kernel command line
507 Use @var{file} as initial ram disk.
511 Debug/Expert options:
515 Redirect the virtual serial port to host character device
516 @var{dev}. The default device is @code{vc} in graphical mode and
517 @code{stdio} in non graphical mode.
519 This option can be used several times to simulate up to 4 serials
522 Use @code{-serial none} to disable all serial ports.
524 Available character devices are:
529 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
531 No device is allocated.
535 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
536 parameters are set according to the emulated ones.
538 [Linux only, parallel port only] Use host parallel port
539 @var{N}. Currently only SPP parallel port features can be used.
541 Write output to filename. No character can be read.
543 [Unix only] standard input/output
545 name pipe @var{filename}
547 [Windows only] Use host serial port @var{n}
548 @item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
549 This implements UDP Net Console. When @var{remote_host} or @var{src_ip} are not specified they default to @code{0.0.0.0}. When not using a specifed @var{src_port} a random port is automatically chosen.
551 If you just want a simple readonly console you can use @code{netcat} or
552 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
553 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
554 will appear in the netconsole session.
556 If you plan to send characters back via netconsole or you want to stop
557 and start qemu a lot of times, you should have qemu use the same
558 source port each time by using something like @code{-serial
559 udp::4555@@:4556} to qemu. Another approach is to use a patched
560 version of netcat which can listen to a TCP port and send and receive
561 characters via udp. If you have a patched version of netcat which
562 activates telnet remote echo and single char transfer, then you can
563 use the following options to step up a netcat redirector to allow
564 telnet on port 5555 to access the qemu port.
567 -serial udp::4555@@:4556
568 @item netcat options:
569 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
570 @item telnet options:
575 @item tcp:[host]:port[,server][,nowait]
576 The TCP Net Console has two modes of operation. It can send the serial
577 I/O to a location or wait for a connection from a location. By default
578 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
579 the @var{server} option QEMU will wait for a client socket application
580 to connect to the port before continuing, unless the @code{nowait}
581 option was specified. If @var{host} is omitted, 0.0.0.0 is assumed. Only
582 one TCP connection at a time is accepted. You can use @code{telnet} to
583 connect to the corresponding character device.
585 @item Example to send tcp console to 192.168.0.2 port 4444
586 -serial tcp:192.168.0.2:4444
587 @item Example to listen and wait on port 4444 for connection
588 -serial tcp::4444,server
589 @item Example to not wait and listen on ip 192.168.0.100 port 4444
590 -serial tcp:192.168.0.100:4444,server,nowait
593 @item telnet:host:port[,server][,nowait]
594 The telnet protocol is used instead of raw tcp sockets. The options
595 work the same as if you had specified @code{-serial tcp}. The
596 difference is that the port acts like a telnet server or client using
597 telnet option negotiation. This will also allow you to send the
598 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
599 sequence. Typically in unix telnet you do it with Control-] and then
600 type "send break" followed by pressing the enter key.
602 @item unix:path[,server][,nowait]
603 A unix domain socket is used instead of a tcp socket. The option works the
604 same as if you had specified @code{-serial tcp} except the unix domain socket
605 @var{path} is used for connections.
610 Redirect the virtual parallel port to host device @var{dev} (same
611 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
612 be used to use hardware devices connected on the corresponding host
615 This option can be used several times to simulate up to 3 parallel
618 Use @code{-parallel none} to disable all parallel ports.
621 Redirect the monitor to host device @var{dev} (same devices as the
623 The default device is @code{vc} in graphical mode and @code{stdio} in
627 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
629 Change gdb connection port.
631 Do not start CPU at startup (you must type 'c' in the monitor).
633 Output log in /tmp/qemu.log
634 @item -hdachs c,h,s,[,t]
635 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
636 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
637 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
638 all thoses parameters. This option is useful for old MS-DOS disk
642 Set the directory for the BIOS, VGA BIOS and keymaps.
645 Simulate a standard VGA card with Bochs VBE extensions (default is
646 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
647 VBE extensions (e.g. Windows XP) and if you want to use high
648 resolution modes (>= 1280x1024x16) then you should use this option.
651 Disable ACPI (Advanced Configuration and Power Interface) support. Use
652 it if your guest OS complains about ACPI problems (PC target machine
656 Exit instead of rebooting.
659 Start right away with a saved state (@code{loadvm} in monitor)
669 During the graphical emulation, you can use the following keys:
675 Switch to virtual console 'n'. Standard console mappings are:
678 Target system display
686 Toggle mouse and keyboard grab.
689 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
690 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
692 During emulation, if you are using the @option{-nographic} option, use
693 @key{Ctrl-a h} to get terminal commands:
701 Save disk data back to file (if -snapshot)
703 Send break (magic sysrq in Linux)
705 Switch between console and monitor
714 The HTML documentation of QEMU for more precise information and Linux
715 user mode emulator invocation.
725 @section QEMU Monitor
727 The QEMU monitor is used to give complex commands to the QEMU
728 emulator. You can use it to:
733 Remove or insert removable medias images
734 (such as CD-ROM or floppies)
737 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
740 @item Inspect the VM state without an external debugger.
746 The following commands are available:
750 @item help or ? [cmd]
751 Show the help for all commands or just for command @var{cmd}.
754 Commit changes to the disk images (if -snapshot is used)
756 @item info subcommand
757 show various information about the system state
761 show the various VLANs and the associated devices
763 show the block devices
765 show the cpu registers
767 show the command line history
769 show emulated PCI device
771 show USB devices plugged on the virtual USB hub
773 show all USB host devices
775 show information about active capturing
777 show list of VM snapshots
783 @item eject [-f] device
784 Eject a removable media (use -f to force it).
786 @item change device filename
787 Change a removable media.
789 @item screendump filename
790 Save screen into PPM image @var{filename}.
792 @item wavcapture filename [frequency [bits [channels]]]
793 Capture audio into @var{filename}. Using sample rate @var{frequency}
794 bits per sample @var{bits} and number of channels @var{channels}.
798 @item Sample rate = 44100 Hz - CD quality
800 @item Number of channels = 2 - Stereo
803 @item stopcapture index
804 Stop capture with a given @var{index}, index can be obtained with
809 @item log item1[,...]
810 Activate logging of the specified items to @file{/tmp/qemu.log}.
812 @item savevm [tag|id]
813 Create a snapshot of the whole virtual machine. If @var{tag} is
814 provided, it is used as human readable identifier. If there is already
815 a snapshot with the same tag or ID, it is replaced. More info at
819 Set the whole virtual machine to the snapshot identified by the tag
820 @var{tag} or the unique snapshot ID @var{id}.
823 Delete the snapshot identified by @var{tag} or @var{id}.
831 @item gdbserver [port]
832 Start gdbserver session (default port=1234)
835 Virtual memory dump starting at @var{addr}.
838 Physical memory dump starting at @var{addr}.
840 @var{fmt} is a format which tells the command how to format the
841 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
845 is the number of items to be dumped.
848 can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
849 c (char) or i (asm instruction).
852 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
853 @code{h} or @code{w} can be specified with the @code{i} format to
854 respectively select 16 or 32 bit code instruction size.
861 Dump 10 instructions at the current instruction pointer:
866 0x90107065: lea 0x0(%esi,1),%esi
867 0x90107069: lea 0x0(%edi,1),%edi
869 0x90107071: jmp 0x90107080
877 Dump 80 16 bit values at the start of the video memory.
879 (qemu) xp/80hx 0xb8000
880 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
881 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
882 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
883 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
884 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
885 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
886 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
887 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
888 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
889 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
893 @item p or print/fmt expr
895 Print expression value. Only the @var{format} part of @var{fmt} is
900 Send @var{keys} to the emulator. Use @code{-} to press several keys
901 simultaneously. Example:
906 This command is useful to send keys that your graphical user interface
907 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
913 @item usb_add devname
915 Add the USB device @var{devname}. For details of available devices see
918 @item usb_del devname
920 Remove the USB device @var{devname} from the QEMU virtual USB
921 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
922 command @code{info usb} to see the devices you can remove.
926 @subsection Integer expressions
928 The monitor understands integers expressions for every integer
929 argument. You can use register names to get the value of specifics
930 CPU registers by prefixing them with @emph{$}.
935 Since version 0.6.1, QEMU supports many disk image formats, including
936 growable disk images (their size increase as non empty sectors are
937 written), compressed and encrypted disk images. Version 0.8.3 added
938 the new qcow2 disk image format which is essential to support VM
942 * disk_images_quickstart:: Quick start for disk image creation
943 * disk_images_snapshot_mode:: Snapshot mode
944 * vm_snapshots:: VM snapshots
945 * qemu_img_invocation:: qemu-img Invocation
946 * host_drives:: Using host drives
947 * disk_images_fat_images:: Virtual FAT disk images
950 @node disk_images_quickstart
951 @subsection Quick start for disk image creation
953 You can create a disk image with the command:
955 qemu-img create myimage.img mysize
957 where @var{myimage.img} is the disk image filename and @var{mysize} is its
958 size in kilobytes. You can add an @code{M} suffix to give the size in
959 megabytes and a @code{G} suffix for gigabytes.
961 See @ref{qemu_img_invocation} for more information.
963 @node disk_images_snapshot_mode
964 @subsection Snapshot mode
966 If you use the option @option{-snapshot}, all disk images are
967 considered as read only. When sectors in written, they are written in
968 a temporary file created in @file{/tmp}. You can however force the
969 write back to the raw disk images by using the @code{commit} monitor
970 command (or @key{C-a s} in the serial console).
973 @subsection VM snapshots
975 VM snapshots are snapshots of the complete virtual machine including
976 CPU state, RAM, device state and the content of all the writable
977 disks. In order to use VM snapshots, you must have at least one non
978 removable and writable block device using the @code{qcow2} disk image
979 format. Normally this device is the first virtual hard drive.
981 Use the monitor command @code{savevm} to create a new VM snapshot or
982 replace an existing one. A human readable name can be assigned to each
983 snapshot in addition to its numerical ID.
985 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
986 a VM snapshot. @code{info snapshots} lists the available snapshots
987 with their associated information:
990 (qemu) info snapshots
991 Snapshot devices: hda
992 Snapshot list (from hda):
993 ID TAG VM SIZE DATE VM CLOCK
994 1 start 41M 2006-08-06 12:38:02 00:00:14.954
995 2 40M 2006-08-06 12:43:29 00:00:18.633
996 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
999 A VM snapshot is made of a VM state info (its size is shown in
1000 @code{info snapshots}) and a snapshot of every writable disk image.
1001 The VM state info is stored in the first @code{qcow2} non removable
1002 and writable block device. The disk image snapshots are stored in
1003 every disk image. The size of a snapshot in a disk image is difficult
1004 to evaluate and is not shown by @code{info snapshots} because the
1005 associated disk sectors are shared among all the snapshots to save
1006 disk space (otherwise each snapshot would need a full copy of all the
1009 When using the (unrelated) @code{-snapshot} option
1010 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1011 but they are deleted as soon as you exit QEMU.
1013 VM snapshots currently have the following known limitations:
1016 They cannot cope with removable devices if they are removed or
1017 inserted after a snapshot is done.
1019 A few device drivers still have incomplete snapshot support so their
1020 state is not saved or restored properly (in particular USB).
1023 @node qemu_img_invocation
1024 @subsection @code{qemu-img} Invocation
1026 @include qemu-img.texi
1029 @subsection Using host drives
1031 In addition to disk image files, QEMU can directly access host
1032 devices. We describe here the usage for QEMU version >= 0.8.3.
1034 @subsubsection Linux
1036 On Linux, you can directly use the host device filename instead of a
1037 disk image filename provided you have enough proviledge to access
1038 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1039 @file{/dev/fd0} for the floppy.
1043 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1044 specific code to detect CDROM insertion or removal. CDROM ejection by
1045 the guest OS is supported. Currently only data CDs are supported.
1047 You can specify a floppy device even if no floppy is loaded. Floppy
1048 removal is currently not detected accurately (if you change floppy
1049 without doing floppy access while the floppy is not loaded, the guest
1050 OS will think that the same floppy is loaded).
1052 Hard disks can be used. Normally you must specify the whole disk
1053 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1054 see it as a partitioned disk. WARNING: unless you know what you do, it
1055 is better to only make READ-ONLY accesses to the hard disk otherwise
1056 you may corrupt your host data (use the @option{-snapshot} command
1057 line option or modify the device permissions accordingly).
1060 @subsubsection Windows
1062 On Windows you can use any host drives as QEMU drive. The prefered
1063 syntax is the driver letter (e.g. @file{d:}). The alternate syntax
1064 @file{\\.\d:} is supported. @file{/dev/cdrom} is supported as an alias
1065 to the first CDROM drive.
1067 Currently there is no specific code to handle removable medias, so it
1068 is better to use the @code{change} or @code{eject} monitor commands to
1069 change or eject media.
1071 @subsubsection Mac OS X
1073 @file{/dev/cdrom} is an alias to the first CDROM.
1075 Currently there is no specific code to handle removable medias, so it
1076 is better to use the @code{change} or @code{eject} monitor commands to
1077 change or eject media.
1079 @node disk_images_fat_images
1080 @subsection Virtual FAT disk images
1082 QEMU can automatically create a virtual FAT disk image from a
1083 directory tree. In order to use it, just type:
1086 qemu linux.img -hdb fat:/my_directory
1089 Then you access access to all the files in the @file{/my_directory}
1090 directory without having to copy them in a disk image or to export
1091 them via SAMBA or NFS. The default access is @emph{read-only}.
1093 Floppies can be emulated with the @code{:floppy:} option:
1096 qemu linux.img -fda fat:floppy:/my_directory
1099 A read/write support is available for testing (beta stage) with the
1103 qemu linux.img -fda fat:floppy:rw:/my_directory
1106 What you should @emph{never} do:
1108 @item use non-ASCII filenames ;
1109 @item use "-snapshot" together with ":rw:" ;
1110 @item expect it to work when loadvm'ing ;
1111 @item write to the FAT directory on the host system while accessing it with the guest system.
1115 @section Network emulation
1117 QEMU can simulate several networks cards (NE2000 boards on the PC
1118 target) and can connect them to an arbitrary number of Virtual Local
1119 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1120 VLAN. VLAN can be connected between separate instances of QEMU to
1121 simulate large networks. For simpler usage, a non priviledged user mode
1122 network stack can replace the TAP device to have a basic network
1127 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1128 connection between several network devices. These devices can be for
1129 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1132 @subsection Using TAP network interfaces
1134 This is the standard way to connect QEMU to a real network. QEMU adds
1135 a virtual network device on your host (called @code{tapN}), and you
1136 can then configure it as if it was a real ethernet card.
1138 @subsubsection Linux host
1140 As an example, you can download the @file{linux-test-xxx.tar.gz}
1141 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1142 configure properly @code{sudo} so that the command @code{ifconfig}
1143 contained in @file{qemu-ifup} can be executed as root. You must verify
1144 that your host kernel supports the TAP network interfaces: the
1145 device @file{/dev/net/tun} must be present.
1147 See @ref{sec_invocation} to have examples of command lines using the
1148 TAP network interfaces.
1150 @subsubsection Windows host
1152 There is a virtual ethernet driver for Windows 2000/XP systems, called
1153 TAP-Win32. But it is not included in standard QEMU for Windows,
1154 so you will need to get it separately. It is part of OpenVPN package,
1155 so download OpenVPN from : @url{http://openvpn.net/}.
1157 @subsection Using the user mode network stack
1159 By using the option @option{-net user} (default configuration if no
1160 @option{-net} option is specified), QEMU uses a completely user mode
1161 network stack (you don't need root priviledge to use the virtual
1162 network). The virtual network configuration is the following:
1166 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1169 ----> DNS server (10.0.2.3)
1171 ----> SMB server (10.0.2.4)
1174 The QEMU VM behaves as if it was behind a firewall which blocks all
1175 incoming connections. You can use a DHCP client to automatically
1176 configure the network in the QEMU VM. The DHCP server assign addresses
1177 to the hosts starting from 10.0.2.15.
1179 In order to check that the user mode network is working, you can ping
1180 the address 10.0.2.2 and verify that you got an address in the range
1181 10.0.2.x from the QEMU virtual DHCP server.
1183 Note that @code{ping} is not supported reliably to the internet as it
1184 would require root priviledges. It means you can only ping the local
1187 When using the built-in TFTP server, the router is also the TFTP
1190 When using the @option{-redir} option, TCP or UDP connections can be
1191 redirected from the host to the guest. It allows for example to
1192 redirect X11, telnet or SSH connections.
1194 @subsection Connecting VLANs between QEMU instances
1196 Using the @option{-net socket} option, it is possible to make VLANs
1197 that span several QEMU instances. See @ref{sec_invocation} to have a
1200 @node direct_linux_boot
1201 @section Direct Linux Boot
1203 This section explains how to launch a Linux kernel inside QEMU without
1204 having to make a full bootable image. It is very useful for fast Linux
1209 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1212 Use @option{-kernel} to provide the Linux kernel image and
1213 @option{-append} to give the kernel command line arguments. The
1214 @option{-initrd} option can be used to provide an INITRD image.
1216 When using the direct Linux boot, a disk image for the first hard disk
1217 @file{hda} is required because its boot sector is used to launch the
1220 If you do not need graphical output, you can disable it and redirect
1221 the virtual serial port and the QEMU monitor to the console with the
1222 @option{-nographic} option. The typical command line is:
1224 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1225 -append "root=/dev/hda console=ttyS0" -nographic
1228 Use @key{Ctrl-a c} to switch between the serial console and the
1229 monitor (@pxref{pcsys_keys}).
1232 @section USB emulation
1234 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1235 virtual USB devices or real host USB devices (experimental, works only
1236 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1237 as necessary to connect multiple USB devices.
1241 * host_usb_devices::
1244 @subsection Connecting USB devices
1246 USB devices can be connected with the @option{-usbdevice} commandline option
1247 or the @code{usb_add} monitor command. Available devices are:
1251 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1253 Pointer device that uses absolute coordinates (like a touchscreen).
1254 This means qemu is able to report the mouse position without having
1255 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1256 @item @code{disk:file}
1257 Mass storage device based on @var{file} (@pxref{disk_images})
1258 @item @code{host:bus.addr}
1259 Pass through the host device identified by @var{bus.addr}
1261 @item @code{host:vendor_id:product_id}
1262 Pass through the host device identified by @var{vendor_id:product_id}
1266 @node host_usb_devices
1267 @subsection Using host USB devices on a Linux host
1269 WARNING: this is an experimental feature. QEMU will slow down when
1270 using it. USB devices requiring real time streaming (i.e. USB Video
1271 Cameras) are not supported yet.
1274 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1275 is actually using the USB device. A simple way to do that is simply to
1276 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1277 to @file{mydriver.o.disabled}.
1279 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1285 @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:
1287 chown -R myuid /proc/bus/usb
1290 @item Launch QEMU and do in the monitor:
1293 Device 1.2, speed 480 Mb/s
1294 Class 00: USB device 1234:5678, USB DISK
1296 You should see the list of the devices you can use (Never try to use
1297 hubs, it won't work).
1299 @item Add the device in QEMU by using:
1301 usb_add host:1234:5678
1304 Normally the guest OS should report that a new USB device is
1305 plugged. You can use the option @option{-usbdevice} to do the same.
1307 @item Now you can try to use the host USB device in QEMU.
1311 When relaunching QEMU, you may have to unplug and plug again the USB
1312 device to make it work again (this is a bug).
1317 QEMU has a primitive support to work with gdb, so that you can do
1318 'Ctrl-C' while the virtual machine is running and inspect its state.
1320 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1323 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1324 -append "root=/dev/hda"
1325 Connected to host network interface: tun0
1326 Waiting gdb connection on port 1234
1329 Then launch gdb on the 'vmlinux' executable:
1334 In gdb, connect to QEMU:
1336 (gdb) target remote localhost:1234
1339 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1344 Here are some useful tips in order to use gdb on system code:
1348 Use @code{info reg} to display all the CPU registers.
1350 Use @code{x/10i $eip} to display the code at the PC position.
1352 Use @code{set architecture i8086} to dump 16 bit code. Then use
1353 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1356 @node pcsys_os_specific
1357 @section Target OS specific information
1361 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1362 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1363 color depth in the guest and the host OS.
1365 When using a 2.6 guest Linux kernel, you should add the option
1366 @code{clock=pit} on the kernel command line because the 2.6 Linux
1367 kernels make very strict real time clock checks by default that QEMU
1368 cannot simulate exactly.
1370 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1371 not activated because QEMU is slower with this patch. The QEMU
1372 Accelerator Module is also much slower in this case. Earlier Fedora
1373 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
1374 patch by default. Newer kernels don't have it.
1378 If you have a slow host, using Windows 95 is better as it gives the
1379 best speed. Windows 2000 is also a good choice.
1381 @subsubsection SVGA graphic modes support
1383 QEMU emulates a Cirrus Logic GD5446 Video
1384 card. All Windows versions starting from Windows 95 should recognize
1385 and use this graphic card. For optimal performances, use 16 bit color
1386 depth in the guest and the host OS.
1388 If you are using Windows XP as guest OS and if you want to use high
1389 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1390 1280x1024x16), then you should use the VESA VBE virtual graphic card
1391 (option @option{-std-vga}).
1393 @subsubsection CPU usage reduction
1395 Windows 9x does not correctly use the CPU HLT
1396 instruction. The result is that it takes host CPU cycles even when
1397 idle. You can install the utility from
1398 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1399 problem. Note that no such tool is needed for NT, 2000 or XP.
1401 @subsubsection Windows 2000 disk full problem
1403 Windows 2000 has a bug which gives a disk full problem during its
1404 installation. When installing it, use the @option{-win2k-hack} QEMU
1405 option to enable a specific workaround. After Windows 2000 is
1406 installed, you no longer need this option (this option slows down the
1409 @subsubsection Windows 2000 shutdown
1411 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1412 can. It comes from the fact that Windows 2000 does not automatically
1413 use the APM driver provided by the BIOS.
1415 In order to correct that, do the following (thanks to Struan
1416 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1417 Add/Troubleshoot a device => Add a new device & Next => No, select the
1418 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1419 (again) a few times. Now the driver is installed and Windows 2000 now
1420 correctly instructs QEMU to shutdown at the appropriate moment.
1422 @subsubsection Share a directory between Unix and Windows
1424 See @ref{sec_invocation} about the help of the option @option{-smb}.
1426 @subsubsection Windows XP security problem
1428 Some releases of Windows XP install correctly but give a security
1431 A problem is preventing Windows from accurately checking the
1432 license for this computer. Error code: 0x800703e6.
1435 The workaround is to install a service pack for XP after a boot in safe
1436 mode. Then reboot, and the problem should go away. Since there is no
1437 network while in safe mode, its recommended to download the full
1438 installation of SP1 or SP2 and transfer that via an ISO or using the
1439 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1441 @subsection MS-DOS and FreeDOS
1443 @subsubsection CPU usage reduction
1445 DOS does not correctly use the CPU HLT instruction. The result is that
1446 it takes host CPU cycles even when idle. You can install the utility
1447 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1450 @node QEMU System emulator for non PC targets
1451 @chapter QEMU System emulator for non PC targets
1453 QEMU is a generic emulator and it emulates many non PC
1454 machines. Most of the options are similar to the PC emulator. The
1455 differences are mentionned in the following sections.
1458 * QEMU PowerPC System emulator::
1459 * Sparc32 System emulator invocation::
1460 * Sparc64 System emulator invocation::
1461 * MIPS System emulator invocation::
1462 * ARM System emulator invocation::
1465 @node QEMU PowerPC System emulator
1466 @section QEMU PowerPC System emulator
1468 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1469 or PowerMac PowerPC system.
1471 QEMU emulates the following PowerMac peripherals:
1477 PCI VGA compatible card with VESA Bochs Extensions
1479 2 PMAC IDE interfaces with hard disk and CD-ROM support
1485 VIA-CUDA with ADB keyboard and mouse.
1488 QEMU emulates the following PREP peripherals:
1494 PCI VGA compatible card with VESA Bochs Extensions
1496 2 IDE interfaces with hard disk and CD-ROM support
1500 NE2000 network adapters
1504 PREP Non Volatile RAM
1506 PC compatible keyboard and mouse.
1509 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1510 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1512 @c man begin OPTIONS
1514 The following options are specific to the PowerPC emulation:
1518 @item -g WxH[xDEPTH]
1520 Set the initial VGA graphic mode. The default is 800x600x15.
1527 More information is available at
1528 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1530 @node Sparc32 System emulator invocation
1531 @section Sparc32 System emulator invocation
1533 Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
1534 (sun4m architecture). The emulation is somewhat complete.
1536 QEMU emulates the following sun4m peripherals:
1544 Lance (Am7990) Ethernet
1546 Non Volatile RAM M48T08
1548 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1549 and power/reset logic
1551 ESP SCSI controller with hard disk and CD-ROM support
1556 The number of peripherals is fixed in the architecture.
1558 Since version 0.8.2, QEMU uses OpenBIOS
1559 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1560 firmware implementation. The goal is to implement a 100% IEEE
1561 1275-1994 (referred to as Open Firmware) compliant firmware.
1563 A sample Linux 2.6 series kernel and ram disk image are available on
1564 the QEMU web site. Please note that currently NetBSD, OpenBSD or
1565 Solaris kernels don't work.
1567 @c man begin OPTIONS
1569 The following options are specific to the Sparc emulation:
1575 Set the initial TCX graphic mode. The default is 1024x768.
1581 @node Sparc64 System emulator invocation
1582 @section Sparc64 System emulator invocation
1584 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
1585 The emulator is not usable for anything yet.
1587 QEMU emulates the following sun4u peripherals:
1591 UltraSparc IIi APB PCI Bridge
1593 PCI VGA compatible card with VESA Bochs Extensions
1595 Non Volatile RAM M48T59
1597 PC-compatible serial ports
1600 @node MIPS System emulator invocation
1601 @section MIPS System emulator invocation
1603 Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
1604 The emulator is able to boot a Linux kernel and to run a Linux Debian
1605 installation from NFS. The following devices are emulated:
1611 PC style serial port
1616 More information is available in the QEMU mailing-list archive.
1618 @node ARM System emulator invocation
1619 @section ARM System emulator invocation
1621 Use the executable @file{qemu-system-arm} to simulate a ARM
1622 machine. The ARM Integrator/CP board is emulated with the following
1627 ARM926E or ARM1026E CPU
1631 SMC 91c111 Ethernet adapter
1633 PL110 LCD controller
1635 PL050 KMI with PS/2 keyboard and mouse.
1638 The ARM Versatile baseboard is emulated with the following devices:
1644 PL190 Vectored Interrupt Controller
1648 SMC 91c111 Ethernet adapter
1650 PL110 LCD controller
1652 PL050 KMI with PS/2 keyboard and mouse.
1654 PCI host bridge. Note the emulated PCI bridge only provides access to
1655 PCI memory space. It does not provide access to PCI IO space.
1656 This means some devices (eg. ne2k_pci NIC) are not useable, and others
1657 (eg. rtl8139 NIC) are only useable when the guest drivers use the memory
1658 mapped control registers.
1660 PCI OHCI USB controller.
1662 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1665 A Linux 2.6 test image is available on the QEMU web site. More
1666 information is available in the QEMU mailing-list archive.
1668 @node QEMU Linux User space emulator
1669 @chapter QEMU Linux User space emulator
1674 * Command line options::
1679 @section Quick Start
1681 In order to launch a Linux process, QEMU needs the process executable
1682 itself and all the target (x86) dynamic libraries used by it.
1686 @item On x86, you can just try to launch any process by using the native
1690 qemu-i386 -L / /bin/ls
1693 @code{-L /} tells that the x86 dynamic linker must be searched with a
1696 @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):
1699 qemu-i386 -L / qemu-i386 -L / /bin/ls
1702 @item On non x86 CPUs, you need first to download at least an x86 glibc
1703 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1704 @code{LD_LIBRARY_PATH} is not set:
1707 unset LD_LIBRARY_PATH
1710 Then you can launch the precompiled @file{ls} x86 executable:
1713 qemu-i386 tests/i386/ls
1715 You can look at @file{qemu-binfmt-conf.sh} so that
1716 QEMU is automatically launched by the Linux kernel when you try to
1717 launch x86 executables. It requires the @code{binfmt_misc} module in the
1720 @item The x86 version of QEMU is also included. You can try weird things such as:
1722 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
1723 /usr/local/qemu-i386/bin/ls-i386
1729 @section Wine launch
1733 @item Ensure that you have a working QEMU with the x86 glibc
1734 distribution (see previous section). In order to verify it, you must be
1738 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1741 @item Download the binary x86 Wine install
1742 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
1744 @item Configure Wine on your account. Look at the provided script
1745 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
1746 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1748 @item Then you can try the example @file{putty.exe}:
1751 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
1752 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1757 @node Command line options
1758 @section Command line options
1761 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1768 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1770 Set the x86 stack size in bytes (default=524288)
1777 Activate log (logfile=/tmp/qemu.log)
1779 Act as if the host page size was 'pagesize' bytes
1782 @node Other binaries
1783 @section Other binaries
1785 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
1786 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
1787 configurations), and arm-uclinux bFLT format binaries.
1789 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
1790 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
1791 coldfire uClinux bFLT format binaries.
1793 The binary format is detected automatically.
1796 @chapter Compilation from the sources
1801 * Cross compilation for Windows with Linux::
1808 @subsection Compilation
1810 First you must decompress the sources:
1813 tar zxvf qemu-x.y.z.tar.gz
1817 Then you configure QEMU and build it (usually no options are needed):
1823 Then type as root user:
1827 to install QEMU in @file{/usr/local}.
1829 @subsection Tested tool versions
1831 In order to compile QEMU successfully, it is very important that you
1832 have the right tools. The most important one is gcc. I cannot guaranty
1833 that QEMU works if you do not use a tested gcc version. Look at
1834 'configure' and 'Makefile' if you want to make a different gcc
1838 host gcc binutils glibc linux distribution
1839 ----------------------------------------------------------------------
1840 x86 3.2 2.13.2 2.1.3 2.4.18
1841 2.96 2.11.93.0.2 2.2.5 2.4.18 Red Hat 7.3
1842 3.2.2 2.13.90.0.18 2.3.2 2.4.20 Red Hat 9
1844 PowerPC 3.3 [4] 2.13.90.0.18 2.3.1 2.4.20briq
1847 Alpha 3.3 [1] 2.14.90.0.4 2.2.5 2.2.20 [2] Debian 3.0
1849 Sparc32 2.95.4 2.12.90.0.1 2.2.5 2.4.18 Debian 3.0
1851 ARM 2.95.4 2.12.90.0.1 2.2.5 2.4.9 [3] Debian 3.0
1853 [1] On Alpha, QEMU needs the gcc 'visibility' attribute only available
1854 for gcc version >= 3.3.
1855 [2] Linux >= 2.4.20 is necessary for precise exception support
1857 [3] 2.4.9-ac10-rmk2-np1-cerf2
1859 [4] gcc 2.95.x generates invalid code when using too many register
1860 variables. You must use gcc 3.x on PowerPC.
1867 @item Install the current versions of MSYS and MinGW from
1868 @url{http://www.mingw.org/}. You can find detailed installation
1869 instructions in the download section and the FAQ.
1872 the MinGW development library of SDL 1.2.x
1873 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
1874 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
1875 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1876 directory. Edit the @file{sdl-config} script so that it gives the
1877 correct SDL directory when invoked.
1879 @item Extract the current version of QEMU.
1881 @item Start the MSYS shell (file @file{msys.bat}).
1883 @item Change to the QEMU directory. Launch @file{./configure} and
1884 @file{make}. If you have problems using SDL, verify that
1885 @file{sdl-config} can be launched from the MSYS command line.
1887 @item You can install QEMU in @file{Program Files/Qemu} by typing
1888 @file{make install}. Don't forget to copy @file{SDL.dll} in
1889 @file{Program Files/Qemu}.
1893 @node Cross compilation for Windows with Linux
1894 @section Cross compilation for Windows with Linux
1898 Install the MinGW cross compilation tools available at
1899 @url{http://www.mingw.org/}.
1902 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1903 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1904 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1905 the QEMU configuration script.
1908 Configure QEMU for Windows cross compilation:
1910 ./configure --enable-mingw32
1912 If necessary, you can change the cross-prefix according to the prefix
1913 choosen for the MinGW tools with --cross-prefix. You can also use
1914 --prefix to set the Win32 install path.
1916 @item You can install QEMU in the installation directory by typing
1917 @file{make install}. Don't forget to copy @file{SDL.dll} in the
1918 installation directory.
1922 Note: Currently, Wine does not seem able to launch
1928 The Mac OS X patches are not fully merged in QEMU, so you should look
1929 at the QEMU mailing list archive to have all the necessary