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