linux-yocto/scripts/setlocalversion
Rasmus Villemoes c45cec53ee setlocalversion: work around "git describe" performance
[ Upstream commit 523f3dbc187a9618d4fd80c2b438e4d490705dcd ]

Contrary to expectations, passing a single candidate tag to "git
describe" is slower than not passing any --match options.

  $ time git describe --debug
  ...
  traversed 10619 commits
  ...
  v6.12-rc5-63-g0fc810ae3ae1

  real    0m0.169s

  $ time git describe --match=v6.12-rc5 --debug
  ...
  traversed 1310024 commits
  v6.12-rc5-63-g0fc810ae3ae1

  real    0m1.281s

In fact, the --debug output shows that git traverses all or most of
history. For some repositories and/or git versions, those 1.3s are
actually 10-15 seconds.

This has been acknowledged as a performance bug in git [1], and a fix
is on its way [2]. However, no solution is yet in git.git, and even
when one lands, it will take quite a while before it finds its way to
a release and for $random_kernel_developer to pick that up.

So rewrite the logic to use plumbing commands. For each of the
candidate values of $tag, we ask: (1) is $tag even an annotated
tag? (2) Is it eligible to describe HEAD, i.e. an ancestor of
HEAD? (3) If so, how many commits are in $tag..HEAD?

I have tested that this produces the same output as the current script
for ~700 random commits between v6.9..v6.10. For those 700 commits,
and in my git repo, the 'make -s kernelrelease' command is on average
~4 times faster with this patch applied (geometric mean of ratios).

For the commit mentioned in Josh's original report [3], the
time-consuming part of setlocalversion goes from

$ time git describe --match=v6.12-rc5 c1e939a21e
v6.12-rc5-44-gc1e939a21eb1

real    0m1.210s

to

$ time git rev-list --count --left-right v6.12-rc5..c1e939a21eb1
0       44

real    0m0.037s

[1] https://lore.kernel.org/git/20241101113910.GA2301440@coredump.intra.peff.net/
[2] https://lore.kernel.org/git/20241106192236.GC880133@coredump.intra.peff.net/
[3] https://lore.kernel.org/lkml/309549cafdcfe50c4fceac3263220cc3d8b109b2.1730337435.git.jpoimboe@kernel.org/

Reported-by: Sean Christopherson <seanjc@google.com>
Closes: https://lore.kernel.org/lkml/ZPtlxmdIJXOe0sEy@google.com/
Reported-by: Josh Poimboeuf <jpoimboe@kernel.org>
Closes: https://lore.kernel.org/lkml/309549cafdcfe50c4fceac3263220cc3d8b109b2.1730337435.git.jpoimboe@kernel.org/
Tested-by: Josh Poimboeuf <jpoimboe@kernel.org>
Signed-off-by: Rasmus Villemoes <linux@rasmusvillemoes.dk>
Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Signed-off-by: Sasha Levin <sashal@kernel.org>
2024-12-14 20:00:17 +01:00

5.2 KiB
Executable File

#!/bin/sh

SPDX-License-Identifier: GPL-2.0

This scripts adds local version information from the version

control system git.

If something goes wrong, send a mail the kernel build mailinglist

(see MAINTAINERS) and CC Nico Schottelius

<nico-linuxsetlocalversion -at- schottelius.org>.

usage() { echo "Usage: $0 [--no-local] [srctree]" >&2 exit 1 }

no_local=false if test "$1" = "--no-local"; then no_local=true shift fi

srctree=. if test $# -gt 0; then srctree=$1 shift fi if test $# -gt 0 -o ! -d "$srctree"; then usage fi

try_tag() { tag="$1"

# Is $tag an annotated tag?
[ "$(git cat-file -t "$tag" 2> /dev/null)" = tag ] || return 1

# Is it an ancestor of HEAD, and if so, how many commits are in $tag..HEAD?
# shellcheck disable=SC2046 # word splitting is the point here
set -- $(git rev-list --count --left-right "$tag"...HEAD 2> /dev/null)

# $1 is 0 if and only if $tag is an ancestor of HEAD. Use
# string comparison, because $1 is empty if the 'git rev-list'
# command somehow failed.
[ "$1" = 0 ] || return 1

# $2 is the number of commits in the range $tag..HEAD, possibly 0.
count="$2"

return 0

}

scm_version() { local short=false local no_dirty=false local tag

while [ $# -gt 0 ];
do
	case "$1" in
	--short)
		short=true;;
	--no-dirty)
		no_dirty=true;;
	esac
	shift
