qemu-doc.texi 53.0 KB
Newer Older
B
bellard 已提交
1
\input texinfo @c -*- texinfo -*-
B
bellard 已提交
2 3 4 5 6 7
@c %**start of header
@setfilename qemu-doc.info
@settitle QEMU CPU Emulator User Documentation
@exampleindent 0
@paragraphindent 0
@c %**end of header
B
bellard 已提交
8

B
updated  
bellard 已提交
9
@iftex
B
bellard 已提交
10 11
@titlepage
@sp 7
B
bellard 已提交
12 13 14
@center @titlefont{QEMU CPU Emulator}
@sp 1
@center @titlefont{User Documentation}
B
bellard 已提交
15 16
@sp 3
@end titlepage
B
updated  
bellard 已提交
17
@end iftex
B
bellard 已提交
18

B
bellard 已提交
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
@ifnottex
@node Top
@top

@menu
* Introduction::
* Installation::
* QEMU PC System emulator::
* QEMU System emulator for non PC targets::
* QEMU Linux User space emulator::
* compilation:: Compilation from the sources
* Index::
@end menu
@end ifnottex

@contents

@node Introduction
B
bellard 已提交
37 38
@chapter Introduction

B
bellard 已提交
39 40 41 42 43
@menu
* intro_features:: Features
@end menu

@node intro_features
B
update  
bellard 已提交
44
@section Features
B
bellard 已提交
45

B
bellard 已提交
46 47
QEMU is a FAST! processor emulator using dynamic translation to
achieve good emulation speed.
B
update  
bellard 已提交
48 49

QEMU has two operating modes:
B
updated  
bellard 已提交
50 51 52 53

@itemize @minus

@item 
B
bellard 已提交
54
Full system emulation. In this mode, QEMU emulates a full system (for
B
bellard 已提交
55 56 57
example a PC), including one or several processors and various
peripherals. It can be used to launch different Operating Systems
without rebooting the PC or to debug system code.
B
update  
bellard 已提交
58

B
updated  
bellard 已提交
59
@item 
B
bellard 已提交
60 61 62 63
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 已提交
64 65 66

@end itemize

B
update  
bellard 已提交
67
QEMU can run without an host kernel driver and yet gives acceptable
68
performance. 
B
update  
bellard 已提交
69

B
update  
bellard 已提交
70 71
For system emulation, the following hardware targets are supported:
@itemize
B
update  
bellard 已提交
72
@item PC (x86 or x86_64 processor)
B
bellard 已提交
73
@item ISA PC (old style PC without PCI bus)
B
update  
bellard 已提交
74
@item PREP (PowerPC processor)
B
update  
bellard 已提交
75 76
@item G3 BW PowerMac (PowerPC processor)
@item Mac99 PowerMac (PowerPC processor, in progress)
B
bellard 已提交
77 78
@item Sun4m (32-bit Sparc processor)
@item Sun4u (64-bit Sparc processor, in progress)
B
bellard 已提交
79
@item Malta board (32-bit MIPS processor)
P
pbrook 已提交
80
@item ARM Integrator/CP (ARM926E or 1026E processor)
P
pbrook 已提交
81
@item ARM Versatile baseboard (ARM926E)
B
update  
bellard 已提交
82
@end itemize
B
bellard 已提交
83

B
bellard 已提交
84
For user emulation, x86, PowerPC, ARM, MIPS, and Sparc32/64 CPUs are supported.
B
updated  
bellard 已提交
85

B
bellard 已提交
86
@node Installation
B
update  
bellard 已提交
87 88
@chapter Installation

B
bellard 已提交
89 90
If you want to compile QEMU yourself, see @ref{compilation}.

B
bellard 已提交
91 92 93 94 95 96 97
@menu
* install_linux::   Linux
* install_windows:: Windows
* install_mac::     Macintosh
@end menu

@node install_linux
B
bellard 已提交
98 99
@section Linux

B
update  
bellard 已提交
100 101
If a precompiled package is available for your distribution - you just
have to install it. Otherwise, see @ref{compilation}.
B
update  
bellard 已提交
102

B
bellard 已提交
103
@node install_windows
B
bellard 已提交
104
@section Windows
B
update  
bellard 已提交
105

