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