release/release.sh

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