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).
539 @item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
540 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
541 = 0 is the default). The NIC is an ne2k_pci by default on the PC
542 target. Optionally, the MAC address can be changed. If no
543 @option{-net} option is specified, a single NIC is created.
544 Qemu can emulate several different models of network card.
545 Valid values for @var{type} are
546 @code{i82551}, @code{i82557b}, @code{i82559er},
547 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
548 @code{smc91c111}, @code{lance} and @code{mcf_fec}.
549 Not all devices are supported on all targets. Use -net nic,model=?
550 for a list of available devices for your target.
552 @item -net user[,vlan=@var{n}][,hostname=@var{name}]
553 Use the user mode network stack which requires no administrator
554 privilege to run. @option{hostname=name} can be used to specify the client
555 hostname reported by the builtin DHCP server.
557 @item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}]
558 Connect the host TAP network interface @var{name} to VLAN @var{n} and
559 use the network script @var{file} to configure it. The default
560 network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
561 disable script execution. If @var{name} is not
562 provided, the OS automatically provides one. @option{fd}=@var{h} can be
563 used to specify the handle of an already opened host TAP interface. Example:
566 qemu linux.img -net nic -net tap
569 More complicated example (two NICs, each one connected to a TAP device)
571 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
572 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
576 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
578 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
579 machine using a TCP socket connection. If @option{listen} is
580 specified, QEMU waits for incoming connections on @var{port}
581 (@var{host} is optional). @option{connect} is used to connect to
582 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
583 specifies an already opened TCP socket.
587 # launch a first QEMU instance
588 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
589 -net socket,listen=:1234
590 # connect the VLAN 0 of this instance to the VLAN 0
591 # of the first instance
592 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
593 -net socket,connect=127.0.0.1:1234
596 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
598 Create a VLAN @var{n} shared with another QEMU virtual
599 machines using a UDP multicast socket, effectively making a bus for
600 every QEMU with same multicast address @var{maddr} and @var{port}.
604 Several QEMU can be running on different hosts and share same bus (assuming
605 correct multicast setup for these hosts).
607 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
608 @url{http://user-mode-linux.sf.net}.
610 Use @option{fd=h} to specify an already opened UDP multicast socket.
615 # launch one QEMU instance
616 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
617 -net socket,mcast=230.0.0.1:1234
618 # launch another QEMU instance on same "bus"
619 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
620 -net socket,mcast=230.0.0.1:1234
621 # launch yet another QEMU instance on same "bus"
622 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
623 -net socket,mcast=230.0.0.1:1234
626 Example (User Mode Linux compat.):
628 # launch QEMU instance (note mcast address selected
630 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
631 -net socket,mcast=239.192.168.1:1102
633 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
637 Indicate that no network devices should be configured. It is used to
638 override the default configuration (@option{-net nic -net user}) which
639 is activated if no @option{-net} options are provided.
641 @item -tftp @var{dir}
642 When using the user mode network stack, activate a built-in TFTP
643 server. The files in @var{dir} will be exposed as the root of a TFTP server.
644 The TFTP client on the guest must be configured in binary mode (use the command
645 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
648 @item -bootp @var{file}
649 When using the user mode network stack, broadcast @var{file} as the BOOTP
650 filename. In conjunction with @option{-tftp}, this can be used to network boot
651 a guest from a local directory.
653 Example (using pxelinux):
655 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
659 When using the user mode network stack, activate a built-in SMB
660 server so that Windows OSes can access to the host files in @file{@var{dir}}
663 In the guest Windows OS, the line:
667 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
668 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
670 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
672 Note that a SAMBA server must be installed on the host OS in
673 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
674 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
676 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
678 When using the user mode network stack, redirect incoming TCP or UDP
679 connections to the host port @var{host-port} to the guest
680 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
681 is not specified, its value is 10.0.2.15 (default address given by the
682 built-in DHCP server).
684 For example, to redirect host X11 connection from screen 1 to guest
685 screen 0, use the following:
689 qemu -redir tcp:6001::6000 [...]
690 # this host xterm should open in the guest X11 server
694 To redirect telnet connections from host port 5555 to telnet port on
695 the guest, use the following:
699 qemu -redir tcp:5555::23 [...]
700 telnet localhost 5555
703 Then when you use on the host @code{telnet localhost 5555}, you
704 connect to the guest telnet server.
708 Linux boot specific: When using these options, you can use a given
709 Linux kernel without installing it in the disk image. It can be useful
710 for easier testing of various kernels.
714 @item -kernel @var{bzImage}
715 Use @var{bzImage} as kernel image.
717 @item -append @var{cmdline}
718 Use @var{cmdline} as kernel command line
720 @item -initrd @var{file}
721 Use @var{file} as initial ram disk.
725 Debug/Expert options:
728 @item -serial @var{dev}
729 Redirect the virtual serial port to host character device
730 @var{dev}. The default device is @code{vc} in graphical mode and
731 @code{stdio} in non graphical mode.
733 This option can be used several times to simulate up to 4 serials
736 Use @code{-serial none} to disable all serial ports.
738 Available character devices are:
741 Virtual console. Optionally, a width and height can be given in pixel with
745 It is also possible to specify width or height in characters:
750 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
752 No device is allocated.
756 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
757 parameters are set according to the emulated ones.
758 @item /dev/parport@var{N}
759 [Linux only, parallel port only] Use host parallel port
760 @var{N}. Currently SPP and EPP parallel port features can be used.
761 @item file:@var{filename}
762 Write output to @var{filename}. No character can be read.
764 [Unix only] standard input/output
765 @item pipe:@var{filename}
766 name pipe @var{filename}
768 [Windows only] Use host serial port @var{n}
769 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
770 This implements UDP Net Console.
771 When @var{remote_host} or @var{src_ip} are not specified
772 they default to @code{0.0.0.0}.
773 When not using a specified @var{src_port} a random port is automatically chosen.
775 If you just want a simple readonly console you can use @code{netcat} or
776 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
777 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
778 will appear in the netconsole session.
780 If you plan to send characters back via netconsole or you want to stop
781 and start qemu a lot of times, you should have qemu use the same
782 source port each time by using something like @code{-serial
783 udp::4555@@:4556} to qemu. Another approach is to use a patched
784 version of netcat which can listen to a TCP port and send and receive
785 characters via udp. If you have a patched version of netcat which
786 activates telnet remote echo and single char transfer, then you can
787 use the following options to step up a netcat redirector to allow
788 telnet on port 5555 to access the qemu port.
791 -serial udp::4555@@:4556
792 @item netcat options:
793 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
794 @item telnet options:
799 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
800 The TCP Net Console has two modes of operation. It can send the serial
801 I/O to a location or wait for a connection from a location. By default
802 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
803 the @var{server} option QEMU will wait for a client socket application
804 to connect to the port before continuing, unless the @code{nowait}
805 option was specified. The @code{nodelay} option disables the Nagle buffering
806 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
807 one TCP connection at a time is accepted. You can use @code{telnet} to
808 connect to the corresponding character device.
810 @item Example to send tcp console to 192.168.0.2 port 4444
811 -serial tcp:192.168.0.2:4444
812 @item Example to listen and wait on port 4444 for connection
813 -serial tcp::4444,server
814 @item Example to not wait and listen on ip 192.168.0.100 port 4444
815 -serial tcp:192.168.0.100:4444,server,nowait
818 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
819 The telnet protocol is used instead of raw tcp sockets. The options
820 work the same as if you had specified @code{-serial tcp}. The
821 difference is that the port acts like a telnet server or client using
822 telnet option negotiation. This will also allow you to send the
823 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
824 sequence. Typically in unix telnet you do it with Control-] and then
825 type "send break" followed by pressing the enter key.
827 @item unix:@var{path}[,server][,nowait]
828 A unix domain socket is used instead of a tcp socket. The option works the
829 same as if you had specified @code{-serial tcp} except the unix domain socket
830 @var{path} is used for connections.
832 @item mon:@var{dev_string}
833 This is a special option to allow the monitor to be multiplexed onto
834 another serial port. The monitor is accessed with key sequence of
835 @key{Control-a} and then pressing @key{c}. See monitor access
836 @ref{pcsys_keys} in the -nographic section for more keys.
837 @var{dev_string} should be any one of the serial devices specified
838 above. An example to multiplex the monitor onto a telnet server
839 listening on port 4444 would be:
841 @item -serial mon:telnet::4444,server,nowait
846 @item -parallel @var{dev}
847 Redirect the virtual parallel port to host device @var{dev} (same
848 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
849 be used to use hardware devices connected on the corresponding host
852 This option can be used several times to simulate up to 3 parallel
855 Use @code{-parallel none} to disable all parallel ports.
857 @item -monitor @var{dev}
858 Redirect the monitor to host device @var{dev} (same devices as the
860 The default device is @code{vc} in graphical mode and @code{stdio} in
863 @item -echr numeric_ascii_value
864 Change the escape character used for switching to the monitor when using
865 monitor and serial sharing. The default is @code{0x01} when using the
866 @code{-nographic} option. @code{0x01} is equal to pressing
867 @code{Control-a}. You can select a different character from the ascii
868 control keys where 1 through 26 map to Control-a through Control-z. For
869 instance you could use the either of the following to change the escape
870 character to Control-t.
877 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
879 Change gdb connection port. @var{port} can be either a decimal number
880 to specify a TCP port, or a host device (same devices as the serial port).
882 Do not start CPU at startup (you must type 'c' in the monitor).
884 Output log in /tmp/qemu.log
885 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
886 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
887 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
888 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
889 all those parameters. This option is useful for old MS-DOS disk
893 Set the directory for the BIOS, VGA BIOS and keymaps.
896 Simulate a standard VGA card with Bochs VBE extensions (default is
897 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
898 VBE extensions (e.g. Windows XP) and if you want to use high
899 resolution modes (>= 1280x1024x16) then you should use this option.
902 Disable ACPI (Advanced Configuration and Power Interface) support. Use
903 it if your guest OS complains about ACPI problems (PC target machine
907 Exit instead of rebooting.
910 Start right away with a saved state (@code{loadvm} in monitor)
913 Enable semihosting syscall emulation (ARM and M68K target machines only).
915 On ARM this implements the "Angel" interface.
916 On M68K this implements the "ColdFire GDB" interface used by libgloss.
918 Note that this allows guest direct access to the host filesystem,
919 so should only be used with trusted guest OS.
929 During the graphical emulation, you can use the following keys:
935 Switch to virtual console 'n'. Standard console mappings are:
938 Target system display
946 Toggle mouse and keyboard grab.
949 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
950 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
952 During emulation, if you are using the @option{-nographic} option, use
953 @key{Ctrl-a h} to get terminal commands:
961 Save disk data back to file (if -snapshot)
963 toggle console timestamps
965 Send break (magic sysrq in Linux)
967 Switch between console and monitor
976 The HTML documentation of QEMU for more precise information and Linux
977 user mode emulator invocation.
987 @section QEMU Monitor
989 The QEMU monitor is used to give complex commands to the QEMU
990 emulator. You can use it to:
995 Remove or insert removable media images
996 (such as CD-ROM or floppies).
999 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
1002 @item Inspect the VM state without an external debugger.
1006 @subsection Commands
1008 The following commands are available:
1012 @item help or ? [@var{cmd}]
1013 Show the help for all commands or just for command @var{cmd}.
1016 Commit changes to the disk images (if -snapshot is used).
1018 @item info @var{subcommand}
1019 Show various information about the system state.
1023 show the various VLANs and the associated devices
1025 show the block devices
1026 @item info registers
1027 show the cpu registers
1029 show the command line history
1031 show emulated PCI device
1033 show USB devices plugged on the virtual USB hub
1035 show all USB host devices
1037 show information about active capturing
1038 @item info snapshots
1039 show list of VM snapshots
1041 show which guest mouse is receiving events
1047 @item eject [-f] @var{device}
1048 Eject a removable medium (use -f to force it).
1050 @item change @var{device} @var{setting}
1052 Change the configuration of a device.
1055 @item change @var{diskdevice} @var{filename}
1056 Change the medium for a removable disk device to point to @var{filename}. eg
1059 (qemu) change cdrom /path/to/some.iso
1062 @item change vnc @var{display},@var{options}
1063 Change the configuration of the VNC server. The valid syntax for @var{display}
1064 and @var{options} are described at @ref{sec_invocation}. eg
1067 (qemu) change vnc localhost:1
1070 @item change vnc password
1072 Change the password associated with the VNC server. The monitor will prompt for
1073 the new password to be entered. VNC passwords are only significant upto 8 letters.
1077 (qemu) change vnc password
1083 @item screendump @var{filename}
1084 Save screen into PPM image @var{filename}.
1086 @item mouse_move @var{dx} @var{dy} [@var{dz}]
1087 Move the active mouse to the specified coordinates @var{dx} @var{dy}
1088 with optional scroll axis @var{dz}.
1090 @item mouse_button @var{val}
1091 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
1093 @item mouse_set @var{index}
1094 Set which mouse device receives events at given @var{index}, index
1095 can be obtained with
1100 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
1101 Capture audio into @var{filename}. Using sample rate @var{frequency}
1102 bits per sample @var{bits} and number of channels @var{channels}.
1106 @item Sample rate = 44100 Hz - CD quality
1108 @item Number of channels = 2 - Stereo
1111 @item stopcapture @var{index}
1112 Stop capture with a given @var{index}, index can be obtained with
1117 @item log @var{item1}[,...]
1118 Activate logging of the specified items to @file{/tmp/qemu.log}.
1120 @item savevm [@var{tag}|@var{id}]
1121 Create a snapshot of the whole virtual machine. If @var{tag} is
1122 provided, it is used as human readable identifier. If there is already
1123 a snapshot with the same tag or ID, it is replaced. More info at
1126 @item loadvm @var{tag}|@var{id}
1127 Set the whole virtual machine to the snapshot identified by the tag
1128 @var{tag} or the unique snapshot ID @var{id}.
1130 @item delvm @var{tag}|@var{id}
1131 Delete the snapshot identified by @var{tag} or @var{id}.
1139 @item gdbserver [@var{port}]
1140 Start gdbserver session (default @var{port}=1234)
1142 @item x/fmt @var{addr}
1143 Virtual memory dump starting at @var{addr}.
1145 @item xp /@var{fmt} @var{addr}
1146 Physical memory dump starting at @var{addr}.
1148 @var{fmt} is a format which tells the command how to format the
1149 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1153 is the number of items to be dumped.
1156 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
1157 c (char) or i (asm instruction).
1160 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1161 @code{h} or @code{w} can be specified with the @code{i} format to
1162 respectively select 16 or 32 bit code instruction size.
1169 Dump 10 instructions at the current instruction pointer:
1174 0x90107065: lea 0x0(%esi,1),%esi
1175 0x90107069: lea 0x0(%edi,1),%edi
1177 0x90107071: jmp 0x90107080
1185 Dump 80 16 bit values at the start of the video memory.
1187 (qemu) xp/80hx 0xb8000
1188 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
1189 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
1190 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
1191 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
1192 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
1193 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
1194 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1195 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1196 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1197 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1201 @item p or print/@var{fmt} @var{expr}
1203 Print expression value. Only the @var{format} part of @var{fmt} is
1206 @item sendkey @var{keys}
1208 Send @var{keys} to the emulator. Use @code{-} to press several keys
1209 simultaneously. Example:
1214 This command is useful to send keys that your graphical user interface
1215 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1221 @item usb_add @var{devname}
1223 Add the USB device @var{devname}. For details of available devices see
1226 @item usb_del @var{devname}
1228 Remove the USB device @var{devname} from the QEMU virtual USB
1229 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1230 command @code{info usb} to see the devices you can remove.
1234 @subsection Integer expressions
1236 The monitor understands integers expressions for every integer
1237 argument. You can use register names to get the value of specifics
1238 CPU registers by prefixing them with @emph{$}.
1241 @section Disk Images
1243 Since version 0.6.1, QEMU supports many disk image formats, including
1244 growable disk images (their size increase as non empty sectors are
1245 written), compressed and encrypted disk images. Version 0.8.3 added
1246 the new qcow2 disk image format which is essential to support VM
1250 * disk_images_quickstart:: Quick start for disk image creation
1251 * disk_images_snapshot_mode:: Snapshot mode
1252 * vm_snapshots:: VM snapshots
1253 * qemu_img_invocation:: qemu-img Invocation
1254 * host_drives:: Using host drives
1255 * disk_images_fat_images:: Virtual FAT disk images
1258 @node disk_images_quickstart
1259 @subsection Quick start for disk image creation
1261 You can create a disk image with the command:
1263 qemu-img create myimage.img mysize
1265 where @var{myimage.img} is the disk image filename and @var{mysize} is its
1266 size in kilobytes. You can add an @code{M} suffix to give the size in
1267 megabytes and a @code{G} suffix for gigabytes.
1269 See @ref{qemu_img_invocation} for more information.
1271 @node disk_images_snapshot_mode
1272 @subsection Snapshot mode
1274 If you use the option @option{-snapshot}, all disk images are
1275 considered as read only. When sectors in written, they are written in
1276 a temporary file created in @file{/tmp}. You can however force the
1277 write back to the raw disk images by using the @code{commit} monitor
1278 command (or @key{C-a s} in the serial console).
1281 @subsection VM snapshots
1283 VM snapshots are snapshots of the complete virtual machine including
1284 CPU state, RAM, device state and the content of all the writable
1285 disks. In order to use VM snapshots, you must have at least one non
1286 removable and writable block device using the @code{qcow2} disk image
1287 format. Normally this device is the first virtual hard drive.
1289 Use the monitor command @code{savevm} to create a new VM snapshot or
1290 replace an existing one. A human readable name can be assigned to each
1291 snapshot in addition to its numerical ID.
1293 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1294 a VM snapshot. @code{info snapshots} lists the available snapshots
1295 with their associated information:
1298 (qemu) info snapshots
1299 Snapshot devices: hda
1300 Snapshot list (from hda):
1301 ID TAG VM SIZE DATE VM CLOCK
1302 1 start 41M 2006-08-06 12:38:02 00:00:14.954
1303 2 40M 2006-08-06 12:43:29 00:00:18.633
1304 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
1307 A VM snapshot is made of a VM state info (its size is shown in
1308 @code{info snapshots}) and a snapshot of every writable disk image.
1309 The VM state info is stored in the first @code{qcow2} non removable
1310 and writable block device. The disk image snapshots are stored in
1311 every disk image. The size of a snapshot in a disk image is difficult
1312 to evaluate and is not shown by @code{info snapshots} because the
1313 associated disk sectors are shared among all the snapshots to save
1314 disk space (otherwise each snapshot would need a full copy of all the
1317 When using the (unrelated) @code{-snapshot} option
1318 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1319 but they are deleted as soon as you exit QEMU.
1321 VM snapshots currently have the following known limitations:
1324 They cannot cope with removable devices if they are removed or
1325 inserted after a snapshot is done.
1327 A few device drivers still have incomplete snapshot support so their
1328 state is not saved or restored properly (in particular USB).
1331 @node qemu_img_invocation
1332 @subsection @code{qemu-img} Invocation
1334 @include qemu-img.texi
1337 @subsection Using host drives
1339 In addition to disk image files, QEMU can directly access host
1340 devices. We describe here the usage for QEMU version >= 0.8.3.
1342 @subsubsection Linux
1344 On Linux, you can directly use the host device filename instead of a
1345 disk image filename provided you have enough privileges to access
1346 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1347 @file{/dev/fd0} for the floppy.
1351 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1352 specific code to detect CDROM insertion or removal. CDROM ejection by
1353 the guest OS is supported. Currently only data CDs are supported.
1355 You can specify a floppy device even if no floppy is loaded. Floppy
1356 removal is currently not detected accurately (if you change floppy
1357 without doing floppy access while the floppy is not loaded, the guest
1358 OS will think that the same floppy is loaded).
1360 Hard disks can be used. Normally you must specify the whole disk
1361 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1362 see it as a partitioned disk. WARNING: unless you know what you do, it
1363 is better to only make READ-ONLY accesses to the hard disk otherwise
1364 you may corrupt your host data (use the @option{-snapshot} command
1365 line option or modify the device permissions accordingly).
1368 @subsubsection Windows
1372 The preferred syntax is the drive letter (e.g. @file{d:}). The
1373 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1374 supported as an alias to the first CDROM drive.
1376 Currently there is no specific code to handle removable media, so it
1377 is better to use the @code{change} or @code{eject} monitor commands to
1378 change or eject media.
1380 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1381 where @var{N} is the drive number (0 is the first hard disk).
1383 WARNING: unless you know what you do, it is better to only make
1384 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1385 host data (use the @option{-snapshot} command line so that the
1386 modifications are written in a temporary file).
1390 @subsubsection Mac OS X
1392 @file{/dev/cdrom} is an alias to the first CDROM.
1394 Currently there is no specific code to handle removable media, so it
1395 is better to use the @code{change} or @code{eject} monitor commands to
1396 change or eject media.
1398 @node disk_images_fat_images
1399 @subsection Virtual FAT disk images
1401 QEMU can automatically create a virtual FAT disk image from a
1402 directory tree. In order to use it, just type:
1405 qemu linux.img -hdb fat:/my_directory
1408 Then you access access to all the files in the @file{/my_directory}
1409 directory without having to copy them in a disk image or to export
1410 them via SAMBA or NFS. The default access is @emph{read-only}.
1412 Floppies can be emulated with the @code{:floppy:} option:
1415 qemu linux.img -fda fat:floppy:/my_directory
1418 A read/write support is available for testing (beta stage) with the
1422 qemu linux.img -fda fat:floppy:rw:/my_directory
1425 What you should @emph{never} do:
1427 @item use non-ASCII filenames ;
1428 @item use "-snapshot" together with ":rw:" ;
1429 @item expect it to work when loadvm'ing ;
1430 @item write to the FAT directory on the host system while accessing it with the guest system.
1434 @section Network emulation
1436 QEMU can simulate several network cards (PCI or ISA cards on the PC
1437 target) and can connect them to an arbitrary number of Virtual Local
1438 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1439 VLAN. VLAN can be connected between separate instances of QEMU to
1440 simulate large networks. For simpler usage, a non privileged user mode
1441 network stack can replace the TAP device to have a basic network
1446 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1447 connection between several network devices. These devices can be for
1448 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1451 @subsection Using TAP network interfaces
1453 This is the standard way to connect QEMU to a real network. QEMU adds
1454 a virtual network device on your host (called @code{tapN}), and you
1455 can then configure it as if it was a real ethernet card.
1457 @subsubsection Linux host
1459 As an example, you can download the @file{linux-test-xxx.tar.gz}
1460 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1461 configure properly @code{sudo} so that the command @code{ifconfig}
1462 contained in @file{qemu-ifup} can be executed as root. You must verify
1463 that your host kernel supports the TAP network interfaces: the
1464 device @file{/dev/net/tun} must be present.
1466 See @ref{sec_invocation} to have examples of command lines using the
1467 TAP network interfaces.
1469 @subsubsection Windows host
1471 There is a virtual ethernet driver for Windows 2000/XP systems, called
1472 TAP-Win32. But it is not included in standard QEMU for Windows,
1473 so you will need to get it separately. It is part of OpenVPN package,
1474 so download OpenVPN from : @url{http://openvpn.net/}.
1476 @subsection Using the user mode network stack
1478 By using the option @option{-net user} (default configuration if no
1479 @option{-net} option is specified), QEMU uses a completely user mode
1480 network stack (you don't need root privilege to use the virtual
1481 network). The virtual network configuration is the following:
1485 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1488 ----> DNS server (10.0.2.3)
1490 ----> SMB server (10.0.2.4)
1493 The QEMU VM behaves as if it was behind a firewall which blocks all
1494 incoming connections. You can use a DHCP client to automatically
1495 configure the network in the QEMU VM. The DHCP server assign addresses
1496 to the hosts starting from 10.0.2.15.
1498 In order to check that the user mode network is working, you can ping
1499 the address 10.0.2.2 and verify that you got an address in the range
1500 10.0.2.x from the QEMU virtual DHCP server.
1502 Note that @code{ping} is not supported reliably to the internet as it
1503 would require root privileges. It means you can only ping the local
1506 When using the built-in TFTP server, the router is also the TFTP
1509 When using the @option{-redir} option, TCP or UDP connections can be
1510 redirected from the host to the guest. It allows for example to
1511 redirect X11, telnet or SSH connections.
1513 @subsection Connecting VLANs between QEMU instances
1515 Using the @option{-net socket} option, it is possible to make VLANs
1516 that span several QEMU instances. See @ref{sec_invocation} to have a
1519 @node direct_linux_boot
1520 @section Direct Linux Boot
1522 This section explains how to launch a Linux kernel inside QEMU without
1523 having to make a full bootable image. It is very useful for fast Linux
1528 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1531 Use @option{-kernel} to provide the Linux kernel image and
1532 @option{-append} to give the kernel command line arguments. The
1533 @option{-initrd} option can be used to provide an INITRD image.
1535 When using the direct Linux boot, a disk image for the first hard disk
1536 @file{hda} is required because its boot sector is used to launch the
1539 If you do not need graphical output, you can disable it and redirect
1540 the virtual serial port and the QEMU monitor to the console with the
1541 @option{-nographic} option. The typical command line is:
1543 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1544 -append "root=/dev/hda console=ttyS0" -nographic
1547 Use @key{Ctrl-a c} to switch between the serial console and the
1548 monitor (@pxref{pcsys_keys}).
1551 @section USB emulation
1553 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1554 virtual USB devices or real host USB devices (experimental, works only
1555 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1556 as necessary to connect multiple USB devices.
1560 * host_usb_devices::
1563 @subsection Connecting USB devices
1565 USB devices can be connected with the @option{-usbdevice} commandline option
1566 or the @code{usb_add} monitor command. Available devices are:
1570 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1572 Pointer device that uses absolute coordinates (like a touchscreen).
1573 This means qemu is able to report the mouse position without having
1574 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1575 @item @code{disk:@var{file}}
1576 Mass storage device based on @var{file} (@pxref{disk_images})
1577 @item @code{host:@var{bus.addr}}
1578 Pass through the host device identified by @var{bus.addr}
1580 @item @code{host:@var{vendor_id:product_id}}
1581 Pass through the host device identified by @var{vendor_id:product_id}
1583 @item @code{wacom-tablet}
1584 Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet}
1585 above but it can be used with the tslib library because in addition to touch
1586 coordinates it reports touch pressure.
1587 @item @code{keyboard}
1588 Standard USB keyboard. Will override the PS/2 keyboard (if present).
1591 @node host_usb_devices
1592 @subsection Using host USB devices on a Linux host
1594 WARNING: this is an experimental feature. QEMU will slow down when
1595 using it. USB devices requiring real time streaming (i.e. USB Video
1596 Cameras) are not supported yet.
1599 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1600 is actually using the USB device. A simple way to do that is simply to
1601 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1602 to @file{mydriver.o.disabled}.
1604 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1610 @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:
1612 chown -R myuid /proc/bus/usb
1615 @item Launch QEMU and do in the monitor:
1618 Device 1.2, speed 480 Mb/s
1619 Class 00: USB device 1234:5678, USB DISK
1621 You should see the list of the devices you can use (Never try to use
1622 hubs, it won't work).
1624 @item Add the device in QEMU by using:
1626 usb_add host:1234:5678
1629 Normally the guest OS should report that a new USB device is
1630 plugged. You can use the option @option{-usbdevice} to do the same.
1632 @item Now you can try to use the host USB device in QEMU.
1636 When relaunching QEMU, you may have to unplug and plug again the USB
1637 device to make it work again (this is a bug).
1640 @section VNC security
1642 The VNC server capability provides access to the graphical console
1643 of the guest VM across the network. This has a number of security
1644 considerations depending on the deployment scenarios.
1648 * vnc_sec_password::
1649 * vnc_sec_certificate::
1650 * vnc_sec_certificate_verify::
1651 * vnc_sec_certificate_pw::
1652 * vnc_generate_cert::
1655 @subsection Without passwords
1657 The simplest VNC server setup does not include any form of authentication.
1658 For this setup it is recommended to restrict it to listen on a UNIX domain
1659 socket only. For example
1662 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1665 This ensures that only users on local box with read/write access to that
1666 path can access the VNC server. To securely access the VNC server from a
1667 remote machine, a combination of netcat+ssh can be used to provide a secure
1670 @node vnc_sec_password
1671 @subsection With passwords
1673 The VNC protocol has limited support for password based authentication. Since
1674 the protocol limits passwords to 8 characters it should not be considered
1675 to provide high security. The password can be fairly easily brute-forced by
1676 a client making repeat connections. For this reason, a VNC server using password
1677 authentication should be restricted to only listen on the loopback interface
1678 or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
1679 option, and then once QEMU is running the password is set with the monitor. Until
1680 the monitor is used to set the password all clients will be rejected.
1683 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1684 (qemu) change vnc password
1689 @node vnc_sec_certificate
1690 @subsection With x509 certificates
1692 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1693 TLS for encryption of the session, and x509 certificates for authentication.
1694 The use of x509 certificates is strongly recommended, because TLS on its
1695 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1696 support provides a secure session, but no authentication. This allows any
1697 client to connect, and provides an encrypted session.
1700 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1703 In the above example @code{/etc/pki/qemu} should contain at least three files,
1704 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1705 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1706 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1707 only be readable by the user owning it.
1709 @node vnc_sec_certificate_verify
1710 @subsection With x509 certificates and client verification
1712 Certificates can also provide a means to authenticate the client connecting.
1713 The server will request that the client provide a certificate, which it will
1714 then validate against the CA certificate. This is a good choice if deploying
1715 in an environment with a private internal certificate authority.
1718 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1722 @node vnc_sec_certificate_pw
1723 @subsection With x509 certificates, client verification and passwords
1725 Finally, the previous method can be combined with VNC password authentication
1726 to provide two layers of authentication for clients.
1729 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1730 (qemu) change vnc password
1735 @node vnc_generate_cert
1736 @subsection Generating certificates for VNC
1738 The GNU TLS packages provides a command called @code{certtool} which can
1739 be used to generate certificates and keys in PEM format. At a minimum it
1740 is neccessary to setup a certificate authority, and issue certificates to
1741 each server. If using certificates for authentication, then each client
1742 will also need to be issued a certificate. The recommendation is for the
1743 server to keep its certificates in either @code{/etc/pki/qemu} or for
1744 unprivileged users in @code{$HOME/.pki/qemu}.
1748 * vnc_generate_server::
1749 * vnc_generate_client::
1751 @node vnc_generate_ca
1752 @subsubsection Setup the Certificate Authority
1754 This step only needs to be performed once per organization / organizational
1755 unit. First the CA needs a private key. This key must be kept VERY secret
1756 and secure. If this key is compromised the entire trust chain of the certificates
1757 issued with it is lost.
1760 # certtool --generate-privkey > ca-key.pem
1763 A CA needs to have a public certificate. For simplicity it can be a self-signed
1764 certificate, or one issue by a commercial certificate issuing authority. To
1765 generate a self-signed certificate requires one core piece of information, the
1766 name of the organization.
1769 # cat > ca.info <<EOF
1770 cn = Name of your organization
1774 # certtool --generate-self-signed \
1775 --load-privkey ca-key.pem
1776 --template ca.info \
1777 --outfile ca-cert.pem
1780 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1781 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1783 @node vnc_generate_server
1784 @subsubsection Issuing server certificates
1786 Each server (or host) needs to be issued with a key and certificate. When connecting
1787 the certificate is sent to the client which validates it against the CA certificate.
1788 The core piece of information for a server certificate is the hostname. This should
1789 be the fully qualified hostname that the client will connect with, since the client
1790 will typically also verify the hostname in the certificate. On the host holding the
1791 secure CA private key:
1794 # cat > server.info <<EOF
1795 organization = Name of your organization
1796 cn = server.foo.example.com
1801 # certtool --generate-privkey > server-key.pem
1802 # certtool --generate-certificate \
1803 --load-ca-certificate ca-cert.pem \
1804 --load-ca-privkey ca-key.pem \
1805 --load-privkey server server-key.pem \
1806 --template server.info \
1807 --outfile server-cert.pem
1810 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1811 to the server for which they were generated. The @code{server-key.pem} is security
1812 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1814 @node vnc_generate_client
1815 @subsubsection Issuing client certificates
1817 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1818 certificates as its authentication mechanism, each client also needs to be issued
1819 a certificate. The client certificate contains enough metadata to uniquely identify
1820 the client, typically organization, state, city, building, etc. On the host holding
1821 the secure CA private key:
1824 # cat > client.info <<EOF
1828 organiazation = Name of your organization
1829 cn = client.foo.example.com
1834 # certtool --generate-privkey > client-key.pem
1835 # certtool --generate-certificate \
1836 --load-ca-certificate ca-cert.pem \
1837 --load-ca-privkey ca-key.pem \
1838 --load-privkey client-key.pem \
1839 --template client.info \
1840 --outfile client-cert.pem
1843 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1844 copied to the client for which they were generated.
1849 QEMU has a primitive support to work with gdb, so that you can do
1850 'Ctrl-C' while the virtual machine is running and inspect its state.
1852 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1855 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1856 -append "root=/dev/hda"
1857 Connected to host network interface: tun0
1858 Waiting gdb connection on port 1234
1861 Then launch gdb on the 'vmlinux' executable:
1866 In gdb, connect to QEMU:
1868 (gdb) target remote localhost:1234
1871 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1876 Here are some useful tips in order to use gdb on system code:
1880 Use @code{info reg} to display all the CPU registers.
1882 Use @code{x/10i $eip} to display the code at the PC position.
1884 Use @code{set architecture i8086} to dump 16 bit code. Then use
1885 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1888 @node pcsys_os_specific
1889 @section Target OS specific information
1893 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1894 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1895 color depth in the guest and the host OS.
1897 When using a 2.6 guest Linux kernel, you should add the option
1898 @code{clock=pit} on the kernel command line because the 2.6 Linux
1899 kernels make very strict real time clock checks by default that QEMU
1900 cannot simulate exactly.
1902 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1903 not activated because QEMU is slower with this patch. The QEMU
1904 Accelerator Module is also much slower in this case. Earlier Fedora
1905 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1906 patch by default. Newer kernels don't have it.
1910 If you have a slow host, using Windows 95 is better as it gives the
1911 best speed. Windows 2000 is also a good choice.
1913 @subsubsection SVGA graphic modes support
1915 QEMU emulates a Cirrus Logic GD5446 Video
1916 card. All Windows versions starting from Windows 95 should recognize
1917 and use this graphic card. For optimal performances, use 16 bit color
1918 depth in the guest and the host OS.
1920 If you are using Windows XP as guest OS and if you want to use high
1921 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1922 1280x1024x16), then you should use the VESA VBE virtual graphic card
1923 (option @option{-std-vga}).
1925 @subsubsection CPU usage reduction
1927 Windows 9x does not correctly use the CPU HLT
1928 instruction. The result is that it takes host CPU cycles even when
1929 idle. You can install the utility from
1930 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1931 problem. Note that no such tool is needed for NT, 2000 or XP.
1933 @subsubsection Windows 2000 disk full problem
1935 Windows 2000 has a bug which gives a disk full problem during its
1936 installation. When installing it, use the @option{-win2k-hack} QEMU
1937 option to enable a specific workaround. After Windows 2000 is
1938 installed, you no longer need this option (this option slows down the
1941 @subsubsection Windows 2000 shutdown
1943 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1944 can. It comes from the fact that Windows 2000 does not automatically
1945 use the APM driver provided by the BIOS.
1947 In order to correct that, do the following (thanks to Struan
1948 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1949 Add/Troubleshoot a device => Add a new device & Next => No, select the
1950 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1951 (again) a few times. Now the driver is installed and Windows 2000 now
1952 correctly instructs QEMU to shutdown at the appropriate moment.
1954 @subsubsection Share a directory between Unix and Windows
1956 See @ref{sec_invocation} about the help of the option @option{-smb}.
1958 @subsubsection Windows XP security problem
1960 Some releases of Windows XP install correctly but give a security
1963 A problem is preventing Windows from accurately checking the
1964 license for this computer. Error code: 0x800703e6.
1967 The workaround is to install a service pack for XP after a boot in safe
1968 mode. Then reboot, and the problem should go away. Since there is no
1969 network while in safe mode, its recommended to download the full
1970 installation of SP1 or SP2 and transfer that via an ISO or using the
1971 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1973 @subsection MS-DOS and FreeDOS
1975 @subsubsection CPU usage reduction
1977 DOS does not correctly use the CPU HLT instruction. The result is that
1978 it takes host CPU cycles even when idle. You can install the utility
1979 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1982 @node QEMU System emulator for non PC targets
1983 @chapter QEMU System emulator for non PC targets
1985 QEMU is a generic emulator and it emulates many non PC
1986 machines. Most of the options are similar to the PC emulator. The
1987 differences are mentioned in the following sections.
1990 * QEMU PowerPC System emulator::
1991 * Sparc32 System emulator::
1992 * Sparc64 System emulator::
1993 * MIPS System emulator::
1994 * ARM System emulator::
1995 * ColdFire System emulator::
1998 @node QEMU PowerPC System emulator
1999 @section QEMU PowerPC System emulator
2001 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
2002 or PowerMac PowerPC system.
2004 QEMU emulates the following PowerMac peripherals:
2010 PCI VGA compatible card with VESA Bochs Extensions
2012 2 PMAC IDE interfaces with hard disk and CD-ROM support
2018 VIA-CUDA with ADB keyboard and mouse.
2021 QEMU emulates the following PREP peripherals:
2027 PCI VGA compatible card with VESA Bochs Extensions
2029 2 IDE interfaces with hard disk and CD-ROM support
2033 NE2000 network adapters
2037 PREP Non Volatile RAM
2039 PC compatible keyboard and mouse.
2042 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2043 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2045 @c man begin OPTIONS
2047 The following options are specific to the PowerPC emulation:
2051 @item -g WxH[xDEPTH]
2053 Set the initial VGA graphic mode. The default is 800x600x15.
2060 More information is available at
2061 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2063 @node Sparc32 System emulator
2064 @section Sparc32 System emulator
2066 Use the executable @file{qemu-system-sparc} to simulate a SPARCstation
2067 5, SPARCstation 10, SPARCstation 20, SPARCserver 600MP (sun4m
2068 architecture), SPARCstation 2 (sun4c architecture), SPARCserver 1000,
2069 or SPARCcenter 2000 (sun4d architecture). The emulation is somewhat
2070 complete. SMP up to 16 CPUs is supported, but Linux limits the number
2071 of usable CPUs to 4.
2073 QEMU emulates the following sun4m/sun4d peripherals:
2081 Lance (Am7990) Ethernet
2083 Non Volatile RAM M48T08
2085 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2086 and power/reset logic
2088 ESP SCSI controller with hard disk and CD-ROM support
2090 Floppy drive (not on SS-600MP)
2092 CS4231 sound device (only on SS-5, not working yet)
2095 The number of peripherals is fixed in the architecture. Maximum
2096 memory size depends on the machine type, for SS-5 it is 256MB and for
2099 Since version 0.8.2, QEMU uses OpenBIOS
2100 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2101 firmware implementation. The goal is to implement a 100% IEEE
2102 1275-1994 (referred to as Open Firmware) compliant firmware.
2104 A sample Linux 2.6 series kernel and ram disk image are available on
2105 the QEMU web site. Please note that currently NetBSD, OpenBSD or
2106 Solaris kernels don't work.
2108 @c man begin OPTIONS
2110 The following options are specific to the Sparc32 emulation:
2114 @item -g WxHx[xDEPTH]
2116 Set the initial TCX graphic mode. The default is 1024x768x8, currently
2117 the only other possible mode is 1024x768x24.
2119 @item -prom-env string
2121 Set OpenBIOS variables in NVRAM, for example:
2124 qemu-system-sparc -prom-env 'auto-boot?=false' \
2125 -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2128 @item -M [SS-5|SS-10|SS-20|SS-600MP|SS-2|SS-1000|SS-2000]
2130 Set the emulated machine type. Default is SS-5.
2136 @node Sparc64 System emulator
2137 @section Sparc64 System emulator
2139 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
2140 The emulator is not usable for anything yet.
2142 QEMU emulates the following sun4u peripherals:
2146 UltraSparc IIi APB PCI Bridge
2148 PCI VGA compatible card with VESA Bochs Extensions
2150 Non Volatile RAM M48T59
2152 PC-compatible serial ports
2155 @node MIPS System emulator
2156 @section MIPS System emulator
2158 Four executables cover simulation of 32 and 64-bit MIPS systems in
2159 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2160 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2161 Four different machine types are emulated:
2165 A generic ISA PC-like machine "mips"
2167 The MIPS Malta prototype board "malta"
2169 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2171 MIPS emulator pseudo board "mipssim"
2174 The generic emulation is supported by Debian 'Etch' and is able to
2175 install Debian into a virtual disk image. The following devices are
2180 A range of MIPS CPUs, default is the 24Kf
2182 PC style serial port
2189 The Malta emulation supports the following devices:
2193 Core board with MIPS 24Kf CPU and Galileo system controller
2195 PIIX4 PCI/USB/SMbus controller
2197 The Multi-I/O chip's serial device
2199 PCnet32 PCI network card
2201 Malta FPGA serial device
2203 Cirrus VGA graphics card
2206 The ACER Pica emulation supports:
2212 PC-style IRQ and DMA controllers
2219 The mipssim pseudo board emulation provides an environment similiar
2220 to what the proprietary MIPS emulator uses for running Linux.
2225 A range of MIPS CPUs, default is the 24Kf
2227 PC style serial port
2229 MIPSnet network emulation
2232 @node ARM System emulator
2233 @section ARM System emulator
2235 Use the executable @file{qemu-system-arm} to simulate a ARM
2236 machine. The ARM Integrator/CP board is emulated with the following
2241 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2245 SMC 91c111 Ethernet adapter
2247 PL110 LCD controller
2249 PL050 KMI with PS/2 keyboard and mouse.
2251 PL181 MultiMedia Card Interface with SD card.
2254 The ARM Versatile baseboard is emulated with the following devices:
2258 ARM926E, ARM1136 or Cortex-A8 CPU
2260 PL190 Vectored Interrupt Controller
2264 SMC 91c111 Ethernet adapter
2266 PL110 LCD controller
2268 PL050 KMI with PS/2 keyboard and mouse.
2270 PCI host bridge. Note the emulated PCI bridge only provides access to
2271 PCI memory space. It does not provide access to PCI IO space.
2272 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2273 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2274 mapped control registers.
2276 PCI OHCI USB controller.
2278 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2280 PL181 MultiMedia Card Interface with SD card.
2283 The ARM RealView Emulation baseboard is emulated with the following devices:
2287 ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2289 ARM AMBA Generic/Distributed Interrupt Controller
2293 SMC 91c111 Ethernet adapter
2295 PL110 LCD controller
2297 PL050 KMI with PS/2 keyboard and mouse
2301 PCI OHCI USB controller
2303 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2305 PL181 MultiMedia Card Interface with SD card.
2308 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2309 and "Terrier") emulation includes the following peripherals:
2313 Intel PXA270 System-on-chip (ARM V5TE core)
2317 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2319 On-chip OHCI USB controller
2321 On-chip LCD controller
2323 On-chip Real Time Clock
2325 TI ADS7846 touchscreen controller on SSP bus
2327 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2329 GPIO-connected keyboard controller and LEDs
2331 Secure Digital card connected to PXA MMC/SD host
2335 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2338 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2343 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2345 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2347 On-chip LCD controller
2349 On-chip Real Time Clock
2351 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2352 CODEC, connected through MicroWire and I@math{^2}S busses
2354 GPIO-connected matrix keypad
2356 Secure Digital card connected to OMAP MMC/SD host
2361 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2368 64k Flash and 8k SRAM.
2370 Timers, UARTs, ADC and I@math{^2}C interface.
2372 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2375 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2382 256k Flash and 64k SRAM.
2384 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2386 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2389 A Linux 2.6 test image is available on the QEMU web site. More
2390 information is available in the QEMU mailing-list archive.
2392 @node ColdFire System emulator
2393 @section ColdFire System emulator
2395 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2396 The emulator is able to boot a uClinux kernel.
2398 The M5208EVB emulation includes the following devices:
2402 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2404 Three Two on-chip UARTs.
2406 Fast Ethernet Controller (FEC)
2409 The AN5206 emulation includes the following devices:
2413 MCF5206 ColdFire V2 Microprocessor.
2418 @node QEMU User space emulator
2419 @chapter QEMU User space emulator
2422 * Supported Operating Systems ::
2423 * Linux User space emulator::
2424 * Mac OS X/Darwin User space emulator ::
2427 @node Supported Operating Systems
2428 @section Supported Operating Systems
2430 The following OS are supported in user space emulation:
2434 Linux (referred as qemu-linux-user)
2436 Mac OS X/Darwin (referred as qemu-darwin-user)
2439 @node Linux User space emulator
2440 @section Linux User space emulator
2445 * Command line options::
2450 @subsection Quick Start
2452 In order to launch a Linux process, QEMU needs the process executable
2453 itself and all the target (x86) dynamic libraries used by it.
2457 @item On x86, you can just try to launch any process by using the native
2461 qemu-i386 -L / /bin/ls
2464 @code{-L /} tells that the x86 dynamic linker must be searched with a
2467 @item Since QEMU is also a linux process, you can launch qemu with
2468 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2471 qemu-i386 -L / qemu-i386 -L / /bin/ls
2474 @item On non x86 CPUs, you need first to download at least an x86 glibc
2475 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2476 @code{LD_LIBRARY_PATH} is not set:
2479 unset LD_LIBRARY_PATH
2482 Then you can launch the precompiled @file{ls} x86 executable:
2485 qemu-i386 tests/i386/ls
2487 You can look at @file{qemu-binfmt-conf.sh} so that
2488 QEMU is automatically launched by the Linux kernel when you try to
2489 launch x86 executables. It requires the @code{binfmt_misc} module in the
2492 @item The x86 version of QEMU is also included. You can try weird things such as:
2494 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2495 /usr/local/qemu-i386/bin/ls-i386
2501 @subsection Wine launch
2505 @item Ensure that you have a working QEMU with the x86 glibc
2506 distribution (see previous section). In order to verify it, you must be
2510 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2513 @item Download the binary x86 Wine install
2514 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2516 @item Configure Wine on your account. Look at the provided script
2517 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2518 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2520 @item Then you can try the example @file{putty.exe}:
2523 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2524 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2529 @node Command line options
2530 @subsection Command line options
2533 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2540 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2542 Set the x86 stack size in bytes (default=524288)
2549 Activate log (logfile=/tmp/qemu.log)
2551 Act as if the host page size was 'pagesize' bytes
2554 Environment variables:
2558 Print system calls and arguments similar to the 'strace' program
2559 (NOTE: the actual 'strace' program will not work because the user
2560 space emulator hasn't implemented ptrace). At the moment this is
2561 incomplete. All system calls that don't have a specific argument
2562 format are printed with information for six arguments. Many
2563 flag-style arguments don't have decoders and will show up as numbers.
2566 @node Other binaries
2567 @subsection Other binaries
2569 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2570 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2571 configurations), and arm-uclinux bFLT format binaries.
2573 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2574 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2575 coldfire uClinux bFLT format binaries.
2577 The binary format is detected automatically.
2579 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2580 (Sparc64 CPU, 32 bit ABI).
2582 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2583 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2585 @node Mac OS X/Darwin User space emulator
2586 @section Mac OS X/Darwin User space emulator
2589 * Mac OS X/Darwin Status::
2590 * Mac OS X/Darwin Quick Start::
2591 * Mac OS X/Darwin Command line options::
2594 @node Mac OS X/Darwin Status
2595 @subsection Mac OS X/Darwin Status
2599 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2601 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2603 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
2605 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2608 [1] If you're host commpage can be executed by qemu.
2610 @node Mac OS X/Darwin Quick Start
2611 @subsection Quick Start
2613 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2614 itself and all the target dynamic libraries used by it. If you don't have the FAT
2615 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2616 CD or compile them by hand.
2620 @item On x86, you can just try to launch any process by using the native
2627 or to run the ppc version of the executable:
2633 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2637 qemu-i386 -L /opt/x86_root/ /bin/ls
2640 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2641 @file{/opt/x86_root/usr/bin/dyld}.
2645 @node Mac OS X/Darwin Command line options
2646 @subsection Command line options
2649 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2656 Set the library root path (default=/)
2658 Set the stack size in bytes (default=524288)
2665 Activate log (logfile=/tmp/qemu.log)
2667 Act as if the host page size was 'pagesize' bytes
2671 @chapter Compilation from the sources
2676 * Cross compilation for Windows with Linux::
2683 @subsection Compilation
2685 First you must decompress the sources:
2688 tar zxvf qemu-x.y.z.tar.gz
2692 Then you configure QEMU and build it (usually no options are needed):
2698 Then type as root user:
2702 to install QEMU in @file{/usr/local}.
2704 @subsection GCC version
2706 In order to compile QEMU successfully, it is very important that you
2707 have the right tools. The most important one is gcc. On most hosts and
2708 in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2709 Linux distribution includes a gcc 4.x compiler, you can usually
2710 install an older version (it is invoked by @code{gcc32} or
2711 @code{gcc34}). The QEMU configure script automatically probes for
2712 these older versions so that usually you don't have to do anything.
2718 @item Install the current versions of MSYS and MinGW from
2719 @url{http://www.mingw.org/}. You can find detailed installation
2720 instructions in the download section and the FAQ.
2723 the MinGW development library of SDL 1.2.x
2724 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2725 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
2726 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2727 directory. Edit the @file{sdl-config} script so that it gives the
2728 correct SDL directory when invoked.
2730 @item Extract the current version of QEMU.
2732 @item Start the MSYS shell (file @file{msys.bat}).
2734 @item Change to the QEMU directory. Launch @file{./configure} and
2735 @file{make}. If you have problems using SDL, verify that
2736 @file{sdl-config} can be launched from the MSYS command line.
2738 @item You can install QEMU in @file{Program Files/Qemu} by typing
2739 @file{make install}. Don't forget to copy @file{SDL.dll} in
2740 @file{Program Files/Qemu}.
2744 @node Cross compilation for Windows with Linux
2745 @section Cross compilation for Windows with Linux
2749 Install the MinGW cross compilation tools available at
2750 @url{http://www.mingw.org/}.
2753 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2754 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2755 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2756 the QEMU configuration script.
2759 Configure QEMU for Windows cross compilation:
2761 ./configure --enable-mingw32
2763 If necessary, you can change the cross-prefix according to the prefix
2764 chosen for the MinGW tools with --cross-prefix. You can also use
2765 --prefix to set the Win32 install path.
2767 @item You can install QEMU in the installation directory by typing
2768 @file{make install}. Don't forget to copy @file{SDL.dll} in the
2769 installation directory.
2773 Note: Currently, Wine does not seem able to launch
2779 The Mac OS X patches are not fully merged in QEMU, so you should look
2780 at the QEMU mailing list archive to have all the necessary