3 # Copyright (c) 2020-2021 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
9 # Portions of this software were developed by Glen Barber
10 # under sponsorship from the FreeBSD Foundation.
12 # Redistribution and use in source and binary forms, with or without
13 # modification, are permitted provided that the following conditions
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.
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
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
38 export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
42 # Prototypes that can be redefined per-chroot or per-target.
48 echo "Usage: $0 [-c release.conf]"
52 # env_setup(): Set up the default build environment variables, such as the
53 # CHROOTDIR, VCSCMD, GITROOT, etc. This is called before the release.conf
54 # file is sourced, if '-c <release.conf>' is specified.
56 # The directory within which the release will be built.
58 if [ -z "${RELENGDIR}" ]; then
59 export RELENGDIR="$(dirname $(realpath ${0}))"
62 # The default version control system command to obtain the sources.
63 for _dir in /usr/bin /usr/local/bin; do
64 [ -x "${_dir}/git" ] && VCSCMD="/${_dir}/git"
65 [ ! -z "${VCSCMD}" ] && break 2
68 # Find the Subversion binary to use. This is a workaround to use
69 # the source of truth for the ports tree, as the conversion to Git
70 # is targeted to occur slightly after the currently-scheduled 13.0
72 for _dir in /usr/bin /usr/local/bin; do
73 for _svn in svn svnlite; do
74 [ -x "${_dir}/${_svn}" ] && SVNCMD="${_dir}/${_svn}"
75 [ ! -z "${SVNCMD}" ] && break 2
79 if [ -z "${VCSCMD}" -a -z "${NOGIT}" ]; then
80 echo "*** The devel/git port/package is required."
83 VCSCMD="/usr/local/bin/git clone -q"
85 # The default git checkout server, and branches for src/, doc/,
87 GITROOT="https://git.FreeBSD.org/"
95 # Set for embedded device builds.
98 # The default make.conf and src.conf to use. Set to /dev/null
99 # by default to avoid polluting the chroot(8) environment with
100 # non-default settings.
101 MAKE_CONF="/dev/null"
104 # The number of make(1) jobs, defaults to the number of CPUs available
105 # for buildworld, and half of number of CPUs available for buildkernel.
106 WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
107 KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
111 # The name of the kernel to build, defaults to GENERIC.
114 # Set to non-empty value to disable checkout of doc/ and/or ports/.
115 # Disabling ports/ checkout also forces NODOC to be set.
119 # Set to non-empty value to disable distributing source tree.
122 # Set to non-empty value to build dvd1.iso as part of the release.
124 WITH_COMPRESSED_IMAGES=
126 # Set to non-empty value to build virtual machine images as part of
129 WITH_COMPRESSED_VMIMAGES=
132 # Set to non-empty value to build virtual machine images for various
133 # cloud providers as part of the release.
139 # env_check(): Perform sanity tests on the build environment, such as ensuring
140 # files/directories exist, as well as adding backwards-compatibility hacks if
141 # necessary. This is called unconditionally, and overrides the defaults set
142 # in env_setup() if '-c <release.conf>' is specified.
144 chroot_build_release_cmd="chroot_build_release"
146 # Prefix the branches with the GITROOT for the full checkout URL.
147 SRC="${GITROOT}${GITSRC}"
148 DOC="${GITROOT}${GITDOC}"
149 #PORT="${GITROOT}${GITPORTS}"
150 PORT="svn://svn.freebsd.org/ports/"
152 if [ -n "${EMBEDDEDBUILD}" ]; then
154 WITH_COMPRESSED_IMAGES=
156 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
157 arm:arm*|arm64:aarch64|riscv:riscv64*)
158 chroot_build_release_cmd="chroot_arm_build_release"
165 # If PORTS is set and NODOC is unset, force NODOC=yes because the ports
166 # tree is required to build the documentation set.
167 if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
168 echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
169 echo " and NOPORTS is set."
173 # If NOSRC, NOPORTS and/or NODOC are unset, they must not pass to make
174 # as variables. The release makefile verifies definedness of the
175 # NOPORTS/NODOC variables instead of their values.
177 if [ -n "${NOPORTS}" ]; then
178 SRCDOCPORTS="NOPORTS=yes"
180 if [ -n "${NODOC}" ]; then
181 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes"
183 if [ -n "${NOSRC}" ]; then
184 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes"
187 # The aggregated build-time flags based upon variables defined within
188 # this file, unless overridden by release.conf. In most cases, these
189 # will not need to be changed.
190 CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
191 if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
192 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
197 if [ -z "${CHROOTDIR}" ]; then
198 echo "Please set CHROOTDIR."
202 if [ $(id -u) -ne 0 ]; then
203 echo "Needs to be run as root."
207 # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist.
208 if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then
212 CHROOT_MAKEENV="${CHROOT_MAKEENV} \
213 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
214 CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
215 CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
216 CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
217 RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
219 RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
220 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
221 RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
222 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \
223 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
224 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
229 # chroot_setup(): Prepare the build chroot environment for the release build.
232 mkdir -p ${CHROOTDIR}/usr
234 if [ -z "${SRC_UPDATE_SKIP}" ]; then
235 if [ -d "${CHROOTDIR}/usr/src/.git" ]; then
236 git -C ${CHROOTDIR}/usr/src pull -q
238 ${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src
241 if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
242 if [ -d "${CHROOTDIR}/usr/doc/.git" ]; then
243 git -C ${CHROOTDIR}/usr/doc pull -q
245 ${VCSCMD} ${DOC} -b ${DOCBRANCH} ${CHROOTDIR}/usr/doc
248 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
249 # if [ -d "${CHROOTDIR}/usr/ports/.git" ]; then
250 # git -C ${CHROOTDIR}/usr/ports pull -q
251 # XXX: Workaround for the overlap in the Git conversion timeframe.
252 if [ -d "${CHROOTDIR}/usr/ports/.svn" ]; then
253 ${SVNCMD} update ${CHROOTDIR}/usr/ports
255 #${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr/ports
256 # XXX: Workaround for the overlap in the Git
257 # conversion timeframe.
258 ${SVNCMD} co ${PORT}/${PORTBRANCH} ${CHROOTDIR}/usr/ports
262 if [ -z "${CHROOTBUILD_SKIP}" ]; then
263 cd ${CHROOTDIR}/usr/src
264 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
265 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
267 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
274 # extra_chroot_setup(): Prepare anything additional within the build
275 # necessary for the release build.
276 extra_chroot_setup() {
277 mkdir -p ${CHROOTDIR}/dev
278 mount -t devfs devfs ${CHROOTDIR}/dev
279 [ -e /etc/resolv.conf -a ! -e ${CHROOTDIR}/etc/resolv.conf ] && \
280 cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
281 # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
282 # is created. This is needed by ports-mgmt/pkg.
283 eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
285 # If MAKE_CONF and/or SRC_CONF are set and not character devices
286 # (/dev/null), copy them to the chroot.
287 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
288 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
289 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
291 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
292 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
293 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
296 if [ -z "${NOGIT}" ]; then
297 # Install git from ports or packages if the ports tree is
298 # available and VCSCMD is unset.
299 _gitcmd="$(which git)"
300 if [ -d ${CHROOTDIR}/usr/ports -a -z "${_gitcmd}" ]; then
301 # Trick the ports 'run-autotools-fixup' target to do the right
303 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
304 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
305 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
306 UNAME_r=${REVISION}-${BRANCH}
307 GITUNSETOPTS="CONTRIB CURL CVS GITWEB GUI HTMLDOCS"
308 GITUNSETOPTS="${GITUNSETOPTS} ICONV NLS P4 PERL"
309 GITUNSETOPTS="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN"
310 GITUNSETOPTS="${GITUNSETOPTS} PCRE PCRE2"
311 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
312 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
313 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
314 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
315 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
316 eval chroot ${CHROOTDIR} env OPTIONS_UNSET=\"${GITUNSETOPTS}\" \
318 make -C /usr/ports/devel/git FORCE_PKG_REGISTER=1 \
319 WRKDIRPREFIX=/tmp/ports \
320 DISTDIR=/tmp/distfiles \
321 install clean distclean
323 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
324 pkg install -y devel/git
325 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
329 if [ -d ${CHROOTDIR}/usr/ports ]; then
330 # Trick the ports 'run-autotools-fixup' target to do the right
332 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
333 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
334 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
335 UNAME_r=${REVISION}-${BRANCH}
336 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
337 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
338 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
339 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
340 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
341 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
342 chroot ${CHROOTDIR} env ${PBUILD_FLAGS} \
343 OPTIONS_UNSET="AVAHI FOP IGOR" make -C \
344 /usr/ports/textproc/docproj \
345 FORCE_PKG_REGISTER=1 \
346 install clean distclean
350 if [ ! -z "${EMBEDDEDPORTS}" ]; then
351 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
352 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
353 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
354 UNAME_r=${REVISION}-${BRANCH}
355 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
356 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
357 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
358 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
359 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
360 for _PORT in ${EMBEDDEDPORTS}; do
361 eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \
362 /usr/ports/${_PORT} \
363 FORCE_PKG_REGISTER=1 deinstall install clean distclean
370 } # extra_chroot_setup()
372 # chroot_build_target(): Build the userland and kernel for the build target.
373 chroot_build_target() {
375 if [ ! -z "${EMBEDDEDBUILD}" ]; then
376 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
377 TARGET=${EMBEDDED_TARGET} \
378 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
379 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
380 TARGET=${EMBEDDED_TARGET} \
381 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
383 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
384 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
387 } # chroot_build_target
389 # chroot_build_release(): Invoke the 'make release' target.
390 chroot_build_release() {
392 if [ ! -z "${WITH_VMIMAGES}" ]; then
393 if [ -z "${VMFORMATS}" ]; then
394 VMFORMATS="$(eval chroot ${CHROOTDIR} \
395 make -C /usr/src/release -V VMFORMATS)"
397 if [ -z "${VMSIZE}" ]; then
398 VMSIZE="$(eval chroot ${CHROOTDIR} \
399 make -C /usr/src/release -V VMSIZE)"
401 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
402 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
404 eval chroot ${CHROOTDIR} make -C /usr/src/release \
405 ${RELEASE_RMAKEFLAGS} release
406 eval chroot ${CHROOTDIR} make -C /usr/src/release \
407 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
408 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
409 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
412 } # chroot_build_release()
427 echo "bootriscv64.efi"
432 # chroot_arm_build_release(): Create arm SD card image.
433 chroot_arm_build_release() {
435 case ${EMBEDDED_TARGET} in
437 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
438 . "${RELENGDIR}/tools/arm.subr"
444 [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
445 export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}"
446 export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
447 export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}"
448 eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj
449 export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)"
450 export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)"
451 export DESTDIR="${OBJDIR}/${KERNEL}"
452 export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img"
453 export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \
454 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
456 chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
457 chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
458 export mddev=$(chroot ${CHROOTDIR} \
459 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
464 mdconfig -d -u ${mddev}
465 chroot ${CHROOTDIR} rmdir ${DESTDIR}
466 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img
467 chroot ${CHROOTDIR} mkdir -p /R
468 chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \
469 /R/${OSRELEASE}-${BOARDNAME}.img
470 chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img
471 cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
473 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
477 } # chroot_arm_build_release()
479 # main(): Start here.
481 set -e # Everything must succeed
483 while getopts c: opt; do
486 RELEASECONF="$(realpath ${OPTARG})"
493 shift $(($OPTIND - 1))
494 if [ ! -z "${RELEASECONF}" ]; then
495 if [ -e "${RELEASECONF}" ]; then
498 echo "Nonexistent configuration file: ${RELEASECONF}"
499 echo "Using default build environment."
503 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
507 ${chroot_build_release_cmd}