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