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