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