]> git.ipfire.org Git - thirdparty/git.git/blame - packfile.c
object-store: move packed_git and packed_git_mru to object store
[thirdparty/git.git] / packfile.c
CommitLineData
4f39cd82 1#include "cache.h"
ec2dd32c 2#include "list.h"
0317f455 3#include "pack.h"
031dc927 4#include "repository.h"
0abe14f6
JT
5#include "dir.h"
6#include "mergesort.h"
7#include "packfile.h"
7b3aa75d 8#include "delta.h"
f1d8130b
JT
9#include "list.h"
10#include "streaming.h"
a2551953 11#include "sha1-lookup.h"
498f1f61
JT
12#include "commit.h"
13#include "object.h"
14#include "tag.h"
15#include "tree-walk.h"
16#include "tree.h"
0d4a1321 17#include "object-store.h"
4f39cd82
JT
18
19char *odb_pack_name(struct strbuf *buf,
20 const unsigned char *sha1,
21 const char *ext)
22{
23 strbuf_reset(buf);
24 strbuf_addf(buf, "%s/pack/pack-%s.%s", get_object_directory(),
25 sha1_to_hex(sha1), ext);
26 return buf->buf;
27}
28
29char *sha1_pack_name(const unsigned char *sha1)
30{
31 static struct strbuf buf = STRBUF_INIT;
32 return odb_pack_name(&buf, sha1, "pack");
33}
34
35char *sha1_pack_index_name(const unsigned char *sha1)
36{
37 static struct strbuf buf = STRBUF_INIT;
38 return odb_pack_name(&buf, sha1, "idx");
39}
6d6a80e0 40
84f80ad5
JT
41static unsigned int pack_used_ctr;
42static unsigned int pack_mmap_calls;
43static unsigned int peak_pack_open_windows;
44static unsigned int pack_open_windows;
e65f1862 45static unsigned int pack_open_fds;
84f80ad5
JT
46static unsigned int pack_max_fds;
47static size_t peak_pack_mapped;
48static size_t pack_mapped;
8e21176c
JT
49
50#define SZ_FMT PRIuMAX
51static inline uintmax_t sz_fmt(size_t s) { return s; }
52
53void pack_report(void)
54{
55 fprintf(stderr,
56 "pack_report: getpagesize() = %10" SZ_FMT "\n"
57 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
58 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
59 sz_fmt(getpagesize()),
60 sz_fmt(packed_git_window_size),
61 sz_fmt(packed_git_limit));
62 fprintf(stderr,
63 "pack_report: pack_used_ctr = %10u\n"
64 "pack_report: pack_mmap_calls = %10u\n"
65 "pack_report: pack_open_windows = %10u / %10u\n"
66 "pack_report: pack_mapped = "
67 "%10" SZ_FMT " / %10" SZ_FMT "\n",
68 pack_used_ctr,
69 pack_mmap_calls,
70 pack_open_windows, peak_pack_open_windows,
71 sz_fmt(pack_mapped), sz_fmt(peak_pack_mapped));
72}
0317f455
JT
73
74/*
75 * Open and mmap the index file at path, perform a couple of
76 * consistency checks, then record its information to p. Return 0 on
77 * success.
78 */
79static int check_packed_git_idx(const char *path, struct packed_git *p)
80{
81 void *idx_map;
82 struct pack_idx_header *hdr;
83 size_t idx_size;
84 uint32_t version, nr, i, *index;
85 int fd = git_open(path);
86 struct stat st;
87
88 if (fd < 0)
89 return -1;
90 if (fstat(fd, &st)) {
91 close(fd);
92 return -1;
93 }
94 idx_size = xsize_t(st.st_size);
95 if (idx_size < 4 * 256 + 20 + 20) {
96 close(fd);
97 return error("index file %s is too small", path);
98 }
99 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
100 close(fd);
101
102 hdr = idx_map;
103 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
104 version = ntohl(hdr->idx_version);
105 if (version < 2 || version > 2) {
106 munmap(idx_map, idx_size);
107 return error("index file %s is version %"PRIu32
108 " and is not supported by this binary"
109 " (try upgrading GIT to a newer version)",
110 path, version);
111 }
112 } else
113 version = 1;
114
115 nr = 0;
116 index = idx_map;
117 if (version > 1)
118 index += 2; /* skip index header */
119 for (i = 0; i < 256; i++) {
120 uint32_t n = ntohl(index[i]);
121 if (n < nr) {
122 munmap(idx_map, idx_size);
123 return error("non-monotonic index %s", path);
124 }
125 nr = n;
126 }
127
128 if (version == 1) {
129 /*
130 * Total size:
131 * - 256 index entries 4 bytes each
132 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
133 * - 20-byte SHA1 of the packfile
134 * - 20-byte SHA1 file checksum
135 */
136 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
137 munmap(idx_map, idx_size);
138 return error("wrong index v1 file size in %s", path);
139 }
140 } else if (version == 2) {
141 /*
142 * Minimum size:
143 * - 8 bytes of header
144 * - 256 index entries 4 bytes each
145 * - 20-byte sha1 entry * nr
146 * - 4-byte crc entry * nr
147 * - 4-byte offset entry * nr
148 * - 20-byte SHA1 of the packfile
149 * - 20-byte SHA1 file checksum
150 * And after the 4-byte offset table might be a
151 * variable sized table containing 8-byte entries
152 * for offsets larger than 2^31.
153 */
154 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
155 unsigned long max_size = min_size;
156 if (nr)
157 max_size += (nr - 1)*8;
158 if (idx_size < min_size || idx_size > max_size) {
159 munmap(idx_map, idx_size);
160 return error("wrong index v2 file size in %s", path);
161 }
162 if (idx_size != min_size &&
163 /*
164 * make sure we can deal with large pack offsets.
165 * 31-bit signed offset won't be enough, neither
166 * 32-bit unsigned one will be.
167 */
168 (sizeof(off_t) <= 4)) {
169 munmap(idx_map, idx_size);
170 return error("pack too large for current definition of off_t in %s", path);
171 }
172 }
173
174 p->index_version = version;
175 p->index_data = idx_map;
176 p->index_size = idx_size;
177 p->num_objects = nr;
178 return 0;
179}
180
181int open_pack_index(struct packed_git *p)
182{
183 char *idx_name;
184 size_t len;
185 int ret;
186
187 if (p->index_data)
188 return 0;
189
190 if (!strip_suffix(p->pack_name, ".pack", &len))
191 die("BUG: pack_name does not end in .pack");
192 idx_name = xstrfmt("%.*s.idx", (int)len, p->pack_name);
193 ret = check_packed_git_idx(idx_name, p);
194 free(idx_name);
195 return ret;
196}
197
198static struct packed_git *alloc_packed_git(int extra)
199{
200 struct packed_git *p = xmalloc(st_add(sizeof(*p), extra));
201 memset(p, 0, sizeof(*p));
202 p->pack_fd = -1;
203 return p;
204}
205
206struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path)
207{
208 const char *path = sha1_pack_name(sha1);
209 size_t alloc = st_add(strlen(path), 1);
210 struct packed_git *p = alloc_packed_git(alloc);
211
212 memcpy(p->pack_name, path, alloc); /* includes NUL */
213 hashcpy(p->sha1, sha1);
214 if (check_packed_git_idx(idx_path, p)) {
215 free(p);
216 return NULL;
217 }
218
219 return p;
220}
f0e17e86
JT
221
222static void scan_windows(struct packed_git *p,
223 struct packed_git **lru_p,
224 struct pack_window **lru_w,
225 struct pack_window **lru_l)
226{
227 struct pack_window *w, *w_l;
228
229 for (w_l = NULL, w = p->windows; w; w = w->next) {
230 if (!w->inuse_cnt) {
231 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
232 *lru_p = p;
233 *lru_w = w;
234 *lru_l = w_l;
235 }
236 }
237 w_l = w;
238 }
239}
240
84f80ad5 241static int unuse_one_window(struct packed_git *current)
f0e17e86
JT
242{
243 struct packed_git *p, *lru_p = NULL;
244 struct pack_window *lru_w = NULL, *lru_l = NULL;
245
246 if (current)
247 scan_windows(current, &lru_p, &lru_w, &lru_l);
a80d72db 248 for (p = the_repository->objects->packed_git; p; p = p->next)
f0e17e86
JT
249 scan_windows(p, &lru_p, &lru_w, &lru_l);
250 if (lru_p) {
251 munmap(lru_w->base, lru_w->len);
252 pack_mapped -= lru_w->len;
253 if (lru_l)
254 lru_l->next = lru_w->next;
255 else
256 lru_p->windows = lru_w->next;
257 free(lru_w);
258 pack_open_windows--;
259 return 1;
260 }
261 return 0;
262}
263
264void release_pack_memory(size_t need)
265{
266 size_t cur = pack_mapped;
267 while (need >= (cur - pack_mapped) && unuse_one_window(NULL))
268 ; /* nothing */
269}
3836d88a
JT
270
271void close_pack_windows(struct packed_git *p)
272{
273 while (p->windows) {
274 struct pack_window *w = p->windows;
275
276 if (w->inuse_cnt)
277 die("pack '%s' still has open windows to it",
278 p->pack_name);
279 munmap(w->base, w->len);
280 pack_mapped -= w->len;
281 pack_open_windows--;
282 p->windows = w->next;
283 free(w);
284 }
285}
286
84f80ad5 287static int close_pack_fd(struct packed_git *p)
3836d88a
JT
288{
289 if (p->pack_fd < 0)
290 return 0;
291
292 close(p->pack_fd);
293 pack_open_fds--;
294 p->pack_fd = -1;
295
296 return 1;
297}
298
299void close_pack_index(struct packed_git *p)
300{
301 if (p->index_data) {
302 munmap((void *)p->index_data, p->index_size);
303 p->index_data = NULL;
304 }
305}
306
307static void close_pack(struct packed_git *p)
308{
309 close_pack_windows(p);
310 close_pack_fd(p);
311 close_pack_index(p);
312}
313
314void close_all_packs(void)
315{
316 struct packed_git *p;
317
a80d72db 318 for (p = the_repository->objects->packed_git; p; p = p->next)
3836d88a
JT
319 if (p->do_not_close)
320 die("BUG: want to close pack marked 'do-not-close'");
321 else
322 close_pack(p);
323}
84f80ad5
JT
324
325/*
326 * The LRU pack is the one with the oldest MRU window, preferring packs
327 * with no used windows, or the oldest mtime if it has no windows allocated.
328 */
329static void find_lru_pack(struct packed_git *p, struct packed_git **lru_p, struct pack_window **mru_w, int *accept_windows_inuse)
330{
331 struct pack_window *w, *this_mru_w;
332 int has_windows_inuse = 0;
333
334 /*
335 * Reject this pack if it has windows and the previously selected
336 * one does not. If this pack does not have windows, reject
337 * it if the pack file is newer than the previously selected one.
338 */
339 if (*lru_p && !*mru_w && (p->windows || p->mtime > (*lru_p)->mtime))
340 return;
341
342 for (w = this_mru_w = p->windows; w; w = w->next) {
343 /*
344 * Reject this pack if any of its windows are in use,
345 * but the previously selected pack did not have any
346 * inuse windows. Otherwise, record that this pack
347 * has windows in use.
348 */
349 if (w->inuse_cnt) {
350 if (*accept_windows_inuse)
351 has_windows_inuse = 1;
352 else
353 return;
354 }
355
356 if (w->last_used > this_mru_w->last_used)
357 this_mru_w = w;
358
359 /*
360 * Reject this pack if it has windows that have been
361 * used more recently than the previously selected pack.
362 * If the previously selected pack had windows inuse and
363 * we have not encountered a window in this pack that is
364 * inuse, skip this check since we prefer a pack with no
365 * inuse windows to one that has inuse windows.
366 */
367 if (*mru_w && *accept_windows_inuse == has_windows_inuse &&
368 this_mru_w->last_used > (*mru_w)->last_used)
369 return;
370 }
371
372 /*
373 * Select this pack.
374 */
375 *mru_w = this_mru_w;
376 *lru_p = p;
377 *accept_windows_inuse = has_windows_inuse;
378}
379
380static int close_one_pack(void)
381{
382 struct packed_git *p, *lru_p = NULL;
383 struct pack_window *mru_w = NULL;
384 int accept_windows_inuse = 1;
385
a80d72db 386 for (p = the_repository->objects->packed_git; p; p = p->next) {
84f80ad5
JT
387 if (p->pack_fd == -1)
388 continue;
389 find_lru_pack(p, &lru_p, &mru_w, &accept_windows_inuse);
390 }
391
392 if (lru_p)
393 return close_pack_fd(lru_p);
394
395 return 0;
396}
397
398static unsigned int get_max_fd_limit(void)
399{
400#ifdef RLIMIT_NOFILE
401 {
402 struct rlimit lim;
403
404 if (!getrlimit(RLIMIT_NOFILE, &lim))
405 return lim.rlim_cur;
406 }
407#endif
408
409#ifdef _SC_OPEN_MAX
410 {
411 long open_max = sysconf(_SC_OPEN_MAX);
412 if (0 < open_max)
413 return open_max;
414 /*
415 * Otherwise, we got -1 for one of the two
416 * reasons:
417 *
418 * (1) sysconf() did not understand _SC_OPEN_MAX
419 * and signaled an error with -1; or
420 * (2) sysconf() said there is no limit.
421 *
422 * We _could_ clear errno before calling sysconf() to
423 * tell these two cases apart and return a huge number
424 * in the latter case to let the caller cap it to a
425 * value that is not so selfish, but letting the
426 * fallback OPEN_MAX codepath take care of these cases
427 * is a lot simpler.
428 */
429 }
430#endif
431
432#ifdef OPEN_MAX
433 return OPEN_MAX;
434#else
435 return 1; /* see the caller ;-) */
436#endif
437}
438
439/*
440 * Do not call this directly as this leaks p->pack_fd on error return;
441 * call open_packed_git() instead.
442 */
443static int open_packed_git_1(struct packed_git *p)
444{
445 struct stat st;
446 struct pack_header hdr;
447 unsigned char sha1[20];
448 unsigned char *idx_sha1;
449 long fd_flag;
41dcc4dc 450 ssize_t read_result;
84f80ad5
JT
451
452 if (!p->index_data && open_pack_index(p))
453 return error("packfile %s index unavailable", p->pack_name);
454
455 if (!pack_max_fds) {
456 unsigned int max_fds = get_max_fd_limit();
457
458 /* Save 3 for stdin/stdout/stderr, 22 for work */
459 if (25 < max_fds)
460 pack_max_fds = max_fds - 25;
461 else
462 pack_max_fds = 1;
463 }
464
465 while (pack_max_fds <= pack_open_fds && close_one_pack())
466 ; /* nothing */
467
468 p->pack_fd = git_open(p->pack_name);
469 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
470 return -1;
471 pack_open_fds++;
472
473 /* If we created the struct before we had the pack we lack size. */
474 if (!p->pack_size) {
475 if (!S_ISREG(st.st_mode))
476 return error("packfile %s not a regular file", p->pack_name);
477 p->pack_size = st.st_size;
478 } else if (p->pack_size != st.st_size)
479 return error("packfile %s size changed", p->pack_name);
480
481 /* We leave these file descriptors open with sliding mmap;
482 * there is no point keeping them open across exec(), though.
483 */
484 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
485 if (fd_flag < 0)
486 return error("cannot determine file descriptor flags");
487 fd_flag |= FD_CLOEXEC;
488 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
489 return error("cannot set FD_CLOEXEC");
490
491 /* Verify we recognize this pack file format. */
41dcc4dc
JK
492 read_result = read_in_full(p->pack_fd, &hdr, sizeof(hdr));
493 if (read_result < 0)
494 return error_errno("error reading from %s", p->pack_name);
495 if (read_result != sizeof(hdr))
84f80ad5
JT
496 return error("file %s is far too short to be a packfile", p->pack_name);
497 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
498 return error("file %s is not a GIT packfile", p->pack_name);
499 if (!pack_version_ok(hdr.hdr_version))
500 return error("packfile %s is version %"PRIu32" and not"
501 " supported (try upgrading GIT to a newer version)",
502 p->pack_name, ntohl(hdr.hdr_version));
503
504 /* Verify the pack matches its index. */
505 if (p->num_objects != ntohl(hdr.hdr_entries))
506 return error("packfile %s claims to have %"PRIu32" objects"
507 " while index indicates %"PRIu32" objects",
508 p->pack_name, ntohl(hdr.hdr_entries),
509 p->num_objects);
510 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
511 return error("end of packfile %s is unavailable", p->pack_name);
41dcc4dc
JK
512 read_result = read_in_full(p->pack_fd, sha1, sizeof(sha1));
513 if (read_result < 0)
514 return error_errno("error reading from %s", p->pack_name);
515 if (read_result != sizeof(sha1))
84f80ad5
JT
516 return error("packfile %s signature is unavailable", p->pack_name);
517 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
518 if (hashcmp(sha1, idx_sha1))
519 return error("packfile %s does not match index", p->pack_name);
520 return 0;
521}
522
a2551953 523static int open_packed_git(struct packed_git *p)
84f80ad5
JT
524{
525 if (!open_packed_git_1(p))
526 return 0;
527 close_pack_fd(p);
528 return -1;
529}
530
531static int in_window(struct pack_window *win, off_t offset)
532{
533 /* We must promise at least 20 bytes (one hash) after the
534 * offset is available from this window, otherwise the offset
535 * is not actually in this window and a different window (which
536 * has that one hash excess) must be used. This is to support
537 * the object header and delta base parsing routines below.
538 */
539 off_t win_off = win->offset;
540 return win_off <= offset
541 && (offset + 20) <= (win_off + win->len);
542}
543
544unsigned char *use_pack(struct packed_git *p,
545 struct pack_window **w_cursor,
546 off_t offset,
547 unsigned long *left)
548{
549 struct pack_window *win = *w_cursor;
550
551 /* Since packfiles end in a hash of their content and it's
552 * pointless to ask for an offset into the middle of that
553 * hash, and the in_window function above wouldn't match
554 * don't allow an offset too close to the end of the file.
555 */
556 if (!p->pack_size && p->pack_fd == -1 && open_packed_git(p))
557 die("packfile %s cannot be accessed", p->pack_name);
558 if (offset > (p->pack_size - 20))
559 die("offset beyond end of packfile (truncated pack?)");
560 if (offset < 0)
561 die(_("offset before end of packfile (broken .idx?)"));
562
563 if (!win || !in_window(win, offset)) {
564 if (win)
565 win->inuse_cnt--;
566 for (win = p->windows; win; win = win->next) {
567 if (in_window(win, offset))
568 break;
569 }
570 if (!win) {
571 size_t window_align = packed_git_window_size / 2;
572 off_t len;
573
574 if (p->pack_fd == -1 && open_packed_git(p))
575 die("packfile %s cannot be accessed", p->pack_name);
576
577 win = xcalloc(1, sizeof(*win));
578 win->offset = (offset / window_align) * window_align;
579 len = p->pack_size - win->offset;
580 if (len > packed_git_window_size)
581 len = packed_git_window_size;
582 win->len = (size_t)len;
583 pack_mapped += win->len;
584 while (packed_git_limit < pack_mapped
585 && unuse_one_window(p))
586 ; /* nothing */
587 win->base = xmmap(NULL, win->len,
588 PROT_READ, MAP_PRIVATE,
589 p->pack_fd, win->offset);
590 if (win->base == MAP_FAILED)
591 die_errno("packfile %s cannot be mapped",
592 p->pack_name);
593 if (!win->offset && win->len == p->pack_size
594 && !p->do_not_close)
595 close_pack_fd(p);
596 pack_mmap_calls++;
597 pack_open_windows++;
598 if (pack_mapped > peak_pack_mapped)
599 peak_pack_mapped = pack_mapped;
600 if (pack_open_windows > peak_pack_open_windows)
601 peak_pack_open_windows = pack_open_windows;
602 win->next = p->windows;
603 p->windows = win;
604 }
605 }
606 if (win != *w_cursor) {
607 win->last_used = pack_used_ctr++;
608 win->inuse_cnt++;
609 *w_cursor = win;
610 }
611 offset -= win->offset;
612 if (left)
613 *left = win->len - xsize_t(offset);
614 return win->base + offset;
615}
97de1803
JT
616
617void unuse_pack(struct pack_window **w_cursor)
618{
619 struct pack_window *w = *w_cursor;
620 if (w) {
621 w->inuse_cnt--;
622 *w_cursor = NULL;
623 }
624}
9a428653
JT
625
626static void try_to_free_pack_memory(size_t size)
627{
628 release_pack_memory(size);
629}
630
631struct packed_git *add_packed_git(const char *path, size_t path_len, int local)
632{
633 static int have_set_try_to_free_routine;
634 struct stat st;
635 size_t alloc;
636 struct packed_git *p;
637
638 if (!have_set_try_to_free_routine) {
639 have_set_try_to_free_routine = 1;
640 set_try_to_free_routine(try_to_free_pack_memory);
641 }
642
643 /*
644 * Make sure a corresponding .pack file exists and that
645 * the index looks sane.
646 */
647 if (!strip_suffix_mem(path, &path_len, ".idx"))
648 return NULL;
649
650 /*
498f1f61 651 * ".promisor" is long enough to hold any suffix we're adding (and
9a428653
JT
652 * the use xsnprintf double-checks that)
653 */
498f1f61 654 alloc = st_add3(path_len, strlen(".promisor"), 1);
9a428653
JT
655 p = alloc_packed_git(alloc);
656 memcpy(p->pack_name, path, path_len);
657
658 xsnprintf(p->pack_name + path_len, alloc - path_len, ".keep");
659 if (!access(p->pack_name, F_OK))
660 p->pack_keep = 1;
661
498f1f61
JT
662 xsnprintf(p->pack_name + path_len, alloc - path_len, ".promisor");
663 if (!access(p->pack_name, F_OK))
664 p->pack_promisor = 1;
665
9a428653
JT
666 xsnprintf(p->pack_name + path_len, alloc - path_len, ".pack");
667 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
668 free(p);
669 return NULL;
670 }
671
672 /* ok, it looks sane as far as we can check without
673 * actually mapping the pack file.
674 */
675 p->pack_size = st.st_size;
676 p->pack_local = local;
677 p->mtime = st.st_mtime;
678 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
679 hashclr(p->sha1);
680 return p;
681}
e65f1862
JT
682
683void install_packed_git(struct packed_git *pack)
684{
685 if (pack->pack_fd != -1)
686 pack_open_fds++;
687
a80d72db
SB
688 pack->next = the_repository->objects->packed_git;
689 the_repository->objects->packed_git = pack;
e65f1862 690}
0abe14f6
JT
691
692void (*report_garbage)(unsigned seen_bits, const char *path);
693
694static void report_helper(const struct string_list *list,
695 int seen_bits, int first, int last)
696{
697 if (seen_bits == (PACKDIR_FILE_PACK|PACKDIR_FILE_IDX))
698 return;
699
700 for (; first < last; first++)
701 report_garbage(seen_bits, list->items[first].string);
702}
703
704static void report_pack_garbage(struct string_list *list)
705{
706 int i, baselen = -1, first = 0, seen_bits = 0;
707
708 if (!report_garbage)
709 return;
710
711 string_list_sort(list);
712
713 for (i = 0; i < list->nr; i++) {
714 const char *path = list->items[i].string;
715 if (baselen != -1 &&
716 strncmp(path, list->items[first].string, baselen)) {
717 report_helper(list, seen_bits, first, i);
718 baselen = -1;
719 seen_bits = 0;
720 }
721 if (baselen == -1) {
722 const char *dot = strrchr(path, '.');
723 if (!dot) {
724 report_garbage(PACKDIR_FILE_GARBAGE, path);
725 continue;
726 }
727 baselen = dot - path + 1;
728 first = i;
729 }
730 if (!strcmp(path + baselen, "pack"))
731 seen_bits |= 1;
732 else if (!strcmp(path + baselen, "idx"))
733 seen_bits |= 2;
734 }
735 report_helper(list, seen_bits, first, list->nr);
736}
737
738static void prepare_packed_git_one(char *objdir, int local)
739{
740 struct strbuf path = STRBUF_INIT;
741 size_t dirnamelen;
742 DIR *dir;
743 struct dirent *de;
744 struct string_list garbage = STRING_LIST_INIT_DUP;
745
746 strbuf_addstr(&path, objdir);
747 strbuf_addstr(&path, "/pack");
748 dir = opendir(path.buf);
749 if (!dir) {
750 if (errno != ENOENT)
751 error_errno("unable to open object pack directory: %s",
752 path.buf);
753 strbuf_release(&path);
754 return;
755 }
756 strbuf_addch(&path, '/');
757 dirnamelen = path.len;
758 while ((de = readdir(dir)) != NULL) {
759 struct packed_git *p;
760 size_t base_len;
761
762 if (is_dot_or_dotdot(de->d_name))
763 continue;
764
765 strbuf_setlen(&path, dirnamelen);
766 strbuf_addstr(&path, de->d_name);
767
768 base_len = path.len;
769 if (strip_suffix_mem(path.buf, &base_len, ".idx")) {
770 /* Don't reopen a pack we already have. */
a80d72db
SB
771 for (p = the_repository->objects->packed_git; p;
772 p = p->next) {
0abe14f6
JT
773 size_t len;
774 if (strip_suffix(p->pack_name, ".pack", &len) &&
775 len == base_len &&
776 !memcmp(p->pack_name, path.buf, len))
777 break;
778 }
779 if (p == NULL &&
780 /*
781 * See if it really is a valid .idx file with
782 * corresponding .pack file that we can map.
783 */
784 (p = add_packed_git(path.buf, path.len, local)) != NULL)
785 install_packed_git(p);
786 }
787
788 if (!report_garbage)
789 continue;
790
791 if (ends_with(de->d_name, ".idx") ||
792 ends_with(de->d_name, ".pack") ||
793 ends_with(de->d_name, ".bitmap") ||
498f1f61
JT
794 ends_with(de->d_name, ".keep") ||
795 ends_with(de->d_name, ".promisor"))
0abe14f6
JT
796 string_list_append(&garbage, path.buf);
797 else
798 report_garbage(PACKDIR_FILE_GARBAGE, path.buf);
799 }
800 closedir(dir);
801 report_pack_garbage(&garbage);
802 string_list_clear(&garbage, 0);
803 strbuf_release(&path);
804}
805
806static int approximate_object_count_valid;
807
808/*
809 * Give a fast, rough count of the number of objects in the repository. This
810 * ignores loose objects completely. If you have a lot of them, then either
811 * you should repack because your performance will be awful, or they are
812 * all unreachable objects about to be pruned, in which case they're not really
813 * interesting as a measure of repo size in the first place.
814 */
815unsigned long approximate_object_count(void)
816{
817 static unsigned long count;
818 if (!approximate_object_count_valid) {
819 struct packed_git *p;
820
821 prepare_packed_git();
822 count = 0;
a80d72db 823 for (p = the_repository->objects->packed_git; p; p = p->next) {
0abe14f6
JT
824 if (open_pack_index(p))
825 continue;
826 count += p->num_objects;
827 }
828 }
829 return count;
830}
831
832static void *get_next_packed_git(const void *p)
833{
834 return ((const struct packed_git *)p)->next;
835}
836
837static void set_next_packed_git(void *p, void *next)
838{
839 ((struct packed_git *)p)->next = next;
840}
841
842static int sort_pack(const void *a_, const void *b_)
843{
844 const struct packed_git *a = a_;
845 const struct packed_git *b = b_;
846 int st;
847
848 /*
849 * Local packs tend to contain objects specific to our
850 * variant of the project than remote ones. In addition,
851 * remote ones could be on a network mounted filesystem.
852 * Favor local ones for these reasons.
853 */
854 st = a->pack_local - b->pack_local;
855 if (st)
856 return -st;
857
858 /*
859 * Younger packs tend to contain more recent objects,
860 * and more recent objects tend to get accessed more
861 * often.
862 */
863 if (a->mtime < b->mtime)
864 return 1;
865 else if (a->mtime == b->mtime)
866 return 0;
867 return -1;
868}
869
870static void rearrange_packed_git(void)
871{
a80d72db
SB
872 the_repository->objects->packed_git = llist_mergesort(
873 the_repository->objects->packed_git, get_next_packed_git,
874 set_next_packed_git, sort_pack);
0abe14f6
JT
875}
876
877static void prepare_packed_git_mru(void)
878{
879 struct packed_git *p;
880
a80d72db 881 INIT_LIST_HEAD(&the_repository->objects->packed_git_mru);
ec2dd32c 882
a80d72db
SB
883 for (p = the_repository->objects->packed_git; p; p = p->next)
884 list_add_tail(&p->mru, &the_repository->objects->packed_git_mru);
0abe14f6
JT
885}
886
887static int prepare_packed_git_run_once = 0;
888void prepare_packed_git(void)
889{
890 struct alternate_object_database *alt;
891
892 if (prepare_packed_git_run_once)
893 return;
894 prepare_packed_git_one(get_object_directory(), 1);
895 prepare_alt_odb();
031dc927 896 for (alt = the_repository->objects->alt_odb_list; alt; alt = alt->next)
0abe14f6
JT
897 prepare_packed_git_one(alt->path, 0);
898 rearrange_packed_git();
899 prepare_packed_git_mru();
900 prepare_packed_git_run_once = 1;
901}
902
903void reprepare_packed_git(void)
904{
905 approximate_object_count_valid = 0;
906 prepare_packed_git_run_once = 0;
907 prepare_packed_git();
908}
32b42e15 909
a80d72db
SB
910struct packed_git *get_packed_git(struct repository *r)
911{
912 return r->objects->packed_git;
913}
914
915struct list_head *get_packed_git_mru(struct repository *r)
916{
917 return &r->objects->packed_git_mru;
918}
919
32b42e15
JT
920unsigned long unpack_object_header_buffer(const unsigned char *buf,
921 unsigned long len, enum object_type *type, unsigned long *sizep)
922{
923 unsigned shift;
924 unsigned long size, c;
925 unsigned long used = 0;
926
927 c = buf[used++];
928 *type = (c >> 4) & 7;
929 size = c & 15;
930 shift = 4;
931 while (c & 0x80) {
932 if (len <= used || bitsizeof(long) <= shift) {
933 error("bad object header");
934 size = used = 0;
935 break;
936 }
937 c = buf[used++];
938 size += (c & 0x7f) << shift;
939 shift += 7;
940 }
941 *sizep = size;
942 return used;
943}
7b3aa75d
JT
944
945unsigned long get_size_from_delta(struct packed_git *p,
946 struct pack_window **w_curs,
947 off_t curpos)
948{
949 const unsigned char *data;
950 unsigned char delta_head[20], *in;
951 git_zstream stream;
952 int st;
953
954 memset(&stream, 0, sizeof(stream));
955 stream.next_out = delta_head;
956 stream.avail_out = sizeof(delta_head);
957
958 git_inflate_init(&stream);
959 do {
960 in = use_pack(p, w_curs, curpos, &stream.avail_in);
961 stream.next_in = in;
962 st = git_inflate(&stream, Z_FINISH);
963 curpos += stream.next_in - in;
964 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
965 stream.total_out < sizeof(delta_head));
966 git_inflate_end(&stream);
967 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head)) {
968 error("delta data unpack-initial failed");
969 return 0;
970 }
971
972 /* Examine the initial part of the delta to figure out
973 * the result size.
974 */
975 data = delta_head;
976
977 /* ignore base size */
978 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
979
980 /* Read the result size */
981 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
982}
3588dd6e
JT
983
984int unpack_object_header(struct packed_git *p,
985 struct pack_window **w_curs,
986 off_t *curpos,
987 unsigned long *sizep)
988{
989 unsigned char *base;
990 unsigned long left;
991 unsigned long used;
992 enum object_type type;
993
994 /* use_pack() assures us we have [base, base + 20) available
995 * as a range that we can look at. (Its actually the hash
996 * size that is assured.) With our object header encoding
997 * the maximum deflated object size is 2^137, which is just
998 * insane, so we know won't exceed what we have been given.
999 */
1000 base = use_pack(p, w_curs, *curpos, &left);
1001 used = unpack_object_header_buffer(base, left, &type, sizep);
1002 if (!used) {
1003 type = OBJ_BAD;
1004 } else
1005 *curpos += used;
1006
1007 return type;
1008}
f1d8130b
JT
1009
1010void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1)
1011{
1012 unsigned i;
1013 for (i = 0; i < p->num_bad_objects; i++)
1014 if (!hashcmp(sha1, p->bad_object_sha1 + GIT_SHA1_RAWSZ * i))
1015 return;
1016 p->bad_object_sha1 = xrealloc(p->bad_object_sha1,
1017 st_mult(GIT_MAX_RAWSZ,
1018 st_add(p->num_bad_objects, 1)));
1019 hashcpy(p->bad_object_sha1 + GIT_SHA1_RAWSZ * p->num_bad_objects, sha1);
1020 p->num_bad_objects++;
1021}
1022
1023const struct packed_git *has_packed_and_bad(const unsigned char *sha1)
1024{
1025 struct packed_git *p;
1026 unsigned i;
1027
a80d72db 1028 for (p = the_repository->objects->packed_git; p; p = p->next)
f1d8130b
JT
1029 for (i = 0; i < p->num_bad_objects; i++)
1030 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1031 return p;
1032 return NULL;
1033}
1034
1035static off_t get_delta_base(struct packed_git *p,
1036 struct pack_window **w_curs,
1037 off_t *curpos,
1038 enum object_type type,
1039 off_t delta_obj_offset)
1040{
1041 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
1042 off_t base_offset;
1043
1044 /* use_pack() assured us we have [base_info, base_info + 20)
1045 * as a range that we can look at without walking off the
1046 * end of the mapped window. Its actually the hash size
1047 * that is assured. An OFS_DELTA longer than the hash size
1048 * is stupid, as then a REF_DELTA would be smaller to store.
1049 */
1050 if (type == OBJ_OFS_DELTA) {
1051 unsigned used = 0;
1052 unsigned char c = base_info[used++];
1053 base_offset = c & 127;
1054 while (c & 128) {
1055 base_offset += 1;
1056 if (!base_offset || MSB(base_offset, 7))
1057 return 0; /* overflow */
1058 c = base_info[used++];
1059 base_offset = (base_offset << 7) + (c & 127);
1060 }
1061 base_offset = delta_obj_offset - base_offset;
1062 if (base_offset <= 0 || base_offset >= delta_obj_offset)
1063 return 0; /* out of bound */
1064 *curpos += used;
1065 } else if (type == OBJ_REF_DELTA) {
1066 /* The base entry _must_ be in the same pack */
1067 base_offset = find_pack_entry_one(base_info, p);
1068 *curpos += 20;
1069 } else
1070 die("I am totally screwed");
1071 return base_offset;
1072}
1073
1074/*
1075 * Like get_delta_base above, but we return the sha1 instead of the pack
1076 * offset. This means it is cheaper for REF deltas (we do not have to do
1077 * the final object lookup), but more expensive for OFS deltas (we
1078 * have to load the revidx to convert the offset back into a sha1).
1079 */
1080static const unsigned char *get_delta_base_sha1(struct packed_git *p,
1081 struct pack_window **w_curs,
1082 off_t curpos,
1083 enum object_type type,
1084 off_t delta_obj_offset)
1085{
1086 if (type == OBJ_REF_DELTA) {
1087 unsigned char *base = use_pack(p, w_curs, curpos, NULL);
1088 return base;
1089 } else if (type == OBJ_OFS_DELTA) {
1090 struct revindex_entry *revidx;
1091 off_t base_offset = get_delta_base(p, w_curs, &curpos,
1092 type, delta_obj_offset);
1093
1094 if (!base_offset)
1095 return NULL;
1096
1097 revidx = find_pack_revindex(p, base_offset);
1098 if (!revidx)
1099 return NULL;
1100
1101 return nth_packed_object_sha1(p, revidx->nr);
1102 } else
1103 return NULL;
1104}
1105
1106static int retry_bad_packed_offset(struct packed_git *p, off_t obj_offset)
1107{
1108 int type;
1109 struct revindex_entry *revidx;
1110 const unsigned char *sha1;
1111 revidx = find_pack_revindex(p, obj_offset);
1112 if (!revidx)
1113 return OBJ_BAD;
1114 sha1 = nth_packed_object_sha1(p, revidx->nr);
1115 mark_bad_packed_object(p, sha1);
1116 type = sha1_object_info(sha1, NULL);
1117 if (type <= OBJ_NONE)
1118 return OBJ_BAD;
1119 return type;
1120}
1121
1122#define POI_STACK_PREALLOC 64
1123
1124static enum object_type packed_to_object_type(struct packed_git *p,
1125 off_t obj_offset,
1126 enum object_type type,
1127 struct pack_window **w_curs,
1128 off_t curpos)
1129{
1130 off_t small_poi_stack[POI_STACK_PREALLOC];
1131 off_t *poi_stack = small_poi_stack;
1132 int poi_stack_nr = 0, poi_stack_alloc = POI_STACK_PREALLOC;
1133
1134 while (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1135 off_t base_offset;
1136 unsigned long size;
1137 /* Push the object we're going to leave behind */
1138 if (poi_stack_nr >= poi_stack_alloc && poi_stack == small_poi_stack) {
1139 poi_stack_alloc = alloc_nr(poi_stack_nr);
1140 ALLOC_ARRAY(poi_stack, poi_stack_alloc);
1141 memcpy(poi_stack, small_poi_stack, sizeof(off_t)*poi_stack_nr);
1142 } else {
1143 ALLOC_GROW(poi_stack, poi_stack_nr+1, poi_stack_alloc);
1144 }
1145 poi_stack[poi_stack_nr++] = obj_offset;
1146 /* If parsing the base offset fails, just unwind */
1147 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
1148 if (!base_offset)
1149 goto unwind;
1150 curpos = obj_offset = base_offset;
1151 type = unpack_object_header(p, w_curs, &curpos, &size);
1152 if (type <= OBJ_NONE) {
1153 /* If getting the base itself fails, we first
1154 * retry the base, otherwise unwind */
1155 type = retry_bad_packed_offset(p, base_offset);
1156 if (type > OBJ_NONE)
1157 goto out;
1158 goto unwind;
1159 }
1160 }
1161
1162 switch (type) {
1163 case OBJ_BAD:
1164 case OBJ_COMMIT:
1165 case OBJ_TREE:
1166 case OBJ_BLOB:
1167 case OBJ_TAG:
1168 break;
1169 default:
1170 error("unknown object type %i at offset %"PRIuMAX" in %s",
1171 type, (uintmax_t)obj_offset, p->pack_name);
1172 type = OBJ_BAD;
1173 }
1174
1175out:
1176 if (poi_stack != small_poi_stack)
1177 free(poi_stack);
1178 return type;
1179
1180unwind:
1181 while (poi_stack_nr) {
1182 obj_offset = poi_stack[--poi_stack_nr];
1183 type = retry_bad_packed_offset(p, obj_offset);
1184 if (type > OBJ_NONE)
1185 goto out;
1186 }
1187 type = OBJ_BAD;
1188 goto out;
1189}
1190
1191static struct hashmap delta_base_cache;
1192static size_t delta_base_cached;
1193
1194static LIST_HEAD(delta_base_cache_lru);
1195
1196struct delta_base_cache_key {
1197 struct packed_git *p;
1198 off_t base_offset;
1199};
1200
1201struct delta_base_cache_entry {
1202 struct hashmap hash;
1203 struct delta_base_cache_key key;
1204 struct list_head lru;
1205 void *data;
1206 unsigned long size;
1207 enum object_type type;
1208};
1209
1210static unsigned int pack_entry_hash(struct packed_git *p, off_t base_offset)
1211{
1212 unsigned int hash;
1213
1214 hash = (unsigned int)(intptr_t)p + (unsigned int)base_offset;
1215 hash += (hash >> 8) + (hash >> 16);
1216 return hash;
1217}
1218
1219static struct delta_base_cache_entry *
1220get_delta_base_cache_entry(struct packed_git *p, off_t base_offset)
1221{
1222 struct hashmap_entry entry;
1223 struct delta_base_cache_key key;
1224
1225 if (!delta_base_cache.cmpfn)
1226 return NULL;
1227
1228 hashmap_entry_init(&entry, pack_entry_hash(p, base_offset));
1229 key.p = p;
1230 key.base_offset = base_offset;
1231 return hashmap_get(&delta_base_cache, &entry, &key);
1232}
1233
1234static int delta_base_cache_key_eq(const struct delta_base_cache_key *a,
1235 const struct delta_base_cache_key *b)
1236{
1237 return a->p == b->p && a->base_offset == b->base_offset;
1238}
1239
1240static int delta_base_cache_hash_cmp(const void *unused_cmp_data,
1241 const void *va, const void *vb,
1242 const void *vkey)
1243{
1244 const struct delta_base_cache_entry *a = va, *b = vb;
1245 const struct delta_base_cache_key *key = vkey;
1246 if (key)
1247 return !delta_base_cache_key_eq(&a->key, key);
1248 else
1249 return !delta_base_cache_key_eq(&a->key, &b->key);
1250}
1251
1252static int in_delta_base_cache(struct packed_git *p, off_t base_offset)
1253{
1254 return !!get_delta_base_cache_entry(p, base_offset);
1255}
1256
1257/*
1258 * Remove the entry from the cache, but do _not_ free the associated
1259 * entry data. The caller takes ownership of the "data" buffer, and
1260 * should copy out any fields it wants before detaching.
1261 */
1262static void detach_delta_base_cache_entry(struct delta_base_cache_entry *ent)
1263{
1264 hashmap_remove(&delta_base_cache, ent, &ent->key);
1265 list_del(&ent->lru);
1266 delta_base_cached -= ent->size;
1267 free(ent);
1268}
1269
1270static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
1271 unsigned long *base_size, enum object_type *type)
1272{
1273 struct delta_base_cache_entry *ent;
1274
1275 ent = get_delta_base_cache_entry(p, base_offset);
1276 if (!ent)
1277 return unpack_entry(p, base_offset, type, base_size);
1278
1279 if (type)
1280 *type = ent->type;
1281 if (base_size)
1282 *base_size = ent->size;
1283 return xmemdupz(ent->data, ent->size);
1284}
1285
1286static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
1287{
1288 free(ent->data);
1289 detach_delta_base_cache_entry(ent);
1290}
1291
1292void clear_delta_base_cache(void)
1293{
1294 struct list_head *lru, *tmp;
1295 list_for_each_safe(lru, tmp, &delta_base_cache_lru) {
1296 struct delta_base_cache_entry *entry =
1297 list_entry(lru, struct delta_base_cache_entry, lru);
1298 release_delta_base_cache(entry);
1299 }
1300}
1301
1302static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
1303 void *base, unsigned long base_size, enum object_type type)
1304{
1305 struct delta_base_cache_entry *ent = xmalloc(sizeof(*ent));
1306 struct list_head *lru, *tmp;
1307
1308 delta_base_cached += base_size;
1309
1310 list_for_each_safe(lru, tmp, &delta_base_cache_lru) {
1311 struct delta_base_cache_entry *f =
1312 list_entry(lru, struct delta_base_cache_entry, lru);
1313 if (delta_base_cached <= delta_base_cache_limit)
1314 break;
1315 release_delta_base_cache(f);
1316 }
1317
1318 ent->key.p = p;
1319 ent->key.base_offset = base_offset;
1320 ent->type = type;
1321 ent->data = base;
1322 ent->size = base_size;
1323 list_add_tail(&ent->lru, &delta_base_cache_lru);
1324
1325 if (!delta_base_cache.cmpfn)
1326 hashmap_init(&delta_base_cache, delta_base_cache_hash_cmp, NULL, 0);
1327 hashmap_entry_init(ent, pack_entry_hash(p, base_offset));
1328 hashmap_add(&delta_base_cache, ent);
1329}
1330
1331int packed_object_info(struct packed_git *p, off_t obj_offset,
1332 struct object_info *oi)
1333{
1334 struct pack_window *w_curs = NULL;
1335 unsigned long size;
1336 off_t curpos = obj_offset;
1337 enum object_type type;
1338
1339 /*
1340 * We always get the representation type, but only convert it to
1341 * a "real" type later if the caller is interested.
1342 */
1343 if (oi->contentp) {
1344 *oi->contentp = cache_or_unpack_entry(p, obj_offset, oi->sizep,
1345 &type);
1346 if (!*oi->contentp)
1347 type = OBJ_BAD;
1348 } else {
1349 type = unpack_object_header(p, &w_curs, &curpos, &size);
1350 }
1351
1352 if (!oi->contentp && oi->sizep) {
1353 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1354 off_t tmp_pos = curpos;
1355 off_t base_offset = get_delta_base(p, &w_curs, &tmp_pos,
1356 type, obj_offset);
1357 if (!base_offset) {
1358 type = OBJ_BAD;
1359 goto out;
1360 }
1361 *oi->sizep = get_size_from_delta(p, &w_curs, tmp_pos);
1362 if (*oi->sizep == 0) {
1363 type = OBJ_BAD;
1364 goto out;
1365 }
1366 } else {
1367 *oi->sizep = size;
1368 }
1369 }
1370
1371 if (oi->disk_sizep) {
1372 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
1373 *oi->disk_sizep = revidx[1].offset - obj_offset;
1374 }
1375
1376 if (oi->typep || oi->typename) {
1377 enum object_type ptot;
1378 ptot = packed_to_object_type(p, obj_offset, type, &w_curs,
1379 curpos);
1380 if (oi->typep)
1381 *oi->typep = ptot;
1382 if (oi->typename) {
1383 const char *tn = typename(ptot);
1384 if (tn)
1385 strbuf_addstr(oi->typename, tn);
1386 }
1387 if (ptot < 0) {
1388 type = OBJ_BAD;
1389 goto out;
1390 }
1391 }
1392
1393 if (oi->delta_base_sha1) {
1394 if (type == OBJ_OFS_DELTA || type == OBJ_REF_DELTA) {
1395 const unsigned char *base;
1396
1397 base = get_delta_base_sha1(p, &w_curs, curpos,
1398 type, obj_offset);
1399 if (!base) {
1400 type = OBJ_BAD;
1401 goto out;
1402 }
1403
1404 hashcpy(oi->delta_base_sha1, base);
1405 } else
1406 hashclr(oi->delta_base_sha1);
1407 }
1408
1409 oi->whence = in_delta_base_cache(p, obj_offset) ? OI_DBCACHED :
1410 OI_PACKED;
1411
1412out:
1413 unuse_pack(&w_curs);
1414 return type;
1415}
1416
1417static void *unpack_compressed_entry(struct packed_git *p,
1418 struct pack_window **w_curs,
1419 off_t curpos,
1420 unsigned long size)
1421{
1422 int st;
1423 git_zstream stream;
1424 unsigned char *buffer, *in;
1425
1426 buffer = xmallocz_gently(size);
1427 if (!buffer)
1428 return NULL;
1429 memset(&stream, 0, sizeof(stream));
1430 stream.next_out = buffer;
1431 stream.avail_out = size + 1;
1432
1433 git_inflate_init(&stream);
1434 do {
1435 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1436 stream.next_in = in;
1437 st = git_inflate(&stream, Z_FINISH);
1438 if (!stream.avail_out)
1439 break; /* the payload is larger than it should be */
1440 curpos += stream.next_in - in;
1441 } while (st == Z_OK || st == Z_BUF_ERROR);
1442 git_inflate_end(&stream);
1443 if ((st != Z_STREAM_END) || stream.total_out != size) {
1444 free(buffer);
1445 return NULL;
1446 }
1447
1448 return buffer;
1449}
1450
1451static void write_pack_access_log(struct packed_git *p, off_t obj_offset)
1452{
1453 static struct trace_key pack_access = TRACE_KEY_INIT(PACK_ACCESS);
1454 trace_printf_key(&pack_access, "%s %"PRIuMAX"\n",
1455 p->pack_name, (uintmax_t)obj_offset);
1456}
1457
1458int do_check_packed_object_crc;
1459
1460#define UNPACK_ENTRY_STACK_PREALLOC 64
1461struct unpack_entry_stack_ent {
1462 off_t obj_offset;
1463 off_t curpos;
1464 unsigned long size;
1465};
1466
1467static void *read_object(const unsigned char *sha1, enum object_type *type,
1468 unsigned long *size)
1469{
1470 struct object_info oi = OBJECT_INFO_INIT;
1471 void *content;
1472 oi.typep = type;
1473 oi.sizep = size;
1474 oi.contentp = &content;
1475
1476 if (sha1_object_info_extended(sha1, &oi, 0) < 0)
1477 return NULL;
1478 return content;
1479}
1480
1481void *unpack_entry(struct packed_git *p, off_t obj_offset,
1482 enum object_type *final_type, unsigned long *final_size)
1483{
1484 struct pack_window *w_curs = NULL;
1485 off_t curpos = obj_offset;
1486 void *data = NULL;
1487 unsigned long size;
1488 enum object_type type;
1489 struct unpack_entry_stack_ent small_delta_stack[UNPACK_ENTRY_STACK_PREALLOC];
1490 struct unpack_entry_stack_ent *delta_stack = small_delta_stack;
1491 int delta_stack_nr = 0, delta_stack_alloc = UNPACK_ENTRY_STACK_PREALLOC;
1492 int base_from_cache = 0;
1493
1494 write_pack_access_log(p, obj_offset);
1495
1496 /* PHASE 1: drill down to the innermost base object */
1497 for (;;) {
1498 off_t base_offset;
1499 int i;
1500 struct delta_base_cache_entry *ent;
1501
1502 ent = get_delta_base_cache_entry(p, curpos);
1503 if (ent) {
1504 type = ent->type;
1505 data = ent->data;
1506 size = ent->size;
1507 detach_delta_base_cache_entry(ent);
1508 base_from_cache = 1;
1509 break;
1510 }
1511
1512 if (do_check_packed_object_crc && p->index_version > 1) {
1513 struct revindex_entry *revidx = find_pack_revindex(p, obj_offset);
1514 off_t len = revidx[1].offset - obj_offset;
1515 if (check_pack_crc(p, &w_curs, obj_offset, len, revidx->nr)) {
1516 const unsigned char *sha1 =
1517 nth_packed_object_sha1(p, revidx->nr);
1518 error("bad packed object CRC for %s",
1519 sha1_to_hex(sha1));
1520 mark_bad_packed_object(p, sha1);
1521 data = NULL;
1522 goto out;
1523 }
1524 }
1525
1526 type = unpack_object_header(p, &w_curs, &curpos, &size);
1527 if (type != OBJ_OFS_DELTA && type != OBJ_REF_DELTA)
1528 break;
1529
1530 base_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
1531 if (!base_offset) {
1532 error("failed to validate delta base reference "
1533 "at offset %"PRIuMAX" from %s",
1534 (uintmax_t)curpos, p->pack_name);
1535 /* bail to phase 2, in hopes of recovery */
1536 data = NULL;
1537 break;
1538 }
1539
1540 /* push object, proceed to base */
1541 if (delta_stack_nr >= delta_stack_alloc
1542 && delta_stack == small_delta_stack) {
1543 delta_stack_alloc = alloc_nr(delta_stack_nr);
1544 ALLOC_ARRAY(delta_stack, delta_stack_alloc);
1545 memcpy(delta_stack, small_delta_stack,
1546 sizeof(*delta_stack)*delta_stack_nr);
1547 } else {
1548 ALLOC_GROW(delta_stack, delta_stack_nr+1, delta_stack_alloc);
1549 }
1550 i = delta_stack_nr++;
1551 delta_stack[i].obj_offset = obj_offset;
1552 delta_stack[i].curpos = curpos;
1553 delta_stack[i].size = size;
1554
1555 curpos = obj_offset = base_offset;
1556 }
1557
1558 /* PHASE 2: handle the base */
1559 switch (type) {
1560 case OBJ_OFS_DELTA:
1561 case OBJ_REF_DELTA:
1562 if (data)
1563 die("BUG: unpack_entry: left loop at a valid delta");
1564 break;
1565 case OBJ_COMMIT:
1566 case OBJ_TREE:
1567 case OBJ_BLOB:
1568 case OBJ_TAG:
1569 if (!base_from_cache)
1570 data = unpack_compressed_entry(p, &w_curs, curpos, size);
1571 break;
1572 default:
1573 data = NULL;
1574 error("unknown object type %i at offset %"PRIuMAX" in %s",
1575 type, (uintmax_t)obj_offset, p->pack_name);
1576 }
1577
1578 /* PHASE 3: apply deltas in order */
1579
1580 /* invariants:
1581 * 'data' holds the base data, or NULL if there was corruption
1582 */
1583 while (delta_stack_nr) {
1584 void *delta_data;
1585 void *base = data;
1586 void *external_base = NULL;
1587 unsigned long delta_size, base_size = size;
1588 int i;
1589
1590 data = NULL;
1591
1592 if (base)
1593 add_delta_base_cache(p, obj_offset, base, base_size, type);
1594
1595 if (!base) {
1596 /*
1597 * We're probably in deep shit, but let's try to fetch
1598 * the required base anyway from another pack or loose.
1599 * This is costly but should happen only in the presence
1600 * of a corrupted pack, and is better than failing outright.
1601 */
1602 struct revindex_entry *revidx;
1603 const unsigned char *base_sha1;
1604 revidx = find_pack_revindex(p, obj_offset);
1605 if (revidx) {
1606 base_sha1 = nth_packed_object_sha1(p, revidx->nr);
1607 error("failed to read delta base object %s"
1608 " at offset %"PRIuMAX" from %s",
1609 sha1_to_hex(base_sha1), (uintmax_t)obj_offset,
1610 p->pack_name);
1611 mark_bad_packed_object(p, base_sha1);
1612 base = read_object(base_sha1, &type, &base_size);
1613 external_base = base;
1614 }
1615 }
1616
1617 i = --delta_stack_nr;
1618 obj_offset = delta_stack[i].obj_offset;
1619 curpos = delta_stack[i].curpos;
1620 delta_size = delta_stack[i].size;
1621
1622 if (!base)
1623 continue;
1624
1625 delta_data = unpack_compressed_entry(p, &w_curs, curpos, delta_size);
1626
1627 if (!delta_data) {
1628 error("failed to unpack compressed delta "
1629 "at offset %"PRIuMAX" from %s",
1630 (uintmax_t)curpos, p->pack_name);
1631 data = NULL;
1632 free(external_base);
1633 continue;
1634 }
1635
1636 data = patch_delta(base, base_size,
1637 delta_data, delta_size,
1638 &size);
1639
1640 /*
1641 * We could not apply the delta; warn the user, but keep going.
1642 * Our failure will be noticed either in the next iteration of
1643 * the loop, or if this is the final delta, in the caller when
1644 * we return NULL. Those code paths will take care of making
1645 * a more explicit warning and retrying with another copy of
1646 * the object.
1647 */
1648 if (!data)
1649 error("failed to apply delta");
1650
1651 free(delta_data);
1652 free(external_base);
1653 }
1654
1655 if (final_type)
1656 *final_type = type;
1657 if (final_size)
1658 *final_size = size;
1659
1660out:
1661 unuse_pack(&w_curs);
1662
1663 if (delta_stack != small_delta_stack)
1664 free(delta_stack);
1665
1666 return data;
1667}
d5a16761
JT
1668
1669const unsigned char *nth_packed_object_sha1(struct packed_git *p,
1670 uint32_t n)
1671{
1672 const unsigned char *index = p->index_data;
1673 if (!index) {
1674 if (open_pack_index(p))
1675 return NULL;
1676 index = p->index_data;
1677 }
1678 if (n >= p->num_objects)
1679 return NULL;
1680 index += 4 * 256;
1681 if (p->index_version == 1) {
1682 return index + 24 * n + 4;
1683 } else {
1684 index += 8;
1685 return index + 20 * n;
1686 }
1687}
1688
1689const struct object_id *nth_packed_object_oid(struct object_id *oid,
1690 struct packed_git *p,
1691 uint32_t n)
1692{
1693 const unsigned char *hash = nth_packed_object_sha1(p, n);
1694 if (!hash)
1695 return NULL;
1696 hashcpy(oid->hash, hash);
1697 return oid;
1698}
9e0f45f5
JT
1699
1700void check_pack_index_ptr(const struct packed_git *p, const void *vptr)
1701{
1702 const unsigned char *ptr = vptr;
1703 const unsigned char *start = p->index_data;
1704 const unsigned char *end = start + p->index_size;
1705 if (ptr < start)
1706 die(_("offset before start of pack index for %s (corrupt index?)"),
1707 p->pack_name);
1708 /* No need to check for underflow; .idx files must be at least 8 bytes */
1709 if (ptr >= end - 8)
1710 die(_("offset beyond end of pack index for %s (truncated index?)"),
1711 p->pack_name);
1712}
1713
1714off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
1715{
1716 const unsigned char *index = p->index_data;
1717 index += 4 * 256;
1718 if (p->index_version == 1) {
1719 return ntohl(*((uint32_t *)(index + 24 * n)));
1720 } else {
1721 uint32_t off;
1722 index += 8 + p->num_objects * (20 + 4);
1723 off = ntohl(*((uint32_t *)(index + 4 * n)));
1724 if (!(off & 0x80000000))
1725 return off;
1726 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
1727 check_pack_index_ptr(p, index);
ad622a25 1728 return get_be64(index);
9e0f45f5
JT
1729 }
1730}
a2551953
JT
1731
1732off_t find_pack_entry_one(const unsigned char *sha1,
1733 struct packed_git *p)
1734{
1735 const uint32_t *level1_ofs = p->index_data;
1736 const unsigned char *index = p->index_data;
1737 unsigned hi, lo, stride;
1738 static int debug_lookup = -1;
1739
1740 if (debug_lookup < 0)
1741 debug_lookup = !!getenv("GIT_DEBUG_LOOKUP");
1742
1743 if (!index) {
1744 if (open_pack_index(p))
1745 return 0;
1746 level1_ofs = p->index_data;
1747 index = p->index_data;
1748 }
1749 if (p->index_version > 1) {
1750 level1_ofs += 2;
1751 index += 8;
1752 }
1753 index += 4 * 256;
1754 hi = ntohl(level1_ofs[*sha1]);
1755 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
1756 if (p->index_version > 1) {
1757 stride = 20;
1758 } else {
1759 stride = 24;
1760 index += 4;
1761 }
1762
1763 if (debug_lookup)
1764 printf("%02x%02x%02x... lo %u hi %u nr %"PRIu32"\n",
1765 sha1[0], sha1[1], sha1[2], lo, hi, p->num_objects);
1766
1767 while (lo < hi) {
19716b21 1768 unsigned mi = lo + (hi - lo) / 2;
a2551953
JT
1769 int cmp = hashcmp(index + mi * stride, sha1);
1770
1771 if (debug_lookup)
1772 printf("lo %u hi %u rg %u mi %u\n",
1773 lo, hi, hi - lo, mi);
1774 if (!cmp)
1775 return nth_packed_object_offset(p, mi);
1776 if (cmp > 0)
1777 hi = mi;
1778 else
1779 lo = mi+1;
1780 }
1781 return 0;
1782}
1783
1784int is_pack_valid(struct packed_git *p)
1785{
1786 /* An already open pack is known to be valid. */
1787 if (p->pack_fd != -1)
1788 return 1;
1789
1790 /* If the pack has one window completely covering the
1791 * file size, the pack is known to be valid even if
1792 * the descriptor is not currently open.
1793 */
1794 if (p->windows) {
1795 struct pack_window *w = p->windows;
1796
1797 if (!w->offset && w->len == p->pack_size)
1798 return 1;
1799 }
1800
1801 /* Force the pack to open to prove its valid. */
1802 return !open_packed_git(p);
1803}
d6fe0036
JT
1804
1805struct packed_git *find_sha1_pack(const unsigned char *sha1,
1806 struct packed_git *packs)
1807{
1808 struct packed_git *p;
1809
1810 for (p = packs; p; p = p->next) {
1811 if (find_pack_entry_one(sha1, p))
1812 return p;
1813 }
1814 return NULL;
1815
1816}
1a1e5d4f
JT
1817
1818static int fill_pack_entry(const unsigned char *sha1,
1819 struct pack_entry *e,
1820 struct packed_git *p)
1821{
1822 off_t offset;
1823
1824 if (p->num_bad_objects) {
1825 unsigned i;
1826 for (i = 0; i < p->num_bad_objects; i++)
1827 if (!hashcmp(sha1, p->bad_object_sha1 + 20 * i))
1828 return 0;
1829 }
1830
1831 offset = find_pack_entry_one(sha1, p);
1832 if (!offset)
1833 return 0;
1834
1835 /*
1836 * We are about to tell the caller where they can locate the
1837 * requested object. We better make sure the packfile is
1838 * still here and can be accessed before supplying that
1839 * answer, as it may have been deleted since the index was
1840 * loaded!
1841 */
1842 if (!is_pack_valid(p))
1843 return 0;
1844 e->offset = offset;
1845 e->p = p;
1846 hashcpy(e->sha1, sha1);
1847 return 1;
1848}
1849
1850/*
1851 * Iff a pack file contains the object named by sha1, return true and
1852 * store its location to e.
1853 */
1854int find_pack_entry(const unsigned char *sha1, struct pack_entry *e)
1855{
8865859d 1856 struct list_head *pos;
1a1e5d4f
JT
1857
1858 prepare_packed_git();
a80d72db 1859 if (!the_repository->objects->packed_git)
1a1e5d4f
JT
1860 return 0;
1861
a80d72db 1862 list_for_each(pos, &the_repository->objects->packed_git_mru) {
ec2dd32c
GS
1863 struct packed_git *p = list_entry(pos, struct packed_git, mru);
1864 if (fill_pack_entry(sha1, e, p)) {
a80d72db
SB
1865 list_move(&p->mru,
1866 &the_repository->objects->packed_git_mru);
1a1e5d4f
JT
1867 return 1;
1868 }
1869 }
1870 return 0;
1871}
150e3001
JT
1872
1873int has_sha1_pack(const unsigned char *sha1)
1874{
1875 struct pack_entry e;
1876 return find_pack_entry(sha1, &e);
1877}
f9a8672a
JT
1878
1879int has_pack_index(const unsigned char *sha1)
1880{
1881 struct stat st;
1882 if (stat(sha1_pack_index_name(sha1), &st))
1883 return 0;
1884 return 1;
1885}
7709f468
JT
1886
1887static int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn cb, void *data)
1888{
1889 uint32_t i;
1890 int r = 0;
1891
1892 for (i = 0; i < p->num_objects; i++) {
1893 struct object_id oid;
1894
1895 if (!nth_packed_object_oid(&oid, p, i))
1896 return error("unable to get sha1 of object %u in %s",
1897 i, p->pack_name);
1898
1899 r = cb(&oid, p, i, data);
1900 if (r)
1901 break;
1902 }
1903 return r;
1904}
1905
1906int for_each_packed_object(each_packed_object_fn cb, void *data, unsigned flags)
1907{
1908 struct packed_git *p;
1909 int r = 0;
1910 int pack_errors = 0;
1911
1912 prepare_packed_git();
a80d72db 1913 for (p = the_repository->objects->packed_git; p; p = p->next) {
7709f468
JT
1914 if ((flags & FOR_EACH_OBJECT_LOCAL_ONLY) && !p->pack_local)
1915 continue;
498f1f61
JT
1916 if ((flags & FOR_EACH_OBJECT_PROMISOR_ONLY) &&
1917 !p->pack_promisor)
1918 continue;
7709f468
JT
1919 if (open_pack_index(p)) {
1920 pack_errors = 1;
1921 continue;
1922 }
1923 r = for_each_object_in_pack(p, cb, data);
1924 if (r)
1925 break;
1926 }
1927 return r ? r : pack_errors;
1928}
498f1f61
JT
1929
1930static int add_promisor_object(const struct object_id *oid,
1931 struct packed_git *pack,
1932 uint32_t pos,
1933 void *set_)
1934{
1935 struct oidset *set = set_;
1936 struct object *obj = parse_object(oid);
1937 if (!obj)
1938 return 1;
1939
1940 oidset_insert(set, oid);
1941
1942 /*
1943 * If this is a tree, commit, or tag, the objects it refers
a80d72db 1944 * to are also promisor objects. (Blobs refer to no objects->)
498f1f61
JT
1945 */
1946 if (obj->type == OBJ_TREE) {
1947 struct tree *tree = (struct tree *)obj;
1948 struct tree_desc desc;
1949 struct name_entry entry;
1950 if (init_tree_desc_gently(&desc, tree->buffer, tree->size))
1951 /*
1952 * Error messages are given when packs are
1953 * verified, so do not print any here.
1954 */
1955 return 0;
1956 while (tree_entry_gently(&desc, &entry))
1957 oidset_insert(set, entry.oid);
1958 } else if (obj->type == OBJ_COMMIT) {
1959 struct commit *commit = (struct commit *) obj;
1960 struct commit_list *parents = commit->parents;
1961
1962 oidset_insert(set, &commit->tree->object.oid);
1963 for (; parents; parents = parents->next)
1964 oidset_insert(set, &parents->item->object.oid);
1965 } else if (obj->type == OBJ_TAG) {
1966 struct tag *tag = (struct tag *) obj;
1967 oidset_insert(set, &tag->tagged->oid);
1968 }
1969 return 0;
1970}
1971
1972int is_promisor_object(const struct object_id *oid)
1973{
1974 static struct oidset promisor_objects;
1975 static int promisor_objects_prepared;
1976
1977 if (!promisor_objects_prepared) {
1978 if (repository_format_partial_clone) {
1979 for_each_packed_object(add_promisor_object,
1980 &promisor_objects,
1981 FOR_EACH_OBJECT_PROMISOR_ONLY);
1982 }
1983 promisor_objects_prepared = 1;
1984 }
1985 return oidset_contains(&promisor_objects, oid);
1986}