1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
3 #include "argv-array.h"
4 #include "repository.h"
9 #include "cache-tree.h"
10 #include "unpack-trees.h"
14 #include "split-index.h"
16 #include "submodule.h"
17 #include "submodule-config.h"
18 #include "fsmonitor.h"
19 #include "object-store.h"
20 #include "fetch-object.h"
23 * Error messages expected by scripts out of plumbing commands such as
24 * read-tree. Non-scripted Porcelain is not required to use these messages
25 * and in fact are encouraged to reword them to better suit their particular
26 * situation better. See how "git checkout" and "git merge" replaces
27 * them using setup_unpack_trees_porcelain(), for example.
29 static const char *unpack_plumbing_errors[NB_UNPACK_TREES_ERROR_TYPES] = {
30 /* ERROR_WOULD_OVERWRITE */
31 "Entry '%s' would be overwritten by merge. Cannot merge.",
33 /* ERROR_NOT_UPTODATE_FILE */
34 "Entry '%s' not uptodate. Cannot merge.",
36 /* ERROR_NOT_UPTODATE_DIR */
37 "Updating '%s' would lose untracked files in it",
39 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
40 "Untracked working tree file '%s' would be overwritten by merge.",
42 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
43 "Untracked working tree file '%s' would be removed by merge.",
45 /* ERROR_BIND_OVERLAP */
46 "Entry '%s' overlaps with '%s'. Cannot bind.",
48 /* ERROR_SPARSE_NOT_UPTODATE_FILE */
49 "Entry '%s' not uptodate. Cannot update sparse checkout.",
51 /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
52 "Working tree file '%s' would be overwritten by sparse checkout update.",
54 /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
55 "Working tree file '%s' would be removed by sparse checkout update.",
57 /* ERROR_WOULD_LOSE_SUBMODULE */
58 "Submodule '%s' cannot checkout new HEAD.",
61 #define ERRORMSG(o,type) \
62 ( ((o) && (o)->msgs[(type)]) \
63 ? ((o)->msgs[(type)]) \
64 : (unpack_plumbing_errors[(type)]) )
66 static const char *super_prefixed(const char *path)
69 * It is necessary and sufficient to have two static buffers
70 * here, as the return value of this function is fed to
71 * error() using the unpack_*_errors[] templates we see above.
73 static struct strbuf buf[2] = {STRBUF_INIT, STRBUF_INIT};
74 static int super_prefix_len = -1;
75 static unsigned idx = ARRAY_SIZE(buf) - 1;
77 if (super_prefix_len < 0) {
78 const char *super_prefix = get_super_prefix();
83 for (i = 0; i < ARRAY_SIZE(buf); i++)
84 strbuf_addstr(&buf[i], super_prefix);
85 super_prefix_len = buf[0].len;
89 if (!super_prefix_len)
92 if (++idx >= ARRAY_SIZE(buf))
95 strbuf_setlen(&buf[idx], super_prefix_len);
96 strbuf_addstr(&buf[idx], path);
101 void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
105 const char **msgs = opts->msgs;
108 argv_array_init(&opts->msgs_to_free);
110 if (!strcmp(cmd, "checkout"))
111 msg = advice_commit_before_merge
112 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
113 "Please commit your changes or stash them before you switch branches.")
114 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
115 else if (!strcmp(cmd, "merge"))
116 msg = advice_commit_before_merge
117 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
118 "Please commit your changes or stash them before you merge.")
119 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
121 msg = advice_commit_before_merge
122 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
123 "Please commit your changes or stash them before you %s.")
124 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
125 msgs[ERROR_WOULD_OVERWRITE] = msgs[ERROR_NOT_UPTODATE_FILE] =
126 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
128 msgs[ERROR_NOT_UPTODATE_DIR] =
129 _("Updating the following directories would lose untracked files in them:\n%s");
131 if (!strcmp(cmd, "checkout"))
132 msg = advice_commit_before_merge
133 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
134 "Please move or remove them before you switch branches.")
135 : _("The following untracked working tree files would be removed by checkout:\n%%s");
136 else if (!strcmp(cmd, "merge"))
137 msg = advice_commit_before_merge
138 ? _("The following untracked working tree files would be removed by merge:\n%%s"
139 "Please move or remove them before you merge.")
140 : _("The following untracked working tree files would be removed by merge:\n%%s");
142 msg = advice_commit_before_merge
143 ? _("The following untracked working tree files would be removed by %s:\n%%s"
144 "Please move or remove them before you %s.")
145 : _("The following untracked working tree files would be removed by %s:\n%%s");
146 msgs[ERROR_WOULD_LOSE_UNTRACKED_REMOVED] =
147 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
149 if (!strcmp(cmd, "checkout"))
150 msg = advice_commit_before_merge
151 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
152 "Please move or remove them before you switch branches.")
153 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
154 else if (!strcmp(cmd, "merge"))
155 msg = advice_commit_before_merge
156 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
157 "Please move or remove them before you merge.")
158 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
160 msg = advice_commit_before_merge
161 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
162 "Please move or remove them before you %s.")
163 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
164 msgs[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN] =
165 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
168 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
169 * cannot easily display it as a list.
171 msgs[ERROR_BIND_OVERLAP] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
173 msgs[ERROR_SPARSE_NOT_UPTODATE_FILE] =
174 _("Cannot update sparse checkout: the following entries are not up to date:\n%s");
175 msgs[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN] =
176 _("The following working tree files would be overwritten by sparse checkout update:\n%s");
177 msgs[ERROR_WOULD_LOSE_ORPHANED_REMOVED] =
178 _("The following working tree files would be removed by sparse checkout update:\n%s");
179 msgs[ERROR_WOULD_LOSE_SUBMODULE] =
180 _("Cannot update submodule:\n%s");
182 opts->show_all_errors = 1;
183 /* rejected paths may not have a static buffer */
184 for (i = 0; i < ARRAY_SIZE(opts->unpack_rejects); i++)
185 opts->unpack_rejects[i].strdup_strings = 1;
188 void clear_unpack_trees_porcelain(struct unpack_trees_options *opts)
190 argv_array_clear(&opts->msgs_to_free);
191 memset(opts->msgs, 0, sizeof(opts->msgs));
194 static int do_add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
195 unsigned int set, unsigned int clear)
202 ce->ce_flags = (ce->ce_flags & ~clear) | set;
203 return add_index_entry(&o->result, ce,
204 ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
207 static void add_entry(struct unpack_trees_options *o,
208 const struct cache_entry *ce,
209 unsigned int set, unsigned int clear)
211 do_add_entry(o, dup_cache_entry(ce, &o->result), set, clear);
215 * add error messages on path <path>
216 * corresponding to the type <e> with the message <msg>
217 * indicating if it should be display in porcelain or not
219 static int add_rejected_path(struct unpack_trees_options *o,
220 enum unpack_trees_error_types e,
223 if (!o->show_all_errors)
224 return error(ERRORMSG(o, e), super_prefixed(path));
227 * Otherwise, insert in a list for future display by
228 * display_error_msgs()
230 string_list_append(&o->unpack_rejects[e], path);
235 * display all the error messages stored in a nice way
237 static void display_error_msgs(struct unpack_trees_options *o)
240 int something_displayed = 0;
241 for (e = 0; e < NB_UNPACK_TREES_ERROR_TYPES; e++) {
242 struct string_list *rejects = &o->unpack_rejects[e];
243 if (rejects->nr > 0) {
244 struct strbuf path = STRBUF_INIT;
245 something_displayed = 1;
246 for (i = 0; i < rejects->nr; i++)
247 strbuf_addf(&path, "\t%s\n", rejects->items[i].string);
248 error(ERRORMSG(o, e), super_prefixed(path.buf));
249 strbuf_release(&path);
251 string_list_clear(rejects, 0);
253 if (something_displayed)
254 fprintf(stderr, _("Aborting\n"));
257 static int check_submodule_move_head(const struct cache_entry *ce,
260 struct unpack_trees_options *o)
262 unsigned flags = SUBMODULE_MOVE_HEAD_DRY_RUN;
263 const struct submodule *sub = submodule_from_ce(ce);
269 flags |= SUBMODULE_MOVE_HEAD_FORCE;
271 if (submodule_move_head(ce->name, old_id, new_id, flags))
272 return o->gently ? -1 :
273 add_rejected_path(o, ERROR_WOULD_LOSE_SUBMODULE, ce->name);
278 * Preform 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 * differnt 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);
295 } else if (state && (ce->ce_flags & CE_UPDATE)) {
296 submodule_free(the_repository);
297 checkout_entry(ce, state, NULL);
298 repo_read_gitmodules(the_repository);
304 * Unlink the last component and schedule the leading directories for
305 * removal, such that empty directories get removed.
307 static void unlink_entry(const struct cache_entry *ce)
309 const struct submodule *sub = submodule_from_ce(ce);
311 /* state.force is set at the caller. */
312 submodule_move_head(ce->name, "HEAD", NULL,
313 SUBMODULE_MOVE_HEAD_FORCE);
315 if (!check_leading_path(ce->name, ce_namelen(ce)))
317 if (remove_or_warn(ce->ce_mode, ce->name))
319 schedule_dir_for_removal(ce->name, ce_namelen(ce));
322 static struct progress *get_progress(struct unpack_trees_options *o)
324 unsigned cnt = 0, total = 0;
325 struct index_state *index = &o->result;
327 if (!o->update || !o->verbose_update)
330 for (; cnt < index->cache_nr; cnt++) {
331 const struct cache_entry *ce = index->cache[cnt];
332 if (ce->ce_flags & (CE_UPDATE | CE_WT_REMOVE))
336 return start_delayed_progress(_("Checking out files"), total);
339 static int check_updates(struct unpack_trees_options *o)
343 struct progress *progress = NULL;
344 struct index_state *index = &o->result;
345 struct checkout state = CHECKOUT_INIT;
348 trace_performance_enter();
351 state.refresh_cache = 1;
352 state.istate = index;
354 progress = get_progress(o);
357 git_attr_set_direction(GIT_ATTR_CHECKOUT, index);
359 if (should_update_submodules() && o->update && !o->dry_run)
360 load_gitmodules_file(index, NULL);
362 for (i = 0; i < index->cache_nr; i++) {
363 const struct cache_entry *ce = index->cache[i];
365 if (ce->ce_flags & CE_WT_REMOVE) {
366 display_progress(progress, ++cnt);
367 if (o->update && !o->dry_run)
371 remove_marked_cache_entries(index);
372 remove_scheduled_dirs();
374 if (should_update_submodules() && o->update && !o->dry_run)
375 load_gitmodules_file(index, &state);
377 enable_delayed_checkout(&state);
378 if (repository_format_partial_clone && o->update && !o->dry_run) {
380 * Prefetch the objects that are to be checked out in the loop
383 struct oid_array to_fetch = OID_ARRAY_INIT;
384 int fetch_if_missing_store = fetch_if_missing;
385 fetch_if_missing = 0;
386 for (i = 0; i < index->cache_nr; i++) {
387 struct cache_entry *ce = index->cache[i];
388 if ((ce->ce_flags & CE_UPDATE) &&
389 !S_ISGITLINK(ce->ce_mode)) {
390 if (!has_object_file(&ce->oid))
391 oid_array_append(&to_fetch, &ce->oid);
395 fetch_objects(repository_format_partial_clone,
397 fetch_if_missing = fetch_if_missing_store;
398 oid_array_clear(&to_fetch);
400 for (i = 0; i < index->cache_nr; i++) {
401 struct cache_entry *ce = index->cache[i];
403 if (ce->ce_flags & CE_UPDATE) {
404 if (ce->ce_flags & CE_WT_REMOVE)
405 BUG("both update and delete flags are set on %s",
407 display_progress(progress, ++cnt);
408 ce->ce_flags &= ~CE_UPDATE;
409 if (o->update && !o->dry_run) {
410 errs |= checkout_entry(ce, &state, NULL);
414 stop_progress(&progress);
415 errs |= finish_delayed_checkout(&state);
417 git_attr_set_direction(GIT_ATTR_CHECKIN, NULL);
418 trace_performance_leave("check_updates");
422 static int verify_uptodate_sparse(const struct cache_entry *ce,
423 struct unpack_trees_options *o);
424 static int verify_absent_sparse(const struct cache_entry *ce,
425 enum unpack_trees_error_types,
426 struct unpack_trees_options *o);
428 static int apply_sparse_checkout(struct index_state *istate,
429 struct cache_entry *ce,
430 struct unpack_trees_options *o)
432 int was_skip_worktree = ce_skip_worktree(ce);
434 if (ce->ce_flags & CE_NEW_SKIP_WORKTREE)
435 ce->ce_flags |= CE_SKIP_WORKTREE;
437 ce->ce_flags &= ~CE_SKIP_WORKTREE;
438 if (was_skip_worktree != ce_skip_worktree(ce)) {
439 ce->ce_flags |= CE_UPDATE_IN_BASE;
440 mark_fsmonitor_invalid(istate, ce);
441 istate->cache_changed |= CE_ENTRY_CHANGED;
445 * if (!was_skip_worktree && !ce_skip_worktree()) {
446 * This is perfectly normal. Move on;
451 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
452 * area as a result of ce_skip_worktree() shortcuts in
453 * verify_absent() and verify_uptodate().
454 * Make sure they don't modify worktree if they are already
455 * outside checkout area
457 if (was_skip_worktree && ce_skip_worktree(ce)) {
458 ce->ce_flags &= ~CE_UPDATE;
461 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
462 * on to get that file removed from both index and worktree.
463 * If that file is already outside worktree area, don't
466 if (ce->ce_flags & CE_REMOVE)
467 ce->ce_flags &= ~CE_WT_REMOVE;
470 if (!was_skip_worktree && ce_skip_worktree(ce)) {
472 * If CE_UPDATE is set, verify_uptodate() must be called already
473 * also stat info may have lost after merged_entry() so calling
474 * verify_uptodate() again may fail
476 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
478 ce->ce_flags |= CE_WT_REMOVE;
479 ce->ce_flags &= ~CE_UPDATE;
481 if (was_skip_worktree && !ce_skip_worktree(ce)) {
482 if (verify_absent_sparse(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
484 ce->ce_flags |= CE_UPDATE;
489 static inline int call_unpack_fn(const struct cache_entry * const *src,
490 struct unpack_trees_options *o)
492 int ret = o->fn(src, o);
498 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
500 ce->ce_flags |= CE_UNPACKED;
502 if (o->cache_bottom < o->src_index->cache_nr &&
503 o->src_index->cache[o->cache_bottom] == ce) {
504 int bottom = o->cache_bottom;
505 while (bottom < o->src_index->cache_nr &&
506 o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
508 o->cache_bottom = bottom;
512 static void mark_all_ce_unused(struct index_state *index)
515 for (i = 0; i < index->cache_nr; i++)
516 index->cache[i]->ce_flags &= ~(CE_UNPACKED | CE_ADDED | CE_NEW_SKIP_WORKTREE);
519 static int locate_in_src_index(const struct cache_entry *ce,
520 struct unpack_trees_options *o)
522 struct index_state *index = o->src_index;
523 int len = ce_namelen(ce);
524 int pos = index_name_pos(index, ce->name, len);
531 * We call unpack_index_entry() with an unmerged cache entry
532 * only in diff-index, and it wants a single callback. Skip
533 * the other unmerged entry with the same name.
535 static void mark_ce_used_same_name(struct cache_entry *ce,
536 struct unpack_trees_options *o)
538 struct index_state *index = o->src_index;
539 int len = ce_namelen(ce);
542 for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
543 struct cache_entry *next = index->cache[pos];
544 if (len != ce_namelen(next) ||
545 memcmp(ce->name, next->name, len))
547 mark_ce_used(next, o);
551 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o)
553 const struct index_state *index = o->src_index;
554 int pos = o->cache_bottom;
556 while (pos < index->cache_nr) {
557 struct cache_entry *ce = index->cache[pos];
558 if (!(ce->ce_flags & CE_UNPACKED))
565 static void add_same_unmerged(const struct cache_entry *ce,
566 struct unpack_trees_options *o)
568 struct index_state *index = o->src_index;
569 int len = ce_namelen(ce);
570 int pos = index_name_pos(index, ce->name, len);
573 die("programming error in a caller of mark_ce_used_same_name");
574 for (pos = -pos - 1; pos < index->cache_nr; pos++) {
575 struct cache_entry *next = index->cache[pos];
576 if (len != ce_namelen(next) ||
577 memcmp(ce->name, next->name, len))
579 add_entry(o, next, 0, 0);
580 mark_ce_used(next, o);
584 static int unpack_index_entry(struct cache_entry *ce,
585 struct unpack_trees_options *o)
587 const struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
594 if (o->skip_unmerged) {
595 add_entry(o, ce, 0, 0);
599 ret = call_unpack_fn(src, o);
601 mark_ce_used_same_name(ce, o);
605 static int find_cache_pos(struct traverse_info *, const struct name_entry *);
607 static void restore_cache_bottom(struct traverse_info *info, int bottom)
609 struct unpack_trees_options *o = info->data;
611 if (o->diff_index_cached)
613 o->cache_bottom = bottom;
616 static int switch_cache_bottom(struct traverse_info *info)
618 struct unpack_trees_options *o = info->data;
621 if (o->diff_index_cached)
623 ret = o->cache_bottom;
624 pos = find_cache_pos(info->prev, &info->name);
627 o->cache_bottom = -2 - pos;
629 o->cache_bottom = o->src_index->cache_nr;
633 static inline int are_same_oid(struct name_entry *name_j, struct name_entry *name_k)
635 return name_j->oid && name_k->oid && !oidcmp(name_j->oid, name_k->oid);
638 static int all_trees_same_as_cache_tree(int n, unsigned long dirmask,
639 struct name_entry *names,
640 struct traverse_info *info)
642 struct unpack_trees_options *o = info->data;
645 if (!o->merge || dirmask != ((1 << n) - 1))
648 for (i = 1; i < n; i++)
649 if (!are_same_oid(names, names + i))
652 return cache_tree_matches_traversal(o->src_index->cache_tree, names, info);
655 static int index_pos_by_traverse_info(struct name_entry *names,
656 struct traverse_info *info)
658 struct unpack_trees_options *o = info->data;
659 int len = traverse_path_len(info, names);
660 char *name = xmalloc(len + 1 /* slash */ + 1 /* NUL */);
663 make_traverse_path(name, info, names);
666 pos = index_name_pos(o->src_index, name, len);
668 BUG("This is a directory and should not exist in index");
670 if (!starts_with(o->src_index->cache[pos]->name, name) ||
671 (pos > 0 && starts_with(o->src_index->cache[pos-1]->name, name)))
672 BUG("pos must point at the first entry in this directory");
678 * Fast path if we detect that all trees are the same as cache-tree at this
679 * path. We'll walk these trees recursively using cache-tree/index instead of
680 * ODB since already know what these trees contain.
682 static int traverse_by_cache_tree(int pos, int nr_entries, int nr_names,
683 struct name_entry *names,
684 struct traverse_info *info)
686 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
687 struct unpack_trees_options *o = info->data;
691 BUG("We need cache-tree to do this optimization");
694 * Do what unpack_callback() and unpack_nondirectories() normally
695 * do. But we walk all paths in an iterative loop instead.
697 * D/F conflicts and higher stage entries are not a concern
698 * because cache-tree would be invalidated and we would never
699 * get here in the first place.
701 for (i = 0; i < nr_entries; i++) {
702 struct cache_entry *tree_ce;
705 src[0] = o->src_index->cache[pos + i];
707 len = ce_namelen(src[0]);
708 tree_ce = xcalloc(1, cache_entry_size(len));
710 tree_ce->ce_mode = src[0]->ce_mode;
711 tree_ce->ce_flags = create_ce_flags(0);
712 tree_ce->ce_namelen = len;
713 oidcpy(&tree_ce->oid, &src[0]->oid);
714 memcpy(tree_ce->name, src[0]->name, len + 1);
716 for (d = 1; d <= nr_names; d++)
719 rc = call_unpack_fn((const struct cache_entry * const *)src, o);
724 mark_ce_used(src[0], o);
727 printf("Unpacked %d entries from %s to %s using cache-tree\n",
729 o->src_index->cache[pos]->name,
730 o->src_index->cache[pos + nr_entries - 1]->name);
734 static int traverse_trees_recursive(int n, unsigned long dirmask,
735 unsigned long df_conflicts,
736 struct name_entry *names,
737 struct traverse_info *info)
741 struct tree_desc t[MAX_UNPACK_TREES];
742 void *buf[MAX_UNPACK_TREES];
743 struct traverse_info newinfo;
744 struct name_entry *p;
747 nr_entries = all_trees_same_as_cache_tree(n, dirmask, names, info);
748 if (nr_entries > 0) {
749 struct unpack_trees_options *o = info->data;
750 int pos = index_pos_by_traverse_info(names, info);
752 if (!o->merge || df_conflicts)
753 BUG("Wrong condition to get here buddy");
756 * All entries up to 'pos' must have been processed
757 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
758 * save and restore cache_bottom anyway to not miss
759 * unprocessed entries before 'pos'.
761 bottom = o->cache_bottom;
762 ret = traverse_by_cache_tree(pos, nr_entries, n, names, info);
763 o->cache_bottom = bottom;
773 newinfo.pathspec = info->pathspec;
775 newinfo.pathlen += tree_entry_len(p) + 1;
776 newinfo.df_conflicts |= df_conflicts;
779 * Fetch the tree from the ODB for each peer directory in the
782 * For 2- and 3-way traversals, we try to avoid hitting the
783 * ODB twice for the same OID. This should yield a nice speed
784 * up in checkouts and merges when the commits are similar.
786 * We don't bother doing the full O(n^2) search for larger n,
787 * because wider traversals don't happen that often and we
788 * avoid the search setup.
790 * When 2 peer OIDs are the same, we just copy the tree
791 * descriptor data. This implicitly borrows the buffer
792 * data from the earlier cell.
794 for (i = 0; i < n; i++, dirmask >>= 1) {
795 if (i > 0 && are_same_oid(&names[i], &names[i - 1]))
797 else if (i > 1 && are_same_oid(&names[i], &names[i - 2]))
800 const struct object_id *oid = NULL;
803 buf[nr_buf++] = fill_tree_descriptor(t + i, oid);
807 bottom = switch_cache_bottom(&newinfo);
808 ret = traverse_trees(n, t, &newinfo);
809 restore_cache_bottom(&newinfo, bottom);
811 for (i = 0; i < nr_buf; i++)
818 * Compare the traverse-path to the cache entry without actually
819 * having to generate the textual representation of the traverse
822 * NOTE! This *only* compares up to the size of the traverse path
823 * itself - the caller needs to do the final check for the cache
824 * entry having more data at the end!
826 static int do_compare_entry_piecewise(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
828 int len, pathlen, ce_len;
832 int cmp = do_compare_entry_piecewise(ce, info->prev,
837 pathlen = info->pathlen;
838 ce_len = ce_namelen(ce);
840 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
841 if (ce_len < pathlen)
845 ce_name = ce->name + pathlen;
847 len = tree_entry_len(n);
848 return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
851 static int do_compare_entry(const struct cache_entry *ce,
852 const struct traverse_info *info,
853 const struct name_entry *n)
855 int len, pathlen, ce_len;
860 * If we have not precomputed the traverse path, it is quicker
861 * to avoid doing so. But if we have precomputed it,
862 * it is quicker to use the precomputed version.
864 if (!info->traverse_path)
865 return do_compare_entry_piecewise(ce, info, n);
867 cmp = strncmp(ce->name, info->traverse_path, info->pathlen);
871 pathlen = info->pathlen;
872 ce_len = ce_namelen(ce);
874 if (ce_len < pathlen)
878 ce_name = ce->name + pathlen;
880 len = tree_entry_len(n);
881 return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
884 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
886 int cmp = do_compare_entry(ce, info, n);
891 * Even if the beginning compared identically, the ce should
892 * compare as bigger than a directory leading up to it!
894 return ce_namelen(ce) > traverse_path_len(info, n);
897 static int ce_in_traverse_path(const struct cache_entry *ce,
898 const struct traverse_info *info)
902 if (do_compare_entry(ce, info->prev, &info->name))
905 * If ce (blob) is the same name as the path (which is a tree
906 * we will be descending into), it won't be inside it.
908 return (info->pathlen < ce_namelen(ce));
911 static struct cache_entry *create_ce_entry(const struct traverse_info *info,
912 const struct name_entry *n,
914 struct index_state *istate,
917 int len = traverse_path_len(info, n);
918 struct cache_entry *ce =
920 make_empty_transient_cache_entry(len) :
921 make_empty_cache_entry(istate, len);
923 ce->ce_mode = create_ce_mode(n->mode);
924 ce->ce_flags = create_ce_flags(stage);
925 ce->ce_namelen = len;
926 oidcpy(&ce->oid, n->oid);
927 make_traverse_path(ce->name, info, n);
933 * Note that traverse_by_cache_tree() duplicates some logic in this function
934 * without actually calling it. If you change the logic here you may need to
935 * check and change there as well.
937 static int unpack_nondirectories(int n, unsigned long mask,
938 unsigned long dirmask,
939 struct cache_entry **src,
940 const struct name_entry *names,
941 const struct traverse_info *info)
944 struct unpack_trees_options *o = info->data;
945 unsigned long conflicts = info->df_conflicts | dirmask;
947 /* Do we have *only* directories? Nothing to do */
948 if (mask == dirmask && !src[0])
952 * Ok, we've filled in up to any potential index entry in src[0],
955 for (i = 0; i < n; i++) {
957 unsigned int bit = 1ul << i;
958 if (conflicts & bit) {
959 src[i + o->merge] = o->df_conflict_entry;
966 else if (i + 1 < o->head_idx)
968 else if (i + 1 > o->head_idx)
974 * If the merge bit is set, then the cache entries are
975 * discarded in the following block. In this case,
976 * construct "transient" cache_entries, as they are
977 * not stored in the index. otherwise construct the
978 * cache entry from the index aware logic.
980 src[i + o->merge] = create_ce_entry(info, names + i, stage, &o->result, o->merge);
984 int rc = call_unpack_fn((const struct cache_entry * const *)src,
986 for (i = 0; i < n; i++) {
987 struct cache_entry *ce = src[i + o->merge];
988 if (ce != o->df_conflict_entry)
989 discard_cache_entry(ce);
994 for (i = 0; i < n; i++)
995 if (src[i] && src[i] != o->df_conflict_entry)
996 if (do_add_entry(o, src[i], 0, 0))
1002 static int unpack_failed(struct unpack_trees_options *o, const char *message)
1004 discard_index(&o->result);
1005 if (!o->gently && !o->exiting_early) {
1007 return error("%s", message);
1014 * The tree traversal is looking at name p. If we have a matching entry,
1015 * return it. If name p is a directory in the index, do not return
1016 * anything, as we will want to match it when the traversal descends into
1019 static int find_cache_pos(struct traverse_info *info,
1020 const struct name_entry *p)
1023 struct unpack_trees_options *o = info->data;
1024 struct index_state *index = o->src_index;
1025 int pfxlen = info->pathlen;
1026 int p_len = tree_entry_len(p);
1028 for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
1029 const struct cache_entry *ce = index->cache[pos];
1030 const char *ce_name, *ce_slash;
1033 if (ce->ce_flags & CE_UNPACKED) {
1035 * cache_bottom entry is already unpacked, so
1036 * we can never match it; don't check it
1039 if (pos == o->cache_bottom)
1043 if (!ce_in_traverse_path(ce, info)) {
1045 * Check if we can skip future cache checks
1046 * (because we're already past all possible
1047 * entries in the traverse path).
1049 if (info->traverse_path) {
1050 if (strncmp(ce->name, info->traverse_path,
1056 ce_name = ce->name + pfxlen;
1057 ce_slash = strchr(ce_name, '/');
1059 ce_len = ce_slash - ce_name;
1061 ce_len = ce_namelen(ce) - pfxlen;
1062 cmp = name_compare(p->path, p_len, ce_name, ce_len);
1064 * Exact match; if we have a directory we need to
1065 * delay returning it.
1068 return ce_slash ? -2 - pos : pos;
1070 continue; /* keep looking */
1072 * ce_name sorts after p->path; could it be that we
1073 * have files under p->path directory in the index?
1074 * E.g. ce_name == "t-i", and p->path == "t"; we may
1075 * have "t/a" in the index.
1077 if (p_len < ce_len && !memcmp(ce_name, p->path, p_len) &&
1078 ce_name[p_len] < '/')
1079 continue; /* keep looking */
1085 static struct cache_entry *find_cache_entry(struct traverse_info *info,
1086 const struct name_entry *p)
1088 int pos = find_cache_pos(info, p);
1089 struct unpack_trees_options *o = info->data;
1092 return o->src_index->cache[pos];
1097 static void debug_path(struct traverse_info *info)
1100 debug_path(info->prev);
1101 if (*info->prev->name.path)
1104 printf("%s", info->name.path);
1107 static void debug_name_entry(int i, struct name_entry *n)
1109 printf("ent#%d %06o %s\n", i,
1110 n->path ? n->mode : 0,
1111 n->path ? n->path : "(missing)");
1114 static void debug_unpack_callback(int n,
1116 unsigned long dirmask,
1117 struct name_entry *names,
1118 struct traverse_info *info)
1121 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1125 for (i = 0; i < n; i++)
1126 debug_name_entry(i, names + i);
1130 * Note that traverse_by_cache_tree() duplicates some logic in this function
1131 * without actually calling it. If you change the logic here you may need to
1132 * check and change there as well.
1134 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
1136 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
1137 struct unpack_trees_options *o = info->data;
1138 const struct name_entry *p = names;
1140 /* Find first entry with a real name (we could use "mask" too) */
1144 if (o->debug_unpack)
1145 debug_unpack_callback(n, mask, dirmask, names, info);
1147 /* Are we supposed to look at the index too? */
1151 struct cache_entry *ce;
1153 if (o->diff_index_cached)
1154 ce = next_cache_entry(o);
1156 ce = find_cache_entry(info, p);
1160 cmp = compare_entry(ce, info, p);
1162 if (unpack_index_entry(ce, o) < 0)
1163 return unpack_failed(o, NULL);
1169 * If we skip unmerged index
1170 * entries, we'll skip this
1171 * entry *and* the tree
1172 * entries associated with it!
1174 if (o->skip_unmerged) {
1175 add_same_unmerged(ce, o);
1185 if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
1188 if (o->merge && src[0]) {
1189 if (ce_stage(src[0]))
1190 mark_ce_used_same_name(src[0], o);
1192 mark_ce_used(src[0], o);
1195 /* Now handle any directories.. */
1197 /* special case: "diff-index --cached" looking at a tree */
1198 if (o->diff_index_cached &&
1199 n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
1201 matches = cache_tree_matches_traversal(o->src_index->cache_tree,
1204 * Everything under the name matches; skip the
1205 * entire hierarchy. diff_index_cached codepath
1206 * special cases D/F conflicts in such a way that
1207 * it does not do any look-ahead, so this is safe.
1210 o->cache_bottom += matches;
1215 if (traverse_trees_recursive(n, dirmask, mask & ~dirmask,
1224 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1225 struct strbuf *prefix,
1226 int select_mask, int clear_mask,
1227 struct exclude_list *el, int defval);
1229 /* Whole directory matching */
1230 static int clear_ce_flags_dir(struct cache_entry **cache, int nr,
1231 struct strbuf *prefix,
1233 int select_mask, int clear_mask,
1234 struct exclude_list *el, int defval)
1236 struct cache_entry **cache_end;
1238 int ret = is_excluded_from_list(prefix->buf, prefix->len,
1239 basename, &dtype, el, &the_index);
1242 strbuf_addch(prefix, '/');
1244 /* If undecided, use matching result of parent dir in defval */
1248 for (cache_end = cache; cache_end != cache + nr; cache_end++) {
1249 struct cache_entry *ce = *cache_end;
1250 if (strncmp(ce->name, prefix->buf, prefix->len))
1255 * TODO: check el, if there are no patterns that may conflict
1256 * with ret (iow, we know in advance the incl/excl
1257 * decision for the entire directory), clear flag here without
1258 * calling clear_ce_flags_1(). That function will call
1259 * the expensive is_excluded_from_list() on every entry.
1261 rc = clear_ce_flags_1(cache, cache_end - cache,
1263 select_mask, clear_mask,
1265 strbuf_setlen(prefix, prefix->len - 1);
1270 * Traverse the index, find every entry that matches according to
1271 * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
1272 * number of traversed entries.
1274 * If select_mask is non-zero, only entries whose ce_flags has on of
1275 * those bits enabled are traversed.
1277 * cache : pointer to an index entry
1278 * prefix_len : an offset to its path
1280 * The current path ("prefix") including the trailing '/' is
1281 * cache[0]->name[0..(prefix_len-1)]
1282 * Top level path has prefix_len zero.
1284 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1285 struct strbuf *prefix,
1286 int select_mask, int clear_mask,
1287 struct exclude_list *el, int defval)
1289 struct cache_entry **cache_end = cache + nr;
1292 * Process all entries that have the given prefix and meet
1293 * select_mask condition
1295 while(cache != cache_end) {
1296 struct cache_entry *ce = *cache;
1297 const char *name, *slash;
1298 int len, dtype, ret;
1300 if (select_mask && !(ce->ce_flags & select_mask)) {
1305 if (prefix->len && strncmp(ce->name, prefix->buf, prefix->len))
1308 name = ce->name + prefix->len;
1309 slash = strchr(name, '/');
1311 /* If it's a directory, try whole directory match first */
1316 strbuf_add(prefix, name, len);
1318 processed = clear_ce_flags_dir(cache, cache_end - cache,
1320 prefix->buf + prefix->len - len,
1321 select_mask, clear_mask,
1324 /* clear_c_f_dir eats a whole dir already? */
1327 strbuf_setlen(prefix, prefix->len - len);
1331 strbuf_addch(prefix, '/');
1332 cache += clear_ce_flags_1(cache, cache_end - cache,
1334 select_mask, clear_mask, el, defval);
1335 strbuf_setlen(prefix, prefix->len - len - 1);
1340 dtype = ce_to_dtype(ce);
1341 ret = is_excluded_from_list(ce->name, ce_namelen(ce),
1342 name, &dtype, el, &the_index);
1346 ce->ce_flags &= ~clear_mask;
1349 return nr - (cache_end - cache);
1352 static int clear_ce_flags(struct cache_entry **cache, int nr,
1353 int select_mask, int clear_mask,
1354 struct exclude_list *el)
1356 static struct strbuf prefix = STRBUF_INIT;
1358 strbuf_reset(&prefix);
1360 return clear_ce_flags_1(cache, nr,
1362 select_mask, clear_mask,
1367 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1369 static void mark_new_skip_worktree(struct exclude_list *el,
1370 struct index_state *the_index,
1371 int select_flag, int skip_wt_flag)
1376 * 1. Pretend the narrowest worktree: only unmerged entries
1379 for (i = 0; i < the_index->cache_nr; i++) {
1380 struct cache_entry *ce = the_index->cache[i];
1382 if (select_flag && !(ce->ce_flags & select_flag))
1385 if (!ce_stage(ce) && !(ce->ce_flags & CE_CONFLICTED))
1386 ce->ce_flags |= skip_wt_flag;
1388 ce->ce_flags &= ~skip_wt_flag;
1392 * 2. Widen worktree according to sparse-checkout file.
1393 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1395 clear_ce_flags(the_index->cache, the_index->cache_nr,
1396 select_flag, skip_wt_flag, el);
1399 static int verify_absent(const struct cache_entry *,
1400 enum unpack_trees_error_types,
1401 struct unpack_trees_options *);
1403 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1404 * resulting index, -2 on failure to reflect the changes to the work tree.
1406 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1408 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
1411 static struct cache_entry *dfc;
1412 struct exclude_list el;
1414 if (len > MAX_UNPACK_TREES)
1415 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
1417 trace_performance_enter();
1418 memset(&el, 0, sizeof(el));
1419 if (!core_apply_sparse_checkout || !o->update)
1420 o->skip_sparse_checkout = 1;
1421 if (!o->skip_sparse_checkout) {
1422 char *sparse = git_pathdup("info/sparse-checkout");
1423 if (add_excludes_from_file_to_list(sparse, "", 0, &el, NULL) < 0)
1424 o->skip_sparse_checkout = 1;
1430 memset(&o->result, 0, sizeof(o->result));
1431 o->result.initialized = 1;
1432 o->result.timestamp.sec = o->src_index->timestamp.sec;
1433 o->result.timestamp.nsec = o->src_index->timestamp.nsec;
1434 o->result.version = o->src_index->version;
1435 if (!o->src_index->split_index) {
1436 o->result.split_index = NULL;
1437 } else if (o->src_index == o->dst_index) {
1439 * o->dst_index (and thus o->src_index) will be discarded
1440 * and overwritten with o->result at the end of this function,
1441 * so just use src_index's split_index to avoid having to
1444 o->result.split_index = o->src_index->split_index;
1445 o->result.split_index->refcount++;
1447 o->result.split_index = init_split_index(&o->result);
1449 oidcpy(&o->result.oid, &o->src_index->oid);
1450 o->merge_size = len;
1451 mark_all_ce_unused(o->src_index);
1454 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1456 if (!o->skip_sparse_checkout)
1457 mark_new_skip_worktree(o->el, o->src_index, 0, CE_NEW_SKIP_WORKTREE);
1460 dfc = xcalloc(1, cache_entry_size(0));
1461 o->df_conflict_entry = dfc;
1464 const char *prefix = o->prefix ? o->prefix : "";
1465 struct traverse_info info;
1467 setup_traverse_info(&info, prefix);
1468 info.fn = unpack_callback;
1470 info.show_all_errors = o->show_all_errors;
1471 info.pathspec = o->pathspec;
1475 * Unpack existing index entries that sort before the
1476 * prefix the tree is spliced into. Note that o->merge
1477 * is always true in this case.
1480 struct cache_entry *ce = next_cache_entry(o);
1483 if (ce_in_traverse_path(ce, &info))
1485 if (unpack_index_entry(ce, o) < 0)
1490 trace_performance_enter();
1491 ret = traverse_trees(len, t, &info);
1492 trace_performance_leave("traverse_trees");
1497 /* Any left-over entries in the index? */
1500 struct cache_entry *ce = next_cache_entry(o);
1503 if (unpack_index_entry(ce, o) < 0)
1507 mark_all_ce_unused(o->src_index);
1509 if (o->trivial_merges_only && o->nontrivial_merge) {
1510 ret = unpack_failed(o, "Merge requires file-level merging");
1514 if (!o->skip_sparse_checkout) {
1515 int empty_worktree = 1;
1518 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1519 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1520 * so apply_sparse_checkout() won't attempt to remove it from worktree
1522 mark_new_skip_worktree(o->el, &o->result, CE_ADDED, CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1525 for (i = 0; i < o->result.cache_nr; i++) {
1526 struct cache_entry *ce = o->result.cache[i];
1529 * Entries marked with CE_ADDED in merged_entry() do not have
1530 * verify_absent() check (the check is effectively disabled
1531 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1533 * Do the real check now because we have had
1534 * correct CE_NEW_SKIP_WORKTREE
1536 if (ce->ce_flags & CE_ADDED &&
1537 verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1538 if (!o->show_all_errors)
1543 if (apply_sparse_checkout(&o->result, ce, o)) {
1544 if (!o->show_all_errors)
1548 if (!ce_skip_worktree(ce))
1555 * Sparse checkout is meant to narrow down checkout area
1556 * but it does not make sense to narrow down to empty working
1557 * tree. This is usually a mistake in sparse checkout rules.
1558 * Do not allow users to do that.
1560 if (o->result.cache_nr && empty_worktree) {
1561 ret = unpack_failed(o, "Sparse checkout leaves no entry on working directory");
1566 ret = check_updates(o) ? (-2) : 0;
1569 if (!o->result.cache_tree)
1570 o->result.cache_tree = cache_tree();
1571 if (!cache_tree_fully_valid(o->result.cache_tree))
1572 cache_tree_update(&o->result,
1576 move_index_extensions(&o->result, o->src_index);
1577 discard_index(o->dst_index);
1578 *o->dst_index = o->result;
1580 discard_index(&o->result);
1582 o->src_index = NULL;
1585 trace_performance_leave("unpack_trees");
1586 clear_exclude_list(&el);
1590 if (o->show_all_errors)
1591 display_error_msgs(o);
1592 mark_all_ce_unused(o->src_index);
1593 ret = unpack_failed(o, NULL);
1594 if (o->exiting_early)
1599 /* Here come the merge functions */
1601 static int reject_merge(const struct cache_entry *ce,
1602 struct unpack_trees_options *o)
1604 return o->gently ? -1 :
1605 add_rejected_path(o, ERROR_WOULD_OVERWRITE, ce->name);
1608 static int same(const struct cache_entry *a, const struct cache_entry *b)
1614 if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
1616 return a->ce_mode == b->ce_mode &&
1617 !oidcmp(&a->oid, &b->oid);
1622 * When a CE gets turned into an unmerged entry, we
1623 * want it to be up-to-date
1625 static int verify_uptodate_1(const struct cache_entry *ce,
1626 struct unpack_trees_options *o,
1627 enum unpack_trees_error_types error_type)
1635 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1636 * if this entry is truly up-to-date because this file may be
1639 if ((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce))
1640 ; /* keep checking */
1641 else if (o->reset || ce_uptodate(ce))
1644 if (!lstat(ce->name, &st)) {
1645 int flags = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE;
1646 unsigned changed = ie_match_stat(o->src_index, ce, &st, flags);
1648 if (submodule_from_ce(ce)) {
1649 int r = check_submodule_move_head(ce,
1650 "HEAD", oid_to_hex(&ce->oid), o);
1652 return o->gently ? -1 :
1653 add_rejected_path(o, error_type, ce->name);
1660 * Historic default policy was to allow submodule to be out
1661 * of sync wrt the superproject index. If the submodule was
1662 * not considered interesting above, we don't care here.
1664 if (S_ISGITLINK(ce->ce_mode))
1669 if (errno == ENOENT)
1671 return o->gently ? -1 :
1672 add_rejected_path(o, error_type, ce->name);
1675 int verify_uptodate(const struct cache_entry *ce,
1676 struct unpack_trees_options *o)
1678 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1680 return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
1683 static int verify_uptodate_sparse(const struct cache_entry *ce,
1684 struct unpack_trees_options *o)
1686 return verify_uptodate_1(ce, o, ERROR_SPARSE_NOT_UPTODATE_FILE);
1689 static void invalidate_ce_path(const struct cache_entry *ce,
1690 struct unpack_trees_options *o)
1694 cache_tree_invalidate_path(o->src_index, ce->name);
1695 untracked_cache_invalidate_path(o->src_index, ce->name, 1);
1699 * Check that checking out ce->sha1 in subdir ce->name is not
1700 * going to overwrite any working files.
1702 * Currently, git does not checkout subprojects during a superproject
1703 * checkout, so it is not going to overwrite anything.
1705 static int verify_clean_submodule(const char *old_sha1,
1706 const struct cache_entry *ce,
1707 enum unpack_trees_error_types error_type,
1708 struct unpack_trees_options *o)
1710 if (!submodule_from_ce(ce))
1713 return check_submodule_move_head(ce, old_sha1,
1714 oid_to_hex(&ce->oid), o);
1717 static int verify_clean_subdirectory(const struct cache_entry *ce,
1718 enum unpack_trees_error_types error_type,
1719 struct unpack_trees_options *o)
1722 * we are about to extract "ce->name"; we would not want to lose
1723 * anything in the existing directory there.
1727 struct dir_struct d;
1731 if (S_ISGITLINK(ce->ce_mode)) {
1732 struct object_id oid;
1733 int sub_head = resolve_gitlink_ref(ce->name, "HEAD", &oid);
1735 * If we are not going to update the submodule, then
1738 if (!sub_head && !oidcmp(&oid, &ce->oid))
1740 return verify_clean_submodule(sub_head ? NULL : oid_to_hex(&oid),
1745 * First let's make sure we do not have a local modification
1746 * in that directory.
1748 namelen = ce_namelen(ce);
1749 for (i = locate_in_src_index(ce, o);
1750 i < o->src_index->cache_nr;
1752 struct cache_entry *ce2 = o->src_index->cache[i];
1753 int len = ce_namelen(ce2);
1754 if (len < namelen ||
1755 strncmp(ce->name, ce2->name, namelen) ||
1756 ce2->name[namelen] != '/')
1759 * ce2->name is an entry in the subdirectory to be
1762 if (!ce_stage(ce2)) {
1763 if (verify_uptodate(ce2, o))
1765 add_entry(o, ce2, CE_REMOVE, 0);
1766 mark_ce_used(ce2, o);
1772 * Then we need to make sure that we do not lose a locally
1773 * present file that is not ignored.
1775 pathbuf = xstrfmt("%.*s/", namelen, ce->name);
1777 memset(&d, 0, sizeof(d));
1779 d.exclude_per_dir = o->dir->exclude_per_dir;
1780 i = read_directory(&d, &the_index, pathbuf, namelen+1, NULL);
1782 return o->gently ? -1 :
1783 add_rejected_path(o, ERROR_NOT_UPTODATE_DIR, ce->name);
1789 * This gets called when there was no index entry for the tree entry 'dst',
1790 * but we found a file in the working tree that 'lstat()' said was fine,
1791 * and we're on a case-insensitive filesystem.
1793 * See if we can find a case-insensitive match in the index that also
1794 * matches the stat information, and assume it's that other file!
1796 static int icase_exists(struct unpack_trees_options *o, const char *name, int len, struct stat *st)
1798 const struct cache_entry *src;
1800 src = index_file_exists(o->src_index, name, len, 1);
1801 return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
1804 static int check_ok_to_remove(const char *name, int len, int dtype,
1805 const struct cache_entry *ce, struct stat *st,
1806 enum unpack_trees_error_types error_type,
1807 struct unpack_trees_options *o)
1809 const struct cache_entry *result;
1812 * It may be that the 'lstat()' succeeded even though
1813 * target 'ce' was absent, because there is an old
1814 * entry that is different only in case..
1816 * Ignore that lstat() if it matches.
1818 if (ignore_case && icase_exists(o, name, len, st))
1822 is_excluded(o->dir, &the_index, name, &dtype))
1824 * ce->name is explicitly excluded, so it is Ok to
1828 if (S_ISDIR(st->st_mode)) {
1830 * We are checking out path "foo" and
1831 * found "foo/." in the working tree.
1832 * This is tricky -- if we have modified
1833 * files that are in "foo/" we would lose
1836 if (verify_clean_subdirectory(ce, error_type, o) < 0)
1842 * The previous round may already have decided to
1843 * delete this path, which is in a subdirectory that
1844 * is being replaced with a blob.
1846 result = index_file_exists(&o->result, name, len, 0);
1848 if (result->ce_flags & CE_REMOVE)
1852 return o->gently ? -1 :
1853 add_rejected_path(o, error_type, name);
1857 * We do not want to remove or overwrite a working tree file that
1858 * is not tracked, unless it is ignored.
1860 static int verify_absent_1(const struct cache_entry *ce,
1861 enum unpack_trees_error_types error_type,
1862 struct unpack_trees_options *o)
1867 if (o->index_only || o->reset || !o->update)
1870 len = check_leading_path(ce->name, ce_namelen(ce));
1877 path = xmemdupz(ce->name, len);
1878 if (lstat(path, &st))
1879 ret = error_errno("cannot stat '%s'", path);
1881 if (submodule_from_ce(ce))
1882 ret = check_submodule_move_head(ce,
1883 oid_to_hex(&ce->oid),
1886 ret = check_ok_to_remove(path, len, DT_UNKNOWN, NULL,
1887 &st, error_type, o);
1891 } else if (lstat(ce->name, &st)) {
1892 if (errno != ENOENT)
1893 return error_errno("cannot stat '%s'", ce->name);
1896 if (submodule_from_ce(ce))
1897 return check_submodule_move_head(ce, oid_to_hex(&ce->oid),
1900 return check_ok_to_remove(ce->name, ce_namelen(ce),
1901 ce_to_dtype(ce), ce, &st,
1906 static int verify_absent(const struct cache_entry *ce,
1907 enum unpack_trees_error_types error_type,
1908 struct unpack_trees_options *o)
1910 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1912 return verify_absent_1(ce, error_type, o);
1915 static int verify_absent_sparse(const struct cache_entry *ce,
1916 enum unpack_trees_error_types error_type,
1917 struct unpack_trees_options *o)
1919 enum unpack_trees_error_types orphaned_error = error_type;
1920 if (orphaned_error == ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN)
1921 orphaned_error = ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN;
1923 return verify_absent_1(ce, orphaned_error, o);
1926 static int merged_entry(const struct cache_entry *ce,
1927 const struct cache_entry *old,
1928 struct unpack_trees_options *o)
1930 int update = CE_UPDATE;
1931 struct cache_entry *merge = dup_cache_entry(ce, &o->result);
1935 * New index entries. In sparse checkout, the following
1936 * verify_absent() will be delayed until after
1937 * traverse_trees() finishes in unpack_trees(), then:
1939 * - CE_NEW_SKIP_WORKTREE will be computed correctly
1940 * - verify_absent() be called again, this time with
1941 * correct CE_NEW_SKIP_WORKTREE
1943 * verify_absent() call here does nothing in sparse
1944 * checkout (i.e. o->skip_sparse_checkout == 0)
1947 merge->ce_flags |= CE_NEW_SKIP_WORKTREE;
1949 if (verify_absent(merge,
1950 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1951 discard_cache_entry(merge);
1954 invalidate_ce_path(merge, o);
1956 if (submodule_from_ce(ce)) {
1957 int ret = check_submodule_move_head(ce, NULL,
1958 oid_to_hex(&ce->oid),
1964 } else if (!(old->ce_flags & CE_CONFLICTED)) {
1966 * See if we can re-use the old CE directly?
1967 * That way we get the uptodate stat info.
1969 * This also removes the UPDATE flag on a match; otherwise
1970 * we will end up overwriting local changes in the work tree.
1972 if (same(old, merge)) {
1973 copy_cache_entry(merge, old);
1976 if (verify_uptodate(old, o)) {
1977 discard_cache_entry(merge);
1980 /* Migrate old flags over */
1981 update |= old->ce_flags & (CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1982 invalidate_ce_path(old, o);
1985 if (submodule_from_ce(ce)) {
1986 int ret = check_submodule_move_head(ce, oid_to_hex(&old->oid),
1987 oid_to_hex(&ce->oid),
1994 * Previously unmerged entry left as an existence
1995 * marker by read_index_unmerged();
1997 invalidate_ce_path(old, o);
2000 do_add_entry(o, merge, update, CE_STAGEMASK);
2004 static int deleted_entry(const struct cache_entry *ce,
2005 const struct cache_entry *old,
2006 struct unpack_trees_options *o)
2008 /* Did it exist in the index? */
2010 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2014 if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
2016 add_entry(o, ce, CE_REMOVE, 0);
2017 invalidate_ce_path(ce, o);
2021 static int keep_entry(const struct cache_entry *ce,
2022 struct unpack_trees_options *o)
2024 add_entry(o, ce, 0, 0);
2029 static void show_stage_entry(FILE *o,
2030 const char *label, const struct cache_entry *ce)
2033 fprintf(o, "%s (missing)\n", label);
2035 fprintf(o, "%s%06o %s %d\t%s\n",
2038 oid_to_hex(&ce->oid),
2044 int threeway_merge(const struct cache_entry * const *stages,
2045 struct unpack_trees_options *o)
2047 const struct cache_entry *index;
2048 const struct cache_entry *head;
2049 const struct cache_entry *remote = stages[o->head_idx + 1];
2052 int remote_match = 0;
2054 int df_conflict_head = 0;
2055 int df_conflict_remote = 0;
2057 int any_anc_missing = 0;
2058 int no_anc_exists = 1;
2061 for (i = 1; i < o->head_idx; i++) {
2062 if (!stages[i] || stages[i] == o->df_conflict_entry)
2063 any_anc_missing = 1;
2069 head = stages[o->head_idx];
2071 if (head == o->df_conflict_entry) {
2072 df_conflict_head = 1;
2076 if (remote == o->df_conflict_entry) {
2077 df_conflict_remote = 1;
2082 * First, if there's a #16 situation, note that to prevent #13
2085 if (!same(remote, head)) {
2086 for (i = 1; i < o->head_idx; i++) {
2087 if (same(stages[i], head)) {
2090 if (same(stages[i], remote)) {
2097 * We start with cases where the index is allowed to match
2098 * something other than the head: #14(ALT) and #2ALT, where it
2099 * is permitted to match the result instead.
2101 /* #14, #14ALT, #2ALT */
2102 if (remote && !df_conflict_head && head_match && !remote_match) {
2103 if (index && !same(index, remote) && !same(index, head))
2104 return reject_merge(index, o);
2105 return merged_entry(remote, index, o);
2108 * If we have an entry in the index cache, then we want to
2109 * make sure that it matches head.
2111 if (index && !same(index, head))
2112 return reject_merge(index, o);
2116 if (same(head, remote))
2117 return merged_entry(head, index, o);
2119 if (!df_conflict_remote && remote_match && !head_match)
2120 return merged_entry(head, index, o);
2124 if (!head && !remote && any_anc_missing)
2128 * Under the "aggressive" rule, we resolve mostly trivial
2129 * cases that we historically had git-merge-one-file resolve.
2131 if (o->aggressive) {
2132 int head_deleted = !head;
2133 int remote_deleted = !remote;
2134 const struct cache_entry *ce = NULL;
2143 for (i = 1; i < o->head_idx; i++) {
2144 if (stages[i] && stages[i] != o->df_conflict_entry) {
2153 * Deleted in one and unchanged in the other.
2155 if ((head_deleted && remote_deleted) ||
2156 (head_deleted && remote && remote_match) ||
2157 (remote_deleted && head && head_match)) {
2159 return deleted_entry(index, index, o);
2160 if (ce && !head_deleted) {
2161 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2167 * Added in both, identically.
2169 if (no_anc_exists && head && remote && same(head, remote))
2170 return merged_entry(head, index, o);
2174 /* Below are "no merge" cases, which require that the index be
2175 * up-to-date to avoid the files getting overwritten with
2176 * conflict resolution files.
2179 if (verify_uptodate(index, o))
2183 o->nontrivial_merge = 1;
2185 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2187 if (!head_match || !remote_match) {
2188 for (i = 1; i < o->head_idx; i++) {
2189 if (stages[i] && stages[i] != o->df_conflict_entry) {
2190 keep_entry(stages[i], o);
2198 fprintf(stderr, "read-tree: warning #16 detected\n");
2199 show_stage_entry(stderr, "head ", stages[head_match]);
2200 show_stage_entry(stderr, "remote ", stages[remote_match]);
2203 if (head) { count += keep_entry(head, o); }
2204 if (remote) { count += keep_entry(remote, o); }
2211 * The rule is to "carry forward" what is in the index without losing
2212 * information across a "fast-forward", favoring a successful merge
2213 * over a merge failure when it makes sense. For details of the
2214 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2217 int twoway_merge(const struct cache_entry * const *src,
2218 struct unpack_trees_options *o)
2220 const struct cache_entry *current = src[0];
2221 const struct cache_entry *oldtree = src[1];
2222 const struct cache_entry *newtree = src[2];
2224 if (o->merge_size != 2)
2225 return error("Cannot do a twoway merge of %d trees",
2228 if (oldtree == o->df_conflict_entry)
2230 if (newtree == o->df_conflict_entry)
2234 if (current->ce_flags & CE_CONFLICTED) {
2235 if (same(oldtree, newtree) || o->reset) {
2237 return deleted_entry(current, current, o);
2239 return merged_entry(newtree, current, o);
2241 return reject_merge(current, o);
2242 } else if ((!oldtree && !newtree) || /* 4 and 5 */
2243 (!oldtree && newtree &&
2244 same(current, newtree)) || /* 6 and 7 */
2245 (oldtree && newtree &&
2246 same(oldtree, newtree)) || /* 14 and 15 */
2247 (oldtree && newtree &&
2248 !same(oldtree, newtree) && /* 18 and 19 */
2249 same(current, newtree))) {
2250 return keep_entry(current, o);
2251 } else if (oldtree && !newtree && same(current, oldtree)) {
2253 return deleted_entry(oldtree, current, o);
2254 } else if (oldtree && newtree &&
2255 same(current, oldtree) && !same(current, newtree)) {
2257 return merged_entry(newtree, current, o);
2259 return reject_merge(current, o);
2262 if (oldtree && !o->initial_checkout) {
2264 * deletion of the path was staged;
2266 if (same(oldtree, newtree))
2268 return reject_merge(oldtree, o);
2270 return merged_entry(newtree, current, o);
2272 return deleted_entry(oldtree, current, o);
2278 * Keep the index entries at stage0, collapse stage1 but make sure
2279 * stage0 does not have anything there.
2281 int bind_merge(const struct cache_entry * const *src,
2282 struct unpack_trees_options *o)
2284 const struct cache_entry *old = src[0];
2285 const struct cache_entry *a = src[1];
2287 if (o->merge_size != 1)
2288 return error("Cannot do a bind merge of %d trees",
2291 return o->gently ? -1 :
2292 error(ERRORMSG(o, ERROR_BIND_OVERLAP),
2293 super_prefixed(a->name),
2294 super_prefixed(old->name));
2296 return keep_entry(old, o);
2298 return merged_entry(a, NULL, o);
2305 * - take the stat information from stage0, take the data from stage1
2307 int oneway_merge(const struct cache_entry * const *src,
2308 struct unpack_trees_options *o)
2310 const struct cache_entry *old = src[0];
2311 const struct cache_entry *a = src[1];
2313 if (o->merge_size != 1)
2314 return error("Cannot do a oneway merge of %d trees",
2317 if (!a || a == o->df_conflict_entry)
2318 return deleted_entry(old, old, o);
2320 if (old && same(old, a)) {
2322 if (o->reset && o->update && !ce_uptodate(old) && !ce_skip_worktree(old)) {
2324 if (lstat(old->name, &st) ||
2325 ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
2326 update |= CE_UPDATE;
2328 if (o->update && S_ISGITLINK(old->ce_mode) &&
2329 should_update_submodules() && !verify_uptodate(old, o))
2330 update |= CE_UPDATE;
2331 add_entry(o, old, update, 0);
2334 return merged_entry(a, old, o);