Code

merge-recursive: distinguish "removed" and "overwritten" messages
[git.git] / unpack-trees.c
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"
12 /*
13  * Error messages expected by scripts out of plumbing commands such as
14  * read-tree.  Non-scripted Porcelain is not required to use these messages
15  * and in fact are encouraged to reword them to better suit their particular
16  * situation better.  See how "git checkout" and "git merge" replaces
17  * them using set_porcelain_error_msgs(), for example.
18  */
19 const char *unpack_plumbing_errors[NB_UNPACK_TREES_ERROR_TYPES] = {
20         /* ERROR_WOULD_OVERWRITE */
21         "Entry '%s' would be overwritten by merge. Cannot merge.",
23         /* ERROR_NOT_UPTODATE_FILE */
24         "Entry '%s' not uptodate. Cannot merge.",
26         /* ERROR_NOT_UPTODATE_DIR */
27         "Updating '%s' would lose untracked files in it",
29         /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
30         "Untracked working tree file '%s' would be overwritten by merge.",
32         /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
33         "Untracked working tree file '%s' would be removed by merge.",
35         /* ERROR_BIND_OVERLAP */
36         "Entry '%s' overlaps with '%s'.  Cannot bind.",
38         /* ERROR_SPARSE_NOT_UPTODATE_FILE */
39         "Entry '%s' not uptodate. Cannot update sparse checkout.",
41         /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
42         "Working tree file '%s' would be overwritten by sparse checkout update.",
44         /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
45         "Working tree file '%s' would be removed by sparse checkout update.",
46 };
48 #define ERRORMSG(o,type) \
49         ( ((o) && (o)->msgs[(type)]) \
50           ? ((o)->msgs[(type)])      \
51           : (unpack_plumbing_errors[(type)]) )
53 static void add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
54         unsigned int set, unsigned int clear)
55 {
56         unsigned int size = ce_size(ce);
57         struct cache_entry *new = xmalloc(size);
59         clear |= CE_HASHED | CE_UNHASHED;
61         memcpy(new, ce, size);
62         new->next = NULL;
63         new->ce_flags = (new->ce_flags & ~clear) | set;
64         add_index_entry(&o->result, new, ADD_CACHE_OK_TO_ADD|ADD_CACHE_OK_TO_REPLACE);
65 }
67 /*
68  * Unlink the last component and schedule the leading directories for
69  * removal, such that empty directories get removed.
70  */
71 static void unlink_entry(struct cache_entry *ce)
72 {
73         if (has_symlink_or_noent_leading_path(ce->name, ce_namelen(ce)))
74                 return;
75         if (remove_or_warn(ce->ce_mode, ce->name))
76                 return;
77         schedule_dir_for_removal(ce->name, ce_namelen(ce));
78 }
80 static struct checkout state;
81 static int check_updates(struct unpack_trees_options *o)
82 {
83         unsigned cnt = 0, total = 0;
84         struct progress *progress = NULL;
85         struct index_state *index = &o->result;
86         int i;
87         int errs = 0;
89         if (o->update && o->verbose_update) {
90                 for (total = cnt = 0; cnt < index->cache_nr; cnt++) {
91                         struct cache_entry *ce = index->cache[cnt];
92                         if (ce->ce_flags & (CE_UPDATE | CE_REMOVE | CE_WT_REMOVE))
93                                 total++;
94                 }
96                 progress = start_progress_delay("Checking out files",
97                                                 total, 50, 1);
98                 cnt = 0;
99         }
101         if (o->update)
102                 git_attr_set_direction(GIT_ATTR_CHECKOUT, &o->result);
103         for (i = 0; i < index->cache_nr; i++) {
104                 struct cache_entry *ce = index->cache[i];
106                 if (ce->ce_flags & CE_WT_REMOVE) {
107                         display_progress(progress, ++cnt);
108                         if (o->update)
109                                 unlink_entry(ce);
110                         continue;
111                 }
113                 if (ce->ce_flags & CE_REMOVE) {
114                         display_progress(progress, ++cnt);
115                         if (o->update)
116                                 unlink_entry(ce);
117                 }
118         }
119         remove_marked_cache_entries(&o->result);
120         remove_scheduled_dirs();
122         for (i = 0; i < index->cache_nr; i++) {
123                 struct cache_entry *ce = index->cache[i];
125                 if (ce->ce_flags & CE_UPDATE) {
126                         display_progress(progress, ++cnt);
127                         ce->ce_flags &= ~CE_UPDATE;
128                         if (o->update) {
129                                 errs |= checkout_entry(ce, &state, NULL);
130                         }
131                 }
132         }
133         stop_progress(&progress);
134         if (o->update)
135                 git_attr_set_direction(GIT_ATTR_CHECKIN, NULL);
136         return errs != 0;
139 static int verify_uptodate_sparse(struct cache_entry *ce, struct unpack_trees_options *o);
140 static int verify_absent_sparse(struct cache_entry *ce, enum unpack_trees_error_types, struct unpack_trees_options *o);
142 static int will_have_skip_worktree(const struct cache_entry *ce, struct unpack_trees_options *o)
144         const char *basename;
146         if (ce_stage(ce))
147                 return 0;
149         basename = strrchr(ce->name, '/');
150         basename = basename ? basename+1 : ce->name;
151         return excluded_from_list(ce->name, ce_namelen(ce), basename, NULL, o->el) <= 0;
154 static int apply_sparse_checkout(struct cache_entry *ce, struct unpack_trees_options *o)
156         int was_skip_worktree = ce_skip_worktree(ce);
158         if (will_have_skip_worktree(ce, o))
159                 ce->ce_flags |= CE_SKIP_WORKTREE;
160         else
161                 ce->ce_flags &= ~CE_SKIP_WORKTREE;
163         /*
164          * We only care about files getting into the checkout area
165          * If merge strategies want to remove some, go ahead, this
166          * flag will be removed eventually in unpack_trees() if it's
167          * outside checkout area.
168          */
169         if (ce->ce_flags & CE_REMOVE)
170                 return 0;
172         if (!was_skip_worktree && ce_skip_worktree(ce)) {
173                 /*
174                  * If CE_UPDATE is set, verify_uptodate() must be called already
175                  * also stat info may have lost after merged_entry() so calling
176                  * verify_uptodate() again may fail
177                  */
178                 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
179                         return -1;
180                 ce->ce_flags |= CE_WT_REMOVE;
181         }
182         if (was_skip_worktree && !ce_skip_worktree(ce)) {
183                 if (verify_absent_sparse(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
184                         return -1;
185                 ce->ce_flags |= CE_UPDATE;
186         }
187         return 0;
190 static inline int call_unpack_fn(struct cache_entry **src, struct unpack_trees_options *o)
192         int ret = o->fn(src, o);
193         if (ret > 0)
194                 ret = 0;
195         return ret;
198 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
200         ce->ce_flags |= CE_UNPACKED;
202         if (o->cache_bottom < o->src_index->cache_nr &&
203             o->src_index->cache[o->cache_bottom] == ce) {
204                 int bottom = o->cache_bottom;
205                 while (bottom < o->src_index->cache_nr &&
206                        o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
207                         bottom++;
208                 o->cache_bottom = bottom;
209         }
212 static void mark_all_ce_unused(struct index_state *index)
214         int i;
215         for (i = 0; i < index->cache_nr; i++)
216                 index->cache[i]->ce_flags &= ~CE_UNPACKED;
219 static int locate_in_src_index(struct cache_entry *ce,
220                                struct unpack_trees_options *o)
222         struct index_state *index = o->src_index;
223         int len = ce_namelen(ce);
224         int pos = index_name_pos(index, ce->name, len);
225         if (pos < 0)
226                 pos = -1 - pos;
227         return pos;
230 /*
231  * We call unpack_index_entry() with an unmerged cache entry
232  * only in diff-index, and it wants a single callback.  Skip
233  * the other unmerged entry with the same name.
234  */
235 static void mark_ce_used_same_name(struct cache_entry *ce,
236                                    struct unpack_trees_options *o)
238         struct index_state *index = o->src_index;
239         int len = ce_namelen(ce);
240         int pos;
242         for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
243                 struct cache_entry *next = index->cache[pos];
244                 if (len != ce_namelen(next) ||
245                     memcmp(ce->name, next->name, len))
246                         break;
247                 mark_ce_used(next, o);
248         }
251 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o)
253         const struct index_state *index = o->src_index;
254         int pos = o->cache_bottom;
256         while (pos < index->cache_nr) {
257                 struct cache_entry *ce = index->cache[pos];
258                 if (!(ce->ce_flags & CE_UNPACKED))
259                         return ce;
260                 pos++;
261         }
262         return NULL;
265 static void add_same_unmerged(struct cache_entry *ce,
266                               struct unpack_trees_options *o)
268         struct index_state *index = o->src_index;
269         int len = ce_namelen(ce);
270         int pos = index_name_pos(index, ce->name, len);
272         if (0 <= pos)
273                 die("programming error in a caller of mark_ce_used_same_name");
274         for (pos = -pos - 1; pos < index->cache_nr; pos++) {
275                 struct cache_entry *next = index->cache[pos];
276                 if (len != ce_namelen(next) ||
277                     memcmp(ce->name, next->name, len))
278                         break;
279                 add_entry(o, next, 0, 0);
280                 mark_ce_used(next, o);
281         }
284 static int unpack_index_entry(struct cache_entry *ce,
285                               struct unpack_trees_options *o)
287         struct cache_entry *src[5] = { NULL };
288         int ret;
290         src[0] = ce;
292         mark_ce_used(ce, o);
293         if (ce_stage(ce)) {
294                 if (o->skip_unmerged) {
295                         add_entry(o, ce, 0, 0);
296                         return 0;
297                 }
298         }
299         ret = call_unpack_fn(src, o);
300         if (ce_stage(ce))
301                 mark_ce_used_same_name(ce, o);
302         return ret;
305 static int find_cache_pos(struct traverse_info *, const struct name_entry *);
307 static void restore_cache_bottom(struct traverse_info *info, int bottom)
309         struct unpack_trees_options *o = info->data;
311         if (o->diff_index_cached)
312                 return;
313         o->cache_bottom = bottom;
316 static int switch_cache_bottom(struct traverse_info *info)
318         struct unpack_trees_options *o = info->data;
319         int ret, pos;
321         if (o->diff_index_cached)
322                 return 0;
323         ret = o->cache_bottom;
324         pos = find_cache_pos(info->prev, &info->name);
326         if (pos < -1)
327                 o->cache_bottom = -2 - pos;
328         else if (pos < 0)
329                 o->cache_bottom = o->src_index->cache_nr;
330         return ret;
333 static int traverse_trees_recursive(int n, unsigned long dirmask, unsigned long df_conflicts, struct name_entry *names, struct traverse_info *info)
335         int i, ret, bottom;
336         struct tree_desc t[MAX_UNPACK_TREES];
337         struct traverse_info newinfo;
338         struct name_entry *p;
340         p = names;
341         while (!p->mode)
342                 p++;
344         newinfo = *info;
345         newinfo.prev = info;
346         newinfo.name = *p;
347         newinfo.pathlen += tree_entry_len(p->path, p->sha1) + 1;
348         newinfo.conflicts |= df_conflicts;
350         for (i = 0; i < n; i++, dirmask >>= 1) {
351                 const unsigned char *sha1 = NULL;
352                 if (dirmask & 1)
353                         sha1 = names[i].sha1;
354                 fill_tree_descriptor(t+i, sha1);
355         }
357         bottom = switch_cache_bottom(&newinfo);
358         ret = traverse_trees(n, t, &newinfo);
359         restore_cache_bottom(&newinfo, bottom);
360         return ret;
363 /*
364  * Compare the traverse-path to the cache entry without actually
365  * having to generate the textual representation of the traverse
366  * path.
367  *
368  * NOTE! This *only* compares up to the size of the traverse path
369  * itself - the caller needs to do the final check for the cache
370  * entry having more data at the end!
371  */
372 static int do_compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
374         int len, pathlen, ce_len;
375         const char *ce_name;
377         if (info->prev) {
378                 int cmp = do_compare_entry(ce, info->prev, &info->name);
379                 if (cmp)
380                         return cmp;
381         }
382         pathlen = info->pathlen;
383         ce_len = ce_namelen(ce);
385         /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
386         if (ce_len < pathlen)
387                 return -1;
389         ce_len -= pathlen;
390         ce_name = ce->name + pathlen;
392         len = tree_entry_len(n->path, n->sha1);
393         return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
396 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
398         int cmp = do_compare_entry(ce, info, n);
399         if (cmp)
400                 return cmp;
402         /*
403          * Even if the beginning compared identically, the ce should
404          * compare as bigger than a directory leading up to it!
405          */
406         return ce_namelen(ce) > traverse_path_len(info, n);
409 static int ce_in_traverse_path(const struct cache_entry *ce,
410                                const struct traverse_info *info)
412         if (!info->prev)
413                 return 1;
414         if (do_compare_entry(ce, info->prev, &info->name))
415                 return 0;
416         /*
417          * If ce (blob) is the same name as the path (which is a tree
418          * we will be descending into), it won't be inside it.
419          */
420         return (info->pathlen < ce_namelen(ce));
423 static struct cache_entry *create_ce_entry(const struct traverse_info *info, const struct name_entry *n, int stage)
425         int len = traverse_path_len(info, n);
426         struct cache_entry *ce = xcalloc(1, cache_entry_size(len));
428         ce->ce_mode = create_ce_mode(n->mode);
429         ce->ce_flags = create_ce_flags(len, stage);
430         hashcpy(ce->sha1, n->sha1);
431         make_traverse_path(ce->name, info, n);
433         return ce;
436 static int unpack_nondirectories(int n, unsigned long mask,
437                                  unsigned long dirmask,
438                                  struct cache_entry **src,
439                                  const struct name_entry *names,
440                                  const struct traverse_info *info)
442         int i;
443         struct unpack_trees_options *o = info->data;
444         unsigned long conflicts;
446         /* Do we have *only* directories? Nothing to do */
447         if (mask == dirmask && !src[0])
448                 return 0;
450         conflicts = info->conflicts;
451         if (o->merge)
452                 conflicts >>= 1;
453         conflicts |= dirmask;
455         /*
456          * Ok, we've filled in up to any potential index entry in src[0],
457          * now do the rest.
458          */
459         for (i = 0; i < n; i++) {
460                 int stage;
461                 unsigned int bit = 1ul << i;
462                 if (conflicts & bit) {
463                         src[i + o->merge] = o->df_conflict_entry;
464                         continue;
465                 }
466                 if (!(mask & bit))
467                         continue;
468                 if (!o->merge)
469                         stage = 0;
470                 else if (i + 1 < o->head_idx)
471                         stage = 1;
472                 else if (i + 1 > o->head_idx)
473                         stage = 3;
474                 else
475                         stage = 2;
476                 src[i + o->merge] = create_ce_entry(info, names + i, stage);
477         }
479         if (o->merge)
480                 return call_unpack_fn(src, o);
482         for (i = 0; i < n; i++)
483                 if (src[i] && src[i] != o->df_conflict_entry)
484                         add_entry(o, src[i], 0, 0);
485         return 0;
488 static int unpack_failed(struct unpack_trees_options *o, const char *message)
490         discard_index(&o->result);
491         if (!o->gently) {
492                 if (message)
493                         return error("%s", message);
494                 return -1;
495         }
496         return -1;
499 /* NEEDSWORK: give this a better name and share with tree-walk.c */
500 static int name_compare(const char *a, int a_len,
501                         const char *b, int b_len)
503         int len = (a_len < b_len) ? a_len : b_len;
504         int cmp = memcmp(a, b, len);
505         if (cmp)
506                 return cmp;
507         return (a_len - b_len);
510 /*
511  * The tree traversal is looking at name p.  If we have a matching entry,
512  * return it.  If name p is a directory in the index, do not return
513  * anything, as we will want to match it when the traversal descends into
514  * the directory.
515  */
516 static int find_cache_pos(struct traverse_info *info,
517                           const struct name_entry *p)
519         int pos;
520         struct unpack_trees_options *o = info->data;
521         struct index_state *index = o->src_index;
522         int pfxlen = info->pathlen;
523         int p_len = tree_entry_len(p->path, p->sha1);
525         for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
526                 struct cache_entry *ce = index->cache[pos];
527                 const char *ce_name, *ce_slash;
528                 int cmp, ce_len;
530                 if (ce->ce_flags & CE_UNPACKED) {
531                         /*
532                          * cache_bottom entry is already unpacked, so
533                          * we can never match it; don't check it
534                          * again.
535                          */
536                         if (pos == o->cache_bottom)
537                                 ++o->cache_bottom;
538                         continue;
539                 }
540                 if (!ce_in_traverse_path(ce, info))
541                         continue;
542                 ce_name = ce->name + pfxlen;
543                 ce_slash = strchr(ce_name, '/');
544                 if (ce_slash)
545                         ce_len = ce_slash - ce_name;
546                 else
547                         ce_len = ce_namelen(ce) - pfxlen;
548                 cmp = name_compare(p->path, p_len, ce_name, ce_len);
549                 /*
550                  * Exact match; if we have a directory we need to
551                  * delay returning it.
552                  */
553                 if (!cmp)
554                         return ce_slash ? -2 - pos : pos;
555                 if (0 < cmp)
556                         continue; /* keep looking */
557                 /*
558                  * ce_name sorts after p->path; could it be that we
559                  * have files under p->path directory in the index?
560                  * E.g.  ce_name == "t-i", and p->path == "t"; we may
561                  * have "t/a" in the index.
562                  */
563                 if (p_len < ce_len && !memcmp(ce_name, p->path, p_len) &&
564                     ce_name[p_len] < '/')
565                         continue; /* keep looking */
566                 break;
567         }
568         return -1;
571 static struct cache_entry *find_cache_entry(struct traverse_info *info,
572                                             const struct name_entry *p)
574         int pos = find_cache_pos(info, p);
575         struct unpack_trees_options *o = info->data;
577         if (0 <= pos)
578                 return o->src_index->cache[pos];
579         else
580                 return NULL;
583 static void debug_path(struct traverse_info *info)
585         if (info->prev) {
586                 debug_path(info->prev);
587                 if (*info->prev->name.path)
588                         putchar('/');
589         }
590         printf("%s", info->name.path);
593 static void debug_name_entry(int i, struct name_entry *n)
595         printf("ent#%d %06o %s\n", i,
596                n->path ? n->mode : 0,
597                n->path ? n->path : "(missing)");
600 static void debug_unpack_callback(int n,
601                                   unsigned long mask,
602                                   unsigned long dirmask,
603                                   struct name_entry *names,
604                                   struct traverse_info *info)
606         int i;
607         printf("* unpack mask %lu, dirmask %lu, cnt %d ",
608                mask, dirmask, n);
609         debug_path(info);
610         putchar('\n');
611         for (i = 0; i < n; i++)
612                 debug_name_entry(i, names + i);
615 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
617         struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
618         struct unpack_trees_options *o = info->data;
619         const struct name_entry *p = names;
621         /* Find first entry with a real name (we could use "mask" too) */
622         while (!p->mode)
623                 p++;
625         if (o->debug_unpack)
626                 debug_unpack_callback(n, mask, dirmask, names, info);
628         /* Are we supposed to look at the index too? */
629         if (o->merge) {
630                 while (1) {
631                         int cmp;
632                         struct cache_entry *ce;
634                         if (o->diff_index_cached)
635                                 ce = next_cache_entry(o);
636                         else
637                                 ce = find_cache_entry(info, p);
639                         if (!ce)
640                                 break;
641                         cmp = compare_entry(ce, info, p);
642                         if (cmp < 0) {
643                                 if (unpack_index_entry(ce, o) < 0)
644                                         return unpack_failed(o, NULL);
645                                 continue;
646                         }
647                         if (!cmp) {
648                                 if (ce_stage(ce)) {
649                                         /*
650                                          * If we skip unmerged index
651                                          * entries, we'll skip this
652                                          * entry *and* the tree
653                                          * entries associated with it!
654                                          */
655                                         if (o->skip_unmerged) {
656                                                 add_same_unmerged(ce, o);
657                                                 return mask;
658                                         }
659                                 }
660                                 src[0] = ce;
661                         }
662                         break;
663                 }
664         }
666         if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
667                 return -1;
669         if (src[0]) {
670                 if (ce_stage(src[0]))
671                         mark_ce_used_same_name(src[0], o);
672                 else
673                         mark_ce_used(src[0], o);
674         }
676         /* Now handle any directories.. */
677         if (dirmask) {
678                 unsigned long conflicts = mask & ~dirmask;
679                 if (o->merge) {
680                         conflicts <<= 1;
681                         if (src[0])
682                                 conflicts |= 1;
683                 }
685                 /* special case: "diff-index --cached" looking at a tree */
686                 if (o->diff_index_cached &&
687                     n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
688                         int matches;
689                         matches = cache_tree_matches_traversal(o->src_index->cache_tree,
690                                                                names, info);
691                         /*
692                          * Everything under the name matches; skip the
693                          * entire hierarchy.  diff_index_cached codepath
694                          * special cases D/F conflicts in such a way that
695                          * it does not do any look-ahead, so this is safe.
696                          */
697                         if (matches) {
698                                 o->cache_bottom += matches;
699                                 return mask;
700                         }
701                 }
703                 if (traverse_trees_recursive(n, dirmask, conflicts,
704                                              names, info) < 0)
705                         return -1;
706                 return mask;
707         }
709         return mask;
712 /*
713  * N-way merge "len" trees.  Returns 0 on success, -1 on failure to manipulate the
714  * resulting index, -2 on failure to reflect the changes to the work tree.
715  */
716 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
718         int i, ret;
719         static struct cache_entry *dfc;
720         struct exclude_list el;
722         if (len > MAX_UNPACK_TREES)
723                 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
724         memset(&state, 0, sizeof(state));
725         state.base_dir = "";
726         state.force = 1;
727         state.quiet = 1;
728         state.refresh_cache = 1;
730         memset(&el, 0, sizeof(el));
731         if (!core_apply_sparse_checkout || !o->update)
732                 o->skip_sparse_checkout = 1;
733         if (!o->skip_sparse_checkout) {
734                 if (add_excludes_from_file_to_list(git_path("info/sparse-checkout"), "", 0, NULL, &el, 0) < 0)
735                         o->skip_sparse_checkout = 1;
736                 else
737                         o->el = &el;
738         }
740         memset(&o->result, 0, sizeof(o->result));
741         o->result.initialized = 1;
742         o->result.timestamp.sec = o->src_index->timestamp.sec;
743         o->result.timestamp.nsec = o->src_index->timestamp.nsec;
744         o->merge_size = len;
745         mark_all_ce_unused(o->src_index);
747         if (!dfc)
748                 dfc = xcalloc(1, cache_entry_size(0));
749         o->df_conflict_entry = dfc;
751         if (len) {
752                 const char *prefix = o->prefix ? o->prefix : "";
753                 struct traverse_info info;
755                 setup_traverse_info(&info, prefix);
756                 info.fn = unpack_callback;
757                 info.data = o;
759                 if (o->prefix) {
760                         /*
761                          * Unpack existing index entries that sort before the
762                          * prefix the tree is spliced into.  Note that o->merge
763                          * is always true in this case.
764                          */
765                         while (1) {
766                                 struct cache_entry *ce = next_cache_entry(o);
767                                 if (!ce)
768                                         break;
769                                 if (ce_in_traverse_path(ce, &info))
770                                         break;
771                                 if (unpack_index_entry(ce, o) < 0)
772                                         goto return_failed;
773                         }
774                 }
776                 if (traverse_trees(len, t, &info) < 0)
777                         goto return_failed;
778         }
780         /* Any left-over entries in the index? */
781         if (o->merge) {
782                 while (1) {
783                         struct cache_entry *ce = next_cache_entry(o);
784                         if (!ce)
785                                 break;
786                         if (unpack_index_entry(ce, o) < 0)
787                                 goto return_failed;
788                 }
789         }
790         mark_all_ce_unused(o->src_index);
792         if (o->trivial_merges_only && o->nontrivial_merge) {
793                 ret = unpack_failed(o, "Merge requires file-level merging");
794                 goto done;
795         }
797         if (!o->skip_sparse_checkout) {
798                 int empty_worktree = 1;
799                 for (i = 0;i < o->result.cache_nr;i++) {
800                         struct cache_entry *ce = o->result.cache[i];
802                         if (apply_sparse_checkout(ce, o)) {
803                                 ret = -1;
804                                 goto done;
805                         }
806                         /*
807                          * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
808                          * area as a result of ce_skip_worktree() shortcuts in
809                          * verify_absent() and verify_uptodate(). Clear them.
810                          */
811                         if (ce_skip_worktree(ce))
812                                 ce->ce_flags &= ~(CE_UPDATE | CE_REMOVE);
813                         else
814                                 empty_worktree = 0;
816                 }
817                 if (o->result.cache_nr && empty_worktree) {
818                         ret = unpack_failed(o, "Sparse checkout leaves no entry on working directory");
819                         goto done;
820                 }
821         }
823         o->src_index = NULL;
824         ret = check_updates(o) ? (-2) : 0;
825         if (o->dst_index)
826                 *o->dst_index = o->result;
828 done:
829         for (i = 0;i < el.nr;i++)
830                 free(el.excludes[i]);
831         if (el.excludes)
832                 free(el.excludes);
834         return ret;
836 return_failed:
837         mark_all_ce_unused(o->src_index);
838         ret = unpack_failed(o, NULL);
839         goto done;
842 /* Here come the merge functions */
844 static int reject_merge(struct cache_entry *ce, struct unpack_trees_options *o)
846         return error(ERRORMSG(o, ERROR_WOULD_OVERWRITE), ce->name);
849 static int same(struct cache_entry *a, struct cache_entry *b)
851         if (!!a != !!b)
852                 return 0;
853         if (!a && !b)
854                 return 1;
855         if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
856                 return 0;
857         return a->ce_mode == b->ce_mode &&
858                !hashcmp(a->sha1, b->sha1);
862 /*
863  * When a CE gets turned into an unmerged entry, we
864  * want it to be up-to-date
865  */
866 static int verify_uptodate_1(struct cache_entry *ce,
867                                    struct unpack_trees_options *o,
868                                    enum unpack_trees_error_types error_type)
870         struct stat st;
872         if (o->index_only || (!((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce)) && (o->reset || ce_uptodate(ce))))
873                 return 0;
875         if (!lstat(ce->name, &st)) {
876                 unsigned changed = ie_match_stat(o->src_index, ce, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
877                 if (!changed)
878                         return 0;
879                 /*
880                  * NEEDSWORK: the current default policy is to allow
881                  * submodule to be out of sync wrt the supermodule
882                  * index.  This needs to be tightened later for
883                  * submodules that are marked to be automatically
884                  * checked out.
885                  */
886                 if (S_ISGITLINK(ce->ce_mode))
887                         return 0;
888                 errno = 0;
889         }
890         if (errno == ENOENT)
891                 return 0;
892         return o->gently ? -1 :
893                 error(ERRORMSG(o, error_type), ce->name);
896 static int verify_uptodate(struct cache_entry *ce,
897                            struct unpack_trees_options *o)
899         if (!o->skip_sparse_checkout && will_have_skip_worktree(ce, o))
900                 return 0;
901         return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
904 static int verify_uptodate_sparse(struct cache_entry *ce,
905                                   struct unpack_trees_options *o)
907         return verify_uptodate_1(ce, o, ERROR_SPARSE_NOT_UPTODATE_FILE);
910 static void invalidate_ce_path(struct cache_entry *ce, struct unpack_trees_options *o)
912         if (ce)
913                 cache_tree_invalidate_path(o->src_index->cache_tree, ce->name);
916 /*
917  * Check that checking out ce->sha1 in subdir ce->name is not
918  * going to overwrite any working files.
919  *
920  * Currently, git does not checkout subprojects during a superproject
921  * checkout, so it is not going to overwrite anything.
922  */
923 static int verify_clean_submodule(struct cache_entry *ce,
924                                       enum unpack_trees_error_types error_type,
925                                       struct unpack_trees_options *o)
927         return 0;
930 static int verify_clean_subdirectory(struct cache_entry *ce,
931                                       enum unpack_trees_error_types error_type,
932                                       struct unpack_trees_options *o)
934         /*
935          * we are about to extract "ce->name"; we would not want to lose
936          * anything in the existing directory there.
937          */
938         int namelen;
939         int i;
940         struct dir_struct d;
941         char *pathbuf;
942         int cnt = 0;
943         unsigned char sha1[20];
945         if (S_ISGITLINK(ce->ce_mode) &&
946             resolve_gitlink_ref(ce->name, "HEAD", sha1) == 0) {
947                 /* If we are not going to update the submodule, then
948                  * we don't care.
949                  */
950                 if (!hashcmp(sha1, ce->sha1))
951                         return 0;
952                 return verify_clean_submodule(ce, error_type, o);
953         }
955         /*
956          * First let's make sure we do not have a local modification
957          * in that directory.
958          */
959         namelen = strlen(ce->name);
960         for (i = locate_in_src_index(ce, o);
961              i < o->src_index->cache_nr;
962              i++) {
963                 struct cache_entry *ce2 = o->src_index->cache[i];
964                 int len = ce_namelen(ce2);
965                 if (len < namelen ||
966                     strncmp(ce->name, ce2->name, namelen) ||
967                     ce2->name[namelen] != '/')
968                         break;
969                 /*
970                  * ce2->name is an entry in the subdirectory to be
971                  * removed.
972                  */
973                 if (!ce_stage(ce2)) {
974                         if (verify_uptodate(ce2, o))
975                                 return -1;
976                         add_entry(o, ce2, CE_REMOVE, 0);
977                         mark_ce_used(ce2, o);
978                 }
979                 cnt++;
980         }
982         /*
983          * Then we need to make sure that we do not lose a locally
984          * present file that is not ignored.
985          */
986         pathbuf = xmalloc(namelen + 2);
987         memcpy(pathbuf, ce->name, namelen);
988         strcpy(pathbuf+namelen, "/");
990         memset(&d, 0, sizeof(d));
991         if (o->dir)
992                 d.exclude_per_dir = o->dir->exclude_per_dir;
993         i = read_directory(&d, pathbuf, namelen+1, NULL);
994         if (i)
995                 return o->gently ? -1 :
996                         error(ERRORMSG(o, ERROR_NOT_UPTODATE_DIR), ce->name);
997         free(pathbuf);
998         return cnt;
1001 /*
1002  * This gets called when there was no index entry for the tree entry 'dst',
1003  * but we found a file in the working tree that 'lstat()' said was fine,
1004  * and we're on a case-insensitive filesystem.
1005  *
1006  * See if we can find a case-insensitive match in the index that also
1007  * matches the stat information, and assume it's that other file!
1008  */
1009 static int icase_exists(struct unpack_trees_options *o, struct cache_entry *dst, struct stat *st)
1011         struct cache_entry *src;
1013         src = index_name_exists(o->src_index, dst->name, ce_namelen(dst), 1);
1014         return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
1017 /*
1018  * We do not want to remove or overwrite a working tree file that
1019  * is not tracked, unless it is ignored.
1020  */
1021 static int verify_absent_1(struct cache_entry *ce,
1022                                  enum unpack_trees_error_types error_type,
1023                                  struct unpack_trees_options *o)
1025         struct stat st;
1027         if (o->index_only || o->reset || !o->update)
1028                 return 0;
1030         if (has_symlink_or_noent_leading_path(ce->name, ce_namelen(ce)))
1031                 return 0;
1033         if (!lstat(ce->name, &st)) {
1034                 int dtype = ce_to_dtype(ce);
1035                 struct cache_entry *result;
1037                 /*
1038                  * It may be that the 'lstat()' succeeded even though
1039                  * target 'ce' was absent, because there is an old
1040                  * entry that is different only in case..
1041                  *
1042                  * Ignore that lstat() if it matches.
1043                  */
1044                 if (ignore_case && icase_exists(o, ce, &st))
1045                         return 0;
1047                 if (o->dir && excluded(o->dir, ce->name, &dtype))
1048                         /*
1049                          * ce->name is explicitly excluded, so it is Ok to
1050                          * overwrite it.
1051                          */
1052                         return 0;
1053                 if (S_ISDIR(st.st_mode)) {
1054                         /*
1055                          * We are checking out path "foo" and
1056                          * found "foo/." in the working tree.
1057                          * This is tricky -- if we have modified
1058                          * files that are in "foo/" we would lose
1059                          * them.
1060                          */
1061                         if (verify_clean_subdirectory(ce, error_type, o) < 0)
1062                                 return -1;
1063                         return 0;
1064                 }
1066                 /*
1067                  * The previous round may already have decided to
1068                  * delete this path, which is in a subdirectory that
1069                  * is being replaced with a blob.
1070                  */
1071                 result = index_name_exists(&o->result, ce->name, ce_namelen(ce), 0);
1072                 if (result) {
1073                         if (result->ce_flags & CE_REMOVE)
1074                                 return 0;
1075                 }
1077                 return o->gently ? -1 :
1078                         error(ERRORMSG(o, error_type), ce->name);
1079         }
1080         return 0;
1082 static int verify_absent(struct cache_entry *ce,
1083                          enum unpack_trees_error_types error_type,
1084                          struct unpack_trees_options *o)
1086         if (!o->skip_sparse_checkout && will_have_skip_worktree(ce, o))
1087                 return 0;
1088         return verify_absent_1(ce, error_type, o);
1091 static int verify_absent_sparse(struct cache_entry *ce,
1092                          enum unpack_trees_error_types error_type,
1093                          struct unpack_trees_options *o)
1095         enum unpack_trees_error_types orphaned_error = error_type;
1096         if (orphaned_error == ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN)
1097                 orphaned_error = ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN;
1099         return verify_absent_1(ce, orphaned_error, o);
1102 static int merged_entry(struct cache_entry *merge, struct cache_entry *old,
1103                 struct unpack_trees_options *o)
1105         int update = CE_UPDATE;
1107         if (!old) {
1108                 if (verify_absent(merge, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
1109                         return -1;
1110                 invalidate_ce_path(merge, o);
1111         } else if (!(old->ce_flags & CE_CONFLICTED)) {
1112                 /*
1113                  * See if we can re-use the old CE directly?
1114                  * That way we get the uptodate stat info.
1115                  *
1116                  * This also removes the UPDATE flag on a match; otherwise
1117                  * we will end up overwriting local changes in the work tree.
1118                  */
1119                 if (same(old, merge)) {
1120                         copy_cache_entry(merge, old);
1121                         update = 0;
1122                 } else {
1123                         if (verify_uptodate(old, o))
1124                                 return -1;
1125                         if (ce_skip_worktree(old))
1126                                 update |= CE_SKIP_WORKTREE;
1127                         invalidate_ce_path(old, o);
1128                 }
1129         } else {
1130                 /*
1131                  * Previously unmerged entry left as an existence
1132                  * marker by read_index_unmerged();
1133                  */
1134                 invalidate_ce_path(old, o);
1135         }
1137         add_entry(o, merge, update, CE_STAGEMASK);
1138         return 1;
1141 static int deleted_entry(struct cache_entry *ce, struct cache_entry *old,
1142                 struct unpack_trees_options *o)
1144         /* Did it exist in the index? */
1145         if (!old) {
1146                 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1147                         return -1;
1148                 return 0;
1149         }
1150         if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
1151                 return -1;
1152         add_entry(o, ce, CE_REMOVE, 0);
1153         invalidate_ce_path(ce, o);
1154         return 1;
1157 static int keep_entry(struct cache_entry *ce, struct unpack_trees_options *o)
1159         add_entry(o, ce, 0, 0);
1160         return 1;
1163 #if DBRT_DEBUG
1164 static void show_stage_entry(FILE *o,
1165                              const char *label, const struct cache_entry *ce)
1167         if (!ce)
1168                 fprintf(o, "%s (missing)\n", label);
1169         else
1170                 fprintf(o, "%s%06o %s %d\t%s\n",
1171                         label,
1172                         ce->ce_mode,
1173                         sha1_to_hex(ce->sha1),
1174                         ce_stage(ce),
1175                         ce->name);
1177 #endif
1179 int threeway_merge(struct cache_entry **stages, struct unpack_trees_options *o)
1181         struct cache_entry *index;
1182         struct cache_entry *head;
1183         struct cache_entry *remote = stages[o->head_idx + 1];
1184         int count;
1185         int head_match = 0;
1186         int remote_match = 0;
1188         int df_conflict_head = 0;
1189         int df_conflict_remote = 0;
1191         int any_anc_missing = 0;
1192         int no_anc_exists = 1;
1193         int i;
1195         for (i = 1; i < o->head_idx; i++) {
1196                 if (!stages[i] || stages[i] == o->df_conflict_entry)
1197                         any_anc_missing = 1;
1198                 else
1199                         no_anc_exists = 0;
1200         }
1202         index = stages[0];
1203         head = stages[o->head_idx];
1205         if (head == o->df_conflict_entry) {
1206                 df_conflict_head = 1;
1207                 head = NULL;
1208         }
1210         if (remote == o->df_conflict_entry) {
1211                 df_conflict_remote = 1;
1212                 remote = NULL;
1213         }
1215         /*
1216          * First, if there's a #16 situation, note that to prevent #13
1217          * and #14.
1218          */
1219         if (!same(remote, head)) {
1220                 for (i = 1; i < o->head_idx; i++) {
1221                         if (same(stages[i], head)) {
1222                                 head_match = i;
1223                         }
1224                         if (same(stages[i], remote)) {
1225                                 remote_match = i;
1226                         }
1227                 }
1228         }
1230         /*
1231          * We start with cases where the index is allowed to match
1232          * something other than the head: #14(ALT) and #2ALT, where it
1233          * is permitted to match the result instead.
1234          */
1235         /* #14, #14ALT, #2ALT */
1236         if (remote && !df_conflict_head && head_match && !remote_match) {
1237                 if (index && !same(index, remote) && !same(index, head))
1238                         return o->gently ? -1 : reject_merge(index, o);
1239                 return merged_entry(remote, index, o);
1240         }
1241         /*
1242          * If we have an entry in the index cache, then we want to
1243          * make sure that it matches head.
1244          */
1245         if (index && !same(index, head))
1246                 return o->gently ? -1 : reject_merge(index, o);
1248         if (head) {
1249                 /* #5ALT, #15 */
1250                 if (same(head, remote))
1251                         return merged_entry(head, index, o);
1252                 /* #13, #3ALT */
1253                 if (!df_conflict_remote && remote_match && !head_match)
1254                         return merged_entry(head, index, o);
1255         }
1257         /* #1 */
1258         if (!head && !remote && any_anc_missing)
1259                 return 0;
1261         /*
1262          * Under the "aggressive" rule, we resolve mostly trivial
1263          * cases that we historically had git-merge-one-file resolve.
1264          */
1265         if (o->aggressive) {
1266                 int head_deleted = !head;
1267                 int remote_deleted = !remote;
1268                 struct cache_entry *ce = NULL;
1270                 if (index)
1271                         ce = index;
1272                 else if (head)
1273                         ce = head;
1274                 else if (remote)
1275                         ce = remote;
1276                 else {
1277                         for (i = 1; i < o->head_idx; i++) {
1278                                 if (stages[i] && stages[i] != o->df_conflict_entry) {
1279                                         ce = stages[i];
1280                                         break;
1281                                 }
1282                         }
1283                 }
1285                 /*
1286                  * Deleted in both.
1287                  * Deleted in one and unchanged in the other.
1288                  */
1289                 if ((head_deleted && remote_deleted) ||
1290                     (head_deleted && remote && remote_match) ||
1291                     (remote_deleted && head && head_match)) {
1292                         if (index)
1293                                 return deleted_entry(index, index, o);
1294                         if (ce && !head_deleted) {
1295                                 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1296                                         return -1;
1297                         }
1298                         return 0;
1299                 }
1300                 /*
1301                  * Added in both, identically.
1302                  */
1303                 if (no_anc_exists && head && remote && same(head, remote))
1304                         return merged_entry(head, index, o);
1306         }
1308         /* Below are "no merge" cases, which require that the index be
1309          * up-to-date to avoid the files getting overwritten with
1310          * conflict resolution files.
1311          */
1312         if (index) {
1313                 if (verify_uptodate(index, o))
1314                         return -1;
1315         }
1317         o->nontrivial_merge = 1;
1319         /* #2, #3, #4, #6, #7, #9, #10, #11. */
1320         count = 0;
1321         if (!head_match || !remote_match) {
1322                 for (i = 1; i < o->head_idx; i++) {
1323                         if (stages[i] && stages[i] != o->df_conflict_entry) {
1324                                 keep_entry(stages[i], o);
1325                                 count++;
1326                                 break;
1327                         }
1328                 }
1329         }
1330 #if DBRT_DEBUG
1331         else {
1332                 fprintf(stderr, "read-tree: warning #16 detected\n");
1333                 show_stage_entry(stderr, "head   ", stages[head_match]);
1334                 show_stage_entry(stderr, "remote ", stages[remote_match]);
1335         }
1336 #endif
1337         if (head) { count += keep_entry(head, o); }
1338         if (remote) { count += keep_entry(remote, o); }
1339         return count;
1342 /*
1343  * Two-way merge.
1344  *
1345  * The rule is to "carry forward" what is in the index without losing
1346  * information across a "fast-forward", favoring a successful merge
1347  * over a merge failure when it makes sense.  For details of the
1348  * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
1349  *
1350  */
1351 int twoway_merge(struct cache_entry **src, struct unpack_trees_options *o)
1353         struct cache_entry *current = src[0];
1354         struct cache_entry *oldtree = src[1];
1355         struct cache_entry *newtree = src[2];
1357         if (o->merge_size != 2)
1358                 return error("Cannot do a twoway merge of %d trees",
1359                              o->merge_size);
1361         if (oldtree == o->df_conflict_entry)
1362                 oldtree = NULL;
1363         if (newtree == o->df_conflict_entry)
1364                 newtree = NULL;
1366         if (current) {
1367                 if ((!oldtree && !newtree) || /* 4 and 5 */
1368                     (!oldtree && newtree &&
1369                      same(current, newtree)) || /* 6 and 7 */
1370                     (oldtree && newtree &&
1371                      same(oldtree, newtree)) || /* 14 and 15 */
1372                     (oldtree && newtree &&
1373                      !same(oldtree, newtree) && /* 18 and 19 */
1374                      same(current, newtree))) {
1375                         return keep_entry(current, o);
1376                 }
1377                 else if (oldtree && !newtree && same(current, oldtree)) {
1378                         /* 10 or 11 */
1379                         return deleted_entry(oldtree, current, o);
1380                 }
1381                 else if (oldtree && newtree &&
1382                          same(current, oldtree) && !same(current, newtree)) {
1383                         /* 20 or 21 */
1384                         return merged_entry(newtree, current, o);
1385                 }
1386                 else {
1387                         /* all other failures */
1388                         if (oldtree)
1389                                 return o->gently ? -1 : reject_merge(oldtree, o);
1390                         if (current)
1391                                 return o->gently ? -1 : reject_merge(current, o);
1392                         if (newtree)
1393                                 return o->gently ? -1 : reject_merge(newtree, o);
1394                         return -1;
1395                 }
1396         }
1397         else if (newtree) {
1398                 if (oldtree && !o->initial_checkout) {
1399                         /*
1400                          * deletion of the path was staged;
1401                          */
1402                         if (same(oldtree, newtree))
1403                                 return 1;
1404                         return reject_merge(oldtree, o);
1405                 }
1406                 return merged_entry(newtree, current, o);
1407         }
1408         return deleted_entry(oldtree, current, o);
1411 /*
1412  * Bind merge.
1413  *
1414  * Keep the index entries at stage0, collapse stage1 but make sure
1415  * stage0 does not have anything there.
1416  */
1417 int bind_merge(struct cache_entry **src,
1418                 struct unpack_trees_options *o)
1420         struct cache_entry *old = src[0];
1421         struct cache_entry *a = src[1];
1423         if (o->merge_size != 1)
1424                 return error("Cannot do a bind merge of %d trees\n",
1425                              o->merge_size);
1426         if (a && old)
1427                 return o->gently ? -1 :
1428                         error(ERRORMSG(o, ERROR_BIND_OVERLAP), a->name, old->name);
1429         if (!a)
1430                 return keep_entry(old, o);
1431         else
1432                 return merged_entry(a, NULL, o);
1435 /*
1436  * One-way merge.
1437  *
1438  * The rule is:
1439  * - take the stat information from stage0, take the data from stage1
1440  */
1441 int oneway_merge(struct cache_entry **src, struct unpack_trees_options *o)
1443         struct cache_entry *old = src[0];
1444         struct cache_entry *a = src[1];
1446         if (o->merge_size != 1)
1447                 return error("Cannot do a oneway merge of %d trees",
1448                              o->merge_size);
1450         if (!a || a == o->df_conflict_entry)
1451                 return deleted_entry(old, old, o);
1453         if (old && same(old, a)) {
1454                 int update = 0;
1455                 if (o->reset && !ce_uptodate(old) && !ce_skip_worktree(old)) {
1456                         struct stat st;
1457                         if (lstat(old->name, &st) ||
1458                             ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
1459                                 update |= CE_UPDATE;
1460                 }
1461                 add_entry(o, old, update, 0);
1462                 return 0;
1463         }
1464         return merged_entry(a, old, o);