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