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 38export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin" 39 40VERSION=3 41 42# Prototypes that can be redefined per-chroot or per-target. 43load_chroot_env() { } 44load_target_env() { } 45buildenv_setup() { } 46 47usage() { 48 echo "Usage: $0 [-c release.conf]" 49 exit 1 50} 51 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. 55env_setup() { 56 # The directory within which the release will be built. 57 CHROOTDIR="/scratch" 58 if [ -z "${RELENGDIR}" ]; then 59 export RELENGDIR="$(dirname $(realpath ${0}))" 60 fi 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}" -a -z "${NOGIT}" ]; 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://git.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 PORT="https://cgit-beta.freebsd.org/ports.git" 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|riscv:riscv64*) 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 git -C ${CHROOTDIR}/usr/src pull -q 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 git -C ${CHROOTDIR}/usr/doc pull -q 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 git -C ${CHROOTDIR}/usr/ports pull -q 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 if [ -z "${NOGIT}" ]; then 280 # Install git from ports or packages if the ports tree is 281 # available and VCSCMD is unset. 282 _gitcmd="$(which git)" 283 if [ -d ${CHROOTDIR}/usr/ports -a -z "${_gitcmd}" ]; then 284 # Trick the ports 'run-autotools-fixup' target to do the right 285 # thing. 286 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U) 287 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION) 288 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH) 289 UNAME_r=${REVISION}-${BRANCH} 290 GITUNSETOPTS="CONTRIB CURL CVS GITWEB GUI HTMLDOCS" 291 GITUNSETOPTS="${GITUNSETOPTS} ICONV NLS P4 PERL" 292 GITUNSETOPTS="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN" 293 GITUNSETOPTS="${GITUNSETOPTS} PCRE PCRE2" 294 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 299 else 300 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \ 301 pkg install -y devel/git 302 eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \ 303 pkg clean -y 304 fi 305 fi 306 if [ -d ${CHROOTDIR}/usr/ports ]; then 307 # Trick the ports 'run-autotools-fixup' target to do the right 308 # thing. 309 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U) 310 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION) 311 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH) 312 UNAME_r=${REVISION}-${BRANCH} 313 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then 314 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes" 315 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}" 316 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}" 317 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports" 318 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles" 319 chroot ${CHROOTDIR} env ${PBUILD_FLAGS} \ 320 OPTIONS_UNSET="AVAHI FOP IGOR" make -C \ 321 /usr/ports/textproc/docproj \ 322 FORCE_PKG_REGISTER=1 \ 323 install clean distclean 324 fi 325 fi 326 327 if [ ! -z "${EMBEDDEDPORTS}" ]; then 328 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U) 329 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION) 330 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH) 331 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes" 332 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}" 333 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}" 334 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports" 335 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles" 336 for _PORT in ${EMBEDDEDPORTS}; do 337 eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \ 338 /usr/ports/${_PORT} \ 339 FORCE_PKG_REGISTER=1 deinstall install clean distclean 340 done 341 fi 342 343 buildenv_setup 344 345 return 0 346} # extra_chroot_setup() 347 348# chroot_build_target(): Build the userland and kernel for the build target. 349chroot_build_target() { 350 load_target_env 351 if [ ! -z "${EMBEDDEDBUILD}" ]; then 352 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \ 353 TARGET=${EMBEDDED_TARGET} \ 354 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}" 355 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \ 356 TARGET=${EMBEDDED_TARGET} \ 357 TARGET_ARCH=${EMBEDDED_TARGET_ARCH}" 358 fi 359 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld 360 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel 361 362 return 0 363} # chroot_build_target 364 365# chroot_build_release(): Invoke the 'make release' target. 366chroot_build_release() { 367 load_target_env 368 if [ ! -z "${WITH_VMIMAGES}" ]; then 369 if [ -z "${VMFORMATS}" ]; then 370 VMFORMATS="$(eval chroot ${CHROOTDIR} \ 371 make -C /usr/src/release -V VMFORMATS)" 372 fi 373 if [ -z "${VMSIZE}" ]; then 374 VMSIZE="$(eval chroot ${CHROOTDIR} \ 375 make -C /usr/src/release -V VMSIZE)" 376 fi 377 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \ 378 VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}" 379 fi 380 eval chroot ${CHROOTDIR} make -C /usr/src/release \ 381 ${RELEASE_RMAKEFLAGS} release 382 eval chroot ${CHROOTDIR} make -C /usr/src/release \ 383 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \ 384 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \ 385 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES} 386 387 return 0 388} # chroot_build_release() 389 390efi_boot_name() 391{ 392 case $1 in 393 arm) 394 echo "bootarm.efi" 395 ;; 396 arm64) 397 echo "bootaa64.efi" 398 ;; 399 amd64) 400 echo "bootx64.efi" 401 ;; 402 riscv) 403 echo "bootriscv64.efi" 404 ;; 405 esac 406} 407 408# chroot_arm_build_release(): Create arm SD card image. 409chroot_arm_build_release() { 410 load_target_env 411 case ${EMBEDDED_TARGET} in 412 arm|arm64|riscv) 413 if [ -e "${RELENGDIR}/tools/arm.subr" ]; then 414 . "${RELENGDIR}/tools/arm.subr" 415 fi 416 ;; 417 *) 418 ;; 419 esac 420 [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}" 421 export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}" 422 export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}" 423 export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}" 424 eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj 425 export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)" 426 export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)" 427 export DESTDIR="${OBJDIR}/${KERNEL}" 428 export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img" 429 export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \ 430 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \ 431 -V OSRELEASE)" 432 chroot ${CHROOTDIR} mkdir -p ${DESTDIR} 433 chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}} 434 export mddev=$(chroot ${CHROOTDIR} \ 435 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS}) 436 arm_create_disk 437 arm_install_base 438 arm_install_boot 439 arm_install_uboot 440 mdconfig -d -u ${mddev} 441 chroot ${CHROOTDIR} rmdir ${DESTDIR} 442 mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img 443 chroot ${CHROOTDIR} mkdir -p /R 444 chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \ 445 /R/${OSRELEASE}-${BOARDNAME}.img 446 chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img 447 cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \ 448 > CHECKSUM.SHA512 449 cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \ 450 > CHECKSUM.SHA256 451 452 return 0 453} # chroot_arm_build_release() 454 455# main(): Start here. 456main() { 457 set -e # Everything must succeed 458 env_setup 459 while getopts c: opt; do 460 case ${opt} in 461 c) 462 RELEASECONF="$(realpath ${OPTARG})" 463 ;; 464 \?) 465 usage 466 ;; 467 esac 468 done 469 shift $(($OPTIND - 1)) 470 if [ ! -z "${RELEASECONF}" ]; then 471 if [ -e "${RELEASECONF}" ]; then 472 . ${RELEASECONF} 473 else 474 echo "Nonexistent configuration file: ${RELEASECONF}" 475 echo "Using default build environment." 476 fi 477 fi 478 env_check 479 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit 480 chroot_setup 481 extra_chroot_setup 482 chroot_build_target 483 ${chroot_build_release_cmd} 484 485 return 0 486} # main() 487 488main "${@}" 489