xref: /freebsd/Makefile (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1#
2# $FreeBSD$
3#
4# The user-driven targets are:
5#
6# universe            - *Really* build *everything* (buildworld and
7#                       all kernels on all architectures).
8# tinderbox           - Same as universe, but presents a list of failed build
9#                       targets and exits with an error if there were any.
10# buildworld          - Rebuild *everything*, including glue to help do
11#                       upgrades.
12# installworld        - Install everything built by "buildworld".
13# world               - buildworld + installworld, no kernel.
14# buildkernel         - Rebuild the kernel and the kernel-modules.
15# installkernel       - Install the kernel and the kernel-modules.
16# installkernel.debug
17# reinstallkernel     - Reinstall the kernel and the kernel-modules.
18# reinstallkernel.debug
19# kernel              - buildkernel + installkernel.
20# kernel-toolchain    - Builds the subset of world necessary to build a kernel
21# kernel-toolchains   - Build kernel-toolchain for all universe targets.
22# doxygen             - Build API documentation of the kernel, needs doxygen.
23# update              - Convenient way to update your source tree(s).
24# checkworld          - Run test suite on installed world.
25# check-old           - List obsolete directories/files/libraries.
26# check-old-dirs      - List obsolete directories.
27# check-old-files     - List obsolete files.
28# check-old-libs      - List obsolete libraries.
29# delete-old          - Delete obsolete directories/files.
30# delete-old-dirs     - Delete obsolete directories.
31# delete-old-files    - Delete obsolete files.
32# delete-old-libs     - Delete obsolete libraries.
33# targets             - Print a list of supported TARGET/TARGET_ARCH pairs
34#                       for world and kernel targets.
35# toolchains          - Build a toolchain for all world and kernel targets.
36# xdev                - xdev-build + xdev-install for the architecture
37#                       specified with XDEV and XDEV_ARCH.
38# xdev-build          - Build cross-development tools.
39# xdev-install        - Install cross-development tools.
40# xdev-links          - Create traditional links in /usr/bin for cc, etc
41# native-xtools       - Create host binaries that produce target objects
42#                       for use in qemu user-mode jails.
43#
44# "quick" way to test all kernel builds:
45# 	_jflag=`sysctl -n hw.ncpu`
46# 	_jflag=$(($_jflag * 2))
47# 	[ $_jflag -gt 12 ] && _jflag=12
48# 	make universe -DMAKE_JUST_KERNELS JFLAG=-j${_jflag}
49#
50# This makefile is simple by design. The FreeBSD make automatically reads
51# the /usr/share/mk/sys.mk unless the -m argument is specified on the
52# command line. By keeping this makefile simple, it doesn't matter too
53# much how different the installed mk files are from those in the source
54# tree. This makefile executes a child make process, forcing it to use
55# the mk files from the source tree which are supposed to DTRT.
56#
57# Most of the user-driven targets (as listed above) are implemented in
58# Makefile.inc1.  The exceptions are universe, tinderbox and targets.
59#
60# If you want to build your system from source be sure that /usr/obj has
61# at least 6GB of diskspace available.  A complete 'universe' build requires
62# about 100GB of space.
63#
64# For individuals wanting to build from the sources currently on their
65# system, the simple instructions are:
66#
67# 1.  `cd /usr/src'  (or to the directory containing your source tree).
68# 2.  Define `HISTORICAL_MAKE_WORLD' variable (see README).
69# 3.  `make world'
70#
71# For individuals wanting to upgrade their sources (even if only a
72# delta of a few days):
73#
74#  1.  `cd /usr/src'       (or to the directory containing your source tree).
75#  2.  `make buildworld'
76#  3.  `make buildkernel KERNCONF=YOUR_KERNEL_HERE'     (default is GENERIC).
77#  4.  `make installkernel KERNCONF=YOUR_KERNEL_HERE'   (default is GENERIC).
78#       [steps 3. & 4. can be combined by using the "kernel" target]
79#  5.  `reboot'        (in single user mode: boot -s from the loader prompt).
80#  6.  `mergemaster -p'
81#  7.  `make installworld'
82#  8.  `mergemaster'		(you may wish to use -i, along with -U or -F).
83#  9.  `make delete-old'
84# 10.  `reboot'
85# 11.  `make delete-old-libs' (in case no 3rd party program uses them anymore)
86#
87# See src/UPDATING `COMMON ITEMS' for more complete information.
88#
89# If TARGET=machine (e.g. powerpc, sparc64, ...) is specified you can
90# cross build world for other machine types using the buildworld target,
91# and once the world is built you can cross build a kernel using the
92# buildkernel target.
93#
94# Define the user-driven targets. These are listed here in alphabetical
95# order, but that's not important.
96#
97# Targets that begin with underscore are internal targets intended for
98# developer convenience only.  They are intentionally not documented and
99# completely subject to change without notice.
100#
101# For more information, see the build(7) manual page.
102#
103
104# This is included so CC is set to ccache for -V, and COMPILER_TYPE/VERSION
105# can be cached for sub-makes.
106.include <bsd.compiler.mk>
107
108# Note: we use this awkward construct to be compatible with FreeBSD's
109# old make used in 10.0 and 9.2 and earlier.
110.if defined(MK_DIRDEPS_BUILD) && ${MK_DIRDEPS_BUILD} == "yes" && !make(showconfig)
111# targets/Makefile plays the role of top-level
112.include "targets/Makefile"
113.else
114
115TGTS=	all all-man buildenv buildenvvars buildkernel buildworld \
116	check check-old check-old-dirs check-old-files check-old-libs \
117	checkdpadd checkworld clean cleandepend cleandir cleanworld \
118	delete-old delete-old-dirs delete-old-files delete-old-libs \
119	depend distribute distributekernel distributekernel.debug \
120	distributeworld distrib-dirs distribution doxygen \
121	everything hier hierarchy install installcheck installkernel \
122	installkernel.debug packagekernel packageworld \
123	reinstallkernel reinstallkernel.debug \
124	installworld kernel-toolchain libraries lint maninstall \
125	obj objlink rerelease showconfig tags toolchain update \
126	_worldtmp _legacy _bootstrap-tools _cleanobj _obj \
127	_build-tools _cross-tools _includes _libraries _depend \
128	build32 builddtb distribute32 install32 xdev xdev-build xdev-install \
129	xdev-links native-xtools installconfig \
130
131TGTS+=	${SUBDIR_TARGETS}
132
133BITGTS=	files includes
134BITGTS:=${BITGTS} ${BITGTS:S/^/build/} ${BITGTS:S/^/install/}
135TGTS+=	${BITGTS}
136
137.ORDER: buildworld installworld
138.ORDER: buildworld distributeworld
139.ORDER: buildworld buildkernel
140.ORDER: installworld distribution
141.ORDER: installworld installkernel
142.ORDER: buildkernel installkernel
143.ORDER: buildkernel installkernel.debug
144.ORDER: buildkernel reinstallkernel
145.ORDER: buildkernel reinstallkernel.debug
146
147PATH=	/sbin:/bin:/usr/sbin:/usr/bin
148MAKEOBJDIRPREFIX?=	/usr/obj
149_MAKEOBJDIRPREFIX!= /usr/bin/env -i PATH=${PATH} ${MAKE} \
150    ${.MAKEFLAGS:MMAKEOBJDIRPREFIX=*} __MAKE_CONF=${__MAKE_CONF} \
151    -f /dev/null -V MAKEOBJDIRPREFIX dummy
152.if !empty(_MAKEOBJDIRPREFIX)
153.error MAKEOBJDIRPREFIX can only be set in environment, not as a global\
154	(in make.conf(5)) or command-line variable.
155.endif
156
157# We often need to use the tree's version of make to build it.
158# Choices add to complexity though.
159# We cannot blindly use a make which may not be the one we want
160# so be exlicit - until all choice is removed.
161WANT_MAKE=	bmake
162MYMAKE=		${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE}/${WANT_MAKE}
163.if defined(.PARSEDIR)
164HAVE_MAKE=	bmake
165.else
166HAVE_MAKE=	fmake
167.endif
168.if exists(${MYMAKE})
169SUB_MAKE:= ${MYMAKE} -m ${.CURDIR}/share/mk
170.elif ${WANT_MAKE} != ${HAVE_MAKE}
171# It may not exist yet but we may cause it to.
172# In the case of fmake, upgrade_checks may cause a newer version to be built.
173SUB_MAKE= `test -x ${MYMAKE} && echo ${MYMAKE} || echo ${MAKE}` \
174	-m ${.CURDIR}/share/mk
175.else
176SUB_MAKE= ${MAKE} -m ${.CURDIR}/share/mk
177.endif
178
179_MAKE=	PATH=${PATH} ${SUB_MAKE} -f Makefile.inc1 TARGET=${_TARGET} TARGET_ARCH=${_TARGET_ARCH}
180
181# Guess machine architecture from machine type, and vice versa.
182.if !defined(TARGET_ARCH) && defined(TARGET)
183_TARGET_ARCH=	${TARGET:S/pc98/i386/:S/arm64/aarch64/}
184.elif !defined(TARGET) && defined(TARGET_ARCH) && \
185    ${TARGET_ARCH} != ${MACHINE_ARCH}
186_TARGET=		${TARGET_ARCH:C/mips(n32|64)?(el)?/mips/:C/arm(v6)?(eb|hf)?/arm/:C/aarch64/arm64/:C/powerpc64/powerpc/:C/riscv64/riscv/}
187.endif
188.if defined(TARGET) && !defined(_TARGET)
189_TARGET=${TARGET}
190.endif
191.if defined(TARGET_ARCH) && !defined(_TARGET_ARCH)
192_TARGET_ARCH=${TARGET_ARCH}
193.endif
194# for historical compatibility for xdev targets
195.if defined(XDEV)
196_TARGET=	${XDEV}
197.endif
198.if defined(XDEV_ARCH)
199_TARGET_ARCH=	${XDEV_ARCH}
200.endif
201# Otherwise, default to current machine type and architecture.
202_TARGET?=	${MACHINE}
203_TARGET_ARCH?=	${MACHINE_ARCH}
204
205#
206# Make sure we have an up-to-date make(1). Only world and buildworld
207# should do this as those are the initial targets used for upgrades.
208# The user can define ALWAYS_CHECK_MAKE to have this check performed
209# for all targets.
210#
211.if defined(ALWAYS_CHECK_MAKE) || !defined(.PARSEDIR)
212${TGTS}: upgrade_checks
213.else
214buildworld: upgrade_checks
215.endif
216
217#
218# Handle the user-driven targets, using the source relative mk files.
219#
220
221tinderbox toolchains kernel-toolchains: .MAKE
222${TGTS}: .PHONY .MAKE
223	${_+_}@cd ${.CURDIR}; ${_MAKE} ${.TARGET}
224
225# The historic default "all" target creates files which may cause stale
226# or (in the cross build case) unlinkable results. Fail with an error
227# when no target is given. The users can explicitly specify "all"
228# if they want the historic behavior.
229.MAIN:	_guard
230
231_guard: .PHONY
232	@echo
233	@echo "Explicit target required.  Likely \"${SUBDIR_OVERRIDE:Dall:Ubuildworld}\" is wanted.  See build(7)."
234	@echo
235	@false
236
237STARTTIME!= LC_ALL=C date
238CHECK_TIME!= find ${.CURDIR}/sys/sys/param.h -mtime -0s ; echo
239.if !empty(CHECK_TIME)
240.error check your date/time: ${STARTTIME}
241.endif
242
243.if defined(HISTORICAL_MAKE_WORLD) || defined(DESTDIR)
244#
245# world
246#
247# Attempt to rebuild and reinstall everything. This target is not to be
248# used for upgrading an existing FreeBSD system, because the kernel is
249# not included. One can argue that this target doesn't build everything
250# then.
251#
252world: upgrade_checks
253	@echo "--------------------------------------------------------------"
254	@echo ">>> make world started on ${STARTTIME}"
255	@echo "--------------------------------------------------------------"
256.if target(pre-world)
257	@echo
258	@echo "--------------------------------------------------------------"
259	@echo ">>> Making 'pre-world' target"
260	@echo "--------------------------------------------------------------"
261	${_+_}@cd ${.CURDIR}; ${_MAKE} pre-world
262.endif
263	${_+_}@cd ${.CURDIR}; ${_MAKE} buildworld
264	${_+_}@cd ${.CURDIR}; ${_MAKE} -B installworld
265.if target(post-world)
266	@echo
267	@echo "--------------------------------------------------------------"
268	@echo ">>> Making 'post-world' target"
269	@echo "--------------------------------------------------------------"
270	${_+_}@cd ${.CURDIR}; ${_MAKE} post-world
271.endif
272	@echo
273	@echo "--------------------------------------------------------------"
274	@echo ">>> make world completed on `LC_ALL=C date`"
275	@echo "                   (started ${STARTTIME})"
276	@echo "--------------------------------------------------------------"
277.else
278world:
279	@echo "WARNING: make world will overwrite your existing FreeBSD"
280	@echo "installation without also building and installing a new"
281	@echo "kernel.  This can be dangerous.  Please read the handbook,"
282	@echo "'Rebuilding world', for how to upgrade your system."
283	@echo "Define DESTDIR to where you want to install FreeBSD,"
284	@echo "including /, to override this warning and proceed as usual."
285	@echo ""
286	@echo "Bailing out now..."
287	@false
288.endif
289
290#
291# kernel
292#
293# Short hand for `make buildkernel installkernel'
294#
295kernel: buildkernel installkernel
296
297#
298# Perform a few tests to determine if the installed tools are adequate
299# for building the world.
300#
301upgrade_checks:
302.if ${HAVE_MAKE} != ${WANT_MAKE} || \
303    (defined(WANT_MAKE_VERSION) && ${MAKE_VERSION} < ${WANT_MAKE_VERSION})
304	@(cd ${.CURDIR} && ${MAKE} ${WANT_MAKE:S,^f,,})
305.endif
306
307#
308# Upgrade make(1) to the current version using the installed
309# headers, libraries and tools.  Also, allow the location of
310# the system bsdmake-like utility to be overridden.
311#
312MMAKEENV=	MAKEOBJDIRPREFIX=${MYMAKE:H} \
313		DESTDIR= \
314		INSTALL="sh ${.CURDIR}/tools/install.sh"
315MMAKE=		${MMAKEENV} ${MAKE} \
316		-DNO_MAN -DNO_SHARED \
317		-DNO_CPU_CFLAGS -DNO_WERROR \
318		MK_TESTS=no \
319		DESTDIR= PROGNAME=${MYMAKE:T}
320
321bmake: .PHONY
322	@echo
323	@echo "--------------------------------------------------------------"
324	@echo ">>> Building an up-to-date ${.TARGET}(1)"
325	@echo "--------------------------------------------------------------"
326	${_+_}@cd ${.CURDIR}/usr.bin/${.TARGET}; \
327		${MMAKE} obj; \
328		${MMAKE} depend; \
329		${MMAKE} all; \
330		${MMAKE} install DESTDIR=${MYMAKE:H} BINDIR=
331
332regress: .PHONY
333	@echo "'make regress' has been renamed 'make check'" | /usr/bin/fmt
334	@false
335
336tinderbox toolchains kernel-toolchains kernels worlds: upgrade_checks
337
338tinderbox:
339	@cd ${.CURDIR}; ${SUB_MAKE} DOING_TINDERBOX=YES universe
340
341toolchains:
342	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=toolchain universe
343
344kernel-toolchains:
345	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=kernel-toolchain universe
346
347kernels:
348	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=buildkernel universe
349
350worlds:
351	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=buildworld universe
352
353#
354# universe
355#
356# Attempt to rebuild *everything* for all supported architectures,
357# with a reasonable chance of success, regardless of how old your
358# existing system is.
359#
360.if make(universe) || make(universe_kernels) || make(tinderbox) || make(targets)
361TARGETS?=amd64 arm arm64 i386 mips pc98 powerpc sparc64
362_UNIVERSE_TARGETS=	${TARGETS}
363TARGET_ARCHES_arm?=	arm armeb armv6 armv6hf
364TARGET_ARCHES_arm64?=	aarch64
365TARGET_ARCHES_mips?=	mipsel mips mips64el mips64 mipsn32
366TARGET_ARCHES_powerpc?=	powerpc powerpc64
367TARGET_ARCHES_pc98?=	i386
368.for target in ${TARGETS}
369TARGET_ARCHES_${target}?= ${target}
370.endfor
371
372# XXX Add arm64 to universe only if we have an external binutils installed.
373# It does not build with the in-tree linker.
374.if !exists(/usr/local/aarch64-freebsd/bin/ld) && empty(${TARGETS})
375_UNIVERSE_TARGETS:= ${_UNIVERSE_TARGETS:Narm64}
376universe: universe_arm64_skip
377universe_epilogue: universe_arm64_skip
378universe_arm64_skip: universe_prologue
379	@echo ">> arm64 skipped - install aarch64-binutils port or package to build"
380.endif
381
382.if defined(UNIVERSE_TARGET)
383MAKE_JUST_WORLDS=	YES
384.else
385UNIVERSE_TARGET?=	buildworld
386.endif
387KERNSRCDIR?=		${.CURDIR}/sys
388
389targets:	.PHONY
390	@echo "Supported TARGET/TARGET_ARCH pairs for world and kernel targets"
391.for target in ${TARGETS}
392.for target_arch in ${TARGET_ARCHES_${target}}
393	@echo "    ${target}/${target_arch}"
394.endfor
395.endfor
396
397.if defined(DOING_TINDERBOX)
398FAILFILE=${.CURDIR}/_.tinderbox.failed
399MAKEFAIL=tee -a ${FAILFILE}
400.else
401MAKEFAIL=cat
402.endif
403
404universe_prologue:  upgrade_checks
405universe: universe_prologue
406universe_prologue:
407	@echo "--------------------------------------------------------------"
408	@echo ">>> make universe started on ${STARTTIME}"
409	@echo "--------------------------------------------------------------"
410.if defined(DOING_TINDERBOX)
411	@rm -f ${FAILFILE}
412.endif
413.for target in ${_UNIVERSE_TARGETS}
414universe: universe_${target}
415universe_epilogue: universe_${target}
416universe_${target}: universe_${target}_prologue
417universe_${target}_prologue: universe_prologue
418	@echo ">> ${target} started on `LC_ALL=C date`"
419universe_${target}_worlds:
420
421.if !defined(MAKE_JUST_KERNELS)
422universe_${target}_done: universe_${target}_worlds
423.for target_arch in ${TARGET_ARCHES_${target}}
424universe_${target}_worlds: universe_${target}_${target_arch}
425universe_${target}_${target_arch}: universe_${target}_prologue .MAKE
426	@echo ">> ${target}.${target_arch} ${UNIVERSE_TARGET} started on `LC_ALL=C date`"
427	@(cd ${.CURDIR} && env __MAKE_CONF=/dev/null \
428	    ${SUB_MAKE} ${JFLAG} ${UNIVERSE_TARGET} \
429	    TARGET=${target} \
430	    TARGET_ARCH=${target_arch} \
431	    > _.${target}.${target_arch}.${UNIVERSE_TARGET} 2>&1 || \
432	    (echo "${target}.${target_arch} ${UNIVERSE_TARGET} failed," \
433	    "check _.${target}.${target_arch}.${UNIVERSE_TARGET} for details" | \
434	    ${MAKEFAIL}))
435	@echo ">> ${target}.${target_arch} ${UNIVERSE_TARGET} completed on `LC_ALL=C date`"
436.endfor
437.endif # !MAKE_JUST_KERNELS
438
439.if !defined(MAKE_JUST_WORLDS)
440universe_${target}_done: universe_${target}_kernels
441universe_${target}_kernels: universe_${target}_worlds
442universe_${target}_kernels: universe_${target}_prologue .MAKE
443.if exists(${KERNSRCDIR}/${target}/conf/NOTES)
444	@(cd ${KERNSRCDIR}/${target}/conf && env __MAKE_CONF=/dev/null \
445	    ${SUB_MAKE} LINT > ${.CURDIR}/_.${target}.makeLINT 2>&1 || \
446	    (echo "${target} 'make LINT' failed," \
447	    "check _.${target}.makeLINT for details"| ${MAKEFAIL}))
448.endif
449	@cd ${.CURDIR}; ${SUB_MAKE} ${.MAKEFLAGS} TARGET=${target} \
450	    universe_kernels
451.endif # !MAKE_JUST_WORLDS
452
453# Tell the user the worlds and kernels have completed
454universe_${target}: universe_${target}_done
455universe_${target}_done:
456	@echo ">> ${target} completed on `LC_ALL=C date`"
457.endfor
458universe_kernels: universe_kernconfs
459.if !defined(TARGET)
460TARGET!=	uname -m
461.endif
462.if defined(MAKE_ALL_KERNELS)
463_THINNER=cat
464.else
465_THINNER=xargs grep -L "^.NO_UNIVERSE" || true
466.endif
467KERNCONFS!=	cd ${KERNSRCDIR}/${TARGET}/conf && \
468		find [[:upper:][:digit:]]*[[:upper:][:digit:]] \
469		-type f -maxdepth 0 \
470		! -name DEFAULTS ! -name NOTES | \
471		${_THINNER}
472universe_kernconfs:
473.for kernel in ${KERNCONFS}
474TARGET_ARCH_${kernel}!=	cd ${KERNSRCDIR}/${TARGET}/conf && \
475	config -m ${KERNSRCDIR}/${TARGET}/conf/${kernel} 2> /dev/null | \
476	grep -v WARNING: | cut -f 2
477.if empty(TARGET_ARCH_${kernel})
478.error "Target architecture for ${TARGET}/conf/${kernel} unknown.  config(8) likely too old."
479.endif
480universe_kernconfs: universe_kernconf_${TARGET}_${kernel}
481universe_kernconf_${TARGET}_${kernel}: .MAKE
482	@(cd ${.CURDIR} && env __MAKE_CONF=/dev/null \
483	    ${SUB_MAKE} ${JFLAG} buildkernel \
484	    TARGET=${TARGET} \
485	    TARGET_ARCH=${TARGET_ARCH_${kernel}} \
486	    KERNCONF=${kernel} \
487	    > _.${TARGET}.${kernel} 2>&1 || \
488	    (echo "${TARGET} ${kernel} kernel failed," \
489	    "check _.${TARGET}.${kernel} for details"| ${MAKEFAIL}))
490.endfor
491universe: universe_epilogue
492universe_epilogue:
493	@echo "--------------------------------------------------------------"
494	@echo ">>> make universe completed on `LC_ALL=C date`"
495	@echo "                      (started ${STARTTIME})"
496	@echo "--------------------------------------------------------------"
497.if defined(DOING_TINDERBOX)
498	@if [ -e ${FAILFILE} ] ; then \
499		echo "Tinderbox failed:" ;\
500		cat ${FAILFILE} ;\
501		exit 1 ;\
502	fi
503.endif
504.endif
505
506buildLINT:
507	${MAKE} -C ${.CURDIR}/sys/${_TARGET}/conf LINT
508
509.if defined(.PARSEDIR)
510# This makefile does not run in meta mode
511.MAKE.MODE= normal
512# Normally the things we run from here don't either.
513# Using -DWITH_META_MODE
514# we can buildworld with meta files created which are useful
515# for debugging, but without any of the rest of a meta mode build.
516MK_DIRDEPS_BUILD= no
517MK_STAGING= no
518# tell meta.autodep.mk to not even think about updating anything.
519UPDATE_DEPENDFILE= NO
520.if !make(showconfig)
521.export MK_DIRDEPS_BUILD MK_STAGING UPDATE_DEPENDFILE
522.endif
523
524.if make(universe)
525# we do not want a failure of one branch abort all.
526MAKE_JOB_ERROR_TOKEN= no
527.export MAKE_JOB_ERROR_TOKEN
528.endif
529.endif # bmake
530
531.endif				# DIRDEPS_BUILD
532