Skip t3902-quoted.sh if the file system does not support funny names.
[git/git.git] / sha1_file.c
CommitLineData
0fcfd160
LT
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 */
0fcfd160 9#include "cache.h"
1f688557 10#include "delta.h"
a733cb60 11#include "pack.h"
8e440259
PE
12#include "blob.h"
13#include "commit.h"
14#include "tag.h"
15#include "tree.h"
f35a6d3b 16#include "refs.h"
0fcfd160 17
144bde78
LT
18#ifndef O_NOATIME
19#if defined(__linux__) && (defined(__i386__) || defined(__PPC__))
20#define O_NOATIME 01000000
21#else
22#define O_NOATIME 0
23#endif
24#endif
25
e05db0fd
PR
26#ifdef NO_C99_FORMAT
27#define SZ_FMT "lu"
28#else
29#define SZ_FMT "zu"
30#endif
31
96f1e58f 32const unsigned char null_sha1[20];
88cd621d 33
144bde78
LT
34static unsigned int sha1_file_open_flag = O_NOATIME;
35
192a6be2 36const signed char hexval_table[256] = {
e49521b5
JH
37 -1, -1, -1, -1, -1, -1, -1, -1, /* 00-07 */
38 -1, -1, -1, -1, -1, -1, -1, -1, /* 08-0f */
39 -1, -1, -1, -1, -1, -1, -1, -1, /* 10-17 */
40 -1, -1, -1, -1, -1, -1, -1, -1, /* 18-1f */
41 -1, -1, -1, -1, -1, -1, -1, -1, /* 20-27 */
42 -1, -1, -1, -1, -1, -1, -1, -1, /* 28-2f */
43 0, 1, 2, 3, 4, 5, 6, 7, /* 30-37 */
44 8, 9, -1, -1, -1, -1, -1, -1, /* 38-3f */
45 -1, 10, 11, 12, 13, 14, 15, -1, /* 40-47 */
46 -1, -1, -1, -1, -1, -1, -1, -1, /* 48-4f */
47 -1, -1, -1, -1, -1, -1, -1, -1, /* 50-57 */
48 -1, -1, -1, -1, -1, -1, -1, -1, /* 58-5f */
49 -1, 10, 11, 12, 13, 14, 15, -1, /* 60-67 */
50 -1, -1, -1, -1, -1, -1, -1, -1, /* 68-67 */
51 -1, -1, -1, -1, -1, -1, -1, -1, /* 70-77 */
52 -1, -1, -1, -1, -1, -1, -1, -1, /* 78-7f */
53 -1, -1, -1, -1, -1, -1, -1, -1, /* 80-87 */
54 -1, -1, -1, -1, -1, -1, -1, -1, /* 88-8f */
55 -1, -1, -1, -1, -1, -1, -1, -1, /* 90-97 */
56 -1, -1, -1, -1, -1, -1, -1, -1, /* 98-9f */
57 -1, -1, -1, -1, -1, -1, -1, -1, /* a0-a7 */
58 -1, -1, -1, -1, -1, -1, -1, -1, /* a8-af */
59 -1, -1, -1, -1, -1, -1, -1, -1, /* b0-b7 */
60 -1, -1, -1, -1, -1, -1, -1, -1, /* b8-bf */
61 -1, -1, -1, -1, -1, -1, -1, -1, /* c0-c7 */
62 -1, -1, -1, -1, -1, -1, -1, -1, /* c8-cf */
63 -1, -1, -1, -1, -1, -1, -1, -1, /* d0-d7 */
64 -1, -1, -1, -1, -1, -1, -1, -1, /* d8-df */
65 -1, -1, -1, -1, -1, -1, -1, -1, /* e0-e7 */
66 -1, -1, -1, -1, -1, -1, -1, -1, /* e8-ef */
67 -1, -1, -1, -1, -1, -1, -1, -1, /* f0-f7 */
68 -1, -1, -1, -1, -1, -1, -1, -1, /* f8-ff */
69};
0fcfd160
LT
70
71int get_sha1_hex(const char *hex, unsigned char *sha1)
72{
73 int i;
74 for (i = 0; i < 20; i++) {
75 unsigned int val = (hexval(hex[0]) << 4) | hexval(hex[1]);
76 if (val & ~0xff)
77 return -1;
78 *sha1++ = val;
79 hex += 2;
80 }
81 return 0;
82}
83
b2cb9425
JH
84int safe_create_leading_directories(char *path)
85{
86 char *pos = path;
67d42212
JR
87 struct stat st;
88
67ffdf4c
JS
89 if (*pos == '/')
90 pos++;
b2cb9425
JH
91
92 while (pos) {
93 pos = strchr(pos, '/');
94 if (!pos)
95 break;
96 *pos = 0;
67d42212
JR
97 if (!stat(path, &st)) {
98 /* path exists */
99 if (!S_ISDIR(st.st_mode)) {
b2cb9425 100 *pos = '/';
67d42212 101 return -3;
b2cb9425 102 }
457f06d6 103 }
67d42212
JR
104 else if (mkdir(path, 0777)) {
105 *pos = '/';
106 return -1;
107 }
457f06d6
JS
108 else if (adjust_shared_perm(path)) {
109 *pos = '/';
110 return -2;
111 }
b2cb9425
JH
112 *pos++ = '/';
113 }
114 return 0;
115}
723c31fe 116
0fcfd160
LT
117char * sha1_to_hex(const unsigned char *sha1)
118{
dcb3450f
LT
119 static int bufno;
120 static char hexbuffer[4][50];
0fcfd160 121 static const char hex[] = "0123456789abcdef";
dcb3450f 122 char *buffer = hexbuffer[3 & ++bufno], *buf = buffer;
0fcfd160
LT
123 int i;
124
125 for (i = 0; i < 20; i++) {
126 unsigned int val = *sha1++;
127 *buf++ = hex[val >> 4];
128 *buf++ = hex[val & 0xf];
129 }
1e80e044
JS
130 *buf = '\0';
131
0fcfd160
LT
132 return buffer;
133}
134
ace1534d
JH
135static void fill_sha1_path(char *pathbuf, const unsigned char *sha1)
136{
137 int i;
138 for (i = 0; i < 20; i++) {
139 static char hex[] = "0123456789abcdef";
140 unsigned int val = sha1[i];
141 char *pos = pathbuf + i*2 + (i > 0);
142 *pos++ = hex[val >> 4];
143 *pos = hex[val & 0xf];
144 }
145}
146
0fcfd160
LT
147/*
148 * NOTE! This returns a statically allocated buffer, so you have to be
9befac47 149 * careful about using it. Do a "xstrdup()" if you need to save the
0fcfd160 150 * filename.
ace1534d
JH
151 *
152 * Also note that this returns the location for creating. Reading
153 * SHA1 file can happen from any alternate directory listed in the
d19938ab 154 * DB_ENVIRONMENT environment variable if it is not found in
ace1534d 155 * the primary object database.
0fcfd160
LT
156 */
157char *sha1_file_name(const unsigned char *sha1)
158{
0fcfd160
LT
159 static char *name, *base;
160
161 if (!base) {
d19938ab 162 const char *sha1_file_directory = get_object_directory();
0fcfd160 163 int len = strlen(sha1_file_directory);
812666c8 164 base = xmalloc(len + 60);
0fcfd160
LT
165 memcpy(base, sha1_file_directory, len);
166 memset(base+len, 0, 60);
167 base[len] = '/';
168 base[len+3] = '/';
169 name = base + len + 1;
170 }
ace1534d 171 fill_sha1_path(name, sha1);
0fcfd160
LT
172 return base;
173}
174
bf592c50
DB
175char *sha1_pack_name(const unsigned char *sha1)
176{
177 static const char hex[] = "0123456789abcdef";
178 static char *name, *base, *buf;
179 int i;
180
181 if (!base) {
182 const char *sha1_file_directory = get_object_directory();
183 int len = strlen(sha1_file_directory);
184 base = xmalloc(len + 60);
185 sprintf(base, "%s/pack/pack-1234567890123456789012345678901234567890.pack", sha1_file_directory);
186 name = base + len + 11;
187 }
188
189 buf = name;
190
191 for (i = 0; i < 20; i++) {
192 unsigned int val = *sha1++;
193 *buf++ = hex[val >> 4];
194 *buf++ = hex[val & 0xf];
195 }
a6080a0a 196
bf592c50
DB
197 return base;
198}
199
200char *sha1_pack_index_name(const unsigned char *sha1)
201{
202 static const char hex[] = "0123456789abcdef";
203 static char *name, *base, *buf;
204 int i;
205
206 if (!base) {
207 const char *sha1_file_directory = get_object_directory();
208 int len = strlen(sha1_file_directory);
209 base = xmalloc(len + 60);
210 sprintf(base, "%s/pack/pack-1234567890123456789012345678901234567890.idx", sha1_file_directory);
211 name = base + len + 11;
212 }
213
214 buf = name;
215
216 for (i = 0; i < 20; i++) {
217 unsigned int val = *sha1++;
218 *buf++ = hex[val >> 4];
219 *buf++ = hex[val & 0xf];
220 }
a6080a0a 221
bf592c50
DB
222 return base;
223}
224
d5a63b99
JH
225struct alternate_object_database *alt_odb_list;
226static struct alternate_object_database **alt_odb_tail;
ace1534d 227
c2f493a4
MW
228static void read_info_alternates(const char * alternates, int depth);
229
ddd5d056
JH
230/*
231 * Prepare alternate object database registry.
d5a63b99
JH
232 *
233 * The variable alt_odb_list points at the list of struct
234 * alternate_object_database. The elements on this list come from
235 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
236 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
1494e038
JH
237 * whose contents is similar to that environment variable but can be
238 * LF separated. Its base points at a statically allocated buffer that
d5a63b99
JH
239 * contains "/the/directory/corresponding/to/.git/objects/...", while
240 * its name points just after the slash at the end of ".git/objects/"
241 * in the example above, and has enough space to hold 40-byte hex
242 * SHA1, an extra slash for the first level indirection, and the
243 * terminating NUL.
ddd5d056 244 */
c2f493a4 245static int link_alt_odb_entry(const char * entry, int len, const char * relative_base, int depth)
ace1534d 246{
c2f493a4 247 struct stat st;
1494e038 248 const char *objdir = get_object_directory();
c2f493a4
MW
249 struct alternate_object_database *ent;
250 struct alternate_object_database *alt;
251 /* 43 = 40-byte + 2 '/' + terminating NUL */
252 int pfxlen = len;
253 int entlen = pfxlen + 43;
ccfd3e99 254 int base_len = -1;
d5a63b99 255
c2f493a4
MW
256 if (*entry != '/' && relative_base) {
257 /* Relative alt-odb */
258 if (base_len < 0)
259 base_len = strlen(relative_base) + 1;
260 entlen += base_len;
261 pfxlen += base_len;
262 }
263 ent = xmalloc(sizeof(*ent) + entlen);
264
265 if (*entry != '/' && relative_base) {
266 memcpy(ent->base, relative_base, base_len - 1);
267 ent->base[base_len - 1] = '/';
268 memcpy(ent->base + base_len, entry, len);
269 }
270 else
271 memcpy(ent->base, entry, pfxlen);
272
273 ent->name = ent->base + pfxlen + 1;
274 ent->base[pfxlen + 3] = '/';
275 ent->base[pfxlen] = ent->base[entlen-1] = 0;
276
277 /* Detect cases where alternate disappeared */
278 if (stat(ent->base, &st) || !S_ISDIR(st.st_mode)) {
279 error("object directory %s does not exist; "
280 "check .git/objects/info/alternates.",
281 ent->base);
282 free(ent);
283 return -1;
284 }
285
286 /* Prevent the common mistake of listing the same
287 * thing twice, or object directory itself.
288 */
289 for (alt = alt_odb_list; alt; alt = alt->next) {
290 if (!memcmp(ent->base, alt->base, pfxlen)) {
291 free(ent);
292 return -1;
293 }
294 }
295 if (!memcmp(ent->base, objdir, pfxlen)) {
296 free(ent);
297 return -1;
298 }
299
300 /* add the alternate entry */
301 *alt_odb_tail = ent;
302 alt_odb_tail = &(ent->next);
303 ent->next = NULL;
304
305 /* recursively add alternates */
306 read_info_alternates(ent->base, depth + 1);
307
308 ent->base[pfxlen] = '/';
309
310 return 0;
311}
312
313static void link_alt_odb_entries(const char *alt, const char *ep, int sep,
314 const char *relative_base, int depth)
315{
316 const char *cp, *last;
317
318 if (depth > 5) {
319 error("%s: ignoring alternate object stores, nesting too deep.",
320 relative_base);
321 return;
322 }
323
d5a63b99 324 last = alt;
9577e7e3
JH
325 while (last < ep) {
326 cp = last;
327 if (cp < ep && *cp == '#') {
328 while (cp < ep && *cp != sep)
329 cp++;
330 last = cp + 1;
331 continue;
332 }
c2f493a4
MW
333 while (cp < ep && *cp != sep)
334 cp++;
d5a63b99 335 if (last != cp) {
c2f493a4
MW
336 if ((*last != '/') && depth) {
337 error("%s: ignoring relative alternate object store %s",
338 relative_base, last);
339 } else {
340 link_alt_odb_entry(last, cp - last,
341 relative_base, depth);
1494e038 342 }
d5a63b99 343 }
9577e7e3 344 while (cp < ep && *cp == sep)
d5a63b99
JH
345 cp++;
346 last = cp;
9577e7e3 347 }
d5a63b99
JH
348}
349
c2f493a4 350static void read_info_alternates(const char * relative_base, int depth)
d5a63b99 351{
9577e7e3 352 char *map;
dc49cd76 353 size_t mapsz;
d5a63b99 354 struct stat st;
9cb18f56
JM
355 const char alt_file_name[] = "info/alternates";
356 /* Given that relative_base is no longer than PATH_MAX,
357 ensure that "path" has enough space to append "/", the
358 file name, "info/alternates", and a trailing NUL. */
359 char path[PATH_MAX + 1 + sizeof alt_file_name];
c2f493a4 360 int fd;
d5a63b99 361
9cb18f56 362 sprintf(path, "%s/%s", relative_base, alt_file_name);
d5a63b99
JH
363 fd = open(path, O_RDONLY);
364 if (fd < 0)
365 return;
366 if (fstat(fd, &st) || (st.st_size == 0)) {
367 close(fd);
9a217f2a 368 return;
ace1534d 369 }
dc49cd76
SP
370 mapsz = xsize_t(st.st_size);
371 map = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, fd, 0);
d5a63b99 372 close(fd);
d5a63b99 373
dc49cd76 374 link_alt_odb_entries(map, map + mapsz, '\n', relative_base, depth);
c2f493a4 375
dc49cd76 376 munmap(map, mapsz);
ace1534d
JH
377}
378
c2f493a4
MW
379void prepare_alt_odb(void)
380{
554fe20d 381 const char *alt;
c2f493a4 382
7dc24aa5
SP
383 if (alt_odb_tail)
384 return;
385
c2f493a4
MW
386 alt = getenv(ALTERNATE_DB_ENVIRONMENT);
387 if (!alt) alt = "";
388
c2f493a4
MW
389 alt_odb_tail = &alt_odb_list;
390 link_alt_odb_entries(alt, alt + strlen(alt), ':', NULL, 0);
391
392 read_info_alternates(get_object_directory(), 0);
393}
394
ace1534d
JH
395static char *find_sha1_file(const unsigned char *sha1, struct stat *st)
396{
ace1534d 397 char *name = sha1_file_name(sha1);
d5a63b99 398 struct alternate_object_database *alt;
ace1534d
JH
399
400 if (!stat(name, st))
401 return name;
9a217f2a 402 prepare_alt_odb();
d5a63b99
JH
403 for (alt = alt_odb_list; alt; alt = alt->next) {
404 name = alt->name;
ace1534d 405 fill_sha1_path(name, sha1);
d5a63b99
JH
406 if (!stat(alt->base, st))
407 return alt->base;
ace1534d
JH
408 }
409 return NULL;
410}
411
60bb8b14 412static unsigned int pack_used_ctr;
a53128b6
SP
413static unsigned int pack_mmap_calls;
414static unsigned int peak_pack_open_windows;
415static unsigned int pack_open_windows;
416static size_t peak_pack_mapped;
60bb8b14 417static size_t pack_mapped;
9a217f2a 418struct packed_git *packed_git;
1f688557 419
b79d18c9 420void pack_report(void)
a53128b6
SP
421{
422 fprintf(stderr,
e05db0fd
PR
423 "pack_report: getpagesize() = %10" SZ_FMT "\n"
424 "pack_report: core.packedGitWindowSize = %10" SZ_FMT "\n"
425 "pack_report: core.packedGitLimit = %10" SZ_FMT "\n",
78a28df9 426 (size_t) getpagesize(),
a53128b6
SP
427 packed_git_window_size,
428 packed_git_limit);
429 fprintf(stderr,
430 "pack_report: pack_used_ctr = %10u\n"
431 "pack_report: pack_mmap_calls = %10u\n"
432 "pack_report: pack_open_windows = %10u / %10u\n"
e05db0fd
PR
433 "pack_report: pack_mapped = "
434 "%10" SZ_FMT " / %10" SZ_FMT "\n",
a53128b6
SP
435 pack_used_ctr,
436 pack_mmap_calls,
437 pack_open_windows, peak_pack_open_windows,
438 pack_mapped, peak_pack_mapped);
439}
440
42873078 441static int check_packed_git_idx(const char *path, struct packed_git *p)
1f688557
JH
442{
443 void *idx_map;
42873078 444 struct pack_idx_header *hdr;
dc49cd76 445 size_t idx_size;
74e34e1f 446 uint32_t version, nr, i, *index;
e93ec6f9 447 int fd = open(path, O_RDONLY);
1f688557 448 struct stat st;
42873078 449
1f688557
JH
450 if (fd < 0)
451 return -1;
452 if (fstat(fd, &st)) {
453 close(fd);
454 return -1;
455 }
dc49cd76 456 idx_size = xsize_t(st.st_size);
2d88451b
SP
457 if (idx_size < 4 * 256 + 20 + 20) {
458 close(fd);
459 return error("index file %s is too small", path);
460 }
c4712e45 461 idx_map = xmmap(NULL, idx_size, PROT_READ, MAP_PRIVATE, fd, 0);
1f688557 462 close(fd);
1f688557 463
42873078
NP
464 hdr = idx_map;
465 if (hdr->idx_signature == htonl(PACK_IDX_SIGNATURE)) {
74e34e1f
NP
466 version = ntohl(hdr->idx_version);
467 if (version < 2 || version > 2) {
468 munmap(idx_map, idx_size);
469 return error("index file %s is version %d"
470 " and is not supported by this binary"
471 " (try upgrading GIT to a newer version)",
472 path, version);
473 }
474 } else
475 version = 1;
df1b059d 476
1f688557 477 nr = 0;
42873078 478 index = idx_map;
74e34e1f
NP
479 if (version > 1)
480 index += 2; /* skip index header */
1f688557 481 for (i = 0; i < 256; i++) {
326bf396 482 uint32_t n = ntohl(index[i]);
2d88451b
SP
483 if (n < nr) {
484 munmap(idx_map, idx_size);
df1b059d 485 return error("non-monotonic index %s", path);
2d88451b 486 }
1f688557
JH
487 nr = n;
488 }
489
74e34e1f
NP
490 if (version == 1) {
491 /*
492 * Total size:
493 * - 256 index entries 4 bytes each
494 * - 24-byte entries * nr (20-byte sha1 + 4-byte offset)
495 * - 20-byte SHA1 of the packfile
496 * - 20-byte SHA1 file checksum
497 */
498 if (idx_size != 4*256 + nr * 24 + 20 + 20) {
499 munmap(idx_map, idx_size);
eef427a0 500 return error("wrong index v1 file size in %s", path);
74e34e1f
NP
501 }
502 } else if (version == 2) {
503 /*
504 * Minimum size:
505 * - 8 bytes of header
506 * - 256 index entries 4 bytes each
507 * - 20-byte sha1 entry * nr
508 * - 4-byte crc entry * nr
509 * - 4-byte offset entry * nr
510 * - 20-byte SHA1 of the packfile
511 * - 20-byte SHA1 file checksum
512 * And after the 4-byte offset table might be a
513 * variable sized table containing 8-byte entries
514 * for offsets larger than 2^31.
515 */
516 unsigned long min_size = 8 + 4*256 + nr*(20 + 4 + 4) + 20 + 20;
1164f1e4
LT
517 unsigned long max_size = min_size;
518 if (nr)
519 max_size += (nr - 1)*8;
520 if (idx_size < min_size || idx_size > max_size) {
74e34e1f 521 munmap(idx_map, idx_size);
eef427a0 522 return error("wrong index v2 file size in %s", path);
74e34e1f 523 }
7109c889
JH
524 if (idx_size != min_size &&
525 /*
526 * make sure we can deal with large pack offsets.
527 * 31-bit signed offset won't be enough, neither
528 * 32-bit unsigned one will be.
529 */
530 (sizeof(off_t) <= 4)) {
531 munmap(idx_map, idx_size);
532 return error("pack too large for current definition of off_t in %s", path);
74e34e1f 533 }
2d88451b 534 }
1f688557 535
74e34e1f 536 p->index_version = version;
42873078
NP
537 p->index_data = idx_map;
538 p->index_size = idx_size;
57059091 539 p->num_objects = nr;
1f688557
JH
540 return 0;
541}
542
bc8e478a 543int open_pack_index(struct packed_git *p)
d079837e
SP
544{
545 char *idx_name;
546 int ret;
547
548 if (p->index_data)
549 return 0;
550
551 idx_name = xstrdup(p->pack_name);
552 strcpy(idx_name + strlen(idx_name) - strlen(".pack"), ".idx");
553 ret = check_packed_git_idx(idx_name, p);
554 free(idx_name);
555 return ret;
556}
557
11daf39b
SP
558static void scan_windows(struct packed_git *p,
559 struct packed_git **lru_p,
560 struct pack_window **lru_w,
561 struct pack_window **lru_l)
1f688557 562{
11daf39b
SP
563 struct pack_window *w, *w_l;
564
565 for (w_l = NULL, w = p->windows; w; w = w->next) {
566 if (!w->inuse_cnt) {
567 if (!*lru_w || w->last_used < (*lru_w)->last_used) {
568 *lru_p = p;
569 *lru_w = w;
570 *lru_l = w_l;
54044bf8 571 }
54044bf8 572 }
11daf39b 573 w_l = w;
f9253394 574 }
11daf39b
SP
575}
576
d1efefa4 577static int unuse_one_window(struct packed_git *current, int keep_fd)
11daf39b
SP
578{
579 struct packed_git *p, *lru_p = NULL;
580 struct pack_window *lru_w = NULL, *lru_l = NULL;
581
582 if (current)
583 scan_windows(current, &lru_p, &lru_w, &lru_l);
584 for (p = packed_git; p; p = p->next)
585 scan_windows(p, &lru_p, &lru_w, &lru_l);
54044bf8
SP
586 if (lru_p) {
587 munmap(lru_w->base, lru_w->len);
588 pack_mapped -= lru_w->len;
589 if (lru_l)
590 lru_l->next = lru_w->next;
591 else {
592 lru_p->windows = lru_w->next;
d1efefa4 593 if (!lru_p->windows && lru_p->pack_fd != keep_fd) {
54044bf8
SP
594 close(lru_p->pack_fd);
595 lru_p->pack_fd = -1;
596 }
597 }
598 free(lru_w);
a53128b6 599 pack_open_windows--;
54044bf8
SP
600 return 1;
601 }
602 return 0;
f9253394
JH
603}
604
d1efefa4 605void release_pack_memory(size_t need, int fd)
97bfeb34
SP
606{
607 size_t cur = pack_mapped;
d1efefa4 608 while (need >= (cur - pack_mapped) && unuse_one_window(NULL, fd))
97bfeb34
SP
609 ; /* nothing */
610}
611
03e79c88 612void unuse_pack(struct pack_window **w_cursor)
f9253394 613{
03e79c88
SP
614 struct pack_window *w = *w_cursor;
615 if (w) {
616 w->inuse_cnt--;
617 *w_cursor = NULL;
618 }
1f688557
JH
619}
620
3cf8b462
SP
621/*
622 * Do not call this directly as this leaks p->pack_fd on error return;
623 * call open_packed_git() instead.
624 */
625static int open_packed_git_1(struct packed_git *p)
1f688557 626{
9bc879c1
SP
627 struct stat st;
628 struct pack_header hdr;
629 unsigned char sha1[20];
630 unsigned char *idx_sha1;
2c039da8 631 long fd_flag;
9bc879c1 632
d079837e
SP
633 if (!p->index_data && open_pack_index(p))
634 return error("packfile %s index unavailable", p->pack_name);
635
9bc879c1
SP
636 p->pack_fd = open(p->pack_name, O_RDONLY);
637 if (p->pack_fd < 0 || fstat(p->pack_fd, &st))
072db278 638 return -1;
9bc879c1
SP
639
640 /* If we created the struct before we had the pack we lack size. */
bf592c50 641 if (!p->pack_size) {
bf592c50 642 if (!S_ISREG(st.st_mode))
072db278 643 return error("packfile %s not a regular file", p->pack_name);
bf592c50 644 p->pack_size = st.st_size;
9bc879c1 645 } else if (p->pack_size != st.st_size)
072db278 646 return error("packfile %s size changed", p->pack_name);
9bc879c1 647
2c039da8
JH
648 /* We leave these file descriptors open with sliding mmap;
649 * there is no point keeping them open across exec(), though.
650 */
651 fd_flag = fcntl(p->pack_fd, F_GETFD, 0);
652 if (fd_flag < 0)
072db278 653 return error("cannot determine file descriptor flags");
2c039da8
JH
654 fd_flag |= FD_CLOEXEC;
655 if (fcntl(p->pack_fd, F_SETFD, fd_flag) == -1)
072db278 656 return error("cannot set FD_CLOEXEC");
2c039da8 657
9bc879c1 658 /* Verify we recognize this pack file format. */
e6e2bd62 659 if (read_in_full(p->pack_fd, &hdr, sizeof(hdr)) != sizeof(hdr))
072db278 660 return error("file %s is far too short to be a packfile", p->pack_name);
9bc879c1 661 if (hdr.hdr_signature != htonl(PACK_SIGNATURE))
072db278 662 return error("file %s is not a GIT packfile", p->pack_name);
9bc879c1 663 if (!pack_version_ok(hdr.hdr_version))
072db278 664 return error("packfile %s is version %u and not supported"
9bc879c1
SP
665 " (try upgrading GIT to a newer version)",
666 p->pack_name, ntohl(hdr.hdr_version));
667
668 /* Verify the pack matches its index. */
57059091 669 if (p->num_objects != ntohl(hdr.hdr_entries))
072db278 670 return error("packfile %s claims to have %u objects"
57059091
NP
671 " while index indicates %u objects",
672 p->pack_name, ntohl(hdr.hdr_entries),
673 p->num_objects);
9bc879c1 674 if (lseek(p->pack_fd, p->pack_size - sizeof(sha1), SEEK_SET) == -1)
072db278 675 return error("end of packfile %s is unavailable", p->pack_name);
e6e2bd62 676 if (read_in_full(p->pack_fd, sha1, sizeof(sha1)) != sizeof(sha1))
072db278 677 return error("packfile %s signature is unavailable", p->pack_name);
42873078 678 idx_sha1 = ((unsigned char *)p->index_data) + p->index_size - 40;
9bc879c1 679 if (hashcmp(sha1, idx_sha1))
072db278
SP
680 return error("packfile %s does not match index", p->pack_name);
681 return 0;
9bc879c1
SP
682}
683
3cf8b462
SP
684static int open_packed_git(struct packed_git *p)
685{
686 if (!open_packed_git_1(p))
687 return 0;
688 if (p->pack_fd != -1) {
689 close(p->pack_fd);
690 p->pack_fd = -1;
691 }
692 return -1;
693}
694
c4001d92 695static int in_window(struct pack_window *win, off_t offset)
60bb8b14
SP
696{
697 /* We must promise at least 20 bytes (one hash) after the
698 * offset is available from this window, otherwise the offset
699 * is not actually in this window and a different window (which
700 * has that one hash excess) must be used. This is to support
701 * the object header and delta base parsing routines below.
702 */
703 off_t win_off = win->offset;
704 return win_off <= offset
705 && (offset + 20) <= (win_off + win->len);
706}
707
03e79c88
SP
708unsigned char* use_pack(struct packed_git *p,
709 struct pack_window **w_cursor,
c4001d92 710 off_t offset,
03e79c88 711 unsigned int *left)
9bc879c1 712{
60bb8b14 713 struct pack_window *win = *w_cursor;
03e79c88 714
072db278
SP
715 if (p->pack_fd == -1 && open_packed_git(p))
716 die("packfile %s cannot be accessed", p->pack_name);
60bb8b14
SP
717
718 /* Since packfiles end in a hash of their content and its
719 * pointless to ask for an offset into the middle of that
720 * hash, and the in_window function above wouldn't match
721 * don't allow an offset too close to the end of the file.
722 */
723 if (offset > (p->pack_size - 20))
724 die("offset beyond end of packfile (truncated pack?)");
725
726 if (!win || !in_window(win, offset)) {
727 if (win)
728 win->inuse_cnt--;
729 for (win = p->windows; win; win = win->next) {
730 if (in_window(win, offset))
731 break;
732 }
733 if (!win) {
78a28df9 734 size_t window_align = packed_git_window_size / 2;
dc49cd76 735 off_t len;
60bb8b14 736 win = xcalloc(1, sizeof(*win));
78a28df9 737 win->offset = (offset / window_align) * window_align;
dc49cd76
SP
738 len = p->pack_size - win->offset;
739 if (len > packed_git_window_size)
740 len = packed_git_window_size;
741 win->len = (size_t)len;
60bb8b14 742 pack_mapped += win->len;
11daf39b 743 while (packed_git_limit < pack_mapped
d1efefa4 744 && unuse_one_window(p, p->pack_fd))
60bb8b14 745 ; /* nothing */
c4712e45 746 win->base = xmmap(NULL, win->len,
60bb8b14
SP
747 PROT_READ, MAP_PRIVATE,
748 p->pack_fd, win->offset);
749 if (win->base == MAP_FAILED)
73b4e4be
SP
750 die("packfile %s cannot be mapped: %s",
751 p->pack_name,
752 strerror(errno));
a53128b6
SP
753 pack_mmap_calls++;
754 pack_open_windows++;
755 if (pack_mapped > peak_pack_mapped)
756 peak_pack_mapped = pack_mapped;
757 if (pack_open_windows > peak_pack_open_windows)
758 peak_pack_open_windows = pack_open_windows;
60bb8b14
SP
759 win->next = p->windows;
760 p->windows = win;
761 }
1f688557 762 }
03e79c88
SP
763 if (win != *w_cursor) {
764 win->last_used = pack_used_ctr++;
765 win->inuse_cnt++;
766 *w_cursor = win;
767 }
60bb8b14 768 offset -= win->offset;
03e79c88 769 if (left)
dc49cd76 770 *left = win->len - xsize_t(offset);
03e79c88 771 return win->base + offset;
1f688557
JH
772}
773
42873078 774struct packed_git *add_packed_git(const char *path, int path_len, int local)
1f688557
JH
775{
776 struct stat st;
42873078 777 struct packed_git *p = xmalloc(sizeof(*p) + path_len + 2);
1f688557 778
42873078
NP
779 /*
780 * Make sure a corresponding .pack file exists and that
781 * the index looks sane.
782 */
783 path_len -= strlen(".idx");
784 if (path_len < 1)
1f688557 785 return NULL;
42873078
NP
786 memcpy(p->pack_name, path, path_len);
787 strcpy(p->pack_name + path_len, ".pack");
d079837e 788 if (stat(p->pack_name, &st) || !S_ISREG(st.st_mode)) {
42873078 789 free(p);
1f688557
JH
790 return NULL;
791 }
42873078 792
1f688557
JH
793 /* ok, it looks sane as far as we can check without
794 * actually mapping the pack file.
795 */
d079837e
SP
796 p->index_version = 0;
797 p->index_data = NULL;
798 p->index_size = 0;
799 p->num_objects = 0;
1f688557 800 p->pack_size = st.st_size;
1f688557 801 p->next = NULL;
c41ee586 802 p->windows = NULL;
9bc879c1 803 p->pack_fd = -1;
9d835df2 804 p->pack_local = local;
b867092f 805 p->mtime = st.st_mtime;
42873078
NP
806 if (path_len < 40 || get_sha1_hex(path + path_len - 40, p->sha1))
807 hashclr(p->sha1);
1f688557
JH
808 return p;
809}
810
bf592c50 811struct packed_git *parse_pack_index(unsigned char *sha1)
c508df5e
DB
812{
813 char *path = sha1_pack_index_name(sha1);
814 return parse_pack_index_file(sha1, path);
815}
816
42873078
NP
817struct packed_git *parse_pack_index_file(const unsigned char *sha1,
818 const char *idx_path)
bf592c50 819{
42873078
NP
820 const char *path = sha1_pack_name(sha1);
821 struct packed_git *p = xmalloc(sizeof(*p) + strlen(path) + 2);
bf592c50 822
42873078
NP
823 if (check_packed_git_idx(idx_path, p)) {
824 free(p);
bf592c50 825 return NULL;
42873078 826 }
bf592c50 827
bf592c50 828 strcpy(p->pack_name, path);
bf592c50 829 p->pack_size = 0;
bf592c50 830 p->next = NULL;
c41ee586 831 p->windows = NULL;
9bc879c1 832 p->pack_fd = -1;
e702496e 833 hashcpy(p->sha1, sha1);
bf592c50
DB
834 return p;
835}
836
837void install_packed_git(struct packed_git *pack)
838{
839 pack->next = packed_git;
840 packed_git = pack;
841}
842
9d835df2 843static void prepare_packed_git_one(char *objdir, int local)
1f688557 844{
9cb18f56
JM
845 /* Ensure that this buffer is large enough so that we can
846 append "/pack/" without clobbering the stack even if
847 strlen(objdir) were PATH_MAX. */
848 char path[PATH_MAX + 1 + 4 + 1 + 1];
1f688557
JH
849 int len;
850 DIR *dir;
851 struct dirent *de;
852
853 sprintf(path, "%s/pack", objdir);
854 len = strlen(path);
855 dir = opendir(path);
b5b16990 856 if (!dir) {
26125f6b 857 if (errno != ENOENT)
bd2afde8 858 error("unable to open object pack directory: %s: %s",
26125f6b 859 path, strerror(errno));
1f688557 860 return;
b5b16990 861 }
1f688557
JH
862 path[len++] = '/';
863 while ((de = readdir(dir)) != NULL) {
864 int namelen = strlen(de->d_name);
865 struct packed_git *p;
866
5bb1cda5 867 if (!has_extension(de->d_name, ".idx"))
1f688557
JH
868 continue;
869
9cb18f56
JM
870 if (len + namelen + 1 > sizeof(path))
871 continue;
872
54a15a8d 873 /* Don't reopen a pack we already have. */
1f688557 874 strcpy(path + len, de->d_name);
86f7780c
JK
875 for (p = packed_git; p; p = p->next) {
876 if (!memcmp(path, p->pack_name, len + namelen - 4))
877 break;
878 }
879 if (p)
880 continue;
54a15a8d
SP
881 /* See if it really is a valid .idx file with corresponding
882 * .pack file that we can map.
883 */
9d835df2 884 p = add_packed_git(path, len + namelen, local);
1f688557
JH
885 if (!p)
886 continue;
625e9421 887 install_packed_git(p);
1f688557 888 }
5b35bcd5 889 closedir(dir);
1f688557
JH
890}
891
b867092f
JH
892static int sort_pack(const void *a_, const void *b_)
893{
894 struct packed_git *a = *((struct packed_git **)a_);
895 struct packed_git *b = *((struct packed_git **)b_);
896 int st;
897
898 /*
899 * Local packs tend to contain objects specific to our
900 * variant of the project than remote ones. In addition,
901 * remote ones could be on a network mounted filesystem.
902 * Favor local ones for these reasons.
903 */
904 st = a->pack_local - b->pack_local;
905 if (st)
906 return -st;
907
908 /*
909 * Younger packs tend to contain more recent objects,
910 * and more recent objects tend to get accessed more
911 * often.
912 */
913 if (a->mtime < b->mtime)
914 return 1;
915 else if (a->mtime == b->mtime)
916 return 0;
917 return -1;
918}
919
920static void rearrange_packed_git(void)
921{
922 struct packed_git **ary, *p;
923 int i, n;
924
925 for (n = 0, p = packed_git; p; p = p->next)
926 n++;
927 if (n < 2)
928 return;
929
930 /* prepare an array of packed_git for easier sorting */
931 ary = xcalloc(n, sizeof(struct packed_git *));
932 for (n = 0, p = packed_git; p; p = p->next)
933 ary[n++] = p;
934
935 qsort(ary, n, sizeof(struct packed_git *), sort_pack);
936
937 /* link them back again */
938 for (i = 0; i < n - 1; i++)
939 ary[i]->next = ary[i + 1];
940 ary[n - 1]->next = NULL;
941 packed_git = ary[0];
942
943 free(ary);
944}
945
637cdd9d 946static int prepare_packed_git_run_once = 0;
9a217f2a 947void prepare_packed_git(void)
1f688557 948{
d5a63b99 949 struct alternate_object_database *alt;
1f688557 950
637cdd9d 951 if (prepare_packed_git_run_once)
1f688557 952 return;
9d835df2 953 prepare_packed_git_one(get_object_directory(), 1);
9a217f2a 954 prepare_alt_odb();
d5a63b99 955 for (alt = alt_odb_list; alt; alt = alt->next) {
1494e038 956 alt->name[-1] = 0;
9d835df2 957 prepare_packed_git_one(alt->base, 0);
1494e038 958 alt->name[-1] = '/';
1f688557 959 }
b867092f 960 rearrange_packed_git();
637cdd9d
JK
961 prepare_packed_git_run_once = 1;
962}
963
fc04c412 964void reprepare_packed_git(void)
637cdd9d
JK
965{
966 prepare_packed_git_run_once = 0;
967 prepare_packed_git();
1f688557
JH
968}
969
5d6ccf5c 970int check_sha1_signature(const unsigned char *sha1, void *map, unsigned long size, const char *type)
0fcfd160
LT
971{
972 unsigned char real_sha1[20];
7cfb5f36 973 hash_sha1_file(map, size, type, real_sha1);
a89fccd2 974 return hashcmp(sha1, real_sha1) ? -1 : 0;
0fcfd160
LT
975}
976
4175e9e3 977static void *map_sha1_file(const unsigned char *sha1, unsigned long *size)
0fcfd160 978{
0fcfd160
LT
979 struct stat st;
980 void *map;
144bde78 981 int fd;
ace1534d
JH
982 char *filename = find_sha1_file(sha1, &st);
983
984 if (!filename) {
ace1534d
JH
985 return NULL;
986 }
0fcfd160 987
144bde78 988 fd = open(filename, O_RDONLY | sha1_file_open_flag);
0fcfd160 989 if (fd < 0) {
144bde78
LT
990 /* See if it works without O_NOATIME */
991 switch (sha1_file_open_flag) {
992 default:
993 fd = open(filename, O_RDONLY);
994 if (fd >= 0)
995 break;
996 /* Fallthrough */
997 case 0:
144bde78
LT
998 return NULL;
999 }
1000
1f688557
JH
1001 /* If it failed once, it will probably fail again.
1002 * Stop using O_NOATIME
1003 */
144bde78 1004 sha1_file_open_flag = 0;
0fcfd160 1005 }
dc49cd76
SP
1006 *size = xsize_t(st.st_size);
1007 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
0fcfd160 1008 close(fd);
0fcfd160
LT
1009 return map;
1010}
1011
726f852b 1012static int legacy_loose_object(unsigned char *map)
bb6b8e4f
JH
1013{
1014 unsigned int word;
1015
1016 /*
1017 * Is it a zlib-compressed buffer? If so, the first byte
1018 * must be 0x78 (15-bit window size, deflated), and the
1019 * first 16-bit word is evenly divisible by 31
1020 */
1021 word = (map[0] << 8) + map[1];
1022 if (map[0] == 0x78 && !(word % 31))
1023 return 1;
1024 else
1025 return 0;
1026}
1027
72518e9c 1028unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep)
c4483576 1029{
ad1ed5ee 1030 unsigned shift;
93821bd9 1031 unsigned char c;
93821bd9 1032 unsigned long size;
ad1ed5ee
JH
1033 unsigned long used = 0;
1034
1035 c = buf[used++];
1036 *type = (c >> 4) & 7;
1037 size = c & 15;
1038 shift = 4;
1039 while (c & 0x80) {
1040 if (len <= used)
1041 return 0;
1042 if (sizeof(long) * 8 <= shift)
1043 return 0;
1044 c = buf[used++];
1045 size += (c & 0x7f) << shift;
1046 shift += 7;
1047 }
1048 *sizep = size;
1049 return used;
1050}
1051
1052static int unpack_sha1_header(z_stream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz)
1053{
1054 unsigned long size, used;
1055 static const char valid_loose_object_type[8] = {
1056 0, /* OBJ_EXT */
1057 1, 1, 1, 1, /* "commit", "tree", "blob", "tag" */
1058 0, /* "delta" and others are invalid in a loose object */
93821bd9 1059 };
ad1ed5ee 1060 enum object_type type;
93821bd9 1061
c4483576
LT
1062 /* Get the data stream */
1063 memset(stream, 0, sizeof(*stream));
1064 stream->next_in = map;
1065 stream->avail_in = mapsize;
1066 stream->next_out = buffer;
93821bd9
LT
1067 stream->avail_out = bufsiz;
1068
bb6b8e4f 1069 if (legacy_loose_object(map)) {
93821bd9
LT
1070 inflateInit(stream);
1071 return inflate(stream, 0);
1072 }
1073
726f852b
NP
1074
1075 /*
1076 * There used to be a second loose object header format which
1077 * was meant to mimic the in-pack format, allowing for direct
1078 * copy of the object data. This format turned up not to be
1079 * really worth it and we don't write it any longer. But we
1080 * can still read it.
1081 */
ad1ed5ee
JH
1082 used = unpack_object_header_gently(map, mapsize, &type, &size);
1083 if (!used || !valid_loose_object_type[type])
93821bd9 1084 return -1;
ad1ed5ee
JH
1085 map += used;
1086 mapsize -= used;
93821bd9
LT
1087
1088 /* Set up the stream for the rest.. */
1089 stream->next_in = map;
1090 stream->avail_in = mapsize;
c4483576 1091 inflateInit(stream);
93821bd9
LT
1092
1093 /* And generate the fake traditional header */
ad1ed5ee 1094 stream->total_out = 1 + snprintf(buffer, bufsiz, "%s %lu",
df843662 1095 typename(type), size);
93821bd9 1096 return 0;
c4483576
LT
1097}
1098
7efbff75 1099static void *unpack_sha1_rest(z_stream *stream, void *buffer, unsigned long size, const unsigned char *sha1)
5180cacc
LT
1100{
1101 int bytes = strlen(buffer) + 1;
d565b341 1102 unsigned char *buf = xmalloc(1+size);
93821bd9 1103 unsigned long n;
7efbff75 1104 int status = Z_OK;
5180cacc 1105
93821bd9
LT
1106 n = stream->total_out - bytes;
1107 if (n > size)
1108 n = size;
1109 memcpy(buf, (char *) buffer + bytes, n);
1110 bytes = n;
456cdf6e
LT
1111 if (bytes <= size) {
1112 /*
1113 * The above condition must be (bytes <= size), not
1114 * (bytes < size). In other words, even though we
1115 * expect no more output and set avail_out to zer0,
1116 * the input zlib stream may have bytes that express
1117 * "this concludes the stream", and we *do* want to
1118 * eat that input.
1119 *
1120 * Otherwise we would not be able to test that we
1121 * consumed all the input to reach the expected size;
1122 * we also want to check that zlib tells us that all
1123 * went well with status == Z_STREAM_END at the end.
1124 */
5180cacc
LT
1125 stream->next_out = buf + bytes;
1126 stream->avail_out = size - bytes;
7efbff75
JH
1127 while (status == Z_OK)
1128 status = inflate(stream, Z_FINISH);
5180cacc
LT
1129 }
1130 buf[size] = 0;
456cdf6e 1131 if (status == Z_STREAM_END && !stream->avail_in) {
7efbff75
JH
1132 inflateEnd(stream);
1133 return buf;
1134 }
1135
1136 if (status < 0)
1137 error("corrupt loose object '%s'", sha1_to_hex(sha1));
1138 else if (stream->avail_in)
1139 error("garbage at end of loose object '%s'",
1140 sha1_to_hex(sha1));
1141 free(buf);
1142 return NULL;
5180cacc
LT
1143}
1144
1145/*
1146 * We used to just use "sscanf()", but that's actually way
1147 * too permissive for what we want to check. So do an anal
1148 * object header parse by hand.
1149 */
21666f1a 1150static int parse_sha1_header(const char *hdr, unsigned long *sizep)
5180cacc 1151{
21666f1a 1152 char type[10];
5180cacc
LT
1153 int i;
1154 unsigned long size;
1155
1156 /*
a6080a0a 1157 * The type can be at most ten bytes (including the
5180cacc 1158 * terminating '\0' that we add), and is followed by
21666f1a 1159 * a space.
5180cacc 1160 */
21666f1a 1161 i = 0;
5180cacc
LT
1162 for (;;) {
1163 char c = *hdr++;
1164 if (c == ' ')
1165 break;
21666f1a
NP
1166 type[i++] = c;
1167 if (i >= sizeof(type))
5180cacc 1168 return -1;
5180cacc 1169 }
21666f1a 1170 type[i] = 0;
5180cacc
LT
1171
1172 /*
1173 * The length must follow immediately, and be in canonical
1174 * decimal format (ie "010" is not valid).
1175 */
1176 size = *hdr++ - '0';
1177 if (size > 9)
1178 return -1;
1179 if (size) {
1180 for (;;) {
1181 unsigned long c = *hdr - '0';
1182 if (c > 9)
1183 break;
1184 hdr++;
1185 size = size * 10 + c;
1186 }
1187 }
1188 *sizep = size;
1189
1190 /*
1191 * The length must be followed by a zero byte
1192 */
21666f1a 1193 return *hdr ? -1 : type_from_string(type);
5180cacc
LT
1194}
1195
7efbff75 1196static void *unpack_sha1_file(void *map, unsigned long mapsize, enum object_type *type, unsigned long *size, const unsigned char *sha1)
0fcfd160 1197{
5180cacc 1198 int ret;
0fcfd160 1199 z_stream stream;
5180cacc 1200 char hdr[8192];
0fcfd160 1201
5180cacc 1202 ret = unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr));
21666f1a 1203 if (ret < Z_OK || (*type = parse_sha1_header(hdr, size)) < 0)
0fcfd160
LT
1204 return NULL;
1205
7efbff75 1206 return unpack_sha1_rest(&stream, hdr, *size, sha1);
0fcfd160
LT
1207}
1208
54dab52a
NP
1209unsigned long get_size_from_delta(struct packed_git *p,
1210 struct pack_window **w_curs,
1211 off_t curpos)
1212{
1213 const unsigned char *data;
1214 unsigned char delta_head[20], *in;
1215 z_stream stream;
1216 int st;
1217
1218 memset(&stream, 0, sizeof(stream));
1219 stream.next_out = delta_head;
1220 stream.avail_out = sizeof(delta_head);
1221
1222 inflateInit(&stream);
1223 do {
1224 in = use_pack(p, w_curs, curpos, &stream.avail_in);
1225 stream.next_in = in;
1226 st = inflate(&stream, Z_FINISH);
1227 curpos += stream.next_in - in;
1228 } while ((st == Z_OK || st == Z_BUF_ERROR) &&
1229 stream.total_out < sizeof(delta_head));
1230 inflateEnd(&stream);
1231 if ((st != Z_STREAM_END) && stream.total_out != sizeof(delta_head))
1232 die("delta data unpack-initial failed");
1233
1234 /* Examine the initial part of the delta to figure out
1235 * the result size.
1236 */
1237 data = delta_head;
1238
1239 /* ignore base size */
1240 get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1241
1242 /* Read the result size */
1243 return get_delta_hdr_size(&data, delta_head+sizeof(delta_head));
1244}
1245
c4001d92 1246static off_t get_delta_base(struct packed_git *p,
03e79c88 1247 struct pack_window **w_curs,
c4001d92 1248 off_t *curpos,
21666f1a 1249 enum object_type type,
c4001d92 1250 off_t delta_obj_offset)
eb32d236 1251{
2b87c45b 1252 unsigned char *base_info = use_pack(p, w_curs, *curpos, NULL);
c4001d92 1253 off_t base_offset;
eb32d236 1254
8d8a4ea5
SP
1255 /* use_pack() assured us we have [base_info, base_info + 20)
1256 * as a range that we can look at without walking off the
1257 * end of the mapped window. Its actually the hash size
1258 * that is assured. An OFS_DELTA longer than the hash size
1259 * is stupid, as then a REF_DELTA would be smaller to store.
1260 */
21666f1a 1261 if (type == OBJ_OFS_DELTA) {
eb32d236
NP
1262 unsigned used = 0;
1263 unsigned char c = base_info[used++];
1264 base_offset = c & 127;
1265 while (c & 128) {
1266 base_offset += 1;
8723f216 1267 if (!base_offset || MSB(base_offset, 7))
eb32d236
NP
1268 die("offset value overflow for delta base object");
1269 c = base_info[used++];
1270 base_offset = (base_offset << 7) + (c & 127);
1271 }
1272 base_offset = delta_obj_offset - base_offset;
1273 if (base_offset >= delta_obj_offset)
1274 die("delta base offset out of bound");
2b87c45b 1275 *curpos += used;
21666f1a 1276 } else if (type == OBJ_REF_DELTA) {
eb32d236
NP
1277 /* The base entry _must_ be in the same pack */
1278 base_offset = find_pack_entry_one(base_info, p);
1279 if (!base_offset)
1280 die("failed to find delta-pack base object %s",
1281 sha1_to_hex(base_info));
2b87c45b 1282 *curpos += 20;
eb32d236
NP
1283 } else
1284 die("I am totally screwed");
2b87c45b 1285 return base_offset;
eb32d236
NP
1286}
1287
f3bf9224 1288/* forward declaration for a mutually recursive function */
c4001d92 1289static int packed_object_info(struct packed_git *p, off_t offset,
21666f1a 1290 unsigned long *sizep);
f3bf9224 1291
43057304 1292static int packed_delta_info(struct packed_git *p,
03e79c88 1293 struct pack_window **w_curs,
c4001d92 1294 off_t curpos,
21666f1a 1295 enum object_type type,
c4001d92 1296 off_t obj_offset,
43057304 1297 unsigned long *sizep)
5db47c2b 1298{
c4001d92 1299 off_t base_offset;
f3bf9224 1300
21666f1a
NP
1301 base_offset = get_delta_base(p, w_curs, &curpos, type, obj_offset);
1302 type = packed_object_info(p, base_offset, NULL);
f3bf9224 1303
c62266f3
JH
1304 /* We choose to only get the type of the base object and
1305 * ignore potentially corrupt pack file that expects the delta
1306 * based on a base with a wrong size. This saves tons of
1307 * inflate() calls.
1308 */
54dab52a
NP
1309 if (sizep)
1310 *sizep = get_size_from_delta(p, w_curs, curpos);
21666f1a
NP
1311
1312 return type;
5db47c2b
JH
1313}
1314
2b87c45b
NP
1315static int unpack_object_header(struct packed_git *p,
1316 struct pack_window **w_curs,
c4001d92 1317 off_t *curpos,
2b87c45b 1318 unsigned long *sizep)
a733cb60 1319{
03e79c88
SP
1320 unsigned char *base;
1321 unsigned int left;
ad1ed5ee 1322 unsigned long used;
2b87c45b 1323 enum object_type type;
a733cb60 1324
8d8a4ea5
SP
1325 /* use_pack() assures us we have [base, base + 20) available
1326 * as a range that we can look at at. (Its actually the hash
3dff5379 1327 * size that is assured.) With our object header encoding
8d8a4ea5
SP
1328 * the maximum deflated object size is 2^137, which is just
1329 * insane, so we know won't exceed what we have been given.
1330 */
2b87c45b
NP
1331 base = use_pack(p, w_curs, *curpos, &left);
1332 used = unpack_object_header_gently(base, left, &type, sizep);
ad1ed5ee
JH
1333 if (!used)
1334 die("object offset outside of pack file");
2b87c45b 1335 *curpos += used;
ad1ed5ee 1336
2b87c45b 1337 return type;
a733cb60
LT
1338}
1339
21666f1a 1340const char *packed_object_info_detail(struct packed_git *p,
c4001d92 1341 off_t obj_offset,
21666f1a
NP
1342 unsigned long *size,
1343 unsigned long *store_size,
1344 unsigned int *delta_chain_length,
1345 unsigned char *base_sha1)
ad8c80a5 1346{
03e79c88 1347 struct pack_window *w_curs = NULL;
c4001d92
SP
1348 off_t curpos;
1349 unsigned long dummy;
43057304 1350 unsigned char *next_sha1;
21666f1a 1351 enum object_type type;
ad8c80a5 1352
43057304 1353 *delta_chain_length = 0;
2b87c45b 1354 curpos = obj_offset;
21666f1a 1355 type = unpack_object_header(p, &w_curs, &curpos, size);
43057304
NP
1356
1357 for (;;) {
21666f1a 1358 switch (type) {
43057304 1359 default:
08a19d87 1360 die("pack %s contains unknown object type %d",
21666f1a 1361 p->pack_name, type);
43057304
NP
1362 case OBJ_COMMIT:
1363 case OBJ_TREE:
1364 case OBJ_BLOB:
1365 case OBJ_TAG:
43057304 1366 *store_size = 0; /* notyet */
03e79c88 1367 unuse_pack(&w_curs);
21666f1a 1368 return typename(type);
eb32d236 1369 case OBJ_OFS_DELTA:
21666f1a 1370 obj_offset = get_delta_base(p, &w_curs, &curpos, type, obj_offset);
eb32d236 1371 if (*delta_chain_length == 0) {
2b87c45b 1372 /* TODO: find base_sha1 as pointed by curpos */
30fee062 1373 hashclr(base_sha1);
eb32d236
NP
1374 }
1375 break;
1376 case OBJ_REF_DELTA:
2b87c45b 1377 next_sha1 = use_pack(p, &w_curs, curpos, NULL);
43057304
NP
1378 if (*delta_chain_length == 0)
1379 hashcpy(base_sha1, next_sha1);
2b87c45b 1380 obj_offset = find_pack_entry_one(next_sha1, p);
43057304
NP
1381 break;
1382 }
43057304 1383 (*delta_chain_length)++;
2b87c45b 1384 curpos = obj_offset;
21666f1a 1385 type = unpack_object_header(p, &w_curs, &curpos, &dummy);
ad8c80a5 1386 }
ad8c80a5
JH
1387}
1388
c4001d92 1389static int packed_object_info(struct packed_git *p, off_t obj_offset,
21666f1a 1390 unsigned long *sizep)
1f688557 1391{
03e79c88 1392 struct pack_window *w_curs = NULL;
c4001d92
SP
1393 unsigned long size;
1394 off_t curpos = obj_offset;
21666f1a 1395 enum object_type type;
5db47c2b 1396
21666f1a 1397 type = unpack_object_header(p, &w_curs, &curpos, &size);
5db47c2b 1398
21666f1a 1399 switch (type) {
eb32d236
NP
1400 case OBJ_OFS_DELTA:
1401 case OBJ_REF_DELTA:
21666f1a
NP
1402 type = packed_delta_info(p, &w_curs, curpos,
1403 type, obj_offset, sizep);
2b87c45b 1404 break;
a733cb60 1405 case OBJ_COMMIT:
a733cb60 1406 case OBJ_TREE:
a733cb60 1407 case OBJ_BLOB:
a733cb60 1408 case OBJ_TAG:
2b87c45b
NP
1409 if (sizep)
1410 *sizep = size;
a69d0943 1411 break;
1f688557 1412 default:
08a19d87 1413 die("pack %s contains unknown object type %d",
21666f1a 1414 p->pack_name, type);
1f688557 1415 }
2b87c45b 1416 unuse_pack(&w_curs);
21666f1a 1417 return type;
1f688557
JH
1418}
1419
eb950c19 1420static void *unpack_compressed_entry(struct packed_git *p,
03e79c88 1421 struct pack_window **w_curs,
c4001d92 1422 off_t curpos,
eb950c19 1423 unsigned long size)
de530aaa
SP
1424{
1425 int st;
1426 z_stream stream;
079afb18 1427 unsigned char *buffer, *in;
de530aaa
SP
1428
1429 buffer = xmalloc(size + 1);
1430 buffer[size] = 0;
1431 memset(&stream, 0, sizeof(stream));
de530aaa
SP
1432 stream.next_out = buffer;
1433 stream.avail_out = size;
1434
1435 inflateInit(&stream);
079afb18 1436 do {
2b87c45b 1437 in = use_pack(p, w_curs, curpos, &stream.avail_in);
079afb18
SP
1438 stream.next_in = in;
1439 st = inflate(&stream, Z_FINISH);
2b87c45b 1440 curpos += stream.next_in - in;
079afb18 1441 } while (st == Z_OK || st == Z_BUF_ERROR);
de530aaa
SP
1442 inflateEnd(&stream);
1443 if ((st != Z_STREAM_END) || stream.total_out != size) {
1444 free(buffer);
1445 return NULL;
1446 }
1447
1448 return buffer;
1449}
1450
e5e01619
LT
1451#define MAX_DELTA_CACHE (256)
1452
18bdec11 1453static size_t delta_base_cached;
5e08ecbf
NP
1454
1455static struct delta_base_cache_lru_list {
1456 struct delta_base_cache_lru_list *prev;
1457 struct delta_base_cache_lru_list *next;
1458} delta_base_cache_lru = { &delta_base_cache_lru, &delta_base_cache_lru };
1459
e5e01619 1460static struct delta_base_cache_entry {
5e08ecbf
NP
1461 struct delta_base_cache_lru_list lru;
1462 void *data;
e5e01619
LT
1463 struct packed_git *p;
1464 off_t base_offset;
1465 unsigned long size;
e5e01619
LT
1466 enum object_type type;
1467} delta_base_cache[MAX_DELTA_CACHE];
1468
1469static unsigned long pack_entry_hash(struct packed_git *p, off_t base_offset)
1470{
1471 unsigned long hash;
1472
1473 hash = (unsigned long)p + (unsigned long)base_offset;
1474 hash += (hash >> 8) + (hash >> 16);
3358004a 1475 return hash % MAX_DELTA_CACHE;
e5e01619
LT
1476}
1477
62f255ad 1478static void *cache_or_unpack_entry(struct packed_git *p, off_t base_offset,
a0cba108 1479 unsigned long *base_size, enum object_type *type, int keep_cache)
62f255ad 1480{
e5e01619
LT
1481 void *ret;
1482 unsigned long hash = pack_entry_hash(p, base_offset);
1483 struct delta_base_cache_entry *ent = delta_base_cache + hash;
1484
1485 ret = ent->data;
1486 if (ret && ent->p == p && ent->base_offset == base_offset)
1487 goto found_cache_entry;
62f255ad 1488 return unpack_entry(p, base_offset, type, base_size);
e5e01619
LT
1489
1490found_cache_entry:
18bdec11 1491 if (!keep_cache) {
a0cba108 1492 ent->data = NULL;
5e08ecbf
NP
1493 ent->lru.next->prev = ent->lru.prev;
1494 ent->lru.prev->next = ent->lru.next;
18bdec11 1495 delta_base_cached -= ent->size;
182af834
PH
1496 } else {
1497 ret = xmemdupz(ent->data, ent->size);
a0cba108 1498 }
e5e01619
LT
1499 *type = ent->type;
1500 *base_size = ent->size;
1501 return ret;
62f255ad
LT
1502}
1503
18bdec11
SP
1504static inline void release_delta_base_cache(struct delta_base_cache_entry *ent)
1505{
1506 if (ent->data) {
1507 free(ent->data);
1508 ent->data = NULL;
5e08ecbf
NP
1509 ent->lru.next->prev = ent->lru.prev;
1510 ent->lru.prev->next = ent->lru.next;
18bdec11
SP
1511 delta_base_cached -= ent->size;
1512 }
1513}
1514
62f255ad
LT
1515static void add_delta_base_cache(struct packed_git *p, off_t base_offset,
1516 void *base, unsigned long base_size, enum object_type type)
1517{
5e08ecbf 1518 unsigned long hash = pack_entry_hash(p, base_offset);
e5e01619 1519 struct delta_base_cache_entry *ent = delta_base_cache + hash;
5e08ecbf 1520 struct delta_base_cache_lru_list *lru;
e5e01619 1521
18bdec11
SP
1522 release_delta_base_cache(ent);
1523 delta_base_cached += base_size;
5e08ecbf
NP
1524
1525 for (lru = delta_base_cache_lru.next;
1526 delta_base_cached > delta_base_cache_limit
1527 && lru != &delta_base_cache_lru;
1528 lru = lru->next) {
1529 struct delta_base_cache_entry *f = (void *)lru;
18bdec11
SP
1530 if (f->type == OBJ_BLOB)
1531 release_delta_base_cache(f);
1532 }
5e08ecbf
NP
1533 for (lru = delta_base_cache_lru.next;
1534 delta_base_cached > delta_base_cache_limit
1535 && lru != &delta_base_cache_lru;
1536 lru = lru->next) {
1537 struct delta_base_cache_entry *f = (void *)lru;
1538 release_delta_base_cache(f);
1539 }
18bdec11 1540
e5e01619
LT
1541 ent->p = p;
1542 ent->base_offset = base_offset;
1543 ent->type = type;
1544 ent->data = base;
1545 ent->size = base_size;
5e08ecbf
NP
1546 ent->lru.next = &delta_base_cache_lru;
1547 ent->lru.prev = delta_base_cache_lru.prev;
1548 delta_base_cache_lru.prev->next = &ent->lru;
1549 delta_base_cache_lru.prev = &ent->lru;
62f255ad
LT
1550}
1551
eb950c19 1552static void *unpack_delta_entry(struct packed_git *p,
03e79c88 1553 struct pack_window **w_curs,
c4001d92 1554 off_t curpos,
1f688557 1555 unsigned long delta_size,
c4001d92 1556 off_t obj_offset,
21666f1a 1557 enum object_type *type,
eb950c19 1558 unsigned long *sizep)
1f688557 1559{
7c3e8be3 1560 void *delta_data, *result, *base;
c4001d92
SP
1561 unsigned long base_size;
1562 off_t base_offset;
43057304 1563
21666f1a 1564 base_offset = get_delta_base(p, w_curs, &curpos, *type, obj_offset);
a0cba108 1565 base = cache_or_unpack_entry(p, base_offset, &base_size, type, 0);
67686d95 1566 if (!base)
c4001d92
SP
1567 die("failed to read delta base object"
1568 " at %"PRIuMAX" from %s",
1569 (uintmax_t)base_offset, p->pack_name);
67686d95 1570
2b87c45b 1571 delta_data = unpack_compressed_entry(p, w_curs, curpos, delta_size);
9064d87b
SP
1572 if (!delta_data)
1573 die("failed to unpack compressed delta"
1574 " at %"PRIuMAX" from %s",
1575 (uintmax_t)curpos, p->pack_name);
1f688557
JH
1576 result = patch_delta(base, base_size,
1577 delta_data, delta_size,
21666f1a 1578 sizep);
1f688557
JH
1579 if (!result)
1580 die("failed to apply delta");
1581 free(delta_data);
62f255ad 1582 add_delta_base_cache(p, base_offset, base, base_size, *type);
1f688557
JH
1583 return result;
1584}
1585
c4001d92 1586void *unpack_entry(struct packed_git *p, off_t obj_offset,
21666f1a 1587 enum object_type *type, unsigned long *sizep)
1f688557 1588{
03e79c88 1589 struct pack_window *w_curs = NULL;
c4001d92 1590 off_t curpos = obj_offset;
21666f1a 1591 void *data;
1f688557 1592
21666f1a
NP
1593 *type = unpack_object_header(p, &w_curs, &curpos, sizep);
1594 switch (*type) {
eb32d236
NP
1595 case OBJ_OFS_DELTA:
1596 case OBJ_REF_DELTA:
21666f1a
NP
1597 data = unpack_delta_entry(p, &w_curs, curpos, *sizep,
1598 obj_offset, type, sizep);
4d703a1a 1599 break;
a733cb60 1600 case OBJ_COMMIT:
a733cb60 1601 case OBJ_TREE:
a733cb60 1602 case OBJ_BLOB:
a733cb60 1603 case OBJ_TAG:
21666f1a 1604 data = unpack_compressed_entry(p, &w_curs, curpos, *sizep);
4d703a1a 1605 break;
1f688557 1606 default:
21666f1a 1607 die("unknown object type %i in %s", *type, p->pack_name);
1f688557 1608 }
03e79c88 1609 unuse_pack(&w_curs);
21666f1a 1610 return data;
1f688557
JH
1611}
1612
d079837e 1613const unsigned char *nth_packed_object_sha1(struct packed_git *p,
d72308e0 1614 uint32_t n)
9a217f2a 1615{
42873078 1616 const unsigned char *index = p->index_data;
d079837e
SP
1617 if (!index) {
1618 if (open_pack_index(p))
1619 return NULL;
1620 index = p->index_data;
1621 }
57059091 1622 if (n >= p->num_objects)
d72308e0 1623 return NULL;
74e34e1f
NP
1624 index += 4 * 256;
1625 if (p->index_version == 1) {
1626 return index + 24 * n + 4;
1627 } else {
1628 index += 8;
1629 return index + 20 * n;
1630 }
1631}
1632
1633static off_t nth_packed_object_offset(const struct packed_git *p, uint32_t n)
1634{
1635 const unsigned char *index = p->index_data;
1636 index += 4 * 256;
1637 if (p->index_version == 1) {
1638 return ntohl(*((uint32_t *)(index + 24 * n)));
1639 } else {
1640 uint32_t off;
1641 index += 8 + p->num_objects * (20 + 4);
1642 off = ntohl(*((uint32_t *)(index + 4 * n)));
1643 if (!(off & 0x80000000))
1644 return off;
1645 index += p->num_objects * 4 + (off & 0x7fffffff) * 8;
1646 return (((uint64_t)ntohl(*((uint32_t *)(index + 0)))) << 32) |
1647 ntohl(*((uint32_t *)(index + 4)));
1648 }
9a217f2a
JH
1649}
1650
c4001d92 1651off_t find_pack_entry_one(const unsigned char *sha1,
43057304 1652 struct packed_git *p)
1f688557 1653{
42873078 1654 const uint32_t *level1_ofs = p->index_data;
42873078 1655 const unsigned char *index = p->index_data;
74e34e1f 1656 unsigned hi, lo;
42873078 1657
d079837e
SP
1658 if (!index) {
1659 if (open_pack_index(p))
1660 return 0;
1661 level1_ofs = p->index_data;
1662 index = p->index_data;
1663 }
74e34e1f
NP
1664 if (p->index_version > 1) {
1665 level1_ofs += 2;
1666 index += 8;
1667 }
42873078 1668 index += 4 * 256;
74e34e1f
NP
1669 hi = ntohl(level1_ofs[*sha1]);
1670 lo = ((*sha1 == 0x0) ? 0 : ntohl(level1_ofs[*sha1 - 1]));
1f688557
JH
1671
1672 do {
74e34e1f
NP
1673 unsigned mi = (lo + hi) / 2;
1674 unsigned x = (p->index_version > 1) ? (mi * 20) : (mi * 24 + 4);
1675 int cmp = hashcmp(index + x, sha1);
43057304 1676 if (!cmp)
74e34e1f 1677 return nth_packed_object_offset(p, mi);
1f688557
JH
1678 if (cmp > 0)
1679 hi = mi;
1680 else
1681 lo = mi+1;
1682 } while (lo < hi);
1683 return 0;
1684}
1685
000dfd3f 1686int matches_pack_name(struct packed_git *p, const char *name)
d4ff6d92
SP
1687{
1688 const char *last_c, *c;
1689
000dfd3f
JH
1690 if (!strcmp(p->pack_name, name))
1691 return 1;
d4ff6d92
SP
1692
1693 for (c = p->pack_name, last_c = c; *c;)
1694 if (*c == '/')
1695 last_c = ++c;
1696 else
1697 ++c;
000dfd3f
JH
1698 if (!strcmp(last_c, name))
1699 return 1;
d4ff6d92 1700
000dfd3f 1701 return 0;
d4ff6d92
SP
1702}
1703
106d710b 1704static int find_pack_entry(const unsigned char *sha1, struct pack_entry *e, const char **ignore_packed)
1f688557 1705{
f7c22cc6 1706 static struct packed_git *last_found = (void *)1;
1f688557 1707 struct packed_git *p;
c4001d92 1708 off_t offset;
43057304 1709
1f688557 1710 prepare_packed_git();
f7c22cc6
NP
1711 if (!packed_git)
1712 return 0;
1713 p = (last_found == (void *)1) ? packed_git : last_found;
1f688557 1714
f7c22cc6 1715 do {
106d710b
JH
1716 if (ignore_packed) {
1717 const char **ig;
1718 for (ig = ignore_packed; *ig; ig++)
000dfd3f 1719 if (matches_pack_name(p, *ig))
106d710b
JH
1720 break;
1721 if (*ig)
f7c22cc6 1722 goto next;
106d710b 1723 }
f7c22cc6 1724
43057304
NP
1725 offset = find_pack_entry_one(sha1, p);
1726 if (offset) {
c715f783
SP
1727 /*
1728 * We are about to tell the caller where they can
1729 * locate the requested object. We better make
1730 * sure the packfile is still here and can be
1731 * accessed before supplying that answer, as
1732 * it may have been deleted since the index
1733 * was loaded!
1734 */
1735 if (p->pack_fd == -1 && open_packed_git(p)) {
1736 error("packfile %s cannot be accessed", p->pack_name);
f7c22cc6 1737 goto next;
c715f783 1738 }
43057304
NP
1739 e->offset = offset;
1740 e->p = p;
1741 hashcpy(e->sha1, sha1);
f7c22cc6 1742 last_found = p;
1f688557 1743 return 1;
43057304 1744 }
f7c22cc6
NP
1745
1746 next:
1747 if (p == last_found)
1748 p = packed_git;
1749 else
1750 p = p->next;
1751 if (p == last_found)
1752 p = p->next;
1753 } while (p);
1f688557
JH
1754 return 0;
1755}
1756
a6080a0a 1757struct packed_git *find_sha1_pack(const unsigned char *sha1,
bf592c50
DB
1758 struct packed_git *packs)
1759{
1760 struct packed_git *p;
bf592c50
DB
1761
1762 for (p = packs; p; p = p->next) {
43057304 1763 if (find_pack_entry_one(sha1, p))
bf592c50
DB
1764 return p;
1765 }
1766 return NULL;
21666f1a 1767
bf592c50
DB
1768}
1769
21666f1a 1770static int sha1_loose_object_info(const unsigned char *sha1, unsigned long *sizep)
65c2e0c3 1771{
36e4d74a 1772 int status;
65c2e0c3
JH
1773 unsigned long mapsize, size;
1774 void *map;
1775 z_stream stream;
d65a16f6 1776 char hdr[32];
65c2e0c3 1777
bb6b8e4f 1778 map = map_sha1_file(sha1, &mapsize);
f0df4ed5
JS
1779 if (!map)
1780 return error("unable to find %s", sha1_to_hex(sha1));
36e4d74a
JH
1781 if (unpack_sha1_header(&stream, map, mapsize, hdr, sizeof(hdr)) < 0)
1782 status = error("unable to unpack %s header",
1783 sha1_to_hex(sha1));
21666f1a 1784 else if ((status = parse_sha1_header(hdr, &size)) < 0)
36e4d74a 1785 status = error("unable to parse %s header", sha1_to_hex(sha1));
21666f1a
NP
1786 else if (sizep)
1787 *sizep = size;
65c2e0c3
JH
1788 inflateEnd(&stream);
1789 munmap(map, mapsize);
1790 return status;
1791}
1792
21666f1a 1793int sha1_object_info(const unsigned char *sha1, unsigned long *sizep)
f0df4ed5 1794{
f0df4ed5
JS
1795 struct pack_entry e;
1796
1797 if (!find_pack_entry(sha1, &e, NULL)) {
1798 reprepare_packed_git();
1799 if (!find_pack_entry(sha1, &e, NULL))
21666f1a 1800 return sha1_loose_object_info(sha1, sizep);
f0df4ed5 1801 }
21666f1a 1802 return packed_object_info(e.p, e.offset, sizep);
f0df4ed5
JS
1803}
1804
21666f1a
NP
1805static void *read_packed_sha1(const unsigned char *sha1,
1806 enum object_type *type, unsigned long *size)
1f688557
JH
1807{
1808 struct pack_entry e;
1809
8276c007 1810 if (!find_pack_entry(sha1, &e, NULL))
1f688557 1811 return NULL;
8276c007 1812 else
a0cba108 1813 return cache_or_unpack_entry(e.p, e.offset, size, type, 1);
1f688557
JH
1814}
1815
d66b37bb
JH
1816/*
1817 * This is meant to hold a *small* number of objects that you would
1818 * want read_sha1_file() to be able to return, but yet you do not want
1819 * to write them into the object store (e.g. a browse-only
1820 * application).
1821 */
1822static struct cached_object {
1823 unsigned char sha1[20];
21666f1a 1824 enum object_type type;
d66b37bb
JH
1825 void *buf;
1826 unsigned long size;
1827} *cached_objects;
1828static int cached_object_nr, cached_object_alloc;
1829
1830static struct cached_object *find_cached_object(const unsigned char *sha1)
1831{
1832 int i;
1833 struct cached_object *co = cached_objects;
1834
1835 for (i = 0; i < cached_object_nr; i++, co++) {
1836 if (!hashcmp(co->sha1, sha1))
1837 return co;
1838 }
1839 return NULL;
1840}
1841
21666f1a
NP
1842int pretend_sha1_file(void *buf, unsigned long len, enum object_type type,
1843 unsigned char *sha1)
d66b37bb
JH
1844{
1845 struct cached_object *co;
1846
21666f1a 1847 hash_sha1_file(buf, len, typename(type), sha1);
d66b37bb
JH
1848 if (has_sha1_file(sha1) || find_cached_object(sha1))
1849 return 0;
1850 if (cached_object_alloc <= cached_object_nr) {
1851 cached_object_alloc = alloc_nr(cached_object_alloc);
1852 cached_objects = xrealloc(cached_objects,
1853 sizeof(*cached_objects) *
1854 cached_object_alloc);
1855 }
1856 co = &cached_objects[cached_object_nr++];
1857 co->size = len;
21666f1a 1858 co->type = type;
efa13f7b
JH
1859 co->buf = xmalloc(len);
1860 memcpy(co->buf, buf, len);
d66b37bb
JH
1861 hashcpy(co->sha1, sha1);
1862 return 0;
1863}
1864
21666f1a
NP
1865void *read_sha1_file(const unsigned char *sha1, enum object_type *type,
1866 unsigned long *size)
0fcfd160
LT
1867{
1868 unsigned long mapsize;
1869 void *map, *buf;
d66b37bb
JH
1870 struct cached_object *co;
1871
1872 co = find_cached_object(sha1);
1873 if (co) {
21666f1a 1874 *type = co->type;
d66b37bb 1875 *size = co->size;
182af834 1876 return xmemdupz(co->buf, co->size);
d66b37bb 1877 }
0fcfd160 1878
8276c007
PE
1879 buf = read_packed_sha1(sha1, type, size);
1880 if (buf)
1881 return buf;
bb6b8e4f 1882 map = map_sha1_file(sha1, &mapsize);
0fcfd160 1883 if (map) {
7efbff75 1884 buf = unpack_sha1_file(map, mapsize, type, size, sha1);
0fcfd160
LT
1885 munmap(map, mapsize);
1886 return buf;
1887 }
637cdd9d 1888 reprepare_packed_git();
8276c007 1889 return read_packed_sha1(sha1, type, size);
0fcfd160
LT
1890}
1891
40469ee9 1892void *read_object_with_reference(const unsigned char *sha1,
21666f1a 1893 const char *required_type_name,
40469ee9
JH
1894 unsigned long *size,
1895 unsigned char *actual_sha1_return)
f4913f91 1896{
21666f1a 1897 enum object_type type, required_type;
f4913f91
JH
1898 void *buffer;
1899 unsigned long isize;
40469ee9 1900 unsigned char actual_sha1[20];
f4913f91 1901
21666f1a 1902 required_type = type_from_string(required_type_name);
e702496e 1903 hashcpy(actual_sha1, sha1);
40469ee9
JH
1904 while (1) {
1905 int ref_length = -1;
1906 const char *ref_type = NULL;
f4913f91 1907
21666f1a 1908 buffer = read_sha1_file(actual_sha1, &type, &isize);
40469ee9
JH
1909 if (!buffer)
1910 return NULL;
21666f1a 1911 if (type == required_type) {
40469ee9
JH
1912 *size = isize;
1913 if (actual_sha1_return)
e702496e 1914 hashcpy(actual_sha1_return, actual_sha1);
40469ee9
JH
1915 return buffer;
1916 }
1917 /* Handle references */
21666f1a 1918 else if (type == OBJ_COMMIT)
40469ee9 1919 ref_type = "tree ";
21666f1a 1920 else if (type == OBJ_TAG)
40469ee9
JH
1921 ref_type = "object ";
1922 else {
1923 free(buffer);
1924 return NULL;
1925 }
1926 ref_length = strlen(ref_type);
f4913f91 1927
40469ee9 1928 if (memcmp(buffer, ref_type, ref_length) ||
1d7f171c 1929 get_sha1_hex((char *) buffer + ref_length, actual_sha1)) {
40469ee9
JH
1930 free(buffer);
1931 return NULL;
1932 }
1cf58e72 1933 free(buffer);
40469ee9
JH
1934 /* Now we have the ID of the referred-to object in
1935 * actual_sha1. Check again. */
f4913f91 1936 }
f4913f91
JH
1937}
1938
ce9fbf16 1939static void write_sha1_file_prepare(const void *buf, unsigned long len,
972a9155 1940 const char *type, unsigned char *sha1,
d65a16f6 1941 char *hdr, int *hdrlen)
d410c0f5
JH
1942{
1943 SHA_CTX c;
1944
1945 /* Generate the header */
d65a16f6 1946 *hdrlen = sprintf(hdr, "%s %lu", type, len)+1;
d410c0f5
JH
1947
1948 /* Sha1.. */
1949 SHA1_Init(&c);
1950 SHA1_Update(&c, hdr, *hdrlen);
1951 SHA1_Update(&c, buf, len);
1952 SHA1_Final(sha1, &c);
d410c0f5
JH
1953}
1954
230f1322
LT
1955/*
1956 * Link the tempfile to the final place, possibly creating the
1957 * last directory level as you do so.
1958 *
1959 * Returns the errno on failure, 0 on success.
1960 */
839837b9 1961static int link_temp_to_file(const char *tmpfile, const char *filename)
230f1322
LT
1962{
1963 int ret;
756aaf4a 1964 char *dir;
230f1322
LT
1965
1966 if (!link(tmpfile, filename))
1967 return 0;
1968
1969 /*
756aaf4a 1970 * Try to mkdir the last path component if that failed.
230f1322
LT
1971 *
1972 * Re-try the "link()" regardless of whether the mkdir
1973 * succeeds, since a race might mean that somebody
1974 * else succeeded.
1975 */
1976 ret = errno;
756aaf4a
SP
1977 dir = strrchr(filename, '/');
1978 if (dir) {
1979 *dir = 0;
866cae0d 1980 if (!mkdir(filename, 0777) && adjust_shared_perm(filename)) {
91c23e48 1981 *dir = '/';
756aaf4a 1982 return -2;
91c23e48 1983 }
756aaf4a
SP
1984 *dir = '/';
1985 if (!link(tmpfile, filename))
1986 return 0;
1987 ret = errno;
230f1322
LT
1988 }
1989 return ret;
1990}
1991
1992/*
1993 * Move the just written object into its final resting place
1994 */
839837b9 1995int move_temp_to_file(const char *tmpfile, const char *filename)
230f1322
LT
1996{
1997 int ret = link_temp_to_file(tmpfile, filename);
7ebb6fca
LT
1998
1999 /*
2000 * Coda hack - coda doesn't like cross-directory links,
2001 * so we fall back to a rename, which will mean that it
2002 * won't be able to check collisions, but that's not a
2003 * big deal.
2004 *
2005 * The same holds for FAT formatted media.
2006 *
2007 * When this succeeds, we just return 0. We have nothing
2008 * left to unlink.
2009 */
2010 if (ret && ret != EEXIST) {
2011 if (!rename(tmpfile, filename))
230f1322 2012 return 0;
9e48b389 2013 ret = errno;
230f1322
LT
2014 }
2015 unlink(tmpfile);
2016 if (ret) {
2017 if (ret != EEXIST) {
916d081b 2018 return error("unable to write sha1 filename %s: %s\n", filename, strerror(ret));
230f1322
LT
2019 }
2020 /* FIXME!!! Collision check here ? */
2021 }
2022
2023 return 0;
2024}
2025
4d548150
LT
2026static int write_buffer(int fd, const void *buf, size_t len)
2027{
d34cf19b 2028 if (write_in_full(fd, buf, len) < 0)
93822c22 2029 return error("file write error (%s)", strerror(errno));
4d548150
LT
2030 return 0;
2031}
2032
ce9fbf16 2033int hash_sha1_file(const void *buf, unsigned long len, const char *type,
abdc3fc8
RS
2034 unsigned char *sha1)
2035{
d65a16f6 2036 char hdr[32];
abdc3fc8
RS
2037 int hdrlen;
2038 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2039 return 0;
2040}
2041
bf0f910d 2042int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *returnsha1)
0fcfd160 2043{
ac54c277 2044 int size, ret;
bf0f910d 2045 unsigned char *compressed;
0fcfd160
LT
2046 z_stream stream;
2047 unsigned char sha1[20];
706bc531 2048 char *filename;
aac17941 2049 static char tmpfile[PATH_MAX];
d65a16f6 2050 char hdr[32];
230f1322 2051 int fd, hdrlen;
a44c9a5e 2052
d410c0f5
JH
2053 /* Normally if we have it in the pack then we do not bother writing
2054 * it out into .git/objects/??/?{38} file.
2055 */
972a9155
RS
2056 write_sha1_file_prepare(buf, len, type, sha1, hdr, &hdrlen);
2057 filename = sha1_file_name(sha1);
706bc531 2058 if (returnsha1)
e702496e 2059 hashcpy(returnsha1, sha1);
d410c0f5
JH
2060 if (has_sha1_file(sha1))
2061 return 0;
aac17941
LT
2062 fd = open(filename, O_RDONLY);
2063 if (fd >= 0) {
706bc531 2064 /*
aac17941
LT
2065 * FIXME!!! We might do collision checking here, but we'd
2066 * need to uncompress the old file and check it. Later.
706bc531 2067 */
aac17941 2068 close(fd);
706bc531
LT
2069 return 0;
2070 }
2071
aac17941 2072 if (errno != ENOENT) {
916d081b 2073 return error("sha1 file %s: %s\n", filename, strerror(errno));
aac17941
LT
2074 }
2075
0e55181f 2076 snprintf(tmpfile, sizeof(tmpfile), "%s/tmp_obj_XXXXXX", get_object_directory());
ace1534d 2077
aac17941
LT
2078 fd = mkstemp(tmpfile);
2079 if (fd < 0) {
916d081b
PB
2080 if (errno == EPERM)
2081 return error("insufficient permission for adding an object to repository database %s\n", get_object_directory());
2082 else
2083 return error("unable to create temporary sha1 filename %s: %s\n", tmpfile, strerror(errno));
aac17941
LT
2084 }
2085
0fcfd160
LT
2086 /* Set it up */
2087 memset(&stream, 0, sizeof(stream));
12f6c308 2088 deflateInit(&stream, zlib_compression_level);
93821bd9 2089 size = 8 + deflateBound(&stream, len+hdrlen);
812666c8 2090 compressed = xmalloc(size);
0fcfd160
LT
2091
2092 /* Compress it */
0fcfd160
LT
2093 stream.next_out = compressed;
2094 stream.avail_out = size;
a44c9a5e
LT
2095
2096 /* First header.. */
d65a16f6 2097 stream.next_in = (unsigned char *)hdr;
a44c9a5e 2098 stream.avail_in = hdrlen;
726f852b
NP
2099 while (deflate(&stream, 0) == Z_OK)
2100 /* nothing */;
a44c9a5e
LT
2101
2102 /* Then the data itself.. */
2103 stream.next_in = buf;
2104 stream.avail_in = len;
ac54c277
LT
2105 ret = deflate(&stream, Z_FINISH);
2106 if (ret != Z_STREAM_END)
2107 die("unable to deflate new object %s (%d)", sha1_to_hex(sha1), ret);
2108
2109 ret = deflateEnd(&stream);
2110 if (ret != Z_OK)
2111 die("deflateEnd on object %s failed (%d)", sha1_to_hex(sha1), ret);
2112
0fcfd160
LT
2113 size = stream.total_out;
2114
4d548150
LT
2115 if (write_buffer(fd, compressed, size) < 0)
2116 die("unable to write sha1 file");
aac17941 2117 fchmod(fd, 0444);
e82973cf
JH
2118 if (close(fd))
2119 die("unable to write sha1 file");
383f85b7 2120 free(compressed);
0fcfd160 2121
230f1322 2122 return move_temp_to_file(tmpfile, filename);
0fcfd160 2123}
8237b185 2124
4d548150
LT
2125/*
2126 * We need to unpack and recompress the object for writing
2127 * it out to a different file.
2128 */
2129static void *repack_object(const unsigned char *sha1, unsigned long *objsize)
a5eda52b 2130{
4d548150 2131 size_t size;
a5eda52b 2132 z_stream stream;
4d548150
LT
2133 unsigned char *unpacked;
2134 unsigned long len;
21666f1a 2135 enum object_type type;
d65a16f6 2136 char hdr[32];
4d548150
LT
2137 int hdrlen;
2138 void *buf;
bfc66daf 2139
a9486b02 2140 /* need to unpack and recompress it by itself */
21666f1a 2141 unpacked = read_packed_sha1(sha1, &type, &len);
8276c007
PE
2142 if (!unpacked)
2143 error("cannot read sha1_file for %s", sha1_to_hex(sha1));
a5eda52b 2144
21666f1a 2145 hdrlen = sprintf(hdr, "%s %lu", typename(type), len) + 1;
a5eda52b 2146
4d548150
LT
2147 /* Set it up */
2148 memset(&stream, 0, sizeof(stream));
12f6c308 2149 deflateInit(&stream, zlib_compression_level);
4d548150
LT
2150 size = deflateBound(&stream, len + hdrlen);
2151 buf = xmalloc(size);
a5eda52b 2152
4d548150
LT
2153 /* Compress it */
2154 stream.next_out = buf;
2155 stream.avail_out = size;
a5eda52b 2156
4d548150
LT
2157 /* First header.. */
2158 stream.next_in = (void *)hdr;
2159 stream.avail_in = hdrlen;
2160 while (deflate(&stream, 0) == Z_OK)
2161 /* nothing */;
bfc66daf 2162
4d548150
LT
2163 /* Then the data itself.. */
2164 stream.next_in = unpacked;
2165 stream.avail_in = len;
2166 while (deflate(&stream, Z_FINISH) == Z_OK)
2167 /* nothing */;
2168 deflateEnd(&stream);
2169 free(unpacked);
bfc66daf 2170
4d548150
LT
2171 *objsize = stream.total_out;
2172 return buf;
2173}
2174
2175int write_sha1_to_fd(int fd, const unsigned char *sha1)
2176{
2177 int retval;
2178 unsigned long objsize;
bb6b8e4f 2179 void *buf = map_sha1_file(sha1, &objsize);
4d548150
LT
2180
2181 if (buf) {
2182 retval = write_buffer(fd, buf, objsize);
2183 munmap(buf, objsize);
2184 return retval;
2185 }
2186
2187 buf = repack_object(sha1, &objsize);
2188 retval = write_buffer(fd, buf, objsize);
2189 free(buf);
2190 return retval;
a5eda52b
DB
2191}
2192
70b9829e
DB
2193int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
2194 size_t bufsize, size_t *bufposn)
8237b185 2195{
230f1322 2196 char tmpfile[PATH_MAX];
8237b185
DB
2197 int local;
2198 z_stream stream;
2199 unsigned char real_sha1[20];
bf0f910d 2200 unsigned char discard[4096];
8237b185
DB
2201 int ret;
2202 SHA_CTX c;
2203
0e55181f 2204 snprintf(tmpfile, sizeof(tmpfile), "%s/tmp_obj_XXXXXX", get_object_directory());
8237b185 2205
230f1322 2206 local = mkstemp(tmpfile);
916d081b
PB
2207 if (local < 0) {
2208 if (errno == EPERM)
2209 return error("insufficient permission for adding an object to repository database %s\n", get_object_directory());
2210 else
2211 return error("unable to create temporary sha1 filename %s: %s\n", tmpfile, strerror(errno));
2212 }
8237b185
DB
2213
2214 memset(&stream, 0, sizeof(stream));
2215
2216 inflateInit(&stream);
2217
2218 SHA1_Init(&c);
2219
2220 do {
2221 ssize_t size;
70b9829e
DB
2222 if (*bufposn) {
2223 stream.avail_in = *bufposn;
96ad15ae 2224 stream.next_in = (unsigned char *) buffer;
70b9829e
DB
2225 do {
2226 stream.next_out = discard;
2227 stream.avail_out = sizeof(discard);
2228 ret = inflate(&stream, Z_SYNC_FLUSH);
2229 SHA1_Update(&c, discard, sizeof(discard) -
2230 stream.avail_out);
2231 } while (stream.avail_in && ret == Z_OK);
4d548150
LT
2232 if (write_buffer(local, buffer, *bufposn - stream.avail_in) < 0)
2233 die("unable to write sha1 file");
70b9829e
DB
2234 memmove(buffer, buffer + *bufposn - stream.avail_in,
2235 stream.avail_in);
2236 *bufposn = stream.avail_in;
2237 if (ret != Z_OK)
2238 break;
2239 }
93d26e4c 2240 size = xread(fd, buffer + *bufposn, bufsize - *bufposn);
8237b185
DB
2241 if (size <= 0) {
2242 close(local);
230f1322 2243 unlink(tmpfile);
8237b185
DB
2244 if (!size)
2245 return error("Connection closed?");
2246 perror("Reading from connection");
2247 return -1;
2248 }
70b9829e
DB
2249 *bufposn += size;
2250 } while (1);
8237b185
DB
2251 inflateEnd(&stream);
2252
b5b8d814 2253 fchmod(local, 0444);
0d315468
JM
2254 if (close(local) != 0)
2255 die("unable to write sha1 file");
8237b185
DB
2256 SHA1_Final(real_sha1, &c);
2257 if (ret != Z_STREAM_END) {
230f1322 2258 unlink(tmpfile);
8237b185
DB
2259 return error("File %s corrupted", sha1_to_hex(sha1));
2260 }
a89fccd2 2261 if (hashcmp(sha1, real_sha1)) {
230f1322 2262 unlink(tmpfile);
bd2afde8 2263 return error("File %s has bad hash", sha1_to_hex(sha1));
8237b185 2264 }
230f1322
LT
2265
2266 return move_temp_to_file(tmpfile, sha1_file_name(sha1));
8237b185
DB
2267}
2268
bf592c50
DB
2269int has_pack_index(const unsigned char *sha1)
2270{
2271 struct stat st;
2272 if (stat(sha1_pack_index_name(sha1), &st))
2273 return 0;
2274 return 1;
2275}
2276
2277int has_pack_file(const unsigned char *sha1)
2278{
2279 struct stat st;
2280 if (stat(sha1_pack_name(sha1), &st))
2281 return 0;
2282 return 1;
2283}
2284
106d710b 2285int has_sha1_pack(const unsigned char *sha1, const char **ignore_packed)
dade09c2
LT
2286{
2287 struct pack_entry e;
106d710b 2288 return find_pack_entry(sha1, &e, ignore_packed);
dade09c2
LT
2289}
2290
8237b185
DB
2291int has_sha1_file(const unsigned char *sha1)
2292{
8237b185 2293 struct stat st;
1f688557
JH
2294 struct pack_entry e;
2295
106d710b 2296 if (find_pack_entry(sha1, &e, NULL))
1f688557 2297 return 1;
ab90ea5d 2298 return find_sha1_file(sha1, &st) ? 1 : 0;
8237b185 2299}
74400e71 2300
e7332f96
BE
2301int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object)
2302{
fd17f5b5 2303 struct strbuf buf;
e7332f96 2304 int ret;
e7332f96 2305
fd17f5b5
PH
2306 strbuf_init(&buf, 0);
2307 if (strbuf_read(&buf, fd, 4096) < 0) {
2308 strbuf_release(&buf);
024510c8
DB
2309 return -1;
2310 }
e7332f96 2311
024510c8 2312 if (!type)
8e440259 2313 type = blob_type;
024510c8 2314 if (write_object)
fd17f5b5 2315 ret = write_sha1_file(buf.buf, buf.len, type, sha1);
abdc3fc8 2316 else
fd17f5b5
PH
2317 ret = hash_sha1_file(buf.buf, buf.len, type, sha1);
2318 strbuf_release(&buf);
2319
024510c8
DB
2320 return ret;
2321}
2322
edaec3fb 2323int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object,
53bca91a 2324 enum object_type type, const char *path)
74400e71 2325{
dc49cd76 2326 size_t size = xsize_t(st->st_size);
3a55602e 2327 void *buf = NULL;
6c510bee 2328 int ret, re_allocated = 0;
74400e71 2329
74400e71 2330 if (size)
c4712e45 2331 buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
74400e71 2332 close(fd);
74400e71 2333
7672db20 2334 if (!type)
edaec3fb 2335 type = OBJ_BLOB;
6c510bee
LT
2336
2337 /*
2338 * Convert blobs to git internal format
2339 */
d0d8e14d 2340 if ((type == OBJ_BLOB) && S_ISREG(st->st_mode)) {
5ecd293d
PH
2341 struct strbuf nbuf;
2342 strbuf_init(&nbuf, 0);
2343 if (convert_to_git(path, buf, size, &nbuf)) {
ac78e548 2344 munmap(buf, size);
b315c5c0 2345 buf = strbuf_detach(&nbuf, &size);
6c510bee
LT
2346 re_allocated = 1;
2347 }
2348 }
2349
7672db20 2350 if (write_object)
edaec3fb 2351 ret = write_sha1_file(buf, size, typename(type), sha1);
abdc3fc8 2352 else
edaec3fb 2353 ret = hash_sha1_file(buf, size, typename(type), sha1);
6c510bee
LT
2354 if (re_allocated) {
2355 free(buf);
2356 return ret;
2357 }
aac17941
LT
2358 if (size)
2359 munmap(buf, size);
2360 return ret;
74400e71 2361}
ec1fcc16
JH
2362
2363int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object)
2364{
2365 int fd;
2366 char *target;
dc49cd76 2367 size_t len;
ec1fcc16
JH
2368
2369 switch (st->st_mode & S_IFMT) {
2370 case S_IFREG:
2371 fd = open(path, O_RDONLY);
2372 if (fd < 0)
2373 return error("open(\"%s\"): %s", path,
2374 strerror(errno));
53bca91a 2375 if (index_fd(sha1, fd, st, write_object, OBJ_BLOB, path) < 0)
ec1fcc16
JH
2376 return error("%s: failed to insert into database",
2377 path);
2378 break;
2379 case S_IFLNK:
dc49cd76
SP
2380 len = xsize_t(st->st_size);
2381 target = xmalloc(len + 1);
2382 if (readlink(path, target, len + 1) != st->st_size) {
ec1fcc16
JH
2383 char *errstr = strerror(errno);
2384 free(target);
2385 return error("readlink(\"%s\"): %s", path,
2386 errstr);
2387 }
abdc3fc8 2388 if (!write_object)
dc49cd76
SP
2389 hash_sha1_file(target, len, blob_type, sha1);
2390 else if (write_sha1_file(target, len, blob_type, sha1))
ec1fcc16
JH
2391 return error("%s: failed to insert into database",
2392 path);
2393 free(target);
2394 break;
f35a6d3b
LT
2395 case S_IFDIR:
2396 return resolve_gitlink_ref(path, "HEAD", sha1);
ec1fcc16
JH
2397 default:
2398 return error("%s: unsupported file type", path);
2399 }
2400 return 0;
2401}
a69e5429
JH
2402
2403int read_pack_header(int fd, struct pack_header *header)
2404{
2405 char *c = (char*)header;
2406 ssize_t remaining = sizeof(struct pack_header);
2407 do {
2408 ssize_t r = xread(fd, c, remaining);
2409 if (r <= 0)
2410 /* "eof before pack header was fully read" */
2411 return PH_ERROR_EOF;
2412 remaining -= r;
2413 c += r;
2414 } while (remaining > 0);
2415 if (header->hdr_signature != htonl(PACK_SIGNATURE))
2416 /* "protocol error (pack signature mismatch detected)" */
2417 return PH_ERROR_PACK_SIGNATURE;
2418 if (!pack_version_ok(header->hdr_version))
2419 /* "protocol error (pack version unsupported)" */
2420 return PH_ERROR_PROTOCOL;
2421 return 0;
2422}