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