2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
6 * This handles basic git sha1 object files - packing, unpacking,
10 #include "string-list.h"
16 #include "run-command.h"
19 #include "tree-walk.h"
21 #include "pack-revindex.h"
22 #include "sha1-lookup.h"
23 #include "bulk-checkin.h"
24 #include "streaming.h"
28 #include "mergesort.h"
31 #if defined(__linux__) && (defined(__i386__) || defined(__PPC__))
32 #define O_NOATIME 01000000
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
56 static struct cached_object {
57 unsigned char sha1[20];
58 enum object_type type;
62 static int cached_object_nr, cached_object_alloc;
64 static struct cached_object empty_tree = {
65 EMPTY_TREE_SHA1_BIN_LITERAL,
71 static struct cached_object *find_cached_object(const unsigned char *sha1)
74 struct cached_object *co = cached_objects;
76 for (i = 0; i < cached_object_nr; i++, co++) {
77 if (!hashcmp(co->sha1, sha1))
80 if (!hashcmp(sha1, empty_tree.sha1))
85 int mkdir_in_gitdir(const char *path)
87 if (mkdir(path, 0777)) {
88 int saved_errno = errno;
90 struct strbuf sb = STRBUF_INIT;
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)) {
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) {
121 char *slash = next_component, slash_character;
123 while (*slash && !is_dir_sep(*slash))
129 next_component = slash + 1;
130 while (is_dir_sep(*next_component))
132 if (!*next_component)
135 slash_character = *slash;
137 if (!stat(path, &st)) {
139 if (!S_ISDIR(st.st_mode))
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
158 } else if (adjust_shared_perm(path)) {
161 *slash = slash_character;
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);
175 static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
178 for (i = 0; i < 20; i++) {
179 static char hex[] = "0123456789abcdef";
180 unsigned int val = sha1[i];
181 char *pos = pathbuf + i*2 + (i > 0);
182 *pos++ = hex[val >> 4];
183 *pos = hex[val & 0xf];
187 const char *sha1_file_name(const unsigned char *sha1)
189 static char buf[PATH_MAX];
193 objdir = get_object_directory();
194 len = strlen(objdir);
196 /* '/' + sha1(2) + '/' + sha1(38) + '\0' */
197 if (len + 43 > PATH_MAX)
198 die("insanely long object directory %s", objdir);
199 memcpy(buf, objdir, len);
203 fill_sha1_path(buf + len + 1, sha1);
208 * Return the name of the pack or index file with the specified sha1
209 * in its filename. *base and *name are scratch space that must be
210 * provided by the caller. which should be "pack" or "idx".
212 static char *sha1_get_pack_name(const unsigned char *sha1,
217 strbuf_addf(buf, "%s/pack/pack-%s.%s", get_object_directory(),
218 sha1_to_hex(sha1), which);
222 char *sha1_pack_name(const unsigned char *sha1)
224 static struct strbuf buf = STRBUF_INIT;
225 return sha1_get_pack_name(sha1, &buf, "pack");
228 char *sha1_pack_index_name(const unsigned char *sha1)
230 static struct strbuf buf = STRBUF_INIT;
231 return sha1_get_pack_name(sha1, &buf, "idx");
234 struct alternate_object_database *alt_odb_list;
235 static struct alternate_object_database **alt_odb_tail;
238 * Return non-zero iff the path is usable as an alternate object database.
240 static int alt_odb_usable(struct strbuf *path, const char *normalized_objdir)
242 struct alternate_object_database *alt;
244 /* Detect cases where alternate disappeared */
245 if (!is_directory(path->buf)) {
246 error("object directory %s does not exist; "
247 "check .git/objects/info/alternates.",
253 * Prevent the common mistake of listing the same
254 * thing twice, or object directory itself.
256 for (alt = alt_odb_list; alt; alt = alt->next) {
257 if (path->len == alt->name - alt->base - 1 &&
258 !memcmp(path->buf, alt->base, path->len))
261 if (!fspathcmp(path->buf, normalized_objdir))
268 * Prepare alternate object database registry.
270 * The variable alt_odb_list points at the list of struct
271 * alternate_object_database. The elements on this list come from
272 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
273 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
274 * whose contents is similar to that environment variable but can be
275 * LF separated. Its base points at a statically allocated buffer that
276 * contains "/the/directory/corresponding/to/.git/objects/...", while
277 * its name points just after the slash at the end of ".git/objects/"
278 * in the example above, and has enough space to hold 40-byte hex
279 * SHA1, an extra slash for the first level indirection, and the
282 static int link_alt_odb_entry(const char *entry, const char *relative_base,
283 int depth, const char *normalized_objdir)
285 struct alternate_object_database *ent;
287 struct strbuf pathbuf = STRBUF_INIT;
289 if (!is_absolute_path(entry) && relative_base) {
290 strbuf_addstr(&pathbuf, real_path(relative_base));
291 strbuf_addch(&pathbuf, '/');
293 strbuf_addstr(&pathbuf, entry);
295 if (strbuf_normalize_path(&pathbuf) < 0) {
296 error("unable to normalize alternate object path: %s",
298 strbuf_release(&pathbuf);
303 * The trailing slash after the directory name is given by
304 * this function at the end. Remove duplicates.
306 while (pathbuf.len && pathbuf.buf[pathbuf.len - 1] == '/')
307 strbuf_setlen(&pathbuf, pathbuf.len - 1);
309 if (!alt_odb_usable(&pathbuf, normalized_objdir)) {
310 strbuf_release(&pathbuf);
314 entlen = st_add(pathbuf.len, 43); /* '/' + 2 hex + '/' + 38 hex + NUL */
315 ent = xmalloc(st_add(sizeof(*ent), entlen));
316 memcpy(ent->base, pathbuf.buf, pathbuf.len);
318 ent->name = ent->base + pathbuf.len + 1;
319 ent->base[pathbuf.len] = '/';
320 ent->base[pathbuf.len + 3] = '/';
321 ent->base[entlen-1] = 0;
323 /* add the alternate entry */
325 alt_odb_tail = &(ent->next);
328 /* recursively add alternates */
329 read_info_alternates(pathbuf.buf, depth + 1);
331 strbuf_release(&pathbuf);
335 static void link_alt_odb_entries(const char *alt, int len, int sep,
336 const char *relative_base, int depth)
338 struct string_list entries = STRING_LIST_INIT_NODUP;
341 struct strbuf objdirbuf = STRBUF_INIT;
344 error("%s: ignoring alternate object stores, nesting too deep.",
349 strbuf_add_absolute_path(&objdirbuf, get_object_directory());
350 if (strbuf_normalize_path(&objdirbuf) < 0)
351 die("unable to normalize object directory: %s",
354 alt_copy = xmemdupz(alt, len);
355 string_list_split_in_place(&entries, alt_copy, sep, -1);
356 for (i = 0; i < entries.nr; i++) {
357 const char *entry = entries.items[i].string;
358 if (entry[0] == '\0' || entry[0] == '#')
360 if (!is_absolute_path(entry) && depth) {
361 error("%s: ignoring relative alternate object store %s",
362 relative_base, entry);
364 link_alt_odb_entry(entry, relative_base, depth, objdirbuf.buf);
367 string_list_clear(&entries, 0);
369 strbuf_release(&objdirbuf);
372 void read_info_alternates(const char * relative_base, int depth)
380 path = xstrfmt("%s/info/alternates", relative_base);
381 fd = git_open_noatime(path);
385 if (fstat(fd, &st) || (st.st_size == 0)) {
389 mapsz = xsize_t(st.st_size);
390 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
393 link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
398 void add_to_alternates_file(const char *reference)
400 struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
401 char *alts = git_pathdup("objects/info/alternates");
404 hold_lock_file_for_update(lock, alts, LOCK_DIE_ON_ERROR);
405 out = fdopen_lock_file(lock, "w");
407 die_errno("unable to fdopen alternates lockfile");
409 in = fopen(alts, "r");
411 struct strbuf line = STRBUF_INIT;
414 while (strbuf_getline(&line, in) != EOF) {
415 if (!strcmp(reference, line.buf)) {
419 fprintf_or_die(out, "%s\n", line.buf);
422 strbuf_release(&line);
426 rollback_lock_file(lock);
430 else if (errno != ENOENT)
431 die_errno("unable to read alternates file");
434 fprintf_or_die(out, "%s\n", reference);
435 if (commit_lock_file(lock))
436 die_errno("unable to move new alternates file into place");
438 link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
443 void add_to_alternates_memory(const char *reference)
446 * Make sure alternates are initialized, or else our entry may be
447 * overwritten when they are.
451 link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
455 * Compute the exact path an alternate is at and returns it. In case of
456 * error NULL is returned and the human readable error is added to `err`
457 * `path` may be relative and should point to $GITDIR.
458 * `err` must not be null.
460 char *compute_alternate_path(const char *path, struct strbuf *err)
462 char *ref_git = NULL;
463 const char *repo, *ref_git_s;
466 ref_git_s = real_path_if_valid(path);
469 strbuf_addf(err, _("path '%s' does not exist"), path);
473 * Beware: read_gitfile(), real_path() and mkpath()
474 * return static buffer
476 ref_git = xstrdup(ref_git_s);
478 repo = read_gitfile(ref_git);
480 repo = read_gitfile(mkpath("%s/.git", ref_git));
483 ref_git = xstrdup(repo);
486 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
487 char *ref_git_git = mkpathdup("%s/.git", ref_git);
489 ref_git = ref_git_git;
490 } else if (!is_directory(mkpath("%s/objects", ref_git))) {
491 struct strbuf sb = STRBUF_INIT;
493 if (get_common_dir(&sb, ref_git)) {
495 _("reference repository '%s' as a linked "
496 "checkout is not supported yet."),
501 strbuf_addf(err, _("reference repository '%s' is not a "
502 "local repository."), path);
506 if (!access(mkpath("%s/shallow", ref_git), F_OK)) {
507 strbuf_addf(err, _("reference repository '%s' is shallow"),
513 if (!access(mkpath("%s/info/grafts", ref_git), F_OK)) {
515 _("reference repository '%s' is grafted"),
530 int foreach_alt_odb(alt_odb_fn fn, void *cb)
532 struct alternate_object_database *ent;
536 for (ent = alt_odb_list; ent; ent = ent->next) {
544 void prepare_alt_odb(void)
551 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
554 alt_odb_tail = &alt_odb_list;
555 link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
557 read_info_alternates(get_object_directory(), 0);
560 /* Returns 1 if we have successfully freshened the file, 0 otherwise. */
561 static int freshen_file(const char *fn)
564 t.actime = t.modtime = time(NULL);
565 return !utime(fn, &t);
569 * All of the check_and_freshen functions return 1 if the file exists and was
570 * freshened (if freshening was requested), 0 otherwise. If they return
571 * 0, you should not assume that it is safe to skip a write of the object (it
572 * either does not exist on disk, or has a stale mtime and may be subject to
575 static int check_and_freshen_file(const char *fn, int freshen)
577 if (access(fn, F_OK))
579 if (freshen && !freshen_file(fn))
584 static int check_and_freshen_local(const unsigned char *sha1, int freshen)
586 return check_and_freshen_file(sha1_file_name(sha1), freshen);
589 static int check_and_freshen_nonlocal(const unsigned char *sha1, int freshen)
591 struct alternate_object_database *alt;
593 for (alt = alt_odb_list; alt; alt = alt->next) {
594 fill_sha1_path(alt->name, sha1);
595 if (check_and_freshen_file(alt->base, freshen))
601 static int check_and_freshen(const unsigned char *sha1, int freshen)
603 return check_and_freshen_local(sha1, freshen) ||
604 check_and_freshen_nonlocal(sha1, freshen);
607 int has_loose_object_nonlocal(const unsigned char *sha1)
609 return check_and_freshen_nonlocal(sha1, 0);
612 static int has_loose_object(const unsigned char *sha1)
614 return check_and_freshen(sha1, 0);
617 static unsigned int pack_used_ctr;
618 static unsigned int pack_mmap_calls;
619 static unsigned int peak_pack_open_windows;
620 static unsigned int pack_open_windows;
621 static unsigned int pack_open_fds;
622 static unsigned int pack_max_fds;
623 static size_t peak_pack_mapped;
624 static size_t pack_mapped;
625 struct packed_git *packed_git;
627 static struct mru packed_git_mru_storage;
628 struct mru *packed_git_mru = &packed_git_mru_storage;
630 void pack_report(void)
633 "pack_report: getpagesize() = %10" SZ_FMT "\n"
634 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
635 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
636 sz_fmt(getpagesize()),
637 sz_fmt(packed_git_window_size),
638 sz_fmt(packed_git_limit));
640 "pack_report: pack_used_ctr = %10u\n"
641 "pack_report: pack_mmap_calls = %10u\n"
642 "pack_report: pack_open_windows = %10u / %10u\n"
643 "pack_report: pack_mapped = "
644 "%10" SZ_FMT " / %10" SZ_FMT "\n",
647 pack_open_windows, peak_pack_open_windows,
648 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
652 * Open and mmap the index file at path, perform a couple of
653 * consistency checks, then record its information to p. Return 0 on
656 static int check_packed_git_idx(const char *path, struct packed_git *p)
659 struct pack_idx_header *hdr;
661 uint32_t version, nr, i, *index;
662 int fd = git_open_noatime(path);
667 if (fstat(fd, &st)) {
671 idx_size = xsize_t(st.st_size);
672 if (idx_size < 4 * 256 + 20 + 20) {
674 return error("index file %s is too small", path);
676 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
680 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
681 version = ntohl(hdr->idx_version);
682 if (version < 2 || version > 2) {
683 munmap(idx_map, idx_size);
684 return error("index file %s is version %"PRIu32
685 " and is not supported by this binary"
686 " (try upgrading GIT to a newer version)",
695 index += 2; /* skip index header */
696 for (i = 0; i < 256; i++) {
697 uint32_t n = ntohl(index[i]);
699 munmap(idx_map, idx_size);
700 return error("non-monotonic index %s", path);
708 * - 256 index entries 4 bytes each
709 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
710 * - 20-byte SHA1 of the packfile
711 * - 20-byte SHA1 file checksum
713 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
714 munmap(idx_map, idx_size);
715 return error("wrong index v1 file size in %s", path);
717 } else if (version == 2) {
720 * - 8 bytes of header
721 * - 256 index entries 4 bytes each
722 * - 20-byte sha1 entry * nr
723 * - 4-byte crc entry * nr
724 * - 4-byte offset entry * nr
725 * - 20-byte SHA1 of the packfile
726 * - 20-byte SHA1 file checksum
727 * And after the 4-byte offset table might be a
728 * variable sized table containing 8-byte entries
729 * for offsets larger than 2^31.
731 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
732 unsigned long max_size = min_size;
734 max_size += (nr - 1)*8;
735 if (idx_size < min_size || idx_size > max_size) {
736 munmap(idx_map, idx_size);
737 return error("wrong index v2 file size in %s", path);
739 if (idx_size != min_size &&
741 * make sure we can deal with large pack offsets.
742 * 31-bit signed offset won't be enough, neither
743 * 32-bit unsigned one will be.
745 (sizeof(off_t) <= 4)) {
746 munmap(idx_map, idx_size);
747 return error("pack too large for current definition of off_t in %s", path);
751 p->index_version = version;
752 p->index_data = idx_map;
753 p->index_size = idx_size;
758 int open_pack_index(struct packed_git *p)
767 if (!strip_suffix(p->pack_name, ".pack", &len))
768 die("BUG: pack_name does not end in .pack");
769 idx_name = xstrfmt("%.*s.idx", (int)len, p->pack_name);
770 ret = check_packed_git_idx(idx_name, p);
775 static void scan_windows(struct packed_git *p,
776 struct packed_git **lru_p,
777 struct pack_window **lru_w,
778 struct pack_window **lru_l)
780 struct pack_window *w, *w_l;
782 for (w_l = NULL, w = p->windows; w; w = w->next) {
784 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
794 static int unuse_one_window(struct packed_git *current)
796 struct packed_git *p, *lru_p = NULL;
797 struct pack_window *lru_w = NULL, *lru_l = NULL;
800 scan_windows(current, &lru_p, &lru_w, &lru_l);
801 for (p = packed_git; p; p = p->next)
802 scan_windows(p, &lru_p, &lru_w, &lru_l);
804 munmap(lru_w->base, lru_w->len);
805 pack_mapped -= lru_w->len;
807 lru_l->next = lru_w->next;
809 lru_p->windows = lru_w->next;
817 void release_pack_memory(size_t need)
819 size_t cur = pack_mapped;
820 while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
824 static void mmap_limit_check(size_t length)
826 static size_t limit = 0;
828 limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
833 die("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX,
834 (uintmax_t)length, (uintmax_t)limit);
837 void *xmmap_gently(void *start, size_t length,
838 int prot, int flags, int fd, off_t offset)
842 mmap_limit_check(length);
843 ret = mmap(start, length, prot, flags, fd, offset);
844 if (ret == MAP_FAILED) {
847 release_pack_memory(length);
848 ret = mmap(start, length, prot, flags, fd, offset);
853 void *xmmap(void *start, size_t length,
854 int prot, int flags, int fd, off_t offset)
856 void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
857 if (ret == MAP_FAILED)
858 die_errno("mmap failed");
862 void close_pack_windows(struct packed_git *p)
865 struct pack_window *w = p->windows;
868 die("pack '%s' still has open windows to it",
870 munmap(w->base, w->len);
871 pack_mapped -= w->len;
873 p->windows = w->next;
878 static int close_pack_fd(struct packed_git *p)
890 static void close_pack(struct packed_git *p)
892 close_pack_windows(p);
897 void close_all_packs(void)
899 struct packed_git *p;
901 for (p = packed_git; p; p = p->next)
903 die("BUG: want to close pack marked 'do-not-close'");
910 * The LRU pack is the one with the oldest MRU window, preferring packs
911 * with no used windows, or the oldest mtime if it has no windows allocated.
913 static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
915 struct pack_window *w, *this_mru_w;
916 int has_windows_inuse = 0;
919 * Reject this pack if it has windows and the previously selected
920 * one does not. If this pack does not have windows, reject
921 * it if the pack file is newer than the previously selected one.
923 if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
926 for (w = this_mru_w = p->windows; w; w = w->next) {
928 * Reject this pack if any of its windows are in use,
929 * but the previously selected pack did not have any
930 * inuse windows. Otherwise, record that this pack
931 * has windows in use.
934 if (*accept_windows_inuse)
935 has_windows_inuse = 1;
940 if (w->last_used > this_mru_w->last_used)
944 * Reject this pack if it has windows that have been
945 * used more recently than the previously selected pack.
946 * If the previously selected pack had windows inuse and
947 * we have not encountered a window in this pack that is
948 * inuse, skip this check since we prefer a pack with no
949 * inuse windows to one that has inuse windows.
951 if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
952 this_mru_w->last_used > (*mru_w)->last_used)
961 *accept_windows_inuse = has_windows_inuse;
964 static int close_one_pack(void)
966 struct packed_git *p, *lru_p = NULL;
967 struct pack_window *mru_w = NULL;
968 int accept_windows_inuse = 1;
970 for (p = packed_git; p; p = p->next) {
971 if (p->pack_fd == -1)
973 find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
977 return close_pack_fd(lru_p);
982 void unuse_pack(struct pack_window **w_cursor)
984 struct pack_window *w = *w_cursor;
991 void close_pack_index(struct packed_git *p)
994 munmap((void *)p->index_data, p->index_size);
995 p->index_data = NULL;
999 static unsigned int get_max_fd_limit(void)
1001 #ifdef RLIMIT_NOFILE
1005 if (!getrlimit(RLIMIT_NOFILE, &lim))
1006 return lim.rlim_cur;
1012 long open_max = sysconf(_SC_OPEN_MAX);
1016 * Otherwise, we got -1 for one of the two
1019 * (1) sysconf() did not understand _SC_OPEN_MAX
1020 * and signaled an error with -1; or
1021 * (2) sysconf() said there is no limit.
1023 * We _could_ clear errno before calling sysconf() to
1024 * tell these two cases apart and return a huge number
1025 * in the latter case to let the caller cap it to a
1026 * value that is not so selfish, but letting the
1027 * fallback OPEN_MAX codepath take care of these cases
1036 return 1; /* see the caller ;-) */
1041 * Do not call this directly as this leaks p->pack_fd on error return;
1042 * call open_packed_git() instead.
1044 static int open_packed_git_1(struct packed_git *p)
1047 struct pack_header hdr;
1048 unsigned char sha1[20];
1049 unsigned char *idx_sha1;
1052 if (!p->index_data && open_pack_index(p))
1053 return error("packfile %s index unavailable", p->pack_name);
1055 if (!pack_max_fds) {
1056 unsigned int max_fds = get_max_fd_limit();
1058 /* Save 3 for stdin/stdout/stderr, 22 for work */
1060 pack_max_fds = max_fds - 25;
1065 while (pack_max_fds <= pack_open_fds && close_one_pack())
1068 p->pack_fd = git_open_noatime(p->pack_name);
1069 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
1073 /* If we created the struct before we had the pack we lack size. */
1074 if (!p->pack_size) {
1075 if (!S_ISREG(st.st_mode))
1076 return error("packfile %s not a regular file", p->pack_name);
1077 p->pack_size = st.st_size;
1078 } else if (p->pack_size != st.st_size)
1079 return error("packfile %s size changed", p->pack_name);
1081 /* We leave these file descriptors open with sliding mmap;
1082 * there is no point keeping them open across exec(), though.
1084 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
1086 return error("cannot determine file descriptor flags");
1087 fd_flag |= FD_CLOEXEC;
1088 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
1089 return error("cannot set FD_CLOEXEC");
1091 /* Verify we recognize this pack file format. */
1092 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
1093 return error("file %s is far too short to be a packfile", p->pack_name);
1094 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
1095 return error("file %s is not a GIT packfile", p->pack_name);
1096 if (!pack_version_ok(hdr.hdr_version))
1097 return error("packfile %s is version %"PRIu32" and not"
1098 " supported (try upgrading GIT to a newer version)",
1099 p->pack_name, ntohl(hdr.hdr_version));
1101 /* Verify the pack matches its index. */
1102 if (p->num_objects != ntohl(hdr.hdr_entries))
1103 return error("packfile %s claims to have %"PRIu32" objects"
1104 " while index indicates %"PRIu32" objects",
1105 p->pack_name, ntohl(hdr.hdr_entries),
1107 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
1108 return error("end of packfile %s is unavailable", p->pack_name);
1109 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
1110 return error("packfile %s signature is unavailable", p->pack_name);
1111 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
1112 if (hashcmp(sha1, idx_sha1))
1113 return error("packfile %s does not match index", p->pack_name);
1117 static int open_packed_git(struct packed_git *p)
1119 if (!open_packed_git_1(p))
1125 static int in_window(struct pack_window *win, off_t offset)
1127 /* We must promise at least 20 bytes (one hash) after the
1128 * offset is available from this window, otherwise the offset
1129 * is not actually in this window and a different window (which
1130 * has that one hash excess) must be used. This is to support
1131 * the object header and delta base parsing routines below.
1133 off_t win_off = win->offset;
1134 return win_off <= offset
1135 && (offset + 20) <= (win_off + win->len);
1138 unsigned char *use_pack(struct packed_git *p,
1139 struct pack_window **w_cursor,
1141 unsigned long *left)
1143 struct pack_window *win = *w_cursor;
1145 /* Since packfiles end in a hash of their content and it's
1146 * pointless to ask for an offset into the middle of that
1147 * hash, and the in_window function above wouldn't match
1148 * don't allow an offset too close to the end of the file.
1150 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
1151 die("packfile %s cannot be accessed", p->pack_name);
1152 if (offset > (p->pack_size - 20))
1153 die("offset beyond end of packfile (truncated pack?)");
1155 die(_("offset before end of packfile (broken .idx?)"));
1157 if (!win || !in_window(win, offset)) {
1160 for (win = p->windows; win; win = win->next) {
1161 if (in_window(win, offset))
1165 size_t window_align = packed_git_window_size / 2;
1168 if (p->pack_fd == -1 && open_packed_git(p))
1169 die("packfile %s cannot be accessed", p->pack_name);
1171 win = xcalloc(1, sizeof(*win));
1172 win->offset = (offset / window_align) * window_align;
1173 len = p->pack_size - win->offset;
1174 if (len > packed_git_window_size)
1175 len = packed_git_window_size;
1176 win->len = (size_t)len;
1177 pack_mapped += win->len;
1178 while (packed_git_limit < pack_mapped
1179 && unuse_one_window(p))
1181 win->base = xmmap(NULL, win->len,
1182 PROT_READ, MAP_PRIVATE,
1183 p->pack_fd, win->offset);
1184 if (win->base == MAP_FAILED)
1185 die_errno("packfile %s cannot be mapped",
1187 if (!win->offset && win->len == p->pack_size
1188 && !p->do_not_close)
1191 pack_open_windows++;
1192 if (pack_mapped > peak_pack_mapped)
1193 peak_pack_mapped = pack_mapped;
1194 if (pack_open_windows > peak_pack_open_windows)
1195 peak_pack_open_windows = pack_open_windows;
1196 win->next = p->windows;
1200 if (win != *w_cursor) {
1201 win->last_used = pack_used_ctr++;
1205 offset -= win->offset;
1207 *left = win->len - xsize_t(offset);
1208 return win->base + offset;
1211 static struct packed_git *alloc_packed_git(int extra)
1213 struct packed_git *p = xmalloc(st_add(sizeof(*p), extra));
1214 memset(p, 0, sizeof(*p));
1219 static void try_to_free_pack_memory(size_t size)
1221 release_pack_memory(size);
1224 struct packed_git *add_packed_git(const char *path, size_t path_len, int local)
1226 static int have_set_try_to_free_routine;
1229 struct packed_git *p;
1231 if (!have_set_try_to_free_routine) {
1232 have_set_try_to_free_routine = 1;
1233 set_try_to_free_routine(try_to_free_pack_memory);
1237 * Make sure a corresponding .pack file exists and that
1238 * the index looks sane.
1240 if (!strip_suffix_mem(path, &path_len, ".idx"))
1244 * ".pack" is long enough to hold any suffix we're adding (and
1245 * the use xsnprintf double-checks that)
1247 alloc = st_add3(path_len, strlen(".pack"), 1);
1248 p = alloc_packed_git(alloc);
1249 memcpy(p->pack_name, path, path_len);
1251 xsnprintf(p->pack_name + path_len, alloc - path_len, ".keep");
1252 if (!access(p->pack_name, F_OK))
1255 xsnprintf(p->pack_name + path_len, alloc - path_len, ".pack");
1256 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
1261 /* ok, it looks sane as far as we can check without
1262 * actually mapping the pack file.
1264 p->pack_size = st.st_size;
1265 p->pack_local = local;
1266 p->mtime = st.st_mtime;
1267 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
1272 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
1274 const char *path = sha1_pack_name(sha1);
1275 size_t alloc = st_add(strlen(path), 1);
1276 struct packed_git *p = alloc_packed_git(alloc);
1278 memcpy(p->pack_name, path, alloc); /* includes NUL */
1279 hashcpy(p->sha1, sha1);
1280 if (check_packed_git_idx(idx_path, p)) {
1288 void install_packed_git(struct packed_git *pack)
1290 if (pack->pack_fd != -1)
1293 pack->next = packed_git;
1297 void (*report_garbage)(unsigned seen_bits, const char *path);
1299 static void report_helper(const struct string_list *list,
1300 int seen_bits, int first, int last)
1302 if (seen_bits == (PACKDIR_FILE_PACK|PACKDIR_FILE_IDX))
1305 for (; first < last; first++)
1306 report_garbage(seen_bits, list->items[first].string);
1309 static void report_pack_garbage(struct string_list *list)
1311 int i, baselen = -1, first = 0, seen_bits = 0;
1313 if (!report_garbage)
1316 string_list_sort(list);
1318 for (i = 0; i < list->nr; i++) {
1319 const char *path = list->items[i].string;
1320 if (baselen != -1 &&
1321 strncmp(path, list->items[first].string, baselen)) {
1322 report_helper(list, seen_bits, first, i);
1326 if (baselen == -1) {
1327 const char *dot = strrchr(path, '.');
1329 report_garbage(PACKDIR_FILE_GARBAGE, path);
1332 baselen = dot - path + 1;
1335 if (!strcmp(path + baselen, "pack"))
1337 else if (!strcmp(path + baselen, "idx"))
1340 report_helper(list, seen_bits, first, list->nr);
1343 static void prepare_packed_git_one(char *objdir, int local)
1345 struct strbuf path = STRBUF_INIT;
1349 struct string_list garbage = STRING_LIST_INIT_DUP;
1351 strbuf_addstr(&path, objdir);
1352 strbuf_addstr(&path, "/pack");
1353 dir = opendir(path.buf);
1355 if (errno != ENOENT)
1356 error_errno("unable to open object pack directory: %s",
1358 strbuf_release(&path);
1361 strbuf_addch(&path, '/');
1362 dirnamelen = path.len;
1363 while ((de = readdir(dir)) != NULL) {
1364 struct packed_git *p;
1367 if (is_dot_or_dotdot(de->d_name))
1370 strbuf_setlen(&path, dirnamelen);
1371 strbuf_addstr(&path, de->d_name);
1373 base_len = path.len;
1374 if (strip_suffix_mem(path.buf, &base_len, ".idx")) {
1375 /* Don't reopen a pack we already have. */
1376 for (p = packed_git; p; p = p->next) {
1378 if (strip_suffix(p->pack_name, ".pack", &len) &&
1380 !memcmp(p->pack_name, path.buf, len))
1385 * See if it really is a valid .idx file with
1386 * corresponding .pack file that we can map.
1388 (p = add_packed_git(path.buf, path.len, local)) != NULL)
1389 install_packed_git(p);
1392 if (!report_garbage)
1395 if (ends_with(de->d_name, ".idx") ||
1396 ends_with(de->d_name, ".pack") ||
1397 ends_with(de->d_name, ".bitmap") ||
1398 ends_with(de->d_name, ".keep"))
1399 string_list_append(&garbage, path.buf);
1401 report_garbage(PACKDIR_FILE_GARBAGE, path.buf);
1404 report_pack_garbage(&garbage);
1405 string_list_clear(&garbage, 0);
1406 strbuf_release(&path);
1409 static void *get_next_packed_git(const void *p)
1411 return ((const struct packed_git *)p)->next;
1414 static void set_next_packed_git(void *p, void *next)
1416 ((struct packed_git *)p)->next = next;
1419 static int sort_pack(const void *a_, const void *b_)
1421 const struct packed_git *a = a_;
1422 const struct packed_git *b = b_;
1426 * Local packs tend to contain objects specific to our
1427 * variant of the project than remote ones. In addition,
1428 * remote ones could be on a network mounted filesystem.
1429 * Favor local ones for these reasons.
1431 st = a->pack_local - b->pack_local;
1436 * Younger packs tend to contain more recent objects,
1437 * and more recent objects tend to get accessed more
1440 if (a->mtime < b->mtime)
1442 else if (a->mtime == b->mtime)
1447 static void rearrange_packed_git(void)
1449 packed_git = llist_mergesort(packed_git, get_next_packed_git,
1450 set_next_packed_git, sort_pack);
1453 static void prepare_packed_git_mru(void)
1455 struct packed_git *p;
1457 mru_clear(packed_git_mru);
1458 for (p = packed_git; p; p = p->next)
1459 mru_append(packed_git_mru, p);
1462 static int prepare_packed_git_run_once = 0;
1463 void prepare_packed_git(void)
1465 struct alternate_object_database *alt;
1467 if (prepare_packed_git_run_once)
1469 prepare_packed_git_one(get_object_directory(), 1);
1471 for (alt = alt_odb_list; alt; alt = alt->next) {
1473 prepare_packed_git_one(alt->base, 0);
1474 alt->name[-1] = '/';
1476 rearrange_packed_git();
1477 prepare_packed_git_mru();
1478 prepare_packed_git_run_once = 1;
1481 void reprepare_packed_git(void)
1483 prepare_packed_git_run_once = 0;
1484 prepare_packed_git();
1487 static void mark_bad_packed_object(struct packed_git *p,
1488 const unsigned char *sha1)
1491 for (i = 0; i < p->num_bad_objects; i++)
1492 if (!hashcmp(sha1, p->bad_object_sha1 + GIT_SHA1_RAWSZ * i))
1494 p->bad_object_sha1 = xrealloc(p->bad_object_sha1,
1495 st_mult(GIT_SHA1_RAWSZ,
1496 st_add(p->num_bad_objects, 1)));
1497 hashcpy(p->bad_object_sha1 + GIT_SHA1_RAWSZ * p->num_bad_objects, sha1);
1498 p->num_bad_objects++;
1501 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1503 struct packed_git *p;
1506 for (p = packed_git; p; p = p->next)
1507 for (i = 0; i < p->num_bad_objects; i++)
1508 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1514 * With an in-core object data in "map", rehash it to make sure the
1515 * object name actually matches "sha1" to detect object corruption.
1516 * With "map" == NULL, try reading the object named with "sha1" using
1517 * the streaming interface and rehash it to do the same.
1519 int check_sha1_signature(const unsigned char *sha1, void *map,
1520 unsigned long size, const char *type)
1522 unsigned char real_sha1[20];
1523 enum object_type obj_type;
1524 struct git_istream *st;
1530 hash_sha1_file(map, size, type, real_sha1);
1531 return hashcmp(sha1, real_sha1) ? -1 : 0;
1534 st = open_istream(sha1, &obj_type, &size, NULL);
1538 /* Generate the header */
1539 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(obj_type), size) + 1;
1543 git_SHA1_Update(&c, hdr, hdrlen);
1545 char buf[1024 * 16];
1546 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1554 git_SHA1_Update(&c, buf, readlen);
1556 git_SHA1_Final(real_sha1, &c);
1558 return hashcmp(sha1, real_sha1) ? -1 : 0;
1561 int git_open_noatime(const char *name)
1563 static int sha1_file_open_flag = O_NOATIME;
1569 fd = open(name, O_RDONLY | sha1_file_open_flag);
1573 /* Might the failure be due to O_NOATIME? */
1574 if (errno != ENOENT && sha1_file_open_flag) {
1575 sha1_file_open_flag = 0;
1583 static int stat_sha1_file(const unsigned char *sha1, struct stat *st)
1585 struct alternate_object_database *alt;
1587 if (!lstat(sha1_file_name(sha1), st))
1592 for (alt = alt_odb_list; alt; alt = alt->next) {
1593 fill_sha1_path(alt->name, sha1);
1594 if (!lstat(alt->base, st))
1601 static int open_sha1_file(const unsigned char *sha1)
1604 struct alternate_object_database *alt;
1605 int most_interesting_errno;
1607 fd = git_open_noatime(sha1_file_name(sha1));
1610 most_interesting_errno = errno;
1613 for (alt = alt_odb_list; alt; alt = alt->next) {
1614 fill_sha1_path(alt->name, sha1);
1615 fd = git_open_noatime(alt->base);
1618 if (most_interesting_errno == ENOENT)
1619 most_interesting_errno = errno;
1621 errno = most_interesting_errno;
1625 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1630 fd = open_sha1_file(sha1);
1635 if (!fstat(fd, &st)) {
1636 *size = xsize_t(st.st_size);
1638 /* mmap() is forbidden on empty files */
1639 error("object file %s is empty", sha1_file_name(sha1));
1642 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1649 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1650 unsigned long len, enum object_type *type, unsigned long *sizep)
1653 unsigned long size, c;
1654 unsigned long used = 0;
1657 *type = (c >> 4) & 7;
1661 if (len <= used || bitsizeof(long) <= shift) {
1662 error("bad object header");
1667 size += (c & 0x7f) << shift;
1674 static int unpack_sha1_short_header(git_zstream *stream,
1675 unsigned char *map, unsigned long mapsize,
1676 void *buffer, unsigned long bufsiz)
1678 /* Get the data stream */
1679 memset(stream, 0, sizeof(*stream));
1680 stream->next_in = map;
1681 stream->avail_in = mapsize;
1682 stream->next_out = buffer;
1683 stream->avail_out = bufsiz;
1685 git_inflate_init(stream);
1686 return git_inflate(stream, 0);
1689 int unpack_sha1_header(git_zstream *stream,
1690 unsigned char *map, unsigned long mapsize,
1691 void *buffer, unsigned long bufsiz)
1693 int status = unpack_sha1_short_header(stream, map, mapsize,
1699 /* Make sure we have the terminating NUL */
1700 if (!memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1705 static int unpack_sha1_header_to_strbuf(git_zstream *stream, unsigned char *map,
1706 unsigned long mapsize, void *buffer,
1707 unsigned long bufsiz, struct strbuf *header)
1711 status = unpack_sha1_short_header(stream, map, mapsize, buffer, bufsiz);
1716 * Check if entire header is unpacked in the first iteration.
1718 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1722 * buffer[0..bufsiz] was not large enough. Copy the partial
1723 * result out to header, and then append the result of further
1724 * reading the stream.
1726 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1727 stream->next_out = buffer;
1728 stream->avail_out = bufsiz;
1731 status = git_inflate(stream, 0);
1732 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1733 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1735 stream->next_out = buffer;
1736 stream->avail_out = bufsiz;
1737 } while (status != Z_STREAM_END);
1741 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1743 int bytes = strlen(buffer) + 1;
1744 unsigned char *buf = xmallocz(size);
1748 n = stream->total_out - bytes;
1751 memcpy(buf, (char *) buffer + bytes, n);
1753 if (bytes <= size) {
1755 * The above condition must be (bytes <= size), not
1756 * (bytes < size). In other words, even though we
1757 * expect no more output and set avail_out to zero,
1758 * the input zlib stream may have bytes that express
1759 * "this concludes the stream", and we *do* want to
1762 * Otherwise we would not be able to test that we
1763 * consumed all the input to reach the expected size;
1764 * we also want to check that zlib tells us that all
1765 * went well with status == Z_STREAM_END at the end.
1767 stream->next_out = buf + bytes;
1768 stream->avail_out = size - bytes;
1769 while (status == Z_OK)
1770 status = git_inflate(stream, Z_FINISH);
1772 if (status == Z_STREAM_END && !stream->avail_in) {
1773 git_inflate_end(stream);
1778 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1779 else if (stream->avail_in)
1780 error("garbage at end of loose object '%s'",
1787 * We used to just use "sscanf()", but that's actually way
1788 * too permissive for what we want to check. So do an anal
1789 * object header parse by hand.
1791 static int parse_sha1_header_extended(const char *hdr, struct object_info *oi,
1794 const char *type_buf = hdr;
1796 int type, type_len = 0;
1799 * The type can be of any size but is followed by
1811 type = type_from_string_gently(type_buf, type_len, 1);
1813 strbuf_add(oi->typename, type_buf, type_len);
1815 * Set type to 0 if its an unknown object and
1816 * we're obtaining the type using '--allow-unknown-type'
1819 if ((flags & LOOKUP_UNKNOWN_OBJECT) && (type < 0))
1822 die("invalid object type");
1827 * The length must follow immediately, and be in canonical
1828 * decimal format (ie "010" is not valid).
1830 size = *hdr++ - '0';
1835 unsigned long c = *hdr - '0';
1839 size = size * 10 + c;
1847 * The length must be followed by a zero byte
1849 return *hdr ? -1 : type;
1852 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1854 struct object_info oi;
1859 return parse_sha1_header_extended(hdr, &oi, LOOKUP_REPLACE_OBJECT);
1862 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1868 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1869 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1872 return unpack_sha1_rest(&stream, hdr, *size, sha1);
1875 unsigned long get_size_from_delta(struct packed_git *p,
1876 struct pack_window **w_curs,
1879 const unsigned char *data;
1880 unsigned char delta_head[20], *in;
1884 memset(&stream, 0, sizeof(stream));
1885 stream.next_out = delta_head;
1886 stream.avail_out = sizeof(delta_head);
1888 git_inflate_init(&stream);
1890 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1891 stream.next_in = in;
1892 st = git_inflate(&stream, Z_FINISH);
1893 curpos += stream.next_in - in;
1894 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1895 stream.total_out < sizeof(delta_head));
1896 git_inflate_end(&stream);
1897 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1898 error("delta data unpack-initial failed");
1902 /* Examine the initial part of the delta to figure out
1907 /* ignore base size */
1908 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1910 /* Read the result size */
1911 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1914 static off_t get_delta_base(struct packed_git *p,
1915 struct pack_window **w_curs,
1917 enum object_type type,
1918 off_t delta_obj_offset)
1920 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1923 /* use_pack() assured us we have [base_info, base_info + 20)
1924 * as a range that we can look at without walking off the
1925 * end of the mapped window. Its actually the hash size
1926 * that is assured. An OFS_DELTA longer than the hash size
1927 * is stupid, as then a REF_DELTA would be smaller to store.
1929 if (type == OBJ_OFS_DELTA) {
1931 unsigned char c = base_info[used++];
1932 base_offset = c & 127;
1935 if (!base_offset || MSB(base_offset, 7))
1936 return 0; /* overflow */
1937 c = base_info[used++];
1938 base_offset = (base_offset << 7) + (c & 127);
1940 base_offset = delta_obj_offset - base_offset;
1941 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1942 return 0; /* out of bound */
1944 } else if (type == OBJ_REF_DELTA) {
1945 /* The base entry _must_ be in the same pack */
1946 base_offset = find_pack_entry_one(base_info, p);
1949 die("I am totally screwed");
1954 * Like get_delta_base above, but we return the sha1 instead of the pack
1955 * offset. This means it is cheaper for REF deltas (we do not have to do
1956 * the final object lookup), but more expensive for OFS deltas (we
1957 * have to load the revidx to convert the offset back into a sha1).
1959 static const unsigned char *get_delta_base_sha1(struct packed_git *p,
1960 struct pack_window **w_curs,
1962 enum object_type type,
1963 off_t delta_obj_offset)
1965 if (type == OBJ_REF_DELTA) {
1966 unsigned char *base = use_pack(p, w_curs, curpos, NULL);
1968 } else if (type == OBJ_OFS_DELTA) {
1969 struct revindex_entry *revidx;
1970 off_t base_offset = get_delta_base(p, w_curs, &curpos,
1971 type, delta_obj_offset);
1976 revidx = find_pack_revindex(p, base_offset);
1980 return nth_packed_object_sha1(p, revidx->nr);
1985 int unpack_object_header(struct packed_git *p,
1986 struct pack_window **w_curs,
1988 unsigned long *sizep)
1990 unsigned char *base;
1993 enum object_type type;
1995 /* use_pack() assures us we have [base, base + 20) available
1996 * as a range that we can look at. (Its actually the hash
1997 * size that is assured.) With our object header encoding
1998 * the maximum deflated object size is 2^137, which is just
1999 * insane, so we know won't exceed what we have been given.
2001 base = use_pack(p, w_curs, *curpos, &left);
2002 used = unpack_object_header_buffer(base, left, &type, sizep);
2011 static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
2014 struct revindex_entry *revidx;
2015 const unsigned char *sha1;
2016 revidx = find_pack_revindex(p, obj_offset);
2019 sha1 = nth_packed_object_sha1(p, revidx->nr);
2020 mark_bad_packed_object(p, sha1);
2021 type = sha1_object_info(sha1, NULL);
2022 if (type <= OBJ_NONE)
2027 #define POI_STACK_PREALLOC 64
2029 static enum object_type packed_to_object_type(struct packed_git *p,
2031 enum object_type type,
2032 struct pack_window **w_curs,
2035 off_t small_poi_stack[POI_STACK_PREALLOC];
2036 off_t *poi_stack = small_poi_stack;
2037 int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
2039 while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2042 /* Push the object we're going to leave behind */
2043 if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
2044 poi_stack_alloc = alloc_nr(poi_stack_nr);
2045 ALLOC_ARRAY(poi_stack, poi_stack_alloc);
2046 memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
2048 ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
2050 poi_stack[poi_stack_nr++] = obj_offset;
2051 /* If parsing the base offset fails, just unwind */
2052 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
2055 curpos = obj_offset = base_offset;
2056 type = unpack_object_header(p, w_curs, &curpos, &size);
2057 if (type <= OBJ_NONE) {
2058 /* If getting the base itself fails, we first
2059 * retry the base, otherwise unwind */
2060 type = retry_bad_packed_offset(p, base_offset);
2061 if (type > OBJ_NONE)
2075 error("unknown object type %i at offset %"PRIuMAX" in %s",
2076 type, (uintmax_t)obj_offset, p->pack_name);
2081 if (poi_stack != small_poi_stack)
2086 while (poi_stack_nr) {
2087 obj_offset = poi_stack[--poi_stack_nr];
2088 type = retry_bad_packed_offset(p, obj_offset);
2089 if (type > OBJ_NONE)
2096 static int packed_object_info(struct packed_git *p, off_t obj_offset,
2097 struct object_info *oi)
2099 struct pack_window *w_curs = NULL;
2101 off_t curpos = obj_offset;
2102 enum object_type type;
2105 * We always get the representation type, but only convert it to
2106 * a "real" type later if the caller is interested.
2108 type = unpack_object_header(p, &w_curs, &curpos, &size);
2111 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2112 off_t tmp_pos = curpos;
2113 off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
2119 *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
2120 if (*oi->sizep == 0) {
2129 if (oi->disk_sizep) {
2130 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2131 *oi->disk_sizep = revidx[1].offset - obj_offset;
2135 *oi->typep = packed_to_object_type(p, obj_offset, type, &w_curs, curpos);
2136 if (*oi->typep < 0) {
2142 if (oi->delta_base_sha1) {
2143 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2144 const unsigned char *base;
2146 base = get_delta_base_sha1(p, &w_curs, curpos,
2153 hashcpy(oi->delta_base_sha1, base);
2155 hashclr(oi->delta_base_sha1);
2159 unuse_pack(&w_curs);
2163 static void *unpack_compressed_entry(struct packed_git *p,
2164 struct pack_window **w_curs,
2170 unsigned char *buffer, *in;
2172 buffer = xmallocz_gently(size);
2175 memset(&stream, 0, sizeof(stream));
2176 stream.next_out = buffer;
2177 stream.avail_out = size + 1;
2179 git_inflate_init(&stream);
2181 in = use_pack(p, w_curs, curpos, &stream.avail_in);
2182 stream.next_in = in;
2183 st = git_inflate(&stream, Z_FINISH);
2184 if (!stream.avail_out)
2185 break; /* the payload is larger than it should be */
2186 curpos += stream.next_in - in;
2187 } while (st == Z_OK || st == Z_BUF_ERROR);
2188 git_inflate_end(&stream);
2189 if ((st != Z_STREAM_END) || stream.total_out != size) {
2197 static struct hashmap delta_base_cache;
2198 static size_t delta_base_cached;
2200 static LIST_HEAD(delta_base_cache_lru);
2202 struct delta_base_cache_key {
2203 struct packed_git *p;
2207 struct delta_base_cache_entry {
2208 struct hashmap hash;
2209 struct delta_base_cache_key key;
2210 struct list_head lru;
2213 enum object_type type;
2216 static unsigned int pack_entry_hash(struct packed_git *p, off_t base_offset)
2220 hash = (unsigned int)(intptr_t)p + (unsigned int)base_offset;
2221 hash += (hash >> 8) + (hash >> 16);
2225 static struct delta_base_cache_entry *
2226 get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
2228 struct hashmap_entry entry;
2229 struct delta_base_cache_key key;
2231 if (!delta_base_cache.cmpfn)
2234 hashmap_entry_init(&entry, pack_entry_hash(p, base_offset));
2236 key.base_offset = base_offset;
2237 return hashmap_get(&delta_base_cache, &entry, &key);
2240 static int delta_base_cache_key_eq(const struct delta_base_cache_key *a,
2241 const struct delta_base_cache_key *b)
2243 return a->p == b->p && a->base_offset == b->base_offset;
2246 static int delta_base_cache_hash_cmp(const void *va, const void *vb,
2249 const struct delta_base_cache_entry *a = va, *b = vb;
2250 const struct delta_base_cache_key *key = vkey;
2252 return !delta_base_cache_key_eq(&a->key, key);
2254 return !delta_base_cache_key_eq(&a->key, &b->key);
2257 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
2259 return !!get_delta_base_cache_entry(p, base_offset);
2263 * Remove the entry from the cache, but do _not_ free the associated
2264 * entry data. The caller takes ownership of the "data" buffer, and
2265 * should copy out any fields it wants before detaching.
2267 static void detach_delta_base_cache_entry(struct delta_base_cache_entry *ent)
2269 hashmap_remove(&delta_base_cache, ent, &ent->key);
2270 list_del(&ent->lru);
2271 delta_base_cached -= ent->size;
2275 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
2276 unsigned long *base_size, enum object_type *type)
2278 struct delta_base_cache_entry *ent;
2280 ent = get_delta_base_cache_entry(p, base_offset);
2282 return unpack_entry(p, base_offset, type, base_size);
2285 *base_size = ent->size;
2286 return xmemdupz(ent->data, ent->size);
2289 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
2292 detach_delta_base_cache_entry(ent);
2295 void clear_delta_base_cache(void)
2297 struct hashmap_iter iter;
2298 struct delta_base_cache_entry *entry;
2299 for (entry = hashmap_iter_first(&delta_base_cache, &iter);
2301 entry = hashmap_iter_next(&iter)) {
2302 release_delta_base_cache(entry);
2306 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
2307 void *base, unsigned long base_size, enum object_type type)
2309 struct delta_base_cache_entry *ent = xmalloc(sizeof(*ent));
2310 struct list_head *lru, *tmp;
2312 delta_base_cached += base_size;
2314 list_for_each_safe(lru, tmp, &delta_base_cache_lru) {
2315 struct delta_base_cache_entry *f =
2316 list_entry(lru, struct delta_base_cache_entry, lru);
2317 if (delta_base_cached <= delta_base_cache_limit)
2319 release_delta_base_cache(f);
2323 ent->key.base_offset = base_offset;
2326 ent->size = base_size;
2327 list_add_tail(&ent->lru, &delta_base_cache_lru);
2329 if (!delta_base_cache.cmpfn)
2330 hashmap_init(&delta_base_cache, delta_base_cache_hash_cmp, 0);
2331 hashmap_entry_init(ent, pack_entry_hash(p, base_offset));
2332 hashmap_add(&delta_base_cache, ent);
2335 static void *read_object(const unsigned char *sha1, enum object_type *type,
2336 unsigned long *size);
2338 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
2340 static struct trace_key pack_access = TRACE_KEY_INIT(PACK_ACCESS);
2341 trace_printf_key(&pack_access, "%s %"PRIuMAX"\n",
2342 p->pack_name, (uintmax_t)obj_offset);
2345 int do_check_packed_object_crc;
2347 #define UNPACK_ENTRY_STACK_PREALLOC 64
2348 struct unpack_entry_stack_ent {
2354 void *unpack_entry(struct packed_git *p, off_t obj_offset,
2355 enum object_type *final_type, unsigned long *final_size)
2357 struct pack_window *w_curs = NULL;
2358 off_t curpos = obj_offset;
2361 enum object_type type;
2362 struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
2363 struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
2364 int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
2365 int base_from_cache = 0;
2367 write_pack_access_log(p, obj_offset);
2369 /* PHASE 1: drill down to the innermost base object */
2373 struct delta_base_cache_entry *ent;
2375 ent = get_delta_base_cache_entry(p, curpos);
2380 detach_delta_base_cache_entry(ent);
2381 base_from_cache = 1;
2385 if (do_check_packed_object_crc && p->index_version > 1) {
2386 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2387 off_t len = revidx[1].offset - obj_offset;
2388 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
2389 const unsigned char *sha1 =
2390 nth_packed_object_sha1(p, revidx->nr);
2391 error("bad packed object CRC for %s",
2393 mark_bad_packed_object(p, sha1);
2394 unuse_pack(&w_curs);
2399 type = unpack_object_header(p, &w_curs, &curpos, &size);
2400 if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
2403 base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
2405 error("failed to validate delta base reference "
2406 "at offset %"PRIuMAX" from %s",
2407 (uintmax_t)curpos, p->pack_name);
2408 /* bail to phase 2, in hopes of recovery */
2413 /* push object, proceed to base */
2414 if (delta_stack_nr >= delta_stack_alloc
2415 && delta_stack == small_delta_stack) {
2416 delta_stack_alloc = alloc_nr(delta_stack_nr);
2417 ALLOC_ARRAY(delta_stack, delta_stack_alloc);
2418 memcpy(delta_stack, small_delta_stack,
2419 sizeof(*delta_stack)*delta_stack_nr);
2421 ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
2423 i = delta_stack_nr++;
2424 delta_stack[i].obj_offset = obj_offset;
2425 delta_stack[i].curpos = curpos;
2426 delta_stack[i].size = size;
2428 curpos = obj_offset = base_offset;
2431 /* PHASE 2: handle the base */
2436 die("BUG: unpack_entry: left loop at a valid delta");
2442 if (!base_from_cache)
2443 data = unpack_compressed_entry(p, &w_curs, curpos, size);
2447 error("unknown object type %i at offset %"PRIuMAX" in %s",
2448 type, (uintmax_t)obj_offset, p->pack_name);
2451 /* PHASE 3: apply deltas in order */
2454 * 'data' holds the base data, or NULL if there was corruption
2456 while (delta_stack_nr) {
2459 unsigned long delta_size, base_size = size;
2465 add_delta_base_cache(p, obj_offset, base, base_size, type);
2469 * We're probably in deep shit, but let's try to fetch
2470 * the required base anyway from another pack or loose.
2471 * This is costly but should happen only in the presence
2472 * of a corrupted pack, and is better than failing outright.
2474 struct revindex_entry *revidx;
2475 const unsigned char *base_sha1;
2476 revidx = find_pack_revindex(p, obj_offset);
2478 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
2479 error("failed to read delta base object %s"
2480 " at offset %"PRIuMAX" from %s",
2481 sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
2483 mark_bad_packed_object(p, base_sha1);
2484 base = read_object(base_sha1, &type, &base_size);
2488 i = --delta_stack_nr;
2489 obj_offset = delta_stack[i].obj_offset;
2490 curpos = delta_stack[i].curpos;
2491 delta_size = delta_stack[i].size;
2496 delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
2499 error("failed to unpack compressed delta "
2500 "at offset %"PRIuMAX" from %s",
2501 (uintmax_t)curpos, p->pack_name);
2506 data = patch_delta(base, base_size,
2507 delta_data, delta_size,
2511 * We could not apply the delta; warn the user, but keep going.
2512 * Our failure will be noticed either in the next iteration of
2513 * the loop, or if this is the final delta, in the caller when
2514 * we return NULL. Those code paths will take care of making
2515 * a more explicit warning and retrying with another copy of
2519 error("failed to apply delta");
2527 unuse_pack(&w_curs);
2529 if (delta_stack != small_delta_stack)
2535 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2538 const unsigned char *index = p->index_data;
2540 if (open_pack_index(p))
2542 index = p->index_data;
2544 if (n >= p->num_objects)
2547 if (p->index_version == 1) {
2548 return index + 24 * n + 4;
2551 return index + 20 * n;
2555 void check_pack_index_ptr(const struct packed_git *p, const void *vptr)
2557 const unsigned char *ptr = vptr;
2558 const unsigned char *start = p->index_data;
2559 const unsigned char *end = start + p->index_size;
2561 die(_("offset before start of pack index for %s (corrupt index?)"),
2563 /* No need to check for underflow; .idx files must be at least 8 bytes */
2565 die(_("offset beyond end of pack index for %s (truncated index?)"),
2569 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2571 const unsigned char *index = p->index_data;
2573 if (p->index_version == 1) {
2574 return ntohl(*((uint32_t *)(index + 24 * n)));
2577 index += 8 + p->num_objects * (20 + 4);
2578 off = ntohl(*((uint32_t *)(index + 4 * n)));
2579 if (!(off & 0x80000000))
2581 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2582 check_pack_index_ptr(p, index);
2583 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2584 ntohl(*((uint32_t *)(index + 4)));
2588 off_t find_pack_entry_one(const unsigned char *sha1,
2589 struct packed_git *p)
2591 const uint32_t *level1_ofs = p->index_data;
2592 const unsigned char *index = p->index_data;
2593 unsigned hi, lo, stride;
2594 static int use_lookup = -1;
2595 static int debug_lookup = -1;
2597 if (debug_lookup < 0)
2598 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2601 if (open_pack_index(p))
2603 level1_ofs = p->index_data;
2604 index = p->index_data;
2606 if (p->index_version > 1) {
2611 hi = ntohl(level1_ofs[*sha1]);
2612 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2613 if (p->index_version > 1) {
2621 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2622 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2625 use_lookup = !!getenv("GIT_USE_LOOKUP");
2627 int pos = sha1_entry_pos(index, stride, 0,
2628 lo, hi, p->num_objects, sha1);
2631 return nth_packed_object_offset(p, pos);
2635 unsigned mi = (lo + hi) / 2;
2636 int cmp = hashcmp(index + mi * stride, sha1);
2639 printf("lo %u hi %u rg %u mi %u\n",
2640 lo, hi, hi - lo, mi);
2642 return nth_packed_object_offset(p, mi);
2651 int is_pack_valid(struct packed_git *p)
2653 /* An already open pack is known to be valid. */
2654 if (p->pack_fd != -1)
2657 /* If the pack has one window completely covering the
2658 * file size, the pack is known to be valid even if
2659 * the descriptor is not currently open.
2662 struct pack_window *w = p->windows;
2664 if (!w->offset && w->len == p->pack_size)
2668 /* Force the pack to open to prove its valid. */
2669 return !open_packed_git(p);
2672 static int fill_pack_entry(const unsigned char *sha1,
2673 struct pack_entry *e,
2674 struct packed_git *p)
2678 if (p->num_bad_objects) {
2680 for (i = 0; i < p->num_bad_objects; i++)
2681 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2685 offset = find_pack_entry_one(sha1, p);
2690 * We are about to tell the caller where they can locate the
2691 * requested object. We better make sure the packfile is
2692 * still here and can be accessed before supplying that
2693 * answer, as it may have been deleted since the index was
2696 if (!is_pack_valid(p))
2700 hashcpy(e->sha1, sha1);
2705 * Iff a pack file contains the object named by sha1, return true and
2706 * store its location to e.
2708 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2710 struct mru_entry *p;
2712 prepare_packed_git();
2716 for (p = packed_git_mru->head; p; p = p->next) {
2717 if (fill_pack_entry(sha1, e, p->item)) {
2718 mru_mark(packed_git_mru, p);
2725 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2726 struct packed_git *packs)
2728 struct packed_git *p;
2730 for (p = packs; p; p = p->next) {
2731 if (find_pack_entry_one(sha1, p))
2738 static int sha1_loose_object_info(const unsigned char *sha1,
2739 struct object_info *oi,
2743 unsigned long mapsize;
2747 struct strbuf hdrbuf = STRBUF_INIT;
2749 if (oi->delta_base_sha1)
2750 hashclr(oi->delta_base_sha1);
2753 * If we don't care about type or size, then we don't
2754 * need to look inside the object at all. Note that we
2755 * do not optimize out the stat call, even if the
2756 * caller doesn't care about the disk-size, since our
2757 * return value implicitly indicates whether the
2758 * object even exists.
2760 if (!oi->typep && !oi->typename && !oi->sizep) {
2762 if (stat_sha1_file(sha1, &st) < 0)
2765 *oi->disk_sizep = st.st_size;
2769 map = map_sha1_file(sha1, &mapsize);
2773 *oi->disk_sizep = mapsize;
2774 if ((flags & LOOKUP_UNKNOWN_OBJECT)) {
2775 if (unpack_sha1_header_to_strbuf(&stream, map, mapsize, hdr, sizeof(hdr), &hdrbuf) < 0)
2776 status = error("unable to unpack %s header with --allow-unknown-type",
2778 } else if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2779 status = error("unable to unpack %s header",
2783 else if (hdrbuf.len) {
2784 if ((status = parse_sha1_header_extended(hdrbuf.buf, oi, flags)) < 0)
2785 status = error("unable to parse %s header with --allow-unknown-type",
2787 } else if ((status = parse_sha1_header_extended(hdr, oi, flags)) < 0)
2788 status = error("unable to parse %s header", sha1_to_hex(sha1));
2789 git_inflate_end(&stream);
2790 munmap(map, mapsize);
2791 if (status && oi->typep)
2792 *oi->typep = status;
2793 strbuf_release(&hdrbuf);
2797 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi, unsigned flags)
2799 struct cached_object *co;
2800 struct pack_entry e;
2802 enum object_type real_type;
2803 const unsigned char *real = lookup_replace_object_extended(sha1, flags);
2805 co = find_cached_object(real);
2808 *(oi->typep) = co->type;
2810 *(oi->sizep) = co->size;
2812 *(oi->disk_sizep) = 0;
2813 if (oi->delta_base_sha1)
2814 hashclr(oi->delta_base_sha1);
2816 strbuf_addstr(oi->typename, typename(co->type));
2817 oi->whence = OI_CACHED;
2821 if (!find_pack_entry(real, &e)) {
2822 /* Most likely it's a loose object. */
2823 if (!sha1_loose_object_info(real, oi, flags)) {
2824 oi->whence = OI_LOOSE;
2828 /* Not a loose object; someone else may have just packed it. */
2829 reprepare_packed_git();
2830 if (!find_pack_entry(real, &e))
2835 * packed_object_info() does not follow the delta chain to
2836 * find out the real type, unless it is given oi->typep.
2838 if (oi->typename && !oi->typep)
2839 oi->typep = &real_type;
2841 rtype = packed_object_info(e.p, e.offset, oi);
2843 mark_bad_packed_object(e.p, real);
2844 if (oi->typep == &real_type)
2846 return sha1_object_info_extended(real, oi, 0);
2847 } else if (in_delta_base_cache(e.p, e.offset)) {
2848 oi->whence = OI_DBCACHED;
2850 oi->whence = OI_PACKED;
2851 oi->u.packed.offset = e.offset;
2852 oi->u.packed.pack = e.p;
2853 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2854 rtype == OBJ_OFS_DELTA);
2857 strbuf_addstr(oi->typename, typename(*oi->typep));
2858 if (oi->typep == &real_type)
2864 /* returns enum object_type or negative */
2865 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2867 enum object_type type;
2868 struct object_info oi = {NULL};
2872 if (sha1_object_info_extended(sha1, &oi, LOOKUP_REPLACE_OBJECT) < 0)
2877 static void *read_packed_sha1(const unsigned char *sha1,
2878 enum object_type *type, unsigned long *size)
2880 struct pack_entry e;
2883 if (!find_pack_entry(sha1, &e))
2885 data = cache_or_unpack_entry(e.p, e.offset, size, type);
2888 * We're probably in deep shit, but let's try to fetch
2889 * the required object anyway from another pack or loose.
2890 * This should happen only in the presence of a corrupted
2891 * pack, and is better than failing outright.
2893 error("failed to read object %s at offset %"PRIuMAX" from %s",
2894 sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2895 mark_bad_packed_object(e.p, sha1);
2896 data = read_object(sha1, type, size);
2901 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2902 unsigned char *sha1)
2904 struct cached_object *co;
2906 hash_sha1_file(buf, len, typename(type), sha1);
2907 if (has_sha1_file(sha1) || find_cached_object(sha1))
2909 ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
2910 co = &cached_objects[cached_object_nr++];
2913 co->buf = xmalloc(len);
2914 memcpy(co->buf, buf, len);
2915 hashcpy(co->sha1, sha1);
2919 static void *read_object(const unsigned char *sha1, enum object_type *type,
2920 unsigned long *size)
2922 unsigned long mapsize;
2924 struct cached_object *co;
2926 co = find_cached_object(sha1);
2930 return xmemdupz(co->buf, co->size);
2933 buf = read_packed_sha1(sha1, type, size);
2936 map = map_sha1_file(sha1, &mapsize);
2938 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2939 munmap(map, mapsize);
2942 reprepare_packed_git();
2943 return read_packed_sha1(sha1, type, size);
2947 * This function dies on corrupt objects; the callers who want to
2948 * deal with them should arrange to call read_object() and give error
2949 * messages themselves.
2951 void *read_sha1_file_extended(const unsigned char *sha1,
2952 enum object_type *type,
2953 unsigned long *size,
2957 const struct packed_git *p;
2958 const unsigned char *repl = lookup_replace_object_extended(sha1, flag);
2961 data = read_object(repl, type, size);
2965 if (errno && errno != ENOENT)
2966 die_errno("failed to read object %s", sha1_to_hex(sha1));
2968 /* die if we replaced an object with one that does not exist */
2970 die("replacement %s not found for %s",
2971 sha1_to_hex(repl), sha1_to_hex(sha1));
2973 if (has_loose_object(repl)) {
2974 const char *path = sha1_file_name(sha1);
2976 die("loose object %s (stored in %s) is corrupt",
2977 sha1_to_hex(repl), path);
2980 if ((p = has_packed_and_bad(repl)) != NULL)
2981 die("packed object %s (stored in %s) is corrupt",
2982 sha1_to_hex(repl), p->pack_name);
2987 void *read_object_with_reference(const unsigned char *sha1,
2988 const char *required_type_name,
2989 unsigned long *size,
2990 unsigned char *actual_sha1_return)
2992 enum object_type type, required_type;
2994 unsigned long isize;
2995 unsigned char actual_sha1[20];
2997 required_type = type_from_string(required_type_name);
2998 hashcpy(actual_sha1, sha1);
3000 int ref_length = -1;
3001 const char *ref_type = NULL;
3003 buffer = read_sha1_file(actual_sha1, &type, &isize);
3006 if (type == required_type) {
3008 if (actual_sha1_return)
3009 hashcpy(actual_sha1_return, actual_sha1);
3012 /* Handle references */
3013 else if (type == OBJ_COMMIT)
3015 else if (type == OBJ_TAG)
3016 ref_type = "object ";
3021 ref_length = strlen(ref_type);
3023 if (ref_length + 40 > isize ||
3024 memcmp(buffer, ref_type, ref_length) ||
3025 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
3030 /* Now we have the ID of the referred-to object in
3031 * actual_sha1. Check again. */
3035 static void write_sha1_file_prepare(const void *buf, unsigned long len,
3036 const char *type, unsigned char *sha1,
3037 char *hdr, int *hdrlen)
3041 /* Generate the header */
3042 *hdrlen = xsnprintf(hdr, *hdrlen, "%s %lu", type, len)+1;
3046 git_SHA1_Update(&c, hdr, *hdrlen);
3047 git_SHA1_Update(&c, buf, len);
3048 git_SHA1_Final(sha1, &c);
3052 * Move the just written object into its final resting place.
3054 int finalize_object_file(const char *tmpfile, const char *filename)
3058 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
3060 else if (link(tmpfile, filename))
3064 * Coda hack - coda doesn't like cross-directory links,
3065 * so we fall back to a rename, which will mean that it
3066 * won't be able to check collisions, but that's not a
3069 * The same holds for FAT formatted media.
3071 * When this succeeds, we just return. We have nothing
3074 if (ret && ret != EEXIST) {
3076 if (!rename(tmpfile, filename))
3080 unlink_or_warn(tmpfile);
3082 if (ret != EEXIST) {
3083 return error_errno("unable to write sha1 filename %s", filename);
3085 /* FIXME!!! Collision check here ? */
3089 if (adjust_shared_perm(filename))
3090 return error("unable to set permission to '%s'", filename);
3094 static int write_buffer(int fd, const void *buf, size_t len)
3096 if (write_in_full(fd, buf, len) < 0)
3097 return error_errno("file write error");
3101 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
3102 unsigned char *sha1)
3105 int hdrlen = sizeof(hdr);
3106 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3110 /* Finalize a file on disk, and close it. */
3111 static void close_sha1_file(int fd)
3113 if (fsync_object_files)
3114 fsync_or_die(fd, "sha1 file");
3116 die_errno("error when closing sha1 file");
3119 /* Size of directory component, including the ending '/' */
3120 static inline int directory_size(const char *filename)
3122 const char *s = strrchr(filename, '/');
3125 return s - filename + 1;
3129 * This creates a temporary file in the same directory as the final
3132 * We want to avoid cross-directory filename renames, because those
3133 * can have problems on various filesystems (FAT, NFS, Coda).
3135 static int create_tmpfile(struct strbuf *tmp, const char *filename)
3137 int fd, dirlen = directory_size(filename);
3140 strbuf_add(tmp, filename, dirlen);
3141 strbuf_addstr(tmp, "tmp_obj_XXXXXX");
3142 fd = git_mkstemp_mode(tmp->buf, 0444);
3143 if (fd < 0 && dirlen && errno == ENOENT) {
3145 * Make sure the directory exists; note that the contents
3146 * of the buffer are undefined after mkstemp returns an
3147 * error, so we have to rewrite the whole buffer from
3151 strbuf_add(tmp, filename, dirlen - 1);
3152 if (mkdir(tmp->buf, 0777) && errno != EEXIST)
3154 if (adjust_shared_perm(tmp->buf))
3158 strbuf_addstr(tmp, "/tmp_obj_XXXXXX");
3159 fd = git_mkstemp_mode(tmp->buf, 0444);
3164 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
3165 const void *buf, unsigned long len, time_t mtime)
3168 unsigned char compressed[4096];
3171 unsigned char parano_sha1[20];
3172 static struct strbuf tmp_file = STRBUF_INIT;
3173 const char *filename = sha1_file_name(sha1);
3175 fd = create_tmpfile(&tmp_file, filename);
3177 if (errno == EACCES)
3178 return error("insufficient permission for adding an object to repository database %s", get_object_directory());
3180 return error_errno("unable to create temporary file");
3184 git_deflate_init(&stream, zlib_compression_level);
3185 stream.next_out = compressed;
3186 stream.avail_out = sizeof(compressed);
3189 /* First header.. */
3190 stream.next_in = (unsigned char *)hdr;
3191 stream.avail_in = hdrlen;
3192 while (git_deflate(&stream, 0) == Z_OK)
3194 git_SHA1_Update(&c, hdr, hdrlen);
3196 /* Then the data itself.. */
3197 stream.next_in = (void *)buf;
3198 stream.avail_in = len;
3200 unsigned char *in0 = stream.next_in;
3201 ret = git_deflate(&stream, Z_FINISH);
3202 git_SHA1_Update(&c, in0, stream.next_in - in0);
3203 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
3204 die("unable to write sha1 file");
3205 stream.next_out = compressed;
3206 stream.avail_out = sizeof(compressed);
3207 } while (ret == Z_OK);
3209 if (ret != Z_STREAM_END)
3210 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
3211 ret = git_deflate_end_gently(&stream);
3213 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
3214 git_SHA1_Final(parano_sha1, &c);
3215 if (hashcmp(sha1, parano_sha1) != 0)
3216 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
3218 close_sha1_file(fd);
3223 utb.modtime = mtime;
3224 if (utime(tmp_file.buf, &utb) < 0)
3225 warning_errno("failed utime() on %s", tmp_file.buf);
3228 return finalize_object_file(tmp_file.buf, filename);
3231 static int freshen_loose_object(const unsigned char *sha1)
3233 return check_and_freshen(sha1, 1);
3236 static int freshen_packed_object(const unsigned char *sha1)
3238 struct pack_entry e;
3239 if (!find_pack_entry(sha1, &e))
3243 if (!freshen_file(e.p->pack_name))
3249 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1)
3252 int hdrlen = sizeof(hdr);
3254 /* Normally if we have it in the pack then we do not bother writing
3255 * it out into .git/objects/??/?{38} file.
3257 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3258 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3260 return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
3263 int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type,
3264 unsigned char *sha1, unsigned flags)
3267 int hdrlen, status = 0;
3269 /* type string, SP, %lu of the length plus NUL must fit this */
3270 hdrlen = strlen(type) + 32;
3271 header = xmalloc(hdrlen);
3272 write_sha1_file_prepare(buf, len, type, sha1, header, &hdrlen);
3274 if (!(flags & HASH_WRITE_OBJECT))
3276 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3278 status = write_loose_object(sha1, header, hdrlen, buf, len, 0);
3285 int force_object_loose(const unsigned char *sha1, time_t mtime)
3289 enum object_type type;
3294 if (has_loose_object(sha1))
3296 buf = read_packed_sha1(sha1, &type, &len);
3298 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
3299 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(type), len) + 1;
3300 ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
3306 int has_pack_index(const unsigned char *sha1)
3309 if (stat(sha1_pack_index_name(sha1), &st))
3314 int has_sha1_pack(const unsigned char *sha1)
3316 struct pack_entry e;
3317 return find_pack_entry(sha1, &e);
3320 int has_sha1_file_with_flags(const unsigned char *sha1, int flags)
3322 struct pack_entry e;
3324 if (find_pack_entry(sha1, &e))
3326 if (has_loose_object(sha1))
3328 if (flags & HAS_SHA1_QUICK)
3330 reprepare_packed_git();
3331 return find_pack_entry(sha1, &e);
3334 int has_object_file(const struct object_id *oid)
3336 return has_sha1_file(oid->hash);
3339 static void check_tree(const void *buf, size_t size)
3341 struct tree_desc desc;
3342 struct name_entry entry;
3344 init_tree_desc(&desc, buf, size);
3345 while (tree_entry(&desc, &entry))
3347 * tree_entry() will die() on malformed entries */
3351 static void check_commit(const void *buf, size_t size)
3354 memset(&c, 0, sizeof(c));
3355 if (parse_commit_buffer(&c, buf, size))
3356 die("corrupt commit");
3359 static void check_tag(const void *buf, size_t size)
3362 memset(&t, 0, sizeof(t));
3363 if (parse_tag_buffer(&t, buf, size))
3367 static int index_mem(unsigned char *sha1, void *buf, size_t size,
3368 enum object_type type,
3369 const char *path, unsigned flags)
3371 int ret, re_allocated = 0;
3372 int write_object = flags & HASH_WRITE_OBJECT;
3378 * Convert blobs to git internal format
3380 if ((type == OBJ_BLOB) && path) {
3381 struct strbuf nbuf = STRBUF_INIT;
3382 if (convert_to_git(path, buf, size, &nbuf,
3383 write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
3384 buf = strbuf_detach(&nbuf, &size);
3388 if (flags & HASH_FORMAT_CHECK) {
3389 if (type == OBJ_TREE)
3390 check_tree(buf, size);
3391 if (type == OBJ_COMMIT)
3392 check_commit(buf, size);
3393 if (type == OBJ_TAG)
3394 check_tag(buf, size);
3398 ret = write_sha1_file(buf, size, typename(type), sha1);
3400 ret = hash_sha1_file(buf, size, typename(type), sha1);
3406 static int index_stream_convert_blob(unsigned char *sha1, int fd,
3407 const char *path, unsigned flags)
3410 const int write_object = flags & HASH_WRITE_OBJECT;
3411 struct strbuf sbuf = STRBUF_INIT;
3414 assert(would_convert_to_git_filter_fd(path));
3416 convert_to_git_filter_fd(path, fd, &sbuf,
3417 write_object ? safe_crlf : SAFE_CRLF_FALSE);
3420 ret = write_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3423 ret = hash_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3425 strbuf_release(&sbuf);
3429 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
3430 const char *path, unsigned flags)
3432 struct strbuf sbuf = STRBUF_INIT;
3435 if (strbuf_read(&sbuf, fd, 4096) >= 0)
3436 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
3439 strbuf_release(&sbuf);
3443 #define SMALL_FILE_SIZE (32*1024)
3445 static int index_core(unsigned char *sha1, int fd, size_t size,
3446 enum object_type type, const char *path,
3452 ret = index_mem(sha1, "", size, type, path, flags);
3453 } else if (size <= SMALL_FILE_SIZE) {
3454 char *buf = xmalloc(size);
3455 if (size == read_in_full(fd, buf, size))
3456 ret = index_mem(sha1, buf, size, type, path, flags);
3458 ret = error_errno("short read");
3461 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
3462 ret = index_mem(sha1, buf, size, type, path, flags);
3469 * This creates one packfile per large blob unless bulk-checkin
3470 * machinery is "plugged".
3472 * This also bypasses the usual "convert-to-git" dance, and that is on
3473 * purpose. We could write a streaming version of the converting
3474 * functions and insert that before feeding the data to fast-import
3475 * (or equivalent in-core API described above). However, that is
3476 * somewhat complicated, as we do not know the size of the filter
3477 * result, which we need to know beforehand when writing a git object.
3478 * Since the primary motivation for trying to stream from the working
3479 * tree file and to avoid mmaping it in core is to deal with large
3480 * binary blobs, they generally do not want to get any conversion, and
3481 * callers should avoid this code path when filters are requested.
3483 static int index_stream(unsigned char *sha1, int fd, size_t size,
3484 enum object_type type, const char *path,
3487 return index_bulk_checkin(sha1, fd, size, type, path, flags);
3490 int index_fd(unsigned char *sha1, int fd, struct stat *st,
3491 enum object_type type, const char *path, unsigned flags)
3496 * Call xsize_t() only when needed to avoid potentially unnecessary
3497 * die() for large files.
3499 if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(path))
3500 ret = index_stream_convert_blob(sha1, fd, path, flags);
3501 else if (!S_ISREG(st->st_mode))
3502 ret = index_pipe(sha1, fd, type, path, flags);
3503 else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
3504 (path && would_convert_to_git(path)))
3505 ret = index_core(sha1, fd, xsize_t(st->st_size), type, path,
3508 ret = index_stream(sha1, fd, xsize_t(st->st_size), type, path,
3514 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
3517 struct strbuf sb = STRBUF_INIT;
3519 switch (st->st_mode & S_IFMT) {
3521 fd = open(path, O_RDONLY);
3523 return error_errno("open(\"%s\")", path);
3524 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
3525 return error("%s: failed to insert into database",
3529 if (strbuf_readlink(&sb, path, st->st_size))
3530 return error_errno("readlink(\"%s\")", path);
3531 if (!(flags & HASH_WRITE_OBJECT))
3532 hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
3533 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
3534 return error("%s: failed to insert into database",
3536 strbuf_release(&sb);
3539 return resolve_gitlink_ref(path, "HEAD", sha1);
3541 return error("%s: unsupported file type", path);
3546 int read_pack_header(int fd, struct pack_header *header)
3548 if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
3549 /* "eof before pack header was fully read" */
3550 return PH_ERROR_EOF;
3552 if (header->hdr_signature != htonl(PACK_SIGNATURE))
3553 /* "protocol error (pack signature mismatch detected)" */
3554 return PH_ERROR_PACK_SIGNATURE;
3555 if (!pack_version_ok(header->hdr_version))
3556 /* "protocol error (pack version unsupported)" */
3557 return PH_ERROR_PROTOCOL;
3561 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
3563 enum object_type type = sha1_object_info(sha1, NULL);
3565 die("%s is not a valid object", sha1_to_hex(sha1));
3567 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
3571 static int for_each_file_in_obj_subdir(int subdir_nr,
3572 struct strbuf *path,
3573 each_loose_object_fn obj_cb,
3574 each_loose_cruft_fn cruft_cb,
3575 each_loose_subdir_fn subdir_cb,
3578 size_t baselen = path->len;
3579 DIR *dir = opendir(path->buf);
3584 if (errno == ENOENT)
3586 return error_errno("unable to open %s", path->buf);
3589 while ((de = readdir(dir))) {
3590 if (is_dot_or_dotdot(de->d_name))
3593 strbuf_setlen(path, baselen);
3594 strbuf_addf(path, "/%s", de->d_name);
3596 if (strlen(de->d_name) == 38) {
3598 unsigned char sha1[20];
3600 snprintf(hex, sizeof(hex), "%02x%s",
3601 subdir_nr, de->d_name);
3602 if (!get_sha1_hex(hex, sha1)) {
3604 r = obj_cb(sha1, path->buf, data);
3613 r = cruft_cb(de->d_name, path->buf, data);
3620 strbuf_setlen(path, baselen);
3621 if (!r && subdir_cb)
3622 r = subdir_cb(subdir_nr, path->buf, data);
3627 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
3628 each_loose_object_fn obj_cb,
3629 each_loose_cruft_fn cruft_cb,
3630 each_loose_subdir_fn subdir_cb,
3633 size_t baselen = path->len;
3637 for (i = 0; i < 256; i++) {
3638 strbuf_addf(path, "/%02x", i);
3639 r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
3641 strbuf_setlen(path, baselen);
3649 int for_each_loose_file_in_objdir(const char *path,
3650 each_loose_object_fn obj_cb,
3651 each_loose_cruft_fn cruft_cb,
3652 each_loose_subdir_fn subdir_cb,
3655 struct strbuf buf = STRBUF_INIT;
3658 strbuf_addstr(&buf, path);
3659 r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
3661 strbuf_release(&buf);
3666 struct loose_alt_odb_data {
3667 each_loose_object_fn *cb;
3671 static int loose_from_alt_odb(struct alternate_object_database *alt,
3674 struct loose_alt_odb_data *data = vdata;
3675 struct strbuf buf = STRBUF_INIT;
3678 /* copy base not including trailing '/' */
3679 strbuf_add(&buf, alt->base, alt->name - alt->base - 1);
3680 r = for_each_loose_file_in_objdir_buf(&buf,
3681 data->cb, NULL, NULL,
3683 strbuf_release(&buf);
3687 int for_each_loose_object(each_loose_object_fn cb, void *data, unsigned flags)
3689 struct loose_alt_odb_data alt;
3692 r = for_each_loose_file_in_objdir(get_object_directory(),
3693 cb, NULL, NULL, data);
3697 if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
3702 return foreach_alt_odb(loose_from_alt_odb, &alt);
3705 static int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn cb, void *data)
3710 for (i = 0; i < p->num_objects; i++) {
3711 const unsigned char *sha1 = nth_packed_object_sha1(p, i);
3714 return error("unable to get sha1 of object %u in %s",
3717 r = cb(sha1, p, i, data);
3724 int for_each_packed_object(each_packed_object_fn cb, void *data, unsigned flags)
3726 struct packed_git *p;
3728 int pack_errors = 0;
3730 prepare_packed_git();
3731 for (p = packed_git; p; p = p->next) {
3732 if ((flags & FOR_EACH_OBJECT_LOCAL_ONLY) && !p->pack_local)
3734 if (open_pack_index(p)) {
3738 r = for_each_object_in_pack(p, cb, data);
3742 return r ? r : pack_errors;