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"
30 #define SZ_FMT PRIuMAX
31 static inline uintmax_t sz_fmt(size_t s) { return s; }
33 const unsigned char null_sha1[20];
34 const struct object_id null_oid;
35 const struct object_id empty_tree_oid = {
36 EMPTY_TREE_SHA1_BIN_LITERAL
38 const struct object_id empty_blob_oid = {
39 EMPTY_BLOB_SHA1_BIN_LITERAL
43 * This is meant to hold a *small* number of objects that you would
44 * want read_sha1_file() to be able to return, but yet you do not want
45 * to write them into the object store (e.g. a browse-only
48 static struct cached_object {
49 unsigned char sha1[20];
50 enum object_type type;
54 static int cached_object_nr, cached_object_alloc;
56 static struct cached_object empty_tree = {
57 EMPTY_TREE_SHA1_BIN_LITERAL,
63 static struct cached_object *find_cached_object(const unsigned char *sha1)
66 struct cached_object *co = cached_objects;
68 for (i = 0; i < cached_object_nr; i++, co++) {
69 if (!hashcmp(co->sha1, sha1))
72 if (!hashcmp(sha1, empty_tree.sha1))
77 int mkdir_in_gitdir(const char *path)
79 if (mkdir(path, 0777)) {
80 int saved_errno = errno;
82 struct strbuf sb = STRBUF_INIT;
87 * Are we looking at a path in a symlinked worktree
88 * whose original repository does not yet have it?
89 * e.g. .git/rr-cache pointing at its original
90 * repository in which the user hasn't performed any
91 * conflict resolution yet?
93 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
94 strbuf_readlink(&sb, path, st.st_size) ||
95 !is_absolute_path(sb.buf) ||
96 mkdir(sb.buf, 0777)) {
103 return adjust_shared_perm(path);
106 enum scld_error safe_create_leading_directories(char *path)
108 char *next_component = path + offset_1st_component(path);
109 enum scld_error ret = SCLD_OK;
111 while (ret == SCLD_OK && next_component) {
113 char *slash = next_component, slash_character;
115 while (*slash && !is_dir_sep(*slash))
121 next_component = slash + 1;
122 while (is_dir_sep(*next_component))
124 if (!*next_component)
127 slash_character = *slash;
129 if (!stat(path, &st)) {
131 if (!S_ISDIR(st.st_mode))
133 } else if (mkdir(path, 0777)) {
134 if (errno == EEXIST &&
135 !stat(path, &st) && S_ISDIR(st.st_mode))
136 ; /* somebody created it since we checked */
137 else if (errno == ENOENT)
139 * Either mkdir() failed because
140 * somebody just pruned the containing
141 * directory, or stat() failed because
142 * the file that was in our way was
143 * just removed. Either way, inform
144 * the caller that it might be worth
150 } else if (adjust_shared_perm(path)) {
153 *slash = slash_character;
158 enum scld_error safe_create_leading_directories_const(const char *path)
160 /* path points to cache entries, so xstrdup before messing with it */
161 char *buf = xstrdup(path);
162 enum scld_error result = safe_create_leading_directories(buf);
167 static void fill_sha1_path(struct strbuf *buf, const unsigned char *sha1)
170 for (i = 0; i < 20; i++) {
171 static char hex[] = "0123456789abcdef";
172 unsigned int val = sha1[i];
173 strbuf_addch(buf, hex[val >> 4]);
174 strbuf_addch(buf, hex[val & 0xf]);
176 strbuf_addch(buf, '/');
180 const char *sha1_file_name(const unsigned char *sha1)
182 static struct strbuf buf = STRBUF_INIT;
185 strbuf_addf(&buf, "%s/", get_object_directory());
187 fill_sha1_path(&buf, sha1);
191 struct strbuf *alt_scratch_buf(struct alternate_object_database *alt)
193 strbuf_setlen(&alt->scratch, alt->base_len);
194 return &alt->scratch;
197 static const char *alt_sha1_path(struct alternate_object_database *alt,
198 const unsigned char *sha1)
200 struct strbuf *buf = alt_scratch_buf(alt);
201 fill_sha1_path(buf, sha1);
206 * Return the name of the pack or index file with the specified sha1
207 * in its filename. *base and *name are scratch space that must be
208 * provided by the caller. which should be "pack" or "idx".
210 static char *sha1_get_pack_name(const unsigned char *sha1,
215 strbuf_addf(buf, "%s/pack/pack-%s.%s", get_object_directory(),
216 sha1_to_hex(sha1), which);
220 char *sha1_pack_name(const unsigned char *sha1)
222 static struct strbuf buf = STRBUF_INIT;
223 return sha1_get_pack_name(sha1, &buf, "pack");
226 char *sha1_pack_index_name(const unsigned char *sha1)
228 static struct strbuf buf = STRBUF_INIT;
229 return sha1_get_pack_name(sha1, &buf, "idx");
232 struct alternate_object_database *alt_odb_list;
233 static struct alternate_object_database **alt_odb_tail;
236 * Return non-zero iff the path is usable as an alternate object database.
238 static int alt_odb_usable(struct strbuf *path, const char *normalized_objdir)
240 struct alternate_object_database *alt;
242 /* Detect cases where alternate disappeared */
243 if (!is_directory(path->buf)) {
244 error("object directory %s does not exist; "
245 "check .git/objects/info/alternates.",
251 * Prevent the common mistake of listing the same
252 * thing twice, or object directory itself.
254 for (alt = alt_odb_list; alt; alt = alt->next) {
255 if (!fspathcmp(path->buf, alt->path))
258 if (!fspathcmp(path->buf, normalized_objdir))
265 * Prepare alternate object database registry.
267 * The variable alt_odb_list points at the list of struct
268 * alternate_object_database. The elements on this list come from
269 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
270 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
271 * whose contents is similar to that environment variable but can be
272 * LF separated. Its base points at a statically allocated buffer that
273 * contains "/the/directory/corresponding/to/.git/objects/...", while
274 * its name points just after the slash at the end of ".git/objects/"
275 * in the example above, and has enough space to hold 40-byte hex
276 * SHA1, an extra slash for the first level indirection, and the
279 static int link_alt_odb_entry(const char *entry, const char *relative_base,
280 int depth, const char *normalized_objdir)
282 struct alternate_object_database *ent;
283 struct strbuf pathbuf = STRBUF_INIT;
285 if (!is_absolute_path(entry) && relative_base) {
286 strbuf_addstr(&pathbuf, real_path(relative_base));
287 strbuf_addch(&pathbuf, '/');
289 strbuf_addstr(&pathbuf, entry);
291 if (strbuf_normalize_path(&pathbuf) < 0) {
292 error("unable to normalize alternate object path: %s",
294 strbuf_release(&pathbuf);
299 * The trailing slash after the directory name is given by
300 * this function at the end. Remove duplicates.
302 while (pathbuf.len && pathbuf.buf[pathbuf.len - 1] == '/')
303 strbuf_setlen(&pathbuf, pathbuf.len - 1);
305 if (!alt_odb_usable(&pathbuf, normalized_objdir)) {
306 strbuf_release(&pathbuf);
310 ent = alloc_alt_odb(pathbuf.buf);
312 /* add the alternate entry */
314 alt_odb_tail = &(ent->next);
317 /* recursively add alternates */
318 read_info_alternates(pathbuf.buf, depth + 1);
320 strbuf_release(&pathbuf);
324 static void link_alt_odb_entries(const char *alt, int len, int sep,
325 const char *relative_base, int depth)
327 struct string_list entries = STRING_LIST_INIT_NODUP;
330 struct strbuf objdirbuf = STRBUF_INIT;
333 error("%s: ignoring alternate object stores, nesting too deep.",
338 strbuf_add_absolute_path(&objdirbuf, get_object_directory());
339 if (strbuf_normalize_path(&objdirbuf) < 0)
340 die("unable to normalize object directory: %s",
343 alt_copy = xmemdupz(alt, len);
344 string_list_split_in_place(&entries, alt_copy, sep, -1);
345 for (i = 0; i < entries.nr; i++) {
346 const char *entry = entries.items[i].string;
347 if (entry[0] == '\0' || entry[0] == '#')
349 link_alt_odb_entry(entry, relative_base, depth, objdirbuf.buf);
351 string_list_clear(&entries, 0);
353 strbuf_release(&objdirbuf);
356 void read_info_alternates(const char * relative_base, int depth)
364 path = xstrfmt("%s/info/alternates", relative_base);
369 if (fstat(fd, &st) || (st.st_size == 0)) {
373 mapsz = xsize_t(st.st_size);
374 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
377 link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
382 struct alternate_object_database *alloc_alt_odb(const char *dir)
384 struct alternate_object_database *ent;
386 FLEX_ALLOC_STR(ent, path, dir);
387 strbuf_init(&ent->scratch, 0);
388 strbuf_addf(&ent->scratch, "%s/", dir);
389 ent->base_len = ent->scratch.len;
394 void add_to_alternates_file(const char *reference)
396 struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
397 char *alts = git_pathdup("objects/info/alternates");
400 hold_lock_file_for_update(lock, alts, LOCK_DIE_ON_ERROR);
401 out = fdopen_lock_file(lock, "w");
403 die_errno("unable to fdopen alternates lockfile");
405 in = fopen(alts, "r");
407 struct strbuf line = STRBUF_INIT;
410 while (strbuf_getline(&line, in) != EOF) {
411 if (!strcmp(reference, line.buf)) {
415 fprintf_or_die(out, "%s\n", line.buf);
418 strbuf_release(&line);
422 rollback_lock_file(lock);
426 else if (errno != ENOENT)
427 die_errno("unable to read alternates file");
430 fprintf_or_die(out, "%s\n", reference);
431 if (commit_lock_file(lock))
432 die_errno("unable to move new alternates file into place");
434 link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
439 void add_to_alternates_memory(const char *reference)
442 * Make sure alternates are initialized, or else our entry may be
443 * overwritten when they are.
447 link_alt_odb_entries(reference, strlen(reference), '\n', NULL, 0);
451 * Compute the exact path an alternate is at and returns it. In case of
452 * error NULL is returned and the human readable error is added to `err`
453 * `path` may be relative and should point to $GITDIR.
454 * `err` must not be null.
456 char *compute_alternate_path(const char *path, struct strbuf *err)
458 char *ref_git = NULL;
459 const char *repo, *ref_git_s;
462 ref_git_s = real_path_if_valid(path);
465 strbuf_addf(err, _("path '%s' does not exist"), path);
469 * Beware: read_gitfile(), real_path() and mkpath()
470 * return static buffer
472 ref_git = xstrdup(ref_git_s);
474 repo = read_gitfile(ref_git);
476 repo = read_gitfile(mkpath("%s/.git", ref_git));
479 ref_git = xstrdup(repo);
482 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
483 char *ref_git_git = mkpathdup("%s/.git", ref_git);
485 ref_git = ref_git_git;
486 } else if (!is_directory(mkpath("%s/objects", ref_git))) {
487 struct strbuf sb = STRBUF_INIT;
489 if (get_common_dir(&sb, ref_git)) {
491 _("reference repository '%s' as a linked "
492 "checkout is not supported yet."),
497 strbuf_addf(err, _("reference repository '%s' is not a "
498 "local repository."), path);
502 if (!access(mkpath("%s/shallow", ref_git), F_OK)) {
503 strbuf_addf(err, _("reference repository '%s' is shallow"),
509 if (!access(mkpath("%s/info/grafts", ref_git), F_OK)) {
511 _("reference repository '%s' is grafted"),
526 int foreach_alt_odb(alt_odb_fn fn, void *cb)
528 struct alternate_object_database *ent;
532 for (ent = alt_odb_list; ent; ent = ent->next) {
540 void prepare_alt_odb(void)
547 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
550 alt_odb_tail = &alt_odb_list;
551 link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
553 read_info_alternates(get_object_directory(), 0);
556 /* Returns 1 if we have successfully freshened the file, 0 otherwise. */
557 static int freshen_file(const char *fn)
560 t.actime = t.modtime = time(NULL);
561 return !utime(fn, &t);
565 * All of the check_and_freshen functions return 1 if the file exists and was
566 * freshened (if freshening was requested), 0 otherwise. If they return
567 * 0, you should not assume that it is safe to skip a write of the object (it
568 * either does not exist on disk, or has a stale mtime and may be subject to
571 static int check_and_freshen_file(const char *fn, int freshen)
573 if (access(fn, F_OK))
575 if (freshen && !freshen_file(fn))
580 static int check_and_freshen_local(const unsigned char *sha1, int freshen)
582 return check_and_freshen_file(sha1_file_name(sha1), freshen);
585 static int check_and_freshen_nonlocal(const unsigned char *sha1, int freshen)
587 struct alternate_object_database *alt;
589 for (alt = alt_odb_list; alt; alt = alt->next) {
590 const char *path = alt_sha1_path(alt, sha1);
591 if (check_and_freshen_file(path, freshen))
597 static int check_and_freshen(const unsigned char *sha1, int freshen)
599 return check_and_freshen_local(sha1, freshen) ||
600 check_and_freshen_nonlocal(sha1, freshen);
603 int has_loose_object_nonlocal(const unsigned char *sha1)
605 return check_and_freshen_nonlocal(sha1, 0);
608 static int has_loose_object(const unsigned char *sha1)
610 return check_and_freshen(sha1, 0);
613 static unsigned int pack_used_ctr;
614 static unsigned int pack_mmap_calls;
615 static unsigned int peak_pack_open_windows;
616 static unsigned int pack_open_windows;
617 static unsigned int pack_open_fds;
618 static unsigned int pack_max_fds;
619 static size_t peak_pack_mapped;
620 static size_t pack_mapped;
621 struct packed_git *packed_git;
623 static struct mru packed_git_mru_storage;
624 struct mru *packed_git_mru = &packed_git_mru_storage;
626 void pack_report(void)
629 "pack_report: getpagesize() = %10" SZ_FMT "\n"
630 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
631 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
632 sz_fmt(getpagesize()),
633 sz_fmt(packed_git_window_size),
634 sz_fmt(packed_git_limit));
636 "pack_report: pack_used_ctr = %10u\n"
637 "pack_report: pack_mmap_calls = %10u\n"
638 "pack_report: pack_open_windows = %10u / %10u\n"
639 "pack_report: pack_mapped = "
640 "%10" SZ_FMT " / %10" SZ_FMT "\n",
643 pack_open_windows, peak_pack_open_windows,
644 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
648 * Open and mmap the index file at path, perform a couple of
649 * consistency checks, then record its information to p. Return 0 on
652 static int check_packed_git_idx(const char *path, struct packed_git *p)
655 struct pack_idx_header *hdr;
657 uint32_t version, nr, i, *index;
658 int fd = git_open(path);
663 if (fstat(fd, &st)) {
667 idx_size = xsize_t(st.st_size);
668 if (idx_size < 4 * 256 + 20 + 20) {
670 return error("index file %s is too small", path);
672 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
676 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
677 version = ntohl(hdr->idx_version);
678 if (version < 2 || version > 2) {
679 munmap(idx_map, idx_size);
680 return error("index file %s is version %"PRIu32
681 " and is not supported by this binary"
682 " (try upgrading GIT to a newer version)",
691 index += 2; /* skip index header */
692 for (i = 0; i < 256; i++) {
693 uint32_t n = ntohl(index[i]);
695 munmap(idx_map, idx_size);
696 return error("non-monotonic index %s", path);
704 * - 256 index entries 4 bytes each
705 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
706 * - 20-byte SHA1 of the packfile
707 * - 20-byte SHA1 file checksum
709 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
710 munmap(idx_map, idx_size);
711 return error("wrong index v1 file size in %s", path);
713 } else if (version == 2) {
716 * - 8 bytes of header
717 * - 256 index entries 4 bytes each
718 * - 20-byte sha1 entry * nr
719 * - 4-byte crc entry * nr
720 * - 4-byte offset entry * nr
721 * - 20-byte SHA1 of the packfile
722 * - 20-byte SHA1 file checksum
723 * And after the 4-byte offset table might be a
724 * variable sized table containing 8-byte entries
725 * for offsets larger than 2^31.
727 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
728 unsigned long max_size = min_size;
730 max_size += (nr - 1)*8;
731 if (idx_size < min_size || idx_size > max_size) {
732 munmap(idx_map, idx_size);
733 return error("wrong index v2 file size in %s", path);
735 if (idx_size != min_size &&
737 * make sure we can deal with large pack offsets.
738 * 31-bit signed offset won't be enough, neither
739 * 32-bit unsigned one will be.
741 (sizeof(off_t) <= 4)) {
742 munmap(idx_map, idx_size);
743 return error("pack too large for current definition of off_t in %s", path);
747 p->index_version = version;
748 p->index_data = idx_map;
749 p->index_size = idx_size;
754 int open_pack_index(struct packed_git *p)
763 if (!strip_suffix(p->pack_name, ".pack", &len))
764 die("BUG: pack_name does not end in .pack");
765 idx_name = xstrfmt("%.*s.idx", (int)len, p->pack_name);
766 ret = check_packed_git_idx(idx_name, p);
771 static void scan_windows(struct packed_git *p,
772 struct packed_git **lru_p,
773 struct pack_window **lru_w,
774 struct pack_window **lru_l)
776 struct pack_window *w, *w_l;
778 for (w_l = NULL, w = p->windows; w; w = w->next) {
780 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
790 static int unuse_one_window(struct packed_git *current)
792 struct packed_git *p, *lru_p = NULL;
793 struct pack_window *lru_w = NULL, *lru_l = NULL;
796 scan_windows(current, &lru_p, &lru_w, &lru_l);
797 for (p = packed_git; p; p = p->next)
798 scan_windows(p, &lru_p, &lru_w, &lru_l);
800 munmap(lru_w->base, lru_w->len);
801 pack_mapped -= lru_w->len;
803 lru_l->next = lru_w->next;
805 lru_p->windows = lru_w->next;
813 void release_pack_memory(size_t need)
815 size_t cur = pack_mapped;
816 while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
820 static void mmap_limit_check(size_t length)
822 static size_t limit = 0;
824 limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
829 die("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX,
830 (uintmax_t)length, (uintmax_t)limit);
833 void *xmmap_gently(void *start, size_t length,
834 int prot, int flags, int fd, off_t offset)
838 mmap_limit_check(length);
839 ret = mmap(start, length, prot, flags, fd, offset);
840 if (ret == MAP_FAILED) {
843 release_pack_memory(length);
844 ret = mmap(start, length, prot, flags, fd, offset);
849 void *xmmap(void *start, size_t length,
850 int prot, int flags, int fd, off_t offset)
852 void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
853 if (ret == MAP_FAILED)
854 die_errno("mmap failed");
858 void close_pack_windows(struct packed_git *p)
861 struct pack_window *w = p->windows;
864 die("pack '%s' still has open windows to it",
866 munmap(w->base, w->len);
867 pack_mapped -= w->len;
869 p->windows = w->next;
874 static int close_pack_fd(struct packed_git *p)
886 static void close_pack(struct packed_git *p)
888 close_pack_windows(p);
893 void close_all_packs(void)
895 struct packed_git *p;
897 for (p = packed_git; p; p = p->next)
899 die("BUG: want to close pack marked 'do-not-close'");
906 * The LRU pack is the one with the oldest MRU window, preferring packs
907 * with no used windows, or the oldest mtime if it has no windows allocated.
909 static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
911 struct pack_window *w, *this_mru_w;
912 int has_windows_inuse = 0;
915 * Reject this pack if it has windows and the previously selected
916 * one does not. If this pack does not have windows, reject
917 * it if the pack file is newer than the previously selected one.
919 if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
922 for (w = this_mru_w = p->windows; w; w = w->next) {
924 * Reject this pack if any of its windows are in use,
925 * but the previously selected pack did not have any
926 * inuse windows. Otherwise, record that this pack
927 * has windows in use.
930 if (*accept_windows_inuse)
931 has_windows_inuse = 1;
936 if (w->last_used > this_mru_w->last_used)
940 * Reject this pack if it has windows that have been
941 * used more recently than the previously selected pack.
942 * If the previously selected pack had windows inuse and
943 * we have not encountered a window in this pack that is
944 * inuse, skip this check since we prefer a pack with no
945 * inuse windows to one that has inuse windows.
947 if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
948 this_mru_w->last_used > (*mru_w)->last_used)
957 *accept_windows_inuse = has_windows_inuse;
960 static int close_one_pack(void)
962 struct packed_git *p, *lru_p = NULL;
963 struct pack_window *mru_w = NULL;
964 int accept_windows_inuse = 1;
966 for (p = packed_git; p; p = p->next) {
967 if (p->pack_fd == -1)
969 find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
973 return close_pack_fd(lru_p);
978 void unuse_pack(struct pack_window **w_cursor)
980 struct pack_window *w = *w_cursor;
987 void close_pack_index(struct packed_git *p)
990 munmap((void *)p->index_data, p->index_size);
991 p->index_data = NULL;
995 static unsigned int get_max_fd_limit(void)
1001 if (!getrlimit(RLIMIT_NOFILE, &lim))
1002 return lim.rlim_cur;
1008 long open_max = sysconf(_SC_OPEN_MAX);
1012 * Otherwise, we got -1 for one of the two
1015 * (1) sysconf() did not understand _SC_OPEN_MAX
1016 * and signaled an error with -1; or
1017 * (2) sysconf() said there is no limit.
1019 * We _could_ clear errno before calling sysconf() to
1020 * tell these two cases apart and return a huge number
1021 * in the latter case to let the caller cap it to a
1022 * value that is not so selfish, but letting the
1023 * fallback OPEN_MAX codepath take care of these cases
1032 return 1; /* see the caller ;-) */
1037 * Do not call this directly as this leaks p->pack_fd on error return;
1038 * call open_packed_git() instead.
1040 static int open_packed_git_1(struct packed_git *p)
1043 struct pack_header hdr;
1044 unsigned char sha1[20];
1045 unsigned char *idx_sha1;
1048 if (!p->index_data && open_pack_index(p))
1049 return error("packfile %s index unavailable", p->pack_name);
1051 if (!pack_max_fds) {
1052 unsigned int max_fds = get_max_fd_limit();
1054 /* Save 3 for stdin/stdout/stderr, 22 for work */
1056 pack_max_fds = max_fds - 25;
1061 while (pack_max_fds <= pack_open_fds && close_one_pack())
1064 p->pack_fd = git_open(p->pack_name);
1065 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
1069 /* If we created the struct before we had the pack we lack size. */
1070 if (!p->pack_size) {
1071 if (!S_ISREG(st.st_mode))
1072 return error("packfile %s not a regular file", p->pack_name);
1073 p->pack_size = st.st_size;
1074 } else if (p->pack_size != st.st_size)
1075 return error("packfile %s size changed", p->pack_name);
1077 /* We leave these file descriptors open with sliding mmap;
1078 * there is no point keeping them open across exec(), though.
1080 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
1082 return error("cannot determine file descriptor flags");
1083 fd_flag |= FD_CLOEXEC;
1084 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
1085 return error("cannot set FD_CLOEXEC");
1087 /* Verify we recognize this pack file format. */
1088 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
1089 return error("file %s is far too short to be a packfile", p->pack_name);
1090 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
1091 return error("file %s is not a GIT packfile", p->pack_name);
1092 if (!pack_version_ok(hdr.hdr_version))
1093 return error("packfile %s is version %"PRIu32" and not"
1094 " supported (try upgrading GIT to a newer version)",
1095 p->pack_name, ntohl(hdr.hdr_version));
1097 /* Verify the pack matches its index. */
1098 if (p->num_objects != ntohl(hdr.hdr_entries))
1099 return error("packfile %s claims to have %"PRIu32" objects"
1100 " while index indicates %"PRIu32" objects",
1101 p->pack_name, ntohl(hdr.hdr_entries),
1103 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
1104 return error("end of packfile %s is unavailable", p->pack_name);
1105 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
1106 return error("packfile %s signature is unavailable", p->pack_name);
1107 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
1108 if (hashcmp(sha1, idx_sha1))
1109 return error("packfile %s does not match index", p->pack_name);
1113 static int open_packed_git(struct packed_git *p)
1115 if (!open_packed_git_1(p))
1121 static int in_window(struct pack_window *win, off_t offset)
1123 /* We must promise at least 20 bytes (one hash) after the
1124 * offset is available from this window, otherwise the offset
1125 * is not actually in this window and a different window (which
1126 * has that one hash excess) must be used. This is to support
1127 * the object header and delta base parsing routines below.
1129 off_t win_off = win->offset;
1130 return win_off <= offset
1131 && (offset + 20) <= (win_off + win->len);
1134 unsigned char *use_pack(struct packed_git *p,
1135 struct pack_window **w_cursor,
1137 unsigned long *left)
1139 struct pack_window *win = *w_cursor;
1141 /* Since packfiles end in a hash of their content and it's
1142 * pointless to ask for an offset into the middle of that
1143 * hash, and the in_window function above wouldn't match
1144 * don't allow an offset too close to the end of the file.
1146 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
1147 die("packfile %s cannot be accessed", p->pack_name);
1148 if (offset > (p->pack_size - 20))
1149 die("offset beyond end of packfile (truncated pack?)");
1151 die(_("offset before end of packfile (broken .idx?)"));
1153 if (!win || !in_window(win, offset)) {
1156 for (win = p->windows; win; win = win->next) {
1157 if (in_window(win, offset))
1161 size_t window_align = packed_git_window_size / 2;
1164 if (p->pack_fd == -1 && open_packed_git(p))
1165 die("packfile %s cannot be accessed", p->pack_name);
1167 win = xcalloc(1, sizeof(*win));
1168 win->offset = (offset / window_align) * window_align;
1169 len = p->pack_size - win->offset;
1170 if (len > packed_git_window_size)
1171 len = packed_git_window_size;
1172 win->len = (size_t)len;
1173 pack_mapped += win->len;
1174 while (packed_git_limit < pack_mapped
1175 && unuse_one_window(p))
1177 win->base = xmmap(NULL, win->len,
1178 PROT_READ, MAP_PRIVATE,
1179 p->pack_fd, win->offset);
1180 if (win->base == MAP_FAILED)
1181 die_errno("packfile %s cannot be mapped",
1183 if (!win->offset && win->len == p->pack_size
1184 && !p->do_not_close)
1187 pack_open_windows++;
1188 if (pack_mapped > peak_pack_mapped)
1189 peak_pack_mapped = pack_mapped;
1190 if (pack_open_windows > peak_pack_open_windows)
1191 peak_pack_open_windows = pack_open_windows;
1192 win->next = p->windows;
1196 if (win != *w_cursor) {
1197 win->last_used = pack_used_ctr++;
1201 offset -= win->offset;
1203 *left = win->len - xsize_t(offset);
1204 return win->base + offset;
1207 static struct packed_git *alloc_packed_git(int extra)
1209 struct packed_git *p = xmalloc(st_add(sizeof(*p), extra));
1210 memset(p, 0, sizeof(*p));
1215 static void try_to_free_pack_memory(size_t size)
1217 release_pack_memory(size);
1220 struct packed_git *add_packed_git(const char *path, size_t path_len, int local)
1222 static int have_set_try_to_free_routine;
1225 struct packed_git *p;
1227 if (!have_set_try_to_free_routine) {
1228 have_set_try_to_free_routine = 1;
1229 set_try_to_free_routine(try_to_free_pack_memory);
1233 * Make sure a corresponding .pack file exists and that
1234 * the index looks sane.
1236 if (!strip_suffix_mem(path, &path_len, ".idx"))
1240 * ".pack" is long enough to hold any suffix we're adding (and
1241 * the use xsnprintf double-checks that)
1243 alloc = st_add3(path_len, strlen(".pack"), 1);
1244 p = alloc_packed_git(alloc);
1245 memcpy(p->pack_name, path, path_len);
1247 xsnprintf(p->pack_name + path_len, alloc - path_len, ".keep");
1248 if (!access(p->pack_name, F_OK))
1251 xsnprintf(p->pack_name + path_len, alloc - path_len, ".pack");
1252 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
1257 /* ok, it looks sane as far as we can check without
1258 * actually mapping the pack file.
1260 p->pack_size = st.st_size;
1261 p->pack_local = local;
1262 p->mtime = st.st_mtime;
1263 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
1268 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
1270 const char *path = sha1_pack_name(sha1);
1271 size_t alloc = st_add(strlen(path), 1);
1272 struct packed_git *p = alloc_packed_git(alloc);
1274 memcpy(p->pack_name, path, alloc); /* includes NUL */
1275 hashcpy(p->sha1, sha1);
1276 if (check_packed_git_idx(idx_path, p)) {
1284 void install_packed_git(struct packed_git *pack)
1286 if (pack->pack_fd != -1)
1289 pack->next = packed_git;
1293 void (*report_garbage)(unsigned seen_bits, const char *path);
1295 static void report_helper(const struct string_list *list,
1296 int seen_bits, int first, int last)
1298 if (seen_bits == (PACKDIR_FILE_PACK|PACKDIR_FILE_IDX))
1301 for (; first < last; first++)
1302 report_garbage(seen_bits, list->items[first].string);
1305 static void report_pack_garbage(struct string_list *list)
1307 int i, baselen = -1, first = 0, seen_bits = 0;
1309 if (!report_garbage)
1312 string_list_sort(list);
1314 for (i = 0; i < list->nr; i++) {
1315 const char *path = list->items[i].string;
1316 if (baselen != -1 &&
1317 strncmp(path, list->items[first].string, baselen)) {
1318 report_helper(list, seen_bits, first, i);
1322 if (baselen == -1) {
1323 const char *dot = strrchr(path, '.');
1325 report_garbage(PACKDIR_FILE_GARBAGE, path);
1328 baselen = dot - path + 1;
1331 if (!strcmp(path + baselen, "pack"))
1333 else if (!strcmp(path + baselen, "idx"))
1336 report_helper(list, seen_bits, first, list->nr);
1339 static void prepare_packed_git_one(char *objdir, int local)
1341 struct strbuf path = STRBUF_INIT;
1345 struct string_list garbage = STRING_LIST_INIT_DUP;
1347 strbuf_addstr(&path, objdir);
1348 strbuf_addstr(&path, "/pack");
1349 dir = opendir(path.buf);
1351 if (errno != ENOENT)
1352 error_errno("unable to open object pack directory: %s",
1354 strbuf_release(&path);
1357 strbuf_addch(&path, '/');
1358 dirnamelen = path.len;
1359 while ((de = readdir(dir)) != NULL) {
1360 struct packed_git *p;
1363 if (is_dot_or_dotdot(de->d_name))
1366 strbuf_setlen(&path, dirnamelen);
1367 strbuf_addstr(&path, de->d_name);
1369 base_len = path.len;
1370 if (strip_suffix_mem(path.buf, &base_len, ".idx")) {
1371 /* Don't reopen a pack we already have. */
1372 for (p = packed_git; p; p = p->next) {
1374 if (strip_suffix(p->pack_name, ".pack", &len) &&
1376 !memcmp(p->pack_name, path.buf, len))
1381 * See if it really is a valid .idx file with
1382 * corresponding .pack file that we can map.
1384 (p = add_packed_git(path.buf, path.len, local)) != NULL)
1385 install_packed_git(p);
1388 if (!report_garbage)
1391 if (ends_with(de->d_name, ".idx") ||
1392 ends_with(de->d_name, ".pack") ||
1393 ends_with(de->d_name, ".bitmap") ||
1394 ends_with(de->d_name, ".keep"))
1395 string_list_append(&garbage, path.buf);
1397 report_garbage(PACKDIR_FILE_GARBAGE, path.buf);
1400 report_pack_garbage(&garbage);
1401 string_list_clear(&garbage, 0);
1402 strbuf_release(&path);
1405 static void *get_next_packed_git(const void *p)
1407 return ((const struct packed_git *)p)->next;
1410 static void set_next_packed_git(void *p, void *next)
1412 ((struct packed_git *)p)->next = next;
1415 static int sort_pack(const void *a_, const void *b_)
1417 const struct packed_git *a = a_;
1418 const struct packed_git *b = b_;
1422 * Local packs tend to contain objects specific to our
1423 * variant of the project than remote ones. In addition,
1424 * remote ones could be on a network mounted filesystem.
1425 * Favor local ones for these reasons.
1427 st = a->pack_local - b->pack_local;
1432 * Younger packs tend to contain more recent objects,
1433 * and more recent objects tend to get accessed more
1436 if (a->mtime < b->mtime)
1438 else if (a->mtime == b->mtime)
1443 static void rearrange_packed_git(void)
1445 packed_git = llist_mergesort(packed_git, get_next_packed_git,
1446 set_next_packed_git, sort_pack);
1449 static void prepare_packed_git_mru(void)
1451 struct packed_git *p;
1453 mru_clear(packed_git_mru);
1454 for (p = packed_git; p; p = p->next)
1455 mru_append(packed_git_mru, p);
1458 static int prepare_packed_git_run_once = 0;
1459 void prepare_packed_git(void)
1461 struct alternate_object_database *alt;
1463 if (prepare_packed_git_run_once)
1465 prepare_packed_git_one(get_object_directory(), 1);
1467 for (alt = alt_odb_list; alt; alt = alt->next)
1468 prepare_packed_git_one(alt->path, 0);
1469 rearrange_packed_git();
1470 prepare_packed_git_mru();
1471 prepare_packed_git_run_once = 1;
1474 void reprepare_packed_git(void)
1476 prepare_packed_git_run_once = 0;
1477 prepare_packed_git();
1480 static void mark_bad_packed_object(struct packed_git *p,
1481 const unsigned char *sha1)
1484 for (i = 0; i < p->num_bad_objects; i++)
1485 if (!hashcmp(sha1, p->bad_object_sha1 + GIT_SHA1_RAWSZ * i))
1487 p->bad_object_sha1 = xrealloc(p->bad_object_sha1,
1488 st_mult(GIT_SHA1_RAWSZ,
1489 st_add(p->num_bad_objects, 1)));
1490 hashcpy(p->bad_object_sha1 + GIT_SHA1_RAWSZ * p->num_bad_objects, sha1);
1491 p->num_bad_objects++;
1494 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1496 struct packed_git *p;
1499 for (p = packed_git; p; p = p->next)
1500 for (i = 0; i < p->num_bad_objects; i++)
1501 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1507 * With an in-core object data in "map", rehash it to make sure the
1508 * object name actually matches "sha1" to detect object corruption.
1509 * With "map" == NULL, try reading the object named with "sha1" using
1510 * the streaming interface and rehash it to do the same.
1512 int check_sha1_signature(const unsigned char *sha1, void *map,
1513 unsigned long size, const char *type)
1515 unsigned char real_sha1[20];
1516 enum object_type obj_type;
1517 struct git_istream *st;
1523 hash_sha1_file(map, size, type, real_sha1);
1524 return hashcmp(sha1, real_sha1) ? -1 : 0;
1527 st = open_istream(sha1, &obj_type, &size, NULL);
1531 /* Generate the header */
1532 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(obj_type), size) + 1;
1536 git_SHA1_Update(&c, hdr, hdrlen);
1538 char buf[1024 * 16];
1539 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1547 git_SHA1_Update(&c, buf, readlen);
1549 git_SHA1_Final(real_sha1, &c);
1551 return hashcmp(sha1, real_sha1) ? -1 : 0;
1554 int git_open_cloexec(const char *name, int flags)
1557 static int o_cloexec = O_CLOEXEC;
1559 fd = open(name, flags | o_cloexec);
1560 if ((o_cloexec & O_CLOEXEC) && fd < 0 && errno == EINVAL) {
1561 /* Try again w/o O_CLOEXEC: the kernel might not support it */
1562 o_cloexec &= ~O_CLOEXEC;
1563 fd = open(name, flags | o_cloexec);
1566 #if defined(F_GETFL) && defined(F_SETFL) && defined(FD_CLOEXEC)
1568 static int fd_cloexec = FD_CLOEXEC;
1570 if (!o_cloexec && 0 <= fd && fd_cloexec) {
1571 /* Opened w/o O_CLOEXEC? try with fcntl(2) to add it */
1572 int flags = fcntl(fd, F_GETFL);
1573 if (fcntl(fd, F_SETFL, flags | fd_cloexec))
1581 static int stat_sha1_file(const unsigned char *sha1, struct stat *st)
1583 struct alternate_object_database *alt;
1585 if (!lstat(sha1_file_name(sha1), st))
1590 for (alt = alt_odb_list; alt; alt = alt->next) {
1591 const char *path = alt_sha1_path(alt, sha1);
1592 if (!lstat(path, st))
1599 static int open_sha1_file(const unsigned char *sha1)
1602 struct alternate_object_database *alt;
1603 int most_interesting_errno;
1605 fd = git_open(sha1_file_name(sha1));
1608 most_interesting_errno = errno;
1611 for (alt = alt_odb_list; alt; alt = alt->next) {
1612 const char *path = alt_sha1_path(alt, sha1);
1613 fd = git_open(path);
1616 if (most_interesting_errno == ENOENT)
1617 most_interesting_errno = errno;
1619 errno = most_interesting_errno;
1623 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1628 fd = open_sha1_file(sha1);
1633 if (!fstat(fd, &st)) {
1634 *size = xsize_t(st.st_size);
1636 /* mmap() is forbidden on empty files */
1637 error("object file %s is empty", sha1_file_name(sha1));
1640 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1647 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1648 unsigned long len, enum object_type *type, unsigned long *sizep)
1651 unsigned long size, c;
1652 unsigned long used = 0;
1655 *type = (c >> 4) & 7;
1659 if (len <= used || bitsizeof(long) <= shift) {
1660 error("bad object header");
1665 size += (c & 0x7f) << shift;
1672 static int unpack_sha1_short_header(git_zstream *stream,
1673 unsigned char *map, unsigned long mapsize,
1674 void *buffer, unsigned long bufsiz)
1676 /* Get the data stream */
1677 memset(stream, 0, sizeof(*stream));
1678 stream->next_in = map;
1679 stream->avail_in = mapsize;
1680 stream->next_out = buffer;
1681 stream->avail_out = bufsiz;
1683 git_inflate_init(stream);
1684 return git_inflate(stream, 0);
1687 int unpack_sha1_header(git_zstream *stream,
1688 unsigned char *map, unsigned long mapsize,
1689 void *buffer, unsigned long bufsiz)
1691 int status = unpack_sha1_short_header(stream, map, mapsize,
1697 /* Make sure we have the terminating NUL */
1698 if (!memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1703 static int unpack_sha1_header_to_strbuf(git_zstream *stream, unsigned char *map,
1704 unsigned long mapsize, void *buffer,
1705 unsigned long bufsiz, struct strbuf *header)
1709 status = unpack_sha1_short_header(stream, map, mapsize, buffer, bufsiz);
1714 * Check if entire header is unpacked in the first iteration.
1716 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1720 * buffer[0..bufsiz] was not large enough. Copy the partial
1721 * result out to header, and then append the result of further
1722 * reading the stream.
1724 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1725 stream->next_out = buffer;
1726 stream->avail_out = bufsiz;
1729 status = git_inflate(stream, 0);
1730 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1731 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1733 stream->next_out = buffer;
1734 stream->avail_out = bufsiz;
1735 } while (status != Z_STREAM_END);
1739 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1741 int bytes = strlen(buffer) + 1;
1742 unsigned char *buf = xmallocz(size);
1746 n = stream->total_out - bytes;
1749 memcpy(buf, (char *) buffer + bytes, n);
1751 if (bytes <= size) {
1753 * The above condition must be (bytes <= size), not
1754 * (bytes < size). In other words, even though we
1755 * expect no more output and set avail_out to zero,
1756 * the input zlib stream may have bytes that express
1757 * "this concludes the stream", and we *do* want to
1760 * Otherwise we would not be able to test that we
1761 * consumed all the input to reach the expected size;
1762 * we also want to check that zlib tells us that all
1763 * went well with status == Z_STREAM_END at the end.
1765 stream->next_out = buf + bytes;
1766 stream->avail_out = size - bytes;
1767 while (status == Z_OK)
1768 status = git_inflate(stream, Z_FINISH);
1770 if (status == Z_STREAM_END && !stream->avail_in) {
1771 git_inflate_end(stream);
1776 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1777 else if (stream->avail_in)
1778 error("garbage at end of loose object '%s'",
1785 * We used to just use "sscanf()", but that's actually way
1786 * too permissive for what we want to check. So do an anal
1787 * object header parse by hand.
1789 static int parse_sha1_header_extended(const char *hdr, struct object_info *oi,
1792 const char *type_buf = hdr;
1794 int type, type_len = 0;
1797 * The type can be of any size but is followed by
1809 type = type_from_string_gently(type_buf, type_len, 1);
1811 strbuf_add(oi->typename, type_buf, type_len);
1813 * Set type to 0 if its an unknown object and
1814 * we're obtaining the type using '--allow-unknown-type'
1817 if ((flags & LOOKUP_UNKNOWN_OBJECT) && (type < 0))
1820 die("invalid object type");
1825 * The length must follow immediately, and be in canonical
1826 * decimal format (ie "010" is not valid).
1828 size = *hdr++ - '0';
1833 unsigned long c = *hdr - '0';
1837 size = size * 10 + c;
1845 * The length must be followed by a zero byte
1847 return *hdr ? -1 : type;
1850 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1852 struct object_info oi = OBJECT_INFO_INIT;
1855 return parse_sha1_header_extended(hdr, &oi, LOOKUP_REPLACE_OBJECT);
1858 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1864 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1865 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1868 return unpack_sha1_rest(&stream, hdr, *size, sha1);
1871 unsigned long get_size_from_delta(struct packed_git *p,
1872 struct pack_window **w_curs,
1875 const unsigned char *data;
1876 unsigned char delta_head[20], *in;
1880 memset(&stream, 0, sizeof(stream));
1881 stream.next_out = delta_head;
1882 stream.avail_out = sizeof(delta_head);
1884 git_inflate_init(&stream);
1886 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1887 stream.next_in = in;
1888 st = git_inflate(&stream, Z_FINISH);
1889 curpos += stream.next_in - in;
1890 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1891 stream.total_out < sizeof(delta_head));
1892 git_inflate_end(&stream);
1893 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1894 error("delta data unpack-initial failed");
1898 /* Examine the initial part of the delta to figure out
1903 /* ignore base size */
1904 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1906 /* Read the result size */
1907 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1910 static off_t get_delta_base(struct packed_git *p,
1911 struct pack_window **w_curs,
1913 enum object_type type,
1914 off_t delta_obj_offset)
1916 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1919 /* use_pack() assured us we have [base_info, base_info + 20)
1920 * as a range that we can look at without walking off the
1921 * end of the mapped window. Its actually the hash size
1922 * that is assured. An OFS_DELTA longer than the hash size
1923 * is stupid, as then a REF_DELTA would be smaller to store.
1925 if (type == OBJ_OFS_DELTA) {
1927 unsigned char c = base_info[used++];
1928 base_offset = c & 127;
1931 if (!base_offset || MSB(base_offset, 7))
1932 return 0; /* overflow */
1933 c = base_info[used++];
1934 base_offset = (base_offset << 7) + (c & 127);
1936 base_offset = delta_obj_offset - base_offset;
1937 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1938 return 0; /* out of bound */
1940 } else if (type == OBJ_REF_DELTA) {
1941 /* The base entry _must_ be in the same pack */
1942 base_offset = find_pack_entry_one(base_info, p);
1945 die("I am totally screwed");
1950 * Like get_delta_base above, but we return the sha1 instead of the pack
1951 * offset. This means it is cheaper for REF deltas (we do not have to do
1952 * the final object lookup), but more expensive for OFS deltas (we
1953 * have to load the revidx to convert the offset back into a sha1).
1955 static const unsigned char *get_delta_base_sha1(struct packed_git *p,
1956 struct pack_window **w_curs,
1958 enum object_type type,
1959 off_t delta_obj_offset)
1961 if (type == OBJ_REF_DELTA) {
1962 unsigned char *base = use_pack(p, w_curs, curpos, NULL);
1964 } else if (type == OBJ_OFS_DELTA) {
1965 struct revindex_entry *revidx;
1966 off_t base_offset = get_delta_base(p, w_curs, &curpos,
1967 type, delta_obj_offset);
1972 revidx = find_pack_revindex(p, base_offset);
1976 return nth_packed_object_sha1(p, revidx->nr);
1981 int unpack_object_header(struct packed_git *p,
1982 struct pack_window **w_curs,
1984 unsigned long *sizep)
1986 unsigned char *base;
1989 enum object_type type;
1991 /* use_pack() assures us we have [base, base + 20) available
1992 * as a range that we can look at. (Its actually the hash
1993 * size that is assured.) With our object header encoding
1994 * the maximum deflated object size is 2^137, which is just
1995 * insane, so we know won't exceed what we have been given.
1997 base = use_pack(p, w_curs, *curpos, &left);
1998 used = unpack_object_header_buffer(base, left, &type, sizep);
2007 static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
2010 struct revindex_entry *revidx;
2011 const unsigned char *sha1;
2012 revidx = find_pack_revindex(p, obj_offset);
2015 sha1 = nth_packed_object_sha1(p, revidx->nr);
2016 mark_bad_packed_object(p, sha1);
2017 type = sha1_object_info(sha1, NULL);
2018 if (type <= OBJ_NONE)
2023 #define POI_STACK_PREALLOC 64
2025 static enum object_type packed_to_object_type(struct packed_git *p,
2027 enum object_type type,
2028 struct pack_window **w_curs,
2031 off_t small_poi_stack[POI_STACK_PREALLOC];
2032 off_t *poi_stack = small_poi_stack;
2033 int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
2035 while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2038 /* Push the object we're going to leave behind */
2039 if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
2040 poi_stack_alloc = alloc_nr(poi_stack_nr);
2041 ALLOC_ARRAY(poi_stack, poi_stack_alloc);
2042 memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
2044 ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
2046 poi_stack[poi_stack_nr++] = obj_offset;
2047 /* If parsing the base offset fails, just unwind */
2048 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
2051 curpos = obj_offset = base_offset;
2052 type = unpack_object_header(p, w_curs, &curpos, &size);
2053 if (type <= OBJ_NONE) {
2054 /* If getting the base itself fails, we first
2055 * retry the base, otherwise unwind */
2056 type = retry_bad_packed_offset(p, base_offset);
2057 if (type > OBJ_NONE)
2071 error("unknown object type %i at offset %"PRIuMAX" in %s",
2072 type, (uintmax_t)obj_offset, p->pack_name);
2077 if (poi_stack != small_poi_stack)
2082 while (poi_stack_nr) {
2083 obj_offset = poi_stack[--poi_stack_nr];
2084 type = retry_bad_packed_offset(p, obj_offset);
2085 if (type > OBJ_NONE)
2092 int packed_object_info(struct packed_git *p, off_t obj_offset,
2093 struct object_info *oi)
2095 struct pack_window *w_curs = NULL;
2097 off_t curpos = obj_offset;
2098 enum object_type type;
2101 * We always get the representation type, but only convert it to
2102 * a "real" type later if the caller is interested.
2104 type = unpack_object_header(p, &w_curs, &curpos, &size);
2107 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2108 off_t tmp_pos = curpos;
2109 off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
2115 *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
2116 if (*oi->sizep == 0) {
2125 if (oi->disk_sizep) {
2126 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2127 *oi->disk_sizep = revidx[1].offset - obj_offset;
2131 *oi->typep = packed_to_object_type(p, obj_offset, type, &w_curs, curpos);
2132 if (*oi->typep < 0) {
2138 if (oi->delta_base_sha1) {
2139 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2140 const unsigned char *base;
2142 base = get_delta_base_sha1(p, &w_curs, curpos,
2149 hashcpy(oi->delta_base_sha1, base);
2151 hashclr(oi->delta_base_sha1);
2155 unuse_pack(&w_curs);
2159 static void *unpack_compressed_entry(struct packed_git *p,
2160 struct pack_window **w_curs,
2166 unsigned char *buffer, *in;
2168 buffer = xmallocz_gently(size);
2171 memset(&stream, 0, sizeof(stream));
2172 stream.next_out = buffer;
2173 stream.avail_out = size + 1;
2175 git_inflate_init(&stream);
2177 in = use_pack(p, w_curs, curpos, &stream.avail_in);
2178 stream.next_in = in;
2179 st = git_inflate(&stream, Z_FINISH);
2180 if (!stream.avail_out)
2181 break; /* the payload is larger than it should be */
2182 curpos += stream.next_in - in;
2183 } while (st == Z_OK || st == Z_BUF_ERROR);
2184 git_inflate_end(&stream);
2185 if ((st != Z_STREAM_END) || stream.total_out != size) {
2193 static struct hashmap delta_base_cache;
2194 static size_t delta_base_cached;
2196 static LIST_HEAD(delta_base_cache_lru);
2198 struct delta_base_cache_key {
2199 struct packed_git *p;
2203 struct delta_base_cache_entry {
2204 struct hashmap hash;
2205 struct delta_base_cache_key key;
2206 struct list_head lru;
2209 enum object_type type;
2212 static unsigned int pack_entry_hash(struct packed_git *p, off_t base_offset)
2216 hash = (unsigned int)(intptr_t)p + (unsigned int)base_offset;
2217 hash += (hash >> 8) + (hash >> 16);
2221 static struct delta_base_cache_entry *
2222 get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
2224 struct hashmap_entry entry;
2225 struct delta_base_cache_key key;
2227 if (!delta_base_cache.cmpfn)
2230 hashmap_entry_init(&entry, pack_entry_hash(p, base_offset));
2232 key.base_offset = base_offset;
2233 return hashmap_get(&delta_base_cache, &entry, &key);
2236 static int delta_base_cache_key_eq(const struct delta_base_cache_key *a,
2237 const struct delta_base_cache_key *b)
2239 return a->p == b->p && a->base_offset == b->base_offset;
2242 static int delta_base_cache_hash_cmp(const void *va, const void *vb,
2245 const struct delta_base_cache_entry *a = va, *b = vb;
2246 const struct delta_base_cache_key *key = vkey;
2248 return !delta_base_cache_key_eq(&a->key, key);
2250 return !delta_base_cache_key_eq(&a->key, &b->key);
2253 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
2255 return !!get_delta_base_cache_entry(p, base_offset);
2259 * Remove the entry from the cache, but do _not_ free the associated
2260 * entry data. The caller takes ownership of the "data" buffer, and
2261 * should copy out any fields it wants before detaching.
2263 static void detach_delta_base_cache_entry(struct delta_base_cache_entry *ent)
2265 hashmap_remove(&delta_base_cache, ent, &ent->key);
2266 list_del(&ent->lru);
2267 delta_base_cached -= ent->size;
2271 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
2272 unsigned long *base_size, enum object_type *type)
2274 struct delta_base_cache_entry *ent;
2276 ent = get_delta_base_cache_entry(p, base_offset);
2278 return unpack_entry(p, base_offset, type, base_size);
2281 *base_size = ent->size;
2282 return xmemdupz(ent->data, ent->size);
2285 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
2288 detach_delta_base_cache_entry(ent);
2291 void clear_delta_base_cache(void)
2293 struct hashmap_iter iter;
2294 struct delta_base_cache_entry *entry;
2295 for (entry = hashmap_iter_first(&delta_base_cache, &iter);
2297 entry = hashmap_iter_next(&iter)) {
2298 release_delta_base_cache(entry);
2302 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
2303 void *base, unsigned long base_size, enum object_type type)
2305 struct delta_base_cache_entry *ent = xmalloc(sizeof(*ent));
2306 struct list_head *lru, *tmp;
2308 delta_base_cached += base_size;
2310 list_for_each_safe(lru, tmp, &delta_base_cache_lru) {
2311 struct delta_base_cache_entry *f =
2312 list_entry(lru, struct delta_base_cache_entry, lru);
2313 if (delta_base_cached <= delta_base_cache_limit)
2315 release_delta_base_cache(f);
2319 ent->key.base_offset = base_offset;
2322 ent->size = base_size;
2323 list_add_tail(&ent->lru, &delta_base_cache_lru);
2325 if (!delta_base_cache.cmpfn)
2326 hashmap_init(&delta_base_cache, delta_base_cache_hash_cmp, 0);
2327 hashmap_entry_init(ent, pack_entry_hash(p, base_offset));
2328 hashmap_add(&delta_base_cache, ent);
2331 static void *read_object(const unsigned char *sha1, enum object_type *type,
2332 unsigned long *size);
2334 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
2336 static struct trace_key pack_access = TRACE_KEY_INIT(PACK_ACCESS);
2337 trace_printf_key(&pack_access, "%s %"PRIuMAX"\n",
2338 p->pack_name, (uintmax_t)obj_offset);
2341 int do_check_packed_object_crc;
2343 #define UNPACK_ENTRY_STACK_PREALLOC 64
2344 struct unpack_entry_stack_ent {
2350 void *unpack_entry(struct packed_git *p, off_t obj_offset,
2351 enum object_type *final_type, unsigned long *final_size)
2353 struct pack_window *w_curs = NULL;
2354 off_t curpos = obj_offset;
2357 enum object_type type;
2358 struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
2359 struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
2360 int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
2361 int base_from_cache = 0;
2363 write_pack_access_log(p, obj_offset);
2365 /* PHASE 1: drill down to the innermost base object */
2369 struct delta_base_cache_entry *ent;
2371 ent = get_delta_base_cache_entry(p, curpos);
2376 detach_delta_base_cache_entry(ent);
2377 base_from_cache = 1;
2381 if (do_check_packed_object_crc && p->index_version > 1) {
2382 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2383 off_t len = revidx[1].offset - obj_offset;
2384 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
2385 const unsigned char *sha1 =
2386 nth_packed_object_sha1(p, revidx->nr);
2387 error("bad packed object CRC for %s",
2389 mark_bad_packed_object(p, sha1);
2390 unuse_pack(&w_curs);
2395 type = unpack_object_header(p, &w_curs, &curpos, &size);
2396 if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
2399 base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
2401 error("failed to validate delta base reference "
2402 "at offset %"PRIuMAX" from %s",
2403 (uintmax_t)curpos, p->pack_name);
2404 /* bail to phase 2, in hopes of recovery */
2409 /* push object, proceed to base */
2410 if (delta_stack_nr >= delta_stack_alloc
2411 && delta_stack == small_delta_stack) {
2412 delta_stack_alloc = alloc_nr(delta_stack_nr);
2413 ALLOC_ARRAY(delta_stack, delta_stack_alloc);
2414 memcpy(delta_stack, small_delta_stack,
2415 sizeof(*delta_stack)*delta_stack_nr);
2417 ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
2419 i = delta_stack_nr++;
2420 delta_stack[i].obj_offset = obj_offset;
2421 delta_stack[i].curpos = curpos;
2422 delta_stack[i].size = size;
2424 curpos = obj_offset = base_offset;
2427 /* PHASE 2: handle the base */
2432 die("BUG: unpack_entry: left loop at a valid delta");
2438 if (!base_from_cache)
2439 data = unpack_compressed_entry(p, &w_curs, curpos, size);
2443 error("unknown object type %i at offset %"PRIuMAX" in %s",
2444 type, (uintmax_t)obj_offset, p->pack_name);
2447 /* PHASE 3: apply deltas in order */
2450 * 'data' holds the base data, or NULL if there was corruption
2452 while (delta_stack_nr) {
2455 unsigned long delta_size, base_size = size;
2461 add_delta_base_cache(p, obj_offset, base, base_size, type);
2465 * We're probably in deep shit, but let's try to fetch
2466 * the required base anyway from another pack or loose.
2467 * This is costly but should happen only in the presence
2468 * of a corrupted pack, and is better than failing outright.
2470 struct revindex_entry *revidx;
2471 const unsigned char *base_sha1;
2472 revidx = find_pack_revindex(p, obj_offset);
2474 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
2475 error("failed to read delta base object %s"
2476 " at offset %"PRIuMAX" from %s",
2477 sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
2479 mark_bad_packed_object(p, base_sha1);
2480 base = read_object(base_sha1, &type, &base_size);
2484 i = --delta_stack_nr;
2485 obj_offset = delta_stack[i].obj_offset;
2486 curpos = delta_stack[i].curpos;
2487 delta_size = delta_stack[i].size;
2492 delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
2495 error("failed to unpack compressed delta "
2496 "at offset %"PRIuMAX" from %s",
2497 (uintmax_t)curpos, p->pack_name);
2502 data = patch_delta(base, base_size,
2503 delta_data, delta_size,
2507 * We could not apply the delta; warn the user, but keep going.
2508 * Our failure will be noticed either in the next iteration of
2509 * the loop, or if this is the final delta, in the caller when
2510 * we return NULL. Those code paths will take care of making
2511 * a more explicit warning and retrying with another copy of
2515 error("failed to apply delta");
2523 unuse_pack(&w_curs);
2525 if (delta_stack != small_delta_stack)
2531 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2534 const unsigned char *index = p->index_data;
2536 if (open_pack_index(p))
2538 index = p->index_data;
2540 if (n >= p->num_objects)
2543 if (p->index_version == 1) {
2544 return index + 24 * n + 4;
2547 return index + 20 * n;
2551 void check_pack_index_ptr(const struct packed_git *p, const void *vptr)
2553 const unsigned char *ptr = vptr;
2554 const unsigned char *start = p->index_data;
2555 const unsigned char *end = start + p->index_size;
2557 die(_("offset before start of pack index for %s (corrupt index?)"),
2559 /* No need to check for underflow; .idx files must be at least 8 bytes */
2561 die(_("offset beyond end of pack index for %s (truncated index?)"),
2565 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2567 const unsigned char *index = p->index_data;
2569 if (p->index_version == 1) {
2570 return ntohl(*((uint32_t *)(index + 24 * n)));
2573 index += 8 + p->num_objects * (20 + 4);
2574 off = ntohl(*((uint32_t *)(index + 4 * n)));
2575 if (!(off & 0x80000000))
2577 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2578 check_pack_index_ptr(p, index);
2579 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2580 ntohl(*((uint32_t *)(index + 4)));
2584 off_t find_pack_entry_one(const unsigned char *sha1,
2585 struct packed_git *p)
2587 const uint32_t *level1_ofs = p->index_data;
2588 const unsigned char *index = p->index_data;
2589 unsigned hi, lo, stride;
2590 static int use_lookup = -1;
2591 static int debug_lookup = -1;
2593 if (debug_lookup < 0)
2594 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2597 if (open_pack_index(p))
2599 level1_ofs = p->index_data;
2600 index = p->index_data;
2602 if (p->index_version > 1) {
2607 hi = ntohl(level1_ofs[*sha1]);
2608 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2609 if (p->index_version > 1) {
2617 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2618 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2621 use_lookup = !!getenv("GIT_USE_LOOKUP");
2623 int pos = sha1_entry_pos(index, stride, 0,
2624 lo, hi, p->num_objects, sha1);
2627 return nth_packed_object_offset(p, pos);
2631 unsigned mi = (lo + hi) / 2;
2632 int cmp = hashcmp(index + mi * stride, sha1);
2635 printf("lo %u hi %u rg %u mi %u\n",
2636 lo, hi, hi - lo, mi);
2638 return nth_packed_object_offset(p, mi);
2647 int is_pack_valid(struct packed_git *p)
2649 /* An already open pack is known to be valid. */
2650 if (p->pack_fd != -1)
2653 /* If the pack has one window completely covering the
2654 * file size, the pack is known to be valid even if
2655 * the descriptor is not currently open.
2658 struct pack_window *w = p->windows;
2660 if (!w->offset && w->len == p->pack_size)
2664 /* Force the pack to open to prove its valid. */
2665 return !open_packed_git(p);
2668 static int fill_pack_entry(const unsigned char *sha1,
2669 struct pack_entry *e,
2670 struct packed_git *p)
2674 if (p->num_bad_objects) {
2676 for (i = 0; i < p->num_bad_objects; i++)
2677 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2681 offset = find_pack_entry_one(sha1, p);
2686 * We are about to tell the caller where they can locate the
2687 * requested object. We better make sure the packfile is
2688 * still here and can be accessed before supplying that
2689 * answer, as it may have been deleted since the index was
2692 if (!is_pack_valid(p))
2696 hashcpy(e->sha1, sha1);
2701 * Iff a pack file contains the object named by sha1, return true and
2702 * store its location to e.
2704 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2706 struct mru_entry *p;
2708 prepare_packed_git();
2712 for (p = packed_git_mru->head; p; p = p->next) {
2713 if (fill_pack_entry(sha1, e, p->item)) {
2714 mru_mark(packed_git_mru, p);
2721 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2722 struct packed_git *packs)
2724 struct packed_git *p;
2726 for (p = packs; p; p = p->next) {
2727 if (find_pack_entry_one(sha1, p))
2734 static int sha1_loose_object_info(const unsigned char *sha1,
2735 struct object_info *oi,
2739 unsigned long mapsize;
2743 struct strbuf hdrbuf = STRBUF_INIT;
2745 if (oi->delta_base_sha1)
2746 hashclr(oi->delta_base_sha1);
2749 * If we don't care about type or size, then we don't
2750 * need to look inside the object at all. Note that we
2751 * do not optimize out the stat call, even if the
2752 * caller doesn't care about the disk-size, since our
2753 * return value implicitly indicates whether the
2754 * object even exists.
2756 if (!oi->typep && !oi->typename && !oi->sizep) {
2758 if (stat_sha1_file(sha1, &st) < 0)
2761 *oi->disk_sizep = st.st_size;
2765 map = map_sha1_file(sha1, &mapsize);
2769 *oi->disk_sizep = mapsize;
2770 if ((flags & LOOKUP_UNKNOWN_OBJECT)) {
2771 if (unpack_sha1_header_to_strbuf(&stream, map, mapsize, hdr, sizeof(hdr), &hdrbuf) < 0)
2772 status = error("unable to unpack %s header with --allow-unknown-type",
2774 } else if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2775 status = error("unable to unpack %s header",
2779 else if (hdrbuf.len) {
2780 if ((status = parse_sha1_header_extended(hdrbuf.buf, oi, flags)) < 0)
2781 status = error("unable to parse %s header with --allow-unknown-type",
2783 } else if ((status = parse_sha1_header_extended(hdr, oi, flags)) < 0)
2784 status = error("unable to parse %s header", sha1_to_hex(sha1));
2785 git_inflate_end(&stream);
2786 munmap(map, mapsize);
2787 if (status && oi->typep)
2788 *oi->typep = status;
2789 strbuf_release(&hdrbuf);
2793 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi, unsigned flags)
2795 struct cached_object *co;
2796 struct pack_entry e;
2798 enum object_type real_type;
2799 const unsigned char *real = lookup_replace_object_extended(sha1, flags);
2801 co = find_cached_object(real);
2804 *(oi->typep) = co->type;
2806 *(oi->sizep) = co->size;
2808 *(oi->disk_sizep) = 0;
2809 if (oi->delta_base_sha1)
2810 hashclr(oi->delta_base_sha1);
2812 strbuf_addstr(oi->typename, typename(co->type));
2813 oi->whence = OI_CACHED;
2817 if (!find_pack_entry(real, &e)) {
2818 /* Most likely it's a loose object. */
2819 if (!sha1_loose_object_info(real, oi, flags)) {
2820 oi->whence = OI_LOOSE;
2824 /* Not a loose object; someone else may have just packed it. */
2825 reprepare_packed_git();
2826 if (!find_pack_entry(real, &e))
2831 * packed_object_info() does not follow the delta chain to
2832 * find out the real type, unless it is given oi->typep.
2834 if (oi->typename && !oi->typep)
2835 oi->typep = &real_type;
2837 rtype = packed_object_info(e.p, e.offset, oi);
2839 mark_bad_packed_object(e.p, real);
2840 if (oi->typep == &real_type)
2842 return sha1_object_info_extended(real, oi, 0);
2843 } else if (in_delta_base_cache(e.p, e.offset)) {
2844 oi->whence = OI_DBCACHED;
2846 oi->whence = OI_PACKED;
2847 oi->u.packed.offset = e.offset;
2848 oi->u.packed.pack = e.p;
2849 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2850 rtype == OBJ_OFS_DELTA);
2853 strbuf_addstr(oi->typename, typename(*oi->typep));
2854 if (oi->typep == &real_type)
2860 /* returns enum object_type or negative */
2861 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2863 enum object_type type;
2864 struct object_info oi = OBJECT_INFO_INIT;
2868 if (sha1_object_info_extended(sha1, &oi, LOOKUP_REPLACE_OBJECT) < 0)
2873 static void *read_packed_sha1(const unsigned char *sha1,
2874 enum object_type *type, unsigned long *size)
2876 struct pack_entry e;
2879 if (!find_pack_entry(sha1, &e))
2881 data = cache_or_unpack_entry(e.p, e.offset, size, type);
2884 * We're probably in deep shit, but let's try to fetch
2885 * the required object anyway from another pack or loose.
2886 * This should happen only in the presence of a corrupted
2887 * pack, and is better than failing outright.
2889 error("failed to read object %s at offset %"PRIuMAX" from %s",
2890 sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2891 mark_bad_packed_object(e.p, sha1);
2892 data = read_object(sha1, type, size);
2897 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2898 unsigned char *sha1)
2900 struct cached_object *co;
2902 hash_sha1_file(buf, len, typename(type), sha1);
2903 if (has_sha1_file(sha1) || find_cached_object(sha1))
2905 ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
2906 co = &cached_objects[cached_object_nr++];
2909 co->buf = xmalloc(len);
2910 memcpy(co->buf, buf, len);
2911 hashcpy(co->sha1, sha1);
2915 static void *read_object(const unsigned char *sha1, enum object_type *type,
2916 unsigned long *size)
2918 unsigned long mapsize;
2920 struct cached_object *co;
2922 co = find_cached_object(sha1);
2926 return xmemdupz(co->buf, co->size);
2929 buf = read_packed_sha1(sha1, type, size);
2932 map = map_sha1_file(sha1, &mapsize);
2934 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2935 munmap(map, mapsize);
2938 reprepare_packed_git();
2939 return read_packed_sha1(sha1, type, size);
2943 * This function dies on corrupt objects; the callers who want to
2944 * deal with them should arrange to call read_object() and give error
2945 * messages themselves.
2947 void *read_sha1_file_extended(const unsigned char *sha1,
2948 enum object_type *type,
2949 unsigned long *size,
2953 const struct packed_git *p;
2954 const unsigned char *repl = lookup_replace_object_extended(sha1, flag);
2957 data = read_object(repl, type, size);
2961 if (errno && errno != ENOENT)
2962 die_errno("failed to read object %s", sha1_to_hex(sha1));
2964 /* die if we replaced an object with one that does not exist */
2966 die("replacement %s not found for %s",
2967 sha1_to_hex(repl), sha1_to_hex(sha1));
2969 if (has_loose_object(repl)) {
2970 const char *path = sha1_file_name(sha1);
2972 die("loose object %s (stored in %s) is corrupt",
2973 sha1_to_hex(repl), path);
2976 if ((p = has_packed_and_bad(repl)) != NULL)
2977 die("packed object %s (stored in %s) is corrupt",
2978 sha1_to_hex(repl), p->pack_name);
2983 void *read_object_with_reference(const unsigned char *sha1,
2984 const char *required_type_name,
2985 unsigned long *size,
2986 unsigned char *actual_sha1_return)
2988 enum object_type type, required_type;
2990 unsigned long isize;
2991 unsigned char actual_sha1[20];
2993 required_type = type_from_string(required_type_name);
2994 hashcpy(actual_sha1, sha1);
2996 int ref_length = -1;
2997 const char *ref_type = NULL;
2999 buffer = read_sha1_file(actual_sha1, &type, &isize);
3002 if (type == required_type) {
3004 if (actual_sha1_return)
3005 hashcpy(actual_sha1_return, actual_sha1);
3008 /* Handle references */
3009 else if (type == OBJ_COMMIT)
3011 else if (type == OBJ_TAG)
3012 ref_type = "object ";
3017 ref_length = strlen(ref_type);
3019 if (ref_length + 40 > isize ||
3020 memcmp(buffer, ref_type, ref_length) ||
3021 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
3026 /* Now we have the ID of the referred-to object in
3027 * actual_sha1. Check again. */
3031 static void write_sha1_file_prepare(const void *buf, unsigned long len,
3032 const char *type, unsigned char *sha1,
3033 char *hdr, int *hdrlen)
3037 /* Generate the header */
3038 *hdrlen = xsnprintf(hdr, *hdrlen, "%s %lu", type, len)+1;
3042 git_SHA1_Update(&c, hdr, *hdrlen);
3043 git_SHA1_Update(&c, buf, len);
3044 git_SHA1_Final(sha1, &c);
3048 * Move the just written object into its final resting place.
3050 int finalize_object_file(const char *tmpfile, const char *filename)
3054 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
3056 else if (link(tmpfile, filename))
3060 * Coda hack - coda doesn't like cross-directory links,
3061 * so we fall back to a rename, which will mean that it
3062 * won't be able to check collisions, but that's not a
3065 * The same holds for FAT formatted media.
3067 * When this succeeds, we just return. We have nothing
3070 if (ret && ret != EEXIST) {
3072 if (!rename(tmpfile, filename))
3076 unlink_or_warn(tmpfile);
3078 if (ret != EEXIST) {
3079 return error_errno("unable to write sha1 filename %s", filename);
3081 /* FIXME!!! Collision check here ? */
3085 if (adjust_shared_perm(filename))
3086 return error("unable to set permission to '%s'", filename);
3090 static int write_buffer(int fd, const void *buf, size_t len)
3092 if (write_in_full(fd, buf, len) < 0)
3093 return error_errno("file write error");
3097 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
3098 unsigned char *sha1)
3101 int hdrlen = sizeof(hdr);
3102 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3106 /* Finalize a file on disk, and close it. */
3107 static void close_sha1_file(int fd)
3109 if (fsync_object_files)
3110 fsync_or_die(fd, "sha1 file");
3112 die_errno("error when closing sha1 file");
3115 /* Size of directory component, including the ending '/' */
3116 static inline int directory_size(const char *filename)
3118 const char *s = strrchr(filename, '/');
3121 return s - filename + 1;
3125 * This creates a temporary file in the same directory as the final
3128 * We want to avoid cross-directory filename renames, because those
3129 * can have problems on various filesystems (FAT, NFS, Coda).
3131 static int create_tmpfile(struct strbuf *tmp, const char *filename)
3133 int fd, dirlen = directory_size(filename);
3136 strbuf_add(tmp, filename, dirlen);
3137 strbuf_addstr(tmp, "tmp_obj_XXXXXX");
3138 fd = git_mkstemp_mode(tmp->buf, 0444);
3139 if (fd < 0 && dirlen && errno == ENOENT) {
3141 * Make sure the directory exists; note that the contents
3142 * of the buffer are undefined after mkstemp returns an
3143 * error, so we have to rewrite the whole buffer from
3147 strbuf_add(tmp, filename, dirlen - 1);
3148 if (mkdir(tmp->buf, 0777) && errno != EEXIST)
3150 if (adjust_shared_perm(tmp->buf))
3154 strbuf_addstr(tmp, "/tmp_obj_XXXXXX");
3155 fd = git_mkstemp_mode(tmp->buf, 0444);
3160 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
3161 const void *buf, unsigned long len, time_t mtime)
3164 unsigned char compressed[4096];
3167 unsigned char parano_sha1[20];
3168 static struct strbuf tmp_file = STRBUF_INIT;
3169 const char *filename = sha1_file_name(sha1);
3171 fd = create_tmpfile(&tmp_file, filename);
3173 if (errno == EACCES)
3174 return error("insufficient permission for adding an object to repository database %s", get_object_directory());
3176 return error_errno("unable to create temporary file");
3180 git_deflate_init(&stream, zlib_compression_level);
3181 stream.next_out = compressed;
3182 stream.avail_out = sizeof(compressed);
3185 /* First header.. */
3186 stream.next_in = (unsigned char *)hdr;
3187 stream.avail_in = hdrlen;
3188 while (git_deflate(&stream, 0) == Z_OK)
3190 git_SHA1_Update(&c, hdr, hdrlen);
3192 /* Then the data itself.. */
3193 stream.next_in = (void *)buf;
3194 stream.avail_in = len;
3196 unsigned char *in0 = stream.next_in;
3197 ret = git_deflate(&stream, Z_FINISH);
3198 git_SHA1_Update(&c, in0, stream.next_in - in0);
3199 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
3200 die("unable to write sha1 file");
3201 stream.next_out = compressed;
3202 stream.avail_out = sizeof(compressed);
3203 } while (ret == Z_OK);
3205 if (ret != Z_STREAM_END)
3206 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
3207 ret = git_deflate_end_gently(&stream);
3209 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
3210 git_SHA1_Final(parano_sha1, &c);
3211 if (hashcmp(sha1, parano_sha1) != 0)
3212 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
3214 close_sha1_file(fd);
3219 utb.modtime = mtime;
3220 if (utime(tmp_file.buf, &utb) < 0)
3221 warning_errno("failed utime() on %s", tmp_file.buf);
3224 return finalize_object_file(tmp_file.buf, filename);
3227 static int freshen_loose_object(const unsigned char *sha1)
3229 return check_and_freshen(sha1, 1);
3232 static int freshen_packed_object(const unsigned char *sha1)
3234 struct pack_entry e;
3235 if (!find_pack_entry(sha1, &e))
3239 if (!freshen_file(e.p->pack_name))
3245 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1)
3248 int hdrlen = sizeof(hdr);
3250 /* Normally if we have it in the pack then we do not bother writing
3251 * it out into .git/objects/??/?{38} file.
3253 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3254 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3256 return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
3259 int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type,
3260 unsigned char *sha1, unsigned flags)
3263 int hdrlen, status = 0;
3265 /* type string, SP, %lu of the length plus NUL must fit this */
3266 hdrlen = strlen(type) + 32;
3267 header = xmalloc(hdrlen);
3268 write_sha1_file_prepare(buf, len, type, sha1, header, &hdrlen);
3270 if (!(flags & HASH_WRITE_OBJECT))
3272 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3274 status = write_loose_object(sha1, header, hdrlen, buf, len, 0);
3281 int force_object_loose(const unsigned char *sha1, time_t mtime)
3285 enum object_type type;
3290 if (has_loose_object(sha1))
3292 buf = read_packed_sha1(sha1, &type, &len);
3294 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
3295 hdrlen = xsnprintf(hdr, sizeof(hdr), "%s %lu", typename(type), len) + 1;
3296 ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
3302 int has_pack_index(const unsigned char *sha1)
3305 if (stat(sha1_pack_index_name(sha1), &st))
3310 int has_sha1_pack(const unsigned char *sha1)
3312 struct pack_entry e;
3313 return find_pack_entry(sha1, &e);
3316 int has_sha1_file_with_flags(const unsigned char *sha1, int flags)
3318 struct pack_entry e;
3320 if (find_pack_entry(sha1, &e))
3322 if (has_loose_object(sha1))
3324 if (flags & HAS_SHA1_QUICK)
3326 reprepare_packed_git();
3327 return find_pack_entry(sha1, &e);
3330 int has_object_file(const struct object_id *oid)
3332 return has_sha1_file(oid->hash);
3335 static void check_tree(const void *buf, size_t size)
3337 struct tree_desc desc;
3338 struct name_entry entry;
3340 init_tree_desc(&desc, buf, size);
3341 while (tree_entry(&desc, &entry))
3343 * tree_entry() will die() on malformed entries */
3347 static void check_commit(const void *buf, size_t size)
3350 memset(&c, 0, sizeof(c));
3351 if (parse_commit_buffer(&c, buf, size))
3352 die("corrupt commit");
3355 static void check_tag(const void *buf, size_t size)
3358 memset(&t, 0, sizeof(t));
3359 if (parse_tag_buffer(&t, buf, size))
3363 static int index_mem(unsigned char *sha1, void *buf, size_t size,
3364 enum object_type type,
3365 const char *path, unsigned flags)
3367 int ret, re_allocated = 0;
3368 int write_object = flags & HASH_WRITE_OBJECT;
3374 * Convert blobs to git internal format
3376 if ((type == OBJ_BLOB) && path) {
3377 struct strbuf nbuf = STRBUF_INIT;
3378 if (convert_to_git(path, buf, size, &nbuf,
3379 write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
3380 buf = strbuf_detach(&nbuf, &size);
3384 if (flags & HASH_FORMAT_CHECK) {
3385 if (type == OBJ_TREE)
3386 check_tree(buf, size);
3387 if (type == OBJ_COMMIT)
3388 check_commit(buf, size);
3389 if (type == OBJ_TAG)
3390 check_tag(buf, size);
3394 ret = write_sha1_file(buf, size, typename(type), sha1);
3396 ret = hash_sha1_file(buf, size, typename(type), sha1);
3402 static int index_stream_convert_blob(unsigned char *sha1, int fd,
3403 const char *path, unsigned flags)
3406 const int write_object = flags & HASH_WRITE_OBJECT;
3407 struct strbuf sbuf = STRBUF_INIT;
3410 assert(would_convert_to_git_filter_fd(path));
3412 convert_to_git_filter_fd(path, fd, &sbuf,
3413 write_object ? safe_crlf : SAFE_CRLF_FALSE);
3416 ret = write_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3419 ret = hash_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3421 strbuf_release(&sbuf);
3425 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
3426 const char *path, unsigned flags)
3428 struct strbuf sbuf = STRBUF_INIT;
3431 if (strbuf_read(&sbuf, fd, 4096) >= 0)
3432 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
3435 strbuf_release(&sbuf);
3439 #define SMALL_FILE_SIZE (32*1024)
3441 static int index_core(unsigned char *sha1, int fd, size_t size,
3442 enum object_type type, const char *path,
3448 ret = index_mem(sha1, "", size, type, path, flags);
3449 } else if (size <= SMALL_FILE_SIZE) {
3450 char *buf = xmalloc(size);
3451 if (size == read_in_full(fd, buf, size))
3452 ret = index_mem(sha1, buf, size, type, path, flags);
3454 ret = error_errno("short read");
3457 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
3458 ret = index_mem(sha1, buf, size, type, path, flags);
3465 * This creates one packfile per large blob unless bulk-checkin
3466 * machinery is "plugged".
3468 * This also bypasses the usual "convert-to-git" dance, and that is on
3469 * purpose. We could write a streaming version of the converting
3470 * functions and insert that before feeding the data to fast-import
3471 * (or equivalent in-core API described above). However, that is
3472 * somewhat complicated, as we do not know the size of the filter
3473 * result, which we need to know beforehand when writing a git object.
3474 * Since the primary motivation for trying to stream from the working
3475 * tree file and to avoid mmaping it in core is to deal with large
3476 * binary blobs, they generally do not want to get any conversion, and
3477 * callers should avoid this code path when filters are requested.
3479 static int index_stream(unsigned char *sha1, int fd, size_t size,
3480 enum object_type type, const char *path,
3483 return index_bulk_checkin(sha1, fd, size, type, path, flags);
3486 int index_fd(unsigned char *sha1, int fd, struct stat *st,
3487 enum object_type type, const char *path, unsigned flags)
3492 * Call xsize_t() only when needed to avoid potentially unnecessary
3493 * die() for large files.
3495 if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(path))
3496 ret = index_stream_convert_blob(sha1, fd, path, flags);
3497 else if (!S_ISREG(st->st_mode))
3498 ret = index_pipe(sha1, fd, type, path, flags);
3499 else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
3500 (path && would_convert_to_git(path)))
3501 ret = index_core(sha1, fd, xsize_t(st->st_size), type, path,
3504 ret = index_stream(sha1, fd, xsize_t(st->st_size), type, path,
3510 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
3513 struct strbuf sb = STRBUF_INIT;
3515 switch (st->st_mode & S_IFMT) {
3517 fd = open(path, O_RDONLY);
3519 return error_errno("open(\"%s\")", path);
3520 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
3521 return error("%s: failed to insert into database",
3525 if (strbuf_readlink(&sb, path, st->st_size))
3526 return error_errno("readlink(\"%s\")", path);
3527 if (!(flags & HASH_WRITE_OBJECT))
3528 hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
3529 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
3530 return error("%s: failed to insert into database",
3532 strbuf_release(&sb);
3535 return resolve_gitlink_ref(path, "HEAD", sha1);
3537 return error("%s: unsupported file type", path);
3542 int read_pack_header(int fd, struct pack_header *header)
3544 if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
3545 /* "eof before pack header was fully read" */
3546 return PH_ERROR_EOF;
3548 if (header->hdr_signature != htonl(PACK_SIGNATURE))
3549 /* "protocol error (pack signature mismatch detected)" */
3550 return PH_ERROR_PACK_SIGNATURE;
3551 if (!pack_version_ok(header->hdr_version))
3552 /* "protocol error (pack version unsupported)" */
3553 return PH_ERROR_PROTOCOL;
3557 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
3559 enum object_type type = sha1_object_info(sha1, NULL);
3561 die("%s is not a valid object", sha1_to_hex(sha1));
3563 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
3567 static int for_each_file_in_obj_subdir(int subdir_nr,
3568 struct strbuf *path,
3569 each_loose_object_fn obj_cb,
3570 each_loose_cruft_fn cruft_cb,
3571 each_loose_subdir_fn subdir_cb,
3574 size_t baselen = path->len;
3575 DIR *dir = opendir(path->buf);
3580 if (errno == ENOENT)
3582 return error_errno("unable to open %s", path->buf);
3585 while ((de = readdir(dir))) {
3586 if (is_dot_or_dotdot(de->d_name))
3589 strbuf_setlen(path, baselen);
3590 strbuf_addf(path, "/%s", de->d_name);
3592 if (strlen(de->d_name) == 38) {
3594 unsigned char sha1[20];
3596 snprintf(hex, sizeof(hex), "%02x%s",
3597 subdir_nr, de->d_name);
3598 if (!get_sha1_hex(hex, sha1)) {
3600 r = obj_cb(sha1, path->buf, data);
3609 r = cruft_cb(de->d_name, path->buf, data);
3616 strbuf_setlen(path, baselen);
3617 if (!r && subdir_cb)
3618 r = subdir_cb(subdir_nr, path->buf, data);
3623 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
3624 each_loose_object_fn obj_cb,
3625 each_loose_cruft_fn cruft_cb,
3626 each_loose_subdir_fn subdir_cb,
3629 size_t baselen = path->len;
3633 for (i = 0; i < 256; i++) {
3634 strbuf_addf(path, "/%02x", i);
3635 r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
3637 strbuf_setlen(path, baselen);
3645 int for_each_loose_file_in_objdir(const char *path,
3646 each_loose_object_fn obj_cb,
3647 each_loose_cruft_fn cruft_cb,
3648 each_loose_subdir_fn subdir_cb,
3651 struct strbuf buf = STRBUF_INIT;
3654 strbuf_addstr(&buf, path);
3655 r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
3657 strbuf_release(&buf);
3662 struct loose_alt_odb_data {
3663 each_loose_object_fn *cb;
3667 static int loose_from_alt_odb(struct alternate_object_database *alt,
3670 struct loose_alt_odb_data *data = vdata;
3671 struct strbuf buf = STRBUF_INIT;
3674 strbuf_addstr(&buf, alt->path);
3675 r = for_each_loose_file_in_objdir_buf(&buf,
3676 data->cb, NULL, NULL,
3678 strbuf_release(&buf);
3682 int for_each_loose_object(each_loose_object_fn cb, void *data, unsigned flags)
3684 struct loose_alt_odb_data alt;
3687 r = for_each_loose_file_in_objdir(get_object_directory(),
3688 cb, NULL, NULL, data);
3692 if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
3697 return foreach_alt_odb(loose_from_alt_odb, &alt);
3700 static int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn cb, void *data)
3705 for (i = 0; i < p->num_objects; i++) {
3706 const unsigned char *sha1 = nth_packed_object_sha1(p, i);
3709 return error("unable to get sha1 of object %u in %s",
3712 r = cb(sha1, p, i, data);
3719 int for_each_packed_object(each_packed_object_fn cb, void *data, unsigned flags)
3721 struct packed_git *p;
3723 int pack_errors = 0;
3725 prepare_packed_git();
3726 for (p = packed_git; p; p = p->next) {
3727 if ((flags & FOR_EACH_OBJECT_LOCAL_ONLY) && !p->pack_local)
3729 if (open_pack_index(p)) {
3733 r = for_each_object_in_pack(p, cb, data);
3737 return r ? r : pack_errors;