qemu-doc.texi 24.4 KB
Newer Older
B
bellard 已提交
1 2
\input texinfo @c -*- texinfo -*-

B
updated  
bellard 已提交
3
@iftex
B
bellard 已提交
4
@settitle QEMU CPU Emulator User Documentation
B
bellard 已提交
5 6
@titlepage
@sp 7
B
bellard 已提交
7
@center @titlefont{QEMU CPU Emulator User Documentation}
B
bellard 已提交
8 9
@sp 3
@end titlepage
B
updated  
bellard 已提交
10
@end iftex
B
bellard 已提交
11 12 13

@chapter Introduction

B
update  
bellard 已提交
14
@section Features
B
bellard 已提交
15

B
bellard 已提交
16 17
QEMU is a FAST! processor emulator using dynamic translation to
achieve good emulation speed.
B
update  
bellard 已提交
18 19

QEMU has two operating modes:
B
updated  
bellard 已提交
20 21 22 23

@itemize @minus

@item 
B
bellard 已提交
24 25 26 27
Full system emulation. In this mode, QEMU emulates a full system (for
example a PC), including a processor and various peripherials. It can
be used to launch different Operating Systems without rebooting the
PC or to debug system code.
B
update  
bellard 已提交
28

B
updated  
bellard 已提交
29
@item 
B
bellard 已提交
30 31 32 33
User mode emulation (Linux host only). In this mode, QEMU can launch
Linux processes compiled for one CPU on another CPU. It can be used to
launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
to ease cross-compilation and cross-debugging.
B
update  
bellard 已提交
34 35 36

@end itemize

B
bellard 已提交
37
As QEMU requires no host kernel driver to run, it is very safe and
B
update  
bellard 已提交
38
easy to use.
B
update  
bellard 已提交
39

B
bellard 已提交
40 41
For system emulation, only the x86 PC emulator is currently
usable. The PowerPC system emulator is being developped.
B
bellard 已提交
42

B
bellard 已提交
43
For user emulation, x86, PowerPC, ARM, and SPARC CPUs are supported.
B
updated  
bellard 已提交
44

B
update  
bellard 已提交
45 46
@chapter Installation

B
bellard 已提交
47 48
@section Linux

B
update  
bellard 已提交
49 50 51 52 53 54 55 56 57 58 59
If you want to compile QEMU, please read the @file{README} which gives
the related information. Otherwise just download the binary
distribution (@file{qemu-XXX-i386.tar.gz}) and untar it as root in
@file{/}:

@example
su
cd /
tar zxvf /tmp/qemu-XXX-i386.tar.gz
@end example

