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 #if defined(__linux__) && (defined(__i386__) || defined(__PPC__))
29 #define O_NOATIME 01000000
35 #define SZ_FMT PRIuMAX
36 static inline uintmax_t sz_fmt(size_t s) { return s; }
38 const unsigned char null_sha1[20];
41 * This is meant to hold a *small* number of objects that you would
42 * want read_sha1_file() to be able to return, but yet you do not want
43 * to write them into the object store (e.g. a browse-only
46 static struct cached_object {
47 unsigned char sha1[20];
48 enum object_type type;
52 static int cached_object_nr, cached_object_alloc;
54 static struct cached_object empty_tree = {
55 EMPTY_TREE_SHA1_BIN_LITERAL,
62 * A pointer to the last packed_git in which an object was found.
63 * When an object is sought, we look in this packfile first, because
64 * objects that are looked up at similar times are often in the same
65 * packfile as one another.
67 static struct packed_git *last_found_pack;
69 static struct cached_object *find_cached_object(const unsigned char *sha1)
72 struct cached_object *co = cached_objects;
74 for (i = 0; i < cached_object_nr; i++, co++) {
75 if (!hashcmp(co->sha1, sha1))
78 if (!hashcmp(sha1, empty_tree.sha1))
83 int mkdir_in_gitdir(const char *path)
85 if (mkdir(path, 0777)) {
86 int saved_errno = errno;
88 struct strbuf sb = STRBUF_INIT;
93 * Are we looking at a path in a symlinked worktree
94 * whose original repository does not yet have it?
95 * e.g. .git/rr-cache pointing at its original
96 * repository in which the user hasn't performed any
97 * conflict resolution yet?
99 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
100 strbuf_readlink(&sb, path, st.st_size) ||
101 !is_absolute_path(sb.buf) ||
102 mkdir(sb.buf, 0777)) {
109 return adjust_shared_perm(path);
112 enum scld_error safe_create_leading_directories(char *path)
114 char *next_component = path + offset_1st_component(path);
115 enum scld_error ret = SCLD_OK;
117 while (ret == SCLD_OK && next_component) {
119 char *slash = next_component, slash_character;
121 while (*slash && !is_dir_sep(*slash))
127 next_component = slash + 1;
128 while (is_dir_sep(*next_component))
130 if (!*next_component)
133 slash_character = *slash;
135 if (!stat(path, &st)) {
137 if (!S_ISDIR(st.st_mode))
139 } else if (mkdir(path, 0777)) {
140 if (errno == EEXIST &&
141 !stat(path, &st) && S_ISDIR(st.st_mode))
142 ; /* somebody created it since we checked */
143 else if (errno == ENOENT)
145 * Either mkdir() failed because
146 * somebody just pruned the containing
147 * directory, or stat() failed because
148 * the file that was in our way was
149 * just removed. Either way, inform
150 * the caller that it might be worth
156 } else if (adjust_shared_perm(path)) {
159 *slash = slash_character;
164 enum scld_error safe_create_leading_directories_const(const char *path)
166 /* path points to cache entries, so xstrdup before messing with it */
167 char *buf = xstrdup(path);
168 enum scld_error result = safe_create_leading_directories(buf);
173 static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
176 for (i = 0; i < 20; i++) {
177 static char hex[] = "0123456789abcdef";
178 unsigned int val = sha1[i];
179 char *pos = pathbuf + i*2 + (i > 0);
180 *pos++ = hex[val >> 4];
181 *pos = hex[val & 0xf];
185 const char *sha1_file_name(const unsigned char *sha1)
187 static char buf[PATH_MAX];
191 objdir = get_object_directory();
192 len = strlen(objdir);
194 /* '/' + sha1(2) + '/' + sha1(38) + '\0' */
195 if (len + 43 > PATH_MAX)
196 die("insanely long object directory %s", objdir);
197 memcpy(buf, objdir, len);
201 fill_sha1_path(buf + len + 1, 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,
211 char **name, char **base, const char *which)
213 static const char hex[] = "0123456789abcdef";
218 const char *sha1_file_directory = get_object_directory();
219 int len = strlen(sha1_file_directory);
220 *base = xmalloc(len + 60);
221 sprintf(*base, "%s/pack/pack-1234567890123456789012345678901234567890.%s",
222 sha1_file_directory, which);
223 *name = *base + len + 11;
228 for (i = 0; i < 20; i++) {
229 unsigned int val = *sha1++;
230 *buf++ = hex[val >> 4];
231 *buf++ = hex[val & 0xf];
237 char *sha1_pack_name(const unsigned char *sha1)
239 static char *name, *base;
241 return sha1_get_pack_name(sha1, &name, &base, "pack");
244 char *sha1_pack_index_name(const unsigned char *sha1)
246 static char *name, *base;
248 return sha1_get_pack_name(sha1, &name, &base, "idx");
251 struct alternate_object_database *alt_odb_list;
252 static struct alternate_object_database **alt_odb_tail;
255 * Prepare alternate object database registry.
257 * The variable alt_odb_list points at the list of struct
258 * alternate_object_database. The elements on this list come from
259 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
260 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
261 * whose contents is similar to that environment variable but can be
262 * LF separated. Its base points at a statically allocated buffer that
263 * contains "/the/directory/corresponding/to/.git/objects/...", while
264 * its name points just after the slash at the end of ".git/objects/"
265 * in the example above, and has enough space to hold 40-byte hex
266 * SHA1, an extra slash for the first level indirection, and the
269 static int link_alt_odb_entry(const char *entry, const char *relative_base,
270 int depth, const char *normalized_objdir)
272 struct alternate_object_database *ent;
273 struct alternate_object_database *alt;
275 struct strbuf pathbuf = STRBUF_INIT;
277 if (!is_absolute_path(entry) && relative_base) {
278 strbuf_addstr(&pathbuf, real_path(relative_base));
279 strbuf_addch(&pathbuf, '/');
281 strbuf_addstr(&pathbuf, entry);
283 normalize_path_copy(pathbuf.buf, pathbuf.buf);
285 pfxlen = strlen(pathbuf.buf);
288 * The trailing slash after the directory name is given by
289 * this function at the end. Remove duplicates.
291 while (pfxlen && pathbuf.buf[pfxlen-1] == '/')
294 entlen = pfxlen + 43; /* '/' + 2 hex + '/' + 38 hex + NUL */
295 ent = xmalloc(sizeof(*ent) + entlen);
296 memcpy(ent->base, pathbuf.buf, pfxlen);
297 strbuf_release(&pathbuf);
299 ent->name = ent->base + pfxlen + 1;
300 ent->base[pfxlen + 3] = '/';
301 ent->base[pfxlen] = ent->base[entlen-1] = 0;
303 /* Detect cases where alternate disappeared */
304 if (!is_directory(ent->base)) {
305 error("object directory %s does not exist; "
306 "check .git/objects/info/alternates.",
312 /* Prevent the common mistake of listing the same
313 * thing twice, or object directory itself.
315 for (alt = alt_odb_list; alt; alt = alt->next) {
316 if (pfxlen == alt->name - alt->base - 1 &&
317 !memcmp(ent->base, alt->base, pfxlen)) {
322 if (!strcmp_icase(ent->base, normalized_objdir)) {
327 /* add the alternate entry */
329 alt_odb_tail = &(ent->next);
332 /* recursively add alternates */
333 read_info_alternates(ent->base, depth + 1);
335 ent->base[pfxlen] = '/';
340 static void link_alt_odb_entries(const char *alt, int len, int sep,
341 const char *relative_base, int depth)
343 struct string_list entries = STRING_LIST_INIT_NODUP;
346 struct strbuf objdirbuf = STRBUF_INIT;
349 error("%s: ignoring alternate object stores, nesting too deep.",
354 strbuf_add_absolute_path(&objdirbuf, get_object_directory());
355 normalize_path_copy(objdirbuf.buf, objdirbuf.buf);
357 alt_copy = xmemdupz(alt, len);
358 string_list_split_in_place(&entries, alt_copy, sep, -1);
359 for (i = 0; i < entries.nr; i++) {
360 const char *entry = entries.items[i].string;
361 if (entry[0] == '\0' || entry[0] == '#')
363 if (!is_absolute_path(entry) && depth) {
364 error("%s: ignoring relative alternate object store %s",
365 relative_base, entry);
367 link_alt_odb_entry(entry, relative_base, depth, objdirbuf.buf);
370 string_list_clear(&entries, 0);
372 strbuf_release(&objdirbuf);
375 void read_info_alternates(const char * relative_base, int depth)
380 const char alt_file_name[] = "info/alternates";
381 /* Given that relative_base is no longer than PATH_MAX,
382 ensure that "path" has enough space to append "/", the
383 file name, "info/alternates", and a trailing NUL. */
384 char path[PATH_MAX + 1 + sizeof alt_file_name];
387 sprintf(path, "%s/%s", relative_base, alt_file_name);
388 fd = git_open_noatime(path);
391 if (fstat(fd, &st) || (st.st_size == 0)) {
395 mapsz = xsize_t(st.st_size);
396 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
399 link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
404 void add_to_alternates_file(const char *reference)
406 struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
407 int fd = hold_lock_file_for_append(lock, git_path("objects/info/alternates"), LOCK_DIE_ON_ERROR);
408 const char *alt = mkpath("%s\n", reference);
409 write_or_die(fd, alt, strlen(alt));
410 if (commit_lock_file(lock))
411 die("could not close alternates file");
413 link_alt_odb_entries(alt, strlen(alt), '\n', NULL, 0);
416 int foreach_alt_odb(alt_odb_fn fn, void *cb)
418 struct alternate_object_database *ent;
422 for (ent = alt_odb_list; ent; ent = ent->next) {
430 void prepare_alt_odb(void)
437 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
440 alt_odb_tail = &alt_odb_list;
441 link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
443 read_info_alternates(get_object_directory(), 0);
446 /* Returns 1 if we have successfully freshened the file, 0 otherwise. */
447 static int freshen_file(const char *fn)
450 t.actime = t.modtime = time(NULL);
451 return !utime(fn, &t);
455 * All of the check_and_freshen functions return 1 if the file exists and was
456 * freshened (if freshening was requested), 0 otherwise. If they return
457 * 0, you should not assume that it is safe to skip a write of the object (it
458 * either does not exist on disk, or has a stale mtime and may be subject to
461 static int check_and_freshen_file(const char *fn, int freshen)
463 if (access(fn, F_OK))
465 if (freshen && !freshen_file(fn))
470 static int check_and_freshen_local(const unsigned char *sha1, int freshen)
472 return check_and_freshen_file(sha1_file_name(sha1), freshen);
475 static int check_and_freshen_nonlocal(const unsigned char *sha1, int freshen)
477 struct alternate_object_database *alt;
479 for (alt = alt_odb_list; alt; alt = alt->next) {
480 fill_sha1_path(alt->name, sha1);
481 if (check_and_freshen_file(alt->base, freshen))
487 static int check_and_freshen(const unsigned char *sha1, int freshen)
489 return check_and_freshen_local(sha1, freshen) ||
490 check_and_freshen_nonlocal(sha1, freshen);
493 int has_loose_object_nonlocal(const unsigned char *sha1)
495 return check_and_freshen_nonlocal(sha1, 0);
498 static int has_loose_object(const unsigned char *sha1)
500 return check_and_freshen(sha1, 0);
503 static unsigned int pack_used_ctr;
504 static unsigned int pack_mmap_calls;
505 static unsigned int peak_pack_open_windows;
506 static unsigned int pack_open_windows;
507 static unsigned int pack_open_fds;
508 static unsigned int pack_max_fds;
509 static size_t peak_pack_mapped;
510 static size_t pack_mapped;
511 struct packed_git *packed_git;
513 void pack_report(void)
516 "pack_report: getpagesize() = %10" SZ_FMT "\n"
517 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
518 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
519 sz_fmt(getpagesize()),
520 sz_fmt(packed_git_window_size),
521 sz_fmt(packed_git_limit));
523 "pack_report: pack_used_ctr = %10u\n"
524 "pack_report: pack_mmap_calls = %10u\n"
525 "pack_report: pack_open_windows = %10u / %10u\n"
526 "pack_report: pack_mapped = "
527 "%10" SZ_FMT " / %10" SZ_FMT "\n",
530 pack_open_windows, peak_pack_open_windows,
531 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
535 * Open and mmap the index file at path, perform a couple of
536 * consistency checks, then record its information to p. Return 0 on
539 static int check_packed_git_idx(const char *path, struct packed_git *p)
542 struct pack_idx_header *hdr;
544 uint32_t version, nr, i, *index;
545 int fd = git_open_noatime(path);
550 if (fstat(fd, &st)) {
554 idx_size = xsize_t(st.st_size);
555 if (idx_size < 4 * 256 + 20 + 20) {
557 return error("index file %s is too small", path);
559 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
563 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
564 version = ntohl(hdr->idx_version);
565 if (version < 2 || version > 2) {
566 munmap(idx_map, idx_size);
567 return error("index file %s is version %"PRIu32
568 " and is not supported by this binary"
569 " (try upgrading GIT to a newer version)",
578 index += 2; /* skip index header */
579 for (i = 0; i < 256; i++) {
580 uint32_t n = ntohl(index[i]);
582 munmap(idx_map, idx_size);
583 return error("non-monotonic index %s", path);
591 * - 256 index entries 4 bytes each
592 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
593 * - 20-byte SHA1 of the packfile
594 * - 20-byte SHA1 file checksum
596 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
597 munmap(idx_map, idx_size);
598 return error("wrong index v1 file size in %s", path);
600 } else if (version == 2) {
603 * - 8 bytes of header
604 * - 256 index entries 4 bytes each
605 * - 20-byte sha1 entry * nr
606 * - 4-byte crc entry * nr
607 * - 4-byte offset entry * nr
608 * - 20-byte SHA1 of the packfile
609 * - 20-byte SHA1 file checksum
610 * And after the 4-byte offset table might be a
611 * variable sized table containing 8-byte entries
612 * for offsets larger than 2^31.
614 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
615 unsigned long max_size = min_size;
617 max_size += (nr - 1)*8;
618 if (idx_size < min_size || idx_size > max_size) {
619 munmap(idx_map, idx_size);
620 return error("wrong index v2 file size in %s", path);
622 if (idx_size != min_size &&
624 * make sure we can deal with large pack offsets.
625 * 31-bit signed offset won't be enough, neither
626 * 32-bit unsigned one will be.
628 (sizeof(off_t) <= 4)) {
629 munmap(idx_map, idx_size);
630 return error("pack too large for current definition of off_t in %s", path);
634 p->index_version = version;
635 p->index_data = idx_map;
636 p->index_size = idx_size;
641 int open_pack_index(struct packed_git *p)
649 idx_name = xstrdup(p->pack_name);
650 strcpy(idx_name + strlen(idx_name) - strlen(".pack"), ".idx");
651 ret = check_packed_git_idx(idx_name, p);
656 static void scan_windows(struct packed_git *p,
657 struct packed_git **lru_p,
658 struct pack_window **lru_w,
659 struct pack_window **lru_l)
661 struct pack_window *w, *w_l;
663 for (w_l = NULL, w = p->windows; w; w = w->next) {
665 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
675 static int unuse_one_window(struct packed_git *current)
677 struct packed_git *p, *lru_p = NULL;
678 struct pack_window *lru_w = NULL, *lru_l = NULL;
681 scan_windows(current, &lru_p, &lru_w, &lru_l);
682 for (p = packed_git; p; p = p->next)
683 scan_windows(p, &lru_p, &lru_w, &lru_l);
685 munmap(lru_w->base, lru_w->len);
686 pack_mapped -= lru_w->len;
688 lru_l->next = lru_w->next;
690 lru_p->windows = lru_w->next;
698 void release_pack_memory(size_t need)
700 size_t cur = pack_mapped;
701 while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
705 static void mmap_limit_check(size_t length)
707 static size_t limit = 0;
709 limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
714 die("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX,
715 (uintmax_t)length, (uintmax_t)limit);
718 void *xmmap_gently(void *start, size_t length,
719 int prot, int flags, int fd, off_t offset)
723 mmap_limit_check(length);
724 ret = mmap(start, length, prot, flags, fd, offset);
725 if (ret == MAP_FAILED) {
728 release_pack_memory(length);
729 ret = mmap(start, length, prot, flags, fd, offset);
734 void *xmmap(void *start, size_t length,
735 int prot, int flags, int fd, off_t offset)
737 void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
738 if (ret == MAP_FAILED)
739 die_errno("mmap failed");
743 void close_pack_windows(struct packed_git *p)
746 struct pack_window *w = p->windows;
749 die("pack '%s' still has open windows to it",
751 munmap(w->base, w->len);
752 pack_mapped -= w->len;
754 p->windows = w->next;
760 * The LRU pack is the one with the oldest MRU window, preferring packs
761 * with no used windows, or the oldest mtime if it has no windows allocated.
763 static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
765 struct pack_window *w, *this_mru_w;
766 int has_windows_inuse = 0;
769 * Reject this pack if it has windows and the previously selected
770 * one does not. If this pack does not have windows, reject
771 * it if the pack file is newer than the previously selected one.
773 if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
776 for (w = this_mru_w = p->windows; w; w = w->next) {
778 * Reject this pack if any of its windows are in use,
779 * but the previously selected pack did not have any
780 * inuse windows. Otherwise, record that this pack
781 * has windows in use.
784 if (*accept_windows_inuse)
785 has_windows_inuse = 1;
790 if (w->last_used > this_mru_w->last_used)
794 * Reject this pack if it has windows that have been
795 * used more recently than the previously selected pack.
796 * If the previously selected pack had windows inuse and
797 * we have not encountered a window in this pack that is
798 * inuse, skip this check since we prefer a pack with no
799 * inuse windows to one that has inuse windows.
801 if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
802 this_mru_w->last_used > (*mru_w)->last_used)
811 *accept_windows_inuse = has_windows_inuse;
814 static int close_one_pack(void)
816 struct packed_git *p, *lru_p = NULL;
817 struct pack_window *mru_w = NULL;
818 int accept_windows_inuse = 1;
820 for (p = packed_git; p; p = p->next) {
821 if (p->pack_fd == -1)
823 find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
827 close(lru_p->pack_fd);
836 void unuse_pack(struct pack_window **w_cursor)
838 struct pack_window *w = *w_cursor;
845 void close_pack_index(struct packed_git *p)
848 munmap((void *)p->index_data, p->index_size);
849 p->index_data = NULL;
854 * This is used by git-repack in case a newly created pack happens to
855 * contain the same set of objects as an existing one. In that case
856 * the resulting file might be different even if its name would be the
857 * same. It is best to close any reference to the old pack before it is
858 * replaced on disk. Of course no index pointers or windows for given pack
859 * must subsist at this point. If ever objects from this pack are requested
860 * again, the new version of the pack will be reinitialized through
861 * reprepare_packed_git().
863 void free_pack_by_name(const char *pack_name)
865 struct packed_git *p, **pp = &packed_git;
869 if (strcmp(pack_name, p->pack_name) == 0) {
870 clear_delta_base_cache();
871 close_pack_windows(p);
872 if (p->pack_fd != -1) {
877 free(p->bad_object_sha1);
879 if (last_found_pack == p)
880 last_found_pack = NULL;
888 static unsigned int get_max_fd_limit(void)
894 if (!getrlimit(RLIMIT_NOFILE, &lim))
901 long open_max = sysconf(_SC_OPEN_MAX);
905 * Otherwise, we got -1 for one of the two
908 * (1) sysconf() did not understand _SC_OPEN_MAX
909 * and signaled an error with -1; or
910 * (2) sysconf() said there is no limit.
912 * We _could_ clear errno before calling sysconf() to
913 * tell these two cases apart and return a huge number
914 * in the latter case to let the caller cap it to a
915 * value that is not so selfish, but letting the
916 * fallback OPEN_MAX codepath take care of these cases
925 return 1; /* see the caller ;-) */
930 * Do not call this directly as this leaks p->pack_fd on error return;
931 * call open_packed_git() instead.
933 static int open_packed_git_1(struct packed_git *p)
936 struct pack_header hdr;
937 unsigned char sha1[20];
938 unsigned char *idx_sha1;
941 if (!p->index_data && open_pack_index(p))
942 return error("packfile %s index unavailable", p->pack_name);
945 unsigned int max_fds = get_max_fd_limit();
947 /* Save 3 for stdin/stdout/stderr, 22 for work */
949 pack_max_fds = max_fds - 25;
954 while (pack_max_fds <= pack_open_fds && close_one_pack())
957 p->pack_fd = git_open_noatime(p->pack_name);
958 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
962 /* If we created the struct before we had the pack we lack size. */
964 if (!S_ISREG(st.st_mode))
965 return error("packfile %s not a regular file", p->pack_name);
966 p->pack_size = st.st_size;
967 } else if (p->pack_size != st.st_size)
968 return error("packfile %s size changed", p->pack_name);
970 /* We leave these file descriptors open with sliding mmap;
971 * there is no point keeping them open across exec(), though.
973 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
975 return error("cannot determine file descriptor flags");
976 fd_flag |= FD_CLOEXEC;
977 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
978 return error("cannot set FD_CLOEXEC");
980 /* Verify we recognize this pack file format. */
981 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
982 return error("file %s is far too short to be a packfile", p->pack_name);
983 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
984 return error("file %s is not a GIT packfile", p->pack_name);
985 if (!pack_version_ok(hdr.hdr_version))
986 return error("packfile %s is version %"PRIu32" and not"
987 " supported (try upgrading GIT to a newer version)",
988 p->pack_name, ntohl(hdr.hdr_version));
990 /* Verify the pack matches its index. */
991 if (p->num_objects != ntohl(hdr.hdr_entries))
992 return error("packfile %s claims to have %"PRIu32" objects"
993 " while index indicates %"PRIu32" objects",
994 p->pack_name, ntohl(hdr.hdr_entries),
996 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
997 return error("end of packfile %s is unavailable", p->pack_name);
998 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
999 return error("packfile %s signature is unavailable", p->pack_name);
1000 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
1001 if (hashcmp(sha1, idx_sha1))
1002 return error("packfile %s does not match index", p->pack_name);
1006 static int open_packed_git(struct packed_git *p)
1008 if (!open_packed_git_1(p))
1010 if (p->pack_fd != -1) {
1018 static int in_window(struct pack_window *win, off_t offset)
1020 /* We must promise at least 20 bytes (one hash) after the
1021 * offset is available from this window, otherwise the offset
1022 * is not actually in this window and a different window (which
1023 * has that one hash excess) must be used. This is to support
1024 * the object header and delta base parsing routines below.
1026 off_t win_off = win->offset;
1027 return win_off <= offset
1028 && (offset + 20) <= (win_off + win->len);
1031 unsigned char *use_pack(struct packed_git *p,
1032 struct pack_window **w_cursor,
1034 unsigned long *left)
1036 struct pack_window *win = *w_cursor;
1038 /* Since packfiles end in a hash of their content and it's
1039 * pointless to ask for an offset into the middle of that
1040 * hash, and the in_window function above wouldn't match
1041 * don't allow an offset too close to the end of the file.
1043 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
1044 die("packfile %s cannot be accessed", p->pack_name);
1045 if (offset > (p->pack_size - 20))
1046 die("offset beyond end of packfile (truncated pack?)");
1048 if (!win || !in_window(win, offset)) {
1051 for (win = p->windows; win; win = win->next) {
1052 if (in_window(win, offset))
1056 size_t window_align = packed_git_window_size / 2;
1059 if (p->pack_fd == -1 && open_packed_git(p))
1060 die("packfile %s cannot be accessed", p->pack_name);
1062 win = xcalloc(1, sizeof(*win));
1063 win->offset = (offset / window_align) * window_align;
1064 len = p->pack_size - win->offset;
1065 if (len > packed_git_window_size)
1066 len = packed_git_window_size;
1067 win->len = (size_t)len;
1068 pack_mapped += win->len;
1069 while (packed_git_limit < pack_mapped
1070 && unuse_one_window(p))
1072 win->base = xmmap(NULL, win->len,
1073 PROT_READ, MAP_PRIVATE,
1074 p->pack_fd, win->offset);
1075 if (win->base == MAP_FAILED)
1076 die("packfile %s cannot be mapped: %s",
1079 if (!win->offset && win->len == p->pack_size
1080 && !p->do_not_close) {
1086 pack_open_windows++;
1087 if (pack_mapped > peak_pack_mapped)
1088 peak_pack_mapped = pack_mapped;
1089 if (pack_open_windows > peak_pack_open_windows)
1090 peak_pack_open_windows = pack_open_windows;
1091 win->next = p->windows;
1095 if (win != *w_cursor) {
1096 win->last_used = pack_used_ctr++;
1100 offset -= win->offset;
1102 *left = win->len - xsize_t(offset);
1103 return win->base + offset;
1106 static struct packed_git *alloc_packed_git(int extra)
1108 struct packed_git *p = xmalloc(sizeof(*p) + extra);
1109 memset(p, 0, sizeof(*p));
1114 static void try_to_free_pack_memory(size_t size)
1116 release_pack_memory(size);
1119 struct packed_git *add_packed_git(const char *path, int path_len, int local)
1121 static int have_set_try_to_free_routine;
1123 struct packed_git *p = alloc_packed_git(path_len + 2);
1125 if (!have_set_try_to_free_routine) {
1126 have_set_try_to_free_routine = 1;
1127 set_try_to_free_routine(try_to_free_pack_memory);
1131 * Make sure a corresponding .pack file exists and that
1132 * the index looks sane.
1134 path_len -= strlen(".idx");
1139 memcpy(p->pack_name, path, path_len);
1141 strcpy(p->pack_name + path_len, ".keep");
1142 if (!access(p->pack_name, F_OK))
1145 strcpy(p->pack_name + path_len, ".pack");
1146 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
1151 /* ok, it looks sane as far as we can check without
1152 * actually mapping the pack file.
1154 p->pack_size = st.st_size;
1155 p->pack_local = local;
1156 p->mtime = st.st_mtime;
1157 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
1162 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
1164 const char *path = sha1_pack_name(sha1);
1165 struct packed_git *p = alloc_packed_git(strlen(path) + 1);
1167 strcpy(p->pack_name, path);
1168 hashcpy(p->sha1, sha1);
1169 if (check_packed_git_idx(idx_path, p)) {
1177 void install_packed_git(struct packed_git *pack)
1179 if (pack->pack_fd != -1)
1182 pack->next = packed_git;
1186 void (*report_garbage)(unsigned seen_bits, const char *path);
1188 static void report_helper(const struct string_list *list,
1189 int seen_bits, int first, int last)
1191 if (seen_bits == (PACKDIR_FILE_PACK|PACKDIR_FILE_IDX))
1194 for (; first < last; first++)
1195 report_garbage(seen_bits, list->items[first].string);
1198 static void report_pack_garbage(struct string_list *list)
1200 int i, baselen = -1, first = 0, seen_bits = 0;
1202 if (!report_garbage)
1205 string_list_sort(list);
1207 for (i = 0; i < list->nr; i++) {
1208 const char *path = list->items[i].string;
1209 if (baselen != -1 &&
1210 strncmp(path, list->items[first].string, baselen)) {
1211 report_helper(list, seen_bits, first, i);
1215 if (baselen == -1) {
1216 const char *dot = strrchr(path, '.');
1218 report_garbage(PACKDIR_FILE_GARBAGE, path);
1221 baselen = dot - path + 1;
1224 if (!strcmp(path + baselen, "pack"))
1226 else if (!strcmp(path + baselen, "idx"))
1229 report_helper(list, seen_bits, first, list->nr);
1232 static void prepare_packed_git_one(char *objdir, int local)
1234 struct strbuf path = STRBUF_INIT;
1238 struct string_list garbage = STRING_LIST_INIT_DUP;
1240 strbuf_addstr(&path, objdir);
1241 strbuf_addstr(&path, "/pack");
1242 dir = opendir(path.buf);
1244 if (errno != ENOENT)
1245 error("unable to open object pack directory: %s: %s",
1246 path.buf, strerror(errno));
1247 strbuf_release(&path);
1250 strbuf_addch(&path, '/');
1251 dirnamelen = path.len;
1252 while ((de = readdir(dir)) != NULL) {
1253 struct packed_git *p;
1256 if (is_dot_or_dotdot(de->d_name))
1259 strbuf_setlen(&path, dirnamelen);
1260 strbuf_addstr(&path, de->d_name);
1262 base_len = path.len;
1263 if (strip_suffix_mem(path.buf, &base_len, ".idx")) {
1264 /* Don't reopen a pack we already have. */
1265 for (p = packed_git; p; p = p->next) {
1267 if (strip_suffix(p->pack_name, ".pack", &len) &&
1269 !memcmp(p->pack_name, path.buf, len))
1274 * See if it really is a valid .idx file with
1275 * corresponding .pack file that we can map.
1277 (p = add_packed_git(path.buf, path.len, local)) != NULL)
1278 install_packed_git(p);
1281 if (!report_garbage)
1284 if (ends_with(de->d_name, ".idx") ||
1285 ends_with(de->d_name, ".pack") ||
1286 ends_with(de->d_name, ".bitmap") ||
1287 ends_with(de->d_name, ".keep"))
1288 string_list_append(&garbage, path.buf);
1290 report_garbage(PACKDIR_FILE_GARBAGE, path.buf);
1293 report_pack_garbage(&garbage);
1294 string_list_clear(&garbage, 0);
1295 strbuf_release(&path);
1298 static int sort_pack(const void *a_, const void *b_)
1300 struct packed_git *a = *((struct packed_git **)a_);
1301 struct packed_git *b = *((struct packed_git **)b_);
1305 * Local packs tend to contain objects specific to our
1306 * variant of the project than remote ones. In addition,
1307 * remote ones could be on a network mounted filesystem.
1308 * Favor local ones for these reasons.
1310 st = a->pack_local - b->pack_local;
1315 * Younger packs tend to contain more recent objects,
1316 * and more recent objects tend to get accessed more
1319 if (a->mtime < b->mtime)
1321 else if (a->mtime == b->mtime)
1326 static void rearrange_packed_git(void)
1328 struct packed_git **ary, *p;
1331 for (n = 0, p = packed_git; p; p = p->next)
1336 /* prepare an array of packed_git for easier sorting */
1337 ary = xcalloc(n, sizeof(struct packed_git *));
1338 for (n = 0, p = packed_git; p; p = p->next)
1341 qsort(ary, n, sizeof(struct packed_git *), sort_pack);
1343 /* link them back again */
1344 for (i = 0; i < n - 1; i++)
1345 ary[i]->next = ary[i + 1];
1346 ary[n - 1]->next = NULL;
1347 packed_git = ary[0];
1352 static int prepare_packed_git_run_once = 0;
1353 void prepare_packed_git(void)
1355 struct alternate_object_database *alt;
1357 if (prepare_packed_git_run_once)
1359 prepare_packed_git_one(get_object_directory(), 1);
1361 for (alt = alt_odb_list; alt; alt = alt->next) {
1363 prepare_packed_git_one(alt->base, 0);
1364 alt->name[-1] = '/';
1366 rearrange_packed_git();
1367 prepare_packed_git_run_once = 1;
1370 void reprepare_packed_git(void)
1372 prepare_packed_git_run_once = 0;
1373 prepare_packed_git();
1376 static void mark_bad_packed_object(struct packed_git *p,
1377 const unsigned char *sha1)
1380 for (i = 0; i < p->num_bad_objects; i++)
1381 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1383 p->bad_object_sha1 = xrealloc(p->bad_object_sha1, 20 * (p->num_bad_objects + 1));
1384 hashcpy(p->bad_object_sha1 + 20 * p->num_bad_objects, sha1);
1385 p->num_bad_objects++;
1388 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1390 struct packed_git *p;
1393 for (p = packed_git; p; p = p->next)
1394 for (i = 0; i < p->num_bad_objects; i++)
1395 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1401 * With an in-core object data in "map", rehash it to make sure the
1402 * object name actually matches "sha1" to detect object corruption.
1403 * With "map" == NULL, try reading the object named with "sha1" using
1404 * the streaming interface and rehash it to do the same.
1406 int check_sha1_signature(const unsigned char *sha1, void *map,
1407 unsigned long size, const char *type)
1409 unsigned char real_sha1[20];
1410 enum object_type obj_type;
1411 struct git_istream *st;
1417 hash_sha1_file(map, size, type, real_sha1);
1418 return hashcmp(sha1, real_sha1) ? -1 : 0;
1421 st = open_istream(sha1, &obj_type, &size, NULL);
1425 /* Generate the header */
1426 hdrlen = sprintf(hdr, "%s %lu", typename(obj_type), size) + 1;
1430 git_SHA1_Update(&c, hdr, hdrlen);
1432 char buf[1024 * 16];
1433 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1441 git_SHA1_Update(&c, buf, readlen);
1443 git_SHA1_Final(real_sha1, &c);
1445 return hashcmp(sha1, real_sha1) ? -1 : 0;
1448 int git_open_noatime(const char *name)
1450 static int sha1_file_open_flag = O_NOATIME;
1453 int fd = open(name, O_RDONLY | sha1_file_open_flag);
1457 /* Might the failure be due to O_NOATIME? */
1458 if (errno != ENOENT && sha1_file_open_flag) {
1459 sha1_file_open_flag = 0;
1467 static int stat_sha1_file(const unsigned char *sha1, struct stat *st)
1469 struct alternate_object_database *alt;
1471 if (!lstat(sha1_file_name(sha1), st))
1476 for (alt = alt_odb_list; alt; alt = alt->next) {
1477 fill_sha1_path(alt->name, sha1);
1478 if (!lstat(alt->base, st))
1485 static int open_sha1_file(const unsigned char *sha1)
1488 struct alternate_object_database *alt;
1489 int most_interesting_errno;
1491 fd = git_open_noatime(sha1_file_name(sha1));
1494 most_interesting_errno = errno;
1497 for (alt = alt_odb_list; alt; alt = alt->next) {
1498 fill_sha1_path(alt->name, sha1);
1499 fd = git_open_noatime(alt->base);
1502 if (most_interesting_errno == ENOENT)
1503 most_interesting_errno = errno;
1505 errno = most_interesting_errno;
1509 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1514 fd = open_sha1_file(sha1);
1519 if (!fstat(fd, &st)) {
1520 *size = xsize_t(st.st_size);
1522 /* mmap() is forbidden on empty files */
1523 error("object file %s is empty", sha1_file_name(sha1));
1526 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1533 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1534 unsigned long len, enum object_type *type, unsigned long *sizep)
1537 unsigned long size, c;
1538 unsigned long used = 0;
1541 *type = (c >> 4) & 7;
1545 if (len <= used || bitsizeof(long) <= shift) {
1546 error("bad object header");
1551 size += (c & 0x7f) << shift;
1558 int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz)
1560 /* Get the data stream */
1561 memset(stream, 0, sizeof(*stream));
1562 stream->next_in = map;
1563 stream->avail_in = mapsize;
1564 stream->next_out = buffer;
1565 stream->avail_out = bufsiz;
1567 git_inflate_init(stream);
1568 return git_inflate(stream, 0);
1571 static int unpack_sha1_header_to_strbuf(git_zstream *stream, unsigned char *map,
1572 unsigned long mapsize, void *buffer,
1573 unsigned long bufsiz, struct strbuf *header)
1577 status = unpack_sha1_header(stream, map, mapsize, buffer, bufsiz);
1580 * Check if entire header is unpacked in the first iteration.
1582 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1586 * buffer[0..bufsiz] was not large enough. Copy the partial
1587 * result out to header, and then append the result of further
1588 * reading the stream.
1590 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1591 stream->next_out = buffer;
1592 stream->avail_out = bufsiz;
1595 status = git_inflate(stream, 0);
1596 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1597 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1599 stream->next_out = buffer;
1600 stream->avail_out = bufsiz;
1601 } while (status != Z_STREAM_END);
1605 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1607 int bytes = strlen(buffer) + 1;
1608 unsigned char *buf = xmallocz(size);
1612 n = stream->total_out - bytes;
1615 memcpy(buf, (char *) buffer + bytes, n);
1617 if (bytes <= size) {
1619 * The above condition must be (bytes <= size), not
1620 * (bytes < size). In other words, even though we
1621 * expect no more output and set avail_out to zero,
1622 * the input zlib stream may have bytes that express
1623 * "this concludes the stream", and we *do* want to
1626 * Otherwise we would not be able to test that we
1627 * consumed all the input to reach the expected size;
1628 * we also want to check that zlib tells us that all
1629 * went well with status == Z_STREAM_END at the end.
1631 stream->next_out = buf + bytes;
1632 stream->avail_out = size - bytes;
1633 while (status == Z_OK)
1634 status = git_inflate(stream, Z_FINISH);
1636 if (status == Z_STREAM_END && !stream->avail_in) {
1637 git_inflate_end(stream);
1642 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1643 else if (stream->avail_in)
1644 error("garbage at end of loose object '%s'",
1651 * We used to just use "sscanf()", but that's actually way
1652 * too permissive for what we want to check. So do an anal
1653 * object header parse by hand.
1655 static int parse_sha1_header_extended(const char *hdr, struct object_info *oi,
1658 const char *type_buf = hdr;
1660 int type, type_len = 0;
1663 * The type can be of any size but is followed by
1673 type = type_from_string_gently(type_buf, type_len, 1);
1675 strbuf_add(oi->typename, type_buf, type_len);
1677 * Set type to 0 if its an unknown object and
1678 * we're obtaining the type using '--allow-unkown-type'
1681 if ((flags & LOOKUP_UNKNOWN_OBJECT) && (type < 0))
1684 die("invalid object type");
1689 * The length must follow immediately, and be in canonical
1690 * decimal format (ie "010" is not valid).
1692 size = *hdr++ - '0';
1697 unsigned long c = *hdr - '0';
1701 size = size * 10 + c;
1709 * The length must be followed by a zero byte
1711 return *hdr ? -1 : type;
1714 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1716 struct object_info oi;
1721 return parse_sha1_header_extended(hdr, &oi, LOOKUP_REPLACE_OBJECT);
1724 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1730 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1731 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1734 return unpack_sha1_rest(&stream, hdr, *size, sha1);
1737 unsigned long get_size_from_delta(struct packed_git *p,
1738 struct pack_window **w_curs,
1741 const unsigned char *data;
1742 unsigned char delta_head[20], *in;
1746 memset(&stream, 0, sizeof(stream));
1747 stream.next_out = delta_head;
1748 stream.avail_out = sizeof(delta_head);
1750 git_inflate_init(&stream);
1752 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1753 stream.next_in = in;
1754 st = git_inflate(&stream, Z_FINISH);
1755 curpos += stream.next_in - in;
1756 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1757 stream.total_out < sizeof(delta_head));
1758 git_inflate_end(&stream);
1759 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1760 error("delta data unpack-initial failed");
1764 /* Examine the initial part of the delta to figure out
1769 /* ignore base size */
1770 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1772 /* Read the result size */
1773 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1776 static off_t get_delta_base(struct packed_git *p,
1777 struct pack_window **w_curs,
1779 enum object_type type,
1780 off_t delta_obj_offset)
1782 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1785 /* use_pack() assured us we have [base_info, base_info + 20)
1786 * as a range that we can look at without walking off the
1787 * end of the mapped window. Its actually the hash size
1788 * that is assured. An OFS_DELTA longer than the hash size
1789 * is stupid, as then a REF_DELTA would be smaller to store.
1791 if (type == OBJ_OFS_DELTA) {
1793 unsigned char c = base_info[used++];
1794 base_offset = c & 127;
1797 if (!base_offset || MSB(base_offset, 7))
1798 return 0; /* overflow */
1799 c = base_info[used++];
1800 base_offset = (base_offset << 7) + (c & 127);
1802 base_offset = delta_obj_offset - base_offset;
1803 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1804 return 0; /* out of bound */
1806 } else if (type == OBJ_REF_DELTA) {
1807 /* The base entry _must_ be in the same pack */
1808 base_offset = find_pack_entry_one(base_info, p);
1811 die("I am totally screwed");
1816 * Like get_delta_base above, but we return the sha1 instead of the pack
1817 * offset. This means it is cheaper for REF deltas (we do not have to do
1818 * the final object lookup), but more expensive for OFS deltas (we
1819 * have to load the revidx to convert the offset back into a sha1).
1821 static const unsigned char *get_delta_base_sha1(struct packed_git *p,
1822 struct pack_window **w_curs,
1824 enum object_type type,
1825 off_t delta_obj_offset)
1827 if (type == OBJ_REF_DELTA) {
1828 unsigned char *base = use_pack(p, w_curs, curpos, NULL);
1830 } else if (type == OBJ_OFS_DELTA) {
1831 struct revindex_entry *revidx;
1832 off_t base_offset = get_delta_base(p, w_curs, &curpos,
1833 type, delta_obj_offset);
1838 revidx = find_pack_revindex(p, base_offset);
1842 return nth_packed_object_sha1(p, revidx->nr);
1847 int unpack_object_header(struct packed_git *p,
1848 struct pack_window **w_curs,
1850 unsigned long *sizep)
1852 unsigned char *base;
1855 enum object_type type;
1857 /* use_pack() assures us we have [base, base + 20) available
1858 * as a range that we can look at. (Its actually the hash
1859 * size that is assured.) With our object header encoding
1860 * the maximum deflated object size is 2^137, which is just
1861 * insane, so we know won't exceed what we have been given.
1863 base = use_pack(p, w_curs, *curpos, &left);
1864 used = unpack_object_header_buffer(base, left, &type, sizep);
1873 static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
1876 struct revindex_entry *revidx;
1877 const unsigned char *sha1;
1878 revidx = find_pack_revindex(p, obj_offset);
1881 sha1 = nth_packed_object_sha1(p, revidx->nr);
1882 mark_bad_packed_object(p, sha1);
1883 type = sha1_object_info(sha1, NULL);
1884 if (type <= OBJ_NONE)
1889 #define POI_STACK_PREALLOC 64
1891 static enum object_type packed_to_object_type(struct packed_git *p,
1893 enum object_type type,
1894 struct pack_window **w_curs,
1897 off_t small_poi_stack[POI_STACK_PREALLOC];
1898 off_t *poi_stack = small_poi_stack;
1899 int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
1901 while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1904 /* Push the object we're going to leave behind */
1905 if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
1906 poi_stack_alloc = alloc_nr(poi_stack_nr);
1907 poi_stack = xmalloc(sizeof(off_t)*poi_stack_alloc);
1908 memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
1910 ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
1912 poi_stack[poi_stack_nr++] = obj_offset;
1913 /* If parsing the base offset fails, just unwind */
1914 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
1917 curpos = obj_offset = base_offset;
1918 type = unpack_object_header(p, w_curs, &curpos, &size);
1919 if (type <= OBJ_NONE) {
1920 /* If getting the base itself fails, we first
1921 * retry the base, otherwise unwind */
1922 type = retry_bad_packed_offset(p, base_offset);
1923 if (type > OBJ_NONE)
1937 error("unknown object type %i at offset %"PRIuMAX" in %s",
1938 type, (uintmax_t)obj_offset, p->pack_name);
1943 if (poi_stack != small_poi_stack)
1948 while (poi_stack_nr) {
1949 obj_offset = poi_stack[--poi_stack_nr];
1950 type = retry_bad_packed_offset(p, obj_offset);
1951 if (type > OBJ_NONE)
1958 static int packed_object_info(struct packed_git *p, off_t obj_offset,
1959 struct object_info *oi)
1961 struct pack_window *w_curs = NULL;
1963 off_t curpos = obj_offset;
1964 enum object_type type;
1967 * We always get the representation type, but only convert it to
1968 * a "real" type later if the caller is interested.
1970 type = unpack_object_header(p, &w_curs, &curpos, &size);
1973 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1974 off_t tmp_pos = curpos;
1975 off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
1981 *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
1982 if (*oi->sizep == 0) {
1991 if (oi->disk_sizep) {
1992 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
1993 *oi->disk_sizep = revidx[1].offset - obj_offset;
1997 *oi->typep = packed_to_object_type(p, obj_offset, type, &w_curs, curpos);
1998 if (*oi->typep < 0) {
2004 if (oi->delta_base_sha1) {
2005 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
2006 const unsigned char *base;
2008 base = get_delta_base_sha1(p, &w_curs, curpos,
2015 hashcpy(oi->delta_base_sha1, base);
2017 hashclr(oi->delta_base_sha1);
2021 unuse_pack(&w_curs);
2025 static void *unpack_compressed_entry(struct packed_git *p,
2026 struct pack_window **w_curs,
2032 unsigned char *buffer, *in;
2034 buffer = xmallocz_gently(size);
2037 memset(&stream, 0, sizeof(stream));
2038 stream.next_out = buffer;
2039 stream.avail_out = size + 1;
2041 git_inflate_init(&stream);
2043 in = use_pack(p, w_curs, curpos, &stream.avail_in);
2044 stream.next_in = in;
2045 st = git_inflate(&stream, Z_FINISH);
2046 if (!stream.avail_out)
2047 break; /* the payload is larger than it should be */
2048 curpos += stream.next_in - in;
2049 } while (st == Z_OK || st == Z_BUF_ERROR);
2050 git_inflate_end(&stream);
2051 if ((st != Z_STREAM_END) || stream.total_out != size) {
2059 #define MAX_DELTA_CACHE (256)
2061 static size_t delta_base_cached;
2063 static struct delta_base_cache_lru_list {
2064 struct delta_base_cache_lru_list *prev;
2065 struct delta_base_cache_lru_list *next;
2066 } delta_base_cache_lru = { &delta_base_cache_lru, &delta_base_cache_lru };
2068 static struct delta_base_cache_entry {
2069 struct delta_base_cache_lru_list lru;
2071 struct packed_git *p;
2074 enum object_type type;
2075 } delta_base_cache[MAX_DELTA_CACHE];
2077 static unsigned long pack_entry_hash(struct packed_git *p, off_t base_offset)
2081 hash = (unsigned long)p + (unsigned long)base_offset;
2082 hash += (hash >> 8) + (hash >> 16);
2083 return hash % MAX_DELTA_CACHE;
2086 static struct delta_base_cache_entry *
2087 get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
2089 unsigned long hash = pack_entry_hash(p, base_offset);
2090 return delta_base_cache + hash;
2093 static int eq_delta_base_cache_entry(struct delta_base_cache_entry *ent,
2094 struct packed_git *p, off_t base_offset)
2096 return (ent->data && ent->p == p && ent->base_offset == base_offset);
2099 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
2101 struct delta_base_cache_entry *ent;
2102 ent = get_delta_base_cache_entry(p, base_offset);
2103 return eq_delta_base_cache_entry(ent, p, base_offset);
2106 static void clear_delta_base_cache_entry(struct delta_base_cache_entry *ent)
2109 ent->lru.next->prev = ent->lru.prev;
2110 ent->lru.prev->next = ent->lru.next;
2111 delta_base_cached -= ent->size;
2114 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
2115 unsigned long *base_size, enum object_type *type, int keep_cache)
2117 struct delta_base_cache_entry *ent;
2120 ent = get_delta_base_cache_entry(p, base_offset);
2122 if (!eq_delta_base_cache_entry(ent, p, base_offset))
2123 return unpack_entry(p, base_offset, type, base_size);
2128 clear_delta_base_cache_entry(ent);
2130 ret = xmemdupz(ent->data, ent->size);
2132 *base_size = ent->size;
2136 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
2141 ent->lru.next->prev = ent->lru.prev;
2142 ent->lru.prev->next = ent->lru.next;
2143 delta_base_cached -= ent->size;
2147 void clear_delta_base_cache(void)
2150 for (p = 0; p < MAX_DELTA_CACHE; p++)
2151 release_delta_base_cache(&delta_base_cache[p]);
2154 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
2155 void *base, unsigned long base_size, enum object_type type)
2157 unsigned long hash = pack_entry_hash(p, base_offset);
2158 struct delta_base_cache_entry *ent = delta_base_cache + hash;
2159 struct delta_base_cache_lru_list *lru;
2161 release_delta_base_cache(ent);
2162 delta_base_cached += base_size;
2164 for (lru = delta_base_cache_lru.next;
2165 delta_base_cached > delta_base_cache_limit
2166 && lru != &delta_base_cache_lru;
2168 struct delta_base_cache_entry *f = (void *)lru;
2169 if (f->type == OBJ_BLOB)
2170 release_delta_base_cache(f);
2172 for (lru = delta_base_cache_lru.next;
2173 delta_base_cached > delta_base_cache_limit
2174 && lru != &delta_base_cache_lru;
2176 struct delta_base_cache_entry *f = (void *)lru;
2177 release_delta_base_cache(f);
2181 ent->base_offset = base_offset;
2184 ent->size = base_size;
2185 ent->lru.next = &delta_base_cache_lru;
2186 ent->lru.prev = delta_base_cache_lru.prev;
2187 delta_base_cache_lru.prev->next = &ent->lru;
2188 delta_base_cache_lru.prev = &ent->lru;
2191 static void *read_object(const unsigned char *sha1, enum object_type *type,
2192 unsigned long *size);
2194 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
2196 static struct trace_key pack_access = TRACE_KEY_INIT(PACK_ACCESS);
2197 trace_printf_key(&pack_access, "%s %"PRIuMAX"\n",
2198 p->pack_name, (uintmax_t)obj_offset);
2201 int do_check_packed_object_crc;
2203 #define UNPACK_ENTRY_STACK_PREALLOC 64
2204 struct unpack_entry_stack_ent {
2210 void *unpack_entry(struct packed_git *p, off_t obj_offset,
2211 enum object_type *final_type, unsigned long *final_size)
2213 struct pack_window *w_curs = NULL;
2214 off_t curpos = obj_offset;
2217 enum object_type type;
2218 struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
2219 struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
2220 int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
2221 int base_from_cache = 0;
2223 write_pack_access_log(p, obj_offset);
2225 /* PHASE 1: drill down to the innermost base object */
2229 struct delta_base_cache_entry *ent;
2231 ent = get_delta_base_cache_entry(p, curpos);
2232 if (eq_delta_base_cache_entry(ent, p, curpos)) {
2236 clear_delta_base_cache_entry(ent);
2237 base_from_cache = 1;
2241 if (do_check_packed_object_crc && p->index_version > 1) {
2242 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2243 unsigned long len = revidx[1].offset - obj_offset;
2244 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
2245 const unsigned char *sha1 =
2246 nth_packed_object_sha1(p, revidx->nr);
2247 error("bad packed object CRC for %s",
2249 mark_bad_packed_object(p, sha1);
2250 unuse_pack(&w_curs);
2255 type = unpack_object_header(p, &w_curs, &curpos, &size);
2256 if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
2259 base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
2261 error("failed to validate delta base reference "
2262 "at offset %"PRIuMAX" from %s",
2263 (uintmax_t)curpos, p->pack_name);
2264 /* bail to phase 2, in hopes of recovery */
2269 /* push object, proceed to base */
2270 if (delta_stack_nr >= delta_stack_alloc
2271 && delta_stack == small_delta_stack) {
2272 delta_stack_alloc = alloc_nr(delta_stack_nr);
2273 delta_stack = xmalloc(sizeof(*delta_stack)*delta_stack_alloc);
2274 memcpy(delta_stack, small_delta_stack,
2275 sizeof(*delta_stack)*delta_stack_nr);
2277 ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
2279 i = delta_stack_nr++;
2280 delta_stack[i].obj_offset = obj_offset;
2281 delta_stack[i].curpos = curpos;
2282 delta_stack[i].size = size;
2284 curpos = obj_offset = base_offset;
2287 /* PHASE 2: handle the base */
2292 die("BUG in unpack_entry: left loop at a valid delta");
2298 if (!base_from_cache)
2299 data = unpack_compressed_entry(p, &w_curs, curpos, size);
2303 error("unknown object type %i at offset %"PRIuMAX" in %s",
2304 type, (uintmax_t)obj_offset, p->pack_name);
2307 /* PHASE 3: apply deltas in order */
2310 * 'data' holds the base data, or NULL if there was corruption
2312 while (delta_stack_nr) {
2315 unsigned long delta_size, base_size = size;
2321 add_delta_base_cache(p, obj_offset, base, base_size, type);
2325 * We're probably in deep shit, but let's try to fetch
2326 * the required base anyway from another pack or loose.
2327 * This is costly but should happen only in the presence
2328 * of a corrupted pack, and is better than failing outright.
2330 struct revindex_entry *revidx;
2331 const unsigned char *base_sha1;
2332 revidx = find_pack_revindex(p, obj_offset);
2334 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
2335 error("failed to read delta base object %s"
2336 " at offset %"PRIuMAX" from %s",
2337 sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
2339 mark_bad_packed_object(p, base_sha1);
2340 base = read_object(base_sha1, &type, &base_size);
2344 i = --delta_stack_nr;
2345 obj_offset = delta_stack[i].obj_offset;
2346 curpos = delta_stack[i].curpos;
2347 delta_size = delta_stack[i].size;
2352 delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
2355 error("failed to unpack compressed delta "
2356 "at offset %"PRIuMAX" from %s",
2357 (uintmax_t)curpos, p->pack_name);
2362 data = patch_delta(base, base_size,
2363 delta_data, delta_size,
2367 * We could not apply the delta; warn the user, but keep going.
2368 * Our failure will be noticed either in the next iteration of
2369 * the loop, or if this is the final delta, in the caller when
2370 * we return NULL. Those code paths will take care of making
2371 * a more explicit warning and retrying with another copy of
2375 error("failed to apply delta");
2383 unuse_pack(&w_curs);
2385 if (delta_stack != small_delta_stack)
2391 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2394 const unsigned char *index = p->index_data;
2396 if (open_pack_index(p))
2398 index = p->index_data;
2400 if (n >= p->num_objects)
2403 if (p->index_version == 1) {
2404 return index + 24 * n + 4;
2407 return index + 20 * n;
2411 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2413 const unsigned char *index = p->index_data;
2415 if (p->index_version == 1) {
2416 return ntohl(*((uint32_t *)(index + 24 * n)));
2419 index += 8 + p->num_objects * (20 + 4);
2420 off = ntohl(*((uint32_t *)(index + 4 * n)));
2421 if (!(off & 0x80000000))
2423 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2424 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2425 ntohl(*((uint32_t *)(index + 4)));
2429 off_t find_pack_entry_one(const unsigned char *sha1,
2430 struct packed_git *p)
2432 const uint32_t *level1_ofs = p->index_data;
2433 const unsigned char *index = p->index_data;
2434 unsigned hi, lo, stride;
2435 static int use_lookup = -1;
2436 static int debug_lookup = -1;
2438 if (debug_lookup < 0)
2439 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2442 if (open_pack_index(p))
2444 level1_ofs = p->index_data;
2445 index = p->index_data;
2447 if (p->index_version > 1) {
2452 hi = ntohl(level1_ofs[*sha1]);
2453 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2454 if (p->index_version > 1) {
2462 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2463 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2466 use_lookup = !!getenv("GIT_USE_LOOKUP");
2468 int pos = sha1_entry_pos(index, stride, 0,
2469 lo, hi, p->num_objects, sha1);
2472 return nth_packed_object_offset(p, pos);
2476 unsigned mi = (lo + hi) / 2;
2477 int cmp = hashcmp(index + mi * stride, sha1);
2480 printf("lo %u hi %u rg %u mi %u\n",
2481 lo, hi, hi - lo, mi);
2483 return nth_packed_object_offset(p, mi);
2492 int is_pack_valid(struct packed_git *p)
2494 /* An already open pack is known to be valid. */
2495 if (p->pack_fd != -1)
2498 /* If the pack has one window completely covering the
2499 * file size, the pack is known to be valid even if
2500 * the descriptor is not currently open.
2503 struct pack_window *w = p->windows;
2505 if (!w->offset && w->len == p->pack_size)
2509 /* Force the pack to open to prove its valid. */
2510 return !open_packed_git(p);
2513 static int fill_pack_entry(const unsigned char *sha1,
2514 struct pack_entry *e,
2515 struct packed_git *p)
2519 if (p->num_bad_objects) {
2521 for (i = 0; i < p->num_bad_objects; i++)
2522 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2526 offset = find_pack_entry_one(sha1, p);
2531 * We are about to tell the caller where they can locate the
2532 * requested object. We better make sure the packfile is
2533 * still here and can be accessed before supplying that
2534 * answer, as it may have been deleted since the index was
2537 if (!is_pack_valid(p))
2541 hashcpy(e->sha1, sha1);
2546 * Iff a pack file contains the object named by sha1, return true and
2547 * store its location to e.
2549 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2551 struct packed_git *p;
2553 prepare_packed_git();
2557 if (last_found_pack && fill_pack_entry(sha1, e, last_found_pack))
2560 for (p = packed_git; p; p = p->next) {
2561 if (p == last_found_pack)
2562 continue; /* we already checked this one */
2564 if (fill_pack_entry(sha1, e, p)) {
2565 last_found_pack = p;
2572 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2573 struct packed_git *packs)
2575 struct packed_git *p;
2577 for (p = packs; p; p = p->next) {
2578 if (find_pack_entry_one(sha1, p))
2585 static int sha1_loose_object_info(const unsigned char *sha1,
2586 struct object_info *oi,
2590 unsigned long mapsize;
2594 struct strbuf hdrbuf = STRBUF_INIT;
2596 if (oi->delta_base_sha1)
2597 hashclr(oi->delta_base_sha1);
2600 * If we don't care about type or size, then we don't
2601 * need to look inside the object at all. Note that we
2602 * do not optimize out the stat call, even if the
2603 * caller doesn't care about the disk-size, since our
2604 * return value implicitly indicates whether the
2605 * object even exists.
2607 if (!oi->typep && !oi->typename && !oi->sizep) {
2609 if (stat_sha1_file(sha1, &st) < 0)
2612 *oi->disk_sizep = st.st_size;
2616 map = map_sha1_file(sha1, &mapsize);
2620 *oi->disk_sizep = mapsize;
2621 if ((flags & LOOKUP_UNKNOWN_OBJECT)) {
2622 if (unpack_sha1_header_to_strbuf(&stream, map, mapsize, hdr, sizeof(hdr), &hdrbuf) < 0)
2623 status = error("unable to unpack %s header with --allow-unknown-type",
2625 } else if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2626 status = error("unable to unpack %s header",
2630 else if (hdrbuf.len) {
2631 if ((status = parse_sha1_header_extended(hdrbuf.buf, oi, flags)) < 0)
2632 status = error("unable to parse %s header with --allow-unknown-type",
2634 } else if ((status = parse_sha1_header_extended(hdr, oi, flags)) < 0)
2635 status = error("unable to parse %s header", sha1_to_hex(sha1));
2636 git_inflate_end(&stream);
2637 munmap(map, mapsize);
2638 if (status && oi->typep)
2639 *oi->typep = status;
2640 strbuf_release(&hdrbuf);
2644 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi, unsigned flags)
2646 struct cached_object *co;
2647 struct pack_entry e;
2649 enum object_type real_type;
2650 const unsigned char *real = lookup_replace_object_extended(sha1, flags);
2652 co = find_cached_object(real);
2655 *(oi->typep) = co->type;
2657 *(oi->sizep) = co->size;
2659 *(oi->disk_sizep) = 0;
2660 if (oi->delta_base_sha1)
2661 hashclr(oi->delta_base_sha1);
2663 strbuf_addstr(oi->typename, typename(co->type));
2664 oi->whence = OI_CACHED;
2668 if (!find_pack_entry(real, &e)) {
2669 /* Most likely it's a loose object. */
2670 if (!sha1_loose_object_info(real, oi, flags)) {
2671 oi->whence = OI_LOOSE;
2675 /* Not a loose object; someone else may have just packed it. */
2676 reprepare_packed_git();
2677 if (!find_pack_entry(real, &e))
2682 * packed_object_info() does not follow the delta chain to
2683 * find out the real type, unless it is given oi->typep.
2685 if (oi->typename && !oi->typep)
2686 oi->typep = &real_type;
2688 rtype = packed_object_info(e.p, e.offset, oi);
2690 mark_bad_packed_object(e.p, real);
2691 if (oi->typep == &real_type)
2693 return sha1_object_info_extended(real, oi, 0);
2694 } else if (in_delta_base_cache(e.p, e.offset)) {
2695 oi->whence = OI_DBCACHED;
2697 oi->whence = OI_PACKED;
2698 oi->u.packed.offset = e.offset;
2699 oi->u.packed.pack = e.p;
2700 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2701 rtype == OBJ_OFS_DELTA);
2704 strbuf_addstr(oi->typename, typename(*oi->typep));
2705 if (oi->typep == &real_type)
2711 /* returns enum object_type or negative */
2712 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2714 enum object_type type;
2715 struct object_info oi = {NULL};
2719 if (sha1_object_info_extended(sha1, &oi, LOOKUP_REPLACE_OBJECT) < 0)
2724 static void *read_packed_sha1(const unsigned char *sha1,
2725 enum object_type *type, unsigned long *size)
2727 struct pack_entry e;
2730 if (!find_pack_entry(sha1, &e))
2732 data = cache_or_unpack_entry(e.p, e.offset, size, type, 1);
2735 * We're probably in deep shit, but let's try to fetch
2736 * the required object anyway from another pack or loose.
2737 * This should happen only in the presence of a corrupted
2738 * pack, and is better than failing outright.
2740 error("failed to read object %s at offset %"PRIuMAX" from %s",
2741 sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2742 mark_bad_packed_object(e.p, sha1);
2743 data = read_object(sha1, type, size);
2748 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2749 unsigned char *sha1)
2751 struct cached_object *co;
2753 hash_sha1_file(buf, len, typename(type), sha1);
2754 if (has_sha1_file(sha1) || find_cached_object(sha1))
2756 ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
2757 co = &cached_objects[cached_object_nr++];
2760 co->buf = xmalloc(len);
2761 memcpy(co->buf, buf, len);
2762 hashcpy(co->sha1, sha1);
2766 static void *read_object(const unsigned char *sha1, enum object_type *type,
2767 unsigned long *size)
2769 unsigned long mapsize;
2771 struct cached_object *co;
2773 co = find_cached_object(sha1);
2777 return xmemdupz(co->buf, co->size);
2780 buf = read_packed_sha1(sha1, type, size);
2783 map = map_sha1_file(sha1, &mapsize);
2785 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2786 munmap(map, mapsize);
2789 reprepare_packed_git();
2790 return read_packed_sha1(sha1, type, size);
2794 * This function dies on corrupt objects; the callers who want to
2795 * deal with them should arrange to call read_object() and give error
2796 * messages themselves.
2798 void *read_sha1_file_extended(const unsigned char *sha1,
2799 enum object_type *type,
2800 unsigned long *size,
2804 const struct packed_git *p;
2805 const unsigned char *repl = lookup_replace_object_extended(sha1, flag);
2808 data = read_object(repl, type, size);
2812 if (errno && errno != ENOENT)
2813 die_errno("failed to read object %s", sha1_to_hex(sha1));
2815 /* die if we replaced an object with one that does not exist */
2817 die("replacement %s not found for %s",
2818 sha1_to_hex(repl), sha1_to_hex(sha1));
2820 if (has_loose_object(repl)) {
2821 const char *path = sha1_file_name(sha1);
2823 die("loose object %s (stored in %s) is corrupt",
2824 sha1_to_hex(repl), path);
2827 if ((p = has_packed_and_bad(repl)) != NULL)
2828 die("packed object %s (stored in %s) is corrupt",
2829 sha1_to_hex(repl), p->pack_name);
2834 void *read_object_with_reference(const unsigned char *sha1,
2835 const char *required_type_name,
2836 unsigned long *size,
2837 unsigned char *actual_sha1_return)
2839 enum object_type type, required_type;
2841 unsigned long isize;
2842 unsigned char actual_sha1[20];
2844 required_type = type_from_string(required_type_name);
2845 hashcpy(actual_sha1, sha1);
2847 int ref_length = -1;
2848 const char *ref_type = NULL;
2850 buffer = read_sha1_file(actual_sha1, &type, &isize);
2853 if (type == required_type) {
2855 if (actual_sha1_return)
2856 hashcpy(actual_sha1_return, actual_sha1);
2859 /* Handle references */
2860 else if (type == OBJ_COMMIT)
2862 else if (type == OBJ_TAG)
2863 ref_type = "object ";
2868 ref_length = strlen(ref_type);
2870 if (ref_length + 40 > isize ||
2871 memcmp(buffer, ref_type, ref_length) ||
2872 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
2877 /* Now we have the ID of the referred-to object in
2878 * actual_sha1. Check again. */
2882 static void write_sha1_file_prepare(const void *buf, unsigned long len,
2883 const char *type, unsigned char *sha1,
2884 char *hdr, int *hdrlen)
2888 /* Generate the header */
2889 *hdrlen = sprintf(hdr, "%s %lu", type, len)+1;
2893 git_SHA1_Update(&c, hdr, *hdrlen);
2894 git_SHA1_Update(&c, buf, len);
2895 git_SHA1_Final(sha1, &c);
2899 * Move the just written object into its final resting place.
2900 * NEEDSWORK: this should be renamed to finalize_temp_file() as
2901 * "moving" is only a part of what it does, when no patch between
2902 * master to pu changes the call sites of this function.
2904 int move_temp_to_file(const char *tmpfile, const char *filename)
2908 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
2910 else if (link(tmpfile, filename))
2914 * Coda hack - coda doesn't like cross-directory links,
2915 * so we fall back to a rename, which will mean that it
2916 * won't be able to check collisions, but that's not a
2919 * The same holds for FAT formatted media.
2921 * When this succeeds, we just return. We have nothing
2924 if (ret && ret != EEXIST) {
2926 if (!rename(tmpfile, filename))
2930 unlink_or_warn(tmpfile);
2932 if (ret != EEXIST) {
2933 return error("unable to write sha1 filename %s: %s", filename, strerror(ret));
2935 /* FIXME!!! Collision check here ? */
2939 if (adjust_shared_perm(filename))
2940 return error("unable to set permission to '%s'", filename);
2944 static int write_buffer(int fd, const void *buf, size_t len)
2946 if (write_in_full(fd, buf, len) < 0)
2947 return error("file write error (%s)", strerror(errno));
2951 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
2952 unsigned char *sha1)
2956 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2960 /* Finalize a file on disk, and close it. */
2961 static void close_sha1_file(int fd)
2963 if (fsync_object_files)
2964 fsync_or_die(fd, "sha1 file");
2966 die_errno("error when closing sha1 file");
2969 /* Size of directory component, including the ending '/' */
2970 static inline int directory_size(const char *filename)
2972 const char *s = strrchr(filename, '/');
2975 return s - filename + 1;
2979 * This creates a temporary file in the same directory as the final
2982 * We want to avoid cross-directory filename renames, because those
2983 * can have problems on various filesystems (FAT, NFS, Coda).
2985 static int create_tmpfile(char *buffer, size_t bufsiz, const char *filename)
2987 int fd, dirlen = directory_size(filename);
2989 if (dirlen + 20 > bufsiz) {
2990 errno = ENAMETOOLONG;
2993 memcpy(buffer, filename, dirlen);
2994 strcpy(buffer + dirlen, "tmp_obj_XXXXXX");
2995 fd = git_mkstemp_mode(buffer, 0444);
2996 if (fd < 0 && dirlen && errno == ENOENT) {
2997 /* Make sure the directory exists */
2998 memcpy(buffer, filename, dirlen);
2999 buffer[dirlen-1] = 0;
3000 if (mkdir(buffer, 0777) && errno != EEXIST)
3002 if (adjust_shared_perm(buffer))
3006 strcpy(buffer + dirlen - 1, "/tmp_obj_XXXXXX");
3007 fd = git_mkstemp_mode(buffer, 0444);
3012 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
3013 const void *buf, unsigned long len, time_t mtime)
3016 unsigned char compressed[4096];
3019 unsigned char parano_sha1[20];
3020 static char tmp_file[PATH_MAX];
3021 const char *filename = sha1_file_name(sha1);
3023 fd = create_tmpfile(tmp_file, sizeof(tmp_file), filename);
3025 if (errno == EACCES)
3026 return error("insufficient permission for adding an object to repository database %s", get_object_directory());
3028 return error("unable to create temporary file: %s", strerror(errno));
3032 git_deflate_init(&stream, zlib_compression_level);
3033 stream.next_out = compressed;
3034 stream.avail_out = sizeof(compressed);
3037 /* First header.. */
3038 stream.next_in = (unsigned char *)hdr;
3039 stream.avail_in = hdrlen;
3040 while (git_deflate(&stream, 0) == Z_OK)
3042 git_SHA1_Update(&c, hdr, hdrlen);
3044 /* Then the data itself.. */
3045 stream.next_in = (void *)buf;
3046 stream.avail_in = len;
3048 unsigned char *in0 = stream.next_in;
3049 ret = git_deflate(&stream, Z_FINISH);
3050 git_SHA1_Update(&c, in0, stream.next_in - in0);
3051 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
3052 die("unable to write sha1 file");
3053 stream.next_out = compressed;
3054 stream.avail_out = sizeof(compressed);
3055 } while (ret == Z_OK);
3057 if (ret != Z_STREAM_END)
3058 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
3059 ret = git_deflate_end_gently(&stream);
3061 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
3062 git_SHA1_Final(parano_sha1, &c);
3063 if (hashcmp(sha1, parano_sha1) != 0)
3064 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
3066 close_sha1_file(fd);
3071 utb.modtime = mtime;
3072 if (utime(tmp_file, &utb) < 0)
3073 warning("failed utime() on %s: %s",
3074 tmp_file, strerror(errno));
3077 return move_temp_to_file(tmp_file, filename);
3080 static int freshen_loose_object(const unsigned char *sha1)
3082 return check_and_freshen(sha1, 1);
3085 static int freshen_packed_object(const unsigned char *sha1)
3087 struct pack_entry e;
3088 if (!find_pack_entry(sha1, &e))
3092 if (!freshen_file(e.p->pack_name))
3098 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1)
3103 /* Normally if we have it in the pack then we do not bother writing
3104 * it out into .git/objects/??/?{38} file.
3106 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
3107 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3109 return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
3112 int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type,
3113 unsigned char *sha1, unsigned flags)
3116 int hdrlen, status = 0;
3118 /* type string, SP, %lu of the length plus NUL must fit this */
3119 header = xmalloc(strlen(type) + 32);
3120 write_sha1_file_prepare(buf, len, type, sha1, header, &hdrlen);
3122 if (!(flags & HASH_WRITE_OBJECT))
3124 if (freshen_packed_object(sha1) || freshen_loose_object(sha1))
3126 status = write_loose_object(sha1, header, hdrlen, buf, len, 0);
3133 int force_object_loose(const unsigned char *sha1, time_t mtime)
3137 enum object_type type;
3142 if (has_loose_object(sha1))
3144 buf = read_packed_sha1(sha1, &type, &len);
3146 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
3147 hdrlen = sprintf(hdr, "%s %lu", typename(type), len) + 1;
3148 ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
3154 int has_pack_index(const unsigned char *sha1)
3157 if (stat(sha1_pack_index_name(sha1), &st))
3162 int has_sha1_pack(const unsigned char *sha1)
3164 struct pack_entry e;
3165 return find_pack_entry(sha1, &e);
3168 int has_sha1_file_with_flags(const unsigned char *sha1, int flags)
3170 struct pack_entry e;
3172 if (find_pack_entry(sha1, &e))
3174 if (has_loose_object(sha1))
3176 if (flags & HAS_SHA1_QUICK)
3178 reprepare_packed_git();
3179 return find_pack_entry(sha1, &e);
3182 static void check_tree(const void *buf, size_t size)
3184 struct tree_desc desc;
3185 struct name_entry entry;
3187 init_tree_desc(&desc, buf, size);
3188 while (tree_entry(&desc, &entry))
3190 * tree_entry() will die() on malformed entries */
3194 static void check_commit(const void *buf, size_t size)
3197 memset(&c, 0, sizeof(c));
3198 if (parse_commit_buffer(&c, buf, size))
3199 die("corrupt commit");
3202 static void check_tag(const void *buf, size_t size)
3205 memset(&t, 0, sizeof(t));
3206 if (parse_tag_buffer(&t, buf, size))
3210 static int index_mem(unsigned char *sha1, void *buf, size_t size,
3211 enum object_type type,
3212 const char *path, unsigned flags)
3214 int ret, re_allocated = 0;
3215 int write_object = flags & HASH_WRITE_OBJECT;
3221 * Convert blobs to git internal format
3223 if ((type == OBJ_BLOB) && path) {
3224 struct strbuf nbuf = STRBUF_INIT;
3225 if (convert_to_git(path, buf, size, &nbuf,
3226 write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
3227 buf = strbuf_detach(&nbuf, &size);
3231 if (flags & HASH_FORMAT_CHECK) {
3232 if (type == OBJ_TREE)
3233 check_tree(buf, size);
3234 if (type == OBJ_COMMIT)
3235 check_commit(buf, size);
3236 if (type == OBJ_TAG)
3237 check_tag(buf, size);
3241 ret = write_sha1_file(buf, size, typename(type), sha1);
3243 ret = hash_sha1_file(buf, size, typename(type), sha1);
3249 static int index_stream_convert_blob(unsigned char *sha1, int fd,
3250 const char *path, unsigned flags)
3253 const int write_object = flags & HASH_WRITE_OBJECT;
3254 struct strbuf sbuf = STRBUF_INIT;
3257 assert(would_convert_to_git_filter_fd(path));
3259 convert_to_git_filter_fd(path, fd, &sbuf,
3260 write_object ? safe_crlf : SAFE_CRLF_FALSE);
3263 ret = write_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3266 ret = hash_sha1_file(sbuf.buf, sbuf.len, typename(OBJ_BLOB),
3268 strbuf_release(&sbuf);
3272 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
3273 const char *path, unsigned flags)
3275 struct strbuf sbuf = STRBUF_INIT;
3278 if (strbuf_read(&sbuf, fd, 4096) >= 0)
3279 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
3282 strbuf_release(&sbuf);
3286 #define SMALL_FILE_SIZE (32*1024)
3288 static int index_core(unsigned char *sha1, int fd, size_t size,
3289 enum object_type type, const char *path,
3295 ret = index_mem(sha1, "", size, type, path, flags);
3296 } else if (size <= SMALL_FILE_SIZE) {
3297 char *buf = xmalloc(size);
3298 if (size == read_in_full(fd, buf, size))
3299 ret = index_mem(sha1, buf, size, type, path, flags);
3301 ret = error("short read %s", strerror(errno));
3304 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
3305 ret = index_mem(sha1, buf, size, type, path, flags);
3312 * This creates one packfile per large blob unless bulk-checkin
3313 * machinery is "plugged".
3315 * This also bypasses the usual "convert-to-git" dance, and that is on
3316 * purpose. We could write a streaming version of the converting
3317 * functions and insert that before feeding the data to fast-import
3318 * (or equivalent in-core API described above). However, that is
3319 * somewhat complicated, as we do not know the size of the filter
3320 * result, which we need to know beforehand when writing a git object.
3321 * Since the primary motivation for trying to stream from the working
3322 * tree file and to avoid mmaping it in core is to deal with large
3323 * binary blobs, they generally do not want to get any conversion, and
3324 * callers should avoid this code path when filters are requested.
3326 static int index_stream(unsigned char *sha1, int fd, size_t size,
3327 enum object_type type, const char *path,
3330 return index_bulk_checkin(sha1, fd, size, type, path, flags);
3333 int index_fd(unsigned char *sha1, int fd, struct stat *st,
3334 enum object_type type, const char *path, unsigned flags)
3339 * Call xsize_t() only when needed to avoid potentially unnecessary
3340 * die() for large files.
3342 if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(path))
3343 ret = index_stream_convert_blob(sha1, fd, path, flags);
3344 else if (!S_ISREG(st->st_mode))
3345 ret = index_pipe(sha1, fd, type, path, flags);
3346 else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
3347 (path && would_convert_to_git(path)))
3348 ret = index_core(sha1, fd, xsize_t(st->st_size), type, path,
3351 ret = index_stream(sha1, fd, xsize_t(st->st_size), type, path,
3357 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
3360 struct strbuf sb = STRBUF_INIT;
3362 switch (st->st_mode & S_IFMT) {
3364 fd = open(path, O_RDONLY);
3366 return error("open(\"%s\"): %s", path,
3368 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
3369 return error("%s: failed to insert into database",
3373 if (strbuf_readlink(&sb, path, st->st_size)) {
3374 char *errstr = strerror(errno);
3375 return error("readlink(\"%s\"): %s", path,
3378 if (!(flags & HASH_WRITE_OBJECT))
3379 hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
3380 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
3381 return error("%s: failed to insert into database",
3383 strbuf_release(&sb);
3386 return resolve_gitlink_ref(path, "HEAD", sha1);
3388 return error("%s: unsupported file type", path);
3393 int read_pack_header(int fd, struct pack_header *header)
3395 if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
3396 /* "eof before pack header was fully read" */
3397 return PH_ERROR_EOF;
3399 if (header->hdr_signature != htonl(PACK_SIGNATURE))
3400 /* "protocol error (pack signature mismatch detected)" */
3401 return PH_ERROR_PACK_SIGNATURE;
3402 if (!pack_version_ok(header->hdr_version))
3403 /* "protocol error (pack version unsupported)" */
3404 return PH_ERROR_PROTOCOL;
3408 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
3410 enum object_type type = sha1_object_info(sha1, NULL);
3412 die("%s is not a valid object", sha1_to_hex(sha1));
3414 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
3418 static int for_each_file_in_obj_subdir(int subdir_nr,
3419 struct strbuf *path,
3420 each_loose_object_fn obj_cb,
3421 each_loose_cruft_fn cruft_cb,
3422 each_loose_subdir_fn subdir_cb,
3425 size_t baselen = path->len;
3426 DIR *dir = opendir(path->buf);
3431 if (errno == ENOENT)
3433 return error("unable to open %s: %s", path->buf, strerror(errno));
3436 while ((de = readdir(dir))) {
3437 if (is_dot_or_dotdot(de->d_name))
3440 strbuf_setlen(path, baselen);
3441 strbuf_addf(path, "/%s", de->d_name);
3443 if (strlen(de->d_name) == 38) {
3445 unsigned char sha1[20];
3447 snprintf(hex, sizeof(hex), "%02x%s",
3448 subdir_nr, de->d_name);
3449 if (!get_sha1_hex(hex, sha1)) {
3451 r = obj_cb(sha1, path->buf, data);
3460 r = cruft_cb(de->d_name, path->buf, data);
3465 strbuf_setlen(path, baselen);
3467 if (!r && subdir_cb)
3468 r = subdir_cb(subdir_nr, path->buf, data);
3474 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
3475 each_loose_object_fn obj_cb,
3476 each_loose_cruft_fn cruft_cb,
3477 each_loose_subdir_fn subdir_cb,
3480 size_t baselen = path->len;
3484 for (i = 0; i < 256; i++) {
3485 strbuf_addf(path, "/%02x", i);
3486 r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
3488 strbuf_setlen(path, baselen);
3496 int for_each_loose_file_in_objdir(const char *path,
3497 each_loose_object_fn obj_cb,
3498 each_loose_cruft_fn cruft_cb,
3499 each_loose_subdir_fn subdir_cb,
3502 struct strbuf buf = STRBUF_INIT;
3505 strbuf_addstr(&buf, path);
3506 r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
3508 strbuf_release(&buf);
3513 struct loose_alt_odb_data {
3514 each_loose_object_fn *cb;
3518 static int loose_from_alt_odb(struct alternate_object_database *alt,
3521 struct loose_alt_odb_data *data = vdata;
3522 struct strbuf buf = STRBUF_INIT;
3525 /* copy base not including trailing '/' */
3526 strbuf_add(&buf, alt->base, alt->name - alt->base - 1);
3527 r = for_each_loose_file_in_objdir_buf(&buf,
3528 data->cb, NULL, NULL,
3530 strbuf_release(&buf);
3534 int for_each_loose_object(each_loose_object_fn cb, void *data, unsigned flags)
3536 struct loose_alt_odb_data alt;
3539 r = for_each_loose_file_in_objdir(get_object_directory(),
3540 cb, NULL, NULL, data);
3544 if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
3549 return foreach_alt_odb(loose_from_alt_odb, &alt);
3552 static int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn cb, void *data)
3557 for (i = 0; i < p->num_objects; i++) {
3558 const unsigned char *sha1 = nth_packed_object_sha1(p, i);
3561 return error("unable to get sha1 of object %u in %s",
3564 r = cb(sha1, p, i, data);
3571 int for_each_packed_object(each_packed_object_fn cb, void *data, unsigned flags)
3573 struct packed_git *p;
3575 int pack_errors = 0;
3577 prepare_packed_git();
3578 for (p = packed_git; p; p = p->next) {
3579 if ((flags & FOR_EACH_OBJECT_LOCAL_ONLY) && !p->pack_local)
3581 if (open_pack_index(p)) {
3585 r = for_each_object_in_pack(p, cb, data);
3589 return r ? r : pack_errors;