xref: /freebsd/share/mk/src.opts.mk (revision 70bc3f4331a1b6e7045ae5326cbe03428503b612) 
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# Options listed in 'REQUIRED_OPTIONS' will be hard-wired to 'yes'; this
57# is intended as a transitional measure while options are in the process
58# of being removed.
59
60__DEFAULT_YES_OPTIONS = \
61    ACCT \
62    ACPI \
63    APM \
64    AT \
65    AUDIT \
66    AUTHPF \
67    AUTOFS \
68    BHYVE \
69    BLACKLIST \
70    BLUETOOTH \
71    BOOT \
72    BOOTPARAMD \
73    BOOTPD \
74    BSD_CPIO \
75    BSDINSTALL \
76    BSNMP \
77    BZIP2 \
78    CALENDAR \
79    CAROOT \
80    CCD \
81    CDDL \
82    CLANG \
83    CLANG_BOOTSTRAP \
84    CLEAN \
85    CPP \
86    CROSS_COMPILER \
87    CRYPT \
88    CUSE \
89    CXGBETOOL \
90    DIALOG \
91    DICT \
92    DMAGENT \
93    DTRACE \
94    DYNAMICROOT \
95    EE \
96    EFI \
97    ELFTOOLCHAIN_BOOTSTRAP \
98    EXAMPLES \
99    FILE \
100    FINGER \
101    FLOPPY \
102    FORTH \
103    FP_LIBC \
104    FREEBSD_UPDATE \
105    FTP \
106    GAMES \
107    GH_BC \
108    GNU_DIFF \
109    GOOGLETEST \
110    GPIO \
111    HAST \
112    HTML \
113    HYPERV \
114    ICONV \
115    INET \
116    INET6 \
117    INETD \
118    IPFILTER \
119    IPFW \
120    ISCSI \
121    JAIL \
122    KDUMP \
123    KVM \
124    LDNS \
125    LDNS_UTILS \
126    LEGACY_CONSOLE \
127    LLD \
128    LLD_BOOTSTRAP \
129    LLD_IS_LD \
130    LLVM_ASSERTIONS \
131    LLVM_COV \
132    LLVM_CXXFILT \
133    LOADER_GELI \
134    LOADER_KBOOT \
135    LOADER_LUA \
136    LOADER_OFW \
137    LOADER_UBOOT \
138    LOCALES \
139    LOCATE \
140    LPR \
141    LS_COLORS \
142    MACHDEP_OPTIMIZATIONS \
143    MAIL \
144    MAILWRAPPER \
145    MAKE \
146    MLX5TOOL \
147    NETCAT \
148    NETGRAPH \
149    NETLINK \
150    NETLINK_SUPPORT \
151    NLS_CATALOGS \
152    NS_CACHING \
153    NTP \
154    NVME \
155    OFED \
156    OPENSSL \
157    PAM \
158    PF \
159    PKGBOOTSTRAP \
160    PMC \
161    PPP \
162    QUOTAS \
163    RADIUS_SUPPORT \
164    RBOOTD \
165    RESCUE \
166    ROUTED \
167    SENDMAIL \
168    SERVICESDB \
169    SETUID_LOGIN \
170    SHARED_TOOLCHAIN \
171    SHAREDOCS \
172    SOURCELESS \
173    SOURCELESS_HOST \
174    SOURCELESS_UCODE \
175    STATS \
176    SYSCONS \
177    SYSTEM_COMPILER \
178    SYSTEM_LINKER \
179    TALK \
180    TCP_WRAPPERS \
181    TCSH \
182    TELNET \
183    TEXTPROC \
184    TFTP \
185    UNBOUND \
186    USB \
187    UTMPX \
188    VI \
189    VT \
190    WIRELESS \
191    WPA_SUPPLICANT_EAPOL \
192    ZFS \
193    LOADER_ZFS \
194    ZONEINFO
195
196__DEFAULT_NO_OPTIONS = \
197    BEARSSL \
198    BHYVE_SNAPSHOT \
199    CLANG_EXTRAS \
200    CLANG_FORMAT \
201    DETECT_TZ_CHANGES \
202    DISK_IMAGE_TOOLS_BOOTSTRAP \
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# MK_*_SUPPORT options which default to "yes" unless their corresponding
232# MK_* variable is set to "no".
233#
234.for var in \
235    BLACKLIST \
236    BZIP2 \
237    INET \
238    INET6 \
239    KERBEROS \
240    KVM \
241    NETGRAPH \
242    PAM \
243    TESTS \
244    WIRELESS
245__DEFAULT_DEPENDENT_OPTIONS+= ${var}_SUPPORT/${var}
246.endfor
247
248#
249# Default behaviour of some options depends on the architecture.  Unfortunately
250# this means that we have to test TARGET_ARCH (the buildworld case) as well
251# as MACHINE_ARCH (the non-buildworld case).  Normally TARGET_ARCH is not
252# used at all in bsd.*.mk, but we have to make an exception here if we want
253# to allow defaults for some things like clang to vary by target architecture.
254# Additional, per-target behavior should be rarely added only after much
255# gnashing of teeth and grinding of gears.
256#
257.if defined(TARGET_ARCH)
258__T=${TARGET_ARCH}
259.else
260__T=${MACHINE_ARCH}
261.endif
262
263# All supported backends for LLVM_TARGET_XXX
264__LLVM_TARGETS= \
265		aarch64 \
266		arm \
267		powerpc \
268		riscv \
269		x86
270__LLVM_TARGET_FILT=	C/(amd64|i386)/x86/:C/powerpc.*/powerpc/:C/armv[67]/arm/:C/riscv.*/riscv/
271.for __llt in ${__LLVM_TARGETS}
272# Default enable the given TARGET's LLVM_TARGET support
273.if ${__T:${__LLVM_TARGET_FILT}} == ${__llt}
274__DEFAULT_YES_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}
275# aarch64 needs arm for -m32 support.
276.elif ${__T} == "aarch64" && ${__llt:Marm*} != ""
277__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_ARM/LLVM_TARGET_AARCH64
278# Default the rest of the LLVM_TARGETs to the value of MK_LLVM_TARGET_ALL.
279.else
280__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}/LLVM_TARGET_ALL
281.endif
282.endfor
283
284__DEFAULT_NO_OPTIONS+=LLVM_TARGET_BPF LLVM_TARGET_MIPS
285
286.include <bsd.compiler.mk>
287
288.if ${__T} == "i386" || ${__T} == "amd64"
289__DEFAULT_NO_OPTIONS += FDT
290.else
291__DEFAULT_YES_OPTIONS += FDT
292.endif
293
294.if ${__T:Marm*} == "" && ${__T:Mriscv64*} == ""
295__DEFAULT_YES_OPTIONS+=LLDB
296.else
297__DEFAULT_NO_OPTIONS+=LLDB
298.endif
299# LIB32 is supported on amd64 and powerpc64
300.if (${__T} == "amd64" || ${__T} == "powerpc64")
301__DEFAULT_YES_OPTIONS+=LIB32
302.else
303BROKEN_OPTIONS+=LIB32
304.endif
305# EFI doesn't exist on powerpc (well, officially) and doesn't work on i386
306.if ${__T:Mpowerpc*} || ${__T} == "i386"
307BROKEN_OPTIONS+=EFI
308.endif
309# OFW is only for powerpc, exclude others
310.if ${__T:Mpowerpc*} == ""
311BROKEN_OPTIONS+=LOADER_OFW
312.endif
313# KBOOT is only for powerpc64 (powerpc64le broken) amd64 and aarch64
314.if ${__T} != "powerpc64" && ${__T} != "amd64" && ${__T} != "aarch64"
315BROKEN_OPTIONS+=LOADER_KBOOT
316.endif
317# UBOOT is only for arm, and big-endian powerpc
318.if (${__T:Marm*} == "" && ${__T:Mpowerpc*} == "") || ${__T} == "powerpc64le"
319BROKEN_OPTIONS+=LOADER_UBOOT
320.endif
321# GELI and Lua in loader currently cause boot failures on powerpc.
322# Further debugging is required -- probably they are just broken on big
323# endian systems generically (they jump to null pointers or try to read
324# crazy high addresses, which is typical of endianness problems).
325.if ${__T:Mpowerpc*}
326BROKEN_OPTIONS+=LOADER_GELI LOADER_LUA
327.endif
328
329# Kernel TLS is enabled by default on amd64, aarch64 and powerpc64*
330.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T:Mpowerpc64*} != ""
331__DEFAULT_YES_OPTIONS+=OPENSSL_KTLS
332.else
333__DEFAULT_NO_OPTIONS+=OPENSSL_KTLS
334.endif
335
336.if ${__T} != "aarch64" && ${__T} != "amd64" && ${__T} != "i386" && \
337    ${__T:Mpowerpc64*} == ""
338BROKEN_OPTIONS+=CXGBETOOL
339BROKEN_OPTIONS+=MLX5TOOL
340.endif
341
342.if ${__T} != "amd64" && ${__T} != "i386" && ${__T} != "aarch64"
343BROKEN_OPTIONS+=HYPERV
344.endif
345
346# NVME is only aarch64, x86 and powerpc64*
347.if ${__T} != "aarch64" && ${__T} != "amd64" && ${__T} != "i386" && \
348    ${__T:Mpowerpc64*} == ""
349BROKEN_OPTIONS+=NVME
350.endif
351
352.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T} == "i386" || \
353    ${__T:Mpowerpc64*} != "" || ${__T:Mriscv64*} != ""
354__DEFAULT_YES_OPTIONS+=OPENMP
355.else
356__DEFAULT_NO_OPTIONS+=OPENMP
357.endif
358
359# Broken on 32-bit arm, kernel module compile errors
360.if ${__T:Marm*} != ""
361BROKEN_OPTIONS+= OFED
362.endif
363
364# MK_host_egacy is set by local.sys.mk so is valid here
365.if ${MACHINE} == "host" && ${MK_host_egacy} == "yes"
366# we cannot expect tests to work
367BROKEN_OPTIONS+= TESTS
368.endif
369
370.-include <site.src.opts.mk>
371
372.include <bsd.mkopt.mk>
373
374#
375# Force some options off if their dependencies are off.
376# Order is somewhat important.
377#
378.if ${MK_CAPSICUM} == "no"
379MK_CASPER:=	no
380.endif
381
382.if ${MK_SOURCELESS} == "no"
383MK_SOURCELESS_HOST:=	no
384MK_SOURCELESS_UCODE:= no
385.endif
386
387.if ${MK_CDDL} == "no"
388MK_CTF:=	no
389MK_DTRACE:=	no
390MK_LOADER_ZFS:=	no
391MK_ZFS:=	no
392.endif
393
394.if ${MK_CRYPT} == "no"
395MK_OPENSSL:=	no
396MK_OPENSSH:=	no
397MK_KERBEROS:=	no
398MK_KERBEROS_SUPPORT:=	no
399.endif
400
401.if ${MK_DIALOG} == "no"
402MK_BSDINSTALL:=	no
403.endif
404
405.if ${MK_DTRACE} == "no"
406MK_CTF:=	no
407.endif
408
409.if ${MK_MAIL} == "no"
410MK_MAILWRAPPER:= no
411MK_SENDMAIL:=	no
412MK_DMAGENT:=	no
413.endif
414
415.if ${MK_NETGRAPH} == "no"
416MK_BLUETOOTH:=	no
417.endif
418
419.if ${MK_NLS} == "no"
420MK_NLS_CATALOGS:= no
421.endif
422
423.if ${MK_OPENSSL} == "no"
424MK_DMAGENT:=	no
425MK_OPENSSH:=	no
426MK_OPENSSL_KTLS:=	no
427MK_KERBEROS:=	no
428MK_KERBEROS_SUPPORT:=	no
429MK_LDNS:=	no
430MK_PKGBOOTSTRAP:=	no
431MK_LOADER_ZFS:=	no
432MK_ZFS:=	no
433.endif
434
435.if ${MK_LDNS} == "no"
436MK_LDNS_UTILS:=	no
437MK_UNBOUND:= no
438.endif
439
440.if ${MK_PF} == "no"
441MK_AUTHPF:=	no
442.endif
443
444.if ${MK_OFED} == "no"
445MK_OFED_EXTRA:=	no
446.endif
447
448.if ${MK_TESTS} == "no"
449MK_DTRACE_TESTS:= no
450.endif
451
452.if ${MK_TESTS_SUPPORT} == "no"
453MK_GOOGLETEST:=	no
454.endif
455
456.if ${MK_ZONEINFO} == "no"
457MK_ZONEINFO_LEAPSECONDS_SUPPORT:= no
458.endif
459
460.if ${MK_CROSS_COMPILER} == "no"
461MK_CLANG_BOOTSTRAP:= no
462MK_ELFTOOLCHAIN_BOOTSTRAP:= no
463MK_LLD_BOOTSTRAP:= no
464.endif
465
466.if ${MK_TOOLCHAIN} == "no"
467MK_CLANG:=	no
468MK_LLD:=	no
469MK_LLDB:=	no
470MK_LLVM_BINUTILS:=	no
471.endif
472
473.if ${MK_CLANG} == "no"
474MK_CLANG_EXTRAS:= no
475MK_CLANG_FORMAT:= no
476MK_CLANG_FULL:= no
477MK_LLVM_COV:= no
478.endif
479
480.if ${MK_ASAN} == "yes"
481# In order to get sensible backtraces from ASAN we have to install
482# llvm-symbolizer as /usr/bin/addr2line instead of the elftoolchain version.
483MK_LLVM_BINUTILS:=	yes
484.endif
485
486.if ${MK_LLVM_BINUTILS} == "yes"
487# MK_LLVM_CXXFILT is a subset of MK_LLVM_BINUTILS and should therefore be
488# enabled if MK_LLVM_BINUTILS is set.
489MK_LLVM_CXXFILT:=	yes
490.endif
491
492.if ${MK_LOADER_VERIEXEC} == "no"
493MK_LOADER_VERIEXEC_PASS_MANIFEST := no
494.endif
495
496#
497# MK_* options whose default value depends on another option.
498#
499.for vv in \
500    GSSAPI/KERBEROS \
501    MAN_UTILS/MAN
502.if defined(WITH_${vv:H})
503MK_${vv:H}:=	yes
504.elif defined(WITHOUT_${vv:H})
505MK_${vv:H}:=	no
506.else
507MK_${vv:H}:=	${MK_${vv:T}}
508.endif
509.endfor
510
511#
512# Set defaults for the MK_*_SUPPORT variables.
513#
514
515.endif #  !target(__<src.opts.mk>__)
516