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" 29b91b0fc1SPhilippe Mathieu-Daudé " supported accelerators are kvm, xen, 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" 4057702891SCédric Le Goater " 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 62b91b0fc1SPhilippe Mathieu-Daudé architecture, kvm, xen, 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 1422cb40d44SStefan Weil which may be identified by the id provided 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" 181b91b0fc1SPhilippe Mathieu-Daudé " select accelerator (kvm, xen, 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" 1853cfb0456SPeter Maydell " one-insn-per-tb=on|off (one guest instruction per TCG translation block)\n" 186a35b3e14SRichard Henderson " split-wx=on|off (enable TCG split w^x mapping)\n" 187fe174132SPaolo Bonzini " tb-size=n (TCG translation block cache size)\n" 1882ea5cb0aSPeter Xu " dirty-ring-size=n (KVM dirty ring GFN count, default 0)\n" 189c8f2eb5dSShameer Kolothum " eager-split-size=n (KVM Eager Page Split chunk size, default 0, disabled. ARM only)\n" 190e2e69f6bSChenyi Qiang " notify-vmexit=run|internal-error|disable,notify-window=n (enable notify VM exit and set notify window, x86 only)\n" 1910b3c5c81SEduardo Habkost " thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL) 192e2fcbf42SPeter MaydellSRST 193e2fcbf42SPeter Maydell``-accel name[,prop=value[,...]]`` 194e2fcbf42SPeter Maydell This is used to enable an accelerator. Depending on the target 195b91b0fc1SPhilippe Mathieu-Daudé architecture, kvm, xen, hvf, nvmm, whpx or tcg can be available. By 196e2fcbf42SPeter Maydell default, tcg is used. If there is more than one accelerator 197e2fcbf42SPeter Maydell specified, the next one is used if the previous one fails to 198e2fcbf42SPeter Maydell initialize. 199e2fcbf42SPeter Maydell 200e2fcbf42SPeter Maydell ``igd-passthru=on|off`` 201e2fcbf42SPeter Maydell When Xen is in use, this option controls whether Intel 202e2fcbf42SPeter Maydell integrated graphics devices can be passed through to the guest 203e2fcbf42SPeter Maydell (default=off) 204e2fcbf42SPeter Maydell 205e2fcbf42SPeter Maydell ``kernel-irqchip=on|off|split`` 206e2fcbf42SPeter Maydell Controls KVM in-kernel irqchip support. The default is full 207e2fcbf42SPeter Maydell acceleration of the interrupt controllers. On x86, split irqchip 208e2fcbf42SPeter Maydell reduces the kernel attack surface, at a performance cost for 209e2fcbf42SPeter Maydell non-MSI interrupts. Disabling the in-kernel irqchip completely 210e2fcbf42SPeter Maydell is not recommended except for debugging purposes. 211e2fcbf42SPeter Maydell 212e2fcbf42SPeter Maydell ``kvm-shadow-mem=size`` 213e2fcbf42SPeter Maydell Defines the size of the KVM shadow MMU. 214e2fcbf42SPeter Maydell 2153cfb0456SPeter Maydell ``one-insn-per-tb=on|off`` 2163cfb0456SPeter Maydell Makes the TCG accelerator put only one guest instruction into 2173cfb0456SPeter Maydell each translation block. This slows down emulation a lot, but 2183cfb0456SPeter Maydell can be useful in some situations, such as when trying to analyse 2193cfb0456SPeter Maydell the logs produced by the ``-d`` option. 2203cfb0456SPeter Maydell 221a35b3e14SRichard Henderson ``split-wx=on|off`` 222a35b3e14SRichard Henderson Controls the use of split w^x mapping for the TCG code generation 223a35b3e14SRichard Henderson buffer. Some operating systems require this to be enabled, and in 224a35b3e14SRichard Henderson such a case this will default on. On other operating systems, this 225a35b3e14SRichard Henderson will default off, but one may enable this for testing or debugging. 226a35b3e14SRichard Henderson 227e2fcbf42SPeter Maydell ``tb-size=n`` 228e2fcbf42SPeter Maydell Controls the size (in MiB) of the TCG translation block cache. 229e2fcbf42SPeter Maydell 230e2fcbf42SPeter Maydell ``thread=single|multi`` 231e2fcbf42SPeter Maydell Controls number of TCG threads. When the TCG is multi-threaded 232cba42d61SMichael Tokarev there will be one thread per vCPU therefore taking advantage of 233e2fcbf42SPeter Maydell additional host cores. The default is to enable multi-threading 234e2fcbf42SPeter Maydell where both the back-end and front-ends support it and no 235e2fcbf42SPeter Maydell incompatible TCG features have been enabled (e.g. 236e2fcbf42SPeter Maydell icount/replay). 2372ea5cb0aSPeter Xu 2382ea5cb0aSPeter Xu ``dirty-ring-size=n`` 2392ea5cb0aSPeter Xu When the KVM accelerator is used, it controls the size of the per-vCPU 2402ea5cb0aSPeter Xu dirty page ring buffer (number of entries for each vCPU). It should 2412ea5cb0aSPeter Xu be a value that is power of two, and it should be 1024 or bigger (but 2422ea5cb0aSPeter Xu still less than the maximum value that the kernel supports). 4096 2432ea5cb0aSPeter Xu could be a good initial value if you have no idea which is the best. 2442ea5cb0aSPeter Xu Set this value to 0 to disable the feature. By default, this feature 2452ea5cb0aSPeter Xu is disabled (dirty-ring-size=0). When enabled, KVM will instead 2462ea5cb0aSPeter Xu record dirty pages in a bitmap. 2472ea5cb0aSPeter Xu 248c8f2eb5dSShameer Kolothum ``eager-split-size=n`` 249c8f2eb5dSShameer Kolothum KVM implements dirty page logging at the PAGE_SIZE granularity and 250c8f2eb5dSShameer Kolothum enabling dirty-logging on a huge-page requires breaking it into 251c8f2eb5dSShameer Kolothum PAGE_SIZE pages in the first place. KVM on ARM does this splitting 252c8f2eb5dSShameer Kolothum lazily by default. There are performance benefits in doing huge-page 253c8f2eb5dSShameer Kolothum split eagerly, especially in situations where TLBI costs associated 254c8f2eb5dSShameer Kolothum with break-before-make sequences are considerable and also if guest 255c8f2eb5dSShameer Kolothum workloads are read intensive. The size here specifies how many pages 256c8f2eb5dSShameer Kolothum to break at a time and needs to be a valid block size which is 257c8f2eb5dSShameer Kolothum 1GB/2MB/4KB, 32MB/16KB and 512MB/64KB for 4KB/16KB/64KB PAGE_SIZE 258c8f2eb5dSShameer Kolothum respectively. Be wary of specifying a higher size as it will have an 259c8f2eb5dSShameer Kolothum impact on the memory. By default, this feature is disabled 260c8f2eb5dSShameer Kolothum (eager-split-size=0). 261c8f2eb5dSShameer Kolothum 262e2e69f6bSChenyi Qiang ``notify-vmexit=run|internal-error|disable,notify-window=n`` 263e2e69f6bSChenyi Qiang Enables or disables notify VM exit support on x86 host and specify 264e2e69f6bSChenyi Qiang the corresponding notify window to trigger the VM exit if enabled. 265e2e69f6bSChenyi Qiang ``run`` option enables the feature. It does nothing and continue 266e2e69f6bSChenyi Qiang if the exit happens. ``internal-error`` option enables the feature. 267e2e69f6bSChenyi Qiang It raises a internal error. ``disable`` option doesn't enable the feature. 268e2e69f6bSChenyi Qiang This feature can mitigate the CPU stuck issue due to event windows don't 269e2e69f6bSChenyi Qiang open up for a specified of time (i.e. notify-window). 270e2e69f6bSChenyi Qiang Default: notify-vmexit=run,notify-window=0. 271e2e69f6bSChenyi Qiang 272e2fcbf42SPeter MaydellERST 2738d4e9146SKONRAD Frederic 2745824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 2755de1aff2SPierre Morel "-smp [[cpus=]n][,maxcpus=maxcpus][,drawers=drawers][,books=books][,sockets=sockets]\n" 2765de1aff2SPierre Morel " [,dies=dies][,clusters=clusters][,cores=cores][,threads=threads]\n" 2770d871785SYanan Wang " set the number of initial CPUs to 'n' [default=1]\n" 278ce8ee7c6SDaniel P. Berrangé " maxcpus= maximum number of total CPUs, including\n" 279ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 2805de1aff2SPierre Morel " drawers= number of drawers on the machine board\n" 2815de1aff2SPierre Morel " books= number of books in one drawer\n" 2825de1aff2SPierre Morel " sockets= number of sockets in one book\n" 2830d871785SYanan Wang " dies= number of dies in one socket\n" 284864c3b5cSYanan Wang " clusters= number of clusters in one die\n" 285864c3b5cSYanan Wang " cores= number of cores in one cluster\n" 2860d871785SYanan Wang " threads= number of threads in one core\n" 2870d871785SYanan Wang "Note: Different machines may have different subsets of the CPU topology\n" 2880d871785SYanan Wang " parameters supported, so the actual meaning of the supported parameters\n" 2890d871785SYanan Wang " will vary accordingly. For example, for a machine type that supports a\n" 2900d871785SYanan Wang " three-level CPU hierarchy of sockets/cores/threads, the parameters will\n" 2910d871785SYanan Wang " sequentially mean as below:\n" 2920d871785SYanan Wang " sockets means the number of sockets on the machine board\n" 2930d871785SYanan Wang " cores means the number of cores in one socket\n" 2940d871785SYanan Wang " threads means the number of threads in one core\n" 2950d871785SYanan Wang " For a particular machine type board, an expected CPU topology hierarchy\n" 2960d871785SYanan Wang " can be defined through the supported sub-option. Unsupported parameters\n" 2970d871785SYanan Wang " can also be provided in addition to the sub-option, but their values\n" 2980d871785SYanan Wang " must be set as 1 in the purpose of correct parsing.\n", 299ad96090aSBlue Swirl QEMU_ARCH_ALL) 300e2fcbf42SPeter MaydellSRST 301864c3b5cSYanan Wang``-smp [[cpus=]n][,maxcpus=maxcpus][,sockets=sockets][,dies=dies][,clusters=clusters][,cores=cores][,threads=threads]`` 30280d78357SDaniel P. Berrangé Simulate a SMP system with '\ ``n``\ ' CPUs initially present on 30380d78357SDaniel P. Berrangé the machine type board. On boards supporting CPU hotplug, the optional 30480d78357SDaniel P. Berrangé '\ ``maxcpus``\ ' parameter can be set to enable further CPUs to be 3057d8c5a39SYanan Wang added at runtime. When both parameters are omitted, the maximum number 3067d8c5a39SYanan Wang of CPUs will be calculated from the provided topology members and the 3077d8c5a39SYanan Wang initial CPU count will match the maximum number. When only one of them 3087d8c5a39SYanan Wang is given then the omitted one will be set to its counterpart's value. 3097d8c5a39SYanan Wang Both parameters may be specified, but the maximum number of CPUs must 3100d871785SYanan Wang be equal to or greater than the initial CPU count. Product of the 3110d871785SYanan Wang CPU topology hierarchy must be equal to the maximum number of CPUs. 3120d871785SYanan Wang Both parameters are subject to an upper limit that is determined by 3130d871785SYanan Wang the specific machine type chosen. 31480d78357SDaniel P. Berrangé 3150d871785SYanan Wang To control reporting of CPU topology information, values of the topology 3160d871785SYanan Wang parameters can be specified. Machines may only support a subset of the 3170d871785SYanan Wang parameters and different machines may have different subsets supported 3180d871785SYanan Wang which vary depending on capacity of the corresponding CPU targets. So 3190d871785SYanan Wang for a particular machine type board, an expected topology hierarchy can 3200d871785SYanan Wang be defined through the supported sub-option. Unsupported parameters can 3210d871785SYanan Wang also be provided in addition to the sub-option, but their values must be 3220d871785SYanan Wang set as 1 in the purpose of correct parsing. 32380d78357SDaniel P. Berrangé 32480d78357SDaniel P. Berrangé Either the initial CPU count, or at least one of the topology parameters 325c2511b16SYanan Wang must be specified. The specified parameters must be greater than zero, 326c2511b16SYanan Wang explicit configuration like "cpus=0" is not allowed. Values for any 327c2511b16SYanan Wang omitted parameters will be computed from those which are given. 3280d871785SYanan Wang 3290d871785SYanan Wang For example, the following sub-option defines a CPU topology hierarchy 3300d871785SYanan Wang (2 sockets totally on the machine, 2 cores per socket, 2 threads per 3310d871785SYanan Wang core) for a machine that only supports sockets/cores/threads. 3320d871785SYanan Wang Some members of the option can be omitted but their values will be 3330d871785SYanan Wang automatically computed: 3340d871785SYanan Wang 3350d871785SYanan Wang :: 3360d871785SYanan Wang 3370d871785SYanan Wang -smp 8,sockets=2,cores=2,threads=2,maxcpus=8 3380d871785SYanan Wang 3390d871785SYanan Wang The following sub-option defines a CPU topology hierarchy (2 sockets 3400d871785SYanan Wang totally on the machine, 2 dies per socket, 2 cores per die, 2 threads 3410d871785SYanan Wang per core) for PC machines which support sockets/dies/cores/threads. 3420d871785SYanan Wang Some members of the option can be omitted but their values will be 3430d871785SYanan Wang automatically computed: 3440d871785SYanan Wang 3450d871785SYanan Wang :: 3460d871785SYanan Wang 3470d871785SYanan Wang -smp 16,sockets=2,dies=2,cores=2,threads=2,maxcpus=16 3480d871785SYanan Wang 349d55c316fSYanan Wang The following sub-option defines a CPU topology hierarchy (2 sockets 350d55c316fSYanan Wang totally on the machine, 2 clusters per socket, 2 cores per cluster, 351d55c316fSYanan Wang 2 threads per core) for ARM virt machines which support sockets/clusters 352d55c316fSYanan Wang /cores/threads. Some members of the option can be omitted but their values 353d55c316fSYanan Wang will be automatically computed: 354d55c316fSYanan Wang 355d55c316fSYanan Wang :: 356d55c316fSYanan Wang 357d55c316fSYanan Wang -smp 16,sockets=2,clusters=2,cores=2,threads=2,maxcpus=16 358d55c316fSYanan Wang 359c2511b16SYanan Wang Historically preference was given to the coarsest topology parameters 360c2511b16SYanan Wang when computing missing values (ie sockets preferred over cores, which 361c2511b16SYanan Wang were preferred over threads), however, this behaviour is considered 3624a0af293SYanan Wang liable to change. Prior to 6.2 the preference was sockets over cores 3634a0af293SYanan Wang over threads. Since 6.2 the preference is cores over sockets over threads. 3640d871785SYanan Wang 3650d871785SYanan Wang For example, the following option defines a machine board with 2 sockets 3660d871785SYanan Wang of 1 core before 6.2 and 1 socket of 2 cores after 6.2: 3670d871785SYanan Wang 3680d871785SYanan Wang :: 3690d871785SYanan Wang 3700d871785SYanan Wang -smp 2 37197f4effeSYicong Yang 37297f4effeSYicong Yang Note: The cluster topology will only be generated in ACPI and exposed 37397f4effeSYicong Yang to guest if it's explicitly specified in -smp. 374e2fcbf42SPeter MaydellERST 3755824d651Sblueswir1 376268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 377244b3f44STao Xu "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 378244b3f44STao Xu "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=node]\n" 3792d19c656SIgor Mammedov "-numa dist,src=source,dst=destination,val=distance\n" 3809b12dfa0SLiu Jingqi "-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]\n" 381c412a48dSLiu 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" 382c412a48dSLiu Jingqi "-numa hmat-cache,node-id=node,size=size,level=level[,associativity=none|direct|complex][,policy=none|write-back|write-through][,line=size]\n", 3832d19c656SIgor Mammedov QEMU_ARCH_ALL) 384e2fcbf42SPeter MaydellSRST 38509ce5f2dSPeter Maydell``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 38609ce5f2dSPeter Maydell \ 38709ce5f2dSPeter Maydell``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` 38809ce5f2dSPeter Maydell \ 38909ce5f2dSPeter Maydell``-numa dist,src=source,dst=destination,val=distance`` 39009ce5f2dSPeter Maydell \ 39109ce5f2dSPeter Maydell``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]`` 39209ce5f2dSPeter Maydell \ 3932cb40d44SStefan Weil``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=type[,latency=lat][,bandwidth=bw]`` 39409ce5f2dSPeter Maydell \ 39509ce5f2dSPeter Maydell``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]`` 396e2fcbf42SPeter Maydell Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA 397e2fcbf42SPeter Maydell distance from a source node to a destination node. Set the ACPI 398e2fcbf42SPeter Maydell Heterogeneous Memory Attributes for the given nodes. 399e2fcbf42SPeter Maydell 400e2fcbf42SPeter Maydell Legacy VCPU assignment uses '\ ``cpus``\ ' option where firstcpu and 401e2fcbf42SPeter Maydell lastcpu are CPU indexes. Each '\ ``cpus``\ ' option represent a 402e2fcbf42SPeter Maydell contiguous range of CPU indexes (or a single VCPU if lastcpu is 403e2fcbf42SPeter Maydell omitted). A non-contiguous set of VCPUs can be represented by 404e2fcbf42SPeter Maydell providing multiple '\ ``cpus``\ ' options. If '\ ``cpus``\ ' is 405e2fcbf42SPeter Maydell omitted on all nodes, VCPUs are automatically split between them. 406e2fcbf42SPeter Maydell 407e2fcbf42SPeter Maydell For example, the following option assigns VCPUs 0, 1, 2 and 5 to a 408e2fcbf42SPeter Maydell NUMA node: 409e2fcbf42SPeter Maydell 410e2fcbf42SPeter Maydell :: 411e2fcbf42SPeter Maydell 412e2fcbf42SPeter Maydell -numa node,cpus=0-2,cpus=5 413e2fcbf42SPeter Maydell 414e2fcbf42SPeter Maydell '\ ``cpu``\ ' option is a new alternative to '\ ``cpus``\ ' option 415e2fcbf42SPeter Maydell which uses '\ ``socket-id|core-id|thread-id``\ ' properties to 416e2fcbf42SPeter Maydell assign CPU objects to a node using topology layout properties of 417e2fcbf42SPeter Maydell CPU. The set of properties is machine specific, and depends on used 418e2fcbf42SPeter Maydell machine type/'\ ``smp``\ ' options. It could be queried with 419e2fcbf42SPeter Maydell '\ ``hotpluggable-cpus``\ ' monitor command. '\ ``node-id``\ ' 420e2fcbf42SPeter Maydell property specifies node to which CPU object will be assigned, it's 421e2fcbf42SPeter Maydell required for node to be declared with '\ ``node``\ ' option before 422e2fcbf42SPeter Maydell it's used with '\ ``cpu``\ ' option. 423e2fcbf42SPeter Maydell 424e2fcbf42SPeter Maydell For example: 425e2fcbf42SPeter Maydell 426e2fcbf42SPeter Maydell :: 427e2fcbf42SPeter Maydell 428e2fcbf42SPeter Maydell -M pc \ 429e2fcbf42SPeter Maydell -smp 1,sockets=2,maxcpus=2 \ 430e2fcbf42SPeter Maydell -numa node,nodeid=0 -numa node,nodeid=1 \ 431e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 432e2fcbf42SPeter Maydell 4334f513984SYohei Kojima '\ ``memdev``\ ' option assigns RAM from a given memory backend 4344f513984SYohei Kojima device to a node. It is recommended to use '\ ``memdev``\ ' option 4354f513984SYohei Kojima over legacy '\ ``mem``\ ' option. This is because '\ ``memdev``\ ' 4364f513984SYohei Kojima option provides better performance and more control over the 4374f513984SYohei Kojima backend's RAM (e.g. '\ ``prealloc``\ ' parameter of 4384f513984SYohei Kojima '\ ``-memory-backend-ram``\ ' allows memory preallocation). 43932a354dcSIgor Mammedov 4404f513984SYohei Kojima For compatibility reasons, legacy '\ ``mem``\ ' option is 4414f513984SYohei Kojima supported in 5.0 and older machine types. Note that '\ ``mem``\ ' 4424f513984SYohei Kojima and '\ ``memdev``\ ' are mutually exclusive. If one node uses 4434f513984SYohei Kojima '\ ``memdev``\ ', the rest nodes have to use '\ ``memdev``\ ' 4444f513984SYohei Kojima option, and vice versa. 445e2fcbf42SPeter Maydell 4464f513984SYohei Kojima Users must specify memory for all NUMA nodes by '\ ``memdev``\ ' 4474f513984SYohei Kojima (or legacy '\ ``mem``\ ' if available). In QEMU 5.2, the support 4484f513984SYohei Kojima for '\ ``-numa node``\ ' without memory specified was removed. 449e2fcbf42SPeter Maydell 450e2fcbf42SPeter Maydell '\ ``initiator``\ ' is an additional option that points to an 451e2fcbf42SPeter Maydell initiator NUMA node that has best performance (the lowest latency or 452e2fcbf42SPeter Maydell largest bandwidth) to this NUMA node. Note that this option can be 453e2fcbf42SPeter Maydell set only when the machine property 'hmat' is set to 'on'. 454e2fcbf42SPeter Maydell 455e2fcbf42SPeter Maydell Following example creates a machine with 2 NUMA nodes, node 0 has 456e2fcbf42SPeter Maydell CPU. node 1 has only memory, and its initiator is node 0. Note that 457e2fcbf42SPeter Maydell because node 0 has CPU, by default the initiator of node 0 is itself 458e2fcbf42SPeter Maydell and must be itself. 459e2fcbf42SPeter Maydell 460e2fcbf42SPeter Maydell :: 461e2fcbf42SPeter Maydell 462e2fcbf42SPeter Maydell -machine hmat=on \ 463e2fcbf42SPeter Maydell -m 2G,slots=2,maxmem=4G \ 464e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 465e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 466e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 467e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 468e2fcbf42SPeter Maydell -smp 2,sockets=2,maxcpus=2 \ 469e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 470e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 471e2fcbf42SPeter Maydell 472e2fcbf42SPeter Maydell source and destination are NUMA node IDs. distance is the NUMA 473e2fcbf42SPeter Maydell distance from source to destination. The distance from a node to 474e2fcbf42SPeter Maydell itself is always 10. If any pair of nodes is given a distance, then 475e2fcbf42SPeter Maydell all pairs must be given distances. Although, when distances are only 476e2fcbf42SPeter Maydell given in one direction for each pair of nodes, then the distances in 477e2fcbf42SPeter Maydell the opposite directions are assumed to be the same. If, however, an 478e2fcbf42SPeter Maydell asymmetrical pair of distances is given for even one node pair, then 479e2fcbf42SPeter Maydell all node pairs must be provided distance values for both directions, 480e2fcbf42SPeter Maydell even when they are symmetrical. When a node is unreachable from 481e2fcbf42SPeter Maydell another node, set the pair's distance to 255. 482e2fcbf42SPeter Maydell 483e2fcbf42SPeter Maydell Note that the -``numa`` option doesn't allocate any of the specified 484e2fcbf42SPeter Maydell resources, it just assigns existing resources to NUMA nodes. This 485e2fcbf42SPeter Maydell means that one still has to use the ``-m``, ``-smp`` options to 486e2fcbf42SPeter Maydell allocate RAM and VCPUs respectively. 487e2fcbf42SPeter Maydell 488e2fcbf42SPeter Maydell Use '\ ``hmat-lb``\ ' to set System Locality Latency and Bandwidth 489e2fcbf42SPeter Maydell Information between initiator and target NUMA nodes in ACPI 490e2fcbf42SPeter Maydell Heterogeneous Attribute Memory Table (HMAT). Initiator NUMA node can 491e2fcbf42SPeter Maydell create memory requests, usually it has one or more processors. 492e2fcbf42SPeter Maydell Target NUMA node contains addressable memory. 493e2fcbf42SPeter Maydell 494e2fcbf42SPeter Maydell In '\ ``hmat-lb``\ ' option, node are NUMA node IDs. hierarchy is 495e2fcbf42SPeter Maydell the memory hierarchy of the target NUMA node: if hierarchy is 496e2fcbf42SPeter Maydell 'memory', the structure represents the memory performance; if 497e2fcbf42SPeter Maydell hierarchy is 'first-level\|second-level\|third-level', this 498e2fcbf42SPeter Maydell structure represents aggregated performance of memory side caches 499e2fcbf42SPeter Maydell for each domain. type of 'data-type' is type of data represented by 500e2fcbf42SPeter Maydell this structure instance: if 'hierarchy' is 'memory', 'data-type' is 501e2fcbf42SPeter Maydell 'access\|read\|write' latency or 'access\|read\|write' bandwidth of 502e2fcbf42SPeter Maydell the target memory; if 'hierarchy' is 503e2fcbf42SPeter Maydell 'first-level\|second-level\|third-level', 'data-type' is 504e2fcbf42SPeter Maydell 'access\|read\|write' hit latency or 'access\|read\|write' hit 505e2fcbf42SPeter Maydell bandwidth of the target memory side cache. 506e2fcbf42SPeter Maydell 507e2fcbf42SPeter Maydell lat is latency value in nanoseconds. bw is bandwidth value, the 508e2fcbf42SPeter Maydell possible value and units are NUM[M\|G\|T], mean that the bandwidth 509e2fcbf42SPeter Maydell value are NUM byte per second (or MB/s, GB/s or TB/s depending on 510e2fcbf42SPeter Maydell used suffix). Note that if latency or bandwidth value is 0, means 511e2fcbf42SPeter Maydell the corresponding latency or bandwidth information is not provided. 512e2fcbf42SPeter Maydell 513e2fcbf42SPeter Maydell In '\ ``hmat-cache``\ ' option, node-id is the NUMA-id of the memory 514e2fcbf42SPeter Maydell belongs. size is the size of memory side cache in bytes. level is 515e2fcbf42SPeter Maydell the cache level described in this structure, note that the cache 516e2fcbf42SPeter Maydell level 0 should not be used with '\ ``hmat-cache``\ ' option. 517e2fcbf42SPeter Maydell associativity is the cache associativity, the possible value is 518e2fcbf42SPeter Maydell 'none/direct(direct-mapped)/complex(complex cache indexing)'. policy 519e2fcbf42SPeter Maydell is the write policy. line is the cache Line size in bytes. 520e2fcbf42SPeter Maydell 521e2fcbf42SPeter Maydell For example, the following options describe 2 NUMA nodes. Node 0 has 522e2fcbf42SPeter Maydell 2 cpus and a ram, node 1 has only a ram. The processors in node 0 523e2fcbf42SPeter Maydell access memory in node 0 with access-latency 5 nanoseconds, 524e2fcbf42SPeter Maydell access-bandwidth is 200 MB/s; The processors in NUMA node 0 access 525e2fcbf42SPeter Maydell memory in NUMA node 1 with access-latency 10 nanoseconds, 526e2fcbf42SPeter Maydell access-bandwidth is 100 MB/s. And for memory side cache information, 527e2fcbf42SPeter Maydell NUMA node 0 and 1 both have 1 level memory cache, size is 10KB, 528e2fcbf42SPeter Maydell policy is write-back, the cache Line size is 8 bytes: 529e2fcbf42SPeter Maydell 530e2fcbf42SPeter Maydell :: 531e2fcbf42SPeter Maydell 532e2fcbf42SPeter Maydell -machine hmat=on \ 533e2fcbf42SPeter Maydell -m 2G \ 534e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m0 \ 535e2fcbf42SPeter Maydell -object memory-backend-ram,size=1G,id=m1 \ 536848dd269SYanan Wang -smp 2,sockets=2,maxcpus=2 \ 537e2fcbf42SPeter Maydell -numa node,nodeid=0,memdev=m0 \ 538e2fcbf42SPeter Maydell -numa node,nodeid=1,memdev=m1,initiator=0 \ 539e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=0 \ 540e2fcbf42SPeter Maydell -numa cpu,node-id=0,socket-id=1 \ 541e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-latency,latency=5 \ 542e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=0,hierarchy=memory,data-type=access-bandwidth,bandwidth=200M \ 543e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-latency,latency=10 \ 544e2fcbf42SPeter Maydell -numa hmat-lb,initiator=0,target=1,hierarchy=memory,data-type=access-bandwidth,bandwidth=100M \ 545e2fcbf42SPeter Maydell -numa hmat-cache,node-id=0,size=10K,level=1,associativity=direct,policy=write-back,line=8 \ 546e2fcbf42SPeter Maydell -numa hmat-cache,node-id=1,size=10K,level=1,associativity=direct,policy=write-back,line=8 547e2fcbf42SPeter MaydellERST 548268a362cSaliguori 54910adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 55010adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 55110adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 552e2fcbf42SPeter MaydellSRST 553e2fcbf42SPeter Maydell``-add-fd fd=fd,set=set[,opaque=opaque]`` 554e2fcbf42SPeter Maydell Add a file descriptor to an fd set. Valid options are: 555e2fcbf42SPeter Maydell 556e2fcbf42SPeter Maydell ``fd=fd`` 557e2fcbf42SPeter Maydell This option defines the file descriptor of which a duplicate is 558e2fcbf42SPeter Maydell added to fd set. The file descriptor cannot be stdin, stdout, or 559e2fcbf42SPeter Maydell stderr. 560e2fcbf42SPeter Maydell 561e2fcbf42SPeter Maydell ``set=set`` 562e2fcbf42SPeter Maydell This option defines the ID of the fd set to add the file 563e2fcbf42SPeter Maydell descriptor to. 564e2fcbf42SPeter Maydell 565e2fcbf42SPeter Maydell ``opaque=opaque`` 566e2fcbf42SPeter Maydell This option defines a free-form string that can be used to 567e2fcbf42SPeter Maydell describe fd. 568e2fcbf42SPeter Maydell 569e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 570e2fcbf42SPeter Maydell set: 571e2fcbf42SPeter Maydell 572e2fcbf42SPeter Maydell .. parsed-literal:: 573e2fcbf42SPeter Maydell 574353a06b4SLaszlo Ersek |qemu_system| \\ 575353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 576353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 577e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 578e2fcbf42SPeter MaydellERST 57910adb8beSMarkus Armbruster 58010adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 58110adb8beSMarkus Armbruster "-set group.id.arg=value\n" 58210adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 58310adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 584e2fcbf42SPeter MaydellSRST 585e2fcbf42SPeter Maydell``-set group.id.arg=value`` 586e2fcbf42SPeter Maydell Set parameter arg for item id of type group 587e2fcbf42SPeter MaydellERST 58810adb8beSMarkus Armbruster 58910adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 5903751d7c4SPaolo Bonzini "-global driver.property=value\n" 5913751d7c4SPaolo Bonzini "-global driver=driver,property=property,value=value\n" 59210adb8beSMarkus Armbruster " set a global default for a driver property\n", 59310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 594e2fcbf42SPeter MaydellSRST 59509ce5f2dSPeter Maydell``-global driver.prop=value`` 59609ce5f2dSPeter Maydell \ 59709ce5f2dSPeter Maydell``-global driver=driver,property=property,value=value`` 598e2fcbf42SPeter Maydell Set default value of driver's property prop to value, e.g.: 599e2fcbf42SPeter Maydell 600e2fcbf42SPeter Maydell .. parsed-literal:: 601e2fcbf42SPeter Maydell 602e2fcbf42SPeter Maydell |qemu_system_x86| -global ide-hd.physical_block_size=4096 disk-image.img 603e2fcbf42SPeter Maydell 604e2fcbf42SPeter Maydell In particular, you can use this to set driver properties for devices 605e2fcbf42SPeter Maydell which are created automatically by the machine model. To create a 606e2fcbf42SPeter Maydell device which is not created automatically and set properties on it, 607e2fcbf42SPeter Maydell use -``device``. 608e2fcbf42SPeter Maydell 609e2fcbf42SPeter Maydell -global driver.prop=value is shorthand for -global 610e2fcbf42SPeter Maydell driver=driver,property=prop,value=value. The longhand syntax works 611e2fcbf42SPeter Maydell even when driver contains a dot. 612e2fcbf42SPeter MaydellERST 61310adb8beSMarkus Armbruster 61410adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 61510adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 616c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 61710adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 61810adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 61910adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 62010adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 62110adb8beSMarkus Armbruster QEMU_ARCH_ALL) 622e2fcbf42SPeter MaydellSRST 623e2fcbf42SPeter Maydell``-boot [order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_timeout][,strict=on|off]`` 624e2fcbf42SPeter Maydell Specify boot order drives as a string of drive letters. Valid drive 625e2fcbf42SPeter Maydell letters depend on the target architecture. The x86 PC uses: a, b 626e2fcbf42SPeter Maydell (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p 627e2fcbf42SPeter Maydell (Etherboot from network adapter 1-4), hard disk boot is the default. 628e2fcbf42SPeter Maydell To apply a particular boot order only on the first startup, specify 629e2fcbf42SPeter Maydell it via ``once``. Note that the ``order`` or ``once`` parameter 630e2fcbf42SPeter Maydell should not be used together with the ``bootindex`` property of 631e2fcbf42SPeter Maydell devices, since the firmware implementations normally do not support 632e2fcbf42SPeter Maydell both at the same time. 633e2fcbf42SPeter Maydell 634e2fcbf42SPeter Maydell Interactive boot menus/prompts can be enabled via ``menu=on`` as far 635e2fcbf42SPeter Maydell as firmware/BIOS supports them. The default is non-interactive boot. 636e2fcbf42SPeter Maydell 637e2fcbf42SPeter Maydell A splash picture could be passed to bios, enabling user to show it 638e2fcbf42SPeter Maydell as logo, when option splash=sp\_name is given and menu=on, If 639e2fcbf42SPeter Maydell firmware/BIOS supports them. Currently Seabios for X86 system 640e2fcbf42SPeter Maydell support it. limitation: The splash file could be a jpeg file or a 641e2fcbf42SPeter Maydell BMP file in 24 BPP format(true color). The resolution should be 642e2fcbf42SPeter Maydell supported by the SVGA mode, so the recommended is 320x240, 640x480, 643e2fcbf42SPeter Maydell 800x640. 644e2fcbf42SPeter Maydell 645e2fcbf42SPeter Maydell A timeout could be passed to bios, guest will pause for rb\_timeout 646e2fcbf42SPeter Maydell ms when boot failed, then reboot. If rb\_timeout is '-1', guest will 647e2fcbf42SPeter Maydell not reboot, qemu passes '-1' to bios by default. Currently Seabios 648e2fcbf42SPeter Maydell for X86 system support it. 649e2fcbf42SPeter Maydell 650e2fcbf42SPeter Maydell Do strict boot via ``strict=on`` as far as firmware/BIOS supports 651e2fcbf42SPeter Maydell it. This only effects when boot priority is changed by bootindex 652e2fcbf42SPeter Maydell options. The default is non-strict boot. 653e2fcbf42SPeter Maydell 65409ce5f2dSPeter Maydell .. parsed-literal:: 655e2fcbf42SPeter Maydell 656e2fcbf42SPeter Maydell # try to boot from network first, then from hard disk 657e2fcbf42SPeter Maydell |qemu_system_x86| -boot order=nc 658e2fcbf42SPeter Maydell # boot from CD-ROM first, switch back to default order after reboot 659e2fcbf42SPeter Maydell |qemu_system_x86| -boot once=d 660e2fcbf42SPeter Maydell # boot with a splash picture for 5 seconds. 661e2fcbf42SPeter Maydell |qemu_system_x86| -boot menu=on,splash=/root/boot.bmp,splash-time=5000 662e2fcbf42SPeter Maydell 663e2fcbf42SPeter Maydell Note: The legacy format '-boot drives' is still supported but its 664e2fcbf42SPeter Maydell use is discouraged as it may be removed from future versions. 665e2fcbf42SPeter MaydellERST 66610adb8beSMarkus Armbruster 66710adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 66889f3ea2bSMichael Tokarev "-m [size=]megs[,slots=n,maxmem=size]\n" 6696e1d3c1cSIgor Mammedov " configure guest RAM\n" 6700daba1f0SAlexander Graf " size: initial amount of guest memory\n" 671c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 672b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 673a635bcfcSThomas Huth " Note: Some architectures might enforce a specific granularity\n", 6746e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 675e2fcbf42SPeter MaydellSRST 676e2fcbf42SPeter Maydell``-m [size=]megs[,slots=n,maxmem=size]`` 677e2fcbf42SPeter Maydell Sets guest startup RAM size to megs megabytes. Default is 128 MiB. 678e2fcbf42SPeter Maydell Optionally, a suffix of "M" or "G" can be used to signify a value in 679e2fcbf42SPeter Maydell megabytes or gigabytes respectively. Optional pair slots, maxmem 680e2fcbf42SPeter Maydell could be used to set amount of hotpluggable memory slots and maximum 681e2fcbf42SPeter Maydell amount of memory. Note that maxmem must be aligned to the page size. 682e2fcbf42SPeter Maydell 683e2fcbf42SPeter Maydell For example, the following command-line sets the guest startup RAM 684e2fcbf42SPeter Maydell size to 1GB, creates 3 slots to hotplug additional memory and sets 685e2fcbf42SPeter Maydell the maximum memory the guest can reach to 4GB: 686e2fcbf42SPeter Maydell 687e2fcbf42SPeter Maydell .. parsed-literal:: 688e2fcbf42SPeter Maydell 689e2fcbf42SPeter Maydell |qemu_system| -m 1G,slots=3,maxmem=4G 690e2fcbf42SPeter Maydell 691e2fcbf42SPeter Maydell If slots and maxmem are not specified, memory hotplug won't be 692e2fcbf42SPeter Maydell enabled and the guest startup RAM will never increase. 693e2fcbf42SPeter MaydellERST 69410adb8beSMarkus Armbruster 69510adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 69610adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 697e2fcbf42SPeter MaydellSRST 698e2fcbf42SPeter Maydell``-mem-path path`` 699e2fcbf42SPeter Maydell Allocate guest RAM from a temporarily created file in path. 700e2fcbf42SPeter MaydellERST 70110adb8beSMarkus Armbruster 70210adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 70310adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 70410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 705e2fcbf42SPeter MaydellSRST 706e2fcbf42SPeter Maydell``-mem-prealloc`` 707e2fcbf42SPeter Maydell Preallocate memory when using -mem-path. 708e2fcbf42SPeter MaydellERST 70910adb8beSMarkus Armbruster 71010adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 71110adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 71210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 713e2fcbf42SPeter MaydellSRST 714e2fcbf42SPeter Maydell``-k language`` 715e2fcbf42SPeter Maydell Use keyboard layout language (for example ``fr`` for French). This 716e2fcbf42SPeter Maydell option is only needed where it is not easy to get raw PC keycodes 717e2fcbf42SPeter Maydell (e.g. on Macs, with some X11 servers or with a VNC or curses 718e2fcbf42SPeter Maydell display). You don't normally need to use it on PC/Linux or 719e2fcbf42SPeter Maydell PC/Windows hosts. 720e2fcbf42SPeter Maydell 721e2fcbf42SPeter Maydell The available layouts are: 722e2fcbf42SPeter Maydell 723e2fcbf42SPeter Maydell :: 724e2fcbf42SPeter Maydell 725e2fcbf42SPeter Maydell ar de-ch es fo fr-ca hu ja mk no pt-br sv 726e2fcbf42SPeter Maydell da en-gb et fr fr-ch is lt nl pl ru th 727e2fcbf42SPeter Maydell de en-us fi fr-be hr it lv nl-be pt sl tr 728e2fcbf42SPeter Maydell 729e2fcbf42SPeter Maydell The default is ``en-us``. 730e2fcbf42SPeter MaydellERST 73110adb8beSMarkus Armbruster 73210adb8beSMarkus Armbruster 733039a6837SPaolo BonziniDEF("audio", HAS_ARG, QEMU_OPTION_audio, 7341ebdbff4SPaolo Bonzini "-audio [driver=]driver[,prop[=value][,...]]\n" 7351ebdbff4SPaolo Bonzini " specifies default audio backend when `audiodev` is not\n" 7361ebdbff4SPaolo Bonzini " used to create a machine or sound device;" 7371ebdbff4SPaolo Bonzini " options are the same as for -audiodev\n" 738039a6837SPaolo Bonzini "-audio [driver=]driver,model=value[,prop[=value][,...]]\n" 739039a6837SPaolo Bonzini " specifies the audio backend and device to use;\n" 740039a6837SPaolo Bonzini " apart from 'model', options are the same as for -audiodev.\n" 741039a6837SPaolo Bonzini " use '-audio model=help' to show possible devices.\n", 742039a6837SPaolo Bonzini QEMU_ARCH_ALL) 743039a6837SPaolo BonziniSRST 7441ebdbff4SPaolo Bonzini``-audio [driver=]driver[,model=value][,prop[=value][,...]]`` 7451ebdbff4SPaolo Bonzini If the ``model`` option is specified, ``-audio`` is a shortcut 7461ebdbff4SPaolo Bonzini for configuring both the guest audio hardware and the host audio 7471ebdbff4SPaolo Bonzini backend in one go. The guest hardware model can be set with 7481ebdbff4SPaolo Bonzini ``model=modelname``. Use ``model=help`` to list the available 7491ebdbff4SPaolo Bonzini device types. 750039a6837SPaolo Bonzini 751039a6837SPaolo Bonzini The following two example do exactly the same, to show how ``-audio`` 752039a6837SPaolo Bonzini can be used to shorten the command line length: 753039a6837SPaolo Bonzini 754039a6837SPaolo Bonzini .. parsed-literal:: 755039a6837SPaolo Bonzini 756039a6837SPaolo Bonzini |qemu_system| -audiodev pa,id=pa -device sb16,audiodev=pa 757039a6837SPaolo Bonzini |qemu_system| -audio pa,model=sb16 7581ebdbff4SPaolo Bonzini 7591ebdbff4SPaolo Bonzini If the ``model`` option is not specified, ``-audio`` is used to 7601ebdbff4SPaolo Bonzini configure a default audio backend that will be used whenever the 7611ebdbff4SPaolo Bonzini ``audiodev`` property is not set on a device or machine. In 7621ebdbff4SPaolo Bonzini particular, ``-audio none`` ensures that no audio is produced even 7631ebdbff4SPaolo Bonzini for machines that have embedded sound hardware. 7641ebdbff4SPaolo Bonzini 7651ebdbff4SPaolo Bonzini In both cases, the driver option is the same as with the corresponding 7661ebdbff4SPaolo Bonzini ``-audiodev`` option below. Use ``driver=help`` to list the available 7671ebdbff4SPaolo Bonzini drivers. 7681ebdbff4SPaolo Bonzini 769039a6837SPaolo BonziniERST 770039a6837SPaolo Bonzini 771f0b3d811SKővágó, ZoltánDEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev, 772f0b3d811SKővágó, Zoltán "-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n" 773f0b3d811SKővágó, Zoltán " specifies the audio backend to use\n" 7745e03b6daSClaudio Fontana " Use ``-audiodev help`` to list the available drivers\n" 775f0b3d811SKővágó, Zoltán " id= identifier of the backend\n" 776f0b3d811SKővágó, Zoltán " timer-period= timer period in microseconds\n" 7778efac073SKővágó, Zoltán " in|out.mixing-engine= use mixing engine to mix streams inside QEMU\n" 778f0b3d811SKővágó, Zoltán " in|out.fixed-settings= use fixed settings for host audio\n" 779f0b3d811SKővágó, Zoltán " in|out.frequency= frequency to use with fixed settings\n" 780f0b3d811SKővágó, Zoltán " in|out.channels= number of channels to use with fixed settings\n" 781f0b3d811SKővágó, Zoltán " in|out.format= sample format to use with fixed settings\n" 78249f77e6fSVolker Rümelin " valid values: s8, s16, s32, u8, u16, u32, f32\n" 783f0b3d811SKővágó, Zoltán " in|out.voices= number of voices to use\n" 7848624725bSStefan Hajnoczi " in|out.buffer-length= length of buffer in microseconds\n" 785f0b3d811SKővágó, Zoltán "-audiodev none,id=id,[,prop[=value][,...]]\n" 786f0b3d811SKővágó, Zoltán " dummy driver that discards all output\n" 787f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_ALSA 788f0b3d811SKővágó, Zoltán "-audiodev alsa,id=id[,prop[=value][,...]]\n" 789f0b3d811SKővágó, Zoltán " in|out.dev= name of the audio device to use\n" 790dfc54343SStefan Hajnoczi " in|out.period-length= length of period in microseconds\n" 791f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 792f0b3d811SKővágó, Zoltán " threshold= threshold (in microseconds) when playback starts\n" 793f0b3d811SKővágó, Zoltán#endif 794f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_COREAUDIO 795f0b3d811SKővágó, Zoltán "-audiodev coreaudio,id=id[,prop[=value][,...]]\n" 796f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 797f0b3d811SKővágó, Zoltán#endif 798f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_DSOUND 799f0b3d811SKővágó, Zoltán "-audiodev dsound,id=id[,prop[=value][,...]]\n" 800f0b3d811SKővágó, Zoltán " latency= add extra latency to playback in microseconds\n" 801f0b3d811SKővágó, Zoltán#endif 802f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_OSS 803f0b3d811SKővágó, Zoltán "-audiodev oss,id=id[,prop[=value][,...]]\n" 804f0b3d811SKővágó, Zoltán " in|out.dev= path of the audio device to use\n" 805f0b3d811SKővágó, Zoltán " in|out.buffer-count= number of buffers\n" 806f0b3d811SKővágó, Zoltán " in|out.try-poll= attempt to use poll mode\n" 807f0b3d811SKővágó, Zoltán " try-mmap= try using memory mapped access\n" 808f0b3d811SKővágó, Zoltán " exclusive= open device in exclusive mode\n" 809f0b3d811SKővágó, Zoltán " dsp-policy= set timing policy (0..10), -1 to use fragment mode\n" 810f0b3d811SKővágó, Zoltán#endif 811f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_PA 812f0b3d811SKővágó, Zoltán "-audiodev pa,id=id[,prop[=value][,...]]\n" 813f0b3d811SKővágó, Zoltán " server= PulseAudio server address\n" 814f0b3d811SKővágó, Zoltán " in|out.name= source/sink device name\n" 81514d4f011SStefan Hajnoczi " in|out.latency= desired latency in microseconds\n" 816f0b3d811SKővágó, Zoltán#endif 817c2d3d1c2SDorinda Bassey#ifdef CONFIG_AUDIO_PIPEWIRE 818c2d3d1c2SDorinda Bassey "-audiodev pipewire,id=id[,prop[=value][,...]]\n" 819c2d3d1c2SDorinda Bassey " in|out.name= source/sink device name\n" 820c2d3d1c2SDorinda Bassey " in|out.stream-name= name of pipewire stream\n" 821c2d3d1c2SDorinda Bassey " in|out.latency= desired latency in microseconds\n" 822c2d3d1c2SDorinda Bassey#endif 823f0b3d811SKővágó, Zoltán#ifdef CONFIG_AUDIO_SDL 824f0b3d811SKővágó, Zoltán "-audiodev sdl,id=id[,prop[=value][,...]]\n" 8255a0926c2SVolker Rümelin " in|out.buffer-count= number of buffers\n" 826f0b3d811SKővágó, Zoltán#endif 827663df1ccSAlexandre Ratchov#ifdef CONFIG_AUDIO_SNDIO 828663df1ccSAlexandre Ratchov "-audiodev sndio,id=id[,prop[=value][,...]]\n" 829663df1ccSAlexandre Ratchov#endif 830f0b3d811SKővágó, Zoltán#ifdef CONFIG_SPICE 831f0b3d811SKővágó, Zoltán "-audiodev spice,id=id[,prop[=value][,...]]\n" 832f0b3d811SKővágó, Zoltán#endif 833739362d4SMarc-André Lureau#ifdef CONFIG_DBUS_DISPLAY 834739362d4SMarc-André Lureau "-audiodev dbus,id=id[,prop[=value][,...]]\n" 835739362d4SMarc-André Lureau#endif 836f0b3d811SKővágó, Zoltán "-audiodev wav,id=id[,prop[=value][,...]]\n" 837f0b3d811SKővágó, Zoltán " path= path of wav file to record\n", 838f0b3d811SKővágó, Zoltán QEMU_ARCH_ALL) 839e2fcbf42SPeter MaydellSRST 840e2fcbf42SPeter Maydell``-audiodev [driver=]driver,id=id[,prop[=value][,...]]`` 841e2fcbf42SPeter Maydell Adds a new audio backend driver identified by id. There are global 842e2fcbf42SPeter Maydell and driver specific properties. Some values can be set differently 843e2fcbf42SPeter Maydell for input and output, they're marked with ``in|out.``. You can set 844e2fcbf42SPeter Maydell the input's property with ``in.prop`` and the output's property with 845e2fcbf42SPeter Maydell ``out.prop``. For example: 846e2fcbf42SPeter Maydell 847e2fcbf42SPeter Maydell :: 848e2fcbf42SPeter Maydell 849e2fcbf42SPeter Maydell -audiodev alsa,id=example,in.frequency=44110,out.frequency=8000 850e2fcbf42SPeter Maydell -audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified 851e2fcbf42SPeter Maydell 852e2fcbf42SPeter Maydell NOTE: parameter validation is known to be incomplete, in many cases 853e2fcbf42SPeter Maydell specifying an invalid option causes QEMU to print an error message 854e2fcbf42SPeter Maydell and continue emulation without sound. 855e2fcbf42SPeter Maydell 856e2fcbf42SPeter Maydell Valid global options are: 857e2fcbf42SPeter Maydell 858e2fcbf42SPeter Maydell ``id=identifier`` 859e2fcbf42SPeter Maydell Identifies the audio backend. 860e2fcbf42SPeter Maydell 861e2fcbf42SPeter Maydell ``timer-period=period`` 862e2fcbf42SPeter Maydell Sets the timer period used by the audio subsystem in 863e2fcbf42SPeter Maydell microseconds. Default is 10000 (10 ms). 864e2fcbf42SPeter Maydell 865e2fcbf42SPeter Maydell ``in|out.mixing-engine=on|off`` 866e2fcbf42SPeter Maydell Use QEMU's mixing engine to mix all streams inside QEMU and 867e2fcbf42SPeter Maydell convert audio formats when not supported by the backend. When 868e2fcbf42SPeter Maydell off, fixed-settings must be off too. Note that disabling this 869e2fcbf42SPeter Maydell option means that the selected backend must support multiple 870e2fcbf42SPeter Maydell streams and the audio formats used by the virtual cards, 871e2fcbf42SPeter Maydell otherwise you'll get no sound. It's not recommended to disable 872e2fcbf42SPeter Maydell this option unless you want to use 5.1 or 7.1 audio, as mixing 873e2fcbf42SPeter Maydell engine only supports mono and stereo audio. Default is on. 874e2fcbf42SPeter Maydell 875e2fcbf42SPeter Maydell ``in|out.fixed-settings=on|off`` 876e2fcbf42SPeter Maydell Use fixed settings for host audio. When off, it will change 877e2fcbf42SPeter Maydell based on how the guest opens the sound card. In this case you 878e2fcbf42SPeter Maydell must not specify frequency, channels or format. Default is on. 879e2fcbf42SPeter Maydell 880e2fcbf42SPeter Maydell ``in|out.frequency=frequency`` 881e2fcbf42SPeter Maydell Specify the frequency to use when using fixed-settings. Default 882e2fcbf42SPeter Maydell is 44100Hz. 883e2fcbf42SPeter Maydell 884e2fcbf42SPeter Maydell ``in|out.channels=channels`` 885e2fcbf42SPeter Maydell Specify the number of channels to use when using fixed-settings. 886e2fcbf42SPeter Maydell Default is 2 (stereo). 887e2fcbf42SPeter Maydell 888e2fcbf42SPeter Maydell ``in|out.format=format`` 889e2fcbf42SPeter Maydell Specify the sample format to use when using fixed-settings. 890e2fcbf42SPeter Maydell Valid values are: ``s8``, ``s16``, ``s32``, ``u8``, ``u16``, 89149f77e6fSVolker Rümelin ``u32``, ``f32``. Default is ``s16``. 892e2fcbf42SPeter Maydell 893e2fcbf42SPeter Maydell ``in|out.voices=voices`` 894e2fcbf42SPeter Maydell Specify the number of voices to use. Default is 1. 895e2fcbf42SPeter Maydell 896e2fcbf42SPeter Maydell ``in|out.buffer-length=usecs`` 897e2fcbf42SPeter Maydell Sets the size of the buffer in microseconds. 898e2fcbf42SPeter Maydell 899e2fcbf42SPeter Maydell``-audiodev none,id=id[,prop[=value][,...]]`` 900e2fcbf42SPeter Maydell Creates a dummy backend that discards all outputs. This backend has 901e2fcbf42SPeter Maydell no backend specific properties. 902e2fcbf42SPeter Maydell 903e2fcbf42SPeter Maydell``-audiodev alsa,id=id[,prop[=value][,...]]`` 904e2fcbf42SPeter Maydell Creates backend using the ALSA. This backend is only available on 905e2fcbf42SPeter Maydell Linux. 906e2fcbf42SPeter Maydell 907e2fcbf42SPeter Maydell ALSA specific options are: 908e2fcbf42SPeter Maydell 909e2fcbf42SPeter Maydell ``in|out.dev=device`` 910e2fcbf42SPeter Maydell Specify the ALSA device to use for input and/or output. Default 911e2fcbf42SPeter Maydell is ``default``. 912e2fcbf42SPeter Maydell 913e2fcbf42SPeter Maydell ``in|out.period-length=usecs`` 914e2fcbf42SPeter Maydell Sets the period length in microseconds. 915e2fcbf42SPeter Maydell 916e2fcbf42SPeter Maydell ``in|out.try-poll=on|off`` 917e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 918e2fcbf42SPeter Maydell 919e2fcbf42SPeter Maydell ``threshold=threshold`` 920e2fcbf42SPeter Maydell Threshold (in microseconds) when playback starts. Default is 0. 921e2fcbf42SPeter Maydell 922e2fcbf42SPeter Maydell``-audiodev coreaudio,id=id[,prop[=value][,...]]`` 923e2fcbf42SPeter Maydell Creates a backend using Apple's Core Audio. This backend is only 924e2fcbf42SPeter Maydell available on Mac OS and only supports playback. 925e2fcbf42SPeter Maydell 926e2fcbf42SPeter Maydell Core Audio specific options are: 927e2fcbf42SPeter Maydell 928e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 929e2fcbf42SPeter Maydell Sets the count of the buffers. 930e2fcbf42SPeter Maydell 931e2fcbf42SPeter Maydell``-audiodev dsound,id=id[,prop[=value][,...]]`` 932e2fcbf42SPeter Maydell Creates a backend using Microsoft's DirectSound. This backend is 933e2fcbf42SPeter Maydell only available on Windows and only supports playback. 934e2fcbf42SPeter Maydell 935e2fcbf42SPeter Maydell DirectSound specific options are: 936e2fcbf42SPeter Maydell 937e2fcbf42SPeter Maydell ``latency=usecs`` 938e2fcbf42SPeter Maydell Add extra usecs microseconds latency to playback. Default is 939e2fcbf42SPeter Maydell 10000 (10 ms). 940e2fcbf42SPeter Maydell 941e2fcbf42SPeter Maydell``-audiodev oss,id=id[,prop[=value][,...]]`` 942e2fcbf42SPeter Maydell Creates a backend using OSS. This backend is available on most 943e2fcbf42SPeter Maydell Unix-like systems. 944e2fcbf42SPeter Maydell 945e2fcbf42SPeter Maydell OSS specific options are: 946e2fcbf42SPeter Maydell 947e2fcbf42SPeter Maydell ``in|out.dev=device`` 948e2fcbf42SPeter Maydell Specify the file name of the OSS device to use. Default is 949e2fcbf42SPeter Maydell ``/dev/dsp``. 950e2fcbf42SPeter Maydell 951e2fcbf42SPeter Maydell ``in|out.buffer-count=count`` 952e2fcbf42SPeter Maydell Sets the count of the buffers. 953e2fcbf42SPeter Maydell 954e2fcbf42SPeter Maydell ``in|out.try-poll=on|of`` 955e2fcbf42SPeter Maydell Attempt to use poll mode with the device. Default is on. 956e2fcbf42SPeter Maydell 957e2fcbf42SPeter Maydell ``try-mmap=on|off`` 958e2fcbf42SPeter Maydell Try using memory mapped device access. Default is off. 959e2fcbf42SPeter Maydell 960e2fcbf42SPeter Maydell ``exclusive=on|off`` 961e2fcbf42SPeter Maydell Open the device in exclusive mode (vmix won't work in this 962e2fcbf42SPeter Maydell case). Default is off. 963e2fcbf42SPeter Maydell 964e2fcbf42SPeter Maydell ``dsp-policy=policy`` 965e2fcbf42SPeter Maydell Sets the timing policy (between 0 and 10, where smaller number 966e2fcbf42SPeter Maydell means smaller latency but higher CPU usage). Use -1 to use 967e2fcbf42SPeter Maydell buffer sizes specified by ``buffer`` and ``buffer-count``. This 968e2fcbf42SPeter Maydell option is ignored if you do not have OSS 4. Default is 5. 969e2fcbf42SPeter Maydell 970e2fcbf42SPeter Maydell``-audiodev pa,id=id[,prop[=value][,...]]`` 971e2fcbf42SPeter Maydell Creates a backend using PulseAudio. This backend is available on 972e2fcbf42SPeter Maydell most systems. 973e2fcbf42SPeter Maydell 974e2fcbf42SPeter Maydell PulseAudio specific options are: 975e2fcbf42SPeter Maydell 976e2fcbf42SPeter Maydell ``server=server`` 977e2fcbf42SPeter Maydell Sets the PulseAudio server to connect to. 978e2fcbf42SPeter Maydell 979e2fcbf42SPeter Maydell ``in|out.name=sink`` 980e2fcbf42SPeter Maydell Use the specified source/sink for recording/playback. 981e2fcbf42SPeter Maydell 982e2fcbf42SPeter Maydell ``in|out.latency=usecs`` 983e2fcbf42SPeter Maydell Desired latency in microseconds. The PulseAudio server will try 984e2fcbf42SPeter Maydell to honor this value but actual latencies may be lower or higher. 985e2fcbf42SPeter Maydell 986c2d3d1c2SDorinda Bassey``-audiodev pipewire,id=id[,prop[=value][,...]]`` 98720c51248SMarc-André Lureau Creates a backend using PipeWire. This backend is available on 988c2d3d1c2SDorinda Bassey most systems. 989c2d3d1c2SDorinda Bassey 99020c51248SMarc-André Lureau PipeWire specific options are: 991c2d3d1c2SDorinda Bassey 992c2d3d1c2SDorinda Bassey ``in|out.latency=usecs`` 993c2d3d1c2SDorinda Bassey Desired latency in microseconds. 994c2d3d1c2SDorinda Bassey 995c2d3d1c2SDorinda Bassey ``in|out.name=sink`` 996c2d3d1c2SDorinda Bassey Use the specified source/sink for recording/playback. 997c2d3d1c2SDorinda Bassey 998c2d3d1c2SDorinda Bassey ``in|out.stream-name`` 999c2d3d1c2SDorinda Bassey Specify the name of pipewire stream. 1000c2d3d1c2SDorinda Bassey 1001e2fcbf42SPeter Maydell``-audiodev sdl,id=id[,prop[=value][,...]]`` 1002e2fcbf42SPeter Maydell Creates a backend using SDL. This backend is available on most 1003e2fcbf42SPeter Maydell systems, but you should use your platform's native backend if 10045a0926c2SVolker Rümelin possible. 10055a0926c2SVolker Rümelin 10065a0926c2SVolker Rümelin SDL specific options are: 10075a0926c2SVolker Rümelin 10085a0926c2SVolker Rümelin ``in|out.buffer-count=count`` 10095a0926c2SVolker Rümelin Sets the count of the buffers. 1010e2fcbf42SPeter Maydell 1011663df1ccSAlexandre Ratchov``-audiodev sndio,id=id[,prop[=value][,...]]`` 1012663df1ccSAlexandre Ratchov Creates a backend using SNDIO. This backend is available on 1013663df1ccSAlexandre Ratchov OpenBSD and most other Unix-like systems. 1014663df1ccSAlexandre Ratchov 1015663df1ccSAlexandre Ratchov Sndio specific options are: 1016663df1ccSAlexandre Ratchov 1017663df1ccSAlexandre Ratchov ``in|out.dev=device`` 1018663df1ccSAlexandre Ratchov Specify the sndio device to use for input and/or output. Default 1019663df1ccSAlexandre Ratchov is ``default``. 1020663df1ccSAlexandre Ratchov 1021663df1ccSAlexandre Ratchov ``in|out.latency=usecs`` 1022663df1ccSAlexandre Ratchov Sets the desired period length in microseconds. 1023663df1ccSAlexandre Ratchov 1024e2fcbf42SPeter Maydell``-audiodev spice,id=id[,prop[=value][,...]]`` 1025e2fcbf42SPeter Maydell Creates a backend that sends audio through SPICE. This backend 1026e2fcbf42SPeter Maydell requires ``-spice`` and automatically selected in that case, so 1027e2fcbf42SPeter Maydell usually you can ignore this option. This backend has no backend 1028e2fcbf42SPeter Maydell specific properties. 1029e2fcbf42SPeter Maydell 1030e2fcbf42SPeter Maydell``-audiodev wav,id=id[,prop[=value][,...]]`` 1031e2fcbf42SPeter Maydell Creates a backend that writes audio to a WAV file. 1032e2fcbf42SPeter Maydell 1033e2fcbf42SPeter Maydell Backend specific options are: 1034e2fcbf42SPeter Maydell 1035e2fcbf42SPeter Maydell ``path=path`` 1036e2fcbf42SPeter Maydell Write recorded audio into the specified file. Default is 1037e2fcbf42SPeter Maydell ``qemu.wav``. 1038e2fcbf42SPeter MaydellERST 103910adb8beSMarkus Armbruster 104010adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 104110adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 104210adb8beSMarkus Armbruster " add device (based on driver)\n" 104310adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 104410adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 104510adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 104610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1047e2fcbf42SPeter MaydellSRST 1048e2fcbf42SPeter Maydell``-device driver[,prop[=value][,...]]`` 1049e2fcbf42SPeter Maydell Add device driver. prop=value sets driver properties. Valid 1050e2fcbf42SPeter Maydell properties depend on the driver. To get help on possible drivers and 1051e2fcbf42SPeter Maydell properties, use ``-device help`` and ``-device driver,help``. 1052e2fcbf42SPeter Maydell 1053e2fcbf42SPeter Maydell Some drivers are: 1054e2fcbf42SPeter Maydell 1055789101b7SCorey Minyard``-device ipmi-bmc-sim,id=id[,prop[=value][,...]]`` 1056e2fcbf42SPeter Maydell Add an IPMI BMC. This is a simulation of a hardware management 1057e2fcbf42SPeter Maydell interface processor that normally sits on a system. It provides a 1058e2fcbf42SPeter Maydell watchdog and the ability to reset and power control the system. You 1059e2fcbf42SPeter Maydell need to connect this to an IPMI interface to make it useful 1060e2fcbf42SPeter Maydell 1061e2fcbf42SPeter Maydell The IPMI slave address to use for the BMC. The default is 0x20. This 1062e2fcbf42SPeter Maydell address is the BMC's address on the I2C network of management 1063e2fcbf42SPeter Maydell controllers. If you don't know what this means, it is safe to ignore 1064e2fcbf42SPeter Maydell it. 1065e2fcbf42SPeter Maydell 1066e2fcbf42SPeter Maydell ``id=id`` 1067e2fcbf42SPeter Maydell The BMC id for interfaces to use this device. 1068e2fcbf42SPeter Maydell 1069e2fcbf42SPeter Maydell ``slave_addr=val`` 1070e2fcbf42SPeter Maydell Define slave address to use for the BMC. The default is 0x20. 1071e2fcbf42SPeter Maydell 1072e2fcbf42SPeter Maydell ``sdrfile=file`` 1073e2fcbf42SPeter Maydell file containing raw Sensor Data Records (SDR) data. The default 1074e2fcbf42SPeter Maydell is none. 1075e2fcbf42SPeter Maydell 1076e2fcbf42SPeter Maydell ``fruareasize=val`` 1077e2fcbf42SPeter Maydell size of a Field Replaceable Unit (FRU) area. The default is 1078e2fcbf42SPeter Maydell 1024. 1079e2fcbf42SPeter Maydell 1080e2fcbf42SPeter Maydell ``frudatafile=file`` 1081e2fcbf42SPeter Maydell file containing raw Field Replaceable Unit (FRU) inventory data. 1082e2fcbf42SPeter Maydell The default is none. 1083e2fcbf42SPeter Maydell 1084e2fcbf42SPeter Maydell ``guid=uuid`` 1085e2fcbf42SPeter Maydell value for the GUID for the BMC, in standard UUID format. If this 1086e2fcbf42SPeter Maydell is set, get "Get GUID" command to the BMC will return it. 1087e2fcbf42SPeter Maydell Otherwise "Get GUID" will return an error. 1088e2fcbf42SPeter Maydell 1089e2fcbf42SPeter Maydell``-device ipmi-bmc-extern,id=id,chardev=id[,slave_addr=val]`` 1090e2fcbf42SPeter Maydell Add a connection to an external IPMI BMC simulator. Instead of 1091e2fcbf42SPeter Maydell locally emulating the BMC like the above item, instead connect to an 1092e2fcbf42SPeter Maydell external entity that provides the IPMI services. 1093e2fcbf42SPeter Maydell 1094e2fcbf42SPeter Maydell A connection is made to an external BMC simulator. If you do this, 1095e2fcbf42SPeter Maydell it is strongly recommended that you use the "reconnect=" chardev 1096e2fcbf42SPeter Maydell option to reconnect to the simulator if the connection is lost. Note 1097e2fcbf42SPeter Maydell that if this is not used carefully, it can be a security issue, as 1098e2fcbf42SPeter Maydell the interface has the ability to send resets, NMIs, and power off 1099e2fcbf42SPeter Maydell the VM. It's best if QEMU makes a connection to an external 1100e2fcbf42SPeter Maydell simulator running on a secure port on localhost, so neither the 1101e2fcbf42SPeter Maydell simulator nor QEMU is exposed to any outside network. 1102e2fcbf42SPeter Maydell 1103e2fcbf42SPeter Maydell See the "lanserv/README.vm" file in the OpenIPMI library for more 1104e2fcbf42SPeter Maydell details on the external interface. 1105e2fcbf42SPeter Maydell 1106e2fcbf42SPeter Maydell``-device isa-ipmi-kcs,bmc=id[,ioport=val][,irq=val]`` 11071e458f11SStefan Weil Add a KCS IPMI interface on the ISA bus. This also adds a 1108e2fcbf42SPeter Maydell corresponding ACPI and SMBIOS entries, if appropriate. 1109e2fcbf42SPeter Maydell 1110e2fcbf42SPeter Maydell ``bmc=id`` 1111e2fcbf42SPeter Maydell The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern 1112e2fcbf42SPeter Maydell above. 1113e2fcbf42SPeter Maydell 1114e2fcbf42SPeter Maydell ``ioport=val`` 1115e2fcbf42SPeter Maydell Define the I/O address of the interface. The default is 0xca0 1116e2fcbf42SPeter Maydell for KCS. 1117e2fcbf42SPeter Maydell 1118e2fcbf42SPeter Maydell ``irq=val`` 1119e2fcbf42SPeter Maydell Define the interrupt to use. The default is 5. To disable 1120e2fcbf42SPeter Maydell interrupts, set this to 0. 1121e2fcbf42SPeter Maydell 1122e2fcbf42SPeter Maydell``-device isa-ipmi-bt,bmc=id[,ioport=val][,irq=val]`` 1123e2fcbf42SPeter Maydell Like the KCS interface, but defines a BT interface. The default port 1124e2fcbf42SPeter Maydell is 0xe4 and the default interrupt is 5. 1125323679daSCorey Minyard 1126323679daSCorey Minyard``-device pci-ipmi-kcs,bmc=id`` 11271e458f11SStefan Weil Add a KCS IPMI interface on the PCI bus. 1128323679daSCorey Minyard 1129323679daSCorey Minyard ``bmc=id`` 1130323679daSCorey Minyard The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 1131323679daSCorey Minyard 1132323679daSCorey Minyard``-device pci-ipmi-bt,bmc=id`` 1133323679daSCorey Minyard Like the KCS interface, but defines a BT interface on the PCI bus. 11347395b3e3SPeter Xu 11357395b3e3SPeter Xu``-device intel-iommu[,option=...]`` 11367395b3e3SPeter Xu This is only supported by ``-machine q35``, which will enable Intel VT-d 11377395b3e3SPeter Xu emulation within the guest. It supports below options: 11387395b3e3SPeter Xu 11397395b3e3SPeter Xu ``intremap=on|off`` (default: auto) 11407395b3e3SPeter Xu This enables interrupt remapping feature. It's required to enable 11417395b3e3SPeter Xu complete x2apic. Currently it only supports kvm kernel-irqchip modes 11427395b3e3SPeter Xu ``off`` or ``split``, while full kernel-irqchip is not yet supported. 11437395b3e3SPeter Xu The default value is "auto", which will be decided by the mode of 11447395b3e3SPeter Xu kernel-irqchip. 11457395b3e3SPeter Xu 11467395b3e3SPeter Xu ``caching-mode=on|off`` (default: off) 11477395b3e3SPeter Xu This enables caching mode for the VT-d emulated device. When 11487395b3e3SPeter Xu caching-mode is enabled, each guest DMA buffer mapping will generate an 11497395b3e3SPeter Xu IOTLB invalidation from the guest IOMMU driver to the vIOMMU device in 11507395b3e3SPeter Xu a synchronous way. It is required for ``-device vfio-pci`` to work 11517395b3e3SPeter Xu with the VT-d device, because host assigned devices requires to setup 11527395b3e3SPeter Xu the DMA mapping on the host before guest DMA starts. 11537395b3e3SPeter Xu 11547395b3e3SPeter Xu ``device-iotlb=on|off`` (default: off) 11557395b3e3SPeter Xu This enables device-iotlb capability for the emulated VT-d device. So 11567395b3e3SPeter Xu far virtio/vhost should be the only real user for this parameter, 11577395b3e3SPeter Xu paired with ats=on configured for the device. 11587395b3e3SPeter Xu 11597395b3e3SPeter Xu ``aw-bits=39|48`` (default: 39) 11607395b3e3SPeter Xu This decides the address width of IOVA address space. The address 11617395b3e3SPeter Xu space has 39 bits width for 3-level IOMMU page tables, and 48 bits for 11627395b3e3SPeter Xu 4-level IOMMU page tables. 11637395b3e3SPeter Xu 11647395b3e3SPeter Xu Please also refer to the wiki page for general scenarios of VT-d 11657395b3e3SPeter Xu emulation in QEMU: https://wiki.qemu.org/Features/VT-d. 11667395b3e3SPeter Xu 1167e2fcbf42SPeter MaydellERST 116810adb8beSMarkus Armbruster 116910adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 11708f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 117110adb8beSMarkus Armbruster " set the name of the guest\n" 1172479a5747SRoman Bolshakov " string1 sets the window title and string2 the process name\n" 1173479a5747SRoman Bolshakov " When debug-threads is enabled, individual threads are given a separate name\n" 11748f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 117510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 1176e2fcbf42SPeter MaydellSRST 1177e2fcbf42SPeter Maydell``-name name`` 1178e2fcbf42SPeter Maydell Sets the name of the guest. This name will be displayed in the SDL 1179e2fcbf42SPeter Maydell window caption. The name will also be used for the VNC server. Also 1180e2fcbf42SPeter Maydell optionally set the top visible process name in Linux. Naming of 1181e2fcbf42SPeter Maydell individual threads can also be enabled on Linux to aid debugging. 1182e2fcbf42SPeter MaydellERST 118310adb8beSMarkus Armbruster 118410adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 118510adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 118610adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 1187e2fcbf42SPeter MaydellSRST 1188e2fcbf42SPeter Maydell``-uuid uuid`` 1189e2fcbf42SPeter Maydell Set system UUID. 1190e2fcbf42SPeter MaydellERST 119110adb8beSMarkus Armbruster 119210adb8beSMarkus ArmbrusterDEFHEADING() 119310adb8beSMarkus Armbruster 1194de6b4f90SMarkus ArmbrusterDEFHEADING(Block device options:) 119510adb8beSMarkus Armbruster 11965af2b0f6SAlex BennéeSRST 11975af2b0f6SAlex BennéeThe QEMU block device handling options have a long history and 11985af2b0f6SAlex Bennéehave gone through several iterations as the feature set and complexity 11995af2b0f6SAlex Bennéeof the block layer have grown. Many online guides to QEMU often 12005af2b0f6SAlex Bennéereference older and deprecated options, which can lead to confusion. 12015af2b0f6SAlex Bennée 1202c1654c3eSAlex BennéeThe most explicit way to describe disks is to use a combination of 12035af2b0f6SAlex Bennée``-device`` to specify the hardware device and ``-blockdev`` to 12045af2b0f6SAlex Bennéedescribe the backend. The device defines what the guest sees and the 1205c1654c3eSAlex Bennéebackend describes how QEMU handles the data. It is the only guaranteed 1206c1654c3eSAlex Bennéestable interface for describing block devices and as such is 1207c1654c3eSAlex Bennéerecommended for management tools and scripting. 1208c1654c3eSAlex Bennée 1209c1654c3eSAlex BennéeThe ``-drive`` option combines the device and backend into a single 1210c1654c3eSAlex Bennéecommand line option which is a more human friendly. There is however no 1211c1654c3eSAlex Bennéeinterface stability guarantee although some older board models still 1212c1654c3eSAlex Bennéeneed updating to work with the modern blockdev forms. 1213c1654c3eSAlex Bennée 1214c1654c3eSAlex BennéeOlder options like ``-hda`` are essentially macros which expand into 1215c1654c3eSAlex Bennée``-drive`` options for various drive interfaces. The original forms 1216c1654c3eSAlex Bennéebake in a lot of assumptions from the days when QEMU was emulating a 1217c1654c3eSAlex Bennéelegacy PC, they are not recommended for modern configurations. 12185af2b0f6SAlex Bennée 12195af2b0f6SAlex BennéeERST 12205af2b0f6SAlex Bennée 12215824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 1222ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 1223ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 1224e2fcbf42SPeter MaydellSRST 122509ce5f2dSPeter Maydell``-fda file`` 122609ce5f2dSPeter Maydell \ 122709ce5f2dSPeter Maydell``-fdb file`` 1228923e9311SThomas Huth Use file as floppy disk 0/1 image (see the :ref:`disk images` chapter in 1229923e9311SThomas Huth the System Emulation Users Guide). 1230e2fcbf42SPeter MaydellERST 12315824d651Sblueswir1 12325824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 1233bcd8e243SThomas Huth "-hda/-hdb file use 'file' as hard disk 0/1 image\n", QEMU_ARCH_ALL) 1234ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 12355824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 1236bcd8e243SThomas Huth "-hdc/-hdd file use 'file' as hard disk 2/3 image\n", QEMU_ARCH_ALL) 1237ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 1238e2fcbf42SPeter MaydellSRST 123909ce5f2dSPeter Maydell``-hda file`` 124009ce5f2dSPeter Maydell \ 124109ce5f2dSPeter Maydell``-hdb file`` 124209ce5f2dSPeter Maydell \ 124309ce5f2dSPeter Maydell``-hdc file`` 124409ce5f2dSPeter Maydell \ 124509ce5f2dSPeter Maydell``-hdd file`` 1246bcd8e243SThomas Huth Use file as hard disk 0, 1, 2 or 3 image on the default bus of the 1247bcd8e243SThomas Huth emulated machine (this is for example the IDE bus on most x86 machines, 1248bcd8e243SThomas Huth but it can also be SCSI, virtio or something else on other target 1249bcd8e243SThomas Huth architectures). See also the :ref:`disk images` chapter in the System 1250bcd8e243SThomas Huth Emulation Users Guide. 1251e2fcbf42SPeter MaydellERST 12525824d651Sblueswir1 12535824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 1254bcd8e243SThomas Huth "-cdrom file use 'file' as CD-ROM image\n", 1255ad96090aSBlue Swirl QEMU_ARCH_ALL) 1256e2fcbf42SPeter MaydellSRST 1257e2fcbf42SPeter Maydell``-cdrom file`` 1258bcd8e243SThomas Huth Use file as CD-ROM image on the default bus of the emulated machine 1259bcd8e243SThomas Huth (which is IDE1 master on x86, so you cannot use ``-hdc`` and ``-cdrom`` 1260bcd8e243SThomas Huth at the same time there). On systems that support it, you can use the 1261bcd8e243SThomas Huth host CD-ROM by using ``/dev/cdrom`` as filename. 1262e2fcbf42SPeter MaydellERST 12635824d651Sblueswir1 126442e5f393SMarkus ArmbrusterDEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, 126542e5f393SMarkus Armbruster "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n" 126642e5f393SMarkus Armbruster " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 1267c9b749d7SKevin Wolf " [,read-only=on|off][,auto-read-only=on|off]\n" 1268c9b749d7SKevin Wolf " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n" 126942e5f393SMarkus Armbruster " [,driver specific parameters...]\n" 127042e5f393SMarkus Armbruster " configure a block backend\n", QEMU_ARCH_ALL) 1271e2fcbf42SPeter MaydellSRST 1272e2fcbf42SPeter Maydell``-blockdev option[,option[,option[,...]]]`` 1273e2fcbf42SPeter Maydell Define a new block driver node. Some of the options apply to all 1274e2fcbf42SPeter Maydell block drivers, other options are only accepted for a specific block 1275e2fcbf42SPeter Maydell driver. See below for a list of generic options and options for the 1276e2fcbf42SPeter Maydell most common block drivers. 1277e2fcbf42SPeter Maydell 1278e2fcbf42SPeter Maydell Options that expect a reference to another node (e.g. ``file``) can 1279e2fcbf42SPeter Maydell be given in two ways. Either you specify the node name of an already 1280e2fcbf42SPeter Maydell existing node (file=node-name), or you define a new node inline, 1281e2fcbf42SPeter Maydell adding options for the referenced node after a dot 1282e2fcbf42SPeter Maydell (file.filename=path,file.aio=native). 1283e2fcbf42SPeter Maydell 1284e2fcbf42SPeter Maydell A block driver node created with ``-blockdev`` can be used for a 1285e2fcbf42SPeter Maydell guest device by specifying its node name for the ``drive`` property 1286e2fcbf42SPeter Maydell in a ``-device`` argument that defines a block device. 1287e2fcbf42SPeter Maydell 1288e2fcbf42SPeter Maydell ``Valid options for any block driver node:`` 1289e2fcbf42SPeter Maydell ``driver`` 1290e2fcbf42SPeter Maydell Specifies the block driver to use for the given node. 1291e2fcbf42SPeter Maydell 1292e2fcbf42SPeter Maydell ``node-name`` 1293e2fcbf42SPeter Maydell This defines the name of the block driver node by which it 1294e2fcbf42SPeter Maydell will be referenced later. The name must be unique, i.e. it 1295e2fcbf42SPeter Maydell must not match the name of a different block driver node, or 1296e2fcbf42SPeter Maydell (if you use ``-drive`` as well) the ID of a drive. 1297e2fcbf42SPeter Maydell 1298e2fcbf42SPeter Maydell If no node name is specified, it is automatically generated. 1299e2fcbf42SPeter Maydell The generated node name is not intended to be predictable 1300e2fcbf42SPeter Maydell and changes between QEMU invocations. For the top level, an 1301e2fcbf42SPeter Maydell explicit node name must be specified. 1302e2fcbf42SPeter Maydell 1303e2fcbf42SPeter Maydell ``read-only`` 1304e2fcbf42SPeter Maydell Open the node read-only. Guest write attempts will fail. 1305e2fcbf42SPeter Maydell 1306e2fcbf42SPeter Maydell Note that some block drivers support only read-only access, 1307e2fcbf42SPeter Maydell either generally or in certain configurations. In this case, 1308e2fcbf42SPeter Maydell the default value ``read-only=off`` does not work and the 1309e2fcbf42SPeter Maydell option must be specified explicitly. 1310e2fcbf42SPeter Maydell 1311e2fcbf42SPeter Maydell ``auto-read-only`` 1312e2fcbf42SPeter Maydell If ``auto-read-only=on`` is set, QEMU may fall back to 1313e2fcbf42SPeter Maydell read-only usage even when ``read-only=off`` is requested, or 1314e2fcbf42SPeter Maydell even switch between modes as needed, e.g. depending on 1315e2fcbf42SPeter Maydell whether the image file is writable or whether a writing user 1316e2fcbf42SPeter Maydell is attached to the node. 1317e2fcbf42SPeter Maydell 1318e2fcbf42SPeter Maydell ``force-share`` 1319e2fcbf42SPeter Maydell Override the image locking system of QEMU by forcing the 1320e2fcbf42SPeter Maydell node to utilize weaker shared access for permissions where 1321e2fcbf42SPeter Maydell it would normally request exclusive access. When there is 1322e2fcbf42SPeter Maydell the potential for multiple instances to have the same file 1323e2fcbf42SPeter Maydell open (whether this invocation of QEMU is the first or the 1324e2fcbf42SPeter Maydell second instance), both instances must permit shared access 1325e2fcbf42SPeter Maydell for the second instance to succeed at opening the file. 1326e2fcbf42SPeter Maydell 1327e2fcbf42SPeter Maydell Enabling ``force-share=on`` requires ``read-only=on``. 1328e2fcbf42SPeter Maydell 1329e2fcbf42SPeter Maydell ``cache.direct`` 1330e2fcbf42SPeter Maydell The host page cache can be avoided with ``cache.direct=on``. 1331e2fcbf42SPeter Maydell This will attempt to do disk IO directly to the guest's 1332e2fcbf42SPeter Maydell memory. QEMU may still perform an internal copy of the data. 1333e2fcbf42SPeter Maydell 1334e2fcbf42SPeter Maydell ``cache.no-flush`` 1335e2fcbf42SPeter Maydell In case you don't care about data integrity over host 1336e2fcbf42SPeter Maydell failures, you can use ``cache.no-flush=on``. This option 1337e2fcbf42SPeter Maydell tells QEMU that it never needs to write any data to the disk 1338e2fcbf42SPeter Maydell but can instead keep things in cache. If anything goes 1339e2fcbf42SPeter Maydell wrong, like your host losing power, the disk storage getting 1340e2fcbf42SPeter Maydell disconnected accidentally, etc. your image will most 1341e2fcbf42SPeter Maydell probably be rendered unusable. 1342e2fcbf42SPeter Maydell 1343e2fcbf42SPeter Maydell ``discard=discard`` 1344e2fcbf42SPeter Maydell discard is one of "ignore" (or "off") or "unmap" (or "on") 1345e2fcbf42SPeter Maydell and controls whether ``discard`` (also known as ``trim`` or 1346e2fcbf42SPeter Maydell ``unmap``) requests are ignored or passed to the filesystem. 1347e2fcbf42SPeter Maydell Some machine types may not support discard requests. 1348e2fcbf42SPeter Maydell 1349e2fcbf42SPeter Maydell ``detect-zeroes=detect-zeroes`` 1350e2fcbf42SPeter Maydell detect-zeroes is "off", "on" or "unmap" and enables the 1351e2fcbf42SPeter Maydell automatic conversion of plain zero writes by the OS to 1352e2fcbf42SPeter Maydell driver specific optimized zero write commands. You may even 1353e2fcbf42SPeter Maydell choose "unmap" if discard is set to "unmap" to allow a zero 1354e2fcbf42SPeter Maydell write to be converted to an ``unmap`` operation. 1355e2fcbf42SPeter Maydell 1356e2fcbf42SPeter Maydell ``Driver-specific options for file`` 1357e2fcbf42SPeter Maydell This is the protocol-level block driver for accessing regular 1358e2fcbf42SPeter Maydell files. 1359e2fcbf42SPeter Maydell 1360e2fcbf42SPeter Maydell ``filename`` 1361e2fcbf42SPeter Maydell The path to the image file in the local filesystem 1362e2fcbf42SPeter Maydell 1363e2fcbf42SPeter Maydell ``aio`` 1364ad1e691dSStefano Garzarella Specifies the AIO backend (threads/native/io_uring, 1365ad1e691dSStefano Garzarella default: threads) 1366e2fcbf42SPeter Maydell 1367e2fcbf42SPeter Maydell ``locking`` 1368e2fcbf42SPeter Maydell Specifies whether the image file is protected with Linux OFD 1369e2fcbf42SPeter Maydell / POSIX locks. The default is to use the Linux Open File 1370e2fcbf42SPeter Maydell Descriptor API if available, otherwise no lock is applied. 1371e2fcbf42SPeter Maydell (auto/on/off, default: auto) 1372e2fcbf42SPeter Maydell 1373e2fcbf42SPeter Maydell Example: 1374e2fcbf42SPeter Maydell 1375e2fcbf42SPeter Maydell :: 1376e2fcbf42SPeter Maydell 1377e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk,filename=disk.img 1378e2fcbf42SPeter Maydell 1379e2fcbf42SPeter Maydell ``Driver-specific options for raw`` 1380e2fcbf42SPeter Maydell This is the image format block driver for raw images. It is 1381e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1382e2fcbf42SPeter Maydell ``file``. 1383e2fcbf42SPeter Maydell 1384e2fcbf42SPeter Maydell ``file`` 1385e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1386e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1387e2fcbf42SPeter Maydell 1388e2fcbf42SPeter Maydell Example 1: 1389e2fcbf42SPeter Maydell 1390e2fcbf42SPeter Maydell :: 1391e2fcbf42SPeter Maydell 1392e2fcbf42SPeter Maydell -blockdev driver=file,node-name=disk_file,filename=disk.img 1393e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file=disk_file 1394e2fcbf42SPeter Maydell 1395e2fcbf42SPeter Maydell Example 2: 1396e2fcbf42SPeter Maydell 1397e2fcbf42SPeter Maydell :: 1398e2fcbf42SPeter Maydell 1399e2fcbf42SPeter Maydell -blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img 1400e2fcbf42SPeter Maydell 1401e2fcbf42SPeter Maydell ``Driver-specific options for qcow2`` 1402e2fcbf42SPeter Maydell This is the image format block driver for qcow2 images. It is 1403e2fcbf42SPeter Maydell usually stacked on top of a protocol level block driver such as 1404e2fcbf42SPeter Maydell ``file``. 1405e2fcbf42SPeter Maydell 1406e2fcbf42SPeter Maydell ``file`` 1407e2fcbf42SPeter Maydell Reference to or definition of the data source block driver 1408e2fcbf42SPeter Maydell node (e.g. a ``file`` driver node) 1409e2fcbf42SPeter Maydell 1410e2fcbf42SPeter Maydell ``backing`` 1411e2fcbf42SPeter Maydell Reference to or definition of the backing file block device 1412e2fcbf42SPeter Maydell (default is taken from the image file). It is allowed to 1413e2fcbf42SPeter Maydell pass ``null`` here in order to disable the default backing 1414e2fcbf42SPeter Maydell file. 1415e2fcbf42SPeter Maydell 1416e2fcbf42SPeter Maydell ``lazy-refcounts`` 1417e2fcbf42SPeter Maydell Whether to enable the lazy refcounts feature (on/off; 1418e2fcbf42SPeter Maydell default is taken from the image file) 1419e2fcbf42SPeter Maydell 1420e2fcbf42SPeter Maydell ``cache-size`` 1421e2fcbf42SPeter Maydell The maximum total size of the L2 table and refcount block 1422e2fcbf42SPeter Maydell caches in bytes (default: the sum of l2-cache-size and 1423e2fcbf42SPeter Maydell refcount-cache-size) 1424e2fcbf42SPeter Maydell 1425e2fcbf42SPeter Maydell ``l2-cache-size`` 1426e2fcbf42SPeter Maydell The maximum size of the L2 table cache in bytes (default: if 1427e2fcbf42SPeter Maydell cache-size is not specified - 32M on Linux platforms, and 8M 1428e2fcbf42SPeter Maydell on non-Linux platforms; otherwise, as large as possible 1429e2fcbf42SPeter Maydell within the cache-size, while permitting the requested or the 1430e2fcbf42SPeter Maydell minimal refcount cache size) 1431e2fcbf42SPeter Maydell 1432e2fcbf42SPeter Maydell ``refcount-cache-size`` 1433e2fcbf42SPeter Maydell The maximum size of the refcount block cache in bytes 1434e2fcbf42SPeter Maydell (default: 4 times the cluster size; or if cache-size is 1435e2fcbf42SPeter Maydell specified, the part of it which is not used for the L2 1436e2fcbf42SPeter Maydell cache) 1437e2fcbf42SPeter Maydell 1438e2fcbf42SPeter Maydell ``cache-clean-interval`` 1439e2fcbf42SPeter Maydell Clean unused entries in the L2 and refcount caches. The 1440e2fcbf42SPeter Maydell interval is in seconds. The default value is 600 on 1441e2fcbf42SPeter Maydell supporting platforms, and 0 on other platforms. Setting it 1442e2fcbf42SPeter Maydell to 0 disables this feature. 1443e2fcbf42SPeter Maydell 1444e2fcbf42SPeter Maydell ``pass-discard-request`` 1445e2fcbf42SPeter Maydell Whether discard requests to the qcow2 device should be 1446e2fcbf42SPeter Maydell forwarded to the data source (on/off; default: on if 1447e2fcbf42SPeter Maydell discard=unmap is specified, off otherwise) 1448e2fcbf42SPeter Maydell 1449e2fcbf42SPeter Maydell ``pass-discard-snapshot`` 1450e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1451e2fcbf42SPeter Maydell issued when a snapshot operation (e.g. deleting a snapshot) 1452e2fcbf42SPeter Maydell frees clusters in the qcow2 file (on/off; default: on) 1453e2fcbf42SPeter Maydell 1454e2fcbf42SPeter Maydell ``pass-discard-other`` 1455e2fcbf42SPeter Maydell Whether discard requests for the data source should be 1456e2fcbf42SPeter Maydell issued on other occasions where a cluster gets freed 1457e2fcbf42SPeter Maydell (on/off; default: off) 1458e2fcbf42SPeter Maydell 145942a2890aSJean-Louis Dupond ``discard-no-unref`` 1460b2b10904SJean-Louis Dupond When enabled, data clusters will remain preallocated when they are 1461b2b10904SJean-Louis Dupond no longer used, e.g. because they are discarded or converted to 1462b2b10904SJean-Louis Dupond zero clusters. As usual, whether the old data is discarded or kept 1463b2b10904SJean-Louis Dupond on the protocol level (i.e. in the image file) depends on the 1464b2b10904SJean-Louis Dupond setting of the pass-discard-request option. Keeping the clusters 1465b2b10904SJean-Louis Dupond preallocated prevents qcow2 fragmentation that would otherwise be 1466b2b10904SJean-Louis Dupond caused by freeing and re-allocating them later. Besides potential 146742a2890aSJean-Louis Dupond performance degradation, such fragmentation can lead to increased 146842a2890aSJean-Louis Dupond allocation of clusters past the end of the image file, 146942a2890aSJean-Louis Dupond resulting in image files whose file length can grow much larger 147042a2890aSJean-Louis Dupond than their guest disk size would suggest. 147142a2890aSJean-Louis Dupond If image file length is of concern (e.g. when storing qcow2 147242a2890aSJean-Louis Dupond images directly on block devices), you should consider enabling 147342a2890aSJean-Louis Dupond this option. 147442a2890aSJean-Louis Dupond 1475e2fcbf42SPeter Maydell ``overlap-check`` 1476e2fcbf42SPeter Maydell Which overlap checks to perform for writes to the image 1477e2fcbf42SPeter Maydell (none/constant/cached/all; default: cached). For details or 1478e2fcbf42SPeter Maydell finer granularity control refer to the QAPI documentation of 1479e2fcbf42SPeter Maydell ``blockdev-add``. 1480e2fcbf42SPeter Maydell 1481e2fcbf42SPeter Maydell Example 1: 1482e2fcbf42SPeter Maydell 1483e2fcbf42SPeter Maydell :: 1484e2fcbf42SPeter Maydell 1485e2fcbf42SPeter Maydell -blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2 1486e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216 1487e2fcbf42SPeter Maydell 1488e2fcbf42SPeter Maydell Example 2: 1489e2fcbf42SPeter Maydell 1490e2fcbf42SPeter Maydell :: 1491e2fcbf42SPeter Maydell 1492e2fcbf42SPeter Maydell -blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2 1493e2fcbf42SPeter Maydell 1494e2fcbf42SPeter Maydell ``Driver-specific options for other drivers`` 1495e2fcbf42SPeter Maydell Please refer to the QAPI documentation of the ``blockdev-add`` 1496e2fcbf42SPeter Maydell QMP command. 1497e2fcbf42SPeter MaydellERST 149842e5f393SMarkus Armbruster 14995824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 15005824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 150192196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 1502572023f7SKevin Wolf " [,snapshot=on|off][,rerror=ignore|stop|report]\n" 1503ad1e691dSStefano Garzarella " [,werror=ignore|stop|report|enospc][,id=name]\n" 1504ad1e691dSStefano Garzarella " [,aio=threads|native|io_uring]\n" 1505fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 15062f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 15073e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 15083e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 15093e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 15103e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 15112024c1dfSBenoît Canet " [[,iops_size=is]]\n" 151276f4afb4SAlberto Garcia " [[,group=g]]\n" 1513ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1514e2fcbf42SPeter MaydellSRST 1515e2fcbf42SPeter Maydell``-drive option[,option[,option[,...]]]`` 1516e2fcbf42SPeter Maydell Define a new drive. This includes creating a block driver node (the 1517e2fcbf42SPeter Maydell backend) as well as a guest device, and is mostly a shortcut for 1518e2fcbf42SPeter Maydell defining the corresponding ``-blockdev`` and ``-device`` options. 1519e2fcbf42SPeter Maydell 1520e2fcbf42SPeter Maydell ``-drive`` accepts all options that are accepted by ``-blockdev``. 1521e2fcbf42SPeter Maydell In addition, it knows the following options: 1522e2fcbf42SPeter Maydell 1523e2fcbf42SPeter Maydell ``file=file`` 1524923e9311SThomas Huth This option defines which disk image (see the :ref:`disk images` 1525923e9311SThomas Huth chapter in the System Emulation Users Guide) to use with this drive. 1526923e9311SThomas Huth If the filename contains comma, you must double it (for instance, 1527e2fcbf42SPeter Maydell "file=my,,file" to use file "my,file"). 1528e2fcbf42SPeter Maydell 1529e2fcbf42SPeter Maydell Special files such as iSCSI devices can be specified using 1530e2fcbf42SPeter Maydell protocol specific URLs. See the section for "Device URL Syntax" 1531e2fcbf42SPeter Maydell for more information. 1532e2fcbf42SPeter Maydell 1533e2fcbf42SPeter Maydell ``if=interface`` 1534e2fcbf42SPeter Maydell This option defines on which type on interface the drive is 1535e2fcbf42SPeter Maydell connected. Available types are: ide, scsi, sd, mtd, floppy, 1536e2fcbf42SPeter Maydell pflash, virtio, none. 1537e2fcbf42SPeter Maydell 1538e2fcbf42SPeter Maydell ``bus=bus,unit=unit`` 1539e2fcbf42SPeter Maydell These options define where is connected the drive by defining 1540e2fcbf42SPeter Maydell the bus number and the unit id. 1541e2fcbf42SPeter Maydell 1542e2fcbf42SPeter Maydell ``index=index`` 154335aab303SLaurent Vivier This option defines where the drive is connected by using an 1544e2fcbf42SPeter Maydell index in the list of available connectors of a given interface 1545e2fcbf42SPeter Maydell type. 1546e2fcbf42SPeter Maydell 1547e2fcbf42SPeter Maydell ``media=media`` 1548e2fcbf42SPeter Maydell This option defines the type of the media: disk or cdrom. 1549e2fcbf42SPeter Maydell 1550e2fcbf42SPeter Maydell ``snapshot=snapshot`` 1551e2fcbf42SPeter Maydell snapshot is "on" or "off" and controls snapshot mode for the 1552e2fcbf42SPeter Maydell given drive (see ``-snapshot``). 1553e2fcbf42SPeter Maydell 1554e2fcbf42SPeter Maydell ``cache=cache`` 1555e2fcbf42SPeter Maydell cache is "none", "writeback", "unsafe", "directsync" or 1556e2fcbf42SPeter Maydell "writethrough" and controls how the host cache is used to access 1557e2fcbf42SPeter Maydell block data. This is a shortcut that sets the ``cache.direct`` 1558e2fcbf42SPeter Maydell and ``cache.no-flush`` options (as in ``-blockdev``), and 1559e2fcbf42SPeter Maydell additionally ``cache.writeback``, which provides a default for 1560e2fcbf42SPeter Maydell the ``write-cache`` option of block guest devices (as in 1561e2fcbf42SPeter Maydell ``-device``). The modes correspond to the following settings: 1562e2fcbf42SPeter Maydell 156309ce5f2dSPeter Maydell ============= =============== ============ ============== 156409ce5f2dSPeter Maydell \ cache.writeback cache.direct cache.no-flush 156509ce5f2dSPeter Maydell ============= =============== ============ ============== 156609ce5f2dSPeter Maydell writeback on off off 156709ce5f2dSPeter Maydell none on on off 156809ce5f2dSPeter Maydell writethrough off off off 156909ce5f2dSPeter Maydell directsync off on off 157009ce5f2dSPeter Maydell unsafe on off on 157109ce5f2dSPeter Maydell ============= =============== ============ ============== 1572e2fcbf42SPeter Maydell 1573e2fcbf42SPeter Maydell The default mode is ``cache=writeback``. 1574e2fcbf42SPeter Maydell 1575e2fcbf42SPeter Maydell ``aio=aio`` 1576ad1e691dSStefano Garzarella aio is "threads", "native", or "io_uring" and selects between pthread 1577ad1e691dSStefano Garzarella based disk I/O, native Linux AIO, or Linux io_uring API. 1578e2fcbf42SPeter Maydell 1579e2fcbf42SPeter Maydell ``format=format`` 1580e2fcbf42SPeter Maydell Specify which disk format will be used rather than detecting the 1581e2fcbf42SPeter Maydell format. Can be used to specify format=raw to avoid interpreting 1582e2fcbf42SPeter Maydell an untrusted format header. 1583e2fcbf42SPeter Maydell 1584e2fcbf42SPeter Maydell ``werror=action,rerror=action`` 1585e2fcbf42SPeter Maydell Specify which action to take on write and read errors. Valid 1586e2fcbf42SPeter Maydell actions are: "ignore" (ignore the error and try to continue), 1587e2fcbf42SPeter Maydell "stop" (pause QEMU), "report" (report the error to the guest), 1588e2fcbf42SPeter Maydell "enospc" (pause QEMU only if the host disk is full; report the 1589e2fcbf42SPeter Maydell error to the guest otherwise). The default setting is 1590e2fcbf42SPeter Maydell ``werror=enospc`` and ``rerror=report``. 1591e2fcbf42SPeter Maydell 1592e2fcbf42SPeter Maydell ``copy-on-read=copy-on-read`` 1593e2fcbf42SPeter Maydell copy-on-read is "on" or "off" and enables whether to copy read 1594e2fcbf42SPeter Maydell backing file sectors into the image file. 1595e2fcbf42SPeter Maydell 1596e2fcbf42SPeter Maydell ``bps=b,bps_rd=r,bps_wr=w`` 1597e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1598e2fcbf42SPeter Maydell for all request types or for reads or writes only. Small values 1599e2fcbf42SPeter Maydell can lead to timeouts or hangs inside the guest. A safe minimum 1600e2fcbf42SPeter Maydell for disks is 2 MB/s. 1601e2fcbf42SPeter Maydell 1602e2fcbf42SPeter Maydell ``bps_max=bm,bps_rd_max=rm,bps_wr_max=wm`` 1603e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1604e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1605e2fcbf42SPeter Maydell above the limit temporarily. 1606e2fcbf42SPeter Maydell 1607e2fcbf42SPeter Maydell ``iops=i,iops_rd=r,iops_wr=w`` 1608e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1609e2fcbf42SPeter Maydell all request types or for reads or writes only. 1610e2fcbf42SPeter Maydell 1611e2fcbf42SPeter Maydell ``iops_max=bm,iops_rd_max=rm,iops_wr_max=wm`` 1612e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1613e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1614e2fcbf42SPeter Maydell spike above the limit temporarily. 1615e2fcbf42SPeter Maydell 1616e2fcbf42SPeter Maydell ``iops_size=is`` 1617e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1618e2fcbf42SPeter Maydell throttling purposes. Use this option to prevent guests from 1619e2fcbf42SPeter Maydell circumventing iops limits by sending fewer but larger requests. 1620e2fcbf42SPeter Maydell 1621e2fcbf42SPeter Maydell ``group=g`` 1622e2fcbf42SPeter Maydell Join a throttling quota group with given name g. All drives that 1623e2fcbf42SPeter Maydell are members of the same group are accounted for together. Use 1624e2fcbf42SPeter Maydell this option to prevent guests from circumventing throttling 1625e2fcbf42SPeter Maydell limits by using many small disks instead of a single larger 1626e2fcbf42SPeter Maydell disk. 1627e2fcbf42SPeter Maydell 1628e2fcbf42SPeter Maydell By default, the ``cache.writeback=on`` mode is used. It will report 1629e2fcbf42SPeter Maydell data writes as completed as soon as the data is present in the host 1630e2fcbf42SPeter Maydell page cache. This is safe as long as your guest OS makes sure to 1631e2fcbf42SPeter Maydell correctly flush disk caches where needed. If your guest OS does not 1632e2fcbf42SPeter Maydell handle volatile disk write caches correctly and your host crashes or 1633e2fcbf42SPeter Maydell loses power, then the guest may experience data corruption. 1634e2fcbf42SPeter Maydell 1635e2fcbf42SPeter Maydell For such guests, you should consider using ``cache.writeback=off``. 1636e2fcbf42SPeter Maydell This means that the host page cache will be used to read and write 1637e2fcbf42SPeter Maydell data, but write notification will be sent to the guest only after 1638e2fcbf42SPeter Maydell QEMU has made sure to flush each write to the disk. Be aware that 1639e2fcbf42SPeter Maydell this has a major impact on performance. 1640e2fcbf42SPeter Maydell 1641e2fcbf42SPeter Maydell When using the ``-snapshot`` option, unsafe caching is always used. 1642e2fcbf42SPeter Maydell 1643e2fcbf42SPeter Maydell Copy-on-read avoids accessing the same backing file sectors 1644e2fcbf42SPeter Maydell repeatedly and is useful when the backing file is over a slow 1645e2fcbf42SPeter Maydell network. By default copy-on-read is off. 1646e2fcbf42SPeter Maydell 1647e2fcbf42SPeter Maydell Instead of ``-cdrom`` you can use: 1648e2fcbf42SPeter Maydell 1649e2fcbf42SPeter Maydell .. parsed-literal:: 1650e2fcbf42SPeter Maydell 1651e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=cdrom 1652e2fcbf42SPeter Maydell 1653e2fcbf42SPeter Maydell Instead of ``-hda``, ``-hdb``, ``-hdc``, ``-hdd``, you can use: 1654e2fcbf42SPeter Maydell 1655e2fcbf42SPeter Maydell .. parsed-literal:: 1656e2fcbf42SPeter Maydell 1657e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=0,media=disk 1658e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=1,media=disk 1659e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=2,media=disk 1660e2fcbf42SPeter Maydell |qemu_system| -drive file=file,index=3,media=disk 1661e2fcbf42SPeter Maydell 1662e2fcbf42SPeter Maydell You can open an image using pre-opened file descriptors from an fd 1663e2fcbf42SPeter Maydell set: 1664e2fcbf42SPeter Maydell 1665e2fcbf42SPeter Maydell .. parsed-literal:: 1666e2fcbf42SPeter Maydell 1667353a06b4SLaszlo Ersek |qemu_system| \\ 1668353a06b4SLaszlo Ersek -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" \\ 1669353a06b4SLaszlo Ersek -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" \\ 1670e2fcbf42SPeter Maydell -drive file=/dev/fdset/2,index=0,media=disk 1671e2fcbf42SPeter Maydell 1672e2fcbf42SPeter Maydell You can connect a CDROM to the slave of ide0: 1673e2fcbf42SPeter Maydell 1674e2fcbf42SPeter Maydell .. parsed-literal:: 1675e2fcbf42SPeter Maydell 1676e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,if=ide,index=1,media=cdrom 1677e2fcbf42SPeter Maydell 1678e2fcbf42SPeter Maydell If you don't specify the "file=" argument, you define an empty 1679e2fcbf42SPeter Maydell drive: 1680e2fcbf42SPeter Maydell 1681e2fcbf42SPeter Maydell .. parsed-literal:: 1682e2fcbf42SPeter Maydell 1683e2fcbf42SPeter Maydell |qemu_system_x86| -drive if=ide,index=1,media=cdrom 1684e2fcbf42SPeter Maydell 1685e2fcbf42SPeter Maydell Instead of ``-fda``, ``-fdb``, you can use: 1686e2fcbf42SPeter Maydell 1687e2fcbf42SPeter Maydell .. parsed-literal:: 1688e2fcbf42SPeter Maydell 1689e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=0,if=floppy 1690e2fcbf42SPeter Maydell |qemu_system_x86| -drive file=file,index=1,if=floppy 1691e2fcbf42SPeter Maydell 1692e2fcbf42SPeter Maydell By default, interface is "ide" and index is automatically 1693e2fcbf42SPeter Maydell incremented: 1694e2fcbf42SPeter Maydell 1695e2fcbf42SPeter Maydell .. parsed-literal:: 1696e2fcbf42SPeter Maydell 1697a234ec31SJohn Snow |qemu_system_x86| -drive file=a -drive file=b 1698e2fcbf42SPeter Maydell 1699e2fcbf42SPeter Maydell is interpreted like: 1700e2fcbf42SPeter Maydell 1701e2fcbf42SPeter Maydell .. parsed-literal:: 1702e2fcbf42SPeter Maydell 1703e2fcbf42SPeter Maydell |qemu_system_x86| -hda a -hdb b 1704e2fcbf42SPeter MaydellERST 17055824d651Sblueswir1 17065824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 1707ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 1708ad96090aSBlue Swirl QEMU_ARCH_ALL) 1709e2fcbf42SPeter MaydellSRST 1710e2fcbf42SPeter Maydell``-mtdblock file`` 1711e2fcbf42SPeter Maydell Use file as on-board Flash memory image. 1712e2fcbf42SPeter MaydellERST 17135824d651Sblueswir1 17145824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 1715ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 1716e2fcbf42SPeter MaydellSRST 1717e2fcbf42SPeter Maydell``-sd file`` 1718e2fcbf42SPeter Maydell Use file as SecureDigital card image. 1719e2fcbf42SPeter MaydellERST 17205824d651Sblueswir1 17215824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 1722ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 1723ad96090aSBlue Swirl QEMU_ARCH_ALL) 1724e2fcbf42SPeter MaydellSRST 1725e2fcbf42SPeter Maydell``-snapshot`` 1726e2fcbf42SPeter Maydell Write to temporary files instead of disk image files. In this case, 1727e2fcbf42SPeter Maydell the raw disk image you use is not written back. You can however 1728923e9311SThomas Huth force the write back by pressing C-a s (see the :ref:`disk images` 1729923e9311SThomas Huth chapter in the System Emulation Users Guide). 1730c1654c3eSAlex Bennée 1731c1654c3eSAlex Bennée .. warning:: 1732c1654c3eSAlex Bennée snapshot is incompatible with ``-blockdev`` (instead use qemu-img 1733c1654c3eSAlex Bennée to manually create snapshot images to attach to your blockdev). 1734c1654c3eSAlex Bennée If you have mixed ``-blockdev`` and ``-drive`` declarations you 1735c1654c3eSAlex Bennée can use the 'snapshot' property on your drive declarations 1736c1654c3eSAlex Bennée instead of this global option. 1737c1654c3eSAlex Bennée 1738e2fcbf42SPeter MaydellERST 17395824d651Sblueswir1 174074db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 1741b44a6b09SGreg Kurz "-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1742991c180dSPaolo Bonzini " [,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode]\n" 1743b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n" 1744b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n" 1745b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n" 1746b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n" 1747b44a6b09SGreg Kurz " [[,throttling.iops-size=is]]\n" 1748991c180dSPaolo Bonzini "-fsdev proxy,id=id,socket=socket[,writeout=immediate][,readonly=on]\n" 1749991c180dSPaolo Bonzini "-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=immediate][,readonly=on]\n" 1750b44a6b09SGreg Kurz "-fsdev synth,id=id\n", 175174db920cSGautham R Shenoy QEMU_ARCH_ALL) 175274db920cSGautham R Shenoy 1753e2fcbf42SPeter MaydellSRST 1754991c180dSPaolo 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[,...]]]`` 175509ce5f2dSPeter Maydell \ 1756991c180dSPaolo Bonzini``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly=on]`` 175709ce5f2dSPeter Maydell \ 1758991c180dSPaolo Bonzini``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly=on]`` 175909ce5f2dSPeter Maydell \ 1760991c180dSPaolo Bonzini``-fsdev synth,id=id[,readonly=on]`` 1761e2fcbf42SPeter Maydell Define a new file system device. Valid options are: 1762e2fcbf42SPeter Maydell 1763e2fcbf42SPeter Maydell ``local`` 1764e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1765e2fcbf42SPeter Maydell 1766e2fcbf42SPeter Maydell ``proxy`` 176771d72eceSChristian Schoenebeck Accesses to the filesystem are done by virtfs-proxy-helper(1). This 176871d72eceSChristian Schoenebeck option is deprecated (since QEMU 8.1) and will be removed in a future 176971d72eceSChristian Schoenebeck version of QEMU. Use ``local`` instead. 1770e2fcbf42SPeter Maydell 1771e2fcbf42SPeter Maydell ``synth`` 1772e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1773e2fcbf42SPeter Maydell 1774e2fcbf42SPeter Maydell ``id=id`` 1775e2fcbf42SPeter Maydell Specifies identifier for this device. 1776e2fcbf42SPeter Maydell 1777e2fcbf42SPeter Maydell ``path=path`` 1778e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1779e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1780e2fcbf42SPeter Maydell 1781e2fcbf42SPeter Maydell ``security_model=security_model`` 1782e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1783e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1784e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1785e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1786e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1787e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1788e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1789e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1790e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1791e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1792e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1793e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1794e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1795e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1796e2fcbf42SPeter Maydell parameter. 1797e2fcbf42SPeter Maydell 1798e2fcbf42SPeter Maydell ``writeout=writeout`` 1799e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1800e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1801e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1802e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1803e2fcbf42SPeter Maydell storage subsystem. 1804e2fcbf42SPeter Maydell 1805991c180dSPaolo Bonzini ``readonly=on`` 1806e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1807e2fcbf42SPeter Maydell default read-write access is given. 1808e2fcbf42SPeter Maydell 1809e2fcbf42SPeter Maydell ``socket=socket`` 1810e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1811e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). 1812e2fcbf42SPeter Maydell 1813e2fcbf42SPeter Maydell ``sock_fd=sock_fd`` 1814e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket descriptor 1815e2fcbf42SPeter Maydell for communicating with virtfs-proxy-helper(1). Usually a helper 1816e2fcbf42SPeter Maydell like libvirt will create socketpair and pass one of the fds as 1817e2fcbf42SPeter Maydell sock\_fd. 1818e2fcbf42SPeter Maydell 1819e2fcbf42SPeter Maydell ``fmode=fmode`` 1820e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1821e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1822e2fcbf42SPeter Maydell "mapped-file". 1823e2fcbf42SPeter Maydell 1824e2fcbf42SPeter Maydell ``dmode=dmode`` 1825e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1826e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1827e2fcbf42SPeter Maydell "mapped-file". 1828e2fcbf42SPeter Maydell 1829e2fcbf42SPeter Maydell ``throttling.bps-total=b,throttling.bps-read=r,throttling.bps-write=w`` 1830e2fcbf42SPeter Maydell Specify bandwidth throttling limits in bytes per second, either 1831e2fcbf42SPeter Maydell for all request types or for reads or writes only. 1832e2fcbf42SPeter Maydell 1833e2fcbf42SPeter Maydell ``throttling.bps-total-max=bm,bps-read-max=rm,bps-write-max=wm`` 1834e2fcbf42SPeter Maydell Specify bursts in bytes per second, either for all request types 1835e2fcbf42SPeter Maydell or for reads or writes only. Bursts allow the guest I/O to spike 1836e2fcbf42SPeter Maydell above the limit temporarily. 1837e2fcbf42SPeter Maydell 1838e2fcbf42SPeter Maydell ``throttling.iops-total=i,throttling.iops-read=r, throttling.iops-write=w`` 1839e2fcbf42SPeter Maydell Specify request rate limits in requests per second, either for 1840e2fcbf42SPeter Maydell all request types or for reads or writes only. 1841e2fcbf42SPeter Maydell 1842e2fcbf42SPeter Maydell ``throttling.iops-total-max=im,throttling.iops-read-max=irm, throttling.iops-write-max=iwm`` 1843e2fcbf42SPeter Maydell Specify bursts in requests per second, either for all request 1844e2fcbf42SPeter Maydell types or for reads or writes only. Bursts allow the guest I/O to 1845e2fcbf42SPeter Maydell spike above the limit temporarily. 1846e2fcbf42SPeter Maydell 1847e2fcbf42SPeter Maydell ``throttling.iops-size=is`` 1848e2fcbf42SPeter Maydell Let every is bytes of a request count as a new request for iops 1849e2fcbf42SPeter Maydell throttling purposes. 1850e2fcbf42SPeter Maydell 1851e2fcbf42SPeter Maydell -fsdev option is used along with -device driver "virtio-9p-...". 1852e2fcbf42SPeter Maydell 1853e2fcbf42SPeter Maydell``-device virtio-9p-type,fsdev=id,mount_tag=mount_tag`` 1854e2fcbf42SPeter Maydell Options for virtio-9p-... driver are: 1855e2fcbf42SPeter Maydell 1856e2fcbf42SPeter Maydell ``type`` 1857e2fcbf42SPeter Maydell Specifies the variant to be used. Supported values are "pci", 1858e2fcbf42SPeter Maydell "ccw" or "device", depending on the machine type. 1859e2fcbf42SPeter Maydell 1860e2fcbf42SPeter Maydell ``fsdev=id`` 1861e2fcbf42SPeter Maydell Specifies the id value specified along with -fsdev option. 1862e2fcbf42SPeter Maydell 1863e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1864e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1865e2fcbf42SPeter Maydell export point. 1866e2fcbf42SPeter MaydellERST 186774db920cSGautham R Shenoy 18683d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 1869b44a6b09SGreg Kurz "-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n" 1870991c180dSPaolo Bonzini " [,id=id][,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode][,multidevs=remap|forbid|warn]\n" 1871991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,socket=socket[,id=id][,writeout=immediate][,readonly=on]\n" 1872991c180dSPaolo Bonzini "-virtfs proxy,mount_tag=tag,sock_fd=sock_fd[,id=id][,writeout=immediate][,readonly=on]\n" 1873991c180dSPaolo Bonzini "-virtfs synth,mount_tag=tag[,id=id][,readonly=on]\n", 18743d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 18753d54abc7SGautham R Shenoy 1876e2fcbf42SPeter MaydellSRST 1877991c180dSPaolo Bonzini``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly=on] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]`` 187809ce5f2dSPeter Maydell \ 1879991c180dSPaolo Bonzini``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 188009ce5f2dSPeter Maydell \ 1881991c180dSPaolo Bonzini``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` 188209ce5f2dSPeter Maydell \ 188309ce5f2dSPeter Maydell``-virtfs synth,mount_tag=mount_tag`` 188465abaa01SChristian Schoenebeck Define a new virtual filesystem device and expose it to the guest using 188565abaa01SChristian Schoenebeck a virtio-9p-device (a.k.a. 9pfs), which essentially means that a certain 188665abaa01SChristian Schoenebeck directory on host is made directly accessible by guest as a pass-through 188765abaa01SChristian Schoenebeck file system by using the 9P network protocol for communication between 188865abaa01SChristian Schoenebeck host and guests, if desired even accessible, shared by several guests 18892cb40d44SStefan Weil simultaneously. 189065abaa01SChristian Schoenebeck 189165abaa01SChristian Schoenebeck Note that ``-virtfs`` is actually just a convenience shortcut for its 189265abaa01SChristian Schoenebeck generalized form ``-fsdev -device virtio-9p-pci``. 189365abaa01SChristian Schoenebeck 189465abaa01SChristian Schoenebeck The general form of pass-through file system options are: 1895e2fcbf42SPeter Maydell 1896e2fcbf42SPeter Maydell ``local`` 1897e2fcbf42SPeter Maydell Accesses to the filesystem are done by QEMU. 1898e2fcbf42SPeter Maydell 1899e2fcbf42SPeter Maydell ``proxy`` 1900e2fcbf42SPeter Maydell Accesses to the filesystem are done by virtfs-proxy-helper(1). 190171d72eceSChristian Schoenebeck This option is deprecated (since QEMU 8.1) and will be removed in a 190271d72eceSChristian Schoenebeck future version of QEMU. Use ``local`` instead. 1903e2fcbf42SPeter Maydell 1904e2fcbf42SPeter Maydell ``synth`` 1905e2fcbf42SPeter Maydell Synthetic filesystem, only used by QTests. 1906e2fcbf42SPeter Maydell 1907e2fcbf42SPeter Maydell ``id=id`` 1908e2fcbf42SPeter Maydell Specifies identifier for the filesystem device 1909e2fcbf42SPeter Maydell 1910e2fcbf42SPeter Maydell ``path=path`` 1911e2fcbf42SPeter Maydell Specifies the export path for the file system device. Files 1912e2fcbf42SPeter Maydell under this path will be available to the 9p client on the guest. 1913e2fcbf42SPeter Maydell 1914e2fcbf42SPeter Maydell ``security_model=security_model`` 1915e2fcbf42SPeter Maydell Specifies the security model to be used for this export path. 1916e2fcbf42SPeter Maydell Supported security models are "passthrough", "mapped-xattr", 1917e2fcbf42SPeter Maydell "mapped-file" and "none". In "passthrough" security model, files 1918e2fcbf42SPeter Maydell are stored using the same credentials as they are created on the 1919e2fcbf42SPeter Maydell guest. This requires QEMU to run as root. In "mapped-xattr" 1920e2fcbf42SPeter Maydell security model, some of the file attributes like uid, gid, mode 1921e2fcbf42SPeter Maydell bits and link target are stored as file attributes. For 1922e2fcbf42SPeter Maydell "mapped-file" these attributes are stored in the hidden 1923e2fcbf42SPeter Maydell .virtfs\_metadata directory. Directories exported by this 1924e2fcbf42SPeter Maydell security model cannot interact with other unix tools. "none" 1925e2fcbf42SPeter Maydell security model is same as passthrough except the sever won't 1926e2fcbf42SPeter Maydell report failures if it fails to set file attributes like 1927e2fcbf42SPeter Maydell ownership. Security model is mandatory only for local fsdriver. 1928e2fcbf42SPeter Maydell Other fsdrivers (like proxy) don't take security model as a 1929e2fcbf42SPeter Maydell parameter. 1930e2fcbf42SPeter Maydell 1931e2fcbf42SPeter Maydell ``writeout=writeout`` 1932e2fcbf42SPeter Maydell This is an optional argument. The only supported value is 1933e2fcbf42SPeter Maydell "immediate". This means that host page cache will be used to 1934e2fcbf42SPeter Maydell read and write data but write notification will be sent to the 1935e2fcbf42SPeter Maydell guest only when the data has been reported as written by the 1936e2fcbf42SPeter Maydell storage subsystem. 1937e2fcbf42SPeter Maydell 1938991c180dSPaolo Bonzini ``readonly=on`` 1939e2fcbf42SPeter Maydell Enables exporting 9p share as a readonly mount for guests. By 1940e2fcbf42SPeter Maydell default read-write access is given. 1941e2fcbf42SPeter Maydell 1942e2fcbf42SPeter Maydell ``socket=socket`` 1943e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed socket file for 1944e2fcbf42SPeter Maydell communicating with virtfs-proxy-helper(1). Usually a helper like 1945e2fcbf42SPeter Maydell libvirt will create socketpair and pass one of the fds as 1946e2fcbf42SPeter Maydell sock\_fd. 1947e2fcbf42SPeter Maydell 1948e2fcbf42SPeter Maydell ``sock_fd`` 1949e2fcbf42SPeter Maydell Enables proxy filesystem driver to use passed 'sock\_fd' as the 1950e2fcbf42SPeter Maydell socket descriptor for interfacing with virtfs-proxy-helper(1). 1951e2fcbf42SPeter Maydell 1952e2fcbf42SPeter Maydell ``fmode=fmode`` 1953e2fcbf42SPeter Maydell Specifies the default mode for newly created files on the host. 1954e2fcbf42SPeter Maydell Works only with security models "mapped-xattr" and 1955e2fcbf42SPeter Maydell "mapped-file". 1956e2fcbf42SPeter Maydell 1957e2fcbf42SPeter Maydell ``dmode=dmode`` 1958e2fcbf42SPeter Maydell Specifies the default mode for newly created directories on the 1959e2fcbf42SPeter Maydell host. Works only with security models "mapped-xattr" and 1960e2fcbf42SPeter Maydell "mapped-file". 1961e2fcbf42SPeter Maydell 1962e2fcbf42SPeter Maydell ``mount_tag=mount_tag`` 1963e2fcbf42SPeter Maydell Specifies the tag name to be used by the guest to mount this 1964e2fcbf42SPeter Maydell export point. 1965e2fcbf42SPeter Maydell 1966e2fcbf42SPeter Maydell ``multidevs=multidevs`` 1967e2fcbf42SPeter Maydell Specifies how to deal with multiple devices being shared with a 1968e2fcbf42SPeter Maydell 9p export. Supported behaviours are either "remap", "forbid" or 1969e2fcbf42SPeter Maydell "warn". The latter is the default behaviour on which virtfs 9p 1970e2fcbf42SPeter Maydell expects only one device to be shared with the same export, and 1971e2fcbf42SPeter Maydell if more than one device is shared and accessed via the same 9p 1972e2fcbf42SPeter Maydell export then only a warning message is logged (once) by qemu on 1973e2fcbf42SPeter Maydell host side. In order to avoid file ID collisions on guest you 1974e2fcbf42SPeter Maydell should either create a separate virtfs export for each device to 1975e2fcbf42SPeter Maydell be shared with guests (recommended way) or you might use "remap" 1976e2fcbf42SPeter Maydell instead which allows you to share multiple devices with only one 1977e2fcbf42SPeter Maydell export instead, which is achieved by remapping the original 1978e2fcbf42SPeter Maydell inode numbers from host to guest in a way that would prevent 1979e2fcbf42SPeter Maydell such collisions. Remapping inodes in such use cases is required 1980e2fcbf42SPeter Maydell because the original device IDs from host are never passed and 1981e2fcbf42SPeter Maydell exposed on guest. Instead all files of an export shared with 1982e2fcbf42SPeter Maydell virtfs always share the same device id on guest. So two files 1983e2fcbf42SPeter Maydell with identical inode numbers but from actually different devices 1984e2fcbf42SPeter Maydell on host would otherwise cause a file ID collision and hence 1985e2fcbf42SPeter Maydell potential misbehaviours on guest. "forbid" on the other hand 1986e2fcbf42SPeter Maydell assumes like "warn" that only one device is shared by the same 1987e2fcbf42SPeter Maydell export, however it will not only log a warning message but also 1988e2fcbf42SPeter Maydell deny access to additional devices on guest. Note though that 1989e2fcbf42SPeter Maydell "forbid" does currently not block all possible file access 1990e2fcbf42SPeter Maydell operations (e.g. readdir() would still return entries from other 1991e2fcbf42SPeter Maydell devices). 1992e2fcbf42SPeter MaydellERST 19933d54abc7SGautham R Shenoy 199461d70487SMarkus ArmbrusterDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 1995c3b3a6c9SDaniel P. Berrangé "-iscsi [user=user][,password=password][,password-secret=secret-id]\n" 1996c3b3a6c9SDaniel P. Berrangé " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE]\n" 199761d70487SMarkus Armbruster " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 199861d70487SMarkus Armbruster " [,timeout=timeout]\n" 199961d70487SMarkus Armbruster " iSCSI session parameters\n", QEMU_ARCH_ALL) 200061d70487SMarkus Armbruster 2001e2fcbf42SPeter MaydellSRST 2002e2fcbf42SPeter Maydell``-iscsi`` 2003e2fcbf42SPeter Maydell Configure iSCSI session parameters. 2004e2fcbf42SPeter MaydellERST 200544743148SMarkus Armbruster 20065824d651Sblueswir1DEFHEADING() 20075824d651Sblueswir1 2008c2a34ab2SThomas HuthDEFHEADING(USB convenience options:) 200910adb8beSMarkus Armbruster 201010adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 201173f46fefSStefan Hajnoczi "-usb enable on-board USB host controller (if not enabled by default)\n", 201210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 2013e2fcbf42SPeter MaydellSRST 2014e2fcbf42SPeter Maydell``-usb`` 2015e2fcbf42SPeter Maydell Enable USB emulation on machine types with an on-board USB host 2016e2fcbf42SPeter Maydell controller (if not enabled by default). Note that on-board USB host 2017e2fcbf42SPeter Maydell controllers may not support USB 3.0. In this case 2018e2fcbf42SPeter Maydell ``-device qemu-xhci`` can be used instead on machines with PCI. 2019e2fcbf42SPeter MaydellERST 202010adb8beSMarkus Armbruster 202110adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 202210adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 202310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 2024e2fcbf42SPeter MaydellSRST 2025e2fcbf42SPeter Maydell``-usbdevice devname`` 2026c2a34ab2SThomas Huth Add the USB device devname, and enable an on-board USB controller 2027c2a34ab2SThomas Huth if possible and necessary (just like it can be done via 2028c2a34ab2SThomas Huth ``-machine usb=on``). Note that this option is mainly intended for 2029c2a34ab2SThomas Huth the user's convenience only. More fine-grained control can be 2030c2a34ab2SThomas Huth achieved by selecting a USB host controller (if necessary) and the 2031c2a34ab2SThomas Huth desired USB device via the ``-device`` option instead. For example, 2032c2a34ab2SThomas Huth instead of using ``-usbdevice mouse`` it is possible to use 2033c2a34ab2SThomas Huth ``-device qemu-xhci -device usb-mouse`` to connect the USB mouse 2034c2a34ab2SThomas Huth to a USB 3.0 controller instead (at least on machines that support 2035c2a34ab2SThomas Huth PCI and do not have an USB controller enabled by default yet). 2036c2a34ab2SThomas Huth For more details, see the chapter about 2037923e9311SThomas Huth :ref:`Connecting USB devices` in the System Emulation Users Guide. 2038c2a34ab2SThomas Huth Possible devices for devname are: 2039c2a34ab2SThomas Huth 2040c2a34ab2SThomas Huth ``braille`` 2041c2a34ab2SThomas Huth Braille device. This will use BrlAPI to display the braille 2042c2a34ab2SThomas Huth output on a real or fake device (i.e. it also creates a 2043c2a34ab2SThomas Huth corresponding ``braille`` chardev automatically beside the 2044c2a34ab2SThomas Huth ``usb-braille`` USB device). 2045c2a34ab2SThomas Huth 2046c2a34ab2SThomas Huth ``keyboard`` 2047c2a34ab2SThomas Huth Standard USB keyboard. Will override the PS/2 keyboard (if present). 2048e2fcbf42SPeter Maydell 2049e2fcbf42SPeter Maydell ``mouse`` 2050e2fcbf42SPeter Maydell Virtual Mouse. This will override the PS/2 mouse emulation when 2051e2fcbf42SPeter Maydell activated. 2052e2fcbf42SPeter Maydell 2053e2fcbf42SPeter Maydell ``tablet`` 2054e2fcbf42SPeter Maydell Pointer device that uses absolute coordinates (like a 2055e2fcbf42SPeter Maydell touchscreen). This means QEMU is able to report the mouse 2056e2fcbf42SPeter Maydell position without having to grab the mouse. Also overrides the 2057e2fcbf42SPeter Maydell PS/2 mouse emulation when activated. 2058e2fcbf42SPeter Maydell 2059c2a34ab2SThomas Huth ``wacom-tablet`` 2060c2a34ab2SThomas Huth Wacom PenPartner USB tablet. 2061c2a34ab2SThomas Huth 2062c2a34ab2SThomas Huth 2063e2fcbf42SPeter MaydellERST 206410adb8beSMarkus Armbruster 206510adb8beSMarkus ArmbrusterDEFHEADING() 206610adb8beSMarkus Armbruster 2067de6b4f90SMarkus ArmbrusterDEFHEADING(Display options:) 20685824d651Sblueswir1 20691472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 207088b40c68SThomas Huth#if defined(CONFIG_SPICE) 2071d8aec9d9SMarc-André Lureau "-display spice-app[,gl=on|off]\n" 207288b40c68SThomas Huth#endif 207388b40c68SThomas Huth#if defined(CONFIG_SDL) 2074a743d60bSThomas Huth "-display sdl[,gl=on|core|es|off][,grab-mod=<mod>][,show-cursor=on|off]\n" 2075a743d60bSThomas Huth " [,window-close=on|off]\n" 207688b40c68SThomas Huth#endif 207788b40c68SThomas Huth#if defined(CONFIG_GTK) 207895f439bdSThomas Huth "-display gtk[,full-screen=on|off][,gl=on|off][,grab-on-hover=on|off]\n" 2079c34a9338SFelix xq Queißner " [,show-tabs=on|off][,show-cursor=on|off][,window-close=on|off]\n" 2080dbccb1a5SBryce Mills " [,show-menubar=on|off]\n" 208188b40c68SThomas Huth#endif 208288b40c68SThomas Huth#if defined(CONFIG_VNC) 2083f04ec5afSRobert Ho "-display vnc=<display>[,<optargs>]\n" 208488b40c68SThomas Huth#endif 208588b40c68SThomas Huth#if defined(CONFIG_CURSES) 20862f8b7cd5SSamuel Thibault "-display curses[,charset=<encoding>]\n" 208788b40c68SThomas Huth#endif 2088f844cdb9SGustavo Noronha Silva#if defined(CONFIG_COCOA) 20894797adceSGustavo Noronha Silva "-display cocoa[,full-grab=on|off][,swap-opt-cmd=on|off]\n" 2090f844cdb9SGustavo Noronha Silva#endif 209188b40c68SThomas Huth#if defined(CONFIG_OPENGL) 209288b40c68SThomas Huth "-display egl-headless[,rendernode=<file>]\n" 209388b40c68SThomas Huth#endif 2094142ca628SMarc-André Lureau#if defined(CONFIG_DBUS_DISPLAY) 2095142ca628SMarc-André Lureau "-display dbus[,addr=<dbusaddr>]\n" 2096142ca628SMarc-André Lureau " [,gl=on|core|es|off][,rendernode=<file>]\n" 2097142ca628SMarc-André Lureau#endif 209848941a52SCarwyn Ellis#if defined(CONFIG_COCOA) 209948941a52SCarwyn Ellis "-display cocoa[,show-cursor=on|off][,left-command-key=on|off]\n" 210048941a52SCarwyn Ellis#endif 2101144aaa99SErik Skultety "-display none\n" 210288b40c68SThomas Huth " select display backend type\n" 2103f04ec5afSRobert Ho " The default display is equivalent to\n " 2104f04ec5afSRobert Ho#if defined(CONFIG_GTK) 210588b40c68SThomas Huth "\"-display gtk\"\n" 2106f04ec5afSRobert Ho#elif defined(CONFIG_SDL) 210788b40c68SThomas Huth "\"-display sdl\"\n" 2108f04ec5afSRobert Ho#elif defined(CONFIG_COCOA) 210988b40c68SThomas Huth "\"-display cocoa\"\n" 2110f04ec5afSRobert Ho#elif defined(CONFIG_VNC) 211188b40c68SThomas Huth "\"-vnc localhost:0,to=99,id=default\"\n" 2112f04ec5afSRobert Ho#else 211388b40c68SThomas Huth "\"-display none\"\n" 2114f04ec5afSRobert Ho#endif 2115f04ec5afSRobert Ho , QEMU_ARCH_ALL) 2116e2fcbf42SPeter MaydellSRST 2117e2fcbf42SPeter Maydell``-display type`` 2118707d93d4SThomas Huth Select type of display to use. Use ``-display help`` to list the available 2119707d93d4SThomas Huth display types. Valid values for type are 2120e2fcbf42SPeter Maydell 2121ddc71758SAhmed Abouzied ``spice-app[,gl=on|off]`` 2122ddc71758SAhmed Abouzied Start QEMU as a Spice server and launch the default Spice client 2123ddc71758SAhmed Abouzied application. The Spice server will redirect the serial consoles 2124ddc71758SAhmed Abouzied and QEMU monitors. (Since 4.0) 2125ddc71758SAhmed Abouzied 2126142ca628SMarc-André Lureau ``dbus`` 2127142ca628SMarc-André Lureau Export the display over D-Bus interfaces. (Since 7.0) 2128142ca628SMarc-André Lureau 2129142ca628SMarc-André Lureau The connection is registered with the "org.qemu" name (and queued when 2130142ca628SMarc-André Lureau already owned). 2131142ca628SMarc-André Lureau 2132142ca628SMarc-André Lureau ``addr=<dbusaddr>`` : D-Bus bus address to connect to. 2133142ca628SMarc-André Lureau 213499997823SMarc-André Lureau ``p2p=yes|no`` : Use peer-to-peer connection, accepted via QMP ``add_client``. 213599997823SMarc-André Lureau 213699997823SMarc-André Lureau ``gl=on|off|core|es`` : Use OpenGL for rendering (the D-Bus interface 213799997823SMarc-André Lureau will share framebuffers with DMABUF file descriptors). 2138142ca628SMarc-André Lureau 213995f439bdSThomas Huth ``sdl`` 2140e2fcbf42SPeter Maydell Display video output via SDL (usually in a separate graphics 2141e2fcbf42SPeter Maydell window; see the SDL documentation for other possibilities). 214295f439bdSThomas Huth Valid parameters are: 2143e2fcbf42SPeter Maydell 21448e8e844bSThomas Huth ``grab-mod=<mods>`` : Used to select the modifier keys for toggling 2145450e0f28SJohn Snow the mouse grabbing in conjunction with the "g" key. ``<mods>`` can be 2146450e0f28SJohn Snow either ``lshift-lctrl-lalt`` or ``rctrl``. 21478e8e844bSThomas Huth 214895f439bdSThomas Huth ``gl=on|off|core|es`` : Use OpenGL for displaying 214995f439bdSThomas Huth 215095f439bdSThomas Huth ``show-cursor=on|off`` : Force showing the mouse cursor 215195f439bdSThomas Huth 215295f439bdSThomas Huth ``window-close=on|off`` : Allow to quit qemu with window close button 215395f439bdSThomas Huth 215495f439bdSThomas Huth ``gtk`` 2155ddc71758SAhmed Abouzied Display video output in a GTK window. This interface provides 2156ddc71758SAhmed Abouzied drop-down menus and other UI elements to configure and control 215795f439bdSThomas Huth the VM during runtime. Valid parameters are: 215895f439bdSThomas Huth 215995f439bdSThomas Huth ``full-screen=on|off`` : Start in fullscreen mode 216095f439bdSThomas Huth 216195f439bdSThomas Huth ``gl=on|off`` : Use OpenGL for displaying 216295f439bdSThomas Huth 216395f439bdSThomas Huth ``grab-on-hover=on|off`` : Grab keyboard input on mouse hover 216495f439bdSThomas Huth 2165c34a9338SFelix xq Queißner ``show-tabs=on|off`` : Display the tab bar for switching between the 2166c34a9338SFelix xq Queißner various graphical interfaces (e.g. VGA and 2167c34a9338SFelix xq Queißner virtual console character devices) by default. 2168c34a9338SFelix xq Queißner 216995f439bdSThomas Huth ``show-cursor=on|off`` : Force showing the mouse cursor 217095f439bdSThomas Huth 217195f439bdSThomas Huth ``window-close=on|off`` : Allow to quit qemu with window close button 2172ddc71758SAhmed Abouzied 2173dbccb1a5SBryce Mills ``show-menubar=on|off`` : Display the main window menubar, defaults to "on" 2174dbccb1a5SBryce Mills 2175c35d9373SJan Kratochvil ``zoom-to-fit=on|off`` : Expand video output to the window size, 2176c35d9373SJan Kratochvil defaults to "off" 2177c35d9373SJan Kratochvil 2178ddc71758SAhmed Abouzied ``curses[,charset=<encoding>]`` 2179e2fcbf42SPeter Maydell Display video output via curses. For graphics device models 2180e2fcbf42SPeter Maydell which support a text mode, QEMU can display this output using a 2181e2fcbf42SPeter Maydell curses/ncurses interface. Nothing is displayed when the graphics 2182e2fcbf42SPeter Maydell device is in graphical mode or if the graphics device does not 2183e2fcbf42SPeter Maydell support a text mode. Generally only the VGA device models 2184e2fcbf42SPeter Maydell support text mode. The font charset used by the guest can be 2185e2fcbf42SPeter Maydell specified with the ``charset`` option, for example 2186e2fcbf42SPeter Maydell ``charset=CP850`` for IBM CP850 encoding. The default is 2187e2fcbf42SPeter Maydell ``CP437``. 2188e2fcbf42SPeter Maydell 218948941a52SCarwyn Ellis ``cocoa`` 219048941a52SCarwyn Ellis Display video output in a Cocoa window. Mac only. This interface 219148941a52SCarwyn Ellis provides drop-down menus and other UI elements to configure and 219248941a52SCarwyn Ellis control the VM during runtime. Valid parameters are: 219348941a52SCarwyn Ellis 219448941a52SCarwyn Ellis ``show-cursor=on|off`` : Force showing the mouse cursor 219548941a52SCarwyn Ellis 219648941a52SCarwyn Ellis ``left-command-key=on|off`` : Disable forwarding left command key to host 219748941a52SCarwyn Ellis 219895f439bdSThomas Huth ``egl-headless[,rendernode=<file>]`` 2199ddc71758SAhmed Abouzied Offload all OpenGL operations to a local DRI device. For any 2200ddc71758SAhmed Abouzied graphical display, this display needs to be paired with either 2201ddc71758SAhmed Abouzied VNC or SPICE displays. 2202ddc71758SAhmed Abouzied 220395f439bdSThomas Huth ``vnc=<display>`` 220495f439bdSThomas Huth Start a VNC server on display <display> 220595f439bdSThomas Huth 2206e2fcbf42SPeter Maydell ``none`` 2207e2fcbf42SPeter Maydell Do not display video output. The guest will still see an 2208e2fcbf42SPeter Maydell emulated graphics card, but its output will not be displayed to 2209e2fcbf42SPeter Maydell the QEMU user. This option differs from the -nographic option in 2210e2fcbf42SPeter Maydell that it only affects what is done with video output; -nographic 2211e2fcbf42SPeter Maydell also changes the destination of the serial and parallel port 2212e2fcbf42SPeter Maydell data. 2213e2fcbf42SPeter MaydellERST 22141472a95bSJes Sorensen 22155824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 2216ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 2217ad96090aSBlue Swirl QEMU_ARCH_ALL) 2218e2fcbf42SPeter MaydellSRST 2219e2fcbf42SPeter Maydell``-nographic`` 2220e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2221e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2222e2fcbf42SPeter Maydell monitor in a window. With this option, you can totally disable 2223e2fcbf42SPeter Maydell graphical output so that QEMU is a simple command line application. 2224e2fcbf42SPeter Maydell The emulated serial port is redirected on the console and muxed with 2225e2fcbf42SPeter Maydell the monitor (unless redirected elsewhere explicitly). Therefore, you 2226e2fcbf42SPeter Maydell can still use QEMU to debug a Linux kernel with a serial console. 2227e2fcbf42SPeter Maydell Use C-a h for help on switching between the console and monitor. 2228e2fcbf42SPeter MaydellERST 22295824d651Sblueswir1 22305324e3e9SMarc-André Lureau#ifdef CONFIG_SPICE 223129b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 223227af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 223327af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 223427af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 2235a9daa36aSDaniel P. Berrangé " [,x509-dh-key-file=<file>][,addr=addr]\n" 2236a9daa36aSDaniel P. Berrangé " [,ipv4=on|off][,ipv6=on|off][,unix=on|off]\n" 223727af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 223827af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 223927af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 224099522f69SDaniel P. Berrangé " [,sasl=on|off][,disable-ticketing=on|off]\n" 224136debafdSDaniel P. Berrangé " [,password-secret=<secret-id>]\n" 224227af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 224327af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 224427af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 2245a9daa36aSDaniel P. Berrangé " [,streaming-video=[off|all|filter]][,disable-copy-paste=on|off]\n" 2246a9daa36aSDaniel P. Berrangé " [,disable-agent-file-xfer=on|off][,agent-mouse=[on|off]]\n" 22475ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 22487b525508SMarc-André Lureau " [,gl=[on|off]][,rendernode=<file>]\n" 224927af7788SYonit Halperin " enable spice\n" 225027af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 225127af7788SYonit Halperin QEMU_ARCH_ALL) 22525324e3e9SMarc-André Lureau#endif 2253e2fcbf42SPeter MaydellSRST 2254e2fcbf42SPeter Maydell``-spice option[,option[,...]]`` 2255e2fcbf42SPeter Maydell Enable the spice remote desktop protocol. Valid options are 2256e2fcbf42SPeter Maydell 2257e2fcbf42SPeter Maydell ``port=<nr>`` 2258e2fcbf42SPeter Maydell Set the TCP port spice is listening on for plaintext channels. 2259e2fcbf42SPeter Maydell 2260e2fcbf42SPeter Maydell ``addr=<addr>`` 2261e2fcbf42SPeter Maydell Set the IP address spice is listening on. Default is any 2262e2fcbf42SPeter Maydell address. 2263e2fcbf42SPeter Maydell 2264a9daa36aSDaniel P. Berrangé ``ipv4=on|off``; \ ``ipv6=on|off``; \ ``unix=on|off`` 2265e2fcbf42SPeter Maydell Force using the specified IP version. 2266e2fcbf42SPeter Maydell 226799522f69SDaniel P. Berrangé ``password-secret=<secret-id>`` 226899522f69SDaniel P. Berrangé Set the ID of the ``secret`` object containing the password 226999522f69SDaniel P. Berrangé you need to authenticate. 227099522f69SDaniel P. Berrangé 2271a9daa36aSDaniel P. Berrangé ``sasl=on|off`` 2272e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the spice. 2273e2fcbf42SPeter Maydell The exact choice of authentication method used is controlled 2274e2fcbf42SPeter Maydell from the system / user's SASL configuration file for the 'qemu' 2275e2fcbf42SPeter Maydell service. This is typically found in /etc/sasl2/qemu.conf. If 2276e2fcbf42SPeter Maydell running QEMU as an unprivileged user, an environment variable 2277e2fcbf42SPeter Maydell SASL\_CONF\_PATH can be used to make it search alternate 2278e2fcbf42SPeter Maydell locations for the service config. While some SASL auth methods 2279e2fcbf42SPeter Maydell can also provide data encryption (eg GSSAPI), it is recommended 2280e2fcbf42SPeter Maydell that SASL always be combined with the 'tls' and 'x509' settings 2281e2fcbf42SPeter Maydell to enable use of SSL and server certificates. This ensures a 2282e2fcbf42SPeter Maydell data encryption preventing compromise of authentication 2283e2fcbf42SPeter Maydell credentials. 2284e2fcbf42SPeter Maydell 2285a9daa36aSDaniel P. Berrangé ``disable-ticketing=on|off`` 2286e2fcbf42SPeter Maydell Allow client connects without authentication. 2287e2fcbf42SPeter Maydell 2288a9daa36aSDaniel P. Berrangé ``disable-copy-paste=on|off`` 2289e2fcbf42SPeter Maydell Disable copy paste between the client and the guest. 2290e2fcbf42SPeter Maydell 2291a9daa36aSDaniel P. Berrangé ``disable-agent-file-xfer=on|off`` 2292e2fcbf42SPeter Maydell Disable spice-vdagent based file-xfer between the client and the 2293e2fcbf42SPeter Maydell guest. 2294e2fcbf42SPeter Maydell 2295e2fcbf42SPeter Maydell ``tls-port=<nr>`` 2296e2fcbf42SPeter Maydell Set the TCP port spice is listening on for encrypted channels. 2297e2fcbf42SPeter Maydell 2298e2fcbf42SPeter Maydell ``x509-dir=<dir>`` 2299e2fcbf42SPeter Maydell Set the x509 file directory. Expects same filenames as -vnc 2300e2fcbf42SPeter Maydell $display,x509=$dir 2301e2fcbf42SPeter Maydell 2302e2fcbf42SPeter Maydell ``x509-key-file=<file>``; \ ``x509-key-password=<file>``; \ ``x509-cert-file=<file>``; \ ``x509-cacert-file=<file>``; \ ``x509-dh-key-file=<file>`` 2303e2fcbf42SPeter Maydell The x509 file names can also be configured individually. 2304e2fcbf42SPeter Maydell 2305e2fcbf42SPeter Maydell ``tls-ciphers=<list>`` 2306e2fcbf42SPeter Maydell Specify which ciphers to use. 2307e2fcbf42SPeter Maydell 2308e2fcbf42SPeter Maydell ``tls-channel=[main|display|cursor|inputs|record|playback]``; \ ``plaintext-channel=[main|display|cursor|inputs|record|playback]`` 2309e2fcbf42SPeter Maydell Force specific channel to be used with or without TLS 2310e2fcbf42SPeter Maydell encryption. The options can be specified multiple times to 2311e2fcbf42SPeter Maydell configure multiple channels. The special name "default" can be 2312e2fcbf42SPeter Maydell used to set the default mode. For channels which are not 2313e2fcbf42SPeter Maydell explicitly forced into one mode the spice client is allowed to 2314e2fcbf42SPeter Maydell pick tls/plaintext as he pleases. 2315e2fcbf42SPeter Maydell 2316e2fcbf42SPeter Maydell ``image-compression=[auto_glz|auto_lz|quic|glz|lz|off]`` 2317e2fcbf42SPeter Maydell Configure image compression (lossless). Default is auto\_glz. 2318e2fcbf42SPeter Maydell 2319e2fcbf42SPeter Maydell ``jpeg-wan-compression=[auto|never|always]``; \ ``zlib-glz-wan-compression=[auto|never|always]`` 2320e2fcbf42SPeter Maydell Configure wan image compression (lossy for slow links). Default 2321e2fcbf42SPeter Maydell is auto. 2322e2fcbf42SPeter Maydell 2323e2fcbf42SPeter Maydell ``streaming-video=[off|all|filter]`` 2324e2fcbf42SPeter Maydell Configure video stream detection. Default is off. 2325e2fcbf42SPeter Maydell 2326e2fcbf42SPeter Maydell ``agent-mouse=[on|off]`` 2327e2fcbf42SPeter Maydell Enable/disable passing mouse events via vdagent. Default is on. 2328e2fcbf42SPeter Maydell 2329e2fcbf42SPeter Maydell ``playback-compression=[on|off]`` 2330e2fcbf42SPeter Maydell Enable/disable audio stream compression (using celt 0.5.1). 2331e2fcbf42SPeter Maydell Default is on. 2332e2fcbf42SPeter Maydell 2333e2fcbf42SPeter Maydell ``seamless-migration=[on|off]`` 2334e2fcbf42SPeter Maydell Enable/disable spice seamless migration. Default is off. 2335e2fcbf42SPeter Maydell 2336e2fcbf42SPeter Maydell ``gl=[on|off]`` 2337e2fcbf42SPeter Maydell Enable/disable OpenGL context. Default is off. 2338e2fcbf42SPeter Maydell 2339e2fcbf42SPeter Maydell ``rendernode=<file>`` 2340e2fcbf42SPeter Maydell DRM render node for OpenGL rendering. If not specified, it will 2341e2fcbf42SPeter Maydell pick the first available. (Since 2.9) 2342e2fcbf42SPeter MaydellERST 234329b0040bSGerd Hoffmann 23445824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 2345ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 2346ad96090aSBlue Swirl QEMU_ARCH_ALL) 2347e2fcbf42SPeter MaydellSRST 2348e2fcbf42SPeter Maydell``-portrait`` 2349e2fcbf42SPeter Maydell Rotate graphical output 90 deg left (only PXA LCD). 2350e2fcbf42SPeter MaydellERST 23515824d651Sblueswir1 23529312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 23539312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 23549312805dSVasily Khoruzhick QEMU_ARCH_ALL) 2355e2fcbf42SPeter MaydellSRST 2356e2fcbf42SPeter Maydell``-rotate deg`` 2357e2fcbf42SPeter Maydell Rotate graphical output some deg left (only PXA LCD). 2358e2fcbf42SPeter MaydellERST 23599312805dSVasily Khoruzhick 23605824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 2361a94f0c5cSGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 2362ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 2363e2fcbf42SPeter MaydellSRST 2364e2fcbf42SPeter Maydell``-vga type`` 2365e2fcbf42SPeter Maydell Select type of VGA card to emulate. Valid values for type are 2366e2fcbf42SPeter Maydell 2367e2fcbf42SPeter Maydell ``cirrus`` 2368e2fcbf42SPeter Maydell Cirrus Logic GD5446 Video card. All Windows versions starting 2369e2fcbf42SPeter Maydell from Windows 95 should recognize and use this graphic card. For 2370e2fcbf42SPeter Maydell optimal performances, use 16 bit color depth in the guest and 2371e2fcbf42SPeter Maydell the host OS. (This card was the default before QEMU 2.2) 2372e2fcbf42SPeter Maydell 2373e2fcbf42SPeter Maydell ``std`` 2374e2fcbf42SPeter Maydell Standard VGA card with Bochs VBE extensions. If your guest OS 2375e2fcbf42SPeter Maydell supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if 2376e2fcbf42SPeter Maydell you want to use high resolution modes (>= 1280x1024x16) then you 2377e2fcbf42SPeter Maydell should use this option. (This card is the default since QEMU 2378e2fcbf42SPeter Maydell 2.2) 2379e2fcbf42SPeter Maydell 2380e2fcbf42SPeter Maydell ``vmware`` 2381e2fcbf42SPeter Maydell VMWare SVGA-II compatible adapter. Use it if you have 2382e2fcbf42SPeter Maydell sufficiently recent XFree86/XOrg server or Windows guest with a 2383e2fcbf42SPeter Maydell driver for this card. 2384e2fcbf42SPeter Maydell 2385e2fcbf42SPeter Maydell ``qxl`` 2386e2fcbf42SPeter Maydell QXL paravirtual graphic card. It is VGA compatible (including 2387e2fcbf42SPeter Maydell VESA 2.0 VBE support). Works best with qxl guest drivers 2388e2fcbf42SPeter Maydell installed though. Recommended choice when using the spice 2389e2fcbf42SPeter Maydell protocol. 2390e2fcbf42SPeter Maydell 2391e2fcbf42SPeter Maydell ``tcx`` 2392e2fcbf42SPeter Maydell (sun4m only) Sun TCX framebuffer. This is the default 2393e2fcbf42SPeter Maydell framebuffer for sun4m machines and offers both 8-bit and 24-bit 2394e2fcbf42SPeter Maydell colour depths at a fixed resolution of 1024x768. 2395e2fcbf42SPeter Maydell 2396e2fcbf42SPeter Maydell ``cg3`` 2397e2fcbf42SPeter Maydell (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit 2398e2fcbf42SPeter Maydell framebuffer for sun4m machines available in both 1024x768 2399e2fcbf42SPeter Maydell (OpenBIOS) and 1152x900 (OBP) resolutions aimed at people 2400e2fcbf42SPeter Maydell wishing to run older Solaris versions. 2401e2fcbf42SPeter Maydell 2402e2fcbf42SPeter Maydell ``virtio`` 2403e2fcbf42SPeter Maydell Virtio VGA card. 2404e2fcbf42SPeter Maydell 2405e2fcbf42SPeter Maydell ``none`` 2406e2fcbf42SPeter Maydell Disable VGA card. 2407e2fcbf42SPeter MaydellERST 24085824d651Sblueswir1 24095824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 2410ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 2411e2fcbf42SPeter MaydellSRST 2412e2fcbf42SPeter Maydell``-full-screen`` 2413e2fcbf42SPeter Maydell Start in full screen. 2414e2fcbf42SPeter MaydellERST 24155824d651Sblueswir1 241660f9a4efSJohn SnowDEF("g", HAS_ARG, QEMU_OPTION_g , 2417ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 24188ac919a0SLaurent Vivier QEMU_ARCH_PPC | QEMU_ARCH_SPARC | QEMU_ARCH_M68K) 2419e2fcbf42SPeter MaydellSRST 242009ce5f2dSPeter Maydell``-g`` *width*\ ``x``\ *height*\ ``[x``\ *depth*\ ``]`` 2421e2fcbf42SPeter Maydell Set the initial graphical resolution and depth (PPC, SPARC only). 2422e2fcbf42SPeter Maydell 2423e2fcbf42SPeter Maydell For PPC the default is 800x600x32. 2424e2fcbf42SPeter Maydell 2425e2fcbf42SPeter Maydell For SPARC with the TCX graphics device, the default is 1024x768x8 2426e2fcbf42SPeter Maydell with the option of 1024x768x24. For cgthree, the default is 2427e2fcbf42SPeter Maydell 1024x768x8 with the option of 1152x900x8 for people who wish to use 2428e2fcbf42SPeter Maydell OBP. 2429e2fcbf42SPeter MaydellERST 24305824d651Sblueswir1 2431*6261164bSMarc-André Lureau#ifdef CONFIG_VNC 24325824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 2433f04ec5afSRobert Ho "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL) 2434*6261164bSMarc-André Lureau#endif 2435e2fcbf42SPeter MaydellSRST 2436e2fcbf42SPeter Maydell``-vnc display[,option[,option[,...]]]`` 2437e2fcbf42SPeter Maydell Normally, if QEMU is compiled with graphical window support, it 2438e2fcbf42SPeter Maydell displays output such as guest graphics, guest console, and the QEMU 2439e2fcbf42SPeter Maydell monitor in a window. With this option, you can have QEMU listen on 2440e2fcbf42SPeter Maydell VNC display display and redirect the VGA display over the VNC 2441e2fcbf42SPeter Maydell session. It is very useful to enable the usb tablet device when 2442e2fcbf42SPeter Maydell using this option (option ``-device usb-tablet``). When using the 2443e2fcbf42SPeter Maydell VNC display, you must use the ``-k`` parameter to set the keyboard 2444e2fcbf42SPeter Maydell layout if you are not using en-us. Valid syntax for the display is 2445e2fcbf42SPeter Maydell 2446e2fcbf42SPeter Maydell ``to=L`` 2447e2fcbf42SPeter Maydell With this option, QEMU will try next available VNC displays, 2448e2fcbf42SPeter Maydell until the number L, if the origianlly defined "-vnc display" is 2449e2fcbf42SPeter Maydell not available, e.g. port 5900+display is already used by another 2450e2fcbf42SPeter Maydell application. By default, to=0. 2451e2fcbf42SPeter Maydell 2452e2fcbf42SPeter Maydell ``host:d`` 2453e2fcbf42SPeter Maydell TCP connections will only be allowed from host on display d. By 2454e2fcbf42SPeter Maydell convention the TCP port is 5900+d. Optionally, host can be 2455e2fcbf42SPeter Maydell omitted in which case the server will accept connections from 2456e2fcbf42SPeter Maydell any host. 2457e2fcbf42SPeter Maydell 2458e2fcbf42SPeter Maydell ``unix:path`` 2459e2fcbf42SPeter Maydell Connections will be allowed over UNIX domain sockets where path 2460e2fcbf42SPeter Maydell is the location of a unix socket to listen for connections on. 2461e2fcbf42SPeter Maydell 2462e2fcbf42SPeter Maydell ``none`` 2463e2fcbf42SPeter Maydell VNC is initialized but not started. The monitor ``change`` 2464e2fcbf42SPeter Maydell command can be used to later start the VNC server. 2465e2fcbf42SPeter Maydell 2466e2fcbf42SPeter Maydell Following the display value there may be one or more option flags 2467e2fcbf42SPeter Maydell separated by commas. Valid options are 2468e2fcbf42SPeter Maydell 246982a17d1dSDaniel P. Berrangé ``reverse=on|off`` 2470e2fcbf42SPeter Maydell Connect to a listening VNC client via a "reverse" connection. 2471e2fcbf42SPeter Maydell The client is specified by the display. For reverse network 2472e2fcbf42SPeter Maydell connections (host:d,``reverse``), the d argument is a TCP port 2473e2fcbf42SPeter Maydell number, not a display number. 2474e2fcbf42SPeter Maydell 247582a17d1dSDaniel P. Berrangé ``websocket=on|off`` 2476e2fcbf42SPeter Maydell Opens an additional TCP listening port dedicated to VNC 2477e2fcbf42SPeter Maydell Websocket connections. If a bare websocket option is given, the 2478e2fcbf42SPeter Maydell Websocket port is 5700+display. An alternative port can be 2479e2fcbf42SPeter Maydell specified with the syntax ``websocket``\ =port. 2480e2fcbf42SPeter Maydell 2481e2fcbf42SPeter Maydell If host is specified connections will only be allowed from this 2482e2fcbf42SPeter Maydell host. It is possible to control the websocket listen address 2483e2fcbf42SPeter Maydell independently, using the syntax ``websocket``\ =host:port. 2484e2fcbf42SPeter Maydell 2485e2fcbf42SPeter Maydell If no TLS credentials are provided, the websocket connection 2486e2fcbf42SPeter Maydell runs in unencrypted mode. If TLS credentials are provided, the 2487e2fcbf42SPeter Maydell websocket connection requires encrypted client connections. 2488e2fcbf42SPeter Maydell 248982a17d1dSDaniel P. Berrangé ``password=on|off`` 2490e2fcbf42SPeter Maydell Require that password based authentication is used for client 2491e2fcbf42SPeter Maydell connections. 2492e2fcbf42SPeter Maydell 2493e2fcbf42SPeter Maydell The password must be set separately using the ``set_password`` 2494923e9311SThomas Huth command in the :ref:`QEMU monitor`. The 2495e2fcbf42SPeter Maydell syntax to change your password is: 2496e2fcbf42SPeter Maydell ``set_password <protocol> <password>`` where <protocol> could be 2497e2fcbf42SPeter Maydell either "vnc" or "spice". 2498e2fcbf42SPeter Maydell 2499e2fcbf42SPeter Maydell If you would like to change <protocol> password expiration, you 2500e2fcbf42SPeter Maydell should use ``expire_password <protocol> <expiration-time>`` 2501e2fcbf42SPeter Maydell where expiration time could be one of the following options: 2502e2fcbf42SPeter Maydell now, never, +seconds or UNIX time of expiration, e.g. +60 to 2503e2fcbf42SPeter Maydell make password expire in 60 seconds, or 1335196800 to make 2504e2fcbf42SPeter Maydell password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for 2505e2fcbf42SPeter Maydell this date and time). 2506e2fcbf42SPeter Maydell 2507e2fcbf42SPeter Maydell You can also use keywords "now" or "never" for the expiration 2508e2fcbf42SPeter Maydell time to allow <protocol> password to expire immediately or never 2509e2fcbf42SPeter Maydell expire. 2510e2fcbf42SPeter Maydell 25116c6840e9SDaniel P. Berrangé ``password-secret=<secret-id>`` 25126c6840e9SDaniel P. Berrangé Require that password based authentication is used for client 25136c6840e9SDaniel P. Berrangé connections, using the password provided by the ``secret`` 25146c6840e9SDaniel P. Berrangé object identified by ``secret-id``. 25156c6840e9SDaniel P. Berrangé 2516e2fcbf42SPeter Maydell ``tls-creds=ID`` 2517e2fcbf42SPeter Maydell Provides the ID of a set of TLS credentials to use to secure the 2518e2fcbf42SPeter Maydell VNC server. They will apply to both the normal VNC server socket 2519e2fcbf42SPeter Maydell and the websocket socket (if enabled). Setting TLS credentials 2520e2fcbf42SPeter Maydell will cause the VNC server socket to enable the VeNCrypt auth 2521e2fcbf42SPeter Maydell mechanism. The credentials should have been previously created 2522e2fcbf42SPeter Maydell using the ``-object tls-creds`` argument. 2523e2fcbf42SPeter Maydell 2524e2fcbf42SPeter Maydell ``tls-authz=ID`` 2525e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2526e2fcbf42SPeter Maydell the client's x509 distinguished name will validated. This object 2527e2fcbf42SPeter Maydell is only resolved at time of use, so can be deleted and recreated 2528e2fcbf42SPeter Maydell on the fly while the VNC server is active. If missing, it will 2529e2fcbf42SPeter Maydell default to denying access. 2530e2fcbf42SPeter Maydell 253182a17d1dSDaniel P. Berrangé ``sasl=on|off`` 2532e2fcbf42SPeter Maydell Require that the client use SASL to authenticate with the VNC 2533e2fcbf42SPeter Maydell server. The exact choice of authentication method used is 2534e2fcbf42SPeter Maydell controlled from the system / user's SASL configuration file for 2535e2fcbf42SPeter Maydell the 'qemu' service. This is typically found in 2536e2fcbf42SPeter Maydell /etc/sasl2/qemu.conf. If running QEMU as an unprivileged user, 2537e2fcbf42SPeter Maydell an environment variable SASL\_CONF\_PATH can be used to make it 2538e2fcbf42SPeter Maydell search alternate locations for the service config. While some 2539e2fcbf42SPeter Maydell SASL auth methods can also provide data encryption (eg GSSAPI), 2540e2fcbf42SPeter Maydell it is recommended that SASL always be combined with the 'tls' 2541e2fcbf42SPeter Maydell and 'x509' settings to enable use of SSL and server 2542e2fcbf42SPeter Maydell certificates. This ensures a data encryption preventing 2543e2fcbf42SPeter Maydell compromise of authentication credentials. See the 2544923e9311SThomas Huth :ref:`VNC security` section in the System Emulation Users Guide 2545923e9311SThomas Huth for details on using SASL authentication. 2546e2fcbf42SPeter Maydell 2547e2fcbf42SPeter Maydell ``sasl-authz=ID`` 2548e2fcbf42SPeter Maydell Provides the ID of the QAuthZ authorization object against which 2549e2fcbf42SPeter Maydell the client's SASL username will validated. This object is only 2550e2fcbf42SPeter Maydell resolved at time of use, so can be deleted and recreated on the 2551e2fcbf42SPeter Maydell fly while the VNC server is active. If missing, it will default 2552e2fcbf42SPeter Maydell to denying access. 2553e2fcbf42SPeter Maydell 255482a17d1dSDaniel P. Berrangé ``acl=on|off`` 2555e2fcbf42SPeter Maydell Legacy method for enabling authorization of clients against the 2556e2fcbf42SPeter Maydell x509 distinguished name and SASL username. It results in the 2557e2fcbf42SPeter Maydell creation of two ``authz-list`` objects with IDs of 2558e2fcbf42SPeter Maydell ``vnc.username`` and ``vnc.x509dname``. The rules for these 2559e2fcbf42SPeter Maydell objects must be configured with the HMP ACL commands. 2560e2fcbf42SPeter Maydell 2561e2fcbf42SPeter Maydell This option is deprecated and should no longer be used. The new 2562e2fcbf42SPeter Maydell ``sasl-authz`` and ``tls-authz`` options are a replacement. 2563e2fcbf42SPeter Maydell 256482a17d1dSDaniel P. Berrangé ``lossy=on|off`` 2565e2fcbf42SPeter Maydell Enable lossy compression methods (gradient, JPEG, ...). If this 2566e2fcbf42SPeter Maydell option is set, VNC client may receive lossy framebuffer updates 2567e2fcbf42SPeter Maydell depending on its encoding settings. Enabling this option can 2568e2fcbf42SPeter Maydell save a lot of bandwidth at the expense of quality. 2569e2fcbf42SPeter Maydell 257082a17d1dSDaniel P. Berrangé ``non-adaptive=on|off`` 2571e2fcbf42SPeter Maydell Disable adaptive encodings. Adaptive encodings are enabled by 2572e2fcbf42SPeter Maydell default. An adaptive encoding will try to detect frequently 2573e2fcbf42SPeter Maydell updated screen regions, and send updates in these regions using 2574e2fcbf42SPeter Maydell a lossy encoding (like JPEG). This can be really helpful to save 2575e2fcbf42SPeter Maydell bandwidth when playing videos. Disabling adaptive encodings 2576e2fcbf42SPeter Maydell restores the original static behavior of encodings like Tight. 2577e2fcbf42SPeter Maydell 2578e2fcbf42SPeter Maydell ``share=[allow-exclusive|force-shared|ignore]`` 2579e2fcbf42SPeter Maydell Set display sharing policy. 'allow-exclusive' allows clients to 2580e2fcbf42SPeter Maydell ask for exclusive access. As suggested by the rfb spec this is 2581e2fcbf42SPeter Maydell implemented by dropping other connections. Connecting multiple 2582e2fcbf42SPeter Maydell clients in parallel requires all clients asking for a shared 2583e2fcbf42SPeter Maydell session (vncviewer: -shared switch). This is the default. 2584e2fcbf42SPeter Maydell 'force-shared' disables exclusive client access. Useful for 2585e2fcbf42SPeter Maydell shared desktop sessions, where you don't want someone forgetting 2586e2fcbf42SPeter Maydell specify -shared disconnect everybody else. 'ignore' completely 2587e2fcbf42SPeter Maydell ignores the shared flag and allows everybody connect 2588e2fcbf42SPeter Maydell unconditionally. Doesn't conform to the rfb spec but is 2589e2fcbf42SPeter Maydell traditional QEMU behavior. 2590e2fcbf42SPeter Maydell 2591e2fcbf42SPeter Maydell ``key-delay-ms`` 2592e2fcbf42SPeter Maydell Set keyboard delay, for key down and key up events, in 2593e2fcbf42SPeter Maydell milliseconds. Default is 10. Keyboards are low-bandwidth 2594e2fcbf42SPeter Maydell devices, so this slowdown can help the device and guest to keep 2595e2fcbf42SPeter Maydell up and not lose events in case events are arriving in bulk. 2596e2fcbf42SPeter Maydell Possible causes for the latter are flaky network connections, or 2597e2fcbf42SPeter Maydell scripts for automated testing. 2598e2fcbf42SPeter Maydell 2599e2fcbf42SPeter Maydell ``audiodev=audiodev`` 2600e2fcbf42SPeter Maydell Use the specified audiodev when the VNC client requests audio 2601e2fcbf42SPeter Maydell transmission. When not using an -audiodev argument, this option 2602e2fcbf42SPeter Maydell must be omitted, otherwise is must be present and specify a 2603e2fcbf42SPeter Maydell valid audiodev. 26047b5fa0b5SDaniel P. Berrangé 260582a17d1dSDaniel P. Berrangé ``power-control=on|off`` 26067b5fa0b5SDaniel P. Berrangé Permit the remote client to issue shutdown, reboot or reset power 26077b5fa0b5SDaniel P. Berrangé control requests. 2608e2fcbf42SPeter MaydellERST 26095824d651Sblueswir1 2610a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 26115824d651Sblueswir1 2612de6b4f90SMarkus ArmbrusterARCHHEADING(i386 target only:, QEMU_ARCH_I386) 26135824d651Sblueswir1 26145824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 2615ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 2616ad96090aSBlue Swirl QEMU_ARCH_I386) 2617e2fcbf42SPeter MaydellSRST 2618e2fcbf42SPeter Maydell``-win2k-hack`` 2619e2fcbf42SPeter Maydell Use it when installing Windows 2000 to avoid a disk full bug. After 2620e2fcbf42SPeter Maydell Windows 2000 is installed, you no longer need this option (this 2621e2fcbf42SPeter Maydell option slows down the IDE transfers). 2622e2fcbf42SPeter MaydellERST 26235824d651Sblueswir1 26245824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 2625ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 2626ad96090aSBlue Swirl QEMU_ARCH_I386) 2627e2fcbf42SPeter MaydellSRST 2628e2fcbf42SPeter Maydell``-no-fd-bootchk`` 2629e2fcbf42SPeter Maydell Disable boot signature checking for floppy disks in BIOS. May be 2630e2fcbf42SPeter Maydell needed to boot from old floppy disks. 2631e2fcbf42SPeter MaydellERST 26325824d651Sblueswir1 26335824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 2634f5d8c8cdSShannon Zhao "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 2635e2fcbf42SPeter MaydellSRST 2636e2fcbf42SPeter Maydell``-no-acpi`` 2637e2fcbf42SPeter Maydell Disable ACPI (Advanced Configuration and Power Interface) support. 2638e2fcbf42SPeter Maydell Use it if your guest OS complains about ACPI problems (PC target 2639e2fcbf42SPeter Maydell machine only). 2640e2fcbf42SPeter MaydellERST 26415824d651Sblueswir1 26425824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 2643ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 2644e2fcbf42SPeter MaydellSRST 2645e2fcbf42SPeter Maydell``-no-hpet`` 2646df37330cSThomas Huth Disable HPET support. Deprecated, use '-machine hpet=off' instead. 2647e2fcbf42SPeter MaydellERST 26485824d651Sblueswir1 26495824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 2650104bf02eSMichael 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" 2651ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 2652e2fcbf42SPeter MaydellSRST 2653e2fcbf42SPeter 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]...]`` 2654e2fcbf42SPeter Maydell Add ACPI table with specified header fields and context from 2655e2fcbf42SPeter Maydell specified files. For file=, take whole ACPI table from the specified 2656e2fcbf42SPeter Maydell files, including all ACPI headers (possible overridden by other 2657e2fcbf42SPeter Maydell options). For data=, only data portion of the table is used, all 2658e2fcbf42SPeter Maydell header information is specified in the command line. If a SLIC table 2659e2fcbf42SPeter Maydell is supplied to QEMU, then the SLIC's oem\_id and oem\_table\_id 2660e2fcbf42SPeter Maydell fields will override the same in the RSDT and the FADT (a.k.a. 2661e2fcbf42SPeter Maydell FACP), in order to ensure the field matches required by the 2662e2fcbf42SPeter Maydell Microsoft SLIC spec and the ACPI spec. 2663e2fcbf42SPeter MaydellERST 26645824d651Sblueswir1 2665b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 2666b6f6e3d3Saliguori "-smbios file=binary\n" 2667ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 2668b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 2669b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 2670ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 2671b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2672b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 2673b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 2674b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 2675b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 2676b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 2677b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 2678b155eb1dSGabriel L. Somlo " [,sku=str]\n" 2679b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 2680b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 2681c906e039SYing Fang " [,asset=str][,part=str][,max-speed=%d][,current-speed=%d]\n" 2682cb5fb04fSPatrick Venture " [,processor-id=%d]\n" 2683b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 2684fd8caa25SHal Martin "-smbios type=8[,external_reference=str][,internal_reference=str][,connector_type=%d][,port_type=%d]\n" 2685fd8caa25SHal Martin " specify SMBIOS type 8 fields\n" 268648a7ff4dSDaniel P. Berrangé "-smbios type=11[,value=str][,path=filename]\n" 268748a7ff4dSDaniel P. Berrangé " specify SMBIOS type 11 fields\n" 2688b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 26893ebd6cc8SGabriel L. Somlo " [,asset=str][,part=str][,speed=%d]\n" 269005dfb447SVincent Bernat " specify SMBIOS type 17 fields\n" 269105dfb447SVincent Bernat "-smbios type=41[,designation=str][,kind=str][,instance=%d][,pcidev=str]\n" 269205dfb447SVincent Bernat " specify SMBIOS type 41 fields\n", 26934934cc58SSong Gao QEMU_ARCH_I386 | QEMU_ARCH_ARM | QEMU_ARCH_LOONGARCH) 2694e2fcbf42SPeter MaydellSRST 2695e2fcbf42SPeter Maydell``-smbios file=binary`` 2696e2fcbf42SPeter Maydell Load SMBIOS entry from binary file. 2697e2fcbf42SPeter Maydell 2698e2fcbf42SPeter Maydell``-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]`` 2699e2fcbf42SPeter Maydell Specify SMBIOS type 0 fields 2700e2fcbf42SPeter Maydell 2701e2fcbf42SPeter Maydell``-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str]`` 2702e2fcbf42SPeter Maydell Specify SMBIOS type 1 fields 2703e2fcbf42SPeter Maydell 2704e2fcbf42SPeter Maydell``-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str][,asset=str][,location=str]`` 2705e2fcbf42SPeter Maydell Specify SMBIOS type 2 fields 2706e2fcbf42SPeter Maydell 2707e2fcbf42SPeter Maydell``-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str][,sku=str]`` 2708e2fcbf42SPeter Maydell Specify SMBIOS type 3 fields 2709e2fcbf42SPeter Maydell 2710cb5fb04fSPatrick Venture``-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str][,asset=str][,part=str][,processor-id=%d]`` 2711e2fcbf42SPeter Maydell Specify SMBIOS type 4 fields 2712e2fcbf42SPeter Maydell 271348a7ff4dSDaniel P. Berrangé``-smbios type=11[,value=str][,path=filename]`` 271448a7ff4dSDaniel P. Berrangé Specify SMBIOS type 11 fields 271548a7ff4dSDaniel P. Berrangé 271648a7ff4dSDaniel P. Berrangé This argument can be repeated multiple times, and values are added in the order they are parsed. 271748a7ff4dSDaniel P. Berrangé Applications intending to use OEM strings data are encouraged to use their application name as 271848a7ff4dSDaniel P. Berrangé a prefix for the value string. This facilitates passing information for multiple applications 271948a7ff4dSDaniel P. Berrangé concurrently. 272048a7ff4dSDaniel P. Berrangé 272148a7ff4dSDaniel P. Berrangé The ``value=str`` syntax provides the string data inline, while the ``path=filename`` syntax 272248a7ff4dSDaniel P. Berrangé loads data from a file on disk. Note that the file is not permitted to contain any NUL bytes. 272348a7ff4dSDaniel P. Berrangé 272448a7ff4dSDaniel P. Berrangé Both the ``value`` and ``path`` options can be repeated multiple times and will be added to 272548a7ff4dSDaniel P. Berrangé the SMBIOS table in the order in which they appear. 272648a7ff4dSDaniel P. Berrangé 272748a7ff4dSDaniel P. Berrangé Note that on the x86 architecture, the total size of all SMBIOS tables is limited to 65535 272848a7ff4dSDaniel P. Berrangé bytes. Thus the OEM strings data is not suitable for passing large amounts of data into the 272948a7ff4dSDaniel P. Berrangé guest. Instead it should be used as a indicator to inform the guest where to locate the real 273048a7ff4dSDaniel P. Berrangé data set, for example, by specifying the serial ID of a block device. 273148a7ff4dSDaniel P. Berrangé 273248a7ff4dSDaniel P. Berrangé An example passing three strings is 273348a7ff4dSDaniel P. Berrangé 273448a7ff4dSDaniel P. Berrangé .. parsed-literal:: 273548a7ff4dSDaniel P. Berrangé 273648a7ff4dSDaniel P. Berrangé -smbios type=11,value=cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/,\\ 273748a7ff4dSDaniel P. Berrangé value=anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os,\\ 273848a7ff4dSDaniel P. Berrangé path=/some/file/with/oemstringsdata.txt 273948a7ff4dSDaniel P. Berrangé 274048a7ff4dSDaniel P. Berrangé In the guest OS this is visible with the ``dmidecode`` command 274148a7ff4dSDaniel P. Berrangé 274248a7ff4dSDaniel P. Berrangé .. parsed-literal:: 274348a7ff4dSDaniel P. Berrangé 274448a7ff4dSDaniel P. Berrangé $ dmidecode -t 11 274548a7ff4dSDaniel P. Berrangé Handle 0x0E00, DMI type 11, 5 bytes 274648a7ff4dSDaniel P. Berrangé OEM Strings 274748a7ff4dSDaniel P. Berrangé String 1: cloud-init:ds=nocloud-net;s=http://10.10.0.1:8000/ 274848a7ff4dSDaniel P. Berrangé String 2: anaconda:method=http://dl.fedoraproject.org/pub/fedora/linux/releases/25/x86_64/os 274948a7ff4dSDaniel P. Berrangé String 3: myapp:some extra data 275048a7ff4dSDaniel P. Berrangé 275148a7ff4dSDaniel P. Berrangé 2752e2fcbf42SPeter Maydell``-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str][,asset=str][,part=str][,speed=%d]`` 2753e2fcbf42SPeter Maydell Specify SMBIOS type 17 fields 275405dfb447SVincent Bernat 275505dfb447SVincent Bernat``-smbios type=41[,designation=str][,kind=str][,instance=%d][,pcidev=str]`` 275605dfb447SVincent Bernat Specify SMBIOS type 41 fields 275705dfb447SVincent Bernat 275805dfb447SVincent Bernat This argument can be repeated multiple times. Its main use is to allow network interfaces be created 275905dfb447SVincent Bernat as ``enoX`` on Linux, with X being the instance number, instead of the name depending on the interface 276005dfb447SVincent Bernat position on the PCI bus. 276105dfb447SVincent Bernat 276205dfb447SVincent Bernat Here is an example of use: 276305dfb447SVincent Bernat 276405dfb447SVincent Bernat .. parsed-literal:: 276505dfb447SVincent Bernat 276605dfb447SVincent Bernat -netdev user,id=internet \\ 276705dfb447SVincent Bernat -device virtio-net-pci,mac=50:54:00:00:00:42,netdev=internet,id=internet-dev \\ 276805dfb447SVincent Bernat -smbios type=41,designation='Onboard LAN',instance=1,kind=ethernet,pcidev=internet-dev 276905dfb447SVincent Bernat 277005dfb447SVincent Bernat In the guest OS, the device should then appear as ``eno1``: 277105dfb447SVincent Bernat 277205dfb447SVincent Bernat ..parsed-literal:: 277305dfb447SVincent Bernat 277405dfb447SVincent Bernat $ ip -brief l 277505dfb447SVincent Bernat lo UNKNOWN 00:00:00:00:00:00 <LOOPBACK,UP,LOWER_UP> 277605dfb447SVincent Bernat eno1 UP 50:54:00:00:00:42 <BROADCAST,MULTICAST,UP,LOWER_UP> 277705dfb447SVincent Bernat 277805dfb447SVincent Bernat Currently, the PCI device has to be attached to the root bus. 277905dfb447SVincent Bernat 2780e2fcbf42SPeter MaydellERST 2781b6f6e3d3Saliguori 2782c70a01e4SMarkus ArmbrusterDEFHEADING() 27835824d651Sblueswir1 2784de6b4f90SMarkus ArmbrusterDEFHEADING(Network options:) 27855824d651Sblueswir1 27866a8b4a5bSThomas HuthDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 27875824d651Sblueswir1#ifdef CONFIG_SLIRP 27888b0dc246SDaniel P. Berrangé "-netdev user,id=str[,ipv4=on|off][,net=addr[/mask]][,host=addr]\n" 27898b0dc246SDaniel P. Berrangé " [,ipv6=on|off][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 27900b11c036SSamuel Thibault " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 2791f18d1375SBenjamin Drung " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n" 27920fca92b9SFam Zheng " [,tftp=dir][,tftp-server-name=name][,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 2793ad196a9dSJan Kiszka#ifndef _WIN32 2794c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 2795ad196a9dSJan Kiszka#endif 27966a8b4a5bSThomas Huth " configure a user mode network backend with ID 'str',\n" 27976a8b4a5bSThomas Huth " its DHCP server and optional services\n" 27985824d651Sblueswir1#endif 27995824d651Sblueswir1#ifdef _WIN32 28006a8b4a5bSThomas Huth "-netdev tap,id=str,ifname=name\n" 28016a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 28025824d651Sblueswir1#else 28036a8b4a5bSThomas Huth "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 2804584613eaSAlexey Kardashevskiy " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 28056a8b4a5bSThomas Huth " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 280669e87b32SJason Wang " [,poll-us=n]\n" 28076a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 2808584613eaSAlexey Kardashevskiy " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 2809a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 2810a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 2811a7c36ee4SCorey Bryant " to deconfigure it\n" 2812ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 2813a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 2814a7c36ee4SCorey Bryant " configure it\n" 28155824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 28162ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 2817ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 2818f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 2819ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 2820ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 282182b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 28225430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 28235430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 282482b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 28252ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 2826ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 2827cba42d61SMichael Tokarev " use 'poll-us=n' to specify the maximum number of microseconds that could be\n" 282869e87b32SJason Wang " spent on busy polling for vhost net\n" 28296a8b4a5bSThomas Huth "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 28306a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str' that is\n" 28316a8b4a5bSThomas Huth " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 28326a8b4a5bSThomas Huth " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 28330df0ff6dSMark McLoughlin#endif 28343fb69aa1SAnton Ivanov#ifdef __linux__ 28356a8b4a5bSThomas Huth "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 28368b0dc246SDaniel P. Berrangé " [,rxsession=rxsession],txsession=txsession[,ipv6=on|off][,udp=on|off]\n" 28378b0dc246SDaniel P. Berrangé " [,cookie64=on|off][,counter][,pincounter][,txcookie=txcookie]\n" 28386a8b4a5bSThomas Huth " [,rxcookie=rxcookie][,offset=offset]\n" 28396a8b4a5bSThomas Huth " configure a network backend with ID 'str' connected to\n" 28406a8b4a5bSThomas Huth " an Ethernet over L2TPv3 pseudowire.\n" 28413fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 28422f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 28433fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 284421843dc4SStefan Hajnoczi " standard (RFC3931). Note - this implementation uses static\n" 28453fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 28463fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 28473fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 28483fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 28493952651aSGonglei " use 'srcport=' to specify source udp port\n" 28503fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 28513fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 28523fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 28533fb69aa1SAnton Ivanov " well as a weak security measure\n" 28543fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 28553fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 28563fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 28573fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 28583fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 28593fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 28603fb69aa1SAnton Ivanov#endif 28616a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 28626a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 28636a8b4a5bSThomas Huth " using a socket connection\n" 28646a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 28656a8b4a5bSThomas Huth " configure a network backend to connect to a multicast maddr and port\n" 28663a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 28676a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 28686a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 28696a8b4a5bSThomas Huth " using an UDP tunnel\n" 2870148fbf0dSLaurent Vivier "-netdev stream,id=str[,server=on|off],addr.type=inet,addr.host=host,addr.port=port[,to=maxport][,numeric=on|off][,keep-alive=on|off][,mptcp=on|off][,addr.ipv4=on|off][,addr.ipv6=on|off][,reconnect=seconds]\n" 2871148fbf0dSLaurent Vivier "-netdev stream,id=str[,server=on|off],addr.type=unix,addr.path=path[,abstract=on|off][,tight=on|off][,reconnect=seconds]\n" 2872148fbf0dSLaurent Vivier "-netdev stream,id=str[,server=on|off],addr.type=fd,addr.str=file-descriptor[,reconnect=seconds]\n" 28735166fe0aSLaurent Vivier " configure a network backend to connect to another network\n" 28745166fe0aSLaurent Vivier " using a socket connection in stream mode.\n" 28755166fe0aSLaurent Vivier "-netdev dgram,id=str,remote.type=inet,remote.host=maddr,remote.port=port[,local.type=inet,local.host=addr]\n" 28765166fe0aSLaurent Vivier "-netdev dgram,id=str,remote.type=inet,remote.host=maddr,remote.port=port[,local.type=fd,local.str=file-descriptor]\n" 28775166fe0aSLaurent Vivier " configure a network backend to connect to a multicast maddr and port\n" 28785166fe0aSLaurent Vivier " use ``local.host=addr`` to specify the host address to send packets from\n" 28795166fe0aSLaurent Vivier "-netdev dgram,id=str,local.type=inet,local.host=addr,local.port=port[,remote.type=inet,remote.host=addr,remote.port=port]\n" 2880784e7a25SLaurent Vivier "-netdev dgram,id=str,local.type=unix,local.path=path[,remote.type=unix,remote.path=path]\n" 28815166fe0aSLaurent Vivier "-netdev dgram,id=str,local.type=fd,local.str=file-descriptor\n" 28825166fe0aSLaurent Vivier " configure a network backend to connect to another network\n" 28835166fe0aSLaurent Vivier " using an UDP tunnel\n" 28845824d651Sblueswir1#ifdef CONFIG_VDE 28856a8b4a5bSThomas Huth "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 28866a8b4a5bSThomas Huth " configure a network backend to connect to port 'n' of a vde switch\n" 28876a8b4a5bSThomas Huth " running on host and listening for incoming connections on 'socketpath'.\n" 28885824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 28895824d651Sblueswir1 " ownership and permissions for communication port.\n" 28905824d651Sblueswir1#endif 289158952137SVincenzo Maffione#ifdef CONFIG_NETMAP 28926a8b4a5bSThomas Huth "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 289358952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 289458952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 289558952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 289658952137SVincenzo Maffione#endif 2897cb039ef3SIlya Maximets#ifdef CONFIG_AF_XDP 2898cb039ef3SIlya Maximets "-netdev af-xdp,id=str,ifname=name[,mode=native|skb][,force-copy=on|off]\n" 2899cb039ef3SIlya Maximets " [,queues=n][,start-queue=m][,inhibit=on|off][,sock-fds=x:y:...:z]\n" 2900cb039ef3SIlya Maximets " attach to the existing network interface 'name' with AF_XDP socket\n" 2901cb039ef3SIlya Maximets " use 'mode=MODE' to specify an XDP program attach mode\n" 2902cb039ef3SIlya Maximets " use 'force-copy=on|off' to force XDP copy mode even if device supports zero-copy (default: off)\n" 2903cb039ef3SIlya Maximets " use 'inhibit=on|off' to inhibit loading of a default XDP program (default: off)\n" 2904cb039ef3SIlya Maximets " with inhibit=on,\n" 2905cb039ef3SIlya Maximets " use 'sock-fds' to provide file descriptors for already open AF_XDP sockets\n" 2906cb039ef3SIlya Maximets " added to a socket map in XDP program. One socket per queue.\n" 2907cb039ef3SIlya Maximets " use 'queues=n' to specify how many queues of a multiqueue interface should be used\n" 2908cb039ef3SIlya Maximets " use 'start-queue=m' to specify the first queue that should be used\n" 2909cb039ef3SIlya Maximets#endif 2910253dc14cSThomas Huth#ifdef CONFIG_POSIX 29116a8b4a5bSThomas Huth "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 29126a8b4a5bSThomas Huth " configure a vhost-user network, backed by a chardev 'dev'\n" 2913253dc14cSThomas Huth#endif 2914108a6481SCindy Lu#ifdef __linux__ 29158801ccd0SSi-Wei Liu "-netdev vhost-vdpa,id=str[,vhostdev=/path/to/dev][,vhostfd=h]\n" 2916108a6481SCindy Lu " configure a vhost-vdpa network,Establish a vhost-vdpa netdev\n" 29178801ccd0SSi-Wei Liu " use 'vhostdev=/path/to/dev' to open a vhost vdpa device\n" 29188801ccd0SSi-Wei Liu " use 'vhostfd=h' to connect to an already opened vhost vdpa device\n" 2919108a6481SCindy Lu#endif 2920b0290db1SVladislav Yaroshchuk#ifdef CONFIG_VMNET 2921b0290db1SVladislav Yaroshchuk "-netdev vmnet-host,id=str[,isolated=on|off][,net-uuid=uuid]\n" 2922b0290db1SVladislav Yaroshchuk " [,start-address=addr,end-address=addr,subnet-mask=mask]\n" 2923b0290db1SVladislav Yaroshchuk " configure a vmnet network backend in host mode with ID 'str',\n" 2924b0290db1SVladislav Yaroshchuk " isolate this interface from others with 'isolated',\n" 2925b0290db1SVladislav Yaroshchuk " configure the address range and choose a subnet mask,\n" 2926b0290db1SVladislav Yaroshchuk " specify network UUID 'uuid' to disable DHCP and interact with\n" 2927b0290db1SVladislav Yaroshchuk " vmnet-host interfaces within this isolated network\n" 2928b0290db1SVladislav Yaroshchuk "-netdev vmnet-shared,id=str[,isolated=on|off][,nat66-prefix=addr]\n" 2929b0290db1SVladislav Yaroshchuk " [,start-address=addr,end-address=addr,subnet-mask=mask]\n" 2930b0290db1SVladislav Yaroshchuk " configure a vmnet network backend in shared mode with ID 'str',\n" 2931b0290db1SVladislav Yaroshchuk " configure the address range and choose a subnet mask,\n" 2932b0290db1SVladislav Yaroshchuk " set IPv6 ULA prefix (of length 64) to use for internal network,\n" 2933b0290db1SVladislav Yaroshchuk " isolate this interface from others with 'isolated'\n" 2934b0290db1SVladislav Yaroshchuk "-netdev vmnet-bridged,id=str,ifname=name[,isolated=on|off]\n" 2935b0290db1SVladislav Yaroshchuk " configure a vmnet network backend in bridged mode with ID 'str',\n" 2936b0290db1SVladislav Yaroshchuk " use 'ifname=name' to select a physical network interface to be bridged,\n" 2937b0290db1SVladislav Yaroshchuk " isolate this interface from others with 'isolated'\n" 2938b0290db1SVladislav Yaroshchuk#endif 293918d65d22SThomas Huth "-netdev hubport,id=str,hubid=n[,netdev=nd]\n" 2940af1a5c3eSThomas Huth " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL) 294178cd6f7bSThomas HuthDEF("nic", HAS_ARG, QEMU_OPTION_nic, 2942dfaa7d50SBALATON Zoltan "-nic [tap|bridge|" 294378cd6f7bSThomas Huth#ifdef CONFIG_SLIRP 294478cd6f7bSThomas Huth "user|" 294578cd6f7bSThomas Huth#endif 294678cd6f7bSThomas Huth#ifdef __linux__ 294778cd6f7bSThomas Huth "l2tpv3|" 294878cd6f7bSThomas Huth#endif 294978cd6f7bSThomas Huth#ifdef CONFIG_VDE 295078cd6f7bSThomas Huth "vde|" 295178cd6f7bSThomas Huth#endif 295278cd6f7bSThomas Huth#ifdef CONFIG_NETMAP 295378cd6f7bSThomas Huth "netmap|" 295478cd6f7bSThomas Huth#endif 2955cb039ef3SIlya Maximets#ifdef CONFIG_AF_XDP 2956cb039ef3SIlya Maximets "af-xdp|" 2957cb039ef3SIlya Maximets#endif 295878cd6f7bSThomas Huth#ifdef CONFIG_POSIX 295978cd6f7bSThomas Huth "vhost-user|" 296078cd6f7bSThomas Huth#endif 2961b0290db1SVladislav Yaroshchuk#ifdef CONFIG_VMNET 2962b0290db1SVladislav Yaroshchuk "vmnet-host|vmnet-shared|vmnet-bridged|" 2963b0290db1SVladislav Yaroshchuk#endif 296478cd6f7bSThomas Huth "socket][,option][,...][mac=macaddr]\n" 296578cd6f7bSThomas Huth " initialize an on-board / default host NIC (using MAC address\n" 296678cd6f7bSThomas Huth " macaddr) and connect it to the given host network backend\n" 2967dfaa7d50SBALATON Zoltan "-nic none use it alone to have zero network devices (the default is to\n" 296878cd6f7bSThomas Huth " provided a 'user' network connection)\n", 296978cd6f7bSThomas Huth QEMU_ARCH_ALL) 29706a8b4a5bSThomas HuthDEF("net", HAS_ARG, QEMU_OPTION_net, 2971af1a5c3eSThomas Huth "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 29720e60a82dSThomas Huth " configure or create an on-board (or machine default) NIC and\n" 2973af1a5c3eSThomas Huth " connect it to hub 0 (please use -nic unless you need a hub)\n" 29746a8b4a5bSThomas Huth "-net [" 2975a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 2976a1ea458fSMark McLoughlin "user|" 2977a1ea458fSMark McLoughlin#endif 2978a1ea458fSMark McLoughlin "tap|" 2979a7c36ee4SCorey Bryant "bridge|" 2980a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 2981a1ea458fSMark McLoughlin "vde|" 2982a1ea458fSMark McLoughlin#endif 298358952137SVincenzo Maffione#ifdef CONFIG_NETMAP 298458952137SVincenzo Maffione "netmap|" 298558952137SVincenzo Maffione#endif 2986cb039ef3SIlya Maximets#ifdef CONFIG_AF_XDP 2987cb039ef3SIlya Maximets "af-xdp|" 2988cb039ef3SIlya Maximets#endif 2989b0290db1SVladislav Yaroshchuk#ifdef CONFIG_VMNET 2990b0290db1SVladislav Yaroshchuk "vmnet-host|vmnet-shared|vmnet-bridged|" 2991b0290db1SVladislav Yaroshchuk#endif 2992af1a5c3eSThomas Huth "socket][,option][,option][,...]\n" 29936a8b4a5bSThomas Huth " old way to initialize a host network interface\n" 29946a8b4a5bSThomas Huth " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 2995e2fcbf42SPeter MaydellSRST 2996cb039ef3SIlya Maximets``-nic [tap|bridge|user|l2tpv3|vde|netmap|af-xdp|vhost-user|socket][,...][,mac=macaddr][,model=mn]`` 2997e2fcbf42SPeter Maydell This option is a shortcut for configuring both the on-board 2998e2fcbf42SPeter Maydell (default) guest NIC hardware and the host network backend in one go. 2999e2fcbf42SPeter Maydell The host backend options are the same as with the corresponding 3000e2fcbf42SPeter Maydell ``-netdev`` options below. The guest NIC model can be set with 3001e2fcbf42SPeter Maydell ``model=modelname``. Use ``model=help`` to list the available device 3002e2fcbf42SPeter Maydell types. The hardware MAC address can be set with ``mac=macaddr``. 3003e2fcbf42SPeter Maydell 3004e2fcbf42SPeter Maydell The following two example do exactly the same, to show how ``-nic`` 3005e2fcbf42SPeter Maydell can be used to shorten the command line length: 3006e2fcbf42SPeter Maydell 3007e2fcbf42SPeter Maydell .. parsed-literal:: 3008e2fcbf42SPeter Maydell 3009e2fcbf42SPeter Maydell |qemu_system| -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32 3010e2fcbf42SPeter Maydell |qemu_system| -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32 3011e2fcbf42SPeter Maydell 3012e2fcbf42SPeter Maydell``-nic none`` 3013e2fcbf42SPeter Maydell Indicate that no network devices should be configured. It is used to 3014e2fcbf42SPeter Maydell override the default configuration (default NIC with "user" host 3015e2fcbf42SPeter Maydell network backend) which is activated if no other networking options 3016e2fcbf42SPeter Maydell are provided. 3017e2fcbf42SPeter Maydell 3018e2fcbf42SPeter Maydell``-netdev user,id=id[,option][,option][,...]`` 3019e2fcbf42SPeter Maydell Configure user mode host network backend which requires no 3020e2fcbf42SPeter Maydell administrator privilege to run. Valid options are: 3021e2fcbf42SPeter Maydell 3022e2fcbf42SPeter Maydell ``id=id`` 3023e2fcbf42SPeter Maydell Assign symbolic name for use in monitor commands. 3024e2fcbf42SPeter Maydell 3025e2fcbf42SPeter Maydell ``ipv4=on|off and ipv6=on|off`` 3026e2fcbf42SPeter Maydell Specify that either IPv4 or IPv6 must be enabled. If neither is 3027e2fcbf42SPeter Maydell specified both protocols are enabled. 3028e2fcbf42SPeter Maydell 3029e2fcbf42SPeter Maydell ``net=addr[/mask]`` 3030e2fcbf42SPeter Maydell Set IP network address the guest will see. Optionally specify 3031e2fcbf42SPeter Maydell the netmask, either in the form a.b.c.d or as number of valid 3032e2fcbf42SPeter Maydell top-most bits. Default is 10.0.2.0/24. 3033e2fcbf42SPeter Maydell 3034e2fcbf42SPeter Maydell ``host=addr`` 3035e2fcbf42SPeter Maydell Specify the guest-visible address of the host. Default is the 3036e2fcbf42SPeter Maydell 2nd IP in the guest network, i.e. x.x.x.2. 3037e2fcbf42SPeter Maydell 3038e2fcbf42SPeter Maydell ``ipv6-net=addr[/int]`` 3039e2fcbf42SPeter Maydell Set IPv6 network address the guest will see (default is 3040e2fcbf42SPeter Maydell fec0::/64). The network prefix is given in the usual hexadecimal 3041e2fcbf42SPeter Maydell IPv6 address notation. The prefix size is optional, and is given 3042e2fcbf42SPeter Maydell as the number of valid top-most bits (default is 64). 3043e2fcbf42SPeter Maydell 3044e2fcbf42SPeter Maydell ``ipv6-host=addr`` 3045e2fcbf42SPeter Maydell Specify the guest-visible IPv6 address of the host. Default is 3046e2fcbf42SPeter Maydell the 2nd IPv6 in the guest network, i.e. xxxx::2. 3047e2fcbf42SPeter Maydell 3048e2fcbf42SPeter Maydell ``restrict=on|off`` 3049e2fcbf42SPeter Maydell If this option is enabled, the guest will be isolated, i.e. it 3050e2fcbf42SPeter Maydell will not be able to contact the host and no guest IP packets 3051e2fcbf42SPeter Maydell will be routed over the host to the outside. This option does 3052e2fcbf42SPeter Maydell not affect any explicitly set forwarding rules. 3053e2fcbf42SPeter Maydell 3054e2fcbf42SPeter Maydell ``hostname=name`` 3055e2fcbf42SPeter Maydell Specifies the client hostname reported by the built-in DHCP 3056e2fcbf42SPeter Maydell server. 3057e2fcbf42SPeter Maydell 3058e2fcbf42SPeter Maydell ``dhcpstart=addr`` 3059e2fcbf42SPeter Maydell Specify the first of the 16 IPs the built-in DHCP server can 3060e2fcbf42SPeter Maydell assign. Default is the 15th to 31st IP in the guest network, 3061e2fcbf42SPeter Maydell i.e. x.x.x.15 to x.x.x.31. 3062e2fcbf42SPeter Maydell 3063e2fcbf42SPeter Maydell ``dns=addr`` 3064e2fcbf42SPeter Maydell Specify the guest-visible address of the virtual nameserver. The 3065e2fcbf42SPeter Maydell address must be different from the host address. Default is the 3066e2fcbf42SPeter Maydell 3rd IP in the guest network, i.e. x.x.x.3. 3067e2fcbf42SPeter Maydell 3068e2fcbf42SPeter Maydell ``ipv6-dns=addr`` 3069e2fcbf42SPeter Maydell Specify the guest-visible address of the IPv6 virtual 3070e2fcbf42SPeter Maydell nameserver. The address must be different from the host address. 3071e2fcbf42SPeter Maydell Default is the 3rd IP in the guest network, i.e. xxxx::3. 3072e2fcbf42SPeter Maydell 3073e2fcbf42SPeter Maydell ``dnssearch=domain`` 3074e2fcbf42SPeter Maydell Provides an entry for the domain-search list sent by the 3075e2fcbf42SPeter Maydell built-in DHCP server. More than one domain suffix can be 3076e2fcbf42SPeter Maydell transmitted by specifying this option multiple times. If 3077e2fcbf42SPeter Maydell supported, this will cause the guest to automatically try to 3078e2fcbf42SPeter Maydell append the given domain suffix(es) in case a domain name can not 3079e2fcbf42SPeter Maydell be resolved. 3080e2fcbf42SPeter Maydell 3081e2fcbf42SPeter Maydell Example: 3082e2fcbf42SPeter Maydell 3083e2fcbf42SPeter Maydell .. parsed-literal:: 3084e2fcbf42SPeter Maydell 3085e2fcbf42SPeter Maydell |qemu_system| -nic user,dnssearch=mgmt.example.org,dnssearch=example.org 3086e2fcbf42SPeter Maydell 3087e2fcbf42SPeter Maydell ``domainname=domain`` 3088e2fcbf42SPeter Maydell Specifies the client domain name reported by the built-in DHCP 3089e2fcbf42SPeter Maydell server. 3090e2fcbf42SPeter Maydell 3091e2fcbf42SPeter Maydell ``tftp=dir`` 3092e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in TFTP 3093e2fcbf42SPeter Maydell server. The files in dir will be exposed as the root of a TFTP 3094e2fcbf42SPeter Maydell server. The TFTP client on the guest must be configured in 3095e2fcbf42SPeter Maydell binary mode (use the command ``bin`` of the Unix TFTP client). 3096e2fcbf42SPeter Maydell 3097e2fcbf42SPeter Maydell ``tftp-server-name=name`` 3098e2fcbf42SPeter Maydell In BOOTP reply, broadcast name as the "TFTP server name" 3099e2fcbf42SPeter Maydell (RFC2132 option 66). This can be used to advise the guest to 3100e2fcbf42SPeter Maydell load boot files or configurations from a different server than 3101e2fcbf42SPeter Maydell the host address. 3102e2fcbf42SPeter Maydell 3103e2fcbf42SPeter Maydell ``bootfile=file`` 3104e2fcbf42SPeter Maydell When using the user mode network stack, broadcast file as the 3105e2fcbf42SPeter Maydell BOOTP filename. In conjunction with ``tftp``, this can be used 3106e2fcbf42SPeter Maydell to network boot a guest from a local directory. 3107e2fcbf42SPeter Maydell 3108e2fcbf42SPeter Maydell Example (using pxelinux): 3109e2fcbf42SPeter Maydell 3110e2fcbf42SPeter Maydell .. parsed-literal:: 3111e2fcbf42SPeter Maydell 3112353a06b4SLaszlo Ersek |qemu_system| -hda linux.img -boot n -device e1000,netdev=n1 \\ 3113e2fcbf42SPeter Maydell -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 3114e2fcbf42SPeter Maydell 3115e2fcbf42SPeter Maydell ``smb=dir[,smbserver=addr]`` 3116e2fcbf42SPeter Maydell When using the user mode network stack, activate a built-in SMB 3117e2fcbf42SPeter Maydell server so that Windows OSes can access to the host files in 3118e2fcbf42SPeter Maydell ``dir`` transparently. The IP address of the SMB server can be 3119e2fcbf42SPeter Maydell set to addr. By default the 4th IP in the guest network is used, 3120e2fcbf42SPeter Maydell i.e. x.x.x.4. 3121e2fcbf42SPeter Maydell 3122e2fcbf42SPeter Maydell In the guest Windows OS, the line: 3123e2fcbf42SPeter Maydell 3124e2fcbf42SPeter Maydell :: 3125e2fcbf42SPeter Maydell 3126e2fcbf42SPeter Maydell 10.0.2.4 smbserver 3127e2fcbf42SPeter Maydell 3128e2fcbf42SPeter Maydell must be added in the file ``C:\WINDOWS\LMHOSTS`` (for windows 3129e2fcbf42SPeter Maydell 9x/Me) or ``C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS`` (Windows 3130e2fcbf42SPeter Maydell NT/2000). 3131e2fcbf42SPeter Maydell 3132e2fcbf42SPeter Maydell Then ``dir`` can be accessed in ``\\smbserver\qemu``. 3133e2fcbf42SPeter Maydell 3134e2fcbf42SPeter Maydell Note that a SAMBA server must be installed on the host OS. 3135e2fcbf42SPeter Maydell 3136e2fcbf42SPeter Maydell ``hostfwd=[tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport`` 3137e2fcbf42SPeter Maydell Redirect incoming TCP or UDP connections to the host port 3138e2fcbf42SPeter Maydell hostport to the guest IP address guestaddr on guest port 3139e2fcbf42SPeter Maydell guestport. If guestaddr is not specified, its value is x.x.x.15 3140e2fcbf42SPeter Maydell (default first address given by the built-in DHCP server). By 3141e2fcbf42SPeter Maydell specifying hostaddr, the rule can be bound to a specific host 3142e2fcbf42SPeter Maydell interface. If no connection type is set, TCP is used. This 3143e2fcbf42SPeter Maydell option can be given multiple times. 3144e2fcbf42SPeter Maydell 3145e2fcbf42SPeter Maydell For example, to redirect host X11 connection from screen 1 to 3146e2fcbf42SPeter Maydell guest screen 0, use the following: 3147e2fcbf42SPeter Maydell 314809ce5f2dSPeter Maydell .. parsed-literal:: 3149e2fcbf42SPeter Maydell 3150e2fcbf42SPeter Maydell # on the host 3151e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp:127.0.0.1:6001-:6000 3152e2fcbf42SPeter Maydell # this host xterm should open in the guest X11 server 3153e2fcbf42SPeter Maydell xterm -display :1 3154e2fcbf42SPeter Maydell 3155e2fcbf42SPeter Maydell To redirect telnet connections from host port 5555 to telnet 3156e2fcbf42SPeter Maydell port on the guest, use the following: 3157e2fcbf42SPeter Maydell 315809ce5f2dSPeter Maydell .. parsed-literal:: 3159e2fcbf42SPeter Maydell 3160e2fcbf42SPeter Maydell # on the host 3161e2fcbf42SPeter Maydell |qemu_system| -nic user,hostfwd=tcp::5555-:23 3162e2fcbf42SPeter Maydell telnet localhost 5555 3163e2fcbf42SPeter Maydell 3164e2fcbf42SPeter Maydell Then when you use on the host ``telnet localhost 5555``, you 3165e2fcbf42SPeter Maydell connect to the guest telnet server. 3166e2fcbf42SPeter Maydell 3167e2fcbf42SPeter Maydell ``guestfwd=[tcp]:server:port-dev``; \ ``guestfwd=[tcp]:server:port-cmd:command`` 3168e2fcbf42SPeter Maydell Forward guest TCP connections to the IP address server on port 3169e2fcbf42SPeter Maydell port to the character device dev or to a program executed by 3170e2fcbf42SPeter Maydell cmd:command which gets spawned for each connection. This option 3171e2fcbf42SPeter Maydell can be given multiple times. 3172e2fcbf42SPeter Maydell 3173e2fcbf42SPeter Maydell You can either use a chardev directly and have that one used 3174e2fcbf42SPeter Maydell throughout QEMU's lifetime, like in the following example: 3175e2fcbf42SPeter Maydell 317609ce5f2dSPeter Maydell .. parsed-literal:: 3177e2fcbf42SPeter Maydell 3178e2fcbf42SPeter Maydell # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 3179e2fcbf42SPeter Maydell # the guest accesses it 3180e2fcbf42SPeter Maydell |qemu_system| -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 3181e2fcbf42SPeter Maydell 3182e2fcbf42SPeter Maydell Or you can execute a command on every TCP connection established 3183e2fcbf42SPeter Maydell by the guest, so that QEMU behaves similar to an inetd process 3184e2fcbf42SPeter Maydell for that virtual server: 3185e2fcbf42SPeter Maydell 318609ce5f2dSPeter Maydell .. parsed-literal:: 3187e2fcbf42SPeter Maydell 3188e2fcbf42SPeter Maydell # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 3189e2fcbf42SPeter Maydell # and connect the TCP stream to its stdin/stdout 3190e2fcbf42SPeter Maydell |qemu_system| -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 3191e2fcbf42SPeter Maydell 3192e2fcbf42SPeter Maydell``-netdev tap,id=id[,fd=h][,ifname=name][,script=file][,downscript=dfile][,br=bridge][,helper=helper]`` 3193e2fcbf42SPeter Maydell Configure a host TAP network backend with ID id. 3194e2fcbf42SPeter Maydell 3195e2fcbf42SPeter Maydell Use the network script file to configure it and the network script 3196e2fcbf42SPeter Maydell dfile to deconfigure it. If name is not provided, the OS 3197e2fcbf42SPeter Maydell automatically provides one. The default network configure script is 3198e2fcbf42SPeter Maydell ``/etc/qemu-ifup`` and the default network deconfigure script is 3199e2fcbf42SPeter Maydell ``/etc/qemu-ifdown``. Use ``script=no`` or ``downscript=no`` to 3200e2fcbf42SPeter Maydell disable script execution. 3201e2fcbf42SPeter Maydell 3202e2fcbf42SPeter Maydell If running QEMU as an unprivileged user, use the network helper 32038d73ec89STianjia Zhang to configure the TAP interface and attach it to the bridge. 3204e2fcbf42SPeter Maydell The default network helper executable is 3205e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 3206e2fcbf42SPeter Maydell ``br0``. 3207e2fcbf42SPeter Maydell 3208e2fcbf42SPeter Maydell ``fd``\ =h can be used to specify the handle of an already opened 3209e2fcbf42SPeter Maydell host TAP interface. 3210e2fcbf42SPeter Maydell 3211e2fcbf42SPeter Maydell Examples: 3212e2fcbf42SPeter Maydell 321309ce5f2dSPeter Maydell .. parsed-literal:: 3214e2fcbf42SPeter Maydell 3215e2fcbf42SPeter Maydell #launch a QEMU instance with the default network script 3216e2fcbf42SPeter Maydell |qemu_system| linux.img -nic tap 3217e2fcbf42SPeter Maydell 321809ce5f2dSPeter Maydell .. parsed-literal:: 3219e2fcbf42SPeter Maydell 3220e2fcbf42SPeter Maydell #launch a QEMU instance with two NICs, each one connected 3221e2fcbf42SPeter Maydell #to a TAP device 3222353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3223353a06b4SLaszlo Ersek -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \\ 3224e2fcbf42SPeter Maydell -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1 3225e2fcbf42SPeter Maydell 322609ce5f2dSPeter Maydell .. parsed-literal:: 3227e2fcbf42SPeter Maydell 3228e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3229e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 3230353a06b4SLaszlo Ersek |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \\ 3231e2fcbf42SPeter Maydell -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper" 3232e2fcbf42SPeter Maydell 3233e2fcbf42SPeter Maydell``-netdev bridge,id=id[,br=bridge][,helper=helper]`` 3234e2fcbf42SPeter Maydell Connect a host TAP network interface to a host bridge device. 3235e2fcbf42SPeter Maydell 3236e2fcbf42SPeter Maydell Use the network helper helper to configure the TAP interface and 3237e2fcbf42SPeter Maydell attach it to the bridge. The default network helper executable is 3238e2fcbf42SPeter Maydell ``/path/to/qemu-bridge-helper`` and the default bridge device is 3239e2fcbf42SPeter Maydell ``br0``. 3240e2fcbf42SPeter Maydell 3241e2fcbf42SPeter Maydell Examples: 3242e2fcbf42SPeter Maydell 324309ce5f2dSPeter Maydell .. parsed-literal:: 3244e2fcbf42SPeter Maydell 3245e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3246e2fcbf42SPeter Maydell #connect a TAP device to bridge br0 3247e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1 3248e2fcbf42SPeter Maydell 324909ce5f2dSPeter Maydell .. parsed-literal:: 3250e2fcbf42SPeter Maydell 3251e2fcbf42SPeter Maydell #launch a QEMU instance with the default network helper to 3252e2fcbf42SPeter Maydell #connect a TAP device to bridge qemubr0 3253e2fcbf42SPeter Maydell |qemu_system| linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1 3254e2fcbf42SPeter Maydell 3255e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,listen=[host]:port][,connect=host:port]`` 3256e2fcbf42SPeter Maydell This host network backend can be used to connect the guest's network 3257e2fcbf42SPeter Maydell to another QEMU virtual machine using a TCP socket connection. If 3258e2fcbf42SPeter Maydell ``listen`` is specified, QEMU waits for incoming connections on port 3259e2fcbf42SPeter Maydell (host is optional). ``connect`` is used to connect to another QEMU 3260e2fcbf42SPeter Maydell instance using the ``listen`` option. ``fd``\ =h specifies an 3261e2fcbf42SPeter Maydell already opened TCP socket. 3262e2fcbf42SPeter Maydell 3263e2fcbf42SPeter Maydell Example: 3264e2fcbf42SPeter Maydell 326509ce5f2dSPeter Maydell .. parsed-literal:: 3266e2fcbf42SPeter Maydell 3267e2fcbf42SPeter Maydell # launch a first QEMU instance 3268353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3269353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3270e2fcbf42SPeter Maydell -netdev socket,id=n1,listen=:1234 3271e2fcbf42SPeter Maydell # connect the network of this instance to the network of the first instance 3272353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3273353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 3274e2fcbf42SPeter Maydell -netdev socket,id=n2,connect=127.0.0.1:1234 3275e2fcbf42SPeter Maydell 3276e2fcbf42SPeter Maydell``-netdev socket,id=id[,fd=h][,mcast=maddr:port[,localaddr=addr]]`` 3277e2fcbf42SPeter Maydell Configure a socket host network backend to share the guest's network 3278e2fcbf42SPeter Maydell traffic with another QEMU virtual machines using a UDP multicast 3279e2fcbf42SPeter Maydell socket, effectively making a bus for every QEMU with same multicast 3280e2fcbf42SPeter Maydell address maddr and port. NOTES: 3281e2fcbf42SPeter Maydell 3282e2fcbf42SPeter Maydell 1. Several QEMU can be running on different hosts and share same bus 3283e2fcbf42SPeter Maydell (assuming correct multicast setup for these hosts). 3284e2fcbf42SPeter Maydell 3285e2fcbf42SPeter Maydell 2. mcast support is compatible with User Mode Linux (argument 3286e2fcbf42SPeter Maydell ``ethN=mcast``), see http://user-mode-linux.sf.net. 3287e2fcbf42SPeter Maydell 3288e2fcbf42SPeter Maydell 3. Use ``fd=h`` to specify an already opened UDP multicast socket. 3289e2fcbf42SPeter Maydell 3290e2fcbf42SPeter Maydell Example: 3291e2fcbf42SPeter Maydell 329209ce5f2dSPeter Maydell .. parsed-literal:: 3293e2fcbf42SPeter Maydell 3294e2fcbf42SPeter Maydell # launch one QEMU instance 3295353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3296353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3297e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=230.0.0.1:1234 3298e2fcbf42SPeter Maydell # launch another QEMU instance on same "bus" 3299353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3300353a06b4SLaszlo Ersek -device e1000,netdev=n2,mac=52:54:00:12:34:57 \\ 3301e2fcbf42SPeter Maydell -netdev socket,id=n2,mcast=230.0.0.1:1234 3302e2fcbf42SPeter Maydell # launch yet another QEMU instance on same "bus" 3303353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3304353a06b4SLaszlo Ersek -device e1000,netdev=n3,mac=52:54:00:12:34:58 \\ 3305e2fcbf42SPeter Maydell -netdev socket,id=n3,mcast=230.0.0.1:1234 3306e2fcbf42SPeter Maydell 3307e2fcbf42SPeter Maydell Example (User Mode Linux compat.): 3308e2fcbf42SPeter Maydell 330909ce5f2dSPeter Maydell .. parsed-literal:: 3310e2fcbf42SPeter Maydell 3311e2fcbf42SPeter Maydell # launch QEMU instance (note mcast address selected is UML's default) 3312353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3313353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3314e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102 3315e2fcbf42SPeter Maydell # launch UML 3316e2fcbf42SPeter Maydell /path/to/linux ubd0=/path/to/root_fs eth0=mcast 3317e2fcbf42SPeter Maydell 3318e2fcbf42SPeter Maydell Example (send packets from host's 1.2.3.4): 3319e2fcbf42SPeter Maydell 3320e2fcbf42SPeter Maydell .. parsed-literal:: 3321e2fcbf42SPeter Maydell 3322353a06b4SLaszlo Ersek |qemu_system| linux.img \\ 3323353a06b4SLaszlo Ersek -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ 3324e2fcbf42SPeter Maydell -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 3325e2fcbf42SPeter Maydell 33268b0dc246SDaniel 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]`` 3327e2fcbf42SPeter Maydell Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931) 3328e2fcbf42SPeter Maydell is a popular protocol to transport Ethernet (and other Layer 2) data 3329e2fcbf42SPeter Maydell frames between two systems. It is present in routers, firewalls and 3330e2fcbf42SPeter Maydell the Linux kernel (from version 3.3 onwards). 3331e2fcbf42SPeter Maydell 3332e2fcbf42SPeter Maydell This transport allows a VM to communicate to another VM, router or 3333e2fcbf42SPeter Maydell firewall directly. 3334e2fcbf42SPeter Maydell 3335e2fcbf42SPeter Maydell ``src=srcaddr`` 3336e2fcbf42SPeter Maydell source address (mandatory) 3337e2fcbf42SPeter Maydell 3338e2fcbf42SPeter Maydell ``dst=dstaddr`` 3339e2fcbf42SPeter Maydell destination address (mandatory) 3340e2fcbf42SPeter Maydell 3341e2fcbf42SPeter Maydell ``udp`` 3342e2fcbf42SPeter Maydell select udp encapsulation (default is ip). 3343e2fcbf42SPeter Maydell 3344e2fcbf42SPeter Maydell ``srcport=srcport`` 3345e2fcbf42SPeter Maydell source udp port. 3346e2fcbf42SPeter Maydell 3347e2fcbf42SPeter Maydell ``dstport=dstport`` 3348e2fcbf42SPeter Maydell destination udp port. 3349e2fcbf42SPeter Maydell 3350e2fcbf42SPeter Maydell ``ipv6`` 3351e2fcbf42SPeter Maydell force v6, otherwise defaults to v4. 3352e2fcbf42SPeter Maydell 3353e2fcbf42SPeter Maydell ``rxcookie=rxcookie``; \ ``txcookie=txcookie`` 3354e2fcbf42SPeter Maydell Cookies are a weak form of security in the l2tpv3 specification. 3355e2fcbf42SPeter Maydell Their function is mostly to prevent misconfiguration. By default 3356e2fcbf42SPeter Maydell they are 32 bit. 3357e2fcbf42SPeter Maydell 3358e2fcbf42SPeter Maydell ``cookie64`` 3359e2fcbf42SPeter Maydell Set cookie size to 64 bit instead of the default 32 3360e2fcbf42SPeter Maydell 3361e2fcbf42SPeter Maydell ``counter=off`` 3362e2fcbf42SPeter Maydell Force a 'cut-down' L2TPv3 with no counter as in 3363e2fcbf42SPeter Maydell draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 3364e2fcbf42SPeter Maydell 3365e2fcbf42SPeter Maydell ``pincounter=on`` 3366e2fcbf42SPeter Maydell Work around broken counter handling in peer. This may also help 3367e2fcbf42SPeter Maydell on networks which have packet reorder. 3368e2fcbf42SPeter Maydell 3369e2fcbf42SPeter Maydell ``offset=offset`` 3370e2fcbf42SPeter Maydell Add an extra offset between header and data 3371e2fcbf42SPeter Maydell 3372e2fcbf42SPeter Maydell For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to 3373e2fcbf42SPeter Maydell the bridge br-lan on the remote Linux host 1.2.3.4: 3374e2fcbf42SPeter Maydell 337509ce5f2dSPeter Maydell .. parsed-literal:: 3376e2fcbf42SPeter Maydell 3377e2fcbf42SPeter Maydell # Setup tunnel on linux host using raw ip as encapsulation 3378e2fcbf42SPeter Maydell # on 1.2.3.4 3379353a06b4SLaszlo Ersek ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \\ 3380e2fcbf42SPeter Maydell encap udp udp_sport 16384 udp_dport 16384 3381353a06b4SLaszlo Ersek ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \\ 3382e2fcbf42SPeter Maydell 0xFFFFFFFF peer_session_id 0xFFFFFFFF 3383e2fcbf42SPeter Maydell ifconfig vmtunnel0 mtu 1500 3384e2fcbf42SPeter Maydell ifconfig vmtunnel0 up 3385e2fcbf42SPeter Maydell brctl addif br-lan vmtunnel0 3386e2fcbf42SPeter Maydell 3387e2fcbf42SPeter Maydell 3388e2fcbf42SPeter Maydell # on 4.3.2.1 3389e2fcbf42SPeter Maydell # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 3390e2fcbf42SPeter Maydell 3391353a06b4SLaszlo Ersek |qemu_system| linux.img -device e1000,netdev=n1 \\ 3392e2fcbf42SPeter 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 3393e2fcbf42SPeter Maydell 3394e2fcbf42SPeter Maydell``-netdev vde,id=id[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]`` 3395e2fcbf42SPeter Maydell Configure VDE backend to connect to PORT n of a vde switch running 3396e2fcbf42SPeter Maydell on host and listening for incoming connections on socketpath. Use 3397e2fcbf42SPeter Maydell GROUP groupname and MODE octalmode to change default ownership and 3398e2fcbf42SPeter Maydell permissions for communication port. This option is only available if 3399e2fcbf42SPeter Maydell QEMU has been compiled with vde support enabled. 3400e2fcbf42SPeter Maydell 3401e2fcbf42SPeter Maydell Example: 3402e2fcbf42SPeter Maydell 340309ce5f2dSPeter Maydell .. parsed-literal:: 3404e2fcbf42SPeter Maydell 3405e2fcbf42SPeter Maydell # launch vde switch 3406e2fcbf42SPeter Maydell vde_switch -F -sock /tmp/myswitch 3407e2fcbf42SPeter Maydell # launch QEMU instance 3408e2fcbf42SPeter Maydell |qemu_system| linux.img -nic vde,sock=/tmp/myswitch 3409e2fcbf42SPeter Maydell 3410cb039ef3SIlya Maximets``-netdev af-xdp,id=str,ifname=name[,mode=native|skb][,force-copy=on|off][,queues=n][,start-queue=m][,inhibit=on|off][,sock-fds=x:y:...:z]`` 3411cb039ef3SIlya Maximets Configure AF_XDP backend to connect to a network interface 'name' 3412cb039ef3SIlya Maximets using AF_XDP socket. A specific program attach mode for a default 3413cb039ef3SIlya Maximets XDP program can be forced with 'mode', defaults to best-effort, 3414cb039ef3SIlya Maximets where the likely most performant mode will be in use. Number of queues 3415cb039ef3SIlya Maximets 'n' should generally match the number or queues in the interface, 3416cb039ef3SIlya Maximets defaults to 1. Traffic arriving on non-configured device queues will 3417cb039ef3SIlya Maximets not be delivered to the network backend. 3418cb039ef3SIlya Maximets 3419cb039ef3SIlya Maximets .. parsed-literal:: 3420cb039ef3SIlya Maximets 3421cb039ef3SIlya Maximets # set number of queues to 4 3422cb039ef3SIlya Maximets ethtool -L eth0 combined 4 3423cb039ef3SIlya Maximets # launch QEMU instance 3424cb039ef3SIlya Maximets |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \\ 3425cb039ef3SIlya Maximets -netdev af-xdp,id=n1,ifname=eth0,queues=4 3426cb039ef3SIlya Maximets 3427cb039ef3SIlya Maximets 'start-queue' option can be specified if a particular range of queues 3428cb039ef3SIlya Maximets [m, m + n] should be in use. For example, this is may be necessary in 3429cb039ef3SIlya Maximets order to use certain NICs in native mode. Kernel allows the driver to 3430cb039ef3SIlya Maximets create a separate set of XDP queues on top of regular ones, and only 3431cb039ef3SIlya Maximets these queues can be used for AF_XDP sockets. NICs that work this way 3432cb039ef3SIlya Maximets may also require an additional traffic redirection with ethtool to these 3433cb039ef3SIlya Maximets special queues. 3434cb039ef3SIlya Maximets 3435cb039ef3SIlya Maximets .. parsed-literal:: 3436cb039ef3SIlya Maximets 3437cb039ef3SIlya Maximets # set number of queues to 1 3438cb039ef3SIlya Maximets ethtool -L eth0 combined 1 3439cb039ef3SIlya Maximets # redirect all the traffic to the second queue (id: 1) 3440cb039ef3SIlya Maximets # note: drivers may require non-empty key/mask pair. 3441cb039ef3SIlya Maximets ethtool -N eth0 flow-type ether \\ 3442cb039ef3SIlya Maximets dst 00:00:00:00:00:00 m FF:FF:FF:FF:FF:FE action 1 3443cb039ef3SIlya Maximets ethtool -N eth0 flow-type ether \\ 3444cb039ef3SIlya Maximets dst 00:00:00:00:00:01 m FF:FF:FF:FF:FF:FE action 1 3445cb039ef3SIlya Maximets # launch QEMU instance 3446cb039ef3SIlya Maximets |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \\ 3447cb039ef3SIlya Maximets -netdev af-xdp,id=n1,ifname=eth0,queues=1,start-queue=1 3448cb039ef3SIlya Maximets 3449cb039ef3SIlya Maximets XDP program can also be loaded externally. In this case 'inhibit' option 3450cb039ef3SIlya Maximets should be set to 'on' and 'sock-fds' provided with file descriptors for 3451cb039ef3SIlya Maximets already open but not bound XDP sockets already added to a socket map for 3452cb039ef3SIlya Maximets corresponding queues. One socket per queue. 3453cb039ef3SIlya Maximets 3454cb039ef3SIlya Maximets .. parsed-literal:: 3455cb039ef3SIlya Maximets 3456cb039ef3SIlya Maximets |qemu_system| linux.img -device virtio-net-pci,netdev=n1 \\ 3457cb039ef3SIlya Maximets -netdev af-xdp,id=n1,ifname=eth0,queues=3,inhibit=on,sock-fds=15:16:17 3458cb039ef3SIlya Maximets 3459e2fcbf42SPeter Maydell``-netdev vhost-user,chardev=id[,vhostforce=on|off][,queues=n]`` 3460e2fcbf42SPeter Maydell Establish a vhost-user netdev, backed by a chardev id. The chardev 3461e2fcbf42SPeter Maydell should be a unix domain socket backed one. The vhost-user uses a 3462e2fcbf42SPeter Maydell specifically defined protocol to pass vhost ioctl replacement 3463e2fcbf42SPeter Maydell messages to an application on the other end of the socket. On 3464e2fcbf42SPeter Maydell non-MSIX guests, the feature can be forced with vhostforce. Use 3465e2fcbf42SPeter Maydell 'queues=n' to specify the number of queues to be created for 3466e2fcbf42SPeter Maydell multiqueue vhost-user. 3467e2fcbf42SPeter Maydell 3468e2fcbf42SPeter Maydell Example: 3469e2fcbf42SPeter Maydell 3470e2fcbf42SPeter Maydell :: 3471e2fcbf42SPeter Maydell 3472e2fcbf42SPeter Maydell qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 3473e2fcbf42SPeter Maydell -numa node,memdev=mem \ 3474e2fcbf42SPeter Maydell -chardev socket,id=chr0,path=/path/to/socket \ 3475e2fcbf42SPeter Maydell -netdev type=vhost-user,id=net0,chardev=chr0 \ 3476e2fcbf42SPeter Maydell -device virtio-net-pci,netdev=net0 3477e2fcbf42SPeter Maydell 34788801ccd0SSi-Wei Liu``-netdev vhost-vdpa[,vhostdev=/path/to/dev][,vhostfd=h]`` 3479108a6481SCindy Lu Establish a vhost-vdpa netdev. 3480108a6481SCindy Lu 3481108a6481SCindy Lu vDPA device is a device that uses a datapath which complies with 3482108a6481SCindy Lu the virtio specifications with a vendor specific control path. 3483108a6481SCindy Lu vDPA devices can be both physically located on the hardware or 3484108a6481SCindy Lu emulated by software. 3485108a6481SCindy Lu 3486e2fcbf42SPeter Maydell``-netdev hubport,id=id,hubid=hubid[,netdev=nd]`` 3487e2fcbf42SPeter Maydell Create a hub port on the emulated hub with ID hubid. 3488e2fcbf42SPeter Maydell 3489e2fcbf42SPeter Maydell The hubport netdev lets you connect a NIC to a QEMU emulated hub 3490e2fcbf42SPeter Maydell instead of a single netdev. Alternatively, you can also connect the 3491e2fcbf42SPeter Maydell hubport to another netdev with ID nd by using the ``netdev=nd`` 3492e2fcbf42SPeter Maydell option. 3493e2fcbf42SPeter Maydell 3494e2fcbf42SPeter Maydell``-net nic[,netdev=nd][,macaddr=mac][,model=type] [,name=name][,addr=addr][,vectors=v]`` 3495e2fcbf42SPeter Maydell Legacy option to configure or create an on-board (or machine 3496e2fcbf42SPeter Maydell default) Network Interface Card(NIC) and connect it either to the 3497e2fcbf42SPeter Maydell emulated hub with ID 0 (i.e. the default hub), or to the netdev nd. 3498e2fcbf42SPeter Maydell If model is omitted, then the default NIC model associated with the 3499e2fcbf42SPeter Maydell machine type is used. Note that the default NIC model may change in 3500e2fcbf42SPeter Maydell future QEMU releases, so it is highly recommended to always specify 3501e2fcbf42SPeter Maydell a model. Optionally, the MAC address can be changed to mac, the 3502e2fcbf42SPeter Maydell device address set to addr (PCI cards only), and a name can be 3503e2fcbf42SPeter Maydell assigned for use in monitor commands. Optionally, for PCI cards, you 3504e2fcbf42SPeter Maydell can specify the number v of MSI-X vectors that the card should have; 3505e2fcbf42SPeter Maydell this option currently only affects virtio cards; set v = 0 to 3506e2fcbf42SPeter Maydell disable MSI-X. If no ``-net`` option is specified, a single NIC is 3507e2fcbf42SPeter Maydell created. QEMU can emulate several different models of network card. 3508e2fcbf42SPeter Maydell Use ``-net nic,model=help`` for a list of available devices for your 3509e2fcbf42SPeter Maydell target. 3510e2fcbf42SPeter Maydell 3511e2fcbf42SPeter Maydell``-net user|tap|bridge|socket|l2tpv3|vde[,...][,name=name]`` 3512e2fcbf42SPeter Maydell Configure a host network backend (with the options corresponding to 3513e2fcbf42SPeter Maydell the same ``-netdev`` option) and connect it to the emulated hub 0 3514e2fcbf42SPeter Maydell (the default hub). Use name to specify the name of the hub port. 3515e2fcbf42SPeter MaydellERST 35165824d651Sblueswir1 35177273a2dbSMatthew BoothDEFHEADING() 35187273a2dbSMatthew Booth 3519de6b4f90SMarkus ArmbrusterDEFHEADING(Character device options:) 35207273a2dbSMatthew Booth 35217273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 3522517b3d40SLin Ma "-chardev help\n" 3523d0d7708bSDaniel P. Berrange "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3524ba858d1fSMarkus Armbruster "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]\n" 3525bfdc1267SDaniel P. Berrangé " [,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds][,mux=on|off]\n" 3526fd4a5fd4SDaniel P. Berrange " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n" 3527bfdc1267SDaniel P. Berrangé "-chardev socket,id=id,path=path[,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds]\n" 3528e339273bSxiaoqiang zhao " [,mux=on|off][,logfile=PATH][,logappend=on|off][,abstract=on|off][,tight=on|off] (unix)\n" 35297273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 3530bfdc1267SDaniel P. Berrangé " [,localport=localport][,ipv4=on|off][,ipv6=on|off][,mux=on|off]\n" 3531d0d7708bSDaniel P. Berrange " [,logfile=PATH][,logappend=on|off]\n" 3532d0d7708bSDaniel P. Berrange "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 35337273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 3534d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3535d0d7708bSDaniel P. Berrange "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 35365b18a6bfSPeter Maydell "-chardev file,id=id,path=path[,input-path=input-file][,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3537d0d7708bSDaniel P. Berrange "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 35387273a2dbSMatthew Booth#ifdef _WIN32 3539d0d7708bSDaniel P. Berrange "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3540d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 35417273a2dbSMatthew Booth#else 3542d0d7708bSDaniel P. Berrange "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 3543d0d7708bSDaniel P. Berrange "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 35447273a2dbSMatthew Booth#endif 35457273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 3546d0d7708bSDaniel P. Berrange "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 35477273a2dbSMatthew Booth#endif 35487273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 35497273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 3550d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 35517273a2dbSMatthew Booth#endif 35527273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 3553d0d7708bSDaniel P. Berrange "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 35547273a2dbSMatthew Booth#endif 3555cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 3556d0d7708bSDaniel P. Berrange "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3557d0d7708bSDaniel P. Berrange "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 3558cbcc6336SAlon Levy#endif 3559ad96090aSBlue Swirl , QEMU_ARCH_ALL 35607273a2dbSMatthew Booth) 35617273a2dbSMatthew Booth 3562e2fcbf42SPeter MaydellSRST 3563e2fcbf42SPeter MaydellThe general form of a character device option is: 3564e2fcbf42SPeter Maydell 3565e2fcbf42SPeter Maydell``-chardev backend,id=id[,mux=on|off][,options]`` 3566e2fcbf42SPeter Maydell Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, 3567e2fcbf42SPeter Maydell ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``, 35686f9f6308SPaolo Bonzini ``pty``, ``stdio``, ``braille``, ``parallel``, 3569e2fcbf42SPeter Maydell ``spicevmc``, ``spiceport``. The specific backend will determine the 3570e2fcbf42SPeter Maydell applicable options. 3571e2fcbf42SPeter Maydell 3572e2fcbf42SPeter Maydell Use ``-chardev help`` to print all available chardev backend types. 3573e2fcbf42SPeter Maydell 3574e2fcbf42SPeter Maydell All devices must have an id, which can be any string up to 127 3575e2fcbf42SPeter Maydell characters long. It is used to uniquely identify this device in 3576e2fcbf42SPeter Maydell other command line directives. 3577e2fcbf42SPeter Maydell 3578e2fcbf42SPeter Maydell A character device may be used in multiplexing mode by multiple 3579e2fcbf42SPeter Maydell front-ends. Specify ``mux=on`` to enable this mode. A multiplexer is 3580e2fcbf42SPeter Maydell a "1:N" device, and here the "1" end is your specified chardev 3581e2fcbf42SPeter Maydell backend, and the "N" end is the various parts of QEMU that can talk 3582e2fcbf42SPeter Maydell to a chardev. If you create a chardev with ``id=myid`` and 3583e2fcbf42SPeter Maydell ``mux=on``, QEMU will create a multiplexer with your specified ID, 3584e2fcbf42SPeter Maydell and you can then configure multiple front ends to use that chardev 3585e2fcbf42SPeter Maydell ID for their input/output. Up to four different front ends can be 3586e2fcbf42SPeter Maydell connected to a single multiplexed chardev. (Without multiplexing 3587e2fcbf42SPeter Maydell enabled, a chardev can only be used by a single front end.) For 3588e2fcbf42SPeter Maydell instance you could use this to allow a single stdio chardev to be 3589e2fcbf42SPeter Maydell used by two serial ports and the QEMU monitor: 3590e2fcbf42SPeter Maydell 3591e2fcbf42SPeter Maydell :: 3592e2fcbf42SPeter Maydell 3593e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3594e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3595e2fcbf42SPeter Maydell -serial chardev:char0 \ 3596e2fcbf42SPeter Maydell -serial chardev:char0 3597e2fcbf42SPeter Maydell 3598e2fcbf42SPeter Maydell You can have more than one multiplexer in a system configuration; 3599e2fcbf42SPeter Maydell for instance you could have a TCP port multiplexed between UART 0 3600e2fcbf42SPeter Maydell and UART 1, and stdio multiplexed between the QEMU monitor and a 3601e2fcbf42SPeter Maydell parallel port: 3602e2fcbf42SPeter Maydell 3603e2fcbf42SPeter Maydell :: 3604e2fcbf42SPeter Maydell 3605e2fcbf42SPeter Maydell -chardev stdio,mux=on,id=char0 \ 3606e2fcbf42SPeter Maydell -mon chardev=char0,mode=readline \ 3607e2fcbf42SPeter Maydell -parallel chardev:char0 \ 3608e2fcbf42SPeter Maydell -chardev tcp,...,mux=on,id=char1 \ 3609e2fcbf42SPeter Maydell -serial chardev:char1 \ 3610e2fcbf42SPeter Maydell -serial chardev:char1 3611e2fcbf42SPeter Maydell 3612e2fcbf42SPeter Maydell When you're using a multiplexed character device, some escape 3613923e9311SThomas Huth sequences are interpreted in the input. See the chapter about 3614923e9311SThomas Huth :ref:`keys in the character backend multiplexer` in the 3615923e9311SThomas Huth System Emulation Users Guide for more details. 3616e2fcbf42SPeter Maydell 3617e2fcbf42SPeter Maydell Note that some other command line options may implicitly create 3618e2fcbf42SPeter Maydell multiplexed character backends; for instance ``-serial mon:stdio`` 3619e2fcbf42SPeter Maydell creates a multiplexed stdio backend connected to the serial port and 3620e2fcbf42SPeter Maydell the QEMU monitor, and ``-nographic`` also multiplexes the console 3621e2fcbf42SPeter Maydell and the monitor to stdio. 3622e2fcbf42SPeter Maydell 3623e2fcbf42SPeter Maydell There is currently no support for multiplexing in the other 3624e2fcbf42SPeter Maydell direction (where a single QEMU front end takes input and output from 3625e2fcbf42SPeter Maydell multiple chardevs). 3626e2fcbf42SPeter Maydell 3627e2fcbf42SPeter Maydell Every backend supports the ``logfile`` option, which supplies the 3628e2fcbf42SPeter Maydell path to a file to record all data transmitted via the backend. The 3629e2fcbf42SPeter Maydell ``logappend`` option controls whether the log file will be truncated 3630e2fcbf42SPeter Maydell or appended to when opened. 3631e2fcbf42SPeter Maydell 3632e2fcbf42SPeter MaydellThe available backends are: 3633e2fcbf42SPeter Maydell 3634e2fcbf42SPeter Maydell``-chardev null,id=id`` 3635e2fcbf42SPeter Maydell A void device. This device will not emit any data, and will drop any 3636e2fcbf42SPeter Maydell data it receives. The null backend does not take any options. 3637e2fcbf42SPeter Maydell 3638bfdc1267SDaniel 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]`` 3639e2fcbf42SPeter Maydell Create a two-way stream socket, which can be either a TCP or a unix 3640e2fcbf42SPeter Maydell socket. A unix socket will be created if ``path`` is specified. 3641e2fcbf42SPeter Maydell Behaviour is undefined if TCP options are specified for a unix 3642e2fcbf42SPeter Maydell socket. 3643e2fcbf42SPeter Maydell 3644bfdc1267SDaniel P. Berrangé ``server=on|off`` specifies that the socket shall be a listening socket. 3645e2fcbf42SPeter Maydell 3646bfdc1267SDaniel P. Berrangé ``wait=on|off`` specifies that QEMU should not block waiting for a client 3647e2fcbf42SPeter Maydell to connect to a listening socket. 3648e2fcbf42SPeter Maydell 3649bfdc1267SDaniel P. Berrangé ``telnet=on|off`` specifies that traffic on the socket should interpret 3650e2fcbf42SPeter Maydell telnet escape sequences. 3651e2fcbf42SPeter Maydell 3652bfdc1267SDaniel P. Berrangé ``websocket=on|off`` specifies that the socket uses WebSocket protocol for 3653e2fcbf42SPeter Maydell communication. 3654e2fcbf42SPeter Maydell 3655e2fcbf42SPeter Maydell ``reconnect`` sets the timeout for reconnecting on non-server 3656e2fcbf42SPeter Maydell sockets when the remote end goes away. qemu will delay this many 3657e2fcbf42SPeter Maydell seconds and then attempt to reconnect. Zero disables reconnecting, 3658e2fcbf42SPeter Maydell and is the default. 3659e2fcbf42SPeter Maydell 3660e2fcbf42SPeter Maydell ``tls-creds`` requests enablement of the TLS protocol for 3661e2fcbf42SPeter Maydell encryption, and specifies the id of the TLS credentials to use for 3662e2fcbf42SPeter Maydell the handshake. The credentials must be previously created with the 3663e2fcbf42SPeter Maydell ``-object tls-creds`` argument. 3664e2fcbf42SPeter Maydell 3665e2fcbf42SPeter Maydell ``tls-auth`` provides the ID of the QAuthZ authorization object 3666e2fcbf42SPeter Maydell against which the client's x509 distinguished name will be 3667e2fcbf42SPeter Maydell validated. This object is only resolved at time of use, so can be 3668e2fcbf42SPeter Maydell deleted and recreated on the fly while the chardev server is active. 3669e2fcbf42SPeter Maydell If missing, it will default to denying access. 3670e2fcbf42SPeter Maydell 3671e2fcbf42SPeter Maydell TCP and unix socket options are given below: 3672e2fcbf42SPeter Maydell 3673a9b1315fSPaolo Bonzini ``TCP options: port=port[,host=host][,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]`` 3674e2fcbf42SPeter Maydell ``host`` for a listening socket specifies the local address to 3675e2fcbf42SPeter Maydell be bound. For a connecting socket species the remote host to 3676e2fcbf42SPeter Maydell connect to. ``host`` is optional for listening sockets. If not 3677e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3678e2fcbf42SPeter Maydell 3679e2fcbf42SPeter Maydell ``port`` for a listening socket specifies the local port to be 3680e2fcbf42SPeter Maydell bound. For a connecting socket specifies the port on the remote 3681e2fcbf42SPeter Maydell host to connect to. ``port`` can be given as either a port 3682e2fcbf42SPeter Maydell number or a service name. ``port`` is required. 3683e2fcbf42SPeter Maydell 3684e2fcbf42SPeter Maydell ``to`` is only relevant to listening sockets. If it is 3685e2fcbf42SPeter Maydell specified, and ``port`` cannot be bound, QEMU will attempt to 3686e2fcbf42SPeter Maydell bind to subsequent ports up to and including ``to`` until it 3687e2fcbf42SPeter Maydell succeeds. ``to`` must be specified as a port number. 3688e2fcbf42SPeter Maydell 3689bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 3690bfdc1267SDaniel P. Berrangé or IPv6 must be used. If neither is specified the socket may 3691bfdc1267SDaniel P. Berrangé use either protocol. 3692e2fcbf42SPeter Maydell 3693a9b1315fSPaolo Bonzini ``nodelay=on|off`` disables the Nagle algorithm. 3694e2fcbf42SPeter Maydell 3695e339273bSxiaoqiang zhao ``unix options: path=path[,abstract=on|off][,tight=on|off]`` 3696e2fcbf42SPeter Maydell ``path`` specifies the local path of the unix socket. ``path`` 3697e2fcbf42SPeter Maydell is required. 3698bfdc1267SDaniel P. Berrangé ``abstract=on|off`` specifies the use of the abstract socket namespace, 3699e339273bSxiaoqiang zhao rather than the filesystem. Optional, defaults to false. 3700bfdc1267SDaniel P. Berrangé ``tight=on|off`` sets the socket length of abstract sockets to their minimum, 3701e339273bSxiaoqiang zhao rather than the full sun_path length. Optional, defaults to true. 3702e2fcbf42SPeter Maydell 3703bfdc1267SDaniel P. Berrangé``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4=on|off][,ipv6=on|off]`` 3704e2fcbf42SPeter Maydell Sends all traffic from the guest to a remote host over UDP. 3705e2fcbf42SPeter Maydell 3706e2fcbf42SPeter Maydell ``host`` specifies the remote host to connect to. If not specified 3707e2fcbf42SPeter Maydell it defaults to ``localhost``. 3708e2fcbf42SPeter Maydell 3709e2fcbf42SPeter Maydell ``port`` specifies the port on the remote host to connect to. 3710e2fcbf42SPeter Maydell ``port`` is required. 3711e2fcbf42SPeter Maydell 3712e2fcbf42SPeter Maydell ``localaddr`` specifies the local address to bind to. If not 3713e2fcbf42SPeter Maydell specified it defaults to ``0.0.0.0``. 3714e2fcbf42SPeter Maydell 3715e2fcbf42SPeter Maydell ``localport`` specifies the local port to bind to. If not specified 3716e2fcbf42SPeter Maydell any available local port will be used. 3717e2fcbf42SPeter Maydell 3718bfdc1267SDaniel P. Berrangé ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 or IPv6 must be used. 3719e2fcbf42SPeter Maydell If neither is specified the device may use either protocol. 3720e2fcbf42SPeter Maydell 3721e2fcbf42SPeter Maydell``-chardev msmouse,id=id`` 3722e2fcbf42SPeter Maydell Forward QEMU's emulated msmouse events to the guest. ``msmouse`` 3723e2fcbf42SPeter Maydell does not take any options. 3724e2fcbf42SPeter Maydell 3725e2fcbf42SPeter Maydell``-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]`` 3726e2fcbf42SPeter Maydell Connect to a QEMU text console. ``vc`` may optionally be given a 3727e2fcbf42SPeter Maydell specific size. 3728e2fcbf42SPeter Maydell 3729e2fcbf42SPeter Maydell ``width`` and ``height`` specify the width and height respectively 3730e2fcbf42SPeter Maydell of the console, in pixels. 3731e2fcbf42SPeter Maydell 3732e2fcbf42SPeter Maydell ``cols`` and ``rows`` specify that the console be sized to fit a 3733e2fcbf42SPeter Maydell text console with the given dimensions. 3734e2fcbf42SPeter Maydell 3735e2fcbf42SPeter Maydell``-chardev ringbuf,id=id[,size=size]`` 3736e2fcbf42SPeter Maydell Create a ring buffer with fixed size ``size``. size must be a power 3737e2fcbf42SPeter Maydell of two and defaults to ``64K``. 3738e2fcbf42SPeter Maydell 37395b18a6bfSPeter Maydell``-chardev file,id=id,path=path[,input-path=input-path]`` 3740e2fcbf42SPeter Maydell Log all traffic received from the guest to a file. 3741e2fcbf42SPeter Maydell 3742e2fcbf42SPeter Maydell ``path`` specifies the path of the file to be opened. This file will 3743e2fcbf42SPeter Maydell be created if it does not already exist, and overwritten if it does. 3744e2fcbf42SPeter Maydell ``path`` is required. 3745e2fcbf42SPeter Maydell 37465b18a6bfSPeter Maydell If ``input-path`` is specified, this is the path of a second file 37475b18a6bfSPeter Maydell which will be used for input. If ``input-path`` is not specified, 37485b18a6bfSPeter Maydell no input will be available from the chardev. 37495b18a6bfSPeter Maydell 37505b18a6bfSPeter Maydell Note that ``input-path`` is not supported on Windows hosts. 37515b18a6bfSPeter Maydell 3752e2fcbf42SPeter Maydell``-chardev pipe,id=id,path=path`` 3753e2fcbf42SPeter Maydell Create a two-way connection to the guest. The behaviour differs 3754e2fcbf42SPeter Maydell slightly between Windows hosts and other hosts: 3755e2fcbf42SPeter Maydell 3756e2fcbf42SPeter Maydell On Windows, a single duplex pipe will be created at 3757e2fcbf42SPeter Maydell ``\\.pipe\path``. 3758e2fcbf42SPeter Maydell 3759e2fcbf42SPeter Maydell On other hosts, 2 pipes will be created called ``path.in`` and 3760e2fcbf42SPeter Maydell ``path.out``. Data written to ``path.in`` will be received by the 3761e2fcbf42SPeter Maydell guest. Data written by the guest can be read from ``path.out``. QEMU 3762e2fcbf42SPeter Maydell will not create these fifos, and requires them to be present. 3763e2fcbf42SPeter Maydell 3764e2fcbf42SPeter Maydell ``path`` forms part of the pipe path as described above. ``path`` is 3765e2fcbf42SPeter Maydell required. 3766e2fcbf42SPeter Maydell 3767e2fcbf42SPeter Maydell``-chardev console,id=id`` 3768e2fcbf42SPeter Maydell Send traffic from the guest to QEMU's standard output. ``console`` 3769e2fcbf42SPeter Maydell does not take any options. 3770e2fcbf42SPeter Maydell 3771e2fcbf42SPeter Maydell ``console`` is only available on Windows hosts. 3772e2fcbf42SPeter Maydell 3773e2fcbf42SPeter Maydell``-chardev serial,id=id,path=path`` 3774e2fcbf42SPeter Maydell Send traffic from the guest to a serial device on the host. 3775e2fcbf42SPeter Maydell 3776e2fcbf42SPeter Maydell On Unix hosts serial will actually accept any tty device, not only 3777e2fcbf42SPeter Maydell serial lines. 3778e2fcbf42SPeter Maydell 3779e2fcbf42SPeter Maydell ``path`` specifies the name of the serial device to open. 3780e2fcbf42SPeter Maydell 3781e2fcbf42SPeter Maydell``-chardev pty,id=id`` 3782e2fcbf42SPeter Maydell Create a new pseudo-terminal on the host and connect to it. ``pty`` 3783e2fcbf42SPeter Maydell does not take any options. 3784e2fcbf42SPeter Maydell 3785e2fcbf42SPeter Maydell ``pty`` is not available on Windows hosts. 3786e2fcbf42SPeter Maydell 3787e2fcbf42SPeter Maydell``-chardev stdio,id=id[,signal=on|off]`` 3788e2fcbf42SPeter Maydell Connect to standard input and standard output of the QEMU process. 3789e2fcbf42SPeter Maydell 3790e2fcbf42SPeter Maydell ``signal`` controls if signals are enabled on the terminal, that 3791e2fcbf42SPeter Maydell includes exiting QEMU with the key sequence Control-c. This option 3792e2fcbf42SPeter Maydell is enabled by default, use ``signal=off`` to disable it. 3793e2fcbf42SPeter Maydell 3794e2fcbf42SPeter Maydell``-chardev braille,id=id`` 3795e2fcbf42SPeter Maydell Connect to a local BrlAPI server. ``braille`` does not take any 3796e2fcbf42SPeter Maydell options. 3797e2fcbf42SPeter Maydell 379809ce5f2dSPeter Maydell``-chardev parallel,id=id,path=path`` 379909ce5f2dSPeter Maydell \ 3800e2fcbf42SPeter Maydell ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD 3801e2fcbf42SPeter Maydell hosts. 3802e2fcbf42SPeter Maydell 3803e2fcbf42SPeter Maydell Connect to a local parallel port. 3804e2fcbf42SPeter Maydell 3805e2fcbf42SPeter Maydell ``path`` specifies the path to the parallel port device. ``path`` is 3806e2fcbf42SPeter Maydell required. 3807e2fcbf42SPeter Maydell 3808e2fcbf42SPeter Maydell``-chardev spicevmc,id=id,debug=debug,name=name`` 3809e2fcbf42SPeter Maydell ``spicevmc`` is only available when spice support is built in. 3810e2fcbf42SPeter Maydell 3811e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3812e2fcbf42SPeter Maydell 3813e2fcbf42SPeter Maydell ``name`` name of spice channel to connect to 3814e2fcbf42SPeter Maydell 3815e2fcbf42SPeter Maydell Connect to a spice virtual machine channel, such as vdiport. 3816e2fcbf42SPeter Maydell 3817e2fcbf42SPeter Maydell``-chardev spiceport,id=id,debug=debug,name=name`` 3818e2fcbf42SPeter Maydell ``spiceport`` is only available when spice support is built in. 3819e2fcbf42SPeter Maydell 3820e2fcbf42SPeter Maydell ``debug`` debug level for spicevmc 3821e2fcbf42SPeter Maydell 3822e2fcbf42SPeter Maydell ``name`` name of spice port to connect to 3823e2fcbf42SPeter Maydell 3824e2fcbf42SPeter Maydell Connect to a spice port, allowing a Spice client to handle the 3825e2fcbf42SPeter Maydell traffic identified by a name (preferably a fqdn). 3826e2fcbf42SPeter MaydellERST 38277273a2dbSMatthew Booth 38287273a2dbSMatthew BoothDEFHEADING() 38297273a2dbSMatthew Booth 3830d1a0cf73SStefan Berger#ifdef CONFIG_TPM 3831de6b4f90SMarkus ArmbrusterDEFHEADING(TPM device options:) 3832d1a0cf73SStefan Berger 3833d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 383492dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 383592dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 383692dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 3837f4ede81eSAmarnath Valluri " not provided it will be searched for in /sys/class/misc/tpm?/device\n" 3838f4ede81eSAmarnath Valluri "-tpmdev emulator,id=id,chardev=dev\n" 3839f4ede81eSAmarnath Valluri " configure the TPM device using chardev backend\n", 3840d1a0cf73SStefan Berger QEMU_ARCH_ALL) 3841e2fcbf42SPeter MaydellSRST 3842e2fcbf42SPeter MaydellThe general form of a TPM device option is: 3843e2fcbf42SPeter Maydell 3844e2fcbf42SPeter Maydell``-tpmdev backend,id=id[,options]`` 3845e2fcbf42SPeter Maydell The specific backend type will determine the applicable options. The 3846e2fcbf42SPeter Maydell ``-tpmdev`` option creates the TPM backend and requires a 3847e2fcbf42SPeter Maydell ``-device`` option that specifies the TPM frontend interface model. 3848e2fcbf42SPeter Maydell 3849e2fcbf42SPeter Maydell Use ``-tpmdev help`` to print all available TPM backend types. 3850e2fcbf42SPeter Maydell 3851e2fcbf42SPeter MaydellThe available backends are: 3852e2fcbf42SPeter Maydell 3853e2fcbf42SPeter Maydell``-tpmdev passthrough,id=id,path=path,cancel-path=cancel-path`` 3854e2fcbf42SPeter Maydell (Linux-host only) Enable access to the host's TPM using the 3855e2fcbf42SPeter Maydell passthrough driver. 3856e2fcbf42SPeter Maydell 3857e2fcbf42SPeter Maydell ``path`` specifies the path to the host's TPM device, i.e., on a 3858e2fcbf42SPeter Maydell Linux host this would be ``/dev/tpm0``. ``path`` is optional and by 3859e2fcbf42SPeter Maydell default ``/dev/tpm0`` is used. 3860e2fcbf42SPeter Maydell 3861e2fcbf42SPeter Maydell ``cancel-path`` specifies the path to the host TPM device's sysfs 3862e2fcbf42SPeter Maydell entry allowing for cancellation of an ongoing TPM command. 3863e2fcbf42SPeter Maydell ``cancel-path`` is optional and by default QEMU will search for the 3864e2fcbf42SPeter Maydell sysfs entry to use. 3865e2fcbf42SPeter Maydell 3866e2fcbf42SPeter Maydell Some notes about using the host's TPM with the passthrough driver: 3867e2fcbf42SPeter Maydell 3868e2fcbf42SPeter Maydell The TPM device accessed by the passthrough driver must not be used 3869e2fcbf42SPeter Maydell by any other application on the host. 3870e2fcbf42SPeter Maydell 3871e2fcbf42SPeter Maydell Since the host's firmware (BIOS/UEFI) has already initialized the 3872e2fcbf42SPeter Maydell TPM, the VM's firmware (BIOS/UEFI) will not be able to initialize 3873e2fcbf42SPeter Maydell the TPM again and may therefore not show a TPM-specific menu that 3874e2fcbf42SPeter Maydell would otherwise allow the user to configure the TPM, e.g., allow the 3875e2fcbf42SPeter Maydell user to enable/disable or activate/deactivate the TPM. Further, if 3876e2fcbf42SPeter Maydell TPM ownership is released from within a VM then the host's TPM will 3877e2fcbf42SPeter Maydell get disabled and deactivated. To enable and activate the TPM again 3878e2fcbf42SPeter Maydell afterwards, the host has to be rebooted and the user is required to 3879e2fcbf42SPeter Maydell enter the firmware's menu to enable and activate the TPM. If the TPM 3880e2fcbf42SPeter Maydell is left disabled and/or deactivated most TPM commands will fail. 3881e2fcbf42SPeter Maydell 3882e2fcbf42SPeter Maydell To create a passthrough TPM use the following two options: 3883e2fcbf42SPeter Maydell 3884e2fcbf42SPeter Maydell :: 3885e2fcbf42SPeter Maydell 3886e2fcbf42SPeter Maydell -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 3887e2fcbf42SPeter Maydell 3888e2fcbf42SPeter Maydell Note that the ``-tpmdev`` id is ``tpm0`` and is referenced by 3889e2fcbf42SPeter Maydell ``tpmdev=tpm0`` in the device option. 3890e2fcbf42SPeter Maydell 3891e2fcbf42SPeter Maydell``-tpmdev emulator,id=id,chardev=dev`` 3892e2fcbf42SPeter Maydell (Linux-host only) Enable access to a TPM emulator using Unix domain 3893e2fcbf42SPeter Maydell socket based chardev backend. 3894e2fcbf42SPeter Maydell 3895e2fcbf42SPeter Maydell ``chardev`` specifies the unique ID of a character device backend 3896e2fcbf42SPeter Maydell that provides connection to the software TPM server. 3897e2fcbf42SPeter Maydell 3898e2fcbf42SPeter Maydell To create a TPM emulator backend device with chardev socket backend: 3899e2fcbf42SPeter Maydell 3900e2fcbf42SPeter Maydell :: 3901e2fcbf42SPeter Maydell 3902e2fcbf42SPeter Maydell -chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0 3903e2fcbf42SPeter MaydellERST 3904d1a0cf73SStefan Berger 3905d1a0cf73SStefan BergerDEFHEADING() 3906d1a0cf73SStefan Berger 3907d1a0cf73SStefan Berger#endif 3908d1a0cf73SStefan Berger 39091235cf7dSAlex BennéeDEFHEADING(Boot Image or Kernel specific:) 3910e2fcbf42SPeter MaydellSRST 39111235cf7dSAlex BennéeThere are broadly 4 ways you can boot a system with QEMU. 3912e2fcbf42SPeter Maydell 39131235cf7dSAlex Bennée - specify a firmware and let it control finding a kernel 39141235cf7dSAlex Bennée - specify a firmware and pass a hint to the kernel to boot 39151235cf7dSAlex Bennée - direct kernel image boot 39161235cf7dSAlex Bennée - manually load files into the guest's address space 39171235cf7dSAlex Bennée 39181235cf7dSAlex BennéeThe third method is useful for quickly testing kernels but as there is 39191235cf7dSAlex Bennéeno firmware to pass configuration information to the kernel the 39201235cf7dSAlex Bennéehardware must either be probeable, the kernel built for the exact 39211235cf7dSAlex Bennéeconfiguration or passed some configuration data (e.g. a DTB blob) 39221235cf7dSAlex Bennéewhich tells the kernel what drivers it needs. This exact details are 39231235cf7dSAlex Bennéeoften hardware specific. 39241235cf7dSAlex Bennée 39251235cf7dSAlex BennéeThe final method is the most generic way of loading images into the 39261235cf7dSAlex Bennéeguest address space and used mostly for ``bare metal`` type 39271235cf7dSAlex Bennéedevelopment where the reset vectors of the processor are taken into 39281235cf7dSAlex Bennéeaccount. 39291235cf7dSAlex Bennée 39301235cf7dSAlex BennéeERST 39311235cf7dSAlex Bennée 39321235cf7dSAlex BennéeSRST 39331235cf7dSAlex Bennée 39341235cf7dSAlex BennéeFor x86 machines and some other architectures ``-bios`` will generally 39351235cf7dSAlex Bennéedo the right thing with whatever it is given. For other machines the 39361235cf7dSAlex Bennéemore strict ``-pflash`` option needs an image that is sized for the 39371235cf7dSAlex Bennéeflash device for the given machine type. 39381235cf7dSAlex Bennée 39391235cf7dSAlex BennéePlease see the :ref:`system-targets-ref` section of the manual for 39401235cf7dSAlex Bennéemore detailed documentation. 39411235cf7dSAlex Bennée 39421235cf7dSAlex BennéeERST 39431235cf7dSAlex Bennée 39441235cf7dSAlex BennéeDEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 39451235cf7dSAlex Bennée "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 39461235cf7dSAlex BennéeSRST 39471235cf7dSAlex Bennée``-bios file`` 39481235cf7dSAlex Bennée Set the filename for the BIOS. 39491235cf7dSAlex BennéeERST 39501235cf7dSAlex Bennée 39511235cf7dSAlex BennéeDEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 39521235cf7dSAlex Bennée "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 39531235cf7dSAlex BennéeSRST 39541235cf7dSAlex Bennée``-pflash file`` 39551235cf7dSAlex Bennée Use file as a parallel flash image. 39561235cf7dSAlex BennéeERST 39571235cf7dSAlex Bennée 39581235cf7dSAlex BennéeSRST 39591235cf7dSAlex Bennée 39601235cf7dSAlex BennéeThe kernel options were designed to work with Linux kernels although 39611235cf7dSAlex Bennéeother things (like hypervisors) can be packaged up as a kernel 39621235cf7dSAlex Bennéeexecutable image. The exact format of a executable image is usually 39631235cf7dSAlex Bennéearchitecture specific. 39641235cf7dSAlex Bennée 39651235cf7dSAlex BennéeThe way in which the kernel is started (what address it is loaded at, 39661235cf7dSAlex Bennéewhat if any information is passed to it via CPU registers, the state 39671235cf7dSAlex Bennéeof the hardware when it is started, and so on) is also architecture 39681235cf7dSAlex Bennéespecific. Typically it follows the specification laid down by the 39691235cf7dSAlex BennéeLinux kernel for how kernels for that architecture must be started. 3970e2fcbf42SPeter Maydell 3971e2fcbf42SPeter MaydellERST 39725824d651Sblueswir1 39735824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 3974ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 3975e2fcbf42SPeter MaydellSRST 3976e2fcbf42SPeter Maydell``-kernel bzImage`` 3977e2fcbf42SPeter Maydell Use bzImage as kernel image. The kernel can be either a Linux kernel 3978e2fcbf42SPeter Maydell or in multiboot format. 3979e2fcbf42SPeter MaydellERST 39805824d651Sblueswir1 39815824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 3982ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 3983e2fcbf42SPeter MaydellSRST 3984e2fcbf42SPeter Maydell``-append cmdline`` 3985e2fcbf42SPeter Maydell Use cmdline as kernel command line 3986e2fcbf42SPeter MaydellERST 39875824d651Sblueswir1 39885824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 3989ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 3990e2fcbf42SPeter MaydellSRST 3991e2fcbf42SPeter Maydell``-initrd file`` 3992e2fcbf42SPeter Maydell Use file as initial ram disk. 3993e2fcbf42SPeter Maydell 3994e2fcbf42SPeter Maydell``-initrd "file1 arg=foo,file2"`` 3995e2fcbf42SPeter Maydell This syntax is only available with multiboot. 3996e2fcbf42SPeter Maydell 3997e2fcbf42SPeter Maydell Use file1 and file2 as modules and pass arg=foo as parameter to the 3998e2fcbf42SPeter Maydell first module. 3999e2fcbf42SPeter MaydellERST 40005824d651Sblueswir1 4001412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 4002379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 4003e2fcbf42SPeter MaydellSRST 4004e2fcbf42SPeter Maydell``-dtb file`` 4005e2fcbf42SPeter Maydell Use file as a device tree binary (dtb) image and pass it to the 4006e2fcbf42SPeter Maydell kernel on boot. 4007e2fcbf42SPeter MaydellERST 4008412beee6SGrant Likely 40091235cf7dSAlex BennéeSRST 40101235cf7dSAlex Bennée 40111235cf7dSAlex BennéeFinally you can also manually load images directly into the address 40121235cf7dSAlex Bennéespace of the guest. This is most useful for developers who already 40131235cf7dSAlex Bennéeknow the layout of their guest and take care to ensure something sane 40141235cf7dSAlex Bennéewill happen when the reset vector executes. 40151235cf7dSAlex Bennée 40161235cf7dSAlex BennéeThe generic loader can be invoked by using the loader device: 40171235cf7dSAlex Bennée 40181235cf7dSAlex Bennée``-device loader,addr=<addr>,data=<data>,data-len=<data-len>[,data-be=<data-be>][,cpu-num=<cpu-num>]`` 40191235cf7dSAlex Bennée 40201235cf7dSAlex Bennéethere is also the guest loader which operates in a similar way but 40211235cf7dSAlex Bennéetweaks the DTB so a hypervisor loaded via ``-kernel`` can find where 40221235cf7dSAlex Bennéethe guest image is: 40231235cf7dSAlex Bennée 40241235cf7dSAlex Bennée``-device guest-loader,addr=<addr>[,kernel=<path>,[bootargs=<arguments>]][,initrd=<path>]`` 40251235cf7dSAlex Bennée 40261235cf7dSAlex BennéeERST 40271235cf7dSAlex Bennée 40285824d651Sblueswir1DEFHEADING() 40295824d651Sblueswir1 4030de6b4f90SMarkus ArmbrusterDEFHEADING(Debug/Expert options:) 40315824d651Sblueswir1 40326dd75472SMarkus ArmbrusterDEF("compat", HAS_ARG, QEMU_OPTION_compat, 4033dbb675c1SMarkus Armbruster "-compat [deprecated-input=accept|reject|crash][,deprecated-output=accept|hide]\n" 403457df0dffSMarkus Armbruster " Policy for handling deprecated management interfaces\n" 403557df0dffSMarkus Armbruster "-compat [unstable-input=accept|reject|crash][,unstable-output=accept|hide]\n" 403657df0dffSMarkus Armbruster " Policy for handling unstable management interfaces\n", 40376dd75472SMarkus Armbruster QEMU_ARCH_ALL) 40386dd75472SMarkus ArmbrusterSRST 40396dd75472SMarkus Armbruster``-compat [deprecated-input=@var{input-policy}][,deprecated-output=@var{output-policy}]`` 40406dd75472SMarkus Armbruster Set policy for handling deprecated management interfaces (experimental): 40416dd75472SMarkus Armbruster 40426dd75472SMarkus Armbruster ``deprecated-input=accept`` (default) 40436dd75472SMarkus Armbruster Accept deprecated commands and arguments 40446dd75472SMarkus Armbruster ``deprecated-input=reject`` 40456dd75472SMarkus Armbruster Reject deprecated commands and arguments 4046dbb675c1SMarkus Armbruster ``deprecated-input=crash`` 4047dbb675c1SMarkus Armbruster Crash on deprecated commands and arguments 40486dd75472SMarkus Armbruster ``deprecated-output=accept`` (default) 40496dd75472SMarkus Armbruster Emit deprecated command results and events 40506dd75472SMarkus Armbruster ``deprecated-output=hide`` 40516dd75472SMarkus Armbruster Suppress deprecated command results and events 40526dd75472SMarkus Armbruster 40536dd75472SMarkus Armbruster Limitation: covers only syntactic aspects of QMP. 405457df0dffSMarkus Armbruster 405557df0dffSMarkus Armbruster``-compat [unstable-input=@var{input-policy}][,unstable-output=@var{output-policy}]`` 405657df0dffSMarkus Armbruster Set policy for handling unstable management interfaces (experimental): 405757df0dffSMarkus Armbruster 405857df0dffSMarkus Armbruster ``unstable-input=accept`` (default) 405957df0dffSMarkus Armbruster Accept unstable commands and arguments 406057df0dffSMarkus Armbruster ``unstable-input=reject`` 406157df0dffSMarkus Armbruster Reject unstable commands and arguments 406257df0dffSMarkus Armbruster ``unstable-input=crash`` 406357df0dffSMarkus Armbruster Crash on unstable commands and arguments 406457df0dffSMarkus Armbruster ``unstable-output=accept`` (default) 406557df0dffSMarkus Armbruster Emit unstable command results and events 406657df0dffSMarkus Armbruster ``unstable-output=hide`` 406757df0dffSMarkus Armbruster Suppress unstable command results and events 406857df0dffSMarkus Armbruster 406957df0dffSMarkus Armbruster Limitation: covers only syntactic aspects of QMP. 40706dd75472SMarkus ArmbrusterERST 40716dd75472SMarkus Armbruster 407281b2b810SGabriel L. SomloDEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 407381b2b810SGabriel L. Somlo "-fw_cfg [name=]<name>,file=<file>\n" 407463d3145aSMarkus Armbruster " add named fw_cfg entry with contents from file\n" 40756407d76eSGabriel L. Somlo "-fw_cfg [name=]<name>,string=<str>\n" 407663d3145aSMarkus Armbruster " add named fw_cfg entry with contents from string\n", 407781b2b810SGabriel L. Somlo QEMU_ARCH_ALL) 4078e2fcbf42SPeter MaydellSRST 4079e2fcbf42SPeter Maydell``-fw_cfg [name=]name,file=file`` 4080e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from file file. 4081e2fcbf42SPeter Maydell 4082e2fcbf42SPeter Maydell``-fw_cfg [name=]name,string=str`` 4083e2fcbf42SPeter Maydell Add named fw\_cfg entry with contents from string str. 4084e2fcbf42SPeter Maydell 4085e2fcbf42SPeter Maydell The terminating NUL character of the contents of str will not be 4086e2fcbf42SPeter Maydell included as part of the fw\_cfg item data. To insert contents with 4087e2fcbf42SPeter Maydell embedded NUL characters, you have to use the file parameter. 4088e2fcbf42SPeter Maydell 4089e2fcbf42SPeter Maydell The fw\_cfg entries are passed by QEMU through to the guest. 4090e2fcbf42SPeter Maydell 4091e2fcbf42SPeter Maydell Example: 4092e2fcbf42SPeter Maydell 4093e2fcbf42SPeter Maydell :: 4094e2fcbf42SPeter Maydell 4095e2fcbf42SPeter Maydell -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 4096e2fcbf42SPeter Maydell 4097e2fcbf42SPeter Maydell creates an fw\_cfg entry named opt/com.mycompany/blob with contents 4098e2fcbf42SPeter Maydell from ./my\_blob.bin. 4099e2fcbf42SPeter MaydellERST 410081b2b810SGabriel L. Somlo 41015824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 4102ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 4103ad96090aSBlue Swirl QEMU_ARCH_ALL) 4104e2fcbf42SPeter MaydellSRST 4105e2fcbf42SPeter Maydell``-serial dev`` 4106e2fcbf42SPeter Maydell Redirect the virtual serial port to host character device dev. The 4107e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 4108e2fcbf42SPeter Maydell graphical mode. 4109e2fcbf42SPeter Maydell 4110e2fcbf42SPeter Maydell This option can be used several times to simulate up to 4 serial 4111e2fcbf42SPeter Maydell ports. 4112e2fcbf42SPeter Maydell 4113e2fcbf42SPeter Maydell Use ``-serial none`` to disable all serial ports. 4114e2fcbf42SPeter Maydell 4115e2fcbf42SPeter Maydell Available character devices are: 4116e2fcbf42SPeter Maydell 4117e2fcbf42SPeter Maydell ``vc[:WxH]`` 4118e2fcbf42SPeter Maydell Virtual console. Optionally, a width and height can be given in 4119e2fcbf42SPeter Maydell pixel with 4120e2fcbf42SPeter Maydell 4121e2fcbf42SPeter Maydell :: 4122e2fcbf42SPeter Maydell 4123e2fcbf42SPeter Maydell vc:800x600 4124e2fcbf42SPeter Maydell 4125e2fcbf42SPeter Maydell It is also possible to specify width or height in characters: 4126e2fcbf42SPeter Maydell 4127e2fcbf42SPeter Maydell :: 4128e2fcbf42SPeter Maydell 4129e2fcbf42SPeter Maydell vc:80Cx24C 4130e2fcbf42SPeter Maydell 4131e2fcbf42SPeter Maydell ``pty`` 4132e2fcbf42SPeter Maydell [Linux only] Pseudo TTY (a new PTY is automatically allocated) 4133e2fcbf42SPeter Maydell 4134e2fcbf42SPeter Maydell ``none`` 4135e2fcbf42SPeter Maydell No device is allocated. 4136e2fcbf42SPeter Maydell 4137e2fcbf42SPeter Maydell ``null`` 4138e2fcbf42SPeter Maydell void device 4139e2fcbf42SPeter Maydell 4140e2fcbf42SPeter Maydell ``chardev:id`` 4141e2fcbf42SPeter Maydell Use a named character device defined with the ``-chardev`` 4142e2fcbf42SPeter Maydell option. 4143e2fcbf42SPeter Maydell 4144e2fcbf42SPeter Maydell ``/dev/XXX`` 4145e2fcbf42SPeter Maydell [Linux only] Use host tty, e.g. ``/dev/ttyS0``. The host serial 4146e2fcbf42SPeter Maydell port parameters are set according to the emulated ones. 4147e2fcbf42SPeter Maydell 4148e2fcbf42SPeter Maydell ``/dev/parportN`` 4149e2fcbf42SPeter Maydell [Linux only, parallel port only] Use host parallel port N. 4150e2fcbf42SPeter Maydell Currently SPP and EPP parallel port features can be used. 4151e2fcbf42SPeter Maydell 4152e2fcbf42SPeter Maydell ``file:filename`` 4153e2fcbf42SPeter Maydell Write output to filename. No character can be read. 4154e2fcbf42SPeter Maydell 4155e2fcbf42SPeter Maydell ``stdio`` 4156e2fcbf42SPeter Maydell [Unix only] standard input/output 4157e2fcbf42SPeter Maydell 4158e2fcbf42SPeter Maydell ``pipe:filename`` 4159e2fcbf42SPeter Maydell name pipe filename 4160e2fcbf42SPeter Maydell 4161e2fcbf42SPeter Maydell ``COMn`` 4162e2fcbf42SPeter Maydell [Windows only] Use host serial port n 4163e2fcbf42SPeter Maydell 4164e2fcbf42SPeter Maydell ``udp:[remote_host]:remote_port[@[src_ip]:src_port]`` 4165e2fcbf42SPeter Maydell This implements UDP Net Console. When remote\_host or src\_ip 4166e2fcbf42SPeter Maydell are not specified they default to ``0.0.0.0``. When not using a 4167e2fcbf42SPeter Maydell specified src\_port a random port is automatically chosen. 4168e2fcbf42SPeter Maydell 4169e2fcbf42SPeter Maydell If you just want a simple readonly console you can use 4170e2fcbf42SPeter Maydell ``netcat`` or ``nc``, by starting QEMU with: 4171e2fcbf42SPeter Maydell ``-serial udp::4555`` and nc as: ``nc -u -l -p 4555``. Any time 4172e2fcbf42SPeter Maydell QEMU writes something to that port it will appear in the 4173e2fcbf42SPeter Maydell netconsole session. 4174e2fcbf42SPeter Maydell 4175e2fcbf42SPeter Maydell If you plan to send characters back via netconsole or you want 4176e2fcbf42SPeter Maydell to stop and start QEMU a lot of times, you should have QEMU use 4177e2fcbf42SPeter Maydell the same source port each time by using something like ``-serial 4178e2fcbf42SPeter Maydell udp::4555@:4556`` to QEMU. Another approach is to use a patched 4179e2fcbf42SPeter Maydell version of netcat which can listen to a TCP port and send and 4180e2fcbf42SPeter Maydell receive characters via udp. If you have a patched version of 4181e2fcbf42SPeter Maydell netcat which activates telnet remote echo and single char 4182e2fcbf42SPeter Maydell transfer, then you can use the following options to set up a 4183e2fcbf42SPeter Maydell netcat redirector to allow telnet on port 5555 to access the 4184e2fcbf42SPeter Maydell QEMU port. 4185e2fcbf42SPeter Maydell 4186e2fcbf42SPeter Maydell ``QEMU Options:`` 4187e2fcbf42SPeter Maydell -serial udp::4555@:4556 4188e2fcbf42SPeter Maydell 4189e2fcbf42SPeter Maydell ``netcat options:`` 4190e2fcbf42SPeter Maydell -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 4191e2fcbf42SPeter Maydell 4192e2fcbf42SPeter Maydell ``telnet options:`` 4193e2fcbf42SPeter Maydell localhost 5555 4194e2fcbf42SPeter Maydell 4195a9b1315fSPaolo Bonzini ``tcp:[host]:port[,server=on|off][,wait=on|off][,nodelay=on|off][,reconnect=seconds]`` 4196e2fcbf42SPeter Maydell The TCP Net Console has two modes of operation. It can send the 4197e2fcbf42SPeter Maydell serial I/O to a location or wait for a connection from a 4198e2fcbf42SPeter Maydell location. By default the TCP Net Console is sent to host at the 4199bfdc1267SDaniel P. Berrangé port. If you use the ``server=on`` option QEMU will wait for a client 4200e2fcbf42SPeter Maydell socket application to connect to the port before continuing, 4201a9b1315fSPaolo Bonzini unless the ``wait=on|off`` option was specified. The ``nodelay=on|off`` 4202bfdc1267SDaniel P. Berrangé option disables the Nagle buffering algorithm. The ``reconnect=on`` 4203bfdc1267SDaniel P. Berrangé option only applies if ``server=no`` is set, if the connection goes 4204e2fcbf42SPeter Maydell down it will attempt to reconnect at the given interval. If host 4205e2fcbf42SPeter Maydell is omitted, 0.0.0.0 is assumed. Only one TCP connection at a 4206bfdc1267SDaniel P. Berrangé time is accepted. You can use ``telnet=on`` to connect to the 4207e2fcbf42SPeter Maydell corresponding character device. 4208e2fcbf42SPeter Maydell 4209e2fcbf42SPeter Maydell ``Example to send tcp console to 192.168.0.2 port 4444`` 4210e2fcbf42SPeter Maydell -serial tcp:192.168.0.2:4444 4211e2fcbf42SPeter Maydell 4212e2fcbf42SPeter Maydell ``Example to listen and wait on port 4444 for connection`` 4213bfdc1267SDaniel P. Berrangé -serial tcp::4444,server=on 4214e2fcbf42SPeter Maydell 4215e2fcbf42SPeter Maydell ``Example to not wait and listen on ip 192.168.0.100 port 4444`` 4216bfdc1267SDaniel P. Berrangé -serial tcp:192.168.0.100:4444,server=on,wait=off 4217e2fcbf42SPeter Maydell 4218a9b1315fSPaolo Bonzini ``telnet:host:port[,server=on|off][,wait=on|off][,nodelay=on|off]`` 4219e2fcbf42SPeter Maydell The telnet protocol is used instead of raw tcp sockets. The 4220e2fcbf42SPeter Maydell options work the same as if you had specified ``-serial tcp``. 4221e2fcbf42SPeter Maydell The difference is that the port acts like a telnet server or 4222e2fcbf42SPeter Maydell client using telnet option negotiation. This will also allow you 4223e2fcbf42SPeter Maydell to send the MAGIC\_SYSRQ sequence if you use a telnet that 4224e2fcbf42SPeter Maydell supports sending the break sequence. Typically in unix telnet 4225e2fcbf42SPeter Maydell you do it with Control-] and then type "send break" followed by 4226e2fcbf42SPeter Maydell pressing the enter key. 4227e2fcbf42SPeter Maydell 4228a9b1315fSPaolo Bonzini ``websocket:host:port,server=on[,wait=on|off][,nodelay=on|off]`` 4229e2fcbf42SPeter Maydell The WebSocket protocol is used instead of raw tcp socket. The 4230e2fcbf42SPeter Maydell port acts as a WebSocket server. Client mode is not supported. 4231e2fcbf42SPeter Maydell 4232bfdc1267SDaniel P. Berrangé ``unix:path[,server=on|off][,wait=on|off][,reconnect=seconds]`` 4233e2fcbf42SPeter Maydell A unix domain socket is used instead of a tcp socket. The option 4234e2fcbf42SPeter Maydell works the same as if you had specified ``-serial tcp`` except 4235e2fcbf42SPeter Maydell the unix domain socket path is used for connections. 4236e2fcbf42SPeter Maydell 4237e2fcbf42SPeter Maydell ``mon:dev_string`` 4238e2fcbf42SPeter Maydell This is a special option to allow the monitor to be multiplexed 4239e2fcbf42SPeter Maydell onto another serial port. The monitor is accessed with key 4240e2fcbf42SPeter Maydell sequence of Control-a and then pressing c. dev\_string should be 4241e2fcbf42SPeter Maydell any one of the serial devices specified above. An example to 4242e2fcbf42SPeter Maydell multiplex the monitor onto a telnet server listening on port 4243e2fcbf42SPeter Maydell 4444 would be: 4244e2fcbf42SPeter Maydell 4245bfdc1267SDaniel P. Berrangé ``-serial mon:telnet::4444,server=on,wait=off`` 4246e2fcbf42SPeter Maydell 4247e2fcbf42SPeter Maydell When the monitor is multiplexed to stdio in this way, Ctrl+C 4248e2fcbf42SPeter Maydell will not terminate QEMU any more but will be passed to the guest 4249e2fcbf42SPeter Maydell instead. 4250e2fcbf42SPeter Maydell 4251e2fcbf42SPeter Maydell ``braille`` 4252e2fcbf42SPeter Maydell Braille device. This will use BrlAPI to display the braille 4253e2fcbf42SPeter Maydell output on a real or fake device. 4254e2fcbf42SPeter Maydell 4255e2fcbf42SPeter Maydell ``msmouse`` 4256e2fcbf42SPeter Maydell Three button serial mouse. Configure the guest to use Microsoft 4257e2fcbf42SPeter Maydell protocol. 4258e2fcbf42SPeter MaydellERST 42595824d651Sblueswir1 42605824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 4261ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 4262ad96090aSBlue Swirl QEMU_ARCH_ALL) 4263e2fcbf42SPeter MaydellSRST 4264e2fcbf42SPeter Maydell``-parallel dev`` 4265e2fcbf42SPeter Maydell Redirect the virtual parallel port to host device dev (same devices 4266e2fcbf42SPeter Maydell as the serial port). On Linux hosts, ``/dev/parportN`` can be used 4267e2fcbf42SPeter Maydell to use hardware devices connected on the corresponding host parallel 4268e2fcbf42SPeter Maydell port. 4269e2fcbf42SPeter Maydell 4270e2fcbf42SPeter Maydell This option can be used several times to simulate up to 3 parallel 4271e2fcbf42SPeter Maydell ports. 4272e2fcbf42SPeter Maydell 4273e2fcbf42SPeter Maydell Use ``-parallel none`` to disable all parallel ports. 4274e2fcbf42SPeter MaydellERST 42755824d651Sblueswir1 42765824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 4277ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 4278ad96090aSBlue Swirl QEMU_ARCH_ALL) 4279e2fcbf42SPeter MaydellSRST 4280e2fcbf42SPeter Maydell``-monitor dev`` 4281e2fcbf42SPeter Maydell Redirect the monitor to host device dev (same devices as the serial 4282e2fcbf42SPeter Maydell port). The default device is ``vc`` in graphical mode and ``stdio`` 4283e2fcbf42SPeter Maydell in non graphical mode. Use ``-monitor none`` to disable the default 4284e2fcbf42SPeter Maydell monitor. 4285e2fcbf42SPeter MaydellERST 42866ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 4287ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 4288ad96090aSBlue Swirl QEMU_ARCH_ALL) 4289e2fcbf42SPeter MaydellSRST 4290e2fcbf42SPeter Maydell``-qmp dev`` 42910ec4468fSPeter Maydell Like ``-monitor`` but opens in 'control' mode. For example, to make 42920ec4468fSPeter Maydell QMP available on localhost port 4444:: 42930ec4468fSPeter Maydell 42940ec4468fSPeter Maydell -qmp tcp:localhost:4444,server=on,wait=off 42950ec4468fSPeter Maydell 42960ec4468fSPeter Maydell Not all options are configurable via this syntax; for maximum 42970ec4468fSPeter Maydell flexibility use the ``-mon`` option and an accompanying ``-chardev``. 42980ec4468fSPeter Maydell 4299e2fcbf42SPeter MaydellERST 43004821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 43014821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 43024821cd4cSMax Reitz QEMU_ARCH_ALL) 4303e2fcbf42SPeter MaydellSRST 4304e2fcbf42SPeter Maydell``-qmp-pretty dev`` 43050ec4468fSPeter Maydell Like ``-qmp`` but uses pretty JSON formatting. 4306e2fcbf42SPeter MaydellERST 43075824d651Sblueswir1 430822a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 4309ef670726SVicente Jimenez Aguilar "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL) 4310e2fcbf42SPeter MaydellSRST 4311e2fcbf42SPeter Maydell``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]`` 43120ec4468fSPeter Maydell Set up a monitor connected to the chardev ``name``. 43130ec4468fSPeter Maydell QEMU supports two monitors: the Human Monitor Protocol 43140ec4468fSPeter Maydell (HMP; for human interaction), and the QEMU Monitor Protocol 43150ec4468fSPeter Maydell (QMP; a JSON RPC-style protocol). 43160ec4468fSPeter Maydell The default is HMP; ``mode=control`` selects QMP instead. 431716b3f3bbSAli Shirvani ``pretty`` is only valid when ``mode=control``, 431816b3f3bbSAli Shirvani turning on JSON pretty printing to ease 4319283d845cSDaniel P. Berrangé human reading and debugging. 43200ec4468fSPeter Maydell 43210ec4468fSPeter Maydell For example:: 43220ec4468fSPeter Maydell 43230ec4468fSPeter Maydell -chardev socket,id=mon1,host=localhost,port=4444,server=on,wait=off \ 43240ec4468fSPeter Maydell -mon chardev=mon1,mode=control,pretty=on 43250ec4468fSPeter Maydell 43260ec4468fSPeter Maydell enables the QMP monitor on localhost port 4444 with pretty-printing. 4327e2fcbf42SPeter MaydellERST 432822a0e04bSGerd Hoffmann 4329c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 4330ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 4331ad96090aSBlue Swirl QEMU_ARCH_ALL) 4332e2fcbf42SPeter MaydellSRST 4333e2fcbf42SPeter Maydell``-debugcon dev`` 4334e2fcbf42SPeter Maydell Redirect the debug console to host device dev (same devices as the 4335e2fcbf42SPeter Maydell serial port). The debug console is an I/O port which is typically 4336e2fcbf42SPeter Maydell port 0xe9; writing to that I/O port sends output to this device. The 4337e2fcbf42SPeter Maydell default device is ``vc`` in graphical mode and ``stdio`` in non 4338e2fcbf42SPeter Maydell graphical mode. 4339e2fcbf42SPeter MaydellERST 4340c9f398e5SH. Peter Anvin 43415824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 4342ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 4343e2fcbf42SPeter MaydellSRST 4344e2fcbf42SPeter Maydell``-pidfile file`` 4345e2fcbf42SPeter Maydell Store the QEMU process PID in file. It is useful if you launch QEMU 4346e2fcbf42SPeter Maydell from a script. 4347e2fcbf42SPeter MaydellERST 43485824d651Sblueswir1 43491b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 435012fd0f41SPeter Maydell "-singlestep deprecated synonym for -accel tcg,one-insn-per-tb=on\n", QEMU_ARCH_ALL) 4351e2fcbf42SPeter MaydellSRST 4352e2fcbf42SPeter Maydell``-singlestep`` 435312fd0f41SPeter Maydell This is a deprecated synonym for the TCG accelerator property 435412fd0f41SPeter Maydell ``one-insn-per-tb``. 4355e2fcbf42SPeter MaydellERST 43561b530a6dSaurel32 4357047f7038SIgor MammedovDEF("preconfig", 0, QEMU_OPTION_preconfig, \ 4358361ac948SMarkus Armbruster "--preconfig pause QEMU before machine is initialized (experimental)\n", 4359047f7038SIgor Mammedov QEMU_ARCH_ALL) 4360e2fcbf42SPeter MaydellSRST 4361e2fcbf42SPeter Maydell``--preconfig`` 4362e2fcbf42SPeter Maydell Pause QEMU for interactive configuration before the machine is 4363e2fcbf42SPeter Maydell created, which allows querying and configuring properties that will 4364e2fcbf42SPeter Maydell affect machine initialization. Use QMP command 'x-exit-preconfig' to 4365e2fcbf42SPeter Maydell exit the preconfig state and move to the next state (i.e. run guest 4366e2fcbf42SPeter Maydell if -S isn't used or pause the second time if -S is used). This 4367e2fcbf42SPeter Maydell option is experimental. 4368e2fcbf42SPeter MaydellERST 4369047f7038SIgor Mammedov 43705824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 4371ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 4372ad96090aSBlue Swirl QEMU_ARCH_ALL) 4373e2fcbf42SPeter MaydellSRST 4374e2fcbf42SPeter Maydell``-S`` 4375e2fcbf42SPeter Maydell Do not start CPU at startup (you must type 'c' in the monitor). 4376e2fcbf42SPeter MaydellERST 43775824d651Sblueswir1 43786f131f13SMichael S. TsirkinDEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit, 4379dfaa7d50SBALATON Zoltan "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n" 43806f131f13SMichael S. Tsirkin " run qemu with overcommit hints\n" 43816f131f13SMichael S. Tsirkin " mem-lock=on|off controls memory lock support (default: off)\n" 43826f131f13SMichael S. Tsirkin " cpu-pm=on|off controls cpu power management (default: off)\n", 43836f131f13SMichael S. Tsirkin QEMU_ARCH_ALL) 4384e2fcbf42SPeter MaydellSRST 4385e2fcbf42SPeter Maydell``-overcommit mem-lock=on|off`` 438609ce5f2dSPeter Maydell \ 4387e2fcbf42SPeter Maydell``-overcommit cpu-pm=on|off`` 4388e2fcbf42SPeter Maydell Run qemu with hints about host resource overcommit. The default is 4389e2fcbf42SPeter Maydell to assume that host overcommits all resources. 4390e2fcbf42SPeter Maydell 4391e2fcbf42SPeter Maydell Locking qemu and guest memory can be enabled via ``mem-lock=on`` 4392e2fcbf42SPeter Maydell (disabled by default). This works when host memory is not 4393c8c9dc42SThomas Huth overcommitted and reduces the worst-case latency for guest. 4394e2fcbf42SPeter Maydell 4395e2fcbf42SPeter Maydell Guest ability to manage power state of host cpus (increasing latency 4396e2fcbf42SPeter Maydell for other processes on the same host cpu, but decreasing latency for 4397e2fcbf42SPeter Maydell guest) can be enabled via ``cpu-pm=on`` (disabled by default). This 4398e2fcbf42SPeter Maydell works best when host CPU is not overcommitted. When used, host 4399e2fcbf42SPeter Maydell estimates of CPU cycle and power utilization will be incorrect, not 4400e2fcbf42SPeter Maydell taking into account guest idle time. 4401e2fcbf42SPeter MaydellERST 44026f131f13SMichael S. Tsirkin 440359030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 4404e5910d42SPeter Maydell "-gdb dev accept gdb connection on 'dev'. (QEMU defaults to starting\n" 4405e5910d42SPeter Maydell " the guest without waiting for gdb to connect; use -S too\n" 4406e5910d42SPeter Maydell " if you want it to not start execution.)\n", 4407e5910d42SPeter Maydell QEMU_ARCH_ALL) 4408e2fcbf42SPeter MaydellSRST 4409e2fcbf42SPeter Maydell``-gdb dev`` 4410923e9311SThomas Huth Accept a gdb connection on device dev (see the :ref:`GDB usage` chapter 4411923e9311SThomas Huth in the System Emulation Users Guide). Note that this option does not pause QEMU 4412e5910d42SPeter Maydell execution -- if you want QEMU to not start the guest until you 4413e5910d42SPeter Maydell connect with gdb and issue a ``continue`` command, you will need to 4414e5910d42SPeter Maydell also pass the ``-S`` option to QEMU. 4415e5910d42SPeter Maydell 4416e5910d42SPeter Maydell The most usual configuration is to listen on a local TCP socket:: 4417e5910d42SPeter Maydell 4418e5910d42SPeter Maydell -gdb tcp::3117 4419e5910d42SPeter Maydell 4420e5910d42SPeter Maydell but you can specify other backends; UDP, pseudo TTY, or even stdio 4421e5910d42SPeter Maydell are all reasonable use cases. For example, a stdio connection 4422e5910d42SPeter Maydell allows you to start QEMU from within gdb and establish the 4423e5910d42SPeter Maydell connection via a pipe: 4424e2fcbf42SPeter Maydell 442509ce5f2dSPeter Maydell .. parsed-literal:: 4426e2fcbf42SPeter Maydell 4427e2fcbf42SPeter Maydell (gdb) target remote | exec |qemu_system| -gdb stdio ... 4428e2fcbf42SPeter MaydellERST 44295824d651Sblueswir1 443059030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 4431ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 4432ad96090aSBlue Swirl QEMU_ARCH_ALL) 4433e2fcbf42SPeter MaydellSRST 4434e2fcbf42SPeter Maydell``-s`` 4435e2fcbf42SPeter Maydell Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 4436923e9311SThomas Huth (see the :ref:`GDB usage` chapter in the System Emulation Users Guide). 4437e2fcbf42SPeter MaydellERST 44385824d651Sblueswir1 44395824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 4440989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 4441ad96090aSBlue Swirl QEMU_ARCH_ALL) 4442e2fcbf42SPeter MaydellSRST 4443e2fcbf42SPeter Maydell``-d item1[,...]`` 4444e2fcbf42SPeter Maydell Enable logging of specified items. Use '-d help' for a list of log 4445e2fcbf42SPeter Maydell items. 4446e2fcbf42SPeter MaydellERST 44475824d651Sblueswir1 4448c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 4449989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 4450c235d738SMatthew Fernandez QEMU_ARCH_ALL) 4451e2fcbf42SPeter MaydellSRST 4452e2fcbf42SPeter Maydell``-D logfile`` 4453e2fcbf42SPeter Maydell Output log in logfile instead of to stderr 4454e2fcbf42SPeter MaydellERST 4455c235d738SMatthew Fernandez 44563514552eSAlex BennéeDEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 44573514552eSAlex Bennée "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 44583514552eSAlex Bennée QEMU_ARCH_ALL) 4459e2fcbf42SPeter MaydellSRST 4460e2fcbf42SPeter Maydell``-dfilter range1[,...]`` 4461e2fcbf42SPeter Maydell Filter debug output to that relevant to a range of target addresses. 4462e2fcbf42SPeter Maydell The filter spec can be either start+size, start-size or start..end 4463e2fcbf42SPeter Maydell where start end and size are the addresses and sizes required. For 4464e2fcbf42SPeter Maydell example: 4465e2fcbf42SPeter Maydell 4466e2fcbf42SPeter Maydell :: 4467e2fcbf42SPeter Maydell 4468e2fcbf42SPeter Maydell -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 4469e2fcbf42SPeter Maydell 4470e2fcbf42SPeter Maydell Will dump output for any code in the 0x1000 sized block starting at 4471e2fcbf42SPeter Maydell 0x8000 and the 0x200 sized block starting at 0xffffffc000080000 and 4472e2fcbf42SPeter Maydell another 0x1000 sized block starting at 0xffffffc00005f000. 4473e2fcbf42SPeter MaydellERST 44743514552eSAlex Bennée 44759c09a251SRichard HendersonDEF("seed", HAS_ARG, QEMU_OPTION_seed, \ 44769c09a251SRichard Henderson "-seed number seed the pseudo-random number generator\n", 44779c09a251SRichard Henderson QEMU_ARCH_ALL) 4478e2fcbf42SPeter MaydellSRST 4479e2fcbf42SPeter Maydell``-seed number`` 4480e2fcbf42SPeter Maydell Force the guest to use a deterministic pseudo-random number 4481e2fcbf42SPeter Maydell generator, seeded with number. This does not affect crypto routines 4482e2fcbf42SPeter Maydell within the host. 4483e2fcbf42SPeter MaydellERST 44849c09a251SRichard Henderson 44855824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 4486ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 4487ad96090aSBlue Swirl QEMU_ARCH_ALL) 4488e2fcbf42SPeter MaydellSRST 4489e2fcbf42SPeter Maydell``-L path`` 4490e2fcbf42SPeter Maydell Set the directory for the BIOS, VGA BIOS and keymaps. 4491e2fcbf42SPeter Maydell 4492e2fcbf42SPeter Maydell To list all the data directories, use ``-L help``. 4493e2fcbf42SPeter MaydellERST 44945824d651Sblueswir1 44955824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 449621abf010SThomas Huth "-enable-kvm enable KVM full virtualization support\n", 449721abf010SThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386 | QEMU_ARCH_MIPS | QEMU_ARCH_PPC | 449821abf010SThomas Huth QEMU_ARCH_RISCV | QEMU_ARCH_S390X) 4499e2fcbf42SPeter MaydellSRST 4500e2fcbf42SPeter Maydell``-enable-kvm`` 4501e2fcbf42SPeter Maydell Enable KVM full virtualization support. This option is only 4502e2fcbf42SPeter Maydell available if KVM support is enabled when compiling. 4503e2fcbf42SPeter MaydellERST 45045824d651Sblueswir1 4505e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 4506eeb3647cSThomas Huth "-xen-domid id specify xen guest domain id\n", 4507eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 4508e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 4509e37630caSaliguori "-xen-attach attach to existing xen domain\n" 45101077bcacSAnthony PERARD " libxl will use this when starting QEMU\n", 4511eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 45121c599472SPaul DurrantDEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict, 45131c599472SPaul Durrant "-xen-domid-restrict restrict set of available xen operations\n" 45141c599472SPaul Durrant " to specified domain id. (Does not affect\n" 45151c599472SPaul Durrant " xenpv machine type).\n", 4516eeb3647cSThomas Huth QEMU_ARCH_ARM | QEMU_ARCH_I386) 4517e2fcbf42SPeter MaydellSRST 4518e2fcbf42SPeter Maydell``-xen-domid id`` 4519e2fcbf42SPeter Maydell Specify xen guest domain id (XEN only). 4520e2fcbf42SPeter Maydell 4521e2fcbf42SPeter Maydell``-xen-attach`` 4522e2fcbf42SPeter Maydell Attach to existing xen domain. libxl will use this when starting 4523e2fcbf42SPeter Maydell QEMU (XEN only). Restrict set of available xen operations to 4524e2fcbf42SPeter Maydell specified domain id (XEN only). 4525e2fcbf42SPeter MaydellERST 4526e37630caSaliguori 45275824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 4528ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 4529e2fcbf42SPeter MaydellSRST 4530e2fcbf42SPeter Maydell``-no-reboot`` 4531e2fcbf42SPeter Maydell Exit instead of rebooting. 4532e2fcbf42SPeter MaydellERST 45335824d651Sblueswir1 45345824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 4535ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 4536e2fcbf42SPeter MaydellSRST 4537e2fcbf42SPeter Maydell``-no-shutdown`` 4538e2fcbf42SPeter Maydell Don't exit QEMU on guest shutdown, but instead only stop the 4539e2fcbf42SPeter Maydell emulation. This allows for instance switching to monitor to commit 4540e2fcbf42SPeter Maydell changes to the disk image. 4541e2fcbf42SPeter MaydellERST 45425824d651Sblueswir1 45432a5ad60bSAlejandro JimenezDEF("action", HAS_ARG, QEMU_OPTION_action, 4544c27025e0SPaolo Bonzini "-action reboot=reset|shutdown\n" 4545c27025e0SPaolo Bonzini " action when guest reboots [default=reset]\n" 45462a5ad60bSAlejandro Jimenez "-action shutdown=poweroff|pause\n" 45472a5ad60bSAlejandro Jimenez " action when guest shuts down [default=poweroff]\n" 45480882caf4SIlya Leoshkevich "-action panic=pause|shutdown|exit-failure|none\n" 4549c27025e0SPaolo Bonzini " action when guest panics [default=shutdown]\n" 45502a5ad60bSAlejandro Jimenez "-action watchdog=reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" 45512a5ad60bSAlejandro Jimenez " action when watchdog fires [default=reset]\n", 45522a5ad60bSAlejandro Jimenez QEMU_ARCH_ALL) 45532a5ad60bSAlejandro JimenezSRST 45542a5ad60bSAlejandro Jimenez``-action event=action`` 45552a5ad60bSAlejandro Jimenez The action parameter serves to modify QEMU's default behavior when 45562a5ad60bSAlejandro Jimenez certain guest events occur. It provides a generic method for specifying the 45572a5ad60bSAlejandro Jimenez same behaviors that are modified by the ``-no-reboot`` and ``-no-shutdown`` 45582a5ad60bSAlejandro Jimenez parameters. 45592a5ad60bSAlejandro Jimenez 45602a5ad60bSAlejandro Jimenez Examples: 45612a5ad60bSAlejandro Jimenez 4562c753e8e7SAlejandro Jimenez ``-action panic=none`` 45632a5ad60bSAlejandro Jimenez ``-action reboot=shutdown,shutdown=pause`` 45645433af76SPaolo Bonzini ``-device i6300esb -action watchdog=pause`` 45652a5ad60bSAlejandro Jimenez 45662a5ad60bSAlejandro JimenezERST 45672a5ad60bSAlejandro Jimenez 45685824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 45695824d651Sblueswir1 "-loadvm [tag|id]\n" \ 4570ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 4571ad96090aSBlue Swirl QEMU_ARCH_ALL) 4572e2fcbf42SPeter MaydellSRST 4573e2fcbf42SPeter Maydell``-loadvm file`` 4574e2fcbf42SPeter Maydell Start right away with a saved state (``loadvm`` in monitor) 4575e2fcbf42SPeter MaydellERST 45765824d651Sblueswir1 45775824d651Sblueswir1#ifndef _WIN32 45785824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 4579ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 45805824d651Sblueswir1#endif 4581e2fcbf42SPeter MaydellSRST 4582e2fcbf42SPeter Maydell``-daemonize`` 4583e2fcbf42SPeter Maydell Daemonize the QEMU process after initialization. QEMU will not 4584e2fcbf42SPeter Maydell detach from standard IO until it is ready to receive connections on 4585e2fcbf42SPeter Maydell any of its devices. This option is a useful way for external 4586e2fcbf42SPeter Maydell programs to launch QEMU without having to cope with initialization 4587e2fcbf42SPeter Maydell race conditions. 4588e2fcbf42SPeter MaydellERST 45895824d651Sblueswir1 45905824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 4591ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 4592ad96090aSBlue Swirl QEMU_ARCH_ALL) 4593e2fcbf42SPeter MaydellSRST 4594e2fcbf42SPeter Maydell``-option-rom file`` 4595e2fcbf42SPeter Maydell Load the contents of file as an option ROM. This option is useful to 4596e2fcbf42SPeter Maydell load things like EtherBoot. 4597e2fcbf42SPeter MaydellERST 45985824d651Sblueswir1 45991ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 4600238d1240SArtem Pisarenko "-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 4601ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 4602ad96090aSBlue Swirl QEMU_ARCH_ALL) 46031ed2fc1fSJan Kiszka 4604e2fcbf42SPeter MaydellSRST 4605e2fcbf42SPeter Maydell``-rtc [base=utc|localtime|datetime][,clock=host|rt|vm][,driftfix=none|slew]`` 4606e2fcbf42SPeter Maydell Specify ``base`` as ``utc`` or ``localtime`` to let the RTC start at 4607e2fcbf42SPeter Maydell the current UTC or local time, respectively. ``localtime`` is 4608e2fcbf42SPeter Maydell required for correct date in MS-DOS or Windows. To start at a 4609e2fcbf42SPeter Maydell specific point in time, provide datetime in the format 4610e2fcbf42SPeter Maydell ``2006-06-17T16:01:21`` or ``2006-06-17``. The default base is UTC. 4611e2fcbf42SPeter Maydell 4612e2fcbf42SPeter Maydell By default the RTC is driven by the host system time. This allows 4613e2fcbf42SPeter Maydell using of the RTC as accurate reference clock inside the guest, 4614e2fcbf42SPeter Maydell specifically if the host time is smoothly following an accurate 4615e2fcbf42SPeter Maydell external reference clock, e.g. via NTP. If you want to isolate the 4616e2fcbf42SPeter Maydell guest time from the host, you can set ``clock`` to ``rt`` instead, 4617e2fcbf42SPeter Maydell which provides a host monotonic clock if host support it. To even 4618e2fcbf42SPeter Maydell prevent the RTC from progressing during suspension, you can set 4619e2fcbf42SPeter Maydell ``clock`` to ``vm`` (virtual clock). '\ ``clock=vm``\ ' is 4620e2fcbf42SPeter Maydell recommended especially in icount mode in order to preserve 4621e2fcbf42SPeter Maydell determinism; however, note that in icount mode the speed of the 4622e2fcbf42SPeter Maydell virtual clock is variable and can in general differ from the host 4623e2fcbf42SPeter Maydell clock. 4624e2fcbf42SPeter Maydell 4625e2fcbf42SPeter Maydell Enable ``driftfix`` (i386 targets only) if you experience time drift 4626e2fcbf42SPeter Maydell problems, specifically with Windows' ACPI HAL. This option will try 4627e2fcbf42SPeter Maydell to figure out how many timer interrupts were not processed by the 4628e2fcbf42SPeter Maydell Windows guest and will re-inject them. 4629e2fcbf42SPeter MaydellERST 46305824d651Sblueswir1 46315824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 4632fa647905SPeter Maydell "-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=<filename>[,rrsnapshot=<snapshot>]]\n" \ 4633bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 4634f1f4b57eSVictor CLEMENT " instruction, enable aligning the host and virtual clocks\n" \ 4635fa647905SPeter Maydell " or disable real time cpu sleeping, and optionally enable\n" \ 4636fa647905SPeter Maydell " record-and-replay mode\n", QEMU_ARCH_ALL) 4637e2fcbf42SPeter MaydellSRST 4638fa647905SPeter Maydell``-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=filename[,rrsnapshot=snapshot]]`` 4639e2fcbf42SPeter Maydell Enable virtual instruction counter. The virtual cpu will execute one 4640e2fcbf42SPeter Maydell instruction every 2^N ns of virtual time. If ``auto`` is specified 4641e2fcbf42SPeter Maydell then the virtual cpu speed will be automatically adjusted to keep 4642e2fcbf42SPeter Maydell virtual time within a few seconds of real time. 4643e2fcbf42SPeter Maydell 4644e2fcbf42SPeter Maydell Note that while this option can give deterministic behavior, it does 4645e2fcbf42SPeter Maydell not provide cycle accurate emulation. Modern CPUs contain 4646e2fcbf42SPeter Maydell superscalar out of order cores with complex cache hierarchies. The 4647e2fcbf42SPeter Maydell number of instructions executed often has little or no correlation 4648e2fcbf42SPeter Maydell with actual performance. 4649e2fcbf42SPeter Maydell 4650fa647905SPeter Maydell When the virtual cpu is sleeping, the virtual time will advance at 4651fa647905SPeter Maydell default speed unless ``sleep=on`` is specified. With 4652fa647905SPeter Maydell ``sleep=on``, the virtual time will jump to the next timer 4653fa647905SPeter Maydell deadline instantly whenever the virtual cpu goes to sleep mode and 4654fa647905SPeter Maydell will not advance if no timer is enabled. This behavior gives 4655fa647905SPeter Maydell deterministic execution times from the guest point of view. 4656fa647905SPeter Maydell The default if icount is enabled is ``sleep=off``. 4657fa647905SPeter Maydell ``sleep=on`` cannot be used together with either ``shift=auto`` 4658fa647905SPeter Maydell or ``align=on``. 4659fa647905SPeter Maydell 4660e2fcbf42SPeter Maydell ``align=on`` will activate the delay algorithm which will try to 4661e2fcbf42SPeter Maydell synchronise the host clock and the virtual clock. The goal is to 4662e2fcbf42SPeter Maydell have a guest running at the real frequency imposed by the shift 4663e2fcbf42SPeter Maydell option. Whenever the guest clock is behind the host clock and if 4664e2fcbf42SPeter Maydell ``align=on`` is specified then we print a message to the user to 4665e2fcbf42SPeter Maydell inform about the delay. Currently this option does not work when 4666e2fcbf42SPeter Maydell ``shift`` is ``auto``. Note: The sync algorithm will work for those 4667e2fcbf42SPeter Maydell shift values for which the guest clock runs ahead of the host clock. 4668e2fcbf42SPeter Maydell Typically this happens when the shift value is high (how high 4669fa647905SPeter Maydell depends on the host machine). The default if icount is enabled 4670fa647905SPeter Maydell is ``align=off``. 4671e2fcbf42SPeter Maydell 4672fa647905SPeter Maydell When the ``rr`` option is specified deterministic record/replay is 4673fa647905SPeter Maydell enabled. The ``rrfile=`` option must also be provided to 4674fa647905SPeter Maydell specify the path to the replay log. In record mode data is written 4675fa647905SPeter Maydell to this file, and in replay mode it is read back. 4676fa647905SPeter Maydell If the ``rrsnapshot`` option is given then it specifies a VM snapshot 4677fa647905SPeter Maydell name. In record mode, a new VM snapshot with the given name is created 4678fa647905SPeter Maydell at the start of execution recording. In replay mode this option 4679fa647905SPeter Maydell specifies the snapshot name used to load the initial VM state. 4680e2fcbf42SPeter MaydellERST 46815824d651Sblueswir1 46829dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 46837ad9270eSMarkus Armbruster "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \ 4684ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 4685ad96090aSBlue Swirl QEMU_ARCH_ALL) 4686e2fcbf42SPeter MaydellSRST 4687e2fcbf42SPeter Maydell``-watchdog-action action`` 4688e2fcbf42SPeter Maydell The action controls what QEMU will do when the watchdog timer 4689e2fcbf42SPeter Maydell expires. The default is ``reset`` (forcefully reset the guest). 4690e2fcbf42SPeter Maydell Other possible actions are: ``shutdown`` (attempt to gracefully 4691e2fcbf42SPeter Maydell shutdown the guest), ``poweroff`` (forcefully poweroff the guest), 4692e2fcbf42SPeter Maydell ``inject-nmi`` (inject a NMI into the guest), ``pause`` (pause the 4693e2fcbf42SPeter Maydell guest), ``debug`` (print a debug message and continue), or ``none`` 4694e2fcbf42SPeter Maydell (do nothing). 4695e2fcbf42SPeter Maydell 4696e2fcbf42SPeter Maydell Note that the ``shutdown`` action requires that the guest responds 4697e2fcbf42SPeter Maydell to ACPI signals, which it may not be able to do in the sort of 4698e2fcbf42SPeter Maydell situations where the watchdog would have expired, and thus 4699e2fcbf42SPeter Maydell ``-watchdog-action shutdown`` is not recommended for production use. 4700e2fcbf42SPeter Maydell 4701e2fcbf42SPeter Maydell Examples: 4702e2fcbf42SPeter Maydell 47035433af76SPaolo Bonzini ``-device i6300esb -watchdog-action pause`` 4704e2fcbf42SPeter Maydell 4705e2fcbf42SPeter MaydellERST 47069dd986ccSRichard W.M. Jones 47075824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 4708ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 4709ad96090aSBlue Swirl QEMU_ARCH_ALL) 4710e2fcbf42SPeter MaydellSRST 4711e2fcbf42SPeter Maydell``-echr numeric_ascii_value`` 4712e2fcbf42SPeter Maydell Change the escape character used for switching to the monitor when 4713e2fcbf42SPeter Maydell using monitor and serial sharing. The default is ``0x01`` when using 4714e2fcbf42SPeter Maydell the ``-nographic`` option. ``0x01`` is equal to pressing 4715e2fcbf42SPeter Maydell ``Control-a``. You can select a different character from the ascii 4716e2fcbf42SPeter Maydell control keys where 1 through 26 map to Control-a through Control-z. 4717e2fcbf42SPeter Maydell For instance you could use the either of the following to change the 4718e2fcbf42SPeter Maydell escape character to Control-t. 4719e2fcbf42SPeter Maydell 4720e2fcbf42SPeter Maydell ``-echr 0x14``; \ ``-echr 20`` 4721e2fcbf42SPeter Maydell 4722e2fcbf42SPeter MaydellERST 47235824d651Sblueswir1 47245824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 4725bf24095fSDaniel P. Berrangé "-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]\n" \ 4726bf24095fSDaniel P. Berrangé "-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]\n" \ 47277c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 47287c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 47297c601803SMichael Tokarev " specified protocol and socket address\n" \ 47307c601803SMichael Tokarev "-incoming fd:fd\n" \ 4731385f510dSSteve Sistare "-incoming file:filename[,offset=offset]\n" \ 47327c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 47337c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 47341597051bSDr. David Alan Gilbert " or from given external command\n" \ 47351597051bSDr. David Alan Gilbert "-incoming defer\n" \ 47361597051bSDr. David Alan Gilbert " wait for the URI to be specified via migrate_incoming\n", 4737ad96090aSBlue Swirl QEMU_ARCH_ALL) 4738e2fcbf42SPeter MaydellSRST 4739bf24095fSDaniel P. Berrangé``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]`` 474009ce5f2dSPeter Maydell \ 4741bf24095fSDaniel P. Berrangé``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]`` 4742e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given tcp port. 4743e2fcbf42SPeter Maydell 4744e2fcbf42SPeter Maydell``-incoming unix:socketpath`` 4745e2fcbf42SPeter Maydell Prepare for incoming migration, listen on a given unix socket. 4746e2fcbf42SPeter Maydell 4747e2fcbf42SPeter Maydell``-incoming fd:fd`` 4748e2fcbf42SPeter Maydell Accept incoming migration from a given file descriptor. 4749e2fcbf42SPeter Maydell 4750385f510dSSteve Sistare``-incoming file:filename[,offset=offset]`` 4751385f510dSSteve Sistare Accept incoming migration from a given file starting at offset. 4752385f510dSSteve Sistare offset allows the common size suffixes, or a 0x prefix, but not both. 47532a9e2e59SSteve Sistare 4754e2fcbf42SPeter Maydell``-incoming exec:cmdline`` 4755e2fcbf42SPeter Maydell Accept incoming migration as an output from specified external 4756e2fcbf42SPeter Maydell command. 4757e2fcbf42SPeter Maydell 4758e2fcbf42SPeter Maydell``-incoming defer`` 4759e2fcbf42SPeter Maydell Wait for the URI to be specified via migrate\_incoming. The monitor 4760e2fcbf42SPeter Maydell can be used to change settings (such as migration parameters) prior 4761e2fcbf42SPeter Maydell to issuing the migrate\_incoming to allow the migration to begin. 4762e2fcbf42SPeter MaydellERST 47635824d651Sblueswir1 4764d15c05fcSAshijeet AcharyaDEF("only-migratable", 0, QEMU_OPTION_only_migratable, \ 4765d15c05fcSAshijeet Acharya "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL) 4766e2fcbf42SPeter MaydellSRST 4767e2fcbf42SPeter Maydell``-only-migratable`` 4768e2fcbf42SPeter Maydell Only allow migratable devices. Devices will not be allowed to enter 4769e2fcbf42SPeter Maydell an unmigratable state. 4770e2fcbf42SPeter MaydellERST 4771d15c05fcSAshijeet Acharya 4772d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 4773ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 4774e2fcbf42SPeter MaydellSRST 4775e2fcbf42SPeter Maydell``-nodefaults`` 4776e2fcbf42SPeter Maydell Don't create default devices. Normally, QEMU sets the default 4777e2fcbf42SPeter Maydell devices like serial port, parallel port, virtual console, monitor 4778e2fcbf42SPeter Maydell device, VGA adapter, floppy and CD-ROM drive and others. The 4779e2fcbf42SPeter Maydell ``-nodefaults`` option will disable all those default devices. 4780e2fcbf42SPeter MaydellERST 4781d8c208ddSGerd Hoffmann 47825824d651Sblueswir1#ifndef _WIN32 47835824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 47849ffcbe2aSThomas Huth "-chroot dir chroot to dir just before starting the VM (deprecated)\n", 4785ad96090aSBlue Swirl QEMU_ARCH_ALL) 47865824d651Sblueswir1#endif 4787e2fcbf42SPeter MaydellSRST 4788e2fcbf42SPeter Maydell``-chroot dir`` 47899ffcbe2aSThomas Huth Deprecated, use '-run-with chroot=...' instead. 4790e2fcbf42SPeter Maydell Immediately before starting guest execution, chroot to the specified 4791e2fcbf42SPeter Maydell directory. Especially useful in combination with -runas. 4792e2fcbf42SPeter MaydellERST 47935824d651Sblueswir1 47945824d651Sblueswir1#ifndef _WIN32 47955824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 47962c42f1e8SIan Jackson "-runas user change to user id user just before starting the VM\n" \ 47972c42f1e8SIan Jackson " user can be numeric uid:gid instead\n", 4798ad96090aSBlue Swirl QEMU_ARCH_ALL) 47995824d651Sblueswir1#endif 4800e2fcbf42SPeter MaydellSRST 4801e2fcbf42SPeter Maydell``-runas user`` 4802e2fcbf42SPeter Maydell Immediately before starting guest execution, drop root privileges, 4803e2fcbf42SPeter Maydell switching to the specified user. 4804e2fcbf42SPeter MaydellERST 48055824d651Sblueswir1 48065824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 48075824d651Sblueswir1 "-prom-env variable=value\n" 4808ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 4809ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 4810e2fcbf42SPeter MaydellSRST 4811e2fcbf42SPeter Maydell``-prom-env variable=value`` 4812e2fcbf42SPeter Maydell Set OpenBIOS nvram variable to given value (PPC, SPARC only). 4813e2fcbf42SPeter Maydell 4814e2fcbf42SPeter Maydell :: 4815e2fcbf42SPeter Maydell 4816e2fcbf42SPeter Maydell qemu-system-sparc -prom-env 'auto-boot?=false' \ 4817e2fcbf42SPeter Maydell -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single' 4818e2fcbf42SPeter Maydell 4819e2fcbf42SPeter Maydell :: 4820e2fcbf42SPeter Maydell 4821e2fcbf42SPeter Maydell qemu-system-ppc -prom-env 'auto-boot?=false' \ 4822e2fcbf42SPeter Maydell -prom-env 'boot-device=hd:2,\yaboot' \ 4823e2fcbf42SPeter Maydell -prom-env 'boot-args=conf=hd:2,\yaboot.conf' 4824e2fcbf42SPeter MaydellERST 48255824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 4826f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 48279d49bcf6SMarkus Armbruster QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | 4828a10b9d93SKeith Packard QEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4829e2fcbf42SPeter MaydellSRST 4830e2fcbf42SPeter Maydell``-semihosting`` 48312da9d213SAlex Bennée Enable :ref:`Semihosting` mode (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V only). 4832e2fcbf42SPeter Maydell 48332da9d213SAlex Bennée .. warning:: 4834e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4835e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4836e2fcbf42SPeter Maydell 4837e2fcbf42SPeter Maydell See the -semihosting-config option documentation for further 4838e2fcbf42SPeter Maydell information about the facilities this enables. 4839e2fcbf42SPeter MaydellERST 4840a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 48415202861bSPeter Maydell "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,userspace=on|off][,arg=str[,...]]\n" \ 4842a59d31a1SLeon Alrae " semihosting configuration\n", 48439d49bcf6SMarkus ArmbrusterQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | 4844a10b9d93SKeith PackardQEMU_ARCH_MIPS | QEMU_ARCH_NIOS2 | QEMU_ARCH_RISCV) 4845e2fcbf42SPeter MaydellSRST 48465202861bSPeter Maydell``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,userspace=on|off][,arg=str[,...]]`` 48472da9d213SAlex Bennée Enable and configure :ref:`Semihosting` (ARM, M68K, Xtensa, MIPS, Nios II, RISC-V 4848e2fcbf42SPeter Maydell only). 4849e2fcbf42SPeter Maydell 48502da9d213SAlex Bennée .. warning:: 4851e2fcbf42SPeter Maydell Note that this allows guest direct access to the host filesystem, so 4852e2fcbf42SPeter Maydell should only be used with a trusted guest OS. 4853e2fcbf42SPeter Maydell 4854e2fcbf42SPeter Maydell ``target=native|gdb|auto`` 4855e2fcbf42SPeter Maydell Defines where the semihosting calls will be addressed, to QEMU 4856e2fcbf42SPeter Maydell (``native``) or to GDB (``gdb``). The default is ``auto``, which 4857e2fcbf42SPeter Maydell means ``gdb`` during debug sessions and ``native`` otherwise. 4858e2fcbf42SPeter Maydell 4859e2fcbf42SPeter Maydell ``chardev=str1`` 4860e2fcbf42SPeter Maydell Send the output to a chardev backend output for native or auto 4861e2fcbf42SPeter Maydell output when not in gdb 4862e2fcbf42SPeter Maydell 48635202861bSPeter Maydell ``userspace=on|off`` 48645202861bSPeter Maydell Allows code running in guest userspace to access the semihosting 48655202861bSPeter Maydell interface. The default is that only privileged guest code can 48665202861bSPeter Maydell make semihosting calls. Note that setting ``userspace=on`` should 48675202861bSPeter Maydell only be used if all guest code is trusted (for example, in 48685202861bSPeter Maydell bare-metal test case code). 48695202861bSPeter Maydell 4870e2fcbf42SPeter Maydell ``arg=str1,arg=str2,...`` 4871e2fcbf42SPeter Maydell Allows the user to pass input arguments, and can be used 4872e2fcbf42SPeter Maydell multiple times to build up a list. The old-style 4873e2fcbf42SPeter Maydell ``-kernel``/``-append`` method of passing a command line is 4874e2fcbf42SPeter Maydell still supported for backward compatibility. If both the 4875e2fcbf42SPeter Maydell ``--semihosting-config arg`` and the ``-kernel``/``-append`` are 4876e2fcbf42SPeter Maydell specified, the former is passed to semihosting as it always 4877e2fcbf42SPeter Maydell takes precedence. 4878e2fcbf42SPeter MaydellERST 48795824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 4880ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 4881e2fcbf42SPeter MaydellSRST 4882e2fcbf42SPeter Maydell``-old-param`` 4883e2fcbf42SPeter Maydell Old param mode (ARM only). 4884e2fcbf42SPeter MaydellERST 488595d5f08bSStefan Weil 48867d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 488773a1e647SEduardo Otubo "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \ 488824f8cdc5SEduardo Otubo " [,spawn=allow|deny][,resourcecontrol=allow|deny]\n" \ 48892b716fa6SEduardo Otubo " Enable seccomp mode 2 system call filter (default 'off').\n" \ 48902b716fa6SEduardo Otubo " use 'obsolete' to allow obsolete system calls that are provided\n" \ 48912b716fa6SEduardo Otubo " by the kernel, but typically no longer used by modern\n" \ 489273a1e647SEduardo Otubo " C library implementations.\n" \ 4893d42304b1SPhilippe Mathieu-Daudé " use 'elevateprivileges' to allow or deny the QEMU process ability\n" \ 4894d42304b1SPhilippe Mathieu-Daudé " to elevate privileges using set*uid|gid system calls.\n" \ 489573a1e647SEduardo Otubo " The value 'children' will deny set*uid|gid system calls for\n" \ 4896995a226fSEduardo Otubo " main QEMU process but will allow forks and execves to run unprivileged\n" \ 4897995a226fSEduardo Otubo " use 'spawn' to avoid QEMU to spawn new threads or processes by\n" \ 4898d42304b1SPhilippe Mathieu-Daudé " blocking *fork and execve\n" \ 489924f8cdc5SEduardo Otubo " use 'resourcecontrol' to disable process affinity and schedular priority\n", 49007d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 4901e2fcbf42SPeter MaydellSRST 4902e2fcbf42SPeter Maydell``-sandbox arg[,obsolete=string][,elevateprivileges=string][,spawn=string][,resourcecontrol=string]`` 4903e2fcbf42SPeter Maydell Enable Seccomp mode 2 system call filter. 'on' will enable syscall 4904e2fcbf42SPeter Maydell filtering and 'off' will disable it. The default is 'off'. 4905e2fcbf42SPeter Maydell 4906e2fcbf42SPeter Maydell ``obsolete=string`` 4907e2fcbf42SPeter Maydell Enable Obsolete system calls 4908e2fcbf42SPeter Maydell 4909e2fcbf42SPeter Maydell ``elevateprivileges=string`` 4910e2fcbf42SPeter Maydell Disable set\*uid\|gid system calls 4911e2fcbf42SPeter Maydell 4912e2fcbf42SPeter Maydell ``spawn=string`` 4913e2fcbf42SPeter Maydell Disable \*fork and execve 4914e2fcbf42SPeter Maydell 4915e2fcbf42SPeter Maydell ``resourcecontrol=string`` 4916e2fcbf42SPeter Maydell Disable process affinity and schedular priority 4917e2fcbf42SPeter MaydellERST 49187d76ad4fSEduardo Otubo 4919715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 4920e960a7eeSPaolo Bonzini "-readconfig <file>\n" 4921e960a7eeSPaolo Bonzini " read config file\n", QEMU_ARCH_ALL) 4922e2fcbf42SPeter MaydellSRST 4923e2fcbf42SPeter Maydell``-readconfig file`` 4924e2fcbf42SPeter Maydell Read device configuration from file. This approach is useful when 4925e2fcbf42SPeter Maydell you want to spawn QEMU process with many command line options but 4926e2fcbf42SPeter Maydell you don't want to exceed the command line character limit. 4927e2fcbf42SPeter MaydellERST 49282feac451SThomas Huth 4929f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 4930f29a5614SEduardo Habkost "-no-user-config\n" 49313478eae9SEduardo Habkost " do not load default user-provided config files at startup\n", 4932f29a5614SEduardo Habkost QEMU_ARCH_ALL) 4933e2fcbf42SPeter MaydellSRST 4934e2fcbf42SPeter Maydell``-no-user-config`` 4935e2fcbf42SPeter Maydell The ``-no-user-config`` option makes QEMU not load any of the 4936e2fcbf42SPeter Maydell user-provided config files on sysconfdir. 4937e2fcbf42SPeter MaydellERST 49382feac451SThomas Huth 4939ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 494010578a25SPaolo Bonzini "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 494123d15e86SLluís " specify tracing options\n", 4942ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 4943e2fcbf42SPeter MaydellSRST 4944e2fcbf42SPeter Maydell``-trace [[enable=]pattern][,events=file][,file=file]`` 494509ce5f2dSPeter Maydell .. include:: ../qemu-option-trace.rst.inc 4946e2fcbf42SPeter Maydell 4947e2fcbf42SPeter MaydellERST 494842229a75SLluís VilanovaDEF("plugin", HAS_ARG, QEMU_OPTION_plugin, 49493a445acbSMahmoud Mandour "-plugin [file=]<file>[,<argname>=<argvalue>]\n" 495042229a75SLluís Vilanova " load a plugin\n", 495142229a75SLluís Vilanova QEMU_ARCH_ALL) 4952e2fcbf42SPeter MaydellSRST 49533a445acbSMahmoud Mandour``-plugin file=file[,argname=argvalue]`` 4954e2fcbf42SPeter Maydell Load a plugin. 4955e2fcbf42SPeter Maydell 4956e2fcbf42SPeter Maydell ``file=file`` 4957e2fcbf42SPeter Maydell Load the given plugin from a shared library file. 4958e2fcbf42SPeter Maydell 49593a445acbSMahmoud Mandour ``argname=argvalue`` 49603a445acbSMahmoud Mandour Argument passed to the plugin. (Can be given multiple times.) 4961e2fcbf42SPeter MaydellERST 49623dbf2c7fSStefan Weil 496331e70d6cSMarkus ArmbrusterHXCOMM Internal use 496431e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 496531e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 4966c7f0f3b1SAnthony Liguori 4967c891c24bSClaudio Imbrenda#ifdef __linux__ 4968c891c24bSClaudio ImbrendaDEF("async-teardown", 0, QEMU_OPTION_asyncteardown, 4969c891c24bSClaudio Imbrenda "-async-teardown enable asynchronous teardown\n", 4970c891c24bSClaudio Imbrenda QEMU_ARCH_ALL) 4971c891c24bSClaudio ImbrendaSRST 4972c891c24bSClaudio Imbrenda``-async-teardown`` 497380bd81caSClaudio Imbrenda This option is deprecated and should no longer be used. The new option 497480bd81caSClaudio Imbrenda ``-run-with async-teardown=on`` is a replacement. 4975c891c24bSClaudio ImbrendaERST 49769ffcbe2aSThomas Huth#endif 49779ffcbe2aSThomas Huth#ifdef CONFIG_POSIX 497880bd81caSClaudio ImbrendaDEF("run-with", HAS_ARG, QEMU_OPTION_run_with, 49799ffcbe2aSThomas Huth "-run-with [async-teardown=on|off][,chroot=dir]\n" 49809ffcbe2aSThomas Huth " Set miscellaneous QEMU process lifecycle options:\n" 49819ffcbe2aSThomas Huth " async-teardown=on enables asynchronous teardown (Linux only)\n" 49829ffcbe2aSThomas Huth " chroot=dir chroot to dir just before starting the VM\n", 498380bd81caSClaudio Imbrenda QEMU_ARCH_ALL) 498480bd81caSClaudio ImbrendaSRST 49859ffcbe2aSThomas Huth``-run-with [async-teardown=on|off][,chroot=dir]`` 498680bd81caSClaudio Imbrenda Set QEMU process lifecycle options. 498780bd81caSClaudio Imbrenda 498880bd81caSClaudio Imbrenda ``async-teardown=on`` enables asynchronous teardown. A new process called 498980bd81caSClaudio Imbrenda "cleanup/<QEMU_PID>" will be created at startup sharing the address 499080bd81caSClaudio Imbrenda space with the main QEMU process, using clone. It will wait for the 499180bd81caSClaudio Imbrenda main QEMU process to terminate completely, and then exit. This allows 499280bd81caSClaudio Imbrenda QEMU to terminate very quickly even if the guest was huge, leaving the 499380bd81caSClaudio Imbrenda teardown of the address space to the cleanup process. Since the cleanup 499480bd81caSClaudio Imbrenda process shares the same cgroups as the main QEMU process, accounting is 499580bd81caSClaudio Imbrenda performed correctly. This only works if the cleanup process is not 499680bd81caSClaudio Imbrenda forcefully killed with SIGKILL before the main QEMU process has 499780bd81caSClaudio Imbrenda terminated completely. 49989ffcbe2aSThomas Huth 49999ffcbe2aSThomas Huth ``chroot=dir`` can be used for doing a chroot to the specified directory 50009ffcbe2aSThomas Huth immediately before starting the guest execution. This is especially useful 50019ffcbe2aSThomas Huth in combination with -runas. 500280bd81caSClaudio ImbrendaERST 500380bd81caSClaudio Imbrenda#endif 5004c891c24bSClaudio Imbrenda 50055e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 50062880ffb0SMario Smarduch "-msg [timestamp[=on|off]][,guest-name=[on|off]]\n" 5007deda497bSMarkus Armbruster " control error message format\n" 50082880ffb0SMario Smarduch " timestamp=on enables timestamps (default: off)\n" 50092880ffb0SMario Smarduch " guest-name=on enables guest name prefix but only if\n" 50102880ffb0SMario Smarduch " -name guest option is set (default: off)\n", 50115e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 5012e2fcbf42SPeter MaydellSRST 50132880ffb0SMario Smarduch``-msg [timestamp[=on|off]][,guest-name[=on|off]]`` 5014e2fcbf42SPeter Maydell Control error message format. 5015e2fcbf42SPeter Maydell 5016e2fcbf42SPeter Maydell ``timestamp=on|off`` 5017e2fcbf42SPeter Maydell Prefix messages with a timestamp. Default is off. 50182880ffb0SMario Smarduch 50192880ffb0SMario Smarduch ``guest-name=on|off`` 50202880ffb0SMario Smarduch Prefix messages with guest name but only if -name guest option is set 50212880ffb0SMario Smarduch otherwise the option is ignored. Default is off. 5022e2fcbf42SPeter MaydellERST 50235e2ac519SSeiji Aguchi 5024abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 5025abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 5026abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 5027abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 5028abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 50292382053fSLaurent Vivier " by comparing two such vmstate dumps.\n", 5030abfd9ce3SAmit Shah QEMU_ARCH_ALL) 5031e2fcbf42SPeter MaydellSRST 5032e2fcbf42SPeter Maydell``-dump-vmstate file`` 5033e2fcbf42SPeter Maydell Dump json-encoded vmstate information for current machine type to 5034e2fcbf42SPeter Maydell file in file 5035e2fcbf42SPeter MaydellERST 5036abfd9ce3SAmit Shah 503712df189dSEmilio G. CotaDEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile, 503812df189dSEmilio G. Cota "-enable-sync-profile\n" 503912df189dSEmilio G. Cota " enable synchronization profiling\n", 504012df189dSEmilio G. Cota QEMU_ARCH_ALL) 5041e2fcbf42SPeter MaydellSRST 5042e2fcbf42SPeter Maydell``-enable-sync-profile`` 5043e2fcbf42SPeter Maydell Enable synchronization profiling. 5044e2fcbf42SPeter MaydellERST 504512df189dSEmilio G. Cota 50465584e2dbSIlya Leoshkevich#if defined(CONFIG_TCG) && defined(CONFIG_LINUX) 50475584e2dbSIlya LeoshkevichDEF("perfmap", 0, QEMU_OPTION_perfmap, 50485584e2dbSIlya Leoshkevich "-perfmap generate a /tmp/perf-${pid}.map file for perf\n", 50495584e2dbSIlya Leoshkevich QEMU_ARCH_ALL) 50505584e2dbSIlya LeoshkevichSRST 50515584e2dbSIlya Leoshkevich``-perfmap`` 50525584e2dbSIlya Leoshkevich Generate a map file for Linux perf tools that will allow basic profiling 50535584e2dbSIlya Leoshkevich information to be broken down into basic blocks. 50545584e2dbSIlya LeoshkevichERST 50555584e2dbSIlya Leoshkevich 50565584e2dbSIlya LeoshkevichDEF("jitdump", 0, QEMU_OPTION_jitdump, 50575584e2dbSIlya Leoshkevich "-jitdump generate a jit-${pid}.dump file for perf\n", 50585584e2dbSIlya Leoshkevich QEMU_ARCH_ALL) 50595584e2dbSIlya LeoshkevichSRST 50605584e2dbSIlya Leoshkevich``-jitdump`` 50615584e2dbSIlya Leoshkevich Generate a dump file for Linux perf tools that maps basic blocks to symbol 50625584e2dbSIlya Leoshkevich names, line numbers and JITted code. 50635584e2dbSIlya LeoshkevichERST 50645584e2dbSIlya Leoshkevich#endif 50655584e2dbSIlya Leoshkevich 506643f187a5SPaolo BonziniDEFHEADING() 5067de6b4f90SMarkus Armbruster 5068de6b4f90SMarkus ArmbrusterDEFHEADING(Generic object creation:) 5069b9174d4fSDaniel P. Berrange 5070b9174d4fSDaniel P. BerrangeDEF("object", HAS_ARG, QEMU_OPTION_object, 5071b9174d4fSDaniel P. Berrange "-object TYPENAME[,PROP1=VALUE1,...]\n" 5072b9174d4fSDaniel P. Berrange " create a new object of type TYPENAME setting properties\n" 5073b9174d4fSDaniel P. Berrange " in the order they are specified. Note that the 'id'\n" 5074b9174d4fSDaniel P. Berrange " property must be set. These objects are placed in the\n" 5075b9174d4fSDaniel P. Berrange " '/objects' path.\n", 5076b9174d4fSDaniel P. Berrange QEMU_ARCH_ALL) 5077e2fcbf42SPeter MaydellSRST 5078e2fcbf42SPeter Maydell``-object typename[,prop1=value1,...]`` 5079e2fcbf42SPeter Maydell Create a new object of type typename setting properties in the order 5080e2fcbf42SPeter Maydell they are specified. Note that the 'id' property must be set. These 5081e2fcbf42SPeter Maydell objects are placed in the '/objects' path. 5082e2fcbf42SPeter Maydell 5083e92666b0SDavid Hildenbrand ``-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,offset=offset,readonly=on|off,rom=on|off|auto`` 5084e2fcbf42SPeter Maydell Creates a memory file backend object, which can be used to back 5085e2fcbf42SPeter Maydell the guest RAM with huge pages. 5086e2fcbf42SPeter Maydell 5087e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 508856c9f00eSRobert Hoo reference this memory region in other parameters, e.g. ``-numa``, 508956c9f00eSRobert Hoo ``-device nvdimm``, etc. 5090e2fcbf42SPeter Maydell 5091e2fcbf42SPeter Maydell The ``size`` option provides the size of the memory region, and 509256c9f00eSRobert Hoo accepts common suffixes, e.g. ``500M``. 5093e2fcbf42SPeter Maydell 5094e2fcbf42SPeter Maydell The ``mem-path`` provides the path to either a shared memory or 5095e2fcbf42SPeter Maydell huge page filesystem mount. 5096e2fcbf42SPeter Maydell 5097e2fcbf42SPeter Maydell The ``share`` boolean option determines whether the memory 5098e2fcbf42SPeter Maydell region is marked as private to QEMU, or shared. The latter 5099e2fcbf42SPeter Maydell allows a co-operating external process to access the QEMU memory 5100e2fcbf42SPeter Maydell region. 5101e2fcbf42SPeter Maydell 5102e2fcbf42SPeter Maydell The ``share`` is also required for pvrdma devices due to 5103e2fcbf42SPeter Maydell limitations in the RDMA API provided by Linux. 5104e2fcbf42SPeter Maydell 5105e2fcbf42SPeter Maydell Setting share=on might affect the ability to configure NUMA 5106e2fcbf42SPeter Maydell bindings for the memory backend under some circumstances, see 5107e2fcbf42SPeter Maydell Documentation/vm/numa\_memory\_policy.txt on the Linux kernel 5108e2fcbf42SPeter Maydell source tree for additional details. 5109e2fcbf42SPeter Maydell 5110e2fcbf42SPeter Maydell Setting the ``discard-data`` boolean option to on indicates that 5111e2fcbf42SPeter Maydell file contents can be destroyed when QEMU exits, to avoid 5112e2fcbf42SPeter Maydell unnecessarily flushing data to the backing file. Note that 5113e2fcbf42SPeter Maydell ``discard-data`` is only an optimization, and QEMU might not 5114e2fcbf42SPeter Maydell discard file contents if it aborts unexpectedly or is terminated 5115e2fcbf42SPeter Maydell using SIGKILL. 5116e2fcbf42SPeter Maydell 5117e2fcbf42SPeter Maydell The ``merge`` boolean option enables memory merge, also known as 5118e2fcbf42SPeter Maydell MADV\_MERGEABLE, so that Kernel Samepage Merging will consider 5119e2fcbf42SPeter Maydell the pages for memory deduplication. 5120e2fcbf42SPeter Maydell 5121e2fcbf42SPeter Maydell Setting the ``dump`` boolean option to off excludes the memory 5122e2fcbf42SPeter Maydell from core dumps. This feature is also known as MADV\_DONTDUMP. 5123e2fcbf42SPeter Maydell 5124e2fcbf42SPeter Maydell The ``prealloc`` boolean option enables memory preallocation. 5125e2fcbf42SPeter Maydell 5126e2fcbf42SPeter Maydell The ``host-nodes`` option binds the memory range to a list of 5127e2fcbf42SPeter Maydell NUMA host nodes. 5128e2fcbf42SPeter Maydell 5129e2fcbf42SPeter Maydell The ``policy`` option sets the NUMA policy to one of the 5130e2fcbf42SPeter Maydell following values: 5131e2fcbf42SPeter Maydell 5132e2fcbf42SPeter Maydell ``default`` 5133e2fcbf42SPeter Maydell default host policy 5134e2fcbf42SPeter Maydell 5135e2fcbf42SPeter Maydell ``preferred`` 5136e2fcbf42SPeter Maydell prefer the given host node list for allocation 5137e2fcbf42SPeter Maydell 5138e2fcbf42SPeter Maydell ``bind`` 5139e2fcbf42SPeter Maydell restrict memory allocation to the given host node list 5140e2fcbf42SPeter Maydell 5141e2fcbf42SPeter Maydell ``interleave`` 5142e2fcbf42SPeter Maydell interleave memory allocations across the given host node 5143e2fcbf42SPeter Maydell list 5144e2fcbf42SPeter Maydell 5145e2fcbf42SPeter Maydell The ``align`` option specifies the base address alignment when 5146e2fcbf42SPeter Maydell QEMU mmap(2) ``mem-path``, and accepts common suffixes, eg 5147e2fcbf42SPeter Maydell ``2M``. Some backend store specified by ``mem-path`` requires an 5148e2fcbf42SPeter Maydell alignment different than the default one used by QEMU, eg the 5149e2fcbf42SPeter Maydell device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In 5150e2fcbf42SPeter Maydell such cases, users can specify the required alignment via this 5151e2fcbf42SPeter Maydell option. 5152e2fcbf42SPeter Maydell 51534b870dc4SAlexander Graf The ``offset`` option specifies the offset into the target file 51544b870dc4SAlexander Graf that the region starts at. You can use this parameter to back 51554b870dc4SAlexander Graf multiple regions with a single file. 51564b870dc4SAlexander Graf 5157e2fcbf42SPeter Maydell The ``pmem`` option specifies whether the backing file specified 5158e2fcbf42SPeter Maydell by ``mem-path`` is in host persistent memory that can be 5159e2fcbf42SPeter Maydell accessed using the SNIA NVM programming model (e.g. Intel 5160e2fcbf42SPeter Maydell NVDIMM). If ``pmem`` is set to 'on', QEMU will take necessary 5161e2fcbf42SPeter Maydell operations to guarantee the persistence of its own writes to 5162e2fcbf42SPeter Maydell ``mem-path`` (e.g. in vNVDIMM label emulation and live 5163e2fcbf42SPeter Maydell migration). Also, we will map the backend-file with MAP\_SYNC 5164e2fcbf42SPeter Maydell flag, which ensures the file metadata is in sync for 5165e2fcbf42SPeter Maydell ``mem-path`` in case of host crash or a power failure. MAP\_SYNC 5166e2fcbf42SPeter Maydell requires support from both the host kernel (since Linux kernel 5167e2fcbf42SPeter Maydell 4.15) and the filesystem of ``mem-path`` mounted with DAX 5168e2fcbf42SPeter Maydell option. 5169e2fcbf42SPeter Maydell 517086635aa4SStefan Hajnoczi The ``readonly`` option specifies whether the backing file is opened 517186635aa4SStefan Hajnoczi read-only or read-write (default). 517286635aa4SStefan Hajnoczi 5173e92666b0SDavid Hildenbrand The ``rom`` option specifies whether to create Read Only Memory 5174e92666b0SDavid Hildenbrand (ROM) that cannot be modified by the VM. Any write attempts to such 5175e92666b0SDavid Hildenbrand ROM will be denied. Most use cases want proper RAM instead of ROM. 5176e92666b0SDavid Hildenbrand However, selected use cases, like R/O NVDIMMs, can benefit from 5177e92666b0SDavid Hildenbrand ROM. If set to ``on``, create ROM; if set to ``off``, create 5178e92666b0SDavid Hildenbrand writable RAM; if set to ``auto`` (default), the value of the 5179e92666b0SDavid Hildenbrand ``readonly`` option is used. This option is primarily helpful when 5180e92666b0SDavid Hildenbrand we want to have writable RAM in configurations that would 5181e92666b0SDavid Hildenbrand traditionally create ROM before the ``rom`` option was introduced: 5182e92666b0SDavid Hildenbrand VM templating, where we want to open a file readonly 5183e92666b0SDavid Hildenbrand (``readonly=on``) and mark the memory to be private for QEMU 5184e92666b0SDavid Hildenbrand (``share=off``). For this use case, we need writable RAM instead 5185e92666b0SDavid Hildenbrand of ROM, and want to also set ``rom=off``. 5186e92666b0SDavid Hildenbrand 5187e2fcbf42SPeter 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`` 5188e2fcbf42SPeter Maydell Creates a memory backend object, which can be used to back the 5189e2fcbf42SPeter Maydell guest RAM. Memory backend objects offer more control than the 5190e2fcbf42SPeter Maydell ``-m`` option that is traditionally used to define guest RAM. 5191e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 5192e2fcbf42SPeter Maydell options. 5193e2fcbf42SPeter Maydell 5194e2fcbf42SPeter 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`` 5195e2fcbf42SPeter Maydell Creates an anonymous memory file backend object, which allows 5196e2fcbf42SPeter Maydell QEMU to share the memory with an external process (e.g. when 5197e2fcbf42SPeter Maydell using vhost-user). The memory is allocated with memfd and 5198e2fcbf42SPeter Maydell optional sealing. (Linux only) 5199e2fcbf42SPeter Maydell 5200e2fcbf42SPeter Maydell The ``seal`` option creates a sealed-file, that will block 5201e2fcbf42SPeter Maydell further resizing the memory ('on' by default). 5202e2fcbf42SPeter Maydell 5203e2fcbf42SPeter Maydell The ``hugetlb`` option specify the file to be created resides in 5204e2fcbf42SPeter Maydell the hugetlbfs filesystem (since Linux 4.14). Used in conjunction 5205e2fcbf42SPeter Maydell with the ``hugetlb`` option, the ``hugetlbsize`` option specify 5206e2fcbf42SPeter Maydell the hugetlb page size on systems that support multiple hugetlb 5207e2fcbf42SPeter Maydell page sizes (it must be a power of 2 value supported by the 5208e2fcbf42SPeter Maydell system). 5209e2fcbf42SPeter Maydell 5210e2fcbf42SPeter Maydell In some versions of Linux, the ``hugetlb`` option is 5211e2fcbf42SPeter Maydell incompatible with the ``seal`` option (requires at least Linux 5212e2fcbf42SPeter Maydell 4.16). 5213e2fcbf42SPeter Maydell 5214e2fcbf42SPeter Maydell Please refer to ``memory-backend-file`` for a description of the 5215e2fcbf42SPeter Maydell other options. 5216e2fcbf42SPeter Maydell 5217e2fcbf42SPeter Maydell The ``share`` boolean option is on by default with memfd. 5218e2fcbf42SPeter Maydell 5219e2fcbf42SPeter Maydell ``-object rng-builtin,id=id`` 5220e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 5221e2fcbf42SPeter Maydell from QEMU builtin functions. The ``id`` parameter is a unique ID 5222e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 5223e2fcbf42SPeter Maydell ``virtio-rng`` device. By default, the ``virtio-rng`` device 5224e2fcbf42SPeter Maydell uses this RNG backend. 5225e2fcbf42SPeter Maydell 5226e2fcbf42SPeter Maydell ``-object rng-random,id=id,filename=/dev/random`` 5227e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 5228e2fcbf42SPeter Maydell from a device on the host. The ``id`` parameter is a unique ID 5229e2fcbf42SPeter Maydell that will be used to reference this entropy backend from the 5230e2fcbf42SPeter Maydell ``virtio-rng`` device. The ``filename`` parameter specifies 5231e2fcbf42SPeter Maydell which file to obtain entropy from and if omitted defaults to 5232e2fcbf42SPeter Maydell ``/dev/urandom``. 5233e2fcbf42SPeter Maydell 5234e2fcbf42SPeter Maydell ``-object rng-egd,id=id,chardev=chardevid`` 5235e2fcbf42SPeter Maydell Creates a random number generator backend which obtains entropy 5236e2fcbf42SPeter Maydell from an external daemon running on the host. The ``id`` 5237e2fcbf42SPeter Maydell parameter is a unique ID that will be used to reference this 5238e2fcbf42SPeter Maydell entropy backend from the ``virtio-rng`` device. The ``chardev`` 5239e2fcbf42SPeter Maydell parameter is the unique ID of a character device backend that 5240e2fcbf42SPeter Maydell provides the connection to the RNG daemon. 5241e2fcbf42SPeter Maydell 5242e2fcbf42SPeter Maydell ``-object tls-creds-anon,id=id,endpoint=endpoint,dir=/path/to/cred/dir,verify-peer=on|off`` 5243e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 5244e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 5245e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 5246e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 5247e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 5248e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 5249e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 5250e2fcbf42SPeter Maydell is completed, the peer credentials will be verified, though this 5251e2fcbf42SPeter Maydell is a no-op for anonymous credentials. 5252e2fcbf42SPeter Maydell 5253e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 5254e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 5255e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 5256e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 5257e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 5258e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 5259e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 5260e2fcbf42SPeter Maydell upfront and saved. 5261e2fcbf42SPeter Maydell 5262e2fcbf42SPeter Maydell ``-object tls-creds-psk,id=id,endpoint=endpoint,dir=/path/to/keys/dir[,username=username]`` 5263e2fcbf42SPeter Maydell Creates a TLS Pre-Shared Keys (PSK) credentials object, which 5264e2fcbf42SPeter Maydell can be used to provide TLS support on network backends. The 5265e2fcbf42SPeter Maydell ``id`` parameter is a unique ID which network backends will use 5266e2fcbf42SPeter Maydell to access the credentials. The ``endpoint`` is either ``server`` 5267e2fcbf42SPeter Maydell or ``client`` depending on whether the QEMU network backend that 5268e2fcbf42SPeter Maydell uses the credentials will be acting as a client or as a server. 5269e2fcbf42SPeter Maydell For clients only, ``username`` is the username which will be 5270e2fcbf42SPeter Maydell sent to the server. If omitted it defaults to "qemu". 5271e2fcbf42SPeter Maydell 5272e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the keys file. It is 5273e2fcbf42SPeter Maydell called "dir/keys.psk" and contains "username:key" pairs. This 5274e2fcbf42SPeter Maydell file can most easily be created using the GnuTLS ``psktool`` 5275e2fcbf42SPeter Maydell program. 5276e2fcbf42SPeter Maydell 5277e2fcbf42SPeter Maydell For server endpoints, dir may also contain a file dh-params.pem 5278e2fcbf42SPeter Maydell providing diffie-hellman parameters to use for the TLS server. 5279e2fcbf42SPeter Maydell If the file is missing, QEMU will generate a set of DH 5280e2fcbf42SPeter Maydell parameters at startup. This is a computationally expensive 5281e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 5282e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated up 5283e2fcbf42SPeter Maydell front and saved. 5284e2fcbf42SPeter Maydell 5285e2fcbf42SPeter Maydell ``-object tls-creds-x509,id=id,endpoint=endpoint,dir=/path/to/cred/dir,priority=priority,verify-peer=on|off,passwordid=id`` 5286e2fcbf42SPeter Maydell Creates a TLS anonymous credentials object, which can be used to 5287e2fcbf42SPeter Maydell provide TLS support on network backends. The ``id`` parameter is 5288e2fcbf42SPeter Maydell a unique ID which network backends will use to access the 5289e2fcbf42SPeter Maydell credentials. The ``endpoint`` is either ``server`` or ``client`` 5290e2fcbf42SPeter Maydell depending on whether the QEMU network backend that uses the 5291e2fcbf42SPeter Maydell credentials will be acting as a client or as a server. If 5292e2fcbf42SPeter Maydell ``verify-peer`` is enabled (the default) then once the handshake 5293e2fcbf42SPeter Maydell is completed, the peer credentials will be verified. With x509 5294e2fcbf42SPeter Maydell certificates, this implies that the clients must be provided 5295e2fcbf42SPeter Maydell with valid client certificates too. 5296e2fcbf42SPeter Maydell 5297e2fcbf42SPeter Maydell The dir parameter tells QEMU where to find the credential files. 5298e2fcbf42SPeter Maydell For server endpoints, this directory may contain a file 5299e2fcbf42SPeter Maydell dh-params.pem providing diffie-hellman parameters to use for the 5300e2fcbf42SPeter Maydell TLS server. If the file is missing, QEMU will generate a set of 5301e2fcbf42SPeter Maydell DH parameters at startup. This is a computationally expensive 5302e2fcbf42SPeter Maydell operation that consumes random pool entropy, so it is 5303e2fcbf42SPeter Maydell recommended that a persistent set of parameters be generated 5304e2fcbf42SPeter Maydell upfront and saved. 5305e2fcbf42SPeter Maydell 5306e2fcbf42SPeter Maydell For x509 certificate credentials the directory will contain 5307e2fcbf42SPeter Maydell further files providing the x509 certificates. The certificates 5308e2fcbf42SPeter Maydell must be stored in PEM format, in filenames ca-cert.pem, 5309e2fcbf42SPeter Maydell ca-crl.pem (optional), server-cert.pem (only servers), 5310e2fcbf42SPeter Maydell server-key.pem (only servers), client-cert.pem (only clients), 5311e2fcbf42SPeter Maydell and client-key.pem (only clients). 5312e2fcbf42SPeter Maydell 5313e2fcbf42SPeter Maydell For the server-key.pem and client-key.pem files which contain 5314e2fcbf42SPeter Maydell sensitive private keys, it is possible to use an encrypted 5315e2fcbf42SPeter Maydell version by providing the passwordid parameter. This provides the 5316e2fcbf42SPeter Maydell ID of a previously created ``secret`` object containing the 5317e2fcbf42SPeter Maydell password for decryption. 5318e2fcbf42SPeter Maydell 5319e2fcbf42SPeter Maydell The priority parameter allows to override the global default 5320e2fcbf42SPeter Maydell priority used by gnutls. This can be useful if the system 5321e2fcbf42SPeter Maydell administrator needs to use a weaker set of crypto priorities for 5322e2fcbf42SPeter Maydell QEMU without potentially forcing the weakness onto all 5323e2fcbf42SPeter Maydell applications. Or conversely if one wants wants a stronger 5324e2fcbf42SPeter Maydell default for QEMU than for all other applications, they can do 5325e2fcbf42SPeter Maydell this through this parameter. Its format is a gnutls priority 5326e2fcbf42SPeter Maydell string as described at 5327e2fcbf42SPeter Maydell https://gnutls.org/manual/html_node/Priority-Strings.html. 5328e2fcbf42SPeter Maydell 5329993aec27SPhilippe Mathieu-Daudé ``-object tls-cipher-suites,id=id,priority=priority`` 5330993aec27SPhilippe Mathieu-Daudé Creates a TLS cipher suites object, which can be used to control 5331993aec27SPhilippe Mathieu-Daudé the TLS cipher/protocol algorithms that applications are permitted 5332993aec27SPhilippe Mathieu-Daudé to use. 5333993aec27SPhilippe Mathieu-Daudé 5334993aec27SPhilippe Mathieu-Daudé The ``id`` parameter is a unique ID which frontends will use to 5335993aec27SPhilippe Mathieu-Daudé access the ordered list of permitted TLS cipher suites from the 5336993aec27SPhilippe Mathieu-Daudé host. 5337993aec27SPhilippe Mathieu-Daudé 5338993aec27SPhilippe Mathieu-Daudé The ``priority`` parameter allows to override the global default 5339993aec27SPhilippe Mathieu-Daudé priority used by gnutls. This can be useful if the system 5340993aec27SPhilippe Mathieu-Daudé administrator needs to use a weaker set of crypto priorities for 5341993aec27SPhilippe Mathieu-Daudé QEMU without potentially forcing the weakness onto all 5342993aec27SPhilippe Mathieu-Daudé applications. Or conversely if one wants wants a stronger 5343993aec27SPhilippe Mathieu-Daudé default for QEMU than for all other applications, they can do 5344993aec27SPhilippe Mathieu-Daudé this through this parameter. Its format is a gnutls priority 5345993aec27SPhilippe Mathieu-Daudé string as described at 5346993aec27SPhilippe Mathieu-Daudé https://gnutls.org/manual/html_node/Priority-Strings.html. 5347993aec27SPhilippe Mathieu-Daudé 534869699f30SPhilippe Mathieu-Daudé An example of use of this object is to control UEFI HTTPS Boot. 534969699f30SPhilippe Mathieu-Daudé The tls-cipher-suites object exposes the ordered list of permitted 535069699f30SPhilippe Mathieu-Daudé TLS cipher suites from the host side to the guest firmware, via 535169699f30SPhilippe Mathieu-Daudé fw_cfg. The list is represented as an array of IANA_TLS_CIPHER 535269699f30SPhilippe Mathieu-Daudé objects. The firmware uses the IANA_TLS_CIPHER array for configuring 535369699f30SPhilippe Mathieu-Daudé guest-side TLS. 535469699f30SPhilippe Mathieu-Daudé 535569699f30SPhilippe Mathieu-Daudé In the following example, the priority at which the host-side policy 535669699f30SPhilippe Mathieu-Daudé is retrieved is given by the ``priority`` property. 535769699f30SPhilippe Mathieu-Daudé Given that QEMU uses GNUTLS, ``priority=@SYSTEM`` may be used to 535869699f30SPhilippe Mathieu-Daudé refer to /etc/crypto-policies/back-ends/gnutls.config. 535969699f30SPhilippe Mathieu-Daudé 536069699f30SPhilippe Mathieu-Daudé .. parsed-literal:: 536169699f30SPhilippe Mathieu-Daudé 5362353a06b4SLaszlo Ersek # |qemu_system| \\ 5363353a06b4SLaszlo Ersek -object tls-cipher-suites,id=mysuite0,priority=@SYSTEM \\ 536469699f30SPhilippe Mathieu-Daudé -fw_cfg name=etc/edk2/https/ciphers,gen_id=mysuite0 536569699f30SPhilippe Mathieu-Daudé 5366e2fcbf42SPeter 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]`` 5367e2fcbf42SPeter Maydell Interval t can't be 0, this filter batches the packet delivery: 5368e2fcbf42SPeter Maydell all packets arriving in a given interval on netdev netdevid are 5369e2fcbf42SPeter Maydell delayed until the end of the interval. Interval is in 5370e2fcbf42SPeter Maydell microseconds. ``status`` is optional that indicate whether the 5371e2fcbf42SPeter Maydell netfilter is on (enabled) or off (disabled), the default status 5372e2fcbf42SPeter Maydell for netfilter will be 'on'. 5373e2fcbf42SPeter Maydell 5374e2fcbf42SPeter Maydell queue all\|rx\|tx is an option that can be applied to any 5375e2fcbf42SPeter Maydell netfilter. 5376e2fcbf42SPeter Maydell 5377e2fcbf42SPeter Maydell ``all``: the filter is attached both to the receive and the 5378e2fcbf42SPeter Maydell transmit queue of the netdev (default). 5379e2fcbf42SPeter Maydell 5380e2fcbf42SPeter Maydell ``rx``: the filter is attached to the receive queue of the 5381e2fcbf42SPeter Maydell netdev, where it will receive packets sent to the netdev. 5382e2fcbf42SPeter Maydell 5383e2fcbf42SPeter Maydell ``tx``: the filter is attached to the transmit queue of the 5384e2fcbf42SPeter Maydell netdev, where it will receive packets sent by the netdev. 5385e2fcbf42SPeter Maydell 5386e2fcbf42SPeter Maydell position head\|tail\|id=<id> is an option to specify where the 5387e2fcbf42SPeter Maydell filter should be inserted in the filter list. It can be applied 5388e2fcbf42SPeter Maydell to any netfilter. 5389e2fcbf42SPeter Maydell 5390e2fcbf42SPeter Maydell ``head``: the filter is inserted at the head of the filter list, 5391e2fcbf42SPeter Maydell before any existing filters. 5392e2fcbf42SPeter Maydell 5393e2fcbf42SPeter Maydell ``tail``: the filter is inserted at the tail of the filter list, 5394e2fcbf42SPeter Maydell behind any existing filters (default). 5395e2fcbf42SPeter Maydell 5396e2fcbf42SPeter Maydell ``id=<id>``: the filter is inserted before or behind the filter 5397e2fcbf42SPeter Maydell specified by <id>, see the insert option below. 5398e2fcbf42SPeter Maydell 5399e2fcbf42SPeter Maydell insert behind\|before is an option to specify where to insert 5400e2fcbf42SPeter Maydell the new filter relative to the one specified with 5401e2fcbf42SPeter Maydell position=id=<id>. It can be applied to any netfilter. 5402e2fcbf42SPeter Maydell 5403e2fcbf42SPeter Maydell ``before``: insert before the specified filter. 5404e2fcbf42SPeter Maydell 5405e2fcbf42SPeter Maydell ``behind``: insert behind the specified filter (default). 5406e2fcbf42SPeter Maydell 5407e2fcbf42SPeter 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]`` 5408e2fcbf42SPeter Maydell filter-mirror on netdev netdevid,mirror net packet to 5409e2fcbf42SPeter Maydell chardevchardevid, if it has the vnet\_hdr\_support flag, 5410e2fcbf42SPeter Maydell filter-mirror will mirror packet with vnet\_hdr\_len. 5411e2fcbf42SPeter Maydell 5412e2fcbf42SPeter 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]`` 5413e2fcbf42SPeter Maydell filter-redirector on netdev netdevid,redirect filter's net 5414e2fcbf42SPeter Maydell packet to chardev chardevid,and redirect indev's packet to 5415e2fcbf42SPeter Maydell filter.if it has the vnet\_hdr\_support flag, filter-redirector 5416e2fcbf42SPeter Maydell will redirect packet with vnet\_hdr\_len. Create a 5417e2fcbf42SPeter Maydell filter-redirector we need to differ outdev id from indev id, id 5418e2fcbf42SPeter Maydell can not be the same. we can just use indev or outdev, but at 5419e2fcbf42SPeter Maydell least one of indev or outdev need to be specified. 5420e2fcbf42SPeter Maydell 5421e2fcbf42SPeter Maydell ``-object filter-rewriter,id=id,netdev=netdevid,queue=all|rx|tx,[vnet_hdr_support][,position=head|tail|id=<id>][,insert=behind|before]`` 5422e2fcbf42SPeter Maydell Filter-rewriter is a part of COLO project.It will rewrite tcp 5423e2fcbf42SPeter Maydell packet to secondary from primary to keep secondary tcp 5424e2fcbf42SPeter Maydell connection,and rewrite tcp packet to primary from secondary make 5425e2fcbf42SPeter Maydell tcp packet can be handled by client.if it has the 5426e2fcbf42SPeter Maydell vnet\_hdr\_support flag, we can parse packet with vnet header. 5427e2fcbf42SPeter Maydell 5428e2fcbf42SPeter Maydell usage: colo secondary: -object 5429e2fcbf42SPeter Maydell filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 -object 5430e2fcbf42SPeter Maydell filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 -object 5431e2fcbf42SPeter Maydell filter-rewriter,id=rew0,netdev=hn0,queue=all 5432e2fcbf42SPeter Maydell 5433e2fcbf42SPeter Maydell ``-object filter-dump,id=id,netdev=dev[,file=filename][,maxlen=len][,position=head|tail|id=<id>][,insert=behind|before]`` 5434e2fcbf42SPeter Maydell Dump the network traffic on netdev dev to the file specified by 5435e2fcbf42SPeter Maydell filename. At most len bytes (64k by default) per packet are 5436e2fcbf42SPeter Maydell stored. The file format is libpcap, so it can be analyzed with 5437e2fcbf42SPeter Maydell tools such as tcpdump or Wireshark. 5438e2fcbf42SPeter Maydell 5439a2e5cb7aSZhang 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}]`` 5440e2fcbf42SPeter Maydell Colo-compare gets packet from primary\_in chardevid and 54412b28a7efSZhang Chen secondary\_in, then compare whether the payload of primary packet 54422b28a7efSZhang Chen and secondary packet are the same. If same, it will output 54432b28a7efSZhang Chen primary packet to out\_dev, else it will notify COLO-framework to do 54442b28a7efSZhang Chen checkpoint and send primary packet to out\_dev. In order to 54452b28a7efSZhang Chen improve efficiency, we need to put the task of comparison in 54462b28a7efSZhang Chen another iothread. If it has the vnet\_hdr\_support flag, 54472b28a7efSZhang Chen colo compare will send/recv packet with vnet\_hdr\_len. 54482b28a7efSZhang Chen The compare\_timeout=@var{ms} determines the maximum time of the 54492b28a7efSZhang Chen colo-compare hold the packet. The expired\_scan\_cycle=@var{ms} 54502b28a7efSZhang Chen is to set the period of scanning expired primary node network packets. 54512b28a7efSZhang Chen The max\_queue\_size=@var{size} is to set the max compare queue 54522b28a7efSZhang Chen size depend on user environment. 54532b28a7efSZhang Chen If user want to use Xen COLO, need to add the notify\_dev to 54549cc43c94SZhang Chen notify Xen colo-frame to do checkpoint. 5455e2fcbf42SPeter Maydell 54562b28a7efSZhang Chen COLO-compare must be used with the help of filter-mirror, 54572b28a7efSZhang Chen filter-redirector and filter-rewriter. 5458e2fcbf42SPeter Maydell 5459e2fcbf42SPeter Maydell :: 5460e2fcbf42SPeter Maydell 5461e2fcbf42SPeter Maydell KVM COLO 5462e2fcbf42SPeter Maydell 5463e2fcbf42SPeter Maydell primary: 5464e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 5465e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 5466bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 5467bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 5468bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 5469e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 5470bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 5471e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 5472e2fcbf42SPeter Maydell -object iothread,id=iothread1 5473e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 5474e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 5475e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 5476e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1 5477e2fcbf42SPeter Maydell 5478e2fcbf42SPeter Maydell secondary: 5479e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 5480e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 5481e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 5482e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 5483e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 5484e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 5485e2fcbf42SPeter Maydell 5486e2fcbf42SPeter Maydell 5487e2fcbf42SPeter Maydell Xen COLO 5488e2fcbf42SPeter Maydell 5489e2fcbf42SPeter Maydell primary: 5490e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 5491e2fcbf42SPeter Maydell -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 5492bfdc1267SDaniel P. Berrangé -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off 5493bfdc1267SDaniel P. Berrangé -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off 5494bfdc1267SDaniel P. Berrangé -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off 5495e2fcbf42SPeter Maydell -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 5496bfdc1267SDaniel P. Berrangé -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off 5497e2fcbf42SPeter Maydell -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 5498bfdc1267SDaniel P. Berrangé -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server=on,wait=off 5499e2fcbf42SPeter Maydell -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 5500e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 5501e2fcbf42SPeter Maydell -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 5502e2fcbf42SPeter Maydell -object iothread,id=iothread1 5503e2fcbf42SPeter Maydell -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1 5504e2fcbf42SPeter Maydell 5505e2fcbf42SPeter Maydell secondary: 5506e2fcbf42SPeter Maydell -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 5507e2fcbf42SPeter Maydell -device e1000,netdev=hn0,mac=52:a4:00:12:78:66 5508e2fcbf42SPeter Maydell -chardev socket,id=red0,host=3.3.3.3,port=9003 5509e2fcbf42SPeter Maydell -chardev socket,id=red1,host=3.3.3.3,port=9004 5510e2fcbf42SPeter Maydell -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 5511e2fcbf42SPeter Maydell -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 5512e2fcbf42SPeter Maydell 5513e2fcbf42SPeter Maydell If you want to know the detail of above command line, you can 5514e2fcbf42SPeter Maydell read the colo-compare git log. 5515e2fcbf42SPeter Maydell 5516e2fcbf42SPeter Maydell ``-object cryptodev-backend-builtin,id=id[,queues=queues]`` 55171e458f11SStefan Weil Creates a cryptodev backend which executes crypto operations from 55181e458f11SStefan Weil the QEMU cipher APIs. The id parameter is a unique ID that will 5519e2fcbf42SPeter Maydell be used to reference this cryptodev backend from the 5520e2fcbf42SPeter Maydell ``virtio-crypto`` device. The queues parameter is optional, 5521e2fcbf42SPeter Maydell which specify the queue number of cryptodev backend, the default 5522e2fcbf42SPeter Maydell of queues is 1. 5523e2fcbf42SPeter Maydell 552409ce5f2dSPeter Maydell .. parsed-literal:: 5525e2fcbf42SPeter Maydell 5526353a06b4SLaszlo Ersek # |qemu_system| \\ 5527353a06b4SLaszlo Ersek [...] \\ 5528353a06b4SLaszlo Ersek -object cryptodev-backend-builtin,id=cryptodev0 \\ 5529353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 5530e2fcbf42SPeter Maydell [...] 5531e2fcbf42SPeter Maydell 5532e2fcbf42SPeter Maydell ``-object cryptodev-vhost-user,id=id,chardev=chardevid[,queues=queues]`` 5533e2fcbf42SPeter Maydell Creates a vhost-user cryptodev backend, backed by a chardev 5534e2fcbf42SPeter Maydell chardevid. The id parameter is a unique ID that will be used to 5535e2fcbf42SPeter Maydell reference this cryptodev backend from the ``virtio-crypto`` 5536e2fcbf42SPeter Maydell device. The chardev should be a unix domain socket backed one. 5537e2fcbf42SPeter Maydell The vhost-user uses a specifically defined protocol to pass 5538e2fcbf42SPeter Maydell vhost ioctl replacement messages to an application on the other 5539e2fcbf42SPeter Maydell end of the socket. The queues parameter is optional, which 5540e2fcbf42SPeter Maydell specify the queue number of cryptodev backend for multiqueue 5541e2fcbf42SPeter Maydell vhost-user, the default of queues is 1. 5542e2fcbf42SPeter Maydell 554309ce5f2dSPeter Maydell .. parsed-literal:: 5544e2fcbf42SPeter Maydell 5545353a06b4SLaszlo Ersek # |qemu_system| \\ 5546353a06b4SLaszlo Ersek [...] \\ 5547353a06b4SLaszlo Ersek -chardev socket,id=chardev0,path=/path/to/socket \\ 5548353a06b4SLaszlo Ersek -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \\ 5549353a06b4SLaszlo Ersek -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \\ 5550e2fcbf42SPeter Maydell [...] 5551e2fcbf42SPeter Maydell 5552e2fcbf42SPeter Maydell ``-object secret,id=id,data=string,format=raw|base64[,keyid=secretid,iv=string]`` 555309ce5f2dSPeter Maydell \ 5554e2fcbf42SPeter Maydell ``-object secret,id=id,file=filename,format=raw|base64[,keyid=secretid,iv=string]`` 5555e2fcbf42SPeter Maydell Defines a secret to store a password, encryption key, or some 5556e2fcbf42SPeter Maydell other sensitive data. The sensitive data can either be passed 5557e2fcbf42SPeter Maydell directly via the data parameter, or indirectly via the file 5558e2fcbf42SPeter Maydell parameter. Using the data parameter is insecure unless the 5559e2fcbf42SPeter Maydell sensitive data is encrypted. 5560e2fcbf42SPeter Maydell 5561e2fcbf42SPeter Maydell The sensitive data can be provided in raw format (the default), 5562e2fcbf42SPeter Maydell or base64. When encoded as JSON, the raw format only supports 5563e2fcbf42SPeter Maydell valid UTF-8 characters, so base64 is recommended for sending 5564e2fcbf42SPeter Maydell binary data. QEMU will convert from which ever format is 5565e2fcbf42SPeter Maydell provided to the format it needs internally. eg, an RBD password 5566e2fcbf42SPeter Maydell can be provided in raw format, even though it will be base64 5567e2fcbf42SPeter Maydell encoded when passed onto the RBD sever. 5568e2fcbf42SPeter Maydell 5569e2fcbf42SPeter Maydell For added protection, it is possible to encrypt the data 5570e2fcbf42SPeter Maydell associated with a secret using the AES-256-CBC cipher. Use of 5571e2fcbf42SPeter Maydell encryption is indicated by providing the keyid and iv 5572e2fcbf42SPeter Maydell parameters. The keyid parameter provides the ID of a previously 5573e2fcbf42SPeter Maydell defined secret that contains the AES-256 decryption key. This 5574e2fcbf42SPeter Maydell key should be 32-bytes long and be base64 encoded. The iv 5575e2fcbf42SPeter Maydell parameter provides the random initialization vector used for 5576e2fcbf42SPeter Maydell encryption of this particular secret and should be a base64 5577e2fcbf42SPeter Maydell encrypted string of the 16-byte IV. 5578e2fcbf42SPeter Maydell 5579e2fcbf42SPeter Maydell The simplest (insecure) usage is to provide the secret inline 5580e2fcbf42SPeter Maydell 558109ce5f2dSPeter Maydell .. parsed-literal:: 5582e2fcbf42SPeter Maydell 5583e2fcbf42SPeter Maydell # |qemu_system| -object secret,id=sec0,data=letmein,format=raw 5584e2fcbf42SPeter Maydell 5585e2fcbf42SPeter Maydell The simplest secure usage is to provide the secret via a file 5586e2fcbf42SPeter Maydell 5587e2fcbf42SPeter Maydell # printf "letmein" > mypasswd.txt # QEMU\_SYSTEM\_MACRO -object 5588e2fcbf42SPeter Maydell secret,id=sec0,file=mypasswd.txt,format=raw 5589e2fcbf42SPeter Maydell 5590e2fcbf42SPeter Maydell For greater security, AES-256-CBC should be used. To illustrate 5591e2fcbf42SPeter Maydell usage, consider the openssl command line tool which can encrypt 5592e2fcbf42SPeter Maydell the data. Note that when encrypting, the plaintext must be 5593e2fcbf42SPeter Maydell padded to the cipher block size (32 bytes) using the standard 5594e2fcbf42SPeter Maydell PKCS#5/6 compatible padding algorithm. 5595e2fcbf42SPeter Maydell 5596e2fcbf42SPeter Maydell First a master key needs to be created in base64 encoding: 5597e2fcbf42SPeter Maydell 5598e2fcbf42SPeter Maydell :: 5599e2fcbf42SPeter Maydell 5600e2fcbf42SPeter Maydell # openssl rand -base64 32 > key.b64 5601e2fcbf42SPeter Maydell # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 5602e2fcbf42SPeter Maydell 5603e2fcbf42SPeter Maydell Each secret to be encrypted needs to have a random 5604e2fcbf42SPeter Maydell initialization vector generated. These do not need to be kept 5605e2fcbf42SPeter Maydell secret 5606e2fcbf42SPeter Maydell 5607e2fcbf42SPeter Maydell :: 5608e2fcbf42SPeter Maydell 5609e2fcbf42SPeter Maydell # openssl rand -base64 16 > iv.b64 5610e2fcbf42SPeter Maydell # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 5611e2fcbf42SPeter Maydell 5612e2fcbf42SPeter Maydell The secret to be defined can now be encrypted, in this case 5613e2fcbf42SPeter Maydell we're telling openssl to base64 encode the result, but it could 5614e2fcbf42SPeter Maydell be left as raw bytes if desired. 5615e2fcbf42SPeter Maydell 5616e2fcbf42SPeter Maydell :: 5617e2fcbf42SPeter Maydell 5618e2fcbf42SPeter Maydell # SECRET=$(printf "letmein" | 5619e2fcbf42SPeter Maydell openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 5620e2fcbf42SPeter Maydell 5621e2fcbf42SPeter Maydell When launching QEMU, create a master secret pointing to 5622e2fcbf42SPeter Maydell ``key.b64`` and specify that to be used to decrypt the user 5623e2fcbf42SPeter Maydell password. Pass the contents of ``iv.b64`` to the second secret 5624e2fcbf42SPeter Maydell 562509ce5f2dSPeter Maydell .. parsed-literal:: 5626e2fcbf42SPeter Maydell 5627353a06b4SLaszlo Ersek # |qemu_system| \\ 5628353a06b4SLaszlo Ersek -object secret,id=secmaster0,format=base64,file=key.b64 \\ 5629353a06b4SLaszlo Ersek -object secret,id=sec0,keyid=secmaster0,format=base64,\\ 5630e2fcbf42SPeter Maydell data=$SECRET,iv=$(<iv.b64) 5631e2fcbf42SPeter Maydell 563255cdf566SDov 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]`` 5633e2fcbf42SPeter Maydell Create a Secure Encrypted Virtualization (SEV) guest object, 5634e2fcbf42SPeter Maydell which can be used to provide the guest memory encryption support 5635e2fcbf42SPeter Maydell on AMD processors. 5636e2fcbf42SPeter Maydell 5637e2fcbf42SPeter Maydell When memory encryption is enabled, one of the physical address 5638e2fcbf42SPeter Maydell bit (aka the C-bit) is utilized to mark if a memory page is 5639e2fcbf42SPeter Maydell protected. The ``cbitpos`` is used to provide the C-bit 5640e2fcbf42SPeter Maydell position. The C-bit position is Host family dependent hence user 5641e2fcbf42SPeter Maydell must provide this value. On EPYC, the value should be 47. 5642e2fcbf42SPeter Maydell 5643e2fcbf42SPeter Maydell When memory encryption is enabled, we loose certain bits in 5644e2fcbf42SPeter Maydell physical address space. The ``reduced-phys-bits`` is used to 5645e2fcbf42SPeter Maydell provide the number of bits we loose in physical address space. 5646e2fcbf42SPeter Maydell Similar to C-bit, the value is Host family dependent. On EPYC, 5647326e3015STom Lendacky a guest will lose a maximum of 1 bit, so the value should be 1. 5648e2fcbf42SPeter Maydell 5649e2fcbf42SPeter Maydell The ``sev-device`` provides the device file to use for 5650e2fcbf42SPeter Maydell communicating with the SEV firmware running inside AMD Secure 5651e2fcbf42SPeter Maydell Processor. The default device is '/dev/sev'. If hardware 5652e2fcbf42SPeter Maydell supports memory encryption then /dev/sev devices are created by 5653e2fcbf42SPeter Maydell CCP driver. 5654e2fcbf42SPeter Maydell 5655e2fcbf42SPeter Maydell The ``policy`` provides the guest policy to be enforced by the 5656e2fcbf42SPeter Maydell SEV firmware and restrict what configuration and operational 5657e2fcbf42SPeter Maydell commands can be performed on this guest by the hypervisor. The 5658e2fcbf42SPeter Maydell policy should be provided by the guest owner and is bound to the 5659e2fcbf42SPeter Maydell guest and cannot be changed throughout the lifetime of the 5660e2fcbf42SPeter Maydell guest. The default is 0. 5661e2fcbf42SPeter Maydell 5662e2fcbf42SPeter Maydell If guest ``policy`` allows sharing the key with another SEV 5663e2fcbf42SPeter Maydell guest then ``handle`` can be use to provide handle of the guest 5664e2fcbf42SPeter Maydell from which to share the key. 5665e2fcbf42SPeter Maydell 5666e2fcbf42SPeter Maydell The ``dh-cert-file`` and ``session-file`` provides the guest 5667e2fcbf42SPeter Maydell owner's Public Diffie-Hillman key defined in SEV spec. The PDH 5668e2fcbf42SPeter Maydell and session parameters are used for establishing a cryptographic 5669e2fcbf42SPeter Maydell session with the guest owner to negotiate keys used for 5670e2fcbf42SPeter Maydell attestation. The file must be encoded in base64. 5671e2fcbf42SPeter Maydell 567255cdf566SDov Murik The ``kernel-hashes`` adds the hashes of given kernel/initrd/ 567355cdf566SDov Murik cmdline to a designated guest firmware page for measured Linux 567455cdf566SDov Murik boot with -kernel. The default is off. (Since 6.2) 567555cdf566SDov Murik 5676e2fcbf42SPeter Maydell e.g to launch a SEV guest 5677e2fcbf42SPeter Maydell 567809ce5f2dSPeter Maydell .. parsed-literal:: 5679e2fcbf42SPeter Maydell 5680353a06b4SLaszlo Ersek # |qemu_system_x86| \\ 5681353a06b4SLaszlo Ersek ...... \\ 5682326e3015STom Lendacky -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=1 \\ 5683353a06b4SLaszlo Ersek -machine ...,memory-encryption=sev0 \\ 5684e2fcbf42SPeter Maydell ..... 5685e2fcbf42SPeter Maydell 5686e2fcbf42SPeter Maydell ``-object authz-simple,id=id,identity=string`` 5687e2fcbf42SPeter Maydell Create an authorization object that will control access to 5688e2fcbf42SPeter Maydell network services. 5689e2fcbf42SPeter Maydell 5690e2fcbf42SPeter Maydell The ``identity`` parameter is identifies the user and its format 5691e2fcbf42SPeter Maydell depends on the network service that authorization object is 5692e2fcbf42SPeter Maydell associated with. For authorizing based on TLS x509 certificates, 5693e2fcbf42SPeter Maydell the identity must be the x509 distinguished name. Note that care 5694e2fcbf42SPeter Maydell must be taken to escape any commas in the distinguished name. 5695e2fcbf42SPeter Maydell 5696e2fcbf42SPeter Maydell An example authorization object to validate a x509 distinguished 5697e2fcbf42SPeter Maydell name would look like: 5698e2fcbf42SPeter Maydell 569909ce5f2dSPeter Maydell .. parsed-literal:: 5700e2fcbf42SPeter Maydell 5701353a06b4SLaszlo Ersek # |qemu_system| \\ 5702353a06b4SLaszlo Ersek ... \\ 5703353a06b4SLaszlo Ersek -object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,O=Example Org,,L=London,,ST=London,,C=GB' \\ 5704e2fcbf42SPeter Maydell ... 5705e2fcbf42SPeter Maydell 5706e2fcbf42SPeter Maydell Note the use of quotes due to the x509 distinguished name 5707e2fcbf42SPeter Maydell containing whitespace, and escaping of ','. 5708e2fcbf42SPeter Maydell 57094d7beeabSDaniel P. Berrangé ``-object authz-listfile,id=id,filename=path,refresh=on|off`` 5710e2fcbf42SPeter Maydell Create an authorization object that will control access to 5711e2fcbf42SPeter Maydell network services. 5712e2fcbf42SPeter Maydell 5713e2fcbf42SPeter Maydell The ``filename`` parameter is the fully qualified path to a file 5714e2fcbf42SPeter Maydell containing the access control list rules in JSON format. 5715e2fcbf42SPeter Maydell 5716e2fcbf42SPeter Maydell An example set of rules that match against SASL usernames might 5717e2fcbf42SPeter Maydell look like: 5718e2fcbf42SPeter Maydell 5719e2fcbf42SPeter Maydell :: 5720e2fcbf42SPeter Maydell 5721e2fcbf42SPeter Maydell { 5722e2fcbf42SPeter Maydell "rules": [ 5723e2fcbf42SPeter Maydell { "match": "fred", "policy": "allow", "format": "exact" }, 5724e2fcbf42SPeter Maydell { "match": "bob", "policy": "allow", "format": "exact" }, 5725e2fcbf42SPeter Maydell { "match": "danb", "policy": "deny", "format": "glob" }, 5726e2fcbf42SPeter Maydell { "match": "dan*", "policy": "allow", "format": "exact" }, 5727e2fcbf42SPeter Maydell ], 5728e2fcbf42SPeter Maydell "policy": "deny" 5729e2fcbf42SPeter Maydell } 5730e2fcbf42SPeter Maydell 5731e2fcbf42SPeter Maydell When checking access the object will iterate over all the rules 5732e2fcbf42SPeter Maydell and the first rule to match will have its ``policy`` value 5733e2fcbf42SPeter Maydell returned as the result. If no rules match, then the default 5734e2fcbf42SPeter Maydell ``policy`` value is returned. 5735e2fcbf42SPeter Maydell 5736e2fcbf42SPeter Maydell The rules can either be an exact string match, or they can use 5737e2fcbf42SPeter Maydell the simple UNIX glob pattern matching to allow wildcards to be 5738e2fcbf42SPeter Maydell used. 5739e2fcbf42SPeter Maydell 5740e2fcbf42SPeter Maydell If ``refresh`` is set to true the file will be monitored and 5741e2fcbf42SPeter Maydell automatically reloaded whenever its content changes. 5742e2fcbf42SPeter Maydell 5743e2fcbf42SPeter Maydell As with the ``authz-simple`` object, the format of the identity 5744e2fcbf42SPeter Maydell strings being matched depends on the network service, but is 5745e2fcbf42SPeter Maydell usually a TLS x509 distinguished name, or a SASL username. 5746e2fcbf42SPeter Maydell 5747e2fcbf42SPeter Maydell An example authorization object to validate a SASL username 5748e2fcbf42SPeter Maydell would look like: 5749e2fcbf42SPeter Maydell 575009ce5f2dSPeter Maydell .. parsed-literal:: 5751e2fcbf42SPeter Maydell 5752353a06b4SLaszlo Ersek # |qemu_system| \\ 5753353a06b4SLaszlo Ersek ... \\ 57544d7beeabSDaniel P. Berrangé -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=on \\ 5755e2fcbf42SPeter Maydell ... 5756e2fcbf42SPeter Maydell 5757e2fcbf42SPeter Maydell ``-object authz-pam,id=id,service=string`` 5758e2fcbf42SPeter Maydell Create an authorization object that will control access to 5759e2fcbf42SPeter Maydell network services. 5760e2fcbf42SPeter Maydell 5761e2fcbf42SPeter Maydell The ``service`` parameter provides the name of a PAM service to 5762e2fcbf42SPeter Maydell use for authorization. It requires that a file 5763e2fcbf42SPeter Maydell ``/etc/pam.d/service`` exist to provide the configuration for 5764e2fcbf42SPeter Maydell the ``account`` subsystem. 5765e2fcbf42SPeter Maydell 5766e2fcbf42SPeter Maydell An example authorization object to validate a TLS x509 5767e2fcbf42SPeter Maydell distinguished name would look like: 5768e2fcbf42SPeter Maydell 576909ce5f2dSPeter Maydell .. parsed-literal:: 5770e2fcbf42SPeter Maydell 5771353a06b4SLaszlo Ersek # |qemu_system| \\ 5772353a06b4SLaszlo Ersek ... \\ 5773353a06b4SLaszlo Ersek -object authz-pam,id=auth0,service=qemu-vnc \\ 5774e2fcbf42SPeter Maydell ... 5775e2fcbf42SPeter Maydell 5776e2fcbf42SPeter Maydell There would then be a corresponding config file for PAM at 5777e2fcbf42SPeter Maydell ``/etc/pam.d/qemu-vnc`` that contains: 5778e2fcbf42SPeter Maydell 5779e2fcbf42SPeter Maydell :: 5780e2fcbf42SPeter Maydell 5781e2fcbf42SPeter Maydell account requisite pam_listfile.so item=user sense=allow \ 5782e2fcbf42SPeter Maydell file=/etc/qemu/vnc.allow 5783e2fcbf42SPeter Maydell 5784e2fcbf42SPeter Maydell Finally the ``/etc/qemu/vnc.allow`` file would contain the list 57851e458f11SStefan Weil of x509 distinguished names that are permitted access 5786e2fcbf42SPeter Maydell 5787e2fcbf42SPeter Maydell :: 5788e2fcbf42SPeter Maydell 5789e2fcbf42SPeter Maydell CN=laptop.example.com,O=Example Home,L=London,ST=London,C=GB 5790e2fcbf42SPeter Maydell 57911793ad02SStefano 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`` 5792e2fcbf42SPeter Maydell Creates a dedicated event loop thread that devices can be 5793e2fcbf42SPeter Maydell assigned to. This is known as an IOThread. By default device 5794e2fcbf42SPeter Maydell emulation happens in vCPU threads or the main event loop thread. 5795e2fcbf42SPeter Maydell This can become a scalability bottleneck. IOThreads allow device 5796e2fcbf42SPeter Maydell emulation and I/O to run on other host CPUs. 5797e2fcbf42SPeter Maydell 5798e2fcbf42SPeter Maydell The ``id`` parameter is a unique ID that will be used to 5799e2fcbf42SPeter Maydell reference this IOThread from ``-device ...,iothread=id``. 5800e2fcbf42SPeter Maydell Multiple devices can be assigned to an IOThread. Note that not 5801e2fcbf42SPeter Maydell all devices support an ``iothread`` parameter. 5802e2fcbf42SPeter Maydell 5803e2fcbf42SPeter Maydell The ``query-iothreads`` QMP command lists IOThreads and reports 5804e2fcbf42SPeter Maydell their thread IDs so that the user can configure host CPU 5805e2fcbf42SPeter Maydell pinning/affinity. 5806e2fcbf42SPeter Maydell 5807e2fcbf42SPeter Maydell IOThreads use an adaptive polling algorithm to reduce event loop 5808e2fcbf42SPeter Maydell latency. Instead of entering a blocking system call to monitor 5809e2fcbf42SPeter Maydell file descriptors and then pay the cost of being woken up when an 5810e2fcbf42SPeter Maydell event occurs, the polling algorithm spins waiting for events for 5811e2fcbf42SPeter Maydell a short time. The algorithm's default parameters are suitable 5812e2fcbf42SPeter Maydell for many cases but can be adjusted based on knowledge of the 5813e2fcbf42SPeter Maydell workload and/or host device latency. 5814e2fcbf42SPeter Maydell 5815e2fcbf42SPeter Maydell The ``poll-max-ns`` parameter is the maximum number of 5816e2fcbf42SPeter Maydell nanoseconds to busy wait for events. Polling can be disabled by 5817e2fcbf42SPeter Maydell setting this value to 0. 5818e2fcbf42SPeter Maydell 5819e2fcbf42SPeter Maydell The ``poll-grow`` parameter is the multiplier used to increase 5820e2fcbf42SPeter Maydell the polling time when the algorithm detects it is missing events 5821e2fcbf42SPeter Maydell due to not polling long enough. 5822e2fcbf42SPeter Maydell 5823e2fcbf42SPeter Maydell The ``poll-shrink`` parameter is the divisor used to decrease 5824e2fcbf42SPeter Maydell the polling time when the algorithm detects it is spending too 5825e2fcbf42SPeter Maydell long polling without encountering events. 5826e2fcbf42SPeter Maydell 58271793ad02SStefano Garzarella The ``aio-max-batch`` parameter is the maximum number of requests 58281793ad02SStefano Garzarella in a batch for the AIO engine, 0 means that the engine will use 58291793ad02SStefano Garzarella its default. 58301793ad02SStefano Garzarella 58311793ad02SStefano Garzarella The IOThread parameters can be modified at run-time using the 5832e2fcbf42SPeter Maydell ``qom-set`` command (where ``iothread1`` is the IOThread's 5833e2fcbf42SPeter Maydell ``id``): 5834e2fcbf42SPeter Maydell 5835e2fcbf42SPeter Maydell :: 5836e2fcbf42SPeter Maydell 5837e2fcbf42SPeter Maydell (qemu) qom-set /objects/iothread1 poll-max-ns 100000 5838e2fcbf42SPeter MaydellERST 5839b9174d4fSDaniel P. Berrange 5840b9174d4fSDaniel P. Berrange 58413dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 5842fd5fc4b1SPaolo Bonzini 5843fd5fc4b1SPaolo Bonzini#undef DEF 5844fd5fc4b1SPaolo Bonzini#undef DEFHEADING 5845fd5fc4b1SPaolo Bonzini#undef ARCHHEADING 5846