Fix kvm_tpr_opt_setup() args
[qemu-kvm/fedora.git] / qemu-doc.texi
blobf3bc4893bf812b4ecf749d42a96b7dfa9ed8a341
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/Sun4v (64-bit Sparc processor, in progress)
79 @item Malta board (32-bit and 64-bit MIPS processors)
80 @item MIPS Magnum (64-bit MIPS processor)
81 @item ARM Integrator/CP (ARM)
82 @item ARM Versatile baseboard (ARM)
83 @item ARM RealView Emulation baseboard (ARM)
84 @item Spitz, Akita, Borzoi, Terrier and Tosa PDAs (PXA270 processor)
85 @item Luminary Micro LM3S811EVB (ARM Cortex-M3)
86 @item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
87 @item Freescale MCF5208EVB (ColdFire V2).
88 @item Arnewsh MCF5206 evaluation board (ColdFire V2).
89 @item Palm Tungsten|E PDA (OMAP310 processor)
90 @item N800 and N810 tablets (OMAP2420 processor)
91 @item MusicPal (MV88W8618 ARM processor)
92 @item Gumstix "Connex" and "Verdex" motherboards (PXA255/270).
93 @item Siemens SX1 smartphone (OMAP310 processor)
94 @end itemize
96 For user emulation, x86, PowerPC, ARM, 32-bit MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
98 @node Installation
99 @chapter Installation
101 If you want to compile QEMU yourself, see @ref{compilation}.
103 @menu
104 * install_linux::   Linux
105 * install_windows:: Windows
106 * install_mac::     Macintosh
107 @end menu
109 @node install_linux
110 @section Linux
112 If a precompiled package is available for your distribution - you just
113 have to install it. Otherwise, see @ref{compilation}.
115 @node install_windows
116 @section Windows
118 Download the experimental binary installer at
119 @url{http://www.free.oszoo.org/@/download.html}.
121 @node install_mac
122 @section Mac OS X
124 Download the experimental binary installer at
125 @url{http://www.free.oszoo.org/@/download.html}.
127 @node QEMU PC System emulator
128 @chapter QEMU PC System emulator
130 @menu
131 * pcsys_introduction:: Introduction
132 * pcsys_quickstart::   Quick Start
133 * sec_invocation::     Invocation
134 * pcsys_keys::         Keys
135 * pcsys_monitor::      QEMU Monitor
136 * disk_images::        Disk Images
137 * pcsys_network::      Network emulation
138 * direct_linux_boot::  Direct Linux Boot
139 * pcsys_usb::          USB emulation
140 * vnc_security::       VNC security
141 * gdb_usage::          GDB usage
142 * pcsys_os_specific::  Target OS specific information
143 @end menu
145 @node pcsys_introduction
146 @section Introduction
148 @c man begin DESCRIPTION
150 The QEMU PC System emulator simulates the
151 following peripherals:
153 @itemize @minus
154 @item
155 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
156 @item
157 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
158 extensions (hardware level, including all non standard modes).
159 @item
160 PS/2 mouse and keyboard
161 @item
162 2 PCI IDE interfaces with hard disk and CD-ROM support
163 @item
164 Floppy disk
165 @item
166 PCI/ISA PCI network adapters
167 @item
168 Serial ports
169 @item
170 Creative SoundBlaster 16 sound card
171 @item
172 ENSONIQ AudioPCI ES1370 sound card
173 @item
174 Intel 82801AA AC97 Audio compatible sound card
175 @item
176 Adlib(OPL2) - Yamaha YM3812 compatible chip
177 @item
178 Gravis Ultrasound GF1 sound card
179 @item
180 CS4231A compatible sound card
181 @item
182 PCI UHCI USB controller and a virtual USB hub.
183 @end itemize
185 SMP is supported with up to 255 CPUs.
187 Note that adlib, ac97, gus and cs4231a are only available when QEMU
188 was configured with --audio-card-list option containing the name(s) of
189 required card(s).
191 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
192 VGA BIOS.
194 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
196 QEMU uses GUS emulation(GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
197 by Tibor "TS" Schütz.
199 CS4231A is the chip used in Windows Sound System and GUSMAX products
201 @c man end
203 @node pcsys_quickstart
204 @section Quick Start
206 Download and uncompress the linux image (@file{linux.img}) and type:
208 @example
209 qemu linux.img
210 @end example
212 Linux should boot and give you a prompt.
214 @node sec_invocation
215 @section Invocation
217 @example
218 @c man begin SYNOPSIS
219 usage: qemu [options] [@var{disk_image}]
220 @c man end
221 @end example
223 @c man begin OPTIONS
224 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
226 General options:
227 @table @option
228 @item -M @var{machine}
229 Select the emulated @var{machine} (@code{-M ?} for list)
231 @item -fda @var{file}
232 @item -fdb @var{file}
233 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
234 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
236 @item -hda @var{file}
237 @item -hdb @var{file}
238 @item -hdc @var{file}
239 @item -hdd @var{file}
240 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
242 @item -cdrom @var{file}
243 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
244 @option{-cdrom} at the same time). You can use the host CD-ROM by
245 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
247 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
249 Define a new drive. Valid options are:
251 @table @code
252 @item file=@var{file}
253 This option defines which disk image (@pxref{disk_images}) to use with
254 this drive. If the filename contains comma, you must double it
255 (for instance, "file=my,,file" to use file "my,file").
256 @item if=@var{interface}
257 This option defines on which type on interface the drive is connected.
258 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
259 @item bus=@var{bus},unit=@var{unit}
260 These options define where is connected the drive by defining the bus number and
261 the unit id.
262 @item index=@var{index}
263 This option defines where is connected the drive by using an index in the list
264 of available connectors of a given interface type.
265 @item media=@var{media}
266 This option defines the type of the media: disk or cdrom.
267 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
268 These options have the same definition as they have in @option{-hdachs}.
269 @item snapshot=@var{snapshot}
270 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
271 @item cache=@var{cache}
272 @var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
273 @item format=@var{format}
274 Specify which disk @var{format} will be used rather than detecting
275 the format.  Can be used to specifiy format=raw to avoid interpreting
276 an untrusted format header.
277 @item boot=@var{boot}
278 @var{boot} if "on" enables extboot for a given drive so it can be used as a boot drive.
279 @end table
281 By default, writethrough caching is used for all block device.  This means that
282 the host page cache will be used to read and write data but write notification
283 will be sent to the guest only when the data has been reported as written by
284 the storage subsystem.
286 Writeback caching will report data writes as completed as soon as the data is
287 present in the host page cache.  This is safe as long as you trust your host.
288 If your host crashes or loses power, then the guest may experience data
289 corruption.  When using the @option{-snapshot} option, writeback caching is
290 used by default.
292 The host page can be avoided entirely with @option{cache=none}.  This will
293 attempt to do disk IO directly to the guests memory.  QEMU may still perform
294 an internal copy of the data.
296 Some block drivers perform badly with @option{cache=writethrough}, most notably,
297 qcow2.  If performance is more important than correctness,
298 @option{cache=writeback} should be used with qcow2.  By default, if no explicit
299 caching is specified for a qcow2 disk image, @option{cache=writeback} will be
300 used.  For all other disk types, @option{cache=writethrough} is the default.
302 Instead of @option{-cdrom} you can use:
303 @example
304 qemu -drive file=file,index=2,media=cdrom
305 @end example
307 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
308 use:
309 @example
310 qemu -drive file=file,index=0,media=disk
311 qemu -drive file=file,index=1,media=disk
312 qemu -drive file=file,index=2,media=disk
313 qemu -drive file=file,index=3,media=disk
314 @end example
316 You can connect a CDROM to the slave of ide0:
317 @example
318 qemu -drive file=file,if=ide,index=1,media=cdrom
319 @end example
321 If you don't specify the "file=" argument, you define an empty drive:
322 @example
323 qemu -drive if=ide,index=1,media=cdrom
324 @end example
326 You can connect a SCSI disk with unit ID 6 on the bus #0:
327 @example
328 qemu -drive file=file,if=scsi,bus=0,unit=6
329 @end example
331 To boot from a SCSI disk, one would use:
333 @example
334 qemu -drive file=file,if=scsi,boot=on
335 @end example
337 Instead of @option{-fda}, @option{-fdb}, you can use:
338 @example
339 qemu -drive file=file,index=0,if=floppy
340 qemu -drive file=file,index=1,if=floppy
341 @end example
343 By default, @var{interface} is "ide" and @var{index} is automatically
344 incremented:
345 @example
346 qemu -drive file=a -drive file=b"
347 @end example
348 is interpreted like:
349 @example
350 qemu -hda a -hdb b
351 @end example
353 @item -boot [a|c|d|n]
354 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
355 is the default.
357 @item -snapshot
358 Write to temporary files instead of disk image files. In this case,
359 the raw disk image you use is not written back. You can however force
360 the write back by pressing @key{C-a s} (@pxref{disk_images}).
362 @item -no-fd-bootchk
363 Disable boot signature checking for floppy disks in Bochs BIOS. It may
364 be needed to boot from old floppy disks.
366 @item -m @var{megs}
367 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
368 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
369 gigabytes respectively.
371 @item -cpu @var{model}
372 Select CPU model (-cpu ? for list and additional feature selection)
374 @item -smp @var{n}
375 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
376 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
377 to 4.
379 @item -audio-help
381 Will show the audio subsystem help: list of drivers, tunable
382 parameters.
384 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
386 Enable audio and selected sound hardware. Use ? to print all
387 available sound hardware.
389 @example
390 qemu -soundhw sb16,adlib disk.img
391 qemu -soundhw es1370 disk.img
392 qemu -soundhw ac97 disk.img
393 qemu -soundhw all disk.img
394 qemu -soundhw ?
395 @end example
397 Note that Linux's i810_audio OSS kernel (for AC97) module might
398 require manually specifying clocking.
400 @example
401 modprobe i810_audio clocking=48000
402 @end example
404 @item -localtime
405 Set the real time clock to local time (the default is to UTC
406 time). This option is needed to have correct date in MS-DOS or
407 Windows.
409 @item -startdate @var{date}
410 Set the initial date of the real time clock. Valid formats for
411 @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
412 @code{2006-06-17}. The default value is @code{now}.
414 @item -pidfile @var{file}
415 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
416 from a script.
418 @item -daemonize
419 Daemonize the QEMU process after initialization.  QEMU will not detach from
420 standard IO until it is ready to receive connections on any of its devices.
421 This option is a useful way for external programs to launch QEMU without having
422 to cope with initialization race conditions.
424 @item -win2k-hack
425 Use it when installing Windows 2000 to avoid a disk full bug. After
426 Windows 2000 is installed, you no longer need this option (this option
427 slows down the IDE transfers).
429 @item -option-rom @var{file}
430 Load the contents of @var{file} as an option ROM.
431 This option is useful to load things like EtherBoot.
433 @item -name @var{name}
434 Sets the @var{name} of the guest.
435 This name will be displayed in the SDL window caption.
436 The @var{name} will also be used for the VNC server.
438 @end table
440 Display options:
441 @table @option
443 @item -nographic
445 Normally, QEMU uses SDL to display the VGA output. With this option,
446 you can totally disable graphical output so that QEMU is a simple
447 command line application. The emulated serial port is redirected on
448 the console. Therefore, you can still use QEMU to debug a Linux kernel
449 with a serial console.
451 @item -curses
453 Normally, QEMU uses SDL to display the VGA output.  With this option,
454 QEMU can display the VGA output when in text mode using a 
455 curses/ncurses interface.  Nothing is displayed in graphical mode.
457 @item -no-frame
459 Do not use decorations for SDL windows and start them using the whole
460 available screen space. This makes the using QEMU in a dedicated desktop
461 workspace more convenient.
463 @item -no-quit
465 Disable SDL window close capability.
467 @item -full-screen
468 Start in full screen.
470 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
472 Normally, QEMU uses SDL to display the VGA output.  With this option,
473 you can have QEMU listen on VNC display @var{display} and redirect the VGA
474 display over the VNC session.  It is very useful to enable the usb
475 tablet device when using this option (option @option{-usbdevice
476 tablet}). When using the VNC display, you must use the @option{-k}
477 parameter to set the keyboard layout if you are not using en-us. Valid
478 syntax for the @var{display} is
480 @table @code
482 @item @var{host}:@var{d}
484 TCP connections will only be allowed from @var{host} on display @var{d}.
485 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
486 be omitted in which case the server will accept connections from any host.
488 @item @code{unix}:@var{path}
490 Connections will be allowed over UNIX domain sockets where @var{path} is the
491 location of a unix socket to listen for connections on.
493 @item none
495 VNC is initialized but not started. The monitor @code{change} command
496 can be used to later start the VNC server.
498 @end table
500 Following the @var{display} value there may be one or more @var{option} flags
501 separated by commas. Valid options are
503 @table @code
505 @item reverse
507 Connect to a listening VNC client via a ``reverse'' connection. The
508 client is specified by the @var{display}. For reverse network
509 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
510 is a TCP port number, not a display number.
512 @item password
514 Require that password based authentication is used for client connections.
515 The password must be set separately using the @code{change} command in the
516 @ref{pcsys_monitor}
518 @item tls
520 Require that client use TLS when communicating with the VNC server. This
521 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
522 attack. It is recommended that this option be combined with either the
523 @var{x509} or @var{x509verify} options.
525 @item x509=@var{/path/to/certificate/dir}
527 Valid if @option{tls} is specified. Require that x509 credentials are used
528 for negotiating the TLS session. The server will send its x509 certificate
529 to the client. It is recommended that a password be set on the VNC server
530 to provide authentication of the client when this is used. The path following
531 this option specifies where the x509 certificates are to be loaded from.
532 See the @ref{vnc_security} section for details on generating certificates.
534 @item x509verify=@var{/path/to/certificate/dir}
536 Valid if @option{tls} is specified. Require that x509 credentials are used
537 for negotiating the TLS session. The server will send its x509 certificate
538 to the client, and request that the client send its own x509 certificate.
539 The server will validate the client's certificate against the CA certificate,
540 and reject clients when validation fails. If the certificate authority is
541 trusted, this is a sufficient authentication mechanism. You may still wish
542 to set a password on the VNC server as a second authentication layer. The
543 path following this option specifies where the x509 certificates are to
544 be loaded from. See the @ref{vnc_security} section for details on generating
545 certificates.
547 @end table
549 @item -k @var{language}
551 Use keyboard layout @var{language} (for example @code{fr} for
552 French). This option is only needed where it is not easy to get raw PC
553 keycodes (e.g. on Macs, with some X11 servers or with a VNC
554 display). You don't normally need to use it on PC/Linux or PC/Windows
555 hosts.
557 The available layouts are:
558 @example
559 ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
560 da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
561 de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
562 @end example
564 The default is @code{en-us}.
566 @end table
568 USB options:
569 @table @option
571 @item -usb
572 Enable the USB driver (will be the default soon)
574 @item -usbdevice @var{devname}
575 Add the USB device @var{devname}. @xref{usb_devices}.
577 @table @code
579 @item mouse
580 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
582 @item tablet
583 Pointer device that uses absolute coordinates (like a touchscreen). This
584 means qemu is able to report the mouse position without having to grab the
585 mouse. Also overrides the PS/2 mouse emulation when activated.
587 @item disk:[format=@var{format}]:file
588 Mass storage device based on file. The optional @var{format} argument
589 will be used rather than detecting the format. Can be used to specifiy
590 format=raw to avoid interpreting an untrusted format header.
592 @item host:bus.addr
593 Pass through the host device identified by bus.addr (Linux only).
595 @item host:vendor_id:product_id
596 Pass through the host device identified by vendor_id:product_id (Linux only).
598 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
599 Serial converter to host character device @var{dev}, see @code{-serial} for the
600 available devices.
602 @item braille
603 Braille device.  This will use BrlAPI to display the braille output on a real
604 or fake device.
606 @item net:options
607 Network adapter that supports CDC ethernet and RNDIS protocols.
609 @end table
611 @end table
613 Network options:
615 @table @option
617 @item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
618 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
619 = 0 is the default). The NIC is an rtl8139 by default on the PC
620 target. Optionally, the MAC address can be changed. If no
621 @option{-net} option is specified, a single NIC is created.
622 Qemu can emulate several different models of network card.
623 Valid values for @var{type} are
624 @code{i82551}, @code{i82557b}, @code{i82559er},
625 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
626 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
627 Not all devices are supported on all targets.  Use -net nic,model=?
628 for a list of available devices for your target.
630 @item -net user[,vlan=@var{n}][,hostname=@var{name}]
631 Use the user mode network stack which requires no administrator
632 privilege to run.  @option{hostname=name} can be used to specify the client
633 hostname reported by the builtin DHCP server.
635 @item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
636 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
637 the network script @var{file} to configure it and the network script 
638 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS 
639 automatically provides one. @option{fd}=@var{h} can be used to specify
640 the handle of an already opened host TAP interface. The default network 
641 configure script is @file{/etc/qemu-ifup} and the default network 
642 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 
643 or @option{downscript=no} to disable script execution. Example:
645 @example
646 qemu linux.img -net nic -net tap
647 @end example
649 More complicated example (two NICs, each one connected to a TAP device)
650 @example
651 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
652                -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
653 @end example
656 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
658 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
659 machine using a TCP socket connection. If @option{listen} is
660 specified, QEMU waits for incoming connections on @var{port}
661 (@var{host} is optional). @option{connect} is used to connect to
662 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
663 specifies an already opened TCP socket.
665 Example:
666 @example
667 # launch a first QEMU instance
668 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
669                -net socket,listen=:1234
670 # connect the VLAN 0 of this instance to the VLAN 0
671 # of the first instance
672 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
673                -net socket,connect=127.0.0.1:1234
674 @end example
676 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
678 Create a VLAN @var{n} shared with another QEMU virtual
679 machines using a UDP multicast socket, effectively making a bus for
680 every QEMU with same multicast address @var{maddr} and @var{port}.
681 NOTES:
682 @enumerate
683 @item
684 Several QEMU can be running on different hosts and share same bus (assuming
685 correct multicast setup for these hosts).
686 @item
687 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
688 @url{http://user-mode-linux.sf.net}.
689 @item
690 Use @option{fd=h} to specify an already opened UDP multicast socket.
691 @end enumerate
693 Example:
694 @example
695 # launch one QEMU instance
696 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
697                -net socket,mcast=230.0.0.1:1234
698 # launch another QEMU instance on same "bus"
699 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
700                -net socket,mcast=230.0.0.1:1234
701 # launch yet another QEMU instance on same "bus"
702 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
703                -net socket,mcast=230.0.0.1:1234
704 @end example
706 Example (User Mode Linux compat.):
707 @example
708 # launch QEMU instance (note mcast address selected
709 # is UML's default)
710 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
711                -net socket,mcast=239.192.168.1:1102
712 # launch UML
713 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
714 @end example
716 @item -net vde[,vlan=@var{n}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
717 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
718 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
719 and MODE @var{octalmode} to change default ownership and permissions for
720 communication port. This option is available only if QEMU has been compiled
721 with vde support enabled.
723 Example:
724 @example
725 # launch vde switch
726 vde_switch -F -sock /tmp/myswitch
727 # launch QEMU instance
728 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
729 @end example
731 @item -net none
732 Indicate that no network devices should be configured. It is used to
733 override the default configuration (@option{-net nic -net user}) which
734 is activated if no @option{-net} options are provided.
736 @item -tftp @var{dir}
737 When using the user mode network stack, activate a built-in TFTP
738 server. The files in @var{dir} will be exposed as the root of a TFTP server.
739 The TFTP client on the guest must be configured in binary mode (use the command
740 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
741 usual 10.0.2.2.
743 @item -bootp @var{file}
744 When using the user mode network stack, broadcast @var{file} as the BOOTP
745 filename.  In conjunction with @option{-tftp}, this can be used to network boot
746 a guest from a local directory.
748 Example (using pxelinux):
749 @example
750 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
751 @end example
753 @item -smb @var{dir}
754 When using the user mode network stack, activate a built-in SMB
755 server so that Windows OSes can access to the host files in @file{@var{dir}}
756 transparently.
758 In the guest Windows OS, the line:
759 @example
760 10.0.2.4 smbserver
761 @end example
762 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
763 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
765 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
767 Note that a SAMBA server must be installed on the host OS in
768 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
769 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
771 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
773 When using the user mode network stack, redirect incoming TCP or UDP
774 connections to the host port @var{host-port} to the guest
775 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
776 is not specified, its value is 10.0.2.15 (default address given by the
777 built-in DHCP server).
779 For example, to redirect host X11 connection from screen 1 to guest
780 screen 0, use the following:
782 @example
783 # on the host
784 qemu -redir tcp:6001::6000 [...]
785 # this host xterm should open in the guest X11 server
786 xterm -display :1
787 @end example
789 To redirect telnet connections from host port 5555 to telnet port on
790 the guest, use the following:
792 @example
793 # on the host
794 qemu -redir tcp:5555::23 [...]
795 telnet localhost 5555
796 @end example
798 Then when you use on the host @code{telnet localhost 5555}, you
799 connect to the guest telnet server.
801 @end table
803 Bluetooth(R) options:
804 @table @option
806 @item -bt hci[...]
807 Defines the function of the corresponding Bluetooth HCI.  -bt options
808 are matched with the HCIs present in the chosen machine type.  For
809 example when emulating a machine with only one HCI built into it, only
810 the first @code{-bt hci[...]} option is valid and defines the HCI's
811 logic.  The Transport Layer is decided by the machine type.  Currently
812 the machines @code{n800} and @code{n810} have one HCI and all other
813 machines have none.
815 @anchor{bt-hcis}
816 The following three types are recognized:
818 @table @code
819 @item -bt hci,null
820 (default) The corresponding Bluetooth HCI assumes no internal logic
821 and will not respond to any HCI commands or emit events.
823 @item -bt hci,host[:@var{id}]
824 (@code{bluez} only) The corresponding HCI passes commands / events
825 to / from the physical HCI identified by the name @var{id} (default:
826 @code{hci0}) on the computer running QEMU.  Only available on @code{bluez}
827 capable systems like Linux.
829 @item -bt hci[,vlan=@var{n}]
830 Add a virtual, standard HCI that will participate in the Bluetooth
831 scatternet @var{n} (default @code{0}).  Similarly to @option{-net}
832 VLANs, devices inside a bluetooth network @var{n} can only communicate
833 with other devices in the same network (scatternet).
834 @end table
836 @item -bt vhci[,vlan=@var{n}]
837 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
838 to the host bluetooth stack instead of to the emulated target.  This
839 allows the host and target machines to participate in a common scatternet
840 and communicate.  Requires the Linux @code{vhci} driver installed.  Can
841 be used as following:
843 @example
844 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
845 @end example
847 @item -bt device:@var{dev}[,vlan=@var{n}]
848 Emulate a bluetooth device @var{dev} and place it in network @var{n}
849 (default @code{0}).  QEMU can only emulate one type of bluetooth devices
850 currently:
852 @table @code
853 @item keyboard
854 Virtual wireless keyboard implementing the HIDP bluetooth profile.
855 @end table
857 @end table
859 Linux boot specific: When using these options, you can use a given
860 Linux kernel without installing it in the disk image. It can be useful
861 for easier testing of various kernels.
863 @table @option
865 @item -kernel @var{bzImage}
866 Use @var{bzImage} as kernel image.
868 @item -append @var{cmdline}
869 Use @var{cmdline} as kernel command line
871 @item -initrd @var{file}
872 Use @var{file} as initial ram disk.
874 @end table
876 Debug/Expert options:
877 @table @option
879 @item -serial @var{dev}
880 Redirect the virtual serial port to host character device
881 @var{dev}. The default device is @code{vc} in graphical mode and
882 @code{stdio} in non graphical mode.
884 This option can be used several times to simulate up to 4 serials
885 ports.
887 Use @code{-serial none} to disable all serial ports.
889 Available character devices are:
890 @table @code
891 @item vc[:WxH]
892 Virtual console. Optionally, a width and height can be given in pixel with
893 @example
894 vc:800x600
895 @end example
896 It is also possible to specify width or height in characters:
897 @example
898 vc:80Cx24C
899 @end example
900 @item pty
901 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
902 @item none
903 No device is allocated.
904 @item null
905 void device
906 @item /dev/XXX
907 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
908 parameters are set according to the emulated ones.
909 @item /dev/parport@var{N}
910 [Linux only, parallel port only] Use host parallel port
911 @var{N}. Currently SPP and EPP parallel port features can be used.
912 @item file:@var{filename}
913 Write output to @var{filename}. No character can be read.
914 @item stdio
915 [Unix only] standard input/output
916 @item pipe:@var{filename}
917 name pipe @var{filename}
918 @item COM@var{n}
919 [Windows only] Use host serial port @var{n}
920 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
921 This implements UDP Net Console.
922 When @var{remote_host} or @var{src_ip} are not specified
923 they default to @code{0.0.0.0}.
924 When not using a specified @var{src_port} a random port is automatically chosen.
926 If you just want a simple readonly console you can use @code{netcat} or
927 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
928 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
929 will appear in the netconsole session.
931 If you plan to send characters back via netconsole or you want to stop
932 and start qemu a lot of times, you should have qemu use the same
933 source port each time by using something like @code{-serial
934 udp::4555@@:4556} to qemu. Another approach is to use a patched
935 version of netcat which can listen to a TCP port and send and receive
936 characters via udp.  If you have a patched version of netcat which
937 activates telnet remote echo and single char transfer, then you can
938 use the following options to step up a netcat redirector to allow
939 telnet on port 5555 to access the qemu port.
940 @table @code
941 @item Qemu Options:
942 -serial udp::4555@@:4556
943 @item netcat options:
944 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
945 @item telnet options:
946 localhost 5555
947 @end table
950 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
951 The TCP Net Console has two modes of operation.  It can send the serial
952 I/O to a location or wait for a connection from a location.  By default
953 the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
954 the @var{server} option QEMU will wait for a client socket application
955 to connect to the port before continuing, unless the @code{nowait}
956 option was specified.  The @code{nodelay} option disables the Nagle buffering
957 algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
958 one TCP connection at a time is accepted. You can use @code{telnet} to
959 connect to the corresponding character device.
960 @table @code
961 @item Example to send tcp console to 192.168.0.2 port 4444
962 -serial tcp:192.168.0.2:4444
963 @item Example to listen and wait on port 4444 for connection
964 -serial tcp::4444,server
965 @item Example to not wait and listen on ip 192.168.0.100 port 4444
966 -serial tcp:192.168.0.100:4444,server,nowait
967 @end table
969 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
970 The telnet protocol is used instead of raw tcp sockets.  The options
971 work the same as if you had specified @code{-serial tcp}.  The
972 difference is that the port acts like a telnet server or client using
973 telnet option negotiation.  This will also allow you to send the
974 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
975 sequence.  Typically in unix telnet you do it with Control-] and then
976 type "send break" followed by pressing the enter key.
978 @item unix:@var{path}[,server][,nowait]
979 A unix domain socket is used instead of a tcp socket.  The option works the
980 same as if you had specified @code{-serial tcp} except the unix domain socket
981 @var{path} is used for connections.
983 @item mon:@var{dev_string}
984 This is a special option to allow the monitor to be multiplexed onto
985 another serial port.  The monitor is accessed with key sequence of
986 @key{Control-a} and then pressing @key{c}. See monitor access
987 @ref{pcsys_keys} in the -nographic section for more keys.
988 @var{dev_string} should be any one of the serial devices specified
989 above.  An example to multiplex the monitor onto a telnet server
990 listening on port 4444 would be:
991 @table @code
992 @item -serial mon:telnet::4444,server,nowait
993 @end table
995 @item braille
996 Braille device.  This will use BrlAPI to display the braille output on a real
997 or fake device.
999 @end table
1001 @item -parallel @var{dev}
1002 Redirect the virtual parallel port to host device @var{dev} (same
1003 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1004 be used to use hardware devices connected on the corresponding host
1005 parallel port.
1007 This option can be used several times to simulate up to 3 parallel
1008 ports.
1010 Use @code{-parallel none} to disable all parallel ports.
1012 @item -monitor @var{dev}
1013 Redirect the monitor to host device @var{dev} (same devices as the
1014 serial port).
1015 The default device is @code{vc} in graphical mode and @code{stdio} in
1016 non graphical mode.
1018 @item -echr numeric_ascii_value
1019 Change the escape character used for switching to the monitor when using
1020 monitor and serial sharing.  The default is @code{0x01} when using the
1021 @code{-nographic} option.  @code{0x01} is equal to pressing
1022 @code{Control-a}.  You can select a different character from the ascii
1023 control keys where 1 through 26 map to Control-a through Control-z.  For
1024 instance you could use the either of the following to change the escape
1025 character to Control-t.
1026 @table @code
1027 @item -echr 0x14
1028 @item -echr 20
1029 @end table
1031 @item -s
1032 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
1033 @item -p @var{port}
1034 Change gdb connection port.  @var{port} can be either a decimal number
1035 to specify a TCP port, or a host device (same devices as the serial port).
1036 @item -S
1037 Do not start CPU at startup (you must type 'c' in the monitor).
1038 @item -d
1039 Output log in /tmp/qemu.log
1040 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1041 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1042 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1043 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1044 all those parameters. This option is useful for old MS-DOS disk
1045 images.
1047 @item -L path
1048 Set the directory for the BIOS, VGA BIOS and keymaps.
1050 @item -vga @var{type}
1051 Select type of VGA card to emulate. Valid values for @var{type} are
1052 @table @code
1053 @item cirrus
1054 Cirrus Logic GD5446 Video card. All Windows versions starting from
1055 Windows 95 should recognize and use this graphic card. For optimal
1056 performances, use 16 bit color depth in the guest and the host OS.
1057 (This one is the default)
1058 @item std
1059 Standard VGA card with Bochs VBE extensions.  If your guest OS
1060 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1061 to use high resolution modes (>= 1280x1024x16) then you should use
1062 this option.
1063 @item vmware
1064 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1065 recent XFree86/XOrg server or Windows guest with a driver for this
1066 card.
1067 @end table
1069 @item -no-acpi
1070 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1071 it if your guest OS complains about ACPI problems (PC target machine
1072 only).
1074 @item -no-reboot
1075 Exit instead of rebooting.
1077 @item -no-shutdown
1078 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1079 This allows for instance switching to monitor to commit changes to the
1080 disk image.
1082 @item -loadvm file
1083 Start right away with a saved state (@code{loadvm} in monitor)
1085 @item -semihosting
1086 Enable semihosting syscall emulation (ARM and M68K target machines only).
1088 On ARM this implements the "Angel" interface.
1089 On M68K this implements the "ColdFire GDB" interface used by libgloss.
1091 Note that this allows guest direct access to the host filesystem,
1092 so should only be used with trusted guest OS.
1094 @item -icount [N|auto]
1095 Enable virtual instruction counter.  The virtual cpu will execute one
1096 instruction every 2^N ns of virtual time.  If @code{auto} is specified
1097 then the virtual cpu speed will be automatically adjusted to keep virtual
1098 time within a few seconds of real time.
1100 Note that while this option can give deterministic behavior, it does not
1101 provide cycle accurate emulation.  Modern CPUs contain superscalar out of
1102 order cores with complex cache hierarchies.  The number of instructions
1103 executed often has little or no correlation with actual performance.
1104 @end table
1106 @c man end
1108 @node pcsys_keys
1109 @section Keys
1111 @c man begin OPTIONS
1113 During the graphical emulation, you can use the following keys:
1114 @table @key
1115 @item Ctrl-Alt-f
1116 Toggle full screen
1118 @item Ctrl-Alt-n
1119 Switch to virtual console 'n'. Standard console mappings are:
1120 @table @emph
1121 @item 1
1122 Target system display
1123 @item 2
1124 Monitor
1125 @item 3
1126 Serial port
1127 @end table
1129 @item Ctrl-Alt
1130 Toggle mouse and keyboard grab.
1131 @end table
1133 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
1134 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
1136 During emulation, if you are using the @option{-nographic} option, use
1137 @key{Ctrl-a h} to get terminal commands:
1139 @table @key
1140 @item Ctrl-a h
1141 Print this help
1142 @item Ctrl-a x
1143 Exit emulator
1144 @item Ctrl-a s
1145 Save disk data back to file (if -snapshot)
1146 @item Ctrl-a t
1147 toggle console timestamps
1148 @item Ctrl-a b
1149 Send break (magic sysrq in Linux)
1150 @item Ctrl-a c
1151 Switch between console and monitor
1152 @item Ctrl-a Ctrl-a
1153 Send Ctrl-a
1154 @end table
1155 @c man end
1157 @ignore
1159 @c man begin SEEALSO
1160 The HTML documentation of QEMU for more precise information and Linux
1161 user mode emulator invocation.
1162 @c man end
1164 @c man begin AUTHOR
1165 Fabrice Bellard
1166 @c man end
1168 @end ignore
1170 @node pcsys_monitor
1171 @section QEMU Monitor
1173 The QEMU monitor is used to give complex commands to the QEMU
1174 emulator. You can use it to:
1176 @itemize @minus
1178 @item
1179 Remove or insert removable media images
1180 (such as CD-ROM or floppies).
1182 @item
1183 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
1184 from a disk file.
1186 @item Inspect the VM state without an external debugger.
1188 @end itemize
1190 @subsection Commands
1192 The following commands are available:
1194 @table @option
1196 @item help or ? [@var{cmd}]
1197 Show the help for all commands or just for command @var{cmd}.
1199 @item commit
1200 Commit changes to the disk images (if -snapshot is used).
1202 @item info @var{subcommand}
1203 Show various information about the system state.
1205 @table @option
1206 @item info network
1207 show the various VLANs and the associated devices
1208 @item info block
1209 show the block devices
1210 @item info registers
1211 show the cpu registers
1212 @item info history
1213 show the command line history
1214 @item info pci
1215 show emulated PCI device
1216 @item info usb
1217 show USB devices plugged on the virtual USB hub
1218 @item info usbhost
1219 show all USB host devices
1220 @item info capture
1221 show information about active capturing
1222 @item info snapshots
1223 show list of VM snapshots
1224 @item info mice
1225 show which guest mouse is receiving events
1226 @end table
1228 @item q or quit
1229 Quit the emulator.
1231 @item eject [-f] @var{device}
1232 Eject a removable medium (use -f to force it).
1234 @item change @var{device} @var{setting}
1236 Change the configuration of a device.
1238 @table @option
1239 @item change @var{diskdevice} @var{filename}
1240 Change the medium for a removable disk device to point to @var{filename}. eg
1242 @example
1243 (qemu) change ide1-cd0 /path/to/some.iso
1244 @end example
1246 @item change vnc @var{display},@var{options}
1247 Change the configuration of the VNC server. The valid syntax for @var{display}
1248 and @var{options} are described at @ref{sec_invocation}. eg
1250 @example
1251 (qemu) change vnc localhost:1
1252 @end example
1254 @item change vnc password [@var{password}]
1256 Change the password associated with the VNC server. If the new password is not
1257 supplied, the monitor will prompt for it to be entered. VNC passwords are only
1258 significant up to 8 letters. eg
1260 @example
1261 (qemu) change vnc password
1262 Password: ********
1263 @end example
1265 @end table
1267 @item screendump @var{filename}
1268 Save screen into PPM image @var{filename}.
1270 @item mouse_move @var{dx} @var{dy} [@var{dz}]
1271 Move the active mouse to the specified coordinates @var{dx} @var{dy}
1272 with optional scroll axis @var{dz}.
1274 @item mouse_button @var{val}
1275 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
1277 @item mouse_set @var{index}
1278 Set which mouse device receives events at given @var{index}, index
1279 can be obtained with
1280 @example
1281 info mice
1282 @end example
1284 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
1285 Capture audio into @var{filename}. Using sample rate @var{frequency}
1286 bits per sample @var{bits} and number of channels @var{channels}.
1288 Defaults:
1289 @itemize @minus
1290 @item Sample rate = 44100 Hz - CD quality
1291 @item Bits = 16
1292 @item Number of channels = 2 - Stereo
1293 @end itemize
1295 @item stopcapture @var{index}
1296 Stop capture with a given @var{index}, index can be obtained with
1297 @example
1298 info capture
1299 @end example
1301 @item log @var{item1}[,...]
1302 Activate logging of the specified items to @file{/tmp/qemu.log}.
1304 @item savevm [@var{tag}|@var{id}]
1305 Create a snapshot of the whole virtual machine. If @var{tag} is
1306 provided, it is used as human readable identifier. If there is already
1307 a snapshot with the same tag or ID, it is replaced. More info at
1308 @ref{vm_snapshots}.
1310 @item loadvm @var{tag}|@var{id}
1311 Set the whole virtual machine to the snapshot identified by the tag
1312 @var{tag} or the unique snapshot ID @var{id}.
1314 @item delvm @var{tag}|@var{id}
1315 Delete the snapshot identified by @var{tag} or @var{id}.
1317 @item stop
1318 Stop emulation.
1320 @item c or cont
1321 Resume emulation.
1323 @item gdbserver [@var{port}]
1324 Start gdbserver session (default @var{port}=1234)
1326 @item x/fmt @var{addr}
1327 Virtual memory dump starting at @var{addr}.
1329 @item xp /@var{fmt} @var{addr}
1330 Physical memory dump starting at @var{addr}.
1332 @var{fmt} is a format which tells the command how to format the
1333 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1335 @table @var
1336 @item count
1337 is the number of items to be dumped.
1339 @item format
1340 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
1341 c (char) or i (asm instruction).
1343 @item size
1344 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1345 @code{h} or @code{w} can be specified with the @code{i} format to
1346 respectively select 16 or 32 bit code instruction size.
1348 @end table
1350 Examples:
1351 @itemize
1352 @item
1353 Dump 10 instructions at the current instruction pointer:
1354 @example
1355 (qemu) x/10i $eip
1356 0x90107063:  ret
1357 0x90107064:  sti
1358 0x90107065:  lea    0x0(%esi,1),%esi
1359 0x90107069:  lea    0x0(%edi,1),%edi
1360 0x90107070:  ret
1361 0x90107071:  jmp    0x90107080
1362 0x90107073:  nop
1363 0x90107074:  nop
1364 0x90107075:  nop
1365 0x90107076:  nop
1366 @end example
1368 @item
1369 Dump 80 16 bit values at the start of the video memory.
1370 @smallexample
1371 (qemu) xp/80hx 0xb8000
1372 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
1373 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
1374 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
1375 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
1376 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
1377 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
1378 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1379 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1380 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1381 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1382 @end smallexample
1383 @end itemize
1385 @item p or print/@var{fmt} @var{expr}
1387 Print expression value. Only the @var{format} part of @var{fmt} is
1388 used.
1390 @item sendkey @var{keys}
1392 Send @var{keys} to the emulator. @var{keys} could be the name of the
1393 key or @code{#} followed by the raw value in either decimal or hexadecimal
1394 format. Use @code{-} to press several keys simultaneously. Example:
1395 @example
1396 sendkey ctrl-alt-f1
1397 @end example
1399 This command is useful to send keys that your graphical user interface
1400 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1402 @item system_reset
1404 Reset the system.
1406 @item boot_set @var{bootdevicelist}
1408 Define new values for the boot device list. Those values will override
1409 the values specified on the command line through the @code{-boot} option.
1411 The values that can be specified here depend on the machine type, but are
1412 the same that can be specified in the @code{-boot} command line option.
1414 @item usb_add @var{devname}
1416 Add the USB device @var{devname}.  For details of available devices see
1417 @ref{usb_devices}
1419 @item usb_del @var{devname}
1421 Remove the USB device @var{devname} from the QEMU virtual USB
1422 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1423 command @code{info usb} to see the devices you can remove.
1425 @end table
1427 @subsection Integer expressions
1429 The monitor understands integers expressions for every integer
1430 argument. You can use register names to get the value of specifics
1431 CPU registers by prefixing them with @emph{$}.
1433 @node disk_images
1434 @section Disk Images
1436 Since version 0.6.1, QEMU supports many disk image formats, including
1437 growable disk images (their size increase as non empty sectors are
1438 written), compressed and encrypted disk images. Version 0.8.3 added
1439 the new qcow2 disk image format which is essential to support VM
1440 snapshots.
1442 @menu
1443 * disk_images_quickstart::    Quick start for disk image creation
1444 * disk_images_snapshot_mode:: Snapshot mode
1445 * vm_snapshots::              VM snapshots
1446 * qemu_img_invocation::       qemu-img Invocation
1447 * qemu_nbd_invocation::       qemu-nbd Invocation
1448 * host_drives::               Using host drives
1449 * disk_images_fat_images::    Virtual FAT disk images
1450 * disk_images_nbd::           NBD access
1451 @end menu
1453 @node disk_images_quickstart
1454 @subsection Quick start for disk image creation
1456 You can create a disk image with the command:
1457 @example
1458 qemu-img create myimage.img mysize
1459 @end example
1460 where @var{myimage.img} is the disk image filename and @var{mysize} is its
1461 size in kilobytes. You can add an @code{M} suffix to give the size in
1462 megabytes and a @code{G} suffix for gigabytes.
1464 See @ref{qemu_img_invocation} for more information.
1466 @node disk_images_snapshot_mode
1467 @subsection Snapshot mode
1469 If you use the option @option{-snapshot}, all disk images are
1470 considered as read only. When sectors in written, they are written in
1471 a temporary file created in @file{/tmp}. You can however force the
1472 write back to the raw disk images by using the @code{commit} monitor
1473 command (or @key{C-a s} in the serial console).
1475 @node vm_snapshots
1476 @subsection VM snapshots
1478 VM snapshots are snapshots of the complete virtual machine including
1479 CPU state, RAM, device state and the content of all the writable
1480 disks. In order to use VM snapshots, you must have at least one non
1481 removable and writable block device using the @code{qcow2} disk image
1482 format. Normally this device is the first virtual hard drive.
1484 Use the monitor command @code{savevm} to create a new VM snapshot or
1485 replace an existing one. A human readable name can be assigned to each
1486 snapshot in addition to its numerical ID.
1488 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1489 a VM snapshot. @code{info snapshots} lists the available snapshots
1490 with their associated information:
1492 @example
1493 (qemu) info snapshots
1494 Snapshot devices: hda
1495 Snapshot list (from hda):
1496 ID        TAG                 VM SIZE                DATE       VM CLOCK
1497 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
1498 2                                 40M 2006-08-06 12:43:29   00:00:18.633
1499 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
1500 @end example
1502 A VM snapshot is made of a VM state info (its size is shown in
1503 @code{info snapshots}) and a snapshot of every writable disk image.
1504 The VM state info is stored in the first @code{qcow2} non removable
1505 and writable block device. The disk image snapshots are stored in
1506 every disk image. The size of a snapshot in a disk image is difficult
1507 to evaluate and is not shown by @code{info snapshots} because the
1508 associated disk sectors are shared among all the snapshots to save
1509 disk space (otherwise each snapshot would need a full copy of all the
1510 disk images).
1512 When using the (unrelated) @code{-snapshot} option
1513 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1514 but they are deleted as soon as you exit QEMU.
1516 VM snapshots currently have the following known limitations:
1517 @itemize
1518 @item
1519 They cannot cope with removable devices if they are removed or
1520 inserted after a snapshot is done.
1521 @item
1522 A few device drivers still have incomplete snapshot support so their
1523 state is not saved or restored properly (in particular USB).
1524 @end itemize
1526 @node qemu_img_invocation
1527 @subsection @code{qemu-img} Invocation
1529 @include qemu-img.texi
1531 @node qemu_nbd_invocation
1532 @subsection @code{qemu-nbd} Invocation
1534 @include qemu-nbd.texi
1536 @node host_drives
1537 @subsection Using host drives
1539 In addition to disk image files, QEMU can directly access host
1540 devices. We describe here the usage for QEMU version >= 0.8.3.
1542 @subsubsection Linux
1544 On Linux, you can directly use the host device filename instead of a
1545 disk image filename provided you have enough privileges to access
1546 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1547 @file{/dev/fd0} for the floppy.
1549 @table @code
1550 @item CD
1551 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1552 specific code to detect CDROM insertion or removal. CDROM ejection by
1553 the guest OS is supported. Currently only data CDs are supported.
1554 @item Floppy
1555 You can specify a floppy device even if no floppy is loaded. Floppy
1556 removal is currently not detected accurately (if you change floppy
1557 without doing floppy access while the floppy is not loaded, the guest
1558 OS will think that the same floppy is loaded).
1559 @item Hard disks
1560 Hard disks can be used. Normally you must specify the whole disk
1561 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1562 see it as a partitioned disk. WARNING: unless you know what you do, it
1563 is better to only make READ-ONLY accesses to the hard disk otherwise
1564 you may corrupt your host data (use the @option{-snapshot} command
1565 line option or modify the device permissions accordingly).
1566 @end table
1568 @subsubsection Windows
1570 @table @code
1571 @item CD
1572 The preferred syntax is the drive letter (e.g. @file{d:}). The
1573 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1574 supported as an alias to the first CDROM drive.
1576 Currently there is no specific code to handle removable media, so it
1577 is better to use the @code{change} or @code{eject} monitor commands to
1578 change or eject media.
1579 @item Hard disks
1580 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1581 where @var{N} is the drive number (0 is the first hard disk).
1583 WARNING: unless you know what you do, it is better to only make
1584 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1585 host data (use the @option{-snapshot} command line so that the
1586 modifications are written in a temporary file).
1587 @end table
1590 @subsubsection Mac OS X
1592 @file{/dev/cdrom} is an alias to the first CDROM.
1594 Currently there is no specific code to handle removable media, so it
1595 is better to use the @code{change} or @code{eject} monitor commands to
1596 change or eject media.
1598 @node disk_images_fat_images
1599 @subsection Virtual FAT disk images
1601 QEMU can automatically create a virtual FAT disk image from a
1602 directory tree. In order to use it, just type:
1604 @example
1605 qemu linux.img -hdb fat:/my_directory
1606 @end example
1608 Then you access access to all the files in the @file{/my_directory}
1609 directory without having to copy them in a disk image or to export
1610 them via SAMBA or NFS. The default access is @emph{read-only}.
1612 Floppies can be emulated with the @code{:floppy:} option:
1614 @example
1615 qemu linux.img -fda fat:floppy:/my_directory
1616 @end example
1618 A read/write support is available for testing (beta stage) with the
1619 @code{:rw:} option:
1621 @example
1622 qemu linux.img -fda fat:floppy:rw:/my_directory
1623 @end example
1625 What you should @emph{never} do:
1626 @itemize
1627 @item use non-ASCII filenames ;
1628 @item use "-snapshot" together with ":rw:" ;
1629 @item expect it to work when loadvm'ing ;
1630 @item write to the FAT directory on the host system while accessing it with the guest system.
1631 @end itemize
1633 @node disk_images_nbd
1634 @subsection NBD access
1636 QEMU can access directly to block device exported using the Network Block Device
1637 protocol.
1639 @example
1640 qemu linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
1641 @end example
1643 If the NBD server is located on the same host, you can use an unix socket instead
1644 of an inet socket:
1646 @example
1647 qemu linux.img -hdb nbd:unix:/tmp/my_socket
1648 @end example
1650 In this case, the block device must be exported using qemu-nbd:
1652 @example
1653 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
1654 @end example
1656 The use of qemu-nbd allows to share a disk between several guests:
1657 @example
1658 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
1659 @end example
1661 and then you can use it with two guests:
1662 @example
1663 qemu linux1.img -hdb nbd:unix:/tmp/my_socket
1664 qemu linux2.img -hdb nbd:unix:/tmp/my_socket
1665 @end example
1667 @node pcsys_network
1668 @section Network emulation
1670 QEMU can simulate several network cards (PCI or ISA cards on the PC
1671 target) and can connect them to an arbitrary number of Virtual Local
1672 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1673 VLAN. VLAN can be connected between separate instances of QEMU to
1674 simulate large networks. For simpler usage, a non privileged user mode
1675 network stack can replace the TAP device to have a basic network
1676 connection.
1678 @subsection VLANs
1680 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1681 connection between several network devices. These devices can be for
1682 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1683 (TAP devices).
1685 @subsection Using TAP network interfaces
1687 This is the standard way to connect QEMU to a real network. QEMU adds
1688 a virtual network device on your host (called @code{tapN}), and you
1689 can then configure it as if it was a real ethernet card.
1691 @subsubsection Linux host
1693 As an example, you can download the @file{linux-test-xxx.tar.gz}
1694 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1695 configure properly @code{sudo} so that the command @code{ifconfig}
1696 contained in @file{qemu-ifup} can be executed as root. You must verify
1697 that your host kernel supports the TAP network interfaces: the
1698 device @file{/dev/net/tun} must be present.
1700 See @ref{sec_invocation} to have examples of command lines using the
1701 TAP network interfaces.
1703 @subsubsection Windows host
1705 There is a virtual ethernet driver for Windows 2000/XP systems, called
1706 TAP-Win32. But it is not included in standard QEMU for Windows,
1707 so you will need to get it separately. It is part of OpenVPN package,
1708 so download OpenVPN from : @url{http://openvpn.net/}.
1710 @subsection Using the user mode network stack
1712 By using the option @option{-net user} (default configuration if no
1713 @option{-net} option is specified), QEMU uses a completely user mode
1714 network stack (you don't need root privilege to use the virtual
1715 network). The virtual network configuration is the following:
1717 @example
1719          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1720                            |          (10.0.2.2)
1721                            |
1722                            ---->  DNS server (10.0.2.3)
1723                            |
1724                            ---->  SMB server (10.0.2.4)
1725 @end example
1727 The QEMU VM behaves as if it was behind a firewall which blocks all
1728 incoming connections. You can use a DHCP client to automatically
1729 configure the network in the QEMU VM. The DHCP server assign addresses
1730 to the hosts starting from 10.0.2.15.
1732 In order to check that the user mode network is working, you can ping
1733 the address 10.0.2.2 and verify that you got an address in the range
1734 10.0.2.x from the QEMU virtual DHCP server.
1736 Note that @code{ping} is not supported reliably to the internet as it
1737 would require root privileges. It means you can only ping the local
1738 router (10.0.2.2).
1740 When using the built-in TFTP server, the router is also the TFTP
1741 server.
1743 When using the @option{-redir} option, TCP or UDP connections can be
1744 redirected from the host to the guest. It allows for example to
1745 redirect X11, telnet or SSH connections.
1747 @subsection Connecting VLANs between QEMU instances
1749 Using the @option{-net socket} option, it is possible to make VLANs
1750 that span several QEMU instances. See @ref{sec_invocation} to have a
1751 basic example.
1753 @node direct_linux_boot
1754 @section Direct Linux Boot
1756 This section explains how to launch a Linux kernel inside QEMU without
1757 having to make a full bootable image. It is very useful for fast Linux
1758 kernel testing.
1760 The syntax is:
1761 @example
1762 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1763 @end example
1765 Use @option{-kernel} to provide the Linux kernel image and
1766 @option{-append} to give the kernel command line arguments. The
1767 @option{-initrd} option can be used to provide an INITRD image.
1769 When using the direct Linux boot, a disk image for the first hard disk
1770 @file{hda} is required because its boot sector is used to launch the
1771 Linux kernel.
1773 If you do not need graphical output, you can disable it and redirect
1774 the virtual serial port and the QEMU monitor to the console with the
1775 @option{-nographic} option. The typical command line is:
1776 @example
1777 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1778      -append "root=/dev/hda console=ttyS0" -nographic
1779 @end example
1781 Use @key{Ctrl-a c} to switch between the serial console and the
1782 monitor (@pxref{pcsys_keys}).
1784 @node pcsys_usb
1785 @section USB emulation
1787 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1788 virtual USB devices or real host USB devices (experimental, works only
1789 on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
1790 as necessary to connect multiple USB devices.
1792 @menu
1793 * usb_devices::
1794 * host_usb_devices::
1795 @end menu
1796 @node usb_devices
1797 @subsection Connecting USB devices
1799 USB devices can be connected with the @option{-usbdevice} commandline option
1800 or the @code{usb_add} monitor command.  Available devices are:
1802 @table @code
1803 @item mouse
1804 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1805 @item tablet
1806 Pointer device that uses absolute coordinates (like a touchscreen).
1807 This means qemu is able to report the mouse position without having
1808 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1809 @item disk:@var{file}
1810 Mass storage device based on @var{file} (@pxref{disk_images})
1811 @item host:@var{bus.addr}
1812 Pass through the host device identified by @var{bus.addr}
1813 (Linux only)
1814 @item host:@var{vendor_id:product_id}
1815 Pass through the host device identified by @var{vendor_id:product_id}
1816 (Linux only)
1817 @item wacom-tablet
1818 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
1819 above but it can be used with the tslib library because in addition to touch
1820 coordinates it reports touch pressure.
1821 @item keyboard
1822 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1823 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1824 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1825 device @var{dev}. The available character devices are the same as for the
1826 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1827 used to override the default 0403:6001. For instance, 
1828 @example
1829 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1830 @end example
1831 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1832 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1833 @item braille
1834 Braille device.  This will use BrlAPI to display the braille output on a real
1835 or fake device.
1836 @item net:@var{options}
1837 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
1838 specifies NIC options as with @code{-net nic,}@var{options} (see description).
1839 For instance, user-mode networking can be used with
1840 @example
1841 qemu [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
1842 @end example
1843 Currently this cannot be used in machines that support PCI NICs.
1844 @item bt[:@var{hci-type}]
1845 Bluetooth dongle whose type is specified in the same format as with
1846 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
1847 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
1848 This USB device implements the USB Transport Layer of HCI.  Example
1849 usage:
1850 @example
1851 qemu [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
1852 @end example
1853 @end table
1855 @node host_usb_devices
1856 @subsection Using host USB devices on a Linux host
1858 WARNING: this is an experimental feature. QEMU will slow down when
1859 using it. USB devices requiring real time streaming (i.e. USB Video
1860 Cameras) are not supported yet.
1862 @enumerate
1863 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1864 is actually using the USB device. A simple way to do that is simply to
1865 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1866 to @file{mydriver.o.disabled}.
1868 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1869 @example
1870 ls /proc/bus/usb
1871 001  devices  drivers
1872 @end example
1874 @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:
1875 @example
1876 chown -R myuid /proc/bus/usb
1877 @end example
1879 @item Launch QEMU and do in the monitor:
1880 @example
1881 info usbhost
1882   Device 1.2, speed 480 Mb/s
1883     Class 00: USB device 1234:5678, USB DISK
1884 @end example
1885 You should see the list of the devices you can use (Never try to use
1886 hubs, it won't work).
1888 @item Add the device in QEMU by using:
1889 @example
1890 usb_add host:1234:5678
1891 @end example
1893 Normally the guest OS should report that a new USB device is
1894 plugged. You can use the option @option{-usbdevice} to do the same.
1896 @item Now you can try to use the host USB device in QEMU.
1898 @end enumerate
1900 When relaunching QEMU, you may have to unplug and plug again the USB
1901 device to make it work again (this is a bug).
1903 @node vnc_security
1904 @section VNC security
1906 The VNC server capability provides access to the graphical console
1907 of the guest VM across the network. This has a number of security
1908 considerations depending on the deployment scenarios.
1910 @menu
1911 * vnc_sec_none::
1912 * vnc_sec_password::
1913 * vnc_sec_certificate::
1914 * vnc_sec_certificate_verify::
1915 * vnc_sec_certificate_pw::
1916 * vnc_generate_cert::
1917 @end menu
1918 @node vnc_sec_none
1919 @subsection Without passwords
1921 The simplest VNC server setup does not include any form of authentication.
1922 For this setup it is recommended to restrict it to listen on a UNIX domain
1923 socket only. For example
1925 @example
1926 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1927 @end example
1929 This ensures that only users on local box with read/write access to that
1930 path can access the VNC server. To securely access the VNC server from a
1931 remote machine, a combination of netcat+ssh can be used to provide a secure
1932 tunnel.
1934 @node vnc_sec_password
1935 @subsection With passwords
1937 The VNC protocol has limited support for password based authentication. Since
1938 the protocol limits passwords to 8 characters it should not be considered
1939 to provide high security. The password can be fairly easily brute-forced by
1940 a client making repeat connections. For this reason, a VNC server using password
1941 authentication should be restricted to only listen on the loopback interface
1942 or UNIX domain sockets. Password authentication is requested with the @code{password}
1943 option, and then once QEMU is running the password is set with the monitor. Until
1944 the monitor is used to set the password all clients will be rejected.
1946 @example
1947 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1948 (qemu) change vnc password
1949 Password: ********
1950 (qemu)
1951 @end example
1953 @node vnc_sec_certificate
1954 @subsection With x509 certificates
1956 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1957 TLS for encryption of the session, and x509 certificates for authentication.
1958 The use of x509 certificates is strongly recommended, because TLS on its
1959 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1960 support provides a secure session, but no authentication. This allows any
1961 client to connect, and provides an encrypted session.
1963 @example
1964 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1965 @end example
1967 In the above example @code{/etc/pki/qemu} should contain at least three files,
1968 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1969 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1970 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1971 only be readable by the user owning it.
1973 @node vnc_sec_certificate_verify
1974 @subsection With x509 certificates and client verification
1976 Certificates can also provide a means to authenticate the client connecting.
1977 The server will request that the client provide a certificate, which it will
1978 then validate against the CA certificate. This is a good choice if deploying
1979 in an environment with a private internal certificate authority.
1981 @example
1982 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1983 @end example
1986 @node vnc_sec_certificate_pw
1987 @subsection With x509 certificates, client verification and passwords
1989 Finally, the previous method can be combined with VNC password authentication
1990 to provide two layers of authentication for clients.
1992 @example
1993 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1994 (qemu) change vnc password
1995 Password: ********
1996 (qemu)
1997 @end example
1999 @node vnc_generate_cert
2000 @subsection Generating certificates for VNC
2002 The GNU TLS packages provides a command called @code{certtool} which can
2003 be used to generate certificates and keys in PEM format. At a minimum it
2004 is neccessary to setup a certificate authority, and issue certificates to
2005 each server. If using certificates for authentication, then each client
2006 will also need to be issued a certificate. The recommendation is for the
2007 server to keep its certificates in either @code{/etc/pki/qemu} or for
2008 unprivileged users in @code{$HOME/.pki/qemu}.
2010 @menu
2011 * vnc_generate_ca::
2012 * vnc_generate_server::
2013 * vnc_generate_client::
2014 @end menu
2015 @node vnc_generate_ca
2016 @subsubsection Setup the Certificate Authority
2018 This step only needs to be performed once per organization / organizational
2019 unit. First the CA needs a private key. This key must be kept VERY secret
2020 and secure. If this key is compromised the entire trust chain of the certificates
2021 issued with it is lost.
2023 @example
2024 # certtool --generate-privkey > ca-key.pem
2025 @end example
2027 A CA needs to have a public certificate. For simplicity it can be a self-signed
2028 certificate, or one issue by a commercial certificate issuing authority. To
2029 generate a self-signed certificate requires one core piece of information, the
2030 name of the organization.
2032 @example
2033 # cat > ca.info <<EOF
2034 cn = Name of your organization
2036 cert_signing_key
2038 # certtool --generate-self-signed \
2039            --load-privkey ca-key.pem
2040            --template ca.info \
2041            --outfile ca-cert.pem
2042 @end example
2044 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
2045 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
2047 @node vnc_generate_server
2048 @subsubsection Issuing server certificates
2050 Each server (or host) needs to be issued with a key and certificate. When connecting
2051 the certificate is sent to the client which validates it against the CA certificate.
2052 The core piece of information for a server certificate is the hostname. This should
2053 be the fully qualified hostname that the client will connect with, since the client
2054 will typically also verify the hostname in the certificate. On the host holding the
2055 secure CA private key:
2057 @example
2058 # cat > server.info <<EOF
2059 organization = Name  of your organization
2060 cn = server.foo.example.com
2061 tls_www_server
2062 encryption_key
2063 signing_key
2065 # certtool --generate-privkey > server-key.pem
2066 # certtool --generate-certificate \
2067            --load-ca-certificate ca-cert.pem \
2068            --load-ca-privkey ca-key.pem \
2069            --load-privkey server server-key.pem \
2070            --template server.info \
2071            --outfile server-cert.pem
2072 @end example
2074 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
2075 to the server for which they were generated. The @code{server-key.pem} is security
2076 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
2078 @node vnc_generate_client
2079 @subsubsection Issuing client certificates
2081 If the QEMU VNC server is to use the @code{x509verify} option to validate client
2082 certificates as its authentication mechanism, each client also needs to be issued
2083 a certificate. The client certificate contains enough metadata to uniquely identify
2084 the client, typically organization, state, city, building, etc. On the host holding
2085 the secure CA private key:
2087 @example
2088 # cat > client.info <<EOF
2089 country = GB
2090 state = London
2091 locality = London
2092 organiazation = Name of your organization
2093 cn = client.foo.example.com
2094 tls_www_client
2095 encryption_key
2096 signing_key
2098 # certtool --generate-privkey > client-key.pem
2099 # certtool --generate-certificate \
2100            --load-ca-certificate ca-cert.pem \
2101            --load-ca-privkey ca-key.pem \
2102            --load-privkey client-key.pem \
2103            --template client.info \
2104            --outfile client-cert.pem
2105 @end example
2107 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
2108 copied to the client for which they were generated.
2110 @node gdb_usage
2111 @section GDB usage
2113 QEMU has a primitive support to work with gdb, so that you can do
2114 'Ctrl-C' while the virtual machine is running and inspect its state.
2116 In order to use gdb, launch qemu with the '-s' option. It will wait for a
2117 gdb connection:
2118 @example
2119 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
2120        -append "root=/dev/hda"
2121 Connected to host network interface: tun0
2122 Waiting gdb connection on port 1234
2123 @end example
2125 Then launch gdb on the 'vmlinux' executable:
2126 @example
2127 > gdb vmlinux
2128 @end example
2130 In gdb, connect to QEMU:
2131 @example
2132 (gdb) target remote localhost:1234
2133 @end example
2135 Then you can use gdb normally. For example, type 'c' to launch the kernel:
2136 @example
2137 (gdb) c
2138 @end example
2140 Here are some useful tips in order to use gdb on system code:
2142 @enumerate
2143 @item
2144 Use @code{info reg} to display all the CPU registers.
2145 @item
2146 Use @code{x/10i $eip} to display the code at the PC position.
2147 @item
2148 Use @code{set architecture i8086} to dump 16 bit code. Then use
2149 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
2150 @end enumerate
2152 Advanced debugging options:
2154 The default single stepping behavior is step with the IRQs and timer service routines off.  It is set this way because when gdb executes a single step it expects to advance beyond the current instruction.  With the IRQs and and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed.  Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB.  There are three commands you can query and set the single step behavior:
2155 @table @code
2156 @item maintenance packet qqemu.sstepbits
2158 This will display the MASK bits used to control the single stepping IE:
2159 @example
2160 (gdb) maintenance packet qqemu.sstepbits
2161 sending: "qqemu.sstepbits"
2162 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
2163 @end example
2164 @item maintenance packet qqemu.sstep
2166 This will display the current value of the mask used when single stepping IE:
2167 @example
2168 (gdb) maintenance packet qqemu.sstep
2169 sending: "qqemu.sstep"
2170 received: "0x7"
2171 @end example
2172 @item maintenance packet Qqemu.sstep=HEX_VALUE
2174 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
2175 @example
2176 (gdb) maintenance packet Qqemu.sstep=0x5
2177 sending: "qemu.sstep=0x5"
2178 received: "OK"
2179 @end example
2180 @end table
2182 @node pcsys_os_specific
2183 @section Target OS specific information
2185 @subsection Linux
2187 To have access to SVGA graphic modes under X11, use the @code{vesa} or
2188 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
2189 color depth in the guest and the host OS.
2191 When using a 2.6 guest Linux kernel, you should add the option
2192 @code{clock=pit} on the kernel command line because the 2.6 Linux
2193 kernels make very strict real time clock checks by default that QEMU
2194 cannot simulate exactly.
2196 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
2197 not activated because QEMU is slower with this patch. The QEMU
2198 Accelerator Module is also much slower in this case. Earlier Fedora
2199 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
2200 patch by default. Newer kernels don't have it.
2202 @subsection Windows
2204 If you have a slow host, using Windows 95 is better as it gives the
2205 best speed. Windows 2000 is also a good choice.
2207 @subsubsection SVGA graphic modes support
2209 QEMU emulates a Cirrus Logic GD5446 Video
2210 card. All Windows versions starting from Windows 95 should recognize
2211 and use this graphic card. For optimal performances, use 16 bit color
2212 depth in the guest and the host OS.
2214 If you are using Windows XP as guest OS and if you want to use high
2215 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
2216 1280x1024x16), then you should use the VESA VBE virtual graphic card
2217 (option @option{-std-vga}).
2219 @subsubsection CPU usage reduction
2221 Windows 9x does not correctly use the CPU HLT
2222 instruction. The result is that it takes host CPU cycles even when
2223 idle. You can install the utility from
2224 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
2225 problem. Note that no such tool is needed for NT, 2000 or XP.
2227 @subsubsection Windows 2000 disk full problem
2229 Windows 2000 has a bug which gives a disk full problem during its
2230 installation. When installing it, use the @option{-win2k-hack} QEMU
2231 option to enable a specific workaround. After Windows 2000 is
2232 installed, you no longer need this option (this option slows down the
2233 IDE transfers).
2235 @subsubsection Windows 2000 shutdown
2237 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
2238 can. It comes from the fact that Windows 2000 does not automatically
2239 use the APM driver provided by the BIOS.
2241 In order to correct that, do the following (thanks to Struan
2242 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
2243 Add/Troubleshoot a device => Add a new device & Next => No, select the
2244 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
2245 (again) a few times. Now the driver is installed and Windows 2000 now
2246 correctly instructs QEMU to shutdown at the appropriate moment.
2248 @subsubsection Share a directory between Unix and Windows
2250 See @ref{sec_invocation} about the help of the option @option{-smb}.
2252 @subsubsection Windows XP security problem
2254 Some releases of Windows XP install correctly but give a security
2255 error when booting:
2256 @example
2257 A problem is preventing Windows from accurately checking the
2258 license for this computer. Error code: 0x800703e6.
2259 @end example
2261 The workaround is to install a service pack for XP after a boot in safe
2262 mode. Then reboot, and the problem should go away. Since there is no
2263 network while in safe mode, its recommended to download the full
2264 installation of SP1 or SP2 and transfer that via an ISO or using the
2265 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
2267 @subsection MS-DOS and FreeDOS
2269 @subsubsection CPU usage reduction
2271 DOS does not correctly use the CPU HLT instruction. The result is that
2272 it takes host CPU cycles even when idle. You can install the utility
2273 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
2274 problem.
2276 @node QEMU System emulator for non PC targets
2277 @chapter QEMU System emulator for non PC targets
2279 QEMU is a generic emulator and it emulates many non PC
2280 machines. Most of the options are similar to the PC emulator. The
2281 differences are mentioned in the following sections.
2283 @menu
2284 * QEMU PowerPC System emulator::
2285 * Sparc32 System emulator::
2286 * Sparc64 System emulator::
2287 * MIPS System emulator::
2288 * ARM System emulator::
2289 * ColdFire System emulator::
2290 @end menu
2292 @node QEMU PowerPC System emulator
2293 @section QEMU PowerPC System emulator
2295 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
2296 or PowerMac PowerPC system.
2298 QEMU emulates the following PowerMac peripherals:
2300 @itemize @minus
2301 @item
2302 UniNorth PCI Bridge
2303 @item
2304 PCI VGA compatible card with VESA Bochs Extensions
2305 @item
2306 2 PMAC IDE interfaces with hard disk and CD-ROM support
2307 @item
2308 NE2000 PCI adapters
2309 @item
2310 Non Volatile RAM
2311 @item
2312 VIA-CUDA with ADB keyboard and mouse.
2313 @end itemize
2315 QEMU emulates the following PREP peripherals:
2317 @itemize @minus
2318 @item
2319 PCI Bridge
2320 @item
2321 PCI VGA compatible card with VESA Bochs Extensions
2322 @item
2323 2 IDE interfaces with hard disk and CD-ROM support
2324 @item
2325 Floppy disk
2326 @item
2327 NE2000 network adapters
2328 @item
2329 Serial port
2330 @item
2331 PREP Non Volatile RAM
2332 @item
2333 PC compatible keyboard and mouse.
2334 @end itemize
2336 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2337 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2339 Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
2340 for the g3bw PowerMac machine. OpenBIOS is a free (GPL v2) portable
2341 firmware implementation. The goal is to implement a 100% IEEE
2342 1275-1994 (referred to as Open Firmware) compliant firmware.
2344 @c man begin OPTIONS
2346 The following options are specific to the PowerPC emulation:
2348 @table @option
2350 @item -g WxH[xDEPTH]
2352 Set the initial VGA graphic mode. The default is 800x600x15.
2354 @item -prom-env string
2356 Set OpenBIOS variables in NVRAM, for example:
2358 @example
2359 qemu-system-ppc -prom-env 'auto-boot?=false' \
2360  -prom-env 'boot-device=hd:2,\yaboot' \
2361  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
2362 @end example
2364 These variables are not used by Open Hack'Ware.
2366 @end table
2368 @c man end
2371 More information is available at
2372 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2374 @node Sparc32 System emulator
2375 @section Sparc32 System emulator
2377 Use the executable @file{qemu-system-sparc} to simulate the following
2378 Sun4m architecture machines:
2379 @itemize @minus
2380 @item
2381 SPARCstation 4
2382 @item
2383 SPARCstation 5
2384 @item
2385 SPARCstation 10
2386 @item
2387 SPARCstation 20
2388 @item
2389 SPARCserver 600MP
2390 @item
2391 SPARCstation LX
2392 @item
2393 SPARCstation Voyager
2394 @item
2395 SPARCclassic
2396 @item
2397 SPARCbook
2398 @end itemize
2400 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
2401 but Linux limits the number of usable CPUs to 4.
2403 It's also possible to simulate a SPARCstation 2 (sun4c architecture),
2404 SPARCserver 1000, or SPARCcenter 2000 (sun4d architecture), but these
2405 emulators are not usable yet.
2407 QEMU emulates the following sun4m/sun4c/sun4d peripherals:
2409 @itemize @minus
2410 @item
2411 IOMMU or IO-UNITs
2412 @item
2413 TCX Frame buffer
2414 @item
2415 Lance (Am7990) Ethernet
2416 @item
2417 Non Volatile RAM M48T02/M48T08
2418 @item
2419 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2420 and power/reset logic
2421 @item
2422 ESP SCSI controller with hard disk and CD-ROM support
2423 @item
2424 Floppy drive (not on SS-600MP)
2425 @item
2426 CS4231 sound device (only on SS-5, not working yet)
2427 @end itemize
2429 The number of peripherals is fixed in the architecture.  Maximum
2430 memory size depends on the machine type, for SS-5 it is 256MB and for
2431 others 2047MB.
2433 Since version 0.8.2, QEMU uses OpenBIOS
2434 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2435 firmware implementation. The goal is to implement a 100% IEEE
2436 1275-1994 (referred to as Open Firmware) compliant firmware.
2438 A sample Linux 2.6 series kernel and ram disk image are available on
2439 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
2440 some kernel versions work. Please note that currently Solaris kernels
2441 don't work probably due to interface issues between OpenBIOS and
2442 Solaris.
2444 @c man begin OPTIONS
2446 The following options are specific to the Sparc32 emulation:
2448 @table @option
2450 @item -g WxHx[xDEPTH]
2452 Set the initial TCX graphic mode. The default is 1024x768x8, currently
2453 the only other possible mode is 1024x768x24.
2455 @item -prom-env string
2457 Set OpenBIOS variables in NVRAM, for example:
2459 @example
2460 qemu-system-sparc -prom-env 'auto-boot?=false' \
2461  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2462 @end example
2464 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic|SPARCbook|SS-2|SS-1000|SS-2000]
2466 Set the emulated machine type. Default is SS-5.
2468 @end table
2470 @c man end
2472 @node Sparc64 System emulator
2473 @section Sparc64 System emulator
2475 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
2476 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
2477 Niagara (T1) machine. The emulator is not usable for anything yet, but
2478 it can launch some kernels.
2480 QEMU emulates the following peripherals:
2482 @itemize @minus
2483 @item
2484 UltraSparc IIi APB PCI Bridge
2485 @item
2486 PCI VGA compatible card with VESA Bochs Extensions
2487 @item
2488 PS/2 mouse and keyboard
2489 @item
2490 Non Volatile RAM M48T59
2491 @item
2492 PC-compatible serial ports
2493 @item
2494 2 PCI IDE interfaces with hard disk and CD-ROM support
2495 @item
2496 Floppy disk
2497 @end itemize
2499 @c man begin OPTIONS
2501 The following options are specific to the Sparc64 emulation:
2503 @table @option
2505 @item -prom-env string
2507 Set OpenBIOS variables in NVRAM, for example:
2509 @example
2510 qemu-system-sparc64 -prom-env 'auto-boot?=false'
2511 @end example
2513 @item -M [sun4u|sun4v|Niagara]
2515 Set the emulated machine type. The default is sun4u.
2517 @end table
2519 @c man end
2521 @node MIPS System emulator
2522 @section MIPS System emulator
2524 Four executables cover simulation of 32 and 64-bit MIPS systems in
2525 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2526 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2527 Five different machine types are emulated:
2529 @itemize @minus
2530 @item
2531 A generic ISA PC-like machine "mips"
2532 @item
2533 The MIPS Malta prototype board "malta"
2534 @item
2535 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2536 @item
2537 MIPS emulator pseudo board "mipssim"
2538 @item
2539 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2540 @end itemize
2542 The generic emulation is supported by Debian 'Etch' and is able to
2543 install Debian into a virtual disk image. The following devices are
2544 emulated:
2546 @itemize @minus
2547 @item
2548 A range of MIPS CPUs, default is the 24Kf
2549 @item
2550 PC style serial port
2551 @item
2552 PC style IDE disk
2553 @item
2554 NE2000 network card
2555 @end itemize
2557 The Malta emulation supports the following devices:
2559 @itemize @minus
2560 @item
2561 Core board with MIPS 24Kf CPU and Galileo system controller
2562 @item
2563 PIIX4 PCI/USB/SMbus controller
2564 @item
2565 The Multi-I/O chip's serial device
2566 @item
2567 PCnet32 PCI network card
2568 @item
2569 Malta FPGA serial device
2570 @item
2571 Cirrus VGA graphics card
2572 @end itemize
2574 The ACER Pica emulation supports:
2576 @itemize @minus
2577 @item
2578 MIPS R4000 CPU
2579 @item
2580 PC-style IRQ and DMA controllers
2581 @item
2582 PC Keyboard
2583 @item
2584 IDE controller
2585 @end itemize
2587 The mipssim pseudo board emulation provides an environment similiar
2588 to what the proprietary MIPS emulator uses for running Linux.
2589 It supports:
2591 @itemize @minus
2592 @item
2593 A range of MIPS CPUs, default is the 24Kf
2594 @item
2595 PC style serial port
2596 @item
2597 MIPSnet network emulation
2598 @end itemize
2600 The MIPS Magnum R4000 emulation supports:
2602 @itemize @minus
2603 @item
2604 MIPS R4000 CPU
2605 @item
2606 PC-style IRQ controller
2607 @item
2608 PC Keyboard
2609 @item
2610 SCSI controller
2611 @item
2612 G364 framebuffer
2613 @end itemize
2616 @node ARM System emulator
2617 @section ARM System emulator
2619 Use the executable @file{qemu-system-arm} to simulate a ARM
2620 machine. The ARM Integrator/CP board is emulated with the following
2621 devices:
2623 @itemize @minus
2624 @item
2625 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2626 @item
2627 Two PL011 UARTs
2628 @item
2629 SMC 91c111 Ethernet adapter
2630 @item
2631 PL110 LCD controller
2632 @item
2633 PL050 KMI with PS/2 keyboard and mouse.
2634 @item
2635 PL181 MultiMedia Card Interface with SD card.
2636 @end itemize
2638 The ARM Versatile baseboard is emulated with the following devices:
2640 @itemize @minus
2641 @item
2642 ARM926E, ARM1136 or Cortex-A8 CPU
2643 @item
2644 PL190 Vectored Interrupt Controller
2645 @item
2646 Four PL011 UARTs
2647 @item
2648 SMC 91c111 Ethernet adapter
2649 @item
2650 PL110 LCD controller
2651 @item
2652 PL050 KMI with PS/2 keyboard and mouse.
2653 @item
2654 PCI host bridge.  Note the emulated PCI bridge only provides access to
2655 PCI memory space.  It does not provide access to PCI IO space.
2656 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2657 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2658 mapped control registers.
2659 @item
2660 PCI OHCI USB controller.
2661 @item
2662 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2663 @item
2664 PL181 MultiMedia Card Interface with SD card.
2665 @end itemize
2667 The ARM RealView Emulation baseboard is emulated with the following devices:
2669 @itemize @minus
2670 @item
2671 ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2672 @item
2673 ARM AMBA Generic/Distributed Interrupt Controller
2674 @item
2675 Four PL011 UARTs
2676 @item
2677 SMC 91c111 Ethernet adapter
2678 @item
2679 PL110 LCD controller
2680 @item
2681 PL050 KMI with PS/2 keyboard and mouse
2682 @item
2683 PCI host bridge
2684 @item
2685 PCI OHCI USB controller
2686 @item
2687 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2688 @item
2689 PL181 MultiMedia Card Interface with SD card.
2690 @end itemize
2692 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2693 and "Terrier") emulation includes the following peripherals:
2695 @itemize @minus
2696 @item
2697 Intel PXA270 System-on-chip (ARM V5TE core)
2698 @item
2699 NAND Flash memory
2700 @item
2701 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2702 @item
2703 On-chip OHCI USB controller
2704 @item
2705 On-chip LCD controller
2706 @item
2707 On-chip Real Time Clock
2708 @item
2709 TI ADS7846 touchscreen controller on SSP bus
2710 @item
2711 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2712 @item
2713 GPIO-connected keyboard controller and LEDs
2714 @item
2715 Secure Digital card connected to PXA MMC/SD host
2716 @item
2717 Three on-chip UARTs
2718 @item
2719 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2720 @end itemize
2722 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2723 following elements:
2725 @itemize @minus
2726 @item
2727 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2728 @item
2729 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2730 @item
2731 On-chip LCD controller
2732 @item
2733 On-chip Real Time Clock
2734 @item
2735 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2736 CODEC, connected through MicroWire and I@math{^2}S busses
2737 @item
2738 GPIO-connected matrix keypad
2739 @item
2740 Secure Digital card connected to OMAP MMC/SD host
2741 @item
2742 Three on-chip UARTs
2743 @end itemize
2745 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2746 emulation supports the following elements:
2748 @itemize @minus
2749 @item
2750 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2751 @item
2752 RAM and non-volatile OneNAND Flash memories
2753 @item
2754 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2755 display controller and a LS041y3 MIPI DBI-C controller
2756 @item
2757 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2758 driven through SPI bus
2759 @item
2760 National Semiconductor LM8323-controlled qwerty keyboard driven
2761 through I@math{^2}C bus
2762 @item
2763 Secure Digital card connected to OMAP MMC/SD host
2764 @item
2765 Three OMAP on-chip UARTs and on-chip STI debugging console
2766 @item
2767 A Bluetooth(R) transciever and HCI connected to an UART
2768 @item
2769 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2770 TUSB6010 chip - only USB host mode is supported
2771 @item
2772 TI TMP105 temperature sensor driven through I@math{^2}C bus
2773 @item
2774 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2775 @item
2776 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2777 through CBUS
2778 @end itemize
2780 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2781 devices:
2783 @itemize @minus
2784 @item
2785 Cortex-M3 CPU core.
2786 @item
2787 64k Flash and 8k SRAM.
2788 @item
2789 Timers, UARTs, ADC and I@math{^2}C interface.
2790 @item
2791 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2792 @end itemize
2794 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2795 devices:
2797 @itemize @minus
2798 @item
2799 Cortex-M3 CPU core.
2800 @item
2801 256k Flash and 64k SRAM.
2802 @item
2803 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2804 @item
2805 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2806 @end itemize
2808 The Freecom MusicPal internet radio emulation includes the following
2809 elements:
2811 @itemize @minus
2812 @item
2813 Marvell MV88W8618 ARM core.
2814 @item
2815 32 MB RAM, 256 KB SRAM, 8 MB flash.
2816 @item
2817 Up to 2 16550 UARTs
2818 @item
2819 MV88W8xx8 Ethernet controller
2820 @item
2821 MV88W8618 audio controller, WM8750 CODEC and mixer
2822 @item
2823 128×64 display with brightness control
2824 @item
2825 2 buttons, 2 navigation wheels with button function
2826 @end itemize
2828 The Siemens SX1 models v1 and v2 (default) basic emulation.
2829 The emulaton includes the following elements:
2831 @itemize @minus
2832 @item
2833 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2834 @item
2835 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2837 1 Flash of 16MB and 1 Flash of 8MB
2839 1 Flash of 32MB
2840 @item
2841 On-chip LCD controller
2842 @item
2843 On-chip Real Time Clock
2844 @item
2845 Secure Digital card connected to OMAP MMC/SD host
2846 @item
2847 Three on-chip UARTs
2848 @end itemize
2850 A Linux 2.6 test image is available on the QEMU web site. More
2851 information is available in the QEMU mailing-list archive.
2853 @node ColdFire System emulator
2854 @section ColdFire System emulator
2856 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2857 The emulator is able to boot a uClinux kernel.
2859 The M5208EVB emulation includes the following devices:
2861 @itemize @minus
2862 @item
2863 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2864 @item
2865 Three Two on-chip UARTs.
2866 @item
2867 Fast Ethernet Controller (FEC)
2868 @end itemize
2870 The AN5206 emulation includes the following devices:
2872 @itemize @minus
2873 @item
2874 MCF5206 ColdFire V2 Microprocessor.
2875 @item
2876 Two on-chip UARTs.
2877 @end itemize
2879 @node QEMU User space emulator
2880 @chapter QEMU User space emulator
2882 @menu
2883 * Supported Operating Systems ::
2884 * Linux User space emulator::
2885 * Mac OS X/Darwin User space emulator ::
2886 * BSD User space emulator ::
2887 @end menu
2889 @node Supported Operating Systems
2890 @section Supported Operating Systems
2892 The following OS are supported in user space emulation:
2894 @itemize @minus
2895 @item
2896 Linux (referred as qemu-linux-user)
2897 @item
2898 Mac OS X/Darwin (referred as qemu-darwin-user)
2899 @item
2900 BSD (referred as qemu-bsd-user)
2901 @end itemize
2903 @node Linux User space emulator
2904 @section Linux User space emulator
2906 @menu
2907 * Quick Start::
2908 * Wine launch::
2909 * Command line options::
2910 * Other binaries::
2911 @end menu
2913 @node Quick Start
2914 @subsection Quick Start
2916 In order to launch a Linux process, QEMU needs the process executable
2917 itself and all the target (x86) dynamic libraries used by it.
2919 @itemize
2921 @item On x86, you can just try to launch any process by using the native
2922 libraries:
2924 @example
2925 qemu-i386 -L / /bin/ls
2926 @end example
2928 @code{-L /} tells that the x86 dynamic linker must be searched with a
2929 @file{/} prefix.
2931 @item Since QEMU is also a linux process, you can launch qemu with
2932 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2934 @example
2935 qemu-i386 -L / qemu-i386 -L / /bin/ls
2936 @end example
2938 @item On non x86 CPUs, you need first to download at least an x86 glibc
2939 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2940 @code{LD_LIBRARY_PATH} is not set:
2942 @example
2943 unset LD_LIBRARY_PATH
2944 @end example
2946 Then you can launch the precompiled @file{ls} x86 executable:
2948 @example
2949 qemu-i386 tests/i386/ls
2950 @end example
2951 You can look at @file{qemu-binfmt-conf.sh} so that
2952 QEMU is automatically launched by the Linux kernel when you try to
2953 launch x86 executables. It requires the @code{binfmt_misc} module in the
2954 Linux kernel.
2956 @item The x86 version of QEMU is also included. You can try weird things such as:
2957 @example
2958 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2959           /usr/local/qemu-i386/bin/ls-i386
2960 @end example
2962 @end itemize
2964 @node Wine launch
2965 @subsection Wine launch
2967 @itemize
2969 @item Ensure that you have a working QEMU with the x86 glibc
2970 distribution (see previous section). In order to verify it, you must be
2971 able to do:
2973 @example
2974 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2975 @end example
2977 @item Download the binary x86 Wine install
2978 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2980 @item Configure Wine on your account. Look at the provided script
2981 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2982 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2984 @item Then you can try the example @file{putty.exe}:
2986 @example
2987 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2988           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2989 @end example
2991 @end itemize
2993 @node Command line options
2994 @subsection Command line options
2996 @example
2997 usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] program [arguments...]
2998 @end example
3000 @table @option
3001 @item -h
3002 Print the help
3003 @item -L path
3004 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
3005 @item -s size
3006 Set the x86 stack size in bytes (default=524288)
3007 @item -cpu model
3008 Select CPU model (-cpu ? for list and additional feature selection)
3009 @end table
3011 Debug options:
3013 @table @option
3014 @item -d
3015 Activate log (logfile=/tmp/qemu.log)
3016 @item -p pagesize
3017 Act as if the host page size was 'pagesize' bytes
3018 @item -g port
3019 Wait gdb connection to port
3020 @end table
3022 Environment variables:
3024 @table @env
3025 @item QEMU_STRACE
3026 Print system calls and arguments similar to the 'strace' program
3027 (NOTE: the actual 'strace' program will not work because the user
3028 space emulator hasn't implemented ptrace).  At the moment this is
3029 incomplete.  All system calls that don't have a specific argument
3030 format are printed with information for six arguments.  Many
3031 flag-style arguments don't have decoders and will show up as numbers.
3032 @end table
3034 @node Other binaries
3035 @subsection Other binaries
3037 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
3038 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
3039 configurations), and arm-uclinux bFLT format binaries.
3041 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
3042 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
3043 coldfire uClinux bFLT format binaries.
3045 The binary format is detected automatically.
3047 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
3049 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
3050 (Sparc64 CPU, 32 bit ABI).
3052 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
3053 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
3055 @node Mac OS X/Darwin User space emulator
3056 @section Mac OS X/Darwin User space emulator
3058 @menu
3059 * Mac OS X/Darwin Status::
3060 * Mac OS X/Darwin Quick Start::
3061 * Mac OS X/Darwin Command line options::
3062 @end menu
3064 @node Mac OS X/Darwin Status
3065 @subsection Mac OS X/Darwin Status
3067 @itemize @minus
3068 @item
3069 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
3070 @item
3071 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
3072 @item
3073 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
3074 @item
3075 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
3076 @end itemize
3078 [1] If you're host commpage can be executed by qemu.
3080 @node Mac OS X/Darwin Quick Start
3081 @subsection Quick Start
3083 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
3084 itself and all the target dynamic libraries used by it. If you don't have the FAT
3085 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
3086 CD or compile them by hand.
3088 @itemize
3090 @item On x86, you can just try to launch any process by using the native
3091 libraries:
3093 @example
3094 qemu-i386 /bin/ls
3095 @end example
3097 or to run the ppc version of the executable:
3099 @example
3100 qemu-ppc /bin/ls
3101 @end example
3103 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
3104 are installed:
3106 @example
3107 qemu-i386 -L /opt/x86_root/ /bin/ls
3108 @end example
3110 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
3111 @file{/opt/x86_root/usr/bin/dyld}.
3113 @end itemize
3115 @node Mac OS X/Darwin Command line options
3116 @subsection Command line options
3118 @example
3119 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
3120 @end example
3122 @table @option
3123 @item -h
3124 Print the help
3125 @item -L path
3126 Set the library root path (default=/)
3127 @item -s size
3128 Set the stack size in bytes (default=524288)
3129 @end table
3131 Debug options:
3133 @table @option
3134 @item -d
3135 Activate log (logfile=/tmp/qemu.log)
3136 @item -p pagesize
3137 Act as if the host page size was 'pagesize' bytes
3138 @end table
3140 @node BSD User space emulator
3141 @section BSD User space emulator
3143 @menu
3144 * BSD Status::
3145 * BSD Quick Start::
3146 * BSD Command line options::
3147 @end menu
3149 @node BSD Status
3150 @subsection BSD Status
3152 @itemize @minus
3153 @item
3154 target Sparc64 on Sparc64: Some trivial programs work.
3155 @end itemize
3157 @node BSD Quick Start
3158 @subsection Quick Start
3160 In order to launch a BSD process, QEMU needs the process executable
3161 itself and all the target dynamic libraries used by it.
3163 @itemize
3165 @item On Sparc64, you can just try to launch any process by using the native
3166 libraries:
3168 @example
3169 qemu-sparc64 /bin/ls
3170 @end example
3172 @end itemize
3174 @node BSD Command line options
3175 @subsection Command line options
3177 @example
3178 usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
3179 @end example
3181 @table @option
3182 @item -h
3183 Print the help
3184 @item -L path
3185 Set the library root path (default=/)
3186 @item -s size
3187 Set the stack size in bytes (default=524288)
3188 @item -bsd type
3189 Set the type of the emulated BSD Operating system. Valid values are
3190 FreeBSD, NetBSD and OpenBSD (default).
3191 @end table
3193 Debug options:
3195 @table @option
3196 @item -d
3197 Activate log (logfile=/tmp/qemu.log)
3198 @item -p pagesize
3199 Act as if the host page size was 'pagesize' bytes
3200 @end table
3202 @node compilation
3203 @chapter Compilation from the sources
3205 @menu
3206 * Linux/Unix::
3207 * Windows::
3208 * Cross compilation for Windows with Linux::
3209 * Mac OS X::
3210 @end menu
3212 @node Linux/Unix
3213 @section Linux/Unix
3215 @subsection Compilation
3217 First you must decompress the sources:
3218 @example
3219 cd /tmp
3220 tar zxvf qemu-x.y.z.tar.gz
3221 cd qemu-x.y.z
3222 @end example
3224 Then you configure QEMU and build it (usually no options are needed):
3225 @example
3226 ./configure
3227 make
3228 @end example
3230 Then type as root user:
3231 @example
3232 make install
3233 @end example
3234 to install QEMU in @file{/usr/local}.
3236 @subsection GCC version
3238 In order to compile QEMU successfully, it is very important that you
3239 have the right tools. The most important one is gcc. On most hosts and
3240 in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
3241 Linux distribution includes a gcc 4.x compiler, you can usually
3242 install an older version (it is invoked by @code{gcc32} or
3243 @code{gcc34}). The QEMU configure script automatically probes for
3244 these older versions so that usually you don't have to do anything.
3246 @node Windows
3247 @section Windows
3249 @itemize
3250 @item Install the current versions of MSYS and MinGW from
3251 @url{http://www.mingw.org/}. You can find detailed installation
3252 instructions in the download section and the FAQ.
3254 @item Download
3255 the MinGW development library of SDL 1.2.x
3256 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
3257 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
3258 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
3259 directory. Edit the @file{sdl-config} script so that it gives the
3260 correct SDL directory when invoked.
3262 @item Extract the current version of QEMU.
3264 @item Start the MSYS shell (file @file{msys.bat}).
3266 @item Change to the QEMU directory. Launch @file{./configure} and
3267 @file{make}.  If you have problems using SDL, verify that
3268 @file{sdl-config} can be launched from the MSYS command line.
3270 @item You can install QEMU in @file{Program Files/Qemu} by typing
3271 @file{make install}. Don't forget to copy @file{SDL.dll} in
3272 @file{Program Files/Qemu}.
3274 @end itemize
3276 @node Cross compilation for Windows with Linux
3277 @section Cross compilation for Windows with Linux
3279 @itemize
3280 @item
3281 Install the MinGW cross compilation tools available at
3282 @url{http://www.mingw.org/}.
3284 @item
3285 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
3286 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
3287 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
3288 the QEMU configuration script.
3290 @item
3291 Configure QEMU for Windows cross compilation:
3292 @example
3293 ./configure --enable-mingw32
3294 @end example
3295 If necessary, you can change the cross-prefix according to the prefix
3296 chosen for the MinGW tools with --cross-prefix. You can also use
3297 --prefix to set the Win32 install path.
3299 @item You can install QEMU in the installation directory by typing
3300 @file{make install}. Don't forget to copy @file{SDL.dll} in the
3301 installation directory.
3303 @end itemize
3305 Note: Currently, Wine does not seem able to launch
3306 QEMU for Win32.
3308 @node Mac OS X
3309 @section Mac OS X
3311 The Mac OS X patches are not fully merged in QEMU, so you should look
3312 at the QEMU mailing list archive to have all the necessary
3313 information.
3315 @node Index
3316 @chapter Index
3317 @printindex cp
3319 @bye