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