xref: /freebsd/share/mk/src.opts.mk (revision 3ceba58a7509418b47b8fca2d2b6bbf088714e26) 
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    CPP \
84    CROSS_COMPILER \
85    CRYPT \
86    CUSE \
87    CXGBETOOL \
88    DICT \
89    DMAGENT \
90    DTRACE \
91    DYNAMICROOT \
92    EE \
93    EFI \
94    ELFTOOLCHAIN_BOOTSTRAP \
95    EXAMPLES \
96    FILE \
97    FINGER \
98    FLOPPY \
99    FORTH \
100    FP_LIBC \
101    FREEBSD_UPDATE \
102    FTP \
103    GAMES \
104    GH_BC \
105    GNU_DIFF \
106    GOOGLETEST \
107    GPIO \
108    HAST \
109    HTML \
110    HYPERV \
111    ICONV \
112    INET \
113    INET6 \
114    INETD \
115    IPFILTER \
116    IPFW \
117    ISCSI \
118    JAIL \
119    JEMALLOC_LG_VADDR_WIDE \
120    KDUMP \
121    KVM \
122    LDNS \
123    LDNS_UTILS \
124    LEGACY_CONSOLE \
125    LLD \
126    LLD_BOOTSTRAP \
127    LLVM_ASSERTIONS \
128    LLVM_COV \
129    LLVM_CXXFILT \
130    LOADER_BIOS_TEXTONLY \
131    LOADER_GELI \
132    LOADER_KBOOT \
133    LOADER_LUA \
134    LOADER_OFW \
135    LOADER_PXEBOOT \
136    LOADER_UBOOT \
137    LOADER_IA32 \
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    NUAGEINIT \
155    OFED \
156    OPENSSL \
157    PAM \
158    PF \
159    PKGBOOTSTRAP \
160    PMC \
161    PPP \
162    PTHREADS_ASSERTIONS \
163    QUOTAS \
164    RADIUS_SUPPORT \
165    RBOOTD \
166    RESCUE \
167    ROUTED \
168    SENDMAIL \
169    SERVICESDB \
170    SETUID_LOGIN \
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    ZFS_TESTS \
194    LOADER_ZFS \
195    ZONEINFO
196
197__DEFAULT_NO_OPTIONS = \
198    BEARSSL \
199    BHYVE_SNAPSHOT \
200    CLANG_EXTRAS \
201    CLANG_FORMAT \
202    CLEAN \
203    DIALOG \
204    DETECT_TZ_CHANGES \
205    DISK_IMAGE_TOOLS_BOOTSTRAP \
206    DTRACE_ASAN \
207    DTRACE_TESTS \
208    EXPERIMENTAL \
209    HESIOD \
210    LOADER_VERBOSE \
211    LOADER_VERIEXEC_PASS_MANIFEST \
212    LLVM_BINUTILS \
213    LLVM_FULL_DEBUGINFO \
214    MALLOC_PRODUCTION \
215    OFED_EXTRA \
216    OPENLDAP \
217    REPRODUCIBLE_BUILD \
218    RPCBIND_WARMSTART_SUPPORT \
219    SORT_THREADS \
220    ZONEINFO_LEAPSECONDS_SUPPORT \
221
222__REQUIRED_OPTIONS = \
223    CASPER
224
225# LEFT/RIGHT. Left options which default to "yes" unless their corresponding
226# RIGHT option is disabled.
227__DEFAULT_DEPENDENT_OPTIONS= \
228	CLANG_FULL/CLANG \
229	LLVM_TARGET_ALL/CLANG \
230	LOADER_VERIEXEC/BEARSSL \
231	LOADER_EFI_SECUREBOOT/LOADER_VERIEXEC \
232	LOADER_VERIEXEC_VECTX/LOADER_VERIEXEC \
233	VERIEXEC/BEARSSL \
234
235__SINGLE_OPTIONS = \
236	LIBC_MALLOC
237
238__LIBC_MALLOC_OPTIONS=	jemalloc
239__LIBC_MALLOC_DEFAULT=	jemalloc
240
241# MK_*_SUPPORT options which default to "yes" unless their corresponding
242# MK_* variable is set to "no".
243#
244.for var in \
245    BLACKLIST \
246    BZIP2 \
247    INET \
248    INET6 \
249    KERBEROS \
250    KVM \
251    NETGRAPH \
252    PAM \
253    TESTS \
254    WIRELESS
255__DEFAULT_DEPENDENT_OPTIONS+= ${var}_SUPPORT/${var}
256.endfor
257
258#
259# Default behaviour of some options depends on the architecture.  Unfortunately
260# this means that we have to test TARGET_ARCH (the buildworld case) as well
261# as MACHINE_ARCH (the non-buildworld case).  Normally TARGET_ARCH is not
262# used at all in bsd.*.mk, but we have to make an exception here if we want
263# to allow defaults for some things like clang to vary by target architecture.
264# Additional, per-target behavior should be rarely added only after much
265# gnashing of teeth and grinding of gears.
266#
267.if defined(TARGET_ARCH)
268__T=${TARGET_ARCH}
269.else
270__T=${MACHINE_ARCH}
271.endif
272
273# All supported backends for LLVM_TARGET_XXX
274__LLVM_TARGETS= \
275		aarch64 \
276		arm \
277		powerpc \
278		riscv \
279		x86
280__LLVM_TARGET_FILT=	C/(amd64|i386)/x86/:C/powerpc.*/powerpc/:C/armv[67]/arm/:C/riscv.*/riscv/
281.for __llt in ${__LLVM_TARGETS}
282# Default enable the given TARGET's LLVM_TARGET support
283.if ${__T:${__LLVM_TARGET_FILT}} == ${__llt}
284__DEFAULT_YES_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}
285# aarch64 needs arm for -m32 support.
286.elif ${__T} == "aarch64" && ${__llt:Marm*} != ""
287__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_ARM/LLVM_TARGET_AARCH64
288# Default the rest of the LLVM_TARGETs to the value of MK_LLVM_TARGET_ALL.
289.else
290__DEFAULT_DEPENDENT_OPTIONS+=	LLVM_TARGET_${__llt:${__LLVM_TARGET_FILT}:tu}/LLVM_TARGET_ALL
291.endif
292.endfor
293
294__DEFAULT_NO_OPTIONS+=LLVM_TARGET_BPF LLVM_TARGET_MIPS
295
296.include <bsd.compiler.mk>
297
298.if ${__T} == "i386" || ${__T} == "amd64"
299__DEFAULT_NO_OPTIONS += FDT
300.else
301__DEFAULT_YES_OPTIONS += FDT
302.endif
303
304.if ${__T:Marm*} == "" && ${__T:Mriscv64*} == ""
305__DEFAULT_YES_OPTIONS+=LLDB
306.else
307__DEFAULT_NO_OPTIONS+=LLDB
308.endif
309# LIB32 is not supported on all 64-bit architectures.
310.if (${__T:Maarch64*} != "" && ((defined(X_COMPILER_TYPE) && ${X_COMPILER_TYPE} != "gcc") || (!defined(X_COMPILER_TYPE) && ${COMPILER_TYPE} != "gcc"))) || ${__T} == "amd64" || ${__T} == "powerpc64"
311__DEFAULT_YES_OPTIONS+=LIB32
312.else
313BROKEN_OPTIONS+=LIB32
314.endif
315# EFI doesn't exist on powerpc (well, officially) and doesn't work on i386
316.if ${__T:Mpowerpc*} || ${__T} == "i386"
317BROKEN_OPTIONS+=EFI
318.endif
319# Bad coupling for libsecure stuff with bearssl and efi, so broken on EFI
320.if ${__T:Mpowerpc*}
321BROKEN_OPTIONS+=BEARSSL		# bearssl brings in secure efi stuff xxx
322.endif
323# OFW is only for powerpc, exclude others
324.if ${__T:Mpowerpc*} == ""
325BROKEN_OPTIONS+=LOADER_OFW
326.endif
327# KBOOT is only for powerpc64 (powerpc64le broken) amd64 and aarch64
328.if ${__T} != "powerpc64" && ${__T} != "amd64" && ${__T} != "aarch64"
329BROKEN_OPTIONS+=LOADER_KBOOT
330.endif
331# UBOOT is only for arm, and big-endian powerpc
332.if (${__T:Marm*} == "" && ${__T:Mpowerpc*} == "") || ${__T} == "powerpc64le"
333BROKEN_OPTIONS+=LOADER_UBOOT
334.endif
335# The 32-bit UEFI loader is only for amd64
336.if ${__T} != "amd64"
337BROKEN_OPTIONS+=LOADER_IA32
338.endif
339# GELI and Lua in loader currently cause boot failures on powerpc.
340# Further debugging is required -- probably they are just broken on big
341# endian systems generically (they jump to null pointers or try to read
342# crazy high addresses, which is typical of endianness problems).
343.if ${__T:Mpowerpc*}
344BROKEN_OPTIONS+=LOADER_GELI LOADER_LUA
345.endif
346
347# Kernel TLS is enabled by default on amd64, aarch64 and powerpc64*
348.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T:Mpowerpc64*} != ""
349__DEFAULT_YES_OPTIONS+=OPENSSL_KTLS
350.else
351__DEFAULT_NO_OPTIONS+=OPENSSL_KTLS
352.endif
353
354.if ${__T} != "aarch64" && ${__T} != "amd64" && ${__T} != "i386" && \
355    ${__T:Mpowerpc64*} == ""
356BROKEN_OPTIONS+=CXGBETOOL
357BROKEN_OPTIONS+=MLX5TOOL
358.endif
359
360.if ${__T} != "amd64" && ${__T} != "i386" && ${__T} != "aarch64"
361BROKEN_OPTIONS+=HYPERV
362.endif
363
364.if ${__T} == "aarch64" || ${__T} == "amd64" || ${__T} == "i386" || \
365    ${__T:Mpowerpc64*} != "" || ${__T:Mriscv64*} != ""
366__DEFAULT_YES_OPTIONS+=OPENMP
367.else
368__DEFAULT_NO_OPTIONS+=OPENMP
369.endif
370
371# Broken on 32-bit arm, kernel module compile errors
372.if ${__T:Marm*} != ""
373BROKEN_OPTIONS+= OFED
374.endif
375
376# MK_host_egacy is set by local.sys.mk so is valid here
377.if ${MACHINE:Nhost*} == "" && ${MK_host_egacy} == "yes"
378# we cannot expect tests to work
379BROKEN_OPTIONS+= TESTS
380.endif
381
382.-include <site.src.opts.mk>
383
384.include <bsd.mkopt.mk>
385
386#
387# Force some options off if their dependencies are off.
388# Order is somewhat important.
389#
390.if ${MK_SOURCELESS} == "no"
391MK_SOURCELESS_HOST:=	no
392MK_SOURCELESS_UCODE:= no
393.endif
394
395.if ${MK_CDDL} == "no"
396MK_CTF:=	no
397MK_DTRACE:=	no
398MK_LOADER_ZFS:=	no
399MK_ZFS:=	no
400.endif
401
402.if ${MK_CRYPT} == "no"
403MK_OPENSSL:=	no
404MK_OPENSSH:=	no
405MK_KERBEROS:=	no
406MK_KERBEROS_SUPPORT:=	no
407.endif
408
409.if ${MK_DTRACE} == "no"
410MK_CTF:=	no
411.endif
412
413.if ${MK_MAIL} == "no"
414MK_MAILWRAPPER:= no
415MK_SENDMAIL:=	no
416MK_DMAGENT:=	no
417.endif
418
419.if ${MK_NETGRAPH} == "no"
420MK_BLUETOOTH:=	no
421.endif
422
423.if ${MK_NLS} == "no"
424MK_NLS_CATALOGS:= no
425.endif
426
427.if ${MK_OPENSSL} == "no"
428MK_DMAGENT:=	no
429MK_OPENSSH:=	no
430MK_OPENSSL_KTLS:=	no
431MK_KERBEROS:=	no
432MK_KERBEROS_SUPPORT:=	no
433MK_LDNS:=	no
434MK_PKGBOOTSTRAP:=	no
435MK_LOADER_ZFS:=	no
436MK_ZFS:=	no
437.endif
438
439.if ${MK_LDNS} == "no"
440MK_LDNS_UTILS:=	no
441MK_UNBOUND:= no
442.endif
443
444.if ${MK_PF} == "no"
445MK_AUTHPF:=	no
446.endif
447
448.if ${MK_OFED} == "no"
449MK_OFED_EXTRA:=	no
450.endif
451
452.if ${MK_TESTS} == "no"
453MK_DTRACE_TESTS:= no
454MK_ZFS_TESTS:= no
455.endif
456
457.if ${MK_ZFS} == "no"
458MK_ZFS_TESTS:=	no
459.endif
460
461.if ${MK_TESTS_SUPPORT} == "no"
462MK_GOOGLETEST:=	no
463.endif
464
465.if ${MK_ZONEINFO} == "no"
466MK_ZONEINFO_LEAPSECONDS_SUPPORT:= no
467.endif
468
469.if ${MK_CROSS_COMPILER} == "no"
470MK_CLANG_BOOTSTRAP:= no
471MK_ELFTOOLCHAIN_BOOTSTRAP:= no
472MK_LLD_BOOTSTRAP:= no
473.endif
474
475.if ${MK_TOOLCHAIN} == "no"
476MK_CLANG:=	no
477MK_LLD:=	no
478MK_LLDB:=	no
479MK_LLVM_BINUTILS:=	no
480.endif
481
482.if ${MK_CLANG} == "no"
483MK_CLANG_EXTRAS:= no
484MK_CLANG_FORMAT:= no
485MK_CLANG_FULL:= no
486MK_LLVM_COV:= no
487.endif
488
489.if ${MK_ASAN} == "yes"
490# In order to get sensible backtraces from ASAN we have to install
491# llvm-symbolizer as /usr/bin/addr2line instead of the elftoolchain version.
492MK_LLVM_BINUTILS:=	yes
493.endif
494
495.if ${MK_LLVM_BINUTILS} == "yes"
496# MK_LLVM_CXXFILT is a subset of MK_LLVM_BINUTILS and should therefore be
497# enabled if MK_LLVM_BINUTILS is set.
498MK_LLVM_CXXFILT:=	yes
499.endif
500
501.if ${MK_LOADER_VERIEXEC} == "no"
502MK_LOADER_VERIEXEC_PASS_MANIFEST := no
503.endif
504
505#
506# MK_* options whose default value depends on another option.
507#
508.for vv in \
509    GSSAPI/KERBEROS \
510    MAN_UTILS/MAN
511.if defined(WITH_${vv:H})
512MK_${vv:H}:=	yes
513.elif defined(WITHOUT_${vv:H})
514MK_${vv:H}:=	no
515.else
516MK_${vv:H}:=	${MK_${vv:T}}
517.endif
518.endfor
519
520#
521# Set defaults for the MK_*_SUPPORT variables.
522#
523
524.endif #  !target(__<src.opts.mk>__)
525