Add copyright notices
[qemu-kvm/fedora.git] / qemu-doc.texi
blob314de9e37ea02b8f9e8c050e836dd644ed19e039
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename qemu-doc.info
4 @settitle QEMU Emulator User Documentation
5 @exampleindent 0
6 @paragraphindent 0
7 @c %**end of header
9 @iftex
10 @titlepage
11 @sp 7
12 @center @titlefont{QEMU Emulator}
13 @sp 1
14 @center @titlefont{User Documentation}
15 @sp 3
16 @end titlepage
17 @end iftex
19 @ifnottex
20 @node Top
21 @top
23 @menu
24 * Introduction::
25 * Installation::
26 * QEMU PC System emulator::
27 * QEMU System emulator for non PC targets::
28 * QEMU User space emulator::
29 * compilation:: Compilation from the sources
30 * Index::
31 @end menu
32 @end ifnottex
34 @contents
36 @node Introduction
37 @chapter Introduction
39 @menu
40 * intro_features:: Features
41 @end menu
43 @node intro_features
44 @section Features
46 QEMU is a FAST! processor emulator using dynamic translation to
47 achieve good emulation speed.
49 QEMU has two operating modes:
51 @itemize @minus
53 @item
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.
59 @item
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.
65 @end itemize
67 QEMU can run without an host kernel driver and yet gives acceptable
68 performance.
70 For system emulation, the following hardware targets are supported:
71 @itemize
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)
89 @end itemize
91 For user emulation, x86, PowerPC, ARM, 32-bit MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
93 @node Installation
94 @chapter Installation
96 If you want to compile QEMU yourself, see @ref{compilation}.
98 @menu
99 * install_linux::   Linux
100 * install_windows:: Windows
101 * install_mac::     Macintosh
102 @end menu
104 @node install_linux
105 @section Linux
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
111 @section Windows
113 Download the experimental binary installer at
114 @url{http://www.free.oszoo.org/@/download.html}.
116 @node install_mac
117 @section Mac OS X
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
125 @menu
126 * pcsys_introduction:: Introduction
127 * pcsys_quickstart::   Quick Start
128 * sec_invocation::     Invocation
129 * pcsys_keys::         Keys
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
138 @end menu
140 @node pcsys_introduction
141 @section Introduction
143 @c man begin DESCRIPTION
145 The QEMU PC System emulator simulates the
146 following peripherals:
148 @itemize @minus
149 @item
150 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
151 @item
152 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
153 extensions (hardware level, including all non standard modes).
154 @item
155 PS/2 mouse and keyboard
156 @item
157 2 PCI IDE interfaces with hard disk and CD-ROM support
158 @item
159 Floppy disk
160 @item
161 PCI/ISA PCI network adapters
162 @item
163 Serial ports
164 @item
165 Creative SoundBlaster 16 sound card
166 @item
167 ENSONIQ AudioPCI ES1370 sound card
168 @item
169 Intel 82801AA AC97 Audio compatible sound card
170 @item
171 Adlib(OPL2) - Yamaha YM3812 compatible chip
172 @item
173 Gravis Ultrasound GF1 sound card
174 @item
175 PCI UHCI USB controller and a virtual USB hub.
176 @end itemize
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
184 VGA BIOS.
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.
191 @c man end
193 @node pcsys_quickstart
194 @section Quick Start
196 Download and uncompress the linux image (@file{linux.img}) and type:
198 @example
199 qemu linux.img
200 @end example
202 Linux should boot and give you a prompt.
204 @node sec_invocation
205 @section Invocation
207 @example
208 @c man begin SYNOPSIS
209 usage: qemu [options] [@var{disk_image}]
210 @c man end
211 @end example
213 @c man begin OPTIONS
214 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
216 General options:
217 @table @option
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:
241 @table @code
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
251 the unit id.
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.
263 @end table
265 Instead of @option{-cdrom} you can use:
266 @example
267 qemu -drive file=file,index=2,media=cdrom
268 @end example
270 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
271 use:
272 @example
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
277 @end example
279 You can connect a CDROM to the slave of ide0:
280 @example
281 qemu -drive file=file,if=ide,index=1,media=cdrom
282 @end example
284 If you don't specify the "file=" argument, you define an empty drive:
285 @example
286 qemu -drive if=ide,index=1,media=cdrom
287 @end example
289 You can connect a SCSI disk with unit ID 6 on the bus #0:
290 @example
291 qemu -drive file=file,if=scsi,bus=0,unit=6
292 @end example
294 Instead of @option{-fda}, @option{-fdb}, you can use:
295 @example
296 qemu -drive file=file,index=0,if=floppy
297 qemu -drive file=file,index=1,if=floppy
298 @end example
300 By default, @var{interface} is "ide" and @var{index} is automatically
301 incremented:
302 @example
303 qemu -drive file=a -drive file=b"
304 @end example
305 is interpreted like:
306 @example
307 qemu -hda a -hdb b
308 @end example
310 @item -boot [a|c|d|n]
311 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
312 is the default.
314 @item -snapshot
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}).
319 @item -no-fd-bootchk
320 Disable boot signature checking for floppy disks in Bochs BIOS. It may
321 be needed to boot from old floppy disks.
323 @item -m @var{megs}
324 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.
326 @item -smp @var{n}
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
329 to 4.
331 @item -audio-help
333 Will show the audio subsystem help: list of drivers, tunable
334 parameters.
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.
341 @example
342 qemu -soundhw sb16,adlib hda
343 qemu -soundhw es1370 hda
344 qemu -soundhw ac97 hda
345 qemu -soundhw all hda
346 qemu -soundhw ?
347 @end example
349 Note that Linux's i810_audio OSS kernel (for AC97) module might
350 require manually specifying clocking.
352 @example
353 modprobe i810_audio clocking=48000
354 @end example
356 @item -localtime
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
359 Windows.
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 -translation @var{setting1[,...]}
367 Select dynamic translation options @var{setting}, @code{-translation ?}
368 shows a list of settings. Valid settings are:
370 @table @code
371 @item @var{no-cache}
372 This option disables caching of translated code. Is useful for low-level
373 debugging of the emulated environment. This option incurs a massive
374 slow-down in emulation speed.
375 @end table
377 @item -pidfile @var{file}
378 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
379 from a script.
381 @item -daemonize
382 Daemonize the QEMU process after initialization.  QEMU will not detach from
383 standard IO until it is ready to receive connections on any of its devices.
384 This option is a useful way for external programs to launch QEMU without having
385 to cope with initialization race conditions.
387 @item -win2k-hack
388 Use it when installing Windows 2000 to avoid a disk full bug. After
389 Windows 2000 is installed, you no longer need this option (this option
390 slows down the IDE transfers).
392 @item -option-rom @var{file}
393 Load the contents of @var{file} as an option ROM.
394 This option is useful to load things like EtherBoot.
396 @item -name @var{name}
397 Sets the @var{name} of the guest.
398 This name will be display in the SDL window caption.
399 The @var{name} will also be used for the VNC server.
401 @end table
403 Display options:
404 @table @option
406 @item -nographic
408 Normally, QEMU uses SDL to display the VGA output. With this option,
409 you can totally disable graphical output so that QEMU is a simple
410 command line application. The emulated serial port is redirected on
411 the console. Therefore, you can still use QEMU to debug a Linux kernel
412 with a serial console.
414 @item -no-frame
416 Do not use decorations for SDL windows and start them using the whole
417 available screen space. This makes the using QEMU in a dedicated desktop
418 workspace more convenient.
420 @item -full-screen
421 Start in full screen.
423 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
425 Normally, QEMU uses SDL to display the VGA output.  With this option,
426 you can have QEMU listen on VNC display @var{display} and redirect the VGA
427 display over the VNC session.  It is very useful to enable the usb
428 tablet device when using this option (option @option{-usbdevice
429 tablet}). When using the VNC display, you must use the @option{-k}
430 parameter to set the keyboard layout if you are not using en-us. Valid
431 syntax for the @var{display} is
433 @table @code
435 @item @var{interface}:@var{d}
437 TCP connections will only be allowed from @var{interface} on display @var{d}.
438 By convention the TCP port is 5900+@var{d}. Optionally, @var{interface} can
439 be omitted in which case the server will bind to all interfaces.
441 @item @var{unix}:@var{path}
443 Connections will be allowed over UNIX domain sockets where @var{path} is the
444 location of a unix socket to listen for connections on.
446 @item none
448 VNC is initialized by not started. The monitor @code{change} command can be used
449 to later start the VNC server.
451 @end table
453 Following the @var{display} value there may be one or more @var{option} flags
454 separated by commas. Valid options are
456 @table @code
458 @item password
460 Require that password based authentication is used for client connections.
461 The password must be set separately using the @code{change} command in the
462 @ref{pcsys_monitor}
464 @item tls
466 Require that client use TLS when communicating with the VNC server. This
467 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
468 attack. It is recommended that this option be combined with either the
469 @var{x509} or @var{x509verify} options.
471 @item x509=@var{/path/to/certificate/dir}
473 Valid if @option{tls} is specified. Require that x509 credentials are used
474 for negotiating the TLS session. The server will send its x509 certificate
475 to the client. It is recommended that a password be set on the VNC server
476 to provide authentication of the client when this is used. The path following
477 this option specifies where the x509 certificates are to be loaded from.
478 See the @ref{vnc_security} section for details on generating certificates.
480 @item x509verify=@var{/path/to/certificate/dir}
482 Valid if @option{tls} is specified. Require that x509 credentials are used
483 for negotiating the TLS session. The server will send its x509 certificate
484 to the client, and request that the client send its own x509 certificate.
485 The server will validate the client's certificate against the CA certificate,
486 and reject clients when validation fails. If the certificate authority is
487 trusted, this is a sufficient authentication mechanism. You may still wish
488 to set a password on the VNC server as a second authentication layer. The
489 path following this option specifies where the x509 certificates are to
490 be loaded from. See the @ref{vnc_security} section for details on generating
491 certificates.
493 @end table
495 @item -k @var{language}
497 Use keyboard layout @var{language} (for example @code{fr} for
498 French). This option is only needed where it is not easy to get raw PC
499 keycodes (e.g. on Macs, with some X11 servers or with a VNC
500 display). You don't normally need to use it on PC/Linux or PC/Windows
501 hosts.
503 The available layouts are:
504 @example
505 ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
506 da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
507 de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
508 @end example
510 The default is @code{en-us}.
512 @end table
514 USB options:
515 @table @option
517 @item -usb
518 Enable the USB driver (will be the default soon)
520 @item -usbdevice @var{devname}
521 Add the USB device @var{devname}. @xref{usb_devices}.
523 @table @code
525 @item mouse
526 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
528 @item tablet
529 Pointer device that uses absolute coordinates (like a touchscreen). This
530 means qemu is able to report the mouse position without having to grab the
531 mouse. Also overrides the PS/2 mouse emulation when activated.
533 @item disk:file
534 Mass storage device based on file
536 @item host:bus.addr
537 Pass through the host device identified by bus.addr (Linux only).
539 @item host:vendor_id:product_id
540 Pass through the host device identified by vendor_id:product_id (Linux only).
542 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
543 Serial converter to host character device @var{dev}, see @code{-serial} for the
544 available devices.
546 @end table
548 @end table
550 Network options:
552 @table @option
554 @item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
555 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
556 = 0 is the default). The NIC is an rtl8139 by default on the PC
557 target. Optionally, the MAC address can be changed. If no
558 @option{-net} option is specified, a single NIC is created.
559 Qemu can emulate several different models of network card.
560 Valid values for @var{type} are
561 @code{i82551}, @code{i82557b}, @code{i82559er},
562 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
563 @code{smc91c111}, @code{lance} and @code{mcf_fec}.
564 Not all devices are supported on all targets.  Use -net nic,model=?
565 for a list of available devices for your target.
567 @item -net user[,vlan=@var{n}][,hostname=@var{name}]
568 Use the user mode network stack which requires no administrator
569 privilege to run.  @option{hostname=name} can be used to specify the client
570 hostname reported by the builtin DHCP server.
572 @item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}]
573 Connect the host TAP network interface @var{name} to VLAN @var{n} and
574 use the network script @var{file} to configure it. The default
575 network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
576 disable script execution. If @var{name} is not
577 provided, the OS automatically provides one. @option{fd}=@var{h} can be
578 used to specify the handle of an already opened host TAP interface. Example:
580 @example
581 qemu linux.img -net nic -net tap
582 @end example
584 More complicated example (two NICs, each one connected to a TAP device)
585 @example
586 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
587                -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
588 @end example
591 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
593 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
594 machine using a TCP socket connection. If @option{listen} is
595 specified, QEMU waits for incoming connections on @var{port}
596 (@var{host} is optional). @option{connect} is used to connect to
597 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
598 specifies an already opened TCP socket.
600 Example:
601 @example
602 # launch a first QEMU instance
603 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
604                -net socket,listen=:1234
605 # connect the VLAN 0 of this instance to the VLAN 0
606 # of the first instance
607 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
608                -net socket,connect=127.0.0.1:1234
609 @end example
611 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
613 Create a VLAN @var{n} shared with another QEMU virtual
614 machines using a UDP multicast socket, effectively making a bus for
615 every QEMU with same multicast address @var{maddr} and @var{port}.
616 NOTES:
617 @enumerate
618 @item
619 Several QEMU can be running on different hosts and share same bus (assuming
620 correct multicast setup for these hosts).
621 @item
622 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
623 @url{http://user-mode-linux.sf.net}.
624 @item
625 Use @option{fd=h} to specify an already opened UDP multicast socket.
626 @end enumerate
628 Example:
629 @example
630 # launch one QEMU instance
631 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
632                -net socket,mcast=230.0.0.1:1234
633 # launch another QEMU instance on same "bus"
634 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
635                -net socket,mcast=230.0.0.1:1234
636 # launch yet another QEMU instance on same "bus"
637 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
638                -net socket,mcast=230.0.0.1:1234
639 @end example
641 Example (User Mode Linux compat.):
642 @example
643 # launch QEMU instance (note mcast address selected
644 # is UML's default)
645 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
646                -net socket,mcast=239.192.168.1:1102
647 # launch UML
648 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
649 @end example
651 @item -net none
652 Indicate that no network devices should be configured. It is used to
653 override the default configuration (@option{-net nic -net user}) which
654 is activated if no @option{-net} options are provided.
656 @item -tftp @var{dir}
657 When using the user mode network stack, activate a built-in TFTP
658 server. The files in @var{dir} will be exposed as the root of a TFTP server.
659 The TFTP client on the guest must be configured in binary mode (use the command
660 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
661 usual 10.0.2.2.
663 @item -bootp @var{file}
664 When using the user mode network stack, broadcast @var{file} as the BOOTP
665 filename.  In conjunction with @option{-tftp}, this can be used to network boot
666 a guest from a local directory.
668 Example (using pxelinux):
669 @example
670 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
671 @end example
673 @item -smb @var{dir}
674 When using the user mode network stack, activate a built-in SMB
675 server so that Windows OSes can access to the host files in @file{@var{dir}}
676 transparently.
678 In the guest Windows OS, the line:
679 @example
680 10.0.2.4 smbserver
681 @end example
682 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
683 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
685 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
687 Note that a SAMBA server must be installed on the host OS in
688 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
689 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
691 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
693 When using the user mode network stack, redirect incoming TCP or UDP
694 connections to the host port @var{host-port} to the guest
695 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
696 is not specified, its value is 10.0.2.15 (default address given by the
697 built-in DHCP server).
699 For example, to redirect host X11 connection from screen 1 to guest
700 screen 0, use the following:
702 @example
703 # on the host
704 qemu -redir tcp:6001::6000 [...]
705 # this host xterm should open in the guest X11 server
706 xterm -display :1
707 @end example
709 To redirect telnet connections from host port 5555 to telnet port on
710 the guest, use the following:
712 @example
713 # on the host
714 qemu -redir tcp:5555::23 [...]
715 telnet localhost 5555
716 @end example
718 Then when you use on the host @code{telnet localhost 5555}, you
719 connect to the guest telnet server.
721 @end table
723 Linux boot specific: When using these options, you can use a given
724 Linux kernel without installing it in the disk image. It can be useful
725 for easier testing of various kernels.
727 @table @option
729 @item -kernel @var{bzImage}
730 Use @var{bzImage} as kernel image.
732 @item -append @var{cmdline}
733 Use @var{cmdline} as kernel command line
735 @item -initrd @var{file}
736 Use @var{file} as initial ram disk.
738 @end table
740 Debug/Expert options:
741 @table @option
743 @item -serial @var{dev}
744 Redirect the virtual serial port to host character device
745 @var{dev}. The default device is @code{vc} in graphical mode and
746 @code{stdio} in non graphical mode.
748 This option can be used several times to simulate up to 4 serials
749 ports.
751 Use @code{-serial none} to disable all serial ports.
753 Available character devices are:
754 @table @code
755 @item vc[:WxH]
756 Virtual console. Optionally, a width and height can be given in pixel with
757 @example
758 vc:800x600
759 @end example
760 It is also possible to specify width or height in characters:
761 @example
762 vc:80Cx24C
763 @end example
764 @item pty
765 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
766 @item none
767 No device is allocated.
768 @item null
769 void device
770 @item /dev/XXX
771 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
772 parameters are set according to the emulated ones.
773 @item /dev/parport@var{N}
774 [Linux only, parallel port only] Use host parallel port
775 @var{N}. Currently SPP and EPP parallel port features can be used.
776 @item file:@var{filename}
777 Write output to @var{filename}. No character can be read.
778 @item stdio
779 [Unix only] standard input/output
780 @item pipe:@var{filename}
781 name pipe @var{filename}
782 @item COM@var{n}
783 [Windows only] Use host serial port @var{n}
784 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
785 This implements UDP Net Console.
786 When @var{remote_host} or @var{src_ip} are not specified
787 they default to @code{0.0.0.0}.
788 When not using a specified @var{src_port} a random port is automatically chosen.
790 If you just want a simple readonly console you can use @code{netcat} or
791 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
792 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
793 will appear in the netconsole session.
795 If you plan to send characters back via netconsole or you want to stop
796 and start qemu a lot of times, you should have qemu use the same
797 source port each time by using something like @code{-serial
798 udp::4555@@:4556} to qemu. Another approach is to use a patched
799 version of netcat which can listen to a TCP port and send and receive
800 characters via udp.  If you have a patched version of netcat which
801 activates telnet remote echo and single char transfer, then you can
802 use the following options to step up a netcat redirector to allow
803 telnet on port 5555 to access the qemu port.
804 @table @code
805 @item Qemu Options:
806 -serial udp::4555@@:4556
807 @item netcat options:
808 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
809 @item telnet options:
810 localhost 5555
811 @end table
814 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
815 The TCP Net Console has two modes of operation.  It can send the serial
816 I/O to a location or wait for a connection from a location.  By default
817 the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
818 the @var{server} option QEMU will wait for a client socket application
819 to connect to the port before continuing, unless the @code{nowait}
820 option was specified.  The @code{nodelay} option disables the Nagle buffering
821 algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
822 one TCP connection at a time is accepted. You can use @code{telnet} to
823 connect to the corresponding character device.
824 @table @code
825 @item Example to send tcp console to 192.168.0.2 port 4444
826 -serial tcp:192.168.0.2:4444
827 @item Example to listen and wait on port 4444 for connection
828 -serial tcp::4444,server
829 @item Example to not wait and listen on ip 192.168.0.100 port 4444
830 -serial tcp:192.168.0.100:4444,server,nowait
831 @end table
833 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
834 The telnet protocol is used instead of raw tcp sockets.  The options
835 work the same as if you had specified @code{-serial tcp}.  The
836 difference is that the port acts like a telnet server or client using
837 telnet option negotiation.  This will also allow you to send the
838 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
839 sequence.  Typically in unix telnet you do it with Control-] and then
840 type "send break" followed by pressing the enter key.
842 @item unix:@var{path}[,server][,nowait]
843 A unix domain socket is used instead of a tcp socket.  The option works the
844 same as if you had specified @code{-serial tcp} except the unix domain socket
845 @var{path} is used for connections.
847 @item mon:@var{dev_string}
848 This is a special option to allow the monitor to be multiplexed onto
849 another serial port.  The monitor is accessed with key sequence of
850 @key{Control-a} and then pressing @key{c}. See monitor access
851 @ref{pcsys_keys} in the -nographic section for more keys.
852 @var{dev_string} should be any one of the serial devices specified
853 above.  An example to multiplex the monitor onto a telnet server
854 listening on port 4444 would be:
855 @table @code
856 @item -serial mon:telnet::4444,server,nowait
857 @end table
859 @end table
861 @item -parallel @var{dev}
862 Redirect the virtual parallel port to host device @var{dev} (same
863 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
864 be used to use hardware devices connected on the corresponding host
865 parallel port.
867 This option can be used several times to simulate up to 3 parallel
868 ports.
870 Use @code{-parallel none} to disable all parallel ports.
872 @item -monitor @var{dev}
873 Redirect the monitor to host device @var{dev} (same devices as the
874 serial port).
875 The default device is @code{vc} in graphical mode and @code{stdio} in
876 non graphical mode.
878 @item -echr numeric_ascii_value
879 Change the escape character used for switching to the monitor when using
880 monitor and serial sharing.  The default is @code{0x01} when using the
881 @code{-nographic} option.  @code{0x01} is equal to pressing
882 @code{Control-a}.  You can select a different character from the ascii
883 control keys where 1 through 26 map to Control-a through Control-z.  For
884 instance you could use the either of the following to change the escape
885 character to Control-t.
886 @table @code
887 @item -echr 0x14
888 @item -echr 20
889 @end table
891 @item -s
892 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
893 @item -p @var{port}
894 Change gdb connection port.  @var{port} can be either a decimal number
895 to specify a TCP port, or a host device (same devices as the serial port).
896 @item -S
897 Do not start CPU at startup (you must type 'c' in the monitor).
898 @item -d
899 Output log in /tmp/qemu.log
900 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
901 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
902 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
903 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
904 all those parameters. This option is useful for old MS-DOS disk
905 images.
907 @item -L path
908 Set the directory for the BIOS, VGA BIOS and keymaps.
910 @item -std-vga
911 Simulate a standard VGA card with Bochs VBE extensions (default is
912 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
913 VBE extensions (e.g. Windows XP) and if you want to use high
914 resolution modes (>= 1280x1024x16) then you should use this option.
916 @item -no-acpi
917 Disable ACPI (Advanced Configuration and Power Interface) support. Use
918 it if your guest OS complains about ACPI problems (PC target machine
919 only).
921 @item -no-reboot
922 Exit instead of rebooting.
924 @item -loadvm file
925 Start right away with a saved state (@code{loadvm} in monitor)
927 @item -semihosting
928 Enable semihosting syscall emulation (ARM and M68K target machines only).
930 On ARM this implements the "Angel" interface.
931 On M68K this implements the "ColdFire GDB" interface used by libgloss.
933 Note that this allows guest direct access to the host filesystem,
934 so should only be used with trusted guest OS.
935 @end table
937 @c man end
939 @node pcsys_keys
940 @section Keys
942 @c man begin OPTIONS
944 During the graphical emulation, you can use the following keys:
945 @table @key
946 @item Ctrl-Alt-f
947 Toggle full screen
949 @item Ctrl-Alt-n
950 Switch to virtual console 'n'. Standard console mappings are:
951 @table @emph
952 @item 1
953 Target system display
954 @item 2
955 Monitor
956 @item 3
957 Serial port
958 @end table
960 @item Ctrl-Alt
961 Toggle mouse and keyboard grab.
962 @end table
964 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
965 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
967 During emulation, if you are using the @option{-nographic} option, use
968 @key{Ctrl-a h} to get terminal commands:
970 @table @key
971 @item Ctrl-a h
972 Print this help
973 @item Ctrl-a x
974 Exit emulator
975 @item Ctrl-a s
976 Save disk data back to file (if -snapshot)
977 @item Ctrl-a t
978 toggle console timestamps
979 @item Ctrl-a b
980 Send break (magic sysrq in Linux)
981 @item Ctrl-a c
982 Switch between console and monitor
983 @item Ctrl-a Ctrl-a
984 Send Ctrl-a
985 @end table
986 @c man end
988 @ignore
990 @c man begin SEEALSO
991 The HTML documentation of QEMU for more precise information and Linux
992 user mode emulator invocation.
993 @c man end
995 @c man begin AUTHOR
996 Fabrice Bellard
997 @c man end
999 @end ignore
1001 @node pcsys_monitor
1002 @section QEMU Monitor
1004 The QEMU monitor is used to give complex commands to the QEMU
1005 emulator. You can use it to:
1007 @itemize @minus
1009 @item
1010 Remove or insert removable media images
1011 (such as CD-ROM or floppies).
1013 @item
1014 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
1015 from a disk file.
1017 @item Inspect the VM state without an external debugger.
1019 @end itemize
1021 @subsection Commands
1023 The following commands are available:
1025 @table @option
1027 @item help or ? [@var{cmd}]
1028 Show the help for all commands or just for command @var{cmd}.
1030 @item commit
1031 Commit changes to the disk images (if -snapshot is used).
1033 @item info @var{subcommand}
1034 Show various information about the system state.
1036 @table @option
1037 @item info network
1038 show the various VLANs and the associated devices
1039 @item info block
1040 show the block devices
1041 @item info registers
1042 show the cpu registers
1043 @item info history
1044 show the command line history
1045 @item info pci
1046 show emulated PCI device
1047 @item info usb
1048 show USB devices plugged on the virtual USB hub
1049 @item info usbhost
1050 show all USB host devices
1051 @item info capture
1052 show information about active capturing
1053 @item info snapshots
1054 show list of VM snapshots
1055 @item info mice
1056 show which guest mouse is receiving events
1057 @end table
1059 @item q or quit
1060 Quit the emulator.
1062 @item eject [-f] @var{device}
1063 Eject a removable medium (use -f to force it).
1065 @item change @var{device} @var{setting}
1067 Change the configuration of a device.
1069 @table @option
1070 @item change @var{diskdevice} @var{filename}
1071 Change the medium for a removable disk device to point to @var{filename}. eg
1073 @example
1074 (qemu) change cdrom /path/to/some.iso
1075 @end example
1077 @item change vnc @var{display},@var{options}
1078 Change the configuration of the VNC server. The valid syntax for @var{display}
1079 and @var{options} are described at @ref{sec_invocation}. eg
1081 @example
1082 (qemu) change vnc localhost:1
1083 @end example
1085 @item change vnc password
1087 Change the password associated with the VNC server. The monitor will prompt for
1088 the new password to be entered. VNC passwords are only significant upto 8 letters.
1091 @example
1092 (qemu) change vnc password
1093 Password: ********
1094 @end example
1096 @end table
1098 @item screendump @var{filename}
1099 Save screen into PPM image @var{filename}.
1101 @item mouse_move @var{dx} @var{dy} [@var{dz}]
1102 Move the active mouse to the specified coordinates @var{dx} @var{dy}
1103 with optional scroll axis @var{dz}.
1105 @item mouse_button @var{val}
1106 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
1108 @item mouse_set @var{index}
1109 Set which mouse device receives events at given @var{index}, index
1110 can be obtained with
1111 @example
1112 info mice
1113 @end example
1115 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
1116 Capture audio into @var{filename}. Using sample rate @var{frequency}
1117 bits per sample @var{bits} and number of channels @var{channels}.
1119 Defaults:
1120 @itemize @minus
1121 @item Sample rate = 44100 Hz - CD quality
1122 @item Bits = 16
1123 @item Number of channels = 2 - Stereo
1124 @end itemize
1126 @item stopcapture @var{index}
1127 Stop capture with a given @var{index}, index can be obtained with
1128 @example
1129 info capture
1130 @end example
1132 @item log @var{item1}[,...]
1133 Activate logging of the specified items to @file{/tmp/qemu.log}.
1135 @item savevm [@var{tag}|@var{id}]
1136 Create a snapshot of the whole virtual machine. If @var{tag} is
1137 provided, it is used as human readable identifier. If there is already
1138 a snapshot with the same tag or ID, it is replaced. More info at
1139 @ref{vm_snapshots}.
1141 @item loadvm @var{tag}|@var{id}
1142 Set the whole virtual machine to the snapshot identified by the tag
1143 @var{tag} or the unique snapshot ID @var{id}.
1145 @item delvm @var{tag}|@var{id}
1146 Delete the snapshot identified by @var{tag} or @var{id}.
1148 @item stop
1149 Stop emulation.
1151 @item c or cont
1152 Resume emulation.
1154 @item gdbserver [@var{port}]
1155 Start gdbserver session (default @var{port}=1234)
1157 @item x/fmt @var{addr}
1158 Virtual memory dump starting at @var{addr}.
1160 @item xp /@var{fmt} @var{addr}
1161 Physical memory dump starting at @var{addr}.
1163 @var{fmt} is a format which tells the command how to format the
1164 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1166 @table @var
1167 @item count
1168 is the number of items to be dumped.
1170 @item format
1171 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
1172 c (char) or i (asm instruction).
1174 @item size
1175 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1176 @code{h} or @code{w} can be specified with the @code{i} format to
1177 respectively select 16 or 32 bit code instruction size.
1179 @end table
1181 Examples:
1182 @itemize
1183 @item
1184 Dump 10 instructions at the current instruction pointer:
1185 @example
1186 (qemu) x/10i $eip
1187 0x90107063:  ret
1188 0x90107064:  sti
1189 0x90107065:  lea    0x0(%esi,1),%esi
1190 0x90107069:  lea    0x0(%edi,1),%edi
1191 0x90107070:  ret
1192 0x90107071:  jmp    0x90107080
1193 0x90107073:  nop
1194 0x90107074:  nop
1195 0x90107075:  nop
1196 0x90107076:  nop
1197 @end example
1199 @item
1200 Dump 80 16 bit values at the start of the video memory.
1201 @smallexample
1202 (qemu) xp/80hx 0xb8000
1203 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
1204 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
1205 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
1206 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
1207 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
1208 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
1209 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1210 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1211 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1212 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1213 @end smallexample
1214 @end itemize
1216 @item p or print/@var{fmt} @var{expr}
1218 Print expression value. Only the @var{format} part of @var{fmt} is
1219 used.
1221 @item sendkey @var{keys}
1223 Send @var{keys} to the emulator. Use @code{-} to press several keys
1224 simultaneously. Example:
1225 @example
1226 sendkey ctrl-alt-f1
1227 @end example
1229 This command is useful to send keys that your graphical user interface
1230 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1232 @item system_reset
1234 Reset the system.
1236 @item usb_add @var{devname}
1238 Add the USB device @var{devname}.  For details of available devices see
1239 @ref{usb_devices}
1241 @item usb_del @var{devname}
1243 Remove the USB device @var{devname} from the QEMU virtual USB
1244 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1245 command @code{info usb} to see the devices you can remove.
1247 @end table
1249 @subsection Integer expressions
1251 The monitor understands integers expressions for every integer
1252 argument. You can use register names to get the value of specifics
1253 CPU registers by prefixing them with @emph{$}.
1255 @node disk_images
1256 @section Disk Images
1258 Since version 0.6.1, QEMU supports many disk image formats, including
1259 growable disk images (their size increase as non empty sectors are
1260 written), compressed and encrypted disk images. Version 0.8.3 added
1261 the new qcow2 disk image format which is essential to support VM
1262 snapshots.
1264 @menu
1265 * disk_images_quickstart::    Quick start for disk image creation
1266 * disk_images_snapshot_mode:: Snapshot mode
1267 * vm_snapshots::              VM snapshots
1268 * qemu_img_invocation::       qemu-img Invocation
1269 * host_drives::               Using host drives
1270 * disk_images_fat_images::    Virtual FAT disk images
1271 @end menu
1273 @node disk_images_quickstart
1274 @subsection Quick start for disk image creation
1276 You can create a disk image with the command:
1277 @example
1278 qemu-img create myimage.img mysize
1279 @end example
1280 where @var{myimage.img} is the disk image filename and @var{mysize} is its
1281 size in kilobytes. You can add an @code{M} suffix to give the size in
1282 megabytes and a @code{G} suffix for gigabytes.
1284 See @ref{qemu_img_invocation} for more information.
1286 @node disk_images_snapshot_mode
1287 @subsection Snapshot mode
1289 If you use the option @option{-snapshot}, all disk images are
1290 considered as read only. When sectors in written, they are written in
1291 a temporary file created in @file{/tmp}. You can however force the
1292 write back to the raw disk images by using the @code{commit} monitor
1293 command (or @key{C-a s} in the serial console).
1295 @node vm_snapshots
1296 @subsection VM snapshots
1298 VM snapshots are snapshots of the complete virtual machine including
1299 CPU state, RAM, device state and the content of all the writable
1300 disks. In order to use VM snapshots, you must have at least one non
1301 removable and writable block device using the @code{qcow2} disk image
1302 format. Normally this device is the first virtual hard drive.
1304 Use the monitor command @code{savevm} to create a new VM snapshot or
1305 replace an existing one. A human readable name can be assigned to each
1306 snapshot in addition to its numerical ID.
1308 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1309 a VM snapshot. @code{info snapshots} lists the available snapshots
1310 with their associated information:
1312 @example
1313 (qemu) info snapshots
1314 Snapshot devices: hda
1315 Snapshot list (from hda):
1316 ID        TAG                 VM SIZE                DATE       VM CLOCK
1317 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
1318 2                                 40M 2006-08-06 12:43:29   00:00:18.633
1319 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
1320 @end example
1322 A VM snapshot is made of a VM state info (its size is shown in
1323 @code{info snapshots}) and a snapshot of every writable disk image.
1324 The VM state info is stored in the first @code{qcow2} non removable
1325 and writable block device. The disk image snapshots are stored in
1326 every disk image. The size of a snapshot in a disk image is difficult
1327 to evaluate and is not shown by @code{info snapshots} because the
1328 associated disk sectors are shared among all the snapshots to save
1329 disk space (otherwise each snapshot would need a full copy of all the
1330 disk images).
1332 When using the (unrelated) @code{-snapshot} option
1333 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1334 but they are deleted as soon as you exit QEMU.
1336 VM snapshots currently have the following known limitations:
1337 @itemize
1338 @item
1339 They cannot cope with removable devices if they are removed or
1340 inserted after a snapshot is done.
1341 @item
1342 A few device drivers still have incomplete snapshot support so their
1343 state is not saved or restored properly (in particular USB).
1344 @end itemize
1346 @node qemu_img_invocation
1347 @subsection @code{qemu-img} Invocation
1349 @include qemu-img.texi
1351 @node host_drives
1352 @subsection Using host drives
1354 In addition to disk image files, QEMU can directly access host
1355 devices. We describe here the usage for QEMU version >= 0.8.3.
1357 @subsubsection Linux
1359 On Linux, you can directly use the host device filename instead of a
1360 disk image filename provided you have enough privileges to access
1361 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1362 @file{/dev/fd0} for the floppy.
1364 @table @code
1365 @item CD
1366 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1367 specific code to detect CDROM insertion or removal. CDROM ejection by
1368 the guest OS is supported. Currently only data CDs are supported.
1369 @item Floppy
1370 You can specify a floppy device even if no floppy is loaded. Floppy
1371 removal is currently not detected accurately (if you change floppy
1372 without doing floppy access while the floppy is not loaded, the guest
1373 OS will think that the same floppy is loaded).
1374 @item Hard disks
1375 Hard disks can be used. Normally you must specify the whole disk
1376 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1377 see it as a partitioned disk. WARNING: unless you know what you do, it
1378 is better to only make READ-ONLY accesses to the hard disk otherwise
1379 you may corrupt your host data (use the @option{-snapshot} command
1380 line option or modify the device permissions accordingly).
1381 @end table
1383 @subsubsection Windows
1385 @table @code
1386 @item CD
1387 The preferred syntax is the drive letter (e.g. @file{d:}). The
1388 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1389 supported as an alias to the first CDROM drive.
1391 Currently there is no specific code to handle removable media, so it
1392 is better to use the @code{change} or @code{eject} monitor commands to
1393 change or eject media.
1394 @item Hard disks
1395 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1396 where @var{N} is the drive number (0 is the first hard disk).
1398 WARNING: unless you know what you do, it is better to only make
1399 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1400 host data (use the @option{-snapshot} command line so that the
1401 modifications are written in a temporary file).
1402 @end table
1405 @subsubsection Mac OS X
1407 @file{/dev/cdrom} is an alias to the first CDROM.
1409 Currently there is no specific code to handle removable media, so it
1410 is better to use the @code{change} or @code{eject} monitor commands to
1411 change or eject media.
1413 @node disk_images_fat_images
1414 @subsection Virtual FAT disk images
1416 QEMU can automatically create a virtual FAT disk image from a
1417 directory tree. In order to use it, just type:
1419 @example
1420 qemu linux.img -hdb fat:/my_directory
1421 @end example
1423 Then you access access to all the files in the @file{/my_directory}
1424 directory without having to copy them in a disk image or to export
1425 them via SAMBA or NFS. The default access is @emph{read-only}.
1427 Floppies can be emulated with the @code{:floppy:} option:
1429 @example
1430 qemu linux.img -fda fat:floppy:/my_directory
1431 @end example
1433 A read/write support is available for testing (beta stage) with the
1434 @code{:rw:} option:
1436 @example
1437 qemu linux.img -fda fat:floppy:rw:/my_directory
1438 @end example
1440 What you should @emph{never} do:
1441 @itemize
1442 @item use non-ASCII filenames ;
1443 @item use "-snapshot" together with ":rw:" ;
1444 @item expect it to work when loadvm'ing ;
1445 @item write to the FAT directory on the host system while accessing it with the guest system.
1446 @end itemize
1448 @node pcsys_network
1449 @section Network emulation
1451 QEMU can simulate several network cards (PCI or ISA cards on the PC
1452 target) and can connect them to an arbitrary number of Virtual Local
1453 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1454 VLAN. VLAN can be connected between separate instances of QEMU to
1455 simulate large networks. For simpler usage, a non privileged user mode
1456 network stack can replace the TAP device to have a basic network
1457 connection.
1459 @subsection VLANs
1461 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1462 connection between several network devices. These devices can be for
1463 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1464 (TAP devices).
1466 @subsection Using TAP network interfaces
1468 This is the standard way to connect QEMU to a real network. QEMU adds
1469 a virtual network device on your host (called @code{tapN}), and you
1470 can then configure it as if it was a real ethernet card.
1472 @subsubsection Linux host
1474 As an example, you can download the @file{linux-test-xxx.tar.gz}
1475 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1476 configure properly @code{sudo} so that the command @code{ifconfig}
1477 contained in @file{qemu-ifup} can be executed as root. You must verify
1478 that your host kernel supports the TAP network interfaces: the
1479 device @file{/dev/net/tun} must be present.
1481 See @ref{sec_invocation} to have examples of command lines using the
1482 TAP network interfaces.
1484 @subsubsection Windows host
1486 There is a virtual ethernet driver for Windows 2000/XP systems, called
1487 TAP-Win32. But it is not included in standard QEMU for Windows,
1488 so you will need to get it separately. It is part of OpenVPN package,
1489 so download OpenVPN from : @url{http://openvpn.net/}.
1491 @subsection Using the user mode network stack
1493 By using the option @option{-net user} (default configuration if no
1494 @option{-net} option is specified), QEMU uses a completely user mode
1495 network stack (you don't need root privilege to use the virtual
1496 network). The virtual network configuration is the following:
1498 @example
1500          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1501                            |          (10.0.2.2)
1502                            |
1503                            ---->  DNS server (10.0.2.3)
1504                            |
1505                            ---->  SMB server (10.0.2.4)
1506 @end example
1508 The QEMU VM behaves as if it was behind a firewall which blocks all
1509 incoming connections. You can use a DHCP client to automatically
1510 configure the network in the QEMU VM. The DHCP server assign addresses
1511 to the hosts starting from 10.0.2.15.
1513 In order to check that the user mode network is working, you can ping
1514 the address 10.0.2.2 and verify that you got an address in the range
1515 10.0.2.x from the QEMU virtual DHCP server.
1517 Note that @code{ping} is not supported reliably to the internet as it
1518 would require root privileges. It means you can only ping the local
1519 router (10.0.2.2).
1521 When using the built-in TFTP server, the router is also the TFTP
1522 server.
1524 When using the @option{-redir} option, TCP or UDP connections can be
1525 redirected from the host to the guest. It allows for example to
1526 redirect X11, telnet or SSH connections.
1528 @subsection Connecting VLANs between QEMU instances
1530 Using the @option{-net socket} option, it is possible to make VLANs
1531 that span several QEMU instances. See @ref{sec_invocation} to have a
1532 basic example.
1534 @node direct_linux_boot
1535 @section Direct Linux Boot
1537 This section explains how to launch a Linux kernel inside QEMU without
1538 having to make a full bootable image. It is very useful for fast Linux
1539 kernel testing.
1541 The syntax is:
1542 @example
1543 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1544 @end example
1546 Use @option{-kernel} to provide the Linux kernel image and
1547 @option{-append} to give the kernel command line arguments. The
1548 @option{-initrd} option can be used to provide an INITRD image.
1550 When using the direct Linux boot, a disk image for the first hard disk
1551 @file{hda} is required because its boot sector is used to launch the
1552 Linux kernel.
1554 If you do not need graphical output, you can disable it and redirect
1555 the virtual serial port and the QEMU monitor to the console with the
1556 @option{-nographic} option. The typical command line is:
1557 @example
1558 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1559      -append "root=/dev/hda console=ttyS0" -nographic
1560 @end example
1562 Use @key{Ctrl-a c} to switch between the serial console and the
1563 monitor (@pxref{pcsys_keys}).
1565 @node pcsys_usb
1566 @section USB emulation
1568 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1569 virtual USB devices or real host USB devices (experimental, works only
1570 on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
1571 as necessary to connect multiple USB devices.
1573 @menu
1574 * usb_devices::
1575 * host_usb_devices::
1576 @end menu
1577 @node usb_devices
1578 @subsection Connecting USB devices
1580 USB devices can be connected with the @option{-usbdevice} commandline option
1581 or the @code{usb_add} monitor command.  Available devices are:
1583 @table @code
1584 @item mouse
1585 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1586 @item tablet
1587 Pointer device that uses absolute coordinates (like a touchscreen).
1588 This means qemu is able to report the mouse position without having
1589 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1590 @item disk:@var{file}
1591 Mass storage device based on @var{file} (@pxref{disk_images})
1592 @item host:@var{bus.addr}
1593 Pass through the host device identified by @var{bus.addr}
1594 (Linux only)
1595 @item host:@var{vendor_id:product_id}
1596 Pass through the host device identified by @var{vendor_id:product_id}
1597 (Linux only)
1598 @item wacom-tablet
1599 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
1600 above but it can be used with the tslib library because in addition to touch
1601 coordinates it reports touch pressure.
1602 @item keyboard
1603 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1604 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1605 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1606 device @var{dev}. The available character devices are the same as for the
1607 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1608 used to override the default 0403:6001. For instance, 
1609 @example
1610 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1611 @end example
1612 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1613 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1614 @end table
1616 @node host_usb_devices
1617 @subsection Using host USB devices on a Linux host
1619 WARNING: this is an experimental feature. QEMU will slow down when
1620 using it. USB devices requiring real time streaming (i.e. USB Video
1621 Cameras) are not supported yet.
1623 @enumerate
1624 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1625 is actually using the USB device. A simple way to do that is simply to
1626 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1627 to @file{mydriver.o.disabled}.
1629 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1630 @example
1631 ls /proc/bus/usb
1632 001  devices  drivers
1633 @end example
1635 @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:
1636 @example
1637 chown -R myuid /proc/bus/usb
1638 @end example
1640 @item Launch QEMU and do in the monitor:
1641 @example
1642 info usbhost
1643   Device 1.2, speed 480 Mb/s
1644     Class 00: USB device 1234:5678, USB DISK
1645 @end example
1646 You should see the list of the devices you can use (Never try to use
1647 hubs, it won't work).
1649 @item Add the device in QEMU by using:
1650 @example
1651 usb_add host:1234:5678
1652 @end example
1654 Normally the guest OS should report that a new USB device is
1655 plugged. You can use the option @option{-usbdevice} to do the same.
1657 @item Now you can try to use the host USB device in QEMU.
1659 @end enumerate
1661 When relaunching QEMU, you may have to unplug and plug again the USB
1662 device to make it work again (this is a bug).
1664 @node vnc_security
1665 @section VNC security
1667 The VNC server capability provides access to the graphical console
1668 of the guest VM across the network. This has a number of security
1669 considerations depending on the deployment scenarios.
1671 @menu
1672 * vnc_sec_none::
1673 * vnc_sec_password::
1674 * vnc_sec_certificate::
1675 * vnc_sec_certificate_verify::
1676 * vnc_sec_certificate_pw::
1677 * vnc_generate_cert::
1678 @end menu
1679 @node vnc_sec_none
1680 @subsection Without passwords
1682 The simplest VNC server setup does not include any form of authentication.
1683 For this setup it is recommended to restrict it to listen on a UNIX domain
1684 socket only. For example
1686 @example
1687 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1688 @end example
1690 This ensures that only users on local box with read/write access to that
1691 path can access the VNC server. To securely access the VNC server from a
1692 remote machine, a combination of netcat+ssh can be used to provide a secure
1693 tunnel.
1695 @node vnc_sec_password
1696 @subsection With passwords
1698 The VNC protocol has limited support for password based authentication. Since
1699 the protocol limits passwords to 8 characters it should not be considered
1700 to provide high security. The password can be fairly easily brute-forced by
1701 a client making repeat connections. For this reason, a VNC server using password
1702 authentication should be restricted to only listen on the loopback interface
1703 or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
1704 option, and then once QEMU is running the password is set with the monitor. Until
1705 the monitor is used to set the password all clients will be rejected.
1707 @example
1708 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1709 (qemu) change vnc password
1710 Password: ********
1711 (qemu)
1712 @end example
1714 @node vnc_sec_certificate
1715 @subsection With x509 certificates
1717 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1718 TLS for encryption of the session, and x509 certificates for authentication.
1719 The use of x509 certificates is strongly recommended, because TLS on its
1720 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1721 support provides a secure session, but no authentication. This allows any
1722 client to connect, and provides an encrypted session.
1724 @example
1725 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1726 @end example
1728 In the above example @code{/etc/pki/qemu} should contain at least three files,
1729 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1730 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1731 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1732 only be readable by the user owning it.
1734 @node vnc_sec_certificate_verify
1735 @subsection With x509 certificates and client verification
1737 Certificates can also provide a means to authenticate the client connecting.
1738 The server will request that the client provide a certificate, which it will
1739 then validate against the CA certificate. This is a good choice if deploying
1740 in an environment with a private internal certificate authority.
1742 @example
1743 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1744 @end example
1747 @node vnc_sec_certificate_pw
1748 @subsection With x509 certificates, client verification and passwords
1750 Finally, the previous method can be combined with VNC password authentication
1751 to provide two layers of authentication for clients.
1753 @example
1754 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1755 (qemu) change vnc password
1756 Password: ********
1757 (qemu)
1758 @end example
1760 @node vnc_generate_cert
1761 @subsection Generating certificates for VNC
1763 The GNU TLS packages provides a command called @code{certtool} which can
1764 be used to generate certificates and keys in PEM format. At a minimum it
1765 is neccessary to setup a certificate authority, and issue certificates to
1766 each server. If using certificates for authentication, then each client
1767 will also need to be issued a certificate. The recommendation is for the
1768 server to keep its certificates in either @code{/etc/pki/qemu} or for
1769 unprivileged users in @code{$HOME/.pki/qemu}.
1771 @menu
1772 * vnc_generate_ca::
1773 * vnc_generate_server::
1774 * vnc_generate_client::
1775 @end menu
1776 @node vnc_generate_ca
1777 @subsubsection Setup the Certificate Authority
1779 This step only needs to be performed once per organization / organizational
1780 unit. First the CA needs a private key. This key must be kept VERY secret
1781 and secure. If this key is compromised the entire trust chain of the certificates
1782 issued with it is lost.
1784 @example
1785 # certtool --generate-privkey > ca-key.pem
1786 @end example
1788 A CA needs to have a public certificate. For simplicity it can be a self-signed
1789 certificate, or one issue by a commercial certificate issuing authority. To
1790 generate a self-signed certificate requires one core piece of information, the
1791 name of the organization.
1793 @example
1794 # cat > ca.info <<EOF
1795 cn = Name of your organization
1797 cert_signing_key
1799 # certtool --generate-self-signed \
1800            --load-privkey ca-key.pem
1801            --template ca.info \
1802            --outfile ca-cert.pem
1803 @end example
1805 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1806 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1808 @node vnc_generate_server
1809 @subsubsection Issuing server certificates
1811 Each server (or host) needs to be issued with a key and certificate. When connecting
1812 the certificate is sent to the client which validates it against the CA certificate.
1813 The core piece of information for a server certificate is the hostname. This should
1814 be the fully qualified hostname that the client will connect with, since the client
1815 will typically also verify the hostname in the certificate. On the host holding the
1816 secure CA private key:
1818 @example
1819 # cat > server.info <<EOF
1820 organization = Name  of your organization
1821 cn = server.foo.example.com
1822 tls_www_server
1823 encryption_key
1824 signing_key
1826 # certtool --generate-privkey > server-key.pem
1827 # certtool --generate-certificate \
1828            --load-ca-certificate ca-cert.pem \
1829            --load-ca-privkey ca-key.pem \
1830            --load-privkey server server-key.pem \
1831            --template server.info \
1832            --outfile server-cert.pem
1833 @end example
1835 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1836 to the server for which they were generated. The @code{server-key.pem} is security
1837 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1839 @node vnc_generate_client
1840 @subsubsection Issuing client certificates
1842 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1843 certificates as its authentication mechanism, each client also needs to be issued
1844 a certificate. The client certificate contains enough metadata to uniquely identify
1845 the client, typically organization, state, city, building, etc. On the host holding
1846 the secure CA private key:
1848 @example
1849 # cat > client.info <<EOF
1850 country = GB
1851 state = London
1852 locality = London
1853 organiazation = Name of your organization
1854 cn = client.foo.example.com
1855 tls_www_client
1856 encryption_key
1857 signing_key
1859 # certtool --generate-privkey > client-key.pem
1860 # certtool --generate-certificate \
1861            --load-ca-certificate ca-cert.pem \
1862            --load-ca-privkey ca-key.pem \
1863            --load-privkey client-key.pem \
1864            --template client.info \
1865            --outfile client-cert.pem
1866 @end example
1868 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1869 copied to the client for which they were generated.
1871 @node gdb_usage
1872 @section GDB usage
1874 QEMU has a primitive support to work with gdb, so that you can do
1875 'Ctrl-C' while the virtual machine is running and inspect its state.
1877 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1878 gdb connection:
1879 @example
1880 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1881        -append "root=/dev/hda"
1882 Connected to host network interface: tun0
1883 Waiting gdb connection on port 1234
1884 @end example
1886 Then launch gdb on the 'vmlinux' executable:
1887 @example
1888 > gdb vmlinux
1889 @end example
1891 In gdb, connect to QEMU:
1892 @example
1893 (gdb) target remote localhost:1234
1894 @end example
1896 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1897 @example
1898 (gdb) c
1899 @end example
1901 Here are some useful tips in order to use gdb on system code:
1903 @enumerate
1904 @item
1905 Use @code{info reg} to display all the CPU registers.
1906 @item
1907 Use @code{x/10i $eip} to display the code at the PC position.
1908 @item
1909 Use @code{set architecture i8086} to dump 16 bit code. Then use
1910 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1911 @end enumerate
1913 @node pcsys_os_specific
1914 @section Target OS specific information
1916 @subsection Linux
1918 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1919 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1920 color depth in the guest and the host OS.
1922 When using a 2.6 guest Linux kernel, you should add the option
1923 @code{clock=pit} on the kernel command line because the 2.6 Linux
1924 kernels make very strict real time clock checks by default that QEMU
1925 cannot simulate exactly.
1927 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1928 not activated because QEMU is slower with this patch. The QEMU
1929 Accelerator Module is also much slower in this case. Earlier Fedora
1930 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1931 patch by default. Newer kernels don't have it.
1933 @subsection Windows
1935 If you have a slow host, using Windows 95 is better as it gives the
1936 best speed. Windows 2000 is also a good choice.
1938 @subsubsection SVGA graphic modes support
1940 QEMU emulates a Cirrus Logic GD5446 Video
1941 card. All Windows versions starting from Windows 95 should recognize
1942 and use this graphic card. For optimal performances, use 16 bit color
1943 depth in the guest and the host OS.
1945 If you are using Windows XP as guest OS and if you want to use high
1946 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1947 1280x1024x16), then you should use the VESA VBE virtual graphic card
1948 (option @option{-std-vga}).
1950 @subsubsection CPU usage reduction
1952 Windows 9x does not correctly use the CPU HLT
1953 instruction. The result is that it takes host CPU cycles even when
1954 idle. You can install the utility from
1955 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1956 problem. Note that no such tool is needed for NT, 2000 or XP.
1958 @subsubsection Windows 2000 disk full problem
1960 Windows 2000 has a bug which gives a disk full problem during its
1961 installation. When installing it, use the @option{-win2k-hack} QEMU
1962 option to enable a specific workaround. After Windows 2000 is
1963 installed, you no longer need this option (this option slows down the
1964 IDE transfers).
1966 @subsubsection Windows 2000 shutdown
1968 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1969 can. It comes from the fact that Windows 2000 does not automatically
1970 use the APM driver provided by the BIOS.
1972 In order to correct that, do the following (thanks to Struan
1973 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1974 Add/Troubleshoot a device => Add a new device & Next => No, select the
1975 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1976 (again) a few times. Now the driver is installed and Windows 2000 now
1977 correctly instructs QEMU to shutdown at the appropriate moment.
1979 @subsubsection Share a directory between Unix and Windows
1981 See @ref{sec_invocation} about the help of the option @option{-smb}.
1983 @subsubsection Windows XP security problem
1985 Some releases of Windows XP install correctly but give a security
1986 error when booting:
1987 @example
1988 A problem is preventing Windows from accurately checking the
1989 license for this computer. Error code: 0x800703e6.
1990 @end example
1992 The workaround is to install a service pack for XP after a boot in safe
1993 mode. Then reboot, and the problem should go away. Since there is no
1994 network while in safe mode, its recommended to download the full
1995 installation of SP1 or SP2 and transfer that via an ISO or using the
1996 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1998 @subsection MS-DOS and FreeDOS
2000 @subsubsection CPU usage reduction
2002 DOS does not correctly use the CPU HLT instruction. The result is that
2003 it takes host CPU cycles even when idle. You can install the utility
2004 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
2005 problem.
2007 @node QEMU System emulator for non PC targets
2008 @chapter QEMU System emulator for non PC targets
2010 QEMU is a generic emulator and it emulates many non PC
2011 machines. Most of the options are similar to the PC emulator. The
2012 differences are mentioned in the following sections.
2014 @menu
2015 * QEMU PowerPC System emulator::
2016 * Sparc32 System emulator::
2017 * Sparc64 System emulator::
2018 * MIPS System emulator::
2019 * ARM System emulator::
2020 * ColdFire System emulator::
2021 @end menu
2023 @node QEMU PowerPC System emulator
2024 @section QEMU PowerPC System emulator
2026 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
2027 or PowerMac PowerPC system.
2029 QEMU emulates the following PowerMac peripherals:
2031 @itemize @minus
2032 @item
2033 UniNorth PCI Bridge
2034 @item
2035 PCI VGA compatible card with VESA Bochs Extensions
2036 @item
2037 2 PMAC IDE interfaces with hard disk and CD-ROM support
2038 @item
2039 NE2000 PCI adapters
2040 @item
2041 Non Volatile RAM
2042 @item
2043 VIA-CUDA with ADB keyboard and mouse.
2044 @end itemize
2046 QEMU emulates the following PREP peripherals:
2048 @itemize @minus
2049 @item
2050 PCI Bridge
2051 @item
2052 PCI VGA compatible card with VESA Bochs Extensions
2053 @item
2054 2 IDE interfaces with hard disk and CD-ROM support
2055 @item
2056 Floppy disk
2057 @item
2058 NE2000 network adapters
2059 @item
2060 Serial port
2061 @item
2062 PREP Non Volatile RAM
2063 @item
2064 PC compatible keyboard and mouse.
2065 @end itemize
2067 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2068 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2070 @c man begin OPTIONS
2072 The following options are specific to the PowerPC emulation:
2074 @table @option
2076 @item -g WxH[xDEPTH]
2078 Set the initial VGA graphic mode. The default is 800x600x15.
2080 @end table
2082 @c man end
2085 More information is available at
2086 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2088 @node Sparc32 System emulator
2089 @section Sparc32 System emulator
2091 Use the executable @file{qemu-system-sparc} to simulate a SPARCstation
2092 5, SPARCstation 10, SPARCstation 20, SPARCserver 600MP (sun4m
2093 architecture), SPARCstation 2 (sun4c architecture), SPARCserver 1000,
2094 or SPARCcenter 2000 (sun4d architecture). The emulation is somewhat
2095 complete.  SMP up to 16 CPUs is supported, but Linux limits the number
2096 of usable CPUs to 4.
2098 QEMU emulates the following sun4m/sun4d peripherals:
2100 @itemize @minus
2101 @item
2102 IOMMU or IO-UNITs
2103 @item
2104 TCX Frame buffer
2105 @item
2106 Lance (Am7990) Ethernet
2107 @item
2108 Non Volatile RAM M48T08
2109 @item
2110 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2111 and power/reset logic
2112 @item
2113 ESP SCSI controller with hard disk and CD-ROM support
2114 @item
2115 Floppy drive (not on SS-600MP)
2116 @item
2117 CS4231 sound device (only on SS-5, not working yet)
2118 @end itemize
2120 The number of peripherals is fixed in the architecture.  Maximum
2121 memory size depends on the machine type, for SS-5 it is 256MB and for
2122 others 2047MB.
2124 Since version 0.8.2, QEMU uses OpenBIOS
2125 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2126 firmware implementation. The goal is to implement a 100% IEEE
2127 1275-1994 (referred to as Open Firmware) compliant firmware.
2129 A sample Linux 2.6 series kernel and ram disk image are available on
2130 the QEMU web site. Please note that currently NetBSD, OpenBSD or
2131 Solaris kernels don't work.
2133 @c man begin OPTIONS
2135 The following options are specific to the Sparc32 emulation:
2137 @table @option
2139 @item -g WxHx[xDEPTH]
2141 Set the initial TCX graphic mode. The default is 1024x768x8, currently
2142 the only other possible mode is 1024x768x24.
2144 @item -prom-env string
2146 Set OpenBIOS variables in NVRAM, for example:
2148 @example
2149 qemu-system-sparc -prom-env 'auto-boot?=false' \
2150  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2151 @end example
2153 @item -M [SS-5|SS-10|SS-20|SS-600MP|SS-2|SS-1000|SS-2000]
2155 Set the emulated machine type. Default is SS-5.
2157 @end table
2159 @c man end
2161 @node Sparc64 System emulator
2162 @section Sparc64 System emulator
2164 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
2165 The emulator is not usable for anything yet.
2167 QEMU emulates the following sun4u peripherals:
2169 @itemize @minus
2170 @item
2171 UltraSparc IIi APB PCI Bridge
2172 @item
2173 PCI VGA compatible card with VESA Bochs Extensions
2174 @item
2175 Non Volatile RAM M48T59
2176 @item
2177 PC-compatible serial ports
2178 @end itemize
2180 @node MIPS System emulator
2181 @section MIPS System emulator
2183 Four executables cover simulation of 32 and 64-bit MIPS systems in
2184 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2185 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2186 Four different machine types are emulated:
2188 @itemize @minus
2189 @item
2190 A generic ISA PC-like machine "mips"
2191 @item
2192 The MIPS Malta prototype board "malta"
2193 @item
2194 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2195 @item
2196 MIPS emulator pseudo board "mipssim"
2197 @end itemize
2199 The generic emulation is supported by Debian 'Etch' and is able to
2200 install Debian into a virtual disk image. The following devices are
2201 emulated:
2203 @itemize @minus
2204 @item
2205 A range of MIPS CPUs, default is the 24Kf
2206 @item
2207 PC style serial port
2208 @item
2209 PC style IDE disk
2210 @item
2211 NE2000 network card
2212 @end itemize
2214 The Malta emulation supports the following devices:
2216 @itemize @minus
2217 @item
2218 Core board with MIPS 24Kf CPU and Galileo system controller
2219 @item
2220 PIIX4 PCI/USB/SMbus controller
2221 @item
2222 The Multi-I/O chip's serial device
2223 @item
2224 PCnet32 PCI network card
2225 @item
2226 Malta FPGA serial device
2227 @item
2228 Cirrus VGA graphics card
2229 @end itemize
2231 The ACER Pica emulation supports:
2233 @itemize @minus
2234 @item
2235 MIPS R4000 CPU
2236 @item
2237 PC-style IRQ and DMA controllers
2238 @item
2239 PC Keyboard
2240 @item
2241 IDE controller
2242 @end itemize
2244 The mipssim pseudo board emulation provides an environment similiar
2245 to what the proprietary MIPS emulator uses for running Linux.
2246 It supports:
2248 @itemize @minus
2249 @item
2250 A range of MIPS CPUs, default is the 24Kf
2251 @item
2252 PC style serial port
2253 @item
2254 MIPSnet network emulation
2255 @end itemize
2257 @node ARM System emulator
2258 @section ARM System emulator
2260 Use the executable @file{qemu-system-arm} to simulate a ARM
2261 machine. The ARM Integrator/CP board is emulated with the following
2262 devices:
2264 @itemize @minus
2265 @item
2266 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2267 @item
2268 Two PL011 UARTs
2269 @item
2270 SMC 91c111 Ethernet adapter
2271 @item
2272 PL110 LCD controller
2273 @item
2274 PL050 KMI with PS/2 keyboard and mouse.
2275 @item
2276 PL181 MultiMedia Card Interface with SD card.
2277 @end itemize
2279 The ARM Versatile baseboard is emulated with the following devices:
2281 @itemize @minus
2282 @item
2283 ARM926E, ARM1136 or Cortex-A8 CPU
2284 @item
2285 PL190 Vectored Interrupt Controller
2286 @item
2287 Four PL011 UARTs
2288 @item
2289 SMC 91c111 Ethernet adapter
2290 @item
2291 PL110 LCD controller
2292 @item
2293 PL050 KMI with PS/2 keyboard and mouse.
2294 @item
2295 PCI host bridge.  Note the emulated PCI bridge only provides access to
2296 PCI memory space.  It does not provide access to PCI IO space.
2297 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2298 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2299 mapped control registers.
2300 @item
2301 PCI OHCI USB controller.
2302 @item
2303 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2304 @item
2305 PL181 MultiMedia Card Interface with SD card.
2306 @end itemize
2308 The ARM RealView Emulation baseboard is emulated with the following devices:
2310 @itemize @minus
2311 @item
2312 ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2313 @item
2314 ARM AMBA Generic/Distributed Interrupt Controller
2315 @item
2316 Four PL011 UARTs
2317 @item
2318 SMC 91c111 Ethernet adapter
2319 @item
2320 PL110 LCD controller
2321 @item
2322 PL050 KMI with PS/2 keyboard and mouse
2323 @item
2324 PCI host bridge
2325 @item
2326 PCI OHCI USB controller
2327 @item
2328 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2329 @item
2330 PL181 MultiMedia Card Interface with SD card.
2331 @end itemize
2333 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2334 and "Terrier") emulation includes the following peripherals:
2336 @itemize @minus
2337 @item
2338 Intel PXA270 System-on-chip (ARM V5TE core)
2339 @item
2340 NAND Flash memory
2341 @item
2342 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2343 @item
2344 On-chip OHCI USB controller
2345 @item
2346 On-chip LCD controller
2347 @item
2348 On-chip Real Time Clock
2349 @item
2350 TI ADS7846 touchscreen controller on SSP bus
2351 @item
2352 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2353 @item
2354 GPIO-connected keyboard controller and LEDs
2355 @item
2356 Secure Digital card connected to PXA MMC/SD host
2357 @item
2358 Three on-chip UARTs
2359 @item
2360 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2361 @end itemize
2363 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2364 following elements:
2366 @itemize @minus
2367 @item
2368 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2369 @item
2370 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2371 @item
2372 On-chip LCD controller
2373 @item
2374 On-chip Real Time Clock
2375 @item
2376 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2377 CODEC, connected through MicroWire and I@math{^2}S busses
2378 @item
2379 GPIO-connected matrix keypad
2380 @item
2381 Secure Digital card connected to OMAP MMC/SD host
2382 @item
2383 Three on-chip UARTs
2384 @end itemize
2386 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2387 devices:
2389 @itemize @minus
2390 @item
2391 Cortex-M3 CPU core.
2392 @item
2393 64k Flash and 8k SRAM.
2394 @item
2395 Timers, UARTs, ADC and I@math{^2}C interface.
2396 @item
2397 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2398 @end itemize
2400 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2401 devices:
2403 @itemize @minus
2404 @item
2405 Cortex-M3 CPU core.
2406 @item
2407 256k Flash and 64k SRAM.
2408 @item
2409 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2410 @item
2411 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2412 @end itemize
2414 A Linux 2.6 test image is available on the QEMU web site. More
2415 information is available in the QEMU mailing-list archive.
2417 @node ColdFire System emulator
2418 @section ColdFire System emulator
2420 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2421 The emulator is able to boot a uClinux kernel.
2423 The M5208EVB emulation includes the following devices:
2425 @itemize @minus
2426 @item
2427 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2428 @item
2429 Three Two on-chip UARTs.
2430 @item
2431 Fast Ethernet Controller (FEC)
2432 @end itemize
2434 The AN5206 emulation includes the following devices:
2436 @itemize @minus
2437 @item
2438 MCF5206 ColdFire V2 Microprocessor.
2439 @item
2440 Two on-chip UARTs.
2441 @end itemize
2443 @node QEMU User space emulator
2444 @chapter QEMU User space emulator
2446 @menu
2447 * Supported Operating Systems ::
2448 * Linux User space emulator::
2449 * Mac OS X/Darwin User space emulator ::
2450 @end menu
2452 @node Supported Operating Systems
2453 @section Supported Operating Systems
2455 The following OS are supported in user space emulation:
2457 @itemize @minus
2458 @item
2459 Linux (referred as qemu-linux-user)
2460 @item
2461 Mac OS X/Darwin (referred as qemu-darwin-user)
2462 @end itemize
2464 @node Linux User space emulator
2465 @section Linux User space emulator
2467 @menu
2468 * Quick Start::
2469 * Wine launch::
2470 * Command line options::
2471 * Other binaries::
2472 @end menu
2474 @node Quick Start
2475 @subsection Quick Start
2477 In order to launch a Linux process, QEMU needs the process executable
2478 itself and all the target (x86) dynamic libraries used by it.
2480 @itemize
2482 @item On x86, you can just try to launch any process by using the native
2483 libraries:
2485 @example
2486 qemu-i386 -L / /bin/ls
2487 @end example
2489 @code{-L /} tells that the x86 dynamic linker must be searched with a
2490 @file{/} prefix.
2492 @item Since QEMU is also a linux process, you can launch qemu with
2493 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2495 @example
2496 qemu-i386 -L / qemu-i386 -L / /bin/ls
2497 @end example
2499 @item On non x86 CPUs, you need first to download at least an x86 glibc
2500 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2501 @code{LD_LIBRARY_PATH} is not set:
2503 @example
2504 unset LD_LIBRARY_PATH
2505 @end example
2507 Then you can launch the precompiled @file{ls} x86 executable:
2509 @example
2510 qemu-i386 tests/i386/ls
2511 @end example
2512 You can look at @file{qemu-binfmt-conf.sh} so that
2513 QEMU is automatically launched by the Linux kernel when you try to
2514 launch x86 executables. It requires the @code{binfmt_misc} module in the
2515 Linux kernel.
2517 @item The x86 version of QEMU is also included. You can try weird things such as:
2518 @example
2519 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2520           /usr/local/qemu-i386/bin/ls-i386
2521 @end example
2523 @end itemize
2525 @node Wine launch
2526 @subsection Wine launch
2528 @itemize
2530 @item Ensure that you have a working QEMU with the x86 glibc
2531 distribution (see previous section). In order to verify it, you must be
2532 able to do:
2534 @example
2535 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2536 @end example
2538 @item Download the binary x86 Wine install
2539 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2541 @item Configure Wine on your account. Look at the provided script
2542 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2543 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2545 @item Then you can try the example @file{putty.exe}:
2547 @example
2548 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2549           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2550 @end example
2552 @end itemize
2554 @node Command line options
2555 @subsection Command line options
2557 @example
2558 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2559 @end example
2561 @table @option
2562 @item -h
2563 Print the help
2564 @item -L path
2565 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2566 @item -s size
2567 Set the x86 stack size in bytes (default=524288)
2568 @end table
2570 Debug options:
2572 @table @option
2573 @item -d
2574 Activate log (logfile=/tmp/qemu.log)
2575 @item -p pagesize
2576 Act as if the host page size was 'pagesize' bytes
2577 @end table
2579 Environment variables:
2581 @table @env
2582 @item QEMU_STRACE
2583 Print system calls and arguments similar to the 'strace' program
2584 (NOTE: the actual 'strace' program will not work because the user
2585 space emulator hasn't implemented ptrace).  At the moment this is
2586 incomplete.  All system calls that don't have a specific argument
2587 format are printed with information for six arguments.  Many
2588 flag-style arguments don't have decoders and will show up as numbers.
2589 @end table
2591 @node Other binaries
2592 @subsection Other binaries
2594 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2595 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2596 configurations), and arm-uclinux bFLT format binaries.
2598 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2599 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2600 coldfire uClinux bFLT format binaries.
2602 The binary format is detected automatically.
2604 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2605 (Sparc64 CPU, 32 bit ABI).
2607 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2608 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2610 @node Mac OS X/Darwin User space emulator
2611 @section Mac OS X/Darwin User space emulator
2613 @menu
2614 * Mac OS X/Darwin Status::
2615 * Mac OS X/Darwin Quick Start::
2616 * Mac OS X/Darwin Command line options::
2617 @end menu
2619 @node Mac OS X/Darwin Status
2620 @subsection Mac OS X/Darwin Status
2622 @itemize @minus
2623 @item
2624 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2625 @item
2626 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2627 @item
2628 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
2629 @item
2630 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2631 @end itemize
2633 [1] If you're host commpage can be executed by qemu.
2635 @node Mac OS X/Darwin Quick Start
2636 @subsection Quick Start
2638 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2639 itself and all the target dynamic libraries used by it. If you don't have the FAT
2640 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2641 CD or compile them by hand.
2643 @itemize
2645 @item On x86, you can just try to launch any process by using the native
2646 libraries:
2648 @example
2649 qemu-i386 /bin/ls
2650 @end example
2652 or to run the ppc version of the executable:
2654 @example
2655 qemu-ppc /bin/ls
2656 @end example
2658 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2659 are installed:
2661 @example
2662 qemu-i386 -L /opt/x86_root/ /bin/ls
2663 @end example
2665 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2666 @file{/opt/x86_root/usr/bin/dyld}.
2668 @end itemize
2670 @node Mac OS X/Darwin Command line options
2671 @subsection Command line options
2673 @example
2674 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2675 @end example
2677 @table @option
2678 @item -h
2679 Print the help
2680 @item -L path
2681 Set the library root path (default=/)
2682 @item -s size
2683 Set the stack size in bytes (default=524288)
2684 @end table
2686 Debug options:
2688 @table @option
2689 @item -d
2690 Activate log (logfile=/tmp/qemu.log)
2691 @item -p pagesize
2692 Act as if the host page size was 'pagesize' bytes
2693 @end table
2695 @node compilation
2696 @chapter Compilation from the sources
2698 @menu
2699 * Linux/Unix::
2700 * Windows::
2701 * Cross compilation for Windows with Linux::
2702 * Mac OS X::
2703 @end menu
2705 @node Linux/Unix
2706 @section Linux/Unix
2708 @subsection Compilation
2710 First you must decompress the sources:
2711 @example
2712 cd /tmp
2713 tar zxvf qemu-x.y.z.tar.gz
2714 cd qemu-x.y.z
2715 @end example
2717 Then you configure QEMU and build it (usually no options are needed):
2718 @example
2719 ./configure
2720 make
2721 @end example
2723 Then type as root user:
2724 @example
2725 make install
2726 @end example
2727 to install QEMU in @file{/usr/local}.
2729 @subsection GCC version
2731 In order to compile QEMU successfully, it is very important that you
2732 have the right tools. The most important one is gcc. On most hosts and
2733 in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2734 Linux distribution includes a gcc 4.x compiler, you can usually
2735 install an older version (it is invoked by @code{gcc32} or
2736 @code{gcc34}). The QEMU configure script automatically probes for
2737 these older versions so that usually you don't have to do anything.
2739 @node Windows
2740 @section Windows
2742 @itemize
2743 @item Install the current versions of MSYS and MinGW from
2744 @url{http://www.mingw.org/}. You can find detailed installation
2745 instructions in the download section and the FAQ.
2747 @item Download
2748 the MinGW development library of SDL 1.2.x
2749 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2750 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
2751 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2752 directory. Edit the @file{sdl-config} script so that it gives the
2753 correct SDL directory when invoked.
2755 @item Extract the current version of QEMU.
2757 @item Start the MSYS shell (file @file{msys.bat}).
2759 @item Change to the QEMU directory. Launch @file{./configure} and
2760 @file{make}.  If you have problems using SDL, verify that
2761 @file{sdl-config} can be launched from the MSYS command line.
2763 @item You can install QEMU in @file{Program Files/Qemu} by typing
2764 @file{make install}. Don't forget to copy @file{SDL.dll} in
2765 @file{Program Files/Qemu}.
2767 @end itemize
2769 @node Cross compilation for Windows with Linux
2770 @section Cross compilation for Windows with Linux
2772 @itemize
2773 @item
2774 Install the MinGW cross compilation tools available at
2775 @url{http://www.mingw.org/}.
2777 @item
2778 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2779 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2780 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2781 the QEMU configuration script.
2783 @item
2784 Configure QEMU for Windows cross compilation:
2785 @example
2786 ./configure --enable-mingw32
2787 @end example
2788 If necessary, you can change the cross-prefix according to the prefix
2789 chosen for the MinGW tools with --cross-prefix. You can also use
2790 --prefix to set the Win32 install path.
2792 @item You can install QEMU in the installation directory by typing
2793 @file{make install}. Don't forget to copy @file{SDL.dll} in the
2794 installation directory.
2796 @end itemize
2798 Note: Currently, Wine does not seem able to launch
2799 QEMU for Win32.
2801 @node Mac OS X
2802 @section Mac OS X
2804 The Mac OS X patches are not fully merged in QEMU, so you should look
2805 at the QEMU mailing list archive to have all the necessary
2806 information.
2808 @node Index
2809 @chapter Index
2810 @printindex cp
2812 @bye