Statistics
| Branch: | Revision:

root / qemu-doc.texi @ acd935ef

History | View | Annotate | Download (34.3 kB)

1 386405f7 bellard
\input texinfo @c -*- texinfo -*-
2 386405f7 bellard
3 0806e3f6 bellard
@iftex
4 1f673135 bellard
@settitle QEMU CPU Emulator User Documentation
5 386405f7 bellard
@titlepage
6 386405f7 bellard
@sp 7
7 1f673135 bellard
@center @titlefont{QEMU CPU Emulator User Documentation}
8 386405f7 bellard
@sp 3
9 386405f7 bellard
@end titlepage
10 0806e3f6 bellard
@end iftex
11 386405f7 bellard
12 386405f7 bellard
@chapter Introduction
13 386405f7 bellard
14 322d0c66 bellard
@section Features
15 386405f7 bellard
16 1f673135 bellard
QEMU is a FAST! processor emulator using dynamic translation to
17 1f673135 bellard
achieve good emulation speed.
18 1eb20527 bellard
19 1eb20527 bellard
QEMU has two operating modes:
20 0806e3f6 bellard
21 0806e3f6 bellard
@itemize @minus
22 0806e3f6 bellard
23 0806e3f6 bellard
@item 
24 1f673135 bellard
Full system emulation. In this mode, QEMU emulates a full system (for
25 1f673135 bellard
example a PC), including a processor and various peripherials. It can
26 1f673135 bellard
be used to launch different Operating Systems without rebooting the
27 1f673135 bellard
PC or to debug system code.
28 1eb20527 bellard
29 0806e3f6 bellard
@item 
30 1f673135 bellard
User mode emulation (Linux host only). In this mode, QEMU can launch
31 1f673135 bellard
Linux processes compiled for one CPU on another CPU. It can be used to
32 1f673135 bellard
launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
33 1f673135 bellard
to ease cross-compilation and cross-debugging.
34 1eb20527 bellard
35 1eb20527 bellard
@end itemize
36 1eb20527 bellard
37 1f673135 bellard
As QEMU requires no host kernel driver to run, it is very safe and
38 1eb20527 bellard
easy to use.
39 322d0c66 bellard
40 52c00a5f bellard
For system emulation, the following hardware targets are supported:
41 52c00a5f bellard
@itemize
42 52c00a5f bellard
@item PC (x86 processor)
43 52c00a5f bellard
@item PREP (PowerPC processor)
44 15a34c63 bellard
@item PowerMac (PowerPC processor, in progress)
45 52c00a5f bellard
@end itemize
46 386405f7 bellard
47 1f673135 bellard
For user emulation, x86, PowerPC, ARM, and SPARC CPUs are supported.
48 0806e3f6 bellard
49 5b9f457a bellard
@chapter Installation
50 5b9f457a bellard
51 15a34c63 bellard
If you want to compile QEMU yourself, see @ref{compilation}.
52 15a34c63 bellard
53 1f673135 bellard
@section Linux
54 1f673135 bellard
55 15a34c63 bellard
Download the binary distribution (@file{qemu-XXX-i386.tar.gz}) and
56 15a34c63 bellard
untar it as root in @file{/}:
57 5b9f457a bellard
58 5b9f457a bellard
@example
59 5b9f457a bellard
su
60 5b9f457a bellard
cd /
61 5b9f457a bellard
tar zxvf /tmp/qemu-XXX-i386.tar.gz
62 5b9f457a bellard
@end example
63 5b9f457a bellard
64 1f673135 bellard
@section Windows
65 8cd0ac2f bellard
66 15a34c63 bellard
Download the experimental binary installer at
67 15a34c63 bellard
@url{http://www.freeoszoo.org/download.php}.
68 d691f669 bellard
69 1f673135 bellard
@section Mac OS X
70 d691f669 bellard
71 15a34c63 bellard
Download the experimental binary installer at
72 15a34c63 bellard
@url{http://www.freeoszoo.org/download.php}.
73 df0f11a0 bellard
74 52c00a5f bellard
@chapter QEMU PC System emulator invocation
75 1eb20527 bellard
76 0806e3f6 bellard
@section Introduction
77 0806e3f6 bellard
78 0806e3f6 bellard
@c man begin DESCRIPTION
79 0806e3f6 bellard
80 52c00a5f bellard
The QEMU System emulator simulates a complete PC.
81 0806e3f6 bellard
82 0806e3f6 bellard
In order to meet specific user needs, two versions of QEMU are
83 0806e3f6 bellard
available:
84 0806e3f6 bellard
85 0806e3f6 bellard
@enumerate
86 0806e3f6 bellard
87 0806e3f6 bellard
@item 
88 15a34c63 bellard
@code{qemu-fast} uses the host Memory Management Unit (MMU) to
89 15a34c63 bellard
simulate the x86 MMU. It is @emph{fast} but has limitations because
90 15a34c63 bellard
the whole 4 GB address space cannot be used and some memory mapped
91 15a34c63 bellard
peripherials cannot be emulated accurately yet. Therefore, a specific
92 3eb2619f bellard
guest Linux kernel can be used (@xref{linux_compile}) as guest
93 3eb2619f bellard
OS. 
94 3eb2619f bellard
95 3eb2619f bellard
Moreover there is no separation between the host and target address
96 3eb2619f bellard
spaces, so it offers no security (the target OS can modify the
97 3eb2619f bellard
@code{qemu-fast} code by writing at the right addresses).
98 0806e3f6 bellard
99 0806e3f6 bellard
@item 
100 3eb2619f bellard
@code{qemu} uses a software MMU. It is about @emph{two times slower}
101 3eb2619f bellard
but gives a more accurate emulation and a complete separation between
102 3eb2619f bellard
the host and target address spaces.
103 0806e3f6 bellard
104 0806e3f6 bellard
@end enumerate
105 0806e3f6 bellard
106 0806e3f6 bellard
QEMU emulates the following PC peripherials:
107 0806e3f6 bellard
108 0806e3f6 bellard
@itemize @minus
109 15a34c63 bellard
@item 
110 15a34c63 bellard
i440FX host PCI bridge and PIIX3 PCI to ISA bridge
111 0806e3f6 bellard
@item
112 15a34c63 bellard
Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
113 15a34c63 bellard
extensions (hardware level, including all non standard modes).
114 0806e3f6 bellard
@item
115 0806e3f6 bellard
PS/2 mouse and keyboard
116 0806e3f6 bellard
@item 
117 15a34c63 bellard
2 PCI IDE interfaces with hard disk and CD-ROM support
118 1f673135 bellard
@item
119 1f673135 bellard
Floppy disk
120 0806e3f6 bellard
@item 
121 15a34c63 bellard
NE2000 PCI network adapters
122 0806e3f6 bellard
@item
123 05d5818c bellard
Serial ports
124 05d5818c bellard
@item
125 181f1558 bellard
Soundblaster 16 card
126 0806e3f6 bellard
@end itemize
127 0806e3f6 bellard
128 15a34c63 bellard
QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
129 15a34c63 bellard
VGA BIOS.
130 15a34c63 bellard
131 0806e3f6 bellard
@c man end
132 0806e3f6 bellard
133 1eb20527 bellard
@section Quick Start
134 1eb20527 bellard
135 285dc330 bellard
Download and uncompress the linux image (@file{linux.img}) and type:
136 0806e3f6 bellard
137 0806e3f6 bellard
@example
138 285dc330 bellard
qemu linux.img
139 0806e3f6 bellard
@end example
140 0806e3f6 bellard
141 0806e3f6 bellard
Linux should boot and give you a prompt.
142 0806e3f6 bellard
143 ec410fc9 bellard
@section Invocation
144 ec410fc9 bellard
145 ec410fc9 bellard
@example
146 0806e3f6 bellard
@c man begin SYNOPSIS
147 0806e3f6 bellard
usage: qemu [options] [disk_image]
148 0806e3f6 bellard
@c man end
149 ec410fc9 bellard
@end example
150 ec410fc9 bellard
151 0806e3f6 bellard
@c man begin OPTIONS
152 9d4520d0 bellard
@var{disk_image} is a raw hard disk image for IDE hard disk 0.
153 ec410fc9 bellard
154 ec410fc9 bellard
General options:
155 ec410fc9 bellard
@table @option
156 2be3bc02 bellard
@item -fda file
157 2be3bc02 bellard
@item -fdb file
158 be3edd95 bellard
Use @var{file} as floppy disk 0/1 image (@xref{disk_images}). You can
159 be3edd95 bellard
use the host floppy by using @file{/dev/fd0} as filename.
160 2be3bc02 bellard
161 ec410fc9 bellard
@item -hda file
162 ec410fc9 bellard
@item -hdb file
163 181f1558 bellard
@item -hdc file
164 181f1558 bellard
@item -hdd file
165 2be3bc02 bellard
Use @var{file} as hard disk 0, 1, 2 or 3 image (@xref{disk_images}).
166 1f47a922 bellard
167 181f1558 bellard
@item -cdrom file
168 181f1558 bellard
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
169 be3edd95 bellard
@option{-cdrom} at the same time). You can use the host CD-ROM by
170 be3edd95 bellard
using @file{/dev/cdrom} as filename.
171 181f1558 bellard
172 1f673135 bellard
@item -boot [a|c|d]
173 1f673135 bellard
Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
174 2be3bc02 bellard
the default.
175 1f47a922 bellard
176 181f1558 bellard
@item -snapshot
177 1f47a922 bellard
Write to temporary files instead of disk image files. In this case,
178 1f47a922 bellard
the raw disk image you use is not written back. You can however force
179 1f47a922 bellard
the write back by pressing @key{C-a s} (@xref{disk_images}). 
180 ec410fc9 bellard
181 ec410fc9 bellard
@item -m megs
182 15a34c63 bellard
Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
183 ec410fc9 bellard
184 0806e3f6 bellard
@item -nographic
185 0806e3f6 bellard
186 0806e3f6 bellard
Normally, QEMU uses SDL to display the VGA output. With this option,
187 0806e3f6 bellard
you can totally disable graphical output so that QEMU is a simple
188 0806e3f6 bellard
command line application. The emulated serial port is redirected on
189 0806e3f6 bellard
the console. Therefore, you can still use QEMU to debug a Linux kernel
190 0806e3f6 bellard
with a serial console.
191 0806e3f6 bellard
192 a8c490cd bellard
@item -enable-audio
193 a8c490cd bellard
194 a8c490cd bellard
The SB16 emulation is disabled by default as it may give problems with
195 a8c490cd bellard
Windows. You can enable it manually with this option.
196 a8c490cd bellard
197 15a34c63 bellard
@item -localtime
198 15a34c63 bellard
Set the real time clock to local time (the default is to UTC
199 15a34c63 bellard
time). This option is needed to have correct date in MS-DOS or
200 15a34c63 bellard
Windows.
201 15a34c63 bellard
202 d63d307f bellard
@item -full-screen
203 d63d307f bellard
Start in full screen.
204 d63d307f bellard
205 0806e3f6 bellard
@end table
206 0806e3f6 bellard
207 1f673135 bellard
Network options:
208 1f673135 bellard
209 1f673135 bellard
@table @option
210 1f673135 bellard
211 1f673135 bellard
@item -n script      
212 52c00a5f bellard
Set TUN/TAP network init script [default=/etc/qemu-ifup]. This script
213 52c00a5f bellard
is launched to configure the host network interface (usually tun0)
214 1f673135 bellard
corresponding to the virtual NE2000 card.
215 1f673135 bellard
216 1f673135 bellard
@item -macaddr addr   
217 1f673135 bellard
218 1f673135 bellard
Set the mac address of the first interface (the format is
219 1f673135 bellard
aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each
220 1f673135 bellard
new network interface.
221 1f673135 bellard
222 52c00a5f bellard
@item -tun-fd fd
223 52c00a5f bellard
Assumes @var{fd} talks to a tap/tun host network interface and use
224 52c00a5f bellard
it. Read @url{http://bellard.org/qemu/tetrinet.html} to have an
225 52c00a5f bellard
example of its use.
226 52c00a5f bellard
227 52c00a5f bellard
@item -user-net 
228 15a34c63 bellard
Use the user mode network stack. This is the default if no tun/tap
229 15a34c63 bellard
network init script is found.
230 52c00a5f bellard
231 9bf05444 bellard
@item -tftp prefix
232 9bf05444 bellard
When using the user mode network stack, activate a built-in TFTP
233 9bf05444 bellard
server. All filenames beginning with @var{prefix} can be downloaded
234 9bf05444 bellard
from the host to the guest using a TFTP client. The TFTP client on the
235 9bf05444 bellard
guest must be configured in binary mode (use the command @code{bin} of
236 9bf05444 bellard
the Unix TFTP client). The host IP address on the guest is as usual
237 9bf05444 bellard
10.0.2.2.
238 9bf05444 bellard
239 2518bd0d bellard
@item -smb dir
240 2518bd0d bellard
When using the user mode network stack, activate a built-in SMB
241 2518bd0d bellard
server so that Windows OSes can access to the host files in @file{dir}
242 2518bd0d bellard
transparently.
243 2518bd0d bellard
244 2518bd0d bellard
In the guest Windows OS, the line:
245 2518bd0d bellard
@example
246 2518bd0d bellard
10.0.2.4 smbserver
247 2518bd0d bellard
@end example
248 2518bd0d bellard
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
249 2518bd0d bellard
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
250 2518bd0d bellard
251 2518bd0d bellard
Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
252 2518bd0d bellard
253 2518bd0d bellard
Note that a SAMBA server must be installed on the host OS in
254 2518bd0d bellard
@file{/usr/sbin/smbd}. QEMU was tested succesfully with smbd version
255 2518bd0d bellard
2.2.7a from the Red Hat 9.
256 2518bd0d bellard
257 9bf05444 bellard
@item -redir [tcp|udp]:host-port:[guest-host]:guest-port
258 9bf05444 bellard
259 9bf05444 bellard
When using the user mode network stack, redirect incoming TCP or UDP
260 9bf05444 bellard
connections to the host port @var{host-port} to the guest
261 9bf05444 bellard
@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
262 9bf05444 bellard
is not specified, its value is 10.0.2.15 (default address given by the
263 9bf05444 bellard
built-in DHCP server).
264 9bf05444 bellard
265 9bf05444 bellard
For example, to redirect host X11 connection from screen 1 to guest
266 9bf05444 bellard
screen 0, use the following:
267 9bf05444 bellard
268 9bf05444 bellard
@example
269 9bf05444 bellard
# on the host
270 9bf05444 bellard
qemu -redir tcp:6001::6000 [...]
271 9bf05444 bellard
# this host xterm should open in the guest X11 server
272 9bf05444 bellard
xterm -display :1
273 9bf05444 bellard
@end example
274 9bf05444 bellard
275 9bf05444 bellard
To redirect telnet connections from host port 5555 to telnet port on
276 9bf05444 bellard
the guest, use the following:
277 9bf05444 bellard
278 9bf05444 bellard
@example
279 9bf05444 bellard
# on the host
280 9bf05444 bellard
qemu -redir tcp:5555::23 [...]
281 9bf05444 bellard
telnet localhost 5555
282 9bf05444 bellard
@end example
283 9bf05444 bellard
284 9bf05444 bellard
Then when you use on the host @code{telnet localhost 5555}, you
285 9bf05444 bellard
connect to the guest telnet server.
286 9bf05444 bellard
287 52c00a5f bellard
@item -dummy-net 
288 15a34c63 bellard
Use the dummy network stack: no packet will be received by the network
289 52c00a5f bellard
cards.
290 1f673135 bellard
291 1f673135 bellard
@end table
292 1f673135 bellard
293 1f673135 bellard
Linux boot specific. When using this options, you can use a given
294 1f673135 bellard
Linux kernel without installing it in the disk image. It can be useful
295 1f673135 bellard
for easier testing of various kernels.
296 1f673135 bellard
297 0806e3f6 bellard
@table @option
298 0806e3f6 bellard
299 0806e3f6 bellard
@item -kernel bzImage 
300 0806e3f6 bellard
Use @var{bzImage} as kernel image.
301 0806e3f6 bellard
302 0806e3f6 bellard
@item -append cmdline 
303 0806e3f6 bellard
Use @var{cmdline} as kernel command line
304 0806e3f6 bellard
305 0806e3f6 bellard
@item -initrd file
306 0806e3f6 bellard
Use @var{file} as initial ram disk.
307 0806e3f6 bellard
308 ec410fc9 bellard
@end table
309 ec410fc9 bellard
310 15a34c63 bellard
Debug/Expert options:
311 ec410fc9 bellard
@table @option
312 a0a821a4 bellard
313 a0a821a4 bellard
@item -serial dev
314 a0a821a4 bellard
Redirect the virtual serial port to host device @var{dev}. Available
315 a0a821a4 bellard
devices are:
316 a0a821a4 bellard
@table @code
317 a0a821a4 bellard
@item vc
318 a0a821a4 bellard
Virtual console
319 a0a821a4 bellard
@item pty
320 a0a821a4 bellard
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
321 a0a821a4 bellard
@item null
322 a0a821a4 bellard
void device
323 a0a821a4 bellard
@item stdio
324 a0a821a4 bellard
[Unix only] standard input/output
325 a0a821a4 bellard
@end table
326 a0a821a4 bellard
The default device is @code{vc} in graphical mode and @code{stdio} in
327 a0a821a4 bellard
non graphical mode.
328 a0a821a4 bellard
329 05d5818c bellard
This option can be used several times to simulate up to 4 serials
330 05d5818c bellard
ports.
331 05d5818c bellard
332 a0a821a4 bellard
@item -monitor dev
333 a0a821a4 bellard
Redirect the monitor to host device @var{dev} (same devices as the
334 a0a821a4 bellard
serial port).
335 a0a821a4 bellard
The default device is @code{vc} in graphical mode and @code{stdio} in
336 a0a821a4 bellard
non graphical mode.
337 a0a821a4 bellard
338 ec410fc9 bellard
@item -s
339 0806e3f6 bellard
Wait gdb connection to port 1234 (@xref{gdb_usage}). 
340 ec410fc9 bellard
@item -p port
341 ec410fc9 bellard
Change gdb connection port.
342 52c00a5f bellard
@item -S
343 52c00a5f bellard
Do not start CPU at startup (you must type 'c' in the monitor).
344 ec410fc9 bellard
@item -d             
345 9d4520d0 bellard
Output log in /tmp/qemu.log
346 15a34c63 bellard
@item -isa
347 15a34c63 bellard
Simulate an ISA-only system (default is PCI system).
348 15a34c63 bellard
@item -std-vga
349 15a34c63 bellard
Simulate a standard VGA card with Bochs VBE extensions (default is
350 15a34c63 bellard
Cirrus Logic GD5446 PCI VGA)
351 d63d307f bellard
@item -loadvm file
352 d63d307f bellard
Start right away with a saved state (@code{loadvm} in monitor)
353 ec410fc9 bellard
@end table
354 ec410fc9 bellard
355 3e11db9a bellard
@c man end
356 3e11db9a bellard
357 3e11db9a bellard
@section Keys
358 3e11db9a bellard
359 3e11db9a bellard
@c man begin OPTIONS
360 3e11db9a bellard
361 a1b74fe8 bellard
During the graphical emulation, you can use the following keys:
362 a1b74fe8 bellard
@table @key
363 f9859310 bellard
@item Ctrl-Alt-f
364 a1b74fe8 bellard
Toggle full screen
365 a0a821a4 bellard
366 f9859310 bellard
@item Ctrl-Alt-n
367 a0a821a4 bellard
Switch to virtual console 'n'. Standard console mappings are:
368 a0a821a4 bellard
@table @emph
369 a0a821a4 bellard
@item 1
370 a0a821a4 bellard
Target system display
371 a0a821a4 bellard
@item 2
372 a0a821a4 bellard
Monitor
373 a0a821a4 bellard
@item 3
374 a0a821a4 bellard
Serial port
375 a1b74fe8 bellard
@end table
376 a1b74fe8 bellard
377 f9859310 bellard
@item Ctrl-Alt
378 a0a821a4 bellard
Toggle mouse and keyboard grab.
379 a0a821a4 bellard
@end table
380 a0a821a4 bellard
381 3e11db9a bellard
In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
382 3e11db9a bellard
@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
383 3e11db9a bellard
384 a0a821a4 bellard
During emulation, if you are using the @option{-nographic} option, use
385 a0a821a4 bellard
@key{Ctrl-a h} to get terminal commands:
386 ec410fc9 bellard
387 ec410fc9 bellard
@table @key
388 a1b74fe8 bellard
@item Ctrl-a h
389 ec410fc9 bellard
Print this help
390 a1b74fe8 bellard
@item Ctrl-a x    
391 ec410fc9 bellard
Exit emulatior
392 a1b74fe8 bellard
@item Ctrl-a s    
393 1f47a922 bellard
Save disk data back to file (if -snapshot)
394 a1b74fe8 bellard
@item Ctrl-a b
395 1f673135 bellard
Send break (magic sysrq in Linux)
396 a1b74fe8 bellard
@item Ctrl-a c
397 1f673135 bellard
Switch between console and monitor
398 a1b74fe8 bellard
@item Ctrl-a Ctrl-a
399 a1b74fe8 bellard
Send Ctrl-a
400 ec410fc9 bellard
@end table
401 0806e3f6 bellard
@c man end
402 0806e3f6 bellard
403 0806e3f6 bellard
@ignore
404 0806e3f6 bellard
405 0806e3f6 bellard
@setfilename qemu 
406 0806e3f6 bellard
@settitle QEMU System Emulator
407 0806e3f6 bellard
408 1f673135 bellard
@c man begin SEEALSO
409 1f673135 bellard
The HTML documentation of QEMU for more precise information and Linux
410 1f673135 bellard
user mode emulator invocation.
411 1f673135 bellard
@c man end
412 1f673135 bellard
413 1f673135 bellard
@c man begin AUTHOR
414 1f673135 bellard
Fabrice Bellard
415 1f673135 bellard
@c man end
416 1f673135 bellard
417 1f673135 bellard
@end ignore
418 1f673135 bellard
419 1f673135 bellard
@end ignore
420 1f673135 bellard
421 1f673135 bellard
422 1f673135 bellard
@section QEMU Monitor
423 1f673135 bellard
424 1f673135 bellard
The QEMU monitor is used to give complex commands to the QEMU
425 1f673135 bellard
emulator. You can use it to:
426 1f673135 bellard
427 1f673135 bellard
@itemize @minus
428 1f673135 bellard
429 1f673135 bellard
@item
430 1f673135 bellard
Remove or insert removable medias images
431 1f673135 bellard
(such as CD-ROM or floppies)
432 1f673135 bellard
433 1f673135 bellard
@item 
434 1f673135 bellard
Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
435 1f673135 bellard
from a disk file.
436 1f673135 bellard
437 1f673135 bellard
@item Inspect the VM state without an external debugger.
438 1f673135 bellard
439 1f673135 bellard
@end itemize
440 1f673135 bellard
441 1f673135 bellard
@subsection Commands
442 1f673135 bellard
443 1f673135 bellard
The following commands are available:
444 1f673135 bellard
445 1f673135 bellard
@table @option
446 1f673135 bellard
447 1f673135 bellard
@item help or ? [cmd]
448 1f673135 bellard
Show the help for all commands or just for command @var{cmd}.
449 1f673135 bellard
450 1f673135 bellard
@item commit  
451 1f673135 bellard
Commit changes to the disk images (if -snapshot is used)
452 1f673135 bellard
453 1f673135 bellard
@item info subcommand 
454 1f673135 bellard
show various information about the system state
455 1f673135 bellard
456 1f673135 bellard
@table @option
457 1f673135 bellard
@item info network
458 1f673135 bellard
show the network state
459 1f673135 bellard
@item info block
460 1f673135 bellard
show the block devices
461 1f673135 bellard
@item info registers
462 1f673135 bellard
show the cpu registers
463 1f673135 bellard
@item info history
464 1f673135 bellard
show the command line history
465 1f673135 bellard
@end table
466 1f673135 bellard
467 1f673135 bellard
@item q or quit
468 1f673135 bellard
Quit the emulator.
469 1f673135 bellard
470 1f673135 bellard
@item eject [-f] device
471 1f673135 bellard
Eject a removable media (use -f to force it).
472 1f673135 bellard
473 1f673135 bellard
@item change device filename
474 1f673135 bellard
Change a removable media.
475 1f673135 bellard
476 1f673135 bellard
@item screendump filename
477 1f673135 bellard
Save screen into PPM image @var{filename}.
478 1f673135 bellard
479 1f673135 bellard
@item log item1[,...]
480 1f673135 bellard
Activate logging of the specified items to @file{/tmp/qemu.log}.
481 1f673135 bellard
482 1f673135 bellard
@item savevm filename
483 1f673135 bellard
Save the whole virtual machine state to @var{filename}.
484 1f673135 bellard
485 1f673135 bellard
@item loadvm filename
486 1f673135 bellard
Restore the whole virtual machine state from @var{filename}.
487 1f673135 bellard
488 1f673135 bellard
@item stop
489 1f673135 bellard
Stop emulation.
490 1f673135 bellard
491 1f673135 bellard
@item c or cont
492 1f673135 bellard
Resume emulation.
493 1f673135 bellard
494 1f673135 bellard
@item gdbserver [port]
495 1f673135 bellard
Start gdbserver session (default port=1234)
496 1f673135 bellard
497 1f673135 bellard
@item x/fmt addr
498 1f673135 bellard
Virtual memory dump starting at @var{addr}.
499 1f673135 bellard
500 1f673135 bellard
@item xp /fmt addr
501 1f673135 bellard
Physical memory dump starting at @var{addr}.
502 1f673135 bellard
503 1f673135 bellard
@var{fmt} is a format which tells the command how to format the
504 1f673135 bellard
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
505 1f673135 bellard
506 1f673135 bellard
@table @var
507 1f673135 bellard
@item count 
508 1f673135 bellard
is the number of items to be dumped.
509 1f673135 bellard
510 1f673135 bellard
@item format
511 1f673135 bellard
can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
512 1f673135 bellard
c (char) or i (asm instruction).
513 1f673135 bellard
514 1f673135 bellard
@item size
515 52c00a5f bellard
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
516 52c00a5f bellard
@code{h} or @code{w} can be specified with the @code{i} format to
517 52c00a5f bellard
respectively select 16 or 32 bit code instruction size.
518 1f673135 bellard
519 1f673135 bellard
@end table
520 1f673135 bellard
521 1f673135 bellard
Examples: 
522 1f673135 bellard
@itemize
523 1f673135 bellard
@item
524 1f673135 bellard
Dump 10 instructions at the current instruction pointer:
525 1f673135 bellard
@example 
526 1f673135 bellard
(qemu) x/10i $eip
527 1f673135 bellard
0x90107063:  ret
528 1f673135 bellard
0x90107064:  sti
529 1f673135 bellard
0x90107065:  lea    0x0(%esi,1),%esi
530 1f673135 bellard
0x90107069:  lea    0x0(%edi,1),%edi
531 1f673135 bellard
0x90107070:  ret
532 1f673135 bellard
0x90107071:  jmp    0x90107080
533 1f673135 bellard
0x90107073:  nop
534 1f673135 bellard
0x90107074:  nop
535 1f673135 bellard
0x90107075:  nop
536 1f673135 bellard
0x90107076:  nop
537 1f673135 bellard
@end example
538 1f673135 bellard
539 1f673135 bellard
@item
540 1f673135 bellard
Dump 80 16 bit values at the start of the video memory.
541 1f673135 bellard
@example 
542 1f673135 bellard
(qemu) xp/80hx 0xb8000
543 1f673135 bellard
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
544 1f673135 bellard
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
545 1f673135 bellard
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
546 1f673135 bellard
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
547 1f673135 bellard
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
548 1f673135 bellard
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
549 1f673135 bellard
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
550 1f673135 bellard
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
551 1f673135 bellard
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
552 1f673135 bellard
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
553 1f673135 bellard
@end example
554 1f673135 bellard
@end itemize
555 1f673135 bellard
556 1f673135 bellard
@item p or print/fmt expr
557 1f673135 bellard
558 1f673135 bellard
Print expression value. Only the @var{format} part of @var{fmt} is
559 1f673135 bellard
used.
560 0806e3f6 bellard
561 a3a91a35 bellard
@item sendkey keys
562 a3a91a35 bellard
563 a3a91a35 bellard
Send @var{keys} to the emulator. Use @code{-} to press several keys
564 a3a91a35 bellard
simultaneously. Example:
565 a3a91a35 bellard
@example
566 a3a91a35 bellard
sendkey ctrl-alt-f1
567 a3a91a35 bellard
@end example
568 a3a91a35 bellard
569 a3a91a35 bellard
This command is useful to send keys that your graphical user interface
570 a3a91a35 bellard
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
571 a3a91a35 bellard
572 15a34c63 bellard
@item system_reset
573 15a34c63 bellard
574 15a34c63 bellard
Reset the system.
575 15a34c63 bellard
576 1f673135 bellard
@end table
577 0806e3f6 bellard
578 1f673135 bellard
@subsection Integer expressions
579 1f673135 bellard
580 1f673135 bellard
The monitor understands integers expressions for every integer
581 1f673135 bellard
argument. You can use register names to get the value of specifics
582 1f673135 bellard
CPU registers by prefixing them with @emph{$}.
583 ec410fc9 bellard
584 1f47a922 bellard
@node disk_images
585 1f47a922 bellard
@section Disk Images
586 1f47a922 bellard
587 acd935ef bellard
Since version 0.6.1, QEMU supports many disk image formats, including
588 acd935ef bellard
growable disk images (their size increase as non empty sectors are
589 acd935ef bellard
written), compressed and encrypted disk images.
590 1f47a922 bellard
591 acd935ef bellard
@subsection Quick start for disk image creation
592 acd935ef bellard
593 acd935ef bellard
You can create a disk image with the command:
594 1f47a922 bellard
@example
595 acd935ef bellard
qemu-img create myimage.img mysize
596 1f47a922 bellard
@end example
597 acd935ef bellard
where @var{myimage.img} is the disk image filename and @var{mysize} is its
598 acd935ef bellard
size in kilobytes. You can add an @code{M} suffix to give the size in
599 acd935ef bellard
megabytes and a @code{G} suffix for gigabytes.
600 acd935ef bellard
601 acd935ef bellard
@xref{qemu_img_invocation} for more information.
602 1f47a922 bellard
603 1f47a922 bellard
@subsection Snapshot mode
604 1f47a922 bellard
605 1f47a922 bellard
If you use the option @option{-snapshot}, all disk images are
606 1f47a922 bellard
considered as read only. When sectors in written, they are written in
607 1f47a922 bellard
a temporary file created in @file{/tmp}. You can however force the
608 acd935ef bellard
write back to the raw disk images by using the @code{commit} monitor
609 acd935ef bellard
command (or @key{C-a s} in the serial console).
610 1f47a922 bellard
611 acd935ef bellard
@node qemu_img_invocation
612 acd935ef bellard
@subsection @code{qemu-img} Invocation
613 1f47a922 bellard
614 acd935ef bellard
@include qemu-img.texi
615 05efe46e bellard
616 9d4fb82e bellard
@section Network emulation
617 9d4fb82e bellard
618 9d4fb82e bellard
QEMU simulates up to 6 networks cards (NE2000 boards). Each card can
619 9d4fb82e bellard
be connected to a specific host network interface.
620 9d4fb82e bellard
621 9d4fb82e bellard
@subsection Using tun/tap network interface
622 9d4fb82e bellard
623 9d4fb82e bellard
This is the standard way to emulate network. QEMU adds a virtual
624 9d4fb82e bellard
network device on your host (called @code{tun0}), and you can then
625 9d4fb82e bellard
configure it as if it was a real ethernet card.
626 9d4fb82e bellard
627 9d4fb82e bellard
As an example, you can download the @file{linux-test-xxx.tar.gz}
628 9d4fb82e bellard
archive and copy the script @file{qemu-ifup} in @file{/etc} and
629 9d4fb82e bellard
configure properly @code{sudo} so that the command @code{ifconfig}
630 9d4fb82e bellard
contained in @file{qemu-ifup} can be executed as root. You must verify
631 9d4fb82e bellard
that your host kernel supports the TUN/TAP network interfaces: the
632 9d4fb82e bellard
device @file{/dev/net/tun} must be present.
633 9d4fb82e bellard
634 9d4fb82e bellard
See @ref{direct_linux_boot} to have an example of network use with a
635 9d4fb82e bellard
Linux distribution.
636 9d4fb82e bellard
637 9d4fb82e bellard
@subsection Using the user mode network stack
638 9d4fb82e bellard
639 443f1376 bellard
By using the option @option{-user-net} or if you have no tun/tap init
640 443f1376 bellard
script, QEMU uses a completely user mode network stack (you don't need
641 443f1376 bellard
root priviledge to use the virtual network). The virtual network
642 443f1376 bellard
configuration is the following:
643 9d4fb82e bellard
644 9d4fb82e bellard
@example
645 9d4fb82e bellard
646 9d4fb82e bellard
QEMU Virtual Machine    <------>  Firewall/DHCP server <-----> Internet
647 9d4fb82e bellard
     (10.0.2.x)            |          (10.0.2.2)
648 9d4fb82e bellard
                           |
649 2518bd0d bellard
                           ---->  DNS server (10.0.2.3)
650 2518bd0d bellard
                           |     
651 2518bd0d bellard
                           ---->  SMB server (10.0.2.4)
652 9d4fb82e bellard
@end example
653 9d4fb82e bellard
654 9d4fb82e bellard
The QEMU VM behaves as if it was behind a firewall which blocks all
655 9d4fb82e bellard
incoming connections. You can use a DHCP client to automatically
656 9d4fb82e bellard
configure the network in the QEMU VM.
657 9d4fb82e bellard
658 9d4fb82e bellard
In order to check that the user mode network is working, you can ping
659 9d4fb82e bellard
the address 10.0.2.2 and verify that you got an address in the range
660 9d4fb82e bellard
10.0.2.x from the QEMU virtual DHCP server.
661 9d4fb82e bellard
662 b415a407 bellard
Note that @code{ping} is not supported reliably to the internet as it
663 b415a407 bellard
would require root priviledges. It means you can only ping the local
664 b415a407 bellard
router (10.0.2.2).
665 b415a407 bellard
666 9bf05444 bellard
When using the built-in TFTP server, the router is also the TFTP
667 9bf05444 bellard
server.
668 9bf05444 bellard
669 9bf05444 bellard
When using the @option{-redir} option, TCP or UDP connections can be
670 9bf05444 bellard
redirected from the host to the guest. It allows for example to
671 9bf05444 bellard
redirect X11, telnet or SSH connections.
672 443f1376 bellard
673 9d4fb82e bellard
@node direct_linux_boot
674 9d4fb82e bellard
@section Direct Linux Boot
675 1f673135 bellard
676 1f673135 bellard
This section explains how to launch a Linux kernel inside QEMU without
677 1f673135 bellard
having to make a full bootable image. It is very useful for fast Linux
678 1f673135 bellard
kernel testing. The QEMU network configuration is also explained.
679 1f673135 bellard
680 1f673135 bellard
@enumerate
681 1f673135 bellard
@item
682 1f673135 bellard
Download the archive @file{linux-test-xxx.tar.gz} containing a Linux
683 1f673135 bellard
kernel and a disk image. 
684 1f673135 bellard
685 1f673135 bellard
@item Optional: If you want network support (for example to launch X11 examples), you
686 1f673135 bellard
must copy the script @file{qemu-ifup} in @file{/etc} and configure
687 1f673135 bellard
properly @code{sudo} so that the command @code{ifconfig} contained in
688 1f673135 bellard
@file{qemu-ifup} can be executed as root. You must verify that your host
689 1f673135 bellard
kernel supports the TUN/TAP network interfaces: the device
690 1f673135 bellard
@file{/dev/net/tun} must be present.
691 1f673135 bellard
692 1f673135 bellard
When network is enabled, there is a virtual network connection between
693 1f673135 bellard
the host kernel and the emulated kernel. The emulated kernel is seen
694 1f673135 bellard
from the host kernel at IP address 172.20.0.2 and the host kernel is
695 1f673135 bellard
seen from the emulated kernel at IP address 172.20.0.1.
696 1f673135 bellard
697 1f673135 bellard
@item Launch @code{qemu.sh}. You should have the following output:
698 1f673135 bellard
699 1f673135 bellard
@example
700 1f673135 bellard
> ./qemu.sh 
701 1f673135 bellard
Connected to host network interface: tun0
702 1f673135 bellard
Linux version 2.4.21 (bellard@voyager.localdomain) (gcc version 3.2.2 20030222 (Red Hat Linux 3.2.2-5)) #5 Tue Nov 11 18:18:53 CET 2003
703 1f673135 bellard
BIOS-provided physical RAM map:
704 1f673135 bellard
 BIOS-e801: 0000000000000000 - 000000000009f000 (usable)
705 1f673135 bellard
 BIOS-e801: 0000000000100000 - 0000000002000000 (usable)
706 1f673135 bellard
32MB LOWMEM available.
707 1f673135 bellard
On node 0 totalpages: 8192
708 1f673135 bellard
zone(0): 4096 pages.
709 1f673135 bellard
zone(1): 4096 pages.
710 1f673135 bellard
zone(2): 0 pages.
711 1f673135 bellard
Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe console=ttyS0
712 1f673135 bellard
ide_setup: ide2=noprobe
713 1f673135 bellard
ide_setup: ide3=noprobe
714 1f673135 bellard
ide_setup: ide4=noprobe
715 1f673135 bellard
ide_setup: ide5=noprobe
716 1f673135 bellard
Initializing CPU#0
717 1f673135 bellard
Detected 2399.621 MHz processor.
718 1f673135 bellard
Console: colour EGA 80x25
719 1f673135 bellard
Calibrating delay loop... 4744.80 BogoMIPS
720 1f673135 bellard
Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, 0k highmem)
721 1f673135 bellard
Dentry cache hash table entries: 4096 (order: 3, 32768 bytes)
722 1f673135 bellard
Inode cache hash table entries: 2048 (order: 2, 16384 bytes)
723 1f673135 bellard
Mount cache hash table entries: 512 (order: 0, 4096 bytes)
724 1f673135 bellard
Buffer-cache hash table entries: 1024 (order: 0, 4096 bytes)
725 1f673135 bellard
Page-cache hash table entries: 8192 (order: 3, 32768 bytes)
726 1f673135 bellard
CPU: Intel Pentium Pro stepping 03
727 1f673135 bellard
Checking 'hlt' instruction... OK.
728 1f673135 bellard
POSIX conformance testing by UNIFIX
729 1f673135 bellard
Linux NET4.0 for Linux 2.4
730 1f673135 bellard
Based upon Swansea University Computer Society NET3.039
731 1f673135 bellard
Initializing RT netlink socket
732 1f673135 bellard
apm: BIOS not found.
733 1f673135 bellard
Starting kswapd
734 1f673135 bellard
Journalled Block Device driver loaded
735 1f673135 bellard
Detected PS/2 Mouse Port.
736 1f673135 bellard
pty: 256 Unix98 ptys configured
737 1f673135 bellard
Serial driver version 5.05c (2001-07-08) with no serial options enabled
738 1f673135 bellard
ttyS00 at 0x03f8 (irq = 4) is a 16450
739 1f673135 bellard
ne.c:v1.10 9/23/94 Donald Becker (becker@scyld.com)
740 1f673135 bellard
Last modified Nov 1, 2000 by Paul Gortmaker
741 1f673135 bellard
NE*000 ethercard probe at 0x300: 52 54 00 12 34 56
742 1f673135 bellard
eth0: NE2000 found at 0x300, using IRQ 9.
743 1f673135 bellard
RAMDISK driver initialized: 16 RAM disks of 4096K size 1024 blocksize
744 1f673135 bellard
Uniform Multi-Platform E-IDE driver Revision: 7.00beta4-2.4
745 1f673135 bellard
ide: Assuming 50MHz system bus speed for PIO modes; override with idebus=xx
746 1f673135 bellard
hda: QEMU HARDDISK, ATA DISK drive
747 1f673135 bellard
ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
748 1f673135 bellard
hda: attached ide-disk driver.
749 1f673135 bellard
hda: 20480 sectors (10 MB) w/256KiB Cache, CHS=20/16/63
750 1f673135 bellard
Partition check:
751 1f673135 bellard
 hda:
752 1f673135 bellard
Soundblaster audio driver Copyright (C) by Hannu Savolainen 1993-1996
753 1f673135 bellard
NET4: Linux TCP/IP 1.0 for NET4.0
754 1f673135 bellard
IP Protocols: ICMP, UDP, TCP, IGMP
755 1f673135 bellard
IP: routing cache hash table of 512 buckets, 4Kbytes
756 1f673135 bellard
TCP: Hash tables configured (established 2048 bind 4096)
757 1f673135 bellard
NET4: Unix domain sockets 1.0/SMP for Linux NET4.0.
758 1f673135 bellard
EXT2-fs warning: mounting unchecked fs, running e2fsck is recommended
759 1f673135 bellard
VFS: Mounted root (ext2 filesystem).
760 1f673135 bellard
Freeing unused kernel memory: 64k freed
761 1f673135 bellard
 
762 1f673135 bellard
Linux version 2.4.21 (bellard@voyager.localdomain) (gcc version 3.2.2 20030222 (Red Hat Linux 3.2.2-5)) #5 Tue Nov 11 18:18:53 CET 2003
763 1f673135 bellard
 
764 1f673135 bellard
QEMU Linux test distribution (based on Redhat 9)
765 1f673135 bellard
 
766 1f673135 bellard
Type 'exit' to halt the system
767 1f673135 bellard
 
768 1f673135 bellard
sh-2.05b# 
769 1f673135 bellard
@end example
770 1f673135 bellard
771 1f673135 bellard
@item
772 1f673135 bellard
Then you can play with the kernel inside the virtual serial console. You
773 1f673135 bellard
can launch @code{ls} for example. Type @key{Ctrl-a h} to have an help
774 1f673135 bellard
about the keys you can type inside the virtual serial console. In
775 1f673135 bellard
particular, use @key{Ctrl-a x} to exit QEMU and use @key{Ctrl-a b} as
776 1f673135 bellard
the Magic SysRq key.
777 1f673135 bellard
778 1f673135 bellard
@item 
779 1f673135 bellard
If the network is enabled, launch the script @file{/etc/linuxrc} in the
780 1f673135 bellard
emulator (don't forget the leading dot):
781 1f673135 bellard
@example
782 1f673135 bellard
. /etc/linuxrc
783 1f673135 bellard
@end example
784 1f673135 bellard
785 1f673135 bellard
Then enable X11 connections on your PC from the emulated Linux: 
786 1f673135 bellard
@example
787 1f673135 bellard
xhost +172.20.0.2
788 1f673135 bellard
@end example
789 1f673135 bellard
790 1f673135 bellard
You can now launch @file{xterm} or @file{xlogo} and verify that you have
791 1f673135 bellard
a real Virtual Linux system !
792 1f673135 bellard
793 1f673135 bellard
@end enumerate
794 1f673135 bellard
795 1f673135 bellard
NOTES:
796 1f673135 bellard
@enumerate
797 1f673135 bellard
@item 
798 1f673135 bellard
A 2.5.74 kernel is also included in the archive. Just
799 1f673135 bellard
replace the bzImage in qemu.sh to try it.
800 1f673135 bellard
801 1f673135 bellard
@item 
802 1f673135 bellard
qemu-fast creates a temporary file in @var{$QEMU_TMPDIR} (@file{/tmp} is the
803 1f673135 bellard
default) containing all the simulated PC memory. If possible, try to use
804 1f673135 bellard
a temporary directory using the tmpfs filesystem to avoid too many
805 1f673135 bellard
unnecessary disk accesses.
806 1f673135 bellard
807 1f673135 bellard
@item 
808 1f673135 bellard
In order to exit cleanly from qemu, you can do a @emph{shutdown} inside
809 1f673135 bellard
qemu. qemu will automatically exit when the Linux shutdown is done.
810 1f673135 bellard
811 1f673135 bellard
@item 
812 1f673135 bellard
You can boot slightly faster by disabling the probe of non present IDE
813 1f673135 bellard
interfaces. To do so, add the following options on the kernel command
814 1f673135 bellard
line:
815 1f673135 bellard
@example
816 1f673135 bellard
ide1=noprobe ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe
817 1f673135 bellard
@end example
818 1f673135 bellard
819 1f673135 bellard
@item 
820 1f673135 bellard
The example disk image is a modified version of the one made by Kevin
821 1f673135 bellard
Lawton for the plex86 Project (@url{www.plex86.org}).
822 1f673135 bellard
823 1f673135 bellard
@end enumerate
824 1f673135 bellard
825 0806e3f6 bellard
@node linux_compile
826 4690764b bellard
@section Linux Kernel Compilation
827 4690764b bellard
828 285dc330 bellard
You can use any linux kernel with QEMU. However, if you want to use
829 1f673135 bellard
@code{qemu-fast} to get maximum performances, you must use a modified
830 1f673135 bellard
guest kernel. If you are using a 2.6 guest kernel, you can use
831 1f673135 bellard
directly the patch @file{linux-2.6-qemu-fast.patch} made by Rusty
832 1f673135 bellard
Russel available in the QEMU source archive. Otherwise, you can make the
833 1f673135 bellard
following changes @emph{by hand} to the Linux kernel:
834 1eb20527 bellard
835 4690764b bellard
@enumerate
836 4690764b bellard
@item
837 4690764b bellard
The kernel must be mapped at 0x90000000 (the default is
838 4690764b bellard
0xc0000000). You must modify only two lines in the kernel source:
839 1eb20527 bellard
840 4690764b bellard
In @file{include/asm/page.h}, replace
841 1eb20527 bellard
@example
842 1eb20527 bellard
#define __PAGE_OFFSET           (0xc0000000)
843 1eb20527 bellard
@end example
844 1eb20527 bellard
by
845 1eb20527 bellard
@example
846 1eb20527 bellard
#define __PAGE_OFFSET           (0x90000000)
847 1eb20527 bellard
@end example
848 1eb20527 bellard
849 4690764b bellard
And in @file{arch/i386/vmlinux.lds}, replace
850 1eb20527 bellard
@example
851 1eb20527 bellard
  . = 0xc0000000 + 0x100000;
852 1eb20527 bellard
@end example
853 1eb20527 bellard
by 
854 1eb20527 bellard
@example
855 1eb20527 bellard
  . = 0x90000000 + 0x100000;
856 1eb20527 bellard
@end example
857 1eb20527 bellard
858 4690764b bellard
@item
859 4690764b bellard
If you want to enable SMP (Symmetric Multi-Processing) support, you
860 4690764b bellard
must make the following change in @file{include/asm/fixmap.h}. Replace
861 1eb20527 bellard
@example
862 4690764b bellard
#define FIXADDR_TOP	(0xffffX000UL)
863 1eb20527 bellard
@end example
864 4690764b bellard
by 
865 4690764b bellard
@example
866 4690764b bellard
#define FIXADDR_TOP	(0xa7ffX000UL)
867 4690764b bellard
@end example
868 4690764b bellard
(X is 'e' or 'f' depending on the kernel version). Although you can
869 4690764b bellard
use an SMP kernel with QEMU, it only supports one CPU.
870 1eb20527 bellard
871 4690764b bellard
@item
872 1f673135 bellard
If you are not using a 2.6 kernel as host kernel but if you use a target
873 1f673135 bellard
2.6 kernel, you must also ensure that the 'HZ' define is set to 100
874 d5a0b50c bellard
(1000 is the default) as QEMU cannot currently emulate timers at
875 1f673135 bellard
frequencies greater than 100 Hz on host Linux systems < 2.6. In
876 4690764b bellard
@file{include/asm/param.h}, replace:
877 d5a0b50c bellard
878 d5a0b50c bellard
@example
879 d5a0b50c bellard
# define HZ		1000		/* Internal kernel timer frequency */
880 d5a0b50c bellard
@end example
881 d5a0b50c bellard
by
882 d5a0b50c bellard
@example
883 d5a0b50c bellard
# define HZ		100		/* Internal kernel timer frequency */
884 d5a0b50c bellard
@end example
885 d5a0b50c bellard
886 4690764b bellard
@end enumerate
887 4690764b bellard
888 4690764b bellard
The file config-2.x.x gives the configuration of the example kernels.
889 4690764b bellard
890 4690764b bellard
Just type
891 4690764b bellard
@example
892 4690764b bellard
make bzImage
893 4690764b bellard
@end example
894 4690764b bellard
895 4690764b bellard
As you would do to make a real kernel. Then you can use with QEMU
896 4690764b bellard
exactly the same kernel as you would boot on your PC (in
897 4690764b bellard
@file{arch/i386/boot/bzImage}).
898 da415d54 bellard
899 0806e3f6 bellard
@node gdb_usage
900 da415d54 bellard
@section GDB usage
901 da415d54 bellard
902 da415d54 bellard
QEMU has a primitive support to work with gdb, so that you can do
903 0806e3f6 bellard
'Ctrl-C' while the virtual machine is running and inspect its state.
904 da415d54 bellard
905 9d4520d0 bellard
In order to use gdb, launch qemu with the '-s' option. It will wait for a
906 da415d54 bellard
gdb connection:
907 da415d54 bellard
@example
908 6c9bf893 bellard
> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
909 da415d54 bellard
Connected to host network interface: tun0
910 da415d54 bellard
Waiting gdb connection on port 1234
911 da415d54 bellard
@end example
912 da415d54 bellard
913 da415d54 bellard
Then launch gdb on the 'vmlinux' executable:
914 da415d54 bellard
@example
915 da415d54 bellard
> gdb vmlinux
916 da415d54 bellard
@end example
917 da415d54 bellard
918 da415d54 bellard
In gdb, connect to QEMU:
919 da415d54 bellard
@example
920 6c9bf893 bellard
(gdb) target remote localhost:1234
921 da415d54 bellard
@end example
922 da415d54 bellard
923 da415d54 bellard
Then you can use gdb normally. For example, type 'c' to launch the kernel:
924 da415d54 bellard
@example
925 da415d54 bellard
(gdb) c
926 da415d54 bellard
@end example
927 da415d54 bellard
928 0806e3f6 bellard
Here are some useful tips in order to use gdb on system code:
929 0806e3f6 bellard
930 0806e3f6 bellard
@enumerate
931 0806e3f6 bellard
@item
932 0806e3f6 bellard
Use @code{info reg} to display all the CPU registers.
933 0806e3f6 bellard
@item
934 0806e3f6 bellard
Use @code{x/10i $eip} to display the code at the PC position.
935 0806e3f6 bellard
@item
936 0806e3f6 bellard
Use @code{set architecture i8086} to dump 16 bit code. Then use
937 0806e3f6 bellard
@code{x/10i $cs*16+*eip} to dump the code at the PC position.
938 0806e3f6 bellard
@end enumerate
939 0806e3f6 bellard
940 1a084f3d bellard
@section Target OS specific information
941 1a084f3d bellard
942 1a084f3d bellard
@subsection Linux
943 1a084f3d bellard
944 15a34c63 bellard
To have access to SVGA graphic modes under X11, use the @code{vesa} or
945 15a34c63 bellard
the @code{cirrus} X11 driver. For optimal performances, use 16 bit
946 15a34c63 bellard
color depth in the guest and the host OS.
947 1a084f3d bellard
948 e3371e62 bellard
When using a 2.6 guest Linux kernel, you should add the option
949 e3371e62 bellard
@code{clock=pit} on the kernel command line because the 2.6 Linux
950 e3371e62 bellard
kernels make very strict real time clock checks by default that QEMU
951 e3371e62 bellard
cannot simulate exactly.
952 e3371e62 bellard
953 1a084f3d bellard
@subsection Windows
954 1a084f3d bellard
955 1a084f3d bellard
If you have a slow host, using Windows 95 is better as it gives the
956 1a084f3d bellard
best speed. Windows 2000 is also a good choice.
957 1a084f3d bellard
958 e3371e62 bellard
@subsubsection SVGA graphic modes support
959 e3371e62 bellard
960 e3371e62 bellard
QEMU emulates a Cirrus Logic GD5446 Video
961 15a34c63 bellard
card. All Windows versions starting from Windows 95 should recognize
962 15a34c63 bellard
and use this graphic card. For optimal performances, use 16 bit color
963 15a34c63 bellard
depth in the guest and the host OS.
964 1a084f3d bellard
965 e3371e62 bellard
@subsubsection CPU usage reduction
966 e3371e62 bellard
967 e3371e62 bellard
Windows 9x does not correctly use the CPU HLT
968 15a34c63 bellard
instruction. The result is that it takes host CPU cycles even when
969 15a34c63 bellard
idle. You can install the utility from
970 15a34c63 bellard
@url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
971 15a34c63 bellard
problem. Note that no such tool is needed for NT, 2000 or XP.
972 1a084f3d bellard
973 e3371e62 bellard
@subsubsection Windows 2000 disk full problems
974 e3371e62 bellard
975 e3371e62 bellard
Currently (release 0.6.0) QEMU has a bug which gives a @code{disk
976 e3371e62 bellard
full} error during installation of some releases of Windows 2000. The
977 e3371e62 bellard
workaround is to stop QEMU as soon as you notice that your disk image
978 e3371e62 bellard
size is growing too fast (monitor it with @code{ls -ls}). Then
979 e3371e62 bellard
relaunch QEMU to continue the installation. If you still experience
980 e3371e62 bellard
the problem, relaunch QEMU again.
981 e3371e62 bellard
982 e3371e62 bellard
Future QEMU releases are likely to correct this bug.
983 e3371e62 bellard
984 e3371e62 bellard
@subsubsection Windows XP security problems
985 e3371e62 bellard
986 e3371e62 bellard
Some releases of Windows XP install correctly but give a security
987 e3371e62 bellard
error when booting:
988 e3371e62 bellard
@example
989 e3371e62 bellard
A problem is preventing Windows from accurately checking the
990 e3371e62 bellard
license for this computer. Error code: 0x800703e6.
991 e3371e62 bellard
@end example
992 e3371e62 bellard
The only known workaround is to boot in Safe mode
993 e3371e62 bellard
without networking support. 
994 e3371e62 bellard
995 e3371e62 bellard
Future QEMU releases are likely to correct this bug.
996 e3371e62 bellard
997 a0a821a4 bellard
@subsection MS-DOS and FreeDOS
998 a0a821a4 bellard
999 a0a821a4 bellard
@subsubsection CPU usage reduction
1000 a0a821a4 bellard
1001 a0a821a4 bellard
DOS does not correctly use the CPU HLT instruction. The result is that
1002 a0a821a4 bellard
it takes host CPU cycles even when idle. You can install the utility
1003 a0a821a4 bellard
from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1004 a0a821a4 bellard
problem.
1005 a0a821a4 bellard
1006 15a34c63 bellard
@chapter QEMU PowerPC System emulator invocation
1007 1a084f3d bellard
1008 15a34c63 bellard
Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1009 15a34c63 bellard
or PowerMac PowerPC system.
1010 1a084f3d bellard
1011 15a34c63 bellard
QEMU emulates the following PowerMac peripherials:
1012 1a084f3d bellard
1013 15a34c63 bellard
@itemize @minus
1014 15a34c63 bellard
@item 
1015 15a34c63 bellard
UniNorth PCI Bridge 
1016 15a34c63 bellard
@item
1017 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1018 15a34c63 bellard
@item 
1019 15a34c63 bellard
2 PMAC IDE interfaces with hard disk and CD-ROM support
1020 15a34c63 bellard
@item 
1021 15a34c63 bellard
NE2000 PCI adapters
1022 15a34c63 bellard
@item
1023 15a34c63 bellard
Non Volatile RAM
1024 15a34c63 bellard
@item
1025 15a34c63 bellard
VIA-CUDA with ADB keyboard and mouse.
1026 1a084f3d bellard
@end itemize
1027 1a084f3d bellard
1028 52c00a5f bellard
QEMU emulates the following PREP peripherials:
1029 52c00a5f bellard
1030 52c00a5f bellard
@itemize @minus
1031 52c00a5f bellard
@item 
1032 15a34c63 bellard
PCI Bridge
1033 15a34c63 bellard
@item
1034 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1035 15a34c63 bellard
@item 
1036 52c00a5f bellard
2 IDE interfaces with hard disk and CD-ROM support
1037 52c00a5f bellard
@item
1038 52c00a5f bellard
Floppy disk
1039 52c00a5f bellard
@item 
1040 15a34c63 bellard
NE2000 network adapters
1041 52c00a5f bellard
@item
1042 52c00a5f bellard
Serial port
1043 52c00a5f bellard
@item
1044 52c00a5f bellard
PREP Non Volatile RAM
1045 15a34c63 bellard
@item
1046 15a34c63 bellard
PC compatible keyboard and mouse.
1047 52c00a5f bellard
@end itemize
1048 52c00a5f bellard
1049 15a34c63 bellard
QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1050 15a34c63 bellard
@url{http://site.voila.fr/jmayer/OpenHackWare/index.htm}.
1051 15a34c63 bellard
1052 52c00a5f bellard
You can read the qemu PC system emulation chapter to have more
1053 52c00a5f bellard
informations about QEMU usage.
1054 52c00a5f bellard
1055 15a34c63 bellard
@c man begin OPTIONS
1056 15a34c63 bellard
1057 15a34c63 bellard
The following options are specific to the PowerPC emulation:
1058 15a34c63 bellard
1059 15a34c63 bellard
@table @option
1060 15a34c63 bellard
1061 15a34c63 bellard
@item -prep
1062 15a34c63 bellard
Simulate a PREP system (default is PowerMAC)
1063 15a34c63 bellard
1064 15a34c63 bellard
@item -g WxH[xDEPTH]  
1065 15a34c63 bellard
1066 15a34c63 bellard
Set the initial VGA graphic mode. The default is 800x600x15.
1067 15a34c63 bellard
1068 15a34c63 bellard
@end table
1069 15a34c63 bellard
1070 15a34c63 bellard
@c man end 
1071 15a34c63 bellard
1072 15a34c63 bellard
1073 52c00a5f bellard
More information is available at
1074 52c00a5f bellard
@url{http://jocelyn.mayer.free.fr/qemu-ppc/}.
1075 52c00a5f bellard
1076 1f673135 bellard
@chapter QEMU User space emulator invocation
1077 386405f7 bellard
1078 1f673135 bellard
@section Quick Start
1079 df0f11a0 bellard
1080 1f673135 bellard
In order to launch a Linux process, QEMU needs the process executable
1081 1f673135 bellard
itself and all the target (x86) dynamic libraries used by it. 
1082 386405f7 bellard
1083 1f673135 bellard
@itemize
1084 386405f7 bellard
1085 1f673135 bellard
@item On x86, you can just try to launch any process by using the native
1086 1f673135 bellard
libraries:
1087 386405f7 bellard
1088 1f673135 bellard
@example 
1089 1f673135 bellard
qemu-i386 -L / /bin/ls
1090 1f673135 bellard
@end example
1091 386405f7 bellard
1092 1f673135 bellard
@code{-L /} tells that the x86 dynamic linker must be searched with a
1093 1f673135 bellard
@file{/} prefix.
1094 386405f7 bellard
1095 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):
1096 386405f7 bellard
1097 1f673135 bellard
@example 
1098 1f673135 bellard
qemu-i386 -L / qemu-i386 -L / /bin/ls
1099 1f673135 bellard
@end example
1100 386405f7 bellard
1101 1f673135 bellard
@item On non x86 CPUs, you need first to download at least an x86 glibc
1102 1f673135 bellard
(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1103 1f673135 bellard
@code{LD_LIBRARY_PATH} is not set:
1104 df0f11a0 bellard
1105 1f673135 bellard
@example
1106 1f673135 bellard
unset LD_LIBRARY_PATH 
1107 1f673135 bellard
@end example
1108 1eb87257 bellard
1109 1f673135 bellard
Then you can launch the precompiled @file{ls} x86 executable:
1110 1eb87257 bellard
1111 1f673135 bellard
@example
1112 1f673135 bellard
qemu-i386 tests/i386/ls
1113 1f673135 bellard
@end example
1114 1f673135 bellard
You can look at @file{qemu-binfmt-conf.sh} so that
1115 1f673135 bellard
QEMU is automatically launched by the Linux kernel when you try to
1116 1f673135 bellard
launch x86 executables. It requires the @code{binfmt_misc} module in the
1117 1f673135 bellard
Linux kernel.
1118 1eb87257 bellard
1119 1f673135 bellard
@item The x86 version of QEMU is also included. You can try weird things such as:
1120 1f673135 bellard
@example
1121 1f673135 bellard
qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1122 1f673135 bellard
@end example
1123 1eb20527 bellard
1124 1f673135 bellard
@end itemize
1125 1eb20527 bellard
1126 1f673135 bellard
@section Wine launch
1127 1eb20527 bellard
1128 1f673135 bellard
@itemize
1129 386405f7 bellard
1130 1f673135 bellard
@item Ensure that you have a working QEMU with the x86 glibc
1131 1f673135 bellard
distribution (see previous section). In order to verify it, you must be
1132 1f673135 bellard
able to do:
1133 386405f7 bellard
1134 1f673135 bellard
@example
1135 1f673135 bellard
qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1136 1f673135 bellard
@end example
1137 386405f7 bellard
1138 1f673135 bellard
@item Download the binary x86 Wine install
1139 1f673135 bellard
(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page). 
1140 386405f7 bellard
1141 1f673135 bellard
@item Configure Wine on your account. Look at the provided script
1142 1f673135 bellard
@file{/usr/local/qemu-i386/bin/wine-conf.sh}. Your previous
1143 1f673135 bellard
@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1144 386405f7 bellard
1145 1f673135 bellard
@item Then you can try the example @file{putty.exe}:
1146 386405f7 bellard
1147 1f673135 bellard
@example
1148 1f673135 bellard
qemu-i386 /usr/local/qemu-i386/wine/bin/wine /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1149 1f673135 bellard
@end example
1150 386405f7 bellard
1151 1f673135 bellard
@end itemize
1152 fd429f2f bellard
1153 1f673135 bellard
@section Command line options
1154 1eb20527 bellard
1155 1f673135 bellard
@example
1156 1f673135 bellard
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1157 1f673135 bellard
@end example
1158 1eb20527 bellard
1159 1f673135 bellard
@table @option
1160 1f673135 bellard
@item -h
1161 1f673135 bellard
Print the help
1162 1f673135 bellard
@item -L path   
1163 1f673135 bellard
Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1164 1f673135 bellard
@item -s size
1165 1f673135 bellard
Set the x86 stack size in bytes (default=524288)
1166 386405f7 bellard
@end table
1167 386405f7 bellard
1168 1f673135 bellard
Debug options:
1169 386405f7 bellard
1170 1f673135 bellard
@table @option
1171 1f673135 bellard
@item -d
1172 1f673135 bellard
Activate log (logfile=/tmp/qemu.log)
1173 1f673135 bellard
@item -p pagesize
1174 1f673135 bellard
Act as if the host page size was 'pagesize' bytes
1175 1f673135 bellard
@end table
1176 386405f7 bellard
1177 15a34c63 bellard
@node compilation
1178 15a34c63 bellard
@chapter Compilation from the sources
1179 15a34c63 bellard
1180 15a34c63 bellard
@section Linux/BSD
1181 15a34c63 bellard
1182 15a34c63 bellard
Read the @file{README} which gives the related information.
1183 15a34c63 bellard
1184 15a34c63 bellard
@section Windows
1185 15a34c63 bellard
1186 15a34c63 bellard
@itemize
1187 15a34c63 bellard
@item Install the current versions of MSYS and MinGW from
1188 15a34c63 bellard
@url{http://www.mingw.org/}. You can find detailed installation
1189 15a34c63 bellard
instructions in the download section and the FAQ.
1190 15a34c63 bellard
1191 15a34c63 bellard
@item Download 
1192 15a34c63 bellard
the MinGW development library of SDL 1.2.x
1193 15a34c63 bellard
(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
1194 15a34c63 bellard
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
1195 15a34c63 bellard
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1196 15a34c63 bellard
directory. Edit the @file{sdl-config} script so that it gives the
1197 15a34c63 bellard
correct SDL directory when invoked.
1198 15a34c63 bellard
1199 15a34c63 bellard
@item Extract the current version of QEMU.
1200 15a34c63 bellard
 
1201 15a34c63 bellard
@item Start the MSYS shell (file @file{msys.bat}).
1202 15a34c63 bellard
1203 15a34c63 bellard
@item Change to the QEMU directory. Launch @file{./configure} and 
1204 15a34c63 bellard
@file{make}.  If you have problems using SDL, verify that
1205 15a34c63 bellard
@file{sdl-config} can be launched from the MSYS command line.
1206 15a34c63 bellard
1207 15a34c63 bellard
@item You can install QEMU in @file{Program Files/Qemu} by typing 
1208 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in
1209 15a34c63 bellard
@file{Program Files/Qemu}.
1210 15a34c63 bellard
1211 15a34c63 bellard
@end itemize
1212 15a34c63 bellard
1213 15a34c63 bellard
@section Cross compilation for Windows with Linux
1214 15a34c63 bellard
1215 15a34c63 bellard
@itemize
1216 15a34c63 bellard
@item
1217 15a34c63 bellard
Install the MinGW cross compilation tools available at
1218 15a34c63 bellard
@url{http://www.mingw.org/}.
1219 15a34c63 bellard
1220 15a34c63 bellard
@item 
1221 15a34c63 bellard
Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1222 15a34c63 bellard
unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1223 15a34c63 bellard
variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1224 15a34c63 bellard
the QEMU configuration script.
1225 15a34c63 bellard
1226 15a34c63 bellard
@item 
1227 15a34c63 bellard
Configure QEMU for Windows cross compilation:
1228 15a34c63 bellard
@example
1229 15a34c63 bellard
./configure --enable-mingw32
1230 15a34c63 bellard
@end example
1231 15a34c63 bellard
If necessary, you can change the cross-prefix according to the prefix
1232 15a34c63 bellard
choosen for the MinGW tools with --cross-prefix. You can also use
1233 15a34c63 bellard
--prefix to set the Win32 install path.
1234 15a34c63 bellard
1235 15a34c63 bellard
@item You can install QEMU in the installation directory by typing 
1236 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in the
1237 15a34c63 bellard
installation directory. 
1238 15a34c63 bellard
1239 15a34c63 bellard
@end itemize
1240 15a34c63 bellard
1241 15a34c63 bellard
Note: Currently, Wine does not seem able to launch
1242 15a34c63 bellard
QEMU for Win32.
1243 15a34c63 bellard
1244 15a34c63 bellard
@section Mac OS X
1245 15a34c63 bellard
1246 15a34c63 bellard
The Mac OS X patches are not fully merged in QEMU, so you should look
1247 15a34c63 bellard
at the QEMU mailing list archive to have all the necessary
1248 15a34c63 bellard
information.