git/t/t3302-notes-index-expensive.sh
Ævar Arnfjörð Bjarmason a52f07afcb revisions API: have release_revisions() release "mailmap"
Extend the the release_revisions() function so that it frees the
"mailmap" in the "struct rev_info".

The log family of functions now calls the clear_mailmap() function
added in fa8afd18e5a (revisions API: provide and use a
release_revisions(), 2021-09-19), allowing us to whitelist some tests
with "TEST_PASSES_SANITIZE_LEAK=true".

Unfortunately having a pointer to a mailmap in "struct rev_info"
instead of an embedded member that we "own" get a bit messy, as can be
seen in the change to builtin/commit.c.

When we free() this data we won't be able to tell apart a pointer to a
"mailmap" on the heap from one on the stack. As seen in
ea57bc0d41 (log: add --use-mailmap option, 2013-01-05) the "log"
family allocates it on the heap, but in the find_author_by_nickname()
code added in ea16794e43 (commit: search author pattern against
mailmap, 2013-08-23) we allocated it on the stack instead.

Ideally we'd simply change that member to a "struct string_list
mailmap" and never free() the "mailmap" itself, but that would be a
much larger change to the revisions API.

We have code that needs to hand an existing "mailmap" to a "struct
rev_info", while we could change all of that, let's not go there
now.

The complexity isn't in the ownership of the "mailmap" per-se, but
that various things assume a "rev_info.mailmap == NULL" means "doesn't
want mailmap", if we changed that to an init'd "struct string_list
we'd need to carefully refactor things to change those assumptions.

Let's instead always free() it, and simply declare that if you add
such a "mailmap" it must be allocated on the heap. Any modern libc
will correctly panic if we free() a stack variable, so this should be
safe going forward.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-04-13 23:56:09 -07:00

140 lines
2.2 KiB
Bash
Executable File

#!/bin/sh
#
# Copyright (c) 2007 Johannes E. Schindelin
#
test_description='Test commit notes index (expensive!)'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh
create_repo () {
number_of_commits=$1
nr=0
test -d .git || {
git init &&
(
while test $nr -lt $number_of_commits
do
nr=$(($nr+1))
mark=$(($nr+$nr))
notemark=$(($mark+1))
test_tick &&
cat <<-INPUT_END &&
commit refs/heads/main
mark :$mark
committer $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL> $GIT_COMMITTER_DATE
data <<COMMIT
commit #$nr
COMMIT
M 644 inline file
data <<EOF
file in commit #$nr
EOF
blob
mark :$notemark
data <<EOF
note for commit #$nr
EOF
INPUT_END
echo "N :$notemark :$mark" >>note_commit
done &&
test_tick &&
cat <<-INPUT_END &&
commit refs/notes/commits
committer $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL> $GIT_COMMITTER_DATE
data <<COMMIT
notes
COMMIT
INPUT_END
cat note_commit
) |
git fast-import --quiet &&
git config core.notesRef refs/notes/commits
}
}
test_notes () {
count=$1 &&
git config core.notesRef refs/notes/commits &&
git log >tmp &&
grep "^ " tmp >output &&
i=$count &&
while test $i -gt 0
do
echo " commit #$i" &&
echo " note for commit #$i" &&
i=$(($i-1))
done >expect &&
test_cmp expect output
}
write_script time_notes <<\EOF
mode=$1
i=1
while test $i -lt $2
do
case $1 in
no-notes)
GIT_NOTES_REF=non-existing
export GIT_NOTES_REF
;;
notes)
unset GIT_NOTES_REF
;;
esac
git log || exit $?
i=$(($i+1))
done >/dev/null
EOF
time_notes () {
for mode in no-notes notes
do
echo $mode
/usr/bin/time ../time_notes $mode $1
done
}
do_tests () {
count=$1 pr=${2-}
test_expect_success $pr "setup $count" '
mkdir "$count" &&
(
cd "$count" &&
create_repo "$count"
)
'
test_expect_success $pr 'notes work' '
(
cd "$count" &&
test_notes "$count"
)
'
test_expect_success "USR_BIN_TIME${pr:+,$pr}" 'notes timing with /usr/bin/time' '
(
cd "$count" &&
time_notes 100
)
'
}
do_tests 10
for count in 100 1000 10000
do
do_tests "$count" EXPENSIVE
done
test_done