B
bellard 已提交
106
Download the experimental binary installer at
B
bellard 已提交
107
@url{http://www.free.oszoo.org/@/download.html}.
108

B
bellard 已提交
109
@node install_mac
B
bellard 已提交
110
@section Mac OS X
111

B
bellard 已提交
112
Download the experimental binary installer at
B
bellard 已提交
113
@url{http://www.free.oszoo.org/@/download.html}.
B
update  
bellard 已提交
114

B
bellard 已提交
115
@node QEMU PC System emulator
B
bellard 已提交
116
@chapter QEMU PC System emulator
B
update  
bellard 已提交
117

B
bellard 已提交
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
@menu
* pcsys_introduction:: Introduction
* pcsys_quickstart::   Quick Start
* sec_invocation::     Invocation
* pcsys_keys::         Keys
* pcsys_monitor::      QEMU Monitor
* disk_images::        Disk Images
* pcsys_network::      Network emulation
* direct_linux_boot::  Direct Linux Boot
* pcsys_usb::          USB emulation
* gdb_usage::          GDB usage
* pcsys_os_specific::  Target OS specific information
@end menu

@node pcsys_introduction
B
updated  
bellard 已提交
133 134 135 136
@section Introduction

@c man begin DESCRIPTION

B
bellard 已提交
137 138
The QEMU PC System emulator simulates the
following peripherals:
B
updated  
bellard 已提交
139 140

@itemize @minus
B
bellard 已提交
141 142
@item 
i440FX host PCI bridge and PIIX3 PCI to ISA bridge
B
updated  
bellard 已提交
143
@item
B
bellard 已提交
144 145
Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
extensions (hardware level, including all non standard modes).
B
updated  
bellard 已提交
146 147 148
@item
PS/2 mouse and keyboard
@item 
B
bellard 已提交
149
2 PCI IDE interfaces with hard disk and CD-ROM support
B
bellard 已提交
150 151
@item
Floppy disk
B
updated  
bellard 已提交
152
@item 
B
bellard 已提交
153
NE2000 PCI network adapters
B
updated  
bellard 已提交
154
@item
B
update  
bellard 已提交
155 156
Serial ports
@item
B
bellard 已提交
157 158 159 160 161
Creative SoundBlaster 16 sound card
@item
ENSONIQ AudioPCI ES1370 sound card
@item
Adlib(OPL2) - Yamaha YM3812 compatible chip
B
bellard 已提交
162 163
@item
PCI UHCI USB controller and a virtual USB hub.
B
updated  
bellard 已提交
164 165
@end itemize

B
bellard 已提交
166 167
SMP is supported with up to 255 CPUs.

B
bellard 已提交
168 169 170
Note that adlib is only available when QEMU was configured with
-enable-adlib

B
bellard 已提交
171 172 173
QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
VGA BIOS.

B
bellard 已提交
174 175
QEMU uses YM3812 emulation by Tatsuyuki Satoh.

B
updated  
bellard 已提交
176 177
@c man end

B
bellard 已提交
178
@node pcsys_quickstart
B
update  
bellard 已提交
179 180
@section Quick Start

B
update  
bellard 已提交
181
Download and uncompress the linux image (@file{linux.img}) and type:
B
updated  
bellard 已提交
182 183

@example
B
update  
bellard 已提交
184
qemu linux.img
B
updated  
bellard 已提交
185 186 187 188
@end example

Linux should boot and give you a prompt.

B
update  
bellard 已提交
189
@node sec_invocation
B
update  
bellard 已提交
190 191 192
@section Invocation

@example
B
updated  
bellard 已提交
193 194 195
@c man begin SYNOPSIS
usage: qemu [options] [disk_image]
@c man end
B
update  
bellard 已提交
196 197
@end example

B
updated  
bellard 已提交
198
@c man begin OPTIONS
B
update  
bellard 已提交
199
@var{disk_image} is a raw hard disk image for IDE hard disk 0.
B
update  
bellard 已提交
200 201 202

General options:
@table @option
203 204 205
@item -M machine
Select the emulated machine (@code{-M ?} for list)

B
update  
bellard 已提交
206 207
@item -fda file
@item -fdb file
B
bellard 已提交
208
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
B
update  
bellard 已提交
209
use the host floppy by using @file{/dev/fd0} as filename.
B
update  
bellard 已提交
210

B
update  
bellard 已提交
211 212
@item -hda file
@item -hdb file
B
update  
bellard 已提交
213 214
@item -hdc file
@item -hdd file
B
bellard 已提交
215
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
B
bellard 已提交
216

B
update  
bellard 已提交
217 218
@item -cdrom file
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
B
update  
bellard 已提交
219 220
@option{-cdrom} at the same time). You can use the host CD-ROM by
using @file{/dev/cdrom} as filename.
B
update  
bellard 已提交
221

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

B
update  
bellard 已提交
226
@item -snapshot
B
bellard 已提交
227 228
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
B
bellard 已提交
229
the write back by pressing @key{C-a s} (@pxref{disk_images}). 
B
update  
bellard 已提交
230

B
bellard 已提交
231 232 233 234
@item -no-fd-bootchk
Disable boot signature checking for floppy disks in Bochs BIOS. It may
be needed to boot from old floppy disks.

B
update  
bellard 已提交
235
@item -m megs
B
bellard 已提交
236
Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
B
update  
bellard 已提交
237

B
bellard 已提交
238 239 240 241
@item -smp n
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
CPUs are supported.

B
updated  
bellard 已提交
242 243 244 245 246 247 248 249
@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.

B
bellard 已提交
250 251 252 253 254 255 256
@item -vnc d

Normally, QEMU uses SDL to display the VGA output.  With this option,
you can have QEMU listen on VNC display d and redirect the VGA display
over the VNC session.  It is very useful to enable the usb tablet device
when using this option (option @option{-usbdevice tablet}).

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
@item -k language

Use keyboard layout @var{language} (for example @code{fr} for
French). This option is only needed where it is not easy to get raw PC
keycodes (e.g. on Macs or with some X11 servers). You don't need to
use it on PC/Linux or PC/Windows hosts.

The available layouts are:
@example
ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
@end example

The default is @code{en-us}.

273 274 275 276 277
@item -audio-help

Will show the audio subsystem help: list of drivers, tunable
parameters.

278
@item -soundhw card1,card2,... or -soundhw all
279 280 281 282 283 284 285

Enable audio and selected sound hardware. Use ? to print all
available sound hardware.

@example
qemu -soundhw sb16,adlib hda
qemu -soundhw es1370 hda
286
qemu -soundhw all hda
287 288
qemu -soundhw ?
@end example
B
update  
bellard 已提交
289

B
bellard 已提交
290 291 292 293 294
@item -localtime
Set the real time clock to local time (the default is to UTC
time). This option is needed to have correct date in MS-DOS or
Windows.

B
bellard 已提交
295 296 297
@item -full-screen
Start in full screen.

B
bellard 已提交
298 299 300 301
@item -pidfile file
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
from a script.

B
update  
bellard 已提交
302 303 304 305 306
@item -win2k-hack
Use it when installing Windows 2000 to avoid a disk full bug. After
Windows 2000 is installed, you no longer need this option (this option
slows down the IDE transfers).

B
updated  
bellard 已提交
307 308
@end table

B
bellard 已提交
309 310 311 312 313 314 315
USB options:
@table @option

@item -usb
Enable the USB driver (will be the default soon)

@item -usbdevice devname
P
pbrook 已提交
316
Add the USB device @var{devname}. @xref{usb_devices}.
B
bellard 已提交
317 318
@end table

B
bellard 已提交
319 320 321 322
Network options:

@table @option

323
@item -net nic[,vlan=n][,macaddr=addr][,model=type]
B
update  
bellard 已提交
324 325 326 327
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
= 0 is the default). The NIC is currently an NE2000 on the PC
target. Optionally, the MAC address can be changed. If no
@option{-net} option is specified, a single NIC is created.
328 329 330 331
Qemu can emulate several different models of network card.  Valid values for
@var{type} are @code{ne2k_pci}, @code{ne2k_isa}, @code{rtl8139},
@code{smc91c111} and @code{lance}.  Not all devices are supported on all
targets.
B
update  
bellard 已提交
332

P
pbrook 已提交
333
@item -net user[,vlan=n][,hostname=name]
B
update  
bellard 已提交
334
Use the user mode network stack which requires no administrator
P
pbrook 已提交
335
priviledge to run.  @option{hostname=name} can be used to specify the client
P
pbrook 已提交
336
hostname reported by the builtin DHCP server.
B
update  
bellard 已提交
337 338 339 340 341 342 343

@item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
Connect the host TAP network interface @var{name} to VLAN @var{n} and
use the network script @var{file} to configure it. The default
network script is @file{/etc/qemu-ifup}. If @var{name} is not
provided, the OS automatically provides one.  @option{fd=h} can be
used to specify the handle of an already opened host TAP interface. Example:
B
bellard 已提交
344

B
update  
bellard 已提交
345 346 347 348 349 350 351 352 353
@example
qemu linux.img -net nic -net tap
@end example

More complicated example (two NICs, each one connected to a TAP device)
@example
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
@end example
B
bellard 已提交
354 355


B
update  
bellard 已提交
356
@item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
B
bellard 已提交
357

B
update  
bellard 已提交
358 359 360 361
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
machine using a TCP socket connection. If @option{listen} is
specified, QEMU waits for incoming connections on @var{port}
(@var{host} is optional). @option{connect} is used to connect to
362 363
another QEMU instance using the @option{listen} option. @option{fd=h}
specifies an already opened TCP socket.
B
bellard 已提交
364

