3 # Copyright (c) 2013-2017 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:armv6|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 CHROOT_MAKEENV="${CHROOT_MAKEENV} \
207 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
208 CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
209 CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
210 CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
211 RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
213 RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
214 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
215 RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
216 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \
217 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
218 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
223 # chroot_setup(): Prepare the build chroot environment for the release build.
226 mkdir -p ${CHROOTDIR}/usr
228 if [ -z "${SRC_UPDATE_SKIP}" ]; then
229 ${VCSCMD} ${FORCE_SRC_KEY} ${SRCBRANCH} ${CHROOTDIR}/usr/src
231 if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
232 ${VCSCMD} ${DOCBRANCH} ${CHROOTDIR}/usr/doc
234 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
235 ${VCSCMD} ${PORTBRANCH} ${CHROOTDIR}/usr/ports
238 if [ -z "${CHROOTBUILD_SKIP}" ]; then
239 cd ${CHROOTDIR}/usr/src
240 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
241 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
243 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
250 # extra_chroot_setup(): Prepare anything additional within the build
251 # necessary for the release build.
252 extra_chroot_setup() {
253 mkdir -p ${CHROOTDIR}/dev
254 mount -t devfs devfs ${CHROOTDIR}/dev
255 [ -e /etc/resolv.conf ] && cp /etc/resolv.conf \
256 ${CHROOTDIR}/etc/resolv.conf
257 # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
258 # is created. This is needed by ports-mgmt/pkg.
259 eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
261 # If MAKE_CONF and/or SRC_CONF are set and not character devices
262 # (/dev/null), copy them to the chroot.
263 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
264 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
265 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
267 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
268 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
269 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
272 if [ -d ${CHROOTDIR}/usr/ports ]; then
273 # Trick the ports 'run-autotools-fixup' target to do the right
275 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
276 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
277 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
278 UNAME_r=${REVISION}-${BRANCH}
279 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
280 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
281 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
282 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
283 chroot ${CHROOTDIR} make -C /usr/ports/textproc/docproj \
284 ${PBUILD_FLAGS} OPTIONS_UNSET="FOP IGOR" \
285 FORCE_PKG_REGISTER=1 \
286 install clean distclean
290 if [ ! -z "${EMBEDDEDPORTS}" ]; then
291 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
292 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
293 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
294 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
295 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
296 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
297 for _PORT in ${EMBEDDEDPORTS}; do
298 eval chroot ${CHROOTDIR} make -C /usr/ports/${_PORT} \
299 FORCE_PKG_REGISTER=1 ${PBUILD_FLAGS} install clean distclean
306 } # extra_chroot_setup()
308 # chroot_build_target(): Build the userland and kernel for the build target.
309 chroot_build_target() {
311 if [ ! -z "${EMBEDDEDBUILD}" ]; then
312 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
313 TARGET=${EMBEDDED_TARGET} \
314 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
315 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
316 TARGET=${EMBEDDED_TARGET} \
317 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
319 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
320 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
323 } # chroot_build_target
325 # chroot_build_release(): Invoke the 'make release' target.
326 chroot_build_release() {
328 if [ ! -z "${WITH_VMIMAGES}" ]; then
329 if [ -z "${VMFORMATS}" ]; then
330 VMFORMATS="$(eval chroot ${CHROOTDIR} \
331 make -C /usr/src/release -V VMFORMATS)"
333 if [ -z "${VMSIZE}" ]; then
334 VMSIZE="$(eval chroot ${CHROOTDIR} \
335 make -C /usr/src/release -V VMSIZE)"
337 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
338 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
340 eval chroot ${CHROOTDIR} make -C /usr/src/release \
341 ${RELEASE_RMAKEFLAGS} release
342 eval chroot ${CHROOTDIR} make -C /usr/src/release \
343 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
344 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
345 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
348 } # chroot_build_release()
350 # chroot_arm_build_release(): Create arm SD card image.
351 chroot_arm_build_release() {
353 eval chroot ${CHROOTDIR} make -C /usr/src/release obj
354 case ${EMBEDDED_TARGET} in
356 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
357 . "${RELENGDIR}/tools/arm.subr"
363 [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
364 WORLDDIR="$(eval chroot ${CHROOTDIR} make -C /usr/src/release -V WORLDDIR)"
365 OBJDIR="$(eval chroot ${CHROOTDIR} make -C /usr/src/release -V .OBJDIR)"
366 DESTDIR="${OBJDIR}/${KERNEL}"
367 IMGBASE="${CHROOTDIR}/${OBJDIR}/${KERNEL}.img"
368 OSRELEASE="$(eval chroot ${CHROOTDIR} make -C /usr/src/release \
369 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
371 chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
372 chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
373 export mddev=$(chroot ${CHROOTDIR} \
374 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
378 mdconfig -d -u ${mddev}
379 chroot ${CHROOTDIR} rmdir ${DESTDIR}
380 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${KERNEL}.img
381 chroot ${CHROOTDIR} mkdir -p /R
382 chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${KERNEL}.img \
383 /R/${OSRELEASE}-${KERNEL}.img
384 chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${KERNEL}.img
385 cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
387 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
391 } # chroot_arm_build_release()
393 # main(): Start here.
395 set -e # Everything must succeed
397 while getopts c: opt; do
400 RELEASECONF="$(realpath ${OPTARG})"
407 shift $(($OPTIND - 1))
408 if [ ! -z "${RELEASECONF}" ]; then
409 if [ -e "${RELEASECONF}" ]; then
412 echo "Nonexistent configuration file: ${RELEASECONF}"
413 echo "Using default build environment."
417 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
421 ${chroot_build_release_cmd}