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" 2974a414a1SReinoud Zandijk " supported accelerators are kvm, xen, hax, hvf, nvmm, 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 6174a414a1SReinoud Zandijk architecture, kvm, xen, hax, hvf, nvmm, 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 :: 10795355829SPeter Maydell 1088db0b204SIgor Mammedov -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on 1098db0b204SIgor Mammedov -machine memory-backend=pc.ram 1108db0b204SIgor Mammedov -m 512M 1118db0b204SIgor Mammedov 1128db0b204SIgor Mammedov Migration compatibility note: 11395355829SPeter Maydell 11495355829SPeter Maydell * as backend id one shall use value of 'default-ram-id', advertised by 1158db0b204SIgor Mammedov machine type (available via ``query-machines`` QMP command), if migration 1168db0b204SIgor Mammedov to/from old QEMU (<5.0) is expected. 11795355829SPeter Maydell * for machine types 4.0 and older, user shall 1188db0b204SIgor Mammedov use ``x-use-canonical-path-for-ramblock-id=off`` backend option 1198db0b204SIgor Mammedov if migration to/from old QEMU (<5.0) is expected. 12095355829SPeter Maydell 1218db0b204SIgor Mammedov For example: 1228db0b204SIgor Mammedov :: 12395355829SPeter Maydell 1248db0b204SIgor Mammedov -object memory-backend-ram,id=pc.ram,size=512M,x-use-canonical-path-for-ramblock-id=off 1258db0b204SIgor Mammedov -machine memory-backend=pc.ram 1268db0b204SIgor Mammedov -m 512M 127e2fcbf42SPeter MaydellERST 1285824d651Sblueswir1 129dfce81f1SSean ChristophersonDEF("M", HAS_ARG, QEMU_OPTION_M, 13011058123SYang Zhong " sgx-epc.0.memdev=memid,sgx-epc.0.node=numaid\n", 131dfce81f1SSean Christopherson QEMU_ARCH_ALL) 132dfce81f1SSean Christopherson 133dfce81f1SSean ChristophersonSRST 13411058123SYang Zhong``sgx-epc.0.memdev=@var{memid},sgx-epc.0.node=@var{numaid}`` 135dfce81f1SSean Christopherson Define an SGX EPC section. 136dfce81f1SSean ChristophersonERST 13780f52a66SJan Kiszka 1385824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 139585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 140e2fcbf42SPeter MaydellSRST 141e2fcbf42SPeter Maydell``-cpu model`` 142e2fcbf42SPeter Maydell Select CPU model (``-cpu help`` for list and additional feature 143e2fcbf42SPeter Maydell selection) 144e2fcbf42SPeter MaydellERST 1455824d651Sblueswir1 1468d4e9146SKONRAD FredericDEF("accel", HAS_ARG, QEMU_OPTION_accel, 147fe174132SPaolo Bonzini "-accel [accel=]accelerator[,prop[=value][,...]]\n" 14874a414a1SReinoud Zandijk " select accelerator (kvm, xen, hax, hvf, nvmm, whpx or tcg; use 'help' for a list)\n" 14946472d82SPaolo Bonzini " igd-passthru=on|off (enable Xen integrated Intel graphics passthrough, default=off)\n" 15011bc4a13SPaolo Bonzini " kernel-irqchip=on|off|split controls accelerated irqchip support (default=on)\n" 15123b0898eSPaolo Bonzini " kvm-shadow-mem=size of KVM shadow MMU in bytes\n" 152a35b3e14SRichard Henderson " split-wx=on|off (enable TCG split w^x mapping)\n" 153fe174132SPaolo Bonzini " tb-size=n (TCG translation block cache size)\n" 1542ea5cb0aSPeter Xu " dirty-ring-size=n (KVM dirty ring GFN count, default 0)\n" 1550b3c5c81SEduardo Habkost " thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL) 156e2fcbf42SPeter MaydellSRST 157e2fcbf42SPeter Maydell``-accel name[,prop=value[,...]]`` 158e2fcbf42SPeter Maydell This is used to enable an accelerator. Depending on the target 15974a414a1SReinoud Zandijk architecture, kvm, xen, hax, hvf, nvmm, whpx or tcg can be available. By 160e2fcbf42SPeter Maydell default, tcg is used. If there is more than one accelerator 161e2fcbf42SPeter Maydell specified, the next one is used if the previous one fails to 162e2fcbf42SPeter Maydell initialize. 163e2fcbf42SPeter Maydell 164e2fcbf42SPeter Maydell ``igd-passthru=on|off`` 165e2fcbf42SPeter Maydell When Xen is in use, this option controls whether Intel 166e2fcbf42SPeter Maydell integrated graphics devices can be passed through to the guest 167e2fcbf42SPeter Maydell (default=off) 168e2fcbf42SPeter Maydell 169e2fcbf42SPeter Maydell ``kernel-irqchip=on|off|split`` 170e2fcbf42SPeter Maydell Controls KVM in-kernel irqchip support. The default is full 171e2fcbf42SPeter Maydell acceleration of the interrupt controllers. On x86, split irqchip 172e2fcbf42SPeter Maydell reduces the kernel attack surface, at a performance cost for 173e2fcbf42SPeter Maydell non-MSI interrupts. Disabling the in-kernel irqchip completely 174e2fcbf42SPeter Maydell is not recommended except for debugging purposes. 175e2fcbf42SPeter Maydell 176e2fcbf42SPeter Maydell ``kvm-shadow-mem=size`` 177e2fcbf42SPeter Maydell Defines the size of the KVM shadow MMU. 178e2fcbf42SPeter Maydell 179a35b3e14SRichard Henderson ``split-wx=on|off`` 180a35b3e14SRichard Henderson Controls the use of split w^x mapping for the TCG code generation 181a35b3e14SRichard Henderson buffer. Some operating systems require this to be enabled, and in 182a35b3e14SRichard Henderson such a case this will default on. On other operating systems, this 183a35b3e14SRichard Henderson will default off, but one may enable this for testing or debugging. 184a35b3e14SRichard Henderson 185e2fcbf42SPeter Maydell ``tb-size=n`` 186e2fcbf42SPeter Maydell Controls the size (in MiB) of the TCG translation block cache. 187e2fcbf42SPeter Maydell 188e2fcbf42SPeter Maydell ``thread=single|multi`` 189e2fcbf42SPeter Maydell Controls number of TCG threads. When the TCG is multi-threaded 190cba42d61SMichael Tokarev there will be one thread per vCPU therefore taking advantage of 191e2fcbf42SPeter Maydell additional host cores. The default is to enable multi-threading 192e2fcbf42SPeter Maydell where both the back-end and front-ends support it and no 193e2fcbf42SPeter Maydell incompatible TCG features have been enabled (e.g. 194e2fcbf42SPeter Maydell icount/replay). 1952ea5cb0aSPeter Xu 1962ea5cb0aSPeter Xu ``dirty-ring-size=n`` 1972ea5cb0aSPeter Xu When the KVM accelerator is used, it controls the size of the per-vCPU 1982ea5cb0aSPeter Xu dirty page ring buffer (number of entries for each vCPU). It should 1992ea5cb0aSPeter Xu be a value that is power of two, and it should be 1024 or bigger (but 2002ea5cb0aSPeter Xu still less than the maximum value that the kernel supports). 4096 2012ea5cb0aSPeter Xu could be a good initial value if you have no idea which is the best. 2022ea5cb0aSPeter Xu Set this value to 0 to disable the feature. By default, this feature 2032ea5cb0aSPeter Xu is disabled (dirty-ring-size=0). When enabled, KVM will instead 2042ea5cb0aSPeter Xu record dirty pages in a bitmap. 2052ea5cb0aSPeter Xu 206e2fcbf42SPeter MaydellERST 2078d4e9146SKONRAD Frederic 2085824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 209864c3b5cSYanan Wang "-smp [[cpus=]n][,maxcpus=maxcpus][,sockets=sockets][,dies=dies][,clusters=clusters][,cores=cores][,threads=threads]\n" 2100d871785SYanan Wang " set the number of initial CPUs to 'n' [default=1]\n" 211ce8ee7c6SDaniel P. Berrangé " maxcpus= maximum number of total CPUs, including\n" 212ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 2130d871785SYanan Wang " sockets= number of sockets on the machine board\n" 2140d871785SYanan Wang " dies= number of dies in one socket\n" 215864c3b5cSYanan Wang " clusters= number of clusters in one die\n" 216864c3b5cSYanan Wang " cores= number of cores in one cluster\n" 2170d871785SYanan Wang " threads= number of threads in one core\n" 2180d871785SYanan Wang "Note: Different machines may have different subsets of the CPU topology\n" 2190d871785SYanan Wang " parameters supported, so the actual meaning of the supported parameters\n" 2200d871785SYanan Wang " will vary accordingly. For example, for a machine type that supports a\n" 2210d871785SYanan Wang " three-level CPU hierarchy of sockets/cores/threads, the parameters will\n" 2220d871785SYanan Wang " sequentially mean as below:\n" 2230d871785SYanan Wang " sockets means the number of sockets on the machine board\n" 2240d871785SYanan Wang " cores means the number of cores in one socket\n" 2250d871785SYanan Wang " threads means the number of threads in one core\n" 2260d871785SYanan Wang " For a particular machine type board, an expected CPU topology hierarchy\n" 2270d871785SYanan Wang " can be defined through the supported sub-option. Unsupported parameters\n" 2280d871785SYanan Wang " can also be provided in addition to the sub-option, but their values\n" 2290d871785SYanan Wang " must be set as 1 in the purpose of correct parsing.\n", 230ad96090aSBlue Swirl QEMU_ARCH_ALL) 231e2fcbf42SPeter MaydellSRST 232864c3b5cSYanan Wang``-smp [[cpus=]n][,maxcpus=maxcpus][,sockets=sockets][,dies=dies][,clusters=clusters][,cores=cores][,threads=threads]`` 23380d78357SDaniel P. Berrangé Simulate a SMP system with '\ ``n``\ ' CPUs initially present on 23480d78357SDaniel P. Berrangé the machine type board. On boards supporting CPU hotplug, the optional 23580d78357SDaniel P. Berrangé '\ ``maxcpus``\ ' parameter can be set to enable further CPUs to be 2367d8c5a39SYanan Wang added at runtime. When both parameters are omitted, the maximum number 2377d8c5a39SYanan Wang of CPUs will be calculated from the provided topology members and the 2387d8c5a39SYanan Wang initial CPU count will match the maximum number. When only one of them 2397d8c5a39SYanan Wang is given then the omitted one will be set to its counterpart's value. 2407d8c5a39SYanan Wang Both parameters may be specified, but the maximum number of CPUs must 2410d871785SYanan Wang be equal to or greater than the initial CPU count. Product of the 2420d871785SYanan Wang CPU topology hierarchy must be equal to the maximum number of CPUs. 2430d871785SYanan Wang Both parameters are subject to an upper limit that is determined by 2440d871785SYanan Wang the specific machine type chosen. 24580d78357SDaniel P. Berrangé 2460d871785SYanan Wang To control reporting of CPU topology information, values of the topology 2470d871785SYanan Wang parameters can be specified. Machines may only support a subset of the 2480d871785SYanan Wang parameters and different machines may have different subsets supported 2490d871785SYanan Wang which vary depending on capacity of the corresponding CPU targets. So 2500d871785SYanan Wang for a particular machine type board, an expected topology hierarchy can 2510d871785SYanan Wang be defined through the supported sub-option. Unsupported parameters can 2520d871785SYanan Wang also be provided in addition to the sub-option, but their values must be 2530d871785SYanan Wang set as 1 in the purpose of correct parsing. 25480d78357SDaniel P. Berrangé 25580d78357SDaniel P. Berrangé Either the initial CPU count, or at least one of the topology parameters 256c2511b16SYanan Wang must be specified. The specified parameters must be greater than zero, 257c2511b16SYanan Wang explicit configuration like "cpus=0" is not allowed. Values for any 258c2511b16SYanan Wang omitted parameters will be computed from those which are given. 2590d871785SYanan Wang 2600d871785SYanan Wang For example, the following sub-option defines a CPU topology hierarchy 2610d871785SYanan Wang (2 sockets totally on the machine, 2 cores per socket, 2 threads per 2620d871785SYanan Wang core) for a machine that only supports sockets/cores/threads. 2630d871785SYanan Wang Some members of the option can be omitted but their values will be 2640d871785SYanan Wang automatically computed: 2650d871785SYanan Wang 2660d871785SYanan Wang :: 2670d871785SYanan Wang 2680d871785SYanan Wang -smp 8,sockets=2,cores=2,threads=2,maxcpus=8 2690d871785SYanan Wang 2700d871785SYanan Wang The following sub-option defines a CPU topology hierarchy (2 sockets 2710d871785SYanan Wang totally on the machine, 2 dies per socket, 2 cores per die, 2 threads 2720d871785SYanan Wang per core) for PC machines which support sockets/dies/cores/threads. 2730d871785SYanan Wang Some members of the option can be omitted but their values will be 2740d871785SYanan Wang automatically computed: 2750d871785SYanan Wang 2760d871785SYanan Wang :: 2770d871785SYanan Wang 2780d871785SYanan Wang -smp 16,sockets=2,dies=2,cores=2,threads=2,maxcpus=16 2790d871785SYanan Wang 280d55c316fSYanan Wang The following sub-option defines a CPU topology hierarchy (2 sockets 281d55c316fSYanan Wang totally on the machine, 2 clusters per socket, 2 cores per cluster, 282d55c316fSYanan Wang 2 threads per core) for ARM virt machines which support sockets/clusters 283d55c316fSYanan Wang /cores/threads. Some members of the option can be omitted but their values 284d55c316fSYanan Wang will be automatically computed: 285d55c316fSYanan Wang 286d55c316fSYanan Wang :: 287d55c316fSYanan Wang 288d55c316fSYanan Wang -smp 16,sockets=2,clusters=2,cores=2,threads=2,maxcpus=16 289d55c316fSYanan Wang 290c2511b16SYanan Wang Historically preference was given to the coarsest topology parameters 291c2511b16SYanan Wang when computing missing values (ie sockets preferred over cores, which 292c2511b16SYanan Wang were preferred over threads), however, this behaviour is considered 2934a0af293SYanan Wang liable to change. Prior to 6.2 the preference was sockets over cores 2944a0af293SYanan Wang over threads. Since 6.2 the preference is cores over sockets over threads. 2950d871785SYanan Wang 2960d871785SYanan Wang For example, the following option defines a machine board with 2 sockets 2970d871785SYanan Wang of 1 core before 6.2 and 1 socket of 2 cores after 6.2: 2980d871785SYanan Wang 2990d871785SYanan Wang :: 3000d871785SYanan Wang 3010d871785SYanan Wang -smp 2 302e2fcbf42SPeter MaydellERST 3035824d651Sblueswir1 304268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 305244b3f44STao Xu "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 306244b3f44STao Xu "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 3072d19c656SIgor Mammedov "-numa dist,src=source,dst=destination,val=distance\n" 3089b12dfa0SLiu Jingqi "-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]\n" 309c412a48dSLiu 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" 310c412a48dSLiu Jingqi "-numa hmat-cache,node-id=node,size=size,level=level[,associativity=none|direct|complex][,policy=none|write-back|write-through][,line=size]\n", 3112d19c656SIgor Mammedov QEMU_ARCH_ALL) 312e2fcbf42SPeter MaydellSRST 31309ce5f2dSPeter Maydell``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 31409ce5f2dSPeter Maydell \ 31509ce5f2dSPeter Maydell``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 31609ce5f2dSPeter Maydell \ 31709ce5f2dSPeter Maydell``-numa dist,src=source,dst=destination,val=distance`` 31809ce5f2dSPeter Maydell \ 31909ce5f2dSPeter Maydell``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]`` 32009ce5f2dSPeter Maydell \ 32109ce5f2dSPeter Maydell``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]`` 32209ce5f2dSPeter Maydell \ 32309ce5f2dSPeter Maydell``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]`` 324e2fcbf42SPeter Maydell Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA 325e2fcbf42SPeter Maydell distance from a source node to a destination node. Set the ACPI 326e2fcbf42SPeter Maydell Heterogeneous Memory Attributes for the given nodes. 327e2fcbf42SPeter Maydell 328e2fcbf42SPeter Maydell Legacy VCPU assignment uses '\ ``cpus``\ ' option where firstcpu and 329e2fcbf42SPeter Maydell lastcpu are CPU indexes. Each '\ ``cpus``\ ' option represent a 330e2fcbf42SPeter Maydell contiguous range of CPU indexes (or a single VCPU if lastcpu is 331e2fcbf42SPeter Maydell omitted). A non-contiguous set of VCPUs can be represented by 332e2fcbf42SPeter Maydell providing multiple '\ ``cpus``\ ' options. If '\ ``cpus``\ ' is 333e2fcbf42SPeter Maydell omitted on all nodes, VCPUs are automatically split between them. 334e2fcbf42SPeter Maydell 335e2fcbf42SPeter Maydell For example, the following option assigns VCPUs 0, 1, 2 and 5 to a 336e2fcbf42SPeter Maydell NUMA node: 337e2fcbf42SPeter Maydell 338e2fcbf42SPeter Maydell :: 339e2fcbf42SPeter Maydell 340e2fcbf42SPeter Maydell -numa node,cpus=0-2,cpus=5 341e2fcbf42SPeter Maydell 342e2fcbf42SPeter Maydell '\ ``cpu``\ ' option is a new alternative to '\ ``cpus``\ ' option 343e2fcbf42SPeter Maydell which uses '\ ``socket-id|core-id|thread-id``\ ' properties to 344e2fcbf42SPeter Maydell assign CPU objects to a node using topology layout properties of 345e2fcbf42SPeter Maydell CPU. The set of properties is machine specific, and depends on used 346e2fcbf42SPeter Maydell machine type/'\ ``smp``\ ' options. It could be queried with 347e2fcbf42SPeter Maydell '\ ``hotpluggable-cpus``\ ' monitor command. '\ ``node-id``\ ' 348e2fcbf42SPeter Maydell property specifies node to which CPU object will be assigned, it's 349e2fcbf42SPeter Maydell required for node to be declared with '\ ``node``\ ' option before 350e2fcbf42SPeter Maydell it's used with '\ ``cpu``\ ' option. 351e2fcbf42SPeter Maydell 352e2fcbf42SPeter Maydell For example: 353e2fcbf42SPeter Maydell 354e2fcbf42SPeter Maydell :: 355e2fcbf42SPeter Maydell 356e2fcbf42SPeter Maydell -M pc \ 357e2fcbf42SPeter Maydell -smp 1,sockets=2,maxcpus=2 \ 358e2fcbf42SPeter Maydell -numa node,nodeid=0 -numa node,nodeid=1 \ 359e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 360e2fcbf42SPeter Maydell 36132a354dcSIgor Mammedov Legacy '\ ``mem``\ ' assigns a given RAM amount to a node (not supported 36232a354dcSIgor Mammedov for 5.1 and newer machine types). '\ ``memdev``\ ' assigns RAM from 36332a354dcSIgor Mammedov a given memory backend device to a node. If '\ ``mem``\ ' and 36432a354dcSIgor Mammedov '\ ``memdev``\ ' are omitted in all nodes, RAM is split equally between them. 36532a354dcSIgor Mammedov 366e2fcbf42SPeter Maydell 367e2fcbf42SPeter Maydell '\ ``mem``\ ' and '\ ``memdev``\ ' are mutually exclusive. 368e2fcbf42SPeter Maydell Furthermore, if one node uses '\ ``memdev``\ ', all of them have to 369e2fcbf42SPeter Maydell use it. 370e2fcbf42SPeter Maydell 371e2fcbf42SPeter Maydell '\ ``initiator``\ ' is an additional option that points to an 372e2fcbf42SPeter Maydell initiator NUMA node that has best performance (the lowest latency or 373e2fcbf42SPeter Maydell largest bandwidth) to this NUMA node. Note that this option can be 374e2fcbf42SPeter Maydell set only when the machine property 'hmat' is set to 'on'. 375e2fcbf42SPeter Maydell 376e2fcbf42SPeter Maydell Following example creates a machine with 2 NUMA nodes, node 0 has 377e2fcbf42SPeter Maydell CPU. node 1 has only memory, and its initiator is node 0. Note that 378e2fcbf42SPeter Maydell because node 0 has CPU, by default the initiator of node 0 is itself 379e2fcbf42SPeter Maydell and must be itself. 380e2fcbf42SPeter Maydell 381e2fcbf42SPeter Maydell :: 382e2fcbf42SPeter Maydell 383e2fcbf42SPeter Maydell -machine hmat=on \ 384e2fcbf42SPeter Maydell -m 2G,slots=2,maxmem=4G \ 385e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 386e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 387e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 388e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 389e2fcbf42SPeter Maydell -smp 2,sockets=2,maxcpus=2 \ 390e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 391e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 392e2fcbf42SPeter Maydell 393e2fcbf42SPeter Maydell source and destination are NUMA node IDs. distance is the NUMA 394e2fcbf42SPeter Maydell distance from source to destination. The distance from a node to 395e2fcbf42SPeter Maydell itself is always 10. If any pair of nodes is given a distance, then 396e2fcbf42SPeter Maydell all pairs must be given distances. Although, when distances are only 397e2fcbf42SPeter Maydell given in one direction for each pair of nodes, then the distances in 398e2fcbf42SPeter Maydell the opposite directions are assumed to be the same. If, however, an 399e2fcbf42SPeter Maydell asymmetrical pair of distances is given for even one node pair, then 400e2fcbf42SPeter Maydell all node pairs must be provided distance values for both directions, 401e2fcbf42SPeter Maydell even when they are symmetrical. When a node is unreachable from 402e2fcbf42SPeter Maydell another node, set the pair's distance to 255. 403e2fcbf42SPeter Maydell 404e2fcbf42SPeter Maydell Note that the -``numa`` option doesn't allocate any of the specified 405e2fcbf42SPeter Maydell resources, it just assigns existing resources to NUMA nodes. This 406e2fcbf42SPeter Maydell means that one still has to use the ``-m``, ``-smp`` options to 407e2fcbf42SPeter Maydell allocate RAM and VCPUs respectively. 408e2fcbf42SPeter Maydell 409e2fcbf42SPeter Maydell Use '\ ``hmat-lb``\ ' to set System Locality Latency and Bandwidth 410e2fcbf42SPeter Maydell Information between initiator and target NUMA nodes in ACPI 411e2fcbf42SPeter Maydell Heterogeneous Attribute Memory Table (HMAT). Initiator NUMA node can 412e2fcbf42SPeter Maydell create memory requests, usually it has one or more processors. 413e2fcbf42SPeter Maydell Target NUMA node contains addressable memory. 414e2fcbf42SPeter Maydell 415e2fcbf42SPeter Maydell In '\ ``hmat-lb``\ ' option, node are NUMA node IDs. hierarchy is 416e2fcbf42SPeter Maydell the memory hierarchy of the target NUMA node: if hierarchy is 417e2fcbf42SPeter Maydell 'memory', the structure represents the memory performance; if 418e2fcbf42SPeter Maydell hierarchy is 'first-level\|second-level\|third-level', this 419e2fcbf42SPeter Maydell structure represents aggregated performance of memory side caches 420e2fcbf42SPeter Maydell for each domain. type of 'data-type' is type of data represented by 421e2fcbf42SPeter Maydell this structure instance: if 'hierarchy' is 'memory', 'data-type' is 422e2fcbf42SPeter Maydell 'access\|read\|write' latency or 'access\|read\|write' bandwidth of 423e2fcbf42SPeter Maydell the target memory; if 'hierarchy' is 424e2fcbf42SPeter Maydell 'first-level\|second-level\|third-level', 'data-type' is 425e2fcbf42SPeter Maydell 'access\|read\|write' hit latency or 'access\|read\|write' hit 426e2fcbf42SPeter Maydell bandwidth of the target memory side cache. 427e2fcbf42SPeter Maydell 428e2fcbf42SPeter Maydell lat is latency value in nanoseconds. bw is bandwidth value, the 429e2fcbf42SPeter Maydell possible value and units are NUM[M\|G\|T], mean that the bandwidth 430e2fcbf42SPeter Maydell value are NUM byte per second (or MB/s, GB/s or TB/s depending on 431e2fcbf42SPeter Maydell used suffix). Note that if latency or bandwidth value is 0, means 432e2fcbf42SPeter Maydell the corresponding latency or bandwidth information is not provided. 433e2fcbf42SPeter Maydell 434e2fcbf42SPeter Maydell In '\ ``hmat-cache``\ ' option, node-id is the NUMA-id of the memory 435e2fcbf42SPeter Maydell belongs. size is the size of memory side cache in bytes. level is 436e2fcbf42SPeter Maydell the cache level described in this structure, note that the cache 437e2fcbf42SPeter Maydell level 0 should not be used with '\ ``hmat-cache``\ ' option. 438e2fcbf42SPeter Maydell associativity is the cache associativity, the possible value is 439e2fcbf42SPeter Maydell 'none/direct(direct-mapped)/complex(complex cache indexing)'. policy 440e2fcbf42SPeter Maydell is the write policy. line is the cache Line size in bytes. 441e2fcbf42SPeter Maydell 442e2fcbf42SPeter Maydell For example, the following options describe 2 NUMA nodes. Node 0 has 443e2fcbf42SPeter Maydell 2 cpus and a ram, node 1 has only a ram. The processors in node 0 444e2fcbf42SPeter Maydell access memory in node 0 with access-latency 5 nanoseconds, 445e2fcbf42SPeter Maydell access-bandwidth is 200 MB/s; The processors in NUMA node 0 access 446e2fcbf42SPeter Maydell memory in NUMA node 1 with access-latency 10 nanoseconds, 447e2fcbf42SPeter Maydell access-bandwidth is 100 MB/s. And for memory side cache information, 448e2fcbf42SPeter Maydell NUMA node 0 and 1 both have 1 level memory cache, size is 10KB, 449e2fcbf42SPeter Maydell policy is write-back, the cache Line size is 8 bytes: 450e2fcbf42SPeter Maydell 451e2fcbf42SPeter Maydell :: 452e2fcbf42SPeter Maydell 453e2fcbf42SPeter Maydell -machine hmat=on \ 454e2fcbf42SPeter Maydell -m 2G \ 455e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 456e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 457848dd269SYanan Wang -smp 2,sockets=2,maxcpus=2 \ 458e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 459e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 460e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 461e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 \ 462e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-latency,latency=5 \ 463e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-bandwidth,bandwidth=200M \ 464e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-latency,latency=10 \ 465e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-bandwidth,bandwidth=100M \ 466e2fcbf42SPeter Maydell -numa hmat-cache,node-id=0,size=10K,level=1,associativity=direct,policy=write-back,line=8 \ 467e2fcbf42SPeter Maydell -numa hmat-cache,node-id=1,size=10K,level=1,associativity=direct,policy=write-back,line=8 468e2fcbf42SPeter MaydellERST 469268a362cSaliguori 47010adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 47110adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 47210adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 473e2fcbf42SPeter MaydellSRST 474e2fcbf42SPeter Maydell``-add-fd fd=fd,set=set[,opaque=opaque]`` 475e2fcbf42SPeter Maydell Add a file descriptor to an fd set. Valid options are: 476e2fcbf42SPeter Maydell 477e2fcbf42SPeter Maydell ``fd=fd`` 478e2fcbf42SPeter Maydell This option defines the file descriptor of which a duplicate is 479e2fcbf42SPeter Maydell added to fd set. The file descriptor cannot be stdin, stdout, or 480e2fcbf42SPeter Maydell stderr. 481e2fcbf42SPeter Maydell 482e2fcbf42SPeter Maydell ``set=set`` 483e2fcbf42SPeter Maydell This option defines the ID of the fd set to add the file 484e2fcbf42SPeter Maydell descriptor to. 485e2fcbf42SPeter Maydell 486e2fcbf42SPeter Maydell ``opaque=opaque`` 487e2fcbf42SPeter Maydell This option defines a free-form string that can be used to 488e2fcbf42SPeter Maydell describe fd. 489e2fcbf42SPeter Maydell 490e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 491e2fcbf42SPeter Maydell set: 492e2fcbf42SPeter Maydell 493e2fcbf42SPeter Maydell .. parsed-literal:: 494e2fcbf42SPeter Maydell 495353a06b4SLaszlo Ersek |qemu_system| \\ 496353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 497353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 498e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 499e2fcbf42SPeter MaydellERST 50010adb8beSMarkus Armbruster 50110adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 50210adb8beSMarkus Armbruster "-set group.id.arg=value\n" 50310adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 50410adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 505e2fcbf42SPeter MaydellSRST 506e2fcbf42SPeter Maydell``-set group.id.arg=value`` 507e2fcbf42SPeter Maydell Set parameter arg for item id of type group 508e2fcbf42SPeter MaydellERST 50910adb8beSMarkus Armbruster 51010adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 5113751d7c4SPaolo Bonzini "-global driver.property=value\n" 5123751d7c4SPaolo Bonzini "-global driver=driver,property=property,value=value\n" 51310adb8beSMarkus Armbruster " set a global default for a driver property\n", 51410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 515e2fcbf42SPeter MaydellSRST 51609ce5f2dSPeter Maydell``-global driver.prop=value`` 51709ce5f2dSPeter Maydell \ 51809ce5f2dSPeter Maydell``-global driver=driver,property=property,value=value`` 519e2fcbf42SPeter Maydell Set default value of driver's property prop to value, e.g.: 520e2fcbf42SPeter Maydell 521e2fcbf42SPeter Maydell .. parsed-literal:: 522e2fcbf42SPeter Maydell 523e2fcbf42SPeter Maydell |qemu_system_x86| -global ide-hd.physical_block_size=4096 disk-image.img 524e2fcbf42SPeter Maydell 525e2fcbf42SPeter Maydell In particular, you can use this to set driver properties for devices 526e2fcbf42SPeter Maydell which are created automatically by the machine model. To create a 527e2fcbf42SPeter Maydell device which is not created automatically and set properties on it, 528e2fcbf42SPeter Maydell use -``device``. 529e2fcbf42SPeter Maydell 530e2fcbf42SPeter Maydell -global driver.prop=value is shorthand for -global 531e2fcbf42SPeter Maydell driver=driver,property=prop,value=value. The longhand syntax works 532e2fcbf42SPeter Maydell even when driver contains a dot. 533e2fcbf42SPeter MaydellERST 53410adb8beSMarkus Armbruster 53510adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 53610adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 537c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 53810adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 53910adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 54010adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 54110adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 54210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 543e2fcbf42SPeter MaydellSRST 544e2fcbf42SPeter Maydell``-boot [order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_timeout][,strict=on|off]`` 545e2fcbf42SPeter Maydell Specify boot order drives as a string of drive letters. Valid drive 546e2fcbf42SPeter Maydell letters depend on the target architecture. The x86 PC uses: a, b 547e2fcbf42SPeter Maydell (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p 548e2fcbf42SPeter Maydell (Etherboot from network adapter 1-4), hard disk boot is the default. 549e2fcbf42SPeter Maydell To apply a particular boot order only on the first startup, specify 550e2fcbf42SPeter Maydell it via ``once``. Note that the ``order`` or ``once`` parameter 551e2fcbf42SPeter Maydell should not be used together with the ``bootindex`` property of 552e2fcbf42SPeter Maydell devices, since the firmware implementations normally do not support 553e2fcbf42SPeter Maydell both at the same time. 554e2fcbf42SPeter Maydell 555e2fcbf42SPeter Maydell Interactive boot menus/prompts can be enabled via ``menu=on`` as far 556e2fcbf42SPeter Maydell as firmware/BIOS supports them. The default is non-interactive boot. 557e2fcbf42SPeter Maydell 558e2fcbf42SPeter Maydell A splash picture could be passed to bios, enabling user to show it 559e2fcbf42SPeter Maydell as logo, when option splash=sp\_name is given and menu=on, If 560e2fcbf42SPeter Maydell firmware/BIOS supports them. Currently Seabios for X86 system 561e2fcbf42SPeter Maydell support it. limitation: The splash file could be a jpeg file or a 562e2fcbf42SPeter Maydell BMP file in 24 BPP format(true color). The resolution should be 563e2fcbf42SPeter Maydell supported by the SVGA mode, so the recommended is 320x240, 640x480, 564e2fcbf42SPeter Maydell 800x640. 565e2fcbf42SPeter Maydell 566e2fcbf42SPeter Maydell A timeout could be passed to bios, guest will pause for rb\_timeout 567e2fcbf42SPeter Maydell ms when boot failed, then reboot. If rb\_timeout is '-1', guest will 568e2fcbf42SPeter Maydell not reboot, qemu passes '-1' to bios by default. Currently Seabios 569e2fcbf42SPeter Maydell for X86 system support it. 570e2fcbf42SPeter Maydell 571e2fcbf42SPeter Maydell Do strict boot via ``strict=on`` as far as firmware/BIOS supports 572e2fcbf42SPeter Maydell it. This only effects when boot priority is changed by bootindex 573e2fcbf42SPeter Maydell options. The default is non-strict boot. 574e2fcbf42SPeter Maydell 57509ce5f2dSPeter Maydell .. parsed-literal:: 576e2fcbf42SPeter Maydell 577e2fcbf42SPeter Maydell # try to boot from network first, then from hard disk 578e2fcbf42SPeter Maydell |qemu_system_x86| -boot order=nc 579e2fcbf42SPeter Maydell # boot from CD-ROM first, switch back to default order after reboot 580e2fcbf42SPeter Maydell |qemu_system_x86| -boot once=d 581e2fcbf42SPeter Maydell # boot with a splash picture for 5 seconds. 582e2fcbf42SPeter Maydell |qemu_system_x86| -boot menu=on,splash=/root/boot.bmp,splash-time=5000 583e2fcbf42SPeter Maydell 584e2fcbf42SPeter Maydell Note: The legacy format '-boot drives' is still supported but its 585e2fcbf42SPeter Maydell use is discouraged as it may be removed from future versions. 586e2fcbf42SPeter MaydellERST 58710adb8beSMarkus Armbruster 58810adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 58989f3ea2bSMichael Tokarev "-m [size=]megs[,slots=n,maxmem=size]\n" 5906e1d3c1cSIgor Mammedov " configure guest RAM\n" 5910daba1f0SAlexander Graf " size: initial amount of guest memory\n" 592c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 593b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 594b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 5956e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 596e2fcbf42SPeter MaydellSRST 597e2fcbf42SPeter Maydell``-m [size=]megs[,slots=n,maxmem=size]`` 598e2fcbf42SPeter Maydell Sets guest startup RAM size to megs megabytes. Default is 128 MiB. 599e2fcbf42SPeter Maydell Optionally, a suffix of "M" or "G" can be used to signify a value in 600e2fcbf42SPeter Maydell megabytes or gigabytes respectively. Optional pair slots, maxmem 601e2fcbf42SPeter Maydell could be used to set amount of hotpluggable memory slots and maximum 602e2fcbf42SPeter Maydell amount of memory. Note that maxmem must be aligned to the page size. 603e2fcbf42SPeter Maydell 604e2fcbf42SPeter Maydell For example, the following command-line sets the guest startup RAM 605e2fcbf42SPeter Maydell size to 1GB, creates 3 slots to hotplug additional memory and sets 606e2fcbf42SPeter Maydell the maximum memory the guest can reach to 4GB: 607e2fcbf42SPeter Maydell 608e2fcbf42SPeter Maydell .. parsed-literal:: 609e2fcbf42SPeter Maydell 610e2fcbf42SPeter Maydell |qemu_system| -m 1G,slots=3,maxmem=4G 611e2fcbf42SPeter Maydell 612e2fcbf42SPeter Maydell If slots and maxmem are not specified, memory hotplug won't be 613e2fcbf42SPeter Maydell enabled and the guest startup RAM will never increase. 614e2fcbf42SPeter MaydellERST 61510adb8beSMarkus Armbruster 61610adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 61710adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 618e2fcbf42SPeter MaydellSRST 619e2fcbf42SPeter Maydell``-mem-path path`` 620e2fcbf42SPeter Maydell Allocate guest RAM from a temporarily created file in path. 621e2fcbf42SPeter MaydellERST 62210adb8beSMarkus Armbruster 62310adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 62410adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 62510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 626e2fcbf42SPeter MaydellSRST 627e2fcbf42SPeter Maydell``-mem-prealloc`` 628e2fcbf42SPeter Maydell Preallocate memory when using -mem-path. 629e2fcbf42SPeter MaydellERST 63010adb8beSMarkus Armbruster 63110adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 63210adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 63310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 634e2fcbf42SPeter MaydellSRST 635e2fcbf42SPeter Maydell``-k language`` 636e2fcbf42SPeter Maydell Use keyboard layout language (for example ``fr`` for French). This 637e2fcbf42SPeter Maydell option is only needed where it is not easy to get raw PC keycodes 638e2fcbf42SPeter Maydell (e.g. on Macs, with some X11 servers or with a VNC or curses 639e2fcbf42SPeter Maydell display). You don't normally need to use it on PC/Linux or 640e2fcbf42SPeter Maydell PC/Windows hosts. 641e2fcbf42SPeter Maydell 642e2fcbf42SPeter Maydell The available layouts are: 643e2fcbf42SPeter Maydell 644e2fcbf42SPeter Maydell :: 645e2fcbf42SPeter Maydell 646e2fcbf42SPeter Maydell ar de-ch es fo fr-ca hu ja mk no pt-br sv 647e2fcbf42SPeter Maydell da en-gb et fr fr-ch is lt nl pl ru th 648e2fcbf42SPeter Maydell de en-us fi fr-be hr it lv nl-be pt sl tr 649e2fcbf42SPeter Maydell 650e2fcbf42SPeter Maydell The default is ``en-us``. 651e2fcbf42SPeter MaydellERST 65210adb8beSMarkus Armbruster 65310adb8beSMarkus Armbruster 654f0b3d811SKővágó, ZoltánHXCOMM Deprecated by -audiodev 65510adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 656f0b3d811SKővágó, Zoltán "-audio-help show -audiodev equivalent of the currently specified audio settings\n", 65710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 658e2fcbf42SPeter MaydellSRST 659e2fcbf42SPeter Maydell``-audio-help`` 660e2fcbf42SPeter Maydell Will show the -audiodev equivalent of the currently specified 661e2fcbf42SPeter Maydell (deprecated) environment variables. 662e2fcbf42SPeter MaydellERST 663f0b3d811SKővágó, Zoltán 664*039a6837SPaolo BonziniDEF("audio", HAS_ARG, QEMU_OPTION_audio, 665*039a6837SPaolo Bonzini "-audio [driver=]driver,model=value[,prop[=value][,...]]\n" 666*039a6837SPaolo Bonzini " specifies the audio backend and device to use;\n" 667*039a6837SPaolo Bonzini " apart from 'model', options are the same as for -audiodev.\n" 668*039a6837SPaolo Bonzini " use '-audio model=help' to show possible devices.\n", 669*039a6837SPaolo Bonzini QEMU_ARCH_ALL) 670*039a6837SPaolo BonziniSRST 671*039a6837SPaolo Bonzini``-audio [driver=]driver,model=value[,prop[=value][,...]]`` 672*039a6837SPaolo Bonzini This option is a shortcut for configuring both the guest audio 673*039a6837SPaolo Bonzini hardware and the host audio backend in one go. 674*039a6837SPaolo Bonzini The host backend options are the same as with the corresponding 675*039a6837SPaolo Bonzini ``-audiodev`` options below. The guest hardware model can be set with 676*039a6837SPaolo Bonzini ``model=modelname``. Use ``model=help`` to list the available device 677*039a6837SPaolo Bonzini types. 678*039a6837SPaolo Bonzini 679*039a6837SPaolo Bonzini The following two example do exactly the same, to show how ``-audio`` 680*039a6837SPaolo Bonzini can be used to shorten the command line length: 681*039a6837SPaolo Bonzini 682*039a6837SPaolo Bonzini .. parsed-literal:: 683*039a6837SPaolo Bonzini 684*039a6837SPaolo Bonzini |qemu_system| -audiodev pa,id=pa -device sb16,audiodev=pa 685*039a6837SPaolo Bonzini |qemu_system| -audio pa,model=sb16 686*039a6837SPaolo BonziniERST 687*039a6837SPaolo Bonzini 688f0b3d811SKővágó, ZoltánDEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev, 689f0b3d811SKővágó, Zoltán "-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n" 690f0b3d811SKővágó, Zoltán " specifies the audio backend to use\n" 691f0b3d811SKővágó, Zoltán " id= identifier of the backend\n" 692f0b3d811SKővágó, Zoltán " timer-period= timer period in microseconds\n" 6938efac073SKővágó, Zoltán " in|out.mixing-engine= use mixing engine to mix streams inside QEMU\n" 694f0b3d811SKővágó, Zoltán " in|out.fixed-settings= use fixed settings for host audio\n" 695f0b3d811SKővágó, Zoltán " in|out.frequency= frequency to use with fixed settings\n" 696f0b3d811SKővágó, Zoltán " in|out.channels= number of channels to use with fixed settings\n" 697f0b3d811SKővágó, Zoltán " in|out.format= sample format to use with fixed settings\n" 69849f77e6fSVolker Rümelin " valid values: s8, s16, s32, u8, u16, u32, f32\n" 699f0b3d811SKővágó, Zoltán " in|out.voices= number of voices to use\n" 7008624725bSStefan Hajnoczi " in|out.buffer-length= length of buffer in microseconds\n" 701f0b3d811SKővágó, Zoltán "-audiodev none,id=id,[,prop[=value][,...]]\n" 702f0b3d811SKővágó, Zoltán " dummy driver that discards all output\n" 703f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_ALSA 704f0b3d811SKővágó, Zoltán "-audiodev alsa,id=id[,prop[=value][,...]]\n" 705f0b3d811SKővágó, Zoltán " in|out.dev= name of the audio device to use\n" 706dfc54343SStefan Hajnoczi " in|out.period-length= length of period in microseconds\n" 707f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 708f0b3d811SKővágó, Zoltán " threshold= threshold (in microseconds) when playback starts\n" 709f0b3d811SKővágó, Zoltán#endif 710f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_COREAUDIO 711f0b3d811SKővágó, Zoltán "-audiodev coreaudio,id=id[,prop[=value][,...]]\n" 712f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 713f0b3d811SKővágó, Zoltán#endif 714f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_DSOUND 715f0b3d811SKővágó, Zoltán "-audiodev dsound,id=id[,prop[=value][,...]]\n" 716f0b3d811SKővágó, Zoltán " latency= add extra latency to playback in microseconds\n" 717f0b3d811SKővágó, Zoltán#endif 718f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_OSS 719f0b3d811SKővágó, Zoltán "-audiodev oss,id=id[,prop[=value][,...]]\n" 720f0b3d811SKővágó, Zoltán " in|out.dev= path of the audio device to use\n" 721f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 722f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 723f0b3d811SKővágó, Zoltán " try-mmap= try using memory mapped access\n" 724f0b3d811SKővágó, Zoltán " exclusive= open device in exclusive mode\n" 725f0b3d811SKővágó, Zoltán " dsp-policy= set timing policy (0..10), -1 to use fragment mode\n" 726f0b3d811SKővágó, Zoltán#endif 727f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_PA 728f0b3d811SKővágó, Zoltán "-audiodev pa,id=id[,prop[=value][,...]]\n" 729f0b3d811SKővágó, Zoltán " server= PulseAudio server address\n" 730f0b3d811SKővágó, Zoltán " in|out.name= source/sink device name\n" 73114d4f011SStefan Hajnoczi " in|out.latency= desired latency in microseconds\n" 732f0b3d811SKővágó, Zoltán#endif 733f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_SDL 734f0b3d811SKővágó, Zoltán "-audiodev sdl,id=id[,prop[=value][,...]]\n" 7355a0926c2SVolker Rümelin " in|out.buffer-count= number of buffers\n" 736f0b3d811SKővágó, Zoltán#endif 737f0b3d811SKővágó, Zoltán#ifdef CONFIG_SPICE 738f0b3d811SKővágó, Zoltán "-audiodev spice,id=id[,prop[=value][,...]]\n" 739f0b3d811SKővágó, Zoltán#endif 740739362d4SMarc-André Lureau#ifdef CONFIG_DBUS_DISPLAY 741739362d4SMarc-André Lureau "-audiodev dbus,id=id[,prop[=value][,...]]\n" 742739362d4SMarc-André Lureau#endif 743f0b3d811SKővágó, Zoltán "-audiodev wav,id=id[,prop[=value][,...]]\n" 744f0b3d811SKővágó, Zoltán " path= path of wav file to record\n", 745f0b3d811SKővágó, Zoltán QEMU_ARCH_ALL) 746e2fcbf42SPeter MaydellSRST 747e2fcbf42SPeter Maydell``-audiodev [driver=]driver,id=id[,prop[=value][,...]]`` 748e2fcbf42SPeter Maydell Adds a new audio backend driver identified by id. There are global 749e2fcbf42SPeter Maydell and driver specific properties. Some values can be set differently 750e2fcbf42SPeter Maydell for input and output, they're marked with ``in|out.``. You can set 751e2fcbf42SPeter Maydell the input's property with ``in.prop`` and the output's property with 752e2fcbf42SPeter Maydell ``out.prop``. For example: 753e2fcbf42SPeter Maydell 754e2fcbf42SPeter Maydell :: 755e2fcbf42SPeter Maydell 756e2fcbf42SPeter Maydell -audiodev alsa,id=example,in.frequency=44110,out.frequency=8000 757e2fcbf42SPeter Maydell -audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified 758e2fcbf42SPeter Maydell 759e2fcbf42SPeter Maydell NOTE: parameter validation is known to be incomplete, in many cases 760e2fcbf42SPeter Maydell specifying an invalid option causes QEMU to print an error message 761e2fcbf42SPeter Maydell and continue emulation without sound. 762e2fcbf42SPeter Maydell 763e2fcbf42SPeter Maydell Valid global options are: 764e2fcbf42SPeter Maydell 765e2fcbf42SPeter Maydell ``id=identifier`` 766e2fcbf42SPeter Maydell Identifies the audio backend. 767e2fcbf42SPeter Maydell 768e2fcbf42SPeter Maydell ``timer-period=period`` 769e2fcbf42SPeter Maydell Sets the timer period used by the audio subsystem in 770e2fcbf42SPeter Maydell microseconds. Default is 10000 (10 ms). 771e2fcbf42SPeter Maydell 772e2fcbf42SPeter Maydell ``in|out.mixing-engine=on|off`` 773e2fcbf42SPeter Maydell Use QEMU's mixing engine to mix all streams inside QEMU and 774e2fcbf42SPeter Maydell convert audio formats when not supported by the backend. When 775e2fcbf42SPeter Maydell off, fixed-settings must be off too. Note that disabling this 776e2fcbf42SPeter Maydell option means that the selected backend must support multiple 777e2fcbf42SPeter Maydell streams and the audio formats used by the virtual cards, 778e2fcbf42SPeter Maydell otherwise you'll get no sound. It's not recommended to disable 779e2fcbf42SPeter Maydell this option unless you want to use 5.1 or 7.1 audio, as mixing 780e2fcbf42SPeter Maydell engine only supports mono and stereo audio. Default is on. 781e2fcbf42SPeter Maydell 782e2fcbf42SPeter Maydell ``in|out.fixed-settings=on|off`` 783e2fcbf42SPeter Maydell Use fixed settings for host audio. When off, it will change 784e2fcbf42SPeter Maydell based on how the guest opens the sound card. In this case you 785e2fcbf42SPeter Maydell must not specify frequency, channels or format. Default is on. 786e2fcbf42SPeter Maydell 787e2fcbf42SPeter Maydell ``in|out.frequency=frequency`` 788e2fcbf42SPeter Maydell Specify the frequency to use when using fixed-settings. Default 789e2fcbf42SPeter Maydell is 44100Hz. 790e2fcbf42SPeter Maydell 791e2fcbf42SPeter Maydell ``in|out.channels=channels`` 792e2fcbf42SPeter Maydell Specify the number of channels to use when using fixed-settings. 793e2fcbf42SPeter Maydell Default is 2 (stereo). 794e2fcbf42SPeter Maydell 795e2fcbf42SPeter Maydell ``in|out.format=format`` 796e2fcbf42SPeter Maydell Specify the sample format to use when using fixed-settings. 797e2fcbf42SPeter Maydell Valid values are: ``s8``, ``s16``, ``s32``, ``u8``, ``u16``, 79849f77e6fSVolker Rümelin ``u32``, ``f32``. Default is ``s16``. 799e2fcbf42SPeter Maydell 800e2fcbf42SPeter Maydell ``in|out.voices=voices`` 801e2fcbf42SPeter Maydell Specify the number of voices to use. Default is 1. 802e2fcbf42SPeter Maydell 803e2fcbf42SPeter Maydell ``in|out.buffer-length=usecs`` 804e2fcbf42SPeter Maydell Sets the size of the buffer in microseconds. 805e2fcbf42SPeter Maydell 806e2fcbf42SPeter Maydell``-audiodev none,id=id[,prop[=value][,...]]`` 807e2fcbf42SPeter Maydell Creates a dummy backend that discards all outputs. This backend has 808e2fcbf42SPeter Maydell no backend specific properties. 809e2fcbf42SPeter Maydell 810e2fcbf42SPeter Maydell``-audiodev alsa,id=id[,prop[=value][,...]]`` 811e2fcbf42SPeter Maydell Creates backend using the ALSA. This backend is only available on 812e2fcbf42SPeter Maydell Linux. 813e2fcbf42SPeter Maydell 814e2fcbf42SPeter Maydell ALSA specific options are: 815e2fcbf42SPeter Maydell 816e2fcbf42SPeter Maydell ``in|out.dev=device`` 817e2fcbf42SPeter Maydell Specify the ALSA device to use for input and/or output. Default 818e2fcbf42SPeter Maydell is ``default``. 819e2fcbf42SPeter Maydell 820e2fcbf42SPeter Maydell ``in|out.period-length=usecs`` 821e2fcbf42SPeter Maydell Sets the period length in microseconds. 822e2fcbf42SPeter Maydell 823e2fcbf42SPeter Maydell ``in|out.try-poll=on|off`` 824e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 825e2fcbf42SPeter Maydell 826e2fcbf42SPeter Maydell ``threshold=threshold`` 827e2fcbf42SPeter Maydell Threshold (in microseconds) when playback starts. Default is 0. 828e2fcbf42SPeter Maydell 829e2fcbf42SPeter Maydell``-audiodev coreaudio,id=id[,prop[=value][,...]]`` 830e2fcbf42SPeter Maydell Creates a backend using Apple's Core Audio. This backend is only 831e2fcbf42SPeter Maydell available on Mac OS and only supports playback. 832e2fcbf42SPeter Maydell 833e2fcbf42SPeter Maydell Core Audio specific options are: 834e2fcbf42SPeter Maydell 835e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 836e2fcbf42SPeter Maydell Sets the count of the buffers. 837e2fcbf42SPeter Maydell 838e2fcbf42SPeter Maydell``-audiodev dsound,id=id[,prop[=value][,...]]`` 839e2fcbf42SPeter Maydell Creates a backend using Microsoft's DirectSound. This backend is 840e2fcbf42SPeter Maydell only available on Windows and only supports playback. 841e2fcbf42SPeter Maydell 842e2fcbf42SPeter Maydell DirectSound specific options are: 843e2fcbf42SPeter Maydell 844e2fcbf42SPeter Maydell ``latency=usecs`` 845e2fcbf42SPeter Maydell Add extra usecs microseconds latency to playback. Default is 846e2fcbf42SPeter Maydell 10000 (10 ms). 847e2fcbf42SPeter Maydell 848e2fcbf42SPeter Maydell``-audiodev oss,id=id[,prop[=value][,...]]`` 849e2fcbf42SPeter Maydell Creates a backend using OSS. This backend is available on most 850e2fcbf42SPeter Maydell Unix-like systems. 851e2fcbf42SPeter Maydell 852e2fcbf42SPeter Maydell OSS specific options are: 853e2fcbf42SPeter Maydell 854e2fcbf42SPeter Maydell ``in|out.dev=device`` 855e2fcbf42SPeter Maydell Specify the file name of the OSS device to use. Default is 856e2fcbf42SPeter Maydell ``/dev/dsp``. 857e2fcbf42SPeter Maydell 858e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 859e2fcbf42SPeter Maydell Sets the count of the buffers. 860e2fcbf42SPeter Maydell 861e2fcbf42SPeter Maydell ``in|out.try-poll=on|of`` 862e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 863e2fcbf42SPeter Maydell 864e2fcbf42SPeter Maydell ``try-mmap=on|off`` 865e2fcbf42SPeter Maydell Try using memory mapped device access. Default is off. 866e2fcbf42SPeter Maydell 867e2fcbf42SPeter Maydell ``exclusive=on|off`` 868e2fcbf42SPeter Maydell Open the device in exclusive mode (vmix won't work in this 869e2fcbf42SPeter Maydell case). Default is off. 870e2fcbf42SPeter Maydell 871e2fcbf42SPeter Maydell ``dsp-policy=policy`` 872e2fcbf42SPeter Maydell Sets the timing policy (between 0 and 10, where smaller number 873e2fcbf42SPeter Maydell means smaller latency but higher CPU usage). Use -1 to use 874e2fcbf42SPeter Maydell buffer sizes specified by ``buffer`` and ``buffer-count``. This 875e2fcbf42SPeter Maydell option is ignored if you do not have OSS 4. Default is 5. 876e2fcbf42SPeter Maydell 877e2fcbf42SPeter Maydell``-audiodev pa,id=id[,prop[=value][,...]]`` 878e2fcbf42SPeter Maydell Creates a backend using PulseAudio. This backend is available on 879e2fcbf42SPeter Maydell most systems. 880e2fcbf42SPeter Maydell 881e2fcbf42SPeter Maydell PulseAudio specific options are: 882e2fcbf42SPeter Maydell 883e2fcbf42SPeter Maydell ``server=server`` 884e2fcbf42SPeter Maydell Sets the PulseAudio server to connect to. 885e2fcbf42SPeter Maydell 886e2fcbf42SPeter Maydell ``in|out.name=sink`` 887e2fcbf42SPeter Maydell Use the specified source/sink for recording/playback. 888e2fcbf42SPeter Maydell 889e2fcbf42SPeter Maydell ``in|out.latency=usecs`` 890e2fcbf42SPeter Maydell Desired latency in microseconds. The PulseAudio server will try 891e2fcbf42SPeter Maydell to honor this value but actual latencies may be lower or higher. 892e2fcbf42SPeter Maydell 893e2fcbf42SPeter Maydell``-audiodev sdl,id=id[,prop[=value][,...]]`` 894e2fcbf42SPeter Maydell Creates a backend using SDL. This backend is available on most 895e2fcbf42SPeter Maydell systems, but you should use your platform's native backend if 8965a0926c2SVolker Rümelin possible. 8975a0926c2SVolker Rümelin 8985a0926c2SVolker Rümelin SDL specific options are: 8995a0926c2SVolker Rümelin 9005a0926c2SVolker Rümelin ``in|out.buffer-count=count`` 9015a0926c2SVolker Rümelin Sets the count of the buffers. 902e2fcbf42SPeter Maydell 903e2fcbf42SPeter Maydell``-audiodev spice,id=id[,prop[=value][,...]]`` 904e2fcbf42SPeter Maydell Creates a backend that sends audio through SPICE. This backend 905e2fcbf42SPeter Maydell requires ``-spice`` and automatically selected in that case, so 906e2fcbf42SPeter Maydell usually you can ignore this option. This backend has no backend 907e2fcbf42SPeter Maydell specific properties. 908e2fcbf42SPeter Maydell 909e2fcbf42SPeter Maydell``-audiodev wav,id=id[,prop[=value][,...]]`` 910e2fcbf42SPeter Maydell Creates a backend that writes audio to a WAV file. 911e2fcbf42SPeter Maydell 912e2fcbf42SPeter Maydell Backend specific options are: 913e2fcbf42SPeter Maydell 914e2fcbf42SPeter Maydell ``path=path`` 915e2fcbf42SPeter Maydell Write recorded audio into the specified file. Default is 916e2fcbf42SPeter Maydell ``qemu.wav``. 917e2fcbf42SPeter MaydellERST 91810adb8beSMarkus Armbruster 91910adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 92010adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 92110adb8beSMarkus Armbruster " add device (based on driver)\n" 92210adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 92310adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 92410adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 92510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 926e2fcbf42SPeter MaydellSRST 927e2fcbf42SPeter Maydell``-device driver[,prop[=value][,...]]`` 928e2fcbf42SPeter Maydell Add device driver. prop=value sets driver properties. Valid 929e2fcbf42SPeter Maydell properties depend on the driver. To get help on possible drivers and 930e2fcbf42SPeter Maydell properties, use ``-device help`` and ``-device driver,help``. 931e2fcbf42SPeter Maydell 932e2fcbf42SPeter Maydell Some drivers are: 933e2fcbf42SPeter Maydell 934789101b7SCorey Minyard``-device ipmi-bmc-sim,id=id[,prop[=value][,...]]`` 935e2fcbf42SPeter Maydell Add an IPMI BMC. This is a simulation of a hardware management 936e2fcbf42SPeter Maydell interface processor that normally sits on a system. It provides a 937e2fcbf42SPeter Maydell watchdog and the ability to reset and power control the system. You 938e2fcbf42SPeter Maydell need to connect this to an IPMI interface to make it useful 939e2fcbf42SPeter Maydell 940e2fcbf42SPeter Maydell The IPMI slave address to use for the BMC. The default is 0x20. This 941e2fcbf42SPeter Maydell address is the BMC's address on the I2C network of management 942e2fcbf42SPeter Maydell controllers. If you don't know what this means, it is safe to ignore 943e2fcbf42SPeter Maydell it. 944e2fcbf42SPeter Maydell 945e2fcbf42SPeter Maydell ``id=id`` 946e2fcbf42SPeter Maydell The BMC id for interfaces to use this device. 947e2fcbf42SPeter Maydell 948e2fcbf42SPeter Maydell ``slave_addr=val`` 949e2fcbf42SPeter Maydell Define slave address to use for the BMC. The default is 0x20. 950e2fcbf42SPeter Maydell 951e2fcbf42SPeter Maydell ``sdrfile=file`` 952e2fcbf42SPeter Maydell file containing raw Sensor Data Records (SDR) data. The default 953e2fcbf42SPeter Maydell is none. 954e2fcbf42SPeter Maydell 955e2fcbf42SPeter Maydell ``fruareasize=val`` 956e2fcbf42SPeter Maydell size of a Field Replaceable Unit (FRU) area. The default is 957e2fcbf42SPeter Maydell 1024. 958e2fcbf42SPeter Maydell 959e2fcbf42SPeter Maydell ``frudatafile=file`` 960e2fcbf42SPeter Maydell file containing raw Field Replaceable Unit (FRU) inventory data. 961e2fcbf42SPeter Maydell The default is none. 962e2fcbf42SPeter Maydell 963e2fcbf42SPeter Maydell ``guid=uuid`` 964e2fcbf42SPeter Maydell value for the GUID for the BMC, in standard UUID format. If this 965e2fcbf42SPeter Maydell is set, get "Get GUID" command to the BMC will return it. 966e2fcbf42SPeter Maydell Otherwise "Get GUID" will return an error. 967e2fcbf42SPeter Maydell 968e2fcbf42SPeter Maydell``-device ipmi-bmc-extern,id=id,chardev=id[,slave_addr=val]`` 969e2fcbf42SPeter Maydell Add a connection to an external IPMI BMC simulator. Instead of 970e2fcbf42SPeter Maydell locally emulating the BMC like the above item, instead connect to an 971e2fcbf42SPeter Maydell external entity that provides the IPMI services. 972e2fcbf42SPeter Maydell 973e2fcbf42SPeter Maydell A connection is made to an external BMC simulator. If you do this, 974e2fcbf42SPeter Maydell it is strongly recommended that you use the "reconnect=" chardev 975e2fcbf42SPeter Maydell option to reconnect to the simulator if the connection is lost. Note 976e2fcbf42SPeter Maydell that if this is not used carefully, it can be a security issue, as 977e2fcbf42SPeter Maydell the interface has the ability to send resets, NMIs, and power off 978e2fcbf42SPeter Maydell the VM. It's best if QEMU makes a connection to an external 979e2fcbf42SPeter Maydell simulator running on a secure port on localhost, so neither the 980e2fcbf42SPeter Maydell simulator nor QEMU is exposed to any outside network. 981e2fcbf42SPeter Maydell 982e2fcbf42SPeter Maydell See the "lanserv/README.vm" file in the OpenIPMI library for more 983e2fcbf42SPeter Maydell details on the external interface. 984e2fcbf42SPeter Maydell 985e2fcbf42SPeter Maydell``-device isa-ipmi-kcs,bmc=id[,ioport=val][,irq=val]`` 986e2fcbf42SPeter Maydell Add a KCS IPMI interafce on the ISA bus. This also adds a 987e2fcbf42SPeter Maydell corresponding ACPI and SMBIOS entries, if appropriate. 988e2fcbf42SPeter Maydell 989e2fcbf42SPeter Maydell ``bmc=id`` 990e2fcbf42SPeter Maydell The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern 991e2fcbf42SPeter Maydell above. 992e2fcbf42SPeter Maydell 993e2fcbf42SPeter Maydell ``ioport=val`` 994e2fcbf42SPeter Maydell Define the I/O address of the interface. The default is 0xca0 995e2fcbf42SPeter Maydell for KCS. 996e2fcbf42SPeter Maydell 997e2fcbf42SPeter Maydell ``irq=val`` 998e2fcbf42SPeter Maydell Define the interrupt to use. The default is 5. To disable 999e2fcbf42SPeter Maydell interrupts, set this to 0. 1000e2fcbf42SPeter Maydell 1001e2fcbf42SPeter Maydell``-device isa-ipmi-bt,bmc=id[,ioport=val][,irq=val]`` 1002e2fcbf42SPeter Maydell Like the KCS interface, but defines a BT interface. The default port 1003e2fcbf42SPeter Maydell is 0xe4 and the default interrupt is 5. 1004323679daSCorey Minyard 1005323679daSCorey Minyard``-device pci-ipmi-kcs,bmc=id`` 1006323679daSCorey Minyard Add a KCS IPMI interafce on the PCI bus. 1007323679daSCorey Minyard 1008323679daSCorey Minyard ``bmc=id`` 1009323679daSCorey Minyard The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 1010323679daSCorey Minyard 1011323679daSCorey Minyard``-device pci-ipmi-bt,bmc=id`` 1012323679daSCorey Minyard Like the KCS interface, but defines a BT interface on the PCI bus. 10137395b3e3SPeter Xu 10147395b3e3SPeter Xu``-device intel-iommu[,option=...]`` 10157395b3e3SPeter Xu This is only supported by ``-machine q35``, which will enable Intel VT-d 10167395b3e3SPeter Xu emulation within the guest. It supports below options: 10177395b3e3SPeter Xu 10187395b3e3SPeter Xu ``intremap=on|off`` (default: auto) 10197395b3e3SPeter Xu This enables interrupt remapping feature. It's required to enable 10207395b3e3SPeter Xu complete x2apic. Currently it only supports kvm kernel-irqchip modes 10217395b3e3SPeter Xu ``off`` or ``split``, while full kernel-irqchip is not yet supported. 10227395b3e3SPeter Xu The default value is "auto", which will be decided by the mode of 10237395b3e3SPeter Xu kernel-irqchip. 10247395b3e3SPeter Xu 10257395b3e3SPeter Xu ``caching-mode=on|off`` (default: off) 10267395b3e3SPeter Xu This enables caching mode for the VT-d emulated device. When 10277395b3e3SPeter Xu caching-mode is enabled, each guest DMA buffer mapping will generate an 10287395b3e3SPeter Xu IOTLB invalidation from the guest IOMMU driver to the vIOMMU device in 10297395b3e3SPeter Xu a synchronous way. It is required for ``-device vfio-pci`` to work 10307395b3e3SPeter Xu with the VT-d device, because host assigned devices requires to setup 10317395b3e3SPeter Xu the DMA mapping on the host before guest DMA starts. 10327395b3e3SPeter Xu 10337395b3e3SPeter Xu ``device-iotlb=on|off`` (default: off) 10347395b3e3SPeter Xu This enables device-iotlb capability for the emulated VT-d device. So 10357395b3e3SPeter Xu far virtio/vhost should be the only real user for this parameter, 10367395b3e3SPeter Xu paired with ats=on configured for the device. 10377395b3e3SPeter Xu 10387395b3e3SPeter Xu ``aw-bits=39|48`` (default: 39) 10397395b3e3SPeter Xu This decides the address width of IOVA address space. The address 10407395b3e3SPeter Xu space has 39 bits width for 3-level IOMMU page tables, and 48 bits for 10417395b3e3SPeter Xu 4-level IOMMU page tables. 10427395b3e3SPeter Xu 10437395b3e3SPeter Xu Please also refer to the wiki page for general scenarios of VT-d 10447395b3e3SPeter Xu emulation in QEMU: https://wiki.qemu.org/Features/VT-d. 10457395b3e3SPeter Xu 1046e2fcbf42SPeter MaydellERST 104710adb8beSMarkus Armbruster 104810adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 10498f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 105010adb8beSMarkus Armbruster " set the name of the guest\n" 1051479a5747SRoman Bolshakov " string1 sets the window title and string2 the process name\n" 1052479a5747SRoman Bolshakov " When debug-threads is enabled, individual threads are given a separate name\n" 10538f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 105410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1055e2fcbf42SPeter MaydellSRST 1056e2fcbf42SPeter Maydell``-name name`` 1057e2fcbf42SPeter Maydell Sets the name of the guest. This name will be displayed in the SDL 1058e2fcbf42SPeter Maydell window caption. The name will also be used for the VNC server. Also 1059e2fcbf42SPeter Maydell optionally set the top visible process name in Linux. Naming of 1060e2fcbf42SPeter Maydell individual threads can also be enabled on Linux to aid debugging. 1061e2fcbf42SPeter MaydellERST 106210adb8beSMarkus Armbruster 106310adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 106410adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 106510adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 1066e2fcbf42SPeter MaydellSRST 1067e2fcbf42SPeter Maydell``-uuid uuid`` 1068e2fcbf42SPeter Maydell Set system UUID. 1069e2fcbf42SPeter MaydellERST 107010adb8beSMarkus Armbruster 107110adb8beSMarkus ArmbrusterDEFHEADING() 107210adb8beSMarkus Armbruster 1073de6b4f90SMarkus ArmbrusterDEFHEADING(Block device options:) 107410adb8beSMarkus Armbruster 10755824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 1076ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 1077ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 1078e2fcbf42SPeter MaydellSRST 107909ce5f2dSPeter Maydell``-fda file`` 108009ce5f2dSPeter Maydell \ 108109ce5f2dSPeter Maydell``-fdb file`` 1082923e9311SThomas Huth Use file as floppy disk 0/1 image (see the :ref:`disk images` chapter in 1083923e9311SThomas Huth the System Emulation Users Guide). 1084e2fcbf42SPeter MaydellERST 10855824d651Sblueswir1 10865824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 1087ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 1088ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 10895824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 1090ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 1091ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 1092e2fcbf42SPeter MaydellSRST 109309ce5f2dSPeter Maydell``-hda file`` 109409ce5f2dSPeter Maydell \ 109509ce5f2dSPeter Maydell``-hdb file`` 109609ce5f2dSPeter Maydell \ 109709ce5f2dSPeter Maydell``-hdc file`` 109809ce5f2dSPeter Maydell \ 109909ce5f2dSPeter Maydell``-hdd file`` 1100923e9311SThomas Huth Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` 1101923e9311SThomas Huth chapter in the System Emulation Users Guide). 1102e2fcbf42SPeter MaydellERST 11035824d651Sblueswir1 11045824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 1105ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 1106ad96090aSBlue Swirl QEMU_ARCH_ALL) 1107e2fcbf42SPeter MaydellSRST 1108e2fcbf42SPeter Maydell``-cdrom file`` 1109e2fcbf42SPeter Maydell Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at 1110e2fcbf42SPeter Maydell the same time). You can use the host CD-ROM by using ``/dev/cdrom`` 1111e2fcbf42SPeter Maydell as filename. 1112e2fcbf42SPeter MaydellERST 11135824d651Sblueswir1 111442e5f393SMarkus ArmbrusterDEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, 111542e5f393SMarkus Armbruster "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n" 111642e5f393SMarkus Armbruster " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 1117c9b749d7SKevin Wolf " [,read-only=on|off][,auto-read-only=on|off]\n" 1118c9b749d7SKevin Wolf " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n" 111942e5f393SMarkus Armbruster " [,driver specific parameters...]\n" 112042e5f393SMarkus Armbruster " configure a block backend\n", QEMU_ARCH_ALL) 1121e2fcbf42SPeter MaydellSRST 1122e2fcbf42SPeter Maydell``-blockdev option[,option[,option[,...]]]`` 1123e2fcbf42SPeter Maydell Define a new block driver node. Some of the options apply to all 1124e2fcbf42SPeter Maydell block drivers, other options are only accepted for a specific block 1125e2fcbf42SPeter Maydell driver. See below for a list of generic options and options for the 1126e2fcbf42SPeter Maydell most common block drivers. 1127e2fcbf42SPeter Maydell 1128e2fcbf42SPeter Maydell Options that expect a reference to another node (e.g. ``file``) can 1129e2fcbf42SPeter Maydell be given in two ways. Either you specify the node name of an already 1130e2fcbf42SPeter Maydell existing node (file=node-name), or you define a new node inline, 1131e2fcbf42SPeter Maydell adding options for the referenced node after a dot 1132e2fcbf42SPeter Maydell (file.filename=path,file.aio=native). 1133e2fcbf42SPeter Maydell 1134e2fcbf42SPeter Maydell A block driver node created with ``-blockdev`` can be used for a 1135e2fcbf42SPeter Maydell guest device by specifying its node name for the ``drive`` property 1136e2fcbf42SPeter Maydell in a ``-device`` argument that defines a block device. 1137e2fcbf42SPeter Maydell 1138e2fcbf42SPeter Maydell ``Valid options for any block driver node:`` 1139e2fcbf42SPeter Maydell ``driver`` 1140e2fcbf42SPeter Maydell Specifies the block driver to use for the given node. 1141e2fcbf42SPeter Maydell 1142e2fcbf42SPeter Maydell ``node-name`` 1143e2fcbf42SPeter Maydell This defines the name of the block driver node by which it 1144e2fcbf42SPeter Maydell will be referenced later. The name must be unique, i.e. it 1145e2fcbf42SPeter Maydell must not match the name of a different block driver node, or 1146e2fcbf42SPeter Maydell (if you use ``-drive`` as well) the ID of a drive. 1147e2fcbf42SPeter Maydell 1148e2fcbf42SPeter Maydell If no node name is specified, it is automatically generated. 1149e2fcbf42SPeter Maydell The generated node name is not intended to be predictable 1150e2fcbf42SPeter Maydell and changes between QEMU invocations. For the top level, an 1151e2fcbf42SPeter Maydell explicit node name must be specified. 1152e2fcbf42SPeter Maydell 1153e2fcbf42SPeter Maydell ``read-only`` 1154e2fcbf42SPeter Maydell Open the node read-only. Guest write attempts will fail. 1155e2fcbf42SPeter Maydell 1156e2fcbf42SPeter Maydell Note that some block drivers support only read-only access, 1157e2fcbf42SPeter Maydell either generally or in certain configurations. In this case, 1158e2fcbf42SPeter Maydell the default value ``read-only=off`` does not work and the 1159e2fcbf42SPeter Maydell option must be specified explicitly. 1160e2fcbf42SPeter Maydell 1161e2fcbf42SPeter Maydell ``auto-read-only`` 1162e2fcbf42SPeter Maydell If ``auto-read-only=on`` is set, QEMU may fall back to 1163e2fcbf42SPeter Maydell read-only usage even when ``read-only=off`` is requested, or 1164e2fcbf42SPeter Maydell even switch between modes as needed, e.g. depending on 1165e2fcbf42SPeter Maydell whether the image file is writable or whether a writing user 1166e2fcbf42SPeter Maydell is attached to the node. 1167e2fcbf42SPeter Maydell 1168e2fcbf42SPeter Maydell ``force-share`` 1169e2fcbf42SPeter Maydell Override the image locking system of QEMU by forcing the 1170e2fcbf42SPeter Maydell node to utilize weaker shared access for permissions where 1171e2fcbf42SPeter Maydell it would normally request exclusive access. When there is 1172e2fcbf42SPeter Maydell the potential for multiple instances to have the same file 1173e2fcbf42SPeter Maydell open (whether this invocation of QEMU is the first or the 1174e2fcbf42SPeter Maydell second instance), both instances must permit shared access 1175e2fcbf42SPeter Maydell for the second instance to succeed at opening the file. 1176e2fcbf42SPeter Maydell 1177e2fcbf42SPeter Maydell Enabling ``force-share=on`` requires ``read-only=on``. 1178e2fcbf42SPeter Maydell 1179e2fcbf42SPeter Maydell ``cache.direct`` 1180e2fcbf42SPeter Maydell The host page cache can be avoided with ``cache.direct=on``. 1181e2fcbf42SPeter Maydell This will attempt to do disk IO directly to the guest's 1182e2fcbf42SPeter Maydell memory. QEMU may still perform an internal copy of the data. 1183e2fcbf42SPeter Maydell 1184e2fcbf42SPeter Maydell ``cache.no-flush`` 1185e2fcbf42SPeter Maydell In case you don't care about data integrity over host 1186e2fcbf42SPeter Maydell failures, you can use ``cache.no-flush=on``. This option 1187e2fcbf42SPeter Maydell tells QEMU that it never needs to write any data to the disk 1188e2fcbf42SPeter Maydell but can instead keep things in cache. If anything goes 1189e2fcbf42SPeter Maydell wrong, like your host losing power, the disk storage getting 1190e2fcbf42SPeter Maydell disconnected accidentally, etc. your image will most 1191e2fcbf42SPeter Maydell probably be rendered unusable. 1192e2fcbf42SPeter Maydell 1193e2fcbf42SPeter Maydell ``discard=discard`` 1194e2fcbf42SPeter Maydell discard is one of "ignore" (or "off") or "unmap" (or "on") 1195e2fcbf42SPeter Maydell and controls whether ``discard`` (also known as ``trim`` or 1196e2fcbf42SPeter Maydell ``unmap``) requests are ignored or passed to the filesystem. 1197e2fcbf42SPeter Maydell Some machine types may not support discard requests. 1198e2fcbf42SPeter Maydell 1199e2fcbf42SPeter Maydell ``detect-zeroes=detect-zeroes`` 1200e2fcbf42SPeter Maydell detect-zeroes is "off", "on" or "unmap" and enables the 1201e2fcbf42SPeter Maydell automatic conversion of plain zero writes by the OS to 1202e2fcbf42SPeter Maydell driver specific optimized zero write commands. You may even 1203e2fcbf42SPeter Maydell choose "unmap" if discard is set to "unmap" to allow a zero 1204e2fcbf42SPeter Maydell write to be converted to an ``unmap`` operation. 1205e2fcbf42SPeter Maydell 1206e2fcbf42SPeter Maydell ``Driver-specific options for file`` 1207e2fcbf42SPeter Maydell This is the protocol-level block driver for accessing regular 1208e2fcbf42SPeter Maydell files. 1209e2fcbf42SPeter Maydell 1210e2fcbf42SPeter Maydell ``filename`` 1211e2fcbf42SPeter Maydell The path to the image file in the local filesystem 1212e2fcbf42SPeter Maydell 1213e2fcbf42SPeter Maydell ``aio`` 1214ad1e691dSStefano Garzarella Specifies the AIO backend (threads/native/io_uring, 1215ad1e691dSStefano Garzarella default: threads) 1216e2fcbf42SPeter Maydell 1217e2fcbf42SPeter Maydell ``locking`` 1218e2fcbf42SPeter Maydell Specifies whether the image file is protected with Linux OFD 1219e2fcbf42SPeter Maydell / POSIX locks. The default is to use the Linux Open File 1220e2fcbf42SPeter Maydell Descriptor API if available, otherwise no lock is applied. 1221e2fcbf42SPeter Maydell (auto/on/off, default: auto) 1222e2fcbf42SPeter Maydell 1223e2fcbf42SPeter Maydell Example: 1224e2fcbf42SPeter Maydell 1225e2fcbf42SPeter Maydell :: 1226e2fcbf42SPeter Maydell 1227e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk,filename=disk.img 1228e2fcbf42SPeter Maydell 1229e2fcbf42SPeter Maydell ``Driver-specific options for raw`` 1230e2fcbf42SPeter Maydell This is the image format block driver for raw images. It is 1231e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1232e2fcbf42SPeter Maydell ``file``. 1233e2fcbf42SPeter Maydell 1234e2fcbf42SPeter Maydell ``file`` 1235e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1236e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1237e2fcbf42SPeter Maydell 1238e2fcbf42SPeter Maydell Example 1: 1239e2fcbf42SPeter Maydell 1240e2fcbf42SPeter Maydell :: 1241e2fcbf42SPeter Maydell 1242e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk_file,filename=disk.img 1243e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file=disk_file 1244e2fcbf42SPeter Maydell 1245e2fcbf42SPeter Maydell Example 2: 1246e2fcbf42SPeter Maydell 1247e2fcbf42SPeter Maydell :: 1248e2fcbf42SPeter Maydell 1249e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img 1250e2fcbf42SPeter Maydell 1251e2fcbf42SPeter Maydell ``Driver-specific options for qcow2`` 1252e2fcbf42SPeter Maydell This is the image format block driver for qcow2 images. It is 1253e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1254e2fcbf42SPeter Maydell ``file``. 1255e2fcbf42SPeter Maydell 1256e2fcbf42SPeter Maydell ``file`` 1257e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1258e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1259e2fcbf42SPeter Maydell 1260e2fcbf42SPeter Maydell ``backing`` 1261e2fcbf42SPeter Maydell Reference to or definition of the backing file block device 1262e2fcbf42SPeter Maydell (default is taken from the image file). It is allowed to 1263e2fcbf42SPeter Maydell pass ``null`` here in order to disable the default backing 1264e2fcbf42SPeter Maydell file. 1265e2fcbf42SPeter Maydell 1266e2fcbf42SPeter Maydell ``lazy-refcounts`` 1267e2fcbf42SPeter Maydell Whether to enable the lazy refcounts feature (on/off; 1268e2fcbf42SPeter Maydell default is taken from the image file) 1269e2fcbf42SPeter Maydell 1270e2fcbf42SPeter Maydell ``cache-size`` 1271e2fcbf42SPeter Maydell The maximum total size of the L2 table and refcount block 1272e2fcbf42SPeter Maydell caches in bytes (default: the sum of l2-cache-size and 1273e2fcbf42SPeter Maydell refcount-cache-size) 1274e2fcbf42SPeter Maydell 1275e2fcbf42SPeter Maydell ``l2-cache-size`` 1276e2fcbf42SPeter Maydell The maximum size of the L2 table cache in bytes (default: if 1277e2fcbf42SPeter Maydell cache-size is not specified - 32M on Linux platforms, and 8M 1278e2fcbf42SPeter Maydell on non-Linux platforms; otherwise, as large as possible 1279e2fcbf42SPeter Maydell within the cache-size, while permitting the requested or the 1280e2fcbf42SPeter Maydell minimal refcount cache size) 1281e2fcbf42SPeter Maydell 1282e2fcbf42SPeter Maydell ``refcount-cache-size`` 1283e2fcbf42SPeter Maydell The maximum size of the refcount block cache in bytes 1284e2fcbf42SPeter Maydell (default: 4 times the cluster size; or if cache-size is 1285e2fcbf42SPeter Maydell specified, the part of it which is not used for the L2 1286e2fcbf42SPeter Maydell cache) 1287e2fcbf42SPeter Maydell 1288e2fcbf42SPeter Maydell ``cache-clean-interval`` 1289e2fcbf42SPeter Maydell Clean unused entries in the L2 and refcount caches. The 1290e2fcbf42SPeter Maydell interval is in seconds. The default value is 600 on 1291e2fcbf42SPeter Maydell supporting platforms, and 0 on other platforms. Setting it 1292e2fcbf42SPeter Maydell to 0 disables this feature. 1293e2fcbf42SPeter Maydell 1294e2fcbf42SPeter Maydell ``pass-discard-request`` 1295e2fcbf42SPeter Maydell Whether discard requests to the qcow2 device should be 1296e2fcbf42SPeter Maydell forwarded to the data source (on/off; default: on if 1297e2fcbf42SPeter Maydell discard=unmap is specified, off otherwise) 1298e2fcbf42SPeter Maydell 1299e2fcbf42SPeter Maydell ``pass-discard-snapshot`` 1300e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1301e2fcbf42SPeter Maydell issued when a snapshot operation (e.g. deleting a snapshot) 1302e2fcbf42SPeter Maydell frees clusters in the qcow2 file (on/off; default: on) 1303e2fcbf42SPeter Maydell 1304e2fcbf42SPeter Maydell ``pass-discard-other`` 1305e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1306e2fcbf42SPeter Maydell issued on other occasions where a cluster gets freed 1307e2fcbf42SPeter Maydell (on/off; default: off) 1308e2fcbf42SPeter Maydell 1309e2fcbf42SPeter Maydell ``overlap-check`` 1310e2fcbf42SPeter Maydell Which overlap checks to perform for writes to the image 1311e2fcbf42SPeter Maydell (none/constant/cached/all; default: cached). For details or 1312e2fcbf42SPeter Maydell finer granularity control refer to the QAPI documentation of 1313e2fcbf42SPeter Maydell ``blockdev-add``. 1314e2fcbf42SPeter Maydell 1315e2fcbf42SPeter Maydell Example 1: 1316e2fcbf42SPeter Maydell 1317e2fcbf42SPeter Maydell :: 1318e2fcbf42SPeter Maydell 1319e2fcbf42SPeter Maydell -blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2 1320e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216 1321e2fcbf42SPeter Maydell 1322e2fcbf42SPeter Maydell Example 2: 1323e2fcbf42SPeter Maydell 1324e2fcbf42SPeter Maydell :: 1325e2fcbf42SPeter Maydell 1326e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2 1327e2fcbf42SPeter Maydell 1328e2fcbf42SPeter Maydell ``Driver-specific options for other drivers`` 1329e2fcbf42SPeter Maydell Please refer to the QAPI documentation of the ``blockdev-add`` 1330e2fcbf42SPeter Maydell QMP command. 1331e2fcbf42SPeter MaydellERST 133242e5f393SMarkus Armbruster 13335824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 13345824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 133592196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 1336572023f7SKevin Wolf " [,snapshot=on|off][,rerror=ignore|stop|report]\n" 1337ad1e691dSStefano Garzarella " [,werror=ignore|stop|report|enospc][,id=name]\n" 1338ad1e691dSStefano Garzarella " [,aio=threads|native|io_uring]\n" 1339fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 13402f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 13413e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 13423e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 13433e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 13443e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 13452024c1dfSBenoît Canet " [[,iops_size=is]]\n" 134676f4afb4SAlberto Garcia " [[,group=g]]\n" 1347ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1348e2fcbf42SPeter MaydellSRST 1349e2fcbf42SPeter Maydell``-drive option[,option[,option[,...]]]`` 1350e2fcbf42SPeter Maydell Define a new drive. This includes creating a block driver node (the 1351e2fcbf42SPeter Maydell backend) as well as a guest device, and is mostly a shortcut for 1352e2fcbf42SPeter Maydell defining the corresponding ``-blockdev`` and ``-device`` options. 1353e2fcbf42SPeter Maydell 1354e2fcbf42SPeter Maydell ``-drive`` accepts all options that are accepted by ``-blockdev``. 1355e2fcbf42SPeter Maydell In addition, it knows the following options: 1356e2fcbf42SPeter Maydell 1357e2fcbf42SPeter Maydell ``file=file`` 1358923e9311SThomas Huth This option defines which disk image (see the :ref:`disk images` 1359923e9311SThomas Huth chapter in the System Emulation Users Guide) to use with this drive. 1360923e9311SThomas Huth If the filename contains comma, you must double it (for instance, 1361e2fcbf42SPeter Maydell "file=my,,file" to use file "my,file"). 1362e2fcbf42SPeter Maydell 1363e2fcbf42SPeter Maydell Special files such as iSCSI devices can be specified using 1364e2fcbf42SPeter Maydell protocol specific URLs. See the section for "Device URL Syntax" 1365e2fcbf42SPeter Maydell for more information. 1366e2fcbf42SPeter Maydell 1367e2fcbf42SPeter Maydell ``if=interface`` 1368e2fcbf42SPeter Maydell This option defines on which type on interface the drive is 1369e2fcbf42SPeter Maydell connected. Available types are: ide, scsi, sd, mtd, floppy, 1370e2fcbf42SPeter Maydell pflash, virtio, none. 1371e2fcbf42SPeter Maydell 1372e2fcbf42SPeter Maydell ``bus=bus,unit=unit`` 1373e2fcbf42SPeter Maydell These options define where is connected the drive by defining 1374e2fcbf42SPeter Maydell the bus number and the unit id. 1375e2fcbf42SPeter Maydell 1376e2fcbf42SPeter Maydell ``index=index`` 137735aab303SLaurent Vivier This option defines where the drive is connected by using an 1378e2fcbf42SPeter Maydell index in the list of available connectors of a given interface 1379e2fcbf42SPeter Maydell type. 1380e2fcbf42SPeter Maydell 1381e2fcbf42SPeter Maydell ``media=media`` 1382e2fcbf42SPeter Maydell This option defines the type of the media: disk or cdrom. 1383e2fcbf42SPeter Maydell 1384e2fcbf42SPeter Maydell ``snapshot=snapshot`` 1385e2fcbf42SPeter Maydell snapshot is "on" or "off" and controls snapshot mode for the 1386e2fcbf42SPeter Maydell given drive (see ``-snapshot``). 1387e2fcbf42SPeter Maydell 1388e2fcbf42SPeter Maydell ``cache=cache`` 1389e2fcbf42SPeter Maydell cache is "none", "writeback", "unsafe", "directsync" or 1390e2fcbf42SPeter Maydell "writethrough" and controls how the host cache is used to access 1391e2fcbf42SPeter Maydell block data. This is a shortcut that sets the ``cache.direct`` 1392e2fcbf42SPeter Maydell and ``cache.no-flush`` options (as in ``-blockdev``), and 1393e2fcbf42SPeter Maydell additionally ``cache.writeback``, which provides a default for 1394e2fcbf42SPeter Maydell the ``write-cache`` option of block guest devices (as in 1395e2fcbf42SPeter Maydell ``-device``). The modes correspond to the following settings: 1396e2fcbf42SPeter Maydell 139709ce5f2dSPeter Maydell ============= =============== ============ ============== 139809ce5f2dSPeter Maydell \ cache.writeback cache.direct cache.no-flush 139909ce5f2dSPeter Maydell ============= =============== ============ ============== 140009ce5f2dSPeter Maydell writeback on off off 140109ce5f2dSPeter Maydell none on on off 140209ce5f2dSPeter Maydell writethrough off off off 140309ce5f2dSPeter Maydell directsync off on off 140409ce5f2dSPeter Maydell unsafe on off on 140509ce5f2dSPeter Maydell ============= =============== ============ ============== 1406e2fcbf42SPeter Maydell 1407e2fcbf42SPeter Maydell The default mode is ``cache=writeback``. 1408e2fcbf42SPeter Maydell 1409e2fcbf42SPeter Maydell ``aio=aio`` 1410ad1e691dSStefano Garzarella aio is "threads", "native", or "io_uring" and selects between pthread 1411ad1e691dSStefano Garzarella based disk I/O, native Linux AIO, or Linux io_uring API. 1412e2fcbf42SPeter Maydell 1413e2fcbf42SPeter Maydell ``format=format`` 1414e2fcbf42SPeter Maydell Specify which disk format will be used rather than detecting the 1415e2fcbf42SPeter Maydell format. Can be used to specify format=raw to avoid interpreting 1416e2fcbf42SPeter Maydell an untrusted format header. 1417e2fcbf42SPeter Maydell 1418e2fcbf42SPeter Maydell ``werror=action,rerror=action`` 1419e2fcbf42SPeter Maydell Specify which action to take on write and read errors. Valid 1420e2fcbf42SPeter Maydell actions are: "ignore" (ignore the error and try to continue), 1421e2fcbf42SPeter Maydell "stop" (pause QEMU), "report" (report the error to the guest), 1422e2fcbf42SPeter Maydell "enospc" (pause QEMU only if the host disk is full; report the 1423e2fcbf42SPeter Maydell error to the guest otherwise). The default setting is 1424e2fcbf42SPeter Maydell ``werror=enospc`` and ``rerror=report``. 1425e2fcbf42SPeter Maydell 1426e2fcbf42SPeter Maydell ``copy-on-read=copy-on-read`` 1427e2fcbf42SPeter Maydell copy-on-read is "on" or "off" and enables whether to copy read 1428e2fcbf42SPeter Maydell backing file sectors into the image file. 1429e2fcbf42SPeter Maydell 1430e2fcbf42SPeter Maydell ``bps=b,bps_rd=r,bps_wr=w`` 1431e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1432e2fcbf42SPeter Maydell for all request types or for reads or writes only. Small values 1433e2fcbf42SPeter Maydell can lead to timeouts or hangs inside the guest. A safe minimum 1434e2fcbf42SPeter Maydell for disks is 2 MB/s. 1435e2fcbf42SPeter Maydell 1436e2fcbf42SPeter Maydell ``bps_max=bm,bps_rd_max=rm,bps_wr_max=wm`` 1437e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1438e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1439e2fcbf42SPeter Maydell above the limit temporarily. 1440e2fcbf42SPeter Maydell 1441e2fcbf42SPeter Maydell ``iops=i,iops_rd=r,iops_wr=w`` 1442e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1443e2fcbf42SPeter Maydell all request types or for reads or writes only. 1444e2fcbf42SPeter Maydell 1445e2fcbf42SPeter Maydell ``iops_max=bm,iops_rd_max=rm,iops_wr_max=wm`` 1446e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1447e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1448e2fcbf42SPeter Maydell spike above the limit temporarily. 1449e2fcbf42SPeter Maydell 1450e2fcbf42SPeter Maydell ``iops_size=is`` 1451e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1452e2fcbf42SPeter Maydell throttling purposes. Use this option to prevent guests from 1453e2fcbf42SPeter Maydell circumventing iops limits by sending fewer but larger requests. 1454e2fcbf42SPeter Maydell 1455e2fcbf42SPeter Maydell ``group=g`` 1456e2fcbf42SPeter Maydell Join a throttling quota group with given name g. All drives that 1457e2fcbf42SPeter Maydell are members of the same group are accounted for together. Use 1458e2fcbf42SPeter Maydell this option to prevent guests from circumventing throttling 1459e2fcbf42SPeter Maydell limits by using many small disks instead of a single larger 1460e2fcbf42SPeter Maydell disk. 1461e2fcbf42SPeter Maydell 1462e2fcbf42SPeter Maydell By default, the ``cache.writeback=on`` mode is used. It will report 1463e2fcbf42SPeter Maydell data writes as completed as soon as the data is present in the host 1464e2fcbf42SPeter Maydell page cache. This is safe as long as your guest OS makes sure to 1465e2fcbf42SPeter Maydell correctly flush disk caches where needed. If your guest OS does not 1466e2fcbf42SPeter Maydell handle volatile disk write caches correctly and your host crashes or 1467e2fcbf42SPeter Maydell loses power, then the guest may experience data corruption. 1468e2fcbf42SPeter Maydell 1469e2fcbf42SPeter Maydell For such guests, you should consider using ``cache.writeback=off``. 1470e2fcbf42SPeter Maydell This means that the host page cache will be used to read and write 1471e2fcbf42SPeter Maydell data, but write notification will be sent to the guest only after 1472e2fcbf42SPeter Maydell QEMU has made sure to flush each write to the disk. Be aware that 1473e2fcbf42SPeter Maydell this has a major impact on performance. 1474e2fcbf42SPeter Maydell 1475e2fcbf42SPeter Maydell When using the ``-snapshot`` option, unsafe caching is always used. 1476e2fcbf42SPeter Maydell 1477e2fcbf42SPeter Maydell Copy-on-read avoids accessing the same backing file sectors 1478e2fcbf42SPeter Maydell repeatedly and is useful when the backing file is over a slow 1479e2fcbf42SPeter Maydell network. By default copy-on-read is off. 1480e2fcbf42SPeter Maydell 1481e2fcbf42SPeter Maydell Instead of ``-cdrom`` you can use: 1482e2fcbf42SPeter Maydell 1483e2fcbf42SPeter Maydell .. parsed-literal:: 1484e2fcbf42SPeter Maydell 1485e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=cdrom 1486e2fcbf42SPeter Maydell 1487e2fcbf42SPeter Maydell Instead of ``-hda``, ``-hdb``, ``-hdc``, ``-hdd``, you can use: 1488e2fcbf42SPeter Maydell 1489e2fcbf42SPeter Maydell .. parsed-literal:: 1490e2fcbf42SPeter Maydell 1491e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=0,media=disk 1492e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=1,media=disk 1493e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=disk 1494e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=3,media=disk 1495e2fcbf42SPeter Maydell 1496e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 1497e2fcbf42SPeter Maydell set: 1498e2fcbf42SPeter Maydell 1499e2fcbf42SPeter Maydell .. parsed-literal:: 1500e2fcbf42SPeter Maydell 1501353a06b4SLaszlo Ersek |qemu_system| \\ 1502353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 1503353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 1504e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 1505e2fcbf42SPeter Maydell 1506e2fcbf42SPeter Maydell You can connect a CDROM to the slave of ide0: 1507e2fcbf42SPeter Maydell 1508e2fcbf42SPeter Maydell .. parsed-literal:: 1509e2fcbf42SPeter Maydell 1510e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,if=ide,index=1,media=cdrom 1511e2fcbf42SPeter Maydell 1512e2fcbf42SPeter Maydell If you don't specify the "file=" argument, you define an empty 1513e2fcbf42SPeter Maydell drive: 1514e2fcbf42SPeter Maydell 1515e2fcbf42SPeter Maydell .. parsed-literal:: 1516e2fcbf42SPeter Maydell 1517e2fcbf42SPeter Maydell |qemu_system_x86| -drive if=ide,index=1,media=cdrom 1518e2fcbf42SPeter Maydell 1519e2fcbf42SPeter Maydell Instead of ``-fda``, ``-fdb``, you can use: 1520e2fcbf42SPeter Maydell 1521e2fcbf42SPeter Maydell .. parsed-literal:: 1522e2fcbf42SPeter Maydell 1523e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=0,if=floppy 1524e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=1,if=floppy 1525e2fcbf42SPeter Maydell 1526e2fcbf42SPeter Maydell By default, interface is "ide" and index is automatically 1527e2fcbf42SPeter Maydell incremented: 1528e2fcbf42SPeter Maydell 1529e2fcbf42SPeter Maydell .. parsed-literal:: 1530e2fcbf42SPeter Maydell 1531e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=a -drive file=b" 1532e2fcbf42SPeter Maydell 1533e2fcbf42SPeter Maydell is interpreted like: 1534e2fcbf42SPeter Maydell 1535e2fcbf42SPeter Maydell .. parsed-literal:: 1536e2fcbf42SPeter Maydell 1537e2fcbf42SPeter Maydell |qemu_system_x86| -hda a -hdb b 1538e2fcbf42SPeter MaydellERST 15395824d651Sblueswir1 15405824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 1541ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 1542ad96090aSBlue Swirl QEMU_ARCH_ALL) 1543e2fcbf42SPeter MaydellSRST 1544e2fcbf42SPeter Maydell``-mtdblock file`` 1545e2fcbf42SPeter Maydell Use file as on-board Flash memory image. 1546e2fcbf42SPeter MaydellERST 15475824d651Sblueswir1 15485824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 1549ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 1550e2fcbf42SPeter MaydellSRST 1551e2fcbf42SPeter Maydell``-sd file`` 1552e2fcbf42SPeter Maydell Use file as SecureDigital card image. 1553e2fcbf42SPeter MaydellERST 15545824d651Sblueswir1 15555824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 1556ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 1557e2fcbf42SPeter MaydellSRST 1558e2fcbf42SPeter Maydell``-pflash file`` 1559e2fcbf42SPeter Maydell Use file as a parallel flash image. 1560e2fcbf42SPeter MaydellERST 15615824d651Sblueswir1 15625824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 1563ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 1564ad96090aSBlue Swirl QEMU_ARCH_ALL) 1565e2fcbf42SPeter MaydellSRST 1566e2fcbf42SPeter Maydell``-snapshot`` 1567e2fcbf42SPeter Maydell Write to temporary files instead of disk image files. In this case, 1568e2fcbf42SPeter Maydell the raw disk image you use is not written back. You can however 1569923e9311SThomas Huth force the write back by pressing C-a s (see the :ref:`disk images` 1570923e9311SThomas Huth chapter in the System Emulation Users Guide). 1571e2fcbf42SPeter MaydellERST 15725824d651Sblueswir1 157374db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 1574b44a6b09SGreg Kurz "-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1575991c180dSPaolo Bonzini " [,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode]\n" 1576b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n" 1577b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n" 1578b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n" 1579b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n" 1580b44a6b09SGreg Kurz " [[,throttling.iops-size=is]]\n" 1581991c180dSPaolo Bonzini "-fsdev proxy,id=id,socket=socket[,writeout=immediate][,readonly=on]\n" 1582991c180dSPaolo Bonzini "-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=immediate][,readonly=on]\n" 1583b44a6b09SGreg Kurz "-fsdev synth,id=id\n", 158474db920cSGautham R Shenoy QEMU_ARCH_ALL) 158574db920cSGautham R Shenoy 1586e2fcbf42SPeter MaydellSRST 1587991c180dSPaolo 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[,...]]]`` 158809ce5f2dSPeter Maydell \ 1589991c180dSPaolo Bonzini``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly=on]`` 159009ce5f2dSPeter Maydell \ 1591991c180dSPaolo Bonzini``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly=on]`` 159209ce5f2dSPeter Maydell \ 1593991c180dSPaolo Bonzini``-fsdev synth,id=id[,readonly=on]`` 1594e2fcbf42SPeter Maydell Define a new file system device. Valid options are: 1595e2fcbf42SPeter Maydell 1596e2fcbf42SPeter Maydell ``local`` 1597e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1598e2fcbf42SPeter Maydell 1599e2fcbf42SPeter Maydell ``proxy`` 1600e2fcbf42SPeter Maydell Accesses to the filesystem are done by virtfs-proxy-helper(1). 1601e2fcbf42SPeter Maydell 1602e2fcbf42SPeter Maydell ``synth`` 1603e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1604e2fcbf42SPeter Maydell 1605e2fcbf42SPeter Maydell ``id=id`` 1606e2fcbf42SPeter Maydell Specifies identifier for this device. 1607e2fcbf42SPeter Maydell 1608e2fcbf42SPeter Maydell ``path=path`` 1609e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1610e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1611e2fcbf42SPeter Maydell 1612e2fcbf42SPeter Maydell ``security_model=security_model`` 1613e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1614e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1615e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1616e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1617e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1618e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1619e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1620e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1621e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1622e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1623e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1624e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1625e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1626e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1627e2fcbf42SPeter Maydell parameter. 1628e2fcbf42SPeter Maydell 1629e2fcbf42SPeter Maydell ``writeout=writeout`` 1630e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1631e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1632e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1633e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1634e2fcbf42SPeter Maydell storage subsystem. 1635e2fcbf42SPeter Maydell 1636991c180dSPaolo Bonzini ``readonly=on`` 1637e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1638e2fcbf42SPeter Maydell default read-write access is given. 1639e2fcbf42SPeter Maydell 1640e2fcbf42SPeter Maydell ``socket=socket`` 1641e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1642e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). 1643e2fcbf42SPeter Maydell 1644e2fcbf42SPeter Maydell ``sock_fd=sock_fd`` 1645e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket descriptor 1646e2fcbf42SPeter Maydell for communicating with virtfs-proxy-helper(1). Usually a helper 1647e2fcbf42SPeter Maydell like libvirt will create socketpair and pass one of the fds as 1648e2fcbf42SPeter Maydell sock\_fd. 1649e2fcbf42SPeter Maydell 1650e2fcbf42SPeter Maydell ``fmode=fmode`` 1651e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1652e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1653e2fcbf42SPeter Maydell "mapped-file". 1654e2fcbf42SPeter Maydell 1655e2fcbf42SPeter Maydell ``dmode=dmode`` 1656e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1657e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1658e2fcbf42SPeter Maydell "mapped-file". 1659e2fcbf42SPeter Maydell 1660e2fcbf42SPeter Maydell ``throttling.bps-total=b,throttling.bps-read=r,throttling.bps-write=w`` 1661e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1662e2fcbf42SPeter Maydell for all request types or for reads or writes only. 1663e2fcbf42SPeter Maydell 1664e2fcbf42SPeter Maydell ``throttling.bps-total-max=bm,bps-read-max=rm,bps-write-max=wm`` 1665e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1666e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1667e2fcbf42SPeter Maydell above the limit temporarily. 1668e2fcbf42SPeter Maydell 1669e2fcbf42SPeter Maydell ``throttling.iops-total=i,throttling.iops-read=r, throttling.iops-write=w`` 1670e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1671e2fcbf42SPeter Maydell all request types or for reads or writes only. 1672e2fcbf42SPeter Maydell 1673e2fcbf42SPeter Maydell ``throttling.iops-total-max=im,throttling.iops-read-max=irm, throttling.iops-write-max=iwm`` 1674e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1675e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1676e2fcbf42SPeter Maydell spike above the limit temporarily. 1677e2fcbf42SPeter Maydell 1678e2fcbf42SPeter Maydell ``throttling.iops-size=is`` 1679e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1680e2fcbf42SPeter Maydell throttling purposes. 1681e2fcbf42SPeter Maydell 1682e2fcbf42SPeter Maydell -fsdev option is used along with -device driver "virtio-9p-...". 1683e2fcbf42SPeter Maydell 1684e2fcbf42SPeter Maydell``-device virtio-9p-type,fsdev=id,mount_tag=mount_tag`` 1685e2fcbf42SPeter Maydell Options for virtio-9p-... driver are: 1686e2fcbf42SPeter Maydell 1687e2fcbf42SPeter Maydell ``type`` 1688e2fcbf42SPeter Maydell Specifies the variant to be used. Supported values are "pci", 1689e2fcbf42SPeter Maydell "ccw" or "device", depending on the machine type. 1690e2fcbf42SPeter Maydell 1691e2fcbf42SPeter Maydell ``fsdev=id`` 1692e2fcbf42SPeter Maydell Specifies the id value specified along with -fsdev option. 1693e2fcbf42SPeter Maydell 1694e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1695e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1696e2fcbf42SPeter Maydell export point. 1697e2fcbf42SPeter MaydellERST 169874db920cSGautham R Shenoy 16993d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 1700b44a6b09SGreg Kurz "-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1701991c180dSPaolo Bonzini " [,id=id][,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode][,multidevs=remap|forbid|warn]\n" 1702991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,socket=socket[,id=id][,writeout=immediate][,readonly=on]\n" 1703991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,sock_fd=sock_fd[,id=id][,writeout=immediate][,readonly=on]\n" 1704991c180dSPaolo Bonzini "-virtfs synth,mount_tag=tag[,id=id][,readonly=on]\n", 17053d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 17063d54abc7SGautham R Shenoy 1707e2fcbf42SPeter MaydellSRST 1708991c180dSPaolo Bonzini``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly=on] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]`` 170909ce5f2dSPeter Maydell \ 1710991c180dSPaolo Bonzini``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 171109ce5f2dSPeter Maydell \ 1712991c180dSPaolo Bonzini``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 171309ce5f2dSPeter Maydell \ 171409ce5f2dSPeter Maydell``-virtfs synth,mount_tag=mount_tag`` 171565abaa01SChristian Schoenebeck Define a new virtual filesystem device and expose it to the guest using 171665abaa01SChristian Schoenebeck a virtio-9p-device (a.k.a. 9pfs), which essentially means that a certain 171765abaa01SChristian Schoenebeck directory on host is made directly accessible by guest as a pass-through 171865abaa01SChristian Schoenebeck file system by using the 9P network protocol for communication between 171965abaa01SChristian Schoenebeck host and guests, if desired even accessible, shared by several guests 172065abaa01SChristian Schoenebeck simultaniously. 172165abaa01SChristian Schoenebeck 172265abaa01SChristian Schoenebeck Note that ``-virtfs`` is actually just a convenience shortcut for its 172365abaa01SChristian Schoenebeck generalized form ``-fsdev -device virtio-9p-pci``. 172465abaa01SChristian Schoenebeck 172565abaa01SChristian Schoenebeck The general form of pass-through file system options are: 1726e2fcbf42SPeter Maydell 1727e2fcbf42SPeter Maydell ``local`` 1728e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1729e2fcbf42SPeter Maydell 1730e2fcbf42SPeter Maydell ``proxy`` 1731e2fcbf42SPeter Maydell Accesses to the filesystem are done by virtfs-proxy-helper(1). 1732e2fcbf42SPeter Maydell 1733e2fcbf42SPeter Maydell ``synth`` 1734e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1735e2fcbf42SPeter Maydell 1736e2fcbf42SPeter Maydell ``id=id`` 1737e2fcbf42SPeter Maydell Specifies identifier for the filesystem device 1738e2fcbf42SPeter Maydell 1739e2fcbf42SPeter Maydell ``path=path`` 1740e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1741e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1742e2fcbf42SPeter Maydell 1743e2fcbf42SPeter Maydell ``security_model=security_model`` 1744e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1745e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1746e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1747e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1748e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1749e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1750e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1751e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1752e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1753e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1754e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1755e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1756e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1757e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1758e2fcbf42SPeter Maydell parameter. 1759e2fcbf42SPeter Maydell 1760e2fcbf42SPeter Maydell ``writeout=writeout`` 1761e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1762e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1763e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1764e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1765e2fcbf42SPeter Maydell storage subsystem. 1766e2fcbf42SPeter Maydell 1767991c180dSPaolo Bonzini ``readonly=on`` 1768e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1769e2fcbf42SPeter Maydell default read-write access is given. 1770e2fcbf42SPeter Maydell 1771e2fcbf42SPeter Maydell ``socket=socket`` 1772e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1773e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). Usually a helper like 1774e2fcbf42SPeter Maydell libvirt will create socketpair and pass one of the fds as 1775e2fcbf42SPeter Maydell sock\_fd. 1776e2fcbf42SPeter Maydell 1777e2fcbf42SPeter Maydell ``sock_fd`` 1778e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed 'sock\_fd' as the 1779e2fcbf42SPeter Maydell socket descriptor for interfacing with virtfs-proxy-helper(1). 1780e2fcbf42SPeter Maydell 1781e2fcbf42SPeter Maydell ``fmode=fmode`` 1782e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1783e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1784e2fcbf42SPeter Maydell "mapped-file". 1785e2fcbf42SPeter Maydell 1786e2fcbf42SPeter Maydell ``dmode=dmode`` 1787e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1788e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1789e2fcbf42SPeter Maydell "mapped-file". 1790e2fcbf42SPeter Maydell 1791e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1792e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1793e2fcbf42SPeter Maydell export point. 1794e2fcbf42SPeter Maydell 1795e2fcbf42SPeter Maydell ``multidevs=multidevs`` 1796e2fcbf42SPeter Maydell Specifies how to deal with multiple devices being shared with a 1797e2fcbf42SPeter Maydell 9p export. Supported behaviours are either "remap", "forbid" or 1798e2fcbf42SPeter Maydell "warn". The latter is the default behaviour on which virtfs 9p 1799e2fcbf42SPeter Maydell expects only one device to be shared with the same export, and 1800e2fcbf42SPeter Maydell if more than one device is shared and accessed via the same 9p 1801e2fcbf42SPeter Maydell export then only a warning message is logged (once) by qemu on 1802e2fcbf42SPeter Maydell host side. In order to avoid file ID collisions on guest you 1803e2fcbf42SPeter Maydell should either create a separate virtfs export for each device to 1804e2fcbf42SPeter Maydell be shared with guests (recommended way) or you might use "remap" 1805e2fcbf42SPeter Maydell instead which allows you to share multiple devices with only one 1806e2fcbf42SPeter Maydell export instead, which is achieved by remapping the original 1807e2fcbf42SPeter Maydell inode numbers from host to guest in a way that would prevent 1808e2fcbf42SPeter Maydell such collisions. Remapping inodes in such use cases is required 1809e2fcbf42SPeter Maydell because the original device IDs from host are never passed and 1810e2fcbf42SPeter Maydell exposed on guest. Instead all files of an export shared with 1811e2fcbf42SPeter Maydell virtfs always share the same device id on guest. So two files 1812e2fcbf42SPeter Maydell with identical inode numbers but from actually different devices 1813e2fcbf42SPeter Maydell on host would otherwise cause a file ID collision and hence 1814e2fcbf42SPeter Maydell potential misbehaviours on guest. "forbid" on the other hand 1815e2fcbf42SPeter Maydell assumes like "warn" that only one device is shared by the same 1816e2fcbf42SPeter Maydell export, however it will not only log a warning message but also 1817e2fcbf42SPeter Maydell deny access to additional devices on guest. Note though that 1818e2fcbf42SPeter Maydell "forbid" does currently not block all possible file access 1819e2fcbf42SPeter Maydell operations (e.g. readdir() would still return entries from other 1820e2fcbf42SPeter Maydell devices). 1821e2fcbf42SPeter MaydellERST 18223d54abc7SGautham R Shenoy 182361d70487SMarkus ArmbrusterDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 182461d70487SMarkus Armbruster "-iscsi [user=user][,password=password]\n" 182561d70487SMarkus Armbruster " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 182661d70487SMarkus Armbruster " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 182761d70487SMarkus Armbruster " [,timeout=timeout]\n" 182861d70487SMarkus Armbruster " iSCSI session parameters\n", QEMU_ARCH_ALL) 182961d70487SMarkus Armbruster 1830e2fcbf42SPeter MaydellSRST 1831e2fcbf42SPeter Maydell``-iscsi`` 1832e2fcbf42SPeter Maydell Configure iSCSI session parameters. 1833e2fcbf42SPeter MaydellERST 183444743148SMarkus Armbruster 18355824d651Sblueswir1DEFHEADING() 18365824d651Sblueswir1 1837c2a34ab2SThomas HuthDEFHEADING(USB convenience options:) 183810adb8beSMarkus Armbruster 183910adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 184073f46fefSStefan Hajnoczi "-usb enable on-board USB host controller (if not enabled by default)\n", 184110adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1842e2fcbf42SPeter MaydellSRST 1843e2fcbf42SPeter Maydell``-usb`` 1844e2fcbf42SPeter Maydell Enable USB emulation on machine types with an on-board USB host 1845e2fcbf42SPeter Maydell controller (if not enabled by default). Note that on-board USB host 1846e2fcbf42SPeter Maydell controllers may not support USB 3.0. In this case 1847e2fcbf42SPeter Maydell ``-device qemu-xhci`` can be used instead on machines with PCI. 1848e2fcbf42SPeter MaydellERST 184910adb8beSMarkus Armbruster 185010adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 185110adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 185210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1853e2fcbf42SPeter MaydellSRST 1854e2fcbf42SPeter Maydell``-usbdevice devname`` 1855c2a34ab2SThomas Huth Add the USB device devname, and enable an on-board USB controller 1856c2a34ab2SThomas Huth if possible and necessary (just like it can be done via 1857c2a34ab2SThomas Huth ``-machine usb=on``). Note that this option is mainly intended for 1858c2a34ab2SThomas Huth the user's convenience only. More fine-grained control can be 1859c2a34ab2SThomas Huth achieved by selecting a USB host controller (if necessary) and the 1860c2a34ab2SThomas Huth desired USB device via the ``-device`` option instead. For example, 1861c2a34ab2SThomas Huth instead of using ``-usbdevice mouse`` it is possible to use 1862c2a34ab2SThomas Huth ``-device qemu-xhci -device usb-mouse`` to connect the USB mouse 1863c2a34ab2SThomas Huth to a USB 3.0 controller instead (at least on machines that support 1864c2a34ab2SThomas Huth PCI and do not have an USB controller enabled by default yet). 1865c2a34ab2SThomas Huth For more details, see the chapter about 1866923e9311SThomas Huth :ref:`Connecting USB devices` in the System Emulation Users Guide. 1867c2a34ab2SThomas Huth Possible devices for devname are: 1868c2a34ab2SThomas Huth 1869c2a34ab2SThomas Huth ``braille`` 1870c2a34ab2SThomas Huth Braille device. This will use BrlAPI to display the braille 1871c2a34ab2SThomas Huth output on a real or fake device (i.e. it also creates a 1872c2a34ab2SThomas Huth corresponding ``braille`` chardev automatically beside the 1873c2a34ab2SThomas Huth ``usb-braille`` USB device). 1874c2a34ab2SThomas Huth 1875c2a34ab2SThomas Huth ``keyboard`` 1876c2a34ab2SThomas Huth Standard USB keyboard. Will override the PS/2 keyboard (if present). 1877e2fcbf42SPeter Maydell 1878e2fcbf42SPeter Maydell ``mouse`` 1879e2fcbf42SPeter Maydell Virtual Mouse. This will override the PS/2 mouse emulation when 1880e2fcbf42SPeter Maydell activated. 1881e2fcbf42SPeter Maydell 1882e2fcbf42SPeter Maydell ``tablet`` 1883e2fcbf42SPeter Maydell Pointer device that uses absolute coordinates (like a 1884e2fcbf42SPeter Maydell touchscreen). This means QEMU is able to report the mouse 1885e2fcbf42SPeter Maydell position without having to grab the mouse. Also overrides the 1886e2fcbf42SPeter Maydell PS/2 mouse emulation when activated. 1887e2fcbf42SPeter Maydell 1888c2a34ab2SThomas Huth ``wacom-tablet`` 1889c2a34ab2SThomas Huth Wacom PenPartner USB tablet. 1890c2a34ab2SThomas Huth 1891c2a34ab2SThomas Huth 1892e2fcbf42SPeter MaydellERST 189310adb8beSMarkus Armbruster 189410adb8beSMarkus ArmbrusterDEFHEADING() 189510adb8beSMarkus Armbruster 1896de6b4f90SMarkus ArmbrusterDEFHEADING(Display options:) 18975824d651Sblueswir1 18981472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 189988b40c68SThomas Huth#if defined(CONFIG_SPICE) 1900d8aec9d9SMarc-André Lureau "-display spice-app[,gl=on|off]\n" 190188b40c68SThomas Huth#endif 190288b40c68SThomas Huth#if defined(CONFIG_SDL) 190395f439bdSThomas Huth "-display sdl[,alt_grab=on|off][,ctrl_grab=on|off][,gl=on|core|es|off]\n" 19048e8e844bSThomas Huth " [,grab-mod=<mod>][,show-cursor=on|off][,window-close=on|off]\n" 190588b40c68SThomas Huth#endif 190688b40c68SThomas Huth#if defined(CONFIG_GTK) 190795f439bdSThomas Huth "-display gtk[,full-screen=on|off][,gl=on|off][,grab-on-hover=on|off]\n" 190895f439bdSThomas Huth " [,show-cursor=on|off][,window-close=on|off]\n" 190988b40c68SThomas Huth#endif 191088b40c68SThomas Huth#if defined(CONFIG_VNC) 1911f04ec5afSRobert Ho "-display vnc=<display>[,<optargs>]\n" 191288b40c68SThomas Huth#endif 191388b40c68SThomas Huth#if defined(CONFIG_CURSES) 19142f8b7cd5SSamuel Thibault "-display curses[,charset=<encoding>]\n" 191588b40c68SThomas Huth#endif 1916f844cdb9SGustavo Noronha Silva#if defined(CONFIG_COCOA) 19174797adceSGustavo Noronha Silva "-display cocoa[,full-grab=on|off][,swap-opt-cmd=on|off]\n" 1918f844cdb9SGustavo Noronha Silva#endif 191988b40c68SThomas Huth#if defined(CONFIG_OPENGL) 192088b40c68SThomas Huth "-display egl-headless[,rendernode=<file>]\n" 192188b40c68SThomas Huth#endif 1922142ca628SMarc-André Lureau#if defined(CONFIG_DBUS_DISPLAY) 1923142ca628SMarc-André Lureau "-display dbus[,addr=<dbusaddr>]\n" 1924142ca628SMarc-André Lureau " [,gl=on|core|es|off][,rendernode=<file>]\n" 1925142ca628SMarc-André Lureau#endif 192648941a52SCarwyn Ellis#if defined(CONFIG_COCOA) 192748941a52SCarwyn Ellis "-display cocoa[,show-cursor=on|off][,left-command-key=on|off]\n" 192848941a52SCarwyn Ellis#endif 1929144aaa99SErik Skultety "-display none\n" 193088b40c68SThomas Huth " select display backend type\n" 1931f04ec5afSRobert Ho " The default display is equivalent to\n " 1932f04ec5afSRobert Ho#if defined(CONFIG_GTK) 193388b40c68SThomas Huth "\"-display gtk\"\n" 1934f04ec5afSRobert Ho#elif defined(CONFIG_SDL) 193588b40c68SThomas Huth "\"-display sdl\"\n" 1936f04ec5afSRobert Ho#elif defined(CONFIG_COCOA) 193788b40c68SThomas Huth "\"-display cocoa\"\n" 1938f04ec5afSRobert Ho#elif defined(CONFIG_VNC) 193988b40c68SThomas Huth "\"-vnc localhost:0,to=99,id=default\"\n" 1940f04ec5afSRobert Ho#else 194188b40c68SThomas Huth "\"-display none\"\n" 1942f04ec5afSRobert Ho#endif 1943f04ec5afSRobert Ho , QEMU_ARCH_ALL) 1944e2fcbf42SPeter MaydellSRST 1945e2fcbf42SPeter Maydell``-display type`` 1946e2fcbf42SPeter Maydell Select type of display to use. This option is a replacement for the 1947e2fcbf42SPeter Maydell old style -sdl/-curses/... options. Use ``-display help`` to list 1948e2fcbf42SPeter Maydell the available display types. Valid values for type are 1949e2fcbf42SPeter Maydell 1950ddc71758SAhmed Abouzied ``spice-app[,gl=on|off]`` 1951ddc71758SAhmed Abouzied Start QEMU as a Spice server and launch the default Spice client 1952ddc71758SAhmed Abouzied application. The Spice server will redirect the serial consoles 1953ddc71758SAhmed Abouzied and QEMU monitors. (Since 4.0) 1954ddc71758SAhmed Abouzied 1955142ca628SMarc-André Lureau ``dbus`` 1956142ca628SMarc-André Lureau Export the display over D-Bus interfaces. (Since 7.0) 1957142ca628SMarc-André Lureau 1958142ca628SMarc-André Lureau The connection is registered with the "org.qemu" name (and queued when 1959142ca628SMarc-André Lureau already owned). 1960142ca628SMarc-André Lureau 1961142ca628SMarc-André Lureau ``addr=<dbusaddr>`` : D-Bus bus address to connect to. 1962142ca628SMarc-André Lureau 196399997823SMarc-André Lureau ``p2p=yes|no`` : Use peer-to-peer connection, accepted via QMP ``add_client``. 196499997823SMarc-André Lureau 196599997823SMarc-André Lureau ``gl=on|off|core|es`` : Use OpenGL for rendering (the D-Bus interface 196699997823SMarc-André Lureau will share framebuffers with DMABUF file descriptors). 1967142ca628SMarc-André Lureau 196895f439bdSThomas Huth ``sdl`` 1969e2fcbf42SPeter Maydell Display video output via SDL (usually in a separate graphics 1970e2fcbf42SPeter Maydell window; see the SDL documentation for other possibilities). 197195f439bdSThomas Huth Valid parameters are: 1972e2fcbf42SPeter Maydell 19738e8e844bSThomas Huth ``grab-mod=<mods>`` : Used to select the modifier keys for toggling 1974450e0f28SJohn Snow the mouse grabbing in conjunction with the "g" key. ``<mods>`` can be 1975450e0f28SJohn Snow either ``lshift-lctrl-lalt`` or ``rctrl``. 19768e8e844bSThomas Huth 1977d46156fdSThomas Huth ``alt_grab=on|off`` : Use Control+Alt+Shift-g to toggle mouse grabbing. 1978d46156fdSThomas Huth This parameter is deprecated - use ``grab-mod`` instead. 197995f439bdSThomas Huth 1980d46156fdSThomas Huth ``ctrl_grab=on|off`` : Use Right-Control-g to toggle mouse grabbing. 1981d46156fdSThomas Huth This parameter is deprecated - use ``grab-mod`` instead. 198295f439bdSThomas Huth 198395f439bdSThomas Huth ``gl=on|off|core|es`` : Use OpenGL for displaying 198495f439bdSThomas Huth 198595f439bdSThomas Huth ``show-cursor=on|off`` : Force showing the mouse cursor 198695f439bdSThomas Huth 198795f439bdSThomas Huth ``window-close=on|off`` : Allow to quit qemu with window close button 198895f439bdSThomas Huth 198995f439bdSThomas Huth ``gtk`` 1990ddc71758SAhmed Abouzied Display video output in a GTK window. This interface provides 1991ddc71758SAhmed Abouzied drop-down menus and other UI elements to configure and control 199295f439bdSThomas Huth the VM during runtime. Valid parameters are: 199395f439bdSThomas Huth 199495f439bdSThomas Huth ``full-screen=on|off`` : Start in fullscreen mode 199595f439bdSThomas Huth 199695f439bdSThomas Huth ``gl=on|off`` : Use OpenGL for displaying 199795f439bdSThomas Huth 199895f439bdSThomas Huth ``grab-on-hover=on|off`` : Grab keyboard input on mouse hover 199995f439bdSThomas Huth 200095f439bdSThomas Huth ``show-cursor=on|off`` : Force showing the mouse cursor 200195f439bdSThomas Huth 200295f439bdSThomas Huth ``window-close=on|off`` : Allow to quit qemu with window close button 2003ddc71758SAhmed Abouzied 2004ddc71758SAhmed Abouzied ``curses[,charset=<encoding>]`` 2005e2fcbf42SPeter Maydell Display video output via curses. For graphics device models 2006e2fcbf42SPeter Maydell which support a text mode, QEMU can display this output using a 2007e2fcbf42SPeter Maydell curses/ncurses interface. Nothing is displayed when the graphics 2008e2fcbf42SPeter Maydell device is in graphical mode or if the graphics device does not 2009e2fcbf42SPeter Maydell support a text mode. Generally only the VGA device models 2010e2fcbf42SPeter Maydell support text mode. The font charset used by the guest can be 2011e2fcbf42SPeter Maydell specified with the ``charset`` option, for example 2012e2fcbf42SPeter Maydell ``charset=CP850`` for IBM CP850 encoding. The default is 2013e2fcbf42SPeter Maydell ``CP437``. 2014e2fcbf42SPeter Maydell 201548941a52SCarwyn Ellis ``cocoa`` 201648941a52SCarwyn Ellis Display video output in a Cocoa window. Mac only. This interface 201748941a52SCarwyn Ellis provides drop-down menus and other UI elements to configure and 201848941a52SCarwyn Ellis control the VM during runtime. Valid parameters are: 201948941a52SCarwyn Ellis 202048941a52SCarwyn Ellis ``show-cursor=on|off`` : Force showing the mouse cursor 202148941a52SCarwyn Ellis 202248941a52SCarwyn Ellis ``left-command-key=on|off`` : Disable forwarding left command key to host 202348941a52SCarwyn Ellis 202495f439bdSThomas Huth ``egl-headless[,rendernode=<file>]`` 2025ddc71758SAhmed Abouzied Offload all OpenGL operations to a local DRI device. For any 2026ddc71758SAhmed Abouzied graphical display, this display needs to be paired with either 2027ddc71758SAhmed Abouzied VNC or SPICE displays. 2028ddc71758SAhmed Abouzied 202995f439bdSThomas Huth ``vnc=<display>`` 203095f439bdSThomas Huth Start a VNC server on display <display> 203195f439bdSThomas Huth 2032e2fcbf42SPeter Maydell ``none`` 2033e2fcbf42SPeter Maydell Do not display video output. The guest will still see an 2034e2fcbf42SPeter Maydell emulated graphics card, but its output will not be displayed to 2035e2fcbf42SPeter Maydell the QEMU user. This option differs from the -nographic option in 2036e2fcbf42SPeter Maydell that it only affects what is done with video output; -nographic 2037e2fcbf42SPeter Maydell also changes the destination of the serial and parallel port 2038e2fcbf42SPeter Maydell data. 2039e2fcbf42SPeter MaydellERST 20401472a95bSJes Sorensen 20415824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 2042ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 2043ad96090aSBlue Swirl QEMU_ARCH_ALL) 2044e2fcbf42SPeter MaydellSRST 2045e2fcbf42SPeter Maydell``-nographic`` 2046e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2047e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2048e2fcbf42SPeter Maydell monitor in a window. With this option, you can totally disable 2049e2fcbf42SPeter Maydell graphical output so that QEMU is a simple command line application. 2050e2fcbf42SPeter Maydell The emulated serial port is redirected on the console and muxed with 2051e2fcbf42SPeter Maydell the monitor (unless redirected elsewhere explicitly). Therefore, you 2052e2fcbf42SPeter Maydell can still use QEMU to debug a Linux kernel with a serial console. 2053e2fcbf42SPeter Maydell Use C-a h for help on switching between the console and monitor. 2054e2fcbf42SPeter MaydellERST 20555824d651Sblueswir1 20565824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 2057f04ec5afSRobert Ho "-curses shorthand for -display curses\n", 2058ad96090aSBlue Swirl QEMU_ARCH_ALL) 2059e2fcbf42SPeter MaydellSRST 2060e2fcbf42SPeter Maydell``-curses`` 2061e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2062e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2063e2fcbf42SPeter Maydell monitor in a window. With this option, QEMU can display the VGA 2064e2fcbf42SPeter Maydell output when in text mode using a curses/ncurses interface. Nothing 2065e2fcbf42SPeter Maydell is displayed in graphical mode. 2066e2fcbf42SPeter MaydellERST 20675824d651Sblueswir1 20685824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 2069ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 2070ad96090aSBlue Swirl QEMU_ARCH_ALL) 2071e2fcbf42SPeter MaydellSRST 2072e2fcbf42SPeter Maydell``-alt-grab`` 2073e2fcbf42SPeter Maydell Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that 2074e2fcbf42SPeter Maydell this also affects the special keys (for fullscreen, monitor-mode 2075d46156fdSThomas Huth switching, etc). This option is deprecated - please use 2076d46156fdSThomas Huth ``-display sdl,grab-mod=lshift-lctrl-lalt`` instead. 2077e2fcbf42SPeter MaydellERST 20785824d651Sblueswir1 20790ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 2080ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 2081ad96090aSBlue Swirl QEMU_ARCH_ALL) 2082e2fcbf42SPeter MaydellSRST 2083e2fcbf42SPeter Maydell``-ctrl-grab`` 2084e2fcbf42SPeter Maydell Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this 2085e2fcbf42SPeter Maydell also affects the special keys (for fullscreen, monitor-mode 2086d46156fdSThomas Huth switching, etc). This option is deprecated - please use 2087d46156fdSThomas Huth ``-display sdl,grab-mod=rctrl`` instead. 2088e2fcbf42SPeter MaydellERST 20890ca9f8a4SDustin Kirkland 20905824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 2091f04ec5afSRobert Ho "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL) 2092e2fcbf42SPeter MaydellSRST 2093e2fcbf42SPeter Maydell``-sdl`` 2094e2fcbf42SPeter Maydell Enable SDL. 2095e2fcbf42SPeter MaydellERST 20965824d651Sblueswir1 20975324e3e9SMarc-André Lureau#ifdef CONFIG_SPICE 209829b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 209927af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 210027af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 210127af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 2102a9daa36aSDaniel P. Berrangé " [,x509-dh-key-file=<file>][,addr=addr]\n" 2103a9daa36aSDaniel P. Berrangé " [,ipv4=on|off][,ipv6=on|off][,unix=on|off]\n" 210427af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 210527af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 210627af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 210799522f69SDaniel P. Berrangé " [,sasl=on|off][,disable-ticketing=on|off]\n" 210899522f69SDaniel P. Berrangé " [,password=<string>][,password-secret=<secret-id>]\n" 210927af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 211027af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 211127af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 2112a9daa36aSDaniel P. Berrangé " [,streaming-video=[off|all|filter]][,disable-copy-paste=on|off]\n" 2113a9daa36aSDaniel P. Berrangé " [,disable-agent-file-xfer=on|off][,agent-mouse=[on|off]]\n" 21145ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 21157b525508SMarc-André Lureau " [,gl=[on|off]][,rendernode=<file>]\n" 211627af7788SYonit Halperin " enable spice\n" 211727af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 211827af7788SYonit Halperin QEMU_ARCH_ALL) 21195324e3e9SMarc-André Lureau#endif 2120e2fcbf42SPeter MaydellSRST 2121e2fcbf42SPeter Maydell``-spice option[,option[,...]]`` 2122e2fcbf42SPeter Maydell Enable the spice remote desktop protocol. Valid options are 2123e2fcbf42SPeter Maydell 2124e2fcbf42SPeter Maydell ``port=<nr>`` 2125e2fcbf42SPeter Maydell Set the TCP port spice is listening on for plaintext channels. 2126e2fcbf42SPeter Maydell 2127e2fcbf42SPeter Maydell ``addr=<addr>`` 2128e2fcbf42SPeter Maydell Set the IP address spice is listening on. Default is any 2129e2fcbf42SPeter Maydell address. 2130e2fcbf42SPeter Maydell 2131a9daa36aSDaniel P. Berrangé ``ipv4=on|off``; \ ``ipv6=on|off``; \ ``unix=on|off`` 2132e2fcbf42SPeter Maydell Force using the specified IP version. 2133e2fcbf42SPeter Maydell 213499522f69SDaniel P. Berrangé ``password=<string>`` 2135e2fcbf42SPeter Maydell Set the password you need to authenticate. 2136e2fcbf42SPeter Maydell 2137c47c0bcbSDaniel P. Berrangé This option is deprecated and insecure because it leaves the 2138c47c0bcbSDaniel P. Berrangé password visible in the process listing. Use ``password-secret`` 2139c47c0bcbSDaniel P. Berrangé instead. 2140c47c0bcbSDaniel P. Berrangé 214199522f69SDaniel P. Berrangé ``password-secret=<secret-id>`` 214299522f69SDaniel P. Berrangé Set the ID of the ``secret`` object containing the password 214399522f69SDaniel P. Berrangé you need to authenticate. 214499522f69SDaniel P. Berrangé 2145a9daa36aSDaniel P. Berrangé ``sasl=on|off`` 2146e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the spice. 2147e2fcbf42SPeter Maydell The exact choice of authentication method used is controlled 2148e2fcbf42SPeter Maydell from the system / user's SASL configuration file for the 'qemu' 2149e2fcbf42SPeter Maydell service. This is typically found in /etc/sasl2/qemu.conf. If 2150e2fcbf42SPeter Maydell running QEMU as an unprivileged user, an environment variable 2151e2fcbf42SPeter Maydell SASL\_CONF\_PATH can be used to make it search alternate 2152e2fcbf42SPeter Maydell locations for the service config. While some SASL auth methods 2153e2fcbf42SPeter Maydell can also provide data encryption (eg GSSAPI), it is recommended 2154e2fcbf42SPeter Maydell that SASL always be combined with the 'tls' and 'x509' settings 2155e2fcbf42SPeter Maydell to enable use of SSL and server certificates. This ensures a 2156e2fcbf42SPeter Maydell data encryption preventing compromise of authentication 2157e2fcbf42SPeter Maydell credentials. 2158e2fcbf42SPeter Maydell 2159a9daa36aSDaniel P. Berrangé ``disable-ticketing=on|off`` 2160e2fcbf42SPeter Maydell Allow client connects without authentication. 2161e2fcbf42SPeter Maydell 2162a9daa36aSDaniel P. Berrangé ``disable-copy-paste=on|off`` 2163e2fcbf42SPeter Maydell Disable copy paste between the client and the guest. 2164e2fcbf42SPeter Maydell 2165a9daa36aSDaniel P. Berrangé ``disable-agent-file-xfer=on|off`` 2166e2fcbf42SPeter Maydell Disable spice-vdagent based file-xfer between the client and the 2167e2fcbf42SPeter Maydell guest. 2168e2fcbf42SPeter Maydell 2169e2fcbf42SPeter Maydell ``tls-port=<nr>`` 2170e2fcbf42SPeter Maydell Set the TCP port spice is listening on for encrypted channels. 2171e2fcbf42SPeter Maydell 2172e2fcbf42SPeter Maydell ``x509-dir=<dir>`` 2173e2fcbf42SPeter Maydell Set the x509 file directory. Expects same filenames as -vnc 2174e2fcbf42SPeter Maydell $display,x509=$dir 2175e2fcbf42SPeter Maydell 2176e2fcbf42SPeter Maydell ``x509-key-file=<file>``; \ ``x509-key-password=<file>``; \ ``x509-cert-file=<file>``; \ ``x509-cacert-file=<file>``; \ ``x509-dh-key-file=<file>`` 2177e2fcbf42SPeter Maydell The x509 file names can also be configured individually. 2178e2fcbf42SPeter Maydell 2179e2fcbf42SPeter Maydell ``tls-ciphers=<list>`` 2180e2fcbf42SPeter Maydell Specify which ciphers to use. 2181e2fcbf42SPeter Maydell 2182e2fcbf42SPeter Maydell ``tls-channel=[main|display|cursor|inputs|record|playback]``; \ ``plaintext-channel=[main|display|cursor|inputs|record|playback]`` 2183e2fcbf42SPeter Maydell Force specific channel to be used with or without TLS 2184e2fcbf42SPeter Maydell encryption. The options can be specified multiple times to 2185e2fcbf42SPeter Maydell configure multiple channels. The special name "default" can be 2186e2fcbf42SPeter Maydell used to set the default mode. For channels which are not 2187e2fcbf42SPeter Maydell explicitly forced into one mode the spice client is allowed to 2188e2fcbf42SPeter Maydell pick tls/plaintext as he pleases. 2189e2fcbf42SPeter Maydell 2190e2fcbf42SPeter Maydell ``image-compression=[auto_glz|auto_lz|quic|glz|lz|off]`` 2191e2fcbf42SPeter Maydell Configure image compression (lossless). Default is auto\_glz. 2192e2fcbf42SPeter Maydell 2193e2fcbf42SPeter Maydell ``jpeg-wan-compression=[auto|never|always]``; \ ``zlib-glz-wan-compression=[auto|never|always]`` 2194e2fcbf42SPeter Maydell Configure wan image compression (lossy for slow links). Default 2195e2fcbf42SPeter Maydell is auto. 2196e2fcbf42SPeter Maydell 2197e2fcbf42SPeter Maydell ``streaming-video=[off|all|filter]`` 2198e2fcbf42SPeter Maydell Configure video stream detection. Default is off. 2199e2fcbf42SPeter Maydell 2200e2fcbf42SPeter Maydell ``agent-mouse=[on|off]`` 2201e2fcbf42SPeter Maydell Enable/disable passing mouse events via vdagent. Default is on. 2202e2fcbf42SPeter Maydell 2203e2fcbf42SPeter Maydell ``playback-compression=[on|off]`` 2204e2fcbf42SPeter Maydell Enable/disable audio stream compression (using celt 0.5.1). 2205e2fcbf42SPeter Maydell Default is on. 2206e2fcbf42SPeter Maydell 2207e2fcbf42SPeter Maydell ``seamless-migration=[on|off]`` 2208e2fcbf42SPeter Maydell Enable/disable spice seamless migration. Default is off. 2209e2fcbf42SPeter Maydell 2210e2fcbf42SPeter Maydell ``gl=[on|off]`` 2211e2fcbf42SPeter Maydell Enable/disable OpenGL context. Default is off. 2212e2fcbf42SPeter Maydell 2213e2fcbf42SPeter Maydell ``rendernode=<file>`` 2214e2fcbf42SPeter Maydell DRM render node for OpenGL rendering. If not specified, it will 2215e2fcbf42SPeter Maydell pick the first available. (Since 2.9) 2216e2fcbf42SPeter MaydellERST 221729b0040bSGerd Hoffmann 22185824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 2219ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 2220ad96090aSBlue Swirl QEMU_ARCH_ALL) 2221e2fcbf42SPeter MaydellSRST 2222e2fcbf42SPeter Maydell``-portrait`` 2223e2fcbf42SPeter Maydell Rotate graphical output 90 deg left (only PXA LCD). 2224e2fcbf42SPeter MaydellERST 22255824d651Sblueswir1 22269312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 22279312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 22289312805dSVasily Khoruzhick QEMU_ARCH_ALL) 2229e2fcbf42SPeter MaydellSRST 2230e2fcbf42SPeter Maydell``-rotate deg`` 2231e2fcbf42SPeter Maydell Rotate graphical output some deg left (only PXA LCD). 2232e2fcbf42SPeter MaydellERST 22339312805dSVasily Khoruzhick 22345824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 2235a94f0c5cSGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 2236ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 2237e2fcbf42SPeter MaydellSRST 2238e2fcbf42SPeter Maydell``-vga type`` 2239e2fcbf42SPeter Maydell Select type of VGA card to emulate. Valid values for type are 2240e2fcbf42SPeter Maydell 2241e2fcbf42SPeter Maydell ``cirrus`` 2242e2fcbf42SPeter Maydell Cirrus Logic GD5446 Video card. All Windows versions starting 2243e2fcbf42SPeter Maydell from Windows 95 should recognize and use this graphic card. For 2244e2fcbf42SPeter Maydell optimal performances, use 16 bit color depth in the guest and 2245e2fcbf42SPeter Maydell the host OS. (This card was the default before QEMU 2.2) 2246e2fcbf42SPeter Maydell 2247e2fcbf42SPeter Maydell ``std`` 2248e2fcbf42SPeter Maydell Standard VGA card with Bochs VBE extensions. If your guest OS 2249e2fcbf42SPeter Maydell supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if 2250e2fcbf42SPeter Maydell you want to use high resolution modes (>= 1280x1024x16) then you 2251e2fcbf42SPeter Maydell should use this option. (This card is the default since QEMU 2252e2fcbf42SPeter Maydell 2.2) 2253e2fcbf42SPeter Maydell 2254e2fcbf42SPeter Maydell ``vmware`` 2255e2fcbf42SPeter Maydell VMWare SVGA-II compatible adapter. Use it if you have 2256e2fcbf42SPeter Maydell sufficiently recent XFree86/XOrg server or Windows guest with a 2257e2fcbf42SPeter Maydell driver for this card. 2258e2fcbf42SPeter Maydell 2259e2fcbf42SPeter Maydell ``qxl`` 2260e2fcbf42SPeter Maydell QXL paravirtual graphic card. It is VGA compatible (including 2261e2fcbf42SPeter Maydell VESA 2.0 VBE support). Works best with qxl guest drivers 2262e2fcbf42SPeter Maydell installed though. Recommended choice when using the spice 2263e2fcbf42SPeter Maydell protocol. 2264e2fcbf42SPeter Maydell 2265e2fcbf42SPeter Maydell ``tcx`` 2266e2fcbf42SPeter Maydell (sun4m only) Sun TCX framebuffer. This is the default 2267e2fcbf42SPeter Maydell framebuffer for sun4m machines and offers both 8-bit and 24-bit 2268e2fcbf42SPeter Maydell colour depths at a fixed resolution of 1024x768. 2269e2fcbf42SPeter Maydell 2270e2fcbf42SPeter Maydell ``cg3`` 2271e2fcbf42SPeter Maydell (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit 2272e2fcbf42SPeter Maydell framebuffer for sun4m machines available in both 1024x768 2273e2fcbf42SPeter Maydell (OpenBIOS) and 1152x900 (OBP) resolutions aimed at people 2274e2fcbf42SPeter Maydell wishing to run older Solaris versions. 2275e2fcbf42SPeter Maydell 2276e2fcbf42SPeter Maydell ``virtio`` 2277e2fcbf42SPeter Maydell Virtio VGA card. 2278e2fcbf42SPeter Maydell 2279e2fcbf42SPeter Maydell ``none`` 2280e2fcbf42SPeter Maydell Disable VGA card. 2281e2fcbf42SPeter MaydellERST 22825824d651Sblueswir1 22835824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 2284ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 2285e2fcbf42SPeter MaydellSRST 2286e2fcbf42SPeter Maydell``-full-screen`` 2287e2fcbf42SPeter Maydell Start in full screen. 2288e2fcbf42SPeter MaydellERST 22895824d651Sblueswir1 229060f9a4efSJohn SnowDEF("g", HAS_ARG, QEMU_OPTION_g , 2291ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 22928ac919a0SLaurent Vivier QEMU_ARCH_PPC | QEMU_ARCH_SPARC | QEMU_ARCH_M68K) 2293e2fcbf42SPeter MaydellSRST 229409ce5f2dSPeter Maydell``-g`` *width*\ ``x``\ *height*\ ``[x``\ *depth*\ ``]`` 2295e2fcbf42SPeter Maydell Set the initial graphical resolution and depth (PPC, SPARC only). 2296e2fcbf42SPeter Maydell 2297e2fcbf42SPeter Maydell For PPC the default is 800x600x32. 2298e2fcbf42SPeter Maydell 2299e2fcbf42SPeter Maydell For SPARC with the TCX graphics device, the default is 1024x768x8 2300e2fcbf42SPeter Maydell with the option of 1024x768x24. For cgthree, the default is 2301e2fcbf42SPeter Maydell 1024x768x8 with the option of 1152x900x8 for people who wish to use 2302e2fcbf42SPeter Maydell OBP. 2303e2fcbf42SPeter MaydellERST 23045824d651Sblueswir1 23055824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 2306f04ec5afSRobert Ho "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL) 2307e2fcbf42SPeter MaydellSRST 2308e2fcbf42SPeter Maydell``-vnc display[,option[,option[,...]]]`` 2309e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2310e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2311e2fcbf42SPeter Maydell monitor in a window. With this option, you can have QEMU listen on 2312e2fcbf42SPeter Maydell VNC display display and redirect the VGA display over the VNC 2313e2fcbf42SPeter Maydell session. It is very useful to enable the usb tablet device when 2314e2fcbf42SPeter Maydell using this option (option ``-device usb-tablet``). When using the 2315e2fcbf42SPeter Maydell VNC display, you must use the ``-k`` parameter to set the keyboard 2316e2fcbf42SPeter Maydell layout if you are not using en-us. Valid syntax for the display is 2317e2fcbf42SPeter Maydell 2318e2fcbf42SPeter Maydell ``to=L`` 2319e2fcbf42SPeter Maydell With this option, QEMU will try next available VNC displays, 2320e2fcbf42SPeter Maydell until the number L, if the origianlly defined "-vnc display" is 2321e2fcbf42SPeter Maydell not available, e.g. port 5900+display is already used by another 2322e2fcbf42SPeter Maydell application. By default, to=0. 2323e2fcbf42SPeter Maydell 2324e2fcbf42SPeter Maydell ``host:d`` 2325e2fcbf42SPeter Maydell TCP connections will only be allowed from host on display d. By 2326e2fcbf42SPeter Maydell convention the TCP port is 5900+d. Optionally, host can be 2327e2fcbf42SPeter Maydell omitted in which case the server will accept connections from 2328e2fcbf42SPeter Maydell any host. 2329e2fcbf42SPeter Maydell 2330e2fcbf42SPeter Maydell ``unix:path`` 2331e2fcbf42SPeter Maydell Connections will be allowed over UNIX domain sockets where path 2332e2fcbf42SPeter Maydell is the location of a unix socket to listen for connections on. 2333e2fcbf42SPeter Maydell 2334e2fcbf42SPeter Maydell ``none`` 2335e2fcbf42SPeter Maydell VNC is initialized but not started. The monitor ``change`` 2336e2fcbf42SPeter Maydell command can be used to later start the VNC server. 2337e2fcbf42SPeter Maydell 2338e2fcbf42SPeter Maydell Following the display value there may be one or more option flags 2339e2fcbf42SPeter Maydell separated by commas. Valid options are 2340e2fcbf42SPeter Maydell 234182a17d1dSDaniel P. Berrangé ``reverse=on|off`` 2342e2fcbf42SPeter Maydell Connect to a listening VNC client via a "reverse" connection. 2343e2fcbf42SPeter Maydell The client is specified by the display. For reverse network 2344e2fcbf42SPeter Maydell connections (host:d,``reverse``), the d argument is a TCP port 2345e2fcbf42SPeter Maydell number, not a display number. 2346e2fcbf42SPeter Maydell 234782a17d1dSDaniel P. Berrangé ``websocket=on|off`` 2348e2fcbf42SPeter Maydell Opens an additional TCP listening port dedicated to VNC 2349e2fcbf42SPeter Maydell Websocket connections. If a bare websocket option is given, the 2350e2fcbf42SPeter Maydell Websocket port is 5700+display. An alternative port can be 2351e2fcbf42SPeter Maydell specified with the syntax ``websocket``\ =port. 2352e2fcbf42SPeter Maydell 2353e2fcbf42SPeter Maydell If host is specified connections will only be allowed from this 2354e2fcbf42SPeter Maydell host. It is possible to control the websocket listen address 2355e2fcbf42SPeter Maydell independently, using the syntax ``websocket``\ =host:port. 2356e2fcbf42SPeter Maydell 2357e2fcbf42SPeter Maydell If no TLS credentials are provided, the websocket connection 2358e2fcbf42SPeter Maydell runs in unencrypted mode. If TLS credentials are provided, the 2359e2fcbf42SPeter Maydell websocket connection requires encrypted client connections. 2360e2fcbf42SPeter Maydell 236182a17d1dSDaniel P. Berrangé ``password=on|off`` 2362e2fcbf42SPeter Maydell Require that password based authentication is used for client 2363e2fcbf42SPeter Maydell connections. 2364e2fcbf42SPeter Maydell 2365e2fcbf42SPeter Maydell The password must be set separately using the ``set_password`` 2366923e9311SThomas Huth command in the :ref:`QEMU monitor`. The 2367e2fcbf42SPeter Maydell syntax to change your password is: 2368e2fcbf42SPeter Maydell ``set_password <protocol> <password>`` where <protocol> could be 2369e2fcbf42SPeter Maydell either "vnc" or "spice". 2370e2fcbf42SPeter Maydell 2371e2fcbf42SPeter Maydell If you would like to change <protocol> password expiration, you 2372e2fcbf42SPeter Maydell should use ``expire_password <protocol> <expiration-time>`` 2373e2fcbf42SPeter Maydell where expiration time could be one of the following options: 2374e2fcbf42SPeter Maydell now, never, +seconds or UNIX time of expiration, e.g. +60 to 2375e2fcbf42SPeter Maydell make password expire in 60 seconds, or 1335196800 to make 2376e2fcbf42SPeter Maydell password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for 2377e2fcbf42SPeter Maydell this date and time). 2378e2fcbf42SPeter Maydell 2379e2fcbf42SPeter Maydell You can also use keywords "now" or "never" for the expiration 2380e2fcbf42SPeter Maydell time to allow <protocol> password to expire immediately or never 2381e2fcbf42SPeter Maydell expire. 2382e2fcbf42SPeter Maydell 23836c6840e9SDaniel P. Berrangé ``password-secret=<secret-id>`` 23846c6840e9SDaniel P. Berrangé Require that password based authentication is used for client 23856c6840e9SDaniel P. Berrangé connections, using the password provided by the ``secret`` 23866c6840e9SDaniel P. Berrangé object identified by ``secret-id``. 23876c6840e9SDaniel P. Berrangé 2388e2fcbf42SPeter Maydell ``tls-creds=ID`` 2389e2fcbf42SPeter Maydell Provides the ID of a set of TLS credentials to use to secure the 2390e2fcbf42SPeter Maydell VNC server. They will apply to both the normal VNC server socket 2391e2fcbf42SPeter Maydell and the websocket socket (if enabled). Setting TLS credentials 2392e2fcbf42SPeter Maydell will cause the VNC server socket to enable the VeNCrypt auth 2393e2fcbf42SPeter Maydell mechanism. The credentials should have been previously created 2394e2fcbf42SPeter Maydell using the ``-object tls-creds`` argument. 2395e2fcbf42SPeter Maydell 2396e2fcbf42SPeter Maydell ``tls-authz=ID`` 2397e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2398e2fcbf42SPeter Maydell the client's x509 distinguished name will validated. This object 2399e2fcbf42SPeter Maydell is only resolved at time of use, so can be deleted and recreated 2400e2fcbf42SPeter Maydell on the fly while the VNC server is active. If missing, it will 2401e2fcbf42SPeter Maydell default to denying access. 2402e2fcbf42SPeter Maydell 240382a17d1dSDaniel P. Berrangé ``sasl=on|off`` 2404e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the VNC 2405e2fcbf42SPeter Maydell server. The exact choice of authentication method used is 2406e2fcbf42SPeter Maydell controlled from the system / user's SASL configuration file for 2407e2fcbf42SPeter Maydell the 'qemu' service. This is typically found in 2408e2fcbf42SPeter Maydell /etc/sasl2/qemu.conf. If running QEMU as an unprivileged user, 2409e2fcbf42SPeter Maydell an environment variable SASL\_CONF\_PATH can be used to make it 2410e2fcbf42SPeter Maydell search alternate locations for the service config. While some 2411e2fcbf42SPeter Maydell SASL auth methods can also provide data encryption (eg GSSAPI), 2412e2fcbf42SPeter Maydell it is recommended that SASL always be combined with the 'tls' 2413e2fcbf42SPeter Maydell and 'x509' settings to enable use of SSL and server 2414e2fcbf42SPeter Maydell certificates. This ensures a data encryption preventing 2415e2fcbf42SPeter Maydell compromise of authentication credentials. See the 2416923e9311SThomas Huth :ref:`VNC security` section in the System Emulation Users Guide 2417923e9311SThomas Huth for details on using SASL authentication. 2418e2fcbf42SPeter Maydell 2419e2fcbf42SPeter Maydell ``sasl-authz=ID`` 2420e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2421e2fcbf42SPeter Maydell the client's SASL username will validated. This object is only 2422e2fcbf42SPeter Maydell resolved at time of use, so can be deleted and recreated on the 2423e2fcbf42SPeter Maydell fly while the VNC server is active. If missing, it will default 2424e2fcbf42SPeter Maydell to denying access. 2425e2fcbf42SPeter Maydell 242682a17d1dSDaniel P. Berrangé ``acl=on|off`` 2427e2fcbf42SPeter Maydell Legacy method for enabling authorization of clients against the 2428e2fcbf42SPeter Maydell x509 distinguished name and SASL username. It results in the 2429e2fcbf42SPeter Maydell creation of two ``authz-list`` objects with IDs of 2430e2fcbf42SPeter Maydell ``vnc.username`` and ``vnc.x509dname``. The rules for these 2431e2fcbf42SPeter Maydell objects must be configured with the HMP ACL commands. 2432e2fcbf42SPeter Maydell 2433e2fcbf42SPeter Maydell This option is deprecated and should no longer be used. The new 2434e2fcbf42SPeter Maydell ``sasl-authz`` and ``tls-authz`` options are a replacement. 2435e2fcbf42SPeter Maydell 243682a17d1dSDaniel P. Berrangé ``lossy=on|off`` 2437e2fcbf42SPeter Maydell Enable lossy compression methods (gradient, JPEG, ...). If this 2438e2fcbf42SPeter Maydell option is set, VNC client may receive lossy framebuffer updates 2439e2fcbf42SPeter Maydell depending on its encoding settings. Enabling this option can 2440e2fcbf42SPeter Maydell save a lot of bandwidth at the expense of quality. 2441e2fcbf42SPeter Maydell 244282a17d1dSDaniel P. Berrangé ``non-adaptive=on|off`` 2443e2fcbf42SPeter Maydell Disable adaptive encodings. Adaptive encodings are enabled by 2444e2fcbf42SPeter Maydell default. An adaptive encoding will try to detect frequently 2445e2fcbf42SPeter Maydell updated screen regions, and send updates in these regions using 2446e2fcbf42SPeter Maydell a lossy encoding (like JPEG). This can be really helpful to save 2447e2fcbf42SPeter Maydell bandwidth when playing videos. Disabling adaptive encodings 2448e2fcbf42SPeter Maydell restores the original static behavior of encodings like Tight. 2449e2fcbf42SPeter Maydell 2450e2fcbf42SPeter Maydell ``share=[allow-exclusive|force-shared|ignore]`` 2451e2fcbf42SPeter Maydell Set display sharing policy. 'allow-exclusive' allows clients to 2452e2fcbf42SPeter Maydell ask for exclusive access. As suggested by the rfb spec this is 2453e2fcbf42SPeter Maydell implemented by dropping other connections. Connecting multiple 2454e2fcbf42SPeter Maydell clients in parallel requires all clients asking for a shared 2455e2fcbf42SPeter Maydell session (vncviewer: -shared switch). This is the default. 2456e2fcbf42SPeter Maydell 'force-shared' disables exclusive client access. Useful for 2457e2fcbf42SPeter Maydell shared desktop sessions, where you don't want someone forgetting 2458e2fcbf42SPeter Maydell specify -shared disconnect everybody else. 'ignore' completely 2459e2fcbf42SPeter Maydell ignores the shared flag and allows everybody connect 2460e2fcbf42SPeter Maydell unconditionally. Doesn't conform to the rfb spec but is 2461e2fcbf42SPeter Maydell traditional QEMU behavior. 2462e2fcbf42SPeter Maydell 2463e2fcbf42SPeter Maydell ``key-delay-ms`` 2464e2fcbf42SPeter Maydell Set keyboard delay, for key down and key up events, in 2465e2fcbf42SPeter Maydell milliseconds. Default is 10. Keyboards are low-bandwidth 2466e2fcbf42SPeter Maydell devices, so this slowdown can help the device and guest to keep 2467e2fcbf42SPeter Maydell up and not lose events in case events are arriving in bulk. 2468e2fcbf42SPeter Maydell Possible causes for the latter are flaky network connections, or 2469e2fcbf42SPeter Maydell scripts for automated testing. 2470e2fcbf42SPeter Maydell 2471e2fcbf42SPeter Maydell ``audiodev=audiodev`` 2472e2fcbf42SPeter Maydell Use the specified audiodev when the VNC client requests audio 2473e2fcbf42SPeter Maydell transmission. When not using an -audiodev argument, this option 2474e2fcbf42SPeter Maydell must be omitted, otherwise is must be present and specify a 2475e2fcbf42SPeter Maydell valid audiodev. 24767b5fa0b5SDaniel P. Berrangé 247782a17d1dSDaniel P. Berrangé ``power-control=on|off`` 24787b5fa0b5SDaniel P. Berrangé Permit the remote client to issue shutdown, reboot or reset power 24797b5fa0b5SDaniel P. Berrangé control requests. 2480e2fcbf42SPeter MaydellERST 24815824d651Sblueswir1 2482a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 24835824d651Sblueswir1 2484de6b4f90SMarkus ArmbrusterARCHHEADING(i386 target only:, QEMU_ARCH_I386) 24855824d651Sblueswir1 24865824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 2487ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 2488ad96090aSBlue Swirl QEMU_ARCH_I386) 2489e2fcbf42SPeter MaydellSRST 2490e2fcbf42SPeter Maydell``-win2k-hack`` 2491e2fcbf42SPeter Maydell Use it when installing Windows 2000 to avoid a disk full bug. After 2492e2fcbf42SPeter Maydell Windows 2000 is installed, you no longer need this option (this 2493e2fcbf42SPeter Maydell option slows down the IDE transfers). 2494e2fcbf42SPeter MaydellERST 24955824d651Sblueswir1 24965824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 2497ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 2498ad96090aSBlue Swirl QEMU_ARCH_I386) 2499e2fcbf42SPeter MaydellSRST 2500e2fcbf42SPeter Maydell``-no-fd-bootchk`` 2501e2fcbf42SPeter Maydell Disable boot signature checking for floppy disks in BIOS. May be 2502e2fcbf42SPeter Maydell needed to boot from old floppy disks. 2503e2fcbf42SPeter MaydellERST 25045824d651Sblueswir1 25055824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 2506f5d8c8cdSShannon Zhao "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2507e2fcbf42SPeter MaydellSRST 2508e2fcbf42SPeter Maydell``-no-acpi`` 2509e2fcbf42SPeter Maydell Disable ACPI (Advanced Configuration and Power Interface) support. 2510e2fcbf42SPeter Maydell Use it if your guest OS complains about ACPI problems (PC target 2511e2fcbf42SPeter Maydell machine only). 2512e2fcbf42SPeter MaydellERST 25135824d651Sblueswir1 25145824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 2515ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 2516e2fcbf42SPeter MaydellSRST 2517e2fcbf42SPeter Maydell``-no-hpet`` 2518e2fcbf42SPeter Maydell Disable HPET support. 2519e2fcbf42SPeter MaydellERST 25205824d651Sblueswir1 25215824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 2522104bf02eSMichael 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" 2523ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 2524e2fcbf42SPeter MaydellSRST 2525e2fcbf42SPeter 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]...]`` 2526e2fcbf42SPeter Maydell Add ACPI table with specified header fields and context from 2527e2fcbf42SPeter Maydell specified files. For file=, take whole ACPI table from the specified 2528e2fcbf42SPeter Maydell files, including all ACPI headers (possible overridden by other 2529e2fcbf42SPeter Maydell options). For data=, only data portion of the table is used, all 2530e2fcbf42SPeter Maydell header information is specified in the command line. If a SLIC table 2531e2fcbf42SPeter Maydell is supplied to QEMU, then the SLIC's oem\_id and oem\_table\_id 2532e2fcbf42SPeter Maydell fields will override the same in the RSDT and the FADT (a.k.a. 2533e2fcbf42SPeter Maydell FACP), in order to ensure the field matches required by the 2534e2fcbf42SPeter Maydell Microsoft SLIC spec and the ACPI spec. 2535e2fcbf42SPeter MaydellERST 25365824d651Sblueswir1 2537b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 2538b6f6e3d3Saliguori "-smbios file=binary\n" 2539ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 2540b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 2541b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 2542ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 2543b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2544b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 2545b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 2546b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2547b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 2548b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 2549b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 2550b155eb1dSGabriel L. Somlo " [,sku=str]\n" 2551b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 2552b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 2553c906e039SYing Fang " [,asset=str][,part=str][,max-speed=%d][,current-speed=%d]\n" 2554cb5fb04fSPatrick Venture " [,processor-id=%d]\n" 2555b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 255648a7ff4dSDaniel P. Berrangé "-smbios type=11[,value=str][,path=filename]\n" 255748a7ff4dSDaniel P. Berrangé " specify SMBIOS type 11 fields\n" 2558b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 25593ebd6cc8SGabriel L. Somlo " [,asset=str][,part=str][,speed=%d]\n" 256005dfb447SVincent Bernat " specify SMBIOS type 17 fields\n" 256105dfb447SVincent Bernat "-smbios type=41[,designation=str][,kind=str][,instance=%d][,pcidev=str]\n" 256205dfb447SVincent Bernat " specify SMBIOS type 41 fields\n", 2563c30e1565SWei Huang QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2564e2fcbf42SPeter MaydellSRST 2565e2fcbf42SPeter Maydell``-smbios file=binary`` 2566e2fcbf42SPeter Maydell Load SMBIOS entry from binary file. 2567e2fcbf42SPeter Maydell 2568e2fcbf42SPeter Maydell``-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]`` 2569e2fcbf42SPeter Maydell Specify SMBIOS type 0 fields 2570e2fcbf42SPeter Maydell 2571e2fcbf42SPeter Maydell``-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str]`` 2572e2fcbf42SPeter Maydell Specify SMBIOS type 1 fields 2573e2fcbf42SPeter Maydell 2574e2fcbf42SPeter Maydell``-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str][,asset=str][,location=str]`` 2575e2fcbf42SPeter Maydell Specify SMBIOS type 2 fields 2576e2fcbf42SPeter Maydell 2577e2fcbf42SPeter Maydell``-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str][,sku=str]`` 2578e2fcbf42SPeter Maydell Specify SMBIOS type 3 fields 2579e2fcbf42SPeter Maydell 2580cb5fb04fSPatrick Venture``-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str][,asset=str][,part=str][,processor-id=%d]`` 2581e2fcbf42SPeter Maydell Specify SMBIOS type 4 fields 2582e2fcbf42SPeter Maydell 258348a7ff4dSDaniel P. Berrangé``-smbios type=11[,value=str][,path=filename]`` 258448a7ff4dSDaniel P. Berrangé Specify SMBIOS type 11 fields 258548a7ff4dSDaniel P. Berrangé 258648a7ff4dSDaniel P. Berrangé This argument can be repeated multiple times, and values are added in the order they are parsed. 258748a7ff4dSDaniel P. Berrangé Applications intending to use OEM strings data are encouraged to use their application name as 258848a7ff4dSDaniel P. Berrangé a prefix for the value string. This facilitates passing information for multiple applications 258948a7ff4dSDaniel P. Berrangé concurrently. 259048a7ff4dSDaniel P. Berrangé 259148a7ff4dSDaniel P. Berrangé The ``value=str`` syntax provides the string data inline, while the ``path=filename`` syntax 259248a7ff4dSDaniel P. Berrangé loads data from a file on disk. Note that the file is not permitted to contain any NUL bytes. 259348a7ff4dSDaniel P. Berrangé 259448a7ff4dSDaniel P. Berrangé Both the ``value`` and ``path`` options can be repeated multiple times and will be added to 259548a7ff4dSDaniel P. Berrangé the SMBIOS table in the order in which they appear. 259648a7ff4dSDaniel P. Berrangé 259748a7ff4dSDaniel P. Berrangé Note that on the x86 architecture, the total size of all SMBIOS tables is limited to 65535 259848a7ff4dSDaniel P. Berrangé bytes. Thus the OEM strings data is not suitable for passing large amounts of data into the 259948a7ff4dSDaniel P. Berrangé guest. Instead it should be used as a indicator to inform the guest where to locate the real 260048a7ff4dSDaniel P. Berrangé data set, for example, by specifying the serial ID of a block device. 260148a7ff4dSDaniel P. Berrangé 260248a7ff4dSDaniel P. Berrangé An example passing three strings is 260348a7ff4dSDaniel P. Berrangé 260448a7ff4dSDaniel P. Berrangé .. parsed-literal:: 260548a7ff4dSDaniel P. Berrangé 260648a7ff4dSDaniel P. Berrangé -smbios type=11,value=cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/,\\ 260748a7ff4dSDaniel P. Berrangé value=anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os,\\ 260848a7ff4dSDaniel P. Berrangé path=/some/file/with/oemstringsdata.txt 260948a7ff4dSDaniel P. Berrangé 261048a7ff4dSDaniel P. Berrangé In the guest OS this is visible with the ``dmidecode`` command 261148a7ff4dSDaniel P. Berrangé 261248a7ff4dSDaniel P. Berrangé .. parsed-literal:: 261348a7ff4dSDaniel P. Berrangé 261448a7ff4dSDaniel P. Berrangé $ dmidecode -t 11 261548a7ff4dSDaniel P. Berrangé Handle 0x0E00, DMI type 11, 5 bytes 261648a7ff4dSDaniel P. Berrangé OEM Strings 261748a7ff4dSDaniel P. Berrangé String 1: cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/ 261848a7ff4dSDaniel P. Berrangé String 2: anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os 261948a7ff4dSDaniel P. Berrangé String 3: myapp:some extra data 262048a7ff4dSDaniel P. Berrangé 262148a7ff4dSDaniel P. Berrangé 2622e2fcbf42SPeter Maydell``-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str][,asset=str][,part=str][,speed=%d]`` 2623e2fcbf42SPeter Maydell Specify SMBIOS type 17 fields 262405dfb447SVincent Bernat 262505dfb447SVincent Bernat``-smbios type=41[,designation=str][,kind=str][,instance=%d][,pcidev=str]`` 262605dfb447SVincent Bernat Specify SMBIOS type 41 fields 262705dfb447SVincent Bernat 262805dfb447SVincent Bernat This argument can be repeated multiple times. Its main use is to allow network interfaces be created 262905dfb447SVincent Bernat as ``enoX`` on Linux, with X being the instance number, instead of the name depending on the interface 263005dfb447SVincent Bernat position on the PCI bus. 263105dfb447SVincent Bernat 263205dfb447SVincent Bernat Here is an example of use: 263305dfb447SVincent Bernat 263405dfb447SVincent Bernat .. parsed-literal:: 263505dfb447SVincent Bernat 263605dfb447SVincent Bernat -netdev user,id=internet \\ 263705dfb447SVincent Bernat -device virtio-net-pci,mac=50:54:00:00:00:42,netdev=internet,id=internet-dev \\ 263805dfb447SVincent Bernat -smbios type=41,designation='Onboard LAN',instance=1,kind=ethernet,pcidev=internet-dev 263905dfb447SVincent Bernat 264005dfb447SVincent Bernat In the guest OS, the device should then appear as ``eno1``: 264105dfb447SVincent Bernat 264205dfb447SVincent Bernat ..parsed-literal:: 264305dfb447SVincent Bernat 264405dfb447SVincent Bernat $ ip -brief l 264505dfb447SVincent Bernat lo UNKNOWN 00:00:00:00:00:00 <LOOPBACK,UP,LOWER_UP> 264605dfb447SVincent Bernat eno1 UP 50:54:00:00:00:42 <BROADCAST,MULTICAST,UP,LOWER_UP> 264705dfb447SVincent Bernat 264805dfb447SVincent Bernat Currently, the PCI device has to be attached to the root bus. 264905dfb447SVincent Bernat 2650e2fcbf42SPeter MaydellERST 2651b6f6e3d3Saliguori 2652c70a01e4SMarkus ArmbrusterDEFHEADING() 26535824d651Sblueswir1 2654de6b4f90SMarkus ArmbrusterDEFHEADING(Network options:) 26555824d651Sblueswir1 26566a8b4a5bSThomas HuthDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 26575824d651Sblueswir1#ifdef CONFIG_SLIRP 26588b0dc246SDaniel P. Berrangé "-netdev user,id=str[,ipv4=on|off][,net=addr[/mask]][,host=addr]\n" 26598b0dc246SDaniel P. Berrangé " [,ipv6=on|off][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 26600b11c036SSamuel Thibault " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 2661f18d1375SBenjamin Drung " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n" 26620fca92b9SFam Zheng " [,tftp=dir][,tftp-server-name=name][,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 2663ad196a9dSJan Kiszka#ifndef _WIN32 2664c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 2665ad196a9dSJan Kiszka#endif 26666a8b4a5bSThomas Huth " configure a user mode network backend with ID 'str',\n" 26676a8b4a5bSThomas Huth " its DHCP server and optional services\n" 26685824d651Sblueswir1#endif 26695824d651Sblueswir1#ifdef _WIN32 26706a8b4a5bSThomas Huth "-netdev tap,id=str,ifname=name\n" 26716a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 26725824d651Sblueswir1#else 26736a8b4a5bSThomas Huth "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 2674584613eaSAlexey Kardashevskiy " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 26756a8b4a5bSThomas Huth " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 267669e87b32SJason Wang " [,poll-us=n]\n" 26776a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 2678584613eaSAlexey Kardashevskiy " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 2679a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 2680a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 2681a7c36ee4SCorey Bryant " to deconfigure it\n" 2682ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 2683a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 2684a7c36ee4SCorey Bryant " configure it\n" 26855824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 26862ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 2687ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 2688f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 2689ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 2690ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 269182b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 26925430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 26935430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 269482b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 26952ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 2696ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 2697cba42d61SMichael Tokarev " use 'poll-us=n' to specify the maximum number of microseconds that could be\n" 269869e87b32SJason Wang " spent on busy polling for vhost net\n" 26996a8b4a5bSThomas Huth "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 27006a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str' that is\n" 27016a8b4a5bSThomas Huth " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 27026a8b4a5bSThomas Huth " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 27030df0ff6dSMark McLoughlin#endif 27043fb69aa1SAnton Ivanov#ifdef __linux__ 27056a8b4a5bSThomas Huth "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 27068b0dc246SDaniel P. Berrangé " [,rxsession=rxsession],txsession=txsession[,ipv6=on|off][,udp=on|off]\n" 27078b0dc246SDaniel P. Berrangé " [,cookie64=on|off][,counter][,pincounter][,txcookie=txcookie]\n" 27086a8b4a5bSThomas Huth " [,rxcookie=rxcookie][,offset=offset]\n" 27096a8b4a5bSThomas Huth " configure a network backend with ID 'str' connected to\n" 27106a8b4a5bSThomas Huth " an Ethernet over L2TPv3 pseudowire.\n" 27113fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 27122f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 27133fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 271421843dc4SStefan Hajnoczi " standard (RFC3931). Note - this implementation uses static\n" 27153fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 27163fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 27173fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 27183fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 27193952651aSGonglei " use 'srcport=' to specify source udp port\n" 27203fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 27213fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 27223fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 27233fb69aa1SAnton Ivanov " well as a weak security measure\n" 27243fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 27253fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 27263fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 27273fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 27283fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 27293fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 27303fb69aa1SAnton Ivanov#endif 27316a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 27326a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 27336a8b4a5bSThomas Huth " using a socket connection\n" 27346a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 27356a8b4a5bSThomas Huth " configure a network backend to connect to a multicast maddr and port\n" 27363a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 27376a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 27386a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 27396a8b4a5bSThomas Huth " using an UDP tunnel\n" 27405824d651Sblueswir1#ifdef CONFIG_VDE 27416a8b4a5bSThomas Huth "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 27426a8b4a5bSThomas Huth " configure a network backend to connect to port 'n' of a vde switch\n" 27436a8b4a5bSThomas Huth " running on host and listening for incoming connections on 'socketpath'.\n" 27445824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 27455824d651Sblueswir1 " ownership and permissions for communication port.\n" 27465824d651Sblueswir1#endif 274758952137SVincenzo Maffione#ifdef CONFIG_NETMAP 27486a8b4a5bSThomas Huth "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 274958952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 275058952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 275158952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 275258952137SVincenzo Maffione#endif 2753253dc14cSThomas Huth#ifdef CONFIG_POSIX 27546a8b4a5bSThomas Huth "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 27556a8b4a5bSThomas Huth " configure a vhost-user network, backed by a chardev 'dev'\n" 2756253dc14cSThomas Huth#endif 2757108a6481SCindy Lu#ifdef __linux__ 2758108a6481SCindy Lu "-netdev vhost-vdpa,id=str,vhostdev=/path/to/dev\n" 2759108a6481SCindy Lu " configure a vhost-vdpa network,Establish a vhost-vdpa netdev\n" 2760108a6481SCindy Lu#endif 276118d65d22SThomas Huth "-netdev hubport,id=str,hubid=n[,netdev=nd]\n" 2762af1a5c3eSThomas Huth " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL) 276378cd6f7bSThomas HuthDEF("nic", HAS_ARG, QEMU_OPTION_nic, 2764dfaa7d50SBALATON Zoltan "-nic [tap|bridge|" 276578cd6f7bSThomas Huth#ifdef CONFIG_SLIRP 276678cd6f7bSThomas Huth "user|" 276778cd6f7bSThomas Huth#endif 276878cd6f7bSThomas Huth#ifdef __linux__ 276978cd6f7bSThomas Huth "l2tpv3|" 277078cd6f7bSThomas Huth#endif 277178cd6f7bSThomas Huth#ifdef CONFIG_VDE 277278cd6f7bSThomas Huth "vde|" 277378cd6f7bSThomas Huth#endif 277478cd6f7bSThomas Huth#ifdef CONFIG_NETMAP 277578cd6f7bSThomas Huth "netmap|" 277678cd6f7bSThomas Huth#endif 277778cd6f7bSThomas Huth#ifdef CONFIG_POSIX 277878cd6f7bSThomas Huth "vhost-user|" 277978cd6f7bSThomas Huth#endif 278078cd6f7bSThomas Huth "socket][,option][,...][mac=macaddr]\n" 278178cd6f7bSThomas Huth " initialize an on-board / default host NIC (using MAC address\n" 278278cd6f7bSThomas Huth " macaddr) and connect it to the given host network backend\n" 2783dfaa7d50SBALATON Zoltan "-nic none use it alone to have zero network devices (the default is to\n" 278478cd6f7bSThomas Huth " provided a 'user' network connection)\n", 278578cd6f7bSThomas Huth QEMU_ARCH_ALL) 27866a8b4a5bSThomas HuthDEF("net", HAS_ARG, QEMU_OPTION_net, 2787af1a5c3eSThomas Huth "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 27880e60a82dSThomas Huth " configure or create an on-board (or machine default) NIC and\n" 2789af1a5c3eSThomas Huth " connect it to hub 0 (please use -nic unless you need a hub)\n" 27906a8b4a5bSThomas Huth "-net [" 2791a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 2792a1ea458fSMark McLoughlin "user|" 2793a1ea458fSMark McLoughlin#endif 2794a1ea458fSMark McLoughlin "tap|" 2795a7c36ee4SCorey Bryant "bridge|" 2796a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 2797a1ea458fSMark McLoughlin "vde|" 2798a1ea458fSMark McLoughlin#endif 279958952137SVincenzo Maffione#ifdef CONFIG_NETMAP 280058952137SVincenzo Maffione "netmap|" 280158952137SVincenzo Maffione#endif 2802af1a5c3eSThomas Huth "socket][,option][,option][,...]\n" 28036a8b4a5bSThomas Huth " old way to initialize a host network interface\n" 28046a8b4a5bSThomas Huth " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 2805e2fcbf42SPeter MaydellSRST 2806e2fcbf42SPeter Maydell``-nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]`` 2807e2fcbf42SPeter Maydell This option is a shortcut for configuring both the on-board 2808e2fcbf42SPeter Maydell (default) guest NIC hardware and the host network backend in one go. 2809e2fcbf42SPeter Maydell The host backend options are the same as with the corresponding 2810e2fcbf42SPeter Maydell ``-netdev`` options below. The guest NIC model can be set with 2811e2fcbf42SPeter Maydell ``model=modelname``. Use ``model=help`` to list the available device 2812e2fcbf42SPeter Maydell types. The hardware MAC address can be set with ``mac=macaddr``. 2813e2fcbf42SPeter Maydell 2814e2fcbf42SPeter Maydell The following two example do exactly the same, to show how ``-nic`` 2815e2fcbf42SPeter Maydell can be used to shorten the command line length: 2816e2fcbf42SPeter Maydell 2817e2fcbf42SPeter Maydell .. parsed-literal:: 2818e2fcbf42SPeter Maydell 2819e2fcbf42SPeter Maydell |qemu_system| -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32 2820e2fcbf42SPeter Maydell |qemu_system| -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32 2821e2fcbf42SPeter Maydell 2822e2fcbf42SPeter Maydell``-nic none`` 2823e2fcbf42SPeter Maydell Indicate that no network devices should be configured. It is used to 2824e2fcbf42SPeter Maydell override the default configuration (default NIC with "user" host 2825e2fcbf42SPeter Maydell network backend) which is activated if no other networking options 2826e2fcbf42SPeter Maydell are provided. 2827e2fcbf42SPeter Maydell 2828e2fcbf42SPeter Maydell``-netdev user,id=id[,option][,option][,...]`` 2829e2fcbf42SPeter Maydell Configure user mode host network backend which requires no 2830e2fcbf42SPeter Maydell administrator privilege to run. Valid options are: 2831e2fcbf42SPeter Maydell 2832e2fcbf42SPeter Maydell ``id=id`` 2833e2fcbf42SPeter Maydell Assign symbolic name for use in monitor commands. 2834e2fcbf42SPeter Maydell 2835e2fcbf42SPeter Maydell ``ipv4=on|off and ipv6=on|off`` 2836e2fcbf42SPeter Maydell Specify that either IPv4 or IPv6 must be enabled. If neither is 2837e2fcbf42SPeter Maydell specified both protocols are enabled. 2838e2fcbf42SPeter Maydell 2839e2fcbf42SPeter Maydell ``net=addr[/mask]`` 2840e2fcbf42SPeter Maydell Set IP network address the guest will see. Optionally specify 2841e2fcbf42SPeter Maydell the netmask, either in the form a.b.c.d or as number of valid 2842e2fcbf42SPeter Maydell top-most bits. Default is 10.0.2.0/24. 2843e2fcbf42SPeter Maydell 2844e2fcbf42SPeter Maydell ``host=addr`` 2845e2fcbf42SPeter Maydell Specify the guest-visible address of the host. Default is the 2846e2fcbf42SPeter Maydell 2nd IP in the guest network, i.e. x.x.x.2. 2847e2fcbf42SPeter Maydell 2848e2fcbf42SPeter Maydell ``ipv6-net=addr[/int]`` 2849e2fcbf42SPeter Maydell Set IPv6 network address the guest will see (default is 2850e2fcbf42SPeter Maydell fec0::/64). The network prefix is given in the usual hexadecimal 2851e2fcbf42SPeter Maydell IPv6 address notation. The prefix size is optional, and is given 2852e2fcbf42SPeter Maydell as the number of valid top-most bits (default is 64). 2853e2fcbf42SPeter Maydell 2854e2fcbf42SPeter Maydell ``ipv6-host=addr`` 2855e2fcbf42SPeter Maydell Specify the guest-visible IPv6 address of the host. Default is 2856e2fcbf42SPeter Maydell the 2nd IPv6 in the guest network, i.e. xxxx::2. 2857e2fcbf42SPeter Maydell 2858e2fcbf42SPeter Maydell ``restrict=on|off`` 2859e2fcbf42SPeter Maydell If this option is enabled, the guest will be isolated, i.e. it 2860e2fcbf42SPeter Maydell will not be able to contact the host and no guest IP packets 2861e2fcbf42SPeter Maydell will be routed over the host to the outside. This option does 2862e2fcbf42SPeter Maydell not affect any explicitly set forwarding rules. 2863e2fcbf42SPeter Maydell 2864e2fcbf42SPeter Maydell ``hostname=name`` 2865e2fcbf42SPeter Maydell Specifies the client hostname reported by the built-in DHCP 2866e2fcbf42SPeter Maydell server. 2867e2fcbf42SPeter Maydell 2868e2fcbf42SPeter Maydell ``dhcpstart=addr`` 2869e2fcbf42SPeter Maydell Specify the first of the 16 IPs the built-in DHCP server can 2870e2fcbf42SPeter Maydell assign. Default is the 15th to 31st IP in the guest network, 2871e2fcbf42SPeter Maydell i.e. x.x.x.15 to x.x.x.31. 2872e2fcbf42SPeter Maydell 2873e2fcbf42SPeter Maydell ``dns=addr`` 2874e2fcbf42SPeter Maydell Specify the guest-visible address of the virtual nameserver. The 2875e2fcbf42SPeter Maydell address must be different from the host address. Default is the 2876e2fcbf42SPeter Maydell 3rd IP in the guest network, i.e. x.x.x.3. 2877e2fcbf42SPeter Maydell 2878e2fcbf42SPeter Maydell ``ipv6-dns=addr`` 2879e2fcbf42SPeter Maydell Specify the guest-visible address of the IPv6 virtual 2880e2fcbf42SPeter Maydell nameserver. The address must be different from the host address. 2881e2fcbf42SPeter Maydell Default is the 3rd IP in the guest network, i.e. xxxx::3. 2882e2fcbf42SPeter Maydell 2883e2fcbf42SPeter Maydell ``dnssearch=domain`` 2884e2fcbf42SPeter Maydell Provides an entry for the domain-search list sent by the 2885e2fcbf42SPeter Maydell built-in DHCP server. More than one domain suffix can be 2886e2fcbf42SPeter Maydell transmitted by specifying this option multiple times. If 2887e2fcbf42SPeter Maydell supported, this will cause the guest to automatically try to 2888e2fcbf42SPeter Maydell append the given domain suffix(es) in case a domain name can not 2889e2fcbf42SPeter Maydell be resolved. 2890e2fcbf42SPeter Maydell 2891e2fcbf42SPeter Maydell Example: 2892e2fcbf42SPeter Maydell 2893e2fcbf42SPeter Maydell .. parsed-literal:: 2894e2fcbf42SPeter Maydell 2895e2fcbf42SPeter Maydell |qemu_system| -nic user,dnssearch=mgmt.example.org,dnssearch=example.org 2896e2fcbf42SPeter Maydell 2897e2fcbf42SPeter Maydell ``domainname=domain`` 2898e2fcbf42SPeter Maydell Specifies the client domain name reported by the built-in DHCP 2899e2fcbf42SPeter Maydell server. 2900e2fcbf42SPeter Maydell 2901e2fcbf42SPeter Maydell ``tftp=dir`` 2902e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in TFTP 2903e2fcbf42SPeter Maydell server. The files in dir will be exposed as the root of a TFTP 2904e2fcbf42SPeter Maydell server. The TFTP client on the guest must be configured in 2905e2fcbf42SPeter Maydell binary mode (use the command ``bin`` of the Unix TFTP client). 2906e2fcbf42SPeter Maydell 2907e2fcbf42SPeter Maydell ``tftp-server-name=name`` 2908e2fcbf42SPeter Maydell In BOOTP reply, broadcast name as the "TFTP server name" 2909e2fcbf42SPeter Maydell (RFC2132 option 66). This can be used to advise the guest to 2910e2fcbf42SPeter Maydell load boot files or configurations from a different server than 2911e2fcbf42SPeter Maydell the host address. 2912e2fcbf42SPeter Maydell 2913e2fcbf42SPeter Maydell ``bootfile=file`` 2914e2fcbf42SPeter Maydell When using the user mode network stack, broadcast file as the 2915e2fcbf42SPeter Maydell BOOTP filename. In conjunction with ``tftp``, this can be used 2916e2fcbf42SPeter Maydell to network boot a guest from a local directory. 2917e2fcbf42SPeter Maydell 2918e2fcbf42SPeter Maydell Example (using pxelinux): 2919e2fcbf42SPeter Maydell 2920e2fcbf42SPeter Maydell .. parsed-literal:: 2921e2fcbf42SPeter Maydell 2922353a06b4SLaszlo Ersek |qemu_system| -hda linux.img -boot n -device e1000,netdev=n1 \\ 2923e2fcbf42SPeter Maydell -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 2924e2fcbf42SPeter Maydell 2925e2fcbf42SPeter Maydell ``smb=dir[,smbserver=addr]`` 2926e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in SMB 2927e2fcbf42SPeter Maydell server so that Windows OSes can access to the host files in 2928e2fcbf42SPeter Maydell ``dir`` transparently. The IP address of the SMB server can be 2929e2fcbf42SPeter Maydell set to addr. By default the 4th IP in the guest network is used, 2930e2fcbf42SPeter Maydell i.e. x.x.x.4. 2931e2fcbf42SPeter Maydell 2932e2fcbf42SPeter Maydell In the guest Windows OS, the line: 2933e2fcbf42SPeter Maydell 2934e2fcbf42SPeter Maydell :: 2935e2fcbf42SPeter Maydell 2936e2fcbf42SPeter Maydell 10.0.2.4 smbserver 2937e2fcbf42SPeter Maydell 2938e2fcbf42SPeter Maydell must be added in the file ``C:\WINDOWS\LMHOSTS`` (for windows 2939e2fcbf42SPeter Maydell 9x/Me) or ``C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS`` (Windows 2940e2fcbf42SPeter Maydell NT/2000). 2941e2fcbf42SPeter Maydell 2942e2fcbf42SPeter Maydell Then ``dir`` can be accessed in ``\\smbserver\qemu``. 2943e2fcbf42SPeter Maydell 2944e2fcbf42SPeter Maydell Note that a SAMBA server must be installed on the host OS. 2945e2fcbf42SPeter Maydell 2946e2fcbf42SPeter Maydell ``hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport`` 2947e2fcbf42SPeter Maydell Redirect incoming TCP or UDP connections to the host port 2948e2fcbf42SPeter Maydell hostport to the guest IP address guestaddr on guest port 2949e2fcbf42SPeter Maydell guestport. If guestaddr is not specified, its value is x.x.x.15 2950e2fcbf42SPeter Maydell (default first address given by the built-in DHCP server). By 2951e2fcbf42SPeter Maydell specifying hostaddr, the rule can be bound to a specific host 2952e2fcbf42SPeter Maydell interface. If no connection type is set, TCP is used. This 2953e2fcbf42SPeter Maydell option can be given multiple times. 2954e2fcbf42SPeter Maydell 2955e2fcbf42SPeter Maydell For example, to redirect host X11 connection from screen 1 to 2956e2fcbf42SPeter Maydell guest screen 0, use the following: 2957e2fcbf42SPeter Maydell 295809ce5f2dSPeter Maydell .. parsed-literal:: 2959e2fcbf42SPeter Maydell 2960e2fcbf42SPeter Maydell # on the host 2961e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp:127.0.0.1:6001-:6000 2962e2fcbf42SPeter Maydell # this host xterm should open in the guest X11 server 2963e2fcbf42SPeter Maydell xterm -display :1 2964e2fcbf42SPeter Maydell 2965e2fcbf42SPeter Maydell To redirect telnet connections from host port 5555 to telnet 2966e2fcbf42SPeter Maydell port on the guest, use the following: 2967e2fcbf42SPeter Maydell 296809ce5f2dSPeter Maydell .. parsed-literal:: 2969e2fcbf42SPeter Maydell 2970e2fcbf42SPeter Maydell # on the host 2971e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp::5555-:23 2972e2fcbf42SPeter Maydell telnet localhost 5555 2973e2fcbf42SPeter Maydell 2974e2fcbf42SPeter Maydell Then when you use on the host ``telnet localhost 5555``, you 2975e2fcbf42SPeter Maydell connect to the guest telnet server. 2976e2fcbf42SPeter Maydell 2977e2fcbf42SPeter Maydell ``guestfwd=[tcp]:server:port-dev``; \ ``guestfwd=[tcp]:server:port-cmd:command`` 2978e2fcbf42SPeter Maydell Forward guest TCP connections to the IP address server on port 2979e2fcbf42SPeter Maydell port to the character device dev or to a program executed by 2980e2fcbf42SPeter Maydell cmd:command which gets spawned for each connection. This option 2981e2fcbf42SPeter Maydell can be given multiple times. 2982e2fcbf42SPeter Maydell 2983e2fcbf42SPeter Maydell You can either use a chardev directly and have that one used 2984e2fcbf42SPeter Maydell throughout QEMU's lifetime, like in the following example: 2985e2fcbf42SPeter Maydell 298609ce5f2dSPeter Maydell .. parsed-literal:: 2987e2fcbf42SPeter Maydell 2988e2fcbf42SPeter Maydell # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 2989e2fcbf42SPeter Maydell # the guest accesses it 2990e2fcbf42SPeter Maydell |qemu_system| -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 2991e2fcbf42SPeter Maydell 2992e2fcbf42SPeter Maydell Or you can execute a command on every TCP connection established 2993e2fcbf42SPeter Maydell by the guest, so that QEMU behaves similar to an inetd process 2994e2fcbf42SPeter Maydell for that virtual server: 2995e2fcbf42SPeter Maydell 299609ce5f2dSPeter Maydell .. parsed-literal:: 2997e2fcbf42SPeter Maydell 2998e2fcbf42SPeter Maydell # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 2999e2fcbf42SPeter Maydell # and connect the TCP stream to its stdin/stdout 3000e2fcbf42SPeter Maydell |qemu_system| -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 3001e2fcbf42SPeter Maydell 3002e2fcbf42SPeter Maydell``-netdev tap,id=id[,fd=h][,ifname=name][,script=file][,downscript=dfile][,br=bridge][,helper=helper]`` 3003e2fcbf42SPeter Maydell Configure a host TAP network backend with ID id. 3004e2fcbf42SPeter Maydell 3005e2fcbf42SPeter Maydell Use the network script file to configure it and the network script 3006e2fcbf42SPeter Maydell dfile to deconfigure it. If name is not provided, the OS 3007e2fcbf42SPeter Maydell automatically provides one. The default network configure script is 3008e2fcbf42SPeter Maydell ``/etc/qemu-ifup`` and the default network deconfigure script is 3009e2fcbf42SPeter Maydell ``/etc/qemu-ifdown``. Use ``script=no`` or ``downscript=no`` to 3010e2fcbf42SPeter Maydell disable script execution. 3011e2fcbf42SPeter Maydell 3012e2fcbf42SPeter Maydell If running QEMU as an unprivileged user, use the network helper 30138d73ec89STianjia Zhang to configure the TAP interface and attach it to the bridge. 3014e2fcbf42SPeter Maydell The default network helper executable is 3015e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 3016e2fcbf42SPeter Maydell ``br0``. 3017e2fcbf42SPeter Maydell 3018e2fcbf42SPeter Maydell ``fd``\ =h can be used to specify the handle of an already opened 3019e2fcbf42SPeter Maydell host TAP interface. 3020e2fcbf42SPeter Maydell 3021e2fcbf42SPeter Maydell Examples: 3022e2fcbf42SPeter Maydell 302309ce5f2dSPeter Maydell .. parsed-literal:: 3024e2fcbf42SPeter Maydell 3025e2fcbf42SPeter Maydell #launch a QEMU instance with the default network script 3026e2fcbf42SPeter Maydell |qemu_system| linux.img -nic tap 3027e2fcbf42SPeter Maydell 302809ce5f2dSPeter Maydell .. parsed-literal:: 3029e2fcbf42SPeter Maydell 3030e2fcbf42SPeter Maydell #launch a QEMU instance with two NICs, each one connected 3031e2fcbf42SPeter Maydell #to a TAP device 3032353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3033353a06b4SLaszlo Ersek -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \\ 3034e2fcbf42SPeter Maydell -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1 3035e2fcbf42SPeter Maydell 303609ce5f2dSPeter Maydell .. parsed-literal:: 3037e2fcbf42SPeter Maydell 3038e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3039e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 3040353a06b4SLaszlo Ersek |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \\ 3041e2fcbf42SPeter Maydell -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper" 3042e2fcbf42SPeter Maydell 3043e2fcbf42SPeter Maydell``-netdev bridge,id=id[,br=bridge][,helper=helper]`` 3044e2fcbf42SPeter Maydell Connect a host TAP network interface to a host bridge device. 3045e2fcbf42SPeter Maydell 3046e2fcbf42SPeter Maydell Use the network helper helper to configure the TAP interface and 3047e2fcbf42SPeter Maydell attach it to the bridge. The default network helper executable is 3048e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 3049e2fcbf42SPeter Maydell ``br0``. 3050e2fcbf42SPeter Maydell 3051e2fcbf42SPeter Maydell Examples: 3052e2fcbf42SPeter Maydell 305309ce5f2dSPeter Maydell .. parsed-literal:: 3054e2fcbf42SPeter Maydell 3055e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3056e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 3057e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1 3058e2fcbf42SPeter Maydell 305909ce5f2dSPeter Maydell .. parsed-literal:: 3060e2fcbf42SPeter Maydell 3061e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3062e2fcbf42SPeter Maydell #connect a TAP device to bridge qemubr0 3063e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1 3064e2fcbf42SPeter Maydell 3065e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,listen=[host]:port][,connect=host:port]`` 3066e2fcbf42SPeter Maydell This host network backend can be used to connect the guest's network 3067e2fcbf42SPeter Maydell to another QEMU virtual machine using a TCP socket connection. If 3068e2fcbf42SPeter Maydell ``listen`` is specified, QEMU waits for incoming connections on port 3069e2fcbf42SPeter Maydell (host is optional). ``connect`` is used to connect to another QEMU 3070e2fcbf42SPeter Maydell instance using the ``listen`` option. ``fd``\ =h specifies an 3071e2fcbf42SPeter Maydell already opened TCP socket. 3072e2fcbf42SPeter Maydell 3073e2fcbf42SPeter Maydell Example: 3074e2fcbf42SPeter Maydell 307509ce5f2dSPeter Maydell .. parsed-literal:: 3076e2fcbf42SPeter Maydell 3077e2fcbf42SPeter Maydell # launch a first QEMU instance 3078353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3079353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3080e2fcbf42SPeter Maydell -netdev socket,id=n1,listen=:1234 3081e2fcbf42SPeter Maydell # connect the network of this instance to the network of the first instance 3082353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3083353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 3084e2fcbf42SPeter Maydell -netdev socket,id=n2,connect=127.0.0.1:1234 3085e2fcbf42SPeter Maydell 3086e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,mcast=maddr:port[,localaddr=addr]]`` 3087e2fcbf42SPeter Maydell Configure a socket host network backend to share the guest's network 3088e2fcbf42SPeter Maydell traffic with another QEMU virtual machines using a UDP multicast 3089e2fcbf42SPeter Maydell socket, effectively making a bus for every QEMU with same multicast 3090e2fcbf42SPeter Maydell address maddr and port. NOTES: 3091e2fcbf42SPeter Maydell 3092e2fcbf42SPeter Maydell 1. Several QEMU can be running on different hosts and share same bus 3093e2fcbf42SPeter Maydell (assuming correct multicast setup for these hosts). 3094e2fcbf42SPeter Maydell 3095e2fcbf42SPeter Maydell 2. mcast support is compatible with User Mode Linux (argument 3096e2fcbf42SPeter Maydell ``ethN=mcast``), see http://user-mode-linux.sf.net. 3097e2fcbf42SPeter Maydell 3098e2fcbf42SPeter Maydell 3. Use ``fd=h`` to specify an already opened UDP multicast socket. 3099e2fcbf42SPeter Maydell 3100e2fcbf42SPeter Maydell Example: 3101e2fcbf42SPeter Maydell 310209ce5f2dSPeter Maydell .. parsed-literal:: 3103e2fcbf42SPeter Maydell 3104e2fcbf42SPeter Maydell # launch one QEMU instance 3105353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3106353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3107e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=230.0.0.1:1234 3108e2fcbf42SPeter Maydell # launch another QEMU instance on same "bus" 3109353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3110353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 3111e2fcbf42SPeter Maydell -netdev socket,id=n2,mcast=230.0.0.1:1234 3112e2fcbf42SPeter Maydell # launch yet another QEMU instance on same "bus" 3113353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3114353a06b4SLaszlo Ersek -device e1000,netdev=n3,mac=52:54:00:12:34:58 \\ 3115e2fcbf42SPeter Maydell -netdev socket,id=n3,mcast=230.0.0.1:1234 3116e2fcbf42SPeter Maydell 3117e2fcbf42SPeter Maydell Example (User Mode Linux compat.): 3118e2fcbf42SPeter Maydell 311909ce5f2dSPeter Maydell .. parsed-literal:: 3120e2fcbf42SPeter Maydell 3121e2fcbf42SPeter Maydell # launch QEMU instance (note mcast address selected is UML's default) 3122353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3123353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3124e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102 3125e2fcbf42SPeter Maydell # launch UML 3126e2fcbf42SPeter Maydell /path/to/linux ubd0=/path/to/root_fs eth0=mcast 3127e2fcbf42SPeter Maydell 3128e2fcbf42SPeter Maydell Example (send packets from host's 1.2.3.4): 3129e2fcbf42SPeter Maydell 3130e2fcbf42SPeter Maydell .. parsed-literal:: 3131e2fcbf42SPeter Maydell 3132353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3133353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3134e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 3135e2fcbf42SPeter Maydell 31368b0dc246SDaniel 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]`` 3137e2fcbf42SPeter Maydell Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931) 3138e2fcbf42SPeter Maydell is a popular protocol to transport Ethernet (and other Layer 2) data 3139e2fcbf42SPeter Maydell frames between two systems. It is present in routers, firewalls and 3140e2fcbf42SPeter Maydell the Linux kernel (from version 3.3 onwards). 3141e2fcbf42SPeter Maydell 3142e2fcbf42SPeter Maydell This transport allows a VM to communicate to another VM, router or 3143e2fcbf42SPeter Maydell firewall directly. 3144e2fcbf42SPeter Maydell 3145e2fcbf42SPeter Maydell ``src=srcaddr`` 3146e2fcbf42SPeter Maydell source address (mandatory) 3147e2fcbf42SPeter Maydell 3148e2fcbf42SPeter Maydell ``dst=dstaddr`` 3149e2fcbf42SPeter Maydell destination address (mandatory) 3150e2fcbf42SPeter Maydell 3151e2fcbf42SPeter Maydell ``udp`` 3152e2fcbf42SPeter Maydell select udp encapsulation (default is ip). 3153e2fcbf42SPeter Maydell 3154e2fcbf42SPeter Maydell ``srcport=srcport`` 3155e2fcbf42SPeter Maydell source udp port. 3156e2fcbf42SPeter Maydell 3157e2fcbf42SPeter Maydell ``dstport=dstport`` 3158e2fcbf42SPeter Maydell destination udp port. 3159e2fcbf42SPeter Maydell 3160e2fcbf42SPeter Maydell ``ipv6`` 3161e2fcbf42SPeter Maydell force v6, otherwise defaults to v4. 3162e2fcbf42SPeter Maydell 3163e2fcbf42SPeter Maydell ``rxcookie=rxcookie``; \ ``txcookie=txcookie`` 3164e2fcbf42SPeter Maydell Cookies are a weak form of security in the l2tpv3 specification. 3165e2fcbf42SPeter Maydell Their function is mostly to prevent misconfiguration. By default 3166e2fcbf42SPeter Maydell they are 32 bit. 3167e2fcbf42SPeter Maydell 3168e2fcbf42SPeter Maydell ``cookie64`` 3169e2fcbf42SPeter Maydell Set cookie size to 64 bit instead of the default 32 3170e2fcbf42SPeter Maydell 3171e2fcbf42SPeter Maydell ``counter=off`` 3172e2fcbf42SPeter Maydell Force a 'cut-down' L2TPv3 with no counter as in 3173e2fcbf42SPeter Maydell draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 3174e2fcbf42SPeter Maydell 3175e2fcbf42SPeter Maydell ``pincounter=on`` 3176e2fcbf42SPeter Maydell Work around broken counter handling in peer. This may also help 3177e2fcbf42SPeter Maydell on networks which have packet reorder. 3178e2fcbf42SPeter Maydell 3179e2fcbf42SPeter Maydell ``offset=offset`` 3180e2fcbf42SPeter Maydell Add an extra offset between header and data 3181e2fcbf42SPeter Maydell 3182e2fcbf42SPeter Maydell For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to 3183e2fcbf42SPeter Maydell the bridge br-lan on the remote Linux host 1.2.3.4: 3184e2fcbf42SPeter Maydell 318509ce5f2dSPeter Maydell .. parsed-literal:: 3186e2fcbf42SPeter Maydell 3187e2fcbf42SPeter Maydell # Setup tunnel on linux host using raw ip as encapsulation 3188e2fcbf42SPeter Maydell # on 1.2.3.4 3189353a06b4SLaszlo Ersek ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \\ 3190e2fcbf42SPeter Maydell encap udp udp_sport 16384 udp_dport 16384 3191353a06b4SLaszlo Ersek ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \\ 3192e2fcbf42SPeter Maydell 0xFFFFFFFF peer_session_id 0xFFFFFFFF 3193e2fcbf42SPeter Maydell ifconfig vmtunnel0 mtu 1500 3194e2fcbf42SPeter Maydell ifconfig vmtunnel0 up 3195e2fcbf42SPeter Maydell brctl addif br-lan vmtunnel0 3196e2fcbf42SPeter Maydell 3197e2fcbf42SPeter Maydell 3198e2fcbf42SPeter Maydell # on 4.3.2.1 3199e2fcbf42SPeter Maydell # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 3200e2fcbf42SPeter Maydell 3201353a06b4SLaszlo Ersek |qemu_system| linux.img -device e1000,netdev=n1 \\ 3202e2fcbf42SPeter 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 3203e2fcbf42SPeter Maydell 3204e2fcbf42SPeter Maydell``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]`` 3205e2fcbf42SPeter Maydell Configure VDE backend to connect to PORT n of a vde switch running 3206e2fcbf42SPeter Maydell on host and listening for incoming connections on socketpath. Use 3207e2fcbf42SPeter Maydell GROUP groupname and MODE octalmode to change default ownership and 3208e2fcbf42SPeter Maydell permissions for communication port. This option is only available if 3209e2fcbf42SPeter Maydell QEMU has been compiled with vde support enabled. 3210e2fcbf42SPeter Maydell 3211e2fcbf42SPeter Maydell Example: 3212e2fcbf42SPeter Maydell 321309ce5f2dSPeter Maydell .. parsed-literal:: 3214e2fcbf42SPeter Maydell 3215e2fcbf42SPeter Maydell # launch vde switch 3216e2fcbf42SPeter Maydell vde_switch -F -sock /tmp/myswitch 3217e2fcbf42SPeter Maydell # launch QEMU instance 3218e2fcbf42SPeter Maydell |qemu_system| linux.img -nic vde,sock=/tmp/myswitch 3219e2fcbf42SPeter Maydell 3220e2fcbf42SPeter Maydell``-netdev vhost-user,chardev=id[,vhostforce=on|off][,queues=n]`` 3221e2fcbf42SPeter Maydell Establish a vhost-user netdev, backed by a chardev id. The chardev 3222e2fcbf42SPeter Maydell should be a unix domain socket backed one. The vhost-user uses a 3223e2fcbf42SPeter Maydell specifically defined protocol to pass vhost ioctl replacement 3224e2fcbf42SPeter Maydell messages to an application on the other end of the socket. On 3225e2fcbf42SPeter Maydell non-MSIX guests, the feature can be forced with vhostforce. Use 3226e2fcbf42SPeter Maydell 'queues=n' to specify the number of queues to be created for 3227e2fcbf42SPeter Maydell multiqueue vhost-user. 3228e2fcbf42SPeter Maydell 3229e2fcbf42SPeter Maydell Example: 3230e2fcbf42SPeter Maydell 3231e2fcbf42SPeter Maydell :: 3232e2fcbf42SPeter Maydell 3233e2fcbf42SPeter Maydell qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 3234e2fcbf42SPeter Maydell -numa node,memdev=mem \ 3235e2fcbf42SPeter Maydell -chardev socket,id=chr0,path=/path/to/socket \ 3236e2fcbf42SPeter Maydell -netdev type=vhost-user,id=net0,chardev=chr0 \ 3237e2fcbf42SPeter Maydell -device virtio-net-pci,netdev=net0 3238e2fcbf42SPeter Maydell 3239108a6481SCindy Lu``-netdev vhost-vdpa,vhostdev=/path/to/dev`` 3240108a6481SCindy Lu Establish a vhost-vdpa netdev. 3241108a6481SCindy Lu 3242108a6481SCindy Lu vDPA device is a device that uses a datapath which complies with 3243108a6481SCindy Lu the virtio specifications with a vendor specific control path. 3244108a6481SCindy Lu vDPA devices can be both physically located on the hardware or 3245108a6481SCindy Lu emulated by software. 3246108a6481SCindy Lu 3247e2fcbf42SPeter Maydell``-netdev hubport,id=id,hubid=hubid[,netdev=nd]`` 3248e2fcbf42SPeter Maydell Create a hub port on the emulated hub with ID hubid. 3249e2fcbf42SPeter Maydell 3250e2fcbf42SPeter Maydell The hubport netdev lets you connect a NIC to a QEMU emulated hub 3251e2fcbf42SPeter Maydell instead of a single netdev. Alternatively, you can also connect the 3252e2fcbf42SPeter Maydell hubport to another netdev with ID nd by using the ``netdev=nd`` 3253e2fcbf42SPeter Maydell option. 3254e2fcbf42SPeter Maydell 3255e2fcbf42SPeter Maydell``-net nic[,netdev=nd][,macaddr=mac][,model=type] [,name=name][,addr=addr][,vectors=v]`` 3256e2fcbf42SPeter Maydell Legacy option to configure or create an on-board (or machine 3257e2fcbf42SPeter Maydell default) Network Interface Card(NIC) and connect it either to the 3258e2fcbf42SPeter Maydell emulated hub with ID 0 (i.e. the default hub), or to the netdev nd. 3259e2fcbf42SPeter Maydell If model is omitted, then the default NIC model associated with the 3260e2fcbf42SPeter Maydell machine type is used. Note that the default NIC model may change in 3261e2fcbf42SPeter Maydell future QEMU releases, so it is highly recommended to always specify 3262e2fcbf42SPeter Maydell a model. Optionally, the MAC address can be changed to mac, the 3263e2fcbf42SPeter Maydell device address set to addr (PCI cards only), and a name can be 3264e2fcbf42SPeter Maydell assigned for use in monitor commands. Optionally, for PCI cards, you 3265e2fcbf42SPeter Maydell can specify the number v of MSI-X vectors that the card should have; 3266e2fcbf42SPeter Maydell this option currently only affects virtio cards; set v = 0 to 3267e2fcbf42SPeter Maydell disable MSI-X. If no ``-net`` option is specified, a single NIC is 3268e2fcbf42SPeter Maydell created. QEMU can emulate several different models of network card. 3269e2fcbf42SPeter Maydell Use ``-net nic,model=help`` for a list of available devices for your 3270e2fcbf42SPeter Maydell target. 3271e2fcbf42SPeter Maydell 3272e2fcbf42SPeter Maydell``-net user|tap|bridge|socket|l2tpv3|vde[,...][,name=name]`` 3273e2fcbf42SPeter Maydell Configure a host network backend (with the options corresponding to 3274e2fcbf42SPeter Maydell the same ``-netdev`` option) and connect it to the emulated hub 0 3275e2fcbf42SPeter Maydell (the default hub). Use name to specify the name of the hub port. 3276e2fcbf42SPeter MaydellERST 32775824d651Sblueswir1 32787273a2dbSMatthew BoothDEFHEADING() 32797273a2dbSMatthew Booth 3280de6b4f90SMarkus ArmbrusterDEFHEADING(Character device options:) 32817273a2dbSMatthew Booth 32827273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 3283517b3d40SLin Ma "-chardev help\n" 3284d0d7708bSDaniel P. Berrange "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3285ba858d1fSMarkus Armbruster "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]\n" 3286bfdc1267SDaniel P. Berrangé " [,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds][,mux=on|off]\n" 3287fd4a5fd4SDaniel P. Berrange " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n" 3288bfdc1267SDaniel P. Berrangé "-chardev socket,id=id,path=path[,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds]\n" 3289e339273bSxiaoqiang zhao " [,mux=on|off][,logfile=PATH][,logappend=on|off][,abstract=on|off][,tight=on|off] (unix)\n" 32907273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 3291bfdc1267SDaniel P. Berrangé " [,localport=localport][,ipv4=on|off][,ipv6=on|off][,mux=on|off]\n" 3292d0d7708bSDaniel P. Berrange " [,logfile=PATH][,logappend=on|off]\n" 3293d0d7708bSDaniel P. Berrange "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 32947273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 3295d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3296d0d7708bSDaniel P. Berrange "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 3297d0d7708bSDaniel P. Berrange "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3298d0d7708bSDaniel P. Berrange "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 32997273a2dbSMatthew Booth#ifdef _WIN32 3300d0d7708bSDaniel P. Berrange "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3301d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33027273a2dbSMatthew Booth#else 3303d0d7708bSDaniel P. Berrange "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3304d0d7708bSDaniel P. Berrange "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 33057273a2dbSMatthew Booth#endif 33067273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 3307d0d7708bSDaniel P. Berrange "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33087273a2dbSMatthew Booth#endif 33097273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 33107273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 3311d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3312d0d7708bSDaniel P. Berrange "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33137273a2dbSMatthew Booth#endif 33147273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 3315d0d7708bSDaniel P. Berrange "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3316d0d7708bSDaniel P. Berrange "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33177273a2dbSMatthew Booth#endif 3318cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 3319d0d7708bSDaniel P. Berrange "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3320d0d7708bSDaniel P. Berrange "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3321cbcc6336SAlon Levy#endif 3322ad96090aSBlue Swirl , QEMU_ARCH_ALL 33237273a2dbSMatthew Booth) 33247273a2dbSMatthew Booth 3325e2fcbf42SPeter MaydellSRST 3326e2fcbf42SPeter MaydellThe general form of a character device option is: 3327e2fcbf42SPeter Maydell 3328e2fcbf42SPeter Maydell``-chardev backend,id=id[,mux=on|off][,options]`` 3329e2fcbf42SPeter Maydell Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, 3330e2fcbf42SPeter Maydell ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``, 3331e2fcbf42SPeter Maydell ``pty``, ``stdio``, ``braille``, ``tty``, ``parallel``, ``parport``, 3332e2fcbf42SPeter Maydell ``spicevmc``, ``spiceport``. The specific backend will determine the 3333e2fcbf42SPeter Maydell applicable options. 3334e2fcbf42SPeter Maydell 3335e2fcbf42SPeter Maydell Use ``-chardev help`` to print all available chardev backend types. 3336e2fcbf42SPeter Maydell 3337e2fcbf42SPeter Maydell All devices must have an id, which can be any string up to 127 3338e2fcbf42SPeter Maydell characters long. It is used to uniquely identify this device in 3339e2fcbf42SPeter Maydell other command line directives. 3340e2fcbf42SPeter Maydell 3341e2fcbf42SPeter Maydell A character device may be used in multiplexing mode by multiple 3342e2fcbf42SPeter Maydell front-ends. Specify ``mux=on`` to enable this mode. A multiplexer is 3343e2fcbf42SPeter Maydell a "1:N" device, and here the "1" end is your specified chardev 3344e2fcbf42SPeter Maydell backend, and the "N" end is the various parts of QEMU that can talk 3345e2fcbf42SPeter Maydell to a chardev. If you create a chardev with ``id=myid`` and 3346e2fcbf42SPeter Maydell ``mux=on``, QEMU will create a multiplexer with your specified ID, 3347e2fcbf42SPeter Maydell and you can then configure multiple front ends to use that chardev 3348e2fcbf42SPeter Maydell ID for their input/output. Up to four different front ends can be 3349e2fcbf42SPeter Maydell connected to a single multiplexed chardev. (Without multiplexing 3350e2fcbf42SPeter Maydell enabled, a chardev can only be used by a single front end.) For 3351e2fcbf42SPeter Maydell instance you could use this to allow a single stdio chardev to be 3352e2fcbf42SPeter Maydell used by two serial ports and the QEMU monitor: 3353e2fcbf42SPeter Maydell 3354e2fcbf42SPeter Maydell :: 3355e2fcbf42SPeter Maydell 3356e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3357e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3358e2fcbf42SPeter Maydell -serial chardev:char0 \ 3359e2fcbf42SPeter Maydell -serial chardev:char0 3360e2fcbf42SPeter Maydell 3361e2fcbf42SPeter Maydell You can have more than one multiplexer in a system configuration; 3362e2fcbf42SPeter Maydell for instance you could have a TCP port multiplexed between UART 0 3363e2fcbf42SPeter Maydell and UART 1, and stdio multiplexed between the QEMU monitor and a 3364e2fcbf42SPeter Maydell parallel port: 3365e2fcbf42SPeter Maydell 3366e2fcbf42SPeter Maydell :: 3367e2fcbf42SPeter Maydell 3368e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3369e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3370e2fcbf42SPeter Maydell -parallel chardev:char0 \ 3371e2fcbf42SPeter Maydell -chardev tcp,...,mux=on,id=char1 \ 3372e2fcbf42SPeter Maydell -serial chardev:char1 \ 3373e2fcbf42SPeter Maydell -serial chardev:char1 3374e2fcbf42SPeter Maydell 3375e2fcbf42SPeter Maydell When you're using a multiplexed character device, some escape 3376923e9311SThomas Huth sequences are interpreted in the input. See the chapter about 3377923e9311SThomas Huth :ref:`keys in the character backend multiplexer` in the 3378923e9311SThomas Huth System Emulation Users Guide for more details. 3379e2fcbf42SPeter Maydell 3380e2fcbf42SPeter Maydell Note that some other command line options may implicitly create 3381e2fcbf42SPeter Maydell multiplexed character backends; for instance ``-serial mon:stdio`` 3382e2fcbf42SPeter Maydell creates a multiplexed stdio backend connected to the serial port and 3383e2fcbf42SPeter Maydell the QEMU monitor, and ``-nographic`` also multiplexes the console 3384e2fcbf42SPeter Maydell and the monitor to stdio. 3385e2fcbf42SPeter Maydell 3386e2fcbf42SPeter Maydell There is currently no support for multiplexing in the other 3387e2fcbf42SPeter Maydell direction (where a single QEMU front end takes input and output from 3388e2fcbf42SPeter Maydell multiple chardevs). 3389e2fcbf42SPeter Maydell 3390e2fcbf42SPeter Maydell Every backend supports the ``logfile`` option, which supplies the 3391e2fcbf42SPeter Maydell path to a file to record all data transmitted via the backend. The 3392e2fcbf42SPeter Maydell ``logappend`` option controls whether the log file will be truncated 3393e2fcbf42SPeter Maydell or appended to when opened. 3394e2fcbf42SPeter Maydell 3395e2fcbf42SPeter MaydellThe available backends are: 3396e2fcbf42SPeter Maydell 3397e2fcbf42SPeter Maydell``-chardev null,id=id`` 3398e2fcbf42SPeter Maydell A void device. This device will not emit any data, and will drop any 3399e2fcbf42SPeter Maydell data it receives. The null backend does not take any options. 3400e2fcbf42SPeter Maydell 3401bfdc1267SDaniel 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]`` 3402e2fcbf42SPeter Maydell Create a two-way stream socket, which can be either a TCP or a unix 3403e2fcbf42SPeter Maydell socket. A unix socket will be created if ``path`` is specified. 3404e2fcbf42SPeter Maydell Behaviour is undefined if TCP options are specified for a unix 3405e2fcbf42SPeter Maydell socket. 3406e2fcbf42SPeter Maydell 3407bfdc1267SDaniel P. Berrangé ``server=on|off`` specifies that the socket shall be a listening socket. 3408e2fcbf42SPeter Maydell 3409bfdc1267SDaniel P. Berrangé ``wait=on|off`` specifies that QEMU should not block waiting for a client 3410e2fcbf42SPeter Maydell to connect to a listening socket. 3411e2fcbf42SPeter Maydell 3412bfdc1267SDaniel P. Berrangé ``telnet=on|off`` specifies that traffic on the socket should interpret 3413e2fcbf42SPeter Maydell telnet escape sequences. 3414e2fcbf42SPeter Maydell 3415bfdc1267SDaniel P. Berrangé ``websocket=on|off`` specifies that the socket uses WebSocket protocol for 3416e2fcbf42SPeter Maydell communication. 3417e2fcbf42SPeter Maydell 3418e2fcbf42SPeter Maydell ``reconnect`` sets the timeout for reconnecting on non-server 3419e2fcbf42SPeter Maydell sockets when the remote end goes away. qemu will delay this many 3420e2fcbf42SPeter Maydell seconds and then attempt to reconnect. Zero disables reconnecting, 3421e2fcbf42SPeter Maydell and is the default. 3422e2fcbf42SPeter Maydell 3423e2fcbf42SPeter Maydell ``tls-creds`` requests enablement of the TLS protocol for 3424e2fcbf42SPeter Maydell encryption, and specifies the id of the TLS credentials to use for 3425e2fcbf42SPeter Maydell the handshake. The credentials must be previously created with the 3426e2fcbf42SPeter Maydell ``-object tls-creds`` argument. 3427e2fcbf42SPeter Maydell 3428e2fcbf42SPeter Maydell ``tls-auth`` provides the ID of the QAuthZ authorization object 3429e2fcbf42SPeter Maydell against which the client's x509 distinguished name will be 3430e2fcbf42SPeter Maydell validated. This object is only resolved at time of use, so can be 3431e2fcbf42SPeter Maydell deleted and recreated on the fly while the chardev server is active. 3432e2fcbf42SPeter Maydell If missing, it will default to denying access. 3433e2fcbf42SPeter Maydell 3434e2fcbf42SPeter Maydell TCP and unix socket options are given below: 3435e2fcbf42SPeter Maydell 3436a9b1315fSPaolo Bonzini ``TCP options: port=port[,host=host][,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]`` 3437e2fcbf42SPeter Maydell ``host`` for a listening socket specifies the local address to 3438e2fcbf42SPeter Maydell be bound. For a connecting socket species the remote host to 3439e2fcbf42SPeter Maydell connect to. ``host`` is optional for listening sockets. If not 3440e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3441e2fcbf42SPeter Maydell 3442e2fcbf42SPeter Maydell ``port`` for a listening socket specifies the local port to be 3443e2fcbf42SPeter Maydell bound. For a connecting socket specifies the port on the remote 3444e2fcbf42SPeter Maydell host to connect to. ``port`` can be given as either a port 3445e2fcbf42SPeter Maydell number or a service name. ``port`` is required. 3446e2fcbf42SPeter Maydell 3447e2fcbf42SPeter Maydell ``to`` is only relevant to listening sockets. If it is 3448e2fcbf42SPeter Maydell specified, and ``port`` cannot be bound, QEMU will attempt to 3449e2fcbf42SPeter Maydell bind to subsequent ports up to and including ``to`` until it 3450e2fcbf42SPeter Maydell succeeds. ``to`` must be specified as a port number. 3451e2fcbf42SPeter Maydell 3452bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 3453bfdc1267SDaniel P. Berrangé or IPv6 must be used. If neither is specified the socket may 3454bfdc1267SDaniel P. Berrangé use either protocol. 3455e2fcbf42SPeter Maydell 3456a9b1315fSPaolo Bonzini ``nodelay=on|off`` disables the Nagle algorithm. 3457e2fcbf42SPeter Maydell 3458e339273bSxiaoqiang zhao ``unix options: path=path[,abstract=on|off][,tight=on|off]`` 3459e2fcbf42SPeter Maydell ``path`` specifies the local path of the unix socket. ``path`` 3460e2fcbf42SPeter Maydell is required. 3461bfdc1267SDaniel P. Berrangé ``abstract=on|off`` specifies the use of the abstract socket namespace, 3462e339273bSxiaoqiang zhao rather than the filesystem. Optional, defaults to false. 3463bfdc1267SDaniel P. Berrangé ``tight=on|off`` sets the socket length of abstract sockets to their minimum, 3464e339273bSxiaoqiang zhao rather than the full sun_path length. Optional, defaults to true. 3465e2fcbf42SPeter Maydell 3466bfdc1267SDaniel P. Berrangé``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4=on|off][,ipv6=on|off]`` 3467e2fcbf42SPeter Maydell Sends all traffic from the guest to a remote host over UDP. 3468e2fcbf42SPeter Maydell 3469e2fcbf42SPeter Maydell ``host`` specifies the remote host to connect to. If not specified 3470e2fcbf42SPeter Maydell it defaults to ``localhost``. 3471e2fcbf42SPeter Maydell 3472e2fcbf42SPeter Maydell ``port`` specifies the port on the remote host to connect to. 3473e2fcbf42SPeter Maydell ``port`` is required. 3474e2fcbf42SPeter Maydell 3475e2fcbf42SPeter Maydell ``localaddr`` specifies the local address to bind to. If not 3476e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3477e2fcbf42SPeter Maydell 3478e2fcbf42SPeter Maydell ``localport`` specifies the local port to bind to. If not specified 3479e2fcbf42SPeter Maydell any available local port will be used. 3480e2fcbf42SPeter Maydell 3481bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 or IPv6 must be used. 3482e2fcbf42SPeter Maydell If neither is specified the device may use either protocol. 3483e2fcbf42SPeter Maydell 3484e2fcbf42SPeter Maydell``-chardev msmouse,id=id`` 3485e2fcbf42SPeter Maydell Forward QEMU's emulated msmouse events to the guest. ``msmouse`` 3486e2fcbf42SPeter Maydell does not take any options. 3487e2fcbf42SPeter Maydell 3488e2fcbf42SPeter Maydell``-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]`` 3489e2fcbf42SPeter Maydell Connect to a QEMU text console. ``vc`` may optionally be given a 3490e2fcbf42SPeter Maydell specific size. 3491e2fcbf42SPeter Maydell 3492e2fcbf42SPeter Maydell ``width`` and ``height`` specify the width and height respectively 3493e2fcbf42SPeter Maydell of the console, in pixels. 3494e2fcbf42SPeter Maydell 3495e2fcbf42SPeter Maydell ``cols`` and ``rows`` specify that the console be sized to fit a 3496e2fcbf42SPeter Maydell text console with the given dimensions. 3497e2fcbf42SPeter Maydell 3498e2fcbf42SPeter Maydell``-chardev ringbuf,id=id[,size=size]`` 3499e2fcbf42SPeter Maydell Create a ring buffer with fixed size ``size``. size must be a power 3500e2fcbf42SPeter Maydell of two and defaults to ``64K``. 3501e2fcbf42SPeter Maydell 3502e2fcbf42SPeter Maydell``-chardev file,id=id,path=path`` 3503e2fcbf42SPeter Maydell Log all traffic received from the guest to a file. 3504e2fcbf42SPeter Maydell 3505e2fcbf42SPeter Maydell ``path`` specifies the path of the file to be opened. This file will 3506e2fcbf42SPeter Maydell be created if it does not already exist, and overwritten if it does. 3507e2fcbf42SPeter Maydell ``path`` is required. 3508e2fcbf42SPeter Maydell 3509e2fcbf42SPeter Maydell``-chardev pipe,id=id,path=path`` 3510e2fcbf42SPeter Maydell Create a two-way connection to the guest. The behaviour differs 3511e2fcbf42SPeter Maydell slightly between Windows hosts and other hosts: 3512e2fcbf42SPeter Maydell 3513e2fcbf42SPeter Maydell On Windows, a single duplex pipe will be created at 3514e2fcbf42SPeter Maydell ``\\.pipe\path``. 3515e2fcbf42SPeter Maydell 3516e2fcbf42SPeter Maydell On other hosts, 2 pipes will be created called ``path.in`` and 3517e2fcbf42SPeter Maydell ``path.out``. Data written to ``path.in`` will be received by the 3518e2fcbf42SPeter Maydell guest. Data written by the guest can be read from ``path.out``. QEMU 3519e2fcbf42SPeter Maydell will not create these fifos, and requires them to be present. 3520e2fcbf42SPeter Maydell 3521e2fcbf42SPeter Maydell ``path`` forms part of the pipe path as described above. ``path`` is 3522e2fcbf42SPeter Maydell required. 3523e2fcbf42SPeter Maydell 3524e2fcbf42SPeter Maydell``-chardev console,id=id`` 3525e2fcbf42SPeter Maydell Send traffic from the guest to QEMU's standard output. ``console`` 3526e2fcbf42SPeter Maydell does not take any options. 3527e2fcbf42SPeter Maydell 3528e2fcbf42SPeter Maydell ``console`` is only available on Windows hosts. 3529e2fcbf42SPeter Maydell 3530e2fcbf42SPeter Maydell``-chardev serial,id=id,path=path`` 3531e2fcbf42SPeter Maydell Send traffic from the guest to a serial device on the host. 3532e2fcbf42SPeter Maydell 3533e2fcbf42SPeter Maydell On Unix hosts serial will actually accept any tty device, not only 3534e2fcbf42SPeter Maydell serial lines. 3535e2fcbf42SPeter Maydell 3536e2fcbf42SPeter Maydell ``path`` specifies the name of the serial device to open. 3537e2fcbf42SPeter Maydell 3538e2fcbf42SPeter Maydell``-chardev pty,id=id`` 3539e2fcbf42SPeter Maydell Create a new pseudo-terminal on the host and connect to it. ``pty`` 3540e2fcbf42SPeter Maydell does not take any options. 3541e2fcbf42SPeter Maydell 3542e2fcbf42SPeter Maydell ``pty`` is not available on Windows hosts. 3543e2fcbf42SPeter Maydell 3544e2fcbf42SPeter Maydell``-chardev stdio,id=id[,signal=on|off]`` 3545e2fcbf42SPeter Maydell Connect to standard input and standard output of the QEMU process. 3546e2fcbf42SPeter Maydell 3547e2fcbf42SPeter Maydell ``signal`` controls if signals are enabled on the terminal, that 3548e2fcbf42SPeter Maydell includes exiting QEMU with the key sequence Control-c. This option 3549e2fcbf42SPeter Maydell is enabled by default, use ``signal=off`` to disable it. 3550e2fcbf42SPeter Maydell 3551e2fcbf42SPeter Maydell``-chardev braille,id=id`` 3552e2fcbf42SPeter Maydell Connect to a local BrlAPI server. ``braille`` does not take any 3553e2fcbf42SPeter Maydell options. 3554e2fcbf42SPeter Maydell 3555e2fcbf42SPeter Maydell``-chardev tty,id=id,path=path`` 3556e2fcbf42SPeter Maydell ``tty`` is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD 3557e2fcbf42SPeter Maydell and DragonFlyBSD hosts. It is an alias for ``serial``. 3558e2fcbf42SPeter Maydell 3559e2fcbf42SPeter Maydell ``path`` specifies the path to the tty. ``path`` is required. 3560e2fcbf42SPeter Maydell 356109ce5f2dSPeter Maydell``-chardev parallel,id=id,path=path`` 356209ce5f2dSPeter Maydell \ 356309ce5f2dSPeter Maydell``-chardev parport,id=id,path=path`` 3564e2fcbf42SPeter Maydell ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD 3565e2fcbf42SPeter Maydell hosts. 3566e2fcbf42SPeter Maydell 3567e2fcbf42SPeter Maydell Connect to a local parallel port. 3568e2fcbf42SPeter Maydell 3569e2fcbf42SPeter Maydell ``path`` specifies the path to the parallel port device. ``path`` is 3570e2fcbf42SPeter Maydell required. 3571e2fcbf42SPeter Maydell 3572e2fcbf42SPeter Maydell``-chardev spicevmc,id=id,debug=debug,name=name`` 3573e2fcbf42SPeter Maydell ``spicevmc`` is only available when spice support is built in. 3574e2fcbf42SPeter Maydell 3575e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3576e2fcbf42SPeter Maydell 3577e2fcbf42SPeter Maydell ``name`` name of spice channel to connect to 3578e2fcbf42SPeter Maydell 3579e2fcbf42SPeter Maydell Connect to a spice virtual machine channel, such as vdiport. 3580e2fcbf42SPeter Maydell 3581e2fcbf42SPeter Maydell``-chardev spiceport,id=id,debug=debug,name=name`` 3582e2fcbf42SPeter Maydell ``spiceport`` is only available when spice support is built in. 3583e2fcbf42SPeter Maydell 3584e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3585e2fcbf42SPeter Maydell 3586e2fcbf42SPeter Maydell ``name`` name of spice port to connect to 3587e2fcbf42SPeter Maydell 3588e2fcbf42SPeter Maydell Connect to a spice port, allowing a Spice client to handle the 3589e2fcbf42SPeter Maydell traffic identified by a name (preferably a fqdn). 3590e2fcbf42SPeter MaydellERST 35917273a2dbSMatthew Booth 35927273a2dbSMatthew BoothDEFHEADING() 35937273a2dbSMatthew Booth 3594d1a0cf73SStefan Berger#ifdef CONFIG_TPM 3595de6b4f90SMarkus ArmbrusterDEFHEADING(TPM device options:) 3596d1a0cf73SStefan Berger 3597d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 359892dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 359992dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 360092dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 3601f4ede81eSAmarnath Valluri " not provided it will be searched for in /sys/class/misc/tpm?/device\n" 3602f4ede81eSAmarnath Valluri "-tpmdev emulator,id=id,chardev=dev\n" 3603f4ede81eSAmarnath Valluri " configure the TPM device using chardev backend\n", 3604d1a0cf73SStefan Berger QEMU_ARCH_ALL) 3605e2fcbf42SPeter MaydellSRST 3606e2fcbf42SPeter MaydellThe general form of a TPM device option is: 3607e2fcbf42SPeter Maydell 3608e2fcbf42SPeter Maydell``-tpmdev backend,id=id[,options]`` 3609e2fcbf42SPeter Maydell The specific backend type will determine the applicable options. The 3610e2fcbf42SPeter Maydell ``-tpmdev`` option creates the TPM backend and requires a 3611e2fcbf42SPeter Maydell ``-device`` option that specifies the TPM frontend interface model. 3612e2fcbf42SPeter Maydell 3613e2fcbf42SPeter Maydell Use ``-tpmdev help`` to print all available TPM backend types. 3614e2fcbf42SPeter Maydell 3615e2fcbf42SPeter MaydellThe available backends are: 3616e2fcbf42SPeter Maydell 3617e2fcbf42SPeter Maydell``-tpmdev passthrough,id=id,path=path,cancel-path=cancel-path`` 3618e2fcbf42SPeter Maydell (Linux-host only) Enable access to the host's TPM using the 3619e2fcbf42SPeter Maydell passthrough driver. 3620e2fcbf42SPeter Maydell 3621e2fcbf42SPeter Maydell ``path`` specifies the path to the host's TPM device, i.e., on a 3622e2fcbf42SPeter Maydell Linux host this would be ``/dev/tpm0``. ``path`` is optional and by 3623e2fcbf42SPeter Maydell default ``/dev/tpm0`` is used. 3624e2fcbf42SPeter Maydell 3625e2fcbf42SPeter Maydell ``cancel-path`` specifies the path to the host TPM device's sysfs 3626e2fcbf42SPeter Maydell entry allowing for cancellation of an ongoing TPM command. 3627e2fcbf42SPeter Maydell ``cancel-path`` is optional and by default QEMU will search for the 3628e2fcbf42SPeter Maydell sysfs entry to use. 3629e2fcbf42SPeter Maydell 3630e2fcbf42SPeter Maydell Some notes about using the host's TPM with the passthrough driver: 3631e2fcbf42SPeter Maydell 3632e2fcbf42SPeter Maydell The TPM device accessed by the passthrough driver must not be used 3633e2fcbf42SPeter Maydell by any other application on the host. 3634e2fcbf42SPeter Maydell 3635e2fcbf42SPeter Maydell Since the host's firmware (BIOS/UEFI) has already initialized the 3636e2fcbf42SPeter Maydell TPM, the VM's firmware (BIOS/UEFI) will not be able to initialize 3637e2fcbf42SPeter Maydell the TPM again and may therefore not show a TPM-specific menu that 3638e2fcbf42SPeter Maydell would otherwise allow the user to configure the TPM, e.g., allow the 3639e2fcbf42SPeter Maydell user to enable/disable or activate/deactivate the TPM. Further, if 3640e2fcbf42SPeter Maydell TPM ownership is released from within a VM then the host's TPM will 3641e2fcbf42SPeter Maydell get disabled and deactivated. To enable and activate the TPM again 3642e2fcbf42SPeter Maydell afterwards, the host has to be rebooted and the user is required to 3643e2fcbf42SPeter Maydell enter the firmware's menu to enable and activate the TPM. If the TPM 3644e2fcbf42SPeter Maydell is left disabled and/or deactivated most TPM commands will fail. 3645e2fcbf42SPeter Maydell 3646e2fcbf42SPeter Maydell To create a passthrough TPM use the following two options: 3647e2fcbf42SPeter Maydell 3648e2fcbf42SPeter Maydell :: 3649e2fcbf42SPeter Maydell 3650e2fcbf42SPeter Maydell -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 3651e2fcbf42SPeter Maydell 3652e2fcbf42SPeter Maydell Note that the ``-tpmdev`` id is ``tpm0`` and is referenced by 3653e2fcbf42SPeter Maydell ``tpmdev=tpm0`` in the device option. 3654e2fcbf42SPeter Maydell 3655e2fcbf42SPeter Maydell``-tpmdev emulator,id=id,chardev=dev`` 3656e2fcbf42SPeter Maydell (Linux-host only) Enable access to a TPM emulator using Unix domain 3657e2fcbf42SPeter Maydell socket based chardev backend. 3658e2fcbf42SPeter Maydell 3659e2fcbf42SPeter Maydell ``chardev`` specifies the unique ID of a character device backend 3660e2fcbf42SPeter Maydell that provides connection to the software TPM server. 3661e2fcbf42SPeter Maydell 3662e2fcbf42SPeter Maydell To create a TPM emulator backend device with chardev socket backend: 3663e2fcbf42SPeter Maydell 3664e2fcbf42SPeter Maydell :: 3665e2fcbf42SPeter Maydell 3666e2fcbf42SPeter Maydell -chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0 3667e2fcbf42SPeter MaydellERST 3668d1a0cf73SStefan Berger 3669d1a0cf73SStefan BergerDEFHEADING() 3670d1a0cf73SStefan Berger 3671d1a0cf73SStefan Berger#endif 3672d1a0cf73SStefan Berger 3673de6b4f90SMarkus ArmbrusterDEFHEADING(Linux/Multiboot boot specific:) 3674e2fcbf42SPeter MaydellSRST 3675e2fcbf42SPeter MaydellWhen using these options, you can use a given Linux or Multiboot kernel 3676e2fcbf42SPeter Maydellwithout installing it in the disk image. It can be useful for easier 3677e2fcbf42SPeter Maydelltesting of various kernels. 3678e2fcbf42SPeter Maydell 3679e2fcbf42SPeter Maydell 3680e2fcbf42SPeter MaydellERST 36815824d651Sblueswir1 36825824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 3683ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 3684e2fcbf42SPeter MaydellSRST 3685e2fcbf42SPeter Maydell``-kernel bzImage`` 3686e2fcbf42SPeter Maydell Use bzImage as kernel image. The kernel can be either a Linux kernel 3687e2fcbf42SPeter Maydell or in multiboot format. 3688e2fcbf42SPeter MaydellERST 36895824d651Sblueswir1 36905824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 3691ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 3692e2fcbf42SPeter MaydellSRST 3693e2fcbf42SPeter Maydell``-append cmdline`` 3694e2fcbf42SPeter Maydell Use cmdline as kernel command line 3695e2fcbf42SPeter MaydellERST 36965824d651Sblueswir1 36975824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 3698ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 3699e2fcbf42SPeter MaydellSRST 3700e2fcbf42SPeter Maydell``-initrd file`` 3701e2fcbf42SPeter Maydell Use file as initial ram disk. 3702e2fcbf42SPeter Maydell 3703e2fcbf42SPeter Maydell``-initrd "file1 arg=foo,file2"`` 3704e2fcbf42SPeter Maydell This syntax is only available with multiboot. 3705e2fcbf42SPeter Maydell 3706e2fcbf42SPeter Maydell Use file1 and file2 as modules and pass arg=foo as parameter to the 3707e2fcbf42SPeter Maydell first module. 3708e2fcbf42SPeter MaydellERST 37095824d651Sblueswir1 3710412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 3711379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 3712e2fcbf42SPeter MaydellSRST 3713e2fcbf42SPeter Maydell``-dtb file`` 3714e2fcbf42SPeter Maydell Use file as a device tree binary (dtb) image and pass it to the 3715e2fcbf42SPeter Maydell kernel on boot. 3716e2fcbf42SPeter MaydellERST 3717412beee6SGrant Likely 37185824d651Sblueswir1DEFHEADING() 37195824d651Sblueswir1 3720de6b4f90SMarkus ArmbrusterDEFHEADING(Debug/Expert options:) 37215824d651Sblueswir1 37226dd75472SMarkus ArmbrusterDEF("compat", HAS_ARG, QEMU_OPTION_compat, 3723dbb675c1SMarkus Armbruster "-compat [deprecated-input=accept|reject|crash][,deprecated-output=accept|hide]\n" 372457df0dffSMarkus Armbruster " Policy for handling deprecated management interfaces\n" 372557df0dffSMarkus Armbruster "-compat [unstable-input=accept|reject|crash][,unstable-output=accept|hide]\n" 372657df0dffSMarkus Armbruster " Policy for handling unstable management interfaces\n", 37276dd75472SMarkus Armbruster QEMU_ARCH_ALL) 37286dd75472SMarkus ArmbrusterSRST 37296dd75472SMarkus Armbruster``-compat [deprecated-input=@var{input-policy}][,deprecated-output=@var{output-policy}]`` 37306dd75472SMarkus Armbruster Set policy for handling deprecated management interfaces (experimental): 37316dd75472SMarkus Armbruster 37326dd75472SMarkus Armbruster ``deprecated-input=accept`` (default) 37336dd75472SMarkus Armbruster Accept deprecated commands and arguments 37346dd75472SMarkus Armbruster ``deprecated-input=reject`` 37356dd75472SMarkus Armbruster Reject deprecated commands and arguments 3736dbb675c1SMarkus Armbruster ``deprecated-input=crash`` 3737dbb675c1SMarkus Armbruster Crash on deprecated commands and arguments 37386dd75472SMarkus Armbruster ``deprecated-output=accept`` (default) 37396dd75472SMarkus Armbruster Emit deprecated command results and events 37406dd75472SMarkus Armbruster ``deprecated-output=hide`` 37416dd75472SMarkus Armbruster Suppress deprecated command results and events 37426dd75472SMarkus Armbruster 37436dd75472SMarkus Armbruster Limitation: covers only syntactic aspects of QMP. 374457df0dffSMarkus Armbruster 374557df0dffSMarkus Armbruster``-compat [unstable-input=@var{input-policy}][,unstable-output=@var{output-policy}]`` 374657df0dffSMarkus Armbruster Set policy for handling unstable management interfaces (experimental): 374757df0dffSMarkus Armbruster 374857df0dffSMarkus Armbruster ``unstable-input=accept`` (default) 374957df0dffSMarkus Armbruster Accept unstable commands and arguments 375057df0dffSMarkus Armbruster ``unstable-input=reject`` 375157df0dffSMarkus Armbruster Reject unstable commands and arguments 375257df0dffSMarkus Armbruster ``unstable-input=crash`` 375357df0dffSMarkus Armbruster Crash on unstable commands and arguments 375457df0dffSMarkus Armbruster ``unstable-output=accept`` (default) 375557df0dffSMarkus Armbruster Emit unstable command results and events 375657df0dffSMarkus Armbruster ``unstable-output=hide`` 375757df0dffSMarkus Armbruster Suppress unstable command results and events 375857df0dffSMarkus Armbruster 375957df0dffSMarkus Armbruster Limitation: covers only syntactic aspects of QMP. 37606dd75472SMarkus ArmbrusterERST 37616dd75472SMarkus Armbruster 376281b2b810SGabriel L. SomloDEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 376381b2b810SGabriel L. Somlo "-fw_cfg [name=]<name>,file=<file>\n" 376463d3145aSMarkus Armbruster " add named fw_cfg entry with contents from file\n" 37656407d76eSGabriel L. Somlo "-fw_cfg [name=]<name>,string=<str>\n" 376663d3145aSMarkus Armbruster " add named fw_cfg entry with contents from string\n", 376781b2b810SGabriel L. Somlo QEMU_ARCH_ALL) 3768e2fcbf42SPeter MaydellSRST 3769e2fcbf42SPeter Maydell``-fw_cfg [name=]name,file=file`` 3770e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from file file. 3771e2fcbf42SPeter Maydell 3772e2fcbf42SPeter Maydell``-fw_cfg [name=]name,string=str`` 3773e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from string str. 3774e2fcbf42SPeter Maydell 3775e2fcbf42SPeter Maydell The terminating NUL character of the contents of str will not be 3776e2fcbf42SPeter Maydell included as part of the fw\_cfg item data. To insert contents with 3777e2fcbf42SPeter Maydell embedded NUL characters, you have to use the file parameter. 3778e2fcbf42SPeter Maydell 3779e2fcbf42SPeter Maydell The fw\_cfg entries are passed by QEMU through to the guest. 3780e2fcbf42SPeter Maydell 3781e2fcbf42SPeter Maydell Example: 3782e2fcbf42SPeter Maydell 3783e2fcbf42SPeter Maydell :: 3784e2fcbf42SPeter Maydell 3785e2fcbf42SPeter Maydell -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 3786e2fcbf42SPeter Maydell 3787e2fcbf42SPeter Maydell creates an fw\_cfg entry named opt/com.mycompany/blob with contents 3788e2fcbf42SPeter Maydell from ./my\_blob.bin. 3789e2fcbf42SPeter MaydellERST 379081b2b810SGabriel L. Somlo 37915824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 3792ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 3793ad96090aSBlue Swirl QEMU_ARCH_ALL) 3794e2fcbf42SPeter MaydellSRST 3795e2fcbf42SPeter Maydell``-serial dev`` 3796e2fcbf42SPeter Maydell Redirect the virtual serial port to host character device dev. The 3797e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 3798e2fcbf42SPeter Maydell graphical mode. 3799e2fcbf42SPeter Maydell 3800e2fcbf42SPeter Maydell This option can be used several times to simulate up to 4 serial 3801e2fcbf42SPeter Maydell ports. 3802e2fcbf42SPeter Maydell 3803e2fcbf42SPeter Maydell Use ``-serial none`` to disable all serial ports. 3804e2fcbf42SPeter Maydell 3805e2fcbf42SPeter Maydell Available character devices are: 3806e2fcbf42SPeter Maydell 3807e2fcbf42SPeter Maydell ``vc[:WxH]`` 3808e2fcbf42SPeter Maydell Virtual console. Optionally, a width and height can be given in 3809e2fcbf42SPeter Maydell pixel with 3810e2fcbf42SPeter Maydell 3811e2fcbf42SPeter Maydell :: 3812e2fcbf42SPeter Maydell 3813e2fcbf42SPeter Maydell vc:800x600 3814e2fcbf42SPeter Maydell 3815e2fcbf42SPeter Maydell It is also possible to specify width or height in characters: 3816e2fcbf42SPeter Maydell 3817e2fcbf42SPeter Maydell :: 3818e2fcbf42SPeter Maydell 3819e2fcbf42SPeter Maydell vc:80Cx24C 3820e2fcbf42SPeter Maydell 3821e2fcbf42SPeter Maydell ``pty`` 3822e2fcbf42SPeter Maydell [Linux only] Pseudo TTY (a new PTY is automatically allocated) 3823e2fcbf42SPeter Maydell 3824e2fcbf42SPeter Maydell ``none`` 3825e2fcbf42SPeter Maydell No device is allocated. 3826e2fcbf42SPeter Maydell 3827e2fcbf42SPeter Maydell ``null`` 3828e2fcbf42SPeter Maydell void device 3829e2fcbf42SPeter Maydell 3830e2fcbf42SPeter Maydell ``chardev:id`` 3831e2fcbf42SPeter Maydell Use a named character device defined with the ``-chardev`` 3832e2fcbf42SPeter Maydell option. 3833e2fcbf42SPeter Maydell 3834e2fcbf42SPeter Maydell ``/dev/XXX`` 3835e2fcbf42SPeter Maydell [Linux only] Use host tty, e.g. ``/dev/ttyS0``. The host serial 3836e2fcbf42SPeter Maydell port parameters are set according to the emulated ones. 3837e2fcbf42SPeter Maydell 3838e2fcbf42SPeter Maydell ``/dev/parportN`` 3839e2fcbf42SPeter Maydell [Linux only, parallel port only] Use host parallel port N. 3840e2fcbf42SPeter Maydell Currently SPP and EPP parallel port features can be used. 3841e2fcbf42SPeter Maydell 3842e2fcbf42SPeter Maydell ``file:filename`` 3843e2fcbf42SPeter Maydell Write output to filename. No character can be read. 3844e2fcbf42SPeter Maydell 3845e2fcbf42SPeter Maydell ``stdio`` 3846e2fcbf42SPeter Maydell [Unix only] standard input/output 3847e2fcbf42SPeter Maydell 3848e2fcbf42SPeter Maydell ``pipe:filename`` 3849e2fcbf42SPeter Maydell name pipe filename 3850e2fcbf42SPeter Maydell 3851e2fcbf42SPeter Maydell ``COMn`` 3852e2fcbf42SPeter Maydell [Windows only] Use host serial port n 3853e2fcbf42SPeter Maydell 3854e2fcbf42SPeter Maydell ``udp:[remote_host]:remote_port[@[src_ip]:src_port]`` 3855e2fcbf42SPeter Maydell This implements UDP Net Console. When remote\_host or src\_ip 3856e2fcbf42SPeter Maydell are not specified they default to ``0.0.0.0``. When not using a 3857e2fcbf42SPeter Maydell specified src\_port a random port is automatically chosen. 3858e2fcbf42SPeter Maydell 3859e2fcbf42SPeter Maydell If you just want a simple readonly console you can use 3860e2fcbf42SPeter Maydell ``netcat`` or ``nc``, by starting QEMU with: 3861e2fcbf42SPeter Maydell ``-serial udp::4555`` and nc as: ``nc -u -l -p 4555``. Any time 3862e2fcbf42SPeter Maydell QEMU writes something to that port it will appear in the 3863e2fcbf42SPeter Maydell netconsole session. 3864e2fcbf42SPeter Maydell 3865e2fcbf42SPeter Maydell If you plan to send characters back via netconsole or you want 3866e2fcbf42SPeter Maydell to stop and start QEMU a lot of times, you should have QEMU use 3867e2fcbf42SPeter Maydell the same source port each time by using something like ``-serial 3868e2fcbf42SPeter Maydell udp::4555@:4556`` to QEMU. Another approach is to use a patched 3869e2fcbf42SPeter Maydell version of netcat which can listen to a TCP port and send and 3870e2fcbf42SPeter Maydell receive characters via udp. If you have a patched version of 3871e2fcbf42SPeter Maydell netcat which activates telnet remote echo and single char 3872e2fcbf42SPeter Maydell transfer, then you can use the following options to set up a 3873e2fcbf42SPeter Maydell netcat redirector to allow telnet on port 5555 to access the 3874e2fcbf42SPeter Maydell QEMU port. 3875e2fcbf42SPeter Maydell 3876e2fcbf42SPeter Maydell ``QEMU Options:`` 3877e2fcbf42SPeter Maydell -serial udp::4555@:4556 3878e2fcbf42SPeter Maydell 3879e2fcbf42SPeter Maydell ``netcat options:`` 3880e2fcbf42SPeter Maydell -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 3881e2fcbf42SPeter Maydell 3882e2fcbf42SPeter Maydell ``telnet options:`` 3883e2fcbf42SPeter Maydell localhost 5555 3884e2fcbf42SPeter Maydell 3885a9b1315fSPaolo Bonzini ``tcp:[host]:port[,server=on|off][,wait=on|off][,nodelay=on|off][,reconnect=seconds]`` 3886e2fcbf42SPeter Maydell The TCP Net Console has two modes of operation. It can send the 3887e2fcbf42SPeter Maydell serial I/O to a location or wait for a connection from a 3888e2fcbf42SPeter Maydell location. By default the TCP Net Console is sent to host at the 3889bfdc1267SDaniel P. Berrangé port. If you use the ``server=on`` option QEMU will wait for a client 3890e2fcbf42SPeter Maydell socket application to connect to the port before continuing, 3891a9b1315fSPaolo Bonzini unless the ``wait=on|off`` option was specified. The ``nodelay=on|off`` 3892bfdc1267SDaniel P. Berrangé option disables the Nagle buffering algorithm. The ``reconnect=on`` 3893bfdc1267SDaniel P. Berrangé option only applies if ``server=no`` is set, if the connection goes 3894e2fcbf42SPeter Maydell down it will attempt to reconnect at the given interval. If host 3895e2fcbf42SPeter Maydell is omitted, 0.0.0.0 is assumed. Only one TCP connection at a 3896bfdc1267SDaniel P. Berrangé time is accepted. You can use ``telnet=on`` to connect to the 3897e2fcbf42SPeter Maydell corresponding character device. 3898e2fcbf42SPeter Maydell 3899e2fcbf42SPeter Maydell ``Example to send tcp console to 192.168.0.2 port 4444`` 3900e2fcbf42SPeter Maydell -serial tcp:192.168.0.2:4444 3901e2fcbf42SPeter Maydell 3902e2fcbf42SPeter Maydell ``Example to listen and wait on port 4444 for connection`` 3903bfdc1267SDaniel P. Berrangé -serial tcp::4444,server=on 3904e2fcbf42SPeter Maydell 3905e2fcbf42SPeter Maydell ``Example to not wait and listen on ip 192.168.0.100 port 4444`` 3906bfdc1267SDaniel P. Berrangé -serial tcp:192.168.0.100:4444,server=on,wait=off 3907e2fcbf42SPeter Maydell 3908a9b1315fSPaolo Bonzini ``telnet:host:port[,server=on|off][,wait=on|off][,nodelay=on|off]`` 3909e2fcbf42SPeter Maydell The telnet protocol is used instead of raw tcp sockets. The 3910e2fcbf42SPeter Maydell options work the same as if you had specified ``-serial tcp``. 3911e2fcbf42SPeter Maydell The difference is that the port acts like a telnet server or 3912e2fcbf42SPeter Maydell client using telnet option negotiation. This will also allow you 3913e2fcbf42SPeter Maydell to send the MAGIC\_SYSRQ sequence if you use a telnet that 3914e2fcbf42SPeter Maydell supports sending the break sequence. Typically in unix telnet 3915e2fcbf42SPeter Maydell you do it with Control-] and then type "send break" followed by 3916e2fcbf42SPeter Maydell pressing the enter key. 3917e2fcbf42SPeter Maydell 3918a9b1315fSPaolo Bonzini ``websocket:host:port,server=on[,wait=on|off][,nodelay=on|off]`` 3919e2fcbf42SPeter Maydell The WebSocket protocol is used instead of raw tcp socket. The 3920e2fcbf42SPeter Maydell port acts as a WebSocket server. Client mode is not supported. 3921e2fcbf42SPeter Maydell 3922bfdc1267SDaniel P. Berrangé ``unix:path[,server=on|off][,wait=on|off][,reconnect=seconds]`` 3923e2fcbf42SPeter Maydell A unix domain socket is used instead of a tcp socket. The option 3924e2fcbf42SPeter Maydell works the same as if you had specified ``-serial tcp`` except 3925e2fcbf42SPeter Maydell the unix domain socket path is used for connections. 3926e2fcbf42SPeter Maydell 3927e2fcbf42SPeter Maydell ``mon:dev_string`` 3928e2fcbf42SPeter Maydell This is a special option to allow the monitor to be multiplexed 3929e2fcbf42SPeter Maydell onto another serial port. The monitor is accessed with key 3930e2fcbf42SPeter Maydell sequence of Control-a and then pressing c. dev\_string should be 3931e2fcbf42SPeter Maydell any one of the serial devices specified above. An example to 3932e2fcbf42SPeter Maydell multiplex the monitor onto a telnet server listening on port 3933e2fcbf42SPeter Maydell 4444 would be: 3934e2fcbf42SPeter Maydell 3935bfdc1267SDaniel P. Berrangé ``-serial mon:telnet::4444,server=on,wait=off`` 3936e2fcbf42SPeter Maydell 3937e2fcbf42SPeter Maydell When the monitor is multiplexed to stdio in this way, Ctrl+C 3938e2fcbf42SPeter Maydell will not terminate QEMU any more but will be passed to the guest 3939e2fcbf42SPeter Maydell instead. 3940e2fcbf42SPeter Maydell 3941e2fcbf42SPeter Maydell ``braille`` 3942e2fcbf42SPeter Maydell Braille device. This will use BrlAPI to display the braille 3943e2fcbf42SPeter Maydell output on a real or fake device. 3944e2fcbf42SPeter Maydell 3945e2fcbf42SPeter Maydell ``msmouse`` 3946e2fcbf42SPeter Maydell Three button serial mouse. Configure the guest to use Microsoft 3947e2fcbf42SPeter Maydell protocol. 3948e2fcbf42SPeter MaydellERST 39495824d651Sblueswir1 39505824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 3951ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 3952ad96090aSBlue Swirl QEMU_ARCH_ALL) 3953e2fcbf42SPeter MaydellSRST 3954e2fcbf42SPeter Maydell``-parallel dev`` 3955e2fcbf42SPeter Maydell Redirect the virtual parallel port to host device dev (same devices 3956e2fcbf42SPeter Maydell as the serial port). On Linux hosts, ``/dev/parportN`` can be used 3957e2fcbf42SPeter Maydell to use hardware devices connected on the corresponding host parallel 3958e2fcbf42SPeter Maydell port. 3959e2fcbf42SPeter Maydell 3960e2fcbf42SPeter Maydell This option can be used several times to simulate up to 3 parallel 3961e2fcbf42SPeter Maydell ports. 3962e2fcbf42SPeter Maydell 3963e2fcbf42SPeter Maydell Use ``-parallel none`` to disable all parallel ports. 3964e2fcbf42SPeter MaydellERST 39655824d651Sblueswir1 39665824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3967ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 3968ad96090aSBlue Swirl QEMU_ARCH_ALL) 3969e2fcbf42SPeter MaydellSRST 3970e2fcbf42SPeter Maydell``-monitor dev`` 3971e2fcbf42SPeter Maydell Redirect the monitor to host device dev (same devices as the serial 3972e2fcbf42SPeter Maydell port). The default device is ``vc`` in graphical mode and ``stdio`` 3973e2fcbf42SPeter Maydell in non graphical mode. Use ``-monitor none`` to disable the default 3974e2fcbf42SPeter Maydell monitor. 3975e2fcbf42SPeter MaydellERST 39766ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3977ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 3978ad96090aSBlue Swirl QEMU_ARCH_ALL) 3979e2fcbf42SPeter MaydellSRST 3980e2fcbf42SPeter Maydell``-qmp dev`` 3981e2fcbf42SPeter Maydell Like -monitor but opens in 'control' mode. 3982e2fcbf42SPeter MaydellERST 39834821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 39844821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 39854821cd4cSMax Reitz QEMU_ARCH_ALL) 3986e2fcbf42SPeter MaydellSRST 3987e2fcbf42SPeter Maydell``-qmp-pretty dev`` 3988e2fcbf42SPeter Maydell Like -qmp but uses pretty JSON formatting. 3989e2fcbf42SPeter MaydellERST 39905824d651Sblueswir1 399122a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 3992ef670726SVicente Jimenez Aguilar "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL) 3993e2fcbf42SPeter MaydellSRST 3994e2fcbf42SPeter Maydell``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]`` 399516b3f3bbSAli Shirvani Setup monitor on chardev name. ``mode=control`` configures 399616b3f3bbSAli Shirvani a QMP monitor (a JSON RPC-style protocol) and it is not the 399716b3f3bbSAli Shirvani same as HMP, the human monitor that has a "(qemu)" prompt. 399816b3f3bbSAli Shirvani ``pretty`` is only valid when ``mode=control``, 399916b3f3bbSAli Shirvani turning on JSON pretty printing to ease 4000283d845cSDaniel P. Berrangé human reading and debugging. 4001e2fcbf42SPeter MaydellERST 400222a0e04bSGerd Hoffmann 4003c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 4004ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 4005ad96090aSBlue Swirl QEMU_ARCH_ALL) 4006e2fcbf42SPeter MaydellSRST 4007e2fcbf42SPeter Maydell``-debugcon dev`` 4008e2fcbf42SPeter Maydell Redirect the debug console to host device dev (same devices as the 4009e2fcbf42SPeter Maydell serial port). The debug console is an I/O port which is typically 4010e2fcbf42SPeter Maydell port 0xe9; writing to that I/O port sends output to this device. The 4011e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 4012e2fcbf42SPeter Maydell graphical mode. 4013e2fcbf42SPeter MaydellERST 4014c9f398e5SH. Peter Anvin 40155824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 4016ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 4017e2fcbf42SPeter MaydellSRST 4018e2fcbf42SPeter Maydell``-pidfile file`` 4019e2fcbf42SPeter Maydell Store the QEMU process PID in file. It is useful if you launch QEMU 4020e2fcbf42SPeter Maydell from a script. 4021e2fcbf42SPeter MaydellERST 40225824d651Sblueswir1 40231b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 4024ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 4025e2fcbf42SPeter MaydellSRST 4026e2fcbf42SPeter Maydell``-singlestep`` 4027e2fcbf42SPeter Maydell Run the emulation in single step mode. 4028e2fcbf42SPeter MaydellERST 40291b530a6dSaurel32 4030047f7038SIgor MammedovDEF("preconfig", 0, QEMU_OPTION_preconfig, \ 4031361ac948SMarkus Armbruster "--preconfig pause QEMU before machine is initialized (experimental)\n", 4032047f7038SIgor Mammedov QEMU_ARCH_ALL) 4033e2fcbf42SPeter MaydellSRST 4034e2fcbf42SPeter Maydell``--preconfig`` 4035e2fcbf42SPeter Maydell Pause QEMU for interactive configuration before the machine is 4036e2fcbf42SPeter Maydell created, which allows querying and configuring properties that will 4037e2fcbf42SPeter Maydell affect machine initialization. Use QMP command 'x-exit-preconfig' to 4038e2fcbf42SPeter Maydell exit the preconfig state and move to the next state (i.e. run guest 4039e2fcbf42SPeter Maydell if -S isn't used or pause the second time if -S is used). This 4040e2fcbf42SPeter Maydell option is experimental. 4041e2fcbf42SPeter MaydellERST 4042047f7038SIgor Mammedov 40435824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 4044ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 4045ad96090aSBlue Swirl QEMU_ARCH_ALL) 4046e2fcbf42SPeter MaydellSRST 4047e2fcbf42SPeter Maydell``-S`` 4048e2fcbf42SPeter Maydell Do not start CPU at startup (you must type 'c' in the monitor). 4049e2fcbf42SPeter MaydellERST 40505824d651Sblueswir1 40516f131f13SMichael S. TsirkinDEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit, 4052dfaa7d50SBALATON Zoltan "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n" 40536f131f13SMichael S. Tsirkin " run qemu with overcommit hints\n" 40546f131f13SMichael S. Tsirkin " mem-lock=on|off controls memory lock support (default: off)\n" 40556f131f13SMichael S. Tsirkin " cpu-pm=on|off controls cpu power management (default: off)\n", 40566f131f13SMichael S. Tsirkin QEMU_ARCH_ALL) 4057e2fcbf42SPeter MaydellSRST 4058e2fcbf42SPeter Maydell``-overcommit mem-lock=on|off`` 405909ce5f2dSPeter Maydell \ 4060e2fcbf42SPeter Maydell``-overcommit cpu-pm=on|off`` 4061e2fcbf42SPeter Maydell Run qemu with hints about host resource overcommit. The default is 4062e2fcbf42SPeter Maydell to assume that host overcommits all resources. 4063e2fcbf42SPeter Maydell 4064e2fcbf42SPeter Maydell Locking qemu and guest memory can be enabled via ``mem-lock=on`` 4065e2fcbf42SPeter Maydell (disabled by default). This works when host memory is not 4066c8c9dc42SThomas Huth overcommitted and reduces the worst-case latency for guest. 4067e2fcbf42SPeter Maydell 4068e2fcbf42SPeter Maydell Guest ability to manage power state of host cpus (increasing latency 4069e2fcbf42SPeter Maydell for other processes on the same host cpu, but decreasing latency for 4070e2fcbf42SPeter Maydell guest) can be enabled via ``cpu-pm=on`` (disabled by default). This 4071e2fcbf42SPeter Maydell works best when host CPU is not overcommitted. When used, host 4072e2fcbf42SPeter Maydell estimates of CPU cycle and power utilization will be incorrect, not 4073e2fcbf42SPeter Maydell taking into account guest idle time. 4074e2fcbf42SPeter MaydellERST 40756f131f13SMichael S. Tsirkin 407659030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 4077e5910d42SPeter Maydell "-gdb dev accept gdb connection on 'dev'. (QEMU defaults to starting\n" 4078e5910d42SPeter Maydell " the guest without waiting for gdb to connect; use -S too\n" 4079e5910d42SPeter Maydell " if you want it to not start execution.)\n", 4080e5910d42SPeter Maydell QEMU_ARCH_ALL) 4081e2fcbf42SPeter MaydellSRST 4082e2fcbf42SPeter Maydell``-gdb dev`` 4083923e9311SThomas Huth Accept a gdb connection on device dev (see the :ref:`GDB usage` chapter 4084923e9311SThomas Huth in the System Emulation Users Guide). Note that this option does not pause QEMU 4085e5910d42SPeter Maydell execution -- if you want QEMU to not start the guest until you 4086e5910d42SPeter Maydell connect with gdb and issue a ``continue`` command, you will need to 4087e5910d42SPeter Maydell also pass the ``-S`` option to QEMU. 4088e5910d42SPeter Maydell 4089e5910d42SPeter Maydell The most usual configuration is to listen on a local TCP socket:: 4090e5910d42SPeter Maydell 4091e5910d42SPeter Maydell -gdb tcp::3117 4092e5910d42SPeter Maydell 4093e5910d42SPeter Maydell but you can specify other backends; UDP, pseudo TTY, or even stdio 4094e5910d42SPeter Maydell are all reasonable use cases. For example, a stdio connection 4095e5910d42SPeter Maydell allows you to start QEMU from within gdb and establish the 4096e5910d42SPeter Maydell connection via a pipe: 4097e2fcbf42SPeter Maydell 409809ce5f2dSPeter Maydell .. parsed-literal:: 4099e2fcbf42SPeter Maydell 4100e2fcbf42SPeter Maydell (gdb) target remote | exec |qemu_system| -gdb stdio ... 4101e2fcbf42SPeter MaydellERST 41025824d651Sblueswir1 410359030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 4104ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 4105ad96090aSBlue Swirl QEMU_ARCH_ALL) 4106e2fcbf42SPeter MaydellSRST 4107e2fcbf42SPeter Maydell``-s`` 4108e2fcbf42SPeter Maydell Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 4109923e9311SThomas Huth (see the :ref:`GDB usage` chapter in the System Emulation Users Guide). 4110e2fcbf42SPeter MaydellERST 41115824d651Sblueswir1 41125824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 4113989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 4114ad96090aSBlue Swirl QEMU_ARCH_ALL) 4115e2fcbf42SPeter MaydellSRST 4116e2fcbf42SPeter Maydell``-d item1[,...]`` 4117e2fcbf42SPeter Maydell Enable logging of specified items. Use '-d help' for a list of log 4118e2fcbf42SPeter Maydell items. 4119e2fcbf42SPeter MaydellERST 41205824d651Sblueswir1 4121c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 4122989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 4123c235d738SMatthew Fernandez QEMU_ARCH_ALL) 4124e2fcbf42SPeter MaydellSRST 4125e2fcbf42SPeter Maydell``-D logfile`` 4126e2fcbf42SPeter Maydell Output log in logfile instead of to stderr 4127e2fcbf42SPeter MaydellERST 4128c235d738SMatthew Fernandez 41293514552eSAlex BennéeDEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 41303514552eSAlex Bennée "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 41313514552eSAlex Bennée QEMU_ARCH_ALL) 4132e2fcbf42SPeter MaydellSRST 4133e2fcbf42SPeter Maydell``-dfilter range1[,...]`` 4134e2fcbf42SPeter Maydell Filter debug output to that relevant to a range of target addresses. 4135e2fcbf42SPeter Maydell The filter spec can be either start+size, start-size or start..end 4136e2fcbf42SPeter Maydell where start end and size are the addresses and sizes required. For 4137e2fcbf42SPeter Maydell example: 4138e2fcbf42SPeter Maydell 4139e2fcbf42SPeter Maydell :: 4140e2fcbf42SPeter Maydell 4141e2fcbf42SPeter Maydell -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 4142e2fcbf42SPeter Maydell 4143e2fcbf42SPeter Maydell Will dump output for any code in the 0x1000 sized block starting at 4144e2fcbf42SPeter Maydell 0x8000 and the 0x200 sized block starting at 0xffffffc000080000 and 4145e2fcbf42SPeter Maydell another 0x1000 sized block starting at 0xffffffc00005f000. 4146e2fcbf42SPeter MaydellERST 41473514552eSAlex Bennée 41489c09a251SRichard HendersonDEF("seed", HAS_ARG, QEMU_OPTION_seed, \ 41499c09a251SRichard Henderson "-seed number seed the pseudo-random number generator\n", 41509c09a251SRichard Henderson QEMU_ARCH_ALL) 4151e2fcbf42SPeter MaydellSRST 4152e2fcbf42SPeter Maydell``-seed number`` 4153e2fcbf42SPeter Maydell Force the guest to use a deterministic pseudo-random number 4154e2fcbf42SPeter Maydell generator, seeded with number. This does not affect crypto routines 4155e2fcbf42SPeter Maydell within the host. 4156e2fcbf42SPeter MaydellERST 41579c09a251SRichard Henderson 41585824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 4159ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 4160ad96090aSBlue Swirl QEMU_ARCH_ALL) 4161e2fcbf42SPeter MaydellSRST 4162e2fcbf42SPeter Maydell``-L path`` 4163e2fcbf42SPeter Maydell Set the directory for the BIOS, VGA BIOS and keymaps. 4164e2fcbf42SPeter Maydell 4165e2fcbf42SPeter Maydell To list all the data directories, use ``-L help``. 4166e2fcbf42SPeter MaydellERST 41675824d651Sblueswir1 41685824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 4169ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 4170e2fcbf42SPeter MaydellSRST 4171e2fcbf42SPeter Maydell``-bios file`` 4172e2fcbf42SPeter Maydell Set the filename for the BIOS. 4173e2fcbf42SPeter MaydellERST 41745824d651Sblueswir1 41755824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 417621abf010SThomas Huth "-enable-kvm enable KVM full virtualization support\n", 417721abf010SThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386 | QEMU_ARCH_MIPS | QEMU_ARCH_PPC | 417821abf010SThomas Huth QEMU_ARCH_RISCV | QEMU_ARCH_S390X) 4179e2fcbf42SPeter MaydellSRST 4180e2fcbf42SPeter Maydell``-enable-kvm`` 4181e2fcbf42SPeter Maydell Enable KVM full virtualization support. This option is only 4182e2fcbf42SPeter Maydell available if KVM support is enabled when compiling. 4183e2fcbf42SPeter MaydellERST 41845824d651Sblueswir1 4185e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 4186eeb3647cSThomas Huth "-xen-domid id specify xen guest domain id\n", 4187eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 4188e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 4189e37630caSaliguori "-xen-attach attach to existing xen domain\n" 41901077bcacSAnthony PERARD " libxl will use this when starting QEMU\n", 4191eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 41921c599472SPaul DurrantDEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict, 41931c599472SPaul Durrant "-xen-domid-restrict restrict set of available xen operations\n" 41941c599472SPaul Durrant " to specified domain id. (Does not affect\n" 41951c599472SPaul Durrant " xenpv machine type).\n", 4196eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 4197e2fcbf42SPeter MaydellSRST 4198e2fcbf42SPeter Maydell``-xen-domid id`` 4199e2fcbf42SPeter Maydell Specify xen guest domain id (XEN only). 4200e2fcbf42SPeter Maydell 4201e2fcbf42SPeter Maydell``-xen-attach`` 4202e2fcbf42SPeter Maydell Attach to existing xen domain. libxl will use this when starting 4203e2fcbf42SPeter Maydell QEMU (XEN only). Restrict set of available xen operations to 4204e2fcbf42SPeter Maydell specified domain id (XEN only). 4205e2fcbf42SPeter MaydellERST 4206e37630caSaliguori 42075824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 4208ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 4209e2fcbf42SPeter MaydellSRST 4210e2fcbf42SPeter Maydell``-no-reboot`` 4211e2fcbf42SPeter Maydell Exit instead of rebooting. 4212e2fcbf42SPeter MaydellERST 42135824d651Sblueswir1 42145824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 4215ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 4216e2fcbf42SPeter MaydellSRST 4217e2fcbf42SPeter Maydell``-no-shutdown`` 4218e2fcbf42SPeter Maydell Don't exit QEMU on guest shutdown, but instead only stop the 4219e2fcbf42SPeter Maydell emulation. This allows for instance switching to monitor to commit 4220e2fcbf42SPeter Maydell changes to the disk image. 4221e2fcbf42SPeter MaydellERST 42225824d651Sblueswir1 42232a5ad60bSAlejandro JimenezDEF("action", HAS_ARG, QEMU_OPTION_action, 4224c27025e0SPaolo Bonzini "-action reboot=reset|shutdown\n" 4225c27025e0SPaolo Bonzini " action when guest reboots [default=reset]\n" 42262a5ad60bSAlejandro Jimenez "-action shutdown=poweroff|pause\n" 42272a5ad60bSAlejandro Jimenez " action when guest shuts down [default=poweroff]\n" 4228c27025e0SPaolo Bonzini "-action panic=pause|shutdown|none\n" 4229c27025e0SPaolo Bonzini " action when guest panics [default=shutdown]\n" 42302a5ad60bSAlejandro Jimenez "-action watchdog=reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" 42312a5ad60bSAlejandro Jimenez " action when watchdog fires [default=reset]\n", 42322a5ad60bSAlejandro Jimenez QEMU_ARCH_ALL) 42332a5ad60bSAlejandro JimenezSRST 42342a5ad60bSAlejandro Jimenez``-action event=action`` 42352a5ad60bSAlejandro Jimenez The action parameter serves to modify QEMU's default behavior when 42362a5ad60bSAlejandro Jimenez certain guest events occur. It provides a generic method for specifying the 42372a5ad60bSAlejandro Jimenez same behaviors that are modified by the ``-no-reboot`` and ``-no-shutdown`` 42382a5ad60bSAlejandro Jimenez parameters. 42392a5ad60bSAlejandro Jimenez 42402a5ad60bSAlejandro Jimenez Examples: 42412a5ad60bSAlejandro Jimenez 4242c753e8e7SAlejandro Jimenez ``-action panic=none`` 42432a5ad60bSAlejandro Jimenez ``-action reboot=shutdown,shutdown=pause`` 42442a5ad60bSAlejandro Jimenez ``-watchdog i6300esb -action watchdog=pause`` 42452a5ad60bSAlejandro Jimenez 42462a5ad60bSAlejandro JimenezERST 42472a5ad60bSAlejandro Jimenez 42485824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 42495824d651Sblueswir1 "-loadvm [tag|id]\n" \ 4250ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 4251ad96090aSBlue Swirl QEMU_ARCH_ALL) 4252e2fcbf42SPeter MaydellSRST 4253e2fcbf42SPeter Maydell``-loadvm file`` 4254e2fcbf42SPeter Maydell Start right away with a saved state (``loadvm`` in monitor) 4255e2fcbf42SPeter MaydellERST 42565824d651Sblueswir1 42575824d651Sblueswir1#ifndef _WIN32 42585824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 4259ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 42605824d651Sblueswir1#endif 4261e2fcbf42SPeter MaydellSRST 4262e2fcbf42SPeter Maydell``-daemonize`` 4263e2fcbf42SPeter Maydell Daemonize the QEMU process after initialization. QEMU will not 4264e2fcbf42SPeter Maydell detach from standard IO until it is ready to receive connections on 4265e2fcbf42SPeter Maydell any of its devices. This option is a useful way for external 4266e2fcbf42SPeter Maydell programs to launch QEMU without having to cope with initialization 4267e2fcbf42SPeter Maydell race conditions. 4268e2fcbf42SPeter MaydellERST 42695824d651Sblueswir1 42705824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 4271ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 4272ad96090aSBlue Swirl QEMU_ARCH_ALL) 4273e2fcbf42SPeter MaydellSRST 4274e2fcbf42SPeter Maydell``-option-rom file`` 4275e2fcbf42SPeter Maydell Load the contents of file as an option ROM. This option is useful to 4276e2fcbf42SPeter Maydell load things like EtherBoot. 4277e2fcbf42SPeter MaydellERST 42785824d651Sblueswir1 42791ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 4280238d1240SArtem Pisarenko "-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 4281ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 4282ad96090aSBlue Swirl QEMU_ARCH_ALL) 42831ed2fc1fSJan Kiszka 4284e2fcbf42SPeter MaydellSRST 4285e2fcbf42SPeter Maydell``-rtc [base=utc|localtime|datetime][,clock=host|rt|vm][,driftfix=none|slew]`` 4286e2fcbf42SPeter Maydell Specify ``base`` as ``utc`` or ``localtime`` to let the RTC start at 4287e2fcbf42SPeter Maydell the current UTC or local time, respectively. ``localtime`` is 4288e2fcbf42SPeter Maydell required for correct date in MS-DOS or Windows. To start at a 4289e2fcbf42SPeter Maydell specific point in time, provide datetime in the format 4290e2fcbf42SPeter Maydell ``2006-06-17T16:01:21`` or ``2006-06-17``. The default base is UTC. 4291e2fcbf42SPeter Maydell 4292e2fcbf42SPeter Maydell By default the RTC is driven by the host system time. This allows 4293e2fcbf42SPeter Maydell using of the RTC as accurate reference clock inside the guest, 4294e2fcbf42SPeter Maydell specifically if the host time is smoothly following an accurate 4295e2fcbf42SPeter Maydell external reference clock, e.g. via NTP. If you want to isolate the 4296e2fcbf42SPeter Maydell guest time from the host, you can set ``clock`` to ``rt`` instead, 4297e2fcbf42SPeter Maydell which provides a host monotonic clock if host support it. To even 4298e2fcbf42SPeter Maydell prevent the RTC from progressing during suspension, you can set 4299e2fcbf42SPeter Maydell ``clock`` to ``vm`` (virtual clock). '\ ``clock=vm``\ ' is 4300e2fcbf42SPeter Maydell recommended especially in icount mode in order to preserve 4301e2fcbf42SPeter Maydell determinism; however, note that in icount mode the speed of the 4302e2fcbf42SPeter Maydell virtual clock is variable and can in general differ from the host 4303e2fcbf42SPeter Maydell clock. 4304e2fcbf42SPeter Maydell 4305e2fcbf42SPeter Maydell Enable ``driftfix`` (i386 targets only) if you experience time drift 4306e2fcbf42SPeter Maydell problems, specifically with Windows' ACPI HAL. This option will try 4307e2fcbf42SPeter Maydell to figure out how many timer interrupts were not processed by the 4308e2fcbf42SPeter Maydell Windows guest and will re-inject them. 4309e2fcbf42SPeter MaydellERST 43105824d651Sblueswir1 43115824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 4312fa647905SPeter Maydell "-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=<filename>[,rrsnapshot=<snapshot>]]\n" \ 4313bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 4314f1f4b57eSVictor CLEMENT " instruction, enable aligning the host and virtual clocks\n" \ 4315fa647905SPeter Maydell " or disable real time cpu sleeping, and optionally enable\n" \ 4316fa647905SPeter Maydell " record-and-replay mode\n", QEMU_ARCH_ALL) 4317e2fcbf42SPeter MaydellSRST 4318fa647905SPeter Maydell``-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=filename[,rrsnapshot=snapshot]]`` 4319e2fcbf42SPeter Maydell Enable virtual instruction counter. The virtual cpu will execute one 4320e2fcbf42SPeter Maydell instruction every 2^N ns of virtual time. If ``auto`` is specified 4321e2fcbf42SPeter Maydell then the virtual cpu speed will be automatically adjusted to keep 4322e2fcbf42SPeter Maydell virtual time within a few seconds of real time. 4323e2fcbf42SPeter Maydell 4324e2fcbf42SPeter Maydell Note that while this option can give deterministic behavior, it does 4325e2fcbf42SPeter Maydell not provide cycle accurate emulation. Modern CPUs contain 4326e2fcbf42SPeter Maydell superscalar out of order cores with complex cache hierarchies. The 4327e2fcbf42SPeter Maydell number of instructions executed often has little or no correlation 4328e2fcbf42SPeter Maydell with actual performance. 4329e2fcbf42SPeter Maydell 4330fa647905SPeter Maydell When the virtual cpu is sleeping, the virtual time will advance at 4331fa647905SPeter Maydell default speed unless ``sleep=on`` is specified. With 4332fa647905SPeter Maydell ``sleep=on``, the virtual time will jump to the next timer 4333fa647905SPeter Maydell deadline instantly whenever the virtual cpu goes to sleep mode and 4334fa647905SPeter Maydell will not advance if no timer is enabled. This behavior gives 4335fa647905SPeter Maydell deterministic execution times from the guest point of view. 4336fa647905SPeter Maydell The default if icount is enabled is ``sleep=off``. 4337fa647905SPeter Maydell ``sleep=on`` cannot be used together with either ``shift=auto`` 4338fa647905SPeter Maydell or ``align=on``. 4339fa647905SPeter Maydell 4340e2fcbf42SPeter Maydell ``align=on`` will activate the delay algorithm which will try to 4341e2fcbf42SPeter Maydell synchronise the host clock and the virtual clock. The goal is to 4342e2fcbf42SPeter Maydell have a guest running at the real frequency imposed by the shift 4343e2fcbf42SPeter Maydell option. Whenever the guest clock is behind the host clock and if 4344e2fcbf42SPeter Maydell ``align=on`` is specified then we print a message to the user to 4345e2fcbf42SPeter Maydell inform about the delay. Currently this option does not work when 4346e2fcbf42SPeter Maydell ``shift`` is ``auto``. Note: The sync algorithm will work for those 4347e2fcbf42SPeter Maydell shift values for which the guest clock runs ahead of the host clock. 4348e2fcbf42SPeter Maydell Typically this happens when the shift value is high (how high 4349fa647905SPeter Maydell depends on the host machine). The default if icount is enabled 4350fa647905SPeter Maydell is ``align=off``. 4351e2fcbf42SPeter Maydell 4352fa647905SPeter Maydell When the ``rr`` option is specified deterministic record/replay is 4353fa647905SPeter Maydell enabled. The ``rrfile=`` option must also be provided to 4354fa647905SPeter Maydell specify the path to the replay log. In record mode data is written 4355fa647905SPeter Maydell to this file, and in replay mode it is read back. 4356fa647905SPeter Maydell If the ``rrsnapshot`` option is given then it specifies a VM snapshot 4357fa647905SPeter Maydell name. In record mode, a new VM snapshot with the given name is created 4358fa647905SPeter Maydell at the start of execution recording. In replay mode this option 4359fa647905SPeter Maydell specifies the snapshot name used to load the initial VM state. 4360e2fcbf42SPeter MaydellERST 43615824d651Sblueswir1 43629dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 4363d7933ef3SXu Wang "-watchdog model\n" \ 4364ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 4365ad96090aSBlue Swirl QEMU_ARCH_ALL) 4366e2fcbf42SPeter MaydellSRST 4367e2fcbf42SPeter Maydell``-watchdog model`` 4368e2fcbf42SPeter Maydell Create a virtual hardware watchdog device. Once enabled (by a guest 4369e2fcbf42SPeter Maydell action), the watchdog must be periodically polled by an agent inside 4370e2fcbf42SPeter Maydell the guest or else the guest will be restarted. Choose a model for 4371e2fcbf42SPeter Maydell which your guest has drivers. 4372e2fcbf42SPeter Maydell 4373e2fcbf42SPeter Maydell The model is the model of hardware watchdog to emulate. Use 4374e2fcbf42SPeter Maydell ``-watchdog help`` to list available hardware models. Only one 4375e2fcbf42SPeter Maydell watchdog can be enabled for a guest. 4376e2fcbf42SPeter Maydell 4377e2fcbf42SPeter Maydell The following models may be available: 4378e2fcbf42SPeter Maydell 4379e2fcbf42SPeter Maydell ``ib700`` 4380e2fcbf42SPeter Maydell iBASE 700 is a very simple ISA watchdog with a single timer. 4381e2fcbf42SPeter Maydell 4382e2fcbf42SPeter Maydell ``i6300esb`` 4383e2fcbf42SPeter Maydell Intel 6300ESB I/O controller hub is a much more featureful 4384e2fcbf42SPeter Maydell PCI-based dual-timer watchdog. 4385e2fcbf42SPeter Maydell 4386e2fcbf42SPeter Maydell ``diag288`` 4387e2fcbf42SPeter Maydell A virtual watchdog for s390x backed by the diagnose 288 4388e2fcbf42SPeter Maydell hypercall (currently KVM only). 4389e2fcbf42SPeter MaydellERST 43909dd986ccSRichard W.M. Jones 43919dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 43927ad9270eSMarkus Armbruster "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \ 4393ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 4394ad96090aSBlue Swirl QEMU_ARCH_ALL) 4395e2fcbf42SPeter MaydellSRST 4396e2fcbf42SPeter Maydell``-watchdog-action action`` 4397e2fcbf42SPeter Maydell The action controls what QEMU will do when the watchdog timer 4398e2fcbf42SPeter Maydell expires. The default is ``reset`` (forcefully reset the guest). 4399e2fcbf42SPeter Maydell Other possible actions are: ``shutdown`` (attempt to gracefully 4400e2fcbf42SPeter Maydell shutdown the guest), ``poweroff`` (forcefully poweroff the guest), 4401e2fcbf42SPeter Maydell ``inject-nmi`` (inject a NMI into the guest), ``pause`` (pause the 4402e2fcbf42SPeter Maydell guest), ``debug`` (print a debug message and continue), or ``none`` 4403e2fcbf42SPeter Maydell (do nothing). 4404e2fcbf42SPeter Maydell 4405e2fcbf42SPeter Maydell Note that the ``shutdown`` action requires that the guest responds 4406e2fcbf42SPeter Maydell to ACPI signals, which it may not be able to do in the sort of 4407e2fcbf42SPeter Maydell situations where the watchdog would have expired, and thus 4408e2fcbf42SPeter Maydell ``-watchdog-action shutdown`` is not recommended for production use. 4409e2fcbf42SPeter Maydell 4410e2fcbf42SPeter Maydell Examples: 4411e2fcbf42SPeter Maydell 4412e2fcbf42SPeter Maydell ``-watchdog i6300esb -watchdog-action pause``; \ ``-watchdog ib700`` 4413e2fcbf42SPeter Maydell 4414e2fcbf42SPeter MaydellERST 44159dd986ccSRichard W.M. Jones 44165824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 4417ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 4418ad96090aSBlue Swirl QEMU_ARCH_ALL) 4419e2fcbf42SPeter MaydellSRST 4420e2fcbf42SPeter Maydell``-echr numeric_ascii_value`` 4421e2fcbf42SPeter Maydell Change the escape character used for switching to the monitor when 4422e2fcbf42SPeter Maydell using monitor and serial sharing. The default is ``0x01`` when using 4423e2fcbf42SPeter Maydell the ``-nographic`` option. ``0x01`` is equal to pressing 4424e2fcbf42SPeter Maydell ``Control-a``. You can select a different character from the ascii 4425e2fcbf42SPeter Maydell control keys where 1 through 26 map to Control-a through Control-z. 4426e2fcbf42SPeter Maydell For instance you could use the either of the following to change the 4427e2fcbf42SPeter Maydell escape character to Control-t. 4428e2fcbf42SPeter Maydell 4429e2fcbf42SPeter Maydell ``-echr 0x14``; \ ``-echr 20`` 4430e2fcbf42SPeter Maydell 4431e2fcbf42SPeter MaydellERST 44325824d651Sblueswir1 44335824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 4434bf24095fSDaniel P. Berrangé "-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]\n" \ 4435bf24095fSDaniel P. Berrangé "-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]\n" \ 44367c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 44377c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 44387c601803SMichael Tokarev " specified protocol and socket address\n" \ 44397c601803SMichael Tokarev "-incoming fd:fd\n" \ 44407c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 44417c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 44421597051bSDr. David Alan Gilbert " or from given external command\n" \ 44431597051bSDr. David Alan Gilbert "-incoming defer\n" \ 44441597051bSDr. David Alan Gilbert " wait for the URI to be specified via migrate_incoming\n", 4445ad96090aSBlue Swirl QEMU_ARCH_ALL) 4446e2fcbf42SPeter MaydellSRST 4447bf24095fSDaniel P. Berrangé``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]`` 444809ce5f2dSPeter Maydell \ 4449bf24095fSDaniel P. Berrangé``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]`` 4450e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given tcp port. 4451e2fcbf42SPeter Maydell 4452e2fcbf42SPeter Maydell``-incoming unix:socketpath`` 4453e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given unix socket. 4454e2fcbf42SPeter Maydell 4455e2fcbf42SPeter Maydell``-incoming fd:fd`` 4456e2fcbf42SPeter Maydell Accept incoming migration from a given filedescriptor. 4457e2fcbf42SPeter Maydell 4458e2fcbf42SPeter Maydell``-incoming exec:cmdline`` 4459e2fcbf42SPeter Maydell Accept incoming migration as an output from specified external 4460e2fcbf42SPeter Maydell command. 4461e2fcbf42SPeter Maydell 4462e2fcbf42SPeter Maydell``-incoming defer`` 4463e2fcbf42SPeter Maydell Wait for the URI to be specified via migrate\_incoming. The monitor 4464e2fcbf42SPeter Maydell can be used to change settings (such as migration parameters) prior 4465e2fcbf42SPeter Maydell to issuing the migrate\_incoming to allow the migration to begin. 4466e2fcbf42SPeter MaydellERST 44675824d651Sblueswir1 4468d15c05fcSAshijeet AcharyaDEF("only-migratable", 0, QEMU_OPTION_only_migratable, \ 4469d15c05fcSAshijeet Acharya "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL) 4470e2fcbf42SPeter MaydellSRST 4471e2fcbf42SPeter Maydell``-only-migratable`` 4472e2fcbf42SPeter Maydell Only allow migratable devices. Devices will not be allowed to enter 4473e2fcbf42SPeter Maydell an unmigratable state. 4474e2fcbf42SPeter MaydellERST 4475d15c05fcSAshijeet Acharya 4476d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 4477ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 4478e2fcbf42SPeter MaydellSRST 4479e2fcbf42SPeter Maydell``-nodefaults`` 4480e2fcbf42SPeter Maydell Don't create default devices. Normally, QEMU sets the default 4481e2fcbf42SPeter Maydell devices like serial port, parallel port, virtual console, monitor 4482e2fcbf42SPeter Maydell device, VGA adapter, floppy and CD-ROM drive and others. The 4483e2fcbf42SPeter Maydell ``-nodefaults`` option will disable all those default devices. 4484e2fcbf42SPeter MaydellERST 4485d8c208ddSGerd Hoffmann 44865824d651Sblueswir1#ifndef _WIN32 44875824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 4488ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 4489ad96090aSBlue Swirl QEMU_ARCH_ALL) 44905824d651Sblueswir1#endif 4491e2fcbf42SPeter MaydellSRST 4492e2fcbf42SPeter Maydell``-chroot dir`` 4493e2fcbf42SPeter Maydell Immediately before starting guest execution, chroot to the specified 4494e2fcbf42SPeter Maydell directory. Especially useful in combination with -runas. 4495e2fcbf42SPeter MaydellERST 44965824d651Sblueswir1 44975824d651Sblueswir1#ifndef _WIN32 44985824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 44992c42f1e8SIan Jackson "-runas user change to user id user just before starting the VM\n" \ 45002c42f1e8SIan Jackson " user can be numeric uid:gid instead\n", 4501ad96090aSBlue Swirl QEMU_ARCH_ALL) 45025824d651Sblueswir1#endif 4503e2fcbf42SPeter MaydellSRST 4504e2fcbf42SPeter Maydell``-runas user`` 4505e2fcbf42SPeter Maydell Immediately before starting guest execution, drop root privileges, 4506e2fcbf42SPeter Maydell switching to the specified user. 4507e2fcbf42SPeter MaydellERST 45085824d651Sblueswir1 45095824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 45105824d651Sblueswir1 "-prom-env variable=value\n" 4511ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 4512ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 4513e2fcbf42SPeter MaydellSRST 4514e2fcbf42SPeter Maydell``-prom-env variable=value`` 4515e2fcbf42SPeter Maydell Set OpenBIOS nvram variable to given value (PPC, SPARC only). 4516e2fcbf42SPeter Maydell 4517e2fcbf42SPeter Maydell :: 4518e2fcbf42SPeter Maydell 4519e2fcbf42SPeter Maydell qemu-system-sparc -prom-env 'auto-boot?=false' \ 4520e2fcbf42SPeter Maydell -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' 4521e2fcbf42SPeter Maydell 4522e2fcbf42SPeter Maydell :: 4523e2fcbf42SPeter Maydell 4524e2fcbf42SPeter Maydell qemu-system-ppc -prom-env 'auto-boot?=false' \ 4525e2fcbf42SPeter Maydell -prom-env 'boot-device=hd:2,\yaboot' \ 4526e2fcbf42SPeter Maydell -prom-env 'boot-args=conf=hd:2,\yaboot.conf' 4527e2fcbf42SPeter MaydellERST 45285824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 4529f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 45309d49bcf6SMarkus Armbruster QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | 4531a10b9d93SKeith Packard QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4532e2fcbf42SPeter MaydellSRST 4533e2fcbf42SPeter Maydell``-semihosting`` 4534a10b9d93SKeith Packard Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V only). 4535e2fcbf42SPeter Maydell 4536e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4537e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4538e2fcbf42SPeter Maydell 4539e2fcbf42SPeter Maydell See the -semihosting-config option documentation for further 4540e2fcbf42SPeter Maydell information about the facilities this enables. 4541e2fcbf42SPeter MaydellERST 4542a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 45434e7f9032SAlex Bennée "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \ 4544a59d31a1SLeon Alrae " semihosting configuration\n", 45459d49bcf6SMarkus ArmbrusterQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | 4546a10b9d93SKeith PackardQEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4547e2fcbf42SPeter MaydellSRST 4548e2fcbf42SPeter Maydell``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]`` 4549a10b9d93SKeith Packard Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V 4550e2fcbf42SPeter Maydell only). 4551e2fcbf42SPeter Maydell 4552e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4553e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4554e2fcbf42SPeter Maydell 4555e2fcbf42SPeter Maydell On Arm this implements the standard semihosting API, version 2.0. 4556e2fcbf42SPeter Maydell 4557e2fcbf42SPeter Maydell On M68K this implements the "ColdFire GDB" interface used by 4558e2fcbf42SPeter Maydell libgloss. 4559e2fcbf42SPeter Maydell 4560e2fcbf42SPeter Maydell Xtensa semihosting provides basic file IO calls, such as 4561e2fcbf42SPeter Maydell open/read/write/seek/select. Tensilica baremetal libc for ISS and 4562e2fcbf42SPeter Maydell linux platform "sim" use this interface. 4563e2fcbf42SPeter Maydell 4564a10b9d93SKeith Packard On RISC-V this implements the standard semihosting API, version 0.2. 4565a10b9d93SKeith Packard 4566e2fcbf42SPeter Maydell ``target=native|gdb|auto`` 4567e2fcbf42SPeter Maydell Defines where the semihosting calls will be addressed, to QEMU 4568e2fcbf42SPeter Maydell (``native``) or to GDB (``gdb``). The default is ``auto``, which 4569e2fcbf42SPeter Maydell means ``gdb`` during debug sessions and ``native`` otherwise. 4570e2fcbf42SPeter Maydell 4571e2fcbf42SPeter Maydell ``chardev=str1`` 4572e2fcbf42SPeter Maydell Send the output to a chardev backend output for native or auto 4573e2fcbf42SPeter Maydell output when not in gdb 4574e2fcbf42SPeter Maydell 4575e2fcbf42SPeter Maydell ``arg=str1,arg=str2,...`` 4576e2fcbf42SPeter Maydell Allows the user to pass input arguments, and can be used 4577e2fcbf42SPeter Maydell multiple times to build up a list. The old-style 4578e2fcbf42SPeter Maydell ``-kernel``/``-append`` method of passing a command line is 4579e2fcbf42SPeter Maydell still supported for backward compatibility. If both the 4580e2fcbf42SPeter Maydell ``--semihosting-config arg`` and the ``-kernel``/``-append`` are 4581e2fcbf42SPeter Maydell specified, the former is passed to semihosting as it always 4582e2fcbf42SPeter Maydell takes precedence. 4583e2fcbf42SPeter MaydellERST 45845824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 4585ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 4586e2fcbf42SPeter MaydellSRST 4587e2fcbf42SPeter Maydell``-old-param`` 4588e2fcbf42SPeter Maydell Old param mode (ARM only). 4589e2fcbf42SPeter MaydellERST 459095d5f08bSStefan Weil 45917d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 459273a1e647SEduardo Otubo "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \ 459324f8cdc5SEduardo Otubo " [,spawn=allow|deny][,resourcecontrol=allow|deny]\n" \ 45942b716fa6SEduardo Otubo " Enable seccomp mode 2 system call filter (default 'off').\n" \ 45952b716fa6SEduardo Otubo " use 'obsolete' to allow obsolete system calls that are provided\n" \ 45962b716fa6SEduardo Otubo " by the kernel, but typically no longer used by modern\n" \ 459773a1e647SEduardo Otubo " C library implementations.\n" \ 4598d42304b1SPhilippe Mathieu-Daudé " use 'elevateprivileges' to allow or deny the QEMU process ability\n" \ 4599d42304b1SPhilippe Mathieu-Daudé " to elevate privileges using set*uid|gid system calls.\n" \ 460073a1e647SEduardo Otubo " The value 'children' will deny set*uid|gid system calls for\n" \ 4601995a226fSEduardo Otubo " main QEMU process but will allow forks and execves to run unprivileged\n" \ 4602995a226fSEduardo Otubo " use 'spawn' to avoid QEMU to spawn new threads or processes by\n" \ 4603d42304b1SPhilippe Mathieu-Daudé " blocking *fork and execve\n" \ 460424f8cdc5SEduardo Otubo " use 'resourcecontrol' to disable process affinity and schedular priority\n", 46057d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 4606e2fcbf42SPeter MaydellSRST 4607e2fcbf42SPeter Maydell``-sandbox arg[,obsolete=string][,elevateprivileges=string][,spawn=string][,resourcecontrol=string]`` 4608e2fcbf42SPeter Maydell Enable Seccomp mode 2 system call filter. 'on' will enable syscall 4609e2fcbf42SPeter Maydell filtering and 'off' will disable it. The default is 'off'. 4610e2fcbf42SPeter Maydell 4611e2fcbf42SPeter Maydell ``obsolete=string`` 4612e2fcbf42SPeter Maydell Enable Obsolete system calls 4613e2fcbf42SPeter Maydell 4614e2fcbf42SPeter Maydell ``elevateprivileges=string`` 4615e2fcbf42SPeter Maydell Disable set\*uid\|gid system calls 4616e2fcbf42SPeter Maydell 4617e2fcbf42SPeter Maydell ``spawn=string`` 4618e2fcbf42SPeter Maydell Disable \*fork and execve 4619e2fcbf42SPeter Maydell 4620e2fcbf42SPeter Maydell ``resourcecontrol=string`` 4621e2fcbf42SPeter Maydell Disable process affinity and schedular priority 4622e2fcbf42SPeter MaydellERST 46237d76ad4fSEduardo Otubo 4624715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 4625e960a7eeSPaolo Bonzini "-readconfig <file>\n" 4626e960a7eeSPaolo Bonzini " read config file\n", QEMU_ARCH_ALL) 4627e2fcbf42SPeter MaydellSRST 4628e2fcbf42SPeter Maydell``-readconfig file`` 4629e2fcbf42SPeter Maydell Read device configuration from file. This approach is useful when 4630e2fcbf42SPeter Maydell you want to spawn QEMU process with many command line options but 4631e2fcbf42SPeter Maydell you don't want to exceed the command line character limit. 4632e2fcbf42SPeter MaydellERST 46332feac451SThomas Huth 4634f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 4635f29a5614SEduardo Habkost "-no-user-config\n" 46363478eae9SEduardo Habkost " do not load default user-provided config files at startup\n", 4637f29a5614SEduardo Habkost QEMU_ARCH_ALL) 4638e2fcbf42SPeter MaydellSRST 4639e2fcbf42SPeter Maydell``-no-user-config`` 4640e2fcbf42SPeter Maydell The ``-no-user-config`` option makes QEMU not load any of the 4641e2fcbf42SPeter Maydell user-provided config files on sysconfdir. 4642e2fcbf42SPeter MaydellERST 46432feac451SThomas Huth 4644ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 464510578a25SPaolo Bonzini "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 464623d15e86SLluís " specify tracing options\n", 4647ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 4648e2fcbf42SPeter MaydellSRST 4649e2fcbf42SPeter Maydell``-trace [[enable=]pattern][,events=file][,file=file]`` 465009ce5f2dSPeter Maydell .. include:: ../qemu-option-trace.rst.inc 4651e2fcbf42SPeter Maydell 4652e2fcbf42SPeter MaydellERST 465342229a75SLluís VilanovaDEF("plugin", HAS_ARG, QEMU_OPTION_plugin, 46543a445acbSMahmoud Mandour "-plugin [file=]<file>[,<argname>=<argvalue>]\n" 465542229a75SLluís Vilanova " load a plugin\n", 465642229a75SLluís Vilanova QEMU_ARCH_ALL) 4657e2fcbf42SPeter MaydellSRST 46583a445acbSMahmoud Mandour``-plugin file=file[,argname=argvalue]`` 4659e2fcbf42SPeter Maydell Load a plugin. 4660e2fcbf42SPeter Maydell 4661e2fcbf42SPeter Maydell ``file=file`` 4662e2fcbf42SPeter Maydell Load the given plugin from a shared library file. 4663e2fcbf42SPeter Maydell 46643a445acbSMahmoud Mandour ``argname=argvalue`` 46653a445acbSMahmoud Mandour Argument passed to the plugin. (Can be given multiple times.) 4666e2fcbf42SPeter MaydellERST 46673dbf2c7fSStefan Weil 466831e70d6cSMarkus ArmbrusterHXCOMM Internal use 466931e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 467031e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 4671c7f0f3b1SAnthony Liguori 46725e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 46732880ffb0SMario Smarduch "-msg [timestamp[=on|off]][,guest-name=[on|off]]\n" 4674deda497bSMarkus Armbruster " control error message format\n" 46752880ffb0SMario Smarduch " timestamp=on enables timestamps (default: off)\n" 46762880ffb0SMario Smarduch " guest-name=on enables guest name prefix but only if\n" 46772880ffb0SMario Smarduch " -name guest option is set (default: off)\n", 46785e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 4679e2fcbf42SPeter MaydellSRST 46802880ffb0SMario Smarduch``-msg [timestamp[=on|off]][,guest-name[=on|off]]`` 4681e2fcbf42SPeter Maydell Control error message format. 4682e2fcbf42SPeter Maydell 4683e2fcbf42SPeter Maydell ``timestamp=on|off`` 4684e2fcbf42SPeter Maydell Prefix messages with a timestamp. Default is off. 46852880ffb0SMario Smarduch 46862880ffb0SMario Smarduch ``guest-name=on|off`` 46872880ffb0SMario Smarduch Prefix messages with guest name but only if -name guest option is set 46882880ffb0SMario Smarduch otherwise the option is ignored. Default is off. 4689e2fcbf42SPeter MaydellERST 46905e2ac519SSeiji Aguchi 4691abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 4692abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 4693abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 4694abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 4695abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 46962382053fSLaurent Vivier " by comparing two such vmstate dumps.\n", 4697abfd9ce3SAmit Shah QEMU_ARCH_ALL) 4698e2fcbf42SPeter MaydellSRST 4699e2fcbf42SPeter Maydell``-dump-vmstate file`` 4700e2fcbf42SPeter Maydell Dump json-encoded vmstate information for current machine type to 4701e2fcbf42SPeter Maydell file in file 4702e2fcbf42SPeter MaydellERST 4703abfd9ce3SAmit Shah 470412df189dSEmilio G. CotaDEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile, 470512df189dSEmilio G. Cota "-enable-sync-profile\n" 470612df189dSEmilio G. Cota " enable synchronization profiling\n", 470712df189dSEmilio G. Cota QEMU_ARCH_ALL) 4708e2fcbf42SPeter MaydellSRST 4709e2fcbf42SPeter Maydell``-enable-sync-profile`` 4710e2fcbf42SPeter Maydell Enable synchronization profiling. 4711e2fcbf42SPeter MaydellERST 471212df189dSEmilio G. Cota 471343f187a5SPaolo BonziniDEFHEADING() 4714de6b4f90SMarkus Armbruster 4715de6b4f90SMarkus ArmbrusterDEFHEADING(Generic object creation:) 4716b9174d4fSDaniel P. Berrange 4717b9174d4fSDaniel P. BerrangeDEF("object", HAS_ARG, QEMU_OPTION_object, 4718b9174d4fSDaniel P. Berrange "-object TYPENAME[,PROP1=VALUE1,...]\n" 4719b9174d4fSDaniel P. Berrange " create a new object of type TYPENAME setting properties\n" 4720b9174d4fSDaniel P. Berrange " in the order they are specified. Note that the 'id'\n" 4721b9174d4fSDaniel P. Berrange " property must be set. These objects are placed in the\n" 4722b9174d4fSDaniel P. Berrange " '/objects' path.\n", 4723b9174d4fSDaniel P. Berrange QEMU_ARCH_ALL) 4724e2fcbf42SPeter MaydellSRST 4725e2fcbf42SPeter Maydell``-object typename[,prop1=value1,...]`` 4726e2fcbf42SPeter Maydell Create a new object of type typename setting properties in the order 4727e2fcbf42SPeter Maydell they are specified. Note that the 'id' property must be set. These 4728e2fcbf42SPeter Maydell objects are placed in the '/objects' path. 4729e2fcbf42SPeter Maydell 473086635aa4SStefan 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`` 4731e2fcbf42SPeter Maydell Creates a memory file backend object, which can be used to back 4732e2fcbf42SPeter Maydell the guest RAM with huge pages. 4733e2fcbf42SPeter Maydell 4734e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 473556c9f00eSRobert Hoo reference this memory region in other parameters, e.g. ``-numa``, 473656c9f00eSRobert Hoo ``-device nvdimm``, etc. 4737e2fcbf42SPeter Maydell 4738e2fcbf42SPeter Maydell The ``size`` option provides the size of the memory region, and 473956c9f00eSRobert Hoo accepts common suffixes, e.g. ``500M``. 4740e2fcbf42SPeter Maydell 4741e2fcbf42SPeter Maydell The ``mem-path`` provides the path to either a shared memory or 4742e2fcbf42SPeter Maydell huge page filesystem mount. 4743e2fcbf42SPeter Maydell 4744e2fcbf42SPeter Maydell The ``share`` boolean option determines whether the memory 4745e2fcbf42SPeter Maydell region is marked as private to QEMU, or shared. The latter 4746e2fcbf42SPeter Maydell allows a co-operating external process to access the QEMU memory 4747e2fcbf42SPeter Maydell region. 4748e2fcbf42SPeter Maydell 4749e2fcbf42SPeter Maydell The ``share`` is also required for pvrdma devices due to 4750e2fcbf42SPeter Maydell limitations in the RDMA API provided by Linux. 4751e2fcbf42SPeter Maydell 4752e2fcbf42SPeter Maydell Setting share=on might affect the ability to configure NUMA 4753e2fcbf42SPeter Maydell bindings for the memory backend under some circumstances, see 4754e2fcbf42SPeter Maydell Documentation/vm/numa\_memory\_policy.txt on the Linux kernel 4755e2fcbf42SPeter Maydell source tree for additional details. 4756e2fcbf42SPeter Maydell 4757e2fcbf42SPeter Maydell Setting the ``discard-data`` boolean option to on indicates that 4758e2fcbf42SPeter Maydell file contents can be destroyed when QEMU exits, to avoid 4759e2fcbf42SPeter Maydell unnecessarily flushing data to the backing file. Note that 4760e2fcbf42SPeter Maydell ``discard-data`` is only an optimization, and QEMU might not 4761e2fcbf42SPeter Maydell discard file contents if it aborts unexpectedly or is terminated 4762e2fcbf42SPeter Maydell using SIGKILL. 4763e2fcbf42SPeter Maydell 4764e2fcbf42SPeter Maydell The ``merge`` boolean option enables memory merge, also known as 4765e2fcbf42SPeter Maydell MADV\_MERGEABLE, so that Kernel Samepage Merging will consider 4766e2fcbf42SPeter Maydell the pages for memory deduplication. 4767e2fcbf42SPeter Maydell 4768e2fcbf42SPeter Maydell Setting the ``dump`` boolean option to off excludes the memory 4769e2fcbf42SPeter Maydell from core dumps. This feature is also known as MADV\_DONTDUMP. 4770e2fcbf42SPeter Maydell 4771e2fcbf42SPeter Maydell The ``prealloc`` boolean option enables memory preallocation. 4772e2fcbf42SPeter Maydell 4773e2fcbf42SPeter Maydell The ``host-nodes`` option binds the memory range to a list of 4774e2fcbf42SPeter Maydell NUMA host nodes. 4775e2fcbf42SPeter Maydell 4776e2fcbf42SPeter Maydell The ``policy`` option sets the NUMA policy to one of the 4777e2fcbf42SPeter Maydell following values: 4778e2fcbf42SPeter Maydell 4779e2fcbf42SPeter Maydell ``default`` 4780e2fcbf42SPeter Maydell default host policy 4781e2fcbf42SPeter Maydell 4782e2fcbf42SPeter Maydell ``preferred`` 4783e2fcbf42SPeter Maydell prefer the given host node list for allocation 4784e2fcbf42SPeter Maydell 4785e2fcbf42SPeter Maydell ``bind`` 4786e2fcbf42SPeter Maydell restrict memory allocation to the given host node list 4787e2fcbf42SPeter Maydell 4788e2fcbf42SPeter Maydell ``interleave`` 4789e2fcbf42SPeter Maydell interleave memory allocations across the given host node 4790e2fcbf42SPeter Maydell list 4791e2fcbf42SPeter Maydell 4792e2fcbf42SPeter Maydell The ``align`` option specifies the base address alignment when 4793e2fcbf42SPeter Maydell QEMU mmap(2) ``mem-path``, and accepts common suffixes, eg 4794e2fcbf42SPeter Maydell ``2M``. Some backend store specified by ``mem-path`` requires an 4795e2fcbf42SPeter Maydell alignment different than the default one used by QEMU, eg the 4796e2fcbf42SPeter Maydell device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In 4797e2fcbf42SPeter Maydell such cases, users can specify the required alignment via this 4798e2fcbf42SPeter Maydell option. 4799e2fcbf42SPeter Maydell 4800e2fcbf42SPeter Maydell The ``pmem`` option specifies whether the backing file specified 4801e2fcbf42SPeter Maydell by ``mem-path`` is in host persistent memory that can be 4802e2fcbf42SPeter Maydell accessed using the SNIA NVM programming model (e.g. Intel 4803e2fcbf42SPeter Maydell NVDIMM). If ``pmem`` is set to 'on', QEMU will take necessary 4804e2fcbf42SPeter Maydell operations to guarantee the persistence of its own writes to 4805e2fcbf42SPeter Maydell ``mem-path`` (e.g. in vNVDIMM label emulation and live 4806e2fcbf42SPeter Maydell migration). Also, we will map the backend-file with MAP\_SYNC 4807e2fcbf42SPeter Maydell flag, which ensures the file metadata is in sync for 4808e2fcbf42SPeter Maydell ``mem-path`` in case of host crash or a power failure. MAP\_SYNC 4809e2fcbf42SPeter Maydell requires support from both the host kernel (since Linux kernel 4810e2fcbf42SPeter Maydell 4.15) and the filesystem of ``mem-path`` mounted with DAX 4811e2fcbf42SPeter Maydell option. 4812e2fcbf42SPeter Maydell 481386635aa4SStefan Hajnoczi The ``readonly`` option specifies whether the backing file is opened 481486635aa4SStefan Hajnoczi read-only or read-write (default). 481586635aa4SStefan Hajnoczi 4816e2fcbf42SPeter 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`` 4817e2fcbf42SPeter Maydell Creates a memory backend object, which can be used to back the 4818e2fcbf42SPeter Maydell guest RAM. Memory backend objects offer more control than the 4819e2fcbf42SPeter Maydell ``-m`` option that is traditionally used to define guest RAM. 4820e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 4821e2fcbf42SPeter Maydell options. 4822e2fcbf42SPeter Maydell 4823e2fcbf42SPeter 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`` 4824e2fcbf42SPeter Maydell Creates an anonymous memory file backend object, which allows 4825e2fcbf42SPeter Maydell QEMU to share the memory with an external process (e.g. when 4826e2fcbf42SPeter Maydell using vhost-user). The memory is allocated with memfd and 4827e2fcbf42SPeter Maydell optional sealing. (Linux only) 4828e2fcbf42SPeter Maydell 4829e2fcbf42SPeter Maydell The ``seal`` option creates a sealed-file, that will block 4830e2fcbf42SPeter Maydell further resizing the memory ('on' by default). 4831e2fcbf42SPeter Maydell 4832e2fcbf42SPeter Maydell The ``hugetlb`` option specify the file to be created resides in 4833e2fcbf42SPeter Maydell the hugetlbfs filesystem (since Linux 4.14). Used in conjunction 4834e2fcbf42SPeter Maydell with the ``hugetlb`` option, the ``hugetlbsize`` option specify 4835e2fcbf42SPeter Maydell the hugetlb page size on systems that support multiple hugetlb 4836e2fcbf42SPeter Maydell page sizes (it must be a power of 2 value supported by the 4837e2fcbf42SPeter Maydell system). 4838e2fcbf42SPeter Maydell 4839e2fcbf42SPeter Maydell In some versions of Linux, the ``hugetlb`` option is 4840e2fcbf42SPeter Maydell incompatible with the ``seal`` option (requires at least Linux 4841e2fcbf42SPeter Maydell 4.16). 4842e2fcbf42SPeter Maydell 4843e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 4844e2fcbf42SPeter Maydell other options. 4845e2fcbf42SPeter Maydell 4846e2fcbf42SPeter Maydell The ``share`` boolean option is on by default with memfd. 4847e2fcbf42SPeter Maydell 4848e2fcbf42SPeter Maydell ``-object rng-builtin,id=id`` 4849e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4850e2fcbf42SPeter Maydell from QEMU builtin functions. The ``id`` parameter is a unique ID 4851e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 4852e2fcbf42SPeter Maydell ``virtio-rng`` device. By default, the ``virtio-rng`` device 4853e2fcbf42SPeter Maydell uses this RNG backend. 4854e2fcbf42SPeter Maydell 4855e2fcbf42SPeter Maydell ``-object rng-random,id=id,filename=/dev/random`` 4856e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4857e2fcbf42SPeter Maydell from a device on the host. The ``id`` parameter is a unique ID 4858e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 4859e2fcbf42SPeter Maydell ``virtio-rng`` device. The ``filename`` parameter specifies 4860e2fcbf42SPeter Maydell which file to obtain entropy from and if omitted defaults to 4861e2fcbf42SPeter Maydell ``/dev/urandom``. 4862e2fcbf42SPeter Maydell 4863e2fcbf42SPeter Maydell ``-object rng-egd,id=id,chardev=chardevid`` 4864e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4865e2fcbf42SPeter Maydell from an external daemon running on the host. The ``id`` 4866e2fcbf42SPeter Maydell parameter is a unique ID that will be used to reference this 4867e2fcbf42SPeter Maydell entropy backend from the ``virtio-rng`` device. The ``chardev`` 4868e2fcbf42SPeter Maydell parameter is the unique ID of a character device backend that 4869e2fcbf42SPeter Maydell provides the connection to the RNG daemon. 4870e2fcbf42SPeter Maydell 4871e2fcbf42SPeter Maydell ``-object tls-creds-anon,id=id,endpoint=endpoint,dir=/path/to/cred/dir,verify-peer=on|off`` 4872e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 4873e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 4874e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 4875e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 4876e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 4877e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 4878e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 4879e2fcbf42SPeter Maydell is completed, the peer credentials will be verified, though this 4880e2fcbf42SPeter Maydell is a no-op for anonymous credentials. 4881e2fcbf42SPeter Maydell 4882e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 4883e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 4884e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 4885e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 4886e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 4887e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4888e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 4889e2fcbf42SPeter Maydell upfront and saved. 4890e2fcbf42SPeter Maydell 4891e2fcbf42SPeter Maydell ``-object tls-creds-psk,id=id,endpoint=endpoint,dir=/path/to/keys/dir[,username=username]`` 4892e2fcbf42SPeter Maydell Creates a TLS Pre-Shared Keys (PSK) credentials object, which 4893e2fcbf42SPeter Maydell can be used to provide TLS support on network backends. The 4894e2fcbf42SPeter Maydell ``id`` parameter is a unique ID which network backends will use 4895e2fcbf42SPeter Maydell to access the credentials. The ``endpoint`` is either ``server`` 4896e2fcbf42SPeter Maydell or ``client`` depending on whether the QEMU network backend that 4897e2fcbf42SPeter Maydell uses the credentials will be acting as a client or as a server. 4898e2fcbf42SPeter Maydell For clients only, ``username`` is the username which will be 4899e2fcbf42SPeter Maydell sent to the server. If omitted it defaults to "qemu". 4900e2fcbf42SPeter Maydell 4901e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the keys file. It is 4902e2fcbf42SPeter Maydell called "dir/keys.psk" and contains "username:key" pairs. This 4903e2fcbf42SPeter Maydell file can most easily be created using the GnuTLS ``psktool`` 4904e2fcbf42SPeter Maydell program. 4905e2fcbf42SPeter Maydell 4906e2fcbf42SPeter Maydell For server endpoints, dir may also contain a file dh-params.pem 4907e2fcbf42SPeter Maydell providing diffie-hellman parameters to use for the TLS server. 4908e2fcbf42SPeter Maydell If the file is missing, QEMU will generate a set of DH 4909e2fcbf42SPeter Maydell parameters at startup. This is a computationally expensive 4910e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4911e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated up 4912e2fcbf42SPeter Maydell front and saved. 4913e2fcbf42SPeter Maydell 4914e2fcbf42SPeter Maydell ``-object tls-creds-x509,id=id,endpoint=endpoint,dir=/path/to/cred/dir,priority=priority,verify-peer=on|off,passwordid=id`` 4915e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 4916e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 4917e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 4918e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 4919e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 4920e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 4921e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 4922e2fcbf42SPeter Maydell is completed, the peer credentials will be verified. With x509 4923e2fcbf42SPeter Maydell certificates, this implies that the clients must be provided 4924e2fcbf42SPeter Maydell with valid client certificates too. 4925e2fcbf42SPeter Maydell 4926e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 4927e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 4928e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 4929e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 4930e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 4931e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4932e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 4933e2fcbf42SPeter Maydell upfront and saved. 4934e2fcbf42SPeter Maydell 4935e2fcbf42SPeter Maydell For x509 certificate credentials the directory will contain 4936e2fcbf42SPeter Maydell further files providing the x509 certificates. The certificates 4937e2fcbf42SPeter Maydell must be stored in PEM format, in filenames ca-cert.pem, 4938e2fcbf42SPeter Maydell ca-crl.pem (optional), server-cert.pem (only servers), 4939e2fcbf42SPeter Maydell server-key.pem (only servers), client-cert.pem (only clients), 4940e2fcbf42SPeter Maydell and client-key.pem (only clients). 4941e2fcbf42SPeter Maydell 4942e2fcbf42SPeter Maydell For the server-key.pem and client-key.pem files which contain 4943e2fcbf42SPeter Maydell sensitive private keys, it is possible to use an encrypted 4944e2fcbf42SPeter Maydell version by providing the passwordid parameter. This provides the 4945e2fcbf42SPeter Maydell ID of a previously created ``secret`` object containing the 4946e2fcbf42SPeter Maydell password for decryption. 4947e2fcbf42SPeter Maydell 4948e2fcbf42SPeter Maydell The priority parameter allows to override the global default 4949e2fcbf42SPeter Maydell priority used by gnutls. This can be useful if the system 4950e2fcbf42SPeter Maydell administrator needs to use a weaker set of crypto priorities for 4951e2fcbf42SPeter Maydell QEMU without potentially forcing the weakness onto all 4952e2fcbf42SPeter Maydell applications. Or conversely if one wants wants a stronger 4953e2fcbf42SPeter Maydell default for QEMU than for all other applications, they can do 4954e2fcbf42SPeter Maydell this through this parameter. Its format is a gnutls priority 4955e2fcbf42SPeter Maydell string as described at 4956e2fcbf42SPeter Maydell https://gnutls.org/manual/html_node/Priority-Strings.html. 4957e2fcbf42SPeter Maydell 4958993aec27SPhilippe Mathieu-Daudé ``-object tls-cipher-suites,id=id,priority=priority`` 4959993aec27SPhilippe Mathieu-Daudé Creates a TLS cipher suites object, which can be used to control 4960993aec27SPhilippe Mathieu-Daudé the TLS cipher/protocol algorithms that applications are permitted 4961993aec27SPhilippe Mathieu-Daudé to use. 4962993aec27SPhilippe Mathieu-Daudé 4963993aec27SPhilippe Mathieu-Daudé The ``id`` parameter is a unique ID which frontends will use to 4964993aec27SPhilippe Mathieu-Daudé access the ordered list of permitted TLS cipher suites from the 4965993aec27SPhilippe Mathieu-Daudé host. 4966993aec27SPhilippe Mathieu-Daudé 4967993aec27SPhilippe Mathieu-Daudé The ``priority`` parameter allows to override the global default 4968993aec27SPhilippe Mathieu-Daudé priority used by gnutls. This can be useful if the system 4969993aec27SPhilippe Mathieu-Daudé administrator needs to use a weaker set of crypto priorities for 4970993aec27SPhilippe Mathieu-Daudé QEMU without potentially forcing the weakness onto all 4971993aec27SPhilippe Mathieu-Daudé applications. Or conversely if one wants wants a stronger 4972993aec27SPhilippe Mathieu-Daudé default for QEMU than for all other applications, they can do 4973993aec27SPhilippe Mathieu-Daudé this through this parameter. Its format is a gnutls priority 4974993aec27SPhilippe Mathieu-Daudé string as described at 4975993aec27SPhilippe Mathieu-Daudé https://gnutls.org/manual/html_node/Priority-Strings.html. 4976993aec27SPhilippe Mathieu-Daudé 497769699f30SPhilippe Mathieu-Daudé An example of use of this object is to control UEFI HTTPS Boot. 497869699f30SPhilippe Mathieu-Daudé The tls-cipher-suites object exposes the ordered list of permitted 497969699f30SPhilippe Mathieu-Daudé TLS cipher suites from the host side to the guest firmware, via 498069699f30SPhilippe Mathieu-Daudé fw_cfg. The list is represented as an array of IANA_TLS_CIPHER 498169699f30SPhilippe Mathieu-Daudé objects. The firmware uses the IANA_TLS_CIPHER array for configuring 498269699f30SPhilippe Mathieu-Daudé guest-side TLS. 498369699f30SPhilippe Mathieu-Daudé 498469699f30SPhilippe Mathieu-Daudé In the following example, the priority at which the host-side policy 498569699f30SPhilippe Mathieu-Daudé is retrieved is given by the ``priority`` property. 498669699f30SPhilippe Mathieu-Daudé Given that QEMU uses GNUTLS, ``priority=@SYSTEM`` may be used to 498769699f30SPhilippe Mathieu-Daudé refer to /etc/crypto-policies/back-ends/gnutls.config. 498869699f30SPhilippe Mathieu-Daudé 498969699f30SPhilippe Mathieu-Daudé .. parsed-literal:: 499069699f30SPhilippe Mathieu-Daudé 4991353a06b4SLaszlo Ersek # |qemu_system| \\ 4992353a06b4SLaszlo Ersek -object tls-cipher-suites,id=mysuite0,priority=@SYSTEM \\ 499369699f30SPhilippe Mathieu-Daudé -fw_cfg name=etc/edk2/https/ciphers,gen_id=mysuite0 499469699f30SPhilippe Mathieu-Daudé 4995e2fcbf42SPeter 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]`` 4996e2fcbf42SPeter Maydell Interval t can't be 0, this filter batches the packet delivery: 4997e2fcbf42SPeter Maydell all packets arriving in a given interval on netdev netdevid are 4998e2fcbf42SPeter Maydell delayed until the end of the interval. Interval is in 4999e2fcbf42SPeter Maydell microseconds. ``status`` is optional that indicate whether the 5000e2fcbf42SPeter Maydell netfilter is on (enabled) or off (disabled), the default status 5001e2fcbf42SPeter Maydell for netfilter will be 'on'. 5002e2fcbf42SPeter Maydell 5003e2fcbf42SPeter Maydell queue all\|rx\|tx is an option that can be applied to any 5004e2fcbf42SPeter Maydell netfilter. 5005e2fcbf42SPeter Maydell 5006e2fcbf42SPeter Maydell ``all``: the filter is attached both to the receive and the 5007e2fcbf42SPeter Maydell transmit queue of the netdev (default). 5008e2fcbf42SPeter Maydell 5009e2fcbf42SPeter Maydell ``rx``: the filter is attached to the receive queue of the 5010e2fcbf42SPeter Maydell netdev, where it will receive packets sent to the netdev. 5011e2fcbf42SPeter Maydell 5012e2fcbf42SPeter Maydell ``tx``: the filter is attached to the transmit queue of the 5013e2fcbf42SPeter Maydell netdev, where it will receive packets sent by the netdev. 5014e2fcbf42SPeter Maydell 5015e2fcbf42SPeter Maydell position head\|tail\|id=<id> is an option to specify where the 5016e2fcbf42SPeter Maydell filter should be inserted in the filter list. It can be applied 5017e2fcbf42SPeter Maydell to any netfilter. 5018e2fcbf42SPeter Maydell 5019e2fcbf42SPeter Maydell ``head``: the filter is inserted at the head of the filter list, 5020e2fcbf42SPeter Maydell before any existing filters. 5021e2fcbf42SPeter Maydell 5022e2fcbf42SPeter Maydell ``tail``: the filter is inserted at the tail of the filter list, 5023e2fcbf42SPeter Maydell behind any existing filters (default). 5024e2fcbf42SPeter Maydell 5025e2fcbf42SPeter Maydell ``id=<id>``: the filter is inserted before or behind the filter 5026e2fcbf42SPeter Maydell specified by <id>, see the insert option below. 5027e2fcbf42SPeter Maydell 5028e2fcbf42SPeter Maydell insert behind\|before is an option to specify where to insert 5029e2fcbf42SPeter Maydell the new filter relative to the one specified with 5030e2fcbf42SPeter Maydell position=id=<id>. It can be applied to any netfilter. 5031e2fcbf42SPeter Maydell 5032e2fcbf42SPeter Maydell ``before``: insert before the specified filter. 5033e2fcbf42SPeter Maydell 5034e2fcbf42SPeter Maydell ``behind``: insert behind the specified filter (default). 5035e2fcbf42SPeter Maydell 5036e2fcbf42SPeter 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]`` 5037e2fcbf42SPeter Maydell filter-mirror on netdev netdevid,mirror net packet to 5038e2fcbf42SPeter Maydell chardevchardevid, if it has the vnet\_hdr\_support flag, 5039e2fcbf42SPeter Maydell filter-mirror will mirror packet with vnet\_hdr\_len. 5040e2fcbf42SPeter Maydell 5041e2fcbf42SPeter 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]`` 5042e2fcbf42SPeter Maydell filter-redirector on netdev netdevid,redirect filter's net 5043e2fcbf42SPeter Maydell packet to chardev chardevid,and redirect indev's packet to 5044e2fcbf42SPeter Maydell filter.if it has the vnet\_hdr\_support flag, filter-redirector 5045e2fcbf42SPeter Maydell will redirect packet with vnet\_hdr\_len. Create a 5046e2fcbf42SPeter Maydell filter-redirector we need to differ outdev id from indev id, id 5047e2fcbf42SPeter Maydell can not be the same. we can just use indev or outdev, but at 5048e2fcbf42SPeter Maydell least one of indev or outdev need to be specified. 5049e2fcbf42SPeter Maydell 5050e2fcbf42SPeter Maydell ``-object filter-rewriter,id=id,netdev=netdevid,queue=all|rx|tx,[vnet_hdr_support][,position=head|tail|id=<id>][,insert=behind|before]`` 5051e2fcbf42SPeter Maydell Filter-rewriter is a part of COLO project.It will rewrite tcp 5052e2fcbf42SPeter Maydell packet to secondary from primary to keep secondary tcp 5053e2fcbf42SPeter Maydell connection,and rewrite tcp packet to primary from secondary make 5054e2fcbf42SPeter Maydell tcp packet can be handled by client.if it has the 5055e2fcbf42SPeter Maydell vnet\_hdr\_support flag, we can parse packet with vnet header. 5056e2fcbf42SPeter Maydell 5057e2fcbf42SPeter Maydell usage: colo secondary: -object 5058e2fcbf42SPeter Maydell filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 -object 5059e2fcbf42SPeter Maydell filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 -object 5060e2fcbf42SPeter Maydell filter-rewriter,id=rew0,netdev=hn0,queue=all 5061e2fcbf42SPeter Maydell 5062e2fcbf42SPeter Maydell ``-object filter-dump,id=id,netdev=dev[,file=filename][,maxlen=len][,position=head|tail|id=<id>][,insert=behind|before]`` 5063e2fcbf42SPeter Maydell Dump the network traffic on netdev dev to the file specified by 5064e2fcbf42SPeter Maydell filename. At most len bytes (64k by default) per packet are 5065e2fcbf42SPeter Maydell stored. The file format is libpcap, so it can be analyzed with 5066e2fcbf42SPeter Maydell tools such as tcpdump or Wireshark. 5067e2fcbf42SPeter Maydell 5068a2e5cb7aSZhang 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}]`` 5069e2fcbf42SPeter Maydell Colo-compare gets packet from primary\_in chardevid and 50702b28a7efSZhang Chen secondary\_in, then compare whether the payload of primary packet 50712b28a7efSZhang Chen and secondary packet are the same. If same, it will output 50722b28a7efSZhang Chen primary packet to out\_dev, else it will notify COLO-framework to do 50732b28a7efSZhang Chen checkpoint and send primary packet to out\_dev. In order to 50742b28a7efSZhang Chen improve efficiency, we need to put the task of comparison in 50752b28a7efSZhang Chen another iothread. If it has the vnet\_hdr\_support flag, 50762b28a7efSZhang Chen colo compare will send/recv packet with vnet\_hdr\_len. 50772b28a7efSZhang Chen The compare\_timeout=@var{ms} determines the maximum time of the 50782b28a7efSZhang Chen colo-compare hold the packet. The expired\_scan\_cycle=@var{ms} 50792b28a7efSZhang Chen is to set the period of scanning expired primary node network packets. 50802b28a7efSZhang Chen The max\_queue\_size=@var{size} is to set the max compare queue 50812b28a7efSZhang Chen size depend on user environment. 50822b28a7efSZhang Chen If user want to use Xen COLO, need to add the notify\_dev to 50839cc43c94SZhang Chen notify Xen colo-frame to do checkpoint. 5084e2fcbf42SPeter Maydell 50852b28a7efSZhang Chen COLO-compare must be used with the help of filter-mirror, 50862b28a7efSZhang Chen filter-redirector and filter-rewriter. 5087e2fcbf42SPeter Maydell 5088e2fcbf42SPeter Maydell :: 5089e2fcbf42SPeter Maydell 5090e2fcbf42SPeter Maydell KVM COLO 5091e2fcbf42SPeter Maydell 5092e2fcbf42SPeter Maydell primary: 5093e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 5094e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 5095bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 5096bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 5097bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 5098e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 5099bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 5100e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 5101e2fcbf42SPeter Maydell -object iothread,id=iothread1 5102e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 5103e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 5104e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 5105e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1 5106e2fcbf42SPeter Maydell 5107e2fcbf42SPeter Maydell secondary: 5108e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 5109e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 5110e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 5111e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 5112e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 5113e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 5114e2fcbf42SPeter Maydell 5115e2fcbf42SPeter Maydell 5116e2fcbf42SPeter Maydell Xen COLO 5117e2fcbf42SPeter Maydell 5118e2fcbf42SPeter Maydell primary: 5119e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 5120e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 5121bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 5122bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 5123bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 5124e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 5125bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 5126e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 5127bfdc1267SDaniel P. Berrangé -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server=on,wait=off 5128e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 5129e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 5130e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 5131e2fcbf42SPeter Maydell -object iothread,id=iothread1 5132e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1 5133e2fcbf42SPeter Maydell 5134e2fcbf42SPeter Maydell secondary: 5135e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 5136e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 5137e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 5138e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 5139e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 5140e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 5141e2fcbf42SPeter Maydell 5142e2fcbf42SPeter Maydell If you want to know the detail of above command line, you can 5143e2fcbf42SPeter Maydell read the colo-compare git log. 5144e2fcbf42SPeter Maydell 5145e2fcbf42SPeter Maydell ``-object cryptodev-backend-builtin,id=id[,queues=queues]`` 5146e2fcbf42SPeter Maydell Creates a cryptodev backend which executes crypto opreation from 5147e2fcbf42SPeter Maydell the QEMU cipher APIS. The id parameter is a unique ID that will 5148e2fcbf42SPeter Maydell be used to reference this cryptodev backend from the 5149e2fcbf42SPeter Maydell ``virtio-crypto`` device. The queues parameter is optional, 5150e2fcbf42SPeter Maydell which specify the queue number of cryptodev backend, the default 5151e2fcbf42SPeter Maydell of queues is 1. 5152e2fcbf42SPeter Maydell 515309ce5f2dSPeter Maydell .. parsed-literal:: 5154e2fcbf42SPeter Maydell 5155353a06b4SLaszlo Ersek # |qemu_system| \\ 5156353a06b4SLaszlo Ersek [...] \\ 5157353a06b4SLaszlo Ersek -object cryptodev-backend-builtin,id=cryptodev0 \\ 5158353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 5159e2fcbf42SPeter Maydell [...] 5160e2fcbf42SPeter Maydell 5161e2fcbf42SPeter Maydell ``-object cryptodev-vhost-user,id=id,chardev=chardevid[,queues=queues]`` 5162e2fcbf42SPeter Maydell Creates a vhost-user cryptodev backend, backed by a chardev 5163e2fcbf42SPeter Maydell chardevid. The id parameter is a unique ID that will be used to 5164e2fcbf42SPeter Maydell reference this cryptodev backend from the ``virtio-crypto`` 5165e2fcbf42SPeter Maydell device. The chardev should be a unix domain socket backed one. 5166e2fcbf42SPeter Maydell The vhost-user uses a specifically defined protocol to pass 5167e2fcbf42SPeter Maydell vhost ioctl replacement messages to an application on the other 5168e2fcbf42SPeter Maydell end of the socket. The queues parameter is optional, which 5169e2fcbf42SPeter Maydell specify the queue number of cryptodev backend for multiqueue 5170e2fcbf42SPeter Maydell vhost-user, the default of queues is 1. 5171e2fcbf42SPeter Maydell 517209ce5f2dSPeter Maydell .. parsed-literal:: 5173e2fcbf42SPeter Maydell 5174353a06b4SLaszlo Ersek # |qemu_system| \\ 5175353a06b4SLaszlo Ersek [...] \\ 5176353a06b4SLaszlo Ersek -chardev socket,id=chardev0,path=/path/to/socket \\ 5177353a06b4SLaszlo Ersek -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \\ 5178353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 5179e2fcbf42SPeter Maydell [...] 5180e2fcbf42SPeter Maydell 5181e2fcbf42SPeter Maydell ``-object secret,id=id,data=string,format=raw|base64[,keyid=secretid,iv=string]`` 518209ce5f2dSPeter Maydell \ 5183e2fcbf42SPeter Maydell ``-object secret,id=id,file=filename,format=raw|base64[,keyid=secretid,iv=string]`` 5184e2fcbf42SPeter Maydell Defines a secret to store a password, encryption key, or some 5185e2fcbf42SPeter Maydell other sensitive data. The sensitive data can either be passed 5186e2fcbf42SPeter Maydell directly via the data parameter, or indirectly via the file 5187e2fcbf42SPeter Maydell parameter. Using the data parameter is insecure unless the 5188e2fcbf42SPeter Maydell sensitive data is encrypted. 5189e2fcbf42SPeter Maydell 5190e2fcbf42SPeter Maydell The sensitive data can be provided in raw format (the default), 5191e2fcbf42SPeter Maydell or base64. When encoded as JSON, the raw format only supports 5192e2fcbf42SPeter Maydell valid UTF-8 characters, so base64 is recommended for sending 5193e2fcbf42SPeter Maydell binary data. QEMU will convert from which ever format is 5194e2fcbf42SPeter Maydell provided to the format it needs internally. eg, an RBD password 5195e2fcbf42SPeter Maydell can be provided in raw format, even though it will be base64 5196e2fcbf42SPeter Maydell encoded when passed onto the RBD sever. 5197e2fcbf42SPeter Maydell 5198e2fcbf42SPeter Maydell For added protection, it is possible to encrypt the data 5199e2fcbf42SPeter Maydell associated with a secret using the AES-256-CBC cipher. Use of 5200e2fcbf42SPeter Maydell encryption is indicated by providing the keyid and iv 5201e2fcbf42SPeter Maydell parameters. The keyid parameter provides the ID of a previously 5202e2fcbf42SPeter Maydell defined secret that contains the AES-256 decryption key. This 5203e2fcbf42SPeter Maydell key should be 32-bytes long and be base64 encoded. The iv 5204e2fcbf42SPeter Maydell parameter provides the random initialization vector used for 5205e2fcbf42SPeter Maydell encryption of this particular secret and should be a base64 5206e2fcbf42SPeter Maydell encrypted string of the 16-byte IV. 5207e2fcbf42SPeter Maydell 5208e2fcbf42SPeter Maydell The simplest (insecure) usage is to provide the secret inline 5209e2fcbf42SPeter Maydell 521009ce5f2dSPeter Maydell .. parsed-literal:: 5211e2fcbf42SPeter Maydell 5212e2fcbf42SPeter Maydell # |qemu_system| -object secret,id=sec0,data=letmein,format=raw 5213e2fcbf42SPeter Maydell 5214e2fcbf42SPeter Maydell The simplest secure usage is to provide the secret via a file 5215e2fcbf42SPeter Maydell 5216e2fcbf42SPeter Maydell # printf "letmein" > mypasswd.txt # QEMU\_SYSTEM\_MACRO -object 5217e2fcbf42SPeter Maydell secret,id=sec0,file=mypasswd.txt,format=raw 5218e2fcbf42SPeter Maydell 5219e2fcbf42SPeter Maydell For greater security, AES-256-CBC should be used. To illustrate 5220e2fcbf42SPeter Maydell usage, consider the openssl command line tool which can encrypt 5221e2fcbf42SPeter Maydell the data. Note that when encrypting, the plaintext must be 5222e2fcbf42SPeter Maydell padded to the cipher block size (32 bytes) using the standard 5223e2fcbf42SPeter Maydell PKCS#5/6 compatible padding algorithm. 5224e2fcbf42SPeter Maydell 5225e2fcbf42SPeter Maydell First a master key needs to be created in base64 encoding: 5226e2fcbf42SPeter Maydell 5227e2fcbf42SPeter Maydell :: 5228e2fcbf42SPeter Maydell 5229e2fcbf42SPeter Maydell # openssl rand -base64 32 > key.b64 5230e2fcbf42SPeter Maydell # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 5231e2fcbf42SPeter Maydell 5232e2fcbf42SPeter Maydell Each secret to be encrypted needs to have a random 5233e2fcbf42SPeter Maydell initialization vector generated. These do not need to be kept 5234e2fcbf42SPeter Maydell secret 5235e2fcbf42SPeter Maydell 5236e2fcbf42SPeter Maydell :: 5237e2fcbf42SPeter Maydell 5238e2fcbf42SPeter Maydell # openssl rand -base64 16 > iv.b64 5239e2fcbf42SPeter Maydell # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 5240e2fcbf42SPeter Maydell 5241e2fcbf42SPeter Maydell The secret to be defined can now be encrypted, in this case 5242e2fcbf42SPeter Maydell we're telling openssl to base64 encode the result, but it could 5243e2fcbf42SPeter Maydell be left as raw bytes if desired. 5244e2fcbf42SPeter Maydell 5245e2fcbf42SPeter Maydell :: 5246e2fcbf42SPeter Maydell 5247e2fcbf42SPeter Maydell # SECRET=$(printf "letmein" | 5248e2fcbf42SPeter Maydell openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 5249e2fcbf42SPeter Maydell 5250e2fcbf42SPeter Maydell When launching QEMU, create a master secret pointing to 5251e2fcbf42SPeter Maydell ``key.b64`` and specify that to be used to decrypt the user 5252e2fcbf42SPeter Maydell password. Pass the contents of ``iv.b64`` to the second secret 5253e2fcbf42SPeter Maydell 525409ce5f2dSPeter Maydell .. parsed-literal:: 5255e2fcbf42SPeter Maydell 5256353a06b4SLaszlo Ersek # |qemu_system| \\ 5257353a06b4SLaszlo Ersek -object secret,id=secmaster0,format=base64,file=key.b64 \\ 5258353a06b4SLaszlo Ersek -object secret,id=sec0,keyid=secmaster0,format=base64,\\ 5259e2fcbf42SPeter Maydell data=$SECRET,iv=$(<iv.b64) 5260e2fcbf42SPeter Maydell 526155cdf566SDov Murik ``-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,kernel-hashes=on|off]`` 5262e2fcbf42SPeter Maydell Create a Secure Encrypted Virtualization (SEV) guest object, 5263e2fcbf42SPeter Maydell which can be used to provide the guest memory encryption support 5264e2fcbf42SPeter Maydell on AMD processors. 5265e2fcbf42SPeter Maydell 5266e2fcbf42SPeter Maydell When memory encryption is enabled, one of the physical address 5267e2fcbf42SPeter Maydell bit (aka the C-bit) is utilized to mark if a memory page is 5268e2fcbf42SPeter Maydell protected. The ``cbitpos`` is used to provide the C-bit 5269e2fcbf42SPeter Maydell position. The C-bit position is Host family dependent hence user 5270e2fcbf42SPeter Maydell must provide this value. On EPYC, the value should be 47. 5271e2fcbf42SPeter Maydell 5272e2fcbf42SPeter Maydell When memory encryption is enabled, we loose certain bits in 5273e2fcbf42SPeter Maydell physical address space. The ``reduced-phys-bits`` is used to 5274e2fcbf42SPeter Maydell provide the number of bits we loose in physical address space. 5275e2fcbf42SPeter Maydell Similar to C-bit, the value is Host family dependent. On EPYC, 5276e2fcbf42SPeter Maydell the value should be 5. 5277e2fcbf42SPeter Maydell 5278e2fcbf42SPeter Maydell The ``sev-device`` provides the device file to use for 5279e2fcbf42SPeter Maydell communicating with the SEV firmware running inside AMD Secure 5280e2fcbf42SPeter Maydell Processor. The default device is '/dev/sev'. If hardware 5281e2fcbf42SPeter Maydell supports memory encryption then /dev/sev devices are created by 5282e2fcbf42SPeter Maydell CCP driver. 5283e2fcbf42SPeter Maydell 5284e2fcbf42SPeter Maydell The ``policy`` provides the guest policy to be enforced by the 5285e2fcbf42SPeter Maydell SEV firmware and restrict what configuration and operational 5286e2fcbf42SPeter Maydell commands can be performed on this guest by the hypervisor. The 5287e2fcbf42SPeter Maydell policy should be provided by the guest owner and is bound to the 5288e2fcbf42SPeter Maydell guest and cannot be changed throughout the lifetime of the 5289e2fcbf42SPeter Maydell guest. The default is 0. 5290e2fcbf42SPeter Maydell 5291e2fcbf42SPeter Maydell If guest ``policy`` allows sharing the key with another SEV 5292e2fcbf42SPeter Maydell guest then ``handle`` can be use to provide handle of the guest 5293e2fcbf42SPeter Maydell from which to share the key. 5294e2fcbf42SPeter Maydell 5295e2fcbf42SPeter Maydell The ``dh-cert-file`` and ``session-file`` provides the guest 5296e2fcbf42SPeter Maydell owner's Public Diffie-Hillman key defined in SEV spec. The PDH 5297e2fcbf42SPeter Maydell and session parameters are used for establishing a cryptographic 5298e2fcbf42SPeter Maydell session with the guest owner to negotiate keys used for 5299e2fcbf42SPeter Maydell attestation. The file must be encoded in base64. 5300e2fcbf42SPeter Maydell 530155cdf566SDov Murik The ``kernel-hashes`` adds the hashes of given kernel/initrd/ 530255cdf566SDov Murik cmdline to a designated guest firmware page for measured Linux 530355cdf566SDov Murik boot with -kernel. The default is off. (Since 6.2) 530455cdf566SDov Murik 5305e2fcbf42SPeter Maydell e.g to launch a SEV guest 5306e2fcbf42SPeter Maydell 530709ce5f2dSPeter Maydell .. parsed-literal:: 5308e2fcbf42SPeter Maydell 5309353a06b4SLaszlo Ersek # |qemu_system_x86| \\ 5310353a06b4SLaszlo Ersek ...... \\ 5311353a06b4SLaszlo Ersek -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \\ 5312353a06b4SLaszlo Ersek -machine ...,memory-encryption=sev0 \\ 5313e2fcbf42SPeter Maydell ..... 5314e2fcbf42SPeter Maydell 5315e2fcbf42SPeter Maydell ``-object authz-simple,id=id,identity=string`` 5316e2fcbf42SPeter Maydell Create an authorization object that will control access to 5317e2fcbf42SPeter Maydell network services. 5318e2fcbf42SPeter Maydell 5319e2fcbf42SPeter Maydell The ``identity`` parameter is identifies the user and its format 5320e2fcbf42SPeter Maydell depends on the network service that authorization object is 5321e2fcbf42SPeter Maydell associated with. For authorizing based on TLS x509 certificates, 5322e2fcbf42SPeter Maydell the identity must be the x509 distinguished name. Note that care 5323e2fcbf42SPeter Maydell must be taken to escape any commas in the distinguished name. 5324e2fcbf42SPeter Maydell 5325e2fcbf42SPeter Maydell An example authorization object to validate a x509 distinguished 5326e2fcbf42SPeter Maydell name would look like: 5327e2fcbf42SPeter Maydell 532809ce5f2dSPeter Maydell .. parsed-literal:: 5329e2fcbf42SPeter Maydell 5330353a06b4SLaszlo Ersek # |qemu_system| \\ 5331353a06b4SLaszlo Ersek ... \\ 5332353a06b4SLaszlo Ersek -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \\ 5333e2fcbf42SPeter Maydell ... 5334e2fcbf42SPeter Maydell 5335e2fcbf42SPeter Maydell Note the use of quotes due to the x509 distinguished name 5336e2fcbf42SPeter Maydell containing whitespace, and escaping of ','. 5337e2fcbf42SPeter Maydell 53384d7beeabSDaniel P. Berrangé ``-object authz-listfile,id=id,filename=path,refresh=on|off`` 5339e2fcbf42SPeter Maydell Create an authorization object that will control access to 5340e2fcbf42SPeter Maydell network services. 5341e2fcbf42SPeter Maydell 5342e2fcbf42SPeter Maydell The ``filename`` parameter is the fully qualified path to a file 5343e2fcbf42SPeter Maydell containing the access control list rules in JSON format. 5344e2fcbf42SPeter Maydell 5345e2fcbf42SPeter Maydell An example set of rules that match against SASL usernames might 5346e2fcbf42SPeter Maydell look like: 5347e2fcbf42SPeter Maydell 5348e2fcbf42SPeter Maydell :: 5349e2fcbf42SPeter Maydell 5350e2fcbf42SPeter Maydell { 5351e2fcbf42SPeter Maydell "rules": [ 5352e2fcbf42SPeter Maydell { "match": "fred", "policy": "allow", "format": "exact" }, 5353e2fcbf42SPeter Maydell { "match": "bob", "policy": "allow", "format": "exact" }, 5354e2fcbf42SPeter Maydell { "match": "danb", "policy": "deny", "format": "glob" }, 5355e2fcbf42SPeter Maydell { "match": "dan*", "policy": "allow", "format": "exact" }, 5356e2fcbf42SPeter Maydell ], 5357e2fcbf42SPeter Maydell "policy": "deny" 5358e2fcbf42SPeter Maydell } 5359e2fcbf42SPeter Maydell 5360e2fcbf42SPeter Maydell When checking access the object will iterate over all the rules 5361e2fcbf42SPeter Maydell and the first rule to match will have its ``policy`` value 5362e2fcbf42SPeter Maydell returned as the result. If no rules match, then the default 5363e2fcbf42SPeter Maydell ``policy`` value is returned. 5364e2fcbf42SPeter Maydell 5365e2fcbf42SPeter Maydell The rules can either be an exact string match, or they can use 5366e2fcbf42SPeter Maydell the simple UNIX glob pattern matching to allow wildcards to be 5367e2fcbf42SPeter Maydell used. 5368e2fcbf42SPeter Maydell 5369e2fcbf42SPeter Maydell If ``refresh`` is set to true the file will be monitored and 5370e2fcbf42SPeter Maydell automatically reloaded whenever its content changes. 5371e2fcbf42SPeter Maydell 5372e2fcbf42SPeter Maydell As with the ``authz-simple`` object, the format of the identity 5373e2fcbf42SPeter Maydell strings being matched depends on the network service, but is 5374e2fcbf42SPeter Maydell usually a TLS x509 distinguished name, or a SASL username. 5375e2fcbf42SPeter Maydell 5376e2fcbf42SPeter Maydell An example authorization object to validate a SASL username 5377e2fcbf42SPeter Maydell would look like: 5378e2fcbf42SPeter Maydell 537909ce5f2dSPeter Maydell .. parsed-literal:: 5380e2fcbf42SPeter Maydell 5381353a06b4SLaszlo Ersek # |qemu_system| \\ 5382353a06b4SLaszlo Ersek ... \\ 53834d7beeabSDaniel P. Berrangé -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=on \\ 5384e2fcbf42SPeter Maydell ... 5385e2fcbf42SPeter Maydell 5386e2fcbf42SPeter Maydell ``-object authz-pam,id=id,service=string`` 5387e2fcbf42SPeter Maydell Create an authorization object that will control access to 5388e2fcbf42SPeter Maydell network services. 5389e2fcbf42SPeter Maydell 5390e2fcbf42SPeter Maydell The ``service`` parameter provides the name of a PAM service to 5391e2fcbf42SPeter Maydell use for authorization. It requires that a file 5392e2fcbf42SPeter Maydell ``/etc/pam.d/service`` exist to provide the configuration for 5393e2fcbf42SPeter Maydell the ``account`` subsystem. 5394e2fcbf42SPeter Maydell 5395e2fcbf42SPeter Maydell An example authorization object to validate a TLS x509 5396e2fcbf42SPeter Maydell distinguished name would look like: 5397e2fcbf42SPeter Maydell 539809ce5f2dSPeter Maydell .. parsed-literal:: 5399e2fcbf42SPeter Maydell 5400353a06b4SLaszlo Ersek # |qemu_system| \\ 5401353a06b4SLaszlo Ersek ... \\ 5402353a06b4SLaszlo Ersek -object authz-pam,id=auth0,service=qemu-vnc \\ 5403e2fcbf42SPeter Maydell ... 5404e2fcbf42SPeter Maydell 5405e2fcbf42SPeter Maydell There would then be a corresponding config file for PAM at 5406e2fcbf42SPeter Maydell ``/etc/pam.d/qemu-vnc`` that contains: 5407e2fcbf42SPeter Maydell 5408e2fcbf42SPeter Maydell :: 5409e2fcbf42SPeter Maydell 5410e2fcbf42SPeter Maydell account requisite pam_listfile.so item=user sense=allow \ 5411e2fcbf42SPeter Maydell file=/etc/qemu/vnc.allow 5412e2fcbf42SPeter Maydell 5413e2fcbf42SPeter Maydell Finally the ``/etc/qemu/vnc.allow`` file would contain the list 5414e2fcbf42SPeter Maydell of x509 distingished names that are permitted access 5415e2fcbf42SPeter Maydell 5416e2fcbf42SPeter Maydell :: 5417e2fcbf42SPeter Maydell 5418e2fcbf42SPeter Maydell CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB 5419e2fcbf42SPeter Maydell 54201793ad02SStefano Garzarella ``-object iothread,id=id,poll-max-ns=poll-max-ns,poll-grow=poll-grow,poll-shrink=poll-shrink,aio-max-batch=aio-max-batch`` 5421e2fcbf42SPeter Maydell Creates a dedicated event loop thread that devices can be 5422e2fcbf42SPeter Maydell assigned to. This is known as an IOThread. By default device 5423e2fcbf42SPeter Maydell emulation happens in vCPU threads or the main event loop thread. 5424e2fcbf42SPeter Maydell This can become a scalability bottleneck. IOThreads allow device 5425e2fcbf42SPeter Maydell emulation and I/O to run on other host CPUs. 5426e2fcbf42SPeter Maydell 5427e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 5428e2fcbf42SPeter Maydell reference this IOThread from ``-device ...,iothread=id``. 5429e2fcbf42SPeter Maydell Multiple devices can be assigned to an IOThread. Note that not 5430e2fcbf42SPeter Maydell all devices support an ``iothread`` parameter. 5431e2fcbf42SPeter Maydell 5432e2fcbf42SPeter Maydell The ``query-iothreads`` QMP command lists IOThreads and reports 5433e2fcbf42SPeter Maydell their thread IDs so that the user can configure host CPU 5434e2fcbf42SPeter Maydell pinning/affinity. 5435e2fcbf42SPeter Maydell 5436e2fcbf42SPeter Maydell IOThreads use an adaptive polling algorithm to reduce event loop 5437e2fcbf42SPeter Maydell latency. Instead of entering a blocking system call to monitor 5438e2fcbf42SPeter Maydell file descriptors and then pay the cost of being woken up when an 5439e2fcbf42SPeter Maydell event occurs, the polling algorithm spins waiting for events for 5440e2fcbf42SPeter Maydell a short time. The algorithm's default parameters are suitable 5441e2fcbf42SPeter Maydell for many cases but can be adjusted based on knowledge of the 5442e2fcbf42SPeter Maydell workload and/or host device latency. 5443e2fcbf42SPeter Maydell 5444e2fcbf42SPeter Maydell The ``poll-max-ns`` parameter is the maximum number of 5445e2fcbf42SPeter Maydell nanoseconds to busy wait for events. Polling can be disabled by 5446e2fcbf42SPeter Maydell setting this value to 0. 5447e2fcbf42SPeter Maydell 5448e2fcbf42SPeter Maydell The ``poll-grow`` parameter is the multiplier used to increase 5449e2fcbf42SPeter Maydell the polling time when the algorithm detects it is missing events 5450e2fcbf42SPeter Maydell due to not polling long enough. 5451e2fcbf42SPeter Maydell 5452e2fcbf42SPeter Maydell The ``poll-shrink`` parameter is the divisor used to decrease 5453e2fcbf42SPeter Maydell the polling time when the algorithm detects it is spending too 5454e2fcbf42SPeter Maydell long polling without encountering events. 5455e2fcbf42SPeter Maydell 54561793ad02SStefano Garzarella The ``aio-max-batch`` parameter is the maximum number of requests 54571793ad02SStefano Garzarella in a batch for the AIO engine, 0 means that the engine will use 54581793ad02SStefano Garzarella its default. 54591793ad02SStefano Garzarella 54601793ad02SStefano Garzarella The IOThread parameters can be modified at run-time using the 5461e2fcbf42SPeter Maydell ``qom-set`` command (where ``iothread1`` is the IOThread's 5462e2fcbf42SPeter Maydell ``id``): 5463e2fcbf42SPeter Maydell 5464e2fcbf42SPeter Maydell :: 5465e2fcbf42SPeter Maydell 5466e2fcbf42SPeter Maydell (qemu) qom-set /objects/iothread1 poll-max-ns 100000 5467e2fcbf42SPeter MaydellERST 5468b9174d4fSDaniel P. Berrange 5469b9174d4fSDaniel P. Berrange 54703dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 5471fd5fc4b1SPaolo Bonzini 5472fd5fc4b1SPaolo Bonzini#undef DEF 5473fd5fc4b1SPaolo Bonzini#undef DEFHEADING 5474fd5fc4b1SPaolo Bonzini#undef ARCHHEADING 5475