merge-tree: mark unused parameter in traverse callback
[git.git] / object-file.c
blob68a2397e33a00cd3ef60ad6f138dc69e69c2225b
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 "alloc.h"
12 #include "config.h"
13 #include "convert.h"
14 #include "environment.h"
15 #include "gettext.h"
16 #include "hex.h"
17 #include "string-list.h"
18 #include "lockfile.h"
19 #include "delta.h"
20 #include "pack.h"
21 #include "blob.h"
22 #include "commit.h"
23 #include "run-command.h"
24 #include "tag.h"
25 #include "tree.h"
26 #include "tree-walk.h"
27 #include "refs.h"
28 #include "pack-revindex.h"
29 #include "hash-lookup.h"
30 #include "bulk-checkin.h"
31 #include "repository.h"
32 #include "replace-object.h"
33 #include "streaming.h"
34 #include "dir.h"
35 #include "list.h"
36 #include "mergesort.h"
37 #include "quote.h"
38 #include "packfile.h"
39 #include "object-file.h"
40 #include "object-store.h"
41 #include "oidtree.h"
42 #include "path.h"
43 #include "promisor-remote.h"
44 #include "setup.h"
45 #include "submodule.h"
46 #include "fsck.h"
47 #include "wrapper.h"
49 /* The maximum size for an object header. */
50 #define MAX_HEADER_LEN 32
53 #define EMPTY_TREE_SHA1_BIN_LITERAL \
54 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
55 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
56 #define EMPTY_TREE_SHA256_BIN_LITERAL \
57 "\x6e\xf1\x9b\x41\x22\x5c\x53\x69\xf1\xc1" \
58 "\x04\xd4\x5d\x8d\x85\xef\xa9\xb0\x57\xb5" \
59 "\x3b\x14\xb4\xb9\xb9\x39\xdd\x74\xde\xcc" \
60 "\x53\x21"
62 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
63 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
64 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
65 #define EMPTY_BLOB_SHA256_BIN_LITERAL \
66 "\x47\x3a\x0f\x4c\x3b\xe8\xa9\x36\x81\xa2" \
67 "\x67\xe3\xb1\xe9\xa7\xdc\xda\x11\x85\x43" \
68 "\x6f\xe1\x41\xf7\x74\x91\x20\xa3\x03\x72" \
69 "\x18\x13"
71 static const struct object_id empty_tree_oid = {
72 .hash = EMPTY_TREE_SHA1_BIN_LITERAL,
73 .algo = GIT_HASH_SHA1,
75 static const struct object_id empty_blob_oid = {
76 .hash = EMPTY_BLOB_SHA1_BIN_LITERAL,
77 .algo = GIT_HASH_SHA1,
79 static const struct object_id null_oid_sha1 = {
80 .hash = {0},
81 .algo = GIT_HASH_SHA1,
83 static const struct object_id empty_tree_oid_sha256 = {
84 .hash = EMPTY_TREE_SHA256_BIN_LITERAL,
85 .algo = GIT_HASH_SHA256,
87 static const struct object_id empty_blob_oid_sha256 = {
88 .hash = EMPTY_BLOB_SHA256_BIN_LITERAL,
89 .algo = GIT_HASH_SHA256,
91 static const struct object_id null_oid_sha256 = {
92 .hash = {0},
93 .algo = GIT_HASH_SHA256,
96 static void git_hash_sha1_init(git_hash_ctx *ctx)
98 git_SHA1_Init(&ctx->sha1);
101 static void git_hash_sha1_clone(git_hash_ctx *dst, const git_hash_ctx *src)
103 git_SHA1_Clone(&dst->sha1, &src->sha1);
106 static void git_hash_sha1_update(git_hash_ctx *ctx, const void *data, size_t len)
108 git_SHA1_Update(&ctx->sha1, data, len);
111 static void git_hash_sha1_final(unsigned char *hash, git_hash_ctx *ctx)
113 git_SHA1_Final(hash, &ctx->sha1);
116 static void git_hash_sha1_final_oid(struct object_id *oid, git_hash_ctx *ctx)
118 git_SHA1_Final(oid->hash, &ctx->sha1);
119 memset(oid->hash + GIT_SHA1_RAWSZ, 0, GIT_MAX_RAWSZ - GIT_SHA1_RAWSZ);
120 oid->algo = GIT_HASH_SHA1;
124 static void git_hash_sha256_init(git_hash_ctx *ctx)
126 git_SHA256_Init(&ctx->sha256);
129 static void git_hash_sha256_clone(git_hash_ctx *dst, const git_hash_ctx *src)
131 git_SHA256_Clone(&dst->sha256, &src->sha256);
134 static void git_hash_sha256_update(git_hash_ctx *ctx, const void *data, size_t len)
136 git_SHA256_Update(&ctx->sha256, data, len);
139 static void git_hash_sha256_final(unsigned char *hash, git_hash_ctx *ctx)
141 git_SHA256_Final(hash, &ctx->sha256);
144 static void git_hash_sha256_final_oid(struct object_id *oid, git_hash_ctx *ctx)
146 git_SHA256_Final(oid->hash, &ctx->sha256);
148 * This currently does nothing, so the compiler should optimize it out,
149 * but keep it in case we extend the hash size again.
151 memset(oid->hash + GIT_SHA256_RAWSZ, 0, GIT_MAX_RAWSZ - GIT_SHA256_RAWSZ);
152 oid->algo = GIT_HASH_SHA256;
155 static void git_hash_unknown_init(git_hash_ctx *ctx UNUSED)
157 BUG("trying to init unknown hash");
160 static void git_hash_unknown_clone(git_hash_ctx *dst UNUSED,
161 const git_hash_ctx *src UNUSED)
163 BUG("trying to clone unknown hash");
166 static void git_hash_unknown_update(git_hash_ctx *ctx UNUSED,
167 const void *data UNUSED,
168 size_t len UNUSED)
170 BUG("trying to update unknown hash");
173 static void git_hash_unknown_final(unsigned char *hash UNUSED,
174 git_hash_ctx *ctx UNUSED)
176 BUG("trying to finalize unknown hash");
179 static void git_hash_unknown_final_oid(struct object_id *oid UNUSED,
180 git_hash_ctx *ctx UNUSED)
182 BUG("trying to finalize unknown hash");
185 const struct git_hash_algo hash_algos[GIT_HASH_NALGOS] = {
187 .name = NULL,
188 .format_id = 0x00000000,
189 .rawsz = 0,
190 .hexsz = 0,
191 .blksz = 0,
192 .init_fn = git_hash_unknown_init,
193 .clone_fn = git_hash_unknown_clone,
194 .update_fn = git_hash_unknown_update,
195 .final_fn = git_hash_unknown_final,
196 .final_oid_fn = git_hash_unknown_final_oid,
197 .empty_tree = NULL,
198 .empty_blob = NULL,
199 .null_oid = NULL,
202 .name = "sha1",
203 .format_id = GIT_SHA1_FORMAT_ID,
204 .rawsz = GIT_SHA1_RAWSZ,
205 .hexsz = GIT_SHA1_HEXSZ,
206 .blksz = GIT_SHA1_BLKSZ,
207 .init_fn = git_hash_sha1_init,
208 .clone_fn = git_hash_sha1_clone,
209 .update_fn = git_hash_sha1_update,
210 .final_fn = git_hash_sha1_final,
211 .final_oid_fn = git_hash_sha1_final_oid,
212 .empty_tree = &empty_tree_oid,
213 .empty_blob = &empty_blob_oid,
214 .null_oid = &null_oid_sha1,
217 .name = "sha256",
218 .format_id = GIT_SHA256_FORMAT_ID,
219 .rawsz = GIT_SHA256_RAWSZ,
220 .hexsz = GIT_SHA256_HEXSZ,
221 .blksz = GIT_SHA256_BLKSZ,
222 .init_fn = git_hash_sha256_init,
223 .clone_fn = git_hash_sha256_clone,
224 .update_fn = git_hash_sha256_update,
225 .final_fn = git_hash_sha256_final,
226 .final_oid_fn = git_hash_sha256_final_oid,
227 .empty_tree = &empty_tree_oid_sha256,
228 .empty_blob = &empty_blob_oid_sha256,
229 .null_oid = &null_oid_sha256,
233 const struct object_id *null_oid(void)
235 return the_hash_algo->null_oid;
238 const char *empty_tree_oid_hex(void)
240 static char buf[GIT_MAX_HEXSZ + 1];
241 return oid_to_hex_r(buf, the_hash_algo->empty_tree);
244 const char *empty_blob_oid_hex(void)
246 static char buf[GIT_MAX_HEXSZ + 1];
247 return oid_to_hex_r(buf, the_hash_algo->empty_blob);
250 int hash_algo_by_name(const char *name)
252 int i;
253 if (!name)
254 return GIT_HASH_UNKNOWN;
255 for (i = 1; i < GIT_HASH_NALGOS; i++)
256 if (!strcmp(name, hash_algos[i].name))
257 return i;
258 return GIT_HASH_UNKNOWN;
261 int hash_algo_by_id(uint32_t format_id)
263 int i;
264 for (i = 1; i < GIT_HASH_NALGOS; i++)
265 if (format_id == hash_algos[i].format_id)
266 return i;
267 return GIT_HASH_UNKNOWN;
270 int hash_algo_by_length(int len)
272 int i;
273 for (i = 1; i < GIT_HASH_NALGOS; i++)
274 if (len == hash_algos[i].rawsz)
275 return i;
276 return GIT_HASH_UNKNOWN;
280 * This is meant to hold a *small* number of objects that you would
281 * want repo_read_object_file() to be able to return, but yet you do not want
282 * to write them into the object store (e.g. a browse-only
283 * application).
285 static struct cached_object {
286 struct object_id oid;
287 enum object_type type;
288 void *buf;
289 unsigned long size;
290 } *cached_objects;
291 static int cached_object_nr, cached_object_alloc;
293 static struct cached_object empty_tree = {
294 .oid = {
295 .hash = EMPTY_TREE_SHA1_BIN_LITERAL,
297 .type = OBJ_TREE,
298 .buf = "",
301 static struct cached_object *find_cached_object(const struct object_id *oid)
303 int i;
304 struct cached_object *co = cached_objects;
306 for (i = 0; i < cached_object_nr; i++, co++) {
307 if (oideq(&co->oid, oid))
308 return co;
310 if (oideq(oid, the_hash_algo->empty_tree))
311 return &empty_tree;
312 return NULL;
316 static int get_conv_flags(unsigned flags)
318 if (flags & HASH_RENORMALIZE)
319 return CONV_EOL_RENORMALIZE;
320 else if (flags & HASH_WRITE_OBJECT)
321 return global_conv_flags_eol | CONV_WRITE_OBJECT;
322 else
323 return 0;
327 int mkdir_in_gitdir(const char *path)
329 if (mkdir(path, 0777)) {
330 int saved_errno = errno;
331 struct stat st;
332 struct strbuf sb = STRBUF_INIT;
334 if (errno != EEXIST)
335 return -1;
337 * Are we looking at a path in a symlinked worktree
338 * whose original repository does not yet have it?
339 * e.g. .git/rr-cache pointing at its original
340 * repository in which the user hasn't performed any
341 * conflict resolution yet?
343 if (lstat(path, &st) || !S_ISLNK(st.st_mode) ||
344 strbuf_readlink(&sb, path, st.st_size) ||
345 !is_absolute_path(sb.buf) ||
346 mkdir(sb.buf, 0777)) {
347 strbuf_release(&sb);
348 errno = saved_errno;
349 return -1;
351 strbuf_release(&sb);
353 return adjust_shared_perm(path);
356 static enum scld_error safe_create_leading_directories_1(char *path, int share)
358 char *next_component = path + offset_1st_component(path);
359 enum scld_error ret = SCLD_OK;
361 while (ret == SCLD_OK && next_component) {
362 struct stat st;
363 char *slash = next_component, slash_character;
365 while (*slash && !is_dir_sep(*slash))
366 slash++;
368 if (!*slash)
369 break;
371 next_component = slash + 1;
372 while (is_dir_sep(*next_component))
373 next_component++;
374 if (!*next_component)
375 break;
377 slash_character = *slash;
378 *slash = '\0';
379 if (!stat(path, &st)) {
380 /* path exists */
381 if (!S_ISDIR(st.st_mode)) {
382 errno = ENOTDIR;
383 ret = SCLD_EXISTS;
385 } else if (mkdir(path, 0777)) {
386 if (errno == EEXIST &&
387 !stat(path, &st) && S_ISDIR(st.st_mode))
388 ; /* somebody created it since we checked */
389 else if (errno == ENOENT)
391 * Either mkdir() failed because
392 * somebody just pruned the containing
393 * directory, or stat() failed because
394 * the file that was in our way was
395 * just removed. Either way, inform
396 * the caller that it might be worth
397 * trying again:
399 ret = SCLD_VANISHED;
400 else
401 ret = SCLD_FAILED;
402 } else if (share && adjust_shared_perm(path)) {
403 ret = SCLD_PERMS;
405 *slash = slash_character;
407 return ret;
410 enum scld_error safe_create_leading_directories(char *path)
412 return safe_create_leading_directories_1(path, 1);
415 enum scld_error safe_create_leading_directories_no_share(char *path)
417 return safe_create_leading_directories_1(path, 0);
420 enum scld_error safe_create_leading_directories_const(const char *path)
422 int save_errno;
423 /* path points to cache entries, so xstrdup before messing with it */
424 char *buf = xstrdup(path);
425 enum scld_error result = safe_create_leading_directories(buf);
427 save_errno = errno;
428 free(buf);
429 errno = save_errno;
430 return result;
433 static void fill_loose_path(struct strbuf *buf, const struct object_id *oid)
435 int i;
436 for (i = 0; i < the_hash_algo->rawsz; i++) {
437 static char hex[] = "0123456789abcdef";
438 unsigned int val = oid->hash[i];
439 strbuf_addch(buf, hex[val >> 4]);
440 strbuf_addch(buf, hex[val & 0xf]);
441 if (!i)
442 strbuf_addch(buf, '/');
446 static const char *odb_loose_path(struct object_directory *odb,
447 struct strbuf *buf,
448 const struct object_id *oid)
450 strbuf_reset(buf);
451 strbuf_addstr(buf, odb->path);
452 strbuf_addch(buf, '/');
453 fill_loose_path(buf, oid);
454 return buf->buf;
457 const char *loose_object_path(struct repository *r, struct strbuf *buf,
458 const struct object_id *oid)
460 return odb_loose_path(r->objects->odb, buf, oid);
464 * Return non-zero iff the path is usable as an alternate object database.
466 static int alt_odb_usable(struct raw_object_store *o,
467 struct strbuf *path,
468 const char *normalized_objdir, khiter_t *pos)
470 int r;
472 /* Detect cases where alternate disappeared */
473 if (!is_directory(path->buf)) {
474 error(_("object directory %s does not exist; "
475 "check .git/objects/info/alternates"),
476 path->buf);
477 return 0;
481 * Prevent the common mistake of listing the same
482 * thing twice, or object directory itself.
484 if (!o->odb_by_path) {
485 khiter_t p;
487 o->odb_by_path = kh_init_odb_path_map();
488 assert(!o->odb->next);
489 p = kh_put_odb_path_map(o->odb_by_path, o->odb->path, &r);
490 assert(r == 1); /* never used */
491 kh_value(o->odb_by_path, p) = o->odb;
493 if (fspatheq(path->buf, normalized_objdir))
494 return 0;
495 *pos = kh_put_odb_path_map(o->odb_by_path, path->buf, &r);
496 /* r: 0 = exists, 1 = never used, 2 = deleted */
497 return r == 0 ? 0 : 1;
501 * Prepare alternate object database registry.
503 * The variable alt_odb_list points at the list of struct
504 * object_directory. The elements on this list come from
505 * non-empty elements from colon separated ALTERNATE_DB_ENVIRONMENT
506 * environment variable, and $GIT_OBJECT_DIRECTORY/info/alternates,
507 * whose contents is similar to that environment variable but can be
508 * LF separated. Its base points at a statically allocated buffer that
509 * contains "/the/directory/corresponding/to/.git/objects/...", while
510 * its name points just after the slash at the end of ".git/objects/"
511 * in the example above, and has enough space to hold all hex characters
512 * of the object ID, an extra slash for the first level indirection, and
513 * the terminating NUL.
515 static void read_info_alternates(struct repository *r,
516 const char *relative_base,
517 int depth);
518 static int link_alt_odb_entry(struct repository *r, const struct strbuf *entry,
519 const char *relative_base, int depth, const char *normalized_objdir)
521 struct object_directory *ent;
522 struct strbuf pathbuf = STRBUF_INIT;
523 struct strbuf tmp = STRBUF_INIT;
524 khiter_t pos;
525 int ret = -1;
527 if (!is_absolute_path(entry->buf) && relative_base) {
528 strbuf_realpath(&pathbuf, relative_base, 1);
529 strbuf_addch(&pathbuf, '/');
531 strbuf_addbuf(&pathbuf, entry);
533 if (!strbuf_realpath(&tmp, pathbuf.buf, 0)) {
534 error(_("unable to normalize alternate object path: %s"),
535 pathbuf.buf);
536 goto error;
538 strbuf_swap(&pathbuf, &tmp);
541 * The trailing slash after the directory name is given by
542 * this function at the end. Remove duplicates.
544 while (pathbuf.len && pathbuf.buf[pathbuf.len - 1] == '/')
545 strbuf_setlen(&pathbuf, pathbuf.len - 1);
547 if (!alt_odb_usable(r->objects, &pathbuf, normalized_objdir, &pos))
548 goto error;
550 CALLOC_ARRAY(ent, 1);
551 /* pathbuf.buf is already in r->objects->odb_by_path */
552 ent->path = strbuf_detach(&pathbuf, NULL);
554 /* add the alternate entry */
555 *r->objects->odb_tail = ent;
556 r->objects->odb_tail = &(ent->next);
557 ent->next = NULL;
558 assert(r->objects->odb_by_path);
559 kh_value(r->objects->odb_by_path, pos) = ent;
561 /* recursively add alternates */
562 read_info_alternates(r, ent->path, depth + 1);
563 ret = 0;
564 error:
565 strbuf_release(&tmp);
566 strbuf_release(&pathbuf);
567 return ret;
570 static const char *parse_alt_odb_entry(const char *string,
571 int sep,
572 struct strbuf *out)
574 const char *end;
576 strbuf_reset(out);
578 if (*string == '#') {
579 /* comment; consume up to next separator */
580 end = strchrnul(string, sep);
581 } else if (*string == '"' && !unquote_c_style(out, string, &end)) {
583 * quoted path; unquote_c_style has copied the
584 * data for us and set "end". Broken quoting (e.g.,
585 * an entry that doesn't end with a quote) falls
586 * back to the unquoted case below.
588 } else {
589 /* normal, unquoted path */
590 end = strchrnul(string, sep);
591 strbuf_add(out, string, end - string);
594 if (*end)
595 end++;
596 return end;
599 static void link_alt_odb_entries(struct repository *r, const char *alt,
600 int sep, const char *relative_base, int depth)
602 struct strbuf objdirbuf = STRBUF_INIT;
603 struct strbuf entry = STRBUF_INIT;
605 if (!alt || !*alt)
606 return;
608 if (depth > 5) {
609 error(_("%s: ignoring alternate object stores, nesting too deep"),
610 relative_base);
611 return;
614 strbuf_realpath(&objdirbuf, r->objects->odb->path, 1);
616 while (*alt) {
617 alt = parse_alt_odb_entry(alt, sep, &entry);
618 if (!entry.len)
619 continue;
620 link_alt_odb_entry(r, &entry,
621 relative_base, depth, objdirbuf.buf);
623 strbuf_release(&entry);
624 strbuf_release(&objdirbuf);
627 static void read_info_alternates(struct repository *r,
628 const char *relative_base,
629 int depth)
631 char *path;
632 struct strbuf buf = STRBUF_INIT;
634 path = xstrfmt("%s/info/alternates", relative_base);
635 if (strbuf_read_file(&buf, path, 1024) < 0) {
636 warn_on_fopen_errors(path);
637 free(path);
638 return;
641 link_alt_odb_entries(r, buf.buf, '\n', relative_base, depth);
642 strbuf_release(&buf);
643 free(path);
646 void add_to_alternates_file(const char *reference)
648 struct lock_file lock = LOCK_INIT;
649 char *alts = git_pathdup("objects/info/alternates");
650 FILE *in, *out;
651 int found = 0;
653 hold_lock_file_for_update(&lock, alts, LOCK_DIE_ON_ERROR);
654 out = fdopen_lock_file(&lock, "w");
655 if (!out)
656 die_errno(_("unable to fdopen alternates lockfile"));
658 in = fopen(alts, "r");
659 if (in) {
660 struct strbuf line = STRBUF_INIT;
662 while (strbuf_getline(&line, in) != EOF) {
663 if (!strcmp(reference, line.buf)) {
664 found = 1;
665 break;
667 fprintf_or_die(out, "%s\n", line.buf);
670 strbuf_release(&line);
671 fclose(in);
673 else if (errno != ENOENT)
674 die_errno(_("unable to read alternates file"));
676 if (found) {
677 rollback_lock_file(&lock);
678 } else {
679 fprintf_or_die(out, "%s\n", reference);
680 if (commit_lock_file(&lock))
681 die_errno(_("unable to move new alternates file into place"));
682 if (the_repository->objects->loaded_alternates)
683 link_alt_odb_entries(the_repository, reference,
684 '\n', NULL, 0);
686 free(alts);
689 void add_to_alternates_memory(const char *reference)
692 * Make sure alternates are initialized, or else our entry may be
693 * overwritten when they are.
695 prepare_alt_odb(the_repository);
697 link_alt_odb_entries(the_repository, reference,
698 '\n', NULL, 0);
701 struct object_directory *set_temporary_primary_odb(const char *dir, int will_destroy)
703 struct object_directory *new_odb;
706 * Make sure alternates are initialized, or else our entry may be
707 * overwritten when they are.
709 prepare_alt_odb(the_repository);
712 * Make a new primary odb and link the old primary ODB in as an
713 * alternate
715 new_odb = xcalloc(1, sizeof(*new_odb));
716 new_odb->path = xstrdup(dir);
719 * Disable ref updates while a temporary odb is active, since
720 * the objects in the database may roll back.
722 new_odb->disable_ref_updates = 1;
723 new_odb->will_destroy = will_destroy;
724 new_odb->next = the_repository->objects->odb;
725 the_repository->objects->odb = new_odb;
726 return new_odb->next;
729 void restore_primary_odb(struct object_directory *restore_odb, const char *old_path)
731 struct object_directory *cur_odb = the_repository->objects->odb;
733 if (strcmp(old_path, cur_odb->path))
734 BUG("expected %s as primary object store; found %s",
735 old_path, cur_odb->path);
737 if (cur_odb->next != restore_odb)
738 BUG("we expect the old primary object store to be the first alternate");
740 the_repository->objects->odb = restore_odb;
741 free_object_directory(cur_odb);
745 * Compute the exact path an alternate is at and returns it. In case of
746 * error NULL is returned and the human readable error is added to `err`
747 * `path` may be relative and should point to $GIT_DIR.
748 * `err` must not be null.
750 char *compute_alternate_path(const char *path, struct strbuf *err)
752 char *ref_git = NULL;
753 const char *repo;
754 int seen_error = 0;
756 ref_git = real_pathdup(path, 0);
757 if (!ref_git) {
758 seen_error = 1;
759 strbuf_addf(err, _("path '%s' does not exist"), path);
760 goto out;
763 repo = read_gitfile(ref_git);
764 if (!repo)
765 repo = read_gitfile(mkpath("%s/.git", ref_git));
766 if (repo) {
767 free(ref_git);
768 ref_git = xstrdup(repo);
771 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
772 char *ref_git_git = mkpathdup("%s/.git", ref_git);
773 free(ref_git);
774 ref_git = ref_git_git;
775 } else if (!is_directory(mkpath("%s/objects", ref_git))) {
776 struct strbuf sb = STRBUF_INIT;
777 seen_error = 1;
778 if (get_common_dir(&sb, ref_git)) {
779 strbuf_addf(err,
780 _("reference repository '%s' as a linked "
781 "checkout is not supported yet."),
782 path);
783 goto out;
786 strbuf_addf(err, _("reference repository '%s' is not a "
787 "local repository."), path);
788 goto out;
791 if (!access(mkpath("%s/shallow", ref_git), F_OK)) {
792 strbuf_addf(err, _("reference repository '%s' is shallow"),
793 path);
794 seen_error = 1;
795 goto out;
798 if (!access(mkpath("%s/info/grafts", ref_git), F_OK)) {
799 strbuf_addf(err,
800 _("reference repository '%s' is grafted"),
801 path);
802 seen_error = 1;
803 goto out;
806 out:
807 if (seen_error) {
808 FREE_AND_NULL(ref_git);
811 return ref_git;
814 struct object_directory *find_odb(struct repository *r, const char *obj_dir)
816 struct object_directory *odb;
817 char *obj_dir_real = real_pathdup(obj_dir, 1);
818 struct strbuf odb_path_real = STRBUF_INIT;
820 prepare_alt_odb(r);
821 for (odb = r->objects->odb; odb; odb = odb->next) {
822 strbuf_realpath(&odb_path_real, odb->path, 1);
823 if (!strcmp(obj_dir_real, odb_path_real.buf))
824 break;
827 free(obj_dir_real);
828 strbuf_release(&odb_path_real);
830 if (!odb)
831 die(_("could not find object directory matching %s"), obj_dir);
832 return odb;
835 static void fill_alternate_refs_command(struct child_process *cmd,
836 const char *repo_path)
838 const char *value;
840 if (!git_config_get_value("core.alternateRefsCommand", &value)) {
841 cmd->use_shell = 1;
843 strvec_push(&cmd->args, value);
844 strvec_push(&cmd->args, repo_path);
845 } else {
846 cmd->git_cmd = 1;
848 strvec_pushf(&cmd->args, "--git-dir=%s", repo_path);
849 strvec_push(&cmd->args, "for-each-ref");
850 strvec_push(&cmd->args, "--format=%(objectname)");
852 if (!git_config_get_value("core.alternateRefsPrefixes", &value)) {
853 strvec_push(&cmd->args, "--");
854 strvec_split(&cmd->args, value);
858 strvec_pushv(&cmd->env, (const char **)local_repo_env);
859 cmd->out = -1;
862 static void read_alternate_refs(const char *path,
863 alternate_ref_fn *cb,
864 void *data)
866 struct child_process cmd = CHILD_PROCESS_INIT;
867 struct strbuf line = STRBUF_INIT;
868 FILE *fh;
870 fill_alternate_refs_command(&cmd, path);
872 if (start_command(&cmd))
873 return;
875 fh = xfdopen(cmd.out, "r");
876 while (strbuf_getline_lf(&line, fh) != EOF) {
877 struct object_id oid;
878 const char *p;
880 if (parse_oid_hex(line.buf, &oid, &p) || *p) {
881 warning(_("invalid line while parsing alternate refs: %s"),
882 line.buf);
883 break;
886 cb(&oid, data);
889 fclose(fh);
890 finish_command(&cmd);
891 strbuf_release(&line);
894 struct alternate_refs_data {
895 alternate_ref_fn *fn;
896 void *data;
899 static int refs_from_alternate_cb(struct object_directory *e,
900 void *data)
902 struct strbuf path = STRBUF_INIT;
903 size_t base_len;
904 struct alternate_refs_data *cb = data;
906 if (!strbuf_realpath(&path, e->path, 0))
907 goto out;
908 if (!strbuf_strip_suffix(&path, "/objects"))
909 goto out;
910 base_len = path.len;
912 /* Is this a git repository with refs? */
913 strbuf_addstr(&path, "/refs");
914 if (!is_directory(path.buf))
915 goto out;
916 strbuf_setlen(&path, base_len);
918 read_alternate_refs(path.buf, cb->fn, cb->data);
920 out:
921 strbuf_release(&path);
922 return 0;
925 void for_each_alternate_ref(alternate_ref_fn fn, void *data)
927 struct alternate_refs_data cb;
928 cb.fn = fn;
929 cb.data = data;
930 foreach_alt_odb(refs_from_alternate_cb, &cb);
933 int foreach_alt_odb(alt_odb_fn fn, void *cb)
935 struct object_directory *ent;
936 int r = 0;
938 prepare_alt_odb(the_repository);
939 for (ent = the_repository->objects->odb->next; ent; ent = ent->next) {
940 r = fn(ent, cb);
941 if (r)
942 break;
944 return r;
947 void prepare_alt_odb(struct repository *r)
949 if (r->objects->loaded_alternates)
950 return;
952 link_alt_odb_entries(r, r->objects->alternate_db, PATH_SEP, NULL, 0);
954 read_info_alternates(r, r->objects->odb->path, 0);
955 r->objects->loaded_alternates = 1;
958 int has_alt_odb(struct repository *r)
960 prepare_alt_odb(r);
961 return !!r->objects->odb->next;
964 /* Returns 1 if we have successfully freshened the file, 0 otherwise. */
965 static int freshen_file(const char *fn)
967 return !utime(fn, NULL);
971 * All of the check_and_freshen functions return 1 if the file exists and was
972 * freshened (if freshening was requested), 0 otherwise. If they return
973 * 0, you should not assume that it is safe to skip a write of the object (it
974 * either does not exist on disk, or has a stale mtime and may be subject to
975 * pruning).
977 int check_and_freshen_file(const char *fn, int freshen)
979 if (access(fn, F_OK))
980 return 0;
981 if (freshen && !freshen_file(fn))
982 return 0;
983 return 1;
986 static int check_and_freshen_odb(struct object_directory *odb,
987 const struct object_id *oid,
988 int freshen)
990 static struct strbuf path = STRBUF_INIT;
991 odb_loose_path(odb, &path, oid);
992 return check_and_freshen_file(path.buf, freshen);
995 static int check_and_freshen_local(const struct object_id *oid, int freshen)
997 return check_and_freshen_odb(the_repository->objects->odb, oid, freshen);
1000 static int check_and_freshen_nonlocal(const struct object_id *oid, int freshen)
1002 struct object_directory *odb;
1004 prepare_alt_odb(the_repository);
1005 for (odb = the_repository->objects->odb->next; odb; odb = odb->next) {
1006 if (check_and_freshen_odb(odb, oid, freshen))
1007 return 1;
1009 return 0;
1012 static int check_and_freshen(const struct object_id *oid, int freshen)
1014 return check_and_freshen_local(oid, freshen) ||
1015 check_and_freshen_nonlocal(oid, freshen);
1018 int has_loose_object_nonlocal(const struct object_id *oid)
1020 return check_and_freshen_nonlocal(oid, 0);
1023 int has_loose_object(const struct object_id *oid)
1025 return check_and_freshen(oid, 0);
1028 static void mmap_limit_check(size_t length)
1030 static size_t limit = 0;
1031 if (!limit) {
1032 limit = git_env_ulong("GIT_MMAP_LIMIT", 0);
1033 if (!limit)
1034 limit = SIZE_MAX;
1036 if (length > limit)
1037 die(_("attempting to mmap %"PRIuMAX" over limit %"PRIuMAX),
1038 (uintmax_t)length, (uintmax_t)limit);
1041 void *xmmap_gently(void *start, size_t length,
1042 int prot, int flags, int fd, off_t offset)
1044 void *ret;
1046 mmap_limit_check(length);
1047 ret = mmap(start, length, prot, flags, fd, offset);
1048 if (ret == MAP_FAILED && !length)
1049 ret = NULL;
1050 return ret;
1053 const char *mmap_os_err(void)
1055 static const char blank[] = "";
1056 #if defined(__linux__)
1057 if (errno == ENOMEM) {
1058 /* this continues an existing error message: */
1059 static const char enomem[] =
1060 ", check sys.vm.max_map_count and/or RLIMIT_DATA";
1061 return enomem;
1063 #endif /* OS-specific bits */
1064 return blank;
1067 void *xmmap(void *start, size_t length,
1068 int prot, int flags, int fd, off_t offset)
1070 void *ret = xmmap_gently(start, length, prot, flags, fd, offset);
1071 if (ret == MAP_FAILED)
1072 die_errno(_("mmap failed%s"), mmap_os_err());
1073 return ret;
1076 static int format_object_header_literally(char *str, size_t size,
1077 const char *type, size_t objsize)
1079 return xsnprintf(str, size, "%s %"PRIuMAX, type, (uintmax_t)objsize) + 1;
1082 int format_object_header(char *str, size_t size, enum object_type type,
1083 size_t objsize)
1085 const char *name = type_name(type);
1087 if (!name)
1088 BUG("could not get a type name for 'enum object_type' value %d", type);
1090 return format_object_header_literally(str, size, name, objsize);
1093 int check_object_signature(struct repository *r, const struct object_id *oid,
1094 void *buf, unsigned long size,
1095 enum object_type type)
1097 struct object_id real_oid;
1099 hash_object_file(r->hash_algo, buf, size, type, &real_oid);
1101 return !oideq(oid, &real_oid) ? -1 : 0;
1104 int stream_object_signature(struct repository *r, const struct object_id *oid)
1106 struct object_id real_oid;
1107 unsigned long size;
1108 enum object_type obj_type;
1109 struct git_istream *st;
1110 git_hash_ctx c;
1111 char hdr[MAX_HEADER_LEN];
1112 int hdrlen;
1114 st = open_istream(r, oid, &obj_type, &size, NULL);
1115 if (!st)
1116 return -1;
1118 /* Generate the header */
1119 hdrlen = format_object_header(hdr, sizeof(hdr), obj_type, size);
1121 /* Sha1.. */
1122 r->hash_algo->init_fn(&c);
1123 r->hash_algo->update_fn(&c, hdr, hdrlen);
1124 for (;;) {
1125 char buf[1024 * 16];
1126 ssize_t readlen = read_istream(st, buf, sizeof(buf));
1128 if (readlen < 0) {
1129 close_istream(st);
1130 return -1;
1132 if (!readlen)
1133 break;
1134 r->hash_algo->update_fn(&c, buf, readlen);
1136 r->hash_algo->final_oid_fn(&real_oid, &c);
1137 close_istream(st);
1138 return !oideq(oid, &real_oid) ? -1 : 0;
1141 int git_open_cloexec(const char *name, int flags)
1143 int fd;
1144 static int o_cloexec = O_CLOEXEC;
1146 fd = open(name, flags | o_cloexec);
1147 if ((o_cloexec & O_CLOEXEC) && fd < 0 && errno == EINVAL) {
1148 /* Try again w/o O_CLOEXEC: the kernel might not support it */
1149 o_cloexec &= ~O_CLOEXEC;
1150 fd = open(name, flags | o_cloexec);
1153 #if defined(F_GETFD) && defined(F_SETFD) && defined(FD_CLOEXEC)
1155 static int fd_cloexec = FD_CLOEXEC;
1157 if (!o_cloexec && 0 <= fd && fd_cloexec) {
1158 /* Opened w/o O_CLOEXEC? try with fcntl(2) to add it */
1159 int flags = fcntl(fd, F_GETFD);
1160 if (fcntl(fd, F_SETFD, flags | fd_cloexec))
1161 fd_cloexec = 0;
1164 #endif
1165 return fd;
1169 * Find "oid" as a loose object in the local repository or in an alternate.
1170 * Returns 0 on success, negative on failure.
1172 * The "path" out-parameter will give the path of the object we found (if any).
1173 * Note that it may point to static storage and is only valid until another
1174 * call to stat_loose_object().
1176 static int stat_loose_object(struct repository *r, const struct object_id *oid,
1177 struct stat *st, const char **path)
1179 struct object_directory *odb;
1180 static struct strbuf buf = STRBUF_INIT;
1182 prepare_alt_odb(r);
1183 for (odb = r->objects->odb; odb; odb = odb->next) {
1184 *path = odb_loose_path(odb, &buf, oid);
1185 if (!lstat(*path, st))
1186 return 0;
1189 return -1;
1193 * Like stat_loose_object(), but actually open the object and return the
1194 * descriptor. See the caveats on the "path" parameter above.
1196 static int open_loose_object(struct repository *r,
1197 const struct object_id *oid, const char **path)
1199 int fd;
1200 struct object_directory *odb;
1201 int most_interesting_errno = ENOENT;
1202 static struct strbuf buf = STRBUF_INIT;
1204 prepare_alt_odb(r);
1205 for (odb = r->objects->odb; odb; odb = odb->next) {
1206 *path = odb_loose_path(odb, &buf, oid);
1207 fd = git_open(*path);
1208 if (fd >= 0)
1209 return fd;
1211 if (most_interesting_errno == ENOENT)
1212 most_interesting_errno = errno;
1214 errno = most_interesting_errno;
1215 return -1;
1218 static int quick_has_loose(struct repository *r,
1219 const struct object_id *oid)
1221 struct object_directory *odb;
1223 prepare_alt_odb(r);
1224 for (odb = r->objects->odb; odb; odb = odb->next) {
1225 if (oidtree_contains(odb_loose_cache(odb, oid), oid))
1226 return 1;
1228 return 0;
1232 * Map and close the given loose object fd. The path argument is used for
1233 * error reporting.
1235 static void *map_fd(int fd, const char *path, unsigned long *size)
1237 void *map = NULL;
1238 struct stat st;
1240 if (!fstat(fd, &st)) {
1241 *size = xsize_t(st.st_size);
1242 if (!*size) {
1243 /* mmap() is forbidden on empty files */
1244 error(_("object file %s is empty"), path);
1245 close(fd);
1246 return NULL;
1248 map = xmmap(NULL, *size, PROT_READ, MAP_PRIVATE, fd, 0);
1250 close(fd);
1251 return map;
1254 void *map_loose_object(struct repository *r,
1255 const struct object_id *oid,
1256 unsigned long *size)
1258 const char *p;
1259 int fd = open_loose_object(r, oid, &p);
1261 if (fd < 0)
1262 return NULL;
1263 return map_fd(fd, p, size);
1266 enum unpack_loose_header_result unpack_loose_header(git_zstream *stream,
1267 unsigned char *map,
1268 unsigned long mapsize,
1269 void *buffer,
1270 unsigned long bufsiz,
1271 struct strbuf *header)
1273 int status;
1275 /* Get the data stream */
1276 memset(stream, 0, sizeof(*stream));
1277 stream->next_in = map;
1278 stream->avail_in = mapsize;
1279 stream->next_out = buffer;
1280 stream->avail_out = bufsiz;
1282 git_inflate_init(stream);
1283 obj_read_unlock();
1284 status = git_inflate(stream, 0);
1285 obj_read_lock();
1286 if (status < Z_OK)
1287 return ULHR_BAD;
1290 * Check if entire header is unpacked in the first iteration.
1292 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1293 return ULHR_OK;
1296 * We have a header longer than MAX_HEADER_LEN. The "header"
1297 * here is only non-NULL when we run "cat-file
1298 * --allow-unknown-type".
1300 if (!header)
1301 return ULHR_TOO_LONG;
1304 * buffer[0..bufsiz] was not large enough. Copy the partial
1305 * result out to header, and then append the result of further
1306 * reading the stream.
1308 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1309 stream->next_out = buffer;
1310 stream->avail_out = bufsiz;
1312 do {
1313 obj_read_unlock();
1314 status = git_inflate(stream, 0);
1315 obj_read_lock();
1316 strbuf_add(header, buffer, stream->next_out - (unsigned char *)buffer);
1317 if (memchr(buffer, '\0', stream->next_out - (unsigned char *)buffer))
1318 return 0;
1319 stream->next_out = buffer;
1320 stream->avail_out = bufsiz;
1321 } while (status != Z_STREAM_END);
1322 return ULHR_TOO_LONG;
1325 static void *unpack_loose_rest(git_zstream *stream,
1326 void *buffer, unsigned long size,
1327 const struct object_id *oid)
1329 int bytes = strlen(buffer) + 1;
1330 unsigned char *buf = xmallocz(size);
1331 unsigned long n;
1332 int status = Z_OK;
1334 n = stream->total_out - bytes;
1335 if (n > size)
1336 n = size;
1337 memcpy(buf, (char *) buffer + bytes, n);
1338 bytes = n;
1339 if (bytes <= size) {
1341 * The above condition must be (bytes <= size), not
1342 * (bytes < size). In other words, even though we
1343 * expect no more output and set avail_out to zero,
1344 * the input zlib stream may have bytes that express
1345 * "this concludes the stream", and we *do* want to
1346 * eat that input.
1348 * Otherwise we would not be able to test that we
1349 * consumed all the input to reach the expected size;
1350 * we also want to check that zlib tells us that all
1351 * went well with status == Z_STREAM_END at the end.
1353 stream->next_out = buf + bytes;
1354 stream->avail_out = size - bytes;
1355 while (status == Z_OK) {
1356 obj_read_unlock();
1357 status = git_inflate(stream, Z_FINISH);
1358 obj_read_lock();
1361 if (status == Z_STREAM_END && !stream->avail_in) {
1362 git_inflate_end(stream);
1363 return buf;
1366 if (status < 0)
1367 error(_("corrupt loose object '%s'"), oid_to_hex(oid));
1368 else if (stream->avail_in)
1369 error(_("garbage at end of loose object '%s'"),
1370 oid_to_hex(oid));
1371 free(buf);
1372 return NULL;
1376 * We used to just use "sscanf()", but that's actually way
1377 * too permissive for what we want to check. So do an anal
1378 * object header parse by hand.
1380 int parse_loose_header(const char *hdr, struct object_info *oi)
1382 const char *type_buf = hdr;
1383 size_t size;
1384 int type, type_len = 0;
1387 * The type can be of any size but is followed by
1388 * a space.
1390 for (;;) {
1391 char c = *hdr++;
1392 if (!c)
1393 return -1;
1394 if (c == ' ')
1395 break;
1396 type_len++;
1399 type = type_from_string_gently(type_buf, type_len, 1);
1400 if (oi->type_name)
1401 strbuf_add(oi->type_name, type_buf, type_len);
1402 if (oi->typep)
1403 *oi->typep = type;
1406 * The length must follow immediately, and be in canonical
1407 * decimal format (ie "010" is not valid).
1409 size = *hdr++ - '0';
1410 if (size > 9)
1411 return -1;
1412 if (size) {
1413 for (;;) {
1414 unsigned long c = *hdr - '0';
1415 if (c > 9)
1416 break;
1417 hdr++;
1418 size = st_add(st_mult(size, 10), c);
1422 if (oi->sizep)
1423 *oi->sizep = cast_size_t_to_ulong(size);
1426 * The length must be followed by a zero byte
1428 if (*hdr)
1429 return -1;
1432 * The format is valid, but the type may still be bogus. The
1433 * Caller needs to check its oi->typep.
1435 return 0;
1438 static int loose_object_info(struct repository *r,
1439 const struct object_id *oid,
1440 struct object_info *oi, int flags)
1442 int status = 0;
1443 int fd;
1444 unsigned long mapsize;
1445 const char *path;
1446 void *map;
1447 git_zstream stream;
1448 char hdr[MAX_HEADER_LEN];
1449 struct strbuf hdrbuf = STRBUF_INIT;
1450 unsigned long size_scratch;
1451 enum object_type type_scratch;
1452 int allow_unknown = flags & OBJECT_INFO_ALLOW_UNKNOWN_TYPE;
1454 if (oi->delta_base_oid)
1455 oidclr(oi->delta_base_oid);
1458 * If we don't care about type or size, then we don't
1459 * need to look inside the object at all. Note that we
1460 * do not optimize out the stat call, even if the
1461 * caller doesn't care about the disk-size, since our
1462 * return value implicitly indicates whether the
1463 * object even exists.
1465 if (!oi->typep && !oi->type_name && !oi->sizep && !oi->contentp) {
1466 struct stat st;
1467 if (!oi->disk_sizep && (flags & OBJECT_INFO_QUICK))
1468 return quick_has_loose(r, oid) ? 0 : -1;
1469 if (stat_loose_object(r, oid, &st, &path) < 0)
1470 return -1;
1471 if (oi->disk_sizep)
1472 *oi->disk_sizep = st.st_size;
1473 return 0;
1476 fd = open_loose_object(r, oid, &path);
1477 if (fd < 0) {
1478 if (errno != ENOENT)
1479 error_errno(_("unable to open loose object %s"), oid_to_hex(oid));
1480 return -1;
1482 map = map_fd(fd, path, &mapsize);
1483 if (!map)
1484 return -1;
1486 if (!oi->sizep)
1487 oi->sizep = &size_scratch;
1488 if (!oi->typep)
1489 oi->typep = &type_scratch;
1491 if (oi->disk_sizep)
1492 *oi->disk_sizep = mapsize;
1494 switch (unpack_loose_header(&stream, map, mapsize, hdr, sizeof(hdr),
1495 allow_unknown ? &hdrbuf : NULL)) {
1496 case ULHR_OK:
1497 if (parse_loose_header(hdrbuf.len ? hdrbuf.buf : hdr, oi) < 0)
1498 status = error(_("unable to parse %s header"), oid_to_hex(oid));
1499 else if (!allow_unknown && *oi->typep < 0)
1500 die(_("invalid object type"));
1502 if (!oi->contentp)
1503 break;
1504 *oi->contentp = unpack_loose_rest(&stream, hdr, *oi->sizep, oid);
1505 if (*oi->contentp)
1506 goto cleanup;
1508 status = -1;
1509 break;
1510 case ULHR_BAD:
1511 status = error(_("unable to unpack %s header"),
1512 oid_to_hex(oid));
1513 break;
1514 case ULHR_TOO_LONG:
1515 status = error(_("header for %s too long, exceeds %d bytes"),
1516 oid_to_hex(oid), MAX_HEADER_LEN);
1517 break;
1520 if (status && (flags & OBJECT_INFO_DIE_IF_CORRUPT))
1521 die(_("loose object %s (stored in %s) is corrupt"),
1522 oid_to_hex(oid), path);
1524 git_inflate_end(&stream);
1525 cleanup:
1526 munmap(map, mapsize);
1527 if (oi->sizep == &size_scratch)
1528 oi->sizep = NULL;
1529 strbuf_release(&hdrbuf);
1530 if (oi->typep == &type_scratch)
1531 oi->typep = NULL;
1532 oi->whence = OI_LOOSE;
1533 return status;
1536 int obj_read_use_lock = 0;
1537 pthread_mutex_t obj_read_mutex;
1539 void enable_obj_read_lock(void)
1541 if (obj_read_use_lock)
1542 return;
1544 obj_read_use_lock = 1;
1545 init_recursive_mutex(&obj_read_mutex);
1548 void disable_obj_read_lock(void)
1550 if (!obj_read_use_lock)
1551 return;
1553 obj_read_use_lock = 0;
1554 pthread_mutex_destroy(&obj_read_mutex);
1557 int fetch_if_missing = 1;
1559 static int do_oid_object_info_extended(struct repository *r,
1560 const struct object_id *oid,
1561 struct object_info *oi, unsigned flags)
1563 static struct object_info blank_oi = OBJECT_INFO_INIT;
1564 struct cached_object *co;
1565 struct pack_entry e;
1566 int rtype;
1567 const struct object_id *real = oid;
1568 int already_retried = 0;
1571 if (flags & OBJECT_INFO_LOOKUP_REPLACE)
1572 real = lookup_replace_object(r, oid);
1574 if (is_null_oid(real))
1575 return -1;
1577 if (!oi)
1578 oi = &blank_oi;
1580 co = find_cached_object(real);
1581 if (co) {
1582 if (oi->typep)
1583 *(oi->typep) = co->type;
1584 if (oi->sizep)
1585 *(oi->sizep) = co->size;
1586 if (oi->disk_sizep)
1587 *(oi->disk_sizep) = 0;
1588 if (oi->delta_base_oid)
1589 oidclr(oi->delta_base_oid);
1590 if (oi->type_name)
1591 strbuf_addstr(oi->type_name, type_name(co->type));
1592 if (oi->contentp)
1593 *oi->contentp = xmemdupz(co->buf, co->size);
1594 oi->whence = OI_CACHED;
1595 return 0;
1598 while (1) {
1599 if (find_pack_entry(r, real, &e))
1600 break;
1602 /* Most likely it's a loose object. */
1603 if (!loose_object_info(r, real, oi, flags))
1604 return 0;
1606 /* Not a loose object; someone else may have just packed it. */
1607 if (!(flags & OBJECT_INFO_QUICK)) {
1608 reprepare_packed_git(r);
1609 if (find_pack_entry(r, real, &e))
1610 break;
1614 * If r is the_repository, this might be an attempt at
1615 * accessing a submodule object as if it were in the_repository
1616 * (having called add_submodule_odb() on that submodule's ODB).
1617 * If any such ODBs exist, register them and try again.
1619 if (r == the_repository &&
1620 register_all_submodule_odb_as_alternates())
1621 /* We added some alternates; retry */
1622 continue;
1624 /* Check if it is a missing object */
1625 if (fetch_if_missing && repo_has_promisor_remote(r) &&
1626 !already_retried &&
1627 !(flags & OBJECT_INFO_SKIP_FETCH_OBJECT)) {
1628 promisor_remote_get_direct(r, real, 1);
1629 already_retried = 1;
1630 continue;
1633 if (flags & OBJECT_INFO_DIE_IF_CORRUPT) {
1634 const struct packed_git *p;
1635 if ((flags & OBJECT_INFO_LOOKUP_REPLACE) && !oideq(real, oid))
1636 die(_("replacement %s not found for %s"),
1637 oid_to_hex(real), oid_to_hex(oid));
1638 if ((p = has_packed_and_bad(r, real)))
1639 die(_("packed object %s (stored in %s) is corrupt"),
1640 oid_to_hex(real), p->pack_name);
1642 return -1;
1645 if (oi == &blank_oi)
1647 * We know that the caller doesn't actually need the
1648 * information below, so return early.
1650 return 0;
1651 rtype = packed_object_info(r, e.p, e.offset, oi);
1652 if (rtype < 0) {
1653 mark_bad_packed_object(e.p, real);
1654 return do_oid_object_info_extended(r, real, oi, 0);
1655 } else if (oi->whence == OI_PACKED) {
1656 oi->u.packed.offset = e.offset;
1657 oi->u.packed.pack = e.p;
1658 oi->u.packed.is_delta = (rtype == OBJ_REF_DELTA ||
1659 rtype == OBJ_OFS_DELTA);
1662 return 0;
1665 int oid_object_info_extended(struct repository *r, const struct object_id *oid,
1666 struct object_info *oi, unsigned flags)
1668 int ret;
1669 obj_read_lock();
1670 ret = do_oid_object_info_extended(r, oid, oi, flags);
1671 obj_read_unlock();
1672 return ret;
1676 /* returns enum object_type or negative */
1677 int oid_object_info(struct repository *r,
1678 const struct object_id *oid,
1679 unsigned long *sizep)
1681 enum object_type type;
1682 struct object_info oi = OBJECT_INFO_INIT;
1684 oi.typep = &type;
1685 oi.sizep = sizep;
1686 if (oid_object_info_extended(r, oid, &oi,
1687 OBJECT_INFO_LOOKUP_REPLACE) < 0)
1688 return -1;
1689 return type;
1692 int pretend_object_file(void *buf, unsigned long len, enum object_type type,
1693 struct object_id *oid)
1695 struct cached_object *co;
1697 hash_object_file(the_hash_algo, buf, len, type, oid);
1698 if (repo_has_object_file_with_flags(the_repository, oid, OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT) ||
1699 find_cached_object(oid))
1700 return 0;
1701 ALLOC_GROW(cached_objects, cached_object_nr + 1, cached_object_alloc);
1702 co = &cached_objects[cached_object_nr++];
1703 co->size = len;
1704 co->type = type;
1705 co->buf = xmalloc(len);
1706 memcpy(co->buf, buf, len);
1707 oidcpy(&co->oid, oid);
1708 return 0;
1712 * This function dies on corrupt objects; the callers who want to
1713 * deal with them should arrange to call oid_object_info_extended() and give
1714 * error messages themselves.
1716 void *repo_read_object_file(struct repository *r,
1717 const struct object_id *oid,
1718 enum object_type *type,
1719 unsigned long *size)
1721 struct object_info oi = OBJECT_INFO_INIT;
1722 unsigned flags = OBJECT_INFO_DIE_IF_CORRUPT | OBJECT_INFO_LOOKUP_REPLACE;
1723 void *data;
1725 oi.typep = type;
1726 oi.sizep = size;
1727 oi.contentp = &data;
1728 if (oid_object_info_extended(r, oid, &oi, flags))
1729 return NULL;
1731 return data;
1734 void *read_object_with_reference(struct repository *r,
1735 const struct object_id *oid,
1736 enum object_type required_type,
1737 unsigned long *size,
1738 struct object_id *actual_oid_return)
1740 enum object_type type;
1741 void *buffer;
1742 unsigned long isize;
1743 struct object_id actual_oid;
1745 oidcpy(&actual_oid, oid);
1746 while (1) {
1747 int ref_length = -1;
1748 const char *ref_type = NULL;
1750 buffer = repo_read_object_file(r, &actual_oid, &type, &isize);
1751 if (!buffer)
1752 return NULL;
1753 if (type == required_type) {
1754 *size = isize;
1755 if (actual_oid_return)
1756 oidcpy(actual_oid_return, &actual_oid);
1757 return buffer;
1759 /* Handle references */
1760 else if (type == OBJ_COMMIT)
1761 ref_type = "tree ";
1762 else if (type == OBJ_TAG)
1763 ref_type = "object ";
1764 else {
1765 free(buffer);
1766 return NULL;
1768 ref_length = strlen(ref_type);
1770 if (ref_length + the_hash_algo->hexsz > isize ||
1771 memcmp(buffer, ref_type, ref_length) ||
1772 get_oid_hex((char *) buffer + ref_length, &actual_oid)) {
1773 free(buffer);
1774 return NULL;
1776 free(buffer);
1777 /* Now we have the ID of the referred-to object in
1778 * actual_oid. Check again. */
1782 static void hash_object_body(const struct git_hash_algo *algo, git_hash_ctx *c,
1783 const void *buf, unsigned long len,
1784 struct object_id *oid,
1785 char *hdr, int *hdrlen)
1787 algo->init_fn(c);
1788 algo->update_fn(c, hdr, *hdrlen);
1789 algo->update_fn(c, buf, len);
1790 algo->final_oid_fn(oid, c);
1793 static void write_object_file_prepare(const struct git_hash_algo *algo,
1794 const void *buf, unsigned long len,
1795 enum object_type type, struct object_id *oid,
1796 char *hdr, int *hdrlen)
1798 git_hash_ctx c;
1800 /* Generate the header */
1801 *hdrlen = format_object_header(hdr, *hdrlen, type, len);
1803 /* Sha1.. */
1804 hash_object_body(algo, &c, buf, len, oid, hdr, hdrlen);
1807 static void write_object_file_prepare_literally(const struct git_hash_algo *algo,
1808 const void *buf, unsigned long len,
1809 const char *type, struct object_id *oid,
1810 char *hdr, int *hdrlen)
1812 git_hash_ctx c;
1814 *hdrlen = format_object_header_literally(hdr, *hdrlen, type, len);
1815 hash_object_body(algo, &c, buf, len, oid, hdr, hdrlen);
1819 * Move the just written object into its final resting place.
1821 int finalize_object_file(const char *tmpfile, const char *filename)
1823 int ret = 0;
1825 if (object_creation_mode == OBJECT_CREATION_USES_RENAMES)
1826 goto try_rename;
1827 else if (link(tmpfile, filename))
1828 ret = errno;
1831 * Coda hack - coda doesn't like cross-directory links,
1832 * so we fall back to a rename, which will mean that it
1833 * won't be able to check collisions, but that's not a
1834 * big deal.
1836 * The same holds for FAT formatted media.
1838 * When this succeeds, we just return. We have nothing
1839 * left to unlink.
1841 if (ret && ret != EEXIST) {
1842 try_rename:
1843 if (!rename(tmpfile, filename))
1844 goto out;
1845 ret = errno;
1847 unlink_or_warn(tmpfile);
1848 if (ret) {
1849 if (ret != EEXIST) {
1850 return error_errno(_("unable to write file %s"), filename);
1852 /* FIXME!!! Collision check here ? */
1855 out:
1856 if (adjust_shared_perm(filename))
1857 return error(_("unable to set permission to '%s'"), filename);
1858 return 0;
1861 static void hash_object_file_literally(const struct git_hash_algo *algo,
1862 const void *buf, unsigned long len,
1863 const char *type, struct object_id *oid)
1865 char hdr[MAX_HEADER_LEN];
1866 int hdrlen = sizeof(hdr);
1868 write_object_file_prepare_literally(algo, buf, len, type, oid, hdr, &hdrlen);
1871 void hash_object_file(const struct git_hash_algo *algo, const void *buf,
1872 unsigned long len, enum object_type type,
1873 struct object_id *oid)
1875 hash_object_file_literally(algo, buf, len, type_name(type), oid);
1878 /* Finalize a file on disk, and close it. */
1879 static void close_loose_object(int fd, const char *filename)
1881 if (the_repository->objects->odb->will_destroy)
1882 goto out;
1884 if (batch_fsync_enabled(FSYNC_COMPONENT_LOOSE_OBJECT))
1885 fsync_loose_object_bulk_checkin(fd, filename);
1886 else if (fsync_object_files > 0)
1887 fsync_or_die(fd, filename);
1888 else
1889 fsync_component_or_die(FSYNC_COMPONENT_LOOSE_OBJECT, fd,
1890 filename);
1892 out:
1893 if (close(fd) != 0)
1894 die_errno(_("error when closing loose object file"));
1897 /* Size of directory component, including the ending '/' */
1898 static inline int directory_size(const char *filename)
1900 const char *s = strrchr(filename, '/');
1901 if (!s)
1902 return 0;
1903 return s - filename + 1;
1907 * This creates a temporary file in the same directory as the final
1908 * 'filename'
1910 * We want to avoid cross-directory filename renames, because those
1911 * can have problems on various filesystems (FAT, NFS, Coda).
1913 static int create_tmpfile(struct strbuf *tmp, const char *filename)
1915 int fd, dirlen = directory_size(filename);
1917 strbuf_reset(tmp);
1918 strbuf_add(tmp, filename, dirlen);
1919 strbuf_addstr(tmp, "tmp_obj_XXXXXX");
1920 fd = git_mkstemp_mode(tmp->buf, 0444);
1921 if (fd < 0 && dirlen && errno == ENOENT) {
1923 * Make sure the directory exists; note that the contents
1924 * of the buffer are undefined after mkstemp returns an
1925 * error, so we have to rewrite the whole buffer from
1926 * scratch.
1928 strbuf_reset(tmp);
1929 strbuf_add(tmp, filename, dirlen - 1);
1930 if (mkdir(tmp->buf, 0777) && errno != EEXIST)
1931 return -1;
1932 if (adjust_shared_perm(tmp->buf))
1933 return -1;
1935 /* Try again */
1936 strbuf_addstr(tmp, "/tmp_obj_XXXXXX");
1937 fd = git_mkstemp_mode(tmp->buf, 0444);
1939 return fd;
1943 * Common steps for loose object writers to start writing loose
1944 * objects:
1946 * - Create tmpfile for the loose object.
1947 * - Setup zlib stream for compression.
1948 * - Start to feed header to zlib stream.
1950 * Returns a "fd", which should later be provided to
1951 * end_loose_object_common().
1953 static int start_loose_object_common(struct strbuf *tmp_file,
1954 const char *filename, unsigned flags,
1955 git_zstream *stream,
1956 unsigned char *buf, size_t buflen,
1957 git_hash_ctx *c,
1958 char *hdr, int hdrlen)
1960 int fd;
1962 fd = create_tmpfile(tmp_file, filename);
1963 if (fd < 0) {
1964 if (flags & HASH_SILENT)
1965 return -1;
1966 else if (errno == EACCES)
1967 return error(_("insufficient permission for adding "
1968 "an object to repository database %s"),
1969 get_object_directory());
1970 else
1971 return error_errno(
1972 _("unable to create temporary file"));
1975 /* Setup zlib stream for compression */
1976 git_deflate_init(stream, zlib_compression_level);
1977 stream->next_out = buf;
1978 stream->avail_out = buflen;
1979 the_hash_algo->init_fn(c);
1981 /* Start to feed header to zlib stream */
1982 stream->next_in = (unsigned char *)hdr;
1983 stream->avail_in = hdrlen;
1984 while (git_deflate(stream, 0) == Z_OK)
1985 ; /* nothing */
1986 the_hash_algo->update_fn(c, hdr, hdrlen);
1988 return fd;
1992 * Common steps for the inner git_deflate() loop for writing loose
1993 * objects. Returns what git_deflate() returns.
1995 static int write_loose_object_common(git_hash_ctx *c,
1996 git_zstream *stream, const int flush,
1997 unsigned char *in0, const int fd,
1998 unsigned char *compressed,
1999 const size_t compressed_len)
2001 int ret;
2003 ret = git_deflate(stream, flush ? Z_FINISH : 0);
2004 the_hash_algo->update_fn(c, in0, stream->next_in - in0);
2005 if (write_in_full(fd, compressed, stream->next_out - compressed) < 0)
2006 die_errno(_("unable to write loose object file"));
2007 stream->next_out = compressed;
2008 stream->avail_out = compressed_len;
2010 return ret;
2014 * Common steps for loose object writers to end writing loose objects:
2016 * - End the compression of zlib stream.
2017 * - Get the calculated oid to "oid".
2019 static int end_loose_object_common(git_hash_ctx *c, git_zstream *stream,
2020 struct object_id *oid)
2022 int ret;
2024 ret = git_deflate_end_gently(stream);
2025 if (ret != Z_OK)
2026 return ret;
2027 the_hash_algo->final_oid_fn(oid, c);
2029 return Z_OK;
2032 static int write_loose_object(const struct object_id *oid, char *hdr,
2033 int hdrlen, const void *buf, unsigned long len,
2034 time_t mtime, unsigned flags)
2036 int fd, ret;
2037 unsigned char compressed[4096];
2038 git_zstream stream;
2039 git_hash_ctx c;
2040 struct object_id parano_oid;
2041 static struct strbuf tmp_file = STRBUF_INIT;
2042 static struct strbuf filename = STRBUF_INIT;
2044 if (batch_fsync_enabled(FSYNC_COMPONENT_LOOSE_OBJECT))
2045 prepare_loose_object_bulk_checkin();
2047 loose_object_path(the_repository, &filename, oid);
2049 fd = start_loose_object_common(&tmp_file, filename.buf, flags,
2050 &stream, compressed, sizeof(compressed),
2051 &c, hdr, hdrlen);
2052 if (fd < 0)
2053 return -1;
2055 /* Then the data itself.. */
2056 stream.next_in = (void *)buf;
2057 stream.avail_in = len;
2058 do {
2059 unsigned char *in0 = stream.next_in;
2061 ret = write_loose_object_common(&c, &stream, 1, in0, fd,
2062 compressed, sizeof(compressed));
2063 } while (ret == Z_OK);
2065 if (ret != Z_STREAM_END)
2066 die(_("unable to deflate new object %s (%d)"), oid_to_hex(oid),
2067 ret);
2068 ret = end_loose_object_common(&c, &stream, &parano_oid);
2069 if (ret != Z_OK)
2070 die(_("deflateEnd on object %s failed (%d)"), oid_to_hex(oid),
2071 ret);
2072 if (!oideq(oid, &parano_oid))
2073 die(_("confused by unstable object source data for %s"),
2074 oid_to_hex(oid));
2076 close_loose_object(fd, tmp_file.buf);
2078 if (mtime) {
2079 struct utimbuf utb;
2080 utb.actime = mtime;
2081 utb.modtime = mtime;
2082 if (utime(tmp_file.buf, &utb) < 0 &&
2083 !(flags & HASH_SILENT))
2084 warning_errno(_("failed utime() on %s"), tmp_file.buf);
2087 return finalize_object_file(tmp_file.buf, filename.buf);
2090 static int freshen_loose_object(const struct object_id *oid)
2092 return check_and_freshen(oid, 1);
2095 static int freshen_packed_object(const struct object_id *oid)
2097 struct pack_entry e;
2098 if (!find_pack_entry(the_repository, oid, &e))
2099 return 0;
2100 if (e.p->is_cruft)
2101 return 0;
2102 if (e.p->freshened)
2103 return 1;
2104 if (!freshen_file(e.p->pack_name))
2105 return 0;
2106 e.p->freshened = 1;
2107 return 1;
2110 int stream_loose_object(struct input_stream *in_stream, size_t len,
2111 struct object_id *oid)
2113 int fd, ret, err = 0, flush = 0;
2114 unsigned char compressed[4096];
2115 git_zstream stream;
2116 git_hash_ctx c;
2117 struct strbuf tmp_file = STRBUF_INIT;
2118 struct strbuf filename = STRBUF_INIT;
2119 int dirlen;
2120 char hdr[MAX_HEADER_LEN];
2121 int hdrlen;
2123 if (batch_fsync_enabled(FSYNC_COMPONENT_LOOSE_OBJECT))
2124 prepare_loose_object_bulk_checkin();
2126 /* Since oid is not determined, save tmp file to odb path. */
2127 strbuf_addf(&filename, "%s/", get_object_directory());
2128 hdrlen = format_object_header(hdr, sizeof(hdr), OBJ_BLOB, len);
2131 * Common steps for write_loose_object and stream_loose_object to
2132 * start writing loose objects:
2134 * - Create tmpfile for the loose object.
2135 * - Setup zlib stream for compression.
2136 * - Start to feed header to zlib stream.
2138 fd = start_loose_object_common(&tmp_file, filename.buf, 0,
2139 &stream, compressed, sizeof(compressed),
2140 &c, hdr, hdrlen);
2141 if (fd < 0) {
2142 err = -1;
2143 goto cleanup;
2146 /* Then the data itself.. */
2147 do {
2148 unsigned char *in0 = stream.next_in;
2150 if (!stream.avail_in && !in_stream->is_finished) {
2151 const void *in = in_stream->read(in_stream, &stream.avail_in);
2152 stream.next_in = (void *)in;
2153 in0 = (unsigned char *)in;
2154 /* All data has been read. */
2155 if (in_stream->is_finished)
2156 flush = 1;
2158 ret = write_loose_object_common(&c, &stream, flush, in0, fd,
2159 compressed, sizeof(compressed));
2161 * Unlike write_loose_object(), we do not have the entire
2162 * buffer. If we get Z_BUF_ERROR due to too few input bytes,
2163 * then we'll replenish them in the next input_stream->read()
2164 * call when we loop.
2166 } while (ret == Z_OK || ret == Z_BUF_ERROR);
2168 if (stream.total_in != len + hdrlen)
2169 die(_("write stream object %ld != %"PRIuMAX), stream.total_in,
2170 (uintmax_t)len + hdrlen);
2173 * Common steps for write_loose_object and stream_loose_object to
2174 * end writing loose oject:
2176 * - End the compression of zlib stream.
2177 * - Get the calculated oid.
2179 if (ret != Z_STREAM_END)
2180 die(_("unable to stream deflate new object (%d)"), ret);
2181 ret = end_loose_object_common(&c, &stream, oid);
2182 if (ret != Z_OK)
2183 die(_("deflateEnd on stream object failed (%d)"), ret);
2184 close_loose_object(fd, tmp_file.buf);
2186 if (freshen_packed_object(oid) || freshen_loose_object(oid)) {
2187 unlink_or_warn(tmp_file.buf);
2188 goto cleanup;
2191 loose_object_path(the_repository, &filename, oid);
2193 /* We finally know the object path, and create the missing dir. */
2194 dirlen = directory_size(filename.buf);
2195 if (dirlen) {
2196 struct strbuf dir = STRBUF_INIT;
2197 strbuf_add(&dir, filename.buf, dirlen);
2199 if (mkdir_in_gitdir(dir.buf) && errno != EEXIST) {
2200 err = error_errno(_("unable to create directory %s"), dir.buf);
2201 strbuf_release(&dir);
2202 goto cleanup;
2204 strbuf_release(&dir);
2207 err = finalize_object_file(tmp_file.buf, filename.buf);
2208 cleanup:
2209 strbuf_release(&tmp_file);
2210 strbuf_release(&filename);
2211 return err;
2214 int write_object_file_flags(const void *buf, unsigned long len,
2215 enum object_type type, struct object_id *oid,
2216 unsigned flags)
2218 char hdr[MAX_HEADER_LEN];
2219 int hdrlen = sizeof(hdr);
2221 /* Normally if we have it in the pack then we do not bother writing
2222 * it out into .git/objects/??/?{38} file.
2224 write_object_file_prepare(the_hash_algo, buf, len, type, oid, hdr,
2225 &hdrlen);
2226 if (freshen_packed_object(oid) || freshen_loose_object(oid))
2227 return 0;
2228 return write_loose_object(oid, hdr, hdrlen, buf, len, 0, flags);
2231 int write_object_file_literally(const void *buf, unsigned long len,
2232 const char *type, struct object_id *oid,
2233 unsigned flags)
2235 char *header;
2236 int hdrlen, status = 0;
2238 /* type string, SP, %lu of the length plus NUL must fit this */
2239 hdrlen = strlen(type) + MAX_HEADER_LEN;
2240 header = xmalloc(hdrlen);
2241 write_object_file_prepare_literally(the_hash_algo, buf, len, type,
2242 oid, header, &hdrlen);
2244 if (!(flags & HASH_WRITE_OBJECT))
2245 goto cleanup;
2246 if (freshen_packed_object(oid) || freshen_loose_object(oid))
2247 goto cleanup;
2248 status = write_loose_object(oid, header, hdrlen, buf, len, 0, 0);
2250 cleanup:
2251 free(header);
2252 return status;
2255 int force_object_loose(const struct object_id *oid, time_t mtime)
2257 void *buf;
2258 unsigned long len;
2259 struct object_info oi = OBJECT_INFO_INIT;
2260 enum object_type type;
2261 char hdr[MAX_HEADER_LEN];
2262 int hdrlen;
2263 int ret;
2265 if (has_loose_object(oid))
2266 return 0;
2267 oi.typep = &type;
2268 oi.sizep = &len;
2269 oi.contentp = &buf;
2270 if (oid_object_info_extended(the_repository, oid, &oi, 0))
2271 return error(_("cannot read object for %s"), oid_to_hex(oid));
2272 hdrlen = format_object_header(hdr, sizeof(hdr), type, len);
2273 ret = write_loose_object(oid, hdr, hdrlen, buf, len, mtime, 0);
2274 free(buf);
2276 return ret;
2279 int has_object(struct repository *r, const struct object_id *oid,
2280 unsigned flags)
2282 int quick = !(flags & HAS_OBJECT_RECHECK_PACKED);
2283 unsigned object_info_flags = OBJECT_INFO_SKIP_FETCH_OBJECT |
2284 (quick ? OBJECT_INFO_QUICK : 0);
2286 if (!startup_info->have_repository)
2287 return 0;
2288 return oid_object_info_extended(r, oid, NULL, object_info_flags) >= 0;
2291 int repo_has_object_file_with_flags(struct repository *r,
2292 const struct object_id *oid, int flags)
2294 if (!startup_info->have_repository)
2295 return 0;
2296 return oid_object_info_extended(r, oid, NULL, flags) >= 0;
2299 int repo_has_object_file(struct repository *r,
2300 const struct object_id *oid)
2302 return repo_has_object_file_with_flags(r, oid, 0);
2306 * We can't use the normal fsck_error_function() for index_mem(),
2307 * because we don't yet have a valid oid for it to report. Instead,
2308 * report the minimal fsck error here, and rely on the caller to
2309 * give more context.
2311 static int hash_format_check_report(struct fsck_options *opts UNUSED,
2312 const struct object_id *oid UNUSED,
2313 enum object_type object_type UNUSED,
2314 enum fsck_msg_type msg_type UNUSED,
2315 enum fsck_msg_id msg_id UNUSED,
2316 const char *message)
2318 error(_("object fails fsck: %s"), message);
2319 return 1;
2322 static int index_mem(struct index_state *istate,
2323 struct object_id *oid, void *buf, size_t size,
2324 enum object_type type,
2325 const char *path, unsigned flags)
2327 int ret = 0;
2328 int re_allocated = 0;
2329 int write_object = flags & HASH_WRITE_OBJECT;
2331 if (!type)
2332 type = OBJ_BLOB;
2335 * Convert blobs to git internal format
2337 if ((type == OBJ_BLOB) && path) {
2338 struct strbuf nbuf = STRBUF_INIT;
2339 if (convert_to_git(istate, path, buf, size, &nbuf,
2340 get_conv_flags(flags))) {
2341 buf = strbuf_detach(&nbuf, &size);
2342 re_allocated = 1;
2345 if (flags & HASH_FORMAT_CHECK) {
2346 struct fsck_options opts = FSCK_OPTIONS_DEFAULT;
2348 opts.strict = 1;
2349 opts.error_func = hash_format_check_report;
2350 if (fsck_buffer(null_oid(), type, buf, size, &opts))
2351 die(_("refusing to create malformed object"));
2352 fsck_finish(&opts);
2355 if (write_object)
2356 ret = write_object_file(buf, size, type, oid);
2357 else
2358 hash_object_file(the_hash_algo, buf, size, type, oid);
2359 if (re_allocated)
2360 free(buf);
2361 return ret;
2364 static int index_stream_convert_blob(struct index_state *istate,
2365 struct object_id *oid,
2366 int fd,
2367 const char *path,
2368 unsigned flags)
2370 int ret = 0;
2371 const int write_object = flags & HASH_WRITE_OBJECT;
2372 struct strbuf sbuf = STRBUF_INIT;
2374 assert(path);
2375 assert(would_convert_to_git_filter_fd(istate, path));
2377 convert_to_git_filter_fd(istate, path, fd, &sbuf,
2378 get_conv_flags(flags));
2380 if (write_object)
2381 ret = write_object_file(sbuf.buf, sbuf.len, OBJ_BLOB,
2382 oid);
2383 else
2384 hash_object_file(the_hash_algo, sbuf.buf, sbuf.len, OBJ_BLOB,
2385 oid);
2386 strbuf_release(&sbuf);
2387 return ret;
2390 static int index_pipe(struct index_state *istate, struct object_id *oid,
2391 int fd, enum object_type type,
2392 const char *path, unsigned flags)
2394 struct strbuf sbuf = STRBUF_INIT;
2395 int ret;
2397 if (strbuf_read(&sbuf, fd, 4096) >= 0)
2398 ret = index_mem(istate, oid, sbuf.buf, sbuf.len, type, path, flags);
2399 else
2400 ret = -1;
2401 strbuf_release(&sbuf);
2402 return ret;
2405 #define SMALL_FILE_SIZE (32*1024)
2407 static int index_core(struct index_state *istate,
2408 struct object_id *oid, int fd, size_t size,
2409 enum object_type type, const char *path,
2410 unsigned flags)
2412 int ret;
2414 if (!size) {
2415 ret = index_mem(istate, oid, "", size, type, path, flags);
2416 } else if (size <= SMALL_FILE_SIZE) {
2417 char *buf = xmalloc(size);
2418 ssize_t read_result = read_in_full(fd, buf, size);
2419 if (read_result < 0)
2420 ret = error_errno(_("read error while indexing %s"),
2421 path ? path : "<unknown>");
2422 else if (read_result != size)
2423 ret = error(_("short read while indexing %s"),
2424 path ? path : "<unknown>");
2425 else
2426 ret = index_mem(istate, oid, buf, size, type, path, flags);
2427 free(buf);
2428 } else {
2429 void *buf = xmmap(NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
2430 ret = index_mem(istate, oid, buf, size, type, path, flags);
2431 munmap(buf, size);
2433 return ret;
2437 * This creates one packfile per large blob unless bulk-checkin
2438 * machinery is "plugged".
2440 * This also bypasses the usual "convert-to-git" dance, and that is on
2441 * purpose. We could write a streaming version of the converting
2442 * functions and insert that before feeding the data to fast-import
2443 * (or equivalent in-core API described above). However, that is
2444 * somewhat complicated, as we do not know the size of the filter
2445 * result, which we need to know beforehand when writing a git object.
2446 * Since the primary motivation for trying to stream from the working
2447 * tree file and to avoid mmaping it in core is to deal with large
2448 * binary blobs, they generally do not want to get any conversion, and
2449 * callers should avoid this code path when filters are requested.
2451 static int index_stream(struct object_id *oid, int fd, size_t size,
2452 enum object_type type, const char *path,
2453 unsigned flags)
2455 return index_bulk_checkin(oid, fd, size, type, path, flags);
2458 int index_fd(struct index_state *istate, struct object_id *oid,
2459 int fd, struct stat *st,
2460 enum object_type type, const char *path, unsigned flags)
2462 int ret;
2465 * Call xsize_t() only when needed to avoid potentially unnecessary
2466 * die() for large files.
2468 if (type == OBJ_BLOB && path && would_convert_to_git_filter_fd(istate, path))
2469 ret = index_stream_convert_blob(istate, oid, fd, path, flags);
2470 else if (!S_ISREG(st->st_mode))
2471 ret = index_pipe(istate, oid, fd, type, path, flags);
2472 else if (st->st_size <= big_file_threshold || type != OBJ_BLOB ||
2473 (path && would_convert_to_git(istate, path)))
2474 ret = index_core(istate, oid, fd, xsize_t(st->st_size),
2475 type, path, flags);
2476 else
2477 ret = index_stream(oid, fd, xsize_t(st->st_size), type, path,
2478 flags);
2479 close(fd);
2480 return ret;
2483 int index_path(struct index_state *istate, struct object_id *oid,
2484 const char *path, struct stat *st, unsigned flags)
2486 int fd;
2487 struct strbuf sb = STRBUF_INIT;
2488 int rc = 0;
2490 switch (st->st_mode & S_IFMT) {
2491 case S_IFREG:
2492 fd = open(path, O_RDONLY);
2493 if (fd < 0)
2494 return error_errno("open(\"%s\")", path);
2495 if (index_fd(istate, oid, fd, st, OBJ_BLOB, path, flags) < 0)
2496 return error(_("%s: failed to insert into database"),
2497 path);
2498 break;
2499 case S_IFLNK:
2500 if (strbuf_readlink(&sb, path, st->st_size))
2501 return error_errno("readlink(\"%s\")", path);
2502 if (!(flags & HASH_WRITE_OBJECT))
2503 hash_object_file(the_hash_algo, sb.buf, sb.len,
2504 OBJ_BLOB, oid);
2505 else if (write_object_file(sb.buf, sb.len, OBJ_BLOB, oid))
2506 rc = error(_("%s: failed to insert into database"), path);
2507 strbuf_release(&sb);
2508 break;
2509 case S_IFDIR:
2510 return resolve_gitlink_ref(path, "HEAD", oid);
2511 default:
2512 return error(_("%s: unsupported file type"), path);
2514 return rc;
2517 int read_pack_header(int fd, struct pack_header *header)
2519 if (read_in_full(fd, header, sizeof(*header)) != sizeof(*header))
2520 /* "eof before pack header was fully read" */
2521 return PH_ERROR_EOF;
2523 if (header->hdr_signature != htonl(PACK_SIGNATURE))
2524 /* "protocol error (pack signature mismatch detected)" */
2525 return PH_ERROR_PACK_SIGNATURE;
2526 if (!pack_version_ok(header->hdr_version))
2527 /* "protocol error (pack version unsupported)" */
2528 return PH_ERROR_PROTOCOL;
2529 return 0;
2532 void assert_oid_type(const struct object_id *oid, enum object_type expect)
2534 enum object_type type = oid_object_info(the_repository, oid, NULL);
2535 if (type < 0)
2536 die(_("%s is not a valid object"), oid_to_hex(oid));
2537 if (type != expect)
2538 die(_("%s is not a valid '%s' object"), oid_to_hex(oid),
2539 type_name(expect));
2542 int for_each_file_in_obj_subdir(unsigned int subdir_nr,
2543 struct strbuf *path,
2544 each_loose_object_fn obj_cb,
2545 each_loose_cruft_fn cruft_cb,
2546 each_loose_subdir_fn subdir_cb,
2547 void *data)
2549 size_t origlen, baselen;
2550 DIR *dir;
2551 struct dirent *de;
2552 int r = 0;
2553 struct object_id oid;
2555 if (subdir_nr > 0xff)
2556 BUG("invalid loose object subdirectory: %x", subdir_nr);
2558 origlen = path->len;
2559 strbuf_complete(path, '/');
2560 strbuf_addf(path, "%02x", subdir_nr);
2562 dir = opendir(path->buf);
2563 if (!dir) {
2564 if (errno != ENOENT)
2565 r = error_errno(_("unable to open %s"), path->buf);
2566 strbuf_setlen(path, origlen);
2567 return r;
2570 oid.hash[0] = subdir_nr;
2571 strbuf_addch(path, '/');
2572 baselen = path->len;
2574 while ((de = readdir_skip_dot_and_dotdot(dir))) {
2575 size_t namelen;
2577 namelen = strlen(de->d_name);
2578 strbuf_setlen(path, baselen);
2579 strbuf_add(path, de->d_name, namelen);
2580 if (namelen == the_hash_algo->hexsz - 2 &&
2581 !hex_to_bytes(oid.hash + 1, de->d_name,
2582 the_hash_algo->rawsz - 1)) {
2583 oid_set_algo(&oid, the_hash_algo);
2584 if (obj_cb) {
2585 r = obj_cb(&oid, path->buf, data);
2586 if (r)
2587 break;
2589 continue;
2592 if (cruft_cb) {
2593 r = cruft_cb(de->d_name, path->buf, data);
2594 if (r)
2595 break;
2598 closedir(dir);
2600 strbuf_setlen(path, baselen - 1);
2601 if (!r && subdir_cb)
2602 r = subdir_cb(subdir_nr, path->buf, data);
2604 strbuf_setlen(path, origlen);
2606 return r;
2609 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
2610 each_loose_object_fn obj_cb,
2611 each_loose_cruft_fn cruft_cb,
2612 each_loose_subdir_fn subdir_cb,
2613 void *data)
2615 int r = 0;
2616 int i;
2618 for (i = 0; i < 256; i++) {
2619 r = for_each_file_in_obj_subdir(i, path, obj_cb, cruft_cb,
2620 subdir_cb, data);
2621 if (r)
2622 break;
2625 return r;
2628 int for_each_loose_file_in_objdir(const char *path,
2629 each_loose_object_fn obj_cb,
2630 each_loose_cruft_fn cruft_cb,
2631 each_loose_subdir_fn subdir_cb,
2632 void *data)
2634 struct strbuf buf = STRBUF_INIT;
2635 int r;
2637 strbuf_addstr(&buf, path);
2638 r = for_each_loose_file_in_objdir_buf(&buf, obj_cb, cruft_cb,
2639 subdir_cb, data);
2640 strbuf_release(&buf);
2642 return r;
2645 int for_each_loose_object(each_loose_object_fn cb, void *data,
2646 enum for_each_object_flags flags)
2648 struct object_directory *odb;
2650 prepare_alt_odb(the_repository);
2651 for (odb = the_repository->objects->odb; odb; odb = odb->next) {
2652 int r = for_each_loose_file_in_objdir(odb->path, cb, NULL,
2653 NULL, data);
2654 if (r)
2655 return r;
2657 if (flags & FOR_EACH_OBJECT_LOCAL_ONLY)
2658 break;
2661 return 0;
2664 static int append_loose_object(const struct object_id *oid,
2665 const char *path UNUSED,
2666 void *data)
2668 oidtree_insert(data, oid);
2669 return 0;
2672 struct oidtree *odb_loose_cache(struct object_directory *odb,
2673 const struct object_id *oid)
2675 int subdir_nr = oid->hash[0];
2676 struct strbuf buf = STRBUF_INIT;
2677 size_t word_bits = bitsizeof(odb->loose_objects_subdir_seen[0]);
2678 size_t word_index = subdir_nr / word_bits;
2679 size_t mask = (size_t)1u << (subdir_nr % word_bits);
2680 uint32_t *bitmap;
2682 if (subdir_nr < 0 ||
2683 subdir_nr >= bitsizeof(odb->loose_objects_subdir_seen))
2684 BUG("subdir_nr out of range");
2686 bitmap = &odb->loose_objects_subdir_seen[word_index];
2687 if (*bitmap & mask)
2688 return odb->loose_objects_cache;
2689 if (!odb->loose_objects_cache) {
2690 ALLOC_ARRAY(odb->loose_objects_cache, 1);
2691 oidtree_init(odb->loose_objects_cache);
2693 strbuf_addstr(&buf, odb->path);
2694 for_each_file_in_obj_subdir(subdir_nr, &buf,
2695 append_loose_object,
2696 NULL, NULL,
2697 odb->loose_objects_cache);
2698 *bitmap |= mask;
2699 strbuf_release(&buf);
2700 return odb->loose_objects_cache;
2703 void odb_clear_loose_cache(struct object_directory *odb)
2705 oidtree_clear(odb->loose_objects_cache);
2706 FREE_AND_NULL(odb->loose_objects_cache);
2707 memset(&odb->loose_objects_subdir_seen, 0,
2708 sizeof(odb->loose_objects_subdir_seen));
2711 static int check_stream_oid(git_zstream *stream,
2712 const char *hdr,
2713 unsigned long size,
2714 const char *path,
2715 const struct object_id *expected_oid)
2717 git_hash_ctx c;
2718 struct object_id real_oid;
2719 unsigned char buf[4096];
2720 unsigned long total_read;
2721 int status = Z_OK;
2723 the_hash_algo->init_fn(&c);
2724 the_hash_algo->update_fn(&c, hdr, stream->total_out);
2727 * We already read some bytes into hdr, but the ones up to the NUL
2728 * do not count against the object's content size.
2730 total_read = stream->total_out - strlen(hdr) - 1;
2733 * This size comparison must be "<=" to read the final zlib packets;
2734 * see the comment in unpack_loose_rest for details.
2736 while (total_read <= size &&
2737 (status == Z_OK ||
2738 (status == Z_BUF_ERROR && !stream->avail_out))) {
2739 stream->next_out = buf;
2740 stream->avail_out = sizeof(buf);
2741 if (size - total_read < stream->avail_out)
2742 stream->avail_out = size - total_read;
2743 status = git_inflate(stream, Z_FINISH);
2744 the_hash_algo->update_fn(&c, buf, stream->next_out - buf);
2745 total_read += stream->next_out - buf;
2747 git_inflate_end(stream);
2749 if (status != Z_STREAM_END) {
2750 error(_("corrupt loose object '%s'"), oid_to_hex(expected_oid));
2751 return -1;
2753 if (stream->avail_in) {
2754 error(_("garbage at end of loose object '%s'"),
2755 oid_to_hex(expected_oid));
2756 return -1;
2759 the_hash_algo->final_oid_fn(&real_oid, &c);
2760 if (!oideq(expected_oid, &real_oid)) {
2761 error(_("hash mismatch for %s (expected %s)"), path,
2762 oid_to_hex(expected_oid));
2763 return -1;
2766 return 0;
2769 int read_loose_object(const char *path,
2770 const struct object_id *expected_oid,
2771 struct object_id *real_oid,
2772 void **contents,
2773 struct object_info *oi)
2775 int ret = -1;
2776 int fd;
2777 void *map = NULL;
2778 unsigned long mapsize;
2779 git_zstream stream;
2780 char hdr[MAX_HEADER_LEN];
2781 unsigned long *size = oi->sizep;
2783 fd = git_open(path);
2784 if (fd >= 0)
2785 map = map_fd(fd, path, &mapsize);
2786 if (!map) {
2787 error_errno(_("unable to mmap %s"), path);
2788 goto out;
2791 if (unpack_loose_header(&stream, map, mapsize, hdr, sizeof(hdr),
2792 NULL) != ULHR_OK) {
2793 error(_("unable to unpack header of %s"), path);
2794 goto out;
2797 if (parse_loose_header(hdr, oi) < 0) {
2798 error(_("unable to parse header of %s"), path);
2799 git_inflate_end(&stream);
2800 goto out;
2803 if (*oi->typep == OBJ_BLOB && *size > big_file_threshold) {
2804 if (check_stream_oid(&stream, hdr, *size, path, expected_oid) < 0)
2805 goto out;
2806 } else {
2807 *contents = unpack_loose_rest(&stream, hdr, *size, expected_oid);
2808 if (!*contents) {
2809 error(_("unable to unpack contents of %s"), path);
2810 git_inflate_end(&stream);
2811 goto out;
2813 hash_object_file_literally(the_repository->hash_algo,
2814 *contents, *size,
2815 oi->type_name->buf, real_oid);
2816 if (!oideq(expected_oid, real_oid))
2817 goto out;
2820 ret = 0; /* everything checks out */
2822 out:
2823 if (map)
2824 munmap(map, mapsize);
2825 return ret;