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