git p4 doc: use two-line style for options with multiple spellings
[git/debian.git] / sha1_file.c
blobdaacc0cfb0132e98a98ba9645991f3d3f228d1cd
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];
39 static const char *no_log_pack_access = "no_log_pack_access";
40 static const char *log_pack_access;
43 * This is meant to hold a *small* number of objects that you would
44 * want read_sha1_file() to be able to return, but yet you do not want
45 * to write them into the object store (e.g. a browse-only
46 * application).
48 static struct cached_object {
49 unsigned char sha1[20];
50 enum object_type type;
51 void *buf;
52 unsigned long size;
53 } *cached_objects;
54 static int cached_object_nr, cached_object_alloc;
56 static struct cached_object empty_tree = {
57 EMPTY_TREE_SHA1_BIN_LITERAL,
58 OBJ_TREE,
59 "",
63 static struct packed_git *last_found_pack;
65 static struct cached_object *find_cached_object(const unsigned char *sha1)
67 int i;
68 struct cached_object *co = cached_objects;
70 for (i = 0; i < cached_object_nr; i++, co++) {
71 if (!hashcmp(co->sha1, sha1))
72 return co;
74 if (!hashcmp(sha1, empty_tree.sha1))
75 return &empty_tree;
76 return NULL;
79 int mkdir_in_gitdir(const char *path)
81 if (mkdir(path, 0777)) {
82 int saved_errno = errno;
83 struct stat st;
84 struct strbuf sb = STRBUF_INIT;
86 if (errno != EEXIST)
87 return -1;
89 * Are we looking at a path in a symlinked worktree
90 * whose original repository does not yet have it?
91 * e.g. .git/rr-cache pointing at its original
92 * repository in which the user hasn't performed any
93 * conflict resolution yet?
95 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
96 strbuf_readlink(&sb, path, st.st_size) ||
97 !is_absolute_path(sb.buf) ||
98 mkdir(sb.buf, 0777)) {
99 strbuf_release(&sb);
100 errno = saved_errno;
101 return -1;
103 strbuf_release(&sb);
105 return adjust_shared_perm(path);
108 int safe_create_leading_directories(char *path)
110 char *pos = path + offset_1st_component(path);
111 struct stat st;
113 while (pos) {
114 pos = strchr(pos, '/');
115 if (!pos)
116 break;
117 while (*++pos == '/')
119 if (!*pos)
120 break;
121 *--pos = '\0';
122 if (!stat(path, &st)) {
123 /* path exists */
124 if (!S_ISDIR(st.st_mode)) {
125 *pos = '/';
126 return -3;
129 else if (mkdir(path, 0777)) {
130 if (errno == EEXIST &&
131 !stat(path, &st) && S_ISDIR(st.st_mode)) {
132 ; /* somebody created it since we checked */
133 } else {
134 *pos = '/';
135 return -1;
138 else if (adjust_shared_perm(path)) {
139 *pos = '/';
140 return -2;
142 *pos++ = '/';
144 return 0;
147 int safe_create_leading_directories_const(const char *path)
149 /* path points to cache entries, so xstrdup before messing with it */
150 char *buf = xstrdup(path);
151 int result = safe_create_leading_directories(buf);
152 free(buf);
153 return result;
156 static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
158 int i;
159 for (i = 0; i < 20; i++) {
160 static char hex[] = "0123456789abcdef";
161 unsigned int val = sha1[i];
162 char *pos = pathbuf + i*2 + (i > 0);
163 *pos++ = hex[val >> 4];
164 *pos = hex[val & 0xf];
169 * NOTE! This returns a statically allocated buffer, so you have to be
170 * careful about using it. Do an "xstrdup()" if you need to save the
171 * filename.
173 * Also note that this returns the location for creating. Reading
174 * SHA1 file can happen from any alternate directory listed in the
175 * DB_ENVIRONMENT environment variable if it is not found in
176 * the primary object database.
178 char *sha1_file_name(const unsigned char *sha1)
180 static char buf[PATH_MAX];
181 const char *objdir;
182 int len;
184 objdir = get_object_directory();
185 len = strlen(objdir);
187 /* '/' + sha1(2) + '/' + sha1(38) + '\0' */
188 if (len + 43 > PATH_MAX)
189 die("insanely long object directory %s", objdir);
190 memcpy(buf, objdir, len);
191 buf[len] = '/';
192 buf[len+3] = '/';
193 buf[len+42] = '\0';
194 fill_sha1_path(buf + len + 1, sha1);
195 return buf;
198 static char *sha1_get_pack_name(const unsigned char *sha1,
199 char **name, char **base, const char *which)
201 static const char hex[] = "0123456789abcdef";
202 char *buf;
203 int i;
205 if (!*base) {
206 const char *sha1_file_directory = get_object_directory();
207 int len = strlen(sha1_file_directory);
208 *base = xmalloc(len + 60);
209 sprintf(*base, "%s/pack/pack-1234567890123456789012345678901234567890.%s",
210 sha1_file_directory, which);
211 *name = *base + len + 11;
214 buf = *name;
216 for (i = 0; i < 20; i++) {
217 unsigned int val = *sha1++;
218 *buf++ = hex[val >> 4];
219 *buf++ = hex[val & 0xf];
222 return *base;
225 char *sha1_pack_name(const unsigned char *sha1)
227 static char *name, *base;
229 return sha1_get_pack_name(sha1, &name, &base, "pack");
232 char *sha1_pack_index_name(const unsigned char *sha1)
234 static char *name, *base;
236 return sha1_get_pack_name(sha1, &name, &base, "idx");
239 struct alternate_object_database *alt_odb_list;
240 static struct alternate_object_database **alt_odb_tail;
242 static int git_open_noatime(const char *name);
245 * Prepare alternate object database registry.
247 * The variable alt_odb_list points at the list of struct
248 * alternate_object_database. The elements on this list come from
249 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
250 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
251 * whose contents is similar to that environment variable but can be
252 * LF separated. Its base points at a statically allocated buffer that
253 * contains "/the/directory/corresponding/to/.git/objects/...", while
254 * its name points just after the slash at the end of ".git/objects/"
255 * in the example above, and has enough space to hold 40-byte hex
256 * SHA1, an extra slash for the first level indirection, and the
257 * terminating NUL.
259 static int link_alt_odb_entry(const char *entry, const char *relative_base, int depth)
261 const char *objdir = get_object_directory();
262 struct alternate_object_database *ent;
263 struct alternate_object_database *alt;
264 int pfxlen, entlen;
265 struct strbuf pathbuf = STRBUF_INIT;
267 if (!is_absolute_path(entry) && relative_base) {
268 strbuf_addstr(&pathbuf, real_path(relative_base));
269 strbuf_addch(&pathbuf, '/');
271 strbuf_addstr(&pathbuf, entry);
273 normalize_path_copy(pathbuf.buf, pathbuf.buf);
275 pfxlen = strlen(pathbuf.buf);
278 * The trailing slash after the directory name is given by
279 * this function at the end. Remove duplicates.
281 while (pfxlen && pathbuf.buf[pfxlen-1] == '/')
282 pfxlen -= 1;
284 entlen = pfxlen + 43; /* '/' + 2 hex + '/' + 38 hex + NUL */
285 ent = xmalloc(sizeof(*ent) + entlen);
286 memcpy(ent->base, pathbuf.buf, pfxlen);
287 strbuf_release(&pathbuf);
289 ent->name = ent->base + pfxlen + 1;
290 ent->base[pfxlen + 3] = '/';
291 ent->base[pfxlen] = ent->base[entlen-1] = 0;
293 /* Detect cases where alternate disappeared */
294 if (!is_directory(ent->base)) {
295 error("object directory %s does not exist; "
296 "check .git/objects/info/alternates.",
297 ent->base);
298 free(ent);
299 return -1;
302 /* Prevent the common mistake of listing the same
303 * thing twice, or object directory itself.
305 for (alt = alt_odb_list; alt; alt = alt->next) {
306 if (!memcmp(ent->base, alt->base, pfxlen)) {
307 free(ent);
308 return -1;
311 if (!strcmp(ent->base, objdir)) {
312 free(ent);
313 return -1;
316 /* add the alternate entry */
317 *alt_odb_tail = ent;
318 alt_odb_tail = &(ent->next);
319 ent->next = NULL;
321 /* recursively add alternates */
322 read_info_alternates(ent->base, depth + 1);
324 ent->base[pfxlen] = '/';
326 return 0;
329 static void link_alt_odb_entries(const char *alt, int len, int sep,
330 const char *relative_base, int depth)
332 struct string_list entries = STRING_LIST_INIT_NODUP;
333 char *alt_copy;
334 int i;
336 if (depth > 5) {
337 error("%s: ignoring alternate object stores, nesting too deep.",
338 relative_base);
339 return;
342 alt_copy = xmemdupz(alt, len);
343 string_list_split_in_place(&entries, alt_copy, sep, -1);
344 for (i = 0; i < entries.nr; i++) {
345 const char *entry = entries.items[i].string;
346 if (entry[0] == '\0' || entry[0] == '#')
347 continue;
348 if (!is_absolute_path(entry) && depth) {
349 error("%s: ignoring relative alternate object store %s",
350 relative_base, entry);
351 } else {
352 link_alt_odb_entry(entry, relative_base, depth);
355 string_list_clear(&entries, 0);
356 free(alt_copy);
359 void read_info_alternates(const char * relative_base, int depth)
361 char *map;
362 size_t mapsz;
363 struct stat st;
364 const char alt_file_name[] = "info/alternates";
365 /* Given that relative_base is no longer than PATH_MAX,
366 ensure that "path" has enough space to append "/", the
367 file name, "info/alternates", and a trailing NUL. */
368 char path[PATH_MAX + 1 + sizeof alt_file_name];
369 int fd;
371 sprintf(path, "%s/%s", relative_base, alt_file_name);
372 fd = git_open_noatime(path);
373 if (fd < 0)
374 return;
375 if (fstat(fd, &st) || (st.st_size == 0)) {
376 close(fd);
377 return;
379 mapsz = xsize_t(st.st_size);
380 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
381 close(fd);
383 link_alt_odb_entries(map, mapsz, '\n', relative_base, depth);
385 munmap(map, mapsz);
388 void add_to_alternates_file(const char *reference)
390 struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
391 int fd = hold_lock_file_for_append(lock, git_path("objects/info/alternates"), LOCK_DIE_ON_ERROR);
392 char *alt = mkpath("%s\n", reference);
393 write_or_die(fd, alt, strlen(alt));
394 if (commit_lock_file(lock))
395 die("could not close alternates file");
396 if (alt_odb_tail)
397 link_alt_odb_entries(alt, strlen(alt), '\n', NULL, 0);
400 void foreach_alt_odb(alt_odb_fn fn, void *cb)
402 struct alternate_object_database *ent;
404 prepare_alt_odb();
405 for (ent = alt_odb_list; ent; ent = ent->next)
406 if (fn(ent, cb))
407 return;
410 void prepare_alt_odb(void)
412 const char *alt;
414 if (alt_odb_tail)
415 return;
417 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
418 if (!alt) alt = "";
420 alt_odb_tail = &alt_odb_list;
421 link_alt_odb_entries(alt, strlen(alt), PATH_SEP, NULL, 0);
423 read_info_alternates(get_object_directory(), 0);
426 static int has_loose_object_local(const unsigned char *sha1)
428 char *name = sha1_file_name(sha1);
429 return !access(name, F_OK);
432 int has_loose_object_nonlocal(const unsigned char *sha1)
434 struct alternate_object_database *alt;
435 prepare_alt_odb();
436 for (alt = alt_odb_list; alt; alt = alt->next) {
437 fill_sha1_path(alt->name, sha1);
438 if (!access(alt->base, F_OK))
439 return 1;
441 return 0;
444 static int has_loose_object(const unsigned char *sha1)
446 return has_loose_object_local(sha1) ||
447 has_loose_object_nonlocal(sha1);
450 static unsigned int pack_used_ctr;
451 static unsigned int pack_mmap_calls;
452 static unsigned int peak_pack_open_windows;
453 static unsigned int pack_open_windows;
454 static unsigned int pack_open_fds;
455 static unsigned int pack_max_fds;
456 static size_t peak_pack_mapped;
457 static size_t pack_mapped;
458 struct packed_git *packed_git;
460 void pack_report(void)
462 fprintf(stderr,
463 "pack_report: getpagesize() = %10" SZ_FMT "\n"
464 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
465 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
466 sz_fmt(getpagesize()),
467 sz_fmt(packed_git_window_size),
468 sz_fmt(packed_git_limit));
469 fprintf(stderr,
470 "pack_report: pack_used_ctr = %10u\n"
471 "pack_report: pack_mmap_calls = %10u\n"
472 "pack_report: pack_open_windows = %10u / %10u\n"
473 "pack_report: pack_mapped = "
474 "%10" SZ_FMT " / %10" SZ_FMT "\n",
475 pack_used_ctr,
476 pack_mmap_calls,
477 pack_open_windows, peak_pack_open_windows,
478 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
481 static int check_packed_git_idx(const char *path, struct packed_git *p)
483 void *idx_map;
484 struct pack_idx_header *hdr;
485 size_t idx_size;
486 uint32_t version, nr, i, *index;
487 int fd = git_open_noatime(path);
488 struct stat st;
490 if (fd < 0)
491 return -1;
492 if (fstat(fd, &st)) {
493 close(fd);
494 return -1;
496 idx_size = xsize_t(st.st_size);
497 if (idx_size < 4 * 256 + 20 + 20) {
498 close(fd);
499 return error("index file %s is too small", path);
501 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
502 close(fd);
504 hdr = idx_map;
505 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
506 version = ntohl(hdr->idx_version);
507 if (version < 2 || version > 2) {
508 munmap(idx_map, idx_size);
509 return error("index file %s is version %"PRIu32
510 " and is not supported by this binary"
511 " (try upgrading GIT to a newer version)",
512 path, version);
514 } else
515 version = 1;
517 nr = 0;
518 index = idx_map;
519 if (version > 1)
520 index += 2; /* skip index header */
521 for (i = 0; i < 256; i++) {
522 uint32_t n = ntohl(index[i]);
523 if (n < nr) {
524 munmap(idx_map, idx_size);
525 return error("non-monotonic index %s", path);
527 nr = n;
530 if (version == 1) {
532 * Total size:
533 * - 256 index entries 4 bytes each
534 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
535 * - 20-byte SHA1 of the packfile
536 * - 20-byte SHA1 file checksum
538 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
539 munmap(idx_map, idx_size);
540 return error("wrong index v1 file size in %s", path);
542 } else if (version == 2) {
544 * Minimum size:
545 * - 8 bytes of header
546 * - 256 index entries 4 bytes each
547 * - 20-byte sha1 entry * nr
548 * - 4-byte crc entry * nr
549 * - 4-byte offset entry * nr
550 * - 20-byte SHA1 of the packfile
551 * - 20-byte SHA1 file checksum
552 * And after the 4-byte offset table might be a
553 * variable sized table containing 8-byte entries
554 * for offsets larger than 2^31.
556 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
557 unsigned long max_size = min_size;
558 if (nr)
559 max_size += (nr - 1)*8;
560 if (idx_size < min_size || idx_size > max_size) {
561 munmap(idx_map, idx_size);
562 return error("wrong index v2 file size in %s", path);
564 if (idx_size != min_size &&
566 * make sure we can deal with large pack offsets.
567 * 31-bit signed offset won't be enough, neither
568 * 32-bit unsigned one will be.
570 (sizeof(off_t) <= 4)) {
571 munmap(idx_map, idx_size);
572 return error("pack too large for current definition of off_t in %s", path);
576 p->index_version = version;
577 p->index_data = idx_map;
578 p->index_size = idx_size;
579 p->num_objects = nr;
580 return 0;
583 int open_pack_index(struct packed_git *p)
585 char *idx_name;
586 int ret;
588 if (p->index_data)
589 return 0;
591 idx_name = xstrdup(p->pack_name);
592 strcpy(idx_name + strlen(idx_name) - strlen(".pack"), ".idx");
593 ret = check_packed_git_idx(idx_name, p);
594 free(idx_name);
595 return ret;
598 static void scan_windows(struct packed_git *p,
599 struct packed_git **lru_p,
600 struct pack_window **lru_w,
601 struct pack_window **lru_l)
603 struct pack_window *w, *w_l;
605 for (w_l = NULL, w = p->windows; w; w = w->next) {
606 if (!w->inuse_cnt) {
607 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
608 *lru_p = p;
609 *lru_w = w;
610 *lru_l = w_l;
613 w_l = w;
617 static int unuse_one_window(struct packed_git *current)
619 struct packed_git *p, *lru_p = NULL;
620 struct pack_window *lru_w = NULL, *lru_l = NULL;
622 if (current)
623 scan_windows(current, &lru_p, &lru_w, &lru_l);
624 for (p = packed_git; p; p = p->next)
625 scan_windows(p, &lru_p, &lru_w, &lru_l);
626 if (lru_p) {
627 munmap(lru_w->base, lru_w->len);
628 pack_mapped -= lru_w->len;
629 if (lru_l)
630 lru_l->next = lru_w->next;
631 else
632 lru_p->windows = lru_w->next;
633 free(lru_w);
634 pack_open_windows--;
635 return 1;
637 return 0;
640 void release_pack_memory(size_t need)
642 size_t cur = pack_mapped;
643 while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
644 ; /* nothing */
647 void *xmmap(void *start, size_t length,
648 int prot, int flags, int fd, off_t offset)
650 void *ret = mmap(start, length, prot, flags, fd, offset);
651 if (ret == MAP_FAILED) {
652 if (!length)
653 return NULL;
654 release_pack_memory(length);
655 ret = mmap(start, length, prot, flags, fd, offset);
656 if (ret == MAP_FAILED)
657 die_errno("Out of memory? mmap failed");
659 return ret;
662 void close_pack_windows(struct packed_git *p)
664 while (p->windows) {
665 struct pack_window *w = p->windows;
667 if (w->inuse_cnt)
668 die("pack '%s' still has open windows to it",
669 p->pack_name);
670 munmap(w->base, w->len);
671 pack_mapped -= w->len;
672 pack_open_windows--;
673 p->windows = w->next;
674 free(w);
679 * The LRU pack is the one with the oldest MRU window, preferring packs
680 * with no used windows, or the oldest mtime if it has no windows allocated.
682 static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
684 struct pack_window *w, *this_mru_w;
685 int has_windows_inuse = 0;
688 * Reject this pack if it has windows and the previously selected
689 * one does not. If this pack does not have windows, reject
690 * it if the pack file is newer than the previously selected one.
692 if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
693 return;
695 for (w = this_mru_w = p->windows; w; w = w->next) {
697 * Reject this pack if any of its windows are in use,
698 * but the previously selected pack did not have any
699 * inuse windows. Otherwise, record that this pack
700 * has windows in use.
702 if (w->inuse_cnt) {
703 if (*accept_windows_inuse)
704 has_windows_inuse = 1;
705 else
706 return;
709 if (w->last_used > this_mru_w->last_used)
710 this_mru_w = w;
713 * Reject this pack if it has windows that have been
714 * used more recently than the previously selected pack.
715 * If the previously selected pack had windows inuse and
716 * we have not encountered a window in this pack that is
717 * inuse, skip this check since we prefer a pack with no
718 * inuse windows to one that has inuse windows.
720 if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
721 this_mru_w->last_used > (*mru_w)->last_used)
722 return;
726 * Select this pack.
728 *mru_w = this_mru_w;
729 *lru_p = p;
730 *accept_windows_inuse = has_windows_inuse;
733 static int close_one_pack(void)
735 struct packed_git *p, *lru_p = NULL;
736 struct pack_window *mru_w = NULL;
737 int accept_windows_inuse = 1;
739 for (p = packed_git; p; p = p->next) {
740 if (p->pack_fd == -1)
741 continue;
742 find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
745 if (lru_p) {
746 close(lru_p->pack_fd);
747 pack_open_fds--;
748 lru_p->pack_fd = -1;
749 return 1;
752 return 0;
755 void unuse_pack(struct pack_window **w_cursor)
757 struct pack_window *w = *w_cursor;
758 if (w) {
759 w->inuse_cnt--;
760 *w_cursor = NULL;
764 void close_pack_index(struct packed_git *p)
766 if (p->index_data) {
767 munmap((void *)p->index_data, p->index_size);
768 p->index_data = NULL;
773 * This is used by git-repack in case a newly created pack happens to
774 * contain the same set of objects as an existing one. In that case
775 * the resulting file might be different even if its name would be the
776 * same. It is best to close any reference to the old pack before it is
777 * replaced on disk. Of course no index pointers nor windows for given pack
778 * must subsist at this point. If ever objects from this pack are requested
779 * again, the new version of the pack will be reinitialized through
780 * reprepare_packed_git().
782 void free_pack_by_name(const char *pack_name)
784 struct packed_git *p, **pp = &packed_git;
786 while (*pp) {
787 p = *pp;
788 if (strcmp(pack_name, p->pack_name) == 0) {
789 clear_delta_base_cache();
790 close_pack_windows(p);
791 if (p->pack_fd != -1) {
792 close(p->pack_fd);
793 pack_open_fds--;
795 close_pack_index(p);
796 free(p->bad_object_sha1);
797 *pp = p->next;
798 if (last_found_pack == p)
799 last_found_pack = NULL;
800 free(p);
801 return;
803 pp = &p->next;
807 static unsigned int get_max_fd_limit(void)
809 #ifdef RLIMIT_NOFILE
810 struct rlimit lim;
812 if (getrlimit(RLIMIT_NOFILE, &lim))
813 die_errno("cannot get RLIMIT_NOFILE");
815 return lim.rlim_cur;
816 #elif defined(_SC_OPEN_MAX)
817 return sysconf(_SC_OPEN_MAX);
818 #elif defined(OPEN_MAX)
819 return OPEN_MAX;
820 #else
821 return 1; /* see the caller ;-) */
822 #endif
826 * Do not call this directly as this leaks p->pack_fd on error return;
827 * call open_packed_git() instead.
829 static int open_packed_git_1(struct packed_git *p)
831 struct stat st;
832 struct pack_header hdr;
833 unsigned char sha1[20];
834 unsigned char *idx_sha1;
835 long fd_flag;
837 if (!p->index_data && open_pack_index(p))
838 return error("packfile %s index unavailable", p->pack_name);
840 if (!pack_max_fds) {
841 unsigned int max_fds = get_max_fd_limit();
843 /* Save 3 for stdin/stdout/stderr, 22 for work */
844 if (25 < max_fds)
845 pack_max_fds = max_fds - 25;
846 else
847 pack_max_fds = 1;
850 while (pack_max_fds <= pack_open_fds && close_one_pack())
851 ; /* nothing */
853 p->pack_fd = git_open_noatime(p->pack_name);
854 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
855 return -1;
856 pack_open_fds++;
858 /* If we created the struct before we had the pack we lack size. */
859 if (!p->pack_size) {
860 if (!S_ISREG(st.st_mode))
861 return error("packfile %s not a regular file", p->pack_name);
862 p->pack_size = st.st_size;
863 } else if (p->pack_size != st.st_size)
864 return error("packfile %s size changed", p->pack_name);
866 /* We leave these file descriptors open with sliding mmap;
867 * there is no point keeping them open across exec(), though.
869 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
870 if (fd_flag < 0)
871 return error("cannot determine file descriptor flags");
872 fd_flag |= FD_CLOEXEC;
873 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
874 return error("cannot set FD_CLOEXEC");
876 /* Verify we recognize this pack file format. */
877 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
878 return error("file %s is far too short to be a packfile", p->pack_name);
879 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
880 return error("file %s is not a GIT packfile", p->pack_name);
881 if (!pack_version_ok(hdr.hdr_version))
882 return error("packfile %s is version %"PRIu32" and not"
883 " supported (try upgrading GIT to a newer version)",
884 p->pack_name, ntohl(hdr.hdr_version));
886 /* Verify the pack matches its index. */
887 if (p->num_objects != ntohl(hdr.hdr_entries))
888 return error("packfile %s claims to have %"PRIu32" objects"
889 " while index indicates %"PRIu32" objects",
890 p->pack_name, ntohl(hdr.hdr_entries),
891 p->num_objects);
892 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
893 return error("end of packfile %s is unavailable", p->pack_name);
894 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
895 return error("packfile %s signature is unavailable", p->pack_name);
896 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
897 if (hashcmp(sha1, idx_sha1))
898 return error("packfile %s does not match index", p->pack_name);
899 return 0;
902 static int open_packed_git(struct packed_git *p)
904 if (!open_packed_git_1(p))
905 return 0;
906 if (p->pack_fd != -1) {
907 close(p->pack_fd);
908 pack_open_fds--;
909 p->pack_fd = -1;
911 return -1;
914 static int in_window(struct pack_window *win, off_t offset)
916 /* We must promise at least 20 bytes (one hash) after the
917 * offset is available from this window, otherwise the offset
918 * is not actually in this window and a different window (which
919 * has that one hash excess) must be used. This is to support
920 * the object header and delta base parsing routines below.
922 off_t win_off = win->offset;
923 return win_off <= offset
924 && (offset + 20) <= (win_off + win->len);
927 unsigned char *use_pack(struct packed_git *p,
928 struct pack_window **w_cursor,
929 off_t offset,
930 unsigned long *left)
932 struct pack_window *win = *w_cursor;
934 /* Since packfiles end in a hash of their content and it's
935 * pointless to ask for an offset into the middle of that
936 * hash, and the in_window function above wouldn't match
937 * don't allow an offset too close to the end of the file.
939 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
940 die("packfile %s cannot be accessed", p->pack_name);
941 if (offset > (p->pack_size - 20))
942 die("offset beyond end of packfile (truncated pack?)");
944 if (!win || !in_window(win, offset)) {
945 if (win)
946 win->inuse_cnt--;
947 for (win = p->windows; win; win = win->next) {
948 if (in_window(win, offset))
949 break;
951 if (!win) {
952 size_t window_align = packed_git_window_size / 2;
953 off_t len;
955 if (p->pack_fd == -1 && open_packed_git(p))
956 die("packfile %s cannot be accessed", p->pack_name);
958 win = xcalloc(1, sizeof(*win));
959 win->offset = (offset / window_align) * window_align;
960 len = p->pack_size - win->offset;
961 if (len > packed_git_window_size)
962 len = packed_git_window_size;
963 win->len = (size_t)len;
964 pack_mapped += win->len;
965 while (packed_git_limit < pack_mapped
966 && unuse_one_window(p))
967 ; /* nothing */
968 win->base = xmmap(NULL, win->len,
969 PROT_READ, MAP_PRIVATE,
970 p->pack_fd, win->offset);
971 if (win->base == MAP_FAILED)
972 die("packfile %s cannot be mapped: %s",
973 p->pack_name,
974 strerror(errno));
975 if (!win->offset && win->len == p->pack_size
976 && !p->do_not_close) {
977 close(p->pack_fd);
978 pack_open_fds--;
979 p->pack_fd = -1;
981 pack_mmap_calls++;
982 pack_open_windows++;
983 if (pack_mapped > peak_pack_mapped)
984 peak_pack_mapped = pack_mapped;
985 if (pack_open_windows > peak_pack_open_windows)
986 peak_pack_open_windows = pack_open_windows;
987 win->next = p->windows;
988 p->windows = win;
991 if (win != *w_cursor) {
992 win->last_used = pack_used_ctr++;
993 win->inuse_cnt++;
994 *w_cursor = win;
996 offset -= win->offset;
997 if (left)
998 *left = win->len - xsize_t(offset);
999 return win->base + offset;
1002 static struct packed_git *alloc_packed_git(int extra)
1004 struct packed_git *p = xmalloc(sizeof(*p) + extra);
1005 memset(p, 0, sizeof(*p));
1006 p->pack_fd = -1;
1007 return p;
1010 static void try_to_free_pack_memory(size_t size)
1012 release_pack_memory(size);
1015 struct packed_git *add_packed_git(const char *path, int path_len, int local)
1017 static int have_set_try_to_free_routine;
1018 struct stat st;
1019 struct packed_git *p = alloc_packed_git(path_len + 2);
1021 if (!have_set_try_to_free_routine) {
1022 have_set_try_to_free_routine = 1;
1023 set_try_to_free_routine(try_to_free_pack_memory);
1027 * Make sure a corresponding .pack file exists and that
1028 * the index looks sane.
1030 path_len -= strlen(".idx");
1031 if (path_len < 1) {
1032 free(p);
1033 return NULL;
1035 memcpy(p->pack_name, path, path_len);
1037 strcpy(p->pack_name + path_len, ".keep");
1038 if (!access(p->pack_name, F_OK))
1039 p->pack_keep = 1;
1041 strcpy(p->pack_name + path_len, ".pack");
1042 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
1043 free(p);
1044 return NULL;
1047 /* ok, it looks sane as far as we can check without
1048 * actually mapping the pack file.
1050 p->pack_size = st.st_size;
1051 p->pack_local = local;
1052 p->mtime = st.st_mtime;
1053 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
1054 hashclr(p->sha1);
1055 return p;
1058 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
1060 const char *path = sha1_pack_name(sha1);
1061 struct packed_git *p = alloc_packed_git(strlen(path) + 1);
1063 strcpy(p->pack_name, path);
1064 hashcpy(p->sha1, sha1);
1065 if (check_packed_git_idx(idx_path, p)) {
1066 free(p);
1067 return NULL;
1070 return p;
1073 void install_packed_git(struct packed_git *pack)
1075 if (pack->pack_fd != -1)
1076 pack_open_fds++;
1078 pack->next = packed_git;
1079 packed_git = pack;
1082 void (*report_garbage)(const char *desc, const char *path);
1084 static void report_helper(const struct string_list *list,
1085 int seen_bits, int first, int last)
1087 const char *msg;
1088 switch (seen_bits) {
1089 case 0:
1090 msg = "no corresponding .idx nor .pack";
1091 break;
1092 case 1:
1093 msg = "no corresponding .idx";
1094 break;
1095 case 2:
1096 msg = "no corresponding .pack";
1097 break;
1098 default:
1099 return;
1101 for (; first < last; first++)
1102 report_garbage(msg, list->items[first].string);
1105 static void report_pack_garbage(struct string_list *list)
1107 int i, baselen = -1, first = 0, seen_bits = 0;
1109 if (!report_garbage)
1110 return;
1112 sort_string_list(list);
1114 for (i = 0; i < list->nr; i++) {
1115 const char *path = list->items[i].string;
1116 if (baselen != -1 &&
1117 strncmp(path, list->items[first].string, baselen)) {
1118 report_helper(list, seen_bits, first, i);
1119 baselen = -1;
1120 seen_bits = 0;
1122 if (baselen == -1) {
1123 const char *dot = strrchr(path, '.');
1124 if (!dot) {
1125 report_garbage("garbage found", path);
1126 continue;
1128 baselen = dot - path + 1;
1129 first = i;
1131 if (!strcmp(path + baselen, "pack"))
1132 seen_bits |= 1;
1133 else if (!strcmp(path + baselen, "idx"))
1134 seen_bits |= 2;
1136 report_helper(list, seen_bits, first, list->nr);
1139 static void prepare_packed_git_one(char *objdir, int local)
1141 /* Ensure that this buffer is large enough so that we can
1142 append "/pack/" without clobbering the stack even if
1143 strlen(objdir) were PATH_MAX. */
1144 char path[PATH_MAX + 1 + 4 + 1 + 1];
1145 int len;
1146 DIR *dir;
1147 struct dirent *de;
1148 struct string_list garbage = STRING_LIST_INIT_DUP;
1150 sprintf(path, "%s/pack", objdir);
1151 len = strlen(path);
1152 dir = opendir(path);
1153 if (!dir) {
1154 if (errno != ENOENT)
1155 error("unable to open object pack directory: %s: %s",
1156 path, strerror(errno));
1157 return;
1159 path[len++] = '/';
1160 while ((de = readdir(dir)) != NULL) {
1161 int namelen = strlen(de->d_name);
1162 struct packed_git *p;
1164 if (len + namelen + 1 > sizeof(path)) {
1165 if (report_garbage) {
1166 struct strbuf sb = STRBUF_INIT;
1167 strbuf_addf(&sb, "%.*s/%s", len - 1, path, de->d_name);
1168 report_garbage("path too long", sb.buf);
1169 strbuf_release(&sb);
1171 continue;
1174 if (is_dot_or_dotdot(de->d_name))
1175 continue;
1177 strcpy(path + len, de->d_name);
1179 if (has_extension(de->d_name, ".idx")) {
1180 /* Don't reopen a pack we already have. */
1181 for (p = packed_git; p; p = p->next) {
1182 if (!memcmp(path, p->pack_name, len + namelen - 4))
1183 break;
1185 if (p == NULL &&
1187 * See if it really is a valid .idx file with
1188 * corresponding .pack file that we can map.
1190 (p = add_packed_git(path, len + namelen, local)) != NULL)
1191 install_packed_git(p);
1194 if (!report_garbage)
1195 continue;
1197 if (has_extension(de->d_name, ".idx") ||
1198 has_extension(de->d_name, ".pack") ||
1199 has_extension(de->d_name, ".keep"))
1200 string_list_append(&garbage, path);
1201 else
1202 report_garbage("garbage found", path);
1204 closedir(dir);
1205 report_pack_garbage(&garbage);
1206 string_list_clear(&garbage, 0);
1209 static int sort_pack(const void *a_, const void *b_)
1211 struct packed_git *a = *((struct packed_git **)a_);
1212 struct packed_git *b = *((struct packed_git **)b_);
1213 int st;
1216 * Local packs tend to contain objects specific to our
1217 * variant of the project than remote ones. In addition,
1218 * remote ones could be on a network mounted filesystem.
1219 * Favor local ones for these reasons.
1221 st = a->pack_local - b->pack_local;
1222 if (st)
1223 return -st;
1226 * Younger packs tend to contain more recent objects,
1227 * and more recent objects tend to get accessed more
1228 * often.
1230 if (a->mtime < b->mtime)
1231 return 1;
1232 else if (a->mtime == b->mtime)
1233 return 0;
1234 return -1;
1237 static void rearrange_packed_git(void)
1239 struct packed_git **ary, *p;
1240 int i, n;
1242 for (n = 0, p = packed_git; p; p = p->next)
1243 n++;
1244 if (n < 2)
1245 return;
1247 /* prepare an array of packed_git for easier sorting */
1248 ary = xcalloc(n, sizeof(struct packed_git *));
1249 for (n = 0, p = packed_git; p; p = p->next)
1250 ary[n++] = p;
1252 qsort(ary, n, sizeof(struct packed_git *), sort_pack);
1254 /* link them back again */
1255 for (i = 0; i < n - 1; i++)
1256 ary[i]->next = ary[i + 1];
1257 ary[n - 1]->next = NULL;
1258 packed_git = ary[0];
1260 free(ary);
1263 static int prepare_packed_git_run_once = 0;
1264 void prepare_packed_git(void)
1266 struct alternate_object_database *alt;
1268 if (prepare_packed_git_run_once)
1269 return;
1270 prepare_packed_git_one(get_object_directory(), 1);
1271 prepare_alt_odb();
1272 for (alt = alt_odb_list; alt; alt = alt->next) {
1273 alt->name[-1] = 0;
1274 prepare_packed_git_one(alt->base, 0);
1275 alt->name[-1] = '/';
1277 rearrange_packed_git();
1278 prepare_packed_git_run_once = 1;
1281 void reprepare_packed_git(void)
1283 discard_revindex();
1284 prepare_packed_git_run_once = 0;
1285 prepare_packed_git();
1288 static void mark_bad_packed_object(struct packed_git *p,
1289 const unsigned char *sha1)
1291 unsigned i;
1292 for (i = 0; i < p->num_bad_objects; i++)
1293 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1294 return;
1295 p->bad_object_sha1 = xrealloc(p->bad_object_sha1, 20 * (p->num_bad_objects + 1));
1296 hashcpy(p->bad_object_sha1 + 20 * p->num_bad_objects, sha1);
1297 p->num_bad_objects++;
1300 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1302 struct packed_git *p;
1303 unsigned i;
1305 for (p = packed_git; p; p = p->next)
1306 for (i = 0; i < p->num_bad_objects; i++)
1307 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1308 return p;
1309 return NULL;
1313 * With an in-core object data in "map", rehash it to make sure the
1314 * object name actually matches "sha1" to detect object corruption.
1315 * With "map" == NULL, try reading the object named with "sha1" using
1316 * the streaming interface and rehash it to do the same.
1318 int check_sha1_signature(const unsigned char *sha1, void *map,
1319 unsigned long size, const char *type)
1321 unsigned char real_sha1[20];
1322 enum object_type obj_type;
1323 struct git_istream *st;
1324 git_SHA_CTX c;
1325 char hdr[32];
1326 int hdrlen;
1328 if (map) {
1329 hash_sha1_file(map, size, type, real_sha1);
1330 return hashcmp(sha1, real_sha1) ? -1 : 0;
1333 st = open_istream(sha1, &obj_type, &size, NULL);
1334 if (!st)
1335 return -1;
1337 /* Generate the header */
1338 hdrlen = sprintf(hdr, "%s %lu", typename(obj_type), size) + 1;
1340 /* Sha1.. */
1341 git_SHA1_Init(&c);
1342 git_SHA1_Update(&c, hdr, hdrlen);
1343 for (;;) {
1344 char buf[1024 * 16];
1345 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1347 if (readlen < 0) {
1348 close_istream(st);
1349 return -1;
1351 if (!readlen)
1352 break;
1353 git_SHA1_Update(&c, buf, readlen);
1355 git_SHA1_Final(real_sha1, &c);
1356 close_istream(st);
1357 return hashcmp(sha1, real_sha1) ? -1 : 0;
1360 static int git_open_noatime(const char *name)
1362 static int sha1_file_open_flag = O_NOATIME;
1364 for (;;) {
1365 int fd = open(name, O_RDONLY | sha1_file_open_flag);
1366 if (fd >= 0)
1367 return fd;
1369 /* Might the failure be due to O_NOATIME? */
1370 if (errno != ENOENT && sha1_file_open_flag) {
1371 sha1_file_open_flag = 0;
1372 continue;
1375 return -1;
1379 static int stat_sha1_file(const unsigned char *sha1, struct stat *st)
1381 char *name = sha1_file_name(sha1);
1382 struct alternate_object_database *alt;
1384 if (!lstat(name, st))
1385 return 0;
1387 prepare_alt_odb();
1388 errno = ENOENT;
1389 for (alt = alt_odb_list; alt; alt = alt->next) {
1390 name = alt->name;
1391 fill_sha1_path(name, sha1);
1392 if (!lstat(alt->base, st))
1393 return 0;
1396 return -1;
1399 static int open_sha1_file(const unsigned char *sha1)
1401 int fd;
1402 char *name = sha1_file_name(sha1);
1403 struct alternate_object_database *alt;
1405 fd = git_open_noatime(name);
1406 if (fd >= 0)
1407 return fd;
1409 prepare_alt_odb();
1410 errno = ENOENT;
1411 for (alt = alt_odb_list; alt; alt = alt->next) {
1412 name = alt->name;
1413 fill_sha1_path(name, sha1);
1414 fd = git_open_noatime(alt->base);
1415 if (fd >= 0)
1416 return fd;
1418 return -1;
1421 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1423 void *map;
1424 int fd;
1426 fd = open_sha1_file(sha1);
1427 map = NULL;
1428 if (fd >= 0) {
1429 struct stat st;
1431 if (!fstat(fd, &st)) {
1432 *size = xsize_t(st.st_size);
1433 if (!*size) {
1434 /* mmap() is forbidden on empty files */
1435 error("object file %s is empty", sha1_file_name(sha1));
1436 return NULL;
1438 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1440 close(fd);
1442 return map;
1445 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1446 unsigned long len, enum object_type *type, unsigned long *sizep)
1448 unsigned shift;
1449 unsigned long size, c;
1450 unsigned long used = 0;
1452 c = buf[used++];
1453 *type = (c >> 4) & 7;
1454 size = c & 15;
1455 shift = 4;
1456 while (c & 0x80) {
1457 if (len <= used || bitsizeof(long) <= shift) {
1458 error("bad object header");
1459 size = used = 0;
1460 break;
1462 c = buf[used++];
1463 size += (c & 0x7f) << shift;
1464 shift += 7;
1466 *sizep = size;
1467 return used;
1470 int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz)
1472 /* Get the data stream */
1473 memset(stream, 0, sizeof(*stream));
1474 stream->next_in = map;
1475 stream->avail_in = mapsize;
1476 stream->next_out = buffer;
1477 stream->avail_out = bufsiz;
1479 git_inflate_init(stream);
1480 return git_inflate(stream, 0);
1483 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1485 int bytes = strlen(buffer) + 1;
1486 unsigned char *buf = xmallocz(size);
1487 unsigned long n;
1488 int status = Z_OK;
1490 n = stream->total_out - bytes;
1491 if (n > size)
1492 n = size;
1493 memcpy(buf, (char *) buffer + bytes, n);
1494 bytes = n;
1495 if (bytes <= size) {
1497 * The above condition must be (bytes <= size), not
1498 * (bytes < size). In other words, even though we
1499 * expect no more output and set avail_out to zero,
1500 * the input zlib stream may have bytes that express
1501 * "this concludes the stream", and we *do* want to
1502 * eat that input.
1504 * Otherwise we would not be able to test that we
1505 * consumed all the input to reach the expected size;
1506 * we also want to check that zlib tells us that all
1507 * went well with status == Z_STREAM_END at the end.
1509 stream->next_out = buf + bytes;
1510 stream->avail_out = size - bytes;
1511 while (status == Z_OK)
1512 status = git_inflate(stream, Z_FINISH);
1514 if (status == Z_STREAM_END && !stream->avail_in) {
1515 git_inflate_end(stream);
1516 return buf;
1519 if (status < 0)
1520 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1521 else if (stream->avail_in)
1522 error("garbage at end of loose object '%s'",
1523 sha1_to_hex(sha1));
1524 free(buf);
1525 return NULL;
1529 * We used to just use "sscanf()", but that's actually way
1530 * too permissive for what we want to check. So do an anal
1531 * object header parse by hand.
1533 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1535 char type[10];
1536 int i;
1537 unsigned long size;
1540 * The type can be at most ten bytes (including the
1541 * terminating '\0' that we add), and is followed by
1542 * a space.
1544 i = 0;
1545 for (;;) {
1546 char c = *hdr++;
1547 if (c == ' ')
1548 break;
1549 type[i++] = c;
1550 if (i >= sizeof(type))
1551 return -1;
1553 type[i] = 0;
1556 * The length must follow immediately, and be in canonical
1557 * decimal format (ie "010" is not valid).
1559 size = *hdr++ - '0';
1560 if (size > 9)
1561 return -1;
1562 if (size) {
1563 for (;;) {
1564 unsigned long c = *hdr - '0';
1565 if (c > 9)
1566 break;
1567 hdr++;
1568 size = size * 10 + c;
1571 *sizep = size;
1574 * The length must be followed by a zero byte
1576 return *hdr ? -1 : type_from_string(type);
1579 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1581 int ret;
1582 git_zstream stream;
1583 char hdr[8192];
1585 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1586 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1587 return NULL;
1589 return unpack_sha1_rest(&stream, hdr, *size, sha1);
1592 unsigned long get_size_from_delta(struct packed_git *p,
1593 struct pack_window **w_curs,
1594 off_t curpos)
1596 const unsigned char *data;
1597 unsigned char delta_head[20], *in;
1598 git_zstream stream;
1599 int st;
1601 memset(&stream, 0, sizeof(stream));
1602 stream.next_out = delta_head;
1603 stream.avail_out = sizeof(delta_head);
1605 git_inflate_init(&stream);
1606 do {
1607 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1608 stream.next_in = in;
1609 st = git_inflate(&stream, Z_FINISH);
1610 curpos += stream.next_in - in;
1611 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1612 stream.total_out < sizeof(delta_head));
1613 git_inflate_end(&stream);
1614 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1615 error("delta data unpack-initial failed");
1616 return 0;
1619 /* Examine the initial part of the delta to figure out
1620 * the result size.
1622 data = delta_head;
1624 /* ignore base size */
1625 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1627 /* Read the result size */
1628 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1631 static off_t get_delta_base(struct packed_git *p,
1632 struct pack_window **w_curs,
1633 off_t *curpos,
1634 enum object_type type,
1635 off_t delta_obj_offset)
1637 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1638 off_t base_offset;
1640 /* use_pack() assured us we have [base_info, base_info + 20)
1641 * as a range that we can look at without walking off the
1642 * end of the mapped window. Its actually the hash size
1643 * that is assured. An OFS_DELTA longer than the hash size
1644 * is stupid, as then a REF_DELTA would be smaller to store.
1646 if (type == OBJ_OFS_DELTA) {
1647 unsigned used = 0;
1648 unsigned char c = base_info[used++];
1649 base_offset = c & 127;
1650 while (c & 128) {
1651 base_offset += 1;
1652 if (!base_offset || MSB(base_offset, 7))
1653 return 0; /* overflow */
1654 c = base_info[used++];
1655 base_offset = (base_offset << 7) + (c & 127);
1657 base_offset = delta_obj_offset - base_offset;
1658 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1659 return 0; /* out of bound */
1660 *curpos += used;
1661 } else if (type == OBJ_REF_DELTA) {
1662 /* The base entry _must_ be in the same pack */
1663 base_offset = find_pack_entry_one(base_info, p);
1664 *curpos += 20;
1665 } else
1666 die("I am totally screwed");
1667 return base_offset;
1670 int unpack_object_header(struct packed_git *p,
1671 struct pack_window **w_curs,
1672 off_t *curpos,
1673 unsigned long *sizep)
1675 unsigned char *base;
1676 unsigned long left;
1677 unsigned long used;
1678 enum object_type type;
1680 /* use_pack() assures us we have [base, base + 20) available
1681 * as a range that we can look at. (Its actually the hash
1682 * size that is assured.) With our object header encoding
1683 * the maximum deflated object size is 2^137, which is just
1684 * insane, so we know won't exceed what we have been given.
1686 base = use_pack(p, w_curs, *curpos, &left);
1687 used = unpack_object_header_buffer(base, left, &type, sizep);
1688 if (!used) {
1689 type = OBJ_BAD;
1690 } else
1691 *curpos += used;
1693 return type;
1696 static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
1698 int type;
1699 struct revindex_entry *revidx;
1700 const unsigned char *sha1;
1701 revidx = find_pack_revindex(p, obj_offset);
1702 if (!revidx)
1703 return OBJ_BAD;
1704 sha1 = nth_packed_object_sha1(p, revidx->nr);
1705 mark_bad_packed_object(p, sha1);
1706 type = sha1_object_info(sha1, NULL);
1707 if (type <= OBJ_NONE)
1708 return OBJ_BAD;
1709 return type;
1712 #define POI_STACK_PREALLOC 64
1714 static enum object_type packed_to_object_type(struct packed_git *p,
1715 off_t obj_offset,
1716 enum object_type type,
1717 struct pack_window **w_curs,
1718 off_t curpos)
1720 off_t small_poi_stack[POI_STACK_PREALLOC];
1721 off_t *poi_stack = small_poi_stack;
1722 int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
1724 while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1725 off_t base_offset;
1726 unsigned long size;
1727 /* Push the object we're going to leave behind */
1728 if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
1729 poi_stack_alloc = alloc_nr(poi_stack_nr);
1730 poi_stack = xmalloc(sizeof(off_t)*poi_stack_alloc);
1731 memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
1732 } else {
1733 ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
1735 poi_stack[poi_stack_nr++] = obj_offset;
1736 /* If parsing the base offset fails, just unwind */
1737 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
1738 if (!base_offset)
1739 goto unwind;
1740 curpos = obj_offset = base_offset;
1741 type = unpack_object_header(p, w_curs, &curpos, &size);
1742 if (type <= OBJ_NONE) {
1743 /* If getting the base itself fails, we first
1744 * retry the base, otherwise unwind */
1745 type = retry_bad_packed_offset(p, base_offset);
1746 if (type > OBJ_NONE)
1747 goto out;
1748 goto unwind;
1752 switch (type) {
1753 case OBJ_BAD:
1754 case OBJ_COMMIT:
1755 case OBJ_TREE:
1756 case OBJ_BLOB:
1757 case OBJ_TAG:
1758 break;
1759 default:
1760 error("unknown object type %i at offset %"PRIuMAX" in %s",
1761 type, (uintmax_t)obj_offset, p->pack_name);
1762 type = OBJ_BAD;
1765 out:
1766 if (poi_stack != small_poi_stack)
1767 free(poi_stack);
1768 return type;
1770 unwind:
1771 while (poi_stack_nr) {
1772 obj_offset = poi_stack[--poi_stack_nr];
1773 type = retry_bad_packed_offset(p, obj_offset);
1774 if (type > OBJ_NONE)
1775 goto out;
1777 type = OBJ_BAD;
1778 goto out;
1781 static int packed_object_info(struct packed_git *p, off_t obj_offset,
1782 struct object_info *oi)
1784 struct pack_window *w_curs = NULL;
1785 unsigned long size;
1786 off_t curpos = obj_offset;
1787 enum object_type type;
1790 * We always get the representation type, but only convert it to
1791 * a "real" type later if the caller is interested.
1793 type = unpack_object_header(p, &w_curs, &curpos, &size);
1795 if (oi->sizep) {
1796 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1797 off_t tmp_pos = curpos;
1798 off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
1799 type, obj_offset);
1800 if (!base_offset) {
1801 type = OBJ_BAD;
1802 goto out;
1804 *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
1805 if (*oi->sizep == 0) {
1806 type = OBJ_BAD;
1807 goto out;
1809 } else {
1810 *oi->sizep = size;
1814 if (oi->disk_sizep) {
1815 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
1816 *oi->disk_sizep = revidx[1].offset - obj_offset;
1819 if (oi->typep) {
1820 *oi->typep = packed_to_object_type(p, obj_offset, type, &w_curs, curpos);
1821 if (*oi->typep < 0) {
1822 type = OBJ_BAD;
1823 goto out;
1827 out:
1828 unuse_pack(&w_curs);
1829 return type;
1832 static void *unpack_compressed_entry(struct packed_git *p,
1833 struct pack_window **w_curs,
1834 off_t curpos,
1835 unsigned long size)
1837 int st;
1838 git_zstream stream;
1839 unsigned char *buffer, *in;
1841 buffer = xmallocz(size);
1842 memset(&stream, 0, sizeof(stream));
1843 stream.next_out = buffer;
1844 stream.avail_out = size + 1;
1846 git_inflate_init(&stream);
1847 do {
1848 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1849 stream.next_in = in;
1850 st = git_inflate(&stream, Z_FINISH);
1851 if (!stream.avail_out)
1852 break; /* the payload is larger than it should be */
1853 curpos += stream.next_in - in;
1854 } while (st == Z_OK || st == Z_BUF_ERROR);
1855 git_inflate_end(&stream);
1856 if ((st != Z_STREAM_END) || stream.total_out != size) {
1857 free(buffer);
1858 return NULL;
1861 return buffer;
1864 #define MAX_DELTA_CACHE (256)
1866 static size_t delta_base_cached;
1868 static struct delta_base_cache_lru_list {
1869 struct delta_base_cache_lru_list *prev;
1870 struct delta_base_cache_lru_list *next;
1871 } delta_base_cache_lru = { &delta_base_cache_lru, &delta_base_cache_lru };
1873 static struct delta_base_cache_entry {
1874 struct delta_base_cache_lru_list lru;
1875 void *data;
1876 struct packed_git *p;
1877 off_t base_offset;
1878 unsigned long size;
1879 enum object_type type;
1880 } delta_base_cache[MAX_DELTA_CACHE];
1882 static unsigned long pack_entry_hash(struct packed_git *p, off_t base_offset)
1884 unsigned long hash;
1886 hash = (unsigned long)p + (unsigned long)base_offset;
1887 hash += (hash >> 8) + (hash >> 16);
1888 return hash % MAX_DELTA_CACHE;
1891 static struct delta_base_cache_entry *
1892 get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
1894 unsigned long hash = pack_entry_hash(p, base_offset);
1895 return delta_base_cache + hash;
1898 static int eq_delta_base_cache_entry(struct delta_base_cache_entry *ent,
1899 struct packed_git *p, off_t base_offset)
1901 return (ent->data && ent->p == p && ent->base_offset == base_offset);
1904 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
1906 struct delta_base_cache_entry *ent;
1907 ent = get_delta_base_cache_entry(p, base_offset);
1908 return eq_delta_base_cache_entry(ent, p, base_offset);
1911 static void clear_delta_base_cache_entry(struct delta_base_cache_entry *ent)
1913 ent->data = NULL;
1914 ent->lru.next->prev = ent->lru.prev;
1915 ent->lru.prev->next = ent->lru.next;
1916 delta_base_cached -= ent->size;
1919 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
1920 unsigned long *base_size, enum object_type *type, int keep_cache)
1922 struct delta_base_cache_entry *ent;
1923 void *ret;
1925 ent = get_delta_base_cache_entry(p, base_offset);
1927 if (!eq_delta_base_cache_entry(ent, p, base_offset))
1928 return unpack_entry(p, base_offset, type, base_size);
1930 ret = ent->data;
1932 if (!keep_cache)
1933 clear_delta_base_cache_entry(ent);
1934 else
1935 ret = xmemdupz(ent->data, ent->size);
1936 *type = ent->type;
1937 *base_size = ent->size;
1938 return ret;
1941 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
1943 if (ent->data) {
1944 free(ent->data);
1945 ent->data = NULL;
1946 ent->lru.next->prev = ent->lru.prev;
1947 ent->lru.prev->next = ent->lru.next;
1948 delta_base_cached -= ent->size;
1952 void clear_delta_base_cache(void)
1954 unsigned long p;
1955 for (p = 0; p < MAX_DELTA_CACHE; p++)
1956 release_delta_base_cache(&delta_base_cache[p]);
1959 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
1960 void *base, unsigned long base_size, enum object_type type)
1962 unsigned long hash = pack_entry_hash(p, base_offset);
1963 struct delta_base_cache_entry *ent = delta_base_cache + hash;
1964 struct delta_base_cache_lru_list *lru;
1966 release_delta_base_cache(ent);
1967 delta_base_cached += base_size;
1969 for (lru = delta_base_cache_lru.next;
1970 delta_base_cached > delta_base_cache_limit
1971 && lru != &delta_base_cache_lru;
1972 lru = lru->next) {
1973 struct delta_base_cache_entry *f = (void *)lru;
1974 if (f->type == OBJ_BLOB)
1975 release_delta_base_cache(f);
1977 for (lru = delta_base_cache_lru.next;
1978 delta_base_cached > delta_base_cache_limit
1979 && lru != &delta_base_cache_lru;
1980 lru = lru->next) {
1981 struct delta_base_cache_entry *f = (void *)lru;
1982 release_delta_base_cache(f);
1985 ent->p = p;
1986 ent->base_offset = base_offset;
1987 ent->type = type;
1988 ent->data = base;
1989 ent->size = base_size;
1990 ent->lru.next = &delta_base_cache_lru;
1991 ent->lru.prev = delta_base_cache_lru.prev;
1992 delta_base_cache_lru.prev->next = &ent->lru;
1993 delta_base_cache_lru.prev = &ent->lru;
1996 static void *read_object(const unsigned char *sha1, enum object_type *type,
1997 unsigned long *size);
1999 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
2001 static FILE *log_file;
2003 if (!log_pack_access)
2004 log_pack_access = getenv("GIT_TRACE_PACK_ACCESS");
2005 if (!log_pack_access)
2006 log_pack_access = no_log_pack_access;
2007 if (log_pack_access == no_log_pack_access)
2008 return;
2010 if (!log_file) {
2011 log_file = fopen(log_pack_access, "w");
2012 if (!log_file) {
2013 error("cannot open pack access log '%s' for writing: %s",
2014 log_pack_access, strerror(errno));
2015 log_pack_access = no_log_pack_access;
2016 return;
2019 fprintf(log_file, "%s %"PRIuMAX"\n",
2020 p->pack_name, (uintmax_t)obj_offset);
2021 fflush(log_file);
2024 int do_check_packed_object_crc;
2026 #define UNPACK_ENTRY_STACK_PREALLOC 64
2027 struct unpack_entry_stack_ent {
2028 off_t obj_offset;
2029 off_t curpos;
2030 unsigned long size;
2033 void *unpack_entry(struct packed_git *p, off_t obj_offset,
2034 enum object_type *final_type, unsigned long *final_size)
2036 struct pack_window *w_curs = NULL;
2037 off_t curpos = obj_offset;
2038 void *data = NULL;
2039 unsigned long size;
2040 enum object_type type;
2041 struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
2042 struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
2043 int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
2044 int base_from_cache = 0;
2046 if (log_pack_access != no_log_pack_access)
2047 write_pack_access_log(p, obj_offset);
2049 /* PHASE 1: drill down to the innermost base object */
2050 for (;;) {
2051 off_t base_offset;
2052 int i;
2053 struct delta_base_cache_entry *ent;
2055 ent = get_delta_base_cache_entry(p, curpos);
2056 if (eq_delta_base_cache_entry(ent, p, curpos)) {
2057 type = ent->type;
2058 data = ent->data;
2059 size = ent->size;
2060 clear_delta_base_cache_entry(ent);
2061 base_from_cache = 1;
2062 break;
2065 if (do_check_packed_object_crc && p->index_version > 1) {
2066 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
2067 unsigned long len = revidx[1].offset - obj_offset;
2068 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
2069 const unsigned char *sha1 =
2070 nth_packed_object_sha1(p, revidx->nr);
2071 error("bad packed object CRC for %s",
2072 sha1_to_hex(sha1));
2073 mark_bad_packed_object(p, sha1);
2074 unuse_pack(&w_curs);
2075 return NULL;
2079 type = unpack_object_header(p, &w_curs, &curpos, &size);
2080 if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
2081 break;
2083 base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
2084 if (!base_offset) {
2085 error("failed to validate delta base reference "
2086 "at offset %"PRIuMAX" from %s",
2087 (uintmax_t)curpos, p->pack_name);
2088 /* bail to phase 2, in hopes of recovery */
2089 data = NULL;
2090 break;
2093 /* push object, proceed to base */
2094 if (delta_stack_nr >= delta_stack_alloc
2095 && delta_stack == small_delta_stack) {
2096 delta_stack_alloc = alloc_nr(delta_stack_nr);
2097 delta_stack = xmalloc(sizeof(*delta_stack)*delta_stack_alloc);
2098 memcpy(delta_stack, small_delta_stack,
2099 sizeof(*delta_stack)*delta_stack_nr);
2100 } else {
2101 ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
2103 i = delta_stack_nr++;
2104 delta_stack[i].obj_offset = obj_offset;
2105 delta_stack[i].curpos = curpos;
2106 delta_stack[i].size = size;
2108 curpos = obj_offset = base_offset;
2111 /* PHASE 2: handle the base */
2112 switch (type) {
2113 case OBJ_OFS_DELTA:
2114 case OBJ_REF_DELTA:
2115 if (data)
2116 die("BUG in unpack_entry: left loop at a valid delta");
2117 break;
2118 case OBJ_COMMIT:
2119 case OBJ_TREE:
2120 case OBJ_BLOB:
2121 case OBJ_TAG:
2122 if (!base_from_cache)
2123 data = unpack_compressed_entry(p, &w_curs, curpos, size);
2124 break;
2125 default:
2126 data = NULL;
2127 error("unknown object type %i at offset %"PRIuMAX" in %s",
2128 type, (uintmax_t)obj_offset, p->pack_name);
2131 /* PHASE 3: apply deltas in order */
2133 /* invariants:
2134 * 'data' holds the base data, or NULL if there was corruption
2136 while (delta_stack_nr) {
2137 void *delta_data;
2138 void *base = data;
2139 unsigned long delta_size, base_size = size;
2140 int i;
2142 data = NULL;
2144 if (base)
2145 add_delta_base_cache(p, obj_offset, base, base_size, type);
2147 if (!base) {
2149 * We're probably in deep shit, but let's try to fetch
2150 * the required base anyway from another pack or loose.
2151 * This is costly but should happen only in the presence
2152 * of a corrupted pack, and is better than failing outright.
2154 struct revindex_entry *revidx;
2155 const unsigned char *base_sha1;
2156 revidx = find_pack_revindex(p, obj_offset);
2157 if (revidx) {
2158 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
2159 error("failed to read delta base object %s"
2160 " at offset %"PRIuMAX" from %s",
2161 sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
2162 p->pack_name);
2163 mark_bad_packed_object(p, base_sha1);
2164 base = read_object(base_sha1, &type, &base_size);
2168 i = --delta_stack_nr;
2169 obj_offset = delta_stack[i].obj_offset;
2170 curpos = delta_stack[i].curpos;
2171 delta_size = delta_stack[i].size;
2173 if (!base)
2174 continue;
2176 delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
2178 if (!delta_data) {
2179 error("failed to unpack compressed delta "
2180 "at offset %"PRIuMAX" from %s",
2181 (uintmax_t)curpos, p->pack_name);
2182 data = NULL;
2183 continue;
2186 data = patch_delta(base, base_size,
2187 delta_data, delta_size,
2188 &size);
2191 * We could not apply the delta; warn the user, but keep going.
2192 * Our failure will be noticed either in the next iteration of
2193 * the loop, or if this is the final delta, in the caller when
2194 * we return NULL. Those code paths will take care of making
2195 * a more explicit warning and retrying with another copy of
2196 * the object.
2198 if (!data)
2199 error("failed to apply delta");
2201 free(delta_data);
2204 *final_type = type;
2205 *final_size = size;
2207 unuse_pack(&w_curs);
2208 return data;
2211 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
2212 uint32_t n)
2214 const unsigned char *index = p->index_data;
2215 if (!index) {
2216 if (open_pack_index(p))
2217 return NULL;
2218 index = p->index_data;
2220 if (n >= p->num_objects)
2221 return NULL;
2222 index += 4 * 256;
2223 if (p->index_version == 1) {
2224 return index + 24 * n + 4;
2225 } else {
2226 index += 8;
2227 return index + 20 * n;
2231 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
2233 const unsigned char *index = p->index_data;
2234 index += 4 * 256;
2235 if (p->index_version == 1) {
2236 return ntohl(*((uint32_t *)(index + 24 * n)));
2237 } else {
2238 uint32_t off;
2239 index += 8 + p->num_objects * (20 + 4);
2240 off = ntohl(*((uint32_t *)(index + 4 * n)));
2241 if (!(off & 0x80000000))
2242 return off;
2243 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
2244 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
2245 ntohl(*((uint32_t *)(index + 4)));
2249 off_t find_pack_entry_one(const unsigned char *sha1,
2250 struct packed_git *p)
2252 const uint32_t *level1_ofs = p->index_data;
2253 const unsigned char *index = p->index_data;
2254 unsigned hi, lo, stride;
2255 static int use_lookup = -1;
2256 static int debug_lookup = -1;
2258 if (debug_lookup < 0)
2259 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
2261 if (!index) {
2262 if (open_pack_index(p))
2263 return 0;
2264 level1_ofs = p->index_data;
2265 index = p->index_data;
2267 if (p->index_version > 1) {
2268 level1_ofs += 2;
2269 index += 8;
2271 index += 4 * 256;
2272 hi = ntohl(level1_ofs[*sha1]);
2273 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
2274 if (p->index_version > 1) {
2275 stride = 20;
2276 } else {
2277 stride = 24;
2278 index += 4;
2281 if (debug_lookup)
2282 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
2283 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
2285 if (use_lookup < 0)
2286 use_lookup = !!getenv("GIT_USE_LOOKUP");
2287 if (use_lookup) {
2288 int pos = sha1_entry_pos(index, stride, 0,
2289 lo, hi, p->num_objects, sha1);
2290 if (pos < 0)
2291 return 0;
2292 return nth_packed_object_offset(p, pos);
2295 do {
2296 unsigned mi = (lo + hi) / 2;
2297 int cmp = hashcmp(index + mi * stride, sha1);
2299 if (debug_lookup)
2300 printf("lo %u hi %u rg %u mi %u\n",
2301 lo, hi, hi - lo, mi);
2302 if (!cmp)
2303 return nth_packed_object_offset(p, mi);
2304 if (cmp > 0)
2305 hi = mi;
2306 else
2307 lo = mi+1;
2308 } while (lo < hi);
2309 return 0;
2312 int is_pack_valid(struct packed_git *p)
2314 /* An already open pack is known to be valid. */
2315 if (p->pack_fd != -1)
2316 return 1;
2318 /* If the pack has one window completely covering the
2319 * file size, the pack is known to be valid even if
2320 * the descriptor is not currently open.
2322 if (p->windows) {
2323 struct pack_window *w = p->windows;
2325 if (!w->offset && w->len == p->pack_size)
2326 return 1;
2329 /* Force the pack to open to prove its valid. */
2330 return !open_packed_git(p);
2333 static int fill_pack_entry(const unsigned char *sha1,
2334 struct pack_entry *e,
2335 struct packed_git *p)
2337 off_t offset;
2339 if (p->num_bad_objects) {
2340 unsigned i;
2341 for (i = 0; i < p->num_bad_objects; i++)
2342 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2343 return 0;
2346 offset = find_pack_entry_one(sha1, p);
2347 if (!offset)
2348 return 0;
2351 * We are about to tell the caller where they can locate the
2352 * requested object. We better make sure the packfile is
2353 * still here and can be accessed before supplying that
2354 * answer, as it may have been deleted since the index was
2355 * loaded!
2357 if (!is_pack_valid(p)) {
2358 warning("packfile %s cannot be accessed", p->pack_name);
2359 return 0;
2361 e->offset = offset;
2362 e->p = p;
2363 hashcpy(e->sha1, sha1);
2364 return 1;
2367 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2369 struct packed_git *p;
2371 prepare_packed_git();
2372 if (!packed_git)
2373 return 0;
2375 if (last_found_pack && fill_pack_entry(sha1, e, last_found_pack))
2376 return 1;
2378 for (p = packed_git; p; p = p->next) {
2379 if (p == last_found_pack || !fill_pack_entry(sha1, e, p))
2380 continue;
2382 last_found_pack = p;
2383 return 1;
2385 return 0;
2388 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2389 struct packed_git *packs)
2391 struct packed_git *p;
2393 for (p = packs; p; p = p->next) {
2394 if (find_pack_entry_one(sha1, p))
2395 return p;
2397 return NULL;
2401 static int sha1_loose_object_info(const unsigned char *sha1,
2402 struct object_info *oi)
2404 int status;
2405 unsigned long mapsize, size;
2406 void *map;
2407 git_zstream stream;
2408 char hdr[32];
2411 * If we don't care about type or size, then we don't
2412 * need to look inside the object at all. Note that we
2413 * do not optimize out the stat call, even if the
2414 * caller doesn't care about the disk-size, since our
2415 * return value implicitly indicates whether the
2416 * object even exists.
2418 if (!oi->typep && !oi->sizep) {
2419 struct stat st;
2420 if (stat_sha1_file(sha1, &st) < 0)
2421 return -1;
2422 if (oi->disk_sizep)
2423 *oi->disk_sizep = st.st_size;
2424 return 0;
2427 map = map_sha1_file(sha1, &mapsize);
2428 if (!map)
2429 return -1;
2430 if (oi->disk_sizep)
2431 *oi->disk_sizep = mapsize;
2432 if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2433 status = error("unable to unpack %s header",
2434 sha1_to_hex(sha1));
2435 else if ((status = parse_sha1_header(hdr, &size)) < 0)
2436 status = error("unable to parse %s header", sha1_to_hex(sha1));
2437 else if (oi->sizep)
2438 *oi->sizep = size;
2439 git_inflate_end(&stream);
2440 munmap(map, mapsize);
2441 if (oi->typep)
2442 *oi->typep = status;
2443 return 0;
2446 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi)
2448 struct cached_object *co;
2449 struct pack_entry e;
2450 int rtype;
2452 co = find_cached_object(sha1);
2453 if (co) {
2454 if (oi->typep)
2455 *(oi->typep) = co->type;
2456 if (oi->sizep)
2457 *(oi->sizep) = co->size;
2458 if (oi->disk_sizep)
2459 *(oi->disk_sizep) = 0;
2460 oi->whence = OI_CACHED;
2461 return 0;
2464 if (!find_pack_entry(sha1, &e)) {
2465 /* Most likely it's a loose object. */
2466 if (!sha1_loose_object_info(sha1, oi)) {
2467 oi->whence = OI_LOOSE;
2468 return 0;
2471 /* Not a loose object; someone else may have just packed it. */
2472 reprepare_packed_git();
2473 if (!find_pack_entry(sha1, &e))
2474 return -1;
2477 rtype = packed_object_info(e.p, e.offset, oi);
2478 if (rtype < 0) {
2479 mark_bad_packed_object(e.p, sha1);
2480 return sha1_object_info_extended(sha1, oi);
2481 } else if (in_delta_base_cache(e.p, e.offset)) {
2482 oi->whence = OI_DBCACHED;
2483 } else {
2484 oi->whence = OI_PACKED;
2485 oi->u.packed.offset = e.offset;
2486 oi->u.packed.pack = e.p;
2487 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2488 rtype == OBJ_OFS_DELTA);
2491 return 0;
2494 /* returns enum object_type or negative */
2495 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2497 enum object_type type;
2498 struct object_info oi = {NULL};
2500 oi.typep = &type;
2501 oi.sizep = sizep;
2502 if (sha1_object_info_extended(sha1, &oi) < 0)
2503 return -1;
2504 return type;
2507 static void *read_packed_sha1(const unsigned char *sha1,
2508 enum object_type *type, unsigned long *size)
2510 struct pack_entry e;
2511 void *data;
2513 if (!find_pack_entry(sha1, &e))
2514 return NULL;
2515 data = cache_or_unpack_entry(e.p, e.offset, size, type, 1);
2516 if (!data) {
2518 * We're probably in deep shit, but let's try to fetch
2519 * the required object anyway from another pack or loose.
2520 * This should happen only in the presence of a corrupted
2521 * pack, and is better than failing outright.
2523 error("failed to read object %s at offset %"PRIuMAX" from %s",
2524 sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2525 mark_bad_packed_object(e.p, sha1);
2526 data = read_object(sha1, type, size);
2528 return data;
2531 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2532 unsigned char *sha1)
2534 struct cached_object *co;
2536 hash_sha1_file(buf, len, typename(type), sha1);
2537 if (has_sha1_file(sha1) || find_cached_object(sha1))
2538 return 0;
2539 if (cached_object_alloc <= cached_object_nr) {
2540 cached_object_alloc = alloc_nr(cached_object_alloc);
2541 cached_objects = xrealloc(cached_objects,
2542 sizeof(*cached_objects) *
2543 cached_object_alloc);
2545 co = &cached_objects[cached_object_nr++];
2546 co->size = len;
2547 co->type = type;
2548 co->buf = xmalloc(len);
2549 memcpy(co->buf, buf, len);
2550 hashcpy(co->sha1, sha1);
2551 return 0;
2554 static void *read_object(const unsigned char *sha1, enum object_type *type,
2555 unsigned long *size)
2557 unsigned long mapsize;
2558 void *map, *buf;
2559 struct cached_object *co;
2561 co = find_cached_object(sha1);
2562 if (co) {
2563 *type = co->type;
2564 *size = co->size;
2565 return xmemdupz(co->buf, co->size);
2568 buf = read_packed_sha1(sha1, type, size);
2569 if (buf)
2570 return buf;
2571 map = map_sha1_file(sha1, &mapsize);
2572 if (map) {
2573 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2574 munmap(map, mapsize);
2575 return buf;
2577 reprepare_packed_git();
2578 return read_packed_sha1(sha1, type, size);
2582 * This function dies on corrupt objects; the callers who want to
2583 * deal with them should arrange to call read_object() and give error
2584 * messages themselves.
2586 void *read_sha1_file_extended(const unsigned char *sha1,
2587 enum object_type *type,
2588 unsigned long *size,
2589 unsigned flag)
2591 void *data;
2592 char *path;
2593 const struct packed_git *p;
2594 const unsigned char *repl = (flag & READ_SHA1_FILE_REPLACE)
2595 ? lookup_replace_object(sha1) : sha1;
2597 errno = 0;
2598 data = read_object(repl, type, size);
2599 if (data)
2600 return data;
2602 if (errno && errno != ENOENT)
2603 die_errno("failed to read object %s", sha1_to_hex(sha1));
2605 /* die if we replaced an object with one that does not exist */
2606 if (repl != sha1)
2607 die("replacement %s not found for %s",
2608 sha1_to_hex(repl), sha1_to_hex(sha1));
2610 if (has_loose_object(repl)) {
2611 path = sha1_file_name(sha1);
2612 die("loose object %s (stored in %s) is corrupt",
2613 sha1_to_hex(repl), path);
2616 if ((p = has_packed_and_bad(repl)) != NULL)
2617 die("packed object %s (stored in %s) is corrupt",
2618 sha1_to_hex(repl), p->pack_name);
2620 return NULL;
2623 void *read_object_with_reference(const unsigned char *sha1,
2624 const char *required_type_name,
2625 unsigned long *size,
2626 unsigned char *actual_sha1_return)
2628 enum object_type type, required_type;
2629 void *buffer;
2630 unsigned long isize;
2631 unsigned char actual_sha1[20];
2633 required_type = type_from_string(required_type_name);
2634 hashcpy(actual_sha1, sha1);
2635 while (1) {
2636 int ref_length = -1;
2637 const char *ref_type = NULL;
2639 buffer = read_sha1_file(actual_sha1, &type, &isize);
2640 if (!buffer)
2641 return NULL;
2642 if (type == required_type) {
2643 *size = isize;
2644 if (actual_sha1_return)
2645 hashcpy(actual_sha1_return, actual_sha1);
2646 return buffer;
2648 /* Handle references */
2649 else if (type == OBJ_COMMIT)
2650 ref_type = "tree ";
2651 else if (type == OBJ_TAG)
2652 ref_type = "object ";
2653 else {
2654 free(buffer);
2655 return NULL;
2657 ref_length = strlen(ref_type);
2659 if (ref_length + 40 > isize ||
2660 memcmp(buffer, ref_type, ref_length) ||
2661 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
2662 free(buffer);
2663 return NULL;
2665 free(buffer);
2666 /* Now we have the ID of the referred-to object in
2667 * actual_sha1. Check again. */
2671 static void write_sha1_file_prepare(const void *buf, unsigned long len,
2672 const char *type, unsigned char *sha1,
2673 char *hdr, int *hdrlen)
2675 git_SHA_CTX c;
2677 /* Generate the header */
2678 *hdrlen = sprintf(hdr, "%s %lu", type, len)+1;
2680 /* Sha1.. */
2681 git_SHA1_Init(&c);
2682 git_SHA1_Update(&c, hdr, *hdrlen);
2683 git_SHA1_Update(&c, buf, len);
2684 git_SHA1_Final(sha1, &c);
2688 * Move the just written object into its final resting place.
2689 * NEEDSWORK: this should be renamed to finalize_temp_file() as
2690 * "moving" is only a part of what it does, when no patch between
2691 * master to pu changes the call sites of this function.
2693 int move_temp_to_file(const char *tmpfile, const char *filename)
2695 int ret = 0;
2697 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
2698 goto try_rename;
2699 else if (link(tmpfile, filename))
2700 ret = errno;
2703 * Coda hack - coda doesn't like cross-directory links,
2704 * so we fall back to a rename, which will mean that it
2705 * won't be able to check collisions, but that's not a
2706 * big deal.
2708 * The same holds for FAT formatted media.
2710 * When this succeeds, we just return. We have nothing
2711 * left to unlink.
2713 if (ret && ret != EEXIST) {
2714 try_rename:
2715 if (!rename(tmpfile, filename))
2716 goto out;
2717 ret = errno;
2719 unlink_or_warn(tmpfile);
2720 if (ret) {
2721 if (ret != EEXIST) {
2722 return error("unable to write sha1 filename %s: %s", filename, strerror(ret));
2724 /* FIXME!!! Collision check here ? */
2727 out:
2728 if (adjust_shared_perm(filename))
2729 return error("unable to set permission to '%s'", filename);
2730 return 0;
2733 static int write_buffer(int fd, const void *buf, size_t len)
2735 if (write_in_full(fd, buf, len) < 0)
2736 return error("file write error (%s)", strerror(errno));
2737 return 0;
2740 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
2741 unsigned char *sha1)
2743 char hdr[32];
2744 int hdrlen;
2745 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2746 return 0;
2749 /* Finalize a file on disk, and close it. */
2750 static void close_sha1_file(int fd)
2752 if (fsync_object_files)
2753 fsync_or_die(fd, "sha1 file");
2754 if (close(fd) != 0)
2755 die_errno("error when closing sha1 file");
2758 /* Size of directory component, including the ending '/' */
2759 static inline int directory_size(const char *filename)
2761 const char *s = strrchr(filename, '/');
2762 if (!s)
2763 return 0;
2764 return s - filename + 1;
2768 * This creates a temporary file in the same directory as the final
2769 * 'filename'
2771 * We want to avoid cross-directory filename renames, because those
2772 * can have problems on various filesystems (FAT, NFS, Coda).
2774 static int create_tmpfile(char *buffer, size_t bufsiz, const char *filename)
2776 int fd, dirlen = directory_size(filename);
2778 if (dirlen + 20 > bufsiz) {
2779 errno = ENAMETOOLONG;
2780 return -1;
2782 memcpy(buffer, filename, dirlen);
2783 strcpy(buffer + dirlen, "tmp_obj_XXXXXX");
2784 fd = git_mkstemp_mode(buffer, 0444);
2785 if (fd < 0 && dirlen && errno == ENOENT) {
2786 /* Make sure the directory exists */
2787 memcpy(buffer, filename, dirlen);
2788 buffer[dirlen-1] = 0;
2789 if (mkdir(buffer, 0777) && errno != EEXIST)
2790 return -1;
2791 if (adjust_shared_perm(buffer))
2792 return -1;
2794 /* Try again */
2795 strcpy(buffer + dirlen - 1, "/tmp_obj_XXXXXX");
2796 fd = git_mkstemp_mode(buffer, 0444);
2798 return fd;
2801 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
2802 const void *buf, unsigned long len, time_t mtime)
2804 int fd, ret;
2805 unsigned char compressed[4096];
2806 git_zstream stream;
2807 git_SHA_CTX c;
2808 unsigned char parano_sha1[20];
2809 char *filename;
2810 static char tmp_file[PATH_MAX];
2812 filename = sha1_file_name(sha1);
2813 fd = create_tmpfile(tmp_file, sizeof(tmp_file), filename);
2814 if (fd < 0) {
2815 if (errno == EACCES)
2816 return error("insufficient permission for adding an object to repository database %s", get_object_directory());
2817 else
2818 return error("unable to create temporary file: %s", strerror(errno));
2821 /* Set it up */
2822 memset(&stream, 0, sizeof(stream));
2823 git_deflate_init(&stream, zlib_compression_level);
2824 stream.next_out = compressed;
2825 stream.avail_out = sizeof(compressed);
2826 git_SHA1_Init(&c);
2828 /* First header.. */
2829 stream.next_in = (unsigned char *)hdr;
2830 stream.avail_in = hdrlen;
2831 while (git_deflate(&stream, 0) == Z_OK)
2832 ; /* nothing */
2833 git_SHA1_Update(&c, hdr, hdrlen);
2835 /* Then the data itself.. */
2836 stream.next_in = (void *)buf;
2837 stream.avail_in = len;
2838 do {
2839 unsigned char *in0 = stream.next_in;
2840 ret = git_deflate(&stream, Z_FINISH);
2841 git_SHA1_Update(&c, in0, stream.next_in - in0);
2842 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
2843 die("unable to write sha1 file");
2844 stream.next_out = compressed;
2845 stream.avail_out = sizeof(compressed);
2846 } while (ret == Z_OK);
2848 if (ret != Z_STREAM_END)
2849 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
2850 ret = git_deflate_end_gently(&stream);
2851 if (ret != Z_OK)
2852 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
2853 git_SHA1_Final(parano_sha1, &c);
2854 if (hashcmp(sha1, parano_sha1) != 0)
2855 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
2857 close_sha1_file(fd);
2859 if (mtime) {
2860 struct utimbuf utb;
2861 utb.actime = mtime;
2862 utb.modtime = mtime;
2863 if (utime(tmp_file, &utb) < 0)
2864 warning("failed utime() on %s: %s",
2865 tmp_file, strerror(errno));
2868 return move_temp_to_file(tmp_file, filename);
2871 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *returnsha1)
2873 unsigned char sha1[20];
2874 char hdr[32];
2875 int hdrlen;
2877 /* Normally if we have it in the pack then we do not bother writing
2878 * it out into .git/objects/??/?{38} file.
2880 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2881 if (returnsha1)
2882 hashcpy(returnsha1, sha1);
2883 if (has_sha1_file(sha1))
2884 return 0;
2885 return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
2888 int force_object_loose(const unsigned char *sha1, time_t mtime)
2890 void *buf;
2891 unsigned long len;
2892 enum object_type type;
2893 char hdr[32];
2894 int hdrlen;
2895 int ret;
2897 if (has_loose_object(sha1))
2898 return 0;
2899 buf = read_packed_sha1(sha1, &type, &len);
2900 if (!buf)
2901 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
2902 hdrlen = sprintf(hdr, "%s %lu", typename(type), len) + 1;
2903 ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
2904 free(buf);
2906 return ret;
2909 int has_pack_index(const unsigned char *sha1)
2911 struct stat st;
2912 if (stat(sha1_pack_index_name(sha1), &st))
2913 return 0;
2914 return 1;
2917 int has_sha1_pack(const unsigned char *sha1)
2919 struct pack_entry e;
2920 return find_pack_entry(sha1, &e);
2923 int has_sha1_file(const unsigned char *sha1)
2925 struct pack_entry e;
2927 if (find_pack_entry(sha1, &e))
2928 return 1;
2929 if (has_loose_object(sha1))
2930 return 1;
2931 reprepare_packed_git();
2932 return find_pack_entry(sha1, &e);
2935 static void check_tree(const void *buf, size_t size)
2937 struct tree_desc desc;
2938 struct name_entry entry;
2940 init_tree_desc(&desc, buf, size);
2941 while (tree_entry(&desc, &entry))
2942 /* do nothing
2943 * tree_entry() will die() on malformed entries */
2947 static void check_commit(const void *buf, size_t size)
2949 struct commit c;
2950 memset(&c, 0, sizeof(c));
2951 if (parse_commit_buffer(&c, buf, size))
2952 die("corrupt commit");
2955 static void check_tag(const void *buf, size_t size)
2957 struct tag t;
2958 memset(&t, 0, sizeof(t));
2959 if (parse_tag_buffer(&t, buf, size))
2960 die("corrupt tag");
2963 static int index_mem(unsigned char *sha1, void *buf, size_t size,
2964 enum object_type type,
2965 const char *path, unsigned flags)
2967 int ret, re_allocated = 0;
2968 int write_object = flags & HASH_WRITE_OBJECT;
2970 if (!type)
2971 type = OBJ_BLOB;
2974 * Convert blobs to git internal format
2976 if ((type == OBJ_BLOB) && path) {
2977 struct strbuf nbuf = STRBUF_INIT;
2978 if (convert_to_git(path, buf, size, &nbuf,
2979 write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
2980 buf = strbuf_detach(&nbuf, &size);
2981 re_allocated = 1;
2984 if (flags & HASH_FORMAT_CHECK) {
2985 if (type == OBJ_TREE)
2986 check_tree(buf, size);
2987 if (type == OBJ_COMMIT)
2988 check_commit(buf, size);
2989 if (type == OBJ_TAG)
2990 check_tag(buf, size);
2993 if (write_object)
2994 ret = write_sha1_file(buf, size, typename(type), sha1);
2995 else
2996 ret = hash_sha1_file(buf, size, typename(type), sha1);
2997 if (re_allocated)
2998 free(buf);
2999 return ret;
3002 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
3003 const char *path, unsigned flags)
3005 struct strbuf sbuf = STRBUF_INIT;
3006 int ret;
3008 if (strbuf_read(&sbuf, fd, 4096) >= 0)
3009 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
3010 else
3011 ret = -1;
3012 strbuf_release(&sbuf);
3013 return ret;
3016 #define SMALL_FILE_SIZE (32*1024)
3018 static int index_core(unsigned char *sha1, int fd, size_t size,
3019 enum object_type type, const char *path,
3020 unsigned flags)
3022 int ret;
3024 if (!size) {
3025 ret = index_mem(sha1, NULL, size, type, path, flags);
3026 } else if (size <= SMALL_FILE_SIZE) {
3027 char *buf = xmalloc(size);
3028 if (size == read_in_full(fd, buf, size))
3029 ret = index_mem(sha1, buf, size, type, path, flags);
3030 else
3031 ret = error("short read %s", strerror(errno));
3032 free(buf);
3033 } else {
3034 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
3035 ret = index_mem(sha1, buf, size, type, path, flags);
3036 munmap(buf, size);
3038 return ret;
3042 * This creates one packfile per large blob unless bulk-checkin
3043 * machinery is "plugged".
3045 * This also bypasses the usual "convert-to-git" dance, and that is on
3046 * purpose. We could write a streaming version of the converting
3047 * functions and insert that before feeding the data to fast-import
3048 * (or equivalent in-core API described above). However, that is
3049 * somewhat complicated, as we do not know the size of the filter
3050 * result, which we need to know beforehand when writing a git object.
3051 * Since the primary motivation for trying to stream from the working
3052 * tree file and to avoid mmaping it in core is to deal with large
3053 * binary blobs, they generally do not want to get any conversion, and
3054 * callers should avoid this code path when filters are requested.
3056 static int index_stream(unsigned char *sha1, int fd, size_t size,
3057 enum object_type type, const char *path,
3058 unsigned flags)
3060 return index_bulk_checkin(sha1, fd, size, type, path, flags);
3063 int index_fd(unsigned char *sha1, int fd, struct stat *st,
3064 enum object_type type, const char *path, unsigned flags)
3066 int ret;
3067 size_t size = xsize_t(st->st_size);
3069 if (!S_ISREG(st->st_mode))
3070 ret = index_pipe(sha1, fd, type, path, flags);
3071 else if (size <= big_file_threshold || type != OBJ_BLOB ||
3072 (path && would_convert_to_git(path, NULL, 0, 0)))
3073 ret = index_core(sha1, fd, size, type, path, flags);
3074 else
3075 ret = index_stream(sha1, fd, size, type, path, flags);
3076 close(fd);
3077 return ret;
3080 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
3082 int fd;
3083 struct strbuf sb = STRBUF_INIT;
3085 switch (st->st_mode & S_IFMT) {
3086 case S_IFREG:
3087 fd = open(path, O_RDONLY);
3088 if (fd < 0)
3089 return error("open(\"%s\"): %s", path,
3090 strerror(errno));
3091 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
3092 return error("%s: failed to insert into database",
3093 path);
3094 break;
3095 case S_IFLNK:
3096 if (strbuf_readlink(&sb, path, st->st_size)) {
3097 char *errstr = strerror(errno);
3098 return error("readlink(\"%s\"): %s", path,
3099 errstr);
3101 if (!(flags & HASH_WRITE_OBJECT))
3102 hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
3103 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
3104 return error("%s: failed to insert into database",
3105 path);
3106 strbuf_release(&sb);
3107 break;
3108 case S_IFDIR:
3109 return resolve_gitlink_ref(path, "HEAD", sha1);
3110 default:
3111 return error("%s: unsupported file type", path);
3113 return 0;
3116 int read_pack_header(int fd, struct pack_header *header)
3118 if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
3119 /* "eof before pack header was fully read" */
3120 return PH_ERROR_EOF;
3122 if (header->hdr_signature != htonl(PACK_SIGNATURE))
3123 /* "protocol error (pack signature mismatch detected)" */
3124 return PH_ERROR_PACK_SIGNATURE;
3125 if (!pack_version_ok(header->hdr_version))
3126 /* "protocol error (pack version unsupported)" */
3127 return PH_ERROR_PROTOCOL;
3128 return 0;
3131 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
3133 enum object_type type = sha1_object_info(sha1, NULL);
3134 if (type < 0)
3135 die("%s is not a valid object", sha1_to_hex(sha1));
3136 if (type != expect)
3137 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
3138 typename(expect));