Git 2.35.8
[git.git] / unpack-trees.c
blob360844bda3ab976c73e9443b318b58dfc400f475
1 #include "cache.h"
2 #include "strvec.h"
3 #include "repository.h"
4 #include "config.h"
5 #include "dir.h"
6 #include "tree.h"
7 #include "tree-walk.h"
8 #include "cache-tree.h"
9 #include "unpack-trees.h"
10 #include "progress.h"
11 #include "refs.h"
12 #include "attr.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"
19 #include "entry.h"
20 #include "parallel-checkout.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_WARNING_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_CWD_IN_THE_WAY */
40 "Refusing to remove '%s' since it is the current working directory.",
42 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
43 "Untracked working tree file '%s' would be overwritten by merge.",
45 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
46 "Untracked working tree file '%s' would be removed by merge.",
48 /* ERROR_BIND_OVERLAP */
49 "Entry '%s' overlaps with '%s'. Cannot bind.",
51 /* ERROR_WOULD_LOSE_SUBMODULE */
52 "Submodule '%s' cannot checkout new HEAD.",
54 /* NB_UNPACK_TREES_ERROR_TYPES; just a meta value */
55 "",
57 /* WARNING_SPARSE_NOT_UPTODATE_FILE */
58 "Path '%s' not uptodate; will not remove from working tree.",
60 /* WARNING_SPARSE_UNMERGED_FILE */
61 "Path '%s' unmerged; will not remove from working tree.",
63 /* WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN */
64 "Path '%s' already present; will not overwrite with sparse update.",
67 #define ERRORMSG(o,type) \
68 ( ((o) && (o)->msgs[(type)]) \
69 ? ((o)->msgs[(type)]) \
70 : (unpack_plumbing_errors[(type)]) )
72 static const char *super_prefixed(const char *path)
75 * It is necessary and sufficient to have two static buffers
76 * here, as the return value of this function is fed to
77 * error() using the unpack_*_errors[] templates we see above.
79 static struct strbuf buf[2] = {STRBUF_INIT, STRBUF_INIT};
80 static int super_prefix_len = -1;
81 static unsigned idx = ARRAY_SIZE(buf) - 1;
83 if (super_prefix_len < 0) {
84 const char *super_prefix = get_super_prefix();
85 if (!super_prefix) {
86 super_prefix_len = 0;
87 } else {
88 int i;
89 for (i = 0; i < ARRAY_SIZE(buf); i++)
90 strbuf_addstr(&buf[i], super_prefix);
91 super_prefix_len = buf[0].len;
95 if (!super_prefix_len)
96 return path;
98 if (++idx >= ARRAY_SIZE(buf))
99 idx = 0;
101 strbuf_setlen(&buf[idx], super_prefix_len);
102 strbuf_addstr(&buf[idx], path);
104 return buf[idx].buf;
107 void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
108 const char *cmd)
110 int i;
111 const char **msgs = opts->msgs;
112 const char *msg;
114 strvec_init(&opts->msgs_to_free);
116 if (!strcmp(cmd, "checkout"))
117 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
118 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
119 "Please commit your changes or stash them before you switch branches.")
120 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
121 else if (!strcmp(cmd, "merge"))
122 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
123 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
124 "Please commit your changes or stash them before you merge.")
125 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
126 else
127 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
128 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
129 "Please commit your changes or stash them before you %s.")
130 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
131 msgs[ERROR_WOULD_OVERWRITE] = msgs[ERROR_NOT_UPTODATE_FILE] =
132 strvec_pushf(&opts->msgs_to_free, msg, cmd, cmd);
134 msgs[ERROR_NOT_UPTODATE_DIR] =
135 _("Updating the following directories would lose untracked files in them:\n%s");
137 msgs[ERROR_CWD_IN_THE_WAY] =
138 _("Refusing to remove the current working directory:\n%s");
140 if (!strcmp(cmd, "checkout"))
141 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
142 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
143 "Please move or remove them before you switch branches.")
144 : _("The following untracked working tree files would be removed by checkout:\n%%s");
145 else if (!strcmp(cmd, "merge"))
146 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
147 ? _("The following untracked working tree files would be removed by merge:\n%%s"
148 "Please move or remove them before you merge.")
149 : _("The following untracked working tree files would be removed by merge:\n%%s");
150 else
151 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
152 ? _("The following untracked working tree files would be removed by %s:\n%%s"
153 "Please move or remove them before you %s.")
154 : _("The following untracked working tree files would be removed by %s:\n%%s");
155 msgs[ERROR_WOULD_LOSE_UNTRACKED_REMOVED] =
156 strvec_pushf(&opts->msgs_to_free, msg, cmd, cmd);
158 if (!strcmp(cmd, "checkout"))
159 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
160 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
161 "Please move or remove them before you switch branches.")
162 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
163 else if (!strcmp(cmd, "merge"))
164 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
165 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
166 "Please move or remove them before you merge.")
167 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
168 else
169 msg = advice_enabled(ADVICE_COMMIT_BEFORE_MERGE)
170 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
171 "Please move or remove them before you %s.")
172 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
173 msgs[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN] =
174 strvec_pushf(&opts->msgs_to_free, msg, cmd, cmd);
177 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
178 * cannot easily display it as a list.
180 msgs[ERROR_BIND_OVERLAP] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
182 msgs[ERROR_WOULD_LOSE_SUBMODULE] =
183 _("Cannot update submodule:\n%s");
185 msgs[WARNING_SPARSE_NOT_UPTODATE_FILE] =
186 _("The following paths are not up to date and were left despite sparse patterns:\n%s");
187 msgs[WARNING_SPARSE_UNMERGED_FILE] =
188 _("The following paths are unmerged and were left despite sparse patterns:\n%s");
189 msgs[WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN] =
190 _("The following paths were already present and thus not updated despite sparse patterns:\n%s");
192 opts->show_all_errors = 1;
193 /* rejected paths may not have a static buffer */
194 for (i = 0; i < ARRAY_SIZE(opts->unpack_rejects); i++)
195 opts->unpack_rejects[i].strdup_strings = 1;
198 void clear_unpack_trees_porcelain(struct unpack_trees_options *opts)
200 strvec_clear(&opts->msgs_to_free);
201 memset(opts->msgs, 0, sizeof(opts->msgs));
204 static int do_add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
205 unsigned int set, unsigned int clear)
207 clear |= CE_HASHED;
209 if (set & CE_REMOVE)
210 set |= CE_WT_REMOVE;
212 ce->ce_flags = (ce->ce_flags & ~clear) | set;
213 return add_index_entry(&o->result, ce,
214 ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
217 static void add_entry(struct unpack_trees_options *o,
218 const struct cache_entry *ce,
219 unsigned int set, unsigned int clear)
221 do_add_entry(o, dup_cache_entry(ce, &o->result), set, clear);
225 * add error messages on path <path>
226 * corresponding to the type <e> with the message <msg>
227 * indicating if it should be display in porcelain or not
229 static int add_rejected_path(struct unpack_trees_options *o,
230 enum unpack_trees_error_types e,
231 const char *path)
233 if (o->quiet)
234 return -1;
236 if (!o->show_all_errors)
237 return error(ERRORMSG(o, e), super_prefixed(path));
240 * Otherwise, insert in a list for future display by
241 * display_(error|warning)_msgs()
243 string_list_append(&o->unpack_rejects[e], path);
244 return -1;
248 * display all the error messages stored in a nice way
250 static void display_error_msgs(struct unpack_trees_options *o)
252 int e;
253 unsigned error_displayed = 0;
254 for (e = 0; e < NB_UNPACK_TREES_ERROR_TYPES; e++) {
255 struct string_list *rejects = &o->unpack_rejects[e];
257 if (rejects->nr > 0) {
258 int i;
259 struct strbuf path = STRBUF_INIT;
261 error_displayed = 1;
262 for (i = 0; i < rejects->nr; i++)
263 strbuf_addf(&path, "\t%s\n", rejects->items[i].string);
264 error(ERRORMSG(o, e), super_prefixed(path.buf));
265 strbuf_release(&path);
267 string_list_clear(rejects, 0);
269 if (error_displayed)
270 fprintf(stderr, _("Aborting\n"));
274 * display all the warning messages stored in a nice way
276 static void display_warning_msgs(struct unpack_trees_options *o)
278 int e;
279 unsigned warning_displayed = 0;
280 for (e = NB_UNPACK_TREES_ERROR_TYPES + 1;
281 e < NB_UNPACK_TREES_WARNING_TYPES; e++) {
282 struct string_list *rejects = &o->unpack_rejects[e];
284 if (rejects->nr > 0) {
285 int i;
286 struct strbuf path = STRBUF_INIT;
288 warning_displayed = 1;
289 for (i = 0; i < rejects->nr; i++)
290 strbuf_addf(&path, "\t%s\n", rejects->items[i].string);
291 warning(ERRORMSG(o, e), super_prefixed(path.buf));
292 strbuf_release(&path);
294 string_list_clear(rejects, 0);
296 if (warning_displayed)
297 fprintf(stderr, _("After fixing the above paths, you may want to run `git sparse-checkout reapply`.\n"));
299 static int check_submodule_move_head(const struct cache_entry *ce,
300 const char *old_id,
301 const char *new_id,
302 struct unpack_trees_options *o)
304 unsigned flags = SUBMODULE_MOVE_HEAD_DRY_RUN;
305 const struct submodule *sub = submodule_from_ce(ce);
307 if (!sub)
308 return 0;
310 if (o->reset)
311 flags |= SUBMODULE_MOVE_HEAD_FORCE;
313 if (submodule_move_head(ce->name, old_id, new_id, flags))
314 return add_rejected_path(o, ERROR_WOULD_LOSE_SUBMODULE, ce->name);
315 return 0;
319 * Perform the loading of the repository's gitmodules file. This function is
320 * used by 'check_update()' to perform loading of the gitmodules file in two
321 * different situations:
322 * (1) before removing entries from the working tree if the gitmodules file has
323 * been marked for removal. This situation is specified by 'state' == NULL.
324 * (2) before checking out entries to the working tree if the gitmodules file
325 * has been marked for update. This situation is specified by 'state' != NULL.
327 static void load_gitmodules_file(struct index_state *index,
328 struct checkout *state)
330 int pos = index_name_pos(index, GITMODULES_FILE, strlen(GITMODULES_FILE));
332 if (pos >= 0) {
333 struct cache_entry *ce = index->cache[pos];
334 if (!state && ce->ce_flags & CE_WT_REMOVE) {
335 repo_read_gitmodules(the_repository, 0);
336 } else if (state && (ce->ce_flags & CE_UPDATE)) {
337 submodule_free(the_repository);
338 checkout_entry(ce, state, NULL, NULL);
339 repo_read_gitmodules(the_repository, 0);
344 static struct progress *get_progress(struct unpack_trees_options *o,
345 struct index_state *index)
347 unsigned cnt = 0, total = 0;
349 if (!o->update || !o->verbose_update)
350 return NULL;
352 for (; cnt < index->cache_nr; cnt++) {
353 const struct cache_entry *ce = index->cache[cnt];
354 if (ce->ce_flags & (CE_UPDATE | CE_WT_REMOVE))
355 total++;
358 return start_delayed_progress(_("Updating files"), total);
361 static void setup_collided_checkout_detection(struct checkout *state,
362 struct index_state *index)
364 int i;
366 state->clone = 1;
367 for (i = 0; i < index->cache_nr; i++)
368 index->cache[i]->ce_flags &= ~CE_MATCHED;
371 static void report_collided_checkout(struct index_state *index)
373 struct string_list list = STRING_LIST_INIT_NODUP;
374 int i;
376 for (i = 0; i < index->cache_nr; i++) {
377 struct cache_entry *ce = index->cache[i];
379 if (!(ce->ce_flags & CE_MATCHED))
380 continue;
382 string_list_append(&list, ce->name);
383 ce->ce_flags &= ~CE_MATCHED;
386 list.cmp = fspathcmp;
387 string_list_sort(&list);
389 if (list.nr) {
390 warning(_("the following paths have collided (e.g. case-sensitive paths\n"
391 "on a case-insensitive filesystem) and only one from the same\n"
392 "colliding group is in the working tree:\n"));
394 for (i = 0; i < list.nr; i++)
395 fprintf(stderr, " '%s'\n", list.items[i].string);
398 string_list_clear(&list, 0);
401 static int must_checkout(const struct cache_entry *ce)
403 return ce->ce_flags & CE_UPDATE;
406 static int check_updates(struct unpack_trees_options *o,
407 struct index_state *index)
409 unsigned cnt = 0;
410 int errs = 0;
411 struct progress *progress;
412 struct checkout state = CHECKOUT_INIT;
413 int i, pc_workers, pc_threshold;
415 trace_performance_enter();
416 state.force = 1;
417 state.quiet = 1;
418 state.refresh_cache = 1;
419 state.istate = index;
420 clone_checkout_metadata(&state.meta, &o->meta, NULL);
422 if (!o->update || o->dry_run) {
423 remove_marked_cache_entries(index, 0);
424 trace_performance_leave("check_updates");
425 return 0;
428 if (o->clone)
429 setup_collided_checkout_detection(&state, index);
431 progress = get_progress(o, index);
433 /* Start with clean cache to avoid using any possibly outdated info. */
434 invalidate_lstat_cache();
436 git_attr_set_direction(GIT_ATTR_CHECKOUT);
438 if (should_update_submodules())
439 load_gitmodules_file(index, NULL);
441 for (i = 0; i < index->cache_nr; i++) {
442 const struct cache_entry *ce = index->cache[i];
444 if (ce->ce_flags & CE_WT_REMOVE) {
445 display_progress(progress, ++cnt);
446 unlink_entry(ce);
450 remove_marked_cache_entries(index, 0);
451 remove_scheduled_dirs();
453 if (should_update_submodules())
454 load_gitmodules_file(index, &state);
456 if (has_promisor_remote())
458 * Prefetch the objects that are to be checked out in the loop
459 * below.
461 prefetch_cache_entries(index, must_checkout);
463 get_parallel_checkout_configs(&pc_workers, &pc_threshold);
465 enable_delayed_checkout(&state);
466 if (pc_workers > 1)
467 init_parallel_checkout();
468 for (i = 0; i < index->cache_nr; i++) {
469 struct cache_entry *ce = index->cache[i];
471 if (must_checkout(ce)) {
472 size_t last_pc_queue_size = pc_queue_size();
474 if (ce->ce_flags & CE_WT_REMOVE)
475 BUG("both update and delete flags are set on %s",
476 ce->name);
477 ce->ce_flags &= ~CE_UPDATE;
478 errs |= checkout_entry(ce, &state, NULL, NULL);
480 if (last_pc_queue_size == pc_queue_size())
481 display_progress(progress, ++cnt);
484 if (pc_workers > 1)
485 errs |= run_parallel_checkout(&state, pc_workers, pc_threshold,
486 progress, &cnt);
487 stop_progress(&progress);
488 errs |= finish_delayed_checkout(&state, NULL, o->verbose_update);
489 git_attr_set_direction(GIT_ATTR_CHECKIN);
491 if (o->clone)
492 report_collided_checkout(index);
494 trace_performance_leave("check_updates");
495 return errs != 0;
498 static int verify_uptodate_sparse(const struct cache_entry *ce,
499 struct unpack_trees_options *o);
500 static int verify_absent_sparse(const struct cache_entry *ce,
501 enum unpack_trees_error_types,
502 struct unpack_trees_options *o);
504 static int apply_sparse_checkout(struct index_state *istate,
505 struct cache_entry *ce,
506 struct unpack_trees_options *o)
508 int was_skip_worktree = ce_skip_worktree(ce);
510 if (ce->ce_flags & CE_NEW_SKIP_WORKTREE)
511 ce->ce_flags |= CE_SKIP_WORKTREE;
512 else
513 ce->ce_flags &= ~CE_SKIP_WORKTREE;
514 if (was_skip_worktree != ce_skip_worktree(ce)) {
515 ce->ce_flags |= CE_UPDATE_IN_BASE;
516 mark_fsmonitor_invalid(istate, ce);
517 istate->cache_changed |= CE_ENTRY_CHANGED;
521 * if (!was_skip_worktree && !ce_skip_worktree()) {
522 * This is perfectly normal. Move on;
527 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
528 * area as a result of ce_skip_worktree() shortcuts in
529 * verify_absent() and verify_uptodate().
530 * Make sure they don't modify worktree if they are already
531 * outside checkout area
533 if (was_skip_worktree && ce_skip_worktree(ce)) {
534 ce->ce_flags &= ~CE_UPDATE;
537 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
538 * on to get that file removed from both index and worktree.
539 * If that file is already outside worktree area, don't
540 * bother remove it.
542 if (ce->ce_flags & CE_REMOVE)
543 ce->ce_flags &= ~CE_WT_REMOVE;
546 if (!was_skip_worktree && ce_skip_worktree(ce)) {
548 * If CE_UPDATE is set, verify_uptodate() must be called already
549 * also stat info may have lost after merged_entry() so calling
550 * verify_uptodate() again may fail
552 if (!(ce->ce_flags & CE_UPDATE) &&
553 verify_uptodate_sparse(ce, o)) {
554 ce->ce_flags &= ~CE_SKIP_WORKTREE;
555 return -1;
557 ce->ce_flags |= CE_WT_REMOVE;
558 ce->ce_flags &= ~CE_UPDATE;
560 if (was_skip_worktree && !ce_skip_worktree(ce)) {
561 if (verify_absent_sparse(ce, WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN, o))
562 return -1;
563 ce->ce_flags |= CE_UPDATE;
565 return 0;
568 static int warn_conflicted_path(struct index_state *istate,
569 int i,
570 struct unpack_trees_options *o)
572 char *conflicting_path = istate->cache[i]->name;
573 int count = 0;
575 add_rejected_path(o, WARNING_SPARSE_UNMERGED_FILE, conflicting_path);
577 /* Find out how many higher stage entries are at same path */
578 while ((++count) + i < istate->cache_nr &&
579 !strcmp(conflicting_path, istate->cache[count + i]->name))
580 ; /* do nothing */
582 return count;
585 static inline int call_unpack_fn(const struct cache_entry * const *src,
586 struct unpack_trees_options *o)
588 int ret = o->fn(src, o);
589 if (ret > 0)
590 ret = 0;
591 return ret;
594 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
596 ce->ce_flags |= CE_UNPACKED;
599 * If this is a sparse directory, don't advance cache_bottom.
600 * That will be advanced later using the cache-tree data.
602 if (S_ISSPARSEDIR(ce->ce_mode))
603 return;
605 if (o->cache_bottom < o->src_index->cache_nr &&
606 o->src_index->cache[o->cache_bottom] == ce) {
607 int bottom = o->cache_bottom;
608 while (bottom < o->src_index->cache_nr &&
609 o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
610 bottom++;
611 o->cache_bottom = bottom;
615 static void mark_all_ce_unused(struct index_state *index)
617 int i;
618 for (i = 0; i < index->cache_nr; i++)
619 index->cache[i]->ce_flags &= ~(CE_UNPACKED | CE_ADDED | CE_NEW_SKIP_WORKTREE);
622 static int locate_in_src_index(const struct cache_entry *ce,
623 struct unpack_trees_options *o)
625 struct index_state *index = o->src_index;
626 int len = ce_namelen(ce);
627 int pos = index_name_pos(index, ce->name, len);
628 if (pos < 0)
629 pos = -1 - pos;
630 return pos;
634 * We call unpack_index_entry() with an unmerged cache entry
635 * only in diff-index, and it wants a single callback. Skip
636 * the other unmerged entry with the same name.
638 static void mark_ce_used_same_name(struct cache_entry *ce,
639 struct unpack_trees_options *o)
641 struct index_state *index = o->src_index;
642 int len = ce_namelen(ce);
643 int pos;
645 for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
646 struct cache_entry *next = index->cache[pos];
647 if (len != ce_namelen(next) ||
648 memcmp(ce->name, next->name, len))
649 break;
650 mark_ce_used(next, o);
654 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o, int *hint)
656 const struct index_state *index = o->src_index;
657 int pos = o->cache_bottom;
659 if (*hint > pos)
660 pos = *hint;
662 while (pos < index->cache_nr) {
663 struct cache_entry *ce = index->cache[pos];
664 if (!(ce->ce_flags & CE_UNPACKED)) {
665 *hint = pos + 1;
666 return ce;
668 pos++;
671 *hint = pos;
672 return NULL;
675 static void add_same_unmerged(const struct cache_entry *ce,
676 struct unpack_trees_options *o)
678 struct index_state *index = o->src_index;
679 int len = ce_namelen(ce);
680 int pos = index_name_pos(index, ce->name, len);
682 if (0 <= pos)
683 die("programming error in a caller of mark_ce_used_same_name");
684 for (pos = -pos - 1; pos < index->cache_nr; pos++) {
685 struct cache_entry *next = index->cache[pos];
686 if (len != ce_namelen(next) ||
687 memcmp(ce->name, next->name, len))
688 break;
689 add_entry(o, next, 0, 0);
690 mark_ce_used(next, o);
694 static int unpack_index_entry(struct cache_entry *ce,
695 struct unpack_trees_options *o)
697 const struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
698 int ret;
700 src[0] = ce;
702 mark_ce_used(ce, o);
703 if (ce_stage(ce)) {
704 if (o->skip_unmerged) {
705 add_entry(o, ce, 0, 0);
706 return 0;
709 ret = call_unpack_fn(src, o);
710 if (ce_stage(ce))
711 mark_ce_used_same_name(ce, o);
712 return ret;
715 static int find_cache_pos(struct traverse_info *, const char *p, size_t len);
717 static void restore_cache_bottom(struct traverse_info *info, int bottom)
719 struct unpack_trees_options *o = info->data;
721 if (o->diff_index_cached)
722 return;
723 o->cache_bottom = bottom;
726 static int switch_cache_bottom(struct traverse_info *info)
728 struct unpack_trees_options *o = info->data;
729 int ret, pos;
731 if (o->diff_index_cached)
732 return 0;
733 ret = o->cache_bottom;
734 pos = find_cache_pos(info->prev, info->name, info->namelen);
736 if (pos < -1)
737 o->cache_bottom = -2 - pos;
738 else if (pos < 0)
739 o->cache_bottom = o->src_index->cache_nr;
740 return ret;
743 static inline int are_same_oid(struct name_entry *name_j, struct name_entry *name_k)
745 return !is_null_oid(&name_j->oid) && !is_null_oid(&name_k->oid) && oideq(&name_j->oid, &name_k->oid);
748 static int all_trees_same_as_cache_tree(int n, unsigned long dirmask,
749 struct name_entry *names,
750 struct traverse_info *info)
752 struct unpack_trees_options *o = info->data;
753 int i;
755 if (!o->merge || dirmask != ((1 << n) - 1))
756 return 0;
758 for (i = 1; i < n; i++)
759 if (!are_same_oid(names, names + i))
760 return 0;
762 return cache_tree_matches_traversal(o->src_index->cache_tree, names, info);
765 static int index_pos_by_traverse_info(struct name_entry *names,
766 struct traverse_info *info)
768 struct unpack_trees_options *o = info->data;
769 struct strbuf name = STRBUF_INIT;
770 int pos;
772 strbuf_make_traverse_path(&name, info, names->path, names->pathlen);
773 strbuf_addch(&name, '/');
774 pos = index_name_pos(o->src_index, name.buf, name.len);
775 if (pos >= 0) {
776 if (!o->src_index->sparse_index ||
777 !(o->src_index->cache[pos]->ce_flags & CE_SKIP_WORKTREE))
778 BUG("This is a directory and should not exist in index");
779 } else {
780 pos = -pos - 1;
782 if (pos >= o->src_index->cache_nr ||
783 !starts_with(o->src_index->cache[pos]->name, name.buf) ||
784 (pos > 0 && starts_with(o->src_index->cache[pos-1]->name, name.buf)))
785 BUG("pos %d doesn't point to the first entry of %s in index",
786 pos, name.buf);
787 strbuf_release(&name);
788 return pos;
792 * Fast path if we detect that all trees are the same as cache-tree at this
793 * path. We'll walk these trees in an iterative loop using cache-tree/index
794 * instead of ODB since we already know what these trees contain.
796 static int traverse_by_cache_tree(int pos, int nr_entries, int nr_names,
797 struct traverse_info *info)
799 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
800 struct unpack_trees_options *o = info->data;
801 struct cache_entry *tree_ce = NULL;
802 int ce_len = 0;
803 int i, d;
805 if (!o->merge)
806 BUG("We need cache-tree to do this optimization");
809 * Do what unpack_callback() and unpack_single_entry() normally
810 * do. But we walk all paths in an iterative loop instead.
812 * D/F conflicts and higher stage entries are not a concern
813 * because cache-tree would be invalidated and we would never
814 * get here in the first place.
816 for (i = 0; i < nr_entries; i++) {
817 int new_ce_len, len, rc;
819 src[0] = o->src_index->cache[pos + i];
821 len = ce_namelen(src[0]);
822 new_ce_len = cache_entry_size(len);
824 if (new_ce_len > ce_len) {
825 new_ce_len <<= 1;
826 tree_ce = xrealloc(tree_ce, new_ce_len);
827 memset(tree_ce, 0, new_ce_len);
828 ce_len = new_ce_len;
830 tree_ce->ce_flags = create_ce_flags(0);
832 for (d = 1; d <= nr_names; d++)
833 src[d] = tree_ce;
836 tree_ce->ce_mode = src[0]->ce_mode;
837 tree_ce->ce_namelen = len;
838 oidcpy(&tree_ce->oid, &src[0]->oid);
839 memcpy(tree_ce->name, src[0]->name, len + 1);
841 rc = call_unpack_fn((const struct cache_entry * const *)src, o);
842 if (rc < 0) {
843 free(tree_ce);
844 return rc;
847 mark_ce_used(src[0], o);
849 free(tree_ce);
850 if (o->debug_unpack)
851 printf("Unpacked %d entries from %s to %s using cache-tree\n",
852 nr_entries,
853 o->src_index->cache[pos]->name,
854 o->src_index->cache[pos + nr_entries - 1]->name);
855 return 0;
858 static int traverse_trees_recursive(int n, unsigned long dirmask,
859 unsigned long df_conflicts,
860 struct name_entry *names,
861 struct traverse_info *info)
863 struct unpack_trees_options *o = info->data;
864 int i, ret, bottom;
865 int nr_buf = 0;
866 struct tree_desc t[MAX_UNPACK_TREES];
867 void *buf[MAX_UNPACK_TREES];
868 struct traverse_info newinfo;
869 struct name_entry *p;
870 int nr_entries;
872 nr_entries = all_trees_same_as_cache_tree(n, dirmask, names, info);
873 if (nr_entries > 0) {
874 int pos = index_pos_by_traverse_info(names, info);
876 if (!o->merge || df_conflicts)
877 BUG("Wrong condition to get here buddy");
880 * All entries up to 'pos' must have been processed
881 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
882 * save and restore cache_bottom anyway to not miss
883 * unprocessed entries before 'pos'.
885 bottom = o->cache_bottom;
886 ret = traverse_by_cache_tree(pos, nr_entries, n, info);
887 o->cache_bottom = bottom;
888 return ret;
891 p = names;
892 while (!p->mode)
893 p++;
895 newinfo = *info;
896 newinfo.prev = info;
897 newinfo.pathspec = info->pathspec;
898 newinfo.name = p->path;
899 newinfo.namelen = p->pathlen;
900 newinfo.mode = p->mode;
901 newinfo.pathlen = st_add3(newinfo.pathlen, tree_entry_len(p), 1);
902 newinfo.df_conflicts |= df_conflicts;
905 * Fetch the tree from the ODB for each peer directory in the
906 * n commits.
908 * For 2- and 3-way traversals, we try to avoid hitting the
909 * ODB twice for the same OID. This should yield a nice speed
910 * up in checkouts and merges when the commits are similar.
912 * We don't bother doing the full O(n^2) search for larger n,
913 * because wider traversals don't happen that often and we
914 * avoid the search setup.
916 * When 2 peer OIDs are the same, we just copy the tree
917 * descriptor data. This implicitly borrows the buffer
918 * data from the earlier cell.
920 for (i = 0; i < n; i++, dirmask >>= 1) {
921 if (i > 0 && are_same_oid(&names[i], &names[i - 1]))
922 t[i] = t[i - 1];
923 else if (i > 1 && are_same_oid(&names[i], &names[i - 2]))
924 t[i] = t[i - 2];
925 else {
926 const struct object_id *oid = NULL;
927 if (dirmask & 1)
928 oid = &names[i].oid;
929 buf[nr_buf++] = fill_tree_descriptor(the_repository, t + i, oid);
933 bottom = switch_cache_bottom(&newinfo);
934 ret = traverse_trees(o->src_index, n, t, &newinfo);
935 restore_cache_bottom(&newinfo, bottom);
937 for (i = 0; i < nr_buf; i++)
938 free(buf[i]);
940 return ret;
944 * Compare the traverse-path to the cache entry without actually
945 * having to generate the textual representation of the traverse
946 * path.
948 * NOTE! This *only* compares up to the size of the traverse path
949 * itself - the caller needs to do the final check for the cache
950 * entry having more data at the end!
952 static int do_compare_entry_piecewise(const struct cache_entry *ce,
953 const struct traverse_info *info,
954 const char *name, size_t namelen,
955 unsigned mode)
957 int pathlen, ce_len;
958 const char *ce_name;
960 if (info->prev) {
961 int cmp = do_compare_entry_piecewise(ce, info->prev,
962 info->name, info->namelen,
963 info->mode);
964 if (cmp)
965 return cmp;
967 pathlen = info->pathlen;
968 ce_len = ce_namelen(ce);
970 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
971 if (ce_len < pathlen)
972 return -1;
974 ce_len -= pathlen;
975 ce_name = ce->name + pathlen;
977 return df_name_compare(ce_name, ce_len, S_IFREG, name, namelen, mode);
980 static int do_compare_entry(const struct cache_entry *ce,
981 const struct traverse_info *info,
982 const char *name, size_t namelen,
983 unsigned mode)
985 int pathlen, ce_len;
986 const char *ce_name;
987 int cmp;
988 unsigned ce_mode;
991 * If we have not precomputed the traverse path, it is quicker
992 * to avoid doing so. But if we have precomputed it,
993 * it is quicker to use the precomputed version.
995 if (!info->traverse_path)
996 return do_compare_entry_piecewise(ce, info, name, namelen, mode);
998 cmp = strncmp(ce->name, info->traverse_path, info->pathlen);
999 if (cmp)
1000 return cmp;
1002 pathlen = info->pathlen;
1003 ce_len = ce_namelen(ce);
1005 if (ce_len < pathlen)
1006 return -1;
1008 ce_len -= pathlen;
1009 ce_name = ce->name + pathlen;
1011 ce_mode = S_ISSPARSEDIR(ce->ce_mode) ? S_IFDIR : S_IFREG;
1012 return df_name_compare(ce_name, ce_len, ce_mode, name, namelen, mode);
1015 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
1017 int cmp = do_compare_entry(ce, info, n->path, n->pathlen, n->mode);
1018 if (cmp)
1019 return cmp;
1022 * At this point, we know that we have a prefix match. If ce
1023 * is a sparse directory, then allow an exact match. This only
1024 * works when the input name is a directory, since ce->name
1025 * ends in a directory separator.
1027 if (S_ISSPARSEDIR(ce->ce_mode) &&
1028 ce->ce_namelen == traverse_path_len(info, tree_entry_len(n)) + 1)
1029 return 0;
1032 * Even if the beginning compared identically, the ce should
1033 * compare as bigger than a directory leading up to it!
1035 return ce_namelen(ce) > traverse_path_len(info, tree_entry_len(n));
1038 static int ce_in_traverse_path(const struct cache_entry *ce,
1039 const struct traverse_info *info)
1041 if (!info->prev)
1042 return 1;
1043 if (do_compare_entry(ce, info->prev,
1044 info->name, info->namelen, info->mode))
1045 return 0;
1047 * If ce (blob) is the same name as the path (which is a tree
1048 * we will be descending into), it won't be inside it.
1050 return (info->pathlen < ce_namelen(ce));
1053 static struct cache_entry *create_ce_entry(const struct traverse_info *info,
1054 const struct name_entry *n,
1055 int stage,
1056 struct index_state *istate,
1057 int is_transient,
1058 int is_sparse_directory)
1060 size_t len = traverse_path_len(info, tree_entry_len(n));
1061 size_t alloc_len = is_sparse_directory ? len + 1 : len;
1062 struct cache_entry *ce =
1063 is_transient ?
1064 make_empty_transient_cache_entry(alloc_len, NULL) :
1065 make_empty_cache_entry(istate, alloc_len);
1067 ce->ce_mode = create_ce_mode(n->mode);
1068 ce->ce_flags = create_ce_flags(stage);
1069 ce->ce_namelen = len;
1070 oidcpy(&ce->oid, &n->oid);
1071 /* len+1 because the cache_entry allocates space for NUL */
1072 make_traverse_path(ce->name, len + 1, info, n->path, n->pathlen);
1074 if (is_sparse_directory) {
1075 ce->name[len] = '/';
1076 ce->name[len + 1] = '\0';
1077 ce->ce_namelen++;
1078 ce->ce_flags |= CE_SKIP_WORKTREE;
1081 return ce;
1085 * Note that traverse_by_cache_tree() duplicates some logic in this function
1086 * without actually calling it. If you change the logic here you may need to
1087 * check and change there as well.
1089 static int unpack_single_entry(int n, unsigned long mask,
1090 unsigned long dirmask,
1091 struct cache_entry **src,
1092 const struct name_entry *names,
1093 const struct traverse_info *info)
1095 int i;
1096 struct unpack_trees_options *o = info->data;
1097 unsigned long conflicts = info->df_conflicts | dirmask;
1099 if (mask == dirmask && !src[0])
1100 return 0;
1103 * When we have a sparse directory entry for src[0],
1104 * then this isn't necessarily a directory-file conflict.
1106 if (mask == dirmask && src[0] &&
1107 S_ISSPARSEDIR(src[0]->ce_mode))
1108 conflicts = 0;
1111 * Ok, we've filled in up to any potential index entry in src[0],
1112 * now do the rest.
1114 for (i = 0; i < n; i++) {
1115 int stage;
1116 unsigned int bit = 1ul << i;
1117 if (conflicts & bit) {
1118 src[i + o->merge] = o->df_conflict_entry;
1119 continue;
1121 if (!(mask & bit))
1122 continue;
1123 if (!o->merge)
1124 stage = 0;
1125 else if (i + 1 < o->head_idx)
1126 stage = 1;
1127 else if (i + 1 > o->head_idx)
1128 stage = 3;
1129 else
1130 stage = 2;
1133 * If the merge bit is set, then the cache entries are
1134 * discarded in the following block. In this case,
1135 * construct "transient" cache_entries, as they are
1136 * not stored in the index. otherwise construct the
1137 * cache entry from the index aware logic.
1139 src[i + o->merge] = create_ce_entry(info, names + i, stage,
1140 &o->result, o->merge,
1141 bit & dirmask);
1144 if (o->merge) {
1145 int rc = call_unpack_fn((const struct cache_entry * const *)src,
1147 for (i = 0; i < n; i++) {
1148 struct cache_entry *ce = src[i + o->merge];
1149 if (ce != o->df_conflict_entry)
1150 discard_cache_entry(ce);
1152 return rc;
1155 for (i = 0; i < n; i++)
1156 if (src[i] && src[i] != o->df_conflict_entry)
1157 if (do_add_entry(o, src[i], 0, 0))
1158 return -1;
1160 return 0;
1163 static int unpack_failed(struct unpack_trees_options *o, const char *message)
1165 discard_index(&o->result);
1166 if (!o->quiet && !o->exiting_early) {
1167 if (message)
1168 return error("%s", message);
1169 return -1;
1171 return -1;
1175 * The tree traversal is looking at name p. If we have a matching entry,
1176 * return it. If name p is a directory in the index, do not return
1177 * anything, as we will want to match it when the traversal descends into
1178 * the directory.
1180 static int find_cache_pos(struct traverse_info *info,
1181 const char *p, size_t p_len)
1183 int pos;
1184 struct unpack_trees_options *o = info->data;
1185 struct index_state *index = o->src_index;
1186 int pfxlen = info->pathlen;
1188 for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
1189 const struct cache_entry *ce = index->cache[pos];
1190 const char *ce_name, *ce_slash;
1191 int cmp, ce_len;
1193 if (ce->ce_flags & CE_UNPACKED) {
1195 * cache_bottom entry is already unpacked, so
1196 * we can never match it; don't check it
1197 * again.
1199 if (pos == o->cache_bottom)
1200 ++o->cache_bottom;
1201 continue;
1203 if (!ce_in_traverse_path(ce, info)) {
1205 * Check if we can skip future cache checks
1206 * (because we're already past all possible
1207 * entries in the traverse path).
1209 if (info->traverse_path) {
1210 if (strncmp(ce->name, info->traverse_path,
1211 info->pathlen) > 0)
1212 break;
1214 continue;
1216 ce_name = ce->name + pfxlen;
1217 ce_slash = strchr(ce_name, '/');
1218 if (ce_slash)
1219 ce_len = ce_slash - ce_name;
1220 else
1221 ce_len = ce_namelen(ce) - pfxlen;
1222 cmp = name_compare(p, p_len, ce_name, ce_len);
1224 * Exact match; if we have a directory we need to
1225 * delay returning it.
1227 if (!cmp)
1228 return ce_slash ? -2 - pos : pos;
1229 if (0 < cmp)
1230 continue; /* keep looking */
1232 * ce_name sorts after p->path; could it be that we
1233 * have files under p->path directory in the index?
1234 * E.g. ce_name == "t-i", and p->path == "t"; we may
1235 * have "t/a" in the index.
1237 if (p_len < ce_len && !memcmp(ce_name, p, p_len) &&
1238 ce_name[p_len] < '/')
1239 continue; /* keep looking */
1240 break;
1242 return -1;
1246 * Given a sparse directory entry 'ce', compare ce->name to
1247 * info->traverse_path + p->path + '/' if info->traverse_path
1248 * is non-empty.
1250 * Compare ce->name to p->path + '/' otherwise. Note that
1251 * ce->name must end in a trailing '/' because it is a sparse
1252 * directory entry.
1254 static int sparse_dir_matches_path(const struct cache_entry *ce,
1255 struct traverse_info *info,
1256 const struct name_entry *p)
1258 assert(S_ISSPARSEDIR(ce->ce_mode));
1259 assert(ce->name[ce->ce_namelen - 1] == '/');
1261 if (info->pathlen)
1262 return ce->ce_namelen == info->pathlen + p->pathlen + 1 &&
1263 ce->name[info->pathlen - 1] == '/' &&
1264 !strncmp(ce->name, info->traverse_path, info->pathlen) &&
1265 !strncmp(ce->name + info->pathlen, p->path, p->pathlen);
1266 return ce->ce_namelen == p->pathlen + 1 &&
1267 !strncmp(ce->name, p->path, p->pathlen);
1270 static struct cache_entry *find_cache_entry(struct traverse_info *info,
1271 const struct name_entry *p)
1273 const char *path;
1274 int pos = find_cache_pos(info, p->path, p->pathlen);
1275 struct unpack_trees_options *o = info->data;
1277 if (0 <= pos)
1278 return o->src_index->cache[pos];
1281 * Check for a sparse-directory entry named "path/".
1282 * Due to the input p->path not having a trailing
1283 * slash, the negative 'pos' value overshoots the
1284 * expected position, hence "-2" instead of "-1".
1286 pos = -pos - 2;
1288 if (pos < 0 || pos >= o->src_index->cache_nr)
1289 return NULL;
1292 * Due to lexicographic sorting and sparse directory
1293 * entries ending with a trailing slash, our path as a
1294 * sparse directory (e.g "subdir/") and our path as a
1295 * file (e.g. "subdir") might be separated by other
1296 * paths (e.g. "subdir-").
1298 while (pos >= 0) {
1299 struct cache_entry *ce = o->src_index->cache[pos];
1301 if (!skip_prefix(ce->name, info->traverse_path, &path) ||
1302 strncmp(path, p->path, p->pathlen) ||
1303 path[p->pathlen] != '/')
1304 return NULL;
1306 if (S_ISSPARSEDIR(ce->ce_mode) &&
1307 sparse_dir_matches_path(ce, info, p))
1308 return ce;
1310 pos--;
1313 return NULL;
1316 static void debug_path(struct traverse_info *info)
1318 if (info->prev) {
1319 debug_path(info->prev);
1320 if (*info->prev->name)
1321 putchar('/');
1323 printf("%s", info->name);
1326 static void debug_name_entry(int i, struct name_entry *n)
1328 printf("ent#%d %06o %s\n", i,
1329 n->path ? n->mode : 0,
1330 n->path ? n->path : "(missing)");
1333 static void debug_unpack_callback(int n,
1334 unsigned long mask,
1335 unsigned long dirmask,
1336 struct name_entry *names,
1337 struct traverse_info *info)
1339 int i;
1340 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1341 mask, dirmask, n);
1342 debug_path(info);
1343 putchar('\n');
1344 for (i = 0; i < n; i++)
1345 debug_name_entry(i, names + i);
1349 * Returns true if and only if the given cache_entry is a
1350 * sparse-directory entry that matches the given name_entry
1351 * from the tree walk at the given traverse_info.
1353 static int is_sparse_directory_entry(struct cache_entry *ce,
1354 struct name_entry *name,
1355 struct traverse_info *info)
1357 if (!ce || !name || !S_ISSPARSEDIR(ce->ce_mode))
1358 return 0;
1360 return sparse_dir_matches_path(ce, info, name);
1364 * Note that traverse_by_cache_tree() duplicates some logic in this function
1365 * without actually calling it. If you change the logic here you may need to
1366 * check and change there as well.
1368 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
1370 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
1371 struct unpack_trees_options *o = info->data;
1372 const struct name_entry *p = names;
1374 /* Find first entry with a real name (we could use "mask" too) */
1375 while (!p->mode)
1376 p++;
1378 if (o->debug_unpack)
1379 debug_unpack_callback(n, mask, dirmask, names, info);
1381 /* Are we supposed to look at the index too? */
1382 if (o->merge) {
1383 int hint = -1;
1384 while (1) {
1385 int cmp;
1386 struct cache_entry *ce;
1388 if (o->diff_index_cached)
1389 ce = next_cache_entry(o, &hint);
1390 else
1391 ce = find_cache_entry(info, p);
1393 if (!ce)
1394 break;
1395 cmp = compare_entry(ce, info, p);
1396 if (cmp < 0) {
1397 if (unpack_index_entry(ce, o) < 0)
1398 return unpack_failed(o, NULL);
1399 continue;
1401 if (!cmp) {
1402 if (ce_stage(ce)) {
1404 * If we skip unmerged index
1405 * entries, we'll skip this
1406 * entry *and* the tree
1407 * entries associated with it!
1409 if (o->skip_unmerged) {
1410 add_same_unmerged(ce, o);
1411 return mask;
1414 src[0] = ce;
1416 break;
1420 if (unpack_single_entry(n, mask, dirmask, src, names, info) < 0)
1421 return -1;
1423 if (o->merge && src[0]) {
1424 if (ce_stage(src[0]))
1425 mark_ce_used_same_name(src[0], o);
1426 else
1427 mark_ce_used(src[0], o);
1430 /* Now handle any directories.. */
1431 if (dirmask) {
1432 /* special case: "diff-index --cached" looking at a tree */
1433 if (o->diff_index_cached &&
1434 n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
1435 int matches;
1436 matches = cache_tree_matches_traversal(o->src_index->cache_tree,
1437 names, info);
1439 * Everything under the name matches; skip the
1440 * entire hierarchy. diff_index_cached codepath
1441 * special cases D/F conflicts in such a way that
1442 * it does not do any look-ahead, so this is safe.
1444 if (matches) {
1445 o->cache_bottom += matches;
1446 return mask;
1450 if (!is_sparse_directory_entry(src[0], names, info) &&
1451 traverse_trees_recursive(n, dirmask, mask & ~dirmask,
1452 names, info) < 0) {
1453 return -1;
1456 return mask;
1459 return mask;
1462 static int clear_ce_flags_1(struct index_state *istate,
1463 struct cache_entry **cache, int nr,
1464 struct strbuf *prefix,
1465 int select_mask, int clear_mask,
1466 struct pattern_list *pl,
1467 enum pattern_match_result default_match,
1468 int progress_nr);
1470 /* Whole directory matching */
1471 static int clear_ce_flags_dir(struct index_state *istate,
1472 struct cache_entry **cache, int nr,
1473 struct strbuf *prefix,
1474 char *basename,
1475 int select_mask, int clear_mask,
1476 struct pattern_list *pl,
1477 enum pattern_match_result default_match,
1478 int progress_nr)
1480 struct cache_entry **cache_end;
1481 int dtype = DT_DIR;
1482 int rc;
1483 enum pattern_match_result ret, orig_ret;
1484 orig_ret = path_matches_pattern_list(prefix->buf, prefix->len,
1485 basename, &dtype, pl, istate);
1487 strbuf_addch(prefix, '/');
1489 /* If undecided, use matching result of parent dir in defval */
1490 if (orig_ret == UNDECIDED)
1491 ret = default_match;
1492 else
1493 ret = orig_ret;
1495 for (cache_end = cache; cache_end != cache + nr; cache_end++) {
1496 struct cache_entry *ce = *cache_end;
1497 if (strncmp(ce->name, prefix->buf, prefix->len))
1498 break;
1501 if (pl->use_cone_patterns && orig_ret == MATCHED_RECURSIVE) {
1502 struct cache_entry **ce = cache;
1503 rc = cache_end - cache;
1505 while (ce < cache_end) {
1506 (*ce)->ce_flags &= ~clear_mask;
1507 ce++;
1509 } else if (pl->use_cone_patterns && orig_ret == NOT_MATCHED) {
1510 rc = cache_end - cache;
1511 } else {
1512 rc = clear_ce_flags_1(istate, cache, cache_end - cache,
1513 prefix,
1514 select_mask, clear_mask,
1515 pl, ret,
1516 progress_nr);
1519 strbuf_setlen(prefix, prefix->len - 1);
1520 return rc;
1524 * Traverse the index, find every entry that matches according to
1525 * o->pl. Do "ce_flags &= ~clear_mask" on those entries. Return the
1526 * number of traversed entries.
1528 * If select_mask is non-zero, only entries whose ce_flags has on of
1529 * those bits enabled are traversed.
1531 * cache : pointer to an index entry
1532 * prefix_len : an offset to its path
1534 * The current path ("prefix") including the trailing '/' is
1535 * cache[0]->name[0..(prefix_len-1)]
1536 * Top level path has prefix_len zero.
1538 static int clear_ce_flags_1(struct index_state *istate,
1539 struct cache_entry **cache, int nr,
1540 struct strbuf *prefix,
1541 int select_mask, int clear_mask,
1542 struct pattern_list *pl,
1543 enum pattern_match_result default_match,
1544 int progress_nr)
1546 struct cache_entry **cache_end = nr ? cache + nr : cache;
1549 * Process all entries that have the given prefix and meet
1550 * select_mask condition
1552 while(cache != cache_end) {
1553 struct cache_entry *ce = *cache;
1554 const char *name, *slash;
1555 int len, dtype;
1556 enum pattern_match_result ret;
1558 display_progress(istate->progress, progress_nr);
1560 if (select_mask && !(ce->ce_flags & select_mask)) {
1561 cache++;
1562 progress_nr++;
1563 continue;
1566 if (prefix->len && strncmp(ce->name, prefix->buf, prefix->len))
1567 break;
1569 name = ce->name + prefix->len;
1570 slash = strchr(name, '/');
1572 /* If it's a directory, try whole directory match first */
1573 if (slash) {
1574 int processed;
1576 len = slash - name;
1577 strbuf_add(prefix, name, len);
1579 processed = clear_ce_flags_dir(istate, cache, cache_end - cache,
1580 prefix,
1581 prefix->buf + prefix->len - len,
1582 select_mask, clear_mask,
1583 pl, default_match,
1584 progress_nr);
1586 /* clear_c_f_dir eats a whole dir already? */
1587 if (processed) {
1588 cache += processed;
1589 progress_nr += processed;
1590 strbuf_setlen(prefix, prefix->len - len);
1591 continue;
1594 strbuf_addch(prefix, '/');
1595 processed = clear_ce_flags_1(istate, cache, cache_end - cache,
1596 prefix,
1597 select_mask, clear_mask, pl,
1598 default_match, progress_nr);
1600 cache += processed;
1601 progress_nr += processed;
1603 strbuf_setlen(prefix, prefix->len - len - 1);
1604 continue;
1607 /* Non-directory */
1608 dtype = ce_to_dtype(ce);
1609 ret = path_matches_pattern_list(ce->name,
1610 ce_namelen(ce),
1611 name, &dtype, pl, istate);
1612 if (ret == UNDECIDED)
1613 ret = default_match;
1614 if (ret == MATCHED || ret == MATCHED_RECURSIVE)
1615 ce->ce_flags &= ~clear_mask;
1616 cache++;
1617 progress_nr++;
1620 display_progress(istate->progress, progress_nr);
1621 return nr - (cache_end - cache);
1624 static int clear_ce_flags(struct index_state *istate,
1625 int select_mask, int clear_mask,
1626 struct pattern_list *pl,
1627 int show_progress)
1629 static struct strbuf prefix = STRBUF_INIT;
1630 char label[100];
1631 int rval;
1633 strbuf_reset(&prefix);
1634 if (show_progress)
1635 istate->progress = start_delayed_progress(
1636 _("Updating index flags"),
1637 istate->cache_nr);
1639 xsnprintf(label, sizeof(label), "clear_ce_flags(0x%08lx,0x%08lx)",
1640 (unsigned long)select_mask, (unsigned long)clear_mask);
1641 trace2_region_enter("unpack_trees", label, the_repository);
1642 rval = clear_ce_flags_1(istate,
1643 istate->cache,
1644 istate->cache_nr,
1645 &prefix,
1646 select_mask, clear_mask,
1647 pl, 0, 0);
1648 trace2_region_leave("unpack_trees", label, the_repository);
1650 stop_progress(&istate->progress);
1651 return rval;
1655 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1657 static void mark_new_skip_worktree(struct pattern_list *pl,
1658 struct index_state *istate,
1659 int select_flag, int skip_wt_flag,
1660 int show_progress)
1662 int i;
1665 * 1. Pretend the narrowest worktree: only unmerged entries
1666 * are checked out
1668 for (i = 0; i < istate->cache_nr; i++) {
1669 struct cache_entry *ce = istate->cache[i];
1671 if (select_flag && !(ce->ce_flags & select_flag))
1672 continue;
1674 if (!ce_stage(ce) && !(ce->ce_flags & CE_CONFLICTED))
1675 ce->ce_flags |= skip_wt_flag;
1676 else
1677 ce->ce_flags &= ~skip_wt_flag;
1681 * 2. Widen worktree according to sparse-checkout file.
1682 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1684 clear_ce_flags(istate, select_flag, skip_wt_flag, pl, show_progress);
1687 static void populate_from_existing_patterns(struct unpack_trees_options *o,
1688 struct pattern_list *pl)
1690 if (get_sparse_checkout_patterns(pl) < 0)
1691 o->skip_sparse_checkout = 1;
1692 else
1693 o->pl = pl;
1697 static int verify_absent(const struct cache_entry *,
1698 enum unpack_trees_error_types,
1699 struct unpack_trees_options *);
1701 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1702 * resulting index, -2 on failure to reflect the changes to the work tree.
1704 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1706 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
1708 struct repository *repo = the_repository;
1709 int i, hint, ret;
1710 static struct cache_entry *dfc;
1711 struct pattern_list pl;
1712 int free_pattern_list = 0;
1713 struct dir_struct dir = DIR_INIT;
1715 if (o->reset == UNPACK_RESET_INVALID)
1716 BUG("o->reset had a value of 1; should be UNPACK_TREES_*_UNTRACKED");
1718 if (len > MAX_UNPACK_TREES)
1719 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
1720 if (o->dir)
1721 BUG("o->dir is for internal use only");
1723 trace_performance_enter();
1724 trace2_region_enter("unpack_trees", "unpack_trees", the_repository);
1726 prepare_repo_settings(repo);
1727 if (repo->settings.command_requires_full_index) {
1728 ensure_full_index(o->src_index);
1729 ensure_full_index(o->dst_index);
1732 if (o->reset == UNPACK_RESET_OVERWRITE_UNTRACKED &&
1733 o->preserve_ignored)
1734 BUG("UNPACK_RESET_OVERWRITE_UNTRACKED incompatible with preserved ignored files");
1736 if (!o->preserve_ignored) {
1737 o->dir = &dir;
1738 o->dir->flags |= DIR_SHOW_IGNORED;
1739 setup_standard_excludes(o->dir);
1742 if (!core_apply_sparse_checkout || !o->update)
1743 o->skip_sparse_checkout = 1;
1744 if (!o->skip_sparse_checkout && !o->pl) {
1745 memset(&pl, 0, sizeof(pl));
1746 free_pattern_list = 1;
1747 populate_from_existing_patterns(o, &pl);
1750 memset(&o->result, 0, sizeof(o->result));
1751 o->result.initialized = 1;
1752 o->result.timestamp.sec = o->src_index->timestamp.sec;
1753 o->result.timestamp.nsec = o->src_index->timestamp.nsec;
1754 o->result.version = o->src_index->version;
1755 if (!o->src_index->split_index) {
1756 o->result.split_index = NULL;
1757 } else if (o->src_index == o->dst_index) {
1759 * o->dst_index (and thus o->src_index) will be discarded
1760 * and overwritten with o->result at the end of this function,
1761 * so just use src_index's split_index to avoid having to
1762 * create a new one.
1764 o->result.split_index = o->src_index->split_index;
1765 o->result.split_index->refcount++;
1766 } else {
1767 o->result.split_index = init_split_index(&o->result);
1769 oidcpy(&o->result.oid, &o->src_index->oid);
1770 o->merge_size = len;
1771 mark_all_ce_unused(o->src_index);
1773 o->result.fsmonitor_last_update =
1774 xstrdup_or_null(o->src_index->fsmonitor_last_update);
1777 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1779 if (!o->skip_sparse_checkout)
1780 mark_new_skip_worktree(o->pl, o->src_index, 0,
1781 CE_NEW_SKIP_WORKTREE, o->verbose_update);
1783 if (!dfc)
1784 dfc = xcalloc(1, cache_entry_size(0));
1785 o->df_conflict_entry = dfc;
1787 if (len) {
1788 const char *prefix = o->prefix ? o->prefix : "";
1789 struct traverse_info info;
1791 setup_traverse_info(&info, prefix);
1792 info.fn = unpack_callback;
1793 info.data = o;
1794 info.show_all_errors = o->show_all_errors;
1795 info.pathspec = o->pathspec;
1797 if (o->prefix) {
1798 hint = -1;
1801 * Unpack existing index entries that sort before the
1802 * prefix the tree is spliced into. Note that o->merge
1803 * is always true in this case.
1805 while (1) {
1806 struct cache_entry *ce = next_cache_entry(o, &hint);
1807 if (!ce)
1808 break;
1809 if (ce_in_traverse_path(ce, &info))
1810 break;
1811 if (unpack_index_entry(ce, o) < 0)
1812 goto return_failed;
1816 trace_performance_enter();
1817 trace2_region_enter("unpack_trees", "traverse_trees", the_repository);
1818 ret = traverse_trees(o->src_index, len, t, &info);
1819 trace2_region_leave("unpack_trees", "traverse_trees", the_repository);
1820 trace_performance_leave("traverse_trees");
1821 if (ret < 0)
1822 goto return_failed;
1825 /* Any left-over entries in the index? */
1826 if (o->merge) {
1827 hint = -1;
1828 while (1) {
1829 struct cache_entry *ce = next_cache_entry(o, &hint);
1830 if (!ce)
1831 break;
1832 if (unpack_index_entry(ce, o) < 0)
1833 goto return_failed;
1836 mark_all_ce_unused(o->src_index);
1838 if (o->trivial_merges_only && o->nontrivial_merge) {
1839 ret = unpack_failed(o, "Merge requires file-level merging");
1840 goto done;
1843 if (!o->skip_sparse_checkout) {
1845 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1846 * If they will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1847 * so apply_sparse_checkout() won't attempt to remove it from worktree
1849 mark_new_skip_worktree(o->pl, &o->result,
1850 CE_ADDED, CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE,
1851 o->verbose_update);
1853 ret = 0;
1854 for (i = 0; i < o->result.cache_nr; i++) {
1855 struct cache_entry *ce = o->result.cache[i];
1858 * Entries marked with CE_ADDED in merged_entry() do not have
1859 * verify_absent() check (the check is effectively disabled
1860 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1862 * Do the real check now because we have had
1863 * correct CE_NEW_SKIP_WORKTREE
1865 if (ce->ce_flags & CE_ADDED &&
1866 verify_absent(ce, WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN, o))
1867 ret = 1;
1869 if (apply_sparse_checkout(&o->result, ce, o))
1870 ret = 1;
1872 if (ret == 1) {
1874 * Inability to sparsify or de-sparsify individual
1875 * paths is not an error, but just a warning.
1877 if (o->show_all_errors)
1878 display_warning_msgs(o);
1879 ret = 0;
1883 ret = check_updates(o, &o->result) ? (-2) : 0;
1884 if (o->dst_index) {
1885 move_index_extensions(&o->result, o->src_index);
1886 if (!ret) {
1887 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
1888 cache_tree_verify(the_repository, &o->result);
1889 if (!cache_tree_fully_valid(o->result.cache_tree))
1890 cache_tree_update(&o->result,
1891 WRITE_TREE_SILENT |
1892 WRITE_TREE_REPAIR);
1895 o->result.updated_workdir = 1;
1896 discard_index(o->dst_index);
1897 *o->dst_index = o->result;
1898 } else {
1899 discard_index(&o->result);
1901 o->src_index = NULL;
1903 done:
1904 if (free_pattern_list)
1905 clear_pattern_list(&pl);
1906 if (o->dir) {
1907 dir_clear(o->dir);
1908 o->dir = NULL;
1910 trace2_region_leave("unpack_trees", "unpack_trees", the_repository);
1911 trace_performance_leave("unpack_trees");
1912 return ret;
1914 return_failed:
1915 if (o->show_all_errors)
1916 display_error_msgs(o);
1917 mark_all_ce_unused(o->src_index);
1918 ret = unpack_failed(o, NULL);
1919 if (o->exiting_early)
1920 ret = 0;
1921 goto done;
1925 * Update SKIP_WORKTREE bits according to sparsity patterns, and update
1926 * working directory to match.
1928 * CE_NEW_SKIP_WORKTREE is used internally.
1930 enum update_sparsity_result update_sparsity(struct unpack_trees_options *o)
1932 enum update_sparsity_result ret = UPDATE_SPARSITY_SUCCESS;
1933 struct pattern_list pl;
1934 int i;
1935 unsigned old_show_all_errors;
1936 int free_pattern_list = 0;
1938 old_show_all_errors = o->show_all_errors;
1939 o->show_all_errors = 1;
1941 /* Sanity checks */
1942 if (!o->update || o->index_only || o->skip_sparse_checkout)
1943 BUG("update_sparsity() is for reflecting sparsity patterns in working directory");
1944 if (o->src_index != o->dst_index || o->fn)
1945 BUG("update_sparsity() called wrong");
1947 trace_performance_enter();
1949 /* If we weren't given patterns, use the recorded ones */
1950 if (!o->pl) {
1951 memset(&pl, 0, sizeof(pl));
1952 free_pattern_list = 1;
1953 populate_from_existing_patterns(o, &pl);
1954 if (o->skip_sparse_checkout)
1955 goto skip_sparse_checkout;
1958 /* Set NEW_SKIP_WORKTREE on existing entries. */
1959 mark_all_ce_unused(o->src_index);
1960 mark_new_skip_worktree(o->pl, o->src_index, 0,
1961 CE_NEW_SKIP_WORKTREE, o->verbose_update);
1963 /* Then loop over entries and update/remove as needed */
1964 ret = UPDATE_SPARSITY_SUCCESS;
1965 for (i = 0; i < o->src_index->cache_nr; i++) {
1966 struct cache_entry *ce = o->src_index->cache[i];
1969 if (ce_stage(ce)) {
1970 /* -1 because for loop will increment by 1 */
1971 i += warn_conflicted_path(o->src_index, i, o) - 1;
1972 ret = UPDATE_SPARSITY_WARNINGS;
1973 continue;
1976 if (apply_sparse_checkout(o->src_index, ce, o))
1977 ret = UPDATE_SPARSITY_WARNINGS;
1980 skip_sparse_checkout:
1981 if (check_updates(o, o->src_index))
1982 ret = UPDATE_SPARSITY_WORKTREE_UPDATE_FAILURES;
1984 display_warning_msgs(o);
1985 o->show_all_errors = old_show_all_errors;
1986 if (free_pattern_list)
1987 clear_pattern_list(&pl);
1988 trace_performance_leave("update_sparsity");
1989 return ret;
1992 /* Here come the merge functions */
1994 static int reject_merge(const struct cache_entry *ce,
1995 struct unpack_trees_options *o)
1997 return add_rejected_path(o, ERROR_WOULD_OVERWRITE, ce->name);
2000 static int same(const struct cache_entry *a, const struct cache_entry *b)
2002 if (!!a != !!b)
2003 return 0;
2004 if (!a && !b)
2005 return 1;
2006 if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
2007 return 0;
2008 return a->ce_mode == b->ce_mode &&
2009 oideq(&a->oid, &b->oid);
2014 * When a CE gets turned into an unmerged entry, we
2015 * want it to be up-to-date
2017 static int verify_uptodate_1(const struct cache_entry *ce,
2018 struct unpack_trees_options *o,
2019 enum unpack_trees_error_types error_type)
2021 struct stat st;
2023 if (o->index_only)
2024 return 0;
2027 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
2028 * if this entry is truly up-to-date because this file may be
2029 * overwritten.
2031 if ((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce))
2032 ; /* keep checking */
2033 else if (o->reset || ce_uptodate(ce))
2034 return 0;
2036 if (!lstat(ce->name, &st)) {
2037 int flags = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE;
2038 unsigned changed = ie_match_stat(o->src_index, ce, &st, flags);
2040 if (submodule_from_ce(ce)) {
2041 int r = check_submodule_move_head(ce,
2042 "HEAD", oid_to_hex(&ce->oid), o);
2043 if (r)
2044 return add_rejected_path(o, error_type, ce->name);
2045 return 0;
2048 if (!changed)
2049 return 0;
2051 * Historic default policy was to allow submodule to be out
2052 * of sync wrt the superproject index. If the submodule was
2053 * not considered interesting above, we don't care here.
2055 if (S_ISGITLINK(ce->ce_mode))
2056 return 0;
2058 errno = 0;
2060 if (errno == ENOENT)
2061 return 0;
2062 return add_rejected_path(o, error_type, ce->name);
2065 int verify_uptodate(const struct cache_entry *ce,
2066 struct unpack_trees_options *o)
2068 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
2069 return 0;
2070 return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
2073 static int verify_uptodate_sparse(const struct cache_entry *ce,
2074 struct unpack_trees_options *o)
2076 return verify_uptodate_1(ce, o, WARNING_SPARSE_NOT_UPTODATE_FILE);
2080 * TODO: We should actually invalidate o->result, not src_index [1].
2081 * But since cache tree and untracked cache both are not copied to
2082 * o->result until unpacking is complete, we invalidate them on
2083 * src_index instead with the assumption that they will be copied to
2084 * dst_index at the end.
2086 * [1] src_index->cache_tree is also used in unpack_callback() so if
2087 * we invalidate o->result, we need to update it to use
2088 * o->result.cache_tree as well.
2090 static void invalidate_ce_path(const struct cache_entry *ce,
2091 struct unpack_trees_options *o)
2093 if (!ce)
2094 return;
2095 cache_tree_invalidate_path(o->src_index, ce->name);
2096 untracked_cache_invalidate_path(o->src_index, ce->name, 1);
2100 * Check that checking out ce->sha1 in subdir ce->name is not
2101 * going to overwrite any working files.
2103 static int verify_clean_submodule(const char *old_sha1,
2104 const struct cache_entry *ce,
2105 struct unpack_trees_options *o)
2107 if (!submodule_from_ce(ce))
2108 return 0;
2110 return check_submodule_move_head(ce, old_sha1,
2111 oid_to_hex(&ce->oid), o);
2114 static int verify_clean_subdirectory(const struct cache_entry *ce,
2115 struct unpack_trees_options *o)
2118 * we are about to extract "ce->name"; we would not want to lose
2119 * anything in the existing directory there.
2121 int namelen;
2122 int i;
2123 struct dir_struct d;
2124 char *pathbuf;
2125 int cnt = 0;
2127 if (S_ISGITLINK(ce->ce_mode)) {
2128 struct object_id oid;
2129 int sub_head = resolve_gitlink_ref(ce->name, "HEAD", &oid);
2131 * If we are not going to update the submodule, then
2132 * we don't care.
2134 if (!sub_head && oideq(&oid, &ce->oid))
2135 return 0;
2136 return verify_clean_submodule(sub_head ? NULL : oid_to_hex(&oid),
2137 ce, o);
2141 * First let's make sure we do not have a local modification
2142 * in that directory.
2144 namelen = ce_namelen(ce);
2145 for (i = locate_in_src_index(ce, o);
2146 i < o->src_index->cache_nr;
2147 i++) {
2148 struct cache_entry *ce2 = o->src_index->cache[i];
2149 int len = ce_namelen(ce2);
2150 if (len < namelen ||
2151 strncmp(ce->name, ce2->name, namelen) ||
2152 ce2->name[namelen] != '/')
2153 break;
2155 * ce2->name is an entry in the subdirectory to be
2156 * removed.
2158 if (!ce_stage(ce2)) {
2159 if (verify_uptodate(ce2, o))
2160 return -1;
2161 add_entry(o, ce2, CE_REMOVE, 0);
2162 invalidate_ce_path(ce, o);
2163 mark_ce_used(ce2, o);
2165 cnt++;
2168 /* Do not lose a locally present file that is not ignored. */
2169 pathbuf = xstrfmt("%.*s/", namelen, ce->name);
2171 memset(&d, 0, sizeof(d));
2172 if (o->dir)
2173 d.exclude_per_dir = o->dir->exclude_per_dir;
2174 i = read_directory(&d, o->src_index, pathbuf, namelen+1, NULL);
2175 dir_clear(&d);
2176 free(pathbuf);
2177 if (i)
2178 return add_rejected_path(o, ERROR_NOT_UPTODATE_DIR, ce->name);
2180 /* Do not lose startup_info->original_cwd */
2181 if (startup_info->original_cwd &&
2182 !strcmp(startup_info->original_cwd, ce->name))
2183 return add_rejected_path(o, ERROR_CWD_IN_THE_WAY, ce->name);
2185 return cnt;
2189 * This gets called when there was no index entry for the tree entry 'dst',
2190 * but we found a file in the working tree that 'lstat()' said was fine,
2191 * and we're on a case-insensitive filesystem.
2193 * See if we can find a case-insensitive match in the index that also
2194 * matches the stat information, and assume it's that other file!
2196 static int icase_exists(struct unpack_trees_options *o, const char *name, int len, struct stat *st)
2198 const struct cache_entry *src;
2200 src = index_file_exists(o->src_index, name, len, 1);
2201 return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
2204 enum absent_checking_type {
2205 COMPLETELY_ABSENT,
2206 ABSENT_ANY_DIRECTORY
2209 static int check_ok_to_remove(const char *name, int len, int dtype,
2210 const struct cache_entry *ce, struct stat *st,
2211 enum unpack_trees_error_types error_type,
2212 enum absent_checking_type absent_type,
2213 struct unpack_trees_options *o)
2215 const struct cache_entry *result;
2218 * It may be that the 'lstat()' succeeded even though
2219 * target 'ce' was absent, because there is an old
2220 * entry that is different only in case..
2222 * Ignore that lstat() if it matches.
2224 if (ignore_case && icase_exists(o, name, len, st))
2225 return 0;
2227 if (o->dir &&
2228 is_excluded(o->dir, o->src_index, name, &dtype))
2230 * ce->name is explicitly excluded, so it is Ok to
2231 * overwrite it.
2233 return 0;
2234 if (S_ISDIR(st->st_mode)) {
2236 * We are checking out path "foo" and
2237 * found "foo/." in the working tree.
2238 * This is tricky -- if we have modified
2239 * files that are in "foo/" we would lose
2240 * them.
2242 if (verify_clean_subdirectory(ce, o) < 0)
2243 return -1;
2244 return 0;
2247 /* If we only care about directories, then we can remove */
2248 if (absent_type == ABSENT_ANY_DIRECTORY)
2249 return 0;
2252 * The previous round may already have decided to
2253 * delete this path, which is in a subdirectory that
2254 * is being replaced with a blob.
2256 result = index_file_exists(&o->result, name, len, 0);
2257 if (result) {
2258 if (result->ce_flags & CE_REMOVE)
2259 return 0;
2262 return add_rejected_path(o, error_type, name);
2266 * We do not want to remove or overwrite a working tree file that
2267 * is not tracked, unless it is ignored.
2269 static int verify_absent_1(const struct cache_entry *ce,
2270 enum unpack_trees_error_types error_type,
2271 enum absent_checking_type absent_type,
2272 struct unpack_trees_options *o)
2274 int len;
2275 struct stat st;
2277 if (o->index_only || !o->update)
2278 return 0;
2280 if (o->reset == UNPACK_RESET_OVERWRITE_UNTRACKED) {
2281 /* Avoid nuking startup_info->original_cwd... */
2282 if (startup_info->original_cwd &&
2283 !strcmp(startup_info->original_cwd, ce->name))
2284 return add_rejected_path(o, ERROR_CWD_IN_THE_WAY,
2285 ce->name);
2286 /* ...but nuke anything else. */
2287 return 0;
2290 len = check_leading_path(ce->name, ce_namelen(ce), 0);
2291 if (!len)
2292 return 0;
2293 else if (len > 0) {
2294 char *path;
2295 int ret;
2297 path = xmemdupz(ce->name, len);
2298 if (lstat(path, &st))
2299 ret = error_errno("cannot stat '%s'", path);
2300 else {
2301 if (submodule_from_ce(ce))
2302 ret = check_submodule_move_head(ce,
2303 oid_to_hex(&ce->oid),
2304 NULL, o);
2305 else
2306 ret = check_ok_to_remove(path, len, DT_UNKNOWN, NULL,
2307 &st, error_type,
2308 absent_type, o);
2310 free(path);
2311 return ret;
2312 } else if (lstat(ce->name, &st)) {
2313 if (errno != ENOENT)
2314 return error_errno("cannot stat '%s'", ce->name);
2315 return 0;
2316 } else {
2317 if (submodule_from_ce(ce))
2318 return check_submodule_move_head(ce, oid_to_hex(&ce->oid),
2319 NULL, o);
2321 return check_ok_to_remove(ce->name, ce_namelen(ce),
2322 ce_to_dtype(ce), ce, &st,
2323 error_type, absent_type, o);
2327 static int verify_absent(const struct cache_entry *ce,
2328 enum unpack_trees_error_types error_type,
2329 struct unpack_trees_options *o)
2331 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
2332 return 0;
2333 return verify_absent_1(ce, error_type, COMPLETELY_ABSENT, o);
2336 static int verify_absent_if_directory(const struct cache_entry *ce,
2337 enum unpack_trees_error_types error_type,
2338 struct unpack_trees_options *o)
2340 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
2341 return 0;
2342 return verify_absent_1(ce, error_type, ABSENT_ANY_DIRECTORY, o);
2345 static int verify_absent_sparse(const struct cache_entry *ce,
2346 enum unpack_trees_error_types error_type,
2347 struct unpack_trees_options *o)
2349 return verify_absent_1(ce, error_type, COMPLETELY_ABSENT, o);
2352 static int merged_entry(const struct cache_entry *ce,
2353 const struct cache_entry *old,
2354 struct unpack_trees_options *o)
2356 int update = CE_UPDATE;
2357 struct cache_entry *merge = dup_cache_entry(ce, &o->result);
2359 if (!old) {
2361 * New index entries. In sparse checkout, the following
2362 * verify_absent() will be delayed until after
2363 * traverse_trees() finishes in unpack_trees(), then:
2365 * - CE_NEW_SKIP_WORKTREE will be computed correctly
2366 * - verify_absent() be called again, this time with
2367 * correct CE_NEW_SKIP_WORKTREE
2369 * verify_absent() call here does nothing in sparse
2370 * checkout (i.e. o->skip_sparse_checkout == 0)
2372 update |= CE_ADDED;
2373 merge->ce_flags |= CE_NEW_SKIP_WORKTREE;
2375 if (verify_absent(merge,
2376 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
2377 discard_cache_entry(merge);
2378 return -1;
2380 invalidate_ce_path(merge, o);
2382 if (submodule_from_ce(ce) && file_exists(ce->name)) {
2383 int ret = check_submodule_move_head(ce, NULL,
2384 oid_to_hex(&ce->oid),
2386 if (ret)
2387 return ret;
2390 } else if (!(old->ce_flags & CE_CONFLICTED)) {
2392 * See if we can re-use the old CE directly?
2393 * That way we get the uptodate stat info.
2395 * This also removes the UPDATE flag on a match; otherwise
2396 * we will end up overwriting local changes in the work tree.
2398 if (same(old, merge)) {
2399 copy_cache_entry(merge, old);
2400 update = 0;
2401 } else {
2402 if (verify_uptodate(old, o)) {
2403 discard_cache_entry(merge);
2404 return -1;
2406 /* Migrate old flags over */
2407 update |= old->ce_flags & (CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
2408 invalidate_ce_path(old, o);
2411 if (submodule_from_ce(ce) && file_exists(ce->name)) {
2412 int ret = check_submodule_move_head(ce, oid_to_hex(&old->oid),
2413 oid_to_hex(&ce->oid),
2415 if (ret)
2416 return ret;
2418 } else {
2420 * Previously unmerged entry left as an existence
2421 * marker by read_index_unmerged();
2423 if (verify_absent_if_directory(merge,
2424 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
2425 discard_cache_entry(merge);
2426 return -1;
2429 invalidate_ce_path(old, o);
2432 if (do_add_entry(o, merge, update, CE_STAGEMASK) < 0)
2433 return -1;
2434 return 1;
2437 static int deleted_entry(const struct cache_entry *ce,
2438 const struct cache_entry *old,
2439 struct unpack_trees_options *o)
2441 /* Did it exist in the index? */
2442 if (!old) {
2443 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2444 return -1;
2445 return 0;
2446 } else if (verify_absent_if_directory(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o)) {
2447 return -1;
2450 if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
2451 return -1;
2452 add_entry(o, ce, CE_REMOVE, 0);
2453 invalidate_ce_path(ce, o);
2454 return 1;
2457 static int keep_entry(const struct cache_entry *ce,
2458 struct unpack_trees_options *o)
2460 add_entry(o, ce, 0, 0);
2461 if (ce_stage(ce))
2462 invalidate_ce_path(ce, o);
2463 return 1;
2466 #if DBRT_DEBUG
2467 static void show_stage_entry(FILE *o,
2468 const char *label, const struct cache_entry *ce)
2470 if (!ce)
2471 fprintf(o, "%s (missing)\n", label);
2472 else
2473 fprintf(o, "%s%06o %s %d\t%s\n",
2474 label,
2475 ce->ce_mode,
2476 oid_to_hex(&ce->oid),
2477 ce_stage(ce),
2478 ce->name);
2480 #endif
2482 int threeway_merge(const struct cache_entry * const *stages,
2483 struct unpack_trees_options *o)
2485 const struct cache_entry *index;
2486 const struct cache_entry *head;
2487 const struct cache_entry *remote = stages[o->head_idx + 1];
2488 int count;
2489 int head_match = 0;
2490 int remote_match = 0;
2492 int df_conflict_head = 0;
2493 int df_conflict_remote = 0;
2495 int any_anc_missing = 0;
2496 int no_anc_exists = 1;
2497 int i;
2499 for (i = 1; i < o->head_idx; i++) {
2500 if (!stages[i] || stages[i] == o->df_conflict_entry)
2501 any_anc_missing = 1;
2502 else
2503 no_anc_exists = 0;
2506 index = stages[0];
2507 head = stages[o->head_idx];
2509 if (head == o->df_conflict_entry) {
2510 df_conflict_head = 1;
2511 head = NULL;
2514 if (remote == o->df_conflict_entry) {
2515 df_conflict_remote = 1;
2516 remote = NULL;
2520 * First, if there's a #16 situation, note that to prevent #13
2521 * and #14.
2523 if (!same(remote, head)) {
2524 for (i = 1; i < o->head_idx; i++) {
2525 if (same(stages[i], head)) {
2526 head_match = i;
2528 if (same(stages[i], remote)) {
2529 remote_match = i;
2535 * We start with cases where the index is allowed to match
2536 * something other than the head: #14(ALT) and #2ALT, where it
2537 * is permitted to match the result instead.
2539 /* #14, #14ALT, #2ALT */
2540 if (remote && !df_conflict_head && head_match && !remote_match) {
2541 if (index && !same(index, remote) && !same(index, head))
2542 return reject_merge(index, o);
2543 return merged_entry(remote, index, o);
2546 * If we have an entry in the index cache, then we want to
2547 * make sure that it matches head.
2549 if (index && !same(index, head))
2550 return reject_merge(index, o);
2552 if (head) {
2553 /* #5ALT, #15 */
2554 if (same(head, remote))
2555 return merged_entry(head, index, o);
2556 /* #13, #3ALT */
2557 if (!df_conflict_remote && remote_match && !head_match)
2558 return merged_entry(head, index, o);
2561 /* #1 */
2562 if (!head && !remote && any_anc_missing)
2563 return 0;
2566 * Under the "aggressive" rule, we resolve mostly trivial
2567 * cases that we historically had git-merge-one-file resolve.
2569 if (o->aggressive) {
2570 int head_deleted = !head;
2571 int remote_deleted = !remote;
2572 const struct cache_entry *ce = NULL;
2574 if (index)
2575 ce = index;
2576 else if (head)
2577 ce = head;
2578 else if (remote)
2579 ce = remote;
2580 else {
2581 for (i = 1; i < o->head_idx; i++) {
2582 if (stages[i] && stages[i] != o->df_conflict_entry) {
2583 ce = stages[i];
2584 break;
2590 * Deleted in both.
2591 * Deleted in one and unchanged in the other.
2593 if ((head_deleted && remote_deleted) ||
2594 (head_deleted && remote && remote_match) ||
2595 (remote_deleted && head && head_match)) {
2596 if (index)
2597 return deleted_entry(index, index, o);
2598 if (ce && !head_deleted) {
2599 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2600 return -1;
2602 return 0;
2605 * Added in both, identically.
2607 if (no_anc_exists && head && remote && same(head, remote))
2608 return merged_entry(head, index, o);
2612 /* Below are "no merge" cases, which require that the index be
2613 * up-to-date to avoid the files getting overwritten with
2614 * conflict resolution files.
2616 if (index) {
2617 if (verify_uptodate(index, o))
2618 return -1;
2621 o->nontrivial_merge = 1;
2623 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2624 count = 0;
2625 if (!head_match || !remote_match) {
2626 for (i = 1; i < o->head_idx; i++) {
2627 if (stages[i] && stages[i] != o->df_conflict_entry) {
2628 keep_entry(stages[i], o);
2629 count++;
2630 break;
2634 #if DBRT_DEBUG
2635 else {
2636 fprintf(stderr, "read-tree: warning #16 detected\n");
2637 show_stage_entry(stderr, "head ", stages[head_match]);
2638 show_stage_entry(stderr, "remote ", stages[remote_match]);
2640 #endif
2641 if (head) { count += keep_entry(head, o); }
2642 if (remote) { count += keep_entry(remote, o); }
2643 return count;
2647 * Two-way merge.
2649 * The rule is to "carry forward" what is in the index without losing
2650 * information across a "fast-forward", favoring a successful merge
2651 * over a merge failure when it makes sense. For details of the
2652 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2655 int twoway_merge(const struct cache_entry * const *src,
2656 struct unpack_trees_options *o)
2658 const struct cache_entry *current = src[0];
2659 const struct cache_entry *oldtree = src[1];
2660 const struct cache_entry *newtree = src[2];
2662 if (o->merge_size != 2)
2663 return error("Cannot do a twoway merge of %d trees",
2664 o->merge_size);
2666 if (oldtree == o->df_conflict_entry)
2667 oldtree = NULL;
2668 if (newtree == o->df_conflict_entry)
2669 newtree = NULL;
2671 if (current) {
2672 if (current->ce_flags & CE_CONFLICTED) {
2673 if (same(oldtree, newtree) || o->reset) {
2674 if (!newtree)
2675 return deleted_entry(current, current, o);
2676 else
2677 return merged_entry(newtree, current, o);
2679 return reject_merge(current, o);
2680 } else if ((!oldtree && !newtree) || /* 4 and 5 */
2681 (!oldtree && newtree &&
2682 same(current, newtree)) || /* 6 and 7 */
2683 (oldtree && newtree &&
2684 same(oldtree, newtree)) || /* 14 and 15 */
2685 (oldtree && newtree &&
2686 !same(oldtree, newtree) && /* 18 and 19 */
2687 same(current, newtree))) {
2688 return keep_entry(current, o);
2689 } else if (oldtree && !newtree && same(current, oldtree)) {
2690 /* 10 or 11 */
2691 return deleted_entry(oldtree, current, o);
2692 } else if (oldtree && newtree &&
2693 same(current, oldtree) && !same(current, newtree)) {
2694 /* 20 or 21 */
2695 return merged_entry(newtree, current, o);
2696 } else if (current && !oldtree && newtree &&
2697 S_ISSPARSEDIR(current->ce_mode) != S_ISSPARSEDIR(newtree->ce_mode) &&
2698 ce_stage(current) == 0) {
2700 * This case is a directory/file conflict across the sparse-index
2701 * boundary. When we are changing from one path to another via
2702 * 'git checkout', then we want to replace one entry with another
2703 * via merged_entry(). If there are staged changes, then we should
2704 * reject the merge instead.
2706 return merged_entry(newtree, current, o);
2707 } else
2708 return reject_merge(current, o);
2710 else if (newtree) {
2711 if (oldtree && !o->initial_checkout) {
2713 * deletion of the path was staged;
2715 if (same(oldtree, newtree))
2716 return 1;
2717 return reject_merge(oldtree, o);
2719 return merged_entry(newtree, current, o);
2721 return deleted_entry(oldtree, current, o);
2725 * Bind merge.
2727 * Keep the index entries at stage0, collapse stage1 but make sure
2728 * stage0 does not have anything there.
2730 int bind_merge(const struct cache_entry * const *src,
2731 struct unpack_trees_options *o)
2733 const struct cache_entry *old = src[0];
2734 const struct cache_entry *a = src[1];
2736 if (o->merge_size != 1)
2737 return error("Cannot do a bind merge of %d trees",
2738 o->merge_size);
2739 if (a && old)
2740 return o->quiet ? -1 :
2741 error(ERRORMSG(o, ERROR_BIND_OVERLAP),
2742 super_prefixed(a->name),
2743 super_prefixed(old->name));
2744 if (!a)
2745 return keep_entry(old, o);
2746 else
2747 return merged_entry(a, NULL, o);
2751 * One-way merge.
2753 * The rule is:
2754 * - take the stat information from stage0, take the data from stage1
2756 int oneway_merge(const struct cache_entry * const *src,
2757 struct unpack_trees_options *o)
2759 const struct cache_entry *old = src[0];
2760 const struct cache_entry *a = src[1];
2762 if (o->merge_size != 1)
2763 return error("Cannot do a oneway merge of %d trees",
2764 o->merge_size);
2766 if (!a || a == o->df_conflict_entry)
2767 return deleted_entry(old, old, o);
2769 if (old && same(old, a)) {
2770 int update = 0;
2771 if (o->reset && o->update && !ce_uptodate(old) && !ce_skip_worktree(old) &&
2772 !(old->ce_flags & CE_FSMONITOR_VALID)) {
2773 struct stat st;
2774 if (lstat(old->name, &st) ||
2775 ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
2776 update |= CE_UPDATE;
2778 if (o->update && S_ISGITLINK(old->ce_mode) &&
2779 should_update_submodules() && !verify_uptodate(old, o))
2780 update |= CE_UPDATE;
2781 add_entry(o, old, update, CE_STAGEMASK);
2782 return 0;
2784 return merged_entry(a, old, o);
2788 * Merge worktree and untracked entries in a stash entry.
2790 * Ignore all index entries. Collapse remaining trees but make sure that they
2791 * don't have any conflicting files.
2793 int stash_worktree_untracked_merge(const struct cache_entry * const *src,
2794 struct unpack_trees_options *o)
2796 const struct cache_entry *worktree = src[1];
2797 const struct cache_entry *untracked = src[2];
2799 if (o->merge_size != 2)
2800 BUG("invalid merge_size: %d", o->merge_size);
2802 if (worktree && untracked)
2803 return error(_("worktree and untracked commit have duplicate entries: %s"),
2804 super_prefixed(worktree->name));
2806 return merged_entry(worktree ? worktree : untracked, NULL, o);