B
update  
bellard 已提交
365 366 367
Example:
@example
# launch a first QEMU instance
B
bellard 已提交
368 369 370 371 372 373
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,listen=:1234
# connect the VLAN 0 of this instance to the VLAN 0
# of the first instance
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
               -net socket,connect=127.0.0.1:1234
B
update  
bellard 已提交
374
@end example
B
update  
bellard 已提交
375

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
@item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]

Create a VLAN @var{n} shared with another QEMU virtual
machines using a UDP multicast socket, effectively making a bus for 
every QEMU with same multicast address @var{maddr} and @var{port}.
NOTES:
@enumerate
@item 
Several QEMU can be running on different hosts and share same bus (assuming 
correct multicast setup for these hosts).
@item
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
@url{http://user-mode-linux.sf.net}.
@item Use @option{fd=h} to specify an already opened UDP multicast socket.
@end enumerate

Example:
@example
# launch one QEMU instance
B
bellard 已提交
395 396
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,mcast=230.0.0.1:1234
397
# launch another QEMU instance on same "bus"
B
bellard 已提交
398 399
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
               -net socket,mcast=230.0.0.1:1234
400
# launch yet another QEMU instance on same "bus"
B
bellard 已提交
401 402
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
               -net socket,mcast=230.0.0.1:1234
403 404 405 406
@end example

Example (User Mode Linux compat.):
@example
B
bellard 已提交
407 408 409 410
# launch QEMU instance (note mcast address selected
# is UML's default)
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
               -net socket,mcast=239.192.168.1:1102
411 412 413 414
# launch UML
/path/to/linux ubd0=/path/to/root_fs eth0=mcast
@end example

B
update  
bellard 已提交
415 416
@item -net none
Indicate that no network devices should be configured. It is used to
B
bellard 已提交
417 418
override the default configuration (@option{-net nic -net user}) which
is activated if no @option{-net} options are provided.
B
update  
bellard 已提交
419

B
bellard 已提交
420 421 422 423 424 425 426 427
@item -tftp prefix
When using the user mode network stack, activate a built-in TFTP
server. All filenames beginning with @var{prefix} can be downloaded
from the host to the guest using a TFTP client. The TFTP client on the
guest must be configured in binary mode (use the command @code{bin} of
the Unix TFTP client). The host IP address on the guest is as usual
10.0.2.2.

B
update  
bellard 已提交
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
@item -smb dir
When using the user mode network stack, activate a built-in SMB
server so that Windows OSes can access to the host files in @file{dir}
transparently.

In the guest Windows OS, the line:
@example
10.0.2.4 smbserver
@end example
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).

Then @file{dir} can be accessed in @file{\\smbserver\qemu}.

Note that a SAMBA server must be installed on the host OS in
@file{/usr/sbin/smbd}. QEMU was tested succesfully with smbd version
B
update  
bellard 已提交
444
2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
B
update  
bellard 已提交
445

B
bellard 已提交
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
@item -redir [tcp|udp]:host-port:[guest-host]:guest-port

When using the user mode network stack, redirect incoming TCP or UDP
connections to the host port @var{host-port} to the guest
@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
is not specified, its value is 10.0.2.15 (default address given by the
built-in DHCP server).

For example, to redirect host X11 connection from screen 1 to guest
screen 0, use the following:

@example
# on the host
qemu -redir tcp:6001::6000 [...]
# this host xterm should open in the guest X11 server
xterm -display :1
@end example

To redirect telnet connections from host port 5555 to telnet port on
the guest, use the following:

@example
# on the host
qemu -redir tcp:5555::23 [...]
telnet localhost 5555
@end example

Then when you use on the host @code{telnet localhost 5555}, you
connect to the guest telnet server.

B
bellard 已提交
476 477
@end table

B
update  
bellard 已提交
478
Linux boot specific: When using these options, you can use a given
B
bellard 已提交
479 480 481
Linux kernel without installing it in the disk image. It can be useful
for easier testing of various kernels.

B
updated  
bellard 已提交
482 483 484 485 486 487 488 489 490 491 492
@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 已提交
493 494
@end table

B
bellard 已提交
495
Debug/Expert options:
B
update  
bellard 已提交
496
@table @option
B
update  
bellard 已提交
497 498

@item -serial dev
499 500 501 502 503 504 505 506
Redirect the virtual serial port to host character device
@var{dev}. The default device is @code{vc} in graphical mode and
@code{stdio} in non graphical mode.

This option can be used several times to simulate up to 4 serials
ports.

Available character devices are:
B
update  
bellard 已提交
507 508 509 510 511 512 513
@table @code
@item vc
Virtual console
@item pty
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
@item null
void device
B
bellard 已提交
514
@item /dev/XXX
B
bellard 已提交
515
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
B
bellard 已提交
516
parameters are set according to the emulated ones.
B
bellard 已提交
517 518 519
@item /dev/parportN
[Linux only, parallel port only] Use host parallel port
@var{N}. Currently only SPP parallel port features can be used.
B
bellard 已提交
520 521
@item file:filename
Write output to filename. No character can be read.
B
update  
bellard 已提交
522 523
@item stdio
[Unix only] standard input/output
B
bellard 已提交
524
@item pipe:filename
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
name pipe @var{filename}
@item COMn
[Windows only] Use host serial port @var{n}
@item udp:remote_port
UDP Net Console sent to locahost at remote_port
@item udp:remote_host:remote_port
UDP Net Console sent to remote_host at remote_port
@item udp:src_port:remote_host:remote_port
UDP Net Console sent from src_port to remote_host at the remote_port.

The udp:* sub options are primary intended for netconsole.  If you
just want a simple readonly console you can use @code{netcat} or
@code{nc}, by starting qemu with: @code{-serial udp:4555} and nc as:
@code{nc -u -l -p 4555}. Any time qemu writes something to that port
it will appear in the netconsole session.

If you plan to send characters back via netconsole or you want to stop
and start qemu a lot of times, you should have qemu use the same
source port each time by using something like @code{-serial
udp:4556:localhost:4555} to qemu. Another approach is to use a patched
version of netcat which can listen to a TCP port and send and receive
characters via udp.  If you have a patched version of netcat which
activates telnet remote echo and single char transfer, then you can
use the following options to step up a netcat redirector to allow
telnet on port 5555 to access the qemu port.
@table @code
@item Qemu Options
-serial udp:4556:localhost:4555
@item netcat options
-u -P 4555 -L localhost:4556  -t -p 5555 -I -T
B
update  
bellard 已提交
555 556
@end table

557 558 559 560 561 562 563 564 565

@item tcp:remote_host:remote_port
TCP Net Console sent to remote_host at the remote_port
@item tcpl:host:port
TCP Net Console: wait for connection on @var{host} on the local port
@var{port}. If host is omitted, 0.0.0.0 is assumed. Only one TCP
connection at a time is accepted. You can use @code{telnet} to connect
to the corresponding character device.
@end table
B
update  
bellard 已提交
566

