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 Intel 82801AA AC97 Audio compatible sound card
171 Adlib(OPL2) - Yamaha YM3812 compatible chip
173 Gravis Ultrasound GF1 sound card
175 PCI UHCI USB controller and a virtual USB hub.
178 SMP is supported with up to 255 CPUs.
180 Note that adlib, ac97 and gus are only available when QEMU was configured
181 with --enable-adlib, --enable-ac97 or --enable-gus respectively.
183 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
186 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
188 QEMU uses GUS emulation(GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
189 by Tibor "TS" Schütz.
193 @node pcsys_quickstart
196 Download and uncompress the linux image (@file{linux.img}) and type:
202 Linux should boot and give you a prompt.
208 @c man begin SYNOPSIS
209 usage: qemu [options] [@var{disk_image}]
214 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
218 @item -M @var{machine}
219 Select the emulated @var{machine} (@code{-M ?} for list)
221 @item -fda @var{file}
222 @item -fdb @var{file}
223 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
224 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
226 @item -hda @var{file}
227 @item -hdb @var{file}
228 @item -hdc @var{file}
229 @item -hdd @var{file}
230 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
232 @item -cdrom @var{file}
233 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
234 @option{-cdrom} at the same time). You can use the host CD-ROM by
235 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
237 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
239 Define a new drive. Valid options are:
242 @item file=@var{file}
243 This option defines which disk image (@pxref{disk_images}) to use with
244 this drive. If the filename contains comma, you must double it
245 (for instance, "file=my,,file" to use file "my,file").
246 @item if=@var{interface}
247 This option defines on which type on interface the drive is connected.
248 Available types are: ide, scsi, sd, mtd, floppy, pflash.
249 @item bus=@var{bus},unit=@var{unit}
250 These options define where is connected the drive by defining the bus number and
252 @item index=@var{index}
253 This option defines where is connected the drive by using an index in the list
254 of available connectors of a given interface type.
255 @item media=@var{media}
256 This option defines the type of the media: disk or cdrom.
257 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
258 These options have the same definition as they have in @option{-hdachs}.
259 @item snapshot=@var{snapshot}
260 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
261 @item cache=@var{cache}
262 @var{cache} is "on" or "off" and allows to disable host cache to access data.
265 Instead of @option{-cdrom} you can use:
267 qemu -drive file=file,index=2,media=cdrom
270 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
273 qemu -drive file=file,index=0,media=disk
274 qemu -drive file=file,index=1,media=disk
275 qemu -drive file=file,index=2,media=disk
276 qemu -drive file=file,index=3,media=disk
279 You can connect a CDROM to the slave of ide0:
281 qemu -drive file=file,if=ide,index=1,media=cdrom
284 If you don't specify the "file=" argument, you define an empty drive:
286 qemu -drive if=ide,index=1,media=cdrom
289 You can connect a SCSI disk with unit ID 6 on the bus #0:
291 qemu -drive file=file,if=scsi,bus=0,unit=6
294 Instead of @option{-fda}, @option{-fdb}, you can use:
296 qemu -drive file=file,index=0,if=floppy
297 qemu -drive file=file,index=1,if=floppy
300 By default, @var{interface} is "ide" and @var{index} is automatically
303 qemu -drive file=a -drive file=b"
310 @item -boot [a|c|d|n]
311 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
315 Write to temporary files instead of disk image files. In this case,
316 the raw disk image you use is not written back. You can however force
317 the write back by pressing @key{C-a s} (@pxref{disk_images}).
320 Disable boot signature checking for floppy disks in Bochs BIOS. It may
321 be needed to boot from old floppy disks.
324 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.
327 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
328 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
333 Will show the audio subsystem help: list of drivers, tunable
336 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
338 Enable audio and selected sound hardware. Use ? to print all
339 available sound hardware.
342 qemu -soundhw sb16,adlib hda
343 qemu -soundhw es1370 hda
344 qemu -soundhw ac97 hda
345 qemu -soundhw all hda
349 Note that Linux's i810_audio OSS kernel (for AC97) module might
350 require manually specifying clocking.
353 modprobe i810_audio clocking=48000
357 Set the real time clock to local time (the default is to UTC
358 time). This option is needed to have correct date in MS-DOS or
361 @item -startdate @var{date}
362 Set the initial date of the real time clock. Valid format for
363 @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
364 @code{2006-06-17}. The default value is @code{now}.
366 @item -pidfile @var{file}
367 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
371 Daemonize the QEMU process after initialization. QEMU will not detach from
372 standard IO until it is ready to receive connections on any of its devices.
373 This option is a useful way for external programs to launch QEMU without having
374 to cope with initialization race conditions.
377 Use it when installing Windows 2000 to avoid a disk full bug. After
378 Windows 2000 is installed, you no longer need this option (this option
379 slows down the IDE transfers).
381 @item -option-rom @var{file}
382 Load the contents of @var{file} as an option ROM.
383 This option is useful to load things like EtherBoot.
385 @item -name @var{name}
386 Sets the @var{name} of the guest.
387 This name will be display in the SDL window caption.
388 The @var{name} will also be used for the VNC server.
397 Normally, QEMU uses SDL to display the VGA output. With this option,
398 you can totally disable graphical output so that QEMU is a simple
399 command line application. The emulated serial port is redirected on
400 the console. Therefore, you can still use QEMU to debug a Linux kernel
401 with a serial console.
405 Do not use decorations for SDL windows and start them using the whole
406 available screen space. This makes the using QEMU in a dedicated desktop
407 workspace more convenient.
410 Start in full screen.
412 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
414 Normally, QEMU uses SDL to display the VGA output. With this option,
415 you can have QEMU listen on VNC display @var{display} and redirect the VGA
416 display over the VNC session. It is very useful to enable the usb
417 tablet device when using this option (option @option{-usbdevice
418 tablet}). When using the VNC display, you must use the @option{-k}
419 parameter to set the keyboard layout if you are not using en-us. Valid
420 syntax for the @var{display} is
424 @item @var{interface}:@var{d}
426 TCP connections will only be allowed from @var{interface} on display @var{d}.
427 By convention the TCP port is 5900+@var{d}. Optionally, @var{interface} can
428 be omitted in which case the server will bind to all interfaces.
430 @item @var{unix}:@var{path}
432 Connections will be allowed over UNIX domain sockets where @var{path} is the
433 location of a unix socket to listen for connections on.
437 VNC is initialized by not started. The monitor @code{change} command can be used
438 to later start the VNC server.
442 Following the @var{display} value there may be one or more @var{option} flags
443 separated by commas. Valid options are
449 Require that password based authentication is used for client connections.
450 The password must be set separately using the @code{change} command in the
455 Require that client use TLS when communicating with the VNC server. This
456 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
457 attack. It is recommended that this option be combined with either the
458 @var{x509} or @var{x509verify} options.
460 @item x509=@var{/path/to/certificate/dir}
462 Valid if @option{tls} is specified. Require that x509 credentials are used
463 for negotiating the TLS session. The server will send its x509 certificate
464 to the client. It is recommended that a password be set on the VNC server
465 to provide authentication of the client when this is used. The path following
466 this option specifies where the x509 certificates are to be loaded from.
467 See the @ref{vnc_security} section for details on generating certificates.
469 @item x509verify=@var{/path/to/certificate/dir}
471 Valid if @option{tls} is specified. Require that x509 credentials are used
472 for negotiating the TLS session. The server will send its x509 certificate
473 to the client, and request that the client send its own x509 certificate.
474 The server will validate the client's certificate against the CA certificate,
475 and reject clients when validation fails. If the certificate authority is
476 trusted, this is a sufficient authentication mechanism. You may still wish
477 to set a password on the VNC server as a second authentication layer. The
478 path following this option specifies where the x509 certificates are to
479 be loaded from. See the @ref{vnc_security} section for details on generating
484 @item -k @var{language}
486 Use keyboard layout @var{language} (for example @code{fr} for
487 French). This option is only needed where it is not easy to get raw PC
488 keycodes (e.g. on Macs, with some X11 servers or with a VNC
489 display). You don't normally need to use it on PC/Linux or PC/Windows
492 The available layouts are:
494 ar de-ch es fo fr-ca hu ja mk no pt-br sv
495 da en-gb et fr fr-ch is lt nl pl ru th
496 de en-us fi fr-be hr it lv nl-be pt sl tr
499 The default is @code{en-us}.
507 Enable the USB driver (will be the default soon)
509 @item -usbdevice @var{devname}
510 Add the USB device @var{devname}. @xref{usb_devices}.
515 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
518 Pointer device that uses absolute coordinates (like a touchscreen). This
519 means qemu is able to report the mouse position without having to grab the
520 mouse. Also overrides the PS/2 mouse emulation when activated.
523 Mass storage device based on file
526 Pass through the host device identified by bus.addr (Linux only).
528 @item host:vendor_id:product_id
529 Pass through the host device identified by vendor_id:product_id (Linux only).
531 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
532 Serial converter to host character device @var{dev}, see @code{-serial} for the
543 @item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
544 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
545 = 0 is the default). The NIC is an ne2k_pci by default on the PC
546 target. Optionally, the MAC address can be changed. If no
547 @option{-net} option is specified, a single NIC is created.
548 Qemu can emulate several different models of network card.
549 Valid values for @var{type} are
550 @code{i82551}, @code{i82557b}, @code{i82559er},
551 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
552 @code{smc91c111}, @code{lance} and @code{mcf_fec}.
553 Not all devices are supported on all targets. Use -net nic,model=?
554 for a list of available devices for your target.
556 @item -net user[,vlan=@var{n}][,hostname=@var{name}]
557 Use the user mode network stack which requires no administrator
558 privilege to run. @option{hostname=name} can be used to specify the client
559 hostname reported by the builtin DHCP server.
561 @item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}]
562 Connect the host TAP network interface @var{name} to VLAN @var{n} and
563 use the network script @var{file} to configure it. The default
564 network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
565 disable script execution. If @var{name} is not
566 provided, the OS automatically provides one. @option{fd}=@var{h} can be
567 used to specify the handle of an already opened host TAP interface. Example:
570 qemu linux.img -net nic -net tap
573 More complicated example (two NICs, each one connected to a TAP device)
575 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
576 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
580 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
582 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
583 machine using a TCP socket connection. If @option{listen} is
584 specified, QEMU waits for incoming connections on @var{port}
585 (@var{host} is optional). @option{connect} is used to connect to
586 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
587 specifies an already opened TCP socket.
591 # launch a first QEMU instance
592 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
593 -net socket,listen=:1234
594 # connect the VLAN 0 of this instance to the VLAN 0
595 # of the first instance
596 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
597 -net socket,connect=127.0.0.1:1234
600 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
602 Create a VLAN @var{n} shared with another QEMU virtual
603 machines using a UDP multicast socket, effectively making a bus for
604 every QEMU with same multicast address @var{maddr} and @var{port}.
608 Several QEMU can be running on different hosts and share same bus (assuming
609 correct multicast setup for these hosts).
611 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
612 @url{http://user-mode-linux.sf.net}.
614 Use @option{fd=h} to specify an already opened UDP multicast socket.
619 # launch one QEMU instance
620 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
621 -net socket,mcast=230.0.0.1:1234
622 # launch another QEMU instance on same "bus"
623 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
624 -net socket,mcast=230.0.0.1:1234
625 # launch yet another QEMU instance on same "bus"
626 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
627 -net socket,mcast=230.0.0.1:1234
630 Example (User Mode Linux compat.):
632 # launch QEMU instance (note mcast address selected
634 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
635 -net socket,mcast=239.192.168.1:1102
637 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
641 Indicate that no network devices should be configured. It is used to
642 override the default configuration (@option{-net nic -net user}) which
643 is activated if no @option{-net} options are provided.
645 @item -tftp @var{dir}
646 When using the user mode network stack, activate a built-in TFTP
647 server. The files in @var{dir} will be exposed as the root of a TFTP server.
648 The TFTP client on the guest must be configured in binary mode (use the command
649 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
652 @item -bootp @var{file}
653 When using the user mode network stack, broadcast @var{file} as the BOOTP
654 filename. In conjunction with @option{-tftp}, this can be used to network boot
655 a guest from a local directory.
657 Example (using pxelinux):
659 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
663 When using the user mode network stack, activate a built-in SMB
664 server so that Windows OSes can access to the host files in @file{@var{dir}}
667 In the guest Windows OS, the line:
671 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
672 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
674 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
676 Note that a SAMBA server must be installed on the host OS in
677 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
678 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
680 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
682 When using the user mode network stack, redirect incoming TCP or UDP
683 connections to the host port @var{host-port} to the guest
684 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
685 is not specified, its value is 10.0.2.15 (default address given by the
686 built-in DHCP server).
688 For example, to redirect host X11 connection from screen 1 to guest
689 screen 0, use the following:
693 qemu -redir tcp:6001::6000 [...]
694 # this host xterm should open in the guest X11 server
698 To redirect telnet connections from host port 5555 to telnet port on
699 the guest, use the following:
703 qemu -redir tcp:5555::23 [...]
704 telnet localhost 5555
707 Then when you use on the host @code{telnet localhost 5555}, you
708 connect to the guest telnet server.
712 Linux boot specific: When using these options, you can use a given
713 Linux kernel without installing it in the disk image. It can be useful
714 for easier testing of various kernels.
718 @item -kernel @var{bzImage}
719 Use @var{bzImage} as kernel image.
721 @item -append @var{cmdline}
722 Use @var{cmdline} as kernel command line
724 @item -initrd @var{file}
725 Use @var{file} as initial ram disk.
729 Debug/Expert options:
732 @item -serial @var{dev}
733 Redirect the virtual serial port to host character device
734 @var{dev}. The default device is @code{vc} in graphical mode and
735 @code{stdio} in non graphical mode.
737 This option can be used several times to simulate up to 4 serials
740 Use @code{-serial none} to disable all serial ports.
742 Available character devices are:
745 Virtual console. Optionally, a width and height can be given in pixel with
749 It is also possible to specify width or height in characters:
754 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
756 No device is allocated.
760 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
761 parameters are set according to the emulated ones.
762 @item /dev/parport@var{N}
763 [Linux only, parallel port only] Use host parallel port
764 @var{N}. Currently SPP and EPP parallel port features can be used.
765 @item file:@var{filename}
766 Write output to @var{filename}. No character can be read.
768 [Unix only] standard input/output
769 @item pipe:@var{filename}
770 name pipe @var{filename}
772 [Windows only] Use host serial port @var{n}
773 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
774 This implements UDP Net Console.
775 When @var{remote_host} or @var{src_ip} are not specified
776 they default to @code{0.0.0.0}.
777 When not using a specified @var{src_port} a random port is automatically chosen.
779 If you just want a simple readonly console you can use @code{netcat} or
780 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
781 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
782 will appear in the netconsole session.
784 If you plan to send characters back via netconsole or you want to stop
785 and start qemu a lot of times, you should have qemu use the same
786 source port each time by using something like @code{-serial
787 udp::4555@@:4556} to qemu. Another approach is to use a patched
788 version of netcat which can listen to a TCP port and send and receive
789 characters via udp. If you have a patched version of netcat which
790 activates telnet remote echo and single char transfer, then you can
791 use the following options to step up a netcat redirector to allow
792 telnet on port 5555 to access the qemu port.
795 -serial udp::4555@@:4556
796 @item netcat options:
797 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
798 @item telnet options:
803 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
804 The TCP Net Console has two modes of operation. It can send the serial
805 I/O to a location or wait for a connection from a location. By default
806 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
807 the @var{server} option QEMU will wait for a client socket application
808 to connect to the port before continuing, unless the @code{nowait}
809 option was specified. The @code{nodelay} option disables the Nagle buffering
810 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
811 one TCP connection at a time is accepted. You can use @code{telnet} to
812 connect to the corresponding character device.
814 @item Example to send tcp console to 192.168.0.2 port 4444
815 -serial tcp:192.168.0.2:4444
816 @item Example to listen and wait on port 4444 for connection
817 -serial tcp::4444,server
818 @item Example to not wait and listen on ip 192.168.0.100 port 4444
819 -serial tcp:192.168.0.100:4444,server,nowait
822 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
823 The telnet protocol is used instead of raw tcp sockets. The options
824 work the same as if you had specified @code{-serial tcp}. The
825 difference is that the port acts like a telnet server or client using
826 telnet option negotiation. This will also allow you to send the
827 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
828 sequence. Typically in unix telnet you do it with Control-] and then
829 type "send break" followed by pressing the enter key.
831 @item unix:@var{path}[,server][,nowait]
832 A unix domain socket is used instead of a tcp socket. The option works the
833 same as if you had specified @code{-serial tcp} except the unix domain socket
834 @var{path} is used for connections.
836 @item mon:@var{dev_string}
837 This is a special option to allow the monitor to be multiplexed onto
838 another serial port. The monitor is accessed with key sequence of
839 @key{Control-a} and then pressing @key{c}. See monitor access
840 @ref{pcsys_keys} in the -nographic section for more keys.
841 @var{dev_string} should be any one of the serial devices specified
842 above. An example to multiplex the monitor onto a telnet server
843 listening on port 4444 would be:
845 @item -serial mon:telnet::4444,server,nowait
850 @item -parallel @var{dev}
851 Redirect the virtual parallel port to host device @var{dev} (same
852 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
853 be used to use hardware devices connected on the corresponding host
856 This option can be used several times to simulate up to 3 parallel
859 Use @code{-parallel none} to disable all parallel ports.
861 @item -monitor @var{dev}
862 Redirect the monitor to host device @var{dev} (same devices as the
864 The default device is @code{vc} in graphical mode and @code{stdio} in
867 @item -echr numeric_ascii_value
868 Change the escape character used for switching to the monitor when using
869 monitor and serial sharing. The default is @code{0x01} when using the
870 @code{-nographic} option. @code{0x01} is equal to pressing
871 @code{Control-a}. You can select a different character from the ascii
872 control keys where 1 through 26 map to Control-a through Control-z. For
873 instance you could use the either of the following to change the escape
874 character to Control-t.
881 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
883 Change gdb connection port. @var{port} can be either a decimal number
884 to specify a TCP port, or a host device (same devices as the serial port).
886 Do not start CPU at startup (you must type 'c' in the monitor).
888 Output log in /tmp/qemu.log
889 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
890 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
891 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
892 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
893 all those parameters. This option is useful for old MS-DOS disk
897 Set the directory for the BIOS, VGA BIOS and keymaps.
900 Simulate a standard VGA card with Bochs VBE extensions (default is
901 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
902 VBE extensions (e.g. Windows XP) and if you want to use high
903 resolution modes (>= 1280x1024x16) then you should use this option.
906 Disable ACPI (Advanced Configuration and Power Interface) support. Use
907 it if your guest OS complains about ACPI problems (PC target machine
911 Exit instead of rebooting.
914 Start right away with a saved state (@code{loadvm} in monitor)
917 Enable semihosting syscall emulation (ARM and M68K target machines only).
919 On ARM this implements the "Angel" interface.
920 On M68K this implements the "ColdFire GDB" interface used by libgloss.
922 Note that this allows guest direct access to the host filesystem,
923 so should only be used with trusted guest OS.
933 During the graphical emulation, you can use the following keys:
939 Switch to virtual console 'n'. Standard console mappings are:
942 Target system display
950 Toggle mouse and keyboard grab.
953 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
954 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
956 During emulation, if you are using the @option{-nographic} option, use
957 @key{Ctrl-a h} to get terminal commands:
965 Save disk data back to file (if -snapshot)
967 toggle console timestamps
969 Send break (magic sysrq in Linux)
971 Switch between console and monitor
980 The HTML documentation of QEMU for more precise information and Linux
981 user mode emulator invocation.
991 @section QEMU Monitor
993 The QEMU monitor is used to give complex commands to the QEMU
994 emulator. You can use it to:
999 Remove or insert removable media images
1000 (such as CD-ROM or floppies).
1003 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
1006 @item Inspect the VM state without an external debugger.
1010 @subsection Commands
1012 The following commands are available:
1016 @item help or ? [@var{cmd}]
1017 Show the help for all commands or just for command @var{cmd}.
1020 Commit changes to the disk images (if -snapshot is used).
1022 @item info @var{subcommand}
1023 Show various information about the system state.
1027 show the various VLANs and the associated devices
1029 show the block devices
1030 @item info registers
1031 show the cpu registers
1033 show the command line history
1035 show emulated PCI device
1037 show USB devices plugged on the virtual USB hub
1039 show all USB host devices
1041 show information about active capturing
1042 @item info snapshots
1043 show list of VM snapshots
1045 show which guest mouse is receiving events
1051 @item eject [-f] @var{device}
1052 Eject a removable medium (use -f to force it).
1054 @item change @var{device} @var{setting}
1056 Change the configuration of a device.
1059 @item change @var{diskdevice} @var{filename}
1060 Change the medium for a removable disk device to point to @var{filename}. eg
1063 (qemu) change cdrom /path/to/some.iso
1066 @item change vnc @var{display},@var{options}
1067 Change the configuration of the VNC server. The valid syntax for @var{display}
1068 and @var{options} are described at @ref{sec_invocation}. eg
1071 (qemu) change vnc localhost:1
1074 @item change vnc password
1076 Change the password associated with the VNC server. The monitor will prompt for
1077 the new password to be entered. VNC passwords are only significant upto 8 letters.
1081 (qemu) change vnc password
1087 @item screendump @var{filename}
1088 Save screen into PPM image @var{filename}.
1090 @item mouse_move @var{dx} @var{dy} [@var{dz}]
1091 Move the active mouse to the specified coordinates @var{dx} @var{dy}
1092 with optional scroll axis @var{dz}.
1094 @item mouse_button @var{val}
1095 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
1097 @item mouse_set @var{index}
1098 Set which mouse device receives events at given @var{index}, index
1099 can be obtained with
1104 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
1105 Capture audio into @var{filename}. Using sample rate @var{frequency}
1106 bits per sample @var{bits} and number of channels @var{channels}.
1110 @item Sample rate = 44100 Hz - CD quality
1112 @item Number of channels = 2 - Stereo
1115 @item stopcapture @var{index}
1116 Stop capture with a given @var{index}, index can be obtained with
1121 @item log @var{item1}[,...]
1122 Activate logging of the specified items to @file{/tmp/qemu.log}.
1124 @item savevm [@var{tag}|@var{id}]
1125 Create a snapshot of the whole virtual machine. If @var{tag} is
1126 provided, it is used as human readable identifier. If there is already
1127 a snapshot with the same tag or ID, it is replaced. More info at
1130 @item loadvm @var{tag}|@var{id}
1131 Set the whole virtual machine to the snapshot identified by the tag
1132 @var{tag} or the unique snapshot ID @var{id}.
1134 @item delvm @var{tag}|@var{id}
1135 Delete the snapshot identified by @var{tag} or @var{id}.
1143 @item gdbserver [@var{port}]
1144 Start gdbserver session (default @var{port}=1234)
1146 @item x/fmt @var{addr}
1147 Virtual memory dump starting at @var{addr}.
1149 @item xp /@var{fmt} @var{addr}
1150 Physical memory dump starting at @var{addr}.
1152 @var{fmt} is a format which tells the command how to format the
1153 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1157 is the number of items to be dumped.
1160 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
1161 c (char) or i (asm instruction).
1164 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1165 @code{h} or @code{w} can be specified with the @code{i} format to
1166 respectively select 16 or 32 bit code instruction size.
1173 Dump 10 instructions at the current instruction pointer:
1178 0x90107065: lea 0x0(%esi,1),%esi
1179 0x90107069: lea 0x0(%edi,1),%edi
1181 0x90107071: jmp 0x90107080
1189 Dump 80 16 bit values at the start of the video memory.
1191 (qemu) xp/80hx 0xb8000
1192 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
1193 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
1194 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
1195 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
1196 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
1197 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
1198 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1199 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1200 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1201 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1205 @item p or print/@var{fmt} @var{expr}
1207 Print expression value. Only the @var{format} part of @var{fmt} is
1210 @item sendkey @var{keys}
1212 Send @var{keys} to the emulator. Use @code{-} to press several keys
1213 simultaneously. Example:
1218 This command is useful to send keys that your graphical user interface
1219 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1225 @item usb_add @var{devname}
1227 Add the USB device @var{devname}. For details of available devices see
1230 @item usb_del @var{devname}
1232 Remove the USB device @var{devname} from the QEMU virtual USB
1233 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1234 command @code{info usb} to see the devices you can remove.
1238 @subsection Integer expressions
1240 The monitor understands integers expressions for every integer
1241 argument. You can use register names to get the value of specifics
1242 CPU registers by prefixing them with @emph{$}.
1245 @section Disk Images
1247 Since version 0.6.1, QEMU supports many disk image formats, including
1248 growable disk images (their size increase as non empty sectors are
1249 written), compressed and encrypted disk images. Version 0.8.3 added
1250 the new qcow2 disk image format which is essential to support VM
1254 * disk_images_quickstart:: Quick start for disk image creation
1255 * disk_images_snapshot_mode:: Snapshot mode
1256 * vm_snapshots:: VM snapshots
1257 * qemu_img_invocation:: qemu-img Invocation
1258 * host_drives:: Using host drives
1259 * disk_images_fat_images:: Virtual FAT disk images
1262 @node disk_images_quickstart
1263 @subsection Quick start for disk image creation
1265 You can create a disk image with the command:
1267 qemu-img create myimage.img mysize
1269 where @var{myimage.img} is the disk image filename and @var{mysize} is its
1270 size in kilobytes. You can add an @code{M} suffix to give the size in
1271 megabytes and a @code{G} suffix for gigabytes.
1273 See @ref{qemu_img_invocation} for more information.
1275 @node disk_images_snapshot_mode
1276 @subsection Snapshot mode
1278 If you use the option @option{-snapshot}, all disk images are
1279 considered as read only. When sectors in written, they are written in
1280 a temporary file created in @file{/tmp}. You can however force the
1281 write back to the raw disk images by using the @code{commit} monitor
1282 command (or @key{C-a s} in the serial console).
1285 @subsection VM snapshots
1287 VM snapshots are snapshots of the complete virtual machine including
1288 CPU state, RAM, device state and the content of all the writable
1289 disks. In order to use VM snapshots, you must have at least one non
1290 removable and writable block device using the @code{qcow2} disk image
1291 format. Normally this device is the first virtual hard drive.
1293 Use the monitor command @code{savevm} to create a new VM snapshot or
1294 replace an existing one. A human readable name can be assigned to each
1295 snapshot in addition to its numerical ID.
1297 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1298 a VM snapshot. @code{info snapshots} lists the available snapshots
1299 with their associated information:
1302 (qemu) info snapshots
1303 Snapshot devices: hda
1304 Snapshot list (from hda):
1305 ID TAG VM SIZE DATE VM CLOCK
1306 1 start 41M 2006-08-06 12:38:02 00:00:14.954
1307 2 40M 2006-08-06 12:43:29 00:00:18.633
1308 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
1311 A VM snapshot is made of a VM state info (its size is shown in
1312 @code{info snapshots}) and a snapshot of every writable disk image.
1313 The VM state info is stored in the first @code{qcow2} non removable
1314 and writable block device. The disk image snapshots are stored in
1315 every disk image. The size of a snapshot in a disk image is difficult
1316 to evaluate and is not shown by @code{info snapshots} because the
1317 associated disk sectors are shared among all the snapshots to save
1318 disk space (otherwise each snapshot would need a full copy of all the
1321 When using the (unrelated) @code{-snapshot} option
1322 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1323 but they are deleted as soon as you exit QEMU.
1325 VM snapshots currently have the following known limitations:
1328 They cannot cope with removable devices if they are removed or
1329 inserted after a snapshot is done.
1331 A few device drivers still have incomplete snapshot support so their
1332 state is not saved or restored properly (in particular USB).
1335 @node qemu_img_invocation
1336 @subsection @code{qemu-img} Invocation
1338 @include qemu-img.texi
1341 @subsection Using host drives
1343 In addition to disk image files, QEMU can directly access host
1344 devices. We describe here the usage for QEMU version >= 0.8.3.
1346 @subsubsection Linux
1348 On Linux, you can directly use the host device filename instead of a
1349 disk image filename provided you have enough privileges to access
1350 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1351 @file{/dev/fd0} for the floppy.
1355 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1356 specific code to detect CDROM insertion or removal. CDROM ejection by
1357 the guest OS is supported. Currently only data CDs are supported.
1359 You can specify a floppy device even if no floppy is loaded. Floppy
1360 removal is currently not detected accurately (if you change floppy
1361 without doing floppy access while the floppy is not loaded, the guest
1362 OS will think that the same floppy is loaded).
1364 Hard disks can be used. Normally you must specify the whole disk
1365 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1366 see it as a partitioned disk. WARNING: unless you know what you do, it
1367 is better to only make READ-ONLY accesses to the hard disk otherwise
1368 you may corrupt your host data (use the @option{-snapshot} command
1369 line option or modify the device permissions accordingly).
1372 @subsubsection Windows
1376 The preferred syntax is the drive letter (e.g. @file{d:}). The
1377 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1378 supported as an alias to the first CDROM drive.
1380 Currently there is no specific code to handle removable media, so it
1381 is better to use the @code{change} or @code{eject} monitor commands to
1382 change or eject media.
1384 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1385 where @var{N} is the drive number (0 is the first hard disk).
1387 WARNING: unless you know what you do, it is better to only make
1388 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1389 host data (use the @option{-snapshot} command line so that the
1390 modifications are written in a temporary file).
1394 @subsubsection Mac OS X
1396 @file{/dev/cdrom} is an alias to the first CDROM.
1398 Currently there is no specific code to handle removable media, so it
1399 is better to use the @code{change} or @code{eject} monitor commands to
1400 change or eject media.
1402 @node disk_images_fat_images
1403 @subsection Virtual FAT disk images
1405 QEMU can automatically create a virtual FAT disk image from a
1406 directory tree. In order to use it, just type:
1409 qemu linux.img -hdb fat:/my_directory
1412 Then you access access to all the files in the @file{/my_directory}
1413 directory without having to copy them in a disk image or to export
1414 them via SAMBA or NFS. The default access is @emph{read-only}.
1416 Floppies can be emulated with the @code{:floppy:} option:
1419 qemu linux.img -fda fat:floppy:/my_directory
1422 A read/write support is available for testing (beta stage) with the
1426 qemu linux.img -fda fat:floppy:rw:/my_directory
1429 What you should @emph{never} do:
1431 @item use non-ASCII filenames ;
1432 @item use "-snapshot" together with ":rw:" ;
1433 @item expect it to work when loadvm'ing ;
1434 @item write to the FAT directory on the host system while accessing it with the guest system.
1438 @section Network emulation
1440 QEMU can simulate several network cards (PCI or ISA cards on the PC
1441 target) and can connect them to an arbitrary number of Virtual Local
1442 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1443 VLAN. VLAN can be connected between separate instances of QEMU to
1444 simulate large networks. For simpler usage, a non privileged user mode
1445 network stack can replace the TAP device to have a basic network
1450 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1451 connection between several network devices. These devices can be for
1452 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1455 @subsection Using TAP network interfaces
1457 This is the standard way to connect QEMU to a real network. QEMU adds
1458 a virtual network device on your host (called @code{tapN}), and you
1459 can then configure it as if it was a real ethernet card.
1461 @subsubsection Linux host
1463 As an example, you can download the @file{linux-test-xxx.tar.gz}
1464 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1465 configure properly @code{sudo} so that the command @code{ifconfig}
1466 contained in @file{qemu-ifup} can be executed as root. You must verify
1467 that your host kernel supports the TAP network interfaces: the
1468 device @file{/dev/net/tun} must be present.
1470 See @ref{sec_invocation} to have examples of command lines using the
1471 TAP network interfaces.
1473 @subsubsection Windows host
1475 There is a virtual ethernet driver for Windows 2000/XP systems, called
1476 TAP-Win32. But it is not included in standard QEMU for Windows,
1477 so you will need to get it separately. It is part of OpenVPN package,
1478 so download OpenVPN from : @url{http://openvpn.net/}.
1480 @subsection Using the user mode network stack
1482 By using the option @option{-net user} (default configuration if no
1483 @option{-net} option is specified), QEMU uses a completely user mode
1484 network stack (you don't need root privilege to use the virtual
1485 network). The virtual network configuration is the following:
1489 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1492 ----> DNS server (10.0.2.3)
1494 ----> SMB server (10.0.2.4)
1497 The QEMU VM behaves as if it was behind a firewall which blocks all
1498 incoming connections. You can use a DHCP client to automatically
1499 configure the network in the QEMU VM. The DHCP server assign addresses
1500 to the hosts starting from 10.0.2.15.
1502 In order to check that the user mode network is working, you can ping
1503 the address 10.0.2.2 and verify that you got an address in the range
1504 10.0.2.x from the QEMU virtual DHCP server.
1506 Note that @code{ping} is not supported reliably to the internet as it
1507 would require root privileges. It means you can only ping the local
1510 When using the built-in TFTP server, the router is also the TFTP
1513 When using the @option{-redir} option, TCP or UDP connections can be
1514 redirected from the host to the guest. It allows for example to
1515 redirect X11, telnet or SSH connections.
1517 @subsection Connecting VLANs between QEMU instances
1519 Using the @option{-net socket} option, it is possible to make VLANs
1520 that span several QEMU instances. See @ref{sec_invocation} to have a
1523 @node direct_linux_boot
1524 @section Direct Linux Boot
1526 This section explains how to launch a Linux kernel inside QEMU without
1527 having to make a full bootable image. It is very useful for fast Linux
1532 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1535 Use @option{-kernel} to provide the Linux kernel image and
1536 @option{-append} to give the kernel command line arguments. The
1537 @option{-initrd} option can be used to provide an INITRD image.
1539 When using the direct Linux boot, a disk image for the first hard disk
1540 @file{hda} is required because its boot sector is used to launch the
1543 If you do not need graphical output, you can disable it and redirect
1544 the virtual serial port and the QEMU monitor to the console with the
1545 @option{-nographic} option. The typical command line is:
1547 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1548 -append "root=/dev/hda console=ttyS0" -nographic
1551 Use @key{Ctrl-a c} to switch between the serial console and the
1552 monitor (@pxref{pcsys_keys}).
1555 @section USB emulation
1557 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1558 virtual USB devices or real host USB devices (experimental, works only
1559 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1560 as necessary to connect multiple USB devices.
1564 * host_usb_devices::
1567 @subsection Connecting USB devices
1569 USB devices can be connected with the @option{-usbdevice} commandline option
1570 or the @code{usb_add} monitor command. Available devices are:
1574 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1576 Pointer device that uses absolute coordinates (like a touchscreen).
1577 This means qemu is able to report the mouse position without having
1578 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1579 @item disk:@var{file}
1580 Mass storage device based on @var{file} (@pxref{disk_images})
1581 @item host:@var{bus.addr}
1582 Pass through the host device identified by @var{bus.addr}
1584 @item host:@var{vendor_id:product_id}
1585 Pass through the host device identified by @var{vendor_id:product_id}
1588 Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet}
1589 above but it can be used with the tslib library because in addition to touch
1590 coordinates it reports touch pressure.
1592 Standard USB keyboard. Will override the PS/2 keyboard (if present).
1593 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1594 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1595 device @var{dev}. The available character devices are the same as for the
1596 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1597 used to override the default 0403:6001. For instance,
1599 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1601 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1602 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1605 @node host_usb_devices
1606 @subsection Using host USB devices on a Linux host
1608 WARNING: this is an experimental feature. QEMU will slow down when
1609 using it. USB devices requiring real time streaming (i.e. USB Video
1610 Cameras) are not supported yet.
1613 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1614 is actually using the USB device. A simple way to do that is simply to
1615 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1616 to @file{mydriver.o.disabled}.
1618 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1624 @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:
1626 chown -R myuid /proc/bus/usb
1629 @item Launch QEMU and do in the monitor:
1632 Device 1.2, speed 480 Mb/s
1633 Class 00: USB device 1234:5678, USB DISK
1635 You should see the list of the devices you can use (Never try to use
1636 hubs, it won't work).
1638 @item Add the device in QEMU by using:
1640 usb_add host:1234:5678
1643 Normally the guest OS should report that a new USB device is
1644 plugged. You can use the option @option{-usbdevice} to do the same.
1646 @item Now you can try to use the host USB device in QEMU.
1650 When relaunching QEMU, you may have to unplug and plug again the USB
1651 device to make it work again (this is a bug).
1654 @section VNC security
1656 The VNC server capability provides access to the graphical console
1657 of the guest VM across the network. This has a number of security
1658 considerations depending on the deployment scenarios.
1662 * vnc_sec_password::
1663 * vnc_sec_certificate::
1664 * vnc_sec_certificate_verify::
1665 * vnc_sec_certificate_pw::
1666 * vnc_generate_cert::
1669 @subsection Without passwords
1671 The simplest VNC server setup does not include any form of authentication.
1672 For this setup it is recommended to restrict it to listen on a UNIX domain
1673 socket only. For example
1676 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1679 This ensures that only users on local box with read/write access to that
1680 path can access the VNC server. To securely access the VNC server from a
1681 remote machine, a combination of netcat+ssh can be used to provide a secure
1684 @node vnc_sec_password
1685 @subsection With passwords
1687 The VNC protocol has limited support for password based authentication. Since
1688 the protocol limits passwords to 8 characters it should not be considered
1689 to provide high security. The password can be fairly easily brute-forced by
1690 a client making repeat connections. For this reason, a VNC server using password
1691 authentication should be restricted to only listen on the loopback interface
1692 or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
1693 option, and then once QEMU is running the password is set with the monitor. Until
1694 the monitor is used to set the password all clients will be rejected.
1697 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1698 (qemu) change vnc password
1703 @node vnc_sec_certificate
1704 @subsection With x509 certificates
1706 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1707 TLS for encryption of the session, and x509 certificates for authentication.
1708 The use of x509 certificates is strongly recommended, because TLS on its
1709 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1710 support provides a secure session, but no authentication. This allows any
1711 client to connect, and provides an encrypted session.
1714 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1717 In the above example @code{/etc/pki/qemu} should contain at least three files,
1718 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1719 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1720 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1721 only be readable by the user owning it.
1723 @node vnc_sec_certificate_verify
1724 @subsection With x509 certificates and client verification
1726 Certificates can also provide a means to authenticate the client connecting.
1727 The server will request that the client provide a certificate, which it will
1728 then validate against the CA certificate. This is a good choice if deploying
1729 in an environment with a private internal certificate authority.
1732 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1736 @node vnc_sec_certificate_pw
1737 @subsection With x509 certificates, client verification and passwords
1739 Finally, the previous method can be combined with VNC password authentication
1740 to provide two layers of authentication for clients.
1743 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1744 (qemu) change vnc password
1749 @node vnc_generate_cert
1750 @subsection Generating certificates for VNC
1752 The GNU TLS packages provides a command called @code{certtool} which can
1753 be used to generate certificates and keys in PEM format. At a minimum it
1754 is neccessary to setup a certificate authority, and issue certificates to
1755 each server. If using certificates for authentication, then each client
1756 will also need to be issued a certificate. The recommendation is for the
1757 server to keep its certificates in either @code{/etc/pki/qemu} or for
1758 unprivileged users in @code{$HOME/.pki/qemu}.
1762 * vnc_generate_server::
1763 * vnc_generate_client::
1765 @node vnc_generate_ca
1766 @subsubsection Setup the Certificate Authority
1768 This step only needs to be performed once per organization / organizational
1769 unit. First the CA needs a private key. This key must be kept VERY secret
1770 and secure. If this key is compromised the entire trust chain of the certificates
1771 issued with it is lost.
1774 # certtool --generate-privkey > ca-key.pem
1777 A CA needs to have a public certificate. For simplicity it can be a self-signed
1778 certificate, or one issue by a commercial certificate issuing authority. To
1779 generate a self-signed certificate requires one core piece of information, the
1780 name of the organization.
1783 # cat > ca.info <<EOF
1784 cn = Name of your organization
1788 # certtool --generate-self-signed \
1789 --load-privkey ca-key.pem
1790 --template ca.info \
1791 --outfile ca-cert.pem
1794 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1795 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1797 @node vnc_generate_server
1798 @subsubsection Issuing server certificates
1800 Each server (or host) needs to be issued with a key and certificate. When connecting
1801 the certificate is sent to the client which validates it against the CA certificate.
1802 The core piece of information for a server certificate is the hostname. This should
1803 be the fully qualified hostname that the client will connect with, since the client
1804 will typically also verify the hostname in the certificate. On the host holding the
1805 secure CA private key:
1808 # cat > server.info <<EOF
1809 organization = Name of your organization
1810 cn = server.foo.example.com
1815 # certtool --generate-privkey > server-key.pem
1816 # certtool --generate-certificate \
1817 --load-ca-certificate ca-cert.pem \
1818 --load-ca-privkey ca-key.pem \
1819 --load-privkey server server-key.pem \
1820 --template server.info \
1821 --outfile server-cert.pem
1824 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1825 to the server for which they were generated. The @code{server-key.pem} is security
1826 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1828 @node vnc_generate_client
1829 @subsubsection Issuing client certificates
1831 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1832 certificates as its authentication mechanism, each client also needs to be issued
1833 a certificate. The client certificate contains enough metadata to uniquely identify
1834 the client, typically organization, state, city, building, etc. On the host holding
1835 the secure CA private key:
1838 # cat > client.info <<EOF
1842 organiazation = Name of your organization
1843 cn = client.foo.example.com
1848 # certtool --generate-privkey > client-key.pem
1849 # certtool --generate-certificate \
1850 --load-ca-certificate ca-cert.pem \
1851 --load-ca-privkey ca-key.pem \
1852 --load-privkey client-key.pem \
1853 --template client.info \
1854 --outfile client-cert.pem
1857 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1858 copied to the client for which they were generated.
1863 QEMU has a primitive support to work with gdb, so that you can do
1864 'Ctrl-C' while the virtual machine is running and inspect its state.
1866 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1869 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1870 -append "root=/dev/hda"
1871 Connected to host network interface: tun0
1872 Waiting gdb connection on port 1234
1875 Then launch gdb on the 'vmlinux' executable:
1880 In gdb, connect to QEMU:
1882 (gdb) target remote localhost:1234
1885 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1890 Here are some useful tips in order to use gdb on system code:
1894 Use @code{info reg} to display all the CPU registers.
1896 Use @code{x/10i $eip} to display the code at the PC position.
1898 Use @code{set architecture i8086} to dump 16 bit code. Then use
1899 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1902 @node pcsys_os_specific
1903 @section Target OS specific information
1907 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1908 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1909 color depth in the guest and the host OS.
1911 When using a 2.6 guest Linux kernel, you should add the option
1912 @code{clock=pit} on the kernel command line because the 2.6 Linux
1913 kernels make very strict real time clock checks by default that QEMU
1914 cannot simulate exactly.
1916 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1917 not activated because QEMU is slower with this patch. The QEMU
1918 Accelerator Module is also much slower in this case. Earlier Fedora
1919 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1920 patch by default. Newer kernels don't have it.
1924 If you have a slow host, using Windows 95 is better as it gives the
1925 best speed. Windows 2000 is also a good choice.
1927 @subsubsection SVGA graphic modes support
1929 QEMU emulates a Cirrus Logic GD5446 Video
1930 card. All Windows versions starting from Windows 95 should recognize
1931 and use this graphic card. For optimal performances, use 16 bit color
1932 depth in the guest and the host OS.
1934 If you are using Windows XP as guest OS and if you want to use high
1935 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1936 1280x1024x16), then you should use the VESA VBE virtual graphic card
1937 (option @option{-std-vga}).
1939 @subsubsection CPU usage reduction
1941 Windows 9x does not correctly use the CPU HLT
1942 instruction. The result is that it takes host CPU cycles even when
1943 idle. You can install the utility from
1944 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1945 problem. Note that no such tool is needed for NT, 2000 or XP.
1947 @subsubsection Windows 2000 disk full problem
1949 Windows 2000 has a bug which gives a disk full problem during its
1950 installation. When installing it, use the @option{-win2k-hack} QEMU
1951 option to enable a specific workaround. After Windows 2000 is
1952 installed, you no longer need this option (this option slows down the
1955 @subsubsection Windows 2000 shutdown
1957 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1958 can. It comes from the fact that Windows 2000 does not automatically
1959 use the APM driver provided by the BIOS.
1961 In order to correct that, do the following (thanks to Struan
1962 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1963 Add/Troubleshoot a device => Add a new device & Next => No, select the
1964 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1965 (again) a few times. Now the driver is installed and Windows 2000 now
1966 correctly instructs QEMU to shutdown at the appropriate moment.
1968 @subsubsection Share a directory between Unix and Windows
1970 See @ref{sec_invocation} about the help of the option @option{-smb}.
1972 @subsubsection Windows XP security problem
1974 Some releases of Windows XP install correctly but give a security
1977 A problem is preventing Windows from accurately checking the
1978 license for this computer. Error code: 0x800703e6.
1981 The workaround is to install a service pack for XP after a boot in safe
1982 mode. Then reboot, and the problem should go away. Since there is no
1983 network while in safe mode, its recommended to download the full
1984 installation of SP1 or SP2 and transfer that via an ISO or using the
1985 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1987 @subsection MS-DOS and FreeDOS
1989 @subsubsection CPU usage reduction
1991 DOS does not correctly use the CPU HLT instruction. The result is that
1992 it takes host CPU cycles even when idle. You can install the utility
1993 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1996 @node QEMU System emulator for non PC targets
1997 @chapter QEMU System emulator for non PC targets
1999 QEMU is a generic emulator and it emulates many non PC
2000 machines. Most of the options are similar to the PC emulator. The
2001 differences are mentioned in the following sections.
2004 * QEMU PowerPC System emulator::
2005 * Sparc32 System emulator::
2006 * Sparc64 System emulator::
2007 * MIPS System emulator::
2008 * ARM System emulator::
2009 * ColdFire System emulator::
2012 @node QEMU PowerPC System emulator
2013 @section QEMU PowerPC System emulator
2015 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
2016 or PowerMac PowerPC system.
2018 QEMU emulates the following PowerMac peripherals:
2024 PCI VGA compatible card with VESA Bochs Extensions
2026 2 PMAC IDE interfaces with hard disk and CD-ROM support
2032 VIA-CUDA with ADB keyboard and mouse.
2035 QEMU emulates the following PREP peripherals:
2041 PCI VGA compatible card with VESA Bochs Extensions
2043 2 IDE interfaces with hard disk and CD-ROM support
2047 NE2000 network adapters
2051 PREP Non Volatile RAM
2053 PC compatible keyboard and mouse.
2056 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2057 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2059 @c man begin OPTIONS
2061 The following options are specific to the PowerPC emulation:
2065 @item -g WxH[xDEPTH]
2067 Set the initial VGA graphic mode. The default is 800x600x15.
2074 More information is available at
2075 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2077 @node Sparc32 System emulator
2078 @section Sparc32 System emulator
2080 Use the executable @file{qemu-system-sparc} to simulate a SPARCstation
2081 5, SPARCstation 10, SPARCstation 20, SPARCserver 600MP (sun4m
2082 architecture), SPARCstation 2 (sun4c architecture), SPARCserver 1000,
2083 or SPARCcenter 2000 (sun4d architecture). The emulation is somewhat
2084 complete. SMP up to 16 CPUs is supported, but Linux limits the number
2085 of usable CPUs to 4.
2087 QEMU emulates the following sun4m/sun4d peripherals:
2095 Lance (Am7990) Ethernet
2097 Non Volatile RAM M48T08
2099 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2100 and power/reset logic
2102 ESP SCSI controller with hard disk and CD-ROM support
2104 Floppy drive (not on SS-600MP)
2106 CS4231 sound device (only on SS-5, not working yet)
2109 The number of peripherals is fixed in the architecture. Maximum
2110 memory size depends on the machine type, for SS-5 it is 256MB and for
2113 Since version 0.8.2, QEMU uses OpenBIOS
2114 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2115 firmware implementation. The goal is to implement a 100% IEEE
2116 1275-1994 (referred to as Open Firmware) compliant firmware.
2118 A sample Linux 2.6 series kernel and ram disk image are available on
2119 the QEMU web site. Please note that currently NetBSD, OpenBSD or
2120 Solaris kernels don't work.
2122 @c man begin OPTIONS
2124 The following options are specific to the Sparc32 emulation:
2128 @item -g WxHx[xDEPTH]
2130 Set the initial TCX graphic mode. The default is 1024x768x8, currently
2131 the only other possible mode is 1024x768x24.
2133 @item -prom-env string
2135 Set OpenBIOS variables in NVRAM, for example:
2138 qemu-system-sparc -prom-env 'auto-boot?=false' \
2139 -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2142 @item -M [SS-5|SS-10|SS-20|SS-600MP|SS-2|SS-1000|SS-2000]
2144 Set the emulated machine type. Default is SS-5.
2150 @node Sparc64 System emulator
2151 @section Sparc64 System emulator
2153 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
2154 The emulator is not usable for anything yet.
2156 QEMU emulates the following sun4u peripherals:
2160 UltraSparc IIi APB PCI Bridge
2162 PCI VGA compatible card with VESA Bochs Extensions
2164 Non Volatile RAM M48T59
2166 PC-compatible serial ports
2169 @node MIPS System emulator
2170 @section MIPS System emulator
2172 Four executables cover simulation of 32 and 64-bit MIPS systems in
2173 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2174 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2175 Four different machine types are emulated:
2179 A generic ISA PC-like machine "mips"
2181 The MIPS Malta prototype board "malta"
2183 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2185 MIPS emulator pseudo board "mipssim"
2188 The generic emulation is supported by Debian 'Etch' and is able to
2189 install Debian into a virtual disk image. The following devices are
2194 A range of MIPS CPUs, default is the 24Kf
2196 PC style serial port
2203 The Malta emulation supports the following devices:
2207 Core board with MIPS 24Kf CPU and Galileo system controller
2209 PIIX4 PCI/USB/SMbus controller
2211 The Multi-I/O chip's serial device
2213 PCnet32 PCI network card
2215 Malta FPGA serial device
2217 Cirrus VGA graphics card
2220 The ACER Pica emulation supports:
2226 PC-style IRQ and DMA controllers
2233 The mipssim pseudo board emulation provides an environment similiar
2234 to what the proprietary MIPS emulator uses for running Linux.
2239 A range of MIPS CPUs, default is the 24Kf
2241 PC style serial port
2243 MIPSnet network emulation
2246 @node ARM System emulator
2247 @section ARM System emulator
2249 Use the executable @file{qemu-system-arm} to simulate a ARM
2250 machine. The ARM Integrator/CP board is emulated with the following
2255 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2259 SMC 91c111 Ethernet adapter
2261 PL110 LCD controller
2263 PL050 KMI with PS/2 keyboard and mouse.
2265 PL181 MultiMedia Card Interface with SD card.
2268 The ARM Versatile baseboard is emulated with the following devices:
2272 ARM926E, ARM1136 or Cortex-A8 CPU
2274 PL190 Vectored Interrupt Controller
2278 SMC 91c111 Ethernet adapter
2280 PL110 LCD controller
2282 PL050 KMI with PS/2 keyboard and mouse.
2284 PCI host bridge. Note the emulated PCI bridge only provides access to
2285 PCI memory space. It does not provide access to PCI IO space.
2286 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2287 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2288 mapped control registers.
2290 PCI OHCI USB controller.
2292 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2294 PL181 MultiMedia Card Interface with SD card.
2297 The ARM RealView Emulation baseboard is emulated with the following devices:
2301 ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2303 ARM AMBA Generic/Distributed Interrupt Controller
2307 SMC 91c111 Ethernet adapter
2309 PL110 LCD controller
2311 PL050 KMI with PS/2 keyboard and mouse
2315 PCI OHCI USB controller
2317 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2319 PL181 MultiMedia Card Interface with SD card.
2322 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2323 and "Terrier") emulation includes the following peripherals:
2327 Intel PXA270 System-on-chip (ARM V5TE core)
2331 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2333 On-chip OHCI USB controller
2335 On-chip LCD controller
2337 On-chip Real Time Clock
2339 TI ADS7846 touchscreen controller on SSP bus
2341 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2343 GPIO-connected keyboard controller and LEDs
2345 Secure Digital card connected to PXA MMC/SD host
2349 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2352 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2357 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2359 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2361 On-chip LCD controller
2363 On-chip Real Time Clock
2365 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2366 CODEC, connected through MicroWire and I@math{^2}S busses
2368 GPIO-connected matrix keypad
2370 Secure Digital card connected to OMAP MMC/SD host
2375 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2382 64k Flash and 8k SRAM.
2384 Timers, UARTs, ADC and I@math{^2}C interface.
2386 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2389 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2396 256k Flash and 64k SRAM.
2398 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2400 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2403 A Linux 2.6 test image is available on the QEMU web site. More
2404 information is available in the QEMU mailing-list archive.
2406 @node ColdFire System emulator
2407 @section ColdFire System emulator
2409 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2410 The emulator is able to boot a uClinux kernel.
2412 The M5208EVB emulation includes the following devices:
2416 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2418 Three Two on-chip UARTs.
2420 Fast Ethernet Controller (FEC)
2423 The AN5206 emulation includes the following devices:
2427 MCF5206 ColdFire V2 Microprocessor.
2432 @node QEMU User space emulator
2433 @chapter QEMU User space emulator
2436 * Supported Operating Systems ::
2437 * Linux User space emulator::
2438 * Mac OS X/Darwin User space emulator ::
2441 @node Supported Operating Systems
2442 @section Supported Operating Systems
2444 The following OS are supported in user space emulation:
2448 Linux (referred as qemu-linux-user)
2450 Mac OS X/Darwin (referred as qemu-darwin-user)
2453 @node Linux User space emulator
2454 @section Linux User space emulator
2459 * Command line options::
2464 @subsection Quick Start
2466 In order to launch a Linux process, QEMU needs the process executable
2467 itself and all the target (x86) dynamic libraries used by it.
2471 @item On x86, you can just try to launch any process by using the native
2475 qemu-i386 -L / /bin/ls
2478 @code{-L /} tells that the x86 dynamic linker must be searched with a
2481 @item Since QEMU is also a linux process, you can launch qemu with
2482 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2485 qemu-i386 -L / qemu-i386 -L / /bin/ls
2488 @item On non x86 CPUs, you need first to download at least an x86 glibc
2489 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2490 @code{LD_LIBRARY_PATH} is not set:
2493 unset LD_LIBRARY_PATH
2496 Then you can launch the precompiled @file{ls} x86 executable:
2499 qemu-i386 tests/i386/ls
2501 You can look at @file{qemu-binfmt-conf.sh} so that
2502 QEMU is automatically launched by the Linux kernel when you try to
2503 launch x86 executables. It requires the @code{binfmt_misc} module in the
2506 @item The x86 version of QEMU is also included. You can try weird things such as:
2508 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2509 /usr/local/qemu-i386/bin/ls-i386
2515 @subsection Wine launch
2519 @item Ensure that you have a working QEMU with the x86 glibc
2520 distribution (see previous section). In order to verify it, you must be
2524 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2527 @item Download the binary x86 Wine install
2528 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2530 @item Configure Wine on your account. Look at the provided script
2531 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2532 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2534 @item Then you can try the example @file{putty.exe}:
2537 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2538 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2543 @node Command line options
2544 @subsection Command line options
2547 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2554 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2556 Set the x86 stack size in bytes (default=524288)
2563 Activate log (logfile=/tmp/qemu.log)
2565 Act as if the host page size was 'pagesize' bytes
2568 Environment variables:
2572 Print system calls and arguments similar to the 'strace' program
2573 (NOTE: the actual 'strace' program will not work because the user
2574 space emulator hasn't implemented ptrace). At the moment this is
2575 incomplete. All system calls that don't have a specific argument
2576 format are printed with information for six arguments. Many
2577 flag-style arguments don't have decoders and will show up as numbers.
2580 @node Other binaries
2581 @subsection Other binaries
2583 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2584 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2585 configurations), and arm-uclinux bFLT format binaries.
2587 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2588 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2589 coldfire uClinux bFLT format binaries.
2591 The binary format is detected automatically.
2593 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2594 (Sparc64 CPU, 32 bit ABI).
2596 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2597 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2599 @node Mac OS X/Darwin User space emulator
2600 @section Mac OS X/Darwin User space emulator
2603 * Mac OS X/Darwin Status::
2604 * Mac OS X/Darwin Quick Start::
2605 * Mac OS X/Darwin Command line options::
2608 @node Mac OS X/Darwin Status
2609 @subsection Mac OS X/Darwin Status
2613 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2615 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2617 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
2619 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2622 [1] If you're host commpage can be executed by qemu.
2624 @node Mac OS X/Darwin Quick Start
2625 @subsection Quick Start
2627 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2628 itself and all the target dynamic libraries used by it. If you don't have the FAT
2629 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2630 CD or compile them by hand.
2634 @item On x86, you can just try to launch any process by using the native
2641 or to run the ppc version of the executable:
2647 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2651 qemu-i386 -L /opt/x86_root/ /bin/ls
2654 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2655 @file{/opt/x86_root/usr/bin/dyld}.
2659 @node Mac OS X/Darwin Command line options
2660 @subsection Command line options
2663 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2670 Set the library root path (default=/)
2672 Set the stack size in bytes (default=524288)
2679 Activate log (logfile=/tmp/qemu.log)
2681 Act as if the host page size was 'pagesize' bytes
2685 @chapter Compilation from the sources
2690 * Cross compilation for Windows with Linux::
2697 @subsection Compilation
2699 First you must decompress the sources:
2702 tar zxvf qemu-x.y.z.tar.gz
2706 Then you configure QEMU and build it (usually no options are needed):
2712 Then type as root user:
2716 to install QEMU in @file{/usr/local}.
2718 @subsection GCC version
2720 In order to compile QEMU successfully, it is very important that you
2721 have the right tools. The most important one is gcc. On most hosts and
2722 in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2723 Linux distribution includes a gcc 4.x compiler, you can usually
2724 install an older version (it is invoked by @code{gcc32} or
2725 @code{gcc34}). The QEMU configure script automatically probes for
2726 these older versions so that usually you don't have to do anything.
2732 @item Install the current versions of MSYS and MinGW from
2733 @url{http://www.mingw.org/}. You can find detailed installation
2734 instructions in the download section and the FAQ.
2737 the MinGW development library of SDL 1.2.x
2738 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2739 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
2740 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2741 directory. Edit the @file{sdl-config} script so that it gives the
2742 correct SDL directory when invoked.
2744 @item Extract the current version of QEMU.
2746 @item Start the MSYS shell (file @file{msys.bat}).
2748 @item Change to the QEMU directory. Launch @file{./configure} and
2749 @file{make}. If you have problems using SDL, verify that
2750 @file{sdl-config} can be launched from the MSYS command line.
2752 @item You can install QEMU in @file{Program Files/Qemu} by typing
2753 @file{make install}. Don't forget to copy @file{SDL.dll} in
2754 @file{Program Files/Qemu}.
2758 @node Cross compilation for Windows with Linux
2759 @section Cross compilation for Windows with Linux
2763 Install the MinGW cross compilation tools available at
2764 @url{http://www.mingw.org/}.
2767 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2768 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2769 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2770 the QEMU configuration script.
2773 Configure QEMU for Windows cross compilation:
2775 ./configure --enable-mingw32
2777 If necessary, you can change the cross-prefix according to the prefix
2778 chosen for the MinGW tools with --cross-prefix. You can also use
2779 --prefix to set the Win32 install path.
2781 @item You can install QEMU in the installation directory by typing
2782 @file{make install}. Don't forget to copy @file{SDL.dll} in the
2783 installation directory.
2787 Note: Currently, Wine does not seem able to launch
2793 The Mac OS X patches are not fully merged in QEMU, so you should look
2794 at the QEMU mailing list archive to have all the necessary