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