xref: /freebsd/share/mk/src.opts.mk (revision 2ad756a6) 
1#
2# Option file for FreeBSD /usr/src builds, at least the userland and boot loader
3# portions of the tree. These options generally chose what parts of the tree to
4# include or omit and are FreeBSD source tree specific.
5#
6# Users define WITH_FOO and WITHOUT_FOO on the command line or in /etc/src.conf
7# and /etc/make.conf files. These translate in the build system to MK_FOO={yes,no}
8# with sensible (usually) defaults.
9#
10# Makefiles must include bsd.opts.mk after defining specific MK_FOO options that
11# are applicable for that Makefile (typically there are none, but sometimes there
12# are exceptions). Recursive makes usually add MK_FOO=no for options that they wish
13# to omit from that make.
14#
15# Makefiles must include bsd.mkopt.mk before they test the value of any MK_FOO
16# variable.
17#
18# Makefiles may also assume that this file is included by src.opts.mk should it
19# need variables defined there prior to the end of the Makefile where
20# bsd.{subdir,lib.bin}.mk is traditionally included.
21#
22# The old-style YES_FOO and NO_FOO are being phased out. No new instances of them
23# should be added. Old instances should be removed since they were just to
24# bridge the gap between FreeBSD 4 and FreeBSD 5.
25#
26# Makefiles should never test WITH_FOO or WITHOUT_FOO directly (although an
27# exception is made for _WITHOUT_SRCONF which turns off this mechanism
28# completely inside bsd.*.mk files).
29#
30
31.if !target(__<src.opts.mk>__)
32__<src.opts.mk>__:
33
34.include <bsd.own.mk>
35
36#
37# Define MK_* variables (which are either "yes" or "no") for users
38# to set via WITH_*/WITHOUT_* in /etc/src.conf and override in the
39# make(1) environment.
40# These should be tested with `== "no"' or `!= "no"' in makefiles.
41# The NO_* variables should only be set by makefiles for variables
42# that haven't been converted over.
43#
44
45# These options are used by the src builds. Those listed in
46# __DEFAULT_YES_OPTIONS default to 'yes' and will build unless turned
47# off.  __DEFAULT_NO_OPTIONS will default to 'no' and won't build
48# unless turned on. Any options listed in 'BROKEN_OPTIONS' will be
49# hard-wired to 'no'.  "Broken" here means not working or
50# not-appropriate and/or not supported. It doesn't imply something is
51# wrong with the code. There's not a single good word for this, so
52# BROKEN was selected as the least imperfect one considered at the
53# time. Options are added to BROKEN_OPTIONS list on a per-arch basis.
54# At this time, there's no provision for mutually incompatible options.
55# Options listed in 'REQUIRED_OPTIONS' will be hard-wired to 'yes'; this
56# is intended as a transitional measure while options are in the process
57# of being removed.
58
59__DEFAULT_YES_OPTIONS = \
60    ACCT \
61    ACPI \
62    APM \
63    AT \
64    AUDIT \
65    AUTHPF \
66    AUTOFS \
67    BHYVE \
68    BLACKLIST \
69    BLUETOOTH \
70    BOOT \
71    BOOTPARAMD \
72    BOOTPD \
73    BSD_CPIO \
74    BSDINSTALL \
75    BSNMP \
76    BZIP2 \
77    CALENDAR \
78    CAROOT \
79    CCD \
80    CDDL \
81    CLANG \
82    CLANG_BOOTSTRAP \
83    CLEAN \
84    CPP \
85    CROSS_COMPILER \
86    CRYPT \
87    CUSE \
88    CXGBETOOL \
89    DIALOG \
90    DICT \
91    DMAGENT \
92    DTRACE \
93    DYNAMICROOT \
94    EE \
95    EFI \
96    ELFTOOLCHAIN_BOOTSTRAP \
97    EXAMPLES \
98    FILE \
99    FINGER \
100    FLOPPY \
101    FORTH \
102    FP_LIBC \
103    FREEBSD_UPDATE \
104    FTP \
105    GAMES \
106    GH_BC \
107    GNU_DIFF \
108    GOOGLETEST \
109    GPIO \
110    HAST \
111    HTML \
112    HYPERV \
113    ICONV \
114    INET \
115    INET6 \
116    INETD \
117    IPFILTER \
118    IPFW \
119    ISCSI \
120    JAIL \
121    KDUMP \
122    KVM \
123    LDNS \
124    LDNS_UTILS \
125    LEGACY_CONSOLE \
126    LLD \
127    LLD_BOOTSTRAP \
128    LLD_IS_LD \
129    LLVM_ASSERTIONS \
130    LLVM_COV \
131    LLVM_CXXFILT \
132    LOADER_GELI \
133    LOADER_KBOOT \
134    LOADER_LUA \
135    LOADER_OFW \
136    LOADER_UBOOT \
137    LOCALES \
138    LOCATE \
139    LPR \
140    LS_COLORS \
141    MACHDEP_OPTIMIZATIONS \
142    MAIL \
143    MAILWRAPPER \
144    MAKE \
145    MLX5TOOL \
146    NETCAT \
147    NETGRAPH \
148    NETLINK \
149    NETLINK_SUPPORT \
150    NLS_CATALOGS \
151    NS_CACHING \
152    NTP \
153    NVME \
154    OFED \
155    OPENSSL \
156    PAM \
157    PF \
158    PKGBOOTSTRAP \
159    PMC \
160    PPP \
161    PTHREADS_ASSERTIONS \
162    QUOTAS \
163    RADIUS_SUPPORT \
164    RBOOTD \
165    RESCUE \
166    ROUTED \
167    SENDMAIL \
168    SERVICESDB \
169    SETUID_LOGIN \
170    SHAREDOCS \
171    SOURCELESS \
172    SOURCELESS_HOST \
173    SOURCELESS_UCODE \
174    STATS \
175    SYSCONS \
176    SYSTEM_COMPILER \
177    SYSTEM_LINKER \
178    TALK \
179    TCP_WRAPPERS \
180    TCSH \
181    TELNET \
182    TEXTPROC \
183    TFTP \
184    UNBOUND \
185    USB \
186    UTMPX \
187    VI \
188    VT \
189    WIRELESS \
190    WPA_SUPPLICANT_EAPOL \
191    ZFS \
192    LOADER_ZFS \
193    ZONEINFO
194
195__DEFAULT_NO_OPTIONS = \
196    BEARSSL \
197    BHYVE_SNAPSHOT \
198    CLANG_EXTRAS \
199    CLANG_FORMAT \
200    DETECT_TZ_CHANGES \
201    DISK_IMAGE_TOOLS_BOOTSTRAP \
202    DTRACE_ASAN \
203    DTRACE_TESTS \
204    EXPERIMENTAL \
205    HESIOD \
206    LOADER_VERBOSE \
207    LOADER_VERIEXEC_PASS_MANIFEST \
208    LLVM_BINUTILS \
209    MALLOC_PRODUCTION \
210    OFED_EXTRA \
211    OPENLDAP \
212    REPRODUCIBLE_BUILD \
213    RPCBIND_WARMSTART_SUPPORT \
214    SORT_THREADS \
215    ZONEINFO_LEAPSECONDS_SUPPORT \
216
217__REQUIRED_OPTIONS = \
218    CAPSICUM \
219    CASPER
220
221# LEFT/RIGHT. Left options which default to "yes" unless their corresponding
222# RIGHT option is disabled.
223__DEFAULT_DEPENDENT_OPTIONS= \
224	CLANG_FULL/CLANG \
225	LLVM_TARGET_ALL/CLANG \
226	LOADER_VERIEXEC/BEARSSL \
227	LOADER_EFI_SECUREBOOT/LOADER_VERIEXEC \
228	LOADER_VERIEXEC_VECTX/LOADER_VERIEXEC \
229	VERIEXEC/BEARSSL \
230
231__SINGLE_OPTIONS = \
232	LIBC_MALLOC
233
234__LIBC_MALLOC_OPTIONS=	jemalloc
235__LIBC_MALLOC_DEFAULT=	jemalloc
236
237# MK_*_SUPPORT options which default to "yes" unless their corresponding
238# MK_* variable is set to "no".
239#
240.for var in \
241    BLACKLIST \
242    BZIP2 \
243    INET \
244    INET6 \
245    KERBEROS \
246    KVM \
247    NETGRAPH \
248    PAM \
249    TESTS \
250    WIRELESS
251__DEFAULT_DEPENDENT_OPTIONS+= ${var}_SUPPORT/${var}
252.endfor
253
254#
255# Default behaviour of some options depends on the architecture.  Unfortunately
256# this means that we have to test TARGET_ARCH (the buildworld case) as well
257# as MACHINE_ARCH (the non-buildworld case).  Normally TARGET_ARCH is not
258# used at all in bsd.*.mk, but we have to make an exception here if we want
259# to allow defaults for some things like clang to vary by target architecture.
260# Additional, per-target behavior should be rarely added only after much
261# gnashing of teeth and grinding of gears.
262#
263.if defined(TARGET_ARCH)
264__T=${TARGET_ARCH}
265.else
266__T=${MACHINE_ARCH}
267.endif
268
269# All supported backends for LLVM_TARGET_XXX
270__LLVM_TARGETS= \
271		aarch64 \
272		arm \
273		powerpc \
274		riscv \
275		x86
276__LLVM_TARGET_FILT=	C/(amd64|i386)/x86/:C/powerpc.*/powerpc/:C/armv[67]/arm/:C/riscv.*/riscv/
277.for __llt in ${__LLVM_TARGETS}
278# Default enable the given TARGET's LLVM_TARGET support
279.if ${__T:${__LLVM_TARGET_FILT}} == ${__llt}
280__DEFAULT_YES_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}
281# aarch64 needs arm for -m32 support.
282.elif ${__T} == "aarch64" && ${__llt:Marm*} != ""
283__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_ARM/LLVM_TARGET_AARCH64
284# Default the rest of the LLVM_TARGETs to the value of MK_LLVM_TARGET_ALL.
285.else
286__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}/LLVM_TARGET_ALL
287.endif
288.endfor
289
290__DEFAULT_NO_OPTIONS+=LLVM_TARGET_BPF LLVM_TARGET_MIPS
291
292.include <bsd.compiler.mk>
293
294.if ${__T} == "i386" || ${__T} == "amd64"
295__DEFAULT_NO_OPTIONS += FDT
296.else
297__DEFAULT_YES_OPTIONS += FDT
298.endif
299
300.if ${__T:Marm*} == "" && ${__T:Mriscv64*} == ""
301__DEFAULT_YES_OPTIONS+=LLDB
302.else
303__DEFAULT_NO_OPTIONS+=LLDB
304.endif
305# LIB32 is not supported on all 64-bit architectures.
306.if (${__T} == "amd64" || ${__T:Maarch64*} != "" || ${__T} == "powerpc64")
307__DEFAULT_YES_OPTIONS+=LIB32
308.else
309BROKEN_OPTIONS+=LIB32
310.endif
311# EFI doesn't exist on powerpc (well, officially) and doesn't work on i386
312.if ${__T:Mpowerpc*} || ${__T} == "i386"
313BROKEN_OPTIONS+=EFI
314.endif
315# OFW is only for powerpc, exclude others
316.if ${__T:Mpowerpc*} == ""
317BROKEN_OPTIONS+=LOADER_OFW
318.endif
319# KBOOT is only for powerpc64 (powerpc64le broken) amd64 and aarch64
320.if ${__T} != "powerpc64" && ${__T} != "amd64" && ${__T} != "aarch64"
321BROKEN_OPTIONS+=LOADER_KBOOT
322.endif
323# UBOOT is only for arm, and big-endian powerpc
324.if (${__T:Marm*} == "" && ${__T:Mpowerpc*} == "") || ${__T} == "powerpc64le"
325BROKEN_OPTIONS+=LOADER_UBOOT
326.endif
327# GELI and Lua in loader currently cause boot failures on powerpc.
328# Further debugging is required -- probably they are just broken on big
329# endian systems generically (they jump to null pointers or try to read
330# crazy high addresses, which is typical of endianness problems).
331.if ${__T:Mpowerpc*}
332BROKEN_OPTIONS+=LOADER_GELI LOADER_LUA
333.endif
334
335# Kernel TLS is enabled by default on amd64, aarch64 and powerpc64*
336.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T:Mpowerpc64*} != ""
337__DEFAULT_YES_OPTIONS+=OPENSSL_KTLS
338.else
339__DEFAULT_NO_OPTIONS+=OPENSSL_KTLS
340.endif
341
342.if ${__T} != "aarch64" && ${__T} != "amd64" && ${__T} != "i386" && \
343    ${__T:Mpowerpc64*} == ""
344BROKEN_OPTIONS+=CXGBETOOL
345BROKEN_OPTIONS+=MLX5TOOL
346.endif
347
348.if ${__T} != "amd64" && ${__T} != "i386" && ${__T} != "aarch64"
349BROKEN_OPTIONS+=HYPERV
350.endif
351
352# NVME is only aarch64, x86 and powerpc64*
353.if ${__T} != "aarch64" && ${__T} != "amd64" && ${__T} != "i386" && \
354    ${__T:Mpowerpc64*} == ""
355BROKEN_OPTIONS+=NVME
356.endif
357
358.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T} == "i386" || \
359    ${__T:Mpowerpc64*} != "" || ${__T:Mriscv64*} != ""
360__DEFAULT_YES_OPTIONS+=OPENMP
361.else
362__DEFAULT_NO_OPTIONS+=OPENMP
363.endif
364
365# Broken on 32-bit arm, kernel module compile errors
366.if ${__T:Marm*} != ""
367BROKEN_OPTIONS+= OFED
368.endif
369
370# MK_host_egacy is set by local.sys.mk so is valid here
371.if ${MACHINE} == "host" && ${MK_host_egacy} == "yes"
372# we cannot expect tests to work
373BROKEN_OPTIONS+= TESTS
374.endif
375
376.-include <site.src.opts.mk>
377
378.include <bsd.mkopt.mk>
379
380#
381# Force some options off if their dependencies are off.
382# Order is somewhat important.
383#
384.if ${MK_CAPSICUM} == "no"
385MK_CASPER:=	no
386.endif
387
388.if ${MK_SOURCELESS} == "no"
389MK_SOURCELESS_HOST:=	no
390MK_SOURCELESS_UCODE:= no
391.endif
392
393.if ${MK_CDDL} == "no"
394MK_CTF:=	no
395MK_DTRACE:=	no
396MK_LOADER_ZFS:=	no
397MK_ZFS:=	no
398.endif
399
400.if ${MK_CRYPT} == "no"
401MK_OPENSSL:=	no
402MK_OPENSSH:=	no
403MK_KERBEROS:=	no
404MK_KERBEROS_SUPPORT:=	no
405.endif
406
407.if ${MK_DIALOG} == "no"
408MK_BSDINSTALL:=	no
409.endif
410
411.if ${MK_DTRACE} == "no"
412MK_CTF:=	no
413.endif
414
415.if ${MK_MAIL} == "no"
416MK_MAILWRAPPER:= no
417MK_SENDMAIL:=	no
418MK_DMAGENT:=	no
419.endif
420
421.if ${MK_NETGRAPH} == "no"
422MK_BLUETOOTH:=	no
423.endif
424
425.if ${MK_NLS} == "no"
426MK_NLS_CATALOGS:= no
427.endif
428
429.if ${MK_OPENSSL} == "no"
430MK_DMAGENT:=	no
431MK_OPENSSH:=	no
432MK_OPENSSL_KTLS:=	no
433MK_KERBEROS:=	no
434MK_KERBEROS_SUPPORT:=	no
435MK_LDNS:=	no
436MK_PKGBOOTSTRAP:=	no
437MK_LOADER_ZFS:=	no
438MK_ZFS:=	no
439.endif
440
441.if ${MK_LDNS} == "no"
442MK_LDNS_UTILS:=	no
443MK_UNBOUND:= no
444.endif
445
446.if ${MK_PF} == "no"
447MK_AUTHPF:=	no
448.endif
449
450.if ${MK_OFED} == "no"
451MK_OFED_EXTRA:=	no
452.endif
453
454.if ${MK_TESTS} == "no"
455MK_DTRACE_TESTS:= no
456.endif
457
458.if ${MK_TESTS_SUPPORT} == "no"
459MK_GOOGLETEST:=	no
460.endif
461
462.if ${MK_ZONEINFO} == "no"
463MK_ZONEINFO_LEAPSECONDS_SUPPORT:= no
464.endif
465
466.if ${MK_CROSS_COMPILER} == "no"
467MK_CLANG_BOOTSTRAP:= no
468MK_ELFTOOLCHAIN_BOOTSTRAP:= no
469MK_LLD_BOOTSTRAP:= no
470.endif
471
472.if ${MK_TOOLCHAIN} == "no"
473MK_CLANG:=	no
474MK_LLD:=	no
475MK_LLDB:=	no
476MK_LLVM_BINUTILS:=	no
477.endif
478
479.if ${MK_CLANG} == "no"
480MK_CLANG_EXTRAS:= no
481MK_CLANG_FORMAT:= no
482MK_CLANG_FULL:= no
483MK_LLVM_COV:= no
484.endif
485
486.if ${MK_ASAN} == "yes"
487# In order to get sensible backtraces from ASAN we have to install
488# llvm-symbolizer as /usr/bin/addr2line instead of the elftoolchain version.
489MK_LLVM_BINUTILS:=	yes
490.endif
491
492.if ${MK_LLVM_BINUTILS} == "yes"
493# MK_LLVM_CXXFILT is a subset of MK_LLVM_BINUTILS and should therefore be
494# enabled if MK_LLVM_BINUTILS is set.
495MK_LLVM_CXXFILT:=	yes
496.endif
497
498.if ${MK_LOADER_VERIEXEC} == "no"
499MK_LOADER_VERIEXEC_PASS_MANIFEST := no
500.endif
501
502#
503# MK_* options whose default value depends on another option.
504#
505.for vv in \
506    GSSAPI/KERBEROS \
507    MAN_UTILS/MAN
508.if defined(WITH_${vv:H})
509MK_${vv:H}:=	yes
510.elif defined(WITHOUT_${vv:H})
511MK_${vv:H}:=	no
512.else
513MK_${vv:H}:=	${MK_${vv:T}}
514.endif
515.endfor
516
517#
518# Set defaults for the MK_*_SUPPORT variables.
519#
520
521.endif #  !target(__<src.opts.mk>__)
522