B
bellard 已提交
567 568 569 570 571 572 573 574 575
@item -parallel dev
Redirect the virtual parallel port to host device @var{dev} (same
devices as the serial port). On Linux hosts, @file{/dev/parportN} can
be used to use hardware devices connected on the corresponding host
parallel port.

This option can be used several times to simulate up to 3 parallel
ports.

B
update  
bellard 已提交
576 577 578 579 580 581
@item -monitor dev
Redirect the monitor to host device @var{dev} (same devices as the
serial port).
The default device is @code{vc} in graphical mode and @code{stdio} in
non graphical mode.

B
update  
bellard 已提交
582
@item -s
B
bellard 已提交
583
Wait gdb connection to port 1234 (@pxref{gdb_usage}). 
B
update  
bellard 已提交
584 585
@item -p port
Change gdb connection port.
B
update  
bellard 已提交
586 587
@item -S
Do not start CPU at startup (you must type 'c' in the monitor).
B
update  
bellard 已提交
588
@item -d             
B
update  
bellard 已提交
589
Output log in /tmp/qemu.log
B
bellard 已提交
590 591 592 593 594 595
@item -hdachs c,h,s,[,t]
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
all thoses parameters. This option is useful for old MS-DOS disk
images.
B
update  
bellard 已提交
596

