make check_object() resilient to pack corruptions
[git/jrn.git] / builtin-pack-objects.c
blobc05fb944b0e5d4d26cb2ba1995a787f08d5228ad
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"
20 #ifdef THREADED_DELTA_SEARCH
21 #include "thread-utils.h"
22 #include <pthread.h>
23 #endif
25 static const char pack_usage[] = "\
26 git pack-objects [{ -q | --progress | --all-progress }] \n\
27 [--max-pack-size=N] [--local] [--incremental] \n\
28 [--window=N] [--window-memory=N] [--depth=N] \n\
29 [--no-reuse-delta] [--no-reuse-object] [--delta-base-offset] \n\
30 [--threads=N] [--non-empty] [--revs [--unpacked | --all]*] [--reflog] \n\
31 [--stdout | base-name] [--include-tag] \n\
32 [--keep-unreachable | --unpack-unreachable] \n\
33 [<ref-list | <object-list]";
35 struct object_entry {
36 struct pack_idx_entry idx;
37 unsigned long size; /* uncompressed size */
38 struct packed_git *in_pack; /* already in pack */
39 off_t in_pack_offset;
40 struct object_entry *delta; /* delta base object */
41 struct object_entry *delta_child; /* deltified objects who bases me */
42 struct object_entry *delta_sibling; /* other deltified objects who
43 * uses the same base as me
45 void *delta_data; /* cached delta (uncompressed) */
46 unsigned long delta_size; /* delta data size (uncompressed) */
47 unsigned long z_delta_size; /* delta data size (compressed) */
48 unsigned int hash; /* name hint hash */
49 enum object_type type;
50 enum object_type in_pack_type; /* could be delta */
51 unsigned char in_pack_header_size;
52 unsigned char preferred_base; /* we do not pack this, but is available
53 * to be used as the base object to delta
54 * objects against.
56 unsigned char no_try_delta;
60 * Objects we are going to pack are collected in objects array (dynamically
61 * expanded). nr_objects & nr_alloc controls this array. They are stored
62 * in the order we see -- typically rev-list --objects order that gives us
63 * nice "minimum seek" order.
65 static struct object_entry *objects;
66 static struct pack_idx_entry **written_list;
67 static uint32_t nr_objects, nr_alloc, nr_result, nr_written;
69 static int non_empty;
70 static int reuse_delta = 1, reuse_object = 1;
71 static int keep_unreachable, unpack_unreachable, include_tag;
72 static int local;
73 static int incremental;
74 static int allow_ofs_delta;
75 static const char *base_name;
76 static int progress = 1;
77 static int window = 10;
78 static uint32_t pack_size_limit, pack_size_limit_cfg;
79 static int depth = 50;
80 static int delta_search_threads = 1;
81 static int pack_to_stdout;
82 static int num_preferred_base;
83 static struct progress *progress_state;
84 static int pack_compression_level = Z_DEFAULT_COMPRESSION;
85 static int pack_compression_seen;
87 static unsigned long delta_cache_size = 0;
88 static unsigned long max_delta_cache_size = 0;
89 static unsigned long cache_max_small_delta_size = 1000;
91 static unsigned long window_memory_limit = 0;
94 * The object names in objects array are hashed with this hashtable,
95 * to help looking up the entry by object name.
96 * This hashtable is built after all the objects are seen.
98 static int *object_ix;
99 static int object_ix_hashsz;
102 * stats
104 static uint32_t written, written_delta;
105 static uint32_t reused, reused_delta;
108 static void *get_delta(struct object_entry *entry)
110 unsigned long size, base_size, delta_size;
111 void *buf, *base_buf, *delta_buf;
112 enum object_type type;
114 buf = read_sha1_file(entry->idx.sha1, &type, &size);
115 if (!buf)
116 die("unable to read %s", sha1_to_hex(entry->idx.sha1));
117 base_buf = read_sha1_file(entry->delta->idx.sha1, &type, &base_size);
118 if (!base_buf)
119 die("unable to read %s", sha1_to_hex(entry->delta->idx.sha1));
120 delta_buf = diff_delta(base_buf, base_size,
121 buf, size, &delta_size, 0);
122 if (!delta_buf || delta_size != entry->delta_size)
123 die("delta size changed");
124 free(buf);
125 free(base_buf);
126 return delta_buf;
129 static unsigned long do_compress(void **pptr, unsigned long size)
131 z_stream stream;
132 void *in, *out;
133 unsigned long maxsize;
135 memset(&stream, 0, sizeof(stream));
136 deflateInit(&stream, pack_compression_level);
137 maxsize = deflateBound(&stream, size);
139 in = *pptr;
140 out = xmalloc(maxsize);
141 *pptr = out;
143 stream.next_in = in;
144 stream.avail_in = size;
145 stream.next_out = out;
146 stream.avail_out = maxsize;
147 while (deflate(&stream, Z_FINISH) == Z_OK)
148 ; /* nothing */
149 deflateEnd(&stream);
151 free(in);
152 return stream.total_out;
156 * The per-object header is a pretty dense thing, which is
157 * - first byte: low four bits are "size", then three bits of "type",
158 * and the high bit is "size continues".
159 * - each byte afterwards: low seven bits are size continuation,
160 * with the high bit being "size continues"
162 static int encode_header(enum object_type type, unsigned long size, unsigned char *hdr)
164 int n = 1;
165 unsigned char c;
167 if (type < OBJ_COMMIT || type > OBJ_REF_DELTA)
168 die("bad type %d", type);
170 c = (type << 4) | (size & 15);
171 size >>= 4;
172 while (size) {
173 *hdr++ = c | 0x80;
174 c = size & 0x7f;
175 size >>= 7;
176 n++;
178 *hdr = c;
179 return n;
183 * we are going to reuse the existing object data as is. make
184 * sure it is not corrupt.
186 static int check_pack_inflate(struct packed_git *p,
187 struct pack_window **w_curs,
188 off_t offset,
189 off_t len,
190 unsigned long expect)
192 z_stream stream;
193 unsigned char fakebuf[4096], *in;
194 int st;
196 memset(&stream, 0, sizeof(stream));
197 inflateInit(&stream);
198 do {
199 in = use_pack(p, w_curs, offset, &stream.avail_in);
200 stream.next_in = in;
201 stream.next_out = fakebuf;
202 stream.avail_out = sizeof(fakebuf);
203 st = inflate(&stream, Z_FINISH);
204 offset += stream.next_in - in;
205 } while (st == Z_OK || st == Z_BUF_ERROR);
206 inflateEnd(&stream);
207 return (st == Z_STREAM_END &&
208 stream.total_out == expect &&
209 stream.total_in == len) ? 0 : -1;
212 static void copy_pack_data(struct sha1file *f,
213 struct packed_git *p,
214 struct pack_window **w_curs,
215 off_t offset,
216 off_t len)
218 unsigned char *in;
219 unsigned int avail;
221 while (len) {
222 in = use_pack(p, w_curs, offset, &avail);
223 if (avail > len)
224 avail = (unsigned int)len;
225 sha1write(f, in, avail);
226 offset += avail;
227 len -= avail;
231 static unsigned long write_object(struct sha1file *f,
232 struct object_entry *entry,
233 off_t write_offset)
235 unsigned long size, limit, datalen;
236 void *buf;
237 unsigned char header[10], dheader[10];
238 unsigned hdrlen;
239 enum object_type type;
240 int usable_delta, to_reuse;
242 if (!pack_to_stdout)
243 crc32_begin(f);
245 type = entry->type;
247 /* write limit if limited packsize and not first object */
248 limit = pack_size_limit && nr_written ?
249 pack_size_limit - write_offset : 0;
251 if (!entry->delta)
252 usable_delta = 0; /* no delta */
253 else if (!pack_size_limit)
254 usable_delta = 1; /* unlimited packfile */
255 else if (entry->delta->idx.offset == (off_t)-1)
256 usable_delta = 0; /* base was written to another pack */
257 else if (entry->delta->idx.offset)
258 usable_delta = 1; /* base already exists in this pack */
259 else
260 usable_delta = 0; /* base could end up in another pack */
262 if (!reuse_object)
263 to_reuse = 0; /* explicit */
264 else if (!entry->in_pack)
265 to_reuse = 0; /* can't reuse what we don't have */
266 else if (type == OBJ_REF_DELTA || type == OBJ_OFS_DELTA)
267 /* check_object() decided it for us ... */
268 to_reuse = usable_delta;
269 /* ... but pack split may override that */
270 else if (type != entry->in_pack_type)
271 to_reuse = 0; /* pack has delta which is unusable */
272 else if (entry->delta)
273 to_reuse = 0; /* we want to pack afresh */
274 else
275 to_reuse = 1; /* we have it in-pack undeltified,
276 * and we do not need to deltify it.
279 if (!to_reuse) {
280 if (!usable_delta) {
281 buf = read_sha1_file(entry->idx.sha1, &type, &size);
282 if (!buf)
283 die("unable to read %s", sha1_to_hex(entry->idx.sha1));
285 * make sure no cached delta data remains from a
286 * previous attempt before a pack split occured.
288 free(entry->delta_data);
289 entry->delta_data = NULL;
290 entry->z_delta_size = 0;
291 } else if (entry->delta_data) {
292 size = entry->delta_size;
293 buf = entry->delta_data;
294 entry->delta_data = NULL;
295 type = (allow_ofs_delta && entry->delta->idx.offset) ?
296 OBJ_OFS_DELTA : OBJ_REF_DELTA;
297 } else {
298 buf = get_delta(entry);
299 size = entry->delta_size;
300 type = (allow_ofs_delta && entry->delta->idx.offset) ?
301 OBJ_OFS_DELTA : OBJ_REF_DELTA;
304 if (entry->z_delta_size)
305 datalen = entry->z_delta_size;
306 else
307 datalen = do_compress(&buf, size);
310 * The object header is a byte of 'type' followed by zero or
311 * more bytes of length.
313 hdrlen = encode_header(type, size, header);
315 if (type == OBJ_OFS_DELTA) {
317 * Deltas with relative base contain an additional
318 * encoding of the relative offset for the delta
319 * base from this object's position in the pack.
321 off_t ofs = entry->idx.offset - entry->delta->idx.offset;
322 unsigned pos = sizeof(dheader) - 1;
323 dheader[pos] = ofs & 127;
324 while (ofs >>= 7)
325 dheader[--pos] = 128 | (--ofs & 127);
326 if (limit && hdrlen + sizeof(dheader) - pos + datalen + 20 >= limit) {
327 free(buf);
328 return 0;
330 sha1write(f, header, hdrlen);
331 sha1write(f, dheader + pos, sizeof(dheader) - pos);
332 hdrlen += sizeof(dheader) - pos;
333 } else if (type == OBJ_REF_DELTA) {
335 * Deltas with a base reference contain
336 * an additional 20 bytes for the base sha1.
338 if (limit && hdrlen + 20 + datalen + 20 >= limit) {
339 free(buf);
340 return 0;
342 sha1write(f, header, hdrlen);
343 sha1write(f, entry->delta->idx.sha1, 20);
344 hdrlen += 20;
345 } else {
346 if (limit && hdrlen + datalen + 20 >= limit) {
347 free(buf);
348 return 0;
350 sha1write(f, header, hdrlen);
352 sha1write(f, buf, datalen);
353 free(buf);
355 else {
356 struct packed_git *p = entry->in_pack;
357 struct pack_window *w_curs = NULL;
358 struct revindex_entry *revidx;
359 off_t offset;
361 if (entry->delta) {
362 type = (allow_ofs_delta && entry->delta->idx.offset) ?
363 OBJ_OFS_DELTA : OBJ_REF_DELTA;
364 reused_delta++;
366 hdrlen = encode_header(type, entry->size, header);
367 offset = entry->in_pack_offset;
368 revidx = find_pack_revindex(p, offset);
369 datalen = revidx[1].offset - offset;
370 if (!pack_to_stdout && p->index_version > 1 &&
371 check_pack_crc(p, &w_curs, offset, datalen, revidx->nr))
372 die("bad packed object CRC for %s", sha1_to_hex(entry->idx.sha1));
373 offset += entry->in_pack_header_size;
374 datalen -= entry->in_pack_header_size;
375 if (type == OBJ_OFS_DELTA) {
376 off_t ofs = entry->idx.offset - entry->delta->idx.offset;
377 unsigned pos = sizeof(dheader) - 1;
378 dheader[pos] = ofs & 127;
379 while (ofs >>= 7)
380 dheader[--pos] = 128 | (--ofs & 127);
381 if (limit && hdrlen + sizeof(dheader) - pos + datalen + 20 >= limit)
382 return 0;
383 sha1write(f, header, hdrlen);
384 sha1write(f, dheader + pos, sizeof(dheader) - pos);
385 hdrlen += sizeof(dheader) - pos;
386 } else if (type == OBJ_REF_DELTA) {
387 if (limit && hdrlen + 20 + datalen + 20 >= limit)
388 return 0;
389 sha1write(f, header, hdrlen);
390 sha1write(f, entry->delta->idx.sha1, 20);
391 hdrlen += 20;
392 } else {
393 if (limit && hdrlen + datalen + 20 >= limit)
394 return 0;
395 sha1write(f, header, hdrlen);
398 if (!pack_to_stdout && p->index_version == 1 &&
399 check_pack_inflate(p, &w_curs, offset, datalen, entry->size))
400 die("corrupt packed object for %s", sha1_to_hex(entry->idx.sha1));
401 copy_pack_data(f, p, &w_curs, offset, datalen);
402 unuse_pack(&w_curs);
403 reused++;
405 if (usable_delta)
406 written_delta++;
407 written++;
408 if (!pack_to_stdout)
409 entry->idx.crc32 = crc32_end(f);
410 return hdrlen + datalen;
413 static int write_one(struct sha1file *f,
414 struct object_entry *e,
415 off_t *offset)
417 unsigned long size;
419 /* offset is non zero if object is written already. */
420 if (e->idx.offset || e->preferred_base)
421 return 1;
423 /* if we are deltified, write out base object first. */
424 if (e->delta && !write_one(f, e->delta, offset))
425 return 0;
427 e->idx.offset = *offset;
428 size = write_object(f, e, *offset);
429 if (!size) {
430 e->idx.offset = 0;
431 return 0;
433 written_list[nr_written++] = &e->idx;
435 /* make sure off_t is sufficiently large not to wrap */
436 if (*offset > *offset + size)
437 die("pack too large for current definition of off_t");
438 *offset += size;
439 return 1;
442 /* forward declaration for write_pack_file */
443 static int adjust_perm(const char *path, mode_t mode);
445 static void write_pack_file(void)
447 uint32_t i = 0, j;
448 struct sha1file *f;
449 off_t offset;
450 struct pack_header hdr;
451 uint32_t nr_remaining = nr_result;
452 time_t last_mtime = 0;
454 if (progress > pack_to_stdout)
455 progress_state = start_progress("Writing objects", nr_result);
456 written_list = xmalloc(nr_objects * sizeof(*written_list));
458 do {
459 unsigned char sha1[20];
460 char *pack_tmp_name = NULL;
462 if (pack_to_stdout) {
463 f = sha1fd_throughput(1, "<stdout>", progress_state);
464 } else {
465 char tmpname[PATH_MAX];
466 int fd;
467 snprintf(tmpname, sizeof(tmpname),
468 "%s/pack/tmp_pack_XXXXXX", get_object_directory());
469 fd = xmkstemp(tmpname);
470 pack_tmp_name = xstrdup(tmpname);
471 f = sha1fd(fd, pack_tmp_name);
474 hdr.hdr_signature = htonl(PACK_SIGNATURE);
475 hdr.hdr_version = htonl(PACK_VERSION);
476 hdr.hdr_entries = htonl(nr_remaining);
477 sha1write(f, &hdr, sizeof(hdr));
478 offset = sizeof(hdr);
479 nr_written = 0;
480 for (; i < nr_objects; i++) {
481 if (!write_one(f, objects + i, &offset))
482 break;
483 display_progress(progress_state, written);
487 * Did we write the wrong # entries in the header?
488 * If so, rewrite it like in fast-import
490 if (pack_to_stdout) {
491 sha1close(f, sha1, CSUM_CLOSE);
492 } else if (nr_written == nr_remaining) {
493 sha1close(f, sha1, CSUM_FSYNC);
494 } else {
495 int fd = sha1close(f, sha1, 0);
496 fixup_pack_header_footer(fd, sha1, pack_tmp_name,
497 nr_written, sha1, offset);
498 close(fd);
501 if (!pack_to_stdout) {
502 mode_t mode = umask(0);
503 struct stat st;
504 char *idx_tmp_name, tmpname[PATH_MAX];
506 umask(mode);
507 mode = 0444 & ~mode;
509 idx_tmp_name = write_idx_file(NULL, written_list,
510 nr_written, sha1);
512 snprintf(tmpname, sizeof(tmpname), "%s-%s.pack",
513 base_name, sha1_to_hex(sha1));
514 if (adjust_perm(pack_tmp_name, mode))
515 die("unable to make temporary pack file readable: %s",
516 strerror(errno));
517 if (rename(pack_tmp_name, tmpname))
518 die("unable to rename temporary pack file: %s",
519 strerror(errno));
522 * Packs are runtime accessed in their mtime
523 * order since newer packs are more likely to contain
524 * younger objects. So if we are creating multiple
525 * packs then we should modify the mtime of later ones
526 * to preserve this property.
528 if (stat(tmpname, &st) < 0) {
529 warning("failed to stat %s: %s",
530 tmpname, strerror(errno));
531 } else if (!last_mtime) {
532 last_mtime = st.st_mtime;
533 } else {
534 struct utimbuf utb;
535 utb.actime = st.st_atime;
536 utb.modtime = --last_mtime;
537 if (utime(tmpname, &utb) < 0)
538 warning("failed utime() on %s: %s",
539 tmpname, strerror(errno));
542 snprintf(tmpname, sizeof(tmpname), "%s-%s.idx",
543 base_name, sha1_to_hex(sha1));
544 if (adjust_perm(idx_tmp_name, mode))
545 die("unable to make temporary index file readable: %s",
546 strerror(errno));
547 if (rename(idx_tmp_name, tmpname))
548 die("unable to rename temporary index file: %s",
549 strerror(errno));
551 free(idx_tmp_name);
552 free(pack_tmp_name);
553 puts(sha1_to_hex(sha1));
556 /* mark written objects as written to previous pack */
557 for (j = 0; j < nr_written; j++) {
558 written_list[j]->offset = (off_t)-1;
560 nr_remaining -= nr_written;
561 } while (nr_remaining && i < nr_objects);
563 free(written_list);
564 stop_progress(&progress_state);
565 if (written != nr_result)
566 die("wrote %"PRIu32" objects while expecting %"PRIu32,
567 written, nr_result);
569 * We have scanned through [0 ... i). Since we have written
570 * the correct number of objects, the remaining [i ... nr_objects)
571 * items must be either already written (due to out-of-order delta base)
572 * or a preferred base. Count those which are neither and complain if any.
574 for (j = 0; i < nr_objects; i++) {
575 struct object_entry *e = objects + i;
576 j += !e->idx.offset && !e->preferred_base;
578 if (j)
579 die("wrote %"PRIu32" objects as expected but %"PRIu32
580 " unwritten", written, j);
583 static int locate_object_entry_hash(const unsigned char *sha1)
585 int i;
586 unsigned int ui;
587 memcpy(&ui, sha1, sizeof(unsigned int));
588 i = ui % object_ix_hashsz;
589 while (0 < object_ix[i]) {
590 if (!hashcmp(sha1, objects[object_ix[i] - 1].idx.sha1))
591 return i;
592 if (++i == object_ix_hashsz)
593 i = 0;
595 return -1 - i;
598 static struct object_entry *locate_object_entry(const unsigned char *sha1)
600 int i;
602 if (!object_ix_hashsz)
603 return NULL;
605 i = locate_object_entry_hash(sha1);
606 if (0 <= i)
607 return &objects[object_ix[i]-1];
608 return NULL;
611 static void rehash_objects(void)
613 uint32_t i;
614 struct object_entry *oe;
616 object_ix_hashsz = nr_objects * 3;
617 if (object_ix_hashsz < 1024)
618 object_ix_hashsz = 1024;
619 object_ix = xrealloc(object_ix, sizeof(int) * object_ix_hashsz);
620 memset(object_ix, 0, sizeof(int) * object_ix_hashsz);
621 for (i = 0, oe = objects; i < nr_objects; i++, oe++) {
622 int ix = locate_object_entry_hash(oe->idx.sha1);
623 if (0 <= ix)
624 continue;
625 ix = -1 - ix;
626 object_ix[ix] = i + 1;
630 static unsigned name_hash(const char *name)
632 unsigned char c;
633 unsigned hash = 0;
635 if (!name)
636 return 0;
639 * This effectively just creates a sortable number from the
640 * last sixteen non-whitespace characters. Last characters
641 * count "most", so things that end in ".c" sort together.
643 while ((c = *name++) != 0) {
644 if (isspace(c))
645 continue;
646 hash = (hash >> 2) + (c << 24);
648 return hash;
651 static void setup_delta_attr_check(struct git_attr_check *check)
653 static struct git_attr *attr_delta;
655 if (!attr_delta)
656 attr_delta = git_attr("delta", 5);
658 check[0].attr = attr_delta;
661 static int no_try_delta(const char *path)
663 struct git_attr_check check[1];
665 setup_delta_attr_check(check);
666 if (git_checkattr(path, ARRAY_SIZE(check), check))
667 return 0;
668 if (ATTR_FALSE(check->value))
669 return 1;
670 return 0;
673 static int add_object_entry(const unsigned char *sha1, enum object_type type,
674 const char *name, int exclude)
676 struct object_entry *entry;
677 struct packed_git *p, *found_pack = NULL;
678 off_t found_offset = 0;
679 int ix;
680 unsigned hash = name_hash(name);
682 ix = nr_objects ? locate_object_entry_hash(sha1) : -1;
683 if (ix >= 0) {
684 if (exclude) {
685 entry = objects + object_ix[ix] - 1;
686 if (!entry->preferred_base)
687 nr_result--;
688 entry->preferred_base = 1;
690 return 0;
693 for (p = packed_git; p; p = p->next) {
694 off_t offset = find_pack_entry_one(sha1, p);
695 if (offset) {
696 if (!found_pack) {
697 found_offset = offset;
698 found_pack = p;
700 if (exclude)
701 break;
702 if (incremental)
703 return 0;
704 if (local && !p->pack_local)
705 return 0;
709 if (nr_objects >= nr_alloc) {
710 nr_alloc = (nr_alloc + 1024) * 3 / 2;
711 objects = xrealloc(objects, nr_alloc * sizeof(*entry));
714 entry = objects + nr_objects++;
715 memset(entry, 0, sizeof(*entry));
716 hashcpy(entry->idx.sha1, sha1);
717 entry->hash = hash;
718 if (type)
719 entry->type = type;
720 if (exclude)
721 entry->preferred_base = 1;
722 else
723 nr_result++;
724 if (found_pack) {
725 entry->in_pack = found_pack;
726 entry->in_pack_offset = found_offset;
729 if (object_ix_hashsz * 3 <= nr_objects * 4)
730 rehash_objects();
731 else
732 object_ix[-1 - ix] = nr_objects;
734 display_progress(progress_state, nr_objects);
736 if (name && no_try_delta(name))
737 entry->no_try_delta = 1;
739 return 1;
742 struct pbase_tree_cache {
743 unsigned char sha1[20];
744 int ref;
745 int temporary;
746 void *tree_data;
747 unsigned long tree_size;
750 static struct pbase_tree_cache *(pbase_tree_cache[256]);
751 static int pbase_tree_cache_ix(const unsigned char *sha1)
753 return sha1[0] % ARRAY_SIZE(pbase_tree_cache);
755 static int pbase_tree_cache_ix_incr(int ix)
757 return (ix+1) % ARRAY_SIZE(pbase_tree_cache);
760 static struct pbase_tree {
761 struct pbase_tree *next;
762 /* This is a phony "cache" entry; we are not
763 * going to evict it nor find it through _get()
764 * mechanism -- this is for the toplevel node that
765 * would almost always change with any commit.
767 struct pbase_tree_cache pcache;
768 } *pbase_tree;
770 static struct pbase_tree_cache *pbase_tree_get(const unsigned char *sha1)
772 struct pbase_tree_cache *ent, *nent;
773 void *data;
774 unsigned long size;
775 enum object_type type;
776 int neigh;
777 int my_ix = pbase_tree_cache_ix(sha1);
778 int available_ix = -1;
780 /* pbase-tree-cache acts as a limited hashtable.
781 * your object will be found at your index or within a few
782 * slots after that slot if it is cached.
784 for (neigh = 0; neigh < 8; neigh++) {
785 ent = pbase_tree_cache[my_ix];
786 if (ent && !hashcmp(ent->sha1, sha1)) {
787 ent->ref++;
788 return ent;
790 else if (((available_ix < 0) && (!ent || !ent->ref)) ||
791 ((0 <= available_ix) &&
792 (!ent && pbase_tree_cache[available_ix])))
793 available_ix = my_ix;
794 if (!ent)
795 break;
796 my_ix = pbase_tree_cache_ix_incr(my_ix);
799 /* Did not find one. Either we got a bogus request or
800 * we need to read and perhaps cache.
802 data = read_sha1_file(sha1, &type, &size);
803 if (!data)
804 return NULL;
805 if (type != OBJ_TREE) {
806 free(data);
807 return NULL;
810 /* We need to either cache or return a throwaway copy */
812 if (available_ix < 0)
813 ent = NULL;
814 else {
815 ent = pbase_tree_cache[available_ix];
816 my_ix = available_ix;
819 if (!ent) {
820 nent = xmalloc(sizeof(*nent));
821 nent->temporary = (available_ix < 0);
823 else {
824 /* evict and reuse */
825 free(ent->tree_data);
826 nent = ent;
828 hashcpy(nent->sha1, sha1);
829 nent->tree_data = data;
830 nent->tree_size = size;
831 nent->ref = 1;
832 if (!nent->temporary)
833 pbase_tree_cache[my_ix] = nent;
834 return nent;
837 static void pbase_tree_put(struct pbase_tree_cache *cache)
839 if (!cache->temporary) {
840 cache->ref--;
841 return;
843 free(cache->tree_data);
844 free(cache);
847 static int name_cmp_len(const char *name)
849 int i;
850 for (i = 0; name[i] && name[i] != '\n' && name[i] != '/'; i++)
852 return i;
855 static void add_pbase_object(struct tree_desc *tree,
856 const char *name,
857 int cmplen,
858 const char *fullname)
860 struct name_entry entry;
861 int cmp;
863 while (tree_entry(tree,&entry)) {
864 if (S_ISGITLINK(entry.mode))
865 continue;
866 cmp = tree_entry_len(entry.path, entry.sha1) != cmplen ? 1 :
867 memcmp(name, entry.path, cmplen);
868 if (cmp > 0)
869 continue;
870 if (cmp < 0)
871 return;
872 if (name[cmplen] != '/') {
873 add_object_entry(entry.sha1,
874 object_type(entry.mode),
875 fullname, 1);
876 return;
878 if (S_ISDIR(entry.mode)) {
879 struct tree_desc sub;
880 struct pbase_tree_cache *tree;
881 const char *down = name+cmplen+1;
882 int downlen = name_cmp_len(down);
884 tree = pbase_tree_get(entry.sha1);
885 if (!tree)
886 return;
887 init_tree_desc(&sub, tree->tree_data, tree->tree_size);
889 add_pbase_object(&sub, down, downlen, fullname);
890 pbase_tree_put(tree);
895 static unsigned *done_pbase_paths;
896 static int done_pbase_paths_num;
897 static int done_pbase_paths_alloc;
898 static int done_pbase_path_pos(unsigned hash)
900 int lo = 0;
901 int hi = done_pbase_paths_num;
902 while (lo < hi) {
903 int mi = (hi + lo) / 2;
904 if (done_pbase_paths[mi] == hash)
905 return mi;
906 if (done_pbase_paths[mi] < hash)
907 hi = mi;
908 else
909 lo = mi + 1;
911 return -lo-1;
914 static int check_pbase_path(unsigned hash)
916 int pos = (!done_pbase_paths) ? -1 : done_pbase_path_pos(hash);
917 if (0 <= pos)
918 return 1;
919 pos = -pos - 1;
920 if (done_pbase_paths_alloc <= done_pbase_paths_num) {
921 done_pbase_paths_alloc = alloc_nr(done_pbase_paths_alloc);
922 done_pbase_paths = xrealloc(done_pbase_paths,
923 done_pbase_paths_alloc *
924 sizeof(unsigned));
926 done_pbase_paths_num++;
927 if (pos < done_pbase_paths_num)
928 memmove(done_pbase_paths + pos + 1,
929 done_pbase_paths + pos,
930 (done_pbase_paths_num - pos - 1) * sizeof(unsigned));
931 done_pbase_paths[pos] = hash;
932 return 0;
935 static void add_preferred_base_object(const char *name)
937 struct pbase_tree *it;
938 int cmplen;
939 unsigned hash = name_hash(name);
941 if (!num_preferred_base || check_pbase_path(hash))
942 return;
944 cmplen = name_cmp_len(name);
945 for (it = pbase_tree; it; it = it->next) {
946 if (cmplen == 0) {
947 add_object_entry(it->pcache.sha1, OBJ_TREE, NULL, 1);
949 else {
950 struct tree_desc tree;
951 init_tree_desc(&tree, it->pcache.tree_data, it->pcache.tree_size);
952 add_pbase_object(&tree, name, cmplen, name);
957 static void add_preferred_base(unsigned char *sha1)
959 struct pbase_tree *it;
960 void *data;
961 unsigned long size;
962 unsigned char tree_sha1[20];
964 if (window <= num_preferred_base++)
965 return;
967 data = read_object_with_reference(sha1, tree_type, &size, tree_sha1);
968 if (!data)
969 return;
971 for (it = pbase_tree; it; it = it->next) {
972 if (!hashcmp(it->pcache.sha1, tree_sha1)) {
973 free(data);
974 return;
978 it = xcalloc(1, sizeof(*it));
979 it->next = pbase_tree;
980 pbase_tree = it;
982 hashcpy(it->pcache.sha1, tree_sha1);
983 it->pcache.tree_data = data;
984 it->pcache.tree_size = size;
987 static void check_object(struct object_entry *entry)
989 if (entry->in_pack) {
990 struct packed_git *p = entry->in_pack;
991 struct pack_window *w_curs = NULL;
992 const unsigned char *base_ref = NULL;
993 struct object_entry *base_entry;
994 unsigned long used, used_0;
995 unsigned int avail;
996 off_t ofs;
997 unsigned char *buf, c;
999 buf = use_pack(p, &w_curs, entry->in_pack_offset, &avail);
1002 * We want in_pack_type even if we do not reuse delta
1003 * since non-delta representations could still be reused.
1005 used = unpack_object_header_buffer(buf, avail,
1006 &entry->in_pack_type,
1007 &entry->size);
1008 if (used == 0)
1009 goto give_up;
1012 * Determine if this is a delta and if so whether we can
1013 * reuse it or not. Otherwise let's find out as cheaply as
1014 * possible what the actual type and size for this object is.
1016 switch (entry->in_pack_type) {
1017 default:
1018 /* Not a delta hence we've already got all we need. */
1019 entry->type = entry->in_pack_type;
1020 entry->in_pack_header_size = used;
1021 if (entry->type < OBJ_COMMIT || entry->type > OBJ_BLOB)
1022 goto give_up;
1023 unuse_pack(&w_curs);
1024 return;
1025 case OBJ_REF_DELTA:
1026 if (reuse_delta && !entry->preferred_base)
1027 base_ref = use_pack(p, &w_curs,
1028 entry->in_pack_offset + used, NULL);
1029 entry->in_pack_header_size = used + 20;
1030 break;
1031 case OBJ_OFS_DELTA:
1032 buf = use_pack(p, &w_curs,
1033 entry->in_pack_offset + used, NULL);
1034 used_0 = 0;
1035 c = buf[used_0++];
1036 ofs = c & 127;
1037 while (c & 128) {
1038 ofs += 1;
1039 if (!ofs || MSB(ofs, 7)) {
1040 error("delta base offset overflow in pack for %s",
1041 sha1_to_hex(entry->idx.sha1));
1042 goto give_up;
1044 c = buf[used_0++];
1045 ofs = (ofs << 7) + (c & 127);
1047 ofs = entry->in_pack_offset - ofs;
1048 if (ofs <= 0 || ofs >= entry->in_pack_offset) {
1049 error("delta base offset out of bound for %s",
1050 sha1_to_hex(entry->idx.sha1));
1051 goto give_up;
1053 if (reuse_delta && !entry->preferred_base) {
1054 struct revindex_entry *revidx;
1055 revidx = find_pack_revindex(p, ofs);
1056 base_ref = nth_packed_object_sha1(p, revidx->nr);
1058 entry->in_pack_header_size = used + used_0;
1059 break;
1062 if (base_ref && (base_entry = locate_object_entry(base_ref))) {
1064 * If base_ref was set above that means we wish to
1065 * reuse delta data, and we even found that base
1066 * in the list of objects we want to pack. Goodie!
1068 * Depth value does not matter - find_deltas() will
1069 * never consider reused delta as the base object to
1070 * deltify other objects against, in order to avoid
1071 * circular deltas.
1073 entry->type = entry->in_pack_type;
1074 entry->delta = base_entry;
1075 entry->delta_sibling = base_entry->delta_child;
1076 base_entry->delta_child = entry;
1077 unuse_pack(&w_curs);
1078 return;
1081 if (entry->type) {
1083 * This must be a delta and we already know what the
1084 * final object type is. Let's extract the actual
1085 * object size from the delta header.
1087 entry->size = get_size_from_delta(p, &w_curs,
1088 entry->in_pack_offset + entry->in_pack_header_size);
1089 if (entry->size == 0)
1090 goto give_up;
1091 unuse_pack(&w_curs);
1092 return;
1096 * No choice but to fall back to the recursive delta walk
1097 * with sha1_object_info() to find about the object type
1098 * at this point...
1100 give_up:
1101 unuse_pack(&w_curs);
1104 entry->type = sha1_object_info(entry->idx.sha1, &entry->size);
1106 * The error condition is checked in prepare_pack(). This is
1107 * to permit a missing preferred base object to be ignored
1108 * as a preferred base. Doing so can result in a larger
1109 * pack file, but the transfer will still take place.
1113 static int pack_offset_sort(const void *_a, const void *_b)
1115 const struct object_entry *a = *(struct object_entry **)_a;
1116 const struct object_entry *b = *(struct object_entry **)_b;
1118 /* avoid filesystem trashing with loose objects */
1119 if (!a->in_pack && !b->in_pack)
1120 return hashcmp(a->idx.sha1, b->idx.sha1);
1122 if (a->in_pack < b->in_pack)
1123 return -1;
1124 if (a->in_pack > b->in_pack)
1125 return 1;
1126 return a->in_pack_offset < b->in_pack_offset ? -1 :
1127 (a->in_pack_offset > b->in_pack_offset);
1130 static void get_object_details(void)
1132 uint32_t i;
1133 struct object_entry **sorted_by_offset;
1135 sorted_by_offset = xcalloc(nr_objects, sizeof(struct object_entry *));
1136 for (i = 0; i < nr_objects; i++)
1137 sorted_by_offset[i] = objects + i;
1138 qsort(sorted_by_offset, nr_objects, sizeof(*sorted_by_offset), pack_offset_sort);
1140 for (i = 0; i < nr_objects; i++)
1141 check_object(sorted_by_offset[i]);
1143 free(sorted_by_offset);
1147 * We search for deltas in a list sorted by type, by filename hash, and then
1148 * by size, so that we see progressively smaller and smaller files.
1149 * That's because we prefer deltas to be from the bigger file
1150 * to the smaller -- deletes are potentially cheaper, but perhaps
1151 * more importantly, the bigger file is likely the more recent
1152 * one. The deepest deltas are therefore the oldest objects which are
1153 * less susceptible to be accessed often.
1155 static int type_size_sort(const void *_a, const void *_b)
1157 const struct object_entry *a = *(struct object_entry **)_a;
1158 const struct object_entry *b = *(struct object_entry **)_b;
1160 if (a->type > b->type)
1161 return -1;
1162 if (a->type < b->type)
1163 return 1;
1164 if (a->hash > b->hash)
1165 return -1;
1166 if (a->hash < b->hash)
1167 return 1;
1168 if (a->preferred_base > b->preferred_base)
1169 return -1;
1170 if (a->preferred_base < b->preferred_base)
1171 return 1;
1172 if (a->size > b->size)
1173 return -1;
1174 if (a->size < b->size)
1175 return 1;
1176 return a < b ? -1 : (a > b); /* newest first */
1179 struct unpacked {
1180 struct object_entry *entry;
1181 void *data;
1182 struct delta_index *index;
1183 unsigned depth;
1186 static int delta_cacheable(unsigned long src_size, unsigned long trg_size,
1187 unsigned long delta_size)
1189 if (max_delta_cache_size && delta_cache_size + delta_size > max_delta_cache_size)
1190 return 0;
1192 if (delta_size < cache_max_small_delta_size)
1193 return 1;
1195 /* cache delta, if objects are large enough compared to delta size */
1196 if ((src_size >> 20) + (trg_size >> 21) > (delta_size >> 10))
1197 return 1;
1199 return 0;
1202 #ifdef THREADED_DELTA_SEARCH
1204 static pthread_mutex_t read_mutex = PTHREAD_MUTEX_INITIALIZER;
1205 #define read_lock() pthread_mutex_lock(&read_mutex)
1206 #define read_unlock() pthread_mutex_unlock(&read_mutex)
1208 static pthread_mutex_t cache_mutex = PTHREAD_MUTEX_INITIALIZER;
1209 #define cache_lock() pthread_mutex_lock(&cache_mutex)
1210 #define cache_unlock() pthread_mutex_unlock(&cache_mutex)
1212 static pthread_mutex_t progress_mutex = PTHREAD_MUTEX_INITIALIZER;
1213 #define progress_lock() pthread_mutex_lock(&progress_mutex)
1214 #define progress_unlock() pthread_mutex_unlock(&progress_mutex)
1216 #else
1218 #define read_lock() (void)0
1219 #define read_unlock() (void)0
1220 #define cache_lock() (void)0
1221 #define cache_unlock() (void)0
1222 #define progress_lock() (void)0
1223 #define progress_unlock() (void)0
1225 #endif
1227 static int try_delta(struct unpacked *trg, struct unpacked *src,
1228 unsigned max_depth, unsigned long *mem_usage)
1230 struct object_entry *trg_entry = trg->entry;
1231 struct object_entry *src_entry = src->entry;
1232 unsigned long trg_size, src_size, delta_size, sizediff, max_size, sz;
1233 unsigned ref_depth;
1234 enum object_type type;
1235 void *delta_buf;
1237 /* Don't bother doing diffs between different types */
1238 if (trg_entry->type != src_entry->type)
1239 return -1;
1242 * We do not bother to try a delta that we discarded
1243 * on an earlier try, but only when reusing delta data.
1245 if (reuse_delta && trg_entry->in_pack &&
1246 trg_entry->in_pack == src_entry->in_pack &&
1247 trg_entry->in_pack_type != OBJ_REF_DELTA &&
1248 trg_entry->in_pack_type != OBJ_OFS_DELTA)
1249 return 0;
1251 /* Let's not bust the allowed depth. */
1252 if (src->depth >= max_depth)
1253 return 0;
1255 /* Now some size filtering heuristics. */
1256 trg_size = trg_entry->size;
1257 if (!trg_entry->delta) {
1258 max_size = trg_size/2 - 20;
1259 ref_depth = 1;
1260 } else {
1261 max_size = trg_entry->delta_size;
1262 ref_depth = trg->depth;
1264 max_size = max_size * (max_depth - src->depth) /
1265 (max_depth - ref_depth + 1);
1266 if (max_size == 0)
1267 return 0;
1268 src_size = src_entry->size;
1269 sizediff = src_size < trg_size ? trg_size - src_size : 0;
1270 if (sizediff >= max_size)
1271 return 0;
1272 if (trg_size < src_size / 32)
1273 return 0;
1275 /* Load data if not already done */
1276 if (!trg->data) {
1277 read_lock();
1278 trg->data = read_sha1_file(trg_entry->idx.sha1, &type, &sz);
1279 read_unlock();
1280 if (!trg->data)
1281 die("object %s cannot be read",
1282 sha1_to_hex(trg_entry->idx.sha1));
1283 if (sz != trg_size)
1284 die("object %s inconsistent object length (%lu vs %lu)",
1285 sha1_to_hex(trg_entry->idx.sha1), sz, trg_size);
1286 *mem_usage += sz;
1288 if (!src->data) {
1289 read_lock();
1290 src->data = read_sha1_file(src_entry->idx.sha1, &type, &sz);
1291 read_unlock();
1292 if (!src->data)
1293 die("object %s cannot be read",
1294 sha1_to_hex(src_entry->idx.sha1));
1295 if (sz != src_size)
1296 die("object %s inconsistent object length (%lu vs %lu)",
1297 sha1_to_hex(src_entry->idx.sha1), sz, src_size);
1298 *mem_usage += sz;
1300 if (!src->index) {
1301 src->index = create_delta_index(src->data, src_size);
1302 if (!src->index) {
1303 static int warned = 0;
1304 if (!warned++)
1305 warning("suboptimal pack - out of memory");
1306 return 0;
1308 *mem_usage += sizeof_delta_index(src->index);
1311 delta_buf = create_delta(src->index, trg->data, trg_size, &delta_size, max_size);
1312 if (!delta_buf)
1313 return 0;
1315 if (trg_entry->delta) {
1316 /* Prefer only shallower same-sized deltas. */
1317 if (delta_size == trg_entry->delta_size &&
1318 src->depth + 1 >= trg->depth) {
1319 free(delta_buf);
1320 return 0;
1325 * Handle memory allocation outside of the cache
1326 * accounting lock. Compiler will optimize the strangeness
1327 * away when THREADED_DELTA_SEARCH is not defined.
1329 free(trg_entry->delta_data);
1330 cache_lock();
1331 if (trg_entry->delta_data) {
1332 delta_cache_size -= trg_entry->delta_size;
1333 trg_entry->delta_data = NULL;
1335 if (delta_cacheable(src_size, trg_size, delta_size)) {
1336 delta_cache_size += delta_size;
1337 cache_unlock();
1338 trg_entry->delta_data = xrealloc(delta_buf, delta_size);
1339 } else {
1340 cache_unlock();
1341 free(delta_buf);
1344 trg_entry->delta = src_entry;
1345 trg_entry->delta_size = delta_size;
1346 trg->depth = src->depth + 1;
1348 return 1;
1351 static unsigned int check_delta_limit(struct object_entry *me, unsigned int n)
1353 struct object_entry *child = me->delta_child;
1354 unsigned int m = n;
1355 while (child) {
1356 unsigned int c = check_delta_limit(child, n + 1);
1357 if (m < c)
1358 m = c;
1359 child = child->delta_sibling;
1361 return m;
1364 static unsigned long free_unpacked(struct unpacked *n)
1366 unsigned long freed_mem = sizeof_delta_index(n->index);
1367 free_delta_index(n->index);
1368 n->index = NULL;
1369 if (n->data) {
1370 freed_mem += n->entry->size;
1371 free(n->data);
1372 n->data = NULL;
1374 n->entry = NULL;
1375 n->depth = 0;
1376 return freed_mem;
1379 static void find_deltas(struct object_entry **list, unsigned *list_size,
1380 int window, int depth, unsigned *processed)
1382 uint32_t i, idx = 0, count = 0;
1383 struct unpacked *array;
1384 unsigned long mem_usage = 0;
1386 array = xcalloc(window, sizeof(struct unpacked));
1388 for (;;) {
1389 struct object_entry *entry;
1390 struct unpacked *n = array + idx;
1391 int j, max_depth, best_base = -1;
1393 progress_lock();
1394 if (!*list_size) {
1395 progress_unlock();
1396 break;
1398 entry = *list++;
1399 (*list_size)--;
1400 if (!entry->preferred_base) {
1401 (*processed)++;
1402 display_progress(progress_state, *processed);
1404 progress_unlock();
1406 mem_usage -= free_unpacked(n);
1407 n->entry = entry;
1409 while (window_memory_limit &&
1410 mem_usage > window_memory_limit &&
1411 count > 1) {
1412 uint32_t tail = (idx + window - count) % window;
1413 mem_usage -= free_unpacked(array + tail);
1414 count--;
1417 /* We do not compute delta to *create* objects we are not
1418 * going to pack.
1420 if (entry->preferred_base)
1421 goto next;
1424 * If the current object is at pack edge, take the depth the
1425 * objects that depend on the current object into account
1426 * otherwise they would become too deep.
1428 max_depth = depth;
1429 if (entry->delta_child) {
1430 max_depth -= check_delta_limit(entry, 0);
1431 if (max_depth <= 0)
1432 goto next;
1435 j = window;
1436 while (--j > 0) {
1437 int ret;
1438 uint32_t other_idx = idx + j;
1439 struct unpacked *m;
1440 if (other_idx >= window)
1441 other_idx -= window;
1442 m = array + other_idx;
1443 if (!m->entry)
1444 break;
1445 ret = try_delta(n, m, max_depth, &mem_usage);
1446 if (ret < 0)
1447 break;
1448 else if (ret > 0)
1449 best_base = other_idx;
1453 * If we decided to cache the delta data, then it is best
1454 * to compress it right away. First because we have to do
1455 * it anyway, and doing it here while we're threaded will
1456 * save a lot of time in the non threaded write phase,
1457 * as well as allow for caching more deltas within
1458 * the same cache size limit.
1459 * ...
1460 * But only if not writing to stdout, since in that case
1461 * the network is most likely throttling writes anyway,
1462 * and therefore it is best to go to the write phase ASAP
1463 * instead, as we can afford spending more time compressing
1464 * between writes at that moment.
1466 if (entry->delta_data && !pack_to_stdout) {
1467 entry->z_delta_size = do_compress(&entry->delta_data,
1468 entry->delta_size);
1469 cache_lock();
1470 delta_cache_size -= entry->delta_size;
1471 delta_cache_size += entry->z_delta_size;
1472 cache_unlock();
1475 /* if we made n a delta, and if n is already at max
1476 * depth, leaving it in the window is pointless. we
1477 * should evict it first.
1479 if (entry->delta && max_depth <= n->depth)
1480 continue;
1483 * Move the best delta base up in the window, after the
1484 * currently deltified object, to keep it longer. It will
1485 * be the first base object to be attempted next.
1487 if (entry->delta) {
1488 struct unpacked swap = array[best_base];
1489 int dist = (window + idx - best_base) % window;
1490 int dst = best_base;
1491 while (dist--) {
1492 int src = (dst + 1) % window;
1493 array[dst] = array[src];
1494 dst = src;
1496 array[dst] = swap;
1499 next:
1500 idx++;
1501 if (count + 1 < window)
1502 count++;
1503 if (idx >= window)
1504 idx = 0;
1507 for (i = 0; i < window; ++i) {
1508 free_delta_index(array[i].index);
1509 free(array[i].data);
1511 free(array);
1514 #ifdef THREADED_DELTA_SEARCH
1517 * The main thread waits on the condition that (at least) one of the workers
1518 * has stopped working (which is indicated in the .working member of
1519 * struct thread_params).
1520 * When a work thread has completed its work, it sets .working to 0 and
1521 * signals the main thread and waits on the condition that .data_ready
1522 * becomes 1.
1525 struct thread_params {
1526 pthread_t thread;
1527 struct object_entry **list;
1528 unsigned list_size;
1529 unsigned remaining;
1530 int window;
1531 int depth;
1532 int working;
1533 int data_ready;
1534 pthread_mutex_t mutex;
1535 pthread_cond_t cond;
1536 unsigned *processed;
1539 static pthread_cond_t progress_cond = PTHREAD_COND_INITIALIZER;
1541 static void *threaded_find_deltas(void *arg)
1543 struct thread_params *me = arg;
1545 while (me->remaining) {
1546 find_deltas(me->list, &me->remaining,
1547 me->window, me->depth, me->processed);
1549 progress_lock();
1550 me->working = 0;
1551 pthread_cond_signal(&progress_cond);
1552 progress_unlock();
1555 * We must not set ->data_ready before we wait on the
1556 * condition because the main thread may have set it to 1
1557 * before we get here. In order to be sure that new
1558 * work is available if we see 1 in ->data_ready, it
1559 * was initialized to 0 before this thread was spawned
1560 * and we reset it to 0 right away.
1562 pthread_mutex_lock(&me->mutex);
1563 while (!me->data_ready)
1564 pthread_cond_wait(&me->cond, &me->mutex);
1565 me->data_ready = 0;
1566 pthread_mutex_unlock(&me->mutex);
1568 /* leave ->working 1 so that this doesn't get more work assigned */
1569 return NULL;
1572 static void ll_find_deltas(struct object_entry **list, unsigned list_size,
1573 int window, int depth, unsigned *processed)
1575 struct thread_params p[delta_search_threads];
1576 int i, ret, active_threads = 0;
1578 if (delta_search_threads <= 1) {
1579 find_deltas(list, &list_size, window, depth, processed);
1580 return;
1583 /* Partition the work amongst work threads. */
1584 for (i = 0; i < delta_search_threads; i++) {
1585 unsigned sub_size = list_size / (delta_search_threads - i);
1587 p[i].window = window;
1588 p[i].depth = depth;
1589 p[i].processed = processed;
1590 p[i].working = 1;
1591 p[i].data_ready = 0;
1593 /* try to split chunks on "path" boundaries */
1594 while (sub_size && sub_size < list_size &&
1595 list[sub_size]->hash &&
1596 list[sub_size]->hash == list[sub_size-1]->hash)
1597 sub_size++;
1599 p[i].list = list;
1600 p[i].list_size = sub_size;
1601 p[i].remaining = sub_size;
1603 list += sub_size;
1604 list_size -= sub_size;
1607 /* Start work threads. */
1608 for (i = 0; i < delta_search_threads; i++) {
1609 if (!p[i].list_size)
1610 continue;
1611 pthread_mutex_init(&p[i].mutex, NULL);
1612 pthread_cond_init(&p[i].cond, NULL);
1613 ret = pthread_create(&p[i].thread, NULL,
1614 threaded_find_deltas, &p[i]);
1615 if (ret)
1616 die("unable to create thread: %s", strerror(ret));
1617 active_threads++;
1621 * Now let's wait for work completion. Each time a thread is done
1622 * with its work, we steal half of the remaining work from the
1623 * thread with the largest number of unprocessed objects and give
1624 * it to that newly idle thread. This ensure good load balancing
1625 * until the remaining object list segments are simply too short
1626 * to be worth splitting anymore.
1628 while (active_threads) {
1629 struct thread_params *target = NULL;
1630 struct thread_params *victim = NULL;
1631 unsigned sub_size = 0;
1633 progress_lock();
1634 for (;;) {
1635 for (i = 0; !target && i < delta_search_threads; i++)
1636 if (!p[i].working)
1637 target = &p[i];
1638 if (target)
1639 break;
1640 pthread_cond_wait(&progress_cond, &progress_mutex);
1643 for (i = 0; i < delta_search_threads; i++)
1644 if (p[i].remaining > 2*window &&
1645 (!victim || victim->remaining < p[i].remaining))
1646 victim = &p[i];
1647 if (victim) {
1648 sub_size = victim->remaining / 2;
1649 list = victim->list + victim->list_size - sub_size;
1650 while (sub_size && list[0]->hash &&
1651 list[0]->hash == list[-1]->hash) {
1652 list++;
1653 sub_size--;
1655 if (!sub_size) {
1657 * It is possible for some "paths" to have
1658 * so many objects that no hash boundary
1659 * might be found. Let's just steal the
1660 * exact half in that case.
1662 sub_size = victim->remaining / 2;
1663 list -= sub_size;
1665 target->list = list;
1666 victim->list_size -= sub_size;
1667 victim->remaining -= sub_size;
1669 target->list_size = sub_size;
1670 target->remaining = sub_size;
1671 target->working = 1;
1672 progress_unlock();
1674 pthread_mutex_lock(&target->mutex);
1675 target->data_ready = 1;
1676 pthread_cond_signal(&target->cond);
1677 pthread_mutex_unlock(&target->mutex);
1679 if (!sub_size) {
1680 pthread_join(target->thread, NULL);
1681 pthread_cond_destroy(&target->cond);
1682 pthread_mutex_destroy(&target->mutex);
1683 active_threads--;
1688 #else
1689 #define ll_find_deltas(l, s, w, d, p) find_deltas(l, &s, w, d, p)
1690 #endif
1692 static int add_ref_tag(const char *path, const unsigned char *sha1, int flag, void *cb_data)
1694 unsigned char peeled[20];
1696 if (!prefixcmp(path, "refs/tags/") && /* is a tag? */
1697 !peel_ref(path, peeled) && /* peelable? */
1698 !is_null_sha1(peeled) && /* annotated tag? */
1699 locate_object_entry(peeled)) /* object packed? */
1700 add_object_entry(sha1, OBJ_TAG, NULL, 0);
1701 return 0;
1704 static void prepare_pack(int window, int depth)
1706 struct object_entry **delta_list;
1707 uint32_t i, nr_deltas;
1708 unsigned n;
1710 get_object_details();
1713 * If we're locally repacking then we need to be doubly careful
1714 * from now on in order to make sure no stealth corruption gets
1715 * propagated to the new pack. Clients receiving streamed packs
1716 * should validate everything they get anyway so no need to incur
1717 * the additional cost here in that case.
1719 if (!pack_to_stdout)
1720 do_check_packed_object_crc = 1;
1722 if (!nr_objects || !window || !depth)
1723 return;
1725 delta_list = xmalloc(nr_objects * sizeof(*delta_list));
1726 nr_deltas = n = 0;
1728 for (i = 0; i < nr_objects; i++) {
1729 struct object_entry *entry = objects + i;
1731 if (entry->delta)
1732 /* This happens if we decided to reuse existing
1733 * delta from a pack. "reuse_delta &&" is implied.
1735 continue;
1737 if (entry->size < 50)
1738 continue;
1740 if (entry->no_try_delta)
1741 continue;
1743 if (!entry->preferred_base) {
1744 nr_deltas++;
1745 if (entry->type < 0)
1746 die("unable to get type of object %s",
1747 sha1_to_hex(entry->idx.sha1));
1748 } else {
1749 if (entry->type < 0) {
1751 * This object is not found, but we
1752 * don't have to include it anyway.
1754 continue;
1758 delta_list[n++] = entry;
1761 if (nr_deltas && n > 1) {
1762 unsigned nr_done = 0;
1763 if (progress)
1764 progress_state = start_progress("Compressing objects",
1765 nr_deltas);
1766 qsort(delta_list, n, sizeof(*delta_list), type_size_sort);
1767 ll_find_deltas(delta_list, n, window+1, depth, &nr_done);
1768 stop_progress(&progress_state);
1769 if (nr_done != nr_deltas)
1770 die("inconsistency with delta count");
1772 free(delta_list);
1775 static int git_pack_config(const char *k, const char *v, void *cb)
1777 if(!strcmp(k, "pack.window")) {
1778 window = git_config_int(k, v);
1779 return 0;
1781 if (!strcmp(k, "pack.windowmemory")) {
1782 window_memory_limit = git_config_ulong(k, v);
1783 return 0;
1785 if (!strcmp(k, "pack.depth")) {
1786 depth = git_config_int(k, v);
1787 return 0;
1789 if (!strcmp(k, "pack.compression")) {
1790 int level = git_config_int(k, v);
1791 if (level == -1)
1792 level = Z_DEFAULT_COMPRESSION;
1793 else if (level < 0 || level > Z_BEST_COMPRESSION)
1794 die("bad pack compression level %d", level);
1795 pack_compression_level = level;
1796 pack_compression_seen = 1;
1797 return 0;
1799 if (!strcmp(k, "pack.deltacachesize")) {
1800 max_delta_cache_size = git_config_int(k, v);
1801 return 0;
1803 if (!strcmp(k, "pack.deltacachelimit")) {
1804 cache_max_small_delta_size = git_config_int(k, v);
1805 return 0;
1807 if (!strcmp(k, "pack.threads")) {
1808 delta_search_threads = git_config_int(k, v);
1809 if (delta_search_threads < 0)
1810 die("invalid number of threads specified (%d)",
1811 delta_search_threads);
1812 #ifndef THREADED_DELTA_SEARCH
1813 if (delta_search_threads != 1)
1814 warning("no threads support, ignoring %s", k);
1815 #endif
1816 return 0;
1818 if (!strcmp(k, "pack.indexversion")) {
1819 pack_idx_default_version = git_config_int(k, v);
1820 if (pack_idx_default_version > 2)
1821 die("bad pack.indexversion=%"PRIu32,
1822 pack_idx_default_version);
1823 return 0;
1825 if (!strcmp(k, "pack.packsizelimit")) {
1826 pack_size_limit_cfg = git_config_ulong(k, v);
1827 return 0;
1829 return git_default_config(k, v, cb);
1832 static void read_object_list_from_stdin(void)
1834 char line[40 + 1 + PATH_MAX + 2];
1835 unsigned char sha1[20];
1837 for (;;) {
1838 if (!fgets(line, sizeof(line), stdin)) {
1839 if (feof(stdin))
1840 break;
1841 if (!ferror(stdin))
1842 die("fgets returned NULL, not EOF, not error!");
1843 if (errno != EINTR)
1844 die("fgets: %s", strerror(errno));
1845 clearerr(stdin);
1846 continue;
1848 if (line[0] == '-') {
1849 if (get_sha1_hex(line+1, sha1))
1850 die("expected edge sha1, got garbage:\n %s",
1851 line);
1852 add_preferred_base(sha1);
1853 continue;
1855 if (get_sha1_hex(line, sha1))
1856 die("expected sha1, got garbage:\n %s", line);
1858 add_preferred_base_object(line+41);
1859 add_object_entry(sha1, 0, line+41, 0);
1863 #define OBJECT_ADDED (1u<<20)
1865 static void show_commit(struct commit *commit)
1867 add_object_entry(commit->object.sha1, OBJ_COMMIT, NULL, 0);
1868 commit->object.flags |= OBJECT_ADDED;
1871 static void show_object(struct object_array_entry *p)
1873 add_preferred_base_object(p->name);
1874 add_object_entry(p->item->sha1, p->item->type, p->name, 0);
1875 p->item->flags |= OBJECT_ADDED;
1878 static void show_edge(struct commit *commit)
1880 add_preferred_base(commit->object.sha1);
1883 struct in_pack_object {
1884 off_t offset;
1885 struct object *object;
1888 struct in_pack {
1889 int alloc;
1890 int nr;
1891 struct in_pack_object *array;
1894 static void mark_in_pack_object(struct object *object, struct packed_git *p, struct in_pack *in_pack)
1896 in_pack->array[in_pack->nr].offset = find_pack_entry_one(object->sha1, p);
1897 in_pack->array[in_pack->nr].object = object;
1898 in_pack->nr++;
1902 * Compare the objects in the offset order, in order to emulate the
1903 * "git rev-list --objects" output that produced the pack originally.
1905 static int ofscmp(const void *a_, const void *b_)
1907 struct in_pack_object *a = (struct in_pack_object *)a_;
1908 struct in_pack_object *b = (struct in_pack_object *)b_;
1910 if (a->offset < b->offset)
1911 return -1;
1912 else if (a->offset > b->offset)
1913 return 1;
1914 else
1915 return hashcmp(a->object->sha1, b->object->sha1);
1918 static void add_objects_in_unpacked_packs(struct rev_info *revs)
1920 struct packed_git *p;
1921 struct in_pack in_pack;
1922 uint32_t i;
1924 memset(&in_pack, 0, sizeof(in_pack));
1926 for (p = packed_git; p; p = p->next) {
1927 const unsigned char *sha1;
1928 struct object *o;
1930 for (i = 0; i < revs->num_ignore_packed; i++) {
1931 if (matches_pack_name(p, revs->ignore_packed[i]))
1932 break;
1934 if (revs->num_ignore_packed <= i)
1935 continue;
1936 if (open_pack_index(p))
1937 die("cannot open pack index");
1939 ALLOC_GROW(in_pack.array,
1940 in_pack.nr + p->num_objects,
1941 in_pack.alloc);
1943 for (i = 0; i < p->num_objects; i++) {
1944 sha1 = nth_packed_object_sha1(p, i);
1945 o = lookup_unknown_object(sha1);
1946 if (!(o->flags & OBJECT_ADDED))
1947 mark_in_pack_object(o, p, &in_pack);
1948 o->flags |= OBJECT_ADDED;
1952 if (in_pack.nr) {
1953 qsort(in_pack.array, in_pack.nr, sizeof(in_pack.array[0]),
1954 ofscmp);
1955 for (i = 0; i < in_pack.nr; i++) {
1956 struct object *o = in_pack.array[i].object;
1957 add_object_entry(o->sha1, o->type, "", 0);
1960 free(in_pack.array);
1963 static void loosen_unused_packed_objects(struct rev_info *revs)
1965 struct packed_git *p;
1966 uint32_t i;
1967 const unsigned char *sha1;
1969 for (p = packed_git; p; p = p->next) {
1970 for (i = 0; i < revs->num_ignore_packed; i++) {
1971 if (matches_pack_name(p, revs->ignore_packed[i]))
1972 break;
1974 if (revs->num_ignore_packed <= i)
1975 continue;
1977 if (open_pack_index(p))
1978 die("cannot open pack index");
1980 for (i = 0; i < p->num_objects; i++) {
1981 sha1 = nth_packed_object_sha1(p, i);
1982 if (!locate_object_entry(sha1))
1983 if (force_object_loose(sha1, p->mtime))
1984 die("unable to force loose object");
1989 static void get_object_list(int ac, const char **av)
1991 struct rev_info revs;
1992 char line[1000];
1993 int flags = 0;
1995 init_revisions(&revs, NULL);
1996 save_commit_buffer = 0;
1997 setup_revisions(ac, av, &revs, NULL);
1999 while (fgets(line, sizeof(line), stdin) != NULL) {
2000 int len = strlen(line);
2001 if (len && line[len - 1] == '\n')
2002 line[--len] = 0;
2003 if (!len)
2004 break;
2005 if (*line == '-') {
2006 if (!strcmp(line, "--not")) {
2007 flags ^= UNINTERESTING;
2008 continue;
2010 die("not a rev '%s'", line);
2012 if (handle_revision_arg(line, &revs, flags, 1))
2013 die("bad revision '%s'", line);
2016 if (prepare_revision_walk(&revs))
2017 die("revision walk setup failed");
2018 mark_edges_uninteresting(revs.commits, &revs, show_edge);
2019 traverse_commit_list(&revs, show_commit, show_object);
2021 if (keep_unreachable)
2022 add_objects_in_unpacked_packs(&revs);
2023 if (unpack_unreachable)
2024 loosen_unused_packed_objects(&revs);
2027 static int adjust_perm(const char *path, mode_t mode)
2029 if (chmod(path, mode))
2030 return -1;
2031 return adjust_shared_perm(path);
2034 int cmd_pack_objects(int argc, const char **argv, const char *prefix)
2036 int use_internal_rev_list = 0;
2037 int thin = 0;
2038 uint32_t i;
2039 const char **rp_av;
2040 int rp_ac_alloc = 64;
2041 int rp_ac;
2043 rp_av = xcalloc(rp_ac_alloc, sizeof(*rp_av));
2045 rp_av[0] = "pack-objects";
2046 rp_av[1] = "--objects"; /* --thin will make it --objects-edge */
2047 rp_ac = 2;
2049 git_config(git_pack_config, NULL);
2050 if (!pack_compression_seen && core_compression_seen)
2051 pack_compression_level = core_compression_level;
2053 progress = isatty(2);
2054 for (i = 1; i < argc; i++) {
2055 const char *arg = argv[i];
2057 if (*arg != '-')
2058 break;
2060 if (!strcmp("--non-empty", arg)) {
2061 non_empty = 1;
2062 continue;
2064 if (!strcmp("--local", arg)) {
2065 local = 1;
2066 continue;
2068 if (!strcmp("--incremental", arg)) {
2069 incremental = 1;
2070 continue;
2072 if (!prefixcmp(arg, "--compression=")) {
2073 char *end;
2074 int level = strtoul(arg+14, &end, 0);
2075 if (!arg[14] || *end)
2076 usage(pack_usage);
2077 if (level == -1)
2078 level = Z_DEFAULT_COMPRESSION;
2079 else if (level < 0 || level > Z_BEST_COMPRESSION)
2080 die("bad pack compression level %d", level);
2081 pack_compression_level = level;
2082 continue;
2084 if (!prefixcmp(arg, "--max-pack-size=")) {
2085 char *end;
2086 pack_size_limit_cfg = 0;
2087 pack_size_limit = strtoul(arg+16, &end, 0) * 1024 * 1024;
2088 if (!arg[16] || *end)
2089 usage(pack_usage);
2090 continue;
2092 if (!prefixcmp(arg, "--window=")) {
2093 char *end;
2094 window = strtoul(arg+9, &end, 0);
2095 if (!arg[9] || *end)
2096 usage(pack_usage);
2097 continue;
2099 if (!prefixcmp(arg, "--window-memory=")) {
2100 if (!git_parse_ulong(arg+16, &window_memory_limit))
2101 usage(pack_usage);
2102 continue;
2104 if (!prefixcmp(arg, "--threads=")) {
2105 char *end;
2106 delta_search_threads = strtoul(arg+10, &end, 0);
2107 if (!arg[10] || *end || delta_search_threads < 0)
2108 usage(pack_usage);
2109 #ifndef THREADED_DELTA_SEARCH
2110 if (delta_search_threads != 1)
2111 warning("no threads support, "
2112 "ignoring %s", arg);
2113 #endif
2114 continue;
2116 if (!prefixcmp(arg, "--depth=")) {
2117 char *end;
2118 depth = strtoul(arg+8, &end, 0);
2119 if (!arg[8] || *end)
2120 usage(pack_usage);
2121 continue;
2123 if (!strcmp("--progress", arg)) {
2124 progress = 1;
2125 continue;
2127 if (!strcmp("--all-progress", arg)) {
2128 progress = 2;
2129 continue;
2131 if (!strcmp("-q", arg)) {
2132 progress = 0;
2133 continue;
2135 if (!strcmp("--no-reuse-delta", arg)) {
2136 reuse_delta = 0;
2137 continue;
2139 if (!strcmp("--no-reuse-object", arg)) {
2140 reuse_object = reuse_delta = 0;
2141 continue;
2143 if (!strcmp("--delta-base-offset", arg)) {
2144 allow_ofs_delta = 1;
2145 continue;
2147 if (!strcmp("--stdout", arg)) {
2148 pack_to_stdout = 1;
2149 continue;
2151 if (!strcmp("--revs", arg)) {
2152 use_internal_rev_list = 1;
2153 continue;
2155 if (!strcmp("--keep-unreachable", arg)) {
2156 keep_unreachable = 1;
2157 continue;
2159 if (!strcmp("--unpack-unreachable", arg)) {
2160 unpack_unreachable = 1;
2161 continue;
2163 if (!strcmp("--include-tag", arg)) {
2164 include_tag = 1;
2165 continue;
2167 if (!strcmp("--unpacked", arg) ||
2168 !prefixcmp(arg, "--unpacked=") ||
2169 !strcmp("--reflog", arg) ||
2170 !strcmp("--all", arg)) {
2171 use_internal_rev_list = 1;
2172 if (rp_ac >= rp_ac_alloc - 1) {
2173 rp_ac_alloc = alloc_nr(rp_ac_alloc);
2174 rp_av = xrealloc(rp_av,
2175 rp_ac_alloc * sizeof(*rp_av));
2177 rp_av[rp_ac++] = arg;
2178 continue;
2180 if (!strcmp("--thin", arg)) {
2181 use_internal_rev_list = 1;
2182 thin = 1;
2183 rp_av[1] = "--objects-edge";
2184 continue;
2186 if (!prefixcmp(arg, "--index-version=")) {
2187 char *c;
2188 pack_idx_default_version = strtoul(arg + 16, &c, 10);
2189 if (pack_idx_default_version > 2)
2190 die("bad %s", arg);
2191 if (*c == ',')
2192 pack_idx_off32_limit = strtoul(c+1, &c, 0);
2193 if (*c || pack_idx_off32_limit & 0x80000000)
2194 die("bad %s", arg);
2195 continue;
2197 usage(pack_usage);
2200 /* Traditionally "pack-objects [options] base extra" failed;
2201 * we would however want to take refs parameter that would
2202 * have been given to upstream rev-list ourselves, which means
2203 * we somehow want to say what the base name is. So the
2204 * syntax would be:
2206 * pack-objects [options] base <refs...>
2208 * in other words, we would treat the first non-option as the
2209 * base_name and send everything else to the internal revision
2210 * walker.
2213 if (!pack_to_stdout)
2214 base_name = argv[i++];
2216 if (pack_to_stdout != !base_name)
2217 usage(pack_usage);
2219 if (!pack_to_stdout && !pack_size_limit)
2220 pack_size_limit = pack_size_limit_cfg;
2222 if (pack_to_stdout && pack_size_limit)
2223 die("--max-pack-size cannot be used to build a pack for transfer.");
2225 if (!pack_to_stdout && thin)
2226 die("--thin cannot be used to build an indexable pack.");
2228 if (keep_unreachable && unpack_unreachable)
2229 die("--keep-unreachable and --unpack-unreachable are incompatible.");
2231 #ifdef THREADED_DELTA_SEARCH
2232 if (!delta_search_threads) /* --threads=0 means autodetect */
2233 delta_search_threads = online_cpus();
2234 #endif
2236 prepare_packed_git();
2238 if (progress)
2239 progress_state = start_progress("Counting objects", 0);
2240 if (!use_internal_rev_list)
2241 read_object_list_from_stdin();
2242 else {
2243 rp_av[rp_ac] = NULL;
2244 get_object_list(rp_ac, rp_av);
2246 if (include_tag && nr_result)
2247 for_each_ref(add_ref_tag, NULL);
2248 stop_progress(&progress_state);
2250 if (non_empty && !nr_result)
2251 return 0;
2252 if (nr_result)
2253 prepare_pack(window, depth);
2254 write_pack_file();
2255 if (progress)
2256 fprintf(stderr, "Total %"PRIu32" (delta %"PRIu32"),"
2257 " reused %"PRIu32" (delta %"PRIu32")\n",
2258 written, written_delta, reused, reused_delta);
2259 return 0;