2 #include "argv-array.h"
3 #include "repository.h"
8 #include "cache-tree.h"
9 #include "unpack-trees.h"
13 #include "split-index.h"
14 #include "submodule.h"
15 #include "submodule-config.h"
16 #include "fsmonitor.h"
17 #include "object-store.h"
18 #include "promisor-remote.h"
21 * Error messages expected by scripts out of plumbing commands such as
22 * read-tree. Non-scripted Porcelain is not required to use these messages
23 * and in fact are encouraged to reword them to better suit their particular
24 * situation better. See how "git checkout" and "git merge" replaces
25 * them using setup_unpack_trees_porcelain(), for example.
27 static const char *unpack_plumbing_errors[NB_UNPACK_TREES_ERROR_TYPES] = {
28 /* ERROR_WOULD_OVERWRITE */
29 "Entry '%s' would be overwritten by merge. Cannot merge.",
31 /* ERROR_NOT_UPTODATE_FILE */
32 "Entry '%s' not uptodate. Cannot merge.",
34 /* ERROR_NOT_UPTODATE_DIR */
35 "Updating '%s' would lose untracked files in it",
37 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
38 "Untracked working tree file '%s' would be overwritten by merge.",
40 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
41 "Untracked working tree file '%s' would be removed by merge.",
43 /* ERROR_BIND_OVERLAP */
44 "Entry '%s' overlaps with '%s'. Cannot bind.",
46 /* ERROR_SPARSE_NOT_UPTODATE_FILE */
47 "Entry '%s' not uptodate. Cannot update sparse checkout.",
49 /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
50 "Working tree file '%s' would be overwritten by sparse checkout update.",
52 /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
53 "Working tree file '%s' would be removed by sparse checkout update.",
55 /* ERROR_WOULD_LOSE_SUBMODULE */
56 "Submodule '%s' cannot checkout new HEAD.",
59 #define ERRORMSG(o,type) \
60 ( ((o) && (o)->msgs[(type)]) \
61 ? ((o)->msgs[(type)]) \
62 : (unpack_plumbing_errors[(type)]) )
64 static const char *super_prefixed(const char *path)
67 * It is necessary and sufficient to have two static buffers
68 * here, as the return value of this function is fed to
69 * error() using the unpack_*_errors[] templates we see above.
71 static struct strbuf buf[2] = {STRBUF_INIT, STRBUF_INIT};
72 static int super_prefix_len = -1;
73 static unsigned idx = ARRAY_SIZE(buf) - 1;
75 if (super_prefix_len < 0) {
76 const char *super_prefix = get_super_prefix();
81 for (i = 0; i < ARRAY_SIZE(buf); i++)
82 strbuf_addstr(&buf[i], super_prefix);
83 super_prefix_len = buf[0].len;
87 if (!super_prefix_len)
90 if (++idx >= ARRAY_SIZE(buf))
93 strbuf_setlen(&buf[idx], super_prefix_len);
94 strbuf_addstr(&buf[idx], path);
99 void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
103 const char **msgs = opts->msgs;
106 argv_array_init(&opts->msgs_to_free);
108 if (!strcmp(cmd, "checkout"))
109 msg = advice_commit_before_merge
110 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
111 "Please commit your changes or stash them before you switch branches.")
112 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
113 else if (!strcmp(cmd, "merge"))
114 msg = advice_commit_before_merge
115 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
116 "Please commit your changes or stash them before you merge.")
117 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
119 msg = advice_commit_before_merge
120 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
121 "Please commit your changes or stash them before you %s.")
122 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
123 msgs[ERROR_WOULD_OVERWRITE] = msgs[ERROR_NOT_UPTODATE_FILE] =
124 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
126 msgs[ERROR_NOT_UPTODATE_DIR] =
127 _("Updating the following directories would lose untracked files in them:\n%s");
129 if (!strcmp(cmd, "checkout"))
130 msg = advice_commit_before_merge
131 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
132 "Please move or remove them before you switch branches.")
133 : _("The following untracked working tree files would be removed by checkout:\n%%s");
134 else if (!strcmp(cmd, "merge"))
135 msg = advice_commit_before_merge
136 ? _("The following untracked working tree files would be removed by merge:\n%%s"
137 "Please move or remove them before you merge.")
138 : _("The following untracked working tree files would be removed by merge:\n%%s");
140 msg = advice_commit_before_merge
141 ? _("The following untracked working tree files would be removed by %s:\n%%s"
142 "Please move or remove them before you %s.")
143 : _("The following untracked working tree files would be removed by %s:\n%%s");
144 msgs[ERROR_WOULD_LOSE_UNTRACKED_REMOVED] =
145 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
147 if (!strcmp(cmd, "checkout"))
148 msg = advice_commit_before_merge
149 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
150 "Please move or remove them before you switch branches.")
151 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
152 else if (!strcmp(cmd, "merge"))
153 msg = advice_commit_before_merge
154 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
155 "Please move or remove them before you merge.")
156 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
158 msg = advice_commit_before_merge
159 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
160 "Please move or remove them before you %s.")
161 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
162 msgs[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN] =
163 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
166 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
167 * cannot easily display it as a list.
169 msgs[ERROR_BIND_OVERLAP] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
171 msgs[ERROR_SPARSE_NOT_UPTODATE_FILE] =
172 _("Cannot update sparse checkout: the following entries are not up to date:\n%s");
173 msgs[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN] =
174 _("The following working tree files would be overwritten by sparse checkout update:\n%s");
175 msgs[ERROR_WOULD_LOSE_ORPHANED_REMOVED] =
176 _("The following working tree files would be removed by sparse checkout update:\n%s");
177 msgs[ERROR_WOULD_LOSE_SUBMODULE] =
178 _("Cannot update submodule:\n%s");
180 opts->show_all_errors = 1;
181 /* rejected paths may not have a static buffer */
182 for (i = 0; i < ARRAY_SIZE(opts->unpack_rejects); i++)
183 opts->unpack_rejects[i].strdup_strings = 1;
186 void clear_unpack_trees_porcelain(struct unpack_trees_options *opts)
188 argv_array_clear(&opts->msgs_to_free);
189 memset(opts->msgs, 0, sizeof(opts->msgs));
192 static int do_add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
193 unsigned int set, unsigned int clear)
200 ce->ce_flags = (ce->ce_flags & ~clear) | set;
201 return add_index_entry(&o->result, ce,
202 ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
205 static void add_entry(struct unpack_trees_options *o,
206 const struct cache_entry *ce,
207 unsigned int set, unsigned int clear)
209 do_add_entry(o, dup_cache_entry(ce, &o->result), set, clear);
213 * add error messages on path <path>
214 * corresponding to the type <e> with the message <msg>
215 * indicating if it should be display in porcelain or not
217 static int add_rejected_path(struct unpack_trees_options *o,
218 enum unpack_trees_error_types e,
224 if (!o->show_all_errors)
225 return error(ERRORMSG(o, e), super_prefixed(path));
228 * Otherwise, insert in a list for future display by
229 * display_error_msgs()
231 string_list_append(&o->unpack_rejects[e], path);
236 * display all the error messages stored in a nice way
238 static void display_error_msgs(struct unpack_trees_options *o)
241 int something_displayed = 0;
242 for (e = 0; e < NB_UNPACK_TREES_ERROR_TYPES; e++) {
243 struct string_list *rejects = &o->unpack_rejects[e];
244 if (rejects->nr > 0) {
245 struct strbuf path = STRBUF_INIT;
246 something_displayed = 1;
247 for (i = 0; i < rejects->nr; i++)
248 strbuf_addf(&path, "\t%s\n", rejects->items[i].string);
249 error(ERRORMSG(o, e), super_prefixed(path.buf));
250 strbuf_release(&path);
252 string_list_clear(rejects, 0);
254 if (something_displayed)
255 fprintf(stderr, _("Aborting\n"));
258 static int check_submodule_move_head(const struct cache_entry *ce,
261 struct unpack_trees_options *o)
263 unsigned flags = SUBMODULE_MOVE_HEAD_DRY_RUN;
264 const struct submodule *sub = submodule_from_ce(ce);
270 flags |= SUBMODULE_MOVE_HEAD_FORCE;
272 if (submodule_move_head(ce->name, old_id, new_id, flags))
273 return add_rejected_path(o, ERROR_WOULD_LOSE_SUBMODULE, ce->name);
278 * Perform the loading of the repository's gitmodules file. This function is
279 * used by 'check_update()' to perform loading of the gitmodules file in two
280 * different situations:
281 * (1) before removing entries from the working tree if the gitmodules file has
282 * been marked for removal. This situation is specified by 'state' == NULL.
283 * (2) before checking out entries to the working tree if the gitmodules file
284 * has been marked for update. This situation is specified by 'state' != NULL.
286 static void load_gitmodules_file(struct index_state *index,
287 struct checkout *state)
289 int pos = index_name_pos(index, GITMODULES_FILE, strlen(GITMODULES_FILE));
292 struct cache_entry *ce = index->cache[pos];
293 if (!state && ce->ce_flags & CE_WT_REMOVE) {
294 repo_read_gitmodules(the_repository, 0);
295 } else if (state && (ce->ce_flags & CE_UPDATE)) {
296 submodule_free(the_repository);
297 checkout_entry(ce, state, NULL, NULL);
298 repo_read_gitmodules(the_repository, 0);
303 static struct progress *get_progress(struct unpack_trees_options *o)
305 unsigned cnt = 0, total = 0;
306 struct index_state *index = &o->result;
308 if (!o->update || !o->verbose_update)
311 for (; cnt < index->cache_nr; cnt++) {
312 const struct cache_entry *ce = index->cache[cnt];
313 if (ce->ce_flags & (CE_UPDATE | CE_WT_REMOVE))
317 return start_delayed_progress(_("Updating files"), total);
320 static void setup_collided_checkout_detection(struct checkout *state,
321 struct index_state *index)
326 for (i = 0; i < index->cache_nr; i++)
327 index->cache[i]->ce_flags &= ~CE_MATCHED;
330 static void report_collided_checkout(struct index_state *index)
332 struct string_list list = STRING_LIST_INIT_NODUP;
335 for (i = 0; i < index->cache_nr; i++) {
336 struct cache_entry *ce = index->cache[i];
338 if (!(ce->ce_flags & CE_MATCHED))
341 string_list_append(&list, ce->name);
342 ce->ce_flags &= ~CE_MATCHED;
345 list.cmp = fspathcmp;
346 string_list_sort(&list);
349 warning(_("the following paths have collided (e.g. case-sensitive paths\n"
350 "on a case-insensitive filesystem) and only one from the same\n"
351 "colliding group is in the working tree:\n"));
353 for (i = 0; i < list.nr; i++)
354 fprintf(stderr, " '%s'\n", list.items[i].string);
357 string_list_clear(&list, 0);
360 static int check_updates(struct unpack_trees_options *o)
364 struct progress *progress;
365 struct index_state *index = &o->result;
366 struct checkout state = CHECKOUT_INIT;
369 trace_performance_enter();
372 state.refresh_cache = 1;
373 state.istate = index;
374 clone_checkout_metadata(&state.meta, &o->meta, NULL);
376 if (!o->update || o->dry_run) {
377 remove_marked_cache_entries(index, 0);
378 trace_performance_leave("check_updates");
383 setup_collided_checkout_detection(&state, index);
385 progress = get_progress(o);
387 git_attr_set_direction(GIT_ATTR_CHECKOUT);
389 if (should_update_submodules())
390 load_gitmodules_file(index, NULL);
392 for (i = 0; i < index->cache_nr; i++) {
393 const struct cache_entry *ce = index->cache[i];
395 if (ce->ce_flags & CE_WT_REMOVE) {
396 display_progress(progress, ++cnt);
401 remove_marked_cache_entries(index, 0);
402 remove_scheduled_dirs();
404 if (should_update_submodules())
405 load_gitmodules_file(index, &state);
407 enable_delayed_checkout(&state);
408 if (has_promisor_remote()) {
410 * Prefetch the objects that are to be checked out in the loop
413 struct oid_array to_fetch = OID_ARRAY_INIT;
414 for (i = 0; i < index->cache_nr; i++) {
415 struct cache_entry *ce = index->cache[i];
417 if (!(ce->ce_flags & CE_UPDATE) ||
418 S_ISGITLINK(ce->ce_mode))
420 if (!oid_object_info_extended(the_repository, &ce->oid,
422 OBJECT_INFO_FOR_PREFETCH))
424 oid_array_append(&to_fetch, &ce->oid);
426 promisor_remote_get_direct(the_repository,
427 to_fetch.oid, to_fetch.nr);
428 oid_array_clear(&to_fetch);
430 for (i = 0; i < index->cache_nr; i++) {
431 struct cache_entry *ce = index->cache[i];
433 if (ce->ce_flags & CE_UPDATE) {
434 if (ce->ce_flags & CE_WT_REMOVE)
435 BUG("both update and delete flags are set on %s",
437 display_progress(progress, ++cnt);
438 ce->ce_flags &= ~CE_UPDATE;
439 errs |= checkout_entry(ce, &state, NULL, NULL);
442 stop_progress(&progress);
443 errs |= finish_delayed_checkout(&state, NULL);
444 git_attr_set_direction(GIT_ATTR_CHECKIN);
447 report_collided_checkout(index);
449 trace_performance_leave("check_updates");
453 static int verify_uptodate_sparse(const struct cache_entry *ce,
454 struct unpack_trees_options *o);
455 static int verify_absent_sparse(const struct cache_entry *ce,
456 enum unpack_trees_error_types,
457 struct unpack_trees_options *o);
459 static int apply_sparse_checkout(struct index_state *istate,
460 struct cache_entry *ce,
461 struct unpack_trees_options *o)
463 int was_skip_worktree = ce_skip_worktree(ce);
465 if (ce->ce_flags & CE_NEW_SKIP_WORKTREE)
466 ce->ce_flags |= CE_SKIP_WORKTREE;
468 ce->ce_flags &= ~CE_SKIP_WORKTREE;
469 if (was_skip_worktree != ce_skip_worktree(ce)) {
470 ce->ce_flags |= CE_UPDATE_IN_BASE;
471 mark_fsmonitor_invalid(istate, ce);
472 istate->cache_changed |= CE_ENTRY_CHANGED;
476 * if (!was_skip_worktree && !ce_skip_worktree()) {
477 * This is perfectly normal. Move on;
482 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
483 * area as a result of ce_skip_worktree() shortcuts in
484 * verify_absent() and verify_uptodate().
485 * Make sure they don't modify worktree if they are already
486 * outside checkout area
488 if (was_skip_worktree && ce_skip_worktree(ce)) {
489 ce->ce_flags &= ~CE_UPDATE;
492 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
493 * on to get that file removed from both index and worktree.
494 * If that file is already outside worktree area, don't
497 if (ce->ce_flags & CE_REMOVE)
498 ce->ce_flags &= ~CE_WT_REMOVE;
501 if (!was_skip_worktree && ce_skip_worktree(ce)) {
503 * If CE_UPDATE is set, verify_uptodate() must be called already
504 * also stat info may have lost after merged_entry() so calling
505 * verify_uptodate() again may fail
507 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
509 ce->ce_flags |= CE_WT_REMOVE;
510 ce->ce_flags &= ~CE_UPDATE;
512 if (was_skip_worktree && !ce_skip_worktree(ce)) {
513 if (verify_absent_sparse(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
515 ce->ce_flags |= CE_UPDATE;
520 static inline int call_unpack_fn(const struct cache_entry * const *src,
521 struct unpack_trees_options *o)
523 int ret = o->fn(src, o);
529 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
531 ce->ce_flags |= CE_UNPACKED;
533 if (o->cache_bottom < o->src_index->cache_nr &&
534 o->src_index->cache[o->cache_bottom] == ce) {
535 int bottom = o->cache_bottom;
536 while (bottom < o->src_index->cache_nr &&
537 o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
539 o->cache_bottom = bottom;
543 static void mark_all_ce_unused(struct index_state *index)
546 for (i = 0; i < index->cache_nr; i++)
547 index->cache[i]->ce_flags &= ~(CE_UNPACKED | CE_ADDED | CE_NEW_SKIP_WORKTREE);
550 static int locate_in_src_index(const struct cache_entry *ce,
551 struct unpack_trees_options *o)
553 struct index_state *index = o->src_index;
554 int len = ce_namelen(ce);
555 int pos = index_name_pos(index, ce->name, len);
562 * We call unpack_index_entry() with an unmerged cache entry
563 * only in diff-index, and it wants a single callback. Skip
564 * the other unmerged entry with the same name.
566 static void mark_ce_used_same_name(struct cache_entry *ce,
567 struct unpack_trees_options *o)
569 struct index_state *index = o->src_index;
570 int len = ce_namelen(ce);
573 for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
574 struct cache_entry *next = index->cache[pos];
575 if (len != ce_namelen(next) ||
576 memcmp(ce->name, next->name, len))
578 mark_ce_used(next, o);
582 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o)
584 const struct index_state *index = o->src_index;
585 int pos = o->cache_bottom;
587 while (pos < index->cache_nr) {
588 struct cache_entry *ce = index->cache[pos];
589 if (!(ce->ce_flags & CE_UNPACKED))
596 static void add_same_unmerged(const struct cache_entry *ce,
597 struct unpack_trees_options *o)
599 struct index_state *index = o->src_index;
600 int len = ce_namelen(ce);
601 int pos = index_name_pos(index, ce->name, len);
604 die("programming error in a caller of mark_ce_used_same_name");
605 for (pos = -pos - 1; pos < index->cache_nr; pos++) {
606 struct cache_entry *next = index->cache[pos];
607 if (len != ce_namelen(next) ||
608 memcmp(ce->name, next->name, len))
610 add_entry(o, next, 0, 0);
611 mark_ce_used(next, o);
615 static int unpack_index_entry(struct cache_entry *ce,
616 struct unpack_trees_options *o)
618 const struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
625 if (o->skip_unmerged) {
626 add_entry(o, ce, 0, 0);
630 ret = call_unpack_fn(src, o);
632 mark_ce_used_same_name(ce, o);
636 static int find_cache_pos(struct traverse_info *, const char *p, size_t len);
638 static void restore_cache_bottom(struct traverse_info *info, int bottom)
640 struct unpack_trees_options *o = info->data;
642 if (o->diff_index_cached)
644 o->cache_bottom = bottom;
647 static int switch_cache_bottom(struct traverse_info *info)
649 struct unpack_trees_options *o = info->data;
652 if (o->diff_index_cached)
654 ret = o->cache_bottom;
655 pos = find_cache_pos(info->prev, info->name, info->namelen);
658 o->cache_bottom = -2 - pos;
660 o->cache_bottom = o->src_index->cache_nr;
664 static inline int are_same_oid(struct name_entry *name_j, struct name_entry *name_k)
666 return !is_null_oid(&name_j->oid) && !is_null_oid(&name_k->oid) && oideq(&name_j->oid, &name_k->oid);
669 static int all_trees_same_as_cache_tree(int n, unsigned long dirmask,
670 struct name_entry *names,
671 struct traverse_info *info)
673 struct unpack_trees_options *o = info->data;
676 if (!o->merge || dirmask != ((1 << n) - 1))
679 for (i = 1; i < n; i++)
680 if (!are_same_oid(names, names + i))
683 return cache_tree_matches_traversal(o->src_index->cache_tree, names, info);
686 static int index_pos_by_traverse_info(struct name_entry *names,
687 struct traverse_info *info)
689 struct unpack_trees_options *o = info->data;
690 struct strbuf name = STRBUF_INIT;
693 strbuf_make_traverse_path(&name, info, names->path, names->pathlen);
694 strbuf_addch(&name, '/');
695 pos = index_name_pos(o->src_index, name.buf, name.len);
697 BUG("This is a directory and should not exist in index");
699 if (pos >= o->src_index->cache_nr ||
700 !starts_with(o->src_index->cache[pos]->name, name.buf) ||
701 (pos > 0 && starts_with(o->src_index->cache[pos-1]->name, name.buf)))
702 BUG("pos %d doesn't point to the first entry of %s in index",
704 strbuf_release(&name);
709 * Fast path if we detect that all trees are the same as cache-tree at this
710 * path. We'll walk these trees in an iterative loop using cache-tree/index
711 * instead of ODB since we already know what these trees contain.
713 static int traverse_by_cache_tree(int pos, int nr_entries, int nr_names,
714 struct traverse_info *info)
716 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
717 struct unpack_trees_options *o = info->data;
718 struct cache_entry *tree_ce = NULL;
723 BUG("We need cache-tree to do this optimization");
726 * Do what unpack_callback() and unpack_nondirectories() normally
727 * do. But we walk all paths in an iterative loop instead.
729 * D/F conflicts and higher stage entries are not a concern
730 * because cache-tree would be invalidated and we would never
731 * get here in the first place.
733 for (i = 0; i < nr_entries; i++) {
734 int new_ce_len, len, rc;
736 src[0] = o->src_index->cache[pos + i];
738 len = ce_namelen(src[0]);
739 new_ce_len = cache_entry_size(len);
741 if (new_ce_len > ce_len) {
743 tree_ce = xrealloc(tree_ce, new_ce_len);
744 memset(tree_ce, 0, new_ce_len);
747 tree_ce->ce_flags = create_ce_flags(0);
749 for (d = 1; d <= nr_names; d++)
753 tree_ce->ce_mode = src[0]->ce_mode;
754 tree_ce->ce_namelen = len;
755 oidcpy(&tree_ce->oid, &src[0]->oid);
756 memcpy(tree_ce->name, src[0]->name, len + 1);
758 rc = call_unpack_fn((const struct cache_entry * const *)src, o);
764 mark_ce_used(src[0], o);
768 printf("Unpacked %d entries from %s to %s using cache-tree\n",
770 o->src_index->cache[pos]->name,
771 o->src_index->cache[pos + nr_entries - 1]->name);
775 static int traverse_trees_recursive(int n, unsigned long dirmask,
776 unsigned long df_conflicts,
777 struct name_entry *names,
778 struct traverse_info *info)
780 struct unpack_trees_options *o = info->data;
783 struct tree_desc t[MAX_UNPACK_TREES];
784 void *buf[MAX_UNPACK_TREES];
785 struct traverse_info newinfo;
786 struct name_entry *p;
789 nr_entries = all_trees_same_as_cache_tree(n, dirmask, names, info);
790 if (nr_entries > 0) {
791 int pos = index_pos_by_traverse_info(names, info);
793 if (!o->merge || df_conflicts)
794 BUG("Wrong condition to get here buddy");
797 * All entries up to 'pos' must have been processed
798 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
799 * save and restore cache_bottom anyway to not miss
800 * unprocessed entries before 'pos'.
802 bottom = o->cache_bottom;
803 ret = traverse_by_cache_tree(pos, nr_entries, n, info);
804 o->cache_bottom = bottom;
814 newinfo.pathspec = info->pathspec;
815 newinfo.name = p->path;
816 newinfo.namelen = p->pathlen;
817 newinfo.mode = p->mode;
818 newinfo.pathlen = st_add3(newinfo.pathlen, tree_entry_len(p), 1);
819 newinfo.df_conflicts |= df_conflicts;
822 * Fetch the tree from the ODB for each peer directory in the
825 * For 2- and 3-way traversals, we try to avoid hitting the
826 * ODB twice for the same OID. This should yield a nice speed
827 * up in checkouts and merges when the commits are similar.
829 * We don't bother doing the full O(n^2) search for larger n,
830 * because wider traversals don't happen that often and we
831 * avoid the search setup.
833 * When 2 peer OIDs are the same, we just copy the tree
834 * descriptor data. This implicitly borrows the buffer
835 * data from the earlier cell.
837 for (i = 0; i < n; i++, dirmask >>= 1) {
838 if (i > 0 && are_same_oid(&names[i], &names[i - 1]))
840 else if (i > 1 && are_same_oid(&names[i], &names[i - 2]))
843 const struct object_id *oid = NULL;
846 buf[nr_buf++] = fill_tree_descriptor(the_repository, t + i, oid);
850 bottom = switch_cache_bottom(&newinfo);
851 ret = traverse_trees(o->src_index, n, t, &newinfo);
852 restore_cache_bottom(&newinfo, bottom);
854 for (i = 0; i < nr_buf; i++)
861 * Compare the traverse-path to the cache entry without actually
862 * having to generate the textual representation of the traverse
865 * NOTE! This *only* compares up to the size of the traverse path
866 * itself - the caller needs to do the final check for the cache
867 * entry having more data at the end!
869 static int do_compare_entry_piecewise(const struct cache_entry *ce,
870 const struct traverse_info *info,
871 const char *name, size_t namelen,
878 int cmp = do_compare_entry_piecewise(ce, info->prev,
879 info->name, info->namelen,
884 pathlen = info->pathlen;
885 ce_len = ce_namelen(ce);
887 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
888 if (ce_len < pathlen)
892 ce_name = ce->name + pathlen;
894 return df_name_compare(ce_name, ce_len, S_IFREG, name, namelen, mode);
897 static int do_compare_entry(const struct cache_entry *ce,
898 const struct traverse_info *info,
899 const char *name, size_t namelen,
907 * If we have not precomputed the traverse path, it is quicker
908 * to avoid doing so. But if we have precomputed it,
909 * it is quicker to use the precomputed version.
911 if (!info->traverse_path)
912 return do_compare_entry_piecewise(ce, info, name, namelen, mode);
914 cmp = strncmp(ce->name, info->traverse_path, info->pathlen);
918 pathlen = info->pathlen;
919 ce_len = ce_namelen(ce);
921 if (ce_len < pathlen)
925 ce_name = ce->name + pathlen;
927 return df_name_compare(ce_name, ce_len, S_IFREG, name, namelen, mode);
930 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
932 int cmp = do_compare_entry(ce, info, n->path, n->pathlen, n->mode);
937 * Even if the beginning compared identically, the ce should
938 * compare as bigger than a directory leading up to it!
940 return ce_namelen(ce) > traverse_path_len(info, tree_entry_len(n));
943 static int ce_in_traverse_path(const struct cache_entry *ce,
944 const struct traverse_info *info)
948 if (do_compare_entry(ce, info->prev,
949 info->name, info->namelen, info->mode))
952 * If ce (blob) is the same name as the path (which is a tree
953 * we will be descending into), it won't be inside it.
955 return (info->pathlen < ce_namelen(ce));
958 static struct cache_entry *create_ce_entry(const struct traverse_info *info,
959 const struct name_entry *n,
961 struct index_state *istate,
964 size_t len = traverse_path_len(info, tree_entry_len(n));
965 struct cache_entry *ce =
967 make_empty_transient_cache_entry(len) :
968 make_empty_cache_entry(istate, len);
970 ce->ce_mode = create_ce_mode(n->mode);
971 ce->ce_flags = create_ce_flags(stage);
972 ce->ce_namelen = len;
973 oidcpy(&ce->oid, &n->oid);
974 /* len+1 because the cache_entry allocates space for NUL */
975 make_traverse_path(ce->name, len + 1, info, n->path, n->pathlen);
981 * Note that traverse_by_cache_tree() duplicates some logic in this function
982 * without actually calling it. If you change the logic here you may need to
983 * check and change there as well.
985 static int unpack_nondirectories(int n, unsigned long mask,
986 unsigned long dirmask,
987 struct cache_entry **src,
988 const struct name_entry *names,
989 const struct traverse_info *info)
992 struct unpack_trees_options *o = info->data;
993 unsigned long conflicts = info->df_conflicts | dirmask;
995 /* Do we have *only* directories? Nothing to do */
996 if (mask == dirmask && !src[0])
1000 * Ok, we've filled in up to any potential index entry in src[0],
1003 for (i = 0; i < n; i++) {
1005 unsigned int bit = 1ul << i;
1006 if (conflicts & bit) {
1007 src[i + o->merge] = o->df_conflict_entry;
1014 else if (i + 1 < o->head_idx)
1016 else if (i + 1 > o->head_idx)
1022 * If the merge bit is set, then the cache entries are
1023 * discarded in the following block. In this case,
1024 * construct "transient" cache_entries, as they are
1025 * not stored in the index. otherwise construct the
1026 * cache entry from the index aware logic.
1028 src[i + o->merge] = create_ce_entry(info, names + i, stage, &o->result, o->merge);
1032 int rc = call_unpack_fn((const struct cache_entry * const *)src,
1034 for (i = 0; i < n; i++) {
1035 struct cache_entry *ce = src[i + o->merge];
1036 if (ce != o->df_conflict_entry)
1037 discard_cache_entry(ce);
1042 for (i = 0; i < n; i++)
1043 if (src[i] && src[i] != o->df_conflict_entry)
1044 if (do_add_entry(o, src[i], 0, 0))
1050 static int unpack_failed(struct unpack_trees_options *o, const char *message)
1052 discard_index(&o->result);
1053 if (!o->quiet && !o->exiting_early) {
1055 return error("%s", message);
1062 * The tree traversal is looking at name p. If we have a matching entry,
1063 * return it. If name p is a directory in the index, do not return
1064 * anything, as we will want to match it when the traversal descends into
1067 static int find_cache_pos(struct traverse_info *info,
1068 const char *p, size_t p_len)
1071 struct unpack_trees_options *o = info->data;
1072 struct index_state *index = o->src_index;
1073 int pfxlen = info->pathlen;
1075 for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
1076 const struct cache_entry *ce = index->cache[pos];
1077 const char *ce_name, *ce_slash;
1080 if (ce->ce_flags & CE_UNPACKED) {
1082 * cache_bottom entry is already unpacked, so
1083 * we can never match it; don't check it
1086 if (pos == o->cache_bottom)
1090 if (!ce_in_traverse_path(ce, info)) {
1092 * Check if we can skip future cache checks
1093 * (because we're already past all possible
1094 * entries in the traverse path).
1096 if (info->traverse_path) {
1097 if (strncmp(ce->name, info->traverse_path,
1103 ce_name = ce->name + pfxlen;
1104 ce_slash = strchr(ce_name, '/');
1106 ce_len = ce_slash - ce_name;
1108 ce_len = ce_namelen(ce) - pfxlen;
1109 cmp = name_compare(p, p_len, ce_name, ce_len);
1111 * Exact match; if we have a directory we need to
1112 * delay returning it.
1115 return ce_slash ? -2 - pos : pos;
1117 continue; /* keep looking */
1119 * ce_name sorts after p->path; could it be that we
1120 * have files under p->path directory in the index?
1121 * E.g. ce_name == "t-i", and p->path == "t"; we may
1122 * have "t/a" in the index.
1124 if (p_len < ce_len && !memcmp(ce_name, p, p_len) &&
1125 ce_name[p_len] < '/')
1126 continue; /* keep looking */
1132 static struct cache_entry *find_cache_entry(struct traverse_info *info,
1133 const struct name_entry *p)
1135 int pos = find_cache_pos(info, p->path, p->pathlen);
1136 struct unpack_trees_options *o = info->data;
1139 return o->src_index->cache[pos];
1144 static void debug_path(struct traverse_info *info)
1147 debug_path(info->prev);
1148 if (*info->prev->name)
1151 printf("%s", info->name);
1154 static void debug_name_entry(int i, struct name_entry *n)
1156 printf("ent#%d %06o %s\n", i,
1157 n->path ? n->mode : 0,
1158 n->path ? n->path : "(missing)");
1161 static void debug_unpack_callback(int n,
1163 unsigned long dirmask,
1164 struct name_entry *names,
1165 struct traverse_info *info)
1168 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1172 for (i = 0; i < n; i++)
1173 debug_name_entry(i, names + i);
1177 * Note that traverse_by_cache_tree() duplicates some logic in this function
1178 * without actually calling it. If you change the logic here you may need to
1179 * check and change there as well.
1181 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
1183 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
1184 struct unpack_trees_options *o = info->data;
1185 const struct name_entry *p = names;
1187 /* Find first entry with a real name (we could use "mask" too) */
1191 if (o->debug_unpack)
1192 debug_unpack_callback(n, mask, dirmask, names, info);
1194 /* Are we supposed to look at the index too? */
1198 struct cache_entry *ce;
1200 if (o->diff_index_cached)
1201 ce = next_cache_entry(o);
1203 ce = find_cache_entry(info, p);
1207 cmp = compare_entry(ce, info, p);
1209 if (unpack_index_entry(ce, o) < 0)
1210 return unpack_failed(o, NULL);
1216 * If we skip unmerged index
1217 * entries, we'll skip this
1218 * entry *and* the tree
1219 * entries associated with it!
1221 if (o->skip_unmerged) {
1222 add_same_unmerged(ce, o);
1232 if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
1235 if (o->merge && src[0]) {
1236 if (ce_stage(src[0]))
1237 mark_ce_used_same_name(src[0], o);
1239 mark_ce_used(src[0], o);
1242 /* Now handle any directories.. */
1244 /* special case: "diff-index --cached" looking at a tree */
1245 if (o->diff_index_cached &&
1246 n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
1248 matches = cache_tree_matches_traversal(o->src_index->cache_tree,
1251 * Everything under the name matches; skip the
1252 * entire hierarchy. diff_index_cached codepath
1253 * special cases D/F conflicts in such a way that
1254 * it does not do any look-ahead, so this is safe.
1257 o->cache_bottom += matches;
1262 if (traverse_trees_recursive(n, dirmask, mask & ~dirmask,
1271 static int clear_ce_flags_1(struct index_state *istate,
1272 struct cache_entry **cache, int nr,
1273 struct strbuf *prefix,
1274 int select_mask, int clear_mask,
1275 struct pattern_list *pl,
1276 enum pattern_match_result default_match,
1279 /* Whole directory matching */
1280 static int clear_ce_flags_dir(struct index_state *istate,
1281 struct cache_entry **cache, int nr,
1282 struct strbuf *prefix,
1284 int select_mask, int clear_mask,
1285 struct pattern_list *pl,
1286 enum pattern_match_result default_match,
1289 struct cache_entry **cache_end;
1292 enum pattern_match_result ret, orig_ret;
1293 orig_ret = path_matches_pattern_list(prefix->buf, prefix->len,
1294 basename, &dtype, pl, istate);
1296 strbuf_addch(prefix, '/');
1298 /* If undecided, use matching result of parent dir in defval */
1299 if (orig_ret == UNDECIDED)
1300 ret = default_match;
1304 for (cache_end = cache; cache_end != cache + nr; cache_end++) {
1305 struct cache_entry *ce = *cache_end;
1306 if (strncmp(ce->name, prefix->buf, prefix->len))
1310 if (pl->use_cone_patterns && orig_ret == MATCHED_RECURSIVE) {
1311 struct cache_entry **ce = cache;
1312 rc = cache_end - cache;
1314 while (ce < cache_end) {
1315 (*ce)->ce_flags &= ~clear_mask;
1318 } else if (pl->use_cone_patterns && orig_ret == NOT_MATCHED) {
1319 rc = cache_end - cache;
1321 rc = clear_ce_flags_1(istate, cache, cache_end - cache,
1323 select_mask, clear_mask,
1328 strbuf_setlen(prefix, prefix->len - 1);
1333 * Traverse the index, find every entry that matches according to
1334 * o->pl. Do "ce_flags &= ~clear_mask" on those entries. Return the
1335 * number of traversed entries.
1337 * If select_mask is non-zero, only entries whose ce_flags has on of
1338 * those bits enabled are traversed.
1340 * cache : pointer to an index entry
1341 * prefix_len : an offset to its path
1343 * The current path ("prefix") including the trailing '/' is
1344 * cache[0]->name[0..(prefix_len-1)]
1345 * Top level path has prefix_len zero.
1347 static int clear_ce_flags_1(struct index_state *istate,
1348 struct cache_entry **cache, int nr,
1349 struct strbuf *prefix,
1350 int select_mask, int clear_mask,
1351 struct pattern_list *pl,
1352 enum pattern_match_result default_match,
1355 struct cache_entry **cache_end = nr ? cache + nr : cache;
1358 * Process all entries that have the given prefix and meet
1359 * select_mask condition
1361 while(cache != cache_end) {
1362 struct cache_entry *ce = *cache;
1363 const char *name, *slash;
1365 enum pattern_match_result ret;
1367 display_progress(istate->progress, progress_nr);
1369 if (select_mask && !(ce->ce_flags & select_mask)) {
1375 if (prefix->len && strncmp(ce->name, prefix->buf, prefix->len))
1378 name = ce->name + prefix->len;
1379 slash = strchr(name, '/');
1381 /* If it's a directory, try whole directory match first */
1386 strbuf_add(prefix, name, len);
1388 processed = clear_ce_flags_dir(istate, cache, cache_end - cache,
1390 prefix->buf + prefix->len - len,
1391 select_mask, clear_mask,
1395 /* clear_c_f_dir eats a whole dir already? */
1398 progress_nr += processed;
1399 strbuf_setlen(prefix, prefix->len - len);
1403 strbuf_addch(prefix, '/');
1404 processed = clear_ce_flags_1(istate, cache, cache_end - cache,
1406 select_mask, clear_mask, pl,
1407 default_match, progress_nr);
1410 progress_nr += processed;
1412 strbuf_setlen(prefix, prefix->len - len - 1);
1417 dtype = ce_to_dtype(ce);
1418 ret = path_matches_pattern_list(ce->name,
1420 name, &dtype, pl, istate);
1421 if (ret == UNDECIDED)
1422 ret = default_match;
1423 if (ret == MATCHED || ret == MATCHED_RECURSIVE)
1424 ce->ce_flags &= ~clear_mask;
1429 display_progress(istate->progress, progress_nr);
1430 return nr - (cache_end - cache);
1433 static int clear_ce_flags(struct index_state *istate,
1434 int select_mask, int clear_mask,
1435 struct pattern_list *pl,
1438 static struct strbuf prefix = STRBUF_INIT;
1442 strbuf_reset(&prefix);
1444 istate->progress = start_delayed_progress(
1445 _("Updating index flags"),
1448 xsnprintf(label, sizeof(label), "clear_ce_flags(0x%08lx,0x%08lx)",
1449 (unsigned long)select_mask, (unsigned long)clear_mask);
1450 trace2_region_enter("unpack_trees", label, the_repository);
1451 rval = clear_ce_flags_1(istate,
1455 select_mask, clear_mask,
1457 trace2_region_leave("unpack_trees", label, the_repository);
1459 stop_progress(&istate->progress);
1464 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1466 static void mark_new_skip_worktree(struct pattern_list *pl,
1467 struct index_state *istate,
1468 int select_flag, int skip_wt_flag,
1474 * 1. Pretend the narrowest worktree: only unmerged entries
1477 for (i = 0; i < istate->cache_nr; i++) {
1478 struct cache_entry *ce = istate->cache[i];
1480 if (select_flag && !(ce->ce_flags & select_flag))
1483 if (!ce_stage(ce) && !(ce->ce_flags & CE_CONFLICTED))
1484 ce->ce_flags |= skip_wt_flag;
1486 ce->ce_flags &= ~skip_wt_flag;
1490 * 2. Widen worktree according to sparse-checkout file.
1491 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1493 clear_ce_flags(istate, select_flag, skip_wt_flag, pl, show_progress);
1496 static int verify_absent(const struct cache_entry *,
1497 enum unpack_trees_error_types,
1498 struct unpack_trees_options *);
1500 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1501 * resulting index, -2 on failure to reflect the changes to the work tree.
1503 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1505 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
1508 static struct cache_entry *dfc;
1509 struct pattern_list pl;
1511 if (len > MAX_UNPACK_TREES)
1512 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
1514 trace_performance_enter();
1515 memset(&pl, 0, sizeof(pl));
1516 if (!core_apply_sparse_checkout || !o->update)
1517 o->skip_sparse_checkout = 1;
1518 if (!o->skip_sparse_checkout && !o->pl) {
1519 char *sparse = git_pathdup("info/sparse-checkout");
1520 pl.use_cone_patterns = core_sparse_checkout_cone;
1521 if (add_patterns_from_file_to_list(sparse, "", 0, &pl, NULL) < 0)
1522 o->skip_sparse_checkout = 1;
1528 memset(&o->result, 0, sizeof(o->result));
1529 o->result.initialized = 1;
1530 o->result.timestamp.sec = o->src_index->timestamp.sec;
1531 o->result.timestamp.nsec = o->src_index->timestamp.nsec;
1532 o->result.version = o->src_index->version;
1533 if (!o->src_index->split_index) {
1534 o->result.split_index = NULL;
1535 } else if (o->src_index == o->dst_index) {
1537 * o->dst_index (and thus o->src_index) will be discarded
1538 * and overwritten with o->result at the end of this function,
1539 * so just use src_index's split_index to avoid having to
1542 o->result.split_index = o->src_index->split_index;
1543 o->result.split_index->refcount++;
1545 o->result.split_index = init_split_index(&o->result);
1547 oidcpy(&o->result.oid, &o->src_index->oid);
1548 o->merge_size = len;
1549 mark_all_ce_unused(o->src_index);
1551 if (o->src_index->fsmonitor_last_update)
1552 o->result.fsmonitor_last_update = o->src_index->fsmonitor_last_update;
1555 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1557 if (!o->skip_sparse_checkout)
1558 mark_new_skip_worktree(o->pl, o->src_index, 0,
1559 CE_NEW_SKIP_WORKTREE, o->verbose_update);
1562 dfc = xcalloc(1, cache_entry_size(0));
1563 o->df_conflict_entry = dfc;
1566 const char *prefix = o->prefix ? o->prefix : "";
1567 struct traverse_info info;
1569 setup_traverse_info(&info, prefix);
1570 info.fn = unpack_callback;
1572 info.show_all_errors = o->show_all_errors;
1573 info.pathspec = o->pathspec;
1577 * Unpack existing index entries that sort before the
1578 * prefix the tree is spliced into. Note that o->merge
1579 * is always true in this case.
1582 struct cache_entry *ce = next_cache_entry(o);
1585 if (ce_in_traverse_path(ce, &info))
1587 if (unpack_index_entry(ce, o) < 0)
1592 trace_performance_enter();
1593 ret = traverse_trees(o->src_index, len, t, &info);
1594 trace_performance_leave("traverse_trees");
1599 /* Any left-over entries in the index? */
1602 struct cache_entry *ce = next_cache_entry(o);
1605 if (unpack_index_entry(ce, o) < 0)
1609 mark_all_ce_unused(o->src_index);
1611 if (o->trivial_merges_only && o->nontrivial_merge) {
1612 ret = unpack_failed(o, "Merge requires file-level merging");
1616 if (!o->skip_sparse_checkout) {
1617 int empty_worktree = 1;
1620 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1621 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1622 * so apply_sparse_checkout() won't attempt to remove it from worktree
1624 mark_new_skip_worktree(o->pl, &o->result,
1625 CE_ADDED, CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE,
1629 for (i = 0; i < o->result.cache_nr; i++) {
1630 struct cache_entry *ce = o->result.cache[i];
1633 * Entries marked with CE_ADDED in merged_entry() do not have
1634 * verify_absent() check (the check is effectively disabled
1635 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1637 * Do the real check now because we have had
1638 * correct CE_NEW_SKIP_WORKTREE
1640 if (ce->ce_flags & CE_ADDED &&
1641 verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1642 if (!o->show_all_errors)
1647 if (apply_sparse_checkout(&o->result, ce, o)) {
1648 if (!o->show_all_errors)
1652 if (!ce_skip_worktree(ce))
1659 * Sparse checkout is meant to narrow down checkout area
1660 * but it does not make sense to narrow down to empty working
1661 * tree. This is usually a mistake in sparse checkout rules.
1662 * Do not allow users to do that.
1664 if (o->result.cache_nr && empty_worktree) {
1665 ret = unpack_failed(o, "Sparse checkout leaves no entry on working directory");
1670 ret = check_updates(o) ? (-2) : 0;
1672 move_index_extensions(&o->result, o->src_index);
1674 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
1675 cache_tree_verify(the_repository, &o->result);
1676 if (!o->result.cache_tree)
1677 o->result.cache_tree = cache_tree();
1678 if (!cache_tree_fully_valid(o->result.cache_tree))
1679 cache_tree_update(&o->result,
1684 o->result.updated_workdir = 1;
1685 discard_index(o->dst_index);
1686 *o->dst_index = o->result;
1688 discard_index(&o->result);
1690 o->src_index = NULL;
1693 trace_performance_leave("unpack_trees");
1694 if (!o->keep_pattern_list)
1695 clear_pattern_list(&pl);
1699 if (o->show_all_errors)
1700 display_error_msgs(o);
1701 mark_all_ce_unused(o->src_index);
1702 ret = unpack_failed(o, NULL);
1703 if (o->exiting_early)
1708 /* Here come the merge functions */
1710 static int reject_merge(const struct cache_entry *ce,
1711 struct unpack_trees_options *o)
1713 return add_rejected_path(o, ERROR_WOULD_OVERWRITE, ce->name);
1716 static int same(const struct cache_entry *a, const struct cache_entry *b)
1722 if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
1724 return a->ce_mode == b->ce_mode &&
1725 oideq(&a->oid, &b->oid);
1730 * When a CE gets turned into an unmerged entry, we
1731 * want it to be up-to-date
1733 static int verify_uptodate_1(const struct cache_entry *ce,
1734 struct unpack_trees_options *o,
1735 enum unpack_trees_error_types error_type)
1743 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1744 * if this entry is truly up-to-date because this file may be
1747 if ((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce))
1748 ; /* keep checking */
1749 else if (o->reset || ce_uptodate(ce))
1752 if (!lstat(ce->name, &st)) {
1753 int flags = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE;
1754 unsigned changed = ie_match_stat(o->src_index, ce, &st, flags);
1756 if (submodule_from_ce(ce)) {
1757 int r = check_submodule_move_head(ce,
1758 "HEAD", oid_to_hex(&ce->oid), o);
1760 return add_rejected_path(o, error_type, ce->name);
1767 * Historic default policy was to allow submodule to be out
1768 * of sync wrt the superproject index. If the submodule was
1769 * not considered interesting above, we don't care here.
1771 if (S_ISGITLINK(ce->ce_mode))
1776 if (errno == ENOENT)
1778 return add_rejected_path(o, error_type, ce->name);
1781 int verify_uptodate(const struct cache_entry *ce,
1782 struct unpack_trees_options *o)
1784 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1786 return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
1789 static int verify_uptodate_sparse(const struct cache_entry *ce,
1790 struct unpack_trees_options *o)
1792 return verify_uptodate_1(ce, o, ERROR_SPARSE_NOT_UPTODATE_FILE);
1796 * TODO: We should actually invalidate o->result, not src_index [1].
1797 * But since cache tree and untracked cache both are not copied to
1798 * o->result until unpacking is complete, we invalidate them on
1799 * src_index instead with the assumption that they will be copied to
1800 * dst_index at the end.
1802 * [1] src_index->cache_tree is also used in unpack_callback() so if
1803 * we invalidate o->result, we need to update it to use
1804 * o->result.cache_tree as well.
1806 static void invalidate_ce_path(const struct cache_entry *ce,
1807 struct unpack_trees_options *o)
1811 cache_tree_invalidate_path(o->src_index, ce->name);
1812 untracked_cache_invalidate_path(o->src_index, ce->name, 1);
1816 * Check that checking out ce->sha1 in subdir ce->name is not
1817 * going to overwrite any working files.
1819 static int verify_clean_submodule(const char *old_sha1,
1820 const struct cache_entry *ce,
1821 struct unpack_trees_options *o)
1823 if (!submodule_from_ce(ce))
1826 return check_submodule_move_head(ce, old_sha1,
1827 oid_to_hex(&ce->oid), o);
1830 static int verify_clean_subdirectory(const struct cache_entry *ce,
1831 struct unpack_trees_options *o)
1834 * we are about to extract "ce->name"; we would not want to lose
1835 * anything in the existing directory there.
1839 struct dir_struct d;
1843 if (S_ISGITLINK(ce->ce_mode)) {
1844 struct object_id oid;
1845 int sub_head = resolve_gitlink_ref(ce->name, "HEAD", &oid);
1847 * If we are not going to update the submodule, then
1850 if (!sub_head && oideq(&oid, &ce->oid))
1852 return verify_clean_submodule(sub_head ? NULL : oid_to_hex(&oid),
1857 * First let's make sure we do not have a local modification
1858 * in that directory.
1860 namelen = ce_namelen(ce);
1861 for (i = locate_in_src_index(ce, o);
1862 i < o->src_index->cache_nr;
1864 struct cache_entry *ce2 = o->src_index->cache[i];
1865 int len = ce_namelen(ce2);
1866 if (len < namelen ||
1867 strncmp(ce->name, ce2->name, namelen) ||
1868 ce2->name[namelen] != '/')
1871 * ce2->name is an entry in the subdirectory to be
1874 if (!ce_stage(ce2)) {
1875 if (verify_uptodate(ce2, o))
1877 add_entry(o, ce2, CE_REMOVE, 0);
1878 invalidate_ce_path(ce, o);
1879 mark_ce_used(ce2, o);
1885 * Then we need to make sure that we do not lose a locally
1886 * present file that is not ignored.
1888 pathbuf = xstrfmt("%.*s/", namelen, ce->name);
1890 memset(&d, 0, sizeof(d));
1892 d.exclude_per_dir = o->dir->exclude_per_dir;
1893 i = read_directory(&d, o->src_index, pathbuf, namelen+1, NULL);
1895 return add_rejected_path(o, ERROR_NOT_UPTODATE_DIR, ce->name);
1901 * This gets called when there was no index entry for the tree entry 'dst',
1902 * but we found a file in the working tree that 'lstat()' said was fine,
1903 * and we're on a case-insensitive filesystem.
1905 * See if we can find a case-insensitive match in the index that also
1906 * matches the stat information, and assume it's that other file!
1908 static int icase_exists(struct unpack_trees_options *o, const char *name, int len, struct stat *st)
1910 const struct cache_entry *src;
1912 src = index_file_exists(o->src_index, name, len, 1);
1913 return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
1916 static int check_ok_to_remove(const char *name, int len, int dtype,
1917 const struct cache_entry *ce, struct stat *st,
1918 enum unpack_trees_error_types error_type,
1919 struct unpack_trees_options *o)
1921 const struct cache_entry *result;
1924 * It may be that the 'lstat()' succeeded even though
1925 * target 'ce' was absent, because there is an old
1926 * entry that is different only in case..
1928 * Ignore that lstat() if it matches.
1930 if (ignore_case && icase_exists(o, name, len, st))
1934 is_excluded(o->dir, o->src_index, name, &dtype))
1936 * ce->name is explicitly excluded, so it is Ok to
1940 if (S_ISDIR(st->st_mode)) {
1942 * We are checking out path "foo" and
1943 * found "foo/." in the working tree.
1944 * This is tricky -- if we have modified
1945 * files that are in "foo/" we would lose
1948 if (verify_clean_subdirectory(ce, o) < 0)
1954 * The previous round may already have decided to
1955 * delete this path, which is in a subdirectory that
1956 * is being replaced with a blob.
1958 result = index_file_exists(&o->result, name, len, 0);
1960 if (result->ce_flags & CE_REMOVE)
1964 return add_rejected_path(o, error_type, name);
1968 * We do not want to remove or overwrite a working tree file that
1969 * is not tracked, unless it is ignored.
1971 static int verify_absent_1(const struct cache_entry *ce,
1972 enum unpack_trees_error_types error_type,
1973 struct unpack_trees_options *o)
1978 if (o->index_only || o->reset || !o->update)
1981 len = check_leading_path(ce->name, ce_namelen(ce));
1988 path = xmemdupz(ce->name, len);
1989 if (lstat(path, &st))
1990 ret = error_errno("cannot stat '%s'", path);
1992 if (submodule_from_ce(ce))
1993 ret = check_submodule_move_head(ce,
1994 oid_to_hex(&ce->oid),
1997 ret = check_ok_to_remove(path, len, DT_UNKNOWN, NULL,
1998 &st, error_type, o);
2002 } else if (lstat(ce->name, &st)) {
2003 if (errno != ENOENT)
2004 return error_errno("cannot stat '%s'", ce->name);
2007 if (submodule_from_ce(ce))
2008 return check_submodule_move_head(ce, oid_to_hex(&ce->oid),
2011 return check_ok_to_remove(ce->name, ce_namelen(ce),
2012 ce_to_dtype(ce), ce, &st,
2017 static int verify_absent(const struct cache_entry *ce,
2018 enum unpack_trees_error_types error_type,
2019 struct unpack_trees_options *o)
2021 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
2023 return verify_absent_1(ce, error_type, o);
2026 static int verify_absent_sparse(const struct cache_entry *ce,
2027 enum unpack_trees_error_types error_type,
2028 struct unpack_trees_options *o)
2030 enum unpack_trees_error_types orphaned_error = error_type;
2031 if (orphaned_error == ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN)
2032 orphaned_error = ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN;
2034 return verify_absent_1(ce, orphaned_error, o);
2037 static int merged_entry(const struct cache_entry *ce,
2038 const struct cache_entry *old,
2039 struct unpack_trees_options *o)
2041 int update = CE_UPDATE;
2042 struct cache_entry *merge = dup_cache_entry(ce, &o->result);
2046 * New index entries. In sparse checkout, the following
2047 * verify_absent() will be delayed until after
2048 * traverse_trees() finishes in unpack_trees(), then:
2050 * - CE_NEW_SKIP_WORKTREE will be computed correctly
2051 * - verify_absent() be called again, this time with
2052 * correct CE_NEW_SKIP_WORKTREE
2054 * verify_absent() call here does nothing in sparse
2055 * checkout (i.e. o->skip_sparse_checkout == 0)
2058 merge->ce_flags |= CE_NEW_SKIP_WORKTREE;
2060 if (verify_absent(merge,
2061 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
2062 discard_cache_entry(merge);
2065 invalidate_ce_path(merge, o);
2067 if (submodule_from_ce(ce) && file_exists(ce->name)) {
2068 int ret = check_submodule_move_head(ce, NULL,
2069 oid_to_hex(&ce->oid),
2075 } else if (!(old->ce_flags & CE_CONFLICTED)) {
2077 * See if we can re-use the old CE directly?
2078 * That way we get the uptodate stat info.
2080 * This also removes the UPDATE flag on a match; otherwise
2081 * we will end up overwriting local changes in the work tree.
2083 if (same(old, merge)) {
2084 copy_cache_entry(merge, old);
2087 if (verify_uptodate(old, o)) {
2088 discard_cache_entry(merge);
2091 /* Migrate old flags over */
2092 update |= old->ce_flags & (CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
2093 invalidate_ce_path(old, o);
2096 if (submodule_from_ce(ce) && file_exists(ce->name)) {
2097 int ret = check_submodule_move_head(ce, oid_to_hex(&old->oid),
2098 oid_to_hex(&ce->oid),
2105 * Previously unmerged entry left as an existence
2106 * marker by read_index_unmerged();
2108 invalidate_ce_path(old, o);
2111 if (do_add_entry(o, merge, update, CE_STAGEMASK) < 0)
2116 static int deleted_entry(const struct cache_entry *ce,
2117 const struct cache_entry *old,
2118 struct unpack_trees_options *o)
2120 /* Did it exist in the index? */
2122 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2126 if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
2128 add_entry(o, ce, CE_REMOVE, 0);
2129 invalidate_ce_path(ce, o);
2133 static int keep_entry(const struct cache_entry *ce,
2134 struct unpack_trees_options *o)
2136 add_entry(o, ce, 0, 0);
2138 invalidate_ce_path(ce, o);
2143 static void show_stage_entry(FILE *o,
2144 const char *label, const struct cache_entry *ce)
2147 fprintf(o, "%s (missing)\n", label);
2149 fprintf(o, "%s%06o %s %d\t%s\n",
2152 oid_to_hex(&ce->oid),
2158 int threeway_merge(const struct cache_entry * const *stages,
2159 struct unpack_trees_options *o)
2161 const struct cache_entry *index;
2162 const struct cache_entry *head;
2163 const struct cache_entry *remote = stages[o->head_idx + 1];
2166 int remote_match = 0;
2168 int df_conflict_head = 0;
2169 int df_conflict_remote = 0;
2171 int any_anc_missing = 0;
2172 int no_anc_exists = 1;
2175 for (i = 1; i < o->head_idx; i++) {
2176 if (!stages[i] || stages[i] == o->df_conflict_entry)
2177 any_anc_missing = 1;
2183 head = stages[o->head_idx];
2185 if (head == o->df_conflict_entry) {
2186 df_conflict_head = 1;
2190 if (remote == o->df_conflict_entry) {
2191 df_conflict_remote = 1;
2196 * First, if there's a #16 situation, note that to prevent #13
2199 if (!same(remote, head)) {
2200 for (i = 1; i < o->head_idx; i++) {
2201 if (same(stages[i], head)) {
2204 if (same(stages[i], remote)) {
2211 * We start with cases where the index is allowed to match
2212 * something other than the head: #14(ALT) and #2ALT, where it
2213 * is permitted to match the result instead.
2215 /* #14, #14ALT, #2ALT */
2216 if (remote && !df_conflict_head && head_match && !remote_match) {
2217 if (index && !same(index, remote) && !same(index, head))
2218 return reject_merge(index, o);
2219 return merged_entry(remote, index, o);
2222 * If we have an entry in the index cache, then we want to
2223 * make sure that it matches head.
2225 if (index && !same(index, head))
2226 return reject_merge(index, o);
2230 if (same(head, remote))
2231 return merged_entry(head, index, o);
2233 if (!df_conflict_remote && remote_match && !head_match)
2234 return merged_entry(head, index, o);
2238 if (!head && !remote && any_anc_missing)
2242 * Under the "aggressive" rule, we resolve mostly trivial
2243 * cases that we historically had git-merge-one-file resolve.
2245 if (o->aggressive) {
2246 int head_deleted = !head;
2247 int remote_deleted = !remote;
2248 const struct cache_entry *ce = NULL;
2257 for (i = 1; i < o->head_idx; i++) {
2258 if (stages[i] && stages[i] != o->df_conflict_entry) {
2267 * Deleted in one and unchanged in the other.
2269 if ((head_deleted && remote_deleted) ||
2270 (head_deleted && remote && remote_match) ||
2271 (remote_deleted && head && head_match)) {
2273 return deleted_entry(index, index, o);
2274 if (ce && !head_deleted) {
2275 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2281 * Added in both, identically.
2283 if (no_anc_exists && head && remote && same(head, remote))
2284 return merged_entry(head, index, o);
2288 /* Below are "no merge" cases, which require that the index be
2289 * up-to-date to avoid the files getting overwritten with
2290 * conflict resolution files.
2293 if (verify_uptodate(index, o))
2297 o->nontrivial_merge = 1;
2299 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2301 if (!head_match || !remote_match) {
2302 for (i = 1; i < o->head_idx; i++) {
2303 if (stages[i] && stages[i] != o->df_conflict_entry) {
2304 keep_entry(stages[i], o);
2312 fprintf(stderr, "read-tree: warning #16 detected\n");
2313 show_stage_entry(stderr, "head ", stages[head_match]);
2314 show_stage_entry(stderr, "remote ", stages[remote_match]);
2317 if (head) { count += keep_entry(head, o); }
2318 if (remote) { count += keep_entry(remote, o); }
2325 * The rule is to "carry forward" what is in the index without losing
2326 * information across a "fast-forward", favoring a successful merge
2327 * over a merge failure when it makes sense. For details of the
2328 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2331 int twoway_merge(const struct cache_entry * const *src,
2332 struct unpack_trees_options *o)
2334 const struct cache_entry *current = src[0];
2335 const struct cache_entry *oldtree = src[1];
2336 const struct cache_entry *newtree = src[2];
2338 if (o->merge_size != 2)
2339 return error("Cannot do a twoway merge of %d trees",
2342 if (oldtree == o->df_conflict_entry)
2344 if (newtree == o->df_conflict_entry)
2348 if (current->ce_flags & CE_CONFLICTED) {
2349 if (same(oldtree, newtree) || o->reset) {
2351 return deleted_entry(current, current, o);
2353 return merged_entry(newtree, current, o);
2355 return reject_merge(current, o);
2356 } else if ((!oldtree && !newtree) || /* 4 and 5 */
2357 (!oldtree && newtree &&
2358 same(current, newtree)) || /* 6 and 7 */
2359 (oldtree && newtree &&
2360 same(oldtree, newtree)) || /* 14 and 15 */
2361 (oldtree && newtree &&
2362 !same(oldtree, newtree) && /* 18 and 19 */
2363 same(current, newtree))) {
2364 return keep_entry(current, o);
2365 } else if (oldtree && !newtree && same(current, oldtree)) {
2367 return deleted_entry(oldtree, current, o);
2368 } else if (oldtree && newtree &&
2369 same(current, oldtree) && !same(current, newtree)) {
2371 return merged_entry(newtree, current, o);
2373 return reject_merge(current, o);
2376 if (oldtree && !o->initial_checkout) {
2378 * deletion of the path was staged;
2380 if (same(oldtree, newtree))
2382 return reject_merge(oldtree, o);
2384 return merged_entry(newtree, current, o);
2386 return deleted_entry(oldtree, current, o);
2392 * Keep the index entries at stage0, collapse stage1 but make sure
2393 * stage0 does not have anything there.
2395 int bind_merge(const struct cache_entry * const *src,
2396 struct unpack_trees_options *o)
2398 const struct cache_entry *old = src[0];
2399 const struct cache_entry *a = src[1];
2401 if (o->merge_size != 1)
2402 return error("Cannot do a bind merge of %d trees",
2405 return o->quiet ? -1 :
2406 error(ERRORMSG(o, ERROR_BIND_OVERLAP),
2407 super_prefixed(a->name),
2408 super_prefixed(old->name));
2410 return keep_entry(old, o);
2412 return merged_entry(a, NULL, o);
2419 * - take the stat information from stage0, take the data from stage1
2421 int oneway_merge(const struct cache_entry * const *src,
2422 struct unpack_trees_options *o)
2424 const struct cache_entry *old = src[0];
2425 const struct cache_entry *a = src[1];
2427 if (o->merge_size != 1)
2428 return error("Cannot do a oneway merge of %d trees",
2431 if (!a || a == o->df_conflict_entry)
2432 return deleted_entry(old, old, o);
2434 if (old && same(old, a)) {
2436 if (o->reset && o->update && !ce_uptodate(old) && !ce_skip_worktree(old) &&
2437 !(old->ce_flags & CE_FSMONITOR_VALID)) {
2439 if (lstat(old->name, &st) ||
2440 ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
2441 update |= CE_UPDATE;
2443 if (o->update && S_ISGITLINK(old->ce_mode) &&
2444 should_update_submodules() && !verify_uptodate(old, o))
2445 update |= CE_UPDATE;
2446 add_entry(o, old, update, CE_STAGEMASK);
2449 return merged_entry(a, old, o);