B
bellard 已提交
597 598
@item -std-vga
Simulate a standard VGA card with Bochs VBE extensions (default is
B
bellard 已提交
599 600 601 602
Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
VBE extensions (e.g. Windows XP) and if you want to use high
resolution modes (>= 1280x1024x16) then you should use this option.

B
bellard 已提交
603 604
@item -loadvm file
Start right away with a saved state (@code{loadvm} in monitor)
B
update  
bellard 已提交
605 606
@end table

B
update  
bellard 已提交
607 608
@c man end

B
bellard 已提交
609
@node pcsys_keys
B
update  
bellard 已提交
610 611 612 613
@section Keys

@c man begin OPTIONS

B
update  
bellard 已提交
614 615
During the graphical emulation, you can use the following keys:
@table @key
B
update  
bellard 已提交
616
@item Ctrl-Alt-f
B
update  
bellard 已提交
617
Toggle full screen
B
update  
bellard 已提交
618

B
update  
bellard 已提交
619
@item Ctrl-Alt-n
B
update  
bellard 已提交
620 621 622 623 624 625 626 627
Switch to virtual console 'n'. Standard console mappings are:
@table @emph
@item 1
Target system display
@item 2
Monitor
@item 3
Serial port
B
update  
bellard 已提交
628 629
@end table

B
update  
bellard 已提交
630
@item Ctrl-Alt
B
update  
bellard 已提交
631 632 633
Toggle mouse and keyboard grab.
@end table

B
update  
bellard 已提交
634 635 636
In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.

B
update  
bellard 已提交
637 638
During emulation, if you are using the @option{-nographic} option, use
@key{Ctrl-a h} to get terminal commands:
B
update  
bellard 已提交
639 640

@table @key
B
update  
bellard 已提交
641
@item Ctrl-a h
B
update  
bellard 已提交
642
Print this help
B
update  
bellard 已提交
643
@item Ctrl-a x    
B
update  
bellard 已提交
644
Exit emulatior
B
update  
bellard 已提交
645
@item Ctrl-a s    
B
bellard 已提交
646
Save disk data back to file (if -snapshot)
B
update  
bellard 已提交
647
@item Ctrl-a b
B
bellard 已提交
648
Send break (magic sysrq in Linux)
B
update  
bellard 已提交
649
@item Ctrl-a c
B
bellard 已提交
650
Switch between console and monitor
B
update  
bellard 已提交
651 652
@item Ctrl-a Ctrl-a
Send Ctrl-a
B
update  
bellard 已提交
653
@end table
B
updated  
bellard 已提交
654 655 656 657
@c man end

@ignore

B
bellard 已提交
658 659 660 661 662 663 664 665 666 667 668
@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

B
bellard 已提交
669
@node pcsys_monitor
B
bellard 已提交
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
@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
B
update  
bellard 已提交
706
show the various VLANs and the associated devices
B
bellard 已提交
707 708 709 710 711 712
@item info block
show the block devices
@item info registers
show the cpu registers
@item info history
show the command line history
B
bellard 已提交
713 714 715 716 717 718
@item info pci
show emulated PCI device
@item info usb
show USB devices plugged on the virtual USB hub
@item info usbhost
show all USB host devices
B
bellard 已提交
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
@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
B
update  
bellard 已提交
769 770 771
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
@code{h} or @code{w} can be specified with the @code{i} format to
respectively select 16 or 32 bit code instruction size.
B
bellard 已提交
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794

@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.
B
bellard 已提交
795
@smallexample 
B
bellard 已提交
796 797 798 799 800 801 802 803 804 805 806
(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
B
bellard 已提交
807
@end smallexample
B
bellard 已提交
808 809 810 811 812 813
@end itemize

@item p or print/fmt expr

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

B
bellard 已提交
815 816 817 818 819 820 821 822 823 824 825
@item sendkey keys

Send @var{keys} to the emulator. Use @code{-} to press several keys
simultaneously. Example:
@example
sendkey ctrl-alt-f1
@end example

This command is useful to send keys that your graphical user interface
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.

B
bellard 已提交
826 827 828 829
@item system_reset

Reset the system.

B
bellard 已提交
830 831
@item usb_add devname

P
pbrook 已提交
832 833
Add the USB device @var{devname}.  For details of available devices see
@ref{usb_devices}
B
bellard 已提交
834 835 836 837 838 839 840

@item usb_del devname

Remove the USB device @var{devname} from the QEMU virtual USB
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
command @code{info usb} to see the devices you can remove.

B
bellard 已提交
841
@end table
B
updated  
bellard 已提交
842

B
bellard 已提交
843 844 845 846 847
@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 已提交
848

B
bellard 已提交
849 850 851
@node disk_images
@section Disk Images

B
bellard 已提交
852 853 854
Since version 0.6.1, QEMU supports many disk image formats, including
growable disk images (their size increase as non empty sectors are
written), compressed and encrypted disk images.
B
bellard 已提交
855

B
bellard 已提交
856 857 858 859 860 861 862 863
@menu
* disk_images_quickstart::    Quick start for disk image creation
* disk_images_snapshot_mode:: Snapshot mode
* qemu_img_invocation::       qemu-img Invocation
* disk_images_fat_images::    Virtual FAT disk images
@end menu

@node disk_images_quickstart
B
bellard 已提交
864 865 866
@subsection Quick start for disk image creation

You can create a disk image with the command:
B
bellard 已提交
867
@example
B
bellard 已提交
868
qemu-img create myimage.img mysize
B
bellard 已提交
869
@end example
B
bellard 已提交
870 871 872 873
where @var{myimage.img} is the disk image filename and @var{mysize} is its
size in kilobytes. You can add an @code{M} suffix to give the size in
megabytes and a @code{G} suffix for gigabytes.

B
bellard 已提交
874
See @ref{qemu_img_invocation} for more information.
B
bellard 已提交
875

B
bellard 已提交
876
@node disk_images_snapshot_mode
B
bellard 已提交
877 878 879 880 881
@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
B
bellard 已提交
882 883
write back to the raw disk images by using the @code{commit} monitor
command (or @key{C-a s} in the serial console).
B
bellard 已提交
884

B
bellard 已提交
885 886
@node qemu_img_invocation
@subsection @code{qemu-img} Invocation
B
bellard 已提交
887

B
bellard 已提交
888
@include qemu-img.texi
B
bellard 已提交
889

B
bellard 已提交
890
@node disk_images_fat_images
B
update  
bellard 已提交
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
@subsection Virtual FAT disk images

QEMU can automatically create a virtual FAT disk image from a
directory tree. In order to use it, just type:

@example 
qemu linux.img -hdb fat:/my_directory
@end example

Then you access access to all the files in the @file{/my_directory}
directory without having to copy them in a disk image or to export
them via SAMBA or NFS. The default access is @emph{read-only}.

Floppies can be emulated with the @code{:floppy:} option:

@example 
qemu linux.img -fda fat:floppy:/my_directory
@end example

A read/write support is available for testing (beta stage) with the
@code{:rw:} option:

@example 
qemu linux.img -fda fat:floppy:rw:/my_directory
@end example

What you should @emph{never} do:
@itemize
@item use non-ASCII filenames ;
@item use "-snapshot" together with ":rw:" ;
B
bellard 已提交
921 922
@item expect it to work when loadvm'ing ;
@item write to the FAT directory on the host system while accessing it with the guest system.
B
update  
bellard 已提交
923 924
@end itemize

B
bellard 已提交
925
@node pcsys_network
B
update  
bellard 已提交
926 927
@section Network emulation

B
update  
bellard 已提交
928 929 930 931 932 933 934 935 936
QEMU can simulate several networks cards (NE2000 boards on the PC
target) and can connect them to an arbitrary number of Virtual Local
Area Networks (VLANs). Host TAP devices can be connected to any QEMU
VLAN. VLAN can be connected between separate instances of QEMU to
simulate large networks. For simpler usage, a non priviledged user mode
network stack can replace the TAP device to have a basic network
connection.

@subsection VLANs
B
update  
bellard 已提交
937

B
update  
bellard 已提交
938 939 940 941
QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
connection between several network devices. These devices can be for
example QEMU virtual Ethernet cards or virtual Host ethernet devices
(TAP devices).
B
update  
bellard 已提交
942

B
update  
bellard 已提交
943 944 945 946 947
@subsection Using TAP network interfaces

This is the standard way to connect QEMU to a real network. QEMU adds
a virtual network device on your host (called @code{tapN}), and you
can then configure it as if it was a real ethernet card.
B
update  
bellard 已提交
948 949 950 951 952

As an example, you can download the @file{linux-test-xxx.tar.gz}
archive and 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
B
update  
bellard 已提交
953
that your host kernel supports the TAP network interfaces: the
B
update  
bellard 已提交
954 955 956
device @file{/dev/net/tun} must be present.

See @ref{direct_linux_boot} to have an example of network use with a
B
update  
bellard 已提交
957 958
Linux distribution and @ref{sec_invocation} to have examples of
command lines using the TAP network interfaces.
B
update  
bellard 已提交
959 960 961

@subsection Using the user mode network stack

B
update  
bellard 已提交
962 963 964 965
By using the option @option{-net user} (default configuration if no
@option{-net} option is specified), QEMU uses a completely user mode
network stack (you don't need root priviledge to use the virtual
network). The virtual network configuration is the following:
B
update  
bellard 已提交
966 967 968

@example

B
update  
bellard 已提交
969 970
         QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
                           |          (10.0.2.2)
B
update  
bellard 已提交
971
                           |
B
update  
bellard 已提交
972 973 974
                           ---->  DNS server (10.0.2.3)
                           |     
                           ---->  SMB server (10.0.2.4)
B
update  
bellard 已提交
975 976 977 978
@end example

The QEMU VM behaves as if it was behind a firewall which blocks all
incoming connections. You can use a DHCP client to automatically
B
update  
bellard 已提交
979 980
configure the network in the QEMU VM. The DHCP server assign addresses
to the hosts starting from 10.0.2.15.
B
update  
bellard 已提交
981 982 983 984 985

In order to check that the user mode network is working, you can ping
the address 10.0.2.2 and verify that you got an address in the range
10.0.2.x from the QEMU virtual DHCP server.

B
update  
bellard 已提交
986 987 988 989
Note that @code{ping} is not supported reliably to the internet as it
would require root priviledges. It means you can only ping the local
router (10.0.2.2).

B
bellard 已提交
990 991 992 993 994 995
When using the built-in TFTP server, the router is also the TFTP
server.

When using the @option{-redir} option, TCP or UDP connections can be
redirected from the host to the guest. It allows for example to
redirect X11, telnet or SSH connections.
B
bellard 已提交
996

B
update  
bellard 已提交
997 998 999 1000 1001 1002
@subsection Connecting VLANs between QEMU instances

Using the @option{-net socket} option, it is possible to make VLANs
that span several QEMU instances. See @ref{sec_invocation} to have a
basic example.

B
update  
bellard 已提交
1003 1004
@node direct_linux_boot
@section Direct Linux Boot
B
bellard 已提交
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028

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:

B
bellard 已提交
1029
@smallexample
B
bellard 已提交
1030 1031
> ./qemu.sh 
Connected to host network interface: tun0
B
bellard 已提交
1032
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
B
bellard 已提交
1033 1034 1035 1036 1037 1038 1039 1040
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.
B
bellard 已提交
1041
Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe @/ide5=noprobe console=ttyS0
B
bellard 已提交
1042 1043 1044 1045 1046 1047 1048 1049
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
B
bellard 已提交
1050
Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, @/0k highmem)
B
bellard 已提交
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
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
B
bellard 已提交
1069
ne.c:v1.10 9/23/94 Donald Becker (becker@@scyld.com)
B
bellard 已提交
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
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
 
B
bellard 已提交
1092
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
B
bellard 已提交
1093 1094 1095 1096 1097 1098
 
QEMU Linux test distribution (based on Redhat 9)
 
Type 'exit' to halt the system
 
sh-2.05b# 
B
bellard 已提交
1099
@end smallexample
B
bellard 已提交
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148

@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 
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
bellard 已提交
1149
@node pcsys_usb
B
bellard 已提交
1150 1151
@section USB emulation

P
pbrook 已提交
1152 1153 1154 1155
QEMU emulates a PCI UHCI USB controller. You can virtually plug
virtual USB devices or real host USB devices (experimental, works only
on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
as neccessary to connect multiple USB devices.
B
bellard 已提交
1156

P
pbrook 已提交
1157 1158 1159 1160 1161 1162
@menu
* usb_devices::
* host_usb_devices::
@end menu
@node usb_devices
@subsection Connecting USB devices
B
bellard 已提交
1163

P
pbrook 已提交
1164 1165
USB devices can be connected with the @option{-usbdevice} commandline option
or the @code{usb_add} monitor command.  Available devices are:
B
bellard 已提交
1166

P
pbrook 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
@table @var
@item @code{mouse}
Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
@item @code{tablet}
Pointer device that uses abolsute coordinates (like a touchscreen).
This means qemu is able to report the mouse position without having
to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
@item @code{disk:file}
Mass storage device based on @var{file} (@pxref{disk_images})
@item @code{host:bus.addr}
Pass through the host device identified by @var{bus.addr}
(Linux only)
@item @code{host:vendor_id:product_id}
Pass through the host device identified by @var{vendor_id:product_id}
(Linux only)
@end table
B
bellard 已提交
1183

P
pbrook 已提交
1184
@node host_usb_devices
B
bellard 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
@subsection Using host USB devices on a Linux host

WARNING: this is an experimental feature. QEMU will slow down when
using it. USB devices requiring real time streaming (i.e. USB Video
Cameras) are not supported yet.

@enumerate
@item If you use an early Linux 2.4 kernel, verify that no Linux driver 
is actually using the USB device. A simple way to do that is simply to
disable the corresponding kernel module by renaming it from @file{mydriver.o}
to @file{mydriver.o.disabled}.

@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
@example
ls /proc/bus/usb
001  devices  drivers
@end example

@item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices:
@example
chown -R myuid /proc/bus/usb
@end example

@item Launch QEMU and do in the monitor:
@example 
info usbhost
  Device 1.2, speed 480 Mb/s
    Class 00: USB device 1234:5678, USB DISK
@end example
You should see the list of the devices you can use (Never try to use
hubs, it won't work).

@item Add the device in QEMU by using:
@example 
usb_add host:1234:5678
@end example

Normally the guest OS should report that a new USB device is
plugged. You can use the option @option{-usbdevice} to do the same.

@item Now you can try to use the host USB device in QEMU.

@end enumerate

When relaunching QEMU, you may have to unplug and plug again the USB
device to make it work again (this is a bug).

B
updated  
bellard 已提交
1232
@node gdb_usage
B
bellard 已提交
1233 1234 1235
@section GDB usage

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

B
update  
bellard 已提交
1238
In order to use gdb, launch qemu with the '-s' option. It will wait for a
B
bellard 已提交
1239 1240
gdb connection:
@example
B
bellard 已提交
1241 1242
> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
       -append "root=/dev/hda"
B
bellard 已提交
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
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 已提交
1254
(gdb) target remote localhost:1234
B
bellard 已提交
1255 1256 1257 1258 1259 1260 1261
@end example

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

B
updated  
bellard 已提交
1262 1263 1264 1265 1266 1267 1268 1269 1270
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
B
update  
bellard 已提交
1271
@code{x/10i $cs*16+$eip} to dump the code at the PC position.
B
updated  
bellard 已提交
1272 1273
@end enumerate

B
bellard 已提交
1274
@node pcsys_os_specific
B
update  
bellard 已提交
1275 1276 1277 1278
@section Target OS specific information

@subsection Linux

B
bellard 已提交
1279 1280 1281
To have access to SVGA graphic modes under X11, use the @code{vesa} or
the @code{cirrus} X11 driver. For optimal performances, use 16 bit
color depth in the guest and the host OS.
B
update  
bellard 已提交
1282

B
update  
bellard 已提交
1283 1284 1285 1286 1287
When using a 2.6 guest Linux kernel, you should add the option
@code{clock=pit} on the kernel command line because the 2.6 Linux
kernels make very strict real time clock checks by default that QEMU
cannot simulate exactly.

B
update  
bellard 已提交
1288 1289 1290 1291 1292 1293
When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
not activated because QEMU is slower with this patch. The QEMU
Accelerator Module is also much slower in this case. Earlier Fedora
Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
patch by default. Newer kernels don't have it.

B
update  
bellard 已提交
1294 1295 1296 1297 1298
@subsection Windows

If you have a slow host, using Windows 95 is better as it gives the
best speed. Windows 2000 is also a good choice.

B
update  
bellard 已提交
1299 1300 1301
@subsubsection SVGA graphic modes support

QEMU emulates a Cirrus Logic GD5446 Video
B
bellard 已提交
1302 1303 1304
card. All Windows versions starting from Windows 95 should recognize
and use this graphic card. For optimal performances, use 16 bit color
depth in the guest and the host OS.
B
update  
bellard 已提交
1305

B
bellard 已提交
1306 1307 1308 1309 1310
If you are using Windows XP as guest OS and if you want to use high
resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1280x1024x16), then you should use the VESA VBE virtual graphic card
(option @option{-std-vga}).

B
update  
bellard 已提交
1311 1312 1313
@subsubsection CPU usage reduction

Windows 9x does not correctly use the CPU HLT
B
bellard 已提交
1314 1315 1316 1317
instruction. The result is that it takes host CPU cycles even when
idle. You can install the utility from
@url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
problem. Note that no such tool is needed for NT, 2000 or XP.
B
update  
bellard 已提交
1318

B
update  
bellard 已提交
1319
@subsubsection Windows 2000 disk full problem
B
update  
bellard 已提交
1320

B
update  
bellard 已提交
1321 1322 1323 1324 1325
Windows 2000 has a bug which gives a disk full problem during its
installation. When installing it, use the @option{-win2k-hack} QEMU
option to enable a specific workaround. After Windows 2000 is
installed, you no longer need this option (this option slows down the
IDE transfers).
B
update  
bellard 已提交
1326

B
update  
bellard 已提交
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
@subsubsection Windows 2000 shutdown

Windows 2000 cannot automatically shutdown in QEMU although Windows 98
can. It comes from the fact that Windows 2000 does not automatically
use the APM driver provided by the BIOS.

In order to correct that, do the following (thanks to Struan
Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
Add/Troubleshoot a device => Add a new device & Next => No, select the
hardware from a list & Next => NT Apm/Legacy Support & Next => Next
(again) a few times. Now the driver is installed and Windows 2000 now
correctly instructs QEMU to shutdown at the appropriate moment. 

@subsubsection Share a directory between Unix and Windows

See @ref{sec_invocation} about the help of the option @option{-smb}.

B
update  
bellard 已提交
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
@subsubsection Windows XP security problems

Some releases of Windows XP install correctly but give a security
error when booting:
@example
A problem is preventing Windows from accurately checking the
license for this computer. Error code: 0x800703e6.
@end example
The only known workaround is to boot in Safe mode
without networking support. 

Future QEMU releases are likely to correct this bug.

B
update  
bellard 已提交
1357 1358 1359 1360 1361 1362 1363 1364 1365
@subsection MS-DOS and FreeDOS

@subsubsection CPU usage reduction

DOS does not correctly use the CPU HLT instruction. The result is that
it takes host CPU cycles even when idle. You can install the utility
from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
problem.

B
bellard 已提交
1366
@node QEMU System emulator for non PC targets
B
bellard 已提交
1367 1368 1369 1370 1371 1372
@chapter QEMU System emulator for non PC targets

QEMU is a generic emulator and it emulates many non PC
machines. Most of the options are similar to the PC emulator. The
differences are mentionned in the following sections.

B
bellard 已提交
1373 1374 1375 1376 1377 1378 1379 1380 1381
@menu
* QEMU PowerPC System emulator::
* Sparc32 System emulator invocation::
* Sparc64 System emulator invocation::
* MIPS System emulator invocation::
* ARM System emulator invocation::
@end menu

@node QEMU PowerPC System emulator
B
bellard 已提交
1382
@section QEMU PowerPC System emulator
B
update  
bellard 已提交
1383

B
bellard 已提交
1384 1385
Use the executable @file{qemu-system-ppc} to simulate a complete PREP
or PowerMac PowerPC system.
B
update  
bellard 已提交
1386

B
typos  
bellard 已提交
1387
QEMU emulates the following PowerMac peripherals:
B
update  
bellard 已提交
1388

B
bellard 已提交
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
@itemize @minus
@item 
UniNorth PCI Bridge 
@item
PCI VGA compatible card with VESA Bochs Extensions
@item 
2 PMAC IDE interfaces with hard disk and CD-ROM support
@item 
NE2000 PCI adapters
@item
Non Volatile RAM
@item
VIA-CUDA with ADB keyboard and mouse.
B
update  
bellard 已提交
1402 1403
@end itemize

B
typos  
bellard 已提交
1404
QEMU emulates the following PREP peripherals:
B
update  
bellard 已提交
1405 1406 1407

@itemize @minus
@item 
B
bellard 已提交
1408 1409 1410 1411
PCI Bridge
@item
PCI VGA compatible card with VESA Bochs Extensions
@item 
B
update  
bellard 已提交
1412 1413 1414 1415
2 IDE interfaces with hard disk and CD-ROM support
@item
Floppy disk
@item 
B
bellard 已提交
1416
NE2000 network adapters
B
update  
bellard 已提交
1417 1418 1419 1420
@item
Serial port
@item
PREP Non Volatile RAM
B
bellard 已提交
1421 1422
@item
PC compatible keyboard and mouse.
B
update  
bellard 已提交
1423 1424
@end itemize

B
bellard 已提交
1425
QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
B
bellard 已提交
1426
@url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
B
update  
bellard 已提交
1427

B
bellard 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
@c man begin OPTIONS

The following options are specific to the PowerPC emulation:

@table @option

@item -g WxH[xDEPTH]  

Set the initial VGA graphic mode. The default is 800x600x15.

@end table

@c man end 


B
update  
bellard 已提交
1443
More information is available at
B
bellard 已提交
1444
@url{http://perso.magic.fr/l_indien/qemu-ppc/}.
B
update  
bellard 已提交
1445

B
bellard 已提交
1446
@node Sparc32 System emulator invocation
B
bellard 已提交
1447
@section Sparc32 System emulator invocation
B
bellard 已提交
1448

1449
Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
B
bellard 已提交
1450
(sun4m architecture). The emulation is somewhat complete.
B
bellard 已提交
1451

B
typos  
bellard 已提交
1452
QEMU emulates the following sun4m peripherals:
B
bellard 已提交
1453 1454

@itemize @minus
B
bellard 已提交
1455
@item
B
bellard 已提交
1456 1457 1458 1459 1460 1461 1462 1463
IOMMU
@item
TCX Frame buffer
@item 
Lance (Am7990) Ethernet
@item
Non Volatile RAM M48T08
@item
B
bellard 已提交
1464 1465 1466 1467 1468 1469
Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
and power/reset logic
@item
ESP SCSI controller with hard disk and CD-ROM support
@item
Floppy drive
B
bellard 已提交
1470 1471
@end itemize

B
bellard 已提交
1472 1473
The number of peripherals is fixed in the architecture.

B
update  
bellard 已提交
1474
Since version 0.8.2, QEMU uses OpenBIOS
1475 1476 1477
@url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
firmware implementation. The goal is to implement a 100% IEEE
1275-1994 (referred to as Open Firmware) compliant firmware.
B
bellard 已提交
1478 1479

A sample Linux 2.6 series kernel and ram disk image are available on
1480 1481
the QEMU web site. Please note that currently NetBSD, OpenBSD or
Solaris kernels don't work.
B
bellard 已提交
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496

@c man begin OPTIONS

The following options are specific to the Sparc emulation:

@table @option

@item -g WxH

Set the initial TCX graphic mode. The default is 1024x768.

@end table

@c man end 

B
bellard 已提交
1497
@node Sparc64 System emulator invocation
B
bellard 已提交
1498
@section Sparc64 System emulator invocation
B
bellard 已提交
1499

B
bellard 已提交
1500 1501
Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
The emulator is not usable for anything yet.
B
bellard 已提交
1502

B
bellard 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
QEMU emulates the following sun4u peripherals:

@itemize @minus
@item
UltraSparc IIi APB PCI Bridge 
@item
PCI VGA compatible card with VESA Bochs Extensions
@item
Non Volatile RAM M48T59
@item
PC-compatible serial ports
@end itemize

B
bellard 已提交
1516
@node MIPS System emulator invocation
B
bellard 已提交
1517
@section MIPS System emulator invocation
B
update  
bellard 已提交
1518 1519

Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
B
bellard 已提交
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
The emulator is able to boot a Linux kernel and to run a Linux Debian
installation from NFS. The following devices are emulated:

@itemize @minus
@item 
MIPS R4K CPU
@item
PC style serial port
@item
NE2000 network card
@end itemize

More information is available in the QEMU mailing-list archive.

B
bellard 已提交
1534
@node ARM System emulator invocation
B
bellard 已提交
1535 1536 1537 1538 1539 1540 1541 1542
@section ARM System emulator invocation

Use the executable @file{qemu-system-arm} to simulate a ARM
machine. The ARM Integrator/CP board is emulated with the following
devices:

@itemize @minus
@item
P
pbrook 已提交
1543
ARM926E or ARM1026E CPU
B
bellard 已提交
1544 1545 1546 1547
@item
Two PL011 UARTs
@item 
SMC 91c111 Ethernet adapter
P
pbrook 已提交
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
@item
PL110 LCD controller
@item
PL050 KMI with PS/2 keyboard and mouse.
@end itemize

The ARM Versatile baseboard is emulated with the following devices:

@itemize @minus
@item
ARM926E CPU
@item
PL190 Vectored Interrupt Controller
@item
Four PL011 UARTs
@item 
SMC 91c111 Ethernet adapter
@item
PL110 LCD controller
@item
PL050 KMI with PS/2 keyboard and mouse.
@item
PCI host bridge.  Note the emulated PCI bridge only provides access to
PCI memory space.  It does not provide access to PCI IO space.
This means some devices (eg. ne2k_pci NIC) are not useable, and others
(eg. rtl8139 NIC) are only useable when the guest drivers use the memory
mapped control registers.
P
pbrook 已提交
1575 1576 1577 1578
@item
PCI OHCI USB controller.
@item
LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
B
bellard 已提交
1579 1580 1581 1582
@end itemize

A Linux 2.6 test image is available on the QEMU web site. More
information is available in the QEMU mailing-list archive.
B
update  
bellard 已提交
1583

B
bellard 已提交
1584
@node QEMU Linux User space emulator 
B
bellard 已提交
1585
@chapter QEMU Linux User space emulator 
B
bellard 已提交
1586

B
bellard 已提交
1587 1588 1589 1590
@menu
* Quick Start::
* Wine launch::
* Command line options::
P
pbrook 已提交
1591
* Other binaries::
B
bellard 已提交
1592 1593 1594
@end menu

@node Quick Start
B
bellard 已提交
1595
@section Quick Start
B
update  
bellard 已提交
1596

B
bellard 已提交
1597 1598
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 已提交
1599

B
bellard 已提交
1600
@itemize
B
bellard 已提交
1601

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

B
bellard 已提交
1605 1606 1607
@example 
qemu-i386 -L / /bin/ls
@end example
B
bellard 已提交
1608

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

B
bellard 已提交
1612
@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 已提交
1613

B
bellard 已提交
1614 1615 1616
@example 
qemu-i386 -L / qemu-i386 -L / /bin/ls
@end example
B
bellard 已提交
1617

B
bellard 已提交
1618 1619 1620
@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 已提交
1621

B
bellard 已提交
1622 1623 1624
@example
unset LD_LIBRARY_PATH 
@end example
B
update  
bellard 已提交
1625

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

B
bellard 已提交
1628 1629 1630 1631 1632 1633 1634
@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 已提交
1635

B
bellard 已提交
1636 1637
@item The x86 version of QEMU is also included. You can try weird things such as:
@example
B
bellard 已提交
1638 1639
qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
          /usr/local/qemu-i386/bin/ls-i386
B
bellard 已提交
1640
@end example
B
update  
bellard 已提交
1641

B
bellard 已提交
1642
@end itemize
B
update  
bellard 已提交
1643

B
bellard 已提交
1644
@node Wine launch
B
bellard 已提交
1645
@section Wine launch
B
update  
bellard 已提交
1646

B
bellard 已提交
1647
@itemize
B
bellard 已提交
1648

B
bellard 已提交
1649 1650 1651
@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 已提交
1652

B
bellard 已提交
1653 1654 1655
@example
qemu-i386 /usr/local/qemu-i386/bin/ls-i386
@end example
B
bellard 已提交
1656

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

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

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

B
bellard 已提交
1666
@example
B
bellard 已提交
1667 1668
qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
          /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
B
bellard 已提交
1669
@end example
B
bellard 已提交
1670

B
bellard 已提交
1671
@end itemize
B
update  
bellard 已提交
1672

B
bellard 已提交
1673
@node Command line options
B
bellard 已提交
1674
@section Command line options
B
update  
bellard 已提交
1675

B
bellard 已提交
1676 1677 1678
@example
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
@end example
B
update  
bellard 已提交
1679

B
bellard 已提交
1680 1681 1682 1683 1684 1685 1686
@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 已提交
1687 1688
@end table

B
bellard 已提交
1689
Debug options:
B
bellard 已提交
1690

B
bellard 已提交
1691 1692 1693 1694 1695 1696
@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 已提交
1697

P
pbrook 已提交
1698 1699 1700 1701 1702 1703 1704 1705 1706
@node Other binaries
@section Other binaries

@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
configurations), and arm-uclinux bFLT format binaries.

The binary format is detected automatically.

B
bellard 已提交
1707 1708 1709
@node compilation
@chapter Compilation from the sources

B
bellard 已提交
1710 1711 1712 1713 1714 1715 1716 1717
@menu
* Linux/Unix::
* Windows::
* Cross compilation for Windows with Linux::
* Mac OS X::
@end menu

@node Linux/Unix
B
update  
bellard 已提交
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
@section Linux/Unix

@subsection Compilation

First you must decompress the sources:
@example
cd /tmp
tar zxvf qemu-x.y.z.tar.gz
cd qemu-x.y.z
@end example

Then you configure QEMU and build it (usually no options are needed):
@example
./configure
make
@end example

Then type as root user:
@example
make install
@end example
to install QEMU in @file{/usr/local}.

@subsection Tested tool versions

In order to compile QEMU succesfully, it is very important that you
have the right tools. The most important one is gcc. I cannot guaranty
that QEMU works if you do not use a tested gcc version. Look at
'configure' and 'Makefile' if you want to make a different gcc
version work.

@example
host      gcc      binutils      glibc    linux       distribution
----------------------------------------------------------------------
x86       3.2      2.13.2        2.1.3    2.4.18
          2.96     2.11.93.0.2   2.2.5    2.4.18      Red Hat 7.3
          3.2.2    2.13.90.0.18  2.3.2    2.4.20      Red Hat 9

PowerPC   3.3 [4]  2.13.90.0.18  2.3.1    2.4.20briq
          3.2

Alpha     3.3 [1]  2.14.90.0.4   2.2.5    2.2.20 [2]  Debian 3.0

Sparc32   2.95.4   2.12.90.0.1   2.2.5    2.4.18      Debian 3.0

ARM       2.95.4   2.12.90.0.1   2.2.5    2.4.9 [3]   Debian 3.0

[1] On Alpha, QEMU needs the gcc 'visibility' attribute only available
    for gcc version >= 3.3.
[2] Linux >= 2.4.20 is necessary for precise exception support
    (untested).
[3] 2.4.9-ac10-rmk2-np1-cerf2

[4] gcc 2.95.x generates invalid code when using too many register
variables. You must use gcc 3.x on PowerPC.
@end example
B
bellard 已提交
1774

B
bellard 已提交
1775
@node Windows
B
bellard 已提交
1776 1777 1778 1779 1780 1781 1782 1783 1784
@section Windows

@itemize
@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
B
bellard 已提交
1785
(@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
B
bellard 已提交
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
@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}).

@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.

@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}.

@end itemize

B
bellard 已提交
1805
@node Cross compilation for Windows with Linux
B
bellard 已提交
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836
@section Cross compilation for Windows with Linux

@itemize
@item
Install the MinGW cross compilation tools available at
@url{http://www.mingw.org/}.

@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.

@item 
Configure QEMU for Windows cross compilation:
@example
./configure --enable-mingw32
@end example
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.

@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. 

@end itemize

Note: Currently, Wine does not seem able to launch
QEMU for Win32.

B
bellard 已提交
1837
@node Mac OS X
B
bellard 已提交
1838 1839 1840 1841 1842 1843
@section Mac OS X

The Mac OS X patches are not fully merged in QEMU, so you should look
at the QEMU mailing list archive to have all the necessary
information.

B
bellard 已提交
1844 1845 1846 1847 1848
@node Index
@chapter Index
@printindex cp

@bye