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