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