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