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