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