done

cd "$srctree"

if test -n "$(git rev-parse --show-cdup 2>/dev/null)"; then
	return
fi

if ! head=$(git rev-parse --verify HEAD 2>/dev/null); then
	return
fi

# mainline kernel:  6.2.0-rc5  ->  v6.2-rc5
# stable kernel:    6.1.7      ->  v6.1.7
version_tag=v$(echo "${KERNELVERSION}" | sed -E 's/^([0-9]+\.[0-9]+)\.0(.*)$/\1\2/')

# try_tag initializes count if the tag is usable.
count=

# If a localversion* file exists, and the corresponding
# annotated tag exists and is an ancestor of HEAD, use
# it. This is the case in linux-next.
if [ -n "${file_localversion#-}" ] ; then
	try_tag "${file_localversion#-}"
fi

# Otherwise, if a localversion* file exists, and the tag
# obtained by appending it to the tag derived from
# KERNELVERSION exists and is an ancestor of HEAD, use
# it. This is e.g. the case in linux-rt.
if [ -z "${count}" ] && [ -n "${file_localversion}" ]; then
	try_tag "${version_tag}${file_localversion}"
fi

# Otherwise, default to the annotated tag derived from KERNELVERSION.
if [ -z "${count}" ]; then
	try_tag "${version_tag}"
fi

# If we are at the tagged commit, we ignore it because the
# version is well-defined. If none of the attempted tags exist
# or were usable, $count is still empty.
if [ -z "${count}" ] || [ "${count}" -gt 0 ]; then

	# If only the short version is requested, don't bother
	# running further git commands
	if $short; then
		echo "+"
		return
	fi

	# If we are past the tagged commit, we pretty print it.
	# (like 6.1.0-14595-g292a089d78d3)
	if [ -n "${count}" ]; then
		printf "%s%05d" "-" "${count}"
	fi

	# Add -g and exactly 12 hex chars.
	printf '%s%.12s' -g "$head"
fi

if ${no_dirty}; then
	return
fi

# Check for uncommitted changes.
# This script must avoid any write attempt to the source tree, which
# might be read-only.
# You cannot use 'git describe --dirty' because it tries to create
# .git/index.lock .
# First, with git-status, but --no-optional-locks is only supported in
# git >= 2.14, so fall back to git-diff-index if it fails. Note that
# git-diff-index does not refresh the index, so it may give misleading
# results.
# See git-update-index(1), git-diff-index(1), and git-status(1).
if {
	git --no-optional-locks status -uno --porcelain 2>/dev/null ||
	git diff-index --name-only HEAD
} | read dummy; then
	printf '%s' -dirty
fi

}

collect_files() { local file res=

for file; do
	case "$file" in
	*\~*)
		continue
		;;
	esac
	if test -e "$file"; then
		res="$res$(cat "$file")"
	fi
done
echo "$res"

}

if [ -z "${KERNELVERSION}" ]; then echo "KERNELVERSION is not set" >&2 exit 1 fi

localversion* files in the build and source directory

file_localversion="$(collect_files localversion*)" if test ! "$srctree" -ef .; then file_localversion="${file_localversion}$(collect_files "$srctree"/localversion*)" fi

if ${no_local}; then echo "${KERNELVERSION}$(scm_version --no-dirty)" exit 0 fi

if ! test -e include/config/auto.conf; then echo "Error: kernelrelease not valid - run 'make prepare' to update it" >&2 exit 1 fi

version string from CONFIG_LOCALVERSION

config_localversion=$(sed -n 's/^CONFIG_LOCALVERSION=(.*)$/\1/p' include/config/auto.conf)

scm version string if not at the kernel version tag or at the file_localversion

if grep -q "^CONFIG_LOCALVERSION_AUTO=y$" include/config/auto.conf; then # full scm version string scm_version="$(scm_version)" elif [ "${LOCALVERSION+set}" != "set" ]; then # If the variable LOCALVERSION is not set, append a plus # sign if the repository is not in a clean annotated or # signed tagged state (as git describe only looks at signed # or annotated tags - git tag -a/-s). # # If the variable LOCALVERSION is set (including being set # to an empty string), we don't want to append a plus sign. scm_version="$(scm_version --short)" fi

echo "${KERNELVERSION}${file_localversion}${config_localversion}${LOCALVERSION}${scm_version}"