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" 3903b39fcfSJonathan Cameron " memory-backend='backend-id' specifies explicitly provided backend for main RAM (default=none)\n" 4003b39fcfSJonathan Cameron " cxl-fmw.0.targets.0=firsttarget,cxl-fmw.0.targets.1=secondtarget,cxl-fmw.0.size=size[,cxl-fmw.0.interleave-granularity=granularity]\n", 4180f52a66SJan Kiszka QEMU_ARCH_ALL) 42e2fcbf42SPeter MaydellSRST 43e2fcbf42SPeter Maydell``-machine [type=]name[,prop=value[,...]]`` 44e2fcbf42SPeter Maydell Select the emulated machine by name. Use ``-machine help`` to list 45e2fcbf42SPeter Maydell available machines. 46e2fcbf42SPeter Maydell 47e2fcbf42SPeter Maydell For architectures which aim to support live migration compatibility 48e2fcbf42SPeter Maydell across releases, each release will introduce a new versioned machine 49e2fcbf42SPeter Maydell type. For example, the 2.8.0 release introduced machine types 50e2fcbf42SPeter Maydell "pc-i440fx-2.8" and "pc-q35-2.8" for the x86\_64/i686 architectures. 51e2fcbf42SPeter Maydell 52e2fcbf42SPeter Maydell To allow live migration of guests from QEMU version 2.8.0, to QEMU 53e2fcbf42SPeter Maydell version 2.9.0, the 2.9.0 version must support the "pc-i440fx-2.8" 54e2fcbf42SPeter Maydell and "pc-q35-2.8" machines too. To allow users live migrating VMs to 55e2fcbf42SPeter Maydell skip multiple intermediate releases when upgrading, new releases of 56e2fcbf42SPeter Maydell QEMU will support machine types from many previous versions. 57e2fcbf42SPeter Maydell 58e2fcbf42SPeter Maydell Supported machine properties are: 59e2fcbf42SPeter Maydell 60e2fcbf42SPeter Maydell ``accel=accels1[:accels2[:...]]`` 61e2fcbf42SPeter Maydell This is used to enable an accelerator. Depending on the target 6274a414a1SReinoud Zandijk architecture, kvm, xen, hax, hvf, nvmm, whpx or tcg can be available. 63e2fcbf42SPeter Maydell By default, tcg is used. If there is more than one accelerator 64e2fcbf42SPeter Maydell specified, the next one is used if the previous one fails to 65e2fcbf42SPeter Maydell initialize. 66e2fcbf42SPeter Maydell 67e2fcbf42SPeter Maydell ``vmport=on|off|auto`` 68e2fcbf42SPeter Maydell Enables emulation of VMWare IO port, for vmmouse etc. auto says 69e2fcbf42SPeter Maydell to select the value based on accel. For accel=xen the default is 70e2fcbf42SPeter Maydell off otherwise the default is on. 71e2fcbf42SPeter Maydell 72e2fcbf42SPeter Maydell ``dump-guest-core=on|off`` 73e2fcbf42SPeter Maydell Include guest memory in a core dump. The default is on. 74e2fcbf42SPeter Maydell 75e2fcbf42SPeter Maydell ``mem-merge=on|off`` 76e2fcbf42SPeter Maydell Enables or disables memory merge support. This feature, when 77e2fcbf42SPeter Maydell supported by the host, de-duplicates identical memory pages 78e2fcbf42SPeter Maydell among VMs instances (enabled by default). 79e2fcbf42SPeter Maydell 80e2fcbf42SPeter Maydell ``aes-key-wrap=on|off`` 81e2fcbf42SPeter Maydell Enables or disables AES key wrapping support on s390-ccw hosts. 82e2fcbf42SPeter Maydell This feature controls whether AES wrapping keys will be created 83e2fcbf42SPeter Maydell to allow execution of AES cryptographic functions. The default 84e2fcbf42SPeter Maydell is on. 85e2fcbf42SPeter Maydell 86e2fcbf42SPeter Maydell ``dea-key-wrap=on|off`` 87e2fcbf42SPeter Maydell Enables or disables DEA key wrapping support on s390-ccw hosts. 88e2fcbf42SPeter Maydell This feature controls whether DEA wrapping keys will be created 89e2fcbf42SPeter Maydell to allow execution of DEA cryptographic functions. The default 90e2fcbf42SPeter Maydell is on. 91e2fcbf42SPeter Maydell 92e2fcbf42SPeter Maydell ``nvdimm=on|off`` 93e2fcbf42SPeter Maydell Enables or disables NVDIMM support. The default is off. 94e2fcbf42SPeter Maydell 95e2fcbf42SPeter Maydell ``memory-encryption=`` 96e2fcbf42SPeter Maydell Memory encryption object to use. The default is none. 97e2fcbf42SPeter Maydell 98e2fcbf42SPeter Maydell ``hmat=on|off`` 99e2fcbf42SPeter Maydell Enables or disables ACPI Heterogeneous Memory Attribute Table 100e2fcbf42SPeter Maydell (HMAT) support. The default is off. 1018db0b204SIgor Mammedov 1028db0b204SIgor Mammedov ``memory-backend='id'`` 1038db0b204SIgor Mammedov An alternative to legacy ``-mem-path`` and ``mem-prealloc`` options. 1048db0b204SIgor Mammedov Allows to use a memory backend as main RAM. 1058db0b204SIgor Mammedov 1068db0b204SIgor Mammedov For example: 1078db0b204SIgor Mammedov :: 10895355829SPeter Maydell 1098db0b204SIgor Mammedov -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on 1108db0b204SIgor Mammedov -machine memory-backend=pc.ram 1118db0b204SIgor Mammedov -m 512M 1128db0b204SIgor Mammedov 1138db0b204SIgor Mammedov Migration compatibility note: 11495355829SPeter Maydell 11595355829SPeter Maydell * as backend id one shall use value of 'default-ram-id', advertised by 1168db0b204SIgor Mammedov machine type (available via ``query-machines`` QMP command), if migration 1178db0b204SIgor Mammedov to/from old QEMU (<5.0) is expected. 11895355829SPeter Maydell * for machine types 4.0 and older, user shall 1198db0b204SIgor Mammedov use ``x-use-canonical-path-for-ramblock-id=off`` backend option 1208db0b204SIgor Mammedov if migration to/from old QEMU (<5.0) is expected. 12195355829SPeter Maydell 1228db0b204SIgor Mammedov For example: 1238db0b204SIgor Mammedov :: 12495355829SPeter Maydell 1258db0b204SIgor Mammedov -object memory-backend-ram,id=pc.ram,size=512M,x-use-canonical-path-for-ramblock-id=off 1268db0b204SIgor Mammedov -machine memory-backend=pc.ram 1278db0b204SIgor Mammedov -m 512M 12803b39fcfSJonathan Cameron 12903b39fcfSJonathan Cameron ``cxl-fmw.0.targets.0=firsttarget,cxl-fmw.0.targets.1=secondtarget,cxl-fmw.0.size=size[,cxl-fmw.0.interleave-granularity=granularity]`` 13003b39fcfSJonathan Cameron Define a CXL Fixed Memory Window (CFMW). 13103b39fcfSJonathan Cameron 13203b39fcfSJonathan Cameron Described in the CXL 2.0 ECN: CEDT CFMWS & QTG _DSM. 13303b39fcfSJonathan Cameron 13403b39fcfSJonathan Cameron They are regions of Host Physical Addresses (HPA) on a system which 13503b39fcfSJonathan Cameron may be interleaved across one or more CXL host bridges. The system 13603b39fcfSJonathan Cameron software will assign particular devices into these windows and 13703b39fcfSJonathan Cameron configure the downstream Host-managed Device Memory (HDM) decoders 13803b39fcfSJonathan Cameron in root ports, switch ports and devices appropriately to meet the 13903b39fcfSJonathan Cameron interleave requirements before enabling the memory devices. 14003b39fcfSJonathan Cameron 14103b39fcfSJonathan Cameron ``targets.X=target`` provides the mapping to CXL host bridges 14203b39fcfSJonathan Cameron which may be identified by the id provied in the -device entry. 14303b39fcfSJonathan Cameron Multiple entries are needed to specify all the targets when 14403b39fcfSJonathan Cameron the fixed memory window represents interleaved memory. X is the 14503b39fcfSJonathan Cameron target index from 0. 14603b39fcfSJonathan Cameron 14703b39fcfSJonathan Cameron ``size=size`` sets the size of the CFMW. This must be a multiple of 14803b39fcfSJonathan Cameron 256MiB. The region will be aligned to 256MiB but the location is 14903b39fcfSJonathan Cameron platform and configuration dependent. 15003b39fcfSJonathan Cameron 15103b39fcfSJonathan Cameron ``interleave-granularity=granularity`` sets the granularity of 15203b39fcfSJonathan Cameron interleave. Default 256KiB. Only 256KiB, 512KiB, 1024KiB, 2048KiB 15303b39fcfSJonathan Cameron 4096KiB, 8192KiB and 16384KiB granularities supported. 15403b39fcfSJonathan Cameron 15503b39fcfSJonathan Cameron Example: 15603b39fcfSJonathan Cameron 15703b39fcfSJonathan Cameron :: 15803b39fcfSJonathan Cameron 15903b39fcfSJonathan Cameron -machine cxl-fmw.0.targets.0=cxl.0,cxl-fmw.0.targets.1=cxl.1,cxl-fmw.0.size=128G,cxl-fmw.0.interleave-granularity=512k 160e2fcbf42SPeter MaydellERST 1615824d651Sblueswir1 162dfce81f1SSean ChristophersonDEF("M", HAS_ARG, QEMU_OPTION_M, 16311058123SYang Zhong " sgx-epc.0.memdev=memid,sgx-epc.0.node=numaid\n", 164dfce81f1SSean Christopherson QEMU_ARCH_ALL) 165dfce81f1SSean Christopherson 166dfce81f1SSean ChristophersonSRST 16711058123SYang Zhong``sgx-epc.0.memdev=@var{memid},sgx-epc.0.node=@var{numaid}`` 168dfce81f1SSean Christopherson Define an SGX EPC section. 169dfce81f1SSean ChristophersonERST 17080f52a66SJan Kiszka 1715824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 172585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 173e2fcbf42SPeter MaydellSRST 174e2fcbf42SPeter Maydell``-cpu model`` 175e2fcbf42SPeter Maydell Select CPU model (``-cpu help`` for list and additional feature 176e2fcbf42SPeter Maydell selection) 177e2fcbf42SPeter MaydellERST 1785824d651Sblueswir1 1798d4e9146SKONRAD FredericDEF("accel", HAS_ARG, QEMU_OPTION_accel, 180fe174132SPaolo Bonzini "-accel [accel=]accelerator[,prop[=value][,...]]\n" 18174a414a1SReinoud Zandijk " select accelerator (kvm, xen, hax, hvf, nvmm, whpx or tcg; use 'help' for a list)\n" 18246472d82SPaolo Bonzini " igd-passthru=on|off (enable Xen integrated Intel graphics passthrough, default=off)\n" 18311bc4a13SPaolo Bonzini " kernel-irqchip=on|off|split controls accelerated irqchip support (default=on)\n" 18423b0898eSPaolo Bonzini " kvm-shadow-mem=size of KVM shadow MMU in bytes\n" 185a35b3e14SRichard Henderson " split-wx=on|off (enable TCG split w^x mapping)\n" 186fe174132SPaolo Bonzini " tb-size=n (TCG translation block cache size)\n" 1872ea5cb0aSPeter Xu " dirty-ring-size=n (KVM dirty ring GFN count, default 0)\n" 1880b3c5c81SEduardo Habkost " thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL) 189e2fcbf42SPeter MaydellSRST 190e2fcbf42SPeter Maydell``-accel name[,prop=value[,...]]`` 191e2fcbf42SPeter Maydell This is used to enable an accelerator. Depending on the target 19274a414a1SReinoud Zandijk architecture, kvm, xen, hax, hvf, nvmm, whpx or tcg can be available. By 193e2fcbf42SPeter Maydell default, tcg is used. If there is more than one accelerator 194e2fcbf42SPeter Maydell specified, the next one is used if the previous one fails to 195e2fcbf42SPeter Maydell initialize. 196e2fcbf42SPeter Maydell 197e2fcbf42SPeter Maydell ``igd-passthru=on|off`` 198e2fcbf42SPeter Maydell When Xen is in use, this option controls whether Intel 199e2fcbf42SPeter Maydell integrated graphics devices can be passed through to the guest 200e2fcbf42SPeter Maydell (default=off) 201e2fcbf42SPeter Maydell 202e2fcbf42SPeter Maydell ``kernel-irqchip=on|off|split`` 203e2fcbf42SPeter Maydell Controls KVM in-kernel irqchip support. The default is full 204e2fcbf42SPeter Maydell acceleration of the interrupt controllers. On x86, split irqchip 205e2fcbf42SPeter Maydell reduces the kernel attack surface, at a performance cost for 206e2fcbf42SPeter Maydell non-MSI interrupts. Disabling the in-kernel irqchip completely 207e2fcbf42SPeter Maydell is not recommended except for debugging purposes. 208e2fcbf42SPeter Maydell 209e2fcbf42SPeter Maydell ``kvm-shadow-mem=size`` 210e2fcbf42SPeter Maydell Defines the size of the KVM shadow MMU. 211e2fcbf42SPeter Maydell 212a35b3e14SRichard Henderson ``split-wx=on|off`` 213a35b3e14SRichard Henderson Controls the use of split w^x mapping for the TCG code generation 214a35b3e14SRichard Henderson buffer. Some operating systems require this to be enabled, and in 215a35b3e14SRichard Henderson such a case this will default on. On other operating systems, this 216a35b3e14SRichard Henderson will default off, but one may enable this for testing or debugging. 217a35b3e14SRichard Henderson 218e2fcbf42SPeter Maydell ``tb-size=n`` 219e2fcbf42SPeter Maydell Controls the size (in MiB) of the TCG translation block cache. 220e2fcbf42SPeter Maydell 221e2fcbf42SPeter Maydell ``thread=single|multi`` 222e2fcbf42SPeter Maydell Controls number of TCG threads. When the TCG is multi-threaded 223cba42d61SMichael Tokarev there will be one thread per vCPU therefore taking advantage of 224e2fcbf42SPeter Maydell additional host cores. The default is to enable multi-threading 225e2fcbf42SPeter Maydell where both the back-end and front-ends support it and no 226e2fcbf42SPeter Maydell incompatible TCG features have been enabled (e.g. 227e2fcbf42SPeter Maydell icount/replay). 2282ea5cb0aSPeter Xu 2292ea5cb0aSPeter Xu ``dirty-ring-size=n`` 2302ea5cb0aSPeter Xu When the KVM accelerator is used, it controls the size of the per-vCPU 2312ea5cb0aSPeter Xu dirty page ring buffer (number of entries for each vCPU). It should 2322ea5cb0aSPeter Xu be a value that is power of two, and it should be 1024 or bigger (but 2332ea5cb0aSPeter Xu still less than the maximum value that the kernel supports). 4096 2342ea5cb0aSPeter Xu could be a good initial value if you have no idea which is the best. 2352ea5cb0aSPeter Xu Set this value to 0 to disable the feature. By default, this feature 2362ea5cb0aSPeter Xu is disabled (dirty-ring-size=0). When enabled, KVM will instead 2372ea5cb0aSPeter Xu record dirty pages in a bitmap. 2382ea5cb0aSPeter Xu 239e2fcbf42SPeter MaydellERST 2408d4e9146SKONRAD Frederic 2415824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 242864c3b5cSYanan Wang "-smp [[cpus=]n][,maxcpus=maxcpus][,sockets=sockets][,dies=dies][,clusters=clusters][,cores=cores][,threads=threads]\n" 2430d871785SYanan Wang " set the number of initial CPUs to 'n' [default=1]\n" 244ce8ee7c6SDaniel P. Berrangé " maxcpus= maximum number of total CPUs, including\n" 245ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 2460d871785SYanan Wang " sockets= number of sockets on the machine board\n" 2470d871785SYanan Wang " dies= number of dies in one socket\n" 248864c3b5cSYanan Wang " clusters= number of clusters in one die\n" 249864c3b5cSYanan Wang " cores= number of cores in one cluster\n" 2500d871785SYanan Wang " threads= number of threads in one core\n" 2510d871785SYanan Wang "Note: Different machines may have different subsets of the CPU topology\n" 2520d871785SYanan Wang " parameters supported, so the actual meaning of the supported parameters\n" 2530d871785SYanan Wang " will vary accordingly. For example, for a machine type that supports a\n" 2540d871785SYanan Wang " three-level CPU hierarchy of sockets/cores/threads, the parameters will\n" 2550d871785SYanan Wang " sequentially mean as below:\n" 2560d871785SYanan Wang " sockets means the number of sockets on the machine board\n" 2570d871785SYanan Wang " cores means the number of cores in one socket\n" 2580d871785SYanan Wang " threads means the number of threads in one core\n" 2590d871785SYanan Wang " For a particular machine type board, an expected CPU topology hierarchy\n" 2600d871785SYanan Wang " can be defined through the supported sub-option. Unsupported parameters\n" 2610d871785SYanan Wang " can also be provided in addition to the sub-option, but their values\n" 2620d871785SYanan Wang " must be set as 1 in the purpose of correct parsing.\n", 263ad96090aSBlue Swirl QEMU_ARCH_ALL) 264e2fcbf42SPeter MaydellSRST 265864c3b5cSYanan Wang``-smp [[cpus=]n][,maxcpus=maxcpus][,sockets=sockets][,dies=dies][,clusters=clusters][,cores=cores][,threads=threads]`` 26680d78357SDaniel P. Berrangé Simulate a SMP system with '\ ``n``\ ' CPUs initially present on 26780d78357SDaniel P. Berrangé the machine type board. On boards supporting CPU hotplug, the optional 26880d78357SDaniel P. Berrangé '\ ``maxcpus``\ ' parameter can be set to enable further CPUs to be 2697d8c5a39SYanan Wang added at runtime. When both parameters are omitted, the maximum number 2707d8c5a39SYanan Wang of CPUs will be calculated from the provided topology members and the 2717d8c5a39SYanan Wang initial CPU count will match the maximum number. When only one of them 2727d8c5a39SYanan Wang is given then the omitted one will be set to its counterpart's value. 2737d8c5a39SYanan Wang Both parameters may be specified, but the maximum number of CPUs must 2740d871785SYanan Wang be equal to or greater than the initial CPU count. Product of the 2750d871785SYanan Wang CPU topology hierarchy must be equal to the maximum number of CPUs. 2760d871785SYanan Wang Both parameters are subject to an upper limit that is determined by 2770d871785SYanan Wang the specific machine type chosen. 27880d78357SDaniel P. Berrangé 2790d871785SYanan Wang To control reporting of CPU topology information, values of the topology 2800d871785SYanan Wang parameters can be specified. Machines may only support a subset of the 2810d871785SYanan Wang parameters and different machines may have different subsets supported 2820d871785SYanan Wang which vary depending on capacity of the corresponding CPU targets. So 2830d871785SYanan Wang for a particular machine type board, an expected topology hierarchy can 2840d871785SYanan Wang be defined through the supported sub-option. Unsupported parameters can 2850d871785SYanan Wang also be provided in addition to the sub-option, but their values must be 2860d871785SYanan Wang set as 1 in the purpose of correct parsing. 28780d78357SDaniel P. Berrangé 28880d78357SDaniel P. Berrangé Either the initial CPU count, or at least one of the topology parameters 289c2511b16SYanan Wang must be specified. The specified parameters must be greater than zero, 290c2511b16SYanan Wang explicit configuration like "cpus=0" is not allowed. Values for any 291c2511b16SYanan Wang omitted parameters will be computed from those which are given. 2920d871785SYanan Wang 2930d871785SYanan Wang For example, the following sub-option defines a CPU topology hierarchy 2940d871785SYanan Wang (2 sockets totally on the machine, 2 cores per socket, 2 threads per 2950d871785SYanan Wang core) for a machine that only supports sockets/cores/threads. 2960d871785SYanan Wang Some members of the option can be omitted but their values will be 2970d871785SYanan Wang automatically computed: 2980d871785SYanan Wang 2990d871785SYanan Wang :: 3000d871785SYanan Wang 3010d871785SYanan Wang -smp 8,sockets=2,cores=2,threads=2,maxcpus=8 3020d871785SYanan Wang 3030d871785SYanan Wang The following sub-option defines a CPU topology hierarchy (2 sockets 3040d871785SYanan Wang totally on the machine, 2 dies per socket, 2 cores per die, 2 threads 3050d871785SYanan Wang per core) for PC machines which support sockets/dies/cores/threads. 3060d871785SYanan Wang Some members of the option can be omitted but their values will be 3070d871785SYanan Wang automatically computed: 3080d871785SYanan Wang 3090d871785SYanan Wang :: 3100d871785SYanan Wang 3110d871785SYanan Wang -smp 16,sockets=2,dies=2,cores=2,threads=2,maxcpus=16 3120d871785SYanan Wang 313d55c316fSYanan Wang The following sub-option defines a CPU topology hierarchy (2 sockets 314d55c316fSYanan Wang totally on the machine, 2 clusters per socket, 2 cores per cluster, 315d55c316fSYanan Wang 2 threads per core) for ARM virt machines which support sockets/clusters 316d55c316fSYanan Wang /cores/threads. Some members of the option can be omitted but their values 317d55c316fSYanan Wang will be automatically computed: 318d55c316fSYanan Wang 319d55c316fSYanan Wang :: 320d55c316fSYanan Wang 321d55c316fSYanan Wang -smp 16,sockets=2,clusters=2,cores=2,threads=2,maxcpus=16 322d55c316fSYanan Wang 323c2511b16SYanan Wang Historically preference was given to the coarsest topology parameters 324c2511b16SYanan Wang when computing missing values (ie sockets preferred over cores, which 325c2511b16SYanan Wang were preferred over threads), however, this behaviour is considered 3264a0af293SYanan Wang liable to change. Prior to 6.2 the preference was sockets over cores 3274a0af293SYanan Wang over threads. Since 6.2 the preference is cores over sockets over threads. 3280d871785SYanan Wang 3290d871785SYanan Wang For example, the following option defines a machine board with 2 sockets 3300d871785SYanan Wang of 1 core before 6.2 and 1 socket of 2 cores after 6.2: 3310d871785SYanan Wang 3320d871785SYanan Wang :: 3330d871785SYanan Wang 3340d871785SYanan Wang -smp 2 335e2fcbf42SPeter MaydellERST 3365824d651Sblueswir1 337268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 338244b3f44STao Xu "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 339244b3f44STao Xu "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 3402d19c656SIgor Mammedov "-numa dist,src=source,dst=destination,val=distance\n" 3419b12dfa0SLiu Jingqi "-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]\n" 342c412a48dSLiu 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" 343c412a48dSLiu Jingqi "-numa hmat-cache,node-id=node,size=size,level=level[,associativity=none|direct|complex][,policy=none|write-back|write-through][,line=size]\n", 3442d19c656SIgor Mammedov QEMU_ARCH_ALL) 345e2fcbf42SPeter MaydellSRST 34609ce5f2dSPeter Maydell``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 34709ce5f2dSPeter Maydell \ 34809ce5f2dSPeter Maydell``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 34909ce5f2dSPeter Maydell \ 35009ce5f2dSPeter Maydell``-numa dist,src=source,dst=destination,val=distance`` 35109ce5f2dSPeter Maydell \ 35209ce5f2dSPeter Maydell``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]`` 35309ce5f2dSPeter Maydell \ 35409ce5f2dSPeter Maydell``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]`` 35509ce5f2dSPeter Maydell \ 35609ce5f2dSPeter Maydell``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]`` 357e2fcbf42SPeter Maydell Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA 358e2fcbf42SPeter Maydell distance from a source node to a destination node. Set the ACPI 359e2fcbf42SPeter Maydell Heterogeneous Memory Attributes for the given nodes. 360e2fcbf42SPeter Maydell 361e2fcbf42SPeter Maydell Legacy VCPU assignment uses '\ ``cpus``\ ' option where firstcpu and 362e2fcbf42SPeter Maydell lastcpu are CPU indexes. Each '\ ``cpus``\ ' option represent a 363e2fcbf42SPeter Maydell contiguous range of CPU indexes (or a single VCPU if lastcpu is 364e2fcbf42SPeter Maydell omitted). A non-contiguous set of VCPUs can be represented by 365e2fcbf42SPeter Maydell providing multiple '\ ``cpus``\ ' options. If '\ ``cpus``\ ' is 366e2fcbf42SPeter Maydell omitted on all nodes, VCPUs are automatically split between them. 367e2fcbf42SPeter Maydell 368e2fcbf42SPeter Maydell For example, the following option assigns VCPUs 0, 1, 2 and 5 to a 369e2fcbf42SPeter Maydell NUMA node: 370e2fcbf42SPeter Maydell 371e2fcbf42SPeter Maydell :: 372e2fcbf42SPeter Maydell 373e2fcbf42SPeter Maydell -numa node,cpus=0-2,cpus=5 374e2fcbf42SPeter Maydell 375e2fcbf42SPeter Maydell '\ ``cpu``\ ' option is a new alternative to '\ ``cpus``\ ' option 376e2fcbf42SPeter Maydell which uses '\ ``socket-id|core-id|thread-id``\ ' properties to 377e2fcbf42SPeter Maydell assign CPU objects to a node using topology layout properties of 378e2fcbf42SPeter Maydell CPU. The set of properties is machine specific, and depends on used 379e2fcbf42SPeter Maydell machine type/'\ ``smp``\ ' options. It could be queried with 380e2fcbf42SPeter Maydell '\ ``hotpluggable-cpus``\ ' monitor command. '\ ``node-id``\ ' 381e2fcbf42SPeter Maydell property specifies node to which CPU object will be assigned, it's 382e2fcbf42SPeter Maydell required for node to be declared with '\ ``node``\ ' option before 383e2fcbf42SPeter Maydell it's used with '\ ``cpu``\ ' option. 384e2fcbf42SPeter Maydell 385e2fcbf42SPeter Maydell For example: 386e2fcbf42SPeter Maydell 387e2fcbf42SPeter Maydell :: 388e2fcbf42SPeter Maydell 389e2fcbf42SPeter Maydell -M pc \ 390e2fcbf42SPeter Maydell -smp 1,sockets=2,maxcpus=2 \ 391e2fcbf42SPeter Maydell -numa node,nodeid=0 -numa node,nodeid=1 \ 392e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 393e2fcbf42SPeter Maydell 39432a354dcSIgor Mammedov Legacy '\ ``mem``\ ' assigns a given RAM amount to a node (not supported 39532a354dcSIgor Mammedov for 5.1 and newer machine types). '\ ``memdev``\ ' assigns RAM from 39632a354dcSIgor Mammedov a given memory backend device to a node. If '\ ``mem``\ ' and 39732a354dcSIgor Mammedov '\ ``memdev``\ ' are omitted in all nodes, RAM is split equally between them. 39832a354dcSIgor Mammedov 399e2fcbf42SPeter Maydell 400e2fcbf42SPeter Maydell '\ ``mem``\ ' and '\ ``memdev``\ ' are mutually exclusive. 401e2fcbf42SPeter Maydell Furthermore, if one node uses '\ ``memdev``\ ', all of them have to 402e2fcbf42SPeter Maydell use it. 403e2fcbf42SPeter Maydell 404e2fcbf42SPeter Maydell '\ ``initiator``\ ' is an additional option that points to an 405e2fcbf42SPeter Maydell initiator NUMA node that has best performance (the lowest latency or 406e2fcbf42SPeter Maydell largest bandwidth) to this NUMA node. Note that this option can be 407e2fcbf42SPeter Maydell set only when the machine property 'hmat' is set to 'on'. 408e2fcbf42SPeter Maydell 409e2fcbf42SPeter Maydell Following example creates a machine with 2 NUMA nodes, node 0 has 410e2fcbf42SPeter Maydell CPU. node 1 has only memory, and its initiator is node 0. Note that 411e2fcbf42SPeter Maydell because node 0 has CPU, by default the initiator of node 0 is itself 412e2fcbf42SPeter Maydell and must be itself. 413e2fcbf42SPeter Maydell 414e2fcbf42SPeter Maydell :: 415e2fcbf42SPeter Maydell 416e2fcbf42SPeter Maydell -machine hmat=on \ 417e2fcbf42SPeter Maydell -m 2G,slots=2,maxmem=4G \ 418e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 419e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 420e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 421e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 422e2fcbf42SPeter Maydell -smp 2,sockets=2,maxcpus=2 \ 423e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 424e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 425e2fcbf42SPeter Maydell 426e2fcbf42SPeter Maydell source and destination are NUMA node IDs. distance is the NUMA 427e2fcbf42SPeter Maydell distance from source to destination. The distance from a node to 428e2fcbf42SPeter Maydell itself is always 10. If any pair of nodes is given a distance, then 429e2fcbf42SPeter Maydell all pairs must be given distances. Although, when distances are only 430e2fcbf42SPeter Maydell given in one direction for each pair of nodes, then the distances in 431e2fcbf42SPeter Maydell the opposite directions are assumed to be the same. If, however, an 432e2fcbf42SPeter Maydell asymmetrical pair of distances is given for even one node pair, then 433e2fcbf42SPeter Maydell all node pairs must be provided distance values for both directions, 434e2fcbf42SPeter Maydell even when they are symmetrical. When a node is unreachable from 435e2fcbf42SPeter Maydell another node, set the pair's distance to 255. 436e2fcbf42SPeter Maydell 437e2fcbf42SPeter Maydell Note that the -``numa`` option doesn't allocate any of the specified 438e2fcbf42SPeter Maydell resources, it just assigns existing resources to NUMA nodes. This 439e2fcbf42SPeter Maydell means that one still has to use the ``-m``, ``-smp`` options to 440e2fcbf42SPeter Maydell allocate RAM and VCPUs respectively. 441e2fcbf42SPeter Maydell 442e2fcbf42SPeter Maydell Use '\ ``hmat-lb``\ ' to set System Locality Latency and Bandwidth 443e2fcbf42SPeter Maydell Information between initiator and target NUMA nodes in ACPI 444e2fcbf42SPeter Maydell Heterogeneous Attribute Memory Table (HMAT). Initiator NUMA node can 445e2fcbf42SPeter Maydell create memory requests, usually it has one or more processors. 446e2fcbf42SPeter Maydell Target NUMA node contains addressable memory. 447e2fcbf42SPeter Maydell 448e2fcbf42SPeter Maydell In '\ ``hmat-lb``\ ' option, node are NUMA node IDs. hierarchy is 449e2fcbf42SPeter Maydell the memory hierarchy of the target NUMA node: if hierarchy is 450e2fcbf42SPeter Maydell 'memory', the structure represents the memory performance; if 451e2fcbf42SPeter Maydell hierarchy is 'first-level\|second-level\|third-level', this 452e2fcbf42SPeter Maydell structure represents aggregated performance of memory side caches 453e2fcbf42SPeter Maydell for each domain. type of 'data-type' is type of data represented by 454e2fcbf42SPeter Maydell this structure instance: if 'hierarchy' is 'memory', 'data-type' is 455e2fcbf42SPeter Maydell 'access\|read\|write' latency or 'access\|read\|write' bandwidth of 456e2fcbf42SPeter Maydell the target memory; if 'hierarchy' is 457e2fcbf42SPeter Maydell 'first-level\|second-level\|third-level', 'data-type' is 458e2fcbf42SPeter Maydell 'access\|read\|write' hit latency or 'access\|read\|write' hit 459e2fcbf42SPeter Maydell bandwidth of the target memory side cache. 460e2fcbf42SPeter Maydell 461e2fcbf42SPeter Maydell lat is latency value in nanoseconds. bw is bandwidth value, the 462e2fcbf42SPeter Maydell possible value and units are NUM[M\|G\|T], mean that the bandwidth 463e2fcbf42SPeter Maydell value are NUM byte per second (or MB/s, GB/s or TB/s depending on 464e2fcbf42SPeter Maydell used suffix). Note that if latency or bandwidth value is 0, means 465e2fcbf42SPeter Maydell the corresponding latency or bandwidth information is not provided. 466e2fcbf42SPeter Maydell 467e2fcbf42SPeter Maydell In '\ ``hmat-cache``\ ' option, node-id is the NUMA-id of the memory 468e2fcbf42SPeter Maydell belongs. size is the size of memory side cache in bytes. level is 469e2fcbf42SPeter Maydell the cache level described in this structure, note that the cache 470e2fcbf42SPeter Maydell level 0 should not be used with '\ ``hmat-cache``\ ' option. 471e2fcbf42SPeter Maydell associativity is the cache associativity, the possible value is 472e2fcbf42SPeter Maydell 'none/direct(direct-mapped)/complex(complex cache indexing)'. policy 473e2fcbf42SPeter Maydell is the write policy. line is the cache Line size in bytes. 474e2fcbf42SPeter Maydell 475e2fcbf42SPeter Maydell For example, the following options describe 2 NUMA nodes. Node 0 has 476e2fcbf42SPeter Maydell 2 cpus and a ram, node 1 has only a ram. The processors in node 0 477e2fcbf42SPeter Maydell access memory in node 0 with access-latency 5 nanoseconds, 478e2fcbf42SPeter Maydell access-bandwidth is 200 MB/s; The processors in NUMA node 0 access 479e2fcbf42SPeter Maydell memory in NUMA node 1 with access-latency 10 nanoseconds, 480e2fcbf42SPeter Maydell access-bandwidth is 100 MB/s. And for memory side cache information, 481e2fcbf42SPeter Maydell NUMA node 0 and 1 both have 1 level memory cache, size is 10KB, 482e2fcbf42SPeter Maydell policy is write-back, the cache Line size is 8 bytes: 483e2fcbf42SPeter Maydell 484e2fcbf42SPeter Maydell :: 485e2fcbf42SPeter Maydell 486e2fcbf42SPeter Maydell -machine hmat=on \ 487e2fcbf42SPeter Maydell -m 2G \ 488e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 489e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 490848dd269SYanan Wang -smp 2,sockets=2,maxcpus=2 \ 491e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 492e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 493e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 494e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 \ 495e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-latency,latency=5 \ 496e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-bandwidth,bandwidth=200M \ 497e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-latency,latency=10 \ 498e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-bandwidth,bandwidth=100M \ 499e2fcbf42SPeter Maydell -numa hmat-cache,node-id=0,size=10K,level=1,associativity=direct,policy=write-back,line=8 \ 500e2fcbf42SPeter Maydell -numa hmat-cache,node-id=1,size=10K,level=1,associativity=direct,policy=write-back,line=8 501e2fcbf42SPeter MaydellERST 502268a362cSaliguori 50310adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 50410adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 50510adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 506e2fcbf42SPeter MaydellSRST 507e2fcbf42SPeter Maydell``-add-fd fd=fd,set=set[,opaque=opaque]`` 508e2fcbf42SPeter Maydell Add a file descriptor to an fd set. Valid options are: 509e2fcbf42SPeter Maydell 510e2fcbf42SPeter Maydell ``fd=fd`` 511e2fcbf42SPeter Maydell This option defines the file descriptor of which a duplicate is 512e2fcbf42SPeter Maydell added to fd set. The file descriptor cannot be stdin, stdout, or 513e2fcbf42SPeter Maydell stderr. 514e2fcbf42SPeter Maydell 515e2fcbf42SPeter Maydell ``set=set`` 516e2fcbf42SPeter Maydell This option defines the ID of the fd set to add the file 517e2fcbf42SPeter Maydell descriptor to. 518e2fcbf42SPeter Maydell 519e2fcbf42SPeter Maydell ``opaque=opaque`` 520e2fcbf42SPeter Maydell This option defines a free-form string that can be used to 521e2fcbf42SPeter Maydell describe fd. 522e2fcbf42SPeter Maydell 523e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 524e2fcbf42SPeter Maydell set: 525e2fcbf42SPeter Maydell 526e2fcbf42SPeter Maydell .. parsed-literal:: 527e2fcbf42SPeter Maydell 528353a06b4SLaszlo Ersek |qemu_system| \\ 529353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 530353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 531e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 532e2fcbf42SPeter MaydellERST 53310adb8beSMarkus Armbruster 53410adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 53510adb8beSMarkus Armbruster "-set group.id.arg=value\n" 53610adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 53710adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 538e2fcbf42SPeter MaydellSRST 539e2fcbf42SPeter Maydell``-set group.id.arg=value`` 540e2fcbf42SPeter Maydell Set parameter arg for item id of type group 541e2fcbf42SPeter MaydellERST 54210adb8beSMarkus Armbruster 54310adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 5443751d7c4SPaolo Bonzini "-global driver.property=value\n" 5453751d7c4SPaolo Bonzini "-global driver=driver,property=property,value=value\n" 54610adb8beSMarkus Armbruster " set a global default for a driver property\n", 54710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 548e2fcbf42SPeter MaydellSRST 54909ce5f2dSPeter Maydell``-global driver.prop=value`` 55009ce5f2dSPeter Maydell \ 55109ce5f2dSPeter Maydell``-global driver=driver,property=property,value=value`` 552e2fcbf42SPeter Maydell Set default value of driver's property prop to value, e.g.: 553e2fcbf42SPeter Maydell 554e2fcbf42SPeter Maydell .. parsed-literal:: 555e2fcbf42SPeter Maydell 556e2fcbf42SPeter Maydell |qemu_system_x86| -global ide-hd.physical_block_size=4096 disk-image.img 557e2fcbf42SPeter Maydell 558e2fcbf42SPeter Maydell In particular, you can use this to set driver properties for devices 559e2fcbf42SPeter Maydell which are created automatically by the machine model. To create a 560e2fcbf42SPeter Maydell device which is not created automatically and set properties on it, 561e2fcbf42SPeter Maydell use -``device``. 562e2fcbf42SPeter Maydell 563e2fcbf42SPeter Maydell -global driver.prop=value is shorthand for -global 564e2fcbf42SPeter Maydell driver=driver,property=prop,value=value. The longhand syntax works 565e2fcbf42SPeter Maydell even when driver contains a dot. 566e2fcbf42SPeter MaydellERST 56710adb8beSMarkus Armbruster 56810adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 56910adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 570c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 57110adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 57210adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 57310adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 57410adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 57510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 576e2fcbf42SPeter MaydellSRST 577e2fcbf42SPeter Maydell``-boot [order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_timeout][,strict=on|off]`` 578e2fcbf42SPeter Maydell Specify boot order drives as a string of drive letters. Valid drive 579e2fcbf42SPeter Maydell letters depend on the target architecture. The x86 PC uses: a, b 580e2fcbf42SPeter Maydell (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p 581e2fcbf42SPeter Maydell (Etherboot from network adapter 1-4), hard disk boot is the default. 582e2fcbf42SPeter Maydell To apply a particular boot order only on the first startup, specify 583e2fcbf42SPeter Maydell it via ``once``. Note that the ``order`` or ``once`` parameter 584e2fcbf42SPeter Maydell should not be used together with the ``bootindex`` property of 585e2fcbf42SPeter Maydell devices, since the firmware implementations normally do not support 586e2fcbf42SPeter Maydell both at the same time. 587e2fcbf42SPeter Maydell 588e2fcbf42SPeter Maydell Interactive boot menus/prompts can be enabled via ``menu=on`` as far 589e2fcbf42SPeter Maydell as firmware/BIOS supports them. The default is non-interactive boot. 590e2fcbf42SPeter Maydell 591e2fcbf42SPeter Maydell A splash picture could be passed to bios, enabling user to show it 592e2fcbf42SPeter Maydell as logo, when option splash=sp\_name is given and menu=on, If 593e2fcbf42SPeter Maydell firmware/BIOS supports them. Currently Seabios for X86 system 594e2fcbf42SPeter Maydell support it. limitation: The splash file could be a jpeg file or a 595e2fcbf42SPeter Maydell BMP file in 24 BPP format(true color). The resolution should be 596e2fcbf42SPeter Maydell supported by the SVGA mode, so the recommended is 320x240, 640x480, 597e2fcbf42SPeter Maydell 800x640. 598e2fcbf42SPeter Maydell 599e2fcbf42SPeter Maydell A timeout could be passed to bios, guest will pause for rb\_timeout 600e2fcbf42SPeter Maydell ms when boot failed, then reboot. If rb\_timeout is '-1', guest will 601e2fcbf42SPeter Maydell not reboot, qemu passes '-1' to bios by default. Currently Seabios 602e2fcbf42SPeter Maydell for X86 system support it. 603e2fcbf42SPeter Maydell 604e2fcbf42SPeter Maydell Do strict boot via ``strict=on`` as far as firmware/BIOS supports 605e2fcbf42SPeter Maydell it. This only effects when boot priority is changed by bootindex 606e2fcbf42SPeter Maydell options. The default is non-strict boot. 607e2fcbf42SPeter Maydell 60809ce5f2dSPeter Maydell .. parsed-literal:: 609e2fcbf42SPeter Maydell 610e2fcbf42SPeter Maydell # try to boot from network first, then from hard disk 611e2fcbf42SPeter Maydell |qemu_system_x86| -boot order=nc 612e2fcbf42SPeter Maydell # boot from CD-ROM first, switch back to default order after reboot 613e2fcbf42SPeter Maydell |qemu_system_x86| -boot once=d 614e2fcbf42SPeter Maydell # boot with a splash picture for 5 seconds. 615e2fcbf42SPeter Maydell |qemu_system_x86| -boot menu=on,splash=/root/boot.bmp,splash-time=5000 616e2fcbf42SPeter Maydell 617e2fcbf42SPeter Maydell Note: The legacy format '-boot drives' is still supported but its 618e2fcbf42SPeter Maydell use is discouraged as it may be removed from future versions. 619e2fcbf42SPeter MaydellERST 62010adb8beSMarkus Armbruster 62110adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 62289f3ea2bSMichael Tokarev "-m [size=]megs[,slots=n,maxmem=size]\n" 6236e1d3c1cSIgor Mammedov " configure guest RAM\n" 6240daba1f0SAlexander Graf " size: initial amount of guest memory\n" 625c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 626b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 627b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 6286e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 629e2fcbf42SPeter MaydellSRST 630e2fcbf42SPeter Maydell``-m [size=]megs[,slots=n,maxmem=size]`` 631e2fcbf42SPeter Maydell Sets guest startup RAM size to megs megabytes. Default is 128 MiB. 632e2fcbf42SPeter Maydell Optionally, a suffix of "M" or "G" can be used to signify a value in 633e2fcbf42SPeter Maydell megabytes or gigabytes respectively. Optional pair slots, maxmem 634e2fcbf42SPeter Maydell could be used to set amount of hotpluggable memory slots and maximum 635e2fcbf42SPeter Maydell amount of memory. Note that maxmem must be aligned to the page size. 636e2fcbf42SPeter Maydell 637e2fcbf42SPeter Maydell For example, the following command-line sets the guest startup RAM 638e2fcbf42SPeter Maydell size to 1GB, creates 3 slots to hotplug additional memory and sets 639e2fcbf42SPeter Maydell the maximum memory the guest can reach to 4GB: 640e2fcbf42SPeter Maydell 641e2fcbf42SPeter Maydell .. parsed-literal:: 642e2fcbf42SPeter Maydell 643e2fcbf42SPeter Maydell |qemu_system| -m 1G,slots=3,maxmem=4G 644e2fcbf42SPeter Maydell 645e2fcbf42SPeter Maydell If slots and maxmem are not specified, memory hotplug won't be 646e2fcbf42SPeter Maydell enabled and the guest startup RAM will never increase. 647e2fcbf42SPeter MaydellERST 64810adb8beSMarkus Armbruster 64910adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 65010adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 651e2fcbf42SPeter MaydellSRST 652e2fcbf42SPeter Maydell``-mem-path path`` 653e2fcbf42SPeter Maydell Allocate guest RAM from a temporarily created file in path. 654e2fcbf42SPeter MaydellERST 65510adb8beSMarkus Armbruster 65610adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 65710adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 65810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 659e2fcbf42SPeter MaydellSRST 660e2fcbf42SPeter Maydell``-mem-prealloc`` 661e2fcbf42SPeter Maydell Preallocate memory when using -mem-path. 662e2fcbf42SPeter MaydellERST 66310adb8beSMarkus Armbruster 66410adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 66510adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 66610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 667e2fcbf42SPeter MaydellSRST 668e2fcbf42SPeter Maydell``-k language`` 669e2fcbf42SPeter Maydell Use keyboard layout language (for example ``fr`` for French). This 670e2fcbf42SPeter Maydell option is only needed where it is not easy to get raw PC keycodes 671e2fcbf42SPeter Maydell (e.g. on Macs, with some X11 servers or with a VNC or curses 672e2fcbf42SPeter Maydell display). You don't normally need to use it on PC/Linux or 673e2fcbf42SPeter Maydell PC/Windows hosts. 674e2fcbf42SPeter Maydell 675e2fcbf42SPeter Maydell The available layouts are: 676e2fcbf42SPeter Maydell 677e2fcbf42SPeter Maydell :: 678e2fcbf42SPeter Maydell 679e2fcbf42SPeter Maydell ar de-ch es fo fr-ca hu ja mk no pt-br sv 680e2fcbf42SPeter Maydell da en-gb et fr fr-ch is lt nl pl ru th 681e2fcbf42SPeter Maydell de en-us fi fr-be hr it lv nl-be pt sl tr 682e2fcbf42SPeter Maydell 683e2fcbf42SPeter Maydell The default is ``en-us``. 684e2fcbf42SPeter MaydellERST 68510adb8beSMarkus Armbruster 68610adb8beSMarkus Armbruster 687f0b3d811SKővágó, ZoltánHXCOMM Deprecated by -audiodev 68810adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 689f0b3d811SKővágó, Zoltán "-audio-help show -audiodev equivalent of the currently specified audio settings\n", 69010adb8beSMarkus Armbruster QEMU_ARCH_ALL) 691e2fcbf42SPeter MaydellSRST 692e2fcbf42SPeter Maydell``-audio-help`` 693e2fcbf42SPeter Maydell Will show the -audiodev equivalent of the currently specified 694e2fcbf42SPeter Maydell (deprecated) environment variables. 695e2fcbf42SPeter MaydellERST 696f0b3d811SKővágó, Zoltán 697039a6837SPaolo BonziniDEF("audio", HAS_ARG, QEMU_OPTION_audio, 698039a6837SPaolo Bonzini "-audio [driver=]driver,model=value[,prop[=value][,...]]\n" 699039a6837SPaolo Bonzini " specifies the audio backend and device to use;\n" 700039a6837SPaolo Bonzini " apart from 'model', options are the same as for -audiodev.\n" 701039a6837SPaolo Bonzini " use '-audio model=help' to show possible devices.\n", 702039a6837SPaolo Bonzini QEMU_ARCH_ALL) 703039a6837SPaolo BonziniSRST 704039a6837SPaolo Bonzini``-audio [driver=]driver,model=value[,prop[=value][,...]]`` 705039a6837SPaolo Bonzini This option is a shortcut for configuring both the guest audio 706039a6837SPaolo Bonzini hardware and the host audio backend in one go. 707039a6837SPaolo Bonzini The host backend options are the same as with the corresponding 708039a6837SPaolo Bonzini ``-audiodev`` options below. The guest hardware model can be set with 709039a6837SPaolo Bonzini ``model=modelname``. Use ``model=help`` to list the available device 710039a6837SPaolo Bonzini types. 711039a6837SPaolo Bonzini 712039a6837SPaolo Bonzini The following two example do exactly the same, to show how ``-audio`` 713039a6837SPaolo Bonzini can be used to shorten the command line length: 714039a6837SPaolo Bonzini 715039a6837SPaolo Bonzini .. parsed-literal:: 716039a6837SPaolo Bonzini 717039a6837SPaolo Bonzini |qemu_system| -audiodev pa,id=pa -device sb16,audiodev=pa 718039a6837SPaolo Bonzini |qemu_system| -audio pa,model=sb16 719039a6837SPaolo BonziniERST 720039a6837SPaolo Bonzini 721f0b3d811SKővágó, ZoltánDEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev, 722f0b3d811SKővágó, Zoltán "-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n" 723f0b3d811SKővágó, Zoltán " specifies the audio backend to use\n" 724f0b3d811SKővágó, Zoltán " id= identifier of the backend\n" 725f0b3d811SKővágó, Zoltán " timer-period= timer period in microseconds\n" 7268efac073SKővágó, Zoltán " in|out.mixing-engine= use mixing engine to mix streams inside QEMU\n" 727f0b3d811SKővágó, Zoltán " in|out.fixed-settings= use fixed settings for host audio\n" 728f0b3d811SKővágó, Zoltán " in|out.frequency= frequency to use with fixed settings\n" 729f0b3d811SKővágó, Zoltán " in|out.channels= number of channels to use with fixed settings\n" 730f0b3d811SKővágó, Zoltán " in|out.format= sample format to use with fixed settings\n" 73149f77e6fSVolker Rümelin " valid values: s8, s16, s32, u8, u16, u32, f32\n" 732f0b3d811SKővágó, Zoltán " in|out.voices= number of voices to use\n" 7338624725bSStefan Hajnoczi " in|out.buffer-length= length of buffer in microseconds\n" 734f0b3d811SKővágó, Zoltán "-audiodev none,id=id,[,prop[=value][,...]]\n" 735f0b3d811SKővágó, Zoltán " dummy driver that discards all output\n" 736f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_ALSA 737f0b3d811SKővágó, Zoltán "-audiodev alsa,id=id[,prop[=value][,...]]\n" 738f0b3d811SKővágó, Zoltán " in|out.dev= name of the audio device to use\n" 739dfc54343SStefan Hajnoczi " in|out.period-length= length of period in microseconds\n" 740f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 741f0b3d811SKővágó, Zoltán " threshold= threshold (in microseconds) when playback starts\n" 742f0b3d811SKővágó, Zoltán#endif 743f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_COREAUDIO 744f0b3d811SKővágó, Zoltán "-audiodev coreaudio,id=id[,prop[=value][,...]]\n" 745f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 746f0b3d811SKővágó, Zoltán#endif 747f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_DSOUND 748f0b3d811SKővágó, Zoltán "-audiodev dsound,id=id[,prop[=value][,...]]\n" 749f0b3d811SKővágó, Zoltán " latency= add extra latency to playback in microseconds\n" 750f0b3d811SKővágó, Zoltán#endif 751f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_OSS 752f0b3d811SKővágó, Zoltán "-audiodev oss,id=id[,prop[=value][,...]]\n" 753f0b3d811SKővágó, Zoltán " in|out.dev= path of the audio device to use\n" 754f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 755f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 756f0b3d811SKővágó, Zoltán " try-mmap= try using memory mapped access\n" 757f0b3d811SKővágó, Zoltán " exclusive= open device in exclusive mode\n" 758f0b3d811SKővágó, Zoltán " dsp-policy= set timing policy (0..10), -1 to use fragment mode\n" 759f0b3d811SKővágó, Zoltán#endif 760f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_PA 761f0b3d811SKővágó, Zoltán "-audiodev pa,id=id[,prop[=value][,...]]\n" 762f0b3d811SKővágó, Zoltán " server= PulseAudio server address\n" 763f0b3d811SKővágó, Zoltán " in|out.name= source/sink device name\n" 76414d4f011SStefan Hajnoczi " in|out.latency= desired latency in microseconds\n" 765f0b3d811SKővágó, Zoltán#endif 766f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_SDL 767f0b3d811SKővágó, Zoltán "-audiodev sdl,id=id[,prop[=value][,...]]\n" 7685a0926c2SVolker Rümelin " in|out.buffer-count= number of buffers\n" 769f0b3d811SKővágó, Zoltán#endif 770f0b3d811SKővágó, Zoltán#ifdef CONFIG_SPICE 771f0b3d811SKővágó, Zoltán "-audiodev spice,id=id[,prop[=value][,...]]\n" 772f0b3d811SKővágó, Zoltán#endif 773739362d4SMarc-André Lureau#ifdef CONFIG_DBUS_DISPLAY 774739362d4SMarc-André Lureau "-audiodev dbus,id=id[,prop[=value][,...]]\n" 775739362d4SMarc-André Lureau#endif 776f0b3d811SKővágó, Zoltán "-audiodev wav,id=id[,prop[=value][,...]]\n" 777f0b3d811SKővágó, Zoltán " path= path of wav file to record\n", 778f0b3d811SKővágó, Zoltán QEMU_ARCH_ALL) 779e2fcbf42SPeter MaydellSRST 780e2fcbf42SPeter Maydell``-audiodev [driver=]driver,id=id[,prop[=value][,...]]`` 781e2fcbf42SPeter Maydell Adds a new audio backend driver identified by id. There are global 782e2fcbf42SPeter Maydell and driver specific properties. Some values can be set differently 783e2fcbf42SPeter Maydell for input and output, they're marked with ``in|out.``. You can set 784e2fcbf42SPeter Maydell the input's property with ``in.prop`` and the output's property with 785e2fcbf42SPeter Maydell ``out.prop``. For example: 786e2fcbf42SPeter Maydell 787e2fcbf42SPeter Maydell :: 788e2fcbf42SPeter Maydell 789e2fcbf42SPeter Maydell -audiodev alsa,id=example,in.frequency=44110,out.frequency=8000 790e2fcbf42SPeter Maydell -audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified 791e2fcbf42SPeter Maydell 792e2fcbf42SPeter Maydell NOTE: parameter validation is known to be incomplete, in many cases 793e2fcbf42SPeter Maydell specifying an invalid option causes QEMU to print an error message 794e2fcbf42SPeter Maydell and continue emulation without sound. 795e2fcbf42SPeter Maydell 796e2fcbf42SPeter Maydell Valid global options are: 797e2fcbf42SPeter Maydell 798e2fcbf42SPeter Maydell ``id=identifier`` 799e2fcbf42SPeter Maydell Identifies the audio backend. 800e2fcbf42SPeter Maydell 801e2fcbf42SPeter Maydell ``timer-period=period`` 802e2fcbf42SPeter Maydell Sets the timer period used by the audio subsystem in 803e2fcbf42SPeter Maydell microseconds. Default is 10000 (10 ms). 804e2fcbf42SPeter Maydell 805e2fcbf42SPeter Maydell ``in|out.mixing-engine=on|off`` 806e2fcbf42SPeter Maydell Use QEMU's mixing engine to mix all streams inside QEMU and 807e2fcbf42SPeter Maydell convert audio formats when not supported by the backend. When 808e2fcbf42SPeter Maydell off, fixed-settings must be off too. Note that disabling this 809e2fcbf42SPeter Maydell option means that the selected backend must support multiple 810e2fcbf42SPeter Maydell streams and the audio formats used by the virtual cards, 811e2fcbf42SPeter Maydell otherwise you'll get no sound. It's not recommended to disable 812e2fcbf42SPeter Maydell this option unless you want to use 5.1 or 7.1 audio, as mixing 813e2fcbf42SPeter Maydell engine only supports mono and stereo audio. Default is on. 814e2fcbf42SPeter Maydell 815e2fcbf42SPeter Maydell ``in|out.fixed-settings=on|off`` 816e2fcbf42SPeter Maydell Use fixed settings for host audio. When off, it will change 817e2fcbf42SPeter Maydell based on how the guest opens the sound card. In this case you 818e2fcbf42SPeter Maydell must not specify frequency, channels or format. Default is on. 819e2fcbf42SPeter Maydell 820e2fcbf42SPeter Maydell ``in|out.frequency=frequency`` 821e2fcbf42SPeter Maydell Specify the frequency to use when using fixed-settings. Default 822e2fcbf42SPeter Maydell is 44100Hz. 823e2fcbf42SPeter Maydell 824e2fcbf42SPeter Maydell ``in|out.channels=channels`` 825e2fcbf42SPeter Maydell Specify the number of channels to use when using fixed-settings. 826e2fcbf42SPeter Maydell Default is 2 (stereo). 827e2fcbf42SPeter Maydell 828e2fcbf42SPeter Maydell ``in|out.format=format`` 829e2fcbf42SPeter Maydell Specify the sample format to use when using fixed-settings. 830e2fcbf42SPeter Maydell Valid values are: ``s8``, ``s16``, ``s32``, ``u8``, ``u16``, 83149f77e6fSVolker Rümelin ``u32``, ``f32``. Default is ``s16``. 832e2fcbf42SPeter Maydell 833e2fcbf42SPeter Maydell ``in|out.voices=voices`` 834e2fcbf42SPeter Maydell Specify the number of voices to use. Default is 1. 835e2fcbf42SPeter Maydell 836e2fcbf42SPeter Maydell ``in|out.buffer-length=usecs`` 837e2fcbf42SPeter Maydell Sets the size of the buffer in microseconds. 838e2fcbf42SPeter Maydell 839e2fcbf42SPeter Maydell``-audiodev none,id=id[,prop[=value][,...]]`` 840e2fcbf42SPeter Maydell Creates a dummy backend that discards all outputs. This backend has 841e2fcbf42SPeter Maydell no backend specific properties. 842e2fcbf42SPeter Maydell 843e2fcbf42SPeter Maydell``-audiodev alsa,id=id[,prop[=value][,...]]`` 844e2fcbf42SPeter Maydell Creates backend using the ALSA. This backend is only available on 845e2fcbf42SPeter Maydell Linux. 846e2fcbf42SPeter Maydell 847e2fcbf42SPeter Maydell ALSA specific options are: 848e2fcbf42SPeter Maydell 849e2fcbf42SPeter Maydell ``in|out.dev=device`` 850e2fcbf42SPeter Maydell Specify the ALSA device to use for input and/or output. Default 851e2fcbf42SPeter Maydell is ``default``. 852e2fcbf42SPeter Maydell 853e2fcbf42SPeter Maydell ``in|out.period-length=usecs`` 854e2fcbf42SPeter Maydell Sets the period length in microseconds. 855e2fcbf42SPeter Maydell 856e2fcbf42SPeter Maydell ``in|out.try-poll=on|off`` 857e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 858e2fcbf42SPeter Maydell 859e2fcbf42SPeter Maydell ``threshold=threshold`` 860e2fcbf42SPeter Maydell Threshold (in microseconds) when playback starts. Default is 0. 861e2fcbf42SPeter Maydell 862e2fcbf42SPeter Maydell``-audiodev coreaudio,id=id[,prop[=value][,...]]`` 863e2fcbf42SPeter Maydell Creates a backend using Apple's Core Audio. This backend is only 864e2fcbf42SPeter Maydell available on Mac OS and only supports playback. 865e2fcbf42SPeter Maydell 866e2fcbf42SPeter Maydell Core Audio specific options are: 867e2fcbf42SPeter Maydell 868e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 869e2fcbf42SPeter Maydell Sets the count of the buffers. 870e2fcbf42SPeter Maydell 871e2fcbf42SPeter Maydell``-audiodev dsound,id=id[,prop[=value][,...]]`` 872e2fcbf42SPeter Maydell Creates a backend using Microsoft's DirectSound. This backend is 873e2fcbf42SPeter Maydell only available on Windows and only supports playback. 874e2fcbf42SPeter Maydell 875e2fcbf42SPeter Maydell DirectSound specific options are: 876e2fcbf42SPeter Maydell 877e2fcbf42SPeter Maydell ``latency=usecs`` 878e2fcbf42SPeter Maydell Add extra usecs microseconds latency to playback. Default is 879e2fcbf42SPeter Maydell 10000 (10 ms). 880e2fcbf42SPeter Maydell 881e2fcbf42SPeter Maydell``-audiodev oss,id=id[,prop[=value][,...]]`` 882e2fcbf42SPeter Maydell Creates a backend using OSS. This backend is available on most 883e2fcbf42SPeter Maydell Unix-like systems. 884e2fcbf42SPeter Maydell 885e2fcbf42SPeter Maydell OSS specific options are: 886e2fcbf42SPeter Maydell 887e2fcbf42SPeter Maydell ``in|out.dev=device`` 888e2fcbf42SPeter Maydell Specify the file name of the OSS device to use. Default is 889e2fcbf42SPeter Maydell ``/dev/dsp``. 890e2fcbf42SPeter Maydell 891e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 892e2fcbf42SPeter Maydell Sets the count of the buffers. 893e2fcbf42SPeter Maydell 894e2fcbf42SPeter Maydell ``in|out.try-poll=on|of`` 895e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 896e2fcbf42SPeter Maydell 897e2fcbf42SPeter Maydell ``try-mmap=on|off`` 898e2fcbf42SPeter Maydell Try using memory mapped device access. Default is off. 899e2fcbf42SPeter Maydell 900e2fcbf42SPeter Maydell ``exclusive=on|off`` 901e2fcbf42SPeter Maydell Open the device in exclusive mode (vmix won't work in this 902e2fcbf42SPeter Maydell case). Default is off. 903e2fcbf42SPeter Maydell 904e2fcbf42SPeter Maydell ``dsp-policy=policy`` 905e2fcbf42SPeter Maydell Sets the timing policy (between 0 and 10, where smaller number 906e2fcbf42SPeter Maydell means smaller latency but higher CPU usage). Use -1 to use 907e2fcbf42SPeter Maydell buffer sizes specified by ``buffer`` and ``buffer-count``. This 908e2fcbf42SPeter Maydell option is ignored if you do not have OSS 4. Default is 5. 909e2fcbf42SPeter Maydell 910e2fcbf42SPeter Maydell``-audiodev pa,id=id[,prop[=value][,...]]`` 911e2fcbf42SPeter Maydell Creates a backend using PulseAudio. This backend is available on 912e2fcbf42SPeter Maydell most systems. 913e2fcbf42SPeter Maydell 914e2fcbf42SPeter Maydell PulseAudio specific options are: 915e2fcbf42SPeter Maydell 916e2fcbf42SPeter Maydell ``server=server`` 917e2fcbf42SPeter Maydell Sets the PulseAudio server to connect to. 918e2fcbf42SPeter Maydell 919e2fcbf42SPeter Maydell ``in|out.name=sink`` 920e2fcbf42SPeter Maydell Use the specified source/sink for recording/playback. 921e2fcbf42SPeter Maydell 922e2fcbf42SPeter Maydell ``in|out.latency=usecs`` 923e2fcbf42SPeter Maydell Desired latency in microseconds. The PulseAudio server will try 924e2fcbf42SPeter Maydell to honor this value but actual latencies may be lower or higher. 925e2fcbf42SPeter Maydell 926e2fcbf42SPeter Maydell``-audiodev sdl,id=id[,prop[=value][,...]]`` 927e2fcbf42SPeter Maydell Creates a backend using SDL. This backend is available on most 928e2fcbf42SPeter Maydell systems, but you should use your platform's native backend if 9295a0926c2SVolker Rümelin possible. 9305a0926c2SVolker Rümelin 9315a0926c2SVolker Rümelin SDL specific options are: 9325a0926c2SVolker Rümelin 9335a0926c2SVolker Rümelin ``in|out.buffer-count=count`` 9345a0926c2SVolker Rümelin Sets the count of the buffers. 935e2fcbf42SPeter Maydell 936e2fcbf42SPeter Maydell``-audiodev spice,id=id[,prop[=value][,...]]`` 937e2fcbf42SPeter Maydell Creates a backend that sends audio through SPICE. This backend 938e2fcbf42SPeter Maydell requires ``-spice`` and automatically selected in that case, so 939e2fcbf42SPeter Maydell usually you can ignore this option. This backend has no backend 940e2fcbf42SPeter Maydell specific properties. 941e2fcbf42SPeter Maydell 942e2fcbf42SPeter Maydell``-audiodev wav,id=id[,prop[=value][,...]]`` 943e2fcbf42SPeter Maydell Creates a backend that writes audio to a WAV file. 944e2fcbf42SPeter Maydell 945e2fcbf42SPeter Maydell Backend specific options are: 946e2fcbf42SPeter Maydell 947e2fcbf42SPeter Maydell ``path=path`` 948e2fcbf42SPeter Maydell Write recorded audio into the specified file. Default is 949e2fcbf42SPeter Maydell ``qemu.wav``. 950e2fcbf42SPeter MaydellERST 95110adb8beSMarkus Armbruster 95210adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 95310adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 95410adb8beSMarkus Armbruster " add device (based on driver)\n" 95510adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 95610adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 95710adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 95810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 959e2fcbf42SPeter MaydellSRST 960e2fcbf42SPeter Maydell``-device driver[,prop[=value][,...]]`` 961e2fcbf42SPeter Maydell Add device driver. prop=value sets driver properties. Valid 962e2fcbf42SPeter Maydell properties depend on the driver. To get help on possible drivers and 963e2fcbf42SPeter Maydell properties, use ``-device help`` and ``-device driver,help``. 964e2fcbf42SPeter Maydell 965e2fcbf42SPeter Maydell Some drivers are: 966e2fcbf42SPeter Maydell 967789101b7SCorey Minyard``-device ipmi-bmc-sim,id=id[,prop[=value][,...]]`` 968e2fcbf42SPeter Maydell Add an IPMI BMC. This is a simulation of a hardware management 969e2fcbf42SPeter Maydell interface processor that normally sits on a system. It provides a 970e2fcbf42SPeter Maydell watchdog and the ability to reset and power control the system. You 971e2fcbf42SPeter Maydell need to connect this to an IPMI interface to make it useful 972e2fcbf42SPeter Maydell 973e2fcbf42SPeter Maydell The IPMI slave address to use for the BMC. The default is 0x20. This 974e2fcbf42SPeter Maydell address is the BMC's address on the I2C network of management 975e2fcbf42SPeter Maydell controllers. If you don't know what this means, it is safe to ignore 976e2fcbf42SPeter Maydell it. 977e2fcbf42SPeter Maydell 978e2fcbf42SPeter Maydell ``id=id`` 979e2fcbf42SPeter Maydell The BMC id for interfaces to use this device. 980e2fcbf42SPeter Maydell 981e2fcbf42SPeter Maydell ``slave_addr=val`` 982e2fcbf42SPeter Maydell Define slave address to use for the BMC. The default is 0x20. 983e2fcbf42SPeter Maydell 984e2fcbf42SPeter Maydell ``sdrfile=file`` 985e2fcbf42SPeter Maydell file containing raw Sensor Data Records (SDR) data. The default 986e2fcbf42SPeter Maydell is none. 987e2fcbf42SPeter Maydell 988e2fcbf42SPeter Maydell ``fruareasize=val`` 989e2fcbf42SPeter Maydell size of a Field Replaceable Unit (FRU) area. The default is 990e2fcbf42SPeter Maydell 1024. 991e2fcbf42SPeter Maydell 992e2fcbf42SPeter Maydell ``frudatafile=file`` 993e2fcbf42SPeter Maydell file containing raw Field Replaceable Unit (FRU) inventory data. 994e2fcbf42SPeter Maydell The default is none. 995e2fcbf42SPeter Maydell 996e2fcbf42SPeter Maydell ``guid=uuid`` 997e2fcbf42SPeter Maydell value for the GUID for the BMC, in standard UUID format. If this 998e2fcbf42SPeter Maydell is set, get "Get GUID" command to the BMC will return it. 999e2fcbf42SPeter Maydell Otherwise "Get GUID" will return an error. 1000e2fcbf42SPeter Maydell 1001e2fcbf42SPeter Maydell``-device ipmi-bmc-extern,id=id,chardev=id[,slave_addr=val]`` 1002e2fcbf42SPeter Maydell Add a connection to an external IPMI BMC simulator. Instead of 1003e2fcbf42SPeter Maydell locally emulating the BMC like the above item, instead connect to an 1004e2fcbf42SPeter Maydell external entity that provides the IPMI services. 1005e2fcbf42SPeter Maydell 1006e2fcbf42SPeter Maydell A connection is made to an external BMC simulator. If you do this, 1007e2fcbf42SPeter Maydell it is strongly recommended that you use the "reconnect=" chardev 1008e2fcbf42SPeter Maydell option to reconnect to the simulator if the connection is lost. Note 1009e2fcbf42SPeter Maydell that if this is not used carefully, it can be a security issue, as 1010e2fcbf42SPeter Maydell the interface has the ability to send resets, NMIs, and power off 1011e2fcbf42SPeter Maydell the VM. It's best if QEMU makes a connection to an external 1012e2fcbf42SPeter Maydell simulator running on a secure port on localhost, so neither the 1013e2fcbf42SPeter Maydell simulator nor QEMU is exposed to any outside network. 1014e2fcbf42SPeter Maydell 1015e2fcbf42SPeter Maydell See the "lanserv/README.vm" file in the OpenIPMI library for more 1016e2fcbf42SPeter Maydell details on the external interface. 1017e2fcbf42SPeter Maydell 1018e2fcbf42SPeter Maydell``-device isa-ipmi-kcs,bmc=id[,ioport=val][,irq=val]`` 1019e2fcbf42SPeter Maydell Add a KCS IPMI interafce on the ISA bus. This also adds a 1020e2fcbf42SPeter Maydell corresponding ACPI and SMBIOS entries, if appropriate. 1021e2fcbf42SPeter Maydell 1022e2fcbf42SPeter Maydell ``bmc=id`` 1023e2fcbf42SPeter Maydell The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern 1024e2fcbf42SPeter Maydell above. 1025e2fcbf42SPeter Maydell 1026e2fcbf42SPeter Maydell ``ioport=val`` 1027e2fcbf42SPeter Maydell Define the I/O address of the interface. The default is 0xca0 1028e2fcbf42SPeter Maydell for KCS. 1029e2fcbf42SPeter Maydell 1030e2fcbf42SPeter Maydell ``irq=val`` 1031e2fcbf42SPeter Maydell Define the interrupt to use. The default is 5. To disable 1032e2fcbf42SPeter Maydell interrupts, set this to 0. 1033e2fcbf42SPeter Maydell 1034e2fcbf42SPeter Maydell``-device isa-ipmi-bt,bmc=id[,ioport=val][,irq=val]`` 1035e2fcbf42SPeter Maydell Like the KCS interface, but defines a BT interface. The default port 1036e2fcbf42SPeter Maydell is 0xe4 and the default interrupt is 5. 1037323679daSCorey Minyard 1038323679daSCorey Minyard``-device pci-ipmi-kcs,bmc=id`` 1039323679daSCorey Minyard Add a KCS IPMI interafce on the PCI bus. 1040323679daSCorey Minyard 1041323679daSCorey Minyard ``bmc=id`` 1042323679daSCorey Minyard The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 1043323679daSCorey Minyard 1044323679daSCorey Minyard``-device pci-ipmi-bt,bmc=id`` 1045323679daSCorey Minyard Like the KCS interface, but defines a BT interface on the PCI bus. 10467395b3e3SPeter Xu 10477395b3e3SPeter Xu``-device intel-iommu[,option=...]`` 10487395b3e3SPeter Xu This is only supported by ``-machine q35``, which will enable Intel VT-d 10497395b3e3SPeter Xu emulation within the guest. It supports below options: 10507395b3e3SPeter Xu 10517395b3e3SPeter Xu ``intremap=on|off`` (default: auto) 10527395b3e3SPeter Xu This enables interrupt remapping feature. It's required to enable 10537395b3e3SPeter Xu complete x2apic. Currently it only supports kvm kernel-irqchip modes 10547395b3e3SPeter Xu ``off`` or ``split``, while full kernel-irqchip is not yet supported. 10557395b3e3SPeter Xu The default value is "auto", which will be decided by the mode of 10567395b3e3SPeter Xu kernel-irqchip. 10577395b3e3SPeter Xu 10587395b3e3SPeter Xu ``caching-mode=on|off`` (default: off) 10597395b3e3SPeter Xu This enables caching mode for the VT-d emulated device. When 10607395b3e3SPeter Xu caching-mode is enabled, each guest DMA buffer mapping will generate an 10617395b3e3SPeter Xu IOTLB invalidation from the guest IOMMU driver to the vIOMMU device in 10627395b3e3SPeter Xu a synchronous way. It is required for ``-device vfio-pci`` to work 10637395b3e3SPeter Xu with the VT-d device, because host assigned devices requires to setup 10647395b3e3SPeter Xu the DMA mapping on the host before guest DMA starts. 10657395b3e3SPeter Xu 10667395b3e3SPeter Xu ``device-iotlb=on|off`` (default: off) 10677395b3e3SPeter Xu This enables device-iotlb capability for the emulated VT-d device. So 10687395b3e3SPeter Xu far virtio/vhost should be the only real user for this parameter, 10697395b3e3SPeter Xu paired with ats=on configured for the device. 10707395b3e3SPeter Xu 10717395b3e3SPeter Xu ``aw-bits=39|48`` (default: 39) 10727395b3e3SPeter Xu This decides the address width of IOVA address space. The address 10737395b3e3SPeter Xu space has 39 bits width for 3-level IOMMU page tables, and 48 bits for 10747395b3e3SPeter Xu 4-level IOMMU page tables. 10757395b3e3SPeter Xu 10767395b3e3SPeter Xu Please also refer to the wiki page for general scenarios of VT-d 10777395b3e3SPeter Xu emulation in QEMU: https://wiki.qemu.org/Features/VT-d. 10787395b3e3SPeter Xu 1079e2fcbf42SPeter MaydellERST 108010adb8beSMarkus Armbruster 108110adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 10828f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 108310adb8beSMarkus Armbruster " set the name of the guest\n" 1084479a5747SRoman Bolshakov " string1 sets the window title and string2 the process name\n" 1085479a5747SRoman Bolshakov " When debug-threads is enabled, individual threads are given a separate name\n" 10868f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 108710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1088e2fcbf42SPeter MaydellSRST 1089e2fcbf42SPeter Maydell``-name name`` 1090e2fcbf42SPeter Maydell Sets the name of the guest. This name will be displayed in the SDL 1091e2fcbf42SPeter Maydell window caption. The name will also be used for the VNC server. Also 1092e2fcbf42SPeter Maydell optionally set the top visible process name in Linux. Naming of 1093e2fcbf42SPeter Maydell individual threads can also be enabled on Linux to aid debugging. 1094e2fcbf42SPeter MaydellERST 109510adb8beSMarkus Armbruster 109610adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 109710adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 109810adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 1099e2fcbf42SPeter MaydellSRST 1100e2fcbf42SPeter Maydell``-uuid uuid`` 1101e2fcbf42SPeter Maydell Set system UUID. 1102e2fcbf42SPeter MaydellERST 110310adb8beSMarkus Armbruster 110410adb8beSMarkus ArmbrusterDEFHEADING() 110510adb8beSMarkus Armbruster 1106de6b4f90SMarkus ArmbrusterDEFHEADING(Block device options:) 110710adb8beSMarkus Armbruster 11085824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 1109ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 1110ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 1111e2fcbf42SPeter MaydellSRST 111209ce5f2dSPeter Maydell``-fda file`` 111309ce5f2dSPeter Maydell \ 111409ce5f2dSPeter Maydell``-fdb file`` 1115923e9311SThomas Huth Use file as floppy disk 0/1 image (see the :ref:`disk images` chapter in 1116923e9311SThomas Huth the System Emulation Users Guide). 1117e2fcbf42SPeter MaydellERST 11185824d651Sblueswir1 11195824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 1120ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 1121ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 11225824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 1123ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 1124ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 1125e2fcbf42SPeter MaydellSRST 112609ce5f2dSPeter Maydell``-hda file`` 112709ce5f2dSPeter Maydell \ 112809ce5f2dSPeter Maydell``-hdb file`` 112909ce5f2dSPeter Maydell \ 113009ce5f2dSPeter Maydell``-hdc file`` 113109ce5f2dSPeter Maydell \ 113209ce5f2dSPeter Maydell``-hdd file`` 1133923e9311SThomas Huth Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` 1134923e9311SThomas Huth chapter in the System Emulation Users Guide). 1135e2fcbf42SPeter MaydellERST 11365824d651Sblueswir1 11375824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 1138ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 1139ad96090aSBlue Swirl QEMU_ARCH_ALL) 1140e2fcbf42SPeter MaydellSRST 1141e2fcbf42SPeter Maydell``-cdrom file`` 1142e2fcbf42SPeter Maydell Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at 1143e2fcbf42SPeter Maydell the same time). You can use the host CD-ROM by using ``/dev/cdrom`` 1144e2fcbf42SPeter Maydell as filename. 1145e2fcbf42SPeter MaydellERST 11465824d651Sblueswir1 114742e5f393SMarkus ArmbrusterDEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, 114842e5f393SMarkus Armbruster "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n" 114942e5f393SMarkus Armbruster " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 1150c9b749d7SKevin Wolf " [,read-only=on|off][,auto-read-only=on|off]\n" 1151c9b749d7SKevin Wolf " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n" 115242e5f393SMarkus Armbruster " [,driver specific parameters...]\n" 115342e5f393SMarkus Armbruster " configure a block backend\n", QEMU_ARCH_ALL) 1154e2fcbf42SPeter MaydellSRST 1155e2fcbf42SPeter Maydell``-blockdev option[,option[,option[,...]]]`` 1156e2fcbf42SPeter Maydell Define a new block driver node. Some of the options apply to all 1157e2fcbf42SPeter Maydell block drivers, other options are only accepted for a specific block 1158e2fcbf42SPeter Maydell driver. See below for a list of generic options and options for the 1159e2fcbf42SPeter Maydell most common block drivers. 1160e2fcbf42SPeter Maydell 1161e2fcbf42SPeter Maydell Options that expect a reference to another node (e.g. ``file``) can 1162e2fcbf42SPeter Maydell be given in two ways. Either you specify the node name of an already 1163e2fcbf42SPeter Maydell existing node (file=node-name), or you define a new node inline, 1164e2fcbf42SPeter Maydell adding options for the referenced node after a dot 1165e2fcbf42SPeter Maydell (file.filename=path,file.aio=native). 1166e2fcbf42SPeter Maydell 1167e2fcbf42SPeter Maydell A block driver node created with ``-blockdev`` can be used for a 1168e2fcbf42SPeter Maydell guest device by specifying its node name for the ``drive`` property 1169e2fcbf42SPeter Maydell in a ``-device`` argument that defines a block device. 1170e2fcbf42SPeter Maydell 1171e2fcbf42SPeter Maydell ``Valid options for any block driver node:`` 1172e2fcbf42SPeter Maydell ``driver`` 1173e2fcbf42SPeter Maydell Specifies the block driver to use for the given node. 1174e2fcbf42SPeter Maydell 1175e2fcbf42SPeter Maydell ``node-name`` 1176e2fcbf42SPeter Maydell This defines the name of the block driver node by which it 1177e2fcbf42SPeter Maydell will be referenced later. The name must be unique, i.e. it 1178e2fcbf42SPeter Maydell must not match the name of a different block driver node, or 1179e2fcbf42SPeter Maydell (if you use ``-drive`` as well) the ID of a drive. 1180e2fcbf42SPeter Maydell 1181e2fcbf42SPeter Maydell If no node name is specified, it is automatically generated. 1182e2fcbf42SPeter Maydell The generated node name is not intended to be predictable 1183e2fcbf42SPeter Maydell and changes between QEMU invocations. For the top level, an 1184e2fcbf42SPeter Maydell explicit node name must be specified. 1185e2fcbf42SPeter Maydell 1186e2fcbf42SPeter Maydell ``read-only`` 1187e2fcbf42SPeter Maydell Open the node read-only. Guest write attempts will fail. 1188e2fcbf42SPeter Maydell 1189e2fcbf42SPeter Maydell Note that some block drivers support only read-only access, 1190e2fcbf42SPeter Maydell either generally or in certain configurations. In this case, 1191e2fcbf42SPeter Maydell the default value ``read-only=off`` does not work and the 1192e2fcbf42SPeter Maydell option must be specified explicitly. 1193e2fcbf42SPeter Maydell 1194e2fcbf42SPeter Maydell ``auto-read-only`` 1195e2fcbf42SPeter Maydell If ``auto-read-only=on`` is set, QEMU may fall back to 1196e2fcbf42SPeter Maydell read-only usage even when ``read-only=off`` is requested, or 1197e2fcbf42SPeter Maydell even switch between modes as needed, e.g. depending on 1198e2fcbf42SPeter Maydell whether the image file is writable or whether a writing user 1199e2fcbf42SPeter Maydell is attached to the node. 1200e2fcbf42SPeter Maydell 1201e2fcbf42SPeter Maydell ``force-share`` 1202e2fcbf42SPeter Maydell Override the image locking system of QEMU by forcing the 1203e2fcbf42SPeter Maydell node to utilize weaker shared access for permissions where 1204e2fcbf42SPeter Maydell it would normally request exclusive access. When there is 1205e2fcbf42SPeter Maydell the potential for multiple instances to have the same file 1206e2fcbf42SPeter Maydell open (whether this invocation of QEMU is the first or the 1207e2fcbf42SPeter Maydell second instance), both instances must permit shared access 1208e2fcbf42SPeter Maydell for the second instance to succeed at opening the file. 1209e2fcbf42SPeter Maydell 1210e2fcbf42SPeter Maydell Enabling ``force-share=on`` requires ``read-only=on``. 1211e2fcbf42SPeter Maydell 1212e2fcbf42SPeter Maydell ``cache.direct`` 1213e2fcbf42SPeter Maydell The host page cache can be avoided with ``cache.direct=on``. 1214e2fcbf42SPeter Maydell This will attempt to do disk IO directly to the guest's 1215e2fcbf42SPeter Maydell memory. QEMU may still perform an internal copy of the data. 1216e2fcbf42SPeter Maydell 1217e2fcbf42SPeter Maydell ``cache.no-flush`` 1218e2fcbf42SPeter Maydell In case you don't care about data integrity over host 1219e2fcbf42SPeter Maydell failures, you can use ``cache.no-flush=on``. This option 1220e2fcbf42SPeter Maydell tells QEMU that it never needs to write any data to the disk 1221e2fcbf42SPeter Maydell but can instead keep things in cache. If anything goes 1222e2fcbf42SPeter Maydell wrong, like your host losing power, the disk storage getting 1223e2fcbf42SPeter Maydell disconnected accidentally, etc. your image will most 1224e2fcbf42SPeter Maydell probably be rendered unusable. 1225e2fcbf42SPeter Maydell 1226e2fcbf42SPeter Maydell ``discard=discard`` 1227e2fcbf42SPeter Maydell discard is one of "ignore" (or "off") or "unmap" (or "on") 1228e2fcbf42SPeter Maydell and controls whether ``discard`` (also known as ``trim`` or 1229e2fcbf42SPeter Maydell ``unmap``) requests are ignored or passed to the filesystem. 1230e2fcbf42SPeter Maydell Some machine types may not support discard requests. 1231e2fcbf42SPeter Maydell 1232e2fcbf42SPeter Maydell ``detect-zeroes=detect-zeroes`` 1233e2fcbf42SPeter Maydell detect-zeroes is "off", "on" or "unmap" and enables the 1234e2fcbf42SPeter Maydell automatic conversion of plain zero writes by the OS to 1235e2fcbf42SPeter Maydell driver specific optimized zero write commands. You may even 1236e2fcbf42SPeter Maydell choose "unmap" if discard is set to "unmap" to allow a zero 1237e2fcbf42SPeter Maydell write to be converted to an ``unmap`` operation. 1238e2fcbf42SPeter Maydell 1239e2fcbf42SPeter Maydell ``Driver-specific options for file`` 1240e2fcbf42SPeter Maydell This is the protocol-level block driver for accessing regular 1241e2fcbf42SPeter Maydell files. 1242e2fcbf42SPeter Maydell 1243e2fcbf42SPeter Maydell ``filename`` 1244e2fcbf42SPeter Maydell The path to the image file in the local filesystem 1245e2fcbf42SPeter Maydell 1246e2fcbf42SPeter Maydell ``aio`` 1247ad1e691dSStefano Garzarella Specifies the AIO backend (threads/native/io_uring, 1248ad1e691dSStefano Garzarella default: threads) 1249e2fcbf42SPeter Maydell 1250e2fcbf42SPeter Maydell ``locking`` 1251e2fcbf42SPeter Maydell Specifies whether the image file is protected with Linux OFD 1252e2fcbf42SPeter Maydell / POSIX locks. The default is to use the Linux Open File 1253e2fcbf42SPeter Maydell Descriptor API if available, otherwise no lock is applied. 1254e2fcbf42SPeter Maydell (auto/on/off, default: auto) 1255e2fcbf42SPeter Maydell 1256e2fcbf42SPeter Maydell Example: 1257e2fcbf42SPeter Maydell 1258e2fcbf42SPeter Maydell :: 1259e2fcbf42SPeter Maydell 1260e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk,filename=disk.img 1261e2fcbf42SPeter Maydell 1262e2fcbf42SPeter Maydell ``Driver-specific options for raw`` 1263e2fcbf42SPeter Maydell This is the image format block driver for raw images. It is 1264e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1265e2fcbf42SPeter Maydell ``file``. 1266e2fcbf42SPeter Maydell 1267e2fcbf42SPeter Maydell ``file`` 1268e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1269e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1270e2fcbf42SPeter Maydell 1271e2fcbf42SPeter Maydell Example 1: 1272e2fcbf42SPeter Maydell 1273e2fcbf42SPeter Maydell :: 1274e2fcbf42SPeter Maydell 1275e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk_file,filename=disk.img 1276e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file=disk_file 1277e2fcbf42SPeter Maydell 1278e2fcbf42SPeter Maydell Example 2: 1279e2fcbf42SPeter Maydell 1280e2fcbf42SPeter Maydell :: 1281e2fcbf42SPeter Maydell 1282e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img 1283e2fcbf42SPeter Maydell 1284e2fcbf42SPeter Maydell ``Driver-specific options for qcow2`` 1285e2fcbf42SPeter Maydell This is the image format block driver for qcow2 images. It is 1286e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1287e2fcbf42SPeter Maydell ``file``. 1288e2fcbf42SPeter Maydell 1289e2fcbf42SPeter Maydell ``file`` 1290e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1291e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1292e2fcbf42SPeter Maydell 1293e2fcbf42SPeter Maydell ``backing`` 1294e2fcbf42SPeter Maydell Reference to or definition of the backing file block device 1295e2fcbf42SPeter Maydell (default is taken from the image file). It is allowed to 1296e2fcbf42SPeter Maydell pass ``null`` here in order to disable the default backing 1297e2fcbf42SPeter Maydell file. 1298e2fcbf42SPeter Maydell 1299e2fcbf42SPeter Maydell ``lazy-refcounts`` 1300e2fcbf42SPeter Maydell Whether to enable the lazy refcounts feature (on/off; 1301e2fcbf42SPeter Maydell default is taken from the image file) 1302e2fcbf42SPeter Maydell 1303e2fcbf42SPeter Maydell ``cache-size`` 1304e2fcbf42SPeter Maydell The maximum total size of the L2 table and refcount block 1305e2fcbf42SPeter Maydell caches in bytes (default: the sum of l2-cache-size and 1306e2fcbf42SPeter Maydell refcount-cache-size) 1307e2fcbf42SPeter Maydell 1308e2fcbf42SPeter Maydell ``l2-cache-size`` 1309e2fcbf42SPeter Maydell The maximum size of the L2 table cache in bytes (default: if 1310e2fcbf42SPeter Maydell cache-size is not specified - 32M on Linux platforms, and 8M 1311e2fcbf42SPeter Maydell on non-Linux platforms; otherwise, as large as possible 1312e2fcbf42SPeter Maydell within the cache-size, while permitting the requested or the 1313e2fcbf42SPeter Maydell minimal refcount cache size) 1314e2fcbf42SPeter Maydell 1315e2fcbf42SPeter Maydell ``refcount-cache-size`` 1316e2fcbf42SPeter Maydell The maximum size of the refcount block cache in bytes 1317e2fcbf42SPeter Maydell (default: 4 times the cluster size; or if cache-size is 1318e2fcbf42SPeter Maydell specified, the part of it which is not used for the L2 1319e2fcbf42SPeter Maydell cache) 1320e2fcbf42SPeter Maydell 1321e2fcbf42SPeter Maydell ``cache-clean-interval`` 1322e2fcbf42SPeter Maydell Clean unused entries in the L2 and refcount caches. The 1323e2fcbf42SPeter Maydell interval is in seconds. The default value is 600 on 1324e2fcbf42SPeter Maydell supporting platforms, and 0 on other platforms. Setting it 1325e2fcbf42SPeter Maydell to 0 disables this feature. 1326e2fcbf42SPeter Maydell 1327e2fcbf42SPeter Maydell ``pass-discard-request`` 1328e2fcbf42SPeter Maydell Whether discard requests to the qcow2 device should be 1329e2fcbf42SPeter Maydell forwarded to the data source (on/off; default: on if 1330e2fcbf42SPeter Maydell discard=unmap is specified, off otherwise) 1331e2fcbf42SPeter Maydell 1332e2fcbf42SPeter Maydell ``pass-discard-snapshot`` 1333e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1334e2fcbf42SPeter Maydell issued when a snapshot operation (e.g. deleting a snapshot) 1335e2fcbf42SPeter Maydell frees clusters in the qcow2 file (on/off; default: on) 1336e2fcbf42SPeter Maydell 1337e2fcbf42SPeter Maydell ``pass-discard-other`` 1338e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1339e2fcbf42SPeter Maydell issued on other occasions where a cluster gets freed 1340e2fcbf42SPeter Maydell (on/off; default: off) 1341e2fcbf42SPeter Maydell 1342e2fcbf42SPeter Maydell ``overlap-check`` 1343e2fcbf42SPeter Maydell Which overlap checks to perform for writes to the image 1344e2fcbf42SPeter Maydell (none/constant/cached/all; default: cached). For details or 1345e2fcbf42SPeter Maydell finer granularity control refer to the QAPI documentation of 1346e2fcbf42SPeter Maydell ``blockdev-add``. 1347e2fcbf42SPeter Maydell 1348e2fcbf42SPeter Maydell Example 1: 1349e2fcbf42SPeter Maydell 1350e2fcbf42SPeter Maydell :: 1351e2fcbf42SPeter Maydell 1352e2fcbf42SPeter Maydell -blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2 1353e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216 1354e2fcbf42SPeter Maydell 1355e2fcbf42SPeter Maydell Example 2: 1356e2fcbf42SPeter Maydell 1357e2fcbf42SPeter Maydell :: 1358e2fcbf42SPeter Maydell 1359e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2 1360e2fcbf42SPeter Maydell 1361e2fcbf42SPeter Maydell ``Driver-specific options for other drivers`` 1362e2fcbf42SPeter Maydell Please refer to the QAPI documentation of the ``blockdev-add`` 1363e2fcbf42SPeter Maydell QMP command. 1364e2fcbf42SPeter MaydellERST 136542e5f393SMarkus Armbruster 13665824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 13675824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 136892196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 1369572023f7SKevin Wolf " [,snapshot=on|off][,rerror=ignore|stop|report]\n" 1370ad1e691dSStefano Garzarella " [,werror=ignore|stop|report|enospc][,id=name]\n" 1371ad1e691dSStefano Garzarella " [,aio=threads|native|io_uring]\n" 1372fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 13732f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 13743e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 13753e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 13763e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 13773e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 13782024c1dfSBenoît Canet " [[,iops_size=is]]\n" 137976f4afb4SAlberto Garcia " [[,group=g]]\n" 1380ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1381e2fcbf42SPeter MaydellSRST 1382e2fcbf42SPeter Maydell``-drive option[,option[,option[,...]]]`` 1383e2fcbf42SPeter Maydell Define a new drive. This includes creating a block driver node (the 1384e2fcbf42SPeter Maydell backend) as well as a guest device, and is mostly a shortcut for 1385e2fcbf42SPeter Maydell defining the corresponding ``-blockdev`` and ``-device`` options. 1386e2fcbf42SPeter Maydell 1387e2fcbf42SPeter Maydell ``-drive`` accepts all options that are accepted by ``-blockdev``. 1388e2fcbf42SPeter Maydell In addition, it knows the following options: 1389e2fcbf42SPeter Maydell 1390e2fcbf42SPeter Maydell ``file=file`` 1391923e9311SThomas Huth This option defines which disk image (see the :ref:`disk images` 1392923e9311SThomas Huth chapter in the System Emulation Users Guide) to use with this drive. 1393923e9311SThomas Huth If the filename contains comma, you must double it (for instance, 1394e2fcbf42SPeter Maydell "file=my,,file" to use file "my,file"). 1395e2fcbf42SPeter Maydell 1396e2fcbf42SPeter Maydell Special files such as iSCSI devices can be specified using 1397e2fcbf42SPeter Maydell protocol specific URLs. See the section for "Device URL Syntax" 1398e2fcbf42SPeter Maydell for more information. 1399e2fcbf42SPeter Maydell 1400e2fcbf42SPeter Maydell ``if=interface`` 1401e2fcbf42SPeter Maydell This option defines on which type on interface the drive is 1402e2fcbf42SPeter Maydell connected. Available types are: ide, scsi, sd, mtd, floppy, 1403e2fcbf42SPeter Maydell pflash, virtio, none. 1404e2fcbf42SPeter Maydell 1405e2fcbf42SPeter Maydell ``bus=bus,unit=unit`` 1406e2fcbf42SPeter Maydell These options define where is connected the drive by defining 1407e2fcbf42SPeter Maydell the bus number and the unit id. 1408e2fcbf42SPeter Maydell 1409e2fcbf42SPeter Maydell ``index=index`` 141035aab303SLaurent Vivier This option defines where the drive is connected by using an 1411e2fcbf42SPeter Maydell index in the list of available connectors of a given interface 1412e2fcbf42SPeter Maydell type. 1413e2fcbf42SPeter Maydell 1414e2fcbf42SPeter Maydell ``media=media`` 1415e2fcbf42SPeter Maydell This option defines the type of the media: disk or cdrom. 1416e2fcbf42SPeter Maydell 1417e2fcbf42SPeter Maydell ``snapshot=snapshot`` 1418e2fcbf42SPeter Maydell snapshot is "on" or "off" and controls snapshot mode for the 1419e2fcbf42SPeter Maydell given drive (see ``-snapshot``). 1420e2fcbf42SPeter Maydell 1421e2fcbf42SPeter Maydell ``cache=cache`` 1422e2fcbf42SPeter Maydell cache is "none", "writeback", "unsafe", "directsync" or 1423e2fcbf42SPeter Maydell "writethrough" and controls how the host cache is used to access 1424e2fcbf42SPeter Maydell block data. This is a shortcut that sets the ``cache.direct`` 1425e2fcbf42SPeter Maydell and ``cache.no-flush`` options (as in ``-blockdev``), and 1426e2fcbf42SPeter Maydell additionally ``cache.writeback``, which provides a default for 1427e2fcbf42SPeter Maydell the ``write-cache`` option of block guest devices (as in 1428e2fcbf42SPeter Maydell ``-device``). The modes correspond to the following settings: 1429e2fcbf42SPeter Maydell 143009ce5f2dSPeter Maydell ============= =============== ============ ============== 143109ce5f2dSPeter Maydell \ cache.writeback cache.direct cache.no-flush 143209ce5f2dSPeter Maydell ============= =============== ============ ============== 143309ce5f2dSPeter Maydell writeback on off off 143409ce5f2dSPeter Maydell none on on off 143509ce5f2dSPeter Maydell writethrough off off off 143609ce5f2dSPeter Maydell directsync off on off 143709ce5f2dSPeter Maydell unsafe on off on 143809ce5f2dSPeter Maydell ============= =============== ============ ============== 1439e2fcbf42SPeter Maydell 1440e2fcbf42SPeter Maydell The default mode is ``cache=writeback``. 1441e2fcbf42SPeter Maydell 1442e2fcbf42SPeter Maydell ``aio=aio`` 1443ad1e691dSStefano Garzarella aio is "threads", "native", or "io_uring" and selects between pthread 1444ad1e691dSStefano Garzarella based disk I/O, native Linux AIO, or Linux io_uring API. 1445e2fcbf42SPeter Maydell 1446e2fcbf42SPeter Maydell ``format=format`` 1447e2fcbf42SPeter Maydell Specify which disk format will be used rather than detecting the 1448e2fcbf42SPeter Maydell format. Can be used to specify format=raw to avoid interpreting 1449e2fcbf42SPeter Maydell an untrusted format header. 1450e2fcbf42SPeter Maydell 1451e2fcbf42SPeter Maydell ``werror=action,rerror=action`` 1452e2fcbf42SPeter Maydell Specify which action to take on write and read errors. Valid 1453e2fcbf42SPeter Maydell actions are: "ignore" (ignore the error and try to continue), 1454e2fcbf42SPeter Maydell "stop" (pause QEMU), "report" (report the error to the guest), 1455e2fcbf42SPeter Maydell "enospc" (pause QEMU only if the host disk is full; report the 1456e2fcbf42SPeter Maydell error to the guest otherwise). The default setting is 1457e2fcbf42SPeter Maydell ``werror=enospc`` and ``rerror=report``. 1458e2fcbf42SPeter Maydell 1459e2fcbf42SPeter Maydell ``copy-on-read=copy-on-read`` 1460e2fcbf42SPeter Maydell copy-on-read is "on" or "off" and enables whether to copy read 1461e2fcbf42SPeter Maydell backing file sectors into the image file. 1462e2fcbf42SPeter Maydell 1463e2fcbf42SPeter Maydell ``bps=b,bps_rd=r,bps_wr=w`` 1464e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1465e2fcbf42SPeter Maydell for all request types or for reads or writes only. Small values 1466e2fcbf42SPeter Maydell can lead to timeouts or hangs inside the guest. A safe minimum 1467e2fcbf42SPeter Maydell for disks is 2 MB/s. 1468e2fcbf42SPeter Maydell 1469e2fcbf42SPeter Maydell ``bps_max=bm,bps_rd_max=rm,bps_wr_max=wm`` 1470e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1471e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1472e2fcbf42SPeter Maydell above the limit temporarily. 1473e2fcbf42SPeter Maydell 1474e2fcbf42SPeter Maydell ``iops=i,iops_rd=r,iops_wr=w`` 1475e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1476e2fcbf42SPeter Maydell all request types or for reads or writes only. 1477e2fcbf42SPeter Maydell 1478e2fcbf42SPeter Maydell ``iops_max=bm,iops_rd_max=rm,iops_wr_max=wm`` 1479e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1480e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1481e2fcbf42SPeter Maydell spike above the limit temporarily. 1482e2fcbf42SPeter Maydell 1483e2fcbf42SPeter Maydell ``iops_size=is`` 1484e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1485e2fcbf42SPeter Maydell throttling purposes. Use this option to prevent guests from 1486e2fcbf42SPeter Maydell circumventing iops limits by sending fewer but larger requests. 1487e2fcbf42SPeter Maydell 1488e2fcbf42SPeter Maydell ``group=g`` 1489e2fcbf42SPeter Maydell Join a throttling quota group with given name g. All drives that 1490e2fcbf42SPeter Maydell are members of the same group are accounted for together. Use 1491e2fcbf42SPeter Maydell this option to prevent guests from circumventing throttling 1492e2fcbf42SPeter Maydell limits by using many small disks instead of a single larger 1493e2fcbf42SPeter Maydell disk. 1494e2fcbf42SPeter Maydell 1495e2fcbf42SPeter Maydell By default, the ``cache.writeback=on`` mode is used. It will report 1496e2fcbf42SPeter Maydell data writes as completed as soon as the data is present in the host 1497e2fcbf42SPeter Maydell page cache. This is safe as long as your guest OS makes sure to 1498e2fcbf42SPeter Maydell correctly flush disk caches where needed. If your guest OS does not 1499e2fcbf42SPeter Maydell handle volatile disk write caches correctly and your host crashes or 1500e2fcbf42SPeter Maydell loses power, then the guest may experience data corruption. 1501e2fcbf42SPeter Maydell 1502e2fcbf42SPeter Maydell For such guests, you should consider using ``cache.writeback=off``. 1503e2fcbf42SPeter Maydell This means that the host page cache will be used to read and write 1504e2fcbf42SPeter Maydell data, but write notification will be sent to the guest only after 1505e2fcbf42SPeter Maydell QEMU has made sure to flush each write to the disk. Be aware that 1506e2fcbf42SPeter Maydell this has a major impact on performance. 1507e2fcbf42SPeter Maydell 1508e2fcbf42SPeter Maydell When using the ``-snapshot`` option, unsafe caching is always used. 1509e2fcbf42SPeter Maydell 1510e2fcbf42SPeter Maydell Copy-on-read avoids accessing the same backing file sectors 1511e2fcbf42SPeter Maydell repeatedly and is useful when the backing file is over a slow 1512e2fcbf42SPeter Maydell network. By default copy-on-read is off. 1513e2fcbf42SPeter Maydell 1514e2fcbf42SPeter Maydell Instead of ``-cdrom`` you can use: 1515e2fcbf42SPeter Maydell 1516e2fcbf42SPeter Maydell .. parsed-literal:: 1517e2fcbf42SPeter Maydell 1518e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=cdrom 1519e2fcbf42SPeter Maydell 1520e2fcbf42SPeter Maydell Instead of ``-hda``, ``-hdb``, ``-hdc``, ``-hdd``, you can use: 1521e2fcbf42SPeter Maydell 1522e2fcbf42SPeter Maydell .. parsed-literal:: 1523e2fcbf42SPeter Maydell 1524e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=0,media=disk 1525e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=1,media=disk 1526e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=disk 1527e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=3,media=disk 1528e2fcbf42SPeter Maydell 1529e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 1530e2fcbf42SPeter Maydell set: 1531e2fcbf42SPeter Maydell 1532e2fcbf42SPeter Maydell .. parsed-literal:: 1533e2fcbf42SPeter Maydell 1534353a06b4SLaszlo Ersek |qemu_system| \\ 1535353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 1536353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 1537e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 1538e2fcbf42SPeter Maydell 1539e2fcbf42SPeter Maydell You can connect a CDROM to the slave of ide0: 1540e2fcbf42SPeter Maydell 1541e2fcbf42SPeter Maydell .. parsed-literal:: 1542e2fcbf42SPeter Maydell 1543e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,if=ide,index=1,media=cdrom 1544e2fcbf42SPeter Maydell 1545e2fcbf42SPeter Maydell If you don't specify the "file=" argument, you define an empty 1546e2fcbf42SPeter Maydell drive: 1547e2fcbf42SPeter Maydell 1548e2fcbf42SPeter Maydell .. parsed-literal:: 1549e2fcbf42SPeter Maydell 1550e2fcbf42SPeter Maydell |qemu_system_x86| -drive if=ide,index=1,media=cdrom 1551e2fcbf42SPeter Maydell 1552e2fcbf42SPeter Maydell Instead of ``-fda``, ``-fdb``, you can use: 1553e2fcbf42SPeter Maydell 1554e2fcbf42SPeter Maydell .. parsed-literal:: 1555e2fcbf42SPeter Maydell 1556e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=0,if=floppy 1557e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=1,if=floppy 1558e2fcbf42SPeter Maydell 1559e2fcbf42SPeter Maydell By default, interface is "ide" and index is automatically 1560e2fcbf42SPeter Maydell incremented: 1561e2fcbf42SPeter Maydell 1562e2fcbf42SPeter Maydell .. parsed-literal:: 1563e2fcbf42SPeter Maydell 1564e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=a -drive file=b" 1565e2fcbf42SPeter Maydell 1566e2fcbf42SPeter Maydell is interpreted like: 1567e2fcbf42SPeter Maydell 1568e2fcbf42SPeter Maydell .. parsed-literal:: 1569e2fcbf42SPeter Maydell 1570e2fcbf42SPeter Maydell |qemu_system_x86| -hda a -hdb b 1571e2fcbf42SPeter MaydellERST 15725824d651Sblueswir1 15735824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 1574ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 1575ad96090aSBlue Swirl QEMU_ARCH_ALL) 1576e2fcbf42SPeter MaydellSRST 1577e2fcbf42SPeter Maydell``-mtdblock file`` 1578e2fcbf42SPeter Maydell Use file as on-board Flash memory image. 1579e2fcbf42SPeter MaydellERST 15805824d651Sblueswir1 15815824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 1582ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 1583e2fcbf42SPeter MaydellSRST 1584e2fcbf42SPeter Maydell``-sd file`` 1585e2fcbf42SPeter Maydell Use file as SecureDigital card image. 1586e2fcbf42SPeter MaydellERST 15875824d651Sblueswir1 15885824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 1589ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 1590e2fcbf42SPeter MaydellSRST 1591e2fcbf42SPeter Maydell``-pflash file`` 1592e2fcbf42SPeter Maydell Use file as a parallel flash image. 1593e2fcbf42SPeter MaydellERST 15945824d651Sblueswir1 15955824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 1596ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 1597ad96090aSBlue Swirl QEMU_ARCH_ALL) 1598e2fcbf42SPeter MaydellSRST 1599e2fcbf42SPeter Maydell``-snapshot`` 1600e2fcbf42SPeter Maydell Write to temporary files instead of disk image files. In this case, 1601e2fcbf42SPeter Maydell the raw disk image you use is not written back. You can however 1602923e9311SThomas Huth force the write back by pressing C-a s (see the :ref:`disk images` 1603923e9311SThomas Huth chapter in the System Emulation Users Guide). 1604e2fcbf42SPeter MaydellERST 16055824d651Sblueswir1 160674db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 1607b44a6b09SGreg Kurz "-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1608991c180dSPaolo Bonzini " [,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode]\n" 1609b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n" 1610b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n" 1611b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n" 1612b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n" 1613b44a6b09SGreg Kurz " [[,throttling.iops-size=is]]\n" 1614991c180dSPaolo Bonzini "-fsdev proxy,id=id,socket=socket[,writeout=immediate][,readonly=on]\n" 1615991c180dSPaolo Bonzini "-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=immediate][,readonly=on]\n" 1616b44a6b09SGreg Kurz "-fsdev synth,id=id\n", 161774db920cSGautham R Shenoy QEMU_ARCH_ALL) 161874db920cSGautham R Shenoy 1619e2fcbf42SPeter MaydellSRST 1620991c180dSPaolo 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[,...]]]`` 162109ce5f2dSPeter Maydell \ 1622991c180dSPaolo Bonzini``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly=on]`` 162309ce5f2dSPeter Maydell \ 1624991c180dSPaolo Bonzini``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly=on]`` 162509ce5f2dSPeter Maydell \ 1626991c180dSPaolo Bonzini``-fsdev synth,id=id[,readonly=on]`` 1627e2fcbf42SPeter Maydell Define a new file system device. Valid options are: 1628e2fcbf42SPeter Maydell 1629e2fcbf42SPeter Maydell ``local`` 1630e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1631e2fcbf42SPeter Maydell 1632e2fcbf42SPeter Maydell ``proxy`` 1633e2fcbf42SPeter Maydell Accesses to the filesystem are done by virtfs-proxy-helper(1). 1634e2fcbf42SPeter Maydell 1635e2fcbf42SPeter Maydell ``synth`` 1636e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1637e2fcbf42SPeter Maydell 1638e2fcbf42SPeter Maydell ``id=id`` 1639e2fcbf42SPeter Maydell Specifies identifier for this device. 1640e2fcbf42SPeter Maydell 1641e2fcbf42SPeter Maydell ``path=path`` 1642e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1643e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1644e2fcbf42SPeter Maydell 1645e2fcbf42SPeter Maydell ``security_model=security_model`` 1646e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1647e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1648e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1649e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1650e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1651e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1652e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1653e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1654e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1655e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1656e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1657e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1658e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1659e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1660e2fcbf42SPeter Maydell parameter. 1661e2fcbf42SPeter Maydell 1662e2fcbf42SPeter Maydell ``writeout=writeout`` 1663e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1664e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1665e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1666e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1667e2fcbf42SPeter Maydell storage subsystem. 1668e2fcbf42SPeter Maydell 1669991c180dSPaolo Bonzini ``readonly=on`` 1670e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1671e2fcbf42SPeter Maydell default read-write access is given. 1672e2fcbf42SPeter Maydell 1673e2fcbf42SPeter Maydell ``socket=socket`` 1674e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1675e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). 1676e2fcbf42SPeter Maydell 1677e2fcbf42SPeter Maydell ``sock_fd=sock_fd`` 1678e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket descriptor 1679e2fcbf42SPeter Maydell for communicating with virtfs-proxy-helper(1). Usually a helper 1680e2fcbf42SPeter Maydell like libvirt will create socketpair and pass one of the fds as 1681e2fcbf42SPeter Maydell sock\_fd. 1682e2fcbf42SPeter Maydell 1683e2fcbf42SPeter Maydell ``fmode=fmode`` 1684e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1685e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1686e2fcbf42SPeter Maydell "mapped-file". 1687e2fcbf42SPeter Maydell 1688e2fcbf42SPeter Maydell ``dmode=dmode`` 1689e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1690e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1691e2fcbf42SPeter Maydell "mapped-file". 1692e2fcbf42SPeter Maydell 1693e2fcbf42SPeter Maydell ``throttling.bps-total=b,throttling.bps-read=r,throttling.bps-write=w`` 1694e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1695e2fcbf42SPeter Maydell for all request types or for reads or writes only. 1696e2fcbf42SPeter Maydell 1697e2fcbf42SPeter Maydell ``throttling.bps-total-max=bm,bps-read-max=rm,bps-write-max=wm`` 1698e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1699e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1700e2fcbf42SPeter Maydell above the limit temporarily. 1701e2fcbf42SPeter Maydell 1702e2fcbf42SPeter Maydell ``throttling.iops-total=i,throttling.iops-read=r, throttling.iops-write=w`` 1703e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1704e2fcbf42SPeter Maydell all request types or for reads or writes only. 1705e2fcbf42SPeter Maydell 1706e2fcbf42SPeter Maydell ``throttling.iops-total-max=im,throttling.iops-read-max=irm, throttling.iops-write-max=iwm`` 1707e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1708e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1709e2fcbf42SPeter Maydell spike above the limit temporarily. 1710e2fcbf42SPeter Maydell 1711e2fcbf42SPeter Maydell ``throttling.iops-size=is`` 1712e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1713e2fcbf42SPeter Maydell throttling purposes. 1714e2fcbf42SPeter Maydell 1715e2fcbf42SPeter Maydell -fsdev option is used along with -device driver "virtio-9p-...". 1716e2fcbf42SPeter Maydell 1717e2fcbf42SPeter Maydell``-device virtio-9p-type,fsdev=id,mount_tag=mount_tag`` 1718e2fcbf42SPeter Maydell Options for virtio-9p-... driver are: 1719e2fcbf42SPeter Maydell 1720e2fcbf42SPeter Maydell ``type`` 1721e2fcbf42SPeter Maydell Specifies the variant to be used. Supported values are "pci", 1722e2fcbf42SPeter Maydell "ccw" or "device", depending on the machine type. 1723e2fcbf42SPeter Maydell 1724e2fcbf42SPeter Maydell ``fsdev=id`` 1725e2fcbf42SPeter Maydell Specifies the id value specified along with -fsdev option. 1726e2fcbf42SPeter Maydell 1727e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1728e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1729e2fcbf42SPeter Maydell export point. 1730e2fcbf42SPeter MaydellERST 173174db920cSGautham R Shenoy 17323d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 1733b44a6b09SGreg Kurz "-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1734991c180dSPaolo Bonzini " [,id=id][,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode][,multidevs=remap|forbid|warn]\n" 1735991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,socket=socket[,id=id][,writeout=immediate][,readonly=on]\n" 1736991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,sock_fd=sock_fd[,id=id][,writeout=immediate][,readonly=on]\n" 1737991c180dSPaolo Bonzini "-virtfs synth,mount_tag=tag[,id=id][,readonly=on]\n", 17383d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 17393d54abc7SGautham R Shenoy 1740e2fcbf42SPeter MaydellSRST 1741991c180dSPaolo Bonzini``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly=on] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]`` 174209ce5f2dSPeter Maydell \ 1743991c180dSPaolo Bonzini``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 174409ce5f2dSPeter Maydell \ 1745991c180dSPaolo Bonzini``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 174609ce5f2dSPeter Maydell \ 174709ce5f2dSPeter Maydell``-virtfs synth,mount_tag=mount_tag`` 174865abaa01SChristian Schoenebeck Define a new virtual filesystem device and expose it to the guest using 174965abaa01SChristian Schoenebeck a virtio-9p-device (a.k.a. 9pfs), which essentially means that a certain 175065abaa01SChristian Schoenebeck directory on host is made directly accessible by guest as a pass-through 175165abaa01SChristian Schoenebeck file system by using the 9P network protocol for communication between 175265abaa01SChristian Schoenebeck host and guests, if desired even accessible, shared by several guests 175365abaa01SChristian Schoenebeck simultaniously. 175465abaa01SChristian Schoenebeck 175565abaa01SChristian Schoenebeck Note that ``-virtfs`` is actually just a convenience shortcut for its 175665abaa01SChristian Schoenebeck generalized form ``-fsdev -device virtio-9p-pci``. 175765abaa01SChristian Schoenebeck 175865abaa01SChristian Schoenebeck The general form of pass-through file system options are: 1759e2fcbf42SPeter Maydell 1760e2fcbf42SPeter Maydell ``local`` 1761e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1762e2fcbf42SPeter Maydell 1763e2fcbf42SPeter Maydell ``proxy`` 1764e2fcbf42SPeter Maydell Accesses to the filesystem are done by virtfs-proxy-helper(1). 1765e2fcbf42SPeter Maydell 1766e2fcbf42SPeter Maydell ``synth`` 1767e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1768e2fcbf42SPeter Maydell 1769e2fcbf42SPeter Maydell ``id=id`` 1770e2fcbf42SPeter Maydell Specifies identifier for the filesystem device 1771e2fcbf42SPeter Maydell 1772e2fcbf42SPeter Maydell ``path=path`` 1773e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1774e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1775e2fcbf42SPeter Maydell 1776e2fcbf42SPeter Maydell ``security_model=security_model`` 1777e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1778e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1779e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1780e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1781e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1782e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1783e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1784e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1785e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1786e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1787e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1788e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1789e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1790e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1791e2fcbf42SPeter Maydell parameter. 1792e2fcbf42SPeter Maydell 1793e2fcbf42SPeter Maydell ``writeout=writeout`` 1794e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1795e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1796e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1797e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1798e2fcbf42SPeter Maydell storage subsystem. 1799e2fcbf42SPeter Maydell 1800991c180dSPaolo Bonzini ``readonly=on`` 1801e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1802e2fcbf42SPeter Maydell default read-write access is given. 1803e2fcbf42SPeter Maydell 1804e2fcbf42SPeter Maydell ``socket=socket`` 1805e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1806e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). Usually a helper like 1807e2fcbf42SPeter Maydell libvirt will create socketpair and pass one of the fds as 1808e2fcbf42SPeter Maydell sock\_fd. 1809e2fcbf42SPeter Maydell 1810e2fcbf42SPeter Maydell ``sock_fd`` 1811e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed 'sock\_fd' as the 1812e2fcbf42SPeter Maydell socket descriptor for interfacing with virtfs-proxy-helper(1). 1813e2fcbf42SPeter Maydell 1814e2fcbf42SPeter Maydell ``fmode=fmode`` 1815e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1816e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1817e2fcbf42SPeter Maydell "mapped-file". 1818e2fcbf42SPeter Maydell 1819e2fcbf42SPeter Maydell ``dmode=dmode`` 1820e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1821e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1822e2fcbf42SPeter Maydell "mapped-file". 1823e2fcbf42SPeter Maydell 1824e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1825e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1826e2fcbf42SPeter Maydell export point. 1827e2fcbf42SPeter Maydell 1828e2fcbf42SPeter Maydell ``multidevs=multidevs`` 1829e2fcbf42SPeter Maydell Specifies how to deal with multiple devices being shared with a 1830e2fcbf42SPeter Maydell 9p export. Supported behaviours are either "remap", "forbid" or 1831e2fcbf42SPeter Maydell "warn". The latter is the default behaviour on which virtfs 9p 1832e2fcbf42SPeter Maydell expects only one device to be shared with the same export, and 1833e2fcbf42SPeter Maydell if more than one device is shared and accessed via the same 9p 1834e2fcbf42SPeter Maydell export then only a warning message is logged (once) by qemu on 1835e2fcbf42SPeter Maydell host side. In order to avoid file ID collisions on guest you 1836e2fcbf42SPeter Maydell should either create a separate virtfs export for each device to 1837e2fcbf42SPeter Maydell be shared with guests (recommended way) or you might use "remap" 1838e2fcbf42SPeter Maydell instead which allows you to share multiple devices with only one 1839e2fcbf42SPeter Maydell export instead, which is achieved by remapping the original 1840e2fcbf42SPeter Maydell inode numbers from host to guest in a way that would prevent 1841e2fcbf42SPeter Maydell such collisions. Remapping inodes in such use cases is required 1842e2fcbf42SPeter Maydell because the original device IDs from host are never passed and 1843e2fcbf42SPeter Maydell exposed on guest. Instead all files of an export shared with 1844e2fcbf42SPeter Maydell virtfs always share the same device id on guest. So two files 1845e2fcbf42SPeter Maydell with identical inode numbers but from actually different devices 1846e2fcbf42SPeter Maydell on host would otherwise cause a file ID collision and hence 1847e2fcbf42SPeter Maydell potential misbehaviours on guest. "forbid" on the other hand 1848e2fcbf42SPeter Maydell assumes like "warn" that only one device is shared by the same 1849e2fcbf42SPeter Maydell export, however it will not only log a warning message but also 1850e2fcbf42SPeter Maydell deny access to additional devices on guest. Note though that 1851e2fcbf42SPeter Maydell "forbid" does currently not block all possible file access 1852e2fcbf42SPeter Maydell operations (e.g. readdir() would still return entries from other 1853e2fcbf42SPeter Maydell devices). 1854e2fcbf42SPeter MaydellERST 18553d54abc7SGautham R Shenoy 185661d70487SMarkus ArmbrusterDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 185761d70487SMarkus Armbruster "-iscsi [user=user][,password=password]\n" 185861d70487SMarkus Armbruster " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 185961d70487SMarkus Armbruster " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 186061d70487SMarkus Armbruster " [,timeout=timeout]\n" 186161d70487SMarkus Armbruster " iSCSI session parameters\n", QEMU_ARCH_ALL) 186261d70487SMarkus Armbruster 1863e2fcbf42SPeter MaydellSRST 1864e2fcbf42SPeter Maydell``-iscsi`` 1865e2fcbf42SPeter Maydell Configure iSCSI session parameters. 1866e2fcbf42SPeter MaydellERST 186744743148SMarkus Armbruster 18685824d651Sblueswir1DEFHEADING() 18695824d651Sblueswir1 1870c2a34ab2SThomas HuthDEFHEADING(USB convenience options:) 187110adb8beSMarkus Armbruster 187210adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 187373f46fefSStefan Hajnoczi "-usb enable on-board USB host controller (if not enabled by default)\n", 187410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1875e2fcbf42SPeter MaydellSRST 1876e2fcbf42SPeter Maydell``-usb`` 1877e2fcbf42SPeter Maydell Enable USB emulation on machine types with an on-board USB host 1878e2fcbf42SPeter Maydell controller (if not enabled by default). Note that on-board USB host 1879e2fcbf42SPeter Maydell controllers may not support USB 3.0. In this case 1880e2fcbf42SPeter Maydell ``-device qemu-xhci`` can be used instead on machines with PCI. 1881e2fcbf42SPeter MaydellERST 188210adb8beSMarkus Armbruster 188310adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 188410adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 188510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1886e2fcbf42SPeter MaydellSRST 1887e2fcbf42SPeter Maydell``-usbdevice devname`` 1888c2a34ab2SThomas Huth Add the USB device devname, and enable an on-board USB controller 1889c2a34ab2SThomas Huth if possible and necessary (just like it can be done via 1890c2a34ab2SThomas Huth ``-machine usb=on``). Note that this option is mainly intended for 1891c2a34ab2SThomas Huth the user's convenience only. More fine-grained control can be 1892c2a34ab2SThomas Huth achieved by selecting a USB host controller (if necessary) and the 1893c2a34ab2SThomas Huth desired USB device via the ``-device`` option instead. For example, 1894c2a34ab2SThomas Huth instead of using ``-usbdevice mouse`` it is possible to use 1895c2a34ab2SThomas Huth ``-device qemu-xhci -device usb-mouse`` to connect the USB mouse 1896c2a34ab2SThomas Huth to a USB 3.0 controller instead (at least on machines that support 1897c2a34ab2SThomas Huth PCI and do not have an USB controller enabled by default yet). 1898c2a34ab2SThomas Huth For more details, see the chapter about 1899923e9311SThomas Huth :ref:`Connecting USB devices` in the System Emulation Users Guide. 1900c2a34ab2SThomas Huth Possible devices for devname are: 1901c2a34ab2SThomas Huth 1902c2a34ab2SThomas Huth ``braille`` 1903c2a34ab2SThomas Huth Braille device. This will use BrlAPI to display the braille 1904c2a34ab2SThomas Huth output on a real or fake device (i.e. it also creates a 1905c2a34ab2SThomas Huth corresponding ``braille`` chardev automatically beside the 1906c2a34ab2SThomas Huth ``usb-braille`` USB device). 1907c2a34ab2SThomas Huth 1908c2a34ab2SThomas Huth ``keyboard`` 1909c2a34ab2SThomas Huth Standard USB keyboard. Will override the PS/2 keyboard (if present). 1910e2fcbf42SPeter Maydell 1911e2fcbf42SPeter Maydell ``mouse`` 1912e2fcbf42SPeter Maydell Virtual Mouse. This will override the PS/2 mouse emulation when 1913e2fcbf42SPeter Maydell activated. 1914e2fcbf42SPeter Maydell 1915e2fcbf42SPeter Maydell ``tablet`` 1916e2fcbf42SPeter Maydell Pointer device that uses absolute coordinates (like a 1917e2fcbf42SPeter Maydell touchscreen). This means QEMU is able to report the mouse 1918e2fcbf42SPeter Maydell position without having to grab the mouse. Also overrides the 1919e2fcbf42SPeter Maydell PS/2 mouse emulation when activated. 1920e2fcbf42SPeter Maydell 1921c2a34ab2SThomas Huth ``wacom-tablet`` 1922c2a34ab2SThomas Huth Wacom PenPartner USB tablet. 1923c2a34ab2SThomas Huth 1924c2a34ab2SThomas Huth 1925e2fcbf42SPeter MaydellERST 192610adb8beSMarkus Armbruster 192710adb8beSMarkus ArmbrusterDEFHEADING() 192810adb8beSMarkus Armbruster 1929de6b4f90SMarkus ArmbrusterDEFHEADING(Display options:) 19305824d651Sblueswir1 19311472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 193288b40c68SThomas Huth#if defined(CONFIG_SPICE) 1933d8aec9d9SMarc-André Lureau "-display spice-app[,gl=on|off]\n" 193488b40c68SThomas Huth#endif 193588b40c68SThomas Huth#if defined(CONFIG_SDL) 1936a743d60bSThomas Huth "-display sdl[,gl=on|core|es|off][,grab-mod=<mod>][,show-cursor=on|off]\n" 1937a743d60bSThomas Huth " [,window-close=on|off]\n" 193888b40c68SThomas Huth#endif 193988b40c68SThomas Huth#if defined(CONFIG_GTK) 194095f439bdSThomas Huth "-display gtk[,full-screen=on|off][,gl=on|off][,grab-on-hover=on|off]\n" 1941*c34a9338SFelix xq Queißner " [,show-tabs=on|off][,show-cursor=on|off][,window-close=on|off]\n" 194288b40c68SThomas Huth#endif 194388b40c68SThomas Huth#if defined(CONFIG_VNC) 1944f04ec5afSRobert Ho "-display vnc=<display>[,<optargs>]\n" 194588b40c68SThomas Huth#endif 194688b40c68SThomas Huth#if defined(CONFIG_CURSES) 19472f8b7cd5SSamuel Thibault "-display curses[,charset=<encoding>]\n" 194888b40c68SThomas Huth#endif 1949f844cdb9SGustavo Noronha Silva#if defined(CONFIG_COCOA) 19504797adceSGustavo Noronha Silva "-display cocoa[,full-grab=on|off][,swap-opt-cmd=on|off]\n" 1951f844cdb9SGustavo Noronha Silva#endif 195288b40c68SThomas Huth#if defined(CONFIG_OPENGL) 195388b40c68SThomas Huth "-display egl-headless[,rendernode=<file>]\n" 195488b40c68SThomas Huth#endif 1955142ca628SMarc-André Lureau#if defined(CONFIG_DBUS_DISPLAY) 1956142ca628SMarc-André Lureau "-display dbus[,addr=<dbusaddr>]\n" 1957142ca628SMarc-André Lureau " [,gl=on|core|es|off][,rendernode=<file>]\n" 1958142ca628SMarc-André Lureau#endif 195948941a52SCarwyn Ellis#if defined(CONFIG_COCOA) 196048941a52SCarwyn Ellis "-display cocoa[,show-cursor=on|off][,left-command-key=on|off]\n" 196148941a52SCarwyn Ellis#endif 1962144aaa99SErik Skultety "-display none\n" 196388b40c68SThomas Huth " select display backend type\n" 1964f04ec5afSRobert Ho " The default display is equivalent to\n " 1965f04ec5afSRobert Ho#if defined(CONFIG_GTK) 196688b40c68SThomas Huth "\"-display gtk\"\n" 1967f04ec5afSRobert Ho#elif defined(CONFIG_SDL) 196888b40c68SThomas Huth "\"-display sdl\"\n" 1969f04ec5afSRobert Ho#elif defined(CONFIG_COCOA) 197088b40c68SThomas Huth "\"-display cocoa\"\n" 1971f04ec5afSRobert Ho#elif defined(CONFIG_VNC) 197288b40c68SThomas Huth "\"-vnc localhost:0,to=99,id=default\"\n" 1973f04ec5afSRobert Ho#else 197488b40c68SThomas Huth "\"-display none\"\n" 1975f04ec5afSRobert Ho#endif 1976f04ec5afSRobert Ho , QEMU_ARCH_ALL) 1977e2fcbf42SPeter MaydellSRST 1978e2fcbf42SPeter Maydell``-display type`` 1979707d93d4SThomas Huth Select type of display to use. Use ``-display help`` to list the available 1980707d93d4SThomas Huth display types. Valid values for type are 1981e2fcbf42SPeter Maydell 1982ddc71758SAhmed Abouzied ``spice-app[,gl=on|off]`` 1983ddc71758SAhmed Abouzied Start QEMU as a Spice server and launch the default Spice client 1984ddc71758SAhmed Abouzied application. The Spice server will redirect the serial consoles 1985ddc71758SAhmed Abouzied and QEMU monitors. (Since 4.0) 1986ddc71758SAhmed Abouzied 1987142ca628SMarc-André Lureau ``dbus`` 1988142ca628SMarc-André Lureau Export the display over D-Bus interfaces. (Since 7.0) 1989142ca628SMarc-André Lureau 1990142ca628SMarc-André Lureau The connection is registered with the "org.qemu" name (and queued when 1991142ca628SMarc-André Lureau already owned). 1992142ca628SMarc-André Lureau 1993142ca628SMarc-André Lureau ``addr=<dbusaddr>`` : D-Bus bus address to connect to. 1994142ca628SMarc-André Lureau 199599997823SMarc-André Lureau ``p2p=yes|no`` : Use peer-to-peer connection, accepted via QMP ``add_client``. 199699997823SMarc-André Lureau 199799997823SMarc-André Lureau ``gl=on|off|core|es`` : Use OpenGL for rendering (the D-Bus interface 199899997823SMarc-André Lureau will share framebuffers with DMABUF file descriptors). 1999142ca628SMarc-André Lureau 200095f439bdSThomas Huth ``sdl`` 2001e2fcbf42SPeter Maydell Display video output via SDL (usually in a separate graphics 2002e2fcbf42SPeter Maydell window; see the SDL documentation for other possibilities). 200395f439bdSThomas Huth Valid parameters are: 2004e2fcbf42SPeter Maydell 20058e8e844bSThomas Huth ``grab-mod=<mods>`` : Used to select the modifier keys for toggling 2006450e0f28SJohn Snow the mouse grabbing in conjunction with the "g" key. ``<mods>`` can be 2007450e0f28SJohn Snow either ``lshift-lctrl-lalt`` or ``rctrl``. 20088e8e844bSThomas Huth 200995f439bdSThomas Huth ``gl=on|off|core|es`` : Use OpenGL for displaying 201095f439bdSThomas Huth 201195f439bdSThomas Huth ``show-cursor=on|off`` : Force showing the mouse cursor 201295f439bdSThomas Huth 201395f439bdSThomas Huth ``window-close=on|off`` : Allow to quit qemu with window close button 201495f439bdSThomas Huth 201595f439bdSThomas Huth ``gtk`` 2016ddc71758SAhmed Abouzied Display video output in a GTK window. This interface provides 2017ddc71758SAhmed Abouzied drop-down menus and other UI elements to configure and control 201895f439bdSThomas Huth the VM during runtime. Valid parameters are: 201995f439bdSThomas Huth 202095f439bdSThomas Huth ``full-screen=on|off`` : Start in fullscreen mode 202195f439bdSThomas Huth 202295f439bdSThomas Huth ``gl=on|off`` : Use OpenGL for displaying 202395f439bdSThomas Huth 202495f439bdSThomas Huth ``grab-on-hover=on|off`` : Grab keyboard input on mouse hover 202595f439bdSThomas Huth 2026*c34a9338SFelix xq Queißner ``show-tabs=on|off`` : Display the tab bar for switching between the 2027*c34a9338SFelix xq Queißner various graphical interfaces (e.g. VGA and 2028*c34a9338SFelix xq Queißner virtual console character devices) by default. 2029*c34a9338SFelix xq Queißner 203095f439bdSThomas Huth ``show-cursor=on|off`` : Force showing the mouse cursor 203195f439bdSThomas Huth 203295f439bdSThomas Huth ``window-close=on|off`` : Allow to quit qemu with window close button 2033ddc71758SAhmed Abouzied 2034ddc71758SAhmed Abouzied ``curses[,charset=<encoding>]`` 2035e2fcbf42SPeter Maydell Display video output via curses. For graphics device models 2036e2fcbf42SPeter Maydell which support a text mode, QEMU can display this output using a 2037e2fcbf42SPeter Maydell curses/ncurses interface. Nothing is displayed when the graphics 2038e2fcbf42SPeter Maydell device is in graphical mode or if the graphics device does not 2039e2fcbf42SPeter Maydell support a text mode. Generally only the VGA device models 2040e2fcbf42SPeter Maydell support text mode. The font charset used by the guest can be 2041e2fcbf42SPeter Maydell specified with the ``charset`` option, for example 2042e2fcbf42SPeter Maydell ``charset=CP850`` for IBM CP850 encoding. The default is 2043e2fcbf42SPeter Maydell ``CP437``. 2044e2fcbf42SPeter Maydell 204548941a52SCarwyn Ellis ``cocoa`` 204648941a52SCarwyn Ellis Display video output in a Cocoa window. Mac only. This interface 204748941a52SCarwyn Ellis provides drop-down menus and other UI elements to configure and 204848941a52SCarwyn Ellis control the VM during runtime. Valid parameters are: 204948941a52SCarwyn Ellis 205048941a52SCarwyn Ellis ``show-cursor=on|off`` : Force showing the mouse cursor 205148941a52SCarwyn Ellis 205248941a52SCarwyn Ellis ``left-command-key=on|off`` : Disable forwarding left command key to host 205348941a52SCarwyn Ellis 205495f439bdSThomas Huth ``egl-headless[,rendernode=<file>]`` 2055ddc71758SAhmed Abouzied Offload all OpenGL operations to a local DRI device. For any 2056ddc71758SAhmed Abouzied graphical display, this display needs to be paired with either 2057ddc71758SAhmed Abouzied VNC or SPICE displays. 2058ddc71758SAhmed Abouzied 205995f439bdSThomas Huth ``vnc=<display>`` 206095f439bdSThomas Huth Start a VNC server on display <display> 206195f439bdSThomas Huth 2062e2fcbf42SPeter Maydell ``none`` 2063e2fcbf42SPeter Maydell Do not display video output. The guest will still see an 2064e2fcbf42SPeter Maydell emulated graphics card, but its output will not be displayed to 2065e2fcbf42SPeter Maydell the QEMU user. This option differs from the -nographic option in 2066e2fcbf42SPeter Maydell that it only affects what is done with video output; -nographic 2067e2fcbf42SPeter Maydell also changes the destination of the serial and parallel port 2068e2fcbf42SPeter Maydell data. 2069e2fcbf42SPeter MaydellERST 20701472a95bSJes Sorensen 20715824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 2072ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 2073ad96090aSBlue Swirl QEMU_ARCH_ALL) 2074e2fcbf42SPeter MaydellSRST 2075e2fcbf42SPeter Maydell``-nographic`` 2076e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2077e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2078e2fcbf42SPeter Maydell monitor in a window. With this option, you can totally disable 2079e2fcbf42SPeter Maydell graphical output so that QEMU is a simple command line application. 2080e2fcbf42SPeter Maydell The emulated serial port is redirected on the console and muxed with 2081e2fcbf42SPeter Maydell the monitor (unless redirected elsewhere explicitly). Therefore, you 2082e2fcbf42SPeter Maydell can still use QEMU to debug a Linux kernel with a serial console. 2083e2fcbf42SPeter Maydell Use C-a h for help on switching between the console and monitor. 2084e2fcbf42SPeter MaydellERST 20855824d651Sblueswir1 20865324e3e9SMarc-André Lureau#ifdef CONFIG_SPICE 208729b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 208827af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 208927af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 209027af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 2091a9daa36aSDaniel P. Berrangé " [,x509-dh-key-file=<file>][,addr=addr]\n" 2092a9daa36aSDaniel P. Berrangé " [,ipv4=on|off][,ipv6=on|off][,unix=on|off]\n" 209327af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 209427af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 209527af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 209699522f69SDaniel P. Berrangé " [,sasl=on|off][,disable-ticketing=on|off]\n" 209799522f69SDaniel P. Berrangé " [,password=<string>][,password-secret=<secret-id>]\n" 209827af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 209927af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 210027af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 2101a9daa36aSDaniel P. Berrangé " [,streaming-video=[off|all|filter]][,disable-copy-paste=on|off]\n" 2102a9daa36aSDaniel P. Berrangé " [,disable-agent-file-xfer=on|off][,agent-mouse=[on|off]]\n" 21035ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 21047b525508SMarc-André Lureau " [,gl=[on|off]][,rendernode=<file>]\n" 210527af7788SYonit Halperin " enable spice\n" 210627af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 210727af7788SYonit Halperin QEMU_ARCH_ALL) 21085324e3e9SMarc-André Lureau#endif 2109e2fcbf42SPeter MaydellSRST 2110e2fcbf42SPeter Maydell``-spice option[,option[,...]]`` 2111e2fcbf42SPeter Maydell Enable the spice remote desktop protocol. Valid options are 2112e2fcbf42SPeter Maydell 2113e2fcbf42SPeter Maydell ``port=<nr>`` 2114e2fcbf42SPeter Maydell Set the TCP port spice is listening on for plaintext channels. 2115e2fcbf42SPeter Maydell 2116e2fcbf42SPeter Maydell ``addr=<addr>`` 2117e2fcbf42SPeter Maydell Set the IP address spice is listening on. Default is any 2118e2fcbf42SPeter Maydell address. 2119e2fcbf42SPeter Maydell 2120a9daa36aSDaniel P. Berrangé ``ipv4=on|off``; \ ``ipv6=on|off``; \ ``unix=on|off`` 2121e2fcbf42SPeter Maydell Force using the specified IP version. 2122e2fcbf42SPeter Maydell 212399522f69SDaniel P. Berrangé ``password=<string>`` 2124e2fcbf42SPeter Maydell Set the password you need to authenticate. 2125e2fcbf42SPeter Maydell 2126c47c0bcbSDaniel P. Berrangé This option is deprecated and insecure because it leaves the 2127c47c0bcbSDaniel P. Berrangé password visible in the process listing. Use ``password-secret`` 2128c47c0bcbSDaniel P. Berrangé instead. 2129c47c0bcbSDaniel P. Berrangé 213099522f69SDaniel P. Berrangé ``password-secret=<secret-id>`` 213199522f69SDaniel P. Berrangé Set the ID of the ``secret`` object containing the password 213299522f69SDaniel P. Berrangé you need to authenticate. 213399522f69SDaniel P. Berrangé 2134a9daa36aSDaniel P. Berrangé ``sasl=on|off`` 2135e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the spice. 2136e2fcbf42SPeter Maydell The exact choice of authentication method used is controlled 2137e2fcbf42SPeter Maydell from the system / user's SASL configuration file for the 'qemu' 2138e2fcbf42SPeter Maydell service. This is typically found in /etc/sasl2/qemu.conf. If 2139e2fcbf42SPeter Maydell running QEMU as an unprivileged user, an environment variable 2140e2fcbf42SPeter Maydell SASL\_CONF\_PATH can be used to make it search alternate 2141e2fcbf42SPeter Maydell locations for the service config. While some SASL auth methods 2142e2fcbf42SPeter Maydell can also provide data encryption (eg GSSAPI), it is recommended 2143e2fcbf42SPeter Maydell that SASL always be combined with the 'tls' and 'x509' settings 2144e2fcbf42SPeter Maydell to enable use of SSL and server certificates. This ensures a 2145e2fcbf42SPeter Maydell data encryption preventing compromise of authentication 2146e2fcbf42SPeter Maydell credentials. 2147e2fcbf42SPeter Maydell 2148a9daa36aSDaniel P. Berrangé ``disable-ticketing=on|off`` 2149e2fcbf42SPeter Maydell Allow client connects without authentication. 2150e2fcbf42SPeter Maydell 2151a9daa36aSDaniel P. Berrangé ``disable-copy-paste=on|off`` 2152e2fcbf42SPeter Maydell Disable copy paste between the client and the guest. 2153e2fcbf42SPeter Maydell 2154a9daa36aSDaniel P. Berrangé ``disable-agent-file-xfer=on|off`` 2155e2fcbf42SPeter Maydell Disable spice-vdagent based file-xfer between the client and the 2156e2fcbf42SPeter Maydell guest. 2157e2fcbf42SPeter Maydell 2158e2fcbf42SPeter Maydell ``tls-port=<nr>`` 2159e2fcbf42SPeter Maydell Set the TCP port spice is listening on for encrypted channels. 2160e2fcbf42SPeter Maydell 2161e2fcbf42SPeter Maydell ``x509-dir=<dir>`` 2162e2fcbf42SPeter Maydell Set the x509 file directory. Expects same filenames as -vnc 2163e2fcbf42SPeter Maydell $display,x509=$dir 2164e2fcbf42SPeter Maydell 2165e2fcbf42SPeter Maydell ``x509-key-file=<file>``; \ ``x509-key-password=<file>``; \ ``x509-cert-file=<file>``; \ ``x509-cacert-file=<file>``; \ ``x509-dh-key-file=<file>`` 2166e2fcbf42SPeter Maydell The x509 file names can also be configured individually. 2167e2fcbf42SPeter Maydell 2168e2fcbf42SPeter Maydell ``tls-ciphers=<list>`` 2169e2fcbf42SPeter Maydell Specify which ciphers to use. 2170e2fcbf42SPeter Maydell 2171e2fcbf42SPeter Maydell ``tls-channel=[main|display|cursor|inputs|record|playback]``; \ ``plaintext-channel=[main|display|cursor|inputs|record|playback]`` 2172e2fcbf42SPeter Maydell Force specific channel to be used with or without TLS 2173e2fcbf42SPeter Maydell encryption. The options can be specified multiple times to 2174e2fcbf42SPeter Maydell configure multiple channels. The special name "default" can be 2175e2fcbf42SPeter Maydell used to set the default mode. For channels which are not 2176e2fcbf42SPeter Maydell explicitly forced into one mode the spice client is allowed to 2177e2fcbf42SPeter Maydell pick tls/plaintext as he pleases. 2178e2fcbf42SPeter Maydell 2179e2fcbf42SPeter Maydell ``image-compression=[auto_glz|auto_lz|quic|glz|lz|off]`` 2180e2fcbf42SPeter Maydell Configure image compression (lossless). Default is auto\_glz. 2181e2fcbf42SPeter Maydell 2182e2fcbf42SPeter Maydell ``jpeg-wan-compression=[auto|never|always]``; \ ``zlib-glz-wan-compression=[auto|never|always]`` 2183e2fcbf42SPeter Maydell Configure wan image compression (lossy for slow links). Default 2184e2fcbf42SPeter Maydell is auto. 2185e2fcbf42SPeter Maydell 2186e2fcbf42SPeter Maydell ``streaming-video=[off|all|filter]`` 2187e2fcbf42SPeter Maydell Configure video stream detection. Default is off. 2188e2fcbf42SPeter Maydell 2189e2fcbf42SPeter Maydell ``agent-mouse=[on|off]`` 2190e2fcbf42SPeter Maydell Enable/disable passing mouse events via vdagent. Default is on. 2191e2fcbf42SPeter Maydell 2192e2fcbf42SPeter Maydell ``playback-compression=[on|off]`` 2193e2fcbf42SPeter Maydell Enable/disable audio stream compression (using celt 0.5.1). 2194e2fcbf42SPeter Maydell Default is on. 2195e2fcbf42SPeter Maydell 2196e2fcbf42SPeter Maydell ``seamless-migration=[on|off]`` 2197e2fcbf42SPeter Maydell Enable/disable spice seamless migration. Default is off. 2198e2fcbf42SPeter Maydell 2199e2fcbf42SPeter Maydell ``gl=[on|off]`` 2200e2fcbf42SPeter Maydell Enable/disable OpenGL context. Default is off. 2201e2fcbf42SPeter Maydell 2202e2fcbf42SPeter Maydell ``rendernode=<file>`` 2203e2fcbf42SPeter Maydell DRM render node for OpenGL rendering. If not specified, it will 2204e2fcbf42SPeter Maydell pick the first available. (Since 2.9) 2205e2fcbf42SPeter MaydellERST 220629b0040bSGerd Hoffmann 22075824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 2208ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 2209ad96090aSBlue Swirl QEMU_ARCH_ALL) 2210e2fcbf42SPeter MaydellSRST 2211e2fcbf42SPeter Maydell``-portrait`` 2212e2fcbf42SPeter Maydell Rotate graphical output 90 deg left (only PXA LCD). 2213e2fcbf42SPeter MaydellERST 22145824d651Sblueswir1 22159312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 22169312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 22179312805dSVasily Khoruzhick QEMU_ARCH_ALL) 2218e2fcbf42SPeter MaydellSRST 2219e2fcbf42SPeter Maydell``-rotate deg`` 2220e2fcbf42SPeter Maydell Rotate graphical output some deg left (only PXA LCD). 2221e2fcbf42SPeter MaydellERST 22229312805dSVasily Khoruzhick 22235824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 2224a94f0c5cSGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 2225ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 2226e2fcbf42SPeter MaydellSRST 2227e2fcbf42SPeter Maydell``-vga type`` 2228e2fcbf42SPeter Maydell Select type of VGA card to emulate. Valid values for type are 2229e2fcbf42SPeter Maydell 2230e2fcbf42SPeter Maydell ``cirrus`` 2231e2fcbf42SPeter Maydell Cirrus Logic GD5446 Video card. All Windows versions starting 2232e2fcbf42SPeter Maydell from Windows 95 should recognize and use this graphic card. For 2233e2fcbf42SPeter Maydell optimal performances, use 16 bit color depth in the guest and 2234e2fcbf42SPeter Maydell the host OS. (This card was the default before QEMU 2.2) 2235e2fcbf42SPeter Maydell 2236e2fcbf42SPeter Maydell ``std`` 2237e2fcbf42SPeter Maydell Standard VGA card with Bochs VBE extensions. If your guest OS 2238e2fcbf42SPeter Maydell supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if 2239e2fcbf42SPeter Maydell you want to use high resolution modes (>= 1280x1024x16) then you 2240e2fcbf42SPeter Maydell should use this option. (This card is the default since QEMU 2241e2fcbf42SPeter Maydell 2.2) 2242e2fcbf42SPeter Maydell 2243e2fcbf42SPeter Maydell ``vmware`` 2244e2fcbf42SPeter Maydell VMWare SVGA-II compatible adapter. Use it if you have 2245e2fcbf42SPeter Maydell sufficiently recent XFree86/XOrg server or Windows guest with a 2246e2fcbf42SPeter Maydell driver for this card. 2247e2fcbf42SPeter Maydell 2248e2fcbf42SPeter Maydell ``qxl`` 2249e2fcbf42SPeter Maydell QXL paravirtual graphic card. It is VGA compatible (including 2250e2fcbf42SPeter Maydell VESA 2.0 VBE support). Works best with qxl guest drivers 2251e2fcbf42SPeter Maydell installed though. Recommended choice when using the spice 2252e2fcbf42SPeter Maydell protocol. 2253e2fcbf42SPeter Maydell 2254e2fcbf42SPeter Maydell ``tcx`` 2255e2fcbf42SPeter Maydell (sun4m only) Sun TCX framebuffer. This is the default 2256e2fcbf42SPeter Maydell framebuffer for sun4m machines and offers both 8-bit and 24-bit 2257e2fcbf42SPeter Maydell colour depths at a fixed resolution of 1024x768. 2258e2fcbf42SPeter Maydell 2259e2fcbf42SPeter Maydell ``cg3`` 2260e2fcbf42SPeter Maydell (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit 2261e2fcbf42SPeter Maydell framebuffer for sun4m machines available in both 1024x768 2262e2fcbf42SPeter Maydell (OpenBIOS) and 1152x900 (OBP) resolutions aimed at people 2263e2fcbf42SPeter Maydell wishing to run older Solaris versions. 2264e2fcbf42SPeter Maydell 2265e2fcbf42SPeter Maydell ``virtio`` 2266e2fcbf42SPeter Maydell Virtio VGA card. 2267e2fcbf42SPeter Maydell 2268e2fcbf42SPeter Maydell ``none`` 2269e2fcbf42SPeter Maydell Disable VGA card. 2270e2fcbf42SPeter MaydellERST 22715824d651Sblueswir1 22725824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 2273ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 2274e2fcbf42SPeter MaydellSRST 2275e2fcbf42SPeter Maydell``-full-screen`` 2276e2fcbf42SPeter Maydell Start in full screen. 2277e2fcbf42SPeter MaydellERST 22785824d651Sblueswir1 227960f9a4efSJohn SnowDEF("g", HAS_ARG, QEMU_OPTION_g , 2280ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 22818ac919a0SLaurent Vivier QEMU_ARCH_PPC | QEMU_ARCH_SPARC | QEMU_ARCH_M68K) 2282e2fcbf42SPeter MaydellSRST 228309ce5f2dSPeter Maydell``-g`` *width*\ ``x``\ *height*\ ``[x``\ *depth*\ ``]`` 2284e2fcbf42SPeter Maydell Set the initial graphical resolution and depth (PPC, SPARC only). 2285e2fcbf42SPeter Maydell 2286e2fcbf42SPeter Maydell For PPC the default is 800x600x32. 2287e2fcbf42SPeter Maydell 2288e2fcbf42SPeter Maydell For SPARC with the TCX graphics device, the default is 1024x768x8 2289e2fcbf42SPeter Maydell with the option of 1024x768x24. For cgthree, the default is 2290e2fcbf42SPeter Maydell 1024x768x8 with the option of 1152x900x8 for people who wish to use 2291e2fcbf42SPeter Maydell OBP. 2292e2fcbf42SPeter MaydellERST 22935824d651Sblueswir1 22945824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 2295f04ec5afSRobert Ho "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL) 2296e2fcbf42SPeter MaydellSRST 2297e2fcbf42SPeter Maydell``-vnc display[,option[,option[,...]]]`` 2298e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2299e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2300e2fcbf42SPeter Maydell monitor in a window. With this option, you can have QEMU listen on 2301e2fcbf42SPeter Maydell VNC display display and redirect the VGA display over the VNC 2302e2fcbf42SPeter Maydell session. It is very useful to enable the usb tablet device when 2303e2fcbf42SPeter Maydell using this option (option ``-device usb-tablet``). When using the 2304e2fcbf42SPeter Maydell VNC display, you must use the ``-k`` parameter to set the keyboard 2305e2fcbf42SPeter Maydell layout if you are not using en-us. Valid syntax for the display is 2306e2fcbf42SPeter Maydell 2307e2fcbf42SPeter Maydell ``to=L`` 2308e2fcbf42SPeter Maydell With this option, QEMU will try next available VNC displays, 2309e2fcbf42SPeter Maydell until the number L, if the origianlly defined "-vnc display" is 2310e2fcbf42SPeter Maydell not available, e.g. port 5900+display is already used by another 2311e2fcbf42SPeter Maydell application. By default, to=0. 2312e2fcbf42SPeter Maydell 2313e2fcbf42SPeter Maydell ``host:d`` 2314e2fcbf42SPeter Maydell TCP connections will only be allowed from host on display d. By 2315e2fcbf42SPeter Maydell convention the TCP port is 5900+d. Optionally, host can be 2316e2fcbf42SPeter Maydell omitted in which case the server will accept connections from 2317e2fcbf42SPeter Maydell any host. 2318e2fcbf42SPeter Maydell 2319e2fcbf42SPeter Maydell ``unix:path`` 2320e2fcbf42SPeter Maydell Connections will be allowed over UNIX domain sockets where path 2321e2fcbf42SPeter Maydell is the location of a unix socket to listen for connections on. 2322e2fcbf42SPeter Maydell 2323e2fcbf42SPeter Maydell ``none`` 2324e2fcbf42SPeter Maydell VNC is initialized but not started. The monitor ``change`` 2325e2fcbf42SPeter Maydell command can be used to later start the VNC server. 2326e2fcbf42SPeter Maydell 2327e2fcbf42SPeter Maydell Following the display value there may be one or more option flags 2328e2fcbf42SPeter Maydell separated by commas. Valid options are 2329e2fcbf42SPeter Maydell 233082a17d1dSDaniel P. Berrangé ``reverse=on|off`` 2331e2fcbf42SPeter Maydell Connect to a listening VNC client via a "reverse" connection. 2332e2fcbf42SPeter Maydell The client is specified by the display. For reverse network 2333e2fcbf42SPeter Maydell connections (host:d,``reverse``), the d argument is a TCP port 2334e2fcbf42SPeter Maydell number, not a display number. 2335e2fcbf42SPeter Maydell 233682a17d1dSDaniel P. Berrangé ``websocket=on|off`` 2337e2fcbf42SPeter Maydell Opens an additional TCP listening port dedicated to VNC 2338e2fcbf42SPeter Maydell Websocket connections. If a bare websocket option is given, the 2339e2fcbf42SPeter Maydell Websocket port is 5700+display. An alternative port can be 2340e2fcbf42SPeter Maydell specified with the syntax ``websocket``\ =port. 2341e2fcbf42SPeter Maydell 2342e2fcbf42SPeter Maydell If host is specified connections will only be allowed from this 2343e2fcbf42SPeter Maydell host. It is possible to control the websocket listen address 2344e2fcbf42SPeter Maydell independently, using the syntax ``websocket``\ =host:port. 2345e2fcbf42SPeter Maydell 2346e2fcbf42SPeter Maydell If no TLS credentials are provided, the websocket connection 2347e2fcbf42SPeter Maydell runs in unencrypted mode. If TLS credentials are provided, the 2348e2fcbf42SPeter Maydell websocket connection requires encrypted client connections. 2349e2fcbf42SPeter Maydell 235082a17d1dSDaniel P. Berrangé ``password=on|off`` 2351e2fcbf42SPeter Maydell Require that password based authentication is used for client 2352e2fcbf42SPeter Maydell connections. 2353e2fcbf42SPeter Maydell 2354e2fcbf42SPeter Maydell The password must be set separately using the ``set_password`` 2355923e9311SThomas Huth command in the :ref:`QEMU monitor`. The 2356e2fcbf42SPeter Maydell syntax to change your password is: 2357e2fcbf42SPeter Maydell ``set_password <protocol> <password>`` where <protocol> could be 2358e2fcbf42SPeter Maydell either "vnc" or "spice". 2359e2fcbf42SPeter Maydell 2360e2fcbf42SPeter Maydell If you would like to change <protocol> password expiration, you 2361e2fcbf42SPeter Maydell should use ``expire_password <protocol> <expiration-time>`` 2362e2fcbf42SPeter Maydell where expiration time could be one of the following options: 2363e2fcbf42SPeter Maydell now, never, +seconds or UNIX time of expiration, e.g. +60 to 2364e2fcbf42SPeter Maydell make password expire in 60 seconds, or 1335196800 to make 2365e2fcbf42SPeter Maydell password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for 2366e2fcbf42SPeter Maydell this date and time). 2367e2fcbf42SPeter Maydell 2368e2fcbf42SPeter Maydell You can also use keywords "now" or "never" for the expiration 2369e2fcbf42SPeter Maydell time to allow <protocol> password to expire immediately or never 2370e2fcbf42SPeter Maydell expire. 2371e2fcbf42SPeter Maydell 23726c6840e9SDaniel P. Berrangé ``password-secret=<secret-id>`` 23736c6840e9SDaniel P. Berrangé Require that password based authentication is used for client 23746c6840e9SDaniel P. Berrangé connections, using the password provided by the ``secret`` 23756c6840e9SDaniel P. Berrangé object identified by ``secret-id``. 23766c6840e9SDaniel P. Berrangé 2377e2fcbf42SPeter Maydell ``tls-creds=ID`` 2378e2fcbf42SPeter Maydell Provides the ID of a set of TLS credentials to use to secure the 2379e2fcbf42SPeter Maydell VNC server. They will apply to both the normal VNC server socket 2380e2fcbf42SPeter Maydell and the websocket socket (if enabled). Setting TLS credentials 2381e2fcbf42SPeter Maydell will cause the VNC server socket to enable the VeNCrypt auth 2382e2fcbf42SPeter Maydell mechanism. The credentials should have been previously created 2383e2fcbf42SPeter Maydell using the ``-object tls-creds`` argument. 2384e2fcbf42SPeter Maydell 2385e2fcbf42SPeter Maydell ``tls-authz=ID`` 2386e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2387e2fcbf42SPeter Maydell the client's x509 distinguished name will validated. This object 2388e2fcbf42SPeter Maydell is only resolved at time of use, so can be deleted and recreated 2389e2fcbf42SPeter Maydell on the fly while the VNC server is active. If missing, it will 2390e2fcbf42SPeter Maydell default to denying access. 2391e2fcbf42SPeter Maydell 239282a17d1dSDaniel P. Berrangé ``sasl=on|off`` 2393e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the VNC 2394e2fcbf42SPeter Maydell server. The exact choice of authentication method used is 2395e2fcbf42SPeter Maydell controlled from the system / user's SASL configuration file for 2396e2fcbf42SPeter Maydell the 'qemu' service. This is typically found in 2397e2fcbf42SPeter Maydell /etc/sasl2/qemu.conf. If running QEMU as an unprivileged user, 2398e2fcbf42SPeter Maydell an environment variable SASL\_CONF\_PATH can be used to make it 2399e2fcbf42SPeter Maydell search alternate locations for the service config. While some 2400e2fcbf42SPeter Maydell SASL auth methods can also provide data encryption (eg GSSAPI), 2401e2fcbf42SPeter Maydell it is recommended that SASL always be combined with the 'tls' 2402e2fcbf42SPeter Maydell and 'x509' settings to enable use of SSL and server 2403e2fcbf42SPeter Maydell certificates. This ensures a data encryption preventing 2404e2fcbf42SPeter Maydell compromise of authentication credentials. See the 2405923e9311SThomas Huth :ref:`VNC security` section in the System Emulation Users Guide 2406923e9311SThomas Huth for details on using SASL authentication. 2407e2fcbf42SPeter Maydell 2408e2fcbf42SPeter Maydell ``sasl-authz=ID`` 2409e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2410e2fcbf42SPeter Maydell the client's SASL username will validated. This object is only 2411e2fcbf42SPeter Maydell resolved at time of use, so can be deleted and recreated on the 2412e2fcbf42SPeter Maydell fly while the VNC server is active. If missing, it will default 2413e2fcbf42SPeter Maydell to denying access. 2414e2fcbf42SPeter Maydell 241582a17d1dSDaniel P. Berrangé ``acl=on|off`` 2416e2fcbf42SPeter Maydell Legacy method for enabling authorization of clients against the 2417e2fcbf42SPeter Maydell x509 distinguished name and SASL username. It results in the 2418e2fcbf42SPeter Maydell creation of two ``authz-list`` objects with IDs of 2419e2fcbf42SPeter Maydell ``vnc.username`` and ``vnc.x509dname``. The rules for these 2420e2fcbf42SPeter Maydell objects must be configured with the HMP ACL commands. 2421e2fcbf42SPeter Maydell 2422e2fcbf42SPeter Maydell This option is deprecated and should no longer be used. The new 2423e2fcbf42SPeter Maydell ``sasl-authz`` and ``tls-authz`` options are a replacement. 2424e2fcbf42SPeter Maydell 242582a17d1dSDaniel P. Berrangé ``lossy=on|off`` 2426e2fcbf42SPeter Maydell Enable lossy compression methods (gradient, JPEG, ...). If this 2427e2fcbf42SPeter Maydell option is set, VNC client may receive lossy framebuffer updates 2428e2fcbf42SPeter Maydell depending on its encoding settings. Enabling this option can 2429e2fcbf42SPeter Maydell save a lot of bandwidth at the expense of quality. 2430e2fcbf42SPeter Maydell 243182a17d1dSDaniel P. Berrangé ``non-adaptive=on|off`` 2432e2fcbf42SPeter Maydell Disable adaptive encodings. Adaptive encodings are enabled by 2433e2fcbf42SPeter Maydell default. An adaptive encoding will try to detect frequently 2434e2fcbf42SPeter Maydell updated screen regions, and send updates in these regions using 2435e2fcbf42SPeter Maydell a lossy encoding (like JPEG). This can be really helpful to save 2436e2fcbf42SPeter Maydell bandwidth when playing videos. Disabling adaptive encodings 2437e2fcbf42SPeter Maydell restores the original static behavior of encodings like Tight. 2438e2fcbf42SPeter Maydell 2439e2fcbf42SPeter Maydell ``share=[allow-exclusive|force-shared|ignore]`` 2440e2fcbf42SPeter Maydell Set display sharing policy. 'allow-exclusive' allows clients to 2441e2fcbf42SPeter Maydell ask for exclusive access. As suggested by the rfb spec this is 2442e2fcbf42SPeter Maydell implemented by dropping other connections. Connecting multiple 2443e2fcbf42SPeter Maydell clients in parallel requires all clients asking for a shared 2444e2fcbf42SPeter Maydell session (vncviewer: -shared switch). This is the default. 2445e2fcbf42SPeter Maydell 'force-shared' disables exclusive client access. Useful for 2446e2fcbf42SPeter Maydell shared desktop sessions, where you don't want someone forgetting 2447e2fcbf42SPeter Maydell specify -shared disconnect everybody else. 'ignore' completely 2448e2fcbf42SPeter Maydell ignores the shared flag and allows everybody connect 2449e2fcbf42SPeter Maydell unconditionally. Doesn't conform to the rfb spec but is 2450e2fcbf42SPeter Maydell traditional QEMU behavior. 2451e2fcbf42SPeter Maydell 2452e2fcbf42SPeter Maydell ``key-delay-ms`` 2453e2fcbf42SPeter Maydell Set keyboard delay, for key down and key up events, in 2454e2fcbf42SPeter Maydell milliseconds. Default is 10. Keyboards are low-bandwidth 2455e2fcbf42SPeter Maydell devices, so this slowdown can help the device and guest to keep 2456e2fcbf42SPeter Maydell up and not lose events in case events are arriving in bulk. 2457e2fcbf42SPeter Maydell Possible causes for the latter are flaky network connections, or 2458e2fcbf42SPeter Maydell scripts for automated testing. 2459e2fcbf42SPeter Maydell 2460e2fcbf42SPeter Maydell ``audiodev=audiodev`` 2461e2fcbf42SPeter Maydell Use the specified audiodev when the VNC client requests audio 2462e2fcbf42SPeter Maydell transmission. When not using an -audiodev argument, this option 2463e2fcbf42SPeter Maydell must be omitted, otherwise is must be present and specify a 2464e2fcbf42SPeter Maydell valid audiodev. 24657b5fa0b5SDaniel P. Berrangé 246682a17d1dSDaniel P. Berrangé ``power-control=on|off`` 24677b5fa0b5SDaniel P. Berrangé Permit the remote client to issue shutdown, reboot or reset power 24687b5fa0b5SDaniel P. Berrangé control requests. 2469e2fcbf42SPeter MaydellERST 24705824d651Sblueswir1 2471a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 24725824d651Sblueswir1 2473de6b4f90SMarkus ArmbrusterARCHHEADING(i386 target only:, QEMU_ARCH_I386) 24745824d651Sblueswir1 24755824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 2476ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 2477ad96090aSBlue Swirl QEMU_ARCH_I386) 2478e2fcbf42SPeter MaydellSRST 2479e2fcbf42SPeter Maydell``-win2k-hack`` 2480e2fcbf42SPeter Maydell Use it when installing Windows 2000 to avoid a disk full bug. After 2481e2fcbf42SPeter Maydell Windows 2000 is installed, you no longer need this option (this 2482e2fcbf42SPeter Maydell option slows down the IDE transfers). 2483e2fcbf42SPeter MaydellERST 24845824d651Sblueswir1 24855824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 2486ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 2487ad96090aSBlue Swirl QEMU_ARCH_I386) 2488e2fcbf42SPeter MaydellSRST 2489e2fcbf42SPeter Maydell``-no-fd-bootchk`` 2490e2fcbf42SPeter Maydell Disable boot signature checking for floppy disks in BIOS. May be 2491e2fcbf42SPeter Maydell needed to boot from old floppy disks. 2492e2fcbf42SPeter MaydellERST 24935824d651Sblueswir1 24945824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 2495f5d8c8cdSShannon Zhao "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2496e2fcbf42SPeter MaydellSRST 2497e2fcbf42SPeter Maydell``-no-acpi`` 2498e2fcbf42SPeter Maydell Disable ACPI (Advanced Configuration and Power Interface) support. 2499e2fcbf42SPeter Maydell Use it if your guest OS complains about ACPI problems (PC target 2500e2fcbf42SPeter Maydell machine only). 2501e2fcbf42SPeter MaydellERST 25025824d651Sblueswir1 25035824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 2504ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 2505e2fcbf42SPeter MaydellSRST 2506e2fcbf42SPeter Maydell``-no-hpet`` 2507e2fcbf42SPeter Maydell Disable HPET support. 2508e2fcbf42SPeter MaydellERST 25095824d651Sblueswir1 25105824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 2511104bf02eSMichael 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" 2512ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 2513e2fcbf42SPeter MaydellSRST 2514e2fcbf42SPeter 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]...]`` 2515e2fcbf42SPeter Maydell Add ACPI table with specified header fields and context from 2516e2fcbf42SPeter Maydell specified files. For file=, take whole ACPI table from the specified 2517e2fcbf42SPeter Maydell files, including all ACPI headers (possible overridden by other 2518e2fcbf42SPeter Maydell options). For data=, only data portion of the table is used, all 2519e2fcbf42SPeter Maydell header information is specified in the command line. If a SLIC table 2520e2fcbf42SPeter Maydell is supplied to QEMU, then the SLIC's oem\_id and oem\_table\_id 2521e2fcbf42SPeter Maydell fields will override the same in the RSDT and the FADT (a.k.a. 2522e2fcbf42SPeter Maydell FACP), in order to ensure the field matches required by the 2523e2fcbf42SPeter Maydell Microsoft SLIC spec and the ACPI spec. 2524e2fcbf42SPeter MaydellERST 25255824d651Sblueswir1 2526b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 2527b6f6e3d3Saliguori "-smbios file=binary\n" 2528ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 2529b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 2530b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 2531ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 2532b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2533b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 2534b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 2535b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2536b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 2537b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 2538b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 2539b155eb1dSGabriel L. Somlo " [,sku=str]\n" 2540b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 2541b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 2542c906e039SYing Fang " [,asset=str][,part=str][,max-speed=%d][,current-speed=%d]\n" 2543cb5fb04fSPatrick Venture " [,processor-id=%d]\n" 2544b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 254548a7ff4dSDaniel P. Berrangé "-smbios type=11[,value=str][,path=filename]\n" 254648a7ff4dSDaniel P. Berrangé " specify SMBIOS type 11 fields\n" 2547b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 25483ebd6cc8SGabriel L. Somlo " [,asset=str][,part=str][,speed=%d]\n" 254905dfb447SVincent Bernat " specify SMBIOS type 17 fields\n" 255005dfb447SVincent Bernat "-smbios type=41[,designation=str][,kind=str][,instance=%d][,pcidev=str]\n" 255105dfb447SVincent Bernat " specify SMBIOS type 41 fields\n", 2552c30e1565SWei Huang QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2553e2fcbf42SPeter MaydellSRST 2554e2fcbf42SPeter Maydell``-smbios file=binary`` 2555e2fcbf42SPeter Maydell Load SMBIOS entry from binary file. 2556e2fcbf42SPeter Maydell 2557e2fcbf42SPeter Maydell``-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]`` 2558e2fcbf42SPeter Maydell Specify SMBIOS type 0 fields 2559e2fcbf42SPeter Maydell 2560e2fcbf42SPeter Maydell``-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str]`` 2561e2fcbf42SPeter Maydell Specify SMBIOS type 1 fields 2562e2fcbf42SPeter Maydell 2563e2fcbf42SPeter Maydell``-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str][,asset=str][,location=str]`` 2564e2fcbf42SPeter Maydell Specify SMBIOS type 2 fields 2565e2fcbf42SPeter Maydell 2566e2fcbf42SPeter Maydell``-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str][,sku=str]`` 2567e2fcbf42SPeter Maydell Specify SMBIOS type 3 fields 2568e2fcbf42SPeter Maydell 2569cb5fb04fSPatrick Venture``-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str][,asset=str][,part=str][,processor-id=%d]`` 2570e2fcbf42SPeter Maydell Specify SMBIOS type 4 fields 2571e2fcbf42SPeter Maydell 257248a7ff4dSDaniel P. Berrangé``-smbios type=11[,value=str][,path=filename]`` 257348a7ff4dSDaniel P. Berrangé Specify SMBIOS type 11 fields 257448a7ff4dSDaniel P. Berrangé 257548a7ff4dSDaniel P. Berrangé This argument can be repeated multiple times, and values are added in the order they are parsed. 257648a7ff4dSDaniel P. Berrangé Applications intending to use OEM strings data are encouraged to use their application name as 257748a7ff4dSDaniel P. Berrangé a prefix for the value string. This facilitates passing information for multiple applications 257848a7ff4dSDaniel P. Berrangé concurrently. 257948a7ff4dSDaniel P. Berrangé 258048a7ff4dSDaniel P. Berrangé The ``value=str`` syntax provides the string data inline, while the ``path=filename`` syntax 258148a7ff4dSDaniel P. Berrangé loads data from a file on disk. Note that the file is not permitted to contain any NUL bytes. 258248a7ff4dSDaniel P. Berrangé 258348a7ff4dSDaniel P. Berrangé Both the ``value`` and ``path`` options can be repeated multiple times and will be added to 258448a7ff4dSDaniel P. Berrangé the SMBIOS table in the order in which they appear. 258548a7ff4dSDaniel P. Berrangé 258648a7ff4dSDaniel P. Berrangé Note that on the x86 architecture, the total size of all SMBIOS tables is limited to 65535 258748a7ff4dSDaniel P. Berrangé bytes. Thus the OEM strings data is not suitable for passing large amounts of data into the 258848a7ff4dSDaniel P. Berrangé guest. Instead it should be used as a indicator to inform the guest where to locate the real 258948a7ff4dSDaniel P. Berrangé data set, for example, by specifying the serial ID of a block device. 259048a7ff4dSDaniel P. Berrangé 259148a7ff4dSDaniel P. Berrangé An example passing three strings is 259248a7ff4dSDaniel P. Berrangé 259348a7ff4dSDaniel P. Berrangé .. parsed-literal:: 259448a7ff4dSDaniel P. Berrangé 259548a7ff4dSDaniel P. Berrangé -smbios type=11,value=cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/,\\ 259648a7ff4dSDaniel P. Berrangé value=anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os,\\ 259748a7ff4dSDaniel P. Berrangé path=/some/file/with/oemstringsdata.txt 259848a7ff4dSDaniel P. Berrangé 259948a7ff4dSDaniel P. Berrangé In the guest OS this is visible with the ``dmidecode`` command 260048a7ff4dSDaniel P. Berrangé 260148a7ff4dSDaniel P. Berrangé .. parsed-literal:: 260248a7ff4dSDaniel P. Berrangé 260348a7ff4dSDaniel P. Berrangé $ dmidecode -t 11 260448a7ff4dSDaniel P. Berrangé Handle 0x0E00, DMI type 11, 5 bytes 260548a7ff4dSDaniel P. Berrangé OEM Strings 260648a7ff4dSDaniel P. Berrangé String 1: cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/ 260748a7ff4dSDaniel P. Berrangé String 2: anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os 260848a7ff4dSDaniel P. Berrangé String 3: myapp:some extra data 260948a7ff4dSDaniel P. Berrangé 261048a7ff4dSDaniel P. Berrangé 2611e2fcbf42SPeter Maydell``-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str][,asset=str][,part=str][,speed=%d]`` 2612e2fcbf42SPeter Maydell Specify SMBIOS type 17 fields 261305dfb447SVincent Bernat 261405dfb447SVincent Bernat``-smbios type=41[,designation=str][,kind=str][,instance=%d][,pcidev=str]`` 261505dfb447SVincent Bernat Specify SMBIOS type 41 fields 261605dfb447SVincent Bernat 261705dfb447SVincent Bernat This argument can be repeated multiple times. Its main use is to allow network interfaces be created 261805dfb447SVincent Bernat as ``enoX`` on Linux, with X being the instance number, instead of the name depending on the interface 261905dfb447SVincent Bernat position on the PCI bus. 262005dfb447SVincent Bernat 262105dfb447SVincent Bernat Here is an example of use: 262205dfb447SVincent Bernat 262305dfb447SVincent Bernat .. parsed-literal:: 262405dfb447SVincent Bernat 262505dfb447SVincent Bernat -netdev user,id=internet \\ 262605dfb447SVincent Bernat -device virtio-net-pci,mac=50:54:00:00:00:42,netdev=internet,id=internet-dev \\ 262705dfb447SVincent Bernat -smbios type=41,designation='Onboard LAN',instance=1,kind=ethernet,pcidev=internet-dev 262805dfb447SVincent Bernat 262905dfb447SVincent Bernat In the guest OS, the device should then appear as ``eno1``: 263005dfb447SVincent Bernat 263105dfb447SVincent Bernat ..parsed-literal:: 263205dfb447SVincent Bernat 263305dfb447SVincent Bernat $ ip -brief l 263405dfb447SVincent Bernat lo UNKNOWN 00:00:00:00:00:00 <LOOPBACK,UP,LOWER_UP> 263505dfb447SVincent Bernat eno1 UP 50:54:00:00:00:42 <BROADCAST,MULTICAST,UP,LOWER_UP> 263605dfb447SVincent Bernat 263705dfb447SVincent Bernat Currently, the PCI device has to be attached to the root bus. 263805dfb447SVincent Bernat 2639e2fcbf42SPeter MaydellERST 2640b6f6e3d3Saliguori 2641c70a01e4SMarkus ArmbrusterDEFHEADING() 26425824d651Sblueswir1 2643de6b4f90SMarkus ArmbrusterDEFHEADING(Network options:) 26445824d651Sblueswir1 26456a8b4a5bSThomas HuthDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 26465824d651Sblueswir1#ifdef CONFIG_SLIRP 26478b0dc246SDaniel P. Berrangé "-netdev user,id=str[,ipv4=on|off][,net=addr[/mask]][,host=addr]\n" 26488b0dc246SDaniel P. Berrangé " [,ipv6=on|off][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 26490b11c036SSamuel Thibault " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 2650f18d1375SBenjamin Drung " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n" 26510fca92b9SFam Zheng " [,tftp=dir][,tftp-server-name=name][,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 2652ad196a9dSJan Kiszka#ifndef _WIN32 2653c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 2654ad196a9dSJan Kiszka#endif 26556a8b4a5bSThomas Huth " configure a user mode network backend with ID 'str',\n" 26566a8b4a5bSThomas Huth " its DHCP server and optional services\n" 26575824d651Sblueswir1#endif 26585824d651Sblueswir1#ifdef _WIN32 26596a8b4a5bSThomas Huth "-netdev tap,id=str,ifname=name\n" 26606a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 26615824d651Sblueswir1#else 26626a8b4a5bSThomas Huth "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 2663584613eaSAlexey Kardashevskiy " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 26646a8b4a5bSThomas Huth " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 266569e87b32SJason Wang " [,poll-us=n]\n" 26666a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 2667584613eaSAlexey Kardashevskiy " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 2668a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 2669a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 2670a7c36ee4SCorey Bryant " to deconfigure it\n" 2671ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 2672a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 2673a7c36ee4SCorey Bryant " configure it\n" 26745824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 26752ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 2676ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 2677f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 2678ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 2679ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 268082b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 26815430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 26825430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 268382b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 26842ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 2685ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 2686cba42d61SMichael Tokarev " use 'poll-us=n' to specify the maximum number of microseconds that could be\n" 268769e87b32SJason Wang " spent on busy polling for vhost net\n" 26886a8b4a5bSThomas Huth "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 26896a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str' that is\n" 26906a8b4a5bSThomas Huth " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 26916a8b4a5bSThomas Huth " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 26920df0ff6dSMark McLoughlin#endif 26933fb69aa1SAnton Ivanov#ifdef __linux__ 26946a8b4a5bSThomas Huth "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 26958b0dc246SDaniel P. Berrangé " [,rxsession=rxsession],txsession=txsession[,ipv6=on|off][,udp=on|off]\n" 26968b0dc246SDaniel P. Berrangé " [,cookie64=on|off][,counter][,pincounter][,txcookie=txcookie]\n" 26976a8b4a5bSThomas Huth " [,rxcookie=rxcookie][,offset=offset]\n" 26986a8b4a5bSThomas Huth " configure a network backend with ID 'str' connected to\n" 26996a8b4a5bSThomas Huth " an Ethernet over L2TPv3 pseudowire.\n" 27003fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 27012f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 27023fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 270321843dc4SStefan Hajnoczi " standard (RFC3931). Note - this implementation uses static\n" 27043fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 27053fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 27063fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 27073fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 27083952651aSGonglei " use 'srcport=' to specify source udp port\n" 27093fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 27103fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 27113fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 27123fb69aa1SAnton Ivanov " well as a weak security measure\n" 27133fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 27143fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 27153fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 27163fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 27173fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 27183fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 27193fb69aa1SAnton Ivanov#endif 27206a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 27216a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 27226a8b4a5bSThomas Huth " using a socket connection\n" 27236a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 27246a8b4a5bSThomas Huth " configure a network backend to connect to a multicast maddr and port\n" 27253a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 27266a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 27276a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 27286a8b4a5bSThomas Huth " using an UDP tunnel\n" 27295824d651Sblueswir1#ifdef CONFIG_VDE 27306a8b4a5bSThomas Huth "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 27316a8b4a5bSThomas Huth " configure a network backend to connect to port 'n' of a vde switch\n" 27326a8b4a5bSThomas Huth " running on host and listening for incoming connections on 'socketpath'.\n" 27335824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 27345824d651Sblueswir1 " ownership and permissions for communication port.\n" 27355824d651Sblueswir1#endif 273658952137SVincenzo Maffione#ifdef CONFIG_NETMAP 27376a8b4a5bSThomas Huth "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 273858952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 273958952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 274058952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 274158952137SVincenzo Maffione#endif 2742253dc14cSThomas Huth#ifdef CONFIG_POSIX 27436a8b4a5bSThomas Huth "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 27446a8b4a5bSThomas Huth " configure a vhost-user network, backed by a chardev 'dev'\n" 2745253dc14cSThomas Huth#endif 2746108a6481SCindy Lu#ifdef __linux__ 2747108a6481SCindy Lu "-netdev vhost-vdpa,id=str,vhostdev=/path/to/dev\n" 2748108a6481SCindy Lu " configure a vhost-vdpa network,Establish a vhost-vdpa netdev\n" 2749108a6481SCindy Lu#endif 2750b0290db1SVladislav Yaroshchuk#ifdef CONFIG_VMNET 2751b0290db1SVladislav Yaroshchuk "-netdev vmnet-host,id=str[,isolated=on|off][,net-uuid=uuid]\n" 2752b0290db1SVladislav Yaroshchuk " [,start-address=addr,end-address=addr,subnet-mask=mask]\n" 2753b0290db1SVladislav Yaroshchuk " configure a vmnet network backend in host mode with ID 'str',\n" 2754b0290db1SVladislav Yaroshchuk " isolate this interface from others with 'isolated',\n" 2755b0290db1SVladislav Yaroshchuk " configure the address range and choose a subnet mask,\n" 2756b0290db1SVladislav Yaroshchuk " specify network UUID 'uuid' to disable DHCP and interact with\n" 2757b0290db1SVladislav Yaroshchuk " vmnet-host interfaces within this isolated network\n" 2758b0290db1SVladislav Yaroshchuk "-netdev vmnet-shared,id=str[,isolated=on|off][,nat66-prefix=addr]\n" 2759b0290db1SVladislav Yaroshchuk " [,start-address=addr,end-address=addr,subnet-mask=mask]\n" 2760b0290db1SVladislav Yaroshchuk " configure a vmnet network backend in shared mode with ID 'str',\n" 2761b0290db1SVladislav Yaroshchuk " configure the address range and choose a subnet mask,\n" 2762b0290db1SVladislav Yaroshchuk " set IPv6 ULA prefix (of length 64) to use for internal network,\n" 2763b0290db1SVladislav Yaroshchuk " isolate this interface from others with 'isolated'\n" 2764b0290db1SVladislav Yaroshchuk "-netdev vmnet-bridged,id=str,ifname=name[,isolated=on|off]\n" 2765b0290db1SVladislav Yaroshchuk " configure a vmnet network backend in bridged mode with ID 'str',\n" 2766b0290db1SVladislav Yaroshchuk " use 'ifname=name' to select a physical network interface to be bridged,\n" 2767b0290db1SVladislav Yaroshchuk " isolate this interface from others with 'isolated'\n" 2768b0290db1SVladislav Yaroshchuk#endif 276918d65d22SThomas Huth "-netdev hubport,id=str,hubid=n[,netdev=nd]\n" 2770af1a5c3eSThomas Huth " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL) 277178cd6f7bSThomas HuthDEF("nic", HAS_ARG, QEMU_OPTION_nic, 2772dfaa7d50SBALATON Zoltan "-nic [tap|bridge|" 277378cd6f7bSThomas Huth#ifdef CONFIG_SLIRP 277478cd6f7bSThomas Huth "user|" 277578cd6f7bSThomas Huth#endif 277678cd6f7bSThomas Huth#ifdef __linux__ 277778cd6f7bSThomas Huth "l2tpv3|" 277878cd6f7bSThomas Huth#endif 277978cd6f7bSThomas Huth#ifdef CONFIG_VDE 278078cd6f7bSThomas Huth "vde|" 278178cd6f7bSThomas Huth#endif 278278cd6f7bSThomas Huth#ifdef CONFIG_NETMAP 278378cd6f7bSThomas Huth "netmap|" 278478cd6f7bSThomas Huth#endif 278578cd6f7bSThomas Huth#ifdef CONFIG_POSIX 278678cd6f7bSThomas Huth "vhost-user|" 278778cd6f7bSThomas Huth#endif 2788b0290db1SVladislav Yaroshchuk#ifdef CONFIG_VMNET 2789b0290db1SVladislav Yaroshchuk "vmnet-host|vmnet-shared|vmnet-bridged|" 2790b0290db1SVladislav Yaroshchuk#endif 279178cd6f7bSThomas Huth "socket][,option][,...][mac=macaddr]\n" 279278cd6f7bSThomas Huth " initialize an on-board / default host NIC (using MAC address\n" 279378cd6f7bSThomas Huth " macaddr) and connect it to the given host network backend\n" 2794dfaa7d50SBALATON Zoltan "-nic none use it alone to have zero network devices (the default is to\n" 279578cd6f7bSThomas Huth " provided a 'user' network connection)\n", 279678cd6f7bSThomas Huth QEMU_ARCH_ALL) 27976a8b4a5bSThomas HuthDEF("net", HAS_ARG, QEMU_OPTION_net, 2798af1a5c3eSThomas Huth "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 27990e60a82dSThomas Huth " configure or create an on-board (or machine default) NIC and\n" 2800af1a5c3eSThomas Huth " connect it to hub 0 (please use -nic unless you need a hub)\n" 28016a8b4a5bSThomas Huth "-net [" 2802a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 2803a1ea458fSMark McLoughlin "user|" 2804a1ea458fSMark McLoughlin#endif 2805a1ea458fSMark McLoughlin "tap|" 2806a7c36ee4SCorey Bryant "bridge|" 2807a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 2808a1ea458fSMark McLoughlin "vde|" 2809a1ea458fSMark McLoughlin#endif 281058952137SVincenzo Maffione#ifdef CONFIG_NETMAP 281158952137SVincenzo Maffione "netmap|" 281258952137SVincenzo Maffione#endif 2813b0290db1SVladislav Yaroshchuk#ifdef CONFIG_VMNET 2814b0290db1SVladislav Yaroshchuk "vmnet-host|vmnet-shared|vmnet-bridged|" 2815b0290db1SVladislav Yaroshchuk#endif 2816af1a5c3eSThomas Huth "socket][,option][,option][,...]\n" 28176a8b4a5bSThomas Huth " old way to initialize a host network interface\n" 28186a8b4a5bSThomas Huth " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 2819e2fcbf42SPeter MaydellSRST 2820e2fcbf42SPeter Maydell``-nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]`` 2821e2fcbf42SPeter Maydell This option is a shortcut for configuring both the on-board 2822e2fcbf42SPeter Maydell (default) guest NIC hardware and the host network backend in one go. 2823e2fcbf42SPeter Maydell The host backend options are the same as with the corresponding 2824e2fcbf42SPeter Maydell ``-netdev`` options below. The guest NIC model can be set with 2825e2fcbf42SPeter Maydell ``model=modelname``. Use ``model=help`` to list the available device 2826e2fcbf42SPeter Maydell types. The hardware MAC address can be set with ``mac=macaddr``. 2827e2fcbf42SPeter Maydell 2828e2fcbf42SPeter Maydell The following two example do exactly the same, to show how ``-nic`` 2829e2fcbf42SPeter Maydell can be used to shorten the command line length: 2830e2fcbf42SPeter Maydell 2831e2fcbf42SPeter Maydell .. parsed-literal:: 2832e2fcbf42SPeter Maydell 2833e2fcbf42SPeter Maydell |qemu_system| -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32 2834e2fcbf42SPeter Maydell |qemu_system| -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32 2835e2fcbf42SPeter Maydell 2836e2fcbf42SPeter Maydell``-nic none`` 2837e2fcbf42SPeter Maydell Indicate that no network devices should be configured. It is used to 2838e2fcbf42SPeter Maydell override the default configuration (default NIC with "user" host 2839e2fcbf42SPeter Maydell network backend) which is activated if no other networking options 2840e2fcbf42SPeter Maydell are provided. 2841e2fcbf42SPeter Maydell 2842e2fcbf42SPeter Maydell``-netdev user,id=id[,option][,option][,...]`` 2843e2fcbf42SPeter Maydell Configure user mode host network backend which requires no 2844e2fcbf42SPeter Maydell administrator privilege to run. Valid options are: 2845e2fcbf42SPeter Maydell 2846e2fcbf42SPeter Maydell ``id=id`` 2847e2fcbf42SPeter Maydell Assign symbolic name for use in monitor commands. 2848e2fcbf42SPeter Maydell 2849e2fcbf42SPeter Maydell ``ipv4=on|off and ipv6=on|off`` 2850e2fcbf42SPeter Maydell Specify that either IPv4 or IPv6 must be enabled. If neither is 2851e2fcbf42SPeter Maydell specified both protocols are enabled. 2852e2fcbf42SPeter Maydell 2853e2fcbf42SPeter Maydell ``net=addr[/mask]`` 2854e2fcbf42SPeter Maydell Set IP network address the guest will see. Optionally specify 2855e2fcbf42SPeter Maydell the netmask, either in the form a.b.c.d or as number of valid 2856e2fcbf42SPeter Maydell top-most bits. Default is 10.0.2.0/24. 2857e2fcbf42SPeter Maydell 2858e2fcbf42SPeter Maydell ``host=addr`` 2859e2fcbf42SPeter Maydell Specify the guest-visible address of the host. Default is the 2860e2fcbf42SPeter Maydell 2nd IP in the guest network, i.e. x.x.x.2. 2861e2fcbf42SPeter Maydell 2862e2fcbf42SPeter Maydell ``ipv6-net=addr[/int]`` 2863e2fcbf42SPeter Maydell Set IPv6 network address the guest will see (default is 2864e2fcbf42SPeter Maydell fec0::/64). The network prefix is given in the usual hexadecimal 2865e2fcbf42SPeter Maydell IPv6 address notation. The prefix size is optional, and is given 2866e2fcbf42SPeter Maydell as the number of valid top-most bits (default is 64). 2867e2fcbf42SPeter Maydell 2868e2fcbf42SPeter Maydell ``ipv6-host=addr`` 2869e2fcbf42SPeter Maydell Specify the guest-visible IPv6 address of the host. Default is 2870e2fcbf42SPeter Maydell the 2nd IPv6 in the guest network, i.e. xxxx::2. 2871e2fcbf42SPeter Maydell 2872e2fcbf42SPeter Maydell ``restrict=on|off`` 2873e2fcbf42SPeter Maydell If this option is enabled, the guest will be isolated, i.e. it 2874e2fcbf42SPeter Maydell will not be able to contact the host and no guest IP packets 2875e2fcbf42SPeter Maydell will be routed over the host to the outside. This option does 2876e2fcbf42SPeter Maydell not affect any explicitly set forwarding rules. 2877e2fcbf42SPeter Maydell 2878e2fcbf42SPeter Maydell ``hostname=name`` 2879e2fcbf42SPeter Maydell Specifies the client hostname reported by the built-in DHCP 2880e2fcbf42SPeter Maydell server. 2881e2fcbf42SPeter Maydell 2882e2fcbf42SPeter Maydell ``dhcpstart=addr`` 2883e2fcbf42SPeter Maydell Specify the first of the 16 IPs the built-in DHCP server can 2884e2fcbf42SPeter Maydell assign. Default is the 15th to 31st IP in the guest network, 2885e2fcbf42SPeter Maydell i.e. x.x.x.15 to x.x.x.31. 2886e2fcbf42SPeter Maydell 2887e2fcbf42SPeter Maydell ``dns=addr`` 2888e2fcbf42SPeter Maydell Specify the guest-visible address of the virtual nameserver. The 2889e2fcbf42SPeter Maydell address must be different from the host address. Default is the 2890e2fcbf42SPeter Maydell 3rd IP in the guest network, i.e. x.x.x.3. 2891e2fcbf42SPeter Maydell 2892e2fcbf42SPeter Maydell ``ipv6-dns=addr`` 2893e2fcbf42SPeter Maydell Specify the guest-visible address of the IPv6 virtual 2894e2fcbf42SPeter Maydell nameserver. The address must be different from the host address. 2895e2fcbf42SPeter Maydell Default is the 3rd IP in the guest network, i.e. xxxx::3. 2896e2fcbf42SPeter Maydell 2897e2fcbf42SPeter Maydell ``dnssearch=domain`` 2898e2fcbf42SPeter Maydell Provides an entry for the domain-search list sent by the 2899e2fcbf42SPeter Maydell built-in DHCP server. More than one domain suffix can be 2900e2fcbf42SPeter Maydell transmitted by specifying this option multiple times. If 2901e2fcbf42SPeter Maydell supported, this will cause the guest to automatically try to 2902e2fcbf42SPeter Maydell append the given domain suffix(es) in case a domain name can not 2903e2fcbf42SPeter Maydell be resolved. 2904e2fcbf42SPeter Maydell 2905e2fcbf42SPeter Maydell Example: 2906e2fcbf42SPeter Maydell 2907e2fcbf42SPeter Maydell .. parsed-literal:: 2908e2fcbf42SPeter Maydell 2909e2fcbf42SPeter Maydell |qemu_system| -nic user,dnssearch=mgmt.example.org,dnssearch=example.org 2910e2fcbf42SPeter Maydell 2911e2fcbf42SPeter Maydell ``domainname=domain`` 2912e2fcbf42SPeter Maydell Specifies the client domain name reported by the built-in DHCP 2913e2fcbf42SPeter Maydell server. 2914e2fcbf42SPeter Maydell 2915e2fcbf42SPeter Maydell ``tftp=dir`` 2916e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in TFTP 2917e2fcbf42SPeter Maydell server. The files in dir will be exposed as the root of a TFTP 2918e2fcbf42SPeter Maydell server. The TFTP client on the guest must be configured in 2919e2fcbf42SPeter Maydell binary mode (use the command ``bin`` of the Unix TFTP client). 2920e2fcbf42SPeter Maydell 2921e2fcbf42SPeter Maydell ``tftp-server-name=name`` 2922e2fcbf42SPeter Maydell In BOOTP reply, broadcast name as the "TFTP server name" 2923e2fcbf42SPeter Maydell (RFC2132 option 66). This can be used to advise the guest to 2924e2fcbf42SPeter Maydell load boot files or configurations from a different server than 2925e2fcbf42SPeter Maydell the host address. 2926e2fcbf42SPeter Maydell 2927e2fcbf42SPeter Maydell ``bootfile=file`` 2928e2fcbf42SPeter Maydell When using the user mode network stack, broadcast file as the 2929e2fcbf42SPeter Maydell BOOTP filename. In conjunction with ``tftp``, this can be used 2930e2fcbf42SPeter Maydell to network boot a guest from a local directory. 2931e2fcbf42SPeter Maydell 2932e2fcbf42SPeter Maydell Example (using pxelinux): 2933e2fcbf42SPeter Maydell 2934e2fcbf42SPeter Maydell .. parsed-literal:: 2935e2fcbf42SPeter Maydell 2936353a06b4SLaszlo Ersek |qemu_system| -hda linux.img -boot n -device e1000,netdev=n1 \\ 2937e2fcbf42SPeter Maydell -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 2938e2fcbf42SPeter Maydell 2939e2fcbf42SPeter Maydell ``smb=dir[,smbserver=addr]`` 2940e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in SMB 2941e2fcbf42SPeter Maydell server so that Windows OSes can access to the host files in 2942e2fcbf42SPeter Maydell ``dir`` transparently. The IP address of the SMB server can be 2943e2fcbf42SPeter Maydell set to addr. By default the 4th IP in the guest network is used, 2944e2fcbf42SPeter Maydell i.e. x.x.x.4. 2945e2fcbf42SPeter Maydell 2946e2fcbf42SPeter Maydell In the guest Windows OS, the line: 2947e2fcbf42SPeter Maydell 2948e2fcbf42SPeter Maydell :: 2949e2fcbf42SPeter Maydell 2950e2fcbf42SPeter Maydell 10.0.2.4 smbserver 2951e2fcbf42SPeter Maydell 2952e2fcbf42SPeter Maydell must be added in the file ``C:\WINDOWS\LMHOSTS`` (for windows 2953e2fcbf42SPeter Maydell 9x/Me) or ``C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS`` (Windows 2954e2fcbf42SPeter Maydell NT/2000). 2955e2fcbf42SPeter Maydell 2956e2fcbf42SPeter Maydell Then ``dir`` can be accessed in ``\\smbserver\qemu``. 2957e2fcbf42SPeter Maydell 2958e2fcbf42SPeter Maydell Note that a SAMBA server must be installed on the host OS. 2959e2fcbf42SPeter Maydell 2960e2fcbf42SPeter Maydell ``hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport`` 2961e2fcbf42SPeter Maydell Redirect incoming TCP or UDP connections to the host port 2962e2fcbf42SPeter Maydell hostport to the guest IP address guestaddr on guest port 2963e2fcbf42SPeter Maydell guestport. If guestaddr is not specified, its value is x.x.x.15 2964e2fcbf42SPeter Maydell (default first address given by the built-in DHCP server). By 2965e2fcbf42SPeter Maydell specifying hostaddr, the rule can be bound to a specific host 2966e2fcbf42SPeter Maydell interface. If no connection type is set, TCP is used. This 2967e2fcbf42SPeter Maydell option can be given multiple times. 2968e2fcbf42SPeter Maydell 2969e2fcbf42SPeter Maydell For example, to redirect host X11 connection from screen 1 to 2970e2fcbf42SPeter Maydell guest screen 0, use the following: 2971e2fcbf42SPeter Maydell 297209ce5f2dSPeter Maydell .. parsed-literal:: 2973e2fcbf42SPeter Maydell 2974e2fcbf42SPeter Maydell # on the host 2975e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp:127.0.0.1:6001-:6000 2976e2fcbf42SPeter Maydell # this host xterm should open in the guest X11 server 2977e2fcbf42SPeter Maydell xterm -display :1 2978e2fcbf42SPeter Maydell 2979e2fcbf42SPeter Maydell To redirect telnet connections from host port 5555 to telnet 2980e2fcbf42SPeter Maydell port on the guest, use the following: 2981e2fcbf42SPeter Maydell 298209ce5f2dSPeter Maydell .. parsed-literal:: 2983e2fcbf42SPeter Maydell 2984e2fcbf42SPeter Maydell # on the host 2985e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp::5555-:23 2986e2fcbf42SPeter Maydell telnet localhost 5555 2987e2fcbf42SPeter Maydell 2988e2fcbf42SPeter Maydell Then when you use on the host ``telnet localhost 5555``, you 2989e2fcbf42SPeter Maydell connect to the guest telnet server. 2990e2fcbf42SPeter Maydell 2991e2fcbf42SPeter Maydell ``guestfwd=[tcp]:server:port-dev``; \ ``guestfwd=[tcp]:server:port-cmd:command`` 2992e2fcbf42SPeter Maydell Forward guest TCP connections to the IP address server on port 2993e2fcbf42SPeter Maydell port to the character device dev or to a program executed by 2994e2fcbf42SPeter Maydell cmd:command which gets spawned for each connection. This option 2995e2fcbf42SPeter Maydell can be given multiple times. 2996e2fcbf42SPeter Maydell 2997e2fcbf42SPeter Maydell You can either use a chardev directly and have that one used 2998e2fcbf42SPeter Maydell throughout QEMU's lifetime, like in the following example: 2999e2fcbf42SPeter Maydell 300009ce5f2dSPeter Maydell .. parsed-literal:: 3001e2fcbf42SPeter Maydell 3002e2fcbf42SPeter Maydell # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 3003e2fcbf42SPeter Maydell # the guest accesses it 3004e2fcbf42SPeter Maydell |qemu_system| -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 3005e2fcbf42SPeter Maydell 3006e2fcbf42SPeter Maydell Or you can execute a command on every TCP connection established 3007e2fcbf42SPeter Maydell by the guest, so that QEMU behaves similar to an inetd process 3008e2fcbf42SPeter Maydell for that virtual server: 3009e2fcbf42SPeter Maydell 301009ce5f2dSPeter Maydell .. parsed-literal:: 3011e2fcbf42SPeter Maydell 3012e2fcbf42SPeter Maydell # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 3013e2fcbf42SPeter Maydell # and connect the TCP stream to its stdin/stdout 3014e2fcbf42SPeter Maydell |qemu_system| -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 3015e2fcbf42SPeter Maydell 3016e2fcbf42SPeter Maydell``-netdev tap,id=id[,fd=h][,ifname=name][,script=file][,downscript=dfile][,br=bridge][,helper=helper]`` 3017e2fcbf42SPeter Maydell Configure a host TAP network backend with ID id. 3018e2fcbf42SPeter Maydell 3019e2fcbf42SPeter Maydell Use the network script file to configure it and the network script 3020e2fcbf42SPeter Maydell dfile to deconfigure it. If name is not provided, the OS 3021e2fcbf42SPeter Maydell automatically provides one. The default network configure script is 3022e2fcbf42SPeter Maydell ``/etc/qemu-ifup`` and the default network deconfigure script is 3023e2fcbf42SPeter Maydell ``/etc/qemu-ifdown``. Use ``script=no`` or ``downscript=no`` to 3024e2fcbf42SPeter Maydell disable script execution. 3025e2fcbf42SPeter Maydell 3026e2fcbf42SPeter Maydell If running QEMU as an unprivileged user, use the network helper 30278d73ec89STianjia Zhang to configure the TAP interface and attach it to the bridge. 3028e2fcbf42SPeter Maydell The default network helper executable is 3029e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 3030e2fcbf42SPeter Maydell ``br0``. 3031e2fcbf42SPeter Maydell 3032e2fcbf42SPeter Maydell ``fd``\ =h can be used to specify the handle of an already opened 3033e2fcbf42SPeter Maydell host TAP interface. 3034e2fcbf42SPeter Maydell 3035e2fcbf42SPeter Maydell Examples: 3036e2fcbf42SPeter Maydell 303709ce5f2dSPeter Maydell .. parsed-literal:: 3038e2fcbf42SPeter Maydell 3039e2fcbf42SPeter Maydell #launch a QEMU instance with the default network script 3040e2fcbf42SPeter Maydell |qemu_system| linux.img -nic tap 3041e2fcbf42SPeter Maydell 304209ce5f2dSPeter Maydell .. parsed-literal:: 3043e2fcbf42SPeter Maydell 3044e2fcbf42SPeter Maydell #launch a QEMU instance with two NICs, each one connected 3045e2fcbf42SPeter Maydell #to a TAP device 3046353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3047353a06b4SLaszlo Ersek -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \\ 3048e2fcbf42SPeter Maydell -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1 3049e2fcbf42SPeter Maydell 305009ce5f2dSPeter Maydell .. parsed-literal:: 3051e2fcbf42SPeter Maydell 3052e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3053e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 3054353a06b4SLaszlo Ersek |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \\ 3055e2fcbf42SPeter Maydell -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper" 3056e2fcbf42SPeter Maydell 3057e2fcbf42SPeter Maydell``-netdev bridge,id=id[,br=bridge][,helper=helper]`` 3058e2fcbf42SPeter Maydell Connect a host TAP network interface to a host bridge device. 3059e2fcbf42SPeter Maydell 3060e2fcbf42SPeter Maydell Use the network helper helper to configure the TAP interface and 3061e2fcbf42SPeter Maydell attach it to the bridge. The default network helper executable is 3062e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 3063e2fcbf42SPeter Maydell ``br0``. 3064e2fcbf42SPeter Maydell 3065e2fcbf42SPeter Maydell Examples: 3066e2fcbf42SPeter Maydell 306709ce5f2dSPeter Maydell .. parsed-literal:: 3068e2fcbf42SPeter Maydell 3069e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3070e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 3071e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1 3072e2fcbf42SPeter Maydell 307309ce5f2dSPeter Maydell .. parsed-literal:: 3074e2fcbf42SPeter Maydell 3075e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3076e2fcbf42SPeter Maydell #connect a TAP device to bridge qemubr0 3077e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1 3078e2fcbf42SPeter Maydell 3079e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,listen=[host]:port][,connect=host:port]`` 3080e2fcbf42SPeter Maydell This host network backend can be used to connect the guest's network 3081e2fcbf42SPeter Maydell to another QEMU virtual machine using a TCP socket connection. If 3082e2fcbf42SPeter Maydell ``listen`` is specified, QEMU waits for incoming connections on port 3083e2fcbf42SPeter Maydell (host is optional). ``connect`` is used to connect to another QEMU 3084e2fcbf42SPeter Maydell instance using the ``listen`` option. ``fd``\ =h specifies an 3085e2fcbf42SPeter Maydell already opened TCP socket. 3086e2fcbf42SPeter Maydell 3087e2fcbf42SPeter Maydell Example: 3088e2fcbf42SPeter Maydell 308909ce5f2dSPeter Maydell .. parsed-literal:: 3090e2fcbf42SPeter Maydell 3091e2fcbf42SPeter Maydell # launch a first QEMU instance 3092353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3093353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3094e2fcbf42SPeter Maydell -netdev socket,id=n1,listen=:1234 3095e2fcbf42SPeter Maydell # connect the network of this instance to the network of the first instance 3096353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3097353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 3098e2fcbf42SPeter Maydell -netdev socket,id=n2,connect=127.0.0.1:1234 3099e2fcbf42SPeter Maydell 3100e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,mcast=maddr:port[,localaddr=addr]]`` 3101e2fcbf42SPeter Maydell Configure a socket host network backend to share the guest's network 3102e2fcbf42SPeter Maydell traffic with another QEMU virtual machines using a UDP multicast 3103e2fcbf42SPeter Maydell socket, effectively making a bus for every QEMU with same multicast 3104e2fcbf42SPeter Maydell address maddr and port. NOTES: 3105e2fcbf42SPeter Maydell 3106e2fcbf42SPeter Maydell 1. Several QEMU can be running on different hosts and share same bus 3107e2fcbf42SPeter Maydell (assuming correct multicast setup for these hosts). 3108e2fcbf42SPeter Maydell 3109e2fcbf42SPeter Maydell 2. mcast support is compatible with User Mode Linux (argument 3110e2fcbf42SPeter Maydell ``ethN=mcast``), see http://user-mode-linux.sf.net. 3111e2fcbf42SPeter Maydell 3112e2fcbf42SPeter Maydell 3. Use ``fd=h`` to specify an already opened UDP multicast socket. 3113e2fcbf42SPeter Maydell 3114e2fcbf42SPeter Maydell Example: 3115e2fcbf42SPeter Maydell 311609ce5f2dSPeter Maydell .. parsed-literal:: 3117e2fcbf42SPeter Maydell 3118e2fcbf42SPeter Maydell # launch one QEMU instance 3119353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3120353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3121e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=230.0.0.1:1234 3122e2fcbf42SPeter Maydell # launch another QEMU instance on same "bus" 3123353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3124353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 3125e2fcbf42SPeter Maydell -netdev socket,id=n2,mcast=230.0.0.1:1234 3126e2fcbf42SPeter Maydell # launch yet another QEMU instance on same "bus" 3127353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3128353a06b4SLaszlo Ersek -device e1000,netdev=n3,mac=52:54:00:12:34:58 \\ 3129e2fcbf42SPeter Maydell -netdev socket,id=n3,mcast=230.0.0.1:1234 3130e2fcbf42SPeter Maydell 3131e2fcbf42SPeter Maydell Example (User Mode Linux compat.): 3132e2fcbf42SPeter Maydell 313309ce5f2dSPeter Maydell .. parsed-literal:: 3134e2fcbf42SPeter Maydell 3135e2fcbf42SPeter Maydell # launch QEMU instance (note mcast address selected is UML's default) 3136353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3137353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3138e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102 3139e2fcbf42SPeter Maydell # launch UML 3140e2fcbf42SPeter Maydell /path/to/linux ubd0=/path/to/root_fs eth0=mcast 3141e2fcbf42SPeter Maydell 3142e2fcbf42SPeter Maydell Example (send packets from host's 1.2.3.4): 3143e2fcbf42SPeter Maydell 3144e2fcbf42SPeter Maydell .. parsed-literal:: 3145e2fcbf42SPeter Maydell 3146353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3147353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3148e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 3149e2fcbf42SPeter Maydell 31508b0dc246SDaniel 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]`` 3151e2fcbf42SPeter Maydell Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931) 3152e2fcbf42SPeter Maydell is a popular protocol to transport Ethernet (and other Layer 2) data 3153e2fcbf42SPeter Maydell frames between two systems. It is present in routers, firewalls and 3154e2fcbf42SPeter Maydell the Linux kernel (from version 3.3 onwards). 3155e2fcbf42SPeter Maydell 3156e2fcbf42SPeter Maydell This transport allows a VM to communicate to another VM, router or 3157e2fcbf42SPeter Maydell firewall directly. 3158e2fcbf42SPeter Maydell 3159e2fcbf42SPeter Maydell ``src=srcaddr`` 3160e2fcbf42SPeter Maydell source address (mandatory) 3161e2fcbf42SPeter Maydell 3162e2fcbf42SPeter Maydell ``dst=dstaddr`` 3163e2fcbf42SPeter Maydell destination address (mandatory) 3164e2fcbf42SPeter Maydell 3165e2fcbf42SPeter Maydell ``udp`` 3166e2fcbf42SPeter Maydell select udp encapsulation (default is ip). 3167e2fcbf42SPeter Maydell 3168e2fcbf42SPeter Maydell ``srcport=srcport`` 3169e2fcbf42SPeter Maydell source udp port. 3170e2fcbf42SPeter Maydell 3171e2fcbf42SPeter Maydell ``dstport=dstport`` 3172e2fcbf42SPeter Maydell destination udp port. 3173e2fcbf42SPeter Maydell 3174e2fcbf42SPeter Maydell ``ipv6`` 3175e2fcbf42SPeter Maydell force v6, otherwise defaults to v4. 3176e2fcbf42SPeter Maydell 3177e2fcbf42SPeter Maydell ``rxcookie=rxcookie``; \ ``txcookie=txcookie`` 3178e2fcbf42SPeter Maydell Cookies are a weak form of security in the l2tpv3 specification. 3179e2fcbf42SPeter Maydell Their function is mostly to prevent misconfiguration. By default 3180e2fcbf42SPeter Maydell they are 32 bit. 3181e2fcbf42SPeter Maydell 3182e2fcbf42SPeter Maydell ``cookie64`` 3183e2fcbf42SPeter Maydell Set cookie size to 64 bit instead of the default 32 3184e2fcbf42SPeter Maydell 3185e2fcbf42SPeter Maydell ``counter=off`` 3186e2fcbf42SPeter Maydell Force a 'cut-down' L2TPv3 with no counter as in 3187e2fcbf42SPeter Maydell draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 3188e2fcbf42SPeter Maydell 3189e2fcbf42SPeter Maydell ``pincounter=on`` 3190e2fcbf42SPeter Maydell Work around broken counter handling in peer. This may also help 3191e2fcbf42SPeter Maydell on networks which have packet reorder. 3192e2fcbf42SPeter Maydell 3193e2fcbf42SPeter Maydell ``offset=offset`` 3194e2fcbf42SPeter Maydell Add an extra offset between header and data 3195e2fcbf42SPeter Maydell 3196e2fcbf42SPeter Maydell For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to 3197e2fcbf42SPeter Maydell the bridge br-lan on the remote Linux host 1.2.3.4: 3198e2fcbf42SPeter Maydell 319909ce5f2dSPeter Maydell .. parsed-literal:: 3200e2fcbf42SPeter Maydell 3201e2fcbf42SPeter Maydell # Setup tunnel on linux host using raw ip as encapsulation 3202e2fcbf42SPeter Maydell # on 1.2.3.4 3203353a06b4SLaszlo Ersek ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \\ 3204e2fcbf42SPeter Maydell encap udp udp_sport 16384 udp_dport 16384 3205353a06b4SLaszlo Ersek ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \\ 3206e2fcbf42SPeter Maydell 0xFFFFFFFF peer_session_id 0xFFFFFFFF 3207e2fcbf42SPeter Maydell ifconfig vmtunnel0 mtu 1500 3208e2fcbf42SPeter Maydell ifconfig vmtunnel0 up 3209e2fcbf42SPeter Maydell brctl addif br-lan vmtunnel0 3210e2fcbf42SPeter Maydell 3211e2fcbf42SPeter Maydell 3212e2fcbf42SPeter Maydell # on 4.3.2.1 3213e2fcbf42SPeter Maydell # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 3214e2fcbf42SPeter Maydell 3215353a06b4SLaszlo Ersek |qemu_system| linux.img -device e1000,netdev=n1 \\ 3216e2fcbf42SPeter 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 3217e2fcbf42SPeter Maydell 3218e2fcbf42SPeter Maydell``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]`` 3219e2fcbf42SPeter Maydell Configure VDE backend to connect to PORT n of a vde switch running 3220e2fcbf42SPeter Maydell on host and listening for incoming connections on socketpath. Use 3221e2fcbf42SPeter Maydell GROUP groupname and MODE octalmode to change default ownership and 3222e2fcbf42SPeter Maydell permissions for communication port. This option is only available if 3223e2fcbf42SPeter Maydell QEMU has been compiled with vde support enabled. 3224e2fcbf42SPeter Maydell 3225e2fcbf42SPeter Maydell Example: 3226e2fcbf42SPeter Maydell 322709ce5f2dSPeter Maydell .. parsed-literal:: 3228e2fcbf42SPeter Maydell 3229e2fcbf42SPeter Maydell # launch vde switch 3230e2fcbf42SPeter Maydell vde_switch -F -sock /tmp/myswitch 3231e2fcbf42SPeter Maydell # launch QEMU instance 3232e2fcbf42SPeter Maydell |qemu_system| linux.img -nic vde,sock=/tmp/myswitch 3233e2fcbf42SPeter Maydell 3234e2fcbf42SPeter Maydell``-netdev vhost-user,chardev=id[,vhostforce=on|off][,queues=n]`` 3235e2fcbf42SPeter Maydell Establish a vhost-user netdev, backed by a chardev id. The chardev 3236e2fcbf42SPeter Maydell should be a unix domain socket backed one. The vhost-user uses a 3237e2fcbf42SPeter Maydell specifically defined protocol to pass vhost ioctl replacement 3238e2fcbf42SPeter Maydell messages to an application on the other end of the socket. On 3239e2fcbf42SPeter Maydell non-MSIX guests, the feature can be forced with vhostforce. Use 3240e2fcbf42SPeter Maydell 'queues=n' to specify the number of queues to be created for 3241e2fcbf42SPeter Maydell multiqueue vhost-user. 3242e2fcbf42SPeter Maydell 3243e2fcbf42SPeter Maydell Example: 3244e2fcbf42SPeter Maydell 3245e2fcbf42SPeter Maydell :: 3246e2fcbf42SPeter Maydell 3247e2fcbf42SPeter Maydell qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 3248e2fcbf42SPeter Maydell -numa node,memdev=mem \ 3249e2fcbf42SPeter Maydell -chardev socket,id=chr0,path=/path/to/socket \ 3250e2fcbf42SPeter Maydell -netdev type=vhost-user,id=net0,chardev=chr0 \ 3251e2fcbf42SPeter Maydell -device virtio-net-pci,netdev=net0 3252e2fcbf42SPeter Maydell 3253108a6481SCindy Lu``-netdev vhost-vdpa,vhostdev=/path/to/dev`` 3254108a6481SCindy Lu Establish a vhost-vdpa netdev. 3255108a6481SCindy Lu 3256108a6481SCindy Lu vDPA device is a device that uses a datapath which complies with 3257108a6481SCindy Lu the virtio specifications with a vendor specific control path. 3258108a6481SCindy Lu vDPA devices can be both physically located on the hardware or 3259108a6481SCindy Lu emulated by software. 3260108a6481SCindy Lu 3261e2fcbf42SPeter Maydell``-netdev hubport,id=id,hubid=hubid[,netdev=nd]`` 3262e2fcbf42SPeter Maydell Create a hub port on the emulated hub with ID hubid. 3263e2fcbf42SPeter Maydell 3264e2fcbf42SPeter Maydell The hubport netdev lets you connect a NIC to a QEMU emulated hub 3265e2fcbf42SPeter Maydell instead of a single netdev. Alternatively, you can also connect the 3266e2fcbf42SPeter Maydell hubport to another netdev with ID nd by using the ``netdev=nd`` 3267e2fcbf42SPeter Maydell option. 3268e2fcbf42SPeter Maydell 3269e2fcbf42SPeter Maydell``-net nic[,netdev=nd][,macaddr=mac][,model=type] [,name=name][,addr=addr][,vectors=v]`` 3270e2fcbf42SPeter Maydell Legacy option to configure or create an on-board (or machine 3271e2fcbf42SPeter Maydell default) Network Interface Card(NIC) and connect it either to the 3272e2fcbf42SPeter Maydell emulated hub with ID 0 (i.e. the default hub), or to the netdev nd. 3273e2fcbf42SPeter Maydell If model is omitted, then the default NIC model associated with the 3274e2fcbf42SPeter Maydell machine type is used. Note that the default NIC model may change in 3275e2fcbf42SPeter Maydell future QEMU releases, so it is highly recommended to always specify 3276e2fcbf42SPeter Maydell a model. Optionally, the MAC address can be changed to mac, the 3277e2fcbf42SPeter Maydell device address set to addr (PCI cards only), and a name can be 3278e2fcbf42SPeter Maydell assigned for use in monitor commands. Optionally, for PCI cards, you 3279e2fcbf42SPeter Maydell can specify the number v of MSI-X vectors that the card should have; 3280e2fcbf42SPeter Maydell this option currently only affects virtio cards; set v = 0 to 3281e2fcbf42SPeter Maydell disable MSI-X. If no ``-net`` option is specified, a single NIC is 3282e2fcbf42SPeter Maydell created. QEMU can emulate several different models of network card. 3283e2fcbf42SPeter Maydell Use ``-net nic,model=help`` for a list of available devices for your 3284e2fcbf42SPeter Maydell target. 3285e2fcbf42SPeter Maydell 3286e2fcbf42SPeter Maydell``-net user|tap|bridge|socket|l2tpv3|vde[,...][,name=name]`` 3287e2fcbf42SPeter Maydell Configure a host network backend (with the options corresponding to 3288e2fcbf42SPeter Maydell the same ``-netdev`` option) and connect it to the emulated hub 0 3289e2fcbf42SPeter Maydell (the default hub). Use name to specify the name of the hub port. 3290e2fcbf42SPeter MaydellERST 32915824d651Sblueswir1 32927273a2dbSMatthew BoothDEFHEADING() 32937273a2dbSMatthew Booth 3294de6b4f90SMarkus ArmbrusterDEFHEADING(Character device options:) 32957273a2dbSMatthew Booth 32967273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 3297517b3d40SLin Ma "-chardev help\n" 3298d0d7708bSDaniel P. Berrange "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3299ba858d1fSMarkus Armbruster "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]\n" 3300bfdc1267SDaniel P. Berrangé " [,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds][,mux=on|off]\n" 3301fd4a5fd4SDaniel P. Berrange " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n" 3302bfdc1267SDaniel P. Berrangé "-chardev socket,id=id,path=path[,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds]\n" 3303e339273bSxiaoqiang zhao " [,mux=on|off][,logfile=PATH][,logappend=on|off][,abstract=on|off][,tight=on|off] (unix)\n" 33047273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 3305bfdc1267SDaniel P. Berrangé " [,localport=localport][,ipv4=on|off][,ipv6=on|off][,mux=on|off]\n" 3306d0d7708bSDaniel P. Berrange " [,logfile=PATH][,logappend=on|off]\n" 3307d0d7708bSDaniel P. Berrange "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33087273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 3309d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3310d0d7708bSDaniel P. Berrange "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 3311d0d7708bSDaniel P. Berrange "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3312d0d7708bSDaniel P. Berrange "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33137273a2dbSMatthew Booth#ifdef _WIN32 3314d0d7708bSDaniel P. Berrange "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3315d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33167273a2dbSMatthew Booth#else 3317d0d7708bSDaniel P. Berrange "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3318d0d7708bSDaniel P. Berrange "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 33197273a2dbSMatthew Booth#endif 33207273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 3321d0d7708bSDaniel P. Berrange "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33227273a2dbSMatthew Booth#endif 33237273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 33247273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 3325d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3326d0d7708bSDaniel P. Berrange "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33277273a2dbSMatthew Booth#endif 33287273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 3329d0d7708bSDaniel P. Berrange "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3330d0d7708bSDaniel P. Berrange "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 33317273a2dbSMatthew Booth#endif 3332cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 3333d0d7708bSDaniel P. Berrange "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3334d0d7708bSDaniel P. Berrange "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3335cbcc6336SAlon Levy#endif 3336ad96090aSBlue Swirl , QEMU_ARCH_ALL 33377273a2dbSMatthew Booth) 33387273a2dbSMatthew Booth 3339e2fcbf42SPeter MaydellSRST 3340e2fcbf42SPeter MaydellThe general form of a character device option is: 3341e2fcbf42SPeter Maydell 3342e2fcbf42SPeter Maydell``-chardev backend,id=id[,mux=on|off][,options]`` 3343e2fcbf42SPeter Maydell Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, 3344e2fcbf42SPeter Maydell ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``, 3345e2fcbf42SPeter Maydell ``pty``, ``stdio``, ``braille``, ``tty``, ``parallel``, ``parport``, 3346e2fcbf42SPeter Maydell ``spicevmc``, ``spiceport``. The specific backend will determine the 3347e2fcbf42SPeter Maydell applicable options. 3348e2fcbf42SPeter Maydell 3349e2fcbf42SPeter Maydell Use ``-chardev help`` to print all available chardev backend types. 3350e2fcbf42SPeter Maydell 3351e2fcbf42SPeter Maydell All devices must have an id, which can be any string up to 127 3352e2fcbf42SPeter Maydell characters long. It is used to uniquely identify this device in 3353e2fcbf42SPeter Maydell other command line directives. 3354e2fcbf42SPeter Maydell 3355e2fcbf42SPeter Maydell A character device may be used in multiplexing mode by multiple 3356e2fcbf42SPeter Maydell front-ends. Specify ``mux=on`` to enable this mode. A multiplexer is 3357e2fcbf42SPeter Maydell a "1:N" device, and here the "1" end is your specified chardev 3358e2fcbf42SPeter Maydell backend, and the "N" end is the various parts of QEMU that can talk 3359e2fcbf42SPeter Maydell to a chardev. If you create a chardev with ``id=myid`` and 3360e2fcbf42SPeter Maydell ``mux=on``, QEMU will create a multiplexer with your specified ID, 3361e2fcbf42SPeter Maydell and you can then configure multiple front ends to use that chardev 3362e2fcbf42SPeter Maydell ID for their input/output. Up to four different front ends can be 3363e2fcbf42SPeter Maydell connected to a single multiplexed chardev. (Without multiplexing 3364e2fcbf42SPeter Maydell enabled, a chardev can only be used by a single front end.) For 3365e2fcbf42SPeter Maydell instance you could use this to allow a single stdio chardev to be 3366e2fcbf42SPeter Maydell used by two serial ports and the QEMU monitor: 3367e2fcbf42SPeter Maydell 3368e2fcbf42SPeter Maydell :: 3369e2fcbf42SPeter Maydell 3370e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3371e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3372e2fcbf42SPeter Maydell -serial chardev:char0 \ 3373e2fcbf42SPeter Maydell -serial chardev:char0 3374e2fcbf42SPeter Maydell 3375e2fcbf42SPeter Maydell You can have more than one multiplexer in a system configuration; 3376e2fcbf42SPeter Maydell for instance you could have a TCP port multiplexed between UART 0 3377e2fcbf42SPeter Maydell and UART 1, and stdio multiplexed between the QEMU monitor and a 3378e2fcbf42SPeter Maydell parallel port: 3379e2fcbf42SPeter Maydell 3380e2fcbf42SPeter Maydell :: 3381e2fcbf42SPeter Maydell 3382e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3383e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3384e2fcbf42SPeter Maydell -parallel chardev:char0 \ 3385e2fcbf42SPeter Maydell -chardev tcp,...,mux=on,id=char1 \ 3386e2fcbf42SPeter Maydell -serial chardev:char1 \ 3387e2fcbf42SPeter Maydell -serial chardev:char1 3388e2fcbf42SPeter Maydell 3389e2fcbf42SPeter Maydell When you're using a multiplexed character device, some escape 3390923e9311SThomas Huth sequences are interpreted in the input. See the chapter about 3391923e9311SThomas Huth :ref:`keys in the character backend multiplexer` in the 3392923e9311SThomas Huth System Emulation Users Guide for more details. 3393e2fcbf42SPeter Maydell 3394e2fcbf42SPeter Maydell Note that some other command line options may implicitly create 3395e2fcbf42SPeter Maydell multiplexed character backends; for instance ``-serial mon:stdio`` 3396e2fcbf42SPeter Maydell creates a multiplexed stdio backend connected to the serial port and 3397e2fcbf42SPeter Maydell the QEMU monitor, and ``-nographic`` also multiplexes the console 3398e2fcbf42SPeter Maydell and the monitor to stdio. 3399e2fcbf42SPeter Maydell 3400e2fcbf42SPeter Maydell There is currently no support for multiplexing in the other 3401e2fcbf42SPeter Maydell direction (where a single QEMU front end takes input and output from 3402e2fcbf42SPeter Maydell multiple chardevs). 3403e2fcbf42SPeter Maydell 3404e2fcbf42SPeter Maydell Every backend supports the ``logfile`` option, which supplies the 3405e2fcbf42SPeter Maydell path to a file to record all data transmitted via the backend. The 3406e2fcbf42SPeter Maydell ``logappend`` option controls whether the log file will be truncated 3407e2fcbf42SPeter Maydell or appended to when opened. 3408e2fcbf42SPeter Maydell 3409e2fcbf42SPeter MaydellThe available backends are: 3410e2fcbf42SPeter Maydell 3411e2fcbf42SPeter Maydell``-chardev null,id=id`` 3412e2fcbf42SPeter Maydell A void device. This device will not emit any data, and will drop any 3413e2fcbf42SPeter Maydell data it receives. The null backend does not take any options. 3414e2fcbf42SPeter Maydell 3415bfdc1267SDaniel 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]`` 3416e2fcbf42SPeter Maydell Create a two-way stream socket, which can be either a TCP or a unix 3417e2fcbf42SPeter Maydell socket. A unix socket will be created if ``path`` is specified. 3418e2fcbf42SPeter Maydell Behaviour is undefined if TCP options are specified for a unix 3419e2fcbf42SPeter Maydell socket. 3420e2fcbf42SPeter Maydell 3421bfdc1267SDaniel P. Berrangé ``server=on|off`` specifies that the socket shall be a listening socket. 3422e2fcbf42SPeter Maydell 3423bfdc1267SDaniel P. Berrangé ``wait=on|off`` specifies that QEMU should not block waiting for a client 3424e2fcbf42SPeter Maydell to connect to a listening socket. 3425e2fcbf42SPeter Maydell 3426bfdc1267SDaniel P. Berrangé ``telnet=on|off`` specifies that traffic on the socket should interpret 3427e2fcbf42SPeter Maydell telnet escape sequences. 3428e2fcbf42SPeter Maydell 3429bfdc1267SDaniel P. Berrangé ``websocket=on|off`` specifies that the socket uses WebSocket protocol for 3430e2fcbf42SPeter Maydell communication. 3431e2fcbf42SPeter Maydell 3432e2fcbf42SPeter Maydell ``reconnect`` sets the timeout for reconnecting on non-server 3433e2fcbf42SPeter Maydell sockets when the remote end goes away. qemu will delay this many 3434e2fcbf42SPeter Maydell seconds and then attempt to reconnect. Zero disables reconnecting, 3435e2fcbf42SPeter Maydell and is the default. 3436e2fcbf42SPeter Maydell 3437e2fcbf42SPeter Maydell ``tls-creds`` requests enablement of the TLS protocol for 3438e2fcbf42SPeter Maydell encryption, and specifies the id of the TLS credentials to use for 3439e2fcbf42SPeter Maydell the handshake. The credentials must be previously created with the 3440e2fcbf42SPeter Maydell ``-object tls-creds`` argument. 3441e2fcbf42SPeter Maydell 3442e2fcbf42SPeter Maydell ``tls-auth`` provides the ID of the QAuthZ authorization object 3443e2fcbf42SPeter Maydell against which the client's x509 distinguished name will be 3444e2fcbf42SPeter Maydell validated. This object is only resolved at time of use, so can be 3445e2fcbf42SPeter Maydell deleted and recreated on the fly while the chardev server is active. 3446e2fcbf42SPeter Maydell If missing, it will default to denying access. 3447e2fcbf42SPeter Maydell 3448e2fcbf42SPeter Maydell TCP and unix socket options are given below: 3449e2fcbf42SPeter Maydell 3450a9b1315fSPaolo Bonzini ``TCP options: port=port[,host=host][,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]`` 3451e2fcbf42SPeter Maydell ``host`` for a listening socket specifies the local address to 3452e2fcbf42SPeter Maydell be bound. For a connecting socket species the remote host to 3453e2fcbf42SPeter Maydell connect to. ``host`` is optional for listening sockets. If not 3454e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3455e2fcbf42SPeter Maydell 3456e2fcbf42SPeter Maydell ``port`` for a listening socket specifies the local port to be 3457e2fcbf42SPeter Maydell bound. For a connecting socket specifies the port on the remote 3458e2fcbf42SPeter Maydell host to connect to. ``port`` can be given as either a port 3459e2fcbf42SPeter Maydell number or a service name. ``port`` is required. 3460e2fcbf42SPeter Maydell 3461e2fcbf42SPeter Maydell ``to`` is only relevant to listening sockets. If it is 3462e2fcbf42SPeter Maydell specified, and ``port`` cannot be bound, QEMU will attempt to 3463e2fcbf42SPeter Maydell bind to subsequent ports up to and including ``to`` until it 3464e2fcbf42SPeter Maydell succeeds. ``to`` must be specified as a port number. 3465e2fcbf42SPeter Maydell 3466bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 3467bfdc1267SDaniel P. Berrangé or IPv6 must be used. If neither is specified the socket may 3468bfdc1267SDaniel P. Berrangé use either protocol. 3469e2fcbf42SPeter Maydell 3470a9b1315fSPaolo Bonzini ``nodelay=on|off`` disables the Nagle algorithm. 3471e2fcbf42SPeter Maydell 3472e339273bSxiaoqiang zhao ``unix options: path=path[,abstract=on|off][,tight=on|off]`` 3473e2fcbf42SPeter Maydell ``path`` specifies the local path of the unix socket. ``path`` 3474e2fcbf42SPeter Maydell is required. 3475bfdc1267SDaniel P. Berrangé ``abstract=on|off`` specifies the use of the abstract socket namespace, 3476e339273bSxiaoqiang zhao rather than the filesystem. Optional, defaults to false. 3477bfdc1267SDaniel P. Berrangé ``tight=on|off`` sets the socket length of abstract sockets to their minimum, 3478e339273bSxiaoqiang zhao rather than the full sun_path length. Optional, defaults to true. 3479e2fcbf42SPeter Maydell 3480bfdc1267SDaniel P. Berrangé``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4=on|off][,ipv6=on|off]`` 3481e2fcbf42SPeter Maydell Sends all traffic from the guest to a remote host over UDP. 3482e2fcbf42SPeter Maydell 3483e2fcbf42SPeter Maydell ``host`` specifies the remote host to connect to. If not specified 3484e2fcbf42SPeter Maydell it defaults to ``localhost``. 3485e2fcbf42SPeter Maydell 3486e2fcbf42SPeter Maydell ``port`` specifies the port on the remote host to connect to. 3487e2fcbf42SPeter Maydell ``port`` is required. 3488e2fcbf42SPeter Maydell 3489e2fcbf42SPeter Maydell ``localaddr`` specifies the local address to bind to. If not 3490e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3491e2fcbf42SPeter Maydell 3492e2fcbf42SPeter Maydell ``localport`` specifies the local port to bind to. If not specified 3493e2fcbf42SPeter Maydell any available local port will be used. 3494e2fcbf42SPeter Maydell 3495bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 or IPv6 must be used. 3496e2fcbf42SPeter Maydell If neither is specified the device may use either protocol. 3497e2fcbf42SPeter Maydell 3498e2fcbf42SPeter Maydell``-chardev msmouse,id=id`` 3499e2fcbf42SPeter Maydell Forward QEMU's emulated msmouse events to the guest. ``msmouse`` 3500e2fcbf42SPeter Maydell does not take any options. 3501e2fcbf42SPeter Maydell 3502e2fcbf42SPeter Maydell``-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]`` 3503e2fcbf42SPeter Maydell Connect to a QEMU text console. ``vc`` may optionally be given a 3504e2fcbf42SPeter Maydell specific size. 3505e2fcbf42SPeter Maydell 3506e2fcbf42SPeter Maydell ``width`` and ``height`` specify the width and height respectively 3507e2fcbf42SPeter Maydell of the console, in pixels. 3508e2fcbf42SPeter Maydell 3509e2fcbf42SPeter Maydell ``cols`` and ``rows`` specify that the console be sized to fit a 3510e2fcbf42SPeter Maydell text console with the given dimensions. 3511e2fcbf42SPeter Maydell 3512e2fcbf42SPeter Maydell``-chardev ringbuf,id=id[,size=size]`` 3513e2fcbf42SPeter Maydell Create a ring buffer with fixed size ``size``. size must be a power 3514e2fcbf42SPeter Maydell of two and defaults to ``64K``. 3515e2fcbf42SPeter Maydell 3516e2fcbf42SPeter Maydell``-chardev file,id=id,path=path`` 3517e2fcbf42SPeter Maydell Log all traffic received from the guest to a file. 3518e2fcbf42SPeter Maydell 3519e2fcbf42SPeter Maydell ``path`` specifies the path of the file to be opened. This file will 3520e2fcbf42SPeter Maydell be created if it does not already exist, and overwritten if it does. 3521e2fcbf42SPeter Maydell ``path`` is required. 3522e2fcbf42SPeter Maydell 3523e2fcbf42SPeter Maydell``-chardev pipe,id=id,path=path`` 3524e2fcbf42SPeter Maydell Create a two-way connection to the guest. The behaviour differs 3525e2fcbf42SPeter Maydell slightly between Windows hosts and other hosts: 3526e2fcbf42SPeter Maydell 3527e2fcbf42SPeter Maydell On Windows, a single duplex pipe will be created at 3528e2fcbf42SPeter Maydell ``\\.pipe\path``. 3529e2fcbf42SPeter Maydell 3530e2fcbf42SPeter Maydell On other hosts, 2 pipes will be created called ``path.in`` and 3531e2fcbf42SPeter Maydell ``path.out``. Data written to ``path.in`` will be received by the 3532e2fcbf42SPeter Maydell guest. Data written by the guest can be read from ``path.out``. QEMU 3533e2fcbf42SPeter Maydell will not create these fifos, and requires them to be present. 3534e2fcbf42SPeter Maydell 3535e2fcbf42SPeter Maydell ``path`` forms part of the pipe path as described above. ``path`` is 3536e2fcbf42SPeter Maydell required. 3537e2fcbf42SPeter Maydell 3538e2fcbf42SPeter Maydell``-chardev console,id=id`` 3539e2fcbf42SPeter Maydell Send traffic from the guest to QEMU's standard output. ``console`` 3540e2fcbf42SPeter Maydell does not take any options. 3541e2fcbf42SPeter Maydell 3542e2fcbf42SPeter Maydell ``console`` is only available on Windows hosts. 3543e2fcbf42SPeter Maydell 3544e2fcbf42SPeter Maydell``-chardev serial,id=id,path=path`` 3545e2fcbf42SPeter Maydell Send traffic from the guest to a serial device on the host. 3546e2fcbf42SPeter Maydell 3547e2fcbf42SPeter Maydell On Unix hosts serial will actually accept any tty device, not only 3548e2fcbf42SPeter Maydell serial lines. 3549e2fcbf42SPeter Maydell 3550e2fcbf42SPeter Maydell ``path`` specifies the name of the serial device to open. 3551e2fcbf42SPeter Maydell 3552e2fcbf42SPeter Maydell``-chardev pty,id=id`` 3553e2fcbf42SPeter Maydell Create a new pseudo-terminal on the host and connect to it. ``pty`` 3554e2fcbf42SPeter Maydell does not take any options. 3555e2fcbf42SPeter Maydell 3556e2fcbf42SPeter Maydell ``pty`` is not available on Windows hosts. 3557e2fcbf42SPeter Maydell 3558e2fcbf42SPeter Maydell``-chardev stdio,id=id[,signal=on|off]`` 3559e2fcbf42SPeter Maydell Connect to standard input and standard output of the QEMU process. 3560e2fcbf42SPeter Maydell 3561e2fcbf42SPeter Maydell ``signal`` controls if signals are enabled on the terminal, that 3562e2fcbf42SPeter Maydell includes exiting QEMU with the key sequence Control-c. This option 3563e2fcbf42SPeter Maydell is enabled by default, use ``signal=off`` to disable it. 3564e2fcbf42SPeter Maydell 3565e2fcbf42SPeter Maydell``-chardev braille,id=id`` 3566e2fcbf42SPeter Maydell Connect to a local BrlAPI server. ``braille`` does not take any 3567e2fcbf42SPeter Maydell options. 3568e2fcbf42SPeter Maydell 3569e2fcbf42SPeter Maydell``-chardev tty,id=id,path=path`` 3570e2fcbf42SPeter Maydell ``tty`` is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD 3571e2fcbf42SPeter Maydell and DragonFlyBSD hosts. It is an alias for ``serial``. 3572e2fcbf42SPeter Maydell 3573e2fcbf42SPeter Maydell ``path`` specifies the path to the tty. ``path`` is required. 3574e2fcbf42SPeter Maydell 357509ce5f2dSPeter Maydell``-chardev parallel,id=id,path=path`` 357609ce5f2dSPeter Maydell \ 357709ce5f2dSPeter Maydell``-chardev parport,id=id,path=path`` 3578e2fcbf42SPeter Maydell ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD 3579e2fcbf42SPeter Maydell hosts. 3580e2fcbf42SPeter Maydell 3581e2fcbf42SPeter Maydell Connect to a local parallel port. 3582e2fcbf42SPeter Maydell 3583e2fcbf42SPeter Maydell ``path`` specifies the path to the parallel port device. ``path`` is 3584e2fcbf42SPeter Maydell required. 3585e2fcbf42SPeter Maydell 3586e2fcbf42SPeter Maydell``-chardev spicevmc,id=id,debug=debug,name=name`` 3587e2fcbf42SPeter Maydell ``spicevmc`` is only available when spice support is built in. 3588e2fcbf42SPeter Maydell 3589e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3590e2fcbf42SPeter Maydell 3591e2fcbf42SPeter Maydell ``name`` name of spice channel to connect to 3592e2fcbf42SPeter Maydell 3593e2fcbf42SPeter Maydell Connect to a spice virtual machine channel, such as vdiport. 3594e2fcbf42SPeter Maydell 3595e2fcbf42SPeter Maydell``-chardev spiceport,id=id,debug=debug,name=name`` 3596e2fcbf42SPeter Maydell ``spiceport`` is only available when spice support is built in. 3597e2fcbf42SPeter Maydell 3598e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3599e2fcbf42SPeter Maydell 3600e2fcbf42SPeter Maydell ``name`` name of spice port to connect to 3601e2fcbf42SPeter Maydell 3602e2fcbf42SPeter Maydell Connect to a spice port, allowing a Spice client to handle the 3603e2fcbf42SPeter Maydell traffic identified by a name (preferably a fqdn). 3604e2fcbf42SPeter MaydellERST 36057273a2dbSMatthew Booth 36067273a2dbSMatthew BoothDEFHEADING() 36077273a2dbSMatthew Booth 3608d1a0cf73SStefan Berger#ifdef CONFIG_TPM 3609de6b4f90SMarkus ArmbrusterDEFHEADING(TPM device options:) 3610d1a0cf73SStefan Berger 3611d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 361292dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 361392dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 361492dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 3615f4ede81eSAmarnath Valluri " not provided it will be searched for in /sys/class/misc/tpm?/device\n" 3616f4ede81eSAmarnath Valluri "-tpmdev emulator,id=id,chardev=dev\n" 3617f4ede81eSAmarnath Valluri " configure the TPM device using chardev backend\n", 3618d1a0cf73SStefan Berger QEMU_ARCH_ALL) 3619e2fcbf42SPeter MaydellSRST 3620e2fcbf42SPeter MaydellThe general form of a TPM device option is: 3621e2fcbf42SPeter Maydell 3622e2fcbf42SPeter Maydell``-tpmdev backend,id=id[,options]`` 3623e2fcbf42SPeter Maydell The specific backend type will determine the applicable options. The 3624e2fcbf42SPeter Maydell ``-tpmdev`` option creates the TPM backend and requires a 3625e2fcbf42SPeter Maydell ``-device`` option that specifies the TPM frontend interface model. 3626e2fcbf42SPeter Maydell 3627e2fcbf42SPeter Maydell Use ``-tpmdev help`` to print all available TPM backend types. 3628e2fcbf42SPeter Maydell 3629e2fcbf42SPeter MaydellThe available backends are: 3630e2fcbf42SPeter Maydell 3631e2fcbf42SPeter Maydell``-tpmdev passthrough,id=id,path=path,cancel-path=cancel-path`` 3632e2fcbf42SPeter Maydell (Linux-host only) Enable access to the host's TPM using the 3633e2fcbf42SPeter Maydell passthrough driver. 3634e2fcbf42SPeter Maydell 3635e2fcbf42SPeter Maydell ``path`` specifies the path to the host's TPM device, i.e., on a 3636e2fcbf42SPeter Maydell Linux host this would be ``/dev/tpm0``. ``path`` is optional and by 3637e2fcbf42SPeter Maydell default ``/dev/tpm0`` is used. 3638e2fcbf42SPeter Maydell 3639e2fcbf42SPeter Maydell ``cancel-path`` specifies the path to the host TPM device's sysfs 3640e2fcbf42SPeter Maydell entry allowing for cancellation of an ongoing TPM command. 3641e2fcbf42SPeter Maydell ``cancel-path`` is optional and by default QEMU will search for the 3642e2fcbf42SPeter Maydell sysfs entry to use. 3643e2fcbf42SPeter Maydell 3644e2fcbf42SPeter Maydell Some notes about using the host's TPM with the passthrough driver: 3645e2fcbf42SPeter Maydell 3646e2fcbf42SPeter Maydell The TPM device accessed by the passthrough driver must not be used 3647e2fcbf42SPeter Maydell by any other application on the host. 3648e2fcbf42SPeter Maydell 3649e2fcbf42SPeter Maydell Since the host's firmware (BIOS/UEFI) has already initialized the 3650e2fcbf42SPeter Maydell TPM, the VM's firmware (BIOS/UEFI) will not be able to initialize 3651e2fcbf42SPeter Maydell the TPM again and may therefore not show a TPM-specific menu that 3652e2fcbf42SPeter Maydell would otherwise allow the user to configure the TPM, e.g., allow the 3653e2fcbf42SPeter Maydell user to enable/disable or activate/deactivate the TPM. Further, if 3654e2fcbf42SPeter Maydell TPM ownership is released from within a VM then the host's TPM will 3655e2fcbf42SPeter Maydell get disabled and deactivated. To enable and activate the TPM again 3656e2fcbf42SPeter Maydell afterwards, the host has to be rebooted and the user is required to 3657e2fcbf42SPeter Maydell enter the firmware's menu to enable and activate the TPM. If the TPM 3658e2fcbf42SPeter Maydell is left disabled and/or deactivated most TPM commands will fail. 3659e2fcbf42SPeter Maydell 3660e2fcbf42SPeter Maydell To create a passthrough TPM use the following two options: 3661e2fcbf42SPeter Maydell 3662e2fcbf42SPeter Maydell :: 3663e2fcbf42SPeter Maydell 3664e2fcbf42SPeter Maydell -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 3665e2fcbf42SPeter Maydell 3666e2fcbf42SPeter Maydell Note that the ``-tpmdev`` id is ``tpm0`` and is referenced by 3667e2fcbf42SPeter Maydell ``tpmdev=tpm0`` in the device option. 3668e2fcbf42SPeter Maydell 3669e2fcbf42SPeter Maydell``-tpmdev emulator,id=id,chardev=dev`` 3670e2fcbf42SPeter Maydell (Linux-host only) Enable access to a TPM emulator using Unix domain 3671e2fcbf42SPeter Maydell socket based chardev backend. 3672e2fcbf42SPeter Maydell 3673e2fcbf42SPeter Maydell ``chardev`` specifies the unique ID of a character device backend 3674e2fcbf42SPeter Maydell that provides connection to the software TPM server. 3675e2fcbf42SPeter Maydell 3676e2fcbf42SPeter Maydell To create a TPM emulator backend device with chardev socket backend: 3677e2fcbf42SPeter Maydell 3678e2fcbf42SPeter Maydell :: 3679e2fcbf42SPeter Maydell 3680e2fcbf42SPeter Maydell -chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0 3681e2fcbf42SPeter MaydellERST 3682d1a0cf73SStefan Berger 3683d1a0cf73SStefan BergerDEFHEADING() 3684d1a0cf73SStefan Berger 3685d1a0cf73SStefan Berger#endif 3686d1a0cf73SStefan Berger 3687de6b4f90SMarkus ArmbrusterDEFHEADING(Linux/Multiboot boot specific:) 3688e2fcbf42SPeter MaydellSRST 3689e2fcbf42SPeter MaydellWhen using these options, you can use a given Linux or Multiboot kernel 3690e2fcbf42SPeter Maydellwithout installing it in the disk image. It can be useful for easier 3691e2fcbf42SPeter Maydelltesting of various kernels. 3692e2fcbf42SPeter Maydell 3693e2fcbf42SPeter Maydell 3694e2fcbf42SPeter MaydellERST 36955824d651Sblueswir1 36965824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 3697ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 3698e2fcbf42SPeter MaydellSRST 3699e2fcbf42SPeter Maydell``-kernel bzImage`` 3700e2fcbf42SPeter Maydell Use bzImage as kernel image. The kernel can be either a Linux kernel 3701e2fcbf42SPeter Maydell or in multiboot format. 3702e2fcbf42SPeter MaydellERST 37035824d651Sblueswir1 37045824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 3705ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 3706e2fcbf42SPeter MaydellSRST 3707e2fcbf42SPeter Maydell``-append cmdline`` 3708e2fcbf42SPeter Maydell Use cmdline as kernel command line 3709e2fcbf42SPeter MaydellERST 37105824d651Sblueswir1 37115824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 3712ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 3713e2fcbf42SPeter MaydellSRST 3714e2fcbf42SPeter Maydell``-initrd file`` 3715e2fcbf42SPeter Maydell Use file as initial ram disk. 3716e2fcbf42SPeter Maydell 3717e2fcbf42SPeter Maydell``-initrd "file1 arg=foo,file2"`` 3718e2fcbf42SPeter Maydell This syntax is only available with multiboot. 3719e2fcbf42SPeter Maydell 3720e2fcbf42SPeter Maydell Use file1 and file2 as modules and pass arg=foo as parameter to the 3721e2fcbf42SPeter Maydell first module. 3722e2fcbf42SPeter MaydellERST 37235824d651Sblueswir1 3724412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 3725379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 3726e2fcbf42SPeter MaydellSRST 3727e2fcbf42SPeter Maydell``-dtb file`` 3728e2fcbf42SPeter Maydell Use file as a device tree binary (dtb) image and pass it to the 3729e2fcbf42SPeter Maydell kernel on boot. 3730e2fcbf42SPeter MaydellERST 3731412beee6SGrant Likely 37325824d651Sblueswir1DEFHEADING() 37335824d651Sblueswir1 3734de6b4f90SMarkus ArmbrusterDEFHEADING(Debug/Expert options:) 37355824d651Sblueswir1 37366dd75472SMarkus ArmbrusterDEF("compat", HAS_ARG, QEMU_OPTION_compat, 3737dbb675c1SMarkus Armbruster "-compat [deprecated-input=accept|reject|crash][,deprecated-output=accept|hide]\n" 373857df0dffSMarkus Armbruster " Policy for handling deprecated management interfaces\n" 373957df0dffSMarkus Armbruster "-compat [unstable-input=accept|reject|crash][,unstable-output=accept|hide]\n" 374057df0dffSMarkus Armbruster " Policy for handling unstable management interfaces\n", 37416dd75472SMarkus Armbruster QEMU_ARCH_ALL) 37426dd75472SMarkus ArmbrusterSRST 37436dd75472SMarkus Armbruster``-compat [deprecated-input=@var{input-policy}][,deprecated-output=@var{output-policy}]`` 37446dd75472SMarkus Armbruster Set policy for handling deprecated management interfaces (experimental): 37456dd75472SMarkus Armbruster 37466dd75472SMarkus Armbruster ``deprecated-input=accept`` (default) 37476dd75472SMarkus Armbruster Accept deprecated commands and arguments 37486dd75472SMarkus Armbruster ``deprecated-input=reject`` 37496dd75472SMarkus Armbruster Reject deprecated commands and arguments 3750dbb675c1SMarkus Armbruster ``deprecated-input=crash`` 3751dbb675c1SMarkus Armbruster Crash on deprecated commands and arguments 37526dd75472SMarkus Armbruster ``deprecated-output=accept`` (default) 37536dd75472SMarkus Armbruster Emit deprecated command results and events 37546dd75472SMarkus Armbruster ``deprecated-output=hide`` 37556dd75472SMarkus Armbruster Suppress deprecated command results and events 37566dd75472SMarkus Armbruster 37576dd75472SMarkus Armbruster Limitation: covers only syntactic aspects of QMP. 375857df0dffSMarkus Armbruster 375957df0dffSMarkus Armbruster``-compat [unstable-input=@var{input-policy}][,unstable-output=@var{output-policy}]`` 376057df0dffSMarkus Armbruster Set policy for handling unstable management interfaces (experimental): 376157df0dffSMarkus Armbruster 376257df0dffSMarkus Armbruster ``unstable-input=accept`` (default) 376357df0dffSMarkus Armbruster Accept unstable commands and arguments 376457df0dffSMarkus Armbruster ``unstable-input=reject`` 376557df0dffSMarkus Armbruster Reject unstable commands and arguments 376657df0dffSMarkus Armbruster ``unstable-input=crash`` 376757df0dffSMarkus Armbruster Crash on unstable commands and arguments 376857df0dffSMarkus Armbruster ``unstable-output=accept`` (default) 376957df0dffSMarkus Armbruster Emit unstable command results and events 377057df0dffSMarkus Armbruster ``unstable-output=hide`` 377157df0dffSMarkus Armbruster Suppress unstable command results and events 377257df0dffSMarkus Armbruster 377357df0dffSMarkus Armbruster Limitation: covers only syntactic aspects of QMP. 37746dd75472SMarkus ArmbrusterERST 37756dd75472SMarkus Armbruster 377681b2b810SGabriel L. SomloDEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 377781b2b810SGabriel L. Somlo "-fw_cfg [name=]<name>,file=<file>\n" 377863d3145aSMarkus Armbruster " add named fw_cfg entry with contents from file\n" 37796407d76eSGabriel L. Somlo "-fw_cfg [name=]<name>,string=<str>\n" 378063d3145aSMarkus Armbruster " add named fw_cfg entry with contents from string\n", 378181b2b810SGabriel L. Somlo QEMU_ARCH_ALL) 3782e2fcbf42SPeter MaydellSRST 3783e2fcbf42SPeter Maydell``-fw_cfg [name=]name,file=file`` 3784e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from file file. 3785e2fcbf42SPeter Maydell 3786e2fcbf42SPeter Maydell``-fw_cfg [name=]name,string=str`` 3787e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from string str. 3788e2fcbf42SPeter Maydell 3789e2fcbf42SPeter Maydell The terminating NUL character of the contents of str will not be 3790e2fcbf42SPeter Maydell included as part of the fw\_cfg item data. To insert contents with 3791e2fcbf42SPeter Maydell embedded NUL characters, you have to use the file parameter. 3792e2fcbf42SPeter Maydell 3793e2fcbf42SPeter Maydell The fw\_cfg entries are passed by QEMU through to the guest. 3794e2fcbf42SPeter Maydell 3795e2fcbf42SPeter Maydell Example: 3796e2fcbf42SPeter Maydell 3797e2fcbf42SPeter Maydell :: 3798e2fcbf42SPeter Maydell 3799e2fcbf42SPeter Maydell -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 3800e2fcbf42SPeter Maydell 3801e2fcbf42SPeter Maydell creates an fw\_cfg entry named opt/com.mycompany/blob with contents 3802e2fcbf42SPeter Maydell from ./my\_blob.bin. 3803e2fcbf42SPeter MaydellERST 380481b2b810SGabriel L. Somlo 38055824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 3806ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 3807ad96090aSBlue Swirl QEMU_ARCH_ALL) 3808e2fcbf42SPeter MaydellSRST 3809e2fcbf42SPeter Maydell``-serial dev`` 3810e2fcbf42SPeter Maydell Redirect the virtual serial port to host character device dev. The 3811e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 3812e2fcbf42SPeter Maydell graphical mode. 3813e2fcbf42SPeter Maydell 3814e2fcbf42SPeter Maydell This option can be used several times to simulate up to 4 serial 3815e2fcbf42SPeter Maydell ports. 3816e2fcbf42SPeter Maydell 3817e2fcbf42SPeter Maydell Use ``-serial none`` to disable all serial ports. 3818e2fcbf42SPeter Maydell 3819e2fcbf42SPeter Maydell Available character devices are: 3820e2fcbf42SPeter Maydell 3821e2fcbf42SPeter Maydell ``vc[:WxH]`` 3822e2fcbf42SPeter Maydell Virtual console. Optionally, a width and height can be given in 3823e2fcbf42SPeter Maydell pixel with 3824e2fcbf42SPeter Maydell 3825e2fcbf42SPeter Maydell :: 3826e2fcbf42SPeter Maydell 3827e2fcbf42SPeter Maydell vc:800x600 3828e2fcbf42SPeter Maydell 3829e2fcbf42SPeter Maydell It is also possible to specify width or height in characters: 3830e2fcbf42SPeter Maydell 3831e2fcbf42SPeter Maydell :: 3832e2fcbf42SPeter Maydell 3833e2fcbf42SPeter Maydell vc:80Cx24C 3834e2fcbf42SPeter Maydell 3835e2fcbf42SPeter Maydell ``pty`` 3836e2fcbf42SPeter Maydell [Linux only] Pseudo TTY (a new PTY is automatically allocated) 3837e2fcbf42SPeter Maydell 3838e2fcbf42SPeter Maydell ``none`` 3839e2fcbf42SPeter Maydell No device is allocated. 3840e2fcbf42SPeter Maydell 3841e2fcbf42SPeter Maydell ``null`` 3842e2fcbf42SPeter Maydell void device 3843e2fcbf42SPeter Maydell 3844e2fcbf42SPeter Maydell ``chardev:id`` 3845e2fcbf42SPeter Maydell Use a named character device defined with the ``-chardev`` 3846e2fcbf42SPeter Maydell option. 3847e2fcbf42SPeter Maydell 3848e2fcbf42SPeter Maydell ``/dev/XXX`` 3849e2fcbf42SPeter Maydell [Linux only] Use host tty, e.g. ``/dev/ttyS0``. The host serial 3850e2fcbf42SPeter Maydell port parameters are set according to the emulated ones. 3851e2fcbf42SPeter Maydell 3852e2fcbf42SPeter Maydell ``/dev/parportN`` 3853e2fcbf42SPeter Maydell [Linux only, parallel port only] Use host parallel port N. 3854e2fcbf42SPeter Maydell Currently SPP and EPP parallel port features can be used. 3855e2fcbf42SPeter Maydell 3856e2fcbf42SPeter Maydell ``file:filename`` 3857e2fcbf42SPeter Maydell Write output to filename. No character can be read. 3858e2fcbf42SPeter Maydell 3859e2fcbf42SPeter Maydell ``stdio`` 3860e2fcbf42SPeter Maydell [Unix only] standard input/output 3861e2fcbf42SPeter Maydell 3862e2fcbf42SPeter Maydell ``pipe:filename`` 3863e2fcbf42SPeter Maydell name pipe filename 3864e2fcbf42SPeter Maydell 3865e2fcbf42SPeter Maydell ``COMn`` 3866e2fcbf42SPeter Maydell [Windows only] Use host serial port n 3867e2fcbf42SPeter Maydell 3868e2fcbf42SPeter Maydell ``udp:[remote_host]:remote_port[@[src_ip]:src_port]`` 3869e2fcbf42SPeter Maydell This implements UDP Net Console. When remote\_host or src\_ip 3870e2fcbf42SPeter Maydell are not specified they default to ``0.0.0.0``. When not using a 3871e2fcbf42SPeter Maydell specified src\_port a random port is automatically chosen. 3872e2fcbf42SPeter Maydell 3873e2fcbf42SPeter Maydell If you just want a simple readonly console you can use 3874e2fcbf42SPeter Maydell ``netcat`` or ``nc``, by starting QEMU with: 3875e2fcbf42SPeter Maydell ``-serial udp::4555`` and nc as: ``nc -u -l -p 4555``. Any time 3876e2fcbf42SPeter Maydell QEMU writes something to that port it will appear in the 3877e2fcbf42SPeter Maydell netconsole session. 3878e2fcbf42SPeter Maydell 3879e2fcbf42SPeter Maydell If you plan to send characters back via netconsole or you want 3880e2fcbf42SPeter Maydell to stop and start QEMU a lot of times, you should have QEMU use 3881e2fcbf42SPeter Maydell the same source port each time by using something like ``-serial 3882e2fcbf42SPeter Maydell udp::4555@:4556`` to QEMU. Another approach is to use a patched 3883e2fcbf42SPeter Maydell version of netcat which can listen to a TCP port and send and 3884e2fcbf42SPeter Maydell receive characters via udp. If you have a patched version of 3885e2fcbf42SPeter Maydell netcat which activates telnet remote echo and single char 3886e2fcbf42SPeter Maydell transfer, then you can use the following options to set up a 3887e2fcbf42SPeter Maydell netcat redirector to allow telnet on port 5555 to access the 3888e2fcbf42SPeter Maydell QEMU port. 3889e2fcbf42SPeter Maydell 3890e2fcbf42SPeter Maydell ``QEMU Options:`` 3891e2fcbf42SPeter Maydell -serial udp::4555@:4556 3892e2fcbf42SPeter Maydell 3893e2fcbf42SPeter Maydell ``netcat options:`` 3894e2fcbf42SPeter Maydell -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 3895e2fcbf42SPeter Maydell 3896e2fcbf42SPeter Maydell ``telnet options:`` 3897e2fcbf42SPeter Maydell localhost 5555 3898e2fcbf42SPeter Maydell 3899a9b1315fSPaolo Bonzini ``tcp:[host]:port[,server=on|off][,wait=on|off][,nodelay=on|off][,reconnect=seconds]`` 3900e2fcbf42SPeter Maydell The TCP Net Console has two modes of operation. It can send the 3901e2fcbf42SPeter Maydell serial I/O to a location or wait for a connection from a 3902e2fcbf42SPeter Maydell location. By default the TCP Net Console is sent to host at the 3903bfdc1267SDaniel P. Berrangé port. If you use the ``server=on`` option QEMU will wait for a client 3904e2fcbf42SPeter Maydell socket application to connect to the port before continuing, 3905a9b1315fSPaolo Bonzini unless the ``wait=on|off`` option was specified. The ``nodelay=on|off`` 3906bfdc1267SDaniel P. Berrangé option disables the Nagle buffering algorithm. The ``reconnect=on`` 3907bfdc1267SDaniel P. Berrangé option only applies if ``server=no`` is set, if the connection goes 3908e2fcbf42SPeter Maydell down it will attempt to reconnect at the given interval. If host 3909e2fcbf42SPeter Maydell is omitted, 0.0.0.0 is assumed. Only one TCP connection at a 3910bfdc1267SDaniel P. Berrangé time is accepted. You can use ``telnet=on`` to connect to the 3911e2fcbf42SPeter Maydell corresponding character device. 3912e2fcbf42SPeter Maydell 3913e2fcbf42SPeter Maydell ``Example to send tcp console to 192.168.0.2 port 4444`` 3914e2fcbf42SPeter Maydell -serial tcp:192.168.0.2:4444 3915e2fcbf42SPeter Maydell 3916e2fcbf42SPeter Maydell ``Example to listen and wait on port 4444 for connection`` 3917bfdc1267SDaniel P. Berrangé -serial tcp::4444,server=on 3918e2fcbf42SPeter Maydell 3919e2fcbf42SPeter Maydell ``Example to not wait and listen on ip 192.168.0.100 port 4444`` 3920bfdc1267SDaniel P. Berrangé -serial tcp:192.168.0.100:4444,server=on,wait=off 3921e2fcbf42SPeter Maydell 3922a9b1315fSPaolo Bonzini ``telnet:host:port[,server=on|off][,wait=on|off][,nodelay=on|off]`` 3923e2fcbf42SPeter Maydell The telnet protocol is used instead of raw tcp sockets. The 3924e2fcbf42SPeter Maydell options work the same as if you had specified ``-serial tcp``. 3925e2fcbf42SPeter Maydell The difference is that the port acts like a telnet server or 3926e2fcbf42SPeter Maydell client using telnet option negotiation. This will also allow you 3927e2fcbf42SPeter Maydell to send the MAGIC\_SYSRQ sequence if you use a telnet that 3928e2fcbf42SPeter Maydell supports sending the break sequence. Typically in unix telnet 3929e2fcbf42SPeter Maydell you do it with Control-] and then type "send break" followed by 3930e2fcbf42SPeter Maydell pressing the enter key. 3931e2fcbf42SPeter Maydell 3932a9b1315fSPaolo Bonzini ``websocket:host:port,server=on[,wait=on|off][,nodelay=on|off]`` 3933e2fcbf42SPeter Maydell The WebSocket protocol is used instead of raw tcp socket. The 3934e2fcbf42SPeter Maydell port acts as a WebSocket server. Client mode is not supported. 3935e2fcbf42SPeter Maydell 3936bfdc1267SDaniel P. Berrangé ``unix:path[,server=on|off][,wait=on|off][,reconnect=seconds]`` 3937e2fcbf42SPeter Maydell A unix domain socket is used instead of a tcp socket. The option 3938e2fcbf42SPeter Maydell works the same as if you had specified ``-serial tcp`` except 3939e2fcbf42SPeter Maydell the unix domain socket path is used for connections. 3940e2fcbf42SPeter Maydell 3941e2fcbf42SPeter Maydell ``mon:dev_string`` 3942e2fcbf42SPeter Maydell This is a special option to allow the monitor to be multiplexed 3943e2fcbf42SPeter Maydell onto another serial port. The monitor is accessed with key 3944e2fcbf42SPeter Maydell sequence of Control-a and then pressing c. dev\_string should be 3945e2fcbf42SPeter Maydell any one of the serial devices specified above. An example to 3946e2fcbf42SPeter Maydell multiplex the monitor onto a telnet server listening on port 3947e2fcbf42SPeter Maydell 4444 would be: 3948e2fcbf42SPeter Maydell 3949bfdc1267SDaniel P. Berrangé ``-serial mon:telnet::4444,server=on,wait=off`` 3950e2fcbf42SPeter Maydell 3951e2fcbf42SPeter Maydell When the monitor is multiplexed to stdio in this way, Ctrl+C 3952e2fcbf42SPeter Maydell will not terminate QEMU any more but will be passed to the guest 3953e2fcbf42SPeter Maydell instead. 3954e2fcbf42SPeter Maydell 3955e2fcbf42SPeter Maydell ``braille`` 3956e2fcbf42SPeter Maydell Braille device. This will use BrlAPI to display the braille 3957e2fcbf42SPeter Maydell output on a real or fake device. 3958e2fcbf42SPeter Maydell 3959e2fcbf42SPeter Maydell ``msmouse`` 3960e2fcbf42SPeter Maydell Three button serial mouse. Configure the guest to use Microsoft 3961e2fcbf42SPeter Maydell protocol. 3962e2fcbf42SPeter MaydellERST 39635824d651Sblueswir1 39645824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 3965ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 3966ad96090aSBlue Swirl QEMU_ARCH_ALL) 3967e2fcbf42SPeter MaydellSRST 3968e2fcbf42SPeter Maydell``-parallel dev`` 3969e2fcbf42SPeter Maydell Redirect the virtual parallel port to host device dev (same devices 3970e2fcbf42SPeter Maydell as the serial port). On Linux hosts, ``/dev/parportN`` can be used 3971e2fcbf42SPeter Maydell to use hardware devices connected on the corresponding host parallel 3972e2fcbf42SPeter Maydell port. 3973e2fcbf42SPeter Maydell 3974e2fcbf42SPeter Maydell This option can be used several times to simulate up to 3 parallel 3975e2fcbf42SPeter Maydell ports. 3976e2fcbf42SPeter Maydell 3977e2fcbf42SPeter Maydell Use ``-parallel none`` to disable all parallel ports. 3978e2fcbf42SPeter MaydellERST 39795824d651Sblueswir1 39805824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3981ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 3982ad96090aSBlue Swirl QEMU_ARCH_ALL) 3983e2fcbf42SPeter MaydellSRST 3984e2fcbf42SPeter Maydell``-monitor dev`` 3985e2fcbf42SPeter Maydell Redirect the monitor to host device dev (same devices as the serial 3986e2fcbf42SPeter Maydell port). The default device is ``vc`` in graphical mode and ``stdio`` 3987e2fcbf42SPeter Maydell in non graphical mode. Use ``-monitor none`` to disable the default 3988e2fcbf42SPeter Maydell monitor. 3989e2fcbf42SPeter MaydellERST 39906ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3991ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 3992ad96090aSBlue Swirl QEMU_ARCH_ALL) 3993e2fcbf42SPeter MaydellSRST 3994e2fcbf42SPeter Maydell``-qmp dev`` 3995e2fcbf42SPeter Maydell Like -monitor but opens in 'control' mode. 3996e2fcbf42SPeter MaydellERST 39974821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 39984821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 39994821cd4cSMax Reitz QEMU_ARCH_ALL) 4000e2fcbf42SPeter MaydellSRST 4001e2fcbf42SPeter Maydell``-qmp-pretty dev`` 4002e2fcbf42SPeter Maydell Like -qmp but uses pretty JSON formatting. 4003e2fcbf42SPeter MaydellERST 40045824d651Sblueswir1 400522a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 4006ef670726SVicente Jimenez Aguilar "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL) 4007e2fcbf42SPeter MaydellSRST 4008e2fcbf42SPeter Maydell``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]`` 400916b3f3bbSAli Shirvani Setup monitor on chardev name. ``mode=control`` configures 401016b3f3bbSAli Shirvani a QMP monitor (a JSON RPC-style protocol) and it is not the 401116b3f3bbSAli Shirvani same as HMP, the human monitor that has a "(qemu)" prompt. 401216b3f3bbSAli Shirvani ``pretty`` is only valid when ``mode=control``, 401316b3f3bbSAli Shirvani turning on JSON pretty printing to ease 4014283d845cSDaniel P. Berrangé human reading and debugging. 4015e2fcbf42SPeter MaydellERST 401622a0e04bSGerd Hoffmann 4017c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 4018ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 4019ad96090aSBlue Swirl QEMU_ARCH_ALL) 4020e2fcbf42SPeter MaydellSRST 4021e2fcbf42SPeter Maydell``-debugcon dev`` 4022e2fcbf42SPeter Maydell Redirect the debug console to host device dev (same devices as the 4023e2fcbf42SPeter Maydell serial port). The debug console is an I/O port which is typically 4024e2fcbf42SPeter Maydell port 0xe9; writing to that I/O port sends output to this device. The 4025e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 4026e2fcbf42SPeter Maydell graphical mode. 4027e2fcbf42SPeter MaydellERST 4028c9f398e5SH. Peter Anvin 40295824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 4030ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 4031e2fcbf42SPeter MaydellSRST 4032e2fcbf42SPeter Maydell``-pidfile file`` 4033e2fcbf42SPeter Maydell Store the QEMU process PID in file. It is useful if you launch QEMU 4034e2fcbf42SPeter Maydell from a script. 4035e2fcbf42SPeter MaydellERST 40365824d651Sblueswir1 40371b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 4038ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 4039e2fcbf42SPeter MaydellSRST 4040e2fcbf42SPeter Maydell``-singlestep`` 4041e2fcbf42SPeter Maydell Run the emulation in single step mode. 4042e2fcbf42SPeter MaydellERST 40431b530a6dSaurel32 4044047f7038SIgor MammedovDEF("preconfig", 0, QEMU_OPTION_preconfig, \ 4045361ac948SMarkus Armbruster "--preconfig pause QEMU before machine is initialized (experimental)\n", 4046047f7038SIgor Mammedov QEMU_ARCH_ALL) 4047e2fcbf42SPeter MaydellSRST 4048e2fcbf42SPeter Maydell``--preconfig`` 4049e2fcbf42SPeter Maydell Pause QEMU for interactive configuration before the machine is 4050e2fcbf42SPeter Maydell created, which allows querying and configuring properties that will 4051e2fcbf42SPeter Maydell affect machine initialization. Use QMP command 'x-exit-preconfig' to 4052e2fcbf42SPeter Maydell exit the preconfig state and move to the next state (i.e. run guest 4053e2fcbf42SPeter Maydell if -S isn't used or pause the second time if -S is used). This 4054e2fcbf42SPeter Maydell option is experimental. 4055e2fcbf42SPeter MaydellERST 4056047f7038SIgor Mammedov 40575824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 4058ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 4059ad96090aSBlue Swirl QEMU_ARCH_ALL) 4060e2fcbf42SPeter MaydellSRST 4061e2fcbf42SPeter Maydell``-S`` 4062e2fcbf42SPeter Maydell Do not start CPU at startup (you must type 'c' in the monitor). 4063e2fcbf42SPeter MaydellERST 40645824d651Sblueswir1 40656f131f13SMichael S. TsirkinDEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit, 4066dfaa7d50SBALATON Zoltan "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n" 40676f131f13SMichael S. Tsirkin " run qemu with overcommit hints\n" 40686f131f13SMichael S. Tsirkin " mem-lock=on|off controls memory lock support (default: off)\n" 40696f131f13SMichael S. Tsirkin " cpu-pm=on|off controls cpu power management (default: off)\n", 40706f131f13SMichael S. Tsirkin QEMU_ARCH_ALL) 4071e2fcbf42SPeter MaydellSRST 4072e2fcbf42SPeter Maydell``-overcommit mem-lock=on|off`` 407309ce5f2dSPeter Maydell \ 4074e2fcbf42SPeter Maydell``-overcommit cpu-pm=on|off`` 4075e2fcbf42SPeter Maydell Run qemu with hints about host resource overcommit. The default is 4076e2fcbf42SPeter Maydell to assume that host overcommits all resources. 4077e2fcbf42SPeter Maydell 4078e2fcbf42SPeter Maydell Locking qemu and guest memory can be enabled via ``mem-lock=on`` 4079e2fcbf42SPeter Maydell (disabled by default). This works when host memory is not 4080c8c9dc42SThomas Huth overcommitted and reduces the worst-case latency for guest. 4081e2fcbf42SPeter Maydell 4082e2fcbf42SPeter Maydell Guest ability to manage power state of host cpus (increasing latency 4083e2fcbf42SPeter Maydell for other processes on the same host cpu, but decreasing latency for 4084e2fcbf42SPeter Maydell guest) can be enabled via ``cpu-pm=on`` (disabled by default). This 4085e2fcbf42SPeter Maydell works best when host CPU is not overcommitted. When used, host 4086e2fcbf42SPeter Maydell estimates of CPU cycle and power utilization will be incorrect, not 4087e2fcbf42SPeter Maydell taking into account guest idle time. 4088e2fcbf42SPeter MaydellERST 40896f131f13SMichael S. Tsirkin 409059030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 4091e5910d42SPeter Maydell "-gdb dev accept gdb connection on 'dev'. (QEMU defaults to starting\n" 4092e5910d42SPeter Maydell " the guest without waiting for gdb to connect; use -S too\n" 4093e5910d42SPeter Maydell " if you want it to not start execution.)\n", 4094e5910d42SPeter Maydell QEMU_ARCH_ALL) 4095e2fcbf42SPeter MaydellSRST 4096e2fcbf42SPeter Maydell``-gdb dev`` 4097923e9311SThomas Huth Accept a gdb connection on device dev (see the :ref:`GDB usage` chapter 4098923e9311SThomas Huth in the System Emulation Users Guide). Note that this option does not pause QEMU 4099e5910d42SPeter Maydell execution -- if you want QEMU to not start the guest until you 4100e5910d42SPeter Maydell connect with gdb and issue a ``continue`` command, you will need to 4101e5910d42SPeter Maydell also pass the ``-S`` option to QEMU. 4102e5910d42SPeter Maydell 4103e5910d42SPeter Maydell The most usual configuration is to listen on a local TCP socket:: 4104e5910d42SPeter Maydell 4105e5910d42SPeter Maydell -gdb tcp::3117 4106e5910d42SPeter Maydell 4107e5910d42SPeter Maydell but you can specify other backends; UDP, pseudo TTY, or even stdio 4108e5910d42SPeter Maydell are all reasonable use cases. For example, a stdio connection 4109e5910d42SPeter Maydell allows you to start QEMU from within gdb and establish the 4110e5910d42SPeter Maydell connection via a pipe: 4111e2fcbf42SPeter Maydell 411209ce5f2dSPeter Maydell .. parsed-literal:: 4113e2fcbf42SPeter Maydell 4114e2fcbf42SPeter Maydell (gdb) target remote | exec |qemu_system| -gdb stdio ... 4115e2fcbf42SPeter MaydellERST 41165824d651Sblueswir1 411759030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 4118ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 4119ad96090aSBlue Swirl QEMU_ARCH_ALL) 4120e2fcbf42SPeter MaydellSRST 4121e2fcbf42SPeter Maydell``-s`` 4122e2fcbf42SPeter Maydell Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 4123923e9311SThomas Huth (see the :ref:`GDB usage` chapter in the System Emulation Users Guide). 4124e2fcbf42SPeter MaydellERST 41255824d651Sblueswir1 41265824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 4127989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 4128ad96090aSBlue Swirl QEMU_ARCH_ALL) 4129e2fcbf42SPeter MaydellSRST 4130e2fcbf42SPeter Maydell``-d item1[,...]`` 4131e2fcbf42SPeter Maydell Enable logging of specified items. Use '-d help' for a list of log 4132e2fcbf42SPeter Maydell items. 4133e2fcbf42SPeter MaydellERST 41345824d651Sblueswir1 4135c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 4136989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 4137c235d738SMatthew Fernandez QEMU_ARCH_ALL) 4138e2fcbf42SPeter MaydellSRST 4139e2fcbf42SPeter Maydell``-D logfile`` 4140e2fcbf42SPeter Maydell Output log in logfile instead of to stderr 4141e2fcbf42SPeter MaydellERST 4142c235d738SMatthew Fernandez 41433514552eSAlex BennéeDEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 41443514552eSAlex Bennée "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 41453514552eSAlex Bennée QEMU_ARCH_ALL) 4146e2fcbf42SPeter MaydellSRST 4147e2fcbf42SPeter Maydell``-dfilter range1[,...]`` 4148e2fcbf42SPeter Maydell Filter debug output to that relevant to a range of target addresses. 4149e2fcbf42SPeter Maydell The filter spec can be either start+size, start-size or start..end 4150e2fcbf42SPeter Maydell where start end and size are the addresses and sizes required. For 4151e2fcbf42SPeter Maydell example: 4152e2fcbf42SPeter Maydell 4153e2fcbf42SPeter Maydell :: 4154e2fcbf42SPeter Maydell 4155e2fcbf42SPeter Maydell -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 4156e2fcbf42SPeter Maydell 4157e2fcbf42SPeter Maydell Will dump output for any code in the 0x1000 sized block starting at 4158e2fcbf42SPeter Maydell 0x8000 and the 0x200 sized block starting at 0xffffffc000080000 and 4159e2fcbf42SPeter Maydell another 0x1000 sized block starting at 0xffffffc00005f000. 4160e2fcbf42SPeter MaydellERST 41613514552eSAlex Bennée 41629c09a251SRichard HendersonDEF("seed", HAS_ARG, QEMU_OPTION_seed, \ 41639c09a251SRichard Henderson "-seed number seed the pseudo-random number generator\n", 41649c09a251SRichard Henderson QEMU_ARCH_ALL) 4165e2fcbf42SPeter MaydellSRST 4166e2fcbf42SPeter Maydell``-seed number`` 4167e2fcbf42SPeter Maydell Force the guest to use a deterministic pseudo-random number 4168e2fcbf42SPeter Maydell generator, seeded with number. This does not affect crypto routines 4169e2fcbf42SPeter Maydell within the host. 4170e2fcbf42SPeter MaydellERST 41719c09a251SRichard Henderson 41725824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 4173ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 4174ad96090aSBlue Swirl QEMU_ARCH_ALL) 4175e2fcbf42SPeter MaydellSRST 4176e2fcbf42SPeter Maydell``-L path`` 4177e2fcbf42SPeter Maydell Set the directory for the BIOS, VGA BIOS and keymaps. 4178e2fcbf42SPeter Maydell 4179e2fcbf42SPeter Maydell To list all the data directories, use ``-L help``. 4180e2fcbf42SPeter MaydellERST 41815824d651Sblueswir1 41825824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 4183ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 4184e2fcbf42SPeter MaydellSRST 4185e2fcbf42SPeter Maydell``-bios file`` 4186e2fcbf42SPeter Maydell Set the filename for the BIOS. 4187e2fcbf42SPeter MaydellERST 41885824d651Sblueswir1 41895824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 419021abf010SThomas Huth "-enable-kvm enable KVM full virtualization support\n", 419121abf010SThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386 | QEMU_ARCH_MIPS | QEMU_ARCH_PPC | 419221abf010SThomas Huth QEMU_ARCH_RISCV | QEMU_ARCH_S390X) 4193e2fcbf42SPeter MaydellSRST 4194e2fcbf42SPeter Maydell``-enable-kvm`` 4195e2fcbf42SPeter Maydell Enable KVM full virtualization support. This option is only 4196e2fcbf42SPeter Maydell available if KVM support is enabled when compiling. 4197e2fcbf42SPeter MaydellERST 41985824d651Sblueswir1 4199e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 4200eeb3647cSThomas Huth "-xen-domid id specify xen guest domain id\n", 4201eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 4202e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 4203e37630caSaliguori "-xen-attach attach to existing xen domain\n" 42041077bcacSAnthony PERARD " libxl will use this when starting QEMU\n", 4205eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 42061c599472SPaul DurrantDEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict, 42071c599472SPaul Durrant "-xen-domid-restrict restrict set of available xen operations\n" 42081c599472SPaul Durrant " to specified domain id. (Does not affect\n" 42091c599472SPaul Durrant " xenpv machine type).\n", 4210eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 4211e2fcbf42SPeter MaydellSRST 4212e2fcbf42SPeter Maydell``-xen-domid id`` 4213e2fcbf42SPeter Maydell Specify xen guest domain id (XEN only). 4214e2fcbf42SPeter Maydell 4215e2fcbf42SPeter Maydell``-xen-attach`` 4216e2fcbf42SPeter Maydell Attach to existing xen domain. libxl will use this when starting 4217e2fcbf42SPeter Maydell QEMU (XEN only). Restrict set of available xen operations to 4218e2fcbf42SPeter Maydell specified domain id (XEN only). 4219e2fcbf42SPeter MaydellERST 4220e37630caSaliguori 42215824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 4222ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 4223e2fcbf42SPeter MaydellSRST 4224e2fcbf42SPeter Maydell``-no-reboot`` 4225e2fcbf42SPeter Maydell Exit instead of rebooting. 4226e2fcbf42SPeter MaydellERST 42275824d651Sblueswir1 42285824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 4229ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 4230e2fcbf42SPeter MaydellSRST 4231e2fcbf42SPeter Maydell``-no-shutdown`` 4232e2fcbf42SPeter Maydell Don't exit QEMU on guest shutdown, but instead only stop the 4233e2fcbf42SPeter Maydell emulation. This allows for instance switching to monitor to commit 4234e2fcbf42SPeter Maydell changes to the disk image. 4235e2fcbf42SPeter MaydellERST 42365824d651Sblueswir1 42372a5ad60bSAlejandro JimenezDEF("action", HAS_ARG, QEMU_OPTION_action, 4238c27025e0SPaolo Bonzini "-action reboot=reset|shutdown\n" 4239c27025e0SPaolo Bonzini " action when guest reboots [default=reset]\n" 42402a5ad60bSAlejandro Jimenez "-action shutdown=poweroff|pause\n" 42412a5ad60bSAlejandro Jimenez " action when guest shuts down [default=poweroff]\n" 4242c27025e0SPaolo Bonzini "-action panic=pause|shutdown|none\n" 4243c27025e0SPaolo Bonzini " action when guest panics [default=shutdown]\n" 42442a5ad60bSAlejandro Jimenez "-action watchdog=reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" 42452a5ad60bSAlejandro Jimenez " action when watchdog fires [default=reset]\n", 42462a5ad60bSAlejandro Jimenez QEMU_ARCH_ALL) 42472a5ad60bSAlejandro JimenezSRST 42482a5ad60bSAlejandro Jimenez``-action event=action`` 42492a5ad60bSAlejandro Jimenez The action parameter serves to modify QEMU's default behavior when 42502a5ad60bSAlejandro Jimenez certain guest events occur. It provides a generic method for specifying the 42512a5ad60bSAlejandro Jimenez same behaviors that are modified by the ``-no-reboot`` and ``-no-shutdown`` 42522a5ad60bSAlejandro Jimenez parameters. 42532a5ad60bSAlejandro Jimenez 42542a5ad60bSAlejandro Jimenez Examples: 42552a5ad60bSAlejandro Jimenez 4256c753e8e7SAlejandro Jimenez ``-action panic=none`` 42572a5ad60bSAlejandro Jimenez ``-action reboot=shutdown,shutdown=pause`` 42582a5ad60bSAlejandro Jimenez ``-watchdog i6300esb -action watchdog=pause`` 42592a5ad60bSAlejandro Jimenez 42602a5ad60bSAlejandro JimenezERST 42612a5ad60bSAlejandro Jimenez 42625824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 42635824d651Sblueswir1 "-loadvm [tag|id]\n" \ 4264ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 4265ad96090aSBlue Swirl QEMU_ARCH_ALL) 4266e2fcbf42SPeter MaydellSRST 4267e2fcbf42SPeter Maydell``-loadvm file`` 4268e2fcbf42SPeter Maydell Start right away with a saved state (``loadvm`` in monitor) 4269e2fcbf42SPeter MaydellERST 42705824d651Sblueswir1 42715824d651Sblueswir1#ifndef _WIN32 42725824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 4273ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 42745824d651Sblueswir1#endif 4275e2fcbf42SPeter MaydellSRST 4276e2fcbf42SPeter Maydell``-daemonize`` 4277e2fcbf42SPeter Maydell Daemonize the QEMU process after initialization. QEMU will not 4278e2fcbf42SPeter Maydell detach from standard IO until it is ready to receive connections on 4279e2fcbf42SPeter Maydell any of its devices. This option is a useful way for external 4280e2fcbf42SPeter Maydell programs to launch QEMU without having to cope with initialization 4281e2fcbf42SPeter Maydell race conditions. 4282e2fcbf42SPeter MaydellERST 42835824d651Sblueswir1 42845824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 4285ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 4286ad96090aSBlue Swirl QEMU_ARCH_ALL) 4287e2fcbf42SPeter MaydellSRST 4288e2fcbf42SPeter Maydell``-option-rom file`` 4289e2fcbf42SPeter Maydell Load the contents of file as an option ROM. This option is useful to 4290e2fcbf42SPeter Maydell load things like EtherBoot. 4291e2fcbf42SPeter MaydellERST 42925824d651Sblueswir1 42931ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 4294238d1240SArtem Pisarenko "-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 4295ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 4296ad96090aSBlue Swirl QEMU_ARCH_ALL) 42971ed2fc1fSJan Kiszka 4298e2fcbf42SPeter MaydellSRST 4299e2fcbf42SPeter Maydell``-rtc [base=utc|localtime|datetime][,clock=host|rt|vm][,driftfix=none|slew]`` 4300e2fcbf42SPeter Maydell Specify ``base`` as ``utc`` or ``localtime`` to let the RTC start at 4301e2fcbf42SPeter Maydell the current UTC or local time, respectively. ``localtime`` is 4302e2fcbf42SPeter Maydell required for correct date in MS-DOS or Windows. To start at a 4303e2fcbf42SPeter Maydell specific point in time, provide datetime in the format 4304e2fcbf42SPeter Maydell ``2006-06-17T16:01:21`` or ``2006-06-17``. The default base is UTC. 4305e2fcbf42SPeter Maydell 4306e2fcbf42SPeter Maydell By default the RTC is driven by the host system time. This allows 4307e2fcbf42SPeter Maydell using of the RTC as accurate reference clock inside the guest, 4308e2fcbf42SPeter Maydell specifically if the host time is smoothly following an accurate 4309e2fcbf42SPeter Maydell external reference clock, e.g. via NTP. If you want to isolate the 4310e2fcbf42SPeter Maydell guest time from the host, you can set ``clock`` to ``rt`` instead, 4311e2fcbf42SPeter Maydell which provides a host monotonic clock if host support it. To even 4312e2fcbf42SPeter Maydell prevent the RTC from progressing during suspension, you can set 4313e2fcbf42SPeter Maydell ``clock`` to ``vm`` (virtual clock). '\ ``clock=vm``\ ' is 4314e2fcbf42SPeter Maydell recommended especially in icount mode in order to preserve 4315e2fcbf42SPeter Maydell determinism; however, note that in icount mode the speed of the 4316e2fcbf42SPeter Maydell virtual clock is variable and can in general differ from the host 4317e2fcbf42SPeter Maydell clock. 4318e2fcbf42SPeter Maydell 4319e2fcbf42SPeter Maydell Enable ``driftfix`` (i386 targets only) if you experience time drift 4320e2fcbf42SPeter Maydell problems, specifically with Windows' ACPI HAL. This option will try 4321e2fcbf42SPeter Maydell to figure out how many timer interrupts were not processed by the 4322e2fcbf42SPeter Maydell Windows guest and will re-inject them. 4323e2fcbf42SPeter MaydellERST 43245824d651Sblueswir1 43255824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 4326fa647905SPeter Maydell "-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=<filename>[,rrsnapshot=<snapshot>]]\n" \ 4327bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 4328f1f4b57eSVictor CLEMENT " instruction, enable aligning the host and virtual clocks\n" \ 4329fa647905SPeter Maydell " or disable real time cpu sleeping, and optionally enable\n" \ 4330fa647905SPeter Maydell " record-and-replay mode\n", QEMU_ARCH_ALL) 4331e2fcbf42SPeter MaydellSRST 4332fa647905SPeter Maydell``-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=filename[,rrsnapshot=snapshot]]`` 4333e2fcbf42SPeter Maydell Enable virtual instruction counter. The virtual cpu will execute one 4334e2fcbf42SPeter Maydell instruction every 2^N ns of virtual time. If ``auto`` is specified 4335e2fcbf42SPeter Maydell then the virtual cpu speed will be automatically adjusted to keep 4336e2fcbf42SPeter Maydell virtual time within a few seconds of real time. 4337e2fcbf42SPeter Maydell 4338e2fcbf42SPeter Maydell Note that while this option can give deterministic behavior, it does 4339e2fcbf42SPeter Maydell not provide cycle accurate emulation. Modern CPUs contain 4340e2fcbf42SPeter Maydell superscalar out of order cores with complex cache hierarchies. The 4341e2fcbf42SPeter Maydell number of instructions executed often has little or no correlation 4342e2fcbf42SPeter Maydell with actual performance. 4343e2fcbf42SPeter Maydell 4344fa647905SPeter Maydell When the virtual cpu is sleeping, the virtual time will advance at 4345fa647905SPeter Maydell default speed unless ``sleep=on`` is specified. With 4346fa647905SPeter Maydell ``sleep=on``, the virtual time will jump to the next timer 4347fa647905SPeter Maydell deadline instantly whenever the virtual cpu goes to sleep mode and 4348fa647905SPeter Maydell will not advance if no timer is enabled. This behavior gives 4349fa647905SPeter Maydell deterministic execution times from the guest point of view. 4350fa647905SPeter Maydell The default if icount is enabled is ``sleep=off``. 4351fa647905SPeter Maydell ``sleep=on`` cannot be used together with either ``shift=auto`` 4352fa647905SPeter Maydell or ``align=on``. 4353fa647905SPeter Maydell 4354e2fcbf42SPeter Maydell ``align=on`` will activate the delay algorithm which will try to 4355e2fcbf42SPeter Maydell synchronise the host clock and the virtual clock. The goal is to 4356e2fcbf42SPeter Maydell have a guest running at the real frequency imposed by the shift 4357e2fcbf42SPeter Maydell option. Whenever the guest clock is behind the host clock and if 4358e2fcbf42SPeter Maydell ``align=on`` is specified then we print a message to the user to 4359e2fcbf42SPeter Maydell inform about the delay. Currently this option does not work when 4360e2fcbf42SPeter Maydell ``shift`` is ``auto``. Note: The sync algorithm will work for those 4361e2fcbf42SPeter Maydell shift values for which the guest clock runs ahead of the host clock. 4362e2fcbf42SPeter Maydell Typically this happens when the shift value is high (how high 4363fa647905SPeter Maydell depends on the host machine). The default if icount is enabled 4364fa647905SPeter Maydell is ``align=off``. 4365e2fcbf42SPeter Maydell 4366fa647905SPeter Maydell When the ``rr`` option is specified deterministic record/replay is 4367fa647905SPeter Maydell enabled. The ``rrfile=`` option must also be provided to 4368fa647905SPeter Maydell specify the path to the replay log. In record mode data is written 4369fa647905SPeter Maydell to this file, and in replay mode it is read back. 4370fa647905SPeter Maydell If the ``rrsnapshot`` option is given then it specifies a VM snapshot 4371fa647905SPeter Maydell name. In record mode, a new VM snapshot with the given name is created 4372fa647905SPeter Maydell at the start of execution recording. In replay mode this option 4373fa647905SPeter Maydell specifies the snapshot name used to load the initial VM state. 4374e2fcbf42SPeter MaydellERST 43755824d651Sblueswir1 43769dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 4377d7933ef3SXu Wang "-watchdog model\n" \ 4378ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 4379ad96090aSBlue Swirl QEMU_ARCH_ALL) 4380e2fcbf42SPeter MaydellSRST 4381e2fcbf42SPeter Maydell``-watchdog model`` 4382e2fcbf42SPeter Maydell Create a virtual hardware watchdog device. Once enabled (by a guest 4383e2fcbf42SPeter Maydell action), the watchdog must be periodically polled by an agent inside 4384e2fcbf42SPeter Maydell the guest or else the guest will be restarted. Choose a model for 4385e2fcbf42SPeter Maydell which your guest has drivers. 4386e2fcbf42SPeter Maydell 4387e2fcbf42SPeter Maydell The model is the model of hardware watchdog to emulate. Use 4388e2fcbf42SPeter Maydell ``-watchdog help`` to list available hardware models. Only one 4389e2fcbf42SPeter Maydell watchdog can be enabled for a guest. 4390e2fcbf42SPeter Maydell 4391e2fcbf42SPeter Maydell The following models may be available: 4392e2fcbf42SPeter Maydell 4393e2fcbf42SPeter Maydell ``ib700`` 4394e2fcbf42SPeter Maydell iBASE 700 is a very simple ISA watchdog with a single timer. 4395e2fcbf42SPeter Maydell 4396e2fcbf42SPeter Maydell ``i6300esb`` 4397e2fcbf42SPeter Maydell Intel 6300ESB I/O controller hub is a much more featureful 4398e2fcbf42SPeter Maydell PCI-based dual-timer watchdog. 4399e2fcbf42SPeter Maydell 4400e2fcbf42SPeter Maydell ``diag288`` 4401e2fcbf42SPeter Maydell A virtual watchdog for s390x backed by the diagnose 288 4402e2fcbf42SPeter Maydell hypercall (currently KVM only). 4403e2fcbf42SPeter MaydellERST 44049dd986ccSRichard W.M. Jones 44059dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 44067ad9270eSMarkus Armbruster "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \ 4407ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 4408ad96090aSBlue Swirl QEMU_ARCH_ALL) 4409e2fcbf42SPeter MaydellSRST 4410e2fcbf42SPeter Maydell``-watchdog-action action`` 4411e2fcbf42SPeter Maydell The action controls what QEMU will do when the watchdog timer 4412e2fcbf42SPeter Maydell expires. The default is ``reset`` (forcefully reset the guest). 4413e2fcbf42SPeter Maydell Other possible actions are: ``shutdown`` (attempt to gracefully 4414e2fcbf42SPeter Maydell shutdown the guest), ``poweroff`` (forcefully poweroff the guest), 4415e2fcbf42SPeter Maydell ``inject-nmi`` (inject a NMI into the guest), ``pause`` (pause the 4416e2fcbf42SPeter Maydell guest), ``debug`` (print a debug message and continue), or ``none`` 4417e2fcbf42SPeter Maydell (do nothing). 4418e2fcbf42SPeter Maydell 4419e2fcbf42SPeter Maydell Note that the ``shutdown`` action requires that the guest responds 4420e2fcbf42SPeter Maydell to ACPI signals, which it may not be able to do in the sort of 4421e2fcbf42SPeter Maydell situations where the watchdog would have expired, and thus 4422e2fcbf42SPeter Maydell ``-watchdog-action shutdown`` is not recommended for production use. 4423e2fcbf42SPeter Maydell 4424e2fcbf42SPeter Maydell Examples: 4425e2fcbf42SPeter Maydell 4426e2fcbf42SPeter Maydell ``-watchdog i6300esb -watchdog-action pause``; \ ``-watchdog ib700`` 4427e2fcbf42SPeter Maydell 4428e2fcbf42SPeter MaydellERST 44299dd986ccSRichard W.M. Jones 44305824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 4431ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 4432ad96090aSBlue Swirl QEMU_ARCH_ALL) 4433e2fcbf42SPeter MaydellSRST 4434e2fcbf42SPeter Maydell``-echr numeric_ascii_value`` 4435e2fcbf42SPeter Maydell Change the escape character used for switching to the monitor when 4436e2fcbf42SPeter Maydell using monitor and serial sharing. The default is ``0x01`` when using 4437e2fcbf42SPeter Maydell the ``-nographic`` option. ``0x01`` is equal to pressing 4438e2fcbf42SPeter Maydell ``Control-a``. You can select a different character from the ascii 4439e2fcbf42SPeter Maydell control keys where 1 through 26 map to Control-a through Control-z. 4440e2fcbf42SPeter Maydell For instance you could use the either of the following to change the 4441e2fcbf42SPeter Maydell escape character to Control-t. 4442e2fcbf42SPeter Maydell 4443e2fcbf42SPeter Maydell ``-echr 0x14``; \ ``-echr 20`` 4444e2fcbf42SPeter Maydell 4445e2fcbf42SPeter MaydellERST 44465824d651Sblueswir1 44475824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 4448bf24095fSDaniel P. Berrangé "-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]\n" \ 4449bf24095fSDaniel P. Berrangé "-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]\n" \ 44507c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 44517c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 44527c601803SMichael Tokarev " specified protocol and socket address\n" \ 44537c601803SMichael Tokarev "-incoming fd:fd\n" \ 44547c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 44557c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 44561597051bSDr. David Alan Gilbert " or from given external command\n" \ 44571597051bSDr. David Alan Gilbert "-incoming defer\n" \ 44581597051bSDr. David Alan Gilbert " wait for the URI to be specified via migrate_incoming\n", 4459ad96090aSBlue Swirl QEMU_ARCH_ALL) 4460e2fcbf42SPeter MaydellSRST 4461bf24095fSDaniel P. Berrangé``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]`` 446209ce5f2dSPeter Maydell \ 4463bf24095fSDaniel P. Berrangé``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]`` 4464e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given tcp port. 4465e2fcbf42SPeter Maydell 4466e2fcbf42SPeter Maydell``-incoming unix:socketpath`` 4467e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given unix socket. 4468e2fcbf42SPeter Maydell 4469e2fcbf42SPeter Maydell``-incoming fd:fd`` 4470e2fcbf42SPeter Maydell Accept incoming migration from a given filedescriptor. 4471e2fcbf42SPeter Maydell 4472e2fcbf42SPeter Maydell``-incoming exec:cmdline`` 4473e2fcbf42SPeter Maydell Accept incoming migration as an output from specified external 4474e2fcbf42SPeter Maydell command. 4475e2fcbf42SPeter Maydell 4476e2fcbf42SPeter Maydell``-incoming defer`` 4477e2fcbf42SPeter Maydell Wait for the URI to be specified via migrate\_incoming. The monitor 4478e2fcbf42SPeter Maydell can be used to change settings (such as migration parameters) prior 4479e2fcbf42SPeter Maydell to issuing the migrate\_incoming to allow the migration to begin. 4480e2fcbf42SPeter MaydellERST 44815824d651Sblueswir1 4482d15c05fcSAshijeet AcharyaDEF("only-migratable", 0, QEMU_OPTION_only_migratable, \ 4483d15c05fcSAshijeet Acharya "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL) 4484e2fcbf42SPeter MaydellSRST 4485e2fcbf42SPeter Maydell``-only-migratable`` 4486e2fcbf42SPeter Maydell Only allow migratable devices. Devices will not be allowed to enter 4487e2fcbf42SPeter Maydell an unmigratable state. 4488e2fcbf42SPeter MaydellERST 4489d15c05fcSAshijeet Acharya 4490d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 4491ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 4492e2fcbf42SPeter MaydellSRST 4493e2fcbf42SPeter Maydell``-nodefaults`` 4494e2fcbf42SPeter Maydell Don't create default devices. Normally, QEMU sets the default 4495e2fcbf42SPeter Maydell devices like serial port, parallel port, virtual console, monitor 4496e2fcbf42SPeter Maydell device, VGA adapter, floppy and CD-ROM drive and others. The 4497e2fcbf42SPeter Maydell ``-nodefaults`` option will disable all those default devices. 4498e2fcbf42SPeter MaydellERST 4499d8c208ddSGerd Hoffmann 45005824d651Sblueswir1#ifndef _WIN32 45015824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 4502ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 4503ad96090aSBlue Swirl QEMU_ARCH_ALL) 45045824d651Sblueswir1#endif 4505e2fcbf42SPeter MaydellSRST 4506e2fcbf42SPeter Maydell``-chroot dir`` 4507e2fcbf42SPeter Maydell Immediately before starting guest execution, chroot to the specified 4508e2fcbf42SPeter Maydell directory. Especially useful in combination with -runas. 4509e2fcbf42SPeter MaydellERST 45105824d651Sblueswir1 45115824d651Sblueswir1#ifndef _WIN32 45125824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 45132c42f1e8SIan Jackson "-runas user change to user id user just before starting the VM\n" \ 45142c42f1e8SIan Jackson " user can be numeric uid:gid instead\n", 4515ad96090aSBlue Swirl QEMU_ARCH_ALL) 45165824d651Sblueswir1#endif 4517e2fcbf42SPeter MaydellSRST 4518e2fcbf42SPeter Maydell``-runas user`` 4519e2fcbf42SPeter Maydell Immediately before starting guest execution, drop root privileges, 4520e2fcbf42SPeter Maydell switching to the specified user. 4521e2fcbf42SPeter MaydellERST 45225824d651Sblueswir1 45235824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 45245824d651Sblueswir1 "-prom-env variable=value\n" 4525ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 4526ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 4527e2fcbf42SPeter MaydellSRST 4528e2fcbf42SPeter Maydell``-prom-env variable=value`` 4529e2fcbf42SPeter Maydell Set OpenBIOS nvram variable to given value (PPC, SPARC only). 4530e2fcbf42SPeter Maydell 4531e2fcbf42SPeter Maydell :: 4532e2fcbf42SPeter Maydell 4533e2fcbf42SPeter Maydell qemu-system-sparc -prom-env 'auto-boot?=false' \ 4534e2fcbf42SPeter Maydell -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' 4535e2fcbf42SPeter Maydell 4536e2fcbf42SPeter Maydell :: 4537e2fcbf42SPeter Maydell 4538e2fcbf42SPeter Maydell qemu-system-ppc -prom-env 'auto-boot?=false' \ 4539e2fcbf42SPeter Maydell -prom-env 'boot-device=hd:2,\yaboot' \ 4540e2fcbf42SPeter Maydell -prom-env 'boot-args=conf=hd:2,\yaboot.conf' 4541e2fcbf42SPeter MaydellERST 45425824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 4543f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 45449d49bcf6SMarkus Armbruster QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | 4545a10b9d93SKeith Packard QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4546e2fcbf42SPeter MaydellSRST 4547e2fcbf42SPeter Maydell``-semihosting`` 4548a10b9d93SKeith Packard Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V only). 4549e2fcbf42SPeter Maydell 4550e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4551e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4552e2fcbf42SPeter Maydell 4553e2fcbf42SPeter Maydell See the -semihosting-config option documentation for further 4554e2fcbf42SPeter Maydell information about the facilities this enables. 4555e2fcbf42SPeter MaydellERST 4556a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 45574e7f9032SAlex Bennée "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \ 4558a59d31a1SLeon Alrae " semihosting configuration\n", 45599d49bcf6SMarkus ArmbrusterQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | 4560a10b9d93SKeith PackardQEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4561e2fcbf42SPeter MaydellSRST 4562e2fcbf42SPeter Maydell``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]`` 4563a10b9d93SKeith Packard Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V 4564e2fcbf42SPeter Maydell only). 4565e2fcbf42SPeter Maydell 4566e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4567e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4568e2fcbf42SPeter Maydell 4569e2fcbf42SPeter Maydell On Arm this implements the standard semihosting API, version 2.0. 4570e2fcbf42SPeter Maydell 4571e2fcbf42SPeter Maydell On M68K this implements the "ColdFire GDB" interface used by 4572e2fcbf42SPeter Maydell libgloss. 4573e2fcbf42SPeter Maydell 4574e2fcbf42SPeter Maydell Xtensa semihosting provides basic file IO calls, such as 4575e2fcbf42SPeter Maydell open/read/write/seek/select. Tensilica baremetal libc for ISS and 4576e2fcbf42SPeter Maydell linux platform "sim" use this interface. 4577e2fcbf42SPeter Maydell 4578a10b9d93SKeith Packard On RISC-V this implements the standard semihosting API, version 0.2. 4579a10b9d93SKeith Packard 4580e2fcbf42SPeter Maydell ``target=native|gdb|auto`` 4581e2fcbf42SPeter Maydell Defines where the semihosting calls will be addressed, to QEMU 4582e2fcbf42SPeter Maydell (``native``) or to GDB (``gdb``). The default is ``auto``, which 4583e2fcbf42SPeter Maydell means ``gdb`` during debug sessions and ``native`` otherwise. 4584e2fcbf42SPeter Maydell 4585e2fcbf42SPeter Maydell ``chardev=str1`` 4586e2fcbf42SPeter Maydell Send the output to a chardev backend output for native or auto 4587e2fcbf42SPeter Maydell output when not in gdb 4588e2fcbf42SPeter Maydell 4589e2fcbf42SPeter Maydell ``arg=str1,arg=str2,...`` 4590e2fcbf42SPeter Maydell Allows the user to pass input arguments, and can be used 4591e2fcbf42SPeter Maydell multiple times to build up a list. The old-style 4592e2fcbf42SPeter Maydell ``-kernel``/``-append`` method of passing a command line is 4593e2fcbf42SPeter Maydell still supported for backward compatibility. If both the 4594e2fcbf42SPeter Maydell ``--semihosting-config arg`` and the ``-kernel``/``-append`` are 4595e2fcbf42SPeter Maydell specified, the former is passed to semihosting as it always 4596e2fcbf42SPeter Maydell takes precedence. 4597e2fcbf42SPeter MaydellERST 45985824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 4599ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 4600e2fcbf42SPeter MaydellSRST 4601e2fcbf42SPeter Maydell``-old-param`` 4602e2fcbf42SPeter Maydell Old param mode (ARM only). 4603e2fcbf42SPeter MaydellERST 460495d5f08bSStefan Weil 46057d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 460673a1e647SEduardo Otubo "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \ 460724f8cdc5SEduardo Otubo " [,spawn=allow|deny][,resourcecontrol=allow|deny]\n" \ 46082b716fa6SEduardo Otubo " Enable seccomp mode 2 system call filter (default 'off').\n" \ 46092b716fa6SEduardo Otubo " use 'obsolete' to allow obsolete system calls that are provided\n" \ 46102b716fa6SEduardo Otubo " by the kernel, but typically no longer used by modern\n" \ 461173a1e647SEduardo Otubo " C library implementations.\n" \ 4612d42304b1SPhilippe Mathieu-Daudé " use 'elevateprivileges' to allow or deny the QEMU process ability\n" \ 4613d42304b1SPhilippe Mathieu-Daudé " to elevate privileges using set*uid|gid system calls.\n" \ 461473a1e647SEduardo Otubo " The value 'children' will deny set*uid|gid system calls for\n" \ 4615995a226fSEduardo Otubo " main QEMU process but will allow forks and execves to run unprivileged\n" \ 4616995a226fSEduardo Otubo " use 'spawn' to avoid QEMU to spawn new threads or processes by\n" \ 4617d42304b1SPhilippe Mathieu-Daudé " blocking *fork and execve\n" \ 461824f8cdc5SEduardo Otubo " use 'resourcecontrol' to disable process affinity and schedular priority\n", 46197d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 4620e2fcbf42SPeter MaydellSRST 4621e2fcbf42SPeter Maydell``-sandbox arg[,obsolete=string][,elevateprivileges=string][,spawn=string][,resourcecontrol=string]`` 4622e2fcbf42SPeter Maydell Enable Seccomp mode 2 system call filter. 'on' will enable syscall 4623e2fcbf42SPeter Maydell filtering and 'off' will disable it. The default is 'off'. 4624e2fcbf42SPeter Maydell 4625e2fcbf42SPeter Maydell ``obsolete=string`` 4626e2fcbf42SPeter Maydell Enable Obsolete system calls 4627e2fcbf42SPeter Maydell 4628e2fcbf42SPeter Maydell ``elevateprivileges=string`` 4629e2fcbf42SPeter Maydell Disable set\*uid\|gid system calls 4630e2fcbf42SPeter Maydell 4631e2fcbf42SPeter Maydell ``spawn=string`` 4632e2fcbf42SPeter Maydell Disable \*fork and execve 4633e2fcbf42SPeter Maydell 4634e2fcbf42SPeter Maydell ``resourcecontrol=string`` 4635e2fcbf42SPeter Maydell Disable process affinity and schedular priority 4636e2fcbf42SPeter MaydellERST 46377d76ad4fSEduardo Otubo 4638715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 4639e960a7eeSPaolo Bonzini "-readconfig <file>\n" 4640e960a7eeSPaolo Bonzini " read config file\n", QEMU_ARCH_ALL) 4641e2fcbf42SPeter MaydellSRST 4642e2fcbf42SPeter Maydell``-readconfig file`` 4643e2fcbf42SPeter Maydell Read device configuration from file. This approach is useful when 4644e2fcbf42SPeter Maydell you want to spawn QEMU process with many command line options but 4645e2fcbf42SPeter Maydell you don't want to exceed the command line character limit. 4646e2fcbf42SPeter MaydellERST 46472feac451SThomas Huth 4648f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 4649f29a5614SEduardo Habkost "-no-user-config\n" 46503478eae9SEduardo Habkost " do not load default user-provided config files at startup\n", 4651f29a5614SEduardo Habkost QEMU_ARCH_ALL) 4652e2fcbf42SPeter MaydellSRST 4653e2fcbf42SPeter Maydell``-no-user-config`` 4654e2fcbf42SPeter Maydell The ``-no-user-config`` option makes QEMU not load any of the 4655e2fcbf42SPeter Maydell user-provided config files on sysconfdir. 4656e2fcbf42SPeter MaydellERST 46572feac451SThomas Huth 4658ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 465910578a25SPaolo Bonzini "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 466023d15e86SLluís " specify tracing options\n", 4661ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 4662e2fcbf42SPeter MaydellSRST 4663e2fcbf42SPeter Maydell``-trace [[enable=]pattern][,events=file][,file=file]`` 466409ce5f2dSPeter Maydell .. include:: ../qemu-option-trace.rst.inc 4665e2fcbf42SPeter Maydell 4666e2fcbf42SPeter MaydellERST 466742229a75SLluís VilanovaDEF("plugin", HAS_ARG, QEMU_OPTION_plugin, 46683a445acbSMahmoud Mandour "-plugin [file=]<file>[,<argname>=<argvalue>]\n" 466942229a75SLluís Vilanova " load a plugin\n", 467042229a75SLluís Vilanova QEMU_ARCH_ALL) 4671e2fcbf42SPeter MaydellSRST 46723a445acbSMahmoud Mandour``-plugin file=file[,argname=argvalue]`` 4673e2fcbf42SPeter Maydell Load a plugin. 4674e2fcbf42SPeter Maydell 4675e2fcbf42SPeter Maydell ``file=file`` 4676e2fcbf42SPeter Maydell Load the given plugin from a shared library file. 4677e2fcbf42SPeter Maydell 46783a445acbSMahmoud Mandour ``argname=argvalue`` 46793a445acbSMahmoud Mandour Argument passed to the plugin. (Can be given multiple times.) 4680e2fcbf42SPeter MaydellERST 46813dbf2c7fSStefan Weil 468231e70d6cSMarkus ArmbrusterHXCOMM Internal use 468331e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 468431e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 4685c7f0f3b1SAnthony Liguori 46865e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 46872880ffb0SMario Smarduch "-msg [timestamp[=on|off]][,guest-name=[on|off]]\n" 4688deda497bSMarkus Armbruster " control error message format\n" 46892880ffb0SMario Smarduch " timestamp=on enables timestamps (default: off)\n" 46902880ffb0SMario Smarduch " guest-name=on enables guest name prefix but only if\n" 46912880ffb0SMario Smarduch " -name guest option is set (default: off)\n", 46925e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 4693e2fcbf42SPeter MaydellSRST 46942880ffb0SMario Smarduch``-msg [timestamp[=on|off]][,guest-name[=on|off]]`` 4695e2fcbf42SPeter Maydell Control error message format. 4696e2fcbf42SPeter Maydell 4697e2fcbf42SPeter Maydell ``timestamp=on|off`` 4698e2fcbf42SPeter Maydell Prefix messages with a timestamp. Default is off. 46992880ffb0SMario Smarduch 47002880ffb0SMario Smarduch ``guest-name=on|off`` 47012880ffb0SMario Smarduch Prefix messages with guest name but only if -name guest option is set 47022880ffb0SMario Smarduch otherwise the option is ignored. Default is off. 4703e2fcbf42SPeter MaydellERST 47045e2ac519SSeiji Aguchi 4705abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 4706abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 4707abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 4708abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 4709abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 47102382053fSLaurent Vivier " by comparing two such vmstate dumps.\n", 4711abfd9ce3SAmit Shah QEMU_ARCH_ALL) 4712e2fcbf42SPeter MaydellSRST 4713e2fcbf42SPeter Maydell``-dump-vmstate file`` 4714e2fcbf42SPeter Maydell Dump json-encoded vmstate information for current machine type to 4715e2fcbf42SPeter Maydell file in file 4716e2fcbf42SPeter MaydellERST 4717abfd9ce3SAmit Shah 471812df189dSEmilio G. CotaDEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile, 471912df189dSEmilio G. Cota "-enable-sync-profile\n" 472012df189dSEmilio G. Cota " enable synchronization profiling\n", 472112df189dSEmilio G. Cota QEMU_ARCH_ALL) 4722e2fcbf42SPeter MaydellSRST 4723e2fcbf42SPeter Maydell``-enable-sync-profile`` 4724e2fcbf42SPeter Maydell Enable synchronization profiling. 4725e2fcbf42SPeter MaydellERST 472612df189dSEmilio G. Cota 472743f187a5SPaolo BonziniDEFHEADING() 4728de6b4f90SMarkus Armbruster 4729de6b4f90SMarkus ArmbrusterDEFHEADING(Generic object creation:) 4730b9174d4fSDaniel P. Berrange 4731b9174d4fSDaniel P. BerrangeDEF("object", HAS_ARG, QEMU_OPTION_object, 4732b9174d4fSDaniel P. Berrange "-object TYPENAME[,PROP1=VALUE1,...]\n" 4733b9174d4fSDaniel P. Berrange " create a new object of type TYPENAME setting properties\n" 4734b9174d4fSDaniel P. Berrange " in the order they are specified. Note that the 'id'\n" 4735b9174d4fSDaniel P. Berrange " property must be set. These objects are placed in the\n" 4736b9174d4fSDaniel P. Berrange " '/objects' path.\n", 4737b9174d4fSDaniel P. Berrange QEMU_ARCH_ALL) 4738e2fcbf42SPeter MaydellSRST 4739e2fcbf42SPeter Maydell``-object typename[,prop1=value1,...]`` 4740e2fcbf42SPeter Maydell Create a new object of type typename setting properties in the order 4741e2fcbf42SPeter Maydell they are specified. Note that the 'id' property must be set. These 4742e2fcbf42SPeter Maydell objects are placed in the '/objects' path. 4743e2fcbf42SPeter Maydell 474486635aa4SStefan 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`` 4745e2fcbf42SPeter Maydell Creates a memory file backend object, which can be used to back 4746e2fcbf42SPeter Maydell the guest RAM with huge pages. 4747e2fcbf42SPeter Maydell 4748e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 474956c9f00eSRobert Hoo reference this memory region in other parameters, e.g. ``-numa``, 475056c9f00eSRobert Hoo ``-device nvdimm``, etc. 4751e2fcbf42SPeter Maydell 4752e2fcbf42SPeter Maydell The ``size`` option provides the size of the memory region, and 475356c9f00eSRobert Hoo accepts common suffixes, e.g. ``500M``. 4754e2fcbf42SPeter Maydell 4755e2fcbf42SPeter Maydell The ``mem-path`` provides the path to either a shared memory or 4756e2fcbf42SPeter Maydell huge page filesystem mount. 4757e2fcbf42SPeter Maydell 4758e2fcbf42SPeter Maydell The ``share`` boolean option determines whether the memory 4759e2fcbf42SPeter Maydell region is marked as private to QEMU, or shared. The latter 4760e2fcbf42SPeter Maydell allows a co-operating external process to access the QEMU memory 4761e2fcbf42SPeter Maydell region. 4762e2fcbf42SPeter Maydell 4763e2fcbf42SPeter Maydell The ``share`` is also required for pvrdma devices due to 4764e2fcbf42SPeter Maydell limitations in the RDMA API provided by Linux. 4765e2fcbf42SPeter Maydell 4766e2fcbf42SPeter Maydell Setting share=on might affect the ability to configure NUMA 4767e2fcbf42SPeter Maydell bindings for the memory backend under some circumstances, see 4768e2fcbf42SPeter Maydell Documentation/vm/numa\_memory\_policy.txt on the Linux kernel 4769e2fcbf42SPeter Maydell source tree for additional details. 4770e2fcbf42SPeter Maydell 4771e2fcbf42SPeter Maydell Setting the ``discard-data`` boolean option to on indicates that 4772e2fcbf42SPeter Maydell file contents can be destroyed when QEMU exits, to avoid 4773e2fcbf42SPeter Maydell unnecessarily flushing data to the backing file. Note that 4774e2fcbf42SPeter Maydell ``discard-data`` is only an optimization, and QEMU might not 4775e2fcbf42SPeter Maydell discard file contents if it aborts unexpectedly or is terminated 4776e2fcbf42SPeter Maydell using SIGKILL. 4777e2fcbf42SPeter Maydell 4778e2fcbf42SPeter Maydell The ``merge`` boolean option enables memory merge, also known as 4779e2fcbf42SPeter Maydell MADV\_MERGEABLE, so that Kernel Samepage Merging will consider 4780e2fcbf42SPeter Maydell the pages for memory deduplication. 4781e2fcbf42SPeter Maydell 4782e2fcbf42SPeter Maydell Setting the ``dump`` boolean option to off excludes the memory 4783e2fcbf42SPeter Maydell from core dumps. This feature is also known as MADV\_DONTDUMP. 4784e2fcbf42SPeter Maydell 4785e2fcbf42SPeter Maydell The ``prealloc`` boolean option enables memory preallocation. 4786e2fcbf42SPeter Maydell 4787e2fcbf42SPeter Maydell The ``host-nodes`` option binds the memory range to a list of 4788e2fcbf42SPeter Maydell NUMA host nodes. 4789e2fcbf42SPeter Maydell 4790e2fcbf42SPeter Maydell The ``policy`` option sets the NUMA policy to one of the 4791e2fcbf42SPeter Maydell following values: 4792e2fcbf42SPeter Maydell 4793e2fcbf42SPeter Maydell ``default`` 4794e2fcbf42SPeter Maydell default host policy 4795e2fcbf42SPeter Maydell 4796e2fcbf42SPeter Maydell ``preferred`` 4797e2fcbf42SPeter Maydell prefer the given host node list for allocation 4798e2fcbf42SPeter Maydell 4799e2fcbf42SPeter Maydell ``bind`` 4800e2fcbf42SPeter Maydell restrict memory allocation to the given host node list 4801e2fcbf42SPeter Maydell 4802e2fcbf42SPeter Maydell ``interleave`` 4803e2fcbf42SPeter Maydell interleave memory allocations across the given host node 4804e2fcbf42SPeter Maydell list 4805e2fcbf42SPeter Maydell 4806e2fcbf42SPeter Maydell The ``align`` option specifies the base address alignment when 4807e2fcbf42SPeter Maydell QEMU mmap(2) ``mem-path``, and accepts common suffixes, eg 4808e2fcbf42SPeter Maydell ``2M``. Some backend store specified by ``mem-path`` requires an 4809e2fcbf42SPeter Maydell alignment different than the default one used by QEMU, eg the 4810e2fcbf42SPeter Maydell device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In 4811e2fcbf42SPeter Maydell such cases, users can specify the required alignment via this 4812e2fcbf42SPeter Maydell option. 4813e2fcbf42SPeter Maydell 4814e2fcbf42SPeter Maydell The ``pmem`` option specifies whether the backing file specified 4815e2fcbf42SPeter Maydell by ``mem-path`` is in host persistent memory that can be 4816e2fcbf42SPeter Maydell accessed using the SNIA NVM programming model (e.g. Intel 4817e2fcbf42SPeter Maydell NVDIMM). If ``pmem`` is set to 'on', QEMU will take necessary 4818e2fcbf42SPeter Maydell operations to guarantee the persistence of its own writes to 4819e2fcbf42SPeter Maydell ``mem-path`` (e.g. in vNVDIMM label emulation and live 4820e2fcbf42SPeter Maydell migration). Also, we will map the backend-file with MAP\_SYNC 4821e2fcbf42SPeter Maydell flag, which ensures the file metadata is in sync for 4822e2fcbf42SPeter Maydell ``mem-path`` in case of host crash or a power failure. MAP\_SYNC 4823e2fcbf42SPeter Maydell requires support from both the host kernel (since Linux kernel 4824e2fcbf42SPeter Maydell 4.15) and the filesystem of ``mem-path`` mounted with DAX 4825e2fcbf42SPeter Maydell option. 4826e2fcbf42SPeter Maydell 482786635aa4SStefan Hajnoczi The ``readonly`` option specifies whether the backing file is opened 482886635aa4SStefan Hajnoczi read-only or read-write (default). 482986635aa4SStefan Hajnoczi 4830e2fcbf42SPeter 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`` 4831e2fcbf42SPeter Maydell Creates a memory backend object, which can be used to back the 4832e2fcbf42SPeter Maydell guest RAM. Memory backend objects offer more control than the 4833e2fcbf42SPeter Maydell ``-m`` option that is traditionally used to define guest RAM. 4834e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 4835e2fcbf42SPeter Maydell options. 4836e2fcbf42SPeter Maydell 4837e2fcbf42SPeter 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`` 4838e2fcbf42SPeter Maydell Creates an anonymous memory file backend object, which allows 4839e2fcbf42SPeter Maydell QEMU to share the memory with an external process (e.g. when 4840e2fcbf42SPeter Maydell using vhost-user). The memory is allocated with memfd and 4841e2fcbf42SPeter Maydell optional sealing. (Linux only) 4842e2fcbf42SPeter Maydell 4843e2fcbf42SPeter Maydell The ``seal`` option creates a sealed-file, that will block 4844e2fcbf42SPeter Maydell further resizing the memory ('on' by default). 4845e2fcbf42SPeter Maydell 4846e2fcbf42SPeter Maydell The ``hugetlb`` option specify the file to be created resides in 4847e2fcbf42SPeter Maydell the hugetlbfs filesystem (since Linux 4.14). Used in conjunction 4848e2fcbf42SPeter Maydell with the ``hugetlb`` option, the ``hugetlbsize`` option specify 4849e2fcbf42SPeter Maydell the hugetlb page size on systems that support multiple hugetlb 4850e2fcbf42SPeter Maydell page sizes (it must be a power of 2 value supported by the 4851e2fcbf42SPeter Maydell system). 4852e2fcbf42SPeter Maydell 4853e2fcbf42SPeter Maydell In some versions of Linux, the ``hugetlb`` option is 4854e2fcbf42SPeter Maydell incompatible with the ``seal`` option (requires at least Linux 4855e2fcbf42SPeter Maydell 4.16). 4856e2fcbf42SPeter Maydell 4857e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 4858e2fcbf42SPeter Maydell other options. 4859e2fcbf42SPeter Maydell 4860e2fcbf42SPeter Maydell The ``share`` boolean option is on by default with memfd. 4861e2fcbf42SPeter Maydell 4862e2fcbf42SPeter Maydell ``-object rng-builtin,id=id`` 4863e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4864e2fcbf42SPeter Maydell from QEMU builtin functions. The ``id`` parameter is a unique ID 4865e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 4866e2fcbf42SPeter Maydell ``virtio-rng`` device. By default, the ``virtio-rng`` device 4867e2fcbf42SPeter Maydell uses this RNG backend. 4868e2fcbf42SPeter Maydell 4869e2fcbf42SPeter Maydell ``-object rng-random,id=id,filename=/dev/random`` 4870e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4871e2fcbf42SPeter Maydell from a device on the host. The ``id`` parameter is a unique ID 4872e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 4873e2fcbf42SPeter Maydell ``virtio-rng`` device. The ``filename`` parameter specifies 4874e2fcbf42SPeter Maydell which file to obtain entropy from and if omitted defaults to 4875e2fcbf42SPeter Maydell ``/dev/urandom``. 4876e2fcbf42SPeter Maydell 4877e2fcbf42SPeter Maydell ``-object rng-egd,id=id,chardev=chardevid`` 4878e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 4879e2fcbf42SPeter Maydell from an external daemon running on the host. The ``id`` 4880e2fcbf42SPeter Maydell parameter is a unique ID that will be used to reference this 4881e2fcbf42SPeter Maydell entropy backend from the ``virtio-rng`` device. The ``chardev`` 4882e2fcbf42SPeter Maydell parameter is the unique ID of a character device backend that 4883e2fcbf42SPeter Maydell provides the connection to the RNG daemon. 4884e2fcbf42SPeter Maydell 4885e2fcbf42SPeter Maydell ``-object tls-creds-anon,id=id,endpoint=endpoint,dir=/path/to/cred/dir,verify-peer=on|off`` 4886e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 4887e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 4888e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 4889e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 4890e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 4891e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 4892e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 4893e2fcbf42SPeter Maydell is completed, the peer credentials will be verified, though this 4894e2fcbf42SPeter Maydell is a no-op for anonymous credentials. 4895e2fcbf42SPeter Maydell 4896e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 4897e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 4898e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 4899e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 4900e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 4901e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4902e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 4903e2fcbf42SPeter Maydell upfront and saved. 4904e2fcbf42SPeter Maydell 4905e2fcbf42SPeter Maydell ``-object tls-creds-psk,id=id,endpoint=endpoint,dir=/path/to/keys/dir[,username=username]`` 4906e2fcbf42SPeter Maydell Creates a TLS Pre-Shared Keys (PSK) credentials object, which 4907e2fcbf42SPeter Maydell can be used to provide TLS support on network backends. The 4908e2fcbf42SPeter Maydell ``id`` parameter is a unique ID which network backends will use 4909e2fcbf42SPeter Maydell to access the credentials. The ``endpoint`` is either ``server`` 4910e2fcbf42SPeter Maydell or ``client`` depending on whether the QEMU network backend that 4911e2fcbf42SPeter Maydell uses the credentials will be acting as a client or as a server. 4912e2fcbf42SPeter Maydell For clients only, ``username`` is the username which will be 4913e2fcbf42SPeter Maydell sent to the server. If omitted it defaults to "qemu". 4914e2fcbf42SPeter Maydell 4915e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the keys file. It is 4916e2fcbf42SPeter Maydell called "dir/keys.psk" and contains "username:key" pairs. This 4917e2fcbf42SPeter Maydell file can most easily be created using the GnuTLS ``psktool`` 4918e2fcbf42SPeter Maydell program. 4919e2fcbf42SPeter Maydell 4920e2fcbf42SPeter Maydell For server endpoints, dir may also contain a file dh-params.pem 4921e2fcbf42SPeter Maydell providing diffie-hellman parameters to use for the TLS server. 4922e2fcbf42SPeter Maydell If the file is missing, QEMU will generate a set of DH 4923e2fcbf42SPeter Maydell parameters at startup. This is a computationally expensive 4924e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4925e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated up 4926e2fcbf42SPeter Maydell front and saved. 4927e2fcbf42SPeter Maydell 4928e2fcbf42SPeter Maydell ``-object tls-creds-x509,id=id,endpoint=endpoint,dir=/path/to/cred/dir,priority=priority,verify-peer=on|off,passwordid=id`` 4929e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 4930e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 4931e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 4932e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 4933e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 4934e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 4935e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 4936e2fcbf42SPeter Maydell is completed, the peer credentials will be verified. With x509 4937e2fcbf42SPeter Maydell certificates, this implies that the clients must be provided 4938e2fcbf42SPeter Maydell with valid client certificates too. 4939e2fcbf42SPeter Maydell 4940e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 4941e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 4942e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 4943e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 4944e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 4945e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 4946e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 4947e2fcbf42SPeter Maydell upfront and saved. 4948e2fcbf42SPeter Maydell 4949e2fcbf42SPeter Maydell For x509 certificate credentials the directory will contain 4950e2fcbf42SPeter Maydell further files providing the x509 certificates. The certificates 4951e2fcbf42SPeter Maydell must be stored in PEM format, in filenames ca-cert.pem, 4952e2fcbf42SPeter Maydell ca-crl.pem (optional), server-cert.pem (only servers), 4953e2fcbf42SPeter Maydell server-key.pem (only servers), client-cert.pem (only clients), 4954e2fcbf42SPeter Maydell and client-key.pem (only clients). 4955e2fcbf42SPeter Maydell 4956e2fcbf42SPeter Maydell For the server-key.pem and client-key.pem files which contain 4957e2fcbf42SPeter Maydell sensitive private keys, it is possible to use an encrypted 4958e2fcbf42SPeter Maydell version by providing the passwordid parameter. This provides the 4959e2fcbf42SPeter Maydell ID of a previously created ``secret`` object containing the 4960e2fcbf42SPeter Maydell password for decryption. 4961e2fcbf42SPeter Maydell 4962e2fcbf42SPeter Maydell The priority parameter allows to override the global default 4963e2fcbf42SPeter Maydell priority used by gnutls. This can be useful if the system 4964e2fcbf42SPeter Maydell administrator needs to use a weaker set of crypto priorities for 4965e2fcbf42SPeter Maydell QEMU without potentially forcing the weakness onto all 4966e2fcbf42SPeter Maydell applications. Or conversely if one wants wants a stronger 4967e2fcbf42SPeter Maydell default for QEMU than for all other applications, they can do 4968e2fcbf42SPeter Maydell this through this parameter. Its format is a gnutls priority 4969e2fcbf42SPeter Maydell string as described at 4970e2fcbf42SPeter Maydell https://gnutls.org/manual/html_node/Priority-Strings.html. 4971e2fcbf42SPeter Maydell 4972993aec27SPhilippe Mathieu-Daudé ``-object tls-cipher-suites,id=id,priority=priority`` 4973993aec27SPhilippe Mathieu-Daudé Creates a TLS cipher suites object, which can be used to control 4974993aec27SPhilippe Mathieu-Daudé the TLS cipher/protocol algorithms that applications are permitted 4975993aec27SPhilippe Mathieu-Daudé to use. 4976993aec27SPhilippe Mathieu-Daudé 4977993aec27SPhilippe Mathieu-Daudé The ``id`` parameter is a unique ID which frontends will use to 4978993aec27SPhilippe Mathieu-Daudé access the ordered list of permitted TLS cipher suites from the 4979993aec27SPhilippe Mathieu-Daudé host. 4980993aec27SPhilippe Mathieu-Daudé 4981993aec27SPhilippe Mathieu-Daudé The ``priority`` parameter allows to override the global default 4982993aec27SPhilippe Mathieu-Daudé priority used by gnutls. This can be useful if the system 4983993aec27SPhilippe Mathieu-Daudé administrator needs to use a weaker set of crypto priorities for 4984993aec27SPhilippe Mathieu-Daudé QEMU without potentially forcing the weakness onto all 4985993aec27SPhilippe Mathieu-Daudé applications. Or conversely if one wants wants a stronger 4986993aec27SPhilippe Mathieu-Daudé default for QEMU than for all other applications, they can do 4987993aec27SPhilippe Mathieu-Daudé this through this parameter. Its format is a gnutls priority 4988993aec27SPhilippe Mathieu-Daudé string as described at 4989993aec27SPhilippe Mathieu-Daudé https://gnutls.org/manual/html_node/Priority-Strings.html. 4990993aec27SPhilippe Mathieu-Daudé 499169699f30SPhilippe Mathieu-Daudé An example of use of this object is to control UEFI HTTPS Boot. 499269699f30SPhilippe Mathieu-Daudé The tls-cipher-suites object exposes the ordered list of permitted 499369699f30SPhilippe Mathieu-Daudé TLS cipher suites from the host side to the guest firmware, via 499469699f30SPhilippe Mathieu-Daudé fw_cfg. The list is represented as an array of IANA_TLS_CIPHER 499569699f30SPhilippe Mathieu-Daudé objects. The firmware uses the IANA_TLS_CIPHER array for configuring 499669699f30SPhilippe Mathieu-Daudé guest-side TLS. 499769699f30SPhilippe Mathieu-Daudé 499869699f30SPhilippe Mathieu-Daudé In the following example, the priority at which the host-side policy 499969699f30SPhilippe Mathieu-Daudé is retrieved is given by the ``priority`` property. 500069699f30SPhilippe Mathieu-Daudé Given that QEMU uses GNUTLS, ``priority=@SYSTEM`` may be used to 500169699f30SPhilippe Mathieu-Daudé refer to /etc/crypto-policies/back-ends/gnutls.config. 500269699f30SPhilippe Mathieu-Daudé 500369699f30SPhilippe Mathieu-Daudé .. parsed-literal:: 500469699f30SPhilippe Mathieu-Daudé 5005353a06b4SLaszlo Ersek # |qemu_system| \\ 5006353a06b4SLaszlo Ersek -object tls-cipher-suites,id=mysuite0,priority=@SYSTEM \\ 500769699f30SPhilippe Mathieu-Daudé -fw_cfg name=etc/edk2/https/ciphers,gen_id=mysuite0 500869699f30SPhilippe Mathieu-Daudé 5009e2fcbf42SPeter 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]`` 5010e2fcbf42SPeter Maydell Interval t can't be 0, this filter batches the packet delivery: 5011e2fcbf42SPeter Maydell all packets arriving in a given interval on netdev netdevid are 5012e2fcbf42SPeter Maydell delayed until the end of the interval. Interval is in 5013e2fcbf42SPeter Maydell microseconds. ``status`` is optional that indicate whether the 5014e2fcbf42SPeter Maydell netfilter is on (enabled) or off (disabled), the default status 5015e2fcbf42SPeter Maydell for netfilter will be 'on'. 5016e2fcbf42SPeter Maydell 5017e2fcbf42SPeter Maydell queue all\|rx\|tx is an option that can be applied to any 5018e2fcbf42SPeter Maydell netfilter. 5019e2fcbf42SPeter Maydell 5020e2fcbf42SPeter Maydell ``all``: the filter is attached both to the receive and the 5021e2fcbf42SPeter Maydell transmit queue of the netdev (default). 5022e2fcbf42SPeter Maydell 5023e2fcbf42SPeter Maydell ``rx``: the filter is attached to the receive queue of the 5024e2fcbf42SPeter Maydell netdev, where it will receive packets sent to the netdev. 5025e2fcbf42SPeter Maydell 5026e2fcbf42SPeter Maydell ``tx``: the filter is attached to the transmit queue of the 5027e2fcbf42SPeter Maydell netdev, where it will receive packets sent by the netdev. 5028e2fcbf42SPeter Maydell 5029e2fcbf42SPeter Maydell position head\|tail\|id=<id> is an option to specify where the 5030e2fcbf42SPeter Maydell filter should be inserted in the filter list. It can be applied 5031e2fcbf42SPeter Maydell to any netfilter. 5032e2fcbf42SPeter Maydell 5033e2fcbf42SPeter Maydell ``head``: the filter is inserted at the head of the filter list, 5034e2fcbf42SPeter Maydell before any existing filters. 5035e2fcbf42SPeter Maydell 5036e2fcbf42SPeter Maydell ``tail``: the filter is inserted at the tail of the filter list, 5037e2fcbf42SPeter Maydell behind any existing filters (default). 5038e2fcbf42SPeter Maydell 5039e2fcbf42SPeter Maydell ``id=<id>``: the filter is inserted before or behind the filter 5040e2fcbf42SPeter Maydell specified by <id>, see the insert option below. 5041e2fcbf42SPeter Maydell 5042e2fcbf42SPeter Maydell insert behind\|before is an option to specify where to insert 5043e2fcbf42SPeter Maydell the new filter relative to the one specified with 5044e2fcbf42SPeter Maydell position=id=<id>. It can be applied to any netfilter. 5045e2fcbf42SPeter Maydell 5046e2fcbf42SPeter Maydell ``before``: insert before the specified filter. 5047e2fcbf42SPeter Maydell 5048e2fcbf42SPeter Maydell ``behind``: insert behind the specified filter (default). 5049e2fcbf42SPeter Maydell 5050e2fcbf42SPeter 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]`` 5051e2fcbf42SPeter Maydell filter-mirror on netdev netdevid,mirror net packet to 5052e2fcbf42SPeter Maydell chardevchardevid, if it has the vnet\_hdr\_support flag, 5053e2fcbf42SPeter Maydell filter-mirror will mirror packet with vnet\_hdr\_len. 5054e2fcbf42SPeter Maydell 5055e2fcbf42SPeter 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]`` 5056e2fcbf42SPeter Maydell filter-redirector on netdev netdevid,redirect filter's net 5057e2fcbf42SPeter Maydell packet to chardev chardevid,and redirect indev's packet to 5058e2fcbf42SPeter Maydell filter.if it has the vnet\_hdr\_support flag, filter-redirector 5059e2fcbf42SPeter Maydell will redirect packet with vnet\_hdr\_len. Create a 5060e2fcbf42SPeter Maydell filter-redirector we need to differ outdev id from indev id, id 5061e2fcbf42SPeter Maydell can not be the same. we can just use indev or outdev, but at 5062e2fcbf42SPeter Maydell least one of indev or outdev need to be specified. 5063e2fcbf42SPeter Maydell 5064e2fcbf42SPeter Maydell ``-object filter-rewriter,id=id,netdev=netdevid,queue=all|rx|tx,[vnet_hdr_support][,position=head|tail|id=<id>][,insert=behind|before]`` 5065e2fcbf42SPeter Maydell Filter-rewriter is a part of COLO project.It will rewrite tcp 5066e2fcbf42SPeter Maydell packet to secondary from primary to keep secondary tcp 5067e2fcbf42SPeter Maydell connection,and rewrite tcp packet to primary from secondary make 5068e2fcbf42SPeter Maydell tcp packet can be handled by client.if it has the 5069e2fcbf42SPeter Maydell vnet\_hdr\_support flag, we can parse packet with vnet header. 5070e2fcbf42SPeter Maydell 5071e2fcbf42SPeter Maydell usage: colo secondary: -object 5072e2fcbf42SPeter Maydell filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 -object 5073e2fcbf42SPeter Maydell filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 -object 5074e2fcbf42SPeter Maydell filter-rewriter,id=rew0,netdev=hn0,queue=all 5075e2fcbf42SPeter Maydell 5076e2fcbf42SPeter Maydell ``-object filter-dump,id=id,netdev=dev[,file=filename][,maxlen=len][,position=head|tail|id=<id>][,insert=behind|before]`` 5077e2fcbf42SPeter Maydell Dump the network traffic on netdev dev to the file specified by 5078e2fcbf42SPeter Maydell filename. At most len bytes (64k by default) per packet are 5079e2fcbf42SPeter Maydell stored. The file format is libpcap, so it can be analyzed with 5080e2fcbf42SPeter Maydell tools such as tcpdump or Wireshark. 5081e2fcbf42SPeter Maydell 5082a2e5cb7aSZhang 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}]`` 5083e2fcbf42SPeter Maydell Colo-compare gets packet from primary\_in chardevid and 50842b28a7efSZhang Chen secondary\_in, then compare whether the payload of primary packet 50852b28a7efSZhang Chen and secondary packet are the same. If same, it will output 50862b28a7efSZhang Chen primary packet to out\_dev, else it will notify COLO-framework to do 50872b28a7efSZhang Chen checkpoint and send primary packet to out\_dev. In order to 50882b28a7efSZhang Chen improve efficiency, we need to put the task of comparison in 50892b28a7efSZhang Chen another iothread. If it has the vnet\_hdr\_support flag, 50902b28a7efSZhang Chen colo compare will send/recv packet with vnet\_hdr\_len. 50912b28a7efSZhang Chen The compare\_timeout=@var{ms} determines the maximum time of the 50922b28a7efSZhang Chen colo-compare hold the packet. The expired\_scan\_cycle=@var{ms} 50932b28a7efSZhang Chen is to set the period of scanning expired primary node network packets. 50942b28a7efSZhang Chen The max\_queue\_size=@var{size} is to set the max compare queue 50952b28a7efSZhang Chen size depend on user environment. 50962b28a7efSZhang Chen If user want to use Xen COLO, need to add the notify\_dev to 50979cc43c94SZhang Chen notify Xen colo-frame to do checkpoint. 5098e2fcbf42SPeter Maydell 50992b28a7efSZhang Chen COLO-compare must be used with the help of filter-mirror, 51002b28a7efSZhang Chen filter-redirector and filter-rewriter. 5101e2fcbf42SPeter Maydell 5102e2fcbf42SPeter Maydell :: 5103e2fcbf42SPeter Maydell 5104e2fcbf42SPeter Maydell KVM COLO 5105e2fcbf42SPeter Maydell 5106e2fcbf42SPeter Maydell primary: 5107e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 5108e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 5109bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 5110bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 5111bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 5112e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 5113bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 5114e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 5115e2fcbf42SPeter Maydell -object iothread,id=iothread1 5116e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 5117e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 5118e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 5119e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1 5120e2fcbf42SPeter Maydell 5121e2fcbf42SPeter Maydell secondary: 5122e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 5123e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 5124e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 5125e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 5126e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 5127e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 5128e2fcbf42SPeter Maydell 5129e2fcbf42SPeter Maydell 5130e2fcbf42SPeter Maydell Xen COLO 5131e2fcbf42SPeter Maydell 5132e2fcbf42SPeter Maydell primary: 5133e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 5134e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 5135bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 5136bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 5137bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 5138e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 5139bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 5140e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 5141bfdc1267SDaniel P. Berrangé -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server=on,wait=off 5142e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 5143e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 5144e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 5145e2fcbf42SPeter Maydell -object iothread,id=iothread1 5146e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1 5147e2fcbf42SPeter Maydell 5148e2fcbf42SPeter Maydell secondary: 5149e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 5150e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 5151e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 5152e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 5153e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 5154e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 5155e2fcbf42SPeter Maydell 5156e2fcbf42SPeter Maydell If you want to know the detail of above command line, you can 5157e2fcbf42SPeter Maydell read the colo-compare git log. 5158e2fcbf42SPeter Maydell 5159e2fcbf42SPeter Maydell ``-object cryptodev-backend-builtin,id=id[,queues=queues]`` 5160e2fcbf42SPeter Maydell Creates a cryptodev backend which executes crypto opreation from 5161e2fcbf42SPeter Maydell the QEMU cipher APIS. The id parameter is a unique ID that will 5162e2fcbf42SPeter Maydell be used to reference this cryptodev backend from the 5163e2fcbf42SPeter Maydell ``virtio-crypto`` device. The queues parameter is optional, 5164e2fcbf42SPeter Maydell which specify the queue number of cryptodev backend, the default 5165e2fcbf42SPeter Maydell of queues is 1. 5166e2fcbf42SPeter Maydell 516709ce5f2dSPeter Maydell .. parsed-literal:: 5168e2fcbf42SPeter Maydell 5169353a06b4SLaszlo Ersek # |qemu_system| \\ 5170353a06b4SLaszlo Ersek [...] \\ 5171353a06b4SLaszlo Ersek -object cryptodev-backend-builtin,id=cryptodev0 \\ 5172353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 5173e2fcbf42SPeter Maydell [...] 5174e2fcbf42SPeter Maydell 5175e2fcbf42SPeter Maydell ``-object cryptodev-vhost-user,id=id,chardev=chardevid[,queues=queues]`` 5176e2fcbf42SPeter Maydell Creates a vhost-user cryptodev backend, backed by a chardev 5177e2fcbf42SPeter Maydell chardevid. The id parameter is a unique ID that will be used to 5178e2fcbf42SPeter Maydell reference this cryptodev backend from the ``virtio-crypto`` 5179e2fcbf42SPeter Maydell device. The chardev should be a unix domain socket backed one. 5180e2fcbf42SPeter Maydell The vhost-user uses a specifically defined protocol to pass 5181e2fcbf42SPeter Maydell vhost ioctl replacement messages to an application on the other 5182e2fcbf42SPeter Maydell end of the socket. The queues parameter is optional, which 5183e2fcbf42SPeter Maydell specify the queue number of cryptodev backend for multiqueue 5184e2fcbf42SPeter Maydell vhost-user, the default of queues is 1. 5185e2fcbf42SPeter Maydell 518609ce5f2dSPeter Maydell .. parsed-literal:: 5187e2fcbf42SPeter Maydell 5188353a06b4SLaszlo Ersek # |qemu_system| \\ 5189353a06b4SLaszlo Ersek [...] \\ 5190353a06b4SLaszlo Ersek -chardev socket,id=chardev0,path=/path/to/socket \\ 5191353a06b4SLaszlo Ersek -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \\ 5192353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 5193e2fcbf42SPeter Maydell [...] 5194e2fcbf42SPeter Maydell 5195e2fcbf42SPeter Maydell ``-object secret,id=id,data=string,format=raw|base64[,keyid=secretid,iv=string]`` 519609ce5f2dSPeter Maydell \ 5197e2fcbf42SPeter Maydell ``-object secret,id=id,file=filename,format=raw|base64[,keyid=secretid,iv=string]`` 5198e2fcbf42SPeter Maydell Defines a secret to store a password, encryption key, or some 5199e2fcbf42SPeter Maydell other sensitive data. The sensitive data can either be passed 5200e2fcbf42SPeter Maydell directly via the data parameter, or indirectly via the file 5201e2fcbf42SPeter Maydell parameter. Using the data parameter is insecure unless the 5202e2fcbf42SPeter Maydell sensitive data is encrypted. 5203e2fcbf42SPeter Maydell 5204e2fcbf42SPeter Maydell The sensitive data can be provided in raw format (the default), 5205e2fcbf42SPeter Maydell or base64. When encoded as JSON, the raw format only supports 5206e2fcbf42SPeter Maydell valid UTF-8 characters, so base64 is recommended for sending 5207e2fcbf42SPeter Maydell binary data. QEMU will convert from which ever format is 5208e2fcbf42SPeter Maydell provided to the format it needs internally. eg, an RBD password 5209e2fcbf42SPeter Maydell can be provided in raw format, even though it will be base64 5210e2fcbf42SPeter Maydell encoded when passed onto the RBD sever. 5211e2fcbf42SPeter Maydell 5212e2fcbf42SPeter Maydell For added protection, it is possible to encrypt the data 5213e2fcbf42SPeter Maydell associated with a secret using the AES-256-CBC cipher. Use of 5214e2fcbf42SPeter Maydell encryption is indicated by providing the keyid and iv 5215e2fcbf42SPeter Maydell parameters. The keyid parameter provides the ID of a previously 5216e2fcbf42SPeter Maydell defined secret that contains the AES-256 decryption key. This 5217e2fcbf42SPeter Maydell key should be 32-bytes long and be base64 encoded. The iv 5218e2fcbf42SPeter Maydell parameter provides the random initialization vector used for 5219e2fcbf42SPeter Maydell encryption of this particular secret and should be a base64 5220e2fcbf42SPeter Maydell encrypted string of the 16-byte IV. 5221e2fcbf42SPeter Maydell 5222e2fcbf42SPeter Maydell The simplest (insecure) usage is to provide the secret inline 5223e2fcbf42SPeter Maydell 522409ce5f2dSPeter Maydell .. parsed-literal:: 5225e2fcbf42SPeter Maydell 5226e2fcbf42SPeter Maydell # |qemu_system| -object secret,id=sec0,data=letmein,format=raw 5227e2fcbf42SPeter Maydell 5228e2fcbf42SPeter Maydell The simplest secure usage is to provide the secret via a file 5229e2fcbf42SPeter Maydell 5230e2fcbf42SPeter Maydell # printf "letmein" > mypasswd.txt # QEMU\_SYSTEM\_MACRO -object 5231e2fcbf42SPeter Maydell secret,id=sec0,file=mypasswd.txt,format=raw 5232e2fcbf42SPeter Maydell 5233e2fcbf42SPeter Maydell For greater security, AES-256-CBC should be used. To illustrate 5234e2fcbf42SPeter Maydell usage, consider the openssl command line tool which can encrypt 5235e2fcbf42SPeter Maydell the data. Note that when encrypting, the plaintext must be 5236e2fcbf42SPeter Maydell padded to the cipher block size (32 bytes) using the standard 5237e2fcbf42SPeter Maydell PKCS#5/6 compatible padding algorithm. 5238e2fcbf42SPeter Maydell 5239e2fcbf42SPeter Maydell First a master key needs to be created in base64 encoding: 5240e2fcbf42SPeter Maydell 5241e2fcbf42SPeter Maydell :: 5242e2fcbf42SPeter Maydell 5243e2fcbf42SPeter Maydell # openssl rand -base64 32 > key.b64 5244e2fcbf42SPeter Maydell # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 5245e2fcbf42SPeter Maydell 5246e2fcbf42SPeter Maydell Each secret to be encrypted needs to have a random 5247e2fcbf42SPeter Maydell initialization vector generated. These do not need to be kept 5248e2fcbf42SPeter Maydell secret 5249e2fcbf42SPeter Maydell 5250e2fcbf42SPeter Maydell :: 5251e2fcbf42SPeter Maydell 5252e2fcbf42SPeter Maydell # openssl rand -base64 16 > iv.b64 5253e2fcbf42SPeter Maydell # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 5254e2fcbf42SPeter Maydell 5255e2fcbf42SPeter Maydell The secret to be defined can now be encrypted, in this case 5256e2fcbf42SPeter Maydell we're telling openssl to base64 encode the result, but it could 5257e2fcbf42SPeter Maydell be left as raw bytes if desired. 5258e2fcbf42SPeter Maydell 5259e2fcbf42SPeter Maydell :: 5260e2fcbf42SPeter Maydell 5261e2fcbf42SPeter Maydell # SECRET=$(printf "letmein" | 5262e2fcbf42SPeter Maydell openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 5263e2fcbf42SPeter Maydell 5264e2fcbf42SPeter Maydell When launching QEMU, create a master secret pointing to 5265e2fcbf42SPeter Maydell ``key.b64`` and specify that to be used to decrypt the user 5266e2fcbf42SPeter Maydell password. Pass the contents of ``iv.b64`` to the second secret 5267e2fcbf42SPeter Maydell 526809ce5f2dSPeter Maydell .. parsed-literal:: 5269e2fcbf42SPeter Maydell 5270353a06b4SLaszlo Ersek # |qemu_system| \\ 5271353a06b4SLaszlo Ersek -object secret,id=secmaster0,format=base64,file=key.b64 \\ 5272353a06b4SLaszlo Ersek -object secret,id=sec0,keyid=secmaster0,format=base64,\\ 5273e2fcbf42SPeter Maydell data=$SECRET,iv=$(<iv.b64) 5274e2fcbf42SPeter Maydell 527555cdf566SDov 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]`` 5276e2fcbf42SPeter Maydell Create a Secure Encrypted Virtualization (SEV) guest object, 5277e2fcbf42SPeter Maydell which can be used to provide the guest memory encryption support 5278e2fcbf42SPeter Maydell on AMD processors. 5279e2fcbf42SPeter Maydell 5280e2fcbf42SPeter Maydell When memory encryption is enabled, one of the physical address 5281e2fcbf42SPeter Maydell bit (aka the C-bit) is utilized to mark if a memory page is 5282e2fcbf42SPeter Maydell protected. The ``cbitpos`` is used to provide the C-bit 5283e2fcbf42SPeter Maydell position. The C-bit position is Host family dependent hence user 5284e2fcbf42SPeter Maydell must provide this value. On EPYC, the value should be 47. 5285e2fcbf42SPeter Maydell 5286e2fcbf42SPeter Maydell When memory encryption is enabled, we loose certain bits in 5287e2fcbf42SPeter Maydell physical address space. The ``reduced-phys-bits`` is used to 5288e2fcbf42SPeter Maydell provide the number of bits we loose in physical address space. 5289e2fcbf42SPeter Maydell Similar to C-bit, the value is Host family dependent. On EPYC, 5290e2fcbf42SPeter Maydell the value should be 5. 5291e2fcbf42SPeter Maydell 5292e2fcbf42SPeter Maydell The ``sev-device`` provides the device file to use for 5293e2fcbf42SPeter Maydell communicating with the SEV firmware running inside AMD Secure 5294e2fcbf42SPeter Maydell Processor. The default device is '/dev/sev'. If hardware 5295e2fcbf42SPeter Maydell supports memory encryption then /dev/sev devices are created by 5296e2fcbf42SPeter Maydell CCP driver. 5297e2fcbf42SPeter Maydell 5298e2fcbf42SPeter Maydell The ``policy`` provides the guest policy to be enforced by the 5299e2fcbf42SPeter Maydell SEV firmware and restrict what configuration and operational 5300e2fcbf42SPeter Maydell commands can be performed on this guest by the hypervisor. The 5301e2fcbf42SPeter Maydell policy should be provided by the guest owner and is bound to the 5302e2fcbf42SPeter Maydell guest and cannot be changed throughout the lifetime of the 5303e2fcbf42SPeter Maydell guest. The default is 0. 5304e2fcbf42SPeter Maydell 5305e2fcbf42SPeter Maydell If guest ``policy`` allows sharing the key with another SEV 5306e2fcbf42SPeter Maydell guest then ``handle`` can be use to provide handle of the guest 5307e2fcbf42SPeter Maydell from which to share the key. 5308e2fcbf42SPeter Maydell 5309e2fcbf42SPeter Maydell The ``dh-cert-file`` and ``session-file`` provides the guest 5310e2fcbf42SPeter Maydell owner's Public Diffie-Hillman key defined in SEV spec. The PDH 5311e2fcbf42SPeter Maydell and session parameters are used for establishing a cryptographic 5312e2fcbf42SPeter Maydell session with the guest owner to negotiate keys used for 5313e2fcbf42SPeter Maydell attestation. The file must be encoded in base64. 5314e2fcbf42SPeter Maydell 531555cdf566SDov Murik The ``kernel-hashes`` adds the hashes of given kernel/initrd/ 531655cdf566SDov Murik cmdline to a designated guest firmware page for measured Linux 531755cdf566SDov Murik boot with -kernel. The default is off. (Since 6.2) 531855cdf566SDov Murik 5319e2fcbf42SPeter Maydell e.g to launch a SEV guest 5320e2fcbf42SPeter Maydell 532109ce5f2dSPeter Maydell .. parsed-literal:: 5322e2fcbf42SPeter Maydell 5323353a06b4SLaszlo Ersek # |qemu_system_x86| \\ 5324353a06b4SLaszlo Ersek ...... \\ 5325353a06b4SLaszlo Ersek -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \\ 5326353a06b4SLaszlo Ersek -machine ...,memory-encryption=sev0 \\ 5327e2fcbf42SPeter Maydell ..... 5328e2fcbf42SPeter Maydell 5329e2fcbf42SPeter Maydell ``-object authz-simple,id=id,identity=string`` 5330e2fcbf42SPeter Maydell Create an authorization object that will control access to 5331e2fcbf42SPeter Maydell network services. 5332e2fcbf42SPeter Maydell 5333e2fcbf42SPeter Maydell The ``identity`` parameter is identifies the user and its format 5334e2fcbf42SPeter Maydell depends on the network service that authorization object is 5335e2fcbf42SPeter Maydell associated with. For authorizing based on TLS x509 certificates, 5336e2fcbf42SPeter Maydell the identity must be the x509 distinguished name. Note that care 5337e2fcbf42SPeter Maydell must be taken to escape any commas in the distinguished name. 5338e2fcbf42SPeter Maydell 5339e2fcbf42SPeter Maydell An example authorization object to validate a x509 distinguished 5340e2fcbf42SPeter Maydell name would look like: 5341e2fcbf42SPeter Maydell 534209ce5f2dSPeter Maydell .. parsed-literal:: 5343e2fcbf42SPeter Maydell 5344353a06b4SLaszlo Ersek # |qemu_system| \\ 5345353a06b4SLaszlo Ersek ... \\ 5346353a06b4SLaszlo Ersek -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \\ 5347e2fcbf42SPeter Maydell ... 5348e2fcbf42SPeter Maydell 5349e2fcbf42SPeter Maydell Note the use of quotes due to the x509 distinguished name 5350e2fcbf42SPeter Maydell containing whitespace, and escaping of ','. 5351e2fcbf42SPeter Maydell 53524d7beeabSDaniel P. Berrangé ``-object authz-listfile,id=id,filename=path,refresh=on|off`` 5353e2fcbf42SPeter Maydell Create an authorization object that will control access to 5354e2fcbf42SPeter Maydell network services. 5355e2fcbf42SPeter Maydell 5356e2fcbf42SPeter Maydell The ``filename`` parameter is the fully qualified path to a file 5357e2fcbf42SPeter Maydell containing the access control list rules in JSON format. 5358e2fcbf42SPeter Maydell 5359e2fcbf42SPeter Maydell An example set of rules that match against SASL usernames might 5360e2fcbf42SPeter Maydell look like: 5361e2fcbf42SPeter Maydell 5362e2fcbf42SPeter Maydell :: 5363e2fcbf42SPeter Maydell 5364e2fcbf42SPeter Maydell { 5365e2fcbf42SPeter Maydell "rules": [ 5366e2fcbf42SPeter Maydell { "match": "fred", "policy": "allow", "format": "exact" }, 5367e2fcbf42SPeter Maydell { "match": "bob", "policy": "allow", "format": "exact" }, 5368e2fcbf42SPeter Maydell { "match": "danb", "policy": "deny", "format": "glob" }, 5369e2fcbf42SPeter Maydell { "match": "dan*", "policy": "allow", "format": "exact" }, 5370e2fcbf42SPeter Maydell ], 5371e2fcbf42SPeter Maydell "policy": "deny" 5372e2fcbf42SPeter Maydell } 5373e2fcbf42SPeter Maydell 5374e2fcbf42SPeter Maydell When checking access the object will iterate over all the rules 5375e2fcbf42SPeter Maydell and the first rule to match will have its ``policy`` value 5376e2fcbf42SPeter Maydell returned as the result. If no rules match, then the default 5377e2fcbf42SPeter Maydell ``policy`` value is returned. 5378e2fcbf42SPeter Maydell 5379e2fcbf42SPeter Maydell The rules can either be an exact string match, or they can use 5380e2fcbf42SPeter Maydell the simple UNIX glob pattern matching to allow wildcards to be 5381e2fcbf42SPeter Maydell used. 5382e2fcbf42SPeter Maydell 5383e2fcbf42SPeter Maydell If ``refresh`` is set to true the file will be monitored and 5384e2fcbf42SPeter Maydell automatically reloaded whenever its content changes. 5385e2fcbf42SPeter Maydell 5386e2fcbf42SPeter Maydell As with the ``authz-simple`` object, the format of the identity 5387e2fcbf42SPeter Maydell strings being matched depends on the network service, but is 5388e2fcbf42SPeter Maydell usually a TLS x509 distinguished name, or a SASL username. 5389e2fcbf42SPeter Maydell 5390e2fcbf42SPeter Maydell An example authorization object to validate a SASL username 5391e2fcbf42SPeter Maydell would look like: 5392e2fcbf42SPeter Maydell 539309ce5f2dSPeter Maydell .. parsed-literal:: 5394e2fcbf42SPeter Maydell 5395353a06b4SLaszlo Ersek # |qemu_system| \\ 5396353a06b4SLaszlo Ersek ... \\ 53974d7beeabSDaniel P. Berrangé -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=on \\ 5398e2fcbf42SPeter Maydell ... 5399e2fcbf42SPeter Maydell 5400e2fcbf42SPeter Maydell ``-object authz-pam,id=id,service=string`` 5401e2fcbf42SPeter Maydell Create an authorization object that will control access to 5402e2fcbf42SPeter Maydell network services. 5403e2fcbf42SPeter Maydell 5404e2fcbf42SPeter Maydell The ``service`` parameter provides the name of a PAM service to 5405e2fcbf42SPeter Maydell use for authorization. It requires that a file 5406e2fcbf42SPeter Maydell ``/etc/pam.d/service`` exist to provide the configuration for 5407e2fcbf42SPeter Maydell the ``account`` subsystem. 5408e2fcbf42SPeter Maydell 5409e2fcbf42SPeter Maydell An example authorization object to validate a TLS x509 5410e2fcbf42SPeter Maydell distinguished name would look like: 5411e2fcbf42SPeter Maydell 541209ce5f2dSPeter Maydell .. parsed-literal:: 5413e2fcbf42SPeter Maydell 5414353a06b4SLaszlo Ersek # |qemu_system| \\ 5415353a06b4SLaszlo Ersek ... \\ 5416353a06b4SLaszlo Ersek -object authz-pam,id=auth0,service=qemu-vnc \\ 5417e2fcbf42SPeter Maydell ... 5418e2fcbf42SPeter Maydell 5419e2fcbf42SPeter Maydell There would then be a corresponding config file for PAM at 5420e2fcbf42SPeter Maydell ``/etc/pam.d/qemu-vnc`` that contains: 5421e2fcbf42SPeter Maydell 5422e2fcbf42SPeter Maydell :: 5423e2fcbf42SPeter Maydell 5424e2fcbf42SPeter Maydell account requisite pam_listfile.so item=user sense=allow \ 5425e2fcbf42SPeter Maydell file=/etc/qemu/vnc.allow 5426e2fcbf42SPeter Maydell 5427e2fcbf42SPeter Maydell Finally the ``/etc/qemu/vnc.allow`` file would contain the list 5428e2fcbf42SPeter Maydell of x509 distingished names that are permitted access 5429e2fcbf42SPeter Maydell 5430e2fcbf42SPeter Maydell :: 5431e2fcbf42SPeter Maydell 5432e2fcbf42SPeter Maydell CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB 5433e2fcbf42SPeter Maydell 54341793ad02SStefano 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`` 5435e2fcbf42SPeter Maydell Creates a dedicated event loop thread that devices can be 5436e2fcbf42SPeter Maydell assigned to. This is known as an IOThread. By default device 5437e2fcbf42SPeter Maydell emulation happens in vCPU threads or the main event loop thread. 5438e2fcbf42SPeter Maydell This can become a scalability bottleneck. IOThreads allow device 5439e2fcbf42SPeter Maydell emulation and I/O to run on other host CPUs. 5440e2fcbf42SPeter Maydell 5441e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 5442e2fcbf42SPeter Maydell reference this IOThread from ``-device ...,iothread=id``. 5443e2fcbf42SPeter Maydell Multiple devices can be assigned to an IOThread. Note that not 5444e2fcbf42SPeter Maydell all devices support an ``iothread`` parameter. 5445e2fcbf42SPeter Maydell 5446e2fcbf42SPeter Maydell The ``query-iothreads`` QMP command lists IOThreads and reports 5447e2fcbf42SPeter Maydell their thread IDs so that the user can configure host CPU 5448e2fcbf42SPeter Maydell pinning/affinity. 5449e2fcbf42SPeter Maydell 5450e2fcbf42SPeter Maydell IOThreads use an adaptive polling algorithm to reduce event loop 5451e2fcbf42SPeter Maydell latency. Instead of entering a blocking system call to monitor 5452e2fcbf42SPeter Maydell file descriptors and then pay the cost of being woken up when an 5453e2fcbf42SPeter Maydell event occurs, the polling algorithm spins waiting for events for 5454e2fcbf42SPeter Maydell a short time. The algorithm's default parameters are suitable 5455e2fcbf42SPeter Maydell for many cases but can be adjusted based on knowledge of the 5456e2fcbf42SPeter Maydell workload and/or host device latency. 5457e2fcbf42SPeter Maydell 5458e2fcbf42SPeter Maydell The ``poll-max-ns`` parameter is the maximum number of 5459e2fcbf42SPeter Maydell nanoseconds to busy wait for events. Polling can be disabled by 5460e2fcbf42SPeter Maydell setting this value to 0. 5461e2fcbf42SPeter Maydell 5462e2fcbf42SPeter Maydell The ``poll-grow`` parameter is the multiplier used to increase 5463e2fcbf42SPeter Maydell the polling time when the algorithm detects it is missing events 5464e2fcbf42SPeter Maydell due to not polling long enough. 5465e2fcbf42SPeter Maydell 5466e2fcbf42SPeter Maydell The ``poll-shrink`` parameter is the divisor used to decrease 5467e2fcbf42SPeter Maydell the polling time when the algorithm detects it is spending too 5468e2fcbf42SPeter Maydell long polling without encountering events. 5469e2fcbf42SPeter Maydell 54701793ad02SStefano Garzarella The ``aio-max-batch`` parameter is the maximum number of requests 54711793ad02SStefano Garzarella in a batch for the AIO engine, 0 means that the engine will use 54721793ad02SStefano Garzarella its default. 54731793ad02SStefano Garzarella 54741793ad02SStefano Garzarella The IOThread parameters can be modified at run-time using the 5475e2fcbf42SPeter Maydell ``qom-set`` command (where ``iothread1`` is the IOThread's 5476e2fcbf42SPeter Maydell ``id``): 5477e2fcbf42SPeter Maydell 5478e2fcbf42SPeter Maydell :: 5479e2fcbf42SPeter Maydell 5480e2fcbf42SPeter Maydell (qemu) qom-set /objects/iothread1 poll-max-ns 100000 5481e2fcbf42SPeter MaydellERST 5482b9174d4fSDaniel P. Berrange 5483b9174d4fSDaniel P. Berrange 54843dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 5485fd5fc4b1SPaolo Bonzini 5486fd5fc4b1SPaolo Bonzini#undef DEF 5487fd5fc4b1SPaolo Bonzini#undef DEFHEADING 5488fd5fc4b1SPaolo Bonzini#undef ARCHHEADING 5489