3 #include "repository.h"
8 #include "cache-tree.h"
9 #include "unpack-trees.h"
13 #include "split-index.h"
14 #include "sparse-index.h"
15 #include "submodule.h"
16 #include "submodule-config.h"
17 #include "fsmonitor.h"
18 #include "object-store.h"
19 #include "promisor-remote.h"
21 #include "parallel-checkout.h"
24 * Error messages expected by scripts out of plumbing commands such as
25 * read-tree. Non-scripted Porcelain is not required to use these messages
26 * and in fact are encouraged to reword them to better suit their particular
27 * situation better. See how "git checkout" and "git merge" replaces
28 * them using setup_unpack_trees_porcelain(), for example.
30 static const char *unpack_plumbing_errors
[NB_UNPACK_TREES_WARNING_TYPES
] = {
31 /* ERROR_WOULD_OVERWRITE */
32 "Entry '%s' would be overwritten by merge. Cannot merge.",
34 /* ERROR_NOT_UPTODATE_FILE */
35 "Entry '%s' not uptodate. Cannot merge.",
37 /* ERROR_NOT_UPTODATE_DIR */
38 "Updating '%s' would lose untracked files in it",
40 /* ERROR_CWD_IN_THE_WAY */
41 "Refusing to remove '%s' since it is the current working directory.",
43 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
44 "Untracked working tree file '%s' would be overwritten by merge.",
46 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
47 "Untracked working tree file '%s' would be removed by merge.",
49 /* ERROR_BIND_OVERLAP */
50 "Entry '%s' overlaps with '%s'. Cannot bind.",
52 /* ERROR_WOULD_LOSE_SUBMODULE */
53 "Submodule '%s' cannot checkout new HEAD.",
55 /* NB_UNPACK_TREES_ERROR_TYPES; just a meta value */
58 /* WARNING_SPARSE_NOT_UPTODATE_FILE */
59 "Path '%s' not uptodate; will not remove from working tree.",
61 /* WARNING_SPARSE_UNMERGED_FILE */
62 "Path '%s' unmerged; will not remove from working tree.",
64 /* WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN */
65 "Path '%s' already present; will not overwrite with sparse update.",
68 #define ERRORMSG(o,type) \
69 ( ((o) && (o)->msgs[(type)]) \
70 ? ((o)->msgs[(type)]) \
71 : (unpack_plumbing_errors[(type)]) )
73 static const char *super_prefixed(const char *path
, const char *super_prefix
)
76 * It is necessary and sufficient to have two static buffers
77 * here, as the return value of this function is fed to
78 * error() using the unpack_*_errors[] templates we see above.
80 static struct strbuf buf
[2] = {STRBUF_INIT
, STRBUF_INIT
};
81 static int super_prefix_len
= -1;
82 static unsigned idx
= ARRAY_SIZE(buf
) - 1;
84 if (super_prefix_len
< 0) {
89 for (i
= 0; i
< ARRAY_SIZE(buf
); i
++)
90 strbuf_addstr(&buf
[i
], super_prefix
);
91 super_prefix_len
= buf
[0].len
;
95 if (!super_prefix_len
)
98 if (++idx
>= ARRAY_SIZE(buf
))
101 strbuf_setlen(&buf
[idx
], super_prefix_len
);
102 strbuf_addstr(&buf
[idx
], path
);
107 void setup_unpack_trees_porcelain(struct unpack_trees_options
*opts
,
111 const char **msgs
= opts
->msgs
;
114 strvec_init(&opts
->msgs_to_free
);
116 if (!strcmp(cmd
, "checkout"))
117 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
118 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
119 "Please commit your changes or stash them before you switch branches.")
120 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
121 else if (!strcmp(cmd
, "merge"))
122 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
123 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
124 "Please commit your changes or stash them before you merge.")
125 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
127 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
128 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
129 "Please commit your changes or stash them before you %s.")
130 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
131 msgs
[ERROR_WOULD_OVERWRITE
] = msgs
[ERROR_NOT_UPTODATE_FILE
] =
132 strvec_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
134 msgs
[ERROR_NOT_UPTODATE_DIR
] =
135 _("Updating the following directories would lose untracked files in them:\n%s");
137 msgs
[ERROR_CWD_IN_THE_WAY
] =
138 _("Refusing to remove the current working directory:\n%s");
140 if (!strcmp(cmd
, "checkout"))
141 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
142 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
143 "Please move or remove them before you switch branches.")
144 : _("The following untracked working tree files would be removed by checkout:\n%%s");
145 else if (!strcmp(cmd
, "merge"))
146 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
147 ? _("The following untracked working tree files would be removed by merge:\n%%s"
148 "Please move or remove them before you merge.")
149 : _("The following untracked working tree files would be removed by merge:\n%%s");
151 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
152 ? _("The following untracked working tree files would be removed by %s:\n%%s"
153 "Please move or remove them before you %s.")
154 : _("The following untracked working tree files would be removed by %s:\n%%s");
155 msgs
[ERROR_WOULD_LOSE_UNTRACKED_REMOVED
] =
156 strvec_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
158 if (!strcmp(cmd
, "checkout"))
159 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
160 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
161 "Please move or remove them before you switch branches.")
162 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
163 else if (!strcmp(cmd
, "merge"))
164 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
165 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
166 "Please move or remove them before you merge.")
167 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
169 msg
= advice_enabled(ADVICE_COMMIT_BEFORE_MERGE
)
170 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
171 "Please move or remove them before you %s.")
172 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
173 msgs
[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
] =
174 strvec_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
177 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
178 * cannot easily display it as a list.
180 msgs
[ERROR_BIND_OVERLAP
] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
182 msgs
[ERROR_WOULD_LOSE_SUBMODULE
] =
183 _("Cannot update submodule:\n%s");
185 msgs
[WARNING_SPARSE_NOT_UPTODATE_FILE
] =
186 _("The following paths are not up to date and were left despite sparse patterns:\n%s");
187 msgs
[WARNING_SPARSE_UNMERGED_FILE
] =
188 _("The following paths are unmerged and were left despite sparse patterns:\n%s");
189 msgs
[WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN
] =
190 _("The following paths were already present and thus not updated despite sparse patterns:\n%s");
192 opts
->show_all_errors
= 1;
193 /* rejected paths may not have a static buffer */
194 for (i
= 0; i
< ARRAY_SIZE(opts
->unpack_rejects
); i
++)
195 opts
->unpack_rejects
[i
].strdup_strings
= 1;
198 void clear_unpack_trees_porcelain(struct unpack_trees_options
*opts
)
200 strvec_clear(&opts
->msgs_to_free
);
201 memset(opts
->msgs
, 0, sizeof(opts
->msgs
));
204 static int do_add_entry(struct unpack_trees_options
*o
, struct cache_entry
*ce
,
205 unsigned int set
, unsigned int clear
)
212 ce
->ce_flags
= (ce
->ce_flags
& ~clear
) | set
;
213 return add_index_entry(&o
->result
, ce
,
214 ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
217 static void add_entry(struct unpack_trees_options
*o
,
218 const struct cache_entry
*ce
,
219 unsigned int set
, unsigned int clear
)
221 do_add_entry(o
, dup_cache_entry(ce
, &o
->result
), set
, clear
);
225 * add error messages on path <path>
226 * corresponding to the type <e> with the message <msg>
227 * indicating if it should be display in porcelain or not
229 static int add_rejected_path(struct unpack_trees_options
*o
,
230 enum unpack_trees_error_types e
,
236 if (!o
->show_all_errors
)
237 return error(ERRORMSG(o
, e
), super_prefixed(path
,
241 * Otherwise, insert in a list for future display by
242 * display_(error|warning)_msgs()
244 string_list_append(&o
->unpack_rejects
[e
], path
);
249 * display all the error messages stored in a nice way
251 static void display_error_msgs(struct unpack_trees_options
*o
)
254 unsigned error_displayed
= 0;
255 for (e
= 0; e
< NB_UNPACK_TREES_ERROR_TYPES
; e
++) {
256 struct string_list
*rejects
= &o
->unpack_rejects
[e
];
258 if (rejects
->nr
> 0) {
260 struct strbuf path
= STRBUF_INIT
;
263 for (i
= 0; i
< rejects
->nr
; i
++)
264 strbuf_addf(&path
, "\t%s\n", rejects
->items
[i
].string
);
265 error(ERRORMSG(o
, e
), super_prefixed(path
.buf
,
267 strbuf_release(&path
);
269 string_list_clear(rejects
, 0);
272 fprintf(stderr
, _("Aborting\n"));
276 * display all the warning messages stored in a nice way
278 static void display_warning_msgs(struct unpack_trees_options
*o
)
281 unsigned warning_displayed
= 0;
282 for (e
= NB_UNPACK_TREES_ERROR_TYPES
+ 1;
283 e
< NB_UNPACK_TREES_WARNING_TYPES
; e
++) {
284 struct string_list
*rejects
= &o
->unpack_rejects
[e
];
286 if (rejects
->nr
> 0) {
288 struct strbuf path
= STRBUF_INIT
;
290 warning_displayed
= 1;
291 for (i
= 0; i
< rejects
->nr
; i
++)
292 strbuf_addf(&path
, "\t%s\n", rejects
->items
[i
].string
);
293 warning(ERRORMSG(o
, e
), super_prefixed(path
.buf
,
295 strbuf_release(&path
);
297 string_list_clear(rejects
, 0);
299 if (warning_displayed
)
300 fprintf(stderr
, _("After fixing the above paths, you may want to run `git sparse-checkout reapply`.\n"));
302 static int check_submodule_move_head(const struct cache_entry
*ce
,
305 struct unpack_trees_options
*o
)
307 unsigned flags
= SUBMODULE_MOVE_HEAD_DRY_RUN
;
308 const struct submodule
*sub
= submodule_from_ce(ce
);
314 flags
|= SUBMODULE_MOVE_HEAD_FORCE
;
316 if (submodule_move_head(ce
->name
, o
->super_prefix
, old_id
, new_id
,
318 return add_rejected_path(o
, ERROR_WOULD_LOSE_SUBMODULE
, ce
->name
);
323 * Perform the loading of the repository's gitmodules file. This function is
324 * used by 'check_update()' to perform loading of the gitmodules file in two
325 * different situations:
326 * (1) before removing entries from the working tree if the gitmodules file has
327 * been marked for removal. This situation is specified by 'state' == NULL.
328 * (2) before checking out entries to the working tree if the gitmodules file
329 * has been marked for update. This situation is specified by 'state' != NULL.
331 static void load_gitmodules_file(struct index_state
*index
,
332 struct checkout
*state
)
334 int pos
= index_name_pos(index
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
337 struct cache_entry
*ce
= index
->cache
[pos
];
338 if (!state
&& ce
->ce_flags
& CE_WT_REMOVE
) {
339 repo_read_gitmodules(the_repository
, 0);
340 } else if (state
&& (ce
->ce_flags
& CE_UPDATE
)) {
341 submodule_free(the_repository
);
342 checkout_entry(ce
, state
, NULL
, NULL
);
343 repo_read_gitmodules(the_repository
, 0);
348 static struct progress
*get_progress(struct unpack_trees_options
*o
,
349 struct index_state
*index
)
351 unsigned cnt
= 0, total
= 0;
353 if (!o
->update
|| !o
->verbose_update
)
356 for (; cnt
< index
->cache_nr
; cnt
++) {
357 const struct cache_entry
*ce
= index
->cache
[cnt
];
358 if (ce
->ce_flags
& (CE_UPDATE
| CE_WT_REMOVE
))
362 return start_delayed_progress(_("Updating files"), total
);
365 static void setup_collided_checkout_detection(struct checkout
*state
,
366 struct index_state
*index
)
371 for (i
= 0; i
< index
->cache_nr
; i
++)
372 index
->cache
[i
]->ce_flags
&= ~CE_MATCHED
;
375 static void report_collided_checkout(struct index_state
*index
)
377 struct string_list list
= STRING_LIST_INIT_NODUP
;
380 for (i
= 0; i
< index
->cache_nr
; i
++) {
381 struct cache_entry
*ce
= index
->cache
[i
];
383 if (!(ce
->ce_flags
& CE_MATCHED
))
386 string_list_append(&list
, ce
->name
);
387 ce
->ce_flags
&= ~CE_MATCHED
;
390 list
.cmp
= fspathcmp
;
391 string_list_sort(&list
);
394 warning(_("the following paths have collided (e.g. case-sensitive paths\n"
395 "on a case-insensitive filesystem) and only one from the same\n"
396 "colliding group is in the working tree:\n"));
398 for (i
= 0; i
< list
.nr
; i
++)
399 fprintf(stderr
, " '%s'\n", list
.items
[i
].string
);
402 string_list_clear(&list
, 0);
405 static int must_checkout(const struct cache_entry
*ce
)
407 return ce
->ce_flags
& CE_UPDATE
;
410 static int check_updates(struct unpack_trees_options
*o
,
411 struct index_state
*index
)
415 struct progress
*progress
;
416 struct checkout state
= CHECKOUT_INIT
;
417 int i
, pc_workers
, pc_threshold
;
419 trace_performance_enter();
420 state
.super_prefix
= o
->super_prefix
;
423 state
.refresh_cache
= 1;
424 state
.istate
= index
;
425 clone_checkout_metadata(&state
.meta
, &o
->meta
, NULL
);
427 if (!o
->update
|| o
->dry_run
) {
428 remove_marked_cache_entries(index
, 0);
429 trace_performance_leave("check_updates");
434 setup_collided_checkout_detection(&state
, index
);
436 progress
= get_progress(o
, index
);
438 /* Start with clean cache to avoid using any possibly outdated info. */
439 invalidate_lstat_cache();
441 git_attr_set_direction(GIT_ATTR_CHECKOUT
);
443 if (should_update_submodules())
444 load_gitmodules_file(index
, NULL
);
446 for (i
= 0; i
< index
->cache_nr
; i
++) {
447 const struct cache_entry
*ce
= index
->cache
[i
];
449 if (ce
->ce_flags
& CE_WT_REMOVE
) {
450 display_progress(progress
, ++cnt
);
451 unlink_entry(ce
, o
->super_prefix
);
455 remove_marked_cache_entries(index
, 0);
456 remove_scheduled_dirs();
458 if (should_update_submodules())
459 load_gitmodules_file(index
, &state
);
461 if (has_promisor_remote())
463 * Prefetch the objects that are to be checked out in the loop
466 prefetch_cache_entries(index
, must_checkout
);
468 get_parallel_checkout_configs(&pc_workers
, &pc_threshold
);
470 enable_delayed_checkout(&state
);
472 init_parallel_checkout();
473 for (i
= 0; i
< index
->cache_nr
; i
++) {
474 struct cache_entry
*ce
= index
->cache
[i
];
476 if (must_checkout(ce
)) {
477 size_t last_pc_queue_size
= pc_queue_size();
479 if (ce
->ce_flags
& CE_WT_REMOVE
)
480 BUG("both update and delete flags are set on %s",
482 ce
->ce_flags
&= ~CE_UPDATE
;
483 errs
|= checkout_entry(ce
, &state
, NULL
, NULL
);
485 if (last_pc_queue_size
== pc_queue_size())
486 display_progress(progress
, ++cnt
);
490 errs
|= run_parallel_checkout(&state
, pc_workers
, pc_threshold
,
492 stop_progress(&progress
);
493 errs
|= finish_delayed_checkout(&state
, o
->verbose_update
);
494 git_attr_set_direction(GIT_ATTR_CHECKIN
);
497 report_collided_checkout(index
);
499 trace_performance_leave("check_updates");
503 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
504 struct unpack_trees_options
*o
);
505 static int verify_absent_sparse(const struct cache_entry
*ce
,
506 enum unpack_trees_error_types
,
507 struct unpack_trees_options
*o
);
509 static int apply_sparse_checkout(struct index_state
*istate
,
510 struct cache_entry
*ce
,
511 struct unpack_trees_options
*o
)
513 int was_skip_worktree
= ce_skip_worktree(ce
);
515 if (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
)
516 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
518 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
519 if (was_skip_worktree
!= ce_skip_worktree(ce
)) {
520 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
521 mark_fsmonitor_invalid(istate
, ce
);
522 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
526 * if (!was_skip_worktree && !ce_skip_worktree()) {
527 * This is perfectly normal. Move on;
532 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
533 * area as a result of ce_skip_worktree() shortcuts in
534 * verify_absent() and verify_uptodate().
535 * Make sure they don't modify worktree if they are already
536 * outside checkout area
538 if (was_skip_worktree
&& ce_skip_worktree(ce
)) {
539 ce
->ce_flags
&= ~CE_UPDATE
;
542 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
543 * on to get that file removed from both index and worktree.
544 * If that file is already outside worktree area, don't
547 if (ce
->ce_flags
& CE_REMOVE
)
548 ce
->ce_flags
&= ~CE_WT_REMOVE
;
551 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
553 * If CE_UPDATE is set, verify_uptodate() must be called already
554 * also stat info may have lost after merged_entry() so calling
555 * verify_uptodate() again may fail
557 if (!(ce
->ce_flags
& CE_UPDATE
) &&
558 verify_uptodate_sparse(ce
, o
)) {
559 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
562 ce
->ce_flags
|= CE_WT_REMOVE
;
563 ce
->ce_flags
&= ~CE_UPDATE
;
565 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
566 if (verify_absent_sparse(ce
, WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN
, o
))
568 ce
->ce_flags
|= CE_UPDATE
;
573 static int warn_conflicted_path(struct index_state
*istate
,
575 struct unpack_trees_options
*o
)
577 char *conflicting_path
= istate
->cache
[i
]->name
;
580 add_rejected_path(o
, WARNING_SPARSE_UNMERGED_FILE
, conflicting_path
);
582 /* Find out how many higher stage entries are at same path */
583 while ((++count
) + i
< istate
->cache_nr
&&
584 !strcmp(conflicting_path
, istate
->cache
[count
+ i
]->name
))
590 static inline int call_unpack_fn(const struct cache_entry
* const *src
,
591 struct unpack_trees_options
*o
)
593 int ret
= o
->fn(src
, o
);
599 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
601 ce
->ce_flags
|= CE_UNPACKED
;
603 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
604 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
605 int bottom
= o
->cache_bottom
;
606 while (bottom
< o
->src_index
->cache_nr
&&
607 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
609 o
->cache_bottom
= bottom
;
613 static void mark_all_ce_unused(struct index_state
*index
)
616 for (i
= 0; i
< index
->cache_nr
; i
++)
617 index
->cache
[i
]->ce_flags
&= ~(CE_UNPACKED
| CE_ADDED
| CE_NEW_SKIP_WORKTREE
);
620 static int locate_in_src_index(const struct cache_entry
*ce
,
621 struct unpack_trees_options
*o
)
623 struct index_state
*index
= o
->src_index
;
624 int len
= ce_namelen(ce
);
625 int pos
= index_name_pos(index
, ce
->name
, len
);
632 * We call unpack_index_entry() with an unmerged cache entry
633 * only in diff-index, and it wants a single callback. Skip
634 * the other unmerged entry with the same name.
636 static void mark_ce_used_same_name(struct cache_entry
*ce
,
637 struct unpack_trees_options
*o
)
639 struct index_state
*index
= o
->src_index
;
640 int len
= ce_namelen(ce
);
643 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
644 struct cache_entry
*next
= index
->cache
[pos
];
645 if (len
!= ce_namelen(next
) ||
646 memcmp(ce
->name
, next
->name
, len
))
648 mark_ce_used(next
, o
);
652 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
654 const struct index_state
*index
= o
->src_index
;
655 int pos
= o
->cache_bottom
;
657 while (pos
< index
->cache_nr
) {
658 struct cache_entry
*ce
= index
->cache
[pos
];
659 if (!(ce
->ce_flags
& CE_UNPACKED
))
666 static void add_same_unmerged(const struct cache_entry
*ce
,
667 struct unpack_trees_options
*o
)
669 struct index_state
*index
= o
->src_index
;
670 int len
= ce_namelen(ce
);
671 int pos
= index_name_pos(index
, ce
->name
, len
);
674 die("programming error in a caller of mark_ce_used_same_name");
675 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
676 struct cache_entry
*next
= index
->cache
[pos
];
677 if (len
!= ce_namelen(next
) ||
678 memcmp(ce
->name
, next
->name
, len
))
680 add_entry(o
, next
, 0, 0);
681 mark_ce_used(next
, o
);
685 static int unpack_index_entry(struct cache_entry
*ce
,
686 struct unpack_trees_options
*o
)
688 const struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
695 if (o
->skip_unmerged
) {
696 add_entry(o
, ce
, 0, 0);
700 ret
= call_unpack_fn(src
, o
);
702 mark_ce_used_same_name(ce
, o
);
706 static int find_cache_pos(struct traverse_info
*, const char *p
, size_t len
);
708 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
710 struct unpack_trees_options
*o
= info
->data
;
712 if (o
->diff_index_cached
)
714 o
->cache_bottom
= bottom
;
717 static int switch_cache_bottom(struct traverse_info
*info
)
719 struct unpack_trees_options
*o
= info
->data
;
722 if (o
->diff_index_cached
)
724 ret
= o
->cache_bottom
;
725 pos
= find_cache_pos(info
->prev
, info
->name
, info
->namelen
);
728 o
->cache_bottom
= -2 - pos
;
730 o
->cache_bottom
= o
->src_index
->cache_nr
;
734 static inline int are_same_oid(struct name_entry
*name_j
, struct name_entry
*name_k
)
736 return !is_null_oid(&name_j
->oid
) && !is_null_oid(&name_k
->oid
) && oideq(&name_j
->oid
, &name_k
->oid
);
739 static int all_trees_same_as_cache_tree(int n
, unsigned long dirmask
,
740 struct name_entry
*names
,
741 struct traverse_info
*info
)
743 struct unpack_trees_options
*o
= info
->data
;
746 if (!o
->merge
|| dirmask
!= ((1 << n
) - 1))
749 for (i
= 1; i
< n
; i
++)
750 if (!are_same_oid(names
, names
+ i
))
753 return cache_tree_matches_traversal(o
->src_index
->cache_tree
, names
, info
);
756 static int index_pos_by_traverse_info(struct name_entry
*names
,
757 struct traverse_info
*info
)
759 struct unpack_trees_options
*o
= info
->data
;
760 struct strbuf name
= STRBUF_INIT
;
763 strbuf_make_traverse_path(&name
, info
, names
->path
, names
->pathlen
);
764 strbuf_addch(&name
, '/');
765 pos
= index_name_pos(o
->src_index
, name
.buf
, name
.len
);
767 if (!o
->src_index
->sparse_index
||
768 !(o
->src_index
->cache
[pos
]->ce_flags
& CE_SKIP_WORKTREE
))
769 BUG("This is a directory and should not exist in index");
773 if (pos
>= o
->src_index
->cache_nr
||
774 !starts_with(o
->src_index
->cache
[pos
]->name
, name
.buf
) ||
775 (pos
> 0 && starts_with(o
->src_index
->cache
[pos
-1]->name
, name
.buf
)))
776 BUG("pos %d doesn't point to the first entry of %s in index",
778 strbuf_release(&name
);
783 * Fast path if we detect that all trees are the same as cache-tree at this
784 * path. We'll walk these trees in an iterative loop using cache-tree/index
785 * instead of ODB since we already know what these trees contain.
787 static int traverse_by_cache_tree(int pos
, int nr_entries
, int nr_names
,
788 struct traverse_info
*info
)
790 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
791 struct unpack_trees_options
*o
= info
->data
;
792 struct cache_entry
*tree_ce
= NULL
;
797 BUG("We need cache-tree to do this optimization");
800 * Do what unpack_callback() and unpack_single_entry() normally
801 * do. But we walk all paths in an iterative loop instead.
803 * D/F conflicts and higher stage entries are not a concern
804 * because cache-tree would be invalidated and we would never
805 * get here in the first place.
807 for (i
= 0; i
< nr_entries
; i
++) {
808 int new_ce_len
, len
, rc
;
810 src
[0] = o
->src_index
->cache
[pos
+ i
];
812 len
= ce_namelen(src
[0]);
813 new_ce_len
= cache_entry_size(len
);
815 if (new_ce_len
> ce_len
) {
817 tree_ce
= xrealloc(tree_ce
, new_ce_len
);
818 memset(tree_ce
, 0, new_ce_len
);
821 tree_ce
->ce_flags
= create_ce_flags(0);
823 for (d
= 1; d
<= nr_names
; d
++)
827 tree_ce
->ce_mode
= src
[0]->ce_mode
;
828 tree_ce
->ce_namelen
= len
;
829 oidcpy(&tree_ce
->oid
, &src
[0]->oid
);
830 memcpy(tree_ce
->name
, src
[0]->name
, len
+ 1);
832 rc
= call_unpack_fn((const struct cache_entry
* const *)src
, o
);
838 mark_ce_used(src
[0], o
);
842 printf("Unpacked %d entries from %s to %s using cache-tree\n",
844 o
->src_index
->cache
[pos
]->name
,
845 o
->src_index
->cache
[pos
+ nr_entries
- 1]->name
);
849 static int traverse_trees_recursive(int n
, unsigned long dirmask
,
850 unsigned long df_conflicts
,
851 struct name_entry
*names
,
852 struct traverse_info
*info
)
854 struct unpack_trees_options
*o
= info
->data
;
857 struct tree_desc t
[MAX_UNPACK_TREES
];
858 void *buf
[MAX_UNPACK_TREES
];
859 struct traverse_info newinfo
;
860 struct name_entry
*p
;
863 nr_entries
= all_trees_same_as_cache_tree(n
, dirmask
, names
, info
);
864 if (nr_entries
> 0) {
865 int pos
= index_pos_by_traverse_info(names
, info
);
867 if (!o
->merge
|| df_conflicts
)
868 BUG("Wrong condition to get here buddy");
871 * All entries up to 'pos' must have been processed
872 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
873 * save and restore cache_bottom anyway to not miss
874 * unprocessed entries before 'pos'.
876 bottom
= o
->cache_bottom
;
877 ret
= traverse_by_cache_tree(pos
, nr_entries
, n
, info
);
878 o
->cache_bottom
= bottom
;
888 newinfo
.pathspec
= info
->pathspec
;
889 newinfo
.name
= p
->path
;
890 newinfo
.namelen
= p
->pathlen
;
891 newinfo
.mode
= p
->mode
;
892 newinfo
.pathlen
= st_add3(newinfo
.pathlen
, tree_entry_len(p
), 1);
893 newinfo
.df_conflicts
|= df_conflicts
;
896 * Fetch the tree from the ODB for each peer directory in the
899 * For 2- and 3-way traversals, we try to avoid hitting the
900 * ODB twice for the same OID. This should yield a nice speed
901 * up in checkouts and merges when the commits are similar.
903 * We don't bother doing the full O(n^2) search for larger n,
904 * because wider traversals don't happen that often and we
905 * avoid the search setup.
907 * When 2 peer OIDs are the same, we just copy the tree
908 * descriptor data. This implicitly borrows the buffer
909 * data from the earlier cell.
911 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
912 if (i
> 0 && are_same_oid(&names
[i
], &names
[i
- 1]))
914 else if (i
> 1 && are_same_oid(&names
[i
], &names
[i
- 2]))
917 const struct object_id
*oid
= NULL
;
920 buf
[nr_buf
++] = fill_tree_descriptor(the_repository
, t
+ i
, oid
);
924 bottom
= switch_cache_bottom(&newinfo
);
925 ret
= traverse_trees(o
->src_index
, n
, t
, &newinfo
);
926 restore_cache_bottom(&newinfo
, bottom
);
928 for (i
= 0; i
< nr_buf
; i
++)
935 * Compare the traverse-path to the cache entry without actually
936 * having to generate the textual representation of the traverse
939 * NOTE! This *only* compares up to the size of the traverse path
940 * itself - the caller needs to do the final check for the cache
941 * entry having more data at the end!
943 static int do_compare_entry_piecewise(const struct cache_entry
*ce
,
944 const struct traverse_info
*info
,
945 const char *name
, size_t namelen
,
952 int cmp
= do_compare_entry_piecewise(ce
, info
->prev
,
953 info
->name
, info
->namelen
,
958 pathlen
= info
->pathlen
;
959 ce_len
= ce_namelen(ce
);
961 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
962 if (ce_len
< pathlen
)
966 ce_name
= ce
->name
+ pathlen
;
968 return df_name_compare(ce_name
, ce_len
, S_IFREG
, name
, namelen
, mode
);
971 static int do_compare_entry(const struct cache_entry
*ce
,
972 const struct traverse_info
*info
,
973 const char *name
, size_t namelen
,
982 * If we have not precomputed the traverse path, it is quicker
983 * to avoid doing so. But if we have precomputed it,
984 * it is quicker to use the precomputed version.
986 if (!info
->traverse_path
)
987 return do_compare_entry_piecewise(ce
, info
, name
, namelen
, mode
);
989 cmp
= strncmp(ce
->name
, info
->traverse_path
, info
->pathlen
);
993 pathlen
= info
->pathlen
;
994 ce_len
= ce_namelen(ce
);
996 if (ce_len
< pathlen
)
1000 ce_name
= ce
->name
+ pathlen
;
1002 ce_mode
= S_ISSPARSEDIR(ce
->ce_mode
) ? S_IFDIR
: S_IFREG
;
1003 return df_name_compare(ce_name
, ce_len
, ce_mode
, name
, namelen
, mode
);
1006 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
1008 int cmp
= do_compare_entry(ce
, info
, n
->path
, n
->pathlen
, n
->mode
);
1013 * At this point, we know that we have a prefix match. If ce
1014 * is a sparse directory, then allow an exact match. This only
1015 * works when the input name is a directory, since ce->name
1016 * ends in a directory separator.
1018 if (S_ISSPARSEDIR(ce
->ce_mode
) &&
1019 ce
->ce_namelen
== traverse_path_len(info
, tree_entry_len(n
)) + 1)
1023 * Even if the beginning compared identically, the ce should
1024 * compare as bigger than a directory leading up to it!
1026 return ce_namelen(ce
) > traverse_path_len(info
, tree_entry_len(n
));
1029 static int ce_in_traverse_path(const struct cache_entry
*ce
,
1030 const struct traverse_info
*info
)
1034 if (do_compare_entry(ce
, info
->prev
,
1035 info
->name
, info
->namelen
, info
->mode
))
1038 * If ce (blob) is the same name as the path (which is a tree
1039 * we will be descending into), it won't be inside it.
1041 return (info
->pathlen
< ce_namelen(ce
));
1044 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
,
1045 const struct name_entry
*n
,
1047 struct index_state
*istate
,
1049 int is_sparse_directory
)
1051 size_t len
= traverse_path_len(info
, tree_entry_len(n
));
1052 size_t alloc_len
= is_sparse_directory
? len
+ 1 : len
;
1053 struct cache_entry
*ce
=
1055 make_empty_transient_cache_entry(alloc_len
, NULL
) :
1056 make_empty_cache_entry(istate
, alloc_len
);
1058 ce
->ce_mode
= create_ce_mode(n
->mode
);
1059 ce
->ce_flags
= create_ce_flags(stage
);
1060 ce
->ce_namelen
= len
;
1061 oidcpy(&ce
->oid
, &n
->oid
);
1062 /* len+1 because the cache_entry allocates space for NUL */
1063 make_traverse_path(ce
->name
, len
+ 1, info
, n
->path
, n
->pathlen
);
1065 if (is_sparse_directory
) {
1066 ce
->name
[len
] = '/';
1067 ce
->name
[len
+ 1] = '\0';
1069 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
1076 * Determine whether the path specified by 'p' should be unpacked as a new
1077 * sparse directory in a sparse index. A new sparse directory 'A/':
1078 * - must be outside the sparse cone.
1079 * - must not already be in the index (i.e., no index entry with name 'A/'
1081 * - must not have any child entries in the index (i.e., no index entry
1082 * 'A/<something>' exists).
1083 * If 'p' meets the above requirements, return 1; otherwise, return 0.
1085 static int entry_is_new_sparse_dir(const struct traverse_info
*info
,
1086 const struct name_entry
*p
)
1089 struct strbuf dirpath
= STRBUF_INIT
;
1090 struct unpack_trees_options
*o
= info
->data
;
1092 if (!S_ISDIR(p
->mode
))
1096 * If the path is inside the sparse cone, it can't be a sparse directory.
1098 strbuf_add(&dirpath
, info
->traverse_path
, info
->pathlen
);
1099 strbuf_add(&dirpath
, p
->path
, p
->pathlen
);
1100 strbuf_addch(&dirpath
, '/');
1101 if (path_in_cone_mode_sparse_checkout(dirpath
.buf
, o
->src_index
)) {
1106 pos
= index_name_pos_sparse(o
->src_index
, dirpath
.buf
, dirpath
.len
);
1108 /* Path is already in the index, not a new sparse dir */
1113 /* Where would this sparse dir be inserted into the index? */
1115 if (pos
>= o
->src_index
->cache_nr
) {
1117 * Sparse dir would be inserted at the end of the index, so we
1118 * know it has no child entries.
1125 * If the dir has child entries in the index, the first would be at the
1126 * position the sparse directory would be inserted. If the entry at this
1127 * position is inside the dir, not a new sparse dir.
1129 res
= strncmp(o
->src_index
->cache
[pos
]->name
, dirpath
.buf
, dirpath
.len
);
1132 strbuf_release(&dirpath
);
1137 * Note that traverse_by_cache_tree() duplicates some logic in this function
1138 * without actually calling it. If you change the logic here you may need to
1139 * check and change there as well.
1141 static int unpack_single_entry(int n
, unsigned long mask
,
1142 unsigned long dirmask
,
1143 struct cache_entry
**src
,
1144 const struct name_entry
*names
,
1145 const struct traverse_info
*info
,
1146 int *is_new_sparse_dir
)
1149 struct unpack_trees_options
*o
= info
->data
;
1150 unsigned long conflicts
= info
->df_conflicts
| dirmask
;
1151 const struct name_entry
*p
= names
;
1153 *is_new_sparse_dir
= 0;
1154 if (mask
== dirmask
&& !src
[0]) {
1156 * If we're not in a sparse index, we can't unpack a directory
1157 * without recursing into it, so we return.
1159 if (!o
->src_index
->sparse_index
)
1162 /* Find first entry with a real name (we could use "mask" too) */
1167 * If the directory is completely missing from the index but
1168 * would otherwise be a sparse directory, we should unpack it.
1169 * If not, we'll return and continue recursively traversing the
1172 *is_new_sparse_dir
= entry_is_new_sparse_dir(info
, p
);
1173 if (!*is_new_sparse_dir
)
1178 * When we are unpacking a sparse directory, then this isn't necessarily
1179 * a directory-file conflict.
1181 if (mask
== dirmask
&&
1182 (*is_new_sparse_dir
|| (src
[0] && S_ISSPARSEDIR(src
[0]->ce_mode
))))
1186 * Ok, we've filled in up to any potential index entry in src[0],
1189 for (i
= 0; i
< n
; i
++) {
1191 unsigned int bit
= 1ul << i
;
1192 if (conflicts
& bit
) {
1193 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
1200 else if (i
+ 1 < o
->head_idx
)
1202 else if (i
+ 1 > o
->head_idx
)
1208 * If the merge bit is set, then the cache entries are
1209 * discarded in the following block. In this case,
1210 * construct "transient" cache_entries, as they are
1211 * not stored in the index. otherwise construct the
1212 * cache entry from the index aware logic.
1214 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
,
1215 &o
->result
, o
->merge
,
1220 int rc
= call_unpack_fn((const struct cache_entry
* const *)src
,
1222 for (i
= 0; i
< n
; i
++) {
1223 struct cache_entry
*ce
= src
[i
+ o
->merge
];
1224 if (ce
!= o
->df_conflict_entry
)
1225 discard_cache_entry(ce
);
1230 for (i
= 0; i
< n
; i
++)
1231 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
1232 if (do_add_entry(o
, src
[i
], 0, 0))
1238 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
1240 discard_index(&o
->result
);
1241 if (!o
->quiet
&& !o
->exiting_early
) {
1243 return error("%s", message
);
1250 * The tree traversal is looking at name p. If we have a matching entry,
1251 * return it. If name p is a directory in the index, do not return
1252 * anything, as we will want to match it when the traversal descends into
1255 static int find_cache_pos(struct traverse_info
*info
,
1256 const char *p
, size_t p_len
)
1259 struct unpack_trees_options
*o
= info
->data
;
1260 struct index_state
*index
= o
->src_index
;
1261 int pfxlen
= info
->pathlen
;
1263 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
1264 const struct cache_entry
*ce
= index
->cache
[pos
];
1265 const char *ce_name
, *ce_slash
;
1268 if (ce
->ce_flags
& CE_UNPACKED
) {
1270 * cache_bottom entry is already unpacked, so
1271 * we can never match it; don't check it
1274 if (pos
== o
->cache_bottom
)
1278 if (!ce_in_traverse_path(ce
, info
)) {
1280 * Check if we can skip future cache checks
1281 * (because we're already past all possible
1282 * entries in the traverse path).
1284 if (info
->traverse_path
) {
1285 if (strncmp(ce
->name
, info
->traverse_path
,
1291 ce_name
= ce
->name
+ pfxlen
;
1292 ce_slash
= strchr(ce_name
, '/');
1294 ce_len
= ce_slash
- ce_name
;
1296 ce_len
= ce_namelen(ce
) - pfxlen
;
1297 cmp
= name_compare(p
, p_len
, ce_name
, ce_len
);
1299 * Exact match; if we have a directory we need to
1300 * delay returning it.
1303 return ce_slash
? -2 - pos
: pos
;
1305 continue; /* keep looking */
1307 * ce_name sorts after p->path; could it be that we
1308 * have files under p->path directory in the index?
1309 * E.g. ce_name == "t-i", and p->path == "t"; we may
1310 * have "t/a" in the index.
1312 if (p_len
< ce_len
&& !memcmp(ce_name
, p
, p_len
) &&
1313 ce_name
[p_len
] < '/')
1314 continue; /* keep looking */
1321 * Given a sparse directory entry 'ce', compare ce->name to
1322 * info->traverse_path + p->path + '/' if info->traverse_path
1325 * Compare ce->name to p->path + '/' otherwise. Note that
1326 * ce->name must end in a trailing '/' because it is a sparse
1329 static int sparse_dir_matches_path(const struct cache_entry
*ce
,
1330 struct traverse_info
*info
,
1331 const struct name_entry
*p
)
1333 assert(S_ISSPARSEDIR(ce
->ce_mode
));
1334 assert(ce
->name
[ce
->ce_namelen
- 1] == '/');
1337 return ce
->ce_namelen
== info
->pathlen
+ p
->pathlen
+ 1 &&
1338 ce
->name
[info
->pathlen
- 1] == '/' &&
1339 !strncmp(ce
->name
, info
->traverse_path
, info
->pathlen
) &&
1340 !strncmp(ce
->name
+ info
->pathlen
, p
->path
, p
->pathlen
);
1341 return ce
->ce_namelen
== p
->pathlen
+ 1 &&
1342 !strncmp(ce
->name
, p
->path
, p
->pathlen
);
1345 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
1346 const struct name_entry
*p
)
1349 int pos
= find_cache_pos(info
, p
->path
, p
->pathlen
);
1350 struct unpack_trees_options
*o
= info
->data
;
1353 return o
->src_index
->cache
[pos
];
1356 * Check for a sparse-directory entry named "path/".
1357 * Due to the input p->path not having a trailing
1358 * slash, the negative 'pos' value overshoots the
1359 * expected position, hence "-2" instead of "-1".
1363 if (pos
< 0 || pos
>= o
->src_index
->cache_nr
)
1367 * Due to lexicographic sorting and sparse directory
1368 * entries ending with a trailing slash, our path as a
1369 * sparse directory (e.g "subdir/") and our path as a
1370 * file (e.g. "subdir") might be separated by other
1371 * paths (e.g. "subdir-").
1374 struct cache_entry
*ce
= o
->src_index
->cache
[pos
];
1376 if (!skip_prefix(ce
->name
, info
->traverse_path
, &path
) ||
1377 strncmp(path
, p
->path
, p
->pathlen
) ||
1378 path
[p
->pathlen
] != '/')
1381 if (S_ISSPARSEDIR(ce
->ce_mode
) &&
1382 sparse_dir_matches_path(ce
, info
, p
))
1391 static void debug_path(struct traverse_info
*info
)
1394 debug_path(info
->prev
);
1395 if (*info
->prev
->name
)
1398 printf("%s", info
->name
);
1401 static void debug_name_entry(int i
, struct name_entry
*n
)
1403 printf("ent#%d %06o %s\n", i
,
1404 n
->path
? n
->mode
: 0,
1405 n
->path
? n
->path
: "(missing)");
1408 static void debug_unpack_callback(int n
,
1410 unsigned long dirmask
,
1411 struct name_entry
*names
,
1412 struct traverse_info
*info
)
1415 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1419 for (i
= 0; i
< n
; i
++)
1420 debug_name_entry(i
, names
+ i
);
1424 * Returns true if and only if the given cache_entry is a
1425 * sparse-directory entry that matches the given name_entry
1426 * from the tree walk at the given traverse_info.
1428 static int is_sparse_directory_entry(struct cache_entry
*ce
,
1429 const struct name_entry
*name
,
1430 struct traverse_info
*info
)
1432 if (!ce
|| !name
|| !S_ISSPARSEDIR(ce
->ce_mode
))
1435 return sparse_dir_matches_path(ce
, info
, name
);
1438 static int unpack_sparse_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
1440 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
1441 struct unpack_trees_options
*o
= info
->data
;
1442 int ret
, is_new_sparse_dir
;
1447 * Unlike in 'unpack_callback', where src[0] is derived from the index when
1448 * merging, src[0] is a transient cache entry derived from the first tree
1449 * provided. Create the temporary entry as if it came from a non-sparse index.
1451 if (!is_null_oid(&names
[0].oid
)) {
1452 src
[0] = create_ce_entry(info
, &names
[0], 0,
1454 dirmask
& (1ul << 0));
1455 src
[0]->ce_flags
|= (CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
1459 * 'unpack_single_entry' assumes that src[0] is derived directly from
1460 * the index, rather than from an entry in 'names'. This is *not* true when
1461 * merging a sparse directory, in which case names[0] is the "index" source
1462 * entry. To match the expectations of 'unpack_single_entry', shift past the
1463 * "index" tree (i.e., names[0]) and adjust 'names', 'n', 'mask', and
1464 * 'dirmask' accordingly.
1466 ret
= unpack_single_entry(n
- 1, mask
>> 1, dirmask
>> 1, src
, names
+ 1, info
, &is_new_sparse_dir
);
1469 discard_cache_entry(src
[0]);
1471 return ret
>= 0 ? mask
: -1;
1475 * Note that traverse_by_cache_tree() duplicates some logic in this function
1476 * without actually calling it. If you change the logic here you may need to
1477 * check and change there as well.
1479 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
1481 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
1482 struct unpack_trees_options
*o
= info
->data
;
1483 const struct name_entry
*p
= names
;
1484 int is_new_sparse_dir
;
1486 /* Find first entry with a real name (we could use "mask" too) */
1490 if (o
->debug_unpack
)
1491 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
1493 /* Are we supposed to look at the index too? */
1497 struct cache_entry
*ce
;
1499 if (o
->diff_index_cached
)
1500 ce
= next_cache_entry(o
);
1502 ce
= find_cache_entry(info
, p
);
1506 cmp
= compare_entry(ce
, info
, p
);
1508 if (unpack_index_entry(ce
, o
) < 0)
1509 return unpack_failed(o
, NULL
);
1515 * If we skip unmerged index
1516 * entries, we'll skip this
1517 * entry *and* the tree
1518 * entries associated with it!
1520 if (o
->skip_unmerged
) {
1521 add_same_unmerged(ce
, o
);
1531 if (unpack_single_entry(n
, mask
, dirmask
, src
, names
, info
, &is_new_sparse_dir
))
1534 if (o
->merge
&& src
[0]) {
1535 if (ce_stage(src
[0]))
1536 mark_ce_used_same_name(src
[0], o
);
1538 mark_ce_used(src
[0], o
);
1541 /* Now handle any directories.. */
1543 /* special case: "diff-index --cached" looking at a tree */
1544 if (o
->diff_index_cached
&&
1545 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
1547 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
1550 * Everything under the name matches; skip the
1551 * entire hierarchy. diff_index_cached codepath
1552 * special cases D/F conflicts in such a way that
1553 * it does not do any look-ahead, so this is safe.
1557 * Only increment the cache_bottom if the
1558 * directory isn't a sparse directory index
1559 * entry (if it is, it was already incremented)
1560 * in 'mark_ce_used()'
1562 if (!src
[0] || !S_ISSPARSEDIR(src
[0]->ce_mode
))
1563 o
->cache_bottom
+= matches
;
1568 if (!is_sparse_directory_entry(src
[0], p
, info
) &&
1569 !is_new_sparse_dir
&&
1570 traverse_trees_recursive(n
, dirmask
, mask
& ~dirmask
,
1581 static int clear_ce_flags_1(struct index_state
*istate
,
1582 struct cache_entry
**cache
, int nr
,
1583 struct strbuf
*prefix
,
1584 int select_mask
, int clear_mask
,
1585 struct pattern_list
*pl
,
1586 enum pattern_match_result default_match
,
1589 /* Whole directory matching */
1590 static int clear_ce_flags_dir(struct index_state
*istate
,
1591 struct cache_entry
**cache
, int nr
,
1592 struct strbuf
*prefix
,
1594 int select_mask
, int clear_mask
,
1595 struct pattern_list
*pl
,
1596 enum pattern_match_result default_match
,
1599 struct cache_entry
**cache_end
;
1602 enum pattern_match_result ret
, orig_ret
;
1603 orig_ret
= path_matches_pattern_list(prefix
->buf
, prefix
->len
,
1604 basename
, &dtype
, pl
, istate
);
1606 strbuf_addch(prefix
, '/');
1608 /* If undecided, use matching result of parent dir in defval */
1609 if (orig_ret
== UNDECIDED
)
1610 ret
= default_match
;
1614 for (cache_end
= cache
; cache_end
!= cache
+ nr
; cache_end
++) {
1615 struct cache_entry
*ce
= *cache_end
;
1616 if (strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1620 if (pl
->use_cone_patterns
&& orig_ret
== MATCHED_RECURSIVE
) {
1621 struct cache_entry
**ce
= cache
;
1622 rc
= cache_end
- cache
;
1624 while (ce
< cache_end
) {
1625 (*ce
)->ce_flags
&= ~clear_mask
;
1628 } else if (pl
->use_cone_patterns
&& orig_ret
== NOT_MATCHED
) {
1629 rc
= cache_end
- cache
;
1631 rc
= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1633 select_mask
, clear_mask
,
1638 strbuf_setlen(prefix
, prefix
->len
- 1);
1643 * Traverse the index, find every entry that matches according to
1644 * o->pl. Do "ce_flags &= ~clear_mask" on those entries. Return the
1645 * number of traversed entries.
1647 * If select_mask is non-zero, only entries whose ce_flags has on of
1648 * those bits enabled are traversed.
1650 * cache : pointer to an index entry
1651 * prefix_len : an offset to its path
1653 * The current path ("prefix") including the trailing '/' is
1654 * cache[0]->name[0..(prefix_len-1)]
1655 * Top level path has prefix_len zero.
1657 static int clear_ce_flags_1(struct index_state
*istate
,
1658 struct cache_entry
**cache
, int nr
,
1659 struct strbuf
*prefix
,
1660 int select_mask
, int clear_mask
,
1661 struct pattern_list
*pl
,
1662 enum pattern_match_result default_match
,
1665 struct cache_entry
**cache_end
= nr
? cache
+ nr
: cache
;
1668 * Process all entries that have the given prefix and meet
1669 * select_mask condition
1671 while(cache
!= cache_end
) {
1672 struct cache_entry
*ce
= *cache
;
1673 const char *name
, *slash
;
1675 enum pattern_match_result ret
;
1677 display_progress(istate
->progress
, progress_nr
);
1679 if (select_mask
&& !(ce
->ce_flags
& select_mask
)) {
1685 if (prefix
->len
&& strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1688 name
= ce
->name
+ prefix
->len
;
1689 slash
= strchr(name
, '/');
1691 /* If it's a directory, try whole directory match first */
1696 strbuf_add(prefix
, name
, len
);
1698 processed
= clear_ce_flags_dir(istate
, cache
, cache_end
- cache
,
1700 prefix
->buf
+ prefix
->len
- len
,
1701 select_mask
, clear_mask
,
1705 /* clear_c_f_dir eats a whole dir already? */
1708 progress_nr
+= processed
;
1709 strbuf_setlen(prefix
, prefix
->len
- len
);
1713 strbuf_addch(prefix
, '/');
1714 processed
= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1716 select_mask
, clear_mask
, pl
,
1717 default_match
, progress_nr
);
1720 progress_nr
+= processed
;
1722 strbuf_setlen(prefix
, prefix
->len
- len
- 1);
1727 dtype
= ce_to_dtype(ce
);
1728 ret
= path_matches_pattern_list(ce
->name
,
1730 name
, &dtype
, pl
, istate
);
1731 if (ret
== UNDECIDED
)
1732 ret
= default_match
;
1733 if (ret
== MATCHED
|| ret
== MATCHED_RECURSIVE
)
1734 ce
->ce_flags
&= ~clear_mask
;
1739 display_progress(istate
->progress
, progress_nr
);
1740 return nr
- (cache_end
- cache
);
1743 static int clear_ce_flags(struct index_state
*istate
,
1744 int select_mask
, int clear_mask
,
1745 struct pattern_list
*pl
,
1748 static struct strbuf prefix
= STRBUF_INIT
;
1752 strbuf_reset(&prefix
);
1754 istate
->progress
= start_delayed_progress(
1755 _("Updating index flags"),
1758 xsnprintf(label
, sizeof(label
), "clear_ce_flags(0x%08lx,0x%08lx)",
1759 (unsigned long)select_mask
, (unsigned long)clear_mask
);
1760 trace2_region_enter("unpack_trees", label
, the_repository
);
1761 rval
= clear_ce_flags_1(istate
,
1765 select_mask
, clear_mask
,
1767 trace2_region_leave("unpack_trees", label
, the_repository
);
1769 stop_progress(&istate
->progress
);
1774 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1776 static void mark_new_skip_worktree(struct pattern_list
*pl
,
1777 struct index_state
*istate
,
1778 int select_flag
, int skip_wt_flag
,
1784 * 1. Pretend the narrowest worktree: only unmerged entries
1787 for (i
= 0; i
< istate
->cache_nr
; i
++) {
1788 struct cache_entry
*ce
= istate
->cache
[i
];
1790 if (select_flag
&& !(ce
->ce_flags
& select_flag
))
1793 if (!ce_stage(ce
) && !(ce
->ce_flags
& CE_CONFLICTED
))
1794 ce
->ce_flags
|= skip_wt_flag
;
1796 ce
->ce_flags
&= ~skip_wt_flag
;
1800 * 2. Widen worktree according to sparse-checkout file.
1801 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1803 clear_ce_flags(istate
, select_flag
, skip_wt_flag
, pl
, show_progress
);
1806 static void populate_from_existing_patterns(struct unpack_trees_options
*o
,
1807 struct pattern_list
*pl
)
1809 if (get_sparse_checkout_patterns(pl
) < 0)
1810 o
->skip_sparse_checkout
= 1;
1815 static void update_sparsity_for_prefix(const char *prefix
,
1816 struct index_state
*istate
)
1818 int prefix_len
= strlen(prefix
);
1819 struct strbuf ce_prefix
= STRBUF_INIT
;
1821 if (!istate
->sparse_index
)
1824 while (prefix_len
> 0 && prefix
[prefix_len
- 1] == '/')
1827 if (prefix_len
<= 0)
1828 BUG("Invalid prefix passed to update_sparsity_for_prefix");
1830 strbuf_grow(&ce_prefix
, prefix_len
+ 1);
1831 strbuf_add(&ce_prefix
, prefix
, prefix_len
);
1832 strbuf_addch(&ce_prefix
, '/');
1835 * If the prefix points to a sparse directory or a path inside a sparse
1836 * directory, the index should be expanded. This is accomplished in one
1838 * - if the prefix is inside a sparse directory, it will be expanded by
1839 * the 'ensure_full_index(...)' call in 'index_name_pos(...)'.
1840 * - if the prefix matches an existing sparse directory entry,
1841 * 'index_name_pos(...)' will return its index position, triggering
1842 * the 'ensure_full_index(...)' below.
1844 if (!path_in_cone_mode_sparse_checkout(ce_prefix
.buf
, istate
) &&
1845 index_name_pos(istate
, ce_prefix
.buf
, ce_prefix
.len
) >= 0)
1846 ensure_full_index(istate
);
1848 strbuf_release(&ce_prefix
);
1851 static int verify_absent(const struct cache_entry
*,
1852 enum unpack_trees_error_types
,
1853 struct unpack_trees_options
*);
1855 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1856 * resulting index, -2 on failure to reflect the changes to the work tree.
1858 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1860 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
1862 struct repository
*repo
= the_repository
;
1864 static struct cache_entry
*dfc
;
1865 struct pattern_list pl
;
1866 int free_pattern_list
= 0;
1867 struct dir_struct dir
= DIR_INIT
;
1869 if (o
->reset
== UNPACK_RESET_INVALID
)
1870 BUG("o->reset had a value of 1; should be UNPACK_TREES_*_UNTRACKED");
1872 if (len
> MAX_UNPACK_TREES
)
1873 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
1875 BUG("o->dir is for internal use only");
1877 trace_performance_enter();
1878 trace2_region_enter("unpack_trees", "unpack_trees", the_repository
);
1880 prepare_repo_settings(repo
);
1881 if (repo
->settings
.command_requires_full_index
) {
1882 ensure_full_index(o
->src_index
);
1884 ensure_full_index(o
->dst_index
);
1887 if (o
->reset
== UNPACK_RESET_OVERWRITE_UNTRACKED
&&
1888 o
->preserve_ignored
)
1889 BUG("UNPACK_RESET_OVERWRITE_UNTRACKED incompatible with preserved ignored files");
1891 if (!o
->preserve_ignored
) {
1893 o
->dir
->flags
|= DIR_SHOW_IGNORED
;
1894 setup_standard_excludes(o
->dir
);
1898 update_sparsity_for_prefix(o
->prefix
, o
->src_index
);
1900 if (!core_apply_sparse_checkout
|| !o
->update
)
1901 o
->skip_sparse_checkout
= 1;
1902 if (!o
->skip_sparse_checkout
&& !o
->pl
) {
1903 memset(&pl
, 0, sizeof(pl
));
1904 free_pattern_list
= 1;
1905 populate_from_existing_patterns(o
, &pl
);
1908 index_state_init(&o
->result
);
1909 o
->result
.initialized
= 1;
1910 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
1911 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
1912 o
->result
.version
= o
->src_index
->version
;
1913 if (!o
->src_index
->split_index
) {
1914 o
->result
.split_index
= NULL
;
1915 } else if (o
->src_index
== o
->dst_index
) {
1917 * o->dst_index (and thus o->src_index) will be discarded
1918 * and overwritten with o->result at the end of this function,
1919 * so just use src_index's split_index to avoid having to
1922 o
->result
.split_index
= o
->src_index
->split_index
;
1923 o
->result
.split_index
->refcount
++;
1925 o
->result
.split_index
= init_split_index(&o
->result
);
1927 oidcpy(&o
->result
.oid
, &o
->src_index
->oid
);
1928 o
->merge_size
= len
;
1929 mark_all_ce_unused(o
->src_index
);
1931 o
->result
.fsmonitor_last_update
=
1932 xstrdup_or_null(o
->src_index
->fsmonitor_last_update
);
1933 o
->result
.fsmonitor_has_run_once
= o
->src_index
->fsmonitor_has_run_once
;
1935 if (!o
->src_index
->initialized
&&
1936 !repo
->settings
.command_requires_full_index
&&
1937 is_sparse_index_allowed(&o
->result
, 0))
1938 o
->result
.sparse_index
= 1;
1941 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1943 if (!o
->skip_sparse_checkout
)
1944 mark_new_skip_worktree(o
->pl
, o
->src_index
, 0,
1945 CE_NEW_SKIP_WORKTREE
, o
->verbose_update
);
1948 dfc
= xcalloc(1, cache_entry_size(0));
1949 o
->df_conflict_entry
= dfc
;
1952 const char *prefix
= o
->prefix
? o
->prefix
: "";
1953 struct traverse_info info
;
1955 setup_traverse_info(&info
, prefix
);
1956 info
.fn
= unpack_callback
;
1958 info
.show_all_errors
= o
->show_all_errors
;
1959 info
.pathspec
= o
->pathspec
;
1963 * Unpack existing index entries that sort before the
1964 * prefix the tree is spliced into. Note that o->merge
1965 * is always true in this case.
1968 struct cache_entry
*ce
= next_cache_entry(o
);
1971 if (ce_in_traverse_path(ce
, &info
))
1973 if (unpack_index_entry(ce
, o
) < 0)
1978 trace_performance_enter();
1979 trace2_region_enter("unpack_trees", "traverse_trees", the_repository
);
1980 ret
= traverse_trees(o
->src_index
, len
, t
, &info
);
1981 trace2_region_leave("unpack_trees", "traverse_trees", the_repository
);
1982 trace_performance_leave("traverse_trees");
1987 /* Any left-over entries in the index? */
1990 struct cache_entry
*ce
= next_cache_entry(o
);
1993 if (unpack_index_entry(ce
, o
) < 0)
1997 mark_all_ce_unused(o
->src_index
);
1999 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
2000 ret
= unpack_failed(o
, "Merge requires file-level merging");
2004 if (!o
->skip_sparse_checkout
) {
2006 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
2007 * If they will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
2008 * so apply_sparse_checkout() won't attempt to remove it from worktree
2010 mark_new_skip_worktree(o
->pl
, &o
->result
,
2011 CE_ADDED
, CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
,
2015 for (i
= 0; i
< o
->result
.cache_nr
; i
++) {
2016 struct cache_entry
*ce
= o
->result
.cache
[i
];
2019 * Entries marked with CE_ADDED in merged_entry() do not have
2020 * verify_absent() check (the check is effectively disabled
2021 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
2023 * Do the real check now because we have had
2024 * correct CE_NEW_SKIP_WORKTREE
2026 if (ce
->ce_flags
& CE_ADDED
&&
2027 verify_absent(ce
, WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN
, o
))
2030 if (apply_sparse_checkout(&o
->result
, ce
, o
))
2035 * Inability to sparsify or de-sparsify individual
2036 * paths is not an error, but just a warning.
2038 if (o
->show_all_errors
)
2039 display_warning_msgs(o
);
2044 ret
= check_updates(o
, &o
->result
) ? (-2) : 0;
2046 move_index_extensions(&o
->result
, o
->src_index
);
2048 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
2049 cache_tree_verify(the_repository
, &o
->result
);
2050 if (!o
->skip_cache_tree_update
&&
2051 !cache_tree_fully_valid(o
->result
.cache_tree
))
2052 cache_tree_update(&o
->result
,
2057 o
->result
.updated_workdir
= 1;
2058 discard_index(o
->dst_index
);
2059 *o
->dst_index
= o
->result
;
2061 discard_index(&o
->result
);
2063 o
->src_index
= NULL
;
2066 if (free_pattern_list
)
2067 clear_pattern_list(&pl
);
2072 trace2_region_leave("unpack_trees", "unpack_trees", the_repository
);
2073 trace_performance_leave("unpack_trees");
2077 if (o
->show_all_errors
)
2078 display_error_msgs(o
);
2079 mark_all_ce_unused(o
->src_index
);
2080 ret
= unpack_failed(o
, NULL
);
2081 if (o
->exiting_early
)
2087 * Update SKIP_WORKTREE bits according to sparsity patterns, and update
2088 * working directory to match.
2090 * CE_NEW_SKIP_WORKTREE is used internally.
2092 enum update_sparsity_result
update_sparsity(struct unpack_trees_options
*o
)
2094 enum update_sparsity_result ret
= UPDATE_SPARSITY_SUCCESS
;
2095 struct pattern_list pl
;
2097 unsigned old_show_all_errors
;
2098 int free_pattern_list
= 0;
2100 old_show_all_errors
= o
->show_all_errors
;
2101 o
->show_all_errors
= 1;
2104 if (!o
->update
|| o
->index_only
|| o
->skip_sparse_checkout
)
2105 BUG("update_sparsity() is for reflecting sparsity patterns in working directory");
2106 if (o
->src_index
!= o
->dst_index
|| o
->fn
)
2107 BUG("update_sparsity() called wrong");
2109 trace_performance_enter();
2111 /* If we weren't given patterns, use the recorded ones */
2113 memset(&pl
, 0, sizeof(pl
));
2114 free_pattern_list
= 1;
2115 populate_from_existing_patterns(o
, &pl
);
2116 if (o
->skip_sparse_checkout
)
2117 goto skip_sparse_checkout
;
2120 /* Expand sparse directories as needed */
2121 expand_index(o
->src_index
, o
->pl
);
2123 /* Set NEW_SKIP_WORKTREE on existing entries. */
2124 mark_all_ce_unused(o
->src_index
);
2125 mark_new_skip_worktree(o
->pl
, o
->src_index
, 0,
2126 CE_NEW_SKIP_WORKTREE
, o
->verbose_update
);
2128 /* Then loop over entries and update/remove as needed */
2129 ret
= UPDATE_SPARSITY_SUCCESS
;
2130 for (i
= 0; i
< o
->src_index
->cache_nr
; i
++) {
2131 struct cache_entry
*ce
= o
->src_index
->cache
[i
];
2135 /* -1 because for loop will increment by 1 */
2136 i
+= warn_conflicted_path(o
->src_index
, i
, o
) - 1;
2137 ret
= UPDATE_SPARSITY_WARNINGS
;
2141 if (apply_sparse_checkout(o
->src_index
, ce
, o
))
2142 ret
= UPDATE_SPARSITY_WARNINGS
;
2145 skip_sparse_checkout
:
2146 if (check_updates(o
, o
->src_index
))
2147 ret
= UPDATE_SPARSITY_WORKTREE_UPDATE_FAILURES
;
2149 display_warning_msgs(o
);
2150 o
->show_all_errors
= old_show_all_errors
;
2151 if (free_pattern_list
)
2152 clear_pattern_list(&pl
);
2153 trace_performance_leave("update_sparsity");
2157 /* Here come the merge functions */
2159 static int reject_merge(const struct cache_entry
*ce
,
2160 struct unpack_trees_options
*o
)
2162 return add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
2165 static int same(const struct cache_entry
*a
, const struct cache_entry
*b
)
2171 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
2173 return a
->ce_mode
== b
->ce_mode
&&
2174 oideq(&a
->oid
, &b
->oid
);
2179 * When a CE gets turned into an unmerged entry, we
2180 * want it to be up-to-date
2182 static int verify_uptodate_1(const struct cache_entry
*ce
,
2183 struct unpack_trees_options
*o
,
2184 enum unpack_trees_error_types error_type
)
2192 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
2193 * if this entry is truly up-to-date because this file may be
2196 if ((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
))
2197 ; /* keep checking */
2198 else if (o
->reset
|| ce_uptodate(ce
))
2201 if (!lstat(ce
->name
, &st
)) {
2202 int flags
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
;
2203 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, flags
);
2205 if (submodule_from_ce(ce
)) {
2206 int r
= check_submodule_move_head(ce
,
2207 "HEAD", oid_to_hex(&ce
->oid
), o
);
2209 return add_rejected_path(o
, error_type
, ce
->name
);
2216 * Historic default policy was to allow submodule to be out
2217 * of sync wrt the superproject index. If the submodule was
2218 * not considered interesting above, we don't care here.
2220 if (S_ISGITLINK(ce
->ce_mode
))
2225 if (errno
== ENOENT
)
2227 return add_rejected_path(o
, error_type
, ce
->name
);
2230 int verify_uptodate(const struct cache_entry
*ce
,
2231 struct unpack_trees_options
*o
)
2233 if (!o
->skip_sparse_checkout
&&
2234 (ce
->ce_flags
& CE_SKIP_WORKTREE
) &&
2235 (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
2237 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
2240 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
2241 struct unpack_trees_options
*o
)
2243 return verify_uptodate_1(ce
, o
, WARNING_SPARSE_NOT_UPTODATE_FILE
);
2247 * TODO: We should actually invalidate o->result, not src_index [1].
2248 * But since cache tree and untracked cache both are not copied to
2249 * o->result until unpacking is complete, we invalidate them on
2250 * src_index instead with the assumption that they will be copied to
2251 * dst_index at the end.
2253 * [1] src_index->cache_tree is also used in unpack_callback() so if
2254 * we invalidate o->result, we need to update it to use
2255 * o->result.cache_tree as well.
2257 static void invalidate_ce_path(const struct cache_entry
*ce
,
2258 struct unpack_trees_options
*o
)
2262 cache_tree_invalidate_path(o
->src_index
, ce
->name
);
2263 untracked_cache_invalidate_path(o
->src_index
, ce
->name
, 1);
2267 * Check that checking out ce->sha1 in subdir ce->name is not
2268 * going to overwrite any working files.
2270 static int verify_clean_submodule(const char *old_sha1
,
2271 const struct cache_entry
*ce
,
2272 struct unpack_trees_options
*o
)
2274 if (!submodule_from_ce(ce
))
2277 return check_submodule_move_head(ce
, old_sha1
,
2278 oid_to_hex(&ce
->oid
), o
);
2281 static int verify_clean_subdirectory(const struct cache_entry
*ce
,
2282 struct unpack_trees_options
*o
)
2285 * we are about to extract "ce->name"; we would not want to lose
2286 * anything in the existing directory there.
2290 struct dir_struct d
;
2294 if (S_ISGITLINK(ce
->ce_mode
)) {
2295 struct object_id oid
;
2296 int sub_head
= resolve_gitlink_ref(ce
->name
, "HEAD", &oid
);
2298 * If we are not going to update the submodule, then
2301 if (!sub_head
&& oideq(&oid
, &ce
->oid
))
2303 return verify_clean_submodule(sub_head
? NULL
: oid_to_hex(&oid
),
2308 * First let's make sure we do not have a local modification
2309 * in that directory.
2311 namelen
= ce_namelen(ce
);
2312 for (i
= locate_in_src_index(ce
, o
);
2313 i
< o
->src_index
->cache_nr
;
2315 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
2316 int len
= ce_namelen(ce2
);
2317 if (len
< namelen
||
2318 strncmp(ce
->name
, ce2
->name
, namelen
) ||
2319 ce2
->name
[namelen
] != '/')
2322 * ce2->name is an entry in the subdirectory to be
2325 if (!ce_stage(ce2
)) {
2326 if (verify_uptodate(ce2
, o
))
2328 add_entry(o
, ce2
, CE_REMOVE
, 0);
2329 invalidate_ce_path(ce
, o
);
2330 mark_ce_used(ce2
, o
);
2335 /* Do not lose a locally present file that is not ignored. */
2336 pathbuf
= xstrfmt("%.*s/", namelen
, ce
->name
);
2338 memset(&d
, 0, sizeof(d
));
2340 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
2341 i
= read_directory(&d
, o
->src_index
, pathbuf
, namelen
+1, NULL
);
2345 return add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
2347 /* Do not lose startup_info->original_cwd */
2348 if (startup_info
->original_cwd
&&
2349 !strcmp(startup_info
->original_cwd
, ce
->name
))
2350 return add_rejected_path(o
, ERROR_CWD_IN_THE_WAY
, ce
->name
);
2356 * This gets called when there was no index entry for the tree entry 'dst',
2357 * but we found a file in the working tree that 'lstat()' said was fine,
2358 * and we're on a case-insensitive filesystem.
2360 * See if we can find a case-insensitive match in the index that also
2361 * matches the stat information, and assume it's that other file!
2363 static int icase_exists(struct unpack_trees_options
*o
, const char *name
, int len
, struct stat
*st
)
2365 const struct cache_entry
*src
;
2367 src
= index_file_exists(o
->src_index
, name
, len
, 1);
2368 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
2371 enum absent_checking_type
{
2373 ABSENT_ANY_DIRECTORY
2376 static int check_ok_to_remove(const char *name
, int len
, int dtype
,
2377 const struct cache_entry
*ce
, struct stat
*st
,
2378 enum unpack_trees_error_types error_type
,
2379 enum absent_checking_type absent_type
,
2380 struct unpack_trees_options
*o
)
2382 const struct cache_entry
*result
;
2385 * It may be that the 'lstat()' succeeded even though
2386 * target 'ce' was absent, because there is an old
2387 * entry that is different only in case..
2389 * Ignore that lstat() if it matches.
2391 if (ignore_case
&& icase_exists(o
, name
, len
, st
))
2395 is_excluded(o
->dir
, o
->src_index
, name
, &dtype
))
2397 * ce->name is explicitly excluded, so it is Ok to
2401 if (S_ISDIR(st
->st_mode
)) {
2403 * We are checking out path "foo" and
2404 * found "foo/." in the working tree.
2405 * This is tricky -- if we have modified
2406 * files that are in "foo/" we would lose
2409 if (verify_clean_subdirectory(ce
, o
) < 0)
2414 /* If we only care about directories, then we can remove */
2415 if (absent_type
== ABSENT_ANY_DIRECTORY
)
2419 * The previous round may already have decided to
2420 * delete this path, which is in a subdirectory that
2421 * is being replaced with a blob.
2423 result
= index_file_exists(&o
->result
, name
, len
, 0);
2425 if (result
->ce_flags
& CE_REMOVE
)
2429 return add_rejected_path(o
, error_type
, name
);
2433 * We do not want to remove or overwrite a working tree file that
2434 * is not tracked, unless it is ignored.
2436 static int verify_absent_1(const struct cache_entry
*ce
,
2437 enum unpack_trees_error_types error_type
,
2438 enum absent_checking_type absent_type
,
2439 struct unpack_trees_options
*o
)
2444 if (o
->index_only
|| !o
->update
)
2447 if (o
->reset
== UNPACK_RESET_OVERWRITE_UNTRACKED
) {
2448 /* Avoid nuking startup_info->original_cwd... */
2449 if (startup_info
->original_cwd
&&
2450 !strcmp(startup_info
->original_cwd
, ce
->name
))
2451 return add_rejected_path(o
, ERROR_CWD_IN_THE_WAY
,
2453 /* ...but nuke anything else. */
2457 len
= check_leading_path(ce
->name
, ce_namelen(ce
), 0);
2464 path
= xmemdupz(ce
->name
, len
);
2465 if (lstat(path
, &st
))
2466 ret
= error_errno("cannot stat '%s'", path
);
2468 if (submodule_from_ce(ce
))
2469 ret
= check_submodule_move_head(ce
,
2470 oid_to_hex(&ce
->oid
),
2473 ret
= check_ok_to_remove(path
, len
, DT_UNKNOWN
, NULL
,
2479 } else if (lstat(ce
->name
, &st
)) {
2480 if (errno
!= ENOENT
)
2481 return error_errno("cannot stat '%s'", ce
->name
);
2484 if (submodule_from_ce(ce
))
2485 return check_submodule_move_head(ce
, oid_to_hex(&ce
->oid
),
2488 return check_ok_to_remove(ce
->name
, ce_namelen(ce
),
2489 ce_to_dtype(ce
), ce
, &st
,
2490 error_type
, absent_type
, o
);
2494 static int verify_absent(const struct cache_entry
*ce
,
2495 enum unpack_trees_error_types error_type
,
2496 struct unpack_trees_options
*o
)
2498 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
2500 return verify_absent_1(ce
, error_type
, COMPLETELY_ABSENT
, o
);
2503 static int verify_absent_if_directory(const struct cache_entry
*ce
,
2504 enum unpack_trees_error_types error_type
,
2505 struct unpack_trees_options
*o
)
2507 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
2509 return verify_absent_1(ce
, error_type
, ABSENT_ANY_DIRECTORY
, o
);
2512 static int verify_absent_sparse(const struct cache_entry
*ce
,
2513 enum unpack_trees_error_types error_type
,
2514 struct unpack_trees_options
*o
)
2516 return verify_absent_1(ce
, error_type
, COMPLETELY_ABSENT
, o
);
2519 static int merged_entry(const struct cache_entry
*ce
,
2520 const struct cache_entry
*old
,
2521 struct unpack_trees_options
*o
)
2523 int update
= CE_UPDATE
;
2524 struct cache_entry
*merge
= dup_cache_entry(ce
, &o
->result
);
2528 * New index entries. In sparse checkout, the following
2529 * verify_absent() will be delayed until after
2530 * traverse_trees() finishes in unpack_trees(), then:
2532 * - CE_NEW_SKIP_WORKTREE will be computed correctly
2533 * - verify_absent() be called again, this time with
2534 * correct CE_NEW_SKIP_WORKTREE
2536 * verify_absent() call here does nothing in sparse
2537 * checkout (i.e. o->skip_sparse_checkout == 0)
2540 merge
->ce_flags
|= CE_NEW_SKIP_WORKTREE
;
2542 if (verify_absent(merge
,
2543 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
2544 discard_cache_entry(merge
);
2547 invalidate_ce_path(merge
, o
);
2549 if (submodule_from_ce(ce
) && file_exists(ce
->name
)) {
2550 int ret
= check_submodule_move_head(ce
, NULL
,
2551 oid_to_hex(&ce
->oid
),
2557 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
2559 * See if we can re-use the old CE directly?
2560 * That way we get the uptodate stat info.
2562 * This also removes the UPDATE flag on a match; otherwise
2563 * we will end up overwriting local changes in the work tree.
2565 if (same(old
, merge
)) {
2566 copy_cache_entry(merge
, old
);
2569 if (verify_uptodate(old
, o
)) {
2570 discard_cache_entry(merge
);
2573 /* Migrate old flags over */
2574 update
|= old
->ce_flags
& (CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
2575 invalidate_ce_path(old
, o
);
2578 if (submodule_from_ce(ce
) && file_exists(ce
->name
)) {
2579 int ret
= check_submodule_move_head(ce
, oid_to_hex(&old
->oid
),
2580 oid_to_hex(&ce
->oid
),
2587 * Previously unmerged entry left as an existence
2588 * marker by read_index_unmerged();
2590 if (verify_absent_if_directory(merge
,
2591 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
2592 discard_cache_entry(merge
);
2596 invalidate_ce_path(old
, o
);
2599 if (do_add_entry(o
, merge
, update
, CE_STAGEMASK
) < 0)
2604 static int merged_sparse_dir(const struct cache_entry
* const *src
, int n
,
2605 struct unpack_trees_options
*o
)
2607 struct tree_desc t
[MAX_UNPACK_TREES
+ 1];
2608 void * tree_bufs
[MAX_UNPACK_TREES
+ 1];
2609 struct traverse_info info
;
2613 * Create the tree traversal information for traversing into *only* the
2616 setup_traverse_info(&info
, src
[0]->name
);
2617 info
.fn
= unpack_sparse_callback
;
2619 info
.show_all_errors
= o
->show_all_errors
;
2620 info
.pathspec
= o
->pathspec
;
2622 /* Get the tree descriptors of the sparse directory in each of the merging trees */
2623 for (i
= 0; i
< n
; i
++)
2624 tree_bufs
[i
] = fill_tree_descriptor(o
->src_index
->repo
, &t
[i
],
2625 src
[i
] && !is_null_oid(&src
[i
]->oid
) ? &src
[i
]->oid
: NULL
);
2627 ret
= traverse_trees(o
->src_index
, n
, t
, &info
);
2629 for (i
= 0; i
< n
; i
++)
2635 static int deleted_entry(const struct cache_entry
*ce
,
2636 const struct cache_entry
*old
,
2637 struct unpack_trees_options
*o
)
2639 /* Did it exist in the index? */
2641 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2644 } else if (verify_absent_if_directory(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
)) {
2648 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
2650 add_entry(o
, ce
, CE_REMOVE
, 0);
2651 invalidate_ce_path(ce
, o
);
2655 static int keep_entry(const struct cache_entry
*ce
,
2656 struct unpack_trees_options
*o
)
2658 add_entry(o
, ce
, 0, 0);
2660 invalidate_ce_path(ce
, o
);
2665 static void show_stage_entry(FILE *o
,
2666 const char *label
, const struct cache_entry
*ce
)
2669 fprintf(o
, "%s (missing)\n", label
);
2671 fprintf(o
, "%s%06o %s %d\t%s\n",
2674 oid_to_hex(&ce
->oid
),
2680 int threeway_merge(const struct cache_entry
* const *stages
,
2681 struct unpack_trees_options
*o
)
2683 const struct cache_entry
*index
;
2684 const struct cache_entry
*head
;
2685 const struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
2688 int remote_match
= 0;
2690 int df_conflict_head
= 0;
2691 int df_conflict_remote
= 0;
2693 int any_anc_missing
= 0;
2694 int no_anc_exists
= 1;
2697 for (i
= 1; i
< o
->head_idx
; i
++) {
2698 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
2699 any_anc_missing
= 1;
2705 head
= stages
[o
->head_idx
];
2707 if (head
== o
->df_conflict_entry
) {
2708 df_conflict_head
= 1;
2712 if (remote
== o
->df_conflict_entry
) {
2713 df_conflict_remote
= 1;
2718 * First, if there's a #16 situation, note that to prevent #13
2721 if (!same(remote
, head
)) {
2722 for (i
= 1; i
< o
->head_idx
; i
++) {
2723 if (same(stages
[i
], head
)) {
2726 if (same(stages
[i
], remote
)) {
2733 * We start with cases where the index is allowed to match
2734 * something other than the head: #14(ALT) and #2ALT, where it
2735 * is permitted to match the result instead.
2737 /* #14, #14ALT, #2ALT */
2738 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
2739 if (index
&& !same(index
, remote
) && !same(index
, head
)) {
2740 if (S_ISSPARSEDIR(index
->ce_mode
))
2741 return merged_sparse_dir(stages
, 4, o
);
2743 return reject_merge(index
, o
);
2745 return merged_entry(remote
, index
, o
);
2748 * If we have an entry in the index cache, then we want to
2749 * make sure that it matches head.
2751 if (index
&& !same(index
, head
)) {
2752 if (S_ISSPARSEDIR(index
->ce_mode
))
2753 return merged_sparse_dir(stages
, 4, o
);
2755 return reject_merge(index
, o
);
2760 if (same(head
, remote
))
2761 return merged_entry(head
, index
, o
);
2763 if (!df_conflict_remote
&& remote_match
&& !head_match
)
2764 return merged_entry(head
, index
, o
);
2768 if (!head
&& !remote
&& any_anc_missing
)
2772 * Under the "aggressive" rule, we resolve mostly trivial
2773 * cases that we historically had git-merge-one-file resolve.
2775 if (o
->aggressive
) {
2776 int head_deleted
= !head
;
2777 int remote_deleted
= !remote
;
2778 const struct cache_entry
*ce
= NULL
;
2787 for (i
= 1; i
< o
->head_idx
; i
++) {
2788 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2797 * Deleted in one and unchanged in the other.
2799 if ((head_deleted
&& remote_deleted
) ||
2800 (head_deleted
&& remote
&& remote_match
) ||
2801 (remote_deleted
&& head
&& head_match
)) {
2803 return deleted_entry(index
, index
, o
);
2804 if (ce
&& !head_deleted
) {
2805 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2811 * Added in both, identically.
2813 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
2814 return merged_entry(head
, index
, o
);
2818 /* Handle "no merge" cases (see t/t1000-read-tree-m-3way.sh) */
2821 * If we've reached the "no merge" cases and we're merging
2822 * a sparse directory, we may have an "edit/edit" conflict that
2823 * can be resolved by individually merging directory contents.
2825 if (S_ISSPARSEDIR(index
->ce_mode
))
2826 return merged_sparse_dir(stages
, 4, o
);
2829 * If we're not merging a sparse directory, ensure the index is
2830 * up-to-date to avoid files getting overwritten with conflict
2833 if (verify_uptodate(index
, o
))
2837 o
->nontrivial_merge
= 1;
2839 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2841 if (!head_match
|| !remote_match
) {
2842 for (i
= 1; i
< o
->head_idx
; i
++) {
2843 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2844 keep_entry(stages
[i
], o
);
2852 fprintf(stderr
, "read-tree: warning #16 detected\n");
2853 show_stage_entry(stderr
, "head ", stages
[head_match
]);
2854 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
2857 if (head
) { count
+= keep_entry(head
, o
); }
2858 if (remote
) { count
+= keep_entry(remote
, o
); }
2865 * The rule is to "carry forward" what is in the index without losing
2866 * information across a "fast-forward", favoring a successful merge
2867 * over a merge failure when it makes sense. For details of the
2868 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2871 int twoway_merge(const struct cache_entry
* const *src
,
2872 struct unpack_trees_options
*o
)
2874 const struct cache_entry
*current
= src
[0];
2875 const struct cache_entry
*oldtree
= src
[1];
2876 const struct cache_entry
*newtree
= src
[2];
2878 if (o
->merge_size
!= 2)
2879 return error("Cannot do a twoway merge of %d trees",
2882 if (oldtree
== o
->df_conflict_entry
)
2884 if (newtree
== o
->df_conflict_entry
)
2888 if (current
->ce_flags
& CE_CONFLICTED
) {
2889 if (same(oldtree
, newtree
) || o
->reset
) {
2891 return deleted_entry(current
, current
, o
);
2893 return merged_entry(newtree
, current
, o
);
2895 return reject_merge(current
, o
);
2896 } else if ((!oldtree
&& !newtree
) || /* 4 and 5 */
2897 (!oldtree
&& newtree
&&
2898 same(current
, newtree
)) || /* 6 and 7 */
2899 (oldtree
&& newtree
&&
2900 same(oldtree
, newtree
)) || /* 14 and 15 */
2901 (oldtree
&& newtree
&&
2902 !same(oldtree
, newtree
) && /* 18 and 19 */
2903 same(current
, newtree
))) {
2904 return keep_entry(current
, o
);
2905 } else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
2907 return deleted_entry(oldtree
, current
, o
);
2908 } else if (oldtree
&& newtree
&&
2909 same(current
, oldtree
) && !same(current
, newtree
)) {
2911 return merged_entry(newtree
, current
, o
);
2912 } else if (current
&& !oldtree
&& newtree
&&
2913 S_ISSPARSEDIR(current
->ce_mode
) != S_ISSPARSEDIR(newtree
->ce_mode
) &&
2914 ce_stage(current
) == 0) {
2916 * This case is a directory/file conflict across the sparse-index
2917 * boundary. When we are changing from one path to another via
2918 * 'git checkout', then we want to replace one entry with another
2919 * via merged_entry(). If there are staged changes, then we should
2920 * reject the merge instead.
2922 return merged_entry(newtree
, current
, o
);
2923 } else if (S_ISSPARSEDIR(current
->ce_mode
)) {
2925 * The sparse directories differ, but we don't know whether that's
2926 * because of two different files in the directory being modified
2927 * (can be trivially merged) or if there is a real file conflict.
2928 * Merge the sparse directory by OID to compare file-by-file.
2930 return merged_sparse_dir(src
, 3, o
);
2932 return reject_merge(current
, o
);
2935 if (oldtree
&& !o
->initial_checkout
) {
2937 * deletion of the path was staged;
2939 if (same(oldtree
, newtree
))
2941 return reject_merge(oldtree
, o
);
2943 return merged_entry(newtree
, current
, o
);
2945 return deleted_entry(oldtree
, current
, o
);
2951 * Keep the index entries at stage0, collapse stage1 but make sure
2952 * stage0 does not have anything there.
2954 int bind_merge(const struct cache_entry
* const *src
,
2955 struct unpack_trees_options
*o
)
2957 const struct cache_entry
*old
= src
[0];
2958 const struct cache_entry
*a
= src
[1];
2960 if (o
->merge_size
!= 1)
2961 return error("Cannot do a bind merge of %d trees",
2964 return o
->quiet
? -1 :
2965 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
),
2966 super_prefixed(a
->name
, o
->super_prefix
),
2967 super_prefixed(old
->name
, o
->super_prefix
));
2969 return keep_entry(old
, o
);
2971 return merged_entry(a
, NULL
, o
);
2978 * - take the stat information from stage0, take the data from stage1
2980 int oneway_merge(const struct cache_entry
* const *src
,
2981 struct unpack_trees_options
*o
)
2983 const struct cache_entry
*old
= src
[0];
2984 const struct cache_entry
*a
= src
[1];
2986 if (o
->merge_size
!= 1)
2987 return error("Cannot do a oneway merge of %d trees",
2990 if (!a
|| a
== o
->df_conflict_entry
)
2991 return deleted_entry(old
, old
, o
);
2993 if (old
&& same(old
, a
)) {
2995 if (o
->reset
&& o
->update
&& !ce_uptodate(old
) && !ce_skip_worktree(old
) &&
2996 !(old
->ce_flags
& CE_FSMONITOR_VALID
)) {
2998 if (lstat(old
->name
, &st
) ||
2999 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
3000 update
|= CE_UPDATE
;
3002 if (o
->update
&& S_ISGITLINK(old
->ce_mode
) &&
3003 should_update_submodules() && !verify_uptodate(old
, o
))
3004 update
|= CE_UPDATE
;
3005 add_entry(o
, old
, update
, CE_STAGEMASK
);
3008 return merged_entry(a
, old
, o
);
3012 * Merge worktree and untracked entries in a stash entry.
3014 * Ignore all index entries. Collapse remaining trees but make sure that they
3015 * don't have any conflicting files.
3017 int stash_worktree_untracked_merge(const struct cache_entry
* const *src
,
3018 struct unpack_trees_options
*o
)
3020 const struct cache_entry
*worktree
= src
[1];
3021 const struct cache_entry
*untracked
= src
[2];
3023 if (o
->merge_size
!= 2)
3024 BUG("invalid merge_size: %d", o
->merge_size
);
3026 if (worktree
&& untracked
)
3027 return error(_("worktree and untracked commit have duplicate entries: %s"),
3028 super_prefixed(worktree
->name
, o
->super_prefix
));
3030 return merged_entry(worktree
? worktree
: untracked
, NULL
, o
);