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/"
93 # Set for embedded device builds.
96 # The default make.conf and src.conf to use. Set to /dev/null
97 # by default to avoid polluting the chroot(8) environment with
98 # non-default settings.
102 # The number of make(1) jobs, defaults to the number of CPUs available
103 # for buildworld, and half of number of CPUs available for buildkernel.
104 WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
105 KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
109 # The name of the kernel to build, defaults to GENERIC.
112 # Set to non-empty value to disable checkout of doc/ and/or ports/.
115 # Set to non-empty value to disable distributing source tree.
118 # Set to non-empty value to build dvd1.iso as part of the release.
120 WITH_COMPRESSED_IMAGES=
122 # Set to non-empty value to build virtual machine images as part of
125 WITH_COMPRESSED_VMIMAGES=
128 # Set to non-empty value to build virtual machine images for various
129 # cloud providers as part of the release.
135 # env_check(): Perform sanity tests on the build environment, such as ensuring
136 # files/directories exist, as well as adding backwards-compatibility hacks if
137 # necessary. This is called unconditionally, and overrides the defaults set
138 # in env_setup() if '-c <release.conf>' is specified.
140 chroot_build_release_cmd="chroot_build_release"
142 # Prefix the branches with the GITROOT for the full checkout URL.
143 SRC="${GITROOT}${GITSRC}"
144 #PORT="${GITROOT}${GITPORTS}"
145 PORT="svn://svn.freebsd.org/ports/"
147 if [ -n "${EMBEDDEDBUILD}" ]; then
149 WITH_COMPRESSED_IMAGES=
150 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
151 arm:arm*|arm64:aarch64|riscv:riscv64*)
152 chroot_build_release_cmd="chroot_arm_build_release"
159 # If NOSRC and/or NOPORTS are unset, they must not pass to make
160 # as variables. The release makefile verifies definedness of the
161 # NOPORTS variable instead of its value.
163 if [ -n "${NOPORTS}" ]; then
164 SRCPORTS="NOPORTS=yes"
166 if [ -n "${NOSRC}" ]; then
167 SRCPORTS="${SRCPORTS}${SRCPORTS:+ }NOSRC=yes"
170 # The aggregated build-time flags based upon variables defined within
171 # this file, unless overridden by release.conf. In most cases, these
172 # will not need to be changed.
173 CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
174 NOCONF_FILES="__MAKE_CONF=/dev/null SRCCONF=/dev/null"
175 if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
176 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
181 if [ -z "${CHROOTDIR}" ]; then
182 echo "Please set CHROOTDIR."
186 if [ $(id -u) -ne 0 ]; then
187 echo "Needs to be run as root."
191 # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist.
192 if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then
196 CHROOT_MAKEENV="${CHROOT_MAKEENV} \
197 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
198 CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${NOCONF_FILES}"
199 CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${NOCONF_FILES}"
200 CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${NOCONF_FILES}"
201 RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
203 RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
204 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
205 RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
206 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCPORTS} \
207 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
208 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
213 # chroot_setup(): Prepare the build chroot environment for the release build.
216 mkdir -p ${CHROOTDIR}/usr
218 if [ -z "${SRC_UPDATE_SKIP}" ]; then
219 if [ -d "${CHROOTDIR}/usr/src/.git" ]; then
220 git -C ${CHROOTDIR}/usr/src pull -q
222 ${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src
225 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
226 # if [ -d "${CHROOTDIR}/usr/ports/.git" ]; then
227 # git -C ${CHROOTDIR}/usr/ports pull -q
228 # XXX: Workaround for the overlap in the Git conversion timeframe.
229 if [ -d "${CHROOTDIR}/usr/ports/.svn" ]; then
230 ${SVNCMD} update ${CHROOTDIR}/usr/ports
232 #${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr/ports
233 # XXX: Workaround for the overlap in the Git
234 # conversion timeframe.
235 ${SVNCMD} co ${PORT}/${PORTBRANCH} ${CHROOTDIR}/usr/ports
239 if [ -z "${CHROOTBUILD_SKIP}" ]; then
240 cd ${CHROOTDIR}/usr/src
241 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
242 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
244 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
251 # extra_chroot_setup(): Prepare anything additional within the build
252 # necessary for the release build.
253 extra_chroot_setup() {
254 mkdir -p ${CHROOTDIR}/dev
255 mount -t devfs devfs ${CHROOTDIR}/dev
256 [ -e /etc/resolv.conf -a ! -e ${CHROOTDIR}/etc/resolv.conf ] && \
257 cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
258 # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
259 # is created. This is needed by ports-mgmt/pkg.
260 eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
262 # If MAKE_CONF and/or SRC_CONF are set and not character devices
263 # (/dev/null), copy them to the chroot.
264 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
265 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
266 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
268 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
269 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
270 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
273 if [ -z "${NOGIT}" ]; then
274 # Install git from ports or packages if the ports tree is
275 # available and VCSCMD is unset.
276 _gitcmd="$(which git)"
277 if [ -d ${CHROOTDIR}/usr/ports -a -z "${_gitcmd}" ]; 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 GITUNSETOPTS="CONTRIB CURL CVS GITWEB GUI HTMLDOCS"
285 GITUNSETOPTS="${GITUNSETOPTS} ICONV NLS P4 PERL"
286 GITUNSETOPTS="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN"
287 GITUNSETOPTS="${GITUNSETOPTS} PCRE PCRE2"
288 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
289 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
290 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
291 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
292 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
293 eval chroot ${CHROOTDIR} env OPTIONS_UNSET=\"${GITUNSETOPTS}\" \
295 make -C /usr/ports/devel/git FORCE_PKG_REGISTER=1 \
296 WRKDIRPREFIX=/tmp/ports \
297 DISTDIR=/tmp/distfiles \
298 install clean distclean
300 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
301 pkg install -y devel/git
302 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
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 UNAME_r=${REVISION}-${BRANCH}
312 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
313 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
314 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
315 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
316 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
317 for _PORT in ${EMBEDDEDPORTS}; do
318 eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \
319 /usr/ports/${_PORT} \
320 FORCE_PKG_REGISTER=1 deinstall install clean distclean
327 } # extra_chroot_setup()
329 # chroot_build_target(): Build the userland and kernel for the build target.
330 chroot_build_target() {
332 if [ ! -z "${EMBEDDEDBUILD}" ]; then
333 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
334 TARGET=${EMBEDDED_TARGET} \
335 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
336 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
337 TARGET=${EMBEDDED_TARGET} \
338 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
340 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
341 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
344 } # chroot_build_target
346 # chroot_build_release(): Invoke the 'make release' target.
347 chroot_build_release() {
349 if [ ! -z "${WITH_VMIMAGES}" ]; then
350 if [ -z "${VMFORMATS}" ]; then
351 VMFORMATS="$(eval chroot ${CHROOTDIR} \
352 make -C /usr/src/release -V VMFORMATS)"
354 if [ -z "${VMSIZE}" ]; then
355 VMSIZE="$(eval chroot ${CHROOTDIR} \
356 make -C /usr/src/release -V VMSIZE)"
358 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
359 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
361 eval chroot ${CHROOTDIR} make -C /usr/src/release \
362 ${RELEASE_RMAKEFLAGS} release
363 eval chroot ${CHROOTDIR} make -C /usr/src/release \
364 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
365 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
366 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
369 } # chroot_build_release()
384 echo "bootriscv64.efi"
389 # chroot_arm_build_release(): Create arm SD card image.
390 chroot_arm_build_release() {
392 case ${EMBEDDED_TARGET} in
394 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
395 . "${RELENGDIR}/tools/arm.subr"
401 [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
402 export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}"
403 export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
404 export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}"
405 eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj
406 export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)"
407 export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)"
408 export DESTDIR="${OBJDIR}/${KERNEL}"
409 export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img"
410 export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \
411 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
413 chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
414 chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
415 export mddev=$(chroot ${CHROOTDIR} \
416 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
421 mdconfig -d -u ${mddev}
422 chroot ${CHROOTDIR} rmdir ${DESTDIR}
423 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img
424 chroot ${CHROOTDIR} mkdir -p /R
425 chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \
426 /R/${OSRELEASE}-${BOARDNAME}.img
427 chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img
428 cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
430 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
434 } # chroot_arm_build_release()
436 # main(): Start here.
438 set -e # Everything must succeed
440 while getopts c: opt; do
443 RELEASECONF="$(realpath ${OPTARG})"
450 shift $(($OPTIND - 1))
451 if [ ! -z "${RELEASECONF}" ]; then
452 if [ -e "${RELEASECONF}" ]; then
455 echo "Nonexistent configuration file: ${RELEASECONF}"
456 echo "Using default build environment."
460 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
464 ${chroot_build_release_cmd}