xref: /freebsd/release/release.sh (revision a0b9e2e854027e6ff61fb075a1309dbc71c42b54)
1#!/bin/sh
2#-
3# Copyright (c) 2020 Rubicon Communications, LLC (netgate.com)
4# Copyright (c) 2013-2019 The FreeBSD Foundation
5# Copyright (c) 2013 Glen Barber
6# Copyright (c) 2011 Nathan Whitehorn
7# All rights reserved.
8#
9# Portions of this software were developed by Glen Barber
10# under sponsorship from the FreeBSD Foundation.
11#
12# Redistribution and use in source and binary forms, with or without
13# modification, are permitted provided that the following conditions
14# are met:
15# 1. Redistributions of source code must retain the above copyright
16#    notice, this list of conditions and the following disclaimer.
17# 2. Redistributions in binary form must reproduce the above copyright
18#    notice, this list of conditions and the following disclaimer in the
19#    documentation and/or other materials provided with the distribution.
20#
21# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31# SUCH DAMAGE.
32#
33# release.sh: check out source trees, and build release components with
34#  totally clean, fresh trees.
35# Based on release/generate-release.sh written by Nathan Whitehorn
36#
37# $FreeBSD$
38#
39
40export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
41
42VERSION=3
43
44# Prototypes that can be redefined per-chroot or per-target.
45load_chroot_env() { }
46load_target_env() { }
47buildenv_setup() { }
48
49usage() {
50	echo "Usage: $0 [-c release.conf]"
51	exit 1
52}
53
54# env_setup(): Set up the default build environment variables, such as the
55# CHROOTDIR, VCSCMD, GITROOT, etc.  This is called before the release.conf
56# file is sourced, if '-c <release.conf>' is specified.
57env_setup() {
58	# The directory within which the release will be built.
59	CHROOTDIR="/scratch"
60	if [ -z "${RELENGDIR}" ]; then
61		export RELENGDIR="$(dirname $(realpath ${0}))"
62	fi
63
64	# The default version control system command to obtain the sources.
65	for _dir in /usr/bin /usr/local/bin; do
66		[ -x "${_dir}/git" ] && VCSCMD="/${_dir}/git"
67		[ ! -z "${VCSCMD}" ] && break 2
68	done
69
70	if [ -z "${VCSCMD}" -a -z "${NOGIT}" ]; then
71		echo "*** The devel/git port/package is required."
72		exit 1
73	fi
74	VCSCMD="/usr/local/bin/git clone -q"
75
76	# The default git checkout server, and branches for src/, doc/,
77	# and ports/.
78	GITROOT="https://cgit-beta.FreeBSD.org/"
79	SRCBRANCH="main"
80	DOCBRANCH="main"
81	PORTBRANCH="main"
82	GITSRC="src.git"
83	GITPORTS="ports.git"
84	GITDOC="doc.git"
85
86	# Set for embedded device builds.
87	EMBEDDEDBUILD=
88
89	# The default make.conf and src.conf to use.  Set to /dev/null
90	# by default to avoid polluting the chroot(8) environment with
91	# non-default settings.
92	MAKE_CONF="/dev/null"
93	SRC_CONF="/dev/null"
94
95	# The number of make(1) jobs, defaults to the number of CPUs available
96	# for buildworld, and half of number of CPUs available for buildkernel.
97	WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
98	KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
99
100	MAKE_FLAGS="-s"
101
102	# The name of the kernel to build, defaults to GENERIC.
103	KERNEL="GENERIC"
104
105	# Set to non-empty value to disable checkout of doc/ and/or ports/.
106	# Disabling ports/ checkout also forces NODOC to be set.
107	NODOC=
108	NOPORTS=
109
110	# Set to non-empty value to disable distributing source tree.
111	NOSRC=
112
113	# Set to non-empty value to build dvd1.iso as part of the release.
114	WITH_DVD=
115	WITH_COMPRESSED_IMAGES=
116
117	# Set to non-empty value to build virtual machine images as part of
118	# the release.
119	WITH_VMIMAGES=
120	WITH_COMPRESSED_VMIMAGES=
121	XZ_THREADS=0
122
123	# Set to non-empty value to build virtual machine images for various
124	# cloud providers as part of the release.
125	WITH_CLOUDWARE=
126
127	return 0
128} # env_setup()
129
130# env_check(): Perform sanity tests on the build environment, such as ensuring
131# files/directories exist, as well as adding backwards-compatibility hacks if
132# necessary.  This is called unconditionally, and overrides the defaults set
133# in env_setup() if '-c <release.conf>' is specified.
134env_check() {
135	chroot_build_release_cmd="chroot_build_release"
136
137	# Prefix the branches with the GITROOT for the full checkout URL.
138	SRC="${GITROOT}${GITSRC}"
139	DOC="${GITROOT}${GITDOC}"
140	PORT="${GITROOT}${GITPORTS}"
141
142	if [ -n "${EMBEDDEDBUILD}" ]; then
143		WITH_DVD=
144		WITH_COMPRESSED_IMAGES=
145		NODOC=yes
146		case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
147			arm:arm*|arm64:aarch64|riscv:riscv64*)
148				chroot_build_release_cmd="chroot_arm_build_release"
149				;;
150			*)
151				;;
152		esac
153	fi
154
155	# If PORTS is set and NODOC is unset, force NODOC=yes because the ports
156	# tree is required to build the documentation set.
157	if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
158		echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
159		echo "            and NOPORTS is set."
160		NODOC=yes
161	fi
162
163	# If NOSRC, NOPORTS and/or NODOC are unset, they must not pass to make
164	# as variables.  The release makefile verifies definedness of the
165	# NOPORTS/NODOC variables instead of their values.
166	SRCDOCPORTS=
167	if [ -n "${NOPORTS}" ]; then
168		SRCDOCPORTS="NOPORTS=yes"
169	fi
170	if [ -n "${NODOC}" ]; then
171		SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes"
172	fi
173	if [ -n "${NOSRC}" ]; then
174		SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes"
175	fi
176
177	# The aggregated build-time flags based upon variables defined within
178	# this file, unless overridden by release.conf.  In most cases, these
179	# will not need to be changed.
180	CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
181	if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
182		ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
183	else
184		ARCH_FLAGS=
185	fi
186
187	if [ -z "${CHROOTDIR}" ]; then
188		echo "Please set CHROOTDIR."
189		exit 1
190	fi
191
192	if [ $(id -u) -ne 0 ]; then
193		echo "Needs to be run as root."
194		exit 1
195	fi
196
197	# Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist.
198	if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then
199		CHROOTBUILD_SKIP=
200	fi
201
202	CHROOT_MAKEENV="${CHROOT_MAKEENV} \
203		MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
204	CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
205	CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
206	CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
207	RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
208		${CONF_FILES}"
209	RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
210		KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
211	RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
212		KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \
213		WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
214		WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
215
216	return 0
217} # env_check()
218
219# chroot_setup(): Prepare the build chroot environment for the release build.
220chroot_setup() {
221	load_chroot_env
222	mkdir -p ${CHROOTDIR}/usr
223
224	if [ -z "${SRC_UPDATE_SKIP}" ]; then
225		if [ -d "${CHROOTDIR}/usr/src/.git" ]; then
226			git -C ${CHROOTDIR}/usr/src pull -q
227		else
228			${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src
229		fi
230	fi
231	if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
232		if [ -d "${CHROOTDIR}/usr/doc/.git" ]; then
233			git -C ${CHROOTDIR}/usr/doc pull -q
234		else
235			${VCSCMD} ${DOC} -b ${DOCBRANCH} ${CHROOTDIR}/usr/doc
236		fi
237	fi
238	if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
239		if [ -d "${CHROOTDIR}/usr/ports/.git" ]; then
240			git -C ${CHROOTDIR}/usr/ports pull -q
241		else
242			${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr/ports
243		fi
244	fi
245
246	if [ -z "${CHROOTBUILD_SKIP}" ]; then
247		cd ${CHROOTDIR}/usr/src
248		env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
249		env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
250			DESTDIR=${CHROOTDIR}
251		env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
252			DESTDIR=${CHROOTDIR}
253	fi
254
255	return 0
256} # chroot_setup()
257
258# extra_chroot_setup(): Prepare anything additional within the build
259# necessary for the release build.
260extra_chroot_setup() {
261	mkdir -p ${CHROOTDIR}/dev
262	mount -t devfs devfs ${CHROOTDIR}/dev
263	[ -e /etc/resolv.conf -a ! -e ${CHROOTDIR}/etc/resolv.conf ] && \
264		cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
265	# Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
266	# is created.  This is needed by ports-mgmt/pkg.
267	eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
268
269	# If MAKE_CONF and/or SRC_CONF are set and not character devices
270	# (/dev/null), copy them to the chroot.
271	if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
272		mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
273		cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
274	fi
275	if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
276		mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
277		cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
278	fi
279
280	if [ -z "${NOGIT}" ]; then
281		# Install git from ports or packages if the ports tree is
282		# available and VCSCMD is unset.
283		_gitcmd="$(which git)"
284		if [ -d ${CHROOTDIR}/usr/ports -a -z "${_gitcmd}" ]; then
285			# Trick the ports 'run-autotools-fixup' target to do the right
286			# thing.
287			_OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
288			REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
289			BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
290			UNAME_r=${REVISION}-${BRANCH}
291			GITUNSETOPTS="CONTRIB CURL CVS GITWEB GUI HTMLDOCS"
292			GITUNSETOPTS="${GITUNSETOPTS} ICONV NLS P4 PERL"
293			GITUNSETOPTS="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN"
294			GITUNSETOPTS="${GITUNSETOPTS} PCRE PCRE2"
295			eval chroot ${CHROOTDIR} env OPTIONS_UNSET=\"${GITUNSETOPTS}\" \
296				make -C /usr/ports/devel/git FORCE_PKG_REGISTER=1 \
297				WRKDIRPREFIX=/tmp/ports \
298				DISTDIR=/tmp/distfiles \
299				install clean distclean
300		else
301			eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
302				pkg install -y devel/git
303			eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
304				pkg clean -y
305		fi
306	fi
307	if [ -d ${CHROOTDIR}/usr/ports ]; then
308		# Trick the ports 'run-autotools-fixup' target to do the right
309		# thing.
310		_OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
311		REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
312		BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
313		UNAME_r=${REVISION}-${BRANCH}
314		if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
315			PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
316			PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
317			PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
318			PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
319			PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
320			chroot ${CHROOTDIR} env ${PBUILD_FLAGS} \
321				OPTIONS_UNSET="AVAHI FOP IGOR" make -C \
322				/usr/ports/textproc/docproj \
323				FORCE_PKG_REGISTER=1 \
324				install clean distclean
325		fi
326	fi
327
328	if [ ! -z "${EMBEDDEDPORTS}" ]; then
329		_OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
330		REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
331		BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
332		PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
333		PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
334		PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
335		PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
336		PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
337		for _PORT in ${EMBEDDEDPORTS}; do
338			eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \
339				/usr/ports/${_PORT} \
340				FORCE_PKG_REGISTER=1 deinstall install clean distclean
341		done
342	fi
343
344	buildenv_setup
345
346	return 0
347} # extra_chroot_setup()
348
349# chroot_build_target(): Build the userland and kernel for the build target.
350chroot_build_target() {
351	load_target_env
352	if [ ! -z "${EMBEDDEDBUILD}" ]; then
353		RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
354			TARGET=${EMBEDDED_TARGET} \
355			TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
356		RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
357			TARGET=${EMBEDDED_TARGET} \
358			TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
359	fi
360	eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
361	eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
362
363	return 0
364} # chroot_build_target
365
366# chroot_build_release(): Invoke the 'make release' target.
367chroot_build_release() {
368	load_target_env
369	if [ ! -z "${WITH_VMIMAGES}" ]; then
370		if [ -z "${VMFORMATS}" ]; then
371			VMFORMATS="$(eval chroot ${CHROOTDIR} \
372				make -C /usr/src/release -V VMFORMATS)"
373		fi
374		if [ -z "${VMSIZE}" ]; then
375			VMSIZE="$(eval chroot ${CHROOTDIR} \
376				make -C /usr/src/release -V VMSIZE)"
377		fi
378		RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
379			VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
380	fi
381	eval chroot ${CHROOTDIR} make -C /usr/src/release \
382		${RELEASE_RMAKEFLAGS} release
383	eval chroot ${CHROOTDIR} make -C /usr/src/release \
384		${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
385		WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
386		WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
387
388	return 0
389} # chroot_build_release()
390
391efi_boot_name()
392{
393	case $1 in
394		arm)
395			echo "bootarm.efi"
396			;;
397		arm64)
398			echo "bootaa64.efi"
399			;;
400		amd64)
401			echo "bootx64.efi"
402			;;
403		riscv)
404			echo "bootriscv64.efi"
405			;;
406	esac
407}
408
409# chroot_arm_build_release(): Create arm SD card image.
410chroot_arm_build_release() {
411	load_target_env
412	case ${EMBEDDED_TARGET} in
413		arm|arm64|riscv)
414			if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
415				. "${RELENGDIR}/tools/arm.subr"
416			fi
417			;;
418		*)
419			;;
420	esac
421	[ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
422	export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}"
423	export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
424	export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}"
425	eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj
426	export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)"
427	export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)"
428	export DESTDIR="${OBJDIR}/${KERNEL}"
429	export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img"
430	export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \
431		TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
432		-V OSRELEASE)"
433	chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
434	chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
435	export mddev=$(chroot ${CHROOTDIR} \
436		mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
437	arm_create_disk
438	arm_install_base
439	arm_install_boot
440	arm_install_uboot
441	mdconfig -d -u ${mddev}
442	chroot ${CHROOTDIR} rmdir ${DESTDIR}
443	mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img
444	chroot ${CHROOTDIR} mkdir -p /R
445	chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \
446		/R/${OSRELEASE}-${BOARDNAME}.img
447	chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img
448	cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
449		> CHECKSUM.SHA512
450	cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
451		> CHECKSUM.SHA256
452
453	return 0
454} # chroot_arm_build_release()
455
456# main(): Start here.
457main() {
458	set -e # Everything must succeed
459	env_setup
460	while getopts c: opt; do
461		case ${opt} in
462			c)
463				RELEASECONF="$(realpath ${OPTARG})"
464				;;
465			\?)
466				usage
467				;;
468		esac
469	done
470	shift $(($OPTIND - 1))
471	if [ ! -z "${RELEASECONF}" ]; then
472		if [ -e "${RELEASECONF}" ]; then
473			. ${RELEASECONF}
474		else
475			echo "Nonexistent configuration file: ${RELEASECONF}"
476			echo "Using default build environment."
477		fi
478	fi
479	env_check
480	trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
481	chroot_setup
482	extra_chroot_setup
483	chroot_build_target
484	${chroot_build_release_cmd}
485
486	return 0
487} # main()
488
489main "${@}"
490