doc: describe git svn init --ignore-refs
[git/git-svn.git] / unpack-trees.c
blobd38c37e38cf183cf878a9f35b19544d1da0bc438
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 _("Cannot update submodule:\n%s");
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 unsigned flags = SUBMODULE_MOVE_HEAD_DRY_RUN;
256 const struct submodule *sub = submodule_from_ce(ce);
257 if (!sub)
258 return 0;
260 if (o->reset)
261 flags |= SUBMODULE_MOVE_HEAD_FORCE;
263 switch (sub->update_strategy.type) {
264 case SM_UPDATE_UNSPECIFIED:
265 case SM_UPDATE_CHECKOUT:
266 if (submodule_move_head(ce->name, old_id, new_id, flags))
267 return o->gently ? -1 :
268 add_rejected_path(o, ERROR_WOULD_LOSE_SUBMODULE, ce->name);
269 return 0;
270 case SM_UPDATE_NONE:
271 return 0;
272 case SM_UPDATE_REBASE:
273 case SM_UPDATE_MERGE:
274 case SM_UPDATE_COMMAND:
275 default:
276 warning(_("submodule update strategy not supported for submodule '%s'"), ce->name);
277 return -1;
281 static void reload_gitmodules_file(struct index_state *index,
282 struct checkout *state)
284 int i;
285 for (i = 0; i < index->cache_nr; i++) {
286 struct cache_entry *ce = index->cache[i];
287 if (ce->ce_flags & CE_UPDATE) {
288 int r = strcmp(ce->name, ".gitmodules");
289 if (r < 0)
290 continue;
291 else if (r == 0) {
292 submodule_free();
293 checkout_entry(ce, state, NULL);
294 gitmodules_config();
295 git_config(submodule_config, NULL);
296 } else
297 break;
303 * Unlink the last component and schedule the leading directories for
304 * removal, such that empty directories get removed.
306 static void unlink_entry(const struct cache_entry *ce)
308 const struct submodule *sub = submodule_from_ce(ce);
309 if (sub) {
310 switch (sub->update_strategy.type) {
311 case SM_UPDATE_UNSPECIFIED:
312 case SM_UPDATE_CHECKOUT:
313 case SM_UPDATE_REBASE:
314 case SM_UPDATE_MERGE:
315 /* state.force is set at the caller. */
316 submodule_move_head(ce->name, "HEAD", NULL,
317 SUBMODULE_MOVE_HEAD_FORCE);
318 break;
319 case SM_UPDATE_NONE:
320 case SM_UPDATE_COMMAND:
321 return; /* Do not touch the submodule. */
324 if (!check_leading_path(ce->name, ce_namelen(ce)))
325 return;
326 if (remove_or_warn(ce->ce_mode, ce->name))
327 return;
328 schedule_dir_for_removal(ce->name, ce_namelen(ce));
331 static struct progress *get_progress(struct unpack_trees_options *o)
333 unsigned cnt = 0, total = 0;
334 struct index_state *index = &o->result;
336 if (!o->update || !o->verbose_update)
337 return NULL;
339 for (; cnt < index->cache_nr; cnt++) {
340 const struct cache_entry *ce = index->cache[cnt];
341 if (ce->ce_flags & (CE_UPDATE | CE_WT_REMOVE))
342 total++;
345 return start_progress_delay(_("Checking out files"),
346 total, 50, 1);
349 static int check_updates(struct unpack_trees_options *o)
351 unsigned cnt = 0;
352 int errs = 0;
353 struct progress *progress = NULL;
354 struct index_state *index = &o->result;
355 struct checkout state = CHECKOUT_INIT;
356 int i;
358 state.force = 1;
359 state.quiet = 1;
360 state.refresh_cache = 1;
361 state.istate = index;
363 progress = get_progress(o);
365 if (o->update)
366 git_attr_set_direction(GIT_ATTR_CHECKOUT, index);
367 for (i = 0; i < index->cache_nr; i++) {
368 const struct cache_entry *ce = index->cache[i];
370 if (ce->ce_flags & CE_WT_REMOVE) {
371 display_progress(progress, ++cnt);
372 if (o->update && !o->dry_run)
373 unlink_entry(ce);
376 remove_marked_cache_entries(index);
377 remove_scheduled_dirs();
379 if (should_update_submodules() && o->update && !o->dry_run)
380 reload_gitmodules_file(index, &state);
382 for (i = 0; i < index->cache_nr; i++) {
383 struct cache_entry *ce = index->cache[i];
385 if (ce->ce_flags & CE_UPDATE) {
386 if (ce->ce_flags & CE_WT_REMOVE)
387 die("BUG: both update and delete flags are set on %s",
388 ce->name);
389 display_progress(progress, ++cnt);
390 ce->ce_flags &= ~CE_UPDATE;
391 if (o->update && !o->dry_run) {
392 errs |= checkout_entry(ce, &state, NULL);
396 stop_progress(&progress);
397 if (o->update)
398 git_attr_set_direction(GIT_ATTR_CHECKIN, NULL);
399 return errs != 0;
402 static int verify_uptodate_sparse(const struct cache_entry *ce,
403 struct unpack_trees_options *o);
404 static int verify_absent_sparse(const struct cache_entry *ce,
405 enum unpack_trees_error_types,
406 struct unpack_trees_options *o);
408 static int apply_sparse_checkout(struct index_state *istate,
409 struct cache_entry *ce,
410 struct unpack_trees_options *o)
412 int was_skip_worktree = ce_skip_worktree(ce);
414 if (ce->ce_flags & CE_NEW_SKIP_WORKTREE)
415 ce->ce_flags |= CE_SKIP_WORKTREE;
416 else
417 ce->ce_flags &= ~CE_SKIP_WORKTREE;
418 if (was_skip_worktree != ce_skip_worktree(ce)) {
419 ce->ce_flags |= CE_UPDATE_IN_BASE;
420 istate->cache_changed |= CE_ENTRY_CHANGED;
424 * if (!was_skip_worktree && !ce_skip_worktree()) {
425 * This is perfectly normal. Move on;
430 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
431 * area as a result of ce_skip_worktree() shortcuts in
432 * verify_absent() and verify_uptodate().
433 * Make sure they don't modify worktree if they are already
434 * outside checkout area
436 if (was_skip_worktree && ce_skip_worktree(ce)) {
437 ce->ce_flags &= ~CE_UPDATE;
440 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
441 * on to get that file removed from both index and worktree.
442 * If that file is already outside worktree area, don't
443 * bother remove it.
445 if (ce->ce_flags & CE_REMOVE)
446 ce->ce_flags &= ~CE_WT_REMOVE;
449 if (!was_skip_worktree && ce_skip_worktree(ce)) {
451 * If CE_UPDATE is set, verify_uptodate() must be called already
452 * also stat info may have lost after merged_entry() so calling
453 * verify_uptodate() again may fail
455 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
456 return -1;
457 ce->ce_flags |= CE_WT_REMOVE;
458 ce->ce_flags &= ~CE_UPDATE;
460 if (was_skip_worktree && !ce_skip_worktree(ce)) {
461 if (verify_absent_sparse(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
462 return -1;
463 ce->ce_flags |= CE_UPDATE;
465 return 0;
468 static inline int call_unpack_fn(const struct cache_entry * const *src,
469 struct unpack_trees_options *o)
471 int ret = o->fn(src, o);
472 if (ret > 0)
473 ret = 0;
474 return ret;
477 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
479 ce->ce_flags |= CE_UNPACKED;
481 if (o->cache_bottom < o->src_index->cache_nr &&
482 o->src_index->cache[o->cache_bottom] == ce) {
483 int bottom = o->cache_bottom;
484 while (bottom < o->src_index->cache_nr &&
485 o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
486 bottom++;
487 o->cache_bottom = bottom;
491 static void mark_all_ce_unused(struct index_state *index)
493 int i;
494 for (i = 0; i < index->cache_nr; i++)
495 index->cache[i]->ce_flags &= ~(CE_UNPACKED | CE_ADDED | CE_NEW_SKIP_WORKTREE);
498 static int locate_in_src_index(const struct cache_entry *ce,
499 struct unpack_trees_options *o)
501 struct index_state *index = o->src_index;
502 int len = ce_namelen(ce);
503 int pos = index_name_pos(index, ce->name, len);
504 if (pos < 0)
505 pos = -1 - pos;
506 return pos;
510 * We call unpack_index_entry() with an unmerged cache entry
511 * only in diff-index, and it wants a single callback. Skip
512 * the other unmerged entry with the same name.
514 static void mark_ce_used_same_name(struct cache_entry *ce,
515 struct unpack_trees_options *o)
517 struct index_state *index = o->src_index;
518 int len = ce_namelen(ce);
519 int pos;
521 for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
522 struct cache_entry *next = index->cache[pos];
523 if (len != ce_namelen(next) ||
524 memcmp(ce->name, next->name, len))
525 break;
526 mark_ce_used(next, o);
530 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o)
532 const struct index_state *index = o->src_index;
533 int pos = o->cache_bottom;
535 while (pos < index->cache_nr) {
536 struct cache_entry *ce = index->cache[pos];
537 if (!(ce->ce_flags & CE_UNPACKED))
538 return ce;
539 pos++;
541 return NULL;
544 static void add_same_unmerged(const struct cache_entry *ce,
545 struct unpack_trees_options *o)
547 struct index_state *index = o->src_index;
548 int len = ce_namelen(ce);
549 int pos = index_name_pos(index, ce->name, len);
551 if (0 <= pos)
552 die("programming error in a caller of mark_ce_used_same_name");
553 for (pos = -pos - 1; pos < index->cache_nr; pos++) {
554 struct cache_entry *next = index->cache[pos];
555 if (len != ce_namelen(next) ||
556 memcmp(ce->name, next->name, len))
557 break;
558 add_entry(o, next, 0, 0);
559 mark_ce_used(next, o);
563 static int unpack_index_entry(struct cache_entry *ce,
564 struct unpack_trees_options *o)
566 const struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
567 int ret;
569 src[0] = ce;
571 mark_ce_used(ce, o);
572 if (ce_stage(ce)) {
573 if (o->skip_unmerged) {
574 add_entry(o, ce, 0, 0);
575 return 0;
578 ret = call_unpack_fn(src, o);
579 if (ce_stage(ce))
580 mark_ce_used_same_name(ce, o);
581 return ret;
584 static int find_cache_pos(struct traverse_info *, const struct name_entry *);
586 static void restore_cache_bottom(struct traverse_info *info, int bottom)
588 struct unpack_trees_options *o = info->data;
590 if (o->diff_index_cached)
591 return;
592 o->cache_bottom = bottom;
595 static int switch_cache_bottom(struct traverse_info *info)
597 struct unpack_trees_options *o = info->data;
598 int ret, pos;
600 if (o->diff_index_cached)
601 return 0;
602 ret = o->cache_bottom;
603 pos = find_cache_pos(info->prev, &info->name);
605 if (pos < -1)
606 o->cache_bottom = -2 - pos;
607 else if (pos < 0)
608 o->cache_bottom = o->src_index->cache_nr;
609 return ret;
612 static inline int are_same_oid(struct name_entry *name_j, struct name_entry *name_k)
614 return name_j->oid && name_k->oid && !oidcmp(name_j->oid, name_k->oid);
617 static int traverse_trees_recursive(int n, unsigned long dirmask,
618 unsigned long df_conflicts,
619 struct name_entry *names,
620 struct traverse_info *info)
622 int i, ret, bottom;
623 int nr_buf = 0;
624 struct tree_desc t[MAX_UNPACK_TREES];
625 void *buf[MAX_UNPACK_TREES];
626 struct traverse_info newinfo;
627 struct name_entry *p;
629 p = names;
630 while (!p->mode)
631 p++;
633 newinfo = *info;
634 newinfo.prev = info;
635 newinfo.pathspec = info->pathspec;
636 newinfo.name = *p;
637 newinfo.pathlen += tree_entry_len(p) + 1;
638 newinfo.df_conflicts |= df_conflicts;
641 * Fetch the tree from the ODB for each peer directory in the
642 * n commits.
644 * For 2- and 3-way traversals, we try to avoid hitting the
645 * ODB twice for the same OID. This should yield a nice speed
646 * up in checkouts and merges when the commits are similar.
648 * We don't bother doing the full O(n^2) search for larger n,
649 * because wider traversals don't happen that often and we
650 * avoid the search setup.
652 * When 2 peer OIDs are the same, we just copy the tree
653 * descriptor data. This implicitly borrows the buffer
654 * data from the earlier cell.
656 for (i = 0; i < n; i++, dirmask >>= 1) {
657 if (i > 0 && are_same_oid(&names[i], &names[i - 1]))
658 t[i] = t[i - 1];
659 else if (i > 1 && are_same_oid(&names[i], &names[i - 2]))
660 t[i] = t[i - 2];
661 else {
662 const unsigned char *sha1 = NULL;
663 if (dirmask & 1)
664 sha1 = names[i].oid->hash;
665 buf[nr_buf++] = fill_tree_descriptor(t+i, sha1);
669 bottom = switch_cache_bottom(&newinfo);
670 ret = traverse_trees(n, t, &newinfo);
671 restore_cache_bottom(&newinfo, bottom);
673 for (i = 0; i < nr_buf; i++)
674 free(buf[i]);
676 return ret;
680 * Compare the traverse-path to the cache entry without actually
681 * having to generate the textual representation of the traverse
682 * path.
684 * NOTE! This *only* compares up to the size of the traverse path
685 * itself - the caller needs to do the final check for the cache
686 * entry having more data at the end!
688 static int do_compare_entry_piecewise(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
690 int len, pathlen, ce_len;
691 const char *ce_name;
693 if (info->prev) {
694 int cmp = do_compare_entry_piecewise(ce, info->prev,
695 &info->name);
696 if (cmp)
697 return cmp;
699 pathlen = info->pathlen;
700 ce_len = ce_namelen(ce);
702 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
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 do_compare_entry(const struct cache_entry *ce,
714 const struct traverse_info *info,
715 const struct name_entry *n)
717 int len, pathlen, ce_len;
718 const char *ce_name;
719 int cmp;
722 * If we have not precomputed the traverse path, it is quicker
723 * to avoid doing so. But if we have precomputed it,
724 * it is quicker to use the precomputed version.
726 if (!info->traverse_path)
727 return do_compare_entry_piecewise(ce, info, n);
729 cmp = strncmp(ce->name, info->traverse_path, info->pathlen);
730 if (cmp)
731 return cmp;
733 pathlen = info->pathlen;
734 ce_len = ce_namelen(ce);
736 if (ce_len < pathlen)
737 return -1;
739 ce_len -= pathlen;
740 ce_name = ce->name + pathlen;
742 len = tree_entry_len(n);
743 return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
746 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
748 int cmp = do_compare_entry(ce, info, n);
749 if (cmp)
750 return cmp;
753 * Even if the beginning compared identically, the ce should
754 * compare as bigger than a directory leading up to it!
756 return ce_namelen(ce) > traverse_path_len(info, n);
759 static int ce_in_traverse_path(const struct cache_entry *ce,
760 const struct traverse_info *info)
762 if (!info->prev)
763 return 1;
764 if (do_compare_entry(ce, info->prev, &info->name))
765 return 0;
767 * If ce (blob) is the same name as the path (which is a tree
768 * we will be descending into), it won't be inside it.
770 return (info->pathlen < ce_namelen(ce));
773 static struct cache_entry *create_ce_entry(const struct traverse_info *info, const struct name_entry *n, int stage)
775 int len = traverse_path_len(info, n);
776 struct cache_entry *ce = xcalloc(1, cache_entry_size(len));
778 ce->ce_mode = create_ce_mode(n->mode);
779 ce->ce_flags = create_ce_flags(stage);
780 ce->ce_namelen = len;
781 oidcpy(&ce->oid, n->oid);
782 make_traverse_path(ce->name, info, n);
784 return ce;
787 static int unpack_nondirectories(int n, unsigned long mask,
788 unsigned long dirmask,
789 struct cache_entry **src,
790 const struct name_entry *names,
791 const struct traverse_info *info)
793 int i;
794 struct unpack_trees_options *o = info->data;
795 unsigned long conflicts = info->df_conflicts | dirmask;
797 /* Do we have *only* directories? Nothing to do */
798 if (mask == dirmask && !src[0])
799 return 0;
802 * Ok, we've filled in up to any potential index entry in src[0],
803 * now do the rest.
805 for (i = 0; i < n; i++) {
806 int stage;
807 unsigned int bit = 1ul << i;
808 if (conflicts & bit) {
809 src[i + o->merge] = o->df_conflict_entry;
810 continue;
812 if (!(mask & bit))
813 continue;
814 if (!o->merge)
815 stage = 0;
816 else if (i + 1 < o->head_idx)
817 stage = 1;
818 else if (i + 1 > o->head_idx)
819 stage = 3;
820 else
821 stage = 2;
822 src[i + o->merge] = create_ce_entry(info, names + i, stage);
825 if (o->merge) {
826 int rc = call_unpack_fn((const struct cache_entry * const *)src,
828 for (i = 0; i < n; i++) {
829 struct cache_entry *ce = src[i + o->merge];
830 if (ce != o->df_conflict_entry)
831 free(ce);
833 return rc;
836 for (i = 0; i < n; i++)
837 if (src[i] && src[i] != o->df_conflict_entry)
838 if (do_add_entry(o, src[i], 0, 0))
839 return -1;
841 return 0;
844 static int unpack_failed(struct unpack_trees_options *o, const char *message)
846 discard_index(&o->result);
847 if (!o->gently && !o->exiting_early) {
848 if (message)
849 return error("%s", message);
850 return -1;
852 return -1;
856 * The tree traversal is looking at name p. If we have a matching entry,
857 * return it. If name p is a directory in the index, do not return
858 * anything, as we will want to match it when the traversal descends into
859 * the directory.
861 static int find_cache_pos(struct traverse_info *info,
862 const struct name_entry *p)
864 int pos;
865 struct unpack_trees_options *o = info->data;
866 struct index_state *index = o->src_index;
867 int pfxlen = info->pathlen;
868 int p_len = tree_entry_len(p);
870 for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
871 const struct cache_entry *ce = index->cache[pos];
872 const char *ce_name, *ce_slash;
873 int cmp, ce_len;
875 if (ce->ce_flags & CE_UNPACKED) {
877 * cache_bottom entry is already unpacked, so
878 * we can never match it; don't check it
879 * again.
881 if (pos == o->cache_bottom)
882 ++o->cache_bottom;
883 continue;
885 if (!ce_in_traverse_path(ce, info)) {
887 * Check if we can skip future cache checks
888 * (because we're already past all possible
889 * entries in the traverse path).
891 if (info->traverse_path) {
892 if (strncmp(ce->name, info->traverse_path,
893 info->pathlen) > 0)
894 break;
896 continue;
898 ce_name = ce->name + pfxlen;
899 ce_slash = strchr(ce_name, '/');
900 if (ce_slash)
901 ce_len = ce_slash - ce_name;
902 else
903 ce_len = ce_namelen(ce) - pfxlen;
904 cmp = name_compare(p->path, p_len, ce_name, ce_len);
906 * Exact match; if we have a directory we need to
907 * delay returning it.
909 if (!cmp)
910 return ce_slash ? -2 - pos : pos;
911 if (0 < cmp)
912 continue; /* keep looking */
914 * ce_name sorts after p->path; could it be that we
915 * have files under p->path directory in the index?
916 * E.g. ce_name == "t-i", and p->path == "t"; we may
917 * have "t/a" in the index.
919 if (p_len < ce_len && !memcmp(ce_name, p->path, p_len) &&
920 ce_name[p_len] < '/')
921 continue; /* keep looking */
922 break;
924 return -1;
927 static struct cache_entry *find_cache_entry(struct traverse_info *info,
928 const struct name_entry *p)
930 int pos = find_cache_pos(info, p);
931 struct unpack_trees_options *o = info->data;
933 if (0 <= pos)
934 return o->src_index->cache[pos];
935 else
936 return NULL;
939 static void debug_path(struct traverse_info *info)
941 if (info->prev) {
942 debug_path(info->prev);
943 if (*info->prev->name.path)
944 putchar('/');
946 printf("%s", info->name.path);
949 static void debug_name_entry(int i, struct name_entry *n)
951 printf("ent#%d %06o %s\n", i,
952 n->path ? n->mode : 0,
953 n->path ? n->path : "(missing)");
956 static void debug_unpack_callback(int n,
957 unsigned long mask,
958 unsigned long dirmask,
959 struct name_entry *names,
960 struct traverse_info *info)
962 int i;
963 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
964 mask, dirmask, n);
965 debug_path(info);
966 putchar('\n');
967 for (i = 0; i < n; i++)
968 debug_name_entry(i, names + i);
971 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
973 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
974 struct unpack_trees_options *o = info->data;
975 const struct name_entry *p = names;
977 /* Find first entry with a real name (we could use "mask" too) */
978 while (!p->mode)
979 p++;
981 if (o->debug_unpack)
982 debug_unpack_callback(n, mask, dirmask, names, info);
984 /* Are we supposed to look at the index too? */
985 if (o->merge) {
986 while (1) {
987 int cmp;
988 struct cache_entry *ce;
990 if (o->diff_index_cached)
991 ce = next_cache_entry(o);
992 else
993 ce = find_cache_entry(info, p);
995 if (!ce)
996 break;
997 cmp = compare_entry(ce, info, p);
998 if (cmp < 0) {
999 if (unpack_index_entry(ce, o) < 0)
1000 return unpack_failed(o, NULL);
1001 continue;
1003 if (!cmp) {
1004 if (ce_stage(ce)) {
1006 * If we skip unmerged index
1007 * entries, we'll skip this
1008 * entry *and* the tree
1009 * entries associated with it!
1011 if (o->skip_unmerged) {
1012 add_same_unmerged(ce, o);
1013 return mask;
1016 src[0] = ce;
1018 break;
1022 if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
1023 return -1;
1025 if (o->merge && src[0]) {
1026 if (ce_stage(src[0]))
1027 mark_ce_used_same_name(src[0], o);
1028 else
1029 mark_ce_used(src[0], o);
1032 /* Now handle any directories.. */
1033 if (dirmask) {
1034 /* special case: "diff-index --cached" looking at a tree */
1035 if (o->diff_index_cached &&
1036 n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
1037 int matches;
1038 matches = cache_tree_matches_traversal(o->src_index->cache_tree,
1039 names, info);
1041 * Everything under the name matches; skip the
1042 * entire hierarchy. diff_index_cached codepath
1043 * special cases D/F conflicts in such a way that
1044 * it does not do any look-ahead, so this is safe.
1046 if (matches) {
1047 o->cache_bottom += matches;
1048 return mask;
1052 if (traverse_trees_recursive(n, dirmask, mask & ~dirmask,
1053 names, info) < 0)
1054 return -1;
1055 return mask;
1058 return mask;
1061 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1062 struct strbuf *prefix,
1063 int select_mask, int clear_mask,
1064 struct exclude_list *el, int defval);
1066 /* Whole directory matching */
1067 static int clear_ce_flags_dir(struct cache_entry **cache, int nr,
1068 struct strbuf *prefix,
1069 char *basename,
1070 int select_mask, int clear_mask,
1071 struct exclude_list *el, int defval)
1073 struct cache_entry **cache_end;
1074 int dtype = DT_DIR;
1075 int ret = is_excluded_from_list(prefix->buf, prefix->len,
1076 basename, &dtype, el, &the_index);
1077 int rc;
1079 strbuf_addch(prefix, '/');
1081 /* If undecided, use matching result of parent dir in defval */
1082 if (ret < 0)
1083 ret = defval;
1085 for (cache_end = cache; cache_end != cache + nr; cache_end++) {
1086 struct cache_entry *ce = *cache_end;
1087 if (strncmp(ce->name, prefix->buf, prefix->len))
1088 break;
1092 * TODO: check el, if there are no patterns that may conflict
1093 * with ret (iow, we know in advance the incl/excl
1094 * decision for the entire directory), clear flag here without
1095 * calling clear_ce_flags_1(). That function will call
1096 * the expensive is_excluded_from_list() on every entry.
1098 rc = clear_ce_flags_1(cache, cache_end - cache,
1099 prefix,
1100 select_mask, clear_mask,
1101 el, ret);
1102 strbuf_setlen(prefix, prefix->len - 1);
1103 return rc;
1107 * Traverse the index, find every entry that matches according to
1108 * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
1109 * number of traversed entries.
1111 * If select_mask is non-zero, only entries whose ce_flags has on of
1112 * those bits enabled are traversed.
1114 * cache : pointer to an index entry
1115 * prefix_len : an offset to its path
1117 * The current path ("prefix") including the trailing '/' is
1118 * cache[0]->name[0..(prefix_len-1)]
1119 * Top level path has prefix_len zero.
1121 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1122 struct strbuf *prefix,
1123 int select_mask, int clear_mask,
1124 struct exclude_list *el, int defval)
1126 struct cache_entry **cache_end = cache + nr;
1129 * Process all entries that have the given prefix and meet
1130 * select_mask condition
1132 while(cache != cache_end) {
1133 struct cache_entry *ce = *cache;
1134 const char *name, *slash;
1135 int len, dtype, ret;
1137 if (select_mask && !(ce->ce_flags & select_mask)) {
1138 cache++;
1139 continue;
1142 if (prefix->len && strncmp(ce->name, prefix->buf, prefix->len))
1143 break;
1145 name = ce->name + prefix->len;
1146 slash = strchr(name, '/');
1148 /* If it's a directory, try whole directory match first */
1149 if (slash) {
1150 int processed;
1152 len = slash - name;
1153 strbuf_add(prefix, name, len);
1155 processed = clear_ce_flags_dir(cache, cache_end - cache,
1156 prefix,
1157 prefix->buf + prefix->len - len,
1158 select_mask, clear_mask,
1159 el, defval);
1161 /* clear_c_f_dir eats a whole dir already? */
1162 if (processed) {
1163 cache += processed;
1164 strbuf_setlen(prefix, prefix->len - len);
1165 continue;
1168 strbuf_addch(prefix, '/');
1169 cache += clear_ce_flags_1(cache, cache_end - cache,
1170 prefix,
1171 select_mask, clear_mask, el, defval);
1172 strbuf_setlen(prefix, prefix->len - len - 1);
1173 continue;
1176 /* Non-directory */
1177 dtype = ce_to_dtype(ce);
1178 ret = is_excluded_from_list(ce->name, ce_namelen(ce),
1179 name, &dtype, el, &the_index);
1180 if (ret < 0)
1181 ret = defval;
1182 if (ret > 0)
1183 ce->ce_flags &= ~clear_mask;
1184 cache++;
1186 return nr - (cache_end - cache);
1189 static int clear_ce_flags(struct cache_entry **cache, int nr,
1190 int select_mask, int clear_mask,
1191 struct exclude_list *el)
1193 static struct strbuf prefix = STRBUF_INIT;
1195 strbuf_reset(&prefix);
1197 return clear_ce_flags_1(cache, nr,
1198 &prefix,
1199 select_mask, clear_mask,
1200 el, 0);
1204 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1206 static void mark_new_skip_worktree(struct exclude_list *el,
1207 struct index_state *the_index,
1208 int select_flag, int skip_wt_flag)
1210 int i;
1213 * 1. Pretend the narrowest worktree: only unmerged entries
1214 * are checked out
1216 for (i = 0; i < the_index->cache_nr; i++) {
1217 struct cache_entry *ce = the_index->cache[i];
1219 if (select_flag && !(ce->ce_flags & select_flag))
1220 continue;
1222 if (!ce_stage(ce))
1223 ce->ce_flags |= skip_wt_flag;
1224 else
1225 ce->ce_flags &= ~skip_wt_flag;
1229 * 2. Widen worktree according to sparse-checkout file.
1230 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1232 clear_ce_flags(the_index->cache, the_index->cache_nr,
1233 select_flag, skip_wt_flag, el);
1236 static int verify_absent(const struct cache_entry *,
1237 enum unpack_trees_error_types,
1238 struct unpack_trees_options *);
1240 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1241 * resulting index, -2 on failure to reflect the changes to the work tree.
1243 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1245 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
1247 int i, ret;
1248 static struct cache_entry *dfc;
1249 struct exclude_list el;
1251 if (len > MAX_UNPACK_TREES)
1252 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
1254 memset(&el, 0, sizeof(el));
1255 if (!core_apply_sparse_checkout || !o->update)
1256 o->skip_sparse_checkout = 1;
1257 if (!o->skip_sparse_checkout) {
1258 char *sparse = git_pathdup("info/sparse-checkout");
1259 if (add_excludes_from_file_to_list(sparse, "", 0, &el, NULL) < 0)
1260 o->skip_sparse_checkout = 1;
1261 else
1262 o->el = &el;
1263 free(sparse);
1266 memset(&o->result, 0, sizeof(o->result));
1267 o->result.initialized = 1;
1268 o->result.timestamp.sec = o->src_index->timestamp.sec;
1269 o->result.timestamp.nsec = o->src_index->timestamp.nsec;
1270 o->result.version = o->src_index->version;
1271 o->result.split_index = o->src_index->split_index;
1272 if (o->result.split_index)
1273 o->result.split_index->refcount++;
1274 hashcpy(o->result.sha1, o->src_index->sha1);
1275 o->merge_size = len;
1276 mark_all_ce_unused(o->src_index);
1279 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1281 if (!o->skip_sparse_checkout)
1282 mark_new_skip_worktree(o->el, o->src_index, 0, CE_NEW_SKIP_WORKTREE);
1284 if (!dfc)
1285 dfc = xcalloc(1, cache_entry_size(0));
1286 o->df_conflict_entry = dfc;
1288 if (len) {
1289 const char *prefix = o->prefix ? o->prefix : "";
1290 struct traverse_info info;
1292 setup_traverse_info(&info, prefix);
1293 info.fn = unpack_callback;
1294 info.data = o;
1295 info.show_all_errors = o->show_all_errors;
1296 info.pathspec = o->pathspec;
1298 if (o->prefix) {
1300 * Unpack existing index entries that sort before the
1301 * prefix the tree is spliced into. Note that o->merge
1302 * is always true in this case.
1304 while (1) {
1305 struct cache_entry *ce = next_cache_entry(o);
1306 if (!ce)
1307 break;
1308 if (ce_in_traverse_path(ce, &info))
1309 break;
1310 if (unpack_index_entry(ce, o) < 0)
1311 goto return_failed;
1315 if (traverse_trees(len, t, &info) < 0)
1316 goto return_failed;
1319 /* Any left-over entries in the index? */
1320 if (o->merge) {
1321 while (1) {
1322 struct cache_entry *ce = next_cache_entry(o);
1323 if (!ce)
1324 break;
1325 if (unpack_index_entry(ce, o) < 0)
1326 goto return_failed;
1329 mark_all_ce_unused(o->src_index);
1331 if (o->trivial_merges_only && o->nontrivial_merge) {
1332 ret = unpack_failed(o, "Merge requires file-level merging");
1333 goto done;
1336 if (!o->skip_sparse_checkout) {
1337 int empty_worktree = 1;
1340 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1341 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1342 * so apply_sparse_checkout() won't attempt to remove it from worktree
1344 mark_new_skip_worktree(o->el, &o->result, CE_ADDED, CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1346 ret = 0;
1347 for (i = 0; i < o->result.cache_nr; i++) {
1348 struct cache_entry *ce = o->result.cache[i];
1351 * Entries marked with CE_ADDED in merged_entry() do not have
1352 * verify_absent() check (the check is effectively disabled
1353 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1355 * Do the real check now because we have had
1356 * correct CE_NEW_SKIP_WORKTREE
1358 if (ce->ce_flags & CE_ADDED &&
1359 verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1360 if (!o->show_all_errors)
1361 goto return_failed;
1362 ret = -1;
1365 if (apply_sparse_checkout(&o->result, ce, o)) {
1366 if (!o->show_all_errors)
1367 goto return_failed;
1368 ret = -1;
1370 if (!ce_skip_worktree(ce))
1371 empty_worktree = 0;
1374 if (ret < 0)
1375 goto return_failed;
1377 * Sparse checkout is meant to narrow down checkout area
1378 * but it does not make sense to narrow down to empty working
1379 * tree. This is usually a mistake in sparse checkout rules.
1380 * Do not allow users to do that.
1382 if (o->result.cache_nr && empty_worktree) {
1383 ret = unpack_failed(o, "Sparse checkout leaves no entry on working directory");
1384 goto done;
1388 o->src_index = NULL;
1389 ret = check_updates(o) ? (-2) : 0;
1390 if (o->dst_index) {
1391 if (!ret) {
1392 if (!o->result.cache_tree)
1393 o->result.cache_tree = cache_tree();
1394 if (!cache_tree_fully_valid(o->result.cache_tree))
1395 cache_tree_update(&o->result,
1396 WRITE_TREE_SILENT |
1397 WRITE_TREE_REPAIR);
1399 move_index_extensions(&o->result, o->dst_index);
1400 discard_index(o->dst_index);
1401 *o->dst_index = o->result;
1402 } else {
1403 discard_index(&o->result);
1406 done:
1407 clear_exclude_list(&el);
1408 return ret;
1410 return_failed:
1411 if (o->show_all_errors)
1412 display_error_msgs(o);
1413 mark_all_ce_unused(o->src_index);
1414 ret = unpack_failed(o, NULL);
1415 if (o->exiting_early)
1416 ret = 0;
1417 goto done;
1420 /* Here come the merge functions */
1422 static int reject_merge(const struct cache_entry *ce,
1423 struct unpack_trees_options *o)
1425 return o->gently ? -1 :
1426 add_rejected_path(o, ERROR_WOULD_OVERWRITE, ce->name);
1429 static int same(const struct cache_entry *a, const struct cache_entry *b)
1431 if (!!a != !!b)
1432 return 0;
1433 if (!a && !b)
1434 return 1;
1435 if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
1436 return 0;
1437 return a->ce_mode == b->ce_mode &&
1438 !oidcmp(&a->oid, &b->oid);
1443 * When a CE gets turned into an unmerged entry, we
1444 * want it to be up-to-date
1446 static int verify_uptodate_1(const struct cache_entry *ce,
1447 struct unpack_trees_options *o,
1448 enum unpack_trees_error_types error_type)
1450 struct stat st;
1452 if (o->index_only)
1453 return 0;
1456 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1457 * if this entry is truly up-to-date because this file may be
1458 * overwritten.
1460 if ((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce))
1461 ; /* keep checking */
1462 else if (o->reset || ce_uptodate(ce))
1463 return 0;
1465 if (!lstat(ce->name, &st)) {
1466 int flags = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE;
1467 unsigned changed = ie_match_stat(o->src_index, ce, &st, flags);
1469 if (submodule_from_ce(ce)) {
1470 int r = check_submodule_move_head(ce,
1471 "HEAD", oid_to_hex(&ce->oid), o);
1472 if (r)
1473 return o->gently ? -1 :
1474 add_rejected_path(o, error_type, ce->name);
1475 return 0;
1478 if (!changed)
1479 return 0;
1481 * Historic default policy was to allow submodule to be out
1482 * of sync wrt the superproject index. If the submodule was
1483 * not considered interesting above, we don't care here.
1485 if (S_ISGITLINK(ce->ce_mode))
1486 return 0;
1488 errno = 0;
1490 if (errno == ENOENT)
1491 return 0;
1492 return o->gently ? -1 :
1493 add_rejected_path(o, error_type, ce->name);
1496 static int verify_uptodate(const struct cache_entry *ce,
1497 struct unpack_trees_options *o)
1499 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1500 return 0;
1501 return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
1504 static int verify_uptodate_sparse(const struct cache_entry *ce,
1505 struct unpack_trees_options *o)
1507 return verify_uptodate_1(ce, o, ERROR_SPARSE_NOT_UPTODATE_FILE);
1510 static void invalidate_ce_path(const struct cache_entry *ce,
1511 struct unpack_trees_options *o)
1513 if (!ce)
1514 return;
1515 cache_tree_invalidate_path(o->src_index, ce->name);
1516 untracked_cache_invalidate_path(o->src_index, ce->name);
1520 * Check that checking out ce->sha1 in subdir ce->name is not
1521 * going to overwrite any working files.
1523 * Currently, git does not checkout subprojects during a superproject
1524 * checkout, so it is not going to overwrite anything.
1526 static int verify_clean_submodule(const char *old_sha1,
1527 const struct cache_entry *ce,
1528 enum unpack_trees_error_types error_type,
1529 struct unpack_trees_options *o)
1531 if (!submodule_from_ce(ce))
1532 return 0;
1534 return check_submodule_move_head(ce, old_sha1,
1535 oid_to_hex(&ce->oid), o);
1538 static int verify_clean_subdirectory(const struct cache_entry *ce,
1539 enum unpack_trees_error_types error_type,
1540 struct unpack_trees_options *o)
1543 * we are about to extract "ce->name"; we would not want to lose
1544 * anything in the existing directory there.
1546 int namelen;
1547 int i;
1548 struct dir_struct d;
1549 char *pathbuf;
1550 int cnt = 0;
1552 if (S_ISGITLINK(ce->ce_mode)) {
1553 unsigned char sha1[20];
1554 int sub_head = resolve_gitlink_ref(ce->name, "HEAD", sha1);
1556 * If we are not going to update the submodule, then
1557 * we don't care.
1559 if (!sub_head && !hashcmp(sha1, ce->oid.hash))
1560 return 0;
1561 return verify_clean_submodule(sub_head ? NULL : sha1_to_hex(sha1),
1562 ce, error_type, o);
1566 * First let's make sure we do not have a local modification
1567 * in that directory.
1569 namelen = ce_namelen(ce);
1570 for (i = locate_in_src_index(ce, o);
1571 i < o->src_index->cache_nr;
1572 i++) {
1573 struct cache_entry *ce2 = o->src_index->cache[i];
1574 int len = ce_namelen(ce2);
1575 if (len < namelen ||
1576 strncmp(ce->name, ce2->name, namelen) ||
1577 ce2->name[namelen] != '/')
1578 break;
1580 * ce2->name is an entry in the subdirectory to be
1581 * removed.
1583 if (!ce_stage(ce2)) {
1584 if (verify_uptodate(ce2, o))
1585 return -1;
1586 add_entry(o, ce2, CE_REMOVE, 0);
1587 mark_ce_used(ce2, o);
1589 cnt++;
1593 * Then we need to make sure that we do not lose a locally
1594 * present file that is not ignored.
1596 pathbuf = xstrfmt("%.*s/", namelen, ce->name);
1598 memset(&d, 0, sizeof(d));
1599 if (o->dir)
1600 d.exclude_per_dir = o->dir->exclude_per_dir;
1601 i = read_directory(&d, &the_index, pathbuf, namelen+1, NULL);
1602 if (i)
1603 return o->gently ? -1 :
1604 add_rejected_path(o, ERROR_NOT_UPTODATE_DIR, ce->name);
1605 free(pathbuf);
1606 return cnt;
1610 * This gets called when there was no index entry for the tree entry 'dst',
1611 * but we found a file in the working tree that 'lstat()' said was fine,
1612 * and we're on a case-insensitive filesystem.
1614 * See if we can find a case-insensitive match in the index that also
1615 * matches the stat information, and assume it's that other file!
1617 static int icase_exists(struct unpack_trees_options *o, const char *name, int len, struct stat *st)
1619 const struct cache_entry *src;
1621 src = index_file_exists(o->src_index, name, len, 1);
1622 return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
1625 static int check_ok_to_remove(const char *name, int len, int dtype,
1626 const struct cache_entry *ce, struct stat *st,
1627 enum unpack_trees_error_types error_type,
1628 struct unpack_trees_options *o)
1630 const struct cache_entry *result;
1633 * It may be that the 'lstat()' succeeded even though
1634 * target 'ce' was absent, because there is an old
1635 * entry that is different only in case..
1637 * Ignore that lstat() if it matches.
1639 if (ignore_case && icase_exists(o, name, len, st))
1640 return 0;
1642 if (o->dir &&
1643 is_excluded(o->dir, &the_index, name, &dtype))
1645 * ce->name is explicitly excluded, so it is Ok to
1646 * overwrite it.
1648 return 0;
1649 if (S_ISDIR(st->st_mode)) {
1651 * We are checking out path "foo" and
1652 * found "foo/." in the working tree.
1653 * This is tricky -- if we have modified
1654 * files that are in "foo/" we would lose
1655 * them.
1657 if (verify_clean_subdirectory(ce, error_type, o) < 0)
1658 return -1;
1659 return 0;
1663 * The previous round may already have decided to
1664 * delete this path, which is in a subdirectory that
1665 * is being replaced with a blob.
1667 result = index_file_exists(&o->result, name, len, 0);
1668 if (result) {
1669 if (result->ce_flags & CE_REMOVE)
1670 return 0;
1673 return o->gently ? -1 :
1674 add_rejected_path(o, error_type, name);
1678 * We do not want to remove or overwrite a working tree file that
1679 * is not tracked, unless it is ignored.
1681 static int verify_absent_1(const struct cache_entry *ce,
1682 enum unpack_trees_error_types error_type,
1683 struct unpack_trees_options *o)
1685 int len;
1686 struct stat st;
1688 if (o->index_only || o->reset || !o->update)
1689 return 0;
1691 len = check_leading_path(ce->name, ce_namelen(ce));
1692 if (!len)
1693 return 0;
1694 else if (len > 0) {
1695 char *path;
1696 int ret;
1698 path = xmemdupz(ce->name, len);
1699 if (lstat(path, &st))
1700 ret = error_errno("cannot stat '%s'", path);
1701 else {
1702 if (submodule_from_ce(ce))
1703 ret = check_submodule_move_head(ce,
1704 oid_to_hex(&ce->oid),
1705 NULL, o);
1706 else
1707 ret = check_ok_to_remove(path, len, DT_UNKNOWN, NULL,
1708 &st, error_type, o);
1710 free(path);
1711 return ret;
1712 } else if (lstat(ce->name, &st)) {
1713 if (errno != ENOENT)
1714 return error_errno("cannot stat '%s'", ce->name);
1715 return 0;
1716 } else {
1717 if (submodule_from_ce(ce))
1718 return check_submodule_move_head(ce, oid_to_hex(&ce->oid),
1719 NULL, o);
1721 return check_ok_to_remove(ce->name, ce_namelen(ce),
1722 ce_to_dtype(ce), ce, &st,
1723 error_type, o);
1727 static int verify_absent(const struct cache_entry *ce,
1728 enum unpack_trees_error_types error_type,
1729 struct unpack_trees_options *o)
1731 if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1732 return 0;
1733 return verify_absent_1(ce, error_type, o);
1736 static int verify_absent_sparse(const struct cache_entry *ce,
1737 enum unpack_trees_error_types error_type,
1738 struct unpack_trees_options *o)
1740 enum unpack_trees_error_types orphaned_error = error_type;
1741 if (orphaned_error == ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN)
1742 orphaned_error = ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN;
1744 return verify_absent_1(ce, orphaned_error, o);
1747 static int merged_entry(const struct cache_entry *ce,
1748 const struct cache_entry *old,
1749 struct unpack_trees_options *o)
1751 int update = CE_UPDATE;
1752 struct cache_entry *merge = dup_entry(ce);
1754 if (!old) {
1756 * New index entries. In sparse checkout, the following
1757 * verify_absent() will be delayed until after
1758 * traverse_trees() finishes in unpack_trees(), then:
1760 * - CE_NEW_SKIP_WORKTREE will be computed correctly
1761 * - verify_absent() be called again, this time with
1762 * correct CE_NEW_SKIP_WORKTREE
1764 * verify_absent() call here does nothing in sparse
1765 * checkout (i.e. o->skip_sparse_checkout == 0)
1767 update |= CE_ADDED;
1768 merge->ce_flags |= CE_NEW_SKIP_WORKTREE;
1770 if (verify_absent(merge,
1771 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1772 free(merge);
1773 return -1;
1775 invalidate_ce_path(merge, o);
1777 if (submodule_from_ce(ce)) {
1778 int ret = check_submodule_move_head(ce, NULL,
1779 oid_to_hex(&ce->oid),
1781 if (ret)
1782 return ret;
1785 } else if (!(old->ce_flags & CE_CONFLICTED)) {
1787 * See if we can re-use the old CE directly?
1788 * That way we get the uptodate stat info.
1790 * This also removes the UPDATE flag on a match; otherwise
1791 * we will end up overwriting local changes in the work tree.
1793 if (same(old, merge)) {
1794 copy_cache_entry(merge, old);
1795 update = 0;
1796 } else {
1797 if (verify_uptodate(old, o)) {
1798 free(merge);
1799 return -1;
1801 /* Migrate old flags over */
1802 update |= old->ce_flags & (CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1803 invalidate_ce_path(old, o);
1806 if (submodule_from_ce(ce)) {
1807 int ret = check_submodule_move_head(ce, oid_to_hex(&old->oid),
1808 oid_to_hex(&ce->oid),
1810 if (ret)
1811 return ret;
1813 } else {
1815 * Previously unmerged entry left as an existence
1816 * marker by read_index_unmerged();
1818 invalidate_ce_path(old, o);
1821 do_add_entry(o, merge, update, CE_STAGEMASK);
1822 return 1;
1825 static int deleted_entry(const struct cache_entry *ce,
1826 const struct cache_entry *old,
1827 struct unpack_trees_options *o)
1829 /* Did it exist in the index? */
1830 if (!old) {
1831 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1832 return -1;
1833 return 0;
1835 if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
1836 return -1;
1837 add_entry(o, ce, CE_REMOVE, 0);
1838 invalidate_ce_path(ce, o);
1839 return 1;
1842 static int keep_entry(const struct cache_entry *ce,
1843 struct unpack_trees_options *o)
1845 add_entry(o, ce, 0, 0);
1846 return 1;
1849 #if DBRT_DEBUG
1850 static void show_stage_entry(FILE *o,
1851 const char *label, const struct cache_entry *ce)
1853 if (!ce)
1854 fprintf(o, "%s (missing)\n", label);
1855 else
1856 fprintf(o, "%s%06o %s %d\t%s\n",
1857 label,
1858 ce->ce_mode,
1859 oid_to_hex(&ce->oid),
1860 ce_stage(ce),
1861 ce->name);
1863 #endif
1865 int threeway_merge(const struct cache_entry * const *stages,
1866 struct unpack_trees_options *o)
1868 const struct cache_entry *index;
1869 const struct cache_entry *head;
1870 const struct cache_entry *remote = stages[o->head_idx + 1];
1871 int count;
1872 int head_match = 0;
1873 int remote_match = 0;
1875 int df_conflict_head = 0;
1876 int df_conflict_remote = 0;
1878 int any_anc_missing = 0;
1879 int no_anc_exists = 1;
1880 int i;
1882 for (i = 1; i < o->head_idx; i++) {
1883 if (!stages[i] || stages[i] == o->df_conflict_entry)
1884 any_anc_missing = 1;
1885 else
1886 no_anc_exists = 0;
1889 index = stages[0];
1890 head = stages[o->head_idx];
1892 if (head == o->df_conflict_entry) {
1893 df_conflict_head = 1;
1894 head = NULL;
1897 if (remote == o->df_conflict_entry) {
1898 df_conflict_remote = 1;
1899 remote = NULL;
1903 * First, if there's a #16 situation, note that to prevent #13
1904 * and #14.
1906 if (!same(remote, head)) {
1907 for (i = 1; i < o->head_idx; i++) {
1908 if (same(stages[i], head)) {
1909 head_match = i;
1911 if (same(stages[i], remote)) {
1912 remote_match = i;
1918 * We start with cases where the index is allowed to match
1919 * something other than the head: #14(ALT) and #2ALT, where it
1920 * is permitted to match the result instead.
1922 /* #14, #14ALT, #2ALT */
1923 if (remote && !df_conflict_head && head_match && !remote_match) {
1924 if (index && !same(index, remote) && !same(index, head))
1925 return reject_merge(index, o);
1926 return merged_entry(remote, index, o);
1929 * If we have an entry in the index cache, then we want to
1930 * make sure that it matches head.
1932 if (index && !same(index, head))
1933 return reject_merge(index, o);
1935 if (head) {
1936 /* #5ALT, #15 */
1937 if (same(head, remote))
1938 return merged_entry(head, index, o);
1939 /* #13, #3ALT */
1940 if (!df_conflict_remote && remote_match && !head_match)
1941 return merged_entry(head, index, o);
1944 /* #1 */
1945 if (!head && !remote && any_anc_missing)
1946 return 0;
1949 * Under the "aggressive" rule, we resolve mostly trivial
1950 * cases that we historically had git-merge-one-file resolve.
1952 if (o->aggressive) {
1953 int head_deleted = !head;
1954 int remote_deleted = !remote;
1955 const struct cache_entry *ce = NULL;
1957 if (index)
1958 ce = index;
1959 else if (head)
1960 ce = head;
1961 else if (remote)
1962 ce = remote;
1963 else {
1964 for (i = 1; i < o->head_idx; i++) {
1965 if (stages[i] && stages[i] != o->df_conflict_entry) {
1966 ce = stages[i];
1967 break;
1973 * Deleted in both.
1974 * Deleted in one and unchanged in the other.
1976 if ((head_deleted && remote_deleted) ||
1977 (head_deleted && remote && remote_match) ||
1978 (remote_deleted && head && head_match)) {
1979 if (index)
1980 return deleted_entry(index, index, o);
1981 if (ce && !head_deleted) {
1982 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1983 return -1;
1985 return 0;
1988 * Added in both, identically.
1990 if (no_anc_exists && head && remote && same(head, remote))
1991 return merged_entry(head, index, o);
1995 /* Below are "no merge" cases, which require that the index be
1996 * up-to-date to avoid the files getting overwritten with
1997 * conflict resolution files.
1999 if (index) {
2000 if (verify_uptodate(index, o))
2001 return -1;
2004 o->nontrivial_merge = 1;
2006 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2007 count = 0;
2008 if (!head_match || !remote_match) {
2009 for (i = 1; i < o->head_idx; i++) {
2010 if (stages[i] && stages[i] != o->df_conflict_entry) {
2011 keep_entry(stages[i], o);
2012 count++;
2013 break;
2017 #if DBRT_DEBUG
2018 else {
2019 fprintf(stderr, "read-tree: warning #16 detected\n");
2020 show_stage_entry(stderr, "head ", stages[head_match]);
2021 show_stage_entry(stderr, "remote ", stages[remote_match]);
2023 #endif
2024 if (head) { count += keep_entry(head, o); }
2025 if (remote) { count += keep_entry(remote, o); }
2026 return count;
2030 * Two-way merge.
2032 * The rule is to "carry forward" what is in the index without losing
2033 * information across a "fast-forward", favoring a successful merge
2034 * over a merge failure when it makes sense. For details of the
2035 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2038 int twoway_merge(const struct cache_entry * const *src,
2039 struct unpack_trees_options *o)
2041 const struct cache_entry *current = src[0];
2042 const struct cache_entry *oldtree = src[1];
2043 const struct cache_entry *newtree = src[2];
2045 if (o->merge_size != 2)
2046 return error("Cannot do a twoway merge of %d trees",
2047 o->merge_size);
2049 if (oldtree == o->df_conflict_entry)
2050 oldtree = NULL;
2051 if (newtree == o->df_conflict_entry)
2052 newtree = NULL;
2054 if (current) {
2055 if (current->ce_flags & CE_CONFLICTED) {
2056 if (same(oldtree, newtree) || o->reset) {
2057 if (!newtree)
2058 return deleted_entry(current, current, o);
2059 else
2060 return merged_entry(newtree, current, o);
2062 return reject_merge(current, o);
2063 } else if ((!oldtree && !newtree) || /* 4 and 5 */
2064 (!oldtree && newtree &&
2065 same(current, newtree)) || /* 6 and 7 */
2066 (oldtree && newtree &&
2067 same(oldtree, newtree)) || /* 14 and 15 */
2068 (oldtree && newtree &&
2069 !same(oldtree, newtree) && /* 18 and 19 */
2070 same(current, newtree))) {
2071 return keep_entry(current, o);
2072 } else if (oldtree && !newtree && same(current, oldtree)) {
2073 /* 10 or 11 */
2074 return deleted_entry(oldtree, current, o);
2075 } else if (oldtree && newtree &&
2076 same(current, oldtree) && !same(current, newtree)) {
2077 /* 20 or 21 */
2078 return merged_entry(newtree, current, o);
2079 } else
2080 return reject_merge(current, o);
2082 else if (newtree) {
2083 if (oldtree && !o->initial_checkout) {
2085 * deletion of the path was staged;
2087 if (same(oldtree, newtree))
2088 return 1;
2089 return reject_merge(oldtree, o);
2091 return merged_entry(newtree, current, o);
2093 return deleted_entry(oldtree, current, o);
2097 * Bind merge.
2099 * Keep the index entries at stage0, collapse stage1 but make sure
2100 * stage0 does not have anything there.
2102 int bind_merge(const struct cache_entry * const *src,
2103 struct unpack_trees_options *o)
2105 const struct cache_entry *old = src[0];
2106 const struct cache_entry *a = src[1];
2108 if (o->merge_size != 1)
2109 return error("Cannot do a bind merge of %d trees",
2110 o->merge_size);
2111 if (a && old)
2112 return o->gently ? -1 :
2113 error(ERRORMSG(o, ERROR_BIND_OVERLAP),
2114 super_prefixed(a->name),
2115 super_prefixed(old->name));
2116 if (!a)
2117 return keep_entry(old, o);
2118 else
2119 return merged_entry(a, NULL, o);
2123 * One-way merge.
2125 * The rule is:
2126 * - take the stat information from stage0, take the data from stage1
2128 int oneway_merge(const struct cache_entry * const *src,
2129 struct unpack_trees_options *o)
2131 const struct cache_entry *old = src[0];
2132 const struct cache_entry *a = src[1];
2134 if (o->merge_size != 1)
2135 return error("Cannot do a oneway merge of %d trees",
2136 o->merge_size);
2138 if (!a || a == o->df_conflict_entry)
2139 return deleted_entry(old, old, o);
2141 if (old && same(old, a)) {
2142 int update = 0;
2143 if (o->reset && o->update && !ce_uptodate(old) && !ce_skip_worktree(old)) {
2144 struct stat st;
2145 if (lstat(old->name, &st) ||
2146 ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
2147 update |= CE_UPDATE;
2149 add_entry(o, old, update, 0);
2150 return 0;
2152 return merged_entry(a, old, o);