Merge branch 'ew/free-island-marks'
[git/debian.git] / builtin / pack-objects.c
blob3395f63abae3fe7551c91a680220234b7e9fcd21
1 #include "builtin.h"
2 #include "cache.h"
3 #include "repository.h"
4 #include "config.h"
5 #include "attr.h"
6 #include "object.h"
7 #include "blob.h"
8 #include "commit.h"
9 #include "tag.h"
10 #include "tree.h"
11 #include "delta.h"
12 #include "pack.h"
13 #include "pack-revindex.h"
14 #include "csum-file.h"
15 #include "tree-walk.h"
16 #include "diff.h"
17 #include "revision.h"
18 #include "list-objects.h"
19 #include "list-objects-filter.h"
20 #include "list-objects-filter-options.h"
21 #include "pack-objects.h"
22 #include "progress.h"
23 #include "refs.h"
24 #include "streaming.h"
25 #include "thread-utils.h"
26 #include "pack-bitmap.h"
27 #include "delta-islands.h"
28 #include "reachable.h"
29 #include "oid-array.h"
30 #include "strvec.h"
31 #include "list.h"
32 #include "packfile.h"
33 #include "object-store.h"
34 #include "dir.h"
35 #include "midx.h"
36 #include "trace2.h"
37 #include "shallow.h"
38 #include "promisor-remote.h"
39 #include "pack-mtimes.h"
42 * Objects we are going to pack are collected in the `to_pack` structure.
43 * It contains an array (dynamically expanded) of the object data, and a map
44 * that can resolve SHA1s to their position in the array.
46 static struct packing_data to_pack;
48 static inline struct object_entry *oe_delta(
49 const struct packing_data *pack,
50 const struct object_entry *e)
52 if (!e->delta_idx)
53 return NULL;
54 if (e->ext_base)
55 return &pack->ext_bases[e->delta_idx - 1];
56 else
57 return &pack->objects[e->delta_idx - 1];
60 static inline unsigned long oe_delta_size(struct packing_data *pack,
61 const struct object_entry *e)
63 if (e->delta_size_valid)
64 return e->delta_size_;
67 * pack->delta_size[] can't be NULL because oe_set_delta_size()
68 * must have been called when a new delta is saved with
69 * oe_set_delta().
70 * If oe_delta() returns NULL (i.e. default state, which means
71 * delta_size_valid is also false), then the caller must never
72 * call oe_delta_size().
74 return pack->delta_size[e - pack->objects];
77 unsigned long oe_get_size_slow(struct packing_data *pack,
78 const struct object_entry *e);
80 static inline unsigned long oe_size(struct packing_data *pack,
81 const struct object_entry *e)
83 if (e->size_valid)
84 return e->size_;
86 return oe_get_size_slow(pack, e);
89 static inline void oe_set_delta(struct packing_data *pack,
90 struct object_entry *e,
91 struct object_entry *delta)
93 if (delta)
94 e->delta_idx = (delta - pack->objects) + 1;
95 else
96 e->delta_idx = 0;
99 static inline struct object_entry *oe_delta_sibling(
100 const struct packing_data *pack,
101 const struct object_entry *e)
103 if (e->delta_sibling_idx)
104 return &pack->objects[e->delta_sibling_idx - 1];
105 return NULL;
108 static inline struct object_entry *oe_delta_child(
109 const struct packing_data *pack,
110 const struct object_entry *e)
112 if (e->delta_child_idx)
113 return &pack->objects[e->delta_child_idx - 1];
114 return NULL;
117 static inline void oe_set_delta_child(struct packing_data *pack,
118 struct object_entry *e,
119 struct object_entry *delta)
121 if (delta)
122 e->delta_child_idx = (delta - pack->objects) + 1;
123 else
124 e->delta_child_idx = 0;
127 static inline void oe_set_delta_sibling(struct packing_data *pack,
128 struct object_entry *e,
129 struct object_entry *delta)
131 if (delta)
132 e->delta_sibling_idx = (delta - pack->objects) + 1;
133 else
134 e->delta_sibling_idx = 0;
137 static inline void oe_set_size(struct packing_data *pack,
138 struct object_entry *e,
139 unsigned long size)
141 if (size < pack->oe_size_limit) {
142 e->size_ = size;
143 e->size_valid = 1;
144 } else {
145 e->size_valid = 0;
146 if (oe_get_size_slow(pack, e) != size)
147 BUG("'size' is supposed to be the object size!");
151 static inline void oe_set_delta_size(struct packing_data *pack,
152 struct object_entry *e,
153 unsigned long size)
155 if (size < pack->oe_delta_size_limit) {
156 e->delta_size_ = size;
157 e->delta_size_valid = 1;
158 } else {
159 packing_data_lock(pack);
160 if (!pack->delta_size)
161 ALLOC_ARRAY(pack->delta_size, pack->nr_alloc);
162 packing_data_unlock(pack);
164 pack->delta_size[e - pack->objects] = size;
165 e->delta_size_valid = 0;
169 #define IN_PACK(obj) oe_in_pack(&to_pack, obj)
170 #define SIZE(obj) oe_size(&to_pack, obj)
171 #define SET_SIZE(obj,size) oe_set_size(&to_pack, obj, size)
172 #define DELTA_SIZE(obj) oe_delta_size(&to_pack, obj)
173 #define DELTA(obj) oe_delta(&to_pack, obj)
174 #define DELTA_CHILD(obj) oe_delta_child(&to_pack, obj)
175 #define DELTA_SIBLING(obj) oe_delta_sibling(&to_pack, obj)
176 #define SET_DELTA(obj, val) oe_set_delta(&to_pack, obj, val)
177 #define SET_DELTA_EXT(obj, oid) oe_set_delta_ext(&to_pack, obj, oid)
178 #define SET_DELTA_SIZE(obj, val) oe_set_delta_size(&to_pack, obj, val)
179 #define SET_DELTA_CHILD(obj, val) oe_set_delta_child(&to_pack, obj, val)
180 #define SET_DELTA_SIBLING(obj, val) oe_set_delta_sibling(&to_pack, obj, val)
182 static const char *pack_usage[] = {
183 N_("git pack-objects --stdout [<options>] [< <ref-list> | < <object-list>]"),
184 N_("git pack-objects [<options>] <base-name> [< <ref-list> | < <object-list>]"),
185 NULL
188 static struct pack_idx_entry **written_list;
189 static uint32_t nr_result, nr_written, nr_seen;
190 static struct bitmap_index *bitmap_git;
191 static uint32_t write_layer;
193 static int non_empty;
194 static int reuse_delta = 1, reuse_object = 1;
195 static int keep_unreachable, unpack_unreachable, include_tag;
196 static timestamp_t unpack_unreachable_expiration;
197 static int pack_loose_unreachable;
198 static int cruft;
199 static timestamp_t cruft_expiration;
200 static int local;
201 static int have_non_local_packs;
202 static int incremental;
203 static int ignore_packed_keep_on_disk;
204 static int ignore_packed_keep_in_core;
205 static int allow_ofs_delta;
206 static struct pack_idx_option pack_idx_opts;
207 static const char *base_name;
208 static int progress = 1;
209 static int window = 10;
210 static unsigned long pack_size_limit;
211 static int depth = 50;
212 static int delta_search_threads;
213 static int pack_to_stdout;
214 static int sparse;
215 static int thin;
216 static int num_preferred_base;
217 static struct progress *progress_state;
219 static struct packed_git *reuse_packfile;
220 static uint32_t reuse_packfile_objects;
221 static struct bitmap *reuse_packfile_bitmap;
223 static int use_bitmap_index_default = 1;
224 static int use_bitmap_index = -1;
225 static int allow_pack_reuse = 1;
226 static enum {
227 WRITE_BITMAP_FALSE = 0,
228 WRITE_BITMAP_QUIET,
229 WRITE_BITMAP_TRUE,
230 } write_bitmap_index;
231 static uint16_t write_bitmap_options = BITMAP_OPT_HASH_CACHE;
233 static int exclude_promisor_objects;
235 static int use_delta_islands;
237 static unsigned long delta_cache_size = 0;
238 static unsigned long max_delta_cache_size = DEFAULT_DELTA_CACHE_SIZE;
239 static unsigned long cache_max_small_delta_size = 1000;
241 static unsigned long window_memory_limit = 0;
243 static struct string_list uri_protocols = STRING_LIST_INIT_NODUP;
245 enum missing_action {
246 MA_ERROR = 0, /* fail if any missing objects are encountered */
247 MA_ALLOW_ANY, /* silently allow ALL missing objects */
248 MA_ALLOW_PROMISOR, /* silently allow all missing PROMISOR objects */
250 static enum missing_action arg_missing_action;
251 static show_object_fn fn_show_object;
253 struct configured_exclusion {
254 struct oidmap_entry e;
255 char *pack_hash_hex;
256 char *uri;
258 static struct oidmap configured_exclusions;
260 static struct oidset excluded_by_config;
263 * stats
265 static uint32_t written, written_delta;
266 static uint32_t reused, reused_delta;
269 * Indexed commits
271 static struct commit **indexed_commits;
272 static unsigned int indexed_commits_nr;
273 static unsigned int indexed_commits_alloc;
275 static void index_commit_for_bitmap(struct commit *commit)
277 if (indexed_commits_nr >= indexed_commits_alloc) {
278 indexed_commits_alloc = (indexed_commits_alloc + 32) * 2;
279 REALLOC_ARRAY(indexed_commits, indexed_commits_alloc);
282 indexed_commits[indexed_commits_nr++] = commit;
285 static void *get_delta(struct object_entry *entry)
287 unsigned long size, base_size, delta_size;
288 void *buf, *base_buf, *delta_buf;
289 enum object_type type;
291 buf = read_object_file(&entry->idx.oid, &type, &size);
292 if (!buf)
293 die(_("unable to read %s"), oid_to_hex(&entry->idx.oid));
294 base_buf = read_object_file(&DELTA(entry)->idx.oid, &type,
295 &base_size);
296 if (!base_buf)
297 die("unable to read %s",
298 oid_to_hex(&DELTA(entry)->idx.oid));
299 delta_buf = diff_delta(base_buf, base_size,
300 buf, size, &delta_size, 0);
302 * We successfully computed this delta once but dropped it for
303 * memory reasons. Something is very wrong if this time we
304 * recompute and create a different delta.
306 if (!delta_buf || delta_size != DELTA_SIZE(entry))
307 BUG("delta size changed");
308 free(buf);
309 free(base_buf);
310 return delta_buf;
313 static unsigned long do_compress(void **pptr, unsigned long size)
315 git_zstream stream;
316 void *in, *out;
317 unsigned long maxsize;
319 git_deflate_init(&stream, pack_compression_level);
320 maxsize = git_deflate_bound(&stream, size);
322 in = *pptr;
323 out = xmalloc(maxsize);
324 *pptr = out;
326 stream.next_in = in;
327 stream.avail_in = size;
328 stream.next_out = out;
329 stream.avail_out = maxsize;
330 while (git_deflate(&stream, Z_FINISH) == Z_OK)
331 ; /* nothing */
332 git_deflate_end(&stream);
334 free(in);
335 return stream.total_out;
338 static unsigned long write_large_blob_data(struct git_istream *st, struct hashfile *f,
339 const struct object_id *oid)
341 git_zstream stream;
342 unsigned char ibuf[1024 * 16];
343 unsigned char obuf[1024 * 16];
344 unsigned long olen = 0;
346 git_deflate_init(&stream, pack_compression_level);
348 for (;;) {
349 ssize_t readlen;
350 int zret = Z_OK;
351 readlen = read_istream(st, ibuf, sizeof(ibuf));
352 if (readlen == -1)
353 die(_("unable to read %s"), oid_to_hex(oid));
355 stream.next_in = ibuf;
356 stream.avail_in = readlen;
357 while ((stream.avail_in || readlen == 0) &&
358 (zret == Z_OK || zret == Z_BUF_ERROR)) {
359 stream.next_out = obuf;
360 stream.avail_out = sizeof(obuf);
361 zret = git_deflate(&stream, readlen ? 0 : Z_FINISH);
362 hashwrite(f, obuf, stream.next_out - obuf);
363 olen += stream.next_out - obuf;
365 if (stream.avail_in)
366 die(_("deflate error (%d)"), zret);
367 if (readlen == 0) {
368 if (zret != Z_STREAM_END)
369 die(_("deflate error (%d)"), zret);
370 break;
373 git_deflate_end(&stream);
374 return olen;
378 * we are going to reuse the existing object data as is. make
379 * sure it is not corrupt.
381 static int check_pack_inflate(struct packed_git *p,
382 struct pack_window **w_curs,
383 off_t offset,
384 off_t len,
385 unsigned long expect)
387 git_zstream stream;
388 unsigned char fakebuf[4096], *in;
389 int st;
391 memset(&stream, 0, sizeof(stream));
392 git_inflate_init(&stream);
393 do {
394 in = use_pack(p, w_curs, offset, &stream.avail_in);
395 stream.next_in = in;
396 stream.next_out = fakebuf;
397 stream.avail_out = sizeof(fakebuf);
398 st = git_inflate(&stream, Z_FINISH);
399 offset += stream.next_in - in;
400 } while (st == Z_OK || st == Z_BUF_ERROR);
401 git_inflate_end(&stream);
402 return (st == Z_STREAM_END &&
403 stream.total_out == expect &&
404 stream.total_in == len) ? 0 : -1;
407 static void copy_pack_data(struct hashfile *f,
408 struct packed_git *p,
409 struct pack_window **w_curs,
410 off_t offset,
411 off_t len)
413 unsigned char *in;
414 unsigned long avail;
416 while (len) {
417 in = use_pack(p, w_curs, offset, &avail);
418 if (avail > len)
419 avail = (unsigned long)len;
420 hashwrite(f, in, avail);
421 offset += avail;
422 len -= avail;
426 static inline int oe_size_greater_than(struct packing_data *pack,
427 const struct object_entry *lhs,
428 unsigned long rhs)
430 if (lhs->size_valid)
431 return lhs->size_ > rhs;
432 if (rhs < pack->oe_size_limit) /* rhs < 2^x <= lhs ? */
433 return 1;
434 return oe_get_size_slow(pack, lhs) > rhs;
437 /* Return 0 if we will bust the pack-size limit */
438 static unsigned long write_no_reuse_object(struct hashfile *f, struct object_entry *entry,
439 unsigned long limit, int usable_delta)
441 unsigned long size, datalen;
442 unsigned char header[MAX_PACK_OBJECT_HEADER],
443 dheader[MAX_PACK_OBJECT_HEADER];
444 unsigned hdrlen;
445 enum object_type type;
446 void *buf;
447 struct git_istream *st = NULL;
448 const unsigned hashsz = the_hash_algo->rawsz;
450 if (!usable_delta) {
451 if (oe_type(entry) == OBJ_BLOB &&
452 oe_size_greater_than(&to_pack, entry, big_file_threshold) &&
453 (st = open_istream(the_repository, &entry->idx.oid, &type,
454 &size, NULL)) != NULL)
455 buf = NULL;
456 else {
457 buf = read_object_file(&entry->idx.oid, &type, &size);
458 if (!buf)
459 die(_("unable to read %s"),
460 oid_to_hex(&entry->idx.oid));
463 * make sure no cached delta data remains from a
464 * previous attempt before a pack split occurred.
466 FREE_AND_NULL(entry->delta_data);
467 entry->z_delta_size = 0;
468 } else if (entry->delta_data) {
469 size = DELTA_SIZE(entry);
470 buf = entry->delta_data;
471 entry->delta_data = NULL;
472 type = (allow_ofs_delta && DELTA(entry)->idx.offset) ?
473 OBJ_OFS_DELTA : OBJ_REF_DELTA;
474 } else {
475 buf = get_delta(entry);
476 size = DELTA_SIZE(entry);
477 type = (allow_ofs_delta && DELTA(entry)->idx.offset) ?
478 OBJ_OFS_DELTA : OBJ_REF_DELTA;
481 if (st) /* large blob case, just assume we don't compress well */
482 datalen = size;
483 else if (entry->z_delta_size)
484 datalen = entry->z_delta_size;
485 else
486 datalen = do_compress(&buf, size);
489 * The object header is a byte of 'type' followed by zero or
490 * more bytes of length.
492 hdrlen = encode_in_pack_object_header(header, sizeof(header),
493 type, size);
495 if (type == OBJ_OFS_DELTA) {
497 * Deltas with relative base contain an additional
498 * encoding of the relative offset for the delta
499 * base from this object's position in the pack.
501 off_t ofs = entry->idx.offset - DELTA(entry)->idx.offset;
502 unsigned pos = sizeof(dheader) - 1;
503 dheader[pos] = ofs & 127;
504 while (ofs >>= 7)
505 dheader[--pos] = 128 | (--ofs & 127);
506 if (limit && hdrlen + sizeof(dheader) - pos + datalen + hashsz >= limit) {
507 if (st)
508 close_istream(st);
509 free(buf);
510 return 0;
512 hashwrite(f, header, hdrlen);
513 hashwrite(f, dheader + pos, sizeof(dheader) - pos);
514 hdrlen += sizeof(dheader) - pos;
515 } else if (type == OBJ_REF_DELTA) {
517 * Deltas with a base reference contain
518 * additional bytes for the base object ID.
520 if (limit && hdrlen + hashsz + datalen + hashsz >= limit) {
521 if (st)
522 close_istream(st);
523 free(buf);
524 return 0;
526 hashwrite(f, header, hdrlen);
527 hashwrite(f, DELTA(entry)->idx.oid.hash, hashsz);
528 hdrlen += hashsz;
529 } else {
530 if (limit && hdrlen + datalen + hashsz >= limit) {
531 if (st)
532 close_istream(st);
533 free(buf);
534 return 0;
536 hashwrite(f, header, hdrlen);
538 if (st) {
539 datalen = write_large_blob_data(st, f, &entry->idx.oid);
540 close_istream(st);
541 } else {
542 hashwrite(f, buf, datalen);
543 free(buf);
546 return hdrlen + datalen;
549 /* Return 0 if we will bust the pack-size limit */
550 static off_t write_reuse_object(struct hashfile *f, struct object_entry *entry,
551 unsigned long limit, int usable_delta)
553 struct packed_git *p = IN_PACK(entry);
554 struct pack_window *w_curs = NULL;
555 uint32_t pos;
556 off_t offset;
557 enum object_type type = oe_type(entry);
558 off_t datalen;
559 unsigned char header[MAX_PACK_OBJECT_HEADER],
560 dheader[MAX_PACK_OBJECT_HEADER];
561 unsigned hdrlen;
562 const unsigned hashsz = the_hash_algo->rawsz;
563 unsigned long entry_size = SIZE(entry);
565 if (DELTA(entry))
566 type = (allow_ofs_delta && DELTA(entry)->idx.offset) ?
567 OBJ_OFS_DELTA : OBJ_REF_DELTA;
568 hdrlen = encode_in_pack_object_header(header, sizeof(header),
569 type, entry_size);
571 offset = entry->in_pack_offset;
572 if (offset_to_pack_pos(p, offset, &pos) < 0)
573 die(_("write_reuse_object: could not locate %s, expected at "
574 "offset %"PRIuMAX" in pack %s"),
575 oid_to_hex(&entry->idx.oid), (uintmax_t)offset,
576 p->pack_name);
577 datalen = pack_pos_to_offset(p, pos + 1) - offset;
578 if (!pack_to_stdout && p->index_version > 1 &&
579 check_pack_crc(p, &w_curs, offset, datalen,
580 pack_pos_to_index(p, pos))) {
581 error(_("bad packed object CRC for %s"),
582 oid_to_hex(&entry->idx.oid));
583 unuse_pack(&w_curs);
584 return write_no_reuse_object(f, entry, limit, usable_delta);
587 offset += entry->in_pack_header_size;
588 datalen -= entry->in_pack_header_size;
590 if (!pack_to_stdout && p->index_version == 1 &&
591 check_pack_inflate(p, &w_curs, offset, datalen, entry_size)) {
592 error(_("corrupt packed object for %s"),
593 oid_to_hex(&entry->idx.oid));
594 unuse_pack(&w_curs);
595 return write_no_reuse_object(f, entry, limit, usable_delta);
598 if (type == OBJ_OFS_DELTA) {
599 off_t ofs = entry->idx.offset - DELTA(entry)->idx.offset;
600 unsigned pos = sizeof(dheader) - 1;
601 dheader[pos] = ofs & 127;
602 while (ofs >>= 7)
603 dheader[--pos] = 128 | (--ofs & 127);
604 if (limit && hdrlen + sizeof(dheader) - pos + datalen + hashsz >= limit) {
605 unuse_pack(&w_curs);
606 return 0;
608 hashwrite(f, header, hdrlen);
609 hashwrite(f, dheader + pos, sizeof(dheader) - pos);
610 hdrlen += sizeof(dheader) - pos;
611 reused_delta++;
612 } else if (type == OBJ_REF_DELTA) {
613 if (limit && hdrlen + hashsz + datalen + hashsz >= limit) {
614 unuse_pack(&w_curs);
615 return 0;
617 hashwrite(f, header, hdrlen);
618 hashwrite(f, DELTA(entry)->idx.oid.hash, hashsz);
619 hdrlen += hashsz;
620 reused_delta++;
621 } else {
622 if (limit && hdrlen + datalen + hashsz >= limit) {
623 unuse_pack(&w_curs);
624 return 0;
626 hashwrite(f, header, hdrlen);
628 copy_pack_data(f, p, &w_curs, offset, datalen);
629 unuse_pack(&w_curs);
630 reused++;
631 return hdrlen + datalen;
634 /* Return 0 if we will bust the pack-size limit */
635 static off_t write_object(struct hashfile *f,
636 struct object_entry *entry,
637 off_t write_offset)
639 unsigned long limit;
640 off_t len;
641 int usable_delta, to_reuse;
643 if (!pack_to_stdout)
644 crc32_begin(f);
646 /* apply size limit if limited packsize and not first object */
647 if (!pack_size_limit || !nr_written)
648 limit = 0;
649 else if (pack_size_limit <= write_offset)
651 * the earlier object did not fit the limit; avoid
652 * mistaking this with unlimited (i.e. limit = 0).
654 limit = 1;
655 else
656 limit = pack_size_limit - write_offset;
658 if (!DELTA(entry))
659 usable_delta = 0; /* no delta */
660 else if (!pack_size_limit)
661 usable_delta = 1; /* unlimited packfile */
662 else if (DELTA(entry)->idx.offset == (off_t)-1)
663 usable_delta = 0; /* base was written to another pack */
664 else if (DELTA(entry)->idx.offset)
665 usable_delta = 1; /* base already exists in this pack */
666 else
667 usable_delta = 0; /* base could end up in another pack */
669 if (!reuse_object)
670 to_reuse = 0; /* explicit */
671 else if (!IN_PACK(entry))
672 to_reuse = 0; /* can't reuse what we don't have */
673 else if (oe_type(entry) == OBJ_REF_DELTA ||
674 oe_type(entry) == OBJ_OFS_DELTA)
675 /* check_object() decided it for us ... */
676 to_reuse = usable_delta;
677 /* ... but pack split may override that */
678 else if (oe_type(entry) != entry->in_pack_type)
679 to_reuse = 0; /* pack has delta which is unusable */
680 else if (DELTA(entry))
681 to_reuse = 0; /* we want to pack afresh */
682 else
683 to_reuse = 1; /* we have it in-pack undeltified,
684 * and we do not need to deltify it.
687 if (!to_reuse)
688 len = write_no_reuse_object(f, entry, limit, usable_delta);
689 else
690 len = write_reuse_object(f, entry, limit, usable_delta);
691 if (!len)
692 return 0;
694 if (usable_delta)
695 written_delta++;
696 written++;
697 if (!pack_to_stdout)
698 entry->idx.crc32 = crc32_end(f);
699 return len;
702 enum write_one_status {
703 WRITE_ONE_SKIP = -1, /* already written */
704 WRITE_ONE_BREAK = 0, /* writing this will bust the limit; not written */
705 WRITE_ONE_WRITTEN = 1, /* normal */
706 WRITE_ONE_RECURSIVE = 2 /* already scheduled to be written */
709 static enum write_one_status write_one(struct hashfile *f,
710 struct object_entry *e,
711 off_t *offset)
713 off_t size;
714 int recursing;
717 * we set offset to 1 (which is an impossible value) to mark
718 * the fact that this object is involved in "write its base
719 * first before writing a deltified object" recursion.
721 recursing = (e->idx.offset == 1);
722 if (recursing) {
723 warning(_("recursive delta detected for object %s"),
724 oid_to_hex(&e->idx.oid));
725 return WRITE_ONE_RECURSIVE;
726 } else if (e->idx.offset || e->preferred_base) {
727 /* offset is non zero if object is written already. */
728 return WRITE_ONE_SKIP;
731 /* if we are deltified, write out base object first. */
732 if (DELTA(e)) {
733 e->idx.offset = 1; /* now recurse */
734 switch (write_one(f, DELTA(e), offset)) {
735 case WRITE_ONE_RECURSIVE:
736 /* we cannot depend on this one */
737 SET_DELTA(e, NULL);
738 break;
739 default:
740 break;
741 case WRITE_ONE_BREAK:
742 e->idx.offset = recursing;
743 return WRITE_ONE_BREAK;
747 e->idx.offset = *offset;
748 size = write_object(f, e, *offset);
749 if (!size) {
750 e->idx.offset = recursing;
751 return WRITE_ONE_BREAK;
753 written_list[nr_written++] = &e->idx;
755 /* make sure off_t is sufficiently large not to wrap */
756 if (signed_add_overflows(*offset, size))
757 die(_("pack too large for current definition of off_t"));
758 *offset += size;
759 return WRITE_ONE_WRITTEN;
762 static int mark_tagged(const char *path UNUSED, const struct object_id *oid,
763 int flag UNUSED, void *cb_data UNUSED)
765 struct object_id peeled;
766 struct object_entry *entry = packlist_find(&to_pack, oid);
768 if (entry)
769 entry->tagged = 1;
770 if (!peel_iterated_oid(oid, &peeled)) {
771 entry = packlist_find(&to_pack, &peeled);
772 if (entry)
773 entry->tagged = 1;
775 return 0;
778 static inline unsigned char oe_layer(struct packing_data *pack,
779 struct object_entry *e)
781 if (!pack->layer)
782 return 0;
783 return pack->layer[e - pack->objects];
786 static inline void add_to_write_order(struct object_entry **wo,
787 unsigned int *endp,
788 struct object_entry *e)
790 if (e->filled || oe_layer(&to_pack, e) != write_layer)
791 return;
792 wo[(*endp)++] = e;
793 e->filled = 1;
796 static void add_descendants_to_write_order(struct object_entry **wo,
797 unsigned int *endp,
798 struct object_entry *e)
800 int add_to_order = 1;
801 while (e) {
802 if (add_to_order) {
803 struct object_entry *s;
804 /* add this node... */
805 add_to_write_order(wo, endp, e);
806 /* all its siblings... */
807 for (s = DELTA_SIBLING(e); s; s = DELTA_SIBLING(s)) {
808 add_to_write_order(wo, endp, s);
811 /* drop down a level to add left subtree nodes if possible */
812 if (DELTA_CHILD(e)) {
813 add_to_order = 1;
814 e = DELTA_CHILD(e);
815 } else {
816 add_to_order = 0;
817 /* our sibling might have some children, it is next */
818 if (DELTA_SIBLING(e)) {
819 e = DELTA_SIBLING(e);
820 continue;
822 /* go back to our parent node */
823 e = DELTA(e);
824 while (e && !DELTA_SIBLING(e)) {
825 /* we're on the right side of a subtree, keep
826 * going up until we can go right again */
827 e = DELTA(e);
829 if (!e) {
830 /* done- we hit our original root node */
831 return;
833 /* pass it off to sibling at this level */
834 e = DELTA_SIBLING(e);
839 static void add_family_to_write_order(struct object_entry **wo,
840 unsigned int *endp,
841 struct object_entry *e)
843 struct object_entry *root;
845 for (root = e; DELTA(root); root = DELTA(root))
846 ; /* nothing */
847 add_descendants_to_write_order(wo, endp, root);
850 static void compute_layer_order(struct object_entry **wo, unsigned int *wo_end)
852 unsigned int i, last_untagged;
853 struct object_entry *objects = to_pack.objects;
855 for (i = 0; i < to_pack.nr_objects; i++) {
856 if (objects[i].tagged)
857 break;
858 add_to_write_order(wo, wo_end, &objects[i]);
860 last_untagged = i;
863 * Then fill all the tagged tips.
865 for (; i < to_pack.nr_objects; i++) {
866 if (objects[i].tagged)
867 add_to_write_order(wo, wo_end, &objects[i]);
871 * And then all remaining commits and tags.
873 for (i = last_untagged; i < to_pack.nr_objects; i++) {
874 if (oe_type(&objects[i]) != OBJ_COMMIT &&
875 oe_type(&objects[i]) != OBJ_TAG)
876 continue;
877 add_to_write_order(wo, wo_end, &objects[i]);
881 * And then all the trees.
883 for (i = last_untagged; i < to_pack.nr_objects; i++) {
884 if (oe_type(&objects[i]) != OBJ_TREE)
885 continue;
886 add_to_write_order(wo, wo_end, &objects[i]);
890 * Finally all the rest in really tight order
892 for (i = last_untagged; i < to_pack.nr_objects; i++) {
893 if (!objects[i].filled && oe_layer(&to_pack, &objects[i]) == write_layer)
894 add_family_to_write_order(wo, wo_end, &objects[i]);
898 static struct object_entry **compute_write_order(void)
900 uint32_t max_layers = 1;
901 unsigned int i, wo_end;
903 struct object_entry **wo;
904 struct object_entry *objects = to_pack.objects;
906 for (i = 0; i < to_pack.nr_objects; i++) {
907 objects[i].tagged = 0;
908 objects[i].filled = 0;
909 SET_DELTA_CHILD(&objects[i], NULL);
910 SET_DELTA_SIBLING(&objects[i], NULL);
914 * Fully connect delta_child/delta_sibling network.
915 * Make sure delta_sibling is sorted in the original
916 * recency order.
918 for (i = to_pack.nr_objects; i > 0;) {
919 struct object_entry *e = &objects[--i];
920 if (!DELTA(e))
921 continue;
922 /* Mark me as the first child */
923 e->delta_sibling_idx = DELTA(e)->delta_child_idx;
924 SET_DELTA_CHILD(DELTA(e), e);
928 * Mark objects that are at the tip of tags.
930 for_each_tag_ref(mark_tagged, NULL);
932 if (use_delta_islands) {
933 max_layers = compute_pack_layers(&to_pack);
934 free_island_marks();
937 ALLOC_ARRAY(wo, to_pack.nr_objects);
938 wo_end = 0;
940 for (; write_layer < max_layers; ++write_layer)
941 compute_layer_order(wo, &wo_end);
943 if (wo_end != to_pack.nr_objects)
944 die(_("ordered %u objects, expected %"PRIu32),
945 wo_end, to_pack.nr_objects);
947 return wo;
952 * A reused set of objects. All objects in a chunk have the same
953 * relative position in the original packfile and the generated
954 * packfile.
957 static struct reused_chunk {
958 /* The offset of the first object of this chunk in the original
959 * packfile. */
960 off_t original;
961 /* The difference for "original" minus the offset of the first object of
962 * this chunk in the generated packfile. */
963 off_t difference;
964 } *reused_chunks;
965 static int reused_chunks_nr;
966 static int reused_chunks_alloc;
968 static void record_reused_object(off_t where, off_t offset)
970 if (reused_chunks_nr && reused_chunks[reused_chunks_nr-1].difference == offset)
971 return;
973 ALLOC_GROW(reused_chunks, reused_chunks_nr + 1,
974 reused_chunks_alloc);
975 reused_chunks[reused_chunks_nr].original = where;
976 reused_chunks[reused_chunks_nr].difference = offset;
977 reused_chunks_nr++;
981 * Binary search to find the chunk that "where" is in. Note
982 * that we're not looking for an exact match, just the first
983 * chunk that contains it (which implicitly ends at the start
984 * of the next chunk.
986 static off_t find_reused_offset(off_t where)
988 int lo = 0, hi = reused_chunks_nr;
989 while (lo < hi) {
990 int mi = lo + ((hi - lo) / 2);
991 if (where == reused_chunks[mi].original)
992 return reused_chunks[mi].difference;
993 if (where < reused_chunks[mi].original)
994 hi = mi;
995 else
996 lo = mi + 1;
1000 * The first chunk starts at zero, so we can't have gone below
1001 * there.
1003 assert(lo);
1004 return reused_chunks[lo-1].difference;
1007 static void write_reused_pack_one(size_t pos, struct hashfile *out,
1008 struct pack_window **w_curs)
1010 off_t offset, next, cur;
1011 enum object_type type;
1012 unsigned long size;
1014 offset = pack_pos_to_offset(reuse_packfile, pos);
1015 next = pack_pos_to_offset(reuse_packfile, pos + 1);
1017 record_reused_object(offset, offset - hashfile_total(out));
1019 cur = offset;
1020 type = unpack_object_header(reuse_packfile, w_curs, &cur, &size);
1021 assert(type >= 0);
1023 if (type == OBJ_OFS_DELTA) {
1024 off_t base_offset;
1025 off_t fixup;
1027 unsigned char header[MAX_PACK_OBJECT_HEADER];
1028 unsigned len;
1030 base_offset = get_delta_base(reuse_packfile, w_curs, &cur, type, offset);
1031 assert(base_offset != 0);
1033 /* Convert to REF_DELTA if we must... */
1034 if (!allow_ofs_delta) {
1035 uint32_t base_pos;
1036 struct object_id base_oid;
1038 if (offset_to_pack_pos(reuse_packfile, base_offset, &base_pos) < 0)
1039 die(_("expected object at offset %"PRIuMAX" "
1040 "in pack %s"),
1041 (uintmax_t)base_offset,
1042 reuse_packfile->pack_name);
1044 nth_packed_object_id(&base_oid, reuse_packfile,
1045 pack_pos_to_index(reuse_packfile, base_pos));
1047 len = encode_in_pack_object_header(header, sizeof(header),
1048 OBJ_REF_DELTA, size);
1049 hashwrite(out, header, len);
1050 hashwrite(out, base_oid.hash, the_hash_algo->rawsz);
1051 copy_pack_data(out, reuse_packfile, w_curs, cur, next - cur);
1052 return;
1055 /* Otherwise see if we need to rewrite the offset... */
1056 fixup = find_reused_offset(offset) -
1057 find_reused_offset(base_offset);
1058 if (fixup) {
1059 unsigned char ofs_header[10];
1060 unsigned i, ofs_len;
1061 off_t ofs = offset - base_offset - fixup;
1063 len = encode_in_pack_object_header(header, sizeof(header),
1064 OBJ_OFS_DELTA, size);
1066 i = sizeof(ofs_header) - 1;
1067 ofs_header[i] = ofs & 127;
1068 while (ofs >>= 7)
1069 ofs_header[--i] = 128 | (--ofs & 127);
1071 ofs_len = sizeof(ofs_header) - i;
1073 hashwrite(out, header, len);
1074 hashwrite(out, ofs_header + sizeof(ofs_header) - ofs_len, ofs_len);
1075 copy_pack_data(out, reuse_packfile, w_curs, cur, next - cur);
1076 return;
1079 /* ...otherwise we have no fixup, and can write it verbatim */
1082 copy_pack_data(out, reuse_packfile, w_curs, offset, next - offset);
1085 static size_t write_reused_pack_verbatim(struct hashfile *out,
1086 struct pack_window **w_curs)
1088 size_t pos = 0;
1090 while (pos < reuse_packfile_bitmap->word_alloc &&
1091 reuse_packfile_bitmap->words[pos] == (eword_t)~0)
1092 pos++;
1094 if (pos) {
1095 off_t to_write;
1097 written = (pos * BITS_IN_EWORD);
1098 to_write = pack_pos_to_offset(reuse_packfile, written)
1099 - sizeof(struct pack_header);
1101 /* We're recording one chunk, not one object. */
1102 record_reused_object(sizeof(struct pack_header), 0);
1103 hashflush(out);
1104 copy_pack_data(out, reuse_packfile, w_curs,
1105 sizeof(struct pack_header), to_write);
1107 display_progress(progress_state, written);
1109 return pos;
1112 static void write_reused_pack(struct hashfile *f)
1114 size_t i = 0;
1115 uint32_t offset;
1116 struct pack_window *w_curs = NULL;
1118 if (allow_ofs_delta)
1119 i = write_reused_pack_verbatim(f, &w_curs);
1121 for (; i < reuse_packfile_bitmap->word_alloc; ++i) {
1122 eword_t word = reuse_packfile_bitmap->words[i];
1123 size_t pos = (i * BITS_IN_EWORD);
1125 for (offset = 0; offset < BITS_IN_EWORD; ++offset) {
1126 if ((word >> offset) == 0)
1127 break;
1129 offset += ewah_bit_ctz64(word >> offset);
1131 * Can use bit positions directly, even for MIDX
1132 * bitmaps. See comment in try_partial_reuse()
1133 * for why.
1135 write_reused_pack_one(pos + offset, f, &w_curs);
1136 display_progress(progress_state, ++written);
1140 unuse_pack(&w_curs);
1143 static void write_excluded_by_configs(void)
1145 struct oidset_iter iter;
1146 const struct object_id *oid;
1148 oidset_iter_init(&excluded_by_config, &iter);
1149 while ((oid = oidset_iter_next(&iter))) {
1150 struct configured_exclusion *ex =
1151 oidmap_get(&configured_exclusions, oid);
1153 if (!ex)
1154 BUG("configured exclusion wasn't configured");
1155 write_in_full(1, ex->pack_hash_hex, strlen(ex->pack_hash_hex));
1156 write_in_full(1, " ", 1);
1157 write_in_full(1, ex->uri, strlen(ex->uri));
1158 write_in_full(1, "\n", 1);
1162 static const char no_split_warning[] = N_(
1163 "disabling bitmap writing, packs are split due to pack.packSizeLimit"
1166 static void write_pack_file(void)
1168 uint32_t i = 0, j;
1169 struct hashfile *f;
1170 off_t offset;
1171 uint32_t nr_remaining = nr_result;
1172 time_t last_mtime = 0;
1173 struct object_entry **write_order;
1175 if (progress > pack_to_stdout)
1176 progress_state = start_progress(_("Writing objects"), nr_result);
1177 ALLOC_ARRAY(written_list, to_pack.nr_objects);
1178 write_order = compute_write_order();
1180 do {
1181 unsigned char hash[GIT_MAX_RAWSZ];
1182 char *pack_tmp_name = NULL;
1184 if (pack_to_stdout)
1185 f = hashfd_throughput(1, "<stdout>", progress_state);
1186 else
1187 f = create_tmp_packfile(&pack_tmp_name);
1189 offset = write_pack_header(f, nr_remaining);
1191 if (reuse_packfile) {
1192 assert(pack_to_stdout);
1193 write_reused_pack(f);
1194 offset = hashfile_total(f);
1197 nr_written = 0;
1198 for (; i < to_pack.nr_objects; i++) {
1199 struct object_entry *e = write_order[i];
1200 if (write_one(f, e, &offset) == WRITE_ONE_BREAK)
1201 break;
1202 display_progress(progress_state, written);
1205 if (pack_to_stdout) {
1207 * We never fsync when writing to stdout since we may
1208 * not be writing to an actual pack file. For instance,
1209 * the upload-pack code passes a pipe here. Calling
1210 * fsync on a pipe results in unnecessary
1211 * synchronization with the reader on some platforms.
1213 finalize_hashfile(f, hash, FSYNC_COMPONENT_NONE,
1214 CSUM_HASH_IN_STREAM | CSUM_CLOSE);
1215 } else if (nr_written == nr_remaining) {
1216 finalize_hashfile(f, hash, FSYNC_COMPONENT_PACK,
1217 CSUM_HASH_IN_STREAM | CSUM_FSYNC | CSUM_CLOSE);
1218 } else {
1220 * If we wrote the wrong number of entries in the
1221 * header, rewrite it like in fast-import.
1224 int fd = finalize_hashfile(f, hash, FSYNC_COMPONENT_PACK, 0);
1225 fixup_pack_header_footer(fd, hash, pack_tmp_name,
1226 nr_written, hash, offset);
1227 close(fd);
1228 if (write_bitmap_index) {
1229 if (write_bitmap_index != WRITE_BITMAP_QUIET)
1230 warning(_(no_split_warning));
1231 write_bitmap_index = 0;
1235 if (!pack_to_stdout) {
1236 struct stat st;
1237 struct strbuf tmpname = STRBUF_INIT;
1238 char *idx_tmp_name = NULL;
1241 * Packs are runtime accessed in their mtime
1242 * order since newer packs are more likely to contain
1243 * younger objects. So if we are creating multiple
1244 * packs then we should modify the mtime of later ones
1245 * to preserve this property.
1247 if (stat(pack_tmp_name, &st) < 0) {
1248 warning_errno(_("failed to stat %s"), pack_tmp_name);
1249 } else if (!last_mtime) {
1250 last_mtime = st.st_mtime;
1251 } else {
1252 struct utimbuf utb;
1253 utb.actime = st.st_atime;
1254 utb.modtime = --last_mtime;
1255 if (utime(pack_tmp_name, &utb) < 0)
1256 warning_errno(_("failed utime() on %s"), pack_tmp_name);
1259 strbuf_addf(&tmpname, "%s-%s.", base_name,
1260 hash_to_hex(hash));
1262 if (write_bitmap_index) {
1263 bitmap_writer_set_checksum(hash);
1264 bitmap_writer_build_type_index(
1265 &to_pack, written_list, nr_written);
1268 if (cruft)
1269 pack_idx_opts.flags |= WRITE_MTIMES;
1271 stage_tmp_packfiles(&tmpname, pack_tmp_name,
1272 written_list, nr_written,
1273 &to_pack, &pack_idx_opts, hash,
1274 &idx_tmp_name);
1276 if (write_bitmap_index) {
1277 size_t tmpname_len = tmpname.len;
1279 strbuf_addstr(&tmpname, "bitmap");
1280 stop_progress(&progress_state);
1282 bitmap_writer_show_progress(progress);
1283 bitmap_writer_select_commits(indexed_commits, indexed_commits_nr, -1);
1284 if (bitmap_writer_build(&to_pack) < 0)
1285 die(_("failed to write bitmap index"));
1286 bitmap_writer_finish(written_list, nr_written,
1287 tmpname.buf, write_bitmap_options);
1288 write_bitmap_index = 0;
1289 strbuf_setlen(&tmpname, tmpname_len);
1292 rename_tmp_packfile_idx(&tmpname, &idx_tmp_name);
1294 free(idx_tmp_name);
1295 strbuf_release(&tmpname);
1296 free(pack_tmp_name);
1297 puts(hash_to_hex(hash));
1300 /* mark written objects as written to previous pack */
1301 for (j = 0; j < nr_written; j++) {
1302 written_list[j]->offset = (off_t)-1;
1304 nr_remaining -= nr_written;
1305 } while (nr_remaining && i < to_pack.nr_objects);
1307 free(written_list);
1308 free(write_order);
1309 stop_progress(&progress_state);
1310 if (written != nr_result)
1311 die(_("wrote %"PRIu32" objects while expecting %"PRIu32),
1312 written, nr_result);
1313 trace2_data_intmax("pack-objects", the_repository,
1314 "write_pack_file/wrote", nr_result);
1317 static int no_try_delta(const char *path)
1319 static struct attr_check *check;
1321 if (!check)
1322 check = attr_check_initl("delta", NULL);
1323 git_check_attr(the_repository->index, NULL, path, check);
1324 if (ATTR_FALSE(check->items[0].value))
1325 return 1;
1326 return 0;
1330 * When adding an object, check whether we have already added it
1331 * to our packing list. If so, we can skip. However, if we are
1332 * being asked to excludei t, but the previous mention was to include
1333 * it, make sure to adjust its flags and tweak our numbers accordingly.
1335 * As an optimization, we pass out the index position where we would have
1336 * found the item, since that saves us from having to look it up again a
1337 * few lines later when we want to add the new entry.
1339 static int have_duplicate_entry(const struct object_id *oid,
1340 int exclude)
1342 struct object_entry *entry;
1344 if (reuse_packfile_bitmap &&
1345 bitmap_walk_contains(bitmap_git, reuse_packfile_bitmap, oid))
1346 return 1;
1348 entry = packlist_find(&to_pack, oid);
1349 if (!entry)
1350 return 0;
1352 if (exclude) {
1353 if (!entry->preferred_base)
1354 nr_result--;
1355 entry->preferred_base = 1;
1358 return 1;
1361 static int want_found_object(const struct object_id *oid, int exclude,
1362 struct packed_git *p)
1364 if (exclude)
1365 return 1;
1366 if (incremental)
1367 return 0;
1369 if (!is_pack_valid(p))
1370 return -1;
1373 * When asked to do --local (do not include an object that appears in a
1374 * pack we borrow from elsewhere) or --honor-pack-keep (do not include
1375 * an object that appears in a pack marked with .keep), finding a pack
1376 * that matches the criteria is sufficient for us to decide to omit it.
1377 * However, even if this pack does not satisfy the criteria, we need to
1378 * make sure no copy of this object appears in _any_ pack that makes us
1379 * to omit the object, so we need to check all the packs.
1381 * We can however first check whether these options can possibly matter;
1382 * if they do not matter we know we want the object in generated pack.
1383 * Otherwise, we signal "-1" at the end to tell the caller that we do
1384 * not know either way, and it needs to check more packs.
1388 * Objects in packs borrowed from elsewhere are discarded regardless of
1389 * if they appear in other packs that weren't borrowed.
1391 if (local && !p->pack_local)
1392 return 0;
1395 * Then handle .keep first, as we have a fast(er) path there.
1397 if (ignore_packed_keep_on_disk || ignore_packed_keep_in_core) {
1399 * Set the flags for the kept-pack cache to be the ones we want
1400 * to ignore.
1402 * That is, if we are ignoring objects in on-disk keep packs,
1403 * then we want to search through the on-disk keep and ignore
1404 * the in-core ones.
1406 unsigned flags = 0;
1407 if (ignore_packed_keep_on_disk)
1408 flags |= ON_DISK_KEEP_PACKS;
1409 if (ignore_packed_keep_in_core)
1410 flags |= IN_CORE_KEEP_PACKS;
1412 if (ignore_packed_keep_on_disk && p->pack_keep)
1413 return 0;
1414 if (ignore_packed_keep_in_core && p->pack_keep_in_core)
1415 return 0;
1416 if (has_object_kept_pack(oid, flags))
1417 return 0;
1421 * At this point we know definitively that either we don't care about
1422 * keep-packs, or the object is not in one. Keep checking other
1423 * conditions...
1425 if (!local || !have_non_local_packs)
1426 return 1;
1428 /* we don't know yet; keep looking for more packs */
1429 return -1;
1432 static int want_object_in_pack_one(struct packed_git *p,
1433 const struct object_id *oid,
1434 int exclude,
1435 struct packed_git **found_pack,
1436 off_t *found_offset)
1438 off_t offset;
1440 if (p == *found_pack)
1441 offset = *found_offset;
1442 else
1443 offset = find_pack_entry_one(oid->hash, p);
1445 if (offset) {
1446 if (!*found_pack) {
1447 if (!is_pack_valid(p))
1448 return -1;
1449 *found_offset = offset;
1450 *found_pack = p;
1452 return want_found_object(oid, exclude, p);
1454 return -1;
1458 * Check whether we want the object in the pack (e.g., we do not want
1459 * objects found in non-local stores if the "--local" option was used).
1461 * If the caller already knows an existing pack it wants to take the object
1462 * from, that is passed in *found_pack and *found_offset; otherwise this
1463 * function finds if there is any pack that has the object and returns the pack
1464 * and its offset in these variables.
1466 static int want_object_in_pack(const struct object_id *oid,
1467 int exclude,
1468 struct packed_git **found_pack,
1469 off_t *found_offset)
1471 int want;
1472 struct list_head *pos;
1473 struct multi_pack_index *m;
1475 if (!exclude && local && has_loose_object_nonlocal(oid))
1476 return 0;
1479 * If we already know the pack object lives in, start checks from that
1480 * pack - in the usual case when neither --local was given nor .keep files
1481 * are present we will determine the answer right now.
1483 if (*found_pack) {
1484 want = want_found_object(oid, exclude, *found_pack);
1485 if (want != -1)
1486 return want;
1488 *found_pack = NULL;
1489 *found_offset = 0;
1492 for (m = get_multi_pack_index(the_repository); m; m = m->next) {
1493 struct pack_entry e;
1494 if (fill_midx_entry(the_repository, oid, &e, m)) {
1495 want = want_object_in_pack_one(e.p, oid, exclude, found_pack, found_offset);
1496 if (want != -1)
1497 return want;
1501 list_for_each(pos, get_packed_git_mru(the_repository)) {
1502 struct packed_git *p = list_entry(pos, struct packed_git, mru);
1503 want = want_object_in_pack_one(p, oid, exclude, found_pack, found_offset);
1504 if (!exclude && want > 0)
1505 list_move(&p->mru,
1506 get_packed_git_mru(the_repository));
1507 if (want != -1)
1508 return want;
1511 if (uri_protocols.nr) {
1512 struct configured_exclusion *ex =
1513 oidmap_get(&configured_exclusions, oid);
1514 int i;
1515 const char *p;
1517 if (ex) {
1518 for (i = 0; i < uri_protocols.nr; i++) {
1519 if (skip_prefix(ex->uri,
1520 uri_protocols.items[i].string,
1521 &p) &&
1522 *p == ':') {
1523 oidset_insert(&excluded_by_config, oid);
1524 return 0;
1530 return 1;
1533 static struct object_entry *create_object_entry(const struct object_id *oid,
1534 enum object_type type,
1535 uint32_t hash,
1536 int exclude,
1537 int no_try_delta,
1538 struct packed_git *found_pack,
1539 off_t found_offset)
1541 struct object_entry *entry;
1543 entry = packlist_alloc(&to_pack, oid);
1544 entry->hash = hash;
1545 oe_set_type(entry, type);
1546 if (exclude)
1547 entry->preferred_base = 1;
1548 else
1549 nr_result++;
1550 if (found_pack) {
1551 oe_set_in_pack(&to_pack, entry, found_pack);
1552 entry->in_pack_offset = found_offset;
1555 entry->no_try_delta = no_try_delta;
1557 return entry;
1560 static const char no_closure_warning[] = N_(
1561 "disabling bitmap writing, as some objects are not being packed"
1564 static int add_object_entry(const struct object_id *oid, enum object_type type,
1565 const char *name, int exclude)
1567 struct packed_git *found_pack = NULL;
1568 off_t found_offset = 0;
1570 display_progress(progress_state, ++nr_seen);
1572 if (have_duplicate_entry(oid, exclude))
1573 return 0;
1575 if (!want_object_in_pack(oid, exclude, &found_pack, &found_offset)) {
1576 /* The pack is missing an object, so it will not have closure */
1577 if (write_bitmap_index) {
1578 if (write_bitmap_index != WRITE_BITMAP_QUIET)
1579 warning(_(no_closure_warning));
1580 write_bitmap_index = 0;
1582 return 0;
1585 create_object_entry(oid, type, pack_name_hash(name),
1586 exclude, name && no_try_delta(name),
1587 found_pack, found_offset);
1588 return 1;
1591 static int add_object_entry_from_bitmap(const struct object_id *oid,
1592 enum object_type type,
1593 int flags, uint32_t name_hash,
1594 struct packed_git *pack, off_t offset)
1596 display_progress(progress_state, ++nr_seen);
1598 if (have_duplicate_entry(oid, 0))
1599 return 0;
1601 if (!want_object_in_pack(oid, 0, &pack, &offset))
1602 return 0;
1604 create_object_entry(oid, type, name_hash, 0, 0, pack, offset);
1605 return 1;
1608 struct pbase_tree_cache {
1609 struct object_id oid;
1610 int ref;
1611 int temporary;
1612 void *tree_data;
1613 unsigned long tree_size;
1616 static struct pbase_tree_cache *(pbase_tree_cache[256]);
1617 static int pbase_tree_cache_ix(const struct object_id *oid)
1619 return oid->hash[0] % ARRAY_SIZE(pbase_tree_cache);
1621 static int pbase_tree_cache_ix_incr(int ix)
1623 return (ix+1) % ARRAY_SIZE(pbase_tree_cache);
1626 static struct pbase_tree {
1627 struct pbase_tree *next;
1628 /* This is a phony "cache" entry; we are not
1629 * going to evict it or find it through _get()
1630 * mechanism -- this is for the toplevel node that
1631 * would almost always change with any commit.
1633 struct pbase_tree_cache pcache;
1634 } *pbase_tree;
1636 static struct pbase_tree_cache *pbase_tree_get(const struct object_id *oid)
1638 struct pbase_tree_cache *ent, *nent;
1639 void *data;
1640 unsigned long size;
1641 enum object_type type;
1642 int neigh;
1643 int my_ix = pbase_tree_cache_ix(oid);
1644 int available_ix = -1;
1646 /* pbase-tree-cache acts as a limited hashtable.
1647 * your object will be found at your index or within a few
1648 * slots after that slot if it is cached.
1650 for (neigh = 0; neigh < 8; neigh++) {
1651 ent = pbase_tree_cache[my_ix];
1652 if (ent && oideq(&ent->oid, oid)) {
1653 ent->ref++;
1654 return ent;
1656 else if (((available_ix < 0) && (!ent || !ent->ref)) ||
1657 ((0 <= available_ix) &&
1658 (!ent && pbase_tree_cache[available_ix])))
1659 available_ix = my_ix;
1660 if (!ent)
1661 break;
1662 my_ix = pbase_tree_cache_ix_incr(my_ix);
1665 /* Did not find one. Either we got a bogus request or
1666 * we need to read and perhaps cache.
1668 data = read_object_file(oid, &type, &size);
1669 if (!data)
1670 return NULL;
1671 if (type != OBJ_TREE) {
1672 free(data);
1673 return NULL;
1676 /* We need to either cache or return a throwaway copy */
1678 if (available_ix < 0)
1679 ent = NULL;
1680 else {
1681 ent = pbase_tree_cache[available_ix];
1682 my_ix = available_ix;
1685 if (!ent) {
1686 nent = xmalloc(sizeof(*nent));
1687 nent->temporary = (available_ix < 0);
1689 else {
1690 /* evict and reuse */
1691 free(ent->tree_data);
1692 nent = ent;
1694 oidcpy(&nent->oid, oid);
1695 nent->tree_data = data;
1696 nent->tree_size = size;
1697 nent->ref = 1;
1698 if (!nent->temporary)
1699 pbase_tree_cache[my_ix] = nent;
1700 return nent;
1703 static void pbase_tree_put(struct pbase_tree_cache *cache)
1705 if (!cache->temporary) {
1706 cache->ref--;
1707 return;
1709 free(cache->tree_data);
1710 free(cache);
1713 static int name_cmp_len(const char *name)
1715 int i;
1716 for (i = 0; name[i] && name[i] != '\n' && name[i] != '/'; i++)
1718 return i;
1721 static void add_pbase_object(struct tree_desc *tree,
1722 const char *name,
1723 int cmplen,
1724 const char *fullname)
1726 struct name_entry entry;
1727 int cmp;
1729 while (tree_entry(tree,&entry)) {
1730 if (S_ISGITLINK(entry.mode))
1731 continue;
1732 cmp = tree_entry_len(&entry) != cmplen ? 1 :
1733 memcmp(name, entry.path, cmplen);
1734 if (cmp > 0)
1735 continue;
1736 if (cmp < 0)
1737 return;
1738 if (name[cmplen] != '/') {
1739 add_object_entry(&entry.oid,
1740 object_type(entry.mode),
1741 fullname, 1);
1742 return;
1744 if (S_ISDIR(entry.mode)) {
1745 struct tree_desc sub;
1746 struct pbase_tree_cache *tree;
1747 const char *down = name+cmplen+1;
1748 int downlen = name_cmp_len(down);
1750 tree = pbase_tree_get(&entry.oid);
1751 if (!tree)
1752 return;
1753 init_tree_desc(&sub, tree->tree_data, tree->tree_size);
1755 add_pbase_object(&sub, down, downlen, fullname);
1756 pbase_tree_put(tree);
1761 static unsigned *done_pbase_paths;
1762 static int done_pbase_paths_num;
1763 static int done_pbase_paths_alloc;
1764 static int done_pbase_path_pos(unsigned hash)
1766 int lo = 0;
1767 int hi = done_pbase_paths_num;
1768 while (lo < hi) {
1769 int mi = lo + (hi - lo) / 2;
1770 if (done_pbase_paths[mi] == hash)
1771 return mi;
1772 if (done_pbase_paths[mi] < hash)
1773 hi = mi;
1774 else
1775 lo = mi + 1;
1777 return -lo-1;
1780 static int check_pbase_path(unsigned hash)
1782 int pos = done_pbase_path_pos(hash);
1783 if (0 <= pos)
1784 return 1;
1785 pos = -pos - 1;
1786 ALLOC_GROW(done_pbase_paths,
1787 done_pbase_paths_num + 1,
1788 done_pbase_paths_alloc);
1789 done_pbase_paths_num++;
1790 if (pos < done_pbase_paths_num)
1791 MOVE_ARRAY(done_pbase_paths + pos + 1, done_pbase_paths + pos,
1792 done_pbase_paths_num - pos - 1);
1793 done_pbase_paths[pos] = hash;
1794 return 0;
1797 static void add_preferred_base_object(const char *name)
1799 struct pbase_tree *it;
1800 int cmplen;
1801 unsigned hash = pack_name_hash(name);
1803 if (!num_preferred_base || check_pbase_path(hash))
1804 return;
1806 cmplen = name_cmp_len(name);
1807 for (it = pbase_tree; it; it = it->next) {
1808 if (cmplen == 0) {
1809 add_object_entry(&it->pcache.oid, OBJ_TREE, NULL, 1);
1811 else {
1812 struct tree_desc tree;
1813 init_tree_desc(&tree, it->pcache.tree_data, it->pcache.tree_size);
1814 add_pbase_object(&tree, name, cmplen, name);
1819 static void add_preferred_base(struct object_id *oid)
1821 struct pbase_tree *it;
1822 void *data;
1823 unsigned long size;
1824 struct object_id tree_oid;
1826 if (window <= num_preferred_base++)
1827 return;
1829 data = read_object_with_reference(the_repository, oid,
1830 OBJ_TREE, &size, &tree_oid);
1831 if (!data)
1832 return;
1834 for (it = pbase_tree; it; it = it->next) {
1835 if (oideq(&it->pcache.oid, &tree_oid)) {
1836 free(data);
1837 return;
1841 CALLOC_ARRAY(it, 1);
1842 it->next = pbase_tree;
1843 pbase_tree = it;
1845 oidcpy(&it->pcache.oid, &tree_oid);
1846 it->pcache.tree_data = data;
1847 it->pcache.tree_size = size;
1850 static void cleanup_preferred_base(void)
1852 struct pbase_tree *it;
1853 unsigned i;
1855 it = pbase_tree;
1856 pbase_tree = NULL;
1857 while (it) {
1858 struct pbase_tree *tmp = it;
1859 it = tmp->next;
1860 free(tmp->pcache.tree_data);
1861 free(tmp);
1864 for (i = 0; i < ARRAY_SIZE(pbase_tree_cache); i++) {
1865 if (!pbase_tree_cache[i])
1866 continue;
1867 free(pbase_tree_cache[i]->tree_data);
1868 FREE_AND_NULL(pbase_tree_cache[i]);
1871 FREE_AND_NULL(done_pbase_paths);
1872 done_pbase_paths_num = done_pbase_paths_alloc = 0;
1876 * Return 1 iff the object specified by "delta" can be sent
1877 * literally as a delta against the base in "base_sha1". If
1878 * so, then *base_out will point to the entry in our packing
1879 * list, or NULL if we must use the external-base list.
1881 * Depth value does not matter - find_deltas() will
1882 * never consider reused delta as the base object to
1883 * deltify other objects against, in order to avoid
1884 * circular deltas.
1886 static int can_reuse_delta(const struct object_id *base_oid,
1887 struct object_entry *delta,
1888 struct object_entry **base_out)
1890 struct object_entry *base;
1893 * First see if we're already sending the base (or it's explicitly in
1894 * our "excluded" list).
1896 base = packlist_find(&to_pack, base_oid);
1897 if (base) {
1898 if (!in_same_island(&delta->idx.oid, &base->idx.oid))
1899 return 0;
1900 *base_out = base;
1901 return 1;
1905 * Otherwise, reachability bitmaps may tell us if the receiver has it,
1906 * even if it was buried too deep in history to make it into the
1907 * packing list.
1909 if (thin && bitmap_has_oid_in_uninteresting(bitmap_git, base_oid)) {
1910 if (use_delta_islands) {
1911 if (!in_same_island(&delta->idx.oid, base_oid))
1912 return 0;
1914 *base_out = NULL;
1915 return 1;
1918 return 0;
1921 static void prefetch_to_pack(uint32_t object_index_start) {
1922 struct oid_array to_fetch = OID_ARRAY_INIT;
1923 uint32_t i;
1925 for (i = object_index_start; i < to_pack.nr_objects; i++) {
1926 struct object_entry *entry = to_pack.objects + i;
1928 if (!oid_object_info_extended(the_repository,
1929 &entry->idx.oid,
1930 NULL,
1931 OBJECT_INFO_FOR_PREFETCH))
1932 continue;
1933 oid_array_append(&to_fetch, &entry->idx.oid);
1935 promisor_remote_get_direct(the_repository,
1936 to_fetch.oid, to_fetch.nr);
1937 oid_array_clear(&to_fetch);
1940 static void check_object(struct object_entry *entry, uint32_t object_index)
1942 unsigned long canonical_size;
1943 enum object_type type;
1944 struct object_info oi = {.typep = &type, .sizep = &canonical_size};
1946 if (IN_PACK(entry)) {
1947 struct packed_git *p = IN_PACK(entry);
1948 struct pack_window *w_curs = NULL;
1949 int have_base = 0;
1950 struct object_id base_ref;
1951 struct object_entry *base_entry;
1952 unsigned long used, used_0;
1953 unsigned long avail;
1954 off_t ofs;
1955 unsigned char *buf, c;
1956 enum object_type type;
1957 unsigned long in_pack_size;
1959 buf = use_pack(p, &w_curs, entry->in_pack_offset, &avail);
1962 * We want in_pack_type even if we do not reuse delta
1963 * since non-delta representations could still be reused.
1965 used = unpack_object_header_buffer(buf, avail,
1966 &type,
1967 &in_pack_size);
1968 if (used == 0)
1969 goto give_up;
1971 if (type < 0)
1972 BUG("invalid type %d", type);
1973 entry->in_pack_type = type;
1976 * Determine if this is a delta and if so whether we can
1977 * reuse it or not. Otherwise let's find out as cheaply as
1978 * possible what the actual type and size for this object is.
1980 switch (entry->in_pack_type) {
1981 default:
1982 /* Not a delta hence we've already got all we need. */
1983 oe_set_type(entry, entry->in_pack_type);
1984 SET_SIZE(entry, in_pack_size);
1985 entry->in_pack_header_size = used;
1986 if (oe_type(entry) < OBJ_COMMIT || oe_type(entry) > OBJ_BLOB)
1987 goto give_up;
1988 unuse_pack(&w_curs);
1989 return;
1990 case OBJ_REF_DELTA:
1991 if (reuse_delta && !entry->preferred_base) {
1992 oidread(&base_ref,
1993 use_pack(p, &w_curs,
1994 entry->in_pack_offset + used,
1995 NULL));
1996 have_base = 1;
1998 entry->in_pack_header_size = used + the_hash_algo->rawsz;
1999 break;
2000 case OBJ_OFS_DELTA:
2001 buf = use_pack(p, &w_curs,
2002 entry->in_pack_offset + used, NULL);
2003 used_0 = 0;
2004 c = buf[used_0++];
2005 ofs = c & 127;
2006 while (c & 128) {
2007 ofs += 1;
2008 if (!ofs || MSB(ofs, 7)) {
2009 error(_("delta base offset overflow in pack for %s"),
2010 oid_to_hex(&entry->idx.oid));
2011 goto give_up;
2013 c = buf[used_0++];
2014 ofs = (ofs << 7) + (c & 127);
2016 ofs = entry->in_pack_offset - ofs;
2017 if (ofs <= 0 || ofs >= entry->in_pack_offset) {
2018 error(_("delta base offset out of bound for %s"),
2019 oid_to_hex(&entry->idx.oid));
2020 goto give_up;
2022 if (reuse_delta && !entry->preferred_base) {
2023 uint32_t pos;
2024 if (offset_to_pack_pos(p, ofs, &pos) < 0)
2025 goto give_up;
2026 if (!nth_packed_object_id(&base_ref, p,
2027 pack_pos_to_index(p, pos)))
2028 have_base = 1;
2030 entry->in_pack_header_size = used + used_0;
2031 break;
2034 if (have_base &&
2035 can_reuse_delta(&base_ref, entry, &base_entry)) {
2036 oe_set_type(entry, entry->in_pack_type);
2037 SET_SIZE(entry, in_pack_size); /* delta size */
2038 SET_DELTA_SIZE(entry, in_pack_size);
2040 if (base_entry) {
2041 SET_DELTA(entry, base_entry);
2042 entry->delta_sibling_idx = base_entry->delta_child_idx;
2043 SET_DELTA_CHILD(base_entry, entry);
2044 } else {
2045 SET_DELTA_EXT(entry, &base_ref);
2048 unuse_pack(&w_curs);
2049 return;
2052 if (oe_type(entry)) {
2053 off_t delta_pos;
2056 * This must be a delta and we already know what the
2057 * final object type is. Let's extract the actual
2058 * object size from the delta header.
2060 delta_pos = entry->in_pack_offset + entry->in_pack_header_size;
2061 canonical_size = get_size_from_delta(p, &w_curs, delta_pos);
2062 if (canonical_size == 0)
2063 goto give_up;
2064 SET_SIZE(entry, canonical_size);
2065 unuse_pack(&w_curs);
2066 return;
2070 * No choice but to fall back to the recursive delta walk
2071 * with oid_object_info() to find about the object type
2072 * at this point...
2074 give_up:
2075 unuse_pack(&w_curs);
2078 if (oid_object_info_extended(the_repository, &entry->idx.oid, &oi,
2079 OBJECT_INFO_SKIP_FETCH_OBJECT | OBJECT_INFO_LOOKUP_REPLACE) < 0) {
2080 if (has_promisor_remote()) {
2081 prefetch_to_pack(object_index);
2082 if (oid_object_info_extended(the_repository, &entry->idx.oid, &oi,
2083 OBJECT_INFO_SKIP_FETCH_OBJECT | OBJECT_INFO_LOOKUP_REPLACE) < 0)
2084 type = -1;
2085 } else {
2086 type = -1;
2089 oe_set_type(entry, type);
2090 if (entry->type_valid) {
2091 SET_SIZE(entry, canonical_size);
2092 } else {
2094 * Bad object type is checked in prepare_pack(). This is
2095 * to permit a missing preferred base object to be ignored
2096 * as a preferred base. Doing so can result in a larger
2097 * pack file, but the transfer will still take place.
2102 static int pack_offset_sort(const void *_a, const void *_b)
2104 const struct object_entry *a = *(struct object_entry **)_a;
2105 const struct object_entry *b = *(struct object_entry **)_b;
2106 const struct packed_git *a_in_pack = IN_PACK(a);
2107 const struct packed_git *b_in_pack = IN_PACK(b);
2109 /* avoid filesystem trashing with loose objects */
2110 if (!a_in_pack && !b_in_pack)
2111 return oidcmp(&a->idx.oid, &b->idx.oid);
2113 if (a_in_pack < b_in_pack)
2114 return -1;
2115 if (a_in_pack > b_in_pack)
2116 return 1;
2117 return a->in_pack_offset < b->in_pack_offset ? -1 :
2118 (a->in_pack_offset > b->in_pack_offset);
2122 * Drop an on-disk delta we were planning to reuse. Naively, this would
2123 * just involve blanking out the "delta" field, but we have to deal
2124 * with some extra book-keeping:
2126 * 1. Removing ourselves from the delta_sibling linked list.
2128 * 2. Updating our size/type to the non-delta representation. These were
2129 * either not recorded initially (size) or overwritten with the delta type
2130 * (type) when check_object() decided to reuse the delta.
2132 * 3. Resetting our delta depth, as we are now a base object.
2134 static void drop_reused_delta(struct object_entry *entry)
2136 unsigned *idx = &to_pack.objects[entry->delta_idx - 1].delta_child_idx;
2137 struct object_info oi = OBJECT_INFO_INIT;
2138 enum object_type type;
2139 unsigned long size;
2141 while (*idx) {
2142 struct object_entry *oe = &to_pack.objects[*idx - 1];
2144 if (oe == entry)
2145 *idx = oe->delta_sibling_idx;
2146 else
2147 idx = &oe->delta_sibling_idx;
2149 SET_DELTA(entry, NULL);
2150 entry->depth = 0;
2152 oi.sizep = &size;
2153 oi.typep = &type;
2154 if (packed_object_info(the_repository, IN_PACK(entry), entry->in_pack_offset, &oi) < 0) {
2156 * We failed to get the info from this pack for some reason;
2157 * fall back to oid_object_info, which may find another copy.
2158 * And if that fails, the error will be recorded in oe_type(entry)
2159 * and dealt with in prepare_pack().
2161 oe_set_type(entry,
2162 oid_object_info(the_repository, &entry->idx.oid, &size));
2163 } else {
2164 oe_set_type(entry, type);
2166 SET_SIZE(entry, size);
2170 * Follow the chain of deltas from this entry onward, throwing away any links
2171 * that cause us to hit a cycle (as determined by the DFS state flags in
2172 * the entries).
2174 * We also detect too-long reused chains that would violate our --depth
2175 * limit.
2177 static void break_delta_chains(struct object_entry *entry)
2180 * The actual depth of each object we will write is stored as an int,
2181 * as it cannot exceed our int "depth" limit. But before we break
2182 * changes based no that limit, we may potentially go as deep as the
2183 * number of objects, which is elsewhere bounded to a uint32_t.
2185 uint32_t total_depth;
2186 struct object_entry *cur, *next;
2188 for (cur = entry, total_depth = 0;
2189 cur;
2190 cur = DELTA(cur), total_depth++) {
2191 if (cur->dfs_state == DFS_DONE) {
2193 * We've already seen this object and know it isn't
2194 * part of a cycle. We do need to append its depth
2195 * to our count.
2197 total_depth += cur->depth;
2198 break;
2202 * We break cycles before looping, so an ACTIVE state (or any
2203 * other cruft which made its way into the state variable)
2204 * is a bug.
2206 if (cur->dfs_state != DFS_NONE)
2207 BUG("confusing delta dfs state in first pass: %d",
2208 cur->dfs_state);
2211 * Now we know this is the first time we've seen the object. If
2212 * it's not a delta, we're done traversing, but we'll mark it
2213 * done to save time on future traversals.
2215 if (!DELTA(cur)) {
2216 cur->dfs_state = DFS_DONE;
2217 break;
2221 * Mark ourselves as active and see if the next step causes
2222 * us to cycle to another active object. It's important to do
2223 * this _before_ we loop, because it impacts where we make the
2224 * cut, and thus how our total_depth counter works.
2225 * E.g., We may see a partial loop like:
2227 * A -> B -> C -> D -> B
2229 * Cutting B->C breaks the cycle. But now the depth of A is
2230 * only 1, and our total_depth counter is at 3. The size of the
2231 * error is always one less than the size of the cycle we
2232 * broke. Commits C and D were "lost" from A's chain.
2234 * If we instead cut D->B, then the depth of A is correct at 3.
2235 * We keep all commits in the chain that we examined.
2237 cur->dfs_state = DFS_ACTIVE;
2238 if (DELTA(cur)->dfs_state == DFS_ACTIVE) {
2239 drop_reused_delta(cur);
2240 cur->dfs_state = DFS_DONE;
2241 break;
2246 * And now that we've gone all the way to the bottom of the chain, we
2247 * need to clear the active flags and set the depth fields as
2248 * appropriate. Unlike the loop above, which can quit when it drops a
2249 * delta, we need to keep going to look for more depth cuts. So we need
2250 * an extra "next" pointer to keep going after we reset cur->delta.
2252 for (cur = entry; cur; cur = next) {
2253 next = DELTA(cur);
2256 * We should have a chain of zero or more ACTIVE states down to
2257 * a final DONE. We can quit after the DONE, because either it
2258 * has no bases, or we've already handled them in a previous
2259 * call.
2261 if (cur->dfs_state == DFS_DONE)
2262 break;
2263 else if (cur->dfs_state != DFS_ACTIVE)
2264 BUG("confusing delta dfs state in second pass: %d",
2265 cur->dfs_state);
2268 * If the total_depth is more than depth, then we need to snip
2269 * the chain into two or more smaller chains that don't exceed
2270 * the maximum depth. Most of the resulting chains will contain
2271 * (depth + 1) entries (i.e., depth deltas plus one base), and
2272 * the last chain (i.e., the one containing entry) will contain
2273 * whatever entries are left over, namely
2274 * (total_depth % (depth + 1)) of them.
2276 * Since we are iterating towards decreasing depth, we need to
2277 * decrement total_depth as we go, and we need to write to the
2278 * entry what its final depth will be after all of the
2279 * snipping. Since we're snipping into chains of length (depth
2280 * + 1) entries, the final depth of an entry will be its
2281 * original depth modulo (depth + 1). Any time we encounter an
2282 * entry whose final depth is supposed to be zero, we snip it
2283 * from its delta base, thereby making it so.
2285 cur->depth = (total_depth--) % (depth + 1);
2286 if (!cur->depth)
2287 drop_reused_delta(cur);
2289 cur->dfs_state = DFS_DONE;
2293 static void get_object_details(void)
2295 uint32_t i;
2296 struct object_entry **sorted_by_offset;
2298 if (progress)
2299 progress_state = start_progress(_("Counting objects"),
2300 to_pack.nr_objects);
2302 CALLOC_ARRAY(sorted_by_offset, to_pack.nr_objects);
2303 for (i = 0; i < to_pack.nr_objects; i++)
2304 sorted_by_offset[i] = to_pack.objects + i;
2305 QSORT(sorted_by_offset, to_pack.nr_objects, pack_offset_sort);
2307 for (i = 0; i < to_pack.nr_objects; i++) {
2308 struct object_entry *entry = sorted_by_offset[i];
2309 check_object(entry, i);
2310 if (entry->type_valid &&
2311 oe_size_greater_than(&to_pack, entry, big_file_threshold))
2312 entry->no_try_delta = 1;
2313 display_progress(progress_state, i + 1);
2315 stop_progress(&progress_state);
2318 * This must happen in a second pass, since we rely on the delta
2319 * information for the whole list being completed.
2321 for (i = 0; i < to_pack.nr_objects; i++)
2322 break_delta_chains(&to_pack.objects[i]);
2324 free(sorted_by_offset);
2328 * We search for deltas in a list sorted by type, by filename hash, and then
2329 * by size, so that we see progressively smaller and smaller files.
2330 * That's because we prefer deltas to be from the bigger file
2331 * to the smaller -- deletes are potentially cheaper, but perhaps
2332 * more importantly, the bigger file is likely the more recent
2333 * one. The deepest deltas are therefore the oldest objects which are
2334 * less susceptible to be accessed often.
2336 static int type_size_sort(const void *_a, const void *_b)
2338 const struct object_entry *a = *(struct object_entry **)_a;
2339 const struct object_entry *b = *(struct object_entry **)_b;
2340 const enum object_type a_type = oe_type(a);
2341 const enum object_type b_type = oe_type(b);
2342 const unsigned long a_size = SIZE(a);
2343 const unsigned long b_size = SIZE(b);
2345 if (a_type > b_type)
2346 return -1;
2347 if (a_type < b_type)
2348 return 1;
2349 if (a->hash > b->hash)
2350 return -1;
2351 if (a->hash < b->hash)
2352 return 1;
2353 if (a->preferred_base > b->preferred_base)
2354 return -1;
2355 if (a->preferred_base < b->preferred_base)
2356 return 1;
2357 if (use_delta_islands) {
2358 const int island_cmp = island_delta_cmp(&a->idx.oid, &b->idx.oid);
2359 if (island_cmp)
2360 return island_cmp;
2362 if (a_size > b_size)
2363 return -1;
2364 if (a_size < b_size)
2365 return 1;
2366 return a < b ? -1 : (a > b); /* newest first */
2369 struct unpacked {
2370 struct object_entry *entry;
2371 void *data;
2372 struct delta_index *index;
2373 unsigned depth;
2376 static int delta_cacheable(unsigned long src_size, unsigned long trg_size,
2377 unsigned long delta_size)
2379 if (max_delta_cache_size && delta_cache_size + delta_size > max_delta_cache_size)
2380 return 0;
2382 if (delta_size < cache_max_small_delta_size)
2383 return 1;
2385 /* cache delta, if objects are large enough compared to delta size */
2386 if ((src_size >> 20) + (trg_size >> 21) > (delta_size >> 10))
2387 return 1;
2389 return 0;
2392 /* Protect delta_cache_size */
2393 static pthread_mutex_t cache_mutex;
2394 #define cache_lock() pthread_mutex_lock(&cache_mutex)
2395 #define cache_unlock() pthread_mutex_unlock(&cache_mutex)
2398 * Protect object list partitioning (e.g. struct thread_param) and
2399 * progress_state
2401 static pthread_mutex_t progress_mutex;
2402 #define progress_lock() pthread_mutex_lock(&progress_mutex)
2403 #define progress_unlock() pthread_mutex_unlock(&progress_mutex)
2406 * Access to struct object_entry is unprotected since each thread owns
2407 * a portion of the main object list. Just don't access object entries
2408 * ahead in the list because they can be stolen and would need
2409 * progress_mutex for protection.
2412 static inline int oe_size_less_than(struct packing_data *pack,
2413 const struct object_entry *lhs,
2414 unsigned long rhs)
2416 if (lhs->size_valid)
2417 return lhs->size_ < rhs;
2418 if (rhs < pack->oe_size_limit) /* rhs < 2^x <= lhs ? */
2419 return 0;
2420 return oe_get_size_slow(pack, lhs) < rhs;
2423 static inline void oe_set_tree_depth(struct packing_data *pack,
2424 struct object_entry *e,
2425 unsigned int tree_depth)
2427 if (!pack->tree_depth)
2428 CALLOC_ARRAY(pack->tree_depth, pack->nr_alloc);
2429 pack->tree_depth[e - pack->objects] = tree_depth;
2433 * Return the size of the object without doing any delta
2434 * reconstruction (so non-deltas are true object sizes, but deltas
2435 * return the size of the delta data).
2437 unsigned long oe_get_size_slow(struct packing_data *pack,
2438 const struct object_entry *e)
2440 struct packed_git *p;
2441 struct pack_window *w_curs;
2442 unsigned char *buf;
2443 enum object_type type;
2444 unsigned long used, avail, size;
2446 if (e->type_ != OBJ_OFS_DELTA && e->type_ != OBJ_REF_DELTA) {
2447 packing_data_lock(&to_pack);
2448 if (oid_object_info(the_repository, &e->idx.oid, &size) < 0)
2449 die(_("unable to get size of %s"),
2450 oid_to_hex(&e->idx.oid));
2451 packing_data_unlock(&to_pack);
2452 return size;
2455 p = oe_in_pack(pack, e);
2456 if (!p)
2457 BUG("when e->type is a delta, it must belong to a pack");
2459 packing_data_lock(&to_pack);
2460 w_curs = NULL;
2461 buf = use_pack(p, &w_curs, e->in_pack_offset, &avail);
2462 used = unpack_object_header_buffer(buf, avail, &type, &size);
2463 if (used == 0)
2464 die(_("unable to parse object header of %s"),
2465 oid_to_hex(&e->idx.oid));
2467 unuse_pack(&w_curs);
2468 packing_data_unlock(&to_pack);
2469 return size;
2472 static int try_delta(struct unpacked *trg, struct unpacked *src,
2473 unsigned max_depth, unsigned long *mem_usage)
2475 struct object_entry *trg_entry = trg->entry;
2476 struct object_entry *src_entry = src->entry;
2477 unsigned long trg_size, src_size, delta_size, sizediff, max_size, sz;
2478 unsigned ref_depth;
2479 enum object_type type;
2480 void *delta_buf;
2482 /* Don't bother doing diffs between different types */
2483 if (oe_type(trg_entry) != oe_type(src_entry))
2484 return -1;
2487 * We do not bother to try a delta that we discarded on an
2488 * earlier try, but only when reusing delta data. Note that
2489 * src_entry that is marked as the preferred_base should always
2490 * be considered, as even if we produce a suboptimal delta against
2491 * it, we will still save the transfer cost, as we already know
2492 * the other side has it and we won't send src_entry at all.
2494 if (reuse_delta && IN_PACK(trg_entry) &&
2495 IN_PACK(trg_entry) == IN_PACK(src_entry) &&
2496 !src_entry->preferred_base &&
2497 trg_entry->in_pack_type != OBJ_REF_DELTA &&
2498 trg_entry->in_pack_type != OBJ_OFS_DELTA)
2499 return 0;
2501 /* Let's not bust the allowed depth. */
2502 if (src->depth >= max_depth)
2503 return 0;
2505 /* Now some size filtering heuristics. */
2506 trg_size = SIZE(trg_entry);
2507 if (!DELTA(trg_entry)) {
2508 max_size = trg_size/2 - the_hash_algo->rawsz;
2509 ref_depth = 1;
2510 } else {
2511 max_size = DELTA_SIZE(trg_entry);
2512 ref_depth = trg->depth;
2514 max_size = (uint64_t)max_size * (max_depth - src->depth) /
2515 (max_depth - ref_depth + 1);
2516 if (max_size == 0)
2517 return 0;
2518 src_size = SIZE(src_entry);
2519 sizediff = src_size < trg_size ? trg_size - src_size : 0;
2520 if (sizediff >= max_size)
2521 return 0;
2522 if (trg_size < src_size / 32)
2523 return 0;
2525 if (!in_same_island(&trg->entry->idx.oid, &src->entry->idx.oid))
2526 return 0;
2528 /* Load data if not already done */
2529 if (!trg->data) {
2530 packing_data_lock(&to_pack);
2531 trg->data = read_object_file(&trg_entry->idx.oid, &type, &sz);
2532 packing_data_unlock(&to_pack);
2533 if (!trg->data)
2534 die(_("object %s cannot be read"),
2535 oid_to_hex(&trg_entry->idx.oid));
2536 if (sz != trg_size)
2537 die(_("object %s inconsistent object length (%"PRIuMAX" vs %"PRIuMAX")"),
2538 oid_to_hex(&trg_entry->idx.oid), (uintmax_t)sz,
2539 (uintmax_t)trg_size);
2540 *mem_usage += sz;
2542 if (!src->data) {
2543 packing_data_lock(&to_pack);
2544 src->data = read_object_file(&src_entry->idx.oid, &type, &sz);
2545 packing_data_unlock(&to_pack);
2546 if (!src->data) {
2547 if (src_entry->preferred_base) {
2548 static int warned = 0;
2549 if (!warned++)
2550 warning(_("object %s cannot be read"),
2551 oid_to_hex(&src_entry->idx.oid));
2553 * Those objects are not included in the
2554 * resulting pack. Be resilient and ignore
2555 * them if they can't be read, in case the
2556 * pack could be created nevertheless.
2558 return 0;
2560 die(_("object %s cannot be read"),
2561 oid_to_hex(&src_entry->idx.oid));
2563 if (sz != src_size)
2564 die(_("object %s inconsistent object length (%"PRIuMAX" vs %"PRIuMAX")"),
2565 oid_to_hex(&src_entry->idx.oid), (uintmax_t)sz,
2566 (uintmax_t)src_size);
2567 *mem_usage += sz;
2569 if (!src->index) {
2570 src->index = create_delta_index(src->data, src_size);
2571 if (!src->index) {
2572 static int warned = 0;
2573 if (!warned++)
2574 warning(_("suboptimal pack - out of memory"));
2575 return 0;
2577 *mem_usage += sizeof_delta_index(src->index);
2580 delta_buf = create_delta(src->index, trg->data, trg_size, &delta_size, max_size);
2581 if (!delta_buf)
2582 return 0;
2584 if (DELTA(trg_entry)) {
2585 /* Prefer only shallower same-sized deltas. */
2586 if (delta_size == DELTA_SIZE(trg_entry) &&
2587 src->depth + 1 >= trg->depth) {
2588 free(delta_buf);
2589 return 0;
2594 * Handle memory allocation outside of the cache
2595 * accounting lock. Compiler will optimize the strangeness
2596 * away when NO_PTHREADS is defined.
2598 free(trg_entry->delta_data);
2599 cache_lock();
2600 if (trg_entry->delta_data) {
2601 delta_cache_size -= DELTA_SIZE(trg_entry);
2602 trg_entry->delta_data = NULL;
2604 if (delta_cacheable(src_size, trg_size, delta_size)) {
2605 delta_cache_size += delta_size;
2606 cache_unlock();
2607 trg_entry->delta_data = xrealloc(delta_buf, delta_size);
2608 } else {
2609 cache_unlock();
2610 free(delta_buf);
2613 SET_DELTA(trg_entry, src_entry);
2614 SET_DELTA_SIZE(trg_entry, delta_size);
2615 trg->depth = src->depth + 1;
2617 return 1;
2620 static unsigned int check_delta_limit(struct object_entry *me, unsigned int n)
2622 struct object_entry *child = DELTA_CHILD(me);
2623 unsigned int m = n;
2624 while (child) {
2625 const unsigned int c = check_delta_limit(child, n + 1);
2626 if (m < c)
2627 m = c;
2628 child = DELTA_SIBLING(child);
2630 return m;
2633 static unsigned long free_unpacked(struct unpacked *n)
2635 unsigned long freed_mem = sizeof_delta_index(n->index);
2636 free_delta_index(n->index);
2637 n->index = NULL;
2638 if (n->data) {
2639 freed_mem += SIZE(n->entry);
2640 FREE_AND_NULL(n->data);
2642 n->entry = NULL;
2643 n->depth = 0;
2644 return freed_mem;
2647 static void find_deltas(struct object_entry **list, unsigned *list_size,
2648 int window, int depth, unsigned *processed)
2650 uint32_t i, idx = 0, count = 0;
2651 struct unpacked *array;
2652 unsigned long mem_usage = 0;
2654 CALLOC_ARRAY(array, window);
2656 for (;;) {
2657 struct object_entry *entry;
2658 struct unpacked *n = array + idx;
2659 int j, max_depth, best_base = -1;
2661 progress_lock();
2662 if (!*list_size) {
2663 progress_unlock();
2664 break;
2666 entry = *list++;
2667 (*list_size)--;
2668 if (!entry->preferred_base) {
2669 (*processed)++;
2670 display_progress(progress_state, *processed);
2672 progress_unlock();
2674 mem_usage -= free_unpacked(n);
2675 n->entry = entry;
2677 while (window_memory_limit &&
2678 mem_usage > window_memory_limit &&
2679 count > 1) {
2680 const uint32_t tail = (idx + window - count) % window;
2681 mem_usage -= free_unpacked(array + tail);
2682 count--;
2685 /* We do not compute delta to *create* objects we are not
2686 * going to pack.
2688 if (entry->preferred_base)
2689 goto next;
2692 * If the current object is at pack edge, take the depth the
2693 * objects that depend on the current object into account
2694 * otherwise they would become too deep.
2696 max_depth = depth;
2697 if (DELTA_CHILD(entry)) {
2698 max_depth -= check_delta_limit(entry, 0);
2699 if (max_depth <= 0)
2700 goto next;
2703 j = window;
2704 while (--j > 0) {
2705 int ret;
2706 uint32_t other_idx = idx + j;
2707 struct unpacked *m;
2708 if (other_idx >= window)
2709 other_idx -= window;
2710 m = array + other_idx;
2711 if (!m->entry)
2712 break;
2713 ret = try_delta(n, m, max_depth, &mem_usage);
2714 if (ret < 0)
2715 break;
2716 else if (ret > 0)
2717 best_base = other_idx;
2721 * If we decided to cache the delta data, then it is best
2722 * to compress it right away. First because we have to do
2723 * it anyway, and doing it here while we're threaded will
2724 * save a lot of time in the non threaded write phase,
2725 * as well as allow for caching more deltas within
2726 * the same cache size limit.
2727 * ...
2728 * But only if not writing to stdout, since in that case
2729 * the network is most likely throttling writes anyway,
2730 * and therefore it is best to go to the write phase ASAP
2731 * instead, as we can afford spending more time compressing
2732 * between writes at that moment.
2734 if (entry->delta_data && !pack_to_stdout) {
2735 unsigned long size;
2737 size = do_compress(&entry->delta_data, DELTA_SIZE(entry));
2738 if (size < (1U << OE_Z_DELTA_BITS)) {
2739 entry->z_delta_size = size;
2740 cache_lock();
2741 delta_cache_size -= DELTA_SIZE(entry);
2742 delta_cache_size += entry->z_delta_size;
2743 cache_unlock();
2744 } else {
2745 FREE_AND_NULL(entry->delta_data);
2746 entry->z_delta_size = 0;
2750 /* if we made n a delta, and if n is already at max
2751 * depth, leaving it in the window is pointless. we
2752 * should evict it first.
2754 if (DELTA(entry) && max_depth <= n->depth)
2755 continue;
2758 * Move the best delta base up in the window, after the
2759 * currently deltified object, to keep it longer. It will
2760 * be the first base object to be attempted next.
2762 if (DELTA(entry)) {
2763 struct unpacked swap = array[best_base];
2764 int dist = (window + idx - best_base) % window;
2765 int dst = best_base;
2766 while (dist--) {
2767 int src = (dst + 1) % window;
2768 array[dst] = array[src];
2769 dst = src;
2771 array[dst] = swap;
2774 next:
2775 idx++;
2776 if (count + 1 < window)
2777 count++;
2778 if (idx >= window)
2779 idx = 0;
2782 for (i = 0; i < window; ++i) {
2783 free_delta_index(array[i].index);
2784 free(array[i].data);
2786 free(array);
2790 * The main object list is split into smaller lists, each is handed to
2791 * one worker.
2793 * The main thread waits on the condition that (at least) one of the workers
2794 * has stopped working (which is indicated in the .working member of
2795 * struct thread_params).
2797 * When a work thread has completed its work, it sets .working to 0 and
2798 * signals the main thread and waits on the condition that .data_ready
2799 * becomes 1.
2801 * The main thread steals half of the work from the worker that has
2802 * most work left to hand it to the idle worker.
2805 struct thread_params {
2806 pthread_t thread;
2807 struct object_entry **list;
2808 unsigned list_size;
2809 unsigned remaining;
2810 int window;
2811 int depth;
2812 int working;
2813 int data_ready;
2814 pthread_mutex_t mutex;
2815 pthread_cond_t cond;
2816 unsigned *processed;
2819 static pthread_cond_t progress_cond;
2822 * Mutex and conditional variable can't be statically-initialized on Windows.
2824 static void init_threaded_search(void)
2826 pthread_mutex_init(&cache_mutex, NULL);
2827 pthread_mutex_init(&progress_mutex, NULL);
2828 pthread_cond_init(&progress_cond, NULL);
2831 static void cleanup_threaded_search(void)
2833 pthread_cond_destroy(&progress_cond);
2834 pthread_mutex_destroy(&cache_mutex);
2835 pthread_mutex_destroy(&progress_mutex);
2838 static void *threaded_find_deltas(void *arg)
2840 struct thread_params *me = arg;
2842 progress_lock();
2843 while (me->remaining) {
2844 progress_unlock();
2846 find_deltas(me->list, &me->remaining,
2847 me->window, me->depth, me->processed);
2849 progress_lock();
2850 me->working = 0;
2851 pthread_cond_signal(&progress_cond);
2852 progress_unlock();
2855 * We must not set ->data_ready before we wait on the
2856 * condition because the main thread may have set it to 1
2857 * before we get here. In order to be sure that new
2858 * work is available if we see 1 in ->data_ready, it
2859 * was initialized to 0 before this thread was spawned
2860 * and we reset it to 0 right away.
2862 pthread_mutex_lock(&me->mutex);
2863 while (!me->data_ready)
2864 pthread_cond_wait(&me->cond, &me->mutex);
2865 me->data_ready = 0;
2866 pthread_mutex_unlock(&me->mutex);
2868 progress_lock();
2870 progress_unlock();
2871 /* leave ->working 1 so that this doesn't get more work assigned */
2872 return NULL;
2875 static void ll_find_deltas(struct object_entry **list, unsigned list_size,
2876 int window, int depth, unsigned *processed)
2878 struct thread_params *p;
2879 int i, ret, active_threads = 0;
2881 init_threaded_search();
2883 if (delta_search_threads <= 1) {
2884 find_deltas(list, &list_size, window, depth, processed);
2885 cleanup_threaded_search();
2886 return;
2888 if (progress > pack_to_stdout)
2889 fprintf_ln(stderr, _("Delta compression using up to %d threads"),
2890 delta_search_threads);
2891 CALLOC_ARRAY(p, delta_search_threads);
2893 /* Partition the work amongst work threads. */
2894 for (i = 0; i < delta_search_threads; i++) {
2895 unsigned sub_size = list_size / (delta_search_threads - i);
2897 /* don't use too small segments or no deltas will be found */
2898 if (sub_size < 2*window && i+1 < delta_search_threads)
2899 sub_size = 0;
2901 p[i].window = window;
2902 p[i].depth = depth;
2903 p[i].processed = processed;
2904 p[i].working = 1;
2905 p[i].data_ready = 0;
2907 /* try to split chunks on "path" boundaries */
2908 while (sub_size && sub_size < list_size &&
2909 list[sub_size]->hash &&
2910 list[sub_size]->hash == list[sub_size-1]->hash)
2911 sub_size++;
2913 p[i].list = list;
2914 p[i].list_size = sub_size;
2915 p[i].remaining = sub_size;
2917 list += sub_size;
2918 list_size -= sub_size;
2921 /* Start work threads. */
2922 for (i = 0; i < delta_search_threads; i++) {
2923 if (!p[i].list_size)
2924 continue;
2925 pthread_mutex_init(&p[i].mutex, NULL);
2926 pthread_cond_init(&p[i].cond, NULL);
2927 ret = pthread_create(&p[i].thread, NULL,
2928 threaded_find_deltas, &p[i]);
2929 if (ret)
2930 die(_("unable to create thread: %s"), strerror(ret));
2931 active_threads++;
2935 * Now let's wait for work completion. Each time a thread is done
2936 * with its work, we steal half of the remaining work from the
2937 * thread with the largest number of unprocessed objects and give
2938 * it to that newly idle thread. This ensure good load balancing
2939 * until the remaining object list segments are simply too short
2940 * to be worth splitting anymore.
2942 while (active_threads) {
2943 struct thread_params *target = NULL;
2944 struct thread_params *victim = NULL;
2945 unsigned sub_size = 0;
2947 progress_lock();
2948 for (;;) {
2949 for (i = 0; !target && i < delta_search_threads; i++)
2950 if (!p[i].working)
2951 target = &p[i];
2952 if (target)
2953 break;
2954 pthread_cond_wait(&progress_cond, &progress_mutex);
2957 for (i = 0; i < delta_search_threads; i++)
2958 if (p[i].remaining > 2*window &&
2959 (!victim || victim->remaining < p[i].remaining))
2960 victim = &p[i];
2961 if (victim) {
2962 sub_size = victim->remaining / 2;
2963 list = victim->list + victim->list_size - sub_size;
2964 while (sub_size && list[0]->hash &&
2965 list[0]->hash == list[-1]->hash) {
2966 list++;
2967 sub_size--;
2969 if (!sub_size) {
2971 * It is possible for some "paths" to have
2972 * so many objects that no hash boundary
2973 * might be found. Let's just steal the
2974 * exact half in that case.
2976 sub_size = victim->remaining / 2;
2977 list -= sub_size;
2979 target->list = list;
2980 victim->list_size -= sub_size;
2981 victim->remaining -= sub_size;
2983 target->list_size = sub_size;
2984 target->remaining = sub_size;
2985 target->working = 1;
2986 progress_unlock();
2988 pthread_mutex_lock(&target->mutex);
2989 target->data_ready = 1;
2990 pthread_cond_signal(&target->cond);
2991 pthread_mutex_unlock(&target->mutex);
2993 if (!sub_size) {
2994 pthread_join(target->thread, NULL);
2995 pthread_cond_destroy(&target->cond);
2996 pthread_mutex_destroy(&target->mutex);
2997 active_threads--;
3000 cleanup_threaded_search();
3001 free(p);
3004 static int obj_is_packed(const struct object_id *oid)
3006 return packlist_find(&to_pack, oid) ||
3007 (reuse_packfile_bitmap &&
3008 bitmap_walk_contains(bitmap_git, reuse_packfile_bitmap, oid));
3011 static void add_tag_chain(const struct object_id *oid)
3013 struct tag *tag;
3016 * We catch duplicates already in add_object_entry(), but we'd
3017 * prefer to do this extra check to avoid having to parse the
3018 * tag at all if we already know that it's being packed (e.g., if
3019 * it was included via bitmaps, we would not have parsed it
3020 * previously).
3022 if (obj_is_packed(oid))
3023 return;
3025 tag = lookup_tag(the_repository, oid);
3026 while (1) {
3027 if (!tag || parse_tag(tag) || !tag->tagged)
3028 die(_("unable to pack objects reachable from tag %s"),
3029 oid_to_hex(oid));
3031 add_object_entry(&tag->object.oid, OBJ_TAG, NULL, 0);
3033 if (tag->tagged->type != OBJ_TAG)
3034 return;
3036 tag = (struct tag *)tag->tagged;
3040 static int add_ref_tag(const char *tag UNUSED, const struct object_id *oid,
3041 int flag UNUSED, void *cb_data UNUSED)
3043 struct object_id peeled;
3045 if (!peel_iterated_oid(oid, &peeled) && obj_is_packed(&peeled))
3046 add_tag_chain(oid);
3047 return 0;
3050 static void prepare_pack(int window, int depth)
3052 struct object_entry **delta_list;
3053 uint32_t i, nr_deltas;
3054 unsigned n;
3056 if (use_delta_islands)
3057 resolve_tree_islands(the_repository, progress, &to_pack);
3059 get_object_details();
3062 * If we're locally repacking then we need to be doubly careful
3063 * from now on in order to make sure no stealth corruption gets
3064 * propagated to the new pack. Clients receiving streamed packs
3065 * should validate everything they get anyway so no need to incur
3066 * the additional cost here in that case.
3068 if (!pack_to_stdout)
3069 do_check_packed_object_crc = 1;
3071 if (!to_pack.nr_objects || !window || !depth)
3072 return;
3074 ALLOC_ARRAY(delta_list, to_pack.nr_objects);
3075 nr_deltas = n = 0;
3077 for (i = 0; i < to_pack.nr_objects; i++) {
3078 struct object_entry *entry = to_pack.objects + i;
3080 if (DELTA(entry))
3081 /* This happens if we decided to reuse existing
3082 * delta from a pack. "reuse_delta &&" is implied.
3084 continue;
3086 if (!entry->type_valid ||
3087 oe_size_less_than(&to_pack, entry, 50))
3088 continue;
3090 if (entry->no_try_delta)
3091 continue;
3093 if (!entry->preferred_base) {
3094 nr_deltas++;
3095 if (oe_type(entry) < 0)
3096 die(_("unable to get type of object %s"),
3097 oid_to_hex(&entry->idx.oid));
3098 } else {
3099 if (oe_type(entry) < 0) {
3101 * This object is not found, but we
3102 * don't have to include it anyway.
3104 continue;
3108 delta_list[n++] = entry;
3111 if (nr_deltas && n > 1) {
3112 unsigned nr_done = 0;
3114 if (progress)
3115 progress_state = start_progress(_("Compressing objects"),
3116 nr_deltas);
3117 QSORT(delta_list, n, type_size_sort);
3118 ll_find_deltas(delta_list, n, window+1, depth, &nr_done);
3119 stop_progress(&progress_state);
3120 if (nr_done != nr_deltas)
3121 die(_("inconsistency with delta count"));
3123 free(delta_list);
3126 static int git_pack_config(const char *k, const char *v, void *cb)
3128 if (!strcmp(k, "pack.window")) {
3129 window = git_config_int(k, v);
3130 return 0;
3132 if (!strcmp(k, "pack.windowmemory")) {
3133 window_memory_limit = git_config_ulong(k, v);
3134 return 0;
3136 if (!strcmp(k, "pack.depth")) {
3137 depth = git_config_int(k, v);
3138 return 0;
3140 if (!strcmp(k, "pack.deltacachesize")) {
3141 max_delta_cache_size = git_config_int(k, v);
3142 return 0;
3144 if (!strcmp(k, "pack.deltacachelimit")) {
3145 cache_max_small_delta_size = git_config_int(k, v);
3146 return 0;
3148 if (!strcmp(k, "pack.writebitmaphashcache")) {
3149 if (git_config_bool(k, v))
3150 write_bitmap_options |= BITMAP_OPT_HASH_CACHE;
3151 else
3152 write_bitmap_options &= ~BITMAP_OPT_HASH_CACHE;
3155 if (!strcmp(k, "pack.writebitmaplookuptable")) {
3156 if (git_config_bool(k, v))
3157 write_bitmap_options |= BITMAP_OPT_LOOKUP_TABLE;
3158 else
3159 write_bitmap_options &= ~BITMAP_OPT_LOOKUP_TABLE;
3162 if (!strcmp(k, "pack.usebitmaps")) {
3163 use_bitmap_index_default = git_config_bool(k, v);
3164 return 0;
3166 if (!strcmp(k, "pack.allowpackreuse")) {
3167 allow_pack_reuse = git_config_bool(k, v);
3168 return 0;
3170 if (!strcmp(k, "pack.threads")) {
3171 delta_search_threads = git_config_int(k, v);
3172 if (delta_search_threads < 0)
3173 die(_("invalid number of threads specified (%d)"),
3174 delta_search_threads);
3175 if (!HAVE_THREADS && delta_search_threads != 1) {
3176 warning(_("no threads support, ignoring %s"), k);
3177 delta_search_threads = 0;
3179 return 0;
3181 if (!strcmp(k, "pack.indexversion")) {
3182 pack_idx_opts.version = git_config_int(k, v);
3183 if (pack_idx_opts.version > 2)
3184 die(_("bad pack.indexVersion=%"PRIu32),
3185 pack_idx_opts.version);
3186 return 0;
3188 if (!strcmp(k, "pack.writereverseindex")) {
3189 if (git_config_bool(k, v))
3190 pack_idx_opts.flags |= WRITE_REV;
3191 else
3192 pack_idx_opts.flags &= ~WRITE_REV;
3193 return 0;
3195 if (!strcmp(k, "uploadpack.blobpackfileuri")) {
3196 struct configured_exclusion *ex = xmalloc(sizeof(*ex));
3197 const char *oid_end, *pack_end;
3199 * Stores the pack hash. This is not a true object ID, but is
3200 * of the same form.
3202 struct object_id pack_hash;
3204 if (parse_oid_hex(v, &ex->e.oid, &oid_end) ||
3205 *oid_end != ' ' ||
3206 parse_oid_hex(oid_end + 1, &pack_hash, &pack_end) ||
3207 *pack_end != ' ')
3208 die(_("value of uploadpack.blobpackfileuri must be "
3209 "of the form '<object-hash> <pack-hash> <uri>' (got '%s')"), v);
3210 if (oidmap_get(&configured_exclusions, &ex->e.oid))
3211 die(_("object already configured in another "
3212 "uploadpack.blobpackfileuri (got '%s')"), v);
3213 ex->pack_hash_hex = xcalloc(1, pack_end - oid_end);
3214 memcpy(ex->pack_hash_hex, oid_end + 1, pack_end - oid_end - 1);
3215 ex->uri = xstrdup(pack_end + 1);
3216 oidmap_put(&configured_exclusions, ex);
3218 return git_default_config(k, v, cb);
3221 /* Counters for trace2 output when in --stdin-packs mode. */
3222 static int stdin_packs_found_nr;
3223 static int stdin_packs_hints_nr;
3225 static int add_object_entry_from_pack(const struct object_id *oid,
3226 struct packed_git *p,
3227 uint32_t pos,
3228 void *_data)
3230 off_t ofs;
3231 enum object_type type = OBJ_NONE;
3233 display_progress(progress_state, ++nr_seen);
3235 if (have_duplicate_entry(oid, 0))
3236 return 0;
3238 ofs = nth_packed_object_offset(p, pos);
3239 if (!want_object_in_pack(oid, 0, &p, &ofs))
3240 return 0;
3242 if (p) {
3243 struct rev_info *revs = _data;
3244 struct object_info oi = OBJECT_INFO_INIT;
3246 oi.typep = &type;
3247 if (packed_object_info(the_repository, p, ofs, &oi) < 0) {
3248 die(_("could not get type of object %s in pack %s"),
3249 oid_to_hex(oid), p->pack_name);
3250 } else if (type == OBJ_COMMIT) {
3252 * commits in included packs are used as starting points for the
3253 * subsequent revision walk
3255 add_pending_oid(revs, NULL, oid, 0);
3258 stdin_packs_found_nr++;
3261 create_object_entry(oid, type, 0, 0, 0, p, ofs);
3263 return 0;
3266 static void show_commit_pack_hint(struct commit *commit, void *_data)
3268 /* nothing to do; commits don't have a namehash */
3271 static void show_object_pack_hint(struct object *object, const char *name,
3272 void *_data)
3274 struct object_entry *oe = packlist_find(&to_pack, &object->oid);
3275 if (!oe)
3276 return;
3279 * Our 'to_pack' list was constructed by iterating all objects packed in
3280 * included packs, and so doesn't have a non-zero hash field that you
3281 * would typically pick up during a reachability traversal.
3283 * Make a best-effort attempt to fill in the ->hash and ->no_try_delta
3284 * here using a now in order to perhaps improve the delta selection
3285 * process.
3287 oe->hash = pack_name_hash(name);
3288 oe->no_try_delta = name && no_try_delta(name);
3290 stdin_packs_hints_nr++;
3293 static int pack_mtime_cmp(const void *_a, const void *_b)
3295 struct packed_git *a = ((const struct string_list_item*)_a)->util;
3296 struct packed_git *b = ((const struct string_list_item*)_b)->util;
3299 * order packs by descending mtime so that objects are laid out
3300 * roughly as newest-to-oldest
3302 if (a->mtime < b->mtime)
3303 return 1;
3304 else if (b->mtime < a->mtime)
3305 return -1;
3306 else
3307 return 0;
3310 static void read_packs_list_from_stdin(void)
3312 struct strbuf buf = STRBUF_INIT;
3313 struct string_list include_packs = STRING_LIST_INIT_DUP;
3314 struct string_list exclude_packs = STRING_LIST_INIT_DUP;
3315 struct string_list_item *item = NULL;
3317 struct packed_git *p;
3318 struct rev_info revs;
3320 repo_init_revisions(the_repository, &revs, NULL);
3322 * Use a revision walk to fill in the namehash of objects in the include
3323 * packs. To save time, we'll avoid traversing through objects that are
3324 * in excluded packs.
3326 * That may cause us to avoid populating all of the namehash fields of
3327 * all included objects, but our goal is best-effort, since this is only
3328 * an optimization during delta selection.
3330 revs.no_kept_objects = 1;
3331 revs.keep_pack_cache_flags |= IN_CORE_KEEP_PACKS;
3332 revs.blob_objects = 1;
3333 revs.tree_objects = 1;
3334 revs.tag_objects = 1;
3335 revs.ignore_missing_links = 1;
3337 while (strbuf_getline(&buf, stdin) != EOF) {
3338 if (!buf.len)
3339 continue;
3341 if (*buf.buf == '^')
3342 string_list_append(&exclude_packs, buf.buf + 1);
3343 else
3344 string_list_append(&include_packs, buf.buf);
3346 strbuf_reset(&buf);
3349 string_list_sort(&include_packs);
3350 string_list_sort(&exclude_packs);
3352 for (p = get_all_packs(the_repository); p; p = p->next) {
3353 const char *pack_name = pack_basename(p);
3355 item = string_list_lookup(&include_packs, pack_name);
3356 if (!item)
3357 item = string_list_lookup(&exclude_packs, pack_name);
3359 if (item)
3360 item->util = p;
3364 * Arguments we got on stdin may not even be packs. First
3365 * check that to avoid segfaulting later on in
3366 * e.g. pack_mtime_cmp(), excluded packs are handled below.
3368 * Since we first parsed our STDIN and then sorted the input
3369 * lines the pack we error on will be whatever line happens to
3370 * sort first. This is lazy, it's enough that we report one
3371 * bad case here, we don't need to report the first/last one,
3372 * or all of them.
3374 for_each_string_list_item(item, &include_packs) {
3375 struct packed_git *p = item->util;
3376 if (!p)
3377 die(_("could not find pack '%s'"), item->string);
3378 if (!is_pack_valid(p))
3379 die(_("packfile %s cannot be accessed"), p->pack_name);
3383 * Then, handle all of the excluded packs, marking them as
3384 * kept in-core so that later calls to add_object_entry()
3385 * discards any objects that are also found in excluded packs.
3387 for_each_string_list_item(item, &exclude_packs) {
3388 struct packed_git *p = item->util;
3389 if (!p)
3390 die(_("could not find pack '%s'"), item->string);
3391 p->pack_keep_in_core = 1;
3395 * Order packs by ascending mtime; use QSORT directly to access the
3396 * string_list_item's ->util pointer, which string_list_sort() does not
3397 * provide.
3399 QSORT(include_packs.items, include_packs.nr, pack_mtime_cmp);
3401 for_each_string_list_item(item, &include_packs) {
3402 struct packed_git *p = item->util;
3403 for_each_object_in_pack(p,
3404 add_object_entry_from_pack,
3405 &revs,
3406 FOR_EACH_OBJECT_PACK_ORDER);
3409 if (prepare_revision_walk(&revs))
3410 die(_("revision walk setup failed"));
3411 traverse_commit_list(&revs,
3412 show_commit_pack_hint,
3413 show_object_pack_hint,
3414 NULL);
3416 trace2_data_intmax("pack-objects", the_repository, "stdin_packs_found",
3417 stdin_packs_found_nr);
3418 trace2_data_intmax("pack-objects", the_repository, "stdin_packs_hints",
3419 stdin_packs_hints_nr);
3421 strbuf_release(&buf);
3422 string_list_clear(&include_packs, 0);
3423 string_list_clear(&exclude_packs, 0);
3426 static void add_cruft_object_entry(const struct object_id *oid, enum object_type type,
3427 struct packed_git *pack, off_t offset,
3428 const char *name, uint32_t mtime)
3430 struct object_entry *entry;
3432 display_progress(progress_state, ++nr_seen);
3434 entry = packlist_find(&to_pack, oid);
3435 if (entry) {
3436 if (name) {
3437 entry->hash = pack_name_hash(name);
3438 entry->no_try_delta = no_try_delta(name);
3440 } else {
3441 if (!want_object_in_pack(oid, 0, &pack, &offset))
3442 return;
3443 if (!pack && type == OBJ_BLOB && !has_loose_object(oid)) {
3445 * If a traversed tree has a missing blob then we want
3446 * to avoid adding that missing object to our pack.
3448 * This only applies to missing blobs, not trees,
3449 * because the traversal needs to parse sub-trees but
3450 * not blobs.
3452 * Note we only perform this check when we couldn't
3453 * already find the object in a pack, so we're really
3454 * limited to "ensure non-tip blobs which don't exist in
3455 * packs do exist via loose objects". Confused?
3457 return;
3460 entry = create_object_entry(oid, type, pack_name_hash(name),
3461 0, name && no_try_delta(name),
3462 pack, offset);
3465 if (mtime > oe_cruft_mtime(&to_pack, entry))
3466 oe_set_cruft_mtime(&to_pack, entry, mtime);
3467 return;
3470 static void show_cruft_object(struct object *obj, const char *name, void *data)
3473 * if we did not record it earlier, it's at least as old as our
3474 * expiration value. Rather than find it exactly, just use that
3475 * value. This may bump it forward from its real mtime, but it
3476 * will still be "too old" next time we run with the same
3477 * expiration.
3479 * if obj does appear in the packing list, this call is a noop (or may
3480 * set the namehash).
3482 add_cruft_object_entry(&obj->oid, obj->type, NULL, 0, name, cruft_expiration);
3485 static void show_cruft_commit(struct commit *commit, void *data)
3487 show_cruft_object((struct object*)commit, NULL, data);
3490 static int cruft_include_check_obj(struct object *obj, void *data)
3492 return !has_object_kept_pack(&obj->oid, IN_CORE_KEEP_PACKS);
3495 static int cruft_include_check(struct commit *commit, void *data)
3497 return cruft_include_check_obj((struct object*)commit, data);
3500 static void set_cruft_mtime(const struct object *object,
3501 struct packed_git *pack,
3502 off_t offset, time_t mtime)
3504 add_cruft_object_entry(&object->oid, object->type, pack, offset, NULL,
3505 mtime);
3508 static void mark_pack_kept_in_core(struct string_list *packs, unsigned keep)
3510 struct string_list_item *item = NULL;
3511 for_each_string_list_item(item, packs) {
3512 struct packed_git *p = item->util;
3513 if (!p)
3514 die(_("could not find pack '%s'"), item->string);
3515 p->pack_keep_in_core = keep;
3519 static void add_unreachable_loose_objects(void);
3520 static void add_objects_in_unpacked_packs(void);
3522 static void enumerate_cruft_objects(void)
3524 if (progress)
3525 progress_state = start_progress(_("Enumerating cruft objects"), 0);
3527 add_objects_in_unpacked_packs();
3528 add_unreachable_loose_objects();
3530 stop_progress(&progress_state);
3533 static void enumerate_and_traverse_cruft_objects(struct string_list *fresh_packs)
3535 struct packed_git *p;
3536 struct rev_info revs;
3537 int ret;
3539 repo_init_revisions(the_repository, &revs, NULL);
3541 revs.tag_objects = 1;
3542 revs.tree_objects = 1;
3543 revs.blob_objects = 1;
3545 revs.include_check = cruft_include_check;
3546 revs.include_check_obj = cruft_include_check_obj;
3548 revs.ignore_missing_links = 1;
3550 if (progress)
3551 progress_state = start_progress(_("Enumerating cruft objects"), 0);
3552 ret = add_unseen_recent_objects_to_traversal(&revs, cruft_expiration,
3553 set_cruft_mtime, 1);
3554 stop_progress(&progress_state);
3556 if (ret)
3557 die(_("unable to add cruft objects"));
3560 * Re-mark only the fresh packs as kept so that objects in
3561 * unknown packs do not halt the reachability traversal early.
3563 for (p = get_all_packs(the_repository); p; p = p->next)
3564 p->pack_keep_in_core = 0;
3565 mark_pack_kept_in_core(fresh_packs, 1);
3567 if (prepare_revision_walk(&revs))
3568 die(_("revision walk setup failed"));
3569 if (progress)
3570 progress_state = start_progress(_("Traversing cruft objects"), 0);
3571 nr_seen = 0;
3572 traverse_commit_list(&revs, show_cruft_commit, show_cruft_object, NULL);
3574 stop_progress(&progress_state);
3577 static void read_cruft_objects(void)
3579 struct strbuf buf = STRBUF_INIT;
3580 struct string_list discard_packs = STRING_LIST_INIT_DUP;
3581 struct string_list fresh_packs = STRING_LIST_INIT_DUP;
3582 struct packed_git *p;
3584 ignore_packed_keep_in_core = 1;
3586 while (strbuf_getline(&buf, stdin) != EOF) {
3587 if (!buf.len)
3588 continue;
3590 if (*buf.buf == '-')
3591 string_list_append(&discard_packs, buf.buf + 1);
3592 else
3593 string_list_append(&fresh_packs, buf.buf);
3594 strbuf_reset(&buf);
3597 string_list_sort(&discard_packs);
3598 string_list_sort(&fresh_packs);
3600 for (p = get_all_packs(the_repository); p; p = p->next) {
3601 const char *pack_name = pack_basename(p);
3602 struct string_list_item *item;
3604 item = string_list_lookup(&fresh_packs, pack_name);
3605 if (!item)
3606 item = string_list_lookup(&discard_packs, pack_name);
3608 if (item) {
3609 item->util = p;
3610 } else {
3612 * This pack wasn't mentioned in either the "fresh" or
3613 * "discard" list, so the caller didn't know about it.
3615 * Mark it as kept so that its objects are ignored by
3616 * add_unseen_recent_objects_to_traversal(). We'll
3617 * unmark it before starting the traversal so it doesn't
3618 * halt the traversal early.
3620 p->pack_keep_in_core = 1;
3624 mark_pack_kept_in_core(&fresh_packs, 1);
3625 mark_pack_kept_in_core(&discard_packs, 0);
3627 if (cruft_expiration)
3628 enumerate_and_traverse_cruft_objects(&fresh_packs);
3629 else
3630 enumerate_cruft_objects();
3632 strbuf_release(&buf);
3633 string_list_clear(&discard_packs, 0);
3634 string_list_clear(&fresh_packs, 0);
3637 static void read_object_list_from_stdin(void)
3639 char line[GIT_MAX_HEXSZ + 1 + PATH_MAX + 2];
3640 struct object_id oid;
3641 const char *p;
3643 for (;;) {
3644 if (!fgets(line, sizeof(line), stdin)) {
3645 if (feof(stdin))
3646 break;
3647 if (!ferror(stdin))
3648 BUG("fgets returned NULL, not EOF, not error!");
3649 if (errno != EINTR)
3650 die_errno("fgets");
3651 clearerr(stdin);
3652 continue;
3654 if (line[0] == '-') {
3655 if (get_oid_hex(line+1, &oid))
3656 die(_("expected edge object ID, got garbage:\n %s"),
3657 line);
3658 add_preferred_base(&oid);
3659 continue;
3661 if (parse_oid_hex(line, &oid, &p))
3662 die(_("expected object ID, got garbage:\n %s"), line);
3664 add_preferred_base_object(p + 1);
3665 add_object_entry(&oid, OBJ_NONE, p + 1, 0);
3669 static void show_commit(struct commit *commit, void *data)
3671 add_object_entry(&commit->object.oid, OBJ_COMMIT, NULL, 0);
3673 if (write_bitmap_index)
3674 index_commit_for_bitmap(commit);
3676 if (use_delta_islands)
3677 propagate_island_marks(commit);
3680 static void show_object(struct object *obj, const char *name, void *data)
3682 add_preferred_base_object(name);
3683 add_object_entry(&obj->oid, obj->type, name, 0);
3685 if (use_delta_islands) {
3686 const char *p;
3687 unsigned depth;
3688 struct object_entry *ent;
3690 /* the empty string is a root tree, which is depth 0 */
3691 depth = *name ? 1 : 0;
3692 for (p = strchr(name, '/'); p; p = strchr(p + 1, '/'))
3693 depth++;
3695 ent = packlist_find(&to_pack, &obj->oid);
3696 if (ent && depth > oe_tree_depth(&to_pack, ent))
3697 oe_set_tree_depth(&to_pack, ent, depth);
3701 static void show_object__ma_allow_any(struct object *obj, const char *name, void *data)
3703 assert(arg_missing_action == MA_ALLOW_ANY);
3706 * Quietly ignore ALL missing objects. This avoids problems with
3707 * staging them now and getting an odd error later.
3709 if (!has_object(the_repository, &obj->oid, 0))
3710 return;
3712 show_object(obj, name, data);
3715 static void show_object__ma_allow_promisor(struct object *obj, const char *name, void *data)
3717 assert(arg_missing_action == MA_ALLOW_PROMISOR);
3720 * Quietly ignore EXPECTED missing objects. This avoids problems with
3721 * staging them now and getting an odd error later.
3723 if (!has_object(the_repository, &obj->oid, 0) && is_promisor_object(&obj->oid))
3724 return;
3726 show_object(obj, name, data);
3729 static int option_parse_missing_action(const struct option *opt,
3730 const char *arg, int unset)
3732 assert(arg);
3733 assert(!unset);
3735 if (!strcmp(arg, "error")) {
3736 arg_missing_action = MA_ERROR;
3737 fn_show_object = show_object;
3738 return 0;
3741 if (!strcmp(arg, "allow-any")) {
3742 arg_missing_action = MA_ALLOW_ANY;
3743 fetch_if_missing = 0;
3744 fn_show_object = show_object__ma_allow_any;
3745 return 0;
3748 if (!strcmp(arg, "allow-promisor")) {
3749 arg_missing_action = MA_ALLOW_PROMISOR;
3750 fetch_if_missing = 0;
3751 fn_show_object = show_object__ma_allow_promisor;
3752 return 0;
3755 die(_("invalid value for '%s': '%s'"), "--missing", arg);
3756 return 0;
3759 static void show_edge(struct commit *commit)
3761 add_preferred_base(&commit->object.oid);
3764 static int add_object_in_unpacked_pack(const struct object_id *oid,
3765 struct packed_git *pack,
3766 uint32_t pos,
3767 void *_data)
3769 if (cruft) {
3770 off_t offset;
3771 time_t mtime;
3773 if (pack->is_cruft) {
3774 if (load_pack_mtimes(pack) < 0)
3775 die(_("could not load cruft pack .mtimes"));
3776 mtime = nth_packed_mtime(pack, pos);
3777 } else {
3778 mtime = pack->mtime;
3780 offset = nth_packed_object_offset(pack, pos);
3782 add_cruft_object_entry(oid, OBJ_NONE, pack, offset,
3783 NULL, mtime);
3784 } else {
3785 add_object_entry(oid, OBJ_NONE, "", 0);
3787 return 0;
3790 static void add_objects_in_unpacked_packs(void)
3792 if (for_each_packed_object(add_object_in_unpacked_pack, NULL,
3793 FOR_EACH_OBJECT_PACK_ORDER |
3794 FOR_EACH_OBJECT_LOCAL_ONLY |
3795 FOR_EACH_OBJECT_SKIP_IN_CORE_KEPT_PACKS |
3796 FOR_EACH_OBJECT_SKIP_ON_DISK_KEPT_PACKS))
3797 die(_("cannot open pack index"));
3800 static int add_loose_object(const struct object_id *oid, const char *path,
3801 void *data)
3803 enum object_type type = oid_object_info(the_repository, oid, NULL);
3805 if (type < 0) {
3806 warning(_("loose object at %s could not be examined"), path);
3807 return 0;
3810 if (cruft) {
3811 struct stat st;
3812 if (stat(path, &st) < 0) {
3813 if (errno == ENOENT)
3814 return 0;
3815 return error_errno("unable to stat %s", oid_to_hex(oid));
3818 add_cruft_object_entry(oid, type, NULL, 0, NULL,
3819 st.st_mtime);
3820 } else {
3821 add_object_entry(oid, type, "", 0);
3823 return 0;
3827 * We actually don't even have to worry about reachability here.
3828 * add_object_entry will weed out duplicates, so we just add every
3829 * loose object we find.
3831 static void add_unreachable_loose_objects(void)
3833 for_each_loose_file_in_objdir(get_object_directory(),
3834 add_loose_object,
3835 NULL, NULL, NULL);
3838 static int has_sha1_pack_kept_or_nonlocal(const struct object_id *oid)
3840 static struct packed_git *last_found = (void *)1;
3841 struct packed_git *p;
3843 p = (last_found != (void *)1) ? last_found :
3844 get_all_packs(the_repository);
3846 while (p) {
3847 if ((!p->pack_local || p->pack_keep ||
3848 p->pack_keep_in_core) &&
3849 find_pack_entry_one(oid->hash, p)) {
3850 last_found = p;
3851 return 1;
3853 if (p == last_found)
3854 p = get_all_packs(the_repository);
3855 else
3856 p = p->next;
3857 if (p == last_found)
3858 p = p->next;
3860 return 0;
3864 * Store a list of sha1s that are should not be discarded
3865 * because they are either written too recently, or are
3866 * reachable from another object that was.
3868 * This is filled by get_object_list.
3870 static struct oid_array recent_objects;
3872 static int loosened_object_can_be_discarded(const struct object_id *oid,
3873 timestamp_t mtime)
3875 if (!unpack_unreachable_expiration)
3876 return 0;
3877 if (mtime > unpack_unreachable_expiration)
3878 return 0;
3879 if (oid_array_lookup(&recent_objects, oid) >= 0)
3880 return 0;
3881 return 1;
3884 static void loosen_unused_packed_objects(void)
3886 struct packed_git *p;
3887 uint32_t i;
3888 uint32_t loosened_objects_nr = 0;
3889 struct object_id oid;
3891 for (p = get_all_packs(the_repository); p; p = p->next) {
3892 if (!p->pack_local || p->pack_keep || p->pack_keep_in_core)
3893 continue;
3895 if (open_pack_index(p))
3896 die(_("cannot open pack index"));
3898 for (i = 0; i < p->num_objects; i++) {
3899 nth_packed_object_id(&oid, p, i);
3900 if (!packlist_find(&to_pack, &oid) &&
3901 !has_sha1_pack_kept_or_nonlocal(&oid) &&
3902 !loosened_object_can_be_discarded(&oid, p->mtime)) {
3903 if (force_object_loose(&oid, p->mtime))
3904 die(_("unable to force loose object"));
3905 loosened_objects_nr++;
3910 trace2_data_intmax("pack-objects", the_repository,
3911 "loosen_unused_packed_objects/loosened", loosened_objects_nr);
3915 * This tracks any options which pack-reuse code expects to be on, or which a
3916 * reader of the pack might not understand, and which would therefore prevent
3917 * blind reuse of what we have on disk.
3919 static int pack_options_allow_reuse(void)
3921 return allow_pack_reuse &&
3922 pack_to_stdout &&
3923 !ignore_packed_keep_on_disk &&
3924 !ignore_packed_keep_in_core &&
3925 (!local || !have_non_local_packs) &&
3926 !incremental;
3929 static int get_object_list_from_bitmap(struct rev_info *revs)
3931 if (!(bitmap_git = prepare_bitmap_walk(revs, 0)))
3932 return -1;
3934 if (pack_options_allow_reuse() &&
3935 !reuse_partial_packfile_from_bitmap(
3936 bitmap_git,
3937 &reuse_packfile,
3938 &reuse_packfile_objects,
3939 &reuse_packfile_bitmap)) {
3940 assert(reuse_packfile_objects);
3941 nr_result += reuse_packfile_objects;
3942 nr_seen += reuse_packfile_objects;
3943 display_progress(progress_state, nr_seen);
3946 traverse_bitmap_commit_list(bitmap_git, revs,
3947 &add_object_entry_from_bitmap);
3948 return 0;
3951 static void record_recent_object(struct object *obj,
3952 const char *name,
3953 void *data)
3955 oid_array_append(&recent_objects, &obj->oid);
3958 static void record_recent_commit(struct commit *commit, void *data)
3960 oid_array_append(&recent_objects, &commit->object.oid);
3963 static int mark_bitmap_preferred_tip(const char *refname,
3964 const struct object_id *oid,
3965 int flags UNUSED,
3966 void *data UNUSED)
3968 struct object_id peeled;
3969 struct object *object;
3971 if (!peel_iterated_oid(oid, &peeled))
3972 oid = &peeled;
3974 object = parse_object_or_die(oid, refname);
3975 if (object->type == OBJ_COMMIT)
3976 object->flags |= NEEDS_BITMAP;
3978 return 0;
3981 static void mark_bitmap_preferred_tips(void)
3983 struct string_list_item *item;
3984 const struct string_list *preferred_tips;
3986 preferred_tips = bitmap_preferred_tips(the_repository);
3987 if (!preferred_tips)
3988 return;
3990 for_each_string_list_item(item, preferred_tips) {
3991 for_each_ref_in(item->string, mark_bitmap_preferred_tip, NULL);
3995 static void get_object_list(struct rev_info *revs, int ac, const char **av)
3997 struct setup_revision_opt s_r_opt = {
3998 .allow_exclude_promisor_objects = 1,
4000 char line[1000];
4001 int flags = 0;
4002 int save_warning;
4004 save_commit_buffer = 0;
4005 setup_revisions(ac, av, revs, &s_r_opt);
4007 /* make sure shallows are read */
4008 is_repository_shallow(the_repository);
4010 save_warning = warn_on_object_refname_ambiguity;
4011 warn_on_object_refname_ambiguity = 0;
4013 while (fgets(line, sizeof(line), stdin) != NULL) {
4014 int len = strlen(line);
4015 if (len && line[len - 1] == '\n')
4016 line[--len] = 0;
4017 if (!len)
4018 break;
4019 if (*line == '-') {
4020 if (!strcmp(line, "--not")) {
4021 flags ^= UNINTERESTING;
4022 write_bitmap_index = 0;
4023 continue;
4025 if (starts_with(line, "--shallow ")) {
4026 struct object_id oid;
4027 if (get_oid_hex(line + 10, &oid))
4028 die("not an object name '%s'", line + 10);
4029 register_shallow(the_repository, &oid);
4030 use_bitmap_index = 0;
4031 continue;
4033 die(_("not a rev '%s'"), line);
4035 if (handle_revision_arg(line, revs, flags, REVARG_CANNOT_BE_FILENAME))
4036 die(_("bad revision '%s'"), line);
4039 warn_on_object_refname_ambiguity = save_warning;
4041 if (use_bitmap_index && !get_object_list_from_bitmap(revs))
4042 return;
4044 if (use_delta_islands)
4045 load_delta_islands(the_repository, progress);
4047 if (write_bitmap_index)
4048 mark_bitmap_preferred_tips();
4050 if (prepare_revision_walk(revs))
4051 die(_("revision walk setup failed"));
4052 mark_edges_uninteresting(revs, show_edge, sparse);
4054 if (!fn_show_object)
4055 fn_show_object = show_object;
4056 traverse_commit_list(revs,
4057 show_commit, fn_show_object,
4058 NULL);
4060 if (unpack_unreachable_expiration) {
4061 revs->ignore_missing_links = 1;
4062 if (add_unseen_recent_objects_to_traversal(revs,
4063 unpack_unreachable_expiration, NULL, 0))
4064 die(_("unable to add recent objects"));
4065 if (prepare_revision_walk(revs))
4066 die(_("revision walk setup failed"));
4067 traverse_commit_list(revs, record_recent_commit,
4068 record_recent_object, NULL);
4071 if (keep_unreachable)
4072 add_objects_in_unpacked_packs();
4073 if (pack_loose_unreachable)
4074 add_unreachable_loose_objects();
4075 if (unpack_unreachable)
4076 loosen_unused_packed_objects();
4078 oid_array_clear(&recent_objects);
4081 static void add_extra_kept_packs(const struct string_list *names)
4083 struct packed_git *p;
4085 if (!names->nr)
4086 return;
4088 for (p = get_all_packs(the_repository); p; p = p->next) {
4089 const char *name = basename(p->pack_name);
4090 int i;
4092 if (!p->pack_local)
4093 continue;
4095 for (i = 0; i < names->nr; i++)
4096 if (!fspathcmp(name, names->items[i].string))
4097 break;
4099 if (i < names->nr) {
4100 p->pack_keep_in_core = 1;
4101 ignore_packed_keep_in_core = 1;
4102 continue;
4107 static int option_parse_index_version(const struct option *opt,
4108 const char *arg, int unset)
4110 char *c;
4111 const char *val = arg;
4113 BUG_ON_OPT_NEG(unset);
4115 pack_idx_opts.version = strtoul(val, &c, 10);
4116 if (pack_idx_opts.version > 2)
4117 die(_("unsupported index version %s"), val);
4118 if (*c == ',' && c[1])
4119 pack_idx_opts.off32_limit = strtoul(c+1, &c, 0);
4120 if (*c || pack_idx_opts.off32_limit & 0x80000000)
4121 die(_("bad index version '%s'"), val);
4122 return 0;
4125 static int option_parse_unpack_unreachable(const struct option *opt,
4126 const char *arg, int unset)
4128 if (unset) {
4129 unpack_unreachable = 0;
4130 unpack_unreachable_expiration = 0;
4132 else {
4133 unpack_unreachable = 1;
4134 if (arg)
4135 unpack_unreachable_expiration = approxidate(arg);
4137 return 0;
4140 static int option_parse_cruft_expiration(const struct option *opt,
4141 const char *arg, int unset)
4143 if (unset) {
4144 cruft = 0;
4145 cruft_expiration = 0;
4146 } else {
4147 cruft = 1;
4148 if (arg)
4149 cruft_expiration = approxidate(arg);
4151 return 0;
4154 int cmd_pack_objects(int argc, const char **argv, const char *prefix)
4156 int use_internal_rev_list = 0;
4157 int shallow = 0;
4158 int all_progress_implied = 0;
4159 struct strvec rp = STRVEC_INIT;
4160 int rev_list_unpacked = 0, rev_list_all = 0, rev_list_reflog = 0;
4161 int rev_list_index = 0;
4162 int stdin_packs = 0;
4163 struct string_list keep_pack_list = STRING_LIST_INIT_NODUP;
4164 struct list_objects_filter_options filter_options =
4165 LIST_OBJECTS_FILTER_INIT;
4167 struct option pack_objects_options[] = {
4168 OPT_SET_INT('q', "quiet", &progress,
4169 N_("do not show progress meter"), 0),
4170 OPT_SET_INT(0, "progress", &progress,
4171 N_("show progress meter"), 1),
4172 OPT_SET_INT(0, "all-progress", &progress,
4173 N_("show progress meter during object writing phase"), 2),
4174 OPT_BOOL(0, "all-progress-implied",
4175 &all_progress_implied,
4176 N_("similar to --all-progress when progress meter is shown")),
4177 OPT_CALLBACK_F(0, "index-version", NULL, N_("<version>[,<offset>]"),
4178 N_("write the pack index file in the specified idx format version"),
4179 PARSE_OPT_NONEG, option_parse_index_version),
4180 OPT_MAGNITUDE(0, "max-pack-size", &pack_size_limit,
4181 N_("maximum size of each output pack file")),
4182 OPT_BOOL(0, "local", &local,
4183 N_("ignore borrowed objects from alternate object store")),
4184 OPT_BOOL(0, "incremental", &incremental,
4185 N_("ignore packed objects")),
4186 OPT_INTEGER(0, "window", &window,
4187 N_("limit pack window by objects")),
4188 OPT_MAGNITUDE(0, "window-memory", &window_memory_limit,
4189 N_("limit pack window by memory in addition to object limit")),
4190 OPT_INTEGER(0, "depth", &depth,
4191 N_("maximum length of delta chain allowed in the resulting pack")),
4192 OPT_BOOL(0, "reuse-delta", &reuse_delta,
4193 N_("reuse existing deltas")),
4194 OPT_BOOL(0, "reuse-object", &reuse_object,
4195 N_("reuse existing objects")),
4196 OPT_BOOL(0, "delta-base-offset", &allow_ofs_delta,
4197 N_("use OFS_DELTA objects")),
4198 OPT_INTEGER(0, "threads", &delta_search_threads,
4199 N_("use threads when searching for best delta matches")),
4200 OPT_BOOL(0, "non-empty", &non_empty,
4201 N_("do not create an empty pack output")),
4202 OPT_BOOL(0, "revs", &use_internal_rev_list,
4203 N_("read revision arguments from standard input")),
4204 OPT_SET_INT_F(0, "unpacked", &rev_list_unpacked,
4205 N_("limit the objects to those that are not yet packed"),
4206 1, PARSE_OPT_NONEG),
4207 OPT_SET_INT_F(0, "all", &rev_list_all,
4208 N_("include objects reachable from any reference"),
4209 1, PARSE_OPT_NONEG),
4210 OPT_SET_INT_F(0, "reflog", &rev_list_reflog,
4211 N_("include objects referred by reflog entries"),
4212 1, PARSE_OPT_NONEG),
4213 OPT_SET_INT_F(0, "indexed-objects", &rev_list_index,
4214 N_("include objects referred to by the index"),
4215 1, PARSE_OPT_NONEG),
4216 OPT_BOOL(0, "stdin-packs", &stdin_packs,
4217 N_("read packs from stdin")),
4218 OPT_BOOL(0, "stdout", &pack_to_stdout,
4219 N_("output pack to stdout")),
4220 OPT_BOOL(0, "include-tag", &include_tag,
4221 N_("include tag objects that refer to objects to be packed")),
4222 OPT_BOOL(0, "keep-unreachable", &keep_unreachable,
4223 N_("keep unreachable objects")),
4224 OPT_BOOL(0, "pack-loose-unreachable", &pack_loose_unreachable,
4225 N_("pack loose unreachable objects")),
4226 OPT_CALLBACK_F(0, "unpack-unreachable", NULL, N_("time"),
4227 N_("unpack unreachable objects newer than <time>"),
4228 PARSE_OPT_OPTARG, option_parse_unpack_unreachable),
4229 OPT_BOOL(0, "cruft", &cruft, N_("create a cruft pack")),
4230 OPT_CALLBACK_F(0, "cruft-expiration", NULL, N_("time"),
4231 N_("expire cruft objects older than <time>"),
4232 PARSE_OPT_OPTARG, option_parse_cruft_expiration),
4233 OPT_BOOL(0, "sparse", &sparse,
4234 N_("use the sparse reachability algorithm")),
4235 OPT_BOOL(0, "thin", &thin,
4236 N_("create thin packs")),
4237 OPT_BOOL(0, "shallow", &shallow,
4238 N_("create packs suitable for shallow fetches")),
4239 OPT_BOOL(0, "honor-pack-keep", &ignore_packed_keep_on_disk,
4240 N_("ignore packs that have companion .keep file")),
4241 OPT_STRING_LIST(0, "keep-pack", &keep_pack_list, N_("name"),
4242 N_("ignore this pack")),
4243 OPT_INTEGER(0, "compression", &pack_compression_level,
4244 N_("pack compression level")),
4245 OPT_SET_INT(0, "keep-true-parents", &grafts_replace_parents,
4246 N_("do not hide commits by grafts"), 0),
4247 OPT_BOOL(0, "use-bitmap-index", &use_bitmap_index,
4248 N_("use a bitmap index if available to speed up counting objects")),
4249 OPT_SET_INT(0, "write-bitmap-index", &write_bitmap_index,
4250 N_("write a bitmap index together with the pack index"),
4251 WRITE_BITMAP_TRUE),
4252 OPT_SET_INT_F(0, "write-bitmap-index-quiet",
4253 &write_bitmap_index,
4254 N_("write a bitmap index if possible"),
4255 WRITE_BITMAP_QUIET, PARSE_OPT_HIDDEN),
4256 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
4257 OPT_CALLBACK_F(0, "missing", NULL, N_("action"),
4258 N_("handling for missing objects"), PARSE_OPT_NONEG,
4259 option_parse_missing_action),
4260 OPT_BOOL(0, "exclude-promisor-objects", &exclude_promisor_objects,
4261 N_("do not pack objects in promisor packfiles")),
4262 OPT_BOOL(0, "delta-islands", &use_delta_islands,
4263 N_("respect islands during delta compression")),
4264 OPT_STRING_LIST(0, "uri-protocol", &uri_protocols,
4265 N_("protocol"),
4266 N_("exclude any configured uploadpack.blobpackfileuri with this protocol")),
4267 OPT_END(),
4270 if (DFS_NUM_STATES > (1 << OE_DFS_STATE_BITS))
4271 BUG("too many dfs states, increase OE_DFS_STATE_BITS");
4273 read_replace_refs = 0;
4275 sparse = git_env_bool("GIT_TEST_PACK_SPARSE", -1);
4276 if (the_repository->gitdir) {
4277 prepare_repo_settings(the_repository);
4278 if (sparse < 0)
4279 sparse = the_repository->settings.pack_use_sparse;
4282 reset_pack_idx_option(&pack_idx_opts);
4283 git_config(git_pack_config, NULL);
4284 if (git_env_bool(GIT_TEST_WRITE_REV_INDEX, 0))
4285 pack_idx_opts.flags |= WRITE_REV;
4287 progress = isatty(2);
4288 argc = parse_options(argc, argv, prefix, pack_objects_options,
4289 pack_usage, 0);
4291 if (argc) {
4292 base_name = argv[0];
4293 argc--;
4295 if (pack_to_stdout != !base_name || argc)
4296 usage_with_options(pack_usage, pack_objects_options);
4298 if (depth < 0)
4299 depth = 0;
4300 if (depth >= (1 << OE_DEPTH_BITS)) {
4301 warning(_("delta chain depth %d is too deep, forcing %d"),
4302 depth, (1 << OE_DEPTH_BITS) - 1);
4303 depth = (1 << OE_DEPTH_BITS) - 1;
4305 if (cache_max_small_delta_size >= (1U << OE_Z_DELTA_BITS)) {
4306 warning(_("pack.deltaCacheLimit is too high, forcing %d"),
4307 (1U << OE_Z_DELTA_BITS) - 1);
4308 cache_max_small_delta_size = (1U << OE_Z_DELTA_BITS) - 1;
4310 if (window < 0)
4311 window = 0;
4313 strvec_push(&rp, "pack-objects");
4314 if (thin) {
4315 use_internal_rev_list = 1;
4316 strvec_push(&rp, shallow
4317 ? "--objects-edge-aggressive"
4318 : "--objects-edge");
4319 } else
4320 strvec_push(&rp, "--objects");
4322 if (rev_list_all) {
4323 use_internal_rev_list = 1;
4324 strvec_push(&rp, "--all");
4326 if (rev_list_reflog) {
4327 use_internal_rev_list = 1;
4328 strvec_push(&rp, "--reflog");
4330 if (rev_list_index) {
4331 use_internal_rev_list = 1;
4332 strvec_push(&rp, "--indexed-objects");
4334 if (rev_list_unpacked && !stdin_packs) {
4335 use_internal_rev_list = 1;
4336 strvec_push(&rp, "--unpacked");
4339 if (exclude_promisor_objects) {
4340 use_internal_rev_list = 1;
4341 fetch_if_missing = 0;
4342 strvec_push(&rp, "--exclude-promisor-objects");
4344 if (unpack_unreachable || keep_unreachable || pack_loose_unreachable)
4345 use_internal_rev_list = 1;
4347 if (!reuse_object)
4348 reuse_delta = 0;
4349 if (pack_compression_level == -1)
4350 pack_compression_level = Z_DEFAULT_COMPRESSION;
4351 else if (pack_compression_level < 0 || pack_compression_level > Z_BEST_COMPRESSION)
4352 die(_("bad pack compression level %d"), pack_compression_level);
4354 if (!delta_search_threads) /* --threads=0 means autodetect */
4355 delta_search_threads = online_cpus();
4357 if (!HAVE_THREADS && delta_search_threads != 1)
4358 warning(_("no threads support, ignoring --threads"));
4359 if (!pack_to_stdout && !pack_size_limit && !cruft)
4360 pack_size_limit = pack_size_limit_cfg;
4361 if (pack_to_stdout && pack_size_limit)
4362 die(_("--max-pack-size cannot be used to build a pack for transfer"));
4363 if (pack_size_limit && pack_size_limit < 1024*1024) {
4364 warning(_("minimum pack size limit is 1 MiB"));
4365 pack_size_limit = 1024*1024;
4368 if (!pack_to_stdout && thin)
4369 die(_("--thin cannot be used to build an indexable pack"));
4371 if (keep_unreachable && unpack_unreachable)
4372 die(_("options '%s' and '%s' cannot be used together"), "--keep-unreachable", "--unpack-unreachable");
4373 if (!rev_list_all || !rev_list_reflog || !rev_list_index)
4374 unpack_unreachable_expiration = 0;
4376 if (filter_options.choice) {
4377 if (!pack_to_stdout)
4378 die(_("cannot use --filter without --stdout"));
4379 if (stdin_packs)
4380 die(_("cannot use --filter with --stdin-packs"));
4383 if (stdin_packs && use_internal_rev_list)
4384 die(_("cannot use internal rev list with --stdin-packs"));
4386 if (cruft) {
4387 if (use_internal_rev_list)
4388 die(_("cannot use internal rev list with --cruft"));
4389 if (stdin_packs)
4390 die(_("cannot use --stdin-packs with --cruft"));
4391 if (pack_size_limit)
4392 die(_("cannot use --max-pack-size with --cruft"));
4396 * "soft" reasons not to use bitmaps - for on-disk repack by default we want
4398 * - to produce good pack (with bitmap index not-yet-packed objects are
4399 * packed in suboptimal order).
4401 * - to use more robust pack-generation codepath (avoiding possible
4402 * bugs in bitmap code and possible bitmap index corruption).
4404 if (!pack_to_stdout)
4405 use_bitmap_index_default = 0;
4407 if (use_bitmap_index < 0)
4408 use_bitmap_index = use_bitmap_index_default;
4410 /* "hard" reasons not to use bitmaps; these just won't work at all */
4411 if (!use_internal_rev_list || (!pack_to_stdout && write_bitmap_index) || is_repository_shallow(the_repository))
4412 use_bitmap_index = 0;
4414 if (pack_to_stdout || !rev_list_all)
4415 write_bitmap_index = 0;
4417 if (use_delta_islands)
4418 strvec_push(&rp, "--topo-order");
4420 if (progress && all_progress_implied)
4421 progress = 2;
4423 add_extra_kept_packs(&keep_pack_list);
4424 if (ignore_packed_keep_on_disk) {
4425 struct packed_git *p;
4426 for (p = get_all_packs(the_repository); p; p = p->next)
4427 if (p->pack_local && p->pack_keep)
4428 break;
4429 if (!p) /* no keep-able packs found */
4430 ignore_packed_keep_on_disk = 0;
4432 if (local) {
4434 * unlike ignore_packed_keep_on_disk above, we do not
4435 * want to unset "local" based on looking at packs, as
4436 * it also covers non-local objects
4438 struct packed_git *p;
4439 for (p = get_all_packs(the_repository); p; p = p->next) {
4440 if (!p->pack_local) {
4441 have_non_local_packs = 1;
4442 break;
4447 trace2_region_enter("pack-objects", "enumerate-objects",
4448 the_repository);
4449 prepare_packing_data(the_repository, &to_pack);
4451 if (progress && !cruft)
4452 progress_state = start_progress(_("Enumerating objects"), 0);
4453 if (stdin_packs) {
4454 /* avoids adding objects in excluded packs */
4455 ignore_packed_keep_in_core = 1;
4456 read_packs_list_from_stdin();
4457 if (rev_list_unpacked)
4458 add_unreachable_loose_objects();
4459 } else if (cruft) {
4460 read_cruft_objects();
4461 } else if (!use_internal_rev_list) {
4462 read_object_list_from_stdin();
4463 } else {
4464 struct rev_info revs;
4466 repo_init_revisions(the_repository, &revs, NULL);
4467 list_objects_filter_copy(&revs.filter, &filter_options);
4468 get_object_list(&revs, rp.nr, rp.v);
4469 release_revisions(&revs);
4471 cleanup_preferred_base();
4472 if (include_tag && nr_result)
4473 for_each_tag_ref(add_ref_tag, NULL);
4474 stop_progress(&progress_state);
4475 trace2_region_leave("pack-objects", "enumerate-objects",
4476 the_repository);
4478 if (non_empty && !nr_result)
4479 goto cleanup;
4480 if (nr_result) {
4481 trace2_region_enter("pack-objects", "prepare-pack",
4482 the_repository);
4483 prepare_pack(window, depth);
4484 trace2_region_leave("pack-objects", "prepare-pack",
4485 the_repository);
4488 trace2_region_enter("pack-objects", "write-pack-file", the_repository);
4489 write_excluded_by_configs();
4490 write_pack_file();
4491 trace2_region_leave("pack-objects", "write-pack-file", the_repository);
4493 if (progress)
4494 fprintf_ln(stderr,
4495 _("Total %"PRIu32" (delta %"PRIu32"),"
4496 " reused %"PRIu32" (delta %"PRIu32"),"
4497 " pack-reused %"PRIu32),
4498 written, written_delta, reused, reused_delta,
4499 reuse_packfile_objects);
4501 cleanup:
4502 list_objects_filter_release(&filter_options);
4503 strvec_clear(&rp);
4505 return 0;