release.sh revision 264106
1#!/bin/sh
2#-
3# Copyright (c) 2013, 2014 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 264106 2014-04-04 07:34:46Z 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=
86
87usage() {
88	echo "Usage: $0 [-c release.conf]"
89	exit 1
90}
91
92while getopts c: opt; do
93	case ${opt} in
94	c)
95		RELEASECONF="${OPTARG}"
96		if [ ! -e "${RELEASECONF}" ]; then
97			echo "ERROR: Configuration file ${RELEASECONF} does not exist."
98			exit 1
99		fi
100		# Source the specified configuration file for overrides
101		. ${RELEASECONF}
102		;;
103	\?)
104		usage
105		;;
106	esac
107done
108shift $(($OPTIND - 1))
109
110# Fix for backwards-compatibility with release.conf that does not have the
111# trailing '/'.
112case ${SVNROOT} in
113	*svn*)
114		SVNROOT="${SVNROOT}/"
115		;;
116	*)
117		;;
118esac
119
120# Prefix the branches with the SVNROOT for the full checkout URL.
121SRCBRANCH="${SVNROOT}${SRCBRANCH}"
122DOCBRANCH="${SVNROOT}${DOCBRANCH}"
123PORTBRANCH="${SVNROOT}${PORTBRANCH}"
124
125if [ -n "${EMBEDDEDBUILD}" ]; then
126	if [ -z "${XDEV}" ] || [ -z "${XDEV_ARCH}" ]; then
127		echo "ERROR: XDEV and XDEV_ARCH must be set in ${RELEASECONF}."
128		exit 1
129	fi
130	WITH_DVD=
131	NODOC=yes
132fi
133
134# If PORTS is set and NODOC is unset, force NODOC=yes because the ports tree
135# is required to build the documentation set.
136if [ -n "${NOPORTS}" ] && [ -z "${NODOC}" ]; then
137	echo "*** NOTICE: Setting NODOC=1 since ports tree is required"
138	echo "            and NOPORTS is set."
139	NODOC=yes
140fi
141
142# If NOPORTS and/or NODOC are unset, they must not pass to make as variables.
143# The release makefile verifies definedness of NOPORTS/NODOC variables
144# instead of their values.
145DOCPORTS=
146if [ -n "${NOPORTS}" ]; then
147	DOCPORTS="NOPORTS=yes "
148fi
149if [ -n "${NODOC}" ]; then
150	DOCPORTS="${DOCPORTS}NODOC=yes"
151fi
152
153# The aggregated build-time flags based upon variables defined within
154# this file, unless overridden by release.conf.  In most cases, these
155# will not need to be changed.
156CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
157if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
158	ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
159else
160	ARCH_FLAGS=
161fi
162CHROOT_MAKEENV="${CHROOT_MAKEENV} MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
163CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
164CHROOT_IMAKEFLAGS="${CONF_FILES}"
165CHROOT_DMAKEFLAGS="${CONF_FILES}"
166RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} ${CONF_FILES}"
167RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
168RELEASE_RMAKEFLAGS="${ARCH_FLAGS} KERNCONF=\"${KERNEL}\" ${CONF_FILES} \
169	${DOCPORTS} WITH_DVD=${WITH_DVD}"
170
171# Force src checkout if configured
172FORCE_SRC_KEY=
173if [ -n "${SRC_FORCE_CHECKOUT}" ]; then
174	FORCE_SRC_KEY="--force"
175fi
176
177if [ -z "${CHROOTDIR}" ]; then
178	echo "Please set CHROOTDIR."
179	exit 1
180fi
181
182if [ $(id -u) -ne 0 ]; then
183	echo "Needs to be run as root."
184	exit 1
185fi
186
187set -e # Everything must succeed
188
189mkdir -p ${CHROOTDIR}/usr
190
191${VCSCMD} ${FORCE_SRC_KEY} ${SRCBRANCH} ${CHROOTDIR}/usr/src
192if [ -z "${NODOC}" ]; then
193	${VCSCMD} ${DOCBRANCH} ${CHROOTDIR}/usr/doc
194fi
195if [ -z "${NOPORTS}" ]; then
196	${VCSCMD} ${PORTBRANCH} ${CHROOTDIR}/usr/ports
197fi
198
199if [ -z "${CHROOTBUILD_SKIP}" ]; then
200	cd ${CHROOTDIR}/usr/src
201	env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
202	env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
203		DESTDIR=${CHROOTDIR}
204	env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
205		DESTDIR=${CHROOTDIR}
206fi
207mount -t devfs devfs ${CHROOTDIR}/dev
208cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
209trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
210
211# If MAKE_CONF and/or SRC_CONF are set and not character devices (/dev/null),
212# copy them to the chroot.
213if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
214	mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
215	cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
216fi
217if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
218	mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
219	cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
220fi
221
222# Embedded builds do not use the 'make release' target.
223if [ -n "${EMBEDDEDBUILD}" ]; then
224	# If a crochet configuration file exists in *this* checkout of
225	# release/, copy it to the /tmp/external directory within the chroot.
226	# This allows building embedded releases without relying on updated
227	# scripts and/or configurations to exist in the branch being built.
228	if [ -e ${RELENGDIR}/tools/${XDEV}/crochet-${KERNEL}.conf ] && \
229		[ -e ${RELENGDIR}/${XDEV}/release.sh ]; then
230			mkdir -p ${CHROOTDIR}/tmp/external/${XDEV}/
231			cp ${RELENGDIR}/tools/${XDEV}/crochet-${KERNEL}.conf \
232				${CHROOTDIR}/tmp/external/${XDEV}/crochet-${KERNEL}.conf
233			/bin/sh ${RELENGDIR}/${XDEV}/release.sh
234	fi
235	# If the script does not exist for this architecture, exit.
236	# This probably should be checked earlier, but allowing the rest
237	# of the build process to get this far will at least set up the
238	# chroot environment for testing.
239	exit 0
240else
241	# Not embedded.
242	continue
243fi
244
245if [ -d ${CHROOTDIR}/usr/ports ]; then
246	# Run ldconfig(8) in the chroot directory so /var/run/ld-elf*.so.hints
247	# is created.  This is needed by ports-mgmt/pkg.
248	chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
249
250	## Trick the ports 'run-autotools-fixup' target to do the right thing.
251	_OSVERSION=$(sysctl -n kern.osreldate)
252	if [ -d ${CHROOTDIR}/usr/doc ] && [ -z "${NODOC}" ]; then
253		PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
254		PBUILD_FLAGS="${PBUILD_FLAGS}"
255		chroot ${CHROOTDIR} make -C /usr/ports/textproc/docproj \
256			${PBUILD_FLAGS} OPTIONS_UNSET="FOP IGOR" install clean distclean
257	fi
258fi
259
260eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
261eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
262eval chroot ${CHROOTDIR} make -C /usr/src/release ${RELEASE_RMAKEFLAGS} \
263	release
264eval chroot ${CHROOTDIR} make -C /usr/src/release ${RELEASE_RMAKEFLAGS} \
265	install DESTDIR=/R
266