status: show commit sha1 in "You are currently reverting" message
[git.git] / sha1_file.c
blob16967d3b9a86dc481a5161f0a98220e05790ca01
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
6 * This handles basic git sha1 object files - packing, unpacking,
7 * creation etc.
8 */
9 #include "cache.h"
10 #include "string-list.h"
11 #include "delta.h"
12 #include "pack.h"
13 #include "blob.h"
14 #include "commit.h"
15 #include "run-command.h"
16 #include "tag.h"
17 #include "tree.h"
18 #include "tree-walk.h"
19 #include "refs.h"
20 #include "pack-revindex.h"
21 #include "sha1-lookup.h"
22 #include "bulk-checkin.h"
23 #include "streaming.h"
24 #include "dir.h"
26 #ifndef O_NOATIME
27 #if defined(__linux__) && (defined(__i386__) || defined(__PPC__))
28 #define O_NOATIME 01000000
29 #else
30 #define O_NOATIME 0
31 #endif
32 #endif
34 #define SZ_FMT PRIuMAX
35 static inline uintmax_t sz_fmt(size_t s) { return s; }
37 const unsigned char null_sha1[20];
40 * This is meant to hold a *small* number of objects that you would
41 * want read_sha1_file() to be able to return, but yet you do not want
42 * to write them into the object store (e.g. a browse-only
43 * application).
45 static struct cached_object {
46 unsigned char sha1[20];
47 enum object_type type;
48 void *buf;
49 unsigned long size;
50 } *cached_objects;
51 static int cached_object_nr, cached_object_alloc;
53 static struct cached_object empty_tree = {
54 EMPTY_TREE_SHA1_BIN_LITERAL,
55 OBJ_TREE,
56 "",
60 static struct packed_git *last_found_pack;
62 static struct cached_object *find_cached_object(const unsigned char *sha1)
64 int i;
65 struct cached_object *co = cached_objects;
67 for (i = 0; i < cached_object_nr; i++, co++) {
68 if (!hashcmp(co->sha1, sha1))
69 return co;
71 if (!hashcmp(sha1, empty_tree.sha1))
72 return &empty_tree;
73 return NULL;
76 int mkdir_in_gitdir(const char *path)
78 if (mkdir(path, 0777)) {
79 int saved_errno = errno;
80 struct stat st;
81 struct strbuf sb = STRBUF_INIT;
83 if (errno != EEXIST)
84 return -1;
86 * Are we looking at a path in a symlinked worktree
87 * whose original repository does not yet have it?
88 * e.g. .git/rr-cache pointing at its original
89 * repository in which the user hasn't performed any
90 * conflict resolution yet?
92 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
93 strbuf_readlink(&sb, path, st.st_size) ||
94 !is_absolute_path(sb.buf) ||
95 mkdir(sb.buf, 0777)) {
96 strbuf_release(&sb);
97 errno = saved_errno;
98 return -1;
100 strbuf_release(&sb);
102 return adjust_shared_perm(path);
105 int safe_create_leading_directories(char *path)
107 char *pos = path + offset_1st_component(path);
108 struct stat st;
110 while (pos) {
111 pos = strchr(pos, '/');
112 if (!pos)
113 break;
114 while (*++pos == '/')
116 if (!*pos)
117 break;
118 *--pos = '\0';
119 if (!stat(path, &st)) {
120 /* path exists */
121 if (!S_ISDIR(st.st_mode)) {
122 *pos = '/';
123 return -3;
126 else if (mkdir(path, 0777)) {
127 *pos = '/';
128 return -1;
130 else if (adjust_shared_perm(path)) {
131 *pos = '/';
132 return -2;
134 *pos++ = '/';
136 return 0;
139 int safe_create_leading_directories_const(const char *path)
141 /* path points to cache entries, so xstrdup before messing with it */
142 char *buf = xstrdup(path);
143 int result = safe_create_leading_directories(buf);
144 free(buf);
145 return result;
148 static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
150 int i;
151 for (i = 0; i < 20; i++) {
152 static char hex[] = "0123456789abcdef";
153 unsigned int val = sha1[i];
154 char *pos = pathbuf + i*2 + (i > 0);
155 *pos++ = hex[val >> 4];
156 *pos = hex[val & 0xf];
161 * NOTE! This returns a statically allocated buffer, so you have to be
162 * careful about using it. Do an "xstrdup()" if you need to save the
163 * filename.
165 * Also note that this returns the location for creating. Reading
166 * SHA1 file can happen from any alternate directory listed in the
167 * DB_ENVIRONMENT environment variable if it is not found in
168 * the primary object database.
170 char *sha1_file_name(const unsigned char *sha1)
172 static char buf[PATH_MAX];
173 const char *objdir;
174 int len;
176 objdir = get_object_directory();
177 len = strlen(objdir);
179 /* '/' + sha1(2) + '/' + sha1(38) + '\0' */
180 if (len + 43 > PATH_MAX)
181 die("insanely long object directory %s", objdir);
182 memcpy(buf, objdir, len);
183 buf[len] = '/';
184 buf[len+3] = '/';
185 buf[len+42] = '\0';
186 fill_sha1_path(buf + len + 1, sha1);
187 return buf;
190 static char *sha1_get_pack_name(const unsigned char *sha1,
191 char **name, char **base, const char *which)
193 static const char hex[] = "0123456789abcdef";
194 char *buf;
195 int i;
197 if (!*base) {
198 const char *sha1_file_directory = get_object_directory();
199 int len = strlen(sha1_file_directory);
200 *base = xmalloc(len + 60);
201 sprintf(*base, "%s/pack/pack-1234567890123456789012345678901234567890.%s",
202 sha1_file_directory, which);
203 *name = *base + len + 11;
206 buf = *name;
208 for (i = 0; i < 20; i++) {
209 unsigned int val = *sha1++;
210 *buf++ = hex[val >> 4];
211 *buf++ = hex[val & 0xf];
214 return *base;
217 char *sha1_pack_name(const unsigned char *sha1)
219 static char *name, *base;
221 return sha1_get_pack_name(sha1, &name, &base, "pack");
224 char *sha1_pack_index_name(const unsigned char *sha1)
226 static char *name, *base;
228 return sha1_get_pack_name(sha1, &name, &base, "idx");
231 struct alternate_object_database *alt_odb_list;
232 static struct alternate_object_database **alt_odb_tail;
234 static int git_open_noatime(const char *name);
237 * Prepare alternate object database registry.
239 * The variable alt_odb_list points at the list of struct
240 * alternate_object_database. The elements on this list come from
241 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
242 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
243 * whose contents is similar to that environment variable but can be
244 * LF separated. Its base points at a statically allocated buffer that
245 * contains "/the/directory/corresponding/to/.git/objects/...", while
246 * its name points just after the slash at the end of ".git/objects/"
247 * in the example above, and has enough space to hold 40-byte hex
248 * SHA1, an extra slash for the first level indirection, and the
249 * terminating NUL.
251 static int link_alt_odb_entry(const char *entry, const char *relative_base, int depth)
253 const char *objdir = get_object_directory();
254 struct alternate_object_database *ent;
255 struct alternate_object_database *alt;
256 int pfxlen, entlen;
257 struct strbuf pathbuf = STRBUF_INIT;
259 if (!is_absolute_path(entry) && relative_base) {
260 strbuf_addstr(&pathbuf, real_path(relative_base));
261 strbuf_addch(&pathbuf, '/');
263 strbuf_addstr(&pathbuf, entry);
265 normalize_path_copy(pathbuf.buf, pathbuf.buf);
267 pfxlen = strlen(pathbuf.buf);
270 * The trailing slash after the directory name is given by
271 * this function at the end. Remove duplicates.
273 while (pfxlen && pathbuf.buf[pfxlen-1] == '/')
274 pfxlen -= 1;
276 entlen = pfxlen + 43; /* '/' + 2 hex + '/' + 38 hex + NUL */
277 ent = xmalloc(sizeof(*ent) + entlen);
278 memcpy(ent->base, pathbuf.buf, pfxlen);
279 strbuf_release(&pathbuf);
281 ent->name = ent->base + pfxlen + 1;
282 ent->base[pfxlen + 3] = '/';
283 ent->base[pfxlen] = ent->base[entlen-1] = 0;
285 /* Detect cases where alternate disappeared */
286 if (!is_directory(ent->base)) {
287 error("object directory %s does not exist; "
288 "check .git/objects/info/alternates.",
289 ent->base);
290 free(ent);
291 return -1;
294 /* Prevent the common mistake of listing the same
295 * thing twice, or object directory itself.
297 for (alt = alt_odb_list; alt; alt = alt->next) {
298 if (!memcmp(ent->base, alt->base, pfxlen)) {
299 free(ent);
300 return -1;
303 if (!strcmp(ent->base, objdir)) {
304 free(ent);
305 return -1;
308 /* add the alternate entry */
309 *alt_odb_tail = ent;
310 alt_odb_tail = &(ent->next);
311 ent->next = NULL;
313 /* recursively add alternates */
314 read_info_alternates(ent->base, depth + 1);
316 ent->base[pfxlen] = '/';
318 return 0;
321 static void link_alt_odb_entries(const char *alt, int len, int sep,
322 const char *relative_base, int depth)
324 struct string_list entries = STRING_LIST_INIT_NODUP;
325 char *alt_copy;
326 int i;
328 if (depth > 5) {
329 error("%s: ignoring alternate object stores, nesting too deep.",
330 relative_base);
331 return;
334 alt_copy = xmemdupz(alt, len);
335 string_list_split_in_place(&entries, alt_copy, sep, -1);
336 for (i = 0; i < entries.nr; i++) {
337 const char *entry = entries.items[i].string;
338 if (entry[0] == '\0' || entry[0] == '#')
339 continue;
340 if (!is_absolute_path(entry) && depth) {
341 error("%s: ignoring relative alternate object store %s",
342 relative_base, entry);
343 } else {
344 link_alt_odb_entry(entry, relative_base, depth);
347 string_list_clear(&entries, 0);
348 free(alt_copy);
351 void read_info_alternates(const char * relative_base, int depth)
353 char *map;
354 size_t mapsz;
355 struct stat st;
356 const char alt_file_name[] = "info/alternates";
357 /* Given that relative_base is no longer than PATH_MAX,
358 ensure that "path" has enough space to append "/", the
359 file name, "info/alternates", and a trailing NUL. */
360 char path[PATH_MAX + 1 + sizeof alt_file_name];
361 int fd;
363 sprintf(path, "%s/%s", relative_base, alt_file_name);
364 fd = git_open_noatime(path);
365 if (fd < 0)
366 return;
367 if (fstat(fd, &st) || (st.st_size == 0)) {
368 close(fd);
369 return;
371 mapsz = xsize_t(st.st_size);
372 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
373 close(fd);
375 link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
377 munmap(map, mapsz);
380 void add_to_alternates_file(const char *reference)
382 struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
383 int fd = hold_lock_file_for_append(lock, git_path("objects/info/alternates"), LOCK_DIE_ON_ERROR);
384 char *alt = mkpath("%s\n", reference);
385 write_or_die(fd, alt, strlen(alt));
386 if (commit_lock_file(lock))
387 die("could not close alternates file");
388 if (alt_odb_tail)
389 link_alt_odb_entries(alt, strlen(alt), '\n', NULL, 0);
392 void foreach_alt_odb(alt_odb_fn fn, void *cb)
394 struct alternate_object_database *ent;
396 prepare_alt_odb();
397 for (ent = alt_odb_list; ent; ent = ent->next)
398 if (fn(ent, cb))
399 return;
402 void prepare_alt_odb(void)
404 const char *alt;
406 if (alt_odb_tail)
407 return;
409 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
410 if (!alt) alt = "";
412 alt_odb_tail = &alt_odb_list;
413 link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
415 read_info_alternates(get_object_directory(), 0);
418 static int has_loose_object_local(const unsigned char *sha1)
420 char *name = sha1_file_name(sha1);
421 return !access(name, F_OK);
424 int has_loose_object_nonlocal(const unsigned char *sha1)
426 struct alternate_object_database *alt;
427 prepare_alt_odb();
428 for (alt = alt_odb_list; alt; alt = alt->next) {
429 fill_sha1_path(alt->name, sha1);
430 if (!access(alt->base, F_OK))
431 return 1;
433 return 0;
436 static int has_loose_object(const unsigned char *sha1)
438 return has_loose_object_local(sha1) ||
439 has_loose_object_nonlocal(sha1);
442 static unsigned int pack_used_ctr;
443 static unsigned int pack_mmap_calls;
444 static unsigned int peak_pack_open_windows;
445 static unsigned int pack_open_windows;
446 static unsigned int pack_open_fds;
447 static unsigned int pack_max_fds;
448 static size_t peak_pack_mapped;
449 static size_t pack_mapped;
450 struct packed_git *packed_git;
452 void pack_report(void)
454 fprintf(stderr,
455 "pack_report: getpagesize() = %10" SZ_FMT "\n"
456 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
457 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
458 sz_fmt(getpagesize()),
459 sz_fmt(packed_git_window_size),
460 sz_fmt(packed_git_limit));
461 fprintf(stderr,
462 "pack_report: pack_used_ctr = %10u\n"
463 "pack_report: pack_mmap_calls = %10u\n"
464 "pack_report: pack_open_windows = %10u / %10u\n"
465 "pack_report: pack_mapped = "
466 "%10" SZ_FMT " / %10" SZ_FMT "\n",
467 pack_used_ctr,
468 pack_mmap_calls,
469 pack_open_windows, peak_pack_open_windows,
470 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
473 static int check_packed_git_idx(const char *path, struct packed_git *p)
475 void *idx_map;
476 struct pack_idx_header *hdr;
477 size_t idx_size;
478 uint32_t version, nr, i, *index;
479 int fd = git_open_noatime(path);
480 struct stat st;
482 if (fd < 0)
483 return -1;
484 if (fstat(fd, &st)) {
485 close(fd);
486 return -1;
488 idx_size = xsize_t(st.st_size);
489 if (idx_size < 4 * 256 + 20 + 20) {
490 close(fd);
491 return error("index file %s is too small", path);
493 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
494 close(fd);
496 hdr = idx_map;
497 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
498 version = ntohl(hdr->idx_version);
499 if (version < 2 || version > 2) {
500 munmap(idx_map, idx_size);
501 return error("index file %s is version %"PRIu32
502 " and is not supported by this binary"
503 " (try upgrading GIT to a newer version)",
504 path, version);
506 } else
507 version = 1;
509 nr = 0;
510 index = idx_map;
511 if (version > 1)
512 index += 2; /* skip index header */
513 for (i = 0; i < 256; i++) {
514 uint32_t n = ntohl(index[i]);
515 if (n < nr) {
516 munmap(idx_map, idx_size);
517 return error("non-monotonic index %s", path);
519 nr = n;
522 if (version == 1) {
524 * Total size:
525 * - 256 index entries 4 bytes each
526 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
527 * - 20-byte SHA1 of the packfile
528 * - 20-byte SHA1 file checksum
530 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
531 munmap(idx_map, idx_size);
532 return error("wrong index v1 file size in %s", path);
534 } else if (version == 2) {
536 * Minimum size:
537 * - 8 bytes of header
538 * - 256 index entries 4 bytes each
539 * - 20-byte sha1 entry * nr
540 * - 4-byte crc entry * nr
541 * - 4-byte offset entry * nr
542 * - 20-byte SHA1 of the packfile
543 * - 20-byte SHA1 file checksum
544 * And after the 4-byte offset table might be a
545 * variable sized table containing 8-byte entries
546 * for offsets larger than 2^31.
548 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
549 unsigned long max_size = min_size;
550 if (nr)
551 max_size += (nr - 1)*8;
552 if (idx_size < min_size || idx_size > max_size) {
553 munmap(idx_map, idx_size);
554 return error("wrong index v2 file size in %s", path);
556 if (idx_size != min_size &&
558 * make sure we can deal with large pack offsets.
559 * 31-bit signed offset won't be enough, neither
560 * 32-bit unsigned one will be.
562 (sizeof(off_t) <= 4)) {
563 munmap(idx_map, idx_size);
564 return error("pack too large for current definition of off_t in %s", path);
568 p->index_version = version;
569 p->index_data = idx_map;
570 p->index_size = idx_size;
571 p->num_objects = nr;
572 return 0;
575 int open_pack_index(struct packed_git *p)
577 char *idx_name;
578 int ret;
580 if (p->index_data)
581 return 0;
583 idx_name = xstrdup(p->pack_name);
584 strcpy(idx_name + strlen(idx_name) - strlen(".pack"), ".idx");
585 ret = check_packed_git_idx(idx_name, p);
586 free(idx_name);
587 return ret;
590 static void scan_windows(struct packed_git *p,
591 struct packed_git **lru_p,
592 struct pack_window **lru_w,
593 struct pack_window **lru_l)
595 struct pack_window *w, *w_l;
597 for (w_l = NULL, w = p->windows; w; w = w->next) {
598 if (!w->inuse_cnt) {
599 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
600 *lru_p = p;
601 *lru_w = w;
602 *lru_l = w_l;
605 w_l = w;
609 static int unuse_one_window(struct packed_git *current, int keep_fd)
611 struct packed_git *p, *lru_p = NULL;
612 struct pack_window *lru_w = NULL, *lru_l = NULL;
614 if (current)
615 scan_windows(current, &lru_p, &lru_w, &lru_l);
616 for (p = packed_git; p; p = p->next)
617 scan_windows(p, &lru_p, &lru_w, &lru_l);
618 if (lru_p) {
619 munmap(lru_w->base, lru_w->len);
620 pack_mapped -= lru_w->len;
621 if (lru_l)
622 lru_l->next = lru_w->next;
623 else {
624 lru_p->windows = lru_w->next;
625 if (!lru_p->windows && lru_p->pack_fd != -1
626 && lru_p->pack_fd != keep_fd) {
627 close(lru_p->pack_fd);
628 pack_open_fds--;
629 lru_p->pack_fd = -1;
632 free(lru_w);
633 pack_open_windows--;
634 return 1;
636 return 0;
639 void release_pack_memory(size_t need, int fd)
641 size_t cur = pack_mapped;
642 while (need >= (cur - pack_mapped) && unuse_one_window(NULL, fd))
643 ; /* nothing */
646 void *xmmap(void *start, size_t length,
647 int prot, int flags, int fd, off_t offset)
649 void *ret = mmap(start, length, prot, flags, fd, offset);
650 if (ret == MAP_FAILED) {
651 if (!length)
652 return NULL;
653 release_pack_memory(length, fd);
654 ret = mmap(start, length, prot, flags, fd, offset);
655 if (ret == MAP_FAILED)
656 die_errno("Out of memory? mmap failed");
658 return ret;
661 void close_pack_windows(struct packed_git *p)
663 while (p->windows) {
664 struct pack_window *w = p->windows;
666 if (w->inuse_cnt)
667 die("pack '%s' still has open windows to it",
668 p->pack_name);
669 munmap(w->base, w->len);
670 pack_mapped -= w->len;
671 pack_open_windows--;
672 p->windows = w->next;
673 free(w);
677 void unuse_pack(struct pack_window **w_cursor)
679 struct pack_window *w = *w_cursor;
680 if (w) {
681 w->inuse_cnt--;
682 *w_cursor = NULL;
686 void close_pack_index(struct packed_git *p)
688 if (p->index_data) {
689 munmap((void *)p->index_data, p->index_size);
690 p->index_data = NULL;
695 * This is used by git-repack in case a newly created pack happens to
696 * contain the same set of objects as an existing one. In that case
697 * the resulting file might be different even if its name would be the
698 * same. It is best to close any reference to the old pack before it is
699 * replaced on disk. Of course no index pointers nor windows for given pack
700 * must subsist at this point. If ever objects from this pack are requested
701 * again, the new version of the pack will be reinitialized through
702 * reprepare_packed_git().
704 void free_pack_by_name(const char *pack_name)
706 struct packed_git *p, **pp = &packed_git;
708 while (*pp) {
709 p = *pp;
710 if (strcmp(pack_name, p->pack_name) == 0) {
711 clear_delta_base_cache();
712 close_pack_windows(p);
713 if (p->pack_fd != -1) {
714 close(p->pack_fd);
715 pack_open_fds--;
717 close_pack_index(p);
718 free(p->bad_object_sha1);
719 *pp = p->next;
720 if (last_found_pack == p)
721 last_found_pack = NULL;
722 free(p);
723 return;
725 pp = &p->next;
729 static unsigned int get_max_fd_limit(void)
731 #ifdef RLIMIT_NOFILE
732 struct rlimit lim;
734 if (getrlimit(RLIMIT_NOFILE, &lim))
735 die_errno("cannot get RLIMIT_NOFILE");
737 return lim.rlim_cur;
738 #elif defined(_SC_OPEN_MAX)
739 return sysconf(_SC_OPEN_MAX);
740 #elif defined(OPEN_MAX)
741 return OPEN_MAX;
742 #else
743 return 1; /* see the caller ;-) */
744 #endif
748 * Do not call this directly as this leaks p->pack_fd on error return;
749 * call open_packed_git() instead.
751 static int open_packed_git_1(struct packed_git *p)
753 struct stat st;
754 struct pack_header hdr;
755 unsigned char sha1[20];
756 unsigned char *idx_sha1;
757 long fd_flag;
759 if (!p->index_data && open_pack_index(p))
760 return error("packfile %s index unavailable", p->pack_name);
762 if (!pack_max_fds) {
763 unsigned int max_fds = get_max_fd_limit();
765 /* Save 3 for stdin/stdout/stderr, 22 for work */
766 if (25 < max_fds)
767 pack_max_fds = max_fds - 25;
768 else
769 pack_max_fds = 1;
772 while (pack_max_fds <= pack_open_fds && unuse_one_window(NULL, -1))
773 ; /* nothing */
775 p->pack_fd = git_open_noatime(p->pack_name);
776 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
777 return -1;
778 pack_open_fds++;
780 /* If we created the struct before we had the pack we lack size. */
781 if (!p->pack_size) {
782 if (!S_ISREG(st.st_mode))
783 return error("packfile %s not a regular file", p->pack_name);
784 p->pack_size = st.st_size;
785 } else if (p->pack_size != st.st_size)
786 return error("packfile %s size changed", p->pack_name);
788 /* We leave these file descriptors open with sliding mmap;
789 * there is no point keeping them open across exec(), though.
791 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
792 if (fd_flag < 0)
793 return error("cannot determine file descriptor flags");
794 fd_flag |= FD_CLOEXEC;
795 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
796 return error("cannot set FD_CLOEXEC");
798 /* Verify we recognize this pack file format. */
799 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
800 return error("file %s is far too short to be a packfile", p->pack_name);
801 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
802 return error("file %s is not a GIT packfile", p->pack_name);
803 if (!pack_version_ok(hdr.hdr_version))
804 return error("packfile %s is version %"PRIu32" and not"
805 " supported (try upgrading GIT to a newer version)",
806 p->pack_name, ntohl(hdr.hdr_version));
808 /* Verify the pack matches its index. */
809 if (p->num_objects != ntohl(hdr.hdr_entries))
810 return error("packfile %s claims to have %"PRIu32" objects"
811 " while index indicates %"PRIu32" objects",
812 p->pack_name, ntohl(hdr.hdr_entries),
813 p->num_objects);
814 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
815 return error("end of packfile %s is unavailable", p->pack_name);
816 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
817 return error("packfile %s signature is unavailable", p->pack_name);
818 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
819 if (hashcmp(sha1, idx_sha1))
820 return error("packfile %s does not match index", p->pack_name);
821 return 0;
824 static int open_packed_git(struct packed_git *p)
826 if (!open_packed_git_1(p))
827 return 0;
828 if (p->pack_fd != -1) {
829 close(p->pack_fd);
830 pack_open_fds--;
831 p->pack_fd = -1;
833 return -1;
836 static int in_window(struct pack_window *win, off_t offset)
838 /* We must promise at least 20 bytes (one hash) after the
839 * offset is available from this window, otherwise the offset
840 * is not actually in this window and a different window (which
841 * has that one hash excess) must be used. This is to support
842 * the object header and delta base parsing routines below.
844 off_t win_off = win->offset;
845 return win_off <= offset
846 && (offset + 20) <= (win_off + win->len);
849 unsigned char *use_pack(struct packed_git *p,
850 struct pack_window **w_cursor,
851 off_t offset,
852 unsigned long *left)
854 struct pack_window *win = *w_cursor;
856 /* Since packfiles end in a hash of their content and it's
857 * pointless to ask for an offset into the middle of that
858 * hash, and the in_window function above wouldn't match
859 * don't allow an offset too close to the end of the file.
861 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
862 die("packfile %s cannot be accessed", p->pack_name);
863 if (offset > (p->pack_size - 20))
864 die("offset beyond end of packfile (truncated pack?)");
866 if (!win || !in_window(win, offset)) {
867 if (win)
868 win->inuse_cnt--;
869 for (win = p->windows; win; win = win->next) {
870 if (in_window(win, offset))
871 break;
873 if (!win) {
874 size_t window_align = packed_git_window_size / 2;
875 off_t len;
877 if (p->pack_fd == -1 && open_packed_git(p))
878 die("packfile %s cannot be accessed", p->pack_name);
880 win = xcalloc(1, sizeof(*win));
881 win->offset = (offset / window_align) * window_align;
882 len = p->pack_size - win->offset;
883 if (len > packed_git_window_size)
884 len = packed_git_window_size;
885 win->len = (size_t)len;
886 pack_mapped += win->len;
887 while (packed_git_limit < pack_mapped
888 && unuse_one_window(p, p->pack_fd))
889 ; /* nothing */
890 win->base = xmmap(NULL, win->len,
891 PROT_READ, MAP_PRIVATE,
892 p->pack_fd, win->offset);
893 if (win->base == MAP_FAILED)
894 die("packfile %s cannot be mapped: %s",
895 p->pack_name,
896 strerror(errno));
897 if (!win->offset && win->len == p->pack_size
898 && !p->do_not_close) {
899 close(p->pack_fd);
900 pack_open_fds--;
901 p->pack_fd = -1;
903 pack_mmap_calls++;
904 pack_open_windows++;
905 if (pack_mapped > peak_pack_mapped)
906 peak_pack_mapped = pack_mapped;
907 if (pack_open_windows > peak_pack_open_windows)
908 peak_pack_open_windows = pack_open_windows;
909 win->next = p->windows;
910 p->windows = win;
913 if (win != *w_cursor) {
914 win->last_used = pack_used_ctr++;
915 win->inuse_cnt++;
916 *w_cursor = win;
918 offset -= win->offset;
919 if (left)
920 *left = win->len - xsize_t(offset);
921 return win->base + offset;
924 static struct packed_git *alloc_packed_git(int extra)
926 struct packed_git *p = xmalloc(sizeof(*p) + extra);
927 memset(p, 0, sizeof(*p));
928 p->pack_fd = -1;
929 return p;
932 static void try_to_free_pack_memory(size_t size)
934 release_pack_memory(size, -1);
937 struct packed_git *add_packed_git(const char *path, int path_len, int local)
939 static int have_set_try_to_free_routine;
940 struct stat st;
941 struct packed_git *p = alloc_packed_git(path_len + 2);
943 if (!have_set_try_to_free_routine) {
944 have_set_try_to_free_routine = 1;
945 set_try_to_free_routine(try_to_free_pack_memory);
949 * Make sure a corresponding .pack file exists and that
950 * the index looks sane.
952 path_len -= strlen(".idx");
953 if (path_len < 1) {
954 free(p);
955 return NULL;
957 memcpy(p->pack_name, path, path_len);
959 strcpy(p->pack_name + path_len, ".keep");
960 if (!access(p->pack_name, F_OK))
961 p->pack_keep = 1;
963 strcpy(p->pack_name + path_len, ".pack");
964 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
965 free(p);
966 return NULL;
969 /* ok, it looks sane as far as we can check without
970 * actually mapping the pack file.
972 p->pack_size = st.st_size;
973 p->pack_local = local;
974 p->mtime = st.st_mtime;
975 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
976 hashclr(p->sha1);
977 return p;
980 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
982 const char *path = sha1_pack_name(sha1);
983 struct packed_git *p = alloc_packed_git(strlen(path) + 1);
985 strcpy(p->pack_name, path);
986 hashcpy(p->sha1, sha1);
987 if (check_packed_git_idx(idx_path, p)) {
988 free(p);
989 return NULL;
992 return p;
995 void install_packed_git(struct packed_git *pack)
997 if (pack->pack_fd != -1)
998 pack_open_fds++;
1000 pack->next = packed_git;
1001 packed_git = pack;
1004 void (*report_garbage)(const char *desc, const char *path);
1006 static void report_helper(const struct string_list *list,
1007 int seen_bits, int first, int last)
1009 const char *msg;
1010 switch (seen_bits) {
1011 case 0:
1012 msg = "no corresponding .idx nor .pack";
1013 break;
1014 case 1:
1015 msg = "no corresponding .idx";
1016 break;
1017 case 2:
1018 msg = "no corresponding .pack";
1019 break;
1020 default:
1021 return;
1023 for (; first < last; first++)
1024 report_garbage(msg, list->items[first].string);
1027 static void report_pack_garbage(struct string_list *list)
1029 int i, baselen = -1, first = 0, seen_bits = 0;
1031 if (!report_garbage)
1032 return;
1034 sort_string_list(list);
1036 for (i = 0; i < list->nr; i++) {
1037 const char *path = list->items[i].string;
1038 if (baselen != -1 &&
1039 strncmp(path, list->items[first].string, baselen)) {
1040 report_helper(list, seen_bits, first, i);
1041 baselen = -1;
1042 seen_bits = 0;
1044 if (baselen == -1) {
1045 const char *dot = strrchr(path, '.');
1046 if (!dot) {
1047 report_garbage("garbage found", path);
1048 continue;
1050 baselen = dot - path + 1;
1051 first = i;
1053 if (!strcmp(path + baselen, "pack"))
1054 seen_bits |= 1;
1055 else if (!strcmp(path + baselen, "idx"))
1056 seen_bits |= 2;
1058 report_helper(list, seen_bits, first, list->nr);
1061 static void prepare_packed_git_one(char *objdir, int local)
1063 /* Ensure that this buffer is large enough so that we can
1064 append "/pack/" without clobbering the stack even if
1065 strlen(objdir) were PATH_MAX. */
1066 char path[PATH_MAX + 1 + 4 + 1 + 1];
1067 int len;
1068 DIR *dir;
1069 struct dirent *de;
1070 struct string_list garbage = STRING_LIST_INIT_DUP;
1072 sprintf(path, "%s/pack", objdir);
1073 len = strlen(path);
1074 dir = opendir(path);
1075 if (!dir) {
1076 if (errno != ENOENT)
1077 error("unable to open object pack directory: %s: %s",
1078 path, strerror(errno));
1079 return;
1081 path[len++] = '/';
1082 while ((de = readdir(dir)) != NULL) {
1083 int namelen = strlen(de->d_name);
1084 struct packed_git *p;
1086 if (len + namelen + 1 > sizeof(path)) {
1087 if (report_garbage) {
1088 struct strbuf sb = STRBUF_INIT;
1089 strbuf_addf(&sb, "%.*s/%s", len - 1, path, de->d_name);
1090 report_garbage("path too long", sb.buf);
1091 strbuf_release(&sb);
1093 continue;
1096 if (is_dot_or_dotdot(de->d_name))
1097 continue;
1099 strcpy(path + len, de->d_name);
1101 if (has_extension(de->d_name, ".idx")) {
1102 /* Don't reopen a pack we already have. */
1103 for (p = packed_git; p; p = p->next) {
1104 if (!memcmp(path, p->pack_name, len + namelen - 4))
1105 break;
1107 if (p == NULL &&
1109 * See if it really is a valid .idx file with
1110 * corresponding .pack file that we can map.
1112 (p = add_packed_git(path, len + namelen, local)) != NULL)
1113 install_packed_git(p);
1116 if (!report_garbage)
1117 continue;
1119 if (has_extension(de->d_name, ".idx") ||
1120 has_extension(de->d_name, ".pack") ||
1121 has_extension(de->d_name, ".keep"))
1122 string_list_append(&garbage, path);
1123 else
1124 report_garbage("garbage found", path);
1126 closedir(dir);
1127 report_pack_garbage(&garbage);
1128 string_list_clear(&garbage, 0);
1131 static int sort_pack(const void *a_, const void *b_)
1133 struct packed_git *a = *((struct packed_git **)a_);
1134 struct packed_git *b = *((struct packed_git **)b_);
1135 int st;
1138 * Local packs tend to contain objects specific to our
1139 * variant of the project than remote ones. In addition,
1140 * remote ones could be on a network mounted filesystem.
1141 * Favor local ones for these reasons.
1143 st = a->pack_local - b->pack_local;
1144 if (st)
1145 return -st;
1148 * Younger packs tend to contain more recent objects,
1149 * and more recent objects tend to get accessed more
1150 * often.
1152 if (a->mtime < b->mtime)
1153 return 1;
1154 else if (a->mtime == b->mtime)
1155 return 0;
1156 return -1;
1159 static void rearrange_packed_git(void)
1161 struct packed_git **ary, *p;
1162 int i, n;
1164 for (n = 0, p = packed_git; p; p = p->next)
1165 n++;
1166 if (n < 2)
1167 return;
1169 /* prepare an array of packed_git for easier sorting */
1170 ary = xcalloc(n, sizeof(struct packed_git *));
1171 for (n = 0, p = packed_git; p; p = p->next)
1172 ary[n++] = p;
1174 qsort(ary, n, sizeof(struct packed_git *), sort_pack);
1176 /* link them back again */
1177 for (i = 0; i < n - 1; i++)
1178 ary[i]->next = ary[i + 1];
1179 ary[n - 1]->next = NULL;
1180 packed_git = ary[0];
1182 free(ary);
1185 static int prepare_packed_git_run_once = 0;
1186 void prepare_packed_git(void)
1188 struct alternate_object_database *alt;
1190 if (prepare_packed_git_run_once)
1191 return;
1192 prepare_packed_git_one(get_object_directory(), 1);
1193 prepare_alt_odb();
1194 for (alt = alt_odb_list; alt; alt = alt->next) {
1195 alt->name[-1] = 0;
1196 prepare_packed_git_one(alt->base, 0);
1197 alt->name[-1] = '/';
1199 rearrange_packed_git();
1200 prepare_packed_git_run_once = 1;
1203 void reprepare_packed_git(void)
1205 discard_revindex();
1206 prepare_packed_git_run_once = 0;
1207 prepare_packed_git();
1210 static void mark_bad_packed_object(struct packed_git *p,
1211 const unsigned char *sha1)
1213 unsigned i;
1214 for (i = 0; i < p->num_bad_objects; i++)
1215 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1216 return;
1217 p->bad_object_sha1 = xrealloc(p->bad_object_sha1, 20 * (p->num_bad_objects + 1));
1218 hashcpy(p->bad_object_sha1 + 20 * p->num_bad_objects, sha1);
1219 p->num_bad_objects++;
1222 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1224 struct packed_git *p;
1225 unsigned i;
1227 for (p = packed_git; p; p = p->next)
1228 for (i = 0; i < p->num_bad_objects; i++)
1229 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1230 return p;
1231 return NULL;
1235 * With an in-core object data in "map", rehash it to make sure the
1236 * object name actually matches "sha1" to detect object corruption.
1237 * With "map" == NULL, try reading the object named with "sha1" using
1238 * the streaming interface and rehash it to do the same.
1240 int check_sha1_signature(const unsigned char *sha1, void *map,
1241 unsigned long size, const char *type)
1243 unsigned char real_sha1[20];
1244 enum object_type obj_type;
1245 struct git_istream *st;
1246 git_SHA_CTX c;
1247 char hdr[32];
1248 int hdrlen;
1250 if (map) {
1251 hash_sha1_file(map, size, type, real_sha1);
1252 return hashcmp(sha1, real_sha1) ? -1 : 0;
1255 st = open_istream(sha1, &obj_type, &size, NULL);
1256 if (!st)
1257 return -1;
1259 /* Generate the header */
1260 hdrlen = sprintf(hdr, "%s %lu", typename(obj_type), size) + 1;
1262 /* Sha1.. */
1263 git_SHA1_Init(&c);
1264 git_SHA1_Update(&c, hdr, hdrlen);
1265 for (;;) {
1266 char buf[1024 * 16];
1267 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1269 if (!readlen)
1270 break;
1271 git_SHA1_Update(&c, buf, readlen);
1273 git_SHA1_Final(real_sha1, &c);
1274 close_istream(st);
1275 return hashcmp(sha1, real_sha1) ? -1 : 0;
1278 static int git_open_noatime(const char *name)
1280 static int sha1_file_open_flag = O_NOATIME;
1282 for (;;) {
1283 int fd = open(name, O_RDONLY | sha1_file_open_flag);
1284 if (fd >= 0)
1285 return fd;
1287 /* Might the failure be due to O_NOATIME? */
1288 if (errno != ENOENT && sha1_file_open_flag) {
1289 sha1_file_open_flag = 0;
1290 continue;
1293 return -1;
1297 static int open_sha1_file(const unsigned char *sha1)
1299 int fd;
1300 char *name = sha1_file_name(sha1);
1301 struct alternate_object_database *alt;
1303 fd = git_open_noatime(name);
1304 if (fd >= 0)
1305 return fd;
1307 prepare_alt_odb();
1308 errno = ENOENT;
1309 for (alt = alt_odb_list; alt; alt = alt->next) {
1310 name = alt->name;
1311 fill_sha1_path(name, sha1);
1312 fd = git_open_noatime(alt->base);
1313 if (fd >= 0)
1314 return fd;
1316 return -1;
1319 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1321 void *map;
1322 int fd;
1324 fd = open_sha1_file(sha1);
1325 map = NULL;
1326 if (fd >= 0) {
1327 struct stat st;
1329 if (!fstat(fd, &st)) {
1330 *size = xsize_t(st.st_size);
1331 if (!*size) {
1332 /* mmap() is forbidden on empty files */
1333 error("object file %s is empty", sha1_file_name(sha1));
1334 return NULL;
1336 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1338 close(fd);
1340 return map;
1344 * There used to be a second loose object header format which
1345 * was meant to mimic the in-pack format, allowing for direct
1346 * copy of the object data. This format turned up not to be
1347 * really worth it and we no longer write loose objects in that
1348 * format.
1350 static int experimental_loose_object(unsigned char *map)
1352 unsigned int word;
1355 * We must determine if the buffer contains the standard
1356 * zlib-deflated stream or the experimental format based
1357 * on the in-pack object format. Compare the header byte
1358 * for each format:
1360 * RFC1950 zlib w/ deflate : 0www1000 : 0 <= www <= 7
1361 * Experimental pack-based : Stttssss : ttt = 1,2,3,4
1363 * If bit 7 is clear and bits 0-3 equal 8, the buffer MUST be
1364 * in standard loose-object format, UNLESS it is a Git-pack
1365 * format object *exactly* 8 bytes in size when inflated.
1367 * However, RFC1950 also specifies that the 1st 16-bit word
1368 * must be divisible by 31 - this checksum tells us our buffer
1369 * is in the standard format, giving a false positive only if
1370 * the 1st word of the Git-pack format object happens to be
1371 * divisible by 31, ie:
1372 * ((byte0 * 256) + byte1) % 31 = 0
1373 * => 0ttt10000www1000 % 31 = 0
1375 * As it happens, this case can only arise for www=3 & ttt=1
1376 * - ie, a Commit object, which would have to be 8 bytes in
1377 * size. As no Commit can be that small, we find that the
1378 * combination of these two criteria (bitmask & checksum)
1379 * can always correctly determine the buffer format.
1381 word = (map[0] << 8) + map[1];
1382 if ((map[0] & 0x8F) == 0x08 && !(word % 31))
1383 return 0;
1384 else
1385 return 1;
1388 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1389 unsigned long len, enum object_type *type, unsigned long *sizep)
1391 unsigned shift;
1392 unsigned long size, c;
1393 unsigned long used = 0;
1395 c = buf[used++];
1396 *type = (c >> 4) & 7;
1397 size = c & 15;
1398 shift = 4;
1399 while (c & 0x80) {
1400 if (len <= used || bitsizeof(long) <= shift) {
1401 error("bad object header");
1402 size = used = 0;
1403 break;
1405 c = buf[used++];
1406 size += (c & 0x7f) << shift;
1407 shift += 7;
1409 *sizep = size;
1410 return used;
1413 int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz)
1415 unsigned long size, used;
1416 static const char valid_loose_object_type[8] = {
1417 0, /* OBJ_EXT */
1418 1, 1, 1, 1, /* "commit", "tree", "blob", "tag" */
1419 0, /* "delta" and others are invalid in a loose object */
1421 enum object_type type;
1423 /* Get the data stream */
1424 memset(stream, 0, sizeof(*stream));
1425 stream->next_in = map;
1426 stream->avail_in = mapsize;
1427 stream->next_out = buffer;
1428 stream->avail_out = bufsiz;
1430 if (experimental_loose_object(map)) {
1432 * The old experimental format we no longer produce;
1433 * we can still read it.
1435 used = unpack_object_header_buffer(map, mapsize, &type, &size);
1436 if (!used || !valid_loose_object_type[type])
1437 return -1;
1438 map += used;
1439 mapsize -= used;
1441 /* Set up the stream for the rest.. */
1442 stream->next_in = map;
1443 stream->avail_in = mapsize;
1444 git_inflate_init(stream);
1446 /* And generate the fake traditional header */
1447 stream->total_out = 1 + snprintf(buffer, bufsiz, "%s %lu",
1448 typename(type), size);
1449 return 0;
1451 git_inflate_init(stream);
1452 return git_inflate(stream, 0);
1455 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1457 int bytes = strlen(buffer) + 1;
1458 unsigned char *buf = xmallocz(size);
1459 unsigned long n;
1460 int status = Z_OK;
1462 n = stream->total_out - bytes;
1463 if (n > size)
1464 n = size;
1465 memcpy(buf, (char *) buffer + bytes, n);
1466 bytes = n;
1467 if (bytes <= size) {
1469 * The above condition must be (bytes <= size), not
1470 * (bytes < size). In other words, even though we
1471 * expect no more output and set avail_out to zero,
1472 * the input zlib stream may have bytes that express
1473 * "this concludes the stream", and we *do* want to
1474 * eat that input.
1476 * Otherwise we would not be able to test that we
1477 * consumed all the input to reach the expected size;
1478 * we also want to check that zlib tells us that all
1479 * went well with status == Z_STREAM_END at the end.
1481 stream->next_out = buf + bytes;
1482 stream->avail_out = size - bytes;
1483 while (status == Z_OK)
1484 status = git_inflate(stream, Z_FINISH);
1486 if (status == Z_STREAM_END && !stream->avail_in) {
1487 git_inflate_end(stream);
1488 return buf;
1491 if (status < 0)
1492 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1493 else if (stream->avail_in)
1494 error("garbage at end of loose object '%s'",
1495 sha1_to_hex(sha1));
1496 free(buf);
1497 return NULL;
1501 * We used to just use "sscanf()", but that's actually way
1502 * too permissive for what we want to check. So do an anal
1503 * object header parse by hand.
1505 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1507 char type[10];
1508 int i;
1509 unsigned long size;
1512 * The type can be at most ten bytes (including the
1513 * terminating '\0' that we add), and is followed by
1514 * a space.
1516 i = 0;
1517 for (;;) {
1518 char c = *hdr++;
1519 if (c == ' ')
1520 break;
1521 type[i++] = c;
1522 if (i >= sizeof(type))
1523 return -1;
1525 type[i] = 0;
1528 * The length must follow immediately, and be in canonical
1529 * decimal format (ie "010" is not valid).
1531 size = *hdr++ - '0';
1532 if (size > 9)
1533 return -1;
1534 if (size) {
1535 for (;;) {
1536 unsigned long c = *hdr - '0';
1537 if (c > 9)
1538 break;
1539 hdr++;
1540 size = size * 10 + c;
1543 *sizep = size;
1546 * The length must be followed by a zero byte
1548 return *hdr ? -1 : type_from_string(type);
1551 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1553 int ret;
1554 git_zstream stream;
1555 char hdr[8192];
1557 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1558 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1559 return NULL;
1561 return unpack_sha1_rest(&stream, hdr, *size, sha1);
1564 unsigned long get_size_from_delta(struct packed_git *p,
1565 struct pack_window **w_curs,
1566 off_t curpos)
1568 const unsigned char *data;
1569 unsigned char delta_head[20], *in;
1570 git_zstream stream;
1571 int st;
1573 memset(&stream, 0, sizeof(stream));
1574 stream.next_out = delta_head;
1575 stream.avail_out = sizeof(delta_head);
1577 git_inflate_init(&stream);
1578 do {
1579 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1580 stream.next_in = in;
1581 st = git_inflate(&stream, Z_FINISH);
1582 curpos += stream.next_in - in;
1583 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1584 stream.total_out < sizeof(delta_head));
1585 git_inflate_end(&stream);
1586 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1587 error("delta data unpack-initial failed");
1588 return 0;
1591 /* Examine the initial part of the delta to figure out
1592 * the result size.
1594 data = delta_head;
1596 /* ignore base size */
1597 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1599 /* Read the result size */
1600 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1603 static off_t get_delta_base(struct packed_git *p,
1604 struct pack_window **w_curs,
1605 off_t *curpos,
1606 enum object_type type,
1607 off_t delta_obj_offset)
1609 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1610 off_t base_offset;
1612 /* use_pack() assured us we have [base_info, base_info + 20)
1613 * as a range that we can look at without walking off the
1614 * end of the mapped window. Its actually the hash size
1615 * that is assured. An OFS_DELTA longer than the hash size
1616 * is stupid, as then a REF_DELTA would be smaller to store.
1618 if (type == OBJ_OFS_DELTA) {
1619 unsigned used = 0;
1620 unsigned char c = base_info[used++];
1621 base_offset = c & 127;
1622 while (c & 128) {
1623 base_offset += 1;
1624 if (!base_offset || MSB(base_offset, 7))
1625 return 0; /* overflow */
1626 c = base_info[used++];
1627 base_offset = (base_offset << 7) + (c & 127);
1629 base_offset = delta_obj_offset - base_offset;
1630 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1631 return 0; /* out of bound */
1632 *curpos += used;
1633 } else if (type == OBJ_REF_DELTA) {
1634 /* The base entry _must_ be in the same pack */
1635 base_offset = find_pack_entry_one(base_info, p);
1636 *curpos += 20;
1637 } else
1638 die("I am totally screwed");
1639 return base_offset;
1642 /* forward declaration for a mutually recursive function */
1643 static int packed_object_info(struct packed_git *p, off_t offset,
1644 unsigned long *sizep, int *rtype);
1646 static int packed_delta_info(struct packed_git *p,
1647 struct pack_window **w_curs,
1648 off_t curpos,
1649 enum object_type type,
1650 off_t obj_offset,
1651 unsigned long *sizep)
1653 off_t base_offset;
1655 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
1656 if (!base_offset)
1657 return OBJ_BAD;
1658 type = packed_object_info(p, base_offset, NULL, NULL);
1659 if (type <= OBJ_NONE) {
1660 struct revindex_entry *revidx;
1661 const unsigned char *base_sha1;
1662 revidx = find_pack_revindex(p, base_offset);
1663 if (!revidx)
1664 return OBJ_BAD;
1665 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
1666 mark_bad_packed_object(p, base_sha1);
1667 type = sha1_object_info(base_sha1, NULL);
1668 if (type <= OBJ_NONE)
1669 return OBJ_BAD;
1672 /* We choose to only get the type of the base object and
1673 * ignore potentially corrupt pack file that expects the delta
1674 * based on a base with a wrong size. This saves tons of
1675 * inflate() calls.
1677 if (sizep) {
1678 *sizep = get_size_from_delta(p, w_curs, curpos);
1679 if (*sizep == 0)
1680 type = OBJ_BAD;
1683 return type;
1686 int unpack_object_header(struct packed_git *p,
1687 struct pack_window **w_curs,
1688 off_t *curpos,
1689 unsigned long *sizep)
1691 unsigned char *base;
1692 unsigned long left;
1693 unsigned long used;
1694 enum object_type type;
1696 /* use_pack() assures us we have [base, base + 20) available
1697 * as a range that we can look at. (Its actually the hash
1698 * size that is assured.) With our object header encoding
1699 * the maximum deflated object size is 2^137, which is just
1700 * insane, so we know won't exceed what we have been given.
1702 base = use_pack(p, w_curs, *curpos, &left);
1703 used = unpack_object_header_buffer(base, left, &type, sizep);
1704 if (!used) {
1705 type = OBJ_BAD;
1706 } else
1707 *curpos += used;
1709 return type;
1712 static int packed_object_info(struct packed_git *p, off_t obj_offset,
1713 unsigned long *sizep, int *rtype)
1715 struct pack_window *w_curs = NULL;
1716 unsigned long size;
1717 off_t curpos = obj_offset;
1718 enum object_type type;
1720 type = unpack_object_header(p, &w_curs, &curpos, &size);
1721 if (rtype)
1722 *rtype = type; /* representation type */
1724 switch (type) {
1725 case OBJ_OFS_DELTA:
1726 case OBJ_REF_DELTA:
1727 type = packed_delta_info(p, &w_curs, curpos,
1728 type, obj_offset, sizep);
1729 break;
1730 case OBJ_COMMIT:
1731 case OBJ_TREE:
1732 case OBJ_BLOB:
1733 case OBJ_TAG:
1734 if (sizep)
1735 *sizep = size;
1736 break;
1737 default:
1738 error("unknown object type %i at offset %"PRIuMAX" in %s",
1739 type, (uintmax_t)obj_offset, p->pack_name);
1740 type = OBJ_BAD;
1742 unuse_pack(&w_curs);
1743 return type;
1746 static void *unpack_compressed_entry(struct packed_git *p,
1747 struct pack_window **w_curs,
1748 off_t curpos,
1749 unsigned long size)
1751 int st;
1752 git_zstream stream;
1753 unsigned char *buffer, *in;
1755 buffer = xmallocz(size);
1756 memset(&stream, 0, sizeof(stream));
1757 stream.next_out = buffer;
1758 stream.avail_out = size + 1;
1760 git_inflate_init(&stream);
1761 do {
1762 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1763 stream.next_in = in;
1764 st = git_inflate(&stream, Z_FINISH);
1765 if (!stream.avail_out)
1766 break; /* the payload is larger than it should be */
1767 curpos += stream.next_in - in;
1768 } while (st == Z_OK || st == Z_BUF_ERROR);
1769 git_inflate_end(&stream);
1770 if ((st != Z_STREAM_END) || stream.total_out != size) {
1771 free(buffer);
1772 return NULL;
1775 return buffer;
1778 #define MAX_DELTA_CACHE (256)
1780 static size_t delta_base_cached;
1782 static struct delta_base_cache_lru_list {
1783 struct delta_base_cache_lru_list *prev;
1784 struct delta_base_cache_lru_list *next;
1785 } delta_base_cache_lru = { &delta_base_cache_lru, &delta_base_cache_lru };
1787 static struct delta_base_cache_entry {
1788 struct delta_base_cache_lru_list lru;
1789 void *data;
1790 struct packed_git *p;
1791 off_t base_offset;
1792 unsigned long size;
1793 enum object_type type;
1794 } delta_base_cache[MAX_DELTA_CACHE];
1796 static unsigned long pack_entry_hash(struct packed_git *p, off_t base_offset)
1798 unsigned long hash;
1800 hash = (unsigned long)p + (unsigned long)base_offset;
1801 hash += (hash >> 8) + (hash >> 16);
1802 return hash % MAX_DELTA_CACHE;
1805 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
1807 unsigned long hash = pack_entry_hash(p, base_offset);
1808 struct delta_base_cache_entry *ent = delta_base_cache + hash;
1809 return (ent->data && ent->p == p && ent->base_offset == base_offset);
1812 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
1813 unsigned long *base_size, enum object_type *type, int keep_cache)
1815 void *ret;
1816 unsigned long hash = pack_entry_hash(p, base_offset);
1817 struct delta_base_cache_entry *ent = delta_base_cache + hash;
1819 ret = ent->data;
1820 if (!ret || ent->p != p || ent->base_offset != base_offset)
1821 return unpack_entry(p, base_offset, type, base_size);
1823 if (!keep_cache) {
1824 ent->data = NULL;
1825 ent->lru.next->prev = ent->lru.prev;
1826 ent->lru.prev->next = ent->lru.next;
1827 delta_base_cached -= ent->size;
1828 } else {
1829 ret = xmemdupz(ent->data, ent->size);
1831 *type = ent->type;
1832 *base_size = ent->size;
1833 return ret;
1836 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
1838 if (ent->data) {
1839 free(ent->data);
1840 ent->data = NULL;
1841 ent->lru.next->prev = ent->lru.prev;
1842 ent->lru.prev->next = ent->lru.next;
1843 delta_base_cached -= ent->size;
1847 void clear_delta_base_cache(void)
1849 unsigned long p;
1850 for (p = 0; p < MAX_DELTA_CACHE; p++)
1851 release_delta_base_cache(&delta_base_cache[p]);
1854 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
1855 void *base, unsigned long base_size, enum object_type type)
1857 unsigned long hash = pack_entry_hash(p, base_offset);
1858 struct delta_base_cache_entry *ent = delta_base_cache + hash;
1859 struct delta_base_cache_lru_list *lru;
1861 release_delta_base_cache(ent);
1862 delta_base_cached += base_size;
1864 for (lru = delta_base_cache_lru.next;
1865 delta_base_cached > delta_base_cache_limit
1866 && lru != &delta_base_cache_lru;
1867 lru = lru->next) {
1868 struct delta_base_cache_entry *f = (void *)lru;
1869 if (f->type == OBJ_BLOB)
1870 release_delta_base_cache(f);
1872 for (lru = delta_base_cache_lru.next;
1873 delta_base_cached > delta_base_cache_limit
1874 && lru != &delta_base_cache_lru;
1875 lru = lru->next) {
1876 struct delta_base_cache_entry *f = (void *)lru;
1877 release_delta_base_cache(f);
1880 ent->p = p;
1881 ent->base_offset = base_offset;
1882 ent->type = type;
1883 ent->data = base;
1884 ent->size = base_size;
1885 ent->lru.next = &delta_base_cache_lru;
1886 ent->lru.prev = delta_base_cache_lru.prev;
1887 delta_base_cache_lru.prev->next = &ent->lru;
1888 delta_base_cache_lru.prev = &ent->lru;
1891 static void *read_object(const unsigned char *sha1, enum object_type *type,
1892 unsigned long *size);
1894 static void *unpack_delta_entry(struct packed_git *p,
1895 struct pack_window **w_curs,
1896 off_t curpos,
1897 unsigned long delta_size,
1898 off_t obj_offset,
1899 enum object_type *type,
1900 unsigned long *sizep)
1902 void *delta_data, *result, *base;
1903 unsigned long base_size;
1904 off_t base_offset;
1906 base_offset = get_delta_base(p, w_curs, &curpos, *type, obj_offset);
1907 if (!base_offset) {
1908 error("failed to validate delta base reference "
1909 "at offset %"PRIuMAX" from %s",
1910 (uintmax_t)curpos, p->pack_name);
1911 return NULL;
1913 unuse_pack(w_curs);
1914 base = cache_or_unpack_entry(p, base_offset, &base_size, type, 0);
1915 if (!base) {
1917 * We're probably in deep shit, but let's try to fetch
1918 * the required base anyway from another pack or loose.
1919 * This is costly but should happen only in the presence
1920 * of a corrupted pack, and is better than failing outright.
1922 struct revindex_entry *revidx;
1923 const unsigned char *base_sha1;
1924 revidx = find_pack_revindex(p, base_offset);
1925 if (!revidx)
1926 return NULL;
1927 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
1928 error("failed to read delta base object %s"
1929 " at offset %"PRIuMAX" from %s",
1930 sha1_to_hex(base_sha1), (uintmax_t)base_offset,
1931 p->pack_name);
1932 mark_bad_packed_object(p, base_sha1);
1933 base = read_object(base_sha1, type, &base_size);
1934 if (!base)
1935 return NULL;
1938 delta_data = unpack_compressed_entry(p, w_curs, curpos, delta_size);
1939 if (!delta_data) {
1940 error("failed to unpack compressed delta "
1941 "at offset %"PRIuMAX" from %s",
1942 (uintmax_t)curpos, p->pack_name);
1943 free(base);
1944 return NULL;
1946 result = patch_delta(base, base_size,
1947 delta_data, delta_size,
1948 sizep);
1949 if (!result)
1950 die("failed to apply delta");
1951 free(delta_data);
1952 add_delta_base_cache(p, base_offset, base, base_size, *type);
1953 return result;
1956 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
1958 static FILE *log_file;
1960 if (!log_file) {
1961 log_file = fopen(log_pack_access, "w");
1962 if (!log_file) {
1963 error("cannot open pack access log '%s' for writing: %s",
1964 log_pack_access, strerror(errno));
1965 log_pack_access = NULL;
1966 return;
1969 fprintf(log_file, "%s %"PRIuMAX"\n",
1970 p->pack_name, (uintmax_t)obj_offset);
1971 fflush(log_file);
1974 int do_check_packed_object_crc;
1976 void *unpack_entry(struct packed_git *p, off_t obj_offset,
1977 enum object_type *type, unsigned long *sizep)
1979 struct pack_window *w_curs = NULL;
1980 off_t curpos = obj_offset;
1981 void *data;
1983 if (log_pack_access)
1984 write_pack_access_log(p, obj_offset);
1986 if (do_check_packed_object_crc && p->index_version > 1) {
1987 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
1988 unsigned long len = revidx[1].offset - obj_offset;
1989 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
1990 const unsigned char *sha1 =
1991 nth_packed_object_sha1(p, revidx->nr);
1992 error("bad packed object CRC for %s",
1993 sha1_to_hex(sha1));
1994 mark_bad_packed_object(p, sha1);
1995 unuse_pack(&w_curs);
1996 return NULL;
2000 *type = unpack_object_header(p, &w_curs, &curpos, sizep);
2001 switch (*type) {
2002 case OBJ_OFS_DELTA:
2003 case OBJ_REF_DELTA:
2004 data = unpack_delta_entry(p, &w_curs, curpos, *sizep,
2005 obj_offset, type, sizep);
2006 break;
2007 case OBJ_COMMIT:
2008 case OBJ_TREE:
2009 case OBJ_BLOB:
2010 case OBJ_TAG:
2011 data = unpack_compressed_entry(p, &w_curs, curpos, *sizep);
2012 break;
2013 default:
2014 data = NULL;
2015 error("unknown object type %i at offset %"PRIuMAX" in %s",
2016 *type, (uintmax_t)obj_offset, p->pack_name);
2018 unuse_pack(&w_curs);
2019 return data;
2022 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2023 uint32_t n)
2025 const unsigned char *index = p->index_data;
2026 if (!index) {
2027 if (open_pack_index(p))
2028 return NULL;
2029 index = p->index_data;
2031 if (n >= p->num_objects)
2032 return NULL;
2033 index += 4 * 256;
2034 if (p->index_version == 1) {
2035 return index + 24 * n + 4;
2036 } else {
2037 index += 8;
2038 return index + 20 * n;
2042 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2044 const unsigned char *index = p->index_data;
2045 index += 4 * 256;
2046 if (p->index_version == 1) {
2047 return ntohl(*((uint32_t *)(index + 24 * n)));
2048 } else {
2049 uint32_t off;
2050 index += 8 + p->num_objects * (20 + 4);
2051 off = ntohl(*((uint32_t *)(index + 4 * n)));
2052 if (!(off & 0x80000000))
2053 return off;
2054 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2055 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2056 ntohl(*((uint32_t *)(index + 4)));
2060 off_t find_pack_entry_one(const unsigned char *sha1,
2061 struct packed_git *p)
2063 const uint32_t *level1_ofs = p->index_data;
2064 const unsigned char *index = p->index_data;
2065 unsigned hi, lo, stride;
2066 static int use_lookup = -1;
2067 static int debug_lookup = -1;
2069 if (debug_lookup < 0)
2070 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2072 if (!index) {
2073 if (open_pack_index(p))
2074 return 0;
2075 level1_ofs = p->index_data;
2076 index = p->index_data;
2078 if (p->index_version > 1) {
2079 level1_ofs += 2;
2080 index += 8;
2082 index += 4 * 256;
2083 hi = ntohl(level1_ofs[*sha1]);
2084 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2085 if (p->index_version > 1) {
2086 stride = 20;
2087 } else {
2088 stride = 24;
2089 index += 4;
2092 if (debug_lookup)
2093 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2094 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2096 if (use_lookup < 0)
2097 use_lookup = !!getenv("GIT_USE_LOOKUP");
2098 if (use_lookup) {
2099 int pos = sha1_entry_pos(index, stride, 0,
2100 lo, hi, p->num_objects, sha1);
2101 if (pos < 0)
2102 return 0;
2103 return nth_packed_object_offset(p, pos);
2106 do {
2107 unsigned mi = (lo + hi) / 2;
2108 int cmp = hashcmp(index + mi * stride, sha1);
2110 if (debug_lookup)
2111 printf("lo %u hi %u rg %u mi %u\n",
2112 lo, hi, hi - lo, mi);
2113 if (!cmp)
2114 return nth_packed_object_offset(p, mi);
2115 if (cmp > 0)
2116 hi = mi;
2117 else
2118 lo = mi+1;
2119 } while (lo < hi);
2120 return 0;
2123 int is_pack_valid(struct packed_git *p)
2125 /* An already open pack is known to be valid. */
2126 if (p->pack_fd != -1)
2127 return 1;
2129 /* If the pack has one window completely covering the
2130 * file size, the pack is known to be valid even if
2131 * the descriptor is not currently open.
2133 if (p->windows) {
2134 struct pack_window *w = p->windows;
2136 if (!w->offset && w->len == p->pack_size)
2137 return 1;
2140 /* Force the pack to open to prove its valid. */
2141 return !open_packed_git(p);
2144 static int fill_pack_entry(const unsigned char *sha1,
2145 struct pack_entry *e,
2146 struct packed_git *p)
2148 off_t offset;
2150 if (p->num_bad_objects) {
2151 unsigned i;
2152 for (i = 0; i < p->num_bad_objects; i++)
2153 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2154 return 0;
2157 offset = find_pack_entry_one(sha1, p);
2158 if (!offset)
2159 return 0;
2162 * We are about to tell the caller where they can locate the
2163 * requested object. We better make sure the packfile is
2164 * still here and can be accessed before supplying that
2165 * answer, as it may have been deleted since the index was
2166 * loaded!
2168 if (!is_pack_valid(p)) {
2169 warning("packfile %s cannot be accessed", p->pack_name);
2170 return 0;
2172 e->offset = offset;
2173 e->p = p;
2174 hashcpy(e->sha1, sha1);
2175 return 1;
2178 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2180 struct packed_git *p;
2182 prepare_packed_git();
2183 if (!packed_git)
2184 return 0;
2186 if (last_found_pack && fill_pack_entry(sha1, e, last_found_pack))
2187 return 1;
2189 for (p = packed_git; p; p = p->next) {
2190 if (p == last_found_pack || !fill_pack_entry(sha1, e, p))
2191 continue;
2193 last_found_pack = p;
2194 return 1;
2196 return 0;
2199 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2200 struct packed_git *packs)
2202 struct packed_git *p;
2204 for (p = packs; p; p = p->next) {
2205 if (find_pack_entry_one(sha1, p))
2206 return p;
2208 return NULL;
2212 static int sha1_loose_object_info(const unsigned char *sha1, unsigned long *sizep)
2214 int status;
2215 unsigned long mapsize, size;
2216 void *map;
2217 git_zstream stream;
2218 char hdr[32];
2220 map = map_sha1_file(sha1, &mapsize);
2221 if (!map)
2222 return error("unable to find %s", sha1_to_hex(sha1));
2223 if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2224 status = error("unable to unpack %s header",
2225 sha1_to_hex(sha1));
2226 else if ((status = parse_sha1_header(hdr, &size)) < 0)
2227 status = error("unable to parse %s header", sha1_to_hex(sha1));
2228 else if (sizep)
2229 *sizep = size;
2230 git_inflate_end(&stream);
2231 munmap(map, mapsize);
2232 return status;
2235 /* returns enum object_type or negative */
2236 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi)
2238 struct cached_object *co;
2239 struct pack_entry e;
2240 int status, rtype;
2242 co = find_cached_object(sha1);
2243 if (co) {
2244 if (oi->sizep)
2245 *(oi->sizep) = co->size;
2246 oi->whence = OI_CACHED;
2247 return co->type;
2250 if (!find_pack_entry(sha1, &e)) {
2251 /* Most likely it's a loose object. */
2252 status = sha1_loose_object_info(sha1, oi->sizep);
2253 if (status >= 0) {
2254 oi->whence = OI_LOOSE;
2255 return status;
2258 /* Not a loose object; someone else may have just packed it. */
2259 reprepare_packed_git();
2260 if (!find_pack_entry(sha1, &e))
2261 return status;
2264 status = packed_object_info(e.p, e.offset, oi->sizep, &rtype);
2265 if (status < 0) {
2266 mark_bad_packed_object(e.p, sha1);
2267 status = sha1_object_info_extended(sha1, oi);
2268 } else if (in_delta_base_cache(e.p, e.offset)) {
2269 oi->whence = OI_DBCACHED;
2270 } else {
2271 oi->whence = OI_PACKED;
2272 oi->u.packed.offset = e.offset;
2273 oi->u.packed.pack = e.p;
2274 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2275 rtype == OBJ_OFS_DELTA);
2278 return status;
2281 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2283 struct object_info oi;
2285 oi.sizep = sizep;
2286 return sha1_object_info_extended(sha1, &oi);
2289 static void *read_packed_sha1(const unsigned char *sha1,
2290 enum object_type *type, unsigned long *size)
2292 struct pack_entry e;
2293 void *data;
2295 if (!find_pack_entry(sha1, &e))
2296 return NULL;
2297 data = cache_or_unpack_entry(e.p, e.offset, size, type, 1);
2298 if (!data) {
2300 * We're probably in deep shit, but let's try to fetch
2301 * the required object anyway from another pack or loose.
2302 * This should happen only in the presence of a corrupted
2303 * pack, and is better than failing outright.
2305 error("failed to read object %s at offset %"PRIuMAX" from %s",
2306 sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2307 mark_bad_packed_object(e.p, sha1);
2308 data = read_object(sha1, type, size);
2310 return data;
2313 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2314 unsigned char *sha1)
2316 struct cached_object *co;
2318 hash_sha1_file(buf, len, typename(type), sha1);
2319 if (has_sha1_file(sha1) || find_cached_object(sha1))
2320 return 0;
2321 if (cached_object_alloc <= cached_object_nr) {
2322 cached_object_alloc = alloc_nr(cached_object_alloc);
2323 cached_objects = xrealloc(cached_objects,
2324 sizeof(*cached_objects) *
2325 cached_object_alloc);
2327 co = &cached_objects[cached_object_nr++];
2328 co->size = len;
2329 co->type = type;
2330 co->buf = xmalloc(len);
2331 memcpy(co->buf, buf, len);
2332 hashcpy(co->sha1, sha1);
2333 return 0;
2336 static void *read_object(const unsigned char *sha1, enum object_type *type,
2337 unsigned long *size)
2339 unsigned long mapsize;
2340 void *map, *buf;
2341 struct cached_object *co;
2343 co = find_cached_object(sha1);
2344 if (co) {
2345 *type = co->type;
2346 *size = co->size;
2347 return xmemdupz(co->buf, co->size);
2350 buf = read_packed_sha1(sha1, type, size);
2351 if (buf)
2352 return buf;
2353 map = map_sha1_file(sha1, &mapsize);
2354 if (map) {
2355 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2356 munmap(map, mapsize);
2357 return buf;
2359 reprepare_packed_git();
2360 return read_packed_sha1(sha1, type, size);
2364 * This function dies on corrupt objects; the callers who want to
2365 * deal with them should arrange to call read_object() and give error
2366 * messages themselves.
2368 void *read_sha1_file_extended(const unsigned char *sha1,
2369 enum object_type *type,
2370 unsigned long *size,
2371 unsigned flag)
2373 void *data;
2374 char *path;
2375 const struct packed_git *p;
2376 const unsigned char *repl = (flag & READ_SHA1_FILE_REPLACE)
2377 ? lookup_replace_object(sha1) : sha1;
2379 errno = 0;
2380 data = read_object(repl, type, size);
2381 if (data)
2382 return data;
2384 if (errno && errno != ENOENT)
2385 die_errno("failed to read object %s", sha1_to_hex(sha1));
2387 /* die if we replaced an object with one that does not exist */
2388 if (repl != sha1)
2389 die("replacement %s not found for %s",
2390 sha1_to_hex(repl), sha1_to_hex(sha1));
2392 if (has_loose_object(repl)) {
2393 path = sha1_file_name(sha1);
2394 die("loose object %s (stored in %s) is corrupt",
2395 sha1_to_hex(repl), path);
2398 if ((p = has_packed_and_bad(repl)) != NULL)
2399 die("packed object %s (stored in %s) is corrupt",
2400 sha1_to_hex(repl), p->pack_name);
2402 return NULL;
2405 void *read_object_with_reference(const unsigned char *sha1,
2406 const char *required_type_name,
2407 unsigned long *size,
2408 unsigned char *actual_sha1_return)
2410 enum object_type type, required_type;
2411 void *buffer;
2412 unsigned long isize;
2413 unsigned char actual_sha1[20];
2415 required_type = type_from_string(required_type_name);
2416 hashcpy(actual_sha1, sha1);
2417 while (1) {
2418 int ref_length = -1;
2419 const char *ref_type = NULL;
2421 buffer = read_sha1_file(actual_sha1, &type, &isize);
2422 if (!buffer)
2423 return NULL;
2424 if (type == required_type) {
2425 *size = isize;
2426 if (actual_sha1_return)
2427 hashcpy(actual_sha1_return, actual_sha1);
2428 return buffer;
2430 /* Handle references */
2431 else if (type == OBJ_COMMIT)
2432 ref_type = "tree ";
2433 else if (type == OBJ_TAG)
2434 ref_type = "object ";
2435 else {
2436 free(buffer);
2437 return NULL;
2439 ref_length = strlen(ref_type);
2441 if (ref_length + 40 > isize ||
2442 memcmp(buffer, ref_type, ref_length) ||
2443 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
2444 free(buffer);
2445 return NULL;
2447 free(buffer);
2448 /* Now we have the ID of the referred-to object in
2449 * actual_sha1. Check again. */
2453 static void write_sha1_file_prepare(const void *buf, unsigned long len,
2454 const char *type, unsigned char *sha1,
2455 char *hdr, int *hdrlen)
2457 git_SHA_CTX c;
2459 /* Generate the header */
2460 *hdrlen = sprintf(hdr, "%s %lu", type, len)+1;
2462 /* Sha1.. */
2463 git_SHA1_Init(&c);
2464 git_SHA1_Update(&c, hdr, *hdrlen);
2465 git_SHA1_Update(&c, buf, len);
2466 git_SHA1_Final(sha1, &c);
2470 * Move the just written object into its final resting place.
2471 * NEEDSWORK: this should be renamed to finalize_temp_file() as
2472 * "moving" is only a part of what it does, when no patch between
2473 * master to pu changes the call sites of this function.
2475 int move_temp_to_file(const char *tmpfile, const char *filename)
2477 int ret = 0;
2479 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
2480 goto try_rename;
2481 else if (link(tmpfile, filename))
2482 ret = errno;
2485 * Coda hack - coda doesn't like cross-directory links,
2486 * so we fall back to a rename, which will mean that it
2487 * won't be able to check collisions, but that's not a
2488 * big deal.
2490 * The same holds for FAT formatted media.
2492 * When this succeeds, we just return. We have nothing
2493 * left to unlink.
2495 if (ret && ret != EEXIST) {
2496 try_rename:
2497 if (!rename(tmpfile, filename))
2498 goto out;
2499 ret = errno;
2501 unlink_or_warn(tmpfile);
2502 if (ret) {
2503 if (ret != EEXIST) {
2504 return error("unable to write sha1 filename %s: %s", filename, strerror(ret));
2506 /* FIXME!!! Collision check here ? */
2509 out:
2510 if (adjust_shared_perm(filename))
2511 return error("unable to set permission to '%s'", filename);
2512 return 0;
2515 static int write_buffer(int fd, const void *buf, size_t len)
2517 if (write_in_full(fd, buf, len) < 0)
2518 return error("file write error (%s)", strerror(errno));
2519 return 0;
2522 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
2523 unsigned char *sha1)
2525 char hdr[32];
2526 int hdrlen;
2527 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2528 return 0;
2531 /* Finalize a file on disk, and close it. */
2532 static void close_sha1_file(int fd)
2534 if (fsync_object_files)
2535 fsync_or_die(fd, "sha1 file");
2536 if (close(fd) != 0)
2537 die_errno("error when closing sha1 file");
2540 /* Size of directory component, including the ending '/' */
2541 static inline int directory_size(const char *filename)
2543 const char *s = strrchr(filename, '/');
2544 if (!s)
2545 return 0;
2546 return s - filename + 1;
2550 * This creates a temporary file in the same directory as the final
2551 * 'filename'
2553 * We want to avoid cross-directory filename renames, because those
2554 * can have problems on various filesystems (FAT, NFS, Coda).
2556 static int create_tmpfile(char *buffer, size_t bufsiz, const char *filename)
2558 int fd, dirlen = directory_size(filename);
2560 if (dirlen + 20 > bufsiz) {
2561 errno = ENAMETOOLONG;
2562 return -1;
2564 memcpy(buffer, filename, dirlen);
2565 strcpy(buffer + dirlen, "tmp_obj_XXXXXX");
2566 fd = git_mkstemp_mode(buffer, 0444);
2567 if (fd < 0 && dirlen && errno == ENOENT) {
2568 /* Make sure the directory exists */
2569 memcpy(buffer, filename, dirlen);
2570 buffer[dirlen-1] = 0;
2571 if (mkdir(buffer, 0777) || adjust_shared_perm(buffer))
2572 return -1;
2574 /* Try again */
2575 strcpy(buffer + dirlen - 1, "/tmp_obj_XXXXXX");
2576 fd = git_mkstemp_mode(buffer, 0444);
2578 return fd;
2581 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
2582 const void *buf, unsigned long len, time_t mtime)
2584 int fd, ret;
2585 unsigned char compressed[4096];
2586 git_zstream stream;
2587 git_SHA_CTX c;
2588 unsigned char parano_sha1[20];
2589 char *filename;
2590 static char tmp_file[PATH_MAX];
2592 filename = sha1_file_name(sha1);
2593 fd = create_tmpfile(tmp_file, sizeof(tmp_file), filename);
2594 if (fd < 0) {
2595 if (errno == EACCES)
2596 return error("insufficient permission for adding an object to repository database %s", get_object_directory());
2597 else
2598 return error("unable to create temporary file: %s", strerror(errno));
2601 /* Set it up */
2602 memset(&stream, 0, sizeof(stream));
2603 git_deflate_init(&stream, zlib_compression_level);
2604 stream.next_out = compressed;
2605 stream.avail_out = sizeof(compressed);
2606 git_SHA1_Init(&c);
2608 /* First header.. */
2609 stream.next_in = (unsigned char *)hdr;
2610 stream.avail_in = hdrlen;
2611 while (git_deflate(&stream, 0) == Z_OK)
2612 ; /* nothing */
2613 git_SHA1_Update(&c, hdr, hdrlen);
2615 /* Then the data itself.. */
2616 stream.next_in = (void *)buf;
2617 stream.avail_in = len;
2618 do {
2619 unsigned char *in0 = stream.next_in;
2620 ret = git_deflate(&stream, Z_FINISH);
2621 git_SHA1_Update(&c, in0, stream.next_in - in0);
2622 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
2623 die("unable to write sha1 file");
2624 stream.next_out = compressed;
2625 stream.avail_out = sizeof(compressed);
2626 } while (ret == Z_OK);
2628 if (ret != Z_STREAM_END)
2629 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
2630 ret = git_deflate_end_gently(&stream);
2631 if (ret != Z_OK)
2632 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
2633 git_SHA1_Final(parano_sha1, &c);
2634 if (hashcmp(sha1, parano_sha1) != 0)
2635 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
2637 close_sha1_file(fd);
2639 if (mtime) {
2640 struct utimbuf utb;
2641 utb.actime = mtime;
2642 utb.modtime = mtime;
2643 if (utime(tmp_file, &utb) < 0)
2644 warning("failed utime() on %s: %s",
2645 tmp_file, strerror(errno));
2648 return move_temp_to_file(tmp_file, filename);
2651 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *returnsha1)
2653 unsigned char sha1[20];
2654 char hdr[32];
2655 int hdrlen;
2657 /* Normally if we have it in the pack then we do not bother writing
2658 * it out into .git/objects/??/?{38} file.
2660 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2661 if (returnsha1)
2662 hashcpy(returnsha1, sha1);
2663 if (has_sha1_file(sha1))
2664 return 0;
2665 return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
2668 int force_object_loose(const unsigned char *sha1, time_t mtime)
2670 void *buf;
2671 unsigned long len;
2672 enum object_type type;
2673 char hdr[32];
2674 int hdrlen;
2675 int ret;
2677 if (has_loose_object(sha1))
2678 return 0;
2679 buf = read_packed_sha1(sha1, &type, &len);
2680 if (!buf)
2681 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
2682 hdrlen = sprintf(hdr, "%s %lu", typename(type), len) + 1;
2683 ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
2684 free(buf);
2686 return ret;
2689 int has_pack_index(const unsigned char *sha1)
2691 struct stat st;
2692 if (stat(sha1_pack_index_name(sha1), &st))
2693 return 0;
2694 return 1;
2697 int has_sha1_pack(const unsigned char *sha1)
2699 struct pack_entry e;
2700 return find_pack_entry(sha1, &e);
2703 int has_sha1_file(const unsigned char *sha1)
2705 struct pack_entry e;
2707 if (find_pack_entry(sha1, &e))
2708 return 1;
2709 return has_loose_object(sha1);
2712 static void check_tree(const void *buf, size_t size)
2714 struct tree_desc desc;
2715 struct name_entry entry;
2717 init_tree_desc(&desc, buf, size);
2718 while (tree_entry(&desc, &entry))
2719 /* do nothing
2720 * tree_entry() will die() on malformed entries */
2724 static void check_commit(const void *buf, size_t size)
2726 struct commit c;
2727 memset(&c, 0, sizeof(c));
2728 if (parse_commit_buffer(&c, buf, size))
2729 die("corrupt commit");
2732 static void check_tag(const void *buf, size_t size)
2734 struct tag t;
2735 memset(&t, 0, sizeof(t));
2736 if (parse_tag_buffer(&t, buf, size))
2737 die("corrupt tag");
2740 static int index_mem(unsigned char *sha1, void *buf, size_t size,
2741 enum object_type type,
2742 const char *path, unsigned flags)
2744 int ret, re_allocated = 0;
2745 int write_object = flags & HASH_WRITE_OBJECT;
2747 if (!type)
2748 type = OBJ_BLOB;
2751 * Convert blobs to git internal format
2753 if ((type == OBJ_BLOB) && path) {
2754 struct strbuf nbuf = STRBUF_INIT;
2755 if (convert_to_git(path, buf, size, &nbuf,
2756 write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
2757 buf = strbuf_detach(&nbuf, &size);
2758 re_allocated = 1;
2761 if (flags & HASH_FORMAT_CHECK) {
2762 if (type == OBJ_TREE)
2763 check_tree(buf, size);
2764 if (type == OBJ_COMMIT)
2765 check_commit(buf, size);
2766 if (type == OBJ_TAG)
2767 check_tag(buf, size);
2770 if (write_object)
2771 ret = write_sha1_file(buf, size, typename(type), sha1);
2772 else
2773 ret = hash_sha1_file(buf, size, typename(type), sha1);
2774 if (re_allocated)
2775 free(buf);
2776 return ret;
2779 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
2780 const char *path, unsigned flags)
2782 struct strbuf sbuf = STRBUF_INIT;
2783 int ret;
2785 if (strbuf_read(&sbuf, fd, 4096) >= 0)
2786 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
2787 else
2788 ret = -1;
2789 strbuf_release(&sbuf);
2790 return ret;
2793 #define SMALL_FILE_SIZE (32*1024)
2795 static int index_core(unsigned char *sha1, int fd, size_t size,
2796 enum object_type type, const char *path,
2797 unsigned flags)
2799 int ret;
2801 if (!size) {
2802 ret = index_mem(sha1, NULL, size, type, path, flags);
2803 } else if (size <= SMALL_FILE_SIZE) {
2804 char *buf = xmalloc(size);
2805 if (size == read_in_full(fd, buf, size))
2806 ret = index_mem(sha1, buf, size, type, path, flags);
2807 else
2808 ret = error("short read %s", strerror(errno));
2809 free(buf);
2810 } else {
2811 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
2812 ret = index_mem(sha1, buf, size, type, path, flags);
2813 munmap(buf, size);
2815 return ret;
2819 * This creates one packfile per large blob unless bulk-checkin
2820 * machinery is "plugged".
2822 * This also bypasses the usual "convert-to-git" dance, and that is on
2823 * purpose. We could write a streaming version of the converting
2824 * functions and insert that before feeding the data to fast-import
2825 * (or equivalent in-core API described above). However, that is
2826 * somewhat complicated, as we do not know the size of the filter
2827 * result, which we need to know beforehand when writing a git object.
2828 * Since the primary motivation for trying to stream from the working
2829 * tree file and to avoid mmaping it in core is to deal with large
2830 * binary blobs, they generally do not want to get any conversion, and
2831 * callers should avoid this code path when filters are requested.
2833 static int index_stream(unsigned char *sha1, int fd, size_t size,
2834 enum object_type type, const char *path,
2835 unsigned flags)
2837 return index_bulk_checkin(sha1, fd, size, type, path, flags);
2840 int index_fd(unsigned char *sha1, int fd, struct stat *st,
2841 enum object_type type, const char *path, unsigned flags)
2843 int ret;
2844 size_t size = xsize_t(st->st_size);
2846 if (!S_ISREG(st->st_mode))
2847 ret = index_pipe(sha1, fd, type, path, flags);
2848 else if (size <= big_file_threshold || type != OBJ_BLOB ||
2849 (path && would_convert_to_git(path, NULL, 0, 0)))
2850 ret = index_core(sha1, fd, size, type, path, flags);
2851 else
2852 ret = index_stream(sha1, fd, size, type, path, flags);
2853 close(fd);
2854 return ret;
2857 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
2859 int fd;
2860 struct strbuf sb = STRBUF_INIT;
2862 switch (st->st_mode & S_IFMT) {
2863 case S_IFREG:
2864 fd = open(path, O_RDONLY);
2865 if (fd < 0)
2866 return error("open(\"%s\"): %s", path,
2867 strerror(errno));
2868 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
2869 return error("%s: failed to insert into database",
2870 path);
2871 break;
2872 case S_IFLNK:
2873 if (strbuf_readlink(&sb, path, st->st_size)) {
2874 char *errstr = strerror(errno);
2875 return error("readlink(\"%s\"): %s", path,
2876 errstr);
2878 if (!(flags & HASH_WRITE_OBJECT))
2879 hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
2880 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
2881 return error("%s: failed to insert into database",
2882 path);
2883 strbuf_release(&sb);
2884 break;
2885 case S_IFDIR:
2886 return resolve_gitlink_ref(path, "HEAD", sha1);
2887 default:
2888 return error("%s: unsupported file type", path);
2890 return 0;
2893 int read_pack_header(int fd, struct pack_header *header)
2895 if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
2896 /* "eof before pack header was fully read" */
2897 return PH_ERROR_EOF;
2899 if (header->hdr_signature != htonl(PACK_SIGNATURE))
2900 /* "protocol error (pack signature mismatch detected)" */
2901 return PH_ERROR_PACK_SIGNATURE;
2902 if (!pack_version_ok(header->hdr_version))
2903 /* "protocol error (pack version unsupported)" */
2904 return PH_ERROR_PROTOCOL;
2905 return 0;
2908 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
2910 enum object_type type = sha1_object_info(sha1, NULL);
2911 if (type < 0)
2912 die("%s is not a valid object", sha1_to_hex(sha1));
2913 if (type != expect)
2914 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
2915 typename(expect));