1#!/bin/sh 2#- 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 7# All rights reserved. 8# 9# Portions of this software were developed by Glen Barber 10# under sponsorship from the FreeBSD Foundation. 11# 12# Redistribution and use in source and binary forms, with or without 13# modification, are permitted provided that the following conditions 14# are met: 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. 20# 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 31# SUCH DAMAGE. 32# 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 36# 37# $FreeBSD$ 38# 39 40export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin" 41 42VERSION=3 43 44# Prototypes that can be redefined per-chroot or per-target. 45load_chroot_env() { } 46load_target_env() { } 47buildenv_setup() { } 48 49usage() { 50 echo "Usage: $0 [-c release.conf]" 51 exit 1 52} 53 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. 57env_setup() { 58 # The directory within which the release will be built. 59 CHROOTDIR="/scratch" 60 RELENGDIR="$(dirname $(realpath ${0}))" 61 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 66 done 67 68 if [ -z "${VCSCMD}" ]; then 69 echo "*** The devel/git port/package is required." 70 exit 1 71 fi 72 VCSCMD="/usr/local/bin/git clone -q" 73 74 # The default git checkout server, and branches for src/, doc/, 75 # and ports/. 76 GITROOT="https://cgit-beta.FreeBSD.org/" 77 SRCBRANCH="main" 78 DOCBRANCH="main" 79 PORTBRANCH="main" 80 GITSRC="src.git" 81 GITPORTS="ports.git" 82 GITDOC="doc.git" 83 84 # Set for embedded device builds. 85 EMBEDDEDBUILD= 86 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. 90 MAKE_CONF="/dev/null" 91 SRC_CONF="/dev/null" 92 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))" 97 98 MAKE_FLAGS="-s" 99 100 # The name of the kernel to build, defaults to GENERIC. 101 KERNEL="GENERIC" 102 103 # Set to non-empty value to disable checkout of doc/ and/or ports/. 104 # Disabling ports/ checkout also forces NODOC to be set. 105 NODOC= 106 NOPORTS= 107 108 # Set to non-empty value to disable distributing source tree. 109 NOSRC= 110 111 # Set to non-empty value to build dvd1.iso as part of the release. 112 WITH_DVD= 113 WITH_COMPRESSED_IMAGES= 114 115 # Set to non-empty value to build virtual machine images as part of 116 # the release. 117 WITH_VMIMAGES= 118 WITH_COMPRESSED_VMIMAGES= 119 XZ_THREADS=0 120 121 # Set to non-empty value to build virtual machine images for various 122 # cloud providers as part of the release. 123 WITH_CLOUDWARE= 124 125 return 0 126} # env_setup() 127 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. 132env_check() { 133 chroot_build_release_cmd="chroot_build_release" 134 135 # Prefix the branches with the GITROOT for the full checkout URL. 136 SRC="${GITROOT}${GITSRC}" 137 DOC="${GITROOT}${GITDOC}" 138 PORT="${GITROOT}${GITPORTS}" 139 140 if [ -n "${EMBEDDEDBUILD}" ]; then 141 WITH_DVD= 142 WITH_COMPRESSED_IMAGES= 143 NODOC=yes 144 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in 145 arm:arm*|arm64:aarch64) 146 chroot_build_release_cmd="chroot_arm_build_release" 147 ;; 148 *) 149 ;; 150 esac 151 fi 152 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." 158 NODOC=yes 159 fi 160 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. 164 SRCDOCPORTS= 165 if [ -n "${NOPORTS}" ]; then 166 SRCDOCPORTS="NOPORTS=yes" 167 fi 168 if [ -n "${NODOC}" ]; then 169 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes" 170 fi 171 if [ -n "${NOSRC}" ]; then 172 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes" 173 fi 174 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}" 181 else 182 ARCH_FLAGS= 183 fi 184 185 if [ -z "${CHROOTDIR}" ]; then 186 echo "Please set CHROOTDIR." 187 exit 1 188 fi 189 190 if [ $(id -u) -ne 0 ]; then 191 echo "Needs to be run as root." 192 exit 1 193 fi 194 195 # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist. 196 if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then 197 CHROOTBUILD_SKIP= 198 fi 199 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} \ 206 ${CONF_FILES}" 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}" 213 214 return 0 215} # env_check() 216 217# chroot_setup(): Prepare the build chroot environment for the release build. 218chroot_setup() { 219 load_chroot_env 220 mkdir -p ${CHROOTDIR}/usr 221 222 if [ -z "${SRC_UPDATE_SKIP}" ]; then 223 ${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src 224 fi 225 if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then 226 ${VCSCMD} ${DOC} -b ${DOCBRANCH} ${CHROOTDIR}/usr/doc 227 fi 228 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then 229 ${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr/ports 230 fi 231 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 \ 236 DESTDIR=${CHROOTDIR} 237 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \ 238 DESTDIR=${CHROOTDIR} 239 fi 240 241 return 0 242} # chroot_setup() 243 244# extra_chroot_setup(): Prepare anything additional within the build 245# necessary for the release build. 246extra_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 254 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} 260 fi 261 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then 262 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF}) 263 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF} 264 fi 265 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 271 # thing. 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 285 fi 286 if [ -d ${CHROOTDIR}/usr/ports ]; then 287 # Trick the ports 'run-autotools-fixup' target to do the right 288 # thing. 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 304 fi 305 fi 306 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 320 done 321 fi 322 323 buildenv_setup 324 325 return 0 326} # extra_chroot_setup() 327 328# chroot_build_target(): Build the userland and kernel for the build target. 329chroot_build_target() { 330 load_target_env 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}" 338 fi 339 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld 340 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel 341 342 return 0 343} # chroot_build_target 344 345# chroot_build_release(): Invoke the 'make release' target. 346chroot_build_release() { 347 load_target_env 348 if [ ! -z "${WITH_VMIMAGES}" ]; then 349 if [ -z "${VMFORMATS}" ]; then 350 VMFORMATS="$(eval chroot ${CHROOTDIR} \ 351 make -C /usr/src/release -V VMFORMATS)" 352 fi 353 if [ -z "${VMSIZE}" ]; then 354 VMSIZE="$(eval chroot ${CHROOTDIR} \ 355 make -C /usr/src/release -V VMSIZE)" 356 fi 357 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \ 358 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}" 359 fi 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} 366 367 return 0 368} # chroot_build_release() 369 370efi_boot_name() 371{ 372 case $1 in 373 arm) 374 echo "bootarm.efi" 375 ;; 376 arm64) 377 echo "bootaa64.efi" 378 ;; 379 amd64) 380 echo "bootx64.efi" 381 ;; 382 esac 383} 384 385# chroot_arm_build_release(): Create arm SD card image. 386chroot_arm_build_release() { 387 load_target_env 388 case ${EMBEDDED_TARGET} in 389 arm|arm64) 390 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then 391 . "${RELENGDIR}/tools/arm.subr" 392 fi 393 ;; 394 *) 395 ;; 396 esac 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} \ 408 -V OSRELEASE)" 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}) 413 arm_create_disk 414 arm_install_base 415 arm_install_boot 416 arm_install_uboot 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}* \ 425 > CHECKSUM.SHA512 426 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \ 427 > CHECKSUM.SHA256 428 429 return 0 430} # chroot_arm_build_release() 431 432# main(): Start here. 433main() { 434 set -e # Everything must succeed 435 env_setup 436 while getopts c: opt; do 437 case ${opt} in 438 c) 439 RELEASECONF="$(realpath ${OPTARG})" 440 ;; 441 \?) 442 usage 443 ;; 444 esac 445 done 446 shift $(($OPTIND - 1)) 447 if [ ! -z "${RELEASECONF}" ]; then 448 if [ -e "${RELEASECONF}" ]; then 449 . ${RELEASECONF} 450 else 451 echo "Nonexistent configuration file: ${RELEASECONF}" 452 echo "Using default build environment." 453 fi 454 fi 455 env_check 456 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit 457 chroot_setup 458 extra_chroot_setup 459 chroot_build_target 460 ${chroot_build_release_cmd} 461 462 return 0 463} # main() 464 465main "${@}" 466