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 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. In this mode, QEMU can launch
61 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/Sun4c/Sun4d (32-bit Sparc processor)
78 @item Sun4u (64-bit Sparc processor, in progress)
79 @item Malta board (32-bit and 64-bit MIPS processors)
80 @item ARM Integrator/CP (ARM)
81 @item ARM Versatile baseboard (ARM)
82 @item ARM RealView Emulation baseboard (ARM)
83 @item Spitz, Akita, Borzoi and Terrier PDAs (PXA270 processor)
84 @item Luminary Micro LM3S811EVB (ARM Cortex-M3)
85 @item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
86 @item Freescale MCF5208EVB (ColdFire V2).
87 @item Arnewsh MCF5206 evaluation board (ColdFire V2).
88 @item Palm Tungsten|E PDA (OMAP310 processor)
91 For user emulation, x86, PowerPC, ARM, 32-bit MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
96 If you want to compile QEMU yourself, see @ref{compilation}.
99 * install_linux:: Linux
100 * install_windows:: Windows
101 * install_mac:: Macintosh
107 If a precompiled package is available for your distribution - you just
108 have to install it. Otherwise, see @ref{compilation}.
110 @node install_windows
113 Download the experimental binary installer at
114 @url{http://www.free.oszoo.org/@/download.html}.
119 Download the experimental binary installer at
120 @url{http://www.free.oszoo.org/@/download.html}.
122 @node QEMU PC System emulator
123 @chapter QEMU PC System emulator
126 * pcsys_introduction:: Introduction
127 * pcsys_quickstart:: Quick Start
128 * sec_invocation:: Invocation
130 * pcsys_monitor:: QEMU Monitor
131 * disk_images:: Disk Images
132 * pcsys_network:: Network emulation
133 * direct_linux_boot:: Direct Linux Boot
134 * pcsys_usb:: USB emulation
135 * vnc_security:: VNC security
136 * gdb_usage:: GDB usage
137 * pcsys_os_specific:: Target OS specific information
140 @node pcsys_introduction
141 @section Introduction
143 @c man begin DESCRIPTION
145 The QEMU PC System emulator simulates the
146 following peripherals:
150 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
152 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
153 extensions (hardware level, including all non standard modes).
155 PS/2 mouse and keyboard
157 2 PCI IDE interfaces with hard disk and CD-ROM support
161 PCI/ISA PCI network adapters
165 Creative SoundBlaster 16 sound card
167 ENSONIQ AudioPCI ES1370 sound card
169 Adlib(OPL2) - Yamaha YM3812 compatible chip
171 PCI UHCI USB controller and a virtual USB hub.
174 SMP is supported with up to 255 CPUs.
176 Note that adlib is only available when QEMU was configured with
179 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
182 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
186 @node pcsys_quickstart
189 Download and uncompress the linux image (@file{linux.img}) and type:
195 Linux should boot and give you a prompt.
201 @c man begin SYNOPSIS
202 usage: qemu [options] [@var{disk_image}]
207 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
211 @item -M @var{machine}
212 Select the emulated @var{machine} (@code{-M ?} for list)
214 @item -fda @var{file}
215 @item -fdb @var{file}
216 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
217 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
219 @item -hda @var{file}
220 @item -hdb @var{file}
221 @item -hdc @var{file}
222 @item -hdd @var{file}
223 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
225 @item -cdrom @var{file}
226 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
227 @option{-cdrom} at the same time). You can use the host CD-ROM by
228 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
230 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
232 Define a new drive. Valid options are:
235 @item file=@var{file}
236 This option defines which disk image (@pxref{disk_images}) to use with
238 @item if=@var{interface}
239 This option defines on which type on interface the drive is connected.
240 Available types are: ide, scsi, sd, mtd, floppy, pflash.
241 @item bus=@var{bus},unit=@var{unit}
242 These options define where is connected the drive by defining the bus number and
244 @item index=@var{index}
245 This option defines where is connected the drive by using an index in the list
246 of available connectors of a given interface type.
247 @item media=@var{media}
248 This option defines the type of the media: disk or cdrom.
249 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
250 These options have the same definition as they have in @option{-hdachs}.
251 @item snapshot=@var{snapshot}
252 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
253 @item cache=@var{cache}
254 @var{cache} is "on" or "off" and allows to disable host cache to access data.
257 Instead of @option{-cdrom} you can use:
259 qemu -drive file=file,index=2,media=cdrom
262 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
265 qemu -drive file=file,index=0,media=disk
266 qemu -drive file=file,index=1,media=disk
267 qemu -drive file=file,index=2,media=disk
268 qemu -drive file=file,index=3,media=disk
271 You can connect a CDROM to the slave of ide0:
273 qemu -drive file=file,if=ide,index=1,media=cdrom
276 If you don't specify the "file=" argument, you define an empty drive:
278 qemu -drive if=ide,index=1,media=cdrom
281 You can connect a SCSI disk with unit ID 6 on the bus #0:
283 qemu -drive file=file,if=scsi,bus=0,unit=6
286 Instead of @option{-fda}, @option{-fdb}, you can use:
288 qemu -drive file=file,index=0,if=floppy
289 qemu -drive file=file,index=1,if=floppy
292 By default, @var{interface} is "ide" and @var{index} is automatically
295 qemu -drive file=a -drive file=b"
302 @item -boot [a|c|d|n]
303 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
307 Write to temporary files instead of disk image files. In this case,
308 the raw disk image you use is not written back. You can however force
309 the write back by pressing @key{C-a s} (@pxref{disk_images}).
312 Disable boot signature checking for floppy disks in Bochs BIOS. It may
313 be needed to boot from old floppy disks.
316 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.
319 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
320 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
325 Will show the audio subsystem help: list of drivers, tunable
328 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
330 Enable audio and selected sound hardware. Use ? to print all
331 available sound hardware.
334 qemu -soundhw sb16,adlib hda
335 qemu -soundhw es1370 hda
336 qemu -soundhw all hda
341 Set the real time clock to local time (the default is to UTC
342 time). This option is needed to have correct date in MS-DOS or
345 @item -startdate @var{date}
346 Set the initial date of the real time clock. Valid format for
347 @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
348 @code{2006-06-17}. The default value is @code{now}.
350 @item -pidfile @var{file}
351 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
355 Daemonize the QEMU process after initialization. QEMU will not detach from
356 standard IO until it is ready to receive connections on any of its devices.
357 This option is a useful way for external programs to launch QEMU without having
358 to cope with initialization race conditions.
361 Use it when installing Windows 2000 to avoid a disk full bug. After
362 Windows 2000 is installed, you no longer need this option (this option
363 slows down the IDE transfers).
365 @item -option-rom @var{file}
366 Load the contents of @var{file} as an option ROM.
367 This option is useful to load things like EtherBoot.
369 @item -name @var{name}
370 Sets the @var{name} of the guest.
371 This name will be display in the SDL window caption.
372 The @var{name} will also be used for the VNC server.
381 Normally, QEMU uses SDL to display the VGA output. With this option,
382 you can totally disable graphical output so that QEMU is a simple
383 command line application. The emulated serial port is redirected on
384 the console. Therefore, you can still use QEMU to debug a Linux kernel
385 with a serial console.
389 Do not use decorations for SDL windows and start them using the whole
390 available screen space. This makes the using QEMU in a dedicated desktop
391 workspace more convenient.
394 Start in full screen.
396 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
398 Normally, QEMU uses SDL to display the VGA output. With this option,
399 you can have QEMU listen on VNC display @var{display} and redirect the VGA
400 display over the VNC session. It is very useful to enable the usb
401 tablet device when using this option (option @option{-usbdevice
402 tablet}). When using the VNC display, you must use the @option{-k}
403 parameter to set the keyboard layout if you are not using en-us. Valid
404 syntax for the @var{display} is
408 @item @var{interface}:@var{d}
410 TCP connections will only be allowed from @var{interface} on display @var{d}.
411 By convention the TCP port is 5900+@var{d}. Optionally, @var{interface} can
412 be omitted in which case the server will bind to all interfaces.
414 @item @var{unix}:@var{path}
416 Connections will be allowed over UNIX domain sockets where @var{path} is the
417 location of a unix socket to listen for connections on.
421 VNC is initialized by not started. The monitor @code{change} command can be used
422 to later start the VNC server.
426 Following the @var{display} value there may be one or more @var{option} flags
427 separated by commas. Valid options are
433 Require that password based authentication is used for client connections.
434 The password must be set separately using the @code{change} command in the
439 Require that client use TLS when communicating with the VNC server. This
440 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
441 attack. It is recommended that this option be combined with either the
442 @var{x509} or @var{x509verify} options.
444 @item x509=@var{/path/to/certificate/dir}
446 Valid if @option{tls} is specified. Require that x509 credentials are used
447 for negotiating the TLS session. The server will send its x509 certificate
448 to the client. It is recommended that a password be set on the VNC server
449 to provide authentication of the client when this is used. The path following
450 this option specifies where the x509 certificates are to be loaded from.
451 See the @ref{vnc_security} section for details on generating certificates.
453 @item x509verify=@var{/path/to/certificate/dir}
455 Valid if @option{tls} is specified. Require that x509 credentials are used
456 for negotiating the TLS session. The server will send its x509 certificate
457 to the client, and request that the client send its own x509 certificate.
458 The server will validate the client's certificate against the CA certificate,
459 and reject clients when validation fails. If the certificate authority is
460 trusted, this is a sufficient authentication mechanism. You may still wish
461 to set a password on the VNC server as a second authentication layer. The
462 path following this option specifies where the x509 certificates are to
463 be loaded from. See the @ref{vnc_security} section for details on generating
468 @item -k @var{language}
470 Use keyboard layout @var{language} (for example @code{fr} for
471 French). This option is only needed where it is not easy to get raw PC
472 keycodes (e.g. on Macs, with some X11 servers or with a VNC
473 display). You don't normally need to use it on PC/Linux or PC/Windows
476 The available layouts are:
478 ar de-ch es fo fr-ca hu ja mk no pt-br sv
479 da en-gb et fr fr-ch is lt nl pl ru th
480 de en-us fi fr-be hr it lv nl-be pt sl tr
483 The default is @code{en-us}.
491 Enable the USB driver (will be the default soon)
493 @item -usbdevice @var{devname}
494 Add the USB device @var{devname}. @xref{usb_devices}.
499 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
502 Pointer device that uses absolute coordinates (like a touchscreen). This
503 means qemu is able to report the mouse position without having to grab the
504 mouse. Also overrides the PS/2 mouse emulation when activated.
507 Mass storage device based on file
510 Pass through the host device identified by bus.addr (Linux only).
512 @item host:vendor_id:product_id
513 Pass through the host device identified by vendor_id:product_id (Linux only).
523 @item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
524 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
525 = 0 is the default). The NIC is an ne2k_pci by default on the PC
526 target. Optionally, the MAC address can be changed. If no
527 @option{-net} option is specified, a single NIC is created.
528 Qemu can emulate several different models of network card.
529 Valid values for @var{type} are
530 @code{i82551}, @code{i82557b}, @code{i82559er},
531 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
532 @code{smc91c111}, @code{lance} and @code{mcf_fec}.
533 Not all devices are supported on all targets. Use -net nic,model=?
534 for a list of available devices for your target.
536 @item -net user[,vlan=@var{n}][,hostname=@var{name}]
537 Use the user mode network stack which requires no administrator
538 privilege to run. @option{hostname=name} can be used to specify the client
539 hostname reported by the builtin DHCP server.
541 @item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}]
542 Connect the host TAP network interface @var{name} to VLAN @var{n} and
543 use the network script @var{file} to configure it. The default
544 network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
545 disable script execution. If @var{name} is not
546 provided, the OS automatically provides one. @option{fd}=@var{h} can be
547 used to specify the handle of an already opened host TAP interface. Example:
550 qemu linux.img -net nic -net tap
553 More complicated example (two NICs, each one connected to a TAP device)
555 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
556 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
560 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
562 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
563 machine using a TCP socket connection. If @option{listen} is
564 specified, QEMU waits for incoming connections on @var{port}
565 (@var{host} is optional). @option{connect} is used to connect to
566 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
567 specifies an already opened TCP socket.
571 # launch a first QEMU instance
572 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
573 -net socket,listen=:1234
574 # connect the VLAN 0 of this instance to the VLAN 0
575 # of the first instance
576 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
577 -net socket,connect=127.0.0.1:1234
580 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
582 Create a VLAN @var{n} shared with another QEMU virtual
583 machines using a UDP multicast socket, effectively making a bus for
584 every QEMU with same multicast address @var{maddr} and @var{port}.
588 Several QEMU can be running on different hosts and share same bus (assuming
589 correct multicast setup for these hosts).
591 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
592 @url{http://user-mode-linux.sf.net}.
594 Use @option{fd=h} to specify an already opened UDP multicast socket.
599 # launch one QEMU instance
600 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
601 -net socket,mcast=230.0.0.1:1234
602 # launch another QEMU instance on same "bus"
603 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
604 -net socket,mcast=230.0.0.1:1234
605 # launch yet another QEMU instance on same "bus"
606 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
607 -net socket,mcast=230.0.0.1:1234
610 Example (User Mode Linux compat.):
612 # launch QEMU instance (note mcast address selected
614 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
615 -net socket,mcast=239.192.168.1:1102
617 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
621 Indicate that no network devices should be configured. It is used to
622 override the default configuration (@option{-net nic -net user}) which
623 is activated if no @option{-net} options are provided.
625 @item -tftp @var{dir}
626 When using the user mode network stack, activate a built-in TFTP
627 server. The files in @var{dir} will be exposed as the root of a TFTP server.
628 The TFTP client on the guest must be configured in binary mode (use the command
629 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
632 @item -bootp @var{file}
633 When using the user mode network stack, broadcast @var{file} as the BOOTP
634 filename. In conjunction with @option{-tftp}, this can be used to network boot
635 a guest from a local directory.
637 Example (using pxelinux):
639 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
643 When using the user mode network stack, activate a built-in SMB
644 server so that Windows OSes can access to the host files in @file{@var{dir}}
647 In the guest Windows OS, the line:
651 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
652 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
654 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
656 Note that a SAMBA server must be installed on the host OS in
657 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
658 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
660 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
662 When using the user mode network stack, redirect incoming TCP or UDP
663 connections to the host port @var{host-port} to the guest
664 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
665 is not specified, its value is 10.0.2.15 (default address given by the
666 built-in DHCP server).
668 For example, to redirect host X11 connection from screen 1 to guest
669 screen 0, use the following:
673 qemu -redir tcp:6001::6000 [...]
674 # this host xterm should open in the guest X11 server
678 To redirect telnet connections from host port 5555 to telnet port on
679 the guest, use the following:
683 qemu -redir tcp:5555::23 [...]
684 telnet localhost 5555
687 Then when you use on the host @code{telnet localhost 5555}, you
688 connect to the guest telnet server.
692 Linux boot specific: When using these options, you can use a given
693 Linux kernel without installing it in the disk image. It can be useful
694 for easier testing of various kernels.
698 @item -kernel @var{bzImage}
699 Use @var{bzImage} as kernel image.
701 @item -append @var{cmdline}
702 Use @var{cmdline} as kernel command line
704 @item -initrd @var{file}
705 Use @var{file} as initial ram disk.
709 Debug/Expert options:
712 @item -serial @var{dev}
713 Redirect the virtual serial port to host character device
714 @var{dev}. The default device is @code{vc} in graphical mode and
715 @code{stdio} in non graphical mode.
717 This option can be used several times to simulate up to 4 serials
720 Use @code{-serial none} to disable all serial ports.
722 Available character devices are:
725 Virtual console. Optionally, a width and height can be given in pixel with
729 It is also possible to specify width or height in characters:
734 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
736 No device is allocated.
740 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
741 parameters are set according to the emulated ones.
742 @item /dev/parport@var{N}
743 [Linux only, parallel port only] Use host parallel port
744 @var{N}. Currently SPP and EPP parallel port features can be used.
745 @item file:@var{filename}
746 Write output to @var{filename}. No character can be read.
748 [Unix only] standard input/output
749 @item pipe:@var{filename}
750 name pipe @var{filename}
752 [Windows only] Use host serial port @var{n}
753 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
754 This implements UDP Net Console.
755 When @var{remote_host} or @var{src_ip} are not specified
756 they default to @code{0.0.0.0}.
757 When not using a specified @var{src_port} a random port is automatically chosen.
759 If you just want a simple readonly console you can use @code{netcat} or
760 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
761 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
762 will appear in the netconsole session.
764 If you plan to send characters back via netconsole or you want to stop
765 and start qemu a lot of times, you should have qemu use the same
766 source port each time by using something like @code{-serial
767 udp::4555@@:4556} to qemu. Another approach is to use a patched
768 version of netcat which can listen to a TCP port and send and receive
769 characters via udp. If you have a patched version of netcat which
770 activates telnet remote echo and single char transfer, then you can
771 use the following options to step up a netcat redirector to allow
772 telnet on port 5555 to access the qemu port.
775 -serial udp::4555@@:4556
776 @item netcat options:
777 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
778 @item telnet options:
783 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
784 The TCP Net Console has two modes of operation. It can send the serial
785 I/O to a location or wait for a connection from a location. By default
786 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
787 the @var{server} option QEMU will wait for a client socket application
788 to connect to the port before continuing, unless the @code{nowait}
789 option was specified. The @code{nodelay} option disables the Nagle buffering
790 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
791 one TCP connection at a time is accepted. You can use @code{telnet} to
792 connect to the corresponding character device.
794 @item Example to send tcp console to 192.168.0.2 port 4444
795 -serial tcp:192.168.0.2:4444
796 @item Example to listen and wait on port 4444 for connection
797 -serial tcp::4444,server
798 @item Example to not wait and listen on ip 192.168.0.100 port 4444
799 -serial tcp:192.168.0.100:4444,server,nowait
802 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
803 The telnet protocol is used instead of raw tcp sockets. The options
804 work the same as if you had specified @code{-serial tcp}. The
805 difference is that the port acts like a telnet server or client using
806 telnet option negotiation. This will also allow you to send the
807 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
808 sequence. Typically in unix telnet you do it with Control-] and then
809 type "send break" followed by pressing the enter key.
811 @item unix:@var{path}[,server][,nowait]
812 A unix domain socket is used instead of a tcp socket. The option works the
813 same as if you had specified @code{-serial tcp} except the unix domain socket
814 @var{path} is used for connections.
816 @item mon:@var{dev_string}
817 This is a special option to allow the monitor to be multiplexed onto
818 another serial port. The monitor is accessed with key sequence of
819 @key{Control-a} and then pressing @key{c}. See monitor access
820 @ref{pcsys_keys} in the -nographic section for more keys.
821 @var{dev_string} should be any one of the serial devices specified
822 above. An example to multiplex the monitor onto a telnet server
823 listening on port 4444 would be:
825 @item -serial mon:telnet::4444,server,nowait
830 @item -parallel @var{dev}
831 Redirect the virtual parallel port to host device @var{dev} (same
832 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
833 be used to use hardware devices connected on the corresponding host
836 This option can be used several times to simulate up to 3 parallel
839 Use @code{-parallel none} to disable all parallel ports.
841 @item -monitor @var{dev}
842 Redirect the monitor to host device @var{dev} (same devices as the
844 The default device is @code{vc} in graphical mode and @code{stdio} in
847 @item -echr numeric_ascii_value
848 Change the escape character used for switching to the monitor when using
849 monitor and serial sharing. The default is @code{0x01} when using the
850 @code{-nographic} option. @code{0x01} is equal to pressing
851 @code{Control-a}. You can select a different character from the ascii
852 control keys where 1 through 26 map to Control-a through Control-z. For
853 instance you could use the either of the following to change the escape
854 character to Control-t.
861 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
863 Change gdb connection port. @var{port} can be either a decimal number
864 to specify a TCP port, or a host device (same devices as the serial port).
866 Do not start CPU at startup (you must type 'c' in the monitor).
868 Output log in /tmp/qemu.log
869 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
870 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
871 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
872 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
873 all those parameters. This option is useful for old MS-DOS disk
877 Set the directory for the BIOS, VGA BIOS and keymaps.
880 Simulate a standard VGA card with Bochs VBE extensions (default is
881 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
882 VBE extensions (e.g. Windows XP) and if you want to use high
883 resolution modes (>= 1280x1024x16) then you should use this option.
886 Disable ACPI (Advanced Configuration and Power Interface) support. Use
887 it if your guest OS complains about ACPI problems (PC target machine
891 Exit instead of rebooting.
894 Start right away with a saved state (@code{loadvm} in monitor)
897 Enable semihosting syscall emulation (ARM and M68K target machines only).
899 On ARM this implements the "Angel" interface.
900 On M68K this implements the "ColdFire GDB" interface used by libgloss.
902 Note that this allows guest direct access to the host filesystem,
903 so should only be used with trusted guest OS.
913 During the graphical emulation, you can use the following keys:
919 Switch to virtual console 'n'. Standard console mappings are:
922 Target system display
930 Toggle mouse and keyboard grab.
933 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
934 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
936 During emulation, if you are using the @option{-nographic} option, use
937 @key{Ctrl-a h} to get terminal commands:
945 Save disk data back to file (if -snapshot)
947 toggle console timestamps
949 Send break (magic sysrq in Linux)
951 Switch between console and monitor
960 The HTML documentation of QEMU for more precise information and Linux
961 user mode emulator invocation.
971 @section QEMU Monitor
973 The QEMU monitor is used to give complex commands to the QEMU
974 emulator. You can use it to:
979 Remove or insert removable media images
980 (such as CD-ROM or floppies).
983 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
986 @item Inspect the VM state without an external debugger.
992 The following commands are available:
996 @item help or ? [@var{cmd}]
997 Show the help for all commands or just for command @var{cmd}.
1000 Commit changes to the disk images (if -snapshot is used).
1002 @item info @var{subcommand}
1003 Show various information about the system state.
1007 show the various VLANs and the associated devices
1009 show the block devices
1010 @item info registers
1011 show the cpu registers
1013 show the command line history
1015 show emulated PCI device
1017 show USB devices plugged on the virtual USB hub
1019 show all USB host devices
1021 show information about active capturing
1022 @item info snapshots
1023 show list of VM snapshots
1025 show which guest mouse is receiving events
1031 @item eject [-f] @var{device}
1032 Eject a removable medium (use -f to force it).
1034 @item change @var{device} @var{setting}
1036 Change the configuration of a device.
1039 @item change @var{diskdevice} @var{filename}
1040 Change the medium for a removable disk device to point to @var{filename}. eg
1043 (qemu) change cdrom /path/to/some.iso
1046 @item change vnc @var{display},@var{options}
1047 Change the configuration of the VNC server. The valid syntax for @var{display}
1048 and @var{options} are described at @ref{sec_invocation}. eg
1051 (qemu) change vnc localhost:1
1054 @item change vnc password
1056 Change the password associated with the VNC server. The monitor will prompt for
1057 the new password to be entered. VNC passwords are only significant upto 8 letters.
1061 (qemu) change vnc password
1067 @item screendump @var{filename}
1068 Save screen into PPM image @var{filename}.
1070 @item mouse_move @var{dx} @var{dy} [@var{dz}]
1071 Move the active mouse to the specified coordinates @var{dx} @var{dy}
1072 with optional scroll axis @var{dz}.
1074 @item mouse_button @var{val}
1075 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
1077 @item mouse_set @var{index}
1078 Set which mouse device receives events at given @var{index}, index
1079 can be obtained with
1084 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
1085 Capture audio into @var{filename}. Using sample rate @var{frequency}
1086 bits per sample @var{bits} and number of channels @var{channels}.
1090 @item Sample rate = 44100 Hz - CD quality
1092 @item Number of channels = 2 - Stereo
1095 @item stopcapture @var{index}
1096 Stop capture with a given @var{index}, index can be obtained with
1101 @item log @var{item1}[,...]
1102 Activate logging of the specified items to @file{/tmp/qemu.log}.
1104 @item savevm [@var{tag}|@var{id}]
1105 Create a snapshot of the whole virtual machine. If @var{tag} is
1106 provided, it is used as human readable identifier. If there is already
1107 a snapshot with the same tag or ID, it is replaced. More info at
1110 @item loadvm @var{tag}|@var{id}
1111 Set the whole virtual machine to the snapshot identified by the tag
1112 @var{tag} or the unique snapshot ID @var{id}.
1114 @item delvm @var{tag}|@var{id}
1115 Delete the snapshot identified by @var{tag} or @var{id}.
1123 @item gdbserver [@var{port}]
1124 Start gdbserver session (default @var{port}=1234)
1126 @item x/fmt @var{addr}
1127 Virtual memory dump starting at @var{addr}.
1129 @item xp /@var{fmt} @var{addr}
1130 Physical memory dump starting at @var{addr}.
1132 @var{fmt} is a format which tells the command how to format the
1133 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1137 is the number of items to be dumped.
1140 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
1141 c (char) or i (asm instruction).
1144 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1145 @code{h} or @code{w} can be specified with the @code{i} format to
1146 respectively select 16 or 32 bit code instruction size.
1153 Dump 10 instructions at the current instruction pointer:
1158 0x90107065: lea 0x0(%esi,1),%esi
1159 0x90107069: lea 0x0(%edi,1),%edi
1161 0x90107071: jmp 0x90107080
1169 Dump 80 16 bit values at the start of the video memory.
1171 (qemu) xp/80hx 0xb8000
1172 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
1173 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
1174 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
1175 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
1176 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
1177 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
1178 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1179 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1180 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1181 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1185 @item p or print/@var{fmt} @var{expr}
1187 Print expression value. Only the @var{format} part of @var{fmt} is
1190 @item sendkey @var{keys}
1192 Send @var{keys} to the emulator. Use @code{-} to press several keys
1193 simultaneously. Example:
1198 This command is useful to send keys that your graphical user interface
1199 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1205 @item usb_add @var{devname}
1207 Add the USB device @var{devname}. For details of available devices see
1210 @item usb_del @var{devname}
1212 Remove the USB device @var{devname} from the QEMU virtual USB
1213 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1214 command @code{info usb} to see the devices you can remove.
1218 @subsection Integer expressions
1220 The monitor understands integers expressions for every integer
1221 argument. You can use register names to get the value of specifics
1222 CPU registers by prefixing them with @emph{$}.
1225 @section Disk Images
1227 Since version 0.6.1, QEMU supports many disk image formats, including
1228 growable disk images (their size increase as non empty sectors are
1229 written), compressed and encrypted disk images. Version 0.8.3 added
1230 the new qcow2 disk image format which is essential to support VM
1234 * disk_images_quickstart:: Quick start for disk image creation
1235 * disk_images_snapshot_mode:: Snapshot mode
1236 * vm_snapshots:: VM snapshots
1237 * qemu_img_invocation:: qemu-img Invocation
1238 * host_drives:: Using host drives
1239 * disk_images_fat_images:: Virtual FAT disk images
1242 @node disk_images_quickstart
1243 @subsection Quick start for disk image creation
1245 You can create a disk image with the command:
1247 qemu-img create myimage.img mysize
1249 where @var{myimage.img} is the disk image filename and @var{mysize} is its
1250 size in kilobytes. You can add an @code{M} suffix to give the size in
1251 megabytes and a @code{G} suffix for gigabytes.
1253 See @ref{qemu_img_invocation} for more information.
1255 @node disk_images_snapshot_mode
1256 @subsection Snapshot mode
1258 If you use the option @option{-snapshot}, all disk images are
1259 considered as read only. When sectors in written, they are written in
1260 a temporary file created in @file{/tmp}. You can however force the
1261 write back to the raw disk images by using the @code{commit} monitor
1262 command (or @key{C-a s} in the serial console).
1265 @subsection VM snapshots
1267 VM snapshots are snapshots of the complete virtual machine including
1268 CPU state, RAM, device state and the content of all the writable
1269 disks. In order to use VM snapshots, you must have at least one non
1270 removable and writable block device using the @code{qcow2} disk image
1271 format. Normally this device is the first virtual hard drive.
1273 Use the monitor command @code{savevm} to create a new VM snapshot or
1274 replace an existing one. A human readable name can be assigned to each
1275 snapshot in addition to its numerical ID.
1277 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1278 a VM snapshot. @code{info snapshots} lists the available snapshots
1279 with their associated information:
1282 (qemu) info snapshots
1283 Snapshot devices: hda
1284 Snapshot list (from hda):
1285 ID TAG VM SIZE DATE VM CLOCK
1286 1 start 41M 2006-08-06 12:38:02 00:00:14.954
1287 2 40M 2006-08-06 12:43:29 00:00:18.633
1288 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
1291 A VM snapshot is made of a VM state info (its size is shown in
1292 @code{info snapshots}) and a snapshot of every writable disk image.
1293 The VM state info is stored in the first @code{qcow2} non removable
1294 and writable block device. The disk image snapshots are stored in
1295 every disk image. The size of a snapshot in a disk image is difficult
1296 to evaluate and is not shown by @code{info snapshots} because the
1297 associated disk sectors are shared among all the snapshots to save
1298 disk space (otherwise each snapshot would need a full copy of all the
1301 When using the (unrelated) @code{-snapshot} option
1302 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1303 but they are deleted as soon as you exit QEMU.
1305 VM snapshots currently have the following known limitations:
1308 They cannot cope with removable devices if they are removed or
1309 inserted after a snapshot is done.
1311 A few device drivers still have incomplete snapshot support so their
1312 state is not saved or restored properly (in particular USB).
1315 @node qemu_img_invocation
1316 @subsection @code{qemu-img} Invocation
1318 @include qemu-img.texi
1321 @subsection Using host drives
1323 In addition to disk image files, QEMU can directly access host
1324 devices. We describe here the usage for QEMU version >= 0.8.3.
1326 @subsubsection Linux
1328 On Linux, you can directly use the host device filename instead of a
1329 disk image filename provided you have enough privileges to access
1330 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1331 @file{/dev/fd0} for the floppy.
1335 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1336 specific code to detect CDROM insertion or removal. CDROM ejection by
1337 the guest OS is supported. Currently only data CDs are supported.
1339 You can specify a floppy device even if no floppy is loaded. Floppy
1340 removal is currently not detected accurately (if you change floppy
1341 without doing floppy access while the floppy is not loaded, the guest
1342 OS will think that the same floppy is loaded).
1344 Hard disks can be used. Normally you must specify the whole disk
1345 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1346 see it as a partitioned disk. WARNING: unless you know what you do, it
1347 is better to only make READ-ONLY accesses to the hard disk otherwise
1348 you may corrupt your host data (use the @option{-snapshot} command
1349 line option or modify the device permissions accordingly).
1352 @subsubsection Windows
1356 The preferred syntax is the drive letter (e.g. @file{d:}). The
1357 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1358 supported as an alias to the first CDROM drive.
1360 Currently there is no specific code to handle removable media, so it
1361 is better to use the @code{change} or @code{eject} monitor commands to
1362 change or eject media.
1364 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1365 where @var{N} is the drive number (0 is the first hard disk).
1367 WARNING: unless you know what you do, it is better to only make
1368 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1369 host data (use the @option{-snapshot} command line so that the
1370 modifications are written in a temporary file).
1374 @subsubsection Mac OS X
1376 @file{/dev/cdrom} is an alias to the first CDROM.
1378 Currently there is no specific code to handle removable media, so it
1379 is better to use the @code{change} or @code{eject} monitor commands to
1380 change or eject media.
1382 @node disk_images_fat_images
1383 @subsection Virtual FAT disk images
1385 QEMU can automatically create a virtual FAT disk image from a
1386 directory tree. In order to use it, just type:
1389 qemu linux.img -hdb fat:/my_directory
1392 Then you access access to all the files in the @file{/my_directory}
1393 directory without having to copy them in a disk image or to export
1394 them via SAMBA or NFS. The default access is @emph{read-only}.
1396 Floppies can be emulated with the @code{:floppy:} option:
1399 qemu linux.img -fda fat:floppy:/my_directory
1402 A read/write support is available for testing (beta stage) with the
1406 qemu linux.img -fda fat:floppy:rw:/my_directory
1409 What you should @emph{never} do:
1411 @item use non-ASCII filenames ;
1412 @item use "-snapshot" together with ":rw:" ;
1413 @item expect it to work when loadvm'ing ;
1414 @item write to the FAT directory on the host system while accessing it with the guest system.
1418 @section Network emulation
1420 QEMU can simulate several network cards (PCI or ISA cards on the PC
1421 target) and can connect them to an arbitrary number of Virtual Local
1422 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1423 VLAN. VLAN can be connected between separate instances of QEMU to
1424 simulate large networks. For simpler usage, a non privileged user mode
1425 network stack can replace the TAP device to have a basic network
1430 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1431 connection between several network devices. These devices can be for
1432 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1435 @subsection Using TAP network interfaces
1437 This is the standard way to connect QEMU to a real network. QEMU adds
1438 a virtual network device on your host (called @code{tapN}), and you
1439 can then configure it as if it was a real ethernet card.
1441 @subsubsection Linux host
1443 As an example, you can download the @file{linux-test-xxx.tar.gz}
1444 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1445 configure properly @code{sudo} so that the command @code{ifconfig}
1446 contained in @file{qemu-ifup} can be executed as root. You must verify
1447 that your host kernel supports the TAP network interfaces: the
1448 device @file{/dev/net/tun} must be present.
1450 See @ref{sec_invocation} to have examples of command lines using the
1451 TAP network interfaces.
1453 @subsubsection Windows host
1455 There is a virtual ethernet driver for Windows 2000/XP systems, called
1456 TAP-Win32. But it is not included in standard QEMU for Windows,
1457 so you will need to get it separately. It is part of OpenVPN package,
1458 so download OpenVPN from : @url{http://openvpn.net/}.
1460 @subsection Using the user mode network stack
1462 By using the option @option{-net user} (default configuration if no
1463 @option{-net} option is specified), QEMU uses a completely user mode
1464 network stack (you don't need root privilege to use the virtual
1465 network). The virtual network configuration is the following:
1469 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1472 ----> DNS server (10.0.2.3)
1474 ----> SMB server (10.0.2.4)
1477 The QEMU VM behaves as if it was behind a firewall which blocks all
1478 incoming connections. You can use a DHCP client to automatically
1479 configure the network in the QEMU VM. The DHCP server assign addresses
1480 to the hosts starting from 10.0.2.15.
1482 In order to check that the user mode network is working, you can ping
1483 the address 10.0.2.2 and verify that you got an address in the range
1484 10.0.2.x from the QEMU virtual DHCP server.
1486 Note that @code{ping} is not supported reliably to the internet as it
1487 would require root privileges. It means you can only ping the local
1490 When using the built-in TFTP server, the router is also the TFTP
1493 When using the @option{-redir} option, TCP or UDP connections can be
1494 redirected from the host to the guest. It allows for example to
1495 redirect X11, telnet or SSH connections.
1497 @subsection Connecting VLANs between QEMU instances
1499 Using the @option{-net socket} option, it is possible to make VLANs
1500 that span several QEMU instances. See @ref{sec_invocation} to have a
1503 @node direct_linux_boot
1504 @section Direct Linux Boot
1506 This section explains how to launch a Linux kernel inside QEMU without
1507 having to make a full bootable image. It is very useful for fast Linux
1512 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1515 Use @option{-kernel} to provide the Linux kernel image and
1516 @option{-append} to give the kernel command line arguments. The
1517 @option{-initrd} option can be used to provide an INITRD image.
1519 When using the direct Linux boot, a disk image for the first hard disk
1520 @file{hda} is required because its boot sector is used to launch the
1523 If you do not need graphical output, you can disable it and redirect
1524 the virtual serial port and the QEMU monitor to the console with the
1525 @option{-nographic} option. The typical command line is:
1527 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1528 -append "root=/dev/hda console=ttyS0" -nographic
1531 Use @key{Ctrl-a c} to switch between the serial console and the
1532 monitor (@pxref{pcsys_keys}).
1535 @section USB emulation
1537 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1538 virtual USB devices or real host USB devices (experimental, works only
1539 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1540 as necessary to connect multiple USB devices.
1544 * host_usb_devices::
1547 @subsection Connecting USB devices
1549 USB devices can be connected with the @option{-usbdevice} commandline option
1550 or the @code{usb_add} monitor command. Available devices are:
1554 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1556 Pointer device that uses absolute coordinates (like a touchscreen).
1557 This means qemu is able to report the mouse position without having
1558 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1559 @item @code{disk:@var{file}}
1560 Mass storage device based on @var{file} (@pxref{disk_images})
1561 @item @code{host:@var{bus.addr}}
1562 Pass through the host device identified by @var{bus.addr}
1564 @item @code{host:@var{vendor_id:product_id}}
1565 Pass through the host device identified by @var{vendor_id:product_id}
1567 @item @code{wacom-tablet}
1568 Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet}
1569 above but it can be used with the tslib library because in addition to touch
1570 coordinates it reports touch pressure.
1571 @item @code{keyboard}
1572 Standard USB keyboard. Will override the PS/2 keyboard (if present).
1575 @node host_usb_devices
1576 @subsection Using host USB devices on a Linux host
1578 WARNING: this is an experimental feature. QEMU will slow down when
1579 using it. USB devices requiring real time streaming (i.e. USB Video
1580 Cameras) are not supported yet.
1583 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1584 is actually using the USB device. A simple way to do that is simply to
1585 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1586 to @file{mydriver.o.disabled}.
1588 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1594 @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:
1596 chown -R myuid /proc/bus/usb
1599 @item Launch QEMU and do in the monitor:
1602 Device 1.2, speed 480 Mb/s
1603 Class 00: USB device 1234:5678, USB DISK
1605 You should see the list of the devices you can use (Never try to use
1606 hubs, it won't work).
1608 @item Add the device in QEMU by using:
1610 usb_add host:1234:5678
1613 Normally the guest OS should report that a new USB device is
1614 plugged. You can use the option @option{-usbdevice} to do the same.
1616 @item Now you can try to use the host USB device in QEMU.
1620 When relaunching QEMU, you may have to unplug and plug again the USB
1621 device to make it work again (this is a bug).
1624 @section VNC security
1626 The VNC server capability provides access to the graphical console
1627 of the guest VM across the network. This has a number of security
1628 considerations depending on the deployment scenarios.
1632 * vnc_sec_password::
1633 * vnc_sec_certificate::
1634 * vnc_sec_certificate_verify::
1635 * vnc_sec_certificate_pw::
1636 * vnc_generate_cert::
1639 @subsection Without passwords
1641 The simplest VNC server setup does not include any form of authentication.
1642 For this setup it is recommended to restrict it to listen on a UNIX domain
1643 socket only. For example
1646 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1649 This ensures that only users on local box with read/write access to that
1650 path can access the VNC server. To securely access the VNC server from a
1651 remote machine, a combination of netcat+ssh can be used to provide a secure
1654 @node vnc_sec_password
1655 @subsection With passwords
1657 The VNC protocol has limited support for password based authentication. Since
1658 the protocol limits passwords to 8 characters it should not be considered
1659 to provide high security. The password can be fairly easily brute-forced by
1660 a client making repeat connections. For this reason, a VNC server using password
1661 authentication should be restricted to only listen on the loopback interface
1662 or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
1663 option, and then once QEMU is running the password is set with the monitor. Until
1664 the monitor is used to set the password all clients will be rejected.
1667 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1668 (qemu) change vnc password
1673 @node vnc_sec_certificate
1674 @subsection With x509 certificates
1676 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1677 TLS for encryption of the session, and x509 certificates for authentication.
1678 The use of x509 certificates is strongly recommended, because TLS on its
1679 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1680 support provides a secure session, but no authentication. This allows any
1681 client to connect, and provides an encrypted session.
1684 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1687 In the above example @code{/etc/pki/qemu} should contain at least three files,
1688 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1689 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1690 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1691 only be readable by the user owning it.
1693 @node vnc_sec_certificate_verify
1694 @subsection With x509 certificates and client verification
1696 Certificates can also provide a means to authenticate the client connecting.
1697 The server will request that the client provide a certificate, which it will
1698 then validate against the CA certificate. This is a good choice if deploying
1699 in an environment with a private internal certificate authority.
1702 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1706 @node vnc_sec_certificate_pw
1707 @subsection With x509 certificates, client verification and passwords
1709 Finally, the previous method can be combined with VNC password authentication
1710 to provide two layers of authentication for clients.
1713 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1714 (qemu) change vnc password
1719 @node vnc_generate_cert
1720 @subsection Generating certificates for VNC
1722 The GNU TLS packages provides a command called @code{certtool} which can
1723 be used to generate certificates and keys in PEM format. At a minimum it
1724 is neccessary to setup a certificate authority, and issue certificates to
1725 each server. If using certificates for authentication, then each client
1726 will also need to be issued a certificate. The recommendation is for the
1727 server to keep its certificates in either @code{/etc/pki/qemu} or for
1728 unprivileged users in @code{$HOME/.pki/qemu}.
1732 * vnc_generate_server::
1733 * vnc_generate_client::
1735 @node vnc_generate_ca
1736 @subsubsection Setup the Certificate Authority
1738 This step only needs to be performed once per organization / organizational
1739 unit. First the CA needs a private key. This key must be kept VERY secret
1740 and secure. If this key is compromised the entire trust chain of the certificates
1741 issued with it is lost.
1744 # certtool --generate-privkey > ca-key.pem
1747 A CA needs to have a public certificate. For simplicity it can be a self-signed
1748 certificate, or one issue by a commercial certificate issuing authority. To
1749 generate a self-signed certificate requires one core piece of information, the
1750 name of the organization.
1753 # cat > ca.info <<EOF
1754 cn = Name of your organization
1758 # certtool --generate-self-signed \
1759 --load-privkey ca-key.pem
1760 --template ca.info \
1761 --outfile ca-cert.pem
1764 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1765 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1767 @node vnc_generate_server
1768 @subsubsection Issuing server certificates
1770 Each server (or host) needs to be issued with a key and certificate. When connecting
1771 the certificate is sent to the client which validates it against the CA certificate.
1772 The core piece of information for a server certificate is the hostname. This should
1773 be the fully qualified hostname that the client will connect with, since the client
1774 will typically also verify the hostname in the certificate. On the host holding the
1775 secure CA private key:
1778 # cat > server.info <<EOF
1779 organization = Name of your organization
1780 cn = server.foo.example.com
1785 # certtool --generate-privkey > server-key.pem
1786 # certtool --generate-certificate \
1787 --load-ca-certificate ca-cert.pem \
1788 --load-ca-privkey ca-key.pem \
1789 --load-privkey server server-key.pem \
1790 --template server.info \
1791 --outfile server-cert.pem
1794 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1795 to the server for which they were generated. The @code{server-key.pem} is security
1796 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1798 @node vnc_generate_client
1799 @subsubsection Issuing client certificates
1801 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1802 certificates as its authentication mechanism, each client also needs to be issued
1803 a certificate. The client certificate contains enough metadata to uniquely identify
1804 the client, typically organization, state, city, building, etc. On the host holding
1805 the secure CA private key:
1808 # cat > client.info <<EOF
1812 organiazation = Name of your organization
1813 cn = client.foo.example.com
1818 # certtool --generate-privkey > client-key.pem
1819 # certtool --generate-certificate \
1820 --load-ca-certificate ca-cert.pem \
1821 --load-ca-privkey ca-key.pem \
1822 --load-privkey client-key.pem \
1823 --template client.info \
1824 --outfile client-cert.pem
1827 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1828 copied to the client for which they were generated.
1833 QEMU has a primitive support to work with gdb, so that you can do
1834 'Ctrl-C' while the virtual machine is running and inspect its state.
1836 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1839 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1840 -append "root=/dev/hda"
1841 Connected to host network interface: tun0
1842 Waiting gdb connection on port 1234
1845 Then launch gdb on the 'vmlinux' executable:
1850 In gdb, connect to QEMU:
1852 (gdb) target remote localhost:1234
1855 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1860 Here are some useful tips in order to use gdb on system code:
1864 Use @code{info reg} to display all the CPU registers.
1866 Use @code{x/10i $eip} to display the code at the PC position.
1868 Use @code{set architecture i8086} to dump 16 bit code. Then use
1869 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1872 @node pcsys_os_specific
1873 @section Target OS specific information
1877 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1878 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1879 color depth in the guest and the host OS.
1881 When using a 2.6 guest Linux kernel, you should add the option
1882 @code{clock=pit} on the kernel command line because the 2.6 Linux
1883 kernels make very strict real time clock checks by default that QEMU
1884 cannot simulate exactly.
1886 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1887 not activated because QEMU is slower with this patch. The QEMU
1888 Accelerator Module is also much slower in this case. Earlier Fedora
1889 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1890 patch by default. Newer kernels don't have it.
1894 If you have a slow host, using Windows 95 is better as it gives the
1895 best speed. Windows 2000 is also a good choice.
1897 @subsubsection SVGA graphic modes support
1899 QEMU emulates a Cirrus Logic GD5446 Video
1900 card. All Windows versions starting from Windows 95 should recognize
1901 and use this graphic card. For optimal performances, use 16 bit color
1902 depth in the guest and the host OS.
1904 If you are using Windows XP as guest OS and if you want to use high
1905 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1906 1280x1024x16), then you should use the VESA VBE virtual graphic card
1907 (option @option{-std-vga}).
1909 @subsubsection CPU usage reduction
1911 Windows 9x does not correctly use the CPU HLT
1912 instruction. The result is that it takes host CPU cycles even when
1913 idle. You can install the utility from
1914 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1915 problem. Note that no such tool is needed for NT, 2000 or XP.
1917 @subsubsection Windows 2000 disk full problem
1919 Windows 2000 has a bug which gives a disk full problem during its
1920 installation. When installing it, use the @option{-win2k-hack} QEMU
1921 option to enable a specific workaround. After Windows 2000 is
1922 installed, you no longer need this option (this option slows down the
1925 @subsubsection Windows 2000 shutdown
1927 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1928 can. It comes from the fact that Windows 2000 does not automatically
1929 use the APM driver provided by the BIOS.
1931 In order to correct that, do the following (thanks to Struan
1932 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1933 Add/Troubleshoot a device => Add a new device & Next => No, select the
1934 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1935 (again) a few times. Now the driver is installed and Windows 2000 now
1936 correctly instructs QEMU to shutdown at the appropriate moment.
1938 @subsubsection Share a directory between Unix and Windows
1940 See @ref{sec_invocation} about the help of the option @option{-smb}.
1942 @subsubsection Windows XP security problem
1944 Some releases of Windows XP install correctly but give a security
1947 A problem is preventing Windows from accurately checking the
1948 license for this computer. Error code: 0x800703e6.
1951 The workaround is to install a service pack for XP after a boot in safe
1952 mode. Then reboot, and the problem should go away. Since there is no
1953 network while in safe mode, its recommended to download the full
1954 installation of SP1 or SP2 and transfer that via an ISO or using the
1955 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1957 @subsection MS-DOS and FreeDOS
1959 @subsubsection CPU usage reduction
1961 DOS does not correctly use the CPU HLT instruction. The result is that
1962 it takes host CPU cycles even when idle. You can install the utility
1963 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1966 @node QEMU System emulator for non PC targets
1967 @chapter QEMU System emulator for non PC targets
1969 QEMU is a generic emulator and it emulates many non PC
1970 machines. Most of the options are similar to the PC emulator. The
1971 differences are mentioned in the following sections.
1974 * QEMU PowerPC System emulator::
1975 * Sparc32 System emulator::
1976 * Sparc64 System emulator::
1977 * MIPS System emulator::
1978 * ARM System emulator::
1979 * ColdFire System emulator::
1982 @node QEMU PowerPC System emulator
1983 @section QEMU PowerPC System emulator
1985 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1986 or PowerMac PowerPC system.
1988 QEMU emulates the following PowerMac peripherals:
1994 PCI VGA compatible card with VESA Bochs Extensions
1996 2 PMAC IDE interfaces with hard disk and CD-ROM support
2002 VIA-CUDA with ADB keyboard and mouse.
2005 QEMU emulates the following PREP peripherals:
2011 PCI VGA compatible card with VESA Bochs Extensions
2013 2 IDE interfaces with hard disk and CD-ROM support
2017 NE2000 network adapters
2021 PREP Non Volatile RAM
2023 PC compatible keyboard and mouse.
2026 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2027 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2029 @c man begin OPTIONS
2031 The following options are specific to the PowerPC emulation:
2035 @item -g WxH[xDEPTH]
2037 Set the initial VGA graphic mode. The default is 800x600x15.
2044 More information is available at
2045 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2047 @node Sparc32 System emulator
2048 @section Sparc32 System emulator
2050 Use the executable @file{qemu-system-sparc} to simulate a SPARCstation
2051 5, SPARCstation 10, SPARCstation 20, SPARCserver 600MP (sun4m
2052 architecture), SPARCstation 2 (sun4c architecture), SPARCserver 1000,
2053 or SPARCcenter 2000 (sun4d architecture). The emulation is somewhat
2054 complete. SMP up to 16 CPUs is supported, but Linux limits the number
2055 of usable CPUs to 4.
2057 QEMU emulates the following sun4m/sun4d peripherals:
2065 Lance (Am7990) Ethernet
2067 Non Volatile RAM M48T08
2069 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2070 and power/reset logic
2072 ESP SCSI controller with hard disk and CD-ROM support
2074 Floppy drive (not on SS-600MP)
2076 CS4231 sound device (only on SS-5, not working yet)
2079 The number of peripherals is fixed in the architecture. Maximum
2080 memory size depends on the machine type, for SS-5 it is 256MB and for
2083 Since version 0.8.2, QEMU uses OpenBIOS
2084 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2085 firmware implementation. The goal is to implement a 100% IEEE
2086 1275-1994 (referred to as Open Firmware) compliant firmware.
2088 A sample Linux 2.6 series kernel and ram disk image are available on
2089 the QEMU web site. Please note that currently NetBSD, OpenBSD or
2090 Solaris kernels don't work.
2092 @c man begin OPTIONS
2094 The following options are specific to the Sparc32 emulation:
2098 @item -g WxHx[xDEPTH]
2100 Set the initial TCX graphic mode. The default is 1024x768x8, currently
2101 the only other possible mode is 1024x768x24.
2103 @item -prom-env string
2105 Set OpenBIOS variables in NVRAM, for example:
2108 qemu-system-sparc -prom-env 'auto-boot?=false' \
2109 -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2112 @item -M [SS-5|SS-10|SS-20|SS-600MP|SS-2|SS-1000|SS-2000]
2114 Set the emulated machine type. Default is SS-5.
2120 @node Sparc64 System emulator
2121 @section Sparc64 System emulator
2123 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
2124 The emulator is not usable for anything yet.
2126 QEMU emulates the following sun4u peripherals:
2130 UltraSparc IIi APB PCI Bridge
2132 PCI VGA compatible card with VESA Bochs Extensions
2134 Non Volatile RAM M48T59
2136 PC-compatible serial ports
2139 @node MIPS System emulator
2140 @section MIPS System emulator
2142 Four executables cover simulation of 32 and 64-bit MIPS systems in
2143 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2144 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2145 Four different machine types are emulated:
2149 A generic ISA PC-like machine "mips"
2151 The MIPS Malta prototype board "malta"
2153 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2155 MIPS emulator pseudo board "mipssim"
2158 The generic emulation is supported by Debian 'Etch' and is able to
2159 install Debian into a virtual disk image. The following devices are
2164 A range of MIPS CPUs, default is the 24Kf
2166 PC style serial port
2173 The Malta emulation supports the following devices:
2177 Core board with MIPS 24Kf CPU and Galileo system controller
2179 PIIX4 PCI/USB/SMbus controller
2181 The Multi-I/O chip's serial device
2183 PCnet32 PCI network card
2185 Malta FPGA serial device
2187 Cirrus VGA graphics card
2190 The ACER Pica emulation supports:
2196 PC-style IRQ and DMA controllers
2203 The mipssim pseudo board emulation provides an environment similiar
2204 to what the proprietary MIPS emulator uses for running Linux.
2209 A range of MIPS CPUs, default is the 24Kf
2211 PC style serial port
2213 MIPSnet network emulation
2216 @node ARM System emulator
2217 @section ARM System emulator
2219 Use the executable @file{qemu-system-arm} to simulate a ARM
2220 machine. The ARM Integrator/CP board is emulated with the following
2225 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2229 SMC 91c111 Ethernet adapter
2231 PL110 LCD controller
2233 PL050 KMI with PS/2 keyboard and mouse.
2235 PL181 MultiMedia Card Interface with SD card.
2238 The ARM Versatile baseboard is emulated with the following devices:
2242 ARM926E, ARM1136 or Cortex-A8 CPU
2244 PL190 Vectored Interrupt Controller
2248 SMC 91c111 Ethernet adapter
2250 PL110 LCD controller
2252 PL050 KMI with PS/2 keyboard and mouse.
2254 PCI host bridge. Note the emulated PCI bridge only provides access to
2255 PCI memory space. It does not provide access to PCI IO space.
2256 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2257 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2258 mapped control registers.
2260 PCI OHCI USB controller.
2262 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2264 PL181 MultiMedia Card Interface with SD card.
2267 The ARM RealView Emulation baseboard is emulated with the following devices:
2271 ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2273 ARM AMBA Generic/Distributed Interrupt Controller
2277 SMC 91c111 Ethernet adapter
2279 PL110 LCD controller
2281 PL050 KMI with PS/2 keyboard and mouse
2285 PCI OHCI USB controller
2287 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2289 PL181 MultiMedia Card Interface with SD card.
2292 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2293 and "Terrier") emulation includes the following peripherals:
2297 Intel PXA270 System-on-chip (ARM V5TE core)
2301 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2303 On-chip OHCI USB controller
2305 On-chip LCD controller
2307 On-chip Real Time Clock
2309 TI ADS7846 touchscreen controller on SSP bus
2311 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2313 GPIO-connected keyboard controller and LEDs
2315 Secure Digital card connected to PXA MMC/SD host
2319 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2322 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2327 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2329 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2331 On-chip LCD controller
2333 On-chip Real Time Clock
2335 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2336 CODEC, connected through MicroWire and I@math{^2}S busses
2338 GPIO-connected matrix keypad
2340 Secure Digital card connected to OMAP MMC/SD host
2345 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2352 64k Flash and 8k SRAM.
2354 Timers, UARTs, ADC and I@math{^2}C interface.
2356 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2359 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2366 256k Flash and 64k SRAM.
2368 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2370 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2373 A Linux 2.6 test image is available on the QEMU web site. More
2374 information is available in the QEMU mailing-list archive.
2376 @node ColdFire System emulator
2377 @section ColdFire System emulator
2379 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2380 The emulator is able to boot a uClinux kernel.
2382 The M5208EVB emulation includes the following devices:
2386 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2388 Three Two on-chip UARTs.
2390 Fast Ethernet Controller (FEC)
2393 The AN5206 emulation includes the following devices:
2397 MCF5206 ColdFire V2 Microprocessor.
2402 @node QEMU User space emulator
2403 @chapter QEMU User space emulator
2406 * Supported Operating Systems ::
2407 * Linux User space emulator::
2408 * Mac OS X/Darwin User space emulator ::
2411 @node Supported Operating Systems
2412 @section Supported Operating Systems
2414 The following OS are supported in user space emulation:
2418 Linux (referred as qemu-linux-user)
2420 Mac OS X/Darwin (referred as qemu-darwin-user)
2423 @node Linux User space emulator
2424 @section Linux User space emulator
2429 * Command line options::
2434 @subsection Quick Start
2436 In order to launch a Linux process, QEMU needs the process executable
2437 itself and all the target (x86) dynamic libraries used by it.
2441 @item On x86, you can just try to launch any process by using the native
2445 qemu-i386 -L / /bin/ls
2448 @code{-L /} tells that the x86 dynamic linker must be searched with a
2451 @item Since QEMU is also a linux process, you can launch qemu with
2452 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2455 qemu-i386 -L / qemu-i386 -L / /bin/ls
2458 @item On non x86 CPUs, you need first to download at least an x86 glibc
2459 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2460 @code{LD_LIBRARY_PATH} is not set:
2463 unset LD_LIBRARY_PATH
2466 Then you can launch the precompiled @file{ls} x86 executable:
2469 qemu-i386 tests/i386/ls
2471 You can look at @file{qemu-binfmt-conf.sh} so that
2472 QEMU is automatically launched by the Linux kernel when you try to
2473 launch x86 executables. It requires the @code{binfmt_misc} module in the
2476 @item The x86 version of QEMU is also included. You can try weird things such as:
2478 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2479 /usr/local/qemu-i386/bin/ls-i386
2485 @subsection Wine launch
2489 @item Ensure that you have a working QEMU with the x86 glibc
2490 distribution (see previous section). In order to verify it, you must be
2494 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2497 @item Download the binary x86 Wine install
2498 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2500 @item Configure Wine on your account. Look at the provided script
2501 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2502 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2504 @item Then you can try the example @file{putty.exe}:
2507 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2508 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2513 @node Command line options
2514 @subsection Command line options
2517 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2524 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2526 Set the x86 stack size in bytes (default=524288)
2533 Activate log (logfile=/tmp/qemu.log)
2535 Act as if the host page size was 'pagesize' bytes
2538 Environment variables:
2542 Print system calls and arguments similar to the 'strace' program
2543 (NOTE: the actual 'strace' program will not work because the user
2544 space emulator hasn't implemented ptrace). At the moment this is
2545 incomplete. All system calls that don't have a specific argument
2546 format are printed with information for six arguments. Many
2547 flag-style arguments don't have decoders and will show up as numbers.
2550 @node Other binaries
2551 @subsection Other binaries
2553 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2554 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2555 configurations), and arm-uclinux bFLT format binaries.
2557 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2558 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2559 coldfire uClinux bFLT format binaries.
2561 The binary format is detected automatically.
2563 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2564 (Sparc64 CPU, 32 bit ABI).
2566 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2567 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2569 @node Mac OS X/Darwin User space emulator
2570 @section Mac OS X/Darwin User space emulator
2573 * Mac OS X/Darwin Status::
2574 * Mac OS X/Darwin Quick Start::
2575 * Mac OS X/Darwin Command line options::
2578 @node Mac OS X/Darwin Status
2579 @subsection Mac OS X/Darwin Status
2583 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2585 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2587 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
2589 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2592 [1] If you're host commpage can be executed by qemu.
2594 @node Mac OS X/Darwin Quick Start
2595 @subsection Quick Start
2597 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2598 itself and all the target dynamic libraries used by it. If you don't have the FAT
2599 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2600 CD or compile them by hand.
2604 @item On x86, you can just try to launch any process by using the native
2611 or to run the ppc version of the executable:
2617 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2621 qemu-i386 -L /opt/x86_root/ /bin/ls
2624 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2625 @file{/opt/x86_root/usr/bin/dyld}.
2629 @node Mac OS X/Darwin Command line options
2630 @subsection Command line options
2633 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2640 Set the library root path (default=/)
2642 Set the stack size in bytes (default=524288)
2649 Activate log (logfile=/tmp/qemu.log)
2651 Act as if the host page size was 'pagesize' bytes
2655 @chapter Compilation from the sources
2660 * Cross compilation for Windows with Linux::
2667 @subsection Compilation
2669 First you must decompress the sources:
2672 tar zxvf qemu-x.y.z.tar.gz
2676 Then you configure QEMU and build it (usually no options are needed):
2682 Then type as root user:
2686 to install QEMU in @file{/usr/local}.
2688 @subsection GCC version
2690 In order to compile QEMU successfully, it is very important that you
2691 have the right tools. The most important one is gcc. On most hosts and
2692 in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2693 Linux distribution includes a gcc 4.x compiler, you can usually
2694 install an older version (it is invoked by @code{gcc32} or
2695 @code{gcc34}). The QEMU configure script automatically probes for
2696 these older versions so that usually you don't have to do anything.
2702 @item Install the current versions of MSYS and MinGW from
2703 @url{http://www.mingw.org/}. You can find detailed installation
2704 instructions in the download section and the FAQ.
2707 the MinGW development library of SDL 1.2.x
2708 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2709 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
2710 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2711 directory. Edit the @file{sdl-config} script so that it gives the
2712 correct SDL directory when invoked.
2714 @item Extract the current version of QEMU.
2716 @item Start the MSYS shell (file @file{msys.bat}).
2718 @item Change to the QEMU directory. Launch @file{./configure} and
2719 @file{make}. If you have problems using SDL, verify that
2720 @file{sdl-config} can be launched from the MSYS command line.
2722 @item You can install QEMU in @file{Program Files/Qemu} by typing
2723 @file{make install}. Don't forget to copy @file{SDL.dll} in
2724 @file{Program Files/Qemu}.
2728 @node Cross compilation for Windows with Linux
2729 @section Cross compilation for Windows with Linux
2733 Install the MinGW cross compilation tools available at
2734 @url{http://www.mingw.org/}.
2737 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2738 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2739 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2740 the QEMU configuration script.
2743 Configure QEMU for Windows cross compilation:
2745 ./configure --enable-mingw32
2747 If necessary, you can change the cross-prefix according to the prefix
2748 chosen for the MinGW tools with --cross-prefix. You can also use
2749 --prefix to set the Win32 install path.
2751 @item You can install QEMU in the installation directory by typing
2752 @file{make install}. Don't forget to copy @file{SDL.dll} in the
2753 installation directory.
2757 Note: Currently, Wine does not seem able to launch
2763 The Mac OS X patches are not fully merged in QEMU, so you should look
2764 at the QEMU mailing list archive to have all the necessary