submodule--helper: add push-check subcommand
[git/git-svn.git] / unpack-trees.c
blob8333da2cc908d7ea373e3d67fbf3ac6526d9019d
1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
2 #include "cache.h"
3 #include "dir.h"
4 #include "tree.h"
5 #include "tree-walk.h"
6 #include "cache-tree.h"
7 #include "unpack-trees.h"
8 #include "progress.h"
9 #include "refs.h"
10 #include "attr.h"
11 #include "split-index.h"
12 #include "dir.h"
13 #include "submodule.h"
14 #include "submodule-config.h"
17 * Error messages expected by scripts out of plumbing commands such as
18 * read-tree. Non-scripted Porcelain is not required to use these messages
19 * and in fact are encouraged to reword them to better suit their particular
20 * situation better. See how "git checkout" and "git merge" replaces
21 * them using setup_unpack_trees_porcelain(), for example.
23 static const char *unpack_plumbing_errors[NB_UNPACK_TREES_ERROR_TYPES] = {
24 /* ERROR_WOULD_OVERWRITE */
25 "Entry '%s' would be overwritten by merge. Cannot merge.",
27 /* ERROR_NOT_UPTODATE_FILE */
28 "Entry '%s' not uptodate. Cannot merge.",
30 /* ERROR_NOT_UPTODATE_DIR */
31 "Updating '%s' would lose untracked files in it",
33 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
34 "Untracked working tree file '%s' would be overwritten by merge.",
36 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
37 "Untracked working tree file '%s' would be removed by merge.",
39 /* ERROR_BIND_OVERLAP */
40 "Entry '%s' overlaps with '%s'. Cannot bind.",
42 /* ERROR_SPARSE_NOT_UPTODATE_FILE */
43 "Entry '%s' not uptodate. Cannot update sparse checkout.",
45 /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
46 "Working tree file '%s' would be overwritten by sparse checkout update.",
48 /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
49 "Working tree file '%s' would be removed by sparse checkout update.",
51 /* ERROR_WOULD_LOSE_SUBMODULE */
52 "Submodule '%s' cannot checkout new HEAD.",
55 #define ERRORMSG(o,type) \
56 ( ((o) && (o)->msgs[(type)]) \
57 ? ((o)->msgs[(type)]) \
58 : (unpack_plumbing_errors[(type)]) )
60 static const char *super_prefixed(const char *path)
63 * It is necessary and sufficient to have two static buffers
64 * here, as the return value of this function is fed to
65 * error() using the unpack_*_errors[] templates we see above.
67 static struct strbuf buf[2] = {STRBUF_INIT, STRBUF_INIT};
68 static int super_prefix_len = -1;
69 static unsigned idx = ARRAY_SIZE(buf) - 1;
71 if (super_prefix_len < 0) {
72 const char *super_prefix = get_super_prefix();
73 if (!super_prefix) {
74 super_prefix_len = 0;
75 } else {
76 int i;
77 for (i = 0; i < ARRAY_SIZE(buf); i++)
78 strbuf_addstr(&buf[i], super_prefix);
79 super_prefix_len = buf[0].len;
83 if (!super_prefix_len)
84 return path;
86 if (++idx >= ARRAY_SIZE(buf))
87 idx = 0;
89 strbuf_setlen(&buf[idx], super_prefix_len);
90 strbuf_addstr(&buf[idx], path);
92 return buf[idx].buf;
95 void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
96 const char *cmd)
98 int i;
99 const char **msgs = opts->msgs;
100 const char *msg;
102 if (!strcmp(cmd, "checkout"))
103 msg = advice_commit_before_merge
104 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
105 "Please commit your changes or stash them before you switch branches.")
106 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
107 else if (!strcmp(cmd, "merge"))
108 msg = advice_commit_before_merge
109 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
110 "Please commit your changes or stash them before you merge.")
111 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
112 else
113 msg = advice_commit_before_merge
114 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
115 "Please commit your changes or stash them before you %s.")
116 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
117 msgs[ERROR_WOULD_OVERWRITE] = msgs[ERROR_NOT_UPTODATE_FILE] =
118 xstrfmt(msg, cmd, cmd);
120 msgs[ERROR_NOT_UPTODATE_DIR] =
121 _("Updating the following directories would lose untracked files in them:\n%s");
123 if (!strcmp(cmd, "checkout"))
124 msg = advice_commit_before_merge
125 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
126 "Please move or remove them before you switch branches.")
127 : _("The following untracked working tree files would be removed by checkout:\n%%s");
128 else if (!strcmp(cmd, "merge"))
129 msg = advice_commit_before_merge
130 ? _("The following untracked working tree files would be removed by merge:\n%%s"
131 "Please move or remove them before you merge.")
132 : _("The following untracked working tree files would be removed by merge:\n%%s");
133 else
134 msg = advice_commit_before_merge
135 ? _("The following untracked working tree files would be removed by %s:\n%%s"
136 "Please move or remove them before you %s.")
137 : _("The following untracked working tree files would be removed by %s:\n%%s");
138 msgs[ERROR_WOULD_LOSE_UNTRACKED_REMOVED] = xstrfmt(msg, cmd, cmd);
140 if (!strcmp(cmd, "checkout"))
141 msg = advice_commit_before_merge
142 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
143 "Please move or remove them before you switch branches.")
144 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
145 else if (!strcmp(cmd, "merge"))
146 msg = advice_commit_before_merge
147 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
148 "Please move or remove them before you merge.")
149 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
150 else
151 msg = advice_commit_before_merge
152 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
153 "Please move or remove them before you %s.")
154 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
155 msgs[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN] = xstrfmt(msg, cmd, cmd);
158 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
159 * cannot easily display it as a list.
161 msgs[ERROR_BIND_OVERLAP] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
163 msgs[ERROR_SPARSE_NOT_UPTODATE_FILE] =
164 _("Cannot update sparse checkout: the following entries are not up-to-date:\n%s");
165 msgs[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN] =
166 _("The following working tree files would be overwritten by sparse checkout update:\n%s");
167 msgs[ERROR_WOULD_LOSE_ORPHANED_REMOVED] =
168 _("The following working tree files would be removed by sparse checkout update:\n%s");
169 msgs[ERROR_WOULD_LOSE_SUBMODULE] =
170 _("Submodule '%s' cannot checkout new HEAD");
172 opts->show_all_errors = 1;
173 /* rejected paths may not have a static buffer */
174 for (i = 0; i < ARRAY_SIZE(opts->unpack_rejects); i++)
175 opts->unpack_rejects[i].strdup_strings = 1;
178 static int do_add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
179 unsigned int set, unsigned int clear)
181 clear |= CE_HASHED;
183 if (set & CE_REMOVE)
184 set |= CE_WT_REMOVE;
186 ce->ce_flags = (ce->ce_flags & ~clear) | set;
187 return add_index_entry(&o->result, ce,
188 ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
191 static struct cache_entry *dup_entry(const struct cache_entry *ce)
193 unsigned int size = ce_size(ce);
194 struct cache_entry *new = xmalloc(size);
196 memcpy(new, ce, size);
197 return new;
200 static void add_entry(struct unpack_trees_options *o,
201 const struct cache_entry *ce,
202 unsigned int set, unsigned int clear)
204 do_add_entry(o, dup_entry(ce), set, clear);
208 * add error messages on path <path>
209 * corresponding to the type <e> with the message <msg>
210 * indicating if it should be display in porcelain or not
212 static int add_rejected_path(struct unpack_trees_options *o,
213 enum unpack_trees_error_types e,
214 const char *path)
216 if (!o->show_all_errors)
217 return error(ERRORMSG(o, e), super_prefixed(path));
220 * Otherwise, insert in a list for future display by
221 * display_error_msgs()
223 string_list_append(&o->unpack_rejects[e], path);
224 return -1;
228 * display all the error messages stored in a nice way
230 static void display_error_msgs(struct unpack_trees_options *o)
232 int e, i;
233 int something_displayed = 0;
234 for (e = 0; e < NB_UNPACK_TREES_ERROR_TYPES; e++) {
235 struct string_list *rejects = &o->unpack_rejects[e];
236 if (rejects->nr > 0) {
237 struct strbuf path = STRBUF_INIT;
238 something_displayed = 1;
239 for (i = 0; i < rejects->nr; i++)
240 strbuf_addf(&path, "\t%s\n", rejects->items[i].string);
241 error(ERRORMSG(o, e), super_prefixed(path.buf));
242 strbuf_release(&path);
244 string_list_clear(rejects, 0);
246 if (something_displayed)
247 fprintf(stderr, _("Aborting\n"));
250 static int check_submodule_move_head(const struct cache_entry *ce,
251 const char *old_id,
252 const char *new_id,
253 struct unpack_trees_options *o)
255 const struct submodule *sub = submodule_from_ce(ce);
256 if (!sub)
257 return 0;
259 switch (sub->update_strategy.type) {
260 case SM_UPDATE_UNSPECIFIED:
261 case SM_UPDATE_CHECKOUT:
262 if (submodule_move_head(ce->name, old_id, new_id, SUBMODULE_MOVE_HEAD_DRY_RUN))
263 return o->gently ? -1 :
264 add_rejected_path(o, ERROR_WOULD_LOSE_SUBMODULE, ce->name);
265 return 0;
266 case SM_UPDATE_NONE:
267 return 0;
268 case SM_UPDATE_REBASE:
269 case SM_UPDATE_MERGE:
270 case SM_UPDATE_COMMAND:
271 default:
272 warning(_("submodule update strategy not supported for submodule '%s'"), ce->name);
273 return -1;
277 static void reload_gitmodules_file(struct index_state *index,
278 struct checkout *state)
280 int i;
281 for (i = 0; i < index->cache_nr; i++) {
282 struct cache_entry *ce = index->cache[i];
283 if (ce->ce_flags & CE_UPDATE) {
284 int r = strcmp(ce->name, ".gitmodules");
285 if (r < 0)
286 continue;
287 else if (r == 0) {
288 submodule_free();
289 checkout_entry(ce, state, NULL);
290 gitmodules_config();
291 git_config(submodule_config, NULL);
292 } else
293 break;
299 * Unlink the last component and schedule the leading directories for
300 * removal, such that empty directories get removed.
302 static void unlink_entry(const struct cache_entry *ce)
304 const struct submodule *sub = submodule_from_ce(ce);
305 if (sub) {
306 switch (sub->update_strategy.type) {
307 case SM_UPDATE_UNSPECIFIED:
308 case SM_UPDATE_CHECKOUT:
309 case SM_UPDATE_REBASE:
310 case SM_UPDATE_MERGE:
311 submodule_move_head(ce->name, "HEAD", NULL,
312 SUBMODULE_MOVE_HEAD_FORCE);
313 break;
314 case SM_UPDATE_NONE:
315 case SM_UPDATE_COMMAND:
316 return; /* Do not touch the submodule. */
319 if (!check_leading_path(ce->name, ce_namelen(ce)))
320 return;
321 if (remove_or_warn(ce->ce_mode, ce->name))
322 return;
323 schedule_dir_for_removal(ce->name, ce_namelen(ce));
326 static struct progress *get_progress(struct unpack_trees_options *o)
328 unsigned cnt = 0, total = 0;
329 struct index_state *index = &o->result;
331 if (!o->update || !o->verbose_update)
332 return NULL;
334 for (; cnt < index->cache_nr; cnt++) {
335 const struct cache_entry *ce = index->cache[cnt];
336 if (ce->ce_flags & (CE_UPDATE | CE_WT_REMOVE))
337 total++;
340 return start_progress_delay(_("Checking out files"),
341 total, 50, 1);
344 static int check_updates(struct unpack_trees_options *o)
346 unsigned cnt = 0;
347 int errs = 0;
348 struct progress *progress = NULL;
349 struct index_state *index = &o->result;
350 struct checkout state = CHECKOUT_INIT;
351 int i;
353 state.force = 1;
354 state.quiet = 1;
355 state.refresh_cache = 1;
356 state.istate = index;
358 progress = get_progress(o);
360 if (o->update)
361 git_attr_set_direction(GIT_ATTR_CHECKOUT, index);
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)
368 unlink_entry(ce);
371 remove_marked_cache_entries(index);
372 remove_scheduled_dirs();
374 if (should_update_submodules() && o->update && !o->dry_run)
375 reload_gitmodules_file(index, &state);
377 for (i = 0; i < index->cache_nr; i++) {
378 struct cache_entry *ce = index->cache[i];
380 if (ce->ce_flags & CE_UPDATE) {
381 if (ce->ce_flags & CE_WT_REMOVE)
382 die("BUG: both update and delete flags are set on %s",
383 ce->name);
384 display_progress(progress, ++cnt);
385 ce->ce_flags &= ~CE_UPDATE;
386 if (o->update && !o->dry_run) {
387 errs |= checkout_entry(ce, &state, NULL);
391 stop_progress(&progress);
392 if (o->update)
393 git_attr_set_direction(GIT_ATTR_CHECKIN, NULL);
394 return errs != 0;
397 static int verify_uptodate_sparse(const struct cache_entry *ce,
398 struct unpack_trees_options *o);
399 static int verify_absent_sparse(const struct cache_entry *ce,
400 enum unpack_trees_error_types,
401 struct unpack_trees_options *o);
403 static int apply_sparse_checkout(struct index_state *istate,
404 struct cache_entry *ce,
405 struct unpack_trees_options *o)
407 int was_skip_worktree = ce_skip_worktree(ce);
409 if (ce->ce_flags & CE_NEW_SKIP_WORKTREE)
410 ce->ce_flags |= CE_SKIP_WORKTREE;
411 else
412 ce->ce_flags &= ~CE_SKIP_WORKTREE;
413 if (was_skip_worktree != ce_skip_worktree(ce)) {
414 ce->ce_flags |= CE_UPDATE_IN_BASE;
415 istate->cache_changed |= CE_ENTRY_CHANGED;
419 * if (!was_skip_worktree && !ce_skip_worktree()) {
420 * This is perfectly normal. Move on;
425 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
426 * area as a result of ce_skip_worktree() shortcuts in
427 * verify_absent() and verify_uptodate().
428 * Make sure they don't modify worktree if they are already
429 * outside checkout area
431 if (was_skip_worktree && ce_skip_worktree(ce)) {
432 ce->ce_flags &= ~CE_UPDATE;
435 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
436 * on to get that file removed from both index and worktree.
437 * If that file is already outside worktree area, don't
438 * bother remove it.
440 if (ce->ce_flags & CE_REMOVE)
441 ce->ce_flags &= ~CE_WT_REMOVE;
444 if (!was_skip_worktree && ce_skip_worktree(ce)) {
446 * If CE_UPDATE is set, verify_uptodate() must be called already
447 * also stat info may have lost after merged_entry() so calling
448 * verify_uptodate() again may fail
450 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
451 return -1;
452 ce->ce_flags |= CE_WT_REMOVE;
453 ce->ce_flags &= ~CE_UPDATE;
455 if (was_skip_worktree && !ce_skip_worktree(ce)) {
456 if (verify_absent_sparse(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
457 return -1;
458 ce->ce_flags |= CE_UPDATE;
460 return 0;
463 static inline int call_unpack_fn(const struct cache_entry * const *src,
464 struct unpack_trees_options *o)
466 int ret = o->fn(src, o);
467 if (ret > 0)
468 ret = 0;
469 return ret;
472 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
474 ce->ce_flags |= CE_UNPACKED;
476 if (o->cache_bottom < o->src_index->cache_nr &&
477 o->src_index->cache[o->cache_bottom] == ce) {
478 int bottom = o->cache_bottom;
479 while (bottom < o->src_index->cache_nr &&
480 o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
481 bottom++;
482 o->cache_bottom = bottom;
486 static void mark_all_ce_unused(struct index_state *index)
488 int i;
489 for (i = 0; i < index->cache_nr; i++)
490 index->cache[i]->ce_flags &= ~(CE_UNPACKED | CE_ADDED | CE_NEW_SKIP_WORKTREE);
493 static int locate_in_src_index(const struct cache_entry *ce,
494 struct unpack_trees_options *o)
496 struct index_state *index = o->src_index;
497 int len = ce_namelen(ce);
498 int pos = index_name_pos(index, ce->name, len);
499 if (pos < 0)
500 pos = -1 - pos;
501 return pos;
505 * We call unpack_index_entry() with an unmerged cache entry
506 * only in diff-index, and it wants a single callback. Skip
507 * the other unmerged entry with the same name.
509 static void mark_ce_used_same_name(struct cache_entry *ce,
510 struct unpack_trees_options *o)
512 struct index_state *index = o->src_index;
513 int len = ce_namelen(ce);
514 int pos;
516 for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
517 struct cache_entry *next = index->cache[pos];
518 if (len != ce_namelen(next) ||
519 memcmp(ce->name, next->name, len))
520 break;
521 mark_ce_used(next, o);
525 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o)
527 const struct index_state *index = o->src_index;
528 int pos = o->cache_bottom;
530 while (pos < index->cache_nr) {
531 struct cache_entry *ce = index->cache[pos];
532 if (!(ce->ce_flags & CE_UNPACKED))
533 return ce;
534 pos++;
536 return NULL;
539 static void add_same_unmerged(const struct cache_entry *ce,
540 struct unpack_trees_options *o)
542 struct index_state *index = o->src_index;
543 int len = ce_namelen(ce);
544 int pos = index_name_pos(index, ce->name, len);
546 if (0 <= pos)
547 die("programming error in a caller of mark_ce_used_same_name");
548 for (pos = -pos - 1; pos < index->cache_nr; pos++) {
549 struct cache_entry *next = index->cache[pos];
550 if (len != ce_namelen(next) ||
551 memcmp(ce->name, next->name, len))
552 break;
553 add_entry(o, next, 0, 0);
554 mark_ce_used(next, o);
558 static int unpack_index_entry(struct cache_entry *ce,
559 struct unpack_trees_options *o)
561 const struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
562 int ret;
564 src[0] = ce;
566 mark_ce_used(ce, o);
567 if (ce_stage(ce)) {
568 if (o->skip_unmerged) {
569 add_entry(o, ce, 0, 0);
570 return 0;
573 ret = call_unpack_fn(src, o);
574 if (ce_stage(ce))
575 mark_ce_used_same_name(ce, o);
576 return ret;
579 static int find_cache_pos(struct traverse_info *, const struct name_entry *);
581 static void restore_cache_bottom(struct traverse_info *info, int bottom)
583 struct unpack_trees_options *o = info->data;
585 if (o->diff_index_cached)
586 return;
587 o->cache_bottom = bottom;
590 static int switch_cache_bottom(struct traverse_info *info)
592 struct unpack_trees_options *o = info->data;
593 int ret, pos;
595 if (o->diff_index_cached)
596 return 0;
597 ret = o->cache_bottom;
598 pos = find_cache_pos(info->prev, &info->name);
600 if (pos < -1)
601 o->cache_bottom = -2 - pos;
602 else if (pos < 0)
603 o->cache_bottom = o->src_index->cache_nr;
604 return ret;
607 static int traverse_trees_recursive(int n, unsigned long dirmask,
608 unsigned long df_conflicts,
609 struct name_entry *names,
610 struct traverse_info *info)
612 int i, ret, bottom;
613 struct tree_desc t[MAX_UNPACK_TREES];
614 void *buf[MAX_UNPACK_TREES];
615 struct traverse_info newinfo;
616 struct name_entry *p;
618 p = names;
619 while (!p->mode)
620 p++;
622 newinfo = *info;
623 newinfo.prev = info;
624 newinfo.pathspec = info->pathspec;
625 newinfo.name = *p;
626 newinfo.pathlen += tree_entry_len(p) + 1;
627 newinfo.df_conflicts |= df_conflicts;
629 for (i = 0; i < n; i++, dirmask >>= 1) {
630 const unsigned char *sha1 = NULL;
631 if (dirmask & 1)
632 sha1 = names[i].oid->hash;
633 buf[i] = fill_tree_descriptor(t+i, sha1);
636 bottom = switch_cache_bottom(&newinfo);
637 ret = traverse_trees(n, t, &newinfo);
638 restore_cache_bottom(&newinfo, bottom);
640 for (i = 0; i < n; i++)
641 free(buf[i]);
643 return ret;
647 * Compare the traverse-path to the cache entry without actually
648 * having to generate the textual representation of the traverse
649 * path.
651 * NOTE! This *only* compares up to the size of the traverse path
652 * itself - the caller needs to do the final check for the cache
653 * entry having more data at the end!
655 static int do_compare_entry_piecewise(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
657 int len, pathlen, ce_len;
658 const char *ce_name;
660 if (info->prev) {
661 int cmp = do_compare_entry_piecewise(ce, info->prev,
662 &info->name);
663 if (cmp)
664 return cmp;
666 pathlen = info->pathlen;
667 ce_len = ce_namelen(ce);
669 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
670 if (ce_len < pathlen)
671 return -1;
673 ce_len -= pathlen;
674 ce_name = ce->name + pathlen;
676 len = tree_entry_len(n);
677 return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
680 static int do_compare_entry(const struct cache_entry *ce,
681 const struct traverse_info *info,
682 const struct name_entry *n)
684 int len, pathlen, ce_len;
685 const char *ce_name;
686 int cmp;
689 * If we have not precomputed the traverse path, it is quicker
690 * to avoid doing so. But if we have precomputed it,
691 * it is quicker to use the precomputed version.
693 if (!info->traverse_path)
694 return do_compare_entry_piecewise(ce, info, n);
696 cmp = strncmp(ce->name, info->traverse_path, info->pathlen);
697 if (cmp)
698 return cmp;
700 pathlen = info->pathlen;
701 ce_len = ce_namelen(ce);
703 if (ce_len < pathlen)
704 return -1;
706 ce_len -= pathlen;
707 ce_name = ce->name + pathlen;
709 len = tree_entry_len(n);
710 return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
713 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
715 int cmp = do_compare_entry(ce, info, n);
716 if (cmp)
717 return cmp;
720 * Even if the beginning compared identically, the ce should
721 * compare as bigger than a directory leading up to it!
723 return ce_namelen(ce) > traverse_path_len(info, n);
726 static int ce_in_traverse_path(const struct cache_entry *ce,
727 const struct traverse_info *info)
729 if (!info->prev)
730 return 1;
731 if (do_compare_entry(ce, info->prev, &info->name))
732 return 0;
734 * If ce (blob) is the same name as the path (which is a tree
735 * we will be descending into), it won't be inside it.
737 return (info->pathlen < ce_namelen(ce));
740 static struct cache_entry *create_ce_entry(const struct traverse_info *info, const struct name_entry *n, int stage)
742 int len = traverse_path_len(info, n);
743 struct cache_entry *ce = xcalloc(1, cache_entry_size(len));
745 ce->ce_mode = create_ce_mode(n->mode);
746 ce->ce_flags = create_ce_flags(stage);
747 ce->ce_namelen = len;
748 oidcpy(&ce->oid, n->oid);
749 make_traverse_path(ce->name, info, n);
751 return ce;
754 static int unpack_nondirectories(int n, unsigned long mask,
755 unsigned long dirmask,
756 struct cache_entry **src,
757 const struct name_entry *names,
758 const struct traverse_info *info)
760 int i;
761 struct unpack_trees_options *o = info->data;
762 unsigned long conflicts = info->df_conflicts | dirmask;
764 /* Do we have *only* directories? Nothing to do */
765 if (mask == dirmask && !src[0])
766 return 0;
769 * Ok, we've filled in up to any potential index entry in src[0],
770 * now do the rest.
772 for (i = 0; i < n; i++) {
773 int stage;
774 unsigned int bit = 1ul << i;
775 if (conflicts & bit) {
776 src[i + o->merge] = o->df_conflict_entry;
777 continue;
779 if (!(mask & bit))
780 continue;
781 if (!o->merge)
782 stage = 0;
783 else if (i + 1 < o->head_idx)
784 stage = 1;
785 else if (i + 1 > o->head_idx)
786 stage = 3;
787 else
788 stage = 2;
789 src[i + o->merge] = create_ce_entry(info, names + i, stage);
792 if (o->merge) {
793 int rc = call_unpack_fn((const struct cache_entry * const *)src,
795 for (i = 0; i < n; i++) {
796 struct cache_entry *ce = src[i + o->merge];
797 if (ce != o->df_conflict_entry)
798 free(ce);
800 return rc;
803 for (i = 0; i < n; i++)
804 if (src[i] && src[i] != o->df_conflict_entry)
805 if (do_add_entry(o, src[i], 0, 0))
806 return -1;
808 return 0;
811 static int unpack_failed(struct unpack_trees_options *o, const char *message)
813 discard_index(&o->result);
814 if (!o->gently && !o->exiting_early) {
815 if (message)
816 return error("%s", message);
817 return -1;
819 return -1;
823 * The tree traversal is looking at name p. If we have a matching entry,
824 * return it. If name p is a directory in the index, do not return
825 * anything, as we will want to match it when the traversal descends into
826 * the directory.
828 static int find_cache_pos(struct traverse_info *info,
829 const struct name_entry *p)
831 int pos;
832 struct unpack_trees_options *o = info->data;
833 struct index_state *index = o->src_index;
834 int pfxlen = info->pathlen;
835 int p_len = tree_entry_len(p);
837 for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
838 const struct cache_entry *ce = index->cache[pos];
839 const char *ce_name, *ce_slash;
840 int cmp, ce_len;
842 if (ce->ce_flags & CE_UNPACKED) {
844 * cache_bottom entry is already unpacked, so
845 * we can never match it; don't check it
846 * again.
848 if (pos == o->cache_bottom)
849 ++o->cache_bottom;
850 continue;
852 if (!ce_in_traverse_path(ce, info)) {
854 * Check if we can skip future cache checks
855 * (because we're already past all possible
856 * entries in the traverse path).
858 if (info->traverse_path) {
859 if (strncmp(ce->name, info->traverse_path,
860 info->pathlen) > 0)
861 break;
863 continue;
865 ce_name = ce->name + pfxlen;
866 ce_slash = strchr(ce_name, '/');
867 if (ce_slash)
868 ce_len = ce_slash - ce_name;
869 else
870 ce_len = ce_namelen(ce) - pfxlen;
871 cmp = name_compare(p->path, p_len, ce_name, ce_len);
873 * Exact match; if we have a directory we need to
874 * delay returning it.
876 if (!cmp)
877 return ce_slash ? -2 - pos : pos;
878 if (0 < cmp)
879 continue; /* keep looking */
881 * ce_name sorts after p->path; could it be that we
882 * have files under p->path directory in the index?
883 * E.g. ce_name == "t-i", and p->path == "t"; we may
884 * have "t/a" in the index.
886 if (p_len < ce_len && !memcmp(ce_name, p->path, p_len) &&
887 ce_name[p_len] < '/')
888 continue; /* keep looking */
889 break;
891 return -1;
894 static struct cache_entry *find_cache_entry(struct traverse_info *info,
895 const struct name_entry *p)
897 int pos = find_cache_pos(info, p);
898 struct unpack_trees_options *o = info->data;
900 if (0 <= pos)
901 return o->src_index->cache[pos];
902 else
903 return NULL;
906 static void debug_path(struct traverse_info *info)
908 if (info->prev) {
909 debug_path(info->prev);
910 if (*info->prev->name.path)
911 putchar('/');
913 printf("%s", info->name.path);
916 static void debug_name_entry(int i, struct name_entry *n)
918 printf("ent#%d %06o %s\n", i,
919 n->path ? n->mode : 0,
920 n->path ? n->path : "(missing)");
923 static void debug_unpack_callback(int n,
924 unsigned long mask,
925 unsigned long dirmask,
926 struct name_entry *names,
927 struct traverse_info *info)
929 int i;
930 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
931 mask, dirmask, n);
932 debug_path(info);
933 putchar('\n');
934 for (i = 0; i < n; i++)
935 debug_name_entry(i, names + i);
938 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
940 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
941 struct unpack_trees_options *o = info->data;
942 const struct name_entry *p = names;
944 /* Find first entry with a real name (we could use "mask" too) */
945 while (!p->mode)
946 p++;
948 if (o->debug_unpack)
949 debug_unpack_callback(n, mask, dirmask, names, info);
951 /* Are we supposed to look at the index too? */
952 if (o->merge) {
953 while (1) {
954 int cmp;
955 struct cache_entry *ce;
957 if (o->diff_index_cached)
958 ce = next_cache_entry(o);
959 else
960 ce = find_cache_entry(info, p);
962 if (!ce)
963 break;
964 cmp = compare_entry(ce, info, p);
965 if (cmp < 0) {
966 if (unpack_index_entry(ce, o) < 0)
967 return unpack_failed(o, NULL);
968 continue;
970 if (!cmp) {
971 if (ce_stage(ce)) {
973 * If we skip unmerged index
974 * entries, we'll skip this
975 * entry *and* the tree
976 * entries associated with it!
978 if (o->skip_unmerged) {
979 add_same_unmerged(ce, o);
980 return mask;
983 src[0] = ce;
985 break;
989 if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
990 return -1;
992 if (o->merge && src[0]) {
993 if (ce_stage(src[0]))
994 mark_ce_used_same_name(src[0], o);
995 else
996 mark_ce_used(src[0], o);
999 /* Now handle any directories.. */
1000 if (dirmask) {
1001 /* special case: "diff-index --cached" looking at a tree */
1002 if (o->diff_index_cached &&
1003 n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
1004 int matches;
1005 matches = cache_tree_matches_traversal(o->src_index->cache_tree,
1006 names, info);
1008 * Everything under the name matches; skip the
1009 * entire hierarchy. diff_index_cached codepath
1010 * special cases D/F conflicts in such a way that
1011 * it does not do any look-ahead, so this is safe.
1013 if (matches) {
1014 o->cache_bottom += matches;
1015 return mask;
1019 if (traverse_trees_recursive(n, dirmask, mask & ~dirmask,
1020 names, info) < 0)
1021 return -1;
1022 return mask;
1025 return mask;
1028 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1029 struct strbuf *prefix,
1030 int select_mask, int clear_mask,
1031 struct exclude_list *el, int defval);
1033 /* Whole directory matching */
1034 static int clear_ce_flags_dir(struct cache_entry **cache, int nr,
1035 struct strbuf *prefix,
1036 char *basename,
1037 int select_mask, int clear_mask,
1038 struct exclude_list *el, int defval)
1040 struct cache_entry **cache_end;
1041 int dtype = DT_DIR;
1042 int ret = is_excluded_from_list(prefix->buf, prefix->len,
1043 basename, &dtype, el);
1044 int rc;
1046 strbuf_addch(prefix, '/');
1048 /* If undecided, use matching result of parent dir in defval */
1049 if (ret < 0)
1050 ret = defval;
1052 for (cache_end = cache; cache_end != cache + nr; cache_end++) {
1053 struct cache_entry *ce = *cache_end;
1054 if (strncmp(ce->name, prefix->buf, prefix->len))
1055 break;
1059 * TODO: check el, if there are no patterns that may conflict
1060 * with ret (iow, we know in advance the incl/excl
1061 * decision for the entire directory), clear flag here without
1062 * calling clear_ce_flags_1(). That function will call
1063 * the expensive is_excluded_from_list() on every entry.
1065 rc = clear_ce_flags_1(cache, cache_end - cache,
1066 prefix,
1067 select_mask, clear_mask,
1068 el, ret);
1069 strbuf_setlen(prefix, prefix->len - 1);
1070 return rc;
1074 * Traverse the index, find every entry that matches according to
1075 * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
1076 * number of traversed entries.
1078 * If select_mask is non-zero, only entries whose ce_flags has on of
1079 * those bits enabled are traversed.
1081 * cache : pointer to an index entry
1082 * prefix_len : an offset to its path
1084 * The current path ("prefix") including the trailing '/' is
1085 * cache[0]->name[0..(prefix_len-1)]
1086 * Top level path has prefix_len zero.
1088 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1089 struct strbuf *prefix,
1090 int select_mask, int clear_mask,
1091 struct exclude_list *el, int defval)
1093 struct cache_entry **cache_end = cache + nr;
1096 * Process all entries that have the given prefix and meet
1097 * select_mask condition
1099 while(cache != cache_end) {
1100 struct cache_entry *ce = *cache;
1101 const char *name, *slash;
1102 int len, dtype, ret;
1104 if (select_mask && !(ce->ce_flags & select_mask)) {
1105 cache++;
1106 continue;
1109 if (prefix->len && strncmp(ce->name, prefix->buf, prefix->len))
1110 break;
1112 name = ce->name + prefix->len;
1113 slash = strchr(name, '/');
1115 /* If it's a directory, try whole directory match first */
1116 if (slash) {
1117 int processed;
1119 len = slash - name;
1120 strbuf_add(prefix, name, len);
1122 processed = clear_ce_flags_dir(cache, cache_end - cache,
1123 prefix,
1124 prefix->buf + prefix->len - len,
1125 select_mask, clear_mask,
1126 el, defval);
1128 /* clear_c_f_dir eats a whole dir already? */
1129 if (processed) {
1130 cache += processed;
1131 strbuf_setlen(prefix, prefix->len - len);
1132 continue;
1135 strbuf_addch(prefix, '/');
1136 cache += clear_ce_flags_1(cache, cache_end - cache,
1137 prefix,
1138 select_mask, clear_mask, el, defval);
1139 strbuf_setlen(prefix, prefix->len - len - 1);
1140 continue;
1143 /* Non-directory */
1144 dtype = ce_to_dtype(ce);
1145 ret = is_excluded_from_list(ce->name, ce_namelen(ce),
1146 name, &dtype, el);
1147 if (ret < 0)
1148 ret = defval;
1149 if (ret > 0)
1150 ce->ce_flags &= ~clear_mask;
1151 cache++;
1153 return nr - (cache_end - cache);
1156 static int clear_ce_flags(struct cache_entry **cache, int nr,
1157 int select_mask, int clear_mask,
1158 struct exclude_list *el)
1160 static struct strbuf prefix = STRBUF_INIT;
1162 strbuf_reset(&prefix);
1164 return clear_ce_flags_1(cache, nr,
1165 &prefix,
1166 select_mask, clear_mask,
1167 el, 0);
1171 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1173 static void mark_new_skip_worktree(struct exclude_list *el,
1174 struct index_state *the_index,
1175 int select_flag, int skip_wt_flag)
1177 int i;
1180 * 1. Pretend the narrowest worktree: only unmerged entries
1181 * are checked out
1183 for (i = 0; i < the_index->cache_nr; i++) {
1184 struct cache_entry *ce = the_index->cache[i];
1186 if (select_flag && !(ce->ce_flags & select_flag))
1187 continue;
1189 if (!ce_stage(ce))
1190 ce->ce_flags |= skip_wt_flag;
1191 else
1192 ce->ce_flags &= ~skip_wt_flag;
1196 * 2. Widen worktree according to sparse-checkout file.
1197 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1199 clear_ce_flags(the_index->cache, the_index->cache_nr,
1200 select_flag, skip_wt_flag, el);
1203 static int verify_absent(const struct cache_entry *,
1204 enum unpack_trees_error_types,
1205 struct unpack_trees_options *);
1207 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1208 * resulting index, -2 on failure to reflect the changes to the work tree.
1210 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1212 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
1214 int i, ret;
1215 static struct cache_entry *dfc;
1216 struct exclude_list el;
1218 if (len > MAX_UNPACK_TREES)
1219 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
1221 memset(&el, 0, sizeof(el));
1222 if (!core_apply_sparse_checkout || !o->update)
1223 o->skip_sparse_checkout = 1;
1224 if (!o->skip_sparse_checkout) {
1225 char *sparse = git_pathdup("info/sparse-checkout");
1226 if (add_excludes_from_file_to_list(sparse, "", 0, &el, 0) < 0)
1227 o->skip_sparse_checkout = 1;
1228 else
1229 o->el = &el;
1230 free(sparse);
1233 memset(&o->result, 0, sizeof(o->result));
1234 o->result.initialized = 1;
1235 o->result.timestamp.sec = o->src_index->timestamp.sec;
1236 o->result.timestamp.nsec = o->src_index->timestamp.nsec;
1237 o->result.version = o->src_index->version;
1238 o->result.split_index = o->src_index->split_index;
1239 if (o->result.split_index)
1240 o->result.split_index->refcount++;
1241 hashcpy(o->result.sha1, o->src_index->sha1);
1242 o->merge_size = len;
1243 mark_all_ce_unused(o->src_index);
1246 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1248 if (!o->skip_sparse_checkout)
1249 mark_new_skip_worktree(o->el, o->src_index, 0, CE_NEW_SKIP_WORKTREE);
1251 if (!dfc)
1252 dfc = xcalloc(1, cache_entry_size(0));
1253 o->df_conflict_entry = dfc;
1255 if (len) {
1256 const char *prefix = o->prefix ? o->prefix : "";
1257 struct traverse_info info;
1259 setup_traverse_info(&info, prefix);
1260 info.fn = unpack_callback;
1261 info.data = o;
1262 info.show_all_errors = o->show_all_errors;
1263 info.pathspec = o->pathspec;
1265 if (o->prefix) {
1267 * Unpack existing index entries that sort before the
1268 * prefix the tree is spliced into. Note that o->merge
1269 * is always true in this case.
1271 while (1) {
1272 struct cache_entry *ce = next_cache_entry(o);
1273 if (!ce)
1274 break;
1275 if (ce_in_traverse_path(ce, &info))
1276 break;
1277 if (unpack_index_entry(ce, o) < 0)
1278 goto return_failed;
1282 if (traverse_trees(len, t, &info) < 0)
1283 goto return_failed;
1286 /* Any left-over entries in the index? */
1287 if (o->merge) {
1288 while (1) {
1289 struct cache_entry *ce = next_cache_entry(o);
1290 if (!ce)
1291 break;
1292 if (unpack_index_entry(ce, o) < 0)
1293 goto return_failed;
1296 mark_all_ce_unused(o->src_index);
1298 if (o->trivial_merges_only && o->nontrivial_merge) {
1299 ret = unpack_failed(o, "Merge requires file-level merging");
1300 goto done;
1303 if (!o->skip_sparse_checkout) {
1304 int empty_worktree = 1;
1307 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1308 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1309 * so apply_sparse_checkout() won't attempt to remove it from worktree
1311 mark_new_skip_worktree(o->el, &o->result, CE_ADDED, CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1313 ret = 0;
1314 for (i = 0; i < o->result.cache_nr; i++) {
1315 struct cache_entry *ce = o->result.cache[i];
1318 * Entries marked with CE_ADDED in merged_entry() do not have
1319 * verify_absent() check (the check is effectively disabled
1320 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1322 * Do the real check now because we have had
1323 * correct CE_NEW_SKIP_WORKTREE
1325 if (ce->ce_flags & CE_ADDED &&
1326 verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1327 if (!o->show_all_errors)
1328 goto return_failed;
1329 ret = -1;
1332 if (apply_sparse_checkout(&o->result, ce, o)) {
1333 if (!o->show_all_errors)
1334 goto return_failed;
1335 ret = -1;
1337 if (!ce_skip_worktree(ce))
1338 empty_worktree = 0;
1341 if (ret < 0)
1342 goto return_failed;
1344 * Sparse checkout is meant to narrow down checkout area
1345 * but it does not make sense to narrow down to empty working
1346 * tree. This is usually a mistake in sparse checkout rules.
1347 * Do not allow users to do that.
1349 if (o->result.cache_nr && empty_worktree) {
1350 ret = unpack_failed(o, "Sparse checkout leaves no entry on working directory");
1351 goto done;
1355 o->src_index = NULL;
1356 ret = check_updates(o) ? (-2) : 0;
1357 if (o->dst_index) {
1358 if (!ret) {
1359 if (!o->result.cache_tree)
1360 o->result.cache_tree = cache_tree();
1361 if (!cache_tree_fully_valid(o->result.cache_tree))
1362 cache_tree_update(&o->result,
1363 WRITE_TREE_SILENT |
1364 WRITE_TREE_REPAIR);
1366 discard_index(o->dst_index);
1367 *o->dst_index = o->result;
1368 } else {
1369 discard_index(&o->result);
1372 done:
1373 clear_exclude_list(&el);
1374 return ret;
1376 return_failed:
1377 if (o->show_all_errors)
1378 display_error_msgs(o);
1379 mark_all_ce_unused(o->src_index);
1380 ret = unpack_failed(o, NULL);
1381 if (o->exiting_early)
1382 ret = 0;
1383 goto done;
1386 /* Here come the merge functions */
1388 static int reject_merge(const struct cache_entry *ce,
1389 struct unpack_trees_options *o)
1391 return o->gently ? -1 :
1392 add_rejected_path(o, ERROR_WOULD_OVERWRITE, ce->name);
1395 static int same(const struct cache_entry *a, const struct cache_entry *b)
1397 if (!!a != !!b)
1398 return 0;
1399 if (!a && !b)
1400 return 1;
1401 if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
1402 return 0;
1403 return a->ce_mode == b->ce_mode &&
1404 !oidcmp(&a->oid, &b->oid);
1409 * When a CE gets turned into an unmerged entry, we
1410 * want it to be up-to-date
1412 static int verify_uptodate_1(const struct cache_entry *ce,
1413 struct unpack_trees_options *o,
1414 enum unpack_trees_error_types error_type)
1416 struct stat st;
1418 if (o->index_only)
1419 return 0;
1422 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1423 * if this entry is truly up-to-date because this file may be
1424 * overwritten.
1426 if ((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce))
1427 ; /* keep checking */
1428 else if (o->reset || ce_uptodate(ce))
1429 return 0;
1431 if (!lstat(ce->name, &st)) {
1432 int flags = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE;
1433 unsigned changed = ie_match_stat(o->src_index, ce, &st, flags);
1435 if (submodule_from_ce(ce)) {
1436 int r = check_submodule_move_head(ce,
1437 "HEAD", oid_to_hex(&ce->oid), o);
1438 if (r)
1439 return o->gently ? -1 :
1440 add_rejected_path(o, error_type, ce->name);
1441 return 0;
1444 if (!changed)
1445 return 0;
1447 * Historic default policy was to allow submodule to be out
1448 * of sync wrt the superproject index. If the submodule was
1449 * not considered interesting above, we don't care here.
1451 if (S_ISGITLINK(ce->ce_mode))
1452 return 0;
1454 errno = 0;
1456 if (errno == ENOENT)
1457 return 0;
1458 return o->gently ? -1 :
1459 add_rejected_path(o, error_type, ce->name);
1462 static int verify_uptodate(const struct cache_entry *ce,
1463 struct unpack_trees_options *o)
1465 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1466 return 0;
1467 return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
1470 static int verify_uptodate_sparse(const struct cache_entry *ce,
1471 struct unpack_trees_options *o)
1473 return verify_uptodate_1(ce, o, ERROR_SPARSE_NOT_UPTODATE_FILE);
1476 static void invalidate_ce_path(const struct cache_entry *ce,
1477 struct unpack_trees_options *o)
1479 if (!ce)
1480 return;
1481 cache_tree_invalidate_path(o->src_index, ce->name);
1482 untracked_cache_invalidate_path(o->src_index, ce->name);
1486 * Check that checking out ce->sha1 in subdir ce->name is not
1487 * going to overwrite any working files.
1489 * Currently, git does not checkout subprojects during a superproject
1490 * checkout, so it is not going to overwrite anything.
1492 static int verify_clean_submodule(const char *old_sha1,
1493 const struct cache_entry *ce,
1494 enum unpack_trees_error_types error_type,
1495 struct unpack_trees_options *o)
1497 if (!submodule_from_ce(ce))
1498 return 0;
1500 return check_submodule_move_head(ce, old_sha1,
1501 oid_to_hex(&ce->oid), o);
1504 static int verify_clean_subdirectory(const struct cache_entry *ce,
1505 enum unpack_trees_error_types error_type,
1506 struct unpack_trees_options *o)
1509 * we are about to extract "ce->name"; we would not want to lose
1510 * anything in the existing directory there.
1512 int namelen;
1513 int i;
1514 struct dir_struct d;
1515 char *pathbuf;
1516 int cnt = 0;
1518 if (S_ISGITLINK(ce->ce_mode)) {
1519 unsigned char sha1[20];
1520 int sub_head = resolve_gitlink_ref(ce->name, "HEAD", sha1);
1522 * If we are not going to update the submodule, then
1523 * we don't care.
1525 if (!sub_head && !hashcmp(sha1, ce->oid.hash))
1526 return 0;
1527 return verify_clean_submodule(sub_head ? NULL : sha1_to_hex(sha1),
1528 ce, error_type, o);
1532 * First let's make sure we do not have a local modification
1533 * in that directory.
1535 namelen = ce_namelen(ce);
1536 for (i = locate_in_src_index(ce, o);
1537 i < o->src_index->cache_nr;
1538 i++) {
1539 struct cache_entry *ce2 = o->src_index->cache[i];
1540 int len = ce_namelen(ce2);
1541 if (len < namelen ||
1542 strncmp(ce->name, ce2->name, namelen) ||
1543 ce2->name[namelen] != '/')
1544 break;
1546 * ce2->name is an entry in the subdirectory to be
1547 * removed.
1549 if (!ce_stage(ce2)) {
1550 if (verify_uptodate(ce2, o))
1551 return -1;
1552 add_entry(o, ce2, CE_REMOVE, 0);
1553 mark_ce_used(ce2, o);
1555 cnt++;
1559 * Then we need to make sure that we do not lose a locally
1560 * present file that is not ignored.
1562 pathbuf = xstrfmt("%.*s/", namelen, ce->name);
1564 memset(&d, 0, sizeof(d));
1565 if (o->dir)
1566 d.exclude_per_dir = o->dir->exclude_per_dir;
1567 i = read_directory(&d, pathbuf, namelen+1, NULL);
1568 if (i)
1569 return o->gently ? -1 :
1570 add_rejected_path(o, ERROR_NOT_UPTODATE_DIR, ce->name);
1571 free(pathbuf);
1572 return cnt;
1576 * This gets called when there was no index entry for the tree entry 'dst',
1577 * but we found a file in the working tree that 'lstat()' said was fine,
1578 * and we're on a case-insensitive filesystem.
1580 * See if we can find a case-insensitive match in the index that also
1581 * matches the stat information, and assume it's that other file!
1583 static int icase_exists(struct unpack_trees_options *o, const char *name, int len, struct stat *st)
1585 const struct cache_entry *src;
1587 src = index_file_exists(o->src_index, name, len, 1);
1588 return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
1591 static int check_ok_to_remove(const char *name, int len, int dtype,
1592 const struct cache_entry *ce, struct stat *st,
1593 enum unpack_trees_error_types error_type,
1594 struct unpack_trees_options *o)
1596 const struct cache_entry *result;
1599 * It may be that the 'lstat()' succeeded even though
1600 * target 'ce' was absent, because there is an old
1601 * entry that is different only in case..
1603 * Ignore that lstat() if it matches.
1605 if (ignore_case && icase_exists(o, name, len, st))
1606 return 0;
1608 if (o->dir &&
1609 is_excluded(o->dir, name, &dtype))
1611 * ce->name is explicitly excluded, so it is Ok to
1612 * overwrite it.
1614 return 0;
1615 if (S_ISDIR(st->st_mode)) {
1617 * We are checking out path "foo" and
1618 * found "foo/." in the working tree.
1619 * This is tricky -- if we have modified
1620 * files that are in "foo/" we would lose
1621 * them.
1623 if (verify_clean_subdirectory(ce, error_type, o) < 0)
1624 return -1;
1625 return 0;
1629 * The previous round may already have decided to
1630 * delete this path, which is in a subdirectory that
1631 * is being replaced with a blob.
1633 result = index_file_exists(&o->result, name, len, 0);
1634 if (result) {
1635 if (result->ce_flags & CE_REMOVE)
1636 return 0;
1639 return o->gently ? -1 :
1640 add_rejected_path(o, error_type, name);
1644 * We do not want to remove or overwrite a working tree file that
1645 * is not tracked, unless it is ignored.
1647 static int verify_absent_1(const struct cache_entry *ce,
1648 enum unpack_trees_error_types error_type,
1649 struct unpack_trees_options *o)
1651 int len;
1652 struct stat st;
1654 if (o->index_only || o->reset || !o->update)
1655 return 0;
1657 len = check_leading_path(ce->name, ce_namelen(ce));
1658 if (!len)
1659 return 0;
1660 else if (len > 0) {
1661 char *path;
1662 int ret;
1664 path = xmemdupz(ce->name, len);
1665 if (lstat(path, &st))
1666 ret = error_errno("cannot stat '%s'", path);
1667 else {
1668 if (submodule_from_ce(ce))
1669 ret = check_submodule_move_head(ce,
1670 oid_to_hex(&ce->oid),
1671 NULL, o);
1672 else
1673 ret = check_ok_to_remove(path, len, DT_UNKNOWN, NULL,
1674 &st, error_type, o);
1676 free(path);
1677 return ret;
1678 } else if (lstat(ce->name, &st)) {
1679 if (errno != ENOENT)
1680 return error_errno("cannot stat '%s'", ce->name);
1681 return 0;
1682 } else {
1683 if (submodule_from_ce(ce))
1684 return check_submodule_move_head(ce, oid_to_hex(&ce->oid),
1685 NULL, o);
1687 return check_ok_to_remove(ce->name, ce_namelen(ce),
1688 ce_to_dtype(ce), ce, &st,
1689 error_type, o);
1693 static int verify_absent(const struct cache_entry *ce,
1694 enum unpack_trees_error_types error_type,
1695 struct unpack_trees_options *o)
1697 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1698 return 0;
1699 return verify_absent_1(ce, error_type, o);
1702 static int verify_absent_sparse(const struct cache_entry *ce,
1703 enum unpack_trees_error_types error_type,
1704 struct unpack_trees_options *o)
1706 enum unpack_trees_error_types orphaned_error = error_type;
1707 if (orphaned_error == ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN)
1708 orphaned_error = ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN;
1710 return verify_absent_1(ce, orphaned_error, o);
1713 static int merged_entry(const struct cache_entry *ce,
1714 const struct cache_entry *old,
1715 struct unpack_trees_options *o)
1717 int update = CE_UPDATE;
1718 struct cache_entry *merge = dup_entry(ce);
1720 if (!old) {
1722 * New index entries. In sparse checkout, the following
1723 * verify_absent() will be delayed until after
1724 * traverse_trees() finishes in unpack_trees(), then:
1726 * - CE_NEW_SKIP_WORKTREE will be computed correctly
1727 * - verify_absent() be called again, this time with
1728 * correct CE_NEW_SKIP_WORKTREE
1730 * verify_absent() call here does nothing in sparse
1731 * checkout (i.e. o->skip_sparse_checkout == 0)
1733 update |= CE_ADDED;
1734 merge->ce_flags |= CE_NEW_SKIP_WORKTREE;
1736 if (verify_absent(merge,
1737 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1738 free(merge);
1739 return -1;
1741 invalidate_ce_path(merge, o);
1743 if (submodule_from_ce(ce)) {
1744 int ret = check_submodule_move_head(ce, NULL,
1745 oid_to_hex(&ce->oid),
1747 if (ret)
1748 return ret;
1751 } else if (!(old->ce_flags & CE_CONFLICTED)) {
1753 * See if we can re-use the old CE directly?
1754 * That way we get the uptodate stat info.
1756 * This also removes the UPDATE flag on a match; otherwise
1757 * we will end up overwriting local changes in the work tree.
1759 if (same(old, merge)) {
1760 copy_cache_entry(merge, old);
1761 update = 0;
1762 } else {
1763 if (verify_uptodate(old, o)) {
1764 free(merge);
1765 return -1;
1767 /* Migrate old flags over */
1768 update |= old->ce_flags & (CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1769 invalidate_ce_path(old, o);
1772 if (submodule_from_ce(ce)) {
1773 int ret = check_submodule_move_head(ce, oid_to_hex(&old->oid),
1774 oid_to_hex(&ce->oid),
1776 if (ret)
1777 return ret;
1779 } else {
1781 * Previously unmerged entry left as an existence
1782 * marker by read_index_unmerged();
1784 invalidate_ce_path(old, o);
1787 do_add_entry(o, merge, update, CE_STAGEMASK);
1788 return 1;
1791 static int deleted_entry(const struct cache_entry *ce,
1792 const struct cache_entry *old,
1793 struct unpack_trees_options *o)
1795 /* Did it exist in the index? */
1796 if (!old) {
1797 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1798 return -1;
1799 return 0;
1801 if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
1802 return -1;
1803 add_entry(o, ce, CE_REMOVE, 0);
1804 invalidate_ce_path(ce, o);
1805 return 1;
1808 static int keep_entry(const struct cache_entry *ce,
1809 struct unpack_trees_options *o)
1811 add_entry(o, ce, 0, 0);
1812 return 1;
1815 #if DBRT_DEBUG
1816 static void show_stage_entry(FILE *o,
1817 const char *label, const struct cache_entry *ce)
1819 if (!ce)
1820 fprintf(o, "%s (missing)\n", label);
1821 else
1822 fprintf(o, "%s%06o %s %d\t%s\n",
1823 label,
1824 ce->ce_mode,
1825 oid_to_hex(&ce->oid),
1826 ce_stage(ce),
1827 ce->name);
1829 #endif
1831 int threeway_merge(const struct cache_entry * const *stages,
1832 struct unpack_trees_options *o)
1834 const struct cache_entry *index;
1835 const struct cache_entry *head;
1836 const struct cache_entry *remote = stages[o->head_idx + 1];
1837 int count;
1838 int head_match = 0;
1839 int remote_match = 0;
1841 int df_conflict_head = 0;
1842 int df_conflict_remote = 0;
1844 int any_anc_missing = 0;
1845 int no_anc_exists = 1;
1846 int i;
1848 for (i = 1; i < o->head_idx; i++) {
1849 if (!stages[i] || stages[i] == o->df_conflict_entry)
1850 any_anc_missing = 1;
1851 else
1852 no_anc_exists = 0;
1855 index = stages[0];
1856 head = stages[o->head_idx];
1858 if (head == o->df_conflict_entry) {
1859 df_conflict_head = 1;
1860 head = NULL;
1863 if (remote == o->df_conflict_entry) {
1864 df_conflict_remote = 1;
1865 remote = NULL;
1869 * First, if there's a #16 situation, note that to prevent #13
1870 * and #14.
1872 if (!same(remote, head)) {
1873 for (i = 1; i < o->head_idx; i++) {
1874 if (same(stages[i], head)) {
1875 head_match = i;
1877 if (same(stages[i], remote)) {
1878 remote_match = i;
1884 * We start with cases where the index is allowed to match
1885 * something other than the head: #14(ALT) and #2ALT, where it
1886 * is permitted to match the result instead.
1888 /* #14, #14ALT, #2ALT */
1889 if (remote && !df_conflict_head && head_match && !remote_match) {
1890 if (index && !same(index, remote) && !same(index, head))
1891 return reject_merge(index, o);
1892 return merged_entry(remote, index, o);
1895 * If we have an entry in the index cache, then we want to
1896 * make sure that it matches head.
1898 if (index && !same(index, head))
1899 return reject_merge(index, o);
1901 if (head) {
1902 /* #5ALT, #15 */
1903 if (same(head, remote))
1904 return merged_entry(head, index, o);
1905 /* #13, #3ALT */
1906 if (!df_conflict_remote && remote_match && !head_match)
1907 return merged_entry(head, index, o);
1910 /* #1 */
1911 if (!head && !remote && any_anc_missing)
1912 return 0;
1915 * Under the "aggressive" rule, we resolve mostly trivial
1916 * cases that we historically had git-merge-one-file resolve.
1918 if (o->aggressive) {
1919 int head_deleted = !head;
1920 int remote_deleted = !remote;
1921 const struct cache_entry *ce = NULL;
1923 if (index)
1924 ce = index;
1925 else if (head)
1926 ce = head;
1927 else if (remote)
1928 ce = remote;
1929 else {
1930 for (i = 1; i < o->head_idx; i++) {
1931 if (stages[i] && stages[i] != o->df_conflict_entry) {
1932 ce = stages[i];
1933 break;
1939 * Deleted in both.
1940 * Deleted in one and unchanged in the other.
1942 if ((head_deleted && remote_deleted) ||
1943 (head_deleted && remote && remote_match) ||
1944 (remote_deleted && head && head_match)) {
1945 if (index)
1946 return deleted_entry(index, index, o);
1947 if (ce && !head_deleted) {
1948 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1949 return -1;
1951 return 0;
1954 * Added in both, identically.
1956 if (no_anc_exists && head && remote && same(head, remote))
1957 return merged_entry(head, index, o);
1961 /* Below are "no merge" cases, which require that the index be
1962 * up-to-date to avoid the files getting overwritten with
1963 * conflict resolution files.
1965 if (index) {
1966 if (verify_uptodate(index, o))
1967 return -1;
1970 o->nontrivial_merge = 1;
1972 /* #2, #3, #4, #6, #7, #9, #10, #11. */
1973 count = 0;
1974 if (!head_match || !remote_match) {
1975 for (i = 1; i < o->head_idx; i++) {
1976 if (stages[i] && stages[i] != o->df_conflict_entry) {
1977 keep_entry(stages[i], o);
1978 count++;
1979 break;
1983 #if DBRT_DEBUG
1984 else {
1985 fprintf(stderr, "read-tree: warning #16 detected\n");
1986 show_stage_entry(stderr, "head ", stages[head_match]);
1987 show_stage_entry(stderr, "remote ", stages[remote_match]);
1989 #endif
1990 if (head) { count += keep_entry(head, o); }
1991 if (remote) { count += keep_entry(remote, o); }
1992 return count;
1996 * Two-way merge.
1998 * The rule is to "carry forward" what is in the index without losing
1999 * information across a "fast-forward", favoring a successful merge
2000 * over a merge failure when it makes sense. For details of the
2001 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2004 int twoway_merge(const struct cache_entry * const *src,
2005 struct unpack_trees_options *o)
2007 const struct cache_entry *current = src[0];
2008 const struct cache_entry *oldtree = src[1];
2009 const struct cache_entry *newtree = src[2];
2011 if (o->merge_size != 2)
2012 return error("Cannot do a twoway merge of %d trees",
2013 o->merge_size);
2015 if (oldtree == o->df_conflict_entry)
2016 oldtree = NULL;
2017 if (newtree == o->df_conflict_entry)
2018 newtree = NULL;
2020 if (current) {
2021 if (current->ce_flags & CE_CONFLICTED) {
2022 if (same(oldtree, newtree) || o->reset) {
2023 if (!newtree)
2024 return deleted_entry(current, current, o);
2025 else
2026 return merged_entry(newtree, current, o);
2028 return reject_merge(current, o);
2029 } else if ((!oldtree && !newtree) || /* 4 and 5 */
2030 (!oldtree && newtree &&
2031 same(current, newtree)) || /* 6 and 7 */
2032 (oldtree && newtree &&
2033 same(oldtree, newtree)) || /* 14 and 15 */
2034 (oldtree && newtree &&
2035 !same(oldtree, newtree) && /* 18 and 19 */
2036 same(current, newtree))) {
2037 return keep_entry(current, o);
2038 } else if (oldtree && !newtree && same(current, oldtree)) {
2039 /* 10 or 11 */
2040 return deleted_entry(oldtree, current, o);
2041 } else if (oldtree && newtree &&
2042 same(current, oldtree) && !same(current, newtree)) {
2043 /* 20 or 21 */
2044 return merged_entry(newtree, current, o);
2045 } else
2046 return reject_merge(current, o);
2048 else if (newtree) {
2049 if (oldtree && !o->initial_checkout) {
2051 * deletion of the path was staged;
2053 if (same(oldtree, newtree))
2054 return 1;
2055 return reject_merge(oldtree, o);
2057 return merged_entry(newtree, current, o);
2059 return deleted_entry(oldtree, current, o);
2063 * Bind merge.
2065 * Keep the index entries at stage0, collapse stage1 but make sure
2066 * stage0 does not have anything there.
2068 int bind_merge(const struct cache_entry * const *src,
2069 struct unpack_trees_options *o)
2071 const struct cache_entry *old = src[0];
2072 const struct cache_entry *a = src[1];
2074 if (o->merge_size != 1)
2075 return error("Cannot do a bind merge of %d trees",
2076 o->merge_size);
2077 if (a && old)
2078 return o->gently ? -1 :
2079 error(ERRORMSG(o, ERROR_BIND_OVERLAP),
2080 super_prefixed(a->name),
2081 super_prefixed(old->name));
2082 if (!a)
2083 return keep_entry(old, o);
2084 else
2085 return merged_entry(a, NULL, o);
2089 * One-way merge.
2091 * The rule is:
2092 * - take the stat information from stage0, take the data from stage1
2094 int oneway_merge(const struct cache_entry * const *src,
2095 struct unpack_trees_options *o)
2097 const struct cache_entry *old = src[0];
2098 const struct cache_entry *a = src[1];
2100 if (o->merge_size != 1)
2101 return error("Cannot do a oneway merge of %d trees",
2102 o->merge_size);
2104 if (!a || a == o->df_conflict_entry)
2105 return deleted_entry(old, old, o);
2107 if (old && same(old, a)) {
2108 int update = 0;
2109 if (o->reset && o->update && !ce_uptodate(old) && !ce_skip_worktree(old)) {
2110 struct stat st;
2111 if (lstat(old->name, &st) ||
2112 ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
2113 update |= CE_UPDATE;
2115 add_entry(o, old, update, 0);
2116 return 0;
2118 return merged_entry(a, old, o);