2 #include "argv-array.h"
3 #include "repository.h"
8 #include "cache-tree.h"
9 #include "unpack-trees.h"
13 #include "split-index.h"
15 #include "submodule.h"
16 #include "submodule-config.h"
17 #include "fsmonitor.h"
18 #include "object-store.h"
19 #include "fetch-object.h"
22 * Error messages expected by scripts out of plumbing commands such as
23 * read-tree. Non-scripted Porcelain is not required to use these messages
24 * and in fact are encouraged to reword them to better suit their particular
25 * situation better. See how "git checkout" and "git merge" replaces
26 * them using setup_unpack_trees_porcelain(), for example.
28 static const char *unpack_plumbing_errors
[NB_UNPACK_TREES_ERROR_TYPES
] = {
29 /* ERROR_WOULD_OVERWRITE */
30 "Entry '%s' would be overwritten by merge. Cannot merge.",
32 /* ERROR_NOT_UPTODATE_FILE */
33 "Entry '%s' not uptodate. Cannot merge.",
35 /* ERROR_NOT_UPTODATE_DIR */
36 "Updating '%s' would lose untracked files in it",
38 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
39 "Untracked working tree file '%s' would be overwritten by merge.",
41 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
42 "Untracked working tree file '%s' would be removed by merge.",
44 /* ERROR_BIND_OVERLAP */
45 "Entry '%s' overlaps with '%s'. Cannot bind.",
47 /* ERROR_SPARSE_NOT_UPTODATE_FILE */
48 "Entry '%s' not uptodate. Cannot update sparse checkout.",
50 /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
51 "Working tree file '%s' would be overwritten by sparse checkout update.",
53 /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
54 "Working tree file '%s' would be removed by sparse checkout update.",
56 /* ERROR_WOULD_LOSE_SUBMODULE */
57 "Submodule '%s' cannot checkout new HEAD.",
60 #define ERRORMSG(o,type) \
61 ( ((o) && (o)->msgs[(type)]) \
62 ? ((o)->msgs[(type)]) \
63 : (unpack_plumbing_errors[(type)]) )
65 static const char *super_prefixed(const char *path
)
68 * It is necessary and sufficient to have two static buffers
69 * here, as the return value of this function is fed to
70 * error() using the unpack_*_errors[] templates we see above.
72 static struct strbuf buf
[2] = {STRBUF_INIT
, STRBUF_INIT
};
73 static int super_prefix_len
= -1;
74 static unsigned idx
= ARRAY_SIZE(buf
) - 1;
76 if (super_prefix_len
< 0) {
77 const char *super_prefix
= get_super_prefix();
82 for (i
= 0; i
< ARRAY_SIZE(buf
); i
++)
83 strbuf_addstr(&buf
[i
], super_prefix
);
84 super_prefix_len
= buf
[0].len
;
88 if (!super_prefix_len
)
91 if (++idx
>= ARRAY_SIZE(buf
))
94 strbuf_setlen(&buf
[idx
], super_prefix_len
);
95 strbuf_addstr(&buf
[idx
], path
);
100 void setup_unpack_trees_porcelain(struct unpack_trees_options
*opts
,
104 const char **msgs
= opts
->msgs
;
107 argv_array_init(&opts
->msgs_to_free
);
109 if (!strcmp(cmd
, "checkout"))
110 msg
= advice_commit_before_merge
111 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
112 "Please commit your changes or stash them before you switch branches.")
113 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
114 else if (!strcmp(cmd
, "merge"))
115 msg
= advice_commit_before_merge
116 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
117 "Please commit your changes or stash them before you merge.")
118 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
120 msg
= advice_commit_before_merge
121 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
122 "Please commit your changes or stash them before you %s.")
123 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
124 msgs
[ERROR_WOULD_OVERWRITE
] = msgs
[ERROR_NOT_UPTODATE_FILE
] =
125 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
127 msgs
[ERROR_NOT_UPTODATE_DIR
] =
128 _("Updating the following directories would lose untracked files in them:\n%s");
130 if (!strcmp(cmd
, "checkout"))
131 msg
= advice_commit_before_merge
132 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
133 "Please move or remove them before you switch branches.")
134 : _("The following untracked working tree files would be removed by checkout:\n%%s");
135 else if (!strcmp(cmd
, "merge"))
136 msg
= advice_commit_before_merge
137 ? _("The following untracked working tree files would be removed by merge:\n%%s"
138 "Please move or remove them before you merge.")
139 : _("The following untracked working tree files would be removed by merge:\n%%s");
141 msg
= advice_commit_before_merge
142 ? _("The following untracked working tree files would be removed by %s:\n%%s"
143 "Please move or remove them before you %s.")
144 : _("The following untracked working tree files would be removed by %s:\n%%s");
145 msgs
[ERROR_WOULD_LOSE_UNTRACKED_REMOVED
] =
146 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
148 if (!strcmp(cmd
, "checkout"))
149 msg
= advice_commit_before_merge
150 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
151 "Please move or remove them before you switch branches.")
152 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
153 else if (!strcmp(cmd
, "merge"))
154 msg
= advice_commit_before_merge
155 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
156 "Please move or remove them before you merge.")
157 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
159 msg
= advice_commit_before_merge
160 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
161 "Please move or remove them before you %s.")
162 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
163 msgs
[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
] =
164 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
167 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
168 * cannot easily display it as a list.
170 msgs
[ERROR_BIND_OVERLAP
] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
172 msgs
[ERROR_SPARSE_NOT_UPTODATE_FILE
] =
173 _("Cannot update sparse checkout: the following entries are not up to date:\n%s");
174 msgs
[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
] =
175 _("The following working tree files would be overwritten by sparse checkout update:\n%s");
176 msgs
[ERROR_WOULD_LOSE_ORPHANED_REMOVED
] =
177 _("The following working tree files would be removed by sparse checkout update:\n%s");
178 msgs
[ERROR_WOULD_LOSE_SUBMODULE
] =
179 _("Cannot update submodule:\n%s");
181 opts
->show_all_errors
= 1;
182 /* rejected paths may not have a static buffer */
183 for (i
= 0; i
< ARRAY_SIZE(opts
->unpack_rejects
); i
++)
184 opts
->unpack_rejects
[i
].strdup_strings
= 1;
187 void clear_unpack_trees_porcelain(struct unpack_trees_options
*opts
)
189 argv_array_clear(&opts
->msgs_to_free
);
190 memset(opts
->msgs
, 0, sizeof(opts
->msgs
));
193 static int do_add_entry(struct unpack_trees_options
*o
, struct cache_entry
*ce
,
194 unsigned int set
, unsigned int clear
)
201 ce
->ce_flags
= (ce
->ce_flags
& ~clear
) | set
;
202 return add_index_entry(&o
->result
, ce
,
203 ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
206 static void add_entry(struct unpack_trees_options
*o
,
207 const struct cache_entry
*ce
,
208 unsigned int set
, unsigned int clear
)
210 do_add_entry(o
, dup_cache_entry(ce
, &o
->result
), set
, clear
);
214 * add error messages on path <path>
215 * corresponding to the type <e> with the message <msg>
216 * indicating if it should be display in porcelain or not
218 static int add_rejected_path(struct unpack_trees_options
*o
,
219 enum unpack_trees_error_types e
,
222 if (!o
->show_all_errors
)
223 return error(ERRORMSG(o
, e
), super_prefixed(path
));
226 * Otherwise, insert in a list for future display by
227 * display_error_msgs()
229 string_list_append(&o
->unpack_rejects
[e
], path
);
234 * display all the error messages stored in a nice way
236 static void display_error_msgs(struct unpack_trees_options
*o
)
239 int something_displayed
= 0;
240 for (e
= 0; e
< NB_UNPACK_TREES_ERROR_TYPES
; e
++) {
241 struct string_list
*rejects
= &o
->unpack_rejects
[e
];
242 if (rejects
->nr
> 0) {
243 struct strbuf path
= STRBUF_INIT
;
244 something_displayed
= 1;
245 for (i
= 0; i
< rejects
->nr
; i
++)
246 strbuf_addf(&path
, "\t%s\n", rejects
->items
[i
].string
);
247 error(ERRORMSG(o
, e
), super_prefixed(path
.buf
));
248 strbuf_release(&path
);
250 string_list_clear(rejects
, 0);
252 if (something_displayed
)
253 fprintf(stderr
, _("Aborting\n"));
256 static int check_submodule_move_head(const struct cache_entry
*ce
,
259 struct unpack_trees_options
*o
)
261 unsigned flags
= SUBMODULE_MOVE_HEAD_DRY_RUN
;
262 const struct submodule
*sub
= submodule_from_ce(ce
);
268 flags
|= SUBMODULE_MOVE_HEAD_FORCE
;
270 if (submodule_move_head(ce
->name
, old_id
, new_id
, flags
))
271 return o
->gently
? -1 :
272 add_rejected_path(o
, ERROR_WOULD_LOSE_SUBMODULE
, ce
->name
);
277 * Preform the loading of the repository's gitmodules file. This function is
278 * used by 'check_update()' to perform loading of the gitmodules file in two
279 * differnt situations:
280 * (1) before removing entries from the working tree if the gitmodules file has
281 * been marked for removal. This situation is specified by 'state' == NULL.
282 * (2) before checking out entries to the working tree if the gitmodules file
283 * has been marked for update. This situation is specified by 'state' != NULL.
285 static void load_gitmodules_file(struct index_state
*index
,
286 struct checkout
*state
)
288 int pos
= index_name_pos(index
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
291 struct cache_entry
*ce
= index
->cache
[pos
];
292 if (!state
&& ce
->ce_flags
& CE_WT_REMOVE
) {
293 repo_read_gitmodules(the_repository
);
294 } else if (state
&& (ce
->ce_flags
& CE_UPDATE
)) {
295 submodule_free(the_repository
);
296 checkout_entry(ce
, state
, NULL
, NULL
);
297 repo_read_gitmodules(the_repository
);
303 * Unlink the last component and schedule the leading directories for
304 * removal, such that empty directories get removed.
306 static void unlink_entry(const struct cache_entry
*ce
)
308 const struct submodule
*sub
= submodule_from_ce(ce
);
310 /* state.force is set at the caller. */
311 submodule_move_head(ce
->name
, "HEAD", NULL
,
312 SUBMODULE_MOVE_HEAD_FORCE
);
314 if (!check_leading_path(ce
->name
, ce_namelen(ce
)))
316 if (remove_or_warn(ce
->ce_mode
, ce
->name
))
318 schedule_dir_for_removal(ce
->name
, ce_namelen(ce
));
321 static struct progress
*get_progress(struct unpack_trees_options
*o
)
323 unsigned cnt
= 0, total
= 0;
324 struct index_state
*index
= &o
->result
;
326 if (!o
->update
|| !o
->verbose_update
)
329 for (; cnt
< index
->cache_nr
; cnt
++) {
330 const struct cache_entry
*ce
= index
->cache
[cnt
];
331 if (ce
->ce_flags
& (CE_UPDATE
| CE_WT_REMOVE
))
335 return start_delayed_progress(_("Checking out files"), total
);
338 static void setup_collided_checkout_detection(struct checkout
*state
,
339 struct index_state
*index
)
344 for (i
= 0; i
< index
->cache_nr
; i
++)
345 index
->cache
[i
]->ce_flags
&= ~CE_MATCHED
;
348 static void report_collided_checkout(struct index_state
*index
)
350 struct string_list list
= STRING_LIST_INIT_NODUP
;
353 for (i
= 0; i
< index
->cache_nr
; i
++) {
354 struct cache_entry
*ce
= index
->cache
[i
];
356 if (!(ce
->ce_flags
& CE_MATCHED
))
359 string_list_append(&list
, ce
->name
);
360 ce
->ce_flags
&= ~CE_MATCHED
;
363 list
.cmp
= fspathcmp
;
364 string_list_sort(&list
);
367 warning(_("the following paths have collided (e.g. case-sensitive paths\n"
368 "on a case-insensitive filesystem) and only one from the same\n"
369 "colliding group is in the working tree:\n"));
371 for (i
= 0; i
< list
.nr
; i
++)
372 fprintf(stderr
, " '%s'\n", list
.items
[i
].string
);
375 string_list_clear(&list
, 0);
378 static int check_updates(struct unpack_trees_options
*o
)
382 struct progress
*progress
;
383 struct index_state
*index
= &o
->result
;
384 struct checkout state
= CHECKOUT_INIT
;
387 trace_performance_enter();
390 state
.refresh_cache
= 1;
391 state
.istate
= index
;
394 setup_collided_checkout_detection(&state
, index
);
396 progress
= get_progress(o
);
399 git_attr_set_direction(GIT_ATTR_CHECKOUT
);
401 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
402 load_gitmodules_file(index
, NULL
);
404 for (i
= 0; i
< index
->cache_nr
; i
++) {
405 const struct cache_entry
*ce
= index
->cache
[i
];
407 if (ce
->ce_flags
& CE_WT_REMOVE
) {
408 display_progress(progress
, ++cnt
);
409 if (o
->update
&& !o
->dry_run
)
413 remove_marked_cache_entries(index
);
414 remove_scheduled_dirs();
416 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
417 load_gitmodules_file(index
, &state
);
419 enable_delayed_checkout(&state
);
420 if (repository_format_partial_clone
&& o
->update
&& !o
->dry_run
) {
422 * Prefetch the objects that are to be checked out in the loop
425 struct oid_array to_fetch
= OID_ARRAY_INIT
;
426 int fetch_if_missing_store
= fetch_if_missing
;
427 fetch_if_missing
= 0;
428 for (i
= 0; i
< index
->cache_nr
; i
++) {
429 struct cache_entry
*ce
= index
->cache
[i
];
430 if ((ce
->ce_flags
& CE_UPDATE
) &&
431 !S_ISGITLINK(ce
->ce_mode
)) {
432 if (!has_object_file(&ce
->oid
))
433 oid_array_append(&to_fetch
, &ce
->oid
);
437 fetch_objects(repository_format_partial_clone
,
438 to_fetch
.oid
, to_fetch
.nr
);
439 fetch_if_missing
= fetch_if_missing_store
;
440 oid_array_clear(&to_fetch
);
442 for (i
= 0; i
< index
->cache_nr
; i
++) {
443 struct cache_entry
*ce
= index
->cache
[i
];
445 if (ce
->ce_flags
& CE_UPDATE
) {
446 if (ce
->ce_flags
& CE_WT_REMOVE
)
447 BUG("both update and delete flags are set on %s",
449 display_progress(progress
, ++cnt
);
450 ce
->ce_flags
&= ~CE_UPDATE
;
451 if (o
->update
&& !o
->dry_run
) {
452 errs
|= checkout_entry(ce
, &state
, NULL
, NULL
);
456 stop_progress(&progress
);
457 errs
|= finish_delayed_checkout(&state
, NULL
);
459 git_attr_set_direction(GIT_ATTR_CHECKIN
);
462 report_collided_checkout(index
);
464 trace_performance_leave("check_updates");
468 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
469 struct unpack_trees_options
*o
);
470 static int verify_absent_sparse(const struct cache_entry
*ce
,
471 enum unpack_trees_error_types
,
472 struct unpack_trees_options
*o
);
474 static int apply_sparse_checkout(struct index_state
*istate
,
475 struct cache_entry
*ce
,
476 struct unpack_trees_options
*o
)
478 int was_skip_worktree
= ce_skip_worktree(ce
);
480 if (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
)
481 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
483 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
484 if (was_skip_worktree
!= ce_skip_worktree(ce
)) {
485 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
486 mark_fsmonitor_invalid(istate
, ce
);
487 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
491 * if (!was_skip_worktree && !ce_skip_worktree()) {
492 * This is perfectly normal. Move on;
497 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
498 * area as a result of ce_skip_worktree() shortcuts in
499 * verify_absent() and verify_uptodate().
500 * Make sure they don't modify worktree if they are already
501 * outside checkout area
503 if (was_skip_worktree
&& ce_skip_worktree(ce
)) {
504 ce
->ce_flags
&= ~CE_UPDATE
;
507 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
508 * on to get that file removed from both index and worktree.
509 * If that file is already outside worktree area, don't
512 if (ce
->ce_flags
& CE_REMOVE
)
513 ce
->ce_flags
&= ~CE_WT_REMOVE
;
516 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
518 * If CE_UPDATE is set, verify_uptodate() must be called already
519 * also stat info may have lost after merged_entry() so calling
520 * verify_uptodate() again may fail
522 if (!(ce
->ce_flags
& CE_UPDATE
) && verify_uptodate_sparse(ce
, o
))
524 ce
->ce_flags
|= CE_WT_REMOVE
;
525 ce
->ce_flags
&= ~CE_UPDATE
;
527 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
528 if (verify_absent_sparse(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
530 ce
->ce_flags
|= CE_UPDATE
;
535 static inline int call_unpack_fn(const struct cache_entry
* const *src
,
536 struct unpack_trees_options
*o
)
538 int ret
= o
->fn(src
, o
);
544 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
546 ce
->ce_flags
|= CE_UNPACKED
;
548 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
549 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
550 int bottom
= o
->cache_bottom
;
551 while (bottom
< o
->src_index
->cache_nr
&&
552 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
554 o
->cache_bottom
= bottom
;
558 static void mark_all_ce_unused(struct index_state
*index
)
561 for (i
= 0; i
< index
->cache_nr
; i
++)
562 index
->cache
[i
]->ce_flags
&= ~(CE_UNPACKED
| CE_ADDED
| CE_NEW_SKIP_WORKTREE
);
565 static int locate_in_src_index(const struct cache_entry
*ce
,
566 struct unpack_trees_options
*o
)
568 struct index_state
*index
= o
->src_index
;
569 int len
= ce_namelen(ce
);
570 int pos
= index_name_pos(index
, ce
->name
, len
);
577 * We call unpack_index_entry() with an unmerged cache entry
578 * only in diff-index, and it wants a single callback. Skip
579 * the other unmerged entry with the same name.
581 static void mark_ce_used_same_name(struct cache_entry
*ce
,
582 struct unpack_trees_options
*o
)
584 struct index_state
*index
= o
->src_index
;
585 int len
= ce_namelen(ce
);
588 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
589 struct cache_entry
*next
= index
->cache
[pos
];
590 if (len
!= ce_namelen(next
) ||
591 memcmp(ce
->name
, next
->name
, len
))
593 mark_ce_used(next
, o
);
597 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
599 const struct index_state
*index
= o
->src_index
;
600 int pos
= o
->cache_bottom
;
602 while (pos
< index
->cache_nr
) {
603 struct cache_entry
*ce
= index
->cache
[pos
];
604 if (!(ce
->ce_flags
& CE_UNPACKED
))
611 static void add_same_unmerged(const struct cache_entry
*ce
,
612 struct unpack_trees_options
*o
)
614 struct index_state
*index
= o
->src_index
;
615 int len
= ce_namelen(ce
);
616 int pos
= index_name_pos(index
, ce
->name
, len
);
619 die("programming error in a caller of mark_ce_used_same_name");
620 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
621 struct cache_entry
*next
= index
->cache
[pos
];
622 if (len
!= ce_namelen(next
) ||
623 memcmp(ce
->name
, next
->name
, len
))
625 add_entry(o
, next
, 0, 0);
626 mark_ce_used(next
, o
);
630 static int unpack_index_entry(struct cache_entry
*ce
,
631 struct unpack_trees_options
*o
)
633 const struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
640 if (o
->skip_unmerged
) {
641 add_entry(o
, ce
, 0, 0);
645 ret
= call_unpack_fn(src
, o
);
647 mark_ce_used_same_name(ce
, o
);
651 static int find_cache_pos(struct traverse_info
*, const struct name_entry
*);
653 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
655 struct unpack_trees_options
*o
= info
->data
;
657 if (o
->diff_index_cached
)
659 o
->cache_bottom
= bottom
;
662 static int switch_cache_bottom(struct traverse_info
*info
)
664 struct unpack_trees_options
*o
= info
->data
;
667 if (o
->diff_index_cached
)
669 ret
= o
->cache_bottom
;
670 pos
= find_cache_pos(info
->prev
, &info
->name
);
673 o
->cache_bottom
= -2 - pos
;
675 o
->cache_bottom
= o
->src_index
->cache_nr
;
679 static inline int are_same_oid(struct name_entry
*name_j
, struct name_entry
*name_k
)
681 return !is_null_oid(&name_j
->oid
) && !is_null_oid(&name_k
->oid
) && oideq(&name_j
->oid
, &name_k
->oid
);
684 static int all_trees_same_as_cache_tree(int n
, unsigned long dirmask
,
685 struct name_entry
*names
,
686 struct traverse_info
*info
)
688 struct unpack_trees_options
*o
= info
->data
;
691 if (!o
->merge
|| dirmask
!= ((1 << n
) - 1))
694 for (i
= 1; i
< n
; i
++)
695 if (!are_same_oid(names
, names
+ i
))
698 return cache_tree_matches_traversal(o
->src_index
->cache_tree
, names
, info
);
701 static int index_pos_by_traverse_info(struct name_entry
*names
,
702 struct traverse_info
*info
)
704 struct unpack_trees_options
*o
= info
->data
;
705 int len
= traverse_path_len(info
, names
);
706 char *name
= xmalloc(len
+ 1 /* slash */ + 1 /* NUL */);
709 make_traverse_path(name
, info
, names
);
712 pos
= index_name_pos(o
->src_index
, name
, len
);
714 BUG("This is a directory and should not exist in index");
716 if (!starts_with(o
->src_index
->cache
[pos
]->name
, name
) ||
717 (pos
> 0 && starts_with(o
->src_index
->cache
[pos
-1]->name
, name
)))
718 BUG("pos must point at the first entry in this directory");
724 * Fast path if we detect that all trees are the same as cache-tree at this
725 * path. We'll walk these trees in an iterative loop using cache-tree/index
726 * instead of ODB since we already know what these trees contain.
728 static int traverse_by_cache_tree(int pos
, int nr_entries
, int nr_names
,
729 struct name_entry
*names
,
730 struct traverse_info
*info
)
732 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
733 struct unpack_trees_options
*o
= info
->data
;
734 struct cache_entry
*tree_ce
= NULL
;
739 BUG("We need cache-tree to do this optimization");
742 * Do what unpack_callback() and unpack_nondirectories() normally
743 * do. But we walk all paths in an iterative loop instead.
745 * D/F conflicts and higher stage entries are not a concern
746 * because cache-tree would be invalidated and we would never
747 * get here in the first place.
749 for (i
= 0; i
< nr_entries
; i
++) {
750 int new_ce_len
, len
, rc
;
752 src
[0] = o
->src_index
->cache
[pos
+ i
];
754 len
= ce_namelen(src
[0]);
755 new_ce_len
= cache_entry_size(len
);
757 if (new_ce_len
> ce_len
) {
759 tree_ce
= xrealloc(tree_ce
, new_ce_len
);
760 memset(tree_ce
, 0, new_ce_len
);
763 tree_ce
->ce_flags
= create_ce_flags(0);
765 for (d
= 1; d
<= nr_names
; d
++)
769 tree_ce
->ce_mode
= src
[0]->ce_mode
;
770 tree_ce
->ce_namelen
= len
;
771 oidcpy(&tree_ce
->oid
, &src
[0]->oid
);
772 memcpy(tree_ce
->name
, src
[0]->name
, len
+ 1);
774 rc
= call_unpack_fn((const struct cache_entry
* const *)src
, o
);
780 mark_ce_used(src
[0], o
);
784 printf("Unpacked %d entries from %s to %s using cache-tree\n",
786 o
->src_index
->cache
[pos
]->name
,
787 o
->src_index
->cache
[pos
+ nr_entries
- 1]->name
);
791 static int traverse_trees_recursive(int n
, unsigned long dirmask
,
792 unsigned long df_conflicts
,
793 struct name_entry
*names
,
794 struct traverse_info
*info
)
796 struct unpack_trees_options
*o
= info
->data
;
799 struct tree_desc t
[MAX_UNPACK_TREES
];
800 void *buf
[MAX_UNPACK_TREES
];
801 struct traverse_info newinfo
;
802 struct name_entry
*p
;
805 nr_entries
= all_trees_same_as_cache_tree(n
, dirmask
, names
, info
);
806 if (nr_entries
> 0) {
807 int pos
= index_pos_by_traverse_info(names
, info
);
809 if (!o
->merge
|| df_conflicts
)
810 BUG("Wrong condition to get here buddy");
813 * All entries up to 'pos' must have been processed
814 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
815 * save and restore cache_bottom anyway to not miss
816 * unprocessed entries before 'pos'.
818 bottom
= o
->cache_bottom
;
819 ret
= traverse_by_cache_tree(pos
, nr_entries
, n
, names
, info
);
820 o
->cache_bottom
= bottom
;
830 newinfo
.pathspec
= info
->pathspec
;
832 newinfo
.pathlen
+= tree_entry_len(p
) + 1;
833 newinfo
.df_conflicts
|= df_conflicts
;
836 * Fetch the tree from the ODB for each peer directory in the
839 * For 2- and 3-way traversals, we try to avoid hitting the
840 * ODB twice for the same OID. This should yield a nice speed
841 * up in checkouts and merges when the commits are similar.
843 * We don't bother doing the full O(n^2) search for larger n,
844 * because wider traversals don't happen that often and we
845 * avoid the search setup.
847 * When 2 peer OIDs are the same, we just copy the tree
848 * descriptor data. This implicitly borrows the buffer
849 * data from the earlier cell.
851 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
852 if (i
> 0 && are_same_oid(&names
[i
], &names
[i
- 1]))
854 else if (i
> 1 && are_same_oid(&names
[i
], &names
[i
- 2]))
857 const struct object_id
*oid
= NULL
;
860 buf
[nr_buf
++] = fill_tree_descriptor(t
+ i
, oid
);
864 bottom
= switch_cache_bottom(&newinfo
);
865 ret
= traverse_trees(o
->src_index
, n
, t
, &newinfo
);
866 restore_cache_bottom(&newinfo
, bottom
);
868 for (i
= 0; i
< nr_buf
; i
++)
875 * Compare the traverse-path to the cache entry without actually
876 * having to generate the textual representation of the traverse
879 * NOTE! This *only* compares up to the size of the traverse path
880 * itself - the caller needs to do the final check for the cache
881 * entry having more data at the end!
883 static int do_compare_entry_piecewise(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
885 int len
, pathlen
, ce_len
;
889 int cmp
= do_compare_entry_piecewise(ce
, info
->prev
,
894 pathlen
= info
->pathlen
;
895 ce_len
= ce_namelen(ce
);
897 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
898 if (ce_len
< pathlen
)
902 ce_name
= ce
->name
+ pathlen
;
904 len
= tree_entry_len(n
);
905 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
908 static int do_compare_entry(const struct cache_entry
*ce
,
909 const struct traverse_info
*info
,
910 const struct name_entry
*n
)
912 int len
, pathlen
, ce_len
;
917 * If we have not precomputed the traverse path, it is quicker
918 * to avoid doing so. But if we have precomputed it,
919 * it is quicker to use the precomputed version.
921 if (!info
->traverse_path
)
922 return do_compare_entry_piecewise(ce
, info
, n
);
924 cmp
= strncmp(ce
->name
, info
->traverse_path
, info
->pathlen
);
928 pathlen
= info
->pathlen
;
929 ce_len
= ce_namelen(ce
);
931 if (ce_len
< pathlen
)
935 ce_name
= ce
->name
+ pathlen
;
937 len
= tree_entry_len(n
);
938 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
941 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
943 int cmp
= do_compare_entry(ce
, info
, n
);
948 * Even if the beginning compared identically, the ce should
949 * compare as bigger than a directory leading up to it!
951 return ce_namelen(ce
) > traverse_path_len(info
, n
);
954 static int ce_in_traverse_path(const struct cache_entry
*ce
,
955 const struct traverse_info
*info
)
959 if (do_compare_entry(ce
, info
->prev
, &info
->name
))
962 * If ce (blob) is the same name as the path (which is a tree
963 * we will be descending into), it won't be inside it.
965 return (info
->pathlen
< ce_namelen(ce
));
968 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
,
969 const struct name_entry
*n
,
971 struct index_state
*istate
,
974 int len
= traverse_path_len(info
, n
);
975 struct cache_entry
*ce
=
977 make_empty_transient_cache_entry(len
) :
978 make_empty_cache_entry(istate
, len
);
980 ce
->ce_mode
= create_ce_mode(n
->mode
);
981 ce
->ce_flags
= create_ce_flags(stage
);
982 ce
->ce_namelen
= len
;
983 oidcpy(&ce
->oid
, &n
->oid
);
984 make_traverse_path(ce
->name
, info
, n
);
990 * Note that traverse_by_cache_tree() duplicates some logic in this function
991 * without actually calling it. If you change the logic here you may need to
992 * check and change there as well.
994 static int unpack_nondirectories(int n
, unsigned long mask
,
995 unsigned long dirmask
,
996 struct cache_entry
**src
,
997 const struct name_entry
*names
,
998 const struct traverse_info
*info
)
1001 struct unpack_trees_options
*o
= info
->data
;
1002 unsigned long conflicts
= info
->df_conflicts
| dirmask
;
1004 /* Do we have *only* directories? Nothing to do */
1005 if (mask
== dirmask
&& !src
[0])
1009 * Ok, we've filled in up to any potential index entry in src[0],
1012 for (i
= 0; i
< n
; i
++) {
1014 unsigned int bit
= 1ul << i
;
1015 if (conflicts
& bit
) {
1016 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
1023 else if (i
+ 1 < o
->head_idx
)
1025 else if (i
+ 1 > o
->head_idx
)
1031 * If the merge bit is set, then the cache entries are
1032 * discarded in the following block. In this case,
1033 * construct "transient" cache_entries, as they are
1034 * not stored in the index. otherwise construct the
1035 * cache entry from the index aware logic.
1037 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
, &o
->result
, o
->merge
);
1041 int rc
= call_unpack_fn((const struct cache_entry
* const *)src
,
1043 for (i
= 0; i
< n
; i
++) {
1044 struct cache_entry
*ce
= src
[i
+ o
->merge
];
1045 if (ce
!= o
->df_conflict_entry
)
1046 discard_cache_entry(ce
);
1051 for (i
= 0; i
< n
; i
++)
1052 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
1053 if (do_add_entry(o
, src
[i
], 0, 0))
1059 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
1061 discard_index(&o
->result
);
1062 if (!o
->gently
&& !o
->exiting_early
) {
1064 return error("%s", message
);
1071 * The tree traversal is looking at name p. If we have a matching entry,
1072 * return it. If name p is a directory in the index, do not return
1073 * anything, as we will want to match it when the traversal descends into
1076 static int find_cache_pos(struct traverse_info
*info
,
1077 const struct name_entry
*p
)
1080 struct unpack_trees_options
*o
= info
->data
;
1081 struct index_state
*index
= o
->src_index
;
1082 int pfxlen
= info
->pathlen
;
1083 int p_len
= tree_entry_len(p
);
1085 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
1086 const struct cache_entry
*ce
= index
->cache
[pos
];
1087 const char *ce_name
, *ce_slash
;
1090 if (ce
->ce_flags
& CE_UNPACKED
) {
1092 * cache_bottom entry is already unpacked, so
1093 * we can never match it; don't check it
1096 if (pos
== o
->cache_bottom
)
1100 if (!ce_in_traverse_path(ce
, info
)) {
1102 * Check if we can skip future cache checks
1103 * (because we're already past all possible
1104 * entries in the traverse path).
1106 if (info
->traverse_path
) {
1107 if (strncmp(ce
->name
, info
->traverse_path
,
1113 ce_name
= ce
->name
+ pfxlen
;
1114 ce_slash
= strchr(ce_name
, '/');
1116 ce_len
= ce_slash
- ce_name
;
1118 ce_len
= ce_namelen(ce
) - pfxlen
;
1119 cmp
= name_compare(p
->path
, p_len
, ce_name
, ce_len
);
1121 * Exact match; if we have a directory we need to
1122 * delay returning it.
1125 return ce_slash
? -2 - pos
: pos
;
1127 continue; /* keep looking */
1129 * ce_name sorts after p->path; could it be that we
1130 * have files under p->path directory in the index?
1131 * E.g. ce_name == "t-i", and p->path == "t"; we may
1132 * have "t/a" in the index.
1134 if (p_len
< ce_len
&& !memcmp(ce_name
, p
->path
, p_len
) &&
1135 ce_name
[p_len
] < '/')
1136 continue; /* keep looking */
1142 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
1143 const struct name_entry
*p
)
1145 int pos
= find_cache_pos(info
, p
);
1146 struct unpack_trees_options
*o
= info
->data
;
1149 return o
->src_index
->cache
[pos
];
1154 static void debug_path(struct traverse_info
*info
)
1157 debug_path(info
->prev
);
1158 if (*info
->prev
->name
.path
)
1161 printf("%s", info
->name
.path
);
1164 static void debug_name_entry(int i
, struct name_entry
*n
)
1166 printf("ent#%d %06o %s\n", i
,
1167 n
->path
? n
->mode
: 0,
1168 n
->path
? n
->path
: "(missing)");
1171 static void debug_unpack_callback(int n
,
1173 unsigned long dirmask
,
1174 struct name_entry
*names
,
1175 struct traverse_info
*info
)
1178 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1182 for (i
= 0; i
< n
; i
++)
1183 debug_name_entry(i
, names
+ i
);
1187 * Note that traverse_by_cache_tree() duplicates some logic in this function
1188 * without actually calling it. If you change the logic here you may need to
1189 * check and change there as well.
1191 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
1193 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
1194 struct unpack_trees_options
*o
= info
->data
;
1195 const struct name_entry
*p
= names
;
1197 /* Find first entry with a real name (we could use "mask" too) */
1201 if (o
->debug_unpack
)
1202 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
1204 /* Are we supposed to look at the index too? */
1208 struct cache_entry
*ce
;
1210 if (o
->diff_index_cached
)
1211 ce
= next_cache_entry(o
);
1213 ce
= find_cache_entry(info
, p
);
1217 cmp
= compare_entry(ce
, info
, p
);
1219 if (unpack_index_entry(ce
, o
) < 0)
1220 return unpack_failed(o
, NULL
);
1226 * If we skip unmerged index
1227 * entries, we'll skip this
1228 * entry *and* the tree
1229 * entries associated with it!
1231 if (o
->skip_unmerged
) {
1232 add_same_unmerged(ce
, o
);
1242 if (unpack_nondirectories(n
, mask
, dirmask
, src
, names
, info
) < 0)
1245 if (o
->merge
&& src
[0]) {
1246 if (ce_stage(src
[0]))
1247 mark_ce_used_same_name(src
[0], o
);
1249 mark_ce_used(src
[0], o
);
1252 /* Now handle any directories.. */
1254 /* special case: "diff-index --cached" looking at a tree */
1255 if (o
->diff_index_cached
&&
1256 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
1258 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
1261 * Everything under the name matches; skip the
1262 * entire hierarchy. diff_index_cached codepath
1263 * special cases D/F conflicts in such a way that
1264 * it does not do any look-ahead, so this is safe.
1267 o
->cache_bottom
+= matches
;
1272 if (traverse_trees_recursive(n
, dirmask
, mask
& ~dirmask
,
1281 static int clear_ce_flags_1(struct index_state
*istate
,
1282 struct cache_entry
**cache
, int nr
,
1283 struct strbuf
*prefix
,
1284 int select_mask
, int clear_mask
,
1285 struct exclude_list
*el
, int defval
);
1287 /* Whole directory matching */
1288 static int clear_ce_flags_dir(struct index_state
*istate
,
1289 struct cache_entry
**cache
, int nr
,
1290 struct strbuf
*prefix
,
1292 int select_mask
, int clear_mask
,
1293 struct exclude_list
*el
, int defval
)
1295 struct cache_entry
**cache_end
;
1297 int ret
= is_excluded_from_list(prefix
->buf
, prefix
->len
,
1298 basename
, &dtype
, el
, istate
);
1301 strbuf_addch(prefix
, '/');
1303 /* If undecided, use matching result of parent dir in defval */
1307 for (cache_end
= cache
; cache_end
!= cache
+ nr
; cache_end
++) {
1308 struct cache_entry
*ce
= *cache_end
;
1309 if (strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1314 * TODO: check el, if there are no patterns that may conflict
1315 * with ret (iow, we know in advance the incl/excl
1316 * decision for the entire directory), clear flag here without
1317 * calling clear_ce_flags_1(). That function will call
1318 * the expensive is_excluded_from_list() on every entry.
1320 rc
= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1322 select_mask
, clear_mask
,
1324 strbuf_setlen(prefix
, prefix
->len
- 1);
1329 * Traverse the index, find every entry that matches according to
1330 * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
1331 * number of traversed entries.
1333 * If select_mask is non-zero, only entries whose ce_flags has on of
1334 * those bits enabled are traversed.
1336 * cache : pointer to an index entry
1337 * prefix_len : an offset to its path
1339 * The current path ("prefix") including the trailing '/' is
1340 * cache[0]->name[0..(prefix_len-1)]
1341 * Top level path has prefix_len zero.
1343 static int clear_ce_flags_1(struct index_state
*istate
,
1344 struct cache_entry
**cache
, int nr
,
1345 struct strbuf
*prefix
,
1346 int select_mask
, int clear_mask
,
1347 struct exclude_list
*el
, int defval
)
1349 struct cache_entry
**cache_end
= cache
+ nr
;
1352 * Process all entries that have the given prefix and meet
1353 * select_mask condition
1355 while(cache
!= cache_end
) {
1356 struct cache_entry
*ce
= *cache
;
1357 const char *name
, *slash
;
1358 int len
, dtype
, ret
;
1360 if (select_mask
&& !(ce
->ce_flags
& select_mask
)) {
1365 if (prefix
->len
&& strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1368 name
= ce
->name
+ prefix
->len
;
1369 slash
= strchr(name
, '/');
1371 /* If it's a directory, try whole directory match first */
1376 strbuf_add(prefix
, name
, len
);
1378 processed
= clear_ce_flags_dir(istate
, cache
, cache_end
- cache
,
1380 prefix
->buf
+ prefix
->len
- len
,
1381 select_mask
, clear_mask
,
1384 /* clear_c_f_dir eats a whole dir already? */
1387 strbuf_setlen(prefix
, prefix
->len
- len
);
1391 strbuf_addch(prefix
, '/');
1392 cache
+= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1394 select_mask
, clear_mask
, el
, defval
);
1395 strbuf_setlen(prefix
, prefix
->len
- len
- 1);
1400 dtype
= ce_to_dtype(ce
);
1401 ret
= is_excluded_from_list(ce
->name
, ce_namelen(ce
),
1402 name
, &dtype
, el
, istate
);
1406 ce
->ce_flags
&= ~clear_mask
;
1409 return nr
- (cache_end
- cache
);
1412 static int clear_ce_flags(struct index_state
*istate
,
1413 int select_mask
, int clear_mask
,
1414 struct exclude_list
*el
)
1416 static struct strbuf prefix
= STRBUF_INIT
;
1418 strbuf_reset(&prefix
);
1420 return clear_ce_flags_1(istate
,
1424 select_mask
, clear_mask
,
1429 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1431 static void mark_new_skip_worktree(struct exclude_list
*el
,
1432 struct index_state
*istate
,
1433 int select_flag
, int skip_wt_flag
)
1438 * 1. Pretend the narrowest worktree: only unmerged entries
1441 for (i
= 0; i
< istate
->cache_nr
; i
++) {
1442 struct cache_entry
*ce
= istate
->cache
[i
];
1444 if (select_flag
&& !(ce
->ce_flags
& select_flag
))
1447 if (!ce_stage(ce
) && !(ce
->ce_flags
& CE_CONFLICTED
))
1448 ce
->ce_flags
|= skip_wt_flag
;
1450 ce
->ce_flags
&= ~skip_wt_flag
;
1454 * 2. Widen worktree according to sparse-checkout file.
1455 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1457 clear_ce_flags(istate
, select_flag
, skip_wt_flag
, el
);
1460 static int verify_absent(const struct cache_entry
*,
1461 enum unpack_trees_error_types
,
1462 struct unpack_trees_options
*);
1464 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1465 * resulting index, -2 on failure to reflect the changes to the work tree.
1467 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1469 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
1472 static struct cache_entry
*dfc
;
1473 struct exclude_list el
;
1475 if (len
> MAX_UNPACK_TREES
)
1476 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
1478 trace_performance_enter();
1479 memset(&el
, 0, sizeof(el
));
1480 if (!core_apply_sparse_checkout
|| !o
->update
)
1481 o
->skip_sparse_checkout
= 1;
1482 if (!o
->skip_sparse_checkout
) {
1483 char *sparse
= git_pathdup("info/sparse-checkout");
1484 if (add_excludes_from_file_to_list(sparse
, "", 0, &el
, NULL
) < 0)
1485 o
->skip_sparse_checkout
= 1;
1491 memset(&o
->result
, 0, sizeof(o
->result
));
1492 o
->result
.initialized
= 1;
1493 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
1494 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
1495 o
->result
.version
= o
->src_index
->version
;
1496 if (!o
->src_index
->split_index
) {
1497 o
->result
.split_index
= NULL
;
1498 } else if (o
->src_index
== o
->dst_index
) {
1500 * o->dst_index (and thus o->src_index) will be discarded
1501 * and overwritten with o->result at the end of this function,
1502 * so just use src_index's split_index to avoid having to
1505 o
->result
.split_index
= o
->src_index
->split_index
;
1506 o
->result
.split_index
->refcount
++;
1508 o
->result
.split_index
= init_split_index(&o
->result
);
1510 oidcpy(&o
->result
.oid
, &o
->src_index
->oid
);
1511 o
->merge_size
= len
;
1512 mark_all_ce_unused(o
->src_index
);
1515 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1517 if (!o
->skip_sparse_checkout
)
1518 mark_new_skip_worktree(o
->el
, o
->src_index
, 0, CE_NEW_SKIP_WORKTREE
);
1521 dfc
= xcalloc(1, cache_entry_size(0));
1522 o
->df_conflict_entry
= dfc
;
1525 const char *prefix
= o
->prefix
? o
->prefix
: "";
1526 struct traverse_info info
;
1528 setup_traverse_info(&info
, prefix
);
1529 info
.fn
= unpack_callback
;
1531 info
.show_all_errors
= o
->show_all_errors
;
1532 info
.pathspec
= o
->pathspec
;
1536 * Unpack existing index entries that sort before the
1537 * prefix the tree is spliced into. Note that o->merge
1538 * is always true in this case.
1541 struct cache_entry
*ce
= next_cache_entry(o
);
1544 if (ce_in_traverse_path(ce
, &info
))
1546 if (unpack_index_entry(ce
, o
) < 0)
1551 trace_performance_enter();
1552 ret
= traverse_trees(o
->src_index
, len
, t
, &info
);
1553 trace_performance_leave("traverse_trees");
1558 /* Any left-over entries in the index? */
1561 struct cache_entry
*ce
= next_cache_entry(o
);
1564 if (unpack_index_entry(ce
, o
) < 0)
1568 mark_all_ce_unused(o
->src_index
);
1570 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
1571 ret
= unpack_failed(o
, "Merge requires file-level merging");
1575 if (!o
->skip_sparse_checkout
) {
1576 int empty_worktree
= 1;
1579 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1580 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1581 * so apply_sparse_checkout() won't attempt to remove it from worktree
1583 mark_new_skip_worktree(o
->el
, &o
->result
, CE_ADDED
, CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
1586 for (i
= 0; i
< o
->result
.cache_nr
; i
++) {
1587 struct cache_entry
*ce
= o
->result
.cache
[i
];
1590 * Entries marked with CE_ADDED in merged_entry() do not have
1591 * verify_absent() check (the check is effectively disabled
1592 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1594 * Do the real check now because we have had
1595 * correct CE_NEW_SKIP_WORKTREE
1597 if (ce
->ce_flags
& CE_ADDED
&&
1598 verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
1599 if (!o
->show_all_errors
)
1604 if (apply_sparse_checkout(&o
->result
, ce
, o
)) {
1605 if (!o
->show_all_errors
)
1609 if (!ce_skip_worktree(ce
))
1616 * Sparse checkout is meant to narrow down checkout area
1617 * but it does not make sense to narrow down to empty working
1618 * tree. This is usually a mistake in sparse checkout rules.
1619 * Do not allow users to do that.
1621 if (o
->result
.cache_nr
&& empty_worktree
) {
1622 ret
= unpack_failed(o
, "Sparse checkout leaves no entry on working directory");
1627 ret
= check_updates(o
) ? (-2) : 0;
1629 move_index_extensions(&o
->result
, o
->src_index
);
1631 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
1632 cache_tree_verify(the_repository
, &o
->result
);
1633 if (!o
->result
.cache_tree
)
1634 o
->result
.cache_tree
= cache_tree();
1635 if (!cache_tree_fully_valid(o
->result
.cache_tree
))
1636 cache_tree_update(&o
->result
,
1640 discard_index(o
->dst_index
);
1641 *o
->dst_index
= o
->result
;
1643 discard_index(&o
->result
);
1645 o
->src_index
= NULL
;
1648 trace_performance_leave("unpack_trees");
1649 clear_exclude_list(&el
);
1653 if (o
->show_all_errors
)
1654 display_error_msgs(o
);
1655 mark_all_ce_unused(o
->src_index
);
1656 ret
= unpack_failed(o
, NULL
);
1657 if (o
->exiting_early
)
1662 /* Here come the merge functions */
1664 static int reject_merge(const struct cache_entry
*ce
,
1665 struct unpack_trees_options
*o
)
1667 return o
->gently
? -1 :
1668 add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
1671 static int same(const struct cache_entry
*a
, const struct cache_entry
*b
)
1677 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
1679 return a
->ce_mode
== b
->ce_mode
&&
1680 oideq(&a
->oid
, &b
->oid
);
1685 * When a CE gets turned into an unmerged entry, we
1686 * want it to be up-to-date
1688 static int verify_uptodate_1(const struct cache_entry
*ce
,
1689 struct unpack_trees_options
*o
,
1690 enum unpack_trees_error_types error_type
)
1698 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1699 * if this entry is truly up-to-date because this file may be
1702 if ((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
))
1703 ; /* keep checking */
1704 else if (o
->reset
|| ce_uptodate(ce
))
1707 if (!lstat(ce
->name
, &st
)) {
1708 int flags
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
;
1709 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, flags
);
1711 if (submodule_from_ce(ce
)) {
1712 int r
= check_submodule_move_head(ce
,
1713 "HEAD", oid_to_hex(&ce
->oid
), o
);
1715 return o
->gently
? -1 :
1716 add_rejected_path(o
, error_type
, ce
->name
);
1723 * Historic default policy was to allow submodule to be out
1724 * of sync wrt the superproject index. If the submodule was
1725 * not considered interesting above, we don't care here.
1727 if (S_ISGITLINK(ce
->ce_mode
))
1732 if (errno
== ENOENT
)
1734 return o
->gently
? -1 :
1735 add_rejected_path(o
, error_type
, ce
->name
);
1738 int verify_uptodate(const struct cache_entry
*ce
,
1739 struct unpack_trees_options
*o
)
1741 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1743 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
1746 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
1747 struct unpack_trees_options
*o
)
1749 return verify_uptodate_1(ce
, o
, ERROR_SPARSE_NOT_UPTODATE_FILE
);
1753 * TODO: We should actually invalidate o->result, not src_index [1].
1754 * But since cache tree and untracked cache both are not copied to
1755 * o->result until unpacking is complete, we invalidate them on
1756 * src_index instead with the assumption that they will be copied to
1757 * dst_index at the end.
1759 * [1] src_index->cache_tree is also used in unpack_callback() so if
1760 * we invalidate o->result, we need to update it to use
1761 * o->result.cache_tree as well.
1763 static void invalidate_ce_path(const struct cache_entry
*ce
,
1764 struct unpack_trees_options
*o
)
1768 cache_tree_invalidate_path(o
->src_index
, ce
->name
);
1769 untracked_cache_invalidate_path(o
->src_index
, ce
->name
, 1);
1773 * Check that checking out ce->sha1 in subdir ce->name is not
1774 * going to overwrite any working files.
1776 * Currently, git does not checkout subprojects during a superproject
1777 * checkout, so it is not going to overwrite anything.
1779 static int verify_clean_submodule(const char *old_sha1
,
1780 const struct cache_entry
*ce
,
1781 enum unpack_trees_error_types error_type
,
1782 struct unpack_trees_options
*o
)
1784 if (!submodule_from_ce(ce
))
1787 return check_submodule_move_head(ce
, old_sha1
,
1788 oid_to_hex(&ce
->oid
), o
);
1791 static int verify_clean_subdirectory(const struct cache_entry
*ce
,
1792 enum unpack_trees_error_types error_type
,
1793 struct unpack_trees_options
*o
)
1796 * we are about to extract "ce->name"; we would not want to lose
1797 * anything in the existing directory there.
1801 struct dir_struct d
;
1805 if (S_ISGITLINK(ce
->ce_mode
)) {
1806 struct object_id oid
;
1807 int sub_head
= resolve_gitlink_ref(ce
->name
, "HEAD", &oid
);
1809 * If we are not going to update the submodule, then
1812 if (!sub_head
&& oideq(&oid
, &ce
->oid
))
1814 return verify_clean_submodule(sub_head
? NULL
: oid_to_hex(&oid
),
1819 * First let's make sure we do not have a local modification
1820 * in that directory.
1822 namelen
= ce_namelen(ce
);
1823 for (i
= locate_in_src_index(ce
, o
);
1824 i
< o
->src_index
->cache_nr
;
1826 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
1827 int len
= ce_namelen(ce2
);
1828 if (len
< namelen
||
1829 strncmp(ce
->name
, ce2
->name
, namelen
) ||
1830 ce2
->name
[namelen
] != '/')
1833 * ce2->name is an entry in the subdirectory to be
1836 if (!ce_stage(ce2
)) {
1837 if (verify_uptodate(ce2
, o
))
1839 add_entry(o
, ce2
, CE_REMOVE
, 0);
1840 invalidate_ce_path(ce
, o
);
1841 mark_ce_used(ce2
, o
);
1847 * Then we need to make sure that we do not lose a locally
1848 * present file that is not ignored.
1850 pathbuf
= xstrfmt("%.*s/", namelen
, ce
->name
);
1852 memset(&d
, 0, sizeof(d
));
1854 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
1855 i
= read_directory(&d
, o
->src_index
, pathbuf
, namelen
+1, NULL
);
1857 return o
->gently
? -1 :
1858 add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
1864 * This gets called when there was no index entry for the tree entry 'dst',
1865 * but we found a file in the working tree that 'lstat()' said was fine,
1866 * and we're on a case-insensitive filesystem.
1868 * See if we can find a case-insensitive match in the index that also
1869 * matches the stat information, and assume it's that other file!
1871 static int icase_exists(struct unpack_trees_options
*o
, const char *name
, int len
, struct stat
*st
)
1873 const struct cache_entry
*src
;
1875 src
= index_file_exists(o
->src_index
, name
, len
, 1);
1876 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
1879 static int check_ok_to_remove(const char *name
, int len
, int dtype
,
1880 const struct cache_entry
*ce
, struct stat
*st
,
1881 enum unpack_trees_error_types error_type
,
1882 struct unpack_trees_options
*o
)
1884 const struct cache_entry
*result
;
1887 * It may be that the 'lstat()' succeeded even though
1888 * target 'ce' was absent, because there is an old
1889 * entry that is different only in case..
1891 * Ignore that lstat() if it matches.
1893 if (ignore_case
&& icase_exists(o
, name
, len
, st
))
1897 is_excluded(o
->dir
, o
->src_index
, name
, &dtype
))
1899 * ce->name is explicitly excluded, so it is Ok to
1903 if (S_ISDIR(st
->st_mode
)) {
1905 * We are checking out path "foo" and
1906 * found "foo/." in the working tree.
1907 * This is tricky -- if we have modified
1908 * files that are in "foo/" we would lose
1911 if (verify_clean_subdirectory(ce
, error_type
, o
) < 0)
1917 * The previous round may already have decided to
1918 * delete this path, which is in a subdirectory that
1919 * is being replaced with a blob.
1921 result
= index_file_exists(&o
->result
, name
, len
, 0);
1923 if (result
->ce_flags
& CE_REMOVE
)
1927 return o
->gently
? -1 :
1928 add_rejected_path(o
, error_type
, name
);
1932 * We do not want to remove or overwrite a working tree file that
1933 * is not tracked, unless it is ignored.
1935 static int verify_absent_1(const struct cache_entry
*ce
,
1936 enum unpack_trees_error_types error_type
,
1937 struct unpack_trees_options
*o
)
1942 if (o
->index_only
|| o
->reset
|| !o
->update
)
1945 len
= check_leading_path(ce
->name
, ce_namelen(ce
));
1952 path
= xmemdupz(ce
->name
, len
);
1953 if (lstat(path
, &st
))
1954 ret
= error_errno("cannot stat '%s'", path
);
1956 if (submodule_from_ce(ce
))
1957 ret
= check_submodule_move_head(ce
,
1958 oid_to_hex(&ce
->oid
),
1961 ret
= check_ok_to_remove(path
, len
, DT_UNKNOWN
, NULL
,
1962 &st
, error_type
, o
);
1966 } else if (lstat(ce
->name
, &st
)) {
1967 if (errno
!= ENOENT
)
1968 return error_errno("cannot stat '%s'", ce
->name
);
1971 if (submodule_from_ce(ce
))
1972 return check_submodule_move_head(ce
, oid_to_hex(&ce
->oid
),
1975 return check_ok_to_remove(ce
->name
, ce_namelen(ce
),
1976 ce_to_dtype(ce
), ce
, &st
,
1981 static int verify_absent(const struct cache_entry
*ce
,
1982 enum unpack_trees_error_types error_type
,
1983 struct unpack_trees_options
*o
)
1985 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1987 return verify_absent_1(ce
, error_type
, o
);
1990 static int verify_absent_sparse(const struct cache_entry
*ce
,
1991 enum unpack_trees_error_types error_type
,
1992 struct unpack_trees_options
*o
)
1994 enum unpack_trees_error_types orphaned_error
= error_type
;
1995 if (orphaned_error
== ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
)
1996 orphaned_error
= ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
;
1998 return verify_absent_1(ce
, orphaned_error
, o
);
2001 static int merged_entry(const struct cache_entry
*ce
,
2002 const struct cache_entry
*old
,
2003 struct unpack_trees_options
*o
)
2005 int update
= CE_UPDATE
;
2006 struct cache_entry
*merge
= dup_cache_entry(ce
, &o
->result
);
2010 * New index entries. In sparse checkout, the following
2011 * verify_absent() will be delayed until after
2012 * traverse_trees() finishes in unpack_trees(), then:
2014 * - CE_NEW_SKIP_WORKTREE will be computed correctly
2015 * - verify_absent() be called again, this time with
2016 * correct CE_NEW_SKIP_WORKTREE
2018 * verify_absent() call here does nothing in sparse
2019 * checkout (i.e. o->skip_sparse_checkout == 0)
2022 merge
->ce_flags
|= CE_NEW_SKIP_WORKTREE
;
2024 if (verify_absent(merge
,
2025 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
2026 discard_cache_entry(merge
);
2029 invalidate_ce_path(merge
, o
);
2031 if (submodule_from_ce(ce
)) {
2032 int ret
= check_submodule_move_head(ce
, NULL
,
2033 oid_to_hex(&ce
->oid
),
2039 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
2041 * See if we can re-use the old CE directly?
2042 * That way we get the uptodate stat info.
2044 * This also removes the UPDATE flag on a match; otherwise
2045 * we will end up overwriting local changes in the work tree.
2047 if (same(old
, merge
)) {
2048 copy_cache_entry(merge
, old
);
2051 if (verify_uptodate(old
, o
)) {
2052 discard_cache_entry(merge
);
2055 /* Migrate old flags over */
2056 update
|= old
->ce_flags
& (CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
2057 invalidate_ce_path(old
, o
);
2060 if (submodule_from_ce(ce
)) {
2061 int ret
= check_submodule_move_head(ce
, oid_to_hex(&old
->oid
),
2062 oid_to_hex(&ce
->oid
),
2069 * Previously unmerged entry left as an existence
2070 * marker by read_index_unmerged();
2072 invalidate_ce_path(old
, o
);
2075 do_add_entry(o
, merge
, update
, CE_STAGEMASK
);
2079 static int deleted_entry(const struct cache_entry
*ce
,
2080 const struct cache_entry
*old
,
2081 struct unpack_trees_options
*o
)
2083 /* Did it exist in the index? */
2085 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2089 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
2091 add_entry(o
, ce
, CE_REMOVE
, 0);
2092 invalidate_ce_path(ce
, o
);
2096 static int keep_entry(const struct cache_entry
*ce
,
2097 struct unpack_trees_options
*o
)
2099 add_entry(o
, ce
, 0, 0);
2101 invalidate_ce_path(ce
, o
);
2106 static void show_stage_entry(FILE *o
,
2107 const char *label
, const struct cache_entry
*ce
)
2110 fprintf(o
, "%s (missing)\n", label
);
2112 fprintf(o
, "%s%06o %s %d\t%s\n",
2115 oid_to_hex(&ce
->oid
),
2121 int threeway_merge(const struct cache_entry
* const *stages
,
2122 struct unpack_trees_options
*o
)
2124 const struct cache_entry
*index
;
2125 const struct cache_entry
*head
;
2126 const struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
2129 int remote_match
= 0;
2131 int df_conflict_head
= 0;
2132 int df_conflict_remote
= 0;
2134 int any_anc_missing
= 0;
2135 int no_anc_exists
= 1;
2138 for (i
= 1; i
< o
->head_idx
; i
++) {
2139 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
2140 any_anc_missing
= 1;
2146 head
= stages
[o
->head_idx
];
2148 if (head
== o
->df_conflict_entry
) {
2149 df_conflict_head
= 1;
2153 if (remote
== o
->df_conflict_entry
) {
2154 df_conflict_remote
= 1;
2159 * First, if there's a #16 situation, note that to prevent #13
2162 if (!same(remote
, head
)) {
2163 for (i
= 1; i
< o
->head_idx
; i
++) {
2164 if (same(stages
[i
], head
)) {
2167 if (same(stages
[i
], remote
)) {
2174 * We start with cases where the index is allowed to match
2175 * something other than the head: #14(ALT) and #2ALT, where it
2176 * is permitted to match the result instead.
2178 /* #14, #14ALT, #2ALT */
2179 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
2180 if (index
&& !same(index
, remote
) && !same(index
, head
))
2181 return reject_merge(index
, o
);
2182 return merged_entry(remote
, index
, o
);
2185 * If we have an entry in the index cache, then we want to
2186 * make sure that it matches head.
2188 if (index
&& !same(index
, head
))
2189 return reject_merge(index
, o
);
2193 if (same(head
, remote
))
2194 return merged_entry(head
, index
, o
);
2196 if (!df_conflict_remote
&& remote_match
&& !head_match
)
2197 return merged_entry(head
, index
, o
);
2201 if (!head
&& !remote
&& any_anc_missing
)
2205 * Under the "aggressive" rule, we resolve mostly trivial
2206 * cases that we historically had git-merge-one-file resolve.
2208 if (o
->aggressive
) {
2209 int head_deleted
= !head
;
2210 int remote_deleted
= !remote
;
2211 const struct cache_entry
*ce
= NULL
;
2220 for (i
= 1; i
< o
->head_idx
; i
++) {
2221 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2230 * Deleted in one and unchanged in the other.
2232 if ((head_deleted
&& remote_deleted
) ||
2233 (head_deleted
&& remote
&& remote_match
) ||
2234 (remote_deleted
&& head
&& head_match
)) {
2236 return deleted_entry(index
, index
, o
);
2237 if (ce
&& !head_deleted
) {
2238 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2244 * Added in both, identically.
2246 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
2247 return merged_entry(head
, index
, o
);
2251 /* Below are "no merge" cases, which require that the index be
2252 * up-to-date to avoid the files getting overwritten with
2253 * conflict resolution files.
2256 if (verify_uptodate(index
, o
))
2260 o
->nontrivial_merge
= 1;
2262 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2264 if (!head_match
|| !remote_match
) {
2265 for (i
= 1; i
< o
->head_idx
; i
++) {
2266 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2267 keep_entry(stages
[i
], o
);
2275 fprintf(stderr
, "read-tree: warning #16 detected\n");
2276 show_stage_entry(stderr
, "head ", stages
[head_match
]);
2277 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
2280 if (head
) { count
+= keep_entry(head
, o
); }
2281 if (remote
) { count
+= keep_entry(remote
, o
); }
2288 * The rule is to "carry forward" what is in the index without losing
2289 * information across a "fast-forward", favoring a successful merge
2290 * over a merge failure when it makes sense. For details of the
2291 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2294 int twoway_merge(const struct cache_entry
* const *src
,
2295 struct unpack_trees_options
*o
)
2297 const struct cache_entry
*current
= src
[0];
2298 const struct cache_entry
*oldtree
= src
[1];
2299 const struct cache_entry
*newtree
= src
[2];
2301 if (o
->merge_size
!= 2)
2302 return error("Cannot do a twoway merge of %d trees",
2305 if (oldtree
== o
->df_conflict_entry
)
2307 if (newtree
== o
->df_conflict_entry
)
2311 if (current
->ce_flags
& CE_CONFLICTED
) {
2312 if (same(oldtree
, newtree
) || o
->reset
) {
2314 return deleted_entry(current
, current
, o
);
2316 return merged_entry(newtree
, current
, o
);
2318 return reject_merge(current
, o
);
2319 } else if ((!oldtree
&& !newtree
) || /* 4 and 5 */
2320 (!oldtree
&& newtree
&&
2321 same(current
, newtree
)) || /* 6 and 7 */
2322 (oldtree
&& newtree
&&
2323 same(oldtree
, newtree
)) || /* 14 and 15 */
2324 (oldtree
&& newtree
&&
2325 !same(oldtree
, newtree
) && /* 18 and 19 */
2326 same(current
, newtree
))) {
2327 return keep_entry(current
, o
);
2328 } else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
2330 return deleted_entry(oldtree
, current
, o
);
2331 } else if (oldtree
&& newtree
&&
2332 same(current
, oldtree
) && !same(current
, newtree
)) {
2334 return merged_entry(newtree
, current
, o
);
2336 return reject_merge(current
, o
);
2339 if (oldtree
&& !o
->initial_checkout
) {
2341 * deletion of the path was staged;
2343 if (same(oldtree
, newtree
))
2345 return reject_merge(oldtree
, o
);
2347 return merged_entry(newtree
, current
, o
);
2349 return deleted_entry(oldtree
, current
, o
);
2355 * Keep the index entries at stage0, collapse stage1 but make sure
2356 * stage0 does not have anything there.
2358 int bind_merge(const struct cache_entry
* const *src
,
2359 struct unpack_trees_options
*o
)
2361 const struct cache_entry
*old
= src
[0];
2362 const struct cache_entry
*a
= src
[1];
2364 if (o
->merge_size
!= 1)
2365 return error("Cannot do a bind merge of %d trees",
2368 return o
->gently
? -1 :
2369 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
),
2370 super_prefixed(a
->name
),
2371 super_prefixed(old
->name
));
2373 return keep_entry(old
, o
);
2375 return merged_entry(a
, NULL
, o
);
2382 * - take the stat information from stage0, take the data from stage1
2384 int oneway_merge(const struct cache_entry
* const *src
,
2385 struct unpack_trees_options
*o
)
2387 const struct cache_entry
*old
= src
[0];
2388 const struct cache_entry
*a
= src
[1];
2390 if (o
->merge_size
!= 1)
2391 return error("Cannot do a oneway merge of %d trees",
2394 if (!a
|| a
== o
->df_conflict_entry
)
2395 return deleted_entry(old
, old
, o
);
2397 if (old
&& same(old
, a
)) {
2399 if (o
->reset
&& o
->update
&& !ce_uptodate(old
) && !ce_skip_worktree(old
)) {
2401 if (lstat(old
->name
, &st
) ||
2402 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
2403 update
|= CE_UPDATE
;
2405 if (o
->update
&& S_ISGITLINK(old
->ce_mode
) &&
2406 should_update_submodules() && !verify_uptodate(old
, o
))
2407 update
|= CE_UPDATE
;
2408 add_entry(o
, old
, update
, 0);
2411 return merged_entry(a
, old
, o
);