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