10 static const char index_pack_usage[] =
11 "git-index-pack [-v] [-o <index-file>] [{ ---keep | --keep=<msg> }] { <pack-file> | --stdin [--fix-thin] [<pack-file>] }";
17 unsigned int hdr_size;
18 enum object_type type;
19 enum object_type real_type;
20 unsigned char sha1[20];
24 unsigned char sha1[20];
29 * Even if sizeof(union delta_base) == 24 on 64-bit archs, we really want
30 * to memcmp() only the first 20 bytes.
32 #define UNION_BASE_SZ 20
36 union delta_base base;
40 static struct object_entry *objects;
41 static struct delta_entry *deltas;
42 static int nr_objects;
44 static int nr_resolved_deltas;
46 static int from_stdin;
49 static volatile sig_atomic_t progress_update;
51 static void progress_interval(int signum)
56 static void setup_progress_signal(void)
61 memset(&sa, 0, sizeof(sa));
62 sa.sa_handler = progress_interval;
63 sigemptyset(&sa.sa_mask);
64 sa.sa_flags = SA_RESTART;
65 sigaction(SIGALRM, &sa, NULL);
67 v.it_interval.tv_sec = 1;
68 v.it_interval.tv_usec = 0;
69 v.it_value = v.it_interval;
70 setitimer(ITIMER_REAL, &v, NULL);
74 static unsigned display_progress(unsigned n, unsigned total, unsigned last_pc)
76 unsigned percent = n * 100 / total;
77 if (percent != last_pc || progress_update) {
78 fprintf(stderr, "%4u%% (%u/%u) done\r", percent, n, total);
84 /* We always read in 4kB chunks. */
85 static unsigned char input_buffer[4096];
86 static unsigned long input_offset, input_len, consumed_bytes;
87 static SHA_CTX input_ctx;
88 static int input_fd, output_fd, pack_fd;
90 /* Discard current buffer used content. */
91 static void flush(void)
95 write_or_die(output_fd, input_buffer, input_offset);
96 SHA1_Update(&input_ctx, input_buffer, input_offset);
97 memmove(input_buffer, input_buffer + input_offset, input_len);
103 * Make sure at least "min" bytes are available in the buffer, and
104 * return the pointer to the buffer.
106 static void *fill(int min)
108 if (min <= input_len)
109 return input_buffer + input_offset;
110 if (min > sizeof(input_buffer))
111 die("cannot fill %d bytes", min);
114 int ret = xread(input_fd, input_buffer + input_len,
115 sizeof(input_buffer) - input_len);
119 die("read error on input: %s", strerror(errno));
122 } while (input_len < min);
126 static void use(int bytes)
128 if (bytes > input_len)
129 die("used more bytes than were available");
131 input_offset += bytes;
132 consumed_bytes += bytes;
135 static const char *open_pack_file(const char *pack_name)
140 static char tmpfile[PATH_MAX];
141 snprintf(tmpfile, sizeof(tmpfile),
142 "%s/pack_XXXXXX", get_object_directory());
143 output_fd = mkstemp(tmpfile);
144 pack_name = xstrdup(tmpfile);
146 output_fd = open(pack_name, O_CREAT|O_EXCL|O_RDWR, 0600);
148 die("unable to create %s: %s\n", pack_name, strerror(errno));
151 input_fd = open(pack_name, O_RDONLY);
153 die("cannot open packfile '%s': %s",
154 pack_name, strerror(errno));
158 SHA1_Init(&input_ctx);
162 static void parse_pack_header(void)
164 struct pack_header *hdr = fill(sizeof(struct pack_header));
166 /* Header consistency check */
167 if (hdr->hdr_signature != htonl(PACK_SIGNATURE))
168 die("pack signature mismatch");
169 if (!pack_version_ok(hdr->hdr_version))
170 die("pack version %d unsupported", ntohl(hdr->hdr_version));
172 nr_objects = ntohl(hdr->hdr_entries);
173 use(sizeof(struct pack_header));
176 static void bad_object(unsigned long offset, const char *format,
177 ...) NORETURN __attribute__((format (printf, 2, 3)));
179 static void bad_object(unsigned long offset, const char *format, ...)
184 va_start(params, format);
185 vsnprintf(buf, sizeof(buf), format, params);
187 die("pack has bad object at offset %lu: %s", offset, buf);
190 static void *unpack_entry_data(unsigned long offset, unsigned long size)
193 void *buf = xmalloc(size);
195 memset(&stream, 0, sizeof(stream));
196 stream.next_out = buf;
197 stream.avail_out = size;
198 stream.next_in = fill(1);
199 stream.avail_in = input_len;
200 inflateInit(&stream);
203 int ret = inflate(&stream, 0);
204 use(input_len - stream.avail_in);
205 if (stream.total_out == size && ret == Z_STREAM_END)
208 bad_object(offset, "inflate returned %d", ret);
209 stream.next_in = fill(1);
210 stream.avail_in = input_len;
216 static void *unpack_raw_entry(struct object_entry *obj, union delta_base *delta_base)
219 unsigned long size, base_offset;
222 obj->offset = consumed_bytes;
227 obj->type = (c >> 4) & 7;
234 size += (c & 0x7fUL) << shift;
241 hashcpy(delta_base->sha1, fill(20));
245 memset(delta_base, 0, sizeof(*delta_base));
249 base_offset = c & 127;
252 if (!base_offset || base_offset & ~(~0UL >> 7))
253 bad_object(obj->offset, "offset value overflow for delta base object");
257 base_offset = (base_offset << 7) + (c & 127);
259 delta_base->offset = obj->offset - base_offset;
260 if (delta_base->offset >= obj->offset)
261 bad_object(obj->offset, "delta base offset is out of bound");
269 bad_object(obj->offset, "unknown object type %d", obj->type);
271 obj->hdr_size = consumed_bytes - obj->offset;
273 return unpack_entry_data(obj->offset, obj->size);
276 static void *get_data_from_pack(struct object_entry *obj)
278 unsigned long from = obj[0].offset + obj[0].hdr_size;
279 unsigned long len = obj[1].offset - from;
280 unsigned long rdy = 0;
281 unsigned char *src, *data;
288 ssize_t n = pread(pack_fd, data + rdy, len - rdy, from + rdy);
290 die("cannot pread pack file: %s", strerror(errno));
293 data = xmalloc(obj->size);
294 memset(&stream, 0, sizeof(stream));
295 stream.next_out = data;
296 stream.avail_out = obj->size;
297 stream.next_in = src;
298 stream.avail_in = len;
299 inflateInit(&stream);
300 while ((st = inflate(&stream, Z_FINISH)) == Z_OK);
302 if (st != Z_STREAM_END || stream.total_out != obj->size)
303 die("serious inflate inconsistency");
308 static int find_delta(const union delta_base *base)
310 int first = 0, last = nr_deltas;
312 while (first < last) {
313 int next = (first + last) / 2;
314 struct delta_entry *delta = &deltas[next];
317 cmp = memcmp(base, &delta->base, UNION_BASE_SZ);
329 static int find_delta_children(const union delta_base *base,
330 int *first_index, int *last_index)
332 int first = find_delta(base);
334 int end = nr_deltas - 1;
338 while (first > 0 && !memcmp(&deltas[first - 1].base, base, UNION_BASE_SZ))
340 while (last < end && !memcmp(&deltas[last + 1].base, base, UNION_BASE_SZ))
342 *first_index = first;
347 static void sha1_object(const void *data, unsigned long size,
348 enum object_type type, unsigned char *sha1)
353 const char *type_str;
356 case OBJ_COMMIT: type_str = commit_type; break;
357 case OBJ_TREE: type_str = tree_type; break;
358 case OBJ_BLOB: type_str = blob_type; break;
359 case OBJ_TAG: type_str = tag_type; break;
361 die("bad type %d", type);
364 header_size = sprintf(header, "%s %lu", type_str, size) + 1;
367 SHA1_Update(&ctx, header, header_size);
368 SHA1_Update(&ctx, data, size);
369 SHA1_Final(sha1, &ctx);
372 static void resolve_delta(struct object_entry *delta_obj, void *base_data,
373 unsigned long base_size, enum object_type type)
376 unsigned long delta_size;
378 unsigned long result_size;
379 union delta_base delta_base;
382 delta_obj->real_type = type;
383 delta_data = get_data_from_pack(delta_obj);
384 delta_size = delta_obj->size;
385 result = patch_delta(base_data, base_size, delta_data, delta_size,
389 bad_object(delta_obj->offset, "failed to apply delta");
390 sha1_object(result, result_size, type, delta_obj->sha1);
391 nr_resolved_deltas++;
393 hashcpy(delta_base.sha1, delta_obj->sha1);
394 if (!find_delta_children(&delta_base, &first, &last)) {
395 for (j = first; j <= last; j++) {
396 struct object_entry *child = objects + deltas[j].obj_no;
397 if (child->real_type == OBJ_REF_DELTA)
398 resolve_delta(child, result, result_size, type);
402 memset(&delta_base, 0, sizeof(delta_base));
403 delta_base.offset = delta_obj->offset;
404 if (!find_delta_children(&delta_base, &first, &last)) {
405 for (j = first; j <= last; j++) {
406 struct object_entry *child = objects + deltas[j].obj_no;
407 if (child->real_type == OBJ_OFS_DELTA)
408 resolve_delta(child, result, result_size, type);
415 static int compare_delta_entry(const void *a, const void *b)
417 const struct delta_entry *delta_a = a;
418 const struct delta_entry *delta_b = b;
419 return memcmp(&delta_a->base, &delta_b->base, UNION_BASE_SZ);
422 /* Parse all objects and return the pack content SHA1 hash */
423 static void parse_pack_objects(unsigned char *sha1)
426 struct delta_entry *delta = deltas;
432 * - find locations of all objects;
433 * - calculate SHA1 of all non-delta objects;
434 * - remember base (SHA1 or offset) for all deltas.
437 fprintf(stderr, "Indexing %d objects.\n", nr_objects);
438 for (i = 0; i < nr_objects; i++) {
439 struct object_entry *obj = &objects[i];
440 data = unpack_raw_entry(obj, &delta->base);
441 obj->real_type = obj->type;
442 if (obj->type == OBJ_REF_DELTA || obj->type == OBJ_OFS_DELTA) {
447 sha1_object(data, obj->size, obj->type, obj->sha1);
450 percent = display_progress(i+1, nr_objects, percent);
452 objects[i].offset = consumed_bytes;
456 /* Check pack integrity */
458 SHA1_Final(sha1, &input_ctx);
459 if (hashcmp(fill(20), sha1))
460 die("pack is corrupted (SHA1 mismatch)");
463 /* If input_fd is a file, we should have reached its end now. */
464 if (fstat(input_fd, &st))
465 die("cannot fstat packfile: %s", strerror(errno));
466 if (S_ISREG(st.st_mode) && st.st_size != consumed_bytes)
467 die("pack has junk at the end");
472 /* Sort deltas by base SHA1/offset for fast searching */
473 qsort(deltas, nr_deltas, sizeof(struct delta_entry),
474 compare_delta_entry);
478 * - for all non-delta objects, look if it is used as a base for
480 * - if used as a base, uncompress the object and apply all deltas,
481 * recursively checking if the resulting object is used as a base
482 * for some more deltas.
485 fprintf(stderr, "Resolving %d deltas.\n", nr_deltas);
486 for (i = 0; i < nr_objects; i++) {
487 struct object_entry *obj = &objects[i];
488 union delta_base base;
489 int j, ref, ref_first, ref_last, ofs, ofs_first, ofs_last;
491 if (obj->type == OBJ_REF_DELTA || obj->type == OBJ_OFS_DELTA)
493 hashcpy(base.sha1, obj->sha1);
494 ref = !find_delta_children(&base, &ref_first, &ref_last);
495 memset(&base, 0, sizeof(base));
496 base.offset = obj->offset;
497 ofs = !find_delta_children(&base, &ofs_first, &ofs_last);
500 data = get_data_from_pack(obj);
502 for (j = ref_first; j <= ref_last; j++) {
503 struct object_entry *child = objects + deltas[j].obj_no;
504 if (child->real_type == OBJ_REF_DELTA)
505 resolve_delta(child, data,
506 obj->size, obj->type);
509 for (j = ofs_first; j <= ofs_last; j++) {
510 struct object_entry *child = objects + deltas[j].obj_no;
511 if (child->real_type == OBJ_OFS_DELTA)
512 resolve_delta(child, data,
513 obj->size, obj->type);
517 percent = display_progress(nr_resolved_deltas,
520 if (verbose && nr_resolved_deltas == nr_deltas)
524 static int write_compressed(int fd, void *in, unsigned int size)
527 unsigned long maxsize;
530 memset(&stream, 0, sizeof(stream));
531 deflateInit(&stream, zlib_compression_level);
532 maxsize = deflateBound(&stream, size);
533 out = xmalloc(maxsize);
537 stream.avail_in = size;
538 stream.next_out = out;
539 stream.avail_out = maxsize;
540 while (deflate(&stream, Z_FINISH) == Z_OK);
543 size = stream.total_out;
544 write_or_die(fd, out, size);
549 static void append_obj_to_pack(void *buf,
550 unsigned long size, enum object_type type)
552 struct object_entry *obj = &objects[nr_objects++];
553 unsigned char header[10];
554 unsigned long s = size;
556 unsigned char c = (type << 4) | (s & 15);
559 header[n++] = c | 0x80;
564 write_or_die(output_fd, header, n);
565 obj[1].offset = obj[0].offset + n;
566 obj[1].offset += write_compressed(output_fd, buf, size);
567 sha1_object(buf, size, type, obj->sha1);
570 static int delta_pos_compare(const void *_a, const void *_b)
572 struct delta_entry *a = *(struct delta_entry **)_a;
573 struct delta_entry *b = *(struct delta_entry **)_b;
574 return a->obj_no - b->obj_no;
577 static void fix_unresolved_deltas(int nr_unresolved)
579 struct delta_entry **sorted_by_pos;
580 int i, n = 0, percent = -1;
583 * Since many unresolved deltas may well be themselves base objects
584 * for more unresolved deltas, we really want to include the
585 * smallest number of base objects that would cover as much delta
586 * as possible by picking the
587 * trunc deltas first, allowing for other deltas to resolve without
588 * additional base objects. Since most base objects are to be found
589 * before deltas depending on them, a good heuristic is to start
590 * resolving deltas in the same order as their position in the pack.
592 sorted_by_pos = xmalloc(nr_unresolved * sizeof(*sorted_by_pos));
593 for (i = 0; i < nr_deltas; i++) {
594 if (objects[deltas[i].obj_no].real_type != OBJ_REF_DELTA)
596 sorted_by_pos[n++] = &deltas[i];
598 qsort(sorted_by_pos, n, sizeof(*sorted_by_pos), delta_pos_compare);
600 for (i = 0; i < n; i++) {
601 struct delta_entry *d = sorted_by_pos[i];
605 enum object_type obj_type;
608 if (objects[d->obj_no].real_type != OBJ_REF_DELTA)
610 data = read_sha1_file(d->base.sha1, type, &size);
613 if (!strcmp(type, blob_type)) obj_type = OBJ_BLOB;
614 else if (!strcmp(type, tree_type)) obj_type = OBJ_TREE;
615 else if (!strcmp(type, commit_type)) obj_type = OBJ_COMMIT;
616 else if (!strcmp(type, tag_type)) obj_type = OBJ_TAG;
617 else die("base object %s is of type '%s'",
618 sha1_to_hex(d->base.sha1), type);
620 find_delta_children(&d->base, &first, &last);
621 for (j = first; j <= last; j++) {
622 struct object_entry *child = objects + deltas[j].obj_no;
623 if (child->real_type == OBJ_REF_DELTA)
624 resolve_delta(child, data, size, obj_type);
627 append_obj_to_pack(data, size, obj_type);
630 percent = display_progress(nr_resolved_deltas,
638 static void readjust_pack_header_and_sha1(unsigned char *sha1)
640 struct pack_header hdr;
644 /* Rewrite pack header with updated object number */
645 if (lseek(output_fd, 0, SEEK_SET) != 0)
646 die("cannot seek back: %s", strerror(errno));
647 if (read_in_full(output_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
648 die("cannot read pack header back: %s", strerror(errno));
649 hdr.hdr_entries = htonl(nr_objects);
650 if (lseek(output_fd, 0, SEEK_SET) != 0)
651 die("cannot seek back: %s", strerror(errno));
652 write_or_die(output_fd, &hdr, sizeof(hdr));
653 if (lseek(output_fd, 0, SEEK_SET) != 0)
654 die("cannot seek back: %s", strerror(errno));
656 /* Recompute and store the new pack's SHA1 */
659 unsigned char *buf[4096];
660 size = xread(output_fd, buf, sizeof(buf));
662 die("cannot read pack data back: %s", strerror(errno));
663 SHA1_Update(&ctx, buf, size);
665 SHA1_Final(sha1, &ctx);
666 write_or_die(output_fd, sha1, 20);
669 static int sha1_compare(const void *_a, const void *_b)
671 struct object_entry *a = *(struct object_entry **)_a;
672 struct object_entry *b = *(struct object_entry **)_b;
673 return hashcmp(a->sha1, b->sha1);
677 * On entry *sha1 contains the pack content SHA1 hash, on exit it is
678 * the SHA1 hash of sorted object names.
680 static const char *write_index_file(const char *index_name, unsigned char *sha1)
683 struct object_entry **sorted_by_sha, **list, **last;
684 unsigned int array[256];
690 xcalloc(nr_objects, sizeof(struct object_entry *));
691 list = sorted_by_sha;
692 last = sorted_by_sha + nr_objects;
693 for (i = 0; i < nr_objects; ++i)
694 sorted_by_sha[i] = &objects[i];
695 qsort(sorted_by_sha, nr_objects, sizeof(sorted_by_sha[0]),
700 sorted_by_sha = list = last = NULL;
703 static char tmpfile[PATH_MAX];
704 snprintf(tmpfile, sizeof(tmpfile),
705 "%s/index_XXXXXX", get_object_directory());
706 fd = mkstemp(tmpfile);
707 index_name = xstrdup(tmpfile);
710 fd = open(index_name, O_CREAT|O_EXCL|O_WRONLY, 0600);
713 die("unable to create %s: %s", index_name, strerror(errno));
714 f = sha1fd(fd, index_name);
717 * Write the first-level table (the list is sorted,
718 * but we use a 256-entry lookup to be able to avoid
719 * having to do eight extra binary search iterations).
721 for (i = 0; i < 256; i++) {
722 struct object_entry **next = list;
723 while (next < last) {
724 struct object_entry *obj = *next;
725 if (obj->sha1[0] != i)
729 array[i] = htonl(next - sorted_by_sha);
732 sha1write(f, array, 256 * sizeof(int));
734 /* recompute the SHA1 hash of sorted object names.
735 * currently pack-objects does not do this, but that
740 * Write the actual SHA1 entries..
742 list = sorted_by_sha;
743 for (i = 0; i < nr_objects; i++) {
744 struct object_entry *obj = *list++;
745 unsigned int offset = htonl(obj->offset);
746 sha1write(f, &offset, 4);
747 sha1write(f, obj->sha1, 20);
748 SHA1_Update(&ctx, obj->sha1, 20);
750 sha1write(f, sha1, 20);
751 sha1close(f, NULL, 1);
753 SHA1_Final(sha1, &ctx);
757 static void final(const char *final_pack_name, const char *curr_pack_name,
758 const char *final_index_name, const char *curr_index_name,
759 const char *keep_name, const char *keep_msg,
762 char *report = "pack";
769 err = close(output_fd);
771 die("error while closing pack file: %s", strerror(errno));
772 chmod(curr_pack_name, 0444);
776 int keep_fd, keep_msg_len = strlen(keep_msg);
778 snprintf(name, sizeof(name), "%s/pack/pack-%s.keep",
779 get_object_directory(), sha1_to_hex(sha1));
782 keep_fd = open(keep_name, O_RDWR|O_CREAT|O_EXCL, 0600);
785 die("cannot write keep file");
787 if (keep_msg_len > 0) {
788 write_or_die(keep_fd, keep_msg, keep_msg_len);
789 write_or_die(keep_fd, "\n", 1);
796 if (final_pack_name != curr_pack_name) {
797 if (!final_pack_name) {
798 snprintf(name, sizeof(name), "%s/pack/pack-%s.pack",
799 get_object_directory(), sha1_to_hex(sha1));
800 final_pack_name = name;
802 if (move_temp_to_file(curr_pack_name, final_pack_name))
803 die("cannot store pack file");
806 chmod(curr_index_name, 0444);
807 if (final_index_name != curr_index_name) {
808 if (!final_index_name) {
809 snprintf(name, sizeof(name), "%s/pack/pack-%s.idx",
810 get_object_directory(), sha1_to_hex(sha1));
811 final_index_name = name;
813 if (move_temp_to_file(curr_index_name, final_index_name))
814 die("cannot store index file");
818 printf("%s\n", sha1_to_hex(sha1));
821 int len = snprintf(buf, sizeof(buf), "%s\t%s\n",
822 report, sha1_to_hex(sha1));
823 write_or_die(1, buf, len);
826 * Let's just mimic git-unpack-objects here and write
827 * the last part of the input buffer to stdout.
830 err = xwrite(1, input_buffer + input_offset, input_len);
839 int main(int argc, char **argv)
841 int i, fix_thin_pack = 0;
842 const char *curr_pack, *pack_name = NULL;
843 const char *curr_index, *index_name = NULL;
844 const char *keep_name = NULL, *keep_msg = NULL;
845 char *index_name_buf = NULL, *keep_name_buf = NULL;
846 unsigned char sha1[20];
848 for (i = 1; i < argc; i++) {
849 const char *arg = argv[i];
852 if (!strcmp(arg, "--stdin")) {
854 } else if (!strcmp(arg, "--fix-thin")) {
856 } else if (!strcmp(arg, "--keep")) {
858 } else if (!strncmp(arg, "--keep=", 7)) {
860 } else if (!strncmp(arg, "--pack_header=", 14)) {
861 struct pack_header *hdr;
864 hdr = (struct pack_header *)input_buffer;
865 hdr->hdr_signature = htonl(PACK_SIGNATURE);
866 hdr->hdr_version = htonl(strtoul(arg + 14, &c, 10));
869 hdr->hdr_entries = htonl(strtoul(c + 1, &c, 10));
872 input_len = sizeof(*hdr);
873 } else if (!strcmp(arg, "-v")) {
875 } else if (!strcmp(arg, "-o")) {
876 if (index_name || (i+1) >= argc)
877 usage(index_pack_usage);
878 index_name = argv[++i];
880 usage(index_pack_usage);
885 usage(index_pack_usage);
889 if (!pack_name && !from_stdin)
890 usage(index_pack_usage);
891 if (fix_thin_pack && !from_stdin)
892 die("--fix-thin cannot be used without --stdin");
893 if (!index_name && pack_name) {
894 int len = strlen(pack_name);
895 if (!has_extension(pack_name, ".pack"))
896 die("packfile name '%s' does not end with '.pack'",
898 index_name_buf = xmalloc(len);
899 memcpy(index_name_buf, pack_name, len - 5);
900 strcpy(index_name_buf + len - 5, ".idx");
901 index_name = index_name_buf;
903 if (keep_msg && !keep_name && pack_name) {
904 int len = strlen(pack_name);
905 if (!has_extension(pack_name, ".pack"))
906 die("packfile name '%s' does not end with '.pack'",
908 keep_name_buf = xmalloc(len);
909 memcpy(keep_name_buf, pack_name, len - 5);
910 strcpy(keep_name_buf + len - 5, ".keep");
911 keep_name = keep_name_buf;
914 curr_pack = open_pack_file(pack_name);
916 objects = xmalloc((nr_objects + 1) * sizeof(struct object_entry));
917 deltas = xmalloc(nr_objects * sizeof(struct delta_entry));
919 setup_progress_signal();
920 parse_pack_objects(sha1);
921 if (nr_deltas != nr_resolved_deltas) {
923 int nr_unresolved = nr_deltas - nr_resolved_deltas;
924 int nr_objects_initial = nr_objects;
925 if (nr_unresolved <= 0)
926 die("confusion beyond insanity");
927 objects = xrealloc(objects,
928 (nr_objects + nr_unresolved + 1)
930 fix_unresolved_deltas(nr_unresolved);
932 fprintf(stderr, "%d objects were added to complete this thin pack.\n",
933 nr_objects - nr_objects_initial);
934 readjust_pack_header_and_sha1(sha1);
936 if (nr_deltas != nr_resolved_deltas)
937 die("pack has %d unresolved deltas",
938 nr_deltas - nr_resolved_deltas);
940 /* Flush remaining pack final 20-byte SHA1. */
944 curr_index = write_index_file(index_name, sha1);
945 final(pack_name, curr_pack,
946 index_name, curr_index,
950 free(index_name_buf);