B
bellard 已提交
60 61
@section Windows
w
62
@itemize
B
bellard 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
@item Install the current versions of MSYS and MinGW from
@url{http://www.mingw.org/}. You can find detailed installation
instructions in the download section and the FAQ.

@item Download 
the MinGW development library of SDL 1.2.x
(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
directory. Edit the @file{sdl-config} script so that it gives the
correct SDL directory when invoked.

@item Extract the current version of QEMU.
 
@item Start the MSYS shell (file @file{msys.bat}).
B
bellard 已提交
78

B
bellard 已提交
79 80 81
@item Change to the QEMU directory. Launch @file{./configure} and 
@file{make}.  If you have problems using SDL, verify that
@file{sdl-config} can be launched from the MSYS command line.
B
bellard 已提交
82

B
bellard 已提交
83 84 85
@item You can install QEMU in @file{Program Files/Qemu} by typing 
@file{make install}. Don't forget to copy @file{SDL.dll} in
@file{Program Files/Qemu}.
B
update  
bellard 已提交
86

B
bellard 已提交
87 88
@end itemize

B
bellard 已提交
89
@section Cross compilation for Windows with Linux
B
bellard 已提交
90 91

@itemize
B
bellard 已提交
92 93 94
@item
Install the MinGW cross compilation tools available at
@url{http://www.mingw.org/}.
B
bellard 已提交
95

B
bellard 已提交
96 97 98 99 100
@item 
Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
the QEMU configuration script.
B
bellard 已提交
101

B
bellard 已提交
102 103
@item 
Configure QEMU for Windows cross compilation:
B
bellard 已提交
104
@example
B
bellard 已提交
105
./configure --enable-mingw32
B
bellard 已提交
106
@end example
B
bellard 已提交
107 108 109
If necessary, you can change the cross-prefix according to the prefix
choosen for the MinGW tools with --cross-prefix. You can also use
--prefix to set the Win32 install path.
B
bellard 已提交
110

B
bellard 已提交
111 112 113
@item You can install QEMU in the installation directory by typing 
@file{make install}. Don't forget to copy @file{SDL.dll} in the
installation directory. 
114 115 116

@end itemize

B
bellard 已提交
117 118
Note: Currently, Wine does not seem able to launch
QEMU for Win32.
119

B
bellard 已提交
120
@section Mac OS X
121

B
bellard 已提交
122
Mac OS X is currently not supported.
B
update  
bellard 已提交
123

B
update  
bellard 已提交
124 125
@chapter QEMU System emulator invocation

B
updated  
bellard 已提交
126 127 128 129
@section Introduction

@c man begin DESCRIPTION

B
bellard 已提交
130
The QEMU System emulator simulates a complete PC. 
B
updated  
bellard 已提交
131 132 133 134 135 136 137

In order to meet specific user needs, two versions of QEMU are
available:

@enumerate

@item 
B
update  
bellard 已提交
138
@code{qemu-fast} uses the host Memory Management Unit (MMU) to simulate 
B
updated  
bellard 已提交
139 140 141 142 143 144
the x86 MMU. It is @emph{fast} but has limitations because the whole 4 GB
address space cannot be used and some memory mapped peripherials
cannot be emulated accurately yet. Therefore, a specific Linux kernel
must be used (@xref{linux_compile}).

@item 
B
update  
bellard 已提交
145 146
@code{qemu} uses a software MMU. It is about @emph{two times 
slower} but gives a more accurate emulation. 
B
updated  
bellard 已提交
147 148 149 150 151 152 153 154 155 156 157

@end enumerate

QEMU emulates the following PC peripherials:

@itemize @minus
@item
VGA (hardware level, including all non standard modes)
@item
PS/2 mouse and keyboard
@item 
B
update  
bellard 已提交
158
2 IDE interfaces with hard disk and CD-ROM support
B
bellard 已提交
159 160
@item
Floppy disk
B
updated  
bellard 已提交
161
@item 
B
bellard 已提交
162
up to 6 NE2000 network adapters
B
updated  
bellard 已提交
163
@item
B
update  
bellard 已提交
164 165 166
Serial port
@item 
Soundblaster 16 card
B
updated  
bellard 已提交
167 168 169 170
@end itemize

@c man end

B
update  
bellard 已提交
171 172
@section Quick Start

B
update  
bellard 已提交
173
Download and uncompress the linux image (@file{linux.img}) and type:
B
updated  
bellard 已提交
174 175

@example
B
update  
bellard 已提交
176
qemu linux.img
B
updated  
bellard 已提交
177 178 179 180
@end example

Linux should boot and give you a prompt.

B
update  
bellard 已提交
181 182 183
@section Invocation

@example
B
updated  
bellard 已提交
184 185 186
@c man begin SYNOPSIS
usage: qemu [options] [disk_image]
@c man end
B
update  
bellard 已提交
187 188
@end example

B
updated  
bellard 已提交
189
@c man begin OPTIONS
B
update  
bellard 已提交
190
@var{disk_image} is a raw hard disk image for IDE hard disk 0.
B
update  
bellard 已提交
191 192 193

General options:
@table @option
B
update  
bellard 已提交
194 195 196 197
@item -fda file
@item -fdb file
Use @var{file} as floppy disk 0/1 image (@xref{disk_images}).

B
update  
bellard 已提交
198 199
@item -hda file
@item -hdb file
B
update  
bellard 已提交
200 201
@item -hdc file
@item -hdd file
B
update  
bellard 已提交
202
Use @var{file} as hard disk 0, 1, 2 or 3 image (@xref{disk_images}).
B
bellard 已提交
203

B
update  
bellard 已提交
204 205 206 207
@item -cdrom file
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
@option{-cdrom} at the same time).

B
bellard 已提交
208 209
@item -boot [a|c|d]
Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
B
update  
bellard 已提交
210
the default.
B
bellard 已提交
211

B
update  
bellard 已提交
212
@item -snapshot
B
bellard 已提交
213 214 215
Write to temporary files instead of disk image files. In this case,
the raw disk image you use is not written back. You can however force
the write back by pressing @key{C-a s} (@xref{disk_images}). 
B
update  
bellard 已提交
216 217 218 219

@item -m megs
Set virtual RAM size to @var{megs} megabytes.

B
update  
bellard 已提交
220
@item -initrd file
B
updated  
bellard 已提交
221 222 223 224 225 226 227 228 229 230 231 232
Use @var{file} as initial ram disk.

@item -nographic

Normally, QEMU uses SDL to display the VGA output. With this option,
you can totally disable graphical output so that QEMU is a simple
command line application. The emulated serial port is redirected on
the console. Therefore, you can still use QEMU to debug a Linux kernel
with a serial console.

@end table

B
bellard 已提交
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
Network options:

@table @option

@item -n script      
Set network init script [default=/etc/qemu-ifup]. This script is
launched to configure the host network interface (usually tun0)
corresponding to the virtual NE2000 card.

@item nics n
Simulate @var{n} network interfaces (default=1).

@item -macaddr addr   

Set the mac address of the first interface (the format is
aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each
new network interface.

@item -tun-fd fd1,...
Assumes @var{fd} talks to tap/tun and use it. Read
@url{http://bellard.org/qemu/tetrinet.html} to have an example of its
use.

@end table

Linux boot specific. When using this options, you can use a given
Linux kernel without installing it in the disk image. It can be useful
for easier testing of various kernels.

B
updated  
bellard 已提交
262 263 264 265 266 267 268 269 270 271 272
@table @option

@item -kernel bzImage 
Use @var{bzImage} as kernel image.

@item -append cmdline 
Use @var{cmdline} as kernel command line

@item -initrd file
Use @var{file} as initial ram disk.

B
update  
bellard 已提交
273 274 275 276 277
@end table

Debug options:
@table @option
@item -s
B
updated  
bellard 已提交
278
Wait gdb connection to port 1234 (@xref{gdb_usage}). 
B
update  
bellard 已提交
279 280 281
@item -p port
Change gdb connection port.
@item -d             
B
update  
bellard 已提交
282
Output log in /tmp/qemu.log
B
update  
bellard 已提交
283 284
@end table

B
bellard 已提交
285 286
During emulation, if you are using the serial console, use @key{C-a h}
to get terminal commands:
B
update  
bellard 已提交
287 288 289 290 291 292

@table @key
@item C-a h
Print this help
@item C-a x    
Exit emulatior
B
bellard 已提交
293 294 295
@item C-a s    
Save disk data back to file (if -snapshot)
@item C-a b
B
bellard 已提交
296 297 298
Send break (magic sysrq in Linux)
@item C-a c
Switch between console and monitor
B
bellard 已提交
299
@item C-a C-a
B
update  
bellard 已提交
300 301
Send C-a
@end table
B
updated  
bellard 已提交
302 303 304 305 306 307 308
@c man end

@ignore

@setfilename qemu 
@settitle QEMU System Emulator

B
bellard 已提交
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
@c man begin SEEALSO
The HTML documentation of QEMU for more precise information and Linux
user mode emulator invocation.
@c man end

@c man begin AUTHOR
Fabrice Bellard
@c man end

@end ignore

@end ignore


@section QEMU Monitor

The QEMU monitor is used to give complex commands to the QEMU
emulator. You can use it to:

@itemize @minus

@item
Remove or insert removable medias images
(such as CD-ROM or floppies)

@item 
Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
from a disk file.

@item Inspect the VM state without an external debugger.

@end itemize

@subsection Commands

The following commands are available:

@table @option

@item help or ? [cmd]
Show the help for all commands or just for command @var{cmd}.

@item commit  
Commit changes to the disk images (if -snapshot is used)

@item info subcommand 
show various information about the system state

@table @option
@item info network
show the network state
@item info block
show the block devices
@item info registers
show the cpu registers
@item info history
show the command line history
@end table

@item q or quit
Quit the emulator.

@item eject [-f] device
Eject a removable media (use -f to force it).

@item change device filename
Change a removable media.

@item screendump filename
Save screen into PPM image @var{filename}.

@item log item1[,...]
Activate logging of the specified items to @file{/tmp/qemu.log}.

@item savevm filename
Save the whole virtual machine state to @var{filename}.

@item loadvm filename
Restore the whole virtual machine state from @var{filename}.

@item stop
Stop emulation.

@item c or cont
Resume emulation.

@item gdbserver [port]
Start gdbserver session (default port=1234)

@item x/fmt addr
Virtual memory dump starting at @var{addr}.

@item xp /fmt addr
Physical memory dump starting at @var{addr}.

@var{fmt} is a format which tells the command how to format the
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}

@table @var
@item count 
is the number of items to be dumped.

@item format
can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
c (char) or i (asm instruction).

@item size
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits)

@end table

Examples: 
@itemize
@item
Dump 10 instructions at the current instruction pointer:
@example 
(qemu) x/10i $eip
0x90107063:  ret
0x90107064:  sti
0x90107065:  lea    0x0(%esi,1),%esi
0x90107069:  lea    0x0(%edi,1),%edi
0x90107070:  ret
0x90107071:  jmp    0x90107080
0x90107073:  nop
0x90107074:  nop
0x90107075:  nop
0x90107076:  nop
@end example

@item
Dump 80 16 bit values at the start of the video memory.
@example 
(qemu) xp/80hx 0xb8000
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
@end example
@end itemize

@item p or print/fmt expr

Print expression value. Only the @var{format} part of @var{fmt} is
used.
B
updated  
bellard 已提交
459

B
bellard 已提交
460
@end table
B
updated  
bellard 已提交
461

B
bellard 已提交
462 463 464 465 466
@subsection Integer expressions

The monitor understands integers expressions for every integer
argument. You can use register names to get the value of specifics
CPU registers by prefixing them with @emph{$}.
B
update  
bellard 已提交
467

B
bellard 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
@node disk_images
@section Disk Images

@subsection Raw disk images

The disk images can simply be raw images of the hard disk. You can
create them with the command:
@example
dd if=/dev/zero of=myimage bs=1024 count=mysize
@end example
where @var{myimage} is the image filename and @var{mysize} is its size
in kilobytes.

@subsection Snapshot mode

If you use the option @option{-snapshot}, all disk images are
considered as read only. When sectors in written, they are written in
a temporary file created in @file{/tmp}. You can however force the
write back to the raw disk images by pressing @key{C-a s}.

NOTE: The snapshot mode only works with raw disk images.

@subsection Copy On Write disk images

QEMU also supports user mode Linux
(@url{http://user-mode-linux.sourceforge.net/}) Copy On Write (COW)
disk images. The COW disk images are much smaller than normal images
as they store only modified sectors. They also permit the use of the
same disk image template for many users.

To create a COW disk images, use the command:

@example
B
updated  
bellard 已提交
501
qemu-mkcow -f myrawimage.bin mycowimage.cow
B
bellard 已提交
502 503 504 505 506 507
@end example

@file{myrawimage.bin} is a raw image you want to use as original disk
image. It will never be written to.

@file{mycowimage.cow} is the COW disk image which is created by
B
updated  
bellard 已提交
508
@code{qemu-mkcow}. You can use it directly with the @option{-hdx}
B
bellard 已提交
509 510 511 512 513 514
options. You must not modify the original raw disk image if you use
COW images, as COW images only store the modified sectors from the raw
disk image. QEMU stores the original raw disk image name and its
modified time in the COW disk image so that chances of mistakes are
reduced.

B
update  
bellard 已提交
515 516 517
If the raw disk image is not read-only, by pressing @key{C-a s} you
can flush the COW disk image back into the raw disk image, as in
snapshot mode.
B
bellard 已提交
518 519 520 521 522 523

COW disk images can also be created without a corresponding raw disk
image. It is useful to have a big initial virtual disk image without
using much disk space. Use:

@example
B
updated  
bellard 已提交
524
qemu-mkcow mycowimage.cow 1024
B
bellard 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538
@end example

to create a 1 gigabyte empty COW disk image.

NOTES: 
@enumerate
@item
COW disk images must be created on file systems supporting
@emph{holes} such as ext2 or ext3.
@item 
Since holes are used, the displayed size of the COW disk image is not
the real one. To know it, use the @code{ls -ls} command.
@end enumerate

B
bellard 已提交
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
@section Direct Linux Boot and Network emulation

This section explains how to launch a Linux kernel inside QEMU without
having to make a full bootable image. It is very useful for fast Linux
kernel testing. The QEMU network configuration is also explained.

@enumerate
@item
Download the archive @file{linux-test-xxx.tar.gz} containing a Linux
kernel and a disk image. 

@item Optional: If you want network support (for example to launch X11 examples), you
must copy the script @file{qemu-ifup} in @file{/etc} and configure
properly @code{sudo} so that the command @code{ifconfig} contained in
@file{qemu-ifup} can be executed as root. You must verify that your host
kernel supports the TUN/TAP network interfaces: the device
@file{/dev/net/tun} must be present.

When network is enabled, there is a virtual network connection between
the host kernel and the emulated kernel. The emulated kernel is seen
from the host kernel at IP address 172.20.0.2 and the host kernel is
seen from the emulated kernel at IP address 172.20.0.1.

@item Launch @code{qemu.sh}. You should have the following output:

@example
> ./qemu.sh 
Connected to host network interface: tun0
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
BIOS-provided physical RAM map:
 BIOS-e801: 0000000000000000 - 000000000009f000 (usable)
 BIOS-e801: 0000000000100000 - 0000000002000000 (usable)
32MB LOWMEM available.
On node 0 totalpages: 8192
zone(0): 4096 pages.
zone(1): 4096 pages.
zone(2): 0 pages.
Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe console=ttyS0
ide_setup: ide2=noprobe
ide_setup: ide3=noprobe
ide_setup: ide4=noprobe
ide_setup: ide5=noprobe
Initializing CPU#0
Detected 2399.621 MHz processor.
Console: colour EGA 80x25
Calibrating delay loop... 4744.80 BogoMIPS
Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, 0k highmem)
Dentry cache hash table entries: 4096 (order: 3, 32768 bytes)
Inode cache hash table entries: 2048 (order: 2, 16384 bytes)
Mount cache hash table entries: 512 (order: 0, 4096 bytes)
Buffer-cache hash table entries: 1024 (order: 0, 4096 bytes)
Page-cache hash table entries: 8192 (order: 3, 32768 bytes)
CPU: Intel Pentium Pro stepping 03
Checking 'hlt' instruction... OK.
POSIX conformance testing by UNIFIX
Linux NET4.0 for Linux 2.4
Based upon Swansea University Computer Society NET3.039
Initializing RT netlink socket
apm: BIOS not found.
Starting kswapd
Journalled Block Device driver loaded
Detected PS/2 Mouse Port.
pty: 256 Unix98 ptys configured
Serial driver version 5.05c (2001-07-08) with no serial options enabled
ttyS00 at 0x03f8 (irq = 4) is a 16450
ne.c:v1.10 9/23/94 Donald Becker (becker@scyld.com)
Last modified Nov 1, 2000 by Paul Gortmaker
NE*000 ethercard probe at 0x300: 52 54 00 12 34 56
eth0: NE2000 found at 0x300, using IRQ 9.
RAMDISK driver initialized: 16 RAM disks of 4096K size 1024 blocksize
Uniform Multi-Platform E-IDE driver Revision: 7.00beta4-2.4
ide: Assuming 50MHz system bus speed for PIO modes; override with idebus=xx
hda: QEMU HARDDISK, ATA DISK drive
ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
hda: attached ide-disk driver.
hda: 20480 sectors (10 MB) w/256KiB Cache, CHS=20/16/63
Partition check:
 hda:
Soundblaster audio driver Copyright (C) by Hannu Savolainen 1993-1996
NET4: Linux TCP/IP 1.0 for NET4.0
IP Protocols: ICMP, UDP, TCP, IGMP
IP: routing cache hash table of 512 buckets, 4Kbytes
TCP: Hash tables configured (established 2048 bind 4096)
NET4: Unix domain sockets 1.0/SMP for Linux NET4.0.
EXT2-fs warning: mounting unchecked fs, running e2fsck is recommended
VFS: Mounted root (ext2 filesystem).
Freeing unused kernel memory: 64k freed
 
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
 
QEMU Linux test distribution (based on Redhat 9)
 
Type 'exit' to halt the system
 
sh-2.05b# 
@end example

@item
Then you can play with the kernel inside the virtual serial console. You
can launch @code{ls} for example. Type @key{Ctrl-a h} to have an help
about the keys you can type inside the virtual serial console. In
particular, use @key{Ctrl-a x} to exit QEMU and use @key{Ctrl-a b} as
the Magic SysRq key.

@item 
If the network is enabled, launch the script @file{/etc/linuxrc} in the
emulator (don't forget the leading dot):
@example
. /etc/linuxrc
@end example

Then enable X11 connections on your PC from the emulated Linux: 
@example
xhost +172.20.0.2
@end example

You can now launch @file{xterm} or @file{xlogo} and verify that you have
a real Virtual Linux system !

@end enumerate

NOTES:
@enumerate
@item 
A 2.5.74 kernel is also included in the archive. Just
replace the bzImage in qemu.sh to try it.

@item 
qemu-fast creates a temporary file in @var{$QEMU_TMPDIR} (@file{/tmp} is the
default) containing all the simulated PC memory. If possible, try to use
a temporary directory using the tmpfs filesystem to avoid too many
unnecessary disk accesses.

@item 
In order to exit cleanly from qemu, you can do a @emph{shutdown} inside
qemu. qemu will automatically exit when the Linux shutdown is done.

@item 
You can boot slightly faster by disabling the probe of non present IDE
interfaces. To do so, add the following options on the kernel command
line:
@example
ide1=noprobe ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe
@end example

@item 
The example disk image is a modified version of the one made by Kevin
Lawton for the plex86 Project (@url{www.plex86.org}).

@end enumerate

B
updated  
bellard 已提交
690
@node linux_compile
B
update  
bellard 已提交
691 692
@section Linux Kernel Compilation

B
update  
bellard 已提交
693
You can use any linux kernel with QEMU. However, if you want to use
B
bellard 已提交
694 695 696 697 698
@code{qemu-fast} to get maximum performances, you must use a modified
guest kernel. If you are using a 2.6 guest kernel, you can use
directly the patch @file{linux-2.6-qemu-fast.patch} made by Rusty
Russel available in the QEMU source archive. Otherwise, you can make the
following changes @emph{by hand} to the Linux kernel:
B
update  
bellard 已提交
699

B
update  
bellard 已提交
700 701 702 703
@enumerate
@item
The kernel must be mapped at 0x90000000 (the default is
0xc0000000). You must modify only two lines in the kernel source:
B
update  
bellard 已提交
704

B
update  
bellard 已提交
705
In @file{include/asm/page.h}, replace
B
update  
bellard 已提交
706 707 708 709 710 711 712 713
@example
#define __PAGE_OFFSET           (0xc0000000)
@end example
by
@example
#define __PAGE_OFFSET           (0x90000000)
@end example

B
update  
bellard 已提交
714
And in @file{arch/i386/vmlinux.lds}, replace
B
update  
bellard 已提交
715 716 717 718 719 720 721 722
@example
  . = 0xc0000000 + 0x100000;
@end example
by 
@example
  . = 0x90000000 + 0x100000;
@end example

B
update  
bellard 已提交
723 724 725
@item
If you want to enable SMP (Symmetric Multi-Processing) support, you
must make the following change in @file{include/asm/fixmap.h}. Replace
B
update  
bellard 已提交
726
@example
B
update  
bellard 已提交
727
#define FIXADDR_TOP	(0xffffX000UL)
B
update  
bellard 已提交
728
@end example
B
update  
bellard 已提交
729 730 731 732 733 734
by 
@example
#define FIXADDR_TOP	(0xa7ffX000UL)
@end example
(X is 'e' or 'f' depending on the kernel version). Although you can
use an SMP kernel with QEMU, it only supports one CPU.
B
update  
bellard 已提交
735

B
update  
bellard 已提交
736
@item
B
bellard 已提交
737 738
If you are not using a 2.6 kernel as host kernel but if you use a target
2.6 kernel, you must also ensure that the 'HZ' define is set to 100
B
update  
bellard 已提交
739
(1000 is the default) as QEMU cannot currently emulate timers at
B
bellard 已提交
740
frequencies greater than 100 Hz on host Linux systems < 2.6. In
B
update  
bellard 已提交
741
@file{include/asm/param.h}, replace:
B
update  
bellard 已提交
742 743 744 745 746 747 748 749 750

@example
# define HZ		1000		/* Internal kernel timer frequency */
@end example
by
@example
# define HZ		100		/* Internal kernel timer frequency */
@end example

B
update  
bellard 已提交
751 752 753 754 755 756 757 758 759 760 761 762
@end enumerate

The file config-2.x.x gives the configuration of the example kernels.

Just type
@example
make bzImage
@end example

As you would do to make a real kernel. Then you can use with QEMU
exactly the same kernel as you would boot on your PC (in
@file{arch/i386/boot/bzImage}).
B
bellard 已提交
763

B
updated  
bellard 已提交
764
@node gdb_usage
B
bellard 已提交
765 766 767
@section GDB usage

QEMU has a primitive support to work with gdb, so that you can do
B
updated  
bellard 已提交
768
'Ctrl-C' while the virtual machine is running and inspect its state.
B
bellard 已提交
769

B
update  
bellard 已提交
770
In order to use gdb, launch qemu with the '-s' option. It will wait for a
B
bellard 已提交
771 772
gdb connection:
@example
B
update  
bellard 已提交
773
> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
B
bellard 已提交
774 775 776 777 778 779 780 781 782 783 784
Connected to host network interface: tun0
Waiting gdb connection on port 1234
@end example

Then launch gdb on the 'vmlinux' executable:
@example
> gdb vmlinux
@end example

In gdb, connect to QEMU:
@example
B
update  
bellard 已提交
785
(gdb) target remote localhost:1234
B
bellard 已提交
786 787 788 789 790 791 792
@end example

Then you can use gdb normally. For example, type 'c' to launch the kernel:
@example
(gdb) c
@end example

B
updated  
bellard 已提交
793 794 795 796 797 798 799 800 801 802 803 804
Here are some useful tips in order to use gdb on system code:

@enumerate
@item
Use @code{info reg} to display all the CPU registers.
@item
Use @code{x/10i $eip} to display the code at the PC position.
@item
Use @code{set architecture i8086} to dump 16 bit code. Then use
@code{x/10i $cs*16+*eip} to dump the code at the PC position.
@end enumerate

B
bellard 已提交
805
@chapter QEMU User space emulator invocation
B
bellard 已提交
806

B
bellard 已提交
807
@section Quick Start
B
update  
bellard 已提交
808

B
bellard 已提交
809 810
In order to launch a Linux process, QEMU needs the process executable
itself and all the target (x86) dynamic libraries used by it. 
B
bellard 已提交
811

B
bellard 已提交
812
@itemize
B
bellard 已提交
813

B
bellard 已提交
814 815
@item On x86, you can just try to launch any process by using the native
libraries:
B
bellard 已提交
816

B
bellard 已提交
817 818 819
@example 
qemu-i386 -L / /bin/ls
@end example
B
bellard 已提交
820

B
bellard 已提交
821 822
@code{-L /} tells that the x86 dynamic linker must be searched with a
@file{/} prefix.
B
bellard 已提交
823

B
bellard 已提交
824
@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):
B
bellard 已提交
825

B
bellard 已提交
826 827 828
@example 
qemu-i386 -L / qemu-i386 -L / /bin/ls
@end example
B
bellard 已提交
829

B
bellard 已提交
830 831 832
@item On non x86 CPUs, you need first to download at least an x86 glibc
(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
@code{LD_LIBRARY_PATH} is not set:
B
update  
bellard 已提交
833

B
bellard 已提交
834 835 836
@example
unset LD_LIBRARY_PATH 
@end example
B
update  
bellard 已提交
837

B
bellard 已提交
838
Then you can launch the precompiled @file{ls} x86 executable:
B
update  
bellard 已提交
839

B
bellard 已提交
840 841 842 843 844 845 846
@example
qemu-i386 tests/i386/ls
@end example
You can look at @file{qemu-binfmt-conf.sh} so that
QEMU is automatically launched by the Linux kernel when you try to
launch x86 executables. It requires the @code{binfmt_misc} module in the
Linux kernel.
B
update  
bellard 已提交
847

B
bellard 已提交
848 849 850 851
@item The x86 version of QEMU is also included. You can try weird things such as:
@example
qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 /usr/local/qemu-i386/bin/ls-i386
@end example
B
update  
bellard 已提交
852

B
bellard 已提交
853
@end itemize
B
update  
bellard 已提交
854

B
bellard 已提交
855
@section Wine launch
B
update  
bellard 已提交
856

B
bellard 已提交
857
@itemize
B
bellard 已提交
858

B
bellard 已提交
859 860 861
@item Ensure that you have a working QEMU with the x86 glibc
distribution (see previous section). In order to verify it, you must be
able to do:
B
bellard 已提交
862

B
bellard 已提交
863 864 865
@example
qemu-i386 /usr/local/qemu-i386/bin/ls-i386
@end example
B
bellard 已提交
866

B
bellard 已提交
867 868
@item Download the binary x86 Wine install
(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page). 
B
bellard 已提交
869

B
bellard 已提交
870 871 872
@item Configure Wine on your account. Look at the provided script
@file{/usr/local/qemu-i386/bin/wine-conf.sh}. Your previous
@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
B
bellard 已提交
873

B
bellard 已提交
874
@item Then you can try the example @file{putty.exe}:
B
bellard 已提交
875

B
bellard 已提交
876 877 878
@example
qemu-i386 /usr/local/qemu-i386/wine/bin/wine /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
@end example
B
bellard 已提交
879

B
bellard 已提交
880
@end itemize
B
update  
bellard 已提交
881

B
bellard 已提交
882
@section Command line options
B
update  
bellard 已提交
883

B
bellard 已提交
884 885 886
@example
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
@end example
B
update  
bellard 已提交
887

B
bellard 已提交
888 889 890 891 892 893 894
@table @option
@item -h
Print the help
@item -L path   
Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
@item -s size
Set the x86 stack size in bytes (default=524288)
B
bellard 已提交
895 896
@end table

B
bellard 已提交
897
Debug options:
B
bellard 已提交
898

B
bellard 已提交
899 900 901 902 903 904
@table @option
@item -d
Activate log (logfile=/tmp/qemu.log)
@item -p pagesize
Act as if the host page size was 'pagesize' bytes
@end table
B
bellard 已提交
905