Code

find_pack_entry(): do not keep packed_git pointer locally
[git.git] / sha1_file.c
1 /*
2  * GIT - The information manager from hell
3  *
4  * Copyright (C) Linus Torvalds, 2005
5  *
6  * This handles basic git sha1 object files - packing, unpacking,
7  * creation etc.
8  */
9 #include "cache.h"
10 #include "delta.h"
11 #include "pack.h"
12 #include "blob.h"
13 #include "commit.h"
14 #include "run-command.h"
15 #include "tag.h"
16 #include "tree.h"
17 #include "tree-walk.h"
18 #include "refs.h"
19 #include "pack-revindex.h"
20 #include "sha1-lookup.h"
21 #include "bulk-checkin.h"
23 #ifndef O_NOATIME
24 #if defined(__linux__) && (defined(__i386__) || defined(__PPC__))
25 #define O_NOATIME 01000000
26 #else
27 #define O_NOATIME 0
28 #endif
29 #endif
31 #define SZ_FMT PRIuMAX
32 static inline uintmax_t sz_fmt(size_t s) { return s; }
34 const unsigned char null_sha1[20];
36 /*
37  * This is meant to hold a *small* number of objects that you would
38  * want read_sha1_file() to be able to return, but yet you do not want
39  * to write them into the object store (e.g. a browse-only
40  * application).
41  */
42 static struct cached_object {
43         unsigned char sha1[20];
44         enum object_type type;
45         void *buf;
46         unsigned long size;
47 } *cached_objects;
48 static int cached_object_nr, cached_object_alloc;
50 static struct cached_object empty_tree = {
51         EMPTY_TREE_SHA1_BIN_LITERAL,
52         OBJ_TREE,
53         "",
54         0
55 };
57 static struct packed_git *last_found_pack;
59 static struct cached_object *find_cached_object(const unsigned char *sha1)
60 {
61         int i;
62         struct cached_object *co = cached_objects;
64         for (i = 0; i < cached_object_nr; i++, co++) {
65                 if (!hashcmp(co->sha1, sha1))
66                         return co;
67         }
68         if (!hashcmp(sha1, empty_tree.sha1))
69                 return &empty_tree;
70         return NULL;
71 }
73 int mkdir_in_gitdir(const char *path)
74 {
75         if (mkdir(path, 0777)) {
76                 int saved_errno = errno;
77                 struct stat st;
78                 struct strbuf sb = STRBUF_INIT;
80                 if (errno != EEXIST)
81                         return -1;
82                 /*
83                  * Are we looking at a path in a symlinked worktree
84                  * whose original repository does not yet have it?
85                  * e.g. .git/rr-cache pointing at its original
86                  * repository in which the user hasn't performed any
87                  * conflict resolution yet?
88                  */
89                 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
90                     strbuf_readlink(&sb, path, st.st_size) ||
91                     !is_absolute_path(sb.buf) ||
92                     mkdir(sb.buf, 0777)) {
93                         strbuf_release(&sb);
94                         errno = saved_errno;
95                         return -1;
96                 }
97                 strbuf_release(&sb);
98         }
99         return adjust_shared_perm(path);
102 int safe_create_leading_directories(char *path)
104         char *pos = path + offset_1st_component(path);
105         struct stat st;
107         while (pos) {
108                 pos = strchr(pos, '/');
109                 if (!pos)
110                         break;
111                 while (*++pos == '/')
112                         ;
113                 if (!*pos)
114                         break;
115                 *--pos = '\0';
116                 if (!stat(path, &st)) {
117                         /* path exists */
118                         if (!S_ISDIR(st.st_mode)) {
119                                 *pos = '/';
120                                 return -3;
121                         }
122                 }
123                 else if (mkdir(path, 0777)) {
124                         *pos = '/';
125                         return -1;
126                 }
127                 else if (adjust_shared_perm(path)) {
128                         *pos = '/';
129                         return -2;
130                 }
131                 *pos++ = '/';
132         }
133         return 0;
136 int safe_create_leading_directories_const(const char *path)
138         /* path points to cache entries, so xstrdup before messing with it */
139         char *buf = xstrdup(path);
140         int result = safe_create_leading_directories(buf);
141         free(buf);
142         return result;
145 static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
147         int i;
148         for (i = 0; i < 20; i++) {
149                 static char hex[] = "0123456789abcdef";
150                 unsigned int val = sha1[i];
151                 char *pos = pathbuf + i*2 + (i > 0);
152                 *pos++ = hex[val >> 4];
153                 *pos = hex[val & 0xf];
154         }
157 /*
158  * NOTE! This returns a statically allocated buffer, so you have to be
159  * careful about using it. Do an "xstrdup()" if you need to save the
160  * filename.
161  *
162  * Also note that this returns the location for creating.  Reading
163  * SHA1 file can happen from any alternate directory listed in the
164  * DB_ENVIRONMENT environment variable if it is not found in
165  * the primary object database.
166  */
167 char *sha1_file_name(const unsigned char *sha1)
169         static char buf[PATH_MAX];
170         const char *objdir;
171         int len;
173         objdir = get_object_directory();
174         len = strlen(objdir);
176         /* '/' + sha1(2) + '/' + sha1(38) + '\0' */
177         if (len + 43 > PATH_MAX)
178                 die("insanely long object directory %s", objdir);
179         memcpy(buf, objdir, len);
180         buf[len] = '/';
181         buf[len+3] = '/';
182         buf[len+42] = '\0';
183         fill_sha1_path(buf + len + 1, sha1);
184         return buf;
187 static char *sha1_get_pack_name(const unsigned char *sha1,
188                                 char **name, char **base, const char *which)
190         static const char hex[] = "0123456789abcdef";
191         char *buf;
192         int i;
194         if (!*base) {
195                 const char *sha1_file_directory = get_object_directory();
196                 int len = strlen(sha1_file_directory);
197                 *base = xmalloc(len + 60);
198                 sprintf(*base, "%s/pack/pack-1234567890123456789012345678901234567890.%s",
199                         sha1_file_directory, which);
200                 *name = *base + len + 11;
201         }
203         buf = *name;
205         for (i = 0; i < 20; i++) {
206                 unsigned int val = *sha1++;
207                 *buf++ = hex[val >> 4];
208                 *buf++ = hex[val & 0xf];
209         }
211         return *base;
214 char *sha1_pack_name(const unsigned char *sha1)
216         static char *name, *base;
218         return sha1_get_pack_name(sha1, &name, &base, "pack");
221 char *sha1_pack_index_name(const unsigned char *sha1)
223         static char *name, *base;
225         return sha1_get_pack_name(sha1, &name, &base, "idx");
228 struct alternate_object_database *alt_odb_list;
229 static struct alternate_object_database **alt_odb_tail;
231 static void read_info_alternates(const char * alternates, int depth);
232 static int git_open_noatime(const char *name);
234 /*
235  * Prepare alternate object database registry.
236  *
237  * The variable alt_odb_list points at the list of struct
238  * alternate_object_database.  The elements on this list come from
239  * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
240  * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
241  * whose contents is similar to that environment variable but can be
242  * LF separated.  Its base points at a statically allocated buffer that
243  * contains "/the/directory/corresponding/to/.git/objects/...", while
244  * its name points just after the slash at the end of ".git/objects/"
245  * in the example above, and has enough space to hold 40-byte hex
246  * SHA1, an extra slash for the first level indirection, and the
247  * terminating NUL.
248  */
249 static int link_alt_odb_entry(const char * entry, int len, const char * relative_base, int depth)
251         const char *objdir = get_object_directory();
252         struct alternate_object_database *ent;
253         struct alternate_object_database *alt;
254         int pfxlen, entlen;
255         struct strbuf pathbuf = STRBUF_INIT;
257         if (!is_absolute_path(entry) && relative_base) {
258                 strbuf_addstr(&pathbuf, real_path(relative_base));
259                 strbuf_addch(&pathbuf, '/');
260         }
261         strbuf_add(&pathbuf, entry, len);
263         normalize_path_copy(pathbuf.buf, pathbuf.buf);
265         pfxlen = strlen(pathbuf.buf);
267         /*
268          * The trailing slash after the directory name is given by
269          * this function at the end. Remove duplicates.
270          */
271         while (pfxlen && pathbuf.buf[pfxlen-1] == '/')
272                 pfxlen -= 1;
274         entlen = pfxlen + 43; /* '/' + 2 hex + '/' + 38 hex + NUL */
275         ent = xmalloc(sizeof(*ent) + entlen);
276         memcpy(ent->base, pathbuf.buf, pfxlen);
277         strbuf_release(&pathbuf);
279         ent->name = ent->base + pfxlen + 1;
280         ent->base[pfxlen + 3] = '/';
281         ent->base[pfxlen] = ent->base[entlen-1] = 0;
283         /* Detect cases where alternate disappeared */
284         if (!is_directory(ent->base)) {
285                 error("object directory %s does not exist; "
286                       "check .git/objects/info/alternates.",
287                       ent->base);
288                 free(ent);
289                 return -1;
290         }
292         /* Prevent the common mistake of listing the same
293          * thing twice, or object directory itself.
294          */
295         for (alt = alt_odb_list; alt; alt = alt->next) {
296                 if (!memcmp(ent->base, alt->base, pfxlen)) {
297                         free(ent);
298                         return -1;
299                 }
300         }
301         if (!memcmp(ent->base, objdir, pfxlen)) {
302                 free(ent);
303                 return -1;
304         }
306         /* add the alternate entry */
307         *alt_odb_tail = ent;
308         alt_odb_tail = &(ent->next);
309         ent->next = NULL;
311         /* recursively add alternates */
312         read_info_alternates(ent->base, depth + 1);
314         ent->base[pfxlen] = '/';
316         return 0;
319 static void link_alt_odb_entries(const char *alt, const char *ep, int sep,
320                                  const char *relative_base, int depth)
322         const char *cp, *last;
324         if (depth > 5) {
325                 error("%s: ignoring alternate object stores, nesting too deep.",
326                                 relative_base);
327                 return;
328         }
330         last = alt;
331         while (last < ep) {
332                 cp = last;
333                 if (cp < ep && *cp == '#') {
334                         while (cp < ep && *cp != sep)
335                                 cp++;
336                         last = cp + 1;
337                         continue;
338                 }
339                 while (cp < ep && *cp != sep)
340                         cp++;
341                 if (last != cp) {
342                         if (!is_absolute_path(last) && depth) {
343                                 error("%s: ignoring relative alternate object store %s",
344                                                 relative_base, last);
345                         } else {
346                                 link_alt_odb_entry(last, cp - last,
347                                                 relative_base, depth);
348                         }
349                 }
350                 while (cp < ep && *cp == sep)
351                         cp++;
352                 last = cp;
353         }
356 static void read_info_alternates(const char * relative_base, int depth)
358         char *map;
359         size_t mapsz;
360         struct stat st;
361         const char alt_file_name[] = "info/alternates";
362         /* Given that relative_base is no longer than PATH_MAX,
363            ensure that "path" has enough space to append "/", the
364            file name, "info/alternates", and a trailing NUL.  */
365         char path[PATH_MAX + 1 + sizeof alt_file_name];
366         int fd;
368         sprintf(path, "%s/%s", relative_base, alt_file_name);
369         fd = git_open_noatime(path);
370         if (fd < 0)
371                 return;
372         if (fstat(fd, &st) || (st.st_size == 0)) {
373                 close(fd);
374                 return;
375         }
376         mapsz = xsize_t(st.st_size);
377         map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
378         close(fd);
380         link_alt_odb_entries(map, map + mapsz, '\n', relative_base, depth);
382         munmap(map, mapsz);
385 void add_to_alternates_file(const char *reference)
387         struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
388         int fd = hold_lock_file_for_append(lock, git_path("objects/info/alternates"), LOCK_DIE_ON_ERROR);
389         char *alt = mkpath("%s\n", reference);
390         write_or_die(fd, alt, strlen(alt));
391         if (commit_lock_file(lock))
392                 die("could not close alternates file");
393         if (alt_odb_tail)
394                 link_alt_odb_entries(alt, alt + strlen(alt), '\n', NULL, 0);
397 void foreach_alt_odb(alt_odb_fn fn, void *cb)
399         struct alternate_object_database *ent;
401         prepare_alt_odb();
402         for (ent = alt_odb_list; ent; ent = ent->next)
403                 if (fn(ent, cb))
404                         return;
407 void prepare_alt_odb(void)
409         const char *alt;
411         if (alt_odb_tail)
412                 return;
414         alt = getenv(ALTERNATE_DB_ENVIRONMENT);
415         if (!alt) alt = "";
417         alt_odb_tail = &alt_odb_list;
418         link_alt_odb_entries(alt, alt + strlen(alt), PATH_SEP, NULL, 0);
420         read_info_alternates(get_object_directory(), 0);
423 static int has_loose_object_local(const unsigned char *sha1)
425         char *name = sha1_file_name(sha1);
426         return !access(name, F_OK);
429 int has_loose_object_nonlocal(const unsigned char *sha1)
431         struct alternate_object_database *alt;
432         prepare_alt_odb();
433         for (alt = alt_odb_list; alt; alt = alt->next) {
434                 fill_sha1_path(alt->name, sha1);
435                 if (!access(alt->base, F_OK))
436                         return 1;
437         }
438         return 0;
441 static int has_loose_object(const unsigned char *sha1)
443         return has_loose_object_local(sha1) ||
444                has_loose_object_nonlocal(sha1);
447 static unsigned int pack_used_ctr;
448 static unsigned int pack_mmap_calls;
449 static unsigned int peak_pack_open_windows;
450 static unsigned int pack_open_windows;
451 static unsigned int pack_open_fds;
452 static unsigned int pack_max_fds;
453 static size_t peak_pack_mapped;
454 static size_t pack_mapped;
455 struct packed_git *packed_git;
457 void pack_report(void)
459         fprintf(stderr,
460                 "pack_report: getpagesize()            = %10" SZ_FMT "\n"
461                 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
462                 "pack_report: core.packedGitLimit      = %10" SZ_FMT "\n",
463                 sz_fmt(getpagesize()),
464                 sz_fmt(packed_git_window_size),
465                 sz_fmt(packed_git_limit));
466         fprintf(stderr,
467                 "pack_report: pack_used_ctr            = %10u\n"
468                 "pack_report: pack_mmap_calls          = %10u\n"
469                 "pack_report: pack_open_windows        = %10u / %10u\n"
470                 "pack_report: pack_mapped              = "
471                         "%10" SZ_FMT " / %10" SZ_FMT "\n",
472                 pack_used_ctr,
473                 pack_mmap_calls,
474                 pack_open_windows, peak_pack_open_windows,
475                 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
478 static int check_packed_git_idx(const char *path,  struct packed_git *p)
480         void *idx_map;
481         struct pack_idx_header *hdr;
482         size_t idx_size;
483         uint32_t version, nr, i, *index;
484         int fd = git_open_noatime(path);
485         struct stat st;
487         if (fd < 0)
488                 return -1;
489         if (fstat(fd, &st)) {
490                 close(fd);
491                 return -1;
492         }
493         idx_size = xsize_t(st.st_size);
494         if (idx_size < 4 * 256 + 20 + 20) {
495                 close(fd);
496                 return error("index file %s is too small", path);
497         }
498         idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
499         close(fd);
501         hdr = idx_map;
502         if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
503                 version = ntohl(hdr->idx_version);
504                 if (version < 2 || version > 2) {
505                         munmap(idx_map, idx_size);
506                         return error("index file %s is version %"PRIu32
507                                      " and is not supported by this binary"
508                                      " (try upgrading GIT to a newer version)",
509                                      path, version);
510                 }
511         } else
512                 version = 1;
514         nr = 0;
515         index = idx_map;
516         if (version > 1)
517                 index += 2;  /* skip index header */
518         for (i = 0; i < 256; i++) {
519                 uint32_t n = ntohl(index[i]);
520                 if (n < nr) {
521                         munmap(idx_map, idx_size);
522                         return error("non-monotonic index %s", path);
523                 }
524                 nr = n;
525         }
527         if (version == 1) {
528                 /*
529                  * Total size:
530                  *  - 256 index entries 4 bytes each
531                  *  - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
532                  *  - 20-byte SHA1 of the packfile
533                  *  - 20-byte SHA1 file checksum
534                  */
535                 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
536                         munmap(idx_map, idx_size);
537                         return error("wrong index v1 file size in %s", path);
538                 }
539         } else if (version == 2) {
540                 /*
541                  * Minimum size:
542                  *  - 8 bytes of header
543                  *  - 256 index entries 4 bytes each
544                  *  - 20-byte sha1 entry * nr
545                  *  - 4-byte crc entry * nr
546                  *  - 4-byte offset entry * nr
547                  *  - 20-byte SHA1 of the packfile
548                  *  - 20-byte SHA1 file checksum
549                  * And after the 4-byte offset table might be a
550                  * variable sized table containing 8-byte entries
551                  * for offsets larger than 2^31.
552                  */
553                 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
554                 unsigned long max_size = min_size;
555                 if (nr)
556                         max_size += (nr - 1)*8;
557                 if (idx_size < min_size || idx_size > max_size) {
558                         munmap(idx_map, idx_size);
559                         return error("wrong index v2 file size in %s", path);
560                 }
561                 if (idx_size != min_size &&
562                     /*
563                      * make sure we can deal with large pack offsets.
564                      * 31-bit signed offset won't be enough, neither
565                      * 32-bit unsigned one will be.
566                      */
567                     (sizeof(off_t) <= 4)) {
568                         munmap(idx_map, idx_size);
569                         return error("pack too large for current definition of off_t in %s", path);
570                 }
571         }
573         p->index_version = version;
574         p->index_data = idx_map;
575         p->index_size = idx_size;
576         p->num_objects = nr;
577         return 0;
580 int open_pack_index(struct packed_git *p)
582         char *idx_name;
583         int ret;
585         if (p->index_data)
586                 return 0;
588         idx_name = xstrdup(p->pack_name);
589         strcpy(idx_name + strlen(idx_name) - strlen(".pack"), ".idx");
590         ret = check_packed_git_idx(idx_name, p);
591         free(idx_name);
592         return ret;
595 static void scan_windows(struct packed_git *p,
596         struct packed_git **lru_p,
597         struct pack_window **lru_w,
598         struct pack_window **lru_l)
600         struct pack_window *w, *w_l;
602         for (w_l = NULL, w = p->windows; w; w = w->next) {
603                 if (!w->inuse_cnt) {
604                         if (!*lru_w || w->last_used < (*lru_w)->last_used) {
605                                 *lru_p = p;
606                                 *lru_w = w;
607                                 *lru_l = w_l;
608                         }
609                 }
610                 w_l = w;
611         }
614 static int unuse_one_window(struct packed_git *current, int keep_fd)
616         struct packed_git *p, *lru_p = NULL;
617         struct pack_window *lru_w = NULL, *lru_l = NULL;
619         if (current)
620                 scan_windows(current, &lru_p, &lru_w, &lru_l);
621         for (p = packed_git; p; p = p->next)
622                 scan_windows(p, &lru_p, &lru_w, &lru_l);
623         if (lru_p) {
624                 munmap(lru_w->base, lru_w->len);
625                 pack_mapped -= lru_w->len;
626                 if (lru_l)
627                         lru_l->next = lru_w->next;
628                 else {
629                         lru_p->windows = lru_w->next;
630                         if (!lru_p->windows && lru_p->pack_fd != -1
631                                 && lru_p->pack_fd != keep_fd) {
632                                 close(lru_p->pack_fd);
633                                 pack_open_fds--;
634                                 lru_p->pack_fd = -1;
635                         }
636                 }
637                 free(lru_w);
638                 pack_open_windows--;
639                 return 1;
640         }
641         return 0;
644 void release_pack_memory(size_t need, int fd)
646         size_t cur = pack_mapped;
647         while (need >= (cur - pack_mapped) && unuse_one_window(NULL, fd))
648                 ; /* nothing */
651 void *xmmap(void *start, size_t length,
652         int prot, int flags, int fd, off_t offset)
654         void *ret = mmap(start, length, prot, flags, fd, offset);
655         if (ret == MAP_FAILED) {
656                 if (!length)
657                         return NULL;
658                 release_pack_memory(length, fd);
659                 ret = mmap(start, length, prot, flags, fd, offset);
660                 if (ret == MAP_FAILED)
661                         die_errno("Out of memory? mmap failed");
662         }
663         return ret;
666 void close_pack_windows(struct packed_git *p)
668         while (p->windows) {
669                 struct pack_window *w = p->windows;
671                 if (w->inuse_cnt)
672                         die("pack '%s' still has open windows to it",
673                             p->pack_name);
674                 munmap(w->base, w->len);
675                 pack_mapped -= w->len;
676                 pack_open_windows--;
677                 p->windows = w->next;
678                 free(w);
679         }
682 void unuse_pack(struct pack_window **w_cursor)
684         struct pack_window *w = *w_cursor;
685         if (w) {
686                 w->inuse_cnt--;
687                 *w_cursor = NULL;
688         }
691 void close_pack_index(struct packed_git *p)
693         if (p->index_data) {
694                 munmap((void *)p->index_data, p->index_size);
695                 p->index_data = NULL;
696         }
699 /*
700  * This is used by git-repack in case a newly created pack happens to
701  * contain the same set of objects as an existing one.  In that case
702  * the resulting file might be different even if its name would be the
703  * same.  It is best to close any reference to the old pack before it is
704  * replaced on disk.  Of course no index pointers nor windows for given pack
705  * must subsist at this point.  If ever objects from this pack are requested
706  * again, the new version of the pack will be reinitialized through
707  * reprepare_packed_git().
708  */
709 void free_pack_by_name(const char *pack_name)
711         struct packed_git *p, **pp = &packed_git;
713         while (*pp) {
714                 p = *pp;
715                 if (strcmp(pack_name, p->pack_name) == 0) {
716                         clear_delta_base_cache();
717                         close_pack_windows(p);
718                         if (p->pack_fd != -1) {
719                                 close(p->pack_fd);
720                                 pack_open_fds--;
721                         }
722                         close_pack_index(p);
723                         free(p->bad_object_sha1);
724                         *pp = p->next;
725                         if (last_found_pack == p)
726                                 last_found_pack = NULL;
727                         free(p);
728                         return;
729                 }
730                 pp = &p->next;
731         }
734 /*
735  * Do not call this directly as this leaks p->pack_fd on error return;
736  * call open_packed_git() instead.
737  */
738 static int open_packed_git_1(struct packed_git *p)
740         struct stat st;
741         struct pack_header hdr;
742         unsigned char sha1[20];
743         unsigned char *idx_sha1;
744         long fd_flag;
746         if (!p->index_data && open_pack_index(p))
747                 return error("packfile %s index unavailable", p->pack_name);
749         if (!pack_max_fds) {
750                 struct rlimit lim;
751                 unsigned int max_fds;
753                 if (getrlimit(RLIMIT_NOFILE, &lim))
754                         die_errno("cannot get RLIMIT_NOFILE");
756                 max_fds = lim.rlim_cur;
758                 /* Save 3 for stdin/stdout/stderr, 22 for work */
759                 if (25 < max_fds)
760                         pack_max_fds = max_fds - 25;
761                 else
762                         pack_max_fds = 1;
763         }
765         while (pack_max_fds <= pack_open_fds && unuse_one_window(NULL, -1))
766                 ; /* nothing */
768         p->pack_fd = git_open_noatime(p->pack_name);
769         if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
770                 return -1;
771         pack_open_fds++;
773         /* If we created the struct before we had the pack we lack size. */
774         if (!p->pack_size) {
775                 if (!S_ISREG(st.st_mode))
776                         return error("packfile %s not a regular file", p->pack_name);
777                 p->pack_size = st.st_size;
778         } else if (p->pack_size != st.st_size)
779                 return error("packfile %s size changed", p->pack_name);
781         /* We leave these file descriptors open with sliding mmap;
782          * there is no point keeping them open across exec(), though.
783          */
784         fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
785         if (fd_flag < 0)
786                 return error("cannot determine file descriptor flags");
787         fd_flag |= FD_CLOEXEC;
788         if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
789                 return error("cannot set FD_CLOEXEC");
791         /* Verify we recognize this pack file format. */
792         if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
793                 return error("file %s is far too short to be a packfile", p->pack_name);
794         if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
795                 return error("file %s is not a GIT packfile", p->pack_name);
796         if (!pack_version_ok(hdr.hdr_version))
797                 return error("packfile %s is version %"PRIu32" and not"
798                         " supported (try upgrading GIT to a newer version)",
799                         p->pack_name, ntohl(hdr.hdr_version));
801         /* Verify the pack matches its index. */
802         if (p->num_objects != ntohl(hdr.hdr_entries))
803                 return error("packfile %s claims to have %"PRIu32" objects"
804                              " while index indicates %"PRIu32" objects",
805                              p->pack_name, ntohl(hdr.hdr_entries),
806                              p->num_objects);
807         if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
808                 return error("end of packfile %s is unavailable", p->pack_name);
809         if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
810                 return error("packfile %s signature is unavailable", p->pack_name);
811         idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
812         if (hashcmp(sha1, idx_sha1))
813                 return error("packfile %s does not match index", p->pack_name);
814         return 0;
817 static int open_packed_git(struct packed_git *p)
819         if (!open_packed_git_1(p))
820                 return 0;
821         if (p->pack_fd != -1) {
822                 close(p->pack_fd);
823                 pack_open_fds--;
824                 p->pack_fd = -1;
825         }
826         return -1;
829 static int in_window(struct pack_window *win, off_t offset)
831         /* We must promise at least 20 bytes (one hash) after the
832          * offset is available from this window, otherwise the offset
833          * is not actually in this window and a different window (which
834          * has that one hash excess) must be used.  This is to support
835          * the object header and delta base parsing routines below.
836          */
837         off_t win_off = win->offset;
838         return win_off <= offset
839                 && (offset + 20) <= (win_off + win->len);
842 unsigned char *use_pack(struct packed_git *p,
843                 struct pack_window **w_cursor,
844                 off_t offset,
845                 unsigned long *left)
847         struct pack_window *win = *w_cursor;
849         /* Since packfiles end in a hash of their content and it's
850          * pointless to ask for an offset into the middle of that
851          * hash, and the in_window function above wouldn't match
852          * don't allow an offset too close to the end of the file.
853          */
854         if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
855                 die("packfile %s cannot be accessed", p->pack_name);
856         if (offset > (p->pack_size - 20))
857                 die("offset beyond end of packfile (truncated pack?)");
859         if (!win || !in_window(win, offset)) {
860                 if (win)
861                         win->inuse_cnt--;
862                 for (win = p->windows; win; win = win->next) {
863                         if (in_window(win, offset))
864                                 break;
865                 }
866                 if (!win) {
867                         size_t window_align = packed_git_window_size / 2;
868                         off_t len;
870                         if (p->pack_fd == -1 && open_packed_git(p))
871                                 die("packfile %s cannot be accessed", p->pack_name);
873                         win = xcalloc(1, sizeof(*win));
874                         win->offset = (offset / window_align) * window_align;
875                         len = p->pack_size - win->offset;
876                         if (len > packed_git_window_size)
877                                 len = packed_git_window_size;
878                         win->len = (size_t)len;
879                         pack_mapped += win->len;
880                         while (packed_git_limit < pack_mapped
881                                 && unuse_one_window(p, p->pack_fd))
882                                 ; /* nothing */
883                         win->base = xmmap(NULL, win->len,
884                                 PROT_READ, MAP_PRIVATE,
885                                 p->pack_fd, win->offset);
886                         if (win->base == MAP_FAILED)
887                                 die("packfile %s cannot be mapped: %s",
888                                         p->pack_name,
889                                         strerror(errno));
890                         if (!win->offset && win->len == p->pack_size
891                                 && !p->do_not_close) {
892                                 close(p->pack_fd);
893                                 pack_open_fds--;
894                                 p->pack_fd = -1;
895                         }
896                         pack_mmap_calls++;
897                         pack_open_windows++;
898                         if (pack_mapped > peak_pack_mapped)
899                                 peak_pack_mapped = pack_mapped;
900                         if (pack_open_windows > peak_pack_open_windows)
901                                 peak_pack_open_windows = pack_open_windows;
902                         win->next = p->windows;
903                         p->windows = win;
904                 }
905         }
906         if (win != *w_cursor) {
907                 win->last_used = pack_used_ctr++;
908                 win->inuse_cnt++;
909                 *w_cursor = win;
910         }
911         offset -= win->offset;
912         if (left)
913                 *left = win->len - xsize_t(offset);
914         return win->base + offset;
917 static struct packed_git *alloc_packed_git(int extra)
919         struct packed_git *p = xmalloc(sizeof(*p) + extra);
920         memset(p, 0, sizeof(*p));
921         p->pack_fd = -1;
922         return p;
925 static void try_to_free_pack_memory(size_t size)
927         release_pack_memory(size, -1);
930 struct packed_git *add_packed_git(const char *path, int path_len, int local)
932         static int have_set_try_to_free_routine;
933         struct stat st;
934         struct packed_git *p = alloc_packed_git(path_len + 2);
936         if (!have_set_try_to_free_routine) {
937                 have_set_try_to_free_routine = 1;
938                 set_try_to_free_routine(try_to_free_pack_memory);
939         }
941         /*
942          * Make sure a corresponding .pack file exists and that
943          * the index looks sane.
944          */
945         path_len -= strlen(".idx");
946         if (path_len < 1) {
947                 free(p);
948                 return NULL;
949         }
950         memcpy(p->pack_name, path, path_len);
952         strcpy(p->pack_name + path_len, ".keep");
953         if (!access(p->pack_name, F_OK))
954                 p->pack_keep = 1;
956         strcpy(p->pack_name + path_len, ".pack");
957         if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
958                 free(p);
959                 return NULL;
960         }
962         /* ok, it looks sane as far as we can check without
963          * actually mapping the pack file.
964          */
965         p->pack_size = st.st_size;
966         p->pack_local = local;
967         p->mtime = st.st_mtime;
968         if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
969                 hashclr(p->sha1);
970         return p;
973 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
975         const char *path = sha1_pack_name(sha1);
976         struct packed_git *p = alloc_packed_git(strlen(path) + 1);
978         strcpy(p->pack_name, path);
979         hashcpy(p->sha1, sha1);
980         if (check_packed_git_idx(idx_path, p)) {
981                 free(p);
982                 return NULL;
983         }
985         return p;
988 void install_packed_git(struct packed_git *pack)
990         if (pack->pack_fd != -1)
991                 pack_open_fds++;
993         pack->next = packed_git;
994         packed_git = pack;
997 static void prepare_packed_git_one(char *objdir, int local)
999         /* Ensure that this buffer is large enough so that we can
1000            append "/pack/" without clobbering the stack even if
1001            strlen(objdir) were PATH_MAX.  */
1002         char path[PATH_MAX + 1 + 4 + 1 + 1];
1003         int len;
1004         DIR *dir;
1005         struct dirent *de;
1007         sprintf(path, "%s/pack", objdir);
1008         len = strlen(path);
1009         dir = opendir(path);
1010         if (!dir) {
1011                 if (errno != ENOENT)
1012                         error("unable to open object pack directory: %s: %s",
1013                               path, strerror(errno));
1014                 return;
1015         }
1016         path[len++] = '/';
1017         while ((de = readdir(dir)) != NULL) {
1018                 int namelen = strlen(de->d_name);
1019                 struct packed_git *p;
1021                 if (!has_extension(de->d_name, ".idx"))
1022                         continue;
1024                 if (len + namelen + 1 > sizeof(path))
1025                         continue;
1027                 /* Don't reopen a pack we already have. */
1028                 strcpy(path + len, de->d_name);
1029                 for (p = packed_git; p; p = p->next) {
1030                         if (!memcmp(path, p->pack_name, len + namelen - 4))
1031                                 break;
1032                 }
1033                 if (p)
1034                         continue;
1035                 /* See if it really is a valid .idx file with corresponding
1036                  * .pack file that we can map.
1037                  */
1038                 p = add_packed_git(path, len + namelen, local);
1039                 if (!p)
1040                         continue;
1041                 install_packed_git(p);
1042         }
1043         closedir(dir);
1046 static int sort_pack(const void *a_, const void *b_)
1048         struct packed_git *a = *((struct packed_git **)a_);
1049         struct packed_git *b = *((struct packed_git **)b_);
1050         int st;
1052         /*
1053          * Local packs tend to contain objects specific to our
1054          * variant of the project than remote ones.  In addition,
1055          * remote ones could be on a network mounted filesystem.
1056          * Favor local ones for these reasons.
1057          */
1058         st = a->pack_local - b->pack_local;
1059         if (st)
1060                 return -st;
1062         /*
1063          * Younger packs tend to contain more recent objects,
1064          * and more recent objects tend to get accessed more
1065          * often.
1066          */
1067         if (a->mtime < b->mtime)
1068                 return 1;
1069         else if (a->mtime == b->mtime)
1070                 return 0;
1071         return -1;
1074 static void rearrange_packed_git(void)
1076         struct packed_git **ary, *p;
1077         int i, n;
1079         for (n = 0, p = packed_git; p; p = p->next)
1080                 n++;
1081         if (n < 2)
1082                 return;
1084         /* prepare an array of packed_git for easier sorting */
1085         ary = xcalloc(n, sizeof(struct packed_git *));
1086         for (n = 0, p = packed_git; p; p = p->next)
1087                 ary[n++] = p;
1089         qsort(ary, n, sizeof(struct packed_git *), sort_pack);
1091         /* link them back again */
1092         for (i = 0; i < n - 1; i++)
1093                 ary[i]->next = ary[i + 1];
1094         ary[n - 1]->next = NULL;
1095         packed_git = ary[0];
1097         free(ary);
1100 static int prepare_packed_git_run_once = 0;
1101 void prepare_packed_git(void)
1103         struct alternate_object_database *alt;
1105         if (prepare_packed_git_run_once)
1106                 return;
1107         prepare_packed_git_one(get_object_directory(), 1);
1108         prepare_alt_odb();
1109         for (alt = alt_odb_list; alt; alt = alt->next) {
1110                 alt->name[-1] = 0;
1111                 prepare_packed_git_one(alt->base, 0);
1112                 alt->name[-1] = '/';
1113         }
1114         rearrange_packed_git();
1115         prepare_packed_git_run_once = 1;
1118 void reprepare_packed_git(void)
1120         discard_revindex();
1121         prepare_packed_git_run_once = 0;
1122         prepare_packed_git();
1125 static void mark_bad_packed_object(struct packed_git *p,
1126                                    const unsigned char *sha1)
1128         unsigned i;
1129         for (i = 0; i < p->num_bad_objects; i++)
1130                 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1131                         return;
1132         p->bad_object_sha1 = xrealloc(p->bad_object_sha1, 20 * (p->num_bad_objects + 1));
1133         hashcpy(p->bad_object_sha1 + 20 * p->num_bad_objects, sha1);
1134         p->num_bad_objects++;
1137 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1139         struct packed_git *p;
1140         unsigned i;
1142         for (p = packed_git; p; p = p->next)
1143                 for (i = 0; i < p->num_bad_objects; i++)
1144                         if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1145                                 return p;
1146         return NULL;
1149 int check_sha1_signature(const unsigned char *sha1, void *map, unsigned long size, const char *type)
1151         unsigned char real_sha1[20];
1152         hash_sha1_file(map, size, type, real_sha1);
1153         return hashcmp(sha1, real_sha1) ? -1 : 0;
1156 static int git_open_noatime(const char *name)
1158         static int sha1_file_open_flag = O_NOATIME;
1160         for (;;) {
1161                 int fd = open(name, O_RDONLY | sha1_file_open_flag);
1162                 if (fd >= 0)
1163                         return fd;
1165                 /* Might the failure be due to O_NOATIME? */
1166                 if (errno != ENOENT && sha1_file_open_flag) {
1167                         sha1_file_open_flag = 0;
1168                         continue;
1169                 }
1171                 return -1;
1172         }
1175 static int open_sha1_file(const unsigned char *sha1)
1177         int fd;
1178         char *name = sha1_file_name(sha1);
1179         struct alternate_object_database *alt;
1181         fd = git_open_noatime(name);
1182         if (fd >= 0)
1183                 return fd;
1185         prepare_alt_odb();
1186         errno = ENOENT;
1187         for (alt = alt_odb_list; alt; alt = alt->next) {
1188                 name = alt->name;
1189                 fill_sha1_path(name, sha1);
1190                 fd = git_open_noatime(alt->base);
1191                 if (fd >= 0)
1192                         return fd;
1193         }
1194         return -1;
1197 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1199         void *map;
1200         int fd;
1202         fd = open_sha1_file(sha1);
1203         map = NULL;
1204         if (fd >= 0) {
1205                 struct stat st;
1207                 if (!fstat(fd, &st)) {
1208                         *size = xsize_t(st.st_size);
1209                         map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1210                 }
1211                 close(fd);
1212         }
1213         return map;
1216 /*
1217  * There used to be a second loose object header format which
1218  * was meant to mimic the in-pack format, allowing for direct
1219  * copy of the object data.  This format turned up not to be
1220  * really worth it and we no longer write loose objects in that
1221  * format.
1222  */
1223 static int experimental_loose_object(unsigned char *map)
1225         unsigned int word;
1227         /*
1228          * We must determine if the buffer contains the standard
1229          * zlib-deflated stream or the experimental format based
1230          * on the in-pack object format. Compare the header byte
1231          * for each format:
1232          *
1233          * RFC1950 zlib w/ deflate : 0www1000 : 0 <= www <= 7
1234          * Experimental pack-based : Stttssss : ttt = 1,2,3,4
1235          *
1236          * If bit 7 is clear and bits 0-3 equal 8, the buffer MUST be
1237          * in standard loose-object format, UNLESS it is a Git-pack
1238          * format object *exactly* 8 bytes in size when inflated.
1239          *
1240          * However, RFC1950 also specifies that the 1st 16-bit word
1241          * must be divisible by 31 - this checksum tells us our buffer
1242          * is in the standard format, giving a false positive only if
1243          * the 1st word of the Git-pack format object happens to be
1244          * divisible by 31, ie:
1245          *      ((byte0 * 256) + byte1) % 31 = 0
1246          *   =>        0ttt10000www1000 % 31 = 0
1247          *
1248          * As it happens, this case can only arise for www=3 & ttt=1
1249          * - ie, a Commit object, which would have to be 8 bytes in
1250          * size. As no Commit can be that small, we find that the
1251          * combination of these two criteria (bitmask & checksum)
1252          * can always correctly determine the buffer format.
1253          */
1254         word = (map[0] << 8) + map[1];
1255         if ((map[0] & 0x8F) == 0x08 && !(word % 31))
1256                 return 0;
1257         else
1258                 return 1;
1261 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1262                 unsigned long len, enum object_type *type, unsigned long *sizep)
1264         unsigned shift;
1265         unsigned long size, c;
1266         unsigned long used = 0;
1268         c = buf[used++];
1269         *type = (c >> 4) & 7;
1270         size = c & 15;
1271         shift = 4;
1272         while (c & 0x80) {
1273                 if (len <= used || bitsizeof(long) <= shift) {
1274                         error("bad object header");
1275                         size = used = 0;
1276                         break;
1277                 }
1278                 c = buf[used++];
1279                 size += (c & 0x7f) << shift;
1280                 shift += 7;
1281         }
1282         *sizep = size;
1283         return used;
1286 int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz)
1288         unsigned long size, used;
1289         static const char valid_loose_object_type[8] = {
1290                 0, /* OBJ_EXT */
1291                 1, 1, 1, 1, /* "commit", "tree", "blob", "tag" */
1292                 0, /* "delta" and others are invalid in a loose object */
1293         };
1294         enum object_type type;
1296         /* Get the data stream */
1297         memset(stream, 0, sizeof(*stream));
1298         stream->next_in = map;
1299         stream->avail_in = mapsize;
1300         stream->next_out = buffer;
1301         stream->avail_out = bufsiz;
1303         if (experimental_loose_object(map)) {
1304                 /*
1305                  * The old experimental format we no longer produce;
1306                  * we can still read it.
1307                  */
1308                 used = unpack_object_header_buffer(map, mapsize, &type, &size);
1309                 if (!used || !valid_loose_object_type[type])
1310                         return -1;
1311                 map += used;
1312                 mapsize -= used;
1314                 /* Set up the stream for the rest.. */
1315                 stream->next_in = map;
1316                 stream->avail_in = mapsize;
1317                 git_inflate_init(stream);
1319                 /* And generate the fake traditional header */
1320                 stream->total_out = 1 + snprintf(buffer, bufsiz, "%s %lu",
1321                                                  typename(type), size);
1322                 return 0;
1323         }
1324         git_inflate_init(stream);
1325         return git_inflate(stream, 0);
1328 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1330         int bytes = strlen(buffer) + 1;
1331         unsigned char *buf = xmallocz(size);
1332         unsigned long n;
1333         int status = Z_OK;
1335         n = stream->total_out - bytes;
1336         if (n > size)
1337                 n = size;
1338         memcpy(buf, (char *) buffer + bytes, n);
1339         bytes = n;
1340         if (bytes <= size) {
1341                 /*
1342                  * The above condition must be (bytes <= size), not
1343                  * (bytes < size).  In other words, even though we
1344                  * expect no more output and set avail_out to zero,
1345                  * the input zlib stream may have bytes that express
1346                  * "this concludes the stream", and we *do* want to
1347                  * eat that input.
1348                  *
1349                  * Otherwise we would not be able to test that we
1350                  * consumed all the input to reach the expected size;
1351                  * we also want to check that zlib tells us that all
1352                  * went well with status == Z_STREAM_END at the end.
1353                  */
1354                 stream->next_out = buf + bytes;
1355                 stream->avail_out = size - bytes;
1356                 while (status == Z_OK)
1357                         status = git_inflate(stream, Z_FINISH);
1358         }
1359         if (status == Z_STREAM_END && !stream->avail_in) {
1360                 git_inflate_end(stream);
1361                 return buf;
1362         }
1364         if (status < 0)
1365                 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1366         else if (stream->avail_in)
1367                 error("garbage at end of loose object '%s'",
1368                       sha1_to_hex(sha1));
1369         free(buf);
1370         return NULL;
1373 /*
1374  * We used to just use "sscanf()", but that's actually way
1375  * too permissive for what we want to check. So do an anal
1376  * object header parse by hand.
1377  */
1378 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1380         char type[10];
1381         int i;
1382         unsigned long size;
1384         /*
1385          * The type can be at most ten bytes (including the
1386          * terminating '\0' that we add), and is followed by
1387          * a space.
1388          */
1389         i = 0;
1390         for (;;) {
1391                 char c = *hdr++;
1392                 if (c == ' ')
1393                         break;
1394                 type[i++] = c;
1395                 if (i >= sizeof(type))
1396                         return -1;
1397         }
1398         type[i] = 0;
1400         /*
1401          * The length must follow immediately, and be in canonical
1402          * decimal format (ie "010" is not valid).
1403          */
1404         size = *hdr++ - '0';
1405         if (size > 9)
1406                 return -1;
1407         if (size) {
1408                 for (;;) {
1409                         unsigned long c = *hdr - '0';
1410                         if (c > 9)
1411                                 break;
1412                         hdr++;
1413                         size = size * 10 + c;
1414                 }
1415         }
1416         *sizep = size;
1418         /*
1419          * The length must be followed by a zero byte
1420          */
1421         return *hdr ? -1 : type_from_string(type);
1424 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1426         int ret;
1427         git_zstream stream;
1428         char hdr[8192];
1430         ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1431         if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1432                 return NULL;
1434         return unpack_sha1_rest(&stream, hdr, *size, sha1);
1437 unsigned long get_size_from_delta(struct packed_git *p,
1438                                   struct pack_window **w_curs,
1439                                   off_t curpos)
1441         const unsigned char *data;
1442         unsigned char delta_head[20], *in;
1443         git_zstream stream;
1444         int st;
1446         memset(&stream, 0, sizeof(stream));
1447         stream.next_out = delta_head;
1448         stream.avail_out = sizeof(delta_head);
1450         git_inflate_init(&stream);
1451         do {
1452                 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1453                 stream.next_in = in;
1454                 st = git_inflate(&stream, Z_FINISH);
1455                 curpos += stream.next_in - in;
1456         } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1457                  stream.total_out < sizeof(delta_head));
1458         git_inflate_end(&stream);
1459         if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1460                 error("delta data unpack-initial failed");
1461                 return 0;
1462         }
1464         /* Examine the initial part of the delta to figure out
1465          * the result size.
1466          */
1467         data = delta_head;
1469         /* ignore base size */
1470         get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1472         /* Read the result size */
1473         return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1476 static off_t get_delta_base(struct packed_git *p,
1477                                     struct pack_window **w_curs,
1478                                     off_t *curpos,
1479                                     enum object_type type,
1480                                     off_t delta_obj_offset)
1482         unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1483         off_t base_offset;
1485         /* use_pack() assured us we have [base_info, base_info + 20)
1486          * as a range that we can look at without walking off the
1487          * end of the mapped window.  Its actually the hash size
1488          * that is assured.  An OFS_DELTA longer than the hash size
1489          * is stupid, as then a REF_DELTA would be smaller to store.
1490          */
1491         if (type == OBJ_OFS_DELTA) {
1492                 unsigned used = 0;
1493                 unsigned char c = base_info[used++];
1494                 base_offset = c & 127;
1495                 while (c & 128) {
1496                         base_offset += 1;
1497                         if (!base_offset || MSB(base_offset, 7))
1498                                 return 0;  /* overflow */
1499                         c = base_info[used++];
1500                         base_offset = (base_offset << 7) + (c & 127);
1501                 }
1502                 base_offset = delta_obj_offset - base_offset;
1503                 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1504                         return 0;  /* out of bound */
1505                 *curpos += used;
1506         } else if (type == OBJ_REF_DELTA) {
1507                 /* The base entry _must_ be in the same pack */
1508                 base_offset = find_pack_entry_one(base_info, p);
1509                 *curpos += 20;
1510         } else
1511                 die("I am totally screwed");
1512         return base_offset;
1515 /* forward declaration for a mutually recursive function */
1516 static int packed_object_info(struct packed_git *p, off_t offset,
1517                               unsigned long *sizep, int *rtype);
1519 static int packed_delta_info(struct packed_git *p,
1520                              struct pack_window **w_curs,
1521                              off_t curpos,
1522                              enum object_type type,
1523                              off_t obj_offset,
1524                              unsigned long *sizep)
1526         off_t base_offset;
1528         base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
1529         if (!base_offset)
1530                 return OBJ_BAD;
1531         type = packed_object_info(p, base_offset, NULL, NULL);
1532         if (type <= OBJ_NONE) {
1533                 struct revindex_entry *revidx;
1534                 const unsigned char *base_sha1;
1535                 revidx = find_pack_revindex(p, base_offset);
1536                 if (!revidx)
1537                         return OBJ_BAD;
1538                 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
1539                 mark_bad_packed_object(p, base_sha1);
1540                 type = sha1_object_info(base_sha1, NULL);
1541                 if (type <= OBJ_NONE)
1542                         return OBJ_BAD;
1543         }
1545         /* We choose to only get the type of the base object and
1546          * ignore potentially corrupt pack file that expects the delta
1547          * based on a base with a wrong size.  This saves tons of
1548          * inflate() calls.
1549          */
1550         if (sizep) {
1551                 *sizep = get_size_from_delta(p, w_curs, curpos);
1552                 if (*sizep == 0)
1553                         type = OBJ_BAD;
1554         }
1556         return type;
1559 int unpack_object_header(struct packed_git *p,
1560                          struct pack_window **w_curs,
1561                          off_t *curpos,
1562                          unsigned long *sizep)
1564         unsigned char *base;
1565         unsigned long left;
1566         unsigned long used;
1567         enum object_type type;
1569         /* use_pack() assures us we have [base, base + 20) available
1570          * as a range that we can look at.  (Its actually the hash
1571          * size that is assured.)  With our object header encoding
1572          * the maximum deflated object size is 2^137, which is just
1573          * insane, so we know won't exceed what we have been given.
1574          */
1575         base = use_pack(p, w_curs, *curpos, &left);
1576         used = unpack_object_header_buffer(base, left, &type, sizep);
1577         if (!used) {
1578                 type = OBJ_BAD;
1579         } else
1580                 *curpos += used;
1582         return type;
1585 static int packed_object_info(struct packed_git *p, off_t obj_offset,
1586                               unsigned long *sizep, int *rtype)
1588         struct pack_window *w_curs = NULL;
1589         unsigned long size;
1590         off_t curpos = obj_offset;
1591         enum object_type type;
1593         type = unpack_object_header(p, &w_curs, &curpos, &size);
1594         if (rtype)
1595                 *rtype = type; /* representation type */
1597         switch (type) {
1598         case OBJ_OFS_DELTA:
1599         case OBJ_REF_DELTA:
1600                 type = packed_delta_info(p, &w_curs, curpos,
1601                                          type, obj_offset, sizep);
1602                 break;
1603         case OBJ_COMMIT:
1604         case OBJ_TREE:
1605         case OBJ_BLOB:
1606         case OBJ_TAG:
1607                 if (sizep)
1608                         *sizep = size;
1609                 break;
1610         default:
1611                 error("unknown object type %i at offset %"PRIuMAX" in %s",
1612                       type, (uintmax_t)obj_offset, p->pack_name);
1613                 type = OBJ_BAD;
1614         }
1615         unuse_pack(&w_curs);
1616         return type;
1619 static void *unpack_compressed_entry(struct packed_git *p,
1620                                     struct pack_window **w_curs,
1621                                     off_t curpos,
1622                                     unsigned long size)
1624         int st;
1625         git_zstream stream;
1626         unsigned char *buffer, *in;
1628         buffer = xmallocz(size);
1629         memset(&stream, 0, sizeof(stream));
1630         stream.next_out = buffer;
1631         stream.avail_out = size + 1;
1633         git_inflate_init(&stream);
1634         do {
1635                 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1636                 stream.next_in = in;
1637                 st = git_inflate(&stream, Z_FINISH);
1638                 if (!stream.avail_out)
1639                         break; /* the payload is larger than it should be */
1640                 curpos += stream.next_in - in;
1641         } while (st == Z_OK || st == Z_BUF_ERROR);
1642         git_inflate_end(&stream);
1643         if ((st != Z_STREAM_END) || stream.total_out != size) {
1644                 free(buffer);
1645                 return NULL;
1646         }
1648         return buffer;
1651 #define MAX_DELTA_CACHE (256)
1653 static size_t delta_base_cached;
1655 static struct delta_base_cache_lru_list {
1656         struct delta_base_cache_lru_list *prev;
1657         struct delta_base_cache_lru_list *next;
1658 } delta_base_cache_lru = { &delta_base_cache_lru, &delta_base_cache_lru };
1660 static struct delta_base_cache_entry {
1661         struct delta_base_cache_lru_list lru;
1662         void *data;
1663         struct packed_git *p;
1664         off_t base_offset;
1665         unsigned long size;
1666         enum object_type type;
1667 } delta_base_cache[MAX_DELTA_CACHE];
1669 static unsigned long pack_entry_hash(struct packed_git *p, off_t base_offset)
1671         unsigned long hash;
1673         hash = (unsigned long)p + (unsigned long)base_offset;
1674         hash += (hash >> 8) + (hash >> 16);
1675         return hash % MAX_DELTA_CACHE;
1678 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
1680         unsigned long hash = pack_entry_hash(p, base_offset);
1681         struct delta_base_cache_entry *ent = delta_base_cache + hash;
1682         return (ent->data && ent->p == p && ent->base_offset == base_offset);
1685 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
1686         unsigned long *base_size, enum object_type *type, int keep_cache)
1688         void *ret;
1689         unsigned long hash = pack_entry_hash(p, base_offset);
1690         struct delta_base_cache_entry *ent = delta_base_cache + hash;
1692         ret = ent->data;
1693         if (!ret || ent->p != p || ent->base_offset != base_offset)
1694                 return unpack_entry(p, base_offset, type, base_size);
1696         if (!keep_cache) {
1697                 ent->data = NULL;
1698                 ent->lru.next->prev = ent->lru.prev;
1699                 ent->lru.prev->next = ent->lru.next;
1700                 delta_base_cached -= ent->size;
1701         } else {
1702                 ret = xmemdupz(ent->data, ent->size);
1703         }
1704         *type = ent->type;
1705         *base_size = ent->size;
1706         return ret;
1709 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
1711         if (ent->data) {
1712                 free(ent->data);
1713                 ent->data = NULL;
1714                 ent->lru.next->prev = ent->lru.prev;
1715                 ent->lru.prev->next = ent->lru.next;
1716                 delta_base_cached -= ent->size;
1717         }
1720 void clear_delta_base_cache(void)
1722         unsigned long p;
1723         for (p = 0; p < MAX_DELTA_CACHE; p++)
1724                 release_delta_base_cache(&delta_base_cache[p]);
1727 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
1728         void *base, unsigned long base_size, enum object_type type)
1730         unsigned long hash = pack_entry_hash(p, base_offset);
1731         struct delta_base_cache_entry *ent = delta_base_cache + hash;
1732         struct delta_base_cache_lru_list *lru;
1734         release_delta_base_cache(ent);
1735         delta_base_cached += base_size;
1737         for (lru = delta_base_cache_lru.next;
1738              delta_base_cached > delta_base_cache_limit
1739              && lru != &delta_base_cache_lru;
1740              lru = lru->next) {
1741                 struct delta_base_cache_entry *f = (void *)lru;
1742                 if (f->type == OBJ_BLOB)
1743                         release_delta_base_cache(f);
1744         }
1745         for (lru = delta_base_cache_lru.next;
1746              delta_base_cached > delta_base_cache_limit
1747              && lru != &delta_base_cache_lru;
1748              lru = lru->next) {
1749                 struct delta_base_cache_entry *f = (void *)lru;
1750                 release_delta_base_cache(f);
1751         }
1753         ent->p = p;
1754         ent->base_offset = base_offset;
1755         ent->type = type;
1756         ent->data = base;
1757         ent->size = base_size;
1758         ent->lru.next = &delta_base_cache_lru;
1759         ent->lru.prev = delta_base_cache_lru.prev;
1760         delta_base_cache_lru.prev->next = &ent->lru;
1761         delta_base_cache_lru.prev = &ent->lru;
1764 static void *read_object(const unsigned char *sha1, enum object_type *type,
1765                          unsigned long *size);
1767 static void *unpack_delta_entry(struct packed_git *p,
1768                                 struct pack_window **w_curs,
1769                                 off_t curpos,
1770                                 unsigned long delta_size,
1771                                 off_t obj_offset,
1772                                 enum object_type *type,
1773                                 unsigned long *sizep)
1775         void *delta_data, *result, *base;
1776         unsigned long base_size;
1777         off_t base_offset;
1779         base_offset = get_delta_base(p, w_curs, &curpos, *type, obj_offset);
1780         if (!base_offset) {
1781                 error("failed to validate delta base reference "
1782                       "at offset %"PRIuMAX" from %s",
1783                       (uintmax_t)curpos, p->pack_name);
1784                 return NULL;
1785         }
1786         unuse_pack(w_curs);
1787         base = cache_or_unpack_entry(p, base_offset, &base_size, type, 0);
1788         if (!base) {
1789                 /*
1790                  * We're probably in deep shit, but let's try to fetch
1791                  * the required base anyway from another pack or loose.
1792                  * This is costly but should happen only in the presence
1793                  * of a corrupted pack, and is better than failing outright.
1794                  */
1795                 struct revindex_entry *revidx;
1796                 const unsigned char *base_sha1;
1797                 revidx = find_pack_revindex(p, base_offset);
1798                 if (!revidx)
1799                         return NULL;
1800                 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
1801                 error("failed to read delta base object %s"
1802                       " at offset %"PRIuMAX" from %s",
1803                       sha1_to_hex(base_sha1), (uintmax_t)base_offset,
1804                       p->pack_name);
1805                 mark_bad_packed_object(p, base_sha1);
1806                 base = read_object(base_sha1, type, &base_size);
1807                 if (!base)
1808                         return NULL;
1809         }
1811         delta_data = unpack_compressed_entry(p, w_curs, curpos, delta_size);
1812         if (!delta_data) {
1813                 error("failed to unpack compressed delta "
1814                       "at offset %"PRIuMAX" from %s",
1815                       (uintmax_t)curpos, p->pack_name);
1816                 free(base);
1817                 return NULL;
1818         }
1819         result = patch_delta(base, base_size,
1820                              delta_data, delta_size,
1821                              sizep);
1822         if (!result)
1823                 die("failed to apply delta");
1824         free(delta_data);
1825         add_delta_base_cache(p, base_offset, base, base_size, *type);
1826         return result;
1829 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
1831         static FILE *log_file;
1833         if (!log_file) {
1834                 log_file = fopen(log_pack_access, "w");
1835                 if (!log_file) {
1836                         error("cannot open pack access log '%s' for writing: %s",
1837                               log_pack_access, strerror(errno));
1838                         log_pack_access = NULL;
1839                         return;
1840                 }
1841         }
1842         fprintf(log_file, "%s %"PRIuMAX"\n",
1843                 p->pack_name, (uintmax_t)obj_offset);
1844         fflush(log_file);
1847 int do_check_packed_object_crc;
1849 void *unpack_entry(struct packed_git *p, off_t obj_offset,
1850                    enum object_type *type, unsigned long *sizep)
1852         struct pack_window *w_curs = NULL;
1853         off_t curpos = obj_offset;
1854         void *data;
1856         if (log_pack_access)
1857                 write_pack_access_log(p, obj_offset);
1859         if (do_check_packed_object_crc && p->index_version > 1) {
1860                 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
1861                 unsigned long len = revidx[1].offset - obj_offset;
1862                 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
1863                         const unsigned char *sha1 =
1864                                 nth_packed_object_sha1(p, revidx->nr);
1865                         error("bad packed object CRC for %s",
1866                               sha1_to_hex(sha1));
1867                         mark_bad_packed_object(p, sha1);
1868                         unuse_pack(&w_curs);
1869                         return NULL;
1870                 }
1871         }
1873         *type = unpack_object_header(p, &w_curs, &curpos, sizep);
1874         switch (*type) {
1875         case OBJ_OFS_DELTA:
1876         case OBJ_REF_DELTA:
1877                 data = unpack_delta_entry(p, &w_curs, curpos, *sizep,
1878                                           obj_offset, type, sizep);
1879                 break;
1880         case OBJ_COMMIT:
1881         case OBJ_TREE:
1882         case OBJ_BLOB:
1883         case OBJ_TAG:
1884                 data = unpack_compressed_entry(p, &w_curs, curpos, *sizep);
1885                 break;
1886         default:
1887                 data = NULL;
1888                 error("unknown object type %i at offset %"PRIuMAX" in %s",
1889                       *type, (uintmax_t)obj_offset, p->pack_name);
1890         }
1891         unuse_pack(&w_curs);
1892         return data;
1895 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
1896                                             uint32_t n)
1898         const unsigned char *index = p->index_data;
1899         if (!index) {
1900                 if (open_pack_index(p))
1901                         return NULL;
1902                 index = p->index_data;
1903         }
1904         if (n >= p->num_objects)
1905                 return NULL;
1906         index += 4 * 256;
1907         if (p->index_version == 1) {
1908                 return index + 24 * n + 4;
1909         } else {
1910                 index += 8;
1911                 return index + 20 * n;
1912         }
1915 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
1917         const unsigned char *index = p->index_data;
1918         index += 4 * 256;
1919         if (p->index_version == 1) {
1920                 return ntohl(*((uint32_t *)(index + 24 * n)));
1921         } else {
1922                 uint32_t off;
1923                 index += 8 + p->num_objects * (20 + 4);
1924                 off = ntohl(*((uint32_t *)(index + 4 * n)));
1925                 if (!(off & 0x80000000))
1926                         return off;
1927                 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
1928                 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
1929                                    ntohl(*((uint32_t *)(index + 4)));
1930         }
1933 off_t find_pack_entry_one(const unsigned char *sha1,
1934                                   struct packed_git *p)
1936         const uint32_t *level1_ofs = p->index_data;
1937         const unsigned char *index = p->index_data;
1938         unsigned hi, lo, stride;
1939         static int use_lookup = -1;
1940         static int debug_lookup = -1;
1942         if (debug_lookup < 0)
1943                 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
1945         if (!index) {
1946                 if (open_pack_index(p))
1947                         return 0;
1948                 level1_ofs = p->index_data;
1949                 index = p->index_data;
1950         }
1951         if (p->index_version > 1) {
1952                 level1_ofs += 2;
1953                 index += 8;
1954         }
1955         index += 4 * 256;
1956         hi = ntohl(level1_ofs[*sha1]);
1957         lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
1958         if (p->index_version > 1) {
1959                 stride = 20;
1960         } else {
1961                 stride = 24;
1962                 index += 4;
1963         }
1965         if (debug_lookup)
1966                 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
1967                        sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
1969         if (use_lookup < 0)
1970                 use_lookup = !!getenv("GIT_USE_LOOKUP");
1971         if (use_lookup) {
1972                 int pos = sha1_entry_pos(index, stride, 0,
1973                                          lo, hi, p->num_objects, sha1);
1974                 if (pos < 0)
1975                         return 0;
1976                 return nth_packed_object_offset(p, pos);
1977         }
1979         do {
1980                 unsigned mi = (lo + hi) / 2;
1981                 int cmp = hashcmp(index + mi * stride, sha1);
1983                 if (debug_lookup)
1984                         printf("lo %u hi %u rg %u mi %u\n",
1985                                lo, hi, hi - lo, mi);
1986                 if (!cmp)
1987                         return nth_packed_object_offset(p, mi);
1988                 if (cmp > 0)
1989                         hi = mi;
1990                 else
1991                         lo = mi+1;
1992         } while (lo < hi);
1993         return 0;
1996 int is_pack_valid(struct packed_git *p)
1998         /* An already open pack is known to be valid. */
1999         if (p->pack_fd != -1)
2000                 return 1;
2002         /* If the pack has one window completely covering the
2003          * file size, the pack is known to be valid even if
2004          * the descriptor is not currently open.
2005          */
2006         if (p->windows) {
2007                 struct pack_window *w = p->windows;
2009                 if (!w->offset && w->len == p->pack_size)
2010                         return 1;
2011         }
2013         /* Force the pack to open to prove its valid. */
2014         return !open_packed_git(p);
2017 static int fill_pack_entry(const unsigned char *sha1,
2018                            struct pack_entry *e,
2019                            struct packed_git *p)
2021         off_t offset;
2023         if (p->num_bad_objects) {
2024                 unsigned i;
2025                 for (i = 0; i < p->num_bad_objects; i++)
2026                         if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2027                                 return 0;
2028         }
2030         offset = find_pack_entry_one(sha1, p);
2031         if (!offset)
2032                 return 0;
2034         /*
2035          * We are about to tell the caller where they can locate the
2036          * requested object.  We better make sure the packfile is
2037          * still here and can be accessed before supplying that
2038          * answer, as it may have been deleted since the index was
2039          * loaded!
2040          */
2041         if (!is_pack_valid(p)) {
2042                 warning("packfile %s cannot be accessed", p->pack_name);
2043                 return 0;
2044         }
2045         e->offset = offset;
2046         e->p = p;
2047         hashcpy(e->sha1, sha1);
2048         return 1;
2051 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2053         struct packed_git *p;
2055         prepare_packed_git();
2056         if (!packed_git)
2057                 return 0;
2059         if (last_found_pack && fill_pack_entry(sha1, e, last_found_pack))
2060                 return 1;
2062         for (p = packed_git; p; p = p->next) {
2063                 if (p == last_found_pack || !fill_pack_entry(sha1, e, p))
2064                         continue;
2066                 last_found_pack = p;
2067                 return 1;
2068         }
2069         return 0;
2072 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2073                                   struct packed_git *packs)
2075         struct packed_git *p;
2077         for (p = packs; p; p = p->next) {
2078                 if (find_pack_entry_one(sha1, p))
2079                         return p;
2080         }
2081         return NULL;
2085 static int sha1_loose_object_info(const unsigned char *sha1, unsigned long *sizep)
2087         int status;
2088         unsigned long mapsize, size;
2089         void *map;
2090         git_zstream stream;
2091         char hdr[32];
2093         map = map_sha1_file(sha1, &mapsize);
2094         if (!map)
2095                 return error("unable to find %s", sha1_to_hex(sha1));
2096         if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2097                 status = error("unable to unpack %s header",
2098                                sha1_to_hex(sha1));
2099         else if ((status = parse_sha1_header(hdr, &size)) < 0)
2100                 status = error("unable to parse %s header", sha1_to_hex(sha1));
2101         else if (sizep)
2102                 *sizep = size;
2103         git_inflate_end(&stream);
2104         munmap(map, mapsize);
2105         return status;
2108 /* returns enum object_type or negative */
2109 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi)
2111         struct cached_object *co;
2112         struct pack_entry e;
2113         int status, rtype;
2115         co = find_cached_object(sha1);
2116         if (co) {
2117                 if (oi->sizep)
2118                         *(oi->sizep) = co->size;
2119                 oi->whence = OI_CACHED;
2120                 return co->type;
2121         }
2123         if (!find_pack_entry(sha1, &e)) {
2124                 /* Most likely it's a loose object. */
2125                 status = sha1_loose_object_info(sha1, oi->sizep);
2126                 if (status >= 0) {
2127                         oi->whence = OI_LOOSE;
2128                         return status;
2129                 }
2131                 /* Not a loose object; someone else may have just packed it. */
2132                 reprepare_packed_git();
2133                 if (!find_pack_entry(sha1, &e))
2134                         return status;
2135         }
2137         status = packed_object_info(e.p, e.offset, oi->sizep, &rtype);
2138         if (status < 0) {
2139                 mark_bad_packed_object(e.p, sha1);
2140                 status = sha1_object_info_extended(sha1, oi);
2141         } else if (in_delta_base_cache(e.p, e.offset)) {
2142                 oi->whence = OI_DBCACHED;
2143         } else {
2144                 oi->whence = OI_PACKED;
2145                 oi->u.packed.offset = e.offset;
2146                 oi->u.packed.pack = e.p;
2147                 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2148                                          rtype == OBJ_OFS_DELTA);
2149         }
2151         return status;
2154 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2156         struct object_info oi;
2158         oi.sizep = sizep;
2159         return sha1_object_info_extended(sha1, &oi);
2162 static void *read_packed_sha1(const unsigned char *sha1,
2163                               enum object_type *type, unsigned long *size)
2165         struct pack_entry e;
2166         void *data;
2168         if (!find_pack_entry(sha1, &e))
2169                 return NULL;
2170         data = cache_or_unpack_entry(e.p, e.offset, size, type, 1);
2171         if (!data) {
2172                 /*
2173                  * We're probably in deep shit, but let's try to fetch
2174                  * the required object anyway from another pack or loose.
2175                  * This should happen only in the presence of a corrupted
2176                  * pack, and is better than failing outright.
2177                  */
2178                 error("failed to read object %s at offset %"PRIuMAX" from %s",
2179                       sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2180                 mark_bad_packed_object(e.p, sha1);
2181                 data = read_object(sha1, type, size);
2182         }
2183         return data;
2186 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2187                       unsigned char *sha1)
2189         struct cached_object *co;
2191         hash_sha1_file(buf, len, typename(type), sha1);
2192         if (has_sha1_file(sha1) || find_cached_object(sha1))
2193                 return 0;
2194         if (cached_object_alloc <= cached_object_nr) {
2195                 cached_object_alloc = alloc_nr(cached_object_alloc);
2196                 cached_objects = xrealloc(cached_objects,
2197                                           sizeof(*cached_objects) *
2198                                           cached_object_alloc);
2199         }
2200         co = &cached_objects[cached_object_nr++];
2201         co->size = len;
2202         co->type = type;
2203         co->buf = xmalloc(len);
2204         memcpy(co->buf, buf, len);
2205         hashcpy(co->sha1, sha1);
2206         return 0;
2209 static void *read_object(const unsigned char *sha1, enum object_type *type,
2210                          unsigned long *size)
2212         unsigned long mapsize;
2213         void *map, *buf;
2214         struct cached_object *co;
2216         co = find_cached_object(sha1);
2217         if (co) {
2218                 *type = co->type;
2219                 *size = co->size;
2220                 return xmemdupz(co->buf, co->size);
2221         }
2223         buf = read_packed_sha1(sha1, type, size);
2224         if (buf)
2225                 return buf;
2226         map = map_sha1_file(sha1, &mapsize);
2227         if (map) {
2228                 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2229                 munmap(map, mapsize);
2230                 return buf;
2231         }
2232         reprepare_packed_git();
2233         return read_packed_sha1(sha1, type, size);
2236 /*
2237  * This function dies on corrupt objects; the callers who want to
2238  * deal with them should arrange to call read_object() and give error
2239  * messages themselves.
2240  */
2241 void *read_sha1_file_extended(const unsigned char *sha1,
2242                               enum object_type *type,
2243                               unsigned long *size,
2244                               unsigned flag)
2246         void *data;
2247         char *path;
2248         const struct packed_git *p;
2249         const unsigned char *repl = (flag & READ_SHA1_FILE_REPLACE)
2250                 ? lookup_replace_object(sha1) : sha1;
2252         errno = 0;
2253         data = read_object(repl, type, size);
2254         if (data)
2255                 return data;
2257         if (errno && errno != ENOENT)
2258                 die_errno("failed to read object %s", sha1_to_hex(sha1));
2260         /* die if we replaced an object with one that does not exist */
2261         if (repl != sha1)
2262                 die("replacement %s not found for %s",
2263                     sha1_to_hex(repl), sha1_to_hex(sha1));
2265         if (has_loose_object(repl)) {
2266                 path = sha1_file_name(sha1);
2267                 die("loose object %s (stored in %s) is corrupt",
2268                     sha1_to_hex(repl), path);
2269         }
2271         if ((p = has_packed_and_bad(repl)) != NULL)
2272                 die("packed object %s (stored in %s) is corrupt",
2273                     sha1_to_hex(repl), p->pack_name);
2275         return NULL;
2278 void *read_object_with_reference(const unsigned char *sha1,
2279                                  const char *required_type_name,
2280                                  unsigned long *size,
2281                                  unsigned char *actual_sha1_return)
2283         enum object_type type, required_type;
2284         void *buffer;
2285         unsigned long isize;
2286         unsigned char actual_sha1[20];
2288         required_type = type_from_string(required_type_name);
2289         hashcpy(actual_sha1, sha1);
2290         while (1) {
2291                 int ref_length = -1;
2292                 const char *ref_type = NULL;
2294                 buffer = read_sha1_file(actual_sha1, &type, &isize);
2295                 if (!buffer)
2296                         return NULL;
2297                 if (type == required_type) {
2298                         *size = isize;
2299                         if (actual_sha1_return)
2300                                 hashcpy(actual_sha1_return, actual_sha1);
2301                         return buffer;
2302                 }
2303                 /* Handle references */
2304                 else if (type == OBJ_COMMIT)
2305                         ref_type = "tree ";
2306                 else if (type == OBJ_TAG)
2307                         ref_type = "object ";
2308                 else {
2309                         free(buffer);
2310                         return NULL;
2311                 }
2312                 ref_length = strlen(ref_type);
2314                 if (ref_length + 40 > isize ||
2315                     memcmp(buffer, ref_type, ref_length) ||
2316                     get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
2317                         free(buffer);
2318                         return NULL;
2319                 }
2320                 free(buffer);
2321                 /* Now we have the ID of the referred-to object in
2322                  * actual_sha1.  Check again. */
2323         }
2326 static void write_sha1_file_prepare(const void *buf, unsigned long len,
2327                                     const char *type, unsigned char *sha1,
2328                                     char *hdr, int *hdrlen)
2330         git_SHA_CTX c;
2332         /* Generate the header */
2333         *hdrlen = sprintf(hdr, "%s %lu", type, len)+1;
2335         /* Sha1.. */
2336         git_SHA1_Init(&c);
2337         git_SHA1_Update(&c, hdr, *hdrlen);
2338         git_SHA1_Update(&c, buf, len);
2339         git_SHA1_Final(sha1, &c);
2342 /*
2343  * Move the just written object into its final resting place.
2344  * NEEDSWORK: this should be renamed to finalize_temp_file() as
2345  * "moving" is only a part of what it does, when no patch between
2346  * master to pu changes the call sites of this function.
2347  */
2348 int move_temp_to_file(const char *tmpfile, const char *filename)
2350         int ret = 0;
2352         if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
2353                 goto try_rename;
2354         else if (link(tmpfile, filename))
2355                 ret = errno;
2357         /*
2358          * Coda hack - coda doesn't like cross-directory links,
2359          * so we fall back to a rename, which will mean that it
2360          * won't be able to check collisions, but that's not a
2361          * big deal.
2362          *
2363          * The same holds for FAT formatted media.
2364          *
2365          * When this succeeds, we just return.  We have nothing
2366          * left to unlink.
2367          */
2368         if (ret && ret != EEXIST) {
2369         try_rename:
2370                 if (!rename(tmpfile, filename))
2371                         goto out;
2372                 ret = errno;
2373         }
2374         unlink_or_warn(tmpfile);
2375         if (ret) {
2376                 if (ret != EEXIST) {
2377                         return error("unable to write sha1 filename %s: %s\n", filename, strerror(ret));
2378                 }
2379                 /* FIXME!!! Collision check here ? */
2380         }
2382 out:
2383         if (adjust_shared_perm(filename))
2384                 return error("unable to set permission to '%s'", filename);
2385         return 0;
2388 static int write_buffer(int fd, const void *buf, size_t len)
2390         if (write_in_full(fd, buf, len) < 0)
2391                 return error("file write error (%s)", strerror(errno));
2392         return 0;
2395 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
2396                    unsigned char *sha1)
2398         char hdr[32];
2399         int hdrlen;
2400         write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2401         return 0;
2404 /* Finalize a file on disk, and close it. */
2405 static void close_sha1_file(int fd)
2407         if (fsync_object_files)
2408                 fsync_or_die(fd, "sha1 file");
2409         if (close(fd) != 0)
2410                 die_errno("error when closing sha1 file");
2413 /* Size of directory component, including the ending '/' */
2414 static inline int directory_size(const char *filename)
2416         const char *s = strrchr(filename, '/');
2417         if (!s)
2418                 return 0;
2419         return s - filename + 1;
2422 /*
2423  * This creates a temporary file in the same directory as the final
2424  * 'filename'
2425  *
2426  * We want to avoid cross-directory filename renames, because those
2427  * can have problems on various filesystems (FAT, NFS, Coda).
2428  */
2429 static int create_tmpfile(char *buffer, size_t bufsiz, const char *filename)
2431         int fd, dirlen = directory_size(filename);
2433         if (dirlen + 20 > bufsiz) {
2434                 errno = ENAMETOOLONG;
2435                 return -1;
2436         }
2437         memcpy(buffer, filename, dirlen);
2438         strcpy(buffer + dirlen, "tmp_obj_XXXXXX");
2439         fd = git_mkstemp_mode(buffer, 0444);
2440         if (fd < 0 && dirlen && errno == ENOENT) {
2441                 /* Make sure the directory exists */
2442                 memcpy(buffer, filename, dirlen);
2443                 buffer[dirlen-1] = 0;
2444                 if (mkdir(buffer, 0777) || adjust_shared_perm(buffer))
2445                         return -1;
2447                 /* Try again */
2448                 strcpy(buffer + dirlen - 1, "/tmp_obj_XXXXXX");
2449                 fd = git_mkstemp_mode(buffer, 0444);
2450         }
2451         return fd;
2454 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
2455                               const void *buf, unsigned long len, time_t mtime)
2457         int fd, ret;
2458         unsigned char compressed[4096];
2459         git_zstream stream;
2460         git_SHA_CTX c;
2461         unsigned char parano_sha1[20];
2462         char *filename;
2463         static char tmp_file[PATH_MAX];
2465         filename = sha1_file_name(sha1);
2466         fd = create_tmpfile(tmp_file, sizeof(tmp_file), filename);
2467         if (fd < 0) {
2468                 if (errno == EACCES)
2469                         return error("insufficient permission for adding an object to repository database %s\n", get_object_directory());
2470                 else
2471                         return error("unable to create temporary sha1 filename %s: %s\n", tmp_file, strerror(errno));
2472         }
2474         /* Set it up */
2475         memset(&stream, 0, sizeof(stream));
2476         git_deflate_init(&stream, zlib_compression_level);
2477         stream.next_out = compressed;
2478         stream.avail_out = sizeof(compressed);
2479         git_SHA1_Init(&c);
2481         /* First header.. */
2482         stream.next_in = (unsigned char *)hdr;
2483         stream.avail_in = hdrlen;
2484         while (git_deflate(&stream, 0) == Z_OK)
2485                 ; /* nothing */
2486         git_SHA1_Update(&c, hdr, hdrlen);
2488         /* Then the data itself.. */
2489         stream.next_in = (void *)buf;
2490         stream.avail_in = len;
2491         do {
2492                 unsigned char *in0 = stream.next_in;
2493                 ret = git_deflate(&stream, Z_FINISH);
2494                 git_SHA1_Update(&c, in0, stream.next_in - in0);
2495                 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
2496                         die("unable to write sha1 file");
2497                 stream.next_out = compressed;
2498                 stream.avail_out = sizeof(compressed);
2499         } while (ret == Z_OK);
2501         if (ret != Z_STREAM_END)
2502                 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
2503         ret = git_deflate_end_gently(&stream);
2504         if (ret != Z_OK)
2505                 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
2506         git_SHA1_Final(parano_sha1, &c);
2507         if (hashcmp(sha1, parano_sha1) != 0)
2508                 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
2510         close_sha1_file(fd);
2512         if (mtime) {
2513                 struct utimbuf utb;
2514                 utb.actime = mtime;
2515                 utb.modtime = mtime;
2516                 if (utime(tmp_file, &utb) < 0)
2517                         warning("failed utime() on %s: %s",
2518                                 tmp_file, strerror(errno));
2519         }
2521         return move_temp_to_file(tmp_file, filename);
2524 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *returnsha1)
2526         unsigned char sha1[20];
2527         char hdr[32];
2528         int hdrlen;
2530         /* Normally if we have it in the pack then we do not bother writing
2531          * it out into .git/objects/??/?{38} file.
2532          */
2533         write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2534         if (returnsha1)
2535                 hashcpy(returnsha1, sha1);
2536         if (has_sha1_file(sha1))
2537                 return 0;
2538         return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
2541 int force_object_loose(const unsigned char *sha1, time_t mtime)
2543         void *buf;
2544         unsigned long len;
2545         enum object_type type;
2546         char hdr[32];
2547         int hdrlen;
2548         int ret;
2550         if (has_loose_object(sha1))
2551                 return 0;
2552         buf = read_packed_sha1(sha1, &type, &len);
2553         if (!buf)
2554                 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
2555         hdrlen = sprintf(hdr, "%s %lu", typename(type), len) + 1;
2556         ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
2557         free(buf);
2559         return ret;
2562 int has_pack_index(const unsigned char *sha1)
2564         struct stat st;
2565         if (stat(sha1_pack_index_name(sha1), &st))
2566                 return 0;
2567         return 1;
2570 int has_sha1_pack(const unsigned char *sha1)
2572         struct pack_entry e;
2573         return find_pack_entry(sha1, &e);
2576 int has_sha1_file(const unsigned char *sha1)
2578         struct pack_entry e;
2580         if (find_pack_entry(sha1, &e))
2581                 return 1;
2582         return has_loose_object(sha1);
2585 static void check_tree(const void *buf, size_t size)
2587         struct tree_desc desc;
2588         struct name_entry entry;
2590         init_tree_desc(&desc, buf, size);
2591         while (tree_entry(&desc, &entry))
2592                 /* do nothing
2593                  * tree_entry() will die() on malformed entries */
2594                 ;
2597 static void check_commit(const void *buf, size_t size)
2599         struct commit c;
2600         memset(&c, 0, sizeof(c));
2601         if (parse_commit_buffer(&c, buf, size))
2602                 die("corrupt commit");
2605 static void check_tag(const void *buf, size_t size)
2607         struct tag t;
2608         memset(&t, 0, sizeof(t));
2609         if (parse_tag_buffer(&t, buf, size))
2610                 die("corrupt tag");
2613 static int index_mem(unsigned char *sha1, void *buf, size_t size,
2614                      enum object_type type,
2615                      const char *path, unsigned flags)
2617         int ret, re_allocated = 0;
2618         int write_object = flags & HASH_WRITE_OBJECT;
2620         if (!type)
2621                 type = OBJ_BLOB;
2623         /*
2624          * Convert blobs to git internal format
2625          */
2626         if ((type == OBJ_BLOB) && path) {
2627                 struct strbuf nbuf = STRBUF_INIT;
2628                 if (convert_to_git(path, buf, size, &nbuf,
2629                                    write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
2630                         buf = strbuf_detach(&nbuf, &size);
2631                         re_allocated = 1;
2632                 }
2633         }
2634         if (flags & HASH_FORMAT_CHECK) {
2635                 if (type == OBJ_TREE)
2636                         check_tree(buf, size);
2637                 if (type == OBJ_COMMIT)
2638                         check_commit(buf, size);
2639                 if (type == OBJ_TAG)
2640                         check_tag(buf, size);
2641         }
2643         if (write_object)
2644                 ret = write_sha1_file(buf, size, typename(type), sha1);
2645         else
2646                 ret = hash_sha1_file(buf, size, typename(type), sha1);
2647         if (re_allocated)
2648                 free(buf);
2649         return ret;
2652 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
2653                       const char *path, unsigned flags)
2655         struct strbuf sbuf = STRBUF_INIT;
2656         int ret;
2658         if (strbuf_read(&sbuf, fd, 4096) >= 0)
2659                 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
2660         else
2661                 ret = -1;
2662         strbuf_release(&sbuf);
2663         return ret;
2666 #define SMALL_FILE_SIZE (32*1024)
2668 static int index_core(unsigned char *sha1, int fd, size_t size,
2669                       enum object_type type, const char *path,
2670                       unsigned flags)
2672         int ret;
2674         if (!size) {
2675                 ret = index_mem(sha1, NULL, size, type, path, flags);
2676         } else if (size <= SMALL_FILE_SIZE) {
2677                 char *buf = xmalloc(size);
2678                 if (size == read_in_full(fd, buf, size))
2679                         ret = index_mem(sha1, buf, size, type, path, flags);
2680                 else
2681                         ret = error("short read %s", strerror(errno));
2682                 free(buf);
2683         } else {
2684                 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
2685                 ret = index_mem(sha1, buf, size, type, path, flags);
2686                 munmap(buf, size);
2687         }
2688         return ret;
2691 /*
2692  * This creates one packfile per large blob unless bulk-checkin
2693  * machinery is "plugged".
2694  *
2695  * This also bypasses the usual "convert-to-git" dance, and that is on
2696  * purpose. We could write a streaming version of the converting
2697  * functions and insert that before feeding the data to fast-import
2698  * (or equivalent in-core API described above), but the primary
2699  * motivation for trying to stream from the working tree file and to
2700  * avoid mmaping it in core is to deal with large binary blobs, and
2701  * by definition they do _not_ want to get any conversion.
2702  */
2703 static int index_stream(unsigned char *sha1, int fd, size_t size,
2704                         enum object_type type, const char *path,
2705                         unsigned flags)
2707         return index_bulk_checkin(sha1, fd, size, type, path, flags);
2710 int index_fd(unsigned char *sha1, int fd, struct stat *st,
2711              enum object_type type, const char *path, unsigned flags)
2713         int ret;
2714         size_t size = xsize_t(st->st_size);
2716         if (!S_ISREG(st->st_mode))
2717                 ret = index_pipe(sha1, fd, type, path, flags);
2718         else if (size <= big_file_threshold || type != OBJ_BLOB)
2719                 ret = index_core(sha1, fd, size, type, path, flags);
2720         else
2721                 ret = index_stream(sha1, fd, size, type, path, flags);
2722         close(fd);
2723         return ret;
2726 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
2728         int fd;
2729         struct strbuf sb = STRBUF_INIT;
2731         switch (st->st_mode & S_IFMT) {
2732         case S_IFREG:
2733                 fd = open(path, O_RDONLY);
2734                 if (fd < 0)
2735                         return error("open(\"%s\"): %s", path,
2736                                      strerror(errno));
2737                 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
2738                         return error("%s: failed to insert into database",
2739                                      path);
2740                 break;
2741         case S_IFLNK:
2742                 if (strbuf_readlink(&sb, path, st->st_size)) {
2743                         char *errstr = strerror(errno);
2744                         return error("readlink(\"%s\"): %s", path,
2745                                      errstr);
2746                 }
2747                 if (!(flags & HASH_WRITE_OBJECT))
2748                         hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
2749                 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
2750                         return error("%s: failed to insert into database",
2751                                      path);
2752                 strbuf_release(&sb);
2753                 break;
2754         case S_IFDIR:
2755                 return resolve_gitlink_ref(path, "HEAD", sha1);
2756         default:
2757                 return error("%s: unsupported file type", path);
2758         }
2759         return 0;
2762 int read_pack_header(int fd, struct pack_header *header)
2764         if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
2765                 /* "eof before pack header was fully read" */
2766                 return PH_ERROR_EOF;
2768         if (header->hdr_signature != htonl(PACK_SIGNATURE))
2769                 /* "protocol error (pack signature mismatch detected)" */
2770                 return PH_ERROR_PACK_SIGNATURE;
2771         if (!pack_version_ok(header->hdr_version))
2772                 /* "protocol error (pack version unsupported)" */
2773                 return PH_ERROR_PROTOCOL;
2774         return 0;
2777 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
2779         enum object_type type = sha1_object_info(sha1, NULL);
2780         if (type < 0)
2781                 die("%s is not a valid object", sha1_to_hex(sha1));
2782         if (type != expect)
2783                 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
2784                     typename(expect));