xref: /freebsd/Makefile (revision bd18fd57db1df29da1a3adf94d47924a977a29c2)
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: buildkernel installkernel
142.ORDER: buildkernel installkernel.debug
143.ORDER: buildkernel reinstallkernel
144.ORDER: buildkernel reinstallkernel.debug
145
146PATH=	/sbin:/bin:/usr/sbin:/usr/bin
147MAKEOBJDIRPREFIX?=	/usr/obj
148_MAKEOBJDIRPREFIX!= /usr/bin/env -i PATH=${PATH} ${MAKE} \
149    ${.MAKEFLAGS:MMAKEOBJDIRPREFIX=*} __MAKE_CONF=${__MAKE_CONF} \
150    -f /dev/null -V MAKEOBJDIRPREFIX dummy
151.if !empty(_MAKEOBJDIRPREFIX)
152.error MAKEOBJDIRPREFIX can only be set in environment, not as a global\
153	(in make.conf(5)) or command-line variable.
154.endif
155
156# We often need to use the tree's version of make to build it.
157# Choices add to complexity though.
158# We cannot blindly use a make which may not be the one we want
159# so be exlicit - until all choice is removed.
160WANT_MAKE=	bmake
161MYMAKE=		${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE}/${WANT_MAKE}
162.if defined(.PARSEDIR)
163HAVE_MAKE=	bmake
164.else
165HAVE_MAKE=	fmake
166.endif
167.if exists(${MYMAKE})
168SUB_MAKE:= ${MYMAKE} -m ${.CURDIR}/share/mk
169.elif ${WANT_MAKE} != ${HAVE_MAKE}
170# It may not exist yet but we may cause it to.
171# In the case of fmake, upgrade_checks may cause a newer version to be built.
172SUB_MAKE= `test -x ${MYMAKE} && echo ${MYMAKE} || echo ${MAKE}` \
173	-m ${.CURDIR}/share/mk
174.else
175SUB_MAKE= ${MAKE} -m ${.CURDIR}/share/mk
176.endif
177
178_MAKE=	PATH=${PATH} ${SUB_MAKE} -f Makefile.inc1 TARGET=${_TARGET} TARGET_ARCH=${_TARGET_ARCH}
179
180# Guess machine architecture from machine type, and vice versa.
181.if !defined(TARGET_ARCH) && defined(TARGET)
182_TARGET_ARCH=	${TARGET:S/pc98/i386/:S/arm64/aarch64/}
183.elif !defined(TARGET) && defined(TARGET_ARCH) && \
184    ${TARGET_ARCH} != ${MACHINE_ARCH}
185_TARGET=		${TARGET_ARCH:C/mips(n32|64)?(el)?/mips/:C/arm(v6)?(eb|hf)?/arm/:C/aarch64/arm64/:C/powerpc64/powerpc/:C/riscv64/riscv/}
186.endif
187.if defined(TARGET) && !defined(_TARGET)
188_TARGET=${TARGET}
189.endif
190.if defined(TARGET_ARCH) && !defined(_TARGET_ARCH)
191_TARGET_ARCH=${TARGET_ARCH}
192.endif
193# for historical compatibility for xdev targets
194.if defined(XDEV)
195_TARGET=	${XDEV}
196.endif
197.if defined(XDEV_ARCH)
198_TARGET_ARCH=	${XDEV_ARCH}
199.endif
200# Otherwise, default to current machine type and architecture.
201_TARGET?=	${MACHINE}
202_TARGET_ARCH?=	${MACHINE_ARCH}
203
204#
205# Make sure we have an up-to-date make(1). Only world and buildworld
206# should do this as those are the initial targets used for upgrades.
207# The user can define ALWAYS_CHECK_MAKE to have this check performed
208# for all targets.
209#
210.if defined(ALWAYS_CHECK_MAKE) || !defined(.PARSEDIR)
211${TGTS}: upgrade_checks
212.else
213buildworld: upgrade_checks
214.endif
215
216#
217# Handle the user-driven targets, using the source relative mk files.
218#
219
220tinderbox toolchains kernel-toolchains: .MAKE
221${TGTS}: .PHONY .MAKE
222	${_+_}@cd ${.CURDIR}; ${_MAKE} ${.TARGET}
223
224# The historic default "all" target creates files which may cause stale
225# or (in the cross build case) unlinkable results. Fail with an error
226# when no target is given. The users can explicitly specify "all"
227# if they want the historic behavior.
228.MAIN:	_guard
229
230_guard: .PHONY
231	@echo
232	@echo "Explicit target required.  Likely \"${SUBDIR_OVERRIDE:Dall:Ubuildworld}\" is wanted.  See build(7)."
233	@echo
234	@false
235
236STARTTIME!= LC_ALL=C date
237CHECK_TIME!= find ${.CURDIR}/sys/sys/param.h -mtime -0s ; echo
238.if !empty(CHECK_TIME)
239.error check your date/time: ${STARTTIME}
240.endif
241
242.if defined(HISTORICAL_MAKE_WORLD) || defined(DESTDIR)
243#
244# world
245#
246# Attempt to rebuild and reinstall everything. This target is not to be
247# used for upgrading an existing FreeBSD system, because the kernel is
248# not included. One can argue that this target doesn't build everything
249# then.
250#
251world: upgrade_checks
252	@echo "--------------------------------------------------------------"
253	@echo ">>> make world started on ${STARTTIME}"
254	@echo "--------------------------------------------------------------"
255.if target(pre-world)
256	@echo
257	@echo "--------------------------------------------------------------"
258	@echo ">>> Making 'pre-world' target"
259	@echo "--------------------------------------------------------------"
260	${_+_}@cd ${.CURDIR}; ${_MAKE} pre-world
261.endif
262	${_+_}@cd ${.CURDIR}; ${_MAKE} buildworld
263	${_+_}@cd ${.CURDIR}; ${_MAKE} -B installworld
264.if target(post-world)
265	@echo
266	@echo "--------------------------------------------------------------"
267	@echo ">>> Making 'post-world' target"
268	@echo "--------------------------------------------------------------"
269	${_+_}@cd ${.CURDIR}; ${_MAKE} post-world
270.endif
271	@echo
272	@echo "--------------------------------------------------------------"
273	@echo ">>> make world completed on `LC_ALL=C date`"
274	@echo "                   (started ${STARTTIME})"
275	@echo "--------------------------------------------------------------"
276.else
277world:
278	@echo "WARNING: make world will overwrite your existing FreeBSD"
279	@echo "installation without also building and installing a new"
280	@echo "kernel.  This can be dangerous.  Please read the handbook,"
281	@echo "'Rebuilding world', for how to upgrade your system."
282	@echo "Define DESTDIR to where you want to install FreeBSD,"
283	@echo "including /, to override this warning and proceed as usual."
284	@echo ""
285	@echo "Bailing out now..."
286	@false
287.endif
288
289#
290# kernel
291#
292# Short hand for `make buildkernel installkernel'
293#
294kernel: buildkernel installkernel
295
296#
297# Perform a few tests to determine if the installed tools are adequate
298# for building the world.
299#
300upgrade_checks:
301.if ${HAVE_MAKE} != ${WANT_MAKE} || \
302    (defined(WANT_MAKE_VERSION) && ${MAKE_VERSION} < ${WANT_MAKE_VERSION})
303	@(cd ${.CURDIR} && ${MAKE} ${WANT_MAKE:S,^f,,})
304.endif
305
306#
307# Upgrade make(1) to the current version using the installed
308# headers, libraries and tools.  Also, allow the location of
309# the system bsdmake-like utility to be overridden.
310#
311MMAKEENV=	MAKEOBJDIRPREFIX=${MYMAKE:H} \
312		DESTDIR= \
313		INSTALL="sh ${.CURDIR}/tools/install.sh"
314MMAKE=		${MMAKEENV} ${MAKE} \
315		-DNO_MAN -DNO_SHARED \
316		-DNO_CPU_CFLAGS -DNO_WERROR \
317		MK_TESTS=no \
318		DESTDIR= PROGNAME=${MYMAKE:T}
319
320bmake: .PHONY
321	@echo
322	@echo "--------------------------------------------------------------"
323	@echo ">>> Building an up-to-date ${.TARGET}(1)"
324	@echo "--------------------------------------------------------------"
325	${_+_}@cd ${.CURDIR}/usr.bin/${.TARGET}; \
326		${MMAKE} obj; \
327		${MMAKE} depend; \
328		${MMAKE} all; \
329		${MMAKE} install DESTDIR=${MYMAKE:H} BINDIR=
330
331regress: .PHONY
332	@echo "'make regress' has been renamed 'make check'" | /usr/bin/fmt
333	@false
334
335tinderbox toolchains kernel-toolchains kernels worlds: upgrade_checks
336
337tinderbox:
338	@cd ${.CURDIR}; ${SUB_MAKE} DOING_TINDERBOX=YES universe
339
340toolchains:
341	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=toolchain universe
342
343kernel-toolchains:
344	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=kernel-toolchain universe
345
346kernels:
347	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=buildkernel universe
348
349worlds:
350	@cd ${.CURDIR}; ${SUB_MAKE} UNIVERSE_TARGET=buildworld universe
351
352#
353# universe
354#
355# Attempt to rebuild *everything* for all supported architectures,
356# with a reasonable chance of success, regardless of how old your
357# existing system is.
358#
359.if make(universe) || make(universe_kernels) || make(tinderbox) || make(targets)
360TARGETS?=amd64 arm arm64 i386 mips pc98 powerpc sparc64
361_UNIVERSE_TARGETS=	${TARGETS}
362TARGET_ARCHES_arm?=	arm armeb armv6 armv6hf
363TARGET_ARCHES_arm64?=	aarch64
364TARGET_ARCHES_mips?=	mipsel mips mips64el mips64 mipsn32
365TARGET_ARCHES_powerpc?=	powerpc powerpc64
366TARGET_ARCHES_pc98?=	i386
367.for target in ${TARGETS}
368TARGET_ARCHES_${target}?= ${target}
369.endfor
370
371# XXX Add arm64 to universe only if we have an external binutils installed.
372# It does not build with the in-tree linker.
373.if !exists(/usr/local/aarch64-freebsd/bin/ld) && empty(${TARGETS})
374_UNIVERSE_TARGETS:= ${_UNIVERSE_TARGETS:Narm64}
375universe: universe_arm64_skip
376universe_epilogue: universe_arm64_skip
377universe_arm64_skip: universe_prologue
378	@echo ">> arm64 skipped - install aarch64-binutils port or package to build"
379.endif
380
381.if defined(UNIVERSE_TARGET)
382MAKE_JUST_WORLDS=	YES
383.else
384UNIVERSE_TARGET?=	buildworld
385.endif
386KERNSRCDIR?=		${.CURDIR}/sys
387
388targets:	.PHONY
389	@echo "Supported TARGET/TARGET_ARCH pairs for world and kernel targets"
390.for target in ${TARGETS}
391.for target_arch in ${TARGET_ARCHES_${target}}
392	@echo "    ${target}/${target_arch}"
393.endfor
394.endfor
395
396.if defined(DOING_TINDERBOX)
397FAILFILE=${.CURDIR}/_.tinderbox.failed
398MAKEFAIL=tee -a ${FAILFILE}
399.else
400MAKEFAIL=cat
401.endif
402
403universe_prologue:  upgrade_checks
404universe: universe_prologue
405universe_prologue:
406	@echo "--------------------------------------------------------------"
407	@echo ">>> make universe started on ${STARTTIME}"
408	@echo "--------------------------------------------------------------"
409.if defined(DOING_TINDERBOX)
410	@rm -f ${FAILFILE}
411.endif
412.for target in ${_UNIVERSE_TARGETS}
413universe: universe_${target}
414universe_epilogue: universe_${target}
415universe_${target}: universe_${target}_prologue
416universe_${target}_prologue: universe_prologue
417	@echo ">> ${target} started on `LC_ALL=C date`"
418universe_${target}_worlds:
419
420.if !defined(MAKE_JUST_KERNELS)
421universe_${target}_done: universe_${target}_worlds
422.for target_arch in ${TARGET_ARCHES_${target}}
423universe_${target}_worlds: universe_${target}_${target_arch}
424universe_${target}_${target_arch}: universe_${target}_prologue .MAKE
425	@echo ">> ${target}.${target_arch} ${UNIVERSE_TARGET} started on `LC_ALL=C date`"
426	@(cd ${.CURDIR} && env __MAKE_CONF=/dev/null \
427	    ${SUB_MAKE} ${JFLAG} ${UNIVERSE_TARGET} \
428	    TARGET=${target} \
429	    TARGET_ARCH=${target_arch} \
430	    > _.${target}.${target_arch}.${UNIVERSE_TARGET} 2>&1 || \
431	    (echo "${target}.${target_arch} ${UNIVERSE_TARGET} failed," \
432	    "check _.${target}.${target_arch}.${UNIVERSE_TARGET} for details" | \
433	    ${MAKEFAIL}))
434	@echo ">> ${target}.${target_arch} ${UNIVERSE_TARGET} completed on `LC_ALL=C date`"
435.endfor
436.endif # !MAKE_JUST_KERNELS
437
438.if !defined(MAKE_JUST_WORLDS)
439universe_${target}_done: universe_${target}_kernels
440universe_${target}_kernels: universe_${target}_worlds
441universe_${target}_kernels: universe_${target}_prologue .MAKE
442.if exists(${KERNSRCDIR}/${target}/conf/NOTES)
443	@(cd ${KERNSRCDIR}/${target}/conf && env __MAKE_CONF=/dev/null \
444	    ${SUB_MAKE} LINT > ${.CURDIR}/_.${target}.makeLINT 2>&1 || \
445	    (echo "${target} 'make LINT' failed," \
446	    "check _.${target}.makeLINT for details"| ${MAKEFAIL}))
447.endif
448	@cd ${.CURDIR}; ${SUB_MAKE} ${.MAKEFLAGS} TARGET=${target} \
449	    universe_kernels
450.endif # !MAKE_JUST_WORLDS
451
452# Tell the user the worlds and kernels have completed
453universe_${target}: universe_${target}_done
454universe_${target}_done:
455	@echo ">> ${target} completed on `LC_ALL=C date`"
456.endfor
457universe_kernels: universe_kernconfs
458.if !defined(TARGET)
459TARGET!=	uname -m
460.endif
461.if defined(MAKE_ALL_KERNELS)
462_THINNER=cat
463.else
464_THINNER=xargs grep -L "^.NO_UNIVERSE" || true
465.endif
466KERNCONFS!=	cd ${KERNSRCDIR}/${TARGET}/conf && \
467		find [[:upper:][:digit:]]*[[:upper:][:digit:]] \
468		-type f -maxdepth 0 \
469		! -name DEFAULTS ! -name NOTES | \
470		${_THINNER}
471universe_kernconfs:
472.for kernel in ${KERNCONFS}
473TARGET_ARCH_${kernel}!=	cd ${KERNSRCDIR}/${TARGET}/conf && \
474	config -m ${KERNSRCDIR}/${TARGET}/conf/${kernel} 2> /dev/null | \
475	grep -v WARNING: | cut -f 2
476.if empty(TARGET_ARCH_${kernel})
477.error "Target architecture for ${TARGET}/conf/${kernel} unknown.  config(8) likely too old."
478.endif
479universe_kernconfs: universe_kernconf_${TARGET}_${kernel}
480universe_kernconf_${TARGET}_${kernel}: .MAKE
481	@(cd ${.CURDIR} && env __MAKE_CONF=/dev/null \
482	    ${SUB_MAKE} ${JFLAG} buildkernel \
483	    TARGET=${TARGET} \
484	    TARGET_ARCH=${TARGET_ARCH_${kernel}} \
485	    KERNCONF=${kernel} \
486	    > _.${TARGET}.${kernel} 2>&1 || \
487	    (echo "${TARGET} ${kernel} kernel failed," \
488	    "check _.${TARGET}.${kernel} for details"| ${MAKEFAIL}))
489.endfor
490universe: universe_epilogue
491universe_epilogue:
492	@echo "--------------------------------------------------------------"
493	@echo ">>> make universe completed on `LC_ALL=C date`"
494	@echo "                      (started ${STARTTIME})"
495	@echo "--------------------------------------------------------------"
496.if defined(DOING_TINDERBOX)
497	@if [ -e ${FAILFILE} ] ; then \
498		echo "Tinderbox failed:" ;\
499		cat ${FAILFILE} ;\
500		exit 1 ;\
501	fi
502.endif
503.endif
504
505buildLINT:
506	${MAKE} -C ${.CURDIR}/sys/${_TARGET}/conf LINT
507
508.if defined(.PARSEDIR)
509# This makefile does not run in meta mode
510.MAKE.MODE= normal
511# Normally the things we run from here don't either.
512# Using -DWITH_META_MODE
513# we can buildworld with meta files created which are useful
514# for debugging, but without any of the rest of a meta mode build.
515MK_DIRDEPS_BUILD= no
516MK_STAGING= no
517# tell meta.autodep.mk to not even think about updating anything.
518UPDATE_DEPENDFILE= NO
519.if !make(showconfig)
520.export MK_DIRDEPS_BUILD MK_STAGING UPDATE_DEPENDFILE
521.endif
522
523.if make(universe)
524# we do not want a failure of one branch abort all.
525MAKE_JOB_ERROR_TOKEN= no
526.export MAKE_JOB_ERROR_TOKEN
527.endif
528.endif # bmake
529
530.endif				# DIRDEPS_BUILD
531