apply: rename and move opt constants to apply.h
[alt-git.git] / builtin / pack-objects.c
blob92e2e5f7a8190c546f2c0cc9bc9724a04d330052
1 #include "builtin.h"
2 #include "cache.h"
3 #include "attr.h"
4 #include "object.h"
5 #include "blob.h"
6 #include "commit.h"
7 #include "tag.h"
8 #include "tree.h"
9 #include "delta.h"
10 #include "pack.h"
11 #include "pack-revindex.h"
12 #include "csum-file.h"
13 #include "tree-walk.h"
14 #include "diff.h"
15 #include "revision.h"
16 #include "list-objects.h"
17 #include "pack-objects.h"
18 #include "progress.h"
19 #include "refs.h"
20 #include "streaming.h"
21 #include "thread-utils.h"
22 #include "pack-bitmap.h"
23 #include "reachable.h"
24 #include "sha1-array.h"
25 #include "argv-array.h"
27 static const char *pack_usage[] = {
28 N_("git pack-objects --stdout [<options>...] [< <ref-list> | < <object-list>]"),
29 N_("git pack-objects [<options>...] <base-name> [< <ref-list> | < <object-list>]"),
30 NULL
34 * Objects we are going to pack are collected in the `to_pack` structure.
35 * It contains an array (dynamically expanded) of the object data, and a map
36 * that can resolve SHA1s to their position in the array.
38 static struct packing_data to_pack;
40 static struct pack_idx_entry **written_list;
41 static uint32_t nr_result, nr_written;
43 static int non_empty;
44 static int reuse_delta = 1, reuse_object = 1;
45 static int keep_unreachable, unpack_unreachable, include_tag;
46 static unsigned long unpack_unreachable_expiration;
47 static int pack_loose_unreachable;
48 static int local;
49 static int incremental;
50 static int ignore_packed_keep;
51 static int allow_ofs_delta;
52 static struct pack_idx_option pack_idx_opts;
53 static const char *base_name;
54 static int progress = 1;
55 static int window = 10;
56 static unsigned long pack_size_limit;
57 static int depth = 50;
58 static int delta_search_threads;
59 static int pack_to_stdout;
60 static int num_preferred_base;
61 static struct progress *progress_state;
62 static int pack_compression_level = Z_DEFAULT_COMPRESSION;
63 static int pack_compression_seen;
65 static struct packed_git *reuse_packfile;
66 static uint32_t reuse_packfile_objects;
67 static off_t reuse_packfile_offset;
69 static int use_bitmap_index = 1;
70 static int write_bitmap_index;
71 static uint16_t write_bitmap_options;
73 static unsigned long delta_cache_size = 0;
74 static unsigned long max_delta_cache_size = 256 * 1024 * 1024;
75 static unsigned long cache_max_small_delta_size = 1000;
77 static unsigned long window_memory_limit = 0;
80 * stats
82 static uint32_t written, written_delta;
83 static uint32_t reused, reused_delta;
86 * Indexed commits
88 static struct commit **indexed_commits;
89 static unsigned int indexed_commits_nr;
90 static unsigned int indexed_commits_alloc;
92 static void index_commit_for_bitmap(struct commit *commit)
94 if (indexed_commits_nr >= indexed_commits_alloc) {
95 indexed_commits_alloc = (indexed_commits_alloc + 32) * 2;
96 REALLOC_ARRAY(indexed_commits, indexed_commits_alloc);
99 indexed_commits[indexed_commits_nr++] = commit;
102 static void *get_delta(struct object_entry *entry)
104 unsigned long size, base_size, delta_size;
105 void *buf, *base_buf, *delta_buf;
106 enum object_type type;
108 buf = read_sha1_file(entry->idx.sha1, &type, &size);
109 if (!buf)
110 die("unable to read %s", sha1_to_hex(entry->idx.sha1));
111 base_buf = read_sha1_file(entry->delta->idx.sha1, &type, &base_size);
112 if (!base_buf)
113 die("unable to read %s", sha1_to_hex(entry->delta->idx.sha1));
114 delta_buf = diff_delta(base_buf, base_size,
115 buf, size, &delta_size, 0);
116 if (!delta_buf || delta_size != entry->delta_size)
117 die("delta size changed");
118 free(buf);
119 free(base_buf);
120 return delta_buf;
123 static unsigned long do_compress(void **pptr, unsigned long size)
125 git_zstream stream;
126 void *in, *out;
127 unsigned long maxsize;
129 git_deflate_init(&stream, pack_compression_level);
130 maxsize = git_deflate_bound(&stream, size);
132 in = *pptr;
133 out = xmalloc(maxsize);
134 *pptr = out;
136 stream.next_in = in;
137 stream.avail_in = size;
138 stream.next_out = out;
139 stream.avail_out = maxsize;
140 while (git_deflate(&stream, Z_FINISH) == Z_OK)
141 ; /* nothing */
142 git_deflate_end(&stream);
144 free(in);
145 return stream.total_out;
148 static unsigned long write_large_blob_data(struct git_istream *st, struct sha1file *f,
149 const unsigned char *sha1)
151 git_zstream stream;
152 unsigned char ibuf[1024 * 16];
153 unsigned char obuf[1024 * 16];
154 unsigned long olen = 0;
156 git_deflate_init(&stream, pack_compression_level);
158 for (;;) {
159 ssize_t readlen;
160 int zret = Z_OK;
161 readlen = read_istream(st, ibuf, sizeof(ibuf));
162 if (readlen == -1)
163 die(_("unable to read %s"), sha1_to_hex(sha1));
165 stream.next_in = ibuf;
166 stream.avail_in = readlen;
167 while ((stream.avail_in || readlen == 0) &&
168 (zret == Z_OK || zret == Z_BUF_ERROR)) {
169 stream.next_out = obuf;
170 stream.avail_out = sizeof(obuf);
171 zret = git_deflate(&stream, readlen ? 0 : Z_FINISH);
172 sha1write(f, obuf, stream.next_out - obuf);
173 olen += stream.next_out - obuf;
175 if (stream.avail_in)
176 die(_("deflate error (%d)"), zret);
177 if (readlen == 0) {
178 if (zret != Z_STREAM_END)
179 die(_("deflate error (%d)"), zret);
180 break;
183 git_deflate_end(&stream);
184 return olen;
188 * we are going to reuse the existing object data as is. make
189 * sure it is not corrupt.
191 static int check_pack_inflate(struct packed_git *p,
192 struct pack_window **w_curs,
193 off_t offset,
194 off_t len,
195 unsigned long expect)
197 git_zstream stream;
198 unsigned char fakebuf[4096], *in;
199 int st;
201 memset(&stream, 0, sizeof(stream));
202 git_inflate_init(&stream);
203 do {
204 in = use_pack(p, w_curs, offset, &stream.avail_in);
205 stream.next_in = in;
206 stream.next_out = fakebuf;
207 stream.avail_out = sizeof(fakebuf);
208 st = git_inflate(&stream, Z_FINISH);
209 offset += stream.next_in - in;
210 } while (st == Z_OK || st == Z_BUF_ERROR);
211 git_inflate_end(&stream);
212 return (st == Z_STREAM_END &&
213 stream.total_out == expect &&
214 stream.total_in == len) ? 0 : -1;
217 static void copy_pack_data(struct sha1file *f,
218 struct packed_git *p,
219 struct pack_window **w_curs,
220 off_t offset,
221 off_t len)
223 unsigned char *in;
224 unsigned long avail;
226 while (len) {
227 in = use_pack(p, w_curs, offset, &avail);
228 if (avail > len)
229 avail = (unsigned long)len;
230 sha1write(f, in, avail);
231 offset += avail;
232 len -= avail;
236 /* Return 0 if we will bust the pack-size limit */
237 static unsigned long write_no_reuse_object(struct sha1file *f, struct object_entry *entry,
238 unsigned long limit, int usable_delta)
240 unsigned long size, datalen;
241 unsigned char header[10], dheader[10];
242 unsigned hdrlen;
243 enum object_type type;
244 void *buf;
245 struct git_istream *st = NULL;
247 if (!usable_delta) {
248 if (entry->type == OBJ_BLOB &&
249 entry->size > big_file_threshold &&
250 (st = open_istream(entry->idx.sha1, &type, &size, NULL)) != NULL)
251 buf = NULL;
252 else {
253 buf = read_sha1_file(entry->idx.sha1, &type, &size);
254 if (!buf)
255 die(_("unable to read %s"), sha1_to_hex(entry->idx.sha1));
258 * make sure no cached delta data remains from a
259 * previous attempt before a pack split occurred.
261 free(entry->delta_data);
262 entry->delta_data = NULL;
263 entry->z_delta_size = 0;
264 } else if (entry->delta_data) {
265 size = entry->delta_size;
266 buf = entry->delta_data;
267 entry->delta_data = NULL;
268 type = (allow_ofs_delta && entry->delta->idx.offset) ?
269 OBJ_OFS_DELTA : OBJ_REF_DELTA;
270 } else {
271 buf = get_delta(entry);
272 size = entry->delta_size;
273 type = (allow_ofs_delta && entry->delta->idx.offset) ?
274 OBJ_OFS_DELTA : OBJ_REF_DELTA;
277 if (st) /* large blob case, just assume we don't compress well */
278 datalen = size;
279 else if (entry->z_delta_size)
280 datalen = entry->z_delta_size;
281 else
282 datalen = do_compress(&buf, size);
285 * The object header is a byte of 'type' followed by zero or
286 * more bytes of length.
288 hdrlen = encode_in_pack_object_header(type, size, header);
290 if (type == OBJ_OFS_DELTA) {
292 * Deltas with relative base contain an additional
293 * encoding of the relative offset for the delta
294 * base from this object's position in the pack.
296 off_t ofs = entry->idx.offset - entry->delta->idx.offset;
297 unsigned pos = sizeof(dheader) - 1;
298 dheader[pos] = ofs & 127;
299 while (ofs >>= 7)
300 dheader[--pos] = 128 | (--ofs & 127);
301 if (limit && hdrlen + sizeof(dheader) - pos + datalen + 20 >= limit) {
302 if (st)
303 close_istream(st);
304 free(buf);
305 return 0;
307 sha1write(f, header, hdrlen);
308 sha1write(f, dheader + pos, sizeof(dheader) - pos);
309 hdrlen += sizeof(dheader) - pos;
310 } else if (type == OBJ_REF_DELTA) {
312 * Deltas with a base reference contain
313 * an additional 20 bytes for the base sha1.
315 if (limit && hdrlen + 20 + datalen + 20 >= limit) {
316 if (st)
317 close_istream(st);
318 free(buf);
319 return 0;
321 sha1write(f, header, hdrlen);
322 sha1write(f, entry->delta->idx.sha1, 20);
323 hdrlen += 20;
324 } else {
325 if (limit && hdrlen + datalen + 20 >= limit) {
326 if (st)
327 close_istream(st);
328 free(buf);
329 return 0;
331 sha1write(f, header, hdrlen);
333 if (st) {
334 datalen = write_large_blob_data(st, f, entry->idx.sha1);
335 close_istream(st);
336 } else {
337 sha1write(f, buf, datalen);
338 free(buf);
341 return hdrlen + datalen;
344 /* Return 0 if we will bust the pack-size limit */
345 static off_t write_reuse_object(struct sha1file *f, struct object_entry *entry,
346 unsigned long limit, int usable_delta)
348 struct packed_git *p = entry->in_pack;
349 struct pack_window *w_curs = NULL;
350 struct revindex_entry *revidx;
351 off_t offset;
352 enum object_type type = entry->type;
353 off_t datalen;
354 unsigned char header[10], dheader[10];
355 unsigned hdrlen;
357 if (entry->delta)
358 type = (allow_ofs_delta && entry->delta->idx.offset) ?
359 OBJ_OFS_DELTA : OBJ_REF_DELTA;
360 hdrlen = encode_in_pack_object_header(type, entry->size, header);
362 offset = entry->in_pack_offset;
363 revidx = find_pack_revindex(p, offset);
364 datalen = revidx[1].offset - offset;
365 if (!pack_to_stdout && p->index_version > 1 &&
366 check_pack_crc(p, &w_curs, offset, datalen, revidx->nr)) {
367 error("bad packed object CRC for %s", sha1_to_hex(entry->idx.sha1));
368 unuse_pack(&w_curs);
369 return write_no_reuse_object(f, entry, limit, usable_delta);
372 offset += entry->in_pack_header_size;
373 datalen -= entry->in_pack_header_size;
375 if (!pack_to_stdout && p->index_version == 1 &&
376 check_pack_inflate(p, &w_curs, offset, datalen, entry->size)) {
377 error("corrupt packed object for %s", sha1_to_hex(entry->idx.sha1));
378 unuse_pack(&w_curs);
379 return write_no_reuse_object(f, entry, limit, usable_delta);
382 if (type == OBJ_OFS_DELTA) {
383 off_t ofs = entry->idx.offset - entry->delta->idx.offset;
384 unsigned pos = sizeof(dheader) - 1;
385 dheader[pos] = ofs & 127;
386 while (ofs >>= 7)
387 dheader[--pos] = 128 | (--ofs & 127);
388 if (limit && hdrlen + sizeof(dheader) - pos + datalen + 20 >= limit) {
389 unuse_pack(&w_curs);
390 return 0;
392 sha1write(f, header, hdrlen);
393 sha1write(f, dheader + pos, sizeof(dheader) - pos);
394 hdrlen += sizeof(dheader) - pos;
395 reused_delta++;
396 } else if (type == OBJ_REF_DELTA) {
397 if (limit && hdrlen + 20 + datalen + 20 >= limit) {
398 unuse_pack(&w_curs);
399 return 0;
401 sha1write(f, header, hdrlen);
402 sha1write(f, entry->delta->idx.sha1, 20);
403 hdrlen += 20;
404 reused_delta++;
405 } else {
406 if (limit && hdrlen + datalen + 20 >= limit) {
407 unuse_pack(&w_curs);
408 return 0;
410 sha1write(f, header, hdrlen);
412 copy_pack_data(f, p, &w_curs, offset, datalen);
413 unuse_pack(&w_curs);
414 reused++;
415 return hdrlen + datalen;
418 /* Return 0 if we will bust the pack-size limit */
419 static off_t write_object(struct sha1file *f,
420 struct object_entry *entry,
421 off_t write_offset)
423 unsigned long limit;
424 off_t len;
425 int usable_delta, to_reuse;
427 if (!pack_to_stdout)
428 crc32_begin(f);
430 /* apply size limit if limited packsize and not first object */
431 if (!pack_size_limit || !nr_written)
432 limit = 0;
433 else if (pack_size_limit <= write_offset)
435 * the earlier object did not fit the limit; avoid
436 * mistaking this with unlimited (i.e. limit = 0).
438 limit = 1;
439 else
440 limit = pack_size_limit - write_offset;
442 if (!entry->delta)
443 usable_delta = 0; /* no delta */
444 else if (!pack_size_limit)
445 usable_delta = 1; /* unlimited packfile */
446 else if (entry->delta->idx.offset == (off_t)-1)
447 usable_delta = 0; /* base was written to another pack */
448 else if (entry->delta->idx.offset)
449 usable_delta = 1; /* base already exists in this pack */
450 else
451 usable_delta = 0; /* base could end up in another pack */
453 if (!reuse_object)
454 to_reuse = 0; /* explicit */
455 else if (!entry->in_pack)
456 to_reuse = 0; /* can't reuse what we don't have */
457 else if (entry->type == OBJ_REF_DELTA || entry->type == OBJ_OFS_DELTA)
458 /* check_object() decided it for us ... */
459 to_reuse = usable_delta;
460 /* ... but pack split may override that */
461 else if (entry->type != entry->in_pack_type)
462 to_reuse = 0; /* pack has delta which is unusable */
463 else if (entry->delta)
464 to_reuse = 0; /* we want to pack afresh */
465 else
466 to_reuse = 1; /* we have it in-pack undeltified,
467 * and we do not need to deltify it.
470 if (!to_reuse)
471 len = write_no_reuse_object(f, entry, limit, usable_delta);
472 else
473 len = write_reuse_object(f, entry, limit, usable_delta);
474 if (!len)
475 return 0;
477 if (usable_delta)
478 written_delta++;
479 written++;
480 if (!pack_to_stdout)
481 entry->idx.crc32 = crc32_end(f);
482 return len;
485 enum write_one_status {
486 WRITE_ONE_SKIP = -1, /* already written */
487 WRITE_ONE_BREAK = 0, /* writing this will bust the limit; not written */
488 WRITE_ONE_WRITTEN = 1, /* normal */
489 WRITE_ONE_RECURSIVE = 2 /* already scheduled to be written */
492 static enum write_one_status write_one(struct sha1file *f,
493 struct object_entry *e,
494 off_t *offset)
496 off_t size;
497 int recursing;
500 * we set offset to 1 (which is an impossible value) to mark
501 * the fact that this object is involved in "write its base
502 * first before writing a deltified object" recursion.
504 recursing = (e->idx.offset == 1);
505 if (recursing) {
506 warning("recursive delta detected for object %s",
507 sha1_to_hex(e->idx.sha1));
508 return WRITE_ONE_RECURSIVE;
509 } else if (e->idx.offset || e->preferred_base) {
510 /* offset is non zero if object is written already. */
511 return WRITE_ONE_SKIP;
514 /* if we are deltified, write out base object first. */
515 if (e->delta) {
516 e->idx.offset = 1; /* now recurse */
517 switch (write_one(f, e->delta, offset)) {
518 case WRITE_ONE_RECURSIVE:
519 /* we cannot depend on this one */
520 e->delta = NULL;
521 break;
522 default:
523 break;
524 case WRITE_ONE_BREAK:
525 e->idx.offset = recursing;
526 return WRITE_ONE_BREAK;
530 e->idx.offset = *offset;
531 size = write_object(f, e, *offset);
532 if (!size) {
533 e->idx.offset = recursing;
534 return WRITE_ONE_BREAK;
536 written_list[nr_written++] = &e->idx;
538 /* make sure off_t is sufficiently large not to wrap */
539 if (signed_add_overflows(*offset, size))
540 die("pack too large for current definition of off_t");
541 *offset += size;
542 return WRITE_ONE_WRITTEN;
545 static int mark_tagged(const char *path, const struct object_id *oid, int flag,
546 void *cb_data)
548 unsigned char peeled[20];
549 struct object_entry *entry = packlist_find(&to_pack, oid->hash, NULL);
551 if (entry)
552 entry->tagged = 1;
553 if (!peel_ref(path, peeled)) {
554 entry = packlist_find(&to_pack, peeled, NULL);
555 if (entry)
556 entry->tagged = 1;
558 return 0;
561 static inline void add_to_write_order(struct object_entry **wo,
562 unsigned int *endp,
563 struct object_entry *e)
565 if (e->filled)
566 return;
567 wo[(*endp)++] = e;
568 e->filled = 1;
571 static void add_descendants_to_write_order(struct object_entry **wo,
572 unsigned int *endp,
573 struct object_entry *e)
575 int add_to_order = 1;
576 while (e) {
577 if (add_to_order) {
578 struct object_entry *s;
579 /* add this node... */
580 add_to_write_order(wo, endp, e);
581 /* all its siblings... */
582 for (s = e->delta_sibling; s; s = s->delta_sibling) {
583 add_to_write_order(wo, endp, s);
586 /* drop down a level to add left subtree nodes if possible */
587 if (e->delta_child) {
588 add_to_order = 1;
589 e = e->delta_child;
590 } else {
591 add_to_order = 0;
592 /* our sibling might have some children, it is next */
593 if (e->delta_sibling) {
594 e = e->delta_sibling;
595 continue;
597 /* go back to our parent node */
598 e = e->delta;
599 while (e && !e->delta_sibling) {
600 /* we're on the right side of a subtree, keep
601 * going up until we can go right again */
602 e = e->delta;
604 if (!e) {
605 /* done- we hit our original root node */
606 return;
608 /* pass it off to sibling at this level */
609 e = e->delta_sibling;
614 static void add_family_to_write_order(struct object_entry **wo,
615 unsigned int *endp,
616 struct object_entry *e)
618 struct object_entry *root;
620 for (root = e; root->delta; root = root->delta)
621 ; /* nothing */
622 add_descendants_to_write_order(wo, endp, root);
625 static struct object_entry **compute_write_order(void)
627 unsigned int i, wo_end, last_untagged;
629 struct object_entry **wo;
630 struct object_entry *objects = to_pack.objects;
632 for (i = 0; i < to_pack.nr_objects; i++) {
633 objects[i].tagged = 0;
634 objects[i].filled = 0;
635 objects[i].delta_child = NULL;
636 objects[i].delta_sibling = NULL;
640 * Fully connect delta_child/delta_sibling network.
641 * Make sure delta_sibling is sorted in the original
642 * recency order.
644 for (i = to_pack.nr_objects; i > 0;) {
645 struct object_entry *e = &objects[--i];
646 if (!e->delta)
647 continue;
648 /* Mark me as the first child */
649 e->delta_sibling = e->delta->delta_child;
650 e->delta->delta_child = e;
654 * Mark objects that are at the tip of tags.
656 for_each_tag_ref(mark_tagged, NULL);
659 * Give the objects in the original recency order until
660 * we see a tagged tip.
662 ALLOC_ARRAY(wo, to_pack.nr_objects);
663 for (i = wo_end = 0; i < to_pack.nr_objects; i++) {
664 if (objects[i].tagged)
665 break;
666 add_to_write_order(wo, &wo_end, &objects[i]);
668 last_untagged = i;
671 * Then fill all the tagged tips.
673 for (; i < to_pack.nr_objects; i++) {
674 if (objects[i].tagged)
675 add_to_write_order(wo, &wo_end, &objects[i]);
679 * And then all remaining commits and tags.
681 for (i = last_untagged; i < to_pack.nr_objects; i++) {
682 if (objects[i].type != OBJ_COMMIT &&
683 objects[i].type != OBJ_TAG)
684 continue;
685 add_to_write_order(wo, &wo_end, &objects[i]);
689 * And then all the trees.
691 for (i = last_untagged; i < to_pack.nr_objects; i++) {
692 if (objects[i].type != OBJ_TREE)
693 continue;
694 add_to_write_order(wo, &wo_end, &objects[i]);
698 * Finally all the rest in really tight order
700 for (i = last_untagged; i < to_pack.nr_objects; i++) {
701 if (!objects[i].filled)
702 add_family_to_write_order(wo, &wo_end, &objects[i]);
705 if (wo_end != to_pack.nr_objects)
706 die("ordered %u objects, expected %"PRIu32, wo_end, to_pack.nr_objects);
708 return wo;
711 static off_t write_reused_pack(struct sha1file *f)
713 unsigned char buffer[8192];
714 off_t to_write, total;
715 int fd;
717 if (!is_pack_valid(reuse_packfile))
718 die("packfile is invalid: %s", reuse_packfile->pack_name);
720 fd = git_open_noatime(reuse_packfile->pack_name);
721 if (fd < 0)
722 die_errno("unable to open packfile for reuse: %s",
723 reuse_packfile->pack_name);
725 if (lseek(fd, sizeof(struct pack_header), SEEK_SET) == -1)
726 die_errno("unable to seek in reused packfile");
728 if (reuse_packfile_offset < 0)
729 reuse_packfile_offset = reuse_packfile->pack_size - 20;
731 total = to_write = reuse_packfile_offset - sizeof(struct pack_header);
733 while (to_write) {
734 int read_pack = xread(fd, buffer, sizeof(buffer));
736 if (read_pack <= 0)
737 die_errno("unable to read from reused packfile");
739 if (read_pack > to_write)
740 read_pack = to_write;
742 sha1write(f, buffer, read_pack);
743 to_write -= read_pack;
746 * We don't know the actual number of objects written,
747 * only how many bytes written, how many bytes total, and
748 * how many objects total. So we can fake it by pretending all
749 * objects we are writing are the same size. This gives us a
750 * smooth progress meter, and at the end it matches the true
751 * answer.
753 written = reuse_packfile_objects *
754 (((double)(total - to_write)) / total);
755 display_progress(progress_state, written);
758 close(fd);
759 written = reuse_packfile_objects;
760 display_progress(progress_state, written);
761 return reuse_packfile_offset - sizeof(struct pack_header);
764 static const char no_split_warning[] = N_(
765 "disabling bitmap writing, packs are split due to pack.packSizeLimit"
768 static void write_pack_file(void)
770 uint32_t i = 0, j;
771 struct sha1file *f;
772 off_t offset;
773 uint32_t nr_remaining = nr_result;
774 time_t last_mtime = 0;
775 struct object_entry **write_order;
777 if (progress > pack_to_stdout)
778 progress_state = start_progress(_("Writing objects"), nr_result);
779 ALLOC_ARRAY(written_list, to_pack.nr_objects);
780 write_order = compute_write_order();
782 do {
783 unsigned char sha1[20];
784 char *pack_tmp_name = NULL;
786 if (pack_to_stdout)
787 f = sha1fd_throughput(1, "<stdout>", progress_state);
788 else
789 f = create_tmp_packfile(&pack_tmp_name);
791 offset = write_pack_header(f, nr_remaining);
793 if (reuse_packfile) {
794 off_t packfile_size;
795 assert(pack_to_stdout);
797 packfile_size = write_reused_pack(f);
798 offset += packfile_size;
801 nr_written = 0;
802 for (; i < to_pack.nr_objects; i++) {
803 struct object_entry *e = write_order[i];
804 if (write_one(f, e, &offset) == WRITE_ONE_BREAK)
805 break;
806 display_progress(progress_state, written);
810 * Did we write the wrong # entries in the header?
811 * If so, rewrite it like in fast-import
813 if (pack_to_stdout) {
814 sha1close(f, sha1, CSUM_CLOSE);
815 } else if (nr_written == nr_remaining) {
816 sha1close(f, sha1, CSUM_FSYNC);
817 } else {
818 int fd = sha1close(f, sha1, 0);
819 fixup_pack_header_footer(fd, sha1, pack_tmp_name,
820 nr_written, sha1, offset);
821 close(fd);
822 if (write_bitmap_index) {
823 warning(_(no_split_warning));
824 write_bitmap_index = 0;
828 if (!pack_to_stdout) {
829 struct stat st;
830 struct strbuf tmpname = STRBUF_INIT;
833 * Packs are runtime accessed in their mtime
834 * order since newer packs are more likely to contain
835 * younger objects. So if we are creating multiple
836 * packs then we should modify the mtime of later ones
837 * to preserve this property.
839 if (stat(pack_tmp_name, &st) < 0) {
840 warning_errno("failed to stat %s", pack_tmp_name);
841 } else if (!last_mtime) {
842 last_mtime = st.st_mtime;
843 } else {
844 struct utimbuf utb;
845 utb.actime = st.st_atime;
846 utb.modtime = --last_mtime;
847 if (utime(pack_tmp_name, &utb) < 0)
848 warning_errno("failed utime() on %s", pack_tmp_name);
851 strbuf_addf(&tmpname, "%s-", base_name);
853 if (write_bitmap_index) {
854 bitmap_writer_set_checksum(sha1);
855 bitmap_writer_build_type_index(written_list, nr_written);
858 finish_tmp_packfile(&tmpname, pack_tmp_name,
859 written_list, nr_written,
860 &pack_idx_opts, sha1);
862 if (write_bitmap_index) {
863 strbuf_addf(&tmpname, "%s.bitmap", sha1_to_hex(sha1));
865 stop_progress(&progress_state);
867 bitmap_writer_show_progress(progress);
868 bitmap_writer_reuse_bitmaps(&to_pack);
869 bitmap_writer_select_commits(indexed_commits, indexed_commits_nr, -1);
870 bitmap_writer_build(&to_pack);
871 bitmap_writer_finish(written_list, nr_written,
872 tmpname.buf, write_bitmap_options);
873 write_bitmap_index = 0;
876 strbuf_release(&tmpname);
877 free(pack_tmp_name);
878 puts(sha1_to_hex(sha1));
881 /* mark written objects as written to previous pack */
882 for (j = 0; j < nr_written; j++) {
883 written_list[j]->offset = (off_t)-1;
885 nr_remaining -= nr_written;
886 } while (nr_remaining && i < to_pack.nr_objects);
888 free(written_list);
889 free(write_order);
890 stop_progress(&progress_state);
891 if (written != nr_result)
892 die("wrote %"PRIu32" objects while expecting %"PRIu32,
893 written, nr_result);
896 static void setup_delta_attr_check(struct git_attr_check *check)
898 static struct git_attr *attr_delta;
900 if (!attr_delta)
901 attr_delta = git_attr("delta");
903 check[0].attr = attr_delta;
906 static int no_try_delta(const char *path)
908 struct git_attr_check check[1];
910 setup_delta_attr_check(check);
911 if (git_check_attr(path, ARRAY_SIZE(check), check))
912 return 0;
913 if (ATTR_FALSE(check->value))
914 return 1;
915 return 0;
919 * When adding an object, check whether we have already added it
920 * to our packing list. If so, we can skip. However, if we are
921 * being asked to excludei t, but the previous mention was to include
922 * it, make sure to adjust its flags and tweak our numbers accordingly.
924 * As an optimization, we pass out the index position where we would have
925 * found the item, since that saves us from having to look it up again a
926 * few lines later when we want to add the new entry.
928 static int have_duplicate_entry(const unsigned char *sha1,
929 int exclude,
930 uint32_t *index_pos)
932 struct object_entry *entry;
934 entry = packlist_find(&to_pack, sha1, index_pos);
935 if (!entry)
936 return 0;
938 if (exclude) {
939 if (!entry->preferred_base)
940 nr_result--;
941 entry->preferred_base = 1;
944 return 1;
948 * Check whether we want the object in the pack (e.g., we do not want
949 * objects found in non-local stores if the "--local" option was used).
951 * As a side effect of this check, we will find the packed version of this
952 * object, if any. We therefore pass out the pack information to avoid having
953 * to look it up again later.
955 static int want_object_in_pack(const unsigned char *sha1,
956 int exclude,
957 struct packed_git **found_pack,
958 off_t *found_offset)
960 struct packed_git *p;
962 if (!exclude && local && has_loose_object_nonlocal(sha1))
963 return 0;
965 *found_pack = NULL;
966 *found_offset = 0;
968 for (p = packed_git; p; p = p->next) {
969 off_t offset = find_pack_entry_one(sha1, p);
970 if (offset) {
971 if (!*found_pack) {
972 if (!is_pack_valid(p))
973 continue;
974 *found_offset = offset;
975 *found_pack = p;
977 if (exclude)
978 return 1;
979 if (incremental)
980 return 0;
981 if (local && !p->pack_local)
982 return 0;
983 if (ignore_packed_keep && p->pack_local && p->pack_keep)
984 return 0;
988 return 1;
991 static void create_object_entry(const unsigned char *sha1,
992 enum object_type type,
993 uint32_t hash,
994 int exclude,
995 int no_try_delta,
996 uint32_t index_pos,
997 struct packed_git *found_pack,
998 off_t found_offset)
1000 struct object_entry *entry;
1002 entry = packlist_alloc(&to_pack, sha1, index_pos);
1003 entry->hash = hash;
1004 if (type)
1005 entry->type = type;
1006 if (exclude)
1007 entry->preferred_base = 1;
1008 else
1009 nr_result++;
1010 if (found_pack) {
1011 entry->in_pack = found_pack;
1012 entry->in_pack_offset = found_offset;
1015 entry->no_try_delta = no_try_delta;
1018 static const char no_closure_warning[] = N_(
1019 "disabling bitmap writing, as some objects are not being packed"
1022 static int add_object_entry(const unsigned char *sha1, enum object_type type,
1023 const char *name, int exclude)
1025 struct packed_git *found_pack;
1026 off_t found_offset;
1027 uint32_t index_pos;
1029 if (have_duplicate_entry(sha1, exclude, &index_pos))
1030 return 0;
1032 if (!want_object_in_pack(sha1, exclude, &found_pack, &found_offset)) {
1033 /* The pack is missing an object, so it will not have closure */
1034 if (write_bitmap_index) {
1035 warning(_(no_closure_warning));
1036 write_bitmap_index = 0;
1038 return 0;
1041 create_object_entry(sha1, type, pack_name_hash(name),
1042 exclude, name && no_try_delta(name),
1043 index_pos, found_pack, found_offset);
1045 display_progress(progress_state, nr_result);
1046 return 1;
1049 static int add_object_entry_from_bitmap(const unsigned char *sha1,
1050 enum object_type type,
1051 int flags, uint32_t name_hash,
1052 struct packed_git *pack, off_t offset)
1054 uint32_t index_pos;
1056 if (have_duplicate_entry(sha1, 0, &index_pos))
1057 return 0;
1059 create_object_entry(sha1, type, name_hash, 0, 0, index_pos, pack, offset);
1061 display_progress(progress_state, nr_result);
1062 return 1;
1065 struct pbase_tree_cache {
1066 unsigned char sha1[20];
1067 int ref;
1068 int temporary;
1069 void *tree_data;
1070 unsigned long tree_size;
1073 static struct pbase_tree_cache *(pbase_tree_cache[256]);
1074 static int pbase_tree_cache_ix(const unsigned char *sha1)
1076 return sha1[0] % ARRAY_SIZE(pbase_tree_cache);
1078 static int pbase_tree_cache_ix_incr(int ix)
1080 return (ix+1) % ARRAY_SIZE(pbase_tree_cache);
1083 static struct pbase_tree {
1084 struct pbase_tree *next;
1085 /* This is a phony "cache" entry; we are not
1086 * going to evict it or find it through _get()
1087 * mechanism -- this is for the toplevel node that
1088 * would almost always change with any commit.
1090 struct pbase_tree_cache pcache;
1091 } *pbase_tree;
1093 static struct pbase_tree_cache *pbase_tree_get(const unsigned char *sha1)
1095 struct pbase_tree_cache *ent, *nent;
1096 void *data;
1097 unsigned long size;
1098 enum object_type type;
1099 int neigh;
1100 int my_ix = pbase_tree_cache_ix(sha1);
1101 int available_ix = -1;
1103 /* pbase-tree-cache acts as a limited hashtable.
1104 * your object will be found at your index or within a few
1105 * slots after that slot if it is cached.
1107 for (neigh = 0; neigh < 8; neigh++) {
1108 ent = pbase_tree_cache[my_ix];
1109 if (ent && !hashcmp(ent->sha1, sha1)) {
1110 ent->ref++;
1111 return ent;
1113 else if (((available_ix < 0) && (!ent || !ent->ref)) ||
1114 ((0 <= available_ix) &&
1115 (!ent && pbase_tree_cache[available_ix])))
1116 available_ix = my_ix;
1117 if (!ent)
1118 break;
1119 my_ix = pbase_tree_cache_ix_incr(my_ix);
1122 /* Did not find one. Either we got a bogus request or
1123 * we need to read and perhaps cache.
1125 data = read_sha1_file(sha1, &type, &size);
1126 if (!data)
1127 return NULL;
1128 if (type != OBJ_TREE) {
1129 free(data);
1130 return NULL;
1133 /* We need to either cache or return a throwaway copy */
1135 if (available_ix < 0)
1136 ent = NULL;
1137 else {
1138 ent = pbase_tree_cache[available_ix];
1139 my_ix = available_ix;
1142 if (!ent) {
1143 nent = xmalloc(sizeof(*nent));
1144 nent->temporary = (available_ix < 0);
1146 else {
1147 /* evict and reuse */
1148 free(ent->tree_data);
1149 nent = ent;
1151 hashcpy(nent->sha1, sha1);
1152 nent->tree_data = data;
1153 nent->tree_size = size;
1154 nent->ref = 1;
1155 if (!nent->temporary)
1156 pbase_tree_cache[my_ix] = nent;
1157 return nent;
1160 static void pbase_tree_put(struct pbase_tree_cache *cache)
1162 if (!cache->temporary) {
1163 cache->ref--;
1164 return;
1166 free(cache->tree_data);
1167 free(cache);
1170 static int name_cmp_len(const char *name)
1172 int i;
1173 for (i = 0; name[i] && name[i] != '\n' && name[i] != '/'; i++)
1175 return i;
1178 static void add_pbase_object(struct tree_desc *tree,
1179 const char *name,
1180 int cmplen,
1181 const char *fullname)
1183 struct name_entry entry;
1184 int cmp;
1186 while (tree_entry(tree,&entry)) {
1187 if (S_ISGITLINK(entry.mode))
1188 continue;
1189 cmp = tree_entry_len(&entry) != cmplen ? 1 :
1190 memcmp(name, entry.path, cmplen);
1191 if (cmp > 0)
1192 continue;
1193 if (cmp < 0)
1194 return;
1195 if (name[cmplen] != '/') {
1196 add_object_entry(entry.oid->hash,
1197 object_type(entry.mode),
1198 fullname, 1);
1199 return;
1201 if (S_ISDIR(entry.mode)) {
1202 struct tree_desc sub;
1203 struct pbase_tree_cache *tree;
1204 const char *down = name+cmplen+1;
1205 int downlen = name_cmp_len(down);
1207 tree = pbase_tree_get(entry.oid->hash);
1208 if (!tree)
1209 return;
1210 init_tree_desc(&sub, tree->tree_data, tree->tree_size);
1212 add_pbase_object(&sub, down, downlen, fullname);
1213 pbase_tree_put(tree);
1218 static unsigned *done_pbase_paths;
1219 static int done_pbase_paths_num;
1220 static int done_pbase_paths_alloc;
1221 static int done_pbase_path_pos(unsigned hash)
1223 int lo = 0;
1224 int hi = done_pbase_paths_num;
1225 while (lo < hi) {
1226 int mi = (hi + lo) / 2;
1227 if (done_pbase_paths[mi] == hash)
1228 return mi;
1229 if (done_pbase_paths[mi] < hash)
1230 hi = mi;
1231 else
1232 lo = mi + 1;
1234 return -lo-1;
1237 static int check_pbase_path(unsigned hash)
1239 int pos = (!done_pbase_paths) ? -1 : done_pbase_path_pos(hash);
1240 if (0 <= pos)
1241 return 1;
1242 pos = -pos - 1;
1243 ALLOC_GROW(done_pbase_paths,
1244 done_pbase_paths_num + 1,
1245 done_pbase_paths_alloc);
1246 done_pbase_paths_num++;
1247 if (pos < done_pbase_paths_num)
1248 memmove(done_pbase_paths + pos + 1,
1249 done_pbase_paths + pos,
1250 (done_pbase_paths_num - pos - 1) * sizeof(unsigned));
1251 done_pbase_paths[pos] = hash;
1252 return 0;
1255 static void add_preferred_base_object(const char *name)
1257 struct pbase_tree *it;
1258 int cmplen;
1259 unsigned hash = pack_name_hash(name);
1261 if (!num_preferred_base || check_pbase_path(hash))
1262 return;
1264 cmplen = name_cmp_len(name);
1265 for (it = pbase_tree; it; it = it->next) {
1266 if (cmplen == 0) {
1267 add_object_entry(it->pcache.sha1, OBJ_TREE, NULL, 1);
1269 else {
1270 struct tree_desc tree;
1271 init_tree_desc(&tree, it->pcache.tree_data, it->pcache.tree_size);
1272 add_pbase_object(&tree, name, cmplen, name);
1277 static void add_preferred_base(unsigned char *sha1)
1279 struct pbase_tree *it;
1280 void *data;
1281 unsigned long size;
1282 unsigned char tree_sha1[20];
1284 if (window <= num_preferred_base++)
1285 return;
1287 data = read_object_with_reference(sha1, tree_type, &size, tree_sha1);
1288 if (!data)
1289 return;
1291 for (it = pbase_tree; it; it = it->next) {
1292 if (!hashcmp(it->pcache.sha1, tree_sha1)) {
1293 free(data);
1294 return;
1298 it = xcalloc(1, sizeof(*it));
1299 it->next = pbase_tree;
1300 pbase_tree = it;
1302 hashcpy(it->pcache.sha1, tree_sha1);
1303 it->pcache.tree_data = data;
1304 it->pcache.tree_size = size;
1307 static void cleanup_preferred_base(void)
1309 struct pbase_tree *it;
1310 unsigned i;
1312 it = pbase_tree;
1313 pbase_tree = NULL;
1314 while (it) {
1315 struct pbase_tree *this = it;
1316 it = this->next;
1317 free(this->pcache.tree_data);
1318 free(this);
1321 for (i = 0; i < ARRAY_SIZE(pbase_tree_cache); i++) {
1322 if (!pbase_tree_cache[i])
1323 continue;
1324 free(pbase_tree_cache[i]->tree_data);
1325 free(pbase_tree_cache[i]);
1326 pbase_tree_cache[i] = NULL;
1329 free(done_pbase_paths);
1330 done_pbase_paths = NULL;
1331 done_pbase_paths_num = done_pbase_paths_alloc = 0;
1334 static void check_object(struct object_entry *entry)
1336 if (entry->in_pack) {
1337 struct packed_git *p = entry->in_pack;
1338 struct pack_window *w_curs = NULL;
1339 const unsigned char *base_ref = NULL;
1340 struct object_entry *base_entry;
1341 unsigned long used, used_0;
1342 unsigned long avail;
1343 off_t ofs;
1344 unsigned char *buf, c;
1346 buf = use_pack(p, &w_curs, entry->in_pack_offset, &avail);
1349 * We want in_pack_type even if we do not reuse delta
1350 * since non-delta representations could still be reused.
1352 used = unpack_object_header_buffer(buf, avail,
1353 &entry->in_pack_type,
1354 &entry->size);
1355 if (used == 0)
1356 goto give_up;
1359 * Determine if this is a delta and if so whether we can
1360 * reuse it or not. Otherwise let's find out as cheaply as
1361 * possible what the actual type and size for this object is.
1363 switch (entry->in_pack_type) {
1364 default:
1365 /* Not a delta hence we've already got all we need. */
1366 entry->type = entry->in_pack_type;
1367 entry->in_pack_header_size = used;
1368 if (entry->type < OBJ_COMMIT || entry->type > OBJ_BLOB)
1369 goto give_up;
1370 unuse_pack(&w_curs);
1371 return;
1372 case OBJ_REF_DELTA:
1373 if (reuse_delta && !entry->preferred_base)
1374 base_ref = use_pack(p, &w_curs,
1375 entry->in_pack_offset + used, NULL);
1376 entry->in_pack_header_size = used + 20;
1377 break;
1378 case OBJ_OFS_DELTA:
1379 buf = use_pack(p, &w_curs,
1380 entry->in_pack_offset + used, NULL);
1381 used_0 = 0;
1382 c = buf[used_0++];
1383 ofs = c & 127;
1384 while (c & 128) {
1385 ofs += 1;
1386 if (!ofs || MSB(ofs, 7)) {
1387 error("delta base offset overflow in pack for %s",
1388 sha1_to_hex(entry->idx.sha1));
1389 goto give_up;
1391 c = buf[used_0++];
1392 ofs = (ofs << 7) + (c & 127);
1394 ofs = entry->in_pack_offset - ofs;
1395 if (ofs <= 0 || ofs >= entry->in_pack_offset) {
1396 error("delta base offset out of bound for %s",
1397 sha1_to_hex(entry->idx.sha1));
1398 goto give_up;
1400 if (reuse_delta && !entry->preferred_base) {
1401 struct revindex_entry *revidx;
1402 revidx = find_pack_revindex(p, ofs);
1403 if (!revidx)
1404 goto give_up;
1405 base_ref = nth_packed_object_sha1(p, revidx->nr);
1407 entry->in_pack_header_size = used + used_0;
1408 break;
1411 if (base_ref && (base_entry = packlist_find(&to_pack, base_ref, NULL))) {
1413 * If base_ref was set above that means we wish to
1414 * reuse delta data, and we even found that base
1415 * in the list of objects we want to pack. Goodie!
1417 * Depth value does not matter - find_deltas() will
1418 * never consider reused delta as the base object to
1419 * deltify other objects against, in order to avoid
1420 * circular deltas.
1422 entry->type = entry->in_pack_type;
1423 entry->delta = base_entry;
1424 entry->delta_size = entry->size;
1425 entry->delta_sibling = base_entry->delta_child;
1426 base_entry->delta_child = entry;
1427 unuse_pack(&w_curs);
1428 return;
1431 if (entry->type) {
1433 * This must be a delta and we already know what the
1434 * final object type is. Let's extract the actual
1435 * object size from the delta header.
1437 entry->size = get_size_from_delta(p, &w_curs,
1438 entry->in_pack_offset + entry->in_pack_header_size);
1439 if (entry->size == 0)
1440 goto give_up;
1441 unuse_pack(&w_curs);
1442 return;
1446 * No choice but to fall back to the recursive delta walk
1447 * with sha1_object_info() to find about the object type
1448 * at this point...
1450 give_up:
1451 unuse_pack(&w_curs);
1454 entry->type = sha1_object_info(entry->idx.sha1, &entry->size);
1456 * The error condition is checked in prepare_pack(). This is
1457 * to permit a missing preferred base object to be ignored
1458 * as a preferred base. Doing so can result in a larger
1459 * pack file, but the transfer will still take place.
1463 static int pack_offset_sort(const void *_a, const void *_b)
1465 const struct object_entry *a = *(struct object_entry **)_a;
1466 const struct object_entry *b = *(struct object_entry **)_b;
1468 /* avoid filesystem trashing with loose objects */
1469 if (!a->in_pack && !b->in_pack)
1470 return hashcmp(a->idx.sha1, b->idx.sha1);
1472 if (a->in_pack < b->in_pack)
1473 return -1;
1474 if (a->in_pack > b->in_pack)
1475 return 1;
1476 return a->in_pack_offset < b->in_pack_offset ? -1 :
1477 (a->in_pack_offset > b->in_pack_offset);
1480 static void get_object_details(void)
1482 uint32_t i;
1483 struct object_entry **sorted_by_offset;
1485 sorted_by_offset = xcalloc(to_pack.nr_objects, sizeof(struct object_entry *));
1486 for (i = 0; i < to_pack.nr_objects; i++)
1487 sorted_by_offset[i] = to_pack.objects + i;
1488 qsort(sorted_by_offset, to_pack.nr_objects, sizeof(*sorted_by_offset), pack_offset_sort);
1490 for (i = 0; i < to_pack.nr_objects; i++) {
1491 struct object_entry *entry = sorted_by_offset[i];
1492 check_object(entry);
1493 if (big_file_threshold < entry->size)
1494 entry->no_try_delta = 1;
1497 free(sorted_by_offset);
1501 * We search for deltas in a list sorted by type, by filename hash, and then
1502 * by size, so that we see progressively smaller and smaller files.
1503 * That's because we prefer deltas to be from the bigger file
1504 * to the smaller -- deletes are potentially cheaper, but perhaps
1505 * more importantly, the bigger file is likely the more recent
1506 * one. The deepest deltas are therefore the oldest objects which are
1507 * less susceptible to be accessed often.
1509 static int type_size_sort(const void *_a, const void *_b)
1511 const struct object_entry *a = *(struct object_entry **)_a;
1512 const struct object_entry *b = *(struct object_entry **)_b;
1514 if (a->type > b->type)
1515 return -1;
1516 if (a->type < b->type)
1517 return 1;
1518 if (a->hash > b->hash)
1519 return -1;
1520 if (a->hash < b->hash)
1521 return 1;
1522 if (a->preferred_base > b->preferred_base)
1523 return -1;
1524 if (a->preferred_base < b->preferred_base)
1525 return 1;
1526 if (a->size > b->size)
1527 return -1;
1528 if (a->size < b->size)
1529 return 1;
1530 return a < b ? -1 : (a > b); /* newest first */
1533 struct unpacked {
1534 struct object_entry *entry;
1535 void *data;
1536 struct delta_index *index;
1537 unsigned depth;
1540 static int delta_cacheable(unsigned long src_size, unsigned long trg_size,
1541 unsigned long delta_size)
1543 if (max_delta_cache_size && delta_cache_size + delta_size > max_delta_cache_size)
1544 return 0;
1546 if (delta_size < cache_max_small_delta_size)
1547 return 1;
1549 /* cache delta, if objects are large enough compared to delta size */
1550 if ((src_size >> 20) + (trg_size >> 21) > (delta_size >> 10))
1551 return 1;
1553 return 0;
1556 #ifndef NO_PTHREADS
1558 static pthread_mutex_t read_mutex;
1559 #define read_lock() pthread_mutex_lock(&read_mutex)
1560 #define read_unlock() pthread_mutex_unlock(&read_mutex)
1562 static pthread_mutex_t cache_mutex;
1563 #define cache_lock() pthread_mutex_lock(&cache_mutex)
1564 #define cache_unlock() pthread_mutex_unlock(&cache_mutex)
1566 static pthread_mutex_t progress_mutex;
1567 #define progress_lock() pthread_mutex_lock(&progress_mutex)
1568 #define progress_unlock() pthread_mutex_unlock(&progress_mutex)
1570 #else
1572 #define read_lock() (void)0
1573 #define read_unlock() (void)0
1574 #define cache_lock() (void)0
1575 #define cache_unlock() (void)0
1576 #define progress_lock() (void)0
1577 #define progress_unlock() (void)0
1579 #endif
1581 static int try_delta(struct unpacked *trg, struct unpacked *src,
1582 unsigned max_depth, unsigned long *mem_usage)
1584 struct object_entry *trg_entry = trg->entry;
1585 struct object_entry *src_entry = src->entry;
1586 unsigned long trg_size, src_size, delta_size, sizediff, max_size, sz;
1587 unsigned ref_depth;
1588 enum object_type type;
1589 void *delta_buf;
1591 /* Don't bother doing diffs between different types */
1592 if (trg_entry->type != src_entry->type)
1593 return -1;
1596 * We do not bother to try a delta that we discarded on an
1597 * earlier try, but only when reusing delta data. Note that
1598 * src_entry that is marked as the preferred_base should always
1599 * be considered, as even if we produce a suboptimal delta against
1600 * it, we will still save the transfer cost, as we already know
1601 * the other side has it and we won't send src_entry at all.
1603 if (reuse_delta && trg_entry->in_pack &&
1604 trg_entry->in_pack == src_entry->in_pack &&
1605 !src_entry->preferred_base &&
1606 trg_entry->in_pack_type != OBJ_REF_DELTA &&
1607 trg_entry->in_pack_type != OBJ_OFS_DELTA)
1608 return 0;
1610 /* Let's not bust the allowed depth. */
1611 if (src->depth >= max_depth)
1612 return 0;
1614 /* Now some size filtering heuristics. */
1615 trg_size = trg_entry->size;
1616 if (!trg_entry->delta) {
1617 max_size = trg_size/2 - 20;
1618 ref_depth = 1;
1619 } else {
1620 max_size = trg_entry->delta_size;
1621 ref_depth = trg->depth;
1623 max_size = (uint64_t)max_size * (max_depth - src->depth) /
1624 (max_depth - ref_depth + 1);
1625 if (max_size == 0)
1626 return 0;
1627 src_size = src_entry->size;
1628 sizediff = src_size < trg_size ? trg_size - src_size : 0;
1629 if (sizediff >= max_size)
1630 return 0;
1631 if (trg_size < src_size / 32)
1632 return 0;
1634 /* Load data if not already done */
1635 if (!trg->data) {
1636 read_lock();
1637 trg->data = read_sha1_file(trg_entry->idx.sha1, &type, &sz);
1638 read_unlock();
1639 if (!trg->data)
1640 die("object %s cannot be read",
1641 sha1_to_hex(trg_entry->idx.sha1));
1642 if (sz != trg_size)
1643 die("object %s inconsistent object length (%lu vs %lu)",
1644 sha1_to_hex(trg_entry->idx.sha1), sz, trg_size);
1645 *mem_usage += sz;
1647 if (!src->data) {
1648 read_lock();
1649 src->data = read_sha1_file(src_entry->idx.sha1, &type, &sz);
1650 read_unlock();
1651 if (!src->data) {
1652 if (src_entry->preferred_base) {
1653 static int warned = 0;
1654 if (!warned++)
1655 warning("object %s cannot be read",
1656 sha1_to_hex(src_entry->idx.sha1));
1658 * Those objects are not included in the
1659 * resulting pack. Be resilient and ignore
1660 * them if they can't be read, in case the
1661 * pack could be created nevertheless.
1663 return 0;
1665 die("object %s cannot be read",
1666 sha1_to_hex(src_entry->idx.sha1));
1668 if (sz != src_size)
1669 die("object %s inconsistent object length (%lu vs %lu)",
1670 sha1_to_hex(src_entry->idx.sha1), sz, src_size);
1671 *mem_usage += sz;
1673 if (!src->index) {
1674 src->index = create_delta_index(src->data, src_size);
1675 if (!src->index) {
1676 static int warned = 0;
1677 if (!warned++)
1678 warning("suboptimal pack - out of memory");
1679 return 0;
1681 *mem_usage += sizeof_delta_index(src->index);
1684 delta_buf = create_delta(src->index, trg->data, trg_size, &delta_size, max_size);
1685 if (!delta_buf)
1686 return 0;
1688 if (trg_entry->delta) {
1689 /* Prefer only shallower same-sized deltas. */
1690 if (delta_size == trg_entry->delta_size &&
1691 src->depth + 1 >= trg->depth) {
1692 free(delta_buf);
1693 return 0;
1698 * Handle memory allocation outside of the cache
1699 * accounting lock. Compiler will optimize the strangeness
1700 * away when NO_PTHREADS is defined.
1702 free(trg_entry->delta_data);
1703 cache_lock();
1704 if (trg_entry->delta_data) {
1705 delta_cache_size -= trg_entry->delta_size;
1706 trg_entry->delta_data = NULL;
1708 if (delta_cacheable(src_size, trg_size, delta_size)) {
1709 delta_cache_size += delta_size;
1710 cache_unlock();
1711 trg_entry->delta_data = xrealloc(delta_buf, delta_size);
1712 } else {
1713 cache_unlock();
1714 free(delta_buf);
1717 trg_entry->delta = src_entry;
1718 trg_entry->delta_size = delta_size;
1719 trg->depth = src->depth + 1;
1721 return 1;
1724 static unsigned int check_delta_limit(struct object_entry *me, unsigned int n)
1726 struct object_entry *child = me->delta_child;
1727 unsigned int m = n;
1728 while (child) {
1729 unsigned int c = check_delta_limit(child, n + 1);
1730 if (m < c)
1731 m = c;
1732 child = child->delta_sibling;
1734 return m;
1737 static unsigned long free_unpacked(struct unpacked *n)
1739 unsigned long freed_mem = sizeof_delta_index(n->index);
1740 free_delta_index(n->index);
1741 n->index = NULL;
1742 if (n->data) {
1743 freed_mem += n->entry->size;
1744 free(n->data);
1745 n->data = NULL;
1747 n->entry = NULL;
1748 n->depth = 0;
1749 return freed_mem;
1752 static void find_deltas(struct object_entry **list, unsigned *list_size,
1753 int window, int depth, unsigned *processed)
1755 uint32_t i, idx = 0, count = 0;
1756 struct unpacked *array;
1757 unsigned long mem_usage = 0;
1759 array = xcalloc(window, sizeof(struct unpacked));
1761 for (;;) {
1762 struct object_entry *entry;
1763 struct unpacked *n = array + idx;
1764 int j, max_depth, best_base = -1;
1766 progress_lock();
1767 if (!*list_size) {
1768 progress_unlock();
1769 break;
1771 entry = *list++;
1772 (*list_size)--;
1773 if (!entry->preferred_base) {
1774 (*processed)++;
1775 display_progress(progress_state, *processed);
1777 progress_unlock();
1779 mem_usage -= free_unpacked(n);
1780 n->entry = entry;
1782 while (window_memory_limit &&
1783 mem_usage > window_memory_limit &&
1784 count > 1) {
1785 uint32_t tail = (idx + window - count) % window;
1786 mem_usage -= free_unpacked(array + tail);
1787 count--;
1790 /* We do not compute delta to *create* objects we are not
1791 * going to pack.
1793 if (entry->preferred_base)
1794 goto next;
1797 * If the current object is at pack edge, take the depth the
1798 * objects that depend on the current object into account
1799 * otherwise they would become too deep.
1801 max_depth = depth;
1802 if (entry->delta_child) {
1803 max_depth -= check_delta_limit(entry, 0);
1804 if (max_depth <= 0)
1805 goto next;
1808 j = window;
1809 while (--j > 0) {
1810 int ret;
1811 uint32_t other_idx = idx + j;
1812 struct unpacked *m;
1813 if (other_idx >= window)
1814 other_idx -= window;
1815 m = array + other_idx;
1816 if (!m->entry)
1817 break;
1818 ret = try_delta(n, m, max_depth, &mem_usage);
1819 if (ret < 0)
1820 break;
1821 else if (ret > 0)
1822 best_base = other_idx;
1826 * If we decided to cache the delta data, then it is best
1827 * to compress it right away. First because we have to do
1828 * it anyway, and doing it here while we're threaded will
1829 * save a lot of time in the non threaded write phase,
1830 * as well as allow for caching more deltas within
1831 * the same cache size limit.
1832 * ...
1833 * But only if not writing to stdout, since in that case
1834 * the network is most likely throttling writes anyway,
1835 * and therefore it is best to go to the write phase ASAP
1836 * instead, as we can afford spending more time compressing
1837 * between writes at that moment.
1839 if (entry->delta_data && !pack_to_stdout) {
1840 entry->z_delta_size = do_compress(&entry->delta_data,
1841 entry->delta_size);
1842 cache_lock();
1843 delta_cache_size -= entry->delta_size;
1844 delta_cache_size += entry->z_delta_size;
1845 cache_unlock();
1848 /* if we made n a delta, and if n is already at max
1849 * depth, leaving it in the window is pointless. we
1850 * should evict it first.
1852 if (entry->delta && max_depth <= n->depth)
1853 continue;
1856 * Move the best delta base up in the window, after the
1857 * currently deltified object, to keep it longer. It will
1858 * be the first base object to be attempted next.
1860 if (entry->delta) {
1861 struct unpacked swap = array[best_base];
1862 int dist = (window + idx - best_base) % window;
1863 int dst = best_base;
1864 while (dist--) {
1865 int src = (dst + 1) % window;
1866 array[dst] = array[src];
1867 dst = src;
1869 array[dst] = swap;
1872 next:
1873 idx++;
1874 if (count + 1 < window)
1875 count++;
1876 if (idx >= window)
1877 idx = 0;
1880 for (i = 0; i < window; ++i) {
1881 free_delta_index(array[i].index);
1882 free(array[i].data);
1884 free(array);
1887 #ifndef NO_PTHREADS
1889 static void try_to_free_from_threads(size_t size)
1891 read_lock();
1892 release_pack_memory(size);
1893 read_unlock();
1896 static try_to_free_t old_try_to_free_routine;
1899 * The main thread waits on the condition that (at least) one of the workers
1900 * has stopped working (which is indicated in the .working member of
1901 * struct thread_params).
1902 * When a work thread has completed its work, it sets .working to 0 and
1903 * signals the main thread and waits on the condition that .data_ready
1904 * becomes 1.
1907 struct thread_params {
1908 pthread_t thread;
1909 struct object_entry **list;
1910 unsigned list_size;
1911 unsigned remaining;
1912 int window;
1913 int depth;
1914 int working;
1915 int data_ready;
1916 pthread_mutex_t mutex;
1917 pthread_cond_t cond;
1918 unsigned *processed;
1921 static pthread_cond_t progress_cond;
1924 * Mutex and conditional variable can't be statically-initialized on Windows.
1926 static void init_threaded_search(void)
1928 init_recursive_mutex(&read_mutex);
1929 pthread_mutex_init(&cache_mutex, NULL);
1930 pthread_mutex_init(&progress_mutex, NULL);
1931 pthread_cond_init(&progress_cond, NULL);
1932 old_try_to_free_routine = set_try_to_free_routine(try_to_free_from_threads);
1935 static void cleanup_threaded_search(void)
1937 set_try_to_free_routine(old_try_to_free_routine);
1938 pthread_cond_destroy(&progress_cond);
1939 pthread_mutex_destroy(&read_mutex);
1940 pthread_mutex_destroy(&cache_mutex);
1941 pthread_mutex_destroy(&progress_mutex);
1944 static void *threaded_find_deltas(void *arg)
1946 struct thread_params *me = arg;
1948 while (me->remaining) {
1949 find_deltas(me->list, &me->remaining,
1950 me->window, me->depth, me->processed);
1952 progress_lock();
1953 me->working = 0;
1954 pthread_cond_signal(&progress_cond);
1955 progress_unlock();
1958 * We must not set ->data_ready before we wait on the
1959 * condition because the main thread may have set it to 1
1960 * before we get here. In order to be sure that new
1961 * work is available if we see 1 in ->data_ready, it
1962 * was initialized to 0 before this thread was spawned
1963 * and we reset it to 0 right away.
1965 pthread_mutex_lock(&me->mutex);
1966 while (!me->data_ready)
1967 pthread_cond_wait(&me->cond, &me->mutex);
1968 me->data_ready = 0;
1969 pthread_mutex_unlock(&me->mutex);
1971 /* leave ->working 1 so that this doesn't get more work assigned */
1972 return NULL;
1975 static void ll_find_deltas(struct object_entry **list, unsigned list_size,
1976 int window, int depth, unsigned *processed)
1978 struct thread_params *p;
1979 int i, ret, active_threads = 0;
1981 init_threaded_search();
1983 if (delta_search_threads <= 1) {
1984 find_deltas(list, &list_size, window, depth, processed);
1985 cleanup_threaded_search();
1986 return;
1988 if (progress > pack_to_stdout)
1989 fprintf(stderr, "Delta compression using up to %d threads.\n",
1990 delta_search_threads);
1991 p = xcalloc(delta_search_threads, sizeof(*p));
1993 /* Partition the work amongst work threads. */
1994 for (i = 0; i < delta_search_threads; i++) {
1995 unsigned sub_size = list_size / (delta_search_threads - i);
1997 /* don't use too small segments or no deltas will be found */
1998 if (sub_size < 2*window && i+1 < delta_search_threads)
1999 sub_size = 0;
2001 p[i].window = window;
2002 p[i].depth = depth;
2003 p[i].processed = processed;
2004 p[i].working = 1;
2005 p[i].data_ready = 0;
2007 /* try to split chunks on "path" boundaries */
2008 while (sub_size && sub_size < list_size &&
2009 list[sub_size]->hash &&
2010 list[sub_size]->hash == list[sub_size-1]->hash)
2011 sub_size++;
2013 p[i].list = list;
2014 p[i].list_size = sub_size;
2015 p[i].remaining = sub_size;
2017 list += sub_size;
2018 list_size -= sub_size;
2021 /* Start work threads. */
2022 for (i = 0; i < delta_search_threads; i++) {
2023 if (!p[i].list_size)
2024 continue;
2025 pthread_mutex_init(&p[i].mutex, NULL);
2026 pthread_cond_init(&p[i].cond, NULL);
2027 ret = pthread_create(&p[i].thread, NULL,
2028 threaded_find_deltas, &p[i]);
2029 if (ret)
2030 die("unable to create thread: %s", strerror(ret));
2031 active_threads++;
2035 * Now let's wait for work completion. Each time a thread is done
2036 * with its work, we steal half of the remaining work from the
2037 * thread with the largest number of unprocessed objects and give
2038 * it to that newly idle thread. This ensure good load balancing
2039 * until the remaining object list segments are simply too short
2040 * to be worth splitting anymore.
2042 while (active_threads) {
2043 struct thread_params *target = NULL;
2044 struct thread_params *victim = NULL;
2045 unsigned sub_size = 0;
2047 progress_lock();
2048 for (;;) {
2049 for (i = 0; !target && i < delta_search_threads; i++)
2050 if (!p[i].working)
2051 target = &p[i];
2052 if (target)
2053 break;
2054 pthread_cond_wait(&progress_cond, &progress_mutex);
2057 for (i = 0; i < delta_search_threads; i++)
2058 if (p[i].remaining > 2*window &&
2059 (!victim || victim->remaining < p[i].remaining))
2060 victim = &p[i];
2061 if (victim) {
2062 sub_size = victim->remaining / 2;
2063 list = victim->list + victim->list_size - sub_size;
2064 while (sub_size && list[0]->hash &&
2065 list[0]->hash == list[-1]->hash) {
2066 list++;
2067 sub_size--;
2069 if (!sub_size) {
2071 * It is possible for some "paths" to have
2072 * so many objects that no hash boundary
2073 * might be found. Let's just steal the
2074 * exact half in that case.
2076 sub_size = victim->remaining / 2;
2077 list -= sub_size;
2079 target->list = list;
2080 victim->list_size -= sub_size;
2081 victim->remaining -= sub_size;
2083 target->list_size = sub_size;
2084 target->remaining = sub_size;
2085 target->working = 1;
2086 progress_unlock();
2088 pthread_mutex_lock(&target->mutex);
2089 target->data_ready = 1;
2090 pthread_cond_signal(&target->cond);
2091 pthread_mutex_unlock(&target->mutex);
2093 if (!sub_size) {
2094 pthread_join(target->thread, NULL);
2095 pthread_cond_destroy(&target->cond);
2096 pthread_mutex_destroy(&target->mutex);
2097 active_threads--;
2100 cleanup_threaded_search();
2101 free(p);
2104 #else
2105 #define ll_find_deltas(l, s, w, d, p) find_deltas(l, &s, w, d, p)
2106 #endif
2108 static int add_ref_tag(const char *path, const struct object_id *oid, int flag, void *cb_data)
2110 struct object_id peeled;
2112 if (starts_with(path, "refs/tags/") && /* is a tag? */
2113 !peel_ref(path, peeled.hash) && /* peelable? */
2114 packlist_find(&to_pack, peeled.hash, NULL)) /* object packed? */
2115 add_object_entry(oid->hash, OBJ_TAG, NULL, 0);
2116 return 0;
2119 static void prepare_pack(int window, int depth)
2121 struct object_entry **delta_list;
2122 uint32_t i, nr_deltas;
2123 unsigned n;
2125 get_object_details();
2128 * If we're locally repacking then we need to be doubly careful
2129 * from now on in order to make sure no stealth corruption gets
2130 * propagated to the new pack. Clients receiving streamed packs
2131 * should validate everything they get anyway so no need to incur
2132 * the additional cost here in that case.
2134 if (!pack_to_stdout)
2135 do_check_packed_object_crc = 1;
2137 if (!to_pack.nr_objects || !window || !depth)
2138 return;
2140 ALLOC_ARRAY(delta_list, to_pack.nr_objects);
2141 nr_deltas = n = 0;
2143 for (i = 0; i < to_pack.nr_objects; i++) {
2144 struct object_entry *entry = to_pack.objects + i;
2146 if (entry->delta)
2147 /* This happens if we decided to reuse existing
2148 * delta from a pack. "reuse_delta &&" is implied.
2150 continue;
2152 if (entry->size < 50)
2153 continue;
2155 if (entry->no_try_delta)
2156 continue;
2158 if (!entry->preferred_base) {
2159 nr_deltas++;
2160 if (entry->type < 0)
2161 die("unable to get type of object %s",
2162 sha1_to_hex(entry->idx.sha1));
2163 } else {
2164 if (entry->type < 0) {
2166 * This object is not found, but we
2167 * don't have to include it anyway.
2169 continue;
2173 delta_list[n++] = entry;
2176 if (nr_deltas && n > 1) {
2177 unsigned nr_done = 0;
2178 if (progress)
2179 progress_state = start_progress(_("Compressing objects"),
2180 nr_deltas);
2181 qsort(delta_list, n, sizeof(*delta_list), type_size_sort);
2182 ll_find_deltas(delta_list, n, window+1, depth, &nr_done);
2183 stop_progress(&progress_state);
2184 if (nr_done != nr_deltas)
2185 die("inconsistency with delta count");
2187 free(delta_list);
2190 static int git_pack_config(const char *k, const char *v, void *cb)
2192 if (!strcmp(k, "pack.window")) {
2193 window = git_config_int(k, v);
2194 return 0;
2196 if (!strcmp(k, "pack.windowmemory")) {
2197 window_memory_limit = git_config_ulong(k, v);
2198 return 0;
2200 if (!strcmp(k, "pack.depth")) {
2201 depth = git_config_int(k, v);
2202 return 0;
2204 if (!strcmp(k, "pack.compression")) {
2205 int level = git_config_int(k, v);
2206 if (level == -1)
2207 level = Z_DEFAULT_COMPRESSION;
2208 else if (level < 0 || level > Z_BEST_COMPRESSION)
2209 die("bad pack compression level %d", level);
2210 pack_compression_level = level;
2211 pack_compression_seen = 1;
2212 return 0;
2214 if (!strcmp(k, "pack.deltacachesize")) {
2215 max_delta_cache_size = git_config_int(k, v);
2216 return 0;
2218 if (!strcmp(k, "pack.deltacachelimit")) {
2219 cache_max_small_delta_size = git_config_int(k, v);
2220 return 0;
2222 if (!strcmp(k, "pack.writebitmaphashcache")) {
2223 if (git_config_bool(k, v))
2224 write_bitmap_options |= BITMAP_OPT_HASH_CACHE;
2225 else
2226 write_bitmap_options &= ~BITMAP_OPT_HASH_CACHE;
2228 if (!strcmp(k, "pack.usebitmaps")) {
2229 use_bitmap_index = git_config_bool(k, v);
2230 return 0;
2232 if (!strcmp(k, "pack.threads")) {
2233 delta_search_threads = git_config_int(k, v);
2234 if (delta_search_threads < 0)
2235 die("invalid number of threads specified (%d)",
2236 delta_search_threads);
2237 #ifdef NO_PTHREADS
2238 if (delta_search_threads != 1)
2239 warning("no threads support, ignoring %s", k);
2240 #endif
2241 return 0;
2243 if (!strcmp(k, "pack.indexversion")) {
2244 pack_idx_opts.version = git_config_int(k, v);
2245 if (pack_idx_opts.version > 2)
2246 die("bad pack.indexversion=%"PRIu32,
2247 pack_idx_opts.version);
2248 return 0;
2250 return git_default_config(k, v, cb);
2253 static void read_object_list_from_stdin(void)
2255 char line[40 + 1 + PATH_MAX + 2];
2256 unsigned char sha1[20];
2258 for (;;) {
2259 if (!fgets(line, sizeof(line), stdin)) {
2260 if (feof(stdin))
2261 break;
2262 if (!ferror(stdin))
2263 die("fgets returned NULL, not EOF, not error!");
2264 if (errno != EINTR)
2265 die_errno("fgets");
2266 clearerr(stdin);
2267 continue;
2269 if (line[0] == '-') {
2270 if (get_sha1_hex(line+1, sha1))
2271 die("expected edge sha1, got garbage:\n %s",
2272 line);
2273 add_preferred_base(sha1);
2274 continue;
2276 if (get_sha1_hex(line, sha1))
2277 die("expected sha1, got garbage:\n %s", line);
2279 add_preferred_base_object(line+41);
2280 add_object_entry(sha1, 0, line+41, 0);
2284 #define OBJECT_ADDED (1u<<20)
2286 static void show_commit(struct commit *commit, void *data)
2288 add_object_entry(commit->object.oid.hash, OBJ_COMMIT, NULL, 0);
2289 commit->object.flags |= OBJECT_ADDED;
2291 if (write_bitmap_index)
2292 index_commit_for_bitmap(commit);
2295 static void show_object(struct object *obj, const char *name, void *data)
2297 add_preferred_base_object(name);
2298 add_object_entry(obj->oid.hash, obj->type, name, 0);
2299 obj->flags |= OBJECT_ADDED;
2302 static void show_edge(struct commit *commit)
2304 add_preferred_base(commit->object.oid.hash);
2307 struct in_pack_object {
2308 off_t offset;
2309 struct object *object;
2312 struct in_pack {
2313 int alloc;
2314 int nr;
2315 struct in_pack_object *array;
2318 static void mark_in_pack_object(struct object *object, struct packed_git *p, struct in_pack *in_pack)
2320 in_pack->array[in_pack->nr].offset = find_pack_entry_one(object->oid.hash, p);
2321 in_pack->array[in_pack->nr].object = object;
2322 in_pack->nr++;
2326 * Compare the objects in the offset order, in order to emulate the
2327 * "git rev-list --objects" output that produced the pack originally.
2329 static int ofscmp(const void *a_, const void *b_)
2331 struct in_pack_object *a = (struct in_pack_object *)a_;
2332 struct in_pack_object *b = (struct in_pack_object *)b_;
2334 if (a->offset < b->offset)
2335 return -1;
2336 else if (a->offset > b->offset)
2337 return 1;
2338 else
2339 return oidcmp(&a->object->oid, &b->object->oid);
2342 static void add_objects_in_unpacked_packs(struct rev_info *revs)
2344 struct packed_git *p;
2345 struct in_pack in_pack;
2346 uint32_t i;
2348 memset(&in_pack, 0, sizeof(in_pack));
2350 for (p = packed_git; p; p = p->next) {
2351 const unsigned char *sha1;
2352 struct object *o;
2354 if (!p->pack_local || p->pack_keep)
2355 continue;
2356 if (open_pack_index(p))
2357 die("cannot open pack index");
2359 ALLOC_GROW(in_pack.array,
2360 in_pack.nr + p->num_objects,
2361 in_pack.alloc);
2363 for (i = 0; i < p->num_objects; i++) {
2364 sha1 = nth_packed_object_sha1(p, i);
2365 o = lookup_unknown_object(sha1);
2366 if (!(o->flags & OBJECT_ADDED))
2367 mark_in_pack_object(o, p, &in_pack);
2368 o->flags |= OBJECT_ADDED;
2372 if (in_pack.nr) {
2373 qsort(in_pack.array, in_pack.nr, sizeof(in_pack.array[0]),
2374 ofscmp);
2375 for (i = 0; i < in_pack.nr; i++) {
2376 struct object *o = in_pack.array[i].object;
2377 add_object_entry(o->oid.hash, o->type, "", 0);
2380 free(in_pack.array);
2383 static int add_loose_object(const unsigned char *sha1, const char *path,
2384 void *data)
2386 enum object_type type = sha1_object_info(sha1, NULL);
2388 if (type < 0) {
2389 warning("loose object at %s could not be examined", path);
2390 return 0;
2393 add_object_entry(sha1, type, "", 0);
2394 return 0;
2398 * We actually don't even have to worry about reachability here.
2399 * add_object_entry will weed out duplicates, so we just add every
2400 * loose object we find.
2402 static void add_unreachable_loose_objects(void)
2404 for_each_loose_file_in_objdir(get_object_directory(),
2405 add_loose_object,
2406 NULL, NULL, NULL);
2409 static int has_sha1_pack_kept_or_nonlocal(const unsigned char *sha1)
2411 static struct packed_git *last_found = (void *)1;
2412 struct packed_git *p;
2414 p = (last_found != (void *)1) ? last_found : packed_git;
2416 while (p) {
2417 if ((!p->pack_local || p->pack_keep) &&
2418 find_pack_entry_one(sha1, p)) {
2419 last_found = p;
2420 return 1;
2422 if (p == last_found)
2423 p = packed_git;
2424 else
2425 p = p->next;
2426 if (p == last_found)
2427 p = p->next;
2429 return 0;
2433 * Store a list of sha1s that are should not be discarded
2434 * because they are either written too recently, or are
2435 * reachable from another object that was.
2437 * This is filled by get_object_list.
2439 static struct sha1_array recent_objects;
2441 static int loosened_object_can_be_discarded(const unsigned char *sha1,
2442 unsigned long mtime)
2444 if (!unpack_unreachable_expiration)
2445 return 0;
2446 if (mtime > unpack_unreachable_expiration)
2447 return 0;
2448 if (sha1_array_lookup(&recent_objects, sha1) >= 0)
2449 return 0;
2450 return 1;
2453 static void loosen_unused_packed_objects(struct rev_info *revs)
2455 struct packed_git *p;
2456 uint32_t i;
2457 const unsigned char *sha1;
2459 for (p = packed_git; p; p = p->next) {
2460 if (!p->pack_local || p->pack_keep)
2461 continue;
2463 if (open_pack_index(p))
2464 die("cannot open pack index");
2466 for (i = 0; i < p->num_objects; i++) {
2467 sha1 = nth_packed_object_sha1(p, i);
2468 if (!packlist_find(&to_pack, sha1, NULL) &&
2469 !has_sha1_pack_kept_or_nonlocal(sha1) &&
2470 !loosened_object_can_be_discarded(sha1, p->mtime))
2471 if (force_object_loose(sha1, p->mtime))
2472 die("unable to force loose object");
2478 * This tracks any options which a reader of the pack might
2479 * not understand, and which would therefore prevent blind reuse
2480 * of what we have on disk.
2482 static int pack_options_allow_reuse(void)
2484 return allow_ofs_delta;
2487 static int get_object_list_from_bitmap(struct rev_info *revs)
2489 if (prepare_bitmap_walk(revs) < 0)
2490 return -1;
2492 if (pack_options_allow_reuse() &&
2493 !reuse_partial_packfile_from_bitmap(
2494 &reuse_packfile,
2495 &reuse_packfile_objects,
2496 &reuse_packfile_offset)) {
2497 assert(reuse_packfile_objects);
2498 nr_result += reuse_packfile_objects;
2499 display_progress(progress_state, nr_result);
2502 traverse_bitmap_commit_list(&add_object_entry_from_bitmap);
2503 return 0;
2506 static void record_recent_object(struct object *obj,
2507 const char *name,
2508 void *data)
2510 sha1_array_append(&recent_objects, obj->oid.hash);
2513 static void record_recent_commit(struct commit *commit, void *data)
2515 sha1_array_append(&recent_objects, commit->object.oid.hash);
2518 static void get_object_list(int ac, const char **av)
2520 struct rev_info revs;
2521 char line[1000];
2522 int flags = 0;
2524 init_revisions(&revs, NULL);
2525 save_commit_buffer = 0;
2526 setup_revisions(ac, av, &revs, NULL);
2528 /* make sure shallows are read */
2529 is_repository_shallow();
2531 while (fgets(line, sizeof(line), stdin) != NULL) {
2532 int len = strlen(line);
2533 if (len && line[len - 1] == '\n')
2534 line[--len] = 0;
2535 if (!len)
2536 break;
2537 if (*line == '-') {
2538 if (!strcmp(line, "--not")) {
2539 flags ^= UNINTERESTING;
2540 write_bitmap_index = 0;
2541 continue;
2543 if (starts_with(line, "--shallow ")) {
2544 unsigned char sha1[20];
2545 if (get_sha1_hex(line + 10, sha1))
2546 die("not an SHA-1 '%s'", line + 10);
2547 register_shallow(sha1);
2548 use_bitmap_index = 0;
2549 continue;
2551 die("not a rev '%s'", line);
2553 if (handle_revision_arg(line, &revs, flags, REVARG_CANNOT_BE_FILENAME))
2554 die("bad revision '%s'", line);
2557 if (use_bitmap_index && !get_object_list_from_bitmap(&revs))
2558 return;
2560 if (prepare_revision_walk(&revs))
2561 die("revision walk setup failed");
2562 mark_edges_uninteresting(&revs, show_edge);
2563 traverse_commit_list(&revs, show_commit, show_object, NULL);
2565 if (unpack_unreachable_expiration) {
2566 revs.ignore_missing_links = 1;
2567 if (add_unseen_recent_objects_to_traversal(&revs,
2568 unpack_unreachable_expiration))
2569 die("unable to add recent objects");
2570 if (prepare_revision_walk(&revs))
2571 die("revision walk setup failed");
2572 traverse_commit_list(&revs, record_recent_commit,
2573 record_recent_object, NULL);
2576 if (keep_unreachable)
2577 add_objects_in_unpacked_packs(&revs);
2578 if (pack_loose_unreachable)
2579 add_unreachable_loose_objects();
2580 if (unpack_unreachable)
2581 loosen_unused_packed_objects(&revs);
2583 sha1_array_clear(&recent_objects);
2586 static int option_parse_index_version(const struct option *opt,
2587 const char *arg, int unset)
2589 char *c;
2590 const char *val = arg;
2591 pack_idx_opts.version = strtoul(val, &c, 10);
2592 if (pack_idx_opts.version > 2)
2593 die(_("unsupported index version %s"), val);
2594 if (*c == ',' && c[1])
2595 pack_idx_opts.off32_limit = strtoul(c+1, &c, 0);
2596 if (*c || pack_idx_opts.off32_limit & 0x80000000)
2597 die(_("bad index version '%s'"), val);
2598 return 0;
2601 static int option_parse_unpack_unreachable(const struct option *opt,
2602 const char *arg, int unset)
2604 if (unset) {
2605 unpack_unreachable = 0;
2606 unpack_unreachable_expiration = 0;
2608 else {
2609 unpack_unreachable = 1;
2610 if (arg)
2611 unpack_unreachable_expiration = approxidate(arg);
2613 return 0;
2616 int cmd_pack_objects(int argc, const char **argv, const char *prefix)
2618 int use_internal_rev_list = 0;
2619 int thin = 0;
2620 int shallow = 0;
2621 int all_progress_implied = 0;
2622 struct argv_array rp = ARGV_ARRAY_INIT;
2623 int rev_list_unpacked = 0, rev_list_all = 0, rev_list_reflog = 0;
2624 int rev_list_index = 0;
2625 struct option pack_objects_options[] = {
2626 OPT_SET_INT('q', "quiet", &progress,
2627 N_("do not show progress meter"), 0),
2628 OPT_SET_INT(0, "progress", &progress,
2629 N_("show progress meter"), 1),
2630 OPT_SET_INT(0, "all-progress", &progress,
2631 N_("show progress meter during object writing phase"), 2),
2632 OPT_BOOL(0, "all-progress-implied",
2633 &all_progress_implied,
2634 N_("similar to --all-progress when progress meter is shown")),
2635 { OPTION_CALLBACK, 0, "index-version", NULL, N_("version[,offset]"),
2636 N_("write the pack index file in the specified idx format version"),
2637 0, option_parse_index_version },
2638 OPT_MAGNITUDE(0, "max-pack-size", &pack_size_limit,
2639 N_("maximum size of each output pack file")),
2640 OPT_BOOL(0, "local", &local,
2641 N_("ignore borrowed objects from alternate object store")),
2642 OPT_BOOL(0, "incremental", &incremental,
2643 N_("ignore packed objects")),
2644 OPT_INTEGER(0, "window", &window,
2645 N_("limit pack window by objects")),
2646 OPT_MAGNITUDE(0, "window-memory", &window_memory_limit,
2647 N_("limit pack window by memory in addition to object limit")),
2648 OPT_INTEGER(0, "depth", &depth,
2649 N_("maximum length of delta chain allowed in the resulting pack")),
2650 OPT_BOOL(0, "reuse-delta", &reuse_delta,
2651 N_("reuse existing deltas")),
2652 OPT_BOOL(0, "reuse-object", &reuse_object,
2653 N_("reuse existing objects")),
2654 OPT_BOOL(0, "delta-base-offset", &allow_ofs_delta,
2655 N_("use OFS_DELTA objects")),
2656 OPT_INTEGER(0, "threads", &delta_search_threads,
2657 N_("use threads when searching for best delta matches")),
2658 OPT_BOOL(0, "non-empty", &non_empty,
2659 N_("do not create an empty pack output")),
2660 OPT_BOOL(0, "revs", &use_internal_rev_list,
2661 N_("read revision arguments from standard input")),
2662 { OPTION_SET_INT, 0, "unpacked", &rev_list_unpacked, NULL,
2663 N_("limit the objects to those that are not yet packed"),
2664 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, 1 },
2665 { OPTION_SET_INT, 0, "all", &rev_list_all, NULL,
2666 N_("include objects reachable from any reference"),
2667 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, 1 },
2668 { OPTION_SET_INT, 0, "reflog", &rev_list_reflog, NULL,
2669 N_("include objects referred by reflog entries"),
2670 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, 1 },
2671 { OPTION_SET_INT, 0, "indexed-objects", &rev_list_index, NULL,
2672 N_("include objects referred to by the index"),
2673 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, 1 },
2674 OPT_BOOL(0, "stdout", &pack_to_stdout,
2675 N_("output pack to stdout")),
2676 OPT_BOOL(0, "include-tag", &include_tag,
2677 N_("include tag objects that refer to objects to be packed")),
2678 OPT_BOOL(0, "keep-unreachable", &keep_unreachable,
2679 N_("keep unreachable objects")),
2680 OPT_BOOL(0, "pack-loose-unreachable", &pack_loose_unreachable,
2681 N_("pack loose unreachable objects")),
2682 { OPTION_CALLBACK, 0, "unpack-unreachable", NULL, N_("time"),
2683 N_("unpack unreachable objects newer than <time>"),
2684 PARSE_OPT_OPTARG, option_parse_unpack_unreachable },
2685 OPT_BOOL(0, "thin", &thin,
2686 N_("create thin packs")),
2687 OPT_BOOL(0, "shallow", &shallow,
2688 N_("create packs suitable for shallow fetches")),
2689 OPT_BOOL(0, "honor-pack-keep", &ignore_packed_keep,
2690 N_("ignore packs that have companion .keep file")),
2691 OPT_INTEGER(0, "compression", &pack_compression_level,
2692 N_("pack compression level")),
2693 OPT_SET_INT(0, "keep-true-parents", &grafts_replace_parents,
2694 N_("do not hide commits by grafts"), 0),
2695 OPT_BOOL(0, "use-bitmap-index", &use_bitmap_index,
2696 N_("use a bitmap index if available to speed up counting objects")),
2697 OPT_BOOL(0, "write-bitmap-index", &write_bitmap_index,
2698 N_("write a bitmap index together with the pack index")),
2699 OPT_END(),
2702 check_replace_refs = 0;
2704 reset_pack_idx_option(&pack_idx_opts);
2705 git_config(git_pack_config, NULL);
2706 if (!pack_compression_seen && core_compression_seen)
2707 pack_compression_level = core_compression_level;
2709 progress = isatty(2);
2710 argc = parse_options(argc, argv, prefix, pack_objects_options,
2711 pack_usage, 0);
2713 if (argc) {
2714 base_name = argv[0];
2715 argc--;
2717 if (pack_to_stdout != !base_name || argc)
2718 usage_with_options(pack_usage, pack_objects_options);
2720 argv_array_push(&rp, "pack-objects");
2721 if (thin) {
2722 use_internal_rev_list = 1;
2723 argv_array_push(&rp, shallow
2724 ? "--objects-edge-aggressive"
2725 : "--objects-edge");
2726 } else
2727 argv_array_push(&rp, "--objects");
2729 if (rev_list_all) {
2730 use_internal_rev_list = 1;
2731 argv_array_push(&rp, "--all");
2733 if (rev_list_reflog) {
2734 use_internal_rev_list = 1;
2735 argv_array_push(&rp, "--reflog");
2737 if (rev_list_index) {
2738 use_internal_rev_list = 1;
2739 argv_array_push(&rp, "--indexed-objects");
2741 if (rev_list_unpacked) {
2742 use_internal_rev_list = 1;
2743 argv_array_push(&rp, "--unpacked");
2746 if (!reuse_object)
2747 reuse_delta = 0;
2748 if (pack_compression_level == -1)
2749 pack_compression_level = Z_DEFAULT_COMPRESSION;
2750 else if (pack_compression_level < 0 || pack_compression_level > Z_BEST_COMPRESSION)
2751 die("bad pack compression level %d", pack_compression_level);
2753 if (!delta_search_threads) /* --threads=0 means autodetect */
2754 delta_search_threads = online_cpus();
2756 #ifdef NO_PTHREADS
2757 if (delta_search_threads != 1)
2758 warning("no threads support, ignoring --threads");
2759 #endif
2760 if (!pack_to_stdout && !pack_size_limit)
2761 pack_size_limit = pack_size_limit_cfg;
2762 if (pack_to_stdout && pack_size_limit)
2763 die("--max-pack-size cannot be used to build a pack for transfer.");
2764 if (pack_size_limit && pack_size_limit < 1024*1024) {
2765 warning("minimum pack size limit is 1 MiB");
2766 pack_size_limit = 1024*1024;
2769 if (!pack_to_stdout && thin)
2770 die("--thin cannot be used to build an indexable pack.");
2772 if (keep_unreachable && unpack_unreachable)
2773 die("--keep-unreachable and --unpack-unreachable are incompatible.");
2774 if (!rev_list_all || !rev_list_reflog || !rev_list_index)
2775 unpack_unreachable_expiration = 0;
2777 if (!use_internal_rev_list || !pack_to_stdout || is_repository_shallow())
2778 use_bitmap_index = 0;
2780 if (pack_to_stdout || !rev_list_all)
2781 write_bitmap_index = 0;
2783 if (progress && all_progress_implied)
2784 progress = 2;
2786 prepare_packed_git();
2788 if (progress)
2789 progress_state = start_progress(_("Counting objects"), 0);
2790 if (!use_internal_rev_list)
2791 read_object_list_from_stdin();
2792 else {
2793 get_object_list(rp.argc, rp.argv);
2794 argv_array_clear(&rp);
2796 cleanup_preferred_base();
2797 if (include_tag && nr_result)
2798 for_each_ref(add_ref_tag, NULL);
2799 stop_progress(&progress_state);
2801 if (non_empty && !nr_result)
2802 return 0;
2803 if (nr_result)
2804 prepare_pack(window, depth);
2805 write_pack_file();
2806 if (progress)
2807 fprintf(stderr, "Total %"PRIu32" (delta %"PRIu32"),"
2808 " reused %"PRIu32" (delta %"PRIu32")\n",
2809 written, written_delta, reused, reused_delta);
2810 return 0;