Code

contrib/completion: "local var=()" is misinterpreted as func-decl by zsh
[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 cached_object *find_cached_object(const unsigned char *sha1)
58 {
59         int i;
60         struct cached_object *co = cached_objects;
62         for (i = 0; i < cached_object_nr; i++, co++) {
63                 if (!hashcmp(co->sha1, sha1))
64                         return co;
65         }
66         if (!hashcmp(sha1, empty_tree.sha1))
67                 return &empty_tree;
68         return NULL;
69 }
71 int mkdir_in_gitdir(const char *path)
72 {
73         if (mkdir(path, 0777)) {
74                 int saved_errno = errno;
75                 struct stat st;
76                 struct strbuf sb = STRBUF_INIT;
78                 if (errno != EEXIST)
79                         return -1;
80                 /*
81                  * Are we looking at a path in a symlinked worktree
82                  * whose original repository does not yet have it?
83                  * e.g. .git/rr-cache pointing at its original
84                  * repository in which the user hasn't performed any
85                  * conflict resolution yet?
86                  */
87                 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
88                     strbuf_readlink(&sb, path, st.st_size) ||
89                     !is_absolute_path(sb.buf) ||
90                     mkdir(sb.buf, 0777)) {
91                         strbuf_release(&sb);
92                         errno = saved_errno;
93                         return -1;
94                 }
95                 strbuf_release(&sb);
96         }
97         return adjust_shared_perm(path);
98 }
100 int safe_create_leading_directories(char *path)
102         char *pos = path + offset_1st_component(path);
103         struct stat st;
105         while (pos) {
106                 pos = strchr(pos, '/');
107                 if (!pos)
108                         break;
109                 while (*++pos == '/')
110                         ;
111                 if (!*pos)
112                         break;
113                 *--pos = '\0';
114                 if (!stat(path, &st)) {
115                         /* path exists */
116                         if (!S_ISDIR(st.st_mode)) {
117                                 *pos = '/';
118                                 return -3;
119                         }
120                 }
121                 else if (mkdir(path, 0777)) {
122                         *pos = '/';
123                         return -1;
124                 }
125                 else if (adjust_shared_perm(path)) {
126                         *pos = '/';
127                         return -2;
128                 }
129                 *pos++ = '/';
130         }
131         return 0;
134 int safe_create_leading_directories_const(const char *path)
136         /* path points to cache entries, so xstrdup before messing with it */
137         char *buf = xstrdup(path);
138         int result = safe_create_leading_directories(buf);
139         free(buf);
140         return result;
143 static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
145         int i;
146         for (i = 0; i < 20; i++) {
147                 static char hex[] = "0123456789abcdef";
148                 unsigned int val = sha1[i];
149                 char *pos = pathbuf + i*2 + (i > 0);
150                 *pos++ = hex[val >> 4];
151                 *pos = hex[val & 0xf];
152         }
155 /*
156  * NOTE! This returns a statically allocated buffer, so you have to be
157  * careful about using it. Do an "xstrdup()" if you need to save the
158  * filename.
159  *
160  * Also note that this returns the location for creating.  Reading
161  * SHA1 file can happen from any alternate directory listed in the
162  * DB_ENVIRONMENT environment variable if it is not found in
163  * the primary object database.
164  */
165 char *sha1_file_name(const unsigned char *sha1)
167         static char buf[PATH_MAX];
168         const char *objdir;
169         int len;
171         objdir = get_object_directory();
172         len = strlen(objdir);
174         /* '/' + sha1(2) + '/' + sha1(38) + '\0' */
175         if (len + 43 > PATH_MAX)
176                 die("insanely long object directory %s", objdir);
177         memcpy(buf, objdir, len);
178         buf[len] = '/';
179         buf[len+3] = '/';
180         buf[len+42] = '\0';
181         fill_sha1_path(buf + len + 1, sha1);
182         return buf;
185 static char *sha1_get_pack_name(const unsigned char *sha1,
186                                 char **name, char **base, const char *which)
188         static const char hex[] = "0123456789abcdef";
189         char *buf;
190         int i;
192         if (!*base) {
193                 const char *sha1_file_directory = get_object_directory();
194                 int len = strlen(sha1_file_directory);
195                 *base = xmalloc(len + 60);
196                 sprintf(*base, "%s/pack/pack-1234567890123456789012345678901234567890.%s",
197                         sha1_file_directory, which);
198                 *name = *base + len + 11;
199         }
201         buf = *name;
203         for (i = 0; i < 20; i++) {
204                 unsigned int val = *sha1++;
205                 *buf++ = hex[val >> 4];
206                 *buf++ = hex[val & 0xf];
207         }
209         return *base;
212 char *sha1_pack_name(const unsigned char *sha1)
214         static char *name, *base;
216         return sha1_get_pack_name(sha1, &name, &base, "pack");
219 char *sha1_pack_index_name(const unsigned char *sha1)
221         static char *name, *base;
223         return sha1_get_pack_name(sha1, &name, &base, "idx");
226 struct alternate_object_database *alt_odb_list;
227 static struct alternate_object_database **alt_odb_tail;
229 static void read_info_alternates(const char * alternates, int depth);
230 static int git_open_noatime(const char *name);
232 /*
233  * Prepare alternate object database registry.
234  *
235  * The variable alt_odb_list points at the list of struct
236  * alternate_object_database.  The elements on this list come from
237  * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
238  * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
239  * whose contents is similar to that environment variable but can be
240  * LF separated.  Its base points at a statically allocated buffer that
241  * contains "/the/directory/corresponding/to/.git/objects/...", while
242  * its name points just after the slash at the end of ".git/objects/"
243  * in the example above, and has enough space to hold 40-byte hex
244  * SHA1, an extra slash for the first level indirection, and the
245  * terminating NUL.
246  */
247 static int link_alt_odb_entry(const char * entry, int len, const char * relative_base, int depth)
249         const char *objdir = get_object_directory();
250         struct alternate_object_database *ent;
251         struct alternate_object_database *alt;
252         int pfxlen, entlen;
253         struct strbuf pathbuf = STRBUF_INIT;
255         if (!is_absolute_path(entry) && relative_base) {
256                 strbuf_addstr(&pathbuf, real_path(relative_base));
257                 strbuf_addch(&pathbuf, '/');
258         }
259         strbuf_add(&pathbuf, entry, len);
261         normalize_path_copy(pathbuf.buf, pathbuf.buf);
263         pfxlen = strlen(pathbuf.buf);
265         /*
266          * The trailing slash after the directory name is given by
267          * this function at the end. Remove duplicates.
268          */
269         while (pfxlen && pathbuf.buf[pfxlen-1] == '/')
270                 pfxlen -= 1;
272         entlen = pfxlen + 43; /* '/' + 2 hex + '/' + 38 hex + NUL */
273         ent = xmalloc(sizeof(*ent) + entlen);
274         memcpy(ent->base, pathbuf.buf, pfxlen);
275         strbuf_release(&pathbuf);
277         ent->name = ent->base + pfxlen + 1;
278         ent->base[pfxlen + 3] = '/';
279         ent->base[pfxlen] = ent->base[entlen-1] = 0;
281         /* Detect cases where alternate disappeared */
282         if (!is_directory(ent->base)) {
283                 error("object directory %s does not exist; "
284                       "check .git/objects/info/alternates.",
285                       ent->base);
286                 free(ent);
287                 return -1;
288         }
290         /* Prevent the common mistake of listing the same
291          * thing twice, or object directory itself.
292          */
293         for (alt = alt_odb_list; alt; alt = alt->next) {
294                 if (!memcmp(ent->base, alt->base, pfxlen)) {
295                         free(ent);
296                         return -1;
297                 }
298         }
299         if (!memcmp(ent->base, objdir, pfxlen)) {
300                 free(ent);
301                 return -1;
302         }
304         /* add the alternate entry */
305         *alt_odb_tail = ent;
306         alt_odb_tail = &(ent->next);
307         ent->next = NULL;
309         /* recursively add alternates */
310         read_info_alternates(ent->base, depth + 1);
312         ent->base[pfxlen] = '/';
314         return 0;
317 static void link_alt_odb_entries(const char *alt, const char *ep, int sep,
318                                  const char *relative_base, int depth)
320         const char *cp, *last;
322         if (depth > 5) {
323                 error("%s: ignoring alternate object stores, nesting too deep.",
324                                 relative_base);
325                 return;
326         }
328         last = alt;
329         while (last < ep) {
330                 cp = last;
331                 if (cp < ep && *cp == '#') {
332                         while (cp < ep && *cp != sep)
333                                 cp++;
334                         last = cp + 1;
335                         continue;
336                 }
337                 while (cp < ep && *cp != sep)
338                         cp++;
339                 if (last != cp) {
340                         if (!is_absolute_path(last) && depth) {
341                                 error("%s: ignoring relative alternate object store %s",
342                                                 relative_base, last);
343                         } else {
344                                 link_alt_odb_entry(last, cp - last,
345                                                 relative_base, depth);
346                         }
347                 }
348                 while (cp < ep && *cp == sep)
349                         cp++;
350                 last = cp;
351         }
354 static void read_info_alternates(const char * relative_base, int depth)
356         char *map;
357         size_t mapsz;
358         struct stat st;
359         const char alt_file_name[] = "info/alternates";
360         /* Given that relative_base is no longer than PATH_MAX,
361            ensure that "path" has enough space to append "/", the
362            file name, "info/alternates", and a trailing NUL.  */
363         char path[PATH_MAX + 1 + sizeof alt_file_name];
364         int fd;
366         sprintf(path, "%s/%s", relative_base, alt_file_name);
367         fd = git_open_noatime(path);
368         if (fd < 0)
369                 return;
370         if (fstat(fd, &st) || (st.st_size == 0)) {
371                 close(fd);
372                 return;
373         }
374         mapsz = xsize_t(st.st_size);
375         map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
376         close(fd);
378         link_alt_odb_entries(map, map + mapsz, '\n', relative_base, depth);
380         munmap(map, mapsz);
383 void add_to_alternates_file(const char *reference)
385         struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
386         int fd = hold_lock_file_for_append(lock, git_path("objects/info/alternates"), LOCK_DIE_ON_ERROR);
387         char *alt = mkpath("%s\n", reference);
388         write_or_die(fd, alt, strlen(alt));
389         if (commit_lock_file(lock))
390                 die("could not close alternates file");
391         if (alt_odb_tail)
392                 link_alt_odb_entries(alt, alt + strlen(alt), '\n', NULL, 0);
395 void foreach_alt_odb(alt_odb_fn fn, void *cb)
397         struct alternate_object_database *ent;
399         prepare_alt_odb();
400         for (ent = alt_odb_list; ent; ent = ent->next)
401                 if (fn(ent, cb))
402                         return;
405 void prepare_alt_odb(void)
407         const char *alt;
409         if (alt_odb_tail)
410                 return;
412         alt = getenv(ALTERNATE_DB_ENVIRONMENT);
413         if (!alt) alt = "";
415         alt_odb_tail = &alt_odb_list;
416         link_alt_odb_entries(alt, alt + strlen(alt), PATH_SEP, NULL, 0);
418         read_info_alternates(get_object_directory(), 0);
421 static int has_loose_object_local(const unsigned char *sha1)
423         char *name = sha1_file_name(sha1);
424         return !access(name, F_OK);
427 int has_loose_object_nonlocal(const unsigned char *sha1)
429         struct alternate_object_database *alt;
430         prepare_alt_odb();
431         for (alt = alt_odb_list; alt; alt = alt->next) {
432                 fill_sha1_path(alt->name, sha1);
433                 if (!access(alt->base, F_OK))
434                         return 1;
435         }
436         return 0;
439 static int has_loose_object(const unsigned char *sha1)
441         return has_loose_object_local(sha1) ||
442                has_loose_object_nonlocal(sha1);
445 static unsigned int pack_used_ctr;
446 static unsigned int pack_mmap_calls;
447 static unsigned int peak_pack_open_windows;
448 static unsigned int pack_open_windows;
449 static unsigned int pack_open_fds;
450 static unsigned int pack_max_fds;
451 static size_t peak_pack_mapped;
452 static size_t pack_mapped;
453 struct packed_git *packed_git;
455 void pack_report(void)
457         fprintf(stderr,
458                 "pack_report: getpagesize()            = %10" SZ_FMT "\n"
459                 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
460                 "pack_report: core.packedGitLimit      = %10" SZ_FMT "\n",
461                 sz_fmt(getpagesize()),
462                 sz_fmt(packed_git_window_size),
463                 sz_fmt(packed_git_limit));
464         fprintf(stderr,
465                 "pack_report: pack_used_ctr            = %10u\n"
466                 "pack_report: pack_mmap_calls          = %10u\n"
467                 "pack_report: pack_open_windows        = %10u / %10u\n"
468                 "pack_report: pack_mapped              = "
469                         "%10" SZ_FMT " / %10" SZ_FMT "\n",
470                 pack_used_ctr,
471                 pack_mmap_calls,
472                 pack_open_windows, peak_pack_open_windows,
473                 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
476 static int check_packed_git_idx(const char *path,  struct packed_git *p)
478         void *idx_map;
479         struct pack_idx_header *hdr;
480         size_t idx_size;
481         uint32_t version, nr, i, *index;
482         int fd = git_open_noatime(path);
483         struct stat st;
485         if (fd < 0)
486                 return -1;
487         if (fstat(fd, &st)) {
488                 close(fd);
489                 return -1;
490         }
491         idx_size = xsize_t(st.st_size);
492         if (idx_size < 4 * 256 + 20 + 20) {
493                 close(fd);
494                 return error("index file %s is too small", path);
495         }
496         idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
497         close(fd);
499         hdr = idx_map;
500         if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
501                 version = ntohl(hdr->idx_version);
502                 if (version < 2 || version > 2) {
503                         munmap(idx_map, idx_size);
504                         return error("index file %s is version %"PRIu32
505                                      " and is not supported by this binary"
506                                      " (try upgrading GIT to a newer version)",
507                                      path, version);
508                 }
509         } else
510                 version = 1;
512         nr = 0;
513         index = idx_map;
514         if (version > 1)
515                 index += 2;  /* skip index header */
516         for (i = 0; i < 256; i++) {
517                 uint32_t n = ntohl(index[i]);
518                 if (n < nr) {
519                         munmap(idx_map, idx_size);
520                         return error("non-monotonic index %s", path);
521                 }
522                 nr = n;
523         }
525         if (version == 1) {
526                 /*
527                  * Total size:
528                  *  - 256 index entries 4 bytes each
529                  *  - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
530                  *  - 20-byte SHA1 of the packfile
531                  *  - 20-byte SHA1 file checksum
532                  */
533                 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
534                         munmap(idx_map, idx_size);
535                         return error("wrong index v1 file size in %s", path);
536                 }
537         } else if (version == 2) {
538                 /*
539                  * Minimum size:
540                  *  - 8 bytes of header
541                  *  - 256 index entries 4 bytes each
542                  *  - 20-byte sha1 entry * nr
543                  *  - 4-byte crc entry * nr
544                  *  - 4-byte offset entry * nr
545                  *  - 20-byte SHA1 of the packfile
546                  *  - 20-byte SHA1 file checksum
547                  * And after the 4-byte offset table might be a
548                  * variable sized table containing 8-byte entries
549                  * for offsets larger than 2^31.
550                  */
551                 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
552                 unsigned long max_size = min_size;
553                 if (nr)
554                         max_size += (nr - 1)*8;
555                 if (idx_size < min_size || idx_size > max_size) {
556                         munmap(idx_map, idx_size);
557                         return error("wrong index v2 file size in %s", path);
558                 }
559                 if (idx_size != min_size &&
560                     /*
561                      * make sure we can deal with large pack offsets.
562                      * 31-bit signed offset won't be enough, neither
563                      * 32-bit unsigned one will be.
564                      */
565                     (sizeof(off_t) <= 4)) {
566                         munmap(idx_map, idx_size);
567                         return error("pack too large for current definition of off_t in %s", path);
568                 }
569         }
571         p->index_version = version;
572         p->index_data = idx_map;
573         p->index_size = idx_size;
574         p->num_objects = nr;
575         return 0;
578 int open_pack_index(struct packed_git *p)
580         char *idx_name;
581         int ret;
583         if (p->index_data)
584                 return 0;
586         idx_name = xstrdup(p->pack_name);
587         strcpy(idx_name + strlen(idx_name) - strlen(".pack"), ".idx");
588         ret = check_packed_git_idx(idx_name, p);
589         free(idx_name);
590         return ret;
593 static void scan_windows(struct packed_git *p,
594         struct packed_git **lru_p,
595         struct pack_window **lru_w,
596         struct pack_window **lru_l)
598         struct pack_window *w, *w_l;
600         for (w_l = NULL, w = p->windows; w; w = w->next) {
601                 if (!w->inuse_cnt) {
602                         if (!*lru_w || w->last_used < (*lru_w)->last_used) {
603                                 *lru_p = p;
604                                 *lru_w = w;
605                                 *lru_l = w_l;
606                         }
607                 }
608                 w_l = w;
609         }
612 static int unuse_one_window(struct packed_git *current, int keep_fd)
614         struct packed_git *p, *lru_p = NULL;
615         struct pack_window *lru_w = NULL, *lru_l = NULL;
617         if (current)
618                 scan_windows(current, &lru_p, &lru_w, &lru_l);
619         for (p = packed_git; p; p = p->next)
620                 scan_windows(p, &lru_p, &lru_w, &lru_l);
621         if (lru_p) {
622                 munmap(lru_w->base, lru_w->len);
623                 pack_mapped -= lru_w->len;
624                 if (lru_l)
625                         lru_l->next = lru_w->next;
626                 else {
627                         lru_p->windows = lru_w->next;
628                         if (!lru_p->windows && lru_p->pack_fd != -1
629                                 && lru_p->pack_fd != keep_fd) {
630                                 close(lru_p->pack_fd);
631                                 pack_open_fds--;
632                                 lru_p->pack_fd = -1;
633                         }
634                 }
635                 free(lru_w);
636                 pack_open_windows--;
637                 return 1;
638         }
639         return 0;
642 void release_pack_memory(size_t need, int fd)
644         size_t cur = pack_mapped;
645         while (need >= (cur - pack_mapped) && unuse_one_window(NULL, fd))
646                 ; /* nothing */
649 void *xmmap(void *start, size_t length,
650         int prot, int flags, int fd, off_t offset)
652         void *ret = mmap(start, length, prot, flags, fd, offset);
653         if (ret == MAP_FAILED) {
654                 if (!length)
655                         return NULL;
656                 release_pack_memory(length, fd);
657                 ret = mmap(start, length, prot, flags, fd, offset);
658                 if (ret == MAP_FAILED)
659                         die_errno("Out of memory? mmap failed");
660         }
661         return ret;
664 void close_pack_windows(struct packed_git *p)
666         while (p->windows) {
667                 struct pack_window *w = p->windows;
669                 if (w->inuse_cnt)
670                         die("pack '%s' still has open windows to it",
671                             p->pack_name);
672                 munmap(w->base, w->len);
673                 pack_mapped -= w->len;
674                 pack_open_windows--;
675                 p->windows = w->next;
676                 free(w);
677         }
680 void unuse_pack(struct pack_window **w_cursor)
682         struct pack_window *w = *w_cursor;
683         if (w) {
684                 w->inuse_cnt--;
685                 *w_cursor = NULL;
686         }
689 void close_pack_index(struct packed_git *p)
691         if (p->index_data) {
692                 munmap((void *)p->index_data, p->index_size);
693                 p->index_data = NULL;
694         }
697 /*
698  * This is used by git-repack in case a newly created pack happens to
699  * contain the same set of objects as an existing one.  In that case
700  * the resulting file might be different even if its name would be the
701  * same.  It is best to close any reference to the old pack before it is
702  * replaced on disk.  Of course no index pointers nor windows for given pack
703  * must subsist at this point.  If ever objects from this pack are requested
704  * again, the new version of the pack will be reinitialized through
705  * reprepare_packed_git().
706  */
707 void free_pack_by_name(const char *pack_name)
709         struct packed_git *p, **pp = &packed_git;
711         while (*pp) {
712                 p = *pp;
713                 if (strcmp(pack_name, p->pack_name) == 0) {
714                         clear_delta_base_cache();
715                         close_pack_windows(p);
716                         if (p->pack_fd != -1) {
717                                 close(p->pack_fd);
718                                 pack_open_fds--;
719                         }
720                         close_pack_index(p);
721                         free(p->bad_object_sha1);
722                         *pp = p->next;
723                         free(p);
724                         return;
725                 }
726                 pp = &p->next;
727         }
730 /*
731  * Do not call this directly as this leaks p->pack_fd on error return;
732  * call open_packed_git() instead.
733  */
734 static int open_packed_git_1(struct packed_git *p)
736         struct stat st;
737         struct pack_header hdr;
738         unsigned char sha1[20];
739         unsigned char *idx_sha1;
740         long fd_flag;
742         if (!p->index_data && open_pack_index(p))
743                 return error("packfile %s index unavailable", p->pack_name);
745         if (!pack_max_fds) {
746                 struct rlimit lim;
747                 unsigned int max_fds;
749                 if (getrlimit(RLIMIT_NOFILE, &lim))
750                         die_errno("cannot get RLIMIT_NOFILE");
752                 max_fds = lim.rlim_cur;
754                 /* Save 3 for stdin/stdout/stderr, 22 for work */
755                 if (25 < max_fds)
756                         pack_max_fds = max_fds - 25;
757                 else
758                         pack_max_fds = 1;
759         }
761         while (pack_max_fds <= pack_open_fds && unuse_one_window(NULL, -1))
762                 ; /* nothing */
764         p->pack_fd = git_open_noatime(p->pack_name);
765         if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
766                 return -1;
767         pack_open_fds++;
769         /* If we created the struct before we had the pack we lack size. */
770         if (!p->pack_size) {
771                 if (!S_ISREG(st.st_mode))
772                         return error("packfile %s not a regular file", p->pack_name);
773                 p->pack_size = st.st_size;
774         } else if (p->pack_size != st.st_size)
775                 return error("packfile %s size changed", p->pack_name);
777         /* We leave these file descriptors open with sliding mmap;
778          * there is no point keeping them open across exec(), though.
779          */
780         fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
781         if (fd_flag < 0)
782                 return error("cannot determine file descriptor flags");
783         fd_flag |= FD_CLOEXEC;
784         if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
785                 return error("cannot set FD_CLOEXEC");
787         /* Verify we recognize this pack file format. */
788         if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
789                 return error("file %s is far too short to be a packfile", p->pack_name);
790         if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
791                 return error("file %s is not a GIT packfile", p->pack_name);
792         if (!pack_version_ok(hdr.hdr_version))
793                 return error("packfile %s is version %"PRIu32" and not"
794                         " supported (try upgrading GIT to a newer version)",
795                         p->pack_name, ntohl(hdr.hdr_version));
797         /* Verify the pack matches its index. */
798         if (p->num_objects != ntohl(hdr.hdr_entries))
799                 return error("packfile %s claims to have %"PRIu32" objects"
800                              " while index indicates %"PRIu32" objects",
801                              p->pack_name, ntohl(hdr.hdr_entries),
802                              p->num_objects);
803         if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
804                 return error("end of packfile %s is unavailable", p->pack_name);
805         if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
806                 return error("packfile %s signature is unavailable", p->pack_name);
807         idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
808         if (hashcmp(sha1, idx_sha1))
809                 return error("packfile %s does not match index", p->pack_name);
810         return 0;
813 static int open_packed_git(struct packed_git *p)
815         if (!open_packed_git_1(p))
816                 return 0;
817         if (p->pack_fd != -1) {
818                 close(p->pack_fd);
819                 pack_open_fds--;
820                 p->pack_fd = -1;
821         }
822         return -1;
825 static int in_window(struct pack_window *win, off_t offset)
827         /* We must promise at least 20 bytes (one hash) after the
828          * offset is available from this window, otherwise the offset
829          * is not actually in this window and a different window (which
830          * has that one hash excess) must be used.  This is to support
831          * the object header and delta base parsing routines below.
832          */
833         off_t win_off = win->offset;
834         return win_off <= offset
835                 && (offset + 20) <= (win_off + win->len);
838 unsigned char *use_pack(struct packed_git *p,
839                 struct pack_window **w_cursor,
840                 off_t offset,
841                 unsigned long *left)
843         struct pack_window *win = *w_cursor;
845         /* Since packfiles end in a hash of their content and it's
846          * pointless to ask for an offset into the middle of that
847          * hash, and the in_window function above wouldn't match
848          * don't allow an offset too close to the end of the file.
849          */
850         if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
851                 die("packfile %s cannot be accessed", p->pack_name);
852         if (offset > (p->pack_size - 20))
853                 die("offset beyond end of packfile (truncated pack?)");
855         if (!win || !in_window(win, offset)) {
856                 if (win)
857                         win->inuse_cnt--;
858                 for (win = p->windows; win; win = win->next) {
859                         if (in_window(win, offset))
860                                 break;
861                 }
862                 if (!win) {
863                         size_t window_align = packed_git_window_size / 2;
864                         off_t len;
866                         if (p->pack_fd == -1 && open_packed_git(p))
867                                 die("packfile %s cannot be accessed", p->pack_name);
869                         win = xcalloc(1, sizeof(*win));
870                         win->offset = (offset / window_align) * window_align;
871                         len = p->pack_size - win->offset;
872                         if (len > packed_git_window_size)
873                                 len = packed_git_window_size;
874                         win->len = (size_t)len;
875                         pack_mapped += win->len;
876                         while (packed_git_limit < pack_mapped
877                                 && unuse_one_window(p, p->pack_fd))
878                                 ; /* nothing */
879                         win->base = xmmap(NULL, win->len,
880                                 PROT_READ, MAP_PRIVATE,
881                                 p->pack_fd, win->offset);
882                         if (win->base == MAP_FAILED)
883                                 die("packfile %s cannot be mapped: %s",
884                                         p->pack_name,
885                                         strerror(errno));
886                         if (!win->offset && win->len == p->pack_size
887                                 && !p->do_not_close) {
888                                 close(p->pack_fd);
889                                 pack_open_fds--;
890                                 p->pack_fd = -1;
891                         }
892                         pack_mmap_calls++;
893                         pack_open_windows++;
894                         if (pack_mapped > peak_pack_mapped)
895                                 peak_pack_mapped = pack_mapped;
896                         if (pack_open_windows > peak_pack_open_windows)
897                                 peak_pack_open_windows = pack_open_windows;
898                         win->next = p->windows;
899                         p->windows = win;
900                 }
901         }
902         if (win != *w_cursor) {
903                 win->last_used = pack_used_ctr++;
904                 win->inuse_cnt++;
905                 *w_cursor = win;
906         }
907         offset -= win->offset;
908         if (left)
909                 *left = win->len - xsize_t(offset);
910         return win->base + offset;
913 static struct packed_git *alloc_packed_git(int extra)
915         struct packed_git *p = xmalloc(sizeof(*p) + extra);
916         memset(p, 0, sizeof(*p));
917         p->pack_fd = -1;
918         return p;
921 static void try_to_free_pack_memory(size_t size)
923         release_pack_memory(size, -1);
926 struct packed_git *add_packed_git(const char *path, int path_len, int local)
928         static int have_set_try_to_free_routine;
929         struct stat st;
930         struct packed_git *p = alloc_packed_git(path_len + 2);
932         if (!have_set_try_to_free_routine) {
933                 have_set_try_to_free_routine = 1;
934                 set_try_to_free_routine(try_to_free_pack_memory);
935         }
937         /*
938          * Make sure a corresponding .pack file exists and that
939          * the index looks sane.
940          */
941         path_len -= strlen(".idx");
942         if (path_len < 1) {
943                 free(p);
944                 return NULL;
945         }
946         memcpy(p->pack_name, path, path_len);
948         strcpy(p->pack_name + path_len, ".keep");
949         if (!access(p->pack_name, F_OK))
950                 p->pack_keep = 1;
952         strcpy(p->pack_name + path_len, ".pack");
953         if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
954                 free(p);
955                 return NULL;
956         }
958         /* ok, it looks sane as far as we can check without
959          * actually mapping the pack file.
960          */
961         p->pack_size = st.st_size;
962         p->pack_local = local;
963         p->mtime = st.st_mtime;
964         if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
965                 hashclr(p->sha1);
966         return p;
969 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
971         const char *path = sha1_pack_name(sha1);
972         struct packed_git *p = alloc_packed_git(strlen(path) + 1);
974         strcpy(p->pack_name, path);
975         hashcpy(p->sha1, sha1);
976         if (check_packed_git_idx(idx_path, p)) {
977                 free(p);
978                 return NULL;
979         }
981         return p;
984 void install_packed_git(struct packed_git *pack)
986         if (pack->pack_fd != -1)
987                 pack_open_fds++;
989         pack->next = packed_git;
990         packed_git = pack;
993 static void prepare_packed_git_one(char *objdir, int local)
995         /* Ensure that this buffer is large enough so that we can
996            append "/pack/" without clobbering the stack even if
997            strlen(objdir) were PATH_MAX.  */
998         char path[PATH_MAX + 1 + 4 + 1 + 1];
999         int len;
1000         DIR *dir;
1001         struct dirent *de;
1003         sprintf(path, "%s/pack", objdir);
1004         len = strlen(path);
1005         dir = opendir(path);
1006         if (!dir) {
1007                 if (errno != ENOENT)
1008                         error("unable to open object pack directory: %s: %s",
1009                               path, strerror(errno));
1010                 return;
1011         }
1012         path[len++] = '/';
1013         while ((de = readdir(dir)) != NULL) {
1014                 int namelen = strlen(de->d_name);
1015                 struct packed_git *p;
1017                 if (!has_extension(de->d_name, ".idx"))
1018                         continue;
1020                 if (len + namelen + 1 > sizeof(path))
1021                         continue;
1023                 /* Don't reopen a pack we already have. */
1024                 strcpy(path + len, de->d_name);
1025                 for (p = packed_git; p; p = p->next) {
1026                         if (!memcmp(path, p->pack_name, len + namelen - 4))
1027                                 break;
1028                 }
1029                 if (p)
1030                         continue;
1031                 /* See if it really is a valid .idx file with corresponding
1032                  * .pack file that we can map.
1033                  */
1034                 p = add_packed_git(path, len + namelen, local);
1035                 if (!p)
1036                         continue;
1037                 install_packed_git(p);
1038         }
1039         closedir(dir);
1042 static int sort_pack(const void *a_, const void *b_)
1044         struct packed_git *a = *((struct packed_git **)a_);
1045         struct packed_git *b = *((struct packed_git **)b_);
1046         int st;
1048         /*
1049          * Local packs tend to contain objects specific to our
1050          * variant of the project than remote ones.  In addition,
1051          * remote ones could be on a network mounted filesystem.
1052          * Favor local ones for these reasons.
1053          */
1054         st = a->pack_local - b->pack_local;
1055         if (st)
1056                 return -st;
1058         /*
1059          * Younger packs tend to contain more recent objects,
1060          * and more recent objects tend to get accessed more
1061          * often.
1062          */
1063         if (a->mtime < b->mtime)
1064                 return 1;
1065         else if (a->mtime == b->mtime)
1066                 return 0;
1067         return -1;
1070 static void rearrange_packed_git(void)
1072         struct packed_git **ary, *p;
1073         int i, n;
1075         for (n = 0, p = packed_git; p; p = p->next)
1076                 n++;
1077         if (n < 2)
1078                 return;
1080         /* prepare an array of packed_git for easier sorting */
1081         ary = xcalloc(n, sizeof(struct packed_git *));
1082         for (n = 0, p = packed_git; p; p = p->next)
1083                 ary[n++] = p;
1085         qsort(ary, n, sizeof(struct packed_git *), sort_pack);
1087         /* link them back again */
1088         for (i = 0; i < n - 1; i++)
1089                 ary[i]->next = ary[i + 1];
1090         ary[n - 1]->next = NULL;
1091         packed_git = ary[0];
1093         free(ary);
1096 static int prepare_packed_git_run_once = 0;
1097 void prepare_packed_git(void)
1099         struct alternate_object_database *alt;
1101         if (prepare_packed_git_run_once)
1102                 return;
1103         prepare_packed_git_one(get_object_directory(), 1);
1104         prepare_alt_odb();
1105         for (alt = alt_odb_list; alt; alt = alt->next) {
1106                 alt->name[-1] = 0;
1107                 prepare_packed_git_one(alt->base, 0);
1108                 alt->name[-1] = '/';
1109         }
1110         rearrange_packed_git();
1111         prepare_packed_git_run_once = 1;
1114 void reprepare_packed_git(void)
1116         discard_revindex();
1117         prepare_packed_git_run_once = 0;
1118         prepare_packed_git();
1121 static void mark_bad_packed_object(struct packed_git *p,
1122                                    const unsigned char *sha1)
1124         unsigned i;
1125         for (i = 0; i < p->num_bad_objects; i++)
1126                 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1127                         return;
1128         p->bad_object_sha1 = xrealloc(p->bad_object_sha1, 20 * (p->num_bad_objects + 1));
1129         hashcpy(p->bad_object_sha1 + 20 * p->num_bad_objects, sha1);
1130         p->num_bad_objects++;
1133 static const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1135         struct packed_git *p;
1136         unsigned i;
1138         for (p = packed_git; p; p = p->next)
1139                 for (i = 0; i < p->num_bad_objects; i++)
1140                         if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1141                                 return p;
1142         return NULL;
1145 int check_sha1_signature(const unsigned char *sha1, void *map, unsigned long size, const char *type)
1147         unsigned char real_sha1[20];
1148         hash_sha1_file(map, size, type, real_sha1);
1149         return hashcmp(sha1, real_sha1) ? -1 : 0;
1152 static int git_open_noatime(const char *name)
1154         static int sha1_file_open_flag = O_NOATIME;
1156         for (;;) {
1157                 int fd = open(name, O_RDONLY | sha1_file_open_flag);
1158                 if (fd >= 0)
1159                         return fd;
1161                 /* Might the failure be due to O_NOATIME? */
1162                 if (errno != ENOENT && sha1_file_open_flag) {
1163                         sha1_file_open_flag = 0;
1164                         continue;
1165                 }
1167                 return -1;
1168         }
1171 static int open_sha1_file(const unsigned char *sha1)
1173         int fd;
1174         char *name = sha1_file_name(sha1);
1175         struct alternate_object_database *alt;
1177         fd = git_open_noatime(name);
1178         if (fd >= 0)
1179                 return fd;
1181         prepare_alt_odb();
1182         errno = ENOENT;
1183         for (alt = alt_odb_list; alt; alt = alt->next) {
1184                 name = alt->name;
1185                 fill_sha1_path(name, sha1);
1186                 fd = git_open_noatime(alt->base);
1187                 if (fd >= 0)
1188                         return fd;
1189         }
1190         return -1;
1193 void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
1195         void *map;
1196         int fd;
1198         fd = open_sha1_file(sha1);
1199         map = NULL;
1200         if (fd >= 0) {
1201                 struct stat st;
1203                 if (!fstat(fd, &st)) {
1204                         *size = xsize_t(st.st_size);
1205                         if (!*size) {
1206                                 /* mmap() is forbidden on empty files */
1207                                 error("object file %s is empty", sha1_file_name(sha1));
1208                                 return NULL;
1209                         }
1210                         map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1211                 }
1212                 close(fd);
1213         }
1214         return map;
1217 /*
1218  * There used to be a second loose object header format which
1219  * was meant to mimic the in-pack format, allowing for direct
1220  * copy of the object data.  This format turned up not to be
1221  * really worth it and we no longer write loose objects in that
1222  * format.
1223  */
1224 static int experimental_loose_object(unsigned char *map)
1226         unsigned int word;
1228         /*
1229          * We must determine if the buffer contains the standard
1230          * zlib-deflated stream or the experimental format based
1231          * on the in-pack object format. Compare the header byte
1232          * for each format:
1233          *
1234          * RFC1950 zlib w/ deflate : 0www1000 : 0 <= www <= 7
1235          * Experimental pack-based : Stttssss : ttt = 1,2,3,4
1236          *
1237          * If bit 7 is clear and bits 0-3 equal 8, the buffer MUST be
1238          * in standard loose-object format, UNLESS it is a Git-pack
1239          * format object *exactly* 8 bytes in size when inflated.
1240          *
1241          * However, RFC1950 also specifies that the 1st 16-bit word
1242          * must be divisible by 31 - this checksum tells us our buffer
1243          * is in the standard format, giving a false positive only if
1244          * the 1st word of the Git-pack format object happens to be
1245          * divisible by 31, ie:
1246          *      ((byte0 * 256) + byte1) % 31 = 0
1247          *   =>        0ttt10000www1000 % 31 = 0
1248          *
1249          * As it happens, this case can only arise for www=3 & ttt=1
1250          * - ie, a Commit object, which would have to be 8 bytes in
1251          * size. As no Commit can be that small, we find that the
1252          * combination of these two criteria (bitmask & checksum)
1253          * can always correctly determine the buffer format.
1254          */
1255         word = (map[0] << 8) + map[1];
1256         if ((map[0] & 0x8F) == 0x08 && !(word % 31))
1257                 return 0;
1258         else
1259                 return 1;
1262 unsigned long unpack_object_header_buffer(const unsigned char *buf,
1263                 unsigned long len, enum object_type *type, unsigned long *sizep)
1265         unsigned shift;
1266         unsigned long size, c;
1267         unsigned long used = 0;
1269         c = buf[used++];
1270         *type = (c >> 4) & 7;
1271         size = c & 15;
1272         shift = 4;
1273         while (c & 0x80) {
1274                 if (len <= used || bitsizeof(long) <= shift) {
1275                         error("bad object header");
1276                         size = used = 0;
1277                         break;
1278                 }
1279                 c = buf[used++];
1280                 size += (c & 0x7f) << shift;
1281                 shift += 7;
1282         }
1283         *sizep = size;
1284         return used;
1287 int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz)
1289         unsigned long size, used;
1290         static const char valid_loose_object_type[8] = {
1291                 0, /* OBJ_EXT */
1292                 1, 1, 1, 1, /* "commit", "tree", "blob", "tag" */
1293                 0, /* "delta" and others are invalid in a loose object */
1294         };
1295         enum object_type type;
1297         /* Get the data stream */
1298         memset(stream, 0, sizeof(*stream));
1299         stream->next_in = map;
1300         stream->avail_in = mapsize;
1301         stream->next_out = buffer;
1302         stream->avail_out = bufsiz;
1304         if (experimental_loose_object(map)) {
1305                 /*
1306                  * The old experimental format we no longer produce;
1307                  * we can still read it.
1308                  */
1309                 used = unpack_object_header_buffer(map, mapsize, &type, &size);
1310                 if (!used || !valid_loose_object_type[type])
1311                         return -1;
1312                 map += used;
1313                 mapsize -= used;
1315                 /* Set up the stream for the rest.. */
1316                 stream->next_in = map;
1317                 stream->avail_in = mapsize;
1318                 git_inflate_init(stream);
1320                 /* And generate the fake traditional header */
1321                 stream->total_out = 1 + snprintf(buffer, bufsiz, "%s %lu",
1322                                                  typename(type), size);
1323                 return 0;
1324         }
1325         git_inflate_init(stream);
1326         return git_inflate(stream, 0);
1329 static void *unpack_sha1_rest(git_zstream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
1331         int bytes = strlen(buffer) + 1;
1332         unsigned char *buf = xmallocz(size);
1333         unsigned long n;
1334         int status = Z_OK;
1336         n = stream->total_out - bytes;
1337         if (n > size)
1338                 n = size;
1339         memcpy(buf, (char *) buffer + bytes, n);
1340         bytes = n;
1341         if (bytes <= size) {
1342                 /*
1343                  * The above condition must be (bytes <= size), not
1344                  * (bytes < size).  In other words, even though we
1345                  * expect no more output and set avail_out to zero,
1346                  * the input zlib stream may have bytes that express
1347                  * "this concludes the stream", and we *do* want to
1348                  * eat that input.
1349                  *
1350                  * Otherwise we would not be able to test that we
1351                  * consumed all the input to reach the expected size;
1352                  * we also want to check that zlib tells us that all
1353                  * went well with status == Z_STREAM_END at the end.
1354                  */
1355                 stream->next_out = buf + bytes;
1356                 stream->avail_out = size - bytes;
1357                 while (status == Z_OK)
1358                         status = git_inflate(stream, Z_FINISH);
1359         }
1360         if (status == Z_STREAM_END && !stream->avail_in) {
1361                 git_inflate_end(stream);
1362                 return buf;
1363         }
1365         if (status < 0)
1366                 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1367         else if (stream->avail_in)
1368                 error("garbage at end of loose object '%s'",
1369                       sha1_to_hex(sha1));
1370         free(buf);
1371         return NULL;
1374 /*
1375  * We used to just use "sscanf()", but that's actually way
1376  * too permissive for what we want to check. So do an anal
1377  * object header parse by hand.
1378  */
1379 int parse_sha1_header(const char *hdr, unsigned long *sizep)
1381         char type[10];
1382         int i;
1383         unsigned long size;
1385         /*
1386          * The type can be at most ten bytes (including the
1387          * terminating '\0' that we add), and is followed by
1388          * a space.
1389          */
1390         i = 0;
1391         for (;;) {
1392                 char c = *hdr++;
1393                 if (c == ' ')
1394                         break;
1395                 type[i++] = c;
1396                 if (i >= sizeof(type))
1397                         return -1;
1398         }
1399         type[i] = 0;
1401         /*
1402          * The length must follow immediately, and be in canonical
1403          * decimal format (ie "010" is not valid).
1404          */
1405         size = *hdr++ - '0';
1406         if (size > 9)
1407                 return -1;
1408         if (size) {
1409                 for (;;) {
1410                         unsigned long c = *hdr - '0';
1411                         if (c > 9)
1412                                 break;
1413                         hdr++;
1414                         size = size * 10 + c;
1415                 }
1416         }
1417         *sizep = size;
1419         /*
1420          * The length must be followed by a zero byte
1421          */
1422         return *hdr ? -1 : type_from_string(type);
1425 static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
1427         int ret;
1428         git_zstream stream;
1429         char hdr[8192];
1431         ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
1432         if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
1433                 return NULL;
1435         return unpack_sha1_rest(&stream, hdr, *size, sha1);
1438 unsigned long get_size_from_delta(struct packed_git *p,
1439                                   struct pack_window **w_curs,
1440                                   off_t curpos)
1442         const unsigned char *data;
1443         unsigned char delta_head[20], *in;
1444         git_zstream stream;
1445         int st;
1447         memset(&stream, 0, sizeof(stream));
1448         stream.next_out = delta_head;
1449         stream.avail_out = sizeof(delta_head);
1451         git_inflate_init(&stream);
1452         do {
1453                 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1454                 stream.next_in = in;
1455                 st = git_inflate(&stream, Z_FINISH);
1456                 curpos += stream.next_in - in;
1457         } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1458                  stream.total_out < sizeof(delta_head));
1459         git_inflate_end(&stream);
1460         if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
1461                 error("delta data unpack-initial failed");
1462                 return 0;
1463         }
1465         /* Examine the initial part of the delta to figure out
1466          * the result size.
1467          */
1468         data = delta_head;
1470         /* ignore base size */
1471         get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1473         /* Read the result size */
1474         return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1477 static off_t get_delta_base(struct packed_git *p,
1478                                     struct pack_window **w_curs,
1479                                     off_t *curpos,
1480                                     enum object_type type,
1481                                     off_t delta_obj_offset)
1483         unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1484         off_t base_offset;
1486         /* use_pack() assured us we have [base_info, base_info + 20)
1487          * as a range that we can look at without walking off the
1488          * end of the mapped window.  Its actually the hash size
1489          * that is assured.  An OFS_DELTA longer than the hash size
1490          * is stupid, as then a REF_DELTA would be smaller to store.
1491          */
1492         if (type == OBJ_OFS_DELTA) {
1493                 unsigned used = 0;
1494                 unsigned char c = base_info[used++];
1495                 base_offset = c & 127;
1496                 while (c & 128) {
1497                         base_offset += 1;
1498                         if (!base_offset || MSB(base_offset, 7))
1499                                 return 0;  /* overflow */
1500                         c = base_info[used++];
1501                         base_offset = (base_offset << 7) + (c & 127);
1502                 }
1503                 base_offset = delta_obj_offset - base_offset;
1504                 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1505                         return 0;  /* out of bound */
1506                 *curpos += used;
1507         } else if (type == OBJ_REF_DELTA) {
1508                 /* The base entry _must_ be in the same pack */
1509                 base_offset = find_pack_entry_one(base_info, p);
1510                 *curpos += 20;
1511         } else
1512                 die("I am totally screwed");
1513         return base_offset;
1516 /* forward declaration for a mutually recursive function */
1517 static int packed_object_info(struct packed_git *p, off_t offset,
1518                               unsigned long *sizep, int *rtype);
1520 static int packed_delta_info(struct packed_git *p,
1521                              struct pack_window **w_curs,
1522                              off_t curpos,
1523                              enum object_type type,
1524                              off_t obj_offset,
1525                              unsigned long *sizep)
1527         off_t base_offset;
1529         base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
1530         if (!base_offset)
1531                 return OBJ_BAD;
1532         type = packed_object_info(p, base_offset, NULL, NULL);
1533         if (type <= OBJ_NONE) {
1534                 struct revindex_entry *revidx;
1535                 const unsigned char *base_sha1;
1536                 revidx = find_pack_revindex(p, base_offset);
1537                 if (!revidx)
1538                         return OBJ_BAD;
1539                 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
1540                 mark_bad_packed_object(p, base_sha1);
1541                 type = sha1_object_info(base_sha1, NULL);
1542                 if (type <= OBJ_NONE)
1543                         return OBJ_BAD;
1544         }
1546         /* We choose to only get the type of the base object and
1547          * ignore potentially corrupt pack file that expects the delta
1548          * based on a base with a wrong size.  This saves tons of
1549          * inflate() calls.
1550          */
1551         if (sizep) {
1552                 *sizep = get_size_from_delta(p, w_curs, curpos);
1553                 if (*sizep == 0)
1554                         type = OBJ_BAD;
1555         }
1557         return type;
1560 int unpack_object_header(struct packed_git *p,
1561                          struct pack_window **w_curs,
1562                          off_t *curpos,
1563                          unsigned long *sizep)
1565         unsigned char *base;
1566         unsigned long left;
1567         unsigned long used;
1568         enum object_type type;
1570         /* use_pack() assures us we have [base, base + 20) available
1571          * as a range that we can look at.  (Its actually the hash
1572          * size that is assured.)  With our object header encoding
1573          * the maximum deflated object size is 2^137, which is just
1574          * insane, so we know won't exceed what we have been given.
1575          */
1576         base = use_pack(p, w_curs, *curpos, &left);
1577         used = unpack_object_header_buffer(base, left, &type, sizep);
1578         if (!used) {
1579                 type = OBJ_BAD;
1580         } else
1581                 *curpos += used;
1583         return type;
1586 static int packed_object_info(struct packed_git *p, off_t obj_offset,
1587                               unsigned long *sizep, int *rtype)
1589         struct pack_window *w_curs = NULL;
1590         unsigned long size;
1591         off_t curpos = obj_offset;
1592         enum object_type type;
1594         type = unpack_object_header(p, &w_curs, &curpos, &size);
1595         if (rtype)
1596                 *rtype = type; /* representation type */
1598         switch (type) {
1599         case OBJ_OFS_DELTA:
1600         case OBJ_REF_DELTA:
1601                 type = packed_delta_info(p, &w_curs, curpos,
1602                                          type, obj_offset, sizep);
1603                 break;
1604         case OBJ_COMMIT:
1605         case OBJ_TREE:
1606         case OBJ_BLOB:
1607         case OBJ_TAG:
1608                 if (sizep)
1609                         *sizep = size;
1610                 break;
1611         default:
1612                 error("unknown object type %i at offset %"PRIuMAX" in %s",
1613                       type, (uintmax_t)obj_offset, p->pack_name);
1614                 type = OBJ_BAD;
1615         }
1616         unuse_pack(&w_curs);
1617         return type;
1620 static void *unpack_compressed_entry(struct packed_git *p,
1621                                     struct pack_window **w_curs,
1622                                     off_t curpos,
1623                                     unsigned long size)
1625         int st;
1626         git_zstream stream;
1627         unsigned char *buffer, *in;
1629         buffer = xmallocz(size);
1630         memset(&stream, 0, sizeof(stream));
1631         stream.next_out = buffer;
1632         stream.avail_out = size + 1;
1634         git_inflate_init(&stream);
1635         do {
1636                 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1637                 stream.next_in = in;
1638                 st = git_inflate(&stream, Z_FINISH);
1639                 if (!stream.avail_out)
1640                         break; /* the payload is larger than it should be */
1641                 curpos += stream.next_in - in;
1642         } while (st == Z_OK || st == Z_BUF_ERROR);
1643         git_inflate_end(&stream);
1644         if ((st != Z_STREAM_END) || stream.total_out != size) {
1645                 free(buffer);
1646                 return NULL;
1647         }
1649         return buffer;
1652 #define MAX_DELTA_CACHE (256)
1654 static size_t delta_base_cached;
1656 static struct delta_base_cache_lru_list {
1657         struct delta_base_cache_lru_list *prev;
1658         struct delta_base_cache_lru_list *next;
1659 } delta_base_cache_lru = { &delta_base_cache_lru, &delta_base_cache_lru };
1661 static struct delta_base_cache_entry {
1662         struct delta_base_cache_lru_list lru;
1663         void *data;
1664         struct packed_git *p;
1665         off_t base_offset;
1666         unsigned long size;
1667         enum object_type type;
1668 } delta_base_cache[MAX_DELTA_CACHE];
1670 static unsigned long pack_entry_hash(struct packed_git *p, off_t base_offset)
1672         unsigned long hash;
1674         hash = (unsigned long)p + (unsigned long)base_offset;
1675         hash += (hash >> 8) + (hash >> 16);
1676         return hash % MAX_DELTA_CACHE;
1679 static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
1681         unsigned long hash = pack_entry_hash(p, base_offset);
1682         struct delta_base_cache_entry *ent = delta_base_cache + hash;
1683         return (ent->data && ent->p == p && ent->base_offset == base_offset);
1686 static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
1687         unsigned long *base_size, enum object_type *type, int keep_cache)
1689         void *ret;
1690         unsigned long hash = pack_entry_hash(p, base_offset);
1691         struct delta_base_cache_entry *ent = delta_base_cache + hash;
1693         ret = ent->data;
1694         if (!ret || ent->p != p || ent->base_offset != base_offset)
1695                 return unpack_entry(p, base_offset, type, base_size);
1697         if (!keep_cache) {
1698                 ent->data = NULL;
1699                 ent->lru.next->prev = ent->lru.prev;
1700                 ent->lru.prev->next = ent->lru.next;
1701                 delta_base_cached -= ent->size;
1702         } else {
1703                 ret = xmemdupz(ent->data, ent->size);
1704         }
1705         *type = ent->type;
1706         *base_size = ent->size;
1707         return ret;
1710 static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
1712         if (ent->data) {
1713                 free(ent->data);
1714                 ent->data = NULL;
1715                 ent->lru.next->prev = ent->lru.prev;
1716                 ent->lru.prev->next = ent->lru.next;
1717                 delta_base_cached -= ent->size;
1718         }
1721 void clear_delta_base_cache(void)
1723         unsigned long p;
1724         for (p = 0; p < MAX_DELTA_CACHE; p++)
1725                 release_delta_base_cache(&delta_base_cache[p]);
1728 static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
1729         void *base, unsigned long base_size, enum object_type type)
1731         unsigned long hash = pack_entry_hash(p, base_offset);
1732         struct delta_base_cache_entry *ent = delta_base_cache + hash;
1733         struct delta_base_cache_lru_list *lru;
1735         release_delta_base_cache(ent);
1736         delta_base_cached += base_size;
1738         for (lru = delta_base_cache_lru.next;
1739              delta_base_cached > delta_base_cache_limit
1740              && lru != &delta_base_cache_lru;
1741              lru = lru->next) {
1742                 struct delta_base_cache_entry *f = (void *)lru;
1743                 if (f->type == OBJ_BLOB)
1744                         release_delta_base_cache(f);
1745         }
1746         for (lru = delta_base_cache_lru.next;
1747              delta_base_cached > delta_base_cache_limit
1748              && lru != &delta_base_cache_lru;
1749              lru = lru->next) {
1750                 struct delta_base_cache_entry *f = (void *)lru;
1751                 release_delta_base_cache(f);
1752         }
1754         ent->p = p;
1755         ent->base_offset = base_offset;
1756         ent->type = type;
1757         ent->data = base;
1758         ent->size = base_size;
1759         ent->lru.next = &delta_base_cache_lru;
1760         ent->lru.prev = delta_base_cache_lru.prev;
1761         delta_base_cache_lru.prev->next = &ent->lru;
1762         delta_base_cache_lru.prev = &ent->lru;
1765 static void *read_object(const unsigned char *sha1, enum object_type *type,
1766                          unsigned long *size);
1768 static void *unpack_delta_entry(struct packed_git *p,
1769                                 struct pack_window **w_curs,
1770                                 off_t curpos,
1771                                 unsigned long delta_size,
1772                                 off_t obj_offset,
1773                                 enum object_type *type,
1774                                 unsigned long *sizep)
1776         void *delta_data, *result, *base;
1777         unsigned long base_size;
1778         off_t base_offset;
1780         base_offset = get_delta_base(p, w_curs, &curpos, *type, obj_offset);
1781         if (!base_offset) {
1782                 error("failed to validate delta base reference "
1783                       "at offset %"PRIuMAX" from %s",
1784                       (uintmax_t)curpos, p->pack_name);
1785                 return NULL;
1786         }
1787         unuse_pack(w_curs);
1788         base = cache_or_unpack_entry(p, base_offset, &base_size, type, 0);
1789         if (!base) {
1790                 /*
1791                  * We're probably in deep shit, but let's try to fetch
1792                  * the required base anyway from another pack or loose.
1793                  * This is costly but should happen only in the presence
1794                  * of a corrupted pack, and is better than failing outright.
1795                  */
1796                 struct revindex_entry *revidx;
1797                 const unsigned char *base_sha1;
1798                 revidx = find_pack_revindex(p, base_offset);
1799                 if (!revidx)
1800                         return NULL;
1801                 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
1802                 error("failed to read delta base object %s"
1803                       " at offset %"PRIuMAX" from %s",
1804                       sha1_to_hex(base_sha1), (uintmax_t)base_offset,
1805                       p->pack_name);
1806                 mark_bad_packed_object(p, base_sha1);
1807                 base = read_object(base_sha1, type, &base_size);
1808                 if (!base)
1809                         return NULL;
1810         }
1812         delta_data = unpack_compressed_entry(p, w_curs, curpos, delta_size);
1813         if (!delta_data) {
1814                 error("failed to unpack compressed delta "
1815                       "at offset %"PRIuMAX" from %s",
1816                       (uintmax_t)curpos, p->pack_name);
1817                 free(base);
1818                 return NULL;
1819         }
1820         result = patch_delta(base, base_size,
1821                              delta_data, delta_size,
1822                              sizep);
1823         if (!result)
1824                 die("failed to apply delta");
1825         free(delta_data);
1826         add_delta_base_cache(p, base_offset, base, base_size, *type);
1827         return result;
1830 static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
1832         static FILE *log_file;
1834         if (!log_file) {
1835                 log_file = fopen(log_pack_access, "w");
1836                 if (!log_file) {
1837                         error("cannot open pack access log '%s' for writing: %s",
1838                               log_pack_access, strerror(errno));
1839                         log_pack_access = NULL;
1840                         return;
1841                 }
1842         }
1843         fprintf(log_file, "%s %"PRIuMAX"\n",
1844                 p->pack_name, (uintmax_t)obj_offset);
1845         fflush(log_file);
1848 int do_check_packed_object_crc;
1850 void *unpack_entry(struct packed_git *p, off_t obj_offset,
1851                    enum object_type *type, unsigned long *sizep)
1853         struct pack_window *w_curs = NULL;
1854         off_t curpos = obj_offset;
1855         void *data;
1857         if (log_pack_access)
1858                 write_pack_access_log(p, obj_offset);
1860         if (do_check_packed_object_crc && p->index_version > 1) {
1861                 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
1862                 unsigned long len = revidx[1].offset - obj_offset;
1863                 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
1864                         const unsigned char *sha1 =
1865                                 nth_packed_object_sha1(p, revidx->nr);
1866                         error("bad packed object CRC for %s",
1867                               sha1_to_hex(sha1));
1868                         mark_bad_packed_object(p, sha1);
1869                         unuse_pack(&w_curs);
1870                         return NULL;
1871                 }
1872         }
1874         *type = unpack_object_header(p, &w_curs, &curpos, sizep);
1875         switch (*type) {
1876         case OBJ_OFS_DELTA:
1877         case OBJ_REF_DELTA:
1878                 data = unpack_delta_entry(p, &w_curs, curpos, *sizep,
1879                                           obj_offset, type, sizep);
1880                 break;
1881         case OBJ_COMMIT:
1882         case OBJ_TREE:
1883         case OBJ_BLOB:
1884         case OBJ_TAG:
1885                 data = unpack_compressed_entry(p, &w_curs, curpos, *sizep);
1886                 break;
1887         default:
1888                 data = NULL;
1889                 error("unknown object type %i at offset %"PRIuMAX" in %s",
1890                       *type, (uintmax_t)obj_offset, p->pack_name);
1891         }
1892         unuse_pack(&w_curs);
1893         return data;
1896 const unsigned char *nth_packed_object_sha1(struct packed_git *p,
1897                                             uint32_t n)
1899         const unsigned char *index = p->index_data;
1900         if (!index) {
1901                 if (open_pack_index(p))
1902                         return NULL;
1903                 index = p->index_data;
1904         }
1905         if (n >= p->num_objects)
1906                 return NULL;
1907         index += 4 * 256;
1908         if (p->index_version == 1) {
1909                 return index + 24 * n + 4;
1910         } else {
1911                 index += 8;
1912                 return index + 20 * n;
1913         }
1916 off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
1918         const unsigned char *index = p->index_data;
1919         index += 4 * 256;
1920         if (p->index_version == 1) {
1921                 return ntohl(*((uint32_t *)(index + 24 * n)));
1922         } else {
1923                 uint32_t off;
1924                 index += 8 + p->num_objects * (20 + 4);
1925                 off = ntohl(*((uint32_t *)(index + 4 * n)));
1926                 if (!(off & 0x80000000))
1927                         return off;
1928                 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
1929                 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
1930                                    ntohl(*((uint32_t *)(index + 4)));
1931         }
1934 off_t find_pack_entry_one(const unsigned char *sha1,
1935                                   struct packed_git *p)
1937         const uint32_t *level1_ofs = p->index_data;
1938         const unsigned char *index = p->index_data;
1939         unsigned hi, lo, stride;
1940         static int use_lookup = -1;
1941         static int debug_lookup = -1;
1943         if (debug_lookup < 0)
1944                 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
1946         if (!index) {
1947                 if (open_pack_index(p))
1948                         return 0;
1949                 level1_ofs = p->index_data;
1950                 index = p->index_data;
1951         }
1952         if (p->index_version > 1) {
1953                 level1_ofs += 2;
1954                 index += 8;
1955         }
1956         index += 4 * 256;
1957         hi = ntohl(level1_ofs[*sha1]);
1958         lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
1959         if (p->index_version > 1) {
1960                 stride = 20;
1961         } else {
1962                 stride = 24;
1963                 index += 4;
1964         }
1966         if (debug_lookup)
1967                 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
1968                        sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
1970         if (use_lookup < 0)
1971                 use_lookup = !!getenv("GIT_USE_LOOKUP");
1972         if (use_lookup) {
1973                 int pos = sha1_entry_pos(index, stride, 0,
1974                                          lo, hi, p->num_objects, sha1);
1975                 if (pos < 0)
1976                         return 0;
1977                 return nth_packed_object_offset(p, pos);
1978         }
1980         do {
1981                 unsigned mi = (lo + hi) / 2;
1982                 int cmp = hashcmp(index + mi * stride, sha1);
1984                 if (debug_lookup)
1985                         printf("lo %u hi %u rg %u mi %u\n",
1986                                lo, hi, hi - lo, mi);
1987                 if (!cmp)
1988                         return nth_packed_object_offset(p, mi);
1989                 if (cmp > 0)
1990                         hi = mi;
1991                 else
1992                         lo = mi+1;
1993         } while (lo < hi);
1994         return 0;
1997 int is_pack_valid(struct packed_git *p)
1999         /* An already open pack is known to be valid. */
2000         if (p->pack_fd != -1)
2001                 return 1;
2003         /* If the pack has one window completely covering the
2004          * file size, the pack is known to be valid even if
2005          * the descriptor is not currently open.
2006          */
2007         if (p->windows) {
2008                 struct pack_window *w = p->windows;
2010                 if (!w->offset && w->len == p->pack_size)
2011                         return 1;
2012         }
2014         /* Force the pack to open to prove its valid. */
2015         return !open_packed_git(p);
2018 static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
2020         static struct packed_git *last_found = (void *)1;
2021         struct packed_git *p;
2022         off_t offset;
2024         prepare_packed_git();
2025         if (!packed_git)
2026                 return 0;
2027         p = (last_found == (void *)1) ? packed_git : last_found;
2029         do {
2030                 if (p->num_bad_objects) {
2031                         unsigned i;
2032                         for (i = 0; i < p->num_bad_objects; i++)
2033                                 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
2034                                         goto next;
2035                 }
2037                 offset = find_pack_entry_one(sha1, p);
2038                 if (offset) {
2039                         /*
2040                          * We are about to tell the caller where they can
2041                          * locate the requested object.  We better make
2042                          * sure the packfile is still here and can be
2043                          * accessed before supplying that answer, as
2044                          * it may have been deleted since the index
2045                          * was loaded!
2046                          */
2047                         if (!is_pack_valid(p)) {
2048                                 warning("packfile %s cannot be accessed", p->pack_name);
2049                                 goto next;
2050                         }
2051                         e->offset = offset;
2052                         e->p = p;
2053                         hashcpy(e->sha1, sha1);
2054                         last_found = p;
2055                         return 1;
2056                 }
2058                 next:
2059                 if (p == last_found)
2060                         p = packed_git;
2061                 else
2062                         p = p->next;
2063                 if (p == last_found)
2064                         p = p->next;
2065         } while (p);
2066         return 0;
2069 struct packed_git *find_sha1_pack(const unsigned char *sha1,
2070                                   struct packed_git *packs)
2072         struct packed_git *p;
2074         for (p = packs; p; p = p->next) {
2075                 if (find_pack_entry_one(sha1, p))
2076                         return p;
2077         }
2078         return NULL;
2082 static int sha1_loose_object_info(const unsigned char *sha1, unsigned long *sizep)
2084         int status;
2085         unsigned long mapsize, size;
2086         void *map;
2087         git_zstream stream;
2088         char hdr[32];
2090         map = map_sha1_file(sha1, &mapsize);
2091         if (!map)
2092                 return error("unable to find %s", sha1_to_hex(sha1));
2093         if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
2094                 status = error("unable to unpack %s header",
2095                                sha1_to_hex(sha1));
2096         else if ((status = parse_sha1_header(hdr, &size)) < 0)
2097                 status = error("unable to parse %s header", sha1_to_hex(sha1));
2098         else if (sizep)
2099                 *sizep = size;
2100         git_inflate_end(&stream);
2101         munmap(map, mapsize);
2102         return status;
2105 /* returns enum object_type or negative */
2106 int sha1_object_info_extended(const unsigned char *sha1, struct object_info *oi)
2108         struct cached_object *co;
2109         struct pack_entry e;
2110         int status, rtype;
2112         co = find_cached_object(sha1);
2113         if (co) {
2114                 if (oi->sizep)
2115                         *(oi->sizep) = co->size;
2116                 oi->whence = OI_CACHED;
2117                 return co->type;
2118         }
2120         if (!find_pack_entry(sha1, &e)) {
2121                 /* Most likely it's a loose object. */
2122                 status = sha1_loose_object_info(sha1, oi->sizep);
2123                 if (status >= 0) {
2124                         oi->whence = OI_LOOSE;
2125                         return status;
2126                 }
2128                 /* Not a loose object; someone else may have just packed it. */
2129                 reprepare_packed_git();
2130                 if (!find_pack_entry(sha1, &e))
2131                         return status;
2132         }
2134         status = packed_object_info(e.p, e.offset, oi->sizep, &rtype);
2135         if (status < 0) {
2136                 mark_bad_packed_object(e.p, sha1);
2137                 status = sha1_object_info_extended(sha1, oi);
2138         } else if (in_delta_base_cache(e.p, e.offset)) {
2139                 oi->whence = OI_DBCACHED;
2140         } else {
2141                 oi->whence = OI_PACKED;
2142                 oi->u.packed.offset = e.offset;
2143                 oi->u.packed.pack = e.p;
2144                 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
2145                                          rtype == OBJ_OFS_DELTA);
2146         }
2148         return status;
2151 int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
2153         struct object_info oi;
2155         oi.sizep = sizep;
2156         return sha1_object_info_extended(sha1, &oi);
2159 static void *read_packed_sha1(const unsigned char *sha1,
2160                               enum object_type *type, unsigned long *size)
2162         struct pack_entry e;
2163         void *data;
2165         if (!find_pack_entry(sha1, &e))
2166                 return NULL;
2167         data = cache_or_unpack_entry(e.p, e.offset, size, type, 1);
2168         if (!data) {
2169                 /*
2170                  * We're probably in deep shit, but let's try to fetch
2171                  * the required object anyway from another pack or loose.
2172                  * This should happen only in the presence of a corrupted
2173                  * pack, and is better than failing outright.
2174                  */
2175                 error("failed to read object %s at offset %"PRIuMAX" from %s",
2176                       sha1_to_hex(sha1), (uintmax_t)e.offset, e.p->pack_name);
2177                 mark_bad_packed_object(e.p, sha1);
2178                 data = read_object(sha1, type, size);
2179         }
2180         return data;
2183 int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
2184                       unsigned char *sha1)
2186         struct cached_object *co;
2188         hash_sha1_file(buf, len, typename(type), sha1);
2189         if (has_sha1_file(sha1) || find_cached_object(sha1))
2190                 return 0;
2191         if (cached_object_alloc <= cached_object_nr) {
2192                 cached_object_alloc = alloc_nr(cached_object_alloc);
2193                 cached_objects = xrealloc(cached_objects,
2194                                           sizeof(*cached_objects) *
2195                                           cached_object_alloc);
2196         }
2197         co = &cached_objects[cached_object_nr++];
2198         co->size = len;
2199         co->type = type;
2200         co->buf = xmalloc(len);
2201         memcpy(co->buf, buf, len);
2202         hashcpy(co->sha1, sha1);
2203         return 0;
2206 static void *read_object(const unsigned char *sha1, enum object_type *type,
2207                          unsigned long *size)
2209         unsigned long mapsize;
2210         void *map, *buf;
2211         struct cached_object *co;
2213         co = find_cached_object(sha1);
2214         if (co) {
2215                 *type = co->type;
2216                 *size = co->size;
2217                 return xmemdupz(co->buf, co->size);
2218         }
2220         buf = read_packed_sha1(sha1, type, size);
2221         if (buf)
2222                 return buf;
2223         map = map_sha1_file(sha1, &mapsize);
2224         if (map) {
2225                 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
2226                 munmap(map, mapsize);
2227                 return buf;
2228         }
2229         reprepare_packed_git();
2230         return read_packed_sha1(sha1, type, size);
2233 /*
2234  * This function dies on corrupt objects; the callers who want to
2235  * deal with them should arrange to call read_object() and give error
2236  * messages themselves.
2237  */
2238 void *read_sha1_file_extended(const unsigned char *sha1,
2239                               enum object_type *type,
2240                               unsigned long *size,
2241                               unsigned flag)
2243         void *data;
2244         char *path;
2245         const struct packed_git *p;
2246         const unsigned char *repl = (flag & READ_SHA1_FILE_REPLACE)
2247                 ? lookup_replace_object(sha1) : sha1;
2249         errno = 0;
2250         data = read_object(repl, type, size);
2251         if (data)
2252                 return data;
2254         if (errno && errno != ENOENT)
2255                 die_errno("failed to read object %s", sha1_to_hex(sha1));
2257         /* die if we replaced an object with one that does not exist */
2258         if (repl != sha1)
2259                 die("replacement %s not found for %s",
2260                     sha1_to_hex(repl), sha1_to_hex(sha1));
2262         if (has_loose_object(repl)) {
2263                 path = sha1_file_name(sha1);
2264                 die("loose object %s (stored in %s) is corrupt",
2265                     sha1_to_hex(repl), path);
2266         }
2268         if ((p = has_packed_and_bad(repl)) != NULL)
2269                 die("packed object %s (stored in %s) is corrupt",
2270                     sha1_to_hex(repl), p->pack_name);
2272         return NULL;
2275 void *read_object_with_reference(const unsigned char *sha1,
2276                                  const char *required_type_name,
2277                                  unsigned long *size,
2278                                  unsigned char *actual_sha1_return)
2280         enum object_type type, required_type;
2281         void *buffer;
2282         unsigned long isize;
2283         unsigned char actual_sha1[20];
2285         required_type = type_from_string(required_type_name);
2286         hashcpy(actual_sha1, sha1);
2287         while (1) {
2288                 int ref_length = -1;
2289                 const char *ref_type = NULL;
2291                 buffer = read_sha1_file(actual_sha1, &type, &isize);
2292                 if (!buffer)
2293                         return NULL;
2294                 if (type == required_type) {
2295                         *size = isize;
2296                         if (actual_sha1_return)
2297                                 hashcpy(actual_sha1_return, actual_sha1);
2298                         return buffer;
2299                 }
2300                 /* Handle references */
2301                 else if (type == OBJ_COMMIT)
2302                         ref_type = "tree ";
2303                 else if (type == OBJ_TAG)
2304                         ref_type = "object ";
2305                 else {
2306                         free(buffer);
2307                         return NULL;
2308                 }
2309                 ref_length = strlen(ref_type);
2311                 if (ref_length + 40 > isize ||
2312                     memcmp(buffer, ref_type, ref_length) ||
2313                     get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
2314                         free(buffer);
2315                         return NULL;
2316                 }
2317                 free(buffer);
2318                 /* Now we have the ID of the referred-to object in
2319                  * actual_sha1.  Check again. */
2320         }
2323 static void write_sha1_file_prepare(const void *buf, unsigned long len,
2324                                     const char *type, unsigned char *sha1,
2325                                     char *hdr, int *hdrlen)
2327         git_SHA_CTX c;
2329         /* Generate the header */
2330         *hdrlen = sprintf(hdr, "%s %lu", type, len)+1;
2332         /* Sha1.. */
2333         git_SHA1_Init(&c);
2334         git_SHA1_Update(&c, hdr, *hdrlen);
2335         git_SHA1_Update(&c, buf, len);
2336         git_SHA1_Final(sha1, &c);
2339 /*
2340  * Move the just written object into its final resting place.
2341  * NEEDSWORK: this should be renamed to finalize_temp_file() as
2342  * "moving" is only a part of what it does, when no patch between
2343  * master to pu changes the call sites of this function.
2344  */
2345 int move_temp_to_file(const char *tmpfile, const char *filename)
2347         int ret = 0;
2349         if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
2350                 goto try_rename;
2351         else if (link(tmpfile, filename))
2352                 ret = errno;
2354         /*
2355          * Coda hack - coda doesn't like cross-directory links,
2356          * so we fall back to a rename, which will mean that it
2357          * won't be able to check collisions, but that's not a
2358          * big deal.
2359          *
2360          * The same holds for FAT formatted media.
2361          *
2362          * When this succeeds, we just return.  We have nothing
2363          * left to unlink.
2364          */
2365         if (ret && ret != EEXIST) {
2366         try_rename:
2367                 if (!rename(tmpfile, filename))
2368                         goto out;
2369                 ret = errno;
2370         }
2371         unlink_or_warn(tmpfile);
2372         if (ret) {
2373                 if (ret != EEXIST) {
2374                         return error("unable to write sha1 filename %s: %s\n", filename, strerror(ret));
2375                 }
2376                 /* FIXME!!! Collision check here ? */
2377         }
2379 out:
2380         if (adjust_shared_perm(filename))
2381                 return error("unable to set permission to '%s'", filename);
2382         return 0;
2385 static int write_buffer(int fd, const void *buf, size_t len)
2387         if (write_in_full(fd, buf, len) < 0)
2388                 return error("file write error (%s)", strerror(errno));
2389         return 0;
2392 int hash_sha1_file(const void *buf, unsigned long len, const char *type,
2393                    unsigned char *sha1)
2395         char hdr[32];
2396         int hdrlen;
2397         write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2398         return 0;
2401 /* Finalize a file on disk, and close it. */
2402 static void close_sha1_file(int fd)
2404         if (fsync_object_files)
2405                 fsync_or_die(fd, "sha1 file");
2406         if (close(fd) != 0)
2407                 die_errno("error when closing sha1 file");
2410 /* Size of directory component, including the ending '/' */
2411 static inline int directory_size(const char *filename)
2413         const char *s = strrchr(filename, '/');
2414         if (!s)
2415                 return 0;
2416         return s - filename + 1;
2419 /*
2420  * This creates a temporary file in the same directory as the final
2421  * 'filename'
2422  *
2423  * We want to avoid cross-directory filename renames, because those
2424  * can have problems on various filesystems (FAT, NFS, Coda).
2425  */
2426 static int create_tmpfile(char *buffer, size_t bufsiz, const char *filename)
2428         int fd, dirlen = directory_size(filename);
2430         if (dirlen + 20 > bufsiz) {
2431                 errno = ENAMETOOLONG;
2432                 return -1;
2433         }
2434         memcpy(buffer, filename, dirlen);
2435         strcpy(buffer + dirlen, "tmp_obj_XXXXXX");
2436         fd = git_mkstemp_mode(buffer, 0444);
2437         if (fd < 0 && dirlen && errno == ENOENT) {
2438                 /* Make sure the directory exists */
2439                 memcpy(buffer, filename, dirlen);
2440                 buffer[dirlen-1] = 0;
2441                 if (mkdir(buffer, 0777) || adjust_shared_perm(buffer))
2442                         return -1;
2444                 /* Try again */
2445                 strcpy(buffer + dirlen - 1, "/tmp_obj_XXXXXX");
2446                 fd = git_mkstemp_mode(buffer, 0444);
2447         }
2448         return fd;
2451 static int write_loose_object(const unsigned char *sha1, char *hdr, int hdrlen,
2452                               const void *buf, unsigned long len, time_t mtime)
2454         int fd, ret;
2455         unsigned char compressed[4096];
2456         git_zstream stream;
2457         git_SHA_CTX c;
2458         unsigned char parano_sha1[20];
2459         char *filename;
2460         static char tmp_file[PATH_MAX];
2462         filename = sha1_file_name(sha1);
2463         fd = create_tmpfile(tmp_file, sizeof(tmp_file), filename);
2464         if (fd < 0) {
2465                 if (errno == EACCES)
2466                         return error("insufficient permission for adding an object to repository database %s\n", get_object_directory());
2467                 else
2468                         return error("unable to create temporary sha1 filename %s: %s\n", tmp_file, strerror(errno));
2469         }
2471         /* Set it up */
2472         memset(&stream, 0, sizeof(stream));
2473         git_deflate_init(&stream, zlib_compression_level);
2474         stream.next_out = compressed;
2475         stream.avail_out = sizeof(compressed);
2476         git_SHA1_Init(&c);
2478         /* First header.. */
2479         stream.next_in = (unsigned char *)hdr;
2480         stream.avail_in = hdrlen;
2481         while (git_deflate(&stream, 0) == Z_OK)
2482                 ; /* nothing */
2483         git_SHA1_Update(&c, hdr, hdrlen);
2485         /* Then the data itself.. */
2486         stream.next_in = (void *)buf;
2487         stream.avail_in = len;
2488         do {
2489                 unsigned char *in0 = stream.next_in;
2490                 ret = git_deflate(&stream, Z_FINISH);
2491                 git_SHA1_Update(&c, in0, stream.next_in - in0);
2492                 if (write_buffer(fd, compressed, stream.next_out - compressed) < 0)
2493                         die("unable to write sha1 file");
2494                 stream.next_out = compressed;
2495                 stream.avail_out = sizeof(compressed);
2496         } while (ret == Z_OK);
2498         if (ret != Z_STREAM_END)
2499                 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
2500         ret = git_deflate_end_gently(&stream);
2501         if (ret != Z_OK)
2502                 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
2503         git_SHA1_Final(parano_sha1, &c);
2504         if (hashcmp(sha1, parano_sha1) != 0)
2505                 die("confused by unstable object source data for %s", sha1_to_hex(sha1));
2507         close_sha1_file(fd);
2509         if (mtime) {
2510                 struct utimbuf utb;
2511                 utb.actime = mtime;
2512                 utb.modtime = mtime;
2513                 if (utime(tmp_file, &utb) < 0)
2514                         warning("failed utime() on %s: %s",
2515                                 tmp_file, strerror(errno));
2516         }
2518         return move_temp_to_file(tmp_file, filename);
2521 int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *returnsha1)
2523         unsigned char sha1[20];
2524         char hdr[32];
2525         int hdrlen;
2527         /* Normally if we have it in the pack then we do not bother writing
2528          * it out into .git/objects/??/?{38} file.
2529          */
2530         write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2531         if (returnsha1)
2532                 hashcpy(returnsha1, sha1);
2533         if (has_sha1_file(sha1))
2534                 return 0;
2535         return write_loose_object(sha1, hdr, hdrlen, buf, len, 0);
2538 int force_object_loose(const unsigned char *sha1, time_t mtime)
2540         void *buf;
2541         unsigned long len;
2542         enum object_type type;
2543         char hdr[32];
2544         int hdrlen;
2545         int ret;
2547         if (has_loose_object(sha1))
2548                 return 0;
2549         buf = read_packed_sha1(sha1, &type, &len);
2550         if (!buf)
2551                 return error("cannot read sha1_file for %s", sha1_to_hex(sha1));
2552         hdrlen = sprintf(hdr, "%s %lu", typename(type), len) + 1;
2553         ret = write_loose_object(sha1, hdr, hdrlen, buf, len, mtime);
2554         free(buf);
2556         return ret;
2559 int has_pack_index(const unsigned char *sha1)
2561         struct stat st;
2562         if (stat(sha1_pack_index_name(sha1), &st))
2563                 return 0;
2564         return 1;
2567 int has_sha1_pack(const unsigned char *sha1)
2569         struct pack_entry e;
2570         return find_pack_entry(sha1, &e);
2573 int has_sha1_file(const unsigned char *sha1)
2575         struct pack_entry e;
2577         if (find_pack_entry(sha1, &e))
2578                 return 1;
2579         return has_loose_object(sha1);
2582 static void check_tree(const void *buf, size_t size)
2584         struct tree_desc desc;
2585         struct name_entry entry;
2587         init_tree_desc(&desc, buf, size);
2588         while (tree_entry(&desc, &entry))
2589                 /* do nothing
2590                  * tree_entry() will die() on malformed entries */
2591                 ;
2594 static void check_commit(const void *buf, size_t size)
2596         struct commit c;
2597         memset(&c, 0, sizeof(c));
2598         if (parse_commit_buffer(&c, buf, size))
2599                 die("corrupt commit");
2602 static void check_tag(const void *buf, size_t size)
2604         struct tag t;
2605         memset(&t, 0, sizeof(t));
2606         if (parse_tag_buffer(&t, buf, size))
2607                 die("corrupt tag");
2610 static int index_mem(unsigned char *sha1, void *buf, size_t size,
2611                      enum object_type type,
2612                      const char *path, unsigned flags)
2614         int ret, re_allocated = 0;
2615         int write_object = flags & HASH_WRITE_OBJECT;
2617         if (!type)
2618                 type = OBJ_BLOB;
2620         /*
2621          * Convert blobs to git internal format
2622          */
2623         if ((type == OBJ_BLOB) && path) {
2624                 struct strbuf nbuf = STRBUF_INIT;
2625                 if (convert_to_git(path, buf, size, &nbuf,
2626                                    write_object ? safe_crlf : SAFE_CRLF_FALSE)) {
2627                         buf = strbuf_detach(&nbuf, &size);
2628                         re_allocated = 1;
2629                 }
2630         }
2631         if (flags & HASH_FORMAT_CHECK) {
2632                 if (type == OBJ_TREE)
2633                         check_tree(buf, size);
2634                 if (type == OBJ_COMMIT)
2635                         check_commit(buf, size);
2636                 if (type == OBJ_TAG)
2637                         check_tag(buf, size);
2638         }
2640         if (write_object)
2641                 ret = write_sha1_file(buf, size, typename(type), sha1);
2642         else
2643                 ret = hash_sha1_file(buf, size, typename(type), sha1);
2644         if (re_allocated)
2645                 free(buf);
2646         return ret;
2649 static int index_pipe(unsigned char *sha1, int fd, enum object_type type,
2650                       const char *path, unsigned flags)
2652         struct strbuf sbuf = STRBUF_INIT;
2653         int ret;
2655         if (strbuf_read(&sbuf, fd, 4096) >= 0)
2656                 ret = index_mem(sha1, sbuf.buf, sbuf.len, type, path, flags);
2657         else
2658                 ret = -1;
2659         strbuf_release(&sbuf);
2660         return ret;
2663 #define SMALL_FILE_SIZE (32*1024)
2665 static int index_core(unsigned char *sha1, int fd, size_t size,
2666                       enum object_type type, const char *path,
2667                       unsigned flags)
2669         int ret;
2671         if (!size) {
2672                 ret = index_mem(sha1, NULL, size, type, path, flags);
2673         } else if (size <= SMALL_FILE_SIZE) {
2674                 char *buf = xmalloc(size);
2675                 if (size == read_in_full(fd, buf, size))
2676                         ret = index_mem(sha1, buf, size, type, path, flags);
2677                 else
2678                         ret = error("short read %s", strerror(errno));
2679                 free(buf);
2680         } else {
2681                 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
2682                 ret = index_mem(sha1, buf, size, type, path, flags);
2683                 munmap(buf, size);
2684         }
2685         return ret;
2688 /*
2689  * This creates one packfile per large blob unless bulk-checkin
2690  * machinery is "plugged".
2691  *
2692  * This also bypasses the usual "convert-to-git" dance, and that is on
2693  * purpose. We could write a streaming version of the converting
2694  * functions and insert that before feeding the data to fast-import
2695  * (or equivalent in-core API described above), but the primary
2696  * motivation for trying to stream from the working tree file and to
2697  * avoid mmaping it in core is to deal with large binary blobs, and
2698  * by definition they do _not_ want to get any conversion.
2699  */
2700 static int index_stream(unsigned char *sha1, int fd, size_t size,
2701                         enum object_type type, const char *path,
2702                         unsigned flags)
2704         return index_bulk_checkin(sha1, fd, size, type, path, flags);
2707 int index_fd(unsigned char *sha1, int fd, struct stat *st,
2708              enum object_type type, const char *path, unsigned flags)
2710         int ret;
2711         size_t size = xsize_t(st->st_size);
2713         if (!S_ISREG(st->st_mode))
2714                 ret = index_pipe(sha1, fd, type, path, flags);
2715         else if (size <= big_file_threshold || type != OBJ_BLOB)
2716                 ret = index_core(sha1, fd, size, type, path, flags);
2717         else
2718                 ret = index_stream(sha1, fd, size, type, path, flags);
2719         close(fd);
2720         return ret;
2723 int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags)
2725         int fd;
2726         struct strbuf sb = STRBUF_INIT;
2728         switch (st->st_mode & S_IFMT) {
2729         case S_IFREG:
2730                 fd = open(path, O_RDONLY);
2731                 if (fd < 0)
2732                         return error("open(\"%s\"): %s", path,
2733                                      strerror(errno));
2734                 if (index_fd(sha1, fd, st, OBJ_BLOB, path, flags) < 0)
2735                         return error("%s: failed to insert into database",
2736                                      path);
2737                 break;
2738         case S_IFLNK:
2739                 if (strbuf_readlink(&sb, path, st->st_size)) {
2740                         char *errstr = strerror(errno);
2741                         return error("readlink(\"%s\"): %s", path,
2742                                      errstr);
2743                 }
2744                 if (!(flags & HASH_WRITE_OBJECT))
2745                         hash_sha1_file(sb.buf, sb.len, blob_type, sha1);
2746                 else if (write_sha1_file(sb.buf, sb.len, blob_type, sha1))
2747                         return error("%s: failed to insert into database",
2748                                      path);
2749                 strbuf_release(&sb);
2750                 break;
2751         case S_IFDIR:
2752                 return resolve_gitlink_ref(path, "HEAD", sha1);
2753         default:
2754                 return error("%s: unsupported file type", path);
2755         }
2756         return 0;
2759 int read_pack_header(int fd, struct pack_header *header)
2761         if (read_in_full(fd, header, sizeof(*header)) < sizeof(*header))
2762                 /* "eof before pack header was fully read" */
2763                 return PH_ERROR_EOF;
2765         if (header->hdr_signature != htonl(PACK_SIGNATURE))
2766                 /* "protocol error (pack signature mismatch detected)" */
2767                 return PH_ERROR_PACK_SIGNATURE;
2768         if (!pack_version_ok(header->hdr_version))
2769                 /* "protocol error (pack version unsupported)" */
2770                 return PH_ERROR_PROTOCOL;
2771         return 0;
2774 void assert_sha1_type(const unsigned char *sha1, enum object_type expect)
2776         enum object_type type = sha1_object_info(sha1, NULL);
2777         if (type < 0)
2778                 die("%s is not a valid object", sha1_to_hex(sha1));
2779         if (type != expect)
2780                 die("%s is not a valid '%s' object", sha1_to_hex(sha1),
2781                     typename(expect));