release/release.sh

   1 #!/bin/sh
   2 #-
   3 # Copyright (c) 2013-2015 The FreeBSD Foundation
   4 # Copyright (c) 2013 Glen Barber
   5 # Copyright (c) 2011 Nathan Whitehorn
   6 # All rights reserved.
   7 #
   8 # Portions of this software were developed by Glen Barber
   9 # under sponsorship from the FreeBSD Foundation.
  10 #
  11 # Redistribution and use in source and binary forms, with or without
  12 # modification, are permitted provided that the following conditions
  13 # are met:
  14 # 1. Redistributions of source code must retain the above copyright
  15 #    notice, this list of conditions and the following disclaimer.
  16 # 2. Redistributions in binary form must reproduce the above copyright
  17 #    notice, this list of conditions and the following disclaimer in the
  18 #    documentation and/or other materials provided with the distribution.
  19 #
  20 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 # SUCH DAMAGE.
  31 #
  32 # release.sh: check out source trees, and build release components with
  33 #  totally clean, fresh trees.
  34 # Based on release/generate-release.sh written by Nathan Whitehorn
  35 #
  36 # $FreeBSD$
  37 #
  38
  39 export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
  40
  41 VERSION=2
  42
  43 # Prototypes that can be redefined per-chroot or per-target.
  44 load_chroot_env() { }
  45 load_target_env() { }
  46 buildenv_setup() { }
  47
  48 usage() {
  49         echo "Usage: $0 [-c release.conf]"
  50         exit 1
  51 }
  52
  53 # env_setup(): Set up the default build environment variables, such as the
  54 # CHROOTDIR, VCSCMD, SVNROOT, etc.  This is called before the release.conf
  55 # file is sourced, if '-c <release.conf>' is specified.
  56 env_setup() {
  57         # The directory within which the release will be built.
  58         CHROOTDIR="/scratch"
  59         RELENGDIR="$(realpath $(dirname $(basename ${0})))"
  60
  61         # The default version control system command to obtain the sources.
  62         for _dir in /usr/bin /usr/local/bin; do
  63                 for _svn in svn svnlite; do
  64                         [ -x "${_dir}/${_svn}" ] && VCSCMD="${_dir}/${_svn}"
  65                         [ ! -z "${VCSCMD}" ] && break 2
  66                 done
  67         done
  68         VCSCMD="${VCSCMD} checkout"
  69
  70         # The default svn checkout server, and svn branches for src/, doc/,
  71         # and ports/.
  72         SVNROOT="svn://svn.FreeBSD.org/"
  73         SRCBRANCH="base/head@rHEAD"
  74         DOCBRANCH="doc/head@rHEAD"
  75         PORTBRANCH="ports/head@rHEAD"
  76
  77         # Set for embedded device builds.
  78         EMBEDDEDBUILD=
  79
  80         # Sometimes one needs to checkout src with --force svn option.
  81         # If custom kernel configs copied to src tree before checkout, e.g.
  82         SRC_FORCE_CHECKOUT=
  83
  84         # The default make.conf and src.conf to use.  Set to /dev/null
  85         # by default to avoid polluting the chroot(8) environment with
  86         # non-default settings.
  87         MAKE_CONF="/dev/null"
  88         SRC_CONF="/dev/null"
  89
  90         # The number of make(1) jobs, defaults to the number of CPUs available
  91         # for buildworld, and half of number of CPUs available for buildkernel.
  92         WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
  93         KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
  94
  95         MAKE_FLAGS="-s"
  96
  97         # The name of the kernel to build, defaults to GENERIC.
  98         KERNEL="GENERIC"
  99
 100         # Set to non-empty value to disable checkout of doc/ and/or ports/.
 101         # Disabling ports/ checkout also forces NODOC to be set.
 102         NODOC=
 103         NOPORTS=
 104
 105         # Set to non-empty value to build dvd1.iso as part of the release.
 106         WITH_DVD=
 107         WITH_COMPRESSED_IMAGES=
 108
 109         # Set to non-empty value to build virtual machine images as part of
 110         # the release.
 111         WITH_VMIMAGES=
 112         WITH_COMPRESSED_VMIMAGES=
 113         XZ_THREADS=0
 114
 115         # Set to non-empty value to build virtual machine images for various
 116         # cloud providers as part of the release.
 117         WITH_CLOUDWARE=
 118
 119         return 0
 120 } # env_setup()
 121
 122 # env_check(): Perform sanity tests on the build environment, such as ensuring
 123 # files/directories exist, as well as adding backwards-compatibility hacks if
 124 # necessary.  This is called unconditionally, and overrides the defaults set
 125 # in env_setup() if '-c <release.conf>' is specified.
 126 env_check() {
 127         # Fix for backwards-compatibility with release.conf that does not have
 128         # the trailing '/'.
 129         case ${SVNROOT} in
 130                 *svn*)
 131                         SVNROOT="${SVNROOT}/"
 132                         ;;
 133                 *)
 134                         ;;
 135         esac
 136
 137         # Prefix the branches with the SVNROOT for the full checkout URL.
 138         SRCBRANCH="${SVNROOT}${SRCBRANCH}"
 139         DOCBRANCH="${SVNROOT}${DOCBRANCH}"
 140         PORTBRANCH="${SVNROOT}${PORTBRANCH}"
 141
 142         if [ -n "${EMBEDDEDBUILD}" ]; then
 143                 WITH_DVD=
 144                 WITH_COMPRESSED_IMAGES=
 145                 NODOC=yes
 146         fi
 147
 148         # If PORTS is set and NODOC is unset, force NODOC=yes because the ports
 149         # tree is required to build the documentation set.
 150         if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
 151                 echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
 152                 echo "            and NOPORTS is set."
 153                 NODOC=yes
 154         fi
 155
 156         # If NOPORTS and/or NODOC are unset, they must not pass to make as
 157         # variables.  The release makefile verifies definedness of the
 158         # NOPORTS/NODOC variables instead of their values.
 159         DOCPORTS=
 160         if [ -n "${NOPORTS}" ]; then
 161                 DOCPORTS="NOPORTS=yes "
 162         fi
 163         if [ -n "${NODOC}" ]; then
 164                 DOCPORTS="${DOCPORTS}NODOC=yes"
 165         fi
 166
 167         # The aggregated build-time flags based upon variables defined within
 168         # this file, unless overridden by release.conf.  In most cases, these
 169         # will not need to be changed.
 170         CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
 171         if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
 172                 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
 173         else
 174                 ARCH_FLAGS=
 175         fi
 176         # Force src checkout if configured
 177         FORCE_SRC_KEY=
 178         if [ -n "${SRC_FORCE_CHECKOUT}" ]; then
 179                 FORCE_SRC_KEY="--force"
 180         fi
 181
 182         if [ -z "${CHROOTDIR}" ]; then
 183                 echo "Please set CHROOTDIR."
 184                 exit 1
 185         fi
 186
 187         if [ $(id -u) -ne 0 ]; then
 188                 echo "Needs to be run as root."
 189                 exit 1
 190         fi
 191
 192         CHROOT_MAKEENV="${CHROOT_MAKEENV} \
 193                 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
 194         CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
 195         CHROOT_IMAKEFLAGS="${CONF_FILES}"
 196         CHROOT_DMAKEFLAGS="${CONF_FILES}"
 197         RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
 198                 ${CONF_FILES}"
 199         RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
 200                 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
 201         RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
 202                 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${DOCPORTS} \
 203                 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
 204                 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
 205
 206         return 0
 207 } # env_check()
 208
 209 # chroot_setup(): Prepare the build chroot environment for the release build.
 210 chroot_setup() {
 211         load_chroot_env
 212         mkdir -p ${CHROOTDIR}/usr
 213
 214         if [ -z "${SRC_UPDATE_SKIP}" ]; then
 215                 ${VCSCMD} ${FORCE_SRC_KEY} ${SRCBRANCH} ${CHROOTDIR}/usr/src
 216         fi
 217         if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
 218                 ${VCSCMD} ${DOCBRANCH} ${CHROOTDIR}/usr/doc
 219         fi
 220         if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
 221                 ${VCSCMD} ${PORTBRANCH} ${CHROOTDIR}/usr/ports
 222         fi
 223
 224         if [ -z "${CHROOTBUILD_SKIP}" ]; then
 225                 cd ${CHROOTDIR}/usr/src
 226                 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
 227                 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
 228                         DESTDIR=${CHROOTDIR}
 229                 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
 230                         DESTDIR=${CHROOTDIR}
 231         fi
 232
 233         return 0
 234 } # chroot_setup()
 235
 236 # extra_chroot_setup(): Prepare anything additional within the build
 237 # necessary for the release build.
 238 extra_chroot_setup() {
 239         mount -t devfs devfs ${CHROOTDIR}/dev
 240         [ -e /etc/resolv.conf ] && cp /etc/resolv.conf \
 241                 ${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         if [ -d ${CHROOTDIR}/usr/ports ]; then
 258                 # Trick the ports 'run-autotools-fixup' target to do the right
 259                 # thing.
 260                 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
 261                 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
 262                 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
 263                 UNAME_r=${REVISION}-${BRANCH}
 264                 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
 265                         PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
 266                         PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
 267                         PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
 268                         chroot ${CHROOTDIR} make -C /usr/ports/textproc/docproj \
 269                                 ${PBUILD_FLAGS} OPTIONS_UNSET="FOP IGOR" \
 270                                 install clean distclean
 271                 fi
 272         fi
 273
 274         if [ ! -z "${EMBEDDEDPORTS}" ]; then
 275                 for _PORT in ${EMBEDDEDPORTS}; do
 276                         eval chroot ${CHROOTDIR} make -C /usr/ports/${_PORT} \
 277                                 BATCH=1 FORCE_PKG_REGISTER=1 install clean distclean
 278                 done
 279         fi
 280
 281         buildenv_setup
 282
 283         return 0
 284 } # extra_chroot_setup()
 285
 286 # chroot_build_target(): Build the userland and kernel for the build target.
 287 chroot_build_target() {
 288         load_target_env
 289         if [ ! -z "${EMBEDDEDBUILD}" ]; then
 290                 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
 291                         TARGET=${EMBEDDED_TARGET} \
 292                         TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
 293                 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
 294                         TARGET=${EMBEDDED_TARGET} \
 295                         TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
 296         fi
 297         eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
 298         eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
 299
 300         return 0
 301 } # chroot_build_target
 302
 303 # chroot_build_release(): Invoke the 'make release' target.
 304 chroot_build_release() {
 305         load_target_env
 306
 307         if [ -z "${EMBEDDEDBUILD}" ]; then
 308                 eval chroot ${CHROOTDIR} make -C /usr/src/release \
 309                         ${RELEASE_RMAKEFLAGS} release
 310                 eval chroot ${CHROOTDIR} make -C /usr/src/release \
 311                         ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
 312                         WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
 313                         WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
 314                 return 0
 315         else
 316                 load_target_env
 317                 # XXX: In progress.
 318                 return 0
 319         fi
 320
 321         return 0
 322 } # chroot_build_release()
 323
 324 # main(): Start here.
 325 main() {
 326         set -e # Everything must succeed
 327         env_setup
 328         while getopts c: opt; do
 329                 case ${opt} in
 330                         c)
 331                                 RELEASECONF="${OPTARG}"
 332                                 ;;
 333                         \?)
 334                                 usage
 335                                 ;;
 336                 esac
 337         done
 338         shift $(($OPTIND - 1))
 339         if [ ! -z "${RELEASECONF}" ]; then
 340                 if [ -e "${RELEASECONF}" ]; then
 341                         . ${RELEASECONF}
 342                 else
 343                         echo "Nonexistent configuration file: ${RELEASECONF}"
 344                         echo "Using default build environment."
 345                 fi
 346         fi
 347         env_check
 348         trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
 349         chroot_setup
 350         extra_chroot_setup
 351         chroot_build_target
 352         chroot_build_release
 353
 354         return 0
 355 } # main()
 356
 357 main "${@}"