Statistics
| Branch: | Revision:

root / qemu-doc.texi @ b0b3de89

History | View | Annotate | Download (77.8 kB)

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