asciidoctor: fix `synopsis` rendering
[git/gitster.git] / object-file.c
blob619f039ebc7ceb52467e4810c5c4cf3afabb907a
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
6 * This handles basic git object files - packing, unpacking,
7 * creation etc.
8 */
9 #include "git-compat-util.h"
10 #include "abspath.h"
11 #include "config.h"
12 #include "convert.h"
13 #include "environment.h"
14 #include "gettext.h"
15 #include "hex.h"
16 #include "string-list.h"
17 #include "lockfile.h"
18 #include "pack.h"
19 #include "commit.h"
20 #include "run-command.h"
21 #include "refs.h"
22 #include "bulk-checkin.h"
23 #include "repository.h"
24 #include "replace-object.h"
25 #include "streaming.h"
26 #include "dir.h"
27 #include "list.h"
28 #include "quote.h"
29 #include "packfile.h"
30 #include "object-file.h"
31 #include "object-store.h"
32 #include "oidtree.h"
33 #include "path.h"
34 #include "promisor-remote.h"
35 #include "setup.h"
36 #include "submodule.h"
37 #include "fsck.h"
39 /* The maximum size for an object header. */
40 #define MAX_HEADER_LEN 32
43 #define EMPTY_TREE_SHA1_BIN_LITERAL \
44 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
45 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
46 #define EMPTY_TREE_SHA256_BIN_LITERAL \
47 "\x6e\xf1\x9b\x41\x22\x5c\x53\x69\xf1\xc1" \
48 "\x04\xd4\x5d\x8d\x85\xef\xa9\xb0\x57\xb5" \
49 "\x3b\x14\xb4\xb9\xb9\x39\xdd\x74\xde\xcc" \
50 "\x53\x21"
52 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
53 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
54 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
55 #define EMPTY_BLOB_SHA256_BIN_LITERAL \
56 "\x47\x3a\x0f\x4c\x3b\xe8\xa9\x36\x81\xa2" \
57 "\x67\xe3\xb1\xe9\xa7\xdc\xda\x11\x85\x43" \
58 "\x6f\xe1\x41\xf7\x74\x91\x20\xa3\x03\x72" \
59 "\x18\x13"
61 static const struct object_id empty_tree_oid = {
62 .hash = EMPTY_TREE_SHA1_BIN_LITERAL,
63 .algo = GIT_HASH_SHA1,
65 static const struct object_id empty_blob_oid = {
66 .hash = EMPTY_BLOB_SHA1_BIN_LITERAL,
67 .algo = GIT_HASH_SHA1,
69 static const struct object_id null_oid_sha1 = {
70 .hash = {0},
71 .algo = GIT_HASH_SHA1,
73 static const struct object_id empty_tree_oid_sha256 = {
74 .hash = EMPTY_TREE_SHA256_BIN_LITERAL,
75 .algo = GIT_HASH_SHA256,
77 static const struct object_id empty_blob_oid_sha256 = {
78 .hash = EMPTY_BLOB_SHA256_BIN_LITERAL,
79 .algo = GIT_HASH_SHA256,
81 static const struct object_id null_oid_sha256 = {
82 .hash = {0},
83 .algo = GIT_HASH_SHA256,
86 static void git_hash_sha1_init(git_hash_ctx *ctx)
88 git_SHA1_Init(&ctx->sha1);
91 static void git_hash_sha1_clone(git_hash_ctx *dst, const git_hash_ctx *src)
93 git_SHA1_Clone(&dst->sha1, &src->sha1);
96 static void git_hash_sha1_update(git_hash_ctx *ctx, const void *data, size_t len)
98 git_SHA1_Update(&ctx->sha1, data, len);
101 static void git_hash_sha1_final(unsigned char *hash, git_hash_ctx *ctx)
103 git_SHA1_Final(hash, &ctx->sha1);
106 static void git_hash_sha1_final_oid(struct object_id *oid, git_hash_ctx *ctx)
108 git_SHA1_Final(oid->hash, &ctx->sha1);
109 memset(oid->hash + GIT_SHA1_RAWSZ, 0, GIT_MAX_RAWSZ - GIT_SHA1_RAWSZ);
110 oid->algo = GIT_HASH_SHA1;
114 static void git_hash_sha256_init(git_hash_ctx *ctx)
116 git_SHA256_Init(&ctx->sha256);
119 static void git_hash_sha256_clone(git_hash_ctx *dst, const git_hash_ctx *src)
121 git_SHA256_Clone(&dst->sha256, &src->sha256);
124 static void git_hash_sha256_update(git_hash_ctx *ctx, const void *data, size_t len)
126 git_SHA256_Update(&ctx->sha256, data, len);
129 static void git_hash_sha256_final(unsigned char *hash, git_hash_ctx *ctx)
131 git_SHA256_Final(hash, &ctx->sha256);
134 static void git_hash_sha256_final_oid(struct object_id *oid, git_hash_ctx *ctx)
136 git_SHA256_Final(oid->hash, &ctx->sha256);
138 * This currently does nothing, so the compiler should optimize it out,
139 * but keep it in case we extend the hash size again.
141 memset(oid->hash + GIT_SHA256_RAWSZ, 0, GIT_MAX_RAWSZ - GIT_SHA256_RAWSZ);
142 oid->algo = GIT_HASH_SHA256;
145 static void git_hash_unknown_init(git_hash_ctx *ctx UNUSED)
147 BUG("trying to init unknown hash");
150 static void git_hash_unknown_clone(git_hash_ctx *dst UNUSED,
151 const git_hash_ctx *src UNUSED)
153 BUG("trying to clone unknown hash");
156 static void git_hash_unknown_update(git_hash_ctx *ctx UNUSED,
157 const void *data UNUSED,
158 size_t len UNUSED)
160 BUG("trying to update unknown hash");
163 static void git_hash_unknown_final(unsigned char *hash UNUSED,
164 git_hash_ctx *ctx UNUSED)
166 BUG("trying to finalize unknown hash");
169 static void git_hash_unknown_final_oid(struct object_id *oid UNUSED,
170 git_hash_ctx *ctx UNUSED)
172 BUG("trying to finalize unknown hash");
175 const struct git_hash_algo hash_algos[GIT_HASH_NALGOS] = {
177 .name = NULL,
178 .format_id = 0x00000000,
179 .rawsz = 0,
180 .hexsz = 0,
181 .blksz = 0,
182 .init_fn = git_hash_unknown_init,
183 .clone_fn = git_hash_unknown_clone,
184 .update_fn = git_hash_unknown_update,
185 .final_fn = git_hash_unknown_final,
186 .final_oid_fn = git_hash_unknown_final_oid,
187 .empty_tree = NULL,
188 .empty_blob = NULL,
189 .null_oid = NULL,
192 .name = "sha1",
193 .format_id = GIT_SHA1_FORMAT_ID,
194 .rawsz = GIT_SHA1_RAWSZ,
195 .hexsz = GIT_SHA1_HEXSZ,
196 .blksz = GIT_SHA1_BLKSZ,
197 .init_fn = git_hash_sha1_init,
198 .clone_fn = git_hash_sha1_clone,
199 .update_fn = git_hash_sha1_update,
200 .final_fn = git_hash_sha1_final,
201 .final_oid_fn = git_hash_sha1_final_oid,
202 .empty_tree = &empty_tree_oid,
203 .empty_blob = &empty_blob_oid,
204 .null_oid = &null_oid_sha1,
207 .name = "sha256",
208 .format_id = GIT_SHA256_FORMAT_ID,
209 .rawsz = GIT_SHA256_RAWSZ,
210 .hexsz = GIT_SHA256_HEXSZ,
211 .blksz = GIT_SHA256_BLKSZ,
212 .init_fn = git_hash_sha256_init,
213 .clone_fn = git_hash_sha256_clone,
214 .update_fn = git_hash_sha256_update,
215 .final_fn = git_hash_sha256_final,
216 .final_oid_fn = git_hash_sha256_final_oid,
217 .empty_tree = &empty_tree_oid_sha256,
218 .empty_blob = &empty_blob_oid_sha256,
219 .null_oid = &null_oid_sha256,
223 const struct object_id *null_oid(void)
225 return the_hash_algo->null_oid;
228 const char *empty_tree_oid_hex(void)
230 static char buf[GIT_MAX_HEXSZ + 1];
231 return oid_to_hex_r(buf, the_hash_algo->empty_tree);
234 const char *empty_blob_oid_hex(void)
236 static char buf[GIT_MAX_HEXSZ + 1];
237 return oid_to_hex_r(buf, the_hash_algo->empty_blob);
240 int hash_algo_by_name(const char *name)
242 int i;
243 if (!name)
244 return GIT_HASH_UNKNOWN;
245 for (i = 1; i < GIT_HASH_NALGOS; i++)
246 if (!strcmp(name, hash_algos[i].name))
247 return i;
248 return GIT_HASH_UNKNOWN;
251 int hash_algo_by_id(uint32_t format_id)
253 int i;
254 for (i = 1; i < GIT_HASH_NALGOS; i++)
255 if (format_id == hash_algos[i].format_id)
256 return i;
257 return GIT_HASH_UNKNOWN;
260 int hash_algo_by_length(int len)
262 int i;
263 for (i = 1; i < GIT_HASH_NALGOS; i++)
264 if (len == hash_algos[i].rawsz)
265 return i;
266 return GIT_HASH_UNKNOWN;
270 * This is meant to hold a *small* number of objects that you would
271 * want repo_read_object_file() to be able to return, but yet you do not want
272 * to write them into the object store (e.g. a browse-only
273 * application).
275 static struct cached_object {
276 struct object_id oid;
277 enum object_type type;
278 void *buf;
279 unsigned long size;
280 } *cached_objects;
281 static int cached_object_nr, cached_object_alloc;
283 static struct cached_object empty_tree = {
284 .oid = {
285 .hash = EMPTY_TREE_SHA1_BIN_LITERAL,
287 .type = OBJ_TREE,
288 .buf = "",
291 static struct cached_object *find_cached_object(const struct object_id *oid)
293 int i;
294 struct cached_object *co = cached_objects;
296 for (i = 0; i < cached_object_nr; i++, co++) {
297 if (oideq(&co->oid, oid))
298 return co;
300 if (oideq(oid, the_hash_algo->empty_tree))
301 return &empty_tree;
302 return NULL;
306 static int get_conv_flags(unsigned flags)
308 if (flags & HASH_RENORMALIZE)
309 return CONV_EOL_RENORMALIZE;
310 else if (flags & HASH_WRITE_OBJECT)
311 return global_conv_flags_eol | CONV_WRITE_OBJECT;
312 else
313 return 0;
317 int mkdir_in_gitdir(const char *path)
319 if (mkdir(path, 0777)) {
320 int saved_errno = errno;
321 struct stat st;
322 struct strbuf sb = STRBUF_INIT;
324 if (errno != EEXIST)
325 return -1;
327 * Are we looking at a path in a symlinked worktree
328 * whose original repository does not yet have it?
329 * e.g. .git/rr-cache pointing at its original
330 * repository in which the user hasn't performed any
331 * conflict resolution yet?
333 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
334 strbuf_readlink(&sb, path, st.st_size) ||
335 !is_absolute_path(sb.buf) ||
336 mkdir(sb.buf, 0777)) {
337 strbuf_release(&sb);
338 errno = saved_errno;
339 return -1;
341 strbuf_release(&sb);
343 return adjust_shared_perm(path);
346 static enum scld_error safe_create_leading_directories_1(char *path, int share)
348 char *next_component = path + offset_1st_component(path);
349 enum scld_error ret = SCLD_OK;
351 while (ret == SCLD_OK && next_component) {
352 struct stat st;
353 char *slash = next_component, slash_character;
355 while (*slash && !is_dir_sep(*slash))
356 slash++;
358 if (!*slash)
359 break;
361 next_component = slash + 1;
362 while (is_dir_sep(*next_component))
363 next_component++;
364 if (!*next_component)
365 break;
367 slash_character = *slash;
368 *slash = '\0';
369 if (!stat(path, &st)) {
370 /* path exists */
371 if (!S_ISDIR(st.st_mode)) {
372 errno = ENOTDIR;
373 ret = SCLD_EXISTS;
375 } else if (mkdir(path, 0777)) {
376 if (errno == EEXIST &&
377 !stat(path, &st) && S_ISDIR(st.st_mode))
378 ; /* somebody created it since we checked */
379 else if (errno == ENOENT)
381 * Either mkdir() failed because
382 * somebody just pruned the containing
383 * directory, or stat() failed because
384 * the file that was in our way was
385 * just removed. Either way, inform
386 * the caller that it might be worth
387 * trying again:
389 ret = SCLD_VANISHED;
390 else
391 ret = SCLD_FAILED;
392 } else if (share && adjust_shared_perm(path)) {
393 ret = SCLD_PERMS;
395 *slash = slash_character;
397 return ret;
400 enum scld_error safe_create_leading_directories(char *path)
402 return safe_create_leading_directories_1(path, 1);
405 enum scld_error safe_create_leading_directories_no_share(char *path)
407 return safe_create_leading_directories_1(path, 0);
410 enum scld_error safe_create_leading_directories_const(const char *path)
412 int save_errno;
413 /* path points to cache entries, so xstrdup before messing with it */
414 char *buf = xstrdup(path);
415 enum scld_error result = safe_create_leading_directories(buf);
417 save_errno = errno;
418 free(buf);
419 errno = save_errno;
420 return result;
423 static void fill_loose_path(struct strbuf *buf, const struct object_id *oid)
425 int i;
426 for (i = 0; i < the_hash_algo->rawsz; i++) {
427 static char hex[] = "0123456789abcdef";
428 unsigned int val = oid->hash[i];
429 strbuf_addch(buf, hex[val >> 4]);
430 strbuf_addch(buf, hex[val & 0xf]);
431 if (!i)
432 strbuf_addch(buf, '/');
436 static const char *odb_loose_path(struct object_directory *odb,
437 struct strbuf *buf,
438 const struct object_id *oid)
440 strbuf_reset(buf);
441 strbuf_addstr(buf, odb->path);
442 strbuf_addch(buf, '/');
443 fill_loose_path(buf, oid);
444 return buf->buf;
447 const char *loose_object_path(struct repository *r, struct strbuf *buf,
448 const struct object_id *oid)
450 return odb_loose_path(r->objects->odb, buf, oid);
454 * Return non-zero iff the path is usable as an alternate object database.
456 static int alt_odb_usable(struct raw_object_store *o,
457 struct strbuf *path,
458 const char *normalized_objdir, khiter_t *pos)
460 int r;
462 /* Detect cases where alternate disappeared */
463 if (!is_directory(path->buf)) {
464 error(_("object directory %s does not exist; "
465 "check .git/objects/info/alternates"),
466 path->buf);
467 return 0;
471 * Prevent the common mistake of listing the same
472 * thing twice, or object directory itself.
474 if (!o->odb_by_path) {
475 khiter_t p;
477 o->odb_by_path = kh_init_odb_path_map();
478 assert(!o->odb->next);
479 p = kh_put_odb_path_map(o->odb_by_path, o->odb->path, &r);
480 assert(r == 1); /* never used */
481 kh_value(o->odb_by_path, p) = o->odb;
483 if (fspatheq(path->buf, normalized_objdir))
484 return 0;
485 *pos = kh_put_odb_path_map(o->odb_by_path, path->buf, &r);
486 /* r: 0 = exists, 1 = never used, 2 = deleted */
487 return r == 0 ? 0 : 1;
491 * Prepare alternate object database registry.
493 * The variable alt_odb_list points at the list of struct
494 * object_directory. The elements on this list come from
495 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
496 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
497 * whose contents is similar to that environment variable but can be
498 * LF separated. Its base points at a statically allocated buffer that
499 * contains "/the/directory/corresponding/to/.git/objects/...", while
500 * its name points just after the slash at the end of ".git/objects/"
501 * in the example above, and has enough space to hold all hex characters
502 * of the object ID, an extra slash for the first level indirection, and
503 * the terminating NUL.
505 static void read_info_alternates(struct repository *r,
506 const char *relative_base,
507 int depth);
508 static int link_alt_odb_entry(struct repository *r, const struct strbuf *entry,
509 const char *relative_base, int depth, const char *normalized_objdir)
511 struct object_directory *ent;
512 struct strbuf pathbuf = STRBUF_INIT;
513 struct strbuf tmp = STRBUF_INIT;
514 khiter_t pos;
515 int ret = -1;
517 if (!is_absolute_path(entry->buf) && relative_base) {
518 strbuf_realpath(&pathbuf, relative_base, 1);
519 strbuf_addch(&pathbuf, '/');
521 strbuf_addbuf(&pathbuf, entry);
523 if (!strbuf_realpath(&tmp, pathbuf.buf, 0)) {
524 error(_("unable to normalize alternate object path: %s"),
525 pathbuf.buf);
526 goto error;
528 strbuf_swap(&pathbuf, &tmp);
531 * The trailing slash after the directory name is given by
532 * this function at the end. Remove duplicates.
534 while (pathbuf.len && pathbuf.buf[pathbuf.len - 1] == '/')
535 strbuf_setlen(&pathbuf, pathbuf.len - 1);
537 if (!alt_odb_usable(r->objects, &pathbuf, normalized_objdir, &pos))
538 goto error;
540 CALLOC_ARRAY(ent, 1);
541 /* pathbuf.buf is already in r->objects->odb_by_path */
542 ent->path = strbuf_detach(&pathbuf, NULL);
544 /* add the alternate entry */
545 *r->objects->odb_tail = ent;
546 r->objects->odb_tail = &(ent->next);
547 ent->next = NULL;
548 assert(r->objects->odb_by_path);
549 kh_value(r->objects->odb_by_path, pos) = ent;
551 /* recursively add alternates */
552 read_info_alternates(r, ent->path, depth + 1);
553 ret = 0;
554 error:
555 strbuf_release(&tmp);
556 strbuf_release(&pathbuf);
557 return ret;
560 static const char *parse_alt_odb_entry(const char *string,
561 int sep,
562 struct strbuf *out)
564 const char *end;
566 strbuf_reset(out);
568 if (*string == '#') {
569 /* comment; consume up to next separator */
570 end = strchrnul(string, sep);
571 } else if (*string == '"' && !unquote_c_style(out, string, &end)) {
573 * quoted path; unquote_c_style has copied the
574 * data for us and set "end". Broken quoting (e.g.,
575 * an entry that doesn't end with a quote) falls
576 * back to the unquoted case below.
578 } else {
579 /* normal, unquoted path */
580 end = strchrnul(string, sep);
581 strbuf_add(out, string, end - string);
584 if (*end)
585 end++;
586 return end;
589 static void link_alt_odb_entries(struct repository *r, const char *alt,
590 int sep, const char *relative_base, int depth)
592 struct strbuf objdirbuf = STRBUF_INIT;
593 struct strbuf entry = STRBUF_INIT;
595 if (!alt || !*alt)
596 return;
598 if (depth > 5) {
599 error(_("%s: ignoring alternate object stores, nesting too deep"),
600 relative_base);
601 return;
604 strbuf_realpath(&objdirbuf, r->objects->odb->path, 1);
606 while (*alt) {
607 alt = parse_alt_odb_entry(alt, sep, &entry);
608 if (!entry.len)
609 continue;
610 link_alt_odb_entry(r, &entry,
611 relative_base, depth, objdirbuf.buf);
613 strbuf_release(&entry);
614 strbuf_release(&objdirbuf);
617 static void read_info_alternates(struct repository *r,
618 const char *relative_base,
619 int depth)
621 char *path;
622 struct strbuf buf = STRBUF_INIT;
624 path = xstrfmt("%s/info/alternates", relative_base);
625 if (strbuf_read_file(&buf, path, 1024) < 0) {
626 warn_on_fopen_errors(path);
627 free(path);
628 return;
631 link_alt_odb_entries(r, buf.buf, '\n', relative_base, depth);
632 strbuf_release(&buf);
633 free(path);
636 void add_to_alternates_file(const char *reference)
638 struct lock_file lock = LOCK_INIT;
639 char *alts = git_pathdup("objects/info/alternates");
640 FILE *in, *out;
641 int found = 0;
643 hold_lock_file_for_update(&lock, alts, LOCK_DIE_ON_ERROR);
644 out = fdopen_lock_file(&lock, "w");
645 if (!out)
646 die_errno(_("unable to fdopen alternates lockfile"));
648 in = fopen(alts, "r");
649 if (in) {
650 struct strbuf line = STRBUF_INIT;
652 while (strbuf_getline(&line, in) != EOF) {
653 if (!strcmp(reference, line.buf)) {
654 found = 1;
655 break;
657 fprintf_or_die(out, "%s\n", line.buf);
660 strbuf_release(&line);
661 fclose(in);
663 else if (errno != ENOENT)
664 die_errno(_("unable to read alternates file"));
666 if (found) {
667 rollback_lock_file(&lock);
668 } else {
669 fprintf_or_die(out, "%s\n", reference);
670 if (commit_lock_file(&lock))
671 die_errno(_("unable to move new alternates file into place"));
672 if (the_repository->objects->loaded_alternates)
673 link_alt_odb_entries(the_repository, reference,
674 '\n', NULL, 0);
676 free(alts);
679 void add_to_alternates_memory(const char *reference)
682 * Make sure alternates are initialized, or else our entry may be
683 * overwritten when they are.
685 prepare_alt_odb(the_repository);
687 link_alt_odb_entries(the_repository, reference,
688 '\n', NULL, 0);
691 struct object_directory *set_temporary_primary_odb(const char *dir, int will_destroy)
693 struct object_directory *new_odb;
696 * Make sure alternates are initialized, or else our entry may be
697 * overwritten when they are.
699 prepare_alt_odb(the_repository);
702 * Make a new primary odb and link the old primary ODB in as an
703 * alternate
705 new_odb = xcalloc(1, sizeof(*new_odb));
706 new_odb->path = xstrdup(dir);
709 * Disable ref updates while a temporary odb is active, since
710 * the objects in the database may roll back.
712 new_odb->disable_ref_updates = 1;
713 new_odb->will_destroy = will_destroy;
714 new_odb->next = the_repository->objects->odb;
715 the_repository->objects->odb = new_odb;
716 return new_odb->next;
719 void restore_primary_odb(struct object_directory *restore_odb, const char *old_path)
721 struct object_directory *cur_odb = the_repository->objects->odb;
723 if (strcmp(old_path, cur_odb->path))
724 BUG("expected %s as primary object store; found %s",
725 old_path, cur_odb->path);
727 if (cur_odb->next != restore_odb)
728 BUG("we expect the old primary object store to be the first alternate");
730 the_repository->objects->odb = restore_odb;
731 free_object_directory(cur_odb);
735 * Compute the exact path an alternate is at and returns it. In case of
736 * error NULL is returned and the human readable error is added to `err`
737 * `path` may be relative and should point to $GIT_DIR.
738 * `err` must not be null.
740 char *compute_alternate_path(const char *path, struct strbuf *err)
742 char *ref_git = NULL;
743 const char *repo;
744 int seen_error = 0;
746 ref_git = real_pathdup(path, 0);
747 if (!ref_git) {
748 seen_error = 1;
749 strbuf_addf(err, _("path '%s' does not exist"), path);
750 goto out;
753 repo = read_gitfile(ref_git);
754 if (!repo)
755 repo = read_gitfile(mkpath("%s/.git", ref_git));
756 if (repo) {
757 free(ref_git);
758 ref_git = xstrdup(repo);
761 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
762 char *ref_git_git = mkpathdup("%s/.git", ref_git);
763 free(ref_git);
764 ref_git = ref_git_git;
765 } else if (!is_directory(mkpath("%s/objects", ref_git))) {
766 struct strbuf sb = STRBUF_INIT;
767 seen_error = 1;
768 if (get_common_dir(&sb, ref_git)) {
769 strbuf_addf(err,
770 _("reference repository '%s' as a linked "
771 "checkout is not supported yet."),
772 path);
773 goto out;
776 strbuf_addf(err, _("reference repository '%s' is not a "
777 "local repository."), path);
778 goto out;
781 if (!access(mkpath("%s/shallow", ref_git), F_OK)) {
782 strbuf_addf(err, _("reference repository '%s' is shallow"),
783 path);
784 seen_error = 1;
785 goto out;
788 if (!access(mkpath("%s/info/grafts", ref_git), F_OK)) {
789 strbuf_addf(err,
790 _("reference repository '%s' is grafted"),
791 path);
792 seen_error = 1;
793 goto out;
796 out:
797 if (seen_error) {
798 FREE_AND_NULL(ref_git);
801 return ref_git;
804 struct object_directory *find_odb(struct repository *r, const char *obj_dir)
806 struct object_directory *odb;
807 char *obj_dir_real = real_pathdup(obj_dir, 1);
808 struct strbuf odb_path_real = STRBUF_INIT;
810 prepare_alt_odb(r);
811 for (odb = r->objects->odb; odb; odb = odb->next) {
812 strbuf_realpath(&odb_path_real, odb->path, 1);
813 if (!strcmp(obj_dir_real, odb_path_real.buf))
814 break;
817 free(obj_dir_real);
818 strbuf_release(&odb_path_real);
820 if (!odb)
821 die(_("could not find object directory matching %s"), obj_dir);
822 return odb;
825 static void fill_alternate_refs_command(struct child_process *cmd,
826 const char *repo_path)
828 const char *value;
830 if (!git_config_get_value("core.alternateRefsCommand", &value)) {
831 cmd->use_shell = 1;
833 strvec_push(&cmd->args, value);
834 strvec_push(&cmd->args, repo_path);
835 } else {
836 cmd->git_cmd = 1;
838 strvec_pushf(&cmd->args, "--git-dir=%s", repo_path);
839 strvec_push(&cmd->args, "for-each-ref");
840 strvec_push(&cmd->args, "--format=%(objectname)");
842 if (!git_config_get_value("core.alternateRefsPrefixes", &value)) {
843 strvec_push(&cmd->args, "--");
844 strvec_split(&cmd->args, value);
848 strvec_pushv(&cmd->env, (const char **)local_repo_env);
849 cmd->out = -1;
852 static void read_alternate_refs(const char *path,
853 alternate_ref_fn *cb,
854 void *data)
856 struct child_process cmd = CHILD_PROCESS_INIT;
857 struct strbuf line = STRBUF_INIT;
858 FILE *fh;
860 fill_alternate_refs_command(&cmd, path);
862 if (start_command(&cmd))
863 return;
865 fh = xfdopen(cmd.out, "r");
866 while (strbuf_getline_lf(&line, fh) != EOF) {
867 struct object_id oid;
868 const char *p;
870 if (parse_oid_hex(line.buf, &oid, &p) || *p) {
871 warning(_("invalid line while parsing alternate refs: %s"),
872 line.buf);
873 break;
876 cb(&oid, data);
879 fclose(fh);
880 finish_command(&cmd);
881 strbuf_release(&line);
884 struct alternate_refs_data {
885 alternate_ref_fn *fn;
886 void *data;
889 static int refs_from_alternate_cb(struct object_directory *e,
890 void *data)
892 struct strbuf path = STRBUF_INIT;
893 size_t base_len;
894 struct alternate_refs_data *cb = data;
896 if (!strbuf_realpath(&path, e->path, 0))
897 goto out;
898 if (!strbuf_strip_suffix(&path, "/objects"))
899 goto out;
900 base_len = path.len;
902 /* Is this a git repository with refs? */
903 strbuf_addstr(&path, "/refs");
904 if (!is_directory(path.buf))
905 goto out;
906 strbuf_setlen(&path, base_len);
908 read_alternate_refs(path.buf, cb->fn, cb->data);
910 out:
911 strbuf_release(&path);
912 return 0;
915 void for_each_alternate_ref(alternate_ref_fn fn, void *data)
917 struct alternate_refs_data cb;
918 cb.fn = fn;
919 cb.data = data;
920 foreach_alt_odb(refs_from_alternate_cb, &cb);
923 int foreach_alt_odb(alt_odb_fn fn, void *cb)
925 struct object_directory *ent;
926 int r = 0;
928 prepare_alt_odb(the_repository);
929 for (ent = the_repository->objects->odb->next; ent; ent = ent->next) {
930 r = fn(ent, cb);
931 if (r)
932 break;
934 return r;
937 void prepare_alt_odb(struct repository *r)
939 if (r->objects->loaded_alternates)
940 return;
942 link_alt_odb_entries(r, r->objects->alternate_db, PATH_SEP, NULL, 0);
944 read_info_alternates(r, r->objects->odb->path, 0);
945 r->objects->loaded_alternates = 1;
948 int has_alt_odb(struct repository *r)
950 prepare_alt_odb(r);
951 return !!r->objects->odb->next;
954 /* Returns 1 if we have successfully freshened the file, 0 otherwise. */
955 static int freshen_file(const char *fn)
957 return !utime(fn, NULL);
961 * All of the check_and_freshen functions return 1 if the file exists and was
962 * freshened (if freshening was requested), 0 otherwise. If they return
963 * 0, you should not assume that it is safe to skip a write of the object (it
964 * either does not exist on disk, or has a stale mtime and may be subject to
965 * pruning).
967 int check_and_freshen_file(const char *fn, int freshen)
969 if (access(fn, F_OK))
970 return 0;
971 if (freshen && !freshen_file(fn))
972 return 0;
973 return 1;
976 static int check_and_freshen_odb(struct object_directory *odb,
977 const struct object_id *oid,
978 int freshen)
980 static struct strbuf path = STRBUF_INIT;
981 odb_loose_path(odb, &path, oid);
982 return check_and_freshen_file(path.buf, freshen);
985 static int check_and_freshen_local(const struct object_id *oid, int freshen)
987 return check_and_freshen_odb(the_repository->objects->odb, oid, freshen);
990 static int check_and_freshen_nonlocal(const struct object_id *oid, int freshen)
992 struct object_directory *odb;
994 prepare_alt_odb(the_repository);
995 for (odb = the_repository->objects->odb->next; odb; odb = odb->next) {
996 if (check_and_freshen_odb(odb, oid, freshen))
997 return 1;
999 return 0;
1002 static int check_and_freshen(const struct object_id *oid, int freshen)
1004 return check_and_freshen_local(oid, freshen) ||
1005 check_and_freshen_nonlocal(oid, freshen);
1008 int has_loose_object_nonlocal(const struct object_id *oid)
1010 return check_and_freshen_nonlocal(oid, 0);
1013 int has_loose_object(const struct object_id *oid)
1015 return check_and_freshen(oid, 0);
1018 static void mmap_limit_check(size_t length)
1020 static size_t limit = 0;
1021 if (!limit) {
1022 limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
1023 if (!limit)
1024 limit = SIZE_MAX;
1026 if (length > limit)
1027 die(_("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX),
1028 (uintmax_t)length, (uintmax_t)limit);
1031 void *xmmap_gently(void *start, size_t length,
1032 int prot, int flags, int fd, off_t offset)
1034 void *ret;
1036 mmap_limit_check(length);
1037 ret = mmap(start, length, prot, flags, fd, offset);
1038 if (ret == MAP_FAILED && !length)
1039 ret = NULL;
1040 return ret;
1043 const char *mmap_os_err(void)
1045 static const char blank[] = "";
1046 #if defined(__linux__)
1047 if (errno == ENOMEM) {
1048 /* this continues an existing error message: */
1049 static const char enomem[] =
1050 ", check sys.vm.max_map_count and/or RLIMIT_DATA";
1051 return enomem;
1053 #endif /* OS-specific bits */
1054 return blank;
1057 void *xmmap(void *start, size_t length,
1058 int prot, int flags, int fd, off_t offset)
1060 void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
1061 if (ret == MAP_FAILED)
1062 die_errno(_("mmap failed%s"), mmap_os_err());
1063 return ret;
1066 static int format_object_header_literally(char *str, size_t size,
1067 const char *type, size_t objsize)
1069 return xsnprintf(str, size, "%s %"PRIuMAX, type, (uintmax_t)objsize) + 1;
1072 int format_object_header(char *str, size_t size, enum object_type type,
1073 size_t objsize)
1075 const char *name = type_name(type);
1077 if (!name)
1078 BUG("could not get a type name for 'enum object_type' value %d", type);
1080 return format_object_header_literally(str, size, name, objsize);
1083 int check_object_signature(struct repository *r, const struct object_id *oid,
1084 void *buf, unsigned long size,
1085 enum object_type type)
1087 struct object_id real_oid;
1089 hash_object_file(r->hash_algo, buf, size, type, &real_oid);
1091 return !oideq(oid, &real_oid) ? -1 : 0;
1094 int stream_object_signature(struct repository *r, const struct object_id *oid)
1096 struct object_id real_oid;
1097 unsigned long size;
1098 enum object_type obj_type;
1099 struct git_istream *st;
1100 git_hash_ctx c;
1101 char hdr[MAX_HEADER_LEN];
1102 int hdrlen;
1104 st = open_istream(r, oid, &obj_type, &size, NULL);
1105 if (!st)
1106 return -1;
1108 /* Generate the header */
1109 hdrlen = format_object_header(hdr, sizeof(hdr), obj_type, size);
1111 /* Sha1.. */
1112 r->hash_algo->init_fn(&c);
1113 r->hash_algo->update_fn(&c, hdr, hdrlen);
1114 for (;;) {
1115 char buf[1024 * 16];
1116 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1118 if (readlen < 0) {
1119 close_istream(st);
1120 return -1;
1122 if (!readlen)
1123 break;
1124 r->hash_algo->update_fn(&c, buf, readlen);
1126 r->hash_algo->final_oid_fn(&real_oid, &c);
1127 close_istream(st);
1128 return !oideq(oid, &real_oid) ? -1 : 0;
1131 int git_open_cloexec(const char *name, int flags)
1133 int fd;
1134 static int o_cloexec = O_CLOEXEC;
1136 fd = open(name, flags | o_cloexec);
1137 if ((o_cloexec & O_CLOEXEC) && fd < 0 && errno == EINVAL) {
1138 /* Try again w/o O_CLOEXEC: the kernel might not support it */
1139 o_cloexec &= ~O_CLOEXEC;
1140 fd = open(name, flags | o_cloexec);
1143 #if defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC)
1145 static int fd_cloexec = FD_CLOEXEC;
1147 if (!o_cloexec && 0 <= fd && fd_cloexec) {
1148 /* Opened w/o O_CLOEXEC? try with fcntl(2) to add it */
1149 int flags = fcntl(fd, F_GETFD);
1150 if (fcntl(fd, F_SETFD, flags | fd_cloexec))
1151 fd_cloexec = 0;
1154 #endif
1155 return fd;
1159 * Find "oid" as a loose object in the local repository or in an alternate.
1160 * Returns 0 on success, negative on failure.
1162 * The "path" out-parameter will give the path of the object we found (if any).
1163 * Note that it may point to static storage and is only valid until another
1164 * call to stat_loose_object().
1166 static int stat_loose_object(struct repository *r, const struct object_id *oid,
1167 struct stat *st, const char **path)
1169 struct object_directory *odb;
1170 static struct strbuf buf = STRBUF_INIT;
1172 prepare_alt_odb(r);
1173 for (odb = r->objects->odb; odb; odb = odb->next) {
1174 *path = odb_loose_path(odb, &buf, oid);
1175 if (!lstat(*path, st))
1176 return 0;
1179 return -1;
1183 * Like stat_loose_object(), but actually open the object and return the
1184 * descriptor. See the caveats on the "path" parameter above.
1186 static int open_loose_object(struct repository *r,
1187 const struct object_id *oid, const char **path)
1189 int fd;
1190 struct object_directory *odb;
1191 int most_interesting_errno = ENOENT;
1192 static struct strbuf buf = STRBUF_INIT;
1194 prepare_alt_odb(r);
1195 for (odb = r->objects->odb; odb; odb = odb->next) {
1196 *path = odb_loose_path(odb, &buf, oid);
1197 fd = git_open(*path);
1198 if (fd >= 0)
1199 return fd;
1201 if (most_interesting_errno == ENOENT)
1202 most_interesting_errno = errno;
1204 errno = most_interesting_errno;
1205 return -1;
1208 static int quick_has_loose(struct repository *r,
1209 const struct object_id *oid)
1211 struct object_directory *odb;
1213 prepare_alt_odb(r);
1214 for (odb = r->objects->odb; odb; odb = odb->next) {
1215 if (oidtree_contains(odb_loose_cache(odb, oid), oid))
1216 return 1;
1218 return 0;
1222 * Map and close the given loose object fd. The path argument is used for
1223 * error reporting.
1225 static void *map_fd(int fd, const char *path, unsigned long *size)
1227 void *map = NULL;
1228 struct stat st;
1230 if (!fstat(fd, &st)) {
1231 *size = xsize_t(st.st_size);
1232 if (!*size) {
1233 /* mmap() is forbidden on empty files */
1234 error(_("object file %s is empty"), path);
1235 close(fd);
1236 return NULL;
1238 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1240 close(fd);
1241 return map;
1244 void *map_loose_object(struct repository *r,
1245 const struct object_id *oid,
1246 unsigned long *size)
1248 const char *p;
1249 int fd = open_loose_object(r, oid, &p);
1251 if (fd < 0)
1252 return NULL;
1253 return map_fd(fd, p, size);
1256 enum unpack_loose_header_result unpack_loose_header(git_zstream *stream,
1257 unsigned char *map,
1258 unsigned long mapsize,
1259 void *buffer,
1260 unsigned long bufsiz,
1261 struct strbuf *header)
1263 int status;
1265 /* Get the data stream */
1266 memset(stream, 0, sizeof(*stream));
1267 stream->next_in = map;
1268 stream->avail_in = mapsize;
1269 stream->next_out = buffer;
1270 stream->avail_out = bufsiz;
1272 git_inflate_init(stream);
1273 obj_read_unlock();
1274 status = git_inflate(stream, 0);
1275 obj_read_lock();
1276 if (status < Z_OK)
1277 return ULHR_BAD;
1280 * Check if entire header is unpacked in the first iteration.
1282 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1283 return ULHR_OK;
1286 * We have a header longer than MAX_HEADER_LEN. The "header"
1287 * here is only non-NULL when we run "cat-file
1288 * --allow-unknown-type".
1290 if (!header)
1291 return ULHR_TOO_LONG;
1294 * buffer[0..bufsiz] was not large enough. Copy the partial
1295 * result out to header, and then append the result of further
1296 * reading the stream.
1298 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1299 stream->next_out = buffer;
1300 stream->avail_out = bufsiz;
1302 do {
1303 obj_read_unlock();
1304 status = git_inflate(stream, 0);
1305 obj_read_lock();
1306 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1307 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1308 return 0;
1309 stream->next_out = buffer;
1310 stream->avail_out = bufsiz;
1311 } while (status != Z_STREAM_END);
1312 return ULHR_TOO_LONG;
1315 static void *unpack_loose_rest(git_zstream *stream,
1316 void *buffer, unsigned long size,
1317 const struct object_id *oid)
1319 int bytes = strlen(buffer) + 1;
1320 unsigned char *buf = xmallocz(size);
1321 unsigned long n;
1322 int status = Z_OK;
1324 n = stream->total_out - bytes;
1325 if (n > size)
1326 n = size;
1327 memcpy(buf, (char *) buffer + bytes, n);
1328 bytes = n;
1329 if (bytes <= size) {
1331 * The above condition must be (bytes <= size), not
1332 * (bytes < size). In other words, even though we
1333 * expect no more output and set avail_out to zero,
1334 * the input zlib stream may have bytes that express
1335 * "this concludes the stream", and we *do* want to
1336 * eat that input.
1338 * Otherwise we would not be able to test that we
1339 * consumed all the input to reach the expected size;
1340 * we also want to check that zlib tells us that all
1341 * went well with status == Z_STREAM_END at the end.
1343 stream->next_out = buf + bytes;
1344 stream->avail_out = size - bytes;
1345 while (status == Z_OK) {
1346 obj_read_unlock();
1347 status = git_inflate(stream, Z_FINISH);
1348 obj_read_lock();
1351 if (status == Z_STREAM_END && !stream->avail_in) {
1352 git_inflate_end(stream);
1353 return buf;
1356 if (status < 0)
1357 error(_("corrupt loose object '%s'"), oid_to_hex(oid));
1358 else if (stream->avail_in)
1359 error(_("garbage at end of loose object '%s'"),
1360 oid_to_hex(oid));
1361 free(buf);
1362 return NULL;
1366 * We used to just use "sscanf()", but that's actually way
1367 * too permissive for what we want to check. So do an anal
1368 * object header parse by hand.
1370 int parse_loose_header(const char *hdr, struct object_info *oi)
1372 const char *type_buf = hdr;
1373 size_t size;
1374 int type, type_len = 0;
1377 * The type can be of any size but is followed by
1378 * a space.
1380 for (;;) {
1381 char c = *hdr++;
1382 if (!c)
1383 return -1;
1384 if (c == ' ')
1385 break;
1386 type_len++;
1389 type = type_from_string_gently(type_buf, type_len, 1);
1390 if (oi->type_name)
1391 strbuf_add(oi->type_name, type_buf, type_len);
1392 if (oi->typep)
1393 *oi->typep = type;
1396 * The length must follow immediately, and be in canonical
1397 * decimal format (ie "010" is not valid).
1399 size = *hdr++ - '0';
1400 if (size > 9)
1401 return -1;
1402 if (size) {
1403 for (;;) {
1404 unsigned long c = *hdr - '0';
1405 if (c > 9)
1406 break;
1407 hdr++;
1408 size = st_add(st_mult(size, 10), c);
1412 if (oi->sizep)
1413 *oi->sizep = cast_size_t_to_ulong(size);
1416 * The length must be followed by a zero byte
1418 if (*hdr)
1419 return -1;
1422 * The format is valid, but the type may still be bogus. The
1423 * Caller needs to check its oi->typep.
1425 return 0;
1428 static int loose_object_info(struct repository *r,
1429 const struct object_id *oid,
1430 struct object_info *oi, int flags)
1432 int status = 0;
1433 int fd;
1434 unsigned long mapsize;
1435 const char *path;
1436 void *map;
1437 git_zstream stream;
1438 char hdr[MAX_HEADER_LEN];
1439 struct strbuf hdrbuf = STRBUF_INIT;
1440 unsigned long size_scratch;
1441 enum object_type type_scratch;
1442 int allow_unknown = flags & OBJECT_INFO_ALLOW_UNKNOWN_TYPE;
1444 if (oi->delta_base_oid)
1445 oidclr(oi->delta_base_oid);
1448 * If we don't care about type or size, then we don't
1449 * need to look inside the object at all. Note that we
1450 * do not optimize out the stat call, even if the
1451 * caller doesn't care about the disk-size, since our
1452 * return value implicitly indicates whether the
1453 * object even exists.
1455 if (!oi->typep && !oi->type_name && !oi->sizep && !oi->contentp) {
1456 struct stat st;
1457 if (!oi->disk_sizep && (flags & OBJECT_INFO_QUICK))
1458 return quick_has_loose(r, oid) ? 0 : -1;
1459 if (stat_loose_object(r, oid, &st, &path) < 0)
1460 return -1;
1461 if (oi->disk_sizep)
1462 *oi->disk_sizep = st.st_size;
1463 return 0;
1466 fd = open_loose_object(r, oid, &path);
1467 if (fd < 0) {
1468 if (errno != ENOENT)
1469 error_errno(_("unable to open loose object %s"), oid_to_hex(oid));
1470 return -1;
1472 map = map_fd(fd, path, &mapsize);
1473 if (!map)
1474 return -1;
1476 if (!oi->sizep)
1477 oi->sizep = &size_scratch;
1478 if (!oi->typep)
1479 oi->typep = &type_scratch;
1481 if (oi->disk_sizep)
1482 *oi->disk_sizep = mapsize;
1484 switch (unpack_loose_header(&stream, map, mapsize, hdr, sizeof(hdr),
1485 allow_unknown ? &hdrbuf : NULL)) {
1486 case ULHR_OK:
1487 if (parse_loose_header(hdrbuf.len ? hdrbuf.buf : hdr, oi) < 0)
1488 status = error(_("unable to parse %s header"), oid_to_hex(oid));
1489 else if (!allow_unknown && *oi->typep < 0)
1490 die(_("invalid object type"));
1492 if (!oi->contentp)
1493 break;
1494 *oi->contentp = unpack_loose_rest(&stream, hdr, *oi->sizep, oid);
1495 if (*oi->contentp)
1496 goto cleanup;
1498 status = -1;
1499 break;
1500 case ULHR_BAD:
1501 status = error(_("unable to unpack %s header"),
1502 oid_to_hex(oid));
1503 break;
1504 case ULHR_TOO_LONG:
1505 status = error(_("header for %s too long, exceeds %d bytes"),
1506 oid_to_hex(oid), MAX_HEADER_LEN);
1507 break;
1510 if (status && (flags & OBJECT_INFO_DIE_IF_CORRUPT))
1511 die(_("loose object %s (stored in %s) is corrupt"),
1512 oid_to_hex(oid), path);
1514 git_inflate_end(&stream);
1515 cleanup:
1516 munmap(map, mapsize);
1517 if (oi->sizep == &size_scratch)
1518 oi->sizep = NULL;
1519 strbuf_release(&hdrbuf);
1520 if (oi->typep == &type_scratch)
1521 oi->typep = NULL;
1522 oi->whence = OI_LOOSE;
1523 return status;
1526 int obj_read_use_lock = 0;
1527 pthread_mutex_t obj_read_mutex;
1529 void enable_obj_read_lock(void)
1531 if (obj_read_use_lock)
1532 return;
1534 obj_read_use_lock = 1;
1535 init_recursive_mutex(&obj_read_mutex);
1538 void disable_obj_read_lock(void)
1540 if (!obj_read_use_lock)
1541 return;
1543 obj_read_use_lock = 0;
1544 pthread_mutex_destroy(&obj_read_mutex);
1547 int fetch_if_missing = 1;
1549 static int do_oid_object_info_extended(struct repository *r,
1550 const struct object_id *oid,
1551 struct object_info *oi, unsigned flags)
1553 static struct object_info blank_oi = OBJECT_INFO_INIT;
1554 struct cached_object *co;
1555 struct pack_entry e;
1556 int rtype;
1557 const struct object_id *real = oid;
1558 int already_retried = 0;
1561 if (flags & OBJECT_INFO_LOOKUP_REPLACE)
1562 real = lookup_replace_object(r, oid);
1564 if (is_null_oid(real))
1565 return -1;
1567 if (!oi)
1568 oi = &blank_oi;
1570 co = find_cached_object(real);
1571 if (co) {
1572 if (oi->typep)
1573 *(oi->typep) = co->type;
1574 if (oi->sizep)
1575 *(oi->sizep) = co->size;
1576 if (oi->disk_sizep)
1577 *(oi->disk_sizep) = 0;
1578 if (oi->delta_base_oid)
1579 oidclr(oi->delta_base_oid);
1580 if (oi->type_name)
1581 strbuf_addstr(oi->type_name, type_name(co->type));
1582 if (oi->contentp)
1583 *oi->contentp = xmemdupz(co->buf, co->size);
1584 oi->whence = OI_CACHED;
1585 return 0;
1588 while (1) {
1589 if (find_pack_entry(r, real, &e))
1590 break;
1592 /* Most likely it's a loose object. */
1593 if (!loose_object_info(r, real, oi, flags))
1594 return 0;
1596 /* Not a loose object; someone else may have just packed it. */
1597 if (!(flags & OBJECT_INFO_QUICK)) {
1598 reprepare_packed_git(r);
1599 if (find_pack_entry(r, real, &e))
1600 break;
1604 * If r is the_repository, this might be an attempt at
1605 * accessing a submodule object as if it were in the_repository
1606 * (having called add_submodule_odb() on that submodule's ODB).
1607 * If any such ODBs exist, register them and try again.
1609 if (r == the_repository &&
1610 register_all_submodule_odb_as_alternates())
1611 /* We added some alternates; retry */
1612 continue;
1614 /* Check if it is a missing object */
1615 if (fetch_if_missing && repo_has_promisor_remote(r) &&
1616 !already_retried &&
1617 !(flags & OBJECT_INFO_SKIP_FETCH_OBJECT)) {
1618 promisor_remote_get_direct(r, real, 1);
1619 already_retried = 1;
1620 continue;
1623 if (flags & OBJECT_INFO_DIE_IF_CORRUPT) {
1624 const struct packed_git *p;
1625 if ((flags & OBJECT_INFO_LOOKUP_REPLACE) && !oideq(real, oid))
1626 die(_("replacement %s not found for %s"),
1627 oid_to_hex(real), oid_to_hex(oid));
1628 if ((p = has_packed_and_bad(r, real)))
1629 die(_("packed object %s (stored in %s) is corrupt"),
1630 oid_to_hex(real), p->pack_name);
1632 return -1;
1635 if (oi == &blank_oi)
1637 * We know that the caller doesn't actually need the
1638 * information below, so return early.
1640 return 0;
1641 rtype = packed_object_info(r, e.p, e.offset, oi);
1642 if (rtype < 0) {
1643 mark_bad_packed_object(e.p, real);
1644 return do_oid_object_info_extended(r, real, oi, 0);
1645 } else if (oi->whence == OI_PACKED) {
1646 oi->u.packed.offset = e.offset;
1647 oi->u.packed.pack = e.p;
1648 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
1649 rtype == OBJ_OFS_DELTA);
1652 return 0;
1655 int oid_object_info_extended(struct repository *r, const struct object_id *oid,
1656 struct object_info *oi, unsigned flags)
1658 int ret;
1659 obj_read_lock();
1660 ret = do_oid_object_info_extended(r, oid, oi, flags);
1661 obj_read_unlock();
1662 return ret;
1666 /* returns enum object_type or negative */
1667 int oid_object_info(struct repository *r,
1668 const struct object_id *oid,
1669 unsigned long *sizep)
1671 enum object_type type;
1672 struct object_info oi = OBJECT_INFO_INIT;
1674 oi.typep = &type;
1675 oi.sizep = sizep;
1676 if (oid_object_info_extended(r, oid, &oi,
1677 OBJECT_INFO_LOOKUP_REPLACE) < 0)
1678 return -1;
1679 return type;
1682 int pretend_object_file(void *buf, unsigned long len, enum object_type type,
1683 struct object_id *oid)
1685 struct cached_object *co;
1687 hash_object_file(the_hash_algo, buf, len, type, oid);
1688 if (repo_has_object_file_with_flags(the_repository, oid, OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT) ||
1689 find_cached_object(oid))
1690 return 0;
1691 ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
1692 co = &cached_objects[cached_object_nr++];
1693 co->size = len;
1694 co->type = type;
1695 co->buf = xmalloc(len);
1696 memcpy(co->buf, buf, len);
1697 oidcpy(&co->oid, oid);
1698 return 0;
1702 * This function dies on corrupt objects; the callers who want to
1703 * deal with them should arrange to call oid_object_info_extended() and give
1704 * error messages themselves.
1706 void *repo_read_object_file(struct repository *r,
1707 const struct object_id *oid,
1708 enum object_type *type,
1709 unsigned long *size)
1711 struct object_info oi = OBJECT_INFO_INIT;
1712 unsigned flags = OBJECT_INFO_DIE_IF_CORRUPT | OBJECT_INFO_LOOKUP_REPLACE;
1713 void *data;
1715 oi.typep = type;
1716 oi.sizep = size;
1717 oi.contentp = &data;
1718 if (oid_object_info_extended(r, oid, &oi, flags))
1719 return NULL;
1721 return data;
1724 void *read_object_with_reference(struct repository *r,
1725 const struct object_id *oid,
1726 enum object_type required_type,
1727 unsigned long *size,
1728 struct object_id *actual_oid_return)
1730 enum object_type type;
1731 void *buffer;
1732 unsigned long isize;
1733 struct object_id actual_oid;
1735 oidcpy(&actual_oid, oid);
1736 while (1) {
1737 int ref_length = -1;
1738 const char *ref_type = NULL;
1740 buffer = repo_read_object_file(r, &actual_oid, &type, &isize);
1741 if (!buffer)
1742 return NULL;
1743 if (type == required_type) {
1744 *size = isize;
1745 if (actual_oid_return)
1746 oidcpy(actual_oid_return, &actual_oid);
1747 return buffer;
1749 /* Handle references */
1750 else if (type == OBJ_COMMIT)
1751 ref_type = "tree ";
1752 else if (type == OBJ_TAG)
1753 ref_type = "object ";
1754 else {
1755 free(buffer);
1756 return NULL;
1758 ref_length = strlen(ref_type);
1760 if (ref_length + the_hash_algo->hexsz > isize ||
1761 memcmp(buffer, ref_type, ref_length) ||
1762 get_oid_hex((char *) buffer + ref_length, &actual_oid)) {
1763 free(buffer);
1764 return NULL;
1766 free(buffer);
1767 /* Now we have the ID of the referred-to object in
1768 * actual_oid. Check again. */
1772 static void hash_object_body(const struct git_hash_algo *algo, git_hash_ctx *c,
1773 const void *buf, unsigned long len,
1774 struct object_id *oid,
1775 char *hdr, int *hdrlen)
1777 algo->init_fn(c);
1778 algo->update_fn(c, hdr, *hdrlen);
1779 algo->update_fn(c, buf, len);
1780 algo->final_oid_fn(oid, c);
1783 static void write_object_file_prepare(const struct git_hash_algo *algo,
1784 const void *buf, unsigned long len,
1785 enum object_type type, struct object_id *oid,
1786 char *hdr, int *hdrlen)
1788 git_hash_ctx c;
1790 /* Generate the header */
1791 *hdrlen = format_object_header(hdr, *hdrlen, type, len);
1793 /* Sha1.. */
1794 hash_object_body(algo, &c, buf, len, oid, hdr, hdrlen);
1797 static void write_object_file_prepare_literally(const struct git_hash_algo *algo,
1798 const void *buf, unsigned long len,
1799 const char *type, struct object_id *oid,
1800 char *hdr, int *hdrlen)
1802 git_hash_ctx c;
1804 *hdrlen = format_object_header_literally(hdr, *hdrlen, type, len);
1805 hash_object_body(algo, &c, buf, len, oid, hdr, hdrlen);
1809 * Move the just written object into its final resting place.
1811 int finalize_object_file(const char *tmpfile, const char *filename)
1813 int ret = 0;
1815 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
1816 goto try_rename;
1817 else if (link(tmpfile, filename))
1818 ret = errno;
1821 * Coda hack - coda doesn't like cross-directory links,
1822 * so we fall back to a rename, which will mean that it
1823 * won't be able to check collisions, but that's not a
1824 * big deal.
1826 * The same holds for FAT formatted media.
1828 * When this succeeds, we just return. We have nothing
1829 * left to unlink.
1831 if (ret && ret != EEXIST) {
1832 try_rename:
1833 if (!rename(tmpfile, filename))
1834 goto out;
1835 ret = errno;
1837 unlink_or_warn(tmpfile);
1838 if (ret) {
1839 if (ret != EEXIST) {
1840 return error_errno(_("unable to write file %s"), filename);
1842 /* FIXME!!! Collision check here ? */
1845 out:
1846 if (adjust_shared_perm(filename))
1847 return error(_("unable to set permission to '%s'"), filename);
1848 return 0;
1851 static void hash_object_file_literally(const struct git_hash_algo *algo,
1852 const void *buf, unsigned long len,
1853 const char *type, struct object_id *oid)
1855 char hdr[MAX_HEADER_LEN];
1856 int hdrlen = sizeof(hdr);
1858 write_object_file_prepare_literally(algo, buf, len, type, oid, hdr, &hdrlen);
1861 void hash_object_file(const struct git_hash_algo *algo, const void *buf,
1862 unsigned long len, enum object_type type,
1863 struct object_id *oid)
1865 hash_object_file_literally(algo, buf, len, type_name(type), oid);
1868 /* Finalize a file on disk, and close it. */
1869 static void close_loose_object(int fd, const char *filename)
1871 if (the_repository->objects->odb->will_destroy)
1872 goto out;
1874 if (batch_fsync_enabled(FSYNC_COMPONENT_LOOSE_OBJECT))
1875 fsync_loose_object_bulk_checkin(fd, filename);
1876 else if (fsync_object_files > 0)
1877 fsync_or_die(fd, filename);
1878 else
1879 fsync_component_or_die(FSYNC_COMPONENT_LOOSE_OBJECT, fd,
1880 filename);
1882 out:
1883 if (close(fd) != 0)
1884 die_errno(_("error when closing loose object file"));
1887 /* Size of directory component, including the ending '/' */
1888 static inline int directory_size(const char *filename)
1890 const char *s = strrchr(filename, '/');
1891 if (!s)
1892 return 0;
1893 return s - filename + 1;
1897 * This creates a temporary file in the same directory as the final
1898 * 'filename'
1900 * We want to avoid cross-directory filename renames, because those
1901 * can have problems on various filesystems (FAT, NFS, Coda).
1903 static int create_tmpfile(struct strbuf *tmp, const char *filename)
1905 int fd, dirlen = directory_size(filename);
1907 strbuf_reset(tmp);
1908 strbuf_add(tmp, filename, dirlen);
1909 strbuf_addstr(tmp, "tmp_obj_XXXXXX");
1910 fd = git_mkstemp_mode(tmp->buf, 0444);
1911 if (fd < 0 && dirlen && errno == ENOENT) {
1913 * Make sure the directory exists; note that the contents
1914 * of the buffer are undefined after mkstemp returns an
1915 * error, so we have to rewrite the whole buffer from
1916 * scratch.
1918 strbuf_reset(tmp);
1919 strbuf_add(tmp, filename, dirlen - 1);
1920 if (mkdir(tmp->buf, 0777) && errno != EEXIST)
1921 return -1;
1922 if (adjust_shared_perm(tmp->buf))
1923 return -1;
1925 /* Try again */
1926 strbuf_addstr(tmp, "/tmp_obj_XXXXXX");
1927 fd = git_mkstemp_mode(tmp->buf, 0444);
1929 return fd;
1933 * Common steps for loose object writers to start writing loose
1934 * objects:
1936 * - Create tmpfile for the loose object.
1937 * - Setup zlib stream for compression.
1938 * - Start to feed header to zlib stream.
1940 * Returns a "fd", which should later be provided to
1941 * end_loose_object_common().
1943 static int start_loose_object_common(struct strbuf *tmp_file,
1944 const char *filename, unsigned flags,
1945 git_zstream *stream,
1946 unsigned char *buf, size_t buflen,
1947 git_hash_ctx *c,
1948 char *hdr, int hdrlen)
1950 int fd;
1952 fd = create_tmpfile(tmp_file, filename);
1953 if (fd < 0) {
1954 if (flags & HASH_SILENT)
1955 return -1;
1956 else if (errno == EACCES)
1957 return error(_("insufficient permission for adding "
1958 "an object to repository database %s"),
1959 get_object_directory());
1960 else
1961 return error_errno(
1962 _("unable to create temporary file"));
1965 /* Setup zlib stream for compression */
1966 git_deflate_init(stream, zlib_compression_level);
1967 stream->next_out = buf;
1968 stream->avail_out = buflen;
1969 the_hash_algo->init_fn(c);
1971 /* Start to feed header to zlib stream */
1972 stream->next_in = (unsigned char *)hdr;
1973 stream->avail_in = hdrlen;
1974 while (git_deflate(stream, 0) == Z_OK)
1975 ; /* nothing */
1976 the_hash_algo->update_fn(c, hdr, hdrlen);
1978 return fd;
1982 * Common steps for the inner git_deflate() loop for writing loose
1983 * objects. Returns what git_deflate() returns.
1985 static int write_loose_object_common(git_hash_ctx *c,
1986 git_zstream *stream, const int flush,
1987 unsigned char *in0, const int fd,
1988 unsigned char *compressed,
1989 const size_t compressed_len)
1991 int ret;
1993 ret = git_deflate(stream, flush ? Z_FINISH : 0);
1994 the_hash_algo->update_fn(c, in0, stream->next_in - in0);
1995 if (write_in_full(fd, compressed, stream->next_out - compressed) < 0)
1996 die_errno(_("unable to write loose object file"));
1997 stream->next_out = compressed;
1998 stream->avail_out = compressed_len;
2000 return ret;
2004 * Common steps for loose object writers to end writing loose objects:
2006 * - End the compression of zlib stream.
2007 * - Get the calculated oid to "oid".
2009 static int end_loose_object_common(git_hash_ctx *c, git_zstream *stream,
2010 struct object_id *oid)
2012 int ret;
2014 ret = git_deflate_end_gently(stream);
2015 if (ret != Z_OK)
2016 return ret;
2017 the_hash_algo->final_oid_fn(oid, c);
2019 return Z_OK;
2022 static int write_loose_object(const struct object_id *oid, char *hdr,
2023 int hdrlen, const void *buf, unsigned long len,
2024 time_t mtime, unsigned flags)
2026 int fd, ret;
2027 unsigned char compressed[4096];
2028 git_zstream stream;
2029 git_hash_ctx c;
2030 struct object_id parano_oid;
2031 static struct strbuf tmp_file = STRBUF_INIT;
2032 static struct strbuf filename = STRBUF_INIT;
2034 if (batch_fsync_enabled(FSYNC_COMPONENT_LOOSE_OBJECT))
2035 prepare_loose_object_bulk_checkin();
2037 loose_object_path(the_repository, &filename, oid);
2039 fd = start_loose_object_common(&tmp_file, filename.buf, flags,
2040 &stream, compressed, sizeof(compressed),
2041 &c, hdr, hdrlen);
2042 if (fd < 0)
2043 return -1;
2045 /* Then the data itself.. */
2046 stream.next_in = (void *)buf;
2047 stream.avail_in = len;
2048 do {
2049 unsigned char *in0 = stream.next_in;
2051 ret = write_loose_object_common(&c, &stream, 1, in0, fd,
2052 compressed, sizeof(compressed));
2053 } while (ret == Z_OK);
2055 if (ret != Z_STREAM_END)
2056 die(_("unable to deflate new object %s (%d)"), oid_to_hex(oid),
2057 ret);
2058 ret = end_loose_object_common(&c, &stream, &parano_oid);
2059 if (ret != Z_OK)
2060 die(_("deflateEnd on object %s failed (%d)"), oid_to_hex(oid),
2061 ret);
2062 if (!oideq(oid, &parano_oid))
2063 die(_("confused by unstable object source data for %s"),
2064 oid_to_hex(oid));
2066 close_loose_object(fd, tmp_file.buf);
2068 if (mtime) {
2069 struct utimbuf utb;
2070 utb.actime = mtime;
2071 utb.modtime = mtime;
2072 if (utime(tmp_file.buf, &utb) < 0 &&
2073 !(flags & HASH_SILENT))
2074 warning_errno(_("failed utime() on %s"), tmp_file.buf);
2077 return finalize_object_file(tmp_file.buf, filename.buf);
2080 static int freshen_loose_object(const struct object_id *oid)
2082 return check_and_freshen(oid, 1);
2085 static int freshen_packed_object(const struct object_id *oid)
2087 struct pack_entry e;
2088 if (!find_pack_entry(the_repository, oid, &e))
2089 return 0;
2090 if (e.p->is_cruft)
2091 return 0;
2092 if (e.p->freshened)
2093 return 1;
2094 if (!freshen_file(e.p->pack_name))
2095 return 0;
2096 e.p->freshened = 1;
2097 return 1;
2100 int stream_loose_object(struct input_stream *in_stream, size_t len,
2101 struct object_id *oid)
2103 int fd, ret, err = 0, flush = 0;
2104 unsigned char compressed[4096];
2105 git_zstream stream;
2106 git_hash_ctx c;
2107 struct strbuf tmp_file = STRBUF_INIT;
2108 struct strbuf filename = STRBUF_INIT;
2109 int dirlen;
2110 char hdr[MAX_HEADER_LEN];
2111 int hdrlen;
2113 if (batch_fsync_enabled(FSYNC_COMPONENT_LOOSE_OBJECT))
2114 prepare_loose_object_bulk_checkin();
2116 /* Since oid is not determined, save tmp file to odb path. */
2117 strbuf_addf(&filename, "%s/", get_object_directory());
2118 hdrlen = format_object_header(hdr, sizeof(hdr), OBJ_BLOB, len);
2121 * Common steps for write_loose_object and stream_loose_object to
2122 * start writing loose objects:
2124 * - Create tmpfile for the loose object.
2125 * - Setup zlib stream for compression.
2126 * - Start to feed header to zlib stream.
2128 fd = start_loose_object_common(&tmp_file, filename.buf, 0,
2129 &stream, compressed, sizeof(compressed),
2130 &c, hdr, hdrlen);
2131 if (fd < 0) {
2132 err = -1;
2133 goto cleanup;
2136 /* Then the data itself.. */
2137 do {
2138 unsigned char *in0 = stream.next_in;
2140 if (!stream.avail_in && !in_stream->is_finished) {
2141 const void *in = in_stream->read(in_stream, &stream.avail_in);
2142 stream.next_in = (void *)in;
2143 in0 = (unsigned char *)in;
2144 /* All data has been read. */
2145 if (in_stream->is_finished)
2146 flush = 1;
2148 ret = write_loose_object_common(&c, &stream, flush, in0, fd,
2149 compressed, sizeof(compressed));
2151 * Unlike write_loose_object(), we do not have the entire
2152 * buffer. If we get Z_BUF_ERROR due to too few input bytes,
2153 * then we'll replenish them in the next input_stream->read()
2154 * call when we loop.
2156 } while (ret == Z_OK || ret == Z_BUF_ERROR);
2158 if (stream.total_in != len + hdrlen)
2159 die(_("write stream object %ld != %"PRIuMAX), stream.total_in,
2160 (uintmax_t)len + hdrlen);
2163 * Common steps for write_loose_object and stream_loose_object to
2164 * end writing loose oject:
2166 * - End the compression of zlib stream.
2167 * - Get the calculated oid.
2169 if (ret != Z_STREAM_END)
2170 die(_("unable to stream deflate new object (%d)"), ret);
2171 ret = end_loose_object_common(&c, &stream, oid);
2172 if (ret != Z_OK)
2173 die(_("deflateEnd on stream object failed (%d)"), ret);
2174 close_loose_object(fd, tmp_file.buf);
2176 if (freshen_packed_object(oid) || freshen_loose_object(oid)) {
2177 unlink_or_warn(tmp_file.buf);
2178 goto cleanup;
2181 loose_object_path(the_repository, &filename, oid);
2183 /* We finally know the object path, and create the missing dir. */
2184 dirlen = directory_size(filename.buf);
2185 if (dirlen) {
2186 struct strbuf dir = STRBUF_INIT;
2187 strbuf_add(&dir, filename.buf, dirlen);
2189 if (mkdir_in_gitdir(dir.buf) && errno != EEXIST) {
2190 err = error_errno(_("unable to create directory %s"), dir.buf);
2191 strbuf_release(&dir);
2192 goto cleanup;
2194 strbuf_release(&dir);
2197 err = finalize_object_file(tmp_file.buf, filename.buf);
2198 cleanup:
2199 strbuf_release(&tmp_file);
2200 strbuf_release(&filename);
2201 return err;
2204 int write_object_file_flags(const void *buf, unsigned long len,
2205 enum object_type type, struct object_id *oid,
2206 unsigned flags)
2208 char hdr[MAX_HEADER_LEN];
2209 int hdrlen = sizeof(hdr);
2211 /* Normally if we have it in the pack then we do not bother writing
2212 * it out into .git/objects/??/?{38} file.
2214 write_object_file_prepare(the_hash_algo, buf, len, type, oid, hdr,
2215 &hdrlen);
2216 if (freshen_packed_object(oid) || freshen_loose_object(oid))
2217 return 0;
2218 return write_loose_object(oid, hdr, hdrlen, buf, len, 0, flags);
2221 int write_object_file_literally(const void *buf, unsigned long len,
2222 const char *type, struct object_id *oid,
2223 unsigned flags)
2225 char *header;
2226 int hdrlen, status = 0;
2228 /* type string, SP, %lu of the length plus NUL must fit this */
2229 hdrlen = strlen(type) + MAX_HEADER_LEN;
2230 header = xmalloc(hdrlen);
2231 write_object_file_prepare_literally(the_hash_algo, buf, len, type,
2232 oid, header, &hdrlen);
2234 if (!(flags & HASH_WRITE_OBJECT))
2235 goto cleanup;
2236 if (freshen_packed_object(oid) || freshen_loose_object(oid))
2237 goto cleanup;
2238 status = write_loose_object(oid, header, hdrlen, buf, len, 0, 0);
2240 cleanup:
2241 free(header);
2242 return status;
2245 int force_object_loose(const struct object_id *oid, time_t mtime)
2247 void *buf;
2248 unsigned long len;
2249 struct object_info oi = OBJECT_INFO_INIT;
2250 enum object_type type;
2251 char hdr[MAX_HEADER_LEN];
2252 int hdrlen;
2253 int ret;
2255 if (has_loose_object(oid))
2256 return 0;
2257 oi.typep = &type;
2258 oi.sizep = &len;
2259 oi.contentp = &buf;
2260 if (oid_object_info_extended(the_repository, oid, &oi, 0))
2261 return error(_("cannot read object for %s"), oid_to_hex(oid));
2262 hdrlen = format_object_header(hdr, sizeof(hdr), type, len);
2263 ret = write_loose_object(oid, hdr, hdrlen, buf, len, mtime, 0);
2264 free(buf);
2266 return ret;
2269 int has_object(struct repository *r, const struct object_id *oid,
2270 unsigned flags)
2272 int quick = !(flags & HAS_OBJECT_RECHECK_PACKED);
2273 unsigned object_info_flags = OBJECT_INFO_SKIP_FETCH_OBJECT |
2274 (quick ? OBJECT_INFO_QUICK : 0);
2276 if (!startup_info->have_repository)
2277 return 0;
2278 return oid_object_info_extended(r, oid, NULL, object_info_flags) >= 0;
2281 int repo_has_object_file_with_flags(struct repository *r,
2282 const struct object_id *oid, int flags)
2284 if (!startup_info->have_repository)
2285 return 0;
2286 return oid_object_info_extended(r, oid, NULL, flags) >= 0;
2289 int repo_has_object_file(struct repository *r,
2290 const struct object_id *oid)
2292 return repo_has_object_file_with_flags(r, oid, 0);
2296 * We can't use the normal fsck_error_function() for index_mem(),
2297 * because we don't yet have a valid oid for it to report. Instead,
2298 * report the minimal fsck error here, and rely on the caller to
2299 * give more context.
2301 static int hash_format_check_report(struct fsck_options *opts UNUSED,
2302 const struct object_id *oid UNUSED,
2303 enum object_type object_type UNUSED,
2304 enum fsck_msg_type msg_type UNUSED,
2305 enum fsck_msg_id msg_id UNUSED,
2306 const char *message)
2308 error(_("object fails fsck: %s"), message);
2309 return 1;
2312 static int index_mem(struct index_state *istate,
2313 struct object_id *oid, void *buf, size_t size,
2314 enum object_type type,
2315 const char *path, unsigned flags)
2317 int ret = 0;
2318 int re_allocated = 0;
2319 int write_object = flags & HASH_WRITE_OBJECT;
2321 if (!type)
2322 type = OBJ_BLOB;
2325 * Convert blobs to git internal format
2327 if ((type == OBJ_BLOB) && path) {
2328 struct strbuf nbuf = STRBUF_INIT;
2329 if (convert_to_git(istate, path, buf, size, &nbuf,
2330 get_conv_flags(flags))) {
2331 buf = strbuf_detach(&nbuf, &size);
2332 re_allocated = 1;
2335 if (flags & HASH_FORMAT_CHECK) {
2336 struct fsck_options opts = FSCK_OPTIONS_DEFAULT;
2338 opts.strict = 1;
2339 opts.error_func = hash_format_check_report;
2340 if (fsck_buffer(null_oid(), type, buf, size, &opts))
2341 die(_("refusing to create malformed object"));
2342 fsck_finish(&opts);
2345 if (write_object)
2346 ret = write_object_file(buf, size, type, oid);
2347 else
2348 hash_object_file(the_hash_algo, buf, size, type, oid);
2349 if (re_allocated)
2350 free(buf);
2351 return ret;
2354 static int index_stream_convert_blob(struct index_state *istate,
2355 struct object_id *oid,
2356 int fd,
2357 const char *path,
2358 unsigned flags)
2360 int ret = 0;
2361 const int write_object = flags & HASH_WRITE_OBJECT;
2362 struct strbuf sbuf = STRBUF_INIT;
2364 assert(path);
2365 assert(would_convert_to_git_filter_fd(istate, path));
2367 convert_to_git_filter_fd(istate, path, fd, &sbuf,
2368 get_conv_flags(flags));
2370 if (write_object)
2371 ret = write_object_file(sbuf.buf, sbuf.len, OBJ_BLOB,
2372 oid);
2373 else
2374 hash_object_file(the_hash_algo, sbuf.buf, sbuf.len, OBJ_BLOB,
2375 oid);
2376 strbuf_release(&sbuf);
2377 return ret;
2380 static int index_pipe(struct index_state *istate, struct object_id *oid,
2381 int fd, enum object_type type,
2382 const char *path, unsigned flags)
2384 struct strbuf sbuf = STRBUF_INIT;
2385 int ret;
2387 if (strbuf_read(&sbuf, fd, 4096) >= 0)
2388 ret = index_mem(istate, oid, sbuf.buf, sbuf.len, type, path, flags);
2389 else
2390 ret = -1;
2391 strbuf_release(&sbuf);
2392 return ret;
2395 #define SMALL_FILE_SIZE (32*1024)
2397 static int index_core(struct index_state *istate,
2398 struct object_id *oid, int fd, size_t size,
2399 enum object_type type, const char *path,
2400 unsigned flags)
2402 int ret;
2404 if (!size) {
2405 ret = index_mem(istate, oid, "", size, type, path, flags);
2406 } else if (size <= SMALL_FILE_SIZE) {
2407 char *buf = xmalloc(size);
2408 ssize_t read_result = read_in_full(fd, buf, size);
2409 if (read_result < 0)
2410 ret = error_errno(_("read error while indexing %s"),
2411 path ? path : "<unknown>");
2412 else if (read_result != size)
2413 ret = error(_("short read while indexing %s"),
2414 path ? path : "<unknown>");
2415 else
2416 ret = index_mem(istate, oid, buf, size, type, path, flags);
2417 free(buf);
2418 } else {
2419 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
2420 ret = index_mem(istate, oid, buf, size, type, path, flags);
2421 munmap(buf, size);
2423 return ret;
2427 * This creates one packfile per large blob unless bulk-checkin
2428 * machinery is "plugged".
2430 * This also bypasses the usual "convert-to-git" dance, and that is on
2431 * purpose. We could write a streaming version of the converting
2432 * functions and insert that before feeding the data to fast-import
2433 * (or equivalent in-core API described above). However, that is
2434 * somewhat complicated, as we do not know the size of the filter
2435 * result, which we need to know beforehand when writing a git object.
2436 * Since the primary motivation for trying to stream from the working
2437 * tree file and to avoid mmaping it in core is to deal with large
2438 * binary blobs, they generally do not want to get any conversion, and
2439 * callers should avoid this code path when filters are requested.
2441 static int index_blob_stream(struct object_id *oid, int fd, size_t size,
2442 const char *path,
2443 unsigned flags)
2445 return index_blob_bulk_checkin(oid, fd, size, path, flags);
2448 int index_fd(struct index_state *istate, struct object_id *oid,
2449 int fd, struct stat *st,
2450 enum object_type type, const char *path, unsigned flags)
2452 int ret;
2455 * Call xsize_t() only when needed to avoid potentially unnecessary
2456 * die() for large files.
2458 if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(istate, path))
2459 ret = index_stream_convert_blob(istate, oid, fd, path, flags);
2460 else if (!S_ISREG(st->st_mode))
2461 ret = index_pipe(istate, oid, fd, type, path, flags);
2462 else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
2463 (path && would_convert_to_git(istate, path)))
2464 ret = index_core(istate, oid, fd, xsize_t(st->st_size),
2465 type, path, flags);
2466 else
2467 ret = index_blob_stream(oid, fd, xsize_t(st->st_size), path,
2468 flags);
2469 close(fd);
2470 return ret;
2473 int index_path(struct index_state *istate, struct object_id *oid,
2474 const char *path, struct stat *st, unsigned flags)
2476 int fd;
2477 struct strbuf sb = STRBUF_INIT;
2478 int rc = 0;
2480 switch (st->st_mode & S_IFMT) {
2481 case S_IFREG:
2482 fd = open(path, O_RDONLY);
2483 if (fd < 0)
2484 return error_errno("open(\"%s\")", path);
2485 if (index_fd(istate, oid, fd, st, OBJ_BLOB, path, flags) < 0)
2486 return error(_("%s: failed to insert into database"),
2487 path);
2488 break;
2489 case S_IFLNK:
2490 if (strbuf_readlink(&sb, path, st->st_size))
2491 return error_errno("readlink(\"%s\")", path);
2492 if (!(flags & HASH_WRITE_OBJECT))
2493 hash_object_file(the_hash_algo, sb.buf, sb.len,
2494 OBJ_BLOB, oid);
2495 else if (write_object_file(sb.buf, sb.len, OBJ_BLOB, oid))
2496 rc = error(_("%s: failed to insert into database"), path);
2497 strbuf_release(&sb);
2498 break;
2499 case S_IFDIR:
2500 return resolve_gitlink_ref(path, "HEAD", oid);
2501 default:
2502 return error(_("%s: unsupported file type"), path);
2504 return rc;
2507 int read_pack_header(int fd, struct pack_header *header)
2509 if (read_in_full(fd, header, sizeof(*header)) != sizeof(*header))
2510 /* "eof before pack header was fully read" */
2511 return PH_ERROR_EOF;
2513 if (header->hdr_signature != htonl(PACK_SIGNATURE))
2514 /* "protocol error (pack signature mismatch detected)" */
2515 return PH_ERROR_PACK_SIGNATURE;
2516 if (!pack_version_ok(header->hdr_version))
2517 /* "protocol error (pack version unsupported)" */
2518 return PH_ERROR_PROTOCOL;
2519 return 0;
2522 void assert_oid_type(const struct object_id *oid, enum object_type expect)
2524 enum object_type type = oid_object_info(the_repository, oid, NULL);
2525 if (type < 0)
2526 die(_("%s is not a valid object"), oid_to_hex(oid));
2527 if (type != expect)
2528 die(_("%s is not a valid '%s' object"), oid_to_hex(oid),
2529 type_name(expect));
2532 int for_each_file_in_obj_subdir(unsigned int subdir_nr,
2533 struct strbuf *path,
2534 each_loose_object_fn obj_cb,
2535 each_loose_cruft_fn cruft_cb,
2536 each_loose_subdir_fn subdir_cb,
2537 void *data)
2539 size_t origlen, baselen;
2540 DIR *dir;
2541 struct dirent *de;
2542 int r = 0;
2543 struct object_id oid;
2545 if (subdir_nr > 0xff)
2546 BUG("invalid loose object subdirectory: %x", subdir_nr);
2548 origlen = path->len;
2549 strbuf_complete(path, '/');
2550 strbuf_addf(path, "%02x", subdir_nr);
2552 dir = opendir(path->buf);
2553 if (!dir) {
2554 if (errno != ENOENT)
2555 r = error_errno(_("unable to open %s"), path->buf);
2556 strbuf_setlen(path, origlen);
2557 return r;
2560 oid.hash[0] = subdir_nr;
2561 strbuf_addch(path, '/');
2562 baselen = path->len;
2564 while ((de = readdir_skip_dot_and_dotdot(dir))) {
2565 size_t namelen;
2567 namelen = strlen(de->d_name);
2568 strbuf_setlen(path, baselen);
2569 strbuf_add(path, de->d_name, namelen);
2570 if (namelen == the_hash_algo->hexsz - 2 &&
2571 !hex_to_bytes(oid.hash + 1, de->d_name,
2572 the_hash_algo->rawsz - 1)) {
2573 oid_set_algo(&oid, the_hash_algo);
2574 if (obj_cb) {
2575 r = obj_cb(&oid, path->buf, data);
2576 if (r)
2577 break;
2579 continue;
2582 if (cruft_cb) {
2583 r = cruft_cb(de->d_name, path->buf, data);
2584 if (r)
2585 break;
2588 closedir(dir);
2590 strbuf_setlen(path, baselen - 1);
2591 if (!r && subdir_cb)
2592 r = subdir_cb(subdir_nr, path->buf, data);
2594 strbuf_setlen(path, origlen);
2596 return r;
2599 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
2600 each_loose_object_fn obj_cb,
2601 each_loose_cruft_fn cruft_cb,
2602 each_loose_subdir_fn subdir_cb,
2603 void *data)
2605 int r = 0;
2606 int i;
2608 for (i = 0; i < 256; i++) {
2609 r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
2610 subdir_cb, data);
2611 if (r)
2612 break;
2615 return r;
2618 int for_each_loose_file_in_objdir(const char *path,
2619 each_loose_object_fn obj_cb,
2620 each_loose_cruft_fn cruft_cb,
2621 each_loose_subdir_fn subdir_cb,
2622 void *data)
2624 struct strbuf buf = STRBUF_INIT;
2625 int r;
2627 strbuf_addstr(&buf, path);
2628 r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
2629 subdir_cb, data);
2630 strbuf_release(&buf);
2632 return r;
2635 int for_each_loose_object(each_loose_object_fn cb, void *data,
2636 enum for_each_object_flags flags)
2638 struct object_directory *odb;
2640 prepare_alt_odb(the_repository);
2641 for (odb = the_repository->objects->odb; odb; odb = odb->next) {
2642 int r = for_each_loose_file_in_objdir(odb->path, cb, NULL,
2643 NULL, data);
2644 if (r)
2645 return r;
2647 if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
2648 break;
2651 return 0;
2654 static int append_loose_object(const struct object_id *oid,
2655 const char *path UNUSED,
2656 void *data)
2658 oidtree_insert(data, oid);
2659 return 0;
2662 struct oidtree *odb_loose_cache(struct object_directory *odb,
2663 const struct object_id *oid)
2665 int subdir_nr = oid->hash[0];
2666 struct strbuf buf = STRBUF_INIT;
2667 size_t word_bits = bitsizeof(odb->loose_objects_subdir_seen[0]);
2668 size_t word_index = subdir_nr / word_bits;
2669 size_t mask = (size_t)1u << (subdir_nr % word_bits);
2670 uint32_t *bitmap;
2672 if (subdir_nr < 0 ||
2673 subdir_nr >= bitsizeof(odb->loose_objects_subdir_seen))
2674 BUG("subdir_nr out of range");
2676 bitmap = &odb->loose_objects_subdir_seen[word_index];
2677 if (*bitmap & mask)
2678 return odb->loose_objects_cache;
2679 if (!odb->loose_objects_cache) {
2680 ALLOC_ARRAY(odb->loose_objects_cache, 1);
2681 oidtree_init(odb->loose_objects_cache);
2683 strbuf_addstr(&buf, odb->path);
2684 for_each_file_in_obj_subdir(subdir_nr, &buf,
2685 append_loose_object,
2686 NULL, NULL,
2687 odb->loose_objects_cache);
2688 *bitmap |= mask;
2689 strbuf_release(&buf);
2690 return odb->loose_objects_cache;
2693 void odb_clear_loose_cache(struct object_directory *odb)
2695 oidtree_clear(odb->loose_objects_cache);
2696 FREE_AND_NULL(odb->loose_objects_cache);
2697 memset(&odb->loose_objects_subdir_seen, 0,
2698 sizeof(odb->loose_objects_subdir_seen));
2701 static int check_stream_oid(git_zstream *stream,
2702 const char *hdr,
2703 unsigned long size,
2704 const char *path,
2705 const struct object_id *expected_oid)
2707 git_hash_ctx c;
2708 struct object_id real_oid;
2709 unsigned char buf[4096];
2710 unsigned long total_read;
2711 int status = Z_OK;
2713 the_hash_algo->init_fn(&c);
2714 the_hash_algo->update_fn(&c, hdr, stream->total_out);
2717 * We already read some bytes into hdr, but the ones up to the NUL
2718 * do not count against the object's content size.
2720 total_read = stream->total_out - strlen(hdr) - 1;
2723 * This size comparison must be "<=" to read the final zlib packets;
2724 * see the comment in unpack_loose_rest for details.
2726 while (total_read <= size &&
2727 (status == Z_OK ||
2728 (status == Z_BUF_ERROR && !stream->avail_out))) {
2729 stream->next_out = buf;
2730 stream->avail_out = sizeof(buf);
2731 if (size - total_read < stream->avail_out)
2732 stream->avail_out = size - total_read;
2733 status = git_inflate(stream, Z_FINISH);
2734 the_hash_algo->update_fn(&c, buf, stream->next_out - buf);
2735 total_read += stream->next_out - buf;
2737 git_inflate_end(stream);
2739 if (status != Z_STREAM_END) {
2740 error(_("corrupt loose object '%s'"), oid_to_hex(expected_oid));
2741 return -1;
2743 if (stream->avail_in) {
2744 error(_("garbage at end of loose object '%s'"),
2745 oid_to_hex(expected_oid));
2746 return -1;
2749 the_hash_algo->final_oid_fn(&real_oid, &c);
2750 if (!oideq(expected_oid, &real_oid)) {
2751 error(_("hash mismatch for %s (expected %s)"), path,
2752 oid_to_hex(expected_oid));
2753 return -1;
2756 return 0;
2759 int read_loose_object(const char *path,
2760 const struct object_id *expected_oid,
2761 struct object_id *real_oid,
2762 void **contents,
2763 struct object_info *oi)
2765 int ret = -1;
2766 int fd;
2767 void *map = NULL;
2768 unsigned long mapsize;
2769 git_zstream stream;
2770 char hdr[MAX_HEADER_LEN];
2771 unsigned long *size = oi->sizep;
2773 fd = git_open(path);
2774 if (fd >= 0)
2775 map = map_fd(fd, path, &mapsize);
2776 if (!map) {
2777 error_errno(_("unable to mmap %s"), path);
2778 goto out;
2781 if (unpack_loose_header(&stream, map, mapsize, hdr, sizeof(hdr),
2782 NULL) != ULHR_OK) {
2783 error(_("unable to unpack header of %s"), path);
2784 goto out;
2787 if (parse_loose_header(hdr, oi) < 0) {
2788 error(_("unable to parse header of %s"), path);
2789 git_inflate_end(&stream);
2790 goto out;
2793 if (*oi->typep == OBJ_BLOB && *size > big_file_threshold) {
2794 if (check_stream_oid(&stream, hdr, *size, path, expected_oid) < 0)
2795 goto out;
2796 } else {
2797 *contents = unpack_loose_rest(&stream, hdr, *size, expected_oid);
2798 if (!*contents) {
2799 error(_("unable to unpack contents of %s"), path);
2800 git_inflate_end(&stream);
2801 goto out;
2803 hash_object_file_literally(the_repository->hash_algo,
2804 *contents, *size,
2805 oi->type_name->buf, real_oid);
2806 if (!oideq(expected_oid, real_oid))
2807 goto out;
2810 ret = 0; /* everything checks out */
2812 out:
2813 if (map)
2814 munmap(map, mapsize);
2815 return ret;