3 #include "repository.h"
13 #include "pack-revindex.h"
14 #include "csum-file.h"
15 #include "tree-walk.h"
18 #include "list-objects.h"
19 #include "list-objects-filter.h"
20 #include "list-objects-filter-options.h"
21 #include "pack-objects.h"
24 #include "streaming.h"
25 #include "thread-utils.h"
26 #include "pack-bitmap.h"
27 #include "reachable.h"
28 #include "sha1-array.h"
29 #include "argv-array.h"
32 #include "object-store.h"
34 #define IN_PACK(obj) oe_in_pack(&to_pack, obj)
35 #define DELTA(obj) oe_delta(&to_pack, obj)
36 #define DELTA_CHILD(obj) oe_delta_child(&to_pack, obj)
37 #define DELTA_SIBLING(obj) oe_delta_sibling(&to_pack, obj)
38 #define SET_DELTA(obj, val) oe_set_delta(&to_pack, obj, val)
39 #define SET_DELTA_CHILD(obj, val) oe_set_delta_child(&to_pack, obj, val)
40 #define SET_DELTA_SIBLING(obj, val) oe_set_delta_sibling(&to_pack, obj, val)
42 static const char *pack_usage
[] = {
43 N_("git pack-objects --stdout [<options>...] [< <ref-list> | < <object-list>]"),
44 N_("git pack-objects [<options>...] <base-name> [< <ref-list> | < <object-list>]"),
49 * Objects we are going to pack are collected in the `to_pack` structure.
50 * It contains an array (dynamically expanded) of the object data, and a map
51 * that can resolve SHA1s to their position in the array.
53 static struct packing_data to_pack
;
55 static struct pack_idx_entry
**written_list
;
56 static uint32_t nr_result
, nr_written
;
59 static int reuse_delta
= 1, reuse_object
= 1;
60 static int keep_unreachable
, unpack_unreachable
, include_tag
;
61 static timestamp_t unpack_unreachable_expiration
;
62 static int pack_loose_unreachable
;
64 static int have_non_local_packs
;
65 static int incremental
;
66 static int ignore_packed_keep
;
67 static int allow_ofs_delta
;
68 static struct pack_idx_option pack_idx_opts
;
69 static const char *base_name
;
70 static int progress
= 1;
71 static int window
= 10;
72 static unsigned long pack_size_limit
;
73 static int depth
= 50;
74 static int delta_search_threads
;
75 static int pack_to_stdout
;
76 static int num_preferred_base
;
77 static struct progress
*progress_state
;
79 static struct packed_git
*reuse_packfile
;
80 static uint32_t reuse_packfile_objects
;
81 static off_t reuse_packfile_offset
;
83 static int use_bitmap_index_default
= 1;
84 static int use_bitmap_index
= -1;
85 static int write_bitmap_index
;
86 static uint16_t write_bitmap_options
;
88 static int exclude_promisor_objects
;
90 static unsigned long delta_cache_size
= 0;
91 static unsigned long max_delta_cache_size
= 256 * 1024 * 1024;
92 static unsigned long cache_max_small_delta_size
= 1000;
94 static unsigned long window_memory_limit
= 0;
96 static struct list_objects_filter_options filter_options
;
99 MA_ERROR
= 0, /* fail if any missing objects are encountered */
100 MA_ALLOW_ANY
, /* silently allow ALL missing objects */
101 MA_ALLOW_PROMISOR
, /* silently allow all missing PROMISOR objects */
103 static enum missing_action arg_missing_action
;
104 static show_object_fn fn_show_object
;
109 static uint32_t written
, written_delta
;
110 static uint32_t reused
, reused_delta
;
115 static struct commit
**indexed_commits
;
116 static unsigned int indexed_commits_nr
;
117 static unsigned int indexed_commits_alloc
;
119 static void index_commit_for_bitmap(struct commit
*commit
)
121 if (indexed_commits_nr
>= indexed_commits_alloc
) {
122 indexed_commits_alloc
= (indexed_commits_alloc
+ 32) * 2;
123 REALLOC_ARRAY(indexed_commits
, indexed_commits_alloc
);
126 indexed_commits
[indexed_commits_nr
++] = commit
;
129 static void *get_delta(struct object_entry
*entry
)
131 unsigned long size
, base_size
, delta_size
;
132 void *buf
, *base_buf
, *delta_buf
;
133 enum object_type type
;
135 buf
= read_object_file(&entry
->idx
.oid
, &type
, &size
);
137 die("unable to read %s", oid_to_hex(&entry
->idx
.oid
));
138 base_buf
= read_object_file(&DELTA(entry
)->idx
.oid
, &type
,
141 die("unable to read %s",
142 oid_to_hex(&DELTA(entry
)->idx
.oid
));
143 delta_buf
= diff_delta(base_buf
, base_size
,
144 buf
, size
, &delta_size
, 0);
145 if (!delta_buf
|| delta_size
!= entry
->delta_size
)
146 die("delta size changed");
152 static unsigned long do_compress(void **pptr
, unsigned long size
)
156 unsigned long maxsize
;
158 git_deflate_init(&stream
, pack_compression_level
);
159 maxsize
= git_deflate_bound(&stream
, size
);
162 out
= xmalloc(maxsize
);
166 stream
.avail_in
= size
;
167 stream
.next_out
= out
;
168 stream
.avail_out
= maxsize
;
169 while (git_deflate(&stream
, Z_FINISH
) == Z_OK
)
171 git_deflate_end(&stream
);
174 return stream
.total_out
;
177 static unsigned long write_large_blob_data(struct git_istream
*st
, struct hashfile
*f
,
178 const struct object_id
*oid
)
181 unsigned char ibuf
[1024 * 16];
182 unsigned char obuf
[1024 * 16];
183 unsigned long olen
= 0;
185 git_deflate_init(&stream
, pack_compression_level
);
190 readlen
= read_istream(st
, ibuf
, sizeof(ibuf
));
192 die(_("unable to read %s"), oid_to_hex(oid
));
194 stream
.next_in
= ibuf
;
195 stream
.avail_in
= readlen
;
196 while ((stream
.avail_in
|| readlen
== 0) &&
197 (zret
== Z_OK
|| zret
== Z_BUF_ERROR
)) {
198 stream
.next_out
= obuf
;
199 stream
.avail_out
= sizeof(obuf
);
200 zret
= git_deflate(&stream
, readlen ?
0 : Z_FINISH
);
201 hashwrite(f
, obuf
, stream
.next_out
- obuf
);
202 olen
+= stream
.next_out
- obuf
;
205 die(_("deflate error (%d)"), zret
);
207 if (zret
!= Z_STREAM_END
)
208 die(_("deflate error (%d)"), zret
);
212 git_deflate_end(&stream
);
217 * we are going to reuse the existing object data as is. make
218 * sure it is not corrupt.
220 static int check_pack_inflate(struct packed_git
*p
,
221 struct pack_window
**w_curs
,
224 unsigned long expect
)
227 unsigned char fakebuf
[4096], *in
;
230 memset(&stream
, 0, sizeof(stream
));
231 git_inflate_init(&stream
);
233 in
= use_pack(p
, w_curs
, offset
, &stream
.avail_in
);
235 stream
.next_out
= fakebuf
;
236 stream
.avail_out
= sizeof(fakebuf
);
237 st
= git_inflate(&stream
, Z_FINISH
);
238 offset
+= stream
.next_in
- in
;
239 } while (st
== Z_OK
|| st
== Z_BUF_ERROR
);
240 git_inflate_end(&stream
);
241 return (st
== Z_STREAM_END
&&
242 stream
.total_out
== expect
&&
243 stream
.total_in
== len
) ?
0 : -1;
246 static void copy_pack_data(struct hashfile
*f
,
247 struct packed_git
*p
,
248 struct pack_window
**w_curs
,
256 in
= use_pack(p
, w_curs
, offset
, &avail
);
258 avail
= (unsigned long)len
;
259 hashwrite(f
, in
, avail
);
265 /* Return 0 if we will bust the pack-size limit */
266 static unsigned long write_no_reuse_object(struct hashfile
*f
, struct object_entry
*entry
,
267 unsigned long limit
, int usable_delta
)
269 unsigned long size
, datalen
;
270 unsigned char header
[MAX_PACK_OBJECT_HEADER
],
271 dheader
[MAX_PACK_OBJECT_HEADER
];
273 enum object_type type
;
275 struct git_istream
*st
= NULL
;
278 if (oe_type(entry
) == OBJ_BLOB
&&
279 entry
->size
> big_file_threshold
&&
280 (st
= open_istream(&entry
->idx
.oid
, &type
, &size
, NULL
)) != NULL
)
283 buf
= read_object_file(&entry
->idx
.oid
, &type
, &size
);
285 die(_("unable to read %s"),
286 oid_to_hex(&entry
->idx
.oid
));
289 * make sure no cached delta data remains from a
290 * previous attempt before a pack split occurred.
292 FREE_AND_NULL(entry
->delta_data
);
293 entry
->z_delta_size
= 0;
294 } else if (entry
->delta_data
) {
295 size
= entry
->delta_size
;
296 buf
= entry
->delta_data
;
297 entry
->delta_data
= NULL
;
298 type
= (allow_ofs_delta
&& DELTA(entry
)->idx
.offset
) ?
299 OBJ_OFS_DELTA
: OBJ_REF_DELTA
;
301 buf
= get_delta(entry
);
302 size
= entry
->delta_size
;
303 type
= (allow_ofs_delta
&& DELTA(entry
)->idx
.offset
) ?
304 OBJ_OFS_DELTA
: OBJ_REF_DELTA
;
307 if (st
) /* large blob case, just assume we don't compress well */
309 else if (entry
->z_delta_size
)
310 datalen
= entry
->z_delta_size
;
312 datalen
= do_compress(&buf
, size
);
315 * The object header is a byte of 'type' followed by zero or
316 * more bytes of length.
318 hdrlen
= encode_in_pack_object_header(header
, sizeof(header
),
321 if (type
== OBJ_OFS_DELTA
) {
323 * Deltas with relative base contain an additional
324 * encoding of the relative offset for the delta
325 * base from this object's position in the pack.
327 off_t ofs
= entry
->idx
.offset
- DELTA(entry
)->idx
.offset
;
328 unsigned pos
= sizeof(dheader
) - 1;
329 dheader
[pos
] = ofs
& 127;
331 dheader
[--pos
] = 128 | (--ofs
& 127);
332 if (limit
&& hdrlen
+ sizeof(dheader
) - pos
+ datalen
+ 20 >= limit
) {
338 hashwrite(f
, header
, hdrlen
);
339 hashwrite(f
, dheader
+ pos
, sizeof(dheader
) - pos
);
340 hdrlen
+= sizeof(dheader
) - pos
;
341 } else if (type
== OBJ_REF_DELTA
) {
343 * Deltas with a base reference contain
344 * an additional 20 bytes for the base sha1.
346 if (limit
&& hdrlen
+ 20 + datalen
+ 20 >= limit
) {
352 hashwrite(f
, header
, hdrlen
);
353 hashwrite(f
, DELTA(entry
)->idx
.oid
.hash
, 20);
356 if (limit
&& hdrlen
+ datalen
+ 20 >= limit
) {
362 hashwrite(f
, header
, hdrlen
);
365 datalen
= write_large_blob_data(st
, f
, &entry
->idx
.oid
);
368 hashwrite(f
, buf
, datalen
);
372 return hdrlen
+ datalen
;
375 /* Return 0 if we will bust the pack-size limit */
376 static off_t
write_reuse_object(struct hashfile
*f
, struct object_entry
*entry
,
377 unsigned long limit
, int usable_delta
)
379 struct packed_git
*p
= IN_PACK(entry
);
380 struct pack_window
*w_curs
= NULL
;
381 struct revindex_entry
*revidx
;
383 enum object_type type
= oe_type(entry
);
385 unsigned char header
[MAX_PACK_OBJECT_HEADER
],
386 dheader
[MAX_PACK_OBJECT_HEADER
];
390 type
= (allow_ofs_delta
&& DELTA(entry
)->idx
.offset
) ?
391 OBJ_OFS_DELTA
: OBJ_REF_DELTA
;
392 hdrlen
= encode_in_pack_object_header(header
, sizeof(header
),
395 offset
= entry
->in_pack_offset
;
396 revidx
= find_pack_revindex(p
, offset
);
397 datalen
= revidx
[1].offset
- offset
;
398 if (!pack_to_stdout
&& p
->index_version
> 1 &&
399 check_pack_crc(p
, &w_curs
, offset
, datalen
, revidx
->nr
)) {
400 error("bad packed object CRC for %s",
401 oid_to_hex(&entry
->idx
.oid
));
403 return write_no_reuse_object(f
, entry
, limit
, usable_delta
);
406 offset
+= entry
->in_pack_header_size
;
407 datalen
-= entry
->in_pack_header_size
;
409 if (!pack_to_stdout
&& p
->index_version
== 1 &&
410 check_pack_inflate(p
, &w_curs
, offset
, datalen
, entry
->size
)) {
411 error("corrupt packed object for %s",
412 oid_to_hex(&entry
->idx
.oid
));
414 return write_no_reuse_object(f
, entry
, limit
, usable_delta
);
417 if (type
== OBJ_OFS_DELTA
) {
418 off_t ofs
= entry
->idx
.offset
- DELTA(entry
)->idx
.offset
;
419 unsigned pos
= sizeof(dheader
) - 1;
420 dheader
[pos
] = ofs
& 127;
422 dheader
[--pos
] = 128 | (--ofs
& 127);
423 if (limit
&& hdrlen
+ sizeof(dheader
) - pos
+ datalen
+ 20 >= limit
) {
427 hashwrite(f
, header
, hdrlen
);
428 hashwrite(f
, dheader
+ pos
, sizeof(dheader
) - pos
);
429 hdrlen
+= sizeof(dheader
) - pos
;
431 } else if (type
== OBJ_REF_DELTA
) {
432 if (limit
&& hdrlen
+ 20 + datalen
+ 20 >= limit
) {
436 hashwrite(f
, header
, hdrlen
);
437 hashwrite(f
, DELTA(entry
)->idx
.oid
.hash
, 20);
441 if (limit
&& hdrlen
+ datalen
+ 20 >= limit
) {
445 hashwrite(f
, header
, hdrlen
);
447 copy_pack_data(f
, p
, &w_curs
, offset
, datalen
);
450 return hdrlen
+ datalen
;
453 /* Return 0 if we will bust the pack-size limit */
454 static off_t
write_object(struct hashfile
*f
,
455 struct object_entry
*entry
,
460 int usable_delta
, to_reuse
;
465 /* apply size limit if limited packsize and not first object */
466 if (!pack_size_limit
|| !nr_written
)
468 else if (pack_size_limit
<= write_offset
)
470 * the earlier object did not fit the limit; avoid
471 * mistaking this with unlimited (i.e. limit = 0).
475 limit
= pack_size_limit
- write_offset
;
478 usable_delta
= 0; /* no delta */
479 else if (!pack_size_limit
)
480 usable_delta
= 1; /* unlimited packfile */
481 else if (DELTA(entry
)->idx
.offset
== (off_t
)-1)
482 usable_delta
= 0; /* base was written to another pack */
483 else if (DELTA(entry
)->idx
.offset
)
484 usable_delta
= 1; /* base already exists in this pack */
486 usable_delta
= 0; /* base could end up in another pack */
489 to_reuse
= 0; /* explicit */
490 else if (!IN_PACK(entry
))
491 to_reuse
= 0; /* can't reuse what we don't have */
492 else if (oe_type(entry
) == OBJ_REF_DELTA
||
493 oe_type(entry
) == OBJ_OFS_DELTA
)
494 /* check_object() decided it for us ... */
495 to_reuse
= usable_delta
;
496 /* ... but pack split may override that */
497 else if (oe_type(entry
) != entry
->in_pack_type
)
498 to_reuse
= 0; /* pack has delta which is unusable */
499 else if (DELTA(entry
))
500 to_reuse
= 0; /* we want to pack afresh */
502 to_reuse
= 1; /* we have it in-pack undeltified,
503 * and we do not need to deltify it.
507 len
= write_no_reuse_object(f
, entry
, limit
, usable_delta
);
509 len
= write_reuse_object(f
, entry
, limit
, usable_delta
);
517 entry
->idx
.crc32
= crc32_end(f
);
521 enum write_one_status
{
522 WRITE_ONE_SKIP
= -1, /* already written */
523 WRITE_ONE_BREAK
= 0, /* writing this will bust the limit; not written */
524 WRITE_ONE_WRITTEN
= 1, /* normal */
525 WRITE_ONE_RECURSIVE
= 2 /* already scheduled to be written */
528 static enum write_one_status
write_one(struct hashfile
*f
,
529 struct object_entry
*e
,
536 * we set offset to 1 (which is an impossible value) to mark
537 * the fact that this object is involved in "write its base
538 * first before writing a deltified object" recursion.
540 recursing
= (e
->idx
.offset
== 1);
542 warning("recursive delta detected for object %s",
543 oid_to_hex(&e
->idx
.oid
));
544 return WRITE_ONE_RECURSIVE
;
545 } else if (e
->idx
.offset
|| e
->preferred_base
) {
546 /* offset is non zero if object is written already. */
547 return WRITE_ONE_SKIP
;
550 /* if we are deltified, write out base object first. */
552 e
->idx
.offset
= 1; /* now recurse */
553 switch (write_one(f
, DELTA(e
), offset
)) {
554 case WRITE_ONE_RECURSIVE
:
555 /* we cannot depend on this one */
560 case WRITE_ONE_BREAK
:
561 e
->idx
.offset
= recursing
;
562 return WRITE_ONE_BREAK
;
566 e
->idx
.offset
= *offset
;
567 size
= write_object(f
, e
, *offset
);
569 e
->idx
.offset
= recursing
;
570 return WRITE_ONE_BREAK
;
572 written_list
[nr_written
++] = &e
->idx
;
574 /* make sure off_t is sufficiently large not to wrap */
575 if (signed_add_overflows(*offset
, size
))
576 die("pack too large for current definition of off_t");
578 return WRITE_ONE_WRITTEN
;
581 static int mark_tagged(const char *path
, const struct object_id
*oid
, int flag
,
584 struct object_id peeled
;
585 struct object_entry
*entry
= packlist_find(&to_pack
, oid
->hash
, NULL
);
589 if (!peel_ref(path
, &peeled
)) {
590 entry
= packlist_find(&to_pack
, peeled
.hash
, NULL
);
597 static inline void add_to_write_order(struct object_entry
**wo
,
599 struct object_entry
*e
)
607 static void add_descendants_to_write_order(struct object_entry
**wo
,
609 struct object_entry
*e
)
611 int add_to_order
= 1;
614 struct object_entry
*s
;
615 /* add this node... */
616 add_to_write_order(wo
, endp
, e
);
617 /* all its siblings... */
618 for (s
= DELTA_SIBLING(e
); s
; s
= DELTA_SIBLING(s
)) {
619 add_to_write_order(wo
, endp
, s
);
622 /* drop down a level to add left subtree nodes if possible */
623 if (DELTA_CHILD(e
)) {
628 /* our sibling might have some children, it is next */
629 if (DELTA_SIBLING(e
)) {
630 e
= DELTA_SIBLING(e
);
633 /* go back to our parent node */
635 while (e
&& !DELTA_SIBLING(e
)) {
636 /* we're on the right side of a subtree, keep
637 * going up until we can go right again */
641 /* done- we hit our original root node */
644 /* pass it off to sibling at this level */
645 e
= DELTA_SIBLING(e
);
650 static void add_family_to_write_order(struct object_entry
**wo
,
652 struct object_entry
*e
)
654 struct object_entry
*root
;
656 for (root
= e
; DELTA(root
); root
= DELTA(root
))
658 add_descendants_to_write_order(wo
, endp
, root
);
661 static struct object_entry
**compute_write_order(void)
663 unsigned int i
, wo_end
, last_untagged
;
665 struct object_entry
**wo
;
666 struct object_entry
*objects
= to_pack
.objects
;
668 for (i
= 0; i
< to_pack
.nr_objects
; i
++) {
669 objects
[i
].tagged
= 0;
670 objects
[i
].filled
= 0;
671 SET_DELTA_CHILD(&objects
[i
], NULL
);
672 SET_DELTA_SIBLING(&objects
[i
], NULL
);
676 * Fully connect delta_child/delta_sibling network.
677 * Make sure delta_sibling is sorted in the original
680 for (i
= to_pack
.nr_objects
; i
> 0;) {
681 struct object_entry
*e
= &objects
[--i
];
684 /* Mark me as the first child */
685 e
->delta_sibling_idx
= DELTA(e
)->delta_child_idx
;
686 SET_DELTA_CHILD(DELTA(e
), e
);
690 * Mark objects that are at the tip of tags.
692 for_each_tag_ref(mark_tagged
, NULL
);
695 * Give the objects in the original recency order until
696 * we see a tagged tip.
698 ALLOC_ARRAY(wo
, to_pack
.nr_objects
);
699 for (i
= wo_end
= 0; i
< to_pack
.nr_objects
; i
++) {
700 if (objects
[i
].tagged
)
702 add_to_write_order(wo
, &wo_end
, &objects
[i
]);
707 * Then fill all the tagged tips.
709 for (; i
< to_pack
.nr_objects
; i
++) {
710 if (objects
[i
].tagged
)
711 add_to_write_order(wo
, &wo_end
, &objects
[i
]);
715 * And then all remaining commits and tags.
717 for (i
= last_untagged
; i
< to_pack
.nr_objects
; i
++) {
718 if (oe_type(&objects
[i
]) != OBJ_COMMIT
&&
719 oe_type(&objects
[i
]) != OBJ_TAG
)
721 add_to_write_order(wo
, &wo_end
, &objects
[i
]);
725 * And then all the trees.
727 for (i
= last_untagged
; i
< to_pack
.nr_objects
; i
++) {
728 if (oe_type(&objects
[i
]) != OBJ_TREE
)
730 add_to_write_order(wo
, &wo_end
, &objects
[i
]);
734 * Finally all the rest in really tight order
736 for (i
= last_untagged
; i
< to_pack
.nr_objects
; i
++) {
737 if (!objects
[i
].filled
)
738 add_family_to_write_order(wo
, &wo_end
, &objects
[i
]);
741 if (wo_end
!= to_pack
.nr_objects
)
742 die("ordered %u objects, expected %"PRIu32
, wo_end
, to_pack
.nr_objects
);
747 static off_t
write_reused_pack(struct hashfile
*f
)
749 unsigned char buffer
[8192];
750 off_t to_write
, total
;
753 if (!is_pack_valid(reuse_packfile
))
754 die("packfile is invalid: %s", reuse_packfile
->pack_name
);
756 fd
= git_open(reuse_packfile
->pack_name
);
758 die_errno("unable to open packfile for reuse: %s",
759 reuse_packfile
->pack_name
);
761 if (lseek(fd
, sizeof(struct pack_header
), SEEK_SET
) == -1)
762 die_errno("unable to seek in reused packfile");
764 if (reuse_packfile_offset
< 0)
765 reuse_packfile_offset
= reuse_packfile
->pack_size
- 20;
767 total
= to_write
= reuse_packfile_offset
- sizeof(struct pack_header
);
770 int read_pack
= xread(fd
, buffer
, sizeof(buffer
));
773 die_errno("unable to read from reused packfile");
775 if (read_pack
> to_write
)
776 read_pack
= to_write
;
778 hashwrite(f
, buffer
, read_pack
);
779 to_write
-= read_pack
;
782 * We don't know the actual number of objects written,
783 * only how many bytes written, how many bytes total, and
784 * how many objects total. So we can fake it by pretending all
785 * objects we are writing are the same size. This gives us a
786 * smooth progress meter, and at the end it matches the true
789 written
= reuse_packfile_objects
*
790 (((double)(total
- to_write
)) / total
);
791 display_progress(progress_state
, written
);
795 written
= reuse_packfile_objects
;
796 display_progress(progress_state
, written
);
797 return reuse_packfile_offset
- sizeof(struct pack_header
);
800 static const char no_split_warning
[] = N_(
801 "disabling bitmap writing, packs are split due to pack.packSizeLimit"
804 static void write_pack_file(void)
809 uint32_t nr_remaining
= nr_result
;
810 time_t last_mtime
= 0;
811 struct object_entry
**write_order
;
813 if (progress
> pack_to_stdout
)
814 progress_state
= start_progress(_("Writing objects"), nr_result
);
815 ALLOC_ARRAY(written_list
, to_pack
.nr_objects
);
816 write_order
= compute_write_order();
819 struct object_id oid
;
820 char *pack_tmp_name
= NULL
;
823 f
= hashfd_throughput(1, "<stdout>", progress_state
);
825 f
= create_tmp_packfile(&pack_tmp_name
);
827 offset
= write_pack_header(f
, nr_remaining
);
829 if (reuse_packfile
) {
831 assert(pack_to_stdout
);
833 packfile_size
= write_reused_pack(f
);
834 offset
+= packfile_size
;
838 for (; i
< to_pack
.nr_objects
; i
++) {
839 struct object_entry
*e
= write_order
[i
];
840 if (write_one(f
, e
, &offset
) == WRITE_ONE_BREAK
)
842 display_progress(progress_state
, written
);
846 * Did we write the wrong # entries in the header?
847 * If so, rewrite it like in fast-import
849 if (pack_to_stdout
) {
850 hashclose(f
, oid
.hash
, CSUM_CLOSE
);
851 } else if (nr_written
== nr_remaining
) {
852 hashclose(f
, oid
.hash
, CSUM_FSYNC
);
854 int fd
= hashclose(f
, oid
.hash
, 0);
855 fixup_pack_header_footer(fd
, oid
.hash
, pack_tmp_name
,
856 nr_written
, oid
.hash
, offset
);
858 if (write_bitmap_index
) {
859 warning(_(no_split_warning
));
860 write_bitmap_index
= 0;
864 if (!pack_to_stdout
) {
866 struct strbuf tmpname
= STRBUF_INIT
;
869 * Packs are runtime accessed in their mtime
870 * order since newer packs are more likely to contain
871 * younger objects. So if we are creating multiple
872 * packs then we should modify the mtime of later ones
873 * to preserve this property.
875 if (stat(pack_tmp_name
, &st
) < 0) {
876 warning_errno("failed to stat %s", pack_tmp_name
);
877 } else if (!last_mtime
) {
878 last_mtime
= st
.st_mtime
;
881 utb
.actime
= st
.st_atime
;
882 utb
.modtime
= --last_mtime
;
883 if (utime(pack_tmp_name
, &utb
) < 0)
884 warning_errno("failed utime() on %s", pack_tmp_name
);
887 strbuf_addf(&tmpname
, "%s-", base_name
);
889 if (write_bitmap_index
) {
890 bitmap_writer_set_checksum(oid
.hash
);
891 bitmap_writer_build_type_index(
892 &to_pack
, written_list
, nr_written
);
895 finish_tmp_packfile(&tmpname
, pack_tmp_name
,
896 written_list
, nr_written
,
897 &pack_idx_opts
, oid
.hash
);
899 if (write_bitmap_index
) {
900 strbuf_addf(&tmpname
, "%s.bitmap", oid_to_hex(&oid
));
902 stop_progress(&progress_state
);
904 bitmap_writer_show_progress(progress
);
905 bitmap_writer_reuse_bitmaps(&to_pack
);
906 bitmap_writer_select_commits(indexed_commits
, indexed_commits_nr
, -1);
907 bitmap_writer_build(&to_pack
);
908 bitmap_writer_finish(written_list
, nr_written
,
909 tmpname
.buf
, write_bitmap_options
);
910 write_bitmap_index
= 0;
913 strbuf_release(&tmpname
);
915 puts(oid_to_hex(&oid
));
918 /* mark written objects as written to previous pack */
919 for (j
= 0; j
< nr_written
; j
++) {
920 written_list
[j
]->offset
= (off_t
)-1;
922 nr_remaining
-= nr_written
;
923 } while (nr_remaining
&& i
< to_pack
.nr_objects
);
927 stop_progress(&progress_state
);
928 if (written
!= nr_result
)
929 die("wrote %"PRIu32
" objects while expecting %"PRIu32
,
933 static int no_try_delta(const char *path
)
935 static struct attr_check
*check
;
938 check
= attr_check_initl("delta", NULL
);
939 if (git_check_attr(path
, check
))
941 if (ATTR_FALSE(check
->items
[0].value
))
947 * When adding an object, check whether we have already added it
948 * to our packing list. If so, we can skip. However, if we are
949 * being asked to excludei t, but the previous mention was to include
950 * it, make sure to adjust its flags and tweak our numbers accordingly.
952 * As an optimization, we pass out the index position where we would have
953 * found the item, since that saves us from having to look it up again a
954 * few lines later when we want to add the new entry.
956 static int have_duplicate_entry(const struct object_id
*oid
,
960 struct object_entry
*entry
;
962 entry
= packlist_find(&to_pack
, oid
->hash
, index_pos
);
967 if (!entry
->preferred_base
)
969 entry
->preferred_base
= 1;
975 static int want_found_object(int exclude
, struct packed_git
*p
)
983 * When asked to do --local (do not include an object that appears in a
984 * pack we borrow from elsewhere) or --honor-pack-keep (do not include
985 * an object that appears in a pack marked with .keep), finding a pack
986 * that matches the criteria is sufficient for us to decide to omit it.
987 * However, even if this pack does not satisfy the criteria, we need to
988 * make sure no copy of this object appears in _any_ pack that makes us
989 * to omit the object, so we need to check all the packs.
991 * We can however first check whether these options can possible matter;
992 * if they do not matter we know we want the object in generated pack.
993 * Otherwise, we signal "-1" at the end to tell the caller that we do
994 * not know either way, and it needs to check more packs.
996 if (!ignore_packed_keep
&&
997 (!local
|| !have_non_local_packs
))
1000 if (local
&& !p
->pack_local
)
1002 if (ignore_packed_keep
&& p
->pack_local
&& p
->pack_keep
)
1005 /* we don't know yet; keep looking for more packs */
1010 * Check whether we want the object in the pack (e.g., we do not want
1011 * objects found in non-local stores if the "--local" option was used).
1013 * If the caller already knows an existing pack it wants to take the object
1014 * from, that is passed in *found_pack and *found_offset; otherwise this
1015 * function finds if there is any pack that has the object and returns the pack
1016 * and its offset in these variables.
1018 static int want_object_in_pack(const struct object_id
*oid
,
1020 struct packed_git
**found_pack
,
1021 off_t
*found_offset
)
1024 struct list_head
*pos
;
1026 if (!exclude
&& local
&& has_loose_object_nonlocal(oid
->hash
))
1030 * If we already know the pack object lives in, start checks from that
1031 * pack - in the usual case when neither --local was given nor .keep files
1032 * are present we will determine the answer right now.
1035 want
= want_found_object(exclude
, *found_pack
);
1039 list_for_each(pos
, get_packed_git_mru(the_repository
)) {
1040 struct packed_git
*p
= list_entry(pos
, struct packed_git
, mru
);
1043 if (p
== *found_pack
)
1044 offset
= *found_offset
;
1046 offset
= find_pack_entry_one(oid
->hash
, p
);
1050 if (!is_pack_valid(p
))
1052 *found_offset
= offset
;
1055 want
= want_found_object(exclude
, p
);
1056 if (!exclude
&& want
> 0)
1058 get_packed_git_mru(the_repository
));
1067 static void create_object_entry(const struct object_id
*oid
,
1068 enum object_type type
,
1073 struct packed_git
*found_pack
,
1076 struct object_entry
*entry
;
1078 entry
= packlist_alloc(&to_pack
, oid
->hash
, index_pos
);
1080 oe_set_type(entry
, type
);
1082 entry
->preferred_base
= 1;
1086 oe_set_in_pack(&to_pack
, entry
, found_pack
);
1087 entry
->in_pack_offset
= found_offset
;
1090 entry
->no_try_delta
= no_try_delta
;
1093 static const char no_closure_warning
[] = N_(
1094 "disabling bitmap writing, as some objects are not being packed"
1097 static int add_object_entry(const struct object_id
*oid
, enum object_type type
,
1098 const char *name
, int exclude
)
1100 struct packed_git
*found_pack
= NULL
;
1101 off_t found_offset
= 0;
1104 if (have_duplicate_entry(oid
, exclude
, &index_pos
))
1107 if (!want_object_in_pack(oid
, exclude
, &found_pack
, &found_offset
)) {
1108 /* The pack is missing an object, so it will not have closure */
1109 if (write_bitmap_index
) {
1110 warning(_(no_closure_warning
));
1111 write_bitmap_index
= 0;
1116 create_object_entry(oid
, type
, pack_name_hash(name
),
1117 exclude
, name
&& no_try_delta(name
),
1118 index_pos
, found_pack
, found_offset
);
1120 display_progress(progress_state
, nr_result
);
1124 static int add_object_entry_from_bitmap(const struct object_id
*oid
,
1125 enum object_type type
,
1126 int flags
, uint32_t name_hash
,
1127 struct packed_git
*pack
, off_t offset
)
1131 if (have_duplicate_entry(oid
, 0, &index_pos
))
1134 if (!want_object_in_pack(oid
, 0, &pack
, &offset
))
1137 create_object_entry(oid
, type
, name_hash
, 0, 0, index_pos
, pack
, offset
);
1139 display_progress(progress_state
, nr_result
);
1143 struct pbase_tree_cache
{
1144 struct object_id oid
;
1148 unsigned long tree_size
;
1151 static struct pbase_tree_cache
*(pbase_tree_cache
[256]);
1152 static int pbase_tree_cache_ix(const struct object_id
*oid
)
1154 return oid
->hash
[0] % ARRAY_SIZE(pbase_tree_cache
);
1156 static int pbase_tree_cache_ix_incr(int ix
)
1158 return (ix
+1) % ARRAY_SIZE(pbase_tree_cache
);
1161 static struct pbase_tree
{
1162 struct pbase_tree
*next
;
1163 /* This is a phony "cache" entry; we are not
1164 * going to evict it or find it through _get()
1165 * mechanism -- this is for the toplevel node that
1166 * would almost always change with any commit.
1168 struct pbase_tree_cache pcache
;
1171 static struct pbase_tree_cache
*pbase_tree_get(const struct object_id
*oid
)
1173 struct pbase_tree_cache
*ent
, *nent
;
1176 enum object_type type
;
1178 int my_ix
= pbase_tree_cache_ix(oid
);
1179 int available_ix
= -1;
1181 /* pbase-tree-cache acts as a limited hashtable.
1182 * your object will be found at your index or within a few
1183 * slots after that slot if it is cached.
1185 for (neigh
= 0; neigh
< 8; neigh
++) {
1186 ent
= pbase_tree_cache
[my_ix
];
1187 if (ent
&& !oidcmp(&ent
->oid
, oid
)) {
1191 else if (((available_ix
< 0) && (!ent
|| !ent
->ref
)) ||
1192 ((0 <= available_ix
) &&
1193 (!ent
&& pbase_tree_cache
[available_ix
])))
1194 available_ix
= my_ix
;
1197 my_ix
= pbase_tree_cache_ix_incr(my_ix
);
1200 /* Did not find one. Either we got a bogus request or
1201 * we need to read and perhaps cache.
1203 data
= read_object_file(oid
, &type
, &size
);
1206 if (type
!= OBJ_TREE
) {
1211 /* We need to either cache or return a throwaway copy */
1213 if (available_ix
< 0)
1216 ent
= pbase_tree_cache
[available_ix
];
1217 my_ix
= available_ix
;
1221 nent
= xmalloc(sizeof(*nent
));
1222 nent
->temporary
= (available_ix
< 0);
1225 /* evict and reuse */
1226 free(ent
->tree_data
);
1229 oidcpy(&nent
->oid
, oid
);
1230 nent
->tree_data
= data
;
1231 nent
->tree_size
= size
;
1233 if (!nent
->temporary
)
1234 pbase_tree_cache
[my_ix
] = nent
;
1238 static void pbase_tree_put(struct pbase_tree_cache
*cache
)
1240 if (!cache
->temporary
) {
1244 free(cache
->tree_data
);
1248 static int name_cmp_len(const char *name
)
1251 for (i
= 0; name
[i
] && name
[i
] != '\n' && name
[i
] != '/'; i
++)
1256 static void add_pbase_object(struct tree_desc
*tree
,
1259 const char *fullname
)
1261 struct name_entry entry
;
1264 while (tree_entry(tree
,&entry
)) {
1265 if (S_ISGITLINK(entry
.mode
))
1267 cmp
= tree_entry_len(&entry
) != cmplen ?
1 :
1268 memcmp(name
, entry
.path
, cmplen
);
1273 if (name
[cmplen
] != '/') {
1274 add_object_entry(entry
.oid
,
1275 object_type(entry
.mode
),
1279 if (S_ISDIR(entry
.mode
)) {
1280 struct tree_desc sub
;
1281 struct pbase_tree_cache
*tree
;
1282 const char *down
= name
+cmplen
+1;
1283 int downlen
= name_cmp_len(down
);
1285 tree
= pbase_tree_get(entry
.oid
);
1288 init_tree_desc(&sub
, tree
->tree_data
, tree
->tree_size
);
1290 add_pbase_object(&sub
, down
, downlen
, fullname
);
1291 pbase_tree_put(tree
);
1296 static unsigned *done_pbase_paths
;
1297 static int done_pbase_paths_num
;
1298 static int done_pbase_paths_alloc
;
1299 static int done_pbase_path_pos(unsigned hash
)
1302 int hi
= done_pbase_paths_num
;
1304 int mi
= lo
+ (hi
- lo
) / 2;
1305 if (done_pbase_paths
[mi
] == hash
)
1307 if (done_pbase_paths
[mi
] < hash
)
1315 static int check_pbase_path(unsigned hash
)
1317 int pos
= done_pbase_path_pos(hash
);
1321 ALLOC_GROW(done_pbase_paths
,
1322 done_pbase_paths_num
+ 1,
1323 done_pbase_paths_alloc
);
1324 done_pbase_paths_num
++;
1325 if (pos
< done_pbase_paths_num
)
1326 MOVE_ARRAY(done_pbase_paths
+ pos
+ 1, done_pbase_paths
+ pos
,
1327 done_pbase_paths_num
- pos
- 1);
1328 done_pbase_paths
[pos
] = hash
;
1332 static void add_preferred_base_object(const char *name
)
1334 struct pbase_tree
*it
;
1336 unsigned hash
= pack_name_hash(name
);
1338 if (!num_preferred_base
|| check_pbase_path(hash
))
1341 cmplen
= name_cmp_len(name
);
1342 for (it
= pbase_tree
; it
; it
= it
->next
) {
1344 add_object_entry(&it
->pcache
.oid
, OBJ_TREE
, NULL
, 1);
1347 struct tree_desc tree
;
1348 init_tree_desc(&tree
, it
->pcache
.tree_data
, it
->pcache
.tree_size
);
1349 add_pbase_object(&tree
, name
, cmplen
, name
);
1354 static void add_preferred_base(struct object_id
*oid
)
1356 struct pbase_tree
*it
;
1359 struct object_id tree_oid
;
1361 if (window
<= num_preferred_base
++)
1364 data
= read_object_with_reference(oid
, tree_type
, &size
, &tree_oid
);
1368 for (it
= pbase_tree
; it
; it
= it
->next
) {
1369 if (!oidcmp(&it
->pcache
.oid
, &tree_oid
)) {
1375 it
= xcalloc(1, sizeof(*it
));
1376 it
->next
= pbase_tree
;
1379 oidcpy(&it
->pcache
.oid
, &tree_oid
);
1380 it
->pcache
.tree_data
= data
;
1381 it
->pcache
.tree_size
= size
;
1384 static void cleanup_preferred_base(void)
1386 struct pbase_tree
*it
;
1392 struct pbase_tree
*tmp
= it
;
1394 free(tmp
->pcache
.tree_data
);
1398 for (i
= 0; i
< ARRAY_SIZE(pbase_tree_cache
); i
++) {
1399 if (!pbase_tree_cache
[i
])
1401 free(pbase_tree_cache
[i
]->tree_data
);
1402 FREE_AND_NULL(pbase_tree_cache
[i
]);
1405 FREE_AND_NULL(done_pbase_paths
);
1406 done_pbase_paths_num
= done_pbase_paths_alloc
= 0;
1409 static void check_object(struct object_entry
*entry
)
1411 if (IN_PACK(entry
)) {
1412 struct packed_git
*p
= IN_PACK(entry
);
1413 struct pack_window
*w_curs
= NULL
;
1414 const unsigned char *base_ref
= NULL
;
1415 struct object_entry
*base_entry
;
1416 unsigned long used
, used_0
;
1417 unsigned long avail
;
1419 unsigned char *buf
, c
;
1420 enum object_type type
;
1421 unsigned long in_pack_size
;
1423 buf
= use_pack(p
, &w_curs
, entry
->in_pack_offset
, &avail
);
1426 * We want in_pack_type even if we do not reuse delta
1427 * since non-delta representations could still be reused.
1429 used
= unpack_object_header_buffer(buf
, avail
,
1436 BUG("invalid type %d", type
);
1437 entry
->in_pack_type
= type
;
1440 * Determine if this is a delta and if so whether we can
1441 * reuse it or not. Otherwise let's find out as cheaply as
1442 * possible what the actual type and size for this object is.
1444 switch (entry
->in_pack_type
) {
1446 /* Not a delta hence we've already got all we need. */
1447 oe_set_type(entry
, entry
->in_pack_type
);
1448 entry
->size
= in_pack_size
;
1449 entry
->in_pack_header_size
= used
;
1450 if (oe_type(entry
) < OBJ_COMMIT
|| oe_type(entry
) > OBJ_BLOB
)
1452 unuse_pack(&w_curs
);
1455 if (reuse_delta
&& !entry
->preferred_base
)
1456 base_ref
= use_pack(p
, &w_curs
,
1457 entry
->in_pack_offset
+ used
, NULL
);
1458 entry
->in_pack_header_size
= used
+ 20;
1461 buf
= use_pack(p
, &w_curs
,
1462 entry
->in_pack_offset
+ used
, NULL
);
1468 if (!ofs
|| MSB(ofs
, 7)) {
1469 error("delta base offset overflow in pack for %s",
1470 oid_to_hex(&entry
->idx
.oid
));
1474 ofs
= (ofs
<< 7) + (c
& 127);
1476 ofs
= entry
->in_pack_offset
- ofs
;
1477 if (ofs
<= 0 || ofs
>= entry
->in_pack_offset
) {
1478 error("delta base offset out of bound for %s",
1479 oid_to_hex(&entry
->idx
.oid
));
1482 if (reuse_delta
&& !entry
->preferred_base
) {
1483 struct revindex_entry
*revidx
;
1484 revidx
= find_pack_revindex(p
, ofs
);
1487 base_ref
= nth_packed_object_sha1(p
, revidx
->nr
);
1489 entry
->in_pack_header_size
= used
+ used_0
;
1493 if (base_ref
&& (base_entry
= packlist_find(&to_pack
, base_ref
, NULL
))) {
1495 * If base_ref was set above that means we wish to
1496 * reuse delta data, and we even found that base
1497 * in the list of objects we want to pack. Goodie!
1499 * Depth value does not matter - find_deltas() will
1500 * never consider reused delta as the base object to
1501 * deltify other objects against, in order to avoid
1504 oe_set_type(entry
, entry
->in_pack_type
);
1505 entry
->size
= in_pack_size
; /* delta size */
1506 SET_DELTA(entry
, base_entry
);
1507 entry
->delta_size
= entry
->size
;
1508 entry
->delta_sibling_idx
= base_entry
->delta_child_idx
;
1509 SET_DELTA_CHILD(base_entry
, entry
);
1510 unuse_pack(&w_curs
);
1514 if (oe_type(entry
)) {
1518 * This must be a delta and we already know what the
1519 * final object type is. Let's extract the actual
1520 * object size from the delta header.
1522 delta_pos
= entry
->in_pack_offset
+ entry
->in_pack_header_size
;
1523 entry
->size
= get_size_from_delta(p
, &w_curs
, delta_pos
);
1524 if (entry
->size
== 0)
1526 unuse_pack(&w_curs
);
1531 * No choice but to fall back to the recursive delta walk
1532 * with sha1_object_info() to find about the object type
1536 unuse_pack(&w_curs
);
1539 oe_set_type(entry
, oid_object_info(&entry
->idx
.oid
, &entry
->size
));
1541 * The error condition is checked in prepare_pack(). This is
1542 * to permit a missing preferred base object to be ignored
1543 * as a preferred base. Doing so can result in a larger
1544 * pack file, but the transfer will still take place.
1548 static int pack_offset_sort(const void *_a
, const void *_b
)
1550 const struct object_entry
*a
= *(struct object_entry
**)_a
;
1551 const struct object_entry
*b
= *(struct object_entry
**)_b
;
1552 const struct packed_git
*a_in_pack
= IN_PACK(a
);
1553 const struct packed_git
*b_in_pack
= IN_PACK(b
);
1555 /* avoid filesystem trashing with loose objects */
1556 if (!a_in_pack
&& !b_in_pack
)
1557 return oidcmp(&a
->idx
.oid
, &b
->idx
.oid
);
1559 if (a_in_pack
< b_in_pack
)
1561 if (a_in_pack
> b_in_pack
)
1563 return a
->in_pack_offset
< b
->in_pack_offset ?
-1 :
1564 (a
->in_pack_offset
> b
->in_pack_offset
);
1568 * Drop an on-disk delta we were planning to reuse. Naively, this would
1569 * just involve blanking out the "delta" field, but we have to deal
1570 * with some extra book-keeping:
1572 * 1. Removing ourselves from the delta_sibling linked list.
1574 * 2. Updating our size/type to the non-delta representation. These were
1575 * either not recorded initially (size) or overwritten with the delta type
1576 * (type) when check_object() decided to reuse the delta.
1578 * 3. Resetting our delta depth, as we are now a base object.
1580 static void drop_reused_delta(struct object_entry
*entry
)
1582 unsigned *idx
= &to_pack
.objects
[entry
->delta_idx
- 1].delta_child_idx
;
1583 struct object_info oi
= OBJECT_INFO_INIT
;
1584 enum object_type type
;
1587 struct object_entry
*oe
= &to_pack
.objects
[*idx
- 1];
1590 *idx
= oe
->delta_sibling_idx
;
1592 idx
= &oe
->delta_sibling_idx
;
1594 SET_DELTA(entry
, NULL
);
1597 oi
.sizep
= &entry
->size
;
1599 if (packed_object_info(IN_PACK(entry
), entry
->in_pack_offset
, &oi
) < 0) {
1601 * We failed to get the info from this pack for some reason;
1602 * fall back to sha1_object_info, which may find another copy.
1603 * And if that fails, the error will be recorded in oe_type(entry)
1604 * and dealt with in prepare_pack().
1606 oe_set_type(entry
, oid_object_info(&entry
->idx
.oid
,
1609 oe_set_type(entry
, type
);
1614 * Follow the chain of deltas from this entry onward, throwing away any links
1615 * that cause us to hit a cycle (as determined by the DFS state flags in
1618 * We also detect too-long reused chains that would violate our --depth
1621 static void break_delta_chains(struct object_entry
*entry
)
1624 * The actual depth of each object we will write is stored as an int,
1625 * as it cannot exceed our int "depth" limit. But before we break
1626 * changes based no that limit, we may potentially go as deep as the
1627 * number of objects, which is elsewhere bounded to a uint32_t.
1629 uint32_t total_depth
;
1630 struct object_entry
*cur
, *next
;
1632 for (cur
= entry
, total_depth
= 0;
1634 cur
= DELTA(cur
), total_depth
++) {
1635 if (cur
->dfs_state
== DFS_DONE
) {
1637 * We've already seen this object and know it isn't
1638 * part of a cycle. We do need to append its depth
1641 total_depth
+= cur
->depth
;
1646 * We break cycles before looping, so an ACTIVE state (or any
1647 * other cruft which made its way into the state variable)
1650 if (cur
->dfs_state
!= DFS_NONE
)
1651 die("BUG: confusing delta dfs state in first pass: %d",
1655 * Now we know this is the first time we've seen the object. If
1656 * it's not a delta, we're done traversing, but we'll mark it
1657 * done to save time on future traversals.
1660 cur
->dfs_state
= DFS_DONE
;
1665 * Mark ourselves as active and see if the next step causes
1666 * us to cycle to another active object. It's important to do
1667 * this _before_ we loop, because it impacts where we make the
1668 * cut, and thus how our total_depth counter works.
1669 * E.g., We may see a partial loop like:
1671 * A -> B -> C -> D -> B
1673 * Cutting B->C breaks the cycle. But now the depth of A is
1674 * only 1, and our total_depth counter is at 3. The size of the
1675 * error is always one less than the size of the cycle we
1676 * broke. Commits C and D were "lost" from A's chain.
1678 * If we instead cut D->B, then the depth of A is correct at 3.
1679 * We keep all commits in the chain that we examined.
1681 cur
->dfs_state
= DFS_ACTIVE
;
1682 if (DELTA(cur
)->dfs_state
== DFS_ACTIVE
) {
1683 drop_reused_delta(cur
);
1684 cur
->dfs_state
= DFS_DONE
;
1690 * And now that we've gone all the way to the bottom of the chain, we
1691 * need to clear the active flags and set the depth fields as
1692 * appropriate. Unlike the loop above, which can quit when it drops a
1693 * delta, we need to keep going to look for more depth cuts. So we need
1694 * an extra "next" pointer to keep going after we reset cur->delta.
1696 for (cur
= entry
; cur
; cur
= next
) {
1700 * We should have a chain of zero or more ACTIVE states down to
1701 * a final DONE. We can quit after the DONE, because either it
1702 * has no bases, or we've already handled them in a previous
1705 if (cur
->dfs_state
== DFS_DONE
)
1707 else if (cur
->dfs_state
!= DFS_ACTIVE
)
1708 die("BUG: confusing delta dfs state in second pass: %d",
1712 * If the total_depth is more than depth, then we need to snip
1713 * the chain into two or more smaller chains that don't exceed
1714 * the maximum depth. Most of the resulting chains will contain
1715 * (depth + 1) entries (i.e., depth deltas plus one base), and
1716 * the last chain (i.e., the one containing entry) will contain
1717 * whatever entries are left over, namely
1718 * (total_depth % (depth + 1)) of them.
1720 * Since we are iterating towards decreasing depth, we need to
1721 * decrement total_depth as we go, and we need to write to the
1722 * entry what its final depth will be after all of the
1723 * snipping. Since we're snipping into chains of length (depth
1724 * + 1) entries, the final depth of an entry will be its
1725 * original depth modulo (depth + 1). Any time we encounter an
1726 * entry whose final depth is supposed to be zero, we snip it
1727 * from its delta base, thereby making it so.
1729 cur
->depth
= (total_depth
--) % (depth
+ 1);
1731 drop_reused_delta(cur
);
1733 cur
->dfs_state
= DFS_DONE
;
1737 static void get_object_details(void)
1740 struct object_entry
**sorted_by_offset
;
1742 sorted_by_offset
= xcalloc(to_pack
.nr_objects
, sizeof(struct object_entry
*));
1743 for (i
= 0; i
< to_pack
.nr_objects
; i
++)
1744 sorted_by_offset
[i
] = to_pack
.objects
+ i
;
1745 QSORT(sorted_by_offset
, to_pack
.nr_objects
, pack_offset_sort
);
1747 for (i
= 0; i
< to_pack
.nr_objects
; i
++) {
1748 struct object_entry
*entry
= sorted_by_offset
[i
];
1749 check_object(entry
);
1750 if (entry
->type_valid
&& big_file_threshold
< entry
->size
)
1751 entry
->no_try_delta
= 1;
1755 * This must happen in a second pass, since we rely on the delta
1756 * information for the whole list being completed.
1758 for (i
= 0; i
< to_pack
.nr_objects
; i
++)
1759 break_delta_chains(&to_pack
.objects
[i
]);
1761 free(sorted_by_offset
);
1765 * We search for deltas in a list sorted by type, by filename hash, and then
1766 * by size, so that we see progressively smaller and smaller files.
1767 * That's because we prefer deltas to be from the bigger file
1768 * to the smaller -- deletes are potentially cheaper, but perhaps
1769 * more importantly, the bigger file is likely the more recent
1770 * one. The deepest deltas are therefore the oldest objects which are
1771 * less susceptible to be accessed often.
1773 static int type_size_sort(const void *_a
, const void *_b
)
1775 const struct object_entry
*a
= *(struct object_entry
**)_a
;
1776 const struct object_entry
*b
= *(struct object_entry
**)_b
;
1777 enum object_type a_type
= oe_type(a
);
1778 enum object_type b_type
= oe_type(b
);
1780 if (a_type
> b_type
)
1782 if (a_type
< b_type
)
1784 if (a
->hash
> b
->hash
)
1786 if (a
->hash
< b
->hash
)
1788 if (a
->preferred_base
> b
->preferred_base
)
1790 if (a
->preferred_base
< b
->preferred_base
)
1792 if (a
->size
> b
->size
)
1794 if (a
->size
< b
->size
)
1796 return a
< b ?
-1 : (a
> b
); /* newest first */
1800 struct object_entry
*entry
;
1802 struct delta_index
*index
;
1806 static int delta_cacheable(unsigned long src_size
, unsigned long trg_size
,
1807 unsigned long delta_size
)
1809 if (max_delta_cache_size
&& delta_cache_size
+ delta_size
> max_delta_cache_size
)
1812 if (delta_size
< cache_max_small_delta_size
)
1815 /* cache delta, if objects are large enough compared to delta size */
1816 if ((src_size
>> 20) + (trg_size
>> 21) > (delta_size
>> 10))
1824 static pthread_mutex_t read_mutex
;
1825 #define read_lock() pthread_mutex_lock(&read_mutex)
1826 #define read_unlock() pthread_mutex_unlock(&read_mutex)
1828 static pthread_mutex_t cache_mutex
;
1829 #define cache_lock() pthread_mutex_lock(&cache_mutex)
1830 #define cache_unlock() pthread_mutex_unlock(&cache_mutex)
1832 static pthread_mutex_t progress_mutex
;
1833 #define progress_lock() pthread_mutex_lock(&progress_mutex)
1834 #define progress_unlock() pthread_mutex_unlock(&progress_mutex)
1838 #define read_lock() (void)0
1839 #define read_unlock() (void)0
1840 #define cache_lock() (void)0
1841 #define cache_unlock() (void)0
1842 #define progress_lock() (void)0
1843 #define progress_unlock() (void)0
1847 static int try_delta(struct unpacked
*trg
, struct unpacked
*src
,
1848 unsigned max_depth
, unsigned long *mem_usage
)
1850 struct object_entry
*trg_entry
= trg
->entry
;
1851 struct object_entry
*src_entry
= src
->entry
;
1852 unsigned long trg_size
, src_size
, delta_size
, sizediff
, max_size
, sz
;
1854 enum object_type type
;
1857 /* Don't bother doing diffs between different types */
1858 if (oe_type(trg_entry
) != oe_type(src_entry
))
1862 * We do not bother to try a delta that we discarded on an
1863 * earlier try, but only when reusing delta data. Note that
1864 * src_entry that is marked as the preferred_base should always
1865 * be considered, as even if we produce a suboptimal delta against
1866 * it, we will still save the transfer cost, as we already know
1867 * the other side has it and we won't send src_entry at all.
1869 if (reuse_delta
&& IN_PACK(trg_entry
) &&
1870 IN_PACK(trg_entry
) == IN_PACK(src_entry
) &&
1871 !src_entry
->preferred_base
&&
1872 trg_entry
->in_pack_type
!= OBJ_REF_DELTA
&&
1873 trg_entry
->in_pack_type
!= OBJ_OFS_DELTA
)
1876 /* Let's not bust the allowed depth. */
1877 if (src
->depth
>= max_depth
)
1880 /* Now some size filtering heuristics. */
1881 trg_size
= trg_entry
->size
;
1882 if (!DELTA(trg_entry
)) {
1883 max_size
= trg_size
/2 - 20;
1886 max_size
= trg_entry
->delta_size
;
1887 ref_depth
= trg
->depth
;
1889 max_size
= (uint64_t)max_size
* (max_depth
- src
->depth
) /
1890 (max_depth
- ref_depth
+ 1);
1893 src_size
= src_entry
->size
;
1894 sizediff
= src_size
< trg_size ? trg_size
- src_size
: 0;
1895 if (sizediff
>= max_size
)
1897 if (trg_size
< src_size
/ 32)
1900 /* Load data if not already done */
1903 trg
->data
= read_object_file(&trg_entry
->idx
.oid
, &type
, &sz
);
1906 die("object %s cannot be read",
1907 oid_to_hex(&trg_entry
->idx
.oid
));
1909 die("object %s inconsistent object length (%lu vs %lu)",
1910 oid_to_hex(&trg_entry
->idx
.oid
), sz
,
1916 src
->data
= read_object_file(&src_entry
->idx
.oid
, &type
, &sz
);
1919 if (src_entry
->preferred_base
) {
1920 static int warned
= 0;
1922 warning("object %s cannot be read",
1923 oid_to_hex(&src_entry
->idx
.oid
));
1925 * Those objects are not included in the
1926 * resulting pack. Be resilient and ignore
1927 * them if they can't be read, in case the
1928 * pack could be created nevertheless.
1932 die("object %s cannot be read",
1933 oid_to_hex(&src_entry
->idx
.oid
));
1936 die("object %s inconsistent object length (%lu vs %lu)",
1937 oid_to_hex(&src_entry
->idx
.oid
), sz
,
1942 src
->index
= create_delta_index(src
->data
, src_size
);
1944 static int warned
= 0;
1946 warning("suboptimal pack - out of memory");
1949 *mem_usage
+= sizeof_delta_index(src
->index
);
1952 delta_buf
= create_delta(src
->index
, trg
->data
, trg_size
, &delta_size
, max_size
);
1956 if (DELTA(trg_entry
)) {
1957 /* Prefer only shallower same-sized deltas. */
1958 if (delta_size
== trg_entry
->delta_size
&&
1959 src
->depth
+ 1 >= trg
->depth
) {
1966 * Handle memory allocation outside of the cache
1967 * accounting lock. Compiler will optimize the strangeness
1968 * away when NO_PTHREADS is defined.
1970 free(trg_entry
->delta_data
);
1972 if (trg_entry
->delta_data
) {
1973 delta_cache_size
-= trg_entry
->delta_size
;
1974 trg_entry
->delta_data
= NULL
;
1976 if (delta_cacheable(src_size
, trg_size
, delta_size
)) {
1977 delta_cache_size
+= delta_size
;
1979 trg_entry
->delta_data
= xrealloc(delta_buf
, delta_size
);
1985 SET_DELTA(trg_entry
, src_entry
);
1986 trg_entry
->delta_size
= delta_size
;
1987 trg
->depth
= src
->depth
+ 1;
1992 static unsigned int check_delta_limit(struct object_entry
*me
, unsigned int n
)
1994 struct object_entry
*child
= DELTA_CHILD(me
);
1997 unsigned int c
= check_delta_limit(child
, n
+ 1);
2000 child
= DELTA_SIBLING(child
);
2005 static unsigned long free_unpacked(struct unpacked
*n
)
2007 unsigned long freed_mem
= sizeof_delta_index(n
->index
);
2008 free_delta_index(n
->index
);
2011 freed_mem
+= n
->entry
->size
;
2012 FREE_AND_NULL(n
->data
);
2019 static void find_deltas(struct object_entry
**list
, unsigned *list_size
,
2020 int window
, int depth
, unsigned *processed
)
2022 uint32_t i
, idx
= 0, count
= 0;
2023 struct unpacked
*array
;
2024 unsigned long mem_usage
= 0;
2026 array
= xcalloc(window
, sizeof(struct unpacked
));
2029 struct object_entry
*entry
;
2030 struct unpacked
*n
= array
+ idx
;
2031 int j
, max_depth
, best_base
= -1;
2040 if (!entry
->preferred_base
) {
2042 display_progress(progress_state
, *processed
);
2046 mem_usage
-= free_unpacked(n
);
2049 while (window_memory_limit
&&
2050 mem_usage
> window_memory_limit
&&
2052 uint32_t tail
= (idx
+ window
- count
) % window
;
2053 mem_usage
-= free_unpacked(array
+ tail
);
2057 /* We do not compute delta to *create* objects we are not
2060 if (entry
->preferred_base
)
2064 * If the current object is at pack edge, take the depth the
2065 * objects that depend on the current object into account
2066 * otherwise they would become too deep.
2069 if (DELTA_CHILD(entry
)) {
2070 max_depth
-= check_delta_limit(entry
, 0);
2078 uint32_t other_idx
= idx
+ j
;
2080 if (other_idx
>= window
)
2081 other_idx
-= window
;
2082 m
= array
+ other_idx
;
2085 ret
= try_delta(n
, m
, max_depth
, &mem_usage
);
2089 best_base
= other_idx
;
2093 * If we decided to cache the delta data, then it is best
2094 * to compress it right away. First because we have to do
2095 * it anyway, and doing it here while we're threaded will
2096 * save a lot of time in the non threaded write phase,
2097 * as well as allow for caching more deltas within
2098 * the same cache size limit.
2100 * But only if not writing to stdout, since in that case
2101 * the network is most likely throttling writes anyway,
2102 * and therefore it is best to go to the write phase ASAP
2103 * instead, as we can afford spending more time compressing
2104 * between writes at that moment.
2106 if (entry
->delta_data
&& !pack_to_stdout
) {
2109 size
= do_compress(&entry
->delta_data
, entry
->delta_size
);
2110 if (size
< (1U << OE_Z_DELTA_BITS
)) {
2111 entry
->z_delta_size
= size
;
2113 delta_cache_size
-= entry
->delta_size
;
2114 delta_cache_size
+= entry
->z_delta_size
;
2117 FREE_AND_NULL(entry
->delta_data
);
2118 entry
->z_delta_size
= 0;
2122 /* if we made n a delta, and if n is already at max
2123 * depth, leaving it in the window is pointless. we
2124 * should evict it first.
2126 if (DELTA(entry
) && max_depth
<= n
->depth
)
2130 * Move the best delta base up in the window, after the
2131 * currently deltified object, to keep it longer. It will
2132 * be the first base object to be attempted next.
2135 struct unpacked swap
= array
[best_base
];
2136 int dist
= (window
+ idx
- best_base
) % window
;
2137 int dst
= best_base
;
2139 int src
= (dst
+ 1) % window
;
2140 array
[dst
] = array
[src
];
2148 if (count
+ 1 < window
)
2154 for (i
= 0; i
< window
; ++i
) {
2155 free_delta_index(array
[i
].index
);
2156 free(array
[i
].data
);
2163 static void try_to_free_from_threads(size_t size
)
2166 release_pack_memory(size
);
2170 static try_to_free_t old_try_to_free_routine
;
2173 * The main thread waits on the condition that (at least) one of the workers
2174 * has stopped working (which is indicated in the .working member of
2175 * struct thread_params).
2176 * When a work thread has completed its work, it sets .working to 0 and
2177 * signals the main thread and waits on the condition that .data_ready
2181 struct thread_params
{
2183 struct object_entry
**list
;
2190 pthread_mutex_t mutex
;
2191 pthread_cond_t cond
;
2192 unsigned *processed
;
2195 static pthread_cond_t progress_cond
;
2198 * Mutex and conditional variable can't be statically-initialized on Windows.
2200 static void init_threaded_search(void)
2202 init_recursive_mutex(&read_mutex
);
2203 pthread_mutex_init(&cache_mutex
, NULL
);
2204 pthread_mutex_init(&progress_mutex
, NULL
);
2205 pthread_cond_init(&progress_cond
, NULL
);
2206 old_try_to_free_routine
= set_try_to_free_routine(try_to_free_from_threads
);
2209 static void cleanup_threaded_search(void)
2211 set_try_to_free_routine(old_try_to_free_routine
);
2212 pthread_cond_destroy(&progress_cond
);
2213 pthread_mutex_destroy(&read_mutex
);
2214 pthread_mutex_destroy(&cache_mutex
);
2215 pthread_mutex_destroy(&progress_mutex
);
2218 static void *threaded_find_deltas(void *arg
)
2220 struct thread_params
*me
= arg
;
2223 while (me
->remaining
) {
2226 find_deltas(me
->list
, &me
->remaining
,
2227 me
->window
, me
->depth
, me
->processed
);
2231 pthread_cond_signal(&progress_cond
);
2235 * We must not set ->data_ready before we wait on the
2236 * condition because the main thread may have set it to 1
2237 * before we get here. In order to be sure that new
2238 * work is available if we see 1 in ->data_ready, it
2239 * was initialized to 0 before this thread was spawned
2240 * and we reset it to 0 right away.
2242 pthread_mutex_lock(&me
->mutex
);
2243 while (!me
->data_ready
)
2244 pthread_cond_wait(&me
->cond
, &me
->mutex
);
2246 pthread_mutex_unlock(&me
->mutex
);
2251 /* leave ->working 1 so that this doesn't get more work assigned */
2255 static void ll_find_deltas(struct object_entry
**list
, unsigned list_size
,
2256 int window
, int depth
, unsigned *processed
)
2258 struct thread_params
*p
;
2259 int i
, ret
, active_threads
= 0;
2261 init_threaded_search();
2263 if (delta_search_threads
<= 1) {
2264 find_deltas(list
, &list_size
, window
, depth
, processed
);
2265 cleanup_threaded_search();
2268 if (progress
> pack_to_stdout
)
2269 fprintf(stderr
, "Delta compression using up to %d threads.\n",
2270 delta_search_threads
);
2271 p
= xcalloc(delta_search_threads
, sizeof(*p
));
2273 /* Partition the work amongst work threads. */
2274 for (i
= 0; i
< delta_search_threads
; i
++) {
2275 unsigned sub_size
= list_size
/ (delta_search_threads
- i
);
2277 /* don't use too small segments or no deltas will be found */
2278 if (sub_size
< 2*window
&& i
+1 < delta_search_threads
)
2281 p
[i
].window
= window
;
2283 p
[i
].processed
= processed
;
2285 p
[i
].data_ready
= 0;
2287 /* try to split chunks on "path" boundaries */
2288 while (sub_size
&& sub_size
< list_size
&&
2289 list
[sub_size
]->hash
&&
2290 list
[sub_size
]->hash
== list
[sub_size
-1]->hash
)
2294 p
[i
].list_size
= sub_size
;
2295 p
[i
].remaining
= sub_size
;
2298 list_size
-= sub_size
;
2301 /* Start work threads. */
2302 for (i
= 0; i
< delta_search_threads
; i
++) {
2303 if (!p
[i
].list_size
)
2305 pthread_mutex_init(&p
[i
].mutex
, NULL
);
2306 pthread_cond_init(&p
[i
].cond
, NULL
);
2307 ret
= pthread_create(&p
[i
].thread
, NULL
,
2308 threaded_find_deltas
, &p
[i
]);
2310 die("unable to create thread: %s", strerror(ret
));
2315 * Now let's wait for work completion. Each time a thread is done
2316 * with its work, we steal half of the remaining work from the
2317 * thread with the largest number of unprocessed objects and give
2318 * it to that newly idle thread. This ensure good load balancing
2319 * until the remaining object list segments are simply too short
2320 * to be worth splitting anymore.
2322 while (active_threads
) {
2323 struct thread_params
*target
= NULL
;
2324 struct thread_params
*victim
= NULL
;
2325 unsigned sub_size
= 0;
2329 for (i
= 0; !target
&& i
< delta_search_threads
; i
++)
2334 pthread_cond_wait(&progress_cond
, &progress_mutex
);
2337 for (i
= 0; i
< delta_search_threads
; i
++)
2338 if (p
[i
].remaining
> 2*window
&&
2339 (!victim
|| victim
->remaining
< p
[i
].remaining
))
2342 sub_size
= victim
->remaining
/ 2;
2343 list
= victim
->list
+ victim
->list_size
- sub_size
;
2344 while (sub_size
&& list
[0]->hash
&&
2345 list
[0]->hash
== list
[-1]->hash
) {
2351 * It is possible for some "paths" to have
2352 * so many objects that no hash boundary
2353 * might be found. Let's just steal the
2354 * exact half in that case.
2356 sub_size
= victim
->remaining
/ 2;
2359 target
->list
= list
;
2360 victim
->list_size
-= sub_size
;
2361 victim
->remaining
-= sub_size
;
2363 target
->list_size
= sub_size
;
2364 target
->remaining
= sub_size
;
2365 target
->working
= 1;
2368 pthread_mutex_lock(&target
->mutex
);
2369 target
->data_ready
= 1;
2370 pthread_cond_signal(&target
->cond
);
2371 pthread_mutex_unlock(&target
->mutex
);
2374 pthread_join(target
->thread
, NULL
);
2375 pthread_cond_destroy(&target
->cond
);
2376 pthread_mutex_destroy(&target
->mutex
);
2380 cleanup_threaded_search();
2385 #define ll_find_deltas(l, s, w, d, p) find_deltas(l, &s, w, d, p)
2388 static void add_tag_chain(const struct object_id
*oid
)
2393 * We catch duplicates already in add_object_entry(), but we'd
2394 * prefer to do this extra check to avoid having to parse the
2395 * tag at all if we already know that it's being packed (e.g., if
2396 * it was included via bitmaps, we would not have parsed it
2399 if (packlist_find(&to_pack
, oid
->hash
, NULL
))
2402 tag
= lookup_tag(oid
);
2404 if (!tag
|| parse_tag(tag
) || !tag
->tagged
)
2405 die("unable to pack objects reachable from tag %s",
2408 add_object_entry(&tag
->object
.oid
, OBJ_TAG
, NULL
, 0);
2410 if (tag
->tagged
->type
!= OBJ_TAG
)
2413 tag
= (struct tag
*)tag
->tagged
;
2417 static int add_ref_tag(const char *path
, const struct object_id
*oid
, int flag
, void *cb_data
)
2419 struct object_id peeled
;
2421 if (starts_with(path
, "refs/tags/") && /* is a tag? */
2422 !peel_ref(path
, &peeled
) && /* peelable? */
2423 packlist_find(&to_pack
, peeled
.hash
, NULL
)) /* object packed? */
2428 static void prepare_pack(int window
, int depth
)
2430 struct object_entry
**delta_list
;
2431 uint32_t i
, nr_deltas
;
2434 get_object_details();
2437 * If we're locally repacking then we need to be doubly careful
2438 * from now on in order to make sure no stealth corruption gets
2439 * propagated to the new pack. Clients receiving streamed packs
2440 * should validate everything they get anyway so no need to incur
2441 * the additional cost here in that case.
2443 if (!pack_to_stdout
)
2444 do_check_packed_object_crc
= 1;
2446 if (!to_pack
.nr_objects
|| !window
|| !depth
)
2449 ALLOC_ARRAY(delta_list
, to_pack
.nr_objects
);
2452 for (i
= 0; i
< to_pack
.nr_objects
; i
++) {
2453 struct object_entry
*entry
= to_pack
.objects
+ i
;
2456 /* This happens if we decided to reuse existing
2457 * delta from a pack. "reuse_delta &&" is implied.
2461 if (!entry
->type_valid
|| entry
->size
< 50)
2464 if (entry
->no_try_delta
)
2467 if (!entry
->preferred_base
) {
2469 if (oe_type(entry
) < 0)
2470 die("unable to get type of object %s",
2471 oid_to_hex(&entry
->idx
.oid
));
2473 if (oe_type(entry
) < 0) {
2475 * This object is not found, but we
2476 * don't have to include it anyway.
2482 delta_list
[n
++] = entry
;
2485 if (nr_deltas
&& n
> 1) {
2486 unsigned nr_done
= 0;
2488 progress_state
= start_progress(_("Compressing objects"),
2490 QSORT(delta_list
, n
, type_size_sort
);
2491 ll_find_deltas(delta_list
, n
, window
+1, depth
, &nr_done
);
2492 stop_progress(&progress_state
);
2493 if (nr_done
!= nr_deltas
)
2494 die("inconsistency with delta count");
2499 static int git_pack_config(const char *k
, const char *v
, void *cb
)
2501 if (!strcmp(k
, "pack.window")) {
2502 window
= git_config_int(k
, v
);
2505 if (!strcmp(k
, "pack.windowmemory")) {
2506 window_memory_limit
= git_config_ulong(k
, v
);
2509 if (!strcmp(k
, "pack.depth")) {
2510 depth
= git_config_int(k
, v
);
2513 if (!strcmp(k
, "pack.deltacachesize")) {
2514 max_delta_cache_size
= git_config_int(k
, v
);
2517 if (!strcmp(k
, "pack.deltacachelimit")) {
2518 cache_max_small_delta_size
= git_config_int(k
, v
);
2521 if (!strcmp(k
, "pack.writebitmaphashcache")) {
2522 if (git_config_bool(k
, v
))
2523 write_bitmap_options
|= BITMAP_OPT_HASH_CACHE
;
2525 write_bitmap_options
&= ~BITMAP_OPT_HASH_CACHE
;
2527 if (!strcmp(k
, "pack.usebitmaps")) {
2528 use_bitmap_index_default
= git_config_bool(k
, v
);
2531 if (!strcmp(k
, "pack.threads")) {
2532 delta_search_threads
= git_config_int(k
, v
);
2533 if (delta_search_threads
< 0)
2534 die("invalid number of threads specified (%d)",
2535 delta_search_threads
);
2537 if (delta_search_threads
!= 1) {
2538 warning("no threads support, ignoring %s", k
);
2539 delta_search_threads
= 0;
2544 if (!strcmp(k
, "pack.indexversion")) {
2545 pack_idx_opts
.version
= git_config_int(k
, v
);
2546 if (pack_idx_opts
.version
> 2)
2547 die("bad pack.indexversion=%"PRIu32
,
2548 pack_idx_opts
.version
);
2551 return git_default_config(k
, v
, cb
);
2554 static void read_object_list_from_stdin(void)
2556 char line
[GIT_MAX_HEXSZ
+ 1 + PATH_MAX
+ 2];
2557 struct object_id oid
;
2561 if (!fgets(line
, sizeof(line
), stdin
)) {
2565 die("fgets returned NULL, not EOF, not error!");
2571 if (line
[0] == '-') {
2572 if (get_oid_hex(line
+1, &oid
))
2573 die("expected edge object ID, got garbage:\n %s",
2575 add_preferred_base(&oid
);
2578 if (parse_oid_hex(line
, &oid
, &p
))
2579 die("expected object ID, got garbage:\n %s", line
);
2581 add_preferred_base_object(p
+ 1);
2582 add_object_entry(&oid
, OBJ_NONE
, p
+ 1, 0);
2586 /* Remember to update object flag allocation in object.h */
2587 #define OBJECT_ADDED (1u<<20)
2589 static void show_commit(struct commit
*commit
, void *data
)
2591 add_object_entry(&commit
->object
.oid
, OBJ_COMMIT
, NULL
, 0);
2592 commit
->object
.flags
|= OBJECT_ADDED
;
2594 if (write_bitmap_index
)
2595 index_commit_for_bitmap(commit
);
2598 static void show_object(struct object
*obj
, const char *name
, void *data
)
2600 add_preferred_base_object(name
);
2601 add_object_entry(&obj
->oid
, obj
->type
, name
, 0);
2602 obj
->flags
|= OBJECT_ADDED
;
2605 static void show_object__ma_allow_any(struct object
*obj
, const char *name
, void *data
)
2607 assert(arg_missing_action
== MA_ALLOW_ANY
);
2610 * Quietly ignore ALL missing objects. This avoids problems with
2611 * staging them now and getting an odd error later.
2613 if (!has_object_file(&obj
->oid
))
2616 show_object(obj
, name
, data
);
2619 static void show_object__ma_allow_promisor(struct object
*obj
, const char *name
, void *data
)
2621 assert(arg_missing_action
== MA_ALLOW_PROMISOR
);
2624 * Quietly ignore EXPECTED missing objects. This avoids problems with
2625 * staging them now and getting an odd error later.
2627 if (!has_object_file(&obj
->oid
) && is_promisor_object(&obj
->oid
))
2630 show_object(obj
, name
, data
);
2633 static int option_parse_missing_action(const struct option
*opt
,
2634 const char *arg
, int unset
)
2639 if (!strcmp(arg
, "error")) {
2640 arg_missing_action
= MA_ERROR
;
2641 fn_show_object
= show_object
;
2645 if (!strcmp(arg
, "allow-any")) {
2646 arg_missing_action
= MA_ALLOW_ANY
;
2647 fetch_if_missing
= 0;
2648 fn_show_object
= show_object__ma_allow_any
;
2652 if (!strcmp(arg
, "allow-promisor")) {
2653 arg_missing_action
= MA_ALLOW_PROMISOR
;
2654 fetch_if_missing
= 0;
2655 fn_show_object
= show_object__ma_allow_promisor
;
2659 die(_("invalid value for --missing"));
2663 static void show_edge(struct commit
*commit
)
2665 add_preferred_base(&commit
->object
.oid
);
2668 struct in_pack_object
{
2670 struct object
*object
;
2676 struct in_pack_object
*array
;
2679 static void mark_in_pack_object(struct object
*object
, struct packed_git
*p
, struct in_pack
*in_pack
)
2681 in_pack
->array
[in_pack
->nr
].offset
= find_pack_entry_one(object
->oid
.hash
, p
);
2682 in_pack
->array
[in_pack
->nr
].object
= object
;
2687 * Compare the objects in the offset order, in order to emulate the
2688 * "git rev-list --objects" output that produced the pack originally.
2690 static int ofscmp(const void *a_
, const void *b_
)
2692 struct in_pack_object
*a
= (struct in_pack_object
*)a_
;
2693 struct in_pack_object
*b
= (struct in_pack_object
*)b_
;
2695 if (a
->offset
< b
->offset
)
2697 else if (a
->offset
> b
->offset
)
2700 return oidcmp(&a
->object
->oid
, &b
->object
->oid
);
2703 static void add_objects_in_unpacked_packs(struct rev_info
*revs
)
2705 struct packed_git
*p
;
2706 struct in_pack in_pack
;
2709 memset(&in_pack
, 0, sizeof(in_pack
));
2711 for (p
= get_packed_git(the_repository
); p
; p
= p
->next
) {
2712 struct object_id oid
;
2715 if (!p
->pack_local
|| p
->pack_keep
)
2717 if (open_pack_index(p
))
2718 die("cannot open pack index");
2720 ALLOC_GROW(in_pack
.array
,
2721 in_pack
.nr
+ p
->num_objects
,
2724 for (i
= 0; i
< p
->num_objects
; i
++) {
2725 nth_packed_object_oid(&oid
, p
, i
);
2726 o
= lookup_unknown_object(oid
.hash
);
2727 if (!(o
->flags
& OBJECT_ADDED
))
2728 mark_in_pack_object(o
, p
, &in_pack
);
2729 o
->flags
|= OBJECT_ADDED
;
2734 QSORT(in_pack
.array
, in_pack
.nr
, ofscmp
);
2735 for (i
= 0; i
< in_pack
.nr
; i
++) {
2736 struct object
*o
= in_pack
.array
[i
].object
;
2737 add_object_entry(&o
->oid
, o
->type
, "", 0);
2740 free(in_pack
.array
);
2743 static int add_loose_object(const struct object_id
*oid
, const char *path
,
2746 enum object_type type
= oid_object_info(oid
, NULL
);
2749 warning("loose object at %s could not be examined", path
);
2753 add_object_entry(oid
, type
, "", 0);
2758 * We actually don't even have to worry about reachability here.
2759 * add_object_entry will weed out duplicates, so we just add every
2760 * loose object we find.
2762 static void add_unreachable_loose_objects(void)
2764 for_each_loose_file_in_objdir(get_object_directory(),
2769 static int has_sha1_pack_kept_or_nonlocal(const struct object_id
*oid
)
2771 static struct packed_git
*last_found
= (void *)1;
2772 struct packed_git
*p
;
2774 p
= (last_found
!= (void *)1) ? last_found
:
2775 get_packed_git(the_repository
);
2778 if ((!p
->pack_local
|| p
->pack_keep
) &&
2779 find_pack_entry_one(oid
->hash
, p
)) {
2783 if (p
== last_found
)
2784 p
= get_packed_git(the_repository
);
2787 if (p
== last_found
)
2794 * Store a list of sha1s that are should not be discarded
2795 * because they are either written too recently, or are
2796 * reachable from another object that was.
2798 * This is filled by get_object_list.
2800 static struct oid_array recent_objects
;
2802 static int loosened_object_can_be_discarded(const struct object_id
*oid
,
2805 if (!unpack_unreachable_expiration
)
2807 if (mtime
> unpack_unreachable_expiration
)
2809 if (oid_array_lookup(&recent_objects
, oid
) >= 0)
2814 static void loosen_unused_packed_objects(struct rev_info
*revs
)
2816 struct packed_git
*p
;
2818 struct object_id oid
;
2820 for (p
= get_packed_git(the_repository
); p
; p
= p
->next
) {
2821 if (!p
->pack_local
|| p
->pack_keep
)
2824 if (open_pack_index(p
))
2825 die("cannot open pack index");
2827 for (i
= 0; i
< p
->num_objects
; i
++) {
2828 nth_packed_object_oid(&oid
, p
, i
);
2829 if (!packlist_find(&to_pack
, oid
.hash
, NULL
) &&
2830 !has_sha1_pack_kept_or_nonlocal(&oid
) &&
2831 !loosened_object_can_be_discarded(&oid
, p
->mtime
))
2832 if (force_object_loose(&oid
, p
->mtime
))
2833 die("unable to force loose object");
2839 * This tracks any options which pack-reuse code expects to be on, or which a
2840 * reader of the pack might not understand, and which would therefore prevent
2841 * blind reuse of what we have on disk.
2843 static int pack_options_allow_reuse(void)
2845 return pack_to_stdout
&&
2847 !ignore_packed_keep
&&
2848 (!local
|| !have_non_local_packs
) &&
2852 static int get_object_list_from_bitmap(struct rev_info
*revs
)
2854 if (prepare_bitmap_walk(revs
) < 0)
2857 if (pack_options_allow_reuse() &&
2858 !reuse_partial_packfile_from_bitmap(
2860 &reuse_packfile_objects
,
2861 &reuse_packfile_offset
)) {
2862 assert(reuse_packfile_objects
);
2863 nr_result
+= reuse_packfile_objects
;
2864 display_progress(progress_state
, nr_result
);
2867 traverse_bitmap_commit_list(&add_object_entry_from_bitmap
);
2871 static void record_recent_object(struct object
*obj
,
2875 oid_array_append(&recent_objects
, &obj
->oid
);
2878 static void record_recent_commit(struct commit
*commit
, void *data
)
2880 oid_array_append(&recent_objects
, &commit
->object
.oid
);
2883 static void get_object_list(int ac
, const char **av
)
2885 struct rev_info revs
;
2889 init_revisions(&revs
, NULL
);
2890 save_commit_buffer
= 0;
2891 setup_revisions(ac
, av
, &revs
, NULL
);
2893 /* make sure shallows are read */
2894 is_repository_shallow();
2896 while (fgets(line
, sizeof(line
), stdin
) != NULL
) {
2897 int len
= strlen(line
);
2898 if (len
&& line
[len
- 1] == '\n')
2903 if (!strcmp(line
, "--not")) {
2904 flags
^= UNINTERESTING
;
2905 write_bitmap_index
= 0;
2908 if (starts_with(line
, "--shallow ")) {
2909 struct object_id oid
;
2910 if (get_oid_hex(line
+ 10, &oid
))
2911 die("not an SHA-1 '%s'", line
+ 10);
2912 register_shallow(&oid
);
2913 use_bitmap_index
= 0;
2916 die("not a rev '%s'", line
);
2918 if (handle_revision_arg(line
, &revs
, flags
, REVARG_CANNOT_BE_FILENAME
))
2919 die("bad revision '%s'", line
);
2922 if (use_bitmap_index
&& !get_object_list_from_bitmap(&revs
))
2925 if (prepare_revision_walk(&revs
))
2926 die("revision walk setup failed");
2927 mark_edges_uninteresting(&revs
, show_edge
);
2929 if (!fn_show_object
)
2930 fn_show_object
= show_object
;
2931 traverse_commit_list_filtered(&filter_options
, &revs
,
2932 show_commit
, fn_show_object
, NULL
,
2935 if (unpack_unreachable_expiration
) {
2936 revs
.ignore_missing_links
= 1;
2937 if (add_unseen_recent_objects_to_traversal(&revs
,
2938 unpack_unreachable_expiration
))
2939 die("unable to add recent objects");
2940 if (prepare_revision_walk(&revs
))
2941 die("revision walk setup failed");
2942 traverse_commit_list(&revs
, record_recent_commit
,
2943 record_recent_object
, NULL
);
2946 if (keep_unreachable
)
2947 add_objects_in_unpacked_packs(&revs
);
2948 if (pack_loose_unreachable
)
2949 add_unreachable_loose_objects();
2950 if (unpack_unreachable
)
2951 loosen_unused_packed_objects(&revs
);
2953 oid_array_clear(&recent_objects
);
2956 static int option_parse_index_version(const struct option
*opt
,
2957 const char *arg
, int unset
)
2960 const char *val
= arg
;
2961 pack_idx_opts
.version
= strtoul(val
, &c
, 10);
2962 if (pack_idx_opts
.version
> 2)
2963 die(_("unsupported index version %s"), val
);
2964 if (*c
== ',' && c
[1])
2965 pack_idx_opts
.off32_limit
= strtoul(c
+1, &c
, 0);
2966 if (*c
|| pack_idx_opts
.off32_limit
& 0x80000000)
2967 die(_("bad index version '%s'"), val
);
2971 static int option_parse_unpack_unreachable(const struct option
*opt
,
2972 const char *arg
, int unset
)
2975 unpack_unreachable
= 0;
2976 unpack_unreachable_expiration
= 0;
2979 unpack_unreachable
= 1;
2981 unpack_unreachable_expiration
= approxidate(arg
);
2986 int cmd_pack_objects(int argc
, const char **argv
, const char *prefix
)
2988 int use_internal_rev_list
= 0;
2991 int all_progress_implied
= 0;
2992 struct argv_array rp
= ARGV_ARRAY_INIT
;
2993 int rev_list_unpacked
= 0, rev_list_all
= 0, rev_list_reflog
= 0;
2994 int rev_list_index
= 0;
2995 struct option pack_objects_options
[] = {
2996 OPT_SET_INT('q', "quiet", &progress
,
2997 N_("do not show progress meter"), 0),
2998 OPT_SET_INT(0, "progress", &progress
,
2999 N_("show progress meter"), 1),
3000 OPT_SET_INT(0, "all-progress", &progress
,
3001 N_("show progress meter during object writing phase"), 2),
3002 OPT_BOOL(0, "all-progress-implied",
3003 &all_progress_implied
,
3004 N_("similar to --all-progress when progress meter is shown")),
3005 { OPTION_CALLBACK
, 0, "index-version", NULL
, N_("version[,offset]"),
3006 N_("write the pack index file in the specified idx format version"),
3007 0, option_parse_index_version
},
3008 OPT_MAGNITUDE(0, "max-pack-size", &pack_size_limit
,
3009 N_("maximum size of each output pack file")),
3010 OPT_BOOL(0, "local", &local
,
3011 N_("ignore borrowed objects from alternate object store")),
3012 OPT_BOOL(0, "incremental", &incremental
,
3013 N_("ignore packed objects")),
3014 OPT_INTEGER(0, "window", &window
,
3015 N_("limit pack window by objects")),
3016 OPT_MAGNITUDE(0, "window-memory", &window_memory_limit
,
3017 N_("limit pack window by memory in addition to object limit")),
3018 OPT_INTEGER(0, "depth", &depth
,
3019 N_("maximum length of delta chain allowed in the resulting pack")),
3020 OPT_BOOL(0, "reuse-delta", &reuse_delta
,
3021 N_("reuse existing deltas")),
3022 OPT_BOOL(0, "reuse-object", &reuse_object
,
3023 N_("reuse existing objects")),
3024 OPT_BOOL(0, "delta-base-offset", &allow_ofs_delta
,
3025 N_("use OFS_DELTA objects")),
3026 OPT_INTEGER(0, "threads", &delta_search_threads
,
3027 N_("use threads when searching for best delta matches")),
3028 OPT_BOOL(0, "non-empty", &non_empty
,
3029 N_("do not create an empty pack output")),
3030 OPT_BOOL(0, "revs", &use_internal_rev_list
,
3031 N_("read revision arguments from standard input")),
3032 { OPTION_SET_INT
, 0, "unpacked", &rev_list_unpacked
, NULL
,
3033 N_("limit the objects to those that are not yet packed"),
3034 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1 },
3035 { OPTION_SET_INT
, 0, "all", &rev_list_all
, NULL
,
3036 N_("include objects reachable from any reference"),
3037 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1 },
3038 { OPTION_SET_INT
, 0, "reflog", &rev_list_reflog
, NULL
,
3039 N_("include objects referred by reflog entries"),
3040 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1 },
3041 { OPTION_SET_INT
, 0, "indexed-objects", &rev_list_index
, NULL
,
3042 N_("include objects referred to by the index"),
3043 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1 },
3044 OPT_BOOL(0, "stdout", &pack_to_stdout
,
3045 N_("output pack to stdout")),
3046 OPT_BOOL(0, "include-tag", &include_tag
,
3047 N_("include tag objects that refer to objects to be packed")),
3048 OPT_BOOL(0, "keep-unreachable", &keep_unreachable
,
3049 N_("keep unreachable objects")),
3050 OPT_BOOL(0, "pack-loose-unreachable", &pack_loose_unreachable
,
3051 N_("pack loose unreachable objects")),
3052 { OPTION_CALLBACK
, 0, "unpack-unreachable", NULL
, N_("time"),
3053 N_("unpack unreachable objects newer than <time>"),
3054 PARSE_OPT_OPTARG
, option_parse_unpack_unreachable
},
3055 OPT_BOOL(0, "thin", &thin
,
3056 N_("create thin packs")),
3057 OPT_BOOL(0, "shallow", &shallow
,
3058 N_("create packs suitable for shallow fetches")),
3059 OPT_BOOL(0, "honor-pack-keep", &ignore_packed_keep
,
3060 N_("ignore packs that have companion .keep file")),
3061 OPT_INTEGER(0, "compression", &pack_compression_level
,
3062 N_("pack compression level")),
3063 OPT_SET_INT(0, "keep-true-parents", &grafts_replace_parents
,
3064 N_("do not hide commits by grafts"), 0),
3065 OPT_BOOL(0, "use-bitmap-index", &use_bitmap_index
,
3066 N_("use a bitmap index if available to speed up counting objects")),
3067 OPT_BOOL(0, "write-bitmap-index", &write_bitmap_index
,
3068 N_("write a bitmap index together with the pack index")),
3069 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
3070 { OPTION_CALLBACK
, 0, "missing", NULL
, N_("action"),
3071 N_("handling for missing objects"), PARSE_OPT_NONEG
,
3072 option_parse_missing_action
},
3073 OPT_BOOL(0, "exclude-promisor-objects", &exclude_promisor_objects
,
3074 N_("do not pack objects in promisor packfiles")),
3078 if (DFS_NUM_STATES
> (1 << OE_DFS_STATE_BITS
))
3079 BUG("too many dfs states, increase OE_DFS_STATE_BITS");
3081 check_replace_refs
= 0;
3083 reset_pack_idx_option(&pack_idx_opts
);
3084 git_config(git_pack_config
, NULL
);
3086 progress
= isatty(2);
3087 argc
= parse_options(argc
, argv
, prefix
, pack_objects_options
,
3091 base_name
= argv
[0];
3094 if (pack_to_stdout
!= !base_name
|| argc
)
3095 usage_with_options(pack_usage
, pack_objects_options
);
3097 if (depth
>= (1 << OE_DEPTH_BITS
)) {
3098 warning(_("delta chain depth %d is too deep, forcing %d"),
3099 depth
, (1 << OE_DEPTH_BITS
) - 1);
3100 depth
= (1 << OE_DEPTH_BITS
) - 1;
3102 if (cache_max_small_delta_size
>= (1U << OE_Z_DELTA_BITS
)) {
3103 warning(_("pack.deltaCacheLimit is too high, forcing %d"),
3104 (1U << OE_Z_DELTA_BITS
) - 1);
3105 cache_max_small_delta_size
= (1U << OE_Z_DELTA_BITS
) - 1;
3108 argv_array_push(&rp
, "pack-objects");
3110 use_internal_rev_list
= 1;
3111 argv_array_push(&rp
, shallow
3112 ?
"--objects-edge-aggressive"
3113 : "--objects-edge");
3115 argv_array_push(&rp
, "--objects");
3118 use_internal_rev_list
= 1;
3119 argv_array_push(&rp
, "--all");
3121 if (rev_list_reflog
) {
3122 use_internal_rev_list
= 1;
3123 argv_array_push(&rp
, "--reflog");
3125 if (rev_list_index
) {
3126 use_internal_rev_list
= 1;
3127 argv_array_push(&rp
, "--indexed-objects");
3129 if (rev_list_unpacked
) {
3130 use_internal_rev_list
= 1;
3131 argv_array_push(&rp
, "--unpacked");
3134 if (exclude_promisor_objects
) {
3135 use_internal_rev_list
= 1;
3136 fetch_if_missing
= 0;
3137 argv_array_push(&rp
, "--exclude-promisor-objects");
3142 if (pack_compression_level
== -1)
3143 pack_compression_level
= Z_DEFAULT_COMPRESSION
;
3144 else if (pack_compression_level
< 0 || pack_compression_level
> Z_BEST_COMPRESSION
)
3145 die("bad pack compression level %d", pack_compression_level
);
3147 if (!delta_search_threads
) /* --threads=0 means autodetect */
3148 delta_search_threads
= online_cpus();
3151 if (delta_search_threads
!= 1)
3152 warning("no threads support, ignoring --threads");
3154 if (!pack_to_stdout
&& !pack_size_limit
)
3155 pack_size_limit
= pack_size_limit_cfg
;
3156 if (pack_to_stdout
&& pack_size_limit
)
3157 die("--max-pack-size cannot be used to build a pack for transfer.");
3158 if (pack_size_limit
&& pack_size_limit
< 1024*1024) {
3159 warning("minimum pack size limit is 1 MiB");
3160 pack_size_limit
= 1024*1024;
3163 if (!pack_to_stdout
&& thin
)
3164 die("--thin cannot be used to build an indexable pack.");
3166 if (keep_unreachable
&& unpack_unreachable
)
3167 die("--keep-unreachable and --unpack-unreachable are incompatible.");
3168 if (!rev_list_all
|| !rev_list_reflog
|| !rev_list_index
)
3169 unpack_unreachable_expiration
= 0;
3171 if (filter_options
.choice
) {
3172 if (!pack_to_stdout
)
3173 die("cannot use --filter without --stdout.");
3174 use_bitmap_index
= 0;
3178 * "soft" reasons not to use bitmaps - for on-disk repack by default we want
3180 * - to produce good pack (with bitmap index not-yet-packed objects are
3181 * packed in suboptimal order).
3183 * - to use more robust pack-generation codepath (avoiding possible
3184 * bugs in bitmap code and possible bitmap index corruption).
3186 if (!pack_to_stdout
)
3187 use_bitmap_index_default
= 0;
3189 if (use_bitmap_index
< 0)
3190 use_bitmap_index
= use_bitmap_index_default
;
3192 /* "hard" reasons not to use bitmaps; these just won't work at all */
3193 if (!use_internal_rev_list
|| (!pack_to_stdout
&& write_bitmap_index
) || is_repository_shallow())
3194 use_bitmap_index
= 0;
3196 if (pack_to_stdout
|| !rev_list_all
)
3197 write_bitmap_index
= 0;
3199 if (progress
&& all_progress_implied
)
3202 if (ignore_packed_keep
) {
3203 struct packed_git
*p
;
3204 for (p
= get_packed_git(the_repository
); p
; p
= p
->next
)
3205 if (p
->pack_local
&& p
->pack_keep
)
3207 if (!p
) /* no keep-able packs found */
3208 ignore_packed_keep
= 0;
3212 * unlike ignore_packed_keep above, we do not want to
3213 * unset "local" based on looking at packs, as it
3214 * also covers non-local objects
3216 struct packed_git
*p
;
3217 for (p
= get_packed_git(the_repository
); p
; p
= p
->next
) {
3218 if (!p
->pack_local
) {
3219 have_non_local_packs
= 1;
3225 prepare_packing_data(&to_pack
);
3228 progress_state
= start_progress(_("Counting objects"), 0);
3229 if (!use_internal_rev_list
)
3230 read_object_list_from_stdin();
3232 get_object_list(rp
.argc
, rp
.argv
);
3233 argv_array_clear(&rp
);
3235 cleanup_preferred_base();
3236 if (include_tag
&& nr_result
)
3237 for_each_ref(add_ref_tag
, NULL
);
3238 stop_progress(&progress_state
);
3240 if (non_empty
&& !nr_result
)
3243 prepare_pack(window
, depth
);
3246 fprintf(stderr
, "Total %"PRIu32
" (delta %"PRIu32
"),"
3247 " reused %"PRIu32
" (delta %"PRIu32
")\n",
3248 written
, written_delta
, reused
, reused_delta
);