sh-setup: add new peel_committish() helper
[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"
11
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 setup_unpack_trees_porcelain(), for example.
18  */
19 static const char *unpack_plumbing_errors[NB_UNPACK_TREES_ERROR_TYPES] = {
20         /* ERROR_WOULD_OVERWRITE */
21         "Entry '%s' would be overwritten by merge. Cannot merge.",
22
23         /* ERROR_NOT_UPTODATE_FILE */
24         "Entry '%s' not uptodate. Cannot merge.",
25
26         /* ERROR_NOT_UPTODATE_DIR */
27         "Updating '%s' would lose untracked files in it",
28
29         /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
30         "Untracked working tree file '%s' would be overwritten by merge.",
31
32         /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
33         "Untracked working tree file '%s' would be removed by merge.",
34
35         /* ERROR_BIND_OVERLAP */
36         "Entry '%s' overlaps with '%s'.  Cannot bind.",
37
38         /* ERROR_SPARSE_NOT_UPTODATE_FILE */
39         "Entry '%s' not uptodate. Cannot update sparse checkout.",
40
41         /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
42         "Working tree file '%s' would be overwritten by sparse checkout update.",
43
44         /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
45         "Working tree file '%s' would be removed by sparse checkout update.",
46 };
47
48 #define ERRORMSG(o,type) \
49         ( ((o) && (o)->msgs[(type)]) \
50           ? ((o)->msgs[(type)])      \
51           : (unpack_plumbing_errors[(type)]) )
52
53 void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
54                                   const char *cmd)
55 {
56         int i;
57         const char **msgs = opts->msgs;
58         const char *msg;
59         char *tmp;
60         const char *cmd2 = strcmp(cmd, "checkout") ? cmd : "switch branches";
61         if (advice_commit_before_merge)
62                 msg = "Your local changes to the following files would be overwritten by %s:\n%%s"
63                         "Please, commit your changes or stash them before you can %s.";
64         else
65                 msg = "Your local changes to the following files would be overwritten by %s:\n%%s";
66         tmp = xmalloc(strlen(msg) + strlen(cmd) + strlen(cmd2) - 2);
67         sprintf(tmp, msg, cmd, cmd2);
68         msgs[ERROR_WOULD_OVERWRITE] = tmp;
69         msgs[ERROR_NOT_UPTODATE_FILE] = tmp;
70
71         msgs[ERROR_NOT_UPTODATE_DIR] =
72                 "Updating the following directories would lose untracked files in it:\n%s";
73
74         if (advice_commit_before_merge)
75                 msg = "The following untracked working tree files would be %s by %s:\n%%s"
76                         "Please move or remove them before you can %s.";
77         else
78                 msg = "The following untracked working tree files would be %s by %s:\n%%s";
79         tmp = xmalloc(strlen(msg) + strlen(cmd) + strlen("removed") + strlen(cmd2) - 4);
80         sprintf(tmp, msg, "removed", cmd, cmd2);
81         msgs[ERROR_WOULD_LOSE_UNTRACKED_REMOVED] = tmp;
82         tmp = xmalloc(strlen(msg) + strlen(cmd) + strlen("overwritten") + strlen(cmd2) - 4);
83         sprintf(tmp, msg, "overwritten", cmd, cmd2);
84         msgs[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN] = tmp;
85
86         /*
87          * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
88          * cannot easily display it as a list.
89          */
90         msgs[ERROR_BIND_OVERLAP] = "Entry '%s' overlaps with '%s'.  Cannot bind.";
91
92         msgs[ERROR_SPARSE_NOT_UPTODATE_FILE] =
93                 "Cannot update sparse checkout: the following entries are not up-to-date:\n%s";
94         msgs[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN] =
95                 "The following Working tree files would be overwritten by sparse checkout update:\n%s";
96         msgs[ERROR_WOULD_LOSE_ORPHANED_REMOVED] =
97                 "The following Working tree files would be removed by sparse checkout update:\n%s";
98
99         opts->show_all_errors = 1;
100         /* rejected paths may not have a static buffer */
101         for (i = 0; i < ARRAY_SIZE(opts->unpack_rejects); i++)
102                 opts->unpack_rejects[i].strdup_strings = 1;
103 }
104
105 static void do_add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
106                          unsigned int set, unsigned int clear)
107 {
108         clear |= CE_HASHED | CE_UNHASHED;
109
110         if (set & CE_REMOVE)
111                 set |= CE_WT_REMOVE;
112
113         ce->next = NULL;
114         ce->ce_flags = (ce->ce_flags & ~clear) | set;
115         add_index_entry(&o->result, ce,
116                         ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
117 }
118
119 static struct cache_entry *dup_entry(const struct cache_entry *ce)
120 {
121         unsigned int size = ce_size(ce);
122         struct cache_entry *new = xmalloc(size);
123
124         memcpy(new, ce, size);
125         return new;
126 }
127
128 static void add_entry(struct unpack_trees_options *o,
129                       const struct cache_entry *ce,
130                       unsigned int set, unsigned int clear)
131 {
132         do_add_entry(o, dup_entry(ce), set, clear);
133 }
134
135 /*
136  * add error messages on path <path>
137  * corresponding to the type <e> with the message <msg>
138  * indicating if it should be display in porcelain or not
139  */
140 static int add_rejected_path(struct unpack_trees_options *o,
141                              enum unpack_trees_error_types e,
142                              const char *path)
143 {
144         if (!o->show_all_errors)
145                 return error(ERRORMSG(o, e), path);
146
147         /*
148          * Otherwise, insert in a list for future display by
149          * display_error_msgs()
150          */
151         string_list_append(&o->unpack_rejects[e], path);
152         return -1;
153 }
154
155 /*
156  * display all the error messages stored in a nice way
157  */
158 static void display_error_msgs(struct unpack_trees_options *o)
159 {
160         int e, i;
161         int something_displayed = 0;
162         for (e = 0; e < NB_UNPACK_TREES_ERROR_TYPES; e++) {
163                 struct string_list *rejects = &o->unpack_rejects[e];
164                 if (rejects->nr > 0) {
165                         struct strbuf path = STRBUF_INIT;
166                         something_displayed = 1;
167                         for (i = 0; i < rejects->nr; i++)
168                                 strbuf_addf(&path, "\t%s\n", rejects->items[i].string);
169                         error(ERRORMSG(o, e), path.buf);
170                         strbuf_release(&path);
171                 }
172                 string_list_clear(rejects, 0);
173         }
174         if (something_displayed)
175                 fprintf(stderr, "Aborting\n");
176 }
177
178 /*
179  * Unlink the last component and schedule the leading directories for
180  * removal, such that empty directories get removed.
181  */
182 static void unlink_entry(struct cache_entry *ce)
183 {
184         if (!check_leading_path(ce->name, ce_namelen(ce)))
185                 return;
186         if (remove_or_warn(ce->ce_mode, ce->name))
187                 return;
188         schedule_dir_for_removal(ce->name, ce_namelen(ce));
189 }
190
191 static struct checkout state;
192 static int check_updates(struct unpack_trees_options *o)
193 {
194         unsigned cnt = 0, total = 0;
195         struct progress *progress = NULL;
196         struct index_state *index = &o->result;
197         int i;
198         int errs = 0;
199
200         if (o->update && o->verbose_update) {
201                 for (total = cnt = 0; cnt < index->cache_nr; cnt++) {
202                         struct cache_entry *ce = index->cache[cnt];
203                         if (ce->ce_flags & (CE_UPDATE | CE_WT_REMOVE))
204                                 total++;
205                 }
206
207                 progress = start_progress_delay("Checking out files",
208                                                 total, 50, 1);
209                 cnt = 0;
210         }
211
212         if (o->update)
213                 git_attr_set_direction(GIT_ATTR_CHECKOUT, &o->result);
214         for (i = 0; i < index->cache_nr; i++) {
215                 struct cache_entry *ce = index->cache[i];
216
217                 if (ce->ce_flags & CE_WT_REMOVE) {
218                         display_progress(progress, ++cnt);
219                         if (o->update && !o->dry_run)
220                                 unlink_entry(ce);
221                         continue;
222                 }
223         }
224         remove_marked_cache_entries(&o->result);
225         remove_scheduled_dirs();
226
227         for (i = 0; i < index->cache_nr; i++) {
228                 struct cache_entry *ce = index->cache[i];
229
230                 if (ce->ce_flags & CE_UPDATE) {
231                         display_progress(progress, ++cnt);
232                         ce->ce_flags &= ~CE_UPDATE;
233                         if (o->update && !o->dry_run) {
234                                 errs |= checkout_entry(ce, &state, NULL);
235                         }
236                 }
237         }
238         stop_progress(&progress);
239         if (o->update)
240                 git_attr_set_direction(GIT_ATTR_CHECKIN, NULL);
241         return errs != 0;
242 }
243
244 static int verify_uptodate_sparse(const struct cache_entry *ce,
245                                   struct unpack_trees_options *o);
246 static int verify_absent_sparse(const struct cache_entry *ce,
247                                 enum unpack_trees_error_types,
248                                 struct unpack_trees_options *o);
249
250 static int apply_sparse_checkout(struct cache_entry *ce, struct unpack_trees_options *o)
251 {
252         int was_skip_worktree = ce_skip_worktree(ce);
253
254         if (ce->ce_flags & CE_NEW_SKIP_WORKTREE)
255                 ce->ce_flags |= CE_SKIP_WORKTREE;
256         else
257                 ce->ce_flags &= ~CE_SKIP_WORKTREE;
258
259         /*
260          * if (!was_skip_worktree && !ce_skip_worktree()) {
261          *      This is perfectly normal. Move on;
262          * }
263          */
264
265         /*
266          * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
267          * area as a result of ce_skip_worktree() shortcuts in
268          * verify_absent() and verify_uptodate().
269          * Make sure they don't modify worktree if they are already
270          * outside checkout area
271          */
272         if (was_skip_worktree && ce_skip_worktree(ce)) {
273                 ce->ce_flags &= ~CE_UPDATE;
274
275                 /*
276                  * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
277                  * on to get that file removed from both index and worktree.
278                  * If that file is already outside worktree area, don't
279                  * bother remove it.
280                  */
281                 if (ce->ce_flags & CE_REMOVE)
282                         ce->ce_flags &= ~CE_WT_REMOVE;
283         }
284
285         if (!was_skip_worktree && ce_skip_worktree(ce)) {
286                 /*
287                  * If CE_UPDATE is set, verify_uptodate() must be called already
288                  * also stat info may have lost after merged_entry() so calling
289                  * verify_uptodate() again may fail
290                  */
291                 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
292                         return -1;
293                 ce->ce_flags |= CE_WT_REMOVE;
294         }
295         if (was_skip_worktree && !ce_skip_worktree(ce)) {
296                 if (verify_absent_sparse(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
297                         return -1;
298                 ce->ce_flags |= CE_UPDATE;
299         }
300         return 0;
301 }
302
303 static inline int call_unpack_fn(const struct cache_entry * const *src,
304                                  struct unpack_trees_options *o)
305 {
306         int ret = o->fn(src, o);
307         if (ret > 0)
308                 ret = 0;
309         return ret;
310 }
311
312 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
313 {
314         ce->ce_flags |= CE_UNPACKED;
315
316         if (o->cache_bottom < o->src_index->cache_nr &&
317             o->src_index->cache[o->cache_bottom] == ce) {
318                 int bottom = o->cache_bottom;
319                 while (bottom < o->src_index->cache_nr &&
320                        o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
321                         bottom++;
322                 o->cache_bottom = bottom;
323         }
324 }
325
326 static void mark_all_ce_unused(struct index_state *index)
327 {
328         int i;
329         for (i = 0; i < index->cache_nr; i++)
330                 index->cache[i]->ce_flags &= ~(CE_UNPACKED | CE_ADDED | CE_NEW_SKIP_WORKTREE);
331 }
332
333 static int locate_in_src_index(const struct cache_entry *ce,
334                                struct unpack_trees_options *o)
335 {
336         struct index_state *index = o->src_index;
337         int len = ce_namelen(ce);
338         int pos = index_name_pos(index, ce->name, len);
339         if (pos < 0)
340                 pos = -1 - pos;
341         return pos;
342 }
343
344 /*
345  * We call unpack_index_entry() with an unmerged cache entry
346  * only in diff-index, and it wants a single callback.  Skip
347  * the other unmerged entry with the same name.
348  */
349 static void mark_ce_used_same_name(struct cache_entry *ce,
350                                    struct unpack_trees_options *o)
351 {
352         struct index_state *index = o->src_index;
353         int len = ce_namelen(ce);
354         int pos;
355
356         for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
357                 struct cache_entry *next = index->cache[pos];
358                 if (len != ce_namelen(next) ||
359                     memcmp(ce->name, next->name, len))
360                         break;
361                 mark_ce_used(next, o);
362         }
363 }
364
365 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o)
366 {
367         const struct index_state *index = o->src_index;
368         int pos = o->cache_bottom;
369
370         while (pos < index->cache_nr) {
371                 struct cache_entry *ce = index->cache[pos];
372                 if (!(ce->ce_flags & CE_UNPACKED))
373                         return ce;
374                 pos++;
375         }
376         return NULL;
377 }
378
379 static void add_same_unmerged(struct cache_entry *ce,
380                               struct unpack_trees_options *o)
381 {
382         struct index_state *index = o->src_index;
383         int len = ce_namelen(ce);
384         int pos = index_name_pos(index, ce->name, len);
385
386         if (0 <= pos)
387                 die("programming error in a caller of mark_ce_used_same_name");
388         for (pos = -pos - 1; pos < index->cache_nr; pos++) {
389                 struct cache_entry *next = index->cache[pos];
390                 if (len != ce_namelen(next) ||
391                     memcmp(ce->name, next->name, len))
392                         break;
393                 add_entry(o, next, 0, 0);
394                 mark_ce_used(next, o);
395         }
396 }
397
398 static int unpack_index_entry(struct cache_entry *ce,
399                               struct unpack_trees_options *o)
400 {
401         const struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
402         int ret;
403
404         src[0] = ce;
405
406         mark_ce_used(ce, o);
407         if (ce_stage(ce)) {
408                 if (o->skip_unmerged) {
409                         add_entry(o, ce, 0, 0);
410                         return 0;
411                 }
412         }
413         ret = call_unpack_fn(src, o);
414         if (ce_stage(ce))
415                 mark_ce_used_same_name(ce, o);
416         return ret;
417 }
418
419 static int find_cache_pos(struct traverse_info *, const struct name_entry *);
420
421 static void restore_cache_bottom(struct traverse_info *info, int bottom)
422 {
423         struct unpack_trees_options *o = info->data;
424
425         if (o->diff_index_cached)
426                 return;
427         o->cache_bottom = bottom;
428 }
429
430 static int switch_cache_bottom(struct traverse_info *info)
431 {
432         struct unpack_trees_options *o = info->data;
433         int ret, pos;
434
435         if (o->diff_index_cached)
436                 return 0;
437         ret = o->cache_bottom;
438         pos = find_cache_pos(info->prev, &info->name);
439
440         if (pos < -1)
441                 o->cache_bottom = -2 - pos;
442         else if (pos < 0)
443                 o->cache_bottom = o->src_index->cache_nr;
444         return ret;
445 }
446
447 static int traverse_trees_recursive(int n, unsigned long dirmask,
448                                     unsigned long df_conflicts,
449                                     struct name_entry *names,
450                                     struct traverse_info *info)
451 {
452         int i, ret, bottom;
453         struct tree_desc t[MAX_UNPACK_TREES];
454         void *buf[MAX_UNPACK_TREES];
455         struct traverse_info newinfo;
456         struct name_entry *p;
457
458         p = names;
459         while (!p->mode)
460                 p++;
461
462         newinfo = *info;
463         newinfo.prev = info;
464         newinfo.pathspec = info->pathspec;
465         newinfo.name = *p;
466         newinfo.pathlen += tree_entry_len(p) + 1;
467         newinfo.conflicts |= df_conflicts;
468
469         for (i = 0; i < n; i++, dirmask >>= 1) {
470                 const unsigned char *sha1 = NULL;
471                 if (dirmask & 1)
472                         sha1 = names[i].sha1;
473                 buf[i] = fill_tree_descriptor(t+i, sha1);
474         }
475
476         bottom = switch_cache_bottom(&newinfo);
477         ret = traverse_trees(n, t, &newinfo);
478         restore_cache_bottom(&newinfo, bottom);
479
480         for (i = 0; i < n; i++)
481                 free(buf[i]);
482
483         return ret;
484 }
485
486 /*
487  * Compare the traverse-path to the cache entry without actually
488  * having to generate the textual representation of the traverse
489  * path.
490  *
491  * NOTE! This *only* compares up to the size of the traverse path
492  * itself - the caller needs to do the final check for the cache
493  * entry having more data at the end!
494  */
495 static int do_compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
496 {
497         int len, pathlen, ce_len;
498         const char *ce_name;
499
500         if (info->prev) {
501                 int cmp = do_compare_entry(ce, info->prev, &info->name);
502                 if (cmp)
503                         return cmp;
504         }
505         pathlen = info->pathlen;
506         ce_len = ce_namelen(ce);
507
508         /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
509         if (ce_len < pathlen)
510                 return -1;
511
512         ce_len -= pathlen;
513         ce_name = ce->name + pathlen;
514
515         len = tree_entry_len(n);
516         return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
517 }
518
519 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
520 {
521         int cmp = do_compare_entry(ce, info, n);
522         if (cmp)
523                 return cmp;
524
525         /*
526          * Even if the beginning compared identically, the ce should
527          * compare as bigger than a directory leading up to it!
528          */
529         return ce_namelen(ce) > traverse_path_len(info, n);
530 }
531
532 static int ce_in_traverse_path(const struct cache_entry *ce,
533                                const struct traverse_info *info)
534 {
535         if (!info->prev)
536                 return 1;
537         if (do_compare_entry(ce, info->prev, &info->name))
538                 return 0;
539         /*
540          * If ce (blob) is the same name as the path (which is a tree
541          * we will be descending into), it won't be inside it.
542          */
543         return (info->pathlen < ce_namelen(ce));
544 }
545
546 static struct cache_entry *create_ce_entry(const struct traverse_info *info, const struct name_entry *n, int stage)
547 {
548         int len = traverse_path_len(info, n);
549         struct cache_entry *ce = xcalloc(1, cache_entry_size(len));
550
551         ce->ce_mode = create_ce_mode(n->mode);
552         ce->ce_flags = create_ce_flags(stage);
553         ce->ce_namelen = len;
554         hashcpy(ce->sha1, n->sha1);
555         make_traverse_path(ce->name, info, n);
556
557         return ce;
558 }
559
560 static int unpack_nondirectories(int n, unsigned long mask,
561                                  unsigned long dirmask,
562                                  struct cache_entry **src,
563                                  const struct name_entry *names,
564                                  const struct traverse_info *info)
565 {
566         int i;
567         struct unpack_trees_options *o = info->data;
568         unsigned long conflicts;
569
570         /* Do we have *only* directories? Nothing to do */
571         if (mask == dirmask && !src[0])
572                 return 0;
573
574         conflicts = info->conflicts;
575         if (o->merge)
576                 conflicts >>= 1;
577         conflicts |= dirmask;
578
579         /*
580          * Ok, we've filled in up to any potential index entry in src[0],
581          * now do the rest.
582          */
583         for (i = 0; i < n; i++) {
584                 int stage;
585                 unsigned int bit = 1ul << i;
586                 if (conflicts & bit) {
587                         src[i + o->merge] = o->df_conflict_entry;
588                         continue;
589                 }
590                 if (!(mask & bit))
591                         continue;
592                 if (!o->merge)
593                         stage = 0;
594                 else if (i + 1 < o->head_idx)
595                         stage = 1;
596                 else if (i + 1 > o->head_idx)
597                         stage = 3;
598                 else
599                         stage = 2;
600                 src[i + o->merge] = create_ce_entry(info, names + i, stage);
601         }
602
603         if (o->merge) {
604                 int rc = call_unpack_fn((const struct cache_entry * const *)src,
605                                         o);
606                 for (i = 0; i < n; i++) {
607                         struct cache_entry *ce = src[i + o->merge];
608                         if (ce != o->df_conflict_entry)
609                                 free(ce);
610                 }
611                 return rc;
612         }
613
614         for (i = 0; i < n; i++)
615                 if (src[i] && src[i] != o->df_conflict_entry)
616                         do_add_entry(o, src[i], 0, 0);
617         return 0;
618 }
619
620 static int unpack_failed(struct unpack_trees_options *o, const char *message)
621 {
622         discard_index(&o->result);
623         if (!o->gently && !o->exiting_early) {
624                 if (message)
625                         return error("%s", message);
626                 return -1;
627         }
628         return -1;
629 }
630
631 /* NEEDSWORK: give this a better name and share with tree-walk.c */
632 static int name_compare(const char *a, int a_len,
633                         const char *b, int b_len)
634 {
635         int len = (a_len < b_len) ? a_len : b_len;
636         int cmp = memcmp(a, b, len);
637         if (cmp)
638                 return cmp;
639         return (a_len - b_len);
640 }
641
642 /*
643  * The tree traversal is looking at name p.  If we have a matching entry,
644  * return it.  If name p is a directory in the index, do not return
645  * anything, as we will want to match it when the traversal descends into
646  * the directory.
647  */
648 static int find_cache_pos(struct traverse_info *info,
649                           const struct name_entry *p)
650 {
651         int pos;
652         struct unpack_trees_options *o = info->data;
653         struct index_state *index = o->src_index;
654         int pfxlen = info->pathlen;
655         int p_len = tree_entry_len(p);
656
657         for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
658                 struct cache_entry *ce = index->cache[pos];
659                 const char *ce_name, *ce_slash;
660                 int cmp, ce_len;
661
662                 if (ce->ce_flags & CE_UNPACKED) {
663                         /*
664                          * cache_bottom entry is already unpacked, so
665                          * we can never match it; don't check it
666                          * again.
667                          */
668                         if (pos == o->cache_bottom)
669                                 ++o->cache_bottom;
670                         continue;
671                 }
672                 if (!ce_in_traverse_path(ce, info))
673                         continue;
674                 ce_name = ce->name + pfxlen;
675                 ce_slash = strchr(ce_name, '/');
676                 if (ce_slash)
677                         ce_len = ce_slash - ce_name;
678                 else
679                         ce_len = ce_namelen(ce) - pfxlen;
680                 cmp = name_compare(p->path, p_len, ce_name, ce_len);
681                 /*
682                  * Exact match; if we have a directory we need to
683                  * delay returning it.
684                  */
685                 if (!cmp)
686                         return ce_slash ? -2 - pos : pos;
687                 if (0 < cmp)
688                         continue; /* keep looking */
689                 /*
690                  * ce_name sorts after p->path; could it be that we
691                  * have files under p->path directory in the index?
692                  * E.g.  ce_name == "t-i", and p->path == "t"; we may
693                  * have "t/a" in the index.
694                  */
695                 if (p_len < ce_len && !memcmp(ce_name, p->path, p_len) &&
696                     ce_name[p_len] < '/')
697                         continue; /* keep looking */
698                 break;
699         }
700         return -1;
701 }
702
703 static struct cache_entry *find_cache_entry(struct traverse_info *info,
704                                             const struct name_entry *p)
705 {
706         int pos = find_cache_pos(info, p);
707         struct unpack_trees_options *o = info->data;
708
709         if (0 <= pos)
710                 return o->src_index->cache[pos];
711         else
712                 return NULL;
713 }
714
715 static void debug_path(struct traverse_info *info)
716 {
717         if (info->prev) {
718                 debug_path(info->prev);
719                 if (*info->prev->name.path)
720                         putchar('/');
721         }
722         printf("%s", info->name.path);
723 }
724
725 static void debug_name_entry(int i, struct name_entry *n)
726 {
727         printf("ent#%d %06o %s\n", i,
728                n->path ? n->mode : 0,
729                n->path ? n->path : "(missing)");
730 }
731
732 static void debug_unpack_callback(int n,
733                                   unsigned long mask,
734                                   unsigned long dirmask,
735                                   struct name_entry *names,
736                                   struct traverse_info *info)
737 {
738         int i;
739         printf("* unpack mask %lu, dirmask %lu, cnt %d ",
740                mask, dirmask, n);
741         debug_path(info);
742         putchar('\n');
743         for (i = 0; i < n; i++)
744                 debug_name_entry(i, names + i);
745 }
746
747 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
748 {
749         struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
750         struct unpack_trees_options *o = info->data;
751         const struct name_entry *p = names;
752
753         /* Find first entry with a real name (we could use "mask" too) */
754         while (!p->mode)
755                 p++;
756
757         if (o->debug_unpack)
758                 debug_unpack_callback(n, mask, dirmask, names, info);
759
760         /* Are we supposed to look at the index too? */
761         if (o->merge) {
762                 while (1) {
763                         int cmp;
764                         struct cache_entry *ce;
765
766                         if (o->diff_index_cached)
767                                 ce = next_cache_entry(o);
768                         else
769                                 ce = find_cache_entry(info, p);
770
771                         if (!ce)
772                                 break;
773                         cmp = compare_entry(ce, info, p);
774                         if (cmp < 0) {
775                                 if (unpack_index_entry(ce, o) < 0)
776                                         return unpack_failed(o, NULL);
777                                 continue;
778                         }
779                         if (!cmp) {
780                                 if (ce_stage(ce)) {
781                                         /*
782                                          * If we skip unmerged index
783                                          * entries, we'll skip this
784                                          * entry *and* the tree
785                                          * entries associated with it!
786                                          */
787                                         if (o->skip_unmerged) {
788                                                 add_same_unmerged(ce, o);
789                                                 return mask;
790                                         }
791                                 }
792                                 src[0] = ce;
793                         }
794                         break;
795                 }
796         }
797
798         if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
799                 return -1;
800
801         if (o->merge && src[0]) {
802                 if (ce_stage(src[0]))
803                         mark_ce_used_same_name(src[0], o);
804                 else
805                         mark_ce_used(src[0], o);
806         }
807
808         /* Now handle any directories.. */
809         if (dirmask) {
810                 unsigned long conflicts = mask & ~dirmask;
811                 if (o->merge) {
812                         conflicts <<= 1;
813                         if (src[0])
814                                 conflicts |= 1;
815                 }
816
817                 /* special case: "diff-index --cached" looking at a tree */
818                 if (o->diff_index_cached &&
819                     n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
820                         int matches;
821                         matches = cache_tree_matches_traversal(o->src_index->cache_tree,
822                                                                names, info);
823                         /*
824                          * Everything under the name matches; skip the
825                          * entire hierarchy.  diff_index_cached codepath
826                          * special cases D/F conflicts in such a way that
827                          * it does not do any look-ahead, so this is safe.
828                          */
829                         if (matches) {
830                                 o->cache_bottom += matches;
831                                 return mask;
832                         }
833                 }
834
835                 if (traverse_trees_recursive(n, dirmask, conflicts,
836                                              names, info) < 0)
837                         return -1;
838                 return mask;
839         }
840
841         return mask;
842 }
843
844 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
845                             char *prefix, int prefix_len,
846                             int select_mask, int clear_mask,
847                             struct exclude_list *el, int defval);
848
849 /* Whole directory matching */
850 static int clear_ce_flags_dir(struct cache_entry **cache, int nr,
851                               char *prefix, int prefix_len,
852                               char *basename,
853                               int select_mask, int clear_mask,
854                               struct exclude_list *el, int defval)
855 {
856         struct cache_entry **cache_end;
857         int dtype = DT_DIR;
858         int ret = is_excluded_from_list(prefix, prefix_len,
859                                         basename, &dtype, el);
860
861         prefix[prefix_len++] = '/';
862
863         /* If undecided, use matching result of parent dir in defval */
864         if (ret < 0)
865                 ret = defval;
866
867         for (cache_end = cache; cache_end != cache + nr; cache_end++) {
868                 struct cache_entry *ce = *cache_end;
869                 if (strncmp(ce->name, prefix, prefix_len))
870                         break;
871         }
872
873         /*
874          * TODO: check el, if there are no patterns that may conflict
875          * with ret (iow, we know in advance the incl/excl
876          * decision for the entire directory), clear flag here without
877          * calling clear_ce_flags_1(). That function will call
878          * the expensive is_excluded_from_list() on every entry.
879          */
880         return clear_ce_flags_1(cache, cache_end - cache,
881                                 prefix, prefix_len,
882                                 select_mask, clear_mask,
883                                 el, ret);
884 }
885
886 /*
887  * Traverse the index, find every entry that matches according to
888  * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
889  * number of traversed entries.
890  *
891  * If select_mask is non-zero, only entries whose ce_flags has on of
892  * those bits enabled are traversed.
893  *
894  * cache        : pointer to an index entry
895  * prefix_len   : an offset to its path
896  *
897  * The current path ("prefix") including the trailing '/' is
898  *   cache[0]->name[0..(prefix_len-1)]
899  * Top level path has prefix_len zero.
900  */
901 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
902                             char *prefix, int prefix_len,
903                             int select_mask, int clear_mask,
904                             struct exclude_list *el, int defval)
905 {
906         struct cache_entry **cache_end = cache + nr;
907
908         /*
909          * Process all entries that have the given prefix and meet
910          * select_mask condition
911          */
912         while(cache != cache_end) {
913                 struct cache_entry *ce = *cache;
914                 const char *name, *slash;
915                 int len, dtype, ret;
916
917                 if (select_mask && !(ce->ce_flags & select_mask)) {
918                         cache++;
919                         continue;
920                 }
921
922                 if (prefix_len && strncmp(ce->name, prefix, prefix_len))
923                         break;
924
925                 name = ce->name + prefix_len;
926                 slash = strchr(name, '/');
927
928                 /* If it's a directory, try whole directory match first */
929                 if (slash) {
930                         int processed;
931
932                         len = slash - name;
933                         memcpy(prefix + prefix_len, name, len);
934
935                         /*
936                          * terminate the string (no trailing slash),
937                          * clear_c_f_dir needs it
938                          */
939                         prefix[prefix_len + len] = '\0';
940                         processed = clear_ce_flags_dir(cache, cache_end - cache,
941                                                        prefix, prefix_len + len,
942                                                        prefix + prefix_len,
943                                                        select_mask, clear_mask,
944                                                        el, defval);
945
946                         /* clear_c_f_dir eats a whole dir already? */
947                         if (processed) {
948                                 cache += processed;
949                                 continue;
950                         }
951
952                         prefix[prefix_len + len++] = '/';
953                         cache += clear_ce_flags_1(cache, cache_end - cache,
954                                                   prefix, prefix_len + len,
955                                                   select_mask, clear_mask, el, defval);
956                         continue;
957                 }
958
959                 /* Non-directory */
960                 dtype = ce_to_dtype(ce);
961                 ret = is_excluded_from_list(ce->name, ce_namelen(ce),
962                                             name, &dtype, el);
963                 if (ret < 0)
964                         ret = defval;
965                 if (ret > 0)
966                         ce->ce_flags &= ~clear_mask;
967                 cache++;
968         }
969         return nr - (cache_end - cache);
970 }
971
972 static int clear_ce_flags(struct cache_entry **cache, int nr,
973                             int select_mask, int clear_mask,
974                             struct exclude_list *el)
975 {
976         char prefix[PATH_MAX];
977         return clear_ce_flags_1(cache, nr,
978                                 prefix, 0,
979                                 select_mask, clear_mask,
980                                 el, 0);
981 }
982
983 /*
984  * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
985  */
986 static void mark_new_skip_worktree(struct exclude_list *el,
987                                    struct index_state *the_index,
988                                    int select_flag, int skip_wt_flag)
989 {
990         int i;
991
992         /*
993          * 1. Pretend the narrowest worktree: only unmerged entries
994          * are checked out
995          */
996         for (i = 0; i < the_index->cache_nr; i++) {
997                 struct cache_entry *ce = the_index->cache[i];
998
999                 if (select_flag && !(ce->ce_flags & select_flag))
1000                         continue;
1001
1002                 if (!ce_stage(ce))
1003                         ce->ce_flags |= skip_wt_flag;
1004                 else
1005                         ce->ce_flags &= ~skip_wt_flag;
1006         }
1007
1008         /*
1009          * 2. Widen worktree according to sparse-checkout file.
1010          * Matched entries will have skip_wt_flag cleared (i.e. "in")
1011          */
1012         clear_ce_flags(the_index->cache, the_index->cache_nr,
1013                        select_flag, skip_wt_flag, el);
1014 }
1015
1016 static int verify_absent(const struct cache_entry *,
1017                          enum unpack_trees_error_types,
1018                          struct unpack_trees_options *);
1019 /*
1020  * N-way merge "len" trees.  Returns 0 on success, -1 on failure to manipulate the
1021  * resulting index, -2 on failure to reflect the changes to the work tree.
1022  *
1023  * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1024  */
1025 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
1026 {
1027         int i, ret;
1028         static struct cache_entry *dfc;
1029         struct exclude_list el;
1030
1031         if (len > MAX_UNPACK_TREES)
1032                 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
1033         memset(&state, 0, sizeof(state));
1034         state.base_dir = "";
1035         state.force = 1;
1036         state.quiet = 1;
1037         state.refresh_cache = 1;
1038
1039         memset(&el, 0, sizeof(el));
1040         if (!core_apply_sparse_checkout || !o->update)
1041                 o->skip_sparse_checkout = 1;
1042         if (!o->skip_sparse_checkout) {
1043                 if (add_excludes_from_file_to_list(git_path("info/sparse-checkout"), "", 0, &el, 0) < 0)
1044                         o->skip_sparse_checkout = 1;
1045                 else
1046                         o->el = &el;
1047         }
1048
1049         memset(&o->result, 0, sizeof(o->result));
1050         o->result.initialized = 1;
1051         o->result.timestamp.sec = o->src_index->timestamp.sec;
1052         o->result.timestamp.nsec = o->src_index->timestamp.nsec;
1053         o->result.version = o->src_index->version;
1054         o->merge_size = len;
1055         mark_all_ce_unused(o->src_index);
1056
1057         /*
1058          * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1059          */
1060         if (!o->skip_sparse_checkout)
1061                 mark_new_skip_worktree(o->el, o->src_index, 0, CE_NEW_SKIP_WORKTREE);
1062
1063         if (!dfc)
1064                 dfc = xcalloc(1, cache_entry_size(0));
1065         o->df_conflict_entry = dfc;
1066
1067         if (len) {
1068                 const char *prefix = o->prefix ? o->prefix : "";
1069                 struct traverse_info info;
1070
1071                 setup_traverse_info(&info, prefix);
1072                 info.fn = unpack_callback;
1073                 info.data = o;
1074                 info.show_all_errors = o->show_all_errors;
1075                 info.pathspec = o->pathspec;
1076
1077                 if (o->prefix) {
1078                         /*
1079                          * Unpack existing index entries that sort before the
1080                          * prefix the tree is spliced into.  Note that o->merge
1081                          * is always true in this case.
1082                          */
1083                         while (1) {
1084                                 struct cache_entry *ce = next_cache_entry(o);
1085                                 if (!ce)
1086                                         break;
1087                                 if (ce_in_traverse_path(ce, &info))
1088                                         break;
1089                                 if (unpack_index_entry(ce, o) < 0)
1090                                         goto return_failed;
1091                         }
1092                 }
1093
1094                 if (traverse_trees(len, t, &info) < 0)
1095                         goto return_failed;
1096         }
1097
1098         /* Any left-over entries in the index? */
1099         if (o->merge) {
1100                 while (1) {
1101                         struct cache_entry *ce = next_cache_entry(o);
1102                         if (!ce)
1103                                 break;
1104                         if (unpack_index_entry(ce, o) < 0)
1105                                 goto return_failed;
1106                 }
1107         }
1108         mark_all_ce_unused(o->src_index);
1109
1110         if (o->trivial_merges_only && o->nontrivial_merge) {
1111                 ret = unpack_failed(o, "Merge requires file-level merging");
1112                 goto done;
1113         }
1114
1115         if (!o->skip_sparse_checkout) {
1116                 int empty_worktree = 1;
1117
1118                 /*
1119                  * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1120                  * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1121                  * so apply_sparse_checkout() won't attempt to remove it from worktree
1122                  */
1123                 mark_new_skip_worktree(o->el, &o->result, CE_ADDED, CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1124
1125                 ret = 0;
1126                 for (i = 0; i < o->result.cache_nr; i++) {
1127                         struct cache_entry *ce = o->result.cache[i];
1128
1129                         /*
1130                          * Entries marked with CE_ADDED in merged_entry() do not have
1131                          * verify_absent() check (the check is effectively disabled
1132                          * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1133                          *
1134                          * Do the real check now because we have had
1135                          * correct CE_NEW_SKIP_WORKTREE
1136                          */
1137                         if (ce->ce_flags & CE_ADDED &&
1138                             verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1139                                 if (!o->show_all_errors)
1140                                         goto return_failed;
1141                                 ret = -1;
1142                         }
1143
1144                         if (apply_sparse_checkout(ce, o)) {
1145                                 if (!o->show_all_errors)
1146                                         goto return_failed;
1147                                 ret = -1;
1148                         }
1149                         if (!ce_skip_worktree(ce))
1150                                 empty_worktree = 0;
1151
1152                 }
1153                 if (ret < 0)
1154                         goto return_failed;
1155                 /*
1156                  * Sparse checkout is meant to narrow down checkout area
1157                  * but it does not make sense to narrow down to empty working
1158                  * tree. This is usually a mistake in sparse checkout rules.
1159                  * Do not allow users to do that.
1160                  */
1161                 if (o->result.cache_nr && empty_worktree) {
1162                         ret = unpack_failed(o, "Sparse checkout leaves no entry on working directory");
1163                         goto done;
1164                 }
1165         }
1166
1167         o->src_index = NULL;
1168         ret = check_updates(o) ? (-2) : 0;
1169         if (o->dst_index)
1170                 *o->dst_index = o->result;
1171
1172 done:
1173         clear_exclude_list(&el);
1174         return ret;
1175
1176 return_failed:
1177         if (o->show_all_errors)
1178                 display_error_msgs(o);
1179         mark_all_ce_unused(o->src_index);
1180         ret = unpack_failed(o, NULL);
1181         if (o->exiting_early)
1182                 ret = 0;
1183         goto done;
1184 }
1185
1186 /* Here come the merge functions */
1187
1188 static int reject_merge(const struct cache_entry *ce,
1189                         struct unpack_trees_options *o)
1190 {
1191         return add_rejected_path(o, ERROR_WOULD_OVERWRITE, ce->name);
1192 }
1193
1194 static int same(const struct cache_entry *a, const struct cache_entry *b)
1195 {
1196         if (!!a != !!b)
1197                 return 0;
1198         if (!a && !b)
1199                 return 1;
1200         if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
1201                 return 0;
1202         return a->ce_mode == b->ce_mode &&
1203                !hashcmp(a->sha1, b->sha1);
1204 }
1205
1206
1207 /*
1208  * When a CE gets turned into an unmerged entry, we
1209  * want it to be up-to-date
1210  */
1211 static int verify_uptodate_1(const struct cache_entry *ce,
1212                              struct unpack_trees_options *o,
1213                              enum unpack_trees_error_types error_type)
1214 {
1215         struct stat st;
1216
1217         if (o->index_only)
1218                 return 0;
1219
1220         /*
1221          * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1222          * if this entry is truly up-to-date because this file may be
1223          * overwritten.
1224          */
1225         if ((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce))
1226                 ; /* keep checking */
1227         else if (o->reset || ce_uptodate(ce))
1228                 return 0;
1229
1230         if (!lstat(ce->name, &st)) {
1231                 int flags = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE;
1232                 unsigned changed = ie_match_stat(o->src_index, ce, &st, flags);
1233                 if (!changed)
1234                         return 0;
1235                 /*
1236                  * NEEDSWORK: the current default policy is to allow
1237                  * submodule to be out of sync wrt the superproject
1238                  * index.  This needs to be tightened later for
1239                  * submodules that are marked to be automatically
1240                  * checked out.
1241                  */
1242                 if (S_ISGITLINK(ce->ce_mode))
1243                         return 0;
1244                 errno = 0;
1245         }
1246         if (errno == ENOENT)
1247                 return 0;
1248         return o->gently ? -1 :
1249                 add_rejected_path(o, error_type, ce->name);
1250 }
1251
1252 static int verify_uptodate(const struct cache_entry *ce,
1253                            struct unpack_trees_options *o)
1254 {
1255         if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1256                 return 0;
1257         return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
1258 }
1259
1260 static int verify_uptodate_sparse(const struct cache_entry *ce,
1261                                   struct unpack_trees_options *o)
1262 {
1263         return verify_uptodate_1(ce, o, ERROR_SPARSE_NOT_UPTODATE_FILE);
1264 }
1265
1266 static void invalidate_ce_path(const struct cache_entry *ce,
1267                                struct unpack_trees_options *o)
1268 {
1269         if (ce)
1270                 cache_tree_invalidate_path(o->src_index->cache_tree, ce->name);
1271 }
1272
1273 /*
1274  * Check that checking out ce->sha1 in subdir ce->name is not
1275  * going to overwrite any working files.
1276  *
1277  * Currently, git does not checkout subprojects during a superproject
1278  * checkout, so it is not going to overwrite anything.
1279  */
1280 static int verify_clean_submodule(const struct cache_entry *ce,
1281                                   enum unpack_trees_error_types error_type,
1282                                   struct unpack_trees_options *o)
1283 {
1284         return 0;
1285 }
1286
1287 static int verify_clean_subdirectory(const struct cache_entry *ce,
1288                                      enum unpack_trees_error_types error_type,
1289                                      struct unpack_trees_options *o)
1290 {
1291         /*
1292          * we are about to extract "ce->name"; we would not want to lose
1293          * anything in the existing directory there.
1294          */
1295         int namelen;
1296         int i;
1297         struct dir_struct d;
1298         char *pathbuf;
1299         int cnt = 0;
1300         unsigned char sha1[20];
1301
1302         if (S_ISGITLINK(ce->ce_mode) &&
1303             resolve_gitlink_ref(ce->name, "HEAD", sha1) == 0) {
1304                 /* If we are not going to update the submodule, then
1305                  * we don't care.
1306                  */
1307                 if (!hashcmp(sha1, ce->sha1))
1308                         return 0;
1309                 return verify_clean_submodule(ce, error_type, o);
1310         }
1311
1312         /*
1313          * First let's make sure we do not have a local modification
1314          * in that directory.
1315          */
1316         namelen = ce_namelen(ce);
1317         for (i = locate_in_src_index(ce, o);
1318              i < o->src_index->cache_nr;
1319              i++) {
1320                 struct cache_entry *ce2 = o->src_index->cache[i];
1321                 int len = ce_namelen(ce2);
1322                 if (len < namelen ||
1323                     strncmp(ce->name, ce2->name, namelen) ||
1324                     ce2->name[namelen] != '/')
1325                         break;
1326                 /*
1327                  * ce2->name is an entry in the subdirectory to be
1328                  * removed.
1329                  */
1330                 if (!ce_stage(ce2)) {
1331                         if (verify_uptodate(ce2, o))
1332                                 return -1;
1333                         add_entry(o, ce2, CE_REMOVE, 0);
1334                         mark_ce_used(ce2, o);
1335                 }
1336                 cnt++;
1337         }
1338
1339         /*
1340          * Then we need to make sure that we do not lose a locally
1341          * present file that is not ignored.
1342          */
1343         pathbuf = xmalloc(namelen + 2);
1344         memcpy(pathbuf, ce->name, namelen);
1345         strcpy(pathbuf+namelen, "/");
1346
1347         memset(&d, 0, sizeof(d));
1348         if (o->dir)
1349                 d.exclude_per_dir = o->dir->exclude_per_dir;
1350         i = read_directory(&d, pathbuf, namelen+1, NULL);
1351         if (i)
1352                 return o->gently ? -1 :
1353                         add_rejected_path(o, ERROR_NOT_UPTODATE_DIR, ce->name);
1354         free(pathbuf);
1355         return cnt;
1356 }
1357
1358 /*
1359  * This gets called when there was no index entry for the tree entry 'dst',
1360  * but we found a file in the working tree that 'lstat()' said was fine,
1361  * and we're on a case-insensitive filesystem.
1362  *
1363  * See if we can find a case-insensitive match in the index that also
1364  * matches the stat information, and assume it's that other file!
1365  */
1366 static int icase_exists(struct unpack_trees_options *o, const char *name, int len, struct stat *st)
1367 {
1368         struct cache_entry *src;
1369
1370         src = index_name_exists(o->src_index, name, len, 1);
1371         return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
1372 }
1373
1374 static int check_ok_to_remove(const char *name, int len, int dtype,
1375                               const struct cache_entry *ce, struct stat *st,
1376                               enum unpack_trees_error_types error_type,
1377                               struct unpack_trees_options *o)
1378 {
1379         struct cache_entry *result;
1380
1381         /*
1382          * It may be that the 'lstat()' succeeded even though
1383          * target 'ce' was absent, because there is an old
1384          * entry that is different only in case..
1385          *
1386          * Ignore that lstat() if it matches.
1387          */
1388         if (ignore_case && icase_exists(o, name, len, st))
1389                 return 0;
1390
1391         if (o->dir &&
1392             is_excluded(o->dir, name, &dtype))
1393                 /*
1394                  * ce->name is explicitly excluded, so it is Ok to
1395                  * overwrite it.
1396                  */
1397                 return 0;
1398         if (S_ISDIR(st->st_mode)) {
1399                 /*
1400                  * We are checking out path "foo" and
1401                  * found "foo/." in the working tree.
1402                  * This is tricky -- if we have modified
1403                  * files that are in "foo/" we would lose
1404                  * them.
1405                  */
1406                 if (verify_clean_subdirectory(ce, error_type, o) < 0)
1407                         return -1;
1408                 return 0;
1409         }
1410
1411         /*
1412          * The previous round may already have decided to
1413          * delete this path, which is in a subdirectory that
1414          * is being replaced with a blob.
1415          */
1416         result = index_name_exists(&o->result, name, len, 0);
1417         if (result) {
1418                 if (result->ce_flags & CE_REMOVE)
1419                         return 0;
1420         }
1421
1422         return o->gently ? -1 :
1423                 add_rejected_path(o, error_type, name);
1424 }
1425
1426 /*
1427  * We do not want to remove or overwrite a working tree file that
1428  * is not tracked, unless it is ignored.
1429  */
1430 static int verify_absent_1(const struct cache_entry *ce,
1431                            enum unpack_trees_error_types error_type,
1432                            struct unpack_trees_options *o)
1433 {
1434         int len;
1435         struct stat st;
1436
1437         if (o->index_only || o->reset || !o->update)
1438                 return 0;
1439
1440         len = check_leading_path(ce->name, ce_namelen(ce));
1441         if (!len)
1442                 return 0;
1443         else if (len > 0) {
1444                 char path[PATH_MAX + 1];
1445                 memcpy(path, ce->name, len);
1446                 path[len] = 0;
1447                 if (lstat(path, &st))
1448                         return error("cannot stat '%s': %s", path,
1449                                         strerror(errno));
1450
1451                 return check_ok_to_remove(path, len, DT_UNKNOWN, NULL, &st,
1452                                 error_type, o);
1453         } else if (lstat(ce->name, &st)) {
1454                 if (errno != ENOENT)
1455                         return error("cannot stat '%s': %s", ce->name,
1456                                      strerror(errno));
1457                 return 0;
1458         } else {
1459                 return check_ok_to_remove(ce->name, ce_namelen(ce),
1460                                           ce_to_dtype(ce), ce, &st,
1461                                           error_type, o);
1462         }
1463 }
1464
1465 static int verify_absent(const struct cache_entry *ce,
1466                          enum unpack_trees_error_types error_type,
1467                          struct unpack_trees_options *o)
1468 {
1469         if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1470                 return 0;
1471         return verify_absent_1(ce, error_type, o);
1472 }
1473
1474 static int verify_absent_sparse(const struct cache_entry *ce,
1475                                 enum unpack_trees_error_types error_type,
1476                                 struct unpack_trees_options *o)
1477 {
1478         enum unpack_trees_error_types orphaned_error = error_type;
1479         if (orphaned_error == ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN)
1480                 orphaned_error = ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN;
1481
1482         return verify_absent_1(ce, orphaned_error, o);
1483 }
1484
1485 static int merged_entry(const struct cache_entry *ce,
1486                         const struct cache_entry *old,
1487                         struct unpack_trees_options *o)
1488 {
1489         int update = CE_UPDATE;
1490         struct cache_entry *merge = dup_entry(ce);
1491
1492         if (!old) {
1493                 /*
1494                  * New index entries. In sparse checkout, the following
1495                  * verify_absent() will be delayed until after
1496                  * traverse_trees() finishes in unpack_trees(), then:
1497                  *
1498                  *  - CE_NEW_SKIP_WORKTREE will be computed correctly
1499                  *  - verify_absent() be called again, this time with
1500                  *    correct CE_NEW_SKIP_WORKTREE
1501                  *
1502                  * verify_absent() call here does nothing in sparse
1503                  * checkout (i.e. o->skip_sparse_checkout == 0)
1504                  */
1505                 update |= CE_ADDED;
1506                 merge->ce_flags |= CE_NEW_SKIP_WORKTREE;
1507
1508                 if (verify_absent(merge,
1509                                   ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1510                         free(merge);
1511                         return -1;
1512                 }
1513                 invalidate_ce_path(merge, o);
1514         } else if (!(old->ce_flags & CE_CONFLICTED)) {
1515                 /*
1516                  * See if we can re-use the old CE directly?
1517                  * That way we get the uptodate stat info.
1518                  *
1519                  * This also removes the UPDATE flag on a match; otherwise
1520                  * we will end up overwriting local changes in the work tree.
1521                  */
1522                 if (same(old, merge)) {
1523                         copy_cache_entry(merge, old);
1524                         update = 0;
1525                 } else {
1526                         if (verify_uptodate(old, o)) {
1527                                 free(merge);
1528                                 return -1;
1529                         }
1530                         /* Migrate old flags over */
1531                         update |= old->ce_flags & (CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1532                         invalidate_ce_path(old, o);
1533                 }
1534         } else {
1535                 /*
1536                  * Previously unmerged entry left as an existence
1537                  * marker by read_index_unmerged();
1538                  */
1539                 invalidate_ce_path(old, o);
1540         }
1541
1542         do_add_entry(o, merge, update, CE_STAGEMASK);
1543         return 1;
1544 }
1545
1546 static int deleted_entry(const struct cache_entry *ce,
1547                          const struct cache_entry *old,
1548                          struct unpack_trees_options *o)
1549 {
1550         /* Did it exist in the index? */
1551         if (!old) {
1552                 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1553                         return -1;
1554                 return 0;
1555         }
1556         if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
1557                 return -1;
1558         add_entry(o, ce, CE_REMOVE, 0);
1559         invalidate_ce_path(ce, o);
1560         return 1;
1561 }
1562
1563 static int keep_entry(const struct cache_entry *ce,
1564                       struct unpack_trees_options *o)
1565 {
1566         add_entry(o, ce, 0, 0);
1567         return 1;
1568 }
1569
1570 #if DBRT_DEBUG
1571 static void show_stage_entry(FILE *o,
1572                              const char *label, const struct cache_entry *ce)
1573 {
1574         if (!ce)
1575                 fprintf(o, "%s (missing)\n", label);
1576         else
1577                 fprintf(o, "%s%06o %s %d\t%s\n",
1578                         label,
1579                         ce->ce_mode,
1580                         sha1_to_hex(ce->sha1),
1581                         ce_stage(ce),
1582                         ce->name);
1583 }
1584 #endif
1585
1586 int threeway_merge(const struct cache_entry * const *stages,
1587                    struct unpack_trees_options *o)
1588 {
1589         const struct cache_entry *index;
1590         const struct cache_entry *head;
1591         const struct cache_entry *remote = stages[o->head_idx + 1];
1592         int count;
1593         int head_match = 0;
1594         int remote_match = 0;
1595
1596         int df_conflict_head = 0;
1597         int df_conflict_remote = 0;
1598
1599         int any_anc_missing = 0;
1600         int no_anc_exists = 1;
1601         int i;
1602
1603         for (i = 1; i < o->head_idx; i++) {
1604                 if (!stages[i] || stages[i] == o->df_conflict_entry)
1605                         any_anc_missing = 1;
1606                 else
1607                         no_anc_exists = 0;
1608         }
1609
1610         index = stages[0];
1611         head = stages[o->head_idx];
1612
1613         if (head == o->df_conflict_entry) {
1614                 df_conflict_head = 1;
1615                 head = NULL;
1616         }
1617
1618         if (remote == o->df_conflict_entry) {
1619                 df_conflict_remote = 1;
1620                 remote = NULL;
1621         }
1622
1623         /*
1624          * First, if there's a #16 situation, note that to prevent #13
1625          * and #14.
1626          */
1627         if (!same(remote, head)) {
1628                 for (i = 1; i < o->head_idx; i++) {
1629                         if (same(stages[i], head)) {
1630                                 head_match = i;
1631                         }
1632                         if (same(stages[i], remote)) {
1633                                 remote_match = i;
1634                         }
1635                 }
1636         }
1637
1638         /*
1639          * We start with cases where the index is allowed to match
1640          * something other than the head: #14(ALT) and #2ALT, where it
1641          * is permitted to match the result instead.
1642          */
1643         /* #14, #14ALT, #2ALT */
1644         if (remote && !df_conflict_head && head_match && !remote_match) {
1645                 if (index && !same(index, remote) && !same(index, head))
1646                         return o->gently ? -1 : reject_merge(index, o);
1647                 return merged_entry(remote, index, o);
1648         }
1649         /*
1650          * If we have an entry in the index cache, then we want to
1651          * make sure that it matches head.
1652          */
1653         if (index && !same(index, head))
1654                 return o->gently ? -1 : reject_merge(index, o);
1655
1656         if (head) {
1657                 /* #5ALT, #15 */
1658                 if (same(head, remote))
1659                         return merged_entry(head, index, o);
1660                 /* #13, #3ALT */
1661                 if (!df_conflict_remote && remote_match && !head_match)
1662                         return merged_entry(head, index, o);
1663         }
1664
1665         /* #1 */
1666         if (!head && !remote && any_anc_missing)
1667                 return 0;
1668
1669         /*
1670          * Under the "aggressive" rule, we resolve mostly trivial
1671          * cases that we historically had git-merge-one-file resolve.
1672          */
1673         if (o->aggressive) {
1674                 int head_deleted = !head;
1675                 int remote_deleted = !remote;
1676                 const struct cache_entry *ce = NULL;
1677
1678                 if (index)
1679                         ce = index;
1680                 else if (head)
1681                         ce = head;
1682                 else if (remote)
1683                         ce = remote;
1684                 else {
1685                         for (i = 1; i < o->head_idx; i++) {
1686                                 if (stages[i] && stages[i] != o->df_conflict_entry) {
1687                                         ce = stages[i];
1688                                         break;
1689                                 }
1690                         }
1691                 }
1692
1693                 /*
1694                  * Deleted in both.
1695                  * Deleted in one and unchanged in the other.
1696                  */
1697                 if ((head_deleted && remote_deleted) ||
1698                     (head_deleted && remote && remote_match) ||
1699                     (remote_deleted && head && head_match)) {
1700                         if (index)
1701                                 return deleted_entry(index, index, o);
1702                         if (ce && !head_deleted) {
1703                                 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
1704                                         return -1;
1705                         }
1706                         return 0;
1707                 }
1708                 /*
1709                  * Added in both, identically.
1710                  */
1711                 if (no_anc_exists && head && remote && same(head, remote))
1712                         return merged_entry(head, index, o);
1713
1714         }
1715
1716         /* Below are "no merge" cases, which require that the index be
1717          * up-to-date to avoid the files getting overwritten with
1718          * conflict resolution files.
1719          */
1720         if (index) {
1721                 if (verify_uptodate(index, o))
1722                         return -1;
1723         }
1724
1725         o->nontrivial_merge = 1;
1726
1727         /* #2, #3, #4, #6, #7, #9, #10, #11. */
1728         count = 0;
1729         if (!head_match || !remote_match) {
1730                 for (i = 1; i < o->head_idx; i++) {
1731                         if (stages[i] && stages[i] != o->df_conflict_entry) {
1732                                 keep_entry(stages[i], o);
1733                                 count++;
1734                                 break;
1735                         }
1736                 }
1737         }
1738 #if DBRT_DEBUG
1739         else {
1740                 fprintf(stderr, "read-tree: warning #16 detected\n");
1741                 show_stage_entry(stderr, "head   ", stages[head_match]);
1742                 show_stage_entry(stderr, "remote ", stages[remote_match]);
1743         }
1744 #endif
1745         if (head) { count += keep_entry(head, o); }
1746         if (remote) { count += keep_entry(remote, o); }
1747         return count;
1748 }
1749
1750 /*
1751  * Two-way merge.
1752  *
1753  * The rule is to "carry forward" what is in the index without losing
1754  * information across a "fast-forward", favoring a successful merge
1755  * over a merge failure when it makes sense.  For details of the
1756  * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
1757  *
1758  */
1759 int twoway_merge(const struct cache_entry * const *src,
1760                  struct unpack_trees_options *o)
1761 {
1762         const struct cache_entry *current = src[0];
1763         const struct cache_entry *oldtree = src[1];
1764         const struct cache_entry *newtree = src[2];
1765
1766         if (o->merge_size != 2)
1767                 return error("Cannot do a twoway merge of %d trees",
1768                              o->merge_size);
1769
1770         if (oldtree == o->df_conflict_entry)
1771                 oldtree = NULL;
1772         if (newtree == o->df_conflict_entry)
1773                 newtree = NULL;
1774
1775         if (current) {
1776                 if ((!oldtree && !newtree) || /* 4 and 5 */
1777                     (!oldtree && newtree &&
1778                      same(current, newtree)) || /* 6 and 7 */
1779                     (oldtree && newtree &&
1780                      same(oldtree, newtree)) || /* 14 and 15 */
1781                     (oldtree && newtree &&
1782                      !same(oldtree, newtree) && /* 18 and 19 */
1783                      same(current, newtree))) {
1784                         return keep_entry(current, o);
1785                 }
1786                 else if (oldtree && !newtree && same(current, oldtree)) {
1787                         /* 10 or 11 */
1788                         return deleted_entry(oldtree, current, o);
1789                 }
1790                 else if (oldtree && newtree &&
1791                          same(current, oldtree) && !same(current, newtree)) {
1792                         /* 20 or 21 */
1793                         return merged_entry(newtree, current, o);
1794                 }
1795                 else {
1796                         /* all other failures */
1797                         if (oldtree)
1798                                 return o->gently ? -1 : reject_merge(oldtree, o);
1799                         if (current)
1800                                 return o->gently ? -1 : reject_merge(current, o);
1801                         if (newtree)
1802                                 return o->gently ? -1 : reject_merge(newtree, o);
1803                         return -1;
1804                 }
1805         }
1806         else if (newtree) {
1807                 if (oldtree && !o->initial_checkout) {
1808                         /*
1809                          * deletion of the path was staged;
1810                          */
1811                         if (same(oldtree, newtree))
1812                                 return 1;
1813                         return reject_merge(oldtree, o);
1814                 }
1815                 return merged_entry(newtree, current, o);
1816         }
1817         return deleted_entry(oldtree, current, o);
1818 }
1819
1820 /*
1821  * Bind merge.
1822  *
1823  * Keep the index entries at stage0, collapse stage1 but make sure
1824  * stage0 does not have anything there.
1825  */
1826 int bind_merge(const struct cache_entry * const *src,
1827                struct unpack_trees_options *o)
1828 {
1829         const struct cache_entry *old = src[0];
1830         const struct cache_entry *a = src[1];
1831
1832         if (o->merge_size != 1)
1833                 return error("Cannot do a bind merge of %d trees",
1834                              o->merge_size);
1835         if (a && old)
1836                 return o->gently ? -1 :
1837                         error(ERRORMSG(o, ERROR_BIND_OVERLAP), a->name, old->name);
1838         if (!a)
1839                 return keep_entry(old, o);
1840         else
1841                 return merged_entry(a, NULL, o);
1842 }
1843
1844 /*
1845  * One-way merge.
1846  *
1847  * The rule is:
1848  * - take the stat information from stage0, take the data from stage1
1849  */
1850 int oneway_merge(const struct cache_entry * const *src,
1851                  struct unpack_trees_options *o)
1852 {
1853         const struct cache_entry *old = src[0];
1854         const struct cache_entry *a = src[1];
1855
1856         if (o->merge_size != 1)
1857                 return error("Cannot do a oneway merge of %d trees",
1858                              o->merge_size);
1859
1860         if (!a || a == o->df_conflict_entry)
1861                 return deleted_entry(old, old, o);
1862
1863         if (old && same(old, a)) {
1864                 int update = 0;
1865                 if (o->reset && o->update && !ce_uptodate(old) && !ce_skip_worktree(old)) {
1866                         struct stat st;
1867                         if (lstat(old->name, &st) ||
1868                             ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
1869                                 update |= CE_UPDATE;
1870                 }
1871                 add_entry(o, old, update, 0);
1872                 return 0;
1873         }
1874         return merged_entry(a, old, o);
1875 }