sha1_file: add read_loose_object() function
[git/raj.git] / sha1_file.c
blobca1c90e5d33785d980f8e053089cf98970bb1b44
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"
28 #include "mergesort.h"
30 #ifndef O_NOATIME
31 #if defined(__linux__) && (defined(__i386__) || defined(__PPC__))
32 #define O_NOATIME 01000000
33 #else
34 #define O_NOATIME 0
35 #endif
36 #endif
38 #define SZ_FMT PRIuMAX
39 static inline uintmax_t sz_fmt(size_t s) { return s; }
41 const unsigned char null_sha1[20];
42 const struct object_id null_oid;
43 const struct object_id empty_tree_oid = {
44 EMPTY_TREE_SHA1_BIN_LITERAL
46 const struct object_id empty_blob_oid = {
47 EMPTY_BLOB_SHA1_BIN_LITERAL
51 * This is meant to hold a *small* number of objects that you would
52 * want read_sha1_file() to be able to return, but yet you do not want
53 * to write them into the object store (e.g. a browse-only
54 * application).
56 static struct cached_object {
57 unsigned char sha1[20];
58 enum object_type type;
59 void *buf;
60 unsigned long size;
61 } *cached_objects;
62 static int cached_object_nr, cached_object_alloc;
64 static struct cached_object empty_tree = {
65 EMPTY_TREE_SHA1_BIN_LITERAL,
66 OBJ_TREE,
67 "",
71 static struct cached_object *find_cached_object(const unsigned char *sha1)
73 int i;
74 struct cached_object *co = cached_objects;
76 for (i = 0; i < cached_object_nr; i++, co++) {
77 if (!hashcmp(co->sha1, sha1))
78 return co;
80 if (!hashcmp(sha1, empty_tree.sha1))
81 return &empty_tree;
82 return NULL;
85 int mkdir_in_gitdir(const char *path)
87 if (mkdir(path, 0777)) {
88 int saved_errno = errno;
89 struct stat st;
90 struct strbuf sb = STRBUF_INIT;
92 if (errno != EEXIST)
93 return -1;
95 * Are we looking at a path in a symlinked worktree
96 * whose original repository does not yet have it?
97 * e.g. .git/rr-cache pointing at its original
98 * repository in which the user hasn't performed any
99 * conflict resolution yet?
101 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
102 strbuf_readlink(&sb, path, st.st_size) ||
103 !is_absolute_path(sb.buf) ||
104 mkdir(sb.buf, 0777)) {
105 strbuf_release(&sb);
106 errno = saved_errno;
107 return -1;
109 strbuf_release(&sb);
111 return adjust_shared_perm(path);
114 enum scld_error safe_create_leading_directories(char *path)
116 char *next_component = path + offset_1st_component(path);
117 enum scld_error ret = SCLD_OK;
119 while (ret == SCLD_OK && next_component) {
120 struct stat st;
121 char *slash = next_component, slash_character;
123 while (*slash && !is_dir_sep(*slash))
124 slash++;
126 if (!*slash)
127 break;
129 next_component = slash + 1;
130 while (is_dir_sep(*next_component))
131 next_component++;
132 if (!*next_component)
133 break;
135 slash_character = *slash;
136 *slash = '\0';
137 if (!stat(path, &st)) {
138 /* path exists */
139 if (!S_ISDIR(st.st_mode))
140 ret = SCLD_EXISTS;
141 } else if (mkdir(path, 0777)) {
142 if (errno == EEXIST &&
143 !stat(path, &st) && S_ISDIR(st.st_mode))
144 ; /* somebody created it since we checked */
145 else if (errno == ENOENT)
147 * Either mkdir() failed because
148 * somebody just pruned the containing
149 * directory, or stat() failed because
150 * the file that was in our way was
151 * just removed. Either way, inform
152 * the caller that it might be worth
153 * trying again:
155 ret = SCLD_VANISHED;
156 else
157 ret = SCLD_FAILED;
158 } else if (adjust_shared_perm(path)) {
159 ret = SCLD_PERMS;
161 *slash = slash_character;
163 return ret;
166 enum scld_error safe_create_leading_directories_const(const char *path)
168 /* path points to cache entries, so xstrdup before messing with it */
169 char *buf = xstrdup(path);
170 enum scld_error result = safe_create_leading_directories(buf);
171 free(buf);
172 return result;
175 static void fill_sha1_path(struct strbuf *buf, const unsigned char *sha1)
177 int i;
178 for (i = 0; i < 20; i++) {
179 static char hex[] = "0123456789abcdef";
180 unsigned int val = sha1[i];
181 strbuf_addch(buf, hex[val >> 4]);
182 strbuf_addch(buf, hex[val & 0xf]);
183 if (!i)
184 strbuf_addch(buf, '/');
188 const char *sha1_file_name(const unsigned char *sha1)
190 static struct strbuf buf = STRBUF_INIT;
192 strbuf_reset(&buf);
193 strbuf_addf(&buf, "%s/", get_object_directory());
195 fill_sha1_path(&buf, sha1);
196 return buf.buf;
199 struct strbuf *alt_scratch_buf(struct alternate_object_database *alt)
201 strbuf_setlen(&alt->scratch, alt->base_len);
202 return &alt->scratch;
205 static const char *alt_sha1_path(struct alternate_object_database *alt,
206 const unsigned char *sha1)
208 struct strbuf *buf = alt_scratch_buf(alt);
209 fill_sha1_path(buf, sha1);
210 return buf->buf;
214 * Return the name of the pack or index file with the specified sha1
215 * in its filename. *base and *name are scratch space that must be
216 * provided by the caller. which should be "pack" or "idx".
218 static char *sha1_get_pack_name(const unsigned char *sha1,
219 struct strbuf *buf,
220 const char *which)
222 strbuf_reset(buf);
223 strbuf_addf(buf, "%s/pack/pack-%s.%s", get_object_directory(),
224 sha1_to_hex(sha1), which);
225 return buf->buf;
228 char *sha1_pack_name(const unsigned char *sha1)
230 static struct strbuf buf = STRBUF_INIT;
231 return sha1_get_pack_name(sha1, &buf, "pack");
234 char *sha1_pack_index_name(const unsigned char *sha1)
236 static struct strbuf buf = STRBUF_INIT;
237 return sha1_get_pack_name(sha1, &buf, "idx");
240 struct alternate_object_database *alt_odb_list;
241 static struct alternate_object_database **alt_odb_tail;
244 * Return non-zero iff the path is usable as an alternate object database.
246 static int alt_odb_usable(struct strbuf *path, const char *normalized_objdir)
248 struct alternate_object_database *alt;
250 /* Detect cases where alternate disappeared */
251 if (!is_directory(path->buf)) {
252 error("object directory %s does not exist; "
253 "check .git/objects/info/alternates.",
254 path->buf);
255 return 0;
259 * Prevent the common mistake of listing the same
260 * thing twice, or object directory itself.
262 for (alt = alt_odb_list; alt; alt = alt->next) {
263 if (!fspathcmp(path->buf, alt->path))
264 return 0;
266 if (!fspathcmp(path->buf, normalized_objdir))
267 return 0;
269 return 1;
273 * Prepare alternate object database registry.
275 * The variable alt_odb_list points at the list of struct
276 * alternate_object_database. The elements on this list come from
277 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
278 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
279 * whose contents is similar to that environment variable but can be
280 * LF separated. Its base points at a statically allocated buffer that
281 * contains "/the/directory/corresponding/to/.git/objects/...", while
282 * its name points just after the slash at the end of ".git/objects/"
283 * in the example above, and has enough space to hold 40-byte hex
284 * SHA1, an extra slash for the first level indirection, and the
285 * terminating NUL.
287 static int link_alt_odb_entry(const char *entry, const char *relative_base,
288 int depth, const char *normalized_objdir)
290 struct alternate_object_database *ent;
291 struct strbuf pathbuf = STRBUF_INIT;
293 if (!is_absolute_path(entry) && relative_base) {
294 strbuf_addstr(&pathbuf, real_path(relative_base));
295 strbuf_addch(&pathbuf, '/');
297 strbuf_addstr(&pathbuf, entry);
299 if (strbuf_normalize_path(&pathbuf) < 0 && relative_base) {
300 error("unable to normalize alternate object path: %s",
301 pathbuf.buf);
302 strbuf_release(&pathbuf);
303 return -1;
307 * The trailing slash after the directory name is given by
308 * this function at the end. Remove duplicates.
310 while (pathbuf.len && pathbuf.buf[pathbuf.len - 1] == '/')
311 strbuf_setlen(&pathbuf, pathbuf.len - 1);
313 if (!alt_odb_usable(&pathbuf, normalized_objdir)) {
314 strbuf_release(&pathbuf);
315 return -1;
318 ent = alloc_alt_odb(pathbuf.buf);
320 /* add the alternate entry */
321 *alt_odb_tail = ent;
322 alt_odb_tail = &(ent->next);
323 ent->next = NULL;
325 /* recursively add alternates */
326 read_info_alternates(pathbuf.buf, depth + 1);
328 strbuf_release(&pathbuf);
329 return 0;
332 static void link_alt_odb_entries(const char *alt, int len, int sep,
333 const char *relative_base, int depth)
335 struct string_list entries = STRING_LIST_INIT_NODUP;
336 char *alt_copy;
337 int i;
338 struct strbuf objdirbuf = STRBUF_INIT;
340 if (depth > 5) {
341 error("%s: ignoring alternate object stores, nesting too deep.",
342 relative_base);
343 return;
346 strbuf_add_absolute_path(&objdirbuf, get_object_directory());
347 if (strbuf_normalize_path(&objdirbuf) < 0)
348 die("unable to normalize object directory: %s",
349 objdirbuf.buf);
351 alt_copy = xmemdupz(alt, len);
352 string_list_split_in_place(&entries, alt_copy, sep, -1);
353 for (i = 0; i < entries.nr; i++) {
354 const char *entry = entries.items[i].string;
355 if (entry[0] == '\0' || entry[0] == '#')
356 continue;
357 link_alt_odb_entry(entry, relative_base, depth, objdirbuf.buf);
359 string_list_clear(&entries, 0);
360 free(alt_copy);
361 strbuf_release(&objdirbuf);
364 void read_info_alternates(const char * relative_base, int depth)
366 char *map;
367 size_t mapsz;
368 struct stat st;
369 char *path;
370 int fd;
372 path = xstrfmt("%s/info/alternates", relative_base);
373 fd = git_open(path);
374 free(path);
375 if (fd < 0)
376 return;
377 if (fstat(fd, &st) || (st.st_size == 0)) {
378 close(fd);
379 return;
381 mapsz = xsize_t(st.st_size);
382 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
383 close(fd);
385 link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
387 munmap(map, mapsz);
390 struct alternate_object_database *alloc_alt_odb(const char *dir)
392 struct alternate_object_database *ent;
394 FLEX_ALLOC_STR(ent, path, dir);
395 strbuf_init(&ent->scratch, 0);
396 strbuf_addf(&ent->scratch, "%s/", dir);
397 ent->base_len = ent->scratch.len;
399 return ent;
402 void add_to_alternates_file(const char *reference)
404 struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
405 char *alts = git_pathdup("objects/info/alternates");
406 FILE *in, *out;
408 hold_lock_file_for_update(lock, alts, LOCK_DIE_ON_ERROR);
409 out = fdopen_lock_file(lock, "w");
410 if (!out)
411 die_errno("unable to fdopen alternates lockfile");
413 in = fopen(alts, "r");
414 if (in) {
415 struct strbuf line = STRBUF_INIT;
416 int found = 0;
418 while (strbuf_getline(&line, in) != EOF) {
419 if (!strcmp(reference, line.buf)) {
420 found = 1;
421 break;
423 fprintf_or_die(out, "%s\n", line.buf);
426 strbuf_release(&line);
427 fclose(in);
429 if (found) {
430 rollback_lock_file(lock);
431 lock = NULL;
434 else if (errno != ENOENT)
435 die_errno("unable to read alternates file");
437 if (lock) {
438 fprintf_or_die(out, "%s\n", reference);
439 if (commit_lock_file(lock))
440 die_errno("unable to move new alternates file into place");
441 if (alt_odb_tail)
442 link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
444 free(alts);
447 void add_to_alternates_memory(const char *reference)
450 * Make sure alternates are initialized, or else our entry may be
451 * overwritten when they are.
453 prepare_alt_odb();
455 link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
459 * Compute the exact path an alternate is at and returns it. In case of
460 * error NULL is returned and the human readable error is added to `err`
461 * `path` may be relative and should point to $GITDIR.
462 * `err` must not be null.
464 char *compute_alternate_path(const char *path, struct strbuf *err)
466 char *ref_git = NULL;
467 const char *repo, *ref_git_s;
468 int seen_error = 0;
470 ref_git_s = real_path_if_valid(path);
471 if (!ref_git_s) {
472 seen_error = 1;
473 strbuf_addf(err, _("path '%s' does not exist"), path);
474 goto out;
475 } else
477 * Beware: read_gitfile(), real_path() and mkpath()
478 * return static buffer
480 ref_git = xstrdup(ref_git_s);
482 repo = read_gitfile(ref_git);
483 if (!repo)
484 repo = read_gitfile(mkpath("%s/.git", ref_git));
485 if (repo) {
486 free(ref_git);
487 ref_git = xstrdup(repo);
490 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
491 char *ref_git_git = mkpathdup("%s/.git", ref_git);
492 free(ref_git);
493 ref_git = ref_git_git;
494 } else if (!is_directory(mkpath("%s/objects", ref_git))) {
495 struct strbuf sb = STRBUF_INIT;
496 seen_error = 1;
497 if (get_common_dir(&sb, ref_git)) {
498 strbuf_addf(err,
499 _("reference repository '%s' as a linked "
500 "checkout is not supported yet."),
501 path);
502 goto out;
505 strbuf_addf(err, _("reference repository '%s' is not a "
506 "local repository."), path);
507 goto out;
510 if (!access(mkpath("%s/shallow", ref_git), F_OK)) {
511 strbuf_addf(err, _("reference repository '%s' is shallow"),
512 path);
513 seen_error = 1;
514 goto out;
517 if (!access(mkpath("%s/info/grafts", ref_git), F_OK)) {
518 strbuf_addf(err,
519 _("reference repository '%s' is grafted"),
520 path);
521 seen_error = 1;
522 goto out;
525 out:
526 if (seen_error) {
527 free(ref_git);
528 ref_git = NULL;
531 return ref_git;
534 int foreach_alt_odb(alt_odb_fn fn, void *cb)
536 struct alternate_object_database *ent;
537 int r = 0;
539 prepare_alt_odb();
540 for (ent = alt_odb_list; ent; ent = ent->next) {
541 r = fn(ent, cb);
542 if (r)
543 break;
545 return r;
548 void prepare_alt_odb(void)
550 const char *alt;
552 if (alt_odb_tail)
553 return;
555 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
556 if (!alt) alt = "";
558 alt_odb_tail = &alt_odb_list;
559 link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
561 read_info_alternates(get_object_directory(), 0);
564 /* Returns 1 if we have successfully freshened the file, 0 otherwise. */
565 static int freshen_file(const char *fn)
567 struct utimbuf t;
568 t.actime = t.modtime = time(NULL);
569 return !utime(fn, &t);
573 * All of the check_and_freshen functions return 1 if the file exists and was
574 * freshened (if freshening was requested), 0 otherwise. If they return
575 * 0, you should not assume that it is safe to skip a write of the object (it
576 * either does not exist on disk, or has a stale mtime and may be subject to
577 * pruning).
579 static int check_and_freshen_file(const char *fn, int freshen)
581 if (access(fn, F_OK))
582 return 0;
583 if (freshen && !freshen_file(fn))
584 return 0;
585 return 1;
588 static int check_and_freshen_local(const unsigned char *sha1, int freshen)
590 return check_and_freshen_file(sha1_file_name(sha1), freshen);
593 static int check_and_freshen_nonlocal(const unsigned char *sha1, int freshen)
595 struct alternate_object_database *alt;
596 prepare_alt_odb();
597 for (alt = alt_odb_list; alt; alt = alt->next) {
598 const char *path = alt_sha1_path(alt, sha1);
599 if (check_and_freshen_file(path, freshen))
600 return 1;
602 return 0;
605 static int check_and_freshen(const unsigned char *sha1, int freshen)
607 return check_and_freshen_local(sha1, freshen) ||
608 check_and_freshen_nonlocal(sha1, freshen);
611 int has_loose_object_nonlocal(const unsigned char *sha1)
613 return check_and_freshen_nonlocal(sha1, 0);
616 static int has_loose_object(const unsigned char *sha1)
618 return check_and_freshen(sha1, 0);
621 static unsigned int pack_used_ctr;
622 static unsigned int pack_mmap_calls;
623 static unsigned int peak_pack_open_windows;
624 static unsigned int pack_open_windows;
625 static unsigned int pack_open_fds;
626 static unsigned int pack_max_fds;
627 static size_t peak_pack_mapped;
628 static size_t pack_mapped;
629 struct packed_git *packed_git;
631 static struct mru packed_git_mru_storage;
632 struct mru *packed_git_mru = &packed_git_mru_storage;
634 void pack_report(void)
636 fprintf(stderr,
637 "pack_report: getpagesize() = %10" SZ_FMT "\n"
638 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
639 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
640 sz_fmt(getpagesize()),
641 sz_fmt(packed_git_window_size),
642 sz_fmt(packed_git_limit));
643 fprintf(stderr,
644 "pack_report: pack_used_ctr = %10u\n"
645 "pack_report: pack_mmap_calls = %10u\n"
646 "pack_report: pack_open_windows = %10u / %10u\n"
647 "pack_report: pack_mapped = "
648 "%10" SZ_FMT " / %10" SZ_FMT "\n",
649 pack_used_ctr,
650 pack_mmap_calls,
651 pack_open_windows, peak_pack_open_windows,
652 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
656 * Open and mmap the index file at path, perform a couple of
657 * consistency checks, then record its information to p. Return 0 on
658 * success.
660 static int check_packed_git_idx(const char *path, struct packed_git *p)
662 void *idx_map;
663 struct pack_idx_header *hdr;
664 size_t idx_size;
665 uint32_t version, nr, i, *index;
666 int fd = git_open(path);
667 struct stat st;
669 if (fd < 0)
670 return -1;
671 if (fstat(fd, &st)) {
672 close(fd);
673 return -1;
675 idx_size = xsize_t(st.st_size);
676 if (idx_size < 4 * 256 + 20 + 20) {
677 close(fd);
678 return error("index file %s is too small", path);
680 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
681 close(fd);
683 hdr = idx_map;
684 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
685 version = ntohl(hdr->idx_version);
686 if (version < 2 || version > 2) {
687 munmap(idx_map, idx_size);
688 return error("index file %s is version %"PRIu32
689 " and is not supported by this binary"
690 " (try upgrading GIT to a newer version)",
691 path, version);
693 } else
694 version = 1;
696 nr = 0;
697 index = idx_map;
698 if (version > 1)
699 index += 2; /* skip index header */
700 for (i = 0; i < 256; i++) {
701 uint32_t n = ntohl(index[i]);
702 if (n < nr) {
703 munmap(idx_map, idx_size);
704 return error("non-monotonic index %s", path);
706 nr = n;
709 if (version == 1) {
711 * Total size:
712 * - 256 index entries 4 bytes each
713 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
714 * - 20-byte SHA1 of the packfile
715 * - 20-byte SHA1 file checksum
717 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
718 munmap(idx_map, idx_size);
719 return error("wrong index v1 file size in %s", path);
721 } else if (version == 2) {
723 * Minimum size:
724 * - 8 bytes of header
725 * - 256 index entries 4 bytes each
726 * - 20-byte sha1 entry * nr
727 * - 4-byte crc entry * nr
728 * - 4-byte offset entry * nr
729 * - 20-byte SHA1 of the packfile
730 * - 20-byte SHA1 file checksum
731 * And after the 4-byte offset table might be a
732 * variable sized table containing 8-byte entries
733 * for offsets larger than 2^31.
735 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
736 unsigned long max_size = min_size;
737 if (nr)
738 max_size += (nr - 1)*8;
739 if (idx_size < min_size || idx_size > max_size) {
740 munmap(idx_map, idx_size);
741 return error("wrong index v2 file size in %s", path);
743 if (idx_size != min_size &&
745 * make sure we can deal with large pack offsets.
746 * 31-bit signed offset won't be enough, neither
747 * 32-bit unsigned one will be.
749 (sizeof(off_t) <= 4)) {
750 munmap(idx_map, idx_size);
751 return error("pack too large for current definition of off_t in %s", path);
755 p->index_version = version;
756 p->index_data = idx_map;
757 p->index_size = idx_size;
758 p->num_objects = nr;
759 return 0;
762 int open_pack_index(struct packed_git *p)
764 char *idx_name;
765 size_t len;
766 int ret;
768 if (p->index_data)
769 return 0;
771 if (!strip_suffix(p->pack_name, ".pack", &len))
772 die("BUG: pack_name does not end in .pack");
773 idx_name = xstrfmt("%.*s.idx", (int)len, p->pack_name);
774 ret = check_packed_git_idx(idx_name, p);
775 free(idx_name);
776 return ret;
779 static void scan_windows(struct packed_git *p,
780 struct packed_git **lru_p,
781 struct pack_window **lru_w,
782 struct pack_window **lru_l)
784 struct pack_window *w, *w_l;
786 for (w_l = NULL, w = p->windows; w; w = w->next) {
787 if (!w->inuse_cnt) {
788 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
789 *lru_p = p;
790 *lru_w = w;
791 *lru_l = w_l;
794 w_l = w;
798 static int unuse_one_window(struct packed_git *current)
800 struct packed_git *p, *lru_p = NULL;
801 struct pack_window *lru_w = NULL, *lru_l = NULL;
803 if (current)
804 scan_windows(current, &lru_p, &lru_w, &lru_l);
805 for (p = packed_git; p; p = p->next)
806 scan_windows(p, &lru_p, &lru_w, &lru_l);
807 if (lru_p) {
808 munmap(lru_w->base, lru_w->len);
809 pack_mapped -= lru_w->len;
810 if (lru_l)
811 lru_l->next = lru_w->next;
812 else
813 lru_p->windows = lru_w->next;
814 free(lru_w);
815 pack_open_windows--;
816 return 1;
818 return 0;
821 void release_pack_memory(size_t need)
823 size_t cur = pack_mapped;
824 while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
825 ; /* nothing */
828 static void mmap_limit_check(size_t length)
830 static size_t limit = 0;
831 if (!limit) {
832 limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
833 if (!limit)
834 limit = SIZE_MAX;
836 if (length > limit)
837 die("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX,
838 (uintmax_t)length, (uintmax_t)limit);
841 void *xmmap_gently(void *start, size_t length,
842 int prot, int flags, int fd, off_t offset)
844 void *ret;
846 mmap_limit_check(length);
847 ret = mmap(start, length, prot, flags, fd, offset);
848 if (ret == MAP_FAILED) {
849 if (!length)
850 return NULL;
851 release_pack_memory(length);
852 ret = mmap(start, length, prot, flags, fd, offset);
854 return ret;
857 void *xmmap(void *start, size_t length,
858 int prot, int flags, int fd, off_t offset)
860 void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
861 if (ret == MAP_FAILED)
862 die_errno("mmap failed");
863 return ret;
866 void close_pack_windows(struct packed_git *p)
868 while (p->windows) {
869 struct pack_window *w = p->windows;
871 if (w->inuse_cnt)
872 die("pack '%s' still has open windows to it",
873 p->pack_name);
874 munmap(w->base, w->len);
875 pack_mapped -= w->len;
876 pack_open_windows--;
877 p->windows = w->next;
878 free(w);
882 static int close_pack_fd(struct packed_git *p)
884 if (p->pack_fd < 0)
885 return 0;
887 close(p->pack_fd);
888 pack_open_fds--;
889 p->pack_fd = -1;
891 return 1;
894 static void close_pack(struct packed_git *p)
896 close_pack_windows(p);
897 close_pack_fd(p);
898 close_pack_index(p);
901 void close_all_packs(void)
903 struct packed_git *p;
905 for (p = packed_git; p; p = p->next)
906 if (p->do_not_close)
907 die("BUG: want to close pack marked 'do-not-close'");
908 else
909 close_pack(p);
914 * The LRU pack is the one with the oldest MRU window, preferring packs
915 * with no used windows, or the oldest mtime if it has no windows allocated.
917 static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
919 struct pack_window *w, *this_mru_w;
920 int has_windows_inuse = 0;
923 * Reject this pack if it has windows and the previously selected
924 * one does not. If this pack does not have windows, reject
925 * it if the pack file is newer than the previously selected one.
927 if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
928 return;
930 for (w = this_mru_w = p->windows; w; w = w->next) {
932 * Reject this pack if any of its windows are in use,
933 * but the previously selected pack did not have any
934 * inuse windows. Otherwise, record that this pack
935 * has windows in use.
937 if (w->inuse_cnt) {
938 if (*accept_windows_inuse)
939 has_windows_inuse = 1;
940 else
941 return;
944 if (w->last_used > this_mru_w->last_used)
945 this_mru_w = w;
948 * Reject this pack if it has windows that have been
949 * used more recently than the previously selected pack.
950 * If the previously selected pack had windows inuse and
951 * we have not encountered a window in this pack that is
952 * inuse, skip this check since we prefer a pack with no
953 * inuse windows to one that has inuse windows.
955 if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
956 this_mru_w->last_used > (*mru_w)->last_used)
957 return;
961 * Select this pack.
963 *mru_w = this_mru_w;
964 *lru_p = p;
965 *accept_windows_inuse = has_windows_inuse;
968 static int close_one_pack(void)
970 struct packed_git *p, *lru_p = NULL;
971 struct pack_window *mru_w = NULL;
972 int accept_windows_inuse = 1;
974 for (p = packed_git; p; p = p->next) {
975 if (p->pack_fd == -1)
976 continue;
977 find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
980 if (lru_p)
981 return close_pack_fd(lru_p);
983 return 0;
986 void unuse_pack(struct pack_window **w_cursor)
988 struct pack_window *w = *w_cursor;
989 if (w) {
990 w->inuse_cnt--;
991 *w_cursor = NULL;
995 void close_pack_index(struct packed_git *p)
997 if (p->index_data) {
998 munmap((void *)p->index_data, p->index_size);
999 p->index_data = NULL;
1003 static unsigned int get_max_fd_limit(void)
1005 #ifdef RLIMIT_NOFILE
1007 struct rlimit lim;
1009 if (!getrlimit(RLIMIT_NOFILE, &lim))
1010 return lim.rlim_cur;
1012 #endif
1014 #ifdef _SC_OPEN_MAX
1016 long open_max = sysconf(_SC_OPEN_MAX);
1017 if (0 < open_max)
1018 return open_max;
1020 * Otherwise, we got -1 for one of the two
1021 * reasons:
1023 * (1) sysconf() did not understand _SC_OPEN_MAX
1024 * and signaled an error with -1; or
1025 * (2) sysconf() said there is no limit.
1027 * We _could_ clear errno before calling sysconf() to
1028 * tell these two cases apart and return a huge number
1029 * in the latter case to let the caller cap it to a
1030 * value that is not so selfish, but letting the
1031 * fallback OPEN_MAX codepath take care of these cases
1032 * is a lot simpler.
1035 #endif
1037 #ifdef OPEN_MAX
1038 return OPEN_MAX;
1039 #else
1040 return 1; /* see the caller ;-) */
1041 #endif
1045 * Do not call this directly as this leaks p->pack_fd on error return;
1046 * call open_packed_git() instead.
1048 static int open_packed_git_1(struct packed_git *p)
1050 struct stat st;
1051 struct pack_header hdr;
1052 unsigned char sha1[20];
1053 unsigned char *idx_sha1;
1054 long fd_flag;
1056 if (!p->index_data && open_pack_index(p))
1057 return error("packfile %s index unavailable", p->pack_name);
1059 if (!pack_max_fds) {
1060 unsigned int max_fds = get_max_fd_limit();
1062 /* Save 3 for stdin/stdout/stderr, 22 for work */
1063 if (25 < max_fds)
1064 pack_max_fds = max_fds - 25;
1065 else
1066 pack_max_fds = 1;
1069 while (pack_max_fds <= pack_open_fds && close_one_pack())
1070 ; /* nothing */
1072 p->pack_fd = git_open(p->pack_name);
1073 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
1074 return -1;
1075 pack_open_fds++;
1077 /* If we created the struct before we had the pack we lack size. */
1078 if (!p->pack_size) {
1079 if (!S_ISREG(st.st_mode))
1080 return error("packfile %s not a regular file", p->pack_name);
1081 p->pack_size = st.st_size;
1082 } else if (p->pack_size != st.st_size)
1083 return error("packfile %s size changed", p->pack_name);
1085 /* We leave these file descriptors open with sliding mmap;
1086 * there is no point keeping them open across exec(), though.
1088 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
1089 if (fd_flag < 0)
1090 return error("cannot determine file descriptor flags");
1091 fd_flag |= FD_CLOEXEC;
1092 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
1093 return error("cannot set FD_CLOEXEC");
1095 /* Verify we recognize this pack file format. */
1096 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
1097 return error("file %s is far too short to be a packfile", p->pack_name);
1098 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
1099 return error("file %s is not a GIT packfile", p->pack_name);
1100 if (!pack_version_ok(hdr.hdr_version))
1101 return error("packfile %s is version %"PRIu32" and not"
1102 " supported (try upgrading GIT to a newer version)",
1103 p->pack_name, ntohl(hdr.hdr_version));
1105 /* Verify the pack matches its index. */
1106 if (p->num_objects != ntohl(hdr.hdr_entries))
1107 return error("packfile %s claims to have %"PRIu32" objects"
1108 " while index indicates %"PRIu32" objects",
1109 p->pack_name, ntohl(hdr.hdr_entries),
1110 p->num_objects);
1111 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
1112 return error("end of packfile %s is unavailable", p->pack_name);
1113 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
1114 return error("packfile %s signature is unavailable", p->pack_name);
1115 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
1116 if (hashcmp(sha1, idx_sha1))
1117 return error("packfile %s does not match index", p->pack_name);
1118 return 0;
1121 static int open_packed_git(struct packed_git *p)
1123 if (!open_packed_git_1(p))
1124 return 0;
1125 close_pack_fd(p);
1126 return -1;
1129 static int in_window(struct pack_window *win, off_t offset)
1131 /* We must promise at least 20 bytes (one hash) after the
1132 * offset is available from this window, otherwise the offset
1133 * is not actually in this window and a different window (which
1134 * has that one hash excess) must be used. This is to support
1135 * the object header and delta base parsing routines below.
1137 off_t win_off = win->offset;
1138 return win_off <= offset
1139 && (offset + 20) <= (win_off + win->len);
1142 unsigned char *use_pack(struct packed_git *p,
1143 struct pack_window **w_cursor,
1144 off_t offset,
1145 unsigned long *left)
1147 struct pack_window *win = *w_cursor;
1149 /* Since packfiles end in a hash of their content and it's
1150 * pointless to ask for an offset into the middle of that
1151 * hash, and the in_window function above wouldn't match
1152 * don't allow an offset too close to the end of the file.
1154 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
1155 die("packfile %s cannot be accessed", p->pack_name);
1156 if (offset > (p->pack_size - 20))
1157 die("offset beyond end of packfile (truncated pack?)");
1158 if (offset < 0)
1159 die(_("offset before end of packfile (broken .idx?)"));
1161 if (!win || !in_window(win, offset)) {
1162 if (win)
1163 win->inuse_cnt--;
1164 for (win = p->windows; win; win = win->next) {
1165 if (in_window(win, offset))
1166 break;
1168 if (!win) {
1169 size_t window_align = packed_git_window_size / 2;
1170 off_t len;
1172 if (p->pack_fd == -1 && open_packed_git(p))
1173 die("packfile %s cannot be accessed", p->pack_name);
1175 win = xcalloc(1, sizeof(*win));
1176 win->offset = (offset / window_align) * window_align;
1177 len = p->pack_size - win->offset;
1178 if (len > packed_git_window_size)
1179 len = packed_git_window_size;
1180 win->len = (size_t)len;
1181 pack_mapped += win->len;
1182 while (packed_git_limit < pack_mapped
1183 && unuse_one_window(p))
1184 ; /* nothing */
1185 win->base = xmmap(NULL, win->len,
1186 PROT_READ, MAP_PRIVATE,
1187 p->pack_fd, win->offset);
1188 if (win->base == MAP_FAILED)
1189 die_errno("packfile %s cannot be mapped",
1190 p->pack_name);
1191 if (!win->offset && win->len == p->pack_size
1192 && !p->do_not_close)
1193 close_pack_fd(p);
1194 pack_mmap_calls++;
1195 pack_open_windows++;
1196 if (pack_mapped > peak_pack_mapped)
1197 peak_pack_mapped = pack_mapped;
1198 if (pack_open_windows > peak_pack_open_windows)
1199 peak_pack_open_windows = pack_open_windows;
1200 win->next = p->windows;
1201 p->windows = win;
1204 if (win != *w_cursor) {
1205 win->last_used = pack_used_ctr++;
1206 win->inuse_cnt++;
1207 *w_cursor = win;
1209 offset -= win->offset;
1210 if (left)
1211 *left = win->len - xsize_t(offset);
1212 return win->base + offset;
1215 static struct packed_git *alloc_packed_git(int extra)
1217 struct packed_git *p = xmalloc(st_add(sizeof(*p), extra));
1218 memset(p, 0, sizeof(*p));
1219 p->pack_fd = -1;
1220 return p;
1223 static void try_to_free_pack_memory(size_t size)
1225 release_pack_memory(size);
1228 struct packed_git *add_packed_git(const char *path, size_t path_len, int local)
1230 static int have_set_try_to_free_routine;
1231 struct stat st;
1232 size_t alloc;
1233 struct packed_git *p;
1235 if (!have_set_try_to_free_routine) {
1236 have_set_try_to_free_routine = 1;
1237 set_try_to_free_routine(try_to_free_pack_memory);
1241 * Make sure a corresponding .pack file exists and that
1242 * the index looks sane.
1244 if (!strip_suffix_mem(path, &path_len, ".idx"))
1245 return NULL;
1248 * ".pack" is long enough to hold any suffix we're adding (and
1249 * the use xsnprintf double-checks that)
1251 alloc = st_add3(path_len, strlen(".pack"), 1);
1252 p = alloc_packed_git(alloc);
1253 memcpy(p->pack_name, path, path_len);
1255 xsnprintf(p->pack_name + path_len, alloc - path_len, ".keep");
1256 if (!access(p->pack_name, F_OK))
1257 p->pack_keep = 1;
1259 xsnprintf(p->pack_name + path_len, alloc - path_len, ".pack");
1260 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
1261 free(p);
1262 return NULL;
1265 /* ok, it looks sane as far as we can check without
1266 * actually mapping the pack file.
1268 p->pack_size = st.st_size;
1269 p->pack_local = local;
1270 p->mtime = st.st_mtime;
1271 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
1272 hashclr(p->sha1);
1273 return p;
1276 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
1278 const char *path = sha1_pack_name(sha1);
1279 size_t alloc = st_add(strlen(path), 1);
1280 struct packed_git *p = alloc_packed_git(alloc);
1282 memcpy(p->pack_name, path, alloc); /* includes NUL */
1283 hashcpy(p->sha1, sha1);
1284 if (check_packed_git_idx(idx_path, p)) {
1285 free(p);
1286 return NULL;
1289 return p;
1292 void install_packed_git(struct packed_git *pack)
1294 if (pack->pack_fd != -1)
1295 pack_open_fds++;
1297 pack->next = packed_git;
1298 packed_git = pack;
1301 void (*report_garbage)(unsigned seen_bits, const char *path);
1303 static void report_helper(const struct string_list *list,
1304 int seen_bits, int first, int last)
1306 if (seen_bits == (PACKDIR_FILE_PACK|PACKDIR_FILE_IDX))
1307 return;
1309 for (; first < last; first++)
1310 report_garbage(seen_bits, list->items[first].string);
1313 static void report_pack_garbage(struct string_list *list)
1315 int i, baselen = -1, first = 0, seen_bits = 0;
1317 if (!report_garbage)
1318 return;
1320 string_list_sort(list);
1322 for (i = 0; i < list->nr; i++) {
1323 const char *path = list->items[i].string;
1324 if (baselen != -1 &&
1325 strncmp(path, list->items[first].string, baselen)) {
1326 report_helper(list, seen_bits, first, i);
1327 baselen = -1;
1328 seen_bits = 0;
1330 if (baselen == -1) {
1331 const char *dot = strrchr(path, '.');
1332 if (!dot) {
1333 report_garbage(PACKDIR_FILE_GARBAGE, path);
1334 continue;
1336 baselen = dot - path + 1;
1337 first = i;
1339 if (!strcmp(path + baselen, "pack"))
1340 seen_bits |= 1;
1341 else if (!strcmp(path + baselen, "idx"))
1342 seen_bits |= 2;
1344 report_helper(list, seen_bits, first, list->nr);
1347 static void prepare_packed_git_one(char *objdir, int local)
1349 struct strbuf path = STRBUF_INIT;
1350 size_t dirnamelen;
1351 DIR *dir;
1352 struct dirent *de;
1353 struct string_list garbage = STRING_LIST_INIT_DUP;
1355 strbuf_addstr(&path, objdir);
1356 strbuf_addstr(&path, "/pack");
1357 dir = opendir(path.buf);
1358 if (!dir) {
1359 if (errno != ENOENT)
1360 error_errno("unable to open object pack directory: %s",
1361 path.buf);
1362 strbuf_release(&path);
1363 return;
1365 strbuf_addch(&path, '/');
1366 dirnamelen = path.len;
1367 while ((de = readdir(dir)) != NULL) {
1368 struct packed_git *p;
1369 size_t base_len;
1371 if (is_dot_or_dotdot(de->d_name))
1372 continue;
1374 strbuf_setlen(&path, dirnamelen);
1375 strbuf_addstr(&path, de->d_name);
1377 base_len = path.len;
1378 if (strip_suffix_mem(path.buf, &base_len, ".idx")) {
1379 /* Don't reopen a pack we already have. */
1380 for (p = packed_git; p; p = p->next) {
1381 size_t len;
1382 if (strip_suffix(p->pack_name, ".pack", &len) &&
1383 len == base_len &&
1384 !memcmp(p->pack_name, path.buf, len))
1385 break;
1387 if (p == NULL &&
1389 * See if it really is a valid .idx file with
1390 * corresponding .pack file that we can map.
1392 (p = add_packed_git(path.buf, path.len, local)) != NULL)
1393 install_packed_git(p);
1396 if (!report_garbage)
1397 continue;
1399 if (ends_with(de->d_name, ".idx") ||
1400 ends_with(de->d_name, ".pack") ||
1401 ends_with(de->d_name, ".bitmap") ||
1402 ends_with(de->d_name, ".keep"))
1403 string_list_append(&garbage, path.buf);
1404 else
1405 report_garbage(PACKDIR_FILE_GARBAGE, path.buf);
1407 closedir(dir);
1408 report_pack_garbage(&garbage);
1409 string_list_clear(&garbage, 0);
1410 strbuf_release(&path);
1413 static int approximate_object_count_valid;
1416 * Give a fast, rough count of the number of objects in the repository. This
1417 * ignores loose objects completely. If you have a lot of them, then either
1418 * you should repack because your performance will be awful, or they are
1419 * all unreachable objects about to be pruned, in which case they're not really
1420 * interesting as a measure of repo size in the first place.
1422 unsigned long approximate_object_count(void)
1424 static unsigned long count;
1425 if (!approximate_object_count_valid) {
1426 struct packed_git *p;
1428 prepare_packed_git();
1429 count = 0;
1430 for (p = packed_git; p; p = p->next) {
1431 if (open_pack_index(p))
1432 continue;
1433 count += p->num_objects;
1436 return count;
1439 static void *get_next_packed_git(const void *p)
1441 return ((const struct packed_git *)p)->next;
1444 static void set_next_packed_git(void *p, void *next)
1446 ((struct packed_git *)p)->next = next;
1449 static int sort_pack(const void *a_, const void *b_)
1451 const struct packed_git *a = a_;
1452 const struct packed_git *b = b_;
1453 int st;
1456 * Local packs tend to contain objects specific to our
1457 * variant of the project than remote ones. In addition,
1458 * remote ones could be on a network mounted filesystem.
1459 * Favor local ones for these reasons.
1461 st = a->pack_local - b->pack_local;
1462 if (st)
1463 return -st;
1466 * Younger packs tend to contain more recent objects,
1467 * and more recent objects tend to get accessed more
1468 * often.
1470 if (a->mtime < b->mtime)
1471 return 1;
1472 else if (a->mtime == b->mtime)
1473 return 0;
1474 return -1;
1477 static void rearrange_packed_git(void)
1479 packed_git = llist_mergesort(packed_git, get_next_packed_git,
1480 set_next_packed_git, sort_pack);
1483 static void prepare_packed_git_mru(void)
1485 struct packed_git *p;
1487 mru_clear(packed_git_mru);
1488 for (p = packed_git; p; p = p->next)
1489 mru_append(packed_git_mru, p);
1492 static int prepare_packed_git_run_once = 0;
1493 void prepare_packed_git(void)
1495 struct alternate_object_database *alt;
1497 if (prepare_packed_git_run_once)
1498 return;
1499 prepare_packed_git_one(get_object_directory(), 1);
1500 prepare_alt_odb();
1501 for (alt = alt_odb_list; alt; alt = alt->next)
1502 prepare_packed_git_one(alt->path, 0);
1503 rearrange_packed_git();
1504 prepare_packed_git_mru();
1505 prepare_packed_git_run_once = 1;
1508 void reprepare_packed_git(void)
1510 approximate_object_count_valid = 0;
1511 prepare_packed_git_run_once = 0;
1512 prepare_packed_git();
1515 static void mark_bad_packed_object(struct packed_git *p,
1516 const unsigned char *sha1)
1518 unsigned i;
1519 for (i = 0; i < p->num_bad_objects; i++)
1520 if (!hashcmp(sha1, p->bad_object_sha1 + GIT_SHA1_RAWSZ * i))
1521 return;
1522 p->bad_object_sha1 = xrealloc(p->bad_object_sha1,
1523 st_mult(GIT_SHA1_RAWSZ,
1524 st_add(p->num_bad_objects, 1)));
1525 hashcpy(p->bad_object_sha1 + GIT_SHA1_RAWSZ * p->num_bad_objects, sha1);
1526 p->num_bad_objects++;
1529 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1531 struct packed_git *p;
1532 unsigned i;
1534 for (p = packed_git; p; p = p->next)
1535 for (i = 0; i < p->num_bad_objects; i++)
1536 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1537 return p;
1538 return NULL;
1542 * With an in-core object data in "map", rehash it to make sure the
1543 * object name actually matches "sha1" to detect object corruption.
1544 * With "map" == NULL, try reading the object named with "sha1" using
1545 * the streaming interface and rehash it to do the same.
1547 int check_sha1_signature(const unsigned char *sha1, void *map,
1548 unsigned long size, const char *type)
1550 unsigned char real_sha1[20];
1551 enum object_type obj_type;
1552 struct git_istream *st;
1553 git_SHA_CTX c;
1554 char hdr[32];
1555 int hdrlen;
1557 if (map) {
1558 hash_sha1_file(map, size, type, real_sha1);
1559 return hashcmp(sha1, real_sha1) ? -1 : 0;
1562 st = open_istream(sha1, &obj_type, &size, NULL);
1563 if (!st)
1564 return -1;
1566 /* Generate the header */
1567 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(obj_type), size) + 1;
1569 /* Sha1.. */
1570 git_SHA1_Init(&c);
1571 git_SHA1_Update(&c, hdr, hdrlen);
1572 for (;;) {
1573 char buf[1024 * 16];
1574 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1576 if (readlen < 0) {
1577 close_istream(st);
1578 return -1;
1580 if (!readlen)
1581 break;
1582 git_SHA1_Update(&c, buf, readlen);
1584 git_SHA1_Final(real_sha1, &c);
1585 close_istream(st);
1586 return hashcmp(sha1, real_sha1) ? -1 : 0;
1589 int git_open(const char *name)
1591 static int sha1_file_open_flag = O_NOATIME | O_CLOEXEC;
1593 for (;;) {
1594 int fd;
1596 errno = 0;
1597 fd = open(name, O_RDONLY | sha1_file_open_flag);
1598 if (fd >= 0)
1599 return fd;
1601 /* Try again w/o O_CLOEXEC: the kernel might not support it */
1602 if ((sha1_file_open_flag & O_CLOEXEC) && errno == EINVAL) {
1603 sha1_file_open_flag &= ~O_CLOEXEC;
1604 continue;
1607 /* Might the failure be due to O_NOATIME? */
1608 if (errno != ENOENT && (sha1_file_open_flag & O_NOATIME)) {
1609 sha1_file_open_flag &= ~O_NOATIME;
1610 continue;
1612 return -1;
1617 * Find "sha1" as a loose object in the local repository or in an alternate.
1618 * Returns 0 on success, negative on failure.
1620 * The "path" out-parameter will give the path of the object we found (if any).
1621 * Note that it may point to static storage and is only valid until another
1622 * call to sha1_file_name(), etc.
1624 static int stat_sha1_file(const unsigned char *sha1, struct stat *st,
1625 const char **path)
1627 struct alternate_object_database *alt;
1629 *path = sha1_file_name(sha1);
1630 if (!lstat(*path, st))
1631 return 0;
1633 prepare_alt_odb();
1634 errno = ENOENT;
1635 for (alt = alt_odb_list; alt; alt = alt->next) {
1636 *path = alt_sha1_path(alt, sha1);
1637 if (!lstat(*path, st))
1638 return 0;
1641 return -1;
1645 * Like stat_sha1_file(), but actually open the object and return the
1646 * descriptor. See the caveats on the "path" parameter above.
1648 static int open_sha1_file(const unsigned char *sha1, const char **path)
1650 int fd;
1651 struct alternate_object_database *alt;
1652 int most_interesting_errno;
1654 *path = sha1_file_name(sha1);
1655 fd = git_open(*path);
1656 if (fd >= 0)
1657 return fd;
1658 most_interesting_errno = errno;
1660 prepare_alt_odb();
1661 for (alt = alt_odb_list; alt; alt = alt->next) {
1662 *path = alt_sha1_path(alt, sha1);
1663 fd = git_open(*path);
1664 if (fd >= 0)
1665 return fd;
1666 if (most_interesting_errno == ENOENT)
1667 most_interesting_errno = errno;
1669 errno = most_interesting_errno;
1670 return -1;
1674 * Map the loose object at "path" if it is not NULL, or the path found by
1675 * searching for a loose object named "sha1".
1677 static void *map_sha1_file_1(const char *path,
1678 const unsigned char *sha1,
1679 unsigned long *size)
1681 void *map;
1682 int fd;
1684 if (path)
1685 fd = git_open(path);
1686 else
1687 fd = open_sha1_file(sha1, &path);
1688 map = NULL;
1689 if (fd >= 0) {
1690 struct stat st;
1692 if (!fstat(fd, &st)) {
1693 *size = xsize_t(st.st_size);
1694 if (!*size) {
1695 /* mmap() is forbidden on empty files */
1696 error("object file %s is empty", path);
1697 return NULL;
1699 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1701 close(fd);
1703 return map;
1706 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1708 return map_sha1_file_1(NULL, sha1, size);
1711 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1712 unsigned long len, enum object_type *type, unsigned long *sizep)
1714 unsigned shift;
1715 unsigned long size, c;
1716 unsigned long used = 0;
1718 c = buf[used++];
1719 *type = (c >> 4) & 7;
1720 size = c & 15;
1721 shift = 4;
1722 while (c & 0x80) {
1723 if (len <= used || bitsizeof(long) <= shift) {
1724 error("bad object header");
1725 size = used = 0;
1726 break;
1728 c = buf[used++];
1729 size += (c & 0x7f) << shift;
1730 shift += 7;
1732 *sizep = size;
1733 return used;
1736 static int unpack_sha1_short_header(git_zstream *stream,
1737 unsigned char *map, unsigned long mapsize,
1738 void *buffer, unsigned long bufsiz)
1740 /* Get the data stream */
1741 memset(stream, 0, sizeof(*stream));
1742 stream->next_in = map;
1743 stream->avail_in = mapsize;
1744 stream->next_out = buffer;
1745 stream->avail_out = bufsiz;
1747 git_inflate_init(stream);
1748 return git_inflate(stream, 0);
1751 int unpack_sha1_header(git_zstream *stream,
1752 unsigned char *map, unsigned long mapsize,
1753 void *buffer, unsigned long bufsiz)
1755 int status = unpack_sha1_short_header(stream, map, mapsize,
1756 buffer, bufsiz);
1758 if (status < Z_OK)
1759 return status;
1761 /* Make sure we have the terminating NUL */
1762 if (!memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1763 return -1;
1764 return 0;
1767 static int unpack_sha1_header_to_strbuf(git_zstream *stream, unsigned char *map,
1768 unsigned long mapsize, void *buffer,
1769 unsigned long bufsiz, struct strbuf *header)
1771 int status;
1773 status = unpack_sha1_short_header(stream, map, mapsize, buffer, bufsiz);
1774 if (status < Z_OK)
1775 return -1;
1778 * Check if entire header is unpacked in the first iteration.
1780 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1781 return 0;
1784 * buffer[0..bufsiz] was not large enough. Copy the partial
1785 * result out to header, and then append the result of further
1786 * reading the stream.
1788 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1789 stream->next_out = buffer;
1790 stream->avail_out = bufsiz;
1792 do {
1793 status = git_inflate(stream, 0);
1794 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1795 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1796 return 0;
1797 stream->next_out = buffer;
1798 stream->avail_out = bufsiz;
1799 } while (status != Z_STREAM_END);
1800 return -1;
1803 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1805 int bytes = strlen(buffer) + 1;
1806 unsigned char *buf = xmallocz(size);
1807 unsigned long n;
1808 int status = Z_OK;
1810 n = stream->total_out - bytes;
1811 if (n > size)
1812 n = size;
1813 memcpy(buf, (char *) buffer + bytes, n);
1814 bytes = n;
1815 if (bytes <= size) {
1817 * The above condition must be (bytes <= size), not
1818 * (bytes < size). In other words, even though we
1819 * expect no more output and set avail_out to zero,
1820 * the input zlib stream may have bytes that express
1821 * "this concludes the stream", and we *do* want to
1822 * eat that input.
1824 * Otherwise we would not be able to test that we
1825 * consumed all the input to reach the expected size;
1826 * we also want to check that zlib tells us that all
1827 * went well with status == Z_STREAM_END at the end.
1829 stream->next_out = buf + bytes;
1830 stream->avail_out = size - bytes;
1831 while (status == Z_OK)
1832 status = git_inflate(stream, Z_FINISH);
1834 if (status == Z_STREAM_END && !stream->avail_in) {
1835 git_inflate_end(stream);
1836 return buf;
1839 if (status < 0)
1840 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1841 else if (stream->avail_in)
1842 error("garbage at end of loose object '%s'",
1843 sha1_to_hex(sha1));
1844 free(buf);
1845 return NULL;
1849 * We used to just use "sscanf()", but that's actually way
1850 * too permissive for what we want to check. So do an anal
1851 * object header parse by hand.
1853 static int parse_sha1_header_extended(const char *hdr, struct object_info *oi,
1854 unsigned int flags)
1856 const char *type_buf = hdr;
1857 unsigned long size;
1858 int type, type_len = 0;
1861 * The type can be of any size but is followed by
1862 * a space.
1864 for (;;) {
1865 char c = *hdr++;
1866 if (!c)
1867 return -1;
1868 if (c == ' ')
1869 break;
1870 type_len++;
1873 type = type_from_string_gently(type_buf, type_len, 1);
1874 if (oi->typename)
1875 strbuf_add(oi->typename, type_buf, type_len);
1877 * Set type to 0 if its an unknown object and
1878 * we're obtaining the type using '--allow-unknown-type'
1879 * option.
1881 if ((flags & LOOKUP_UNKNOWN_OBJECT) && (type < 0))
1882 type = 0;
1883 else if (type < 0)
1884 die("invalid object type");
1885 if (oi->typep)
1886 *oi->typep = type;
1889 * The length must follow immediately, and be in canonical
1890 * decimal format (ie "010" is not valid).
1892 size = *hdr++ - '0';
1893 if (size > 9)
1894 return -1;
1895 if (size) {
1896 for (;;) {
1897 unsigned long c = *hdr - '0';
1898 if (c > 9)
1899 break;
1900 hdr++;
1901 size = size * 10 + c;
1905 if (oi->sizep)
1906 *oi->sizep = size;
1909 * The length must be followed by a zero byte
1911 return *hdr ? -1 : type;
1914 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1916 struct object_info oi = OBJECT_INFO_INIT;
1918 oi.sizep = sizep;
1919 return parse_sha1_header_extended(hdr, &oi, LOOKUP_REPLACE_OBJECT);
1922 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1924 int ret;
1925 git_zstream stream;
1926 char hdr[8192];
1928 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1929 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1930 return NULL;
1932 return unpack_sha1_rest(&stream, hdr, *size, sha1);
1935 unsigned long get_size_from_delta(struct packed_git *p,
1936 struct pack_window **w_curs,
1937 off_t curpos)
1939 const unsigned char *data;
1940 unsigned char delta_head[20], *in;
1941 git_zstream stream;
1942 int st;
1944 memset(&stream, 0, sizeof(stream));
1945 stream.next_out = delta_head;
1946 stream.avail_out = sizeof(delta_head);
1948 git_inflate_init(&stream);
1949 do {
1950 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1951 stream.next_in = in;
1952 st = git_inflate(&stream, Z_FINISH);
1953 curpos += stream.next_in - in;
1954 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1955 stream.total_out < sizeof(delta_head));
1956 git_inflate_end(&stream);
1957 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1958 error("delta data unpack-initial failed");
1959 return 0;
1962 /* Examine the initial part of the delta to figure out
1963 * the result size.
1965 data = delta_head;
1967 /* ignore base size */
1968 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1970 /* Read the result size */
1971 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1974 static off_t get_delta_base(struct packed_git *p,
1975 struct pack_window **w_curs,
1976 off_t *curpos,
1977 enum object_type type,
1978 off_t delta_obj_offset)
1980 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1981 off_t base_offset;
1983 /* use_pack() assured us we have [base_info, base_info + 20)
1984 * as a range that we can look at without walking off the
1985 * end of the mapped window. Its actually the hash size
1986 * that is assured. An OFS_DELTA longer than the hash size
1987 * is stupid, as then a REF_DELTA would be smaller to store.
1989 if (type == OBJ_OFS_DELTA) {
1990 unsigned used = 0;
1991 unsigned char c = base_info[used++];
1992 base_offset = c & 127;
1993 while (c & 128) {
1994 base_offset += 1;
1995 if (!base_offset || MSB(base_offset, 7))
1996 return 0; /* overflow */
1997 c = base_info[used++];
1998 base_offset = (base_offset << 7) + (c & 127);
2000 base_offset = delta_obj_offset - base_offset;
2001 if (base_offset <= 0 || base_offset >= delta_obj_offset)
2002 return 0; /* out of bound */
2003 *curpos += used;
2004 } else if (type == OBJ_REF_DELTA) {
2005 /* The base entry _must_ be in the same pack */
2006 base_offset = find_pack_entry_one(base_info, p);
2007 *curpos += 20;
2008 } else
2009 die("I am totally screwed");
2010 return base_offset;
2014 * Like get_delta_base above, but we return the sha1 instead of the pack
2015 * offset. This means it is cheaper for REF deltas (we do not have to do
2016 * the final object lookup), but more expensive for OFS deltas (we
2017 * have to load the revidx to convert the offset back into a sha1).
2019 static const unsigned char *get_delta_base_sha1(struct packed_git *p,
2020 struct pack_window **w_curs,
2021 off_t curpos,
2022 enum object_type type,
2023 off_t delta_obj_offset)
2025 if (type == OBJ_REF_DELTA) {
2026 unsigned char *base = use_pack(p, w_curs, curpos, NULL);
2027 return base;
2028 } else if (type == OBJ_OFS_DELTA) {
2029 struct revindex_entry *revidx;
2030 off_t base_offset = get_delta_base(p, w_curs, &curpos,
2031 type, delta_obj_offset);
2033 if (!base_offset)
2034 return NULL;
2036 revidx = find_pack_revindex(p, base_offset);
2037 if (!revidx)
2038 return NULL;
2040 return nth_packed_object_sha1(p, revidx->nr);
2041 } else
2042 return NULL;
2045 int unpack_object_header(struct packed_git *p,
2046 struct pack_window **w_curs,
2047 off_t *curpos,
2048 unsigned long *sizep)
2050 unsigned char *base;
2051 unsigned long left;
2052 unsigned long used;
2053 enum object_type type;
2055 /* use_pack() assures us we have [base, base + 20) available
2056 * as a range that we can look at. (Its actually the hash
2057 * size that is assured.) With our object header encoding
2058 * the maximum deflated object size is 2^137, which is just
2059 * insane, so we know won't exceed what we have been given.
2061 base = use_pack(p, w_curs, *curpos, &left);
2062 used = unpack_object_header_buffer(base, left, &type, sizep);
2063 if (!used) {
2064 type = OBJ_BAD;
2065 } else
2066 *curpos += used;
2068 return type;
2071 static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
2073 int type;
2074 struct revindex_entry *revidx;
2075 const unsigned char *sha1;
2076 revidx = find_pack_revindex(p, obj_offset);
2077 if (!revidx)
2078 return OBJ_BAD;
2079 sha1 = nth_packed_object_sha1(p, revidx->nr);
2080 mark_bad_packed_object(p, sha1);
2081 type = sha1_object_info(sha1, NULL);
2082 if (type <= OBJ_NONE)
2083 return OBJ_BAD;
2084 return type;
2087 #define POI_STACK_PREALLOC 64
2089 static enum object_type packed_to_object_type(struct packed_git *p,
2090 off_t obj_offset,
2091 enum object_type type,
2092 struct pack_window **w_curs,
2093 off_t curpos)
2095 off_t small_poi_stack[POI_STACK_PREALLOC];
2096 off_t *poi_stack = small_poi_stack;
2097 int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
2099 while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2100 off_t base_offset;
2101 unsigned long size;
2102 /* Push the object we're going to leave behind */
2103 if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
2104 poi_stack_alloc = alloc_nr(poi_stack_nr);
2105 ALLOC_ARRAY(poi_stack, poi_stack_alloc);
2106 memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
2107 } else {
2108 ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
2110 poi_stack[poi_stack_nr++] = obj_offset;
2111 /* If parsing the base offset fails, just unwind */
2112 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
2113 if (!base_offset)
2114 goto unwind;
2115 curpos = obj_offset = base_offset;
2116 type = unpack_object_header(p, w_curs, &curpos, &size);
2117 if (type <= OBJ_NONE) {
2118 /* If getting the base itself fails, we first
2119 * retry the base, otherwise unwind */
2120 type = retry_bad_packed_offset(p, base_offset);
2121 if (type > OBJ_NONE)
2122 goto out;
2123 goto unwind;
2127 switch (type) {
2128 case OBJ_BAD:
2129 case OBJ_COMMIT:
2130 case OBJ_TREE:
2131 case OBJ_BLOB:
2132 case OBJ_TAG:
2133 break;
2134 default:
2135 error("unknown object type %i at offset %"PRIuMAX" in %s",
2136 type, (uintmax_t)obj_offset, p->pack_name);
2137 type = OBJ_BAD;
2140 out:
2141 if (poi_stack != small_poi_stack)
2142 free(poi_stack);
2143 return type;
2145 unwind:
2146 while (poi_stack_nr) {
2147 obj_offset = poi_stack[--poi_stack_nr];
2148 type = retry_bad_packed_offset(p, obj_offset);
2149 if (type > OBJ_NONE)
2150 goto out;
2152 type = OBJ_BAD;
2153 goto out;
2156 int packed_object_info(struct packed_git *p, off_t obj_offset,
2157 struct object_info *oi)
2159 struct pack_window *w_curs = NULL;
2160 unsigned long size;
2161 off_t curpos = obj_offset;
2162 enum object_type type;
2165 * We always get the representation type, but only convert it to
2166 * a "real" type later if the caller is interested.
2168 type = unpack_object_header(p, &w_curs, &curpos, &size);
2170 if (oi->sizep) {
2171 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2172 off_t tmp_pos = curpos;
2173 off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
2174 type, obj_offset);
2175 if (!base_offset) {
2176 type = OBJ_BAD;
2177 goto out;
2179 *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
2180 if (*oi->sizep == 0) {
2181 type = OBJ_BAD;
2182 goto out;
2184 } else {
2185 *oi->sizep = size;
2189 if (oi->disk_sizep) {
2190 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2191 *oi->disk_sizep = revidx[1].offset - obj_offset;
2194 if (oi->typep) {
2195 *oi->typep = packed_to_object_type(p, obj_offset, type, &w_curs, curpos);
2196 if (*oi->typep < 0) {
2197 type = OBJ_BAD;
2198 goto out;
2202 if (oi->delta_base_sha1) {
2203 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2204 const unsigned char *base;
2206 base = get_delta_base_sha1(p, &w_curs, curpos,
2207 type, obj_offset);
2208 if (!base) {
2209 type = OBJ_BAD;
2210 goto out;
2213 hashcpy(oi->delta_base_sha1, base);
2214 } else
2215 hashclr(oi->delta_base_sha1);
2218 out:
2219 unuse_pack(&w_curs);
2220 return type;
2223 static void *unpack_compressed_entry(struct packed_git *p,
2224 struct pack_window **w_curs,
2225 off_t curpos,
2226 unsigned long size)
2228 int st;
2229 git_zstream stream;
2230 unsigned char *buffer, *in;
2232 buffer = xmallocz_gently(size);
2233 if (!buffer)
2234 return NULL;
2235 memset(&stream, 0, sizeof(stream));
2236 stream.next_out = buffer;
2237 stream.avail_out = size + 1;
2239 git_inflate_init(&stream);
2240 do {
2241 in = use_pack(p, w_curs, curpos, &stream.avail_in);
2242 stream.next_in = in;
2243 st = git_inflate(&stream, Z_FINISH);
2244 if (!stream.avail_out)
2245 break; /* the payload is larger than it should be */
2246 curpos += stream.next_in - in;
2247 } while (st == Z_OK || st == Z_BUF_ERROR);
2248 git_inflate_end(&stream);
2249 if ((st != Z_STREAM_END) || stream.total_out != size) {
2250 free(buffer);
2251 return NULL;
2254 return buffer;
2257 static struct hashmap delta_base_cache;
2258 static size_t delta_base_cached;
2260 static LIST_HEAD(delta_base_cache_lru);
2262 struct delta_base_cache_key {
2263 struct packed_git *p;
2264 off_t base_offset;
2267 struct delta_base_cache_entry {
2268 struct hashmap hash;
2269 struct delta_base_cache_key key;
2270 struct list_head lru;
2271 void *data;
2272 unsigned long size;
2273 enum object_type type;
2276 static unsigned int pack_entry_hash(struct packed_git *p, off_t base_offset)
2278 unsigned int hash;
2280 hash = (unsigned int)(intptr_t)p + (unsigned int)base_offset;
2281 hash += (hash >> 8) + (hash >> 16);
2282 return hash;
2285 static struct delta_base_cache_entry *
2286 get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
2288 struct hashmap_entry entry;
2289 struct delta_base_cache_key key;
2291 if (!delta_base_cache.cmpfn)
2292 return NULL;
2294 hashmap_entry_init(&entry, pack_entry_hash(p, base_offset));
2295 key.p = p;
2296 key.base_offset = base_offset;
2297 return hashmap_get(&delta_base_cache, &entry, &key);
2300 static int delta_base_cache_key_eq(const struct delta_base_cache_key *a,
2301 const struct delta_base_cache_key *b)
2303 return a->p == b->p && a->base_offset == b->base_offset;
2306 static int delta_base_cache_hash_cmp(const void *va, const void *vb,
2307 const void *vkey)
2309 const struct delta_base_cache_entry *a = va, *b = vb;
2310 const struct delta_base_cache_key *key = vkey;
2311 if (key)
2312 return !delta_base_cache_key_eq(&a->key, key);
2313 else
2314 return !delta_base_cache_key_eq(&a->key, &b->key);
2317 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
2319 return !!get_delta_base_cache_entry(p, base_offset);
2323 * Remove the entry from the cache, but do _not_ free the associated
2324 * entry data. The caller takes ownership of the "data" buffer, and
2325 * should copy out any fields it wants before detaching.
2327 static void detach_delta_base_cache_entry(struct delta_base_cache_entry *ent)
2329 hashmap_remove(&delta_base_cache, ent, &ent->key);
2330 list_del(&ent->lru);
2331 delta_base_cached -= ent->size;
2332 free(ent);
2335 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
2336 unsigned long *base_size, enum object_type *type)
2338 struct delta_base_cache_entry *ent;
2340 ent = get_delta_base_cache_entry(p, base_offset);
2341 if (!ent)
2342 return unpack_entry(p, base_offset, type, base_size);
2344 *type = ent->type;
2345 *base_size = ent->size;
2346 return xmemdupz(ent->data, ent->size);
2349 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
2351 free(ent->data);
2352 detach_delta_base_cache_entry(ent);
2355 void clear_delta_base_cache(void)
2357 struct hashmap_iter iter;
2358 struct delta_base_cache_entry *entry;
2359 for (entry = hashmap_iter_first(&delta_base_cache, &iter);
2360 entry;
2361 entry = hashmap_iter_next(&iter)) {
2362 release_delta_base_cache(entry);
2366 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
2367 void *base, unsigned long base_size, enum object_type type)
2369 struct delta_base_cache_entry *ent = xmalloc(sizeof(*ent));
2370 struct list_head *lru, *tmp;
2372 delta_base_cached += base_size;
2374 list_for_each_safe(lru, tmp, &delta_base_cache_lru) {
2375 struct delta_base_cache_entry *f =
2376 list_entry(lru, struct delta_base_cache_entry, lru);
2377 if (delta_base_cached <= delta_base_cache_limit)
2378 break;
2379 release_delta_base_cache(f);
2382 ent->key.p = p;
2383 ent->key.base_offset = base_offset;
2384 ent->type = type;
2385 ent->data = base;
2386 ent->size = base_size;
2387 list_add_tail(&ent->lru, &delta_base_cache_lru);
2389 if (!delta_base_cache.cmpfn)
2390 hashmap_init(&delta_base_cache, delta_base_cache_hash_cmp, 0);
2391 hashmap_entry_init(ent, pack_entry_hash(p, base_offset));
2392 hashmap_add(&delta_base_cache, ent);
2395 static void *read_object(const unsigned char *sha1, enum object_type *type,
2396 unsigned long *size);
2398 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
2400 static struct trace_key pack_access = TRACE_KEY_INIT(PACK_ACCESS);
2401 trace_printf_key(&pack_access, "%s %"PRIuMAX"\n",
2402 p->pack_name, (uintmax_t)obj_offset);
2405 int do_check_packed_object_crc;
2407 #define UNPACK_ENTRY_STACK_PREALLOC 64
2408 struct unpack_entry_stack_ent {
2409 off_t obj_offset;
2410 off_t curpos;
2411 unsigned long size;
2414 void *unpack_entry(struct packed_git *p, off_t obj_offset,
2415 enum object_type *final_type, unsigned long *final_size)
2417 struct pack_window *w_curs = NULL;
2418 off_t curpos = obj_offset;
2419 void *data = NULL;
2420 unsigned long size;
2421 enum object_type type;
2422 struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
2423 struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
2424 int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
2425 int base_from_cache = 0;
2427 write_pack_access_log(p, obj_offset);
2429 /* PHASE 1: drill down to the innermost base object */
2430 for (;;) {
2431 off_t base_offset;
2432 int i;
2433 struct delta_base_cache_entry *ent;
2435 ent = get_delta_base_cache_entry(p, curpos);
2436 if (ent) {
2437 type = ent->type;
2438 data = ent->data;
2439 size = ent->size;
2440 detach_delta_base_cache_entry(ent);
2441 base_from_cache = 1;
2442 break;
2445 if (do_check_packed_object_crc && p->index_version > 1) {
2446 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2447 off_t len = revidx[1].offset - obj_offset;
2448 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
2449 const unsigned char *sha1 =
2450 nth_packed_object_sha1(p, revidx->nr);
2451 error("bad packed object CRC for %s",
2452 sha1_to_hex(sha1));
2453 mark_bad_packed_object(p, sha1);
2454 unuse_pack(&w_curs);
2455 return NULL;
2459 type = unpack_object_header(p, &w_curs, &curpos, &size);
2460 if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
2461 break;
2463 base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
2464 if (!base_offset) {
2465 error("failed to validate delta base reference "
2466 "at offset %"PRIuMAX" from %s",
2467 (uintmax_t)curpos, p->pack_name);
2468 /* bail to phase 2, in hopes of recovery */
2469 data = NULL;
2470 break;
2473 /* push object, proceed to base */
2474 if (delta_stack_nr >= delta_stack_alloc
2475 && delta_stack == small_delta_stack) {
2476 delta_stack_alloc = alloc_nr(delta_stack_nr);
2477 ALLOC_ARRAY(delta_stack, delta_stack_alloc);
2478 memcpy(delta_stack, small_delta_stack,
2479 sizeof(*delta_stack)*delta_stack_nr);
2480 } else {
2481 ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
2483 i = delta_stack_nr++;
2484 delta_stack[i].obj_offset = obj_offset;
2485 delta_stack[i].curpos = curpos;
2486 delta_stack[i].size = size;
2488 curpos = obj_offset = base_offset;
2491 /* PHASE 2: handle the base */
2492 switch (type) {
2493 case OBJ_OFS_DELTA:
2494 case OBJ_REF_DELTA:
2495 if (data)
2496 die("BUG: unpack_entry: left loop at a valid delta");
2497 break;
2498 case OBJ_COMMIT:
2499 case OBJ_TREE:
2500 case OBJ_BLOB:
2501 case OBJ_TAG:
2502 if (!base_from_cache)
2503 data = unpack_compressed_entry(p, &w_curs, curpos, size);
2504 break;
2505 default:
2506 data = NULL;
2507 error("unknown object type %i at offset %"PRIuMAX" in %s",
2508 type, (uintmax_t)obj_offset, p->pack_name);
2511 /* PHASE 3: apply deltas in order */
2513 /* invariants:
2514 * 'data' holds the base data, or NULL if there was corruption
2516 while (delta_stack_nr) {
2517 void *delta_data;
2518 void *base = data;
2519 unsigned long delta_size, base_size = size;
2520 int i;
2522 data = NULL;
2524 if (base)
2525 add_delta_base_cache(p, obj_offset, base, base_size, type);
2527 if (!base) {
2529 * We're probably in deep shit, but let's try to fetch
2530 * the required base anyway from another pack or loose.
2531 * This is costly but should happen only in the presence
2532 * of a corrupted pack, and is better than failing outright.
2534 struct revindex_entry *revidx;
2535 const unsigned char *base_sha1;
2536 revidx = find_pack_revindex(p, obj_offset);
2537 if (revidx) {
2538 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
2539 error("failed to read delta base object %s"
2540 " at offset %"PRIuMAX" from %s",
2541 sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
2542 p->pack_name);
2543 mark_bad_packed_object(p, base_sha1);
2544 base = read_object(base_sha1, &type, &base_size);
2548 i = --delta_stack_nr;
2549 obj_offset = delta_stack[i].obj_offset;
2550 curpos = delta_stack[i].curpos;
2551 delta_size = delta_stack[i].size;
2553 if (!base)
2554 continue;
2556 delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
2558 if (!delta_data) {
2559 error("failed to unpack compressed delta "
2560 "at offset %"PRIuMAX" from %s",
2561 (uintmax_t)curpos, p->pack_name);
2562 data = NULL;
2563 continue;
2566 data = patch_delta(base, base_size,
2567 delta_data, delta_size,
2568 &size);
2571 * We could not apply the delta; warn the user, but keep going.
2572 * Our failure will be noticed either in the next iteration of
2573 * the loop, or if this is the final delta, in the caller when
2574 * we return NULL. Those code paths will take care of making
2575 * a more explicit warning and retrying with another copy of
2576 * the object.
2578 if (!data)
2579 error("failed to apply delta");
2581 free(delta_data);
2584 *final_type = type;
2585 *final_size = size;
2587 unuse_pack(&w_curs);
2589 if (delta_stack != small_delta_stack)
2590 free(delta_stack);
2592 return data;
2595 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2596 uint32_t n)
2598 const unsigned char *index = p->index_data;
2599 if (!index) {
2600 if (open_pack_index(p))
2601 return NULL;
2602 index = p->index_data;
2604 if (n >= p->num_objects)
2605 return NULL;
2606 index += 4 * 256;
2607 if (p->index_version == 1) {
2608 return index + 24 * n + 4;
2609 } else {
2610 index += 8;
2611 return index + 20 * n;
2615 void check_pack_index_ptr(const struct packed_git *p, const void *vptr)
2617 const unsigned char *ptr = vptr;
2618 const unsigned char *start = p->index_data;
2619 const unsigned char *end = start + p->index_size;
2620 if (ptr < start)
2621 die(_("offset before start of pack index for %s (corrupt index?)"),
2622 p->pack_name);
2623 /* No need to check for underflow; .idx files must be at least 8 bytes */
2624 if (ptr >= end - 8)
2625 die(_("offset beyond end of pack index for %s (truncated index?)"),
2626 p->pack_name);
2629 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2631 const unsigned char *index = p->index_data;
2632 index += 4 * 256;
2633 if (p->index_version == 1) {
2634 return ntohl(*((uint32_t *)(index + 24 * n)));
2635 } else {
2636 uint32_t off;
2637 index += 8 + p->num_objects * (20 + 4);
2638 off = ntohl(*((uint32_t *)(index + 4 * n)));
2639 if (!(off & 0x80000000))
2640 return off;
2641 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2642 check_pack_index_ptr(p, index);
2643 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2644 ntohl(*((uint32_t *)(index + 4)));
2648 off_t find_pack_entry_one(const unsigned char *sha1,
2649 struct packed_git *p)
2651 const uint32_t *level1_ofs = p->index_data;
2652 const unsigned char *index = p->index_data;
2653 unsigned hi, lo, stride;
2654 static int use_lookup = -1;
2655 static int debug_lookup = -1;
2657 if (debug_lookup < 0)
2658 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2660 if (!index) {
2661 if (open_pack_index(p))
2662 return 0;
2663 level1_ofs = p->index_data;
2664 index = p->index_data;
2666 if (p->index_version > 1) {
2667 level1_ofs += 2;
2668 index += 8;
2670 index += 4 * 256;
2671 hi = ntohl(level1_ofs[*sha1]);
2672 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2673 if (p->index_version > 1) {
2674 stride = 20;
2675 } else {
2676 stride = 24;
2677 index += 4;
2680 if (debug_lookup)
2681 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2682 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2684 if (use_lookup < 0)
2685 use_lookup = !!getenv("GIT_USE_LOOKUP");
2686 if (use_lookup) {
2687 int pos = sha1_entry_pos(index, stride, 0,
2688 lo, hi, p->num_objects, sha1);
2689 if (pos < 0)
2690 return 0;
2691 return nth_packed_object_offset(p, pos);
2694 do {
2695 unsigned mi = (lo + hi) / 2;
2696 int cmp = hashcmp(index + mi * stride, sha1);
2698 if (debug_lookup)
2699 printf("lo %u hi %u rg %u mi %u\n",
2700 lo, hi, hi - lo, mi);
2701 if (!cmp)
2702 return nth_packed_object_offset(p, mi);
2703 if (cmp > 0)
2704 hi = mi;
2705 else
2706 lo = mi+1;
2707 } while (lo < hi);
2708 return 0;
2711 int is_pack_valid(struct packed_git *p)
2713 /* An already open pack is known to be valid. */
2714 if (p->pack_fd != -1)
2715 return 1;
2717 /* If the pack has one window completely covering the
2718 * file size, the pack is known to be valid even if
2719 * the descriptor is not currently open.
2721 if (p->windows) {
2722 struct pack_window *w = p->windows;
2724 if (!w->offset && w->len == p->pack_size)
2725 return 1;
2728 /* Force the pack to open to prove its valid. */
2729 return !open_packed_git(p);
2732 static int fill_pack_entry(const unsigned char *sha1,
2733 struct pack_entry *e,
2734 struct packed_git *p)
2736 off_t offset;
2738 if (p->num_bad_objects) {
2739 unsigned i;
2740 for (i = 0; i < p->num_bad_objects; i++)
2741 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2742 return 0;
2745 offset = find_pack_entry_one(sha1, p);
2746 if (!offset)
2747 return 0;
2750 * We are about to tell the caller where they can locate the
2751 * requested object. We better make sure the packfile is
2752 * still here and can be accessed before supplying that
2753 * answer, as it may have been deleted since the index was
2754 * loaded!
2756 if (!is_pack_valid(p))
2757 return 0;
2758 e->offset = offset;
2759 e->p = p;
2760 hashcpy(e->sha1, sha1);
2761 return 1;
2765 * Iff a pack file contains the object named by sha1, return true and
2766 * store its location to e.
2768 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2770 struct mru_entry *p;
2772 prepare_packed_git();
2773 if (!packed_git)
2774 return 0;
2776 for (p = packed_git_mru->head; p; p = p->next) {
2777 if (fill_pack_entry(sha1, e, p->item)) {
2778 mru_mark(packed_git_mru, p);
2779 return 1;
2782 return 0;
2785 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2786 struct packed_git *packs)
2788 struct packed_git *p;
2790 for (p = packs; p; p = p->next) {
2791 if (find_pack_entry_one(sha1, p))
2792 return p;
2794 return NULL;
2798 static int sha1_loose_object_info(const unsigned char *sha1,
2799 struct object_info *oi,
2800 int flags)
2802 int status = 0;
2803 unsigned long mapsize;
2804 void *map;
2805 git_zstream stream;
2806 char hdr[32];
2807 struct strbuf hdrbuf = STRBUF_INIT;
2809 if (oi->delta_base_sha1)
2810 hashclr(oi->delta_base_sha1);
2813 * If we don't care about type or size, then we don't
2814 * need to look inside the object at all. Note that we
2815 * do not optimize out the stat call, even if the
2816 * caller doesn't care about the disk-size, since our
2817 * return value implicitly indicates whether the
2818 * object even exists.
2820 if (!oi->typep && !oi->typename && !oi->sizep) {
2821 const char *path;
2822 struct stat st;
2823 if (stat_sha1_file(sha1, &st, &path) < 0)
2824 return -1;
2825 if (oi->disk_sizep)
2826 *oi->disk_sizep = st.st_size;
2827 return 0;
2830 map = map_sha1_file(sha1, &mapsize);
2831 if (!map)
2832 return -1;
2833 if (oi->disk_sizep)
2834 *oi->disk_sizep = mapsize;
2835 if ((flags & LOOKUP_UNKNOWN_OBJECT)) {
2836 if (unpack_sha1_header_to_strbuf(&stream, map, mapsize, hdr, sizeof(hdr), &hdrbuf) < 0)
2837 status = error("unable to unpack %s header with --allow-unknown-type",
2838 sha1_to_hex(sha1));
2839 } else if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2840 status = error("unable to unpack %s header",
2841 sha1_to_hex(sha1));
2842 if (status < 0)
2843 ; /* Do nothing */
2844 else if (hdrbuf.len) {
2845 if ((status = parse_sha1_header_extended(hdrbuf.buf, oi, flags)) < 0)
2846 status = error("unable to parse %s header with --allow-unknown-type",
2847 sha1_to_hex(sha1));
2848 } else if ((status = parse_sha1_header_extended(hdr, oi, flags)) < 0)
2849 status = error("unable to parse %s header", sha1_to_hex(sha1));
2850 git_inflate_end(&stream);
2851 munmap(map, mapsize);
2852 if (status && oi->typep)
2853 *oi->typep = status;
2854 strbuf_release(&hdrbuf);
2855 return 0;
2858 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi, unsigned flags)
2860 struct cached_object *co;
2861 struct pack_entry e;
2862 int rtype;
2863 enum object_type real_type;
2864 const unsigned char *real = lookup_replace_object_extended(sha1, flags);
2866 co = find_cached_object(real);
2867 if (co) {
2868 if (oi->typep)
2869 *(oi->typep) = co->type;
2870 if (oi->sizep)
2871 *(oi->sizep) = co->size;
2872 if (oi->disk_sizep)
2873 *(oi->disk_sizep) = 0;
2874 if (oi->delta_base_sha1)
2875 hashclr(oi->delta_base_sha1);
2876 if (oi->typename)
2877 strbuf_addstr(oi->typename, typename(co->type));
2878 oi->whence = OI_CACHED;
2879 return 0;
2882 if (!find_pack_entry(real, &e)) {
2883 /* Most likely it's a loose object. */
2884 if (!sha1_loose_object_info(real, oi, flags)) {
2885 oi->whence = OI_LOOSE;
2886 return 0;
2889 /* Not a loose object; someone else may have just packed it. */
2890 reprepare_packed_git();
2891 if (!find_pack_entry(real, &e))
2892 return -1;
2896 * packed_object_info() does not follow the delta chain to
2897 * find out the real type, unless it is given oi->typep.
2899 if (oi->typename && !oi->typep)
2900 oi->typep = &real_type;
2902 rtype = packed_object_info(e.p, e.offset, oi);
2903 if (rtype < 0) {
2904 mark_bad_packed_object(e.p, real);
2905 if (oi->typep == &real_type)
2906 oi->typep = NULL;
2907 return sha1_object_info_extended(real, oi, 0);
2908 } else if (in_delta_base_cache(e.p, e.offset)) {
2909 oi->whence = OI_DBCACHED;
2910 } else {
2911 oi->whence = OI_PACKED;
2912 oi->u.packed.offset = e.offset;
2913 oi->u.packed.pack = e.p;
2914 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2915 rtype == OBJ_OFS_DELTA);
2917 if (oi->typename)
2918 strbuf_addstr(oi->typename, typename(*oi->typep));
2919 if (oi->typep == &real_type)
2920 oi->typep = NULL;
2922 return 0;
2925 /* returns enum object_type or negative */
2926 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2928 enum object_type type;
2929 struct object_info oi = OBJECT_INFO_INIT;
2931 oi.typep = &type;
2932 oi.sizep = sizep;
2933 if (sha1_object_info_extended(sha1, &oi, LOOKUP_REPLACE_OBJECT) < 0)
2934 return -1;
2935 return type;
2938 static void *read_packed_sha1(const unsigned char *sha1,
2939 enum object_type *type, unsigned long *size)
2941 struct pack_entry e;
2942 void *data;
2944 if (!find_pack_entry(sha1, &e))
2945 return NULL;
2946 data = cache_or_unpack_entry(e.p, e.offset, size, type);
2947 if (!data) {
2949 * We're probably in deep shit, but let's try to fetch
2950 * the required object anyway from another pack or loose.
2951 * This should happen only in the presence of a corrupted
2952 * pack, and is better than failing outright.
2954 error("failed to read object %s at offset %"PRIuMAX" from %s",
2955 sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2956 mark_bad_packed_object(e.p, sha1);
2957 data = read_object(sha1, type, size);
2959 return data;
2962 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2963 unsigned char *sha1)
2965 struct cached_object *co;
2967 hash_sha1_file(buf, len, typename(type), sha1);
2968 if (has_sha1_file(sha1) || find_cached_object(sha1))
2969 return 0;
2970 ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
2971 co = &cached_objects[cached_object_nr++];
2972 co->size = len;
2973 co->type = type;
2974 co->buf = xmalloc(len);
2975 memcpy(co->buf, buf, len);
2976 hashcpy(co->sha1, sha1);
2977 return 0;
2980 static void *read_object(const unsigned char *sha1, enum object_type *type,
2981 unsigned long *size)
2983 unsigned long mapsize;
2984 void *map, *buf;
2985 struct cached_object *co;
2987 co = find_cached_object(sha1);
2988 if (co) {
2989 *type = co->type;
2990 *size = co->size;
2991 return xmemdupz(co->buf, co->size);
2994 buf = read_packed_sha1(sha1, type, size);
2995 if (buf)
2996 return buf;
2997 map = map_sha1_file(sha1, &mapsize);
2998 if (map) {
2999 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
3000 munmap(map, mapsize);
3001 return buf;
3003 reprepare_packed_git();
3004 return read_packed_sha1(sha1, type, size);
3008 * This function dies on corrupt objects; the callers who want to
3009 * deal with them should arrange to call read_object() and give error
3010 * messages themselves.
3012 void *read_sha1_file_extended(const unsigned char *sha1,
3013 enum object_type *type,
3014 unsigned long *size,
3015 unsigned flag)
3017 void *data;
3018 const struct packed_git *p;
3019 const char *path;
3020 struct stat st;
3021 const unsigned char *repl = lookup_replace_object_extended(sha1, flag);
3023 errno = 0;
3024 data = read_object(repl, type, size);
3025 if (data)
3026 return data;
3028 if (errno && errno != ENOENT)
3029 die_errno("failed to read object %s", sha1_to_hex(sha1));
3031 /* die if we replaced an object with one that does not exist */
3032 if (repl != sha1)
3033 die("replacement %s not found for %s",
3034 sha1_to_hex(repl), sha1_to_hex(sha1));
3036 if (!stat_sha1_file(repl, &st, &path))
3037 die("loose object %s (stored in %s) is corrupt",
3038 sha1_to_hex(repl), path);
3040 if ((p = has_packed_and_bad(repl)) != NULL)
3041 die("packed object %s (stored in %s) is corrupt",
3042 sha1_to_hex(repl), p->pack_name);
3044 return NULL;
3047 void *read_object_with_reference(const unsigned char *sha1,
3048 const char *required_type_name,
3049 unsigned long *size,
3050 unsigned char *actual_sha1_return)
3052 enum object_type type, required_type;
3053 void *buffer;
3054 unsigned long isize;
3055 unsigned char actual_sha1[20];
3057 required_type = type_from_string(required_type_name);
3058 hashcpy(actual_sha1, sha1);
3059 while (1) {
3060 int ref_length = -1;
3061 const char *ref_type = NULL;
3063 buffer = read_sha1_file(actual_sha1, &type, &isize);
3064 if (!buffer)
3065 return NULL;
3066 if (type == required_type) {
3067 *size = isize;
3068 if (actual_sha1_return)
3069 hashcpy(actual_sha1_return, actual_sha1);
3070 return buffer;
3072 /* Handle references */
3073 else if (type == OBJ_COMMIT)
3074 ref_type = "tree ";
3075 else if (type == OBJ_TAG)
3076 ref_type = "object ";
3077 else {
3078 free(buffer);
3079 return NULL;
3081 ref_length = strlen(ref_type);
3083 if (ref_length + 40 > isize ||
3084 memcmp(buffer, ref_type, ref_length) ||
3085 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
3086 free(buffer);
3087 return NULL;
3089 free(buffer);
3090 /* Now we have the ID of the referred-to object in
3091 * actual_sha1. Check again. */
3095 static void write_sha1_file_prepare(const void *buf, unsigned long len,
3096 const char *type, unsigned char *sha1,
3097 char *hdr, int *hdrlen)
3099 git_SHA_CTX c;
3101 /* Generate the header */
3102 *hdrlen = xsnprintf(hdr, *hdrlen, "%s %lu", type, len)+1;
3104 /* Sha1.. */
3105 git_SHA1_Init(&c);
3106 git_SHA1_Update(&c, hdr, *hdrlen);
3107 git_SHA1_Update(&c, buf, len);
3108 git_SHA1_Final(sha1, &c);
3112 * Move the just written object into its final resting place.
3114 int finalize_object_file(const char *tmpfile, const char *filename)
3116 int ret = 0;
3118 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
3119 goto try_rename;
3120 else if (link(tmpfile, filename))
3121 ret = errno;
3124 * Coda hack - coda doesn't like cross-directory links,
3125 * so we fall back to a rename, which will mean that it
3126 * won't be able to check collisions, but that's not a
3127 * big deal.
3129 * The same holds for FAT formatted media.
3131 * When this succeeds, we just return. We have nothing
3132 * left to unlink.
3134 if (ret && ret != EEXIST) {
3135 try_rename:
3136 if (!rename(tmpfile, filename))
3137 goto out;
3138 ret = errno;
3140 unlink_or_warn(tmpfile);
3141 if (ret) {
3142 if (ret != EEXIST) {
3143 return error_errno("unable to write sha1 filename %s", filename);
3145 /* FIXME!!! Collision check here ? */
3148 out:
3149 if (adjust_shared_perm(filename))
3150 return error("unable to set permission to '%s'", filename);
3151 return 0;
3154 static int write_buffer(int fd, const void *buf, size_t len)
3156 if (write_in_full(fd, buf, len) < 0)
3157 return error_errno("file write error");
3158 return 0;
3161 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
3162 unsigned char *sha1)
3164 char hdr[32];
3165 int hdrlen = sizeof(hdr);
3166 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3167 return 0;
3170 /* Finalize a file on disk, and close it. */
3171 static void close_sha1_file(int fd)
3173 if (fsync_object_files)
3174 fsync_or_die(fd, "sha1 file");
3175 if (close(fd) != 0)
3176 die_errno("error when closing sha1 file");
3179 /* Size of directory component, including the ending '/' */
3180 static inline int directory_size(const char *filename)
3182 const char *s = strrchr(filename, '/');
3183 if (!s)
3184 return 0;
3185 return s - filename + 1;
3189 * This creates a temporary file in the same directory as the final
3190 * 'filename'
3192 * We want to avoid cross-directory filename renames, because those
3193 * can have problems on various filesystems (FAT, NFS, Coda).
3195 static int create_tmpfile(struct strbuf *tmp, const char *filename)
3197 int fd, dirlen = directory_size(filename);
3199 strbuf_reset(tmp);
3200 strbuf_add(tmp, filename, dirlen);
3201 strbuf_addstr(tmp, "tmp_obj_XXXXXX");
3202 fd = git_mkstemp_mode(tmp->buf, 0444);
3203 if (fd < 0 && dirlen && errno == ENOENT) {
3205 * Make sure the directory exists; note that the contents
3206 * of the buffer are undefined after mkstemp returns an
3207 * error, so we have to rewrite the whole buffer from
3208 * scratch.
3210 strbuf_reset(tmp);
3211 strbuf_add(tmp, filename, dirlen - 1);
3212 if (mkdir(tmp->buf, 0777) && errno != EEXIST)
3213 return -1;
3214 if (adjust_shared_perm(tmp->buf))
3215 return -1;
3217 /* Try again */
3218 strbuf_addstr(tmp, "/tmp_obj_XXXXXX");
3219 fd = git_mkstemp_mode(tmp->buf, 0444);
3221 return fd;
3224 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
3225 const void *buf, unsigned long len, time_t mtime)
3227 int fd, ret;
3228 unsigned char compressed[4096];
3229 git_zstream stream;
3230 git_SHA_CTX c;
3231 unsigned char parano_sha1[20];
3232 static struct strbuf tmp_file = STRBUF_INIT;
3233 const char *filename = sha1_file_name(sha1);
3235 fd = create_tmpfile(&tmp_file, filename);
3236 if (fd < 0) {
3237 if (errno == EACCES)
3238 return error("insufficient permission for adding an object to repository database %s", get_object_directory());
3239 else
3240 return error_errno("unable to create temporary file");
3243 /* Set it up */
3244 git_deflate_init(&stream, zlib_compression_level);
3245 stream.next_out = compressed;
3246 stream.avail_out = sizeof(compressed);
3247 git_SHA1_Init(&c);
3249 /* First header.. */
3250 stream.next_in = (unsigned char *)hdr;
3251 stream.avail_in = hdrlen;
3252 while (git_deflate(&stream, 0) == Z_OK)
3253 ; /* nothing */
3254 git_SHA1_Update(&c, hdr, hdrlen);
3256 /* Then the data itself.. */
3257 stream.next_in = (void *)buf;
3258 stream.avail_in = len;
3259 do {
3260 unsigned char *in0 = stream.next_in;
3261 ret = git_deflate(&stream, Z_FINISH);
3262 git_SHA1_Update(&c, in0, stream.next_in - in0);
3263 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
3264 die("unable to write sha1 file");
3265 stream.next_out = compressed;
3266 stream.avail_out = sizeof(compressed);
3267 } while (ret == Z_OK);
3269 if (ret != Z_STREAM_END)
3270 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
3271 ret = git_deflate_end_gently(&stream);
3272 if (ret != Z_OK)
3273 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
3274 git_SHA1_Final(parano_sha1, &c);
3275 if (hashcmp(sha1, parano_sha1) != 0)
3276 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
3278 close_sha1_file(fd);
3280 if (mtime) {
3281 struct utimbuf utb;
3282 utb.actime = mtime;
3283 utb.modtime = mtime;
3284 if (utime(tmp_file.buf, &utb) < 0)
3285 warning_errno("failed utime() on %s", tmp_file.buf);
3288 return finalize_object_file(tmp_file.buf, filename);
3291 static int freshen_loose_object(const unsigned char *sha1)
3293 return check_and_freshen(sha1, 1);
3296 static int freshen_packed_object(const unsigned char *sha1)
3298 struct pack_entry e;
3299 if (!find_pack_entry(sha1, &e))
3300 return 0;
3301 if (e.p->freshened)
3302 return 1;
3303 if (!freshen_file(e.p->pack_name))
3304 return 0;
3305 e.p->freshened = 1;
3306 return 1;
3309 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1)
3311 char hdr[32];
3312 int hdrlen = sizeof(hdr);
3314 /* Normally if we have it in the pack then we do not bother writing
3315 * it out into .git/objects/??/?{38} file.
3317 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3318 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3319 return 0;
3320 return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
3323 int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type,
3324 unsigned char *sha1, unsigned flags)
3326 char *header;
3327 int hdrlen, status = 0;
3329 /* type string, SP, %lu of the length plus NUL must fit this */
3330 hdrlen = strlen(type) + 32;
3331 header = xmalloc(hdrlen);
3332 write_sha1_file_prepare(buf, len, type, sha1, header, &hdrlen);
3334 if (!(flags & HASH_WRITE_OBJECT))
3335 goto cleanup;
3336 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3337 goto cleanup;
3338 status = write_loose_object(sha1, header, hdrlen, buf, len, 0);
3340 cleanup:
3341 free(header);
3342 return status;
3345 int force_object_loose(const unsigned char *sha1, time_t mtime)
3347 void *buf;
3348 unsigned long len;
3349 enum object_type type;
3350 char hdr[32];
3351 int hdrlen;
3352 int ret;
3354 if (has_loose_object(sha1))
3355 return 0;
3356 buf = read_packed_sha1(sha1, &type, &len);
3357 if (!buf)
3358 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
3359 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(type), len) + 1;
3360 ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
3361 free(buf);
3363 return ret;
3366 int has_pack_index(const unsigned char *sha1)
3368 struct stat st;
3369 if (stat(sha1_pack_index_name(sha1), &st))
3370 return 0;
3371 return 1;
3374 int has_sha1_pack(const unsigned char *sha1)
3376 struct pack_entry e;
3377 return find_pack_entry(sha1, &e);
3380 int has_sha1_file_with_flags(const unsigned char *sha1, int flags)
3382 struct pack_entry e;
3384 if (find_pack_entry(sha1, &e))
3385 return 1;
3386 if (has_loose_object(sha1))
3387 return 1;
3388 if (flags & HAS_SHA1_QUICK)
3389 return 0;
3390 reprepare_packed_git();
3391 return find_pack_entry(sha1, &e);
3394 int has_object_file(const struct object_id *oid)
3396 return has_sha1_file(oid->hash);
3399 int has_object_file_with_flags(const struct object_id *oid, int flags)
3401 return has_sha1_file_with_flags(oid->hash, flags);
3404 static void check_tree(const void *buf, size_t size)
3406 struct tree_desc desc;
3407 struct name_entry entry;
3409 init_tree_desc(&desc, buf, size);
3410 while (tree_entry(&desc, &entry))
3411 /* do nothing
3412 * tree_entry() will die() on malformed entries */
3416 static void check_commit(const void *buf, size_t size)
3418 struct commit c;
3419 memset(&c, 0, sizeof(c));
3420 if (parse_commit_buffer(&c, buf, size))
3421 die("corrupt commit");
3424 static void check_tag(const void *buf, size_t size)
3426 struct tag t;
3427 memset(&t, 0, sizeof(t));
3428 if (parse_tag_buffer(&t, buf, size))
3429 die("corrupt tag");
3432 static int index_mem(unsigned char *sha1, void *buf, size_t size,
3433 enum object_type type,
3434 const char *path, unsigned flags)
3436 int ret, re_allocated = 0;
3437 int write_object = flags & HASH_WRITE_OBJECT;
3439 if (!type)
3440 type = OBJ_BLOB;
3443 * Convert blobs to git internal format
3445 if ((type == OBJ_BLOB) && path) {
3446 struct strbuf nbuf = STRBUF_INIT;
3447 if (convert_to_git(path, buf, size, &nbuf,
3448 write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
3449 buf = strbuf_detach(&nbuf, &size);
3450 re_allocated = 1;
3453 if (flags & HASH_FORMAT_CHECK) {
3454 if (type == OBJ_TREE)
3455 check_tree(buf, size);
3456 if (type == OBJ_COMMIT)
3457 check_commit(buf, size);
3458 if (type == OBJ_TAG)
3459 check_tag(buf, size);
3462 if (write_object)
3463 ret = write_sha1_file(buf, size, typename(type), sha1);
3464 else
3465 ret = hash_sha1_file(buf, size, typename(type), sha1);
3466 if (re_allocated)
3467 free(buf);
3468 return ret;
3471 static int index_stream_convert_blob(unsigned char *sha1, int fd,
3472 const char *path, unsigned flags)
3474 int ret;
3475 const int write_object = flags & HASH_WRITE_OBJECT;
3476 struct strbuf sbuf = STRBUF_INIT;
3478 assert(path);
3479 assert(would_convert_to_git_filter_fd(path));
3481 convert_to_git_filter_fd(path, fd, &sbuf,
3482 write_object ? safe_crlf : SAFE_CRLF_FALSE);
3484 if (write_object)
3485 ret = write_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3486 sha1);
3487 else
3488 ret = hash_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3489 sha1);
3490 strbuf_release(&sbuf);
3491 return ret;
3494 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
3495 const char *path, unsigned flags)
3497 struct strbuf sbuf = STRBUF_INIT;
3498 int ret;
3500 if (strbuf_read(&sbuf, fd, 4096) >= 0)
3501 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
3502 else
3503 ret = -1;
3504 strbuf_release(&sbuf);
3505 return ret;
3508 #define SMALL_FILE_SIZE (32*1024)
3510 static int index_core(unsigned char *sha1, int fd, size_t size,
3511 enum object_type type, const char *path,
3512 unsigned flags)
3514 int ret;
3516 if (!size) {
3517 ret = index_mem(sha1, "", size, type, path, flags);
3518 } else if (size <= SMALL_FILE_SIZE) {
3519 char *buf = xmalloc(size);
3520 if (size == read_in_full(fd, buf, size))
3521 ret = index_mem(sha1, buf, size, type, path, flags);
3522 else
3523 ret = error_errno("short read");
3524 free(buf);
3525 } else {
3526 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
3527 ret = index_mem(sha1, buf, size, type, path, flags);
3528 munmap(buf, size);
3530 return ret;
3534 * This creates one packfile per large blob unless bulk-checkin
3535 * machinery is "plugged".
3537 * This also bypasses the usual "convert-to-git" dance, and that is on
3538 * purpose. We could write a streaming version of the converting
3539 * functions and insert that before feeding the data to fast-import
3540 * (or equivalent in-core API described above). However, that is
3541 * somewhat complicated, as we do not know the size of the filter
3542 * result, which we need to know beforehand when writing a git object.
3543 * Since the primary motivation for trying to stream from the working
3544 * tree file and to avoid mmaping it in core is to deal with large
3545 * binary blobs, they generally do not want to get any conversion, and
3546 * callers should avoid this code path when filters are requested.
3548 static int index_stream(unsigned char *sha1, int fd, size_t size,
3549 enum object_type type, const char *path,
3550 unsigned flags)
3552 return index_bulk_checkin(sha1, fd, size, type, path, flags);
3555 int index_fd(unsigned char *sha1, int fd, struct stat *st,
3556 enum object_type type, const char *path, unsigned flags)
3558 int ret;
3561 * Call xsize_t() only when needed to avoid potentially unnecessary
3562 * die() for large files.
3564 if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(path))
3565 ret = index_stream_convert_blob(sha1, fd, path, flags);
3566 else if (!S_ISREG(st->st_mode))
3567 ret = index_pipe(sha1, fd, type, path, flags);
3568 else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
3569 (path && would_convert_to_git(path)))
3570 ret = index_core(sha1, fd, xsize_t(st->st_size), type, path,
3571 flags);
3572 else
3573 ret = index_stream(sha1, fd, xsize_t(st->st_size), type, path,
3574 flags);
3575 close(fd);
3576 return ret;
3579 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
3581 int fd;
3582 struct strbuf sb = STRBUF_INIT;
3584 switch (st->st_mode & S_IFMT) {
3585 case S_IFREG:
3586 fd = open(path, O_RDONLY);
3587 if (fd < 0)
3588 return error_errno("open(\"%s\")", path);
3589 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
3590 return error("%s: failed to insert into database",
3591 path);
3592 break;
3593 case S_IFLNK:
3594 if (strbuf_readlink(&sb, path, st->st_size))
3595 return error_errno("readlink(\"%s\")", path);
3596 if (!(flags & HASH_WRITE_OBJECT))
3597 hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
3598 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
3599 return error("%s: failed to insert into database",
3600 path);
3601 strbuf_release(&sb);
3602 break;
3603 case S_IFDIR:
3604 return resolve_gitlink_ref(path, "HEAD", sha1);
3605 default:
3606 return error("%s: unsupported file type", path);
3608 return 0;
3611 int read_pack_header(int fd, struct pack_header *header)
3613 if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
3614 /* "eof before pack header was fully read" */
3615 return PH_ERROR_EOF;
3617 if (header->hdr_signature != htonl(PACK_SIGNATURE))
3618 /* "protocol error (pack signature mismatch detected)" */
3619 return PH_ERROR_PACK_SIGNATURE;
3620 if (!pack_version_ok(header->hdr_version))
3621 /* "protocol error (pack version unsupported)" */
3622 return PH_ERROR_PROTOCOL;
3623 return 0;
3626 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
3628 enum object_type type = sha1_object_info(sha1, NULL);
3629 if (type < 0)
3630 die("%s is not a valid object", sha1_to_hex(sha1));
3631 if (type != expect)
3632 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
3633 typename(expect));
3636 static int for_each_file_in_obj_subdir(int subdir_nr,
3637 struct strbuf *path,
3638 each_loose_object_fn obj_cb,
3639 each_loose_cruft_fn cruft_cb,
3640 each_loose_subdir_fn subdir_cb,
3641 void *data)
3643 size_t baselen = path->len;
3644 DIR *dir = opendir(path->buf);
3645 struct dirent *de;
3646 int r = 0;
3648 if (!dir) {
3649 if (errno == ENOENT)
3650 return 0;
3651 return error_errno("unable to open %s", path->buf);
3654 while ((de = readdir(dir))) {
3655 if (is_dot_or_dotdot(de->d_name))
3656 continue;
3658 strbuf_setlen(path, baselen);
3659 strbuf_addf(path, "/%s", de->d_name);
3661 if (strlen(de->d_name) == 38) {
3662 char hex[41];
3663 unsigned char sha1[20];
3665 snprintf(hex, sizeof(hex), "%02x%s",
3666 subdir_nr, de->d_name);
3667 if (!get_sha1_hex(hex, sha1)) {
3668 if (obj_cb) {
3669 r = obj_cb(sha1, path->buf, data);
3670 if (r)
3671 break;
3673 continue;
3677 if (cruft_cb) {
3678 r = cruft_cb(de->d_name, path->buf, data);
3679 if (r)
3680 break;
3683 closedir(dir);
3685 strbuf_setlen(path, baselen);
3686 if (!r && subdir_cb)
3687 r = subdir_cb(subdir_nr, path->buf, data);
3689 return r;
3692 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
3693 each_loose_object_fn obj_cb,
3694 each_loose_cruft_fn cruft_cb,
3695 each_loose_subdir_fn subdir_cb,
3696 void *data)
3698 size_t baselen = path->len;
3699 int r = 0;
3700 int i;
3702 for (i = 0; i < 256; i++) {
3703 strbuf_addf(path, "/%02x", i);
3704 r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
3705 subdir_cb, data);
3706 strbuf_setlen(path, baselen);
3707 if (r)
3708 break;
3711 return r;
3714 int for_each_loose_file_in_objdir(const char *path,
3715 each_loose_object_fn obj_cb,
3716 each_loose_cruft_fn cruft_cb,
3717 each_loose_subdir_fn subdir_cb,
3718 void *data)
3720 struct strbuf buf = STRBUF_INIT;
3721 int r;
3723 strbuf_addstr(&buf, path);
3724 r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
3725 subdir_cb, data);
3726 strbuf_release(&buf);
3728 return r;
3731 struct loose_alt_odb_data {
3732 each_loose_object_fn *cb;
3733 void *data;
3736 static int loose_from_alt_odb(struct alternate_object_database *alt,
3737 void *vdata)
3739 struct loose_alt_odb_data *data = vdata;
3740 struct strbuf buf = STRBUF_INIT;
3741 int r;
3743 strbuf_addstr(&buf, alt->path);
3744 r = for_each_loose_file_in_objdir_buf(&buf,
3745 data->cb, NULL, NULL,
3746 data->data);
3747 strbuf_release(&buf);
3748 return r;
3751 int for_each_loose_object(each_loose_object_fn cb, void *data, unsigned flags)
3753 struct loose_alt_odb_data alt;
3754 int r;
3756 r = for_each_loose_file_in_objdir(get_object_directory(),
3757 cb, NULL, NULL, data);
3758 if (r)
3759 return r;
3761 if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
3762 return 0;
3764 alt.cb = cb;
3765 alt.data = data;
3766 return foreach_alt_odb(loose_from_alt_odb, &alt);
3769 static int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn cb, void *data)
3771 uint32_t i;
3772 int r = 0;
3774 for (i = 0; i < p->num_objects; i++) {
3775 const unsigned char *sha1 = nth_packed_object_sha1(p, i);
3777 if (!sha1)
3778 return error("unable to get sha1 of object %u in %s",
3779 i, p->pack_name);
3781 r = cb(sha1, p, i, data);
3782 if (r)
3783 break;
3785 return r;
3788 int for_each_packed_object(each_packed_object_fn cb, void *data, unsigned flags)
3790 struct packed_git *p;
3791 int r = 0;
3792 int pack_errors = 0;
3794 prepare_packed_git();
3795 for (p = packed_git; p; p = p->next) {
3796 if ((flags & FOR_EACH_OBJECT_LOCAL_ONLY) && !p->pack_local)
3797 continue;
3798 if (open_pack_index(p)) {
3799 pack_errors = 1;
3800 continue;
3802 r = for_each_object_in_pack(p, cb, data);
3803 if (r)
3804 break;
3806 return r ? r : pack_errors;
3809 static int check_stream_sha1(git_zstream *stream,
3810 const char *hdr,
3811 unsigned long size,
3812 const char *path,
3813 const unsigned char *expected_sha1)
3815 git_SHA_CTX c;
3816 unsigned char real_sha1[GIT_SHA1_RAWSZ];
3817 unsigned char buf[4096];
3818 unsigned long total_read;
3819 int status = Z_OK;
3821 git_SHA1_Init(&c);
3822 git_SHA1_Update(&c, hdr, stream->total_out);
3825 * We already read some bytes into hdr, but the ones up to the NUL
3826 * do not count against the object's content size.
3828 total_read = stream->total_out - strlen(hdr) - 1;
3831 * This size comparison must be "<=" to read the final zlib packets;
3832 * see the comment in unpack_sha1_rest for details.
3834 while (total_read <= size &&
3835 (status == Z_OK || status == Z_BUF_ERROR)) {
3836 stream->next_out = buf;
3837 stream->avail_out = sizeof(buf);
3838 if (size - total_read < stream->avail_out)
3839 stream->avail_out = size - total_read;
3840 status = git_inflate(stream, Z_FINISH);
3841 git_SHA1_Update(&c, buf, stream->next_out - buf);
3842 total_read += stream->next_out - buf;
3844 git_inflate_end(stream);
3846 if (status != Z_STREAM_END) {
3847 error("corrupt loose object '%s'", sha1_to_hex(expected_sha1));
3848 return -1;
3851 git_SHA1_Final(real_sha1, &c);
3852 if (hashcmp(expected_sha1, real_sha1)) {
3853 error("sha1 mismatch for %s (expected %s)", path,
3854 sha1_to_hex(expected_sha1));
3855 return -1;
3858 return 0;
3861 int read_loose_object(const char *path,
3862 const unsigned char *expected_sha1,
3863 enum object_type *type,
3864 unsigned long *size,
3865 void **contents)
3867 int ret = -1;
3868 int fd = -1;
3869 void *map = NULL;
3870 unsigned long mapsize;
3871 git_zstream stream;
3872 char hdr[32];
3874 *contents = NULL;
3876 map = map_sha1_file_1(path, NULL, &mapsize);
3877 if (!map) {
3878 error_errno("unable to mmap %s", path);
3879 goto out;
3882 if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0) {
3883 error("unable to unpack header of %s", path);
3884 goto out;
3887 *type = parse_sha1_header(hdr, size);
3888 if (*type < 0) {
3889 error("unable to parse header of %s", path);
3890 git_inflate_end(&stream);
3891 goto out;
3894 if (*type == OBJ_BLOB) {
3895 if (check_stream_sha1(&stream, hdr, *size, path, expected_sha1) < 0)
3896 goto out;
3897 } else {
3898 *contents = unpack_sha1_rest(&stream, hdr, *size, expected_sha1);
3899 if (!*contents) {
3900 error("unable to unpack contents of %s", path);
3901 git_inflate_end(&stream);
3902 goto out;
3904 if (check_sha1_signature(expected_sha1, *contents,
3905 *size, typename(*type))) {
3906 error("sha1 mismatch for %s (expected %s)", path,
3907 sha1_to_hex(expected_sha1));
3908 free(*contents);
3909 goto out;
3913 ret = 0; /* everything checks out */
3915 out:
3916 if (map)
3917 munmap(map, mapsize);
3918 if (fd >= 0)
3919 close(fd);
3920 return ret;