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