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