qapi2texi: Fix up output around #optional
[qemu.git] / qemu-doc.texi
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename qemu-doc.info
4
5 @documentlanguage en
6 @documentencoding UTF-8
7
8 @settitle QEMU Emulator User Documentation
9 @exampleindent 0
10 @paragraphindent 0
11 @c %**end of header
12
13 @ifinfo
14 @direntry
15 * QEMU: (qemu-doc).    The QEMU Emulator User Documentation.
16 @end direntry
17 @end ifinfo
18
19 @iftex
20 @titlepage
21 @sp 7
22 @center @titlefont{QEMU Emulator}
23 @sp 1
24 @center @titlefont{User Documentation}
25 @sp 3
26 @end titlepage
27 @end iftex
28
29 @ifnottex
30 @node Top
31 @top
32
33 @menu
34 * Introduction::
35 * QEMU PC System emulator::
36 * QEMU System emulator for non PC targets::
37 * QEMU User space emulator::
38 * Implementation notes::
39 * License::
40 * Index::
41 @end menu
42 @end ifnottex
43
44 @contents
45
46 @node Introduction
47 @chapter Introduction
48
49 @menu
50 * intro_features:: Features
51 @end menu
52
53 @node intro_features
54 @section Features
55
56 QEMU is a FAST! processor emulator using dynamic translation to
57 achieve good emulation speed.
58
59 @cindex operating modes
60 QEMU has two operating modes:
61
62 @itemize
63 @cindex system emulation
64 @item Full system emulation. In this mode, QEMU emulates a full system (for
65 example a PC), including one or several processors and various
66 peripherals. It can be used to launch different Operating Systems
67 without rebooting the PC or to debug system code.
68
69 @cindex user mode emulation
70 @item User mode emulation. In this mode, QEMU can launch
71 processes compiled for one CPU on another CPU. It can be used to
72 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
73 to ease cross-compilation and cross-debugging.
74
75 @end itemize
76
77 QEMU has the following features:
78
79 @itemize
80 @item QEMU can run without a host kernel driver and yet gives acceptable
81 performance.  It uses dynamic translation to native code for reasonable speed,
82 with support for self-modifying code and precise exceptions.
83
84 @item It is portable to several operating systems (GNU/Linux, *BSD, Mac OS X,
85 Windows) and architectures.
86
87 @item It performs accurate software emulation of the FPU.
88 @end itemize
89
90 QEMU user mode emulation has the following features:
91 @itemize
92 @item Generic Linux system call converter, including most ioctls.
93
94 @item clone() emulation using native CPU clone() to use Linux scheduler for threads.
95
96 @item Accurate signal handling by remapping host signals to target signals.
97 @end itemize
98
99 QEMU full system emulation has the following features:
100 @itemize
101 @item
102 QEMU uses a full software MMU for maximum portability.
103
104 @item
105 QEMU can optionally use an in-kernel accelerator, like kvm. The accelerators 
106 execute most of the guest code natively, while
107 continuing to emulate the rest of the machine.
108
109 @item
110 Various hardware devices can be emulated and in some cases, host
111 devices (e.g. serial and parallel ports, USB, drives) can be used
112 transparently by the guest Operating System. Host device passthrough
113 can be used for talking to external physical peripherals (e.g. a
114 webcam, modem or tape drive).
115
116 @item
117 Symmetric multiprocessing (SMP) support.  Currently, an in-kernel
118 accelerator is required to use more than one host CPU for emulation.
119
120 @end itemize
121
122
123 @node QEMU PC System emulator
124 @chapter QEMU PC System emulator
125 @cindex system emulation (PC)
126
127 @menu
128 * pcsys_introduction:: Introduction
129 * pcsys_quickstart::   Quick Start
130 * sec_invocation::     Invocation
131 * pcsys_keys::         Keys in the graphical frontends
132 * mux_keys::           Keys in the character backend multiplexer
133 * pcsys_monitor::      QEMU Monitor
134 * disk_images::        Disk Images
135 * pcsys_network::      Network emulation
136 * pcsys_other_devs::   Other Devices
137 * direct_linux_boot::  Direct Linux Boot
138 * pcsys_usb::          USB emulation
139 * vnc_security::       VNC security
140 * gdb_usage::          GDB usage
141 * pcsys_os_specific::  Target OS specific information
142 @end menu
143
144 @node pcsys_introduction
145 @section Introduction
146
147 @c man begin DESCRIPTION
148
149 The QEMU PC System emulator simulates the
150 following peripherals:
151
152 @itemize @minus
153 @item
154 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
155 @item
156 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
157 extensions (hardware level, including all non standard modes).
158 @item
159 PS/2 mouse and keyboard
160 @item
161 2 PCI IDE interfaces with hard disk and CD-ROM support
162 @item
163 Floppy disk
164 @item
165 PCI and ISA network adapters
166 @item
167 Serial ports
168 @item
169 IPMI BMC, either and internal or external one
170 @item
171 Creative SoundBlaster 16 sound card
172 @item
173 ENSONIQ AudioPCI ES1370 sound card
174 @item
175 Intel 82801AA AC97 Audio compatible sound card
176 @item
177 Intel HD Audio Controller and HDA codec
178 @item
179 Adlib (OPL2) - Yamaha YM3812 compatible chip
180 @item
181 Gravis Ultrasound GF1 sound card
182 @item
183 CS4231A compatible sound card
184 @item
185 PCI UHCI USB controller and a virtual USB hub.
186 @end itemize
187
188 SMP is supported with up to 255 CPUs.
189
190 QEMU uses the PC BIOS from the Seabios project and the Plex86/Bochs LGPL
191 VGA BIOS.
192
193 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
194
195 QEMU uses GUS emulation (GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
196 by Tibor "TS" Schütz.
197
198 Note that, by default, GUS shares IRQ(7) with parallel ports and so
199 QEMU must be told to not have parallel ports to have working GUS.
200
201 @example
202 qemu-system-i386 dos.img -soundhw gus -parallel none
203 @end example
204
205 Alternatively:
206 @example
207 qemu-system-i386 dos.img -device gus,irq=5
208 @end example
209
210 Or some other unclaimed IRQ.
211
212 CS4231A is the chip used in Windows Sound System and GUSMAX products
213
214 @c man end
215
216 @node pcsys_quickstart
217 @section Quick Start
218 @cindex quick start
219
220 Download and uncompress the linux image (@file{linux.img}) and type:
221
222 @example
223 qemu-system-i386 linux.img
224 @end example
225
226 Linux should boot and give you a prompt.
227
228 @node sec_invocation
229 @section Invocation
230
231 @example
232 @c man begin SYNOPSIS
233 @command{qemu-system-i386} [@var{options}] [@var{disk_image}]
234 @c man end
235 @end example
236
237 @c man begin OPTIONS
238 @var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
239 targets do not need a disk image.
240
241 @include qemu-options.texi
242
243 @c man end
244
245 @node pcsys_keys
246 @section Keys in the graphical frontends
247
248 @c man begin OPTIONS
249
250 During the graphical emulation, you can use special key combinations to change
251 modes. The default key mappings are shown below, but if you use @code{-alt-grab}
252 then the modifier is Ctrl-Alt-Shift (instead of Ctrl-Alt) and if you use
253 @code{-ctrl-grab} then the modifier is the right Ctrl key (instead of Ctrl-Alt):
254
255 @table @key
256 @item Ctrl-Alt-f
257 @kindex Ctrl-Alt-f
258 Toggle full screen
259
260 @item Ctrl-Alt-+
261 @kindex Ctrl-Alt-+
262 Enlarge the screen
263
264 @item Ctrl-Alt--
265 @kindex Ctrl-Alt--
266 Shrink the screen
267
268 @item Ctrl-Alt-u
269 @kindex Ctrl-Alt-u
270 Restore the screen's un-scaled dimensions
271
272 @item Ctrl-Alt-n
273 @kindex Ctrl-Alt-n
274 Switch to virtual console 'n'. Standard console mappings are:
275 @table @emph
276 @item 1
277 Target system display
278 @item 2
279 Monitor
280 @item 3
281 Serial port
282 @end table
283
284 @item Ctrl-Alt
285 @kindex Ctrl-Alt
286 Toggle mouse and keyboard grab.
287 @end table
288
289 @kindex Ctrl-Up
290 @kindex Ctrl-Down
291 @kindex Ctrl-PageUp
292 @kindex Ctrl-PageDown
293 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
294 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
295
296 @c man end
297
298 @node mux_keys
299 @section Keys in the character backend multiplexer
300
301 @c man begin OPTIONS
302
303 During emulation, if you are using a character backend multiplexer
304 (which is the default if you are using @option{-nographic}) then
305 several commands are available via an escape sequence. These
306 key sequences all start with an escape character, which is @key{Ctrl-a}
307 by default, but can be changed with @option{-echr}. The list below assumes
308 you're using the default.
309
310 @table @key
311 @item Ctrl-a h
312 @kindex Ctrl-a h
313 Print this help
314 @item Ctrl-a x
315 @kindex Ctrl-a x
316 Exit emulator
317 @item Ctrl-a s
318 @kindex Ctrl-a s
319 Save disk data back to file (if -snapshot)
320 @item Ctrl-a t
321 @kindex Ctrl-a t
322 Toggle console timestamps
323 @item Ctrl-a b
324 @kindex Ctrl-a b
325 Send break (magic sysrq in Linux)
326 @item Ctrl-a c
327 @kindex Ctrl-a c
328 Rotate between the frontends connected to the multiplexer (usually
329 this switches between the monitor and the console)
330 @item Ctrl-a Ctrl-a
331 @kindex Ctrl-a Ctrl-a
332 Send the escape character to the frontend
333 @end table
334 @c man end
335
336 @ignore
337
338 @c man begin SEEALSO
339 The HTML documentation of QEMU for more precise information and Linux
340 user mode emulator invocation.
341 @c man end
342
343 @c man begin AUTHOR
344 Fabrice Bellard
345 @c man end
346
347 @end ignore
348
349 @node pcsys_monitor
350 @section QEMU Monitor
351 @cindex QEMU monitor
352
353 The QEMU monitor is used to give complex commands to the QEMU
354 emulator. You can use it to:
355
356 @itemize @minus
357
358 @item
359 Remove or insert removable media images
360 (such as CD-ROM or floppies).
361
362 @item
363 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
364 from a disk file.
365
366 @item Inspect the VM state without an external debugger.
367
368 @end itemize
369
370 @subsection Commands
371
372 The following commands are available:
373
374 @include qemu-monitor.texi
375
376 @include qemu-monitor-info.texi
377
378 @subsection Integer expressions
379
380 The monitor understands integers expressions for every integer
381 argument. You can use register names to get the value of specifics
382 CPU registers by prefixing them with @emph{$}.
383
384 @node disk_images
385 @section Disk Images
386
387 Since version 0.6.1, QEMU supports many disk image formats, including
388 growable disk images (their size increase as non empty sectors are
389 written), compressed and encrypted disk images. Version 0.8.3 added
390 the new qcow2 disk image format which is essential to support VM
391 snapshots.
392
393 @menu
394 * disk_images_quickstart::    Quick start for disk image creation
395 * disk_images_snapshot_mode:: Snapshot mode
396 * vm_snapshots::              VM snapshots
397 * qemu_img_invocation::       qemu-img Invocation
398 * qemu_nbd_invocation::       qemu-nbd Invocation
399 * qemu_ga_invocation::        qemu-ga Invocation
400 * disk_images_formats::       Disk image file formats
401 * host_drives::               Using host drives
402 * disk_images_fat_images::    Virtual FAT disk images
403 * disk_images_nbd::           NBD access
404 * disk_images_sheepdog::      Sheepdog disk images
405 * disk_images_iscsi::         iSCSI LUNs
406 * disk_images_gluster::       GlusterFS disk images
407 * disk_images_ssh::           Secure Shell (ssh) disk images
408 @end menu
409
410 @node disk_images_quickstart
411 @subsection Quick start for disk image creation
412
413 You can create a disk image with the command:
414 @example
415 qemu-img create myimage.img mysize
416 @end example
417 where @var{myimage.img} is the disk image filename and @var{mysize} is its
418 size in kilobytes. You can add an @code{M} suffix to give the size in
419 megabytes and a @code{G} suffix for gigabytes.
420
421 See @ref{qemu_img_invocation} for more information.
422
423 @node disk_images_snapshot_mode
424 @subsection Snapshot mode
425
426 If you use the option @option{-snapshot}, all disk images are
427 considered as read only. When sectors in written, they are written in
428 a temporary file created in @file{/tmp}. You can however force the
429 write back to the raw disk images by using the @code{commit} monitor
430 command (or @key{C-a s} in the serial console).
431
432 @node vm_snapshots
433 @subsection VM snapshots
434
435 VM snapshots are snapshots of the complete virtual machine including
436 CPU state, RAM, device state and the content of all the writable
437 disks. In order to use VM snapshots, you must have at least one non
438 removable and writable block device using the @code{qcow2} disk image
439 format. Normally this device is the first virtual hard drive.
440
441 Use the monitor command @code{savevm} to create a new VM snapshot or
442 replace an existing one. A human readable name can be assigned to each
443 snapshot in addition to its numerical ID.
444
445 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
446 a VM snapshot. @code{info snapshots} lists the available snapshots
447 with their associated information:
448
449 @example
450 (qemu) info snapshots
451 Snapshot devices: hda
452 Snapshot list (from hda):
453 ID        TAG                 VM SIZE                DATE       VM CLOCK
454 1         start                   41M 2006-08-06 12:38:02   00:00:14.954
455 2                                 40M 2006-08-06 12:43:29   00:00:18.633
456 3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
457 @end example
458
459 A VM snapshot is made of a VM state info (its size is shown in
460 @code{info snapshots}) and a snapshot of every writable disk image.
461 The VM state info is stored in the first @code{qcow2} non removable
462 and writable block device. The disk image snapshots are stored in
463 every disk image. The size of a snapshot in a disk image is difficult
464 to evaluate and is not shown by @code{info snapshots} because the
465 associated disk sectors are shared among all the snapshots to save
466 disk space (otherwise each snapshot would need a full copy of all the
467 disk images).
468
469 When using the (unrelated) @code{-snapshot} option
470 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
471 but they are deleted as soon as you exit QEMU.
472
473 VM snapshots currently have the following known limitations:
474 @itemize
475 @item
476 They cannot cope with removable devices if they are removed or
477 inserted after a snapshot is done.
478 @item
479 A few device drivers still have incomplete snapshot support so their
480 state is not saved or restored properly (in particular USB).
481 @end itemize
482
483 @node qemu_img_invocation
484 @subsection @code{qemu-img} Invocation
485
486 @include qemu-img.texi
487
488 @node qemu_nbd_invocation
489 @subsection @code{qemu-nbd} Invocation
490
491 @include qemu-nbd.texi
492
493 @node qemu_ga_invocation
494 @subsection @code{qemu-ga} Invocation
495
496 @include qemu-ga.texi
497
498 @node disk_images_formats
499 @subsection Disk image file formats
500
501 QEMU supports many image file formats that can be used with VMs as well as with
502 any of the tools (like @code{qemu-img}). This includes the preferred formats
503 raw and qcow2 as well as formats that are supported for compatibility with
504 older QEMU versions or other hypervisors.
505
506 Depending on the image format, different options can be passed to
507 @code{qemu-img create} and @code{qemu-img convert} using the @code{-o} option.
508 This section describes each format and the options that are supported for it.
509
510 @table @option
511 @item raw
512
513 Raw disk image format. This format has the advantage of
514 being simple and easily exportable to all other emulators. If your
515 file system supports @emph{holes} (for example in ext2 or ext3 on
516 Linux or NTFS on Windows), then only the written sectors will reserve
517 space. Use @code{qemu-img info} to know the real size used by the
518 image or @code{ls -ls} on Unix/Linux.
519
520 Supported options:
521 @table @code
522 @item preallocation
523 Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
524 @code{falloc} mode preallocates space for image by calling posix_fallocate().
525 @code{full} mode preallocates space for image by writing zeros to underlying
526 storage.
527 @end table
528
529 @item qcow2
530 QEMU image format, the most versatile format. Use it to have smaller
531 images (useful if your filesystem does not supports holes, for example
532 on Windows), zlib based compression and support of multiple VM
533 snapshots.
534
535 Supported options:
536 @table @code
537 @item compat
538 Determines the qcow2 version to use. @code{compat=0.10} uses the
539 traditional image format that can be read by any QEMU since 0.10.
540 @code{compat=1.1} enables image format extensions that only QEMU 1.1 and
541 newer understand (this is the default). Amongst others, this includes
542 zero clusters, which allow efficient copy-on-read for sparse images.
543
544 @item backing_file
545 File name of a base image (see @option{create} subcommand)
546 @item backing_fmt
547 Image format of the base image
548 @item encryption
549 If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
550
551 The use of encryption in qcow and qcow2 images is considered to be flawed by
552 modern cryptography standards, suffering from a number of design problems:
553
554 @itemize @minus
555 @item The AES-CBC cipher is used with predictable initialization vectors based
556 on the sector number. This makes it vulnerable to chosen plaintext attacks
557 which can reveal the existence of encrypted data.
558 @item The user passphrase is directly used as the encryption key. A poorly
559 chosen or short passphrase will compromise the security of the encryption.
560 @item In the event of the passphrase being compromised there is no way to
561 change the passphrase to protect data in any qcow images. The files must
562 be cloned, using a different encryption passphrase in the new file. The
563 original file must then be securely erased using a program like shred,
564 though even this is ineffective with many modern storage technologies.
565 @end itemize
566
567 Use of qcow / qcow2 encryption with QEMU is deprecated, and support for
568 it will go away in a future release.  Users are recommended to use an
569 alternative encryption technology such as the Linux dm-crypt / LUKS
570 system.
571
572 @item cluster_size
573 Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
574 sizes can improve the image file size whereas larger cluster sizes generally
575 provide better performance.
576
577 @item preallocation
578 Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
579 @code{full}). An image with preallocated metadata is initially larger but can
580 improve performance when the image needs to grow. @code{falloc} and @code{full}
581 preallocations are like the same options of @code{raw} format, but sets up
582 metadata also.
583
584 @item lazy_refcounts
585 If this option is set to @code{on}, reference count updates are postponed with
586 the goal of avoiding metadata I/O and improving performance. This is
587 particularly interesting with @option{cache=writethrough} which doesn't batch
588 metadata updates. The tradeoff is that after a host crash, the reference count
589 tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
590 check -r all} is required, which may take some time.
591
592 This option can only be enabled if @code{compat=1.1} is specified.
593
594 @item nocow
595 If this option is set to @code{on}, it will turn off COW of the file. It's only
596 valid on btrfs, no effect on other file systems.
597
598 Btrfs has low performance when hosting a VM image file, even more when the guest
599 on the VM also using btrfs as file system. Turning off COW is a way to mitigate
600 this bad performance. Generally there are two ways to turn off COW on btrfs:
601 a) Disable it by mounting with nodatacow, then all newly created files will be
602 NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
603 does.
604
605 Note: this option is only valid to new or empty files. If there is an existing
606 file which is COW and has data blocks already, it couldn't be changed to NOCOW
607 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
608 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
609
610 @end table
611
612 @item qed
613 Old QEMU image format with support for backing files and compact image files
614 (when your filesystem or transport medium does not support holes).
615
616 When converting QED images to qcow2, you might want to consider using the
617 @code{lazy_refcounts=on} option to get a more QED-like behaviour.
618
619 Supported options:
620 @table @code
621 @item backing_file
622 File name of a base image (see @option{create} subcommand).
623 @item backing_fmt
624 Image file format of backing file (optional).  Useful if the format cannot be
625 autodetected because it has no header, like some vhd/vpc files.
626 @item cluster_size
627 Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller
628 cluster sizes can improve the image file size whereas larger cluster sizes
629 generally provide better performance.
630 @item table_size
631 Changes the number of clusters per L1/L2 table (must be power-of-2 between 1
632 and 16).  There is normally no need to change this value but this option can be
633 used for performance benchmarking.
634 @end table
635
636 @item qcow
637 Old QEMU image format with support for backing files, compact image files,
638 encryption and compression.
639
640 Supported options:
641 @table @code
642 @item backing_file
643 File name of a base image (see @option{create} subcommand)
644 @item encryption
645 If this option is set to @code{on}, the image is encrypted.
646 @end table
647
648 @item vdi
649 VirtualBox 1.1 compatible image format.
650 Supported options:
651 @table @code
652 @item static
653 If this option is set to @code{on}, the image is created with metadata
654 preallocation.
655 @end table
656
657 @item vmdk
658 VMware 3 and 4 compatible image format.
659
660 Supported options:
661 @table @code
662 @item backing_file
663 File name of a base image (see @option{create} subcommand).
664 @item compat6
665 Create a VMDK version 6 image (instead of version 4)
666 @item hwversion
667 Specify vmdk virtual hardware version. Compat6 flag cannot be enabled
668 if hwversion is specified.
669 @item subformat
670 Specifies which VMDK subformat to use. Valid options are
671 @code{monolithicSparse} (default),
672 @code{monolithicFlat},
673 @code{twoGbMaxExtentSparse},
674 @code{twoGbMaxExtentFlat} and
675 @code{streamOptimized}.
676 @end table
677
678 @item vpc
679 VirtualPC compatible image format (VHD).
680 Supported options:
681 @table @code
682 @item subformat
683 Specifies which VHD subformat to use. Valid options are
684 @code{dynamic} (default) and @code{fixed}.
685 @end table
686
687 @item VHDX
688 Hyper-V compatible image format (VHDX).
689 Supported options:
690 @table @code
691 @item subformat
692 Specifies which VHDX subformat to use. Valid options are
693 @code{dynamic} (default) and @code{fixed}.
694 @item block_state_zero
695 Force use of payload blocks of type 'ZERO'.  Can be set to @code{on} (default)
696 or @code{off}.  When set to @code{off}, new blocks will be created as
697 @code{PAYLOAD_BLOCK_NOT_PRESENT}, which means parsers are free to return
698 arbitrary data for those blocks.  Do not set to @code{off} when using
699 @code{qemu-img convert} with @code{subformat=dynamic}.
700 @item block_size
701 Block size; min 1 MB, max 256 MB.  0 means auto-calculate based on image size.
702 @item log_size
703 Log size; min 1 MB.
704 @end table
705 @end table
706
707 @subsubsection Read-only formats
708 More disk image file formats are supported in a read-only mode.
709 @table @option
710 @item bochs
711 Bochs images of @code{growing} type.
712 @item cloop
713 Linux Compressed Loop image, useful only to reuse directly compressed
714 CD-ROM images present for example in the Knoppix CD-ROMs.
715 @item dmg
716 Apple disk image.
717 @item parallels
718 Parallels disk image format.
719 @end table
720
721
722 @node host_drives
723 @subsection Using host drives
724
725 In addition to disk image files, QEMU can directly access host
726 devices. We describe here the usage for QEMU version >= 0.8.3.
727
728 @subsubsection Linux
729
730 On Linux, you can directly use the host device filename instead of a
731 disk image filename provided you have enough privileges to access
732 it. For example, use @file{/dev/cdrom} to access to the CDROM.
733
734 @table @code
735 @item CD
736 You can specify a CDROM device even if no CDROM is loaded. QEMU has
737 specific code to detect CDROM insertion or removal. CDROM ejection by
738 the guest OS is supported. Currently only data CDs are supported.
739 @item Floppy
740 You can specify a floppy device even if no floppy is loaded. Floppy
741 removal is currently not detected accurately (if you change floppy
742 without doing floppy access while the floppy is not loaded, the guest
743 OS will think that the same floppy is loaded).
744 Use of the host's floppy device is deprecated, and support for it will
745 be removed in a future release.
746 @item Hard disks
747 Hard disks can be used. Normally you must specify the whole disk
748 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
749 see it as a partitioned disk. WARNING: unless you know what you do, it
750 is better to only make READ-ONLY accesses to the hard disk otherwise
751 you may corrupt your host data (use the @option{-snapshot} command
752 line option or modify the device permissions accordingly).
753 @end table
754
755 @subsubsection Windows
756
757 @table @code
758 @item CD
759 The preferred syntax is the drive letter (e.g. @file{d:}). The
760 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
761 supported as an alias to the first CDROM drive.
762
763 Currently there is no specific code to handle removable media, so it
764 is better to use the @code{change} or @code{eject} monitor commands to
765 change or eject media.
766 @item Hard disks
767 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
768 where @var{N} is the drive number (0 is the first hard disk).
769
770 WARNING: unless you know what you do, it is better to only make
771 READ-ONLY accesses to the hard disk otherwise you may corrupt your
772 host data (use the @option{-snapshot} command line so that the
773 modifications are written in a temporary file).
774 @end table
775
776
777 @subsubsection Mac OS X
778
779 @file{/dev/cdrom} is an alias to the first CDROM.
780
781 Currently there is no specific code to handle removable media, so it
782 is better to use the @code{change} or @code{eject} monitor commands to
783 change or eject media.
784
785 @node disk_images_fat_images
786 @subsection Virtual FAT disk images
787
788 QEMU can automatically create a virtual FAT disk image from a
789 directory tree. In order to use it, just type:
790
791 @example
792 qemu-system-i386 linux.img -hdb fat:/my_directory
793 @end example
794
795 Then you access access to all the files in the @file{/my_directory}
796 directory without having to copy them in a disk image or to export
797 them via SAMBA or NFS. The default access is @emph{read-only}.
798
799 Floppies can be emulated with the @code{:floppy:} option:
800
801 @example
802 qemu-system-i386 linux.img -fda fat:floppy:/my_directory
803 @end example
804
805 A read/write support is available for testing (beta stage) with the
806 @code{:rw:} option:
807
808 @example
809 qemu-system-i386 linux.img -fda fat:floppy:rw:/my_directory
810 @end example
811
812 What you should @emph{never} do:
813 @itemize
814 @item use non-ASCII filenames ;
815 @item use "-snapshot" together with ":rw:" ;
816 @item expect it to work when loadvm'ing ;
817 @item write to the FAT directory on the host system while accessing it with the guest system.
818 @end itemize
819
820 @node disk_images_nbd
821 @subsection NBD access
822
823 QEMU can access directly to block device exported using the Network Block Device
824 protocol.
825
826 @example
827 qemu-system-i386 linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/
828 @end example
829
830 If the NBD server is located on the same host, you can use an unix socket instead
831 of an inet socket:
832
833 @example
834 qemu-system-i386 linux.img -hdb nbd+unix://?socket=/tmp/my_socket
835 @end example
836
837 In this case, the block device must be exported using qemu-nbd:
838
839 @example
840 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
841 @end example
842
843 The use of qemu-nbd allows sharing of a disk between several guests:
844 @example
845 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
846 @end example
847
848 @noindent
849 and then you can use it with two guests:
850 @example
851 qemu-system-i386 linux1.img -hdb nbd+unix://?socket=/tmp/my_socket
852 qemu-system-i386 linux2.img -hdb nbd+unix://?socket=/tmp/my_socket
853 @end example
854
855 If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's
856 own embedded NBD server), you must specify an export name in the URI:
857 @example
858 qemu-system-i386 -cdrom nbd://localhost/debian-500-ppc-netinst
859 qemu-system-i386 -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst
860 @end example
861
862 The URI syntax for NBD is supported since QEMU 1.3.  An alternative syntax is
863 also available.  Here are some example of the older syntax:
864 @example
865 qemu-system-i386 linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
866 qemu-system-i386 linux2.img -hdb nbd:unix:/tmp/my_socket
867 qemu-system-i386 -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst
868 @end example
869
870 @node disk_images_sheepdog
871 @subsection Sheepdog disk images
872
873 Sheepdog is a distributed storage system for QEMU.  It provides highly
874 available block level storage volumes that can be attached to
875 QEMU-based virtual machines.
876
877 You can create a Sheepdog disk image with the command:
878 @example
879 qemu-img create sheepdog:///@var{image} @var{size}
880 @end example
881 where @var{image} is the Sheepdog image name and @var{size} is its
882 size.
883
884 To import the existing @var{filename} to Sheepdog, you can use a
885 convert command.
886 @example
887 qemu-img convert @var{filename} sheepdog:///@var{image}
888 @end example
889
890 You can boot from the Sheepdog disk image with the command:
891 @example
892 qemu-system-i386 sheepdog:///@var{image}
893 @end example
894
895 You can also create a snapshot of the Sheepdog image like qcow2.
896 @example
897 qemu-img snapshot -c @var{tag} sheepdog:///@var{image}
898 @end example
899 where @var{tag} is a tag name of the newly created snapshot.
900
901 To boot from the Sheepdog snapshot, specify the tag name of the
902 snapshot.
903 @example
904 qemu-system-i386 sheepdog:///@var{image}#@var{tag}
905 @end example
906
907 You can create a cloned image from the existing snapshot.
908 @example
909 qemu-img create -b sheepdog:///@var{base}#@var{tag} sheepdog:///@var{image}
910 @end example
911 where @var{base} is a image name of the source snapshot and @var{tag}
912 is its tag name.
913
914 You can use an unix socket instead of an inet socket:
915
916 @example
917 qemu-system-i386 sheepdog+unix:///@var{image}?socket=@var{path}
918 @end example
919
920 If the Sheepdog daemon doesn't run on the local host, you need to
921 specify one of the Sheepdog servers to connect to.
922 @example
923 qemu-img create sheepdog://@var{hostname}:@var{port}/@var{image} @var{size}
924 qemu-system-i386 sheepdog://@var{hostname}:@var{port}/@var{image}
925 @end example
926
927 @node disk_images_iscsi
928 @subsection iSCSI LUNs
929
930 iSCSI is a popular protocol used to access SCSI devices across a computer
931 network.
932
933 There are two different ways iSCSI devices can be used by QEMU.
934
935 The first method is to mount the iSCSI LUN on the host, and make it appear as
936 any other ordinary SCSI device on the host and then to access this device as a
937 /dev/sd device from QEMU. How to do this differs between host OSes.
938
939 The second method involves using the iSCSI initiator that is built into
940 QEMU. This provides a mechanism that works the same way regardless of which
941 host OS you are running QEMU on. This section will describe this second method
942 of using iSCSI together with QEMU.
943
944 In QEMU, iSCSI devices are described using special iSCSI URLs
945
946 @example
947 URL syntax:
948 iscsi://[<username>[%<password>]@@]<host>[:<port>]/<target-iqn-name>/<lun>
949 @end example
950
951 Username and password are optional and only used if your target is set up
952 using CHAP authentication for access control.
953 Alternatively the username and password can also be set via environment
954 variables to have these not show up in the process list
955
956 @example
957 export LIBISCSI_CHAP_USERNAME=<username>
958 export LIBISCSI_CHAP_PASSWORD=<password>
959 iscsi://<host>/<target-iqn-name>/<lun>
960 @end example
961
962 Various session related parameters can be set via special options, either
963 in a configuration file provided via '-readconfig' or directly on the
964 command line.
965
966 If the initiator-name is not specified qemu will use a default name
967 of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
968 virtual machine.
969
970
971 @example
972 Setting a specific initiator name to use when logging in to the target
973 -iscsi initiator-name=iqn.qemu.test:my-initiator
974 @end example
975
976 @example
977 Controlling which type of header digest to negotiate with the target
978 -iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
979 @end example
980
981 These can also be set via a configuration file
982 @example
983 [iscsi]
984   user = "CHAP username"
985   password = "CHAP password"
986   initiator-name = "iqn.qemu.test:my-initiator"
987   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
988   header-digest = "CRC32C"
989 @end example
990
991
992 Setting the target name allows different options for different targets
993 @example
994 [iscsi "iqn.target.name"]
995   user = "CHAP username"
996   password = "CHAP password"
997   initiator-name = "iqn.qemu.test:my-initiator"
998   # header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
999   header-digest = "CRC32C"
1000 @end example
1001
1002
1003 Howto use a configuration file to set iSCSI configuration options:
1004 @example
1005 cat >iscsi.conf <<EOF
1006 [iscsi]
1007   user = "me"
1008   password = "my password"
1009   initiator-name = "iqn.qemu.test:my-initiator"
1010   header-digest = "CRC32C"
1011 EOF
1012
1013 qemu-system-i386 -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1014     -readconfig iscsi.conf
1015 @end example
1016
1017
1018 Howto set up a simple iSCSI target on loopback and accessing it via QEMU:
1019 @example
1020 This example shows how to set up an iSCSI target with one CDROM and one DISK
1021 using the Linux STGT software target. This target is available on Red Hat based
1022 systems as the package 'scsi-target-utils'.
1023
1024 tgtd --iscsi portal=127.0.0.1:3260
1025 tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
1026 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \
1027     -b /IMAGES/disk.img --device-type=disk
1028 tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \
1029     -b /IMAGES/cd.iso --device-type=cd
1030 tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
1031
1032 qemu-system-i386 -iscsi initiator-name=iqn.qemu.test:my-initiator \
1033     -boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
1034     -cdrom iscsi://127.0.0.1/iqn.qemu.test/2
1035 @end example
1036
1037 @node disk_images_gluster
1038 @subsection GlusterFS disk images
1039
1040 GlusterFS is a user space distributed file system.
1041
1042 You can boot from the GlusterFS disk image with the command:
1043 @example
1044 URI:
1045 qemu-system-x86_64 -drive file=gluster[+@var{type}]://[@var{host}[:@var{port}]]/@var{volume}/@var{path}
1046                                [?socket=...][,file.debug=9][,file.logfile=...]
1047
1048 JSON:
1049 qemu-system-x86_64 'json:@{"driver":"qcow2",
1050                            "file":@{"driver":"gluster",
1051                                     "volume":"testvol","path":"a.img","debug":9,"logfile":"...",
1052                                     "server":[@{"type":"tcp","host":"...","port":"..."@},
1053                                               @{"type":"unix","socket":"..."@}]@}@}'
1054 @end example
1055
1056 @var{gluster} is the protocol.
1057
1058 @var{type} specifies the transport type used to connect to gluster
1059 management daemon (glusterd). Valid transport types are
1060 tcp and unix. In the URI form, if a transport type isn't specified,
1061 then tcp type is assumed.
1062
1063 @var{host} specifies the server where the volume file specification for
1064 the given volume resides. This can be either a hostname or an ipv4 address.
1065 If transport type is unix, then @var{host} field should not be specified.
1066 Instead @var{socket} field needs to be populated with the path to unix domain
1067 socket.
1068
1069 @var{port} is the port number on which glusterd is listening. This is optional
1070 and if not specified, it defaults to port 24007. If the transport type is unix,
1071 then @var{port} should not be specified.
1072
1073 @var{volume} is the name of the gluster volume which contains the disk image.
1074
1075 @var{path} is the path to the actual disk image that resides on gluster volume.
1076
1077 @var{debug} is the logging level of the gluster protocol driver. Debug levels
1078 are 0-9, with 9 being the most verbose, and 0 representing no debugging output.
1079 The default level is 4. The current logging levels defined in the gluster source
1080 are 0 - None, 1 - Emergency, 2 - Alert, 3 - Critical, 4 - Error, 5 - Warning,
1081 6 - Notice, 7 - Info, 8 - Debug, 9 - Trace
1082
1083 @var{logfile} is a commandline option to mention log file path which helps in
1084 logging to the specified file and also help in persisting the gfapi logs. The
1085 default is stderr.
1086
1087
1088
1089
1090 You can create a GlusterFS disk image with the command:
1091 @example
1092 qemu-img create gluster://@var{host}/@var{volume}/@var{path} @var{size}
1093 @end example
1094
1095 Examples
1096 @example
1097 qemu-system-x86_64 -drive file=gluster://1.2.3.4/testvol/a.img
1098 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4/testvol/a.img
1099 qemu-system-x86_64 -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
1100 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
1101 qemu-system-x86_64 -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
1102 qemu-system-x86_64 -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
1103 qemu-system-x86_64 -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
1104 qemu-system-x86_64 -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
1105 qemu-system-x86_64 -drive file=gluster://1.2.3.4/testvol/a.img,file.debug=9,file.logfile=/var/log/qemu-gluster.log
1106 qemu-system-x86_64 'json:@{"driver":"qcow2",
1107                            "file":@{"driver":"gluster",
1108                                     "volume":"testvol","path":"a.img",
1109                                     "debug":9,"logfile":"/var/log/qemu-gluster.log",
1110                                     "server":[@{"type":"tcp","host":"1.2.3.4","port":24007@},
1111                                               @{"type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}'
1112 qemu-system-x86_64 -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
1113                                        file.debug=9,file.logfile=/var/log/qemu-gluster.log,
1114                                        file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
1115                                        file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
1116 @end example
1117
1118 @node disk_images_ssh
1119 @subsection Secure Shell (ssh) disk images
1120
1121 You can access disk images located on a remote ssh server
1122 by using the ssh protocol:
1123
1124 @example
1125 qemu-system-x86_64 -drive file=ssh://[@var{user}@@]@var{server}[:@var{port}]/@var{path}[?host_key_check=@var{host_key_check}]
1126 @end example
1127
1128 Alternative syntax using properties:
1129
1130 @example
1131 qemu-system-x86_64 -drive file.driver=ssh[,file.user=@var{user}],file.host=@var{server}[,file.port=@var{port}],file.path=@var{path}[,file.host_key_check=@var{host_key_check}]
1132 @end example
1133
1134 @var{ssh} is the protocol.
1135
1136 @var{user} is the remote user.  If not specified, then the local
1137 username is tried.
1138
1139 @var{server} specifies the remote ssh server.  Any ssh server can be
1140 used, but it must implement the sftp-server protocol.  Most Unix/Linux
1141 systems should work without requiring any extra configuration.
1142
1143 @var{port} is the port number on which sshd is listening.  By default
1144 the standard ssh port (22) is used.
1145
1146 @var{path} is the path to the disk image.
1147
1148 The optional @var{host_key_check} parameter controls how the remote
1149 host's key is checked.  The default is @code{yes} which means to use
1150 the local @file{.ssh/known_hosts} file.  Setting this to @code{no}
1151 turns off known-hosts checking.  Or you can check that the host key
1152 matches a specific fingerprint:
1153 @code{host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8}
1154 (@code{sha1:} can also be used as a prefix, but note that OpenSSH
1155 tools only use MD5 to print fingerprints).
1156
1157 Currently authentication must be done using ssh-agent.  Other
1158 authentication methods may be supported in future.
1159
1160 Note: Many ssh servers do not support an @code{fsync}-style operation.
1161 The ssh driver cannot guarantee that disk flush requests are
1162 obeyed, and this causes a risk of disk corruption if the remote
1163 server or network goes down during writes.  The driver will
1164 print a warning when @code{fsync} is not supported:
1165
1166 warning: ssh server @code{ssh.example.com:22} does not support fsync
1167
1168 With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is
1169 supported.
1170
1171 @node pcsys_network
1172 @section Network emulation
1173
1174 QEMU can simulate several network cards (PCI or ISA cards on the PC
1175 target) and can connect them to an arbitrary number of Virtual Local
1176 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1177 VLAN. VLAN can be connected between separate instances of QEMU to
1178 simulate large networks. For simpler usage, a non privileged user mode
1179 network stack can replace the TAP device to have a basic network
1180 connection.
1181
1182 @subsection VLANs
1183
1184 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1185 connection between several network devices. These devices can be for
1186 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1187 (TAP devices).
1188
1189 @subsection Using TAP network interfaces
1190
1191 This is the standard way to connect QEMU to a real network. QEMU adds
1192 a virtual network device on your host (called @code{tapN}), and you
1193 can then configure it as if it was a real ethernet card.
1194
1195 @subsubsection Linux host
1196
1197 As an example, you can download the @file{linux-test-xxx.tar.gz}
1198 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1199 configure properly @code{sudo} so that the command @code{ifconfig}
1200 contained in @file{qemu-ifup} can be executed as root. You must verify
1201 that your host kernel supports the TAP network interfaces: the
1202 device @file{/dev/net/tun} must be present.
1203
1204 See @ref{sec_invocation} to have examples of command lines using the
1205 TAP network interfaces.
1206
1207 @subsubsection Windows host
1208
1209 There is a virtual ethernet driver for Windows 2000/XP systems, called
1210 TAP-Win32. But it is not included in standard QEMU for Windows,
1211 so you will need to get it separately. It is part of OpenVPN package,
1212 so download OpenVPN from : @url{http://openvpn.net/}.
1213
1214 @subsection Using the user mode network stack
1215
1216 By using the option @option{-net user} (default configuration if no
1217 @option{-net} option is specified), QEMU uses a completely user mode
1218 network stack (you don't need root privilege to use the virtual
1219 network). The virtual network configuration is the following:
1220
1221 @example
1222
1223          QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1224                            |          (10.0.2.2)
1225                            |
1226                            ---->  DNS server (10.0.2.3)
1227                            |
1228                            ---->  SMB server (10.0.2.4)
1229 @end example
1230
1231 The QEMU VM behaves as if it was behind a firewall which blocks all
1232 incoming connections. You can use a DHCP client to automatically
1233 configure the network in the QEMU VM. The DHCP server assign addresses
1234 to the hosts starting from 10.0.2.15.
1235
1236 In order to check that the user mode network is working, you can ping
1237 the address 10.0.2.2 and verify that you got an address in the range
1238 10.0.2.x from the QEMU virtual DHCP server.
1239
1240 Note that ICMP traffic in general does not work with user mode networking.
1241 @code{ping}, aka. ICMP echo, to the local router (10.0.2.2) shall work,
1242 however. If you're using QEMU on Linux >= 3.0, it can use unprivileged ICMP
1243 ping sockets to allow @code{ping} to the Internet. The host admin has to set
1244 the ping_group_range in order to grant access to those sockets. To allow ping
1245 for GID 100 (usually users group):
1246
1247 @example
1248 echo 100 100 > /proc/sys/net/ipv4/ping_group_range
1249 @end example
1250
1251 When using the built-in TFTP server, the router is also the TFTP
1252 server.
1253
1254 When using the @option{'-netdev user,hostfwd=...'} option, TCP or UDP
1255 connections can be redirected from the host to the guest. It allows for
1256 example to redirect X11, telnet or SSH connections.
1257
1258 @subsection Connecting VLANs between QEMU instances
1259
1260 Using the @option{-net socket} option, it is possible to make VLANs
1261 that span several QEMU instances. See @ref{sec_invocation} to have a
1262 basic example.
1263
1264 @node pcsys_other_devs
1265 @section Other Devices
1266
1267 @subsection Inter-VM Shared Memory device
1268
1269 On Linux hosts, a shared memory device is available.  The basic syntax
1270 is:
1271
1272 @example
1273 qemu-system-x86_64 -device ivshmem-plain,memdev=@var{hostmem}
1274 @end example
1275
1276 where @var{hostmem} names a host memory backend.  For a POSIX shared
1277 memory backend, use something like
1278
1279 @example
1280 -object memory-backend-file,size=1M,share,mem-path=/dev/shm/ivshmem,id=@var{hostmem}
1281 @end example
1282
1283 If desired, interrupts can be sent between guest VMs accessing the same shared
1284 memory region.  Interrupt support requires using a shared memory server and
1285 using a chardev socket to connect to it.  The code for the shared memory server
1286 is qemu.git/contrib/ivshmem-server.  An example syntax when using the shared
1287 memory server is:
1288
1289 @example
1290 # First start the ivshmem server once and for all
1291 ivshmem-server -p @var{pidfile} -S @var{path} -m @var{shm-name} -l @var{shm-size} -n @var{vectors}
1292
1293 # Then start your qemu instances with matching arguments
1294 qemu-system-x86_64 -device ivshmem-doorbell,vectors=@var{vectors},chardev=@var{id}
1295                  -chardev socket,path=@var{path},id=@var{id}
1296 @end example
1297
1298 When using the server, the guest will be assigned a VM ID (>=0) that allows guests
1299 using the same server to communicate via interrupts.  Guests can read their
1300 VM ID from a device register (see ivshmem-spec.txt).
1301
1302 @subsubsection Migration with ivshmem
1303
1304 With device property @option{master=on}, the guest will copy the shared
1305 memory on migration to the destination host.  With @option{master=off},
1306 the guest will not be able to migrate with the device attached.  In the
1307 latter case, the device should be detached and then reattached after
1308 migration using the PCI hotplug support.
1309
1310 At most one of the devices sharing the same memory can be master.  The
1311 master must complete migration before you plug back the other devices.
1312
1313 @subsubsection ivshmem and hugepages
1314
1315 Instead of specifying the <shm size> using POSIX shm, you may specify
1316 a memory backend that has hugepage support:
1317
1318 @example
1319 qemu-system-x86_64 -object memory-backend-file,size=1G,mem-path=/dev/hugepages/my-shmem-file,share,id=mb1
1320                  -device ivshmem-plain,memdev=mb1
1321 @end example
1322
1323 ivshmem-server also supports hugepages mount points with the
1324 @option{-m} memory path argument.
1325
1326 @node direct_linux_boot
1327 @section Direct Linux Boot
1328
1329 This section explains how to launch a Linux kernel inside QEMU without
1330 having to make a full bootable image. It is very useful for fast Linux
1331 kernel testing.
1332
1333 The syntax is:
1334 @example
1335 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1336 @end example
1337
1338 Use @option{-kernel} to provide the Linux kernel image and
1339 @option{-append} to give the kernel command line arguments. The
1340 @option{-initrd} option can be used to provide an INITRD image.
1341
1342 When using the direct Linux boot, a disk image for the first hard disk
1343 @file{hda} is required because its boot sector is used to launch the
1344 Linux kernel.
1345
1346 If you do not need graphical output, you can disable it and redirect
1347 the virtual serial port and the QEMU monitor to the console with the
1348 @option{-nographic} option. The typical command line is:
1349 @example
1350 qemu-system-i386 -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1351                  -append "root=/dev/hda console=ttyS0" -nographic
1352 @end example
1353
1354 Use @key{Ctrl-a c} to switch between the serial console and the
1355 monitor (@pxref{pcsys_keys}).
1356
1357 @node pcsys_usb
1358 @section USB emulation
1359
1360 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1361 virtual USB devices or real host USB devices (experimental, works only
1362 on Linux hosts).  QEMU will automatically create and connect virtual USB hubs
1363 as necessary to connect multiple USB devices.
1364
1365 @menu
1366 * usb_devices::
1367 * host_usb_devices::
1368 @end menu
1369 @node usb_devices
1370 @subsection Connecting USB devices
1371
1372 USB devices can be connected with the @option{-usbdevice} commandline option
1373 or the @code{usb_add} monitor command.  Available devices are:
1374
1375 @table @code
1376 @item mouse
1377 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1378 @item tablet
1379 Pointer device that uses absolute coordinates (like a touchscreen).
1380 This means QEMU is able to report the mouse position without having
1381 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1382 @item disk:@var{file}
1383 Mass storage device based on @var{file} (@pxref{disk_images})
1384 @item host:@var{bus.addr}
1385 Pass through the host device identified by @var{bus.addr}
1386 (Linux only)
1387 @item host:@var{vendor_id:product_id}
1388 Pass through the host device identified by @var{vendor_id:product_id}
1389 (Linux only)
1390 @item wacom-tablet
1391 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
1392 above but it can be used with the tslib library because in addition to touch
1393 coordinates it reports touch pressure.
1394 @item keyboard
1395 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
1396 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1397 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1398 device @var{dev}. The available character devices are the same as for the
1399 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1400 used to override the default 0403:6001. For instance,
1401 @example
1402 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1403 @end example
1404 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1405 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1406 @item braille
1407 Braille device.  This will use BrlAPI to display the braille output on a real
1408 or fake device.
1409 @item net:@var{options}
1410 Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
1411 specifies NIC options as with @code{-net nic,}@var{options} (see description).
1412 For instance, user-mode networking can be used with
1413 @example
1414 qemu-system-i386 [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
1415 @end example
1416 Currently this cannot be used in machines that support PCI NICs.
1417 @item bt[:@var{hci-type}]
1418 Bluetooth dongle whose type is specified in the same format as with
1419 the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
1420 no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
1421 This USB device implements the USB Transport Layer of HCI.  Example
1422 usage:
1423 @example
1424 @command{qemu-system-i386} [...@var{OPTIONS}...] @option{-usbdevice} bt:hci,vlan=3 @option{-bt} device:keyboard,vlan=3
1425 @end example
1426 @end table
1427
1428 @node host_usb_devices
1429 @subsection Using host USB devices on a Linux host
1430
1431 WARNING: this is an experimental feature. QEMU will slow down when
1432 using it. USB devices requiring real time streaming (i.e. USB Video
1433 Cameras) are not supported yet.
1434
1435 @enumerate
1436 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1437 is actually using the USB device. A simple way to do that is simply to
1438 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1439 to @file{mydriver.o.disabled}.
1440
1441 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1442 @example
1443 ls /proc/bus/usb
1444 001  devices  drivers
1445 @end example
1446
1447 @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:
1448 @example
1449 chown -R myuid /proc/bus/usb
1450 @end example
1451
1452 @item Launch QEMU and do in the monitor:
1453 @example
1454 info usbhost
1455   Device 1.2, speed 480 Mb/s
1456     Class 00: USB device 1234:5678, USB DISK
1457 @end example
1458 You should see the list of the devices you can use (Never try to use
1459 hubs, it won't work).
1460
1461 @item Add the device in QEMU by using:
1462 @example
1463 usb_add host:1234:5678
1464 @end example
1465
1466 Normally the guest OS should report that a new USB device is
1467 plugged. You can use the option @option{-usbdevice} to do the same.
1468
1469 @item Now you can try to use the host USB device in QEMU.
1470
1471 @end enumerate
1472
1473 When relaunching QEMU, you may have to unplug and plug again the USB
1474 device to make it work again (this is a bug).
1475
1476 @node vnc_security
1477 @section VNC security
1478
1479 The VNC server capability provides access to the graphical console
1480 of the guest VM across the network. This has a number of security
1481 considerations depending on the deployment scenarios.
1482
1483 @menu
1484 * vnc_sec_none::
1485 * vnc_sec_password::
1486 * vnc_sec_certificate::
1487 * vnc_sec_certificate_verify::
1488 * vnc_sec_certificate_pw::
1489 * vnc_sec_sasl::
1490 * vnc_sec_certificate_sasl::
1491 * vnc_generate_cert::
1492 * vnc_setup_sasl::
1493 @end menu
1494 @node vnc_sec_none
1495 @subsection Without passwords
1496
1497 The simplest VNC server setup does not include any form of authentication.
1498 For this setup it is recommended to restrict it to listen on a UNIX domain
1499 socket only. For example
1500
1501 @example
1502 qemu-system-i386 [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1503 @end example
1504
1505 This ensures that only users on local box with read/write access to that
1506 path can access the VNC server. To securely access the VNC server from a
1507 remote machine, a combination of netcat+ssh can be used to provide a secure
1508 tunnel.
1509
1510 @node vnc_sec_password
1511 @subsection With passwords
1512
1513 The VNC protocol has limited support for password based authentication. Since
1514 the protocol limits passwords to 8 characters it should not be considered
1515 to provide high security. The password can be fairly easily brute-forced by
1516 a client making repeat connections. For this reason, a VNC server using password
1517 authentication should be restricted to only listen on the loopback interface
1518 or UNIX domain sockets. Password authentication is not supported when operating
1519 in FIPS 140-2 compliance mode as it requires the use of the DES cipher. Password
1520 authentication is requested with the @code{password} option, and then once QEMU
1521 is running the password is set with the monitor. Until the monitor is used to
1522 set the password all clients will be rejected.
1523
1524 @example
1525 qemu-system-i386 [...OPTIONS...] -vnc :1,password -monitor stdio
1526 (qemu) change vnc password
1527 Password: ********
1528 (qemu)
1529 @end example
1530
1531 @node vnc_sec_certificate
1532 @subsection With x509 certificates
1533
1534 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1535 TLS for encryption of the session, and x509 certificates for authentication.
1536 The use of x509 certificates is strongly recommended, because TLS on its
1537 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1538 support provides a secure session, but no authentication. This allows any
1539 client to connect, and provides an encrypted session.
1540
1541 @example
1542 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1543 @end example
1544
1545 In the above example @code{/etc/pki/qemu} should contain at least three files,
1546 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1547 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1548 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1549 only be readable by the user owning it.
1550
1551 @node vnc_sec_certificate_verify
1552 @subsection With x509 certificates and client verification
1553
1554 Certificates can also provide a means to authenticate the client connecting.
1555 The server will request that the client provide a certificate, which it will
1556 then validate against the CA certificate. This is a good choice if deploying
1557 in an environment with a private internal certificate authority.
1558
1559 @example
1560 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1561 @end example
1562
1563
1564 @node vnc_sec_certificate_pw
1565 @subsection With x509 certificates, client verification and passwords
1566
1567 Finally, the previous method can be combined with VNC password authentication
1568 to provide two layers of authentication for clients.
1569
1570 @example
1571 qemu-system-i386 [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1572 (qemu) change vnc password
1573 Password: ********
1574 (qemu)
1575 @end example
1576
1577
1578 @node vnc_sec_sasl
1579 @subsection With SASL authentication
1580
1581 The SASL authentication method is a VNC extension, that provides an
1582 easily extendable, pluggable authentication method. This allows for
1583 integration with a wide range of authentication mechanisms, such as
1584 PAM, GSSAPI/Kerberos, LDAP, SQL databases, one-time keys and more.
1585 The strength of the authentication depends on the exact mechanism
1586 configured. If the chosen mechanism also provides a SSF layer, then
1587 it will encrypt the datastream as well.
1588
1589 Refer to the later docs on how to choose the exact SASL mechanism
1590 used for authentication, but assuming use of one supporting SSF,
1591 then QEMU can be launched with:
1592
1593 @example
1594 qemu-system-i386 [...OPTIONS...] -vnc :1,sasl -monitor stdio
1595 @end example
1596
1597 @node vnc_sec_certificate_sasl
1598 @subsection With x509 certificates and SASL authentication
1599
1600 If the desired SASL authentication mechanism does not supported
1601 SSF layers, then it is strongly advised to run it in combination
1602 with TLS and x509 certificates. This provides securely encrypted
1603 data stream, avoiding risk of compromising of the security
1604 credentials. This can be enabled, by combining the 'sasl' option
1605 with the aforementioned TLS + x509 options:
1606
1607 @example
1608 qemu-system-i386 [...OPTIONS...] -vnc :1,tls,x509,sasl -monitor stdio
1609 @end example
1610
1611
1612 @node vnc_generate_cert
1613 @subsection Generating certificates for VNC
1614
1615 The GNU TLS packages provides a command called @code{certtool} which can
1616 be used to generate certificates and keys in PEM format. At a minimum it
1617 is necessary to setup a certificate authority, and issue certificates to
1618 each server. If using certificates for authentication, then each client
1619 will also need to be issued a certificate. The recommendation is for the
1620 server to keep its certificates in either @code{/etc/pki/qemu} or for
1621 unprivileged users in @code{$HOME/.pki/qemu}.
1622
1623 @menu
1624 * vnc_generate_ca::
1625 * vnc_generate_server::
1626 * vnc_generate_client::
1627 @end menu
1628 @node vnc_generate_ca
1629 @subsubsection Setup the Certificate Authority
1630
1631 This step only needs to be performed once per organization / organizational
1632 unit. First the CA needs a private key. This key must be kept VERY secret
1633 and secure. If this key is compromised the entire trust chain of the certificates
1634 issued with it is lost.
1635
1636 @example
1637 # certtool --generate-privkey > ca-key.pem
1638 @end example
1639
1640 A CA needs to have a public certificate. For simplicity it can be a self-signed
1641 certificate, or one issue by a commercial certificate issuing authority. To
1642 generate a self-signed certificate requires one core piece of information, the
1643 name of the organization.
1644
1645 @example
1646 # cat > ca.info <<EOF
1647 cn = Name of your organization
1648 ca
1649 cert_signing_key
1650 EOF
1651 # certtool --generate-self-signed \
1652            --load-privkey ca-key.pem
1653            --template ca.info \
1654            --outfile ca-cert.pem
1655 @end example
1656
1657 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1658 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1659
1660 @node vnc_generate_server
1661 @subsubsection Issuing server certificates
1662
1663 Each server (or host) needs to be issued with a key and certificate. When connecting
1664 the certificate is sent to the client which validates it against the CA certificate.
1665 The core piece of information for a server certificate is the hostname. This should
1666 be the fully qualified hostname that the client will connect with, since the client
1667 will typically also verify the hostname in the certificate. On the host holding the
1668 secure CA private key:
1669
1670 @example
1671 # cat > server.info <<EOF
1672 organization = Name  of your organization
1673 cn = server.foo.example.com
1674 tls_www_server
1675 encryption_key
1676 signing_key
1677 EOF
1678 # certtool --generate-privkey > server-key.pem
1679 # certtool --generate-certificate \
1680            --load-ca-certificate ca-cert.pem \
1681            --load-ca-privkey ca-key.pem \
1682            --load-privkey server-key.pem \
1683            --template server.info \
1684            --outfile server-cert.pem
1685 @end example
1686
1687 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1688 to the server for which they were generated. The @code{server-key.pem} is security
1689 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1690
1691 @node vnc_generate_client
1692 @subsubsection Issuing client certificates
1693
1694 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1695 certificates as its authentication mechanism, each client also needs to be issued
1696 a certificate. The client certificate contains enough metadata to uniquely identify
1697 the client, typically organization, state, city, building, etc. On the host holding
1698 the secure CA private key:
1699
1700 @example
1701 # cat > client.info <<EOF
1702 country = GB
1703 state = London
1704 locality = London
1705 organization = Name of your organization
1706 cn = client.foo.example.com
1707 tls_www_client
1708 encryption_key
1709 signing_key
1710 EOF
1711 # certtool --generate-privkey > client-key.pem
1712 # certtool --generate-certificate \
1713            --load-ca-certificate ca-cert.pem \
1714            --load-ca-privkey ca-key.pem \
1715            --load-privkey client-key.pem \
1716            --template client.info \
1717            --outfile client-cert.pem
1718 @end example
1719
1720 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1721 copied to the client for which they were generated.
1722
1723
1724 @node vnc_setup_sasl
1725
1726 @subsection Configuring SASL mechanisms
1727
1728 The following documentation assumes use of the Cyrus SASL implementation on a
1729 Linux host, but the principals should apply to any other SASL impl. When SASL
1730 is enabled, the mechanism configuration will be loaded from system default
1731 SASL service config /etc/sasl2/qemu.conf. If running QEMU as an
1732 unprivileged user, an environment variable SASL_CONF_PATH can be used
1733 to make it search alternate locations for the service config.
1734
1735 The default configuration might contain
1736
1737 @example
1738 mech_list: digest-md5
1739 sasldb_path: /etc/qemu/passwd.db
1740 @end example
1741
1742 This says to use the 'Digest MD5' mechanism, which is similar to the HTTP
1743 Digest-MD5 mechanism. The list of valid usernames & passwords is maintained
1744 in the /etc/qemu/passwd.db file, and can be updated using the saslpasswd2
1745 command. While this mechanism is easy to configure and use, it is not
1746 considered secure by modern standards, so only suitable for developers /
1747 ad-hoc testing.
1748
1749 A more serious deployment might use Kerberos, which is done with the 'gssapi'
1750 mechanism
1751
1752 @example
1753 mech_list: gssapi
1754 keytab: /etc/qemu/krb5.tab
1755 @end example
1756
1757 For this to work the administrator of your KDC must generate a Kerberos
1758 principal for the server, with a name of  'qemu/somehost.example.com@@EXAMPLE.COM'
1759 replacing 'somehost.example.com' with the fully qualified host name of the
1760 machine running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm.
1761
1762 Other configurations will be left as an exercise for the reader. It should
1763 be noted that only Digest-MD5 and GSSAPI provides a SSF layer for data
1764 encryption. For all other mechanisms, VNC should always be configured to
1765 use TLS and x509 certificates to protect security credentials from snooping.
1766
1767 @node gdb_usage
1768 @section GDB usage
1769
1770 QEMU has a primitive support to work with gdb, so that you can do
1771 'Ctrl-C' while the virtual machine is running and inspect its state.
1772
1773 In order to use gdb, launch QEMU with the '-s' option. It will wait for a
1774 gdb connection:
1775 @example
1776 qemu-system-i386 -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1777                     -append "root=/dev/hda"
1778 Connected to host network interface: tun0
1779 Waiting gdb connection on port 1234
1780 @end example
1781
1782 Then launch gdb on the 'vmlinux' executable:
1783 @example
1784 > gdb vmlinux
1785 @end example
1786
1787 In gdb, connect to QEMU:
1788 @example
1789 (gdb) target remote localhost:1234
1790 @end example
1791
1792 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1793 @example
1794 (gdb) c
1795 @end example
1796
1797 Here are some useful tips in order to use gdb on system code:
1798
1799 @enumerate
1800 @item
1801 Use @code{info reg} to display all the CPU registers.
1802 @item
1803 Use @code{x/10i $eip} to display the code at the PC position.
1804 @item
1805 Use @code{set architecture i8086} to dump 16 bit code. Then use
1806 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1807 @end enumerate
1808
1809 Advanced debugging options:
1810
1811 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 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:
1812 @table @code
1813 @item maintenance packet qqemu.sstepbits
1814
1815 This will display the MASK bits used to control the single stepping IE:
1816 @example
1817 (gdb) maintenance packet qqemu.sstepbits
1818 sending: "qqemu.sstepbits"
1819 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1820 @end example
1821 @item maintenance packet qqemu.sstep
1822
1823 This will display the current value of the mask used when single stepping IE:
1824 @example
1825 (gdb) maintenance packet qqemu.sstep
1826 sending: "qqemu.sstep"
1827 received: "0x7"
1828 @end example
1829 @item maintenance packet Qqemu.sstep=HEX_VALUE
1830
1831 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1832 @example
1833 (gdb) maintenance packet Qqemu.sstep=0x5
1834 sending: "qemu.sstep=0x5"
1835 received: "OK"
1836 @end example
1837 @end table
1838
1839 @node pcsys_os_specific
1840 @section Target OS specific information
1841
1842 @subsection Linux
1843
1844 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1845 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1846 color depth in the guest and the host OS.
1847
1848 When using a 2.6 guest Linux kernel, you should add the option
1849 @code{clock=pit} on the kernel command line because the 2.6 Linux
1850 kernels make very strict real time clock checks by default that QEMU
1851 cannot simulate exactly.
1852
1853 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1854 not activated because QEMU is slower with this patch. The QEMU
1855 Accelerator Module is also much slower in this case. Earlier Fedora
1856 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
1857 patch by default. Newer kernels don't have it.
1858
1859 @subsection Windows
1860
1861 If you have a slow host, using Windows 95 is better as it gives the
1862 best speed. Windows 2000 is also a good choice.
1863
1864 @subsubsection SVGA graphic modes support
1865
1866 QEMU emulates a Cirrus Logic GD5446 Video
1867 card. All Windows versions starting from Windows 95 should recognize
1868 and use this graphic card. For optimal performances, use 16 bit color
1869 depth in the guest and the host OS.
1870
1871 If you are using Windows XP as guest OS and if you want to use high
1872 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1873 1280x1024x16), then you should use the VESA VBE virtual graphic card
1874 (option @option{-std-vga}).
1875
1876 @subsubsection CPU usage reduction
1877
1878 Windows 9x does not correctly use the CPU HLT
1879 instruction. The result is that it takes host CPU cycles even when
1880 idle. You can install the utility from
1881 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1882 problem. Note that no such tool is needed for NT, 2000 or XP.
1883
1884 @subsubsection Windows 2000 disk full problem
1885
1886 Windows 2000 has a bug which gives a disk full problem during its
1887 installation. When installing it, use the @option{-win2k-hack} QEMU
1888 option to enable a specific workaround. After Windows 2000 is
1889 installed, you no longer need this option (this option slows down the
1890 IDE transfers).
1891
1892 @subsubsection Windows 2000 shutdown
1893
1894 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1895 can. It comes from the fact that Windows 2000 does not automatically
1896 use the APM driver provided by the BIOS.
1897
1898 In order to correct that, do the following (thanks to Struan
1899 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1900 Add/Troubleshoot a device => Add a new device & Next => No, select the
1901 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1902 (again) a few times. Now the driver is installed and Windows 2000 now
1903 correctly instructs QEMU to shutdown at the appropriate moment.
1904
1905 @subsubsection Share a directory between Unix and Windows
1906
1907 See @ref{sec_invocation} about the help of the option
1908 @option{'-netdev user,smb=...'}.
1909
1910 @subsubsection Windows XP security problem
1911
1912 Some releases of Windows XP install correctly but give a security
1913 error when booting:
1914 @example
1915 A problem is preventing Windows from accurately checking the
1916 license for this computer. Error code: 0x800703e6.
1917 @end example
1918
1919 The workaround is to install a service pack for XP after a boot in safe
1920 mode. Then reboot, and the problem should go away. Since there is no
1921 network while in safe mode, its recommended to download the full
1922 installation of SP1 or SP2 and transfer that via an ISO or using the
1923 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1924
1925 @subsection MS-DOS and FreeDOS
1926
1927 @subsubsection CPU usage reduction
1928
1929 DOS does not correctly use the CPU HLT instruction. The result is that
1930 it takes host CPU cycles even when idle. You can install the utility
1931 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1932 problem.
1933
1934 @node QEMU System emulator for non PC targets
1935 @chapter QEMU System emulator for non PC targets
1936
1937 QEMU is a generic emulator and it emulates many non PC
1938 machines. Most of the options are similar to the PC emulator. The
1939 differences are mentioned in the following sections.
1940
1941 @menu
1942 * PowerPC System emulator::
1943 * Sparc32 System emulator::
1944 * Sparc64 System emulator::
1945 * MIPS System emulator::
1946 * ARM System emulator::
1947 * ColdFire System emulator::
1948 * Cris System emulator::
1949 * Microblaze System emulator::
1950 * SH4 System emulator::
1951 * Xtensa System emulator::
1952 @end menu
1953
1954 @node PowerPC System emulator
1955 @section PowerPC System emulator
1956 @cindex system emulation (PowerPC)
1957
1958 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1959 or PowerMac PowerPC system.
1960
1961 QEMU emulates the following PowerMac peripherals:
1962
1963 @itemize @minus
1964 @item
1965 UniNorth or Grackle PCI Bridge
1966 @item
1967 PCI VGA compatible card with VESA Bochs Extensions
1968 @item
1969 2 PMAC IDE interfaces with hard disk and CD-ROM support
1970 @item
1971 NE2000 PCI adapters
1972 @item
1973 Non Volatile RAM
1974 @item
1975 VIA-CUDA with ADB keyboard and mouse.
1976 @end itemize
1977
1978 QEMU emulates the following PREP peripherals:
1979
1980 @itemize @minus
1981 @item
1982 PCI Bridge
1983 @item
1984 PCI VGA compatible card with VESA Bochs Extensions
1985 @item
1986 2 IDE interfaces with hard disk and CD-ROM support
1987 @item
1988 Floppy disk
1989 @item
1990 NE2000 network adapters
1991 @item
1992 Serial port
1993 @item
1994 PREP Non Volatile RAM
1995 @item
1996 PC compatible keyboard and mouse.
1997 @end itemize
1998
1999 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2000 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2001
2002 Since version 0.9.1, QEMU uses OpenBIOS @url{http://www.openbios.org/}
2003 for the g3beige and mac99 PowerMac machines. OpenBIOS is a free (GPL
2004 v2) portable firmware implementation. The goal is to implement a 100%
2005 IEEE 1275-1994 (referred to as Open Firmware) compliant firmware.
2006
2007 @c man begin OPTIONS
2008
2009 The following options are specific to the PowerPC emulation:
2010
2011 @table @option
2012
2013 @item -g @var{W}x@var{H}[x@var{DEPTH}]
2014
2015 Set the initial VGA graphic mode. The default is 800x600x32.
2016
2017 @item -prom-env @var{string}
2018
2019 Set OpenBIOS variables in NVRAM, for example:
2020
2021 @example
2022 qemu-system-ppc -prom-env 'auto-boot?=false' \
2023  -prom-env 'boot-device=hd:2,\yaboot' \
2024  -prom-env 'boot-args=conf=hd:2,\yaboot.conf'
2025 @end example
2026
2027 These variables are not used by Open Hack'Ware.
2028
2029 @end table
2030
2031 @c man end
2032
2033
2034 More information is available at
2035 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2036
2037 @node Sparc32 System emulator
2038 @section Sparc32 System emulator
2039 @cindex system emulation (Sparc32)
2040
2041 Use the executable @file{qemu-system-sparc} to simulate the following
2042 Sun4m architecture machines:
2043 @itemize @minus
2044 @item
2045 SPARCstation 4
2046 @item
2047 SPARCstation 5
2048 @item
2049 SPARCstation 10
2050 @item
2051 SPARCstation 20
2052 @item
2053 SPARCserver 600MP
2054 @item
2055 SPARCstation LX
2056 @item
2057 SPARCstation Voyager
2058 @item
2059 SPARCclassic
2060 @item
2061 SPARCbook
2062 @end itemize
2063
2064 The emulation is somewhat complete. SMP up to 16 CPUs is supported,
2065 but Linux limits the number of usable CPUs to 4.
2066
2067 QEMU emulates the following sun4m peripherals:
2068
2069 @itemize @minus
2070 @item
2071 IOMMU
2072 @item
2073 TCX or cgthree Frame buffer
2074 @item
2075 Lance (Am7990) Ethernet
2076 @item
2077 Non Volatile RAM M48T02/M48T08
2078 @item
2079 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2080 and power/reset logic
2081 @item
2082 ESP SCSI controller with hard disk and CD-ROM support
2083 @item
2084 Floppy drive (not on SS-600MP)
2085 @item
2086 CS4231 sound device (only on SS-5, not working yet)
2087 @end itemize
2088
2089 The number of peripherals is fixed in the architecture.  Maximum
2090 memory size depends on the machine type, for SS-5 it is 256MB and for
2091 others 2047MB.
2092
2093 Since version 0.8.2, QEMU uses OpenBIOS
2094 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2095 firmware implementation. The goal is to implement a 100% IEEE
2096 1275-1994 (referred to as Open Firmware) compliant firmware.
2097
2098 A sample Linux 2.6 series kernel and ram disk image are available on
2099 the QEMU web site. There are still issues with NetBSD and OpenBSD, but
2100 most kernel versions work. Please note that currently older Solaris kernels
2101 don't work probably due to interface issues between OpenBIOS and
2102 Solaris.
2103
2104 @c man begin OPTIONS
2105
2106 The following options are specific to the Sparc32 emulation:
2107
2108 @table @option
2109
2110 @item -g @var{W}x@var{H}x[x@var{DEPTH}]
2111
2112 Set the initial graphics mode. For TCX, the default is 1024x768x8 with the
2113 option of 1024x768x24. For cgthree, the default is 1024x768x8 with the option
2114 of 1152x900x8 for people who wish to use OBP.
2115
2116 @item -prom-env @var{string}
2117
2118 Set OpenBIOS variables in NVRAM, for example:
2119
2120 @example
2121 qemu-system-sparc -prom-env 'auto-boot?=false' \
2122  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2123 @end example
2124
2125 @item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook]
2126
2127 Set the emulated machine type. Default is SS-5.
2128
2129 @end table
2130
2131 @c man end
2132
2133 @node Sparc64 System emulator
2134 @section Sparc64 System emulator
2135 @cindex system emulation (Sparc64)
2136
2137 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u
2138 (UltraSPARC PC-like machine), Sun4v (T1 PC-like machine), or generic
2139 Niagara (T1) machine. The Sun4u emulator is mostly complete, being
2140 able to run Linux, NetBSD and OpenBSD in headless (-nographic) mode. The
2141 Sun4v emulator is still a work in progress.
2142
2143 The Niagara T1 emulator makes use of firmware and OS binaries supplied in the S10image/ directory
2144 of the OpenSPARC T1 project @url{http://download.oracle.com/technetwork/systems/opensparc/OpenSPARCT1_Arch.1.5.tar.bz2}
2145 and is able to boot the disk.s10hw2 Solaris image.
2146 @example
2147 qemu-system-sparc64 -M niagara -L /path-to/S10image/ \
2148                     -nographic -m 256 \
2149                     -drive if=pflash,readonly=on,file=/S10image/disk.s10hw2
2150 @end example
2151
2152
2153 QEMU emulates the following peripherals:
2154
2155 @itemize @minus
2156 @item
2157 UltraSparc IIi APB PCI Bridge
2158 @item
2159 PCI VGA compatible card with VESA Bochs Extensions
2160 @item
2161 PS/2 mouse and keyboard
2162 @item
2163 Non Volatile RAM M48T59
2164 @item
2165 PC-compatible serial ports
2166 @item
2167 2 PCI IDE interfaces with hard disk and CD-ROM support
2168 @item
2169 Floppy disk
2170 @end itemize
2171
2172 @c man begin OPTIONS
2173
2174 The following options are specific to the Sparc64 emulation:
2175
2176 @table @option
2177
2178 @item -prom-env @var{string}
2179
2180 Set OpenBIOS variables in NVRAM, for example:
2181
2182 @example
2183 qemu-system-sparc64 -prom-env 'auto-boot?=false'
2184 @end example
2185
2186 @item -M [sun4u|sun4v|niagara]
2187
2188 Set the emulated machine type. The default is sun4u.
2189
2190 @end table
2191
2192 @c man end
2193
2194 @node MIPS System emulator
2195 @section MIPS System emulator
2196 @cindex system emulation (MIPS)
2197
2198 Four executables cover simulation of 32 and 64-bit MIPS systems in
2199 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2200 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2201 Five different machine types are emulated:
2202
2203 @itemize @minus
2204 @item
2205 A generic ISA PC-like machine "mips"
2206 @item
2207 The MIPS Malta prototype board "malta"
2208 @item
2209 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2210 @item
2211 MIPS emulator pseudo board "mipssim"
2212 @item
2213 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2214 @end itemize
2215
2216 The generic emulation is supported by Debian 'Etch' and is able to
2217 install Debian into a virtual disk image. The following devices are
2218 emulated:
2219
2220 @itemize @minus
2221 @item
2222 A range of MIPS CPUs, default is the 24Kf
2223 @item
2224 PC style serial port
2225 @item
2226 PC style IDE disk
2227 @item
2228 NE2000 network card
2229 @end itemize
2230
2231 The Malta emulation supports the following devices:
2232
2233 @itemize @minus
2234 @item
2235 Core board with MIPS 24Kf CPU and Galileo system controller
2236 @item
2237 PIIX4 PCI/USB/SMbus controller
2238 @item
2239 The Multi-I/O chip's serial device
2240 @item
2241 PCI network cards (PCnet32 and others)
2242 @item
2243 Malta FPGA serial device
2244 @item
2245 Cirrus (default) or any other PCI VGA graphics card
2246 @end itemize
2247
2248 The ACER Pica emulation supports:
2249
2250 @itemize @minus
2251 @item
2252 MIPS R4000 CPU
2253 @item
2254 PC-style IRQ and DMA controllers
2255 @item
2256 PC Keyboard
2257 @item
2258 IDE controller
2259 @end itemize
2260
2261 The mipssim pseudo board emulation provides an environment similar
2262 to what the proprietary MIPS emulator uses for running Linux.
2263 It supports:
2264
2265 @itemize @minus
2266 @item
2267 A range of MIPS CPUs, default is the 24Kf
2268 @item
2269 PC style serial port
2270 @item
2271 MIPSnet network emulation
2272 @end itemize
2273
2274 The MIPS Magnum R4000 emulation supports:
2275
2276 @itemize @minus
2277 @item
2278 MIPS R4000 CPU
2279 @item
2280 PC-style IRQ controller
2281 @item
2282 PC Keyboard
2283 @item
2284 SCSI controller
2285 @item
2286 G364 framebuffer
2287 @end itemize
2288
2289
2290 @node ARM System emulator
2291 @section ARM System emulator
2292 @cindex system emulation (ARM)
2293
2294 Use the executable @file{qemu-system-arm} to simulate a ARM
2295 machine. The ARM Integrator/CP board is emulated with the following
2296 devices:
2297
2298 @itemize @minus
2299 @item
2300 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2301 @item
2302 Two PL011 UARTs
2303 @item
2304 SMC 91c111 Ethernet adapter
2305 @item
2306 PL110 LCD controller
2307 @item
2308 PL050 KMI with PS/2 keyboard and mouse.
2309 @item
2310 PL181 MultiMedia Card Interface with SD card.
2311 @end itemize
2312
2313 The ARM Versatile baseboard is emulated with the following devices:
2314
2315 @itemize @minus
2316 @item
2317 ARM926E, ARM1136 or Cortex-A8 CPU
2318 @item
2319 PL190 Vectored Interrupt Controller
2320 @item
2321 Four PL011 UARTs
2322 @item
2323 SMC 91c111 Ethernet adapter
2324 @item
2325 PL110 LCD controller
2326 @item
2327 PL050 KMI with PS/2 keyboard and mouse.
2328 @item
2329 PCI host bridge.  Note the emulated PCI bridge only provides access to
2330 PCI memory space.  It does not provide access to PCI IO space.
2331 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2332 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2333 mapped control registers.
2334 @item
2335 PCI OHCI USB controller.
2336 @item
2337 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2338 @item
2339 PL181 MultiMedia Card Interface with SD card.
2340 @end itemize
2341
2342 Several variants of the ARM RealView baseboard are emulated,
2343 including the EB, PB-A8 and PBX-A9.  Due to interactions with the
2344 bootloader, only certain Linux kernel configurations work out
2345 of the box on these boards.
2346
2347 Kernels for the PB-A8 board should have CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2348 enabled in the kernel, and expect 512M RAM.  Kernels for The PBX-A9 board
2349 should have CONFIG_SPARSEMEM enabled, CONFIG_REALVIEW_HIGH_PHYS_OFFSET
2350 disabled and expect 1024M RAM.
2351
2352 The following devices are emulated:
2353
2354 @itemize @minus
2355 @item
2356 ARM926E, ARM1136, ARM11MPCore, Cortex-A8 or Cortex-A9 MPCore CPU
2357 @item
2358 ARM AMBA Generic/Distributed Interrupt Controller
2359 @item
2360 Four PL011 UARTs
2361 @item
2362 SMC 91c111 or SMSC LAN9118 Ethernet adapter
2363 @item
2364 PL110 LCD controller
2365 @item
2366 PL050 KMI with PS/2 keyboard and mouse
2367 @item
2368 PCI host bridge
2369 @item
2370 PCI OHCI USB controller
2371 @item
2372 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2373 @item
2374 PL181 MultiMedia Card Interface with SD card.
2375 @end itemize
2376
2377 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2378 and "Terrier") emulation includes the following peripherals:
2379
2380 @itemize @minus
2381 @item
2382 Intel PXA270 System-on-chip (ARM V5TE core)
2383 @item
2384 NAND Flash memory
2385 @item
2386 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2387 @item
2388 On-chip OHCI USB controller
2389 @item
2390 On-chip LCD controller
2391 @item
2392 On-chip Real Time Clock
2393 @item
2394 TI ADS7846 touchscreen controller on SSP bus
2395 @item
2396 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2397 @item
2398 GPIO-connected keyboard controller and LEDs
2399 @item
2400 Secure Digital card connected to PXA MMC/SD host
2401 @item
2402 Three on-chip UARTs
2403 @item
2404 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2405 @end itemize
2406
2407 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2408 following elements:
2409
2410 @itemize @minus
2411 @item
2412 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2413 @item
2414 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2415 @item
2416 On-chip LCD controller
2417 @item
2418 On-chip Real Time Clock
2419 @item
2420 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2421 CODEC, connected through MicroWire and I@math{^2}S busses
2422 @item
2423 GPIO-connected matrix keypad
2424 @item
2425 Secure Digital card connected to OMAP MMC/SD host
2426 @item
2427 Three on-chip UARTs
2428 @end itemize
2429
2430 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2431 emulation supports the following elements:
2432
2433 @itemize @minus
2434 @item
2435 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2436 @item
2437 RAM and non-volatile OneNAND Flash memories
2438 @item
2439 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2440 display controller and a LS041y3 MIPI DBI-C controller
2441 @item
2442 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2443 driven through SPI bus
2444 @item
2445 National Semiconductor LM8323-controlled qwerty keyboard driven
2446 through I@math{^2}C bus
2447 @item
2448 Secure Digital card connected to OMAP MMC/SD host
2449 @item
2450 Three OMAP on-chip UARTs and on-chip STI debugging console
2451 @item
2452 A Bluetooth(R) transceiver and HCI connected to an UART
2453 @item
2454 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2455 TUSB6010 chip - only USB host mode is supported
2456 @item
2457 TI TMP105 temperature sensor driven through I@math{^2}C bus
2458 @item
2459 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2460 @item
2461 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2462 through CBUS
2463 @end itemize
2464
2465 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2466 devices:
2467
2468 @itemize @minus
2469 @item
2470 Cortex-M3 CPU core.
2471 @item
2472 64k Flash and 8k SRAM.
2473 @item
2474 Timers, UARTs, ADC and I@math{^2}C interface.
2475 @item
2476 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2477 @end itemize
2478
2479 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2480 devices:
2481
2482 @itemize @minus
2483 @item
2484 Cortex-M3 CPU core.
2485 @item
2486 256k Flash and 64k SRAM.
2487 @item
2488 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2489 @item
2490 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2491 @end itemize
2492
2493 The Freecom MusicPal internet radio emulation includes the following
2494 elements:
2495
2496 @itemize @minus
2497 @item
2498 Marvell MV88W8618 ARM core.
2499 @item
2500 32 MB RAM, 256 KB SRAM, 8 MB flash.
2501 @item
2502 Up to 2 16550 UARTs
2503 @item
2504 MV88W8xx8 Ethernet controller
2505 @item
2506 MV88W8618 audio controller, WM8750 CODEC and mixer
2507 @item
2508 128×64 display with brightness control
2509 @item
2510 2 buttons, 2 navigation wheels with button function
2511 @end itemize
2512
2513 The Siemens SX1 models v1 and v2 (default) basic emulation.
2514 The emulation includes the following elements:
2515
2516 @itemize @minus
2517 @item
2518 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2519 @item
2520 ROM and RAM memories (ROM firmware image can be loaded with -pflash)
2521 V1
2522 1 Flash of 16MB and 1 Flash of 8MB
2523 V2
2524 1 Flash of 32MB
2525 @item
2526 On-chip LCD controller
2527 @item
2528 On-chip Real Time Clock
2529 @item
2530 Secure Digital card connected to OMAP MMC/SD host
2531 @item
2532 Three on-chip UARTs
2533 @end itemize
2534
2535 A Linux 2.6 test image is available on the QEMU web site. More
2536 information is available in the QEMU mailing-list archive.
2537
2538 @c man begin OPTIONS
2539
2540 The following options are specific to the ARM emulation:
2541
2542 @table @option
2543
2544 @item -semihosting
2545 Enable semihosting syscall emulation.
2546
2547 On ARM this implements the "Angel" interface.
2548
2549 Note that this allows guest direct access to the host filesystem,
2550 so should only be used with trusted guest OS.
2551
2552 @end table
2553
2554 @node ColdFire System emulator
2555 @section ColdFire System emulator
2556 @cindex system emulation (ColdFire)
2557 @cindex system emulation (M68K)
2558
2559 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2560 The emulator is able to boot a uClinux kernel.
2561
2562 The M5208EVB emulation includes the following devices:
2563
2564 @itemize @minus
2565 @item
2566 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2567 @item
2568 Three Two on-chip UARTs.
2569 @item
2570 Fast Ethernet Controller (FEC)
2571 @end itemize
2572
2573 The AN5206 emulation includes the following devices:
2574
2575 @itemize @minus
2576 @item
2577 MCF5206 ColdFire V2 Microprocessor.
2578 @item
2579 Two on-chip UARTs.
2580 @end itemize
2581
2582 @c man begin OPTIONS
2583
2584 The following options are specific to the ColdFire emulation:
2585
2586 @table @option
2587
2588 @item -semihosting
2589 Enable semihosting syscall emulation.
2590
2591 On M68K this implements the "ColdFire GDB" interface used by libgloss.
2592
2593 Note that this allows guest direct access to the host filesystem,
2594 so should only be used with trusted guest OS.
2595
2596 @end table
2597
2598 @node Cris System emulator
2599 @section Cris System emulator
2600 @cindex system emulation (Cris)
2601
2602 TODO
2603
2604 @node Microblaze System emulator
2605 @section Microblaze System emulator
2606 @cindex system emulation (Microblaze)
2607
2608 TODO
2609
2610 @node SH4 System emulator
2611 @section SH4 System emulator
2612 @cindex system emulation (SH4)
2613
2614 TODO
2615
2616 @node Xtensa System emulator
2617 @section Xtensa System emulator
2618 @cindex system emulation (Xtensa)
2619
2620 Two executables cover simulation of both Xtensa endian options,
2621 @file{qemu-system-xtensa} and @file{qemu-system-xtensaeb}.
2622 Two different machine types are emulated:
2623
2624 @itemize @minus
2625 @item
2626 Xtensa emulator pseudo board "sim"
2627 @item
2628 Avnet LX60/LX110/LX200 board
2629 @end itemize
2630
2631 The sim pseudo board emulation provides an environment similar
2632 to one provided by the proprietary Tensilica ISS.
2633 It supports:
2634
2635 @itemize @minus
2636 @item
2637 A range of Xtensa CPUs, default is the DC232B
2638 @item
2639 Console and filesystem access via semihosting calls
2640 @end itemize
2641
2642 The Avnet LX60/LX110/LX200 emulation supports:
2643
2644 @itemize @minus
2645 @item
2646 A range of Xtensa CPUs, default is the DC232B
2647 @item
2648 16550 UART
2649 @item
2650 OpenCores 10/100 Mbps Ethernet MAC
2651 @end itemize
2652
2653 @c man begin OPTIONS
2654
2655 The following options are specific to the Xtensa emulation:
2656
2657 @table @option
2658
2659 @item -semihosting
2660 Enable semihosting syscall emulation.
2661
2662 Xtensa semihosting provides basic file IO calls, such as open/read/write/seek/select.
2663 Tensilica baremetal libc for ISS and linux platform "sim" use this interface.
2664
2665 Note that this allows guest direct access to the host filesystem,
2666 so should only be used with trusted guest OS.
2667
2668 @end table
2669 @node QEMU User space emulator
2670 @chapter QEMU User space emulator
2671
2672 @menu
2673 * Supported Operating Systems ::
2674 * Features::
2675 * Linux User space emulator::
2676 * BSD User space emulator ::
2677 @end menu
2678
2679 @node Supported Operating Systems
2680 @section Supported Operating Systems
2681
2682 The following OS are supported in user space emulation:
2683
2684 @itemize @minus
2685 @item
2686 Linux (referred as qemu-linux-user)
2687 @item
2688 BSD (referred as qemu-bsd-user)
2689 @end itemize
2690
2691 @node Features
2692 @section Features
2693
2694 QEMU user space emulation has the following notable features:
2695
2696 @table @strong
2697 @item System call translation:
2698 QEMU includes a generic system call translator.  This means that
2699 the parameters of the system calls can be converted to fix
2700 endianness and 32/64-bit mismatches between hosts and targets.
2701 IOCTLs can be converted too.
2702
2703 @item POSIX signal handling:
2704 QEMU can redirect to the running program all signals coming from
2705 the host (such as @code{SIGALRM}), as well as synthesize signals from
2706 virtual CPU exceptions (for example @code{SIGFPE} when the program
2707 executes a division by zero).
2708
2709 QEMU relies on the host kernel to emulate most signal system
2710 calls, for example to emulate the signal mask.  On Linux, QEMU
2711 supports both normal and real-time signals.
2712
2713 @item Threading:
2714 On Linux, QEMU can emulate the @code{clone} syscall and create a real
2715 host thread (with a separate virtual CPU) for each emulated thread.
2716 Note that not all targets currently emulate atomic operations correctly.
2717 x86 and ARM use a global lock in order to preserve their semantics.
2718 @end table
2719
2720 QEMU was conceived so that ultimately it can emulate itself. Although
2721 it is not very useful, it is an important test to show the power of the
2722 emulator.
2723
2724 @node Linux User space emulator
2725 @section Linux User space emulator
2726
2727 @menu
2728 * Quick Start::
2729 * Wine launch::
2730 * Command line options::
2731 * Other binaries::
2732 @end menu
2733
2734 @node Quick Start
2735 @subsection Quick Start
2736
2737 In order to launch a Linux process, QEMU needs the process executable
2738 itself and all the target (x86) dynamic libraries used by it.
2739
2740 @itemize
2741
2742 @item On x86, you can just try to launch any process by using the native
2743 libraries:
2744
2745 @example
2746 qemu-i386 -L / /bin/ls
2747 @end example
2748
2749 @code{-L /} tells that the x86 dynamic linker must be searched with a
2750 @file{/} prefix.
2751
2752 @item Since QEMU is also a linux process, you can launch QEMU with
2753 QEMU (NOTE: you can only do that if you compiled QEMU from the sources):
2754
2755 @example
2756 qemu-i386 -L / qemu-i386 -L / /bin/ls
2757 @end example
2758
2759 @item On non x86 CPUs, you need first to download at least an x86 glibc
2760 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2761 @code{LD_LIBRARY_PATH} is not set:
2762
2763 @example
2764 unset LD_LIBRARY_PATH
2765 @end example
2766
2767 Then you can launch the precompiled @file{ls} x86 executable:
2768
2769 @example
2770 qemu-i386 tests/i386/ls
2771 @end example
2772 You can look at @file{scripts/qemu-binfmt-conf.sh} so that
2773 QEMU is automatically launched by the Linux kernel when you try to
2774 launch x86 executables. It requires the @code{binfmt_misc} module in the
2775 Linux kernel.
2776
2777 @item The x86 version of QEMU is also included. You can try weird things such as:
2778 @example
2779 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2780           /usr/local/qemu-i386/bin/ls-i386
2781 @end example
2782
2783 @end itemize
2784
2785 @node Wine launch
2786 @subsection Wine launch
2787
2788 @itemize
2789
2790 @item Ensure that you have a working QEMU with the x86 glibc
2791 distribution (see previous section). In order to verify it, you must be
2792 able to do:
2793
2794 @example
2795 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2796 @end example
2797
2798 @item Download the binary x86 Wine install
2799 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2800
2801 @item Configure Wine on your account. Look at the provided script
2802 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2803 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2804
2805 @item Then you can try the example @file{putty.exe}:
2806
2807 @example
2808 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2809           /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2810 @end example
2811
2812 @end itemize
2813
2814 @node Command line options
2815 @subsection Command line options
2816
2817 @example
2818 @command{qemu-i386} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-cpu} @var{model}] [@option{-g} @var{port}] [@option{-B} @var{offset}] [@option{-R} @var{size}] @var{program} [@var{arguments}...]
2819 @end example
2820
2821 @table @option
2822 @item -h
2823 Print the help
2824 @item -L path
2825 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2826 @item -s size
2827 Set the x86 stack size in bytes (default=524288)
2828 @item -cpu model
2829 Select CPU model (-cpu help for list and additional feature selection)
2830 @item -E @var{var}=@var{value}
2831 Set environment @var{var} to @var{value}.
2832 @item -U @var{var}
2833 Remove @var{var} from the environment.
2834 @item -B offset
2835 Offset guest address by the specified number of bytes.  This is useful when
2836 the address region required by guest applications is reserved on the host.
2837 This option is currently only supported on some hosts.
2838 @item -R size
2839 Pre-allocate a guest virtual address space of the given size (in bytes).
2840 "G", "M", and "k" suffixes may be used when specifying the size.
2841 @end table
2842
2843 Debug options:
2844
2845 @table @option
2846 @item -d item1,...
2847 Activate logging of the specified items (use '-d help' for a list of log items)
2848 @item -p pagesize
2849 Act as if the host page size was 'pagesize' bytes
2850 @item -g port
2851 Wait gdb connection to port
2852 @item -singlestep
2853 Run the emulation in single step mode.
2854 @end table
2855
2856 Environment variables:
2857
2858 @table @env
2859 @item QEMU_STRACE
2860 Print system calls and arguments similar to the 'strace' program
2861 (NOTE: the actual 'strace' program will not work because the user
2862 space emulator hasn't implemented ptrace).  At the moment this is
2863 incomplete.  All system calls that don't have a specific argument
2864 format are printed with information for six arguments.  Many
2865 flag-style arguments don't have decoders and will show up as numbers.
2866 @end table
2867
2868 @node Other binaries
2869 @subsection Other binaries
2870
2871 @cindex user mode (Alpha)
2872 @command{qemu-alpha} TODO.
2873
2874 @cindex user mode (ARM)
2875 @command{qemu-armeb} TODO.
2876
2877 @cindex user mode (ARM)
2878 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2879 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2880 configurations), and arm-uclinux bFLT format binaries.
2881
2882 @cindex user mode (ColdFire)
2883 @cindex user mode (M68K)
2884 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2885 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2886 coldfire uClinux bFLT format binaries.
2887
2888 The binary format is detected automatically.
2889
2890 @cindex user mode (Cris)
2891 @command{qemu-cris} TODO.
2892
2893 @cindex user mode (i386)
2894 @command{qemu-i386} TODO.
2895 @command{qemu-x86_64} TODO.
2896
2897 @cindex user mode (Microblaze)
2898 @command{qemu-microblaze} TODO.
2899
2900 @cindex user mode (MIPS)
2901 @command{qemu-mips} TODO.
2902 @command{qemu-mipsel} TODO.
2903
2904 @cindex user mode (NiosII)
2905 @command{qemu-nios2} TODO.
2906
2907 @cindex user mode (PowerPC)
2908 @command{qemu-ppc64abi32} TODO.
2909 @command{qemu-ppc64} TODO.
2910 @command{qemu-ppc} TODO.
2911
2912 @cindex user mode (SH4)
2913 @command{qemu-sh4eb} TODO.
2914 @command{qemu-sh4} TODO.
2915
2916 @cindex user mode (SPARC)
2917 @command{qemu-sparc} can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
2918
2919 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2920 (Sparc64 CPU, 32 bit ABI).
2921
2922 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2923 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2924
2925 @node BSD User space emulator
2926 @section BSD User space emulator
2927
2928 @menu
2929 * BSD Status::
2930 * BSD Quick Start::
2931 * BSD Command line options::
2932 @end menu
2933
2934 @node BSD Status
2935 @subsection BSD Status
2936
2937 @itemize @minus
2938 @item
2939 target Sparc64 on Sparc64: Some trivial programs work.
2940 @end itemize
2941
2942 @node BSD Quick Start
2943 @subsection Quick Start
2944
2945 In order to launch a BSD process, QEMU needs the process executable
2946 itself and all the target dynamic libraries used by it.
2947
2948 @itemize
2949
2950 @item On Sparc64, you can just try to launch any process by using the native
2951 libraries:
2952
2953 @example
2954 qemu-sparc64 /bin/ls
2955 @end example
2956
2957 @end itemize
2958
2959 @node BSD Command line options
2960 @subsection Command line options
2961
2962 @example
2963 @command{qemu-sparc64} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-bsd} @var{type}] @var{program} [@var{arguments}...]
2964 @end example
2965
2966 @table @option
2967 @item -h
2968 Print the help
2969 @item -L path
2970 Set the library root path (default=/)
2971 @item -s size
2972 Set the stack size in bytes (default=524288)
2973 @item -ignore-environment
2974 Start with an empty environment. Without this option,
2975 the initial environment is a copy of the caller's environment.
2976 @item -E @var{var}=@var{value}
2977 Set environment @var{var} to @var{value}.
2978 @item -U @var{var}
2979 Remove @var{var} from the environment.
2980 @item -bsd type
2981 Set the type of the emulated BSD Operating system. Valid values are
2982 FreeBSD, NetBSD and OpenBSD (default).
2983 @end table
2984
2985 Debug options:
2986
2987 @table @option
2988 @item -d item1,...
2989 Activate logging of the specified items (use '-d help' for a list of log items)
2990 @item -p pagesize
2991 Act as if the host page size was 'pagesize' bytes
2992 @item -singlestep
2993 Run the emulation in single step mode.
2994 @end table
2995
2996
2997 @include qemu-tech.texi
2998
2999 @node License
3000 @appendix License
3001
3002 QEMU is a trademark of Fabrice Bellard.
3003
3004 QEMU is released under the GNU General Public License (TODO: add link).
3005 Parts of QEMU have specific licenses, see file LICENSE.
3006
3007 TODO (refer to file LICENSE, include it, include the GPL?)
3008
3009 @node Index
3010 @appendix Index
3011 @menu
3012 * Concept Index::
3013 * Function Index::
3014 * Keystroke Index::
3015 * Program Index::
3016 * Data Type Index::
3017 * Variable Index::
3018 @end menu
3019
3020 @node Concept Index
3021 @section Concept Index
3022 This is the main index. Should we combine all keywords in one index? TODO
3023 @printindex cp
3024
3025 @node Function Index
3026 @section Function Index
3027 This index could be used for command line options and monitor functions.
3028 @printindex fn
3029
3030 @node Keystroke Index
3031 @section Keystroke Index
3032
3033 This is a list of all keystrokes which have a special function
3034 in system emulation.
3035
3036 @printindex ky
3037
3038 @node Program Index
3039 @section Program Index
3040 @printindex pg
3041
3042 @node Data Type Index
3043 @section Data Type Index
3044
3045 This index could be used for qdev device names and options.
3046
3047 @printindex tp
3048
3049 @node Variable Index
3050 @section Variable Index
3051 @printindex vr
3052
3053 @bye