Document update for nd/unpack-trees-with-cache-tree
[git] / unpack-trees.c
1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
2 #include "cache.h"
3 #include "argv-array.h"
4 #include "repository.h"
5 #include "config.h"
6 #include "dir.h"
7 #include "tree.h"
8 #include "tree-walk.h"
9 #include "cache-tree.h"
10 #include "unpack-trees.h"
11 #include "progress.h"
12 #include "refs.h"
13 #include "attr.h"
14 #include "split-index.h"
15 #include "dir.h"
16 #include "submodule.h"
17 #include "submodule-config.h"
18 #include "fsmonitor.h"
19 #include "object-store.h"
20 #include "fetch-object.h"
21
22 /*
23  * Error messages expected by scripts out of plumbing commands such as
24  * read-tree.  Non-scripted Porcelain is not required to use these messages
25  * and in fact are encouraged to reword them to better suit their particular
26  * situation better.  See how "git checkout" and "git merge" replaces
27  * them using setup_unpack_trees_porcelain(), for example.
28  */
29 static const char *unpack_plumbing_errors[NB_UNPACK_TREES_ERROR_TYPES] = {
30         /* ERROR_WOULD_OVERWRITE */
31         "Entry '%s' would be overwritten by merge. Cannot merge.",
32
33         /* ERROR_NOT_UPTODATE_FILE */
34         "Entry '%s' not uptodate. Cannot merge.",
35
36         /* ERROR_NOT_UPTODATE_DIR */
37         "Updating '%s' would lose untracked files in it",
38
39         /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
40         "Untracked working tree file '%s' would be overwritten by merge.",
41
42         /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
43         "Untracked working tree file '%s' would be removed by merge.",
44
45         /* ERROR_BIND_OVERLAP */
46         "Entry '%s' overlaps with '%s'.  Cannot bind.",
47
48         /* ERROR_SPARSE_NOT_UPTODATE_FILE */
49         "Entry '%s' not uptodate. Cannot update sparse checkout.",
50
51         /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
52         "Working tree file '%s' would be overwritten by sparse checkout update.",
53
54         /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
55         "Working tree file '%s' would be removed by sparse checkout update.",
56
57         /* ERROR_WOULD_LOSE_SUBMODULE */
58         "Submodule '%s' cannot checkout new HEAD.",
59 };
60
61 #define ERRORMSG(o,type) \
62         ( ((o) && (o)->msgs[(type)]) \
63           ? ((o)->msgs[(type)])      \
64           : (unpack_plumbing_errors[(type)]) )
65
66 static const char *super_prefixed(const char *path)
67 {
68         /*
69          * It is necessary and sufficient to have two static buffers
70          * here, as the return value of this function is fed to
71          * error() using the unpack_*_errors[] templates we see above.
72          */
73         static struct strbuf buf[2] = {STRBUF_INIT, STRBUF_INIT};
74         static int super_prefix_len = -1;
75         static unsigned idx = ARRAY_SIZE(buf) - 1;
76
77         if (super_prefix_len < 0) {
78                 const char *super_prefix = get_super_prefix();
79                 if (!super_prefix) {
80                         super_prefix_len = 0;
81                 } else {
82                         int i;
83                         for (i = 0; i < ARRAY_SIZE(buf); i++)
84                                 strbuf_addstr(&buf[i], super_prefix);
85                         super_prefix_len = buf[0].len;
86                 }
87         }
88
89         if (!super_prefix_len)
90                 return path;
91
92         if (++idx >= ARRAY_SIZE(buf))
93                 idx = 0;
94
95         strbuf_setlen(&buf[idx], super_prefix_len);
96         strbuf_addstr(&buf[idx], path);
97
98         return buf[idx].buf;
99 }
100
101 void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
102                                   const char *cmd)
103 {
104         int i;
105         const char **msgs = opts->msgs;
106         const char *msg;
107
108         argv_array_init(&opts->msgs_to_free);
109
110         if (!strcmp(cmd, "checkout"))
111                 msg = advice_commit_before_merge
112                       ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
113                           "Please commit your changes or stash them before you switch branches.")
114                       : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
115         else if (!strcmp(cmd, "merge"))
116                 msg = advice_commit_before_merge
117                       ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
118                           "Please commit your changes or stash them before you merge.")
119                       : _("Your local changes to the following files would be overwritten by merge:\n%%s");
120         else
121                 msg = advice_commit_before_merge
122                       ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
123                           "Please commit your changes or stash them before you %s.")
124                       : _("Your local changes to the following files would be overwritten by %s:\n%%s");
125         msgs[ERROR_WOULD_OVERWRITE] = msgs[ERROR_NOT_UPTODATE_FILE] =
126                 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
127
128         msgs[ERROR_NOT_UPTODATE_DIR] =
129                 _("Updating the following directories would lose untracked files in them:\n%s");
130
131         if (!strcmp(cmd, "checkout"))
132                 msg = advice_commit_before_merge
133                       ? _("The following untracked working tree files would be removed by checkout:\n%%s"
134                           "Please move or remove them before you switch branches.")
135                       : _("The following untracked working tree files would be removed by checkout:\n%%s");
136         else if (!strcmp(cmd, "merge"))
137                 msg = advice_commit_before_merge
138                       ? _("The following untracked working tree files would be removed by merge:\n%%s"
139                           "Please move or remove them before you merge.")
140                       : _("The following untracked working tree files would be removed by merge:\n%%s");
141         else
142                 msg = advice_commit_before_merge
143                       ? _("The following untracked working tree files would be removed by %s:\n%%s"
144                           "Please move or remove them before you %s.")
145                       : _("The following untracked working tree files would be removed by %s:\n%%s");
146         msgs[ERROR_WOULD_LOSE_UNTRACKED_REMOVED] =
147                 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
148
149         if (!strcmp(cmd, "checkout"))
150                 msg = advice_commit_before_merge
151                       ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
152                           "Please move or remove them before you switch branches.")
153                       : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
154         else if (!strcmp(cmd, "merge"))
155                 msg = advice_commit_before_merge
156                       ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
157                           "Please move or remove them before you merge.")
158                       : _("The following untracked working tree files would be overwritten by merge:\n%%s");
159         else
160                 msg = advice_commit_before_merge
161                       ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
162                           "Please move or remove them before you %s.")
163                       : _("The following untracked working tree files would be overwritten by %s:\n%%s");
164         msgs[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN] =
165                 argv_array_pushf(&opts->msgs_to_free, msg, cmd, cmd);
166
167         /*
168          * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
169          * cannot easily display it as a list.
170          */
171         msgs[ERROR_BIND_OVERLAP] = _("Entry '%s' overlaps with '%s'.  Cannot bind.");
172
173         msgs[ERROR_SPARSE_NOT_UPTODATE_FILE] =
174                 _("Cannot update sparse checkout: the following entries are not up to date:\n%s");
175         msgs[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN] =
176                 _("The following working tree files would be overwritten by sparse checkout update:\n%s");
177         msgs[ERROR_WOULD_LOSE_ORPHANED_REMOVED] =
178                 _("The following working tree files would be removed by sparse checkout update:\n%s");
179         msgs[ERROR_WOULD_LOSE_SUBMODULE] =
180                 _("Cannot update submodule:\n%s");
181
182         opts->show_all_errors = 1;
183         /* rejected paths may not have a static buffer */
184         for (i = 0; i < ARRAY_SIZE(opts->unpack_rejects); i++)
185                 opts->unpack_rejects[i].strdup_strings = 1;
186 }
187
188 void clear_unpack_trees_porcelain(struct unpack_trees_options *opts)
189 {
190         argv_array_clear(&opts->msgs_to_free);
191         memset(opts->msgs, 0, sizeof(opts->msgs));
192 }
193
194 static int do_add_entry(struct unpack_trees_options *o, struct cache_entry *ce,
195                          unsigned int set, unsigned int clear)
196 {
197         clear |= CE_HASHED;
198
199         if (set & CE_REMOVE)
200                 set |= CE_WT_REMOVE;
201
202         ce->ce_flags = (ce->ce_flags & ~clear) | set;
203         return add_index_entry(&o->result, ce,
204                                ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
205 }
206
207 static void add_entry(struct unpack_trees_options *o,
208                       const struct cache_entry *ce,
209                       unsigned int set, unsigned int clear)
210 {
211         do_add_entry(o, dup_cache_entry(ce, &o->result), set, clear);
212 }
213
214 /*
215  * add error messages on path <path>
216  * corresponding to the type <e> with the message <msg>
217  * indicating if it should be display in porcelain or not
218  */
219 static int add_rejected_path(struct unpack_trees_options *o,
220                              enum unpack_trees_error_types e,
221                              const char *path)
222 {
223         if (!o->show_all_errors)
224                 return error(ERRORMSG(o, e), super_prefixed(path));
225
226         /*
227          * Otherwise, insert in a list for future display by
228          * display_error_msgs()
229          */
230         string_list_append(&o->unpack_rejects[e], path);
231         return -1;
232 }
233
234 /*
235  * display all the error messages stored in a nice way
236  */
237 static void display_error_msgs(struct unpack_trees_options *o)
238 {
239         int e, i;
240         int something_displayed = 0;
241         for (e = 0; e < NB_UNPACK_TREES_ERROR_TYPES; e++) {
242                 struct string_list *rejects = &o->unpack_rejects[e];
243                 if (rejects->nr > 0) {
244                         struct strbuf path = STRBUF_INIT;
245                         something_displayed = 1;
246                         for (i = 0; i < rejects->nr; i++)
247                                 strbuf_addf(&path, "\t%s\n", rejects->items[i].string);
248                         error(ERRORMSG(o, e), super_prefixed(path.buf));
249                         strbuf_release(&path);
250                 }
251                 string_list_clear(rejects, 0);
252         }
253         if (something_displayed)
254                 fprintf(stderr, _("Aborting\n"));
255 }
256
257 static int check_submodule_move_head(const struct cache_entry *ce,
258                                      const char *old_id,
259                                      const char *new_id,
260                                      struct unpack_trees_options *o)
261 {
262         unsigned flags = SUBMODULE_MOVE_HEAD_DRY_RUN;
263         const struct submodule *sub = submodule_from_ce(ce);
264
265         if (!sub)
266                 return 0;
267
268         if (o->reset)
269                 flags |= SUBMODULE_MOVE_HEAD_FORCE;
270
271         if (submodule_move_head(ce->name, old_id, new_id, flags))
272                 return o->gently ? -1 :
273                                    add_rejected_path(o, ERROR_WOULD_LOSE_SUBMODULE, ce->name);
274         return 0;
275 }
276
277 /*
278  * Preform the loading of the repository's gitmodules file.  This function is
279  * used by 'check_update()' to perform loading of the gitmodules file in two
280  * differnt situations:
281  * (1) before removing entries from the working tree if the gitmodules file has
282  *     been marked for removal.  This situation is specified by 'state' == NULL.
283  * (2) before checking out entries to the working tree if the gitmodules file
284  *     has been marked for update.  This situation is specified by 'state' != NULL.
285  */
286 static void load_gitmodules_file(struct index_state *index,
287                                  struct checkout *state)
288 {
289         int pos = index_name_pos(index, GITMODULES_FILE, strlen(GITMODULES_FILE));
290
291         if (pos >= 0) {
292                 struct cache_entry *ce = index->cache[pos];
293                 if (!state && ce->ce_flags & CE_WT_REMOVE) {
294                         repo_read_gitmodules(the_repository);
295                 } else if (state && (ce->ce_flags & CE_UPDATE)) {
296                         submodule_free(the_repository);
297                         checkout_entry(ce, state, NULL);
298                         repo_read_gitmodules(the_repository);
299                 }
300         }
301 }
302
303 /*
304  * Unlink the last component and schedule the leading directories for
305  * removal, such that empty directories get removed.
306  */
307 static void unlink_entry(const struct cache_entry *ce)
308 {
309         const struct submodule *sub = submodule_from_ce(ce);
310         if (sub) {
311                 /* state.force is set at the caller. */
312                 submodule_move_head(ce->name, "HEAD", NULL,
313                                     SUBMODULE_MOVE_HEAD_FORCE);
314         }
315         if (!check_leading_path(ce->name, ce_namelen(ce)))
316                 return;
317         if (remove_or_warn(ce->ce_mode, ce->name))
318                 return;
319         schedule_dir_for_removal(ce->name, ce_namelen(ce));
320 }
321
322 static struct progress *get_progress(struct unpack_trees_options *o)
323 {
324         unsigned cnt = 0, total = 0;
325         struct index_state *index = &o->result;
326
327         if (!o->update || !o->verbose_update)
328                 return NULL;
329
330         for (; cnt < index->cache_nr; cnt++) {
331                 const struct cache_entry *ce = index->cache[cnt];
332                 if (ce->ce_flags & (CE_UPDATE | CE_WT_REMOVE))
333                         total++;
334         }
335
336         return start_delayed_progress(_("Checking out files"), total);
337 }
338
339 static int check_updates(struct unpack_trees_options *o)
340 {
341         unsigned cnt = 0;
342         int errs = 0;
343         struct progress *progress = NULL;
344         struct index_state *index = &o->result;
345         struct checkout state = CHECKOUT_INIT;
346         int i;
347
348         trace_performance_enter();
349         state.force = 1;
350         state.quiet = 1;
351         state.refresh_cache = 1;
352         state.istate = index;
353
354         progress = get_progress(o);
355
356         if (o->update)
357                 git_attr_set_direction(GIT_ATTR_CHECKOUT, index);
358
359         if (should_update_submodules() && o->update && !o->dry_run)
360                 load_gitmodules_file(index, NULL);
361
362         for (i = 0; i < index->cache_nr; i++) {
363                 const struct cache_entry *ce = index->cache[i];
364
365                 if (ce->ce_flags & CE_WT_REMOVE) {
366                         display_progress(progress, ++cnt);
367                         if (o->update && !o->dry_run)
368                                 unlink_entry(ce);
369                 }
370         }
371         remove_marked_cache_entries(index);
372         remove_scheduled_dirs();
373
374         if (should_update_submodules() && o->update && !o->dry_run)
375                 load_gitmodules_file(index, &state);
376
377         enable_delayed_checkout(&state);
378         if (repository_format_partial_clone && o->update && !o->dry_run) {
379                 /*
380                  * Prefetch the objects that are to be checked out in the loop
381                  * below.
382                  */
383                 struct oid_array to_fetch = OID_ARRAY_INIT;
384                 int fetch_if_missing_store = fetch_if_missing;
385                 fetch_if_missing = 0;
386                 for (i = 0; i < index->cache_nr; i++) {
387                         struct cache_entry *ce = index->cache[i];
388                         if ((ce->ce_flags & CE_UPDATE) &&
389                             !S_ISGITLINK(ce->ce_mode)) {
390                                 if (!has_object_file(&ce->oid))
391                                         oid_array_append(&to_fetch, &ce->oid);
392                         }
393                 }
394                 if (to_fetch.nr)
395                         fetch_objects(repository_format_partial_clone,
396                                       &to_fetch);
397                 fetch_if_missing = fetch_if_missing_store;
398                 oid_array_clear(&to_fetch);
399         }
400         for (i = 0; i < index->cache_nr; i++) {
401                 struct cache_entry *ce = index->cache[i];
402
403                 if (ce->ce_flags & CE_UPDATE) {
404                         if (ce->ce_flags & CE_WT_REMOVE)
405                                 BUG("both update and delete flags are set on %s",
406                                     ce->name);
407                         display_progress(progress, ++cnt);
408                         ce->ce_flags &= ~CE_UPDATE;
409                         if (o->update && !o->dry_run) {
410                                 errs |= checkout_entry(ce, &state, NULL);
411                         }
412                 }
413         }
414         stop_progress(&progress);
415         errs |= finish_delayed_checkout(&state);
416         if (o->update)
417                 git_attr_set_direction(GIT_ATTR_CHECKIN, NULL);
418         trace_performance_leave("check_updates");
419         return errs != 0;
420 }
421
422 static int verify_uptodate_sparse(const struct cache_entry *ce,
423                                   struct unpack_trees_options *o);
424 static int verify_absent_sparse(const struct cache_entry *ce,
425                                 enum unpack_trees_error_types,
426                                 struct unpack_trees_options *o);
427
428 static int apply_sparse_checkout(struct index_state *istate,
429                                  struct cache_entry *ce,
430                                  struct unpack_trees_options *o)
431 {
432         int was_skip_worktree = ce_skip_worktree(ce);
433
434         if (ce->ce_flags & CE_NEW_SKIP_WORKTREE)
435                 ce->ce_flags |= CE_SKIP_WORKTREE;
436         else
437                 ce->ce_flags &= ~CE_SKIP_WORKTREE;
438         if (was_skip_worktree != ce_skip_worktree(ce)) {
439                 ce->ce_flags |= CE_UPDATE_IN_BASE;
440                 mark_fsmonitor_invalid(istate, ce);
441                 istate->cache_changed |= CE_ENTRY_CHANGED;
442         }
443
444         /*
445          * if (!was_skip_worktree && !ce_skip_worktree()) {
446          *      This is perfectly normal. Move on;
447          * }
448          */
449
450         /*
451          * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
452          * area as a result of ce_skip_worktree() shortcuts in
453          * verify_absent() and verify_uptodate().
454          * Make sure they don't modify worktree if they are already
455          * outside checkout area
456          */
457         if (was_skip_worktree && ce_skip_worktree(ce)) {
458                 ce->ce_flags &= ~CE_UPDATE;
459
460                 /*
461                  * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
462                  * on to get that file removed from both index and worktree.
463                  * If that file is already outside worktree area, don't
464                  * bother remove it.
465                  */
466                 if (ce->ce_flags & CE_REMOVE)
467                         ce->ce_flags &= ~CE_WT_REMOVE;
468         }
469
470         if (!was_skip_worktree && ce_skip_worktree(ce)) {
471                 /*
472                  * If CE_UPDATE is set, verify_uptodate() must be called already
473                  * also stat info may have lost after merged_entry() so calling
474                  * verify_uptodate() again may fail
475                  */
476                 if (!(ce->ce_flags & CE_UPDATE) && verify_uptodate_sparse(ce, o))
477                         return -1;
478                 ce->ce_flags |= CE_WT_REMOVE;
479                 ce->ce_flags &= ~CE_UPDATE;
480         }
481         if (was_skip_worktree && !ce_skip_worktree(ce)) {
482                 if (verify_absent_sparse(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o))
483                         return -1;
484                 ce->ce_flags |= CE_UPDATE;
485         }
486         return 0;
487 }
488
489 static inline int call_unpack_fn(const struct cache_entry * const *src,
490                                  struct unpack_trees_options *o)
491 {
492         int ret = o->fn(src, o);
493         if (ret > 0)
494                 ret = 0;
495         return ret;
496 }
497
498 static void mark_ce_used(struct cache_entry *ce, struct unpack_trees_options *o)
499 {
500         ce->ce_flags |= CE_UNPACKED;
501
502         if (o->cache_bottom < o->src_index->cache_nr &&
503             o->src_index->cache[o->cache_bottom] == ce) {
504                 int bottom = o->cache_bottom;
505                 while (bottom < o->src_index->cache_nr &&
506                        o->src_index->cache[bottom]->ce_flags & CE_UNPACKED)
507                         bottom++;
508                 o->cache_bottom = bottom;
509         }
510 }
511
512 static void mark_all_ce_unused(struct index_state *index)
513 {
514         int i;
515         for (i = 0; i < index->cache_nr; i++)
516                 index->cache[i]->ce_flags &= ~(CE_UNPACKED | CE_ADDED | CE_NEW_SKIP_WORKTREE);
517 }
518
519 static int locate_in_src_index(const struct cache_entry *ce,
520                                struct unpack_trees_options *o)
521 {
522         struct index_state *index = o->src_index;
523         int len = ce_namelen(ce);
524         int pos = index_name_pos(index, ce->name, len);
525         if (pos < 0)
526                 pos = -1 - pos;
527         return pos;
528 }
529
530 /*
531  * We call unpack_index_entry() with an unmerged cache entry
532  * only in diff-index, and it wants a single callback.  Skip
533  * the other unmerged entry with the same name.
534  */
535 static void mark_ce_used_same_name(struct cache_entry *ce,
536                                    struct unpack_trees_options *o)
537 {
538         struct index_state *index = o->src_index;
539         int len = ce_namelen(ce);
540         int pos;
541
542         for (pos = locate_in_src_index(ce, o); pos < index->cache_nr; pos++) {
543                 struct cache_entry *next = index->cache[pos];
544                 if (len != ce_namelen(next) ||
545                     memcmp(ce->name, next->name, len))
546                         break;
547                 mark_ce_used(next, o);
548         }
549 }
550
551 static struct cache_entry *next_cache_entry(struct unpack_trees_options *o)
552 {
553         const struct index_state *index = o->src_index;
554         int pos = o->cache_bottom;
555
556         while (pos < index->cache_nr) {
557                 struct cache_entry *ce = index->cache[pos];
558                 if (!(ce->ce_flags & CE_UNPACKED))
559                         return ce;
560                 pos++;
561         }
562         return NULL;
563 }
564
565 static void add_same_unmerged(const struct cache_entry *ce,
566                               struct unpack_trees_options *o)
567 {
568         struct index_state *index = o->src_index;
569         int len = ce_namelen(ce);
570         int pos = index_name_pos(index, ce->name, len);
571
572         if (0 <= pos)
573                 die("programming error in a caller of mark_ce_used_same_name");
574         for (pos = -pos - 1; pos < index->cache_nr; pos++) {
575                 struct cache_entry *next = index->cache[pos];
576                 if (len != ce_namelen(next) ||
577                     memcmp(ce->name, next->name, len))
578                         break;
579                 add_entry(o, next, 0, 0);
580                 mark_ce_used(next, o);
581         }
582 }
583
584 static int unpack_index_entry(struct cache_entry *ce,
585                               struct unpack_trees_options *o)
586 {
587         const struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
588         int ret;
589
590         src[0] = ce;
591
592         mark_ce_used(ce, o);
593         if (ce_stage(ce)) {
594                 if (o->skip_unmerged) {
595                         add_entry(o, ce, 0, 0);
596                         return 0;
597                 }
598         }
599         ret = call_unpack_fn(src, o);
600         if (ce_stage(ce))
601                 mark_ce_used_same_name(ce, o);
602         return ret;
603 }
604
605 static int find_cache_pos(struct traverse_info *, const struct name_entry *);
606
607 static void restore_cache_bottom(struct traverse_info *info, int bottom)
608 {
609         struct unpack_trees_options *o = info->data;
610
611         if (o->diff_index_cached)
612                 return;
613         o->cache_bottom = bottom;
614 }
615
616 static int switch_cache_bottom(struct traverse_info *info)
617 {
618         struct unpack_trees_options *o = info->data;
619         int ret, pos;
620
621         if (o->diff_index_cached)
622                 return 0;
623         ret = o->cache_bottom;
624         pos = find_cache_pos(info->prev, &info->name);
625
626         if (pos < -1)
627                 o->cache_bottom = -2 - pos;
628         else if (pos < 0)
629                 o->cache_bottom = o->src_index->cache_nr;
630         return ret;
631 }
632
633 static inline int are_same_oid(struct name_entry *name_j, struct name_entry *name_k)
634 {
635         return name_j->oid && name_k->oid && !oidcmp(name_j->oid, name_k->oid);
636 }
637
638 static int all_trees_same_as_cache_tree(int n, unsigned long dirmask,
639                                         struct name_entry *names,
640                                         struct traverse_info *info)
641 {
642         struct unpack_trees_options *o = info->data;
643         int i;
644
645         if (!o->merge || dirmask != ((1 << n) - 1))
646                 return 0;
647
648         for (i = 1; i < n; i++)
649                 if (!are_same_oid(names, names + i))
650                         return 0;
651
652         return cache_tree_matches_traversal(o->src_index->cache_tree, names, info);
653 }
654
655 static int index_pos_by_traverse_info(struct name_entry *names,
656                                       struct traverse_info *info)
657 {
658         struct unpack_trees_options *o = info->data;
659         int len = traverse_path_len(info, names);
660         char *name = xmalloc(len + 1 /* slash */ + 1 /* NUL */);
661         int pos;
662
663         make_traverse_path(name, info, names);
664         name[len++] = '/';
665         name[len] = '\0';
666         pos = index_name_pos(o->src_index, name, len);
667         if (pos >= 0)
668                 BUG("This is a directory and should not exist in index");
669         pos = -pos - 1;
670         if (!starts_with(o->src_index->cache[pos]->name, name) ||
671             (pos > 0 && starts_with(o->src_index->cache[pos-1]->name, name)))
672                 BUG("pos must point at the first entry in this directory");
673         free(name);
674         return pos;
675 }
676
677 /*
678  * Fast path if we detect that all trees are the same as cache-tree at this
679  * path. We'll walk these trees in an iterative loop using cache-tree/index
680  * instead of ODB since we already know what these trees contain.
681  */
682 static int traverse_by_cache_tree(int pos, int nr_entries, int nr_names,
683                                   struct name_entry *names,
684                                   struct traverse_info *info)
685 {
686         struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
687         struct unpack_trees_options *o = info->data;
688         struct cache_entry *tree_ce = NULL;
689         int ce_len = 0;
690         int i, d;
691
692         if (!o->merge)
693                 BUG("We need cache-tree to do this optimization");
694
695         /*
696          * Do what unpack_callback() and unpack_nondirectories() normally
697          * do. But we walk all paths in an iterative loop instead.
698          *
699          * D/F conflicts and higher stage entries are not a concern
700          * because cache-tree would be invalidated and we would never
701          * get here in the first place.
702          */
703         for (i = 0; i < nr_entries; i++) {
704                 int new_ce_len, len, rc;
705
706                 src[0] = o->src_index->cache[pos + i];
707
708                 len = ce_namelen(src[0]);
709                 new_ce_len = cache_entry_size(len);
710
711                 if (new_ce_len > ce_len) {
712                         new_ce_len <<= 1;
713                         tree_ce = xrealloc(tree_ce, new_ce_len);
714                         memset(tree_ce, 0, new_ce_len);
715                         ce_len = new_ce_len;
716
717                         tree_ce->ce_flags = create_ce_flags(0);
718
719                         for (d = 1; d <= nr_names; d++)
720                                 src[d] = tree_ce;
721                 }
722
723                 tree_ce->ce_mode = src[0]->ce_mode;
724                 tree_ce->ce_namelen = len;
725                 oidcpy(&tree_ce->oid, &src[0]->oid);
726                 memcpy(tree_ce->name, src[0]->name, len + 1);
727
728                 rc = call_unpack_fn((const struct cache_entry * const *)src, o);
729                 if (rc < 0) {
730                         free(tree_ce);
731                         return rc;
732                 }
733
734                 mark_ce_used(src[0], o);
735         }
736         free(tree_ce);
737         if (o->debug_unpack)
738                 printf("Unpacked %d entries from %s to %s using cache-tree\n",
739                        nr_entries,
740                        o->src_index->cache[pos]->name,
741                        o->src_index->cache[pos + nr_entries - 1]->name);
742         return 0;
743 }
744
745 static int traverse_trees_recursive(int n, unsigned long dirmask,
746                                     unsigned long df_conflicts,
747                                     struct name_entry *names,
748                                     struct traverse_info *info)
749 {
750         int i, ret, bottom;
751         int nr_buf = 0;
752         struct tree_desc t[MAX_UNPACK_TREES];
753         void *buf[MAX_UNPACK_TREES];
754         struct traverse_info newinfo;
755         struct name_entry *p;
756         int nr_entries;
757
758         nr_entries = all_trees_same_as_cache_tree(n, dirmask, names, info);
759         if (nr_entries > 0) {
760                 struct unpack_trees_options *o = info->data;
761                 int pos = index_pos_by_traverse_info(names, info);
762
763                 if (!o->merge || df_conflicts)
764                         BUG("Wrong condition to get here buddy");
765
766                 /*
767                  * All entries up to 'pos' must have been processed
768                  * (i.e. marked CE_UNPACKED) at this point. But to be safe,
769                  * save and restore cache_bottom anyway to not miss
770                  * unprocessed entries before 'pos'.
771                  */
772                 bottom = o->cache_bottom;
773                 ret = traverse_by_cache_tree(pos, nr_entries, n, names, info);
774                 o->cache_bottom = bottom;
775                 return ret;
776         }
777
778         p = names;
779         while (!p->mode)
780                 p++;
781
782         newinfo = *info;
783         newinfo.prev = info;
784         newinfo.pathspec = info->pathspec;
785         newinfo.name = *p;
786         newinfo.pathlen += tree_entry_len(p) + 1;
787         newinfo.df_conflicts |= df_conflicts;
788
789         /*
790          * Fetch the tree from the ODB for each peer directory in the
791          * n commits.
792          *
793          * For 2- and 3-way traversals, we try to avoid hitting the
794          * ODB twice for the same OID.  This should yield a nice speed
795          * up in checkouts and merges when the commits are similar.
796          *
797          * We don't bother doing the full O(n^2) search for larger n,
798          * because wider traversals don't happen that often and we
799          * avoid the search setup.
800          *
801          * When 2 peer OIDs are the same, we just copy the tree
802          * descriptor data.  This implicitly borrows the buffer
803          * data from the earlier cell.
804          */
805         for (i = 0; i < n; i++, dirmask >>= 1) {
806                 if (i > 0 && are_same_oid(&names[i], &names[i - 1]))
807                         t[i] = t[i - 1];
808                 else if (i > 1 && are_same_oid(&names[i], &names[i - 2]))
809                         t[i] = t[i - 2];
810                 else {
811                         const struct object_id *oid = NULL;
812                         if (dirmask & 1)
813                                 oid = names[i].oid;
814                         buf[nr_buf++] = fill_tree_descriptor(t + i, oid);
815                 }
816         }
817
818         bottom = switch_cache_bottom(&newinfo);
819         ret = traverse_trees(n, t, &newinfo);
820         restore_cache_bottom(&newinfo, bottom);
821
822         for (i = 0; i < nr_buf; i++)
823                 free(buf[i]);
824
825         return ret;
826 }
827
828 /*
829  * Compare the traverse-path to the cache entry without actually
830  * having to generate the textual representation of the traverse
831  * path.
832  *
833  * NOTE! This *only* compares up to the size of the traverse path
834  * itself - the caller needs to do the final check for the cache
835  * entry having more data at the end!
836  */
837 static int do_compare_entry_piecewise(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
838 {
839         int len, pathlen, ce_len;
840         const char *ce_name;
841
842         if (info->prev) {
843                 int cmp = do_compare_entry_piecewise(ce, info->prev,
844                                                      &info->name);
845                 if (cmp)
846                         return cmp;
847         }
848         pathlen = info->pathlen;
849         ce_len = ce_namelen(ce);
850
851         /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
852         if (ce_len < pathlen)
853                 return -1;
854
855         ce_len -= pathlen;
856         ce_name = ce->name + pathlen;
857
858         len = tree_entry_len(n);
859         return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
860 }
861
862 static int do_compare_entry(const struct cache_entry *ce,
863                             const struct traverse_info *info,
864                             const struct name_entry *n)
865 {
866         int len, pathlen, ce_len;
867         const char *ce_name;
868         int cmp;
869
870         /*
871          * If we have not precomputed the traverse path, it is quicker
872          * to avoid doing so.  But if we have precomputed it,
873          * it is quicker to use the precomputed version.
874          */
875         if (!info->traverse_path)
876                 return do_compare_entry_piecewise(ce, info, n);
877
878         cmp = strncmp(ce->name, info->traverse_path, info->pathlen);
879         if (cmp)
880                 return cmp;
881
882         pathlen = info->pathlen;
883         ce_len = ce_namelen(ce);
884
885         if (ce_len < pathlen)
886                 return -1;
887
888         ce_len -= pathlen;
889         ce_name = ce->name + pathlen;
890
891         len = tree_entry_len(n);
892         return df_name_compare(ce_name, ce_len, S_IFREG, n->path, len, n->mode);
893 }
894
895 static int compare_entry(const struct cache_entry *ce, const struct traverse_info *info, const struct name_entry *n)
896 {
897         int cmp = do_compare_entry(ce, info, n);
898         if (cmp)
899                 return cmp;
900
901         /*
902          * Even if the beginning compared identically, the ce should
903          * compare as bigger than a directory leading up to it!
904          */
905         return ce_namelen(ce) > traverse_path_len(info, n);
906 }
907
908 static int ce_in_traverse_path(const struct cache_entry *ce,
909                                const struct traverse_info *info)
910 {
911         if (!info->prev)
912                 return 1;
913         if (do_compare_entry(ce, info->prev, &info->name))
914                 return 0;
915         /*
916          * If ce (blob) is the same name as the path (which is a tree
917          * we will be descending into), it won't be inside it.
918          */
919         return (info->pathlen < ce_namelen(ce));
920 }
921
922 static struct cache_entry *create_ce_entry(const struct traverse_info *info,
923         const struct name_entry *n,
924         int stage,
925         struct index_state *istate,
926         int is_transient)
927 {
928         int len = traverse_path_len(info, n);
929         struct cache_entry *ce =
930                 is_transient ?
931                 make_empty_transient_cache_entry(len) :
932                 make_empty_cache_entry(istate, len);
933
934         ce->ce_mode = create_ce_mode(n->mode);
935         ce->ce_flags = create_ce_flags(stage);
936         ce->ce_namelen = len;
937         oidcpy(&ce->oid, n->oid);
938         make_traverse_path(ce->name, info, n);
939
940         return ce;
941 }
942
943 /*
944  * Note that traverse_by_cache_tree() duplicates some logic in this function
945  * without actually calling it. If you change the logic here you may need to
946  * check and change there as well.
947  */
948 static int unpack_nondirectories(int n, unsigned long mask,
949                                  unsigned long dirmask,
950                                  struct cache_entry **src,
951                                  const struct name_entry *names,
952                                  const struct traverse_info *info)
953 {
954         int i;
955         struct unpack_trees_options *o = info->data;
956         unsigned long conflicts = info->df_conflicts | dirmask;
957
958         /* Do we have *only* directories? Nothing to do */
959         if (mask == dirmask && !src[0])
960                 return 0;
961
962         /*
963          * Ok, we've filled in up to any potential index entry in src[0],
964          * now do the rest.
965          */
966         for (i = 0; i < n; i++) {
967                 int stage;
968                 unsigned int bit = 1ul << i;
969                 if (conflicts & bit) {
970                         src[i + o->merge] = o->df_conflict_entry;
971                         continue;
972                 }
973                 if (!(mask & bit))
974                         continue;
975                 if (!o->merge)
976                         stage = 0;
977                 else if (i + 1 < o->head_idx)
978                         stage = 1;
979                 else if (i + 1 > o->head_idx)
980                         stage = 3;
981                 else
982                         stage = 2;
983
984                 /*
985                  * If the merge bit is set, then the cache entries are
986                  * discarded in the following block.  In this case,
987                  * construct "transient" cache_entries, as they are
988                  * not stored in the index.  otherwise construct the
989                  * cache entry from the index aware logic.
990                  */
991                 src[i + o->merge] = create_ce_entry(info, names + i, stage, &o->result, o->merge);
992         }
993
994         if (o->merge) {
995                 int rc = call_unpack_fn((const struct cache_entry * const *)src,
996                                         o);
997                 for (i = 0; i < n; i++) {
998                         struct cache_entry *ce = src[i + o->merge];
999                         if (ce != o->df_conflict_entry)
1000                                 discard_cache_entry(ce);
1001                 }
1002                 return rc;
1003         }
1004
1005         for (i = 0; i < n; i++)
1006                 if (src[i] && src[i] != o->df_conflict_entry)
1007                         if (do_add_entry(o, src[i], 0, 0))
1008                                 return -1;
1009
1010         return 0;
1011 }
1012
1013 static int unpack_failed(struct unpack_trees_options *o, const char *message)
1014 {
1015         discard_index(&o->result);
1016         if (!o->gently && !o->exiting_early) {
1017                 if (message)
1018                         return error("%s", message);
1019                 return -1;
1020         }
1021         return -1;
1022 }
1023
1024 /*
1025  * The tree traversal is looking at name p.  If we have a matching entry,
1026  * return it.  If name p is a directory in the index, do not return
1027  * anything, as we will want to match it when the traversal descends into
1028  * the directory.
1029  */
1030 static int find_cache_pos(struct traverse_info *info,
1031                           const struct name_entry *p)
1032 {
1033         int pos;
1034         struct unpack_trees_options *o = info->data;
1035         struct index_state *index = o->src_index;
1036         int pfxlen = info->pathlen;
1037         int p_len = tree_entry_len(p);
1038
1039         for (pos = o->cache_bottom; pos < index->cache_nr; pos++) {
1040                 const struct cache_entry *ce = index->cache[pos];
1041                 const char *ce_name, *ce_slash;
1042                 int cmp, ce_len;
1043
1044                 if (ce->ce_flags & CE_UNPACKED) {
1045                         /*
1046                          * cache_bottom entry is already unpacked, so
1047                          * we can never match it; don't check it
1048                          * again.
1049                          */
1050                         if (pos == o->cache_bottom)
1051                                 ++o->cache_bottom;
1052                         continue;
1053                 }
1054                 if (!ce_in_traverse_path(ce, info)) {
1055                         /*
1056                          * Check if we can skip future cache checks
1057                          * (because we're already past all possible
1058                          * entries in the traverse path).
1059                          */
1060                         if (info->traverse_path) {
1061                                 if (strncmp(ce->name, info->traverse_path,
1062                                             info->pathlen) > 0)
1063                                         break;
1064                         }
1065                         continue;
1066                 }
1067                 ce_name = ce->name + pfxlen;
1068                 ce_slash = strchr(ce_name, '/');
1069                 if (ce_slash)
1070                         ce_len = ce_slash - ce_name;
1071                 else
1072                         ce_len = ce_namelen(ce) - pfxlen;
1073                 cmp = name_compare(p->path, p_len, ce_name, ce_len);
1074                 /*
1075                  * Exact match; if we have a directory we need to
1076                  * delay returning it.
1077                  */
1078                 if (!cmp)
1079                         return ce_slash ? -2 - pos : pos;
1080                 if (0 < cmp)
1081                         continue; /* keep looking */
1082                 /*
1083                  * ce_name sorts after p->path; could it be that we
1084                  * have files under p->path directory in the index?
1085                  * E.g.  ce_name == "t-i", and p->path == "t"; we may
1086                  * have "t/a" in the index.
1087                  */
1088                 if (p_len < ce_len && !memcmp(ce_name, p->path, p_len) &&
1089                     ce_name[p_len] < '/')
1090                         continue; /* keep looking */
1091                 break;
1092         }
1093         return -1;
1094 }
1095
1096 static struct cache_entry *find_cache_entry(struct traverse_info *info,
1097                                             const struct name_entry *p)
1098 {
1099         int pos = find_cache_pos(info, p);
1100         struct unpack_trees_options *o = info->data;
1101
1102         if (0 <= pos)
1103                 return o->src_index->cache[pos];
1104         else
1105                 return NULL;
1106 }
1107
1108 static void debug_path(struct traverse_info *info)
1109 {
1110         if (info->prev) {
1111                 debug_path(info->prev);
1112                 if (*info->prev->name.path)
1113                         putchar('/');
1114         }
1115         printf("%s", info->name.path);
1116 }
1117
1118 static void debug_name_entry(int i, struct name_entry *n)
1119 {
1120         printf("ent#%d %06o %s\n", i,
1121                n->path ? n->mode : 0,
1122                n->path ? n->path : "(missing)");
1123 }
1124
1125 static void debug_unpack_callback(int n,
1126                                   unsigned long mask,
1127                                   unsigned long dirmask,
1128                                   struct name_entry *names,
1129                                   struct traverse_info *info)
1130 {
1131         int i;
1132         printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1133                mask, dirmask, n);
1134         debug_path(info);
1135         putchar('\n');
1136         for (i = 0; i < n; i++)
1137                 debug_name_entry(i, names + i);
1138 }
1139
1140 /*
1141  * Note that traverse_by_cache_tree() duplicates some logic in this function
1142  * without actually calling it. If you change the logic here you may need to
1143  * check and change there as well.
1144  */
1145 static int unpack_callback(int n, unsigned long mask, unsigned long dirmask, struct name_entry *names, struct traverse_info *info)
1146 {
1147         struct cache_entry *src[MAX_UNPACK_TREES + 1] = { NULL, };
1148         struct unpack_trees_options *o = info->data;
1149         const struct name_entry *p = names;
1150
1151         /* Find first entry with a real name (we could use "mask" too) */
1152         while (!p->mode)
1153                 p++;
1154
1155         if (o->debug_unpack)
1156                 debug_unpack_callback(n, mask, dirmask, names, info);
1157
1158         /* Are we supposed to look at the index too? */
1159         if (o->merge) {
1160                 while (1) {
1161                         int cmp;
1162                         struct cache_entry *ce;
1163
1164                         if (o->diff_index_cached)
1165                                 ce = next_cache_entry(o);
1166                         else
1167                                 ce = find_cache_entry(info, p);
1168
1169                         if (!ce)
1170                                 break;
1171                         cmp = compare_entry(ce, info, p);
1172                         if (cmp < 0) {
1173                                 if (unpack_index_entry(ce, o) < 0)
1174                                         return unpack_failed(o, NULL);
1175                                 continue;
1176                         }
1177                         if (!cmp) {
1178                                 if (ce_stage(ce)) {
1179                                         /*
1180                                          * If we skip unmerged index
1181                                          * entries, we'll skip this
1182                                          * entry *and* the tree
1183                                          * entries associated with it!
1184                                          */
1185                                         if (o->skip_unmerged) {
1186                                                 add_same_unmerged(ce, o);
1187                                                 return mask;
1188                                         }
1189                                 }
1190                                 src[0] = ce;
1191                         }
1192                         break;
1193                 }
1194         }
1195
1196         if (unpack_nondirectories(n, mask, dirmask, src, names, info) < 0)
1197                 return -1;
1198
1199         if (o->merge && src[0]) {
1200                 if (ce_stage(src[0]))
1201                         mark_ce_used_same_name(src[0], o);
1202                 else
1203                         mark_ce_used(src[0], o);
1204         }
1205
1206         /* Now handle any directories.. */
1207         if (dirmask) {
1208                 /* special case: "diff-index --cached" looking at a tree */
1209                 if (o->diff_index_cached &&
1210                     n == 1 && dirmask == 1 && S_ISDIR(names->mode)) {
1211                         int matches;
1212                         matches = cache_tree_matches_traversal(o->src_index->cache_tree,
1213                                                                names, info);
1214                         /*
1215                          * Everything under the name matches; skip the
1216                          * entire hierarchy.  diff_index_cached codepath
1217                          * special cases D/F conflicts in such a way that
1218                          * it does not do any look-ahead, so this is safe.
1219                          */
1220                         if (matches) {
1221                                 o->cache_bottom += matches;
1222                                 return mask;
1223                         }
1224                 }
1225
1226                 if (traverse_trees_recursive(n, dirmask, mask & ~dirmask,
1227                                              names, info) < 0)
1228                         return -1;
1229                 return mask;
1230         }
1231
1232         return mask;
1233 }
1234
1235 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1236                             struct strbuf *prefix,
1237                             int select_mask, int clear_mask,
1238                             struct exclude_list *el, int defval);
1239
1240 /* Whole directory matching */
1241 static int clear_ce_flags_dir(struct cache_entry **cache, int nr,
1242                               struct strbuf *prefix,
1243                               char *basename,
1244                               int select_mask, int clear_mask,
1245                               struct exclude_list *el, int defval)
1246 {
1247         struct cache_entry **cache_end;
1248         int dtype = DT_DIR;
1249         int ret = is_excluded_from_list(prefix->buf, prefix->len,
1250                                         basename, &dtype, el, &the_index);
1251         int rc;
1252
1253         strbuf_addch(prefix, '/');
1254
1255         /* If undecided, use matching result of parent dir in defval */
1256         if (ret < 0)
1257                 ret = defval;
1258
1259         for (cache_end = cache; cache_end != cache + nr; cache_end++) {
1260                 struct cache_entry *ce = *cache_end;
1261                 if (strncmp(ce->name, prefix->buf, prefix->len))
1262                         break;
1263         }
1264
1265         /*
1266          * TODO: check el, if there are no patterns that may conflict
1267          * with ret (iow, we know in advance the incl/excl
1268          * decision for the entire directory), clear flag here without
1269          * calling clear_ce_flags_1(). That function will call
1270          * the expensive is_excluded_from_list() on every entry.
1271          */
1272         rc = clear_ce_flags_1(cache, cache_end - cache,
1273                               prefix,
1274                               select_mask, clear_mask,
1275                               el, ret);
1276         strbuf_setlen(prefix, prefix->len - 1);
1277         return rc;
1278 }
1279
1280 /*
1281  * Traverse the index, find every entry that matches according to
1282  * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
1283  * number of traversed entries.
1284  *
1285  * If select_mask is non-zero, only entries whose ce_flags has on of
1286  * those bits enabled are traversed.
1287  *
1288  * cache        : pointer to an index entry
1289  * prefix_len   : an offset to its path
1290  *
1291  * The current path ("prefix") including the trailing '/' is
1292  *   cache[0]->name[0..(prefix_len-1)]
1293  * Top level path has prefix_len zero.
1294  */
1295 static int clear_ce_flags_1(struct cache_entry **cache, int nr,
1296                             struct strbuf *prefix,
1297                             int select_mask, int clear_mask,
1298                             struct exclude_list *el, int defval)
1299 {
1300         struct cache_entry **cache_end = cache + nr;
1301
1302         /*
1303          * Process all entries that have the given prefix and meet
1304          * select_mask condition
1305          */
1306         while(cache != cache_end) {
1307                 struct cache_entry *ce = *cache;
1308                 const char *name, *slash;
1309                 int len, dtype, ret;
1310
1311                 if (select_mask && !(ce->ce_flags & select_mask)) {
1312                         cache++;
1313                         continue;
1314                 }
1315
1316                 if (prefix->len && strncmp(ce->name, prefix->buf, prefix->len))
1317                         break;
1318
1319                 name = ce->name + prefix->len;
1320                 slash = strchr(name, '/');
1321
1322                 /* If it's a directory, try whole directory match first */
1323                 if (slash) {
1324                         int processed;
1325
1326                         len = slash - name;
1327                         strbuf_add(prefix, name, len);
1328
1329                         processed = clear_ce_flags_dir(cache, cache_end - cache,
1330                                                        prefix,
1331                                                        prefix->buf + prefix->len - len,
1332                                                        select_mask, clear_mask,
1333                                                        el, defval);
1334
1335                         /* clear_c_f_dir eats a whole dir already? */
1336                         if (processed) {
1337                                 cache += processed;
1338                                 strbuf_setlen(prefix, prefix->len - len);
1339                                 continue;
1340                         }
1341
1342                         strbuf_addch(prefix, '/');
1343                         cache += clear_ce_flags_1(cache, cache_end - cache,
1344                                                   prefix,
1345                                                   select_mask, clear_mask, el, defval);
1346                         strbuf_setlen(prefix, prefix->len - len - 1);
1347                         continue;
1348                 }
1349
1350                 /* Non-directory */
1351                 dtype = ce_to_dtype(ce);
1352                 ret = is_excluded_from_list(ce->name, ce_namelen(ce),
1353                                             name, &dtype, el, &the_index);
1354                 if (ret < 0)
1355                         ret = defval;
1356                 if (ret > 0)
1357                         ce->ce_flags &= ~clear_mask;
1358                 cache++;
1359         }
1360         return nr - (cache_end - cache);
1361 }
1362
1363 static int clear_ce_flags(struct cache_entry **cache, int nr,
1364                             int select_mask, int clear_mask,
1365                             struct exclude_list *el)
1366 {
1367         static struct strbuf prefix = STRBUF_INIT;
1368
1369         strbuf_reset(&prefix);
1370
1371         return clear_ce_flags_1(cache, nr,
1372                                 &prefix,
1373                                 select_mask, clear_mask,
1374                                 el, 0);
1375 }
1376
1377 /*
1378  * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1379  */
1380 static void mark_new_skip_worktree(struct exclude_list *el,
1381                                    struct index_state *the_index,
1382                                    int select_flag, int skip_wt_flag)
1383 {
1384         int i;
1385
1386         /*
1387          * 1. Pretend the narrowest worktree: only unmerged entries
1388          * are checked out
1389          */
1390         for (i = 0; i < the_index->cache_nr; i++) {
1391                 struct cache_entry *ce = the_index->cache[i];
1392
1393                 if (select_flag && !(ce->ce_flags & select_flag))
1394                         continue;
1395
1396                 if (!ce_stage(ce) && !(ce->ce_flags & CE_CONFLICTED))
1397                         ce->ce_flags |= skip_wt_flag;
1398                 else
1399                         ce->ce_flags &= ~skip_wt_flag;
1400         }
1401
1402         /*
1403          * 2. Widen worktree according to sparse-checkout file.
1404          * Matched entries will have skip_wt_flag cleared (i.e. "in")
1405          */
1406         clear_ce_flags(the_index->cache, the_index->cache_nr,
1407                        select_flag, skip_wt_flag, el);
1408 }
1409
1410 static int verify_absent(const struct cache_entry *,
1411                          enum unpack_trees_error_types,
1412                          struct unpack_trees_options *);
1413 /*
1414  * N-way merge "len" trees.  Returns 0 on success, -1 on failure to manipulate the
1415  * resulting index, -2 on failure to reflect the changes to the work tree.
1416  *
1417  * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1418  */
1419 int unpack_trees(unsigned len, struct tree_desc *t, struct unpack_trees_options *o)
1420 {
1421         int i, ret;
1422         static struct cache_entry *dfc;
1423         struct exclude_list el;
1424
1425         if (len > MAX_UNPACK_TREES)
1426                 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES);
1427
1428         trace_performance_enter();
1429         memset(&el, 0, sizeof(el));
1430         if (!core_apply_sparse_checkout || !o->update)
1431                 o->skip_sparse_checkout = 1;
1432         if (!o->skip_sparse_checkout) {
1433                 char *sparse = git_pathdup("info/sparse-checkout");
1434                 if (add_excludes_from_file_to_list(sparse, "", 0, &el, NULL) < 0)
1435                         o->skip_sparse_checkout = 1;
1436                 else
1437                         o->el = &el;
1438                 free(sparse);
1439         }
1440
1441         memset(&o->result, 0, sizeof(o->result));
1442         o->result.initialized = 1;
1443         o->result.timestamp.sec = o->src_index->timestamp.sec;
1444         o->result.timestamp.nsec = o->src_index->timestamp.nsec;
1445         o->result.version = o->src_index->version;
1446         if (!o->src_index->split_index) {
1447                 o->result.split_index = NULL;
1448         } else if (o->src_index == o->dst_index) {
1449                 /*
1450                  * o->dst_index (and thus o->src_index) will be discarded
1451                  * and overwritten with o->result at the end of this function,
1452                  * so just use src_index's split_index to avoid having to
1453                  * create a new one.
1454                  */
1455                 o->result.split_index = o->src_index->split_index;
1456                 o->result.split_index->refcount++;
1457         } else {
1458                 o->result.split_index = init_split_index(&o->result);
1459         }
1460         oidcpy(&o->result.oid, &o->src_index->oid);
1461         o->merge_size = len;
1462         mark_all_ce_unused(o->src_index);
1463
1464         /*
1465          * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1466          */
1467         if (!o->skip_sparse_checkout)
1468                 mark_new_skip_worktree(o->el, o->src_index, 0, CE_NEW_SKIP_WORKTREE);
1469
1470         if (!dfc)
1471                 dfc = xcalloc(1, cache_entry_size(0));
1472         o->df_conflict_entry = dfc;
1473
1474         if (len) {
1475                 const char *prefix = o->prefix ? o->prefix : "";
1476                 struct traverse_info info;
1477
1478                 setup_traverse_info(&info, prefix);
1479                 info.fn = unpack_callback;
1480                 info.data = o;
1481                 info.show_all_errors = o->show_all_errors;
1482                 info.pathspec = o->pathspec;
1483
1484                 if (o->prefix) {
1485                         /*
1486                          * Unpack existing index entries that sort before the
1487                          * prefix the tree is spliced into.  Note that o->merge
1488                          * is always true in this case.
1489                          */
1490                         while (1) {
1491                                 struct cache_entry *ce = next_cache_entry(o);
1492                                 if (!ce)
1493                                         break;
1494                                 if (ce_in_traverse_path(ce, &info))
1495                                         break;
1496                                 if (unpack_index_entry(ce, o) < 0)
1497                                         goto return_failed;
1498                         }
1499                 }
1500
1501                 trace_performance_enter();
1502                 ret = traverse_trees(len, t, &info);
1503                 trace_performance_leave("traverse_trees");
1504                 if (ret < 0)
1505                         goto return_failed;
1506         }
1507
1508         /* Any left-over entries in the index? */
1509         if (o->merge) {
1510                 while (1) {
1511                         struct cache_entry *ce = next_cache_entry(o);
1512                         if (!ce)
1513                                 break;
1514                         if (unpack_index_entry(ce, o) < 0)
1515                                 goto return_failed;
1516                 }
1517         }
1518         mark_all_ce_unused(o->src_index);
1519
1520         if (o->trivial_merges_only && o->nontrivial_merge) {
1521                 ret = unpack_failed(o, "Merge requires file-level merging");
1522                 goto done;
1523         }
1524
1525         if (!o->skip_sparse_checkout) {
1526                 int empty_worktree = 1;
1527
1528                 /*
1529                  * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1530                  * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1531                  * so apply_sparse_checkout() won't attempt to remove it from worktree
1532                  */
1533                 mark_new_skip_worktree(o->el, &o->result, CE_ADDED, CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1534
1535                 ret = 0;
1536                 for (i = 0; i < o->result.cache_nr; i++) {
1537                         struct cache_entry *ce = o->result.cache[i];
1538
1539                         /*
1540                          * Entries marked with CE_ADDED in merged_entry() do not have
1541                          * verify_absent() check (the check is effectively disabled
1542                          * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1543                          *
1544                          * Do the real check now because we have had
1545                          * correct CE_NEW_SKIP_WORKTREE
1546                          */
1547                         if (ce->ce_flags & CE_ADDED &&
1548                             verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1549                                 if (!o->show_all_errors)
1550                                         goto return_failed;
1551                                 ret = -1;
1552                         }
1553
1554                         if (apply_sparse_checkout(&o->result, ce, o)) {
1555                                 if (!o->show_all_errors)
1556                                         goto return_failed;
1557                                 ret = -1;
1558                         }
1559                         if (!ce_skip_worktree(ce))
1560                                 empty_worktree = 0;
1561
1562                 }
1563                 if (ret < 0)
1564                         goto return_failed;
1565                 /*
1566                  * Sparse checkout is meant to narrow down checkout area
1567                  * but it does not make sense to narrow down to empty working
1568                  * tree. This is usually a mistake in sparse checkout rules.
1569                  * Do not allow users to do that.
1570                  */
1571                 if (o->result.cache_nr && empty_worktree) {
1572                         ret = unpack_failed(o, "Sparse checkout leaves no entry on working directory");
1573                         goto done;
1574                 }
1575         }
1576
1577         ret = check_updates(o) ? (-2) : 0;
1578         if (o->dst_index) {
1579                 move_index_extensions(&o->result, o->src_index);
1580                 if (!ret) {
1581                         if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
1582                                 cache_tree_verify(&o->result);
1583                         if (!o->result.cache_tree)
1584                                 o->result.cache_tree = cache_tree();
1585                         if (!cache_tree_fully_valid(o->result.cache_tree))
1586                                 cache_tree_update(&o->result,
1587                                                   WRITE_TREE_SILENT |
1588                                                   WRITE_TREE_REPAIR);
1589                 }
1590                 discard_index(o->dst_index);
1591                 *o->dst_index = o->result;
1592         } else {
1593                 discard_index(&o->result);
1594         }
1595         o->src_index = NULL;
1596
1597 done:
1598         trace_performance_leave("unpack_trees");
1599         clear_exclude_list(&el);
1600         return ret;
1601
1602 return_failed:
1603         if (o->show_all_errors)
1604                 display_error_msgs(o);
1605         mark_all_ce_unused(o->src_index);
1606         ret = unpack_failed(o, NULL);
1607         if (o->exiting_early)
1608                 ret = 0;
1609         goto done;
1610 }
1611
1612 /* Here come the merge functions */
1613
1614 static int reject_merge(const struct cache_entry *ce,
1615                         struct unpack_trees_options *o)
1616 {
1617         return o->gently ? -1 :
1618                 add_rejected_path(o, ERROR_WOULD_OVERWRITE, ce->name);
1619 }
1620
1621 static int same(const struct cache_entry *a, const struct cache_entry *b)
1622 {
1623         if (!!a != !!b)
1624                 return 0;
1625         if (!a && !b)
1626                 return 1;
1627         if ((a->ce_flags | b->ce_flags) & CE_CONFLICTED)
1628                 return 0;
1629         return a->ce_mode == b->ce_mode &&
1630                !oidcmp(&a->oid, &b->oid);
1631 }
1632
1633
1634 /*
1635  * When a CE gets turned into an unmerged entry, we
1636  * want it to be up-to-date
1637  */
1638 static int verify_uptodate_1(const struct cache_entry *ce,
1639                              struct unpack_trees_options *o,
1640                              enum unpack_trees_error_types error_type)
1641 {
1642         struct stat st;
1643
1644         if (o->index_only)
1645                 return 0;
1646
1647         /*
1648          * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1649          * if this entry is truly up-to-date because this file may be
1650          * overwritten.
1651          */
1652         if ((ce->ce_flags & CE_VALID) || ce_skip_worktree(ce))
1653                 ; /* keep checking */
1654         else if (o->reset || ce_uptodate(ce))
1655                 return 0;
1656
1657         if (!lstat(ce->name, &st)) {
1658                 int flags = CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE;
1659                 unsigned changed = ie_match_stat(o->src_index, ce, &st, flags);
1660
1661                 if (submodule_from_ce(ce)) {
1662                         int r = check_submodule_move_head(ce,
1663                                 "HEAD", oid_to_hex(&ce->oid), o);
1664                         if (r)
1665                                 return o->gently ? -1 :
1666                                         add_rejected_path(o, error_type, ce->name);
1667                         return 0;
1668                 }
1669
1670                 if (!changed)
1671                         return 0;
1672                 /*
1673                  * Historic default policy was to allow submodule to be out
1674                  * of sync wrt the superproject index. If the submodule was
1675                  * not considered interesting above, we don't care here.
1676                  */
1677                 if (S_ISGITLINK(ce->ce_mode))
1678                         return 0;
1679
1680                 errno = 0;
1681         }
1682         if (errno == ENOENT)
1683                 return 0;
1684         return o->gently ? -1 :
1685                 add_rejected_path(o, error_type, ce->name);
1686 }
1687
1688 int verify_uptodate(const struct cache_entry *ce,
1689                     struct unpack_trees_options *o)
1690 {
1691         if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1692                 return 0;
1693         return verify_uptodate_1(ce, o, ERROR_NOT_UPTODATE_FILE);
1694 }
1695
1696 static int verify_uptodate_sparse(const struct cache_entry *ce,
1697                                   struct unpack_trees_options *o)
1698 {
1699         return verify_uptodate_1(ce, o, ERROR_SPARSE_NOT_UPTODATE_FILE);
1700 }
1701
1702 static void invalidate_ce_path(const struct cache_entry *ce,
1703                                struct unpack_trees_options *o)
1704 {
1705         if (!ce)
1706                 return;
1707         cache_tree_invalidate_path(o->src_index, ce->name);
1708         untracked_cache_invalidate_path(o->src_index, ce->name, 1);
1709 }
1710
1711 /*
1712  * Check that checking out ce->sha1 in subdir ce->name is not
1713  * going to overwrite any working files.
1714  *
1715  * Currently, git does not checkout subprojects during a superproject
1716  * checkout, so it is not going to overwrite anything.
1717  */
1718 static int verify_clean_submodule(const char *old_sha1,
1719                                   const struct cache_entry *ce,
1720                                   enum unpack_trees_error_types error_type,
1721                                   struct unpack_trees_options *o)
1722 {
1723         if (!submodule_from_ce(ce))
1724                 return 0;
1725
1726         return check_submodule_move_head(ce, old_sha1,
1727                                          oid_to_hex(&ce->oid), o);
1728 }
1729
1730 static int verify_clean_subdirectory(const struct cache_entry *ce,
1731                                      enum unpack_trees_error_types error_type,
1732                                      struct unpack_trees_options *o)
1733 {
1734         /*
1735          * we are about to extract "ce->name"; we would not want to lose
1736          * anything in the existing directory there.
1737          */
1738         int namelen;
1739         int i;
1740         struct dir_struct d;
1741         char *pathbuf;
1742         int cnt = 0;
1743
1744         if (S_ISGITLINK(ce->ce_mode)) {
1745                 struct object_id oid;
1746                 int sub_head = resolve_gitlink_ref(ce->name, "HEAD", &oid);
1747                 /*
1748                  * If we are not going to update the submodule, then
1749                  * we don't care.
1750                  */
1751                 if (!sub_head && !oidcmp(&oid, &ce->oid))
1752                         return 0;
1753                 return verify_clean_submodule(sub_head ? NULL : oid_to_hex(&oid),
1754                                               ce, error_type, o);
1755         }
1756
1757         /*
1758          * First let's make sure we do not have a local modification
1759          * in that directory.
1760          */
1761         namelen = ce_namelen(ce);
1762         for (i = locate_in_src_index(ce, o);
1763              i < o->src_index->cache_nr;
1764              i++) {
1765                 struct cache_entry *ce2 = o->src_index->cache[i];
1766                 int len = ce_namelen(ce2);
1767                 if (len < namelen ||
1768                     strncmp(ce->name, ce2->name, namelen) ||
1769                     ce2->name[namelen] != '/')
1770                         break;
1771                 /*
1772                  * ce2->name is an entry in the subdirectory to be
1773                  * removed.
1774                  */
1775                 if (!ce_stage(ce2)) {
1776                         if (verify_uptodate(ce2, o))
1777                                 return -1;
1778                         add_entry(o, ce2, CE_REMOVE, 0);
1779                         invalidate_ce_path(ce, o);
1780                         mark_ce_used(ce2, o);
1781                 }
1782                 cnt++;
1783         }
1784
1785         /*
1786          * Then we need to make sure that we do not lose a locally
1787          * present file that is not ignored.
1788          */
1789         pathbuf = xstrfmt("%.*s/", namelen, ce->name);
1790
1791         memset(&d, 0, sizeof(d));
1792         if (o->dir)
1793                 d.exclude_per_dir = o->dir->exclude_per_dir;
1794         i = read_directory(&d, &the_index, pathbuf, namelen+1, NULL);
1795         if (i)
1796                 return o->gently ? -1 :
1797                         add_rejected_path(o, ERROR_NOT_UPTODATE_DIR, ce->name);
1798         free(pathbuf);
1799         return cnt;
1800 }
1801
1802 /*
1803  * This gets called when there was no index entry for the tree entry 'dst',
1804  * but we found a file in the working tree that 'lstat()' said was fine,
1805  * and we're on a case-insensitive filesystem.
1806  *
1807  * See if we can find a case-insensitive match in the index that also
1808  * matches the stat information, and assume it's that other file!
1809  */
1810 static int icase_exists(struct unpack_trees_options *o, const char *name, int len, struct stat *st)
1811 {
1812         const struct cache_entry *src;
1813
1814         src = index_file_exists(o->src_index, name, len, 1);
1815         return src && !ie_match_stat(o->src_index, src, st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE);
1816 }
1817
1818 static int check_ok_to_remove(const char *name, int len, int dtype,
1819                               const struct cache_entry *ce, struct stat *st,
1820                               enum unpack_trees_error_types error_type,
1821                               struct unpack_trees_options *o)
1822 {
1823         const struct cache_entry *result;
1824
1825         /*
1826          * It may be that the 'lstat()' succeeded even though
1827          * target 'ce' was absent, because there is an old
1828          * entry that is different only in case..
1829          *
1830          * Ignore that lstat() if it matches.
1831          */
1832         if (ignore_case && icase_exists(o, name, len, st))
1833                 return 0;
1834
1835         if (o->dir &&
1836             is_excluded(o->dir, &the_index, name, &dtype))
1837                 /*
1838                  * ce->name is explicitly excluded, so it is Ok to
1839                  * overwrite it.
1840                  */
1841                 return 0;
1842         if (S_ISDIR(st->st_mode)) {
1843                 /*
1844                  * We are checking out path "foo" and
1845                  * found "foo/." in the working tree.
1846                  * This is tricky -- if we have modified
1847                  * files that are in "foo/" we would lose
1848                  * them.
1849                  */
1850                 if (verify_clean_subdirectory(ce, error_type, o) < 0)
1851                         return -1;
1852                 return 0;
1853         }
1854
1855         /*
1856          * The previous round may already have decided to
1857          * delete this path, which is in a subdirectory that
1858          * is being replaced with a blob.
1859          */
1860         result = index_file_exists(&o->result, name, len, 0);
1861         if (result) {
1862                 if (result->ce_flags & CE_REMOVE)
1863                         return 0;
1864         }
1865
1866         return o->gently ? -1 :
1867                 add_rejected_path(o, error_type, name);
1868 }
1869
1870 /*
1871  * We do not want to remove or overwrite a working tree file that
1872  * is not tracked, unless it is ignored.
1873  */
1874 static int verify_absent_1(const struct cache_entry *ce,
1875                            enum unpack_trees_error_types error_type,
1876                            struct unpack_trees_options *o)
1877 {
1878         int len;
1879         struct stat st;
1880
1881         if (o->index_only || o->reset || !o->update)
1882                 return 0;
1883
1884         len = check_leading_path(ce->name, ce_namelen(ce));
1885         if (!len)
1886                 return 0;
1887         else if (len > 0) {
1888                 char *path;
1889                 int ret;
1890
1891                 path = xmemdupz(ce->name, len);
1892                 if (lstat(path, &st))
1893                         ret = error_errno("cannot stat '%s'", path);
1894                 else {
1895                         if (submodule_from_ce(ce))
1896                                 ret = check_submodule_move_head(ce,
1897                                                                 oid_to_hex(&ce->oid),
1898                                                                 NULL, o);
1899                         else
1900                                 ret = check_ok_to_remove(path, len, DT_UNKNOWN, NULL,
1901                                                          &st, error_type, o);
1902                 }
1903                 free(path);
1904                 return ret;
1905         } else if (lstat(ce->name, &st)) {
1906                 if (errno != ENOENT)
1907                         return error_errno("cannot stat '%s'", ce->name);
1908                 return 0;
1909         } else {
1910                 if (submodule_from_ce(ce))
1911                         return check_submodule_move_head(ce, oid_to_hex(&ce->oid),
1912                                                          NULL, o);
1913
1914                 return check_ok_to_remove(ce->name, ce_namelen(ce),
1915                                           ce_to_dtype(ce), ce, &st,
1916                                           error_type, o);
1917         }
1918 }
1919
1920 static int verify_absent(const struct cache_entry *ce,
1921                          enum unpack_trees_error_types error_type,
1922                          struct unpack_trees_options *o)
1923 {
1924         if (!o->skip_sparse_checkout && (ce->ce_flags & CE_NEW_SKIP_WORKTREE))
1925                 return 0;
1926         return verify_absent_1(ce, error_type, o);
1927 }
1928
1929 static int verify_absent_sparse(const struct cache_entry *ce,
1930                                 enum unpack_trees_error_types error_type,
1931                                 struct unpack_trees_options *o)
1932 {
1933         enum unpack_trees_error_types orphaned_error = error_type;
1934         if (orphaned_error == ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN)
1935                 orphaned_error = ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN;
1936
1937         return verify_absent_1(ce, orphaned_error, o);
1938 }
1939
1940 static int merged_entry(const struct cache_entry *ce,
1941                         const struct cache_entry *old,
1942                         struct unpack_trees_options *o)
1943 {
1944         int update = CE_UPDATE;
1945         struct cache_entry *merge = dup_cache_entry(ce, &o->result);
1946
1947         if (!old) {
1948                 /*
1949                  * New index entries. In sparse checkout, the following
1950                  * verify_absent() will be delayed until after
1951                  * traverse_trees() finishes in unpack_trees(), then:
1952                  *
1953                  *  - CE_NEW_SKIP_WORKTREE will be computed correctly
1954                  *  - verify_absent() be called again, this time with
1955                  *    correct CE_NEW_SKIP_WORKTREE
1956                  *
1957                  * verify_absent() call here does nothing in sparse
1958                  * checkout (i.e. o->skip_sparse_checkout == 0)
1959                  */
1960                 update |= CE_ADDED;
1961                 merge->ce_flags |= CE_NEW_SKIP_WORKTREE;
1962
1963                 if (verify_absent(merge,
1964                                   ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN, o)) {
1965                         discard_cache_entry(merge);
1966                         return -1;
1967                 }
1968                 invalidate_ce_path(merge, o);
1969
1970                 if (submodule_from_ce(ce)) {
1971                         int ret = check_submodule_move_head(ce, NULL,
1972                                                             oid_to_hex(&ce->oid),
1973                                                             o);
1974                         if (ret)
1975                                 return ret;
1976                 }
1977
1978         } else if (!(old->ce_flags & CE_CONFLICTED)) {
1979                 /*
1980                  * See if we can re-use the old CE directly?
1981                  * That way we get the uptodate stat info.
1982                  *
1983                  * This also removes the UPDATE flag on a match; otherwise
1984                  * we will end up overwriting local changes in the work tree.
1985                  */
1986                 if (same(old, merge)) {
1987                         copy_cache_entry(merge, old);
1988                         update = 0;
1989                 } else {
1990                         if (verify_uptodate(old, o)) {
1991                                 discard_cache_entry(merge);
1992                                 return -1;
1993                         }
1994                         /* Migrate old flags over */
1995                         update |= old->ce_flags & (CE_SKIP_WORKTREE | CE_NEW_SKIP_WORKTREE);
1996                         invalidate_ce_path(old, o);
1997                 }
1998
1999                 if (submodule_from_ce(ce)) {
2000                         int ret = check_submodule_move_head(ce, oid_to_hex(&old->oid),
2001                                                             oid_to_hex(&ce->oid),
2002                                                             o);
2003                         if (ret)
2004                                 return ret;
2005                 }
2006         } else {
2007                 /*
2008                  * Previously unmerged entry left as an existence
2009                  * marker by read_index_unmerged();
2010                  */
2011                 invalidate_ce_path(old, o);
2012         }
2013
2014         do_add_entry(o, merge, update, CE_STAGEMASK);
2015         return 1;
2016 }
2017
2018 static int deleted_entry(const struct cache_entry *ce,
2019                          const struct cache_entry *old,
2020                          struct unpack_trees_options *o)
2021 {
2022         /* Did it exist in the index? */
2023         if (!old) {
2024                 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2025                         return -1;
2026                 return 0;
2027         }
2028         if (!(old->ce_flags & CE_CONFLICTED) && verify_uptodate(old, o))
2029                 return -1;
2030         add_entry(o, ce, CE_REMOVE, 0);
2031         invalidate_ce_path(ce, o);
2032         return 1;
2033 }
2034
2035 static int keep_entry(const struct cache_entry *ce,
2036                       struct unpack_trees_options *o)
2037 {
2038         add_entry(o, ce, 0, 0);
2039         if (ce_stage(ce))
2040                 invalidate_ce_path(ce, o);
2041         return 1;
2042 }
2043
2044 #if DBRT_DEBUG
2045 static void show_stage_entry(FILE *o,
2046                              const char *label, const struct cache_entry *ce)
2047 {
2048         if (!ce)
2049                 fprintf(o, "%s (missing)\n", label);
2050         else
2051                 fprintf(o, "%s%06o %s %d\t%s\n",
2052                         label,
2053                         ce->ce_mode,
2054                         oid_to_hex(&ce->oid),
2055                         ce_stage(ce),
2056                         ce->name);
2057 }
2058 #endif
2059
2060 int threeway_merge(const struct cache_entry * const *stages,
2061                    struct unpack_trees_options *o)
2062 {
2063         const struct cache_entry *index;
2064         const struct cache_entry *head;
2065         const struct cache_entry *remote = stages[o->head_idx + 1];
2066         int count;
2067         int head_match = 0;
2068         int remote_match = 0;
2069
2070         int df_conflict_head = 0;
2071         int df_conflict_remote = 0;
2072
2073         int any_anc_missing = 0;
2074         int no_anc_exists = 1;
2075         int i;
2076
2077         for (i = 1; i < o->head_idx; i++) {
2078                 if (!stages[i] || stages[i] == o->df_conflict_entry)
2079                         any_anc_missing = 1;
2080                 else
2081                         no_anc_exists = 0;
2082         }
2083
2084         index = stages[0];
2085         head = stages[o->head_idx];
2086
2087         if (head == o->df_conflict_entry) {
2088                 df_conflict_head = 1;
2089                 head = NULL;
2090         }
2091
2092         if (remote == o->df_conflict_entry) {
2093                 df_conflict_remote = 1;
2094                 remote = NULL;
2095         }
2096
2097         /*
2098          * First, if there's a #16 situation, note that to prevent #13
2099          * and #14.
2100          */
2101         if (!same(remote, head)) {
2102                 for (i = 1; i < o->head_idx; i++) {
2103                         if (same(stages[i], head)) {
2104                                 head_match = i;
2105                         }
2106                         if (same(stages[i], remote)) {
2107                                 remote_match = i;
2108                         }
2109                 }
2110         }
2111
2112         /*
2113          * We start with cases where the index is allowed to match
2114          * something other than the head: #14(ALT) and #2ALT, where it
2115          * is permitted to match the result instead.
2116          */
2117         /* #14, #14ALT, #2ALT */
2118         if (remote && !df_conflict_head && head_match && !remote_match) {
2119                 if (index && !same(index, remote) && !same(index, head))
2120                         return reject_merge(index, o);
2121                 return merged_entry(remote, index, o);
2122         }
2123         /*
2124          * If we have an entry in the index cache, then we want to
2125          * make sure that it matches head.
2126          */
2127         if (index && !same(index, head))
2128                 return reject_merge(index, o);
2129
2130         if (head) {
2131                 /* #5ALT, #15 */
2132                 if (same(head, remote))
2133                         return merged_entry(head, index, o);
2134                 /* #13, #3ALT */
2135                 if (!df_conflict_remote && remote_match && !head_match)
2136                         return merged_entry(head, index, o);
2137         }
2138
2139         /* #1 */
2140         if (!head && !remote && any_anc_missing)
2141                 return 0;
2142
2143         /*
2144          * Under the "aggressive" rule, we resolve mostly trivial
2145          * cases that we historically had git-merge-one-file resolve.
2146          */
2147         if (o->aggressive) {
2148                 int head_deleted = !head;
2149                 int remote_deleted = !remote;
2150                 const struct cache_entry *ce = NULL;
2151
2152                 if (index)
2153                         ce = index;
2154                 else if (head)
2155                         ce = head;
2156                 else if (remote)
2157                         ce = remote;
2158                 else {
2159                         for (i = 1; i < o->head_idx; i++) {
2160                                 if (stages[i] && stages[i] != o->df_conflict_entry) {
2161                                         ce = stages[i];
2162                                         break;
2163                                 }
2164                         }
2165                 }
2166
2167                 /*
2168                  * Deleted in both.
2169                  * Deleted in one and unchanged in the other.
2170                  */
2171                 if ((head_deleted && remote_deleted) ||
2172                     (head_deleted && remote && remote_match) ||
2173                     (remote_deleted && head && head_match)) {
2174                         if (index)
2175                                 return deleted_entry(index, index, o);
2176                         if (ce && !head_deleted) {
2177                                 if (verify_absent(ce, ERROR_WOULD_LOSE_UNTRACKED_REMOVED, o))
2178                                         return -1;
2179                         }
2180                         return 0;
2181                 }
2182                 /*
2183                  * Added in both, identically.
2184                  */
2185                 if (no_anc_exists && head && remote && same(head, remote))
2186                         return merged_entry(head, index, o);
2187
2188         }
2189
2190         /* Below are "no merge" cases, which require that the index be
2191          * up-to-date to avoid the files getting overwritten with
2192          * conflict resolution files.
2193          */
2194         if (index) {
2195                 if (verify_uptodate(index, o))
2196                         return -1;
2197         }
2198
2199         o->nontrivial_merge = 1;
2200
2201         /* #2, #3, #4, #6, #7, #9, #10, #11. */
2202         count = 0;
2203         if (!head_match || !remote_match) {
2204                 for (i = 1; i < o->head_idx; i++) {
2205                         if (stages[i] && stages[i] != o->df_conflict_entry) {
2206                                 keep_entry(stages[i], o);
2207                                 count++;
2208                                 break;
2209                         }
2210                 }
2211         }
2212 #if DBRT_DEBUG
2213         else {
2214                 fprintf(stderr, "read-tree: warning #16 detected\n");
2215                 show_stage_entry(stderr, "head   ", stages[head_match]);
2216                 show_stage_entry(stderr, "remote ", stages[remote_match]);
2217         }
2218 #endif
2219         if (head) { count += keep_entry(head, o); }
2220         if (remote) { count += keep_entry(remote, o); }
2221         return count;
2222 }
2223
2224 /*
2225  * Two-way merge.
2226  *
2227  * The rule is to "carry forward" what is in the index without losing
2228  * information across a "fast-forward", favoring a successful merge
2229  * over a merge failure when it makes sense.  For details of the
2230  * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2231  *
2232  */
2233 int twoway_merge(const struct cache_entry * const *src,
2234                  struct unpack_trees_options *o)
2235 {
2236         const struct cache_entry *current = src[0];
2237         const struct cache_entry *oldtree = src[1];
2238         const struct cache_entry *newtree = src[2];
2239
2240         if (o->merge_size != 2)
2241                 return error("Cannot do a twoway merge of %d trees",
2242                              o->merge_size);
2243
2244         if (oldtree == o->df_conflict_entry)
2245                 oldtree = NULL;
2246         if (newtree == o->df_conflict_entry)
2247                 newtree = NULL;
2248
2249         if (current) {
2250                 if (current->ce_flags & CE_CONFLICTED) {
2251                         if (same(oldtree, newtree) || o->reset) {
2252                                 if (!newtree)
2253                                         return deleted_entry(current, current, o);
2254                                 else
2255                                         return merged_entry(newtree, current, o);
2256                         }
2257                         return reject_merge(current, o);
2258                 } else if ((!oldtree && !newtree) || /* 4 and 5 */
2259                          (!oldtree && newtree &&
2260                           same(current, newtree)) || /* 6 and 7 */
2261                          (oldtree && newtree &&
2262                           same(oldtree, newtree)) || /* 14 and 15 */
2263                          (oldtree && newtree &&
2264                           !same(oldtree, newtree) && /* 18 and 19 */
2265                           same(current, newtree))) {
2266                         return keep_entry(current, o);
2267                 } else if (oldtree && !newtree && same(current, oldtree)) {
2268                         /* 10 or 11 */
2269                         return deleted_entry(oldtree, current, o);
2270                 } else if (oldtree && newtree &&
2271                          same(current, oldtree) && !same(current, newtree)) {
2272                         /* 20 or 21 */
2273                         return merged_entry(newtree, current, o);
2274                 } else
2275                         return reject_merge(current, o);
2276         }
2277         else if (newtree) {
2278                 if (oldtree && !o->initial_checkout) {
2279                         /*
2280                          * deletion of the path was staged;
2281                          */
2282                         if (same(oldtree, newtree))
2283                                 return 1;
2284                         return reject_merge(oldtree, o);
2285                 }
2286                 return merged_entry(newtree, current, o);
2287         }
2288         return deleted_entry(oldtree, current, o);
2289 }
2290
2291 /*
2292  * Bind merge.
2293  *
2294  * Keep the index entries at stage0, collapse stage1 but make sure
2295  * stage0 does not have anything there.
2296  */
2297 int bind_merge(const struct cache_entry * const *src,
2298                struct unpack_trees_options *o)
2299 {
2300         const struct cache_entry *old = src[0];
2301         const struct cache_entry *a = src[1];
2302
2303         if (o->merge_size != 1)
2304                 return error("Cannot do a bind merge of %d trees",
2305                              o->merge_size);
2306         if (a && old)
2307                 return o->gently ? -1 :
2308                         error(ERRORMSG(o, ERROR_BIND_OVERLAP),
2309                               super_prefixed(a->name),
2310                               super_prefixed(old->name));
2311         if (!a)
2312                 return keep_entry(old, o);
2313         else
2314                 return merged_entry(a, NULL, o);
2315 }
2316
2317 /*
2318  * One-way merge.
2319  *
2320  * The rule is:
2321  * - take the stat information from stage0, take the data from stage1
2322  */
2323 int oneway_merge(const struct cache_entry * const *src,
2324                  struct unpack_trees_options *o)
2325 {
2326         const struct cache_entry *old = src[0];
2327         const struct cache_entry *a = src[1];
2328
2329         if (o->merge_size != 1)
2330                 return error("Cannot do a oneway merge of %d trees",
2331                              o->merge_size);
2332
2333         if (!a || a == o->df_conflict_entry)
2334                 return deleted_entry(old, old, o);
2335
2336         if (old && same(old, a)) {
2337                 int update = 0;
2338                 if (o->reset && o->update && !ce_uptodate(old) && !ce_skip_worktree(old)) {
2339                         struct stat st;
2340                         if (lstat(old->name, &st) ||
2341                             ie_match_stat(o->src_index, old, &st, CE_MATCH_IGNORE_VALID|CE_MATCH_IGNORE_SKIP_WORKTREE))
2342                                 update |= CE_UPDATE;
2343                 }
2344                 if (o->update && S_ISGITLINK(old->ce_mode) &&
2345                     should_update_submodules() && !verify_uptodate(old, o))
2346                         update |= CE_UPDATE;
2347                 add_entry(o, old, update, 0);
2348                 return 0;
2349         }
2350         return merged_entry(a, old, o);
2351 }