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