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 VCSUPDATE="/usr/local/bin/git pull -q" 74 75 # The default git checkout server, and branches for src/, doc/, 76 # and ports/. 77 GITROOT="https://cgit-beta.FreeBSD.org/" 78 SRCBRANCH="main" 79 DOCBRANCH="main" 80 PORTBRANCH="main" 81 GITSRC="src.git" 82 GITPORTS="ports.git" 83 GITDOC="doc.git" 84 85 # Set for embedded device builds. 86 EMBEDDEDBUILD= 87 88 # The default make.conf and src.conf to use. Set to /dev/null 89 # by default to avoid polluting the chroot(8) environment with 90 # non-default settings. 91 MAKE_CONF="/dev/null" 92 SRC_CONF="/dev/null" 93 94 # The number of make(1) jobs, defaults to the number of CPUs available 95 # for buildworld, and half of number of CPUs available for buildkernel. 96 WORLD_FLAGS="-j$(sysctl -n hw.ncpu)" 97 KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))" 98 99 MAKE_FLAGS="-s" 100 101 # The name of the kernel to build, defaults to GENERIC. 102 KERNEL="GENERIC" 103 104 # Set to non-empty value to disable checkout of doc/ and/or ports/. 105 # Disabling ports/ checkout also forces NODOC to be set. 106 NODOC= 107 NOPORTS= 108 109 # Set to non-empty value to disable distributing source tree. 110 NOSRC= 111 112 # Set to non-empty value to build dvd1.iso as part of the release. 113 WITH_DVD= 114 WITH_COMPRESSED_IMAGES= 115 116 # Set to non-empty value to build virtual machine images as part of 117 # the release. 118 WITH_VMIMAGES= 119 WITH_COMPRESSED_VMIMAGES= 120 XZ_THREADS=0 121 122 # Set to non-empty value to build virtual machine images for various 123 # cloud providers as part of the release. 124 WITH_CLOUDWARE= 125 126 return 0 127} # env_setup() 128 129# env_check(): Perform sanity tests on the build environment, such as ensuring 130# files/directories exist, as well as adding backwards-compatibility hacks if 131# necessary. This is called unconditionally, and overrides the defaults set 132# in env_setup() if '-c <release.conf>' is specified. 133env_check() { 134 chroot_build_release_cmd="chroot_build_release" 135 136 # Prefix the branches with the GITROOT for the full checkout URL. 137 SRC="${GITROOT}${GITSRC}" 138 DOC="${GITROOT}${GITDOC}" 139 PORT="${GITROOT}${GITPORTS}" 140 141 if [ -n "${EMBEDDEDBUILD}" ]; then 142 WITH_DVD= 143 WITH_COMPRESSED_IMAGES= 144 NODOC=yes 145 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in 146 arm:arm*|arm64:aarch64) 147 chroot_build_release_cmd="chroot_arm_build_release" 148 ;; 149 *) 150 ;; 151 esac 152 fi 153 154 # If PORTS is set and NODOC is unset, force NODOC=yes because the ports 155 # tree is required to build the documentation set. 156 if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then 157 echo "*** NOTICE: Setting NODOC=1 since ports tree is required" 158 echo " and NOPORTS is set." 159 NODOC=yes 160 fi 161 162 # If NOSRC, NOPORTS and/or NODOC are unset, they must not pass to make 163 # as variables. The release makefile verifies definedness of the 164 # NOPORTS/NODOC variables instead of their values. 165 SRCDOCPORTS= 166 if [ -n "${NOPORTS}" ]; then 167 SRCDOCPORTS="NOPORTS=yes" 168 fi 169 if [ -n "${NODOC}" ]; then 170 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes" 171 fi 172 if [ -n "${NOSRC}" ]; then 173 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes" 174 fi 175 176 # The aggregated build-time flags based upon variables defined within 177 # this file, unless overridden by release.conf. In most cases, these 178 # will not need to be changed. 179 CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}" 180 if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then 181 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}" 182 else 183 ARCH_FLAGS= 184 fi 185 186 if [ -z "${CHROOTDIR}" ]; then 187 echo "Please set CHROOTDIR." 188 exit 1 189 fi 190 191 if [ $(id -u) -ne 0 ]; then 192 echo "Needs to be run as root." 193 exit 1 194 fi 195 196 # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist. 197 if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then 198 CHROOTBUILD_SKIP= 199 fi 200 201 CHROOT_MAKEENV="${CHROOT_MAKEENV} \ 202 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj" 203 CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}" 204 CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}" 205 CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}" 206 RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \ 207 ${CONF_FILES}" 208 RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \ 209 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}" 210 RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \ 211 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \ 212 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \ 213 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}" 214 215 return 0 216} # env_check() 217 218# chroot_setup(): Prepare the build chroot environment for the release build. 219chroot_setup() { 220 load_chroot_env 221 mkdir -p ${CHROOTDIR}/usr 222 223 if [ -z "${SRC_UPDATE_SKIP}" ]; then 224 if [ -d "${CHROOTDIR}/usr/src/.git" ]; then 225 ${VCSUPDATE} -C ${CHROOTDIR}/usr/src 226 else 227 ${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src 228 fi 229 fi 230 if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then 231 if [ -d "${CHROOTDIR}/usr/doc/.git" ]; then 232 ${VCSUPDATE} -C ${CHROOTDIR}/usr/doc 233 else 234 ${VCSCMD} ${DOC} -b ${DOCBRANCH} ${CHROOTDIR}/usr/doc 235 fi 236 fi 237 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then 238 if [ -d "${CHROOTDIR}/usr/ports/.git" ]; then 239 ${VCSUPDATE} -C ${CHROOTDIR}/usr/ports 240 else 241 ${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr/ports 242 fi 243 fi 244 245 if [ -z "${CHROOTBUILD_SKIP}" ]; then 246 cd ${CHROOTDIR}/usr/src 247 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld 248 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \ 249 DESTDIR=${CHROOTDIR} 250 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \ 251 DESTDIR=${CHROOTDIR} 252 fi 253 254 return 0 255} # chroot_setup() 256 257# extra_chroot_setup(): Prepare anything additional within the build 258# necessary for the release build. 259extra_chroot_setup() { 260 mkdir -p ${CHROOTDIR}/dev 261 mount -t devfs devfs ${CHROOTDIR}/dev 262 [ -e /etc/resolv.conf -a ! -e ${CHROOTDIR}/etc/resolv.conf ] && \ 263 cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf 264 # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints 265 # is created. This is needed by ports-mgmt/pkg. 266 eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart 267 268 # If MAKE_CONF and/or SRC_CONF are set and not character devices 269 # (/dev/null), copy them to the chroot. 270 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then 271 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF}) 272 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF} 273 fi 274 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then 275 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF}) 276 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF} 277 fi 278 279 # Install git from ports or packages if the ports tree is 280 # available and VCSCMD is unset. 281 _gitcmd="$(which git)" 282 if [ -d ${CHROOTDIR}/usr/ports -a -z "${_gitcmd}" ]; then 283 # Trick the ports 'run-autotools-fixup' target to do the right 284 # thing. 285 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U) 286 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION) 287 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH) 288 UNAME_r=${REVISION}-${BRANCH} 289 GITUNSETOPTS="CONTRIB CURL CVS GITWEB GUI HTMLDOCS" 290 GITUNSETOPTS="${GITUNSETOPTS} ICONV NLS P4 PERL" 291 GITUNSETOPTS="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN" 292 GITUNSETOPTS="${GITUNSETOPTS} PCRE PCRE2" 293 eval chroot ${CHROOTDIR} env OPTIONS_UNSET=\"${GITUNSETOPTS}\" \ 294 make -C /usr/ports/devel/git FORCE_PKG_REGISTER=1 \ 295 WRKDIRPREFIX=/tmp/ports \ 296 DISTDIR=/tmp/distfiles \ 297 install clean distclean 298 else 299 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \ 300 pkg install -y devel/git 301 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \ 302 pkg clean -y 303 fi 304 if [ -d ${CHROOTDIR}/usr/ports ]; then 305 # Trick the ports 'run-autotools-fixup' target to do the right 306 # thing. 307 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U) 308 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION) 309 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH) 310 UNAME_r=${REVISION}-${BRANCH} 311 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then 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 chroot ${CHROOTDIR} env ${PBUILD_FLAGS} \ 318 OPTIONS_UNSET="AVAHI FOP IGOR" make -C \ 319 /usr/ports/textproc/docproj \ 320 FORCE_PKG_REGISTER=1 \ 321 install clean distclean 322 fi 323 fi 324 325 if [ ! -z "${EMBEDDEDPORTS}" ]; then 326 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U) 327 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION) 328 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH) 329 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes" 330 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}" 331 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}" 332 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports" 333 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles" 334 for _PORT in ${EMBEDDEDPORTS}; do 335 eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \ 336 /usr/ports/${_PORT} \ 337 FORCE_PKG_REGISTER=1 deinstall install clean distclean 338 done 339 fi 340 341 buildenv_setup 342 343 return 0 344} # extra_chroot_setup() 345 346# chroot_build_target(): Build the userland and kernel for the build target. 347chroot_build_target() { 348 load_target_env 349 if [ ! -z "${EMBEDDEDBUILD}" ]; then 350 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \ 351 TARGET=${EMBEDDED_TARGET} \ 352 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}" 353 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \ 354 TARGET=${EMBEDDED_TARGET} \ 355 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}" 356 fi 357 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld 358 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel 359 360 return 0 361} # chroot_build_target 362 363# chroot_build_release(): Invoke the 'make release' target. 364chroot_build_release() { 365 load_target_env 366 if [ ! -z "${WITH_VMIMAGES}" ]; then 367 if [ -z "${VMFORMATS}" ]; then 368 VMFORMATS="$(eval chroot ${CHROOTDIR} \ 369 make -C /usr/src/release -V VMFORMATS)" 370 fi 371 if [ -z "${VMSIZE}" ]; then 372 VMSIZE="$(eval chroot ${CHROOTDIR} \ 373 make -C /usr/src/release -V VMSIZE)" 374 fi 375 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \ 376 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}" 377 fi 378 eval chroot ${CHROOTDIR} make -C /usr/src/release \ 379 ${RELEASE_RMAKEFLAGS} release 380 eval chroot ${CHROOTDIR} make -C /usr/src/release \ 381 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \ 382 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \ 383 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES} 384 385 return 0 386} # chroot_build_release() 387 388efi_boot_name() 389{ 390 case $1 in 391 arm) 392 echo "bootarm.efi" 393 ;; 394 arm64) 395 echo "bootaa64.efi" 396 ;; 397 amd64) 398 echo "bootx64.efi" 399 ;; 400 esac 401} 402 403# chroot_arm_build_release(): Create arm SD card image. 404chroot_arm_build_release() { 405 load_target_env 406 case ${EMBEDDED_TARGET} in 407 arm|arm64) 408 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then 409 . "${RELENGDIR}/tools/arm.subr" 410 fi 411 ;; 412 *) 413 ;; 414 esac 415 [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}" 416 export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}" 417 export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}" 418 export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}" 419 eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj 420 export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)" 421 export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)" 422 export DESTDIR="${OBJDIR}/${KERNEL}" 423 export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img" 424 export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \ 425 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \ 426 -V OSRELEASE)" 427 chroot ${CHROOTDIR} mkdir -p ${DESTDIR} 428 chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}} 429 export mddev=$(chroot ${CHROOTDIR} \ 430 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS}) 431 arm_create_disk 432 arm_install_base 433 arm_install_boot 434 arm_install_uboot 435 mdconfig -d -u ${mddev} 436 chroot ${CHROOTDIR} rmdir ${DESTDIR} 437 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img 438 chroot ${CHROOTDIR} mkdir -p /R 439 chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \ 440 /R/${OSRELEASE}-${BOARDNAME}.img 441 chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img 442 cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \ 443 > CHECKSUM.SHA512 444 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \ 445 > CHECKSUM.SHA256 446 447 return 0 448} # chroot_arm_build_release() 449 450# main(): Start here. 451main() { 452 set -e # Everything must succeed 453 env_setup 454 while getopts c: opt; do 455 case ${opt} in 456 c) 457 RELEASECONF="$(realpath ${OPTARG})" 458 ;; 459 \?) 460 usage 461 ;; 462 esac 463 done 464 shift $(($OPTIND - 1)) 465 if [ ! -z "${RELEASECONF}" ]; then 466 if [ -e "${RELEASECONF}" ]; then 467 . ${RELEASECONF} 468 else 469 echo "Nonexistent configuration file: ${RELEASECONF}" 470 echo "Using default build environment." 471 fi 472 fi 473 env_check 474 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit 475 chroot_setup 476 extra_chroot_setup 477 chroot_build_target 478 ${chroot_build_release_cmd} 479 480 return 0 481} # main() 482 483main "${@}" 484