1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
6 #include "cache-tree.h"
7 #include "unpack-trees.h"
12 * Error messages expected by scripts out of plumbing commands such as
13 * read-tree. Non-scripted Porcelain is not required to use these messages
14 * and in fact are encouraged to reword them to better suit their particular
15 * situation better. See how "git checkout" replaces not_uptodate_file to
16 * explain why it does not allow switching between branches when you have
17 * local changes, for example.
19 static struct unpack_trees_error_msgs unpack_plumbing_errors = {
21 "Entry '%s' would be overwritten by merge. Cannot merge.",
23 /* not_uptodate_file */
24 "Entry '%s' not uptodate. Cannot merge.",
26 /* not_uptodate_dir */
27 "Updating '%s' would lose untracked files in it",
29 /* would_lose_untracked */
30 "Untracked working tree file '%s' would be %s by merge.",
33 "Entry '%s' overlaps with '%s'. Cannot bind.",
36 #define ERRORMSG(o,fld) \
37 ( ((o) && (o)->msgs.fld) \
39 : (unpack_plumbing_errors.fld) )
41 static void add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
42 unsigned int set, unsigned int clear)
44 unsigned int size = ce_size(ce);
45 struct cache_entry *new = xmalloc(size);
47 clear |= CE_HASHED | CE_UNHASHED;
49 memcpy(new, ce, size);
51 new->ce_flags = (new->ce_flags & ~clear) | set;
52 add_index_entry(&o->result, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE|ADD_CACHE_SKIP_DFCHECK);
55 /* Unlink the last component and attempt to remove leading
56 * directories, in case this unlink is the removal of the
57 * last entry in the directory -- empty directories are removed.
59 static void unlink_entry(struct cache_entry *ce)
62 char *name = ce->name;
64 if (has_symlink_leading_path(ce_namelen(ce), ce->name))
71 cp = strrchr(name, '/');
87 static struct checkout state;
88 static int check_updates(struct unpack_trees_options *o)
90 unsigned cnt = 0, total = 0;
91 struct progress *progress = NULL;
92 struct index_state *index = &o->result;
96 if (o->update && o->verbose_update) {
97 for (total = cnt = 0; cnt < index->cache_nr; cnt++) {
98 struct cache_entry *ce = index->cache[cnt];
99 if (ce->ce_flags & (CE_UPDATE | CE_REMOVE))
103 progress = start_progress_delay("Checking out files",
108 for (i = 0; i < index->cache_nr; i++) {
109 struct cache_entry *ce = index->cache[i];
111 if (ce->ce_flags & CE_REMOVE) {
112 display_progress(progress, ++cnt);
115 remove_index_entry_at(&o->result, i);
121 for (i = 0; i < index->cache_nr; i++) {
122 struct cache_entry *ce = index->cache[i];
124 if (ce->ce_flags & CE_UPDATE) {
125 display_progress(progress, ++cnt);
126 ce->ce_flags &= ~CE_UPDATE;
128 errs |= checkout_entry(ce, &state, NULL);
132 stop_progress(&progress);
136 static inline int call_unpack_fn(struct cache_entry **src, struct unpack_trees_options *o)
138 int ret = o->fn(src, o);
144 static int unpack_index_entry(struct cache_entry *ce, struct unpack_trees_options *o)
146 struct cache_entry *src[5] = { ce, };
150 if (o->skip_unmerged) {
151 add_entry(o, ce, 0, 0);
155 return call_unpack_fn(src, o);
158 int traverse_trees_recursive(int n, unsigned long dirmask, unsigned long df_conflicts, struct name_entry *names, struct traverse_info *info)
161 struct tree_desc t[MAX_UNPACK_TREES];
162 struct traverse_info newinfo;
163 struct name_entry *p;
172 newinfo.pathlen += tree_entry_len(p->path, p->sha1) + 1;
173 newinfo.conflicts |= df_conflicts;
175 for (i = 0; i < n; i++, dirmask >>= 1) {
176 const unsigned char *sha1 = NULL;
178 sha1 = names[i].sha1;
179 fill_tree_descriptor(t+i, sha1);
181 return traverse_trees(n, t, &newinfo);
185 * Compare the traverse-path to the cache entry without actually
186 * having to generate the textual representation of the traverse
189 * NOTE! This *only* compares up to the size of the traverse path
190 * itself - the caller needs to do the final check for the cache
191 * entry having more data at the end!
193 static int do_compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
195 int len, pathlen, ce_len;
199 int cmp = do_compare_entry(ce, info->prev, &info->name);
203 pathlen = info->pathlen;
204 ce_len = ce_namelen(ce);
206 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
207 if (ce_len < pathlen)
211 ce_name = ce->name + pathlen;
213 len = tree_entry_len(n->path, n->sha1);
214 return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
217 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
219 int cmp = do_compare_entry(ce, info, n);
224 * Even if the beginning compared identically, the ce should
225 * compare as bigger than a directory leading up to it!
227 return ce_namelen(ce) > traverse_path_len(info, n);
230 static struct cache_entry *create_ce_entry(const struct traverse_info *info, const struct name_entry *n, int stage)
232 int len = traverse_path_len(info, n);
233 struct cache_entry *ce = xcalloc(1, cache_entry_size(len));
235 ce->ce_mode = create_ce_mode(n->mode);
236 ce->ce_flags = create_ce_flags(len, stage);
237 hashcpy(ce->sha1, n->sha1);
238 make_traverse_path(ce->name, info, n);
243 static int unpack_nondirectories(int n, unsigned long mask,
244 unsigned long dirmask,
245 struct cache_entry **src,
246 const struct name_entry *names,
247 const struct traverse_info *info)
250 struct unpack_trees_options *o = info->data;
251 unsigned long conflicts;
253 /* Do we have *only* directories? Nothing to do */
254 if (mask == dirmask && !src[0])
257 conflicts = info->conflicts;
260 conflicts |= dirmask;
263 * Ok, we've filled in up to any potential index entry in src[0],
266 for (i = 0; i < n; i++) {
268 unsigned int bit = 1ul << i;
269 if (conflicts & bit) {
270 src[i + o->merge] = o->df_conflict_entry;
277 else if (i + 1 < o->head_idx)
279 else if (i + 1 > o->head_idx)
283 src[i + o->merge] = create_ce_entry(info, names + i, stage);
287 return call_unpack_fn(src, o);
290 for (i = 0; i < n; i++)
291 add_entry(o, src[i], 0, 0);
295 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
297 struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
298 struct unpack_trees_options *o = info->data;
299 const struct name_entry *p = names;
301 /* Find first entry with a real name (we could use "mask" too) */
305 /* Are we supposed to look at the index too? */
307 while (o->pos < o->src_index->cache_nr) {
308 struct cache_entry *ce = o->src_index->cache[o->pos];
309 int cmp = compare_entry(ce, info, p);
311 if (unpack_index_entry(ce, o) < 0)
319 * If we skip unmerged index entries, we'll skip this
320 * entry *and* the tree entries associated with it!
322 if (o->skip_unmerged) {
323 add_entry(o, ce, 0, 0);
333 if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
336 /* Now handle any directories.. */
338 unsigned long conflicts = mask & ~dirmask;
344 if (traverse_trees_recursive(n, dirmask, conflicts,
353 static int unpack_failed(struct unpack_trees_options *o, const char *message)
355 discard_index(&o->result);
358 return error("%s", message);
365 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
366 * resulting index, -2 on failure to reflect the changes to the work tree.
368 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
371 static struct cache_entry *dfc;
373 if (len > MAX_UNPACK_TREES)
374 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
375 memset(&state, 0, sizeof(state));
379 state.refresh_cache = 1;
381 memset(&o->result, 0, sizeof(o->result));
382 o->result.initialized = 1;
384 o->result.timestamp = o->src_index->timestamp;
388 dfc = xcalloc(1, cache_entry_size(0));
389 o->df_conflict_entry = dfc;
392 const char *prefix = o->prefix ? o->prefix : "";
393 struct traverse_info info;
395 setup_traverse_info(&info, prefix);
396 info.fn = unpack_callback;
399 if (traverse_trees(len, t, &info) < 0)
400 return unpack_failed(o, NULL);
403 /* Any left-over entries in the index? */
405 while (o->pos < o->src_index->cache_nr) {
406 struct cache_entry *ce = o->src_index->cache[o->pos];
407 if (unpack_index_entry(ce, o) < 0)
408 return unpack_failed(o, NULL);
412 if (o->trivial_merges_only && o->nontrivial_merge)
413 return unpack_failed(o, "Merge requires file-level merging");
416 ret = check_updates(o) ? (-2) : 0;
418 *o->dst_index = o->result;
422 /* Here come the merge functions */
424 static int reject_merge(struct cache_entry *ce, struct unpack_trees_options *o)
426 return error(ERRORMSG(o, would_overwrite), ce->name);
429 static int same(struct cache_entry *a, struct cache_entry *b)
435 return a->ce_mode == b->ce_mode &&
436 !hashcmp(a->sha1, b->sha1);
441 * When a CE gets turned into an unmerged entry, we
442 * want it to be up-to-date
444 static int verify_uptodate(struct cache_entry *ce,
445 struct unpack_trees_options *o)
449 if (o->index_only || o->reset)
452 if (!lstat(ce->name, &st)) {
453 unsigned changed = ie_match_stat(o->src_index, ce, &st, CE_MATCH_IGNORE_VALID);
457 * NEEDSWORK: the current default policy is to allow
458 * submodule to be out of sync wrt the supermodule
459 * index. This needs to be tightened later for
460 * submodules that are marked to be automatically
463 if (S_ISGITLINK(ce->ce_mode))
469 return o->gently ? -1 :
470 error(ERRORMSG(o, not_uptodate_file), ce->name);
473 static void invalidate_ce_path(struct cache_entry *ce, struct unpack_trees_options *o)
476 cache_tree_invalidate_path(o->src_index->cache_tree, ce->name);
480 * Check that checking out ce->sha1 in subdir ce->name is not
481 * going to overwrite any working files.
483 * Currently, git does not checkout subprojects during a superproject
484 * checkout, so it is not going to overwrite anything.
486 static int verify_clean_submodule(struct cache_entry *ce, const char *action,
487 struct unpack_trees_options *o)
492 static int verify_clean_subdirectory(struct cache_entry *ce, const char *action,
493 struct unpack_trees_options *o)
496 * we are about to extract "ce->name"; we would not want to lose
497 * anything in the existing directory there.
504 unsigned char sha1[20];
506 if (S_ISGITLINK(ce->ce_mode) &&
507 resolve_gitlink_ref(ce->name, "HEAD", sha1) == 0) {
508 /* If we are not going to update the submodule, then
511 if (!hashcmp(sha1, ce->sha1))
513 return verify_clean_submodule(ce, action, o);
517 * First let's make sure we do not have a local modification
520 namelen = strlen(ce->name);
521 pos = index_name_pos(o->src_index, ce->name, namelen);
523 return cnt; /* we have it as nondirectory */
525 for (i = pos; i < o->src_index->cache_nr; i++) {
526 struct cache_entry *ce = o->src_index->cache[i];
527 int len = ce_namelen(ce);
529 strncmp(ce->name, ce->name, namelen) ||
530 ce->name[namelen] != '/')
533 * ce->name is an entry in the subdirectory.
536 if (verify_uptodate(ce, o))
538 add_entry(o, ce, CE_REMOVE, 0);
544 * Then we need to make sure that we do not lose a locally
545 * present file that is not ignored.
547 pathbuf = xmalloc(namelen + 2);
548 memcpy(pathbuf, ce->name, namelen);
549 strcpy(pathbuf+namelen, "/");
551 memset(&d, 0, sizeof(d));
553 d.exclude_per_dir = o->dir->exclude_per_dir;
554 i = read_directory(&d, ce->name, pathbuf, namelen+1, NULL);
556 return o->gently ? -1 :
557 error(ERRORMSG(o, not_uptodate_dir), ce->name);
563 * This gets called when there was no index entry for the tree entry 'dst',
564 * but we found a file in the working tree that 'lstat()' said was fine,
565 * and we're on a case-insensitive filesystem.
567 * See if we can find a case-insensitive match in the index that also
568 * matches the stat information, and assume it's that other file!
570 static int icase_exists(struct unpack_trees_options *o, struct cache_entry *dst, struct stat *st)
572 struct cache_entry *src;
574 src = index_name_exists(o->src_index, dst->name, ce_namelen(dst), 1);
575 return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID);
579 * We do not want to remove or overwrite a working tree file that
580 * is not tracked, unless it is ignored.
582 static int verify_absent(struct cache_entry *ce, const char *action,
583 struct unpack_trees_options *o)
587 if (o->index_only || o->reset || !o->update)
590 if (has_symlink_leading_path(ce_namelen(ce), ce->name))
593 if (!lstat(ce->name, &st)) {
595 int dtype = ce_to_dtype(ce);
596 struct cache_entry *result;
599 * It may be that the 'lstat()' succeeded even though
600 * target 'ce' was absent, because there is an old
601 * entry that is different only in case..
603 * Ignore that lstat() if it matches.
605 if (ignore_case && icase_exists(o, ce, &st))
608 if (o->dir && excluded(o->dir, ce->name, &dtype))
610 * ce->name is explicitly excluded, so it is Ok to
614 if (S_ISDIR(st.st_mode)) {
616 * We are checking out path "foo" and
617 * found "foo/." in the working tree.
618 * This is tricky -- if we have modified
619 * files that are in "foo/" we would lose
622 cnt = verify_clean_subdirectory(ce, action, o);
625 * If this removed entries from the index,
626 * what that means is:
628 * (1) the caller unpack_trees_rec() saw path/foo
629 * in the index, and it has not removed it because
630 * it thinks it is handling 'path' as blob with
632 * (2) we will return "ok, we placed a merged entry
633 * in the index" which would cause o->pos to be
634 * incremented by one;
635 * (3) however, original o->pos now has 'path/foo'
636 * marked with "to be removed".
638 * We need to increment it by the number of
639 * deleted entries here.
646 * The previous round may already have decided to
647 * delete this path, which is in a subdirectory that
648 * is being replaced with a blob.
650 result = index_name_exists(&o->result, ce->name, ce_namelen(ce), 0);
652 if (result->ce_flags & CE_REMOVE)
656 return o->gently ? -1 :
657 error(ERRORMSG(o, would_lose_untracked), ce->name, action);
662 static int merged_entry(struct cache_entry *merge, struct cache_entry *old,
663 struct unpack_trees_options *o)
665 int update = CE_UPDATE;
669 * See if we can re-use the old CE directly?
670 * That way we get the uptodate stat info.
672 * This also removes the UPDATE flag on a match; otherwise
673 * we will end up overwriting local changes in the work tree.
675 if (same(old, merge)) {
676 copy_cache_entry(merge, old);
679 if (verify_uptodate(old, o))
681 invalidate_ce_path(old, o);
685 if (verify_absent(merge, "overwritten", o))
687 invalidate_ce_path(merge, o);
690 add_entry(o, merge, update, CE_STAGEMASK);
694 static int deleted_entry(struct cache_entry *ce, struct cache_entry *old,
695 struct unpack_trees_options *o)
697 /* Did it exist in the index? */
699 if (verify_absent(ce, "removed", o))
703 if (verify_uptodate(old, o))
705 add_entry(o, ce, CE_REMOVE, 0);
706 invalidate_ce_path(ce, o);
710 static int keep_entry(struct cache_entry *ce, struct unpack_trees_options *o)
712 add_entry(o, ce, 0, 0);
717 static void show_stage_entry(FILE *o,
718 const char *label, const struct cache_entry *ce)
721 fprintf(o, "%s (missing)\n", label);
723 fprintf(o, "%s%06o %s %d\t%s\n",
726 sha1_to_hex(ce->sha1),
732 int threeway_merge(struct cache_entry **stages, struct unpack_trees_options *o)
734 struct cache_entry *index;
735 struct cache_entry *head;
736 struct cache_entry *remote = stages[o->head_idx + 1];
739 int remote_match = 0;
741 int df_conflict_head = 0;
742 int df_conflict_remote = 0;
744 int any_anc_missing = 0;
745 int no_anc_exists = 1;
748 for (i = 1; i < o->head_idx; i++) {
749 if (!stages[i] || stages[i] == o->df_conflict_entry)
756 head = stages[o->head_idx];
758 if (head == o->df_conflict_entry) {
759 df_conflict_head = 1;
763 if (remote == o->df_conflict_entry) {
764 df_conflict_remote = 1;
768 /* First, if there's a #16 situation, note that to prevent #13
771 if (!same(remote, head)) {
772 for (i = 1; i < o->head_idx; i++) {
773 if (same(stages[i], head)) {
776 if (same(stages[i], remote)) {
782 /* We start with cases where the index is allowed to match
783 * something other than the head: #14(ALT) and #2ALT, where it
784 * is permitted to match the result instead.
786 /* #14, #14ALT, #2ALT */
787 if (remote && !df_conflict_head && head_match && !remote_match) {
788 if (index && !same(index, remote) && !same(index, head))
789 return o->gently ? -1 : reject_merge(index, o);
790 return merged_entry(remote, index, o);
793 * If we have an entry in the index cache, then we want to
794 * make sure that it matches head.
796 if (index && !same(index, head))
797 return o->gently ? -1 : reject_merge(index, o);
801 if (same(head, remote))
802 return merged_entry(head, index, o);
804 if (!df_conflict_remote && remote_match && !head_match)
805 return merged_entry(head, index, o);
809 if (!head && !remote && any_anc_missing)
812 /* Under the new "aggressive" rule, we resolve mostly trivial
813 * cases that we historically had git-merge-one-file resolve.
816 int head_deleted = !head && !df_conflict_head;
817 int remote_deleted = !remote && !df_conflict_remote;
818 struct cache_entry *ce = NULL;
827 for (i = 1; i < o->head_idx; i++) {
828 if (stages[i] && stages[i] != o->df_conflict_entry) {
837 * Deleted in one and unchanged in the other.
839 if ((head_deleted && remote_deleted) ||
840 (head_deleted && remote && remote_match) ||
841 (remote_deleted && head && head_match)) {
843 return deleted_entry(index, index, o);
844 if (ce && !head_deleted) {
845 if (verify_absent(ce, "removed", o))
851 * Added in both, identically.
853 if (no_anc_exists && head && remote && same(head, remote))
854 return merged_entry(head, index, o);
858 /* Below are "no merge" cases, which require that the index be
859 * up-to-date to avoid the files getting overwritten with
860 * conflict resolution files.
863 if (verify_uptodate(index, o))
867 o->nontrivial_merge = 1;
869 /* #2, #3, #4, #6, #7, #9, #10, #11. */
871 if (!head_match || !remote_match) {
872 for (i = 1; i < o->head_idx; i++) {
873 if (stages[i] && stages[i] != o->df_conflict_entry) {
874 keep_entry(stages[i], o);
882 fprintf(stderr, "read-tree: warning #16 detected\n");
883 show_stage_entry(stderr, "head ", stages[head_match]);
884 show_stage_entry(stderr, "remote ", stages[remote_match]);
887 if (head) { count += keep_entry(head, o); }
888 if (remote) { count += keep_entry(remote, o); }
895 * The rule is to "carry forward" what is in the index without losing
896 * information across a "fast forward", favoring a successful merge
897 * over a merge failure when it makes sense. For details of the
898 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
901 int twoway_merge(struct cache_entry **src, struct unpack_trees_options *o)
903 struct cache_entry *current = src[0];
904 struct cache_entry *oldtree = src[1];
905 struct cache_entry *newtree = src[2];
907 if (o->merge_size != 2)
908 return error("Cannot do a twoway merge of %d trees",
911 if (oldtree == o->df_conflict_entry)
913 if (newtree == o->df_conflict_entry)
917 if ((!oldtree && !newtree) || /* 4 and 5 */
918 (!oldtree && newtree &&
919 same(current, newtree)) || /* 6 and 7 */
920 (oldtree && newtree &&
921 same(oldtree, newtree)) || /* 14 and 15 */
922 (oldtree && newtree &&
923 !same(oldtree, newtree) && /* 18 and 19 */
924 same(current, newtree))) {
925 return keep_entry(current, o);
927 else if (oldtree && !newtree && same(current, oldtree)) {
929 return deleted_entry(oldtree, current, o);
931 else if (oldtree && newtree &&
932 same(current, oldtree) && !same(current, newtree)) {
934 return merged_entry(newtree, current, o);
937 /* all other failures */
939 return o->gently ? -1 : reject_merge(oldtree, o);
941 return o->gently ? -1 : reject_merge(current, o);
943 return o->gently ? -1 : reject_merge(newtree, o);
948 if (oldtree && !o->initial_checkout) {
950 * deletion of the path was staged;
952 if (same(oldtree, newtree))
954 return reject_merge(oldtree, o);
956 return merged_entry(newtree, current, o);
958 return deleted_entry(oldtree, current, o);
964 * Keep the index entries at stage0, collapse stage1 but make sure
965 * stage0 does not have anything there.
967 int bind_merge(struct cache_entry **src,
968 struct unpack_trees_options *o)
970 struct cache_entry *old = src[0];
971 struct cache_entry *a = src[1];
973 if (o->merge_size != 1)
974 return error("Cannot do a bind merge of %d trees\n",
977 return o->gently ? -1 :
978 error(ERRORMSG(o, bind_overlap), a->name, old->name);
980 return keep_entry(old, o);
982 return merged_entry(a, NULL, o);
989 * - take the stat information from stage0, take the data from stage1
991 int oneway_merge(struct cache_entry **src, struct unpack_trees_options *o)
993 struct cache_entry *old = src[0];
994 struct cache_entry *a = src[1];
996 if (o->merge_size != 1)
997 return error("Cannot do a oneway merge of %d trees",
1001 return deleted_entry(old, old, o);
1003 if (old && same(old, a)) {
1007 if (lstat(old->name, &st) ||
1008 ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID))
1009 update |= CE_UPDATE;
1011 add_entry(o, old, update, 0);
1014 return merged_entry(a, old, o);