linux-kernel - Re: [PATCH v2] setlocalversion: work around "git describe" performance

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAK7LNAQdxx6yHGc9-+=aQxeOkBs-qGxf_1namqWp-gUwQ-uo-w@mail.gmail.com>
Date: Sat, 16 Nov 2024 08:17:36 +0900
From: Masahiro Yamada <masahiroy@...nel.org>
To: Rasmus Villemoes <linux@...musvillemoes.dk>
Cc: Josh Poimboeuf <jpoimboe@...nel.org>, linux-kernel@...r.kernel.org, 
	Jeff King <peff@...f.net>
Subject: Re: [PATCH v2] setlocalversion: work around "git describe" performance

This patch was not sent to linux-kbuild ML
(and it can be one reason when a patch falls into a crack),
but I guess I am expected to review and pick it.



On Wed, Nov 13, 2024 at 6:04 AM Rasmus Villemoes
<linux@...musvillemoes.dk> wrote:
>
> 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 c1e939a21eb1
> 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: Josh Poimboeuf <jpoimboe@...nel.org>


Maybe, the comprehensive tag list looks like this?

Reported-by: Sean Christopherson <seanjc@...gle.com>
Closes: https://lore.kernel.org/lkml/ZPtlxmdIJXOe0sEy@google.com/
Reported-by: Josh Poimboeuf <jpoimboe@...nel.org>
Closes: https://lore.kernel.org/lkml/309549cafdcfe50c4fceac3263220cc3d8b109b2.1730337435.git.jpoimboe@kernel.org/




> Signed-off-by: Rasmus Villemoes <linux@...musvillemoes.dk>
> ---
>
> v2: Drop odd here-doc, use "set -- $()" instead. Update commit log to
> mention the git.git patches in flight.
>
>  scripts/setlocalversion | 53 ++++++++++++++++++++++++++++-------------
>  1 file changed, 37 insertions(+), 16 deletions(-)
>
> diff --git a/scripts/setlocalversion b/scripts/setlocalversion
> index 38b96c6797f4..1e3b01ec096c 100755
> --- a/scripts/setlocalversion
> +++ b/scripts/setlocalversion
> @@ -30,6 +30,26 @@ 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

The double-quotes for tag are unneeded.

"tag"  --> tag

This function returns either 1 or 0, but how is it used?




> +       [ "$1" = 0 ] || return 1
> +
> +       # $2 is the number of commits in the range $tag..HEAD, possibly 0.
> +       count="$2"
> +
> +       return 0


Same here. The return value seems unnecessary.



--
Best Regards

Masahiro Yamada