]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - release/release.sh
zfs: merge OpenZFS master-bedbc13da
[FreeBSD/FreeBSD.git] / release / release.sh
1 #!/bin/sh
2 #-
3 # Copyright (c) 2020-2021 Rubicon Communications, LLC (netgate.com)
4 # Copyright (c) 2013-2019 The FreeBSD Foundation
5 # Copyright (c) 2013 Glen Barber
6 # Copyright (c) 2011 Nathan Whitehorn
7 # All rights reserved.
8 #
9 # Portions of this software were developed by Glen Barber
10 # under sponsorship from the FreeBSD Foundation.
11 #
12 # Redistribution and use in source and binary forms, with or without
13 # modification, are permitted provided that the following conditions
14 # are met:
15 # 1. Redistributions of source code must retain the above copyright
16 #    notice, this list of conditions and the following disclaimer.
17 # 2. Redistributions in binary form must reproduce the above copyright
18 #    notice, this list of conditions and the following disclaimer in the
19 #    documentation and/or other materials provided with the distribution.
20 #
21 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 # SUCH DAMAGE.
32 #
33 # release.sh: check out source trees, and build release components with
34 #  totally clean, fresh trees.
35 # Based on release/generate-release.sh written by Nathan Whitehorn
36 #
37
38 export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"
39
40 VERSION=3
41
42 # Prototypes that can be redefined per-chroot or per-target.
43 load_chroot_env() { }
44 load_target_env() { }
45 buildenv_setup() { }
46
47 usage() {
48         echo "Usage: $0 [-c release.conf]"
49         exit 1
50 }
51
52 # env_setup(): Set up the default build environment variables, such as the
53 # CHROOTDIR, VCSCMD, GITROOT, etc.  This is called before the release.conf
54 # file is sourced, if '-c <release.conf>' is specified.
55 env_setup() {
56         # The directory within which the release will be built.
57         CHROOTDIR="/scratch"
58         if [ -z "${RELENGDIR}" ]; then
59                 export RELENGDIR="$(dirname $(realpath ${0}))"
60         fi
61
62         # The default version control system command to obtain the sources.
63         for _dir in /usr/bin /usr/local/bin; do
64                 [ -x "${_dir}/git" ] && VCSCMD="/${_dir}/git"
65                 [ ! -z "${VCSCMD}" ] && break 2
66         done
67
68         # Find the Subversion binary to use.  This is a workaround to use
69         # the source of truth for the ports tree, as the conversion to Git
70         # is targeted to occur slightly after the currently-scheduled 13.0
71         # release.
72         for _dir in /usr/bin /usr/local/bin; do
73                 for _svn in svn svnlite; do
74                         [ -x "${_dir}/${_svn}" ] && SVNCMD="${_dir}/${_svn}"
75                         [ ! -z "${SVNCMD}" ] && break 2
76                 done
77         done
78
79         if [ -z "${VCSCMD}" -a -z "${NOGIT}" ]; then
80                 echo "*** The devel/git port/package is required."
81                 exit 1
82         fi
83         VCSCMD="/usr/local/bin/git clone -q"
84
85         # The default git checkout server, and branches for src/, doc/,
86         # and ports/.
87         GITROOT="https://git.FreeBSD.org/"
88         SRCBRANCH="main"
89         PORTBRANCH="head"
90         GITSRC="src.git"
91         GITPORTS="ports.git"
92
93         # Set for embedded device builds.
94         EMBEDDEDBUILD=
95
96         # The default make.conf and src.conf to use.  Set to /dev/null
97         # by default to avoid polluting the chroot(8) environment with
98         # non-default settings.
99         MAKE_CONF="/dev/null"
100         SRC_CONF="/dev/null"
101
102         # The number of make(1) jobs, defaults to the number of CPUs available
103         # for buildworld, and half of number of CPUs available for buildkernel.
104         WORLD_FLAGS="-j$(sysctl -n hw.ncpu)"
105         KERNEL_FLAGS="-j$(( $(( $(sysctl -n hw.ncpu) + 1 )) / 2))"
106
107         MAKE_FLAGS="-s"
108
109         # The name of the kernel to build, defaults to GENERIC.
110         KERNEL="GENERIC"
111
112         # Set to non-empty value to disable checkout of doc/ and/or ports/.
113         NOPORTS=
114
115         # Set to non-empty value to disable distributing source tree.
116         NOSRC=
117
118         # Set to non-empty value to build dvd1.iso as part of the release.
119         WITH_DVD=
120         WITH_COMPRESSED_IMAGES=
121
122         # Set to non-empty value to build virtual machine images as part of
123         # the release.
124         WITH_VMIMAGES=
125         WITH_COMPRESSED_VMIMAGES=
126         XZ_THREADS=0
127
128         # Set to non-empty value to build virtual machine images for various
129         # cloud providers as part of the release.
130         WITH_CLOUDWARE=
131
132         return 0
133 } # env_setup()
134
135 # env_check(): Perform sanity tests on the build environment, such as ensuring
136 # files/directories exist, as well as adding backwards-compatibility hacks if
137 # necessary.  This is called unconditionally, and overrides the defaults set
138 # in env_setup() if '-c <release.conf>' is specified.
139 env_check() {
140         chroot_build_release_cmd="chroot_build_release"
141
142         # Prefix the branches with the GITROOT for the full checkout URL.
143         SRC="${GITROOT}${GITSRC}"
144         #PORT="${GITROOT}${GITPORTS}"
145         PORT="svn://svn.freebsd.org/ports/"
146
147         if [ -n "${EMBEDDEDBUILD}" ]; then
148                 WITH_DVD=
149                 WITH_COMPRESSED_IMAGES=
150                 case ${EMBEDDED_TARGET}:${EMBEDDED_TARGET_ARCH} in
151                         arm:arm*|arm64:aarch64|riscv:riscv64*)
152                                 chroot_build_release_cmd="chroot_arm_build_release"
153                                 ;;
154                         *)
155                                 ;;
156                 esac
157         fi
158
159         # If NOSRC and/or NOPORTS are unset, they must not pass to make
160         # as variables.  The release makefile verifies definedness of the
161         # NOPORTS variable instead of its value.
162         SRCPORTS=
163         if [ -n "${NOPORTS}" ]; then
164                 SRCPORTS="NOPORTS=yes"
165         fi
166         if [ -n "${NOSRC}" ]; then
167                 SRCPORTS="${SRCPORTS}${SRCPORTS:+ }NOSRC=yes"
168         fi
169
170         # The aggregated build-time flags based upon variables defined within
171         # this file, unless overridden by release.conf.  In most cases, these
172         # will not need to be changed.
173         CONF_FILES="__MAKE_CONF=${MAKE_CONF} SRCCONF=${SRC_CONF}"
174         if [ -n "${TARGET}" ] && [ -n "${TARGET_ARCH}" ]; then
175                 ARCH_FLAGS="TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}"
176         else
177                 ARCH_FLAGS=
178         fi
179
180         if [ -z "${CHROOTDIR}" ]; then
181                 echo "Please set CHROOTDIR."
182                 exit 1
183         fi
184
185         if [ $(id -u) -ne 0 ]; then
186                 echo "Needs to be run as root."
187                 exit 1
188         fi
189
190         # Unset CHROOTBUILD_SKIP if the chroot(8) does not appear to exist.
191         if [ ! -z "${CHROOTBUILD_SKIP}" -a ! -e ${CHROOTDIR}/bin/sh ]; then
192                 CHROOTBUILD_SKIP=
193         fi
194
195         CHROOT_MAKEENV="${CHROOT_MAKEENV} \
196                 MAKEOBJDIRPREFIX=${CHROOTDIR}/tmp/obj"
197         CHROOT_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${CONF_FILES}"
198         CHROOT_IMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
199         CHROOT_DMAKEFLAGS="${WORLD_FLAGS} ${CONF_FILES}"
200         RELEASE_WMAKEFLAGS="${MAKE_FLAGS} ${WORLD_FLAGS} ${ARCH_FLAGS} \
201                 ${CONF_FILES}"
202         RELEASE_KMAKEFLAGS="${MAKE_FLAGS} ${KERNEL_FLAGS} \
203                 KERNCONF=\"${KERNEL}\" ${ARCH_FLAGS} ${CONF_FILES}"
204         RELEASE_RMAKEFLAGS="${ARCH_FLAGS} \
205                 KERNCONF=\"${KERNEL}\" ${CONF_FILES} ${SRCPORTS} \
206                 WITH_DVD=${WITH_DVD} WITH_VMIMAGES=${WITH_VMIMAGES} \
207                 WITH_CLOUDWARE=${WITH_CLOUDWARE} XZ_THREADS=${XZ_THREADS}"
208
209         return 0
210 } # env_check()
211
212 # chroot_setup(): Prepare the build chroot environment for the release build.
213 chroot_setup() {
214         load_chroot_env
215         mkdir -p ${CHROOTDIR}/usr
216
217         if [ -z "${SRC_UPDATE_SKIP}" ]; then
218                 if [ -d "${CHROOTDIR}/usr/src/.git" ]; then
219                         git -C ${CHROOTDIR}/usr/src pull -q
220                 else
221                         ${VCSCMD} ${SRC} -b ${SRCBRANCH} ${CHROOTDIR}/usr/src
222                 fi
223         fi
224         if [ -z "${NOPORTS}" ] && [ -z "${PORTS_UPDATE_SKIP}" ]; then
225                 # if [ -d "${CHROOTDIR}/usr/ports/.git" ]; then
226                         # git -C ${CHROOTDIR}/usr/ports pull -q
227                 # XXX: Workaround for the overlap in the Git conversion timeframe.
228                 if [ -d "${CHROOTDIR}/usr/ports/.svn" ]; then
229                         ${SVNCMD} update ${CHROOTDIR}/usr/ports
230                 else
231                         #${VCSCMD} ${PORT} -b ${PORTBRANCH} ${CHROOTDIR}/usr/ports
232                         # XXX: Workaround for the overlap in the Git
233                         # conversion timeframe.
234                         ${SVNCMD} co ${PORT}/${PORTBRANCH} ${CHROOTDIR}/usr/ports
235                 fi
236         fi
237
238         if [ -z "${CHROOTBUILD_SKIP}" ]; then
239                 cd ${CHROOTDIR}/usr/src
240                 env ${CHROOT_MAKEENV} make ${CHROOT_WMAKEFLAGS} buildworld
241                 env ${CHROOT_MAKEENV} make ${CHROOT_IMAKEFLAGS} installworld \
242                         DESTDIR=${CHROOTDIR}
243                 env ${CHROOT_MAKEENV} make ${CHROOT_DMAKEFLAGS} distribution \
244                         DESTDIR=${CHROOTDIR}
245         fi
246
247         return 0
248 } # chroot_setup()
249
250 # extra_chroot_setup(): Prepare anything additional within the build
251 # necessary for the release build.
252 extra_chroot_setup() {
253         mkdir -p ${CHROOTDIR}/dev
254         mount -t devfs devfs ${CHROOTDIR}/dev
255         [ -e /etc/resolv.conf -a ! -e ${CHROOTDIR}/etc/resolv.conf ] && \
256                 cp /etc/resolv.conf ${CHROOTDIR}/etc/resolv.conf
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         eval chroot ${CHROOTDIR} /etc/rc.d/ldconfig forcerestart
260
261         # If MAKE_CONF and/or SRC_CONF are set and not character devices
262         # (/dev/null), copy them to the chroot.
263         if [ -e ${MAKE_CONF} ] && [ ! -c ${MAKE_CONF} ]; then
264                 mkdir -p ${CHROOTDIR}/$(dirname ${MAKE_CONF})
265                 cp ${MAKE_CONF} ${CHROOTDIR}/${MAKE_CONF}
266         fi
267         if [ -e ${SRC_CONF} ] && [ ! -c ${SRC_CONF} ]; then
268                 mkdir -p ${CHROOTDIR}/$(dirname ${SRC_CONF})
269                 cp ${SRC_CONF} ${CHROOTDIR}/${SRC_CONF}
270         fi
271
272         if [ -z "${NOGIT}" ]; then
273                 # Install git from ports or packages if the ports tree is
274                 # available and VCSCMD is unset.
275                 _gitcmd="$(which git)"
276                 if [ -d ${CHROOTDIR}/usr/ports -a -z "${_gitcmd}" ]; then
277                         # Trick the ports 'run-autotools-fixup' target to do the right
278                         # thing.
279                         _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
280                         REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
281                         BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
282                         UNAME_r=${REVISION}-${BRANCH}
283                         GITUNSETOPTS="CONTRIB CURL CVS GITWEB GUI HTMLDOCS"
284                         GITUNSETOPTS="${GITUNSETOPTS} ICONV NLS P4 PERL"
285                         GITUNSETOPTS="${GITUNSETOPTS} SEND_EMAIL SUBTREE SVN"
286                         GITUNSETOPTS="${GITUNSETOPTS} PCRE PCRE2"
287                         PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
288                         PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
289                         PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
290                         PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
291                         PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
292                         eval chroot ${CHROOTDIR} env OPTIONS_UNSET=\"${GITUNSETOPTS}\" \
293                                 ${PBUILD_FLAGS} \
294                                 make -C /usr/ports/devel/git FORCE_PKG_REGISTER=1 \
295                                 WRKDIRPREFIX=/tmp/ports \
296                                 DISTDIR=/tmp/distfiles \
297                                 install clean distclean
298                 else
299                         eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
300                                 pkg install -y devel/git
301                         eval chroot ${CHROOTDIR} env ASSUME_ALWAYS_YES=yes \
302                                 pkg clean -y
303                 fi
304         fi
305
306         if [ ! -z "${EMBEDDEDPORTS}" ]; then
307                 _OSVERSION=$(chroot ${CHROOTDIR} /usr/bin/uname -U)
308                 REVISION=$(chroot ${CHROOTDIR} make -C /usr/src/release -V REVISION)
309                 BRANCH=$(chroot ${CHROOTDIR} make -C /usr/src/release -V BRANCH)
310                 UNAME_r=${REVISION}-${BRANCH}
311                 PBUILD_FLAGS="OSVERSION=${_OSVERSION} BATCH=yes"
312                 PBUILD_FLAGS="${PBUILD_FLAGS} UNAME_r=${UNAME_r}"
313                 PBUILD_FLAGS="${PBUILD_FLAGS} OSREL=${REVISION}"
314                 PBUILD_FLAGS="${PBUILD_FLAGS} WRKDIRPREFIX=/tmp/ports"
315                 PBUILD_FLAGS="${PBUILD_FLAGS} DISTDIR=/tmp/distfiles"
316                 for _PORT in ${EMBEDDEDPORTS}; do
317                         eval chroot ${CHROOTDIR} env ${PBUILD_FLAGS} make -C \
318                                 /usr/ports/${_PORT} \
319                                 FORCE_PKG_REGISTER=1 deinstall install clean distclean
320                 done
321         fi
322
323         buildenv_setup
324
325         return 0
326 } # extra_chroot_setup()
327
328 # chroot_build_target(): Build the userland and kernel for the build target.
329 chroot_build_target() {
330         load_target_env
331         if [ ! -z "${EMBEDDEDBUILD}" ]; then
332                 RELEASE_WMAKEFLAGS="${RELEASE_WMAKEFLAGS} \
333                         TARGET=${EMBEDDED_TARGET} \
334                         TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
335                 RELEASE_KMAKEFLAGS="${RELEASE_KMAKEFLAGS} \
336                         TARGET=${EMBEDDED_TARGET} \
337                         TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
338         fi
339         eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_WMAKEFLAGS} buildworld
340         eval chroot ${CHROOTDIR} make -C /usr/src ${RELEASE_KMAKEFLAGS} buildkernel
341
342         return 0
343 } # chroot_build_target
344
345 # chroot_build_release(): Invoke the 'make release' target.
346 chroot_build_release() {
347         load_target_env
348         if [ ! -z "${WITH_VMIMAGES}" ]; then
349                 if [ -z "${VMFORMATS}" ]; then
350                         VMFORMATS="$(eval chroot ${CHROOTDIR} \
351                                 make -C /usr/src/release -V VMFORMATS)"
352                 fi
353                 if [ -z "${VMSIZE}" ]; then
354                         VMSIZE="$(eval chroot ${CHROOTDIR} \
355                                 make -C /usr/src/release -V VMSIZE)"
356                 fi
357                 RELEASE_RMAKEFLAGS="${RELEASE_RMAKEFLAGS} \
358                         VMFORMATS=\"${VMFORMATS}\" VMSIZE=${VMSIZE}"
359         fi
360         eval chroot ${CHROOTDIR} make -C /usr/src/release \
361                 ${RELEASE_RMAKEFLAGS} release
362         eval chroot ${CHROOTDIR} make -C /usr/src/release \
363                 ${RELEASE_RMAKEFLAGS} install DESTDIR=/R \
364                 WITH_COMPRESSED_IMAGES=${WITH_COMPRESSED_IMAGES} \
365                 WITH_COMPRESSED_VMIMAGES=${WITH_COMPRESSED_VMIMAGES}
366
367         return 0
368 } # chroot_build_release()
369
370 efi_boot_name()
371 {
372         case $1 in
373                 arm)
374                         echo "bootarm.efi"
375                         ;;
376                 arm64)
377                         echo "bootaa64.efi"
378                         ;;
379                 amd64)
380                         echo "bootx64.efi"
381                         ;;
382                 riscv)
383                         echo "bootriscv64.efi"
384                         ;;
385         esac
386 }
387
388 # chroot_arm_build_release(): Create arm SD card image.
389 chroot_arm_build_release() {
390         load_target_env
391         case ${EMBEDDED_TARGET} in
392                 arm|arm64|riscv)
393                         if [ -e "${RELENGDIR}/tools/arm.subr" ]; then
394                                 . "${RELENGDIR}/tools/arm.subr"
395                         fi
396                         ;;
397                 *)
398                         ;;
399         esac
400         [ ! -z "${RELEASECONF}" ] && . "${RELEASECONF}"
401         export MAKE_FLAGS="${MAKE_FLAGS} TARGET=${EMBEDDED_TARGET}"
402         export MAKE_FLAGS="${MAKE_FLAGS} TARGET_ARCH=${EMBEDDED_TARGET_ARCH}"
403         export MAKE_FLAGS="${MAKE_FLAGS} ${CONF_FILES}"
404         eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release obj
405         export WORLDDIR="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release -V WORLDDIR)"
406         export OBJDIR="$(eval chroot ${CHROOTDIR} env WITH_UNIFIED_OBJDIR=1 make ${MAKE_FLAGS} -C /usr/src/release -V .OBJDIR)"
407         export DESTDIR="${OBJDIR}/${KERNEL}"
408         export IMGBASE="${CHROOTDIR}/${OBJDIR}/${BOARDNAME}.img"
409         export OSRELEASE="$(eval chroot ${CHROOTDIR} make ${MAKE_FLAGS} -C /usr/src/release \
410                 TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
411                 -V OSRELEASE)"
412         chroot ${CHROOTDIR} mkdir -p ${DESTDIR}
413         chroot ${CHROOTDIR} truncate -s ${IMAGE_SIZE} ${IMGBASE##${CHROOTDIR}}
414         export mddev=$(chroot ${CHROOTDIR} \
415                 mdconfig -f ${IMGBASE##${CHROOTDIR}} ${MD_ARGS})
416         arm_create_disk
417         arm_install_base
418         arm_install_boot
419         arm_install_uboot
420         mdconfig -d -u ${mddev}
421         chroot ${CHROOTDIR} rmdir ${DESTDIR}
422         mv ${IMGBASE} ${CHROOTDIR}/${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img
423         chroot ${CHROOTDIR} mkdir -p /R
424         chroot ${CHROOTDIR} cp -p ${OBJDIR}/${OSRELEASE}-${BOARDNAME}.img \
425                 /R/${OSRELEASE}-${BOARDNAME}.img
426         chroot ${CHROOTDIR} xz -T ${XZ_THREADS} /R/${OSRELEASE}-${BOARDNAME}.img
427         cd ${CHROOTDIR}/R && sha512 ${OSRELEASE}* \
428                 > CHECKSUM.SHA512
429         cd ${CHROOTDIR}/R && sha256 ${OSRELEASE}* \
430                 > CHECKSUM.SHA256
431
432         return 0
433 } # chroot_arm_build_release()
434
435 # main(): Start here.
436 main() {
437         set -e # Everything must succeed
438         env_setup
439         while getopts c: opt; do
440                 case ${opt} in
441                         c)
442                                 RELEASECONF="$(realpath ${OPTARG})"
443                                 ;;
444                         \?)
445                                 usage
446                                 ;;
447                 esac
448         done
449         shift $(($OPTIND - 1))
450         if [ ! -z "${RELEASECONF}" ]; then
451                 if [ -e "${RELEASECONF}" ]; then
452                         . ${RELEASECONF}
453                 else
454                         echo "Nonexistent configuration file: ${RELEASECONF}"
455                         echo "Using default build environment."
456                 fi
457         fi
458         env_check
459         trap "umount ${CHROOTDIR}/dev" EXIT # Clean up devfs mount on exit
460         chroot_setup
461         extra_chroot_setup
462         chroot_build_target
463         ${chroot_build_release_cmd}
464
465         return 0
466 } # main()
467
468 main "${@}"