3 test_description
='exercise basic bitmap functionality'
4 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
=master
5 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
8 .
"$TEST_DIRECTORY"/lib-bundle.sh
9 .
"$TEST_DIRECTORY"/lib-bitmap.sh
12 echo ".git/objects/$(echo "$1" | sed -e 's|\(..\)|\1/|')"
15 # show objects present in pack ($1 should be associated *.idx)
16 list_packed_objects
() {
17 git show-index
<"$1" >object-list
&&
18 cut
-d' ' -f2 object-list
21 # has_any pattern-file content-file
22 # tests whether content-file has any entry from pattern-file with entries being
28 # To ensure the logic for "maximal commits" is exercised, make
29 # the repository a bit more complicated.
33 # (99 commits) (99 commits)
36 # | * octo-other octo-second * |
37 # |/|\_________ ____________/|\|
38 # | \ \/ __________/ |
40 # * |/ * merge-right *
41 # | _|__________/ \____________ |
43 # (l1) * * merge-left * (r1)
44 # | / \________________________ |
47 # \___________________________ |
51 # We only push bits down the first-parent history, which
52 # makes some of these commits unimportant!
54 # The important part for the maximal commit algorithm is how
55 # the bitmasks are extended. Assuming starting bit positions
56 # for second (bit 0) and other (bit 1), the bitmasks at the
59 # second: 1 (maximal, selected)
60 # other: 01 (maximal, selected)
61 # (base): 11 (maximal)
63 # This complicated history was important for a previous
64 # version of the walk that guarantees never walking a
65 # commit multiple times. That goal might be important
66 # again, so preserve this complicated case. For now, this
67 # test will guarantee that the bitmaps are computed
68 # correctly, even with the repeat calculations.
70 test_expect_success
'setup repo with moderate-sized history' '
71 test_commit_bulk --id=file 10 &&
72 git branch -M second &&
73 git checkout -b other HEAD~5 &&
74 test_commit_bulk --id=side 10 &&
76 # add complicated history setup, including merges and
77 # ambiguous merge-bases
79 git checkout -b merge-left other~2 &&
80 git merge second~2 -m "merge-left" &&
82 git checkout -b merge-right second~1 &&
83 git merge other~1 -m "merge-right" &&
85 git checkout -b octo-second second &&
86 git merge merge-left merge-right -m "octopus-second" &&
88 git checkout -b octo-other other &&
89 git merge merge-left merge-right -m "octopus-other" &&
92 git merge octo-other -m "pull octopus" &&
94 git checkout second &&
95 git merge octo-second -m "pull octopus" &&
97 # Remove these branches so they are not selected
99 git branch -D merge-left &&
100 git branch -D merge-right &&
101 git branch -D octo-other &&
102 git branch -D octo-second &&
104 # add padding to make these merges less interesting
105 # and avoid having them selected for bitmaps
106 test_commit_bulk --id=file 100 &&
107 git checkout other &&
108 test_commit_bulk --id=side 100 &&
109 git checkout second &&
111 bitmaptip=$(git rev-parse second) &&
112 blob=$(echo tagged-blob | git hash-object -w --stdin) &&
113 git tag tagged-blob $blob &&
114 git config repack.writebitmaps true
117 test_expect_success
'full repack creates bitmaps' '
118 GIT_TRACE2_EVENT_NESTING=4 GIT_TRACE2_EVENT="$(pwd)/trace" \
120 ls .git/objects/pack/ | grep bitmap >output &&
121 test_line_count = 1 output &&
122 grep "\"key\":\"num_selected_commits\",\"value\":\"106\"" trace &&
123 grep "\"key\":\"num_maximal_commits\",\"value\":\"107\"" trace
126 test_expect_success
'rev-list --test-bitmap verifies bitmaps' '
127 git rev-list --test-bitmap HEAD
130 rev_list_tests_head
() {
131 test_expect_success
"counting commits via bitmap ($state, $branch)" '
132 git rev-list --count $branch >expect &&
133 git rev-list --use-bitmap-index --count $branch >actual &&
134 test_cmp expect actual
137 test_expect_success
"counting partial commits via bitmap ($state, $branch)" '
138 git rev-list --count $branch~5..$branch >expect &&
139 git rev-list --use-bitmap-index --count $branch~5..$branch >actual &&
140 test_cmp expect actual
143 test_expect_success
"counting commits with limit ($state, $branch)" '
144 git rev-list --count -n 1 $branch >expect &&
145 git rev-list --use-bitmap-index --count -n 1 $branch >actual &&
146 test_cmp expect actual
149 test_expect_success
"counting non-linear history ($state, $branch)" '
150 git rev-list --count other...second >expect &&
151 git rev-list --use-bitmap-index --count other...second >actual &&
152 test_cmp expect actual
155 test_expect_success
"counting commits with limiting ($state, $branch)" '
156 git rev-list --count $branch -- 1.t >expect &&
157 git rev-list --use-bitmap-index --count $branch -- 1.t >actual &&
158 test_cmp expect actual
161 test_expect_success
"counting objects via bitmap ($state, $branch)" '
162 git rev-list --count --objects $branch >expect &&
163 git rev-list --use-bitmap-index --count --objects $branch >actual &&
164 test_cmp expect actual
167 test_expect_success
"enumerate commits ($state, $branch)" '
168 git rev-list --use-bitmap-index $branch >actual &&
169 git rev-list $branch >expect &&
170 test_bitmap_traversal --no-confirm-bitmaps expect actual
173 test_expect_success
"enumerate --objects ($state, $branch)" '
174 git rev-list --objects --use-bitmap-index $branch >actual &&
175 git rev-list --objects $branch >expect &&
176 test_bitmap_traversal expect actual
179 test_expect_success
"bitmap --objects handles non-commit objects ($state, $branch)" '
180 git rev-list --objects --use-bitmap-index $branch tagged-blob >actual &&
188 for branch
in "second" "other"
194 rev_list_tests
'full bitmap'
196 test_expect_success
'clone from bitmapped repository' '
197 git clone --no-local --bare . clone.git &&
198 git rev-parse HEAD >expect &&
199 git --git-dir=clone.git rev-parse HEAD >actual &&
200 test_cmp expect actual
203 test_expect_success
'partial clone from bitmapped repository' '
204 test_config uploadpack.allowfilter true &&
205 git clone --no-local --bare --filter=blob:none . partial-clone.git &&
207 cd partial-clone.git &&
208 pack=$(echo objects/pack/*.pack) &&
209 git verify-pack -v "$pack" >have &&
210 awk "/blob/ { print \$1 }" <have >blobs &&
211 # we expect this single blob because of the direct ref
212 git rev-parse refs/tags/tagged-blob >expect &&
213 test_cmp expect blobs
217 test_expect_success
'setup further non-bitmapped commits' '
218 test_commit_bulk --id=further 10
221 rev_list_tests
'partial bitmap'
223 test_expect_success
'fetch (partial bitmap)' '
224 git --git-dir=clone.git fetch origin second:second &&
225 git rev-parse HEAD >expect &&
226 git --git-dir=clone.git rev-parse HEAD >actual &&
227 test_cmp expect actual
230 test_expect_success
'incremental repack fails when bitmaps are requested' '
231 test_commit more-1 &&
232 test_must_fail git repack -d 2>err &&
233 test_i18ngrep "Incremental repacks are incompatible with bitmap" err
236 test_expect_success
'incremental repack can disable bitmaps' '
237 test_commit more-2 &&
238 git repack -d --no-write-bitmap-index
241 test_expect_success
'pack-objects respects --local (non-local loose)' '
242 git init --bare alt.git &&
243 echo $(pwd)/alt.git/objects >.git/objects/info/alternates &&
244 echo content1 >file1 &&
245 # non-local loose object which is not present in bitmapped pack
246 altblob=$(GIT_DIR=alt.git git hash-object -w file1) &&
247 # non-local loose object which is also present in bitmapped pack
248 git cat-file blob $blob | GIT_DIR=alt.git git hash-object -w --stdin &&
251 git commit -m commit_file1 &&
252 echo HEAD | git pack-objects --local --stdout --revs >1.pack &&
253 git index-pack 1.pack &&
254 list_packed_objects 1.idx >1.objects &&
255 printf "%s\n" "$altblob" "$blob" >nonlocal-loose &&
256 ! has_any nonlocal-loose 1.objects
259 test_expect_success
'pack-objects respects --honor-pack-keep (local non-bitmapped pack)' '
260 echo content2 >file2 &&
261 blob2=$(git hash-object -w file2) &&
264 git commit -m commit_file2 &&
265 printf "%s\n" "$blob2" "$bitmaptip" >keepobjects &&
266 pack2=$(git pack-objects pack2 <keepobjects) &&
267 mv pack2-$pack2.* .git/objects/pack/ &&
268 >.git/objects/pack/pack2-$pack2.keep &&
269 rm $(objpath $blob2) &&
270 echo HEAD | git pack-objects --honor-pack-keep --stdout --revs >2a.pack &&
271 git index-pack 2a.pack &&
272 list_packed_objects 2a.idx >2a.objects &&
273 ! has_any keepobjects 2a.objects
276 test_expect_success
'pack-objects respects --local (non-local pack)' '
277 mv .git/objects/pack/pack2-$pack2.* alt.git/objects/pack/ &&
278 echo HEAD | git pack-objects --local --stdout --revs >2b.pack &&
279 git index-pack 2b.pack &&
280 list_packed_objects 2b.idx >2b.objects &&
281 ! has_any keepobjects 2b.objects
284 test_expect_success
'pack-objects respects --honor-pack-keep (local bitmapped pack)' '
285 ls .git/objects/pack/ | grep bitmap >output &&
286 test_line_count = 1 output &&
287 packbitmap=$(basename $(cat output) .bitmap) &&
288 list_packed_objects .git/objects/pack/$packbitmap.idx >packbitmap.objects &&
289 test_when_finished "rm -f .git/objects/pack/$packbitmap.keep" &&
290 >.git/objects/pack/$packbitmap.keep &&
291 echo HEAD | git pack-objects --honor-pack-keep --stdout --revs >3a.pack &&
292 git index-pack 3a.pack &&
293 list_packed_objects 3a.idx >3a.objects &&
294 ! has_any packbitmap.objects 3a.objects
297 test_expect_success
'pack-objects respects --local (non-local bitmapped pack)' '
298 mv .git/objects/pack/$packbitmap.* alt.git/objects/pack/ &&
299 rm -f .git/objects/pack/multi-pack-index &&
300 test_when_finished "mv alt.git/objects/pack/$packbitmap.* .git/objects/pack/" &&
301 echo HEAD | git pack-objects --local --stdout --revs >3b.pack &&
302 git index-pack 3b.pack &&
303 list_packed_objects 3b.idx >3b.objects &&
304 ! has_any packbitmap.objects 3b.objects
307 test_expect_success
'pack-objects to file can use bitmap' '
308 # make sure we still have 1 bitmap index from previous tests
309 ls .git/objects/pack/ | grep bitmap >output &&
310 test_line_count = 1 output &&
311 # verify equivalent packs are generated with/without using bitmap index
312 packasha1=$(git pack-objects --no-use-bitmap-index --all packa </dev/null) &&
313 packbsha1=$(git pack-objects --use-bitmap-index --all packb </dev/null) &&
314 list_packed_objects packa-$packasha1.idx >packa.objects &&
315 list_packed_objects packb-$packbsha1.idx >packb.objects &&
316 test_cmp packa.objects packb.objects
319 test_expect_success
'full repack, reusing previous bitmaps' '
321 ls .git/objects/pack/ | grep bitmap >output &&
322 test_line_count = 1 output
325 test_expect_success
'fetch (full bitmap)' '
326 git --git-dir=clone.git fetch origin second:second &&
327 git rev-parse HEAD >expect &&
328 git --git-dir=clone.git rev-parse HEAD >actual &&
329 test_cmp expect actual
332 test_expect_success
'create objects for missing-HAVE tests' '
333 blob=$(echo "missing have" | git hash-object -w --stdin) &&
334 tree=$(printf "100644 blob $blob\tfile\n" | git mktree) &&
335 parent=$(echo parent | git commit-tree $tree) &&
336 commit=$(echo commit | git commit-tree $tree -p $parent) &&
344 test_expect_success
'pack-objects respects --incremental' '
349 git pack-objects --incremental --stdout --revs <revs2 >4.pack &&
350 git index-pack 4.pack &&
351 list_packed_objects 4.idx >4.objects &&
352 test_line_count = 4 4.objects &&
353 git rev-list --objects $commit >revlist &&
354 cut -d" " -f1 revlist |sort >objects &&
355 test_cmp 4.objects objects
358 test_expect_success
'pack with missing blob' '
359 rm $(objpath $blob) &&
360 git pack-objects --stdout --revs <revs >/dev/null
363 test_expect_success
'pack with missing tree' '
364 rm $(objpath $tree) &&
365 git pack-objects --stdout --revs <revs >/dev/null
368 test_expect_success
'pack with missing parent' '
369 rm $(objpath $parent) &&
370 git pack-objects --stdout --revs <revs >/dev/null
373 test_expect_success JGIT
,SHA1
'we can read jgit bitmaps' '
374 git clone --bare . compat-jgit.git &&
376 cd compat-jgit.git &&
377 rm -f objects/pack/*.bitmap &&
379 git rev-list --test-bitmap HEAD
383 test_expect_success JGIT
,SHA1
'jgit can read our bitmaps' '
384 git clone --bare . compat-us.git &&
388 # jgit gc will barf if it does not like our bitmaps
393 test_expect_success
'splitting packs does not generate bogus bitmaps' '
394 test-tool genrandom foo $((1024 * 1024)) >rand &&
396 git commit -m "commit with big file" &&
397 git -c pack.packSizeLimit=500k repack -adb &&
398 git init --bare no-bitmaps.git &&
399 git -C no-bitmaps.git fetch .. HEAD
402 test_expect_success
'set up reusable pack' '
403 rm -f .git/objects/pack/*.keep &&
406 git for-each-ref --format="%(objectname)" |
407 git pack-objects --delta-base-offset --revs --stdout "$@"
411 test_expect_success
'pack reuse respects --honor-pack-keep' '
412 test_when_finished "rm -f .git/objects/pack/*.keep" &&
413 for i in .git/objects/pack/*.pack
417 reusable_pack --honor-pack-keep >empty.pack &&
418 git index-pack empty.pack &&
419 git show-index <empty.idx >actual &&
420 test_must_be_empty actual
423 test_expect_success
'pack reuse respects --local' '
424 mv .git/objects/pack/* alt.git/objects/pack/ &&
425 test_when_finished "mv alt.git/objects/pack/* .git/objects/pack/" &&
426 reusable_pack --local >empty.pack &&
427 git index-pack empty.pack &&
428 git show-index <empty.idx >actual &&
429 test_must_be_empty actual
432 test_expect_success
'pack reuse respects --incremental' '
433 reusable_pack --incremental >empty.pack &&
434 git index-pack empty.pack &&
435 git show-index <empty.idx >actual &&
436 test_must_be_empty actual
439 test_expect_success
'truncated bitmap fails gracefully (ewah)' '
440 test_config pack.writebitmaphashcache false &&
442 git rev-list --use-bitmap-index --count --all >expect &&
443 bitmap=$(ls .git/objects/pack/*.bitmap) &&
444 test_when_finished "rm -f $bitmap" &&
445 test_copy_bytes 256 <$bitmap >$bitmap.tmp &&
446 mv -f $bitmap.tmp $bitmap &&
447 git rev-list --use-bitmap-index --count --all >actual 2>stderr &&
448 test_cmp expect actual &&
449 test_i18ngrep corrupt.ewah.bitmap stderr
452 test_expect_success
'truncated bitmap fails gracefully (cache)' '
454 git rev-list --use-bitmap-index --count --all >expect &&
455 bitmap=$(ls .git/objects/pack/*.bitmap) &&
456 test_when_finished "rm -f $bitmap" &&
457 test_copy_bytes 512 <$bitmap >$bitmap.tmp &&
458 mv -f $bitmap.tmp $bitmap &&
459 git rev-list --use-bitmap-index --count --all >actual 2>stderr &&
460 test_cmp expect actual &&
461 test_i18ngrep corrupted.bitmap.index stderr
464 test_expect_success
'enumerating progress counts pack-reused objects' '
465 count=$(git rev-list --objects --all --count) &&
468 # check first with only reused objects; confirm that our progress
469 # showed the right number, and also that we did pack-reuse as expected.
470 # Check only the final "done" line of the meter (there may be an
471 # arbitrary number of intermediate lines ending with CR).
472 GIT_PROGRESS_DELAY=0 \
473 git pack-objects --all --stdout --progress \
474 </dev/null >/dev/null 2>stderr &&
475 grep "Enumerating objects: $count, done" stderr &&
476 grep "pack-reused $count" stderr &&
478 # now the same but with one non-reused object
479 git commit --allow-empty -m "an extra commit object" &&
480 GIT_PROGRESS_DELAY=0 \
481 git pack-objects --all --stdout --progress \
482 </dev/null >/dev/null 2>stderr &&
483 grep "Enumerating objects: $((count+1)), done" stderr &&
484 grep "pack-reused $count" stderr
487 # have_delta <obj> <expected_base>
489 # Note that because this relies on cat-file, it might find _any_ copy of an
490 # object in the repository. The caller is responsible for making sure
491 # there's only one (e.g., via "repack -ad", or having just fetched a copy).
494 echo $1 | git cat-file
--batch-check="%(deltabase)" >actual
&&
495 test_cmp expect actual
498 # Create a state of history with these properties:
500 # - refs that allow a client to fetch some new history, while sharing some old
501 # history with the server; we use branches delta-reuse-old and
502 # delta-reuse-new here
504 # - the new history contains an object that is stored on the server as a delta
505 # against a base that is in the old history
507 # - the base object is not immediately reachable from the tip of the old
508 # history; finding it would involve digging down through history we know the
511 # This should result in a state where fetching from old->new would not
512 # traditionally reuse the on-disk delta (because we'd have to dig to realize
513 # that the client has it), but we will do so if bitmaps can tell us cheaply
514 # that the other side has it.
515 test_expect_success
'set up thin delta-reuse parent' '
516 # This first commit contains the buried base object.
517 test-tool genrandom delta 16384 >file &&
519 git commit -m "delta base" &&
520 base=$(git rev-parse --verify HEAD:file) &&
522 # These intermediate commits bury the base back in history.
523 # This becomes the "old" state.
527 git commit -am "intermediate $i" || return 1
529 git branch delta-reuse-old &&
531 # And now our new history has a delta against the buried base. Note
532 # that this must be smaller than the original file, since pack-objects
533 # prefers to create deltas from smaller objects to larger.
534 test-tool genrandom delta 16300 >file &&
535 git commit -am "delta result" &&
536 delta=$(git rev-parse --verify HEAD:file) &&
537 git branch delta-reuse-new &&
539 # Repack with bitmaps and double check that we have the expected delta
542 have_delta $delta $base
545 # Now we can sanity-check the non-bitmap behavior (that the server is not able
546 # to reuse the delta). This isn't strictly something we care about, so this
547 # test could be scrapped in the future. But it makes sure that the next test is
548 # actually triggering the feature we want.
550 # Note that our tools for working with on-the-wire "thin" packs are limited. So
551 # we actually perform the fetch, retain the resulting pack, and inspect the
553 test_expect_success
'fetch without bitmaps ignores delta against old base' '
554 test_config pack.usebitmaps false &&
555 test_when_finished "rm -rf client.git" &&
556 git init --bare client.git &&
559 git config transfer.unpackLimit 1 &&
560 git fetch .. delta-reuse-old:delta-reuse-old &&
561 git fetch .. delta-reuse-new:delta-reuse-new &&
562 have_delta $delta $ZERO_OID
566 # And do the same for the bitmap case, where we do expect to find the delta.
567 test_expect_success
'fetch with bitmaps can reuse old base' '
568 test_config pack.usebitmaps true &&
569 test_when_finished "rm -rf client.git" &&
570 git init --bare client.git &&
573 git config transfer.unpackLimit 1 &&
574 git fetch .. delta-reuse-old:delta-reuse-old &&
575 git fetch .. delta-reuse-new:delta-reuse-new &&
576 have_delta $delta $base
580 test_expect_success
'pack.preferBitmapTips' '
582 test_when_finished "rm -fr repo" &&
586 # create enough commits that not all are receive bitmap
587 # coverage even if they are all at the tip of some reference.
588 test_commit_bulk --message="%s" 103 &&
590 git rev-list HEAD >commits.raw &&
591 sort <commits.raw >commits &&
593 git log --format="create refs/tags/%s %H" HEAD >refs &&
594 git update-ref --stdin <refs &&
597 test-tool bitmap list-commits | sort >bitmaps &&
599 # remember which commits did not receive bitmaps
600 comm -13 bitmaps commits >before &&
601 test_file_not_empty before &&
603 # mark the commits which did not receive bitmaps as preferred,
604 # and generate the bitmap again
605 perl -pe "s{^}{create refs/tags/include/$. }" <before |
606 git update-ref --stdin &&
607 git -c pack.preferBitmapTips=refs/tags/include repack -adb &&
609 # finally, check that the commit(s) without bitmap coverage
610 # are not the same ones as before
611 test-tool bitmap list-commits | sort >bitmaps &&
612 comm -13 bitmaps commits >after &&
614 ! test_cmp before after