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