![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to qemu-doc.texi CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Qemu by Fabrice Bellard] / qemu|
Return to qemu-doc.texi CVS log | Up to [Qemu by Fabrice Bellard] / qemu |
1.1 root 1: \input texinfo @c -*- texinfo -*-
1.1.1.3 root 2: @c %**start of header
3: @setfilename qemu-doc.info
1.1.1.11! root 4:
! 5: @documentlanguage en
! 6: @documentencoding UTF-8
! 7:
1.1.1.5 root 8: @settitle QEMU Emulator User Documentation
1.1.1.3 root 9: @exampleindent 0
10: @paragraphindent 0
11: @c %**end of header
1.1 root 12:
1.1.1.11! root 13: @ifinfo
! 14: @direntry
! 15: * QEMU: (qemu-doc). The QEMU Emulator User Documentation.
! 16: @end direntry
! 17: @end ifinfo
! 18:
1.1 root 19: @iftex
20: @titlepage
21: @sp 7
1.1.1.5 root 22: @center @titlefont{QEMU Emulator}
1.1.1.3 root 23: @sp 1
24: @center @titlefont{User Documentation}
1.1 root 25: @sp 3
26: @end titlepage
27: @end iftex
28:
1.1.1.3 root 29: @ifnottex
30: @node Top
31: @top
32:
33: @menu
34: * Introduction::
35: * Installation::
36: * QEMU PC System emulator::
37: * QEMU System emulator for non PC targets::
1.1.1.5 root 38: * QEMU User space emulator::
1.1.1.3 root 39: * compilation:: Compilation from the sources
1.1.1.11! root 40: * License::
1.1.1.3 root 41: * Index::
42: @end menu
43: @end ifnottex
44:
45: @contents
46:
47: @node Introduction
1.1 root 48: @chapter Introduction
49:
1.1.1.3 root 50: @menu
51: * intro_features:: Features
52: @end menu
53:
54: @node intro_features
1.1 root 55: @section Features
56:
57: QEMU is a FAST! processor emulator using dynamic translation to
58: achieve good emulation speed.
59:
60: QEMU has two operating modes:
61:
1.1.1.11! root 62: @itemize
! 63: @cindex operating modes
1.1 root 64:
1.1.1.6 root 65: @item
1.1.1.11! root 66: @cindex system emulation
1.1 root 67: Full system emulation. In this mode, QEMU emulates a full system (for
1.1.1.2 root 68: example a PC), including one or several processors and various
69: peripherals. It can be used to launch different Operating Systems
70: without rebooting the PC or to debug system code.
1.1 root 71:
1.1.1.6 root 72: @item
1.1.1.11! root 73: @cindex user mode emulation
1.1.1.5 root 74: User mode emulation. In this mode, QEMU can launch
75: processes compiled for one CPU on another CPU. It can be used to
1.1 root 76: launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
77: to ease cross-compilation and cross-debugging.
78:
79: @end itemize
80:
81: QEMU can run without an host kernel driver and yet gives acceptable
1.1.1.6 root 82: performance.
1.1 root 83:
84: For system emulation, the following hardware targets are supported:
85: @itemize
1.1.1.11! root 86: @cindex emulated target systems
! 87: @cindex supported target systems
1.1 root 88: @item PC (x86 or x86_64 processor)
1.1.1.2 root 89: @item ISA PC (old style PC without PCI bus)
1.1 root 90: @item PREP (PowerPC processor)
1.1.1.7 root 91: @item G3 Beige PowerMac (PowerPC processor)
1.1 root 92: @item Mac99 PowerMac (PowerPC processor, in progress)
1.1.1.6 root 93: @item Sun4m/Sun4c/Sun4d (32-bit Sparc processor)
1.1.1.7 root 94: @item Sun4u/Sun4v (64-bit Sparc processor, in progress)
1.1.1.6 root 95: @item Malta board (32-bit and 64-bit MIPS processors)
1.1.1.7 root 96: @item MIPS Magnum (64-bit MIPS processor)
1.1.1.6 root 97: @item ARM Integrator/CP (ARM)
98: @item ARM Versatile baseboard (ARM)
1.1.1.10 root 99: @item ARM RealView Emulation/Platform baseboard (ARM)
1.1.1.7 root 100: @item Spitz, Akita, Borzoi, Terrier and Tosa PDAs (PXA270 processor)
1.1.1.6 root 101: @item Luminary Micro LM3S811EVB (ARM Cortex-M3)
102: @item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
103: @item Freescale MCF5208EVB (ColdFire V2).
104: @item Arnewsh MCF5206 evaluation board (ColdFire V2).
105: @item Palm Tungsten|E PDA (OMAP310 processor)
1.1.1.7 root 106: @item N800 and N810 tablets (OMAP2420 processor)
107: @item MusicPal (MV88W8618 ARM processor)
108: @item Gumstix "Connex" and "Verdex" motherboards (PXA255/270).
109: @item Siemens SX1 smartphone (OMAP310 processor)
1.1.1.9 root 110: @item Syborg SVP base model (ARM Cortex-A8).
111: @item AXIS-Devboard88 (CRISv32 ETRAX-FS).
112: @item Petalogix Spartan 3aDSP1800 MMU ref design (MicroBlaze).
1.1 root 113: @end itemize
114:
1.1.1.11! root 115: @cindex supported user mode targets
! 116: For user emulation, x86 (32 and 64 bit), PowerPC (32 and 64 bit),
! 117: ARM, MIPS (32 bit only), Sparc (32 and 64 bit),
! 118: Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
1.1 root 119:
1.1.1.3 root 120: @node Installation
1.1 root 121: @chapter Installation
122:
123: If you want to compile QEMU yourself, see @ref{compilation}.
124:
1.1.1.3 root 125: @menu
126: * install_linux:: Linux
127: * install_windows:: Windows
128: * install_mac:: Macintosh
129: @end menu
130:
131: @node install_linux
1.1 root 132: @section Linux
1.1.1.11! root 133: @cindex installation (Linux)
1.1 root 134:
135: If a precompiled package is available for your distribution - you just
136: have to install it. Otherwise, see @ref{compilation}.
137:
1.1.1.3 root 138: @node install_windows
1.1 root 139: @section Windows
1.1.1.11! root 140: @cindex installation (Windows)
1.1 root 141:
142: Download the experimental binary installer at
1.1.1.3 root 143: @url{http://www.free.oszoo.org/@/download.html}.
1.1.1.11! root 144: TODO (no longer available)
1.1 root 145:
1.1.1.3 root 146: @node install_mac
1.1 root 147: @section Mac OS X
148:
149: Download the experimental binary installer at
1.1.1.3 root 150: @url{http://www.free.oszoo.org/@/download.html}.
1.1.1.11! root 151: TODO (no longer available)
1.1 root 152:
1.1.1.3 root 153: @node QEMU PC System emulator
1.1.1.2 root 154: @chapter QEMU PC System emulator
1.1.1.11! root 155: @cindex system emulation (PC)
1.1 root 156:
1.1.1.3 root 157: @menu
158: * pcsys_introduction:: Introduction
159: * pcsys_quickstart:: Quick Start
160: * sec_invocation:: Invocation
161: * pcsys_keys:: Keys
162: * pcsys_monitor:: QEMU Monitor
163: * disk_images:: Disk Images
164: * pcsys_network:: Network emulation
165: * direct_linux_boot:: Direct Linux Boot
166: * pcsys_usb:: USB emulation
1.1.1.6 root 167: * vnc_security:: VNC security
1.1.1.3 root 168: * gdb_usage:: GDB usage
169: * pcsys_os_specific:: Target OS specific information
170: @end menu
171:
172: @node pcsys_introduction
1.1 root 173: @section Introduction
174:
175: @c man begin DESCRIPTION
176:
1.1.1.2 root 177: The QEMU PC System emulator simulates the
178: following peripherals:
1.1 root 179:
180: @itemize @minus
1.1.1.6 root 181: @item
1.1 root 182: i440FX host PCI bridge and PIIX3 PCI to ISA bridge
183: @item
184: Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
185: extensions (hardware level, including all non standard modes).
186: @item
187: PS/2 mouse and keyboard
1.1.1.6 root 188: @item
1.1 root 189: 2 PCI IDE interfaces with hard disk and CD-ROM support
190: @item
191: Floppy disk
1.1.1.6 root 192: @item
1.1.1.9 root 193: PCI and ISA network adapters
1.1 root 194: @item
195: Serial ports
196: @item
1.1.1.2 root 197: Creative SoundBlaster 16 sound card
198: @item
199: ENSONIQ AudioPCI ES1370 sound card
200: @item
1.1.1.7 root 201: Intel 82801AA AC97 Audio compatible sound card
202: @item
1.1.1.2 root 203: Adlib(OPL2) - Yamaha YM3812 compatible chip
204: @item
1.1.1.7 root 205: Gravis Ultrasound GF1 sound card
206: @item
207: CS4231A compatible sound card
208: @item
1.1.1.2 root 209: PCI UHCI USB controller and a virtual USB hub.
1.1 root 210: @end itemize
211:
1.1.1.2 root 212: SMP is supported with up to 255 CPUs.
213:
1.1.1.7 root 214: Note that adlib, gus and cs4231a are only available when QEMU was
215: configured with --audio-card-list option containing the name(s) of
216: required card(s).
1.1.1.2 root 217:
1.1 root 218: QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
219: VGA BIOS.
220:
1.1.1.2 root 221: QEMU uses YM3812 emulation by Tatsuyuki Satoh.
222:
1.1.1.7 root 223: QEMU uses GUS emulation(GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
224: by Tibor "TS" Schütz.
225:
1.1.1.10 root 226: Not that, by default, GUS shares IRQ(7) with parallel ports and so
227: qemu must be told to not have parallel ports to have working GUS
228:
229: @example
230: qemu dos.img -soundhw gus -parallel none
231: @end example
232:
233: Alternatively:
234: @example
235: qemu dos.img -device gus,irq=5
236: @end example
237:
238: Or some other unclaimed IRQ.
239:
1.1.1.7 root 240: CS4231A is the chip used in Windows Sound System and GUSMAX products
241:
1.1 root 242: @c man end
243:
1.1.1.3 root 244: @node pcsys_quickstart
1.1 root 245: @section Quick Start
1.1.1.11! root 246: @cindex quick start
1.1 root 247:
248: Download and uncompress the linux image (@file{linux.img}) and type:
249:
250: @example
251: qemu linux.img
252: @end example
253:
254: Linux should boot and give you a prompt.
255:
256: @node sec_invocation
257: @section Invocation
258:
259: @example
260: @c man begin SYNOPSIS
1.1.1.6 root 261: usage: qemu [options] [@var{disk_image}]
1.1 root 262: @c man end
263: @end example
264:
265: @c man begin OPTIONS
1.1.1.7 root 266: @var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
267: targets do not need a disk image.
1.1 root 268:
1.1.1.9 root 269: @include qemu-options.texi
1.1 root 270:
271: @c man end
272:
1.1.1.3 root 273: @node pcsys_keys
1.1 root 274: @section Keys
275:
276: @c man begin OPTIONS
277:
278: During the graphical emulation, you can use the following keys:
279: @table @key
280: @item Ctrl-Alt-f
1.1.1.11! root 281: @kindex Ctrl-Alt-f
1.1 root 282: Toggle full screen
283:
1.1.1.10 root 284: @item Ctrl-Alt-u
1.1.1.11! root 285: @kindex Ctrl-Alt-u
1.1.1.10 root 286: Restore the screen's un-scaled dimensions
287:
1.1 root 288: @item Ctrl-Alt-n
1.1.1.11! root 289: @kindex Ctrl-Alt-n
1.1 root 290: Switch to virtual console 'n'. Standard console mappings are:
291: @table @emph
292: @item 1
293: Target system display
294: @item 2
295: Monitor
296: @item 3
297: Serial port
298: @end table
299:
300: @item Ctrl-Alt
1.1.1.11! root 301: @kindex Ctrl-Alt
1.1 root 302: Toggle mouse and keyboard grab.
303: @end table
304:
1.1.1.11! root 305: @kindex Ctrl-Up
! 306: @kindex Ctrl-Down
! 307: @kindex Ctrl-PageUp
! 308: @kindex Ctrl-PageDown
1.1 root 309: In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
310: @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
311:
1.1.1.11! root 312: @kindex Ctrl-a h
1.1 root 313: During emulation, if you are using the @option{-nographic} option, use
314: @key{Ctrl-a h} to get terminal commands:
315:
316: @table @key
317: @item Ctrl-a h
1.1.1.11! root 318: @kindex Ctrl-a h
1.1.1.7 root 319: @item Ctrl-a ?
1.1.1.11! root 320: @kindex Ctrl-a ?
1.1 root 321: Print this help
1.1.1.6 root 322: @item Ctrl-a x
1.1.1.11! root 323: @kindex Ctrl-a x
1.1.1.5 root 324: Exit emulator
1.1.1.6 root 325: @item Ctrl-a s
1.1.1.11! root 326: @kindex Ctrl-a s
1.1 root 327: Save disk data back to file (if -snapshot)
1.1.1.6 root 328: @item Ctrl-a t
1.1.1.11! root 329: @kindex Ctrl-a t
1.1.1.7 root 330: Toggle console timestamps
1.1 root 331: @item Ctrl-a b
1.1.1.11! root 332: @kindex Ctrl-a b
1.1 root 333: Send break (magic sysrq in Linux)
334: @item Ctrl-a c
1.1.1.11! root 335: @kindex Ctrl-a c
1.1 root 336: Switch between console and monitor
337: @item Ctrl-a Ctrl-a
1.1.1.11! root 338: @kindex Ctrl-a a
1.1 root 339: Send Ctrl-a
340: @end table
341: @c man end
342:
343: @ignore
344:
345: @c man begin SEEALSO
346: The HTML documentation of QEMU for more precise information and Linux
347: user mode emulator invocation.
348: @c man end
349:
350: @c man begin AUTHOR
351: Fabrice Bellard
352: @c man end
353:
354: @end ignore
355:
1.1.1.3 root 356: @node pcsys_monitor
1.1 root 357: @section QEMU Monitor
1.1.1.11! root 358: @cindex QEMU monitor
1.1 root 359:
360: The QEMU monitor is used to give complex commands to the QEMU
361: emulator. You can use it to:
362:
363: @itemize @minus
364:
365: @item
1.1.1.6 root 366: Remove or insert removable media images
367: (such as CD-ROM or floppies).
1.1 root 368:
1.1.1.6 root 369: @item
1.1 root 370: Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
371: from a disk file.
372:
373: @item Inspect the VM state without an external debugger.
374:
375: @end itemize
376:
377: @subsection Commands
378:
379: The following commands are available:
380:
1.1.1.9 root 381: @include qemu-monitor.texi
1.1 root 382:
383: @subsection Integer expressions
384:
385: The monitor understands integers expressions for every integer
386: argument. You can use register names to get the value of specifics
387: CPU registers by prefixing them with @emph{$}.
388:
389: @node disk_images
390: @section Disk Images
391:
392: Since version 0.6.1, QEMU supports many disk image formats, including
393: growable disk images (their size increase as non empty sectors are
1.1.1.5 root 394: written), compressed and encrypted disk images. Version 0.8.3 added
395: the new qcow2 disk image format which is essential to support VM
396: snapshots.
1.1 root 397:
1.1.1.3 root 398: @menu
399: * disk_images_quickstart:: Quick start for disk image creation
400: * disk_images_snapshot_mode:: Snapshot mode
1.1.1.5 root 401: * vm_snapshots:: VM snapshots
1.1.1.3 root 402: * qemu_img_invocation:: qemu-img Invocation
1.1.1.7 root 403: * qemu_nbd_invocation:: qemu-nbd Invocation
1.1.1.5 root 404: * host_drives:: Using host drives
1.1.1.3 root 405: * disk_images_fat_images:: Virtual FAT disk images
1.1.1.7 root 406: * disk_images_nbd:: NBD access
1.1.1.3 root 407: @end menu
408:
409: @node disk_images_quickstart
1.1 root 410: @subsection Quick start for disk image creation
411:
412: You can create a disk image with the command:
413: @example
414: qemu-img create myimage.img mysize
415: @end example
416: where @var{myimage.img} is the disk image filename and @var{mysize} is its
417: size in kilobytes. You can add an @code{M} suffix to give the size in
418: megabytes and a @code{G} suffix for gigabytes.
419:
1.1.1.3 root 420: See @ref{qemu_img_invocation} for more information.
1.1 root 421:
1.1.1.3 root 422: @node disk_images_snapshot_mode
1.1 root 423: @subsection Snapshot mode
424:
425: If you use the option @option{-snapshot}, all disk images are
426: considered as read only. When sectors in written, they are written in
427: a temporary file created in @file{/tmp}. You can however force the
428: write back to the raw disk images by using the @code{commit} monitor
429: command (or @key{C-a s} in the serial console).
430:
1.1.1.5 root 431: @node vm_snapshots
432: @subsection VM snapshots
433:
434: VM snapshots are snapshots of the complete virtual machine including
435: CPU state, RAM, device state and the content of all the writable
436: disks. In order to use VM snapshots, you must have at least one non
437: removable and writable block device using the @code{qcow2} disk image
438: format. Normally this device is the first virtual hard drive.
439:
440: Use the monitor command @code{savevm} to create a new VM snapshot or
441: replace an existing one. A human readable name can be assigned to each
442: snapshot in addition to its numerical ID.
443:
444: Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
445: a VM snapshot. @code{info snapshots} lists the available snapshots
446: with their associated information:
447:
448: @example
449: (qemu) info snapshots
450: Snapshot devices: hda
451: Snapshot list (from hda):
452: ID TAG VM SIZE DATE VM CLOCK
453: 1 start 41M 2006-08-06 12:38:02 00:00:14.954
454: 2 40M 2006-08-06 12:43:29 00:00:18.633
455: 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
456: @end example
457:
458: A VM snapshot is made of a VM state info (its size is shown in
459: @code{info snapshots}) and a snapshot of every writable disk image.
460: The VM state info is stored in the first @code{qcow2} non removable
461: and writable block device. The disk image snapshots are stored in
462: every disk image. The size of a snapshot in a disk image is difficult
463: to evaluate and is not shown by @code{info snapshots} because the
464: associated disk sectors are shared among all the snapshots to save
465: disk space (otherwise each snapshot would need a full copy of all the
466: disk images).
467:
468: When using the (unrelated) @code{-snapshot} option
469: (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
470: but they are deleted as soon as you exit QEMU.
471:
472: VM snapshots currently have the following known limitations:
473: @itemize
1.1.1.6 root 474: @item
1.1.1.5 root 475: They cannot cope with removable devices if they are removed or
476: inserted after a snapshot is done.
1.1.1.6 root 477: @item
1.1.1.5 root 478: A few device drivers still have incomplete snapshot support so their
479: state is not saved or restored properly (in particular USB).
480: @end itemize
481:
1.1 root 482: @node qemu_img_invocation
483: @subsection @code{qemu-img} Invocation
484:
485: @include qemu-img.texi
486:
1.1.1.7 root 487: @node qemu_nbd_invocation
488: @subsection @code{qemu-nbd} Invocation
489:
490: @include qemu-nbd.texi
491:
1.1.1.5 root 492: @node host_drives
493: @subsection Using host drives
494:
495: In addition to disk image files, QEMU can directly access host
496: devices. We describe here the usage for QEMU version >= 0.8.3.
497:
498: @subsubsection Linux
499:
500: On Linux, you can directly use the host device filename instead of a
1.1.1.6 root 501: disk image filename provided you have enough privileges to access
1.1.1.5 root 502: it. For example, use @file{/dev/cdrom} to access to the CDROM or
503: @file{/dev/fd0} for the floppy.
504:
505: @table @code
506: @item CD
507: You can specify a CDROM device even if no CDROM is loaded. QEMU has
508: specific code to detect CDROM insertion or removal. CDROM ejection by
509: the guest OS is supported. Currently only data CDs are supported.
510: @item Floppy
511: You can specify a floppy device even if no floppy is loaded. Floppy
512: removal is currently not detected accurately (if you change floppy
513: without doing floppy access while the floppy is not loaded, the guest
514: OS will think that the same floppy is loaded).
515: @item Hard disks
516: Hard disks can be used. Normally you must specify the whole disk
517: (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
518: see it as a partitioned disk. WARNING: unless you know what you do, it
519: is better to only make READ-ONLY accesses to the hard disk otherwise
520: you may corrupt your host data (use the @option{-snapshot} command
521: line option or modify the device permissions accordingly).
522: @end table
523:
524: @subsubsection Windows
525:
526: @table @code
527: @item CD
1.1.1.6 root 528: The preferred syntax is the drive letter (e.g. @file{d:}). The
1.1.1.5 root 529: alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
530: supported as an alias to the first CDROM drive.
531:
1.1.1.6 root 532: Currently there is no specific code to handle removable media, so it
1.1.1.5 root 533: is better to use the @code{change} or @code{eject} monitor commands to
534: change or eject media.
535: @item Hard disks
1.1.1.6 root 536: Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1.1.1.5 root 537: where @var{N} is the drive number (0 is the first hard disk).
538:
539: WARNING: unless you know what you do, it is better to only make
540: READ-ONLY accesses to the hard disk otherwise you may corrupt your
541: host data (use the @option{-snapshot} command line so that the
542: modifications are written in a temporary file).
543: @end table
544:
545:
546: @subsubsection Mac OS X
547:
1.1.1.6 root 548: @file{/dev/cdrom} is an alias to the first CDROM.
1.1.1.5 root 549:
1.1.1.6 root 550: Currently there is no specific code to handle removable media, so it
1.1.1.5 root 551: is better to use the @code{change} or @code{eject} monitor commands to
552: change or eject media.
553:
1.1.1.3 root 554: @node disk_images_fat_images
1.1.1.2 root 555: @subsection Virtual FAT disk images
556:
557: QEMU can automatically create a virtual FAT disk image from a
558: directory tree. In order to use it, just type:
559:
1.1.1.6 root 560: @example
1.1.1.2 root 561: qemu linux.img -hdb fat:/my_directory
562: @end example
563:
564: Then you access access to all the files in the @file{/my_directory}
565: directory without having to copy them in a disk image or to export
566: them via SAMBA or NFS. The default access is @emph{read-only}.
1.1 root 567:
1.1.1.2 root 568: Floppies can be emulated with the @code{:floppy:} option:
1.1 root 569:
1.1.1.6 root 570: @example
1.1.1.2 root 571: qemu linux.img -fda fat:floppy:/my_directory
572: @end example
1.1 root 573:
1.1.1.2 root 574: A read/write support is available for testing (beta stage) with the
575: @code{:rw:} option:
576:
1.1.1.6 root 577: @example
1.1.1.2 root 578: qemu linux.img -fda fat:floppy:rw:/my_directory
579: @end example
580:
581: What you should @emph{never} do:
582: @itemize
583: @item use non-ASCII filenames ;
584: @item use "-snapshot" together with ":rw:" ;
585: @item expect it to work when loadvm'ing ;
586: @item write to the FAT directory on the host system while accessing it with the guest system.
587: @end itemize
588:
1.1.1.7 root 589: @node disk_images_nbd
590: @subsection NBD access
591:
592: QEMU can access directly to block device exported using the Network Block Device
593: protocol.
594:
595: @example
596: qemu linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
597: @end example
598:
599: If the NBD server is located on the same host, you can use an unix socket instead
600: of an inet socket:
601:
602: @example
603: qemu linux.img -hdb nbd:unix:/tmp/my_socket
604: @end example
605:
606: In this case, the block device must be exported using qemu-nbd:
607:
608: @example
609: qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
610: @end example
611:
612: The use of qemu-nbd allows to share a disk between several guests:
613: @example
614: qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
615: @end example
616:
617: and then you can use it with two guests:
618: @example
619: qemu linux1.img -hdb nbd:unix:/tmp/my_socket
620: qemu linux2.img -hdb nbd:unix:/tmp/my_socket
621: @end example
622:
1.1.1.3 root 623: @node pcsys_network
1.1.1.2 root 624: @section Network emulation
625:
1.1.1.6 root 626: QEMU can simulate several network cards (PCI or ISA cards on the PC
1.1.1.2 root 627: target) and can connect them to an arbitrary number of Virtual Local
628: Area Networks (VLANs). Host TAP devices can be connected to any QEMU
629: VLAN. VLAN can be connected between separate instances of QEMU to
1.1.1.6 root 630: simulate large networks. For simpler usage, a non privileged user mode
1.1.1.2 root 631: network stack can replace the TAP device to have a basic network
632: connection.
633:
634: @subsection VLANs
635:
636: QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
637: connection between several network devices. These devices can be for
638: example QEMU virtual Ethernet cards or virtual Host ethernet devices
639: (TAP devices).
640:
641: @subsection Using TAP network interfaces
642:
643: This is the standard way to connect QEMU to a real network. QEMU adds
644: a virtual network device on your host (called @code{tapN}), and you
645: can then configure it as if it was a real ethernet card.
1.1 root 646:
1.1.1.5 root 647: @subsubsection Linux host
648:
1.1 root 649: As an example, you can download the @file{linux-test-xxx.tar.gz}
650: archive and copy the script @file{qemu-ifup} in @file{/etc} and
651: configure properly @code{sudo} so that the command @code{ifconfig}
652: contained in @file{qemu-ifup} can be executed as root. You must verify
1.1.1.2 root 653: that your host kernel supports the TAP network interfaces: the
1.1 root 654: device @file{/dev/net/tun} must be present.
655:
1.1.1.5 root 656: See @ref{sec_invocation} to have examples of command lines using the
657: TAP network interfaces.
658:
659: @subsubsection Windows host
660:
661: There is a virtual ethernet driver for Windows 2000/XP systems, called
662: TAP-Win32. But it is not included in standard QEMU for Windows,
663: so you will need to get it separately. It is part of OpenVPN package,
664: so download OpenVPN from : @url{http://openvpn.net/}.
1.1 root 665:
666: @subsection Using the user mode network stack
667:
1.1.1.2 root 668: By using the option @option{-net user} (default configuration if no
669: @option{-net} option is specified), QEMU uses a completely user mode
1.1.1.6 root 670: network stack (you don't need root privilege to use the virtual
1.1.1.2 root 671: network). The virtual network configuration is the following:
1.1 root 672:
673: @example
674:
1.1.1.2 root 675: QEMU VLAN <------> Firewall/DHCP server <-----> Internet
676: | (10.0.2.2)
1.1 root 677: |
678: ----> DNS server (10.0.2.3)
1.1.1.6 root 679: |
1.1 root 680: ----> SMB server (10.0.2.4)
681: @end example
682:
683: The QEMU VM behaves as if it was behind a firewall which blocks all
684: incoming connections. You can use a DHCP client to automatically
1.1.1.2 root 685: configure the network in the QEMU VM. The DHCP server assign addresses
686: to the hosts starting from 10.0.2.15.
1.1 root 687:
688: In order to check that the user mode network is working, you can ping
689: the address 10.0.2.2 and verify that you got an address in the range
690: 10.0.2.x from the QEMU virtual DHCP server.
691:
692: Note that @code{ping} is not supported reliably to the internet as it
1.1.1.6 root 693: would require root privileges. It means you can only ping the local
1.1 root 694: router (10.0.2.2).
695:
696: When using the built-in TFTP server, the router is also the TFTP
697: server.
698:
699: When using the @option{-redir} option, TCP or UDP connections can be
700: redirected from the host to the guest. It allows for example to
701: redirect X11, telnet or SSH connections.
702:
1.1.1.2 root 703: @subsection Connecting VLANs between QEMU instances
704:
705: Using the @option{-net socket} option, it is possible to make VLANs
706: that span several QEMU instances. See @ref{sec_invocation} to have a
707: basic example.
708:
1.1.1.11! root 709: @section Other Devices
! 710:
! 711: @subsection Inter-VM Shared Memory device
! 712:
! 713: With KVM enabled on a Linux host, a shared memory device is available. Guests
! 714: map a POSIX shared memory region into the guest as a PCI device that enables
! 715: zero-copy communication to the application level of the guests. The basic
! 716: syntax is:
! 717:
! 718: @example
! 719: qemu -device ivshmem,size=<size in format accepted by -m>[,shm=<shm name>]
! 720: @end example
! 721:
! 722: If desired, interrupts can be sent between guest VMs accessing the same shared
! 723: memory region. Interrupt support requires using a shared memory server and
! 724: using a chardev socket to connect to it. The code for the shared memory server
! 725: is qemu.git/contrib/ivshmem-server. An example syntax when using the shared
! 726: memory server is:
! 727:
! 728: @example
! 729: qemu -device ivshmem,size=<size in format accepted by -m>[,chardev=<id>]
! 730: [,msi=on][,ioeventfd=on][,vectors=n][,role=peer|master]
! 731: qemu -chardev socket,path=<path>,id=<id>
! 732: @end example
! 733:
! 734: When using the server, the guest will be assigned a VM ID (>=0) that allows guests
! 735: using the same server to communicate via interrupts. Guests can read their
! 736: VM ID from a device register (see example code). Since receiving the shared
! 737: memory region from the server is asynchronous, there is a (small) chance the
! 738: guest may boot before the shared memory is attached. To allow an application
! 739: to ensure shared memory is attached, the VM ID register will return -1 (an
! 740: invalid VM ID) until the memory is attached. Once the shared memory is
! 741: attached, the VM ID will return the guest's valid VM ID. With these semantics,
! 742: the guest application can check to ensure the shared memory is attached to the
! 743: guest before proceeding.
! 744:
! 745: The @option{role} argument can be set to either master or peer and will affect
! 746: how the shared memory is migrated. With @option{role=master}, the guest will
! 747: copy the shared memory on migration to the destination host. With
! 748: @option{role=peer}, the guest will not be able to migrate with the device attached.
! 749: With the @option{peer} case, the device should be detached and then reattached
! 750: after migration using the PCI hotplug support.
! 751:
1.1 root 752: @node direct_linux_boot
753: @section Direct Linux Boot
754:
755: This section explains how to launch a Linux kernel inside QEMU without
756: having to make a full bootable image. It is very useful for fast Linux
1.1.1.5 root 757: kernel testing.
1.1 root 758:
1.1.1.5 root 759: The syntax is:
1.1 root 760: @example
1.1.1.5 root 761: qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1.1 root 762: @end example
763:
1.1.1.5 root 764: Use @option{-kernel} to provide the Linux kernel image and
765: @option{-append} to give the kernel command line arguments. The
766: @option{-initrd} option can be used to provide an INITRD image.
1.1 root 767:
1.1.1.5 root 768: When using the direct Linux boot, a disk image for the first hard disk
769: @file{hda} is required because its boot sector is used to launch the
770: Linux kernel.
1.1 root 771:
1.1.1.5 root 772: If you do not need graphical output, you can disable it and redirect
773: the virtual serial port and the QEMU monitor to the console with the
774: @option{-nographic} option. The typical command line is:
1.1 root 775: @example
1.1.1.5 root 776: qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
777: -append "root=/dev/hda console=ttyS0" -nographic
1.1 root 778: @end example
779:
1.1.1.5 root 780: Use @key{Ctrl-a c} to switch between the serial console and the
781: monitor (@pxref{pcsys_keys}).
1.1 root 782:
1.1.1.3 root 783: @node pcsys_usb
1.1.1.2 root 784: @section USB emulation
785:
1.1.1.4 root 786: QEMU emulates a PCI UHCI USB controller. You can virtually plug
787: virtual USB devices or real host USB devices (experimental, works only
788: on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1.1.1.5 root 789: as necessary to connect multiple USB devices.
1.1.1.2 root 790:
1.1.1.4 root 791: @menu
792: * usb_devices::
793: * host_usb_devices::
794: @end menu
795: @node usb_devices
796: @subsection Connecting USB devices
1.1.1.2 root 797:
1.1.1.4 root 798: USB devices can be connected with the @option{-usbdevice} commandline option
799: or the @code{usb_add} monitor command. Available devices are:
1.1.1.2 root 800:
1.1.1.7 root 801: @table @code
802: @item mouse
1.1.1.4 root 803: Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1.1.1.7 root 804: @item tablet
1.1.1.5 root 805: Pointer device that uses absolute coordinates (like a touchscreen).
1.1.1.4 root 806: This means qemu is able to report the mouse position without having
807: to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1.1.1.7 root 808: @item disk:@var{file}
1.1.1.4 root 809: Mass storage device based on @var{file} (@pxref{disk_images})
1.1.1.7 root 810: @item host:@var{bus.addr}
1.1.1.4 root 811: Pass through the host device identified by @var{bus.addr}
812: (Linux only)
1.1.1.7 root 813: @item host:@var{vendor_id:product_id}
1.1.1.4 root 814: Pass through the host device identified by @var{vendor_id:product_id}
815: (Linux only)
1.1.1.7 root 816: @item wacom-tablet
1.1.1.6 root 817: Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet}
818: above but it can be used with the tslib library because in addition to touch
819: coordinates it reports touch pressure.
1.1.1.7 root 820: @item keyboard
1.1.1.6 root 821: Standard USB keyboard. Will override the PS/2 keyboard (if present).
1.1.1.7 root 822: @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
823: Serial converter. This emulates an FTDI FT232BM chip connected to host character
824: device @var{dev}. The available character devices are the same as for the
825: @code{-serial} option. The @code{vendorid} and @code{productid} options can be
826: used to override the default 0403:6001. For instance,
827: @example
828: usb_add serial:productid=FA00:tcp:192.168.0.2:4444
829: @end example
830: will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
831: serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
832: @item braille
833: Braille device. This will use BrlAPI to display the braille output on a real
834: or fake device.
835: @item net:@var{options}
836: Network adapter that supports CDC ethernet and RNDIS protocols. @var{options}
837: specifies NIC options as with @code{-net nic,}@var{options} (see description).
838: For instance, user-mode networking can be used with
839: @example
840: qemu [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
841: @end example
842: Currently this cannot be used in machines that support PCI NICs.
843: @item bt[:@var{hci-type}]
844: Bluetooth dongle whose type is specified in the same format as with
845: the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}. If
846: no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
847: This USB device implements the USB Transport Layer of HCI. Example
848: usage:
849: @example
850: qemu [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
851: @end example
1.1.1.4 root 852: @end table
1.1.1.2 root 853:
1.1.1.4 root 854: @node host_usb_devices
1.1.1.2 root 855: @subsection Using host USB devices on a Linux host
856:
857: WARNING: this is an experimental feature. QEMU will slow down when
858: using it. USB devices requiring real time streaming (i.e. USB Video
859: Cameras) are not supported yet.
860:
861: @enumerate
1.1.1.6 root 862: @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1.1.1.2 root 863: is actually using the USB device. A simple way to do that is simply to
864: disable the corresponding kernel module by renaming it from @file{mydriver.o}
865: to @file{mydriver.o.disabled}.
866:
867: @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
868: @example
869: ls /proc/bus/usb
870: 001 devices drivers
871: @end example
872:
873: @item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices:
874: @example
875: chown -R myuid /proc/bus/usb
876: @end example
877:
878: @item Launch QEMU and do in the monitor:
1.1.1.6 root 879: @example
1.1.1.2 root 880: info usbhost
881: Device 1.2, speed 480 Mb/s
882: Class 00: USB device 1234:5678, USB DISK
883: @end example
884: You should see the list of the devices you can use (Never try to use
885: hubs, it won't work).
886:
887: @item Add the device in QEMU by using:
1.1.1.6 root 888: @example
1.1.1.2 root 889: usb_add host:1234:5678
890: @end example
891:
892: Normally the guest OS should report that a new USB device is
893: plugged. You can use the option @option{-usbdevice} to do the same.
894:
895: @item Now you can try to use the host USB device in QEMU.
896:
897: @end enumerate
898:
899: When relaunching QEMU, you may have to unplug and plug again the USB
900: device to make it work again (this is a bug).
901:
1.1.1.6 root 902: @node vnc_security
903: @section VNC security
904:
905: The VNC server capability provides access to the graphical console
906: of the guest VM across the network. This has a number of security
907: considerations depending on the deployment scenarios.
908:
909: @menu
910: * vnc_sec_none::
911: * vnc_sec_password::
912: * vnc_sec_certificate::
913: * vnc_sec_certificate_verify::
914: * vnc_sec_certificate_pw::
1.1.1.9 root 915: * vnc_sec_sasl::
916: * vnc_sec_certificate_sasl::
1.1.1.6 root 917: * vnc_generate_cert::
1.1.1.9 root 918: * vnc_setup_sasl::
1.1.1.6 root 919: @end menu
920: @node vnc_sec_none
921: @subsection Without passwords
922:
923: The simplest VNC server setup does not include any form of authentication.
924: For this setup it is recommended to restrict it to listen on a UNIX domain
925: socket only. For example
926:
927: @example
928: qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
929: @end example
930:
931: This ensures that only users on local box with read/write access to that
932: path can access the VNC server. To securely access the VNC server from a
933: remote machine, a combination of netcat+ssh can be used to provide a secure
934: tunnel.
935:
936: @node vnc_sec_password
937: @subsection With passwords
938:
939: The VNC protocol has limited support for password based authentication. Since
940: the protocol limits passwords to 8 characters it should not be considered
941: to provide high security. The password can be fairly easily brute-forced by
942: a client making repeat connections. For this reason, a VNC server using password
943: authentication should be restricted to only listen on the loopback interface
1.1.1.7 root 944: or UNIX domain sockets. Password authentication is requested with the @code{password}
1.1.1.6 root 945: option, and then once QEMU is running the password is set with the monitor. Until
946: the monitor is used to set the password all clients will be rejected.
947:
948: @example
949: qemu [...OPTIONS...] -vnc :1,password -monitor stdio
950: (qemu) change vnc password
951: Password: ********
952: (qemu)
953: @end example
954:
955: @node vnc_sec_certificate
956: @subsection With x509 certificates
957:
958: The QEMU VNC server also implements the VeNCrypt extension allowing use of
959: TLS for encryption of the session, and x509 certificates for authentication.
960: The use of x509 certificates is strongly recommended, because TLS on its
961: own is susceptible to man-in-the-middle attacks. Basic x509 certificate
962: support provides a secure session, but no authentication. This allows any
963: client to connect, and provides an encrypted session.
964:
965: @example
966: qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
967: @end example
968:
969: In the above example @code{/etc/pki/qemu} should contain at least three files,
970: @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
971: users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
972: NB the @code{server-key.pem} file should be protected with file mode 0600 to
973: only be readable by the user owning it.
974:
975: @node vnc_sec_certificate_verify
976: @subsection With x509 certificates and client verification
977:
978: Certificates can also provide a means to authenticate the client connecting.
979: The server will request that the client provide a certificate, which it will
980: then validate against the CA certificate. This is a good choice if deploying
981: in an environment with a private internal certificate authority.
982:
983: @example
984: qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
985: @end example
986:
987:
988: @node vnc_sec_certificate_pw
989: @subsection With x509 certificates, client verification and passwords
990:
991: Finally, the previous method can be combined with VNC password authentication
992: to provide two layers of authentication for clients.
993:
994: @example
995: qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
996: (qemu) change vnc password
997: Password: ********
998: (qemu)
999: @end example
1000:
1.1.1.9 root 1001:
1002: @node vnc_sec_sasl
1003: @subsection With SASL authentication
1004:
1005: The SASL authentication method is a VNC extension, that provides an
1006: easily extendable, pluggable authentication method. This allows for
1007: integration with a wide range of authentication mechanisms, such as
1008: PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1009: The strength of the authentication depends on the exact mechanism
1010: configured. If the chosen mechanism also provides a SSF layer, then
1011: it will encrypt the datastream as well.
1012:
1013: Refer to the later docs on how to choose the exact SASL mechanism
1014: used for authentication, but assuming use of one supporting SSF,
1015: then QEMU can be launched with:
1016:
1017: @example
1018: qemu [...OPTIONS...] -vnc :1,sasl -monitor stdio
1019: @end example
1020:
1021: @node vnc_sec_certificate_sasl
1022: @subsection With x509 certificates and SASL authentication
1023:
1024: If the desired SASL authentication mechanism does not supported
1025: SSF layers, then it is strongly advised to run it in combination
1026: with TLS and x509 certificates. This provides securely encrypted
1027: data stream, avoiding risk of compromising of the security
1028: credentials. This can be enabled, by combining the 'sasl' option
1029: with the aforementioned TLS + x509 options:
1030:
1031: @example
1032: qemu [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1033: @end example
1034:
1035:
1.1.1.6 root 1036: @node vnc_generate_cert
1037: @subsection Generating certificates for VNC
1038:
1039: The GNU TLS packages provides a command called @code{certtool} which can
1040: be used to generate certificates and keys in PEM format. At a minimum it
1041: is neccessary to setup a certificate authority, and issue certificates to
1042: each server. If using certificates for authentication, then each client
1043: will also need to be issued a certificate. The recommendation is for the
1044: server to keep its certificates in either @code{/etc/pki/qemu} or for
1045: unprivileged users in @code{$HOME/.pki/qemu}.
1046:
1047: @menu
1048: * vnc_generate_ca::
1049: * vnc_generate_server::
1050: * vnc_generate_client::
1051: @end menu
1052: @node vnc_generate_ca
1053: @subsubsection Setup the Certificate Authority
1054:
1055: This step only needs to be performed once per organization / organizational
1056: unit. First the CA needs a private key. This key must be kept VERY secret
1057: and secure. If this key is compromised the entire trust chain of the certificates
1058: issued with it is lost.
1059:
1060: @example
1061: # certtool --generate-privkey > ca-key.pem
1062: @end example
1063:
1064: A CA needs to have a public certificate. For simplicity it can be a self-signed
1065: certificate, or one issue by a commercial certificate issuing authority. To
1066: generate a self-signed certificate requires one core piece of information, the
1067: name of the organization.
1068:
1069: @example
1070: # cat > ca.info <<EOF
1071: cn = Name of your organization
1072: ca
1073: cert_signing_key
1074: EOF
1075: # certtool --generate-self-signed \
1076: --load-privkey ca-key.pem
1077: --template ca.info \
1078: --outfile ca-cert.pem
1079: @end example
1080:
1081: The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1082: TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1083:
1084: @node vnc_generate_server
1085: @subsubsection Issuing server certificates
1086:
1087: Each server (or host) needs to be issued with a key and certificate. When connecting
1088: the certificate is sent to the client which validates it against the CA certificate.
1089: The core piece of information for a server certificate is the hostname. This should
1090: be the fully qualified hostname that the client will connect with, since the client
1091: will typically also verify the hostname in the certificate. On the host holding the
1092: secure CA private key:
1093:
1094: @example
1095: # cat > server.info <<EOF
1096: organization = Name of your organization
1097: cn = server.foo.example.com
1098: tls_www_server
1099: encryption_key
1100: signing_key
1101: EOF
1102: # certtool --generate-privkey > server-key.pem
1103: # certtool --generate-certificate \
1104: --load-ca-certificate ca-cert.pem \
1105: --load-ca-privkey ca-key.pem \
1106: --load-privkey server server-key.pem \
1107: --template server.info \
1108: --outfile server-cert.pem
1109: @end example
1110:
1111: The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1112: to the server for which they were generated. The @code{server-key.pem} is security
1113: sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1114:
1115: @node vnc_generate_client
1116: @subsubsection Issuing client certificates
1117:
1118: If the QEMU VNC server is to use the @code{x509verify} option to validate client
1119: certificates as its authentication mechanism, each client also needs to be issued
1120: a certificate. The client certificate contains enough metadata to uniquely identify
1121: the client, typically organization, state, city, building, etc. On the host holding
1122: the secure CA private key:
1123:
1124: @example
1125: # cat > client.info <<EOF
1126: country = GB
1127: state = London
1128: locality = London
1129: organiazation = Name of your organization
1130: cn = client.foo.example.com
1131: tls_www_client
1132: encryption_key
1133: signing_key
1134: EOF
1135: # certtool --generate-privkey > client-key.pem
1136: # certtool --generate-certificate \
1137: --load-ca-certificate ca-cert.pem \
1138: --load-ca-privkey ca-key.pem \
1139: --load-privkey client-key.pem \
1140: --template client.info \
1141: --outfile client-cert.pem
1142: @end example
1143:
1144: The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1145: copied to the client for which they were generated.
1146:
1.1.1.9 root 1147:
1148: @node vnc_setup_sasl
1149:
1150: @subsection Configuring SASL mechanisms
1151:
1152: The following documentation assumes use of the Cyrus SASL implementation on a
1153: Linux host, but the principals should apply to any other SASL impl. When SASL
1154: is enabled, the mechanism configuration will be loaded from system default
1155: SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1156: unprivileged user, an environment variable SASL_CONF_PATH can be used
1157: to make it search alternate locations for the service config.
1158:
1159: The default configuration might contain
1160:
1161: @example
1162: mech_list: digest-md5
1163: sasldb_path: /etc/qemu/passwd.db
1164: @end example
1165:
1166: This says to use the 'Digest MD5' mechanism, which is similar to the HTTP
1167: Digest-MD5 mechanism. The list of valid usernames & passwords is maintained
1168: in the /etc/qemu/passwd.db file, and can be updated using the saslpasswd2
1169: command. While this mechanism is easy to configure and use, it is not
1170: considered secure by modern standards, so only suitable for developers /
1171: ad-hoc testing.
1172:
1173: A more serious deployment might use Kerberos, which is done with the 'gssapi'
1174: mechanism
1175:
1176: @example
1177: mech_list: gssapi
1178: keytab: /etc/qemu/krb5.tab
1179: @end example
1180:
1181: For this to work the administrator of your KDC must generate a Kerberos
1182: principal for the server, with a name of 'qemu/somehost.example.com@@EXAMPLE.COM'
1183: replacing 'somehost.example.com' with the fully qualified host name of the
1184: machine running QEMU, and 'EXAMPLE.COM' with the Keberos Realm.
1185:
1186: Other configurations will be left as an exercise for the reader. It should
1187: be noted that only Digest-MD5 and GSSAPI provides a SSF layer for data
1188: encryption. For all other mechanisms, VNC should always be configured to
1189: use TLS and x509 certificates to protect security credentials from snooping.
1190:
1.1 root 1191: @node gdb_usage
1192: @section GDB usage
1193:
1194: QEMU has a primitive support to work with gdb, so that you can do
1195: 'Ctrl-C' while the virtual machine is running and inspect its state.
1196:
1197: In order to use gdb, launch qemu with the '-s' option. It will wait for a
1198: gdb connection:
1199: @example
1.1.1.3 root 1200: > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1201: -append "root=/dev/hda"
1.1 root 1202: Connected to host network interface: tun0
1203: Waiting gdb connection on port 1234
1204: @end example
1205:
1206: Then launch gdb on the 'vmlinux' executable:
1207: @example
1208: > gdb vmlinux
1209: @end example
1210:
1211: In gdb, connect to QEMU:
1212: @example
1213: (gdb) target remote localhost:1234
1214: @end example
1215:
1216: Then you can use gdb normally. For example, type 'c' to launch the kernel:
1217: @example
1218: (gdb) c
1219: @end example
1220:
1221: Here are some useful tips in order to use gdb on system code:
1222:
1223: @enumerate
1224: @item
1225: Use @code{info reg} to display all the CPU registers.
1226: @item
1227: Use @code{x/10i $eip} to display the code at the PC position.
1228: @item
1229: Use @code{set architecture i8086} to dump 16 bit code. Then use
1.1.1.4 root 1230: @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1.1 root 1231: @end enumerate
1232:
1.1.1.7 root 1233: Advanced debugging options:
1234:
1235: The default single stepping behavior is step with the IRQs and timer service routines off. It is set this way because when gdb executes a single step it expects to advance beyond the current instruction. With the IRQs and and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed. Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB. There are three commands you can query and set the single step behavior:
1236: @table @code
1237: @item maintenance packet qqemu.sstepbits
1238:
1239: This will display the MASK bits used to control the single stepping IE:
1240: @example
1241: (gdb) maintenance packet qqemu.sstepbits
1242: sending: "qqemu.sstepbits"
1243: received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1244: @end example
1245: @item maintenance packet qqemu.sstep
1246:
1247: This will display the current value of the mask used when single stepping IE:
1248: @example
1249: (gdb) maintenance packet qqemu.sstep
1250: sending: "qqemu.sstep"
1251: received: "0x7"
1252: @end example
1253: @item maintenance packet Qqemu.sstep=HEX_VALUE
1254:
1255: This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1256: @example
1257: (gdb) maintenance packet Qqemu.sstep=0x5
1258: sending: "qemu.sstep=0x5"
1259: received: "OK"
1260: @end example
1261: @end table
1262:
1.1.1.3 root 1263: @node pcsys_os_specific
1.1 root 1264: @section Target OS specific information
1265:
1266: @subsection Linux
1267:
1268: To have access to SVGA graphic modes under X11, use the @code{vesa} or
1269: the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1270: color depth in the guest and the host OS.
1271:
1272: When using a 2.6 guest Linux kernel, you should add the option
1273: @code{clock=pit} on the kernel command line because the 2.6 Linux
1274: kernels make very strict real time clock checks by default that QEMU
1275: cannot simulate exactly.
1276:
1277: When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1278: not activated because QEMU is slower with this patch. The QEMU
1279: Accelerator Module is also much slower in this case. Earlier Fedora
1.1.1.6 root 1280: Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1.1 root 1281: patch by default. Newer kernels don't have it.
1282:
1283: @subsection Windows
1284:
1285: If you have a slow host, using Windows 95 is better as it gives the
1286: best speed. Windows 2000 is also a good choice.
1287:
1288: @subsubsection SVGA graphic modes support
1289:
1290: QEMU emulates a Cirrus Logic GD5446 Video
1291: card. All Windows versions starting from Windows 95 should recognize
1292: and use this graphic card. For optimal performances, use 16 bit color
1293: depth in the guest and the host OS.
1294:
1.1.1.4 root 1295: If you are using Windows XP as guest OS and if you want to use high
1296: resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1297: 1280x1024x16), then you should use the VESA VBE virtual graphic card
1298: (option @option{-std-vga}).
1299:
1.1 root 1300: @subsubsection CPU usage reduction
1301:
1302: Windows 9x does not correctly use the CPU HLT
1303: instruction. The result is that it takes host CPU cycles even when
1304: idle. You can install the utility from
1305: @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1306: problem. Note that no such tool is needed for NT, 2000 or XP.
1307:
1308: @subsubsection Windows 2000 disk full problem
1309:
1310: Windows 2000 has a bug which gives a disk full problem during its
1311: installation. When installing it, use the @option{-win2k-hack} QEMU
1312: option to enable a specific workaround. After Windows 2000 is
1313: installed, you no longer need this option (this option slows down the
1314: IDE transfers).
1315:
1316: @subsubsection Windows 2000 shutdown
1317:
1318: Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1319: can. It comes from the fact that Windows 2000 does not automatically
1320: use the APM driver provided by the BIOS.
1321:
1322: In order to correct that, do the following (thanks to Struan
1323: Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1324: Add/Troubleshoot a device => Add a new device & Next => No, select the
1325: hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1326: (again) a few times. Now the driver is installed and Windows 2000 now
1.1.1.6 root 1327: correctly instructs QEMU to shutdown at the appropriate moment.
1.1 root 1328:
1329: @subsubsection Share a directory between Unix and Windows
1330:
1331: See @ref{sec_invocation} about the help of the option @option{-smb}.
1332:
1.1.1.5 root 1333: @subsubsection Windows XP security problem
1.1 root 1334:
1335: Some releases of Windows XP install correctly but give a security
1336: error when booting:
1337: @example
1338: A problem is preventing Windows from accurately checking the
1339: license for this computer. Error code: 0x800703e6.
1340: @end example
1341:
1.1.1.5 root 1342: The workaround is to install a service pack for XP after a boot in safe
1343: mode. Then reboot, and the problem should go away. Since there is no
1344: network while in safe mode, its recommended to download the full
1345: installation of SP1 or SP2 and transfer that via an ISO or using the
1346: vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1.1 root 1347:
1348: @subsection MS-DOS and FreeDOS
1349:
1350: @subsubsection CPU usage reduction
1351:
1352: DOS does not correctly use the CPU HLT instruction. The result is that
1353: it takes host CPU cycles even when idle. You can install the utility
1354: from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1355: problem.
1356:
1.1.1.3 root 1357: @node QEMU System emulator for non PC targets
1.1.1.2 root 1358: @chapter QEMU System emulator for non PC targets
1359:
1360: QEMU is a generic emulator and it emulates many non PC
1361: machines. Most of the options are similar to the PC emulator. The
1.1.1.6 root 1362: differences are mentioned in the following sections.
1.1.1.2 root 1363:
1.1.1.3 root 1364: @menu
1.1.1.11! root 1365: * PowerPC System emulator::
1.1.1.6 root 1366: * Sparc32 System emulator::
1367: * Sparc64 System emulator::
1368: * MIPS System emulator::
1369: * ARM System emulator::
1370: * ColdFire System emulator::
1.1.1.11! root 1371: * Cris System emulator::
! 1372: * Microblaze System emulator::
! 1373: * SH4 System emulator::
1.1.1.3 root 1374: @end menu
1375:
1.1.1.11! root 1376: @node PowerPC System emulator
! 1377: @section PowerPC System emulator
! 1378: @cindex system emulation (PowerPC)
1.1 root 1379:
1380: Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1381: or PowerMac PowerPC system.
1382:
1383: QEMU emulates the following PowerMac peripherals:
1384:
1385: @itemize @minus
1.1.1.6 root 1386: @item
1.1.1.7 root 1387: UniNorth or Grackle PCI Bridge
1.1 root 1388: @item
1389: PCI VGA compatible card with VESA Bochs Extensions
1.1.1.6 root 1390: @item
1.1 root 1391: 2 PMAC IDE interfaces with hard disk and CD-ROM support
1.1.1.6 root 1392: @item
1.1 root 1393: NE2000 PCI adapters
1394: @item
1395: Non Volatile RAM
1396: @item
1397: VIA-CUDA with ADB keyboard and mouse.
1398: @end itemize
1399:
1400: QEMU emulates the following PREP peripherals:
1401:
1402: @itemize @minus
1.1.1.6 root 1403: @item
1.1 root 1404: PCI Bridge
1405: @item
1406: PCI VGA compatible card with VESA Bochs Extensions
1.1.1.6 root 1407: @item
1.1 root 1408: 2 IDE interfaces with hard disk and CD-ROM support
1409: @item
1410: Floppy disk
1.1.1.6 root 1411: @item
1.1 root 1412: NE2000 network adapters
1413: @item
1414: Serial port
1415: @item
1416: PREP Non Volatile RAM
1417: @item
1418: PC compatible keyboard and mouse.
1419: @end itemize
1420:
1421: QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1.1.1.2 root 1422: @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1.1 root 1423:
1.1.1.7 root 1424: Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
1425: for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
1426: v2) portable firmware implementation. The goal is to implement a 100%
1427: IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
1428:
1.1 root 1429: @c man begin OPTIONS
1430:
1431: The following options are specific to the PowerPC emulation:
1432:
1433: @table @option
1434:
1.1.1.10 root 1435: @item -g @var{W}x@var{H}[x@var{DEPTH}]
1.1 root 1436:
1437: Set the initial VGA graphic mode. The default is 800x600x15.
1438:
1.1.1.10 root 1439: @item -prom-env @var{string}
1.1.1.7 root 1440:
1441: Set OpenBIOS variables in NVRAM, for example:
1442:
1443: @example
1444: qemu-system-ppc -prom-env 'auto-boot?=false' \
1445: -prom-env 'boot-device=hd:2,\yaboot' \
1446: -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
1447: @end example
1448:
1449: These variables are not used by Open Hack'Ware.
1450:
1.1 root 1451: @end table
1452:
1.1.1.6 root 1453: @c man end
1.1 root 1454:
1455:
1456: More information is available at
1.1.1.2 root 1457: @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1.1 root 1458:
1.1.1.6 root 1459: @node Sparc32 System emulator
1460: @section Sparc32 System emulator
1.1.1.11! root 1461: @cindex system emulation (Sparc32)
1.1 root 1462:
1.1.1.7 root 1463: Use the executable @file{qemu-system-sparc} to simulate the following
1464: Sun4m architecture machines:
1465: @itemize @minus
1466: @item
1467: SPARCstation 4
1468: @item
1469: SPARCstation 5
1470: @item
1471: SPARCstation 10
1472: @item
1473: SPARCstation 20
1474: @item
1475: SPARCserver 600MP
1476: @item
1477: SPARCstation LX
1478: @item
1479: SPARCstation Voyager
1480: @item
1481: SPARCclassic
1482: @item
1483: SPARCbook
1484: @end itemize
1485:
1486: The emulation is somewhat complete. SMP up to 16 CPUs is supported,
1487: but Linux limits the number of usable CPUs to 4.
1.1 root 1488:
1.1.1.7 root 1489: It's also possible to simulate a SPARCstation 2 (sun4c architecture),
1490: SPARCserver 1000, or SPARCcenter 2000 (sun4d architecture), but these
1491: emulators are not usable yet.
1492:
1493: QEMU emulates the following sun4m/sun4c/sun4d peripherals:
1.1 root 1494:
1495: @itemize @minus
1496: @item
1.1.1.6 root 1497: IOMMU or IO-UNITs
1.1 root 1498: @item
1499: TCX Frame buffer
1.1.1.6 root 1500: @item
1.1 root 1501: Lance (Am7990) Ethernet
1502: @item
1.1.1.7 root 1503: Non Volatile RAM M48T02/M48T08
1.1 root 1504: @item
1505: Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1506: and power/reset logic
1507: @item
1508: ESP SCSI controller with hard disk and CD-ROM support
1509: @item
1.1.1.6 root 1510: Floppy drive (not on SS-600MP)
1511: @item
1512: CS4231 sound device (only on SS-5, not working yet)
1.1 root 1513: @end itemize
1514:
1.1.1.6 root 1515: The number of peripherals is fixed in the architecture. Maximum
1516: memory size depends on the machine type, for SS-5 it is 256MB and for
1517: others 2047MB.
1.1 root 1518:
1.1.1.4 root 1519: Since version 0.8.2, QEMU uses OpenBIOS
1520: @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1521: firmware implementation. The goal is to implement a 100% IEEE
1522: 1275-1994 (referred to as Open Firmware) compliant firmware.
1.1 root 1523:
1524: A sample Linux 2.6 series kernel and ram disk image are available on
1.1.1.7 root 1525: the QEMU web site. There are still issues with NetBSD and OpenBSD, but
1526: some kernel versions work. Please note that currently Solaris kernels
1527: don't work probably due to interface issues between OpenBIOS and
1528: Solaris.
1.1 root 1529:
1530: @c man begin OPTIONS
1531:
1.1.1.6 root 1532: The following options are specific to the Sparc32 emulation:
1.1 root 1533:
1534: @table @option
1535:
1.1.1.10 root 1536: @item -g @var{W}x@var{H}x[x@var{DEPTH}]
1.1.1.6 root 1537:
1538: Set the initial TCX graphic mode. The default is 1024x768x8, currently
1539: the only other possible mode is 1024x768x24.
1540:
1.1.1.10 root 1541: @item -prom-env @var{string}
1.1 root 1542:
1.1.1.6 root 1543: Set OpenBIOS variables in NVRAM, for example:
1544:
1545: @example
1546: qemu-system-sparc -prom-env 'auto-boot?=false' \
1547: -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
1548: @end example
1549:
1.1.1.11! root 1550: @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook|SS-2|SS-1000|SS-2000]
1.1.1.6 root 1551:
1552: Set the emulated machine type. Default is SS-5.
1.1 root 1553:
1554: @end table
1555:
1.1.1.6 root 1556: @c man end
1.1 root 1557:
1.1.1.6 root 1558: @node Sparc64 System emulator
1559: @section Sparc64 System emulator
1.1.1.11! root 1560: @cindex system emulation (Sparc64)
1.1 root 1561:
1.1.1.7 root 1562: Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
1563: (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
1564: Niagara (T1) machine. The emulator is not usable for anything yet, but
1565: it can launch some kernels.
1.1 root 1566:
1.1.1.7 root 1567: QEMU emulates the following peripherals:
1.1 root 1568:
1569: @itemize @minus
1570: @item
1.1.1.6 root 1571: UltraSparc IIi APB PCI Bridge
1.1 root 1572: @item
1573: PCI VGA compatible card with VESA Bochs Extensions
1574: @item
1.1.1.7 root 1575: PS/2 mouse and keyboard
1576: @item
1.1 root 1577: Non Volatile RAM M48T59
1578: @item
1579: PC-compatible serial ports
1.1.1.7 root 1580: @item
1581: 2 PCI IDE interfaces with hard disk and CD-ROM support
1582: @item
1583: Floppy disk
1.1 root 1584: @end itemize
1585:
1.1.1.7 root 1586: @c man begin OPTIONS
1587:
1588: The following options are specific to the Sparc64 emulation:
1589:
1590: @table @option
1591:
1.1.1.10 root 1592: @item -prom-env @var{string}
1.1.1.7 root 1593:
1594: Set OpenBIOS variables in NVRAM, for example:
1595:
1596: @example
1597: qemu-system-sparc64 -prom-env 'auto-boot?=false'
1598: @end example
1599:
1600: @item -M [sun4u|sun4v|Niagara]
1601:
1602: Set the emulated machine type. The default is sun4u.
1603:
1604: @end table
1605:
1606: @c man end
1607:
1.1.1.6 root 1608: @node MIPS System emulator
1609: @section MIPS System emulator
1.1.1.11! root 1610: @cindex system emulation (MIPS)
1.1.1.6 root 1611:
1612: Four executables cover simulation of 32 and 64-bit MIPS systems in
1613: both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
1614: @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
1.1.1.7 root 1615: Five different machine types are emulated:
1.1.1.6 root 1616:
1617: @itemize @minus
1618: @item
1619: A generic ISA PC-like machine "mips"
1620: @item
1621: The MIPS Malta prototype board "malta"
1622: @item
1623: An ACER Pica "pica61". This machine needs the 64-bit emulator.
1624: @item
1625: MIPS emulator pseudo board "mipssim"
1.1.1.7 root 1626: @item
1627: A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
1.1.1.6 root 1628: @end itemize
1.1 root 1629:
1.1.1.6 root 1630: The generic emulation is supported by Debian 'Etch' and is able to
1631: install Debian into a virtual disk image. The following devices are
1632: emulated:
1.1.1.2 root 1633:
1634: @itemize @minus
1.1.1.6 root 1635: @item
1636: A range of MIPS CPUs, default is the 24Kf
1.1.1.2 root 1637: @item
1638: PC style serial port
1639: @item
1.1.1.6 root 1640: PC style IDE disk
1641: @item
1.1.1.2 root 1642: NE2000 network card
1643: @end itemize
1644:
1.1.1.6 root 1645: The Malta emulation supports the following devices:
1646:
1647: @itemize @minus
1648: @item
1649: Core board with MIPS 24Kf CPU and Galileo system controller
1650: @item
1651: PIIX4 PCI/USB/SMbus controller
1652: @item
1653: The Multi-I/O chip's serial device
1654: @item
1.1.1.9 root 1655: PCI network cards (PCnet32 and others)
1.1.1.6 root 1656: @item
1657: Malta FPGA serial device
1658: @item
1.1.1.7 root 1659: Cirrus (default) or any other PCI VGA graphics card
1.1.1.6 root 1660: @end itemize
1661:
1662: The ACER Pica emulation supports:
1663:
1664: @itemize @minus
1665: @item
1666: MIPS R4000 CPU
1667: @item
1668: PC-style IRQ and DMA controllers
1669: @item
1670: PC Keyboard
1671: @item
1672: IDE controller
1673: @end itemize
1.1.1.2 root 1674:
1.1.1.6 root 1675: The mipssim pseudo board emulation provides an environment similiar
1676: to what the proprietary MIPS emulator uses for running Linux.
1677: It supports:
1678:
1679: @itemize @minus
1680: @item
1681: A range of MIPS CPUs, default is the 24Kf
1682: @item
1683: PC style serial port
1684: @item
1685: MIPSnet network emulation
1686: @end itemize
1687:
1.1.1.7 root 1688: The MIPS Magnum R4000 emulation supports:
1689:
1690: @itemize @minus
1691: @item
1692: MIPS R4000 CPU
1693: @item
1694: PC-style IRQ controller
1695: @item
1696: PC Keyboard
1697: @item
1698: SCSI controller
1699: @item
1700: G364 framebuffer
1701: @end itemize
1702:
1703:
1.1.1.6 root 1704: @node ARM System emulator
1705: @section ARM System emulator
1.1.1.11! root 1706: @cindex system emulation (ARM)
1.1.1.2 root 1707:
1708: Use the executable @file{qemu-system-arm} to simulate a ARM
1709: machine. The ARM Integrator/CP board is emulated with the following
1710: devices:
1711:
1712: @itemize @minus
1713: @item
1.1.1.6 root 1714: ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
1.1.1.2 root 1715: @item
1716: Two PL011 UARTs
1.1.1.6 root 1717: @item
1.1.1.2 root 1718: SMC 91c111 Ethernet adapter
1.1.1.4 root 1719: @item
1720: PL110 LCD controller
1721: @item
1722: PL050 KMI with PS/2 keyboard and mouse.
1.1.1.6 root 1723: @item
1724: PL181 MultiMedia Card Interface with SD card.
1.1.1.4 root 1725: @end itemize
1726:
1727: The ARM Versatile baseboard is emulated with the following devices:
1728:
1729: @itemize @minus
1730: @item
1.1.1.6 root 1731: ARM926E, ARM1136 or Cortex-A8 CPU
1.1.1.4 root 1732: @item
1733: PL190 Vectored Interrupt Controller
1734: @item
1735: Four PL011 UARTs
1.1.1.6 root 1736: @item
1.1.1.4 root 1737: SMC 91c111 Ethernet adapter
1738: @item
1739: PL110 LCD controller
1740: @item
1741: PL050 KMI with PS/2 keyboard and mouse.
1742: @item
1743: PCI host bridge. Note the emulated PCI bridge only provides access to
1744: PCI memory space. It does not provide access to PCI IO space.
1.1.1.6 root 1745: This means some devices (eg. ne2k_pci NIC) are not usable, and others
1746: (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
1.1.1.4 root 1747: mapped control registers.
1748: @item
1749: PCI OHCI USB controller.
1750: @item
1751: LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1.1.1.6 root 1752: @item
1753: PL181 MultiMedia Card Interface with SD card.
1754: @end itemize
1755:
1.1.1.11! root 1756: Several variants of the ARM RealView baseboard are emulated,
! 1757: including the EB, PB-A8 and PBX-A9. Due to interactions with the
! 1758: bootloader, only certain Linux kernel configurations work out
! 1759: of the box on these boards.
! 1760:
! 1761: Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
! 1762: enabled in the kernel, and expect 512M RAM. Kernels for The PBX-A9 board
! 1763: should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
! 1764: disabled and expect 1024M RAM.
! 1765:
! 1766: The following devices are emuilated:
1.1.1.6 root 1767:
1768: @itemize @minus
1769: @item
1.1.1.10 root 1770: ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
1.1.1.6 root 1771: @item
1772: ARM AMBA Generic/Distributed Interrupt Controller
1773: @item
1774: Four PL011 UARTs
1775: @item
1.1.1.10 root 1776: SMC 91c111 or SMSC LAN9118 Ethernet adapter
1.1.1.6 root 1777: @item
1778: PL110 LCD controller
1779: @item
1780: PL050 KMI with PS/2 keyboard and mouse
1781: @item
1782: PCI host bridge
1783: @item
1784: PCI OHCI USB controller
1785: @item
1786: LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
1787: @item
1788: PL181 MultiMedia Card Interface with SD card.
1789: @end itemize
1790:
1791: The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
1792: and "Terrier") emulation includes the following peripherals:
1793:
1794: @itemize @minus
1795: @item
1796: Intel PXA270 System-on-chip (ARM V5TE core)
1797: @item
1798: NAND Flash memory
1799: @item
1800: IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
1801: @item
1802: On-chip OHCI USB controller
1803: @item
1804: On-chip LCD controller
1805: @item
1806: On-chip Real Time Clock
1807: @item
1808: TI ADS7846 touchscreen controller on SSP bus
1809: @item
1810: Maxim MAX1111 analog-digital converter on I@math{^2}C bus
1811: @item
1812: GPIO-connected keyboard controller and LEDs
1813: @item
1814: Secure Digital card connected to PXA MMC/SD host
1815: @item
1816: Three on-chip UARTs
1817: @item
1818: WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
1819: @end itemize
1820:
1821: The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
1822: following elements:
1823:
1824: @itemize @minus
1825: @item
1826: Texas Instruments OMAP310 System-on-chip (ARM 925T core)
1827: @item
1828: ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
1829: @item
1830: On-chip LCD controller
1831: @item
1832: On-chip Real Time Clock
1833: @item
1834: TI TSC2102i touchscreen controller / analog-digital converter / Audio
1835: CODEC, connected through MicroWire and I@math{^2}S busses
1836: @item
1837: GPIO-connected matrix keypad
1838: @item
1839: Secure Digital card connected to OMAP MMC/SD host
1840: @item
1841: Three on-chip UARTs
1842: @end itemize
1843:
1.1.1.7 root 1844: Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
1845: emulation supports the following elements:
1846:
1847: @itemize @minus
1848: @item
1849: Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
1850: @item
1851: RAM and non-volatile OneNAND Flash memories
1852: @item
1853: Display connected to EPSON remote framebuffer chip and OMAP on-chip
1854: display controller and a LS041y3 MIPI DBI-C controller
1855: @item
1856: TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
1857: driven through SPI bus
1858: @item
1859: National Semiconductor LM8323-controlled qwerty keyboard driven
1860: through I@math{^2}C bus
1861: @item
1862: Secure Digital card connected to OMAP MMC/SD host
1863: @item
1864: Three OMAP on-chip UARTs and on-chip STI debugging console
1865: @item
1866: A Bluetooth(R) transciever and HCI connected to an UART
1867: @item
1868: Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
1869: TUSB6010 chip - only USB host mode is supported
1870: @item
1871: TI TMP105 temperature sensor driven through I@math{^2}C bus
1872: @item
1873: TI TWL92230C power management companion with an RTC on I@math{^2}C bus
1874: @item
1875: Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
1876: through CBUS
1877: @end itemize
1878:
1.1.1.6 root 1879: The Luminary Micro Stellaris LM3S811EVB emulation includes the following
1880: devices:
1881:
1882: @itemize @minus
1883: @item
1884: Cortex-M3 CPU core.
1885: @item
1886: 64k Flash and 8k SRAM.
1887: @item
1888: Timers, UARTs, ADC and I@math{^2}C interface.
1889: @item
1890: OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
1891: @end itemize
1892:
1893: The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
1894: devices:
1895:
1896: @itemize @minus
1897: @item
1898: Cortex-M3 CPU core.
1899: @item
1900: 256k Flash and 64k SRAM.
1901: @item
1902: Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
1903: @item
1904: OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
1.1.1.2 root 1905: @end itemize
1906:
1.1.1.7 root 1907: The Freecom MusicPal internet radio emulation includes the following
1908: elements:
1909:
1910: @itemize @minus
1911: @item
1912: Marvell MV88W8618 ARM core.
1913: @item
1914: 32 MB RAM, 256 KB SRAM, 8 MB flash.
1915: @item
1916: Up to 2 16550 UARTs
1917: @item
1918: MV88W8xx8 Ethernet controller
1919: @item
1920: MV88W8618 audio controller, WM8750 CODEC and mixer
1921: @item
1.1.1.11! root 1922: 128×64 display with brightness control
1.1.1.7 root 1923: @item
1924: 2 buttons, 2 navigation wheels with button function
1925: @end itemize
1926:
1927: The Siemens SX1 models v1 and v2 (default) basic emulation.
1928: The emulaton includes the following elements:
1929:
1930: @itemize @minus
1931: @item
1932: Texas Instruments OMAP310 System-on-chip (ARM 925T core)
1933: @item
1934: ROM and RAM memories (ROM firmware image can be loaded with -pflash)
1935: V1
1936: 1 Flash of 16MB and 1 Flash of 8MB
1937: V2
1938: 1 Flash of 32MB
1939: @item
1940: On-chip LCD controller
1941: @item
1942: On-chip Real Time Clock
1943: @item
1944: Secure Digital card connected to OMAP MMC/SD host
1945: @item
1946: Three on-chip UARTs
1947: @end itemize
1948:
1.1.1.9 root 1949: The "Syborg" Symbian Virtual Platform base model includes the following
1950: elements:
1951:
1952: @itemize @minus
1953: @item
1954: ARM Cortex-A8 CPU
1955: @item
1956: Interrupt controller
1957: @item
1958: Timer
1959: @item
1960: Real Time Clock
1961: @item
1962: Keyboard
1963: @item
1964: Framebuffer
1965: @item
1966: Touchscreen
1967: @item
1968: UARTs
1969: @end itemize
1970:
1.1.1.2 root 1971: A Linux 2.6 test image is available on the QEMU web site. More
1972: information is available in the QEMU mailing-list archive.
1.1 root 1973:
1.1.1.7 root 1974: @c man begin OPTIONS
1975:
1976: The following options are specific to the ARM emulation:
1977:
1978: @table @option
1979:
1980: @item -semihosting
1981: Enable semihosting syscall emulation.
1982:
1983: On ARM this implements the "Angel" interface.
1984:
1985: Note that this allows guest direct access to the host filesystem,
1986: so should only be used with trusted guest OS.
1987:
1988: @end table
1989:
1.1.1.6 root 1990: @node ColdFire System emulator
1991: @section ColdFire System emulator
1.1.1.11! root 1992: @cindex system emulation (ColdFire)
! 1993: @cindex system emulation (M68K)
1.1.1.6 root 1994:
1995: Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
1996: The emulator is able to boot a uClinux kernel.
1997:
1998: The M5208EVB emulation includes the following devices:
1999:
2000: @itemize @minus
2001: @item
2002: MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2003: @item
2004: Three Two on-chip UARTs.
2005: @item
2006: Fast Ethernet Controller (FEC)
2007: @end itemize
2008:
2009: The AN5206 emulation includes the following devices:
2010:
2011: @itemize @minus
2012: @item
2013: MCF5206 ColdFire V2 Microprocessor.
2014: @item
2015: Two on-chip UARTs.
2016: @end itemize
2017:
1.1.1.7 root 2018: @c man begin OPTIONS
2019:
1.1.1.11! root 2020: The following options are specific to the ColdFire emulation:
1.1.1.7 root 2021:
2022: @table @option
2023:
2024: @item -semihosting
2025: Enable semihosting syscall emulation.
2026:
2027: On M68K this implements the "ColdFire GDB" interface used by libgloss.
2028:
2029: Note that this allows guest direct access to the host filesystem,
2030: so should only be used with trusted guest OS.
2031:
2032: @end table
2033:
1.1.1.11! root 2034: @node Cris System emulator
! 2035: @section Cris System emulator
! 2036: @cindex system emulation (Cris)
! 2037:
! 2038: TODO
! 2039:
! 2040: @node Microblaze System emulator
! 2041: @section Microblaze System emulator
! 2042: @cindex system emulation (Microblaze)
! 2043:
! 2044: TODO
! 2045:
! 2046: @node SH4 System emulator
! 2047: @section SH4 System emulator
! 2048: @cindex system emulation (SH4)
! 2049:
! 2050: TODO
! 2051:
1.1.1.6 root 2052: @node QEMU User space emulator
2053: @chapter QEMU User space emulator
1.1.1.5 root 2054:
2055: @menu
2056: * Supported Operating Systems ::
2057: * Linux User space emulator::
2058: * Mac OS X/Darwin User space emulator ::
1.1.1.7 root 2059: * BSD User space emulator ::
1.1.1.5 root 2060: @end menu
2061:
2062: @node Supported Operating Systems
2063: @section Supported Operating Systems
2064:
2065: The following OS are supported in user space emulation:
2066:
2067: @itemize @minus
2068: @item
1.1.1.6 root 2069: Linux (referred as qemu-linux-user)
1.1.1.5 root 2070: @item
1.1.1.6 root 2071: Mac OS X/Darwin (referred as qemu-darwin-user)
1.1.1.7 root 2072: @item
2073: BSD (referred as qemu-bsd-user)
1.1.1.5 root 2074: @end itemize
2075:
2076: @node Linux User space emulator
2077: @section Linux User space emulator
1.1 root 2078:
1.1.1.3 root 2079: @menu
2080: * Quick Start::
2081: * Wine launch::
2082: * Command line options::
1.1.1.4 root 2083: * Other binaries::
1.1.1.3 root 2084: @end menu
2085:
2086: @node Quick Start
1.1.1.5 root 2087: @subsection Quick Start
1.1 root 2088:
2089: In order to launch a Linux process, QEMU needs the process executable
1.1.1.6 root 2090: itself and all the target (x86) dynamic libraries used by it.
1.1 root 2091:
2092: @itemize
2093:
2094: @item On x86, you can just try to launch any process by using the native
2095: libraries:
2096:
1.1.1.6 root 2097: @example
1.1 root 2098: qemu-i386 -L / /bin/ls
2099: @end example
2100:
2101: @code{-L /} tells that the x86 dynamic linker must be searched with a
2102: @file{/} prefix.
2103:
1.1.1.6 root 2104: @item Since QEMU is also a linux process, you can launch qemu with
2105: qemu (NOTE: you can only do that if you compiled QEMU from the sources):
1.1 root 2106:
1.1.1.6 root 2107: @example
1.1 root 2108: qemu-i386 -L / qemu-i386 -L / /bin/ls
2109: @end example
2110:
2111: @item On non x86 CPUs, you need first to download at least an x86 glibc
2112: (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2113: @code{LD_LIBRARY_PATH} is not set:
2114:
2115: @example
1.1.1.6 root 2116: unset LD_LIBRARY_PATH
1.1 root 2117: @end example
2118:
2119: Then you can launch the precompiled @file{ls} x86 executable:
2120:
2121: @example
2122: qemu-i386 tests/i386/ls
2123: @end example
2124: You can look at @file{qemu-binfmt-conf.sh} so that
2125: QEMU is automatically launched by the Linux kernel when you try to
2126: launch x86 executables. It requires the @code{binfmt_misc} module in the
2127: Linux kernel.
2128:
2129: @item The x86 version of QEMU is also included. You can try weird things such as:
2130: @example
1.1.1.3 root 2131: qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2132: /usr/local/qemu-i386/bin/ls-i386
1.1 root 2133: @end example
2134:
2135: @end itemize
2136:
1.1.1.3 root 2137: @node Wine launch
1.1.1.5 root 2138: @subsection Wine launch
1.1 root 2139:
2140: @itemize
2141:
2142: @item Ensure that you have a working QEMU with the x86 glibc
2143: distribution (see previous section). In order to verify it, you must be
2144: able to do:
2145:
2146: @example
2147: qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2148: @end example
2149:
2150: @item Download the binary x86 Wine install
1.1.1.6 root 2151: (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
1.1 root 2152:
2153: @item Configure Wine on your account. Look at the provided script
1.1.1.3 root 2154: @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
1.1 root 2155: @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2156:
2157: @item Then you can try the example @file{putty.exe}:
2158:
2159: @example
1.1.1.3 root 2160: qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2161: /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1.1 root 2162: @end example
2163:
2164: @end itemize
2165:
1.1.1.3 root 2166: @node Command line options
1.1.1.5 root 2167: @subsection Command line options
1.1 root 2168:
2169: @example
1.1.1.11! root 2170: usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
1.1 root 2171: @end example
2172:
2173: @table @option
2174: @item -h
2175: Print the help
1.1.1.6 root 2176: @item -L path
1.1 root 2177: Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2178: @item -s size
2179: Set the x86 stack size in bytes (default=524288)
1.1.1.7 root 2180: @item -cpu model
2181: Select CPU model (-cpu ? for list and additional feature selection)
1.1.1.10 root 2182: @item -B offset
2183: Offset guest address by the specified number of bytes. This is useful when
1.1.1.11! root 2184: the address region required by guest applications is reserved on the host.
! 2185: This option is currently only supported on some hosts.
! 2186: @item -R size
! 2187: Pre-allocate a guest virtual address space of the given size (in bytes).
! 2188: "G", "M", and "k" suffixes may be used when specifying the size.
1.1 root 2189: @end table
2190:
2191: Debug options:
2192:
2193: @table @option
2194: @item -d
2195: Activate log (logfile=/tmp/qemu.log)
2196: @item -p pagesize
2197: Act as if the host page size was 'pagesize' bytes
1.1.1.7 root 2198: @item -g port
2199: Wait gdb connection to port
1.1.1.9 root 2200: @item -singlestep
2201: Run the emulation in single step mode.
1.1 root 2202: @end table
2203:
1.1.1.6 root 2204: Environment variables:
2205:
2206: @table @env
2207: @item QEMU_STRACE
2208: Print system calls and arguments similar to the 'strace' program
2209: (NOTE: the actual 'strace' program will not work because the user
2210: space emulator hasn't implemented ptrace). At the moment this is
2211: incomplete. All system calls that don't have a specific argument
2212: format are printed with information for six arguments. Many
2213: flag-style arguments don't have decoders and will show up as numbers.
2214: @end table
2215:
1.1.1.4 root 2216: @node Other binaries
1.1.1.5 root 2217: @subsection Other binaries
1.1.1.4 root 2218:
1.1.1.11! root 2219: @cindex user mode (Alpha)
! 2220: @command{qemu-alpha} TODO.
! 2221:
! 2222: @cindex user mode (ARM)
! 2223: @command{qemu-armeb} TODO.
! 2224:
! 2225: @cindex user mode (ARM)
1.1.1.4 root 2226: @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2227: binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2228: configurations), and arm-uclinux bFLT format binaries.
2229:
1.1.1.11! root 2230: @cindex user mode (ColdFire)
! 2231: @cindex user mode (M68K)
1.1.1.5 root 2232: @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2233: (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2234: coldfire uClinux bFLT format binaries.
2235:
1.1.1.4 root 2236: The binary format is detected automatically.
2237:
1.1.1.11! root 2238: @cindex user mode (Cris)
! 2239: @command{qemu-cris} TODO.
! 2240:
! 2241: @cindex user mode (i386)
! 2242: @command{qemu-i386} TODO.
! 2243: @command{qemu-x86_64} TODO.
! 2244:
! 2245: @cindex user mode (Microblaze)
! 2246: @command{qemu-microblaze} TODO.
! 2247:
! 2248: @cindex user mode (MIPS)
! 2249: @command{qemu-mips} TODO.
! 2250: @command{qemu-mipsel} TODO.
! 2251:
! 2252: @cindex user mode (PowerPC)
! 2253: @command{qemu-ppc64abi32} TODO.
! 2254: @command{qemu-ppc64} TODO.
! 2255: @command{qemu-ppc} TODO.
! 2256:
! 2257: @cindex user mode (SH4)
! 2258: @command{qemu-sh4eb} TODO.
! 2259: @command{qemu-sh4} TODO.
! 2260:
! 2261: @cindex user mode (SPARC)
1.1.1.7 root 2262: @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2263:
1.1.1.6 root 2264: @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2265: (Sparc64 CPU, 32 bit ABI).
2266:
2267: @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2268: SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2269:
1.1.1.5 root 2270: @node Mac OS X/Darwin User space emulator
2271: @section Mac OS X/Darwin User space emulator
2272:
2273: @menu
2274: * Mac OS X/Darwin Status::
2275: * Mac OS X/Darwin Quick Start::
2276: * Mac OS X/Darwin Command line options::
2277: @end menu
2278:
2279: @node Mac OS X/Darwin Status
2280: @subsection Mac OS X/Darwin Status
2281:
2282: @itemize @minus
2283: @item
2284: target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2285: @item
2286: target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2287: @item
1.1.1.6 root 2288: target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
1.1.1.5 root 2289: @item
2290: target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2291: @end itemize
2292:
2293: [1] If you're host commpage can be executed by qemu.
2294:
2295: @node Mac OS X/Darwin Quick Start
2296: @subsection Quick Start
2297:
2298: In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2299: itself and all the target dynamic libraries used by it. If you don't have the FAT
2300: libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2301: CD or compile them by hand.
2302:
2303: @itemize
2304:
2305: @item On x86, you can just try to launch any process by using the native
2306: libraries:
2307:
1.1.1.6 root 2308: @example
2309: qemu-i386 /bin/ls
1.1.1.5 root 2310: @end example
2311:
2312: or to run the ppc version of the executable:
2313:
1.1.1.6 root 2314: @example
2315: qemu-ppc /bin/ls
1.1.1.5 root 2316: @end example
2317:
2318: @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2319: are installed:
2320:
1.1.1.6 root 2321: @example
2322: qemu-i386 -L /opt/x86_root/ /bin/ls
1.1.1.5 root 2323: @end example
2324:
2325: @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2326: @file{/opt/x86_root/usr/bin/dyld}.
2327:
2328: @end itemize
2329:
2330: @node Mac OS X/Darwin Command line options
2331: @subsection Command line options
2332:
2333: @example
1.1.1.6 root 2334: usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1.1.1.5 root 2335: @end example
2336:
2337: @table @option
2338: @item -h
2339: Print the help
1.1.1.6 root 2340: @item -L path
1.1.1.5 root 2341: Set the library root path (default=/)
2342: @item -s size
2343: Set the stack size in bytes (default=524288)
2344: @end table
2345:
2346: Debug options:
2347:
2348: @table @option
2349: @item -d
2350: Activate log (logfile=/tmp/qemu.log)
2351: @item -p pagesize
2352: Act as if the host page size was 'pagesize' bytes
1.1.1.9 root 2353: @item -singlestep
2354: Run the emulation in single step mode.
1.1.1.5 root 2355: @end table
2356:
1.1.1.7 root 2357: @node BSD User space emulator
2358: @section BSD User space emulator
2359:
2360: @menu
2361: * BSD Status::
2362: * BSD Quick Start::
2363: * BSD Command line options::
2364: @end menu
2365:
2366: @node BSD Status
2367: @subsection BSD Status
2368:
2369: @itemize @minus
2370: @item
2371: target Sparc64 on Sparc64: Some trivial programs work.
2372: @end itemize
2373:
2374: @node BSD Quick Start
2375: @subsection Quick Start
2376:
2377: In order to launch a BSD process, QEMU needs the process executable
2378: itself and all the target dynamic libraries used by it.
2379:
2380: @itemize
2381:
2382: @item On Sparc64, you can just try to launch any process by using the native
2383: libraries:
2384:
2385: @example
2386: qemu-sparc64 /bin/ls
2387: @end example
2388:
2389: @end itemize
2390:
2391: @node BSD Command line options
2392: @subsection Command line options
2393:
2394: @example
2395: usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
2396: @end example
2397:
2398: @table @option
2399: @item -h
2400: Print the help
2401: @item -L path
2402: Set the library root path (default=/)
2403: @item -s size
2404: Set the stack size in bytes (default=524288)
2405: @item -bsd type
2406: Set the type of the emulated BSD Operating system. Valid values are
2407: FreeBSD, NetBSD and OpenBSD (default).
2408: @end table
2409:
2410: Debug options:
2411:
2412: @table @option
2413: @item -d
2414: Activate log (logfile=/tmp/qemu.log)
2415: @item -p pagesize
2416: Act as if the host page size was 'pagesize' bytes
1.1.1.9 root 2417: @item -singlestep
2418: Run the emulation in single step mode.
1.1.1.7 root 2419: @end table
2420:
1.1 root 2421: @node compilation
2422: @chapter Compilation from the sources
2423:
1.1.1.3 root 2424: @menu
2425: * Linux/Unix::
2426: * Windows::
2427: * Cross compilation for Windows with Linux::
2428: * Mac OS X::
1.1.1.11! root 2429: * Make targets::
1.1.1.3 root 2430: @end menu
2431:
2432: @node Linux/Unix
1.1 root 2433: @section Linux/Unix
2434:
2435: @subsection Compilation
2436:
2437: First you must decompress the sources:
2438: @example
2439: cd /tmp
2440: tar zxvf qemu-x.y.z.tar.gz
2441: cd qemu-x.y.z
2442: @end example
2443:
2444: Then you configure QEMU and build it (usually no options are needed):
2445: @example
2446: ./configure
2447: make
2448: @end example
2449:
2450: Then type as root user:
2451: @example
2452: make install
2453: @end example
2454: to install QEMU in @file{/usr/local}.
2455:
1.1.1.3 root 2456: @node Windows
1.1 root 2457: @section Windows
2458:
2459: @itemize
2460: @item Install the current versions of MSYS and MinGW from
2461: @url{http://www.mingw.org/}. You can find detailed installation
2462: instructions in the download section and the FAQ.
2463:
1.1.1.6 root 2464: @item Download
1.1 root 2465: the MinGW development library of SDL 1.2.x
1.1.1.3 root 2466: (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
1.1.1.11! root 2467: @url{http://www.libsdl.org}. Unpack it in a temporary place and
! 2468: edit the @file{sdl-config} script so that it gives the
1.1 root 2469: correct SDL directory when invoked.
2470:
1.1.1.11! root 2471: @item Install the MinGW version of zlib and make sure
! 2472: @file{zlib.h} and @file{libz.dll.a} are in
! 2473: MingGW's default header and linker search paths.
! 2474:
1.1 root 2475: @item Extract the current version of QEMU.
1.1.1.6 root 2476:
1.1 root 2477: @item Start the MSYS shell (file @file{msys.bat}).
2478:
1.1.1.6 root 2479: @item Change to the QEMU directory. Launch @file{./configure} and
1.1 root 2480: @file{make}. If you have problems using SDL, verify that
2481: @file{sdl-config} can be launched from the MSYS command line.
2482:
1.1.1.6 root 2483: @item You can install QEMU in @file{Program Files/Qemu} by typing
1.1 root 2484: @file{make install}. Don't forget to copy @file{SDL.dll} in
2485: @file{Program Files/Qemu}.
2486:
2487: @end itemize
2488:
1.1.1.3 root 2489: @node Cross compilation for Windows with Linux
1.1 root 2490: @section Cross compilation for Windows with Linux
2491:
2492: @itemize
2493: @item
2494: Install the MinGW cross compilation tools available at
2495: @url{http://www.mingw.org/}.
2496:
1.1.1.11! root 2497: @item Download
! 2498: the MinGW development library of SDL 1.2.x
! 2499: (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
! 2500: @url{http://www.libsdl.org}. Unpack it in a temporary place and
! 2501: edit the @file{sdl-config} script so that it gives the
! 2502: correct SDL directory when invoked. Set up the @code{PATH} environment
! 2503: variable so that @file{sdl-config} can be launched by
1.1 root 2504: the QEMU configuration script.
2505:
1.1.1.11! root 2506: @item Install the MinGW version of zlib and make sure
! 2507: @file{zlib.h} and @file{libz.dll.a} are in
! 2508: MingGW's default header and linker search paths.
! 2509:
1.1.1.6 root 2510: @item
1.1 root 2511: Configure QEMU for Windows cross compilation:
2512: @example
1.1.1.11! root 2513: PATH=/usr/i686-pc-mingw32/sys-root/mingw/bin:$PATH ./configure --cross-prefix='i686-pc-mingw32-'
! 2514: @end example
! 2515: The example assumes @file{sdl-config} is installed under @file{/usr/i686-pc-mingw32/sys-root/mingw/bin} and
! 2516: MinGW cross compilation tools have names like @file{i686-pc-mingw32-gcc} and @file{i686-pc-mingw32-strip}.
! 2517: We set the @code{PATH} environment variable to ensure the MingW version of @file{sdl-config} is used and
! 2518: use --cross-prefix to specify the name of the cross compiler.
! 2519: You can also use --prefix to set the Win32 install path which defaults to @file{c:/Program Files/Qemu}.
! 2520:
! 2521: Under Fedora Linux, you can run:
! 2522: @example
! 2523: yum -y install mingw32-gcc mingw32-SDL mingw32-zlib
1.1 root 2524: @end example
1.1.1.11! root 2525: to get a suitable cross compilation environment.
1.1 root 2526:
1.1.1.6 root 2527: @item You can install QEMU in the installation directory by typing
1.1.1.11! root 2528: @code{make install}. Don't forget to copy @file{SDL.dll} and @file{zlib1.dll} into the
1.1.1.6 root 2529: installation directory.
1.1 root 2530:
2531: @end itemize
2532:
1.1.1.11! root 2533: Wine can be used to launch the resulting qemu.exe compiled for Win32.
1.1 root 2534:
1.1.1.3 root 2535: @node Mac OS X
1.1 root 2536: @section Mac OS X
2537:
2538: The Mac OS X patches are not fully merged in QEMU, so you should look
2539: at the QEMU mailing list archive to have all the necessary
2540: information.
2541:
1.1.1.11! root 2542: @node Make targets
! 2543: @section Make targets
! 2544:
! 2545: @table @code
! 2546:
! 2547: @item make
! 2548: @item make all
! 2549: Make everything which is typically needed.
! 2550:
! 2551: @item install
! 2552: TODO
! 2553:
! 2554: @item install-doc
! 2555: TODO
! 2556:
! 2557: @item make clean
! 2558: Remove most files which were built during make.
! 2559:
! 2560: @item make distclean
! 2561: Remove everything which was built during make.
! 2562:
! 2563: @item make dvi
! 2564: @item make html
! 2565: @item make info
! 2566: @item make pdf
! 2567: Create documentation in dvi, html, info or pdf format.
! 2568:
! 2569: @item make cscope
! 2570: TODO
! 2571:
! 2572: @item make defconfig
! 2573: (Re-)create some build configuration files.
! 2574: User made changes will be overwritten.
! 2575:
! 2576: @item tar
! 2577: @item tarbin
! 2578: TODO
! 2579:
! 2580: @end table
! 2581:
! 2582: @node License
! 2583: @appendix License
! 2584:
! 2585: QEMU is a trademark of Fabrice Bellard.
! 2586:
! 2587: QEMU is released under the GNU General Public License (TODO: add link).
! 2588: Parts of QEMU have specific licenses, see file LICENSE.
! 2589:
! 2590: TODO (refer to file LICENSE, include it, include the GPL?)
! 2591:
1.1.1.3 root 2592: @node Index
1.1.1.11! root 2593: @appendix Index
! 2594: @menu
! 2595: * Concept Index::
! 2596: * Function Index::
! 2597: * Keystroke Index::
! 2598: * Program Index::
! 2599: * Data Type Index::
! 2600: * Variable Index::
! 2601: @end menu
! 2602:
! 2603: @node Concept Index
! 2604: @section Concept Index
! 2605: This is the main index. Should we combine all keywords in one index? TODO
1.1.1.3 root 2606: @printindex cp
2607:
1.1.1.11! root 2608: @node Function Index
! 2609: @section Function Index
! 2610: This index could be used for command line options and monitor functions.
! 2611: @printindex fn
! 2612:
! 2613: @node Keystroke Index
! 2614: @section Keystroke Index
! 2615:
! 2616: This is a list of all keystrokes which have a special function
! 2617: in system emulation.
! 2618:
! 2619: @printindex ky
! 2620:
! 2621: @node Program Index
! 2622: @section Program Index
! 2623: @printindex pg
! 2624:
! 2625: @node Data Type Index
! 2626: @section Data Type Index
! 2627:
! 2628: This index could be used for qdev device names and options.
! 2629:
! 2630: @printindex tp
! 2631:
! 2632: @node Variable Index
! 2633: @section Variable Index
! 2634: @printindex vr
! 2635:
1.1.1.3 root 2636: @bye
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.