Statistics
| Branch: | Revision:

root / qemu-doc.texi @ 26a16623

History | View | Annotate | Download (59.9 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 0806e3f6 bellard
@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 0806e3f6 bellard
@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 6f2f2b24 bellard
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 ed96ca35 pbrook
@item ARM Integrator/CP (ARM926E or 1026E processor)
81 00a9bf19 pbrook
@item ARM Versatile baseboard (ARM926E)
82 52c00a5f bellard
@end itemize
83 386405f7 bellard
84 e6e5906b pbrook
For user emulation, x86, PowerPC, ARM, MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
85 0806e3f6 bellard
86 debc7065 bellard
@node Installation
87 5b9f457a bellard
@chapter Installation
88 5b9f457a bellard
89 15a34c63 bellard
If you want to compile QEMU yourself, see @ref{compilation}.
90 15a34c63 bellard
91 debc7065 bellard
@menu
92 debc7065 bellard
* install_linux::   Linux
93 debc7065 bellard
* install_windows:: Windows
94 debc7065 bellard
* install_mac::     Macintosh
95 debc7065 bellard
@end menu
96 debc7065 bellard
97 debc7065 bellard
@node install_linux
98 1f673135 bellard
@section Linux
99 1f673135 bellard
100 7c3fc84d bellard
If a precompiled package is available for your distribution - you just
101 7c3fc84d bellard
have to install it. Otherwise, see @ref{compilation}.
102 5b9f457a bellard
103 debc7065 bellard
@node install_windows
104 1f673135 bellard
@section Windows
105 8cd0ac2f bellard
106 15a34c63 bellard
Download the experimental binary installer at
107 debc7065 bellard
@url{http://www.free.oszoo.org/@/download.html}.
108 d691f669 bellard
109 debc7065 bellard
@node install_mac
110 1f673135 bellard
@section Mac OS X
111 d691f669 bellard
112 15a34c63 bellard
Download the experimental binary installer at
113 debc7065 bellard
@url{http://www.free.oszoo.org/@/download.html}.
114 df0f11a0 bellard
115 debc7065 bellard
@node QEMU PC System emulator
116 3f9f3aa1 bellard
@chapter QEMU PC System emulator
117 1eb20527 bellard
118 debc7065 bellard
@menu
119 debc7065 bellard
* pcsys_introduction:: Introduction
120 debc7065 bellard
* pcsys_quickstart::   Quick Start
121 debc7065 bellard
* sec_invocation::     Invocation
122 debc7065 bellard
* pcsys_keys::         Keys
123 debc7065 bellard
* pcsys_monitor::      QEMU Monitor
124 debc7065 bellard
* disk_images::        Disk Images
125 debc7065 bellard
* pcsys_network::      Network emulation
126 debc7065 bellard
* direct_linux_boot::  Direct Linux Boot
127 debc7065 bellard
* pcsys_usb::          USB emulation
128 debc7065 bellard
* gdb_usage::          GDB usage
129 debc7065 bellard
* pcsys_os_specific::  Target OS specific information
130 debc7065 bellard
@end menu
131 debc7065 bellard
132 debc7065 bellard
@node pcsys_introduction
133 0806e3f6 bellard
@section Introduction
134 0806e3f6 bellard
135 0806e3f6 bellard
@c man begin DESCRIPTION
136 0806e3f6 bellard
137 3f9f3aa1 bellard
The QEMU PC System emulator simulates the
138 3f9f3aa1 bellard
following peripherals:
139 0806e3f6 bellard
140 0806e3f6 bellard
@itemize @minus
141 15a34c63 bellard
@item 
142 15a34c63 bellard
i440FX host PCI bridge and PIIX3 PCI to ISA bridge
143 0806e3f6 bellard
@item
144 15a34c63 bellard
Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
145 15a34c63 bellard
extensions (hardware level, including all non standard modes).
146 0806e3f6 bellard
@item
147 0806e3f6 bellard
PS/2 mouse and keyboard
148 0806e3f6 bellard
@item 
149 15a34c63 bellard
2 PCI IDE interfaces with hard disk and CD-ROM support
150 1f673135 bellard
@item
151 1f673135 bellard
Floppy disk
152 0806e3f6 bellard
@item 
153 15a34c63 bellard
NE2000 PCI network adapters
154 0806e3f6 bellard
@item
155 05d5818c bellard
Serial ports
156 05d5818c bellard
@item
157 c0fe3827 bellard
Creative SoundBlaster 16 sound card
158 c0fe3827 bellard
@item
159 c0fe3827 bellard
ENSONIQ AudioPCI ES1370 sound card
160 c0fe3827 bellard
@item
161 c0fe3827 bellard
Adlib(OPL2) - Yamaha YM3812 compatible chip
162 b389dbfb bellard
@item
163 b389dbfb bellard
PCI UHCI USB controller and a virtual USB hub.
164 0806e3f6 bellard
@end itemize
165 0806e3f6 bellard
166 3f9f3aa1 bellard
SMP is supported with up to 255 CPUs.
167 3f9f3aa1 bellard
168 c0fe3827 bellard
Note that adlib is only available when QEMU was configured with
169 c0fe3827 bellard
-enable-adlib
170 c0fe3827 bellard
171 15a34c63 bellard
QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
172 15a34c63 bellard
VGA BIOS.
173 15a34c63 bellard
174 c0fe3827 bellard
QEMU uses YM3812 emulation by Tatsuyuki Satoh.
175 c0fe3827 bellard
176 0806e3f6 bellard
@c man end
177 0806e3f6 bellard
178 debc7065 bellard
@node pcsys_quickstart
179 1eb20527 bellard
@section Quick Start
180 1eb20527 bellard
181 285dc330 bellard
Download and uncompress the linux image (@file{linux.img}) and type:
182 0806e3f6 bellard
183 0806e3f6 bellard
@example
184 285dc330 bellard
qemu linux.img
185 0806e3f6 bellard
@end example
186 0806e3f6 bellard
187 0806e3f6 bellard
Linux should boot and give you a prompt.
188 0806e3f6 bellard
189 6cc721cf bellard
@node sec_invocation
190 ec410fc9 bellard
@section Invocation
191 ec410fc9 bellard
192 ec410fc9 bellard
@example
193 0806e3f6 bellard
@c man begin SYNOPSIS
194 0806e3f6 bellard
usage: qemu [options] [disk_image]
195 0806e3f6 bellard
@c man end
196 ec410fc9 bellard
@end example
197 ec410fc9 bellard
198 0806e3f6 bellard
@c man begin OPTIONS
199 9d4520d0 bellard
@var{disk_image} is a raw hard disk image for IDE hard disk 0.
200 ec410fc9 bellard
201 ec410fc9 bellard
General options:
202 ec410fc9 bellard
@table @option
203 3dbbdc25 bellard
@item -M machine
204 3dbbdc25 bellard
Select the emulated machine (@code{-M ?} for list)
205 3dbbdc25 bellard
206 2be3bc02 bellard
@item -fda file
207 2be3bc02 bellard
@item -fdb file
208 debc7065 bellard
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
209 19cb3738 bellard
use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
210 2be3bc02 bellard
211 ec410fc9 bellard
@item -hda file
212 ec410fc9 bellard
@item -hdb file
213 181f1558 bellard
@item -hdc file
214 181f1558 bellard
@item -hdd file
215 debc7065 bellard
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
216 1f47a922 bellard
217 181f1558 bellard
@item -cdrom file
218 181f1558 bellard
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
219 be3edd95 bellard
@option{-cdrom} at the same time). You can use the host CD-ROM by
220 19cb3738 bellard
using @file{/dev/cdrom} as filename (@pxref{host_drives}).
221 181f1558 bellard
222 eec85c2a ths
@item -boot [a|c|d|n]
223 eec85c2a ths
Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
224 eec85c2a ths
is the default.
225 1f47a922 bellard
226 181f1558 bellard
@item -snapshot
227 1f47a922 bellard
Write to temporary files instead of disk image files. In this case,
228 1f47a922 bellard
the raw disk image you use is not written back. You can however force
229 42550fde ths
the write back by pressing @key{C-a s} (@pxref{disk_images}).
230 ec410fc9 bellard
231 52ca8d6a bellard
@item -no-fd-bootchk
232 52ca8d6a bellard
Disable boot signature checking for floppy disks in Bochs BIOS. It may
233 52ca8d6a bellard
be needed to boot from old floppy disks.
234 52ca8d6a bellard
235 ec410fc9 bellard
@item -m megs
236 15a34c63 bellard
Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
237 ec410fc9 bellard
238 3f9f3aa1 bellard
@item -smp n
239 3f9f3aa1 bellard
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
240 3f9f3aa1 bellard
CPUs are supported.
241 3f9f3aa1 bellard
242 0806e3f6 bellard
@item -nographic
243 0806e3f6 bellard
244 0806e3f6 bellard
Normally, QEMU uses SDL to display the VGA output. With this option,
245 0806e3f6 bellard
you can totally disable graphical output so that QEMU is a simple
246 0806e3f6 bellard
command line application. The emulated serial port is redirected on
247 0806e3f6 bellard
the console. Therefore, you can still use QEMU to debug a Linux kernel
248 0806e3f6 bellard
with a serial console.
249 0806e3f6 bellard
250 73fc9742 ths
@item -vnc display
251 24236869 bellard
252 24236869 bellard
Normally, QEMU uses SDL to display the VGA output.  With this option,
253 73fc9742 ths
you can have QEMU listen on VNC display @var{display} and redirect the VGA
254 3c656346 bellard
display over the VNC session.  It is very useful to enable the usb
255 3c656346 bellard
tablet device when using this option (option @option{-usbdevice
256 3c656346 bellard
tablet}). When using the VNC display, you must use the @option{-k}
257 73fc9742 ths
option to set the keyboard layout if you are not using en-us.
258 73fc9742 ths
259 73fc9742 ths
@var{display} may be in the form @var{interface:d}, in which case connections
260 73fc9742 ths
will only be allowed from @var{interface} on display @var{d}. Optionally,
261 73fc9742 ths
@var{interface} can be omitted.  @var{display} can also be in the form
262 73fc9742 ths
@var{unix:path} where @var{path} is the location of a unix socket to listen for
263 73fc9742 ths
connections on.
264 73fc9742 ths
265 24236869 bellard
266 3d11d0eb bellard
@item -k language
267 3d11d0eb bellard
268 3d11d0eb bellard
Use keyboard layout @var{language} (for example @code{fr} for
269 3d11d0eb bellard
French). This option is only needed where it is not easy to get raw PC
270 3c656346 bellard
keycodes (e.g. on Macs, with some X11 servers or with a VNC
271 3c656346 bellard
display). You don't normally need to use it on PC/Linux or PC/Windows
272 3c656346 bellard
hosts.
273 3d11d0eb bellard
274 3d11d0eb bellard
The available layouts are:
275 3d11d0eb bellard
@example
276 3d11d0eb bellard
ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
277 3d11d0eb bellard
da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
278 3d11d0eb bellard
de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
279 3d11d0eb bellard
@end example
280 3d11d0eb bellard
281 3d11d0eb bellard
The default is @code{en-us}.
282 3d11d0eb bellard
283 1d14ffa9 bellard
@item -audio-help
284 1d14ffa9 bellard
285 1d14ffa9 bellard
Will show the audio subsystem help: list of drivers, tunable
286 1d14ffa9 bellard
parameters.
287 1d14ffa9 bellard
288 6a36d84e bellard
@item -soundhw card1,card2,... or -soundhw all
289 1d14ffa9 bellard
290 1d14ffa9 bellard
Enable audio and selected sound hardware. Use ? to print all
291 1d14ffa9 bellard
available sound hardware.
292 1d14ffa9 bellard
293 1d14ffa9 bellard
@example
294 1d14ffa9 bellard
qemu -soundhw sb16,adlib hda
295 1d14ffa9 bellard
qemu -soundhw es1370 hda
296 6a36d84e bellard
qemu -soundhw all hda
297 1d14ffa9 bellard
qemu -soundhw ?
298 1d14ffa9 bellard
@end example
299 a8c490cd bellard
300 15a34c63 bellard
@item -localtime
301 15a34c63 bellard
Set the real time clock to local time (the default is to UTC
302 15a34c63 bellard
time). This option is needed to have correct date in MS-DOS or
303 15a34c63 bellard
Windows.
304 15a34c63 bellard
305 d63d307f bellard
@item -full-screen
306 d63d307f bellard
Start in full screen.
307 d63d307f bellard
308 f7cce898 bellard
@item -pidfile file
309 f7cce898 bellard
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
310 f7cce898 bellard
from a script.
311 f7cce898 bellard
312 71e3ceb8 ths
@item -daemonize
313 71e3ceb8 ths
Daemonize the QEMU process after initialization.  QEMU will not detach from
314 71e3ceb8 ths
standard IO until it is ready to receive connections on any of its devices.
315 71e3ceb8 ths
This option is a useful way for external programs to launch QEMU without having
316 71e3ceb8 ths
to cope with initialization race conditions.
317 71e3ceb8 ths
318 9d0a8e6f bellard
@item -win2k-hack
319 9d0a8e6f bellard
Use it when installing Windows 2000 to avoid a disk full bug. After
320 9d0a8e6f bellard
Windows 2000 is installed, you no longer need this option (this option
321 9d0a8e6f bellard
slows down the IDE transfers).
322 9d0a8e6f bellard
323 9ae02555 ths
@item -option-rom file
324 9ae02555 ths
Load the contents of file as an option ROM.  This option is useful to load
325 9ae02555 ths
things like EtherBoot.
326 9ae02555 ths
327 0806e3f6 bellard
@end table
328 0806e3f6 bellard
329 b389dbfb bellard
USB options:
330 b389dbfb bellard
@table @option
331 b389dbfb bellard
332 b389dbfb bellard
@item -usb
333 b389dbfb bellard
Enable the USB driver (will be the default soon)
334 b389dbfb bellard
335 b389dbfb bellard
@item -usbdevice devname
336 0aff66b5 pbrook
Add the USB device @var{devname}. @xref{usb_devices}.
337 b389dbfb bellard
@end table
338 b389dbfb bellard
339 1f673135 bellard
Network options:
340 1f673135 bellard
341 1f673135 bellard
@table @option
342 1f673135 bellard
343 a41b2ff2 pbrook
@item -net nic[,vlan=n][,macaddr=addr][,model=type]
344 41d03949 bellard
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
345 41d03949 bellard
= 0 is the default). The NIC is currently an NE2000 on the PC
346 41d03949 bellard
target. Optionally, the MAC address can be changed. If no
347 41d03949 bellard
@option{-net} option is specified, a single NIC is created.
348 a41b2ff2 pbrook
Qemu can emulate several different models of network card.  Valid values for
349 a41b2ff2 pbrook
@var{type} are @code{ne2k_pci}, @code{ne2k_isa}, @code{rtl8139},
350 a41b2ff2 pbrook
@code{smc91c111} and @code{lance}.  Not all devices are supported on all
351 a41b2ff2 pbrook
targets.
352 41d03949 bellard
353 115defd1 pbrook
@item -net user[,vlan=n][,hostname=name]
354 7e89463d bellard
Use the user mode network stack which requires no administrator
355 a03a6053 pbrook
priviledge to run.  @option{hostname=name} can be used to specify the client
356 115defd1 pbrook
hostname reported by the builtin DHCP server.
357 41d03949 bellard
358 41d03949 bellard
@item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
359 41d03949 bellard
Connect the host TAP network interface @var{name} to VLAN @var{n} and
360 41d03949 bellard
use the network script @var{file} to configure it. The default
361 6a1cbf68 ths
network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
362 6a1cbf68 ths
disable script execution. If @var{name} is not
363 41d03949 bellard
provided, the OS automatically provides one.  @option{fd=h} can be
364 41d03949 bellard
used to specify the handle of an already opened host TAP interface. Example:
365 1f673135 bellard
366 41d03949 bellard
@example
367 41d03949 bellard
qemu linux.img -net nic -net tap
368 41d03949 bellard
@end example
369 41d03949 bellard
370 41d03949 bellard
More complicated example (two NICs, each one connected to a TAP device)
371 41d03949 bellard
@example
372 41d03949 bellard
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
373 41d03949 bellard
               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
374 41d03949 bellard
@end example
375 3f1a88f4 bellard
376 3f1a88f4 bellard
377 41d03949 bellard
@item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
378 1f673135 bellard
379 41d03949 bellard
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
380 41d03949 bellard
machine using a TCP socket connection. If @option{listen} is
381 41d03949 bellard
specified, QEMU waits for incoming connections on @var{port}
382 41d03949 bellard
(@var{host} is optional). @option{connect} is used to connect to
383 3d830459 bellard
another QEMU instance using the @option{listen} option. @option{fd=h}
384 3d830459 bellard
specifies an already opened TCP socket.
385 1f673135 bellard
386 41d03949 bellard
Example:
387 41d03949 bellard
@example
388 41d03949 bellard
# launch a first QEMU instance
389 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
390 debc7065 bellard
               -net socket,listen=:1234
391 debc7065 bellard
# connect the VLAN 0 of this instance to the VLAN 0
392 debc7065 bellard
# of the first instance
393 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
394 debc7065 bellard
               -net socket,connect=127.0.0.1:1234
395 41d03949 bellard
@end example
396 52c00a5f bellard
397 3d830459 bellard
@item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]
398 3d830459 bellard
399 3d830459 bellard
Create a VLAN @var{n} shared with another QEMU virtual
400 3d830459 bellard
machines using a UDP multicast socket, effectively making a bus for 
401 3d830459 bellard
every QEMU with same multicast address @var{maddr} and @var{port}.
402 3d830459 bellard
NOTES:
403 3d830459 bellard
@enumerate
404 3d830459 bellard
@item 
405 3d830459 bellard
Several QEMU can be running on different hosts and share same bus (assuming 
406 3d830459 bellard
correct multicast setup for these hosts).
407 3d830459 bellard
@item
408 3d830459 bellard
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
409 3d830459 bellard
@url{http://user-mode-linux.sf.net}.
410 3d830459 bellard
@item Use @option{fd=h} to specify an already opened UDP multicast socket.
411 3d830459 bellard
@end enumerate
412 3d830459 bellard
413 3d830459 bellard
Example:
414 3d830459 bellard
@example
415 3d830459 bellard
# launch one QEMU instance
416 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
417 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
418 3d830459 bellard
# launch another QEMU instance on same "bus"
419 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
420 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
421 3d830459 bellard
# launch yet another QEMU instance on same "bus"
422 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
423 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
424 3d830459 bellard
@end example
425 3d830459 bellard
426 3d830459 bellard
Example (User Mode Linux compat.):
427 3d830459 bellard
@example
428 debc7065 bellard
# launch QEMU instance (note mcast address selected
429 debc7065 bellard
# is UML's default)
430 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
431 debc7065 bellard
               -net socket,mcast=239.192.168.1:1102
432 3d830459 bellard
# launch UML
433 3d830459 bellard
/path/to/linux ubd0=/path/to/root_fs eth0=mcast
434 3d830459 bellard
@end example
435 3d830459 bellard
436 41d03949 bellard
@item -net none
437 41d03949 bellard
Indicate that no network devices should be configured. It is used to
438 039af320 bellard
override the default configuration (@option{-net nic -net user}) which
439 039af320 bellard
is activated if no @option{-net} options are provided.
440 52c00a5f bellard
441 9bf05444 bellard
@item -tftp prefix
442 9bf05444 bellard
When using the user mode network stack, activate a built-in TFTP
443 9bf05444 bellard
server. All filenames beginning with @var{prefix} can be downloaded
444 9bf05444 bellard
from the host to the guest using a TFTP client. The TFTP client on the
445 9bf05444 bellard
guest must be configured in binary mode (use the command @code{bin} of
446 9bf05444 bellard
the Unix TFTP client). The host IP address on the guest is as usual
447 9bf05444 bellard
10.0.2.2.
448 9bf05444 bellard
449 2518bd0d bellard
@item -smb dir
450 2518bd0d bellard
When using the user mode network stack, activate a built-in SMB
451 2518bd0d bellard
server so that Windows OSes can access to the host files in @file{dir}
452 2518bd0d bellard
transparently.
453 2518bd0d bellard
454 2518bd0d bellard
In the guest Windows OS, the line:
455 2518bd0d bellard
@example
456 2518bd0d bellard
10.0.2.4 smbserver
457 2518bd0d bellard
@end example
458 2518bd0d bellard
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
459 2518bd0d bellard
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
460 2518bd0d bellard
461 2518bd0d bellard
Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
462 2518bd0d bellard
463 2518bd0d bellard
Note that a SAMBA server must be installed on the host OS in
464 366dfc52 ths
@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
465 6cc721cf bellard
2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
466 2518bd0d bellard
467 9bf05444 bellard
@item -redir [tcp|udp]:host-port:[guest-host]:guest-port
468 9bf05444 bellard
469 9bf05444 bellard
When using the user mode network stack, redirect incoming TCP or UDP
470 9bf05444 bellard
connections to the host port @var{host-port} to the guest
471 9bf05444 bellard
@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
472 9bf05444 bellard
is not specified, its value is 10.0.2.15 (default address given by the
473 9bf05444 bellard
built-in DHCP server).
474 9bf05444 bellard
475 9bf05444 bellard
For example, to redirect host X11 connection from screen 1 to guest
476 9bf05444 bellard
screen 0, use the following:
477 9bf05444 bellard
478 9bf05444 bellard
@example
479 9bf05444 bellard
# on the host
480 9bf05444 bellard
qemu -redir tcp:6001::6000 [...]
481 9bf05444 bellard
# this host xterm should open in the guest X11 server
482 9bf05444 bellard
xterm -display :1
483 9bf05444 bellard
@end example
484 9bf05444 bellard
485 9bf05444 bellard
To redirect telnet connections from host port 5555 to telnet port on
486 9bf05444 bellard
the guest, use the following:
487 9bf05444 bellard
488 9bf05444 bellard
@example
489 9bf05444 bellard
# on the host
490 9bf05444 bellard
qemu -redir tcp:5555::23 [...]
491 9bf05444 bellard
telnet localhost 5555
492 9bf05444 bellard
@end example
493 9bf05444 bellard
494 9bf05444 bellard
Then when you use on the host @code{telnet localhost 5555}, you
495 9bf05444 bellard
connect to the guest telnet server.
496 9bf05444 bellard
497 1f673135 bellard
@end table
498 1f673135 bellard
499 41d03949 bellard
Linux boot specific: When using these options, you can use a given
500 1f673135 bellard
Linux kernel without installing it in the disk image. It can be useful
501 1f673135 bellard
for easier testing of various kernels.
502 1f673135 bellard
503 0806e3f6 bellard
@table @option
504 0806e3f6 bellard
505 0806e3f6 bellard
@item -kernel bzImage 
506 0806e3f6 bellard
Use @var{bzImage} as kernel image.
507 0806e3f6 bellard
508 0806e3f6 bellard
@item -append cmdline 
509 0806e3f6 bellard
Use @var{cmdline} as kernel command line
510 0806e3f6 bellard
511 0806e3f6 bellard
@item -initrd file
512 0806e3f6 bellard
Use @var{file} as initial ram disk.
513 0806e3f6 bellard
514 ec410fc9 bellard
@end table
515 ec410fc9 bellard
516 15a34c63 bellard
Debug/Expert options:
517 ec410fc9 bellard
@table @option
518 a0a821a4 bellard
519 a0a821a4 bellard
@item -serial dev
520 0bab00f3 bellard
Redirect the virtual serial port to host character device
521 0bab00f3 bellard
@var{dev}. The default device is @code{vc} in graphical mode and
522 0bab00f3 bellard
@code{stdio} in non graphical mode.
523 0bab00f3 bellard
524 0bab00f3 bellard
This option can be used several times to simulate up to 4 serials
525 0bab00f3 bellard
ports.
526 0bab00f3 bellard
527 c03b0f0f bellard
Use @code{-serial none} to disable all serial ports.
528 c03b0f0f bellard
529 0bab00f3 bellard
Available character devices are:
530 a0a821a4 bellard
@table @code
531 a0a821a4 bellard
@item vc
532 a0a821a4 bellard
Virtual console
533 a0a821a4 bellard
@item pty
534 a0a821a4 bellard
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
535 c03b0f0f bellard
@item none
536 c03b0f0f bellard
No device is allocated.
537 a0a821a4 bellard
@item null
538 a0a821a4 bellard
void device
539 f8d179e3 bellard
@item /dev/XXX
540 e57a8c0e bellard
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
541 f8d179e3 bellard
parameters are set according to the emulated ones.
542 e57a8c0e bellard
@item /dev/parportN
543 e57a8c0e bellard
[Linux only, parallel port only] Use host parallel port
544 e57a8c0e bellard
@var{N}. Currently only SPP parallel port features can be used.
545 f8d179e3 bellard
@item file:filename
546 f8d179e3 bellard
Write output to filename. No character can be read.
547 a0a821a4 bellard
@item stdio
548 a0a821a4 bellard
[Unix only] standard input/output
549 f8d179e3 bellard
@item pipe:filename
550 0bab00f3 bellard
name pipe @var{filename}
551 0bab00f3 bellard
@item COMn
552 0bab00f3 bellard
[Windows only] Use host serial port @var{n}
553 951f1351 bellard
@item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
554 951f1351 bellard
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 specifed @var{src_port} a random port is automatically chosen.
555 951f1351 bellard
556 951f1351 bellard
If you just want a simple readonly console you can use @code{netcat} or
557 951f1351 bellard
@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
558 951f1351 bellard
@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
559 951f1351 bellard
will appear in the netconsole session.
560 0bab00f3 bellard
561 0bab00f3 bellard
If you plan to send characters back via netconsole or you want to stop
562 0bab00f3 bellard
and start qemu a lot of times, you should have qemu use the same
563 0bab00f3 bellard
source port each time by using something like @code{-serial
564 951f1351 bellard
udp::4555@@:4556} to qemu. Another approach is to use a patched
565 0bab00f3 bellard
version of netcat which can listen to a TCP port and send and receive
566 0bab00f3 bellard
characters via udp.  If you have a patched version of netcat which
567 0bab00f3 bellard
activates telnet remote echo and single char transfer, then you can
568 0bab00f3 bellard
use the following options to step up a netcat redirector to allow
569 0bab00f3 bellard
telnet on port 5555 to access the qemu port.
570 0bab00f3 bellard
@table @code
571 951f1351 bellard
@item Qemu Options:
572 951f1351 bellard
-serial udp::4555@@:4556
573 951f1351 bellard
@item netcat options:
574 951f1351 bellard
-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
575 951f1351 bellard
@item telnet options:
576 951f1351 bellard
localhost 5555
577 951f1351 bellard
@end table
578 951f1351 bellard
579 951f1351 bellard
580 f7499989 pbrook
@item tcp:[host]:port[,server][,nowait][,nodelay]
581 951f1351 bellard
The TCP Net Console has two modes of operation.  It can send the serial
582 951f1351 bellard
I/O to a location or wait for a connection from a location.  By default
583 951f1351 bellard
the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
584 f542086d bellard
the @var{server} option QEMU will wait for a client socket application
585 f542086d bellard
to connect to the port before continuing, unless the @code{nowait}
586 f7499989 pbrook
option was specified.  The @code{nodelay} option disables the Nagle buffering
587 f7499989 pbrook
algoritm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
588 951f1351 bellard
one TCP connection at a time is accepted. You can use @code{telnet} to
589 951f1351 bellard
connect to the corresponding character device.
590 951f1351 bellard
@table @code
591 951f1351 bellard
@item Example to send tcp console to 192.168.0.2 port 4444
592 951f1351 bellard
-serial tcp:192.168.0.2:4444
593 951f1351 bellard
@item Example to listen and wait on port 4444 for connection
594 951f1351 bellard
-serial tcp::4444,server
595 951f1351 bellard
@item Example to not wait and listen on ip 192.168.0.100 port 4444
596 951f1351 bellard
-serial tcp:192.168.0.100:4444,server,nowait
597 a0a821a4 bellard
@end table
598 a0a821a4 bellard
599 f7499989 pbrook
@item telnet:host:port[,server][,nowait][,nodelay]
600 951f1351 bellard
The telnet protocol is used instead of raw tcp sockets.  The options
601 951f1351 bellard
work the same as if you had specified @code{-serial tcp}.  The
602 951f1351 bellard
difference is that the port acts like a telnet server or client using
603 951f1351 bellard
telnet option negotiation.  This will also allow you to send the
604 951f1351 bellard
MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
605 951f1351 bellard
sequence.  Typically in unix telnet you do it with Control-] and then
606 951f1351 bellard
type "send break" followed by pressing the enter key.
607 0bab00f3 bellard
608 ffd843bc ths
@item unix:path[,server][,nowait]
609 ffd843bc ths
A unix domain socket is used instead of a tcp socket.  The option works the
610 ffd843bc ths
same as if you had specified @code{-serial tcp} except the unix domain socket
611 ffd843bc ths
@var{path} is used for connections.
612 ffd843bc ths
613 0bab00f3 bellard
@end table
614 05d5818c bellard
615 e57a8c0e bellard
@item -parallel dev
616 e57a8c0e bellard
Redirect the virtual parallel port to host device @var{dev} (same
617 e57a8c0e bellard
devices as the serial port). On Linux hosts, @file{/dev/parportN} can
618 e57a8c0e bellard
be used to use hardware devices connected on the corresponding host
619 e57a8c0e bellard
parallel port.
620 e57a8c0e bellard
621 e57a8c0e bellard
This option can be used several times to simulate up to 3 parallel
622 e57a8c0e bellard
ports.
623 e57a8c0e bellard
624 c03b0f0f bellard
Use @code{-parallel none} to disable all parallel ports.
625 c03b0f0f bellard
626 a0a821a4 bellard
@item -monitor dev
627 a0a821a4 bellard
Redirect the monitor to host device @var{dev} (same devices as the
628 a0a821a4 bellard
serial port).
629 a0a821a4 bellard
The default device is @code{vc} in graphical mode and @code{stdio} in
630 a0a821a4 bellard
non graphical mode.
631 a0a821a4 bellard
632 ec410fc9 bellard
@item -s
633 debc7065 bellard
Wait gdb connection to port 1234 (@pxref{gdb_usage}). 
634 ec410fc9 bellard
@item -p port
635 4046d913 pbrook
Change gdb connection port.  @var{port} can be either a decimal number
636 4046d913 pbrook
to specify a TCP port, or a host device (same devices as the serial port).
637 52c00a5f bellard
@item -S
638 52c00a5f bellard
Do not start CPU at startup (you must type 'c' in the monitor).
639 ec410fc9 bellard
@item -d             
640 9d4520d0 bellard
Output log in /tmp/qemu.log
641 46d4767d bellard
@item -hdachs c,h,s,[,t]
642 46d4767d bellard
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
643 46d4767d bellard
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
644 46d4767d bellard
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
645 46d4767d bellard
all thoses parameters. This option is useful for old MS-DOS disk
646 46d4767d bellard
images.
647 7c3fc84d bellard
648 87b47350 bellard
@item -L path
649 87b47350 bellard
Set the directory for the BIOS, VGA BIOS and keymaps.
650 87b47350 bellard
651 15a34c63 bellard
@item -std-vga
652 15a34c63 bellard
Simulate a standard VGA card with Bochs VBE extensions (default is
653 3cb0853a bellard
Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
654 3cb0853a bellard
VBE extensions (e.g. Windows XP) and if you want to use high
655 3cb0853a bellard
resolution modes (>= 1280x1024x16) then you should use this option.
656 3cb0853a bellard
657 3c656346 bellard
@item -no-acpi
658 3c656346 bellard
Disable ACPI (Advanced Configuration and Power Interface) support. Use
659 3c656346 bellard
it if your guest OS complains about ACPI problems (PC target machine
660 3c656346 bellard
only).
661 3c656346 bellard
662 d1beab82 bellard
@item -no-reboot
663 d1beab82 bellard
Exit instead of rebooting.
664 d1beab82 bellard
665 d63d307f bellard
@item -loadvm file
666 d63d307f bellard
Start right away with a saved state (@code{loadvm} in monitor)
667 8e71621f pbrook
668 8e71621f pbrook
@item -semihosting
669 8e71621f pbrook
Enable "Angel" semihosting interface (ARM target machines only).
670 8e71621f pbrook
Note that this allows guest direct access to the host filesystem,
671 8e71621f pbrook
so should only be used with trusted guest OS.
672 ec410fc9 bellard
@end table
673 ec410fc9 bellard
674 3e11db9a bellard
@c man end
675 3e11db9a bellard
676 debc7065 bellard
@node pcsys_keys
677 3e11db9a bellard
@section Keys
678 3e11db9a bellard
679 3e11db9a bellard
@c man begin OPTIONS
680 3e11db9a bellard
681 a1b74fe8 bellard
During the graphical emulation, you can use the following keys:
682 a1b74fe8 bellard
@table @key
683 f9859310 bellard
@item Ctrl-Alt-f
684 a1b74fe8 bellard
Toggle full screen
685 a0a821a4 bellard
686 f9859310 bellard
@item Ctrl-Alt-n
687 a0a821a4 bellard
Switch to virtual console 'n'. Standard console mappings are:
688 a0a821a4 bellard
@table @emph
689 a0a821a4 bellard
@item 1
690 a0a821a4 bellard
Target system display
691 a0a821a4 bellard
@item 2
692 a0a821a4 bellard
Monitor
693 a0a821a4 bellard
@item 3
694 a0a821a4 bellard
Serial port
695 a1b74fe8 bellard
@end table
696 a1b74fe8 bellard
697 f9859310 bellard
@item Ctrl-Alt
698 a0a821a4 bellard
Toggle mouse and keyboard grab.
699 a0a821a4 bellard
@end table
700 a0a821a4 bellard
701 3e11db9a bellard
In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
702 3e11db9a bellard
@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
703 3e11db9a bellard
704 a0a821a4 bellard
During emulation, if you are using the @option{-nographic} option, use
705 a0a821a4 bellard
@key{Ctrl-a h} to get terminal commands:
706 ec410fc9 bellard
707 ec410fc9 bellard
@table @key
708 a1b74fe8 bellard
@item Ctrl-a h
709 ec410fc9 bellard
Print this help
710 a1b74fe8 bellard
@item Ctrl-a x    
711 366dfc52 ths
Exit emulator
712 a1b74fe8 bellard
@item Ctrl-a s    
713 1f47a922 bellard
Save disk data back to file (if -snapshot)
714 a1b74fe8 bellard
@item Ctrl-a b
715 1f673135 bellard
Send break (magic sysrq in Linux)
716 a1b74fe8 bellard
@item Ctrl-a c
717 1f673135 bellard
Switch between console and monitor
718 a1b74fe8 bellard
@item Ctrl-a Ctrl-a
719 a1b74fe8 bellard
Send Ctrl-a
720 ec410fc9 bellard
@end table
721 0806e3f6 bellard
@c man end
722 0806e3f6 bellard
723 0806e3f6 bellard
@ignore
724 0806e3f6 bellard
725 1f673135 bellard
@c man begin SEEALSO
726 1f673135 bellard
The HTML documentation of QEMU for more precise information and Linux
727 1f673135 bellard
user mode emulator invocation.
728 1f673135 bellard
@c man end
729 1f673135 bellard
730 1f673135 bellard
@c man begin AUTHOR
731 1f673135 bellard
Fabrice Bellard
732 1f673135 bellard
@c man end
733 1f673135 bellard
734 1f673135 bellard
@end ignore
735 1f673135 bellard
736 debc7065 bellard
@node pcsys_monitor
737 1f673135 bellard
@section QEMU Monitor
738 1f673135 bellard
739 1f673135 bellard
The QEMU monitor is used to give complex commands to the QEMU
740 1f673135 bellard
emulator. You can use it to:
741 1f673135 bellard
742 1f673135 bellard
@itemize @minus
743 1f673135 bellard
744 1f673135 bellard
@item
745 1f673135 bellard
Remove or insert removable medias images
746 1f673135 bellard
(such as CD-ROM or floppies)
747 1f673135 bellard
748 1f673135 bellard
@item 
749 1f673135 bellard
Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
750 1f673135 bellard
from a disk file.
751 1f673135 bellard
752 1f673135 bellard
@item Inspect the VM state without an external debugger.
753 1f673135 bellard
754 1f673135 bellard
@end itemize
755 1f673135 bellard
756 1f673135 bellard
@subsection Commands
757 1f673135 bellard
758 1f673135 bellard
The following commands are available:
759 1f673135 bellard
760 1f673135 bellard
@table @option
761 1f673135 bellard
762 1f673135 bellard
@item help or ? [cmd]
763 1f673135 bellard
Show the help for all commands or just for command @var{cmd}.
764 1f673135 bellard
765 1f673135 bellard
@item commit  
766 1f673135 bellard
Commit changes to the disk images (if -snapshot is used)
767 1f673135 bellard
768 1f673135 bellard
@item info subcommand 
769 1f673135 bellard
show various information about the system state
770 1f673135 bellard
771 1f673135 bellard
@table @option
772 1f673135 bellard
@item info network
773 41d03949 bellard
show the various VLANs and the associated devices
774 1f673135 bellard
@item info block
775 1f673135 bellard
show the block devices
776 1f673135 bellard
@item info registers
777 1f673135 bellard
show the cpu registers
778 1f673135 bellard
@item info history
779 1f673135 bellard
show the command line history
780 b389dbfb bellard
@item info pci
781 b389dbfb bellard
show emulated PCI device
782 b389dbfb bellard
@item info usb
783 b389dbfb bellard
show USB devices plugged on the virtual USB hub
784 b389dbfb bellard
@item info usbhost
785 b389dbfb bellard
show all USB host devices
786 a3c25997 bellard
@item info capture
787 a3c25997 bellard
show information about active capturing
788 13a2e80f bellard
@item info snapshots
789 13a2e80f bellard
show list of VM snapshots
790 455204eb ths
@item info mice
791 455204eb ths
show which guest mouse is receiving events
792 1f673135 bellard
@end table
793 1f673135 bellard
794 1f673135 bellard
@item q or quit
795 1f673135 bellard
Quit the emulator.
796 1f673135 bellard
797 1f673135 bellard
@item eject [-f] device
798 1f673135 bellard
Eject a removable media (use -f to force it).
799 1f673135 bellard
800 1f673135 bellard
@item change device filename
801 1f673135 bellard
Change a removable media.
802 1f673135 bellard
803 1f673135 bellard
@item screendump filename
804 1f673135 bellard
Save screen into PPM image @var{filename}.
805 1f673135 bellard
806 455204eb ths
@item mouse_move dx dy [dz]
807 455204eb ths
Move the active mouse to the specified coordinates @var{dx} @var{dy}
808 455204eb ths
with optional scroll axis @var{dz}.
809 455204eb ths
810 455204eb ths
@item mouse_button val
811 455204eb ths
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
812 455204eb ths
813 455204eb ths
@item mouse_set index
814 455204eb ths
Set which mouse device receives events at given @var{index}, index
815 455204eb ths
can be obtained with
816 455204eb ths
@example
817 455204eb ths
info mice
818 455204eb ths
@end example
819 455204eb ths
820 a3c25997 bellard
@item wavcapture filename [frequency [bits [channels]]]
821 a3c25997 bellard
Capture audio into @var{filename}. Using sample rate @var{frequency}
822 a3c25997 bellard
bits per sample @var{bits} and number of channels @var{channels}.
823 a3c25997 bellard
824 a3c25997 bellard
Defaults:
825 a3c25997 bellard
@itemize @minus
826 a3c25997 bellard
@item Sample rate = 44100 Hz - CD quality
827 a3c25997 bellard
@item Bits = 16
828 a3c25997 bellard
@item Number of channels = 2 - Stereo
829 a3c25997 bellard
@end itemize
830 a3c25997 bellard
831 a3c25997 bellard
@item stopcapture index
832 a3c25997 bellard
Stop capture with a given @var{index}, index can be obtained with
833 a3c25997 bellard
@example
834 a3c25997 bellard
info capture
835 a3c25997 bellard
@end example
836 a3c25997 bellard
837 1f673135 bellard
@item log item1[,...]
838 1f673135 bellard
Activate logging of the specified items to @file{/tmp/qemu.log}.
839 1f673135 bellard
840 13a2e80f bellard
@item savevm [tag|id]
841 13a2e80f bellard
Create a snapshot of the whole virtual machine. If @var{tag} is
842 13a2e80f bellard
provided, it is used as human readable identifier. If there is already
843 13a2e80f bellard
a snapshot with the same tag or ID, it is replaced. More info at
844 13a2e80f bellard
@ref{vm_snapshots}.
845 1f673135 bellard
846 13a2e80f bellard
@item loadvm tag|id
847 13a2e80f bellard
Set the whole virtual machine to the snapshot identified by the tag
848 13a2e80f bellard
@var{tag} or the unique snapshot ID @var{id}.
849 13a2e80f bellard
850 13a2e80f bellard
@item delvm tag|id
851 13a2e80f bellard
Delete the snapshot identified by @var{tag} or @var{id}.
852 1f673135 bellard
853 1f673135 bellard
@item stop
854 1f673135 bellard
Stop emulation.
855 1f673135 bellard
856 1f673135 bellard
@item c or cont
857 1f673135 bellard
Resume emulation.
858 1f673135 bellard
859 1f673135 bellard
@item gdbserver [port]
860 1f673135 bellard
Start gdbserver session (default port=1234)
861 1f673135 bellard
862 1f673135 bellard
@item x/fmt addr
863 1f673135 bellard
Virtual memory dump starting at @var{addr}.
864 1f673135 bellard
865 1f673135 bellard
@item xp /fmt addr
866 1f673135 bellard
Physical memory dump starting at @var{addr}.
867 1f673135 bellard
868 1f673135 bellard
@var{fmt} is a format which tells the command how to format the
869 1f673135 bellard
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
870 1f673135 bellard
871 1f673135 bellard
@table @var
872 1f673135 bellard
@item count 
873 1f673135 bellard
is the number of items to be dumped.
874 1f673135 bellard
875 1f673135 bellard
@item format
876 1f673135 bellard
can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
877 1f673135 bellard
c (char) or i (asm instruction).
878 1f673135 bellard
879 1f673135 bellard
@item size
880 52c00a5f bellard
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
881 52c00a5f bellard
@code{h} or @code{w} can be specified with the @code{i} format to
882 52c00a5f bellard
respectively select 16 or 32 bit code instruction size.
883 1f673135 bellard
884 1f673135 bellard
@end table
885 1f673135 bellard
886 1f673135 bellard
Examples: 
887 1f673135 bellard
@itemize
888 1f673135 bellard
@item
889 1f673135 bellard
Dump 10 instructions at the current instruction pointer:
890 1f673135 bellard
@example 
891 1f673135 bellard
(qemu) x/10i $eip
892 1f673135 bellard
0x90107063:  ret
893 1f673135 bellard
0x90107064:  sti
894 1f673135 bellard
0x90107065:  lea    0x0(%esi,1),%esi
895 1f673135 bellard
0x90107069:  lea    0x0(%edi,1),%edi
896 1f673135 bellard
0x90107070:  ret
897 1f673135 bellard
0x90107071:  jmp    0x90107080
898 1f673135 bellard
0x90107073:  nop
899 1f673135 bellard
0x90107074:  nop
900 1f673135 bellard
0x90107075:  nop
901 1f673135 bellard
0x90107076:  nop
902 1f673135 bellard
@end example
903 1f673135 bellard
904 1f673135 bellard
@item
905 1f673135 bellard
Dump 80 16 bit values at the start of the video memory.
906 debc7065 bellard
@smallexample 
907 1f673135 bellard
(qemu) xp/80hx 0xb8000
908 1f673135 bellard
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
909 1f673135 bellard
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
910 1f673135 bellard
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
911 1f673135 bellard
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
912 1f673135 bellard
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
913 1f673135 bellard
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
914 1f673135 bellard
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
915 1f673135 bellard
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
916 1f673135 bellard
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
917 1f673135 bellard
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
918 debc7065 bellard
@end smallexample
919 1f673135 bellard
@end itemize
920 1f673135 bellard
921 1f673135 bellard
@item p or print/fmt expr
922 1f673135 bellard
923 1f673135 bellard
Print expression value. Only the @var{format} part of @var{fmt} is
924 1f673135 bellard
used.
925 0806e3f6 bellard
926 a3a91a35 bellard
@item sendkey keys
927 a3a91a35 bellard
928 a3a91a35 bellard
Send @var{keys} to the emulator. Use @code{-} to press several keys
929 a3a91a35 bellard
simultaneously. Example:
930 a3a91a35 bellard
@example
931 a3a91a35 bellard
sendkey ctrl-alt-f1
932 a3a91a35 bellard
@end example
933 a3a91a35 bellard
934 a3a91a35 bellard
This command is useful to send keys that your graphical user interface
935 a3a91a35 bellard
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
936 a3a91a35 bellard
937 15a34c63 bellard
@item system_reset
938 15a34c63 bellard
939 15a34c63 bellard
Reset the system.
940 15a34c63 bellard
941 b389dbfb bellard
@item usb_add devname
942 b389dbfb bellard
943 0aff66b5 pbrook
Add the USB device @var{devname}.  For details of available devices see
944 0aff66b5 pbrook
@ref{usb_devices}
945 b389dbfb bellard
946 b389dbfb bellard
@item usb_del devname
947 b389dbfb bellard
948 b389dbfb bellard
Remove the USB device @var{devname} from the QEMU virtual USB
949 b389dbfb bellard
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
950 b389dbfb bellard
command @code{info usb} to see the devices you can remove.
951 b389dbfb bellard
952 1f673135 bellard
@end table
953 0806e3f6 bellard
954 1f673135 bellard
@subsection Integer expressions
955 1f673135 bellard
956 1f673135 bellard
The monitor understands integers expressions for every integer
957 1f673135 bellard
argument. You can use register names to get the value of specifics
958 1f673135 bellard
CPU registers by prefixing them with @emph{$}.
959 ec410fc9 bellard
960 1f47a922 bellard
@node disk_images
961 1f47a922 bellard
@section Disk Images
962 1f47a922 bellard
963 acd935ef bellard
Since version 0.6.1, QEMU supports many disk image formats, including
964 acd935ef bellard
growable disk images (their size increase as non empty sectors are
965 13a2e80f bellard
written), compressed and encrypted disk images. Version 0.8.3 added
966 13a2e80f bellard
the new qcow2 disk image format which is essential to support VM
967 13a2e80f bellard
snapshots.
968 1f47a922 bellard
969 debc7065 bellard
@menu
970 debc7065 bellard
* disk_images_quickstart::    Quick start for disk image creation
971 debc7065 bellard
* disk_images_snapshot_mode:: Snapshot mode
972 13a2e80f bellard
* vm_snapshots::              VM snapshots
973 debc7065 bellard
* qemu_img_invocation::       qemu-img Invocation
974 19cb3738 bellard
* host_drives::               Using host drives
975 debc7065 bellard
* disk_images_fat_images::    Virtual FAT disk images
976 debc7065 bellard
@end menu
977 debc7065 bellard
978 debc7065 bellard
@node disk_images_quickstart
979 acd935ef bellard
@subsection Quick start for disk image creation
980 acd935ef bellard
981 acd935ef bellard
You can create a disk image with the command:
982 1f47a922 bellard
@example
983 acd935ef bellard
qemu-img create myimage.img mysize
984 1f47a922 bellard
@end example
985 acd935ef bellard
where @var{myimage.img} is the disk image filename and @var{mysize} is its
986 acd935ef bellard
size in kilobytes. You can add an @code{M} suffix to give the size in
987 acd935ef bellard
megabytes and a @code{G} suffix for gigabytes.
988 acd935ef bellard
989 debc7065 bellard
See @ref{qemu_img_invocation} for more information.
990 1f47a922 bellard
991 debc7065 bellard
@node disk_images_snapshot_mode
992 1f47a922 bellard
@subsection Snapshot mode
993 1f47a922 bellard
994 1f47a922 bellard
If you use the option @option{-snapshot}, all disk images are
995 1f47a922 bellard
considered as read only. When sectors in written, they are written in
996 1f47a922 bellard
a temporary file created in @file{/tmp}. You can however force the
997 acd935ef bellard
write back to the raw disk images by using the @code{commit} monitor
998 acd935ef bellard
command (or @key{C-a s} in the serial console).
999 1f47a922 bellard
1000 13a2e80f bellard
@node vm_snapshots
1001 13a2e80f bellard
@subsection VM snapshots
1002 13a2e80f bellard
1003 13a2e80f bellard
VM snapshots are snapshots of the complete virtual machine including
1004 13a2e80f bellard
CPU state, RAM, device state and the content of all the writable
1005 13a2e80f bellard
disks. In order to use VM snapshots, you must have at least one non
1006 13a2e80f bellard
removable and writable block device using the @code{qcow2} disk image
1007 13a2e80f bellard
format. Normally this device is the first virtual hard drive.
1008 13a2e80f bellard
1009 13a2e80f bellard
Use the monitor command @code{savevm} to create a new VM snapshot or
1010 13a2e80f bellard
replace an existing one. A human readable name can be assigned to each
1011 19d36792 bellard
snapshot in addition to its numerical ID.
1012 13a2e80f bellard
1013 13a2e80f bellard
Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1014 13a2e80f bellard
a VM snapshot. @code{info snapshots} lists the available snapshots
1015 13a2e80f bellard
with their associated information:
1016 13a2e80f bellard
1017 13a2e80f bellard
@example
1018 13a2e80f bellard
(qemu) info snapshots
1019 13a2e80f bellard
Snapshot devices: hda
1020 13a2e80f bellard
Snapshot list (from hda):
1021 13a2e80f bellard
ID        TAG                 VM SIZE                DATE       VM CLOCK
1022 13a2e80f bellard
1         start                   41M 2006-08-06 12:38:02   00:00:14.954
1023 13a2e80f bellard
2                                 40M 2006-08-06 12:43:29   00:00:18.633
1024 13a2e80f bellard
3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
1025 13a2e80f bellard
@end example
1026 13a2e80f bellard
1027 13a2e80f bellard
A VM snapshot is made of a VM state info (its size is shown in
1028 13a2e80f bellard
@code{info snapshots}) and a snapshot of every writable disk image.
1029 13a2e80f bellard
The VM state info is stored in the first @code{qcow2} non removable
1030 13a2e80f bellard
and writable block device. The disk image snapshots are stored in
1031 13a2e80f bellard
every disk image. The size of a snapshot in a disk image is difficult
1032 13a2e80f bellard
to evaluate and is not shown by @code{info snapshots} because the
1033 13a2e80f bellard
associated disk sectors are shared among all the snapshots to save
1034 19d36792 bellard
disk space (otherwise each snapshot would need a full copy of all the
1035 19d36792 bellard
disk images).
1036 13a2e80f bellard
1037 13a2e80f bellard
When using the (unrelated) @code{-snapshot} option
1038 13a2e80f bellard
(@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1039 13a2e80f bellard
but they are deleted as soon as you exit QEMU.
1040 13a2e80f bellard
1041 13a2e80f bellard
VM snapshots currently have the following known limitations:
1042 13a2e80f bellard
@itemize
1043 13a2e80f bellard
@item 
1044 13a2e80f bellard
They cannot cope with removable devices if they are removed or
1045 13a2e80f bellard
inserted after a snapshot is done.
1046 13a2e80f bellard
@item 
1047 13a2e80f bellard
A few device drivers still have incomplete snapshot support so their
1048 13a2e80f bellard
state is not saved or restored properly (in particular USB).
1049 13a2e80f bellard
@end itemize
1050 13a2e80f bellard
1051 acd935ef bellard
@node qemu_img_invocation
1052 acd935ef bellard
@subsection @code{qemu-img} Invocation
1053 1f47a922 bellard
1054 acd935ef bellard
@include qemu-img.texi
1055 05efe46e bellard
1056 19cb3738 bellard
@node host_drives
1057 19cb3738 bellard
@subsection Using host drives
1058 19cb3738 bellard
1059 19cb3738 bellard
In addition to disk image files, QEMU can directly access host
1060 19cb3738 bellard
devices. We describe here the usage for QEMU version >= 0.8.3.
1061 19cb3738 bellard
1062 19cb3738 bellard
@subsubsection Linux
1063 19cb3738 bellard
1064 19cb3738 bellard
On Linux, you can directly use the host device filename instead of a
1065 19cb3738 bellard
disk image filename provided you have enough proviledge to access
1066 19cb3738 bellard
it. For example, use @file{/dev/cdrom} to access to the CDROM or
1067 19cb3738 bellard
@file{/dev/fd0} for the floppy.
1068 19cb3738 bellard
1069 f542086d bellard
@table @code
1070 19cb3738 bellard
@item CD
1071 19cb3738 bellard
You can specify a CDROM device even if no CDROM is loaded. QEMU has
1072 19cb3738 bellard
specific code to detect CDROM insertion or removal. CDROM ejection by
1073 19cb3738 bellard
the guest OS is supported. Currently only data CDs are supported.
1074 19cb3738 bellard
@item Floppy
1075 19cb3738 bellard
You can specify a floppy device even if no floppy is loaded. Floppy
1076 19cb3738 bellard
removal is currently not detected accurately (if you change floppy
1077 19cb3738 bellard
without doing floppy access while the floppy is not loaded, the guest
1078 19cb3738 bellard
OS will think that the same floppy is loaded).
1079 19cb3738 bellard
@item Hard disks
1080 19cb3738 bellard
Hard disks can be used. Normally you must specify the whole disk
1081 19cb3738 bellard
(@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1082 19cb3738 bellard
see it as a partitioned disk. WARNING: unless you know what you do, it
1083 19cb3738 bellard
is better to only make READ-ONLY accesses to the hard disk otherwise
1084 19cb3738 bellard
you may corrupt your host data (use the @option{-snapshot} command
1085 19cb3738 bellard
line option or modify the device permissions accordingly).
1086 19cb3738 bellard
@end table
1087 19cb3738 bellard
1088 19cb3738 bellard
@subsubsection Windows
1089 19cb3738 bellard
1090 01781963 bellard
@table @code
1091 01781963 bellard
@item CD
1092 01781963 bellard
The prefered syntax is the drive letter (e.g. @file{d:}). The
1093 01781963 bellard
alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1094 01781963 bellard
supported as an alias to the first CDROM drive.
1095 19cb3738 bellard
1096 19cb3738 bellard
Currently there is no specific code to handle removable medias, so it
1097 19cb3738 bellard
is better to use the @code{change} or @code{eject} monitor commands to
1098 19cb3738 bellard
change or eject media.
1099 01781963 bellard
@item Hard disks
1100 01781963 bellard
Hard disks can be used with the syntax: @file{\\.\PhysicalDriveN}
1101 01781963 bellard
where @var{N} is the drive number (0 is the first hard disk).
1102 01781963 bellard
1103 01781963 bellard
WARNING: unless you know what you do, it is better to only make
1104 01781963 bellard
READ-ONLY accesses to the hard disk otherwise you may corrupt your
1105 01781963 bellard
host data (use the @option{-snapshot} command line so that the
1106 01781963 bellard
modifications are written in a temporary file).
1107 01781963 bellard
@end table
1108 01781963 bellard
1109 19cb3738 bellard
1110 19cb3738 bellard
@subsubsection Mac OS X
1111 19cb3738 bellard
1112 19cb3738 bellard
@file{/dev/cdrom} is an alias to the first CDROM. 
1113 19cb3738 bellard
1114 19cb3738 bellard
Currently there is no specific code to handle removable medias, so it
1115 19cb3738 bellard
is better to use the @code{change} or @code{eject} monitor commands to
1116 19cb3738 bellard
change or eject media.
1117 19cb3738 bellard
1118 debc7065 bellard
@node disk_images_fat_images
1119 2c6cadd4 bellard
@subsection Virtual FAT disk images
1120 2c6cadd4 bellard
1121 2c6cadd4 bellard
QEMU can automatically create a virtual FAT disk image from a
1122 2c6cadd4 bellard
directory tree. In order to use it, just type:
1123 2c6cadd4 bellard
1124 2c6cadd4 bellard
@example 
1125 2c6cadd4 bellard
qemu linux.img -hdb fat:/my_directory
1126 2c6cadd4 bellard
@end example
1127 2c6cadd4 bellard
1128 2c6cadd4 bellard
Then you access access to all the files in the @file{/my_directory}
1129 2c6cadd4 bellard
directory without having to copy them in a disk image or to export
1130 2c6cadd4 bellard
them via SAMBA or NFS. The default access is @emph{read-only}.
1131 2c6cadd4 bellard
1132 2c6cadd4 bellard
Floppies can be emulated with the @code{:floppy:} option:
1133 2c6cadd4 bellard
1134 2c6cadd4 bellard
@example 
1135 2c6cadd4 bellard
qemu linux.img -fda fat:floppy:/my_directory
1136 2c6cadd4 bellard
@end example
1137 2c6cadd4 bellard
1138 2c6cadd4 bellard
A read/write support is available for testing (beta stage) with the
1139 2c6cadd4 bellard
@code{:rw:} option:
1140 2c6cadd4 bellard
1141 2c6cadd4 bellard
@example 
1142 2c6cadd4 bellard
qemu linux.img -fda fat:floppy:rw:/my_directory
1143 2c6cadd4 bellard
@end example
1144 2c6cadd4 bellard
1145 2c6cadd4 bellard
What you should @emph{never} do:
1146 2c6cadd4 bellard
@itemize
1147 2c6cadd4 bellard
@item use non-ASCII filenames ;
1148 2c6cadd4 bellard
@item use "-snapshot" together with ":rw:" ;
1149 85b2c688 bellard
@item expect it to work when loadvm'ing ;
1150 85b2c688 bellard
@item write to the FAT directory on the host system while accessing it with the guest system.
1151 2c6cadd4 bellard
@end itemize
1152 2c6cadd4 bellard
1153 debc7065 bellard
@node pcsys_network
1154 9d4fb82e bellard
@section Network emulation
1155 9d4fb82e bellard
1156 41d03949 bellard
QEMU can simulate several networks cards (NE2000 boards on the PC
1157 41d03949 bellard
target) and can connect them to an arbitrary number of Virtual Local
1158 41d03949 bellard
Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1159 41d03949 bellard
VLAN. VLAN can be connected between separate instances of QEMU to
1160 41d03949 bellard
simulate large networks. For simpler usage, a non priviledged user mode
1161 41d03949 bellard
network stack can replace the TAP device to have a basic network
1162 41d03949 bellard
connection.
1163 41d03949 bellard
1164 41d03949 bellard
@subsection VLANs
1165 9d4fb82e bellard
1166 41d03949 bellard
QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1167 41d03949 bellard
connection between several network devices. These devices can be for
1168 41d03949 bellard
example QEMU virtual Ethernet cards or virtual Host ethernet devices
1169 41d03949 bellard
(TAP devices).
1170 9d4fb82e bellard
1171 41d03949 bellard
@subsection Using TAP network interfaces
1172 41d03949 bellard
1173 41d03949 bellard
This is the standard way to connect QEMU to a real network. QEMU adds
1174 41d03949 bellard
a virtual network device on your host (called @code{tapN}), and you
1175 41d03949 bellard
can then configure it as if it was a real ethernet card.
1176 9d4fb82e bellard
1177 8f40c388 bellard
@subsubsection Linux host
1178 8f40c388 bellard
1179 9d4fb82e bellard
As an example, you can download the @file{linux-test-xxx.tar.gz}
1180 9d4fb82e bellard
archive and copy the script @file{qemu-ifup} in @file{/etc} and
1181 9d4fb82e bellard
configure properly @code{sudo} so that the command @code{ifconfig}
1182 9d4fb82e bellard
contained in @file{qemu-ifup} can be executed as root. You must verify
1183 41d03949 bellard
that your host kernel supports the TAP network interfaces: the
1184 9d4fb82e bellard
device @file{/dev/net/tun} must be present.
1185 9d4fb82e bellard
1186 ee0f4751 bellard
See @ref{sec_invocation} to have examples of command lines using the
1187 ee0f4751 bellard
TAP network interfaces.
1188 9d4fb82e bellard
1189 8f40c388 bellard
@subsubsection Windows host
1190 8f40c388 bellard
1191 8f40c388 bellard
There is a virtual ethernet driver for Windows 2000/XP systems, called
1192 8f40c388 bellard
TAP-Win32. But it is not included in standard QEMU for Windows,
1193 8f40c388 bellard
so you will need to get it separately. It is part of OpenVPN package,
1194 8f40c388 bellard
so download OpenVPN from : @url{http://openvpn.net/}.
1195 8f40c388 bellard
1196 9d4fb82e bellard
@subsection Using the user mode network stack
1197 9d4fb82e bellard
1198 41d03949 bellard
By using the option @option{-net user} (default configuration if no
1199 41d03949 bellard
@option{-net} option is specified), QEMU uses a completely user mode
1200 41d03949 bellard
network stack (you don't need root priviledge to use the virtual
1201 41d03949 bellard
network). The virtual network configuration is the following:
1202 9d4fb82e bellard
1203 9d4fb82e bellard
@example
1204 9d4fb82e bellard
1205 41d03949 bellard
         QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1206 41d03949 bellard
                           |          (10.0.2.2)
1207 9d4fb82e bellard
                           |
1208 2518bd0d bellard
                           ---->  DNS server (10.0.2.3)
1209 2518bd0d bellard
                           |     
1210 2518bd0d bellard
                           ---->  SMB server (10.0.2.4)
1211 9d4fb82e bellard
@end example
1212 9d4fb82e bellard
1213 9d4fb82e bellard
The QEMU VM behaves as if it was behind a firewall which blocks all
1214 9d4fb82e bellard
incoming connections. You can use a DHCP client to automatically
1215 41d03949 bellard
configure the network in the QEMU VM. The DHCP server assign addresses
1216 41d03949 bellard
to the hosts starting from 10.0.2.15.
1217 9d4fb82e bellard
1218 9d4fb82e bellard
In order to check that the user mode network is working, you can ping
1219 9d4fb82e bellard
the address 10.0.2.2 and verify that you got an address in the range
1220 9d4fb82e bellard
10.0.2.x from the QEMU virtual DHCP server.
1221 9d4fb82e bellard
1222 b415a407 bellard
Note that @code{ping} is not supported reliably to the internet as it
1223 b415a407 bellard
would require root priviledges. It means you can only ping the local
1224 b415a407 bellard
router (10.0.2.2).
1225 b415a407 bellard
1226 9bf05444 bellard
When using the built-in TFTP server, the router is also the TFTP
1227 9bf05444 bellard
server.
1228 9bf05444 bellard
1229 9bf05444 bellard
When using the @option{-redir} option, TCP or UDP connections can be
1230 9bf05444 bellard
redirected from the host to the guest. It allows for example to
1231 9bf05444 bellard
redirect X11, telnet or SSH connections.
1232 443f1376 bellard
1233 41d03949 bellard
@subsection Connecting VLANs between QEMU instances
1234 41d03949 bellard
1235 41d03949 bellard
Using the @option{-net socket} option, it is possible to make VLANs
1236 41d03949 bellard
that span several QEMU instances. See @ref{sec_invocation} to have a
1237 41d03949 bellard
basic example.
1238 41d03949 bellard
1239 9d4fb82e bellard
@node direct_linux_boot
1240 9d4fb82e bellard
@section Direct Linux Boot
1241 1f673135 bellard
1242 1f673135 bellard
This section explains how to launch a Linux kernel inside QEMU without
1243 1f673135 bellard
having to make a full bootable image. It is very useful for fast Linux
1244 ee0f4751 bellard
kernel testing.
1245 1f673135 bellard
1246 ee0f4751 bellard
The syntax is:
1247 1f673135 bellard
@example
1248 ee0f4751 bellard
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1249 1f673135 bellard
@end example
1250 1f673135 bellard
1251 ee0f4751 bellard
Use @option{-kernel} to provide the Linux kernel image and
1252 ee0f4751 bellard
@option{-append} to give the kernel command line arguments. The
1253 ee0f4751 bellard
@option{-initrd} option can be used to provide an INITRD image.
1254 1f673135 bellard
1255 ee0f4751 bellard
When using the direct Linux boot, a disk image for the first hard disk
1256 ee0f4751 bellard
@file{hda} is required because its boot sector is used to launch the
1257 ee0f4751 bellard
Linux kernel.
1258 1f673135 bellard
1259 ee0f4751 bellard
If you do not need graphical output, you can disable it and redirect
1260 ee0f4751 bellard
the virtual serial port and the QEMU monitor to the console with the
1261 ee0f4751 bellard
@option{-nographic} option. The typical command line is:
1262 1f673135 bellard
@example
1263 ee0f4751 bellard
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1264 ee0f4751 bellard
     -append "root=/dev/hda console=ttyS0" -nographic
1265 1f673135 bellard
@end example
1266 1f673135 bellard
1267 ee0f4751 bellard
Use @key{Ctrl-a c} to switch between the serial console and the
1268 ee0f4751 bellard
monitor (@pxref{pcsys_keys}).
1269 1f673135 bellard
1270 debc7065 bellard
@node pcsys_usb
1271 b389dbfb bellard
@section USB emulation
1272 b389dbfb bellard
1273 0aff66b5 pbrook
QEMU emulates a PCI UHCI USB controller. You can virtually plug
1274 0aff66b5 pbrook
virtual USB devices or real host USB devices (experimental, works only
1275 0aff66b5 pbrook
on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
1276 f542086d bellard
as necessary to connect multiple USB devices.
1277 b389dbfb bellard
1278 0aff66b5 pbrook
@menu
1279 0aff66b5 pbrook
* usb_devices::
1280 0aff66b5 pbrook
* host_usb_devices::
1281 0aff66b5 pbrook
@end menu
1282 0aff66b5 pbrook
@node usb_devices
1283 0aff66b5 pbrook
@subsection Connecting USB devices
1284 b389dbfb bellard
1285 0aff66b5 pbrook
USB devices can be connected with the @option{-usbdevice} commandline option
1286 0aff66b5 pbrook
or the @code{usb_add} monitor command.  Available devices are:
1287 b389dbfb bellard
1288 0aff66b5 pbrook
@table @var
1289 0aff66b5 pbrook
@item @code{mouse}
1290 0aff66b5 pbrook
Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1291 0aff66b5 pbrook
@item @code{tablet}
1292 c6d46c20 bellard
Pointer device that uses absolute coordinates (like a touchscreen).
1293 0aff66b5 pbrook
This means qemu is able to report the mouse position without having
1294 0aff66b5 pbrook
to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1295 0aff66b5 pbrook
@item @code{disk:file}
1296 0aff66b5 pbrook
Mass storage device based on @var{file} (@pxref{disk_images})
1297 0aff66b5 pbrook
@item @code{host:bus.addr}
1298 0aff66b5 pbrook
Pass through the host device identified by @var{bus.addr}
1299 0aff66b5 pbrook
(Linux only)
1300 0aff66b5 pbrook
@item @code{host:vendor_id:product_id}
1301 0aff66b5 pbrook
Pass through the host device identified by @var{vendor_id:product_id}
1302 0aff66b5 pbrook
(Linux only)
1303 0aff66b5 pbrook
@end table
1304 b389dbfb bellard
1305 0aff66b5 pbrook
@node host_usb_devices
1306 b389dbfb bellard
@subsection Using host USB devices on a Linux host
1307 b389dbfb bellard
1308 b389dbfb bellard
WARNING: this is an experimental feature. QEMU will slow down when
1309 b389dbfb bellard
using it. USB devices requiring real time streaming (i.e. USB Video
1310 b389dbfb bellard
Cameras) are not supported yet.
1311 b389dbfb bellard
1312 b389dbfb bellard
@enumerate
1313 b389dbfb bellard
@item If you use an early Linux 2.4 kernel, verify that no Linux driver 
1314 b389dbfb bellard
is actually using the USB device. A simple way to do that is simply to
1315 b389dbfb bellard
disable the corresponding kernel module by renaming it from @file{mydriver.o}
1316 b389dbfb bellard
to @file{mydriver.o.disabled}.
1317 b389dbfb bellard
1318 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:
1319 b389dbfb bellard
@example
1320 b389dbfb bellard
ls /proc/bus/usb
1321 b389dbfb bellard
001  devices  drivers
1322 b389dbfb bellard
@end example
1323 b389dbfb bellard
1324 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:
1325 b389dbfb bellard
@example
1326 b389dbfb bellard
chown -R myuid /proc/bus/usb
1327 b389dbfb bellard
@end example
1328 b389dbfb bellard
1329 b389dbfb bellard
@item Launch QEMU and do in the monitor:
1330 b389dbfb bellard
@example 
1331 b389dbfb bellard
info usbhost
1332 b389dbfb bellard
  Device 1.2, speed 480 Mb/s
1333 b389dbfb bellard
    Class 00: USB device 1234:5678, USB DISK
1334 b389dbfb bellard
@end example
1335 b389dbfb bellard
You should see the list of the devices you can use (Never try to use
1336 b389dbfb bellard
hubs, it won't work).
1337 b389dbfb bellard
1338 b389dbfb bellard
@item Add the device in QEMU by using:
1339 b389dbfb bellard
@example 
1340 b389dbfb bellard
usb_add host:1234:5678
1341 b389dbfb bellard
@end example
1342 b389dbfb bellard
1343 b389dbfb bellard
Normally the guest OS should report that a new USB device is
1344 b389dbfb bellard
plugged. You can use the option @option{-usbdevice} to do the same.
1345 b389dbfb bellard
1346 b389dbfb bellard
@item Now you can try to use the host USB device in QEMU.
1347 b389dbfb bellard
1348 b389dbfb bellard
@end enumerate
1349 b389dbfb bellard
1350 b389dbfb bellard
When relaunching QEMU, you may have to unplug and plug again the USB
1351 b389dbfb bellard
device to make it work again (this is a bug).
1352 b389dbfb bellard
1353 0806e3f6 bellard
@node gdb_usage
1354 da415d54 bellard
@section GDB usage
1355 da415d54 bellard
1356 da415d54 bellard
QEMU has a primitive support to work with gdb, so that you can do
1357 0806e3f6 bellard
'Ctrl-C' while the virtual machine is running and inspect its state.
1358 da415d54 bellard
1359 9d4520d0 bellard
In order to use gdb, launch qemu with the '-s' option. It will wait for a
1360 da415d54 bellard
gdb connection:
1361 da415d54 bellard
@example
1362 debc7065 bellard
> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1363 debc7065 bellard
       -append "root=/dev/hda"
1364 da415d54 bellard
Connected to host network interface: tun0
1365 da415d54 bellard
Waiting gdb connection on port 1234
1366 da415d54 bellard
@end example
1367 da415d54 bellard
1368 da415d54 bellard
Then launch gdb on the 'vmlinux' executable:
1369 da415d54 bellard
@example
1370 da415d54 bellard
> gdb vmlinux
1371 da415d54 bellard
@end example
1372 da415d54 bellard
1373 da415d54 bellard
In gdb, connect to QEMU:
1374 da415d54 bellard
@example
1375 6c9bf893 bellard
(gdb) target remote localhost:1234
1376 da415d54 bellard
@end example
1377 da415d54 bellard
1378 da415d54 bellard
Then you can use gdb normally. For example, type 'c' to launch the kernel:
1379 da415d54 bellard
@example
1380 da415d54 bellard
(gdb) c
1381 da415d54 bellard
@end example
1382 da415d54 bellard
1383 0806e3f6 bellard
Here are some useful tips in order to use gdb on system code:
1384 0806e3f6 bellard
1385 0806e3f6 bellard
@enumerate
1386 0806e3f6 bellard
@item
1387 0806e3f6 bellard
Use @code{info reg} to display all the CPU registers.
1388 0806e3f6 bellard
@item
1389 0806e3f6 bellard
Use @code{x/10i $eip} to display the code at the PC position.
1390 0806e3f6 bellard
@item
1391 0806e3f6 bellard
Use @code{set architecture i8086} to dump 16 bit code. Then use
1392 294e8637 bellard
@code{x/10i $cs*16+$eip} to dump the code at the PC position.
1393 0806e3f6 bellard
@end enumerate
1394 0806e3f6 bellard
1395 debc7065 bellard
@node pcsys_os_specific
1396 1a084f3d bellard
@section Target OS specific information
1397 1a084f3d bellard
1398 1a084f3d bellard
@subsection Linux
1399 1a084f3d bellard
1400 15a34c63 bellard
To have access to SVGA graphic modes under X11, use the @code{vesa} or
1401 15a34c63 bellard
the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1402 15a34c63 bellard
color depth in the guest and the host OS.
1403 1a084f3d bellard
1404 e3371e62 bellard
When using a 2.6 guest Linux kernel, you should add the option
1405 e3371e62 bellard
@code{clock=pit} on the kernel command line because the 2.6 Linux
1406 e3371e62 bellard
kernels make very strict real time clock checks by default that QEMU
1407 e3371e62 bellard
cannot simulate exactly.
1408 e3371e62 bellard
1409 7c3fc84d bellard
When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1410 7c3fc84d bellard
not activated because QEMU is slower with this patch. The QEMU
1411 7c3fc84d bellard
Accelerator Module is also much slower in this case. Earlier Fedora
1412 7c3fc84d bellard
Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
1413 7c3fc84d bellard
patch by default. Newer kernels don't have it.
1414 7c3fc84d bellard
1415 1a084f3d bellard
@subsection Windows
1416 1a084f3d bellard
1417 1a084f3d bellard
If you have a slow host, using Windows 95 is better as it gives the
1418 1a084f3d bellard
best speed. Windows 2000 is also a good choice.
1419 1a084f3d bellard
1420 e3371e62 bellard
@subsubsection SVGA graphic modes support
1421 e3371e62 bellard
1422 e3371e62 bellard
QEMU emulates a Cirrus Logic GD5446 Video
1423 15a34c63 bellard
card. All Windows versions starting from Windows 95 should recognize
1424 15a34c63 bellard
and use this graphic card. For optimal performances, use 16 bit color
1425 15a34c63 bellard
depth in the guest and the host OS.
1426 1a084f3d bellard
1427 3cb0853a bellard
If you are using Windows XP as guest OS and if you want to use high
1428 3cb0853a bellard
resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1429 3cb0853a bellard
1280x1024x16), then you should use the VESA VBE virtual graphic card
1430 3cb0853a bellard
(option @option{-std-vga}).
1431 3cb0853a bellard
1432 e3371e62 bellard
@subsubsection CPU usage reduction
1433 e3371e62 bellard
1434 e3371e62 bellard
Windows 9x does not correctly use the CPU HLT
1435 15a34c63 bellard
instruction. The result is that it takes host CPU cycles even when
1436 15a34c63 bellard
idle. You can install the utility from
1437 15a34c63 bellard
@url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1438 15a34c63 bellard
problem. Note that no such tool is needed for NT, 2000 or XP.
1439 1a084f3d bellard
1440 9d0a8e6f bellard
@subsubsection Windows 2000 disk full problem
1441 e3371e62 bellard
1442 9d0a8e6f bellard
Windows 2000 has a bug which gives a disk full problem during its
1443 9d0a8e6f bellard
installation. When installing it, use the @option{-win2k-hack} QEMU
1444 9d0a8e6f bellard
option to enable a specific workaround. After Windows 2000 is
1445 9d0a8e6f bellard
installed, you no longer need this option (this option slows down the
1446 9d0a8e6f bellard
IDE transfers).
1447 e3371e62 bellard
1448 6cc721cf bellard
@subsubsection Windows 2000 shutdown
1449 6cc721cf bellard
1450 6cc721cf bellard
Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1451 6cc721cf bellard
can. It comes from the fact that Windows 2000 does not automatically
1452 6cc721cf bellard
use the APM driver provided by the BIOS.
1453 6cc721cf bellard
1454 6cc721cf bellard
In order to correct that, do the following (thanks to Struan
1455 6cc721cf bellard
Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1456 6cc721cf bellard
Add/Troubleshoot a device => Add a new device & Next => No, select the
1457 6cc721cf bellard
hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1458 6cc721cf bellard
(again) a few times. Now the driver is installed and Windows 2000 now
1459 6cc721cf bellard
correctly instructs QEMU to shutdown at the appropriate moment. 
1460 6cc721cf bellard
1461 6cc721cf bellard
@subsubsection Share a directory between Unix and Windows
1462 6cc721cf bellard
1463 6cc721cf bellard
See @ref{sec_invocation} about the help of the option @option{-smb}.
1464 6cc721cf bellard
1465 2192c332 bellard
@subsubsection Windows XP security problem
1466 e3371e62 bellard
1467 e3371e62 bellard
Some releases of Windows XP install correctly but give a security
1468 e3371e62 bellard
error when booting:
1469 e3371e62 bellard
@example
1470 e3371e62 bellard
A problem is preventing Windows from accurately checking the
1471 e3371e62 bellard
license for this computer. Error code: 0x800703e6.
1472 e3371e62 bellard
@end example
1473 e3371e62 bellard
1474 2192c332 bellard
The workaround is to install a service pack for XP after a boot in safe
1475 2192c332 bellard
mode. Then reboot, and the problem should go away. Since there is no
1476 2192c332 bellard
network while in safe mode, its recommended to download the full
1477 2192c332 bellard
installation of SP1 or SP2 and transfer that via an ISO or using the
1478 2192c332 bellard
vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1479 e3371e62 bellard
1480 a0a821a4 bellard
@subsection MS-DOS and FreeDOS
1481 a0a821a4 bellard
1482 a0a821a4 bellard
@subsubsection CPU usage reduction
1483 a0a821a4 bellard
1484 a0a821a4 bellard
DOS does not correctly use the CPU HLT instruction. The result is that
1485 a0a821a4 bellard
it takes host CPU cycles even when idle. You can install the utility
1486 a0a821a4 bellard
from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1487 a0a821a4 bellard
problem.
1488 a0a821a4 bellard
1489 debc7065 bellard
@node QEMU System emulator for non PC targets
1490 3f9f3aa1 bellard
@chapter QEMU System emulator for non PC targets
1491 3f9f3aa1 bellard
1492 3f9f3aa1 bellard
QEMU is a generic emulator and it emulates many non PC
1493 3f9f3aa1 bellard
machines. Most of the options are similar to the PC emulator. The
1494 3f9f3aa1 bellard
differences are mentionned in the following sections.
1495 3f9f3aa1 bellard
1496 debc7065 bellard
@menu
1497 debc7065 bellard
* QEMU PowerPC System emulator::
1498 debc7065 bellard
* Sparc32 System emulator invocation::
1499 debc7065 bellard
* Sparc64 System emulator invocation::
1500 debc7065 bellard
* MIPS System emulator invocation::
1501 debc7065 bellard
* ARM System emulator invocation::
1502 debc7065 bellard
@end menu
1503 debc7065 bellard
1504 debc7065 bellard
@node QEMU PowerPC System emulator
1505 3f9f3aa1 bellard
@section QEMU PowerPC System emulator
1506 1a084f3d bellard
1507 15a34c63 bellard
Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1508 15a34c63 bellard
or PowerMac PowerPC system.
1509 1a084f3d bellard
1510 b671f9ed bellard
QEMU emulates the following PowerMac peripherals:
1511 1a084f3d bellard
1512 15a34c63 bellard
@itemize @minus
1513 15a34c63 bellard
@item 
1514 15a34c63 bellard
UniNorth PCI Bridge 
1515 15a34c63 bellard
@item
1516 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1517 15a34c63 bellard
@item 
1518 15a34c63 bellard
2 PMAC IDE interfaces with hard disk and CD-ROM support
1519 15a34c63 bellard
@item 
1520 15a34c63 bellard
NE2000 PCI adapters
1521 15a34c63 bellard
@item
1522 15a34c63 bellard
Non Volatile RAM
1523 15a34c63 bellard
@item
1524 15a34c63 bellard
VIA-CUDA with ADB keyboard and mouse.
1525 1a084f3d bellard
@end itemize
1526 1a084f3d bellard
1527 b671f9ed bellard
QEMU emulates the following PREP peripherals:
1528 52c00a5f bellard
1529 52c00a5f bellard
@itemize @minus
1530 52c00a5f bellard
@item 
1531 15a34c63 bellard
PCI Bridge
1532 15a34c63 bellard
@item
1533 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1534 15a34c63 bellard
@item 
1535 52c00a5f bellard
2 IDE interfaces with hard disk and CD-ROM support
1536 52c00a5f bellard
@item
1537 52c00a5f bellard
Floppy disk
1538 52c00a5f bellard
@item 
1539 15a34c63 bellard
NE2000 network adapters
1540 52c00a5f bellard
@item
1541 52c00a5f bellard
Serial port
1542 52c00a5f bellard
@item
1543 52c00a5f bellard
PREP Non Volatile RAM
1544 15a34c63 bellard
@item
1545 15a34c63 bellard
PC compatible keyboard and mouse.
1546 52c00a5f bellard
@end itemize
1547 52c00a5f bellard
1548 15a34c63 bellard
QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1549 3f9f3aa1 bellard
@url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1550 52c00a5f bellard
1551 15a34c63 bellard
@c man begin OPTIONS
1552 15a34c63 bellard
1553 15a34c63 bellard
The following options are specific to the PowerPC emulation:
1554 15a34c63 bellard
1555 15a34c63 bellard
@table @option
1556 15a34c63 bellard
1557 15a34c63 bellard
@item -g WxH[xDEPTH]  
1558 15a34c63 bellard
1559 15a34c63 bellard
Set the initial VGA graphic mode. The default is 800x600x15.
1560 15a34c63 bellard
1561 15a34c63 bellard
@end table
1562 15a34c63 bellard
1563 15a34c63 bellard
@c man end 
1564 15a34c63 bellard
1565 15a34c63 bellard
1566 52c00a5f bellard
More information is available at
1567 3f9f3aa1 bellard
@url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1568 52c00a5f bellard
1569 debc7065 bellard
@node Sparc32 System emulator invocation
1570 3f9f3aa1 bellard
@section Sparc32 System emulator invocation
1571 e80cfcfc bellard
1572 0986ac3b bellard
Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
1573 3475187d bellard
(sun4m architecture). The emulation is somewhat complete.
1574 e80cfcfc bellard
1575 b671f9ed bellard
QEMU emulates the following sun4m peripherals:
1576 e80cfcfc bellard
1577 e80cfcfc bellard
@itemize @minus
1578 3475187d bellard
@item
1579 e80cfcfc bellard
IOMMU
1580 e80cfcfc bellard
@item
1581 e80cfcfc bellard
TCX Frame buffer
1582 e80cfcfc bellard
@item 
1583 e80cfcfc bellard
Lance (Am7990) Ethernet
1584 e80cfcfc bellard
@item
1585 e80cfcfc bellard
Non Volatile RAM M48T08
1586 e80cfcfc bellard
@item
1587 3475187d bellard
Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1588 3475187d bellard
and power/reset logic
1589 3475187d bellard
@item
1590 3475187d bellard
ESP SCSI controller with hard disk and CD-ROM support
1591 3475187d bellard
@item
1592 3475187d bellard
Floppy drive
1593 e80cfcfc bellard
@end itemize
1594 e80cfcfc bellard
1595 3475187d bellard
The number of peripherals is fixed in the architecture.
1596 3475187d bellard
1597 30a604f3 bellard
Since version 0.8.2, QEMU uses OpenBIOS
1598 0986ac3b bellard
@url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1599 0986ac3b bellard
firmware implementation. The goal is to implement a 100% IEEE
1600 0986ac3b bellard
1275-1994 (referred to as Open Firmware) compliant firmware.
1601 3475187d bellard
1602 3475187d bellard
A sample Linux 2.6 series kernel and ram disk image are available on
1603 0986ac3b bellard
the QEMU web site. Please note that currently NetBSD, OpenBSD or
1604 0986ac3b bellard
Solaris kernels don't work.
1605 3475187d bellard
1606 3475187d bellard
@c man begin OPTIONS
1607 3475187d bellard
1608 3475187d bellard
The following options are specific to the Sparc emulation:
1609 3475187d bellard
1610 3475187d bellard
@table @option
1611 3475187d bellard
1612 3475187d bellard
@item -g WxH
1613 3475187d bellard
1614 3475187d bellard
Set the initial TCX graphic mode. The default is 1024x768.
1615 3475187d bellard
1616 3475187d bellard
@end table
1617 3475187d bellard
1618 3475187d bellard
@c man end 
1619 3475187d bellard
1620 debc7065 bellard
@node Sparc64 System emulator invocation
1621 3f9f3aa1 bellard
@section Sparc64 System emulator invocation
1622 e80cfcfc bellard
1623 3475187d bellard
Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
1624 3475187d bellard
The emulator is not usable for anything yet.
1625 b756921a bellard
1626 83469015 bellard
QEMU emulates the following sun4u peripherals:
1627 83469015 bellard
1628 83469015 bellard
@itemize @minus
1629 83469015 bellard
@item
1630 83469015 bellard
UltraSparc IIi APB PCI Bridge 
1631 83469015 bellard
@item
1632 83469015 bellard
PCI VGA compatible card with VESA Bochs Extensions
1633 83469015 bellard
@item
1634 83469015 bellard
Non Volatile RAM M48T59
1635 83469015 bellard
@item
1636 83469015 bellard
PC-compatible serial ports
1637 83469015 bellard
@end itemize
1638 83469015 bellard
1639 debc7065 bellard
@node MIPS System emulator invocation
1640 3f9f3aa1 bellard
@section MIPS System emulator invocation
1641 9d0a8e6f bellard
1642 9d0a8e6f bellard
Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
1643 3f9f3aa1 bellard
The emulator is able to boot a Linux kernel and to run a Linux Debian
1644 3f9f3aa1 bellard
installation from NFS. The following devices are emulated:
1645 3f9f3aa1 bellard
1646 3f9f3aa1 bellard
@itemize @minus
1647 3f9f3aa1 bellard
@item 
1648 3f9f3aa1 bellard
MIPS R4K CPU
1649 3f9f3aa1 bellard
@item
1650 3f9f3aa1 bellard
PC style serial port
1651 3f9f3aa1 bellard
@item
1652 3f9f3aa1 bellard
NE2000 network card
1653 3f9f3aa1 bellard
@end itemize
1654 3f9f3aa1 bellard
1655 3f9f3aa1 bellard
More information is available in the QEMU mailing-list archive.
1656 3f9f3aa1 bellard
1657 debc7065 bellard
@node ARM System emulator invocation
1658 3f9f3aa1 bellard
@section ARM System emulator invocation
1659 3f9f3aa1 bellard
1660 3f9f3aa1 bellard
Use the executable @file{qemu-system-arm} to simulate a ARM
1661 3f9f3aa1 bellard
machine. The ARM Integrator/CP board is emulated with the following
1662 3f9f3aa1 bellard
devices:
1663 3f9f3aa1 bellard
1664 3f9f3aa1 bellard
@itemize @minus
1665 3f9f3aa1 bellard
@item
1666 ed96ca35 pbrook
ARM926E or ARM1026E CPU
1667 3f9f3aa1 bellard
@item
1668 3f9f3aa1 bellard
Two PL011 UARTs
1669 3f9f3aa1 bellard
@item 
1670 3f9f3aa1 bellard
SMC 91c111 Ethernet adapter
1671 00a9bf19 pbrook
@item
1672 00a9bf19 pbrook
PL110 LCD controller
1673 00a9bf19 pbrook
@item
1674 00a9bf19 pbrook
PL050 KMI with PS/2 keyboard and mouse.
1675 00a9bf19 pbrook
@end itemize
1676 00a9bf19 pbrook
1677 00a9bf19 pbrook
The ARM Versatile baseboard is emulated with the following devices:
1678 00a9bf19 pbrook
1679 00a9bf19 pbrook
@itemize @minus
1680 00a9bf19 pbrook
@item
1681 00a9bf19 pbrook
ARM926E CPU
1682 00a9bf19 pbrook
@item
1683 00a9bf19 pbrook
PL190 Vectored Interrupt Controller
1684 00a9bf19 pbrook
@item
1685 00a9bf19 pbrook
Four PL011 UARTs
1686 00a9bf19 pbrook
@item 
1687 00a9bf19 pbrook
SMC 91c111 Ethernet adapter
1688 00a9bf19 pbrook
@item
1689 00a9bf19 pbrook
PL110 LCD controller
1690 00a9bf19 pbrook
@item
1691 00a9bf19 pbrook
PL050 KMI with PS/2 keyboard and mouse.
1692 00a9bf19 pbrook
@item
1693 00a9bf19 pbrook
PCI host bridge.  Note the emulated PCI bridge only provides access to
1694 00a9bf19 pbrook
PCI memory space.  It does not provide access to PCI IO space.
1695 00a9bf19 pbrook
This means some devices (eg. ne2k_pci NIC) are not useable, and others
1696 00a9bf19 pbrook
(eg. rtl8139 NIC) are only useable when the guest drivers use the memory
1697 00a9bf19 pbrook
mapped control registers.
1698 e6de1bad pbrook
@item
1699 e6de1bad pbrook
PCI OHCI USB controller.
1700 e6de1bad pbrook
@item
1701 e6de1bad pbrook
LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1702 3f9f3aa1 bellard
@end itemize
1703 3f9f3aa1 bellard
1704 3f9f3aa1 bellard
A Linux 2.6 test image is available on the QEMU web site. More
1705 3f9f3aa1 bellard
information is available in the QEMU mailing-list archive.
1706 9d0a8e6f bellard
1707 83195237 bellard
@node QEMU User space emulator 
1708 83195237 bellard
@chapter QEMU User space emulator 
1709 83195237 bellard
1710 83195237 bellard
@menu
1711 83195237 bellard
* Supported Operating Systems ::
1712 83195237 bellard
* Linux User space emulator::
1713 83195237 bellard
* Mac OS X/Darwin User space emulator ::
1714 83195237 bellard
@end menu
1715 83195237 bellard
1716 83195237 bellard
@node Supported Operating Systems
1717 83195237 bellard
@section Supported Operating Systems
1718 83195237 bellard
1719 83195237 bellard
The following OS are supported in user space emulation:
1720 83195237 bellard
1721 83195237 bellard
@itemize @minus
1722 83195237 bellard
@item
1723 83195237 bellard
Linux (refered as qemu-linux-user)
1724 83195237 bellard
@item
1725 83195237 bellard
Mac OS X/Darwin (refered as qemu-darwin-user)
1726 83195237 bellard
@end itemize
1727 83195237 bellard
1728 83195237 bellard
@node Linux User space emulator
1729 83195237 bellard
@section Linux User space emulator
1730 386405f7 bellard
1731 debc7065 bellard
@menu
1732 debc7065 bellard
* Quick Start::
1733 debc7065 bellard
* Wine launch::
1734 debc7065 bellard
* Command line options::
1735 79737e4a pbrook
* Other binaries::
1736 debc7065 bellard
@end menu
1737 debc7065 bellard
1738 debc7065 bellard
@node Quick Start
1739 83195237 bellard
@subsection Quick Start
1740 df0f11a0 bellard
1741 1f673135 bellard
In order to launch a Linux process, QEMU needs the process executable
1742 1f673135 bellard
itself and all the target (x86) dynamic libraries used by it. 
1743 386405f7 bellard
1744 1f673135 bellard
@itemize
1745 386405f7 bellard
1746 1f673135 bellard
@item On x86, you can just try to launch any process by using the native
1747 1f673135 bellard
libraries:
1748 386405f7 bellard
1749 1f673135 bellard
@example 
1750 1f673135 bellard
qemu-i386 -L / /bin/ls
1751 1f673135 bellard
@end example
1752 386405f7 bellard
1753 1f673135 bellard
@code{-L /} tells that the x86 dynamic linker must be searched with a
1754 1f673135 bellard
@file{/} prefix.
1755 386405f7 bellard
1756 1f673135 bellard
@item Since QEMU is also a linux process, you can launch qemu with qemu (NOTE: you can only do that if you compiled QEMU from the sources):
1757 386405f7 bellard
1758 1f673135 bellard
@example 
1759 1f673135 bellard
qemu-i386 -L / qemu-i386 -L / /bin/ls
1760 1f673135 bellard
@end example
1761 386405f7 bellard
1762 1f673135 bellard
@item On non x86 CPUs, you need first to download at least an x86 glibc
1763 1f673135 bellard
(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1764 1f673135 bellard
@code{LD_LIBRARY_PATH} is not set:
1765 df0f11a0 bellard
1766 1f673135 bellard
@example
1767 1f673135 bellard
unset LD_LIBRARY_PATH 
1768 1f673135 bellard
@end example
1769 1eb87257 bellard
1770 1f673135 bellard
Then you can launch the precompiled @file{ls} x86 executable:
1771 1eb87257 bellard
1772 1f673135 bellard
@example
1773 1f673135 bellard
qemu-i386 tests/i386/ls
1774 1f673135 bellard
@end example
1775 1f673135 bellard
You can look at @file{qemu-binfmt-conf.sh} so that
1776 1f673135 bellard
QEMU is automatically launched by the Linux kernel when you try to
1777 1f673135 bellard
launch x86 executables. It requires the @code{binfmt_misc} module in the
1778 1f673135 bellard
Linux kernel.
1779 1eb87257 bellard
1780 1f673135 bellard
@item The x86 version of QEMU is also included. You can try weird things such as:
1781 1f673135 bellard
@example
1782 debc7065 bellard
qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
1783 debc7065 bellard
          /usr/local/qemu-i386/bin/ls-i386
1784 1f673135 bellard
@end example
1785 1eb20527 bellard
1786 1f673135 bellard
@end itemize
1787 1eb20527 bellard
1788 debc7065 bellard
@node Wine launch
1789 83195237 bellard
@subsection Wine launch
1790 1eb20527 bellard
1791 1f673135 bellard
@itemize
1792 386405f7 bellard
1793 1f673135 bellard
@item Ensure that you have a working QEMU with the x86 glibc
1794 1f673135 bellard
distribution (see previous section). In order to verify it, you must be
1795 1f673135 bellard
able to do:
1796 386405f7 bellard
1797 1f673135 bellard
@example
1798 1f673135 bellard
qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1799 1f673135 bellard
@end example
1800 386405f7 bellard
1801 1f673135 bellard
@item Download the binary x86 Wine install
1802 1f673135 bellard
(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page). 
1803 386405f7 bellard
1804 1f673135 bellard
@item Configure Wine on your account. Look at the provided script
1805 debc7065 bellard
@file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
1806 1f673135 bellard
@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1807 386405f7 bellard
1808 1f673135 bellard
@item Then you can try the example @file{putty.exe}:
1809 386405f7 bellard
1810 1f673135 bellard
@example
1811 debc7065 bellard
qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
1812 debc7065 bellard
          /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1813 1f673135 bellard
@end example
1814 386405f7 bellard
1815 1f673135 bellard
@end itemize
1816 fd429f2f bellard
1817 debc7065 bellard
@node Command line options
1818 83195237 bellard
@subsection Command line options
1819 1eb20527 bellard
1820 1f673135 bellard
@example
1821 1f673135 bellard
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1822 1f673135 bellard
@end example
1823 1eb20527 bellard
1824 1f673135 bellard
@table @option
1825 1f673135 bellard
@item -h
1826 1f673135 bellard
Print the help
1827 1f673135 bellard
@item -L path   
1828 1f673135 bellard
Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1829 1f673135 bellard
@item -s size
1830 1f673135 bellard
Set the x86 stack size in bytes (default=524288)
1831 386405f7 bellard
@end table
1832 386405f7 bellard
1833 1f673135 bellard
Debug options:
1834 386405f7 bellard
1835 1f673135 bellard
@table @option
1836 1f673135 bellard
@item -d
1837 1f673135 bellard
Activate log (logfile=/tmp/qemu.log)
1838 1f673135 bellard
@item -p pagesize
1839 1f673135 bellard
Act as if the host page size was 'pagesize' bytes
1840 1f673135 bellard
@end table
1841 386405f7 bellard
1842 79737e4a pbrook
@node Other binaries
1843 83195237 bellard
@subsection Other binaries
1844 79737e4a pbrook
1845 79737e4a pbrook
@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
1846 79737e4a pbrook
binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
1847 79737e4a pbrook
configurations), and arm-uclinux bFLT format binaries.
1848 79737e4a pbrook
1849 e6e5906b pbrook
@command{qemu-m68k} is capable of running semihosted binaries using the BDM
1850 e6e5906b pbrook
(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
1851 e6e5906b pbrook
coldfire uClinux bFLT format binaries.
1852 e6e5906b pbrook
1853 79737e4a pbrook
The binary format is detected automatically.
1854 79737e4a pbrook
1855 83195237 bellard
@node Mac OS X/Darwin User space emulator
1856 83195237 bellard
@section Mac OS X/Darwin User space emulator
1857 83195237 bellard
1858 83195237 bellard
@menu
1859 83195237 bellard
* Mac OS X/Darwin Status::
1860 83195237 bellard
* Mac OS X/Darwin Quick Start::
1861 83195237 bellard
* Mac OS X/Darwin Command line options::
1862 83195237 bellard
@end menu
1863 83195237 bellard
1864 83195237 bellard
@node Mac OS X/Darwin Status
1865 83195237 bellard
@subsection Mac OS X/Darwin Status
1866 83195237 bellard
1867 83195237 bellard
@itemize @minus
1868 83195237 bellard
@item
1869 83195237 bellard
target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
1870 83195237 bellard
@item
1871 83195237 bellard
target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
1872 83195237 bellard
@item
1873 83195237 bellard
target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
1874 83195237 bellard
@item
1875 83195237 bellard
target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
1876 83195237 bellard
@end itemize
1877 83195237 bellard
1878 83195237 bellard
[1] If you're host commpage can be executed by qemu.
1879 83195237 bellard
1880 83195237 bellard
@node Mac OS X/Darwin Quick Start
1881 83195237 bellard
@subsection Quick Start
1882 83195237 bellard
1883 83195237 bellard
In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
1884 83195237 bellard
itself and all the target dynamic libraries used by it. If you don't have the FAT
1885 83195237 bellard
libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
1886 83195237 bellard
CD or compile them by hand.
1887 83195237 bellard
1888 83195237 bellard
@itemize
1889 83195237 bellard
1890 83195237 bellard
@item On x86, you can just try to launch any process by using the native
1891 83195237 bellard
libraries:
1892 83195237 bellard
1893 83195237 bellard
@example 
1894 83195237 bellard
qemu-darwin-i386 /bin/ls
1895 83195237 bellard
@end example
1896 83195237 bellard
1897 83195237 bellard
or to run the ppc version of the executable:
1898 83195237 bellard
1899 83195237 bellard
@example 
1900 83195237 bellard
qemu-darwin-ppc /bin/ls
1901 83195237 bellard
@end example
1902 83195237 bellard
1903 83195237 bellard
@item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
1904 83195237 bellard
are installed:
1905 83195237 bellard
1906 83195237 bellard
@example 
1907 83195237 bellard
qemu-darwin-i386 -L /opt/x86_root/ /bin/ls
1908 83195237 bellard
@end example
1909 83195237 bellard
1910 83195237 bellard
@code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
1911 83195237 bellard
@file{/opt/x86_root/usr/bin/dyld}.
1912 83195237 bellard
1913 83195237 bellard
@end itemize
1914 83195237 bellard
1915 83195237 bellard
@node Mac OS X/Darwin Command line options
1916 83195237 bellard
@subsection Command line options
1917 83195237 bellard
1918 83195237 bellard
@example
1919 83195237 bellard
usage: qemu-darwin-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1920 83195237 bellard
@end example
1921 83195237 bellard
1922 83195237 bellard
@table @option
1923 83195237 bellard
@item -h
1924 83195237 bellard
Print the help
1925 83195237 bellard
@item -L path   
1926 83195237 bellard
Set the library root path (default=/)
1927 83195237 bellard
@item -s size
1928 83195237 bellard
Set the stack size in bytes (default=524288)
1929 83195237 bellard
@end table
1930 83195237 bellard
1931 83195237 bellard
Debug options:
1932 83195237 bellard
1933 83195237 bellard
@table @option
1934 83195237 bellard
@item -d
1935 83195237 bellard
Activate log (logfile=/tmp/qemu.log)
1936 83195237 bellard
@item -p pagesize
1937 83195237 bellard
Act as if the host page size was 'pagesize' bytes
1938 83195237 bellard
@end table
1939 83195237 bellard
1940 15a34c63 bellard
@node compilation
1941 15a34c63 bellard
@chapter Compilation from the sources
1942 15a34c63 bellard
1943 debc7065 bellard
@menu
1944 debc7065 bellard
* Linux/Unix::
1945 debc7065 bellard
* Windows::
1946 debc7065 bellard
* Cross compilation for Windows with Linux::
1947 debc7065 bellard
* Mac OS X::
1948 debc7065 bellard
@end menu
1949 debc7065 bellard
1950 debc7065 bellard
@node Linux/Unix
1951 7c3fc84d bellard
@section Linux/Unix
1952 7c3fc84d bellard
1953 7c3fc84d bellard
@subsection Compilation
1954 7c3fc84d bellard
1955 7c3fc84d bellard
First you must decompress the sources:
1956 7c3fc84d bellard
@example
1957 7c3fc84d bellard
cd /tmp
1958 7c3fc84d bellard
tar zxvf qemu-x.y.z.tar.gz
1959 7c3fc84d bellard
cd qemu-x.y.z
1960 7c3fc84d bellard
@end example
1961 7c3fc84d bellard
1962 7c3fc84d bellard
Then you configure QEMU and build it (usually no options are needed):
1963 7c3fc84d bellard
@example
1964 7c3fc84d bellard
./configure
1965 7c3fc84d bellard
make
1966 7c3fc84d bellard
@end example
1967 7c3fc84d bellard
1968 7c3fc84d bellard
Then type as root user:
1969 7c3fc84d bellard
@example
1970 7c3fc84d bellard
make install
1971 7c3fc84d bellard
@end example
1972 7c3fc84d bellard
to install QEMU in @file{/usr/local}.
1973 7c3fc84d bellard
1974 4fe8b87a bellard
@subsection GCC version
1975 7c3fc84d bellard
1976 366dfc52 ths
In order to compile QEMU successfully, it is very important that you
1977 4fe8b87a bellard
have the right tools. The most important one is gcc. On most hosts and
1978 4fe8b87a bellard
in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
1979 4fe8b87a bellard
Linux distribution includes a gcc 4.x compiler, you can usually
1980 4fe8b87a bellard
install an older version (it is invoked by @code{gcc32} or
1981 4fe8b87a bellard
@code{gcc34}). The QEMU configure script automatically probes for
1982 4fe8b87a bellard
these older versions so that usally you don't have to do anything.
1983 15a34c63 bellard
1984 debc7065 bellard
@node Windows
1985 15a34c63 bellard
@section Windows
1986 15a34c63 bellard
1987 15a34c63 bellard
@itemize
1988 15a34c63 bellard
@item Install the current versions of MSYS and MinGW from
1989 15a34c63 bellard
@url{http://www.mingw.org/}. You can find detailed installation
1990 15a34c63 bellard
instructions in the download section and the FAQ.
1991 15a34c63 bellard
1992 15a34c63 bellard
@item Download 
1993 15a34c63 bellard
the MinGW development library of SDL 1.2.x
1994 debc7065 bellard
(@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
1995 15a34c63 bellard
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
1996 15a34c63 bellard
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1997 15a34c63 bellard
directory. Edit the @file{sdl-config} script so that it gives the
1998 15a34c63 bellard
correct SDL directory when invoked.
1999 15a34c63 bellard
2000 15a34c63 bellard
@item Extract the current version of QEMU.
2001 15a34c63 bellard
 
2002 15a34c63 bellard
@item Start the MSYS shell (file @file{msys.bat}).
2003 15a34c63 bellard
2004 15a34c63 bellard
@item Change to the QEMU directory. Launch @file{./configure} and 
2005 15a34c63 bellard
@file{make}.  If you have problems using SDL, verify that
2006 15a34c63 bellard
@file{sdl-config} can be launched from the MSYS command line.
2007 15a34c63 bellard
2008 15a34c63 bellard
@item You can install QEMU in @file{Program Files/Qemu} by typing 
2009 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in
2010 15a34c63 bellard
@file{Program Files/Qemu}.
2011 15a34c63 bellard
2012 15a34c63 bellard
@end itemize
2013 15a34c63 bellard
2014 debc7065 bellard
@node Cross compilation for Windows with Linux
2015 15a34c63 bellard
@section Cross compilation for Windows with Linux
2016 15a34c63 bellard
2017 15a34c63 bellard
@itemize
2018 15a34c63 bellard
@item
2019 15a34c63 bellard
Install the MinGW cross compilation tools available at
2020 15a34c63 bellard
@url{http://www.mingw.org/}.
2021 15a34c63 bellard
2022 15a34c63 bellard
@item 
2023 15a34c63 bellard
Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2024 15a34c63 bellard
unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2025 15a34c63 bellard
variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2026 15a34c63 bellard
the QEMU configuration script.
2027 15a34c63 bellard
2028 15a34c63 bellard
@item 
2029 15a34c63 bellard
Configure QEMU for Windows cross compilation:
2030 15a34c63 bellard
@example
2031 15a34c63 bellard
./configure --enable-mingw32
2032 15a34c63 bellard
@end example
2033 15a34c63 bellard
If necessary, you can change the cross-prefix according to the prefix
2034 15a34c63 bellard
choosen for the MinGW tools with --cross-prefix. You can also use
2035 15a34c63 bellard
--prefix to set the Win32 install path.
2036 15a34c63 bellard
2037 15a34c63 bellard
@item You can install QEMU in the installation directory by typing 
2038 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in the
2039 15a34c63 bellard
installation directory. 
2040 15a34c63 bellard
2041 15a34c63 bellard
@end itemize
2042 15a34c63 bellard
2043 15a34c63 bellard
Note: Currently, Wine does not seem able to launch
2044 15a34c63 bellard
QEMU for Win32.
2045 15a34c63 bellard
2046 debc7065 bellard
@node Mac OS X
2047 15a34c63 bellard
@section Mac OS X
2048 15a34c63 bellard
2049 15a34c63 bellard
The Mac OS X patches are not fully merged in QEMU, so you should look
2050 15a34c63 bellard
at the QEMU mailing list archive to have all the necessary
2051 15a34c63 bellard
information.
2052 15a34c63 bellard
2053 debc7065 bellard
@node Index
2054 debc7065 bellard
@chapter Index
2055 debc7065 bellard
@printindex cp
2056 debc7065 bellard
2057 debc7065 bellard
@bye