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
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
40 export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
44 # Prototypes that can be redefined per-chroot or per-target.
50 echo "Usage: $0 [-c release.conf]"
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.
58 # The directory within which the release will be built.
60 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}" ]; 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://cgit-beta.FreeBSD.org/"
84 # Set for embedded device builds.
87 # The default make.conf and src.conf to use. Set to /dev/null
88 # by default to avoid polluting the chroot(8) environment with
89 # non-default settings.
93 # The number of make(1) jobs, defaults to the number of CPUs available
94 # for buildworld, and half of number of CPUs available for buildkernel.
95 WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
96 KERNEL_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/.
104 # Disabling ports/ checkout also forces NODOC to be set.
108 # Set to non-empty value to disable distributing source tree.
111 # Set to non-empty value to build dvd1.iso as part of the release.
113 WITH_COMPRESSED_IMAGES=
115 # Set to non-empty value to build virtual machine images as part of
118 WITH_COMPRESSED_VMIMAGES=
121 # Set to non-empty value to build virtual machine images for various
122 # cloud providers as part of the release.
128 # env_check(): Perform sanity tests on the build environment, such as ensuring
129 # files/directories exist, as well as adding backwards-compatibility hacks if
130 # necessary. This is called unconditionally, and overrides the defaults set
131 # in env_setup() if '-c <release.conf>' is specified.
133 chroot_build_release_cmd="chroot_build_release"
135 # Prefix the branches with the GITROOT for the full checkout URL.
136 SRC="${GITROOT}${GITSRC}"
137 DOC="${GITROOT}${GITDOC}"
138 PORT="${GITROOT}${GITPORTS}"
140 if [ -n "${EMBEDDEDBUILD}" ]; then
142 WITH_COMPRESSED_IMAGES=
144 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
145 arm:arm*|arm64:aarch64)
146 chroot_build_release_cmd="chroot_arm_build_release"
153 # If PORTS is set and NODOC is unset, force NODOC=yes because the ports
154 # tree is required to build the documentation set.
155 if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
156 echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
157 echo " and NOPORTS is set."
161 # If NOSRC, NOPORTS and/or NODOC are unset, they must not pass to make
162 # as variables. The release makefile verifies definedness of the
163 # NOPORTS/NODOC variables instead of their values.
165 if [ -n "${NOPORTS}" ]; then
166 SRCDOCPORTS="NOPORTS=yes"
168 if [ -n "${NODOC}" ]; then
169 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes"
171 if [ -n "${NOSRC}" ]; then
172 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes"
175 # The aggregated build-time flags based upon variables defined within
176 # this file, unless overridden by release.conf. In most cases, these
177 # will not need to be changed.
178 CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
179 if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
180 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
185 if [ -z "${CHROOTDIR}" ]; then
186 echo "Please set CHROOTDIR."
190 if [ $(id -u) -ne 0 ]; then
191 echo "Needs to be run as root."
195 # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist.
196 if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then
200 CHROOT_MAKEENV="${CHROOT_MAKEENV} \
201 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
202 CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
203 CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
204 CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
205 RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
207 RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
208 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
209 RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
210 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \
211 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
212 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
217 # chroot_setup(): Prepare the build chroot environment for the release build.
220 mkdir -p ${CHROOTDIR}/usr
222 if [ -z "${SRC_UPDATE_SKIP}" ]; then
223 ${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src
225 if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
226 ${VCSCMD} ${DOC} -b ${DOCBRANCH} ${CHROOTDIR}/usr/doc
228 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
229 ${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr/ports
232 if [ -z "${CHROOTBUILD_SKIP}" ]; then
233 cd ${CHROOTDIR}/usr/src
234 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
235 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
237 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
244 # extra_chroot_setup(): Prepare anything additional within the build
245 # necessary for the release build.
246 extra_chroot_setup() {
247 mkdir -p ${CHROOTDIR}/dev
248 mount -t devfs devfs ${CHROOTDIR}/dev
249 [ -e /etc/resolv.conf -a ! -e ${CHROOTDIR}/etc/resolv.conf ] && \
250 cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
251 # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
252 # is created. This is needed by ports-mgmt/pkg.
253 eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
255 # If MAKE_CONF and/or SRC_CONF are set and not character devices
256 # (/dev/null), copy them to the chroot.
257 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
258 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
259 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
261 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
262 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
263 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
266 # Install git from ports or packages if the ports tree is
267 # available and VCSCMD is unset.
268 _gitcmd="$(which git)"
269 if [ -d ${CHROOTDIR}/usr/ports -a -z "${_gitcmd}" ]; then
270 # Trick the ports 'run-autotools-fixup' target to do the right
272 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
273 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
274 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
275 UNAME_r=${REVISION}-${BRANCH}
276 GITUNSETOPTS="CONTRIB CURL CVS GITWEB GUI HTMLDOCS"
277 GITUNSETOPTS="${GITUNSETOPTS} ICONV NLS P4 PERL"
278 GITUNSETOPTS="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN"
279 GITUNSETOPTS="${GITUNSETOPTS} PCRE PCRE2"
280 eval chroot ${CHROOTDIR} env OPTIONS_UNSET=\"${GITUNSETOPTS}\" \
281 make -C /usr/ports/devel/git FORCE_PKG_REGISTER=1 \
282 WRKDIRPREFIX=/tmp/ports \
283 DISTDIR=/tmp/distfiles \
284 install clean distclean
286 if [ -d ${CHROOTDIR}/usr/ports ]; then
287 # Trick the ports 'run-autotools-fixup' target to do the right
289 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
290 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
291 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
292 UNAME_r=${REVISION}-${BRANCH}
293 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
294 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
295 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
296 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
297 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
298 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
299 chroot ${CHROOTDIR} env ${PBUILD_FLAGS} \
300 OPTIONS_UNSET="AVAHI FOP IGOR" make -C \
301 /usr/ports/textproc/docproj \
302 FORCE_PKG_REGISTER=1 \
303 install clean distclean
307 if [ ! -z "${EMBEDDEDPORTS}" ]; then
308 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
309 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
310 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
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 for _PORT in ${EMBEDDEDPORTS}; do
317 eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \
318 /usr/ports/${_PORT} \
319 FORCE_PKG_REGISTER=1 deinstall install clean distclean
326 } # extra_chroot_setup()
328 # chroot_build_target(): Build the userland and kernel for the build target.
329 chroot_build_target() {
331 if [ ! -z "${EMBEDDEDBUILD}" ]; then
332 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
333 TARGET=${EMBEDDED_TARGET} \
334 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
335 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
336 TARGET=${EMBEDDED_TARGET} \
337 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
339 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
340 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
343 } # chroot_build_target
345 # chroot_build_release(): Invoke the 'make release' target.
346 chroot_build_release() {
348 if [ ! -z "${WITH_VMIMAGES}" ]; then
349 if [ -z "${VMFORMATS}" ]; then
350 VMFORMATS="$(eval chroot ${CHROOTDIR} \
351 make -C /usr/src/release -V VMFORMATS)"
353 if [ -z "${VMSIZE}" ]; then
354 VMSIZE="$(eval chroot ${CHROOTDIR} \
355 make -C /usr/src/release -V VMSIZE)"
357 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
358 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
360 eval chroot ${CHROOTDIR} make -C /usr/src/release \
361 ${RELEASE_RMAKEFLAGS} release
362 eval chroot ${CHROOTDIR} make -C /usr/src/release \
363 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
364 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
365 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
368 } # chroot_build_release()
385 # chroot_arm_build_release(): Create arm SD card image.
386 chroot_arm_build_release() {
388 case ${EMBEDDED_TARGET} in
390 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
391 . "${RELENGDIR}/tools/arm.subr"
397 [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
398 export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}"
399 export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
400 export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}"
401 eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj
402 export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)"
403 export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)"
404 export DESTDIR="${OBJDIR}/${KERNEL}"
405 export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img"
406 export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \
407 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
409 chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
410 chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
411 export mddev=$(chroot ${CHROOTDIR} \
412 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
417 mdconfig -d -u ${mddev}
418 chroot ${CHROOTDIR} rmdir ${DESTDIR}
419 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img
420 chroot ${CHROOTDIR} mkdir -p /R
421 chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \
422 /R/${OSRELEASE}-${BOARDNAME}.img
423 chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img
424 cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
426 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
430 } # chroot_arm_build_release()
432 # main(): Start here.
434 set -e # Everything must succeed
436 while getopts c: opt; do
439 RELEASECONF="$(realpath ${OPTARG})"
446 shift $(($OPTIND - 1))
447 if [ ! -z "${RELEASECONF}" ]; then
448 if [ -e "${RELEASECONF}" ]; then
451 echo "Nonexistent configuration file: ${RELEASECONF}"
452 echo "Using default build environment."
456 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
460 ${chroot_build_release_cmd}