xref: /qemu/meson_options.txt (revision bb154e3e)
1# These options do not correspond to a --enable/--disable-* option
2# on the configure script command line.  If you add more, list them in
3# scripts/meson-buildoptions.py's SKIP_OPTIONS constant too.
4
5option('qemu_suffix', type : 'string', value: 'qemu',
6       description: 'Suffix for QEMU data/modules/config directories (can be empty)')
7option('docdir', type : 'string', value : 'share/doc',
8       description: 'Base directory for documentation installation (can be empty)')
9option('qemu_firmwarepath', type : 'array', value : ['share/qemu-firmware'],
10       description: 'search PATH for firmware files')
11option('pkgversion', type : 'string', value : '',
12       description: 'use specified string as sub-version of the package')
13option('smbd', type : 'string', value : '',
14       description: 'Path to smbd for slirp networking')
15option('iasl', type : 'string', value : '',
16       description: 'Path to ACPI disassembler')
17option('tls_priority', type : 'string', value : 'NORMAL',
18       description: 'Default TLS protocol/cipher priority string')
19option('default_devices', type : 'boolean', value : true,
20       description: 'Include a default selection of devices in emulators')
21option('audio_drv_list', type: 'array', value: ['default'],
22       choices: ['alsa', 'coreaudio', 'default', 'dsound', 'jack', 'oss', 'pa', 'pipewire', 'sdl', 'sndio'],
23       description: 'Set audio driver list')
24option('block_drv_rw_whitelist', type : 'string', value : '',
25       description: 'set block driver read-write whitelist (by default affects only QEMU, not tools like qemu-img)')
26option('block_drv_ro_whitelist', type : 'string', value : '',
27       description: 'set block driver read-only whitelist (by default affects only QEMU, not tools like qemu-img)')
28option('interp_prefix', type : 'string', value : '/usr/gnemul/qemu-%M',
29       description: 'where to find shared libraries etc., use %M for cpu name')
30option('fuzzing_engine', type : 'string', value : '',
31       description: 'fuzzing engine library for OSS-Fuzz')
32option('trace_file', type: 'string', value: 'trace',
33       description: 'Trace file prefix for simple backend')
34option('coroutine_backend', type: 'combo',
35       choices: ['ucontext', 'sigaltstack', 'windows', 'auto'],
36       value: 'auto', description: 'coroutine backend to use')
37
38# Everything else can be set via --enable/--disable-* option
39# on the configure script command line.  After adding an option
40# here make sure to run "make update-buildoptions".
41
42option('docs', type : 'feature', value : 'auto',
43       description: 'Documentations build support')
44option('fuzzing', type : 'boolean', value: false,
45       description: 'build fuzzing targets')
46option('gettext', type : 'feature', value : 'auto',
47       description: 'Localization of the GTK+ user interface')
48option('modules', type : 'feature', value : 'disabled',
49       description: 'modules support (non Windows)')
50option('module_upgrades', type : 'boolean', value : false,
51       description: 'try to load modules from alternate paths for upgrades')
52option('install_blobs', type : 'boolean', value : true,
53       description: 'install provided firmware blobs')
54option('sparse', type : 'feature', value : 'auto',
55       description: 'sparse checker')
56option('guest_agent', type : 'feature', value : 'auto',
57       description: 'Build QEMU Guest Agent')
58option('guest_agent_msi', type : 'feature', value : 'auto',
59       description: 'Build MSI package for the QEMU Guest Agent')
60option('tools', type : 'feature', value : 'auto',
61       description: 'build support utilities that come with QEMU')
62option('qga_vss', type : 'feature', value: 'auto',
63       description: 'build QGA VSS support (broken with MinGW)')
64
65option('malloc_trim', type : 'feature', value : 'auto',
66       description: 'enable libc malloc_trim() for memory optimization')
67option('malloc', type : 'combo', choices : ['system', 'tcmalloc', 'jemalloc'],
68       value: 'system', description: 'choose memory allocator to use')
69
70option('kvm', type: 'feature', value: 'auto',
71       description: 'KVM acceleration support')
72option('whpx', type: 'feature', value: 'auto',
73       description: 'WHPX acceleration support')
74option('hvf', type: 'feature', value: 'auto',
75       description: 'HVF acceleration support')
76option('nvmm', type: 'feature', value: 'auto',
77       description: 'NVMM acceleration support')
78option('xen', type: 'feature', value: 'auto',
79       description: 'Xen backend support')
80option('xen_pci_passthrough', type: 'feature', value: 'auto',
81       description: 'Xen PCI passthrough support')
82option('tcg', type: 'feature', value: 'enabled',
83       description: 'TCG support')
84option('plugins', type: 'boolean', value: false,
85       description: 'TCG plugins via shared library loading')
86option('debug_tcg', type: 'boolean', value: false,
87       description: 'TCG debugging')
88option('debug_remap', type: 'boolean', value: false,
89       description: 'syscall buffer debugging support')
90option('tcg_interpreter', type: 'boolean', value: false,
91       description: 'TCG with bytecode interpreter (slow)')
92option('safe_stack', type: 'boolean', value: false,
93       description: 'SafeStack Stack Smash Protection (requires clang/llvm and coroutine backend ucontext)')
94option('asan', type: 'boolean', value: false,
95       description: 'enable address sanitizer')
96option('ubsan', type: 'boolean', value: false,
97       description: 'enable undefined behaviour sanitizer')
98option('tsan', type: 'boolean', value: false,
99       description: 'enable thread sanitizer')
100option('stack_protector', type: 'feature', value: 'auto',
101       description: 'compiler-provided stack protection')
102option('cfi', type: 'boolean', value: false,
103       description: 'Control-Flow Integrity (CFI)')
104option('cfi_debug', type: 'boolean', value: false,
105       description: 'Verbose errors in case of CFI violation')
106option('multiprocess', type: 'feature', value: 'auto',
107       description: 'Out of process device emulation support')
108option('relocatable', type : 'boolean', value : true,
109       description: 'toggle relocatable install')
110option('vfio_user_server', type: 'feature', value: 'disabled',
111       description: 'vfio-user server support')
112option('dbus_display', type: 'feature', value: 'auto',
113       description: '-display dbus support')
114option('tpm', type : 'feature', value : 'auto',
115       description: 'TPM support')
116
117# Do not enable it by default even for Mingw32, because it doesn't
118# work on Wine.
119option('membarrier', type: 'feature', value: 'disabled',
120       description: 'membarrier system call (for Linux 4.14+ or Windows')
121
122option('avx2', type: 'feature', value: 'auto',
123       description: 'AVX2 optimizations')
124option('avx512bw', type: 'feature', value: 'auto',
125       description: 'AVX512BW optimizations')
126option('keyring', type: 'feature', value: 'auto',
127       description: 'Linux keyring support')
128option('libkeyutils', type: 'feature', value: 'auto',
129       description: 'Linux keyutils support')
130
131option('af_xdp', type : 'feature', value : 'auto',
132       description: 'AF_XDP network backend support')
133option('attr', type : 'feature', value : 'auto',
134       description: 'attr/xattr support')
135option('auth_pam', type : 'feature', value : 'auto',
136       description: 'PAM access control')
137option('brlapi', type : 'feature', value : 'auto',
138       description: 'brlapi character device driver')
139option('bzip2', type : 'feature', value : 'auto',
140       description: 'bzip2 support for DMG images')
141option('cap_ng', type : 'feature', value : 'auto',
142       description: 'cap_ng support')
143option('blkio', type : 'feature', value : 'auto',
144       description: 'libblkio block device driver')
145option('bpf', type : 'feature', value : 'auto',
146        description: 'eBPF support')
147option('cocoa', type : 'feature', value : 'auto',
148       description: 'Cocoa user interface (macOS only)')
149option('curl', type : 'feature', value : 'auto',
150       description: 'CURL block device driver')
151option('gio', type : 'feature', value : 'auto',
152       description: 'use libgio for D-Bus support')
153option('glusterfs', type : 'feature', value : 'auto',
154       description: 'Glusterfs block device driver')
155option('hv_balloon', type : 'feature', value : 'auto',
156       description: 'hv-balloon driver (requires Glib 2.68+ GTree API)')
157option('libdw', type : 'feature', value : 'auto',
158       description: 'debuginfo support')
159option('libiscsi', type : 'feature', value : 'auto',
160       description: 'libiscsi userspace initiator')
161option('libnfs', type : 'feature', value : 'auto',
162       description: 'libnfs block device driver')
163option('mpath', type : 'feature', value : 'auto',
164       description: 'Multipath persistent reservation passthrough')
165option('numa', type : 'feature', value : 'auto',
166       description: 'libnuma support')
167option('iconv', type : 'feature', value : 'auto',
168       description: 'Font glyph conversion support')
169option('curses', type : 'feature', value : 'auto',
170       description: 'curses UI')
171option('libcbor', type : 'feature', value : 'auto',
172       description: 'libcbor support')
173option('gnutls', type : 'feature', value : 'auto',
174       description: 'GNUTLS cryptography support')
175option('nettle', type : 'feature', value : 'auto',
176       description: 'nettle cryptography support')
177option('gcrypt', type : 'feature', value : 'auto',
178       description: 'libgcrypt cryptography support')
179option('crypto_afalg', type : 'feature', value : 'disabled',
180       description: 'Linux AF_ALG crypto backend driver')
181option('libdaxctl', type : 'feature', value : 'auto',
182       description: 'libdaxctl support')
183option('libpmem', type : 'feature', value : 'auto',
184       description: 'libpmem support')
185option('libssh', type : 'feature', value : 'auto',
186       description: 'ssh block device support')
187option('libudev', type : 'feature', value : 'auto',
188       description: 'Use libudev to enumerate host devices')
189option('libusb', type : 'feature', value : 'auto',
190       description: 'libusb support for USB passthrough')
191option('linux_aio', type : 'feature', value : 'auto',
192       description: 'Linux AIO support')
193option('linux_io_uring', type : 'feature', value : 'auto',
194       description: 'Linux io_uring support')
195option('lzfse', type : 'feature', value : 'auto',
196       description: 'lzfse support for DMG images')
197option('lzo', type : 'feature', value : 'auto',
198       description: 'lzo compression support')
199option('rbd', type : 'feature', value : 'auto',
200       description: 'Ceph block device driver')
201option('opengl', type : 'feature', value : 'auto',
202       description: 'OpenGL support')
203option('rdma', type : 'feature', value : 'auto',
204       description: 'Enable RDMA-based migration')
205option('gtk', type : 'feature', value : 'auto',
206       description: 'GTK+ user interface')
207option('sdl', type : 'feature', value : 'auto',
208       description: 'SDL user interface')
209option('sdl_image', type : 'feature', value : 'auto',
210       description: 'SDL Image support for icons')
211option('seccomp', type : 'feature', value : 'auto',
212       description: 'seccomp support')
213option('smartcard', type : 'feature', value : 'auto',
214       description: 'CA smartcard emulation support')
215option('snappy', type : 'feature', value : 'auto',
216       description: 'snappy compression support')
217option('spice', type : 'feature', value : 'auto',
218       description: 'Spice server support')
219option('spice_protocol', type : 'feature', value : 'auto',
220       description: 'Spice protocol support')
221option('u2f', type : 'feature', value : 'auto',
222       description: 'U2F emulation support')
223option('canokey', type : 'feature', value : 'auto',
224       description: 'CanoKey support')
225option('usb_redir', type : 'feature', value : 'auto',
226       description: 'libusbredir support')
227option('l2tpv3', type : 'feature', value : 'auto',
228       description: 'l2tpv3 network backend support')
229option('netmap', type : 'feature', value : 'auto',
230       description: 'netmap network backend support')
231option('pixman', type : 'feature', value : 'auto',
232       description: 'pixman support')
233option('slirp', type: 'feature', value: 'auto',
234       description: 'libslirp user mode network backend support')
235option('vde', type : 'feature', value : 'auto',
236       description: 'vde network backend support')
237option('vmnet', type : 'feature', value : 'auto',
238       description: 'vmnet.framework network backend support')
239option('virglrenderer', type : 'feature', value : 'auto',
240       description: 'virgl rendering support')
241option('rutabaga_gfx', type : 'feature', value : 'auto',
242       description: 'rutabaga_gfx support')
243option('png', type : 'feature', value : 'auto',
244       description: 'PNG support with libpng')
245option('vnc', type : 'feature', value : 'auto',
246       description: 'VNC server')
247option('vnc_jpeg', type : 'feature', value : 'auto',
248       description: 'JPEG lossy compression for VNC server')
249option('vnc_sasl', type : 'feature', value : 'auto',
250       description: 'SASL authentication for VNC server')
251option('vte', type : 'feature', value : 'auto',
252       description: 'vte support for the gtk UI')
253
254# GTK Clipboard implementation is disabled by default, since it may cause hangs
255# of the guest VCPUs. See gitlab issue 1150:
256# https://gitlab.com/qemu-project/qemu/-/issues/1150
257
258option('gtk_clipboard', type: 'feature', value : 'disabled',
259       description: 'clipboard support for the gtk UI (EXPERIMENTAL, MAY HANG)')
260option('xkbcommon', type : 'feature', value : 'auto',
261       description: 'xkbcommon support')
262option('zstd', type : 'feature', value : 'auto',
263       description: 'zstd compression support')
264option('qpl', type : 'feature', value : 'auto',
265       description: 'Query Processing Library support')
266option('uadk', type : 'feature', value : 'auto',
267       description: 'UADK Library support')
268option('qatzip', type: 'feature', value: 'auto',
269       description: 'QATzip compression support')
270option('fuse', type: 'feature', value: 'auto',
271       description: 'FUSE block device export')
272option('fuse_lseek', type : 'feature', value : 'auto',
273       description: 'SEEK_HOLE/SEEK_DATA support for FUSE exports')
274
275option('trace_backends', type: 'array', value: ['log'],
276       choices: ['dtrace', 'ftrace', 'log', 'nop', 'simple', 'syslog', 'ust'],
277       description: 'Set available tracing backends')
278
279option('alsa', type: 'feature', value: 'auto',
280       description: 'ALSA sound support')
281option('coreaudio', type: 'feature', value: 'auto',
282       description: 'CoreAudio sound support')
283option('dsound', type: 'feature', value: 'auto',
284       description: 'DirectSound sound support')
285option('jack', type: 'feature', value: 'auto',
286       description: 'JACK sound support')
287option('oss', type: 'feature', value: 'auto',
288       description: 'OSS sound support')
289option('pa', type: 'feature', value: 'auto',
290       description: 'PulseAudio sound support')
291option('pipewire', type: 'feature', value: 'auto',
292       description: 'PipeWire sound support')
293option('sndio', type: 'feature', value: 'auto',
294       description: 'sndio sound support')
295
296option('vhost_kernel', type: 'feature', value: 'auto',
297       description: 'vhost kernel backend support')
298option('vhost_net', type: 'feature', value: 'auto',
299       description: 'vhost-net kernel acceleration support')
300option('vhost_user', type: 'feature', value: 'auto',
301       description: 'vhost-user backend support')
302option('vhost_crypto', type: 'feature', value: 'auto',
303       description: 'vhost-user crypto backend support')
304option('vhost_vdpa', type: 'feature', value: 'auto',
305       description: 'vhost-vdpa kernel backend support')
306option('vhost_user_blk_server', type: 'feature', value: 'auto',
307       description: 'build vhost-user-blk server')
308option('virtfs', type: 'feature', value: 'auto',
309       description: 'virtio-9p support')
310option('libvduse', type: 'feature', value: 'auto',
311       description: 'build VDUSE Library')
312option('vduse_blk_export', type: 'feature', value: 'auto',
313       description: 'VDUSE block export support')
314
315option('capstone', type: 'feature', value: 'auto',
316       description: 'Whether and how to find the capstone library')
317option('fdt', type: 'combo', value: 'auto',
318       choices: ['disabled', 'enabled', 'auto', 'system', 'internal'],
319       description: 'Whether and how to find the libfdt library')
320
321option('selinux', type: 'feature', value: 'auto',
322       description: 'SELinux support in qemu-nbd')
323option('replication', type: 'feature', value: 'auto',
324       description: 'replication support')
325option('colo_proxy', type: 'feature', value: 'auto',
326       description: 'colo-proxy support')
327option('bochs', type: 'feature', value: 'auto',
328       description: 'bochs image format support')
329option('cloop', type: 'feature', value: 'auto',
330       description: 'cloop image format support')
331option('dmg', type: 'feature', value: 'auto',
332       description: 'dmg image format support')
333option('qcow1', type: 'feature', value: 'auto',
334       description: 'qcow1 image format support')
335option('vdi', type: 'feature', value: 'auto',
336       description: 'vdi image format support')
337option('vhdx', type: 'feature', value: 'auto',
338       description: 'vhdx image format support')
339option('vmdk', type: 'feature', value: 'auto',
340       description: 'vmdk image format support')
341option('vpc', type: 'feature', value: 'auto',
342       description: 'vpc image format support')
343option('vvfat', type: 'feature', value: 'auto',
344       description: 'vvfat image format support')
345option('qed', type: 'feature', value: 'auto',
346       description: 'qed image format support')
347option('parallels', type: 'feature', value: 'auto',
348       description: 'parallels image format support')
349option('block_drv_whitelist_in_tools', type: 'boolean', value: false,
350       description: 'use block whitelist also in tools instead of only QEMU')
351option('rng_none', type: 'boolean', value: false,
352       description: 'dummy RNG, avoid using /dev/(u)random and getrandom()')
353option('coroutine_pool', type: 'boolean', value: true,
354       description: 'coroutine freelist (better performance)')
355option('debug_graph_lock', type: 'boolean', value: false,
356       description: 'graph lock debugging support')
357option('debug_mutex', type: 'boolean', value: false,
358       description: 'mutex debugging support')
359option('debug_stack_usage', type: 'boolean', value: false,
360       description: 'measure coroutine stack usage')
361option('qom_cast_debug', type: 'boolean', value: true,
362       description: 'cast debugging support')
363option('slirp_smbd', type : 'feature', value : 'auto',
364       description: 'use smbd (at path --smbd=*) in slirp networking')
365
366option('qemu_ga_manufacturer', type: 'string', value: 'QEMU',
367       description: '"manufacturer" name for qemu-ga registry entries')
368option('qemu_ga_distro', type: 'string', value: 'Linux',
369       description: 'second path element in qemu-ga registry entries')
370option('qemu_ga_version', type: 'string', value: '',
371       description: 'version number for qemu-ga installer')
372
373option('hexagon_idef_parser', type : 'boolean', value : true,
374       description: 'use idef-parser to automatically generate TCG code for the Hexagon frontend')
375
376option('x86_version', type : 'combo', choices : ['0', '1', '2', '3', '4'], value: '1',
377       description: 'tweak required x86_64 architecture version beyond compiler default')
378
379option('rust', type: 'feature', value: 'disabled',
380       description: 'Rust support')
381