13c95fdefSPeter MaydellHXCOMM Use DEFHEADING() to define headings in both help text and rST. 23c95fdefSPeter MaydellHXCOMM Text between SRST and ERST is copied to the rST version and 33c95fdefSPeter MaydellHXCOMM discarded from C version. 4ad96090aSBlue SwirlHXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5ad96090aSBlue SwirlHXCOMM construct option structures, enums and help message for specified 6ad96090aSBlue SwirlHXCOMM architectures. 73c95fdefSPeter MaydellHXCOMM HXCOMM can be used for comments, discarded from both rST and C. 85824d651Sblueswir1 9de6b4f90SMarkus ArmbrusterDEFHEADING(Standard options:) 105824d651Sblueswir1 115824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 12ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 13e2fcbf42SPeter MaydellSRST 14e2fcbf42SPeter Maydell``-h`` 15e2fcbf42SPeter Maydell Display help and exit 16e2fcbf42SPeter MaydellERST 175824d651Sblueswir1 189bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 19ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 20e2fcbf42SPeter MaydellSRST 21e2fcbf42SPeter Maydell``-version`` 22e2fcbf42SPeter Maydell Display version information and exit 23e2fcbf42SPeter MaydellERST 249bd7e6d9Spbrook 2580f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 2680f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 27585f6036SPeter Maydell " selects emulated machine ('-machine help' for list)\n" 2880f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 29d661d9a4SJustin Terry (VM) " supported accelerators are kvm, xen, hax, hvf, whpx or tcg (default: tcg)\n" 30d1048befSDon Slutz " vmport=on|off|auto controls emulation of vmport (default: auto)\n" 318490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 32a52a7fdfSLe Tan " mem-merge=on|off controls memory merge support (default: on)\n" 332eb1cd07STony Krowiak " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n" 349850c604SAlexander Graf " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n" 3587252e1bSXiao Guangrong " suppress-vmdesc=on|off disables self-describing migration (default=off)\n" 36902c053dSGreg Kurz " nvdimm=on|off controls NVDIMM support (default=off)\n" 37244b3f44STao Xu " memory-encryption=@var{} memory encryption object to use (default=none)\n" 388db0b204SIgor Mammedov " hmat=on|off controls ACPI HMAT support (default=off)\n" 398db0b204SIgor Mammedov " memory-backend='backend-id' specifies explicitly provided backend for main RAM (default=none)\n", 4080f52a66SJan Kiszka QEMU_ARCH_ALL) 41e2fcbf42SPeter MaydellSRST 42e2fcbf42SPeter Maydell``-machine [type=]name[,prop=value[,...]]`` 43e2fcbf42SPeter Maydell Select the emulated machine by name. Use ``-machine help`` to list 44e2fcbf42SPeter Maydell available machines. 45e2fcbf42SPeter Maydell 46e2fcbf42SPeter Maydell For architectures which aim to support live migration compatibility 47e2fcbf42SPeter Maydell across releases, each release will introduce a new versioned machine 48e2fcbf42SPeter Maydell type. For example, the 2.8.0 release introduced machine types 49e2fcbf42SPeter Maydell "pc-i440fx-2.8" and "pc-q35-2.8" for the x86\_64/i686 architectures. 50e2fcbf42SPeter Maydell 51e2fcbf42SPeter Maydell To allow live migration of guests from QEMU version 2.8.0, to QEMU 52e2fcbf42SPeter Maydell version 2.9.0, the 2.9.0 version must support the "pc-i440fx-2.8" 53e2fcbf42SPeter Maydell and "pc-q35-2.8" machines too. To allow users live migrating VMs to 54e2fcbf42SPeter Maydell skip multiple intermediate releases when upgrading, new releases of 55e2fcbf42SPeter Maydell QEMU will support machine types from many previous versions. 56e2fcbf42SPeter Maydell 57e2fcbf42SPeter Maydell Supported machine properties are: 58e2fcbf42SPeter Maydell 59e2fcbf42SPeter Maydell ``accel=accels1[:accels2[:...]]`` 60e2fcbf42SPeter Maydell This is used to enable an accelerator. Depending on the target 61e2fcbf42SPeter Maydell architecture, kvm, xen, hax, hvf, whpx or tcg can be available. 62e2fcbf42SPeter Maydell By default, tcg is used. If there is more than one accelerator 63e2fcbf42SPeter Maydell specified, the next one is used if the previous one fails to 64e2fcbf42SPeter Maydell initialize. 65e2fcbf42SPeter Maydell 66e2fcbf42SPeter Maydell ``vmport=on|off|auto`` 67e2fcbf42SPeter Maydell Enables emulation of VMWare IO port, for vmmouse etc. auto says 68e2fcbf42SPeter Maydell to select the value based on accel. For accel=xen the default is 69e2fcbf42SPeter Maydell off otherwise the default is on. 70e2fcbf42SPeter Maydell 71e2fcbf42SPeter Maydell ``dump-guest-core=on|off`` 72e2fcbf42SPeter Maydell Include guest memory in a core dump. The default is on. 73e2fcbf42SPeter Maydell 74e2fcbf42SPeter Maydell ``mem-merge=on|off`` 75e2fcbf42SPeter Maydell Enables or disables memory merge support. This feature, when 76e2fcbf42SPeter Maydell supported by the host, de-duplicates identical memory pages 77e2fcbf42SPeter Maydell among VMs instances (enabled by default). 78e2fcbf42SPeter Maydell 79e2fcbf42SPeter Maydell ``aes-key-wrap=on|off`` 80e2fcbf42SPeter Maydell Enables or disables AES key wrapping support on s390-ccw hosts. 81e2fcbf42SPeter Maydell This feature controls whether AES wrapping keys will be created 82e2fcbf42SPeter Maydell to allow execution of AES cryptographic functions. The default 83e2fcbf42SPeter Maydell is on. 84e2fcbf42SPeter Maydell 85e2fcbf42SPeter Maydell ``dea-key-wrap=on|off`` 86e2fcbf42SPeter Maydell Enables or disables DEA key wrapping support on s390-ccw hosts. 87e2fcbf42SPeter Maydell This feature controls whether DEA wrapping keys will be created 88e2fcbf42SPeter Maydell to allow execution of DEA cryptographic functions. The default 89e2fcbf42SPeter Maydell is on. 90e2fcbf42SPeter Maydell 91e2fcbf42SPeter Maydell ``nvdimm=on|off`` 92e2fcbf42SPeter Maydell Enables or disables NVDIMM support. The default is off. 93e2fcbf42SPeter Maydell 94e2fcbf42SPeter Maydell ``memory-encryption=`` 95e2fcbf42SPeter Maydell Memory encryption object to use. The default is none. 96e2fcbf42SPeter Maydell 97e2fcbf42SPeter Maydell ``hmat=on|off`` 98e2fcbf42SPeter Maydell Enables or disables ACPI Heterogeneous Memory Attribute Table 99e2fcbf42SPeter Maydell (HMAT) support. The default is off. 1008db0b204SIgor Mammedov 1018db0b204SIgor Mammedov ``memory-backend='id'`` 1028db0b204SIgor Mammedov An alternative to legacy ``-mem-path`` and ``mem-prealloc`` options. 1038db0b204SIgor Mammedov Allows to use a memory backend as main RAM. 1048db0b204SIgor Mammedov 1058db0b204SIgor Mammedov For example: 1068db0b204SIgor Mammedov :: 1078db0b204SIgor Mammedov -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on 1088db0b204SIgor Mammedov -machine memory-backend=pc.ram 1098db0b204SIgor Mammedov -m 512M 1108db0b204SIgor Mammedov 1118db0b204SIgor Mammedov Migration compatibility note: 1128db0b204SIgor Mammedov a) as backend id one shall use value of 'default-ram-id', advertised by 1138db0b204SIgor Mammedov machine type (available via ``query-machines`` QMP command), if migration 1148db0b204SIgor Mammedov to/from old QEMU (<5.0) is expected. 1158db0b204SIgor Mammedov b) for machine types 4.0 and older, user shall 1168db0b204SIgor Mammedov use ``x-use-canonical-path-for-ramblock-id=off`` backend option 1178db0b204SIgor Mammedov if migration to/from old QEMU (<5.0) is expected. 1188db0b204SIgor Mammedov For example: 1198db0b204SIgor Mammedov :: 1208db0b204SIgor Mammedov -object memory-backend-ram,id=pc.ram,size=512M,x-use-canonical-path-for-ramblock-id=off 1218db0b204SIgor Mammedov -machine memory-backend=pc.ram 1228db0b204SIgor Mammedov -m 512M 123e2fcbf42SPeter MaydellERST 1245824d651Sblueswir1 12580f52a66SJan KiszkaHXCOMM Deprecated by -machine 12680f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 12780f52a66SJan Kiszka 1285824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 129585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 130e2fcbf42SPeter MaydellSRST 131e2fcbf42SPeter Maydell``-cpu model`` 132e2fcbf42SPeter Maydell Select CPU model (``-cpu help`` for list and additional feature 133e2fcbf42SPeter Maydell selection) 134e2fcbf42SPeter MaydellERST 1355824d651Sblueswir1 1368d4e9146SKONRAD FredericDEF("accel", HAS_ARG, QEMU_OPTION_accel, 137fe174132SPaolo Bonzini "-accel [accel=]accelerator[,prop[=value][,...]]\n" 138d661d9a4SJustin Terry (VM) " select accelerator (kvm, xen, hax, hvf, whpx or tcg; use 'help' for a list)\n" 13946472d82SPaolo Bonzini " igd-passthru=on|off (enable Xen integrated Intel graphics passthrough, default=off)\n" 14011bc4a13SPaolo Bonzini " kernel-irqchip=on|off|split controls accelerated irqchip support (default=on)\n" 14123b0898eSPaolo Bonzini " kvm-shadow-mem=size of KVM shadow MMU in bytes\n" 142a35b3e14SRichard Henderson " split-wx=on|off (enable TCG split w^x mapping)\n" 143fe174132SPaolo Bonzini " tb-size=n (TCG translation block cache size)\n" 1440b3c5c81SEduardo Habkost " thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL) 145e2fcbf42SPeter MaydellSRST 146e2fcbf42SPeter Maydell``-accel name[,prop=value[,...]]`` 147e2fcbf42SPeter Maydell This is used to enable an accelerator. Depending on the target 148e2fcbf42SPeter Maydell architecture, kvm, xen, hax, hvf, whpx or tcg can be available. By 149e2fcbf42SPeter Maydell default, tcg is used. If there is more than one accelerator 150e2fcbf42SPeter Maydell specified, the next one is used if the previous one fails to 151e2fcbf42SPeter Maydell initialize. 152e2fcbf42SPeter Maydell 153e2fcbf42SPeter Maydell ``igd-passthru=on|off`` 154e2fcbf42SPeter Maydell When Xen is in use, this option controls whether Intel 155e2fcbf42SPeter Maydell integrated graphics devices can be passed through to the guest 156e2fcbf42SPeter Maydell (default=off) 157e2fcbf42SPeter Maydell 158e2fcbf42SPeter Maydell ``kernel-irqchip=on|off|split`` 159e2fcbf42SPeter Maydell Controls KVM in-kernel irqchip support. The default is full 160e2fcbf42SPeter Maydell acceleration of the interrupt controllers. On x86, split irqchip 161e2fcbf42SPeter Maydell reduces the kernel attack surface, at a performance cost for 162e2fcbf42SPeter Maydell non-MSI interrupts. Disabling the in-kernel irqchip completely 163e2fcbf42SPeter Maydell is not recommended except for debugging purposes. 164e2fcbf42SPeter Maydell 165e2fcbf42SPeter Maydell ``kvm-shadow-mem=size`` 166e2fcbf42SPeter Maydell Defines the size of the KVM shadow MMU. 167e2fcbf42SPeter Maydell 168a35b3e14SRichard Henderson ``split-wx=on|off`` 169a35b3e14SRichard Henderson Controls the use of split w^x mapping for the TCG code generation 170a35b3e14SRichard Henderson buffer. Some operating systems require this to be enabled, and in 171a35b3e14SRichard Henderson such a case this will default on. On other operating systems, this 172a35b3e14SRichard Henderson will default off, but one may enable this for testing or debugging. 173a35b3e14SRichard Henderson 174e2fcbf42SPeter Maydell ``tb-size=n`` 175e2fcbf42SPeter Maydell Controls the size (in MiB) of the TCG translation block cache. 176e2fcbf42SPeter Maydell 177e2fcbf42SPeter Maydell ``thread=single|multi`` 178e2fcbf42SPeter Maydell Controls number of TCG threads. When the TCG is multi-threaded 179cba42d61SMichael Tokarev there will be one thread per vCPU therefore taking advantage of 180e2fcbf42SPeter Maydell additional host cores. The default is to enable multi-threading 181e2fcbf42SPeter Maydell where both the back-end and front-ends support it and no 182e2fcbf42SPeter Maydell incompatible TCG features have been enabled (e.g. 183e2fcbf42SPeter Maydell icount/replay). 184e2fcbf42SPeter MaydellERST 1858d4e9146SKONRAD Frederic 1865824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 1871b458422SLike Xu "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,dies=dies][,sockets=sockets]\n" 1886be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 1896be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 190ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 1911b458422SLike Xu " cores= number of CPU cores on one socket (for PC, it's on one die)\n" 19258a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 1931b458422SLike Xu " dies= number of CPU dies on one socket (for PC only)\n" 194ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 195ad96090aSBlue Swirl QEMU_ARCH_ALL) 196e2fcbf42SPeter MaydellSRST 197e2fcbf42SPeter Maydell``-smp [cpus=]n[,cores=cores][,threads=threads][,dies=dies][,sockets=sockets][,maxcpus=maxcpus]`` 198e2fcbf42SPeter Maydell Simulate an SMP system with n CPUs. On the PC target, up to 255 CPUs 199e2fcbf42SPeter Maydell are supported. On Sparc32 target, Linux limits the number of usable 200e2fcbf42SPeter Maydell CPUs to 4. For the PC target, the number of cores per die, the 201e2fcbf42SPeter Maydell number of threads per cores, the number of dies per packages and the 202e2fcbf42SPeter Maydell total number of sockets can be specified. Missing values will be 203e2fcbf42SPeter Maydell computed. If any on the three values is given, the total number of 204e2fcbf42SPeter Maydell CPUs n can be omitted. maxcpus specifies the maximum number of 205e2fcbf42SPeter Maydell hotpluggable CPUs. 206e2fcbf42SPeter MaydellERST 2075824d651Sblueswir1 208268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 209244b3f44STao Xu "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 210244b3f44STao Xu "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 2112d19c656SIgor Mammedov "-numa dist,src=source,dst=destination,val=distance\n" 2129b12dfa0SLiu Jingqi "-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]\n" 213c412a48dSLiu Jingqi "-numa hmat-lb,initiator=node,target=node,hierarchy=memory|first-level|second-level|third-level,data-type=access-latency|read-latency|write-latency[,latency=lat][,bandwidth=bw]\n" 214c412a48dSLiu Jingqi "-numa hmat-cache,node-id=node,size=size,level=level[,associativity=none|direct|complex][,policy=none|write-back|write-through][,line=size]\n", 2152d19c656SIgor Mammedov QEMU_ARCH_ALL) 216e2fcbf42SPeter MaydellSRST 21709ce5f2dSPeter Maydell``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 21809ce5f2dSPeter Maydell \ 21909ce5f2dSPeter Maydell``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 22009ce5f2dSPeter Maydell \ 22109ce5f2dSPeter Maydell``-numa dist,src=source,dst=destination,val=distance`` 22209ce5f2dSPeter Maydell \ 22309ce5f2dSPeter Maydell``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]`` 22409ce5f2dSPeter Maydell \ 22509ce5f2dSPeter Maydell``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]`` 22609ce5f2dSPeter Maydell \ 22709ce5f2dSPeter Maydell``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]`` 228e2fcbf42SPeter Maydell Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA 229e2fcbf42SPeter Maydell distance from a source node to a destination node. Set the ACPI 230e2fcbf42SPeter Maydell Heterogeneous Memory Attributes for the given nodes. 231e2fcbf42SPeter Maydell 232e2fcbf42SPeter Maydell Legacy VCPU assignment uses '\ ``cpus``\ ' option where firstcpu and 233e2fcbf42SPeter Maydell lastcpu are CPU indexes. Each '\ ``cpus``\ ' option represent a 234e2fcbf42SPeter Maydell contiguous range of CPU indexes (or a single VCPU if lastcpu is 235e2fcbf42SPeter Maydell omitted). A non-contiguous set of VCPUs can be represented by 236e2fcbf42SPeter Maydell providing multiple '\ ``cpus``\ ' options. If '\ ``cpus``\ ' is 237e2fcbf42SPeter Maydell omitted on all nodes, VCPUs are automatically split between them. 238e2fcbf42SPeter Maydell 239e2fcbf42SPeter Maydell For example, the following option assigns VCPUs 0, 1, 2 and 5 to a 240e2fcbf42SPeter Maydell NUMA node: 241e2fcbf42SPeter Maydell 242e2fcbf42SPeter Maydell :: 243e2fcbf42SPeter Maydell 244e2fcbf42SPeter Maydell -numa node,cpus=0-2,cpus=5 245e2fcbf42SPeter Maydell 246e2fcbf42SPeter Maydell '\ ``cpu``\ ' option is a new alternative to '\ ``cpus``\ ' option 247e2fcbf42SPeter Maydell which uses '\ ``socket-id|core-id|thread-id``\ ' properties to 248e2fcbf42SPeter Maydell assign CPU objects to a node using topology layout properties of 249e2fcbf42SPeter Maydell CPU. The set of properties is machine specific, and depends on used 250e2fcbf42SPeter Maydell machine type/'\ ``smp``\ ' options. It could be queried with 251e2fcbf42SPeter Maydell '\ ``hotpluggable-cpus``\ ' monitor command. '\ ``node-id``\ ' 252e2fcbf42SPeter Maydell property specifies node to which CPU object will be assigned, it's 253e2fcbf42SPeter Maydell required for node to be declared with '\ ``node``\ ' option before 254e2fcbf42SPeter Maydell it's used with '\ ``cpu``\ ' option. 255e2fcbf42SPeter Maydell 256e2fcbf42SPeter Maydell For example: 257e2fcbf42SPeter Maydell 258e2fcbf42SPeter Maydell :: 259e2fcbf42SPeter Maydell 260e2fcbf42SPeter Maydell -M pc \ 261e2fcbf42SPeter Maydell -smp 1,sockets=2,maxcpus=2 \ 262e2fcbf42SPeter Maydell -numa node,nodeid=0 -numa node,nodeid=1 \ 263e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 264e2fcbf42SPeter Maydell 26532a354dcSIgor Mammedov Legacy '\ ``mem``\ ' assigns a given RAM amount to a node (not supported 26632a354dcSIgor Mammedov for 5.1 and newer machine types). '\ ``memdev``\ ' assigns RAM from 26732a354dcSIgor Mammedov a given memory backend device to a node. If '\ ``mem``\ ' and 26832a354dcSIgor Mammedov '\ ``memdev``\ ' are omitted in all nodes, RAM is split equally between them. 26932a354dcSIgor Mammedov 270e2fcbf42SPeter Maydell 271e2fcbf42SPeter Maydell '\ ``mem``\ ' and '\ ``memdev``\ ' are mutually exclusive. 272e2fcbf42SPeter Maydell Furthermore, if one node uses '\ ``memdev``\ ', all of them have to 273e2fcbf42SPeter Maydell use it. 274e2fcbf42SPeter Maydell 275e2fcbf42SPeter Maydell '\ ``initiator``\ ' is an additional option that points to an 276e2fcbf42SPeter Maydell initiator NUMA node that has best performance (the lowest latency or 277e2fcbf42SPeter Maydell largest bandwidth) to this NUMA node. Note that this option can be 278e2fcbf42SPeter Maydell set only when the machine property 'hmat' is set to 'on'. 279e2fcbf42SPeter Maydell 280e2fcbf42SPeter Maydell Following example creates a machine with 2 NUMA nodes, node 0 has 281e2fcbf42SPeter Maydell CPU. node 1 has only memory, and its initiator is node 0. Note that 282e2fcbf42SPeter Maydell because node 0 has CPU, by default the initiator of node 0 is itself 283e2fcbf42SPeter Maydell and must be itself. 284e2fcbf42SPeter Maydell 285e2fcbf42SPeter Maydell :: 286e2fcbf42SPeter Maydell 287e2fcbf42SPeter Maydell -machine hmat=on \ 288e2fcbf42SPeter Maydell -m 2G,slots=2,maxmem=4G \ 289e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 290e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 291e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 292e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 293e2fcbf42SPeter Maydell -smp 2,sockets=2,maxcpus=2 \ 294e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 295e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 296e2fcbf42SPeter Maydell 297e2fcbf42SPeter Maydell source and destination are NUMA node IDs. distance is the NUMA 298e2fcbf42SPeter Maydell distance from source to destination. The distance from a node to 299e2fcbf42SPeter Maydell itself is always 10. If any pair of nodes is given a distance, then 300e2fcbf42SPeter Maydell all pairs must be given distances. Although, when distances are only 301e2fcbf42SPeter Maydell given in one direction for each pair of nodes, then the distances in 302e2fcbf42SPeter Maydell the opposite directions are assumed to be the same. If, however, an 303e2fcbf42SPeter Maydell asymmetrical pair of distances is given for even one node pair, then 304e2fcbf42SPeter Maydell all node pairs must be provided distance values for both directions, 305e2fcbf42SPeter Maydell even when they are symmetrical. When a node is unreachable from 306e2fcbf42SPeter Maydell another node, set the pair's distance to 255. 307e2fcbf42SPeter Maydell 308e2fcbf42SPeter Maydell Note that the -``numa`` option doesn't allocate any of the specified 309e2fcbf42SPeter Maydell resources, it just assigns existing resources to NUMA nodes. This 310e2fcbf42SPeter Maydell means that one still has to use the ``-m``, ``-smp`` options to 311e2fcbf42SPeter Maydell allocate RAM and VCPUs respectively. 312e2fcbf42SPeter Maydell 313e2fcbf42SPeter Maydell Use '\ ``hmat-lb``\ ' to set System Locality Latency and Bandwidth 314e2fcbf42SPeter Maydell Information between initiator and target NUMA nodes in ACPI 315e2fcbf42SPeter Maydell Heterogeneous Attribute Memory Table (HMAT). Initiator NUMA node can 316e2fcbf42SPeter Maydell create memory requests, usually it has one or more processors. 317e2fcbf42SPeter Maydell Target NUMA node contains addressable memory. 318e2fcbf42SPeter Maydell 319e2fcbf42SPeter Maydell In '\ ``hmat-lb``\ ' option, node are NUMA node IDs. hierarchy is 320e2fcbf42SPeter Maydell the memory hierarchy of the target NUMA node: if hierarchy is 321e2fcbf42SPeter Maydell 'memory', the structure represents the memory performance; if 322e2fcbf42SPeter Maydell hierarchy is 'first-level\|second-level\|third-level', this 323e2fcbf42SPeter Maydell structure represents aggregated performance of memory side caches 324e2fcbf42SPeter Maydell for each domain. type of 'data-type' is type of data represented by 325e2fcbf42SPeter Maydell this structure instance: if 'hierarchy' is 'memory', 'data-type' is 326e2fcbf42SPeter Maydell 'access\|read\|write' latency or 'access\|read\|write' bandwidth of 327e2fcbf42SPeter Maydell the target memory; if 'hierarchy' is 328e2fcbf42SPeter Maydell 'first-level\|second-level\|third-level', 'data-type' is 329e2fcbf42SPeter Maydell 'access\|read\|write' hit latency or 'access\|read\|write' hit 330e2fcbf42SPeter Maydell bandwidth of the target memory side cache. 331e2fcbf42SPeter Maydell 332e2fcbf42SPeter Maydell lat is latency value in nanoseconds. bw is bandwidth value, the 333e2fcbf42SPeter Maydell possible value and units are NUM[M\|G\|T], mean that the bandwidth 334e2fcbf42SPeter Maydell value are NUM byte per second (or MB/s, GB/s or TB/s depending on 335e2fcbf42SPeter Maydell used suffix). Note that if latency or bandwidth value is 0, means 336e2fcbf42SPeter Maydell the corresponding latency or bandwidth information is not provided. 337e2fcbf42SPeter Maydell 338e2fcbf42SPeter Maydell In '\ ``hmat-cache``\ ' option, node-id is the NUMA-id of the memory 339e2fcbf42SPeter Maydell belongs. size is the size of memory side cache in bytes. level is 340e2fcbf42SPeter Maydell the cache level described in this structure, note that the cache 341e2fcbf42SPeter Maydell level 0 should not be used with '\ ``hmat-cache``\ ' option. 342e2fcbf42SPeter Maydell associativity is the cache associativity, the possible value is 343e2fcbf42SPeter Maydell 'none/direct(direct-mapped)/complex(complex cache indexing)'. policy 344e2fcbf42SPeter Maydell is the write policy. line is the cache Line size in bytes. 345e2fcbf42SPeter Maydell 346e2fcbf42SPeter Maydell For example, the following options describe 2 NUMA nodes. Node 0 has 347e2fcbf42SPeter Maydell 2 cpus and a ram, node 1 has only a ram. The processors in node 0 348e2fcbf42SPeter Maydell access memory in node 0 with access-latency 5 nanoseconds, 349e2fcbf42SPeter Maydell access-bandwidth is 200 MB/s; The processors in NUMA node 0 access 350e2fcbf42SPeter Maydell memory in NUMA node 1 with access-latency 10 nanoseconds, 351e2fcbf42SPeter Maydell access-bandwidth is 100 MB/s. And for memory side cache information, 352e2fcbf42SPeter Maydell NUMA node 0 and 1 both have 1 level memory cache, size is 10KB, 353e2fcbf42SPeter Maydell policy is write-back, the cache Line size is 8 bytes: 354e2fcbf42SPeter Maydell 355e2fcbf42SPeter Maydell :: 356e2fcbf42SPeter Maydell 357e2fcbf42SPeter Maydell -machine hmat=on \ 358e2fcbf42SPeter Maydell -m 2G \ 359e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 360e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 361e2fcbf42SPeter Maydell -smp 2 \ 362e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 363e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 364e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 365e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 \ 366e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-latency,latency=5 \ 367e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-bandwidth,bandwidth=200M \ 368e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-latency,latency=10 \ 369e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-bandwidth,bandwidth=100M \ 370e2fcbf42SPeter Maydell -numa hmat-cache,node-id=0,size=10K,level=1,associativity=direct,policy=write-back,line=8 \ 371e2fcbf42SPeter Maydell -numa hmat-cache,node-id=1,size=10K,level=1,associativity=direct,policy=write-back,line=8 372e2fcbf42SPeter MaydellERST 373268a362cSaliguori 37410adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 37510adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 37610adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 377e2fcbf42SPeter MaydellSRST 378e2fcbf42SPeter Maydell``-add-fd fd=fd,set=set[,opaque=opaque]`` 379e2fcbf42SPeter Maydell Add a file descriptor to an fd set. Valid options are: 380e2fcbf42SPeter Maydell 381e2fcbf42SPeter Maydell ``fd=fd`` 382e2fcbf42SPeter Maydell This option defines the file descriptor of which a duplicate is 383e2fcbf42SPeter Maydell added to fd set. The file descriptor cannot be stdin, stdout, or 384e2fcbf42SPeter Maydell stderr. 385e2fcbf42SPeter Maydell 386e2fcbf42SPeter Maydell ``set=set`` 387e2fcbf42SPeter Maydell This option defines the ID of the fd set to add the file 388e2fcbf42SPeter Maydell descriptor to. 389e2fcbf42SPeter Maydell 390e2fcbf42SPeter Maydell ``opaque=opaque`` 391e2fcbf42SPeter Maydell This option defines a free-form string that can be used to 392e2fcbf42SPeter Maydell describe fd. 393e2fcbf42SPeter Maydell 394e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 395e2fcbf42SPeter Maydell set: 396e2fcbf42SPeter Maydell 397e2fcbf42SPeter Maydell .. parsed-literal:: 398e2fcbf42SPeter Maydell 399353a06b4SLaszlo Ersek |qemu_system| \\ 400353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 401353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 402e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 403e2fcbf42SPeter MaydellERST 40410adb8beSMarkus Armbruster 40510adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 40610adb8beSMarkus Armbruster "-set group.id.arg=value\n" 40710adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 40810adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 409e2fcbf42SPeter MaydellSRST 410e2fcbf42SPeter Maydell``-set group.id.arg=value`` 411e2fcbf42SPeter Maydell Set parameter arg for item id of type group 412e2fcbf42SPeter MaydellERST 41310adb8beSMarkus Armbruster 41410adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 4153751d7c4SPaolo Bonzini "-global driver.property=value\n" 4163751d7c4SPaolo Bonzini "-global driver=driver,property=property,value=value\n" 41710adb8beSMarkus Armbruster " set a global default for a driver property\n", 41810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 419e2fcbf42SPeter MaydellSRST 42009ce5f2dSPeter Maydell``-global driver.prop=value`` 42109ce5f2dSPeter Maydell \ 42209ce5f2dSPeter Maydell``-global driver=driver,property=property,value=value`` 423e2fcbf42SPeter Maydell Set default value of driver's property prop to value, e.g.: 424e2fcbf42SPeter Maydell 425e2fcbf42SPeter Maydell .. parsed-literal:: 426e2fcbf42SPeter Maydell 427e2fcbf42SPeter Maydell |qemu_system_x86| -global ide-hd.physical_block_size=4096 disk-image.img 428e2fcbf42SPeter Maydell 429e2fcbf42SPeter Maydell In particular, you can use this to set driver properties for devices 430e2fcbf42SPeter Maydell which are created automatically by the machine model. To create a 431e2fcbf42SPeter Maydell device which is not created automatically and set properties on it, 432e2fcbf42SPeter Maydell use -``device``. 433e2fcbf42SPeter Maydell 434e2fcbf42SPeter Maydell -global driver.prop=value is shorthand for -global 435e2fcbf42SPeter Maydell driver=driver,property=prop,value=value. The longhand syntax works 436e2fcbf42SPeter Maydell even when driver contains a dot. 437e2fcbf42SPeter MaydellERST 43810adb8beSMarkus Armbruster 43910adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 44010adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 441c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 44210adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 44310adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 44410adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 44510adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 44610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 447e2fcbf42SPeter MaydellSRST 448e2fcbf42SPeter Maydell``-boot [order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_timeout][,strict=on|off]`` 449e2fcbf42SPeter Maydell Specify boot order drives as a string of drive letters. Valid drive 450e2fcbf42SPeter Maydell letters depend on the target architecture. The x86 PC uses: a, b 451e2fcbf42SPeter Maydell (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p 452e2fcbf42SPeter Maydell (Etherboot from network adapter 1-4), hard disk boot is the default. 453e2fcbf42SPeter Maydell To apply a particular boot order only on the first startup, specify 454e2fcbf42SPeter Maydell it via ``once``. Note that the ``order`` or ``once`` parameter 455e2fcbf42SPeter Maydell should not be used together with the ``bootindex`` property of 456e2fcbf42SPeter Maydell devices, since the firmware implementations normally do not support 457e2fcbf42SPeter Maydell both at the same time. 458e2fcbf42SPeter Maydell 459e2fcbf42SPeter Maydell Interactive boot menus/prompts can be enabled via ``menu=on`` as far 460e2fcbf42SPeter Maydell as firmware/BIOS supports them. The default is non-interactive boot. 461e2fcbf42SPeter Maydell 462e2fcbf42SPeter Maydell A splash picture could be passed to bios, enabling user to show it 463e2fcbf42SPeter Maydell as logo, when option splash=sp\_name is given and menu=on, If 464e2fcbf42SPeter Maydell firmware/BIOS supports them. Currently Seabios for X86 system 465e2fcbf42SPeter Maydell support it. limitation: The splash file could be a jpeg file or a 466e2fcbf42SPeter Maydell BMP file in 24 BPP format(true color). The resolution should be 467e2fcbf42SPeter Maydell supported by the SVGA mode, so the recommended is 320x240, 640x480, 468e2fcbf42SPeter Maydell 800x640. 469e2fcbf42SPeter Maydell 470e2fcbf42SPeter Maydell A timeout could be passed to bios, guest will pause for rb\_timeout 471e2fcbf42SPeter Maydell ms when boot failed, then reboot. If rb\_timeout is '-1', guest will 472e2fcbf42SPeter Maydell not reboot, qemu passes '-1' to bios by default. Currently Seabios 473e2fcbf42SPeter Maydell for X86 system support it. 474e2fcbf42SPeter Maydell 475e2fcbf42SPeter Maydell Do strict boot via ``strict=on`` as far as firmware/BIOS supports 476e2fcbf42SPeter Maydell it. This only effects when boot priority is changed by bootindex 477e2fcbf42SPeter Maydell options. The default is non-strict boot. 478e2fcbf42SPeter Maydell 47909ce5f2dSPeter Maydell .. parsed-literal:: 480e2fcbf42SPeter Maydell 481e2fcbf42SPeter Maydell # try to boot from network first, then from hard disk 482e2fcbf42SPeter Maydell |qemu_system_x86| -boot order=nc 483e2fcbf42SPeter Maydell # boot from CD-ROM first, switch back to default order after reboot 484e2fcbf42SPeter Maydell |qemu_system_x86| -boot once=d 485e2fcbf42SPeter Maydell # boot with a splash picture for 5 seconds. 486e2fcbf42SPeter Maydell |qemu_system_x86| -boot menu=on,splash=/root/boot.bmp,splash-time=5000 487e2fcbf42SPeter Maydell 488e2fcbf42SPeter Maydell Note: The legacy format '-boot drives' is still supported but its 489e2fcbf42SPeter Maydell use is discouraged as it may be removed from future versions. 490e2fcbf42SPeter MaydellERST 49110adb8beSMarkus Armbruster 49210adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 49389f3ea2bSMichael Tokarev "-m [size=]megs[,slots=n,maxmem=size]\n" 4946e1d3c1cSIgor Mammedov " configure guest RAM\n" 4950daba1f0SAlexander Graf " size: initial amount of guest memory\n" 496c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 497b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 498b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 4996e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 500e2fcbf42SPeter MaydellSRST 501e2fcbf42SPeter Maydell``-m [size=]megs[,slots=n,maxmem=size]`` 502e2fcbf42SPeter Maydell Sets guest startup RAM size to megs megabytes. Default is 128 MiB. 503e2fcbf42SPeter Maydell Optionally, a suffix of "M" or "G" can be used to signify a value in 504e2fcbf42SPeter Maydell megabytes or gigabytes respectively. Optional pair slots, maxmem 505e2fcbf42SPeter Maydell could be used to set amount of hotpluggable memory slots and maximum 506e2fcbf42SPeter Maydell amount of memory. Note that maxmem must be aligned to the page size. 507e2fcbf42SPeter Maydell 508e2fcbf42SPeter Maydell For example, the following command-line sets the guest startup RAM 509e2fcbf42SPeter Maydell size to 1GB, creates 3 slots to hotplug additional memory and sets 510e2fcbf42SPeter Maydell the maximum memory the guest can reach to 4GB: 511e2fcbf42SPeter Maydell 512e2fcbf42SPeter Maydell .. parsed-literal:: 513e2fcbf42SPeter Maydell 514e2fcbf42SPeter Maydell |qemu_system| -m 1G,slots=3,maxmem=4G 515e2fcbf42SPeter Maydell 516e2fcbf42SPeter Maydell If slots and maxmem are not specified, memory hotplug won't be 517e2fcbf42SPeter Maydell enabled and the guest startup RAM will never increase. 518e2fcbf42SPeter MaydellERST 51910adb8beSMarkus Armbruster 52010adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 52110adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 522e2fcbf42SPeter MaydellSRST 523e2fcbf42SPeter Maydell``-mem-path path`` 524e2fcbf42SPeter Maydell Allocate guest RAM from a temporarily created file in path. 525e2fcbf42SPeter MaydellERST 52610adb8beSMarkus Armbruster 52710adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 52810adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 52910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 530e2fcbf42SPeter MaydellSRST 531e2fcbf42SPeter Maydell``-mem-prealloc`` 532e2fcbf42SPeter Maydell Preallocate memory when using -mem-path. 533e2fcbf42SPeter MaydellERST 53410adb8beSMarkus Armbruster 53510adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 53610adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 53710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 538e2fcbf42SPeter MaydellSRST 539e2fcbf42SPeter Maydell``-k language`` 540e2fcbf42SPeter Maydell Use keyboard layout language (for example ``fr`` for French). This 541e2fcbf42SPeter Maydell option is only needed where it is not easy to get raw PC keycodes 542e2fcbf42SPeter Maydell (e.g. on Macs, with some X11 servers or with a VNC or curses 543e2fcbf42SPeter Maydell display). You don't normally need to use it on PC/Linux or 544e2fcbf42SPeter Maydell PC/Windows hosts. 545e2fcbf42SPeter Maydell 546e2fcbf42SPeter Maydell The available layouts are: 547e2fcbf42SPeter Maydell 548e2fcbf42SPeter Maydell :: 549e2fcbf42SPeter Maydell 550e2fcbf42SPeter Maydell ar de-ch es fo fr-ca hu ja mk no pt-br sv 551e2fcbf42SPeter Maydell da en-gb et fr fr-ch is lt nl pl ru th 552e2fcbf42SPeter Maydell de en-us fi fr-be hr it lv nl-be pt sl tr 553e2fcbf42SPeter Maydell 554e2fcbf42SPeter Maydell The default is ``en-us``. 555e2fcbf42SPeter MaydellERST 55610adb8beSMarkus Armbruster 55710adb8beSMarkus Armbruster 558f0b3d811SKővágó, ZoltánHXCOMM Deprecated by -audiodev 55910adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 560f0b3d811SKővágó, Zoltán "-audio-help show -audiodev equivalent of the currently specified audio settings\n", 56110adb8beSMarkus Armbruster QEMU_ARCH_ALL) 562e2fcbf42SPeter MaydellSRST 563e2fcbf42SPeter Maydell``-audio-help`` 564e2fcbf42SPeter Maydell Will show the -audiodev equivalent of the currently specified 565e2fcbf42SPeter Maydell (deprecated) environment variables. 566e2fcbf42SPeter MaydellERST 567f0b3d811SKővágó, Zoltán 568f0b3d811SKővágó, ZoltánDEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev, 569f0b3d811SKővágó, Zoltán "-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n" 570f0b3d811SKővágó, Zoltán " specifies the audio backend to use\n" 571f0b3d811SKővágó, Zoltán " id= identifier of the backend\n" 572f0b3d811SKővágó, Zoltán " timer-period= timer period in microseconds\n" 5738efac073SKővágó, Zoltán " in|out.mixing-engine= use mixing engine to mix streams inside QEMU\n" 574f0b3d811SKővágó, Zoltán " in|out.fixed-settings= use fixed settings for host audio\n" 575f0b3d811SKővágó, Zoltán " in|out.frequency= frequency to use with fixed settings\n" 576f0b3d811SKővágó, Zoltán " in|out.channels= number of channels to use with fixed settings\n" 577f0b3d811SKővágó, Zoltán " in|out.format= sample format to use with fixed settings\n" 57849f77e6fSVolker Rümelin " valid values: s8, s16, s32, u8, u16, u32, f32\n" 579f0b3d811SKővágó, Zoltán " in|out.voices= number of voices to use\n" 5808624725bSStefan Hajnoczi " in|out.buffer-length= length of buffer in microseconds\n" 581f0b3d811SKővágó, Zoltán "-audiodev none,id=id,[,prop[=value][,...]]\n" 582f0b3d811SKővágó, Zoltán " dummy driver that discards all output\n" 583f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_ALSA 584f0b3d811SKővágó, Zoltán "-audiodev alsa,id=id[,prop[=value][,...]]\n" 585f0b3d811SKővágó, Zoltán " in|out.dev= name of the audio device to use\n" 586dfc54343SStefan Hajnoczi " in|out.period-length= length of period in microseconds\n" 587f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 588f0b3d811SKővágó, Zoltán " threshold= threshold (in microseconds) when playback starts\n" 589f0b3d811SKővágó, Zoltán#endif 590f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_COREAUDIO 591f0b3d811SKővágó, Zoltán "-audiodev coreaudio,id=id[,prop[=value][,...]]\n" 592f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 593f0b3d811SKővágó, Zoltán#endif 594f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_DSOUND 595f0b3d811SKővágó, Zoltán "-audiodev dsound,id=id[,prop[=value][,...]]\n" 596f0b3d811SKővágó, Zoltán " latency= add extra latency to playback in microseconds\n" 597f0b3d811SKővágó, Zoltán#endif 598f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_OSS 599f0b3d811SKővágó, Zoltán "-audiodev oss,id=id[,prop[=value][,...]]\n" 600f0b3d811SKővágó, Zoltán " in|out.dev= path of the audio device to use\n" 601f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 602f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 603f0b3d811SKővágó, Zoltán " try-mmap= try using memory mapped access\n" 604f0b3d811SKővágó, Zoltán " exclusive= open device in exclusive mode\n" 605f0b3d811SKővágó, Zoltán " dsp-policy= set timing policy (0..10), -1 to use fragment mode\n" 606f0b3d811SKővágó, Zoltán#endif 607f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_PA 608f0b3d811SKővágó, Zoltán "-audiodev pa,id=id[,prop[=value][,...]]\n" 609f0b3d811SKővágó, Zoltán " server= PulseAudio server address\n" 610f0b3d811SKővágó, Zoltán " in|out.name= source/sink device name\n" 61114d4f011SStefan Hajnoczi " in|out.latency= desired latency in microseconds\n" 612f0b3d811SKővágó, Zoltán#endif 613f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_SDL 614f0b3d811SKővágó, Zoltán "-audiodev sdl,id=id[,prop[=value][,...]]\n" 6155a0926c2SVolker Rümelin " in|out.buffer-count= number of buffers\n" 616f0b3d811SKővágó, Zoltán#endif 617f0b3d811SKővágó, Zoltán#ifdef CONFIG_SPICE 618f0b3d811SKővágó, Zoltán "-audiodev spice,id=id[,prop[=value][,...]]\n" 619f0b3d811SKővágó, Zoltán#endif 620f0b3d811SKővágó, Zoltán "-audiodev wav,id=id[,prop[=value][,...]]\n" 621f0b3d811SKővágó, Zoltán " path= path of wav file to record\n", 622f0b3d811SKővágó, Zoltán QEMU_ARCH_ALL) 623e2fcbf42SPeter MaydellSRST 624e2fcbf42SPeter Maydell``-audiodev [driver=]driver,id=id[,prop[=value][,...]]`` 625e2fcbf42SPeter Maydell Adds a new audio backend driver identified by id. There are global 626e2fcbf42SPeter Maydell and driver specific properties. Some values can be set differently 627e2fcbf42SPeter Maydell for input and output, they're marked with ``in|out.``. You can set 628e2fcbf42SPeter Maydell the input's property with ``in.prop`` and the output's property with 629e2fcbf42SPeter Maydell ``out.prop``. For example: 630e2fcbf42SPeter Maydell 631e2fcbf42SPeter Maydell :: 632e2fcbf42SPeter Maydell 633e2fcbf42SPeter Maydell -audiodev alsa,id=example,in.frequency=44110,out.frequency=8000 634e2fcbf42SPeter Maydell -audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified 635e2fcbf42SPeter Maydell 636e2fcbf42SPeter Maydell NOTE: parameter validation is known to be incomplete, in many cases 637e2fcbf42SPeter Maydell specifying an invalid option causes QEMU to print an error message 638e2fcbf42SPeter Maydell and continue emulation without sound. 639e2fcbf42SPeter Maydell 640e2fcbf42SPeter Maydell Valid global options are: 641e2fcbf42SPeter Maydell 642e2fcbf42SPeter Maydell ``id=identifier`` 643e2fcbf42SPeter Maydell Identifies the audio backend. 644e2fcbf42SPeter Maydell 645e2fcbf42SPeter Maydell ``timer-period=period`` 646e2fcbf42SPeter Maydell Sets the timer period used by the audio subsystem in 647e2fcbf42SPeter Maydell microseconds. Default is 10000 (10 ms). 648e2fcbf42SPeter Maydell 649e2fcbf42SPeter Maydell ``in|out.mixing-engine=on|off`` 650e2fcbf42SPeter Maydell Use QEMU's mixing engine to mix all streams inside QEMU and 651e2fcbf42SPeter Maydell convert audio formats when not supported by the backend. When 652e2fcbf42SPeter Maydell off, fixed-settings must be off too. Note that disabling this 653e2fcbf42SPeter Maydell option means that the selected backend must support multiple 654e2fcbf42SPeter Maydell streams and the audio formats used by the virtual cards, 655e2fcbf42SPeter Maydell otherwise you'll get no sound. It's not recommended to disable 656e2fcbf42SPeter Maydell this option unless you want to use 5.1 or 7.1 audio, as mixing 657e2fcbf42SPeter Maydell engine only supports mono and stereo audio. Default is on. 658e2fcbf42SPeter Maydell 659e2fcbf42SPeter Maydell ``in|out.fixed-settings=on|off`` 660e2fcbf42SPeter Maydell Use fixed settings for host audio. When off, it will change 661e2fcbf42SPeter Maydell based on how the guest opens the sound card. In this case you 662e2fcbf42SPeter Maydell must not specify frequency, channels or format. Default is on. 663e2fcbf42SPeter Maydell 664e2fcbf42SPeter Maydell ``in|out.frequency=frequency`` 665e2fcbf42SPeter Maydell Specify the frequency to use when using fixed-settings. Default 666e2fcbf42SPeter Maydell is 44100Hz. 667e2fcbf42SPeter Maydell 668e2fcbf42SPeter Maydell ``in|out.channels=channels`` 669e2fcbf42SPeter Maydell Specify the number of channels to use when using fixed-settings. 670e2fcbf42SPeter Maydell Default is 2 (stereo). 671e2fcbf42SPeter Maydell 672e2fcbf42SPeter Maydell ``in|out.format=format`` 673e2fcbf42SPeter Maydell Specify the sample format to use when using fixed-settings. 674e2fcbf42SPeter Maydell Valid values are: ``s8``, ``s16``, ``s32``, ``u8``, ``u16``, 67549f77e6fSVolker Rümelin ``u32``, ``f32``. Default is ``s16``. 676e2fcbf42SPeter Maydell 677e2fcbf42SPeter Maydell ``in|out.voices=voices`` 678e2fcbf42SPeter Maydell Specify the number of voices to use. Default is 1. 679e2fcbf42SPeter Maydell 680e2fcbf42SPeter Maydell ``in|out.buffer-length=usecs`` 681e2fcbf42SPeter Maydell Sets the size of the buffer in microseconds. 682e2fcbf42SPeter Maydell 683e2fcbf42SPeter Maydell``-audiodev none,id=id[,prop[=value][,...]]`` 684e2fcbf42SPeter Maydell Creates a dummy backend that discards all outputs. This backend has 685e2fcbf42SPeter Maydell no backend specific properties. 686e2fcbf42SPeter Maydell 687e2fcbf42SPeter Maydell``-audiodev alsa,id=id[,prop[=value][,...]]`` 688e2fcbf42SPeter Maydell Creates backend using the ALSA. This backend is only available on 689e2fcbf42SPeter Maydell Linux. 690e2fcbf42SPeter Maydell 691e2fcbf42SPeter Maydell ALSA specific options are: 692e2fcbf42SPeter Maydell 693e2fcbf42SPeter Maydell ``in|out.dev=device`` 694e2fcbf42SPeter Maydell Specify the ALSA device to use for input and/or output. Default 695e2fcbf42SPeter Maydell is ``default``. 696e2fcbf42SPeter Maydell 697e2fcbf42SPeter Maydell ``in|out.period-length=usecs`` 698e2fcbf42SPeter Maydell Sets the period length in microseconds. 699e2fcbf42SPeter Maydell 700e2fcbf42SPeter Maydell ``in|out.try-poll=on|off`` 701e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 702e2fcbf42SPeter Maydell 703e2fcbf42SPeter Maydell ``threshold=threshold`` 704e2fcbf42SPeter Maydell Threshold (in microseconds) when playback starts. Default is 0. 705e2fcbf42SPeter Maydell 706e2fcbf42SPeter Maydell``-audiodev coreaudio,id=id[,prop[=value][,...]]`` 707e2fcbf42SPeter Maydell Creates a backend using Apple's Core Audio. This backend is only 708e2fcbf42SPeter Maydell available on Mac OS and only supports playback. 709e2fcbf42SPeter Maydell 710e2fcbf42SPeter Maydell Core Audio specific options are: 711e2fcbf42SPeter Maydell 712e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 713e2fcbf42SPeter Maydell Sets the count of the buffers. 714e2fcbf42SPeter Maydell 715e2fcbf42SPeter Maydell``-audiodev dsound,id=id[,prop[=value][,...]]`` 716e2fcbf42SPeter Maydell Creates a backend using Microsoft's DirectSound. This backend is 717e2fcbf42SPeter Maydell only available on Windows and only supports playback. 718e2fcbf42SPeter Maydell 719e2fcbf42SPeter Maydell DirectSound specific options are: 720e2fcbf42SPeter Maydell 721e2fcbf42SPeter Maydell ``latency=usecs`` 722e2fcbf42SPeter Maydell Add extra usecs microseconds latency to playback. Default is 723e2fcbf42SPeter Maydell 10000 (10 ms). 724e2fcbf42SPeter Maydell 725e2fcbf42SPeter Maydell``-audiodev oss,id=id[,prop[=value][,...]]`` 726e2fcbf42SPeter Maydell Creates a backend using OSS. This backend is available on most 727e2fcbf42SPeter Maydell Unix-like systems. 728e2fcbf42SPeter Maydell 729e2fcbf42SPeter Maydell OSS specific options are: 730e2fcbf42SPeter Maydell 731e2fcbf42SPeter Maydell ``in|out.dev=device`` 732e2fcbf42SPeter Maydell Specify the file name of the OSS device to use. Default is 733e2fcbf42SPeter Maydell ``/dev/dsp``. 734e2fcbf42SPeter Maydell 735e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 736e2fcbf42SPeter Maydell Sets the count of the buffers. 737e2fcbf42SPeter Maydell 738e2fcbf42SPeter Maydell ``in|out.try-poll=on|of`` 739e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 740e2fcbf42SPeter Maydell 741e2fcbf42SPeter Maydell ``try-mmap=on|off`` 742e2fcbf42SPeter Maydell Try using memory mapped device access. Default is off. 743e2fcbf42SPeter Maydell 744e2fcbf42SPeter Maydell ``exclusive=on|off`` 745e2fcbf42SPeter Maydell Open the device in exclusive mode (vmix won't work in this 746e2fcbf42SPeter Maydell case). Default is off. 747e2fcbf42SPeter Maydell 748e2fcbf42SPeter Maydell ``dsp-policy=policy`` 749e2fcbf42SPeter Maydell Sets the timing policy (between 0 and 10, where smaller number 750e2fcbf42SPeter Maydell means smaller latency but higher CPU usage). Use -1 to use 751e2fcbf42SPeter Maydell buffer sizes specified by ``buffer`` and ``buffer-count``. This 752e2fcbf42SPeter Maydell option is ignored if you do not have OSS 4. Default is 5. 753e2fcbf42SPeter Maydell 754e2fcbf42SPeter Maydell``-audiodev pa,id=id[,prop[=value][,...]]`` 755e2fcbf42SPeter Maydell Creates a backend using PulseAudio. This backend is available on 756e2fcbf42SPeter Maydell most systems. 757e2fcbf42SPeter Maydell 758e2fcbf42SPeter Maydell PulseAudio specific options are: 759e2fcbf42SPeter Maydell 760e2fcbf42SPeter Maydell ``server=server`` 761e2fcbf42SPeter Maydell Sets the PulseAudio server to connect to. 762e2fcbf42SPeter Maydell 763e2fcbf42SPeter Maydell ``in|out.name=sink`` 764e2fcbf42SPeter Maydell Use the specified source/sink for recording/playback. 765e2fcbf42SPeter Maydell 766e2fcbf42SPeter Maydell ``in|out.latency=usecs`` 767e2fcbf42SPeter Maydell Desired latency in microseconds. The PulseAudio server will try 768e2fcbf42SPeter Maydell to honor this value but actual latencies may be lower or higher. 769e2fcbf42SPeter Maydell 770e2fcbf42SPeter Maydell``-audiodev sdl,id=id[,prop[=value][,...]]`` 771e2fcbf42SPeter Maydell Creates a backend using SDL. This backend is available on most 772e2fcbf42SPeter Maydell systems, but you should use your platform's native backend if 7735a0926c2SVolker Rümelin possible. 7745a0926c2SVolker Rümelin 7755a0926c2SVolker Rümelin SDL specific options are: 7765a0926c2SVolker Rümelin 7775a0926c2SVolker Rümelin ``in|out.buffer-count=count`` 7785a0926c2SVolker Rümelin Sets the count of the buffers. 779e2fcbf42SPeter Maydell 780e2fcbf42SPeter Maydell``-audiodev spice,id=id[,prop[=value][,...]]`` 781e2fcbf42SPeter Maydell Creates a backend that sends audio through SPICE. This backend 782e2fcbf42SPeter Maydell requires ``-spice`` and automatically selected in that case, so 783e2fcbf42SPeter Maydell usually you can ignore this option. This backend has no backend 784e2fcbf42SPeter Maydell specific properties. 785e2fcbf42SPeter Maydell 786e2fcbf42SPeter Maydell``-audiodev wav,id=id[,prop[=value][,...]]`` 787e2fcbf42SPeter Maydell Creates a backend that writes audio to a WAV file. 788e2fcbf42SPeter Maydell 789e2fcbf42SPeter Maydell Backend specific options are: 790e2fcbf42SPeter Maydell 791e2fcbf42SPeter Maydell ``path=path`` 792e2fcbf42SPeter Maydell Write recorded audio into the specified file. Default is 793e2fcbf42SPeter Maydell ``qemu.wav``. 794e2fcbf42SPeter MaydellERST 79510adb8beSMarkus Armbruster 79610adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 79710adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 79810adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 79910adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 80010adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 801e2fcbf42SPeter MaydellSRST 802e2fcbf42SPeter Maydell``-soundhw card1[,card2,...] or -soundhw all`` 803e2fcbf42SPeter Maydell Enable audio and selected sound hardware. Use 'help' to print all 804e2fcbf42SPeter Maydell available sound hardware. For example: 805e2fcbf42SPeter Maydell 806e2fcbf42SPeter Maydell .. parsed-literal:: 807e2fcbf42SPeter Maydell 808e2fcbf42SPeter Maydell |qemu_system_x86| -soundhw sb16,adlib disk.img 809e2fcbf42SPeter Maydell |qemu_system_x86| -soundhw es1370 disk.img 810e2fcbf42SPeter Maydell |qemu_system_x86| -soundhw ac97 disk.img 811e2fcbf42SPeter Maydell |qemu_system_x86| -soundhw hda disk.img 812e2fcbf42SPeter Maydell |qemu_system_x86| -soundhw all disk.img 813e2fcbf42SPeter Maydell |qemu_system_x86| -soundhw help 814e2fcbf42SPeter Maydell 815e2fcbf42SPeter Maydell Note that Linux's i810\_audio OSS kernel (for AC97) module might 816e2fcbf42SPeter Maydell require manually specifying clocking. 817e2fcbf42SPeter Maydell 818e2fcbf42SPeter Maydell :: 819e2fcbf42SPeter Maydell 820e2fcbf42SPeter Maydell modprobe i810_audio clocking=48000 821e2fcbf42SPeter MaydellERST 82210adb8beSMarkus Armbruster 82310adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 82410adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 82510adb8beSMarkus Armbruster " add device (based on driver)\n" 82610adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 82710adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 82810adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 82910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 830e2fcbf42SPeter MaydellSRST 831e2fcbf42SPeter Maydell``-device driver[,prop[=value][,...]]`` 832e2fcbf42SPeter Maydell Add device driver. prop=value sets driver properties. Valid 833e2fcbf42SPeter Maydell properties depend on the driver. To get help on possible drivers and 834e2fcbf42SPeter Maydell properties, use ``-device help`` and ``-device driver,help``. 835e2fcbf42SPeter Maydell 836e2fcbf42SPeter Maydell Some drivers are: 837e2fcbf42SPeter Maydell 838789101b7SCorey Minyard``-device ipmi-bmc-sim,id=id[,prop[=value][,...]]`` 839e2fcbf42SPeter Maydell Add an IPMI BMC. This is a simulation of a hardware management 840e2fcbf42SPeter Maydell interface processor that normally sits on a system. It provides a 841e2fcbf42SPeter Maydell watchdog and the ability to reset and power control the system. You 842e2fcbf42SPeter Maydell need to connect this to an IPMI interface to make it useful 843e2fcbf42SPeter Maydell 844e2fcbf42SPeter Maydell The IPMI slave address to use for the BMC. The default is 0x20. This 845e2fcbf42SPeter Maydell address is the BMC's address on the I2C network of management 846e2fcbf42SPeter Maydell controllers. If you don't know what this means, it is safe to ignore 847e2fcbf42SPeter Maydell it. 848e2fcbf42SPeter Maydell 849e2fcbf42SPeter Maydell ``id=id`` 850e2fcbf42SPeter Maydell The BMC id for interfaces to use this device. 851e2fcbf42SPeter Maydell 852e2fcbf42SPeter Maydell ``slave_addr=val`` 853e2fcbf42SPeter Maydell Define slave address to use for the BMC. The default is 0x20. 854e2fcbf42SPeter Maydell 855e2fcbf42SPeter Maydell ``sdrfile=file`` 856e2fcbf42SPeter Maydell file containing raw Sensor Data Records (SDR) data. The default 857e2fcbf42SPeter Maydell is none. 858e2fcbf42SPeter Maydell 859e2fcbf42SPeter Maydell ``fruareasize=val`` 860e2fcbf42SPeter Maydell size of a Field Replaceable Unit (FRU) area. The default is 861e2fcbf42SPeter Maydell 1024. 862e2fcbf42SPeter Maydell 863e2fcbf42SPeter Maydell ``frudatafile=file`` 864e2fcbf42SPeter Maydell file containing raw Field Replaceable Unit (FRU) inventory data. 865e2fcbf42SPeter Maydell The default is none. 866e2fcbf42SPeter Maydell 867e2fcbf42SPeter Maydell ``guid=uuid`` 868e2fcbf42SPeter Maydell value for the GUID for the BMC, in standard UUID format. If this 869e2fcbf42SPeter Maydell is set, get "Get GUID" command to the BMC will return it. 870e2fcbf42SPeter Maydell Otherwise "Get GUID" will return an error. 871e2fcbf42SPeter Maydell 872e2fcbf42SPeter Maydell``-device ipmi-bmc-extern,id=id,chardev=id[,slave_addr=val]`` 873e2fcbf42SPeter Maydell Add a connection to an external IPMI BMC simulator. Instead of 874e2fcbf42SPeter Maydell locally emulating the BMC like the above item, instead connect to an 875e2fcbf42SPeter Maydell external entity that provides the IPMI services. 876e2fcbf42SPeter Maydell 877e2fcbf42SPeter Maydell A connection is made to an external BMC simulator. If you do this, 878e2fcbf42SPeter Maydell it is strongly recommended that you use the "reconnect=" chardev 879e2fcbf42SPeter Maydell option to reconnect to the simulator if the connection is lost. Note 880e2fcbf42SPeter Maydell that if this is not used carefully, it can be a security issue, as 881e2fcbf42SPeter Maydell the interface has the ability to send resets, NMIs, and power off 882e2fcbf42SPeter Maydell the VM. It's best if QEMU makes a connection to an external 883e2fcbf42SPeter Maydell simulator running on a secure port on localhost, so neither the 884e2fcbf42SPeter Maydell simulator nor QEMU is exposed to any outside network. 885e2fcbf42SPeter Maydell 886e2fcbf42SPeter Maydell See the "lanserv/README.vm" file in the OpenIPMI library for more 887e2fcbf42SPeter Maydell details on the external interface. 888e2fcbf42SPeter Maydell 889e2fcbf42SPeter Maydell``-device isa-ipmi-kcs,bmc=id[,ioport=val][,irq=val]`` 890e2fcbf42SPeter Maydell Add a KCS IPMI interafce on the ISA bus. This also adds a 891e2fcbf42SPeter Maydell corresponding ACPI and SMBIOS entries, if appropriate. 892e2fcbf42SPeter Maydell 893e2fcbf42SPeter Maydell ``bmc=id`` 894e2fcbf42SPeter Maydell The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern 895e2fcbf42SPeter Maydell above. 896e2fcbf42SPeter Maydell 897e2fcbf42SPeter Maydell ``ioport=val`` 898e2fcbf42SPeter Maydell Define the I/O address of the interface. The default is 0xca0 899e2fcbf42SPeter Maydell for KCS. 900e2fcbf42SPeter Maydell 901e2fcbf42SPeter Maydell ``irq=val`` 902e2fcbf42SPeter Maydell Define the interrupt to use. The default is 5. To disable 903e2fcbf42SPeter Maydell interrupts, set this to 0. 904e2fcbf42SPeter Maydell 905e2fcbf42SPeter Maydell``-device isa-ipmi-bt,bmc=id[,ioport=val][,irq=val]`` 906e2fcbf42SPeter Maydell Like the KCS interface, but defines a BT interface. The default port 907e2fcbf42SPeter Maydell is 0xe4 and the default interrupt is 5. 908323679daSCorey Minyard 909323679daSCorey Minyard``-device pci-ipmi-kcs,bmc=id`` 910323679daSCorey Minyard Add a KCS IPMI interafce on the PCI bus. 911323679daSCorey Minyard 912323679daSCorey Minyard ``bmc=id`` 913323679daSCorey Minyard The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 914323679daSCorey Minyard 915323679daSCorey Minyard``-device pci-ipmi-bt,bmc=id`` 916323679daSCorey Minyard Like the KCS interface, but defines a BT interface on the PCI bus. 917e2fcbf42SPeter MaydellERST 91810adb8beSMarkus Armbruster 91910adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 9208f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 92110adb8beSMarkus Armbruster " set the name of the guest\n" 922479a5747SRoman Bolshakov " string1 sets the window title and string2 the process name\n" 923479a5747SRoman Bolshakov " When debug-threads is enabled, individual threads are given a separate name\n" 9248f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 92510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 926e2fcbf42SPeter MaydellSRST 927e2fcbf42SPeter Maydell``-name name`` 928e2fcbf42SPeter Maydell Sets the name of the guest. This name will be displayed in the SDL 929e2fcbf42SPeter Maydell window caption. The name will also be used for the VNC server. Also 930e2fcbf42SPeter Maydell optionally set the top visible process name in Linux. Naming of 931e2fcbf42SPeter Maydell individual threads can also be enabled on Linux to aid debugging. 932e2fcbf42SPeter MaydellERST 93310adb8beSMarkus Armbruster 93410adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 93510adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 93610adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 937e2fcbf42SPeter MaydellSRST 938e2fcbf42SPeter Maydell``-uuid uuid`` 939e2fcbf42SPeter Maydell Set system UUID. 940e2fcbf42SPeter MaydellERST 94110adb8beSMarkus Armbruster 94210adb8beSMarkus ArmbrusterDEFHEADING() 94310adb8beSMarkus Armbruster 944de6b4f90SMarkus ArmbrusterDEFHEADING(Block device options:) 94510adb8beSMarkus Armbruster 9465824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 947ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 948ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 949e2fcbf42SPeter MaydellSRST 95009ce5f2dSPeter Maydell``-fda file`` 95109ce5f2dSPeter Maydell \ 95209ce5f2dSPeter Maydell``-fdb file`` 953923e9311SThomas Huth Use file as floppy disk 0/1 image (see the :ref:`disk images` chapter in 954923e9311SThomas Huth the System Emulation Users Guide). 955e2fcbf42SPeter MaydellERST 9565824d651Sblueswir1 9575824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 958ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 959ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 9605824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 961ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 962ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 963e2fcbf42SPeter MaydellSRST 96409ce5f2dSPeter Maydell``-hda file`` 96509ce5f2dSPeter Maydell \ 96609ce5f2dSPeter Maydell``-hdb file`` 96709ce5f2dSPeter Maydell \ 96809ce5f2dSPeter Maydell``-hdc file`` 96909ce5f2dSPeter Maydell \ 97009ce5f2dSPeter Maydell``-hdd file`` 971923e9311SThomas Huth Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` 972923e9311SThomas Huth chapter in the System Emulation Users Guide). 973e2fcbf42SPeter MaydellERST 9745824d651Sblueswir1 9755824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 976ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 977ad96090aSBlue Swirl QEMU_ARCH_ALL) 978e2fcbf42SPeter MaydellSRST 979e2fcbf42SPeter Maydell``-cdrom file`` 980e2fcbf42SPeter Maydell Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at 981e2fcbf42SPeter Maydell the same time). You can use the host CD-ROM by using ``/dev/cdrom`` 982e2fcbf42SPeter Maydell as filename. 983e2fcbf42SPeter MaydellERST 9845824d651Sblueswir1 98542e5f393SMarkus ArmbrusterDEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, 98642e5f393SMarkus Armbruster "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n" 98742e5f393SMarkus Armbruster " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 988c9b749d7SKevin Wolf " [,read-only=on|off][,auto-read-only=on|off]\n" 989c9b749d7SKevin Wolf " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n" 99042e5f393SMarkus Armbruster " [,driver specific parameters...]\n" 99142e5f393SMarkus Armbruster " configure a block backend\n", QEMU_ARCH_ALL) 992e2fcbf42SPeter MaydellSRST 993e2fcbf42SPeter Maydell``-blockdev option[,option[,option[,...]]]`` 994e2fcbf42SPeter Maydell Define a new block driver node. Some of the options apply to all 995e2fcbf42SPeter Maydell block drivers, other options are only accepted for a specific block 996e2fcbf42SPeter Maydell driver. See below for a list of generic options and options for the 997e2fcbf42SPeter Maydell most common block drivers. 998e2fcbf42SPeter Maydell 999e2fcbf42SPeter Maydell Options that expect a reference to another node (e.g. ``file``) can 1000e2fcbf42SPeter Maydell be given in two ways. Either you specify the node name of an already 1001e2fcbf42SPeter Maydell existing node (file=node-name), or you define a new node inline, 1002e2fcbf42SPeter Maydell adding options for the referenced node after a dot 1003e2fcbf42SPeter Maydell (file.filename=path,file.aio=native). 1004e2fcbf42SPeter Maydell 1005e2fcbf42SPeter Maydell A block driver node created with ``-blockdev`` can be used for a 1006e2fcbf42SPeter Maydell guest device by specifying its node name for the ``drive`` property 1007e2fcbf42SPeter Maydell in a ``-device`` argument that defines a block device. 1008e2fcbf42SPeter Maydell 1009e2fcbf42SPeter Maydell ``Valid options for any block driver node:`` 1010e2fcbf42SPeter Maydell ``driver`` 1011e2fcbf42SPeter Maydell Specifies the block driver to use for the given node. 1012e2fcbf42SPeter Maydell 1013e2fcbf42SPeter Maydell ``node-name`` 1014e2fcbf42SPeter Maydell This defines the name of the block driver node by which it 1015e2fcbf42SPeter Maydell will be referenced later. The name must be unique, i.e. it 1016e2fcbf42SPeter Maydell must not match the name of a different block driver node, or 1017e2fcbf42SPeter Maydell (if you use ``-drive`` as well) the ID of a drive. 1018e2fcbf42SPeter Maydell 1019e2fcbf42SPeter Maydell If no node name is specified, it is automatically generated. 1020e2fcbf42SPeter Maydell The generated node name is not intended to be predictable 1021e2fcbf42SPeter Maydell and changes between QEMU invocations. For the top level, an 1022e2fcbf42SPeter Maydell explicit node name must be specified. 1023e2fcbf42SPeter Maydell 1024e2fcbf42SPeter Maydell ``read-only`` 1025e2fcbf42SPeter Maydell Open the node read-only. Guest write attempts will fail. 1026e2fcbf42SPeter Maydell 1027e2fcbf42SPeter Maydell Note that some block drivers support only read-only access, 1028e2fcbf42SPeter Maydell either generally or in certain configurations. In this case, 1029e2fcbf42SPeter Maydell the default value ``read-only=off`` does not work and the 1030e2fcbf42SPeter Maydell option must be specified explicitly. 1031e2fcbf42SPeter Maydell 1032e2fcbf42SPeter Maydell ``auto-read-only`` 1033e2fcbf42SPeter Maydell If ``auto-read-only=on`` is set, QEMU may fall back to 1034e2fcbf42SPeter Maydell read-only usage even when ``read-only=off`` is requested, or 1035e2fcbf42SPeter Maydell even switch between modes as needed, e.g. depending on 1036e2fcbf42SPeter Maydell whether the image file is writable or whether a writing user 1037e2fcbf42SPeter Maydell is attached to the node. 1038e2fcbf42SPeter Maydell 1039e2fcbf42SPeter Maydell ``force-share`` 1040e2fcbf42SPeter Maydell Override the image locking system of QEMU by forcing the 1041e2fcbf42SPeter Maydell node to utilize weaker shared access for permissions where 1042e2fcbf42SPeter Maydell it would normally request exclusive access. When there is 1043e2fcbf42SPeter Maydell the potential for multiple instances to have the same file 1044e2fcbf42SPeter Maydell open (whether this invocation of QEMU is the first or the 1045e2fcbf42SPeter Maydell second instance), both instances must permit shared access 1046e2fcbf42SPeter Maydell for the second instance to succeed at opening the file. 1047e2fcbf42SPeter Maydell 1048e2fcbf42SPeter Maydell Enabling ``force-share=on`` requires ``read-only=on``. 1049e2fcbf42SPeter Maydell 1050e2fcbf42SPeter Maydell ``cache.direct`` 1051e2fcbf42SPeter Maydell The host page cache can be avoided with ``cache.direct=on``. 1052e2fcbf42SPeter Maydell This will attempt to do disk IO directly to the guest's 1053e2fcbf42SPeter Maydell memory. QEMU may still perform an internal copy of the data. 1054e2fcbf42SPeter Maydell 1055e2fcbf42SPeter Maydell ``cache.no-flush`` 1056e2fcbf42SPeter Maydell In case you don't care about data integrity over host 1057e2fcbf42SPeter Maydell failures, you can use ``cache.no-flush=on``. This option 1058e2fcbf42SPeter Maydell tells QEMU that it never needs to write any data to the disk 1059e2fcbf42SPeter Maydell but can instead keep things in cache. If anything goes 1060e2fcbf42SPeter Maydell wrong, like your host losing power, the disk storage getting 1061e2fcbf42SPeter Maydell disconnected accidentally, etc. your image will most 1062e2fcbf42SPeter Maydell probably be rendered unusable. 1063e2fcbf42SPeter Maydell 1064e2fcbf42SPeter Maydell ``discard=discard`` 1065e2fcbf42SPeter Maydell discard is one of "ignore" (or "off") or "unmap" (or "on") 1066e2fcbf42SPeter Maydell and controls whether ``discard`` (also known as ``trim`` or 1067e2fcbf42SPeter Maydell ``unmap``) requests are ignored or passed to the filesystem. 1068e2fcbf42SPeter Maydell Some machine types may not support discard requests. 1069e2fcbf42SPeter Maydell 1070e2fcbf42SPeter Maydell ``detect-zeroes=detect-zeroes`` 1071e2fcbf42SPeter Maydell detect-zeroes is "off", "on" or "unmap" and enables the 1072e2fcbf42SPeter Maydell automatic conversion of plain zero writes by the OS to 1073e2fcbf42SPeter Maydell driver specific optimized zero write commands. You may even 1074e2fcbf42SPeter Maydell choose "unmap" if discard is set to "unmap" to allow a zero 1075e2fcbf42SPeter Maydell write to be converted to an ``unmap`` operation. 1076e2fcbf42SPeter Maydell 1077e2fcbf42SPeter Maydell ``Driver-specific options for file`` 1078e2fcbf42SPeter Maydell This is the protocol-level block driver for accessing regular 1079e2fcbf42SPeter Maydell files. 1080e2fcbf42SPeter Maydell 1081e2fcbf42SPeter Maydell ``filename`` 1082e2fcbf42SPeter Maydell The path to the image file in the local filesystem 1083e2fcbf42SPeter Maydell 1084e2fcbf42SPeter Maydell ``aio`` 1085ad1e691dSStefano Garzarella Specifies the AIO backend (threads/native/io_uring, 1086ad1e691dSStefano Garzarella default: threads) 1087e2fcbf42SPeter Maydell 1088e2fcbf42SPeter Maydell ``locking`` 1089e2fcbf42SPeter Maydell Specifies whether the image file is protected with Linux OFD 1090e2fcbf42SPeter Maydell / POSIX locks. The default is to use the Linux Open File 1091e2fcbf42SPeter Maydell Descriptor API if available, otherwise no lock is applied. 1092e2fcbf42SPeter Maydell (auto/on/off, default: auto) 1093e2fcbf42SPeter Maydell 1094e2fcbf42SPeter Maydell Example: 1095e2fcbf42SPeter Maydell 1096e2fcbf42SPeter Maydell :: 1097e2fcbf42SPeter Maydell 1098e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk,filename=disk.img 1099e2fcbf42SPeter Maydell 1100e2fcbf42SPeter Maydell ``Driver-specific options for raw`` 1101e2fcbf42SPeter Maydell This is the image format block driver for raw images. It is 1102e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1103e2fcbf42SPeter Maydell ``file``. 1104e2fcbf42SPeter Maydell 1105e2fcbf42SPeter Maydell ``file`` 1106e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1107e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1108e2fcbf42SPeter Maydell 1109e2fcbf42SPeter Maydell Example 1: 1110e2fcbf42SPeter Maydell 1111e2fcbf42SPeter Maydell :: 1112e2fcbf42SPeter Maydell 1113e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk_file,filename=disk.img 1114e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file=disk_file 1115e2fcbf42SPeter Maydell 1116e2fcbf42SPeter Maydell Example 2: 1117e2fcbf42SPeter Maydell 1118e2fcbf42SPeter Maydell :: 1119e2fcbf42SPeter Maydell 1120e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img 1121e2fcbf42SPeter Maydell 1122e2fcbf42SPeter Maydell ``Driver-specific options for qcow2`` 1123e2fcbf42SPeter Maydell This is the image format block driver for qcow2 images. It is 1124e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1125e2fcbf42SPeter Maydell ``file``. 1126e2fcbf42SPeter Maydell 1127e2fcbf42SPeter Maydell ``file`` 1128e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1129e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1130e2fcbf42SPeter Maydell 1131e2fcbf42SPeter Maydell ``backing`` 1132e2fcbf42SPeter Maydell Reference to or definition of the backing file block device 1133e2fcbf42SPeter Maydell (default is taken from the image file). It is allowed to 1134e2fcbf42SPeter Maydell pass ``null`` here in order to disable the default backing 1135e2fcbf42SPeter Maydell file. 1136e2fcbf42SPeter Maydell 1137e2fcbf42SPeter Maydell ``lazy-refcounts`` 1138e2fcbf42SPeter Maydell Whether to enable the lazy refcounts feature (on/off; 1139e2fcbf42SPeter Maydell default is taken from the image file) 1140e2fcbf42SPeter Maydell 1141e2fcbf42SPeter Maydell ``cache-size`` 1142e2fcbf42SPeter Maydell The maximum total size of the L2 table and refcount block 1143e2fcbf42SPeter Maydell caches in bytes (default: the sum of l2-cache-size and 1144e2fcbf42SPeter Maydell refcount-cache-size) 1145e2fcbf42SPeter Maydell 1146e2fcbf42SPeter Maydell ``l2-cache-size`` 1147e2fcbf42SPeter Maydell The maximum size of the L2 table cache in bytes (default: if 1148e2fcbf42SPeter Maydell cache-size is not specified - 32M on Linux platforms, and 8M 1149e2fcbf42SPeter Maydell on non-Linux platforms; otherwise, as large as possible 1150e2fcbf42SPeter Maydell within the cache-size, while permitting the requested or the 1151e2fcbf42SPeter Maydell minimal refcount cache size) 1152e2fcbf42SPeter Maydell 1153e2fcbf42SPeter Maydell ``refcount-cache-size`` 1154e2fcbf42SPeter Maydell The maximum size of the refcount block cache in bytes 1155e2fcbf42SPeter Maydell (default: 4 times the cluster size; or if cache-size is 1156e2fcbf42SPeter Maydell specified, the part of it which is not used for the L2 1157e2fcbf42SPeter Maydell cache) 1158e2fcbf42SPeter Maydell 1159e2fcbf42SPeter Maydell ``cache-clean-interval`` 1160e2fcbf42SPeter Maydell Clean unused entries in the L2 and refcount caches. The 1161e2fcbf42SPeter Maydell interval is in seconds. The default value is 600 on 1162e2fcbf42SPeter Maydell supporting platforms, and 0 on other platforms. Setting it 1163e2fcbf42SPeter Maydell to 0 disables this feature. 1164e2fcbf42SPeter Maydell 1165e2fcbf42SPeter Maydell ``pass-discard-request`` 1166e2fcbf42SPeter Maydell Whether discard requests to the qcow2 device should be 1167e2fcbf42SPeter Maydell forwarded to the data source (on/off; default: on if 1168e2fcbf42SPeter Maydell discard=unmap is specified, off otherwise) 1169e2fcbf42SPeter Maydell 1170e2fcbf42SPeter Maydell ``pass-discard-snapshot`` 1171e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1172e2fcbf42SPeter Maydell issued when a snapshot operation (e.g. deleting a snapshot) 1173e2fcbf42SPeter Maydell frees clusters in the qcow2 file (on/off; default: on) 1174e2fcbf42SPeter Maydell 1175e2fcbf42SPeter Maydell ``pass-discard-other`` 1176e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1177e2fcbf42SPeter Maydell issued on other occasions where a cluster gets freed 1178e2fcbf42SPeter Maydell (on/off; default: off) 1179e2fcbf42SPeter Maydell 1180e2fcbf42SPeter Maydell ``overlap-check`` 1181e2fcbf42SPeter Maydell Which overlap checks to perform for writes to the image 1182e2fcbf42SPeter Maydell (none/constant/cached/all; default: cached). For details or 1183e2fcbf42SPeter Maydell finer granularity control refer to the QAPI documentation of 1184e2fcbf42SPeter Maydell ``blockdev-add``. 1185e2fcbf42SPeter Maydell 1186e2fcbf42SPeter Maydell Example 1: 1187e2fcbf42SPeter Maydell 1188e2fcbf42SPeter Maydell :: 1189e2fcbf42SPeter Maydell 1190e2fcbf42SPeter Maydell -blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2 1191e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216 1192e2fcbf42SPeter Maydell 1193e2fcbf42SPeter Maydell Example 2: 1194e2fcbf42SPeter Maydell 1195e2fcbf42SPeter Maydell :: 1196e2fcbf42SPeter Maydell 1197e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2 1198e2fcbf42SPeter Maydell 1199e2fcbf42SPeter Maydell ``Driver-specific options for other drivers`` 1200e2fcbf42SPeter Maydell Please refer to the QAPI documentation of the ``blockdev-add`` 1201e2fcbf42SPeter Maydell QMP command. 1202e2fcbf42SPeter MaydellERST 120342e5f393SMarkus Armbruster 12045824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 12055824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 120692196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 1207572023f7SKevin Wolf " [,snapshot=on|off][,rerror=ignore|stop|report]\n" 1208ad1e691dSStefano Garzarella " [,werror=ignore|stop|report|enospc][,id=name]\n" 1209ad1e691dSStefano Garzarella " [,aio=threads|native|io_uring]\n" 1210fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 12112f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 12123e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 12133e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 12143e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 12153e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 12162024c1dfSBenoît Canet " [[,iops_size=is]]\n" 121776f4afb4SAlberto Garcia " [[,group=g]]\n" 1218ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1219e2fcbf42SPeter MaydellSRST 1220e2fcbf42SPeter Maydell``-drive option[,option[,option[,...]]]`` 1221e2fcbf42SPeter Maydell Define a new drive. This includes creating a block driver node (the 1222e2fcbf42SPeter Maydell backend) as well as a guest device, and is mostly a shortcut for 1223e2fcbf42SPeter Maydell defining the corresponding ``-blockdev`` and ``-device`` options. 1224e2fcbf42SPeter Maydell 1225e2fcbf42SPeter Maydell ``-drive`` accepts all options that are accepted by ``-blockdev``. 1226e2fcbf42SPeter Maydell In addition, it knows the following options: 1227e2fcbf42SPeter Maydell 1228e2fcbf42SPeter Maydell ``file=file`` 1229923e9311SThomas Huth This option defines which disk image (see the :ref:`disk images` 1230923e9311SThomas Huth chapter in the System Emulation Users Guide) to use with this drive. 1231923e9311SThomas Huth If the filename contains comma, you must double it (for instance, 1232e2fcbf42SPeter Maydell "file=my,,file" to use file "my,file"). 1233e2fcbf42SPeter Maydell 1234e2fcbf42SPeter Maydell Special files such as iSCSI devices can be specified using 1235e2fcbf42SPeter Maydell protocol specific URLs. See the section for "Device URL Syntax" 1236e2fcbf42SPeter Maydell for more information. 1237e2fcbf42SPeter Maydell 1238e2fcbf42SPeter Maydell ``if=interface`` 1239e2fcbf42SPeter Maydell This option defines on which type on interface the drive is 1240e2fcbf42SPeter Maydell connected. Available types are: ide, scsi, sd, mtd, floppy, 1241e2fcbf42SPeter Maydell pflash, virtio, none. 1242e2fcbf42SPeter Maydell 1243e2fcbf42SPeter Maydell ``bus=bus,unit=unit`` 1244e2fcbf42SPeter Maydell These options define where is connected the drive by defining 1245e2fcbf42SPeter Maydell the bus number and the unit id. 1246e2fcbf42SPeter Maydell 1247e2fcbf42SPeter Maydell ``index=index`` 1248e2fcbf42SPeter Maydell This option defines where is connected the drive by using an 1249e2fcbf42SPeter Maydell index in the list of available connectors of a given interface 1250e2fcbf42SPeter Maydell type. 1251e2fcbf42SPeter Maydell 1252e2fcbf42SPeter Maydell ``media=media`` 1253e2fcbf42SPeter Maydell This option defines the type of the media: disk or cdrom. 1254e2fcbf42SPeter Maydell 1255e2fcbf42SPeter Maydell ``snapshot=snapshot`` 1256e2fcbf42SPeter Maydell snapshot is "on" or "off" and controls snapshot mode for the 1257e2fcbf42SPeter Maydell given drive (see ``-snapshot``). 1258e2fcbf42SPeter Maydell 1259e2fcbf42SPeter Maydell ``cache=cache`` 1260e2fcbf42SPeter Maydell cache is "none", "writeback", "unsafe", "directsync" or 1261e2fcbf42SPeter Maydell "writethrough" and controls how the host cache is used to access 1262e2fcbf42SPeter Maydell block data. This is a shortcut that sets the ``cache.direct`` 1263e2fcbf42SPeter Maydell and ``cache.no-flush`` options (as in ``-blockdev``), and 1264e2fcbf42SPeter Maydell additionally ``cache.writeback``, which provides a default for 1265e2fcbf42SPeter Maydell the ``write-cache`` option of block guest devices (as in 1266e2fcbf42SPeter Maydell ``-device``). The modes correspond to the following settings: 1267e2fcbf42SPeter Maydell 126809ce5f2dSPeter Maydell ============= =============== ============ ============== 126909ce5f2dSPeter Maydell \ cache.writeback cache.direct cache.no-flush 127009ce5f2dSPeter Maydell ============= =============== ============ ============== 127109ce5f2dSPeter Maydell writeback on off off 127209ce5f2dSPeter Maydell none on on off 127309ce5f2dSPeter Maydell writethrough off off off 127409ce5f2dSPeter Maydell directsync off on off 127509ce5f2dSPeter Maydell unsafe on off on 127609ce5f2dSPeter Maydell ============= =============== ============ ============== 1277e2fcbf42SPeter Maydell 1278e2fcbf42SPeter Maydell The default mode is ``cache=writeback``. 1279e2fcbf42SPeter Maydell 1280e2fcbf42SPeter Maydell ``aio=aio`` 1281ad1e691dSStefano Garzarella aio is "threads", "native", or "io_uring" and selects between pthread 1282ad1e691dSStefano Garzarella based disk I/O, native Linux AIO, or Linux io_uring API. 1283e2fcbf42SPeter Maydell 1284e2fcbf42SPeter Maydell ``format=format`` 1285e2fcbf42SPeter Maydell Specify which disk format will be used rather than detecting the 1286e2fcbf42SPeter Maydell format. Can be used to specify format=raw to avoid interpreting 1287e2fcbf42SPeter Maydell an untrusted format header. 1288e2fcbf42SPeter Maydell 1289e2fcbf42SPeter Maydell ``werror=action,rerror=action`` 1290e2fcbf42SPeter Maydell Specify which action to take on write and read errors. Valid 1291e2fcbf42SPeter Maydell actions are: "ignore" (ignore the error and try to continue), 1292e2fcbf42SPeter Maydell "stop" (pause QEMU), "report" (report the error to the guest), 1293e2fcbf42SPeter Maydell "enospc" (pause QEMU only if the host disk is full; report the 1294e2fcbf42SPeter Maydell error to the guest otherwise). The default setting is 1295e2fcbf42SPeter Maydell ``werror=enospc`` and ``rerror=report``. 1296e2fcbf42SPeter Maydell 1297e2fcbf42SPeter Maydell ``copy-on-read=copy-on-read`` 1298e2fcbf42SPeter Maydell copy-on-read is "on" or "off" and enables whether to copy read 1299e2fcbf42SPeter Maydell backing file sectors into the image file. 1300e2fcbf42SPeter Maydell 1301e2fcbf42SPeter Maydell ``bps=b,bps_rd=r,bps_wr=w`` 1302e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1303e2fcbf42SPeter Maydell for all request types or for reads or writes only. Small values 1304e2fcbf42SPeter Maydell can lead to timeouts or hangs inside the guest. A safe minimum 1305e2fcbf42SPeter Maydell for disks is 2 MB/s. 1306e2fcbf42SPeter Maydell 1307e2fcbf42SPeter Maydell ``bps_max=bm,bps_rd_max=rm,bps_wr_max=wm`` 1308e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1309e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1310e2fcbf42SPeter Maydell above the limit temporarily. 1311e2fcbf42SPeter Maydell 1312e2fcbf42SPeter Maydell ``iops=i,iops_rd=r,iops_wr=w`` 1313e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1314e2fcbf42SPeter Maydell all request types or for reads or writes only. 1315e2fcbf42SPeter Maydell 1316e2fcbf42SPeter Maydell ``iops_max=bm,iops_rd_max=rm,iops_wr_max=wm`` 1317e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1318e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1319e2fcbf42SPeter Maydell spike above the limit temporarily. 1320e2fcbf42SPeter Maydell 1321e2fcbf42SPeter Maydell ``iops_size=is`` 1322e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1323e2fcbf42SPeter Maydell throttling purposes. Use this option to prevent guests from 1324e2fcbf42SPeter Maydell circumventing iops limits by sending fewer but larger requests. 1325e2fcbf42SPeter Maydell 1326e2fcbf42SPeter Maydell ``group=g`` 1327e2fcbf42SPeter Maydell Join a throttling quota group with given name g. All drives that 1328e2fcbf42SPeter Maydell are members of the same group are accounted for together. Use 1329e2fcbf42SPeter Maydell this option to prevent guests from circumventing throttling 1330e2fcbf42SPeter Maydell limits by using many small disks instead of a single larger 1331e2fcbf42SPeter Maydell disk. 1332e2fcbf42SPeter Maydell 1333e2fcbf42SPeter Maydell By default, the ``cache.writeback=on`` mode is used. It will report 1334e2fcbf42SPeter Maydell data writes as completed as soon as the data is present in the host 1335e2fcbf42SPeter Maydell page cache. This is safe as long as your guest OS makes sure to 1336e2fcbf42SPeter Maydell correctly flush disk caches where needed. If your guest OS does not 1337e2fcbf42SPeter Maydell handle volatile disk write caches correctly and your host crashes or 1338e2fcbf42SPeter Maydell loses power, then the guest may experience data corruption. 1339e2fcbf42SPeter Maydell 1340e2fcbf42SPeter Maydell For such guests, you should consider using ``cache.writeback=off``. 1341e2fcbf42SPeter Maydell This means that the host page cache will be used to read and write 1342e2fcbf42SPeter Maydell data, but write notification will be sent to the guest only after 1343e2fcbf42SPeter Maydell QEMU has made sure to flush each write to the disk. Be aware that 1344e2fcbf42SPeter Maydell this has a major impact on performance. 1345e2fcbf42SPeter Maydell 1346e2fcbf42SPeter Maydell When using the ``-snapshot`` option, unsafe caching is always used. 1347e2fcbf42SPeter Maydell 1348e2fcbf42SPeter Maydell Copy-on-read avoids accessing the same backing file sectors 1349e2fcbf42SPeter Maydell repeatedly and is useful when the backing file is over a slow 1350e2fcbf42SPeter Maydell network. By default copy-on-read is off. 1351e2fcbf42SPeter Maydell 1352e2fcbf42SPeter Maydell Instead of ``-cdrom`` you can use: 1353e2fcbf42SPeter Maydell 1354e2fcbf42SPeter Maydell .. parsed-literal:: 1355e2fcbf42SPeter Maydell 1356e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=cdrom 1357e2fcbf42SPeter Maydell 1358e2fcbf42SPeter Maydell Instead of ``-hda``, ``-hdb``, ``-hdc``, ``-hdd``, you can use: 1359e2fcbf42SPeter Maydell 1360e2fcbf42SPeter Maydell .. parsed-literal:: 1361e2fcbf42SPeter Maydell 1362e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=0,media=disk 1363e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=1,media=disk 1364e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=disk 1365e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=3,media=disk 1366e2fcbf42SPeter Maydell 1367e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 1368e2fcbf42SPeter Maydell set: 1369e2fcbf42SPeter Maydell 1370e2fcbf42SPeter Maydell .. parsed-literal:: 1371e2fcbf42SPeter Maydell 1372353a06b4SLaszlo Ersek |qemu_system| \\ 1373353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 1374353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 1375e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 1376e2fcbf42SPeter Maydell 1377e2fcbf42SPeter Maydell You can connect a CDROM to the slave of ide0: 1378e2fcbf42SPeter Maydell 1379e2fcbf42SPeter Maydell .. parsed-literal:: 1380e2fcbf42SPeter Maydell 1381e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,if=ide,index=1,media=cdrom 1382e2fcbf42SPeter Maydell 1383e2fcbf42SPeter Maydell If you don't specify the "file=" argument, you define an empty 1384e2fcbf42SPeter Maydell drive: 1385e2fcbf42SPeter Maydell 1386e2fcbf42SPeter Maydell .. parsed-literal:: 1387e2fcbf42SPeter Maydell 1388e2fcbf42SPeter Maydell |qemu_system_x86| -drive if=ide,index=1,media=cdrom 1389e2fcbf42SPeter Maydell 1390e2fcbf42SPeter Maydell Instead of ``-fda``, ``-fdb``, you can use: 1391e2fcbf42SPeter Maydell 1392e2fcbf42SPeter Maydell .. parsed-literal:: 1393e2fcbf42SPeter Maydell 1394e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=0,if=floppy 1395e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=1,if=floppy 1396e2fcbf42SPeter Maydell 1397e2fcbf42SPeter Maydell By default, interface is "ide" and index is automatically 1398e2fcbf42SPeter Maydell incremented: 1399e2fcbf42SPeter Maydell 1400e2fcbf42SPeter Maydell .. parsed-literal:: 1401e2fcbf42SPeter Maydell 1402e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=a -drive file=b" 1403e2fcbf42SPeter Maydell 1404e2fcbf42SPeter Maydell is interpreted like: 1405e2fcbf42SPeter Maydell 1406e2fcbf42SPeter Maydell .. parsed-literal:: 1407e2fcbf42SPeter Maydell 1408e2fcbf42SPeter Maydell |qemu_system_x86| -hda a -hdb b 1409e2fcbf42SPeter MaydellERST 14105824d651Sblueswir1 14115824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 1412ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 1413ad96090aSBlue Swirl QEMU_ARCH_ALL) 1414e2fcbf42SPeter MaydellSRST 1415e2fcbf42SPeter Maydell``-mtdblock file`` 1416e2fcbf42SPeter Maydell Use file as on-board Flash memory image. 1417e2fcbf42SPeter MaydellERST 14185824d651Sblueswir1 14195824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 1420ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 1421e2fcbf42SPeter MaydellSRST 1422e2fcbf42SPeter Maydell``-sd file`` 1423e2fcbf42SPeter Maydell Use file as SecureDigital card image. 1424e2fcbf42SPeter MaydellERST 14255824d651Sblueswir1 14265824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 1427ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 1428e2fcbf42SPeter MaydellSRST 1429e2fcbf42SPeter Maydell``-pflash file`` 1430e2fcbf42SPeter Maydell Use file as a parallel flash image. 1431e2fcbf42SPeter MaydellERST 14325824d651Sblueswir1 14335824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 1434ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 1435ad96090aSBlue Swirl QEMU_ARCH_ALL) 1436e2fcbf42SPeter MaydellSRST 1437e2fcbf42SPeter Maydell``-snapshot`` 1438e2fcbf42SPeter Maydell Write to temporary files instead of disk image files. In this case, 1439e2fcbf42SPeter Maydell the raw disk image you use is not written back. You can however 1440923e9311SThomas Huth force the write back by pressing C-a s (see the :ref:`disk images` 1441923e9311SThomas Huth chapter in the System Emulation Users Guide). 1442e2fcbf42SPeter MaydellERST 14435824d651Sblueswir1 144474db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 1445b44a6b09SGreg Kurz "-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1446991c180dSPaolo Bonzini " [,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode]\n" 1447b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n" 1448b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n" 1449b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n" 1450b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n" 1451b44a6b09SGreg Kurz " [[,throttling.iops-size=is]]\n" 1452991c180dSPaolo Bonzini "-fsdev proxy,id=id,socket=socket[,writeout=immediate][,readonly=on]\n" 1453991c180dSPaolo Bonzini "-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=immediate][,readonly=on]\n" 1454b44a6b09SGreg Kurz "-fsdev synth,id=id\n", 145574db920cSGautham R Shenoy QEMU_ARCH_ALL) 145674db920cSGautham R Shenoy 1457e2fcbf42SPeter MaydellSRST 1458991c180dSPaolo Bonzini``-fsdev local,id=id,path=path,security_model=security_model [,writeout=writeout][,readonly=on][,fmode=fmode][,dmode=dmode] [,throttling.option=value[,throttling.option=value[,...]]]`` 145909ce5f2dSPeter Maydell \ 1460991c180dSPaolo Bonzini``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly=on]`` 146109ce5f2dSPeter Maydell \ 1462991c180dSPaolo Bonzini``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly=on]`` 146309ce5f2dSPeter Maydell \ 1464991c180dSPaolo Bonzini``-fsdev synth,id=id[,readonly=on]`` 1465e2fcbf42SPeter Maydell Define a new file system device. Valid options are: 1466e2fcbf42SPeter Maydell 1467e2fcbf42SPeter Maydell ``local`` 1468e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1469e2fcbf42SPeter Maydell 1470e2fcbf42SPeter Maydell ``proxy`` 1471e2fcbf42SPeter Maydell Accesses to the filesystem are done by virtfs-proxy-helper(1). 1472e2fcbf42SPeter Maydell 1473e2fcbf42SPeter Maydell ``synth`` 1474e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1475e2fcbf42SPeter Maydell 1476e2fcbf42SPeter Maydell ``id=id`` 1477e2fcbf42SPeter Maydell Specifies identifier for this device. 1478e2fcbf42SPeter Maydell 1479e2fcbf42SPeter Maydell ``path=path`` 1480e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1481e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1482e2fcbf42SPeter Maydell 1483e2fcbf42SPeter Maydell ``security_model=security_model`` 1484e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1485e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1486e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1487e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1488e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1489e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1490e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1491e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1492e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1493e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1494e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1495e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1496e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1497e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1498e2fcbf42SPeter Maydell parameter. 1499e2fcbf42SPeter Maydell 1500e2fcbf42SPeter Maydell ``writeout=writeout`` 1501e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1502e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1503e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1504e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1505e2fcbf42SPeter Maydell storage subsystem. 1506e2fcbf42SPeter Maydell 1507991c180dSPaolo Bonzini ``readonly=on`` 1508e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1509e2fcbf42SPeter Maydell default read-write access is given. 1510e2fcbf42SPeter Maydell 1511e2fcbf42SPeter Maydell ``socket=socket`` 1512e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1513e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). 1514e2fcbf42SPeter Maydell 1515e2fcbf42SPeter Maydell ``sock_fd=sock_fd`` 1516e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket descriptor 1517e2fcbf42SPeter Maydell for communicating with virtfs-proxy-helper(1). Usually a helper 1518e2fcbf42SPeter Maydell like libvirt will create socketpair and pass one of the fds as 1519e2fcbf42SPeter Maydell sock\_fd. 1520e2fcbf42SPeter Maydell 1521e2fcbf42SPeter Maydell ``fmode=fmode`` 1522e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1523e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1524e2fcbf42SPeter Maydell "mapped-file". 1525e2fcbf42SPeter Maydell 1526e2fcbf42SPeter Maydell ``dmode=dmode`` 1527e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1528e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1529e2fcbf42SPeter Maydell "mapped-file". 1530e2fcbf42SPeter Maydell 1531e2fcbf42SPeter Maydell ``throttling.bps-total=b,throttling.bps-read=r,throttling.bps-write=w`` 1532e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1533e2fcbf42SPeter Maydell for all request types or for reads or writes only. 1534e2fcbf42SPeter Maydell 1535e2fcbf42SPeter Maydell ``throttling.bps-total-max=bm,bps-read-max=rm,bps-write-max=wm`` 1536e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1537e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1538e2fcbf42SPeter Maydell above the limit temporarily. 1539e2fcbf42SPeter Maydell 1540e2fcbf42SPeter Maydell ``throttling.iops-total=i,throttling.iops-read=r, throttling.iops-write=w`` 1541e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1542e2fcbf42SPeter Maydell all request types or for reads or writes only. 1543e2fcbf42SPeter Maydell 1544e2fcbf42SPeter Maydell ``throttling.iops-total-max=im,throttling.iops-read-max=irm, throttling.iops-write-max=iwm`` 1545e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1546e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1547e2fcbf42SPeter Maydell spike above the limit temporarily. 1548e2fcbf42SPeter Maydell 1549e2fcbf42SPeter Maydell ``throttling.iops-size=is`` 1550e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1551e2fcbf42SPeter Maydell throttling purposes. 1552e2fcbf42SPeter Maydell 1553e2fcbf42SPeter Maydell -fsdev option is used along with -device driver "virtio-9p-...". 1554e2fcbf42SPeter Maydell 1555e2fcbf42SPeter Maydell``-device virtio-9p-type,fsdev=id,mount_tag=mount_tag`` 1556e2fcbf42SPeter Maydell Options for virtio-9p-... driver are: 1557e2fcbf42SPeter Maydell 1558e2fcbf42SPeter Maydell ``type`` 1559e2fcbf42SPeter Maydell Specifies the variant to be used. Supported values are "pci", 1560e2fcbf42SPeter Maydell "ccw" or "device", depending on the machine type. 1561e2fcbf42SPeter Maydell 1562e2fcbf42SPeter Maydell ``fsdev=id`` 1563e2fcbf42SPeter Maydell Specifies the id value specified along with -fsdev option. 1564e2fcbf42SPeter Maydell 1565e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1566e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1567e2fcbf42SPeter Maydell export point. 1568e2fcbf42SPeter MaydellERST 156974db920cSGautham R Shenoy 15703d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 1571b44a6b09SGreg Kurz "-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1572991c180dSPaolo Bonzini " [,id=id][,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode][,multidevs=remap|forbid|warn]\n" 1573991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,socket=socket[,id=id][,writeout=immediate][,readonly=on]\n" 1574991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,sock_fd=sock_fd[,id=id][,writeout=immediate][,readonly=on]\n" 1575991c180dSPaolo Bonzini "-virtfs synth,mount_tag=tag[,id=id][,readonly=on]\n", 15763d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 15773d54abc7SGautham R Shenoy 1578e2fcbf42SPeter MaydellSRST 1579991c180dSPaolo Bonzini``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly=on] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]`` 158009ce5f2dSPeter Maydell \ 1581991c180dSPaolo Bonzini``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 158209ce5f2dSPeter Maydell \ 1583991c180dSPaolo Bonzini``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 158409ce5f2dSPeter Maydell \ 158509ce5f2dSPeter Maydell``-virtfs synth,mount_tag=mount_tag`` 158665abaa01SChristian Schoenebeck Define a new virtual filesystem device and expose it to the guest using 158765abaa01SChristian Schoenebeck a virtio-9p-device (a.k.a. 9pfs), which essentially means that a certain 158865abaa01SChristian Schoenebeck directory on host is made directly accessible by guest as a pass-through 158965abaa01SChristian Schoenebeck file system by using the 9P network protocol for communication between 159065abaa01SChristian Schoenebeck host and guests, if desired even accessible, shared by several guests 159165abaa01SChristian Schoenebeck simultaniously. 159265abaa01SChristian Schoenebeck 159365abaa01SChristian Schoenebeck Note that ``-virtfs`` is actually just a convenience shortcut for its 159465abaa01SChristian Schoenebeck generalized form ``-fsdev -device virtio-9p-pci``. 159565abaa01SChristian Schoenebeck 159665abaa01SChristian Schoenebeck The general form of pass-through file system options are: 1597e2fcbf42SPeter Maydell 1598e2fcbf42SPeter Maydell ``local`` 1599e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1600e2fcbf42SPeter Maydell 1601e2fcbf42SPeter Maydell ``proxy`` 1602e2fcbf42SPeter Maydell Accesses to the filesystem are done by virtfs-proxy-helper(1). 1603e2fcbf42SPeter Maydell 1604e2fcbf42SPeter Maydell ``synth`` 1605e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1606e2fcbf42SPeter Maydell 1607e2fcbf42SPeter Maydell ``id=id`` 1608e2fcbf42SPeter Maydell Specifies identifier for the filesystem device 1609e2fcbf42SPeter Maydell 1610e2fcbf42SPeter Maydell ``path=path`` 1611e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1612e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1613e2fcbf42SPeter Maydell 1614e2fcbf42SPeter Maydell ``security_model=security_model`` 1615e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1616e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1617e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1618e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1619e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1620e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1621e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1622e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1623e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1624e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1625e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1626e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1627e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1628e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1629e2fcbf42SPeter Maydell parameter. 1630e2fcbf42SPeter Maydell 1631e2fcbf42SPeter Maydell ``writeout=writeout`` 1632e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1633e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1634e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1635e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1636e2fcbf42SPeter Maydell storage subsystem. 1637e2fcbf42SPeter Maydell 1638991c180dSPaolo Bonzini ``readonly=on`` 1639e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1640e2fcbf42SPeter Maydell default read-write access is given. 1641e2fcbf42SPeter Maydell 1642e2fcbf42SPeter Maydell ``socket=socket`` 1643e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1644e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). Usually a helper like 1645e2fcbf42SPeter Maydell libvirt will create socketpair and pass one of the fds as 1646e2fcbf42SPeter Maydell sock\_fd. 1647e2fcbf42SPeter Maydell 1648e2fcbf42SPeter Maydell ``sock_fd`` 1649e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed 'sock\_fd' as the 1650e2fcbf42SPeter Maydell socket descriptor for interfacing with virtfs-proxy-helper(1). 1651e2fcbf42SPeter Maydell 1652e2fcbf42SPeter Maydell ``fmode=fmode`` 1653e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1654e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1655e2fcbf42SPeter Maydell "mapped-file". 1656e2fcbf42SPeter Maydell 1657e2fcbf42SPeter Maydell ``dmode=dmode`` 1658e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1659e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1660e2fcbf42SPeter Maydell "mapped-file". 1661e2fcbf42SPeter Maydell 1662e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1663e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1664e2fcbf42SPeter Maydell export point. 1665e2fcbf42SPeter Maydell 1666e2fcbf42SPeter Maydell ``multidevs=multidevs`` 1667e2fcbf42SPeter Maydell Specifies how to deal with multiple devices being shared with a 1668e2fcbf42SPeter Maydell 9p export. Supported behaviours are either "remap", "forbid" or 1669e2fcbf42SPeter Maydell "warn". The latter is the default behaviour on which virtfs 9p 1670e2fcbf42SPeter Maydell expects only one device to be shared with the same export, and 1671e2fcbf42SPeter Maydell if more than one device is shared and accessed via the same 9p 1672e2fcbf42SPeter Maydell export then only a warning message is logged (once) by qemu on 1673e2fcbf42SPeter Maydell host side. In order to avoid file ID collisions on guest you 1674e2fcbf42SPeter Maydell should either create a separate virtfs export for each device to 1675e2fcbf42SPeter Maydell be shared with guests (recommended way) or you might use "remap" 1676e2fcbf42SPeter Maydell instead which allows you to share multiple devices with only one 1677e2fcbf42SPeter Maydell export instead, which is achieved by remapping the original 1678e2fcbf42SPeter Maydell inode numbers from host to guest in a way that would prevent 1679e2fcbf42SPeter Maydell such collisions. Remapping inodes in such use cases is required 1680e2fcbf42SPeter Maydell because the original device IDs from host are never passed and 1681e2fcbf42SPeter Maydell exposed on guest. Instead all files of an export shared with 1682e2fcbf42SPeter Maydell virtfs always share the same device id on guest. So two files 1683e2fcbf42SPeter Maydell with identical inode numbers but from actually different devices 1684e2fcbf42SPeter Maydell on host would otherwise cause a file ID collision and hence 1685e2fcbf42SPeter Maydell potential misbehaviours on guest. "forbid" on the other hand 1686e2fcbf42SPeter Maydell assumes like "warn" that only one device is shared by the same 1687e2fcbf42SPeter Maydell export, however it will not only log a warning message but also 1688e2fcbf42SPeter Maydell deny access to additional devices on guest. Note though that 1689e2fcbf42SPeter Maydell "forbid" does currently not block all possible file access 1690e2fcbf42SPeter Maydell operations (e.g. readdir() would still return entries from other 1691e2fcbf42SPeter Maydell devices). 1692e2fcbf42SPeter MaydellERST 16933d54abc7SGautham R Shenoy 169461d70487SMarkus ArmbrusterDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 169561d70487SMarkus Armbruster "-iscsi [user=user][,password=password]\n" 169661d70487SMarkus Armbruster " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 169761d70487SMarkus Armbruster " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 169861d70487SMarkus Armbruster " [,timeout=timeout]\n" 169961d70487SMarkus Armbruster " iSCSI session parameters\n", QEMU_ARCH_ALL) 170061d70487SMarkus Armbruster 1701e2fcbf42SPeter MaydellSRST 1702e2fcbf42SPeter Maydell``-iscsi`` 1703e2fcbf42SPeter Maydell Configure iSCSI session parameters. 1704e2fcbf42SPeter MaydellERST 170544743148SMarkus Armbruster 17065824d651Sblueswir1DEFHEADING() 17075824d651Sblueswir1 1708c2a34ab2SThomas HuthDEFHEADING(USB convenience options:) 170910adb8beSMarkus Armbruster 171010adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 171173f46fefSStefan Hajnoczi "-usb enable on-board USB host controller (if not enabled by default)\n", 171210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1713e2fcbf42SPeter MaydellSRST 1714e2fcbf42SPeter Maydell``-usb`` 1715e2fcbf42SPeter Maydell Enable USB emulation on machine types with an on-board USB host 1716e2fcbf42SPeter Maydell controller (if not enabled by default). Note that on-board USB host 1717e2fcbf42SPeter Maydell controllers may not support USB 3.0. In this case 1718e2fcbf42SPeter Maydell ``-device qemu-xhci`` can be used instead on machines with PCI. 1719e2fcbf42SPeter MaydellERST 172010adb8beSMarkus Armbruster 172110adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 172210adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 172310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1724e2fcbf42SPeter MaydellSRST 1725e2fcbf42SPeter Maydell``-usbdevice devname`` 1726c2a34ab2SThomas Huth Add the USB device devname, and enable an on-board USB controller 1727c2a34ab2SThomas Huth if possible and necessary (just like it can be done via 1728c2a34ab2SThomas Huth ``-machine usb=on``). Note that this option is mainly intended for 1729c2a34ab2SThomas Huth the user's convenience only. More fine-grained control can be 1730c2a34ab2SThomas Huth achieved by selecting a USB host controller (if necessary) and the 1731c2a34ab2SThomas Huth desired USB device via the ``-device`` option instead. For example, 1732c2a34ab2SThomas Huth instead of using ``-usbdevice mouse`` it is possible to use 1733c2a34ab2SThomas Huth ``-device qemu-xhci -device usb-mouse`` to connect the USB mouse 1734c2a34ab2SThomas Huth to a USB 3.0 controller instead (at least on machines that support 1735c2a34ab2SThomas Huth PCI and do not have an USB controller enabled by default yet). 1736c2a34ab2SThomas Huth For more details, see the chapter about 1737923e9311SThomas Huth :ref:`Connecting USB devices` in the System Emulation Users Guide. 1738c2a34ab2SThomas Huth Possible devices for devname are: 1739c2a34ab2SThomas Huth 1740c2a34ab2SThomas Huth ``braille`` 1741c2a34ab2SThomas Huth Braille device. This will use BrlAPI to display the braille 1742c2a34ab2SThomas Huth output on a real or fake device (i.e. it also creates a 1743c2a34ab2SThomas Huth corresponding ``braille`` chardev automatically beside the 1744c2a34ab2SThomas Huth ``usb-braille`` USB device). 1745c2a34ab2SThomas Huth 1746c2a34ab2SThomas Huth ``ccid`` 1747c2a34ab2SThomas Huth Smartcard reader device 1748c2a34ab2SThomas Huth 1749c2a34ab2SThomas Huth ``keyboard`` 1750c2a34ab2SThomas Huth Standard USB keyboard. Will override the PS/2 keyboard (if present). 1751e2fcbf42SPeter Maydell 1752e2fcbf42SPeter Maydell ``mouse`` 1753e2fcbf42SPeter Maydell Virtual Mouse. This will override the PS/2 mouse emulation when 1754e2fcbf42SPeter Maydell activated. 1755e2fcbf42SPeter Maydell 1756e2fcbf42SPeter Maydell ``tablet`` 1757e2fcbf42SPeter Maydell Pointer device that uses absolute coordinates (like a 1758e2fcbf42SPeter Maydell touchscreen). This means QEMU is able to report the mouse 1759e2fcbf42SPeter Maydell position without having to grab the mouse. Also overrides the 1760e2fcbf42SPeter Maydell PS/2 mouse emulation when activated. 1761e2fcbf42SPeter Maydell 1762c2a34ab2SThomas Huth ``wacom-tablet`` 1763c2a34ab2SThomas Huth Wacom PenPartner USB tablet. 1764c2a34ab2SThomas Huth 1765c2a34ab2SThomas Huth 1766e2fcbf42SPeter MaydellERST 176710adb8beSMarkus Armbruster 176810adb8beSMarkus ArmbrusterDEFHEADING() 176910adb8beSMarkus Armbruster 1770de6b4f90SMarkus ArmbrusterDEFHEADING(Display options:) 17715824d651Sblueswir1 17721472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 177388b40c68SThomas Huth#if defined(CONFIG_SPICE) 1774d8aec9d9SMarc-André Lureau "-display spice-app[,gl=on|off]\n" 177588b40c68SThomas Huth#endif 177688b40c68SThomas Huth#if defined(CONFIG_SDL) 177788b40c68SThomas Huth "-display sdl[,alt_grab=on|off][,ctrl_grab=on|off]\n" 17784867e47cSElie Tournier " [,window_close=on|off][,gl=on|core|es|off]\n" 177988b40c68SThomas Huth#endif 178088b40c68SThomas Huth#if defined(CONFIG_GTK) 1781f04ec5afSRobert Ho "-display gtk[,grab_on_hover=on|off][,gl=on|off]|\n" 178288b40c68SThomas Huth#endif 178388b40c68SThomas Huth#if defined(CONFIG_VNC) 1784f04ec5afSRobert Ho "-display vnc=<display>[,<optargs>]\n" 178588b40c68SThomas Huth#endif 178688b40c68SThomas Huth#if defined(CONFIG_CURSES) 17872f8b7cd5SSamuel Thibault "-display curses[,charset=<encoding>]\n" 178888b40c68SThomas Huth#endif 178988b40c68SThomas Huth#if defined(CONFIG_OPENGL) 179088b40c68SThomas Huth "-display egl-headless[,rendernode=<file>]\n" 179188b40c68SThomas Huth#endif 1792144aaa99SErik Skultety "-display none\n" 179388b40c68SThomas Huth " select display backend type\n" 1794f04ec5afSRobert Ho " The default display is equivalent to\n " 1795f04ec5afSRobert Ho#if defined(CONFIG_GTK) 179688b40c68SThomas Huth "\"-display gtk\"\n" 1797f04ec5afSRobert Ho#elif defined(CONFIG_SDL) 179888b40c68SThomas Huth "\"-display sdl\"\n" 1799f04ec5afSRobert Ho#elif defined(CONFIG_COCOA) 180088b40c68SThomas Huth "\"-display cocoa\"\n" 1801f04ec5afSRobert Ho#elif defined(CONFIG_VNC) 180288b40c68SThomas Huth "\"-vnc localhost:0,to=99,id=default\"\n" 1803f04ec5afSRobert Ho#else 180488b40c68SThomas Huth "\"-display none\"\n" 1805f04ec5afSRobert Ho#endif 1806f04ec5afSRobert Ho , QEMU_ARCH_ALL) 1807e2fcbf42SPeter MaydellSRST 1808e2fcbf42SPeter Maydell``-display type`` 1809e2fcbf42SPeter Maydell Select type of display to use. This option is a replacement for the 1810e2fcbf42SPeter Maydell old style -sdl/-curses/... options. Use ``-display help`` to list 1811e2fcbf42SPeter Maydell the available display types. Valid values for type are 1812e2fcbf42SPeter Maydell 1813e2fcbf42SPeter Maydell ``sdl`` 1814e2fcbf42SPeter Maydell Display video output via SDL (usually in a separate graphics 1815e2fcbf42SPeter Maydell window; see the SDL documentation for other possibilities). 1816e2fcbf42SPeter Maydell 1817e2fcbf42SPeter Maydell ``curses`` 1818e2fcbf42SPeter Maydell Display video output via curses. For graphics device models 1819e2fcbf42SPeter Maydell which support a text mode, QEMU can display this output using a 1820e2fcbf42SPeter Maydell curses/ncurses interface. Nothing is displayed when the graphics 1821e2fcbf42SPeter Maydell device is in graphical mode or if the graphics device does not 1822e2fcbf42SPeter Maydell support a text mode. Generally only the VGA device models 1823e2fcbf42SPeter Maydell support text mode. The font charset used by the guest can be 1824e2fcbf42SPeter Maydell specified with the ``charset`` option, for example 1825e2fcbf42SPeter Maydell ``charset=CP850`` for IBM CP850 encoding. The default is 1826e2fcbf42SPeter Maydell ``CP437``. 1827e2fcbf42SPeter Maydell 1828e2fcbf42SPeter Maydell ``none`` 1829e2fcbf42SPeter Maydell Do not display video output. The guest will still see an 1830e2fcbf42SPeter Maydell emulated graphics card, but its output will not be displayed to 1831e2fcbf42SPeter Maydell the QEMU user. This option differs from the -nographic option in 1832e2fcbf42SPeter Maydell that it only affects what is done with video output; -nographic 1833e2fcbf42SPeter Maydell also changes the destination of the serial and parallel port 1834e2fcbf42SPeter Maydell data. 1835e2fcbf42SPeter Maydell 1836e2fcbf42SPeter Maydell ``gtk`` 1837e2fcbf42SPeter Maydell Display video output in a GTK window. This interface provides 1838e2fcbf42SPeter Maydell drop-down menus and other UI elements to configure and control 1839e2fcbf42SPeter Maydell the VM during runtime. 1840e2fcbf42SPeter Maydell 1841e2fcbf42SPeter Maydell ``vnc`` 1842e2fcbf42SPeter Maydell Start a VNC server on display <arg> 1843e2fcbf42SPeter Maydell 1844e2fcbf42SPeter Maydell ``egl-headless`` 1845e2fcbf42SPeter Maydell Offload all OpenGL operations to a local DRI device. For any 1846e2fcbf42SPeter Maydell graphical display, this display needs to be paired with either 1847e2fcbf42SPeter Maydell VNC or SPICE displays. 1848e2fcbf42SPeter Maydell 1849e2fcbf42SPeter Maydell ``spice-app`` 1850e2fcbf42SPeter Maydell Start QEMU as a Spice server and launch the default Spice client 1851e2fcbf42SPeter Maydell application. The Spice server will redirect the serial consoles 1852e2fcbf42SPeter Maydell and QEMU monitors. (Since 4.0) 1853e2fcbf42SPeter MaydellERST 18541472a95bSJes Sorensen 18555824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 1856ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 1857ad96090aSBlue Swirl QEMU_ARCH_ALL) 1858e2fcbf42SPeter MaydellSRST 1859e2fcbf42SPeter Maydell``-nographic`` 1860e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 1861e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 1862e2fcbf42SPeter Maydell monitor in a window. With this option, you can totally disable 1863e2fcbf42SPeter Maydell graphical output so that QEMU is a simple command line application. 1864e2fcbf42SPeter Maydell The emulated serial port is redirected on the console and muxed with 1865e2fcbf42SPeter Maydell the monitor (unless redirected elsewhere explicitly). Therefore, you 1866e2fcbf42SPeter Maydell can still use QEMU to debug a Linux kernel with a serial console. 1867e2fcbf42SPeter Maydell Use C-a h for help on switching between the console and monitor. 1868e2fcbf42SPeter MaydellERST 18695824d651Sblueswir1 18705824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 1871f04ec5afSRobert Ho "-curses shorthand for -display curses\n", 1872ad96090aSBlue Swirl QEMU_ARCH_ALL) 1873e2fcbf42SPeter MaydellSRST 1874e2fcbf42SPeter Maydell``-curses`` 1875e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 1876e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 1877e2fcbf42SPeter Maydell monitor in a window. With this option, QEMU can display the VGA 1878e2fcbf42SPeter Maydell output when in text mode using a curses/ncurses interface. Nothing 1879e2fcbf42SPeter Maydell is displayed in graphical mode. 1880e2fcbf42SPeter MaydellERST 18815824d651Sblueswir1 18825824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 1883ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 1884ad96090aSBlue Swirl QEMU_ARCH_ALL) 1885e2fcbf42SPeter MaydellSRST 1886e2fcbf42SPeter Maydell``-alt-grab`` 1887e2fcbf42SPeter Maydell Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that 1888e2fcbf42SPeter Maydell this also affects the special keys (for fullscreen, monitor-mode 1889e2fcbf42SPeter Maydell switching, etc). 1890e2fcbf42SPeter MaydellERST 18915824d651Sblueswir1 18920ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 1893ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 1894ad96090aSBlue Swirl QEMU_ARCH_ALL) 1895e2fcbf42SPeter MaydellSRST 1896e2fcbf42SPeter Maydell``-ctrl-grab`` 1897e2fcbf42SPeter Maydell Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this 1898e2fcbf42SPeter Maydell also affects the special keys (for fullscreen, monitor-mode 1899e2fcbf42SPeter Maydell switching, etc). 1900e2fcbf42SPeter MaydellERST 19010ca9f8a4SDustin Kirkland 19025824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 1903ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 1904e2fcbf42SPeter MaydellSRST 1905e2fcbf42SPeter Maydell``-no-quit`` 1906e2fcbf42SPeter Maydell Disable SDL window close capability. 1907e2fcbf42SPeter MaydellERST 19085824d651Sblueswir1 19095824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 1910f04ec5afSRobert Ho "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL) 1911e2fcbf42SPeter MaydellSRST 1912e2fcbf42SPeter Maydell``-sdl`` 1913e2fcbf42SPeter Maydell Enable SDL. 1914e2fcbf42SPeter MaydellERST 19155824d651Sblueswir1 191629b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 191727af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 191827af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 191927af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 1920a9daa36aSDaniel P. Berrangé " [,x509-dh-key-file=<file>][,addr=addr]\n" 1921a9daa36aSDaniel P. Berrangé " [,ipv4=on|off][,ipv6=on|off][,unix=on|off]\n" 192227af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 192327af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 192427af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 192599522f69SDaniel P. Berrangé " [,sasl=on|off][,disable-ticketing=on|off]\n" 192699522f69SDaniel P. Berrangé " [,password=<string>][,password-secret=<secret-id>]\n" 192727af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 192827af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 192927af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 1930a9daa36aSDaniel P. Berrangé " [,streaming-video=[off|all|filter]][,disable-copy-paste=on|off]\n" 1931a9daa36aSDaniel P. Berrangé " [,disable-agent-file-xfer=on|off][,agent-mouse=[on|off]]\n" 19325ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 19337b525508SMarc-André Lureau " [,gl=[on|off]][,rendernode=<file>]\n" 193427af7788SYonit Halperin " enable spice\n" 193527af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 193627af7788SYonit Halperin QEMU_ARCH_ALL) 1937e2fcbf42SPeter MaydellSRST 1938e2fcbf42SPeter Maydell``-spice option[,option[,...]]`` 1939e2fcbf42SPeter Maydell Enable the spice remote desktop protocol. Valid options are 1940e2fcbf42SPeter Maydell 1941e2fcbf42SPeter Maydell ``port=<nr>`` 1942e2fcbf42SPeter Maydell Set the TCP port spice is listening on for plaintext channels. 1943e2fcbf42SPeter Maydell 1944e2fcbf42SPeter Maydell ``addr=<addr>`` 1945e2fcbf42SPeter Maydell Set the IP address spice is listening on. Default is any 1946e2fcbf42SPeter Maydell address. 1947e2fcbf42SPeter Maydell 1948a9daa36aSDaniel P. Berrangé ``ipv4=on|off``; \ ``ipv6=on|off``; \ ``unix=on|off`` 1949e2fcbf42SPeter Maydell Force using the specified IP version. 1950e2fcbf42SPeter Maydell 195199522f69SDaniel P. Berrangé ``password=<string>`` 1952e2fcbf42SPeter Maydell Set the password you need to authenticate. 1953e2fcbf42SPeter Maydell 1954c47c0bcbSDaniel P. Berrangé This option is deprecated and insecure because it leaves the 1955c47c0bcbSDaniel P. Berrangé password visible in the process listing. Use ``password-secret`` 1956c47c0bcbSDaniel P. Berrangé instead. 1957c47c0bcbSDaniel P. Berrangé 195899522f69SDaniel P. Berrangé ``password-secret=<secret-id>`` 195999522f69SDaniel P. Berrangé Set the ID of the ``secret`` object containing the password 196099522f69SDaniel P. Berrangé you need to authenticate. 196199522f69SDaniel P. Berrangé 1962a9daa36aSDaniel P. Berrangé ``sasl=on|off`` 1963e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the spice. 1964e2fcbf42SPeter Maydell The exact choice of authentication method used is controlled 1965e2fcbf42SPeter Maydell from the system / user's SASL configuration file for the 'qemu' 1966e2fcbf42SPeter Maydell service. This is typically found in /etc/sasl2/qemu.conf. If 1967e2fcbf42SPeter Maydell running QEMU as an unprivileged user, an environment variable 1968e2fcbf42SPeter Maydell SASL\_CONF\_PATH can be used to make it search alternate 1969e2fcbf42SPeter Maydell locations for the service config. While some SASL auth methods 1970e2fcbf42SPeter Maydell can also provide data encryption (eg GSSAPI), it is recommended 1971e2fcbf42SPeter Maydell that SASL always be combined with the 'tls' and 'x509' settings 1972e2fcbf42SPeter Maydell to enable use of SSL and server certificates. This ensures a 1973e2fcbf42SPeter Maydell data encryption preventing compromise of authentication 1974e2fcbf42SPeter Maydell credentials. 1975e2fcbf42SPeter Maydell 1976a9daa36aSDaniel P. Berrangé ``disable-ticketing=on|off`` 1977e2fcbf42SPeter Maydell Allow client connects without authentication. 1978e2fcbf42SPeter Maydell 1979a9daa36aSDaniel P. Berrangé ``disable-copy-paste=on|off`` 1980e2fcbf42SPeter Maydell Disable copy paste between the client and the guest. 1981e2fcbf42SPeter Maydell 1982a9daa36aSDaniel P. Berrangé ``disable-agent-file-xfer=on|off`` 1983e2fcbf42SPeter Maydell Disable spice-vdagent based file-xfer between the client and the 1984e2fcbf42SPeter Maydell guest. 1985e2fcbf42SPeter Maydell 1986e2fcbf42SPeter Maydell ``tls-port=<nr>`` 1987e2fcbf42SPeter Maydell Set the TCP port spice is listening on for encrypted channels. 1988e2fcbf42SPeter Maydell 1989e2fcbf42SPeter Maydell ``x509-dir=<dir>`` 1990e2fcbf42SPeter Maydell Set the x509 file directory. Expects same filenames as -vnc 1991e2fcbf42SPeter Maydell $display,x509=$dir 1992e2fcbf42SPeter Maydell 1993e2fcbf42SPeter Maydell ``x509-key-file=<file>``; \ ``x509-key-password=<file>``; \ ``x509-cert-file=<file>``; \ ``x509-cacert-file=<file>``; \ ``x509-dh-key-file=<file>`` 1994e2fcbf42SPeter Maydell The x509 file names can also be configured individually. 1995e2fcbf42SPeter Maydell 1996e2fcbf42SPeter Maydell ``tls-ciphers=<list>`` 1997e2fcbf42SPeter Maydell Specify which ciphers to use. 1998e2fcbf42SPeter Maydell 1999e2fcbf42SPeter Maydell ``tls-channel=[main|display|cursor|inputs|record|playback]``; \ ``plaintext-channel=[main|display|cursor|inputs|record|playback]`` 2000e2fcbf42SPeter Maydell Force specific channel to be used with or without TLS 2001e2fcbf42SPeter Maydell encryption. The options can be specified multiple times to 2002e2fcbf42SPeter Maydell configure multiple channels. The special name "default" can be 2003e2fcbf42SPeter Maydell used to set the default mode. For channels which are not 2004e2fcbf42SPeter Maydell explicitly forced into one mode the spice client is allowed to 2005e2fcbf42SPeter Maydell pick tls/plaintext as he pleases. 2006e2fcbf42SPeter Maydell 2007e2fcbf42SPeter Maydell ``image-compression=[auto_glz|auto_lz|quic|glz|lz|off]`` 2008e2fcbf42SPeter Maydell Configure image compression (lossless). Default is auto\_glz. 2009e2fcbf42SPeter Maydell 2010e2fcbf42SPeter Maydell ``jpeg-wan-compression=[auto|never|always]``; \ ``zlib-glz-wan-compression=[auto|never|always]`` 2011e2fcbf42SPeter Maydell Configure wan image compression (lossy for slow links). Default 2012e2fcbf42SPeter Maydell is auto. 2013e2fcbf42SPeter Maydell 2014e2fcbf42SPeter Maydell ``streaming-video=[off|all|filter]`` 2015e2fcbf42SPeter Maydell Configure video stream detection. Default is off. 2016e2fcbf42SPeter Maydell 2017e2fcbf42SPeter Maydell ``agent-mouse=[on|off]`` 2018e2fcbf42SPeter Maydell Enable/disable passing mouse events via vdagent. Default is on. 2019e2fcbf42SPeter Maydell 2020e2fcbf42SPeter Maydell ``playback-compression=[on|off]`` 2021e2fcbf42SPeter Maydell Enable/disable audio stream compression (using celt 0.5.1). 2022e2fcbf42SPeter Maydell Default is on. 2023e2fcbf42SPeter Maydell 2024e2fcbf42SPeter Maydell ``seamless-migration=[on|off]`` 2025e2fcbf42SPeter Maydell Enable/disable spice seamless migration. Default is off. 2026e2fcbf42SPeter Maydell 2027e2fcbf42SPeter Maydell ``gl=[on|off]`` 2028e2fcbf42SPeter Maydell Enable/disable OpenGL context. Default is off. 2029e2fcbf42SPeter Maydell 2030e2fcbf42SPeter Maydell ``rendernode=<file>`` 2031e2fcbf42SPeter Maydell DRM render node for OpenGL rendering. If not specified, it will 2032e2fcbf42SPeter Maydell pick the first available. (Since 2.9) 2033e2fcbf42SPeter MaydellERST 203429b0040bSGerd Hoffmann 20355824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 2036ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 2037ad96090aSBlue Swirl QEMU_ARCH_ALL) 2038e2fcbf42SPeter MaydellSRST 2039e2fcbf42SPeter Maydell``-portrait`` 2040e2fcbf42SPeter Maydell Rotate graphical output 90 deg left (only PXA LCD). 2041e2fcbf42SPeter MaydellERST 20425824d651Sblueswir1 20439312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 20449312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 20459312805dSVasily Khoruzhick QEMU_ARCH_ALL) 2046e2fcbf42SPeter MaydellSRST 2047e2fcbf42SPeter Maydell``-rotate deg`` 2048e2fcbf42SPeter Maydell Rotate graphical output some deg left (only PXA LCD). 2049e2fcbf42SPeter MaydellERST 20509312805dSVasily Khoruzhick 20515824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 2052a94f0c5cSGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 2053ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 2054e2fcbf42SPeter MaydellSRST 2055e2fcbf42SPeter Maydell``-vga type`` 2056e2fcbf42SPeter Maydell Select type of VGA card to emulate. Valid values for type are 2057e2fcbf42SPeter Maydell 2058e2fcbf42SPeter Maydell ``cirrus`` 2059e2fcbf42SPeter Maydell Cirrus Logic GD5446 Video card. All Windows versions starting 2060e2fcbf42SPeter Maydell from Windows 95 should recognize and use this graphic card. For 2061e2fcbf42SPeter Maydell optimal performances, use 16 bit color depth in the guest and 2062e2fcbf42SPeter Maydell the host OS. (This card was the default before QEMU 2.2) 2063e2fcbf42SPeter Maydell 2064e2fcbf42SPeter Maydell ``std`` 2065e2fcbf42SPeter Maydell Standard VGA card with Bochs VBE extensions. If your guest OS 2066e2fcbf42SPeter Maydell supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if 2067e2fcbf42SPeter Maydell you want to use high resolution modes (>= 1280x1024x16) then you 2068e2fcbf42SPeter Maydell should use this option. (This card is the default since QEMU 2069e2fcbf42SPeter Maydell 2.2) 2070e2fcbf42SPeter Maydell 2071e2fcbf42SPeter Maydell ``vmware`` 2072e2fcbf42SPeter Maydell VMWare SVGA-II compatible adapter. Use it if you have 2073e2fcbf42SPeter Maydell sufficiently recent XFree86/XOrg server or Windows guest with a 2074e2fcbf42SPeter Maydell driver for this card. 2075e2fcbf42SPeter Maydell 2076e2fcbf42SPeter Maydell ``qxl`` 2077e2fcbf42SPeter Maydell QXL paravirtual graphic card. It is VGA compatible (including 2078e2fcbf42SPeter Maydell VESA 2.0 VBE support). Works best with qxl guest drivers 2079e2fcbf42SPeter Maydell installed though. Recommended choice when using the spice 2080e2fcbf42SPeter Maydell protocol. 2081e2fcbf42SPeter Maydell 2082e2fcbf42SPeter Maydell ``tcx`` 2083e2fcbf42SPeter Maydell (sun4m only) Sun TCX framebuffer. This is the default 2084e2fcbf42SPeter Maydell framebuffer for sun4m machines and offers both 8-bit and 24-bit 2085e2fcbf42SPeter Maydell colour depths at a fixed resolution of 1024x768. 2086e2fcbf42SPeter Maydell 2087e2fcbf42SPeter Maydell ``cg3`` 2088e2fcbf42SPeter Maydell (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit 2089e2fcbf42SPeter Maydell framebuffer for sun4m machines available in both 1024x768 2090e2fcbf42SPeter Maydell (OpenBIOS) and 1152x900 (OBP) resolutions aimed at people 2091e2fcbf42SPeter Maydell wishing to run older Solaris versions. 2092e2fcbf42SPeter Maydell 2093e2fcbf42SPeter Maydell ``virtio`` 2094e2fcbf42SPeter Maydell Virtio VGA card. 2095e2fcbf42SPeter Maydell 2096e2fcbf42SPeter Maydell ``none`` 2097e2fcbf42SPeter Maydell Disable VGA card. 2098e2fcbf42SPeter MaydellERST 20995824d651Sblueswir1 21005824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 2101ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 2102e2fcbf42SPeter MaydellSRST 2103e2fcbf42SPeter Maydell``-full-screen`` 2104e2fcbf42SPeter Maydell Start in full screen. 2105e2fcbf42SPeter MaydellERST 21065824d651Sblueswir1 210760f9a4efSJohn SnowDEF("g", HAS_ARG, QEMU_OPTION_g , 2108ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 21098ac919a0SLaurent Vivier QEMU_ARCH_PPC | QEMU_ARCH_SPARC | QEMU_ARCH_M68K) 2110e2fcbf42SPeter MaydellSRST 211109ce5f2dSPeter Maydell``-g`` *width*\ ``x``\ *height*\ ``[x``\ *depth*\ ``]`` 2112e2fcbf42SPeter Maydell Set the initial graphical resolution and depth (PPC, SPARC only). 2113e2fcbf42SPeter Maydell 2114e2fcbf42SPeter Maydell For PPC the default is 800x600x32. 2115e2fcbf42SPeter Maydell 2116e2fcbf42SPeter Maydell For SPARC with the TCX graphics device, the default is 1024x768x8 2117e2fcbf42SPeter Maydell with the option of 1024x768x24. For cgthree, the default is 2118e2fcbf42SPeter Maydell 1024x768x8 with the option of 1152x900x8 for people who wish to use 2119e2fcbf42SPeter Maydell OBP. 2120e2fcbf42SPeter MaydellERST 21215824d651Sblueswir1 21225824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 2123f04ec5afSRobert Ho "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL) 2124e2fcbf42SPeter MaydellSRST 2125e2fcbf42SPeter Maydell``-vnc display[,option[,option[,...]]]`` 2126e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2127e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2128e2fcbf42SPeter Maydell monitor in a window. With this option, you can have QEMU listen on 2129e2fcbf42SPeter Maydell VNC display display and redirect the VGA display over the VNC 2130e2fcbf42SPeter Maydell session. It is very useful to enable the usb tablet device when 2131e2fcbf42SPeter Maydell using this option (option ``-device usb-tablet``). When using the 2132e2fcbf42SPeter Maydell VNC display, you must use the ``-k`` parameter to set the keyboard 2133e2fcbf42SPeter Maydell layout if you are not using en-us. Valid syntax for the display is 2134e2fcbf42SPeter Maydell 2135e2fcbf42SPeter Maydell ``to=L`` 2136e2fcbf42SPeter Maydell With this option, QEMU will try next available VNC displays, 2137e2fcbf42SPeter Maydell until the number L, if the origianlly defined "-vnc display" is 2138e2fcbf42SPeter Maydell not available, e.g. port 5900+display is already used by another 2139e2fcbf42SPeter Maydell application. By default, to=0. 2140e2fcbf42SPeter Maydell 2141e2fcbf42SPeter Maydell ``host:d`` 2142e2fcbf42SPeter Maydell TCP connections will only be allowed from host on display d. By 2143e2fcbf42SPeter Maydell convention the TCP port is 5900+d. Optionally, host can be 2144e2fcbf42SPeter Maydell omitted in which case the server will accept connections from 2145e2fcbf42SPeter Maydell any host. 2146e2fcbf42SPeter Maydell 2147e2fcbf42SPeter Maydell ``unix:path`` 2148e2fcbf42SPeter Maydell Connections will be allowed over UNIX domain sockets where path 2149e2fcbf42SPeter Maydell is the location of a unix socket to listen for connections on. 2150e2fcbf42SPeter Maydell 2151e2fcbf42SPeter Maydell ``none`` 2152e2fcbf42SPeter Maydell VNC is initialized but not started. The monitor ``change`` 2153e2fcbf42SPeter Maydell command can be used to later start the VNC server. 2154e2fcbf42SPeter Maydell 2155e2fcbf42SPeter Maydell Following the display value there may be one or more option flags 2156e2fcbf42SPeter Maydell separated by commas. Valid options are 2157e2fcbf42SPeter Maydell 215882a17d1dSDaniel P. Berrangé ``reverse=on|off`` 2159e2fcbf42SPeter Maydell Connect to a listening VNC client via a "reverse" connection. 2160e2fcbf42SPeter Maydell The client is specified by the display. For reverse network 2161e2fcbf42SPeter Maydell connections (host:d,``reverse``), the d argument is a TCP port 2162e2fcbf42SPeter Maydell number, not a display number. 2163e2fcbf42SPeter Maydell 216482a17d1dSDaniel P. Berrangé ``websocket=on|off`` 2165e2fcbf42SPeter Maydell Opens an additional TCP listening port dedicated to VNC 2166e2fcbf42SPeter Maydell Websocket connections. If a bare websocket option is given, the 2167e2fcbf42SPeter Maydell Websocket port is 5700+display. An alternative port can be 2168e2fcbf42SPeter Maydell specified with the syntax ``websocket``\ =port. 2169e2fcbf42SPeter Maydell 2170e2fcbf42SPeter Maydell If host is specified connections will only be allowed from this 2171e2fcbf42SPeter Maydell host. It is possible to control the websocket listen address 2172e2fcbf42SPeter Maydell independently, using the syntax ``websocket``\ =host:port. 2173e2fcbf42SPeter Maydell 2174e2fcbf42SPeter Maydell If no TLS credentials are provided, the websocket connection 2175e2fcbf42SPeter Maydell runs in unencrypted mode. If TLS credentials are provided, the 2176e2fcbf42SPeter Maydell websocket connection requires encrypted client connections. 2177e2fcbf42SPeter Maydell 217882a17d1dSDaniel P. Berrangé ``password=on|off`` 2179e2fcbf42SPeter Maydell Require that password based authentication is used for client 2180e2fcbf42SPeter Maydell connections. 2181e2fcbf42SPeter Maydell 2182e2fcbf42SPeter Maydell The password must be set separately using the ``set_password`` 2183923e9311SThomas Huth command in the :ref:`QEMU monitor`. The 2184e2fcbf42SPeter Maydell syntax to change your password is: 2185e2fcbf42SPeter Maydell ``set_password <protocol> <password>`` where <protocol> could be 2186e2fcbf42SPeter Maydell either "vnc" or "spice". 2187e2fcbf42SPeter Maydell 2188e2fcbf42SPeter Maydell If you would like to change <protocol> password expiration, you 2189e2fcbf42SPeter Maydell should use ``expire_password <protocol> <expiration-time>`` 2190e2fcbf42SPeter Maydell where expiration time could be one of the following options: 2191e2fcbf42SPeter Maydell now, never, +seconds or UNIX time of expiration, e.g. +60 to 2192e2fcbf42SPeter Maydell make password expire in 60 seconds, or 1335196800 to make 2193e2fcbf42SPeter Maydell password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for 2194e2fcbf42SPeter Maydell this date and time). 2195e2fcbf42SPeter Maydell 2196e2fcbf42SPeter Maydell You can also use keywords "now" or "never" for the expiration 2197e2fcbf42SPeter Maydell time to allow <protocol> password to expire immediately or never 2198e2fcbf42SPeter Maydell expire. 2199e2fcbf42SPeter Maydell 22006c6840e9SDaniel P. Berrangé ``password-secret=<secret-id>`` 22016c6840e9SDaniel P. Berrangé Require that password based authentication is used for client 22026c6840e9SDaniel P. Berrangé connections, using the password provided by the ``secret`` 22036c6840e9SDaniel P. Berrangé object identified by ``secret-id``. 22046c6840e9SDaniel P. Berrangé 2205e2fcbf42SPeter Maydell ``tls-creds=ID`` 2206e2fcbf42SPeter Maydell Provides the ID of a set of TLS credentials to use to secure the 2207e2fcbf42SPeter Maydell VNC server. They will apply to both the normal VNC server socket 2208e2fcbf42SPeter Maydell and the websocket socket (if enabled). Setting TLS credentials 2209e2fcbf42SPeter Maydell will cause the VNC server socket to enable the VeNCrypt auth 2210e2fcbf42SPeter Maydell mechanism. The credentials should have been previously created 2211e2fcbf42SPeter Maydell using the ``-object tls-creds`` argument. 2212e2fcbf42SPeter Maydell 2213e2fcbf42SPeter Maydell ``tls-authz=ID`` 2214e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2215e2fcbf42SPeter Maydell the client's x509 distinguished name will validated. This object 2216e2fcbf42SPeter Maydell is only resolved at time of use, so can be deleted and recreated 2217e2fcbf42SPeter Maydell on the fly while the VNC server is active. If missing, it will 2218e2fcbf42SPeter Maydell default to denying access. 2219e2fcbf42SPeter Maydell 222082a17d1dSDaniel P. Berrangé ``sasl=on|off`` 2221e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the VNC 2222e2fcbf42SPeter Maydell server. The exact choice of authentication method used is 2223e2fcbf42SPeter Maydell controlled from the system / user's SASL configuration file for 2224e2fcbf42SPeter Maydell the 'qemu' service. This is typically found in 2225e2fcbf42SPeter Maydell /etc/sasl2/qemu.conf. If running QEMU as an unprivileged user, 2226e2fcbf42SPeter Maydell an environment variable SASL\_CONF\_PATH can be used to make it 2227e2fcbf42SPeter Maydell search alternate locations for the service config. While some 2228e2fcbf42SPeter Maydell SASL auth methods can also provide data encryption (eg GSSAPI), 2229e2fcbf42SPeter Maydell it is recommended that SASL always be combined with the 'tls' 2230e2fcbf42SPeter Maydell and 'x509' settings to enable use of SSL and server 2231e2fcbf42SPeter Maydell certificates. This ensures a data encryption preventing 2232e2fcbf42SPeter Maydell compromise of authentication credentials. See the 2233923e9311SThomas Huth :ref:`VNC security` section in the System Emulation Users Guide 2234923e9311SThomas Huth for details on using SASL authentication. 2235e2fcbf42SPeter Maydell 2236e2fcbf42SPeter Maydell ``sasl-authz=ID`` 2237e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2238e2fcbf42SPeter Maydell the client's SASL username will validated. This object is only 2239e2fcbf42SPeter Maydell resolved at time of use, so can be deleted and recreated on the 2240e2fcbf42SPeter Maydell fly while the VNC server is active. If missing, it will default 2241e2fcbf42SPeter Maydell to denying access. 2242e2fcbf42SPeter Maydell 224382a17d1dSDaniel P. Berrangé ``acl=on|off`` 2244e2fcbf42SPeter Maydell Legacy method for enabling authorization of clients against the 2245e2fcbf42SPeter Maydell x509 distinguished name and SASL username. It results in the 2246e2fcbf42SPeter Maydell creation of two ``authz-list`` objects with IDs of 2247e2fcbf42SPeter Maydell ``vnc.username`` and ``vnc.x509dname``. The rules for these 2248e2fcbf42SPeter Maydell objects must be configured with the HMP ACL commands. 2249e2fcbf42SPeter Maydell 2250e2fcbf42SPeter Maydell This option is deprecated and should no longer be used. The new 2251e2fcbf42SPeter Maydell ``sasl-authz`` and ``tls-authz`` options are a replacement. 2252e2fcbf42SPeter Maydell 225382a17d1dSDaniel P. Berrangé ``lossy=on|off`` 2254e2fcbf42SPeter Maydell Enable lossy compression methods (gradient, JPEG, ...). If this 2255e2fcbf42SPeter Maydell option is set, VNC client may receive lossy framebuffer updates 2256e2fcbf42SPeter Maydell depending on its encoding settings. Enabling this option can 2257e2fcbf42SPeter Maydell save a lot of bandwidth at the expense of quality. 2258e2fcbf42SPeter Maydell 225982a17d1dSDaniel P. Berrangé ``non-adaptive=on|off`` 2260e2fcbf42SPeter Maydell Disable adaptive encodings. Adaptive encodings are enabled by 2261e2fcbf42SPeter Maydell default. An adaptive encoding will try to detect frequently 2262e2fcbf42SPeter Maydell updated screen regions, and send updates in these regions using 2263e2fcbf42SPeter Maydell a lossy encoding (like JPEG). This can be really helpful to save 2264e2fcbf42SPeter Maydell bandwidth when playing videos. Disabling adaptive encodings 2265e2fcbf42SPeter Maydell restores the original static behavior of encodings like Tight. 2266e2fcbf42SPeter Maydell 2267e2fcbf42SPeter Maydell ``share=[allow-exclusive|force-shared|ignore]`` 2268e2fcbf42SPeter Maydell Set display sharing policy. 'allow-exclusive' allows clients to 2269e2fcbf42SPeter Maydell ask for exclusive access. As suggested by the rfb spec this is 2270e2fcbf42SPeter Maydell implemented by dropping other connections. Connecting multiple 2271e2fcbf42SPeter Maydell clients in parallel requires all clients asking for a shared 2272e2fcbf42SPeter Maydell session (vncviewer: -shared switch). This is the default. 2273e2fcbf42SPeter Maydell 'force-shared' disables exclusive client access. Useful for 2274e2fcbf42SPeter Maydell shared desktop sessions, where you don't want someone forgetting 2275e2fcbf42SPeter Maydell specify -shared disconnect everybody else. 'ignore' completely 2276e2fcbf42SPeter Maydell ignores the shared flag and allows everybody connect 2277e2fcbf42SPeter Maydell unconditionally. Doesn't conform to the rfb spec but is 2278e2fcbf42SPeter Maydell traditional QEMU behavior. 2279e2fcbf42SPeter Maydell 2280e2fcbf42SPeter Maydell ``key-delay-ms`` 2281e2fcbf42SPeter Maydell Set keyboard delay, for key down and key up events, in 2282e2fcbf42SPeter Maydell milliseconds. Default is 10. Keyboards are low-bandwidth 2283e2fcbf42SPeter Maydell devices, so this slowdown can help the device and guest to keep 2284e2fcbf42SPeter Maydell up and not lose events in case events are arriving in bulk. 2285e2fcbf42SPeter Maydell Possible causes for the latter are flaky network connections, or 2286e2fcbf42SPeter Maydell scripts for automated testing. 2287e2fcbf42SPeter Maydell 2288e2fcbf42SPeter Maydell ``audiodev=audiodev`` 2289e2fcbf42SPeter Maydell Use the specified audiodev when the VNC client requests audio 2290e2fcbf42SPeter Maydell transmission. When not using an -audiodev argument, this option 2291e2fcbf42SPeter Maydell must be omitted, otherwise is must be present and specify a 2292e2fcbf42SPeter Maydell valid audiodev. 22937b5fa0b5SDaniel P. Berrangé 229482a17d1dSDaniel P. Berrangé ``power-control=on|off`` 22957b5fa0b5SDaniel P. Berrangé Permit the remote client to issue shutdown, reboot or reset power 22967b5fa0b5SDaniel P. Berrangé control requests. 2297e2fcbf42SPeter MaydellERST 22985824d651Sblueswir1 2299a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 23005824d651Sblueswir1 2301de6b4f90SMarkus ArmbrusterARCHHEADING(i386 target only:, QEMU_ARCH_I386) 23025824d651Sblueswir1 23035824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 2304ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 2305ad96090aSBlue Swirl QEMU_ARCH_I386) 2306e2fcbf42SPeter MaydellSRST 2307e2fcbf42SPeter Maydell``-win2k-hack`` 2308e2fcbf42SPeter Maydell Use it when installing Windows 2000 to avoid a disk full bug. After 2309e2fcbf42SPeter Maydell Windows 2000 is installed, you no longer need this option (this 2310e2fcbf42SPeter Maydell option slows down the IDE transfers). 2311e2fcbf42SPeter MaydellERST 23125824d651Sblueswir1 23135824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 2314ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 2315ad96090aSBlue Swirl QEMU_ARCH_I386) 2316e2fcbf42SPeter MaydellSRST 2317e2fcbf42SPeter Maydell``-no-fd-bootchk`` 2318e2fcbf42SPeter Maydell Disable boot signature checking for floppy disks in BIOS. May be 2319e2fcbf42SPeter Maydell needed to boot from old floppy disks. 2320e2fcbf42SPeter MaydellERST 23215824d651Sblueswir1 23225824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 2323f5d8c8cdSShannon Zhao "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2324e2fcbf42SPeter MaydellSRST 2325e2fcbf42SPeter Maydell``-no-acpi`` 2326e2fcbf42SPeter Maydell Disable ACPI (Advanced Configuration and Power Interface) support. 2327e2fcbf42SPeter Maydell Use it if your guest OS complains about ACPI problems (PC target 2328e2fcbf42SPeter Maydell machine only). 2329e2fcbf42SPeter MaydellERST 23305824d651Sblueswir1 23315824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 2332ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 2333e2fcbf42SPeter MaydellSRST 2334e2fcbf42SPeter Maydell``-no-hpet`` 2335e2fcbf42SPeter Maydell Disable HPET support. 2336e2fcbf42SPeter MaydellERST 23375824d651Sblueswir1 23385824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 2339104bf02eSMichael Tokarev "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n" 2340ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 2341e2fcbf42SPeter MaydellSRST 2342e2fcbf42SPeter Maydell``-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n] [,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]`` 2343e2fcbf42SPeter Maydell Add ACPI table with specified header fields and context from 2344e2fcbf42SPeter Maydell specified files. For file=, take whole ACPI table from the specified 2345e2fcbf42SPeter Maydell files, including all ACPI headers (possible overridden by other 2346e2fcbf42SPeter Maydell options). For data=, only data portion of the table is used, all 2347e2fcbf42SPeter Maydell header information is specified in the command line. If a SLIC table 2348e2fcbf42SPeter Maydell is supplied to QEMU, then the SLIC's oem\_id and oem\_table\_id 2349e2fcbf42SPeter Maydell fields will override the same in the RSDT and the FADT (a.k.a. 2350e2fcbf42SPeter Maydell FACP), in order to ensure the field matches required by the 2351e2fcbf42SPeter Maydell Microsoft SLIC spec and the ACPI spec. 2352e2fcbf42SPeter MaydellERST 23535824d651Sblueswir1 2354b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 2355b6f6e3d3Saliguori "-smbios file=binary\n" 2356ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 2357b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 2358b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 2359ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 2360b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2361b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 2362b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 2363b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2364b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 2365b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 2366b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 2367b155eb1dSGabriel L. Somlo " [,sku=str]\n" 2368b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 2369b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 2370c906e039SYing Fang " [,asset=str][,part=str][,max-speed=%d][,current-speed=%d]\n" 2371b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 237248a7ff4dSDaniel P. Berrangé "-smbios type=11[,value=str][,path=filename]\n" 237348a7ff4dSDaniel P. Berrangé " specify SMBIOS type 11 fields\n" 2374b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 23753ebd6cc8SGabriel L. Somlo " [,asset=str][,part=str][,speed=%d]\n" 2376b155eb1dSGabriel L. Somlo " specify SMBIOS type 17 fields\n", 2377c30e1565SWei Huang QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2378e2fcbf42SPeter MaydellSRST 2379e2fcbf42SPeter Maydell``-smbios file=binary`` 2380e2fcbf42SPeter Maydell Load SMBIOS entry from binary file. 2381e2fcbf42SPeter Maydell 2382e2fcbf42SPeter Maydell``-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]`` 2383e2fcbf42SPeter Maydell Specify SMBIOS type 0 fields 2384e2fcbf42SPeter Maydell 2385e2fcbf42SPeter Maydell``-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str]`` 2386e2fcbf42SPeter Maydell Specify SMBIOS type 1 fields 2387e2fcbf42SPeter Maydell 2388e2fcbf42SPeter Maydell``-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str][,asset=str][,location=str]`` 2389e2fcbf42SPeter Maydell Specify SMBIOS type 2 fields 2390e2fcbf42SPeter Maydell 2391e2fcbf42SPeter Maydell``-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str][,sku=str]`` 2392e2fcbf42SPeter Maydell Specify SMBIOS type 3 fields 2393e2fcbf42SPeter Maydell 2394e2fcbf42SPeter Maydell``-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str][,asset=str][,part=str]`` 2395e2fcbf42SPeter Maydell Specify SMBIOS type 4 fields 2396e2fcbf42SPeter Maydell 239748a7ff4dSDaniel P. Berrangé``-smbios type=11[,value=str][,path=filename]`` 239848a7ff4dSDaniel P. Berrangé Specify SMBIOS type 11 fields 239948a7ff4dSDaniel P. Berrangé 240048a7ff4dSDaniel P. Berrangé This argument can be repeated multiple times, and values are added in the order they are parsed. 240148a7ff4dSDaniel P. Berrangé Applications intending to use OEM strings data are encouraged to use their application name as 240248a7ff4dSDaniel P. Berrangé a prefix for the value string. This facilitates passing information for multiple applications 240348a7ff4dSDaniel P. Berrangé concurrently. 240448a7ff4dSDaniel P. Berrangé 240548a7ff4dSDaniel P. Berrangé The ``value=str`` syntax provides the string data inline, while the ``path=filename`` syntax 240648a7ff4dSDaniel P. Berrangé loads data from a file on disk. Note that the file is not permitted to contain any NUL bytes. 240748a7ff4dSDaniel P. Berrangé 240848a7ff4dSDaniel P. Berrangé Both the ``value`` and ``path`` options can be repeated multiple times and will be added to 240948a7ff4dSDaniel P. Berrangé the SMBIOS table in the order in which they appear. 241048a7ff4dSDaniel P. Berrangé 241148a7ff4dSDaniel P. Berrangé Note that on the x86 architecture, the total size of all SMBIOS tables is limited to 65535 241248a7ff4dSDaniel P. Berrangé bytes. Thus the OEM strings data is not suitable for passing large amounts of data into the 241348a7ff4dSDaniel P. Berrangé guest. Instead it should be used as a indicator to inform the guest where to locate the real 241448a7ff4dSDaniel P. Berrangé data set, for example, by specifying the serial ID of a block device. 241548a7ff4dSDaniel P. Berrangé 241648a7ff4dSDaniel P. Berrangé An example passing three strings is 241748a7ff4dSDaniel P. Berrangé 241848a7ff4dSDaniel P. Berrangé .. parsed-literal:: 241948a7ff4dSDaniel P. Berrangé 242048a7ff4dSDaniel P. Berrangé -smbios type=11,value=cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/,\\ 242148a7ff4dSDaniel P. Berrangé value=anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os,\\ 242248a7ff4dSDaniel P. Berrangé path=/some/file/with/oemstringsdata.txt 242348a7ff4dSDaniel P. Berrangé 242448a7ff4dSDaniel P. Berrangé In the guest OS this is visible with the ``dmidecode`` command 242548a7ff4dSDaniel P. Berrangé 242648a7ff4dSDaniel P. Berrangé .. parsed-literal:: 242748a7ff4dSDaniel P. Berrangé 242848a7ff4dSDaniel P. Berrangé $ dmidecode -t 11 242948a7ff4dSDaniel P. Berrangé Handle 0x0E00, DMI type 11, 5 bytes 243048a7ff4dSDaniel P. Berrangé OEM Strings 243148a7ff4dSDaniel P. Berrangé String 1: cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/ 243248a7ff4dSDaniel P. Berrangé String 2: anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os 243348a7ff4dSDaniel P. Berrangé String 3: myapp:some extra data 243448a7ff4dSDaniel P. Berrangé 243548a7ff4dSDaniel P. Berrangé 2436e2fcbf42SPeter Maydell``-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str][,asset=str][,part=str][,speed=%d]`` 2437e2fcbf42SPeter Maydell Specify SMBIOS type 17 fields 2438e2fcbf42SPeter MaydellERST 2439b6f6e3d3Saliguori 2440c70a01e4SMarkus ArmbrusterDEFHEADING() 24415824d651Sblueswir1 2442de6b4f90SMarkus ArmbrusterDEFHEADING(Network options:) 24435824d651Sblueswir1 24446a8b4a5bSThomas HuthDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 24455824d651Sblueswir1#ifdef CONFIG_SLIRP 24468b0dc246SDaniel P. Berrangé "-netdev user,id=str[,ipv4=on|off][,net=addr[/mask]][,host=addr]\n" 24478b0dc246SDaniel P. Berrangé " [,ipv6=on|off][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 24480b11c036SSamuel Thibault " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 2449f18d1375SBenjamin Drung " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n" 24500fca92b9SFam Zheng " [,tftp=dir][,tftp-server-name=name][,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 2451ad196a9dSJan Kiszka#ifndef _WIN32 2452c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 2453ad196a9dSJan Kiszka#endif 24546a8b4a5bSThomas Huth " configure a user mode network backend with ID 'str',\n" 24556a8b4a5bSThomas Huth " its DHCP server and optional services\n" 24565824d651Sblueswir1#endif 24575824d651Sblueswir1#ifdef _WIN32 24586a8b4a5bSThomas Huth "-netdev tap,id=str,ifname=name\n" 24596a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 24605824d651Sblueswir1#else 24616a8b4a5bSThomas Huth "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 2462584613eaSAlexey Kardashevskiy " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 24636a8b4a5bSThomas Huth " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 246469e87b32SJason Wang " [,poll-us=n]\n" 24656a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 2466584613eaSAlexey Kardashevskiy " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 2467a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 2468a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 2469a7c36ee4SCorey Bryant " to deconfigure it\n" 2470ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 2471a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 2472a7c36ee4SCorey Bryant " configure it\n" 24735824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 24742ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 2475ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 2476f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 2477ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 2478ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 247982b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 24805430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 24815430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 248282b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 24832ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 2484ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 2485cba42d61SMichael Tokarev " use 'poll-us=n' to specify the maximum number of microseconds that could be\n" 248669e87b32SJason Wang " spent on busy polling for vhost net\n" 24876a8b4a5bSThomas Huth "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 24886a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str' that is\n" 24896a8b4a5bSThomas Huth " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 24906a8b4a5bSThomas Huth " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 24910df0ff6dSMark McLoughlin#endif 24923fb69aa1SAnton Ivanov#ifdef __linux__ 24936a8b4a5bSThomas Huth "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 24948b0dc246SDaniel P. Berrangé " [,rxsession=rxsession],txsession=txsession[,ipv6=on|off][,udp=on|off]\n" 24958b0dc246SDaniel P. Berrangé " [,cookie64=on|off][,counter][,pincounter][,txcookie=txcookie]\n" 24966a8b4a5bSThomas Huth " [,rxcookie=rxcookie][,offset=offset]\n" 24976a8b4a5bSThomas Huth " configure a network backend with ID 'str' connected to\n" 24986a8b4a5bSThomas Huth " an Ethernet over L2TPv3 pseudowire.\n" 24993fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 25002f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 25013fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 250221843dc4SStefan Hajnoczi " standard (RFC3931). Note - this implementation uses static\n" 25033fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 25043fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 25053fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 25063fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 25073952651aSGonglei " use 'srcport=' to specify source udp port\n" 25083fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 25093fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 25103fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 25113fb69aa1SAnton Ivanov " well as a weak security measure\n" 25123fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 25133fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 25143fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 25153fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 25163fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 25173fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 25183fb69aa1SAnton Ivanov#endif 25196a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 25206a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 25216a8b4a5bSThomas Huth " using a socket connection\n" 25226a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 25236a8b4a5bSThomas Huth " configure a network backend to connect to a multicast maddr and port\n" 25243a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 25256a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 25266a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 25276a8b4a5bSThomas Huth " using an UDP tunnel\n" 25285824d651Sblueswir1#ifdef CONFIG_VDE 25296a8b4a5bSThomas Huth "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 25306a8b4a5bSThomas Huth " configure a network backend to connect to port 'n' of a vde switch\n" 25316a8b4a5bSThomas Huth " running on host and listening for incoming connections on 'socketpath'.\n" 25325824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 25335824d651Sblueswir1 " ownership and permissions for communication port.\n" 25345824d651Sblueswir1#endif 253558952137SVincenzo Maffione#ifdef CONFIG_NETMAP 25366a8b4a5bSThomas Huth "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 253758952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 253858952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 253958952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 254058952137SVincenzo Maffione#endif 2541253dc14cSThomas Huth#ifdef CONFIG_POSIX 25426a8b4a5bSThomas Huth "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 25436a8b4a5bSThomas Huth " configure a vhost-user network, backed by a chardev 'dev'\n" 2544253dc14cSThomas Huth#endif 2545108a6481SCindy Lu#ifdef __linux__ 2546108a6481SCindy Lu "-netdev vhost-vdpa,id=str,vhostdev=/path/to/dev\n" 2547108a6481SCindy Lu " configure a vhost-vdpa network,Establish a vhost-vdpa netdev\n" 2548108a6481SCindy Lu#endif 254918d65d22SThomas Huth "-netdev hubport,id=str,hubid=n[,netdev=nd]\n" 2550af1a5c3eSThomas Huth " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL) 255178cd6f7bSThomas HuthDEF("nic", HAS_ARG, QEMU_OPTION_nic, 2552dfaa7d50SBALATON Zoltan "-nic [tap|bridge|" 255378cd6f7bSThomas Huth#ifdef CONFIG_SLIRP 255478cd6f7bSThomas Huth "user|" 255578cd6f7bSThomas Huth#endif 255678cd6f7bSThomas Huth#ifdef __linux__ 255778cd6f7bSThomas Huth "l2tpv3|" 255878cd6f7bSThomas Huth#endif 255978cd6f7bSThomas Huth#ifdef CONFIG_VDE 256078cd6f7bSThomas Huth "vde|" 256178cd6f7bSThomas Huth#endif 256278cd6f7bSThomas Huth#ifdef CONFIG_NETMAP 256378cd6f7bSThomas Huth "netmap|" 256478cd6f7bSThomas Huth#endif 256578cd6f7bSThomas Huth#ifdef CONFIG_POSIX 256678cd6f7bSThomas Huth "vhost-user|" 256778cd6f7bSThomas Huth#endif 256878cd6f7bSThomas Huth "socket][,option][,...][mac=macaddr]\n" 256978cd6f7bSThomas Huth " initialize an on-board / default host NIC (using MAC address\n" 257078cd6f7bSThomas Huth " macaddr) and connect it to the given host network backend\n" 2571dfaa7d50SBALATON Zoltan "-nic none use it alone to have zero network devices (the default is to\n" 257278cd6f7bSThomas Huth " provided a 'user' network connection)\n", 257378cd6f7bSThomas Huth QEMU_ARCH_ALL) 25746a8b4a5bSThomas HuthDEF("net", HAS_ARG, QEMU_OPTION_net, 2575af1a5c3eSThomas Huth "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 25760e60a82dSThomas Huth " configure or create an on-board (or machine default) NIC and\n" 2577af1a5c3eSThomas Huth " connect it to hub 0 (please use -nic unless you need a hub)\n" 25786a8b4a5bSThomas Huth "-net [" 2579a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 2580a1ea458fSMark McLoughlin "user|" 2581a1ea458fSMark McLoughlin#endif 2582a1ea458fSMark McLoughlin "tap|" 2583a7c36ee4SCorey Bryant "bridge|" 2584a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 2585a1ea458fSMark McLoughlin "vde|" 2586a1ea458fSMark McLoughlin#endif 258758952137SVincenzo Maffione#ifdef CONFIG_NETMAP 258858952137SVincenzo Maffione "netmap|" 258958952137SVincenzo Maffione#endif 2590af1a5c3eSThomas Huth "socket][,option][,option][,...]\n" 25916a8b4a5bSThomas Huth " old way to initialize a host network interface\n" 25926a8b4a5bSThomas Huth " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 2593e2fcbf42SPeter MaydellSRST 2594e2fcbf42SPeter Maydell``-nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]`` 2595e2fcbf42SPeter Maydell This option is a shortcut for configuring both the on-board 2596e2fcbf42SPeter Maydell (default) guest NIC hardware and the host network backend in one go. 2597e2fcbf42SPeter Maydell The host backend options are the same as with the corresponding 2598e2fcbf42SPeter Maydell ``-netdev`` options below. The guest NIC model can be set with 2599e2fcbf42SPeter Maydell ``model=modelname``. Use ``model=help`` to list the available device 2600e2fcbf42SPeter Maydell types. The hardware MAC address can be set with ``mac=macaddr``. 2601e2fcbf42SPeter Maydell 2602e2fcbf42SPeter Maydell The following two example do exactly the same, to show how ``-nic`` 2603e2fcbf42SPeter Maydell can be used to shorten the command line length: 2604e2fcbf42SPeter Maydell 2605e2fcbf42SPeter Maydell .. parsed-literal:: 2606e2fcbf42SPeter Maydell 2607e2fcbf42SPeter Maydell |qemu_system| -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32 2608e2fcbf42SPeter Maydell |qemu_system| -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32 2609e2fcbf42SPeter Maydell 2610e2fcbf42SPeter Maydell``-nic none`` 2611e2fcbf42SPeter Maydell Indicate that no network devices should be configured. It is used to 2612e2fcbf42SPeter Maydell override the default configuration (default NIC with "user" host 2613e2fcbf42SPeter Maydell network backend) which is activated if no other networking options 2614e2fcbf42SPeter Maydell are provided. 2615e2fcbf42SPeter Maydell 2616e2fcbf42SPeter Maydell``-netdev user,id=id[,option][,option][,...]`` 2617e2fcbf42SPeter Maydell Configure user mode host network backend which requires no 2618e2fcbf42SPeter Maydell administrator privilege to run. Valid options are: 2619e2fcbf42SPeter Maydell 2620e2fcbf42SPeter Maydell ``id=id`` 2621e2fcbf42SPeter Maydell Assign symbolic name for use in monitor commands. 2622e2fcbf42SPeter Maydell 2623e2fcbf42SPeter Maydell ``ipv4=on|off and ipv6=on|off`` 2624e2fcbf42SPeter Maydell Specify that either IPv4 or IPv6 must be enabled. If neither is 2625e2fcbf42SPeter Maydell specified both protocols are enabled. 2626e2fcbf42SPeter Maydell 2627e2fcbf42SPeter Maydell ``net=addr[/mask]`` 2628e2fcbf42SPeter Maydell Set IP network address the guest will see. Optionally specify 2629e2fcbf42SPeter Maydell the netmask, either in the form a.b.c.d or as number of valid 2630e2fcbf42SPeter Maydell top-most bits. Default is 10.0.2.0/24. 2631e2fcbf42SPeter Maydell 2632e2fcbf42SPeter Maydell ``host=addr`` 2633e2fcbf42SPeter Maydell Specify the guest-visible address of the host. Default is the 2634e2fcbf42SPeter Maydell 2nd IP in the guest network, i.e. x.x.x.2. 2635e2fcbf42SPeter Maydell 2636e2fcbf42SPeter Maydell ``ipv6-net=addr[/int]`` 2637e2fcbf42SPeter Maydell Set IPv6 network address the guest will see (default is 2638e2fcbf42SPeter Maydell fec0::/64). The network prefix is given in the usual hexadecimal 2639e2fcbf42SPeter Maydell IPv6 address notation. The prefix size is optional, and is given 2640e2fcbf42SPeter Maydell as the number of valid top-most bits (default is 64). 2641e2fcbf42SPeter Maydell 2642e2fcbf42SPeter Maydell ``ipv6-host=addr`` 2643e2fcbf42SPeter Maydell Specify the guest-visible IPv6 address of the host. Default is 2644e2fcbf42SPeter Maydell the 2nd IPv6 in the guest network, i.e. xxxx::2. 2645e2fcbf42SPeter Maydell 2646e2fcbf42SPeter Maydell ``restrict=on|off`` 2647e2fcbf42SPeter Maydell If this option is enabled, the guest will be isolated, i.e. it 2648e2fcbf42SPeter Maydell will not be able to contact the host and no guest IP packets 2649e2fcbf42SPeter Maydell will be routed over the host to the outside. This option does 2650e2fcbf42SPeter Maydell not affect any explicitly set forwarding rules. 2651e2fcbf42SPeter Maydell 2652e2fcbf42SPeter Maydell ``hostname=name`` 2653e2fcbf42SPeter Maydell Specifies the client hostname reported by the built-in DHCP 2654e2fcbf42SPeter Maydell server. 2655e2fcbf42SPeter Maydell 2656e2fcbf42SPeter Maydell ``dhcpstart=addr`` 2657e2fcbf42SPeter Maydell Specify the first of the 16 IPs the built-in DHCP server can 2658e2fcbf42SPeter Maydell assign. Default is the 15th to 31st IP in the guest network, 2659e2fcbf42SPeter Maydell i.e. x.x.x.15 to x.x.x.31. 2660e2fcbf42SPeter Maydell 2661e2fcbf42SPeter Maydell ``dns=addr`` 2662e2fcbf42SPeter Maydell Specify the guest-visible address of the virtual nameserver. The 2663e2fcbf42SPeter Maydell address must be different from the host address. Default is the 2664e2fcbf42SPeter Maydell 3rd IP in the guest network, i.e. x.x.x.3. 2665e2fcbf42SPeter Maydell 2666e2fcbf42SPeter Maydell ``ipv6-dns=addr`` 2667e2fcbf42SPeter Maydell Specify the guest-visible address of the IPv6 virtual 2668e2fcbf42SPeter Maydell nameserver. The address must be different from the host address. 2669e2fcbf42SPeter Maydell Default is the 3rd IP in the guest network, i.e. xxxx::3. 2670e2fcbf42SPeter Maydell 2671e2fcbf42SPeter Maydell ``dnssearch=domain`` 2672e2fcbf42SPeter Maydell Provides an entry for the domain-search list sent by the 2673e2fcbf42SPeter Maydell built-in DHCP server. More than one domain suffix can be 2674e2fcbf42SPeter Maydell transmitted by specifying this option multiple times. If 2675e2fcbf42SPeter Maydell supported, this will cause the guest to automatically try to 2676e2fcbf42SPeter Maydell append the given domain suffix(es) in case a domain name can not 2677e2fcbf42SPeter Maydell be resolved. 2678e2fcbf42SPeter Maydell 2679e2fcbf42SPeter Maydell Example: 2680e2fcbf42SPeter Maydell 2681e2fcbf42SPeter Maydell .. parsed-literal:: 2682e2fcbf42SPeter Maydell 2683e2fcbf42SPeter Maydell |qemu_system| -nic user,dnssearch=mgmt.example.org,dnssearch=example.org 2684e2fcbf42SPeter Maydell 2685e2fcbf42SPeter Maydell ``domainname=domain`` 2686e2fcbf42SPeter Maydell Specifies the client domain name reported by the built-in DHCP 2687e2fcbf42SPeter Maydell server. 2688e2fcbf42SPeter Maydell 2689e2fcbf42SPeter Maydell ``tftp=dir`` 2690e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in TFTP 2691e2fcbf42SPeter Maydell server. The files in dir will be exposed as the root of a TFTP 2692e2fcbf42SPeter Maydell server. The TFTP client on the guest must be configured in 2693e2fcbf42SPeter Maydell binary mode (use the command ``bin`` of the Unix TFTP client). 2694e2fcbf42SPeter Maydell 2695e2fcbf42SPeter Maydell ``tftp-server-name=name`` 2696e2fcbf42SPeter Maydell In BOOTP reply, broadcast name as the "TFTP server name" 2697e2fcbf42SPeter Maydell (RFC2132 option 66). This can be used to advise the guest to 2698e2fcbf42SPeter Maydell load boot files or configurations from a different server than 2699e2fcbf42SPeter Maydell the host address. 2700e2fcbf42SPeter Maydell 2701e2fcbf42SPeter Maydell ``bootfile=file`` 2702e2fcbf42SPeter Maydell When using the user mode network stack, broadcast file as the 2703e2fcbf42SPeter Maydell BOOTP filename. In conjunction with ``tftp``, this can be used 2704e2fcbf42SPeter Maydell to network boot a guest from a local directory. 2705e2fcbf42SPeter Maydell 2706e2fcbf42SPeter Maydell Example (using pxelinux): 2707e2fcbf42SPeter Maydell 2708e2fcbf42SPeter Maydell .. parsed-literal:: 2709e2fcbf42SPeter Maydell 2710353a06b4SLaszlo Ersek |qemu_system| -hda linux.img -boot n -device e1000,netdev=n1 \\ 2711e2fcbf42SPeter Maydell -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 2712e2fcbf42SPeter Maydell 2713e2fcbf42SPeter Maydell ``smb=dir[,smbserver=addr]`` 2714e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in SMB 2715e2fcbf42SPeter Maydell server so that Windows OSes can access to the host files in 2716e2fcbf42SPeter Maydell ``dir`` transparently. The IP address of the SMB server can be 2717e2fcbf42SPeter Maydell set to addr. By default the 4th IP in the guest network is used, 2718e2fcbf42SPeter Maydell i.e. x.x.x.4. 2719e2fcbf42SPeter Maydell 2720e2fcbf42SPeter Maydell In the guest Windows OS, the line: 2721e2fcbf42SPeter Maydell 2722e2fcbf42SPeter Maydell :: 2723e2fcbf42SPeter Maydell 2724e2fcbf42SPeter Maydell 10.0.2.4 smbserver 2725e2fcbf42SPeter Maydell 2726e2fcbf42SPeter Maydell must be added in the file ``C:\WINDOWS\LMHOSTS`` (for windows 2727e2fcbf42SPeter Maydell 9x/Me) or ``C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS`` (Windows 2728e2fcbf42SPeter Maydell NT/2000). 2729e2fcbf42SPeter Maydell 2730e2fcbf42SPeter Maydell Then ``dir`` can be accessed in ``\\smbserver\qemu``. 2731e2fcbf42SPeter Maydell 2732e2fcbf42SPeter Maydell Note that a SAMBA server must be installed on the host OS. 2733e2fcbf42SPeter Maydell 2734e2fcbf42SPeter Maydell ``hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport`` 2735e2fcbf42SPeter Maydell Redirect incoming TCP or UDP connections to the host port 2736e2fcbf42SPeter Maydell hostport to the guest IP address guestaddr on guest port 2737e2fcbf42SPeter Maydell guestport. If guestaddr is not specified, its value is x.x.x.15 2738e2fcbf42SPeter Maydell (default first address given by the built-in DHCP server). By 2739e2fcbf42SPeter Maydell specifying hostaddr, the rule can be bound to a specific host 2740e2fcbf42SPeter Maydell interface. If no connection type is set, TCP is used. This 2741e2fcbf42SPeter Maydell option can be given multiple times. 2742e2fcbf42SPeter Maydell 2743e2fcbf42SPeter Maydell For example, to redirect host X11 connection from screen 1 to 2744e2fcbf42SPeter Maydell guest screen 0, use the following: 2745e2fcbf42SPeter Maydell 274609ce5f2dSPeter Maydell .. parsed-literal:: 2747e2fcbf42SPeter Maydell 2748e2fcbf42SPeter Maydell # on the host 2749e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp:127.0.0.1:6001-:6000 2750e2fcbf42SPeter Maydell # this host xterm should open in the guest X11 server 2751e2fcbf42SPeter Maydell xterm -display :1 2752e2fcbf42SPeter Maydell 2753e2fcbf42SPeter Maydell To redirect telnet connections from host port 5555 to telnet 2754e2fcbf42SPeter Maydell port on the guest, use the following: 2755e2fcbf42SPeter Maydell 275609ce5f2dSPeter Maydell .. parsed-literal:: 2757e2fcbf42SPeter Maydell 2758e2fcbf42SPeter Maydell # on the host 2759e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp::5555-:23 2760e2fcbf42SPeter Maydell telnet localhost 5555 2761e2fcbf42SPeter Maydell 2762e2fcbf42SPeter Maydell Then when you use on the host ``telnet localhost 5555``, you 2763e2fcbf42SPeter Maydell connect to the guest telnet server. 2764e2fcbf42SPeter Maydell 2765e2fcbf42SPeter Maydell ``guestfwd=[tcp]:server:port-dev``; \ ``guestfwd=[tcp]:server:port-cmd:command`` 2766e2fcbf42SPeter Maydell Forward guest TCP connections to the IP address server on port 2767e2fcbf42SPeter Maydell port to the character device dev or to a program executed by 2768e2fcbf42SPeter Maydell cmd:command which gets spawned for each connection. This option 2769e2fcbf42SPeter Maydell can be given multiple times. 2770e2fcbf42SPeter Maydell 2771e2fcbf42SPeter Maydell You can either use a chardev directly and have that one used 2772e2fcbf42SPeter Maydell throughout QEMU's lifetime, like in the following example: 2773e2fcbf42SPeter Maydell 277409ce5f2dSPeter Maydell .. parsed-literal:: 2775e2fcbf42SPeter Maydell 2776e2fcbf42SPeter Maydell # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 2777e2fcbf42SPeter Maydell # the guest accesses it 2778e2fcbf42SPeter Maydell |qemu_system| -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 2779e2fcbf42SPeter Maydell 2780e2fcbf42SPeter Maydell Or you can execute a command on every TCP connection established 2781e2fcbf42SPeter Maydell by the guest, so that QEMU behaves similar to an inetd process 2782e2fcbf42SPeter Maydell for that virtual server: 2783e2fcbf42SPeter Maydell 278409ce5f2dSPeter Maydell .. parsed-literal:: 2785e2fcbf42SPeter Maydell 2786e2fcbf42SPeter Maydell # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 2787e2fcbf42SPeter Maydell # and connect the TCP stream to its stdin/stdout 2788e2fcbf42SPeter Maydell |qemu_system| -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 2789e2fcbf42SPeter Maydell 2790e2fcbf42SPeter Maydell``-netdev tap,id=id[,fd=h][,ifname=name][,script=file][,downscript=dfile][,br=bridge][,helper=helper]`` 2791e2fcbf42SPeter Maydell Configure a host TAP network backend with ID id. 2792e2fcbf42SPeter Maydell 2793e2fcbf42SPeter Maydell Use the network script file to configure it and the network script 2794e2fcbf42SPeter Maydell dfile to deconfigure it. If name is not provided, the OS 2795e2fcbf42SPeter Maydell automatically provides one. The default network configure script is 2796e2fcbf42SPeter Maydell ``/etc/qemu-ifup`` and the default network deconfigure script is 2797e2fcbf42SPeter Maydell ``/etc/qemu-ifdown``. Use ``script=no`` or ``downscript=no`` to 2798e2fcbf42SPeter Maydell disable script execution. 2799e2fcbf42SPeter Maydell 2800e2fcbf42SPeter Maydell If running QEMU as an unprivileged user, use the network helper 28018d73ec89STianjia Zhang to configure the TAP interface and attach it to the bridge. 2802e2fcbf42SPeter Maydell The default network helper executable is 2803e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 2804e2fcbf42SPeter Maydell ``br0``. 2805e2fcbf42SPeter Maydell 2806e2fcbf42SPeter Maydell ``fd``\ =h can be used to specify the handle of an already opened 2807e2fcbf42SPeter Maydell host TAP interface. 2808e2fcbf42SPeter Maydell 2809e2fcbf42SPeter Maydell Examples: 2810e2fcbf42SPeter Maydell 281109ce5f2dSPeter Maydell .. parsed-literal:: 2812e2fcbf42SPeter Maydell 2813e2fcbf42SPeter Maydell #launch a QEMU instance with the default network script 2814e2fcbf42SPeter Maydell |qemu_system| linux.img -nic tap 2815e2fcbf42SPeter Maydell 281609ce5f2dSPeter Maydell .. parsed-literal:: 2817e2fcbf42SPeter Maydell 2818e2fcbf42SPeter Maydell #launch a QEMU instance with two NICs, each one connected 2819e2fcbf42SPeter Maydell #to a TAP device 2820353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2821353a06b4SLaszlo Ersek -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \\ 2822e2fcbf42SPeter Maydell -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1 2823e2fcbf42SPeter Maydell 282409ce5f2dSPeter Maydell .. parsed-literal:: 2825e2fcbf42SPeter Maydell 2826e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 2827e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 2828353a06b4SLaszlo Ersek |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \\ 2829e2fcbf42SPeter Maydell -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper" 2830e2fcbf42SPeter Maydell 2831e2fcbf42SPeter Maydell``-netdev bridge,id=id[,br=bridge][,helper=helper]`` 2832e2fcbf42SPeter Maydell Connect a host TAP network interface to a host bridge device. 2833e2fcbf42SPeter Maydell 2834e2fcbf42SPeter Maydell Use the network helper helper to configure the TAP interface and 2835e2fcbf42SPeter Maydell attach it to the bridge. The default network helper executable is 2836e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 2837e2fcbf42SPeter Maydell ``br0``. 2838e2fcbf42SPeter Maydell 2839e2fcbf42SPeter Maydell Examples: 2840e2fcbf42SPeter Maydell 284109ce5f2dSPeter Maydell .. parsed-literal:: 2842e2fcbf42SPeter Maydell 2843e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 2844e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 2845e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1 2846e2fcbf42SPeter Maydell 284709ce5f2dSPeter Maydell .. parsed-literal:: 2848e2fcbf42SPeter Maydell 2849e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 2850e2fcbf42SPeter Maydell #connect a TAP device to bridge qemubr0 2851e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1 2852e2fcbf42SPeter Maydell 2853e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,listen=[host]:port][,connect=host:port]`` 2854e2fcbf42SPeter Maydell This host network backend can be used to connect the guest's network 2855e2fcbf42SPeter Maydell to another QEMU virtual machine using a TCP socket connection. If 2856e2fcbf42SPeter Maydell ``listen`` is specified, QEMU waits for incoming connections on port 2857e2fcbf42SPeter Maydell (host is optional). ``connect`` is used to connect to another QEMU 2858e2fcbf42SPeter Maydell instance using the ``listen`` option. ``fd``\ =h specifies an 2859e2fcbf42SPeter Maydell already opened TCP socket. 2860e2fcbf42SPeter Maydell 2861e2fcbf42SPeter Maydell Example: 2862e2fcbf42SPeter Maydell 286309ce5f2dSPeter Maydell .. parsed-literal:: 2864e2fcbf42SPeter Maydell 2865e2fcbf42SPeter Maydell # launch a first QEMU instance 2866353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2867353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 2868e2fcbf42SPeter Maydell -netdev socket,id=n1,listen=:1234 2869e2fcbf42SPeter Maydell # connect the network of this instance to the network of the first instance 2870353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2871353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 2872e2fcbf42SPeter Maydell -netdev socket,id=n2,connect=127.0.0.1:1234 2873e2fcbf42SPeter Maydell 2874e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,mcast=maddr:port[,localaddr=addr]]`` 2875e2fcbf42SPeter Maydell Configure a socket host network backend to share the guest's network 2876e2fcbf42SPeter Maydell traffic with another QEMU virtual machines using a UDP multicast 2877e2fcbf42SPeter Maydell socket, effectively making a bus for every QEMU with same multicast 2878e2fcbf42SPeter Maydell address maddr and port. NOTES: 2879e2fcbf42SPeter Maydell 2880e2fcbf42SPeter Maydell 1. Several QEMU can be running on different hosts and share same bus 2881e2fcbf42SPeter Maydell (assuming correct multicast setup for these hosts). 2882e2fcbf42SPeter Maydell 2883e2fcbf42SPeter Maydell 2. mcast support is compatible with User Mode Linux (argument 2884e2fcbf42SPeter Maydell ``ethN=mcast``), see http://user-mode-linux.sf.net. 2885e2fcbf42SPeter Maydell 2886e2fcbf42SPeter Maydell 3. Use ``fd=h`` to specify an already opened UDP multicast socket. 2887e2fcbf42SPeter Maydell 2888e2fcbf42SPeter Maydell Example: 2889e2fcbf42SPeter Maydell 289009ce5f2dSPeter Maydell .. parsed-literal:: 2891e2fcbf42SPeter Maydell 2892e2fcbf42SPeter Maydell # launch one QEMU instance 2893353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2894353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 2895e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=230.0.0.1:1234 2896e2fcbf42SPeter Maydell # launch another QEMU instance on same "bus" 2897353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2898353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 2899e2fcbf42SPeter Maydell -netdev socket,id=n2,mcast=230.0.0.1:1234 2900e2fcbf42SPeter Maydell # launch yet another QEMU instance on same "bus" 2901353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2902353a06b4SLaszlo Ersek -device e1000,netdev=n3,mac=52:54:00:12:34:58 \\ 2903e2fcbf42SPeter Maydell -netdev socket,id=n3,mcast=230.0.0.1:1234 2904e2fcbf42SPeter Maydell 2905e2fcbf42SPeter Maydell Example (User Mode Linux compat.): 2906e2fcbf42SPeter Maydell 290709ce5f2dSPeter Maydell .. parsed-literal:: 2908e2fcbf42SPeter Maydell 2909e2fcbf42SPeter Maydell # launch QEMU instance (note mcast address selected is UML's default) 2910353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2911353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 2912e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102 2913e2fcbf42SPeter Maydell # launch UML 2914e2fcbf42SPeter Maydell /path/to/linux ubd0=/path/to/root_fs eth0=mcast 2915e2fcbf42SPeter Maydell 2916e2fcbf42SPeter Maydell Example (send packets from host's 1.2.3.4): 2917e2fcbf42SPeter Maydell 2918e2fcbf42SPeter Maydell .. parsed-literal:: 2919e2fcbf42SPeter Maydell 2920353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 2921353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 2922e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 2923e2fcbf42SPeter Maydell 29248b0dc246SDaniel P. Berrangé``-netdev l2tpv3,id=id,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6=on|off][,udp=on|off][,cookie64][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]`` 2925e2fcbf42SPeter Maydell Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931) 2926e2fcbf42SPeter Maydell is a popular protocol to transport Ethernet (and other Layer 2) data 2927e2fcbf42SPeter Maydell frames between two systems. It is present in routers, firewalls and 2928e2fcbf42SPeter Maydell the Linux kernel (from version 3.3 onwards). 2929e2fcbf42SPeter Maydell 2930e2fcbf42SPeter Maydell This transport allows a VM to communicate to another VM, router or 2931e2fcbf42SPeter Maydell firewall directly. 2932e2fcbf42SPeter Maydell 2933e2fcbf42SPeter Maydell ``src=srcaddr`` 2934e2fcbf42SPeter Maydell source address (mandatory) 2935e2fcbf42SPeter Maydell 2936e2fcbf42SPeter Maydell ``dst=dstaddr`` 2937e2fcbf42SPeter Maydell destination address (mandatory) 2938e2fcbf42SPeter Maydell 2939e2fcbf42SPeter Maydell ``udp`` 2940e2fcbf42SPeter Maydell select udp encapsulation (default is ip). 2941e2fcbf42SPeter Maydell 2942e2fcbf42SPeter Maydell ``srcport=srcport`` 2943e2fcbf42SPeter Maydell source udp port. 2944e2fcbf42SPeter Maydell 2945e2fcbf42SPeter Maydell ``dstport=dstport`` 2946e2fcbf42SPeter Maydell destination udp port. 2947e2fcbf42SPeter Maydell 2948e2fcbf42SPeter Maydell ``ipv6`` 2949e2fcbf42SPeter Maydell force v6, otherwise defaults to v4. 2950e2fcbf42SPeter Maydell 2951e2fcbf42SPeter Maydell ``rxcookie=rxcookie``; \ ``txcookie=txcookie`` 2952e2fcbf42SPeter Maydell Cookies are a weak form of security in the l2tpv3 specification. 2953e2fcbf42SPeter Maydell Their function is mostly to prevent misconfiguration. By default 2954e2fcbf42SPeter Maydell they are 32 bit. 2955e2fcbf42SPeter Maydell 2956e2fcbf42SPeter Maydell ``cookie64`` 2957e2fcbf42SPeter Maydell Set cookie size to 64 bit instead of the default 32 2958e2fcbf42SPeter Maydell 2959e2fcbf42SPeter Maydell ``counter=off`` 2960e2fcbf42SPeter Maydell Force a 'cut-down' L2TPv3 with no counter as in 2961e2fcbf42SPeter Maydell draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 2962e2fcbf42SPeter Maydell 2963e2fcbf42SPeter Maydell ``pincounter=on`` 2964e2fcbf42SPeter Maydell Work around broken counter handling in peer. This may also help 2965e2fcbf42SPeter Maydell on networks which have packet reorder. 2966e2fcbf42SPeter Maydell 2967e2fcbf42SPeter Maydell ``offset=offset`` 2968e2fcbf42SPeter Maydell Add an extra offset between header and data 2969e2fcbf42SPeter Maydell 2970e2fcbf42SPeter Maydell For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to 2971e2fcbf42SPeter Maydell the bridge br-lan on the remote Linux host 1.2.3.4: 2972e2fcbf42SPeter Maydell 297309ce5f2dSPeter Maydell .. parsed-literal:: 2974e2fcbf42SPeter Maydell 2975e2fcbf42SPeter Maydell # Setup tunnel on linux host using raw ip as encapsulation 2976e2fcbf42SPeter Maydell # on 1.2.3.4 2977353a06b4SLaszlo Ersek ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \\ 2978e2fcbf42SPeter Maydell encap udp udp_sport 16384 udp_dport 16384 2979353a06b4SLaszlo Ersek ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \\ 2980e2fcbf42SPeter Maydell 0xFFFFFFFF peer_session_id 0xFFFFFFFF 2981e2fcbf42SPeter Maydell ifconfig vmtunnel0 mtu 1500 2982e2fcbf42SPeter Maydell ifconfig vmtunnel0 up 2983e2fcbf42SPeter Maydell brctl addif br-lan vmtunnel0 2984e2fcbf42SPeter Maydell 2985e2fcbf42SPeter Maydell 2986e2fcbf42SPeter Maydell # on 4.3.2.1 2987e2fcbf42SPeter Maydell # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 2988e2fcbf42SPeter Maydell 2989353a06b4SLaszlo Ersek |qemu_system| linux.img -device e1000,netdev=n1 \\ 2990e2fcbf42SPeter Maydell -netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter 2991e2fcbf42SPeter Maydell 2992e2fcbf42SPeter Maydell``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]`` 2993e2fcbf42SPeter Maydell Configure VDE backend to connect to PORT n of a vde switch running 2994e2fcbf42SPeter Maydell on host and listening for incoming connections on socketpath. Use 2995e2fcbf42SPeter Maydell GROUP groupname and MODE octalmode to change default ownership and 2996e2fcbf42SPeter Maydell permissions for communication port. This option is only available if 2997e2fcbf42SPeter Maydell QEMU has been compiled with vde support enabled. 2998e2fcbf42SPeter Maydell 2999e2fcbf42SPeter Maydell Example: 3000e2fcbf42SPeter Maydell 300109ce5f2dSPeter Maydell .. parsed-literal:: 3002e2fcbf42SPeter Maydell 3003e2fcbf42SPeter Maydell # launch vde switch 3004e2fcbf42SPeter Maydell vde_switch -F -sock /tmp/myswitch 3005e2fcbf42SPeter Maydell # launch QEMU instance 3006e2fcbf42SPeter Maydell |qemu_system| linux.img -nic vde,sock=/tmp/myswitch 3007e2fcbf42SPeter Maydell 3008e2fcbf42SPeter Maydell``-netdev vhost-user,chardev=id[,vhostforce=on|off][,queues=n]`` 3009e2fcbf42SPeter Maydell Establish a vhost-user netdev, backed by a chardev id. The chardev 3010e2fcbf42SPeter Maydell should be a unix domain socket backed one. The vhost-user uses a 3011e2fcbf42SPeter Maydell specifically defined protocol to pass vhost ioctl replacement 3012e2fcbf42SPeter Maydell messages to an application on the other end of the socket. On 3013e2fcbf42SPeter Maydell non-MSIX guests, the feature can be forced with vhostforce. Use 3014e2fcbf42SPeter Maydell 'queues=n' to specify the number of queues to be created for 3015e2fcbf42SPeter Maydell multiqueue vhost-user. 3016e2fcbf42SPeter Maydell 3017e2fcbf42SPeter Maydell Example: 3018e2fcbf42SPeter Maydell 3019e2fcbf42SPeter Maydell :: 3020e2fcbf42SPeter Maydell 3021e2fcbf42SPeter Maydell qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 3022e2fcbf42SPeter Maydell -numa node,memdev=mem \ 3023e2fcbf42SPeter Maydell -chardev socket,id=chr0,path=/path/to/socket \ 3024e2fcbf42SPeter Maydell -netdev type=vhost-user,id=net0,chardev=chr0 \ 3025e2fcbf42SPeter Maydell -device virtio-net-pci,netdev=net0 3026e2fcbf42SPeter Maydell 3027108a6481SCindy Lu``-netdev vhost-vdpa,vhostdev=/path/to/dev`` 3028108a6481SCindy Lu Establish a vhost-vdpa netdev. 3029108a6481SCindy Lu 3030108a6481SCindy Lu vDPA device is a device that uses a datapath which complies with 3031108a6481SCindy Lu the virtio specifications with a vendor specific control path. 3032108a6481SCindy Lu vDPA devices can be both physically located on the hardware or 3033108a6481SCindy Lu emulated by software. 3034108a6481SCindy Lu 3035e2fcbf42SPeter Maydell``-netdev hubport,id=id,hubid=hubid[,netdev=nd]`` 3036e2fcbf42SPeter Maydell Create a hub port on the emulated hub with ID hubid. 3037e2fcbf42SPeter Maydell 3038e2fcbf42SPeter Maydell The hubport netdev lets you connect a NIC to a QEMU emulated hub 3039e2fcbf42SPeter Maydell instead of a single netdev. Alternatively, you can also connect the 3040e2fcbf42SPeter Maydell hubport to another netdev with ID nd by using the ``netdev=nd`` 3041e2fcbf42SPeter Maydell option. 3042e2fcbf42SPeter Maydell 3043e2fcbf42SPeter Maydell``-net nic[,netdev=nd][,macaddr=mac][,model=type] [,name=name][,addr=addr][,vectors=v]`` 3044e2fcbf42SPeter Maydell Legacy option to configure or create an on-board (or machine 3045e2fcbf42SPeter Maydell default) Network Interface Card(NIC) and connect it either to the 3046e2fcbf42SPeter Maydell emulated hub with ID 0 (i.e. the default hub), or to the netdev nd. 3047e2fcbf42SPeter Maydell If model is omitted, then the default NIC model associated with the 3048e2fcbf42SPeter Maydell machine type is used. Note that the default NIC model may change in 3049e2fcbf42SPeter Maydell future QEMU releases, so it is highly recommended to always specify 3050e2fcbf42SPeter Maydell a model. Optionally, the MAC address can be changed to mac, the 3051e2fcbf42SPeter Maydell device address set to addr (PCI cards only), and a name can be 3052e2fcbf42SPeter Maydell assigned for use in monitor commands. Optionally, for PCI cards, you 3053e2fcbf42SPeter Maydell can specify the number v of MSI-X vectors that the card should have; 3054e2fcbf42SPeter Maydell this option currently only affects virtio cards; set v = 0 to 3055e2fcbf42SPeter Maydell disable MSI-X. If no ``-net`` option is specified, a single NIC is 3056e2fcbf42SPeter Maydell created. QEMU can emulate several different models of network card. 3057e2fcbf42SPeter Maydell Use ``-net nic,model=help`` for a list of available devices for your 3058e2fcbf42SPeter Maydell target. 3059e2fcbf42SPeter Maydell 3060e2fcbf42SPeter Maydell``-net user|tap|bridge|socket|l2tpv3|vde[,...][,name=name]`` 3061e2fcbf42SPeter Maydell Configure a host network backend (with the options corresponding to 3062e2fcbf42SPeter Maydell the same ``-netdev`` option) and connect it to the emulated hub 0 3063e2fcbf42SPeter Maydell (the default hub). Use name to specify the name of the hub port. 3064e2fcbf42SPeter MaydellERST 30655824d651Sblueswir1 30667273a2dbSMatthew BoothDEFHEADING() 30677273a2dbSMatthew Booth 3068de6b4f90SMarkus ArmbrusterDEFHEADING(Character device options:) 30697273a2dbSMatthew Booth 30707273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 3071517b3d40SLin Ma "-chardev help\n" 3072d0d7708bSDaniel P. Berrange "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3073a9b1315fSPaolo Bonzini "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off][,reconnect=seconds]\n" 3074bfdc1267SDaniel P. Berrangé " [,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds][,mux=on|off]\n" 3075fd4a5fd4SDaniel P. Berrange " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n" 3076bfdc1267SDaniel P. Berrangé "-chardev socket,id=id,path=path[,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds]\n" 3077e339273bSxiaoqiang zhao " [,mux=on|off][,logfile=PATH][,logappend=on|off][,abstract=on|off][,tight=on|off] (unix)\n" 30787273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 3079bfdc1267SDaniel P. Berrangé " [,localport=localport][,ipv4=on|off][,ipv6=on|off][,mux=on|off]\n" 3080d0d7708bSDaniel P. Berrange " [,logfile=PATH][,logappend=on|off]\n" 3081d0d7708bSDaniel P. Berrange "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 30827273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 3083d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3084d0d7708bSDaniel P. Berrange "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 3085d0d7708bSDaniel P. Berrange "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3086d0d7708bSDaniel P. Berrange "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 30877273a2dbSMatthew Booth#ifdef _WIN32 3088d0d7708bSDaniel P. Berrange "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3089d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 30907273a2dbSMatthew Booth#else 3091d0d7708bSDaniel P. Berrange "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3092d0d7708bSDaniel P. Berrange "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 30937273a2dbSMatthew Booth#endif 30947273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 3095d0d7708bSDaniel P. Berrange "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 30967273a2dbSMatthew Booth#endif 30977273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 30987273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 3099d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3100d0d7708bSDaniel P. Berrange "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 31017273a2dbSMatthew Booth#endif 31027273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 3103d0d7708bSDaniel P. Berrange "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3104d0d7708bSDaniel P. Berrange "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 31057273a2dbSMatthew Booth#endif 3106cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 3107d0d7708bSDaniel P. Berrange "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3108d0d7708bSDaniel P. Berrange "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3109cbcc6336SAlon Levy#endif 3110ad96090aSBlue Swirl , QEMU_ARCH_ALL 31117273a2dbSMatthew Booth) 31127273a2dbSMatthew Booth 3113e2fcbf42SPeter MaydellSRST 3114e2fcbf42SPeter MaydellThe general form of a character device option is: 3115e2fcbf42SPeter Maydell 3116e2fcbf42SPeter Maydell``-chardev backend,id=id[,mux=on|off][,options]`` 3117e2fcbf42SPeter Maydell Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, 3118e2fcbf42SPeter Maydell ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``, 3119e2fcbf42SPeter Maydell ``pty``, ``stdio``, ``braille``, ``tty``, ``parallel``, ``parport``, 3120e2fcbf42SPeter Maydell ``spicevmc``, ``spiceport``. The specific backend will determine the 3121e2fcbf42SPeter Maydell applicable options. 3122e2fcbf42SPeter Maydell 3123e2fcbf42SPeter Maydell Use ``-chardev help`` to print all available chardev backend types. 3124e2fcbf42SPeter Maydell 3125e2fcbf42SPeter Maydell All devices must have an id, which can be any string up to 127 3126e2fcbf42SPeter Maydell characters long. It is used to uniquely identify this device in 3127e2fcbf42SPeter Maydell other command line directives. 3128e2fcbf42SPeter Maydell 3129e2fcbf42SPeter Maydell A character device may be used in multiplexing mode by multiple 3130e2fcbf42SPeter Maydell front-ends. Specify ``mux=on`` to enable this mode. A multiplexer is 3131e2fcbf42SPeter Maydell a "1:N" device, and here the "1" end is your specified chardev 3132e2fcbf42SPeter Maydell backend, and the "N" end is the various parts of QEMU that can talk 3133e2fcbf42SPeter Maydell to a chardev. If you create a chardev with ``id=myid`` and 3134e2fcbf42SPeter Maydell ``mux=on``, QEMU will create a multiplexer with your specified ID, 3135e2fcbf42SPeter Maydell and you can then configure multiple front ends to use that chardev 3136e2fcbf42SPeter Maydell ID for their input/output. Up to four different front ends can be 3137e2fcbf42SPeter Maydell connected to a single multiplexed chardev. (Without multiplexing 3138e2fcbf42SPeter Maydell enabled, a chardev can only be used by a single front end.) For 3139e2fcbf42SPeter Maydell instance you could use this to allow a single stdio chardev to be 3140e2fcbf42SPeter Maydell used by two serial ports and the QEMU monitor: 3141e2fcbf42SPeter Maydell 3142e2fcbf42SPeter Maydell :: 3143e2fcbf42SPeter Maydell 3144e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3145e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3146e2fcbf42SPeter Maydell -serial chardev:char0 \ 3147e2fcbf42SPeter Maydell -serial chardev:char0 3148e2fcbf42SPeter Maydell 3149e2fcbf42SPeter Maydell You can have more than one multiplexer in a system configuration; 3150e2fcbf42SPeter Maydell for instance you could have a TCP port multiplexed between UART 0 3151e2fcbf42SPeter Maydell and UART 1, and stdio multiplexed between the QEMU monitor and a 3152e2fcbf42SPeter Maydell parallel port: 3153e2fcbf42SPeter Maydell 3154e2fcbf42SPeter Maydell :: 3155e2fcbf42SPeter Maydell 3156e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3157e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3158e2fcbf42SPeter Maydell -parallel chardev:char0 \ 3159e2fcbf42SPeter Maydell -chardev tcp,...,mux=on,id=char1 \ 3160e2fcbf42SPeter Maydell -serial chardev:char1 \ 3161e2fcbf42SPeter Maydell -serial chardev:char1 3162e2fcbf42SPeter Maydell 3163e2fcbf42SPeter Maydell When you're using a multiplexed character device, some escape 3164923e9311SThomas Huth sequences are interpreted in the input. See the chapter about 3165923e9311SThomas Huth :ref:`keys in the character backend multiplexer` in the 3166923e9311SThomas Huth System Emulation Users Guide for more details. 3167e2fcbf42SPeter Maydell 3168e2fcbf42SPeter Maydell Note that some other command line options may implicitly create 3169e2fcbf42SPeter Maydell multiplexed character backends; for instance ``-serial mon:stdio`` 3170e2fcbf42SPeter Maydell creates a multiplexed stdio backend connected to the serial port and 3171e2fcbf42SPeter Maydell the QEMU monitor, and ``-nographic`` also multiplexes the console 3172e2fcbf42SPeter Maydell and the monitor to stdio. 3173e2fcbf42SPeter Maydell 3174e2fcbf42SPeter Maydell There is currently no support for multiplexing in the other 3175e2fcbf42SPeter Maydell direction (where a single QEMU front end takes input and output from 3176e2fcbf42SPeter Maydell multiple chardevs). 3177e2fcbf42SPeter Maydell 3178e2fcbf42SPeter Maydell Every backend supports the ``logfile`` option, which supplies the 3179e2fcbf42SPeter Maydell path to a file to record all data transmitted via the backend. The 3180e2fcbf42SPeter Maydell ``logappend`` option controls whether the log file will be truncated 3181e2fcbf42SPeter Maydell or appended to when opened. 3182e2fcbf42SPeter Maydell 3183e2fcbf42SPeter MaydellThe available backends are: 3184e2fcbf42SPeter Maydell 3185e2fcbf42SPeter Maydell``-chardev null,id=id`` 3186e2fcbf42SPeter Maydell A void device. This device will not emit any data, and will drop any 3187e2fcbf42SPeter Maydell data it receives. The null backend does not take any options. 3188e2fcbf42SPeter Maydell 3189bfdc1267SDaniel P. Berrangé``-chardev socket,id=id[,TCP options or unix options][,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds][,tls-creds=id][,tls-authz=id]`` 3190e2fcbf42SPeter Maydell Create a two-way stream socket, which can be either a TCP or a unix 3191e2fcbf42SPeter Maydell socket. A unix socket will be created if ``path`` is specified. 3192e2fcbf42SPeter Maydell Behaviour is undefined if TCP options are specified for a unix 3193e2fcbf42SPeter Maydell socket. 3194e2fcbf42SPeter Maydell 3195bfdc1267SDaniel P. Berrangé ``server=on|off`` specifies that the socket shall be a listening socket. 3196e2fcbf42SPeter Maydell 3197bfdc1267SDaniel P. Berrangé ``wait=on|off`` specifies that QEMU should not block waiting for a client 3198e2fcbf42SPeter Maydell to connect to a listening socket. 3199e2fcbf42SPeter Maydell 3200bfdc1267SDaniel P. Berrangé ``telnet=on|off`` specifies that traffic on the socket should interpret 3201e2fcbf42SPeter Maydell telnet escape sequences. 3202e2fcbf42SPeter Maydell 3203bfdc1267SDaniel P. Berrangé ``websocket=on|off`` specifies that the socket uses WebSocket protocol for 3204e2fcbf42SPeter Maydell communication. 3205e2fcbf42SPeter Maydell 3206e2fcbf42SPeter Maydell ``reconnect`` sets the timeout for reconnecting on non-server 3207e2fcbf42SPeter Maydell sockets when the remote end goes away. qemu will delay this many 3208e2fcbf42SPeter Maydell seconds and then attempt to reconnect. Zero disables reconnecting, 3209e2fcbf42SPeter Maydell and is the default. 3210e2fcbf42SPeter Maydell 3211e2fcbf42SPeter Maydell ``tls-creds`` requests enablement of the TLS protocol for 3212e2fcbf42SPeter Maydell encryption, and specifies the id of the TLS credentials to use for 3213e2fcbf42SPeter Maydell the handshake. The credentials must be previously created with the 3214e2fcbf42SPeter Maydell ``-object tls-creds`` argument. 3215e2fcbf42SPeter Maydell 3216e2fcbf42SPeter Maydell ``tls-auth`` provides the ID of the QAuthZ authorization object 3217e2fcbf42SPeter Maydell against which the client's x509 distinguished name will be 3218e2fcbf42SPeter Maydell validated. This object is only resolved at time of use, so can be 3219e2fcbf42SPeter Maydell deleted and recreated on the fly while the chardev server is active. 3220e2fcbf42SPeter Maydell If missing, it will default to denying access. 3221e2fcbf42SPeter Maydell 3222e2fcbf42SPeter Maydell TCP and unix socket options are given below: 3223e2fcbf42SPeter Maydell 3224a9b1315fSPaolo Bonzini ``TCP options: port=port[,host=host][,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]`` 3225e2fcbf42SPeter Maydell ``host`` for a listening socket specifies the local address to 3226e2fcbf42SPeter Maydell be bound. For a connecting socket species the remote host to 3227e2fcbf42SPeter Maydell connect to. ``host`` is optional for listening sockets. If not 3228e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3229e2fcbf42SPeter Maydell 3230e2fcbf42SPeter Maydell ``port`` for a listening socket specifies the local port to be 3231e2fcbf42SPeter Maydell bound. For a connecting socket specifies the port on the remote 3232e2fcbf42SPeter Maydell host to connect to. ``port`` can be given as either a port 3233e2fcbf42SPeter Maydell number or a service name. ``port`` is required. 3234e2fcbf42SPeter Maydell 3235e2fcbf42SPeter Maydell ``to`` is only relevant to listening sockets. If it is 3236e2fcbf42SPeter Maydell specified, and ``port`` cannot be bound, QEMU will attempt to 3237e2fcbf42SPeter Maydell bind to subsequent ports up to and including ``to`` until it 3238e2fcbf42SPeter Maydell succeeds. ``to`` must be specified as a port number. 3239e2fcbf42SPeter Maydell 3240bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 3241bfdc1267SDaniel P. Berrangé or IPv6 must be used. If neither is specified the socket may 3242bfdc1267SDaniel P. Berrangé use either protocol. 3243e2fcbf42SPeter Maydell 3244a9b1315fSPaolo Bonzini ``nodelay=on|off`` disables the Nagle algorithm. 3245e2fcbf42SPeter Maydell 3246e339273bSxiaoqiang zhao ``unix options: path=path[,abstract=on|off][,tight=on|off]`` 3247e2fcbf42SPeter Maydell ``path`` specifies the local path of the unix socket. ``path`` 3248e2fcbf42SPeter Maydell is required. 3249bfdc1267SDaniel P. Berrangé ``abstract=on|off`` specifies the use of the abstract socket namespace, 3250e339273bSxiaoqiang zhao rather than the filesystem. Optional, defaults to false. 3251bfdc1267SDaniel P. Berrangé ``tight=on|off`` sets the socket length of abstract sockets to their minimum, 3252e339273bSxiaoqiang zhao rather than the full sun_path length. Optional, defaults to true. 3253e2fcbf42SPeter Maydell 3254bfdc1267SDaniel P. Berrangé``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4=on|off][,ipv6=on|off]`` 3255e2fcbf42SPeter Maydell Sends all traffic from the guest to a remote host over UDP. 3256e2fcbf42SPeter Maydell 3257e2fcbf42SPeter Maydell ``host`` specifies the remote host to connect to. If not specified 3258e2fcbf42SPeter Maydell it defaults to ``localhost``. 3259e2fcbf42SPeter Maydell 3260e2fcbf42SPeter Maydell ``port`` specifies the port on the remote host to connect to. 3261e2fcbf42SPeter Maydell ``port`` is required. 3262e2fcbf42SPeter Maydell 3263e2fcbf42SPeter Maydell ``localaddr`` specifies the local address to bind to. If not 3264e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3265e2fcbf42SPeter Maydell 3266e2fcbf42SPeter Maydell ``localport`` specifies the local port to bind to. If not specified 3267e2fcbf42SPeter Maydell any available local port will be used. 3268e2fcbf42SPeter Maydell 3269bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 or IPv6 must be used. 3270e2fcbf42SPeter Maydell If neither is specified the device may use either protocol. 3271e2fcbf42SPeter Maydell 3272e2fcbf42SPeter Maydell``-chardev msmouse,id=id`` 3273e2fcbf42SPeter Maydell Forward QEMU's emulated msmouse events to the guest. ``msmouse`` 3274e2fcbf42SPeter Maydell does not take any options. 3275e2fcbf42SPeter Maydell 3276e2fcbf42SPeter Maydell``-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]`` 3277e2fcbf42SPeter Maydell Connect to a QEMU text console. ``vc`` may optionally be given a 3278e2fcbf42SPeter Maydell specific size. 3279e2fcbf42SPeter Maydell 3280e2fcbf42SPeter Maydell ``width`` and ``height`` specify the width and height respectively 3281e2fcbf42SPeter Maydell of the console, in pixels. 3282e2fcbf42SPeter Maydell 3283e2fcbf42SPeter Maydell ``cols`` and ``rows`` specify that the console be sized to fit a 3284e2fcbf42SPeter Maydell text console with the given dimensions. 3285e2fcbf42SPeter Maydell 3286e2fcbf42SPeter Maydell``-chardev ringbuf,id=id[,size=size]`` 3287e2fcbf42SPeter Maydell Create a ring buffer with fixed size ``size``. size must be a power 3288e2fcbf42SPeter Maydell of two and defaults to ``64K``. 3289e2fcbf42SPeter Maydell 3290e2fcbf42SPeter Maydell``-chardev file,id=id,path=path`` 3291e2fcbf42SPeter Maydell Log all traffic received from the guest to a file. 3292e2fcbf42SPeter Maydell 3293e2fcbf42SPeter Maydell ``path`` specifies the path of the file to be opened. This file will 3294e2fcbf42SPeter Maydell be created if it does not already exist, and overwritten if it does. 3295e2fcbf42SPeter Maydell ``path`` is required. 3296e2fcbf42SPeter Maydell 3297e2fcbf42SPeter Maydell``-chardev pipe,id=id,path=path`` 3298e2fcbf42SPeter Maydell Create a two-way connection to the guest. The behaviour differs 3299e2fcbf42SPeter Maydell slightly between Windows hosts and other hosts: 3300e2fcbf42SPeter Maydell 3301e2fcbf42SPeter Maydell On Windows, a single duplex pipe will be created at 3302e2fcbf42SPeter Maydell ``\\.pipe\path``. 3303e2fcbf42SPeter Maydell 3304e2fcbf42SPeter Maydell On other hosts, 2 pipes will be created called ``path.in`` and 3305e2fcbf42SPeter Maydell ``path.out``. Data written to ``path.in`` will be received by the 3306e2fcbf42SPeter Maydell guest. Data written by the guest can be read from ``path.out``. QEMU 3307e2fcbf42SPeter Maydell will not create these fifos, and requires them to be present. 3308e2fcbf42SPeter Maydell 3309e2fcbf42SPeter Maydell ``path`` forms part of the pipe path as described above. ``path`` is 3310e2fcbf42SPeter Maydell required. 3311e2fcbf42SPeter Maydell 3312e2fcbf42SPeter Maydell``-chardev console,id=id`` 3313e2fcbf42SPeter Maydell Send traffic from the guest to QEMU's standard output. ``console`` 3314e2fcbf42SPeter Maydell does not take any options. 3315e2fcbf42SPeter Maydell 3316e2fcbf42SPeter Maydell ``console`` is only available on Windows hosts. 3317e2fcbf42SPeter Maydell 3318e2fcbf42SPeter Maydell``-chardev serial,id=id,path=path`` 3319e2fcbf42SPeter Maydell Send traffic from the guest to a serial device on the host. 3320e2fcbf42SPeter Maydell 3321e2fcbf42SPeter Maydell On Unix hosts serial will actually accept any tty device, not only 3322e2fcbf42SPeter Maydell serial lines. 3323e2fcbf42SPeter Maydell 3324e2fcbf42SPeter Maydell ``path`` specifies the name of the serial device to open. 3325e2fcbf42SPeter Maydell 3326e2fcbf42SPeter Maydell``-chardev pty,id=id`` 3327e2fcbf42SPeter Maydell Create a new pseudo-terminal on the host and connect to it. ``pty`` 3328e2fcbf42SPeter Maydell does not take any options. 3329e2fcbf42SPeter Maydell 3330e2fcbf42SPeter Maydell ``pty`` is not available on Windows hosts. 3331e2fcbf42SPeter Maydell 3332e2fcbf42SPeter Maydell``-chardev stdio,id=id[,signal=on|off]`` 3333e2fcbf42SPeter Maydell Connect to standard input and standard output of the QEMU process. 3334e2fcbf42SPeter Maydell 3335e2fcbf42SPeter Maydell ``signal`` controls if signals are enabled on the terminal, that 3336e2fcbf42SPeter Maydell includes exiting QEMU with the key sequence Control-c. This option 3337e2fcbf42SPeter Maydell is enabled by default, use ``signal=off`` to disable it. 3338e2fcbf42SPeter Maydell 3339e2fcbf42SPeter Maydell``-chardev braille,id=id`` 3340e2fcbf42SPeter Maydell Connect to a local BrlAPI server. ``braille`` does not take any 3341e2fcbf42SPeter Maydell options. 3342e2fcbf42SPeter Maydell 3343e2fcbf42SPeter Maydell``-chardev tty,id=id,path=path`` 3344e2fcbf42SPeter Maydell ``tty`` is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD 3345e2fcbf42SPeter Maydell and DragonFlyBSD hosts. It is an alias for ``serial``. 3346e2fcbf42SPeter Maydell 3347e2fcbf42SPeter Maydell ``path`` specifies the path to the tty. ``path`` is required. 3348e2fcbf42SPeter Maydell 334909ce5f2dSPeter Maydell``-chardev parallel,id=id,path=path`` 335009ce5f2dSPeter Maydell \ 335109ce5f2dSPeter Maydell``-chardev parport,id=id,path=path`` 3352e2fcbf42SPeter Maydell ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD 3353e2fcbf42SPeter Maydell hosts. 3354e2fcbf42SPeter Maydell 3355e2fcbf42SPeter Maydell Connect to a local parallel port. 3356e2fcbf42SPeter Maydell 3357e2fcbf42SPeter Maydell ``path`` specifies the path to the parallel port device. ``path`` is 3358e2fcbf42SPeter Maydell required. 3359e2fcbf42SPeter Maydell 3360e2fcbf42SPeter Maydell``-chardev spicevmc,id=id,debug=debug,name=name`` 3361e2fcbf42SPeter Maydell ``spicevmc`` is only available when spice support is built in. 3362e2fcbf42SPeter Maydell 3363e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3364e2fcbf42SPeter Maydell 3365e2fcbf42SPeter Maydell ``name`` name of spice channel to connect to 3366e2fcbf42SPeter Maydell 3367e2fcbf42SPeter Maydell Connect to a spice virtual machine channel, such as vdiport. 3368e2fcbf42SPeter Maydell 3369e2fcbf42SPeter Maydell``-chardev spiceport,id=id,debug=debug,name=name`` 3370e2fcbf42SPeter Maydell ``spiceport`` is only available when spice support is built in. 3371e2fcbf42SPeter Maydell 3372e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3373e2fcbf42SPeter Maydell 3374e2fcbf42SPeter Maydell ``name`` name of spice port to connect to 3375e2fcbf42SPeter Maydell 3376e2fcbf42SPeter Maydell Connect to a spice port, allowing a Spice client to handle the 3377e2fcbf42SPeter Maydell traffic identified by a name (preferably a fqdn). 3378e2fcbf42SPeter MaydellERST 33797273a2dbSMatthew Booth 33807273a2dbSMatthew BoothDEFHEADING() 33817273a2dbSMatthew Booth 3382d1a0cf73SStefan Berger#ifdef CONFIG_TPM 3383de6b4f90SMarkus ArmbrusterDEFHEADING(TPM device options:) 3384d1a0cf73SStefan Berger 3385d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 338692dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 338792dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 338892dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 3389f4ede81eSAmarnath Valluri " not provided it will be searched for in /sys/class/misc/tpm?/device\n" 3390f4ede81eSAmarnath Valluri "-tpmdev emulator,id=id,chardev=dev\n" 3391f4ede81eSAmarnath Valluri " configure the TPM device using chardev backend\n", 3392d1a0cf73SStefan Berger QEMU_ARCH_ALL) 3393e2fcbf42SPeter MaydellSRST 3394e2fcbf42SPeter MaydellThe general form of a TPM device option is: 3395e2fcbf42SPeter Maydell 3396e2fcbf42SPeter Maydell``-tpmdev backend,id=id[,options]`` 3397e2fcbf42SPeter Maydell The specific backend type will determine the applicable options. The 3398e2fcbf42SPeter Maydell ``-tpmdev`` option creates the TPM backend and requires a 3399e2fcbf42SPeter Maydell ``-device`` option that specifies the TPM frontend interface model. 3400e2fcbf42SPeter Maydell 3401e2fcbf42SPeter Maydell Use ``-tpmdev help`` to print all available TPM backend types. 3402e2fcbf42SPeter Maydell 3403e2fcbf42SPeter MaydellThe available backends are: 3404e2fcbf42SPeter Maydell 3405e2fcbf42SPeter Maydell``-tpmdev passthrough,id=id,path=path,cancel-path=cancel-path`` 3406e2fcbf42SPeter Maydell (Linux-host only) Enable access to the host's TPM using the 3407e2fcbf42SPeter Maydell passthrough driver. 3408e2fcbf42SPeter Maydell 3409e2fcbf42SPeter Maydell ``path`` specifies the path to the host's TPM device, i.e., on a 3410e2fcbf42SPeter Maydell Linux host this would be ``/dev/tpm0``. ``path`` is optional and by 3411e2fcbf42SPeter Maydell default ``/dev/tpm0`` is used. 3412e2fcbf42SPeter Maydell 3413e2fcbf42SPeter Maydell ``cancel-path`` specifies the path to the host TPM device's sysfs 3414e2fcbf42SPeter Maydell entry allowing for cancellation of an ongoing TPM command. 3415e2fcbf42SPeter Maydell ``cancel-path`` is optional and by default QEMU will search for the 3416e2fcbf42SPeter Maydell sysfs entry to use. 3417e2fcbf42SPeter Maydell 3418e2fcbf42SPeter Maydell Some notes about using the host's TPM with the passthrough driver: 3419e2fcbf42SPeter Maydell 3420e2fcbf42SPeter Maydell The TPM device accessed by the passthrough driver must not be used 3421e2fcbf42SPeter Maydell by any other application on the host. 3422e2fcbf42SPeter Maydell 3423e2fcbf42SPeter Maydell Since the host's firmware (BIOS/UEFI) has already initialized the 3424e2fcbf42SPeter Maydell TPM, the VM's firmware (BIOS/UEFI) will not be able to initialize 3425e2fcbf42SPeter Maydell the TPM again and may therefore not show a TPM-specific menu that 3426e2fcbf42SPeter Maydell would otherwise allow the user to configure the TPM, e.g., allow the 3427e2fcbf42SPeter Maydell user to enable/disable or activate/deactivate the TPM. Further, if 3428e2fcbf42SPeter Maydell TPM ownership is released from within a VM then the host's TPM will 3429e2fcbf42SPeter Maydell get disabled and deactivated. To enable and activate the TPM again 3430e2fcbf42SPeter Maydell afterwards, the host has to be rebooted and the user is required to 3431e2fcbf42SPeter Maydell enter the firmware's menu to enable and activate the TPM. If the TPM 3432e2fcbf42SPeter Maydell is left disabled and/or deactivated most TPM commands will fail. 3433e2fcbf42SPeter Maydell 3434e2fcbf42SPeter Maydell To create a passthrough TPM use the following two options: 3435e2fcbf42SPeter Maydell 3436e2fcbf42SPeter Maydell :: 3437e2fcbf42SPeter Maydell 3438e2fcbf42SPeter Maydell -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 3439e2fcbf42SPeter Maydell 3440e2fcbf42SPeter Maydell Note that the ``-tpmdev`` id is ``tpm0`` and is referenced by 3441e2fcbf42SPeter Maydell ``tpmdev=tpm0`` in the device option. 3442e2fcbf42SPeter Maydell 3443e2fcbf42SPeter Maydell``-tpmdev emulator,id=id,chardev=dev`` 3444e2fcbf42SPeter Maydell (Linux-host only) Enable access to a TPM emulator using Unix domain 3445e2fcbf42SPeter Maydell socket based chardev backend. 3446e2fcbf42SPeter Maydell 3447e2fcbf42SPeter Maydell ``chardev`` specifies the unique ID of a character device backend 3448e2fcbf42SPeter Maydell that provides connection to the software TPM server. 3449e2fcbf42SPeter Maydell 3450e2fcbf42SPeter Maydell To create a TPM emulator backend device with chardev socket backend: 3451e2fcbf42SPeter Maydell 3452e2fcbf42SPeter Maydell :: 3453e2fcbf42SPeter Maydell 3454e2fcbf42SPeter Maydell -chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0 3455e2fcbf42SPeter MaydellERST 3456d1a0cf73SStefan Berger 3457d1a0cf73SStefan BergerDEFHEADING() 3458d1a0cf73SStefan Berger 3459d1a0cf73SStefan Berger#endif 3460d1a0cf73SStefan Berger 3461de6b4f90SMarkus ArmbrusterDEFHEADING(Linux/Multiboot boot specific:) 3462e2fcbf42SPeter MaydellSRST 3463e2fcbf42SPeter MaydellWhen using these options, you can use a given Linux or Multiboot kernel 3464e2fcbf42SPeter Maydellwithout installing it in the disk image. It can be useful for easier 3465e2fcbf42SPeter Maydelltesting of various kernels. 3466e2fcbf42SPeter Maydell 3467e2fcbf42SPeter Maydell 3468e2fcbf42SPeter MaydellERST 34695824d651Sblueswir1 34705824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 3471ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 3472e2fcbf42SPeter MaydellSRST 3473e2fcbf42SPeter Maydell``-kernel bzImage`` 3474e2fcbf42SPeter Maydell Use bzImage as kernel image. The kernel can be either a Linux kernel 3475e2fcbf42SPeter Maydell or in multiboot format. 3476e2fcbf42SPeter MaydellERST 34775824d651Sblueswir1 34785824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 3479ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 3480e2fcbf42SPeter MaydellSRST 3481e2fcbf42SPeter Maydell``-append cmdline`` 3482e2fcbf42SPeter Maydell Use cmdline as kernel command line 3483e2fcbf42SPeter MaydellERST 34845824d651Sblueswir1 34855824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 3486ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 3487e2fcbf42SPeter MaydellSRST 3488e2fcbf42SPeter Maydell``-initrd file`` 3489e2fcbf42SPeter Maydell Use file as initial ram disk. 3490e2fcbf42SPeter Maydell 3491e2fcbf42SPeter Maydell``-initrd "file1 arg=foo,file2"`` 3492e2fcbf42SPeter Maydell This syntax is only available with multiboot. 3493e2fcbf42SPeter Maydell 3494e2fcbf42SPeter Maydell Use file1 and file2 as modules and pass arg=foo as parameter to the 3495e2fcbf42SPeter Maydell first module. 3496e2fcbf42SPeter MaydellERST 34975824d651Sblueswir1 3498412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 3499379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 3500e2fcbf42SPeter MaydellSRST 3501e2fcbf42SPeter Maydell``-dtb file`` 3502e2fcbf42SPeter Maydell Use file as a device tree binary (dtb) image and pass it to the 3503e2fcbf42SPeter Maydell kernel on boot. 3504e2fcbf42SPeter MaydellERST 3505412beee6SGrant Likely 35065824d651Sblueswir1DEFHEADING() 35075824d651Sblueswir1 3508de6b4f90SMarkus ArmbrusterDEFHEADING(Debug/Expert options:) 35095824d651Sblueswir1 351081b2b810SGabriel L. SomloDEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 351181b2b810SGabriel L. Somlo "-fw_cfg [name=]<name>,file=<file>\n" 351263d3145aSMarkus Armbruster " add named fw_cfg entry with contents from file\n" 35136407d76eSGabriel L. Somlo "-fw_cfg [name=]<name>,string=<str>\n" 351463d3145aSMarkus Armbruster " add named fw_cfg entry with contents from string\n", 351581b2b810SGabriel L. Somlo QEMU_ARCH_ALL) 3516e2fcbf42SPeter MaydellSRST 3517e2fcbf42SPeter Maydell``-fw_cfg [name=]name,file=file`` 3518e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from file file. 3519e2fcbf42SPeter Maydell 3520e2fcbf42SPeter Maydell``-fw_cfg [name=]name,string=str`` 3521e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from string str. 3522e2fcbf42SPeter Maydell 3523e2fcbf42SPeter Maydell The terminating NUL character of the contents of str will not be 3524e2fcbf42SPeter Maydell included as part of the fw\_cfg item data. To insert contents with 3525e2fcbf42SPeter Maydell embedded NUL characters, you have to use the file parameter. 3526e2fcbf42SPeter Maydell 3527e2fcbf42SPeter Maydell The fw\_cfg entries are passed by QEMU through to the guest. 3528e2fcbf42SPeter Maydell 3529e2fcbf42SPeter Maydell Example: 3530e2fcbf42SPeter Maydell 3531e2fcbf42SPeter Maydell :: 3532e2fcbf42SPeter Maydell 3533e2fcbf42SPeter Maydell -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 3534e2fcbf42SPeter Maydell 3535e2fcbf42SPeter Maydell creates an fw\_cfg entry named opt/com.mycompany/blob with contents 3536e2fcbf42SPeter Maydell from ./my\_blob.bin. 3537e2fcbf42SPeter MaydellERST 353881b2b810SGabriel L. Somlo 35395824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 3540ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 3541ad96090aSBlue Swirl QEMU_ARCH_ALL) 3542e2fcbf42SPeter MaydellSRST 3543e2fcbf42SPeter Maydell``-serial dev`` 3544e2fcbf42SPeter Maydell Redirect the virtual serial port to host character device dev. The 3545e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 3546e2fcbf42SPeter Maydell graphical mode. 3547e2fcbf42SPeter Maydell 3548e2fcbf42SPeter Maydell This option can be used several times to simulate up to 4 serial 3549e2fcbf42SPeter Maydell ports. 3550e2fcbf42SPeter Maydell 3551e2fcbf42SPeter Maydell Use ``-serial none`` to disable all serial ports. 3552e2fcbf42SPeter Maydell 3553e2fcbf42SPeter Maydell Available character devices are: 3554e2fcbf42SPeter Maydell 3555e2fcbf42SPeter Maydell ``vc[:WxH]`` 3556e2fcbf42SPeter Maydell Virtual console. Optionally, a width and height can be given in 3557e2fcbf42SPeter Maydell pixel with 3558e2fcbf42SPeter Maydell 3559e2fcbf42SPeter Maydell :: 3560e2fcbf42SPeter Maydell 3561e2fcbf42SPeter Maydell vc:800x600 3562e2fcbf42SPeter Maydell 3563e2fcbf42SPeter Maydell It is also possible to specify width or height in characters: 3564e2fcbf42SPeter Maydell 3565e2fcbf42SPeter Maydell :: 3566e2fcbf42SPeter Maydell 3567e2fcbf42SPeter Maydell vc:80Cx24C 3568e2fcbf42SPeter Maydell 3569e2fcbf42SPeter Maydell ``pty`` 3570e2fcbf42SPeter Maydell [Linux only] Pseudo TTY (a new PTY is automatically allocated) 3571e2fcbf42SPeter Maydell 3572e2fcbf42SPeter Maydell ``none`` 3573e2fcbf42SPeter Maydell No device is allocated. 3574e2fcbf42SPeter Maydell 3575e2fcbf42SPeter Maydell ``null`` 3576e2fcbf42SPeter Maydell void device 3577e2fcbf42SPeter Maydell 3578e2fcbf42SPeter Maydell ``chardev:id`` 3579e2fcbf42SPeter Maydell Use a named character device defined with the ``-chardev`` 3580e2fcbf42SPeter Maydell option. 3581e2fcbf42SPeter Maydell 3582e2fcbf42SPeter Maydell ``/dev/XXX`` 3583e2fcbf42SPeter Maydell [Linux only] Use host tty, e.g. ``/dev/ttyS0``. The host serial 3584e2fcbf42SPeter Maydell port parameters are set according to the emulated ones. 3585e2fcbf42SPeter Maydell 3586e2fcbf42SPeter Maydell ``/dev/parportN`` 3587e2fcbf42SPeter Maydell [Linux only, parallel port only] Use host parallel port N. 3588e2fcbf42SPeter Maydell Currently SPP and EPP parallel port features can be used. 3589e2fcbf42SPeter Maydell 3590e2fcbf42SPeter Maydell ``file:filename`` 3591e2fcbf42SPeter Maydell Write output to filename. No character can be read. 3592e2fcbf42SPeter Maydell 3593e2fcbf42SPeter Maydell ``stdio`` 3594e2fcbf42SPeter Maydell [Unix only] standard input/output 3595e2fcbf42SPeter Maydell 3596e2fcbf42SPeter Maydell ``pipe:filename`` 3597e2fcbf42SPeter Maydell name pipe filename 3598e2fcbf42SPeter Maydell 3599e2fcbf42SPeter Maydell ``COMn`` 3600e2fcbf42SPeter Maydell [Windows only] Use host serial port n 3601e2fcbf42SPeter Maydell 3602e2fcbf42SPeter Maydell ``udp:[remote_host]:remote_port[@[src_ip]:src_port]`` 3603e2fcbf42SPeter Maydell This implements UDP Net Console. When remote\_host or src\_ip 3604e2fcbf42SPeter Maydell are not specified they default to ``0.0.0.0``. When not using a 3605e2fcbf42SPeter Maydell specified src\_port a random port is automatically chosen. 3606e2fcbf42SPeter Maydell 3607e2fcbf42SPeter Maydell If you just want a simple readonly console you can use 3608e2fcbf42SPeter Maydell ``netcat`` or ``nc``, by starting QEMU with: 3609e2fcbf42SPeter Maydell ``-serial udp::4555`` and nc as: ``nc -u -l -p 4555``. Any time 3610e2fcbf42SPeter Maydell QEMU writes something to that port it will appear in the 3611e2fcbf42SPeter Maydell netconsole session. 3612e2fcbf42SPeter Maydell 3613e2fcbf42SPeter Maydell If you plan to send characters back via netconsole or you want 3614e2fcbf42SPeter Maydell to stop and start QEMU a lot of times, you should have QEMU use 3615e2fcbf42SPeter Maydell the same source port each time by using something like ``-serial 3616e2fcbf42SPeter Maydell udp::4555@:4556`` to QEMU. Another approach is to use a patched 3617e2fcbf42SPeter Maydell version of netcat which can listen to a TCP port and send and 3618e2fcbf42SPeter Maydell receive characters via udp. If you have a patched version of 3619e2fcbf42SPeter Maydell netcat which activates telnet remote echo and single char 3620e2fcbf42SPeter Maydell transfer, then you can use the following options to set up a 3621e2fcbf42SPeter Maydell netcat redirector to allow telnet on port 5555 to access the 3622e2fcbf42SPeter Maydell QEMU port. 3623e2fcbf42SPeter Maydell 3624e2fcbf42SPeter Maydell ``QEMU Options:`` 3625e2fcbf42SPeter Maydell -serial udp::4555@:4556 3626e2fcbf42SPeter Maydell 3627e2fcbf42SPeter Maydell ``netcat options:`` 3628e2fcbf42SPeter Maydell -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 3629e2fcbf42SPeter Maydell 3630e2fcbf42SPeter Maydell ``telnet options:`` 3631e2fcbf42SPeter Maydell localhost 5555 3632e2fcbf42SPeter Maydell 3633a9b1315fSPaolo Bonzini ``tcp:[host]:port[,server=on|off][,wait=on|off][,nodelay=on|off][,reconnect=seconds]`` 3634e2fcbf42SPeter Maydell The TCP Net Console has two modes of operation. It can send the 3635e2fcbf42SPeter Maydell serial I/O to a location or wait for a connection from a 3636e2fcbf42SPeter Maydell location. By default the TCP Net Console is sent to host at the 3637bfdc1267SDaniel P. Berrangé port. If you use the ``server=on`` option QEMU will wait for a client 3638e2fcbf42SPeter Maydell socket application to connect to the port before continuing, 3639a9b1315fSPaolo Bonzini unless the ``wait=on|off`` option was specified. The ``nodelay=on|off`` 3640bfdc1267SDaniel P. Berrangé option disables the Nagle buffering algorithm. The ``reconnect=on`` 3641bfdc1267SDaniel P. Berrangé option only applies if ``server=no`` is set, if the connection goes 3642e2fcbf42SPeter Maydell down it will attempt to reconnect at the given interval. If host 3643e2fcbf42SPeter Maydell is omitted, 0.0.0.0 is assumed. Only one TCP connection at a 3644bfdc1267SDaniel P. Berrangé time is accepted. You can use ``telnet=on`` to connect to the 3645e2fcbf42SPeter Maydell corresponding character device. 3646e2fcbf42SPeter Maydell 3647e2fcbf42SPeter Maydell ``Example to send tcp console to 192.168.0.2 port 4444`` 3648e2fcbf42SPeter Maydell -serial tcp:192.168.0.2:4444 3649e2fcbf42SPeter Maydell 3650e2fcbf42SPeter Maydell ``Example to listen and wait on port 4444 for connection`` 3651bfdc1267SDaniel P. Berrangé -serial tcp::4444,server=on 3652e2fcbf42SPeter Maydell 3653e2fcbf42SPeter Maydell ``Example to not wait and listen on ip 192.168.0.100 port 4444`` 3654bfdc1267SDaniel P. Berrangé -serial tcp:192.168.0.100:4444,server=on,wait=off 3655e2fcbf42SPeter Maydell 3656a9b1315fSPaolo Bonzini ``telnet:host:port[,server=on|off][,wait=on|off][,nodelay=on|off]`` 3657e2fcbf42SPeter Maydell The telnet protocol is used instead of raw tcp sockets. The 3658e2fcbf42SPeter Maydell options work the same as if you had specified ``-serial tcp``. 3659e2fcbf42SPeter Maydell The difference is that the port acts like a telnet server or 3660e2fcbf42SPeter Maydell client using telnet option negotiation. This will also allow you 3661e2fcbf42SPeter Maydell to send the MAGIC\_SYSRQ sequence if you use a telnet that 3662e2fcbf42SPeter Maydell supports sending the break sequence. Typically in unix telnet 3663e2fcbf42SPeter Maydell you do it with Control-] and then type "send break" followed by 3664e2fcbf42SPeter Maydell pressing the enter key. 3665e2fcbf42SPeter Maydell 3666a9b1315fSPaolo Bonzini ``websocket:host:port,server=on[,wait=on|off][,nodelay=on|off]`` 3667e2fcbf42SPeter Maydell The WebSocket protocol is used instead of raw tcp socket. The 3668e2fcbf42SPeter Maydell port acts as a WebSocket server. Client mode is not supported. 3669e2fcbf42SPeter Maydell 3670bfdc1267SDaniel P. Berrangé ``unix:path[,server=on|off][,wait=on|off][,reconnect=seconds]`` 3671e2fcbf42SPeter Maydell A unix domain socket is used instead of a tcp socket. The option 3672e2fcbf42SPeter Maydell works the same as if you had specified ``-serial tcp`` except 3673e2fcbf42SPeter Maydell the unix domain socket path is used for connections. 3674e2fcbf42SPeter Maydell 3675e2fcbf42SPeter Maydell ``mon:dev_string`` 3676e2fcbf42SPeter Maydell This is a special option to allow the monitor to be multiplexed 3677e2fcbf42SPeter Maydell onto another serial port. The monitor is accessed with key 3678e2fcbf42SPeter Maydell sequence of Control-a and then pressing c. dev\_string should be 3679e2fcbf42SPeter Maydell any one of the serial devices specified above. An example to 3680e2fcbf42SPeter Maydell multiplex the monitor onto a telnet server listening on port 3681e2fcbf42SPeter Maydell 4444 would be: 3682e2fcbf42SPeter Maydell 3683bfdc1267SDaniel P. Berrangé ``-serial mon:telnet::4444,server=on,wait=off`` 3684e2fcbf42SPeter Maydell 3685e2fcbf42SPeter Maydell When the monitor is multiplexed to stdio in this way, Ctrl+C 3686e2fcbf42SPeter Maydell will not terminate QEMU any more but will be passed to the guest 3687e2fcbf42SPeter Maydell instead. 3688e2fcbf42SPeter Maydell 3689e2fcbf42SPeter Maydell ``braille`` 3690e2fcbf42SPeter Maydell Braille device. This will use BrlAPI to display the braille 3691e2fcbf42SPeter Maydell output on a real or fake device. 3692e2fcbf42SPeter Maydell 3693e2fcbf42SPeter Maydell ``msmouse`` 3694e2fcbf42SPeter Maydell Three button serial mouse. Configure the guest to use Microsoft 3695e2fcbf42SPeter Maydell protocol. 3696e2fcbf42SPeter MaydellERST 36975824d651Sblueswir1 36985824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 3699ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 3700ad96090aSBlue Swirl QEMU_ARCH_ALL) 3701e2fcbf42SPeter MaydellSRST 3702e2fcbf42SPeter Maydell``-parallel dev`` 3703e2fcbf42SPeter Maydell Redirect the virtual parallel port to host device dev (same devices 3704e2fcbf42SPeter Maydell as the serial port). On Linux hosts, ``/dev/parportN`` can be used 3705e2fcbf42SPeter Maydell to use hardware devices connected on the corresponding host parallel 3706e2fcbf42SPeter Maydell port. 3707e2fcbf42SPeter Maydell 3708e2fcbf42SPeter Maydell This option can be used several times to simulate up to 3 parallel 3709e2fcbf42SPeter Maydell ports. 3710e2fcbf42SPeter Maydell 3711e2fcbf42SPeter Maydell Use ``-parallel none`` to disable all parallel ports. 3712e2fcbf42SPeter MaydellERST 37135824d651Sblueswir1 37145824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3715ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 3716ad96090aSBlue Swirl QEMU_ARCH_ALL) 3717e2fcbf42SPeter MaydellSRST 3718e2fcbf42SPeter Maydell``-monitor dev`` 3719e2fcbf42SPeter Maydell Redirect the monitor to host device dev (same devices as the serial 3720e2fcbf42SPeter Maydell port). The default device is ``vc`` in graphical mode and ``stdio`` 3721e2fcbf42SPeter Maydell in non graphical mode. Use ``-monitor none`` to disable the default 3722e2fcbf42SPeter Maydell monitor. 3723e2fcbf42SPeter MaydellERST 37246ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3725ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 3726ad96090aSBlue Swirl QEMU_ARCH_ALL) 3727e2fcbf42SPeter MaydellSRST 3728e2fcbf42SPeter Maydell``-qmp dev`` 3729e2fcbf42SPeter Maydell Like -monitor but opens in 'control' mode. 3730e2fcbf42SPeter MaydellERST 37314821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 37324821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 37334821cd4cSMax Reitz QEMU_ARCH_ALL) 3734e2fcbf42SPeter MaydellSRST 3735e2fcbf42SPeter Maydell``-qmp-pretty dev`` 3736e2fcbf42SPeter Maydell Like -qmp but uses pretty JSON formatting. 3737e2fcbf42SPeter MaydellERST 37385824d651Sblueswir1 373922a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 3740ef670726SVicente Jimenez Aguilar "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL) 3741e2fcbf42SPeter MaydellSRST 3742e2fcbf42SPeter Maydell``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]`` 3743*283d845cSDaniel P. Berrangé Setup monitor on chardev name. ``pretty`` is only valid when 3744*283d845cSDaniel P. Berrangé ``mode=control``, turning on JSON pretty printing to ease 3745*283d845cSDaniel P. Berrangé human reading and debugging. 3746e2fcbf42SPeter MaydellERST 374722a0e04bSGerd Hoffmann 3748c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 3749ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 3750ad96090aSBlue Swirl QEMU_ARCH_ALL) 3751e2fcbf42SPeter MaydellSRST 3752e2fcbf42SPeter Maydell``-debugcon dev`` 3753e2fcbf42SPeter Maydell Redirect the debug console to host device dev (same devices as the 3754e2fcbf42SPeter Maydell serial port). The debug console is an I/O port which is typically 3755e2fcbf42SPeter Maydell port 0xe9; writing to that I/O port sends output to this device. The 3756e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 3757e2fcbf42SPeter Maydell graphical mode. 3758e2fcbf42SPeter MaydellERST 3759c9f398e5SH. Peter Anvin 37605824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 3761ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 3762e2fcbf42SPeter MaydellSRST 3763e2fcbf42SPeter Maydell``-pidfile file`` 3764e2fcbf42SPeter Maydell Store the QEMU process PID in file. It is useful if you launch QEMU 3765e2fcbf42SPeter Maydell from a script. 3766e2fcbf42SPeter MaydellERST 37675824d651Sblueswir1 37681b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 3769ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 3770e2fcbf42SPeter MaydellSRST 3771e2fcbf42SPeter Maydell``-singlestep`` 3772e2fcbf42SPeter Maydell Run the emulation in single step mode. 3773e2fcbf42SPeter MaydellERST 37741b530a6dSaurel32 3775047f7038SIgor MammedovDEF("preconfig", 0, QEMU_OPTION_preconfig, \ 3776361ac948SMarkus Armbruster "--preconfig pause QEMU before machine is initialized (experimental)\n", 3777047f7038SIgor Mammedov QEMU_ARCH_ALL) 3778e2fcbf42SPeter MaydellSRST 3779e2fcbf42SPeter Maydell``--preconfig`` 3780e2fcbf42SPeter Maydell Pause QEMU for interactive configuration before the machine is 3781e2fcbf42SPeter Maydell created, which allows querying and configuring properties that will 3782e2fcbf42SPeter Maydell affect machine initialization. Use QMP command 'x-exit-preconfig' to 3783e2fcbf42SPeter Maydell exit the preconfig state and move to the next state (i.e. run guest 3784e2fcbf42SPeter Maydell if -S isn't used or pause the second time if -S is used). This 3785e2fcbf42SPeter Maydell option is experimental. 3786e2fcbf42SPeter MaydellERST 3787047f7038SIgor Mammedov 37885824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 3789ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 3790ad96090aSBlue Swirl QEMU_ARCH_ALL) 3791e2fcbf42SPeter MaydellSRST 3792e2fcbf42SPeter Maydell``-S`` 3793e2fcbf42SPeter Maydell Do not start CPU at startup (you must type 'c' in the monitor). 3794e2fcbf42SPeter MaydellERST 37955824d651Sblueswir1 37966f131f13SMichael S. TsirkinDEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit, 3797dfaa7d50SBALATON Zoltan "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n" 37986f131f13SMichael S. Tsirkin " run qemu with overcommit hints\n" 37996f131f13SMichael S. Tsirkin " mem-lock=on|off controls memory lock support (default: off)\n" 38006f131f13SMichael S. Tsirkin " cpu-pm=on|off controls cpu power management (default: off)\n", 38016f131f13SMichael S. Tsirkin QEMU_ARCH_ALL) 3802e2fcbf42SPeter MaydellSRST 3803e2fcbf42SPeter Maydell``-overcommit mem-lock=on|off`` 380409ce5f2dSPeter Maydell \ 3805e2fcbf42SPeter Maydell``-overcommit cpu-pm=on|off`` 3806e2fcbf42SPeter Maydell Run qemu with hints about host resource overcommit. The default is 3807e2fcbf42SPeter Maydell to assume that host overcommits all resources. 3808e2fcbf42SPeter Maydell 3809e2fcbf42SPeter Maydell Locking qemu and guest memory can be enabled via ``mem-lock=on`` 3810e2fcbf42SPeter Maydell (disabled by default). This works when host memory is not 3811c8c9dc42SThomas Huth overcommitted and reduces the worst-case latency for guest. 3812e2fcbf42SPeter Maydell 3813e2fcbf42SPeter Maydell Guest ability to manage power state of host cpus (increasing latency 3814e2fcbf42SPeter Maydell for other processes on the same host cpu, but decreasing latency for 3815e2fcbf42SPeter Maydell guest) can be enabled via ``cpu-pm=on`` (disabled by default). This 3816e2fcbf42SPeter Maydell works best when host CPU is not overcommitted. When used, host 3817e2fcbf42SPeter Maydell estimates of CPU cycle and power utilization will be incorrect, not 3818e2fcbf42SPeter Maydell taking into account guest idle time. 3819e2fcbf42SPeter MaydellERST 38206f131f13SMichael S. Tsirkin 382159030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 3822e5910d42SPeter Maydell "-gdb dev accept gdb connection on 'dev'. (QEMU defaults to starting\n" 3823e5910d42SPeter Maydell " the guest without waiting for gdb to connect; use -S too\n" 3824e5910d42SPeter Maydell " if you want it to not start execution.)\n", 3825e5910d42SPeter Maydell QEMU_ARCH_ALL) 3826e2fcbf42SPeter MaydellSRST 3827e2fcbf42SPeter Maydell``-gdb dev`` 3828923e9311SThomas Huth Accept a gdb connection on device dev (see the :ref:`GDB usage` chapter 3829923e9311SThomas Huth in the System Emulation Users Guide). Note that this option does not pause QEMU 3830e5910d42SPeter Maydell execution -- if you want QEMU to not start the guest until you 3831e5910d42SPeter Maydell connect with gdb and issue a ``continue`` command, you will need to 3832e5910d42SPeter Maydell also pass the ``-S`` option to QEMU. 3833e5910d42SPeter Maydell 3834e5910d42SPeter Maydell The most usual configuration is to listen on a local TCP socket:: 3835e5910d42SPeter Maydell 3836e5910d42SPeter Maydell -gdb tcp::3117 3837e5910d42SPeter Maydell 3838e5910d42SPeter Maydell but you can specify other backends; UDP, pseudo TTY, or even stdio 3839e5910d42SPeter Maydell are all reasonable use cases. For example, a stdio connection 3840e5910d42SPeter Maydell allows you to start QEMU from within gdb and establish the 3841e5910d42SPeter Maydell connection via a pipe: 3842e2fcbf42SPeter Maydell 384309ce5f2dSPeter Maydell .. parsed-literal:: 3844e2fcbf42SPeter Maydell 3845e2fcbf42SPeter Maydell (gdb) target remote | exec |qemu_system| -gdb stdio ... 3846e2fcbf42SPeter MaydellERST 38475824d651Sblueswir1 384859030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 3849ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 3850ad96090aSBlue Swirl QEMU_ARCH_ALL) 3851e2fcbf42SPeter MaydellSRST 3852e2fcbf42SPeter Maydell``-s`` 3853e2fcbf42SPeter Maydell Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 3854923e9311SThomas Huth (see the :ref:`GDB usage` chapter in the System Emulation Users Guide). 3855e2fcbf42SPeter MaydellERST 38565824d651Sblueswir1 38575824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 3858989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 3859ad96090aSBlue Swirl QEMU_ARCH_ALL) 3860e2fcbf42SPeter MaydellSRST 3861e2fcbf42SPeter Maydell``-d item1[,...]`` 3862e2fcbf42SPeter Maydell Enable logging of specified items. Use '-d help' for a list of log 3863e2fcbf42SPeter Maydell items. 3864e2fcbf42SPeter MaydellERST 38655824d651Sblueswir1 3866c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 3867989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 3868c235d738SMatthew Fernandez QEMU_ARCH_ALL) 3869e2fcbf42SPeter MaydellSRST 3870e2fcbf42SPeter Maydell``-D logfile`` 3871e2fcbf42SPeter Maydell Output log in logfile instead of to stderr 3872e2fcbf42SPeter MaydellERST 3873c235d738SMatthew Fernandez 38743514552eSAlex BennéeDEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 38753514552eSAlex Bennée "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 38763514552eSAlex Bennée QEMU_ARCH_ALL) 3877e2fcbf42SPeter MaydellSRST 3878e2fcbf42SPeter Maydell``-dfilter range1[,...]`` 3879e2fcbf42SPeter Maydell Filter debug output to that relevant to a range of target addresses. 3880e2fcbf42SPeter Maydell The filter spec can be either start+size, start-size or start..end 3881e2fcbf42SPeter Maydell where start end and size are the addresses and sizes required. For 3882e2fcbf42SPeter Maydell example: 3883e2fcbf42SPeter Maydell 3884e2fcbf42SPeter Maydell :: 3885e2fcbf42SPeter Maydell 3886e2fcbf42SPeter Maydell -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 3887e2fcbf42SPeter Maydell 3888e2fcbf42SPeter Maydell Will dump output for any code in the 0x1000 sized block starting at 3889e2fcbf42SPeter Maydell 0x8000 and the 0x200 sized block starting at 0xffffffc000080000 and 3890e2fcbf42SPeter Maydell another 0x1000 sized block starting at 0xffffffc00005f000. 3891e2fcbf42SPeter MaydellERST 38923514552eSAlex Bennée 38939c09a251SRichard HendersonDEF("seed", HAS_ARG, QEMU_OPTION_seed, \ 38949c09a251SRichard Henderson "-seed number seed the pseudo-random number generator\n", 38959c09a251SRichard Henderson QEMU_ARCH_ALL) 3896e2fcbf42SPeter MaydellSRST 3897e2fcbf42SPeter Maydell``-seed number`` 3898e2fcbf42SPeter Maydell Force the guest to use a deterministic pseudo-random number 3899e2fcbf42SPeter Maydell generator, seeded with number. This does not affect crypto routines 3900e2fcbf42SPeter Maydell within the host. 3901e2fcbf42SPeter MaydellERST 39029c09a251SRichard Henderson 39035824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 3904ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 3905ad96090aSBlue Swirl QEMU_ARCH_ALL) 3906e2fcbf42SPeter MaydellSRST 3907e2fcbf42SPeter Maydell``-L path`` 3908e2fcbf42SPeter Maydell Set the directory for the BIOS, VGA BIOS and keymaps. 3909e2fcbf42SPeter Maydell 3910e2fcbf42SPeter Maydell To list all the data directories, use ``-L help``. 3911e2fcbf42SPeter MaydellERST 39125824d651Sblueswir1 39135824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 3914ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 3915e2fcbf42SPeter MaydellSRST 3916e2fcbf42SPeter Maydell``-bios file`` 3917e2fcbf42SPeter Maydell Set the filename for the BIOS. 3918e2fcbf42SPeter MaydellERST 39195824d651Sblueswir1 39205824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3921ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 3922e2fcbf42SPeter MaydellSRST 3923e2fcbf42SPeter Maydell``-enable-kvm`` 3924e2fcbf42SPeter Maydell Enable KVM full virtualization support. This option is only 3925e2fcbf42SPeter Maydell available if KVM support is enabled when compiling. 3926e2fcbf42SPeter MaydellERST 39275824d651Sblueswir1 3928e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3929ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3930e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3931e37630caSaliguori "-xen-attach attach to existing xen domain\n" 39321077bcacSAnthony PERARD " libxl will use this when starting QEMU\n", 3933ad96090aSBlue Swirl QEMU_ARCH_ALL) 39341c599472SPaul DurrantDEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict, 39351c599472SPaul Durrant "-xen-domid-restrict restrict set of available xen operations\n" 39361c599472SPaul Durrant " to specified domain id. (Does not affect\n" 39371c599472SPaul Durrant " xenpv machine type).\n", 39381c599472SPaul Durrant QEMU_ARCH_ALL) 3939e2fcbf42SPeter MaydellSRST 3940e2fcbf42SPeter Maydell``-xen-domid id`` 3941e2fcbf42SPeter Maydell Specify xen guest domain id (XEN only). 3942e2fcbf42SPeter Maydell 3943e2fcbf42SPeter Maydell``-xen-attach`` 3944e2fcbf42SPeter Maydell Attach to existing xen domain. libxl will use this when starting 3945e2fcbf42SPeter Maydell QEMU (XEN only). Restrict set of available xen operations to 3946e2fcbf42SPeter Maydell specified domain id (XEN only). 3947e2fcbf42SPeter MaydellERST 3948e37630caSaliguori 39495824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3950ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 3951e2fcbf42SPeter MaydellSRST 3952e2fcbf42SPeter Maydell``-no-reboot`` 3953e2fcbf42SPeter Maydell Exit instead of rebooting. 3954e2fcbf42SPeter MaydellERST 39555824d651Sblueswir1 39565824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3957ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 3958e2fcbf42SPeter MaydellSRST 3959e2fcbf42SPeter Maydell``-no-shutdown`` 3960e2fcbf42SPeter Maydell Don't exit QEMU on guest shutdown, but instead only stop the 3961e2fcbf42SPeter Maydell emulation. This allows for instance switching to monitor to commit 3962e2fcbf42SPeter Maydell changes to the disk image. 3963e2fcbf42SPeter MaydellERST 39645824d651Sblueswir1 39652a5ad60bSAlejandro JimenezDEF("action", HAS_ARG, QEMU_OPTION_action, 3966c27025e0SPaolo Bonzini "-action reboot=reset|shutdown\n" 3967c27025e0SPaolo Bonzini " action when guest reboots [default=reset]\n" 39682a5ad60bSAlejandro Jimenez "-action shutdown=poweroff|pause\n" 39692a5ad60bSAlejandro Jimenez " action when guest shuts down [default=poweroff]\n" 3970c27025e0SPaolo Bonzini "-action panic=pause|shutdown|none\n" 3971c27025e0SPaolo Bonzini " action when guest panics [default=shutdown]\n" 39722a5ad60bSAlejandro Jimenez "-action watchdog=reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" 39732a5ad60bSAlejandro Jimenez " action when watchdog fires [default=reset]\n", 39742a5ad60bSAlejandro Jimenez QEMU_ARCH_ALL) 39752a5ad60bSAlejandro JimenezSRST 39762a5ad60bSAlejandro Jimenez``-action event=action`` 39772a5ad60bSAlejandro Jimenez The action parameter serves to modify QEMU's default behavior when 39782a5ad60bSAlejandro Jimenez certain guest events occur. It provides a generic method for specifying the 39792a5ad60bSAlejandro Jimenez same behaviors that are modified by the ``-no-reboot`` and ``-no-shutdown`` 39802a5ad60bSAlejandro Jimenez parameters. 39812a5ad60bSAlejandro Jimenez 39822a5ad60bSAlejandro Jimenez Examples: 39832a5ad60bSAlejandro Jimenez 3984c753e8e7SAlejandro Jimenez ``-action panic=none`` 39852a5ad60bSAlejandro Jimenez ``-action reboot=shutdown,shutdown=pause`` 39862a5ad60bSAlejandro Jimenez ``-watchdog i6300esb -action watchdog=pause`` 39872a5ad60bSAlejandro Jimenez 39882a5ad60bSAlejandro JimenezERST 39892a5ad60bSAlejandro Jimenez 39905824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 39915824d651Sblueswir1 "-loadvm [tag|id]\n" \ 3992ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 3993ad96090aSBlue Swirl QEMU_ARCH_ALL) 3994e2fcbf42SPeter MaydellSRST 3995e2fcbf42SPeter Maydell``-loadvm file`` 3996e2fcbf42SPeter Maydell Start right away with a saved state (``loadvm`` in monitor) 3997e2fcbf42SPeter MaydellERST 39985824d651Sblueswir1 39995824d651Sblueswir1#ifndef _WIN32 40005824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 4001ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 40025824d651Sblueswir1#endif 4003e2fcbf42SPeter MaydellSRST 4004e2fcbf42SPeter Maydell``-daemonize`` 4005e2fcbf42SPeter Maydell Daemonize the QEMU process after initialization. QEMU will not 4006e2fcbf42SPeter Maydell detach from standard IO until it is ready to receive connections on 4007e2fcbf42SPeter Maydell any of its devices. This option is a useful way for external 4008e2fcbf42SPeter Maydell programs to launch QEMU without having to cope with initialization 4009e2fcbf42SPeter Maydell race conditions. 4010e2fcbf42SPeter MaydellERST 40115824d651Sblueswir1 40125824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 4013ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 4014ad96090aSBlue Swirl QEMU_ARCH_ALL) 4015e2fcbf42SPeter MaydellSRST 4016e2fcbf42SPeter Maydell``-option-rom file`` 4017e2fcbf42SPeter Maydell Load the contents of file as an option ROM. This option is useful to 4018e2fcbf42SPeter Maydell load things like EtherBoot. 4019e2fcbf42SPeter MaydellERST 40205824d651Sblueswir1 40211ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 4022238d1240SArtem Pisarenko "-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 4023ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 4024ad96090aSBlue Swirl QEMU_ARCH_ALL) 40251ed2fc1fSJan Kiszka 4026e2fcbf42SPeter MaydellSRST 4027e2fcbf42SPeter Maydell``-rtc [base=utc|localtime|datetime][,clock=host|rt|vm][,driftfix=none|slew]`` 4028e2fcbf42SPeter Maydell Specify ``base`` as ``utc`` or ``localtime`` to let the RTC start at 4029e2fcbf42SPeter Maydell the current UTC or local time, respectively. ``localtime`` is 4030e2fcbf42SPeter Maydell required for correct date in MS-DOS or Windows. To start at a 4031e2fcbf42SPeter Maydell specific point in time, provide datetime in the format 4032e2fcbf42SPeter Maydell ``2006-06-17T16:01:21`` or ``2006-06-17``. The default base is UTC. 4033e2fcbf42SPeter Maydell 4034e2fcbf42SPeter Maydell By default the RTC is driven by the host system time. This allows 4035e2fcbf42SPeter Maydell using of the RTC as accurate reference clock inside the guest, 4036e2fcbf42SPeter Maydell specifically if the host time is smoothly following an accurate 4037e2fcbf42SPeter Maydell external reference clock, e.g. via NTP. If you want to isolate the 4038e2fcbf42SPeter Maydell guest time from the host, you can set ``clock`` to ``rt`` instead, 4039e2fcbf42SPeter Maydell which provides a host monotonic clock if host support it. To even 4040e2fcbf42SPeter Maydell prevent the RTC from progressing during suspension, you can set 4041e2fcbf42SPeter Maydell ``clock`` to ``vm`` (virtual clock). '\ ``clock=vm``\ ' is 4042e2fcbf42SPeter Maydell recommended especially in icount mode in order to preserve 4043e2fcbf42SPeter Maydell determinism; however, note that in icount mode the speed of the 4044e2fcbf42SPeter Maydell virtual clock is variable and can in general differ from the host 4045e2fcbf42SPeter Maydell clock. 4046e2fcbf42SPeter Maydell 4047e2fcbf42SPeter Maydell Enable ``driftfix`` (i386 targets only) if you experience time drift 4048e2fcbf42SPeter Maydell problems, specifically with Windows' ACPI HAL. This option will try 4049e2fcbf42SPeter Maydell to figure out how many timer interrupts were not processed by the 4050e2fcbf42SPeter Maydell Windows guest and will re-inject them. 4051e2fcbf42SPeter MaydellERST 40525824d651Sblueswir1 40535824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 4054fa647905SPeter Maydell "-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=<filename>[,rrsnapshot=<snapshot>]]\n" \ 4055bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 4056f1f4b57eSVictor CLEMENT " instruction, enable aligning the host and virtual clocks\n" \ 4057fa647905SPeter Maydell " or disable real time cpu sleeping, and optionally enable\n" \ 4058fa647905SPeter Maydell " record-and-replay mode\n", QEMU_ARCH_ALL) 4059e2fcbf42SPeter MaydellSRST 4060fa647905SPeter Maydell``-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=filename[,rrsnapshot=snapshot]]`` 4061e2fcbf42SPeter Maydell Enable virtual instruction counter. The virtual cpu will execute one 4062e2fcbf42SPeter Maydell instruction every 2^N ns of virtual time. If ``auto`` is specified 4063e2fcbf42SPeter Maydell then the virtual cpu speed will be automatically adjusted to keep 4064e2fcbf42SPeter Maydell virtual time within a few seconds of real time. 4065e2fcbf42SPeter Maydell 4066e2fcbf42SPeter Maydell Note that while this option can give deterministic behavior, it does 4067e2fcbf42SPeter Maydell not provide cycle accurate emulation. Modern CPUs contain 4068e2fcbf42SPeter Maydell superscalar out of order cores with complex cache hierarchies. The 4069e2fcbf42SPeter Maydell number of instructions executed often has little or no correlation 4070e2fcbf42SPeter Maydell with actual performance. 4071e2fcbf42SPeter Maydell 4072fa647905SPeter Maydell When the virtual cpu is sleeping, the virtual time will advance at 4073fa647905SPeter Maydell default speed unless ``sleep=on`` is specified. With 4074fa647905SPeter Maydell ``sleep=on``, the virtual time will jump to the next timer 4075fa647905SPeter Maydell deadline instantly whenever the virtual cpu goes to sleep mode and 4076fa647905SPeter Maydell will not advance if no timer is enabled. This behavior gives 4077fa647905SPeter Maydell deterministic execution times from the guest point of view. 4078fa647905SPeter Maydell The default if icount is enabled is ``sleep=off``. 4079fa647905SPeter Maydell ``sleep=on`` cannot be used together with either ``shift=auto`` 4080fa647905SPeter Maydell or ``align=on``. 4081fa647905SPeter Maydell 4082e2fcbf42SPeter Maydell ``align=on`` will activate the delay algorithm which will try to 4083e2fcbf42SPeter Maydell synchronise the host clock and the virtual clock. The goal is to 4084e2fcbf42SPeter Maydell have a guest running at the real frequency imposed by the shift 4085e2fcbf42SPeter Maydell option. Whenever the guest clock is behind the host clock and if 4086e2fcbf42SPeter Maydell ``align=on`` is specified then we print a message to the user to 4087e2fcbf42SPeter Maydell inform about the delay. Currently this option does not work when 4088e2fcbf42SPeter Maydell ``shift`` is ``auto``. Note: The sync algorithm will work for those 4089e2fcbf42SPeter Maydell shift values for which the guest clock runs ahead of the host clock. 4090e2fcbf42SPeter Maydell Typically this happens when the shift value is high (how high 4091fa647905SPeter Maydell depends on the host machine). The default if icount is enabled 4092fa647905SPeter Maydell is ``align=off``. 4093e2fcbf42SPeter Maydell 4094fa647905SPeter Maydell When the ``rr`` option is specified deterministic record/replay is 4095fa647905SPeter Maydell enabled. The ``rrfile=`` option must also be provided to 4096fa647905SPeter Maydell specify the path to the replay log. In record mode data is written 4097fa647905SPeter Maydell to this file, and in replay mode it is read back. 4098fa647905SPeter Maydell If the ``rrsnapshot`` option is given then it specifies a VM snapshot 4099fa647905SPeter Maydell name. In record mode, a new VM snapshot with the given name is created 4100fa647905SPeter Maydell at the start of execution recording. In replay mode this option 4101fa647905SPeter Maydell specifies the snapshot name used to load the initial VM state. 4102e2fcbf42SPeter MaydellERST 41035824d651Sblueswir1 41049dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 4105d7933ef3SXu Wang "-watchdog model\n" \ 4106ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 4107ad96090aSBlue Swirl QEMU_ARCH_ALL) 4108e2fcbf42SPeter MaydellSRST 4109e2fcbf42SPeter Maydell``-watchdog model`` 4110e2fcbf42SPeter Maydell Create a virtual hardware watchdog device. Once enabled (by a guest 4111e2fcbf42SPeter Maydell action), the watchdog must be periodically polled by an agent inside 4112e2fcbf42SPeter Maydell the guest or else the guest will be restarted. Choose a model for 4113e2fcbf42SPeter Maydell which your guest has drivers. 4114e2fcbf42SPeter Maydell 4115e2fcbf42SPeter Maydell The model is the model of hardware watchdog to emulate. Use 4116e2fcbf42SPeter Maydell ``-watchdog help`` to list available hardware models. Only one 4117e2fcbf42SPeter Maydell watchdog can be enabled for a guest. 4118e2fcbf42SPeter Maydell 4119e2fcbf42SPeter Maydell The following models may be available: 4120e2fcbf42SPeter Maydell 4121e2fcbf42SPeter Maydell ``ib700`` 4122e2fcbf42SPeter Maydell iBASE 700 is a very simple ISA watchdog with a single timer. 4123e2fcbf42SPeter Maydell 4124e2fcbf42SPeter Maydell ``i6300esb`` 4125e2fcbf42SPeter Maydell Intel 6300ESB I/O controller hub is a much more featureful 4126e2fcbf42SPeter Maydell PCI-based dual-timer watchdog. 4127e2fcbf42SPeter Maydell 4128e2fcbf42SPeter Maydell ``diag288`` 4129e2fcbf42SPeter Maydell A virtual watchdog for s390x backed by the diagnose 288 4130e2fcbf42SPeter Maydell hypercall (currently KVM only). 4131e2fcbf42SPeter MaydellERST 41329dd986ccSRichard W.M. Jones 41339dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 41347ad9270eSMarkus Armbruster "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \ 4135ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 4136ad96090aSBlue Swirl QEMU_ARCH_ALL) 4137e2fcbf42SPeter MaydellSRST 4138e2fcbf42SPeter Maydell``-watchdog-action action`` 4139e2fcbf42SPeter Maydell The action controls what QEMU will do when the watchdog timer 4140e2fcbf42SPeter Maydell expires. The default is ``reset`` (forcefully reset the guest). 4141e2fcbf42SPeter Maydell Other possible actions are: ``shutdown`` (attempt to gracefully 4142e2fcbf42SPeter Maydell shutdown the guest), ``poweroff`` (forcefully poweroff the guest), 4143e2fcbf42SPeter Maydell ``inject-nmi`` (inject a NMI into the guest), ``pause`` (pause the 4144e2fcbf42SPeter Maydell guest), ``debug`` (print a debug message and continue), or ``none`` 4145e2fcbf42SPeter Maydell (do nothing). 4146e2fcbf42SPeter Maydell 4147e2fcbf42SPeter Maydell Note that the ``shutdown`` action requires that the guest responds 4148e2fcbf42SPeter Maydell to ACPI signals, which it may not be able to do in the sort of 4149e2fcbf42SPeter Maydell situations where the watchdog would have expired, and thus 4150e2fcbf42SPeter Maydell ``-watchdog-action shutdown`` is not recommended for production use. 4151e2fcbf42SPeter Maydell 4152e2fcbf42SPeter Maydell Examples: 4153e2fcbf42SPeter Maydell 4154e2fcbf42SPeter Maydell ``-watchdog i6300esb -watchdog-action pause``; \ ``-watchdog ib700`` 4155e2fcbf42SPeter Maydell 4156e2fcbf42SPeter MaydellERST 41579dd986ccSRichard W.M. Jones 41585824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 4159ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 4160ad96090aSBlue Swirl QEMU_ARCH_ALL) 4161e2fcbf42SPeter MaydellSRST 4162e2fcbf42SPeter Maydell``-echr numeric_ascii_value`` 4163e2fcbf42SPeter Maydell Change the escape character used for switching to the monitor when 4164e2fcbf42SPeter Maydell using monitor and serial sharing. The default is ``0x01`` when using 4165e2fcbf42SPeter Maydell the ``-nographic`` option. ``0x01`` is equal to pressing 4166e2fcbf42SPeter Maydell ``Control-a``. You can select a different character from the ascii 4167e2fcbf42SPeter Maydell control keys where 1 through 26 map to Control-a through Control-z. 4168e2fcbf42SPeter Maydell For instance you could use the either of the following to change the 4169e2fcbf42SPeter Maydell escape character to Control-t. 4170e2fcbf42SPeter Maydell 4171e2fcbf42SPeter Maydell ``-echr 0x14``; \ ``-echr 20`` 4172e2fcbf42SPeter Maydell 4173e2fcbf42SPeter MaydellERST 41745824d651Sblueswir1 41755824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 4176bf24095fSDaniel P. Berrangé "-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]\n" \ 4177bf24095fSDaniel P. Berrangé "-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]\n" \ 41787c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 41797c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 41807c601803SMichael Tokarev " specified protocol and socket address\n" \ 41817c601803SMichael Tokarev "-incoming fd:fd\n" \ 41827c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 41837c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 41841597051bSDr. David Alan Gilbert " or from given external command\n" \ 41851597051bSDr. David Alan Gilbert "-incoming defer\n" \ 41861597051bSDr. David Alan Gilbert " wait for the URI to be specified via migrate_incoming\n", 4187ad96090aSBlue Swirl QEMU_ARCH_ALL) 4188e2fcbf42SPeter MaydellSRST 4189bf24095fSDaniel P. Berrangé``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]`` 419009ce5f2dSPeter Maydell \ 4191bf24095fSDaniel P. Berrangé``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]`` 4192e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given tcp port. 4193e2fcbf42SPeter Maydell 4194e2fcbf42SPeter Maydell``-incoming unix:socketpath`` 4195e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given unix socket. 4196e2fcbf42SPeter Maydell 4197e2fcbf42SPeter Maydell``-incoming fd:fd`` 4198e2fcbf42SPeter Maydell Accept incoming migration from a given filedescriptor. 4199e2fcbf42SPeter Maydell 4200e2fcbf42SPeter Maydell``-incoming exec:cmdline`` 4201e2fcbf42SPeter Maydell Accept incoming migration as an output from specified external 4202e2fcbf42SPeter Maydell command. 4203e2fcbf42SPeter Maydell 4204e2fcbf42SPeter Maydell``-incoming defer`` 4205e2fcbf42SPeter Maydell Wait for the URI to be specified via migrate\_incoming. The monitor 4206e2fcbf42SPeter Maydell can be used to change settings (such as migration parameters) prior 4207e2fcbf42SPeter Maydell to issuing the migrate\_incoming to allow the migration to begin. 4208e2fcbf42SPeter MaydellERST 42095824d651Sblueswir1 4210d15c05fcSAshijeet AcharyaDEF("only-migratable", 0, QEMU_OPTION_only_migratable, \ 4211d15c05fcSAshijeet Acharya "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL) 4212e2fcbf42SPeter MaydellSRST 4213e2fcbf42SPeter Maydell``-only-migratable`` 4214e2fcbf42SPeter Maydell Only allow migratable devices. Devices will not be allowed to enter 4215e2fcbf42SPeter Maydell an unmigratable state. 4216e2fcbf42SPeter MaydellERST 4217d15c05fcSAshijeet Acharya 4218d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 4219ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 4220e2fcbf42SPeter MaydellSRST 4221e2fcbf42SPeter Maydell``-nodefaults`` 4222e2fcbf42SPeter Maydell Don't create default devices. Normally, QEMU sets the default 4223e2fcbf42SPeter Maydell devices like serial port, parallel port, virtual console, monitor 4224e2fcbf42SPeter Maydell device, VGA adapter, floppy and CD-ROM drive and others. The 4225e2fcbf42SPeter Maydell ``-nodefaults`` option will disable all those default devices. 4226e2fcbf42SPeter MaydellERST 4227d8c208ddSGerd Hoffmann 42285824d651Sblueswir1#ifndef _WIN32 42295824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 4230ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 4231ad96090aSBlue Swirl QEMU_ARCH_ALL) 42325824d651Sblueswir1#endif 4233e2fcbf42SPeter MaydellSRST 4234e2fcbf42SPeter Maydell``-chroot dir`` 4235e2fcbf42SPeter Maydell Immediately before starting guest execution, chroot to the specified 4236e2fcbf42SPeter Maydell directory. Especially useful in combination with -runas. 4237e2fcbf42SPeter MaydellERST 42385824d651Sblueswir1 42395824d651Sblueswir1#ifndef _WIN32 42405824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 42412c42f1e8SIan Jackson "-runas user change to user id user just before starting the VM\n" \ 42422c42f1e8SIan Jackson " user can be numeric uid:gid instead\n", 4243ad96090aSBlue Swirl QEMU_ARCH_ALL) 42445824d651Sblueswir1#endif 4245e2fcbf42SPeter MaydellSRST 4246e2fcbf42SPeter Maydell``-runas user`` 4247e2fcbf42SPeter Maydell Immediately before starting guest execution, drop root privileges, 4248e2fcbf42SPeter Maydell switching to the specified user. 4249e2fcbf42SPeter MaydellERST 42505824d651Sblueswir1 42515824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 42525824d651Sblueswir1 "-prom-env variable=value\n" 4253ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 4254ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 4255e2fcbf42SPeter MaydellSRST 4256e2fcbf42SPeter Maydell``-prom-env variable=value`` 4257e2fcbf42SPeter Maydell Set OpenBIOS nvram variable to given value (PPC, SPARC only). 4258e2fcbf42SPeter Maydell 4259e2fcbf42SPeter Maydell :: 4260e2fcbf42SPeter Maydell 4261e2fcbf42SPeter Maydell qemu-system-sparc -prom-env 'auto-boot?=false' \ 4262e2fcbf42SPeter Maydell -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' 4263e2fcbf42SPeter Maydell 4264e2fcbf42SPeter Maydell :: 4265e2fcbf42SPeter Maydell 4266e2fcbf42SPeter Maydell qemu-system-ppc -prom-env 'auto-boot?=false' \ 4267e2fcbf42SPeter Maydell -prom-env 'boot-device=hd:2,\yaboot' \ 4268e2fcbf42SPeter Maydell -prom-env 'boot-args=conf=hd:2,\yaboot.conf' 4269e2fcbf42SPeter MaydellERST 42705824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 4271f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 42723b3c1694SLeon Alrae QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 4273a10b9d93SKeith Packard QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4274e2fcbf42SPeter MaydellSRST 4275e2fcbf42SPeter Maydell``-semihosting`` 4276a10b9d93SKeith Packard Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V only). 4277e2fcbf42SPeter Maydell 4278e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4279e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4280e2fcbf42SPeter Maydell 4281e2fcbf42SPeter Maydell See the -semihosting-config option documentation for further 4282e2fcbf42SPeter Maydell information about the facilities this enables. 4283e2fcbf42SPeter MaydellERST 4284a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 42854e7f9032SAlex Bennée "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \ 4286a59d31a1SLeon Alrae " semihosting configuration\n", 42873b3c1694SLeon AlraeQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 4288a10b9d93SKeith PackardQEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4289e2fcbf42SPeter MaydellSRST 4290e2fcbf42SPeter Maydell``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]`` 4291a10b9d93SKeith Packard Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V 4292e2fcbf42SPeter Maydell only). 4293e2fcbf42SPeter Maydell 4294e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4295e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4296e2fcbf42SPeter Maydell 4297e2fcbf42SPeter Maydell On Arm this implements the standard semihosting API, version 2.0. 4298e2fcbf42SPeter Maydell 4299e2fcbf42SPeter Maydell On M68K this implements the "ColdFire GDB" interface used by 4300e2fcbf42SPeter Maydell libgloss. 4301e2fcbf42SPeter Maydell 4302e2fcbf42SPeter Maydell Xtensa semihosting provides basic file IO calls, such as 4303e2fcbf42SPeter Maydell open/read/write/seek/select. Tensilica baremetal libc for ISS and 4304e2fcbf42SPeter Maydell linux platform "sim" use this interface. 4305e2fcbf42SPeter Maydell 4306a10b9d93SKeith Packard On RISC-V this implements the standard semihosting API, version 0.2. 4307a10b9d93SKeith Packard 4308e2fcbf42SPeter Maydell ``target=native|gdb|auto`` 4309e2fcbf42SPeter Maydell Defines where the semihosting calls will be addressed, to QEMU 4310e2fcbf42SPeter Maydell (``native``) or to GDB (``gdb``). The default is ``auto``, which 4311e2fcbf42SPeter Maydell means ``gdb`` during debug sessions and ``native`` otherwise. 4312e2fcbf42SPeter Maydell 4313e2fcbf42SPeter Maydell ``chardev=str1`` 4314e2fcbf42SPeter Maydell Send the output to a chardev backend output for native or auto 4315e2fcbf42SPeter Maydell output when not in gdb 4316e2fcbf42SPeter Maydell 4317e2fcbf42SPeter Maydell ``arg=str1,arg=str2,...`` 4318e2fcbf42SPeter Maydell Allows the user to pass input arguments, and can be used 4319e2fcbf42SPeter Maydell multiple times to build up a list. The old-style 4320e2fcbf42SPeter Maydell ``-kernel``/``-append`` method of passing a command line is 4321e2fcbf42SPeter Maydell still supported for backward compatibility. If both the 4322e2fcbf42SPeter Maydell ``--semihosting-config arg`` and the ``-kernel``/``-append`` are 4323e2fcbf42SPeter Maydell specified, the former is passed to semihosting as it always 4324e2fcbf42SPeter Maydell takes precedence. 4325e2fcbf42SPeter MaydellERST 43265824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 4327ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 4328e2fcbf42SPeter MaydellSRST 4329e2fcbf42SPeter Maydell``-old-param`` 4330e2fcbf42SPeter Maydell Old param mode (ARM only). 4331e2fcbf42SPeter MaydellERST 433295d5f08bSStefan Weil 43337d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 433473a1e647SEduardo Otubo "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \ 433524f8cdc5SEduardo Otubo " [,spawn=allow|deny][,resourcecontrol=allow|deny]\n" \ 43362b716fa6SEduardo Otubo " Enable seccomp mode 2 system call filter (default 'off').\n" \ 43372b716fa6SEduardo Otubo " use 'obsolete' to allow obsolete system calls that are provided\n" \ 43382b716fa6SEduardo Otubo " by the kernel, but typically no longer used by modern\n" \ 433973a1e647SEduardo Otubo " C library implementations.\n" \ 4340d42304b1SPhilippe Mathieu-Daudé " use 'elevateprivileges' to allow or deny the QEMU process ability\n" \ 4341d42304b1SPhilippe Mathieu-Daudé " to elevate privileges using set*uid|gid system calls.\n" \ 434273a1e647SEduardo Otubo " The value 'children' will deny set*uid|gid system calls for\n" \ 4343995a226fSEduardo Otubo " main QEMU process but will allow forks and execves to run unprivileged\n" \ 4344995a226fSEduardo Otubo " use 'spawn' to avoid QEMU to spawn new threads or processes by\n" \ 4345d42304b1SPhilippe Mathieu-Daudé " blocking *fork and execve\n" \ 434624f8cdc5SEduardo Otubo " use 'resourcecontrol' to disable process affinity and schedular priority\n", 43477d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 4348e2fcbf42SPeter MaydellSRST 4349e2fcbf42SPeter Maydell``-sandbox arg[,obsolete=string][,elevateprivileges=string][,spawn=string][,resourcecontrol=string]`` 4350e2fcbf42SPeter Maydell Enable Seccomp mode 2 system call filter. 'on' will enable syscall 4351e2fcbf42SPeter Maydell filtering and 'off' will disable it. The default is 'off'. 4352e2fcbf42SPeter Maydell 4353e2fcbf42SPeter Maydell ``obsolete=string`` 4354e2fcbf42SPeter Maydell Enable Obsolete system calls 4355e2fcbf42SPeter Maydell 4356e2fcbf42SPeter Maydell ``elevateprivileges=string`` 4357e2fcbf42SPeter Maydell Disable set\*uid\|gid system calls 4358e2fcbf42SPeter Maydell 4359e2fcbf42SPeter Maydell ``spawn=string`` 4360e2fcbf42SPeter Maydell Disable \*fork and execve 4361e2fcbf42SPeter Maydell 4362e2fcbf42SPeter Maydell ``resourcecontrol=string`` 4363e2fcbf42SPeter Maydell Disable process affinity and schedular priority 4364e2fcbf42SPeter MaydellERST 43657d76ad4fSEduardo Otubo 4366715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 4367ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 4368e2fcbf42SPeter MaydellSRST 4369e2fcbf42SPeter Maydell``-readconfig file`` 4370e2fcbf42SPeter Maydell Read device configuration from file. This approach is useful when 4371e2fcbf42SPeter Maydell you want to spawn QEMU process with many command line options but 4372e2fcbf42SPeter Maydell you don't want to exceed the command line character limit. 4373e2fcbf42SPeter MaydellERST 4374715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 4375715a664aSGerd Hoffmann "-writeconfig <file>\n" 4376b979c931SPaolo Bonzini " read/write config file (deprecated)\n", QEMU_ARCH_ALL) 4377e2fcbf42SPeter MaydellSRST 4378e2fcbf42SPeter MaydellERST 43792feac451SThomas Huth 4380f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 4381f29a5614SEduardo Habkost "-no-user-config\n" 43823478eae9SEduardo Habkost " do not load default user-provided config files at startup\n", 4383f29a5614SEduardo Habkost QEMU_ARCH_ALL) 4384e2fcbf42SPeter MaydellSRST 4385e2fcbf42SPeter Maydell``-no-user-config`` 4386e2fcbf42SPeter Maydell The ``-no-user-config`` option makes QEMU not load any of the 4387e2fcbf42SPeter Maydell user-provided config files on sysconfdir. 4388e2fcbf42SPeter MaydellERST 43892feac451SThomas Huth 4390ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 439110578a25SPaolo Bonzini "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 439223d15e86SLluís " specify tracing options\n", 4393ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 4394e2fcbf42SPeter MaydellSRST 4395e2fcbf42SPeter Maydell``-trace [[enable=]pattern][,events=file][,file=file]`` 439609ce5f2dSPeter Maydell .. include:: ../qemu-option-trace.rst.inc 4397e2fcbf42SPeter Maydell 4398e2fcbf42SPeter MaydellERST 439942229a75SLluís VilanovaDEF("plugin", HAS_ARG, QEMU_OPTION_plugin, 440042229a75SLluís Vilanova "-plugin [file=]<file>[,arg=<string>]\n" 440142229a75SLluís Vilanova " load a plugin\n", 440242229a75SLluís Vilanova QEMU_ARCH_ALL) 4403e2fcbf42SPeter MaydellSRST 4404e2fcbf42SPeter Maydell``-plugin file=file[,arg=string]`` 4405e2fcbf42SPeter Maydell Load a plugin. 4406e2fcbf42SPeter Maydell 4407e2fcbf42SPeter Maydell ``file=file`` 4408e2fcbf42SPeter Maydell Load the given plugin from a shared library file. 4409e2fcbf42SPeter Maydell 4410e2fcbf42SPeter Maydell ``arg=string`` 4411e2fcbf42SPeter Maydell Argument string passed to the plugin. (Can be given multiple 4412e2fcbf42SPeter Maydell times.) 4413e2fcbf42SPeter MaydellERST 44143dbf2c7fSStefan Weil 441531e70d6cSMarkus ArmbrusterHXCOMM Internal use 441631e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 441731e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 4418c7f0f3b1SAnthony Liguori 44190f66998fSPaul Moore#ifdef __linux__ 44200f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 44210f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 44220f66998fSPaul Moore QEMU_ARCH_ALL) 44230f66998fSPaul Moore#endif 4424e2fcbf42SPeter MaydellSRST 4425e2fcbf42SPeter Maydell``-enable-fips`` 4426e2fcbf42SPeter Maydell Enable FIPS 140-2 compliance mode. 4427e2fcbf42SPeter MaydellERST 44280f66998fSPaul Moore 44295e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 44302880ffb0SMario Smarduch "-msg [timestamp[=on|off]][,guest-name=[on|off]]\n" 4431deda497bSMarkus Armbruster " control error message format\n" 44322880ffb0SMario Smarduch " timestamp=on enables timestamps (default: off)\n" 44332880ffb0SMario Smarduch " guest-name=on enables guest name prefix but only if\n" 44342880ffb0SMario Smarduch " -name guest option is set (default: off)\n", 44355e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 4436e2fcbf42SPeter MaydellSRST 44372880ffb0SMario Smarduch``-msg [timestamp[=on|off]][,guest-name[=on|off]]`` 4438e2fcbf42SPeter Maydell Control error message format. 4439e2fcbf42SPeter Maydell 4440e2fcbf42SPeter Maydell ``timestamp=on|off`` 4441e2fcbf42SPeter Maydell Prefix messages with a timestamp. Default is off. 44422880ffb0SMario Smarduch 44432880ffb0SMario Smarduch ``guest-name=on|off`` 44442880ffb0SMario Smarduch Prefix messages with guest name but only if -name guest option is set 44452880ffb0SMario Smarduch otherwise the option is ignored. Default is off. 4446e2fcbf42SPeter MaydellERST 44475e2ac519SSeiji Aguchi 4448abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 4449abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 4450abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 4451abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 4452abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 44532382053fSLaurent Vivier " by comparing two such vmstate dumps.\n", 4454abfd9ce3SAmit Shah QEMU_ARCH_ALL) 4455e2fcbf42SPeter MaydellSRST 4456e2fcbf42SPeter Maydell``-dump-vmstate file`` 4457e2fcbf42SPeter Maydell Dump json-encoded vmstate information for current machine type to 4458e2fcbf42SPeter Maydell file in file 4459e2fcbf42SPeter MaydellERST 4460abfd9ce3SAmit Shah 446112df189dSEmilio G. CotaDEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile, 446212df189dSEmilio G. Cota "-enable-sync-profile\n" 446312df189dSEmilio G. Cota " enable synchronization profiling\n", 446412df189dSEmilio G. Cota QEMU_ARCH_ALL) 4465e2fcbf42SPeter MaydellSRST 4466e2fcbf42SPeter Maydell``-enable-sync-profile`` 4467e2fcbf42SPeter Maydell Enable synchronization profiling. 4468e2fcbf42SPeter MaydellERST 446912df189dSEmilio G. Cota 447043f187a5SPaolo BonziniDEFHEADING() 4471de6b4f90SMarkus Armbruster 4472de6b4f90SMarkus ArmbrusterDEFHEADING(Generic object creation:) 4473b9174d4fSDaniel P. Berrange 4474b9174d4fSDaniel P. BerrangeDEF("object", HAS_ARG, QEMU_OPTION_object, 4475b9174d4fSDaniel P. Berrange "-object TYPENAME[,PROP1=VALUE1,...]\n" 4476b9174d4fSDaniel P. Berrange " create a new object of type TYPENAME setting properties\n" 4477b9174d4fSDaniel P. Berrange " in the order they are specified. Note that the 'id'\n" 4478b9174d4fSDaniel P. Berrange " property must be set. These objects are placed in the\n" 4479b9174d4fSDaniel P. Berrange " '/objects' path.\n", 4480b9174d4fSDaniel P. Berrange QEMU_ARCH_ALL) 4481e2fcbf42SPeter MaydellSRST 4482e2fcbf42SPeter Maydell``-object typename[,prop1=value1,...]`` 4483e2fcbf42SPeter Maydell Create a new object of type typename setting properties in the order 4484e2fcbf42SPeter Maydell they are specified. Note that the 'id' property must be set. These 4485e2fcbf42SPeter Maydell objects are placed in the '/objects' path. 4486e2fcbf42SPeter Maydell 448786635aa4SStefan Hajnoczi ``-object memory-backend-file,id=id,size=size,mem-path=dir,share=on|off,discard-data=on|off,merge=on|off,dump=on|off,prealloc=on|off,host-nodes=host-nodes,policy=default|preferred|bind|interleave,align=align,readonly=on|off`` 4488e2fcbf42SPeter Maydell Creates a memory file backend object, which can be used to back 4489e2fcbf42SPeter Maydell the guest RAM with huge pages. 4490e2fcbf42SPeter Maydell 4491e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 4492e2fcbf42SPeter Maydell reference this memory region when configuring the ``-numa`` 4493e2fcbf42SPeter Maydell argument. 4494e2fcbf42SPeter Maydell 4495e2fcbf42SPeter Maydell The ``size`` option provides the size of the memory region, and 4496e2fcbf42SPeter Maydell accepts common suffixes, eg ``500M``. 4497e2fcbf42SPeter Maydell 4498e2fcbf42SPeter Maydell The ``mem-path`` provides the path to either a shared memory or 4499e2fcbf42SPeter Maydell huge page filesystem mount. 4500e2fcbf42SPeter Maydell 4501e2fcbf42SPeter Maydell The ``share`` boolean option determines whether the memory 4502e2fcbf42SPeter Maydell region is marked as private to QEMU, or shared. The latter 4503e2fcbf42SPeter Maydell allows a co-operating external process to access the QEMU memory 4504e2fcbf42SPeter Maydell region. 4505e2fcbf42SPeter Maydell 4506e2fcbf42SPeter Maydell The ``share`` is also required for pvrdma devices due to 4507e2fcbf42SPeter Maydell limitations in the RDMA API provided by Linux. 4508e2fcbf42SPeter Maydell 4509e2fcbf42SPeter Maydell Setting share=on might affect the ability to configure NUMA 4510e2fcbf42SPeter Maydell bindings for the memory backend under some circumstances, see 4511e2fcbf42SPeter Maydell Documentation/vm/numa\_memory\_policy.txt on the Linux kernel 4512e2fcbf42SPeter Maydell source tree for additional details. 4513e2fcbf42SPeter Maydell 4514e2fcbf42SPeter Maydell Setting the ``discard-data`` boolean option to on indicates that 4515e2fcbf42SPeter Maydell file contents can be destroyed when QEMU exits, to avoid 4516e2fcbf42SPeter Maydell unnecessarily flushing data to the backing file. Note that 4517e2fcbf42SPeter Maydell ``discard-data`` is only an optimization, and QEMU might not 4518e2fcbf42SPeter Maydell discard file contents if it aborts unexpectedly or is terminated 4519e2fcbf42SPeter Maydell using SIGKILL. 4520e2fcbf42SPeter Maydell 4521e2fcbf42SPeter Maydell The ``merge`` boolean option enables memory merge, also known as 4522e2fcbf42SPeter Maydell MADV\_MERGEABLE, so that Kernel Samepage Merging will consider 4523e2fcbf42SPeter Maydell the pages for memory deduplication. 4524e2fcbf42SPeter Maydell 4525e2fcbf42SPeter Maydell Setting the ``dump`` boolean option to off excludes the memory 4526e2fcbf42SPeter Maydell from core dumps. This feature is also known as MADV\_DONTDUMP. 4527e2fcbf42SPeter Maydell 4528e2fcbf42SPeter Maydell The ``prealloc`` boolean option enables memory preallocation. 4529e2fcbf42SPeter Maydell 4530e2fcbf42SPeter Maydell The ``host-nodes`` option binds the memory range to a list of 4531e2fcbf42SPeter Maydell NUMA host nodes. 4532e2fcbf42SPeter Maydell 4533e2fcbf42SPeter Maydell The ``policy`` option sets the NUMA policy to one of the 4534e2fcbf42SPeter Maydell following values: 4535e2fcbf42SPeter Maydell 4536e2fcbf42SPeter Maydell ``default`` 4537e2fcbf42SPeter Maydell default host policy 4538e2fcbf42SPeter Maydell 4539e2fcbf42SPeter Maydell ``preferred`` 4540e2fcbf42SPeter Maydell prefer the given host node list for allocation 4541e2fcbf42SPeter Maydell 4542e2fcbf42SPeter Maydell ``bind`` 4543e2fcbf42SPeter Maydell restrict memory allocation to the given host node list 4544e2fcbf42SPeter Maydell 4545e2fcbf42SPeter Maydell ``interleave`` 4546e2fcbf42SPeter Maydell interleave memory allocations across the given host node 4547e2fcbf42SPeter Maydell list 4548e2fcbf42SPeter Maydell 4549e2fcbf42SPeter Maydell The ``align`` option specifies the base address alignment when 4550e2fcbf42SPeter Maydell QEMU mmap(2) ``mem-path``, and accepts common suffixes, eg 4551e2fcbf42SPeter Maydell ``2M``. Some backend store specified by ``mem-path`` requires an 4552e2fcbf42SPeter Maydell alignment different than the default one used by QEMU, eg the 4553e2fcbf42SPeter Maydell device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In 4554e2fcbf42SPeter Maydell such cases, users can specify the required alignment via this 4555e2fcbf42SPeter Maydell option. 4556e2fcbf42SPeter Maydell 4557e2fcbf42SPeter Maydell The ``pmem`` option specifies whether the backing file specified 4558e2fcbf42SPeter Maydell by ``mem-path`` is in host persistent memory that can be 4559e2fcbf42SPeter Maydell accessed using the SNIA NVM programming model (e.g. Intel 4560e2fcbf42SPeter Maydell NVDIMM). If ``pmem`` is set to 'on', QEMU will take necessary 4561e2fcbf42SPeter Maydell operations to guarantee the persistence of its own writes to 4562e2fcbf42SPeter Maydell ``mem-path`` (e.g. in vNVDIMM label emulation and live 4563e2fcbf42SPeter Maydell migration). Also, we will map the backend-file with MAP\_SYNC 4564e2fcbf42SPeter Maydell flag, which ensures the file metadata is in sync for 4565e2fcbf42SPeter Maydell ``mem-path`` in case of host crash or a power failure. MAP\_SYNC 4566e2fcbf42SPeter Maydell requires support from both the host kernel (since Linux kernel 4567e2fcbf42SPeter Maydell 4.15) and the filesystem of ``mem-path`` mounted with DAX 4568e2fcbf42SPeter Maydell option. 4569e2fcbf42SPeter Maydell 457086635aa4SStefan Hajnoczi The ``readonly`` option specifies whether the backing file is opened 457186635aa4SStefan Hajnoczi read-only or read-write (default). 457286635aa4SStefan Hajnoczi 4573e2fcbf42SPeter Maydell ``-object memory-backend-ram,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=default|preferred|bind|interleave`` 4574e2fcbf42SPeter Maydell Creates a memory backend object, which can be used to back the 4575e2fcbf42SPeter Maydell guest RAM. Memory backend objects offer more control than the 4576e2fcbf42SPeter Maydell ``-m`` option that is traditionally used to define guest RAM. 4577e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 4578e2fcbf42SPeter Maydell options. 4579e2fcbf42SPeter Maydell 4580e2fcbf42SPeter Maydell ``-object memory-backend-memfd,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=default|preferred|bind|interleave,seal=on|off,hugetlb=on|off,hugetlbsize=size`` 4581e2fcbf42SPeter Maydell Creates an anonymous memory file backend object, which allows 4582e2fcbf42SPeter Maydell QEMU to share the memory with an external process (e.g. when 4583e2fcbf42SPeter Maydell using vhost-user). The memory is allocated with memfd and 4584e2fcbf42SPeter Maydell optional sealing. (Linux only) 4585e2fcbf42SPeter Maydell 4586e2fcbf42SPeter Maydell The ``seal`` option creates a sealed-file, that will block 4587e2fcbf42SPeter Maydell further resizing the memory ('on' by default). 4588e2fcbf42SPeter Maydell 4589e2fcbf42SPeter Maydell The ``hugetlb`` option specify the file to be created resides in 4590e2fcbf42SPeter Maydell the hugetlbfs filesystem (since Linux 4.14). Used in conjunction 4591e2fcbf42SPeter Maydell with the ``hugetlb`` option, the ``hugetlbsize`` option specify 4592e2fcbf42SPeter Maydell the hugetlb page size on systems that support multiple hugetlb 4593e2fcbf42SPeter Maydell page sizes (it must be a power of 2 value supported by the 4594e2fcbf42SPeter Maydell system). 4595e2fcbf42SPeter Maydell 4596e2fcbf42SPeter Maydell In some versions of Linux, the ``hugetlb`` option is 4597e2fcbf42SPeter Maydell incompatible with the ``seal`` option (requires at least Linux 4598e2fcbf42SPeter Maydell 4.16). 4599e2fcbf42SPeter Maydell 4600e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 4601e2fcbf42SPeter Maydell other options. 4602e2fcbf42SPeter Maydell 4603e2fcbf42SPeter Maydell The ``share`` boolean option is on by default with memfd. 4604e2fcbf42SPeter Maydell 4605e2fcbf42SPeter Maydell ``-object rng-builtin,id=id`` 4606e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4607e2fcbf42SPeter Maydell from QEMU builtin functions. The ``id`` parameter is a unique ID 4608e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 4609e2fcbf42SPeter Maydell ``virtio-rng`` device. By default, the ``virtio-rng`` device 4610e2fcbf42SPeter Maydell uses this RNG backend. 4611e2fcbf42SPeter Maydell 4612e2fcbf42SPeter Maydell ``-object rng-random,id=id,filename=/dev/random`` 4613e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4614e2fcbf42SPeter Maydell from a device on the host. The ``id`` parameter is a unique ID 4615e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 4616e2fcbf42SPeter Maydell ``virtio-rng`` device. The ``filename`` parameter specifies 4617e2fcbf42SPeter Maydell which file to obtain entropy from and if omitted defaults to 4618e2fcbf42SPeter Maydell ``/dev/urandom``. 4619e2fcbf42SPeter Maydell 4620e2fcbf42SPeter Maydell ``-object rng-egd,id=id,chardev=chardevid`` 4621e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4622e2fcbf42SPeter Maydell from an external daemon running on the host. The ``id`` 4623e2fcbf42SPeter Maydell parameter is a unique ID that will be used to reference this 4624e2fcbf42SPeter Maydell entropy backend from the ``virtio-rng`` device. The ``chardev`` 4625e2fcbf42SPeter Maydell parameter is the unique ID of a character device backend that 4626e2fcbf42SPeter Maydell provides the connection to the RNG daemon. 4627e2fcbf42SPeter Maydell 4628e2fcbf42SPeter Maydell ``-object tls-creds-anon,id=id,endpoint=endpoint,dir=/path/to/cred/dir,verify-peer=on|off`` 4629e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 4630e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 4631e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 4632e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 4633e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 4634e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 4635e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 4636e2fcbf42SPeter Maydell is completed, the peer credentials will be verified, though this 4637e2fcbf42SPeter Maydell is a no-op for anonymous credentials. 4638e2fcbf42SPeter Maydell 4639e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 4640e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 4641e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 4642e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 4643e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 4644e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4645e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 4646e2fcbf42SPeter Maydell upfront and saved. 4647e2fcbf42SPeter Maydell 4648e2fcbf42SPeter Maydell ``-object tls-creds-psk,id=id,endpoint=endpoint,dir=/path/to/keys/dir[,username=username]`` 4649e2fcbf42SPeter Maydell Creates a TLS Pre-Shared Keys (PSK) credentials object, which 4650e2fcbf42SPeter Maydell can be used to provide TLS support on network backends. The 4651e2fcbf42SPeter Maydell ``id`` parameter is a unique ID which network backends will use 4652e2fcbf42SPeter Maydell to access the credentials. The ``endpoint`` is either ``server`` 4653e2fcbf42SPeter Maydell or ``client`` depending on whether the QEMU network backend that 4654e2fcbf42SPeter Maydell uses the credentials will be acting as a client or as a server. 4655e2fcbf42SPeter Maydell For clients only, ``username`` is the username which will be 4656e2fcbf42SPeter Maydell sent to the server. If omitted it defaults to "qemu". 4657e2fcbf42SPeter Maydell 4658e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the keys file. It is 4659e2fcbf42SPeter Maydell called "dir/keys.psk" and contains "username:key" pairs. This 4660e2fcbf42SPeter Maydell file can most easily be created using the GnuTLS ``psktool`` 4661e2fcbf42SPeter Maydell program. 4662e2fcbf42SPeter Maydell 4663e2fcbf42SPeter Maydell For server endpoints, dir may also contain a file dh-params.pem 4664e2fcbf42SPeter Maydell providing diffie-hellman parameters to use for the TLS server. 4665e2fcbf42SPeter Maydell If the file is missing, QEMU will generate a set of DH 4666e2fcbf42SPeter Maydell parameters at startup. This is a computationally expensive 4667e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4668e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated up 4669e2fcbf42SPeter Maydell front and saved. 4670e2fcbf42SPeter Maydell 4671e2fcbf42SPeter Maydell ``-object tls-creds-x509,id=id,endpoint=endpoint,dir=/path/to/cred/dir,priority=priority,verify-peer=on|off,passwordid=id`` 4672e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 4673e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 4674e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 4675e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 4676e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 4677e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 4678e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 4679e2fcbf42SPeter Maydell is completed, the peer credentials will be verified. With x509 4680e2fcbf42SPeter Maydell certificates, this implies that the clients must be provided 4681e2fcbf42SPeter Maydell with valid client certificates too. 4682e2fcbf42SPeter Maydell 4683e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 4684e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 4685e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 4686e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 4687e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 4688e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4689e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 4690e2fcbf42SPeter Maydell upfront and saved. 4691e2fcbf42SPeter Maydell 4692e2fcbf42SPeter Maydell For x509 certificate credentials the directory will contain 4693e2fcbf42SPeter Maydell further files providing the x509 certificates. The certificates 4694e2fcbf42SPeter Maydell must be stored in PEM format, in filenames ca-cert.pem, 4695e2fcbf42SPeter Maydell ca-crl.pem (optional), server-cert.pem (only servers), 4696e2fcbf42SPeter Maydell server-key.pem (only servers), client-cert.pem (only clients), 4697e2fcbf42SPeter Maydell and client-key.pem (only clients). 4698e2fcbf42SPeter Maydell 4699e2fcbf42SPeter Maydell For the server-key.pem and client-key.pem files which contain 4700e2fcbf42SPeter Maydell sensitive private keys, it is possible to use an encrypted 4701e2fcbf42SPeter Maydell version by providing the passwordid parameter. This provides the 4702e2fcbf42SPeter Maydell ID of a previously created ``secret`` object containing the 4703e2fcbf42SPeter Maydell password for decryption. 4704e2fcbf42SPeter Maydell 4705e2fcbf42SPeter Maydell The priority parameter allows to override the global default 4706e2fcbf42SPeter Maydell priority used by gnutls. This can be useful if the system 4707e2fcbf42SPeter Maydell administrator needs to use a weaker set of crypto priorities for 4708e2fcbf42SPeter Maydell QEMU without potentially forcing the weakness onto all 4709e2fcbf42SPeter Maydell applications. Or conversely if one wants wants a stronger 4710e2fcbf42SPeter Maydell default for QEMU than for all other applications, they can do 4711e2fcbf42SPeter Maydell this through this parameter. Its format is a gnutls priority 4712e2fcbf42SPeter Maydell string as described at 4713e2fcbf42SPeter Maydell https://gnutls.org/manual/html_node/Priority-Strings.html. 4714e2fcbf42SPeter Maydell 4715993aec27SPhilippe Mathieu-Daudé ``-object tls-cipher-suites,id=id,priority=priority`` 4716993aec27SPhilippe Mathieu-Daudé Creates a TLS cipher suites object, which can be used to control 4717993aec27SPhilippe Mathieu-Daudé the TLS cipher/protocol algorithms that applications are permitted 4718993aec27SPhilippe Mathieu-Daudé to use. 4719993aec27SPhilippe Mathieu-Daudé 4720993aec27SPhilippe Mathieu-Daudé The ``id`` parameter is a unique ID which frontends will use to 4721993aec27SPhilippe Mathieu-Daudé access the ordered list of permitted TLS cipher suites from the 4722993aec27SPhilippe Mathieu-Daudé host. 4723993aec27SPhilippe Mathieu-Daudé 4724993aec27SPhilippe Mathieu-Daudé The ``priority`` parameter allows to override the global default 4725993aec27SPhilippe Mathieu-Daudé priority used by gnutls. This can be useful if the system 4726993aec27SPhilippe Mathieu-Daudé administrator needs to use a weaker set of crypto priorities for 4727993aec27SPhilippe Mathieu-Daudé QEMU without potentially forcing the weakness onto all 4728993aec27SPhilippe Mathieu-Daudé applications. Or conversely if one wants wants a stronger 4729993aec27SPhilippe Mathieu-Daudé default for QEMU than for all other applications, they can do 4730993aec27SPhilippe Mathieu-Daudé this through this parameter. Its format is a gnutls priority 4731993aec27SPhilippe Mathieu-Daudé string as described at 4732993aec27SPhilippe Mathieu-Daudé https://gnutls.org/manual/html_node/Priority-Strings.html. 4733993aec27SPhilippe Mathieu-Daudé 473469699f30SPhilippe Mathieu-Daudé An example of use of this object is to control UEFI HTTPS Boot. 473569699f30SPhilippe Mathieu-Daudé The tls-cipher-suites object exposes the ordered list of permitted 473669699f30SPhilippe Mathieu-Daudé TLS cipher suites from the host side to the guest firmware, via 473769699f30SPhilippe Mathieu-Daudé fw_cfg. The list is represented as an array of IANA_TLS_CIPHER 473869699f30SPhilippe Mathieu-Daudé objects. The firmware uses the IANA_TLS_CIPHER array for configuring 473969699f30SPhilippe Mathieu-Daudé guest-side TLS. 474069699f30SPhilippe Mathieu-Daudé 474169699f30SPhilippe Mathieu-Daudé In the following example, the priority at which the host-side policy 474269699f30SPhilippe Mathieu-Daudé is retrieved is given by the ``priority`` property. 474369699f30SPhilippe Mathieu-Daudé Given that QEMU uses GNUTLS, ``priority=@SYSTEM`` may be used to 474469699f30SPhilippe Mathieu-Daudé refer to /etc/crypto-policies/back-ends/gnutls.config. 474569699f30SPhilippe Mathieu-Daudé 474669699f30SPhilippe Mathieu-Daudé .. parsed-literal:: 474769699f30SPhilippe Mathieu-Daudé 4748353a06b4SLaszlo Ersek # |qemu_system| \\ 4749353a06b4SLaszlo Ersek -object tls-cipher-suites,id=mysuite0,priority=@SYSTEM \\ 475069699f30SPhilippe Mathieu-Daudé -fw_cfg name=etc/edk2/https/ciphers,gen_id=mysuite0 475169699f30SPhilippe Mathieu-Daudé 4752e2fcbf42SPeter Maydell ``-object filter-buffer,id=id,netdev=netdevid,interval=t[,queue=all|rx|tx][,status=on|off][,position=head|tail|id=<id>][,insert=behind|before]`` 4753e2fcbf42SPeter Maydell Interval t can't be 0, this filter batches the packet delivery: 4754e2fcbf42SPeter Maydell all packets arriving in a given interval on netdev netdevid are 4755e2fcbf42SPeter Maydell delayed until the end of the interval. Interval is in 4756e2fcbf42SPeter Maydell microseconds. ``status`` is optional that indicate whether the 4757e2fcbf42SPeter Maydell netfilter is on (enabled) or off (disabled), the default status 4758e2fcbf42SPeter Maydell for netfilter will be 'on'. 4759e2fcbf42SPeter Maydell 4760e2fcbf42SPeter Maydell queue all\|rx\|tx is an option that can be applied to any 4761e2fcbf42SPeter Maydell netfilter. 4762e2fcbf42SPeter Maydell 4763e2fcbf42SPeter Maydell ``all``: the filter is attached both to the receive and the 4764e2fcbf42SPeter Maydell transmit queue of the netdev (default). 4765e2fcbf42SPeter Maydell 4766e2fcbf42SPeter Maydell ``rx``: the filter is attached to the receive queue of the 4767e2fcbf42SPeter Maydell netdev, where it will receive packets sent to the netdev. 4768e2fcbf42SPeter Maydell 4769e2fcbf42SPeter Maydell ``tx``: the filter is attached to the transmit queue of the 4770e2fcbf42SPeter Maydell netdev, where it will receive packets sent by the netdev. 4771e2fcbf42SPeter Maydell 4772e2fcbf42SPeter Maydell position head\|tail\|id=<id> is an option to specify where the 4773e2fcbf42SPeter Maydell filter should be inserted in the filter list. It can be applied 4774e2fcbf42SPeter Maydell to any netfilter. 4775e2fcbf42SPeter Maydell 4776e2fcbf42SPeter Maydell ``head``: the filter is inserted at the head of the filter list, 4777e2fcbf42SPeter Maydell before any existing filters. 4778e2fcbf42SPeter Maydell 4779e2fcbf42SPeter Maydell ``tail``: the filter is inserted at the tail of the filter list, 4780e2fcbf42SPeter Maydell behind any existing filters (default). 4781e2fcbf42SPeter Maydell 4782e2fcbf42SPeter Maydell ``id=<id>``: the filter is inserted before or behind the filter 4783e2fcbf42SPeter Maydell specified by <id>, see the insert option below. 4784e2fcbf42SPeter Maydell 4785e2fcbf42SPeter Maydell insert behind\|before is an option to specify where to insert 4786e2fcbf42SPeter Maydell the new filter relative to the one specified with 4787e2fcbf42SPeter Maydell position=id=<id>. It can be applied to any netfilter. 4788e2fcbf42SPeter Maydell 4789e2fcbf42SPeter Maydell ``before``: insert before the specified filter. 4790e2fcbf42SPeter Maydell 4791e2fcbf42SPeter Maydell ``behind``: insert behind the specified filter (default). 4792e2fcbf42SPeter Maydell 4793e2fcbf42SPeter Maydell ``-object filter-mirror,id=id,netdev=netdevid,outdev=chardevid,queue=all|rx|tx[,vnet_hdr_support][,position=head|tail|id=<id>][,insert=behind|before]`` 4794e2fcbf42SPeter Maydell filter-mirror on netdev netdevid,mirror net packet to 4795e2fcbf42SPeter Maydell chardevchardevid, if it has the vnet\_hdr\_support flag, 4796e2fcbf42SPeter Maydell filter-mirror will mirror packet with vnet\_hdr\_len. 4797e2fcbf42SPeter Maydell 4798e2fcbf42SPeter Maydell ``-object filter-redirector,id=id,netdev=netdevid,indev=chardevid,outdev=chardevid,queue=all|rx|tx[,vnet_hdr_support][,position=head|tail|id=<id>][,insert=behind|before]`` 4799e2fcbf42SPeter Maydell filter-redirector on netdev netdevid,redirect filter's net 4800e2fcbf42SPeter Maydell packet to chardev chardevid,and redirect indev's packet to 4801e2fcbf42SPeter Maydell filter.if it has the vnet\_hdr\_support flag, filter-redirector 4802e2fcbf42SPeter Maydell will redirect packet with vnet\_hdr\_len. Create a 4803e2fcbf42SPeter Maydell filter-redirector we need to differ outdev id from indev id, id 4804e2fcbf42SPeter Maydell can not be the same. we can just use indev or outdev, but at 4805e2fcbf42SPeter Maydell least one of indev or outdev need to be specified. 4806e2fcbf42SPeter Maydell 4807e2fcbf42SPeter Maydell ``-object filter-rewriter,id=id,netdev=netdevid,queue=all|rx|tx,[vnet_hdr_support][,position=head|tail|id=<id>][,insert=behind|before]`` 4808e2fcbf42SPeter Maydell Filter-rewriter is a part of COLO project.It will rewrite tcp 4809e2fcbf42SPeter Maydell packet to secondary from primary to keep secondary tcp 4810e2fcbf42SPeter Maydell connection,and rewrite tcp packet to primary from secondary make 4811e2fcbf42SPeter Maydell tcp packet can be handled by client.if it has the 4812e2fcbf42SPeter Maydell vnet\_hdr\_support flag, we can parse packet with vnet header. 4813e2fcbf42SPeter Maydell 4814e2fcbf42SPeter Maydell usage: colo secondary: -object 4815e2fcbf42SPeter Maydell filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 -object 4816e2fcbf42SPeter Maydell filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 -object 4817e2fcbf42SPeter Maydell filter-rewriter,id=rew0,netdev=hn0,queue=all 4818e2fcbf42SPeter Maydell 4819e2fcbf42SPeter Maydell ``-object filter-dump,id=id,netdev=dev[,file=filename][,maxlen=len][,position=head|tail|id=<id>][,insert=behind|before]`` 4820e2fcbf42SPeter Maydell Dump the network traffic on netdev dev to the file specified by 4821e2fcbf42SPeter Maydell filename. At most len bytes (64k by default) per packet are 4822e2fcbf42SPeter Maydell stored. The file format is libpcap, so it can be analyzed with 4823e2fcbf42SPeter Maydell tools such as tcpdump or Wireshark. 4824e2fcbf42SPeter Maydell 4825a2e5cb7aSZhang Chen ``-object colo-compare,id=id,primary_in=chardevid,secondary_in=chardevid,outdev=chardevid,iothread=id[,vnet_hdr_support][,notify_dev=id][,compare_timeout=@var{ms}][,expired_scan_cycle=@var{ms}][,max_queue_size=@var{size}]`` 4826e2fcbf42SPeter Maydell Colo-compare gets packet from primary\_in chardevid and 48272b28a7efSZhang Chen secondary\_in, then compare whether the payload of primary packet 48282b28a7efSZhang Chen and secondary packet are the same. If same, it will output 48292b28a7efSZhang Chen primary packet to out\_dev, else it will notify COLO-framework to do 48302b28a7efSZhang Chen checkpoint and send primary packet to out\_dev. In order to 48312b28a7efSZhang Chen improve efficiency, we need to put the task of comparison in 48322b28a7efSZhang Chen another iothread. If it has the vnet\_hdr\_support flag, 48332b28a7efSZhang Chen colo compare will send/recv packet with vnet\_hdr\_len. 48342b28a7efSZhang Chen The compare\_timeout=@var{ms} determines the maximum time of the 48352b28a7efSZhang Chen colo-compare hold the packet. The expired\_scan\_cycle=@var{ms} 48362b28a7efSZhang Chen is to set the period of scanning expired primary node network packets. 48372b28a7efSZhang Chen The max\_queue\_size=@var{size} is to set the max compare queue 48382b28a7efSZhang Chen size depend on user environment. 48392b28a7efSZhang Chen If user want to use Xen COLO, need to add the notify\_dev to 48409cc43c94SZhang Chen notify Xen colo-frame to do checkpoint. 4841e2fcbf42SPeter Maydell 48422b28a7efSZhang Chen COLO-compare must be used with the help of filter-mirror, 48432b28a7efSZhang Chen filter-redirector and filter-rewriter. 4844e2fcbf42SPeter Maydell 4845e2fcbf42SPeter Maydell :: 4846e2fcbf42SPeter Maydell 4847e2fcbf42SPeter Maydell KVM COLO 4848e2fcbf42SPeter Maydell 4849e2fcbf42SPeter Maydell primary: 4850e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 4851e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 4852bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 4853bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 4854bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 4855e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 4856bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 4857e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 4858e2fcbf42SPeter Maydell -object iothread,id=iothread1 4859e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 4860e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 4861e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 4862e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1 4863e2fcbf42SPeter Maydell 4864e2fcbf42SPeter Maydell secondary: 4865e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 4866e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 4867e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 4868e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 4869e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4870e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4871e2fcbf42SPeter Maydell 4872e2fcbf42SPeter Maydell 4873e2fcbf42SPeter Maydell Xen COLO 4874e2fcbf42SPeter Maydell 4875e2fcbf42SPeter Maydell primary: 4876e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 4877e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 4878bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 4879bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 4880bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 4881e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 4882bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 4883e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 4884bfdc1267SDaniel P. Berrangé -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server=on,wait=off 4885e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 4886e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 4887e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 4888e2fcbf42SPeter Maydell -object iothread,id=iothread1 4889e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1 4890e2fcbf42SPeter Maydell 4891e2fcbf42SPeter Maydell secondary: 4892e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 4893e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 4894e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 4895e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 4896e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4897e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4898e2fcbf42SPeter Maydell 4899e2fcbf42SPeter Maydell If you want to know the detail of above command line, you can 4900e2fcbf42SPeter Maydell read the colo-compare git log. 4901e2fcbf42SPeter Maydell 4902e2fcbf42SPeter Maydell ``-object cryptodev-backend-builtin,id=id[,queues=queues]`` 4903e2fcbf42SPeter Maydell Creates a cryptodev backend which executes crypto opreation from 4904e2fcbf42SPeter Maydell the QEMU cipher APIS. The id parameter is a unique ID that will 4905e2fcbf42SPeter Maydell be used to reference this cryptodev backend from the 4906e2fcbf42SPeter Maydell ``virtio-crypto`` device. The queues parameter is optional, 4907e2fcbf42SPeter Maydell which specify the queue number of cryptodev backend, the default 4908e2fcbf42SPeter Maydell of queues is 1. 4909e2fcbf42SPeter Maydell 491009ce5f2dSPeter Maydell .. parsed-literal:: 4911e2fcbf42SPeter Maydell 4912353a06b4SLaszlo Ersek # |qemu_system| \\ 4913353a06b4SLaszlo Ersek [...] \\ 4914353a06b4SLaszlo Ersek -object cryptodev-backend-builtin,id=cryptodev0 \\ 4915353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 4916e2fcbf42SPeter Maydell [...] 4917e2fcbf42SPeter Maydell 4918e2fcbf42SPeter Maydell ``-object cryptodev-vhost-user,id=id,chardev=chardevid[,queues=queues]`` 4919e2fcbf42SPeter Maydell Creates a vhost-user cryptodev backend, backed by a chardev 4920e2fcbf42SPeter Maydell chardevid. The id parameter is a unique ID that will be used to 4921e2fcbf42SPeter Maydell reference this cryptodev backend from the ``virtio-crypto`` 4922e2fcbf42SPeter Maydell device. The chardev should be a unix domain socket backed one. 4923e2fcbf42SPeter Maydell The vhost-user uses a specifically defined protocol to pass 4924e2fcbf42SPeter Maydell vhost ioctl replacement messages to an application on the other 4925e2fcbf42SPeter Maydell end of the socket. The queues parameter is optional, which 4926e2fcbf42SPeter Maydell specify the queue number of cryptodev backend for multiqueue 4927e2fcbf42SPeter Maydell vhost-user, the default of queues is 1. 4928e2fcbf42SPeter Maydell 492909ce5f2dSPeter Maydell .. parsed-literal:: 4930e2fcbf42SPeter Maydell 4931353a06b4SLaszlo Ersek # |qemu_system| \\ 4932353a06b4SLaszlo Ersek [...] \\ 4933353a06b4SLaszlo Ersek -chardev socket,id=chardev0,path=/path/to/socket \\ 4934353a06b4SLaszlo Ersek -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \\ 4935353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 4936e2fcbf42SPeter Maydell [...] 4937e2fcbf42SPeter Maydell 4938e2fcbf42SPeter Maydell ``-object secret,id=id,data=string,format=raw|base64[,keyid=secretid,iv=string]`` 493909ce5f2dSPeter Maydell \ 4940e2fcbf42SPeter Maydell ``-object secret,id=id,file=filename,format=raw|base64[,keyid=secretid,iv=string]`` 4941e2fcbf42SPeter Maydell Defines a secret to store a password, encryption key, or some 4942e2fcbf42SPeter Maydell other sensitive data. The sensitive data can either be passed 4943e2fcbf42SPeter Maydell directly via the data parameter, or indirectly via the file 4944e2fcbf42SPeter Maydell parameter. Using the data parameter is insecure unless the 4945e2fcbf42SPeter Maydell sensitive data is encrypted. 4946e2fcbf42SPeter Maydell 4947e2fcbf42SPeter Maydell The sensitive data can be provided in raw format (the default), 4948e2fcbf42SPeter Maydell or base64. When encoded as JSON, the raw format only supports 4949e2fcbf42SPeter Maydell valid UTF-8 characters, so base64 is recommended for sending 4950e2fcbf42SPeter Maydell binary data. QEMU will convert from which ever format is 4951e2fcbf42SPeter Maydell provided to the format it needs internally. eg, an RBD password 4952e2fcbf42SPeter Maydell can be provided in raw format, even though it will be base64 4953e2fcbf42SPeter Maydell encoded when passed onto the RBD sever. 4954e2fcbf42SPeter Maydell 4955e2fcbf42SPeter Maydell For added protection, it is possible to encrypt the data 4956e2fcbf42SPeter Maydell associated with a secret using the AES-256-CBC cipher. Use of 4957e2fcbf42SPeter Maydell encryption is indicated by providing the keyid and iv 4958e2fcbf42SPeter Maydell parameters. The keyid parameter provides the ID of a previously 4959e2fcbf42SPeter Maydell defined secret that contains the AES-256 decryption key. This 4960e2fcbf42SPeter Maydell key should be 32-bytes long and be base64 encoded. The iv 4961e2fcbf42SPeter Maydell parameter provides the random initialization vector used for 4962e2fcbf42SPeter Maydell encryption of this particular secret and should be a base64 4963e2fcbf42SPeter Maydell encrypted string of the 16-byte IV. 4964e2fcbf42SPeter Maydell 4965e2fcbf42SPeter Maydell The simplest (insecure) usage is to provide the secret inline 4966e2fcbf42SPeter Maydell 496709ce5f2dSPeter Maydell .. parsed-literal:: 4968e2fcbf42SPeter Maydell 4969e2fcbf42SPeter Maydell # |qemu_system| -object secret,id=sec0,data=letmein,format=raw 4970e2fcbf42SPeter Maydell 4971e2fcbf42SPeter Maydell The simplest secure usage is to provide the secret via a file 4972e2fcbf42SPeter Maydell 4973e2fcbf42SPeter Maydell # printf "letmein" > mypasswd.txt # QEMU\_SYSTEM\_MACRO -object 4974e2fcbf42SPeter Maydell secret,id=sec0,file=mypasswd.txt,format=raw 4975e2fcbf42SPeter Maydell 4976e2fcbf42SPeter Maydell For greater security, AES-256-CBC should be used. To illustrate 4977e2fcbf42SPeter Maydell usage, consider the openssl command line tool which can encrypt 4978e2fcbf42SPeter Maydell the data. Note that when encrypting, the plaintext must be 4979e2fcbf42SPeter Maydell padded to the cipher block size (32 bytes) using the standard 4980e2fcbf42SPeter Maydell PKCS#5/6 compatible padding algorithm. 4981e2fcbf42SPeter Maydell 4982e2fcbf42SPeter Maydell First a master key needs to be created in base64 encoding: 4983e2fcbf42SPeter Maydell 4984e2fcbf42SPeter Maydell :: 4985e2fcbf42SPeter Maydell 4986e2fcbf42SPeter Maydell # openssl rand -base64 32 > key.b64 4987e2fcbf42SPeter Maydell # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 4988e2fcbf42SPeter Maydell 4989e2fcbf42SPeter Maydell Each secret to be encrypted needs to have a random 4990e2fcbf42SPeter Maydell initialization vector generated. These do not need to be kept 4991e2fcbf42SPeter Maydell secret 4992e2fcbf42SPeter Maydell 4993e2fcbf42SPeter Maydell :: 4994e2fcbf42SPeter Maydell 4995e2fcbf42SPeter Maydell # openssl rand -base64 16 > iv.b64 4996e2fcbf42SPeter Maydell # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 4997e2fcbf42SPeter Maydell 4998e2fcbf42SPeter Maydell The secret to be defined can now be encrypted, in this case 4999e2fcbf42SPeter Maydell we're telling openssl to base64 encode the result, but it could 5000e2fcbf42SPeter Maydell be left as raw bytes if desired. 5001e2fcbf42SPeter Maydell 5002e2fcbf42SPeter Maydell :: 5003e2fcbf42SPeter Maydell 5004e2fcbf42SPeter Maydell # SECRET=$(printf "letmein" | 5005e2fcbf42SPeter Maydell openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 5006e2fcbf42SPeter Maydell 5007e2fcbf42SPeter Maydell When launching QEMU, create a master secret pointing to 5008e2fcbf42SPeter Maydell ``key.b64`` and specify that to be used to decrypt the user 5009e2fcbf42SPeter Maydell password. Pass the contents of ``iv.b64`` to the second secret 5010e2fcbf42SPeter Maydell 501109ce5f2dSPeter Maydell .. parsed-literal:: 5012e2fcbf42SPeter Maydell 5013353a06b4SLaszlo Ersek # |qemu_system| \\ 5014353a06b4SLaszlo Ersek -object secret,id=secmaster0,format=base64,file=key.b64 \\ 5015353a06b4SLaszlo Ersek -object secret,id=sec0,keyid=secmaster0,format=base64,\\ 5016e2fcbf42SPeter Maydell data=$SECRET,iv=$(<iv.b64) 5017e2fcbf42SPeter Maydell 5018e2fcbf42SPeter Maydell ``-object sev-guest,id=id,cbitpos=cbitpos,reduced-phys-bits=val,[sev-device=string,policy=policy,handle=handle,dh-cert-file=file,session-file=file]`` 5019e2fcbf42SPeter Maydell Create a Secure Encrypted Virtualization (SEV) guest object, 5020e2fcbf42SPeter Maydell which can be used to provide the guest memory encryption support 5021e2fcbf42SPeter Maydell on AMD processors. 5022e2fcbf42SPeter Maydell 5023e2fcbf42SPeter Maydell When memory encryption is enabled, one of the physical address 5024e2fcbf42SPeter Maydell bit (aka the C-bit) is utilized to mark if a memory page is 5025e2fcbf42SPeter Maydell protected. The ``cbitpos`` is used to provide the C-bit 5026e2fcbf42SPeter Maydell position. The C-bit position is Host family dependent hence user 5027e2fcbf42SPeter Maydell must provide this value. On EPYC, the value should be 47. 5028e2fcbf42SPeter Maydell 5029e2fcbf42SPeter Maydell When memory encryption is enabled, we loose certain bits in 5030e2fcbf42SPeter Maydell physical address space. The ``reduced-phys-bits`` is used to 5031e2fcbf42SPeter Maydell provide the number of bits we loose in physical address space. 5032e2fcbf42SPeter Maydell Similar to C-bit, the value is Host family dependent. On EPYC, 5033e2fcbf42SPeter Maydell the value should be 5. 5034e2fcbf42SPeter Maydell 5035e2fcbf42SPeter Maydell The ``sev-device`` provides the device file to use for 5036e2fcbf42SPeter Maydell communicating with the SEV firmware running inside AMD Secure 5037e2fcbf42SPeter Maydell Processor. The default device is '/dev/sev'. If hardware 5038e2fcbf42SPeter Maydell supports memory encryption then /dev/sev devices are created by 5039e2fcbf42SPeter Maydell CCP driver. 5040e2fcbf42SPeter Maydell 5041e2fcbf42SPeter Maydell The ``policy`` provides the guest policy to be enforced by the 5042e2fcbf42SPeter Maydell SEV firmware and restrict what configuration and operational 5043e2fcbf42SPeter Maydell commands can be performed on this guest by the hypervisor. The 5044e2fcbf42SPeter Maydell policy should be provided by the guest owner and is bound to the 5045e2fcbf42SPeter Maydell guest and cannot be changed throughout the lifetime of the 5046e2fcbf42SPeter Maydell guest. The default is 0. 5047e2fcbf42SPeter Maydell 5048e2fcbf42SPeter Maydell If guest ``policy`` allows sharing the key with another SEV 5049e2fcbf42SPeter Maydell guest then ``handle`` can be use to provide handle of the guest 5050e2fcbf42SPeter Maydell from which to share the key. 5051e2fcbf42SPeter Maydell 5052e2fcbf42SPeter Maydell The ``dh-cert-file`` and ``session-file`` provides the guest 5053e2fcbf42SPeter Maydell owner's Public Diffie-Hillman key defined in SEV spec. The PDH 5054e2fcbf42SPeter Maydell and session parameters are used for establishing a cryptographic 5055e2fcbf42SPeter Maydell session with the guest owner to negotiate keys used for 5056e2fcbf42SPeter Maydell attestation. The file must be encoded in base64. 5057e2fcbf42SPeter Maydell 5058e2fcbf42SPeter Maydell e.g to launch a SEV guest 5059e2fcbf42SPeter Maydell 506009ce5f2dSPeter Maydell .. parsed-literal:: 5061e2fcbf42SPeter Maydell 5062353a06b4SLaszlo Ersek # |qemu_system_x86| \\ 5063353a06b4SLaszlo Ersek ...... \\ 5064353a06b4SLaszlo Ersek -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \\ 5065353a06b4SLaszlo Ersek -machine ...,memory-encryption=sev0 \\ 5066e2fcbf42SPeter Maydell ..... 5067e2fcbf42SPeter Maydell 5068e2fcbf42SPeter Maydell ``-object authz-simple,id=id,identity=string`` 5069e2fcbf42SPeter Maydell Create an authorization object that will control access to 5070e2fcbf42SPeter Maydell network services. 5071e2fcbf42SPeter Maydell 5072e2fcbf42SPeter Maydell The ``identity`` parameter is identifies the user and its format 5073e2fcbf42SPeter Maydell depends on the network service that authorization object is 5074e2fcbf42SPeter Maydell associated with. For authorizing based on TLS x509 certificates, 5075e2fcbf42SPeter Maydell the identity must be the x509 distinguished name. Note that care 5076e2fcbf42SPeter Maydell must be taken to escape any commas in the distinguished name. 5077e2fcbf42SPeter Maydell 5078e2fcbf42SPeter Maydell An example authorization object to validate a x509 distinguished 5079e2fcbf42SPeter Maydell name would look like: 5080e2fcbf42SPeter Maydell 508109ce5f2dSPeter Maydell .. parsed-literal:: 5082e2fcbf42SPeter Maydell 5083353a06b4SLaszlo Ersek # |qemu_system| \\ 5084353a06b4SLaszlo Ersek ... \\ 5085353a06b4SLaszlo Ersek -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \\ 5086e2fcbf42SPeter Maydell ... 5087e2fcbf42SPeter Maydell 5088e2fcbf42SPeter Maydell Note the use of quotes due to the x509 distinguished name 5089e2fcbf42SPeter Maydell containing whitespace, and escaping of ','. 5090e2fcbf42SPeter Maydell 50914d7beeabSDaniel P. Berrangé ``-object authz-listfile,id=id,filename=path,refresh=on|off`` 5092e2fcbf42SPeter Maydell Create an authorization object that will control access to 5093e2fcbf42SPeter Maydell network services. 5094e2fcbf42SPeter Maydell 5095e2fcbf42SPeter Maydell The ``filename`` parameter is the fully qualified path to a file 5096e2fcbf42SPeter Maydell containing the access control list rules in JSON format. 5097e2fcbf42SPeter Maydell 5098e2fcbf42SPeter Maydell An example set of rules that match against SASL usernames might 5099e2fcbf42SPeter Maydell look like: 5100e2fcbf42SPeter Maydell 5101e2fcbf42SPeter Maydell :: 5102e2fcbf42SPeter Maydell 5103e2fcbf42SPeter Maydell { 5104e2fcbf42SPeter Maydell "rules": [ 5105e2fcbf42SPeter Maydell { "match": "fred", "policy": "allow", "format": "exact" }, 5106e2fcbf42SPeter Maydell { "match": "bob", "policy": "allow", "format": "exact" }, 5107e2fcbf42SPeter Maydell { "match": "danb", "policy": "deny", "format": "glob" }, 5108e2fcbf42SPeter Maydell { "match": "dan*", "policy": "allow", "format": "exact" }, 5109e2fcbf42SPeter Maydell ], 5110e2fcbf42SPeter Maydell "policy": "deny" 5111e2fcbf42SPeter Maydell } 5112e2fcbf42SPeter Maydell 5113e2fcbf42SPeter Maydell When checking access the object will iterate over all the rules 5114e2fcbf42SPeter Maydell and the first rule to match will have its ``policy`` value 5115e2fcbf42SPeter Maydell returned as the result. If no rules match, then the default 5116e2fcbf42SPeter Maydell ``policy`` value is returned. 5117e2fcbf42SPeter Maydell 5118e2fcbf42SPeter Maydell The rules can either be an exact string match, or they can use 5119e2fcbf42SPeter Maydell the simple UNIX glob pattern matching to allow wildcards to be 5120e2fcbf42SPeter Maydell used. 5121e2fcbf42SPeter Maydell 5122e2fcbf42SPeter Maydell If ``refresh`` is set to true the file will be monitored and 5123e2fcbf42SPeter Maydell automatically reloaded whenever its content changes. 5124e2fcbf42SPeter Maydell 5125e2fcbf42SPeter Maydell As with the ``authz-simple`` object, the format of the identity 5126e2fcbf42SPeter Maydell strings being matched depends on the network service, but is 5127e2fcbf42SPeter Maydell usually a TLS x509 distinguished name, or a SASL username. 5128e2fcbf42SPeter Maydell 5129e2fcbf42SPeter Maydell An example authorization object to validate a SASL username 5130e2fcbf42SPeter Maydell would look like: 5131e2fcbf42SPeter Maydell 513209ce5f2dSPeter Maydell .. parsed-literal:: 5133e2fcbf42SPeter Maydell 5134353a06b4SLaszlo Ersek # |qemu_system| \\ 5135353a06b4SLaszlo Ersek ... \\ 51364d7beeabSDaniel P. Berrangé -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=on \\ 5137e2fcbf42SPeter Maydell ... 5138e2fcbf42SPeter Maydell 5139e2fcbf42SPeter Maydell ``-object authz-pam,id=id,service=string`` 5140e2fcbf42SPeter Maydell Create an authorization object that will control access to 5141e2fcbf42SPeter Maydell network services. 5142e2fcbf42SPeter Maydell 5143e2fcbf42SPeter Maydell The ``service`` parameter provides the name of a PAM service to 5144e2fcbf42SPeter Maydell use for authorization. It requires that a file 5145e2fcbf42SPeter Maydell ``/etc/pam.d/service`` exist to provide the configuration for 5146e2fcbf42SPeter Maydell the ``account`` subsystem. 5147e2fcbf42SPeter Maydell 5148e2fcbf42SPeter Maydell An example authorization object to validate a TLS x509 5149e2fcbf42SPeter Maydell distinguished name would look like: 5150e2fcbf42SPeter Maydell 515109ce5f2dSPeter Maydell .. parsed-literal:: 5152e2fcbf42SPeter Maydell 5153353a06b4SLaszlo Ersek # |qemu_system| \\ 5154353a06b4SLaszlo Ersek ... \\ 5155353a06b4SLaszlo Ersek -object authz-pam,id=auth0,service=qemu-vnc \\ 5156e2fcbf42SPeter Maydell ... 5157e2fcbf42SPeter Maydell 5158e2fcbf42SPeter Maydell There would then be a corresponding config file for PAM at 5159e2fcbf42SPeter Maydell ``/etc/pam.d/qemu-vnc`` that contains: 5160e2fcbf42SPeter Maydell 5161e2fcbf42SPeter Maydell :: 5162e2fcbf42SPeter Maydell 5163e2fcbf42SPeter Maydell account requisite pam_listfile.so item=user sense=allow \ 5164e2fcbf42SPeter Maydell file=/etc/qemu/vnc.allow 5165e2fcbf42SPeter Maydell 5166e2fcbf42SPeter Maydell Finally the ``/etc/qemu/vnc.allow`` file would contain the list 5167e2fcbf42SPeter Maydell of x509 distingished names that are permitted access 5168e2fcbf42SPeter Maydell 5169e2fcbf42SPeter Maydell :: 5170e2fcbf42SPeter Maydell 5171e2fcbf42SPeter Maydell CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB 5172e2fcbf42SPeter Maydell 5173e2fcbf42SPeter Maydell ``-object iothread,id=id,poll-max-ns=poll-max-ns,poll-grow=poll-grow,poll-shrink=poll-shrink`` 5174e2fcbf42SPeter Maydell Creates a dedicated event loop thread that devices can be 5175e2fcbf42SPeter Maydell assigned to. This is known as an IOThread. By default device 5176e2fcbf42SPeter Maydell emulation happens in vCPU threads or the main event loop thread. 5177e2fcbf42SPeter Maydell This can become a scalability bottleneck. IOThreads allow device 5178e2fcbf42SPeter Maydell emulation and I/O to run on other host CPUs. 5179e2fcbf42SPeter Maydell 5180e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 5181e2fcbf42SPeter Maydell reference this IOThread from ``-device ...,iothread=id``. 5182e2fcbf42SPeter Maydell Multiple devices can be assigned to an IOThread. Note that not 5183e2fcbf42SPeter Maydell all devices support an ``iothread`` parameter. 5184e2fcbf42SPeter Maydell 5185e2fcbf42SPeter Maydell The ``query-iothreads`` QMP command lists IOThreads and reports 5186e2fcbf42SPeter Maydell their thread IDs so that the user can configure host CPU 5187e2fcbf42SPeter Maydell pinning/affinity. 5188e2fcbf42SPeter Maydell 5189e2fcbf42SPeter Maydell IOThreads use an adaptive polling algorithm to reduce event loop 5190e2fcbf42SPeter Maydell latency. Instead of entering a blocking system call to monitor 5191e2fcbf42SPeter Maydell file descriptors and then pay the cost of being woken up when an 5192e2fcbf42SPeter Maydell event occurs, the polling algorithm spins waiting for events for 5193e2fcbf42SPeter Maydell a short time. The algorithm's default parameters are suitable 5194e2fcbf42SPeter Maydell for many cases but can be adjusted based on knowledge of the 5195e2fcbf42SPeter Maydell workload and/or host device latency. 5196e2fcbf42SPeter Maydell 5197e2fcbf42SPeter Maydell The ``poll-max-ns`` parameter is the maximum number of 5198e2fcbf42SPeter Maydell nanoseconds to busy wait for events. Polling can be disabled by 5199e2fcbf42SPeter Maydell setting this value to 0. 5200e2fcbf42SPeter Maydell 5201e2fcbf42SPeter Maydell The ``poll-grow`` parameter is the multiplier used to increase 5202e2fcbf42SPeter Maydell the polling time when the algorithm detects it is missing events 5203e2fcbf42SPeter Maydell due to not polling long enough. 5204e2fcbf42SPeter Maydell 5205e2fcbf42SPeter Maydell The ``poll-shrink`` parameter is the divisor used to decrease 5206e2fcbf42SPeter Maydell the polling time when the algorithm detects it is spending too 5207e2fcbf42SPeter Maydell long polling without encountering events. 5208e2fcbf42SPeter Maydell 5209e2fcbf42SPeter Maydell The polling parameters can be modified at run-time using the 5210e2fcbf42SPeter Maydell ``qom-set`` command (where ``iothread1`` is the IOThread's 5211e2fcbf42SPeter Maydell ``id``): 5212e2fcbf42SPeter Maydell 5213e2fcbf42SPeter Maydell :: 5214e2fcbf42SPeter Maydell 5215e2fcbf42SPeter Maydell (qemu) qom-set /objects/iothread1 poll-max-ns 100000 5216e2fcbf42SPeter MaydellERST 5217b9174d4fSDaniel P. Berrange 5218b9174d4fSDaniel P. Berrange 52193dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 5220