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 if [ -z "${VCSCMD}" -a -z "${NOGIT}" ]; then
69 echo "*** The devel/git port/package is required."
72 VCSCMD
="/usr/local/bin/git clone -q"
74 # The default git checkout server, and branches for src/, doc/,
76 GITROOT
="https://git.FreeBSD.org/"
82 # Set for embedded device builds.
85 # The default make.conf and src.conf to use. Set to /dev/null
86 # by default to avoid polluting the chroot(8) environment with
87 # non-default settings.
91 # The number of make(1) jobs, defaults to the number of CPUs available
92 # for buildworld, and half of number of CPUs available for buildkernel
94 WORLD_FLAGS
="-j$(sysctl -n hw.ncpu)"
95 KERNEL_FLAGS
="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
96 RELEASE_FLAGS
="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
100 # The name of the kernel to build, defaults to GENERIC.
103 # Set to non-empty value to disable checkout of doc/ and/or ports/.
106 # Set to non-empty value to disable distributing source tree.
109 # Set to non-empty value to build dvd1.iso as part of the release.
111 WITH_COMPRESSED_IMAGES
=
113 # Set to non-empty value to build virtual machine images as part of
116 WITH_COMPRESSED_VMIMAGES
=
119 # Set to non-empty value to build virtual machine images for various
120 # cloud providers as part of the release.
123 # Set to non-empty to build OCI images as part of the release
129 # env_check(): Perform sanity tests on the build environment, such as ensuring
130 # files/directories exist, as well as adding backwards-compatibility hacks if
131 # necessary. This is called unconditionally, and overrides the defaults set
132 # in env_setup() if '-c <release.conf>' is specified.
134 chroot_build_release_cmd
="chroot_build_release"
136 # Prefix the branches with the GITROOT for the full checkout URL.
137 SRC
="${GITROOT}${GITSRC}"
138 PORT
="${GITROOT}${GITPORTS}"
140 if [ -n "${EMBEDDEDBUILD}" ]; then
142 WITH_COMPRESSED_IMAGES
=
143 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
144 arm
:arm
*|arm64
:aarch64|riscv
:riscv64
*)
145 chroot_build_release_cmd
="chroot_arm_build_release"
152 # If NOSRC and/or NOPORTS are unset, they must not pass to make
153 # as variables. The release makefile verifies definedness of the
154 # NOPORTS variable instead of its value.
156 if [ -n "${NOPORTS}" ]; then
157 SRCPORTS
="NOPORTS=yes"
159 if [ -n "${NOSRC}" ]; then
160 SRCPORTS
="${SRCPORTS}${SRCPORTS:+ }NOSRC=yes"
163 # The aggregated build-time flags based upon variables defined within
164 # this file, unless overridden by release.conf. In most cases, these
165 # will not need to be changed.
166 CONF_FILES
="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
167 NOCONF_FILES
="__MAKE_CONF=/dev/null SRCCONF=/dev/null"
168 if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
169 ARCH_FLAGS
="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
174 if [ -z "${CHROOTDIR}" ]; then
175 echo "Please set CHROOTDIR."
179 if [ $
(id
-u) -ne 0 ]; then
180 echo "Needs to be run as root."
184 # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist.
185 if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin
/sh
]; then
189 CHROOT_MAKEENV
="${CHROOT_MAKEENV} \
190 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
191 CHROOT_WMAKEFLAGS
="${MAKE_FLAGS} ${WORLD_FLAGS} ${NOCONF_FILES}"
192 CHROOT_IMAKEFLAGS
="${WORLD_FLAGS} ${NOCONF_FILES}"
193 CHROOT_DMAKEFLAGS
="${WORLD_FLAGS} ${NOCONF_FILES}"
194 RELEASE_WMAKEFLAGS
="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
196 RELEASE_KMAKEFLAGS
="${MAKE_FLAGS} ${KERNEL_FLAGS} \
197 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
198 RELEASE_RMAKEFLAGS
="${ARCH_FLAGS} ${RELEASE_FLAGS} \
199 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCPORTS} \
200 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
201 WITH_CLOUDWARE=${WITH_CLOUDWARE} WITH_OCIIMAGES=${WITH_OCIIMAGES} \
202 XZ_THREADS=${XZ_THREADS}"
207 # chroot_setup(): Prepare the build chroot environment for the release build.
210 mkdir
-p ${CHROOTDIR}/usr
212 if [ -z "${SRC_UPDATE_SKIP}" ]; then
213 if [ -d "${CHROOTDIR}/usr/src/.git" ]; then
214 git
-C ${CHROOTDIR}/usr
/src pull
-q
216 ${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr
/src
219 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
220 if [ -d "${CHROOTDIR}/usr/ports/.git" ]; then
221 git
-C ${CHROOTDIR}/usr
/ports pull
-q
223 ${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr
/ports
227 if [ -z "${CHROOTBUILD_SKIP}" ]; then
228 cd ${CHROOTDIR}/usr
/src
229 env
${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
230 env
${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
232 env
${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
239 # extra_chroot_setup(): Prepare anything additional within the build
240 # necessary for the release build.
241 extra_chroot_setup
() {
242 mkdir
-p ${CHROOTDIR}/dev
243 mount
-t devfs devfs
${CHROOTDIR}/dev
244 [ -e /etc
/resolv.conf
-a ! -e ${CHROOTDIR}/etc
/resolv.conf
] && \
245 cp /etc
/resolv.conf
${CHROOTDIR}/etc
/resolv.conf
246 # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
247 # is created. This is needed by ports-mgmt/pkg.
248 eval chroot
${CHROOTDIR} /etc
/rc.d
/ldconfig forcerestart
250 # If MAKE_CONF and/or SRC_CONF are set and not character devices
251 # (/dev/null), copy them to the chroot.
252 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
253 mkdir
-p ${CHROOTDIR}/$
(dirname ${MAKE_CONF})
254 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
256 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
257 mkdir
-p ${CHROOTDIR}/$
(dirname ${SRC_CONF})
258 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
261 _gitcmd
="$(which git)"
262 if [ -z "${NOGIT}" -a -z "${_gitcmd}" ]; then
263 # Install git from ports if the ports tree is available;
264 # otherwise install the pkg.
265 if [ -d ${CHROOTDIR}/usr
/ports
]; then
266 # Trick the ports 'run-autotools-fixup' target to do the right
268 _OSVERSION
=$
(chroot
${CHROOTDIR} /usr
/bin
/uname
-U)
269 REVISION
=$
(chroot
${CHROOTDIR} make -C /usr
/src
/release
-V REVISION
)
270 BRANCH
=$
(chroot
${CHROOTDIR} make -C /usr
/src
/release
-V BRANCH
)
271 UNAME_r
=${REVISION}-${BRANCH}
272 GITUNSETOPTS
="CONTRIB CURL CVS GITWEB GUI HTMLDOCS"
273 GITUNSETOPTS
="${GITUNSETOPTS} ICONV NLS P4 PERL"
274 GITUNSETOPTS
="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN"
275 GITUNSETOPTS
="${GITUNSETOPTS} PCRE PCRE2"
276 PBUILD_FLAGS
="OSVERSION=${_OSVERSION} BATCH=yes"
277 PBUILD_FLAGS
="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
278 PBUILD_FLAGS
="${PBUILD_FLAGS} OSREL=${REVISION}"
279 PBUILD_FLAGS
="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
280 PBUILD_FLAGS
="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
281 eval chroot
${CHROOTDIR} env OPTIONS_UNSET
=\"${GITUNSETOPTS}\" \
283 make -C /usr
/ports
/devel
/git FORCE_PKG_REGISTER
=1 \
284 WRKDIRPREFIX
=/tmp
/ports \
285 DISTDIR
=/tmp
/distfiles \
286 install clean distclean
288 eval chroot
${CHROOTDIR} env ASSUME_ALWAYS_YES
=yes \
289 pkg
install -y devel
/git
290 eval chroot
${CHROOTDIR} env ASSUME_ALWAYS_YES
=yes \
295 if [ ! -z "${WITH_OCIIMAGES}" ]; then
296 # Install buildah and skopeo from ports if the ports tree is available;
297 # otherwise install the pkg.
298 if [ -d ${CHROOTDIR}/usr
/ports
]; then
299 # Trick the ports 'run-autotools-fixup' target to do the right
301 _OSVERSION
=$
(chroot
${CHROOTDIR} /usr
/bin
/uname
-U)
302 REVISION
=$
(chroot
${CHROOTDIR} make -C /usr
/src
/release
-V REVISION
)
303 BRANCH
=$
(chroot
${CHROOTDIR} make -C /usr
/src
/release
-V BRANCH
)
304 UNAME_r
=${REVISION}-${BRANCH}
305 GITUNSETOPTS
="CONTRIB CURL CVS GITWEB GUI HTMLDOCS"
306 GITUNSETOPTS
="${GITUNSETOPTS} ICONV NLS P4 PERL"
307 GITUNSETOPTS
="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN"
308 GITUNSETOPTS
="${GITUNSETOPTS} PCRE PCRE2"
309 PBUILD_FLAGS
="OSVERSION=${_OSVERSION} BATCH=yes"
310 PBUILD_FLAGS
="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
311 PBUILD_FLAGS
="${PBUILD_FLAGS} OSREL=${REVISION}"
312 PBUILD_FLAGS
="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
313 PBUILD_FLAGS
="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
314 for _PORT
in sysutils
/buildah sysutils
/skopeo
; do
315 eval chroot
${CHROOTDIR} env
${PBUILD_FLAGS} make -C \
316 /usr
/ports
/${_PORT} \
317 FORCE_PKG_REGISTER
=1 deinstall
install clean distclean
320 eval chroot
${CHROOTDIR} env ASSUME_ALWAYS_YES
=yes \
321 pkg
install -y sysutils
/buildah sysutils
/skopeo
322 eval chroot
${CHROOTDIR} env ASSUME_ALWAYS_YES
=yes \
325 # Use the vfs storage driver so that this works whether or not
326 # the build directory is on ZFS. The images are small so the
327 # performance difference is negligible.
328 eval chroot
${CHROOTDIR} sed -I .bak
-e '/^driver/s/zfs/vfs/' /usr
/local
/etc
/containers
/storage.conf
329 # Remove any stray images from previous builds
330 eval chroot
${CHROOTDIR} buildah rmi
-af
333 if [ ! -z "${EMBEDDEDPORTS}" ]; then
334 _OSVERSION
=$
(chroot
${CHROOTDIR} /usr
/bin
/uname
-U)
335 REVISION
=$
(chroot
${CHROOTDIR} make -C /usr
/src
/release
-V REVISION
)
336 BRANCH
=$
(chroot
${CHROOTDIR} make -C /usr
/src
/release
-V BRANCH
)
337 UNAME_r
=${REVISION}-${BRANCH}
338 PBUILD_FLAGS
="OSVERSION=${_OSVERSION} BATCH=yes"
339 PBUILD_FLAGS
="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
340 PBUILD_FLAGS
="${PBUILD_FLAGS} OSREL=${REVISION}"
341 PBUILD_FLAGS
="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
342 PBUILD_FLAGS
="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
343 for _PORT
in ${EMBEDDEDPORTS}; do
344 eval chroot
${CHROOTDIR} env
${PBUILD_FLAGS} make -C \
345 /usr
/ports
/${_PORT} \
346 FORCE_PKG_REGISTER
=1 deinstall
install clean distclean
353 } # extra_chroot_setup()
355 # chroot_build_target(): Build the userland and kernel for the build target.
356 chroot_build_target
() {
358 if [ ! -z "${EMBEDDEDBUILD}" ]; then
359 RELEASE_WMAKEFLAGS
="${RELEASE_WMAKEFLAGS} \
360 TARGET=${EMBEDDED_TARGET} \
361 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
362 RELEASE_KMAKEFLAGS
="${RELEASE_KMAKEFLAGS} \
363 TARGET=${EMBEDDED_TARGET} \
364 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
366 eval chroot
${CHROOTDIR} make -C /usr
/src
${RELEASE_WMAKEFLAGS} buildworld
367 eval chroot
${CHROOTDIR} make -C /usr
/src
${RELEASE_KMAKEFLAGS} buildkernel
368 if [ ! -z "${WITH_OCIIMAGES}" ]; then
369 eval chroot
${CHROOTDIR} make -C /usr
/src
${RELEASE_WMAKEFLAGS} packages
373 } # chroot_build_target
375 # chroot_build_release(): Invoke the 'make release' target.
376 chroot_build_release
() {
378 if [ ! -z "${WITH_VMIMAGES}" ]; then
379 if [ -z "${VMFORMATS}" ]; then
380 VMFORMATS
="$(eval chroot ${CHROOTDIR} \
381 make -C /usr/src/release -V VMFORMATS)"
383 if [ -z "${VMSIZE}" ]; then
384 VMSIZE
="$(eval chroot ${CHROOTDIR} \
385 make -C /usr/src/release ${ARCH_FLAGS} -V VMSIZE)"
387 RELEASE_RMAKEFLAGS
="${RELEASE_RMAKEFLAGS} \
388 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
390 eval chroot
${CHROOTDIR} make -C /usr
/src
/release \
391 ${RELEASE_RMAKEFLAGS} release
392 eval chroot
${CHROOTDIR} make -C /usr
/src
/release \
393 ${RELEASE_RMAKEFLAGS} install DESTDIR
=/R \
394 WITH_COMPRESSED_IMAGES
=${WITH_COMPRESSED_IMAGES} \
395 WITH_COMPRESSED_VMIMAGES
=${WITH_COMPRESSED_VMIMAGES}
398 } # chroot_build_release()
413 echo "bootriscv64.efi"
418 # chroot_arm_build_release(): Create arm SD card image.
419 chroot_arm_build_release
() {
421 case ${EMBEDDED_TARGET} in
423 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
424 .
"${RELENGDIR}/tools/arm.subr"
430 [ ! -z "${RELEASECONF}" ] && .
"${RELEASECONF}"
431 export MAKE_FLAGS
="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}"
432 export MAKE_FLAGS
="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
433 export MAKE_FLAGS
="${MAKE_FLAGS} ${CONF_FILES}"
434 eval chroot
${CHROOTDIR} env WITH_UNIFIED_OBJDIR
=1 make ${MAKE_FLAGS} -C /usr
/src
/release obj
435 export WORLDDIR
="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)"
436 export OBJDIR
="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)"
437 export DESTDIR
="${OBJDIR}/${KERNEL}"
438 export IMGBASE
="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img"
439 export OSRELEASE
="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \
440 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
442 chroot
${CHROOTDIR} mkdir
-p ${DESTDIR}
443 chroot
${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
444 export mddev
=$
(chroot
${CHROOTDIR} \
445 mdconfig
-f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
450 mdconfig
-d -u ${mddev}
451 chroot
${CHROOTDIR} rmdir ${DESTDIR}
452 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img
453 chroot
${CHROOTDIR} mkdir
-p /R
454 chroot
${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \
455 /R
/${OSRELEASE}-${BOARDNAME}.img
456 chroot
${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img
457 cd ${CHROOTDIR}/R
&& sha512
${OSRELEASE}* \
459 cd ${CHROOTDIR}/R
&& sha256
${OSRELEASE}* \
463 } # chroot_arm_build_release()
465 # main(): Start here.
467 set -e # Everything must succeed
469 while getopts c
: opt
; do
472 RELEASECONF
="$(realpath ${OPTARG})"
479 shift $
(($OPTIND - 1))
480 if [ ! -z "${RELEASECONF}" ]; then
481 if [ -e "${RELEASECONF}" ]; then
484 echo "Nonexistent configuration file: ${RELEASECONF}"
485 echo "Using default build environment."
489 trap "umount ${CHROOTDIR}/dev" EXIT
# Clean up devfs mount on exit
493 ${chroot_build_release_cmd}