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