xref: /freebsd/share/mk/src.opts.mk (revision 4cc76d90ea259df205fec14d6bed1bfb7b0ef23e) 
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    ATM \
63    AUDIT \
64    AUTHPF \
65    AUTOFS \
66    BHYVE \
67    BLACKLIST \
68    BLUETOOTH \
69    BOOT \
70    BOOTPARAMD \
71    BOOTPD \
72    BSD_CPIO \
73    BSDINSTALL \
74    BSNMP \
75    BZIP2 \
76    CALENDAR \
77    CAPSICUM \
78    CAROOT \
79    CASPER \
80    CCD \
81    CDDL \
82    CLANG \
83    CLANG_BOOTSTRAP \
84    CLANG_IS_CC \
85    CLEAN \
86    CPP \
87    CROSS_COMPILER \
88    CRYPT \
89    CUSE \
90    CXX \
91    CXGBETOOL \
92    DIALOG \
93    DICT \
94    DMAGENT \
95    DYNAMICROOT \
96    EE \
97    EFI \
98    ELFTOOLCHAIN_BOOTSTRAP \
99    EXAMPLES \
100    FDT \
101    FILE \
102    FINGER \
103    FLOPPY \
104    FORTH \
105    FP_LIBC \
106    FREEBSD_UPDATE \
107    FTP \
108    GAMES \
109    GH_BC \
110    GNU_DIFF \
111    GOOGLETEST \
112    GPIO \
113    HAST \
114    HTML \
115    HYPERV \
116    ICONV \
117    INET \
118    INET6 \
119    INETD \
120    IPFILTER \
121    IPFW \
122    ISCSI \
123    JAIL \
124    KDUMP \
125    KVM \
126    LDNS \
127    LDNS_UTILS \
128    LEGACY_CONSOLE \
129    LLD \
130    LLD_BOOTSTRAP \
131    LLD_IS_LD \
132    LLVM_ASSERTIONS \
133    LLVM_COV \
134    LLVM_CXXFILT \
135    LOADER_GELI \
136    LOADER_KBOOT \
137    LOADER_LUA \
138    LOADER_OFW \
139    LOADER_UBOOT \
140    LOCALES \
141    LOCATE \
142    LPR \
143    LS_COLORS \
144    MAIL \
145    MAILWRAPPER \
146    MAKE \
147    MLX5TOOL \
148    NDIS \
149    NETCAT \
150    NETGRAPH \
151    NLS_CATALOGS \
152    NS_CACHING \
153    NTP \
154    NVME \
155    OFED \
156    OPENSSL \
157    PAM \
158    PF \
159    PKGBOOTSTRAP \
160    PMC \
161    PORTSNAP \
162    PPP \
163    QUOTAS \
164    RADIUS_SUPPORT \
165    RBOOTD \
166    RESCUE \
167    ROUTED \
168    SENDMAIL \
169    SERVICESDB \
170    SETUID_LOGIN \
171    SHARED_TOOLCHAIN \
172    SHAREDOCS \
173    SOURCELESS \
174    SOURCELESS_HOST \
175    SOURCELESS_UCODE \
176    STATS \
177    SYSCONS \
178    SYSTEM_COMPILER \
179    SYSTEM_LINKER \
180    TALK \
181    TCP_WRAPPERS \
182    TCSH \
183    TELNET \
184    TEXTPROC \
185    TFTP \
186    UNBOUND \
187    USB \
188    UTMPX \
189    VI \
190    VT \
191    WIRELESS \
192    WPA_SUPPLICANT_EAPOL \
193    ZFS \
194    LOADER_ZFS \
195    ZONEINFO
196
197__DEFAULT_NO_OPTIONS = \
198    BEARSSL \
199    BHYVE_SNAPSHOT \
200    CLANG_EXTRAS \
201    CLANG_FORMAT \
202    DETECT_TZ_CHANGES \
203    DTRACE_TESTS \
204    EXPERIMENTAL \
205    HESIOD \
206    LIBSOFT \
207    LOADER_FIREWIRE \
208    LOADER_VERBOSE \
209    LOADER_VERIEXEC_PASS_MANIFEST \
210    LLVM_BINUTILS \
211    MALLOC_PRODUCTION \
212    OFED_EXTRA \
213    OPENLDAP \
214    REPRODUCIBLE_BUILD \
215    RPCBIND_WARMSTART_SUPPORT \
216    SORT_THREADS \
217    ZONEINFO_LEAPSECONDS_SUPPORT \
218
219# LEFT/RIGHT. Left options which default to "yes" unless their corresponding
220# RIGHT option is disabled.
221__DEFAULT_DEPENDENT_OPTIONS= \
222	CLANG_FULL/CLANG \
223	LLVM_TARGET_ALL/CLANG \
224	LOADER_VERIEXEC/BEARSSL \
225	LOADER_EFI_SECUREBOOT/LOADER_VERIEXEC \
226	LOADER_VERIEXEC_VECTX/LOADER_VERIEXEC \
227	VERIEXEC/BEARSSL \
228
229# MK_*_SUPPORT options which default to "yes" unless their corresponding
230# MK_* variable is set to "no".
231#
232.for var in \
233    BLACKLIST \
234    BZIP2 \
235    INET \
236    INET6 \
237    KERBEROS \
238    KVM \
239    NETGRAPH \
240    PAM \
241    TESTS \
242    WIRELESS
243__DEFAULT_DEPENDENT_OPTIONS+= ${var}_SUPPORT/${var}
244.endfor
245
246#
247# Default behaviour of some options depends on the architecture.  Unfortunately
248# this means that we have to test TARGET_ARCH (the buildworld case) as well
249# as MACHINE_ARCH (the non-buildworld case).  Normally TARGET_ARCH is not
250# used at all in bsd.*.mk, but we have to make an exception here if we want
251# to allow defaults for some things like clang to vary by target architecture.
252# Additional, per-target behavior should be rarely added only after much
253# gnashing of teeth and grinding of gears.
254#
255.if defined(TARGET_ARCH)
256__T=${TARGET_ARCH}
257.else
258__T=${MACHINE_ARCH}
259.endif
260
261# All supported backends for LLVM_TARGET_XXX
262__LLVM_TARGETS= \
263		aarch64 \
264		arm \
265		powerpc \
266		riscv \
267		x86
268__LLVM_TARGET_FILT=	C/(amd64|i386)/x86/:C/powerpc.*/powerpc/:C/armv[67]/arm/:C/riscv.*/riscv/:C/mips.*/mips/
269.for __llt in ${__LLVM_TARGETS}
270# Default enable the given TARGET's LLVM_TARGET support
271.if ${__T:${__LLVM_TARGET_FILT}} == ${__llt}
272__DEFAULT_YES_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}
273# aarch64 needs arm for -m32 support.
274.elif ${__T} == "aarch64" && ${__llt:Marm*} != ""
275__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_ARM/LLVM_TARGET_AARCH64
276# Default the rest of the LLVM_TARGETs to the value of MK_LLVM_TARGET_ALL.
277.else
278__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}/LLVM_TARGET_ALL
279.endif
280.endfor
281
282__DEFAULT_NO_OPTIONS+=LLVM_TARGET_BPF LLVM_TARGET_MIPS
283
284.include <bsd.compiler.mk>
285
286.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T} == "i386"
287__DEFAULT_YES_OPTIONS+=LLDB
288.else
289__DEFAULT_NO_OPTIONS+=LLDB
290.endif
291# LIB32 is supported on amd64, mips64, and powerpc64
292.if (${__T} == "amd64" || ${__T:Mmips64*} || ${__T} == "powerpc64")
293__DEFAULT_YES_OPTIONS+=LIB32
294.else
295BROKEN_OPTIONS+=LIB32
296.endif
297# Only doing soft float API stuff on armv6 and armv7
298.if ${__T} != "armv6" && ${__T} != "armv7"
299BROKEN_OPTIONS+=LIBSOFT
300.endif
301.if ${__T:Mmips*}
302# GOOGLETEST cannot currently be compiled on mips due to external circumstances.
303# Notably, the freebsd-gcc port isn't linking in libgcc so we end up trying ot
304# link to a hidden symbol. LLVM would successfully link this in, but some of
305# the mips variants are broken under LLVM until LLVM 10. GOOGLETEST should be
306# marked no longer broken with the switch to LLVM.
307BROKEN_OPTIONS+=GOOGLETEST SSP
308.endif
309# EFI doesn't exist on mips or powerpc.
310.if ${__T:Mmips*} || ${__T:Mpowerpc*}
311BROKEN_OPTIONS+=EFI
312.endif
313# OFW is only for powerpc, exclude others
314.if ${__T:Mpowerpc*} == ""
315BROKEN_OPTIONS+=LOADER_OFW
316.endif
317# KBOOT is only for powerpc64 (powerpc64le broken)
318.if ${__T} != "powerpc64"
319BROKEN_OPTIONS+=LOADER_KBOOT
320.endif
321# UBOOT is only for arm, and big-endian powerpc
322.if (${__T:Marm*} == "" && ${__T:Mpowerpc*} == "") || ${__T} == "powerpc64le"
323BROKEN_OPTIONS+=LOADER_UBOOT
324.endif
325# GELI and Lua in loader currently cause boot failures on powerpc.
326# Further debugging is required -- probably they are just broken on big
327# endian systems generically (they jump to null pointers or try to read
328# crazy high addresses, which is typical of endianness problems).
329.if ${__T:Mpowerpc*}
330BROKEN_OPTIONS+=LOADER_GELI LOADER_LUA
331.endif
332
333# Kernel TLS is enabled by default on amd64 and aarch64
334.if ${__T} == "aarch64" || ${__T} == "amd64"
335__DEFAULT_YES_OPTIONS+=OPENSSL_KTLS
336.else
337__DEFAULT_NO_OPTIONS+=OPENSSL_KTLS
338.endif
339
340.if ${__T:Mmips64*}
341# profiling won't work on MIPS64 because there is only assembly for o32
342BROKEN_OPTIONS+=PROFILE
343.endif
344.if ${__T} != "aarch64" && ${__T} != "amd64" && ${__T} != "i386" && \
345    ${__T} != "powerpc64"
346BROKEN_OPTIONS+=CXGBETOOL
347BROKEN_OPTIONS+=MLX5TOOL
348.endif
349
350# HyperV is currently x86-only
351.if ${__T} != "amd64" && ${__T} != "i386"
352BROKEN_OPTIONS+=HYPERV
353.endif
354
355# NVME is only aarch64, x86 and powerpc64*
356.if ${__T} != "aarch64" && ${__T} != "amd64" && ${__T} != "i386" && \
357    ${__T:Mpowerpc64*} == ""
358BROKEN_OPTIONS+=NVME
359.endif
360
361.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T} == "i386" || \
362    ${__T:Mpowerpc64*} != "" || ${__T:Mriscv64*} != ""
363__DEFAULT_YES_OPTIONS+=OPENMP
364.else
365__DEFAULT_NO_OPTIONS+=OPENMP
366.endif
367
368.include <bsd.mkopt.mk>
369
370#
371# Force some options off if their dependencies are off.
372# Order is somewhat important.
373#
374.if ${MK_CAPSICUM} == "no"
375MK_CASPER:=	no
376.endif
377
378.if ${MK_SOURCELESS} == "no"
379MK_SOURCELESS_HOST:=	no
380MK_SOURCELESS_UCODE:= no
381.endif
382
383.if ${MK_CDDL} == "no"
384MK_ZFS:=	no
385MK_LOADER_ZFS:=	no
386MK_CTF:=	no
387.endif
388
389.if ${MK_CRYPT} == "no"
390MK_OPENSSL:=	no
391MK_OPENSSH:=	no
392MK_KERBEROS:=	no
393MK_KERBEROS_SUPPORT:=	no
394.endif
395
396.if ${MK_CXX} == "no"
397MK_CLANG:=	no
398MK_GOOGLETEST:=	no
399MK_OFED:=	no
400MK_OPENMP:=	no
401MK_PMC:=	no
402MK_TESTS:=	no
403.endif
404
405.if ${MK_DIALOG} == "no"
406MK_BSDINSTALL:=	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_ATM:=	no
417MK_BLUETOOTH:=	no
418.endif
419
420.if ${MK_NLS} == "no"
421MK_NLS_CATALOGS:= no
422.endif
423
424.if ${MK_OPENSSL} == "no"
425MK_DMAGENT:=	no
426MK_OPENSSH:=	no
427MK_OPENSSL_KTLS:=	no
428MK_KERBEROS:=	no
429MK_KERBEROS_SUPPORT:=	no
430MK_LDNS:=	no
431MK_PKGBOOTSTRAP:=	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_INCLUDES:=	no
469MK_LLD:=	no
470MK_LLDB:=	no
471MK_LLVM_BINUTILS:=	no
472.endif
473
474.if ${MK_CLANG} == "no"
475MK_CLANG_EXTRAS:= no
476MK_CLANG_FORMAT:= no
477MK_CLANG_FULL:= no
478MK_LLVM_COV:= no
479.endif
480
481.if ${MK_ASAN} == "yes"
482# In order to get sensible backtraces from ASAN we have to install
483# llvm-symbolizer as /usr/bin/addr2line instead of the elftoolchain version.
484MK_LLVM_BINUTILS:=	yes
485.endif
486
487.if ${MK_LLVM_BINUTILS} == "yes"
488# MK_LLVM_CXXFILT is a subset of MK_LLVM_BINUTILS and should therefore be
489# enabled if MK_LLVM_BINUTILS is set.
490MK_LLVM_CXXFILT:=	yes
491.endif
492
493.if ${MK_LOADER_VERIEXEC} == "no"
494MK_LOADER_VERIEXEC_PASS_MANIFEST := no
495.endif
496
497#
498# MK_* options whose default value depends on another option.
499#
500.for vv in \
501    GSSAPI/KERBEROS \
502    MAN_UTILS/MAN
503.if defined(WITH_${vv:H})
504MK_${vv:H}:=	yes
505.elif defined(WITHOUT_${vv:H})
506MK_${vv:H}:=	no
507.else
508MK_${vv:H}:=	${MK_${vv:T}}
509.endif
510.endfor
511
512#
513# Set defaults for the MK_*_SUPPORT variables.
514#
515
516.endif #  !target(__<src.opts.mk>__)
517