5 #include "cache-tree.h"
6 #include "object-store.h"
7 #include "replace-object.h"
8 #include "promisor-remote.h"
10 #ifndef DEBUG_CACHE_TREE
11 #define DEBUG_CACHE_TREE 0
14 struct cache_tree *cache_tree(void)
16 struct cache_tree *it = xcalloc(1, sizeof(struct cache_tree));
21 void cache_tree_free(struct cache_tree **it_p)
24 struct cache_tree *it = *it_p;
28 for (i = 0; i < it->subtree_nr; i++)
30 cache_tree_free(&it->down[i]->cache_tree);
38 static int subtree_name_cmp(const char *one, int onelen,
39 const char *two, int twolen)
45 return memcmp(one, two, onelen);
48 static int subtree_pos(struct cache_tree *it, const char *path, int pathlen)
50 struct cache_tree_sub **down = it->down;
55 int mi = lo + (hi - lo) / 2;
56 struct cache_tree_sub *mdl = down[mi];
57 int cmp = subtree_name_cmp(path, pathlen,
58 mdl->name, mdl->namelen);
69 static struct cache_tree_sub *find_subtree(struct cache_tree *it,
74 struct cache_tree_sub *down;
75 int pos = subtree_pos(it, path, pathlen);
82 ALLOC_GROW(it->down, it->subtree_nr + 1, it->subtree_alloc);
85 FLEX_ALLOC_MEM(down, name, path, pathlen);
86 down->cache_tree = NULL;
87 down->namelen = pathlen;
89 if (pos < it->subtree_nr)
90 MOVE_ARRAY(it->down + pos + 1, it->down + pos,
91 it->subtree_nr - pos - 1);
96 struct cache_tree_sub *cache_tree_sub(struct cache_tree *it, const char *path)
98 int pathlen = strlen(path);
99 return find_subtree(it, path, pathlen, 1);
102 static int do_invalidate_path(struct cache_tree *it, const char *path)
105 * ==> invalidate self
106 * ==> find "a", have it invalidate "b/c"
108 * ==> invalidate self
109 * ==> if "a" exists as a subtree, remove it.
113 struct cache_tree_sub *down;
116 fprintf(stderr, "cache-tree invalidate <%s>\n", path);
121 slash = strchrnul(path, '/');
122 namelen = slash - path;
123 it->entry_count = -1;
126 pos = subtree_pos(it, path, namelen);
128 cache_tree_free(&it->down[pos]->cache_tree);
133 * move 4 and 5 up one place (2 entries)
134 * 2 = 6 - 3 - 1 = subtree_nr - pos - 1
136 MOVE_ARRAY(it->down + pos, it->down + pos + 1,
137 it->subtree_nr - pos - 1);
142 down = find_subtree(it, path, namelen, 0);
144 do_invalidate_path(down->cache_tree, slash + 1);
148 void cache_tree_invalidate_path(struct index_state *istate, const char *path)
150 if (do_invalidate_path(istate->cache_tree, path))
151 istate->cache_changed |= CACHE_TREE_CHANGED;
154 static int verify_cache(struct cache_entry **cache,
155 int entries, int flags)
158 int silent = flags & WRITE_TREE_SILENT;
160 /* Verify that the tree is merged */
162 for (i = 0; i < entries; i++) {
163 const struct cache_entry *ce = cache[i];
168 fprintf(stderr, "...\n");
171 fprintf(stderr, "%s: unmerged (%s)\n",
172 ce->name, oid_to_hex(&ce->oid));
178 /* Also verify that the cache does not have path and path/file
179 * at the same time. At this point we know the cache has only
183 for (i = 0; i < entries - 1; i++) {
184 /* path/file always comes after path because of the way
185 * the cache is sorted. Also path can appear only once,
186 * which means conflicting one would immediately follow.
188 const char *this_name = cache[i]->name;
189 const char *next_name = cache[i+1]->name;
190 int this_len = strlen(this_name);
191 if (this_len < strlen(next_name) &&
192 strncmp(this_name, next_name, this_len) == 0 &&
193 next_name[this_len] == '/') {
195 fprintf(stderr, "...\n");
198 fprintf(stderr, "You have both %s and %s\n",
199 this_name, next_name);
207 static void discard_unused_subtrees(struct cache_tree *it)
209 struct cache_tree_sub **down = it->down;
210 int nr = it->subtree_nr;
212 for (dst = src = 0; src < nr; src++) {
213 struct cache_tree_sub *s = down[src];
217 cache_tree_free(&s->cache_tree);
224 int cache_tree_fully_valid(struct cache_tree *it)
229 if (it->entry_count < 0 || !has_object_file(&it->oid))
231 for (i = 0; i < it->subtree_nr; i++) {
232 if (!cache_tree_fully_valid(it->down[i]->cache_tree))
238 static int update_one(struct cache_tree *it,
239 struct cache_entry **cache,
246 struct strbuf buffer;
247 int missing_ok = flags & WRITE_TREE_MISSING_OK;
248 int dryrun = flags & WRITE_TREE_DRY_RUN;
249 int repair = flags & WRITE_TREE_REPAIR;
250 int to_invalidate = 0;
253 assert(!(dryrun && repair));
257 if (0 <= it->entry_count && has_object_file(&it->oid))
258 return it->entry_count;
261 * We first scan for subtrees and update them; we start by
262 * marking existing subtrees -- the ones that are unmarked
263 * should not be in the result.
265 for (i = 0; i < it->subtree_nr; i++)
266 it->down[i]->used = 0;
269 * Find the subtrees and update them.
272 while (i < entries) {
273 const struct cache_entry *ce = cache[i];
274 struct cache_tree_sub *sub;
275 const char *path, *slash;
276 int pathlen, sublen, subcnt, subskip;
279 pathlen = ce_namelen(ce);
280 if (pathlen <= baselen || memcmp(base, path, baselen))
281 break; /* at the end of this level */
283 slash = strchr(path + baselen, '/');
289 * a/bbb/c (base = a/, slash = /c)
291 * path+baselen = bbb/c, sublen = 3
293 sublen = slash - (path + baselen);
294 sub = find_subtree(it, path + baselen, sublen, 1);
295 if (!sub->cache_tree)
296 sub->cache_tree = cache_tree();
297 subcnt = update_one(sub->cache_tree,
298 cache + i, entries - i,
300 baselen + sublen + 1,
306 die("index cache-tree records empty sub-tree");
308 sub->count = subcnt; /* to be used in the next loop */
309 *skip_count += subskip;
313 discard_unused_subtrees(it);
316 * Then write out the tree object for this level.
318 strbuf_init(&buffer, 8192);
321 while (i < entries) {
322 const struct cache_entry *ce = cache[i];
323 struct cache_tree_sub *sub = NULL;
324 const char *path, *slash;
326 const struct object_id *oid;
328 int expected_missing = 0;
329 int contains_ita = 0;
333 pathlen = ce_namelen(ce);
334 if (pathlen <= baselen || memcmp(base, path, baselen))
335 break; /* at the end of this level */
337 slash = strchr(path + baselen, '/');
339 entlen = slash - (path + baselen);
340 sub = find_subtree(it, path + baselen, entlen, 0);
342 die("cache-tree.c: '%.*s' in '%s' not found",
343 entlen, path + baselen, path);
345 oid = &sub->cache_tree->oid;
347 contains_ita = sub->cache_tree->entry_count < 0;
350 expected_missing = 1;
356 entlen = pathlen - baselen;
360 ce_missing_ok = mode == S_IFGITLINK || missing_ok ||
361 (has_promisor_remote() &&
362 ce_skip_worktree(ce));
363 if (is_null_oid(oid) ||
364 (!ce_missing_ok && !has_object_file(oid))) {
365 strbuf_release(&buffer);
366 if (expected_missing)
368 return error("invalid object %06o %s for '%.*s'",
369 mode, oid_to_hex(oid), entlen+baselen, path);
373 * CE_REMOVE entries are removed before the index is
374 * written to disk. Skip them to remain consistent
375 * with the future on-disk index.
377 if (ce->ce_flags & CE_REMOVE) {
378 *skip_count = *skip_count + 1;
383 * CE_INTENT_TO_ADD entries exist on on-disk index but
384 * they are not part of generated trees. Invalidate up
385 * to root to force cache-tree users to read elsewhere.
387 if (!sub && ce_intent_to_add(ce)) {
393 * "sub" can be an empty tree if all subentries are i-t-a.
395 if (contains_ita && is_empty_tree_oid(oid))
398 strbuf_grow(&buffer, entlen + 100);
399 strbuf_addf(&buffer, "%o %.*s%c", mode, entlen, path + baselen, '\0');
400 strbuf_add(&buffer, oid->hash, the_hash_algo->rawsz);
403 fprintf(stderr, "cache-tree update-one %o %.*s\n",
404 mode, entlen, path + baselen);
409 struct object_id oid;
410 hash_object_file(buffer.buf, buffer.len, tree_type, &oid);
411 if (has_object_file(&oid))
412 oidcpy(&it->oid, &oid);
416 hash_object_file(buffer.buf, buffer.len, tree_type, &it->oid);
417 } else if (write_object_file(buffer.buf, buffer.len, tree_type,
419 strbuf_release(&buffer);
423 strbuf_release(&buffer);
424 it->entry_count = to_invalidate ? -1 : i - *skip_count;
426 fprintf(stderr, "cache-tree update-one (%d ent, %d subtree) %s\n",
427 it->entry_count, it->subtree_nr,
428 oid_to_hex(&it->oid));
433 int cache_tree_update(struct index_state *istate, int flags)
435 struct cache_tree *it = istate->cache_tree;
436 struct cache_entry **cache = istate->cache;
437 int entries = istate->cache_nr;
438 int skip, i = verify_cache(cache, entries, flags);
442 trace_performance_enter();
443 i = update_one(it, cache, entries, "", 0, &skip, flags);
444 trace_performance_leave("cache_tree_update");
447 istate->cache_changed |= CACHE_TREE_CHANGED;
451 static void write_one(struct strbuf *buffer, struct cache_tree *it,
452 const char *path, int pathlen)
456 /* One "cache-tree" entry consists of the following:
457 * path (NUL terminated)
458 * entry_count, subtree_nr ("%d %d\n")
459 * tree-sha1 (missing if invalid)
460 * subtree_nr "cache-tree" entries for subtrees.
462 strbuf_grow(buffer, pathlen + 100);
463 strbuf_add(buffer, path, pathlen);
464 strbuf_addf(buffer, "%c%d %d\n", 0, it->entry_count, it->subtree_nr);
467 if (0 <= it->entry_count)
468 fprintf(stderr, "cache-tree <%.*s> (%d ent, %d subtree) %s\n",
469 pathlen, path, it->entry_count, it->subtree_nr,
470 oid_to_hex(&it->oid));
472 fprintf(stderr, "cache-tree <%.*s> (%d subtree) invalid\n",
473 pathlen, path, it->subtree_nr);
476 if (0 <= it->entry_count) {
477 strbuf_add(buffer, it->oid.hash, the_hash_algo->rawsz);
479 for (i = 0; i < it->subtree_nr; i++) {
480 struct cache_tree_sub *down = it->down[i];
482 struct cache_tree_sub *prev = it->down[i-1];
483 if (subtree_name_cmp(down->name, down->namelen,
484 prev->name, prev->namelen) <= 0)
485 die("fatal - unsorted cache subtree");
487 write_one(buffer, down->cache_tree, down->name, down->namelen);
491 void cache_tree_write(struct strbuf *sb, struct cache_tree *root)
493 write_one(sb, root, "", 0);
496 static struct cache_tree *read_one(const char **buffer, unsigned long *size_p)
498 const char *buf = *buffer;
499 unsigned long size = *size_p;
502 struct cache_tree *it;
504 const unsigned rawsz = the_hash_algo->rawsz;
507 /* skip name, but make sure name exists */
508 while (size && *buf) {
518 it->entry_count = strtol(cp, &ep, 10);
522 subtree_nr = strtol(cp, &ep, 10);
525 while (size && *buf && *buf != '\n') {
532 if (0 <= it->entry_count) {
535 oidread(&it->oid, (const unsigned char *)buf);
541 if (0 <= it->entry_count)
542 fprintf(stderr, "cache-tree <%s> (%d ent, %d subtree) %s\n",
543 *buffer, it->entry_count, subtree_nr,
544 oid_to_hex(&it->oid));
546 fprintf(stderr, "cache-tree <%s> (%d subtrees) invalid\n",
547 *buffer, subtree_nr);
551 * Just a heuristic -- we do not add directories that often but
552 * we do not want to have to extend it immediately when we do,
555 it->subtree_alloc = subtree_nr + 2;
556 it->down = xcalloc(it->subtree_alloc, sizeof(struct cache_tree_sub *));
557 for (i = 0; i < subtree_nr; i++) {
558 /* read each subtree */
559 struct cache_tree *sub;
560 struct cache_tree_sub *subtree;
561 const char *name = buf;
563 sub = read_one(&buf, &size);
566 subtree = cache_tree_sub(it, name);
567 subtree->cache_tree = sub;
569 if (subtree_nr != it->subtree_nr)
570 die("cache-tree: internal error");
576 cache_tree_free(&it);
580 struct cache_tree *cache_tree_read(const char *buffer, unsigned long size)
583 return NULL; /* not the whole tree */
584 return read_one(&buffer, &size);
587 static struct cache_tree *cache_tree_find(struct cache_tree *it, const char *path)
593 struct cache_tree_sub *sub;
595 slash = strchrnul(path, '/');
597 * Between path and slash is the name of the subtree
600 sub = find_subtree(it, path, slash - path, 0);
603 it = sub->cache_tree;
612 int write_index_as_tree(struct object_id *oid, struct index_state *index_state, const char *index_path, int flags, const char *prefix)
614 int entries, was_valid;
615 struct lock_file lock_file = LOCK_INIT;
618 hold_lock_file_for_update(&lock_file, index_path, LOCK_DIE_ON_ERROR);
620 entries = read_index_from(index_state, index_path, get_git_dir());
622 ret = WRITE_TREE_UNREADABLE_INDEX;
625 if (flags & WRITE_TREE_IGNORE_CACHE_TREE)
626 cache_tree_free(&index_state->cache_tree);
628 if (!index_state->cache_tree)
629 index_state->cache_tree = cache_tree();
631 was_valid = cache_tree_fully_valid(index_state->cache_tree);
633 if (cache_tree_update(index_state, flags) < 0) {
634 ret = WRITE_TREE_UNMERGED_INDEX;
637 write_locked_index(index_state, &lock_file, COMMIT_LOCK);
638 /* Not being able to write is fine -- we are only interested
639 * in updating the cache-tree part, and if the next caller
640 * ends up using the old index with unupdated cache-tree part
641 * it misses the work we did here, but that is just a
642 * performance penalty and not a big deal.
647 struct cache_tree *subtree;
648 subtree = cache_tree_find(index_state->cache_tree, prefix);
650 ret = WRITE_TREE_PREFIX_ERROR;
653 oidcpy(oid, &subtree->oid);
656 oidcpy(oid, &index_state->cache_tree->oid);
659 rollback_lock_file(&lock_file);
663 static void prime_cache_tree_rec(struct repository *r,
664 struct cache_tree *it,
667 struct tree_desc desc;
668 struct name_entry entry;
671 oidcpy(&it->oid, &tree->object.oid);
672 init_tree_desc(&desc, tree->buffer, tree->size);
674 while (tree_entry(&desc, &entry)) {
675 if (!S_ISDIR(entry.mode))
678 struct cache_tree_sub *sub;
679 struct tree *subtree = lookup_tree(r, &entry.oid);
680 if (!subtree->object.parsed)
682 sub = cache_tree_sub(it, entry.path);
683 sub->cache_tree = cache_tree();
684 prime_cache_tree_rec(r, sub->cache_tree, subtree);
685 cnt += sub->cache_tree->entry_count;
688 it->entry_count = cnt;
691 void prime_cache_tree(struct repository *r,
692 struct index_state *istate,
695 cache_tree_free(&istate->cache_tree);
696 istate->cache_tree = cache_tree();
697 prime_cache_tree_rec(r, istate->cache_tree, tree);
698 istate->cache_changed |= CACHE_TREE_CHANGED;
702 * find the cache_tree that corresponds to the current level without
703 * exploding the full path into textual form. The root of the
704 * cache tree is given as "root", and our current level is "info".
705 * (1) When at root level, info->prev is NULL, so it is "root" itself.
706 * (2) Otherwise, find the cache_tree that corresponds to one level
707 * above us, and find ourselves in there.
709 static struct cache_tree *find_cache_tree_from_traversal(struct cache_tree *root,
710 struct traverse_info *info)
712 struct cache_tree *our_parent;
716 our_parent = find_cache_tree_from_traversal(root, info->prev);
717 return cache_tree_find(our_parent, info->name);
720 int cache_tree_matches_traversal(struct cache_tree *root,
721 struct name_entry *ent,
722 struct traverse_info *info)
724 struct cache_tree *it;
726 it = find_cache_tree_from_traversal(root, info);
727 it = cache_tree_find(it, ent->path);
728 if (it && it->entry_count > 0 && oideq(&ent->oid, &it->oid))
729 return it->entry_count;
733 static void verify_one(struct repository *r,
734 struct index_state *istate,
735 struct cache_tree *it,
738 int i, pos, len = path->len;
739 struct strbuf tree_buf = STRBUF_INIT;
740 struct object_id new_oid;
742 for (i = 0; i < it->subtree_nr; i++) {
743 strbuf_addf(path, "%s/", it->down[i]->name);
744 verify_one(r, istate, it->down[i]->cache_tree, path);
745 strbuf_setlen(path, len);
748 if (it->entry_count < 0 ||
749 /* no verification on tests (t7003) that replace trees */
750 lookup_replace_object(r, &it->oid) != &it->oid)
754 pos = index_name_pos(istate, path->buf, path->len);
761 while (i < it->entry_count) {
762 struct cache_entry *ce = istate->cache[pos + i];
764 struct cache_tree_sub *sub = NULL;
765 const struct object_id *oid;
770 if (ce->ce_flags & (CE_STAGEMASK | CE_INTENT_TO_ADD | CE_REMOVE))
771 BUG("%s with flags 0x%x should not be in cache-tree",
772 ce->name, ce->ce_flags);
773 name = ce->name + path->len;
774 slash = strchr(name, '/');
776 entlen = slash - name;
777 sub = find_subtree(it, ce->name + path->len, entlen, 0);
778 if (!sub || sub->cache_tree->entry_count < 0)
779 BUG("bad subtree '%.*s'", entlen, name);
780 oid = &sub->cache_tree->oid;
782 i += sub->cache_tree->entry_count;
786 entlen = ce_namelen(ce) - path->len;
789 strbuf_addf(&tree_buf, "%o %.*s%c", mode, entlen, name, '\0');
790 strbuf_add(&tree_buf, oid->hash, the_hash_algo->rawsz);
792 hash_object_file(tree_buf.buf, tree_buf.len, tree_type, &new_oid);
793 if (!oideq(&new_oid, &it->oid))
794 BUG("cache-tree for path %.*s does not match. "
795 "Expected %s got %s", len, path->buf,
796 oid_to_hex(&new_oid), oid_to_hex(&it->oid));
797 strbuf_setlen(path, len);
798 strbuf_release(&tree_buf);
801 void cache_tree_verify(struct repository *r, struct index_state *istate)
803 struct strbuf path = STRBUF_INIT;
805 if (!istate->cache_tree)
807 verify_one(r, istate, istate->cache_tree, &path);
808 strbuf_release(&path);