Merge branch 'sb/submodule-clone-rr'
[alt-git.git] / sha1_file.c
blob6f38dc65487bb4e639766bb6a189297b356021d7
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
6 * This handles basic git sha1 object files - packing, unpacking,
7 * creation etc.
8 */
9 #include "cache.h"
10 #include "string-list.h"
11 #include "lockfile.h"
12 #include "delta.h"
13 #include "pack.h"
14 #include "blob.h"
15 #include "commit.h"
16 #include "run-command.h"
17 #include "tag.h"
18 #include "tree.h"
19 #include "tree-walk.h"
20 #include "refs.h"
21 #include "pack-revindex.h"
22 #include "sha1-lookup.h"
23 #include "bulk-checkin.h"
24 #include "streaming.h"
25 #include "dir.h"
26 #include "mru.h"
27 #include "list.h"
29 #ifndef O_NOATIME
30 #if defined(__linux__) && (defined(__i386__) || defined(__PPC__))
31 #define O_NOATIME 01000000
32 #else
33 #define O_NOATIME 0
34 #endif
35 #endif
37 #define SZ_FMT PRIuMAX
38 static inline uintmax_t sz_fmt(size_t s) { return s; }
40 const unsigned char null_sha1[20];
41 const struct object_id null_oid;
44 * This is meant to hold a *small* number of objects that you would
45 * want read_sha1_file() to be able to return, but yet you do not want
46 * to write them into the object store (e.g. a browse-only
47 * application).
49 static struct cached_object {
50 unsigned char sha1[20];
51 enum object_type type;
52 void *buf;
53 unsigned long size;
54 } *cached_objects;
55 static int cached_object_nr, cached_object_alloc;
57 static struct cached_object empty_tree = {
58 EMPTY_TREE_SHA1_BIN_LITERAL,
59 OBJ_TREE,
60 "",
64 static struct cached_object *find_cached_object(const unsigned char *sha1)
66 int i;
67 struct cached_object *co = cached_objects;
69 for (i = 0; i < cached_object_nr; i++, co++) {
70 if (!hashcmp(co->sha1, sha1))
71 return co;
73 if (!hashcmp(sha1, empty_tree.sha1))
74 return &empty_tree;
75 return NULL;
78 int mkdir_in_gitdir(const char *path)
80 if (mkdir(path, 0777)) {
81 int saved_errno = errno;
82 struct stat st;
83 struct strbuf sb = STRBUF_INIT;
85 if (errno != EEXIST)
86 return -1;
88 * Are we looking at a path in a symlinked worktree
89 * whose original repository does not yet have it?
90 * e.g. .git/rr-cache pointing at its original
91 * repository in which the user hasn't performed any
92 * conflict resolution yet?
94 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
95 strbuf_readlink(&sb, path, st.st_size) ||
96 !is_absolute_path(sb.buf) ||
97 mkdir(sb.buf, 0777)) {
98 strbuf_release(&sb);
99 errno = saved_errno;
100 return -1;
102 strbuf_release(&sb);
104 return adjust_shared_perm(path);
107 enum scld_error safe_create_leading_directories(char *path)
109 char *next_component = path + offset_1st_component(path);
110 enum scld_error ret = SCLD_OK;
112 while (ret == SCLD_OK && next_component) {
113 struct stat st;
114 char *slash = next_component, slash_character;
116 while (*slash && !is_dir_sep(*slash))
117 slash++;
119 if (!*slash)
120 break;
122 next_component = slash + 1;
123 while (is_dir_sep(*next_component))
124 next_component++;
125 if (!*next_component)
126 break;
128 slash_character = *slash;
129 *slash = '\0';
130 if (!stat(path, &st)) {
131 /* path exists */
132 if (!S_ISDIR(st.st_mode))
133 ret = SCLD_EXISTS;
134 } else if (mkdir(path, 0777)) {
135 if (errno == EEXIST &&
136 !stat(path, &st) && S_ISDIR(st.st_mode))
137 ; /* somebody created it since we checked */
138 else if (errno == ENOENT)
140 * Either mkdir() failed because
141 * somebody just pruned the containing
142 * directory, or stat() failed because
143 * the file that was in our way was
144 * just removed. Either way, inform
145 * the caller that it might be worth
146 * trying again:
148 ret = SCLD_VANISHED;
149 else
150 ret = SCLD_FAILED;
151 } else if (adjust_shared_perm(path)) {
152 ret = SCLD_PERMS;
154 *slash = slash_character;
156 return ret;
159 enum scld_error safe_create_leading_directories_const(const char *path)
161 /* path points to cache entries, so xstrdup before messing with it */
162 char *buf = xstrdup(path);
163 enum scld_error result = safe_create_leading_directories(buf);
164 free(buf);
165 return result;
168 static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
170 int i;
171 for (i = 0; i < 20; i++) {
172 static char hex[] = "0123456789abcdef";
173 unsigned int val = sha1[i];
174 char *pos = pathbuf + i*2 + (i > 0);
175 *pos++ = hex[val >> 4];
176 *pos = hex[val & 0xf];
180 const char *sha1_file_name(const unsigned char *sha1)
182 static char buf[PATH_MAX];
183 const char *objdir;
184 int len;
186 objdir = get_object_directory();
187 len = strlen(objdir);
189 /* '/' + sha1(2) + '/' + sha1(38) + '\0' */
190 if (len + 43 > PATH_MAX)
191 die("insanely long object directory %s", objdir);
192 memcpy(buf, objdir, len);
193 buf[len] = '/';
194 buf[len+3] = '/';
195 buf[len+42] = '\0';
196 fill_sha1_path(buf + len + 1, sha1);
197 return buf;
201 * Return the name of the pack or index file with the specified sha1
202 * in its filename. *base and *name are scratch space that must be
203 * provided by the caller. which should be "pack" or "idx".
205 static char *sha1_get_pack_name(const unsigned char *sha1,
206 struct strbuf *buf,
207 const char *which)
209 strbuf_reset(buf);
210 strbuf_addf(buf, "%s/pack/pack-%s.%s", get_object_directory(),
211 sha1_to_hex(sha1), which);
212 return buf->buf;
215 char *sha1_pack_name(const unsigned char *sha1)
217 static struct strbuf buf = STRBUF_INIT;
218 return sha1_get_pack_name(sha1, &buf, "pack");
221 char *sha1_pack_index_name(const unsigned char *sha1)
223 static struct strbuf buf = STRBUF_INIT;
224 return sha1_get_pack_name(sha1, &buf, "idx");
227 struct alternate_object_database *alt_odb_list;
228 static struct alternate_object_database **alt_odb_tail;
231 * Prepare alternate object database registry.
233 * The variable alt_odb_list points at the list of struct
234 * alternate_object_database. The elements on this list come from
235 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
236 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
237 * whose contents is similar to that environment variable but can be
238 * LF separated. Its base points at a statically allocated buffer that
239 * contains "/the/directory/corresponding/to/.git/objects/...", while
240 * its name points just after the slash at the end of ".git/objects/"
241 * in the example above, and has enough space to hold 40-byte hex
242 * SHA1, an extra slash for the first level indirection, and the
243 * terminating NUL.
245 static int link_alt_odb_entry(const char *entry, const char *relative_base,
246 int depth, const char *normalized_objdir)
248 struct alternate_object_database *ent;
249 struct alternate_object_database *alt;
250 size_t pfxlen, entlen;
251 struct strbuf pathbuf = STRBUF_INIT;
253 if (!is_absolute_path(entry) && relative_base) {
254 strbuf_addstr(&pathbuf, real_path(relative_base));
255 strbuf_addch(&pathbuf, '/');
257 strbuf_addstr(&pathbuf, entry);
259 normalize_path_copy(pathbuf.buf, pathbuf.buf);
261 pfxlen = strlen(pathbuf.buf);
264 * The trailing slash after the directory name is given by
265 * this function at the end. Remove duplicates.
267 while (pfxlen && pathbuf.buf[pfxlen-1] == '/')
268 pfxlen -= 1;
270 entlen = st_add(pfxlen, 43); /* '/' + 2 hex + '/' + 38 hex + NUL */
271 ent = xmalloc(st_add(sizeof(*ent), entlen));
272 memcpy(ent->base, pathbuf.buf, pfxlen);
273 strbuf_release(&pathbuf);
275 ent->name = ent->base + pfxlen + 1;
276 ent->base[pfxlen + 3] = '/';
277 ent->base[pfxlen] = ent->base[entlen-1] = 0;
279 /* Detect cases where alternate disappeared */
280 if (!is_directory(ent->base)) {
281 error("object directory %s does not exist; "
282 "check .git/objects/info/alternates.",
283 ent->base);
284 free(ent);
285 return -1;
288 /* Prevent the common mistake of listing the same
289 * thing twice, or object directory itself.
291 for (alt = alt_odb_list; alt; alt = alt->next) {
292 if (pfxlen == alt->name - alt->base - 1 &&
293 !memcmp(ent->base, alt->base, pfxlen)) {
294 free(ent);
295 return -1;
298 if (!fspathcmp(ent->base, normalized_objdir)) {
299 free(ent);
300 return -1;
303 /* add the alternate entry */
304 *alt_odb_tail = ent;
305 alt_odb_tail = &(ent->next);
306 ent->next = NULL;
308 /* recursively add alternates */
309 read_info_alternates(ent->base, depth + 1);
311 ent->base[pfxlen] = '/';
313 return 0;
316 static void link_alt_odb_entries(const char *alt, int len, int sep,
317 const char *relative_base, int depth)
319 struct string_list entries = STRING_LIST_INIT_NODUP;
320 char *alt_copy;
321 int i;
322 struct strbuf objdirbuf = STRBUF_INIT;
324 if (depth > 5) {
325 error("%s: ignoring alternate object stores, nesting too deep.",
326 relative_base);
327 return;
330 strbuf_add_absolute_path(&objdirbuf, get_object_directory());
331 normalize_path_copy(objdirbuf.buf, objdirbuf.buf);
333 alt_copy = xmemdupz(alt, len);
334 string_list_split_in_place(&entries, alt_copy, sep, -1);
335 for (i = 0; i < entries.nr; i++) {
336 const char *entry = entries.items[i].string;
337 if (entry[0] == '\0' || entry[0] == '#')
338 continue;
339 if (!is_absolute_path(entry) && depth) {
340 error("%s: ignoring relative alternate object store %s",
341 relative_base, entry);
342 } else {
343 link_alt_odb_entry(entry, relative_base, depth, objdirbuf.buf);
346 string_list_clear(&entries, 0);
347 free(alt_copy);
348 strbuf_release(&objdirbuf);
351 void read_info_alternates(const char * relative_base, int depth)
353 char *map;
354 size_t mapsz;
355 struct stat st;
356 char *path;
357 int fd;
359 path = xstrfmt("%s/info/alternates", relative_base);
360 fd = git_open_noatime(path);
361 free(path);
362 if (fd < 0)
363 return;
364 if (fstat(fd, &st) || (st.st_size == 0)) {
365 close(fd);
366 return;
368 mapsz = xsize_t(st.st_size);
369 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
370 close(fd);
372 link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
374 munmap(map, mapsz);
377 void add_to_alternates_file(const char *reference)
379 struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
380 char *alts = git_pathdup("objects/info/alternates");
381 FILE *in, *out;
383 hold_lock_file_for_update(lock, alts, LOCK_DIE_ON_ERROR);
384 out = fdopen_lock_file(lock, "w");
385 if (!out)
386 die_errno("unable to fdopen alternates lockfile");
388 in = fopen(alts, "r");
389 if (in) {
390 struct strbuf line = STRBUF_INIT;
391 int found = 0;
393 while (strbuf_getline(&line, in) != EOF) {
394 if (!strcmp(reference, line.buf)) {
395 found = 1;
396 break;
398 fprintf_or_die(out, "%s\n", line.buf);
401 strbuf_release(&line);
402 fclose(in);
404 if (found) {
405 rollback_lock_file(lock);
406 lock = NULL;
409 else if (errno != ENOENT)
410 die_errno("unable to read alternates file");
412 if (lock) {
413 fprintf_or_die(out, "%s\n", reference);
414 if (commit_lock_file(lock))
415 die_errno("unable to move new alternates file into place");
416 if (alt_odb_tail)
417 link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
419 free(alts);
423 * Compute the exact path an alternate is at and returns it. In case of
424 * error NULL is returned and the human readable error is added to `err`
425 * `path` may be relative and should point to $GITDIR.
426 * `err` must not be null.
428 char *compute_alternate_path(const char *path, struct strbuf *err)
430 char *ref_git = NULL;
431 const char *repo, *ref_git_s;
432 int seen_error = 0;
434 ref_git_s = real_path_if_valid(path);
435 if (!ref_git_s) {
436 seen_error = 1;
437 strbuf_addf(err, _("path '%s' does not exist"), path);
438 goto out;
439 } else
441 * Beware: read_gitfile(), real_path() and mkpath()
442 * return static buffer
444 ref_git = xstrdup(ref_git_s);
446 repo = read_gitfile(ref_git);
447 if (!repo)
448 repo = read_gitfile(mkpath("%s/.git", ref_git));
449 if (repo) {
450 free(ref_git);
451 ref_git = xstrdup(repo);
454 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
455 char *ref_git_git = mkpathdup("%s/.git", ref_git);
456 free(ref_git);
457 ref_git = ref_git_git;
458 } else if (!is_directory(mkpath("%s/objects", ref_git))) {
459 struct strbuf sb = STRBUF_INIT;
460 seen_error = 1;
461 if (get_common_dir(&sb, ref_git)) {
462 strbuf_addf(err,
463 _("reference repository '%s' as a linked "
464 "checkout is not supported yet."),
465 path);
466 goto out;
469 strbuf_addf(err, _("reference repository '%s' is not a "
470 "local repository."), path);
471 goto out;
474 if (!access(mkpath("%s/shallow", ref_git), F_OK)) {
475 strbuf_addf(err, _("reference repository '%s' is shallow"),
476 path);
477 seen_error = 1;
478 goto out;
481 if (!access(mkpath("%s/info/grafts", ref_git), F_OK)) {
482 strbuf_addf(err,
483 _("reference repository '%s' is grafted"),
484 path);
485 seen_error = 1;
486 goto out;
489 out:
490 if (seen_error) {
491 free(ref_git);
492 ref_git = NULL;
495 return ref_git;
498 int foreach_alt_odb(alt_odb_fn fn, void *cb)
500 struct alternate_object_database *ent;
501 int r = 0;
503 prepare_alt_odb();
504 for (ent = alt_odb_list; ent; ent = ent->next) {
505 r = fn(ent, cb);
506 if (r)
507 break;
509 return r;
512 void prepare_alt_odb(void)
514 const char *alt;
516 if (alt_odb_tail)
517 return;
519 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
520 if (!alt) alt = "";
522 alt_odb_tail = &alt_odb_list;
523 link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
525 read_info_alternates(get_object_directory(), 0);
528 /* Returns 1 if we have successfully freshened the file, 0 otherwise. */
529 static int freshen_file(const char *fn)
531 struct utimbuf t;
532 t.actime = t.modtime = time(NULL);
533 return !utime(fn, &t);
537 * All of the check_and_freshen functions return 1 if the file exists and was
538 * freshened (if freshening was requested), 0 otherwise. If they return
539 * 0, you should not assume that it is safe to skip a write of the object (it
540 * either does not exist on disk, or has a stale mtime and may be subject to
541 * pruning).
543 static int check_and_freshen_file(const char *fn, int freshen)
545 if (access(fn, F_OK))
546 return 0;
547 if (freshen && !freshen_file(fn))
548 return 0;
549 return 1;
552 static int check_and_freshen_local(const unsigned char *sha1, int freshen)
554 return check_and_freshen_file(sha1_file_name(sha1), freshen);
557 static int check_and_freshen_nonlocal(const unsigned char *sha1, int freshen)
559 struct alternate_object_database *alt;
560 prepare_alt_odb();
561 for (alt = alt_odb_list; alt; alt = alt->next) {
562 fill_sha1_path(alt->name, sha1);
563 if (check_and_freshen_file(alt->base, freshen))
564 return 1;
566 return 0;
569 static int check_and_freshen(const unsigned char *sha1, int freshen)
571 return check_and_freshen_local(sha1, freshen) ||
572 check_and_freshen_nonlocal(sha1, freshen);
575 int has_loose_object_nonlocal(const unsigned char *sha1)
577 return check_and_freshen_nonlocal(sha1, 0);
580 static int has_loose_object(const unsigned char *sha1)
582 return check_and_freshen(sha1, 0);
585 static unsigned int pack_used_ctr;
586 static unsigned int pack_mmap_calls;
587 static unsigned int peak_pack_open_windows;
588 static unsigned int pack_open_windows;
589 static unsigned int pack_open_fds;
590 static unsigned int pack_max_fds;
591 static size_t peak_pack_mapped;
592 static size_t pack_mapped;
593 struct packed_git *packed_git;
595 static struct mru packed_git_mru_storage;
596 struct mru *packed_git_mru = &packed_git_mru_storage;
598 void pack_report(void)
600 fprintf(stderr,
601 "pack_report: getpagesize() = %10" SZ_FMT "\n"
602 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
603 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
604 sz_fmt(getpagesize()),
605 sz_fmt(packed_git_window_size),
606 sz_fmt(packed_git_limit));
607 fprintf(stderr,
608 "pack_report: pack_used_ctr = %10u\n"
609 "pack_report: pack_mmap_calls = %10u\n"
610 "pack_report: pack_open_windows = %10u / %10u\n"
611 "pack_report: pack_mapped = "
612 "%10" SZ_FMT " / %10" SZ_FMT "\n",
613 pack_used_ctr,
614 pack_mmap_calls,
615 pack_open_windows, peak_pack_open_windows,
616 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
620 * Open and mmap the index file at path, perform a couple of
621 * consistency checks, then record its information to p. Return 0 on
622 * success.
624 static int check_packed_git_idx(const char *path, struct packed_git *p)
626 void *idx_map;
627 struct pack_idx_header *hdr;
628 size_t idx_size;
629 uint32_t version, nr, i, *index;
630 int fd = git_open_noatime(path);
631 struct stat st;
633 if (fd < 0)
634 return -1;
635 if (fstat(fd, &st)) {
636 close(fd);
637 return -1;
639 idx_size = xsize_t(st.st_size);
640 if (idx_size < 4 * 256 + 20 + 20) {
641 close(fd);
642 return error("index file %s is too small", path);
644 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
645 close(fd);
647 hdr = idx_map;
648 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
649 version = ntohl(hdr->idx_version);
650 if (version < 2 || version > 2) {
651 munmap(idx_map, idx_size);
652 return error("index file %s is version %"PRIu32
653 " and is not supported by this binary"
654 " (try upgrading GIT to a newer version)",
655 path, version);
657 } else
658 version = 1;
660 nr = 0;
661 index = idx_map;
662 if (version > 1)
663 index += 2; /* skip index header */
664 for (i = 0; i < 256; i++) {
665 uint32_t n = ntohl(index[i]);
666 if (n < nr) {
667 munmap(idx_map, idx_size);
668 return error("non-monotonic index %s", path);
670 nr = n;
673 if (version == 1) {
675 * Total size:
676 * - 256 index entries 4 bytes each
677 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
678 * - 20-byte SHA1 of the packfile
679 * - 20-byte SHA1 file checksum
681 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
682 munmap(idx_map, idx_size);
683 return error("wrong index v1 file size in %s", path);
685 } else if (version == 2) {
687 * Minimum size:
688 * - 8 bytes of header
689 * - 256 index entries 4 bytes each
690 * - 20-byte sha1 entry * nr
691 * - 4-byte crc entry * nr
692 * - 4-byte offset entry * nr
693 * - 20-byte SHA1 of the packfile
694 * - 20-byte SHA1 file checksum
695 * And after the 4-byte offset table might be a
696 * variable sized table containing 8-byte entries
697 * for offsets larger than 2^31.
699 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
700 unsigned long max_size = min_size;
701 if (nr)
702 max_size += (nr - 1)*8;
703 if (idx_size < min_size || idx_size > max_size) {
704 munmap(idx_map, idx_size);
705 return error("wrong index v2 file size in %s", path);
707 if (idx_size != min_size &&
709 * make sure we can deal with large pack offsets.
710 * 31-bit signed offset won't be enough, neither
711 * 32-bit unsigned one will be.
713 (sizeof(off_t) <= 4)) {
714 munmap(idx_map, idx_size);
715 return error("pack too large for current definition of off_t in %s", path);
719 p->index_version = version;
720 p->index_data = idx_map;
721 p->index_size = idx_size;
722 p->num_objects = nr;
723 return 0;
726 int open_pack_index(struct packed_git *p)
728 char *idx_name;
729 size_t len;
730 int ret;
732 if (p->index_data)
733 return 0;
735 if (!strip_suffix(p->pack_name, ".pack", &len))
736 die("BUG: pack_name does not end in .pack");
737 idx_name = xstrfmt("%.*s.idx", (int)len, p->pack_name);
738 ret = check_packed_git_idx(idx_name, p);
739 free(idx_name);
740 return ret;
743 static void scan_windows(struct packed_git *p,
744 struct packed_git **lru_p,
745 struct pack_window **lru_w,
746 struct pack_window **lru_l)
748 struct pack_window *w, *w_l;
750 for (w_l = NULL, w = p->windows; w; w = w->next) {
751 if (!w->inuse_cnt) {
752 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
753 *lru_p = p;
754 *lru_w = w;
755 *lru_l = w_l;
758 w_l = w;
762 static int unuse_one_window(struct packed_git *current)
764 struct packed_git *p, *lru_p = NULL;
765 struct pack_window *lru_w = NULL, *lru_l = NULL;
767 if (current)
768 scan_windows(current, &lru_p, &lru_w, &lru_l);
769 for (p = packed_git; p; p = p->next)
770 scan_windows(p, &lru_p, &lru_w, &lru_l);
771 if (lru_p) {
772 munmap(lru_w->base, lru_w->len);
773 pack_mapped -= lru_w->len;
774 if (lru_l)
775 lru_l->next = lru_w->next;
776 else
777 lru_p->windows = lru_w->next;
778 free(lru_w);
779 pack_open_windows--;
780 return 1;
782 return 0;
785 void release_pack_memory(size_t need)
787 size_t cur = pack_mapped;
788 while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
789 ; /* nothing */
792 static void mmap_limit_check(size_t length)
794 static size_t limit = 0;
795 if (!limit) {
796 limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
797 if (!limit)
798 limit = SIZE_MAX;
800 if (length > limit)
801 die("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX,
802 (uintmax_t)length, (uintmax_t)limit);
805 void *xmmap_gently(void *start, size_t length,
806 int prot, int flags, int fd, off_t offset)
808 void *ret;
810 mmap_limit_check(length);
811 ret = mmap(start, length, prot, flags, fd, offset);
812 if (ret == MAP_FAILED) {
813 if (!length)
814 return NULL;
815 release_pack_memory(length);
816 ret = mmap(start, length, prot, flags, fd, offset);
818 return ret;
821 void *xmmap(void *start, size_t length,
822 int prot, int flags, int fd, off_t offset)
824 void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
825 if (ret == MAP_FAILED)
826 die_errno("mmap failed");
827 return ret;
830 void close_pack_windows(struct packed_git *p)
832 while (p->windows) {
833 struct pack_window *w = p->windows;
835 if (w->inuse_cnt)
836 die("pack '%s' still has open windows to it",
837 p->pack_name);
838 munmap(w->base, w->len);
839 pack_mapped -= w->len;
840 pack_open_windows--;
841 p->windows = w->next;
842 free(w);
846 static int close_pack_fd(struct packed_git *p)
848 if (p->pack_fd < 0)
849 return 0;
851 close(p->pack_fd);
852 pack_open_fds--;
853 p->pack_fd = -1;
855 return 1;
858 static void close_pack(struct packed_git *p)
860 close_pack_windows(p);
861 close_pack_fd(p);
862 close_pack_index(p);
865 void close_all_packs(void)
867 struct packed_git *p;
869 for (p = packed_git; p; p = p->next)
870 if (p->do_not_close)
871 die("BUG: want to close pack marked 'do-not-close'");
872 else
873 close_pack(p);
878 * The LRU pack is the one with the oldest MRU window, preferring packs
879 * with no used windows, or the oldest mtime if it has no windows allocated.
881 static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
883 struct pack_window *w, *this_mru_w;
884 int has_windows_inuse = 0;
887 * Reject this pack if it has windows and the previously selected
888 * one does not. If this pack does not have windows, reject
889 * it if the pack file is newer than the previously selected one.
891 if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
892 return;
894 for (w = this_mru_w = p->windows; w; w = w->next) {
896 * Reject this pack if any of its windows are in use,
897 * but the previously selected pack did not have any
898 * inuse windows. Otherwise, record that this pack
899 * has windows in use.
901 if (w->inuse_cnt) {
902 if (*accept_windows_inuse)
903 has_windows_inuse = 1;
904 else
905 return;
908 if (w->last_used > this_mru_w->last_used)
909 this_mru_w = w;
912 * Reject this pack if it has windows that have been
913 * used more recently than the previously selected pack.
914 * If the previously selected pack had windows inuse and
915 * we have not encountered a window in this pack that is
916 * inuse, skip this check since we prefer a pack with no
917 * inuse windows to one that has inuse windows.
919 if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
920 this_mru_w->last_used > (*mru_w)->last_used)
921 return;
925 * Select this pack.
927 *mru_w = this_mru_w;
928 *lru_p = p;
929 *accept_windows_inuse = has_windows_inuse;
932 static int close_one_pack(void)
934 struct packed_git *p, *lru_p = NULL;
935 struct pack_window *mru_w = NULL;
936 int accept_windows_inuse = 1;
938 for (p = packed_git; p; p = p->next) {
939 if (p->pack_fd == -1)
940 continue;
941 find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
944 if (lru_p)
945 return close_pack_fd(lru_p);
947 return 0;
950 void unuse_pack(struct pack_window **w_cursor)
952 struct pack_window *w = *w_cursor;
953 if (w) {
954 w->inuse_cnt--;
955 *w_cursor = NULL;
959 void close_pack_index(struct packed_git *p)
961 if (p->index_data) {
962 munmap((void *)p->index_data, p->index_size);
963 p->index_data = NULL;
967 static unsigned int get_max_fd_limit(void)
969 #ifdef RLIMIT_NOFILE
971 struct rlimit lim;
973 if (!getrlimit(RLIMIT_NOFILE, &lim))
974 return lim.rlim_cur;
976 #endif
978 #ifdef _SC_OPEN_MAX
980 long open_max = sysconf(_SC_OPEN_MAX);
981 if (0 < open_max)
982 return open_max;
984 * Otherwise, we got -1 for one of the two
985 * reasons:
987 * (1) sysconf() did not understand _SC_OPEN_MAX
988 * and signaled an error with -1; or
989 * (2) sysconf() said there is no limit.
991 * We _could_ clear errno before calling sysconf() to
992 * tell these two cases apart and return a huge number
993 * in the latter case to let the caller cap it to a
994 * value that is not so selfish, but letting the
995 * fallback OPEN_MAX codepath take care of these cases
996 * is a lot simpler.
999 #endif
1001 #ifdef OPEN_MAX
1002 return OPEN_MAX;
1003 #else
1004 return 1; /* see the caller ;-) */
1005 #endif
1009 * Do not call this directly as this leaks p->pack_fd on error return;
1010 * call open_packed_git() instead.
1012 static int open_packed_git_1(struct packed_git *p)
1014 struct stat st;
1015 struct pack_header hdr;
1016 unsigned char sha1[20];
1017 unsigned char *idx_sha1;
1018 long fd_flag;
1020 if (!p->index_data && open_pack_index(p))
1021 return error("packfile %s index unavailable", p->pack_name);
1023 if (!pack_max_fds) {
1024 unsigned int max_fds = get_max_fd_limit();
1026 /* Save 3 for stdin/stdout/stderr, 22 for work */
1027 if (25 < max_fds)
1028 pack_max_fds = max_fds - 25;
1029 else
1030 pack_max_fds = 1;
1033 while (pack_max_fds <= pack_open_fds && close_one_pack())
1034 ; /* nothing */
1036 p->pack_fd = git_open_noatime(p->pack_name);
1037 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
1038 return -1;
1039 pack_open_fds++;
1041 /* If we created the struct before we had the pack we lack size. */
1042 if (!p->pack_size) {
1043 if (!S_ISREG(st.st_mode))
1044 return error("packfile %s not a regular file", p->pack_name);
1045 p->pack_size = st.st_size;
1046 } else if (p->pack_size != st.st_size)
1047 return error("packfile %s size changed", p->pack_name);
1049 /* We leave these file descriptors open with sliding mmap;
1050 * there is no point keeping them open across exec(), though.
1052 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
1053 if (fd_flag < 0)
1054 return error("cannot determine file descriptor flags");
1055 fd_flag |= FD_CLOEXEC;
1056 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
1057 return error("cannot set FD_CLOEXEC");
1059 /* Verify we recognize this pack file format. */
1060 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
1061 return error("file %s is far too short to be a packfile", p->pack_name);
1062 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
1063 return error("file %s is not a GIT packfile", p->pack_name);
1064 if (!pack_version_ok(hdr.hdr_version))
1065 return error("packfile %s is version %"PRIu32" and not"
1066 " supported (try upgrading GIT to a newer version)",
1067 p->pack_name, ntohl(hdr.hdr_version));
1069 /* Verify the pack matches its index. */
1070 if (p->num_objects != ntohl(hdr.hdr_entries))
1071 return error("packfile %s claims to have %"PRIu32" objects"
1072 " while index indicates %"PRIu32" objects",
1073 p->pack_name, ntohl(hdr.hdr_entries),
1074 p->num_objects);
1075 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
1076 return error("end of packfile %s is unavailable", p->pack_name);
1077 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
1078 return error("packfile %s signature is unavailable", p->pack_name);
1079 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
1080 if (hashcmp(sha1, idx_sha1))
1081 return error("packfile %s does not match index", p->pack_name);
1082 return 0;
1085 static int open_packed_git(struct packed_git *p)
1087 if (!open_packed_git_1(p))
1088 return 0;
1089 close_pack_fd(p);
1090 return -1;
1093 static int in_window(struct pack_window *win, off_t offset)
1095 /* We must promise at least 20 bytes (one hash) after the
1096 * offset is available from this window, otherwise the offset
1097 * is not actually in this window and a different window (which
1098 * has that one hash excess) must be used. This is to support
1099 * the object header and delta base parsing routines below.
1101 off_t win_off = win->offset;
1102 return win_off <= offset
1103 && (offset + 20) <= (win_off + win->len);
1106 unsigned char *use_pack(struct packed_git *p,
1107 struct pack_window **w_cursor,
1108 off_t offset,
1109 unsigned long *left)
1111 struct pack_window *win = *w_cursor;
1113 /* Since packfiles end in a hash of their content and it's
1114 * pointless to ask for an offset into the middle of that
1115 * hash, and the in_window function above wouldn't match
1116 * don't allow an offset too close to the end of the file.
1118 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
1119 die("packfile %s cannot be accessed", p->pack_name);
1120 if (offset > (p->pack_size - 20))
1121 die("offset beyond end of packfile (truncated pack?)");
1122 if (offset < 0)
1123 die(_("offset before end of packfile (broken .idx?)"));
1125 if (!win || !in_window(win, offset)) {
1126 if (win)
1127 win->inuse_cnt--;
1128 for (win = p->windows; win; win = win->next) {
1129 if (in_window(win, offset))
1130 break;
1132 if (!win) {
1133 size_t window_align = packed_git_window_size / 2;
1134 off_t len;
1136 if (p->pack_fd == -1 && open_packed_git(p))
1137 die("packfile %s cannot be accessed", p->pack_name);
1139 win = xcalloc(1, sizeof(*win));
1140 win->offset = (offset / window_align) * window_align;
1141 len = p->pack_size - win->offset;
1142 if (len > packed_git_window_size)
1143 len = packed_git_window_size;
1144 win->len = (size_t)len;
1145 pack_mapped += win->len;
1146 while (packed_git_limit < pack_mapped
1147 && unuse_one_window(p))
1148 ; /* nothing */
1149 win->base = xmmap(NULL, win->len,
1150 PROT_READ, MAP_PRIVATE,
1151 p->pack_fd, win->offset);
1152 if (win->base == MAP_FAILED)
1153 die_errno("packfile %s cannot be mapped",
1154 p->pack_name);
1155 if (!win->offset && win->len == p->pack_size
1156 && !p->do_not_close)
1157 close_pack_fd(p);
1158 pack_mmap_calls++;
1159 pack_open_windows++;
1160 if (pack_mapped > peak_pack_mapped)
1161 peak_pack_mapped = pack_mapped;
1162 if (pack_open_windows > peak_pack_open_windows)
1163 peak_pack_open_windows = pack_open_windows;
1164 win->next = p->windows;
1165 p->windows = win;
1168 if (win != *w_cursor) {
1169 win->last_used = pack_used_ctr++;
1170 win->inuse_cnt++;
1171 *w_cursor = win;
1173 offset -= win->offset;
1174 if (left)
1175 *left = win->len - xsize_t(offset);
1176 return win->base + offset;
1179 static struct packed_git *alloc_packed_git(int extra)
1181 struct packed_git *p = xmalloc(st_add(sizeof(*p), extra));
1182 memset(p, 0, sizeof(*p));
1183 p->pack_fd = -1;
1184 return p;
1187 static void try_to_free_pack_memory(size_t size)
1189 release_pack_memory(size);
1192 struct packed_git *add_packed_git(const char *path, size_t path_len, int local)
1194 static int have_set_try_to_free_routine;
1195 struct stat st;
1196 size_t alloc;
1197 struct packed_git *p;
1199 if (!have_set_try_to_free_routine) {
1200 have_set_try_to_free_routine = 1;
1201 set_try_to_free_routine(try_to_free_pack_memory);
1205 * Make sure a corresponding .pack file exists and that
1206 * the index looks sane.
1208 if (!strip_suffix_mem(path, &path_len, ".idx"))
1209 return NULL;
1212 * ".pack" is long enough to hold any suffix we're adding (and
1213 * the use xsnprintf double-checks that)
1215 alloc = st_add3(path_len, strlen(".pack"), 1);
1216 p = alloc_packed_git(alloc);
1217 memcpy(p->pack_name, path, path_len);
1219 xsnprintf(p->pack_name + path_len, alloc - path_len, ".keep");
1220 if (!access(p->pack_name, F_OK))
1221 p->pack_keep = 1;
1223 xsnprintf(p->pack_name + path_len, alloc - path_len, ".pack");
1224 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
1225 free(p);
1226 return NULL;
1229 /* ok, it looks sane as far as we can check without
1230 * actually mapping the pack file.
1232 p->pack_size = st.st_size;
1233 p->pack_local = local;
1234 p->mtime = st.st_mtime;
1235 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
1236 hashclr(p->sha1);
1237 return p;
1240 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
1242 const char *path = sha1_pack_name(sha1);
1243 size_t alloc = st_add(strlen(path), 1);
1244 struct packed_git *p = alloc_packed_git(alloc);
1246 memcpy(p->pack_name, path, alloc); /* includes NUL */
1247 hashcpy(p->sha1, sha1);
1248 if (check_packed_git_idx(idx_path, p)) {
1249 free(p);
1250 return NULL;
1253 return p;
1256 void install_packed_git(struct packed_git *pack)
1258 if (pack->pack_fd != -1)
1259 pack_open_fds++;
1261 pack->next = packed_git;
1262 packed_git = pack;
1265 void (*report_garbage)(unsigned seen_bits, const char *path);
1267 static void report_helper(const struct string_list *list,
1268 int seen_bits, int first, int last)
1270 if (seen_bits == (PACKDIR_FILE_PACK|PACKDIR_FILE_IDX))
1271 return;
1273 for (; first < last; first++)
1274 report_garbage(seen_bits, list->items[first].string);
1277 static void report_pack_garbage(struct string_list *list)
1279 int i, baselen = -1, first = 0, seen_bits = 0;
1281 if (!report_garbage)
1282 return;
1284 string_list_sort(list);
1286 for (i = 0; i < list->nr; i++) {
1287 const char *path = list->items[i].string;
1288 if (baselen != -1 &&
1289 strncmp(path, list->items[first].string, baselen)) {
1290 report_helper(list, seen_bits, first, i);
1291 baselen = -1;
1292 seen_bits = 0;
1294 if (baselen == -1) {
1295 const char *dot = strrchr(path, '.');
1296 if (!dot) {
1297 report_garbage(PACKDIR_FILE_GARBAGE, path);
1298 continue;
1300 baselen = dot - path + 1;
1301 first = i;
1303 if (!strcmp(path + baselen, "pack"))
1304 seen_bits |= 1;
1305 else if (!strcmp(path + baselen, "idx"))
1306 seen_bits |= 2;
1308 report_helper(list, seen_bits, first, list->nr);
1311 static void prepare_packed_git_one(char *objdir, int local)
1313 struct strbuf path = STRBUF_INIT;
1314 size_t dirnamelen;
1315 DIR *dir;
1316 struct dirent *de;
1317 struct string_list garbage = STRING_LIST_INIT_DUP;
1319 strbuf_addstr(&path, objdir);
1320 strbuf_addstr(&path, "/pack");
1321 dir = opendir(path.buf);
1322 if (!dir) {
1323 if (errno != ENOENT)
1324 error_errno("unable to open object pack directory: %s",
1325 path.buf);
1326 strbuf_release(&path);
1327 return;
1329 strbuf_addch(&path, '/');
1330 dirnamelen = path.len;
1331 while ((de = readdir(dir)) != NULL) {
1332 struct packed_git *p;
1333 size_t base_len;
1335 if (is_dot_or_dotdot(de->d_name))
1336 continue;
1338 strbuf_setlen(&path, dirnamelen);
1339 strbuf_addstr(&path, de->d_name);
1341 base_len = path.len;
1342 if (strip_suffix_mem(path.buf, &base_len, ".idx")) {
1343 /* Don't reopen a pack we already have. */
1344 for (p = packed_git; p; p = p->next) {
1345 size_t len;
1346 if (strip_suffix(p->pack_name, ".pack", &len) &&
1347 len == base_len &&
1348 !memcmp(p->pack_name, path.buf, len))
1349 break;
1351 if (p == NULL &&
1353 * See if it really is a valid .idx file with
1354 * corresponding .pack file that we can map.
1356 (p = add_packed_git(path.buf, path.len, local)) != NULL)
1357 install_packed_git(p);
1360 if (!report_garbage)
1361 continue;
1363 if (ends_with(de->d_name, ".idx") ||
1364 ends_with(de->d_name, ".pack") ||
1365 ends_with(de->d_name, ".bitmap") ||
1366 ends_with(de->d_name, ".keep"))
1367 string_list_append(&garbage, path.buf);
1368 else
1369 report_garbage(PACKDIR_FILE_GARBAGE, path.buf);
1371 closedir(dir);
1372 report_pack_garbage(&garbage);
1373 string_list_clear(&garbage, 0);
1374 strbuf_release(&path);
1377 static int sort_pack(const void *a_, const void *b_)
1379 struct packed_git *a = *((struct packed_git **)a_);
1380 struct packed_git *b = *((struct packed_git **)b_);
1381 int st;
1384 * Local packs tend to contain objects specific to our
1385 * variant of the project than remote ones. In addition,
1386 * remote ones could be on a network mounted filesystem.
1387 * Favor local ones for these reasons.
1389 st = a->pack_local - b->pack_local;
1390 if (st)
1391 return -st;
1394 * Younger packs tend to contain more recent objects,
1395 * and more recent objects tend to get accessed more
1396 * often.
1398 if (a->mtime < b->mtime)
1399 return 1;
1400 else if (a->mtime == b->mtime)
1401 return 0;
1402 return -1;
1405 static void rearrange_packed_git(void)
1407 struct packed_git **ary, *p;
1408 int i, n;
1410 for (n = 0, p = packed_git; p; p = p->next)
1411 n++;
1412 if (n < 2)
1413 return;
1415 /* prepare an array of packed_git for easier sorting */
1416 ary = xcalloc(n, sizeof(struct packed_git *));
1417 for (n = 0, p = packed_git; p; p = p->next)
1418 ary[n++] = p;
1420 qsort(ary, n, sizeof(struct packed_git *), sort_pack);
1422 /* link them back again */
1423 for (i = 0; i < n - 1; i++)
1424 ary[i]->next = ary[i + 1];
1425 ary[n - 1]->next = NULL;
1426 packed_git = ary[0];
1428 free(ary);
1431 static void prepare_packed_git_mru(void)
1433 struct packed_git *p;
1435 mru_clear(packed_git_mru);
1436 for (p = packed_git; p; p = p->next)
1437 mru_append(packed_git_mru, p);
1440 static int prepare_packed_git_run_once = 0;
1441 void prepare_packed_git(void)
1443 struct alternate_object_database *alt;
1445 if (prepare_packed_git_run_once)
1446 return;
1447 prepare_packed_git_one(get_object_directory(), 1);
1448 prepare_alt_odb();
1449 for (alt = alt_odb_list; alt; alt = alt->next) {
1450 alt->name[-1] = 0;
1451 prepare_packed_git_one(alt->base, 0);
1452 alt->name[-1] = '/';
1454 rearrange_packed_git();
1455 prepare_packed_git_mru();
1456 prepare_packed_git_run_once = 1;
1459 void reprepare_packed_git(void)
1461 prepare_packed_git_run_once = 0;
1462 prepare_packed_git();
1465 static void mark_bad_packed_object(struct packed_git *p,
1466 const unsigned char *sha1)
1468 unsigned i;
1469 for (i = 0; i < p->num_bad_objects; i++)
1470 if (!hashcmp(sha1, p->bad_object_sha1 + GIT_SHA1_RAWSZ * i))
1471 return;
1472 p->bad_object_sha1 = xrealloc(p->bad_object_sha1,
1473 st_mult(GIT_SHA1_RAWSZ,
1474 st_add(p->num_bad_objects, 1)));
1475 hashcpy(p->bad_object_sha1 + GIT_SHA1_RAWSZ * p->num_bad_objects, sha1);
1476 p->num_bad_objects++;
1479 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1481 struct packed_git *p;
1482 unsigned i;
1484 for (p = packed_git; p; p = p->next)
1485 for (i = 0; i < p->num_bad_objects; i++)
1486 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1487 return p;
1488 return NULL;
1492 * With an in-core object data in "map", rehash it to make sure the
1493 * object name actually matches "sha1" to detect object corruption.
1494 * With "map" == NULL, try reading the object named with "sha1" using
1495 * the streaming interface and rehash it to do the same.
1497 int check_sha1_signature(const unsigned char *sha1, void *map,
1498 unsigned long size, const char *type)
1500 unsigned char real_sha1[20];
1501 enum object_type obj_type;
1502 struct git_istream *st;
1503 git_SHA_CTX c;
1504 char hdr[32];
1505 int hdrlen;
1507 if (map) {
1508 hash_sha1_file(map, size, type, real_sha1);
1509 return hashcmp(sha1, real_sha1) ? -1 : 0;
1512 st = open_istream(sha1, &obj_type, &size, NULL);
1513 if (!st)
1514 return -1;
1516 /* Generate the header */
1517 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(obj_type), size) + 1;
1519 /* Sha1.. */
1520 git_SHA1_Init(&c);
1521 git_SHA1_Update(&c, hdr, hdrlen);
1522 for (;;) {
1523 char buf[1024 * 16];
1524 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1526 if (readlen < 0) {
1527 close_istream(st);
1528 return -1;
1530 if (!readlen)
1531 break;
1532 git_SHA1_Update(&c, buf, readlen);
1534 git_SHA1_Final(real_sha1, &c);
1535 close_istream(st);
1536 return hashcmp(sha1, real_sha1) ? -1 : 0;
1539 int git_open_noatime(const char *name)
1541 static int sha1_file_open_flag = O_NOATIME;
1543 for (;;) {
1544 int fd;
1546 errno = 0;
1547 fd = open(name, O_RDONLY | sha1_file_open_flag);
1548 if (fd >= 0)
1549 return fd;
1551 /* Might the failure be due to O_NOATIME? */
1552 if (errno != ENOENT && sha1_file_open_flag) {
1553 sha1_file_open_flag = 0;
1554 continue;
1557 return -1;
1561 static int stat_sha1_file(const unsigned char *sha1, struct stat *st)
1563 struct alternate_object_database *alt;
1565 if (!lstat(sha1_file_name(sha1), st))
1566 return 0;
1568 prepare_alt_odb();
1569 errno = ENOENT;
1570 for (alt = alt_odb_list; alt; alt = alt->next) {
1571 fill_sha1_path(alt->name, sha1);
1572 if (!lstat(alt->base, st))
1573 return 0;
1576 return -1;
1579 static int open_sha1_file(const unsigned char *sha1)
1581 int fd;
1582 struct alternate_object_database *alt;
1583 int most_interesting_errno;
1585 fd = git_open_noatime(sha1_file_name(sha1));
1586 if (fd >= 0)
1587 return fd;
1588 most_interesting_errno = errno;
1590 prepare_alt_odb();
1591 for (alt = alt_odb_list; alt; alt = alt->next) {
1592 fill_sha1_path(alt->name, sha1);
1593 fd = git_open_noatime(alt->base);
1594 if (fd >= 0)
1595 return fd;
1596 if (most_interesting_errno == ENOENT)
1597 most_interesting_errno = errno;
1599 errno = most_interesting_errno;
1600 return -1;
1603 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1605 void *map;
1606 int fd;
1608 fd = open_sha1_file(sha1);
1609 map = NULL;
1610 if (fd >= 0) {
1611 struct stat st;
1613 if (!fstat(fd, &st)) {
1614 *size = xsize_t(st.st_size);
1615 if (!*size) {
1616 /* mmap() is forbidden on empty files */
1617 error("object file %s is empty", sha1_file_name(sha1));
1618 return NULL;
1620 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1622 close(fd);
1624 return map;
1627 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1628 unsigned long len, enum object_type *type, unsigned long *sizep)
1630 unsigned shift;
1631 unsigned long size, c;
1632 unsigned long used = 0;
1634 c = buf[used++];
1635 *type = (c >> 4) & 7;
1636 size = c & 15;
1637 shift = 4;
1638 while (c & 0x80) {
1639 if (len <= used || bitsizeof(long) <= shift) {
1640 error("bad object header");
1641 size = used = 0;
1642 break;
1644 c = buf[used++];
1645 size += (c & 0x7f) << shift;
1646 shift += 7;
1648 *sizep = size;
1649 return used;
1652 int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz)
1654 /* Get the data stream */
1655 memset(stream, 0, sizeof(*stream));
1656 stream->next_in = map;
1657 stream->avail_in = mapsize;
1658 stream->next_out = buffer;
1659 stream->avail_out = bufsiz;
1661 git_inflate_init(stream);
1662 return git_inflate(stream, 0);
1665 static int unpack_sha1_header_to_strbuf(git_zstream *stream, unsigned char *map,
1666 unsigned long mapsize, void *buffer,
1667 unsigned long bufsiz, struct strbuf *header)
1669 int status;
1671 status = unpack_sha1_header(stream, map, mapsize, buffer, bufsiz);
1674 * Check if entire header is unpacked in the first iteration.
1676 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1677 return 0;
1680 * buffer[0..bufsiz] was not large enough. Copy the partial
1681 * result out to header, and then append the result of further
1682 * reading the stream.
1684 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1685 stream->next_out = buffer;
1686 stream->avail_out = bufsiz;
1688 do {
1689 status = git_inflate(stream, 0);
1690 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1691 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1692 return 0;
1693 stream->next_out = buffer;
1694 stream->avail_out = bufsiz;
1695 } while (status != Z_STREAM_END);
1696 return -1;
1699 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1701 int bytes = strlen(buffer) + 1;
1702 unsigned char *buf = xmallocz(size);
1703 unsigned long n;
1704 int status = Z_OK;
1706 n = stream->total_out - bytes;
1707 if (n > size)
1708 n = size;
1709 memcpy(buf, (char *) buffer + bytes, n);
1710 bytes = n;
1711 if (bytes <= size) {
1713 * The above condition must be (bytes <= size), not
1714 * (bytes < size). In other words, even though we
1715 * expect no more output and set avail_out to zero,
1716 * the input zlib stream may have bytes that express
1717 * "this concludes the stream", and we *do* want to
1718 * eat that input.
1720 * Otherwise we would not be able to test that we
1721 * consumed all the input to reach the expected size;
1722 * we also want to check that zlib tells us that all
1723 * went well with status == Z_STREAM_END at the end.
1725 stream->next_out = buf + bytes;
1726 stream->avail_out = size - bytes;
1727 while (status == Z_OK)
1728 status = git_inflate(stream, Z_FINISH);
1730 if (status == Z_STREAM_END && !stream->avail_in) {
1731 git_inflate_end(stream);
1732 return buf;
1735 if (status < 0)
1736 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1737 else if (stream->avail_in)
1738 error("garbage at end of loose object '%s'",
1739 sha1_to_hex(sha1));
1740 free(buf);
1741 return NULL;
1745 * We used to just use "sscanf()", but that's actually way
1746 * too permissive for what we want to check. So do an anal
1747 * object header parse by hand.
1749 static int parse_sha1_header_extended(const char *hdr, struct object_info *oi,
1750 unsigned int flags)
1752 const char *type_buf = hdr;
1753 unsigned long size;
1754 int type, type_len = 0;
1757 * The type can be of any size but is followed by
1758 * a space.
1760 for (;;) {
1761 char c = *hdr++;
1762 if (c == ' ')
1763 break;
1764 type_len++;
1767 type = type_from_string_gently(type_buf, type_len, 1);
1768 if (oi->typename)
1769 strbuf_add(oi->typename, type_buf, type_len);
1771 * Set type to 0 if its an unknown object and
1772 * we're obtaining the type using '--allow-unknown-type'
1773 * option.
1775 if ((flags & LOOKUP_UNKNOWN_OBJECT) && (type < 0))
1776 type = 0;
1777 else if (type < 0)
1778 die("invalid object type");
1779 if (oi->typep)
1780 *oi->typep = type;
1783 * The length must follow immediately, and be in canonical
1784 * decimal format (ie "010" is not valid).
1786 size = *hdr++ - '0';
1787 if (size > 9)
1788 return -1;
1789 if (size) {
1790 for (;;) {
1791 unsigned long c = *hdr - '0';
1792 if (c > 9)
1793 break;
1794 hdr++;
1795 size = size * 10 + c;
1799 if (oi->sizep)
1800 *oi->sizep = size;
1803 * The length must be followed by a zero byte
1805 return *hdr ? -1 : type;
1808 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1810 struct object_info oi;
1812 oi.sizep = sizep;
1813 oi.typename = NULL;
1814 oi.typep = NULL;
1815 return parse_sha1_header_extended(hdr, &oi, LOOKUP_REPLACE_OBJECT);
1818 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1820 int ret;
1821 git_zstream stream;
1822 char hdr[8192];
1824 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1825 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1826 return NULL;
1828 return unpack_sha1_rest(&stream, hdr, *size, sha1);
1831 unsigned long get_size_from_delta(struct packed_git *p,
1832 struct pack_window **w_curs,
1833 off_t curpos)
1835 const unsigned char *data;
1836 unsigned char delta_head[20], *in;
1837 git_zstream stream;
1838 int st;
1840 memset(&stream, 0, sizeof(stream));
1841 stream.next_out = delta_head;
1842 stream.avail_out = sizeof(delta_head);
1844 git_inflate_init(&stream);
1845 do {
1846 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1847 stream.next_in = in;
1848 st = git_inflate(&stream, Z_FINISH);
1849 curpos += stream.next_in - in;
1850 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1851 stream.total_out < sizeof(delta_head));
1852 git_inflate_end(&stream);
1853 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1854 error("delta data unpack-initial failed");
1855 return 0;
1858 /* Examine the initial part of the delta to figure out
1859 * the result size.
1861 data = delta_head;
1863 /* ignore base size */
1864 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1866 /* Read the result size */
1867 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1870 static off_t get_delta_base(struct packed_git *p,
1871 struct pack_window **w_curs,
1872 off_t *curpos,
1873 enum object_type type,
1874 off_t delta_obj_offset)
1876 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1877 off_t base_offset;
1879 /* use_pack() assured us we have [base_info, base_info + 20)
1880 * as a range that we can look at without walking off the
1881 * end of the mapped window. Its actually the hash size
1882 * that is assured. An OFS_DELTA longer than the hash size
1883 * is stupid, as then a REF_DELTA would be smaller to store.
1885 if (type == OBJ_OFS_DELTA) {
1886 unsigned used = 0;
1887 unsigned char c = base_info[used++];
1888 base_offset = c & 127;
1889 while (c & 128) {
1890 base_offset += 1;
1891 if (!base_offset || MSB(base_offset, 7))
1892 return 0; /* overflow */
1893 c = base_info[used++];
1894 base_offset = (base_offset << 7) + (c & 127);
1896 base_offset = delta_obj_offset - base_offset;
1897 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1898 return 0; /* out of bound */
1899 *curpos += used;
1900 } else if (type == OBJ_REF_DELTA) {
1901 /* The base entry _must_ be in the same pack */
1902 base_offset = find_pack_entry_one(base_info, p);
1903 *curpos += 20;
1904 } else
1905 die("I am totally screwed");
1906 return base_offset;
1910 * Like get_delta_base above, but we return the sha1 instead of the pack
1911 * offset. This means it is cheaper for REF deltas (we do not have to do
1912 * the final object lookup), but more expensive for OFS deltas (we
1913 * have to load the revidx to convert the offset back into a sha1).
1915 static const unsigned char *get_delta_base_sha1(struct packed_git *p,
1916 struct pack_window **w_curs,
1917 off_t curpos,
1918 enum object_type type,
1919 off_t delta_obj_offset)
1921 if (type == OBJ_REF_DELTA) {
1922 unsigned char *base = use_pack(p, w_curs, curpos, NULL);
1923 return base;
1924 } else if (type == OBJ_OFS_DELTA) {
1925 struct revindex_entry *revidx;
1926 off_t base_offset = get_delta_base(p, w_curs, &curpos,
1927 type, delta_obj_offset);
1929 if (!base_offset)
1930 return NULL;
1932 revidx = find_pack_revindex(p, base_offset);
1933 if (!revidx)
1934 return NULL;
1936 return nth_packed_object_sha1(p, revidx->nr);
1937 } else
1938 return NULL;
1941 int unpack_object_header(struct packed_git *p,
1942 struct pack_window **w_curs,
1943 off_t *curpos,
1944 unsigned long *sizep)
1946 unsigned char *base;
1947 unsigned long left;
1948 unsigned long used;
1949 enum object_type type;
1951 /* use_pack() assures us we have [base, base + 20) available
1952 * as a range that we can look at. (Its actually the hash
1953 * size that is assured.) With our object header encoding
1954 * the maximum deflated object size is 2^137, which is just
1955 * insane, so we know won't exceed what we have been given.
1957 base = use_pack(p, w_curs, *curpos, &left);
1958 used = unpack_object_header_buffer(base, left, &type, sizep);
1959 if (!used) {
1960 type = OBJ_BAD;
1961 } else
1962 *curpos += used;
1964 return type;
1967 static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
1969 int type;
1970 struct revindex_entry *revidx;
1971 const unsigned char *sha1;
1972 revidx = find_pack_revindex(p, obj_offset);
1973 if (!revidx)
1974 return OBJ_BAD;
1975 sha1 = nth_packed_object_sha1(p, revidx->nr);
1976 mark_bad_packed_object(p, sha1);
1977 type = sha1_object_info(sha1, NULL);
1978 if (type <= OBJ_NONE)
1979 return OBJ_BAD;
1980 return type;
1983 #define POI_STACK_PREALLOC 64
1985 static enum object_type packed_to_object_type(struct packed_git *p,
1986 off_t obj_offset,
1987 enum object_type type,
1988 struct pack_window **w_curs,
1989 off_t curpos)
1991 off_t small_poi_stack[POI_STACK_PREALLOC];
1992 off_t *poi_stack = small_poi_stack;
1993 int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
1995 while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1996 off_t base_offset;
1997 unsigned long size;
1998 /* Push the object we're going to leave behind */
1999 if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
2000 poi_stack_alloc = alloc_nr(poi_stack_nr);
2001 ALLOC_ARRAY(poi_stack, poi_stack_alloc);
2002 memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
2003 } else {
2004 ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
2006 poi_stack[poi_stack_nr++] = obj_offset;
2007 /* If parsing the base offset fails, just unwind */
2008 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
2009 if (!base_offset)
2010 goto unwind;
2011 curpos = obj_offset = base_offset;
2012 type = unpack_object_header(p, w_curs, &curpos, &size);
2013 if (type <= OBJ_NONE) {
2014 /* If getting the base itself fails, we first
2015 * retry the base, otherwise unwind */
2016 type = retry_bad_packed_offset(p, base_offset);
2017 if (type > OBJ_NONE)
2018 goto out;
2019 goto unwind;
2023 switch (type) {
2024 case OBJ_BAD:
2025 case OBJ_COMMIT:
2026 case OBJ_TREE:
2027 case OBJ_BLOB:
2028 case OBJ_TAG:
2029 break;
2030 default:
2031 error("unknown object type %i at offset %"PRIuMAX" in %s",
2032 type, (uintmax_t)obj_offset, p->pack_name);
2033 type = OBJ_BAD;
2036 out:
2037 if (poi_stack != small_poi_stack)
2038 free(poi_stack);
2039 return type;
2041 unwind:
2042 while (poi_stack_nr) {
2043 obj_offset = poi_stack[--poi_stack_nr];
2044 type = retry_bad_packed_offset(p, obj_offset);
2045 if (type > OBJ_NONE)
2046 goto out;
2048 type = OBJ_BAD;
2049 goto out;
2052 static int packed_object_info(struct packed_git *p, off_t obj_offset,
2053 struct object_info *oi)
2055 struct pack_window *w_curs = NULL;
2056 unsigned long size;
2057 off_t curpos = obj_offset;
2058 enum object_type type;
2061 * We always get the representation type, but only convert it to
2062 * a "real" type later if the caller is interested.
2064 type = unpack_object_header(p, &w_curs, &curpos, &size);
2066 if (oi->sizep) {
2067 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2068 off_t tmp_pos = curpos;
2069 off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
2070 type, obj_offset);
2071 if (!base_offset) {
2072 type = OBJ_BAD;
2073 goto out;
2075 *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
2076 if (*oi->sizep == 0) {
2077 type = OBJ_BAD;
2078 goto out;
2080 } else {
2081 *oi->sizep = size;
2085 if (oi->disk_sizep) {
2086 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2087 *oi->disk_sizep = revidx[1].offset - obj_offset;
2090 if (oi->typep) {
2091 *oi->typep = packed_to_object_type(p, obj_offset, type, &w_curs, curpos);
2092 if (*oi->typep < 0) {
2093 type = OBJ_BAD;
2094 goto out;
2098 if (oi->delta_base_sha1) {
2099 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2100 const unsigned char *base;
2102 base = get_delta_base_sha1(p, &w_curs, curpos,
2103 type, obj_offset);
2104 if (!base) {
2105 type = OBJ_BAD;
2106 goto out;
2109 hashcpy(oi->delta_base_sha1, base);
2110 } else
2111 hashclr(oi->delta_base_sha1);
2114 out:
2115 unuse_pack(&w_curs);
2116 return type;
2119 static void *unpack_compressed_entry(struct packed_git *p,
2120 struct pack_window **w_curs,
2121 off_t curpos,
2122 unsigned long size)
2124 int st;
2125 git_zstream stream;
2126 unsigned char *buffer, *in;
2128 buffer = xmallocz_gently(size);
2129 if (!buffer)
2130 return NULL;
2131 memset(&stream, 0, sizeof(stream));
2132 stream.next_out = buffer;
2133 stream.avail_out = size + 1;
2135 git_inflate_init(&stream);
2136 do {
2137 in = use_pack(p, w_curs, curpos, &stream.avail_in);
2138 stream.next_in = in;
2139 st = git_inflate(&stream, Z_FINISH);
2140 if (!stream.avail_out)
2141 break; /* the payload is larger than it should be */
2142 curpos += stream.next_in - in;
2143 } while (st == Z_OK || st == Z_BUF_ERROR);
2144 git_inflate_end(&stream);
2145 if ((st != Z_STREAM_END) || stream.total_out != size) {
2146 free(buffer);
2147 return NULL;
2150 return buffer;
2153 static struct hashmap delta_base_cache;
2154 static size_t delta_base_cached;
2156 static LIST_HEAD(delta_base_cache_lru);
2158 struct delta_base_cache_key {
2159 struct packed_git *p;
2160 off_t base_offset;
2163 struct delta_base_cache_entry {
2164 struct hashmap hash;
2165 struct delta_base_cache_key key;
2166 struct list_head lru;
2167 void *data;
2168 unsigned long size;
2169 enum object_type type;
2172 static unsigned int pack_entry_hash(struct packed_git *p, off_t base_offset)
2174 unsigned int hash;
2176 hash = (unsigned int)(intptr_t)p + (unsigned int)base_offset;
2177 hash += (hash >> 8) + (hash >> 16);
2178 return hash;
2181 static struct delta_base_cache_entry *
2182 get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
2184 struct hashmap_entry entry;
2185 struct delta_base_cache_key key;
2187 if (!delta_base_cache.cmpfn)
2188 return NULL;
2190 hashmap_entry_init(&entry, pack_entry_hash(p, base_offset));
2191 key.p = p;
2192 key.base_offset = base_offset;
2193 return hashmap_get(&delta_base_cache, &entry, &key);
2196 static int delta_base_cache_key_eq(const struct delta_base_cache_key *a,
2197 const struct delta_base_cache_key *b)
2199 return a->p == b->p && a->base_offset == b->base_offset;
2202 static int delta_base_cache_hash_cmp(const void *va, const void *vb,
2203 const void *vkey)
2205 const struct delta_base_cache_entry *a = va, *b = vb;
2206 const struct delta_base_cache_key *key = vkey;
2207 if (key)
2208 return !delta_base_cache_key_eq(&a->key, key);
2209 else
2210 return !delta_base_cache_key_eq(&a->key, &b->key);
2213 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
2215 return !!get_delta_base_cache_entry(p, base_offset);
2219 * Remove the entry from the cache, but do _not_ free the associated
2220 * entry data. The caller takes ownership of the "data" buffer, and
2221 * should copy out any fields it wants before detaching.
2223 static void detach_delta_base_cache_entry(struct delta_base_cache_entry *ent)
2225 hashmap_remove(&delta_base_cache, ent, &ent->key);
2226 list_del(&ent->lru);
2227 delta_base_cached -= ent->size;
2228 free(ent);
2231 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
2232 unsigned long *base_size, enum object_type *type)
2234 struct delta_base_cache_entry *ent;
2236 ent = get_delta_base_cache_entry(p, base_offset);
2237 if (!ent)
2238 return unpack_entry(p, base_offset, type, base_size);
2240 *type = ent->type;
2241 *base_size = ent->size;
2242 return xmemdupz(ent->data, ent->size);
2245 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
2247 free(ent->data);
2248 detach_delta_base_cache_entry(ent);
2251 void clear_delta_base_cache(void)
2253 struct hashmap_iter iter;
2254 struct delta_base_cache_entry *entry;
2255 for (entry = hashmap_iter_first(&delta_base_cache, &iter);
2256 entry;
2257 entry = hashmap_iter_next(&iter)) {
2258 release_delta_base_cache(entry);
2262 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
2263 void *base, unsigned long base_size, enum object_type type)
2265 struct delta_base_cache_entry *ent = xmalloc(sizeof(*ent));
2266 struct list_head *lru;
2268 delta_base_cached += base_size;
2270 list_for_each(lru, &delta_base_cache_lru) {
2271 struct delta_base_cache_entry *f =
2272 list_entry(lru, struct delta_base_cache_entry, lru);
2273 if (delta_base_cached <= delta_base_cache_limit)
2274 break;
2275 release_delta_base_cache(f);
2278 ent->key.p = p;
2279 ent->key.base_offset = base_offset;
2280 ent->type = type;
2281 ent->data = base;
2282 ent->size = base_size;
2283 list_add_tail(&ent->lru, &delta_base_cache_lru);
2285 if (!delta_base_cache.cmpfn)
2286 hashmap_init(&delta_base_cache, delta_base_cache_hash_cmp, 0);
2287 hashmap_entry_init(ent, pack_entry_hash(p, base_offset));
2288 hashmap_add(&delta_base_cache, ent);
2291 static void *read_object(const unsigned char *sha1, enum object_type *type,
2292 unsigned long *size);
2294 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
2296 static struct trace_key pack_access = TRACE_KEY_INIT(PACK_ACCESS);
2297 trace_printf_key(&pack_access, "%s %"PRIuMAX"\n",
2298 p->pack_name, (uintmax_t)obj_offset);
2301 int do_check_packed_object_crc;
2303 #define UNPACK_ENTRY_STACK_PREALLOC 64
2304 struct unpack_entry_stack_ent {
2305 off_t obj_offset;
2306 off_t curpos;
2307 unsigned long size;
2310 void *unpack_entry(struct packed_git *p, off_t obj_offset,
2311 enum object_type *final_type, unsigned long *final_size)
2313 struct pack_window *w_curs = NULL;
2314 off_t curpos = obj_offset;
2315 void *data = NULL;
2316 unsigned long size;
2317 enum object_type type;
2318 struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
2319 struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
2320 int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
2321 int base_from_cache = 0;
2323 write_pack_access_log(p, obj_offset);
2325 /* PHASE 1: drill down to the innermost base object */
2326 for (;;) {
2327 off_t base_offset;
2328 int i;
2329 struct delta_base_cache_entry *ent;
2331 ent = get_delta_base_cache_entry(p, curpos);
2332 if (ent) {
2333 type = ent->type;
2334 data = ent->data;
2335 size = ent->size;
2336 detach_delta_base_cache_entry(ent);
2337 base_from_cache = 1;
2338 break;
2341 if (do_check_packed_object_crc && p->index_version > 1) {
2342 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2343 off_t len = revidx[1].offset - obj_offset;
2344 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
2345 const unsigned char *sha1 =
2346 nth_packed_object_sha1(p, revidx->nr);
2347 error("bad packed object CRC for %s",
2348 sha1_to_hex(sha1));
2349 mark_bad_packed_object(p, sha1);
2350 unuse_pack(&w_curs);
2351 return NULL;
2355 type = unpack_object_header(p, &w_curs, &curpos, &size);
2356 if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
2357 break;
2359 base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
2360 if (!base_offset) {
2361 error("failed to validate delta base reference "
2362 "at offset %"PRIuMAX" from %s",
2363 (uintmax_t)curpos, p->pack_name);
2364 /* bail to phase 2, in hopes of recovery */
2365 data = NULL;
2366 break;
2369 /* push object, proceed to base */
2370 if (delta_stack_nr >= delta_stack_alloc
2371 && delta_stack == small_delta_stack) {
2372 delta_stack_alloc = alloc_nr(delta_stack_nr);
2373 ALLOC_ARRAY(delta_stack, delta_stack_alloc);
2374 memcpy(delta_stack, small_delta_stack,
2375 sizeof(*delta_stack)*delta_stack_nr);
2376 } else {
2377 ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
2379 i = delta_stack_nr++;
2380 delta_stack[i].obj_offset = obj_offset;
2381 delta_stack[i].curpos = curpos;
2382 delta_stack[i].size = size;
2384 curpos = obj_offset = base_offset;
2387 /* PHASE 2: handle the base */
2388 switch (type) {
2389 case OBJ_OFS_DELTA:
2390 case OBJ_REF_DELTA:
2391 if (data)
2392 die("BUG: unpack_entry: left loop at a valid delta");
2393 break;
2394 case OBJ_COMMIT:
2395 case OBJ_TREE:
2396 case OBJ_BLOB:
2397 case OBJ_TAG:
2398 if (!base_from_cache)
2399 data = unpack_compressed_entry(p, &w_curs, curpos, size);
2400 break;
2401 default:
2402 data = NULL;
2403 error("unknown object type %i at offset %"PRIuMAX" in %s",
2404 type, (uintmax_t)obj_offset, p->pack_name);
2407 /* PHASE 3: apply deltas in order */
2409 /* invariants:
2410 * 'data' holds the base data, or NULL if there was corruption
2412 while (delta_stack_nr) {
2413 void *delta_data;
2414 void *base = data;
2415 unsigned long delta_size, base_size = size;
2416 int i;
2418 data = NULL;
2420 if (base)
2421 add_delta_base_cache(p, obj_offset, base, base_size, type);
2423 if (!base) {
2425 * We're probably in deep shit, but let's try to fetch
2426 * the required base anyway from another pack or loose.
2427 * This is costly but should happen only in the presence
2428 * of a corrupted pack, and is better than failing outright.
2430 struct revindex_entry *revidx;
2431 const unsigned char *base_sha1;
2432 revidx = find_pack_revindex(p, obj_offset);
2433 if (revidx) {
2434 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
2435 error("failed to read delta base object %s"
2436 " at offset %"PRIuMAX" from %s",
2437 sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
2438 p->pack_name);
2439 mark_bad_packed_object(p, base_sha1);
2440 base = read_object(base_sha1, &type, &base_size);
2444 i = --delta_stack_nr;
2445 obj_offset = delta_stack[i].obj_offset;
2446 curpos = delta_stack[i].curpos;
2447 delta_size = delta_stack[i].size;
2449 if (!base)
2450 continue;
2452 delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
2454 if (!delta_data) {
2455 error("failed to unpack compressed delta "
2456 "at offset %"PRIuMAX" from %s",
2457 (uintmax_t)curpos, p->pack_name);
2458 data = NULL;
2459 continue;
2462 data = patch_delta(base, base_size,
2463 delta_data, delta_size,
2464 &size);
2467 * We could not apply the delta; warn the user, but keep going.
2468 * Our failure will be noticed either in the next iteration of
2469 * the loop, or if this is the final delta, in the caller when
2470 * we return NULL. Those code paths will take care of making
2471 * a more explicit warning and retrying with another copy of
2472 * the object.
2474 if (!data)
2475 error("failed to apply delta");
2477 free(delta_data);
2480 *final_type = type;
2481 *final_size = size;
2483 unuse_pack(&w_curs);
2485 if (delta_stack != small_delta_stack)
2486 free(delta_stack);
2488 return data;
2491 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2492 uint32_t n)
2494 const unsigned char *index = p->index_data;
2495 if (!index) {
2496 if (open_pack_index(p))
2497 return NULL;
2498 index = p->index_data;
2500 if (n >= p->num_objects)
2501 return NULL;
2502 index += 4 * 256;
2503 if (p->index_version == 1) {
2504 return index + 24 * n + 4;
2505 } else {
2506 index += 8;
2507 return index + 20 * n;
2511 void check_pack_index_ptr(const struct packed_git *p, const void *vptr)
2513 const unsigned char *ptr = vptr;
2514 const unsigned char *start = p->index_data;
2515 const unsigned char *end = start + p->index_size;
2516 if (ptr < start)
2517 die(_("offset before start of pack index for %s (corrupt index?)"),
2518 p->pack_name);
2519 /* No need to check for underflow; .idx files must be at least 8 bytes */
2520 if (ptr >= end - 8)
2521 die(_("offset beyond end of pack index for %s (truncated index?)"),
2522 p->pack_name);
2525 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2527 const unsigned char *index = p->index_data;
2528 index += 4 * 256;
2529 if (p->index_version == 1) {
2530 return ntohl(*((uint32_t *)(index + 24 * n)));
2531 } else {
2532 uint32_t off;
2533 index += 8 + p->num_objects * (20 + 4);
2534 off = ntohl(*((uint32_t *)(index + 4 * n)));
2535 if (!(off & 0x80000000))
2536 return off;
2537 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2538 check_pack_index_ptr(p, index);
2539 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2540 ntohl(*((uint32_t *)(index + 4)));
2544 off_t find_pack_entry_one(const unsigned char *sha1,
2545 struct packed_git *p)
2547 const uint32_t *level1_ofs = p->index_data;
2548 const unsigned char *index = p->index_data;
2549 unsigned hi, lo, stride;
2550 static int use_lookup = -1;
2551 static int debug_lookup = -1;
2553 if (debug_lookup < 0)
2554 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2556 if (!index) {
2557 if (open_pack_index(p))
2558 return 0;
2559 level1_ofs = p->index_data;
2560 index = p->index_data;
2562 if (p->index_version > 1) {
2563 level1_ofs += 2;
2564 index += 8;
2566 index += 4 * 256;
2567 hi = ntohl(level1_ofs[*sha1]);
2568 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2569 if (p->index_version > 1) {
2570 stride = 20;
2571 } else {
2572 stride = 24;
2573 index += 4;
2576 if (debug_lookup)
2577 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2578 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2580 if (use_lookup < 0)
2581 use_lookup = !!getenv("GIT_USE_LOOKUP");
2582 if (use_lookup) {
2583 int pos = sha1_entry_pos(index, stride, 0,
2584 lo, hi, p->num_objects, sha1);
2585 if (pos < 0)
2586 return 0;
2587 return nth_packed_object_offset(p, pos);
2590 do {
2591 unsigned mi = (lo + hi) / 2;
2592 int cmp = hashcmp(index + mi * stride, sha1);
2594 if (debug_lookup)
2595 printf("lo %u hi %u rg %u mi %u\n",
2596 lo, hi, hi - lo, mi);
2597 if (!cmp)
2598 return nth_packed_object_offset(p, mi);
2599 if (cmp > 0)
2600 hi = mi;
2601 else
2602 lo = mi+1;
2603 } while (lo < hi);
2604 return 0;
2607 int is_pack_valid(struct packed_git *p)
2609 /* An already open pack is known to be valid. */
2610 if (p->pack_fd != -1)
2611 return 1;
2613 /* If the pack has one window completely covering the
2614 * file size, the pack is known to be valid even if
2615 * the descriptor is not currently open.
2617 if (p->windows) {
2618 struct pack_window *w = p->windows;
2620 if (!w->offset && w->len == p->pack_size)
2621 return 1;
2624 /* Force the pack to open to prove its valid. */
2625 return !open_packed_git(p);
2628 static int fill_pack_entry(const unsigned char *sha1,
2629 struct pack_entry *e,
2630 struct packed_git *p)
2632 off_t offset;
2634 if (p->num_bad_objects) {
2635 unsigned i;
2636 for (i = 0; i < p->num_bad_objects; i++)
2637 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2638 return 0;
2641 offset = find_pack_entry_one(sha1, p);
2642 if (!offset)
2643 return 0;
2646 * We are about to tell the caller where they can locate the
2647 * requested object. We better make sure the packfile is
2648 * still here and can be accessed before supplying that
2649 * answer, as it may have been deleted since the index was
2650 * loaded!
2652 if (!is_pack_valid(p))
2653 return 0;
2654 e->offset = offset;
2655 e->p = p;
2656 hashcpy(e->sha1, sha1);
2657 return 1;
2661 * Iff a pack file contains the object named by sha1, return true and
2662 * store its location to e.
2664 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2666 struct mru_entry *p;
2668 prepare_packed_git();
2669 if (!packed_git)
2670 return 0;
2672 for (p = packed_git_mru->head; p; p = p->next) {
2673 if (fill_pack_entry(sha1, e, p->item)) {
2674 mru_mark(packed_git_mru, p);
2675 return 1;
2678 return 0;
2681 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2682 struct packed_git *packs)
2684 struct packed_git *p;
2686 for (p = packs; p; p = p->next) {
2687 if (find_pack_entry_one(sha1, p))
2688 return p;
2690 return NULL;
2694 static int sha1_loose_object_info(const unsigned char *sha1,
2695 struct object_info *oi,
2696 int flags)
2698 int status = 0;
2699 unsigned long mapsize;
2700 void *map;
2701 git_zstream stream;
2702 char hdr[32];
2703 struct strbuf hdrbuf = STRBUF_INIT;
2705 if (oi->delta_base_sha1)
2706 hashclr(oi->delta_base_sha1);
2709 * If we don't care about type or size, then we don't
2710 * need to look inside the object at all. Note that we
2711 * do not optimize out the stat call, even if the
2712 * caller doesn't care about the disk-size, since our
2713 * return value implicitly indicates whether the
2714 * object even exists.
2716 if (!oi->typep && !oi->typename && !oi->sizep) {
2717 struct stat st;
2718 if (stat_sha1_file(sha1, &st) < 0)
2719 return -1;
2720 if (oi->disk_sizep)
2721 *oi->disk_sizep = st.st_size;
2722 return 0;
2725 map = map_sha1_file(sha1, &mapsize);
2726 if (!map)
2727 return -1;
2728 if (oi->disk_sizep)
2729 *oi->disk_sizep = mapsize;
2730 if ((flags & LOOKUP_UNKNOWN_OBJECT)) {
2731 if (unpack_sha1_header_to_strbuf(&stream, map, mapsize, hdr, sizeof(hdr), &hdrbuf) < 0)
2732 status = error("unable to unpack %s header with --allow-unknown-type",
2733 sha1_to_hex(sha1));
2734 } else if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2735 status = error("unable to unpack %s header",
2736 sha1_to_hex(sha1));
2737 if (status < 0)
2738 ; /* Do nothing */
2739 else if (hdrbuf.len) {
2740 if ((status = parse_sha1_header_extended(hdrbuf.buf, oi, flags)) < 0)
2741 status = error("unable to parse %s header with --allow-unknown-type",
2742 sha1_to_hex(sha1));
2743 } else if ((status = parse_sha1_header_extended(hdr, oi, flags)) < 0)
2744 status = error("unable to parse %s header", sha1_to_hex(sha1));
2745 git_inflate_end(&stream);
2746 munmap(map, mapsize);
2747 if (status && oi->typep)
2748 *oi->typep = status;
2749 strbuf_release(&hdrbuf);
2750 return 0;
2753 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi, unsigned flags)
2755 struct cached_object *co;
2756 struct pack_entry e;
2757 int rtype;
2758 enum object_type real_type;
2759 const unsigned char *real = lookup_replace_object_extended(sha1, flags);
2761 co = find_cached_object(real);
2762 if (co) {
2763 if (oi->typep)
2764 *(oi->typep) = co->type;
2765 if (oi->sizep)
2766 *(oi->sizep) = co->size;
2767 if (oi->disk_sizep)
2768 *(oi->disk_sizep) = 0;
2769 if (oi->delta_base_sha1)
2770 hashclr(oi->delta_base_sha1);
2771 if (oi->typename)
2772 strbuf_addstr(oi->typename, typename(co->type));
2773 oi->whence = OI_CACHED;
2774 return 0;
2777 if (!find_pack_entry(real, &e)) {
2778 /* Most likely it's a loose object. */
2779 if (!sha1_loose_object_info(real, oi, flags)) {
2780 oi->whence = OI_LOOSE;
2781 return 0;
2784 /* Not a loose object; someone else may have just packed it. */
2785 reprepare_packed_git();
2786 if (!find_pack_entry(real, &e))
2787 return -1;
2791 * packed_object_info() does not follow the delta chain to
2792 * find out the real type, unless it is given oi->typep.
2794 if (oi->typename && !oi->typep)
2795 oi->typep = &real_type;
2797 rtype = packed_object_info(e.p, e.offset, oi);
2798 if (rtype < 0) {
2799 mark_bad_packed_object(e.p, real);
2800 if (oi->typep == &real_type)
2801 oi->typep = NULL;
2802 return sha1_object_info_extended(real, oi, 0);
2803 } else if (in_delta_base_cache(e.p, e.offset)) {
2804 oi->whence = OI_DBCACHED;
2805 } else {
2806 oi->whence = OI_PACKED;
2807 oi->u.packed.offset = e.offset;
2808 oi->u.packed.pack = e.p;
2809 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2810 rtype == OBJ_OFS_DELTA);
2812 if (oi->typename)
2813 strbuf_addstr(oi->typename, typename(*oi->typep));
2814 if (oi->typep == &real_type)
2815 oi->typep = NULL;
2817 return 0;
2820 /* returns enum object_type or negative */
2821 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2823 enum object_type type;
2824 struct object_info oi = {NULL};
2826 oi.typep = &type;
2827 oi.sizep = sizep;
2828 if (sha1_object_info_extended(sha1, &oi, LOOKUP_REPLACE_OBJECT) < 0)
2829 return -1;
2830 return type;
2833 static void *read_packed_sha1(const unsigned char *sha1,
2834 enum object_type *type, unsigned long *size)
2836 struct pack_entry e;
2837 void *data;
2839 if (!find_pack_entry(sha1, &e))
2840 return NULL;
2841 data = cache_or_unpack_entry(e.p, e.offset, size, type);
2842 if (!data) {
2844 * We're probably in deep shit, but let's try to fetch
2845 * the required object anyway from another pack or loose.
2846 * This should happen only in the presence of a corrupted
2847 * pack, and is better than failing outright.
2849 error("failed to read object %s at offset %"PRIuMAX" from %s",
2850 sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2851 mark_bad_packed_object(e.p, sha1);
2852 data = read_object(sha1, type, size);
2854 return data;
2857 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2858 unsigned char *sha1)
2860 struct cached_object *co;
2862 hash_sha1_file(buf, len, typename(type), sha1);
2863 if (has_sha1_file(sha1) || find_cached_object(sha1))
2864 return 0;
2865 ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
2866 co = &cached_objects[cached_object_nr++];
2867 co->size = len;
2868 co->type = type;
2869 co->buf = xmalloc(len);
2870 memcpy(co->buf, buf, len);
2871 hashcpy(co->sha1, sha1);
2872 return 0;
2875 static void *read_object(const unsigned char *sha1, enum object_type *type,
2876 unsigned long *size)
2878 unsigned long mapsize;
2879 void *map, *buf;
2880 struct cached_object *co;
2882 co = find_cached_object(sha1);
2883 if (co) {
2884 *type = co->type;
2885 *size = co->size;
2886 return xmemdupz(co->buf, co->size);
2889 buf = read_packed_sha1(sha1, type, size);
2890 if (buf)
2891 return buf;
2892 map = map_sha1_file(sha1, &mapsize);
2893 if (map) {
2894 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2895 munmap(map, mapsize);
2896 return buf;
2898 reprepare_packed_git();
2899 return read_packed_sha1(sha1, type, size);
2903 * This function dies on corrupt objects; the callers who want to
2904 * deal with them should arrange to call read_object() and give error
2905 * messages themselves.
2907 void *read_sha1_file_extended(const unsigned char *sha1,
2908 enum object_type *type,
2909 unsigned long *size,
2910 unsigned flag)
2912 void *data;
2913 const struct packed_git *p;
2914 const unsigned char *repl = lookup_replace_object_extended(sha1, flag);
2916 errno = 0;
2917 data = read_object(repl, type, size);
2918 if (data)
2919 return data;
2921 if (errno && errno != ENOENT)
2922 die_errno("failed to read object %s", sha1_to_hex(sha1));
2924 /* die if we replaced an object with one that does not exist */
2925 if (repl != sha1)
2926 die("replacement %s not found for %s",
2927 sha1_to_hex(repl), sha1_to_hex(sha1));
2929 if (has_loose_object(repl)) {
2930 const char *path = sha1_file_name(sha1);
2932 die("loose object %s (stored in %s) is corrupt",
2933 sha1_to_hex(repl), path);
2936 if ((p = has_packed_and_bad(repl)) != NULL)
2937 die("packed object %s (stored in %s) is corrupt",
2938 sha1_to_hex(repl), p->pack_name);
2940 return NULL;
2943 void *read_object_with_reference(const unsigned char *sha1,
2944 const char *required_type_name,
2945 unsigned long *size,
2946 unsigned char *actual_sha1_return)
2948 enum object_type type, required_type;
2949 void *buffer;
2950 unsigned long isize;
2951 unsigned char actual_sha1[20];
2953 required_type = type_from_string(required_type_name);
2954 hashcpy(actual_sha1, sha1);
2955 while (1) {
2956 int ref_length = -1;
2957 const char *ref_type = NULL;
2959 buffer = read_sha1_file(actual_sha1, &type, &isize);
2960 if (!buffer)
2961 return NULL;
2962 if (type == required_type) {
2963 *size = isize;
2964 if (actual_sha1_return)
2965 hashcpy(actual_sha1_return, actual_sha1);
2966 return buffer;
2968 /* Handle references */
2969 else if (type == OBJ_COMMIT)
2970 ref_type = "tree ";
2971 else if (type == OBJ_TAG)
2972 ref_type = "object ";
2973 else {
2974 free(buffer);
2975 return NULL;
2977 ref_length = strlen(ref_type);
2979 if (ref_length + 40 > isize ||
2980 memcmp(buffer, ref_type, ref_length) ||
2981 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
2982 free(buffer);
2983 return NULL;
2985 free(buffer);
2986 /* Now we have the ID of the referred-to object in
2987 * actual_sha1. Check again. */
2991 static void write_sha1_file_prepare(const void *buf, unsigned long len,
2992 const char *type, unsigned char *sha1,
2993 char *hdr, int *hdrlen)
2995 git_SHA_CTX c;
2997 /* Generate the header */
2998 *hdrlen = xsnprintf(hdr, *hdrlen, "%s %lu", type, len)+1;
3000 /* Sha1.. */
3001 git_SHA1_Init(&c);
3002 git_SHA1_Update(&c, hdr, *hdrlen);
3003 git_SHA1_Update(&c, buf, len);
3004 git_SHA1_Final(sha1, &c);
3008 * Move the just written object into its final resting place.
3010 int finalize_object_file(const char *tmpfile, const char *filename)
3012 int ret = 0;
3014 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
3015 goto try_rename;
3016 else if (link(tmpfile, filename))
3017 ret = errno;
3020 * Coda hack - coda doesn't like cross-directory links,
3021 * so we fall back to a rename, which will mean that it
3022 * won't be able to check collisions, but that's not a
3023 * big deal.
3025 * The same holds for FAT formatted media.
3027 * When this succeeds, we just return. We have nothing
3028 * left to unlink.
3030 if (ret && ret != EEXIST) {
3031 try_rename:
3032 if (!rename(tmpfile, filename))
3033 goto out;
3034 ret = errno;
3036 unlink_or_warn(tmpfile);
3037 if (ret) {
3038 if (ret != EEXIST) {
3039 return error_errno("unable to write sha1 filename %s", filename);
3041 /* FIXME!!! Collision check here ? */
3044 out:
3045 if (adjust_shared_perm(filename))
3046 return error("unable to set permission to '%s'", filename);
3047 return 0;
3050 static int write_buffer(int fd, const void *buf, size_t len)
3052 if (write_in_full(fd, buf, len) < 0)
3053 return error_errno("file write error");
3054 return 0;
3057 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
3058 unsigned char *sha1)
3060 char hdr[32];
3061 int hdrlen = sizeof(hdr);
3062 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3063 return 0;
3066 /* Finalize a file on disk, and close it. */
3067 static void close_sha1_file(int fd)
3069 if (fsync_object_files)
3070 fsync_or_die(fd, "sha1 file");
3071 if (close(fd) != 0)
3072 die_errno("error when closing sha1 file");
3075 /* Size of directory component, including the ending '/' */
3076 static inline int directory_size(const char *filename)
3078 const char *s = strrchr(filename, '/');
3079 if (!s)
3080 return 0;
3081 return s - filename + 1;
3085 * This creates a temporary file in the same directory as the final
3086 * 'filename'
3088 * We want to avoid cross-directory filename renames, because those
3089 * can have problems on various filesystems (FAT, NFS, Coda).
3091 static int create_tmpfile(struct strbuf *tmp, const char *filename)
3093 int fd, dirlen = directory_size(filename);
3095 strbuf_reset(tmp);
3096 strbuf_add(tmp, filename, dirlen);
3097 strbuf_addstr(tmp, "tmp_obj_XXXXXX");
3098 fd = git_mkstemp_mode(tmp->buf, 0444);
3099 if (fd < 0 && dirlen && errno == ENOENT) {
3101 * Make sure the directory exists; note that the contents
3102 * of the buffer are undefined after mkstemp returns an
3103 * error, so we have to rewrite the whole buffer from
3104 * scratch.
3106 strbuf_reset(tmp);
3107 strbuf_add(tmp, filename, dirlen - 1);
3108 if (mkdir(tmp->buf, 0777) && errno != EEXIST)
3109 return -1;
3110 if (adjust_shared_perm(tmp->buf))
3111 return -1;
3113 /* Try again */
3114 strbuf_addstr(tmp, "/tmp_obj_XXXXXX");
3115 fd = git_mkstemp_mode(tmp->buf, 0444);
3117 return fd;
3120 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
3121 const void *buf, unsigned long len, time_t mtime)
3123 int fd, ret;
3124 unsigned char compressed[4096];
3125 git_zstream stream;
3126 git_SHA_CTX c;
3127 unsigned char parano_sha1[20];
3128 static struct strbuf tmp_file = STRBUF_INIT;
3129 const char *filename = sha1_file_name(sha1);
3131 fd = create_tmpfile(&tmp_file, filename);
3132 if (fd < 0) {
3133 if (errno == EACCES)
3134 return error("insufficient permission for adding an object to repository database %s", get_object_directory());
3135 else
3136 return error_errno("unable to create temporary file");
3139 /* Set it up */
3140 git_deflate_init(&stream, zlib_compression_level);
3141 stream.next_out = compressed;
3142 stream.avail_out = sizeof(compressed);
3143 git_SHA1_Init(&c);
3145 /* First header.. */
3146 stream.next_in = (unsigned char *)hdr;
3147 stream.avail_in = hdrlen;
3148 while (git_deflate(&stream, 0) == Z_OK)
3149 ; /* nothing */
3150 git_SHA1_Update(&c, hdr, hdrlen);
3152 /* Then the data itself.. */
3153 stream.next_in = (void *)buf;
3154 stream.avail_in = len;
3155 do {
3156 unsigned char *in0 = stream.next_in;
3157 ret = git_deflate(&stream, Z_FINISH);
3158 git_SHA1_Update(&c, in0, stream.next_in - in0);
3159 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
3160 die("unable to write sha1 file");
3161 stream.next_out = compressed;
3162 stream.avail_out = sizeof(compressed);
3163 } while (ret == Z_OK);
3165 if (ret != Z_STREAM_END)
3166 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
3167 ret = git_deflate_end_gently(&stream);
3168 if (ret != Z_OK)
3169 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
3170 git_SHA1_Final(parano_sha1, &c);
3171 if (hashcmp(sha1, parano_sha1) != 0)
3172 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
3174 close_sha1_file(fd);
3176 if (mtime) {
3177 struct utimbuf utb;
3178 utb.actime = mtime;
3179 utb.modtime = mtime;
3180 if (utime(tmp_file.buf, &utb) < 0)
3181 warning_errno("failed utime() on %s", tmp_file.buf);
3184 return finalize_object_file(tmp_file.buf, filename);
3187 static int freshen_loose_object(const unsigned char *sha1)
3189 return check_and_freshen(sha1, 1);
3192 static int freshen_packed_object(const unsigned char *sha1)
3194 struct pack_entry e;
3195 if (!find_pack_entry(sha1, &e))
3196 return 0;
3197 if (e.p->freshened)
3198 return 1;
3199 if (!freshen_file(e.p->pack_name))
3200 return 0;
3201 e.p->freshened = 1;
3202 return 1;
3205 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1)
3207 char hdr[32];
3208 int hdrlen = sizeof(hdr);
3210 /* Normally if we have it in the pack then we do not bother writing
3211 * it out into .git/objects/??/?{38} file.
3213 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3214 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3215 return 0;
3216 return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
3219 int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type,
3220 unsigned char *sha1, unsigned flags)
3222 char *header;
3223 int hdrlen, status = 0;
3225 /* type string, SP, %lu of the length plus NUL must fit this */
3226 hdrlen = strlen(type) + 32;
3227 header = xmalloc(hdrlen);
3228 write_sha1_file_prepare(buf, len, type, sha1, header, &hdrlen);
3230 if (!(flags & HASH_WRITE_OBJECT))
3231 goto cleanup;
3232 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3233 goto cleanup;
3234 status = write_loose_object(sha1, header, hdrlen, buf, len, 0);
3236 cleanup:
3237 free(header);
3238 return status;
3241 int force_object_loose(const unsigned char *sha1, time_t mtime)
3243 void *buf;
3244 unsigned long len;
3245 enum object_type type;
3246 char hdr[32];
3247 int hdrlen;
3248 int ret;
3250 if (has_loose_object(sha1))
3251 return 0;
3252 buf = read_packed_sha1(sha1, &type, &len);
3253 if (!buf)
3254 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
3255 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(type), len) + 1;
3256 ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
3257 free(buf);
3259 return ret;
3262 int has_pack_index(const unsigned char *sha1)
3264 struct stat st;
3265 if (stat(sha1_pack_index_name(sha1), &st))
3266 return 0;
3267 return 1;
3270 int has_sha1_pack(const unsigned char *sha1)
3272 struct pack_entry e;
3273 return find_pack_entry(sha1, &e);
3276 int has_sha1_file_with_flags(const unsigned char *sha1, int flags)
3278 struct pack_entry e;
3280 if (find_pack_entry(sha1, &e))
3281 return 1;
3282 if (has_loose_object(sha1))
3283 return 1;
3284 if (flags & HAS_SHA1_QUICK)
3285 return 0;
3286 reprepare_packed_git();
3287 return find_pack_entry(sha1, &e);
3290 int has_object_file(const struct object_id *oid)
3292 return has_sha1_file(oid->hash);
3295 static void check_tree(const void *buf, size_t size)
3297 struct tree_desc desc;
3298 struct name_entry entry;
3300 init_tree_desc(&desc, buf, size);
3301 while (tree_entry(&desc, &entry))
3302 /* do nothing
3303 * tree_entry() will die() on malformed entries */
3307 static void check_commit(const void *buf, size_t size)
3309 struct commit c;
3310 memset(&c, 0, sizeof(c));
3311 if (parse_commit_buffer(&c, buf, size))
3312 die("corrupt commit");
3315 static void check_tag(const void *buf, size_t size)
3317 struct tag t;
3318 memset(&t, 0, sizeof(t));
3319 if (parse_tag_buffer(&t, buf, size))
3320 die("corrupt tag");
3323 static int index_mem(unsigned char *sha1, void *buf, size_t size,
3324 enum object_type type,
3325 const char *path, unsigned flags)
3327 int ret, re_allocated = 0;
3328 int write_object = flags & HASH_WRITE_OBJECT;
3330 if (!type)
3331 type = OBJ_BLOB;
3334 * Convert blobs to git internal format
3336 if ((type == OBJ_BLOB) && path) {
3337 struct strbuf nbuf = STRBUF_INIT;
3338 if (convert_to_git(path, buf, size, &nbuf,
3339 write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
3340 buf = strbuf_detach(&nbuf, &size);
3341 re_allocated = 1;
3344 if (flags & HASH_FORMAT_CHECK) {
3345 if (type == OBJ_TREE)
3346 check_tree(buf, size);
3347 if (type == OBJ_COMMIT)
3348 check_commit(buf, size);
3349 if (type == OBJ_TAG)
3350 check_tag(buf, size);
3353 if (write_object)
3354 ret = write_sha1_file(buf, size, typename(type), sha1);
3355 else
3356 ret = hash_sha1_file(buf, size, typename(type), sha1);
3357 if (re_allocated)
3358 free(buf);
3359 return ret;
3362 static int index_stream_convert_blob(unsigned char *sha1, int fd,
3363 const char *path, unsigned flags)
3365 int ret;
3366 const int write_object = flags & HASH_WRITE_OBJECT;
3367 struct strbuf sbuf = STRBUF_INIT;
3369 assert(path);
3370 assert(would_convert_to_git_filter_fd(path));
3372 convert_to_git_filter_fd(path, fd, &sbuf,
3373 write_object ? safe_crlf : SAFE_CRLF_FALSE);
3375 if (write_object)
3376 ret = write_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3377 sha1);
3378 else
3379 ret = hash_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3380 sha1);
3381 strbuf_release(&sbuf);
3382 return ret;
3385 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
3386 const char *path, unsigned flags)
3388 struct strbuf sbuf = STRBUF_INIT;
3389 int ret;
3391 if (strbuf_read(&sbuf, fd, 4096) >= 0)
3392 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
3393 else
3394 ret = -1;
3395 strbuf_release(&sbuf);
3396 return ret;
3399 #define SMALL_FILE_SIZE (32*1024)
3401 static int index_core(unsigned char *sha1, int fd, size_t size,
3402 enum object_type type, const char *path,
3403 unsigned flags)
3405 int ret;
3407 if (!size) {
3408 ret = index_mem(sha1, "", size, type, path, flags);
3409 } else if (size <= SMALL_FILE_SIZE) {
3410 char *buf = xmalloc(size);
3411 if (size == read_in_full(fd, buf, size))
3412 ret = index_mem(sha1, buf, size, type, path, flags);
3413 else
3414 ret = error_errno("short read");
3415 free(buf);
3416 } else {
3417 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
3418 ret = index_mem(sha1, buf, size, type, path, flags);
3419 munmap(buf, size);
3421 return ret;
3425 * This creates one packfile per large blob unless bulk-checkin
3426 * machinery is "plugged".
3428 * This also bypasses the usual "convert-to-git" dance, and that is on
3429 * purpose. We could write a streaming version of the converting
3430 * functions and insert that before feeding the data to fast-import
3431 * (or equivalent in-core API described above). However, that is
3432 * somewhat complicated, as we do not know the size of the filter
3433 * result, which we need to know beforehand when writing a git object.
3434 * Since the primary motivation for trying to stream from the working
3435 * tree file and to avoid mmaping it in core is to deal with large
3436 * binary blobs, they generally do not want to get any conversion, and
3437 * callers should avoid this code path when filters are requested.
3439 static int index_stream(unsigned char *sha1, int fd, size_t size,
3440 enum object_type type, const char *path,
3441 unsigned flags)
3443 return index_bulk_checkin(sha1, fd, size, type, path, flags);
3446 int index_fd(unsigned char *sha1, int fd, struct stat *st,
3447 enum object_type type, const char *path, unsigned flags)
3449 int ret;
3452 * Call xsize_t() only when needed to avoid potentially unnecessary
3453 * die() for large files.
3455 if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(path))
3456 ret = index_stream_convert_blob(sha1, fd, path, flags);
3457 else if (!S_ISREG(st->st_mode))
3458 ret = index_pipe(sha1, fd, type, path, flags);
3459 else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
3460 (path && would_convert_to_git(path)))
3461 ret = index_core(sha1, fd, xsize_t(st->st_size), type, path,
3462 flags);
3463 else
3464 ret = index_stream(sha1, fd, xsize_t(st->st_size), type, path,
3465 flags);
3466 close(fd);
3467 return ret;
3470 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
3472 int fd;
3473 struct strbuf sb = STRBUF_INIT;
3475 switch (st->st_mode & S_IFMT) {
3476 case S_IFREG:
3477 fd = open(path, O_RDONLY);
3478 if (fd < 0)
3479 return error_errno("open(\"%s\")", path);
3480 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
3481 return error("%s: failed to insert into database",
3482 path);
3483 break;
3484 case S_IFLNK:
3485 if (strbuf_readlink(&sb, path, st->st_size))
3486 return error_errno("readlink(\"%s\")", path);
3487 if (!(flags & HASH_WRITE_OBJECT))
3488 hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
3489 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
3490 return error("%s: failed to insert into database",
3491 path);
3492 strbuf_release(&sb);
3493 break;
3494 case S_IFDIR:
3495 return resolve_gitlink_ref(path, "HEAD", sha1);
3496 default:
3497 return error("%s: unsupported file type", path);
3499 return 0;
3502 int read_pack_header(int fd, struct pack_header *header)
3504 if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
3505 /* "eof before pack header was fully read" */
3506 return PH_ERROR_EOF;
3508 if (header->hdr_signature != htonl(PACK_SIGNATURE))
3509 /* "protocol error (pack signature mismatch detected)" */
3510 return PH_ERROR_PACK_SIGNATURE;
3511 if (!pack_version_ok(header->hdr_version))
3512 /* "protocol error (pack version unsupported)" */
3513 return PH_ERROR_PROTOCOL;
3514 return 0;
3517 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
3519 enum object_type type = sha1_object_info(sha1, NULL);
3520 if (type < 0)
3521 die("%s is not a valid object", sha1_to_hex(sha1));
3522 if (type != expect)
3523 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
3524 typename(expect));
3527 static int for_each_file_in_obj_subdir(int subdir_nr,
3528 struct strbuf *path,
3529 each_loose_object_fn obj_cb,
3530 each_loose_cruft_fn cruft_cb,
3531 each_loose_subdir_fn subdir_cb,
3532 void *data)
3534 size_t baselen = path->len;
3535 DIR *dir = opendir(path->buf);
3536 struct dirent *de;
3537 int r = 0;
3539 if (!dir) {
3540 if (errno == ENOENT)
3541 return 0;
3542 return error_errno("unable to open %s", path->buf);
3545 while ((de = readdir(dir))) {
3546 if (is_dot_or_dotdot(de->d_name))
3547 continue;
3549 strbuf_setlen(path, baselen);
3550 strbuf_addf(path, "/%s", de->d_name);
3552 if (strlen(de->d_name) == 38) {
3553 char hex[41];
3554 unsigned char sha1[20];
3556 snprintf(hex, sizeof(hex), "%02x%s",
3557 subdir_nr, de->d_name);
3558 if (!get_sha1_hex(hex, sha1)) {
3559 if (obj_cb) {
3560 r = obj_cb(sha1, path->buf, data);
3561 if (r)
3562 break;
3564 continue;
3568 if (cruft_cb) {
3569 r = cruft_cb(de->d_name, path->buf, data);
3570 if (r)
3571 break;
3574 closedir(dir);
3576 strbuf_setlen(path, baselen);
3577 if (!r && subdir_cb)
3578 r = subdir_cb(subdir_nr, path->buf, data);
3580 return r;
3583 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
3584 each_loose_object_fn obj_cb,
3585 each_loose_cruft_fn cruft_cb,
3586 each_loose_subdir_fn subdir_cb,
3587 void *data)
3589 size_t baselen = path->len;
3590 int r = 0;
3591 int i;
3593 for (i = 0; i < 256; i++) {
3594 strbuf_addf(path, "/%02x", i);
3595 r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
3596 subdir_cb, data);
3597 strbuf_setlen(path, baselen);
3598 if (r)
3599 break;
3602 return r;
3605 int for_each_loose_file_in_objdir(const char *path,
3606 each_loose_object_fn obj_cb,
3607 each_loose_cruft_fn cruft_cb,
3608 each_loose_subdir_fn subdir_cb,
3609 void *data)
3611 struct strbuf buf = STRBUF_INIT;
3612 int r;
3614 strbuf_addstr(&buf, path);
3615 r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
3616 subdir_cb, data);
3617 strbuf_release(&buf);
3619 return r;
3622 struct loose_alt_odb_data {
3623 each_loose_object_fn *cb;
3624 void *data;
3627 static int loose_from_alt_odb(struct alternate_object_database *alt,
3628 void *vdata)
3630 struct loose_alt_odb_data *data = vdata;
3631 struct strbuf buf = STRBUF_INIT;
3632 int r;
3634 /* copy base not including trailing '/' */
3635 strbuf_add(&buf, alt->base, alt->name - alt->base - 1);
3636 r = for_each_loose_file_in_objdir_buf(&buf,
3637 data->cb, NULL, NULL,
3638 data->data);
3639 strbuf_release(&buf);
3640 return r;
3643 int for_each_loose_object(each_loose_object_fn cb, void *data, unsigned flags)
3645 struct loose_alt_odb_data alt;
3646 int r;
3648 r = for_each_loose_file_in_objdir(get_object_directory(),
3649 cb, NULL, NULL, data);
3650 if (r)
3651 return r;
3653 if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
3654 return 0;
3656 alt.cb = cb;
3657 alt.data = data;
3658 return foreach_alt_odb(loose_from_alt_odb, &alt);
3661 static int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn cb, void *data)
3663 uint32_t i;
3664 int r = 0;
3666 for (i = 0; i < p->num_objects; i++) {
3667 const unsigned char *sha1 = nth_packed_object_sha1(p, i);
3669 if (!sha1)
3670 return error("unable to get sha1 of object %u in %s",
3671 i, p->pack_name);
3673 r = cb(sha1, p, i, data);
3674 if (r)
3675 break;
3677 return r;
3680 int for_each_packed_object(each_packed_object_fn cb, void *data, unsigned flags)
3682 struct packed_git *p;
3683 int r = 0;
3684 int pack_errors = 0;
3686 prepare_packed_git();
3687 for (p = packed_git; p; p = p->next) {
3688 if ((flags & FOR_EACH_OBJECT_LOCAL_ONLY) && !p->pack_local)
3689 continue;
3690 if (open_pack_index(p)) {
3691 pack_errors = 1;
3692 continue;
3694 r = for_each_object_in_pack(p, cb, data);
3695 if (r)
3696 break;
3698 return r ? r : pack_errors;