mirror of
https://github.com/git/git.git
synced 2024-12-01 05:54:16 +08:00
ed4a1d6ae1
When performing multi-pack reuse, reuse_partial_packfile_from_bitmap()
is responsible for generating an array of bitmapped_pack structs from
which to perform reuse.
In the multi-pack case, we loop over the MIDXs packs and copy the result
of calling `nth_bitmapped_pack()` to construct the list of reusable
paths.
But we may also want to do pack-reuse over a single pack, either because
we only had one pack to perform reuse over (in the case of single-pack
bitmaps), or because we explicitly asked to do single pack reuse even
with a MIDX[^1].
When this is the case, the array we generate of reusable packs contains
only a single element, which is either (a) the pack attached to the
single-pack bitmap, or (b) the MIDX's preferred pack.
In 795006fff4
(pack-bitmap: gracefully handle missing BTMP chunks,
2024-04-15), we refactored the reuse_partial_packfile_from_bitmap()
function and stopped assigning the pack_int_id field when reusing only
the MIDX's preferred pack. This results in an uninitialized read down in
try_partial_reuse() like so:
==7474==WARNING: MemorySanitizer: use-of-uninitialized-value
#0 0x55c5cd191dde in try_partial_reuse pack-bitmap.c:1887:8
#1 0x55c5cd191dde in reuse_partial_packfile_from_bitmap_1 pack-bitmap.c:2001:8
#2 0x55c5cd191dde in reuse_partial_packfile_from_bitmap pack-bitmap.c:2105:3
#3 0x55c5cce0bd0e in get_object_list_from_bitmap builtin/pack-objects.c:4043:3
#4 0x55c5cce0bd0e in get_object_list builtin/pack-objects.c:4156:27
#5 0x55c5cce0bd0e in cmd_pack_objects builtin/pack-objects.c:4596:3
#6 0x55c5ccc8fac8 in run_builtin git.c:474:11
which happens when try_partial_reuse() tries to call
midx_pair_to_pack_pos() when it tries to reject cross-pack deltas.
Avoid the uninitialized read by ensuring that the pack_int_id field is
set in the single-pack reuse case by setting it to either the MIDX
preferred pack's pack_int_id, or '-1', in the case of single-pack
bitmaps. In the latter case, we never read the pack_int_id field, so
the choice of '-1' is intentional as a "garbage in, garbage out"
measure.
Guard against further regressions in this area by adding a test which
ensures that we do not throw out deltas from the preferred pack as
"cross-pack" due to an uninitialized pack_int_id.
[^1]: This can happen for a couple of reasons, either because the
repository is configured with 'pack.allowPackReuse=(true|single)', or
because the MIDX was generated prior to the introduction of the BTMP
chunk, which contains information necessary to perform multi-pack
reuse.
Reported-by: Kyle Lippincott <spectral@google.com>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
234 lines
5.6 KiB
Bash
Executable File
234 lines
5.6 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
test_description='pack-objects multi-pack reuse'
|
|
|
|
TEST_PASSES_SANITIZE_LEAK=true
|
|
. ./test-lib.sh
|
|
. "$TEST_DIRECTORY"/lib-bitmap.sh
|
|
|
|
objdir=.git/objects
|
|
packdir=$objdir/pack
|
|
|
|
test_pack_reused () {
|
|
test_trace2_data pack-objects pack-reused "$1"
|
|
}
|
|
|
|
test_packs_reused () {
|
|
test_trace2_data pack-objects packs-reused "$1"
|
|
}
|
|
|
|
|
|
# pack_position <object> </path/to/pack.idx
|
|
pack_position () {
|
|
git show-index >objects &&
|
|
grep "$1" objects | cut -d" " -f1
|
|
}
|
|
|
|
# test_pack_objects_reused_all <pack-reused> <packs-reused>
|
|
test_pack_objects_reused_all () {
|
|
: >trace2.txt &&
|
|
GIT_TRACE2_EVENT="$PWD/trace2.txt" \
|
|
git pack-objects --stdout --revs --all --delta-base-offset \
|
|
>/dev/null &&
|
|
|
|
test_pack_reused "$1" <trace2.txt &&
|
|
test_packs_reused "$2" <trace2.txt
|
|
}
|
|
|
|
# test_pack_objects_reused <pack-reused> <packs-reused>
|
|
test_pack_objects_reused () {
|
|
: >trace2.txt &&
|
|
GIT_TRACE2_EVENT="$PWD/trace2.txt" \
|
|
git pack-objects --stdout --revs >/dev/null &&
|
|
|
|
test_pack_reused "$1" <trace2.txt &&
|
|
test_packs_reused "$2" <trace2.txt
|
|
}
|
|
|
|
test_expect_success 'preferred pack is reused for single-pack reuse' '
|
|
test_config pack.allowPackReuse single &&
|
|
|
|
for i in A B
|
|
do
|
|
test_commit "$i" &&
|
|
git repack -d || return 1
|
|
done &&
|
|
|
|
git multi-pack-index write --bitmap &&
|
|
|
|
test_pack_objects_reused_all 3 1
|
|
'
|
|
|
|
test_expect_success 'multi-pack reuse is disabled by default' '
|
|
test_pack_objects_reused_all 3 1
|
|
'
|
|
|
|
test_expect_success 'feature.experimental implies multi-pack reuse' '
|
|
test_config feature.experimental true &&
|
|
|
|
test_pack_objects_reused_all 6 2
|
|
'
|
|
|
|
test_expect_success 'multi-pack reuse can be disabled with feature.experimental' '
|
|
test_config feature.experimental true &&
|
|
test_config pack.allowPackReuse single &&
|
|
|
|
test_pack_objects_reused_all 3 1
|
|
'
|
|
|
|
test_expect_success 'enable multi-pack reuse' '
|
|
git config pack.allowPackReuse multi
|
|
'
|
|
|
|
test_expect_success 'reuse all objects from subset of bitmapped packs' '
|
|
test_commit C &&
|
|
git repack -d &&
|
|
|
|
git multi-pack-index write --bitmap &&
|
|
|
|
cat >in <<-EOF &&
|
|
$(git rev-parse C)
|
|
^$(git rev-parse A)
|
|
EOF
|
|
|
|
test_pack_objects_reused 6 2 <in
|
|
'
|
|
|
|
test_expect_success 'reuse all objects from all packs' '
|
|
test_pack_objects_reused_all 9 3
|
|
'
|
|
|
|
test_expect_success 'reuse objects from first pack with middle gap' '
|
|
for i in D E F
|
|
do
|
|
test_commit "$i" || return 1
|
|
done &&
|
|
|
|
# Set "pack.window" to zero to ensure that we do not create any
|
|
# deltas, which could alter the amount of pack reuse we perform
|
|
# (if, for e.g., we are not sending one or more bases).
|
|
D="$(git -c pack.window=0 pack-objects --all --unpacked $packdir/pack)" &&
|
|
|
|
d_pos="$(pack_position $(git rev-parse D) <$packdir/pack-$D.idx)" &&
|
|
e_pos="$(pack_position $(git rev-parse E) <$packdir/pack-$D.idx)" &&
|
|
f_pos="$(pack_position $(git rev-parse F) <$packdir/pack-$D.idx)" &&
|
|
|
|
# commits F, E, and D, should appear in that order at the
|
|
# beginning of the pack
|
|
test $f_pos -lt $e_pos &&
|
|
test $e_pos -lt $d_pos &&
|
|
|
|
# Ensure that the pack we are constructing sorts ahead of any
|
|
# other packs in lexical/bitmap order by choosing it as the
|
|
# preferred pack.
|
|
git multi-pack-index write --bitmap --preferred-pack="pack-$D.idx" &&
|
|
|
|
cat >in <<-EOF &&
|
|
$(git rev-parse E)
|
|
^$(git rev-parse D)
|
|
EOF
|
|
|
|
test_pack_objects_reused 3 1 <in
|
|
'
|
|
|
|
test_expect_success 'reuse objects from middle pack with middle gap' '
|
|
rm -fr $packdir/multi-pack-index* &&
|
|
|
|
# Ensure that the pack we are constructing sort into any
|
|
# position *but* the first one, by choosing a different pack as
|
|
# the preferred one.
|
|
git multi-pack-index write --bitmap --preferred-pack="pack-$A.idx" &&
|
|
|
|
cat >in <<-EOF &&
|
|
$(git rev-parse E)
|
|
^$(git rev-parse D)
|
|
EOF
|
|
|
|
test_pack_objects_reused 3 1 <in
|
|
'
|
|
|
|
test_expect_success 'omit delta with uninteresting base (same pack)' '
|
|
git repack -adk &&
|
|
|
|
test_seq 32 >f &&
|
|
git add f &&
|
|
test_tick &&
|
|
git commit -m "delta" &&
|
|
delta="$(git rev-parse HEAD)" &&
|
|
|
|
test_seq 64 >f &&
|
|
test_tick &&
|
|
git commit -a -m "base" &&
|
|
base="$(git rev-parse HEAD)" &&
|
|
|
|
test_commit other &&
|
|
|
|
git repack -d &&
|
|
|
|
have_delta "$(git rev-parse $delta:f)" "$(git rev-parse $base:f)" &&
|
|
|
|
git multi-pack-index write --bitmap &&
|
|
|
|
cat >in <<-EOF &&
|
|
$(git rev-parse other)
|
|
^$base
|
|
EOF
|
|
|
|
# We can only reuse the 3 objects corresponding to "other" from
|
|
# the latest pack.
|
|
#
|
|
# This is because even though we want "delta", we do not want
|
|
# "base", meaning that we have to inflate the delta/base-pair
|
|
# corresponding to the blob in commit "delta", which bypasses
|
|
# the pack-reuse mechanism.
|
|
#
|
|
# The remaining objects from the other pack are similarly not
|
|
# reused because their objects are on the uninteresting side of
|
|
# the query.
|
|
test_pack_objects_reused 3 1 <in
|
|
'
|
|
|
|
test_expect_success 'omit delta from uninteresting base (cross pack)' '
|
|
cat >in <<-EOF &&
|
|
$(git rev-parse $base)
|
|
^$(git rev-parse $delta)
|
|
EOF
|
|
|
|
P="$(git pack-objects --revs $packdir/pack <in)" &&
|
|
|
|
git multi-pack-index write --bitmap --preferred-pack="pack-$P.idx" &&
|
|
|
|
packs_nr="$(find $packdir -type f -name "pack-*.pack" | wc -l)" &&
|
|
objects_nr="$(git rev-list --count --all --objects)" &&
|
|
|
|
test_pack_objects_reused_all $(($objects_nr - 1)) $packs_nr
|
|
'
|
|
|
|
test_expect_success 'non-omitted delta in MIDX preferred pack' '
|
|
test_config pack.allowPackReuse single &&
|
|
|
|
cat >p1.objects <<-EOF &&
|
|
$(git rev-parse $base)
|
|
^$(git rev-parse $delta^)
|
|
EOF
|
|
cat >p2.objects <<-EOF &&
|
|
$(git rev-parse F)
|
|
EOF
|
|
|
|
p1="$(git pack-objects --revs $packdir/pack <p1.objects)" &&
|
|
p2="$(git pack-objects --revs $packdir/pack <p2.objects)" &&
|
|
|
|
cat >in <<-EOF &&
|
|
pack-$p1.idx
|
|
pack-$p2.idx
|
|
EOF
|
|
git multi-pack-index write --bitmap --stdin-packs \
|
|
--preferred-pack=pack-$p1.pack <in &&
|
|
|
|
git show-index <$packdir/pack-$p1.idx >expect &&
|
|
|
|
test_pack_objects_reused_all $(wc -l <expect) 1
|
|
'
|
|
|
|
test_done
|