1 \input texinfo @c -*- texinfo -*-
3 @setfilename qemu-doc.info
4 @settitle QEMU CPU Emulator User Documentation
12 @center @titlefont{QEMU CPU Emulator}
14 @center @titlefont{User Documentation}
26 * QEMU PC System emulator::
27 * QEMU System emulator for non PC targets::
28 * QEMU Linux User space emulator::
29 * compilation:: Compilation from the sources
40 * intro_features:: Features
46 QEMU is a FAST! processor emulator using dynamic translation to
47 achieve good emulation speed.
49 QEMU has two operating modes:
54 Full system emulation. In this mode, QEMU emulates a full system (for
55 example a PC), including one or several processors and various
56 peripherals. It can be used to launch different Operating Systems
57 without rebooting the PC or to debug system code.
60 User mode emulation (Linux host only). In this mode, QEMU can launch
61 Linux processes compiled for one CPU on another CPU. It can be used to
62 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
63 to ease cross-compilation and cross-debugging.
67 QEMU can run without an host kernel driver and yet gives acceptable
70 For system emulation, the following hardware targets are supported:
72 @item PC (x86 or x86_64 processor)
73 @item ISA PC (old style PC without PCI bus)
74 @item PREP (PowerPC processor)
75 @item G3 BW PowerMac (PowerPC processor)
76 @item Mac99 PowerMac (PowerPC processor, in progress)
77 @item Sun4m (32-bit Sparc processor)
78 @item Sun4u (64-bit Sparc processor, in progress)
79 @item Malta board (32-bit MIPS processor)
80 @item ARM Integrator/CP (ARM926E or 1026E processor)
81 @item ARM Versatile baseboard (ARM926E)
84 For user emulation, x86, PowerPC, ARM, MIPS, and Sparc32/64 CPUs are supported.
89 If you want to compile QEMU yourself, see @ref{compilation}.
92 * install_linux:: Linux
93 * install_windows:: Windows
94 * install_mac:: Macintosh
100 If a precompiled package is available for your distribution - you just
101 have to install it. Otherwise, see @ref{compilation}.
103 @node install_windows
106 Download the experimental binary installer at
107 @url{http://www.free.oszoo.org/@/download.html}.
112 Download the experimental binary installer at
113 @url{http://www.free.oszoo.org/@/download.html}.
115 @node QEMU PC System emulator
116 @chapter QEMU PC System emulator
119 * pcsys_introduction:: Introduction
120 * pcsys_quickstart:: Quick Start
121 * sec_invocation:: Invocation
123 * pcsys_monitor:: QEMU Monitor
124 * disk_images:: Disk Images
125 * pcsys_network:: Network emulation
126 * direct_linux_boot:: Direct Linux Boot
127 * pcsys_usb:: USB emulation
128 * gdb_usage:: GDB usage
129 * pcsys_os_specific:: Target OS specific information
132 @node pcsys_introduction
133 @section Introduction
135 @c man begin DESCRIPTION
137 The QEMU PC System emulator simulates the
138 following peripherals:
142 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
144 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
145 extensions (hardware level, including all non standard modes).
147 PS/2 mouse and keyboard
149 2 PCI IDE interfaces with hard disk and CD-ROM support
153 NE2000 PCI network adapters
157 Creative SoundBlaster 16 sound card
159 ENSONIQ AudioPCI ES1370 sound card
161 Adlib(OPL2) - Yamaha YM3812 compatible chip
163 PCI UHCI USB controller and a virtual USB hub.
166 SMP is supported with up to 255 CPUs.
168 Note that adlib is only available when QEMU was configured with
171 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
174 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
178 @node pcsys_quickstart
181 Download and uncompress the linux image (@file{linux.img}) and type:
187 Linux should boot and give you a prompt.
193 @c man begin SYNOPSIS
194 usage: qemu [options] [disk_image]
199 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
204 Select the emulated machine (@code{-M ?} for list)
208 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
209 use the host floppy by using @file{/dev/fd0} as filename.
215 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
218 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
219 @option{-cdrom} at the same time). You can use the host CD-ROM by
220 using @file{/dev/cdrom} as filename.
223 Boot on floppy (a), hard disk (c) or CD-ROM (d). Hard disk boot is
227 Write to temporary files instead of disk image files. In this case,
228 the raw disk image you use is not written back. You can however force
229 the write back by pressing @key{C-a s} (@pxref{disk_images}).
232 Disable boot signature checking for floppy disks in Bochs BIOS. It may
233 be needed to boot from old floppy disks.
236 Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
239 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
244 Normally, QEMU uses SDL to display the VGA output. With this option,
245 you can totally disable graphical output so that QEMU is a simple
246 command line application. The emulated serial port is redirected on
247 the console. Therefore, you can still use QEMU to debug a Linux kernel
248 with a serial console.
252 Normally, QEMU uses SDL to display the VGA output. With this option,
253 you can have QEMU listen on VNC display d and redirect the VGA display
254 over the VNC session. It is very useful to enable the usb tablet device
255 when using this option (option @option{-usbdevice tablet}).
259 Use keyboard layout @var{language} (for example @code{fr} for
260 French). This option is only needed where it is not easy to get raw PC
261 keycodes (e.g. on Macs or with some X11 servers). You don't need to
262 use it on PC/Linux or PC/Windows hosts.
264 The available layouts are:
266 ar de-ch es fo fr-ca hu ja mk no pt-br sv
267 da en-gb et fr fr-ch is lt nl pl ru th
268 de en-us fi fr-be hr it lv nl-be pt sl tr
271 The default is @code{en-us}.
275 Will show the audio subsystem help: list of drivers, tunable
278 @item -soundhw card1,card2,... or -soundhw all
280 Enable audio and selected sound hardware. Use ? to print all
281 available sound hardware.
284 qemu -soundhw sb16,adlib hda
285 qemu -soundhw es1370 hda
286 qemu -soundhw all hda
291 Set the real time clock to local time (the default is to UTC
292 time). This option is needed to have correct date in MS-DOS or
296 Start in full screen.
299 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
303 Use it when installing Windows 2000 to avoid a disk full bug. After
304 Windows 2000 is installed, you no longer need this option (this option
305 slows down the IDE transfers).
313 Enable the USB driver (will be the default soon)
315 @item -usbdevice devname
316 Add the USB device @var{devname}. @xref{usb_devices}.
323 @item -net nic[,vlan=n][,macaddr=addr][,model=type]
324 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
325 = 0 is the default). The NIC is currently an NE2000 on the PC
326 target. Optionally, the MAC address can be changed. If no
327 @option{-net} option is specified, a single NIC is created.
328 Qemu can emulate several different models of network card. Valid values for
329 @var{type} are @code{ne2k_pci}, @code{ne2k_isa}, @code{rtl8139},
330 @code{smc91c111} and @code{lance}. Not all devices are supported on all
333 @item -net user[,vlan=n][,hostname=name]
334 Use the user mode network stack which requires no administrator
335 priviledge to run. @option{hostname=name} can be used to specify the client
336 hostname reported by the builtin DHCP server.
338 @item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
339 Connect the host TAP network interface @var{name} to VLAN @var{n} and
340 use the network script @var{file} to configure it. The default
341 network script is @file{/etc/qemu-ifup}. If @var{name} is not
342 provided, the OS automatically provides one. @option{fd=h} can be
343 used to specify the handle of an already opened host TAP interface. Example:
346 qemu linux.img -net nic -net tap
349 More complicated example (two NICs, each one connected to a TAP device)
351 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
352 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
356 @item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
358 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
359 machine using a TCP socket connection. If @option{listen} is
360 specified, QEMU waits for incoming connections on @var{port}
361 (@var{host} is optional). @option{connect} is used to connect to
362 another QEMU instance using the @option{listen} option. @option{fd=h}
363 specifies an already opened TCP socket.
367 # launch a first QEMU instance
368 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
369 -net socket,listen=:1234
370 # connect the VLAN 0 of this instance to the VLAN 0
371 # of the first instance
372 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
373 -net socket,connect=127.0.0.1:1234
376 @item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]
378 Create a VLAN @var{n} shared with another QEMU virtual
379 machines using a UDP multicast socket, effectively making a bus for
380 every QEMU with same multicast address @var{maddr} and @var{port}.
384 Several QEMU can be running on different hosts and share same bus (assuming
385 correct multicast setup for these hosts).
387 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
388 @url{http://user-mode-linux.sf.net}.
389 @item Use @option{fd=h} to specify an already opened UDP multicast socket.
394 # launch one QEMU instance
395 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
396 -net socket,mcast=230.0.0.1:1234
397 # launch another QEMU instance on same "bus"
398 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
399 -net socket,mcast=230.0.0.1:1234
400 # launch yet another QEMU instance on same "bus"
401 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
402 -net socket,mcast=230.0.0.1:1234
405 Example (User Mode Linux compat.):
407 # launch QEMU instance (note mcast address selected
409 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
410 -net socket,mcast=239.192.168.1:1102
412 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
416 Indicate that no network devices should be configured. It is used to
417 override the default configuration (@option{-net nic -net user}) which
418 is activated if no @option{-net} options are provided.
421 When using the user mode network stack, activate a built-in TFTP
422 server. All filenames beginning with @var{prefix} can be downloaded
423 from the host to the guest using a TFTP client. The TFTP client on the
424 guest must be configured in binary mode (use the command @code{bin} of
425 the Unix TFTP client). The host IP address on the guest is as usual
429 When using the user mode network stack, activate a built-in SMB
430 server so that Windows OSes can access to the host files in @file{dir}
433 In the guest Windows OS, the line:
437 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
438 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
440 Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
442 Note that a SAMBA server must be installed on the host OS in
443 @file{/usr/sbin/smbd}. QEMU was tested succesfully with smbd version
444 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
446 @item -redir [tcp|udp]:host-port:[guest-host]:guest-port
448 When using the user mode network stack, redirect incoming TCP or UDP
449 connections to the host port @var{host-port} to the guest
450 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
451 is not specified, its value is 10.0.2.15 (default address given by the
452 built-in DHCP server).
454 For example, to redirect host X11 connection from screen 1 to guest
455 screen 0, use the following:
459 qemu -redir tcp:6001::6000 [...]
460 # this host xterm should open in the guest X11 server
464 To redirect telnet connections from host port 5555 to telnet port on
465 the guest, use the following:
469 qemu -redir tcp:5555::23 [...]
470 telnet localhost 5555
473 Then when you use on the host @code{telnet localhost 5555}, you
474 connect to the guest telnet server.
478 Linux boot specific: When using these options, you can use a given
479 Linux kernel without installing it in the disk image. It can be useful
480 for easier testing of various kernels.
484 @item -kernel bzImage
485 Use @var{bzImage} as kernel image.
487 @item -append cmdline
488 Use @var{cmdline} as kernel command line
491 Use @var{file} as initial ram disk.
495 Debug/Expert options:
499 Redirect the virtual serial port to host device @var{dev}. Available
505 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
509 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
510 parameters are set according to the emulated ones.
512 [Linux only, parallel port only] Use host parallel port
513 @var{N}. Currently only SPP parallel port features can be used.
515 Write output to filename. No character can be read.
517 [Unix only] standard input/output
519 [Unix only] name pipe @var{filename}
521 The default device is @code{vc} in graphical mode and @code{stdio} in
524 This option can be used several times to simulate up to 4 serials
528 Redirect the virtual parallel port to host device @var{dev} (same
529 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
530 be used to use hardware devices connected on the corresponding host
533 This option can be used several times to simulate up to 3 parallel
537 Redirect the monitor to host device @var{dev} (same devices as the
539 The default device is @code{vc} in graphical mode and @code{stdio} in
543 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
545 Change gdb connection port.
547 Do not start CPU at startup (you must type 'c' in the monitor).
549 Output log in /tmp/qemu.log
550 @item -hdachs c,h,s,[,t]
551 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
552 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
553 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
554 all thoses parameters. This option is useful for old MS-DOS disk
558 Simulate a standard VGA card with Bochs VBE extensions (default is
559 Cirrus Logic GD5446 PCI VGA)
561 Start right away with a saved state (@code{loadvm} in monitor)
571 During the graphical emulation, you can use the following keys:
577 Switch to virtual console 'n'. Standard console mappings are:
580 Target system display
588 Toggle mouse and keyboard grab.
591 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
592 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
594 During emulation, if you are using the @option{-nographic} option, use
595 @key{Ctrl-a h} to get terminal commands:
603 Save disk data back to file (if -snapshot)
605 Send break (magic sysrq in Linux)
607 Switch between console and monitor
616 The HTML documentation of QEMU for more precise information and Linux
617 user mode emulator invocation.
627 @section QEMU Monitor
629 The QEMU monitor is used to give complex commands to the QEMU
630 emulator. You can use it to:
635 Remove or insert removable medias images
636 (such as CD-ROM or floppies)
639 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
642 @item Inspect the VM state without an external debugger.
648 The following commands are available:
652 @item help or ? [cmd]
653 Show the help for all commands or just for command @var{cmd}.
656 Commit changes to the disk images (if -snapshot is used)
658 @item info subcommand
659 show various information about the system state
663 show the various VLANs and the associated devices
665 show the block devices
667 show the cpu registers
669 show the command line history
671 show emulated PCI device
673 show USB devices plugged on the virtual USB hub
675 show all USB host devices
681 @item eject [-f] device
682 Eject a removable media (use -f to force it).
684 @item change device filename
685 Change a removable media.
687 @item screendump filename
688 Save screen into PPM image @var{filename}.
690 @item log item1[,...]
691 Activate logging of the specified items to @file{/tmp/qemu.log}.
693 @item savevm filename
694 Save the whole virtual machine state to @var{filename}.
696 @item loadvm filename
697 Restore the whole virtual machine state from @var{filename}.
705 @item gdbserver [port]
706 Start gdbserver session (default port=1234)
709 Virtual memory dump starting at @var{addr}.
712 Physical memory dump starting at @var{addr}.
714 @var{fmt} is a format which tells the command how to format the
715 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
719 is the number of items to be dumped.
722 can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
723 c (char) or i (asm instruction).
726 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
727 @code{h} or @code{w} can be specified with the @code{i} format to
728 respectively select 16 or 32 bit code instruction size.
735 Dump 10 instructions at the current instruction pointer:
740 0x90107065: lea 0x0(%esi,1),%esi
741 0x90107069: lea 0x0(%edi,1),%edi
743 0x90107071: jmp 0x90107080
751 Dump 80 16 bit values at the start of the video memory.
753 (qemu) xp/80hx 0xb8000
754 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
755 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
756 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
757 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
758 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
759 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
760 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
761 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
762 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
763 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
767 @item p or print/fmt expr
769 Print expression value. Only the @var{format} part of @var{fmt} is
774 Send @var{keys} to the emulator. Use @code{-} to press several keys
775 simultaneously. Example:
780 This command is useful to send keys that your graphical user interface
781 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
787 @item usb_add devname
789 Add the USB device @var{devname}. For details of available devices see
792 @item usb_del devname
794 Remove the USB device @var{devname} from the QEMU virtual USB
795 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
796 command @code{info usb} to see the devices you can remove.
800 @subsection Integer expressions
802 The monitor understands integers expressions for every integer
803 argument. You can use register names to get the value of specifics
804 CPU registers by prefixing them with @emph{$}.
809 Since version 0.6.1, QEMU supports many disk image formats, including
810 growable disk images (their size increase as non empty sectors are
811 written), compressed and encrypted disk images.
814 * disk_images_quickstart:: Quick start for disk image creation
815 * disk_images_snapshot_mode:: Snapshot mode
816 * qemu_img_invocation:: qemu-img Invocation
817 * disk_images_fat_images:: Virtual FAT disk images
820 @node disk_images_quickstart
821 @subsection Quick start for disk image creation
823 You can create a disk image with the command:
825 qemu-img create myimage.img mysize
827 where @var{myimage.img} is the disk image filename and @var{mysize} is its
828 size in kilobytes. You can add an @code{M} suffix to give the size in
829 megabytes and a @code{G} suffix for gigabytes.
831 See @ref{qemu_img_invocation} for more information.
833 @node disk_images_snapshot_mode
834 @subsection Snapshot mode
836 If you use the option @option{-snapshot}, all disk images are
837 considered as read only. When sectors in written, they are written in
838 a temporary file created in @file{/tmp}. You can however force the
839 write back to the raw disk images by using the @code{commit} monitor
840 command (or @key{C-a s} in the serial console).
842 @node qemu_img_invocation
843 @subsection @code{qemu-img} Invocation
845 @include qemu-img.texi
847 @node disk_images_fat_images
848 @subsection Virtual FAT disk images
850 QEMU can automatically create a virtual FAT disk image from a
851 directory tree. In order to use it, just type:
854 qemu linux.img -hdb fat:/my_directory
857 Then you access access to all the files in the @file{/my_directory}
858 directory without having to copy them in a disk image or to export
859 them via SAMBA or NFS. The default access is @emph{read-only}.
861 Floppies can be emulated with the @code{:floppy:} option:
864 qemu linux.img -fda fat:floppy:/my_directory
867 A read/write support is available for testing (beta stage) with the
871 qemu linux.img -fda fat:floppy:rw:/my_directory
874 What you should @emph{never} do:
876 @item use non-ASCII filenames ;
877 @item use "-snapshot" together with ":rw:" ;
878 @item expect it to work when loadvm'ing ;
879 @item write to the FAT directory on the host system while accessing it with the guest system.
883 @section Network emulation
885 QEMU can simulate several networks cards (NE2000 boards on the PC
886 target) and can connect them to an arbitrary number of Virtual Local
887 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
888 VLAN. VLAN can be connected between separate instances of QEMU to
889 simulate large networks. For simpler usage, a non priviledged user mode
890 network stack can replace the TAP device to have a basic network
895 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
896 connection between several network devices. These devices can be for
897 example QEMU virtual Ethernet cards or virtual Host ethernet devices
900 @subsection Using TAP network interfaces
902 This is the standard way to connect QEMU to a real network. QEMU adds
903 a virtual network device on your host (called @code{tapN}), and you
904 can then configure it as if it was a real ethernet card.
906 As an example, you can download the @file{linux-test-xxx.tar.gz}
907 archive and copy the script @file{qemu-ifup} in @file{/etc} and
908 configure properly @code{sudo} so that the command @code{ifconfig}
909 contained in @file{qemu-ifup} can be executed as root. You must verify
910 that your host kernel supports the TAP network interfaces: the
911 device @file{/dev/net/tun} must be present.
913 See @ref{direct_linux_boot} to have an example of network use with a
914 Linux distribution and @ref{sec_invocation} to have examples of
915 command lines using the TAP network interfaces.
917 @subsection Using the user mode network stack
919 By using the option @option{-net user} (default configuration if no
920 @option{-net} option is specified), QEMU uses a completely user mode
921 network stack (you don't need root priviledge to use the virtual
922 network). The virtual network configuration is the following:
926 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
929 ----> DNS server (10.0.2.3)
931 ----> SMB server (10.0.2.4)
934 The QEMU VM behaves as if it was behind a firewall which blocks all
935 incoming connections. You can use a DHCP client to automatically
936 configure the network in the QEMU VM. The DHCP server assign addresses
937 to the hosts starting from 10.0.2.15.
939 In order to check that the user mode network is working, you can ping
940 the address 10.0.2.2 and verify that you got an address in the range
941 10.0.2.x from the QEMU virtual DHCP server.
943 Note that @code{ping} is not supported reliably to the internet as it
944 would require root priviledges. It means you can only ping the local
947 When using the built-in TFTP server, the router is also the TFTP
950 When using the @option{-redir} option, TCP or UDP connections can be
951 redirected from the host to the guest. It allows for example to
952 redirect X11, telnet or SSH connections.
954 @subsection Connecting VLANs between QEMU instances
956 Using the @option{-net socket} option, it is possible to make VLANs
957 that span several QEMU instances. See @ref{sec_invocation} to have a
960 @node direct_linux_boot
961 @section Direct Linux Boot
963 This section explains how to launch a Linux kernel inside QEMU without
964 having to make a full bootable image. It is very useful for fast Linux
965 kernel testing. The QEMU network configuration is also explained.
969 Download the archive @file{linux-test-xxx.tar.gz} containing a Linux
970 kernel and a disk image.
972 @item Optional: If you want network support (for example to launch X11 examples), you
973 must copy the script @file{qemu-ifup} in @file{/etc} and configure
974 properly @code{sudo} so that the command @code{ifconfig} contained in
975 @file{qemu-ifup} can be executed as root. You must verify that your host
976 kernel supports the TUN/TAP network interfaces: the device
977 @file{/dev/net/tun} must be present.
979 When network is enabled, there is a virtual network connection between
980 the host kernel and the emulated kernel. The emulated kernel is seen
981 from the host kernel at IP address 172.20.0.2 and the host kernel is
982 seen from the emulated kernel at IP address 172.20.0.1.
984 @item Launch @code{qemu.sh}. You should have the following output:
988 Connected to host network interface: tun0
989 Linux version 2.4.21 (bellard@@voyager.localdomain) (gcc version 3.2.2 20030222 @/(Red Hat @/Linux 3.2.2-5)) #5 Tue Nov 11 18:18:53 CET 2003
990 BIOS-provided physical RAM map:
991 BIOS-e801: 0000000000000000 - 000000000009f000 (usable)
992 BIOS-e801: 0000000000100000 - 0000000002000000 (usable)
993 32MB LOWMEM available.
994 On node 0 totalpages: 8192
998 Kernel command line: root=/dev/hda sb=0x220,5,1,5 ide2=noprobe ide3=noprobe ide4=noprobe @/ide5=noprobe console=ttyS0
999 ide_setup: ide2=noprobe
1000 ide_setup: ide3=noprobe
1001 ide_setup: ide4=noprobe
1002 ide_setup: ide5=noprobe
1004 Detected 2399.621 MHz processor.
1005 Console: colour EGA 80x25
1006 Calibrating delay loop... 4744.80 BogoMIPS
1007 Memory: 28872k/32768k available (1210k kernel code, 3508k reserved, 266k data, 64k init, @/0k highmem)
1008 Dentry cache hash table entries: 4096 (order: 3, 32768 bytes)
1009 Inode cache hash table entries: 2048 (order: 2, 16384 bytes)
1010 Mount cache hash table entries: 512 (order: 0, 4096 bytes)
1011 Buffer-cache hash table entries: 1024 (order: 0, 4096 bytes)
1012 Page-cache hash table entries: 8192 (order: 3, 32768 bytes)
1013 CPU: Intel Pentium Pro stepping 03
1014 Checking 'hlt' instruction... OK.
1015 POSIX conformance testing by UNIFIX
1016 Linux NET4.0 for Linux 2.4
1017 Based upon Swansea University Computer Society NET3.039
1018 Initializing RT netlink socket
1019 apm: BIOS not found.
1021 Journalled Block Device driver loaded
1022 Detected PS/2 Mouse Port.
1023 pty: 256 Unix98 ptys configured
1024 Serial driver version 5.05c (2001-07-08) with no serial options enabled
1025 ttyS00 at 0x03f8 (irq = 4) is a 16450
1026 ne.c:v1.10 9/23/94 Donald Becker (becker@@scyld.com)
1027 Last modified Nov 1, 2000 by Paul Gortmaker
1028 NE*000 ethercard probe at 0x300: 52 54 00 12 34 56
1029 eth0: NE2000 found at 0x300, using IRQ 9.
1030 RAMDISK driver initialized: 16 RAM disks of 4096K size 1024 blocksize
1031 Uniform Multi-Platform E-IDE driver Revision: 7.00beta4-2.4
1032 ide: Assuming 50MHz system bus speed for PIO modes; override with idebus=xx
1033 hda: QEMU HARDDISK, ATA DISK drive
1034 ide0 at 0x1f0-0x1f7,0x3f6 on irq 14
1035 hda: attached ide-disk driver.
1036 hda: 20480 sectors (10 MB) w/256KiB Cache, CHS=20/16/63
1039 Soundblaster audio driver Copyright (C) by Hannu Savolainen 1993-1996
1040 NET4: Linux TCP/IP 1.0 for NET4.0
1041 IP Protocols: ICMP, UDP, TCP, IGMP
1042 IP: routing cache hash table of 512 buckets, 4Kbytes
1043 TCP: Hash tables configured (established 2048 bind 4096)
1044 NET4: Unix domain sockets 1.0/SMP for Linux NET4.0.
1045 EXT2-fs warning: mounting unchecked fs, running e2fsck is recommended
1046 VFS: Mounted root (ext2 filesystem).
1047 Freeing unused kernel memory: 64k freed
1049 Linux version 2.4.21 (bellard@@voyager.localdomain) (gcc version 3.2.2 20030222 @/(Red Hat @/Linux 3.2.2-5)) #5 Tue Nov 11 18:18:53 CET 2003
1051 QEMU Linux test distribution (based on Redhat 9)
1053 Type 'exit' to halt the system
1059 Then you can play with the kernel inside the virtual serial console. You
1060 can launch @code{ls} for example. Type @key{Ctrl-a h} to have an help
1061 about the keys you can type inside the virtual serial console. In
1062 particular, use @key{Ctrl-a x} to exit QEMU and use @key{Ctrl-a b} as
1063 the Magic SysRq key.
1066 If the network is enabled, launch the script @file{/etc/linuxrc} in the
1067 emulator (don't forget the leading dot):
1072 Then enable X11 connections on your PC from the emulated Linux:
1077 You can now launch @file{xterm} or @file{xlogo} and verify that you have
1078 a real Virtual Linux system !
1085 A 2.5.74 kernel is also included in the archive. Just
1086 replace the bzImage in qemu.sh to try it.
1089 In order to exit cleanly from qemu, you can do a @emph{shutdown} inside
1090 qemu. qemu will automatically exit when the Linux shutdown is done.
1093 You can boot slightly faster by disabling the probe of non present IDE
1094 interfaces. To do so, add the following options on the kernel command
1097 ide1=noprobe ide2=noprobe ide3=noprobe ide4=noprobe ide5=noprobe
1101 The example disk image is a modified version of the one made by Kevin
1102 Lawton for the plex86 Project (@url{www.plex86.org}).
1107 @section USB emulation
1109 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1110 virtual USB devices or real host USB devices (experimental, works only
1111 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1112 as neccessary to connect multiple USB devices.
1116 * host_usb_devices::
1119 @subsection Connecting USB devices
1121 USB devices can be connected with the @option{-usbdevice} commandline option
1122 or the @code{usb_add} monitor command. Available devices are:
1126 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1128 Pointer device that uses abolsute coordinates (like a touchscreen).
1129 This means qemu is able to report the mouse position without having
1130 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1131 @item @code{disk:file}
1132 Mass storage device based on @var{file} (@pxref{disk_images})
1133 @item @code{host:bus.addr}
1134 Pass through the host device identified by @var{bus.addr}
1136 @item @code{host:vendor_id:product_id}
1137 Pass through the host device identified by @var{vendor_id:product_id}
1141 @node host_usb_devices
1142 @subsection Using host USB devices on a Linux host
1144 WARNING: this is an experimental feature. QEMU will slow down when
1145 using it. USB devices requiring real time streaming (i.e. USB Video
1146 Cameras) are not supported yet.
1149 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1150 is actually using the USB device. A simple way to do that is simply to
1151 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1152 to @file{mydriver.o.disabled}.
1154 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1160 @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:
1162 chown -R myuid /proc/bus/usb
1165 @item Launch QEMU and do in the monitor:
1168 Device 1.2, speed 480 Mb/s
1169 Class 00: USB device 1234:5678, USB DISK
1171 You should see the list of the devices you can use (Never try to use
1172 hubs, it won't work).
1174 @item Add the device in QEMU by using:
1176 usb_add host:1234:5678
1179 Normally the guest OS should report that a new USB device is
1180 plugged. You can use the option @option{-usbdevice} to do the same.
1182 @item Now you can try to use the host USB device in QEMU.
1186 When relaunching QEMU, you may have to unplug and plug again the USB
1187 device to make it work again (this is a bug).
1192 QEMU has a primitive support to work with gdb, so that you can do
1193 'Ctrl-C' while the virtual machine is running and inspect its state.
1195 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1198 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1199 -append "root=/dev/hda"
1200 Connected to host network interface: tun0
1201 Waiting gdb connection on port 1234
1204 Then launch gdb on the 'vmlinux' executable:
1209 In gdb, connect to QEMU:
1211 (gdb) target remote localhost:1234
1214 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1219 Here are some useful tips in order to use gdb on system code:
1223 Use @code{info reg} to display all the CPU registers.
1225 Use @code{x/10i $eip} to display the code at the PC position.
1227 Use @code{set architecture i8086} to dump 16 bit code. Then use
1228 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1231 @node pcsys_os_specific
1232 @section Target OS specific information
1236 To have access to SVGA graphic modes under X11, use the @code{vesa} or
1237 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1238 color depth in the guest and the host OS.
1240 When using a 2.6 guest Linux kernel, you should add the option
1241 @code{clock=pit} on the kernel command line because the 2.6 Linux
1242 kernels make very strict real time clock checks by default that QEMU
1243 cannot simulate exactly.
1245 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1246 not activated because QEMU is slower with this patch. The QEMU
1247 Accelerator Module is also much slower in this case. Earlier Fedora
1248 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
1249 patch by default. Newer kernels don't have it.
1253 If you have a slow host, using Windows 95 is better as it gives the
1254 best speed. Windows 2000 is also a good choice.
1256 @subsubsection SVGA graphic modes support
1258 QEMU emulates a Cirrus Logic GD5446 Video
1259 card. All Windows versions starting from Windows 95 should recognize
1260 and use this graphic card. For optimal performances, use 16 bit color
1261 depth in the guest and the host OS.
1263 @subsubsection CPU usage reduction
1265 Windows 9x does not correctly use the CPU HLT
1266 instruction. The result is that it takes host CPU cycles even when
1267 idle. You can install the utility from
1268 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1269 problem. Note that no such tool is needed for NT, 2000 or XP.
1271 @subsubsection Windows 2000 disk full problem
1273 Windows 2000 has a bug which gives a disk full problem during its
1274 installation. When installing it, use the @option{-win2k-hack} QEMU
1275 option to enable a specific workaround. After Windows 2000 is
1276 installed, you no longer need this option (this option slows down the
1279 @subsubsection Windows 2000 shutdown
1281 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1282 can. It comes from the fact that Windows 2000 does not automatically
1283 use the APM driver provided by the BIOS.
1285 In order to correct that, do the following (thanks to Struan
1286 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1287 Add/Troubleshoot a device => Add a new device & Next => No, select the
1288 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1289 (again) a few times. Now the driver is installed and Windows 2000 now
1290 correctly instructs QEMU to shutdown at the appropriate moment.
1292 @subsubsection Share a directory between Unix and Windows
1294 See @ref{sec_invocation} about the help of the option @option{-smb}.
1296 @subsubsection Windows XP security problems
1298 Some releases of Windows XP install correctly but give a security
1301 A problem is preventing Windows from accurately checking the
1302 license for this computer. Error code: 0x800703e6.
1304 The only known workaround is to boot in Safe mode
1305 without networking support.
1307 Future QEMU releases are likely to correct this bug.
1309 @subsection MS-DOS and FreeDOS
1311 @subsubsection CPU usage reduction
1313 DOS does not correctly use the CPU HLT instruction. The result is that
1314 it takes host CPU cycles even when idle. You can install the utility
1315 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1318 @node QEMU System emulator for non PC targets
1319 @chapter QEMU System emulator for non PC targets
1321 QEMU is a generic emulator and it emulates many non PC
1322 machines. Most of the options are similar to the PC emulator. The
1323 differences are mentionned in the following sections.
1326 * QEMU PowerPC System emulator::
1327 * Sparc32 System emulator invocation::
1328 * Sparc64 System emulator invocation::
1329 * MIPS System emulator invocation::
1330 * ARM System emulator invocation::
1333 @node QEMU PowerPC System emulator
1334 @section QEMU PowerPC System emulator
1336 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1337 or PowerMac PowerPC system.
1339 QEMU emulates the following PowerMac peripherals:
1345 PCI VGA compatible card with VESA Bochs Extensions
1347 2 PMAC IDE interfaces with hard disk and CD-ROM support
1353 VIA-CUDA with ADB keyboard and mouse.
1356 QEMU emulates the following PREP peripherals:
1362 PCI VGA compatible card with VESA Bochs Extensions
1364 2 IDE interfaces with hard disk and CD-ROM support
1368 NE2000 network adapters
1372 PREP Non Volatile RAM
1374 PC compatible keyboard and mouse.
1377 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1378 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1380 @c man begin OPTIONS
1382 The following options are specific to the PowerPC emulation:
1386 @item -g WxH[xDEPTH]
1388 Set the initial VGA graphic mode. The default is 800x600x15.
1395 More information is available at
1396 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1398 @node Sparc32 System emulator invocation
1399 @section Sparc32 System emulator invocation
1401 Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
1402 (sun4m architecture). The emulation is somewhat complete.
1404 QEMU emulates the following sun4m peripherals:
1412 Lance (Am7990) Ethernet
1414 Non Volatile RAM M48T08
1416 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1417 and power/reset logic
1419 ESP SCSI controller with hard disk and CD-ROM support
1424 The number of peripherals is fixed in the architecture.
1426 Since version 0.8.2, QEMU uses OpenBIOS
1427 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1428 firmware implementation. The goal is to implement a 100% IEEE
1429 1275-1994 (referred to as Open Firmware) compliant firmware.
1431 A sample Linux 2.6 series kernel and ram disk image are available on
1432 the QEMU web site. Please note that currently NetBSD, OpenBSD or
1433 Solaris kernels don't work.
1435 @c man begin OPTIONS
1437 The following options are specific to the Sparc emulation:
1443 Set the initial TCX graphic mode. The default is 1024x768.
1449 @node Sparc64 System emulator invocation
1450 @section Sparc64 System emulator invocation
1452 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
1453 The emulator is not usable for anything yet.
1455 QEMU emulates the following sun4u peripherals:
1459 UltraSparc IIi APB PCI Bridge
1461 PCI VGA compatible card with VESA Bochs Extensions
1463 Non Volatile RAM M48T59
1465 PC-compatible serial ports
1468 @node MIPS System emulator invocation
1469 @section MIPS System emulator invocation
1471 Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
1472 The emulator is able to boot a Linux kernel and to run a Linux Debian
1473 installation from NFS. The following devices are emulated:
1479 PC style serial port
1484 More information is available in the QEMU mailing-list archive.
1486 @node ARM System emulator invocation
1487 @section ARM System emulator invocation
1489 Use the executable @file{qemu-system-arm} to simulate a ARM
1490 machine. The ARM Integrator/CP board is emulated with the following
1495 ARM926E or ARM1026E CPU
1499 SMC 91c111 Ethernet adapter
1501 PL110 LCD controller
1503 PL050 KMI with PS/2 keyboard and mouse.
1506 The ARM Versatile baseboard is emulated with the following devices:
1512 PL190 Vectored Interrupt Controller
1516 SMC 91c111 Ethernet adapter
1518 PL110 LCD controller
1520 PL050 KMI with PS/2 keyboard and mouse.
1522 PCI host bridge. Note the emulated PCI bridge only provides access to
1523 PCI memory space. It does not provide access to PCI IO space.
1524 This means some devices (eg. ne2k_pci NIC) are not useable, and others
1525 (eg. rtl8139 NIC) are only useable when the guest drivers use the memory
1526 mapped control registers.
1528 PCI OHCI USB controller.
1530 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1533 A Linux 2.6 test image is available on the QEMU web site. More
1534 information is available in the QEMU mailing-list archive.
1536 @node QEMU Linux User space emulator
1537 @chapter QEMU Linux User space emulator
1542 * Command line options::
1547 @section Quick Start
1549 In order to launch a Linux process, QEMU needs the process executable
1550 itself and all the target (x86) dynamic libraries used by it.
1554 @item On x86, you can just try to launch any process by using the native
1558 qemu-i386 -L / /bin/ls
1561 @code{-L /} tells that the x86 dynamic linker must be searched with a
1564 @item Since QEMU is also a linux process, you can launch qemu with qemu (NOTE: you can only do that if you compiled QEMU from the sources):
1567 qemu-i386 -L / qemu-i386 -L / /bin/ls
1570 @item On non x86 CPUs, you need first to download at least an x86 glibc
1571 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1572 @code{LD_LIBRARY_PATH} is not set:
1575 unset LD_LIBRARY_PATH
1578 Then you can launch the precompiled @file{ls} x86 executable:
1581 qemu-i386 tests/i386/ls
1583 You can look at @file{qemu-binfmt-conf.sh} so that
1584 QEMU is automatically launched by the Linux kernel when you try to
1585 launch x86 executables. It requires the @code{binfmt_misc} module in the
1588 @item The x86 version of QEMU is also included. You can try weird things such as:
1590 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
1591 /usr/local/qemu-i386/bin/ls-i386
1597 @section Wine launch
1601 @item Ensure that you have a working QEMU with the x86 glibc
1602 distribution (see previous section). In order to verify it, you must be
1606 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1609 @item Download the binary x86 Wine install
1610 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
1612 @item Configure Wine on your account. Look at the provided script
1613 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
1614 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1616 @item Then you can try the example @file{putty.exe}:
1619 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
1620 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1625 @node Command line options
1626 @section Command line options
1629 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1636 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1638 Set the x86 stack size in bytes (default=524288)
1645 Activate log (logfile=/tmp/qemu.log)
1647 Act as if the host page size was 'pagesize' bytes
1650 @node Other binaries
1651 @section Other binaries
1653 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
1654 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
1655 configurations), and arm-uclinux bFLT format binaries.
1657 The binary format is detected automatically.
1660 @chapter Compilation from the sources
1665 * Cross compilation for Windows with Linux::
1672 @subsection Compilation
1674 First you must decompress the sources:
1677 tar zxvf qemu-x.y.z.tar.gz
1681 Then you configure QEMU and build it (usually no options are needed):
1687 Then type as root user:
1691 to install QEMU in @file{/usr/local}.
1693 @subsection Tested tool versions
1695 In order to compile QEMU succesfully, it is very important that you
1696 have the right tools. The most important one is gcc. I cannot guaranty
1697 that QEMU works if you do not use a tested gcc version. Look at
1698 'configure' and 'Makefile' if you want to make a different gcc
1702 host gcc binutils glibc linux distribution
1703 ----------------------------------------------------------------------
1704 x86 3.2 2.13.2 2.1.3 2.4.18
1705 2.96 2.11.93.0.2 2.2.5 2.4.18 Red Hat 7.3
1706 3.2.2 2.13.90.0.18 2.3.2 2.4.20 Red Hat 9
1708 PowerPC 3.3 [4] 2.13.90.0.18 2.3.1 2.4.20briq
1711 Alpha 3.3 [1] 2.14.90.0.4 2.2.5 2.2.20 [2] Debian 3.0
1713 Sparc32 2.95.4 2.12.90.0.1 2.2.5 2.4.18 Debian 3.0
1715 ARM 2.95.4 2.12.90.0.1 2.2.5 2.4.9 [3] Debian 3.0
1717 [1] On Alpha, QEMU needs the gcc 'visibility' attribute only available
1718 for gcc version >= 3.3.
1719 [2] Linux >= 2.4.20 is necessary for precise exception support
1721 [3] 2.4.9-ac10-rmk2-np1-cerf2
1723 [4] gcc 2.95.x generates invalid code when using too many register
1724 variables. You must use gcc 3.x on PowerPC.
1731 @item Install the current versions of MSYS and MinGW from
1732 @url{http://www.mingw.org/}. You can find detailed installation
1733 instructions in the download section and the FAQ.
1736 the MinGW development library of SDL 1.2.x
1737 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
1738 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
1739 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1740 directory. Edit the @file{sdl-config} script so that it gives the
1741 correct SDL directory when invoked.
1743 @item Extract the current version of QEMU.
1745 @item Start the MSYS shell (file @file{msys.bat}).
1747 @item Change to the QEMU directory. Launch @file{./configure} and
1748 @file{make}. If you have problems using SDL, verify that
1749 @file{sdl-config} can be launched from the MSYS command line.
1751 @item You can install QEMU in @file{Program Files/Qemu} by typing
1752 @file{make install}. Don't forget to copy @file{SDL.dll} in
1753 @file{Program Files/Qemu}.
1757 @node Cross compilation for Windows with Linux
1758 @section Cross compilation for Windows with Linux
1762 Install the MinGW cross compilation tools available at
1763 @url{http://www.mingw.org/}.
1766 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1767 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1768 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1769 the QEMU configuration script.
1772 Configure QEMU for Windows cross compilation:
1774 ./configure --enable-mingw32
1776 If necessary, you can change the cross-prefix according to the prefix
1777 choosen for the MinGW tools with --cross-prefix. You can also use
1778 --prefix to set the Win32 install path.
1780 @item You can install QEMU in the installation directory by typing
1781 @file{make install}. Don't forget to copy @file{SDL.dll} in the
1782 installation directory.
1786 Note: Currently, Wine does not seem able to launch
1792 The Mac OS X patches are not fully merged in QEMU, so you should look
1793 at the QEMU mailing list archive to have all the necessary