git-show-ref doc: typeset regexp in fixed width font
[git/jrn.git] / builtin / pack-objects.c
blob8bfe3a6ffb11fb2fc0956043dfafc2f3f66adccf
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 "progress.h"
18 #include "refs.h"
19 #include "thread-utils.h"
21 static const char pack_usage[] =
22 "git pack-objects [ -q | --progress | --all-progress ]\n"
23 " [--all-progress-implied]\n"
24 " [--max-pack-size=<n>] [--local] [--incremental]\n"
25 " [--window=<n>] [--window-memory=<n>] [--depth=<n>]\n"
26 " [--no-reuse-delta] [--no-reuse-object] [--delta-base-offset]\n"
27 " [--threads=<n>] [--non-empty] [--revs [--unpacked | --all]]\n"
28 " [--reflog] [--stdout | base-name] [--include-tag]\n"
29 " [--keep-unreachable | --unpack-unreachable]\n"
30 " [< ref-list | < object-list]";
32 struct object_entry {
33 struct pack_idx_entry idx;
34 unsigned long size; /* uncompressed size */
35 struct packed_git *in_pack; /* already in pack */
36 off_t in_pack_offset;
37 struct object_entry *delta; /* delta base object */
38 struct object_entry *delta_child; /* deltified objects who bases me */
39 struct object_entry *delta_sibling; /* other deltified objects who
40 * uses the same base as me
42 void *delta_data; /* cached delta (uncompressed) */
43 unsigned long delta_size; /* delta data size (uncompressed) */
44 unsigned long z_delta_size; /* delta data size (compressed) */
45 unsigned int hash; /* name hint hash */
46 enum object_type type;
47 enum object_type in_pack_type; /* could be delta */
48 unsigned char in_pack_header_size;
49 unsigned char preferred_base; /* we do not pack this, but is available
50 * to be used as the base object to delta
51 * objects against.
53 unsigned char no_try_delta;
57 * Objects we are going to pack are collected in objects array (dynamically
58 * expanded). nr_objects & nr_alloc controls this array. They are stored
59 * in the order we see -- typically rev-list --objects order that gives us
60 * nice "minimum seek" order.
62 static struct object_entry *objects;
63 static struct pack_idx_entry **written_list;
64 static uint32_t nr_objects, nr_alloc, nr_result, nr_written;
66 static int non_empty;
67 static int reuse_delta = 1, reuse_object = 1;
68 static int keep_unreachable, unpack_unreachable, include_tag;
69 static int local;
70 static int incremental;
71 static int ignore_packed_keep;
72 static int allow_ofs_delta;
73 static const char *base_name;
74 static int progress = 1;
75 static int window = 10;
76 static unsigned long pack_size_limit, pack_size_limit_cfg;
77 static int depth = 50;
78 static int delta_search_threads;
79 static int pack_to_stdout;
80 static int num_preferred_base;
81 static struct progress *progress_state;
82 static int pack_compression_level = Z_DEFAULT_COMPRESSION;
83 static int pack_compression_seen;
85 static unsigned long delta_cache_size = 0;
86 static unsigned long max_delta_cache_size = 256 * 1024 * 1024;
87 static unsigned long cache_max_small_delta_size = 1000;
89 static unsigned long window_memory_limit = 0;
92 * The object names in objects array are hashed with this hashtable,
93 * to help looking up the entry by object name.
94 * This hashtable is built after all the objects are seen.
96 static int *object_ix;
97 static int object_ix_hashsz;
100 * stats
102 static uint32_t written, written_delta;
103 static uint32_t reused, reused_delta;
106 static void *get_delta(struct object_entry *entry)
108 unsigned long size, base_size, delta_size;
109 void *buf, *base_buf, *delta_buf;
110 enum object_type type;
112 buf = read_sha1_file(entry->idx.sha1, &type, &size);
113 if (!buf)
114 die("unable to read %s", sha1_to_hex(entry->idx.sha1));
115 base_buf = read_sha1_file(entry->delta->idx.sha1, &type, &base_size);
116 if (!base_buf)
117 die("unable to read %s", sha1_to_hex(entry->delta->idx.sha1));
118 delta_buf = diff_delta(base_buf, base_size,
119 buf, size, &delta_size, 0);
120 if (!delta_buf || delta_size != entry->delta_size)
121 die("delta size changed");
122 free(buf);
123 free(base_buf);
124 return delta_buf;
127 static unsigned long do_compress(void **pptr, unsigned long size)
129 git_zstream stream;
130 void *in, *out;
131 unsigned long maxsize;
133 memset(&stream, 0, sizeof(stream));
134 git_deflate_init(&stream, pack_compression_level);
135 maxsize = git_deflate_bound(&stream, size);
137 in = *pptr;
138 out = xmalloc(maxsize);
139 *pptr = out;
141 stream.next_in = in;
142 stream.avail_in = size;
143 stream.next_out = out;
144 stream.avail_out = maxsize;
145 while (git_deflate(&stream, Z_FINISH) == Z_OK)
146 ; /* nothing */
147 git_deflate_end(&stream);
149 free(in);
150 return stream.total_out;
154 * we are going to reuse the existing object data as is. make
155 * sure it is not corrupt.
157 static int check_pack_inflate(struct packed_git *p,
158 struct pack_window **w_curs,
159 off_t offset,
160 off_t len,
161 unsigned long expect)
163 git_zstream stream;
164 unsigned char fakebuf[4096], *in;
165 int st;
167 memset(&stream, 0, sizeof(stream));
168 git_inflate_init(&stream);
169 do {
170 in = use_pack(p, w_curs, offset, &stream.avail_in);
171 stream.next_in = in;
172 stream.next_out = fakebuf;
173 stream.avail_out = sizeof(fakebuf);
174 st = git_inflate(&stream, Z_FINISH);
175 offset += stream.next_in - in;
176 } while (st == Z_OK || st == Z_BUF_ERROR);
177 git_inflate_end(&stream);
178 return (st == Z_STREAM_END &&
179 stream.total_out == expect &&
180 stream.total_in == len) ? 0 : -1;
183 static void copy_pack_data(struct sha1file *f,
184 struct packed_git *p,
185 struct pack_window **w_curs,
186 off_t offset,
187 off_t len)
189 unsigned char *in;
190 unsigned long avail;
192 while (len) {
193 in = use_pack(p, w_curs, offset, &avail);
194 if (avail > len)
195 avail = (unsigned long)len;
196 sha1write(f, in, avail);
197 offset += avail;
198 len -= avail;
202 static unsigned long write_object(struct sha1file *f,
203 struct object_entry *entry,
204 off_t write_offset)
206 unsigned long size, limit, datalen;
207 void *buf;
208 unsigned char header[10], dheader[10];
209 unsigned hdrlen;
210 enum object_type type;
211 int usable_delta, to_reuse;
213 if (!pack_to_stdout)
214 crc32_begin(f);
216 type = entry->type;
218 /* apply size limit if limited packsize and not first object */
219 if (!pack_size_limit || !nr_written)
220 limit = 0;
221 else if (pack_size_limit <= write_offset)
223 * the earlier object did not fit the limit; avoid
224 * mistaking this with unlimited (i.e. limit = 0).
226 limit = 1;
227 else
228 limit = pack_size_limit - write_offset;
230 if (!entry->delta)
231 usable_delta = 0; /* no delta */
232 else if (!pack_size_limit)
233 usable_delta = 1; /* unlimited packfile */
234 else if (entry->delta->idx.offset == (off_t)-1)
235 usable_delta = 0; /* base was written to another pack */
236 else if (entry->delta->idx.offset)
237 usable_delta = 1; /* base already exists in this pack */
238 else
239 usable_delta = 0; /* base could end up in another pack */
241 if (!reuse_object)
242 to_reuse = 0; /* explicit */
243 else if (!entry->in_pack)
244 to_reuse = 0; /* can't reuse what we don't have */
245 else if (type == OBJ_REF_DELTA || type == OBJ_OFS_DELTA)
246 /* check_object() decided it for us ... */
247 to_reuse = usable_delta;
248 /* ... but pack split may override that */
249 else if (type != entry->in_pack_type)
250 to_reuse = 0; /* pack has delta which is unusable */
251 else if (entry->delta)
252 to_reuse = 0; /* we want to pack afresh */
253 else
254 to_reuse = 1; /* we have it in-pack undeltified,
255 * and we do not need to deltify it.
258 if (!to_reuse) {
259 no_reuse:
260 if (!usable_delta) {
261 buf = read_sha1_file(entry->idx.sha1, &type, &size);
262 if (!buf)
263 die("unable to read %s", sha1_to_hex(entry->idx.sha1));
265 * make sure no cached delta data remains from a
266 * previous attempt before a pack split occurred.
268 free(entry->delta_data);
269 entry->delta_data = NULL;
270 entry->z_delta_size = 0;
271 } else if (entry->delta_data) {
272 size = entry->delta_size;
273 buf = entry->delta_data;
274 entry->delta_data = NULL;
275 type = (allow_ofs_delta && entry->delta->idx.offset) ?
276 OBJ_OFS_DELTA : OBJ_REF_DELTA;
277 } else {
278 buf = get_delta(entry);
279 size = entry->delta_size;
280 type = (allow_ofs_delta && entry->delta->idx.offset) ?
281 OBJ_OFS_DELTA : OBJ_REF_DELTA;
284 if (entry->z_delta_size)
285 datalen = entry->z_delta_size;
286 else
287 datalen = do_compress(&buf, size);
290 * The object header is a byte of 'type' followed by zero or
291 * more bytes of length.
293 hdrlen = encode_in_pack_object_header(type, size, header);
295 if (type == OBJ_OFS_DELTA) {
297 * Deltas with relative base contain an additional
298 * encoding of the relative offset for the delta
299 * base from this object's position in the pack.
301 off_t ofs = entry->idx.offset - entry->delta->idx.offset;
302 unsigned pos = sizeof(dheader) - 1;
303 dheader[pos] = ofs & 127;
304 while (ofs >>= 7)
305 dheader[--pos] = 128 | (--ofs & 127);
306 if (limit && hdrlen + sizeof(dheader) - pos + datalen + 20 >= limit) {
307 free(buf);
308 return 0;
310 sha1write(f, header, hdrlen);
311 sha1write(f, dheader + pos, sizeof(dheader) - pos);
312 hdrlen += sizeof(dheader) - pos;
313 } else if (type == OBJ_REF_DELTA) {
315 * Deltas with a base reference contain
316 * an additional 20 bytes for the base sha1.
318 if (limit && hdrlen + 20 + datalen + 20 >= limit) {
319 free(buf);
320 return 0;
322 sha1write(f, header, hdrlen);
323 sha1write(f, entry->delta->idx.sha1, 20);
324 hdrlen += 20;
325 } else {
326 if (limit && hdrlen + datalen + 20 >= limit) {
327 free(buf);
328 return 0;
330 sha1write(f, header, hdrlen);
332 sha1write(f, buf, datalen);
333 free(buf);
335 else {
336 struct packed_git *p = entry->in_pack;
337 struct pack_window *w_curs = NULL;
338 struct revindex_entry *revidx;
339 off_t offset;
341 if (entry->delta)
342 type = (allow_ofs_delta && entry->delta->idx.offset) ?
343 OBJ_OFS_DELTA : OBJ_REF_DELTA;
344 hdrlen = encode_in_pack_object_header(type, entry->size, header);
346 offset = entry->in_pack_offset;
347 revidx = find_pack_revindex(p, offset);
348 datalen = revidx[1].offset - offset;
349 if (!pack_to_stdout && p->index_version > 1 &&
350 check_pack_crc(p, &w_curs, offset, datalen, revidx->nr)) {
351 error("bad packed object CRC for %s", sha1_to_hex(entry->idx.sha1));
352 unuse_pack(&w_curs);
353 goto no_reuse;
356 offset += entry->in_pack_header_size;
357 datalen -= entry->in_pack_header_size;
358 if (!pack_to_stdout && p->index_version == 1 &&
359 check_pack_inflate(p, &w_curs, offset, datalen, entry->size)) {
360 error("corrupt packed object for %s", sha1_to_hex(entry->idx.sha1));
361 unuse_pack(&w_curs);
362 goto no_reuse;
365 if (type == OBJ_OFS_DELTA) {
366 off_t ofs = entry->idx.offset - entry->delta->idx.offset;
367 unsigned pos = sizeof(dheader) - 1;
368 dheader[pos] = ofs & 127;
369 while (ofs >>= 7)
370 dheader[--pos] = 128 | (--ofs & 127);
371 if (limit && hdrlen + sizeof(dheader) - pos + datalen + 20 >= limit) {
372 unuse_pack(&w_curs);
373 return 0;
375 sha1write(f, header, hdrlen);
376 sha1write(f, dheader + pos, sizeof(dheader) - pos);
377 hdrlen += sizeof(dheader) - pos;
378 reused_delta++;
379 } else if (type == OBJ_REF_DELTA) {
380 if (limit && hdrlen + 20 + datalen + 20 >= limit) {
381 unuse_pack(&w_curs);
382 return 0;
384 sha1write(f, header, hdrlen);
385 sha1write(f, entry->delta->idx.sha1, 20);
386 hdrlen += 20;
387 reused_delta++;
388 } else {
389 if (limit && hdrlen + datalen + 20 >= limit) {
390 unuse_pack(&w_curs);
391 return 0;
393 sha1write(f, header, hdrlen);
395 copy_pack_data(f, p, &w_curs, offset, datalen);
396 unuse_pack(&w_curs);
397 reused++;
399 if (usable_delta)
400 written_delta++;
401 written++;
402 if (!pack_to_stdout)
403 entry->idx.crc32 = crc32_end(f);
404 return hdrlen + datalen;
407 static int write_one(struct sha1file *f,
408 struct object_entry *e,
409 off_t *offset)
411 unsigned long size;
413 /* offset is non zero if object is written already. */
414 if (e->idx.offset || e->preferred_base)
415 return -1;
417 /* if we are deltified, write out base object first. */
418 if (e->delta && !write_one(f, e->delta, offset))
419 return 0;
421 e->idx.offset = *offset;
422 size = write_object(f, e, *offset);
423 if (!size) {
424 e->idx.offset = 0;
425 return 0;
427 written_list[nr_written++] = &e->idx;
429 /* make sure off_t is sufficiently large not to wrap */
430 if (signed_add_overflows(*offset, size))
431 die("pack too large for current definition of off_t");
432 *offset += size;
433 return 1;
436 static void write_pack_file(void)
438 uint32_t i = 0, j;
439 struct sha1file *f;
440 off_t offset;
441 struct pack_header hdr;
442 uint32_t nr_remaining = nr_result;
443 time_t last_mtime = 0;
445 if (progress > pack_to_stdout)
446 progress_state = start_progress("Writing objects", nr_result);
447 written_list = xmalloc(nr_objects * sizeof(*written_list));
449 do {
450 unsigned char sha1[20];
451 char *pack_tmp_name = NULL;
453 if (pack_to_stdout) {
454 f = sha1fd_throughput(1, "<stdout>", progress_state);
455 } else {
456 char tmpname[PATH_MAX];
457 int fd;
458 fd = odb_mkstemp(tmpname, sizeof(tmpname),
459 "pack/tmp_pack_XXXXXX");
460 pack_tmp_name = xstrdup(tmpname);
461 f = sha1fd(fd, pack_tmp_name);
464 hdr.hdr_signature = htonl(PACK_SIGNATURE);
465 hdr.hdr_version = htonl(PACK_VERSION);
466 hdr.hdr_entries = htonl(nr_remaining);
467 sha1write(f, &hdr, sizeof(hdr));
468 offset = sizeof(hdr);
469 nr_written = 0;
470 for (; i < nr_objects; i++) {
471 if (!write_one(f, objects + i, &offset))
472 break;
473 display_progress(progress_state, written);
477 * Did we write the wrong # entries in the header?
478 * If so, rewrite it like in fast-import
480 if (pack_to_stdout) {
481 sha1close(f, sha1, CSUM_CLOSE);
482 } else if (nr_written == nr_remaining) {
483 sha1close(f, sha1, CSUM_FSYNC);
484 } else {
485 int fd = sha1close(f, sha1, 0);
486 fixup_pack_header_footer(fd, sha1, pack_tmp_name,
487 nr_written, sha1, offset);
488 close(fd);
491 if (!pack_to_stdout) {
492 struct stat st;
493 const char *idx_tmp_name;
494 char tmpname[PATH_MAX];
496 idx_tmp_name = write_idx_file(NULL, written_list,
497 nr_written, sha1);
499 snprintf(tmpname, sizeof(tmpname), "%s-%s.pack",
500 base_name, sha1_to_hex(sha1));
501 free_pack_by_name(tmpname);
502 if (adjust_shared_perm(pack_tmp_name))
503 die_errno("unable to make temporary pack file readable");
504 if (rename(pack_tmp_name, tmpname))
505 die_errno("unable to rename temporary pack file");
508 * Packs are runtime accessed in their mtime
509 * order since newer packs are more likely to contain
510 * younger objects. So if we are creating multiple
511 * packs then we should modify the mtime of later ones
512 * to preserve this property.
514 if (stat(tmpname, &st) < 0) {
515 warning("failed to stat %s: %s",
516 tmpname, strerror(errno));
517 } else if (!last_mtime) {
518 last_mtime = st.st_mtime;
519 } else {
520 struct utimbuf utb;
521 utb.actime = st.st_atime;
522 utb.modtime = --last_mtime;
523 if (utime(tmpname, &utb) < 0)
524 warning("failed utime() on %s: %s",
525 tmpname, strerror(errno));
528 snprintf(tmpname, sizeof(tmpname), "%s-%s.idx",
529 base_name, sha1_to_hex(sha1));
530 if (adjust_shared_perm(idx_tmp_name))
531 die_errno("unable to make temporary index file readable");
532 if (rename(idx_tmp_name, tmpname))
533 die_errno("unable to rename temporary index file");
535 free((void *) idx_tmp_name);
536 free(pack_tmp_name);
537 puts(sha1_to_hex(sha1));
540 /* mark written objects as written to previous pack */
541 for (j = 0; j < nr_written; j++) {
542 written_list[j]->offset = (off_t)-1;
544 nr_remaining -= nr_written;
545 } while (nr_remaining && i < nr_objects);
547 free(written_list);
548 stop_progress(&progress_state);
549 if (written != nr_result)
550 die("wrote %"PRIu32" objects while expecting %"PRIu32,
551 written, nr_result);
554 static int locate_object_entry_hash(const unsigned char *sha1)
556 int i;
557 unsigned int ui;
558 memcpy(&ui, sha1, sizeof(unsigned int));
559 i = ui % object_ix_hashsz;
560 while (0 < object_ix[i]) {
561 if (!hashcmp(sha1, objects[object_ix[i] - 1].idx.sha1))
562 return i;
563 if (++i == object_ix_hashsz)
564 i = 0;
566 return -1 - i;
569 static struct object_entry *locate_object_entry(const unsigned char *sha1)
571 int i;
573 if (!object_ix_hashsz)
574 return NULL;
576 i = locate_object_entry_hash(sha1);
577 if (0 <= i)
578 return &objects[object_ix[i]-1];
579 return NULL;
582 static void rehash_objects(void)
584 uint32_t i;
585 struct object_entry *oe;
587 object_ix_hashsz = nr_objects * 3;
588 if (object_ix_hashsz < 1024)
589 object_ix_hashsz = 1024;
590 object_ix = xrealloc(object_ix, sizeof(int) * object_ix_hashsz);
591 memset(object_ix, 0, sizeof(int) * object_ix_hashsz);
592 for (i = 0, oe = objects; i < nr_objects; i++, oe++) {
593 int ix = locate_object_entry_hash(oe->idx.sha1);
594 if (0 <= ix)
595 continue;
596 ix = -1 - ix;
597 object_ix[ix] = i + 1;
601 static unsigned name_hash(const char *name)
603 unsigned c, hash = 0;
605 if (!name)
606 return 0;
609 * This effectively just creates a sortable number from the
610 * last sixteen non-whitespace characters. Last characters
611 * count "most", so things that end in ".c" sort together.
613 while ((c = *name++) != 0) {
614 if (isspace(c))
615 continue;
616 hash = (hash >> 2) + (c << 24);
618 return hash;
621 static void setup_delta_attr_check(struct git_attr_check *check)
623 static struct git_attr *attr_delta;
625 if (!attr_delta)
626 attr_delta = git_attr("delta");
628 check[0].attr = attr_delta;
631 static int no_try_delta(const char *path)
633 struct git_attr_check check[1];
635 setup_delta_attr_check(check);
636 if (git_checkattr(path, ARRAY_SIZE(check), check))
637 return 0;
638 if (ATTR_FALSE(check->value))
639 return 1;
640 return 0;
643 static int add_object_entry(const unsigned char *sha1, enum object_type type,
644 const char *name, int exclude)
646 struct object_entry *entry;
647 struct packed_git *p, *found_pack = NULL;
648 off_t found_offset = 0;
649 int ix;
650 unsigned hash = name_hash(name);
652 ix = nr_objects ? locate_object_entry_hash(sha1) : -1;
653 if (ix >= 0) {
654 if (exclude) {
655 entry = objects + object_ix[ix] - 1;
656 if (!entry->preferred_base)
657 nr_result--;
658 entry->preferred_base = 1;
660 return 0;
663 if (!exclude && local && has_loose_object_nonlocal(sha1))
664 return 0;
666 for (p = packed_git; p; p = p->next) {
667 off_t offset = find_pack_entry_one(sha1, p);
668 if (offset) {
669 if (!found_pack) {
670 found_offset = offset;
671 found_pack = p;
673 if (exclude)
674 break;
675 if (incremental)
676 return 0;
677 if (local && !p->pack_local)
678 return 0;
679 if (ignore_packed_keep && p->pack_local && p->pack_keep)
680 return 0;
684 if (nr_objects >= nr_alloc) {
685 nr_alloc = (nr_alloc + 1024) * 3 / 2;
686 objects = xrealloc(objects, nr_alloc * sizeof(*entry));
689 entry = objects + nr_objects++;
690 memset(entry, 0, sizeof(*entry));
691 hashcpy(entry->idx.sha1, sha1);
692 entry->hash = hash;
693 if (type)
694 entry->type = type;
695 if (exclude)
696 entry->preferred_base = 1;
697 else
698 nr_result++;
699 if (found_pack) {
700 entry->in_pack = found_pack;
701 entry->in_pack_offset = found_offset;
704 if (object_ix_hashsz * 3 <= nr_objects * 4)
705 rehash_objects();
706 else
707 object_ix[-1 - ix] = nr_objects;
709 display_progress(progress_state, nr_objects);
711 if (name && no_try_delta(name))
712 entry->no_try_delta = 1;
714 return 1;
717 struct pbase_tree_cache {
718 unsigned char sha1[20];
719 int ref;
720 int temporary;
721 void *tree_data;
722 unsigned long tree_size;
725 static struct pbase_tree_cache *(pbase_tree_cache[256]);
726 static int pbase_tree_cache_ix(const unsigned char *sha1)
728 return sha1[0] % ARRAY_SIZE(pbase_tree_cache);
730 static int pbase_tree_cache_ix_incr(int ix)
732 return (ix+1) % ARRAY_SIZE(pbase_tree_cache);
735 static struct pbase_tree {
736 struct pbase_tree *next;
737 /* This is a phony "cache" entry; we are not
738 * going to evict it nor find it through _get()
739 * mechanism -- this is for the toplevel node that
740 * would almost always change with any commit.
742 struct pbase_tree_cache pcache;
743 } *pbase_tree;
745 static struct pbase_tree_cache *pbase_tree_get(const unsigned char *sha1)
747 struct pbase_tree_cache *ent, *nent;
748 void *data;
749 unsigned long size;
750 enum object_type type;
751 int neigh;
752 int my_ix = pbase_tree_cache_ix(sha1);
753 int available_ix = -1;
755 /* pbase-tree-cache acts as a limited hashtable.
756 * your object will be found at your index or within a few
757 * slots after that slot if it is cached.
759 for (neigh = 0; neigh < 8; neigh++) {
760 ent = pbase_tree_cache[my_ix];
761 if (ent && !hashcmp(ent->sha1, sha1)) {
762 ent->ref++;
763 return ent;
765 else if (((available_ix < 0) && (!ent || !ent->ref)) ||
766 ((0 <= available_ix) &&
767 (!ent && pbase_tree_cache[available_ix])))
768 available_ix = my_ix;
769 if (!ent)
770 break;
771 my_ix = pbase_tree_cache_ix_incr(my_ix);
774 /* Did not find one. Either we got a bogus request or
775 * we need to read and perhaps cache.
777 data = read_sha1_file(sha1, &type, &size);
778 if (!data)
779 return NULL;
780 if (type != OBJ_TREE) {
781 free(data);
782 return NULL;
785 /* We need to either cache or return a throwaway copy */
787 if (available_ix < 0)
788 ent = NULL;
789 else {
790 ent = pbase_tree_cache[available_ix];
791 my_ix = available_ix;
794 if (!ent) {
795 nent = xmalloc(sizeof(*nent));
796 nent->temporary = (available_ix < 0);
798 else {
799 /* evict and reuse */
800 free(ent->tree_data);
801 nent = ent;
803 hashcpy(nent->sha1, sha1);
804 nent->tree_data = data;
805 nent->tree_size = size;
806 nent->ref = 1;
807 if (!nent->temporary)
808 pbase_tree_cache[my_ix] = nent;
809 return nent;
812 static void pbase_tree_put(struct pbase_tree_cache *cache)
814 if (!cache->temporary) {
815 cache->ref--;
816 return;
818 free(cache->tree_data);
819 free(cache);
822 static int name_cmp_len(const char *name)
824 int i;
825 for (i = 0; name[i] && name[i] != '\n' && name[i] != '/'; i++)
827 return i;
830 static void add_pbase_object(struct tree_desc *tree,
831 const char *name,
832 int cmplen,
833 const char *fullname)
835 struct name_entry entry;
836 int cmp;
838 while (tree_entry(tree,&entry)) {
839 if (S_ISGITLINK(entry.mode))
840 continue;
841 cmp = tree_entry_len(entry.path, entry.sha1) != cmplen ? 1 :
842 memcmp(name, entry.path, cmplen);
843 if (cmp > 0)
844 continue;
845 if (cmp < 0)
846 return;
847 if (name[cmplen] != '/') {
848 add_object_entry(entry.sha1,
849 object_type(entry.mode),
850 fullname, 1);
851 return;
853 if (S_ISDIR(entry.mode)) {
854 struct tree_desc sub;
855 struct pbase_tree_cache *tree;
856 const char *down = name+cmplen+1;
857 int downlen = name_cmp_len(down);
859 tree = pbase_tree_get(entry.sha1);
860 if (!tree)
861 return;
862 init_tree_desc(&sub, tree->tree_data, tree->tree_size);
864 add_pbase_object(&sub, down, downlen, fullname);
865 pbase_tree_put(tree);
870 static unsigned *done_pbase_paths;
871 static int done_pbase_paths_num;
872 static int done_pbase_paths_alloc;
873 static int done_pbase_path_pos(unsigned hash)
875 int lo = 0;
876 int hi = done_pbase_paths_num;
877 while (lo < hi) {
878 int mi = (hi + lo) / 2;
879 if (done_pbase_paths[mi] == hash)
880 return mi;
881 if (done_pbase_paths[mi] < hash)
882 hi = mi;
883 else
884 lo = mi + 1;
886 return -lo-1;
889 static int check_pbase_path(unsigned hash)
891 int pos = (!done_pbase_paths) ? -1 : done_pbase_path_pos(hash);
892 if (0 <= pos)
893 return 1;
894 pos = -pos - 1;
895 if (done_pbase_paths_alloc <= done_pbase_paths_num) {
896 done_pbase_paths_alloc = alloc_nr(done_pbase_paths_alloc);
897 done_pbase_paths = xrealloc(done_pbase_paths,
898 done_pbase_paths_alloc *
899 sizeof(unsigned));
901 done_pbase_paths_num++;
902 if (pos < done_pbase_paths_num)
903 memmove(done_pbase_paths + pos + 1,
904 done_pbase_paths + pos,
905 (done_pbase_paths_num - pos - 1) * sizeof(unsigned));
906 done_pbase_paths[pos] = hash;
907 return 0;
910 static void add_preferred_base_object(const char *name)
912 struct pbase_tree *it;
913 int cmplen;
914 unsigned hash = name_hash(name);
916 if (!num_preferred_base || check_pbase_path(hash))
917 return;
919 cmplen = name_cmp_len(name);
920 for (it = pbase_tree; it; it = it->next) {
921 if (cmplen == 0) {
922 add_object_entry(it->pcache.sha1, OBJ_TREE, NULL, 1);
924 else {
925 struct tree_desc tree;
926 init_tree_desc(&tree, it->pcache.tree_data, it->pcache.tree_size);
927 add_pbase_object(&tree, name, cmplen, name);
932 static void add_preferred_base(unsigned char *sha1)
934 struct pbase_tree *it;
935 void *data;
936 unsigned long size;
937 unsigned char tree_sha1[20];
939 if (window <= num_preferred_base++)
940 return;
942 data = read_object_with_reference(sha1, tree_type, &size, tree_sha1);
943 if (!data)
944 return;
946 for (it = pbase_tree; it; it = it->next) {
947 if (!hashcmp(it->pcache.sha1, tree_sha1)) {
948 free(data);
949 return;
953 it = xcalloc(1, sizeof(*it));
954 it->next = pbase_tree;
955 pbase_tree = it;
957 hashcpy(it->pcache.sha1, tree_sha1);
958 it->pcache.tree_data = data;
959 it->pcache.tree_size = size;
962 static void cleanup_preferred_base(void)
964 struct pbase_tree *it;
965 unsigned i;
967 it = pbase_tree;
968 pbase_tree = NULL;
969 while (it) {
970 struct pbase_tree *this = it;
971 it = this->next;
972 free(this->pcache.tree_data);
973 free(this);
976 for (i = 0; i < ARRAY_SIZE(pbase_tree_cache); i++) {
977 if (!pbase_tree_cache[i])
978 continue;
979 free(pbase_tree_cache[i]->tree_data);
980 free(pbase_tree_cache[i]);
981 pbase_tree_cache[i] = NULL;
984 free(done_pbase_paths);
985 done_pbase_paths = NULL;
986 done_pbase_paths_num = done_pbase_paths_alloc = 0;
989 static void check_object(struct object_entry *entry)
991 if (entry->in_pack) {
992 struct packed_git *p = entry->in_pack;
993 struct pack_window *w_curs = NULL;
994 const unsigned char *base_ref = NULL;
995 struct object_entry *base_entry;
996 unsigned long used, used_0;
997 unsigned long avail;
998 off_t ofs;
999 unsigned char *buf, c;
1001 buf = use_pack(p, &w_curs, entry->in_pack_offset, &avail);
1004 * We want in_pack_type even if we do not reuse delta
1005 * since non-delta representations could still be reused.
1007 used = unpack_object_header_buffer(buf, avail,
1008 &entry->in_pack_type,
1009 &entry->size);
1010 if (used == 0)
1011 goto give_up;
1014 * Determine if this is a delta and if so whether we can
1015 * reuse it or not. Otherwise let's find out as cheaply as
1016 * possible what the actual type and size for this object is.
1018 switch (entry->in_pack_type) {
1019 default:
1020 /* Not a delta hence we've already got all we need. */
1021 entry->type = entry->in_pack_type;
1022 entry->in_pack_header_size = used;
1023 if (entry->type < OBJ_COMMIT || entry->type > OBJ_BLOB)
1024 goto give_up;
1025 unuse_pack(&w_curs);
1026 return;
1027 case OBJ_REF_DELTA:
1028 if (reuse_delta && !entry->preferred_base)
1029 base_ref = use_pack(p, &w_curs,
1030 entry->in_pack_offset + used, NULL);
1031 entry->in_pack_header_size = used + 20;
1032 break;
1033 case OBJ_OFS_DELTA:
1034 buf = use_pack(p, &w_curs,
1035 entry->in_pack_offset + used, NULL);
1036 used_0 = 0;
1037 c = buf[used_0++];
1038 ofs = c & 127;
1039 while (c & 128) {
1040 ofs += 1;
1041 if (!ofs || MSB(ofs, 7)) {
1042 error("delta base offset overflow in pack for %s",
1043 sha1_to_hex(entry->idx.sha1));
1044 goto give_up;
1046 c = buf[used_0++];
1047 ofs = (ofs << 7) + (c & 127);
1049 ofs = entry->in_pack_offset - ofs;
1050 if (ofs <= 0 || ofs >= entry->in_pack_offset) {
1051 error("delta base offset out of bound for %s",
1052 sha1_to_hex(entry->idx.sha1));
1053 goto give_up;
1055 if (reuse_delta && !entry->preferred_base) {
1056 struct revindex_entry *revidx;
1057 revidx = find_pack_revindex(p, ofs);
1058 if (!revidx)
1059 goto give_up;
1060 base_ref = nth_packed_object_sha1(p, revidx->nr);
1062 entry->in_pack_header_size = used + used_0;
1063 break;
1066 if (base_ref && (base_entry = locate_object_entry(base_ref))) {
1068 * If base_ref was set above that means we wish to
1069 * reuse delta data, and we even found that base
1070 * in the list of objects we want to pack. Goodie!
1072 * Depth value does not matter - find_deltas() will
1073 * never consider reused delta as the base object to
1074 * deltify other objects against, in order to avoid
1075 * circular deltas.
1077 entry->type = entry->in_pack_type;
1078 entry->delta = base_entry;
1079 entry->delta_size = entry->size;
1080 entry->delta_sibling = base_entry->delta_child;
1081 base_entry->delta_child = entry;
1082 unuse_pack(&w_curs);
1083 return;
1086 if (entry->type) {
1088 * This must be a delta and we already know what the
1089 * final object type is. Let's extract the actual
1090 * object size from the delta header.
1092 entry->size = get_size_from_delta(p, &w_curs,
1093 entry->in_pack_offset + entry->in_pack_header_size);
1094 if (entry->size == 0)
1095 goto give_up;
1096 unuse_pack(&w_curs);
1097 return;
1101 * No choice but to fall back to the recursive delta walk
1102 * with sha1_object_info() to find about the object type
1103 * at this point...
1105 give_up:
1106 unuse_pack(&w_curs);
1109 entry->type = sha1_object_info(entry->idx.sha1, &entry->size);
1111 * The error condition is checked in prepare_pack(). This is
1112 * to permit a missing preferred base object to be ignored
1113 * as a preferred base. Doing so can result in a larger
1114 * pack file, but the transfer will still take place.
1118 static int pack_offset_sort(const void *_a, const void *_b)
1120 const struct object_entry *a = *(struct object_entry **)_a;
1121 const struct object_entry *b = *(struct object_entry **)_b;
1123 /* avoid filesystem trashing with loose objects */
1124 if (!a->in_pack && !b->in_pack)
1125 return hashcmp(a->idx.sha1, b->idx.sha1);
1127 if (a->in_pack < b->in_pack)
1128 return -1;
1129 if (a->in_pack > b->in_pack)
1130 return 1;
1131 return a->in_pack_offset < b->in_pack_offset ? -1 :
1132 (a->in_pack_offset > b->in_pack_offset);
1135 static void get_object_details(void)
1137 uint32_t i;
1138 struct object_entry **sorted_by_offset;
1140 sorted_by_offset = xcalloc(nr_objects, sizeof(struct object_entry *));
1141 for (i = 0; i < nr_objects; i++)
1142 sorted_by_offset[i] = objects + i;
1143 qsort(sorted_by_offset, nr_objects, sizeof(*sorted_by_offset), pack_offset_sort);
1145 for (i = 0; i < nr_objects; i++) {
1146 struct object_entry *entry = sorted_by_offset[i];
1147 check_object(entry);
1148 if (big_file_threshold <= entry->size)
1149 entry->no_try_delta = 1;
1152 free(sorted_by_offset);
1156 * We search for deltas in a list sorted by type, by filename hash, and then
1157 * by size, so that we see progressively smaller and smaller files.
1158 * That's because we prefer deltas to be from the bigger file
1159 * to the smaller -- deletes are potentially cheaper, but perhaps
1160 * more importantly, the bigger file is likely the more recent
1161 * one. The deepest deltas are therefore the oldest objects which are
1162 * less susceptible to be accessed often.
1164 static int type_size_sort(const void *_a, const void *_b)
1166 const struct object_entry *a = *(struct object_entry **)_a;
1167 const struct object_entry *b = *(struct object_entry **)_b;
1169 if (a->type > b->type)
1170 return -1;
1171 if (a->type < b->type)
1172 return 1;
1173 if (a->hash > b->hash)
1174 return -1;
1175 if (a->hash < b->hash)
1176 return 1;
1177 if (a->preferred_base > b->preferred_base)
1178 return -1;
1179 if (a->preferred_base < b->preferred_base)
1180 return 1;
1181 if (a->size > b->size)
1182 return -1;
1183 if (a->size < b->size)
1184 return 1;
1185 return a < b ? -1 : (a > b); /* newest first */
1188 struct unpacked {
1189 struct object_entry *entry;
1190 void *data;
1191 struct delta_index *index;
1192 unsigned depth;
1195 static int delta_cacheable(unsigned long src_size, unsigned long trg_size,
1196 unsigned long delta_size)
1198 if (max_delta_cache_size && delta_cache_size + delta_size > max_delta_cache_size)
1199 return 0;
1201 if (delta_size < cache_max_small_delta_size)
1202 return 1;
1204 /* cache delta, if objects are large enough compared to delta size */
1205 if ((src_size >> 20) + (trg_size >> 21) > (delta_size >> 10))
1206 return 1;
1208 return 0;
1211 #ifndef NO_PTHREADS
1213 static pthread_mutex_t read_mutex;
1214 #define read_lock() pthread_mutex_lock(&read_mutex)
1215 #define read_unlock() pthread_mutex_unlock(&read_mutex)
1217 static pthread_mutex_t cache_mutex;
1218 #define cache_lock() pthread_mutex_lock(&cache_mutex)
1219 #define cache_unlock() pthread_mutex_unlock(&cache_mutex)
1221 static pthread_mutex_t progress_mutex;
1222 #define progress_lock() pthread_mutex_lock(&progress_mutex)
1223 #define progress_unlock() pthread_mutex_unlock(&progress_mutex)
1225 #else
1227 #define read_lock() (void)0
1228 #define read_unlock() (void)0
1229 #define cache_lock() (void)0
1230 #define cache_unlock() (void)0
1231 #define progress_lock() (void)0
1232 #define progress_unlock() (void)0
1234 #endif
1236 static int try_delta(struct unpacked *trg, struct unpacked *src,
1237 unsigned max_depth, unsigned long *mem_usage)
1239 struct object_entry *trg_entry = trg->entry;
1240 struct object_entry *src_entry = src->entry;
1241 unsigned long trg_size, src_size, delta_size, sizediff, max_size, sz;
1242 unsigned ref_depth;
1243 enum object_type type;
1244 void *delta_buf;
1246 /* Don't bother doing diffs between different types */
1247 if (trg_entry->type != src_entry->type)
1248 return -1;
1251 * We do not bother to try a delta that we discarded on an
1252 * earlier try, but only when reusing delta data. Note that
1253 * src_entry that is marked as the preferred_base should always
1254 * be considered, as even if we produce a suboptimal delta against
1255 * it, we will still save the transfer cost, as we already know
1256 * the other side has it and we won't send src_entry at all.
1258 if (reuse_delta && trg_entry->in_pack &&
1259 trg_entry->in_pack == src_entry->in_pack &&
1260 !src_entry->preferred_base &&
1261 trg_entry->in_pack_type != OBJ_REF_DELTA &&
1262 trg_entry->in_pack_type != OBJ_OFS_DELTA)
1263 return 0;
1265 /* Let's not bust the allowed depth. */
1266 if (src->depth >= max_depth)
1267 return 0;
1269 /* Now some size filtering heuristics. */
1270 trg_size = trg_entry->size;
1271 if (!trg_entry->delta) {
1272 max_size = trg_size/2 - 20;
1273 ref_depth = 1;
1274 } else {
1275 max_size = trg_entry->delta_size;
1276 ref_depth = trg->depth;
1278 max_size = (uint64_t)max_size * (max_depth - src->depth) /
1279 (max_depth - ref_depth + 1);
1280 if (max_size == 0)
1281 return 0;
1282 src_size = src_entry->size;
1283 sizediff = src_size < trg_size ? trg_size - src_size : 0;
1284 if (sizediff >= max_size)
1285 return 0;
1286 if (trg_size < src_size / 32)
1287 return 0;
1289 /* Load data if not already done */
1290 if (!trg->data) {
1291 read_lock();
1292 trg->data = read_sha1_file(trg_entry->idx.sha1, &type, &sz);
1293 read_unlock();
1294 if (!trg->data)
1295 die("object %s cannot be read",
1296 sha1_to_hex(trg_entry->idx.sha1));
1297 if (sz != trg_size)
1298 die("object %s inconsistent object length (%lu vs %lu)",
1299 sha1_to_hex(trg_entry->idx.sha1), sz, trg_size);
1300 *mem_usage += sz;
1302 if (!src->data) {
1303 read_lock();
1304 src->data = read_sha1_file(src_entry->idx.sha1, &type, &sz);
1305 read_unlock();
1306 if (!src->data) {
1307 if (src_entry->preferred_base) {
1308 static int warned = 0;
1309 if (!warned++)
1310 warning("object %s cannot be read",
1311 sha1_to_hex(src_entry->idx.sha1));
1313 * Those objects are not included in the
1314 * resulting pack. Be resilient and ignore
1315 * them if they can't be read, in case the
1316 * pack could be created nevertheless.
1318 return 0;
1320 die("object %s cannot be read",
1321 sha1_to_hex(src_entry->idx.sha1));
1323 if (sz != src_size)
1324 die("object %s inconsistent object length (%lu vs %lu)",
1325 sha1_to_hex(src_entry->idx.sha1), sz, src_size);
1326 *mem_usage += sz;
1328 if (!src->index) {
1329 src->index = create_delta_index(src->data, src_size);
1330 if (!src->index) {
1331 static int warned = 0;
1332 if (!warned++)
1333 warning("suboptimal pack - out of memory");
1334 return 0;
1336 *mem_usage += sizeof_delta_index(src->index);
1339 delta_buf = create_delta(src->index, trg->data, trg_size, &delta_size, max_size);
1340 if (!delta_buf)
1341 return 0;
1343 if (trg_entry->delta) {
1344 /* Prefer only shallower same-sized deltas. */
1345 if (delta_size == trg_entry->delta_size &&
1346 src->depth + 1 >= trg->depth) {
1347 free(delta_buf);
1348 return 0;
1353 * Handle memory allocation outside of the cache
1354 * accounting lock. Compiler will optimize the strangeness
1355 * away when NO_PTHREADS is defined.
1357 free(trg_entry->delta_data);
1358 cache_lock();
1359 if (trg_entry->delta_data) {
1360 delta_cache_size -= trg_entry->delta_size;
1361 trg_entry->delta_data = NULL;
1363 if (delta_cacheable(src_size, trg_size, delta_size)) {
1364 delta_cache_size += delta_size;
1365 cache_unlock();
1366 trg_entry->delta_data = xrealloc(delta_buf, delta_size);
1367 } else {
1368 cache_unlock();
1369 free(delta_buf);
1372 trg_entry->delta = src_entry;
1373 trg_entry->delta_size = delta_size;
1374 trg->depth = src->depth + 1;
1376 return 1;
1379 static unsigned int check_delta_limit(struct object_entry *me, unsigned int n)
1381 struct object_entry *child = me->delta_child;
1382 unsigned int m = n;
1383 while (child) {
1384 unsigned int c = check_delta_limit(child, n + 1);
1385 if (m < c)
1386 m = c;
1387 child = child->delta_sibling;
1389 return m;
1392 static unsigned long free_unpacked(struct unpacked *n)
1394 unsigned long freed_mem = sizeof_delta_index(n->index);
1395 free_delta_index(n->index);
1396 n->index = NULL;
1397 if (n->data) {
1398 freed_mem += n->entry->size;
1399 free(n->data);
1400 n->data = NULL;
1402 n->entry = NULL;
1403 n->depth = 0;
1404 return freed_mem;
1407 static void find_deltas(struct object_entry **list, unsigned *list_size,
1408 int window, int depth, unsigned *processed)
1410 uint32_t i, idx = 0, count = 0;
1411 struct unpacked *array;
1412 unsigned long mem_usage = 0;
1414 array = xcalloc(window, sizeof(struct unpacked));
1416 for (;;) {
1417 struct object_entry *entry;
1418 struct unpacked *n = array + idx;
1419 int j, max_depth, best_base = -1;
1421 progress_lock();
1422 if (!*list_size) {
1423 progress_unlock();
1424 break;
1426 entry = *list++;
1427 (*list_size)--;
1428 if (!entry->preferred_base) {
1429 (*processed)++;
1430 display_progress(progress_state, *processed);
1432 progress_unlock();
1434 mem_usage -= free_unpacked(n);
1435 n->entry = entry;
1437 while (window_memory_limit &&
1438 mem_usage > window_memory_limit &&
1439 count > 1) {
1440 uint32_t tail = (idx + window - count) % window;
1441 mem_usage -= free_unpacked(array + tail);
1442 count--;
1445 /* We do not compute delta to *create* objects we are not
1446 * going to pack.
1448 if (entry->preferred_base)
1449 goto next;
1452 * If the current object is at pack edge, take the depth the
1453 * objects that depend on the current object into account
1454 * otherwise they would become too deep.
1456 max_depth = depth;
1457 if (entry->delta_child) {
1458 max_depth -= check_delta_limit(entry, 0);
1459 if (max_depth <= 0)
1460 goto next;
1463 j = window;
1464 while (--j > 0) {
1465 int ret;
1466 uint32_t other_idx = idx + j;
1467 struct unpacked *m;
1468 if (other_idx >= window)
1469 other_idx -= window;
1470 m = array + other_idx;
1471 if (!m->entry)
1472 break;
1473 ret = try_delta(n, m, max_depth, &mem_usage);
1474 if (ret < 0)
1475 break;
1476 else if (ret > 0)
1477 best_base = other_idx;
1481 * If we decided to cache the delta data, then it is best
1482 * to compress it right away. First because we have to do
1483 * it anyway, and doing it here while we're threaded will
1484 * save a lot of time in the non threaded write phase,
1485 * as well as allow for caching more deltas within
1486 * the same cache size limit.
1487 * ...
1488 * But only if not writing to stdout, since in that case
1489 * the network is most likely throttling writes anyway,
1490 * and therefore it is best to go to the write phase ASAP
1491 * instead, as we can afford spending more time compressing
1492 * between writes at that moment.
1494 if (entry->delta_data && !pack_to_stdout) {
1495 entry->z_delta_size = do_compress(&entry->delta_data,
1496 entry->delta_size);
1497 cache_lock();
1498 delta_cache_size -= entry->delta_size;
1499 delta_cache_size += entry->z_delta_size;
1500 cache_unlock();
1503 /* if we made n a delta, and if n is already at max
1504 * depth, leaving it in the window is pointless. we
1505 * should evict it first.
1507 if (entry->delta && max_depth <= n->depth)
1508 continue;
1511 * Move the best delta base up in the window, after the
1512 * currently deltified object, to keep it longer. It will
1513 * be the first base object to be attempted next.
1515 if (entry->delta) {
1516 struct unpacked swap = array[best_base];
1517 int dist = (window + idx - best_base) % window;
1518 int dst = best_base;
1519 while (dist--) {
1520 int src = (dst + 1) % window;
1521 array[dst] = array[src];
1522 dst = src;
1524 array[dst] = swap;
1527 next:
1528 idx++;
1529 if (count + 1 < window)
1530 count++;
1531 if (idx >= window)
1532 idx = 0;
1535 for (i = 0; i < window; ++i) {
1536 free_delta_index(array[i].index);
1537 free(array[i].data);
1539 free(array);
1542 #ifndef NO_PTHREADS
1544 static void try_to_free_from_threads(size_t size)
1546 read_lock();
1547 release_pack_memory(size, -1);
1548 read_unlock();
1551 static try_to_free_t old_try_to_free_routine;
1554 * The main thread waits on the condition that (at least) one of the workers
1555 * has stopped working (which is indicated in the .working member of
1556 * struct thread_params).
1557 * When a work thread has completed its work, it sets .working to 0 and
1558 * signals the main thread and waits on the condition that .data_ready
1559 * becomes 1.
1562 struct thread_params {
1563 pthread_t thread;
1564 struct object_entry **list;
1565 unsigned list_size;
1566 unsigned remaining;
1567 int window;
1568 int depth;
1569 int working;
1570 int data_ready;
1571 pthread_mutex_t mutex;
1572 pthread_cond_t cond;
1573 unsigned *processed;
1576 static pthread_cond_t progress_cond;
1579 * Mutex and conditional variable can't be statically-initialized on Windows.
1581 static void init_threaded_search(void)
1583 init_recursive_mutex(&read_mutex);
1584 pthread_mutex_init(&cache_mutex, NULL);
1585 pthread_mutex_init(&progress_mutex, NULL);
1586 pthread_cond_init(&progress_cond, NULL);
1587 old_try_to_free_routine = set_try_to_free_routine(try_to_free_from_threads);
1590 static void cleanup_threaded_search(void)
1592 set_try_to_free_routine(old_try_to_free_routine);
1593 pthread_cond_destroy(&progress_cond);
1594 pthread_mutex_destroy(&read_mutex);
1595 pthread_mutex_destroy(&cache_mutex);
1596 pthread_mutex_destroy(&progress_mutex);
1599 static void *threaded_find_deltas(void *arg)
1601 struct thread_params *me = arg;
1603 while (me->remaining) {
1604 find_deltas(me->list, &me->remaining,
1605 me->window, me->depth, me->processed);
1607 progress_lock();
1608 me->working = 0;
1609 pthread_cond_signal(&progress_cond);
1610 progress_unlock();
1613 * We must not set ->data_ready before we wait on the
1614 * condition because the main thread may have set it to 1
1615 * before we get here. In order to be sure that new
1616 * work is available if we see 1 in ->data_ready, it
1617 * was initialized to 0 before this thread was spawned
1618 * and we reset it to 0 right away.
1620 pthread_mutex_lock(&me->mutex);
1621 while (!me->data_ready)
1622 pthread_cond_wait(&me->cond, &me->mutex);
1623 me->data_ready = 0;
1624 pthread_mutex_unlock(&me->mutex);
1626 /* leave ->working 1 so that this doesn't get more work assigned */
1627 return NULL;
1630 static void ll_find_deltas(struct object_entry **list, unsigned list_size,
1631 int window, int depth, unsigned *processed)
1633 struct thread_params *p;
1634 int i, ret, active_threads = 0;
1636 init_threaded_search();
1638 if (!delta_search_threads) /* --threads=0 means autodetect */
1639 delta_search_threads = online_cpus();
1640 if (delta_search_threads <= 1) {
1641 find_deltas(list, &list_size, window, depth, processed);
1642 cleanup_threaded_search();
1643 return;
1645 if (progress > pack_to_stdout)
1646 fprintf(stderr, "Delta compression using up to %d threads.\n",
1647 delta_search_threads);
1648 p = xcalloc(delta_search_threads, sizeof(*p));
1650 /* Partition the work amongst work threads. */
1651 for (i = 0; i < delta_search_threads; i++) {
1652 unsigned sub_size = list_size / (delta_search_threads - i);
1654 /* don't use too small segments or no deltas will be found */
1655 if (sub_size < 2*window && i+1 < delta_search_threads)
1656 sub_size = 0;
1658 p[i].window = window;
1659 p[i].depth = depth;
1660 p[i].processed = processed;
1661 p[i].working = 1;
1662 p[i].data_ready = 0;
1664 /* try to split chunks on "path" boundaries */
1665 while (sub_size && sub_size < list_size &&
1666 list[sub_size]->hash &&
1667 list[sub_size]->hash == list[sub_size-1]->hash)
1668 sub_size++;
1670 p[i].list = list;
1671 p[i].list_size = sub_size;
1672 p[i].remaining = sub_size;
1674 list += sub_size;
1675 list_size -= sub_size;
1678 /* Start work threads. */
1679 for (i = 0; i < delta_search_threads; i++) {
1680 if (!p[i].list_size)
1681 continue;
1682 pthread_mutex_init(&p[i].mutex, NULL);
1683 pthread_cond_init(&p[i].cond, NULL);
1684 ret = pthread_create(&p[i].thread, NULL,
1685 threaded_find_deltas, &p[i]);
1686 if (ret)
1687 die("unable to create thread: %s", strerror(ret));
1688 active_threads++;
1692 * Now let's wait for work completion. Each time a thread is done
1693 * with its work, we steal half of the remaining work from the
1694 * thread with the largest number of unprocessed objects and give
1695 * it to that newly idle thread. This ensure good load balancing
1696 * until the remaining object list segments are simply too short
1697 * to be worth splitting anymore.
1699 while (active_threads) {
1700 struct thread_params *target = NULL;
1701 struct thread_params *victim = NULL;
1702 unsigned sub_size = 0;
1704 progress_lock();
1705 for (;;) {
1706 for (i = 0; !target && i < delta_search_threads; i++)
1707 if (!p[i].working)
1708 target = &p[i];
1709 if (target)
1710 break;
1711 pthread_cond_wait(&progress_cond, &progress_mutex);
1714 for (i = 0; i < delta_search_threads; i++)
1715 if (p[i].remaining > 2*window &&
1716 (!victim || victim->remaining < p[i].remaining))
1717 victim = &p[i];
1718 if (victim) {
1719 sub_size = victim->remaining / 2;
1720 list = victim->list + victim->list_size - sub_size;
1721 while (sub_size && list[0]->hash &&
1722 list[0]->hash == list[-1]->hash) {
1723 list++;
1724 sub_size--;
1726 if (!sub_size) {
1728 * It is possible for some "paths" to have
1729 * so many objects that no hash boundary
1730 * might be found. Let's just steal the
1731 * exact half in that case.
1733 sub_size = victim->remaining / 2;
1734 list -= sub_size;
1736 target->list = list;
1737 victim->list_size -= sub_size;
1738 victim->remaining -= sub_size;
1740 target->list_size = sub_size;
1741 target->remaining = sub_size;
1742 target->working = 1;
1743 progress_unlock();
1745 pthread_mutex_lock(&target->mutex);
1746 target->data_ready = 1;
1747 pthread_cond_signal(&target->cond);
1748 pthread_mutex_unlock(&target->mutex);
1750 if (!sub_size) {
1751 pthread_join(target->thread, NULL);
1752 pthread_cond_destroy(&target->cond);
1753 pthread_mutex_destroy(&target->mutex);
1754 active_threads--;
1757 cleanup_threaded_search();
1758 free(p);
1761 #else
1762 #define ll_find_deltas(l, s, w, d, p) find_deltas(l, &s, w, d, p)
1763 #endif
1765 static int add_ref_tag(const char *path, const unsigned char *sha1, int flag, void *cb_data)
1767 unsigned char peeled[20];
1769 if (!prefixcmp(path, "refs/tags/") && /* is a tag? */
1770 !peel_ref(path, peeled) && /* peelable? */
1771 !is_null_sha1(peeled) && /* annotated tag? */
1772 locate_object_entry(peeled)) /* object packed? */
1773 add_object_entry(sha1, OBJ_TAG, NULL, 0);
1774 return 0;
1777 static void prepare_pack(int window, int depth)
1779 struct object_entry **delta_list;
1780 uint32_t i, nr_deltas;
1781 unsigned n;
1783 get_object_details();
1786 * If we're locally repacking then we need to be doubly careful
1787 * from now on in order to make sure no stealth corruption gets
1788 * propagated to the new pack. Clients receiving streamed packs
1789 * should validate everything they get anyway so no need to incur
1790 * the additional cost here in that case.
1792 if (!pack_to_stdout)
1793 do_check_packed_object_crc = 1;
1795 if (!nr_objects || !window || !depth)
1796 return;
1798 delta_list = xmalloc(nr_objects * sizeof(*delta_list));
1799 nr_deltas = n = 0;
1801 for (i = 0; i < nr_objects; i++) {
1802 struct object_entry *entry = objects + i;
1804 if (entry->delta)
1805 /* This happens if we decided to reuse existing
1806 * delta from a pack. "reuse_delta &&" is implied.
1808 continue;
1810 if (entry->size < 50)
1811 continue;
1813 if (entry->no_try_delta)
1814 continue;
1816 if (!entry->preferred_base) {
1817 nr_deltas++;
1818 if (entry->type < 0)
1819 die("unable to get type of object %s",
1820 sha1_to_hex(entry->idx.sha1));
1821 } else {
1822 if (entry->type < 0) {
1824 * This object is not found, but we
1825 * don't have to include it anyway.
1827 continue;
1831 delta_list[n++] = entry;
1834 if (nr_deltas && n > 1) {
1835 unsigned nr_done = 0;
1836 if (progress)
1837 progress_state = start_progress("Compressing objects",
1838 nr_deltas);
1839 qsort(delta_list, n, sizeof(*delta_list), type_size_sort);
1840 ll_find_deltas(delta_list, n, window+1, depth, &nr_done);
1841 stop_progress(&progress_state);
1842 if (nr_done != nr_deltas)
1843 die("inconsistency with delta count");
1845 free(delta_list);
1848 static int git_pack_config(const char *k, const char *v, void *cb)
1850 if (!strcmp(k, "pack.window")) {
1851 window = git_config_int(k, v);
1852 return 0;
1854 if (!strcmp(k, "pack.windowmemory")) {
1855 window_memory_limit = git_config_ulong(k, v);
1856 return 0;
1858 if (!strcmp(k, "pack.depth")) {
1859 depth = git_config_int(k, v);
1860 return 0;
1862 if (!strcmp(k, "pack.compression")) {
1863 int level = git_config_int(k, v);
1864 if (level == -1)
1865 level = Z_DEFAULT_COMPRESSION;
1866 else if (level < 0 || level > Z_BEST_COMPRESSION)
1867 die("bad pack compression level %d", level);
1868 pack_compression_level = level;
1869 pack_compression_seen = 1;
1870 return 0;
1872 if (!strcmp(k, "pack.deltacachesize")) {
1873 max_delta_cache_size = git_config_int(k, v);
1874 return 0;
1876 if (!strcmp(k, "pack.deltacachelimit")) {
1877 cache_max_small_delta_size = git_config_int(k, v);
1878 return 0;
1880 if (!strcmp(k, "pack.threads")) {
1881 delta_search_threads = git_config_int(k, v);
1882 if (delta_search_threads < 0)
1883 die("invalid number of threads specified (%d)",
1884 delta_search_threads);
1885 #ifdef NO_PTHREADS
1886 if (delta_search_threads != 1)
1887 warning("no threads support, ignoring %s", k);
1888 #endif
1889 return 0;
1891 if (!strcmp(k, "pack.indexversion")) {
1892 pack_idx_default_version = git_config_int(k, v);
1893 if (pack_idx_default_version > 2)
1894 die("bad pack.indexversion=%"PRIu32,
1895 pack_idx_default_version);
1896 return 0;
1898 if (!strcmp(k, "pack.packsizelimit")) {
1899 pack_size_limit_cfg = git_config_ulong(k, v);
1900 return 0;
1902 return git_default_config(k, v, cb);
1905 static void read_object_list_from_stdin(void)
1907 char line[40 + 1 + PATH_MAX + 2];
1908 unsigned char sha1[20];
1910 for (;;) {
1911 if (!fgets(line, sizeof(line), stdin)) {
1912 if (feof(stdin))
1913 break;
1914 if (!ferror(stdin))
1915 die("fgets returned NULL, not EOF, not error!");
1916 if (errno != EINTR)
1917 die_errno("fgets");
1918 clearerr(stdin);
1919 continue;
1921 if (line[0] == '-') {
1922 if (get_sha1_hex(line+1, sha1))
1923 die("expected edge sha1, got garbage:\n %s",
1924 line);
1925 add_preferred_base(sha1);
1926 continue;
1928 if (get_sha1_hex(line, sha1))
1929 die("expected sha1, got garbage:\n %s", line);
1931 add_preferred_base_object(line+41);
1932 add_object_entry(sha1, 0, line+41, 0);
1936 #define OBJECT_ADDED (1u<<20)
1938 static void show_commit(struct commit *commit, void *data)
1940 add_object_entry(commit->object.sha1, OBJ_COMMIT, NULL, 0);
1941 commit->object.flags |= OBJECT_ADDED;
1944 static void show_object(struct object *obj, const struct name_path *path, const char *last)
1946 char *name = path_name(path, last);
1948 add_preferred_base_object(name);
1949 add_object_entry(obj->sha1, obj->type, name, 0);
1950 obj->flags |= OBJECT_ADDED;
1953 * We will have generated the hash from the name,
1954 * but not saved a pointer to it - we can free it
1956 free((char *)name);
1959 static void show_edge(struct commit *commit)
1961 add_preferred_base(commit->object.sha1);
1964 struct in_pack_object {
1965 off_t offset;
1966 struct object *object;
1969 struct in_pack {
1970 int alloc;
1971 int nr;
1972 struct in_pack_object *array;
1975 static void mark_in_pack_object(struct object *object, struct packed_git *p, struct in_pack *in_pack)
1977 in_pack->array[in_pack->nr].offset = find_pack_entry_one(object->sha1, p);
1978 in_pack->array[in_pack->nr].object = object;
1979 in_pack->nr++;
1983 * Compare the objects in the offset order, in order to emulate the
1984 * "git rev-list --objects" output that produced the pack originally.
1986 static int ofscmp(const void *a_, const void *b_)
1988 struct in_pack_object *a = (struct in_pack_object *)a_;
1989 struct in_pack_object *b = (struct in_pack_object *)b_;
1991 if (a->offset < b->offset)
1992 return -1;
1993 else if (a->offset > b->offset)
1994 return 1;
1995 else
1996 return hashcmp(a->object->sha1, b->object->sha1);
1999 static void add_objects_in_unpacked_packs(struct rev_info *revs)
2001 struct packed_git *p;
2002 struct in_pack in_pack;
2003 uint32_t i;
2005 memset(&in_pack, 0, sizeof(in_pack));
2007 for (p = packed_git; p; p = p->next) {
2008 const unsigned char *sha1;
2009 struct object *o;
2011 if (!p->pack_local || p->pack_keep)
2012 continue;
2013 if (open_pack_index(p))
2014 die("cannot open pack index");
2016 ALLOC_GROW(in_pack.array,
2017 in_pack.nr + p->num_objects,
2018 in_pack.alloc);
2020 for (i = 0; i < p->num_objects; i++) {
2021 sha1 = nth_packed_object_sha1(p, i);
2022 o = lookup_unknown_object(sha1);
2023 if (!(o->flags & OBJECT_ADDED))
2024 mark_in_pack_object(o, p, &in_pack);
2025 o->flags |= OBJECT_ADDED;
2029 if (in_pack.nr) {
2030 qsort(in_pack.array, in_pack.nr, sizeof(in_pack.array[0]),
2031 ofscmp);
2032 for (i = 0; i < in_pack.nr; i++) {
2033 struct object *o = in_pack.array[i].object;
2034 add_object_entry(o->sha1, o->type, "", 0);
2037 free(in_pack.array);
2040 static int has_sha1_pack_kept_or_nonlocal(const unsigned char *sha1)
2042 static struct packed_git *last_found = (void *)1;
2043 struct packed_git *p;
2045 p = (last_found != (void *)1) ? last_found : packed_git;
2047 while (p) {
2048 if ((!p->pack_local || p->pack_keep) &&
2049 find_pack_entry_one(sha1, p)) {
2050 last_found = p;
2051 return 1;
2053 if (p == last_found)
2054 p = packed_git;
2055 else
2056 p = p->next;
2057 if (p == last_found)
2058 p = p->next;
2060 return 0;
2063 static void loosen_unused_packed_objects(struct rev_info *revs)
2065 struct packed_git *p;
2066 uint32_t i;
2067 const unsigned char *sha1;
2069 for (p = packed_git; p; p = p->next) {
2070 if (!p->pack_local || p->pack_keep)
2071 continue;
2073 if (open_pack_index(p))
2074 die("cannot open pack index");
2076 for (i = 0; i < p->num_objects; i++) {
2077 sha1 = nth_packed_object_sha1(p, i);
2078 if (!locate_object_entry(sha1) &&
2079 !has_sha1_pack_kept_or_nonlocal(sha1))
2080 if (force_object_loose(sha1, p->mtime))
2081 die("unable to force loose object");
2086 static void get_object_list(int ac, const char **av)
2088 struct rev_info revs;
2089 char line[1000];
2090 int flags = 0;
2092 init_revisions(&revs, NULL);
2093 save_commit_buffer = 0;
2094 setup_revisions(ac, av, &revs, NULL);
2096 while (fgets(line, sizeof(line), stdin) != NULL) {
2097 int len = strlen(line);
2098 if (len && line[len - 1] == '\n')
2099 line[--len] = 0;
2100 if (!len)
2101 break;
2102 if (*line == '-') {
2103 if (!strcmp(line, "--not")) {
2104 flags ^= UNINTERESTING;
2105 continue;
2107 die("not a rev '%s'", line);
2109 if (handle_revision_arg(line, &revs, flags, 1))
2110 die("bad revision '%s'", line);
2113 if (prepare_revision_walk(&revs))
2114 die("revision walk setup failed");
2115 mark_edges_uninteresting(revs.commits, &revs, show_edge);
2116 traverse_commit_list(&revs, show_commit, show_object, NULL);
2118 if (keep_unreachable)
2119 add_objects_in_unpacked_packs(&revs);
2120 if (unpack_unreachable)
2121 loosen_unused_packed_objects(&revs);
2124 int cmd_pack_objects(int argc, const char **argv, const char *prefix)
2126 int use_internal_rev_list = 0;
2127 int thin = 0;
2128 int all_progress_implied = 0;
2129 uint32_t i;
2130 const char **rp_av;
2131 int rp_ac_alloc = 64;
2132 int rp_ac;
2134 read_replace_refs = 0;
2136 rp_av = xcalloc(rp_ac_alloc, sizeof(*rp_av));
2138 rp_av[0] = "pack-objects";
2139 rp_av[1] = "--objects"; /* --thin will make it --objects-edge */
2140 rp_ac = 2;
2142 git_config(git_pack_config, NULL);
2143 if (!pack_compression_seen && core_compression_seen)
2144 pack_compression_level = core_compression_level;
2146 progress = isatty(2);
2147 for (i = 1; i < argc; i++) {
2148 const char *arg = argv[i];
2150 if (*arg != '-')
2151 break;
2153 if (!strcmp("--non-empty", arg)) {
2154 non_empty = 1;
2155 continue;
2157 if (!strcmp("--local", arg)) {
2158 local = 1;
2159 continue;
2161 if (!strcmp("--incremental", arg)) {
2162 incremental = 1;
2163 continue;
2165 if (!strcmp("--honor-pack-keep", arg)) {
2166 ignore_packed_keep = 1;
2167 continue;
2169 if (!prefixcmp(arg, "--compression=")) {
2170 char *end;
2171 int level = strtoul(arg+14, &end, 0);
2172 if (!arg[14] || *end)
2173 usage(pack_usage);
2174 if (level == -1)
2175 level = Z_DEFAULT_COMPRESSION;
2176 else if (level < 0 || level > Z_BEST_COMPRESSION)
2177 die("bad pack compression level %d", level);
2178 pack_compression_level = level;
2179 continue;
2181 if (!prefixcmp(arg, "--max-pack-size=")) {
2182 pack_size_limit_cfg = 0;
2183 if (!git_parse_ulong(arg+16, &pack_size_limit))
2184 usage(pack_usage);
2185 continue;
2187 if (!prefixcmp(arg, "--window=")) {
2188 char *end;
2189 window = strtoul(arg+9, &end, 0);
2190 if (!arg[9] || *end)
2191 usage(pack_usage);
2192 continue;
2194 if (!prefixcmp(arg, "--window-memory=")) {
2195 if (!git_parse_ulong(arg+16, &window_memory_limit))
2196 usage(pack_usage);
2197 continue;
2199 if (!prefixcmp(arg, "--threads=")) {
2200 char *end;
2201 delta_search_threads = strtoul(arg+10, &end, 0);
2202 if (!arg[10] || *end || delta_search_threads < 0)
2203 usage(pack_usage);
2204 #ifdef NO_PTHREADS
2205 if (delta_search_threads != 1)
2206 warning("no threads support, "
2207 "ignoring %s", arg);
2208 #endif
2209 continue;
2211 if (!prefixcmp(arg, "--depth=")) {
2212 char *end;
2213 depth = strtoul(arg+8, &end, 0);
2214 if (!arg[8] || *end)
2215 usage(pack_usage);
2216 continue;
2218 if (!strcmp("--progress", arg)) {
2219 progress = 1;
2220 continue;
2222 if (!strcmp("--all-progress", arg)) {
2223 progress = 2;
2224 continue;
2226 if (!strcmp("--all-progress-implied", arg)) {
2227 all_progress_implied = 1;
2228 continue;
2230 if (!strcmp("-q", arg)) {
2231 progress = 0;
2232 continue;
2234 if (!strcmp("--no-reuse-delta", arg)) {
2235 reuse_delta = 0;
2236 continue;
2238 if (!strcmp("--no-reuse-object", arg)) {
2239 reuse_object = reuse_delta = 0;
2240 continue;
2242 if (!strcmp("--delta-base-offset", arg)) {
2243 allow_ofs_delta = 1;
2244 continue;
2246 if (!strcmp("--stdout", arg)) {
2247 pack_to_stdout = 1;
2248 continue;
2250 if (!strcmp("--revs", arg)) {
2251 use_internal_rev_list = 1;
2252 continue;
2254 if (!strcmp("--keep-unreachable", arg)) {
2255 keep_unreachable = 1;
2256 continue;
2258 if (!strcmp("--unpack-unreachable", arg)) {
2259 unpack_unreachable = 1;
2260 continue;
2262 if (!strcmp("--include-tag", arg)) {
2263 include_tag = 1;
2264 continue;
2266 if (!strcmp("--unpacked", arg) ||
2267 !strcmp("--reflog", arg) ||
2268 !strcmp("--all", arg)) {
2269 use_internal_rev_list = 1;
2270 if (rp_ac >= rp_ac_alloc - 1) {
2271 rp_ac_alloc = alloc_nr(rp_ac_alloc);
2272 rp_av = xrealloc(rp_av,
2273 rp_ac_alloc * sizeof(*rp_av));
2275 rp_av[rp_ac++] = arg;
2276 continue;
2278 if (!strcmp("--thin", arg)) {
2279 use_internal_rev_list = 1;
2280 thin = 1;
2281 rp_av[1] = "--objects-edge";
2282 continue;
2284 if (!prefixcmp(arg, "--index-version=")) {
2285 char *c;
2286 pack_idx_default_version = strtoul(arg + 16, &c, 10);
2287 if (pack_idx_default_version > 2)
2288 die("bad %s", arg);
2289 if (*c == ',')
2290 pack_idx_off32_limit = strtoul(c+1, &c, 0);
2291 if (*c || pack_idx_off32_limit & 0x80000000)
2292 die("bad %s", arg);
2293 continue;
2295 if (!strcmp(arg, "--keep-true-parents")) {
2296 grafts_replace_parents = 0;
2297 continue;
2299 usage(pack_usage);
2302 /* Traditionally "pack-objects [options] base extra" failed;
2303 * we would however want to take refs parameter that would
2304 * have been given to upstream rev-list ourselves, which means
2305 * we somehow want to say what the base name is. So the
2306 * syntax would be:
2308 * pack-objects [options] base <refs...>
2310 * in other words, we would treat the first non-option as the
2311 * base_name and send everything else to the internal revision
2312 * walker.
2315 if (!pack_to_stdout)
2316 base_name = argv[i++];
2318 if (pack_to_stdout != !base_name)
2319 usage(pack_usage);
2321 if (!pack_to_stdout && !pack_size_limit)
2322 pack_size_limit = pack_size_limit_cfg;
2323 if (pack_to_stdout && pack_size_limit)
2324 die("--max-pack-size cannot be used to build a pack for transfer.");
2325 if (pack_size_limit && pack_size_limit < 1024*1024) {
2326 warning("minimum pack size limit is 1 MiB");
2327 pack_size_limit = 1024*1024;
2330 if (!pack_to_stdout && thin)
2331 die("--thin cannot be used to build an indexable pack.");
2333 if (keep_unreachable && unpack_unreachable)
2334 die("--keep-unreachable and --unpack-unreachable are incompatible.");
2336 if (progress && all_progress_implied)
2337 progress = 2;
2339 prepare_packed_git();
2341 if (progress)
2342 progress_state = start_progress("Counting objects", 0);
2343 if (!use_internal_rev_list)
2344 read_object_list_from_stdin();
2345 else {
2346 rp_av[rp_ac] = NULL;
2347 get_object_list(rp_ac, rp_av);
2349 cleanup_preferred_base();
2350 if (include_tag && nr_result)
2351 for_each_ref(add_ref_tag, NULL);
2352 stop_progress(&progress_state);
2354 if (non_empty && !nr_result)
2355 return 0;
2356 if (nr_result)
2357 prepare_pack(window, depth);
2358 write_pack_file();
2359 if (progress)
2360 fprintf(stderr, "Total %"PRIu32" (delta %"PRIu32"),"
2361 " reused %"PRIu32" (delta %"PRIu32")\n",
2362 written, written_delta, reused, reused_delta);
2363 return 0;