Statistics
| Branch: | Revision:

root / qemu-doc.texi @ 3e11db9a

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