3 # Copyright (c) 2013-2018 The FreeBSD Foundation
4 # Copyright (c) 2013 Glen Barber
5 # Copyright (c) 2011 Nathan Whitehorn
8 # Portions of this software were developed by Glen Barber
9 # under sponsorship from the FreeBSD Foundation.
11 # Redistribution and use in source and binary forms, with or without
12 # modification, are permitted provided that the following conditions
14 # 1. Redistributions of source code must retain the above copyright
15 # notice, this list of conditions and the following disclaimer.
16 # 2. Redistributions in binary form must reproduce the above copyright
17 # notice, this list of conditions and the following disclaimer in the
18 # documentation and/or other materials provided with the distribution.
20 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 # release.sh: check out source trees, and build release components with
33 # totally clean, fresh trees.
34 # Based on release/generate-release.sh written by Nathan Whitehorn
39 export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
43 # Prototypes that can be redefined per-chroot or per-target.
49 echo "Usage: $0 [-c release.conf]"
53 # env_setup(): Set up the default build environment variables, such as the
54 # CHROOTDIR, VCSCMD, SVNROOT, etc. This is called before the release.conf
55 # file is sourced, if '-c <release.conf>' is specified.
57 # The directory within which the release will be built.
59 RELENGDIR="$(dirname $(realpath ${0}))"
61 # The default version control system command to obtain the sources.
62 for _dir in /usr/bin /usr/local/bin; do
63 for _svn in svn svnlite; do
64 [ -x "${_dir}/${_svn}" ] && VCSCMD="${_dir}/${_svn}"
65 [ ! -z "${VCSCMD}" ] && break 2
68 VCSCMD="${VCSCMD} checkout"
70 # The default svn checkout server, and svn branches for src/, doc/,
72 SVNROOT="svn://svn.FreeBSD.org/"
73 SRCBRANCH="base/head@rHEAD"
74 DOCBRANCH="doc/head@rHEAD"
75 PORTBRANCH="ports/head@rHEAD"
77 # Set for embedded device builds.
80 # Sometimes one needs to checkout src with --force svn option.
81 # If custom kernel configs copied to src tree before checkout, e.g.
84 # The default make.conf and src.conf to use. Set to /dev/null
85 # by default to avoid polluting the chroot(8) environment with
86 # non-default settings.
90 # The number of make(1) jobs, defaults to the number of CPUs available
91 # for buildworld, and half of number of CPUs available for buildkernel.
92 WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
93 KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
97 # The name of the kernel to build, defaults to GENERIC.
100 # Set to non-empty value to disable checkout of doc/ and/or ports/.
101 # Disabling ports/ checkout also forces NODOC to be set.
105 # Set to non-empty value to disable distributing source tree.
108 # Set to non-empty value to build dvd1.iso as part of the release.
110 WITH_COMPRESSED_IMAGES=
112 # Set to non-empty value to build virtual machine images as part of
115 WITH_COMPRESSED_VMIMAGES=
118 # Set to non-empty value to build virtual machine images for various
119 # cloud providers as part of the release.
125 # env_check(): Perform sanity tests on the build environment, such as ensuring
126 # files/directories exist, as well as adding backwards-compatibility hacks if
127 # necessary. This is called unconditionally, and overrides the defaults set
128 # in env_setup() if '-c <release.conf>' is specified.
130 chroot_build_release_cmd="chroot_build_release"
131 # Fix for backwards-compatibility with release.conf that does not have
135 SVNROOT="${SVNROOT}/"
141 # Prefix the branches with the SVNROOT for the full checkout URL.
142 SRCBRANCH="${SVNROOT}${SRCBRANCH}"
143 DOCBRANCH="${SVNROOT}${DOCBRANCH}"
144 PORTBRANCH="${SVNROOT}${PORTBRANCH}"
146 if [ -n "${EMBEDDEDBUILD}" ]; then
148 WITH_COMPRESSED_IMAGES=
150 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
151 arm:arm*|arm64:aarch64)
152 chroot_build_release_cmd="chroot_arm_build_release"
159 # If PORTS is set and NODOC is unset, force NODOC=yes because the ports
160 # tree is required to build the documentation set.
161 if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
162 echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
163 echo " and NOPORTS is set."
167 # If NOSRC, NOPORTS and/or NODOC are unset, they must not pass to make
168 # as variables. The release makefile verifies definedness of the
169 # NOPORTS/NODOC variables instead of their values.
171 if [ -n "${NOPORTS}" ]; then
172 SRCDOCPORTS="NOPORTS=yes"
174 if [ -n "${NODOC}" ]; then
175 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes"
177 if [ -n "${NOSRC}" ]; then
178 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes"
181 # The aggregated build-time flags based upon variables defined within
182 # this file, unless overridden by release.conf. In most cases, these
183 # will not need to be changed.
184 CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
185 if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
186 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
190 # Force src checkout if configured
192 if [ -n "${SRC_FORCE_CHECKOUT}" ]; then
193 FORCE_SRC_KEY="--force"
196 if [ -z "${CHROOTDIR}" ]; then
197 echo "Please set CHROOTDIR."
201 if [ $(id -u) -ne 0 ]; then
202 echo "Needs to be run as root."
206 # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist.
207 if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then
211 CHROOT_MAKEENV="${CHROOT_MAKEENV} \
212 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
213 CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
214 CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
215 CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
216 RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
218 RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
219 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
220 RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
221 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \
222 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
223 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
228 # chroot_setup(): Prepare the build chroot environment for the release build.
231 mkdir -p ${CHROOTDIR}/usr
233 if [ -z "${SRC_UPDATE_SKIP}" ]; then
234 ${VCSCMD} ${FORCE_SRC_KEY} ${SRCBRANCH} ${CHROOTDIR}/usr/src
236 if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
237 ${VCSCMD} ${DOCBRANCH} ${CHROOTDIR}/usr/doc
239 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
240 ${VCSCMD} ${PORTBRANCH} ${CHROOTDIR}/usr/ports
243 if [ -z "${CHROOTBUILD_SKIP}" ]; then
244 cd ${CHROOTDIR}/usr/src
245 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
246 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
248 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
255 # extra_chroot_setup(): Prepare anything additional within the build
256 # necessary for the release build.
257 extra_chroot_setup() {
258 mkdir -p ${CHROOTDIR}/dev
259 mount -t devfs devfs ${CHROOTDIR}/dev
260 [ -e /etc/resolv.conf -a ! -e ${CHROOTDIR}/etc/resolv.conf ] && \
261 cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
262 # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
263 # is created. This is needed by ports-mgmt/pkg.
264 eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
266 # If MAKE_CONF and/or SRC_CONF are set and not character devices
267 # (/dev/null), copy them to the chroot.
268 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
269 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
270 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
272 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
273 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
274 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
277 if [ -d ${CHROOTDIR}/usr/ports ]; then
278 # Trick the ports 'run-autotools-fixup' target to do the right
280 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
281 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
282 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
283 UNAME_r=${REVISION}-${BRANCH}
284 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
285 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
286 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
287 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
288 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
289 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
290 chroot ${CHROOTDIR} env ${PBUILD_FLAGS} \
291 OPTIONS_UNSET="AVAHI FOP IGOR" make -C \
292 /usr/ports/textproc/docproj \
293 FORCE_PKG_REGISTER=1 \
294 install clean distclean
298 if [ ! -z "${EMBEDDEDPORTS}" ]; then
299 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
300 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
301 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
302 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
303 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
304 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
305 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
306 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
307 for _PORT in ${EMBEDDEDPORTS}; do
308 eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \
309 /usr/ports/${_PORT} \
310 FORCE_PKG_REGISTER=1 deinstall install clean distclean
317 } # extra_chroot_setup()
319 # chroot_build_target(): Build the userland and kernel for the build target.
320 chroot_build_target() {
322 if [ ! -z "${EMBEDDEDBUILD}" ]; then
323 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
324 TARGET=${EMBEDDED_TARGET} \
325 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
326 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
327 TARGET=${EMBEDDED_TARGET} \
328 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
330 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
331 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
334 } # chroot_build_target
336 # chroot_build_release(): Invoke the 'make release' target.
337 chroot_build_release() {
339 if [ ! -z "${WITH_VMIMAGES}" ]; then
340 if [ -z "${VMFORMATS}" ]; then
341 VMFORMATS="$(eval chroot ${CHROOTDIR} \
342 make -C /usr/src/release -V VMFORMATS)"
344 if [ -z "${VMSIZE}" ]; then
345 VMSIZE="$(eval chroot ${CHROOTDIR} \
346 make -C /usr/src/release -V VMSIZE)"
348 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
349 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
351 eval chroot ${CHROOTDIR} make -C /usr/src/release \
352 ${RELEASE_RMAKEFLAGS} release
353 eval chroot ${CHROOTDIR} make -C /usr/src/release \
354 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
355 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
356 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
359 } # chroot_build_release()
376 # chroot_arm_build_release(): Create arm SD card image.
377 chroot_arm_build_release() {
379 case ${EMBEDDED_TARGET} in
381 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
382 . "${RELENGDIR}/tools/arm.subr"
388 [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
389 export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}"
390 export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
391 export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}"
392 eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj
393 export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)"
394 export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)"
395 export DESTDIR="${OBJDIR}/${KERNEL}"
396 export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img"
397 export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \
398 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
400 chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
401 chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
402 export mddev=$(chroot ${CHROOTDIR} \
403 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
408 mdconfig -d -u ${mddev}
409 chroot ${CHROOTDIR} rmdir ${DESTDIR}
410 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img
411 chroot ${CHROOTDIR} mkdir -p /R
412 chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \
413 /R/${OSRELEASE}-${BOARDNAME}.img
414 chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img
415 cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
417 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
421 } # chroot_arm_build_release()
423 # main(): Start here.
425 set -e # Everything must succeed
427 while getopts c: opt; do
430 RELEASECONF="$(realpath ${OPTARG})"
437 shift $(($OPTIND - 1))
438 if [ ! -z "${RELEASECONF}" ]; then
439 if [ -e "${RELEASECONF}" ]; then
442 echo "Nonexistent configuration file: ${RELEASECONF}"
443 echo "Using default build environment."
447 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
451 ${chroot_build_release_cmd}