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 PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
  40 export PATH
  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 # The directory within which the release will be built.
  48 CHROOTDIR="/scratch"
  49 RELENGDIR="$(realpath $(dirname $(basename ${0})))"
  50
  51 # The default version control system command to obtain the sources.
  52 VCSCMD="svn checkout"
  53
  54 # The default svn checkout server, and svn branches for src/, doc/,
  55 # and ports/.
  56 SVNROOT="svn://svn.FreeBSD.org/"
  57 SRCBRANCH="base/head@rHEAD"
  58 DOCBRANCH="doc/head@rHEAD"
  59 PORTBRANCH="ports/head@rHEAD"
  60
  61 # Set for embedded device builds.
  62 EMBEDDEDBUILD=
  63
  64 # Sometimes one needs to checkout src with --force svn option.
  65 # If custom kernel configs copied to src tree before checkout, e.g.
  66 SRC_FORCE_CHECKOUT=
  67
  68 # The default make.conf and src.conf to use.  Set to /dev/null
  69 # by default to avoid polluting the chroot(8) environment with
  70 # non-default settings.
  71 MAKE_CONF="/dev/null"
  72 SRC_CONF="/dev/null"
  73
  74 # The number of make(1) jobs, defaults to the number of CPUs available for
  75 # buildworld, and half of number of CPUs available for buildkernel.
  76 WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
  77 KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
  78
  79 MAKE_FLAGS="-s"
  80
  81 # The name of the kernel to build, defaults to GENERIC.
  82 KERNEL="GENERIC"
  83
  84 # Set to non-empty value to disable checkout of doc/ and/or ports/.  Disabling
  85 # ports/ checkout also forces NODOC to be set.
  86 NODOC=
  87 NOPORTS=
  88
  89 # Set to non-empty value to build dvd1.iso as part of the release.
  90 WITH_DVD=
  91 WITH_COMPRESSED_IMAGES=
  92
  93 # Set to non-empty value to build virtual machine images as part of
  94 # the release.
  95 WITH_VMIMAGES=
  96 WITH_COMPRESSED_VMIMAGES=
  97 XZ_THREADS=0
  98
  99 # Set to non-empty value to build virtual machine images for various
 100 # cloud providers as part of the release.
 101 WITH_CLOUDWARE=
 102
 103 usage() {
 104         echo "Usage: $0 [-c release.conf]"
 105         exit 1
 106 }
 107
 108 while getopts c: opt; do
 109         case ${opt} in
 110         c)
 111                 RELEASECONF="${OPTARG}"
 112                 if [ ! -e "${RELEASECONF}" ]; then
 113                         echo "ERROR: Configuration file ${RELEASECONF} does not exist."
 114                         exit 1
 115                 fi
 116                 # Source the specified configuration file for overrides
 117                 . ${RELEASECONF}
 118                 ;;
 119         \?)
 120                 usage
 121                 ;;
 122         esac
 123 done
 124 shift $(($OPTIND - 1))
 125
 126 # Fix for backwards-compatibility with release.conf that does not have the
 127 # trailing '/'.
 128 case ${SVNROOT} in
 129         *svn*)
 130                 SVNROOT="${SVNROOT}/"
 131                 ;;
 132         *)
 133                 ;;
 134 esac
 135
 136 # Prefix the branches with the SVNROOT for the full checkout URL.
 137 SRCBRANCH="${SVNROOT}${SRCBRANCH}"
 138 DOCBRANCH="${SVNROOT}${DOCBRANCH}"
 139 PORTBRANCH="${SVNROOT}${PORTBRANCH}"
 140
 141 if [ -n "${EMBEDDEDBUILD}" ]; then
 142         WITH_DVD=
 143         WITH_COMPRESSED_IMAGES=
 144         NODOC=yes
 145 fi
 146
 147 # If PORTS is set and NODOC is unset, force NODOC=yes because the ports tree
 148 # is required to build the documentation set.
 149 if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
 150         echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
 151         echo "            and NOPORTS is set."
 152         NODOC=yes
 153 fi
 154
 155 # If NOPORTS and/or NODOC are unset, they must not pass to make as variables.
 156 # The release makefile verifies definedness of NOPORTS/NODOC variables
 157 # instead of their values.
 158 DOCPORTS=
 159 if [ -n "${NOPORTS}" ]; then
 160         DOCPORTS="NOPORTS=yes "
 161 fi
 162 if [ -n "${NODOC}" ]; then
 163         DOCPORTS="${DOCPORTS}NODOC=yes"
 164 fi
 165
 166 # The aggregated build-time flags based upon variables defined within
 167 # this file, unless overridden by release.conf.  In most cases, these
 168 # will not need to be changed.
 169 CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
 170 if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
 171         ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
 172 else
 173         ARCH_FLAGS=
 174 fi
 175 load_chroot_env
 176 CHROOT_MAKEENV="${CHROOT_MAKEENV} MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
 177 CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
 178 CHROOT_IMAKEFLAGS="${CONF_FILES}"
 179 CHROOT_DMAKEFLAGS="${CONF_FILES}"
 180 RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} ${CONF_FILES}"
 181 RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
 182 RELEASE_RMAKEFLAGS="${ARCH_FLAGS} KERNCONF=\"${KERNEL}\" ${CONF_FILES} \
 183         ${DOCPORTS} WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
 184         WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
 185
 186 # Force src checkout if configured
 187 FORCE_SRC_KEY=
 188 if [ -n "${SRC_FORCE_CHECKOUT}" ]; then
 189         FORCE_SRC_KEY="--force"
 190 fi
 191
 192 if [ -z "${CHROOTDIR}" ]; then
 193         echo "Please set CHROOTDIR."
 194         exit 1
 195 fi
 196
 197 if [ $(id -u) -ne 0 ]; then
 198         echo "Needs to be run as root."
 199         exit 1
 200 fi
 201
 202 set -e # Everything must succeed
 203
 204 mkdir -p ${CHROOTDIR}/usr
 205
 206 if [ -z "${SRC_UPDATE_SKIP}" ]; then
 207         ${VCSCMD} ${FORCE_SRC_KEY} ${SRCBRANCH} ${CHROOTDIR}/usr/src
 208 fi
 209 if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
 210         ${VCSCMD} ${DOCBRANCH} ${CHROOTDIR}/usr/doc
 211 fi
 212 if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
 213         ${VCSCMD} ${PORTBRANCH} ${CHROOTDIR}/usr/ports
 214 fi
 215
 216 if [ -z "${CHROOTBUILD_SKIP}" ]; then
 217         cd ${CHROOTDIR}/usr/src
 218         env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
 219         env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
 220                 DESTDIR=${CHROOTDIR}
 221         env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
 222                 DESTDIR=${CHROOTDIR}
 223 fi
 224 mount -t devfs devfs ${CHROOTDIR}/dev
 225 cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
 226 trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
 227
 228 # If MAKE_CONF and/or SRC_CONF are set and not character devices (/dev/null),
 229 # copy them to the chroot.
 230 if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
 231         mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
 232         cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
 233 fi
 234 if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
 235         mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
 236         cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
 237 fi
 238
 239 # Embedded builds do not use the 'make release' target.
 240 if [ -n "${EMBEDDEDBUILD}" ]; then
 241         # If a crochet configuration file exists in *this* checkout of
 242         # release/, copy it to the /tmp/external directory within the chroot.
 243         # This allows building embedded releases without relying on updated
 244         # scripts and/or configurations to exist in the branch being built.
 245         load_target_env
 246         if [ -e ${RELENGDIR}/tools/${XDEV}/crochet-${KERNEL}.conf ] && \
 247                 [ -e ${RELENGDIR}/${XDEV}/release.sh ]; then
 248                         mkdir -p ${CHROOTDIR}/tmp/external/${XDEV}/
 249                         cp ${RELENGDIR}/tools/${XDEV}/crochet-${KERNEL}.conf \
 250                                 ${CHROOTDIR}/tmp/external/${XDEV}/crochet-${KERNEL}.conf
 251                         /bin/sh ${RELENGDIR}/${XDEV}/release.sh
 252         fi
 253         # If the script does not exist for this architecture, exit.
 254         # This probably should be checked earlier, but allowing the rest
 255         # of the build process to get this far will at least set up the
 256         # chroot environment for testing.
 257         exit 0
 258 else
 259         # Not embedded.
 260         continue
 261 fi
 262
 263 if [ -d ${CHROOTDIR}/usr/ports ]; then
 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         chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
 267
 268         ## Trick the ports 'run-autotools-fixup' target to do the right thing.
 269         _OSVERSION=$(sysctl -n kern.osreldate)
 270         REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
 271         BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
 272         UNAME_r=${REVISION}-${BRANCH}
 273         if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
 274                 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
 275                 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
 276                 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
 277                 chroot ${CHROOTDIR} make -C /usr/ports/textproc/docproj \
 278                         ${PBUILD_FLAGS} OPTIONS_UNSET="FOP IGOR" \
 279                         install clean distclean
 280         fi
 281 fi
 282
 283 buildenv_setup
 284 load_target_env
 285 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
 286 eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
 287 eval chroot ${CHROOTDIR} make -C /usr/src/release ${RELEASE_RMAKEFLAGS} \
 288         release
 289 eval chroot ${CHROOTDIR} make -C /usr/src/release ${RELEASE_RMAKEFLAGS} \
 290         install DESTDIR=/R WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
 291         WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}