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="$(dirname $(realpath ${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 disable distributing source tree.
 106         NOSRC=
 107
 108         # Set to non-empty value to build dvd1.iso as part of the release.
 109         WITH_DVD=
 110         WITH_COMPRESSED_IMAGES=
 111
 112         # Set to non-empty value to build virtual machine images as part of
 113         # the release.
 114         WITH_VMIMAGES=
 115         WITH_COMPRESSED_VMIMAGES=
 116         XZ_THREADS=0
 117
 118         # Set to non-empty value to build virtual machine images for various
 119         # cloud providers as part of the release.
 120         WITH_CLOUDWARE=
 121
 122         return 0
 123 } # env_setup()
 124
 125 # env_check(): Perform sanity tests on the build environment, such as ensuring
 126 # files/directories exist, as well as adding backwards-compatibility hacks if
 127 # necessary.  This is called unconditionally, and overrides the defaults set
 128 # in env_setup() if '-c <release.conf>' is specified.
 129 env_check() {
 130         chroot_build_release_cmd="chroot_build_release"
 131         # Fix for backwards-compatibility with release.conf that does not have
 132         # the trailing '/'.
 133         case ${SVNROOT} in
 134                 *svn*)
 135                         SVNROOT="${SVNROOT}/"
 136                         ;;
 137                 *)
 138                         ;;
 139         esac
 140
 141         # Prefix the branches with the SVNROOT for the full checkout URL.
 142         SRCBRANCH="${SVNROOT}${SRCBRANCH}"
 143         DOCBRANCH="${SVNROOT}${DOCBRANCH}"
 144         PORTBRANCH="${SVNROOT}${PORTBRANCH}"
 145
 146         if [ -n "${EMBEDDEDBUILD}" ]; then
 147                 WITH_DVD=
 148                 WITH_COMPRESSED_IMAGES=
 149                 NODOC=yes
 150                 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
 151                         arm:armv6)
 152                                 chroot_build_release_cmd="chroot_arm_armv6_build_release"
 153                                 ;;
 154                         *)
 155                 esac
 156         fi
 157
 158         # If PORTS is set and NODOC is unset, force NODOC=yes because the ports
 159         # tree is required to build the documentation set.
 160         if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
 161                 echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
 162                 echo "            and NOPORTS is set."
 163                 NODOC=yes
 164         fi
 165
 166         # If NOSRC, NOPORTS and/or NODOC are unset, they must not pass to make
 167         # as variables.  The release makefile verifies definedness of the
 168         # NOPORTS/NODOC variables instead of their values.
 169         SRCDOCPORTS=
 170         if [ -n "${NOPORTS}" ]; then
 171                 SRCDOCPORTS="NOPORTS=yes"
 172         fi
 173         if [ -n "${NODOC}" ]; then
 174                 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NODOC=yes"
 175         fi
 176         if [ -n "${NOSRC}" ]; then
 177                 SRCDOCPORTS="${SRCDOCPORTS}${SRCDOCPORTS:+ }NOSRC=yes"
 178         fi
 179
 180         # The aggregated build-time flags based upon variables defined within
 181         # this file, unless overridden by release.conf.  In most cases, these
 182         # will not need to be changed.
 183         CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
 184         if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
 185                 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
 186         else
 187                 ARCH_FLAGS=
 188         fi
 189         # Force src checkout if configured
 190         FORCE_SRC_KEY=
 191         if [ -n "${SRC_FORCE_CHECKOUT}" ]; then
 192                 FORCE_SRC_KEY="--force"
 193         fi
 194
 195         if [ -z "${CHROOTDIR}" ]; then
 196                 echo "Please set CHROOTDIR."
 197                 exit 1
 198         fi
 199
 200         if [ $(id -u) -ne 0 ]; then
 201                 echo "Needs to be run as root."
 202                 exit 1
 203         fi
 204
 205         CHROOT_MAKEENV="${CHROOT_MAKEENV} \
 206                 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
 207         CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
 208         CHROOT_IMAKEFLAGS="${CONF_FILES}"
 209         CHROOT_DMAKEFLAGS="${CONF_FILES}"
 210         RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
 211                 ${CONF_FILES}"
 212         RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
 213                 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
 214         RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
 215                 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCDOCPORTS} \
 216                 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
 217                 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
 218
 219         return 0
 220 } # env_check()
 221
 222 # chroot_setup(): Prepare the build chroot environment for the release build.
 223 chroot_setup() {
 224         load_chroot_env
 225         mkdir -p ${CHROOTDIR}/usr
 226
 227         if [ -z "${SRC_UPDATE_SKIP}" ]; then
 228                 ${VCSCMD} ${FORCE_SRC_KEY} ${SRCBRANCH} ${CHROOTDIR}/usr/src
 229         fi
 230         if [ -z "${NODOC}" ] && [ -z "${DOC_UPDATE_SKIP}" ]; then
 231                 ${VCSCMD} ${DOCBRANCH} ${CHROOTDIR}/usr/doc
 232         fi
 233         if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
 234                 ${VCSCMD} ${PORTBRANCH} ${CHROOTDIR}/usr/ports
 235         fi
 236
 237         if [ -z "${CHROOTBUILD_SKIP}" ]; then
 238                 cd ${CHROOTDIR}/usr/src
 239                 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
 240                 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
 241                         DESTDIR=${CHROOTDIR}
 242                 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
 243                         DESTDIR=${CHROOTDIR}
 244         fi
 245
 246         return 0
 247 } # chroot_setup()
 248
 249 # extra_chroot_setup(): Prepare anything additional within the build
 250 # necessary for the release build.
 251 extra_chroot_setup() {
 252         mkdir -p ${CHROOTDIR}/dev
 253         mount -t devfs devfs ${CHROOTDIR}/dev
 254         [ -e /etc/resolv.conf ] && cp /etc/resolv.conf \
 255                 ${CHROOTDIR}/etc/resolv.conf
 256         # Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
 257         # is created.  This is needed by ports-mgmt/pkg.
 258         eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
 259
 260         # If MAKE_CONF and/or SRC_CONF are set and not character devices
 261         # (/dev/null), copy them to the chroot.
 262         if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
 263                 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
 264                 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
 265         fi
 266         if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
 267                 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
 268                 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
 269         fi
 270
 271         if [ -d ${CHROOTDIR}/usr/ports ]; then
 272                 # Trick the ports 'run-autotools-fixup' target to do the right
 273                 # thing.
 274                 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
 275                 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
 276                 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
 277                 UNAME_r=${REVISION}-${BRANCH}
 278                 if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
 279                         PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
 280                         PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
 281                         PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
 282                         chroot ${CHROOTDIR} make -C /usr/ports/textproc/docproj \
 283                                 ${PBUILD_FLAGS} OPTIONS_UNSET="FOP IGOR" \
 284                                 FORCE_PKG_REGISTER=1 \
 285                                 install clean distclean
 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                 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
 294                 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
 295                 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
 296                 for _PORT in ${EMBEDDEDPORTS}; do
 297                         eval chroot ${CHROOTDIR} make -C /usr/ports/${_PORT} \
 298                                 FORCE_PKG_REGISTER=1 ${PBUILD_FLAGS} install clean distclean
 299                 done
 300         fi
 301
 302         buildenv_setup
 303
 304         return 0
 305 } # extra_chroot_setup()
 306
 307 # chroot_build_target(): Build the userland and kernel for the build target.
 308 chroot_build_target() {
 309         load_target_env
 310         if [ ! -z "${EMBEDDEDBUILD}" ]; then
 311                 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
 312                         TARGET=${EMBEDDED_TARGET} \
 313                         TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
 314                 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
 315                         TARGET=${EMBEDDED_TARGET} \
 316                         TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
 317         fi
 318         eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
 319         eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
 320
 321         return 0
 322 } # chroot_build_target
 323
 324 # chroot_build_release(): Invoke the 'make release' target.
 325 chroot_build_release() {
 326         load_target_env
 327         if [ ! -z "${WITH_VMIMAGES}" ]; then
 328                 if [ -z "${VMFORMATS}" ]; then
 329                         VMFORMATS="$(eval chroot ${CHROOTDIR} \
 330                                 make -C /usr/src/release -V VMFORMATS)"
 331                 fi
 332                 if [ -z "${VMSIZE}" ]; then
 333                         VMSIZE="$(eval chroot ${CHROOTDIR} \
 334                                 make -C /usr/src/release -V VMSIZE)"
 335                 fi
 336                 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
 337                         VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
 338         fi
 339         eval chroot ${CHROOTDIR} make -C /usr/src/release \
 340                 ${RELEASE_RMAKEFLAGS} release
 341         eval chroot ${CHROOTDIR} make -C /usr/src/release \
 342                 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
 343                 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
 344                 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
 345
 346         return 0
 347 } # chroot_build_release()
 348
 349 # chroot_arm_armv6_build_release(): Create arm/armv6 SD card image.
 350 chroot_arm_armv6_build_release() {
 351         load_target_env
 352         eval chroot ${CHROOTDIR} make -C /usr/src/release obj
 353         if [ -e "${RELENGDIR}/tools/${EMBEDDED_TARGET}.subr" ]; then
 354                 . "${RELENGDIR}/tools/${EMBEDDED_TARGET}.subr"
 355         fi
 356         [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
 357         WORLDDIR="$(eval chroot ${CHROOTDIR} make -C /usr/src/release -V WORLDDIR)"
 358         OBJDIR="$(eval chroot ${CHROOTDIR} make -C /usr/src/release -V .OBJDIR)"
 359         DESTDIR="${OBJDIR}/${KERNEL}"
 360         IMGBASE="${CHROOTDIR}/${OBJDIR}/${KERNEL}.img"
 361         OSRELEASE="$(eval chroot ${CHROOTDIR} make -C /usr/src/release \
 362                 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
 363                 -V OSRELEASE)"
 364         chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
 365         chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
 366         export mddev=$(chroot ${CHROOTDIR} \
 367                 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
 368         arm_create_disk
 369         arm_install_base
 370         arm_install_uboot
 371         mdconfig -d -u ${mddev}
 372         chroot ${CHROOTDIR} rmdir ${DESTDIR}
 373         mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${KERNEL}.img
 374         chroot ${CHROOTDIR} mkdir -p /R
 375         chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${KERNEL}.img \
 376                 /R/${OSRELEASE}-${KERNEL}.img
 377         chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${KERNEL}.img
 378         cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
 379                 > CHECKSUM.SHA512
 380         cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
 381                 > CHECKSUM.SHA256
 382
 383         return 0
 384 } # chroot_arm_armv6_build_release()
 385
 386 # main(): Start here.
 387 main() {
 388         set -e # Everything must succeed
 389         env_setup
 390         while getopts c: opt; do
 391                 case ${opt} in
 392                         c)
 393                                 RELEASECONF="${OPTARG}"
 394                                 ;;
 395                         \?)
 396                                 usage
 397                                 ;;
 398                 esac
 399         done
 400         shift $(($OPTIND - 1))
 401         if [ ! -z "${RELEASECONF}" ]; then
 402                 if [ -e "${RELEASECONF}" ]; then
 403                         . ${RELEASECONF}
 404                 else
 405                         echo "Nonexistent configuration file: ${RELEASECONF}"
 406                         echo "Using default build environment."
 407                 fi
 408         fi
 409         env_check
 410         trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
 411         chroot_setup
 412         extra_chroot_setup
 413         chroot_build_target
 414         ${chroot_build_release_cmd}
 415
 416         return 0
 417 } # main()
 418
 419 main "${@}"