]> git.proxmox.com Git - qemu.git/blame - qemu-doc.texi
added target_phys_addr_t
[qemu.git] / qemu-doc.texi
CommitLineData
386405f7
FB
1\input texinfo @c -*- texinfo -*-
2
0806e3f6 3@iftex
1f673135 4@settitle QEMU CPU Emulator User Documentation
386405f7
FB
5@titlepage
6@sp 7
1f673135 7@center @titlefont{QEMU CPU Emulator User Documentation}
386405f7
FB
8@sp 3
9@end titlepage
0806e3f6 10@end iftex
386405f7
FB
11
12@chapter Introduction
13
322d0c66 14@section Features
386405f7 15
1f673135
FB
16QEMU is a FAST! processor emulator using dynamic translation to
17achieve good emulation speed.
1eb20527
FB
18
19QEMU has two operating modes:
0806e3f6
FB
20
21@itemize @minus
22
23@item
1f673135
FB
24Full system emulation. In this mode, QEMU emulates a full system (for
25example a PC), including a processor and various peripherials. It can
26be used to launch different Operating Systems without rebooting the
27PC or to debug system code.
1eb20527 28
0806e3f6 29@item
1f673135
FB
30User mode emulation (Linux host only). In this mode, QEMU can launch
31Linux processes compiled for one CPU on another CPU. It can be used to
32launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
33to ease cross-compilation and cross-debugging.
1eb20527
FB
34
35@end itemize
36
1f673135 37As QEMU requires no host kernel driver to run, it is very safe and
1eb20527 38easy to use.
322d0c66 39
1f673135
FB
40For system emulation, only the x86 PC emulator is currently
41usable. The PowerPC system emulator is being developped.
386405f7 42
1f673135 43For user emulation, x86, PowerPC, ARM, and SPARC CPUs are supported.
0806e3f6 44
5b9f457a
FB
45@chapter Installation
46
1f673135
FB
47@section Linux
48
5b9f457a
FB
49If you want to compile QEMU, please read the @file{README} which gives
50the related information. Otherwise just download the binary
51distribution (@file{qemu-XXX-i386.tar.gz}) and untar it as root in
52@file{/}:
53
54@example
55su
56cd /
57tar zxvf /tmp/qemu-XXX-i386.tar.gz
58@end example
59
1f673135
FB
60@section Windows
61w
d691f669 62@itemize
1f673135
FB
63@item Install the current versions of MSYS and MinGW from
64@url{http://www.mingw.org/}. You can find detailed installation
65instructions in the download section and the FAQ.
66
67@item Download
68the MinGW development library of SDL 1.2.x
69(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
70@url{http://www.libsdl.org}. Unpack it in a temporary place, and
71unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
72directory. Edit the @file{sdl-config} script so that it gives the
73correct SDL directory when invoked.
74
75@item Extract the current version of QEMU.
76
77@item Start the MSYS shell (file @file{msys.bat}).
386405f7 78
1f673135
FB
79@item Change to the QEMU directory. Launch @file{./configure} and
80@file{make}. If you have problems using SDL, verify that
81@file{sdl-config} can be launched from the MSYS command line.
644c433c 82
1f673135
FB
83@item You can install QEMU in @file{Program Files/Qemu} by typing
84@file{make install}. Don't forget to copy @file{SDL.dll} in
85@file{Program Files/Qemu}.
1eb87257 86
168485b7
FB
87@end itemize
88
1f673135 89@section Cross compilation for Windows with Linux
168485b7
FB
90
91@itemize
1f673135
FB
92@item
93Install the MinGW cross compilation tools available at
94@url{http://www.mingw.org/}.
168485b7 95
1f673135
FB
96@item
97Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
98unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
99variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
100the QEMU configuration script.
168485b7 101
1f673135
FB
102@item
103Configure QEMU for Windows cross compilation:
168485b7 104@example
1f673135 105./configure --enable-mingw32
168485b7 106@end example
1f673135
FB
107If necessary, you can change the cross-prefix according to the prefix
108choosen for the MinGW tools with --cross-prefix. You can also use
109--prefix to set the Win32 install path.
168485b7 110
1f673135
FB
111@item You can install QEMU in the installation directory by typing
112@file{make install}. Don't forget to copy @file{SDL.dll} in the
113installation directory.
d691f669
FB
114
115@end itemize
116
1f673135
FB
117Note: Currently, Wine does not seem able to launch
118QEMU for Win32.
d691f669 119
1f673135 120@section Mac OS X
d691f669 121
1f673135 122Mac OS X is currently not supported.
df0f11a0 123
1eb20527
FB
124@chapter QEMU System emulator invocation
125
0806e3f6
FB
126@section Introduction
127
128@c man begin DESCRIPTION
129
1f673135 130The QEMU System emulator simulates a complete PC.
0806e3f6
FB
131
132In order to meet specific user needs, two versions of QEMU are
133available:
134
135@enumerate
136
137@item
285dc330 138@code{qemu-fast} uses the host Memory Management Unit (MMU) to simulate
0806e3f6
FB
139the x86 MMU. It is @emph{fast} but has limitations because the whole 4 GB
140address space cannot be used and some memory mapped peripherials
141cannot be emulated accurately yet. Therefore, a specific Linux kernel
142must be used (@xref{linux_compile}).
143
144@item
285dc330
FB
145@code{qemu} uses a software MMU. It is about @emph{two times
146slower} but gives a more accurate emulation.
0806e3f6
FB
147
148@end enumerate
149
150QEMU emulates the following PC peripherials:
151
152@itemize @minus
153@item
154VGA (hardware level, including all non standard modes)
155@item
156PS/2 mouse and keyboard
157@item
181f1558 1582 IDE interfaces with hard disk and CD-ROM support
1f673135
FB
159@item
160Floppy disk
0806e3f6 161@item
1f673135 162up to 6 NE2000 network adapters
0806e3f6 163@item
181f1558
FB
164Serial port
165@item
166Soundblaster 16 card
0806e3f6
FB
167@end itemize
168
169@c man end
170
1eb20527
FB
171@section Quick Start
172
285dc330 173Download and uncompress the linux image (@file{linux.img}) and type:
0806e3f6
FB
174
175@example
285dc330 176qemu linux.img
0806e3f6
FB
177@end example
178
179Linux should boot and give you a prompt.
180
ec410fc9
FB
181@section Invocation
182
183@example
0806e3f6
FB
184@c man begin SYNOPSIS
185usage: qemu [options] [disk_image]
186@c man end
ec410fc9
FB
187@end example
188
0806e3f6 189@c man begin OPTIONS
9d4520d0 190@var{disk_image} is a raw hard disk image for IDE hard disk 0.
ec410fc9
FB
191
192General options:
193@table @option
2be3bc02
FB
194@item -fda file
195@item -fdb file
196Use @var{file} as floppy disk 0/1 image (@xref{disk_images}).
197
ec410fc9
FB
198@item -hda file
199@item -hdb file
181f1558
FB
200@item -hdc file
201@item -hdd file
2be3bc02 202Use @var{file} as hard disk 0, 1, 2 or 3 image (@xref{disk_images}).
1f47a922 203
181f1558
FB
204@item -cdrom file
205Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
206@option{-cdrom} at the same time).
207
1f673135
FB
208@item -boot [a|c|d]
209Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
2be3bc02 210the default.
1f47a922 211
181f1558 212@item -snapshot
1f47a922
FB
213Write to temporary files instead of disk image files. In this case,
214the raw disk image you use is not written back. You can however force
215the write back by pressing @key{C-a s} (@xref{disk_images}).
ec410fc9
FB
216
217@item -m megs
218Set virtual RAM size to @var{megs} megabytes.
219
4690764b 220@item -initrd file
0806e3f6
FB
221Use @var{file} as initial ram disk.
222
0806e3f6
FB
223@item -nographic
224
225Normally, QEMU uses SDL to display the VGA output. With this option,
226you can totally disable graphical output so that QEMU is a simple
227command line application. The emulated serial port is redirected on
228the console. Therefore, you can still use QEMU to debug a Linux kernel
229with a serial console.
230
231@end table
232
1f673135
FB
233Network options:
234
235@table @option
236
237@item -n script
238Set network init script [default=/etc/qemu-ifup]. This script is
239launched to configure the host network interface (usually tun0)
240corresponding to the virtual NE2000 card.
241
242@item nics n
243Simulate @var{n} network interfaces (default=1).
244
245@item -macaddr addr
246
247Set the mac address of the first interface (the format is
248aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each
249new network interface.
250
251@item -tun-fd fd1,...
252Assumes @var{fd} talks to tap/tun and use it. Read
253@url{http://bellard.org/qemu/tetrinet.html} to have an example of its
254use.
255
256@end table
257
258Linux boot specific. When using this options, you can use a given
259Linux kernel without installing it in the disk image. It can be useful
260for easier testing of various kernels.
261
0806e3f6
FB
262@table @option
263
264@item -kernel bzImage
265Use @var{bzImage} as kernel image.
266
267@item -append cmdline
268Use @var{cmdline} as kernel command line
269
270@item -initrd file
271Use @var{file} as initial ram disk.
272
ec410fc9
FB
273@end table
274
275Debug options:
276@table @option
277@item -s
0806e3f6 278Wait gdb connection to port 1234 (@xref{gdb_usage}).
ec410fc9
FB
279@item -p port
280Change gdb connection port.
281@item -d
9d4520d0 282Output log in /tmp/qemu.log
ec410fc9
FB
283@end table
284
1f673135
FB
285During emulation, if you are using the serial console, use @key{C-a h}
286to get terminal commands:
ec410fc9
FB
287
288@table @key
289@item C-a h
290Print this help
291@item C-a x
292Exit emulatior
1f47a922
FB
293@item C-a s
294Save disk data back to file (if -snapshot)
295@item C-a b
1f673135
FB
296Send break (magic sysrq in Linux)
297@item C-a c
298Switch between console and monitor
1f47a922 299@item C-a C-a
ec410fc9
FB
300Send C-a
301@end table
0806e3f6
FB
302@c man end
303
304@ignore
305
306@setfilename qemu
307@settitle QEMU System Emulator
308
1f673135
FB
309@c man begin SEEALSO
310The HTML documentation of QEMU for more precise information and Linux
311user mode emulator invocation.
312@c man end
313
314@c man begin AUTHOR
315Fabrice Bellard
316@c man end
317
318@end ignore
319
320@end ignore
321
322
323@section QEMU Monitor
324
325The QEMU monitor is used to give complex commands to the QEMU
326emulator. You can use it to:
327
328@itemize @minus
329
330@item
331Remove or insert removable medias images
332(such as CD-ROM or floppies)
333
334@item
335Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
336from a disk file.
337
338@item Inspect the VM state without an external debugger.
339
340@end itemize
341
342@subsection Commands
343
344The following commands are available:
345
346@table @option
347
348@item help or ? [cmd]
349Show the help for all commands or just for command @var{cmd}.
350
351@item commit
352Commit changes to the disk images (if -snapshot is used)
353
354@item info subcommand
355show various information about the system state
356
357@table @option
358@item info network
359show the network state
360@item info block
361show the block devices
362@item info registers
363show the cpu registers
364@item info history
365show the command line history
366@end table
367
368@item q or quit
369Quit the emulator.
370
371@item eject [-f] device
372Eject a removable media (use -f to force it).
373
374@item change device filename
375Change a removable media.
376
377@item screendump filename
378Save screen into PPM image @var{filename}.
379
380@item log item1[,...]
381Activate logging of the specified items to @file{/tmp/qemu.log}.
382
383@item savevm filename
384Save the whole virtual machine state to @var{filename}.
385
386@item loadvm filename
387Restore the whole virtual machine state from @var{filename}.
388
389@item stop
390Stop emulation.
391
392@item c or cont
393Resume emulation.
394
395@item gdbserver [port]
396Start gdbserver session (default port=1234)
397
398@item x/fmt addr
399Virtual memory dump starting at @var{addr}.
400
401@item xp /fmt addr
402Physical memory dump starting at @var{addr}.
403
404@var{fmt} is a format which tells the command how to format the
405data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
406
407@table @var
408@item count
409is the number of items to be dumped.
410
411@item format
412can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
413c (char) or i (asm instruction).
414
415@item size
416can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits)
417
418@end table
419
420Examples:
421@itemize
422@item
423Dump 10 instructions at the current instruction pointer:
424@example
425(qemu) x/10i $eip
4260x90107063: ret
4270x90107064: sti
4280x90107065: lea 0x0(%esi,1),%esi
4290x90107069: lea 0x0(%edi,1),%edi
4300x90107070: ret
4310x90107071: jmp 0x90107080
4320x90107073: nop
4330x90107074: nop
4340x90107075: nop
4350x90107076: nop
436@end example
437
438@item
439Dump 80 16 bit values at the start of the video memory.
440@example
441(qemu) xp/80hx 0xb8000
4420x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
4430x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
4440x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
4450x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
4460x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
4470x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
4480x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4490x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4500x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4510x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
452@end example
453@end itemize
454
455@item p or print/fmt expr
456
457Print expression value. Only the @var{format} part of @var{fmt} is
458used.
0806e3f6 459
1f673135 460@end table
0806e3f6 461
1f673135
FB
462@subsection Integer expressions
463
464The monitor understands integers expressions for every integer
465argument. You can use register names to get the value of specifics
466CPU registers by prefixing them with @emph{$}.
ec410fc9 467
1f47a922
FB
468@node disk_images
469@section Disk Images
470
471@subsection Raw disk images
472
473The disk images can simply be raw images of the hard disk. You can
474create them with the command:
475@example
476dd if=/dev/zero of=myimage bs=1024 count=mysize
477@end example
478where @var{myimage} is the image filename and @var{mysize} is its size
479in kilobytes.
480
481@subsection Snapshot mode
482
483If you use the option @option{-snapshot}, all disk images are
484considered as read only. When sectors in written, they are written in
485a temporary file created in @file{/tmp}. You can however force the
486write back to the raw disk images by pressing @key{C-a s}.
487
488NOTE: The snapshot mode only works with raw disk images.
489
490@subsection Copy On Write disk images
491
492QEMU also supports user mode Linux
493(@url{http://user-mode-linux.sourceforge.net/}) Copy On Write (COW)
494disk images. The COW disk images are much smaller than normal images
495as they store only modified sectors. They also permit the use of the
496same disk image template for many users.
497
498To create a COW disk images, use the command:
499
500@example
0806e3f6 501qemu-mkcow -f myrawimage.bin mycowimage.cow
1f47a922
FB
502@end example
503
504@file{myrawimage.bin} is a raw image you want to use as original disk
505image. It will never be written to.
506
507@file{mycowimage.cow} is the COW disk image which is created by
0806e3f6 508@code{qemu-mkcow}. You can use it directly with the @option{-hdx}
1f47a922
FB
509options. You must not modify the original raw disk image if you use
510COW images, as COW images only store the modified sectors from the raw
511disk image. QEMU stores the original raw disk image name and its
512modified time in the COW disk image so that chances of mistakes are
513reduced.
514
9d0fe224
FB
515If the raw disk image is not read-only, by pressing @key{C-a s} you
516can flush the COW disk image back into the raw disk image, as in
517snapshot mode.
1f47a922
FB
518
519COW disk images can also be created without a corresponding raw disk
520image. It is useful to have a big initial virtual disk image without
521using much disk space. Use:
522
523@example
0806e3f6 524qemu-mkcow mycowimage.cow 1024
1f47a922
FB
525@end example
526
527to create a 1 gigabyte empty COW disk image.
528
529NOTES:
530@enumerate
531@item
532COW disk images must be created on file systems supporting
533@emph{holes} such as ext2 or ext3.
534@item
535Since holes are used, the displayed size of the COW disk image is not
536the real one. To know it, use the @code{ls -ls} command.
537@end enumerate
538
1f673135
FB
539@section Direct Linux Boot and Network emulation
540
541This section explains how to launch a Linux kernel inside QEMU without
542having to make a full bootable image. It is very useful for fast Linux
543kernel testing. The QEMU network configuration is also explained.
544
545@enumerate
546@item
547Download the archive @file{linux-test-xxx.tar.gz} containing a Linux
548kernel and a disk image.
549
550@item Optional: If you want network support (for example to launch X11 examples), you
551must copy the script @file{qemu-ifup} in @file{/etc} and configure
552properly @code{sudo} so that the command @code{ifconfig} contained in
553@file{qemu-ifup} can be executed as root. You must verify that your host
554kernel supports the TUN/TAP network interfaces: the device
555@file{/dev/net/tun} must be present.
556
557When network is enabled, there is a virtual network connection between
558the host kernel and the emulated kernel. The emulated kernel is seen
559from the host kernel at IP address 172.20.0.2 and the host kernel is
560seen from the emulated kernel at IP address 172.20.0.1.
561
562@item Launch @code{qemu.sh}. You should have the following output:
563
564@example
565> ./qemu.sh
566Connected to host network interface: tun0
567Linux 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
568BIOS-provided physical RAM map:
569 BIOS-e801: 0000000000000000 - 000000000009f000 (usable)
570 BIOS-e801: 0000000000100000 - 0000000002000000 (usable)
57132MB LOWMEM available.
572On node 0 totalpages: 8192
573zone(0): 4096 pages.
574zone(1): 4096 pages.
575zone(2): 0 pages.
576Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe console=ttyS0
577ide_setup: ide2=noprobe
578ide_setup: ide3=noprobe
579ide_setup: ide4=noprobe
580ide_setup: ide5=noprobe
581Initializing CPU#0
582Detected 2399.621 MHz processor.
583Console: colour EGA 80x25
584Calibrating delay loop... 4744.80 BogoMIPS
585Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, 0k highmem)
586Dentry cache hash table entries: 4096 (order: 3, 32768 bytes)
587Inode cache hash table entries: 2048 (order: 2, 16384 bytes)
588Mount cache hash table entries: 512 (order: 0, 4096 bytes)
589Buffer-cache hash table entries: 1024 (order: 0, 4096 bytes)
590Page-cache hash table entries: 8192 (order: 3, 32768 bytes)
591CPU: Intel Pentium Pro stepping 03
592Checking 'hlt' instruction... OK.
593POSIX conformance testing by UNIFIX
594Linux NET4.0 for Linux 2.4
595Based upon Swansea University Computer Society NET3.039
596Initializing RT netlink socket
597apm: BIOS not found.
598Starting kswapd
599Journalled Block Device driver loaded
600Detected PS/2 Mouse Port.
601pty: 256 Unix98 ptys configured
602Serial driver version 5.05c (2001-07-08) with no serial options enabled
603ttyS00 at 0x03f8 (irq = 4) is a 16450
604ne.c:v1.10 9/23/94 Donald Becker (becker@scyld.com)
605Last modified Nov 1, 2000 by Paul Gortmaker
606NE*000 ethercard probe at 0x300: 52 54 00 12 34 56
607eth0: NE2000 found at 0x300, using IRQ 9.
608RAMDISK driver initialized: 16 RAM disks of 4096K size 1024 blocksize
609Uniform Multi-Platform E-IDE driver Revision: 7.00beta4-2.4
610ide: Assuming 50MHz system bus speed for PIO modes; override with idebus=xx
611hda: QEMU HARDDISK, ATA DISK drive
612ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
613hda: attached ide-disk driver.
614hda: 20480 sectors (10 MB) w/256KiB Cache, CHS=20/16/63
615Partition check:
616 hda:
617Soundblaster audio driver Copyright (C) by Hannu Savolainen 1993-1996
618NET4: Linux TCP/IP 1.0 for NET4.0
619IP Protocols: ICMP, UDP, TCP, IGMP
620IP: routing cache hash table of 512 buckets, 4Kbytes
621TCP: Hash tables configured (established 2048 bind 4096)
622NET4: Unix domain sockets 1.0/SMP for Linux NET4.0.
623EXT2-fs warning: mounting unchecked fs, running e2fsck is recommended
624VFS: Mounted root (ext2 filesystem).
625Freeing unused kernel memory: 64k freed
626
627Linux 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
628
629QEMU Linux test distribution (based on Redhat 9)
630
631Type 'exit' to halt the system
632
633sh-2.05b#
634@end example
635
636@item
637Then you can play with the kernel inside the virtual serial console. You
638can launch @code{ls} for example. Type @key{Ctrl-a h} to have an help
639about the keys you can type inside the virtual serial console. In
640particular, use @key{Ctrl-a x} to exit QEMU and use @key{Ctrl-a b} as
641the Magic SysRq key.
642
643@item
644If the network is enabled, launch the script @file{/etc/linuxrc} in the
645emulator (don't forget the leading dot):
646@example
647. /etc/linuxrc
648@end example
649
650Then enable X11 connections on your PC from the emulated Linux:
651@example
652xhost +172.20.0.2
653@end example
654
655You can now launch @file{xterm} or @file{xlogo} and verify that you have
656a real Virtual Linux system !
657
658@end enumerate
659
660NOTES:
661@enumerate
662@item
663A 2.5.74 kernel is also included in the archive. Just
664replace the bzImage in qemu.sh to try it.
665
666@item
667qemu-fast creates a temporary file in @var{$QEMU_TMPDIR} (@file{/tmp} is the
668default) containing all the simulated PC memory. If possible, try to use
669a temporary directory using the tmpfs filesystem to avoid too many
670unnecessary disk accesses.
671
672@item
673In order to exit cleanly from qemu, you can do a @emph{shutdown} inside
674qemu. qemu will automatically exit when the Linux shutdown is done.
675
676@item
677You can boot slightly faster by disabling the probe of non present IDE
678interfaces. To do so, add the following options on the kernel command
679line:
680@example
681ide1=noprobe ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe
682@end example
683
684@item
685The example disk image is a modified version of the one made by Kevin
686Lawton for the plex86 Project (@url{www.plex86.org}).
687
688@end enumerate
689
0806e3f6 690@node linux_compile
4690764b
FB
691@section Linux Kernel Compilation
692
285dc330 693You can use any linux kernel with QEMU. However, if you want to use
1f673135
FB
694@code{qemu-fast} to get maximum performances, you must use a modified
695guest kernel. If you are using a 2.6 guest kernel, you can use
696directly the patch @file{linux-2.6-qemu-fast.patch} made by Rusty
697Russel available in the QEMU source archive. Otherwise, you can make the
698following changes @emph{by hand} to the Linux kernel:
1eb20527 699
4690764b
FB
700@enumerate
701@item
702The kernel must be mapped at 0x90000000 (the default is
7030xc0000000). You must modify only two lines in the kernel source:
1eb20527 704
4690764b 705In @file{include/asm/page.h}, replace
1eb20527
FB
706@example
707#define __PAGE_OFFSET (0xc0000000)
708@end example
709by
710@example
711#define __PAGE_OFFSET (0x90000000)
712@end example
713
4690764b 714And in @file{arch/i386/vmlinux.lds}, replace
1eb20527
FB
715@example
716 . = 0xc0000000 + 0x100000;
717@end example
718by
719@example
720 . = 0x90000000 + 0x100000;
721@end example
722
4690764b
FB
723@item
724If you want to enable SMP (Symmetric Multi-Processing) support, you
725must make the following change in @file{include/asm/fixmap.h}. Replace
1eb20527 726@example
4690764b 727#define FIXADDR_TOP (0xffffX000UL)
1eb20527 728@end example
4690764b
FB
729by
730@example
731#define FIXADDR_TOP (0xa7ffX000UL)
732@end example
733(X is 'e' or 'f' depending on the kernel version). Although you can
734use an SMP kernel with QEMU, it only supports one CPU.
1eb20527 735
4690764b 736@item
1f673135
FB
737If you are not using a 2.6 kernel as host kernel but if you use a target
7382.6 kernel, you must also ensure that the 'HZ' define is set to 100
d5a0b50c 739(1000 is the default) as QEMU cannot currently emulate timers at
1f673135 740frequencies greater than 100 Hz on host Linux systems < 2.6. In
4690764b 741@file{include/asm/param.h}, replace:
d5a0b50c
FB
742
743@example
744# define HZ 1000 /* Internal kernel timer frequency */
745@end example
746by
747@example
748# define HZ 100 /* Internal kernel timer frequency */
749@end example
750
4690764b
FB
751@end enumerate
752
753The file config-2.x.x gives the configuration of the example kernels.
754
755Just type
756@example
757make bzImage
758@end example
759
760As you would do to make a real kernel. Then you can use with QEMU
761exactly the same kernel as you would boot on your PC (in
762@file{arch/i386/boot/bzImage}).
da415d54 763
0806e3f6 764@node gdb_usage
da415d54
FB
765@section GDB usage
766
767QEMU has a primitive support to work with gdb, so that you can do
0806e3f6 768'Ctrl-C' while the virtual machine is running and inspect its state.
da415d54 769
9d4520d0 770In order to use gdb, launch qemu with the '-s' option. It will wait for a
da415d54
FB
771gdb connection:
772@example
6c9bf893 773> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
da415d54
FB
774Connected to host network interface: tun0
775Waiting gdb connection on port 1234
776@end example
777
778Then launch gdb on the 'vmlinux' executable:
779@example
780> gdb vmlinux
781@end example
782
783In gdb, connect to QEMU:
784@example
6c9bf893 785(gdb) target remote localhost:1234
da415d54
FB
786@end example
787
788Then you can use gdb normally. For example, type 'c' to launch the kernel:
789@example
790(gdb) c
791@end example
792
0806e3f6
FB
793Here are some useful tips in order to use gdb on system code:
794
795@enumerate
796@item
797Use @code{info reg} to display all the CPU registers.
798@item
799Use @code{x/10i $eip} to display the code at the PC position.
800@item
801Use @code{set architecture i8086} to dump 16 bit code. Then use
802@code{x/10i $cs*16+*eip} to dump the code at the PC position.
803@end enumerate
804
1f673135 805@chapter QEMU User space emulator invocation
386405f7 806
1f673135 807@section Quick Start
df0f11a0 808
1f673135
FB
809In order to launch a Linux process, QEMU needs the process executable
810itself and all the target (x86) dynamic libraries used by it.
386405f7 811
1f673135 812@itemize
386405f7 813
1f673135
FB
814@item On x86, you can just try to launch any process by using the native
815libraries:
386405f7 816
1f673135
FB
817@example
818qemu-i386 -L / /bin/ls
819@end example
386405f7 820
1f673135
FB
821@code{-L /} tells that the x86 dynamic linker must be searched with a
822@file{/} prefix.
386405f7 823
1f673135 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):
386405f7 825
1f673135
FB
826@example
827qemu-i386 -L / qemu-i386 -L / /bin/ls
828@end example
386405f7 829
1f673135
FB
830@item On non x86 CPUs, you need first to download at least an x86 glibc
831(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
832@code{LD_LIBRARY_PATH} is not set:
df0f11a0 833
1f673135
FB
834@example
835unset LD_LIBRARY_PATH
836@end example
1eb87257 837
1f673135 838Then you can launch the precompiled @file{ls} x86 executable:
1eb87257 839
1f673135
FB
840@example
841qemu-i386 tests/i386/ls
842@end example
843You can look at @file{qemu-binfmt-conf.sh} so that
844QEMU is automatically launched by the Linux kernel when you try to
845launch x86 executables. It requires the @code{binfmt_misc} module in the
846Linux kernel.
1eb87257 847
1f673135
FB
848@item The x86 version of QEMU is also included. You can try weird things such as:
849@example
850qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 /usr/local/qemu-i386/bin/ls-i386
851@end example
1eb20527 852
1f673135 853@end itemize
1eb20527 854
1f673135 855@section Wine launch
1eb20527 856
1f673135 857@itemize
386405f7 858
1f673135
FB
859@item Ensure that you have a working QEMU with the x86 glibc
860distribution (see previous section). In order to verify it, you must be
861able to do:
386405f7 862
1f673135
FB
863@example
864qemu-i386 /usr/local/qemu-i386/bin/ls-i386
865@end example
386405f7 866
1f673135
FB
867@item Download the binary x86 Wine install
868(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
386405f7 869
1f673135
FB
870@item Configure Wine on your account. Look at the provided script
871@file{/usr/local/qemu-i386/bin/wine-conf.sh}. Your previous
872@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
386405f7 873
1f673135 874@item Then you can try the example @file{putty.exe}:
386405f7 875
1f673135
FB
876@example
877qemu-i386 /usr/local/qemu-i386/wine/bin/wine /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
878@end example
386405f7 879
1f673135 880@end itemize
fd429f2f 881
1f673135 882@section Command line options
1eb20527 883
1f673135
FB
884@example
885usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
886@end example
1eb20527 887
1f673135
FB
888@table @option
889@item -h
890Print the help
891@item -L path
892Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
893@item -s size
894Set the x86 stack size in bytes (default=524288)
386405f7
FB
895@end table
896
1f673135 897Debug options:
386405f7 898
1f673135
FB
899@table @option
900@item -d
901Activate log (logfile=/tmp/qemu.log)
902@item -p pagesize
903Act as if the host page size was 'pagesize' bytes
904@end table
386405f7 905