xref: /freebsd/sys/conf/newvers.sh (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1#!/bin/sh -
2#
3# SPDX-License-Identifier: BSD-3-Clause
4#
5# Copyright (c) 1984, 1986, 1990, 1993
6#	The Regents of the University of California.  All rights reserved.
7#
8# Redistribution and use in source and binary forms, with or without
9# modification, are permitted provided that the following conditions
10# are met:
11# 1. Redistributions of source code must retain the above copyright
12#    notice, this list of conditions and the following disclaimer.
13# 2. Redistributions in binary form must reproduce the above copyright
14#    notice, this list of conditions and the following disclaimer in the
15#    documentation and/or other materials provided with the distribution.
16# 3. Neither the name of the University nor the names of its contributors
17#    may be used to endorse or promote products derived from this software
18#    without specific prior written permission.
19#
20# THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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# Command line options:
33#
34#	-c	Print the copyright / license statement as a C comment and exit
35#
36#	-r	Reproducible build.  Do not embed directory names, user	names,
37#		time stamps or other dynamic information into the output file.
38#		This is intended to allow two builds done at different times
39#		and even by different people on different hosts to produce
40#		identical output.
41#
42#	-R	Reproducible build if the tree represents an unmodified
43#		checkout from a version control system.  Metadata is included
44#		if the tree is modified.
45#
46#	-V var	Print ${var}="${val-of-var}" and exit
47#
48#	-v	Print TYPE REVISION BRANCH RELEASE VERSION RELDATE variables
49#		like the -V command
50#
51
52TYPE="FreeBSD"
53REVISION="15.0"
54BRANCH="CURRENT"
55if [ -n "${BRANCH_OVERRIDE}" ]; then
56	BRANCH=${BRANCH_OVERRIDE}
57fi
58unset RELEASE
59unset VERSION
60
61if [ -z "${SYSDIR}" ]; then
62	SYSDIR=$(dirname $0)/..
63fi
64
65# allow random overrides
66while :
67do
68	case "$1" in
69	*=*) eval "$1"; shift;;
70	*) break;;
71	esac
72done
73
74RELEASE="${RELEASE:-${REVISION}-${BRANCH}}"
75VERSION="${VERSION:-${TYPE} ${RELEASE}}"
76
77RELDATE=$(awk '/^#define[[:space:]]*__FreeBSD_version/ {print $3}' ${PARAMFILE:-${SYSDIR}/sys/param.h})
78
79if [ -r "${SYSDIR}/../COPYRIGHT" ]; then
80	year=$(sed -Ee '/^Copyright .* The FreeBSD Project/!d;s/^.*1992-([0-9]*) .*$/\1/g' ${SYSDIR}/../COPYRIGHT)
81else
82	year=$(date +%Y)
83fi
84# look for copyright template
85b=share/examples/etc/bsd-style-copyright
86for bsd_copyright in $b ../$b ../../$b ../../../$b /usr/src/$b /usr/$b
87do
88	if [ -r "$bsd_copyright" ]; then
89		COPYRIGHT=$(sed \
90		    -e "s/\[year\]/1992-$year/" \
91		    -e 's/\[your name here\]\.* /The FreeBSD Project./' \
92		    -e 's/\[your name\]\.*/The FreeBSD Project./' \
93		    -e '/\[id for your version control system, if any\]/d' \
94		    $bsd_copyright)
95		break
96	fi
97done
98
99# no copyright found, use a dummy
100if [ -z "$COPYRIGHT" ]; then
101	COPYRIGHT="/*-
102 * Copyright (c) 1992-$year The FreeBSD Project.
103 *
104 */"
105fi
106
107# add newline
108COPYRIGHT="$COPYRIGHT
109"
110
111# We expand include_metadata later since we may set it to the
112# future value of modified.
113include_metadata=yes
114modified=no
115while getopts crRvV: opt; do
116	case "$opt" in
117	c)
118		echo "$COPYRIGHT"
119		exit 0
120		;;
121	r)
122		include_metadata=no
123		;;
124	R)
125		include_metadata=if-modified
126		;;
127	v)
128		# Only put variables that are single lines here.
129		for v in TYPE REVISION BRANCH RELEASE VERSION RELDATE; do
130			eval val=\$${v}
131			echo ${v}=\"${val}\"
132		done
133		exit 0
134		;;
135	V)
136		v=$OPTARG
137		eval val=\$${v}
138		echo ${v}=\"${val}\"
139		VARS_ONLY_EXIT=1
140		;;
141	esac
142done
143shift $((OPTIND - 1))
144
145# VARS_ONLY means no files should be generated, this is just being
146# included.
147[ -n "$VARS_ONLY" ] && return 0
148
149# VARS_ONLY_EXIT means no files should be generated, only the value of
150# variables are being output.
151[ -n "$VARS_ONLY_EXIT" ] && exit 0
152
153#
154# findvcs dir
155#	Looks up directory dir at world root and up the filesystem
156#
157findvcs()
158{
159	local savedir
160
161	savedir=$(pwd)
162	cd ${SYSDIR}/..
163	while [ $(pwd) != "/" ]; do
164		if [ -e "./$1" ]; then
165			VCSTOP=$(pwd)
166			VCSDIR=${VCSTOP}"/$1"
167			cd ${savedir}
168			return 0
169		fi
170		cd ..
171	done
172	cd ${savedir}
173	return 1
174}
175
176git_tree_modified()
177{
178	! $git_cmd "--work-tree=${VCSTOP}" -c core.checkStat=minimal -c core.fileMode=off diff --quiet
179}
180
181LC_ALL=C; export LC_ALL
182if [ ! -r version ]
183then
184	echo 0 > version
185fi
186
187touch version
188v=$(cat version)
189u=${USER:-root}
190d=$(pwd)
191h=${HOSTNAME:-$(hostname)}
192if [ -n "$SOURCE_DATE_EPOCH" ]; then
193	if ! t=$(date -r $SOURCE_DATE_EPOCH 2>/dev/null); then
194		echo "Invalid SOURCE_DATE_EPOCH" >&2
195		exit 1
196	fi
197else
198	t=$(date)
199fi
200i=$(${MAKE:-make} -V KERN_IDENT)
201compiler_v=$($(${MAKE:-make} -V CC) -v 2>&1 | grep -w 'version')
202
203for dir in /usr/bin /usr/local/bin; do
204	if [ ! -z "${svnversion}" ] ; then
205		break
206	fi
207	if [ -x "${dir}/svnversion" ] && [ -z ${svnversion} ] ; then
208		# Run svnversion from ${dir} on this script; if return code
209		# is not zero, the checkout might not be compatible with the
210		# svnversion being used.
211		${dir}/svnversion $(realpath ${0}) >/dev/null 2>&1
212		if [ $? -eq 0 ]; then
213			svnversion=${dir}/svnversion
214			break
215		fi
216	fi
217done
218
219if findvcs .git; then
220	for dir in /usr/bin /usr/local/bin; do
221		if [ -x "${dir}/git" ] ; then
222			git_cmd="${dir}/git -c help.autocorrect=0 --git-dir=${VCSDIR}"
223			break
224		fi
225	done
226fi
227
228if findvcs .gituprevision; then
229	gituprevision="${VCSTOP}/.gituprevision"
230fi
231
232if findvcs .hg; then
233	for dir in /usr/bin /usr/local/bin; do
234		if [ -x "${dir}/hg" ] ; then
235			hg_cmd="${dir}/hg -R ${VCSDIR}"
236			break
237		fi
238	done
239fi
240
241if [ -n "$svnversion" ] ; then
242	svn=$(cd ${SYSDIR} && $svnversion 2>/dev/null)
243	case "$svn" in
244	[0-9]*[MSP]|*:*)
245		svn=" r${svn}"
246		modified=yes
247		;;
248	[0-9]*)
249		svn=" r${svn}"
250		;;
251	*)
252		unset svn
253		;;
254	esac
255fi
256
257if [ -n "$git_cmd" ] ; then
258	git=$($git_cmd rev-parse --verify --short HEAD 2>/dev/null)
259	if [ "$($git_cmd rev-parse --is-shallow-repository)" = false ] ; then
260		git_cnt=$($git_cmd rev-list --first-parent --count HEAD 2>/dev/null)
261		if [ -n "$git_cnt" ] ; then
262			git="n${git_cnt}-${git}"
263		fi
264	fi
265	git_b=$($git_cmd rev-parse --abbrev-ref HEAD)
266	if [ -n "$git_b" -a "$git_b" != "HEAD" ] ; then
267		git="${git_b}-${git}"
268	fi
269	if git_tree_modified; then
270		git="${git}-dirty"
271		modified=yes
272	fi
273	git=" ${git}"
274fi
275
276if [ -n "$gituprevision" ] ; then
277	gitup=" $(awk -F: '{print $2}' $gituprevision)"
278fi
279
280if [ -n "$hg_cmd" ] ; then
281	hg=$($hg_cmd id 2>/dev/null)
282	hgsvn=$($hg_cmd svn info 2>/dev/null | \
283		awk -F': ' '/Revision/ { print $2 }')
284	if [ -n "$hgsvn" ] ; then
285		svn=" r${hgsvn}"
286	fi
287	if [ -n "$hg" ] ; then
288		hg=" ${hg}"
289	fi
290fi
291
292[ ${include_metadata} = "if-modified" -a ${modified} = "yes" ] && include_metadata=yes
293if [ ${include_metadata} != "yes" ]; then
294	VERINFO="${VERSION}${svn}${git}${gitup}${hg} ${i}"
295	VERSTR="${VERINFO}\\n"
296else
297	VERINFO="${VERSION} #${v}${svn}${git}${gitup}${hg}: ${t}"
298	VERSTR="${VERINFO}\\n    ${u}@${h}:${d}\\n"
299fi
300
301vers_content_new=$(cat << EOF
302$COPYRIGHT
303/*
304 * The SCCS stuff is a marker that by convention identifies the kernel.  While
305 * the convention originated with SCCS, the current use is more generic and is
306 * used by different organizations to identify the kernel, the crash dump,
307 * etc. The what(1) utility prints these markers. Better methods exist, so this
308 * method is deprecated and will be removed in a future version of FreeBSD. Orgs
309 * that use it are encouraged to migrate before then.
310 */
311#define SCCSSTR "@(#)${VERINFO}"
312#define VERSTR "${VERSTR}"
313#define RELSTR "${RELEASE}"
314
315char sccs[sizeof(SCCSSTR) > 128 ? sizeof(SCCSSTR) : 128] = SCCSSTR;
316char version[sizeof(VERSTR) > 256 ? sizeof(VERSTR) : 256] = VERSTR;
317char compiler_version[] = "${compiler_v}";
318char ostype[] = "${TYPE}";
319char osrelease[sizeof(RELSTR) > 32 ? sizeof(RELSTR) : 32] = RELSTR;
320int osreldate = ${RELDATE};
321char kern_ident[] = "${i}";
322EOF
323)
324vers_content_old=$(cat vers.c 2>/dev/null || true)
325if [ "$vers_content_new" != "$vers_content_old" ]; then
326	printf "%s\n" "$vers_content_new" > vers.c
327fi
328
329echo $((v + 1)) > version
330