1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
3 #include "argv-array.h"
4 #include "repository.h"
9 #include "cache-tree.h"
10 #include "unpack-trees.h"
14 #include "split-index.h"
16 #include "submodule.h"
17 #include "submodule-config.h"
18 #include "fsmonitor.h"
19 #include "object-store.h"
20 #include "fetch-object.h"
23 * Error messages expected by scripts out of plumbing commands such as
24 * read-tree. Non-scripted Porcelain is not required to use these messages
25 * and in fact are encouraged to reword them to better suit their particular
26 * situation better. See how "git checkout" and "git merge" replaces
27 * them using setup_unpack_trees_porcelain(), for example.
29 static const char *unpack_plumbing_errors
[NB_UNPACK_TREES_ERROR_TYPES
] = {
30 /* ERROR_WOULD_OVERWRITE */
31 "Entry '%s' would be overwritten by merge. Cannot merge.",
33 /* ERROR_NOT_UPTODATE_FILE */
34 "Entry '%s' not uptodate. Cannot merge.",
36 /* ERROR_NOT_UPTODATE_DIR */
37 "Updating '%s' would lose untracked files in it",
39 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
40 "Untracked working tree file '%s' would be overwritten by merge.",
42 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
43 "Untracked working tree file '%s' would be removed by merge.",
45 /* ERROR_BIND_OVERLAP */
46 "Entry '%s' overlaps with '%s'. Cannot bind.",
48 /* ERROR_SPARSE_NOT_UPTODATE_FILE */
49 "Entry '%s' not uptodate. Cannot update sparse checkout.",
51 /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
52 "Working tree file '%s' would be overwritten by sparse checkout update.",
54 /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
55 "Working tree file '%s' would be removed by sparse checkout update.",
57 /* ERROR_WOULD_LOSE_SUBMODULE */
58 "Submodule '%s' cannot checkout new HEAD.",
61 #define ERRORMSG(o,type) \
62 ( ((o) && (o)->msgs[(type)]) \
63 ? ((o)->msgs[(type)]) \
64 : (unpack_plumbing_errors[(type)]) )
66 static const char *super_prefixed(const char *path
)
69 * It is necessary and sufficient to have two static buffers
70 * here, as the return value of this function is fed to
71 * error() using the unpack_*_errors[] templates we see above.
73 static struct strbuf buf
[2] = {STRBUF_INIT
, STRBUF_INIT
};
74 static int super_prefix_len
= -1;
75 static unsigned idx
= ARRAY_SIZE(buf
) - 1;
77 if (super_prefix_len
< 0) {
78 const char *super_prefix
= get_super_prefix();
83 for (i
= 0; i
< ARRAY_SIZE(buf
); i
++)
84 strbuf_addstr(&buf
[i
], super_prefix
);
85 super_prefix_len
= buf
[0].len
;
89 if (!super_prefix_len
)
92 if (++idx
>= ARRAY_SIZE(buf
))
95 strbuf_setlen(&buf
[idx
], super_prefix_len
);
96 strbuf_addstr(&buf
[idx
], path
);
101 void setup_unpack_trees_porcelain(struct unpack_trees_options
*opts
,
105 const char **msgs
= opts
->msgs
;
108 argv_array_init(&opts
->msgs_to_free
);
110 if (!strcmp(cmd
, "checkout"))
111 msg
= advice_commit_before_merge
112 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
113 "Please commit your changes or stash them before you switch branches.")
114 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
115 else if (!strcmp(cmd
, "merge"))
116 msg
= advice_commit_before_merge
117 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
118 "Please commit your changes or stash them before you merge.")
119 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
121 msg
= advice_commit_before_merge
122 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
123 "Please commit your changes or stash them before you %s.")
124 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
125 msgs
[ERROR_WOULD_OVERWRITE
] = msgs
[ERROR_NOT_UPTODATE_FILE
] =
126 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
128 msgs
[ERROR_NOT_UPTODATE_DIR
] =
129 _("Updating the following directories would lose untracked files in them:\n%s");
131 if (!strcmp(cmd
, "checkout"))
132 msg
= advice_commit_before_merge
133 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
134 "Please move or remove them before you switch branches.")
135 : _("The following untracked working tree files would be removed by checkout:\n%%s");
136 else if (!strcmp(cmd
, "merge"))
137 msg
= advice_commit_before_merge
138 ? _("The following untracked working tree files would be removed by merge:\n%%s"
139 "Please move or remove them before you merge.")
140 : _("The following untracked working tree files would be removed by merge:\n%%s");
142 msg
= advice_commit_before_merge
143 ? _("The following untracked working tree files would be removed by %s:\n%%s"
144 "Please move or remove them before you %s.")
145 : _("The following untracked working tree files would be removed by %s:\n%%s");
146 msgs
[ERROR_WOULD_LOSE_UNTRACKED_REMOVED
] =
147 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
149 if (!strcmp(cmd
, "checkout"))
150 msg
= advice_commit_before_merge
151 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
152 "Please move or remove them before you switch branches.")
153 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
154 else if (!strcmp(cmd
, "merge"))
155 msg
= advice_commit_before_merge
156 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
157 "Please move or remove them before you merge.")
158 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
160 msg
= advice_commit_before_merge
161 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
162 "Please move or remove them before you %s.")
163 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
164 msgs
[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
] =
165 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
168 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
169 * cannot easily display it as a list.
171 msgs
[ERROR_BIND_OVERLAP
] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
173 msgs
[ERROR_SPARSE_NOT_UPTODATE_FILE
] =
174 _("Cannot update sparse checkout: the following entries are not up to date:\n%s");
175 msgs
[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
] =
176 _("The following working tree files would be overwritten by sparse checkout update:\n%s");
177 msgs
[ERROR_WOULD_LOSE_ORPHANED_REMOVED
] =
178 _("The following working tree files would be removed by sparse checkout update:\n%s");
179 msgs
[ERROR_WOULD_LOSE_SUBMODULE
] =
180 _("Cannot update submodule:\n%s");
182 opts
->show_all_errors
= 1;
183 /* rejected paths may not have a static buffer */
184 for (i
= 0; i
< ARRAY_SIZE(opts
->unpack_rejects
); i
++)
185 opts
->unpack_rejects
[i
].strdup_strings
= 1;
188 void clear_unpack_trees_porcelain(struct unpack_trees_options
*opts
)
190 argv_array_clear(&opts
->msgs_to_free
);
191 memset(opts
->msgs
, 0, sizeof(opts
->msgs
));
194 static int do_add_entry(struct unpack_trees_options
*o
, struct cache_entry
*ce
,
195 unsigned int set
, unsigned int clear
)
202 ce
->ce_flags
= (ce
->ce_flags
& ~clear
) | set
;
203 return add_index_entry(&o
->result
, ce
,
204 ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
207 static void add_entry(struct unpack_trees_options
*o
,
208 const struct cache_entry
*ce
,
209 unsigned int set
, unsigned int clear
)
211 do_add_entry(o
, dup_cache_entry(ce
, &o
->result
), set
, clear
);
215 * add error messages on path <path>
216 * corresponding to the type <e> with the message <msg>
217 * indicating if it should be display in porcelain or not
219 static int add_rejected_path(struct unpack_trees_options
*o
,
220 enum unpack_trees_error_types e
,
223 if (!o
->show_all_errors
)
224 return error(ERRORMSG(o
, e
), super_prefixed(path
));
227 * Otherwise, insert in a list for future display by
228 * display_error_msgs()
230 string_list_append(&o
->unpack_rejects
[e
], path
);
235 * display all the error messages stored in a nice way
237 static void display_error_msgs(struct unpack_trees_options
*o
)
240 int something_displayed
= 0;
241 for (e
= 0; e
< NB_UNPACK_TREES_ERROR_TYPES
; e
++) {
242 struct string_list
*rejects
= &o
->unpack_rejects
[e
];
243 if (rejects
->nr
> 0) {
244 struct strbuf path
= STRBUF_INIT
;
245 something_displayed
= 1;
246 for (i
= 0; i
< rejects
->nr
; i
++)
247 strbuf_addf(&path
, "\t%s\n", rejects
->items
[i
].string
);
248 error(ERRORMSG(o
, e
), super_prefixed(path
.buf
));
249 strbuf_release(&path
);
251 string_list_clear(rejects
, 0);
253 if (something_displayed
)
254 fprintf(stderr
, _("Aborting\n"));
257 static int check_submodule_move_head(const struct cache_entry
*ce
,
260 struct unpack_trees_options
*o
)
262 unsigned flags
= SUBMODULE_MOVE_HEAD_DRY_RUN
;
263 const struct submodule
*sub
= submodule_from_ce(ce
);
269 flags
|= SUBMODULE_MOVE_HEAD_FORCE
;
271 if (submodule_move_head(ce
->name
, old_id
, new_id
, flags
))
272 return o
->gently
? -1 :
273 add_rejected_path(o
, ERROR_WOULD_LOSE_SUBMODULE
, ce
->name
);
278 * Preform the loading of the repository's gitmodules file. This function is
279 * used by 'check_update()' to perform loading of the gitmodules file in two
280 * differnt situations:
281 * (1) before removing entries from the working tree if the gitmodules file has
282 * been marked for removal. This situation is specified by 'state' == NULL.
283 * (2) before checking out entries to the working tree if the gitmodules file
284 * has been marked for update. This situation is specified by 'state' != NULL.
286 static void load_gitmodules_file(struct index_state
*index
,
287 struct checkout
*state
)
289 int pos
= index_name_pos(index
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
292 struct cache_entry
*ce
= index
->cache
[pos
];
293 if (!state
&& ce
->ce_flags
& CE_WT_REMOVE
) {
294 repo_read_gitmodules(the_repository
);
295 } else if (state
&& (ce
->ce_flags
& CE_UPDATE
)) {
296 submodule_free(the_repository
);
297 checkout_entry(ce
, state
, NULL
);
298 repo_read_gitmodules(the_repository
);
304 * Unlink the last component and schedule the leading directories for
305 * removal, such that empty directories get removed.
307 static void unlink_entry(const struct cache_entry
*ce
)
309 const struct submodule
*sub
= submodule_from_ce(ce
);
311 /* state.force is set at the caller. */
312 submodule_move_head(ce
->name
, "HEAD", NULL
,
313 SUBMODULE_MOVE_HEAD_FORCE
);
315 if (!check_leading_path(ce
->name
, ce_namelen(ce
)))
317 if (remove_or_warn(ce
->ce_mode
, ce
->name
))
319 schedule_dir_for_removal(ce
->name
, ce_namelen(ce
));
322 static struct progress
*get_progress(struct unpack_trees_options
*o
)
324 unsigned cnt
= 0, total
= 0;
325 struct index_state
*index
= &o
->result
;
327 if (!o
->update
|| !o
->verbose_update
)
330 for (; cnt
< index
->cache_nr
; cnt
++) {
331 const struct cache_entry
*ce
= index
->cache
[cnt
];
332 if (ce
->ce_flags
& (CE_UPDATE
| CE_WT_REMOVE
))
336 return start_delayed_progress(_("Checking out files"), total
);
339 static int check_updates(struct unpack_trees_options
*o
)
343 struct progress
*progress
= NULL
;
344 struct index_state
*index
= &o
->result
;
345 struct checkout state
= CHECKOUT_INIT
;
348 trace_performance_enter();
351 state
.refresh_cache
= 1;
352 state
.istate
= index
;
354 progress
= get_progress(o
);
357 git_attr_set_direction(GIT_ATTR_CHECKOUT
, index
);
359 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
360 load_gitmodules_file(index
, NULL
);
362 for (i
= 0; i
< index
->cache_nr
; i
++) {
363 const struct cache_entry
*ce
= index
->cache
[i
];
365 if (ce
->ce_flags
& CE_WT_REMOVE
) {
366 display_progress(progress
, ++cnt
);
367 if (o
->update
&& !o
->dry_run
)
371 remove_marked_cache_entries(index
);
372 remove_scheduled_dirs();
374 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
375 load_gitmodules_file(index
, &state
);
377 enable_delayed_checkout(&state
);
378 if (repository_format_partial_clone
&& o
->update
&& !o
->dry_run
) {
380 * Prefetch the objects that are to be checked out in the loop
383 struct oid_array to_fetch
= OID_ARRAY_INIT
;
384 int fetch_if_missing_store
= fetch_if_missing
;
385 fetch_if_missing
= 0;
386 for (i
= 0; i
< index
->cache_nr
; i
++) {
387 struct cache_entry
*ce
= index
->cache
[i
];
388 if ((ce
->ce_flags
& CE_UPDATE
) &&
389 !S_ISGITLINK(ce
->ce_mode
)) {
390 if (!has_object_file(&ce
->oid
))
391 oid_array_append(&to_fetch
, &ce
->oid
);
395 fetch_objects(repository_format_partial_clone
,
397 fetch_if_missing
= fetch_if_missing_store
;
398 oid_array_clear(&to_fetch
);
400 for (i
= 0; i
< index
->cache_nr
; i
++) {
401 struct cache_entry
*ce
= index
->cache
[i
];
403 if (ce
->ce_flags
& CE_UPDATE
) {
404 if (ce
->ce_flags
& CE_WT_REMOVE
)
405 BUG("both update and delete flags are set on %s",
407 display_progress(progress
, ++cnt
);
408 ce
->ce_flags
&= ~CE_UPDATE
;
409 if (o
->update
&& !o
->dry_run
) {
410 errs
|= checkout_entry(ce
, &state
, NULL
);
414 stop_progress(&progress
);
415 errs
|= finish_delayed_checkout(&state
);
417 git_attr_set_direction(GIT_ATTR_CHECKIN
, NULL
);
418 trace_performance_leave("check_updates");
422 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
423 struct unpack_trees_options
*o
);
424 static int verify_absent_sparse(const struct cache_entry
*ce
,
425 enum unpack_trees_error_types
,
426 struct unpack_trees_options
*o
);
428 static int apply_sparse_checkout(struct index_state
*istate
,
429 struct cache_entry
*ce
,
430 struct unpack_trees_options
*o
)
432 int was_skip_worktree
= ce_skip_worktree(ce
);
434 if (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
)
435 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
437 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
438 if (was_skip_worktree
!= ce_skip_worktree(ce
)) {
439 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
440 mark_fsmonitor_invalid(istate
, ce
);
441 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
445 * if (!was_skip_worktree && !ce_skip_worktree()) {
446 * This is perfectly normal. Move on;
451 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
452 * area as a result of ce_skip_worktree() shortcuts in
453 * verify_absent() and verify_uptodate().
454 * Make sure they don't modify worktree if they are already
455 * outside checkout area
457 if (was_skip_worktree
&& ce_skip_worktree(ce
)) {
458 ce
->ce_flags
&= ~CE_UPDATE
;
461 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
462 * on to get that file removed from both index and worktree.
463 * If that file is already outside worktree area, don't
466 if (ce
->ce_flags
& CE_REMOVE
)
467 ce
->ce_flags
&= ~CE_WT_REMOVE
;
470 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
472 * If CE_UPDATE is set, verify_uptodate() must be called already
473 * also stat info may have lost after merged_entry() so calling
474 * verify_uptodate() again may fail
476 if (!(ce
->ce_flags
& CE_UPDATE
) && verify_uptodate_sparse(ce
, o
))
478 ce
->ce_flags
|= CE_WT_REMOVE
;
479 ce
->ce_flags
&= ~CE_UPDATE
;
481 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
482 if (verify_absent_sparse(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
484 ce
->ce_flags
|= CE_UPDATE
;
489 static inline int call_unpack_fn(const struct cache_entry
* const *src
,
490 struct unpack_trees_options
*o
)
492 int ret
= o
->fn(src
, o
);
498 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
500 ce
->ce_flags
|= CE_UNPACKED
;
502 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
503 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
504 int bottom
= o
->cache_bottom
;
505 while (bottom
< o
->src_index
->cache_nr
&&
506 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
508 o
->cache_bottom
= bottom
;
512 static void mark_all_ce_unused(struct index_state
*index
)
515 for (i
= 0; i
< index
->cache_nr
; i
++)
516 index
->cache
[i
]->ce_flags
&= ~(CE_UNPACKED
| CE_ADDED
| CE_NEW_SKIP_WORKTREE
);
519 static int locate_in_src_index(const struct cache_entry
*ce
,
520 struct unpack_trees_options
*o
)
522 struct index_state
*index
= o
->src_index
;
523 int len
= ce_namelen(ce
);
524 int pos
= index_name_pos(index
, ce
->name
, len
);
531 * We call unpack_index_entry() with an unmerged cache entry
532 * only in diff-index, and it wants a single callback. Skip
533 * the other unmerged entry with the same name.
535 static void mark_ce_used_same_name(struct cache_entry
*ce
,
536 struct unpack_trees_options
*o
)
538 struct index_state
*index
= o
->src_index
;
539 int len
= ce_namelen(ce
);
542 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
543 struct cache_entry
*next
= index
->cache
[pos
];
544 if (len
!= ce_namelen(next
) ||
545 memcmp(ce
->name
, next
->name
, len
))
547 mark_ce_used(next
, o
);
551 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
553 const struct index_state
*index
= o
->src_index
;
554 int pos
= o
->cache_bottom
;
556 while (pos
< index
->cache_nr
) {
557 struct cache_entry
*ce
= index
->cache
[pos
];
558 if (!(ce
->ce_flags
& CE_UNPACKED
))
565 static void add_same_unmerged(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
);
573 die("programming error in a caller of mark_ce_used_same_name");
574 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
575 struct cache_entry
*next
= index
->cache
[pos
];
576 if (len
!= ce_namelen(next
) ||
577 memcmp(ce
->name
, next
->name
, len
))
579 add_entry(o
, next
, 0, 0);
580 mark_ce_used(next
, o
);
584 static int unpack_index_entry(struct cache_entry
*ce
,
585 struct unpack_trees_options
*o
)
587 const struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
594 if (o
->skip_unmerged
) {
595 add_entry(o
, ce
, 0, 0);
599 ret
= call_unpack_fn(src
, o
);
601 mark_ce_used_same_name(ce
, o
);
605 static int find_cache_pos(struct traverse_info
*, const struct name_entry
*);
607 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
609 struct unpack_trees_options
*o
= info
->data
;
611 if (o
->diff_index_cached
)
613 o
->cache_bottom
= bottom
;
616 static int switch_cache_bottom(struct traverse_info
*info
)
618 struct unpack_trees_options
*o
= info
->data
;
621 if (o
->diff_index_cached
)
623 ret
= o
->cache_bottom
;
624 pos
= find_cache_pos(info
->prev
, &info
->name
);
627 o
->cache_bottom
= -2 - pos
;
629 o
->cache_bottom
= o
->src_index
->cache_nr
;
633 static inline int are_same_oid(struct name_entry
*name_j
, struct name_entry
*name_k
)
635 return name_j
->oid
&& name_k
->oid
&& !oidcmp(name_j
->oid
, name_k
->oid
);
638 static int all_trees_same_as_cache_tree(int n
, unsigned long dirmask
,
639 struct name_entry
*names
,
640 struct traverse_info
*info
)
642 struct unpack_trees_options
*o
= info
->data
;
645 if (!o
->merge
|| dirmask
!= ((1 << n
) - 1))
648 for (i
= 1; i
< n
; i
++)
649 if (!are_same_oid(names
, names
+ i
))
652 return cache_tree_matches_traversal(o
->src_index
->cache_tree
, names
, info
);
655 static int index_pos_by_traverse_info(struct name_entry
*names
,
656 struct traverse_info
*info
)
658 struct unpack_trees_options
*o
= info
->data
;
659 int len
= traverse_path_len(info
, names
);
660 char *name
= xmalloc(len
+ 1 /* slash */ + 1 /* NUL */);
663 make_traverse_path(name
, info
, names
);
666 pos
= index_name_pos(o
->src_index
, name
, len
);
668 BUG("This is a directory and should not exist in index");
670 if (!starts_with(o
->src_index
->cache
[pos
]->name
, name
) ||
671 (pos
> 0 && starts_with(o
->src_index
->cache
[pos
-1]->name
, name
)))
672 BUG("pos must point at the first entry in this directory");
678 * Fast path if we detect that all trees are the same as cache-tree at this
679 * path. We'll walk these trees recursively using cache-tree/index instead of
680 * ODB since already know what these trees contain.
682 static int traverse_by_cache_tree(int pos
, int nr_entries
, int nr_names
,
683 struct name_entry
*names
,
684 struct traverse_info
*info
)
686 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
687 struct unpack_trees_options
*o
= info
->data
;
688 struct cache_entry
*tree_ce
= NULL
;
693 BUG("We need cache-tree to do this optimization");
696 * Do what unpack_callback() and unpack_nondirectories() normally
697 * do. But we walk all paths in an iterative loop instead.
699 * D/F conflicts and higher stage entries are not a concern
700 * because cache-tree would be invalidated and we would never
701 * get here in the first place.
703 for (i
= 0; i
< nr_entries
; i
++) {
704 int new_ce_len
, len
, rc
;
706 src
[0] = o
->src_index
->cache
[pos
+ i
];
708 len
= ce_namelen(src
[0]);
709 new_ce_len
= cache_entry_size(len
);
711 if (new_ce_len
> ce_len
) {
713 tree_ce
= xrealloc(tree_ce
, new_ce_len
);
714 memset(tree_ce
, 0, new_ce_len
);
717 tree_ce
->ce_flags
= create_ce_flags(0);
719 for (d
= 1; d
<= nr_names
; d
++)
723 tree_ce
->ce_mode
= src
[0]->ce_mode
;
724 tree_ce
->ce_namelen
= len
;
725 oidcpy(&tree_ce
->oid
, &src
[0]->oid
);
726 memcpy(tree_ce
->name
, src
[0]->name
, len
+ 1);
728 rc
= call_unpack_fn((const struct cache_entry
* const *)src
, o
);
734 mark_ce_used(src
[0], o
);
738 printf("Unpacked %d entries from %s to %s using cache-tree\n",
740 o
->src_index
->cache
[pos
]->name
,
741 o
->src_index
->cache
[pos
+ nr_entries
- 1]->name
);
745 static int traverse_trees_recursive(int n
, unsigned long dirmask
,
746 unsigned long df_conflicts
,
747 struct name_entry
*names
,
748 struct traverse_info
*info
)
752 struct tree_desc t
[MAX_UNPACK_TREES
];
753 void *buf
[MAX_UNPACK_TREES
];
754 struct traverse_info newinfo
;
755 struct name_entry
*p
;
758 nr_entries
= all_trees_same_as_cache_tree(n
, dirmask
, names
, info
);
759 if (nr_entries
> 0) {
760 struct unpack_trees_options
*o
= info
->data
;
761 int pos
= index_pos_by_traverse_info(names
, info
);
763 if (!o
->merge
|| df_conflicts
)
764 BUG("Wrong condition to get here buddy");
767 * All entries up to 'pos' must have been processed
768 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
769 * save and restore cache_bottom anyway to not miss
770 * unprocessed entries before 'pos'.
772 bottom
= o
->cache_bottom
;
773 ret
= traverse_by_cache_tree(pos
, nr_entries
, n
, names
, info
);
774 o
->cache_bottom
= bottom
;
784 newinfo
.pathspec
= info
->pathspec
;
786 newinfo
.pathlen
+= tree_entry_len(p
) + 1;
787 newinfo
.df_conflicts
|= df_conflicts
;
790 * Fetch the tree from the ODB for each peer directory in the
793 * For 2- and 3-way traversals, we try to avoid hitting the
794 * ODB twice for the same OID. This should yield a nice speed
795 * up in checkouts and merges when the commits are similar.
797 * We don't bother doing the full O(n^2) search for larger n,
798 * because wider traversals don't happen that often and we
799 * avoid the search setup.
801 * When 2 peer OIDs are the same, we just copy the tree
802 * descriptor data. This implicitly borrows the buffer
803 * data from the earlier cell.
805 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
806 if (i
> 0 && are_same_oid(&names
[i
], &names
[i
- 1]))
808 else if (i
> 1 && are_same_oid(&names
[i
], &names
[i
- 2]))
811 const struct object_id
*oid
= NULL
;
814 buf
[nr_buf
++] = fill_tree_descriptor(t
+ i
, oid
);
818 bottom
= switch_cache_bottom(&newinfo
);
819 ret
= traverse_trees(n
, t
, &newinfo
);
820 restore_cache_bottom(&newinfo
, bottom
);
822 for (i
= 0; i
< nr_buf
; i
++)
829 * Compare the traverse-path to the cache entry without actually
830 * having to generate the textual representation of the traverse
833 * NOTE! This *only* compares up to the size of the traverse path
834 * itself - the caller needs to do the final check for the cache
835 * entry having more data at the end!
837 static int do_compare_entry_piecewise(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
839 int len
, pathlen
, ce_len
;
843 int cmp
= do_compare_entry_piecewise(ce
, info
->prev
,
848 pathlen
= info
->pathlen
;
849 ce_len
= ce_namelen(ce
);
851 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
852 if (ce_len
< pathlen
)
856 ce_name
= ce
->name
+ pathlen
;
858 len
= tree_entry_len(n
);
859 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
862 static int do_compare_entry(const struct cache_entry
*ce
,
863 const struct traverse_info
*info
,
864 const struct name_entry
*n
)
866 int len
, pathlen
, ce_len
;
871 * If we have not precomputed the traverse path, it is quicker
872 * to avoid doing so. But if we have precomputed it,
873 * it is quicker to use the precomputed version.
875 if (!info
->traverse_path
)
876 return do_compare_entry_piecewise(ce
, info
, n
);
878 cmp
= strncmp(ce
->name
, info
->traverse_path
, info
->pathlen
);
882 pathlen
= info
->pathlen
;
883 ce_len
= ce_namelen(ce
);
885 if (ce_len
< pathlen
)
889 ce_name
= ce
->name
+ pathlen
;
891 len
= tree_entry_len(n
);
892 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
895 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
897 int cmp
= do_compare_entry(ce
, info
, n
);
902 * Even if the beginning compared identically, the ce should
903 * compare as bigger than a directory leading up to it!
905 return ce_namelen(ce
) > traverse_path_len(info
, n
);
908 static int ce_in_traverse_path(const struct cache_entry
*ce
,
909 const struct traverse_info
*info
)
913 if (do_compare_entry(ce
, info
->prev
, &info
->name
))
916 * If ce (blob) is the same name as the path (which is a tree
917 * we will be descending into), it won't be inside it.
919 return (info
->pathlen
< ce_namelen(ce
));
922 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
,
923 const struct name_entry
*n
,
925 struct index_state
*istate
,
928 int len
= traverse_path_len(info
, n
);
929 struct cache_entry
*ce
=
931 make_empty_transient_cache_entry(len
) :
932 make_empty_cache_entry(istate
, len
);
934 ce
->ce_mode
= create_ce_mode(n
->mode
);
935 ce
->ce_flags
= create_ce_flags(stage
);
936 ce
->ce_namelen
= len
;
937 oidcpy(&ce
->oid
, n
->oid
);
938 make_traverse_path(ce
->name
, info
, n
);
944 * Note that traverse_by_cache_tree() duplicates some logic in this function
945 * without actually calling it. If you change the logic here you may need to
946 * check and change there as well.
948 static int unpack_nondirectories(int n
, unsigned long mask
,
949 unsigned long dirmask
,
950 struct cache_entry
**src
,
951 const struct name_entry
*names
,
952 const struct traverse_info
*info
)
955 struct unpack_trees_options
*o
= info
->data
;
956 unsigned long conflicts
= info
->df_conflicts
| dirmask
;
958 /* Do we have *only* directories? Nothing to do */
959 if (mask
== dirmask
&& !src
[0])
963 * Ok, we've filled in up to any potential index entry in src[0],
966 for (i
= 0; i
< n
; i
++) {
968 unsigned int bit
= 1ul << i
;
969 if (conflicts
& bit
) {
970 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
977 else if (i
+ 1 < o
->head_idx
)
979 else if (i
+ 1 > o
->head_idx
)
985 * If the merge bit is set, then the cache entries are
986 * discarded in the following block. In this case,
987 * construct "transient" cache_entries, as they are
988 * not stored in the index. otherwise construct the
989 * cache entry from the index aware logic.
991 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
, &o
->result
, o
->merge
);
995 int rc
= call_unpack_fn((const struct cache_entry
* const *)src
,
997 for (i
= 0; i
< n
; i
++) {
998 struct cache_entry
*ce
= src
[i
+ o
->merge
];
999 if (ce
!= o
->df_conflict_entry
)
1000 discard_cache_entry(ce
);
1005 for (i
= 0; i
< n
; i
++)
1006 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
1007 if (do_add_entry(o
, src
[i
], 0, 0))
1013 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
1015 discard_index(&o
->result
);
1016 if (!o
->gently
&& !o
->exiting_early
) {
1018 return error("%s", message
);
1025 * The tree traversal is looking at name p. If we have a matching entry,
1026 * return it. If name p is a directory in the index, do not return
1027 * anything, as we will want to match it when the traversal descends into
1030 static int find_cache_pos(struct traverse_info
*info
,
1031 const struct name_entry
*p
)
1034 struct unpack_trees_options
*o
= info
->data
;
1035 struct index_state
*index
= o
->src_index
;
1036 int pfxlen
= info
->pathlen
;
1037 int p_len
= tree_entry_len(p
);
1039 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
1040 const struct cache_entry
*ce
= index
->cache
[pos
];
1041 const char *ce_name
, *ce_slash
;
1044 if (ce
->ce_flags
& CE_UNPACKED
) {
1046 * cache_bottom entry is already unpacked, so
1047 * we can never match it; don't check it
1050 if (pos
== o
->cache_bottom
)
1054 if (!ce_in_traverse_path(ce
, info
)) {
1056 * Check if we can skip future cache checks
1057 * (because we're already past all possible
1058 * entries in the traverse path).
1060 if (info
->traverse_path
) {
1061 if (strncmp(ce
->name
, info
->traverse_path
,
1067 ce_name
= ce
->name
+ pfxlen
;
1068 ce_slash
= strchr(ce_name
, '/');
1070 ce_len
= ce_slash
- ce_name
;
1072 ce_len
= ce_namelen(ce
) - pfxlen
;
1073 cmp
= name_compare(p
->path
, p_len
, ce_name
, ce_len
);
1075 * Exact match; if we have a directory we need to
1076 * delay returning it.
1079 return ce_slash
? -2 - pos
: pos
;
1081 continue; /* keep looking */
1083 * ce_name sorts after p->path; could it be that we
1084 * have files under p->path directory in the index?
1085 * E.g. ce_name == "t-i", and p->path == "t"; we may
1086 * have "t/a" in the index.
1088 if (p_len
< ce_len
&& !memcmp(ce_name
, p
->path
, p_len
) &&
1089 ce_name
[p_len
] < '/')
1090 continue; /* keep looking */
1096 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
1097 const struct name_entry
*p
)
1099 int pos
= find_cache_pos(info
, p
);
1100 struct unpack_trees_options
*o
= info
->data
;
1103 return o
->src_index
->cache
[pos
];
1108 static void debug_path(struct traverse_info
*info
)
1111 debug_path(info
->prev
);
1112 if (*info
->prev
->name
.path
)
1115 printf("%s", info
->name
.path
);
1118 static void debug_name_entry(int i
, struct name_entry
*n
)
1120 printf("ent#%d %06o %s\n", i
,
1121 n
->path
? n
->mode
: 0,
1122 n
->path
? n
->path
: "(missing)");
1125 static void debug_unpack_callback(int n
,
1127 unsigned long dirmask
,
1128 struct name_entry
*names
,
1129 struct traverse_info
*info
)
1132 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1136 for (i
= 0; i
< n
; i
++)
1137 debug_name_entry(i
, names
+ i
);
1141 * Note that traverse_by_cache_tree() duplicates some logic in this function
1142 * without actually calling it. If you change the logic here you may need to
1143 * check and change there as well.
1145 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
1147 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
1148 struct unpack_trees_options
*o
= info
->data
;
1149 const struct name_entry
*p
= names
;
1151 /* Find first entry with a real name (we could use "mask" too) */
1155 if (o
->debug_unpack
)
1156 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
1158 /* Are we supposed to look at the index too? */
1162 struct cache_entry
*ce
;
1164 if (o
->diff_index_cached
)
1165 ce
= next_cache_entry(o
);
1167 ce
= find_cache_entry(info
, p
);
1171 cmp
= compare_entry(ce
, info
, p
);
1173 if (unpack_index_entry(ce
, o
) < 0)
1174 return unpack_failed(o
, NULL
);
1180 * If we skip unmerged index
1181 * entries, we'll skip this
1182 * entry *and* the tree
1183 * entries associated with it!
1185 if (o
->skip_unmerged
) {
1186 add_same_unmerged(ce
, o
);
1196 if (unpack_nondirectories(n
, mask
, dirmask
, src
, names
, info
) < 0)
1199 if (o
->merge
&& src
[0]) {
1200 if (ce_stage(src
[0]))
1201 mark_ce_used_same_name(src
[0], o
);
1203 mark_ce_used(src
[0], o
);
1206 /* Now handle any directories.. */
1208 /* special case: "diff-index --cached" looking at a tree */
1209 if (o
->diff_index_cached
&&
1210 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
1212 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
1215 * Everything under the name matches; skip the
1216 * entire hierarchy. diff_index_cached codepath
1217 * special cases D/F conflicts in such a way that
1218 * it does not do any look-ahead, so this is safe.
1221 o
->cache_bottom
+= matches
;
1226 if (traverse_trees_recursive(n
, dirmask
, mask
& ~dirmask
,
1235 static int clear_ce_flags_1(struct cache_entry
**cache
, int nr
,
1236 struct strbuf
*prefix
,
1237 int select_mask
, int clear_mask
,
1238 struct exclude_list
*el
, int defval
);
1240 /* Whole directory matching */
1241 static int clear_ce_flags_dir(struct cache_entry
**cache
, int nr
,
1242 struct strbuf
*prefix
,
1244 int select_mask
, int clear_mask
,
1245 struct exclude_list
*el
, int defval
)
1247 struct cache_entry
**cache_end
;
1249 int ret
= is_excluded_from_list(prefix
->buf
, prefix
->len
,
1250 basename
, &dtype
, el
, &the_index
);
1253 strbuf_addch(prefix
, '/');
1255 /* If undecided, use matching result of parent dir in defval */
1259 for (cache_end
= cache
; cache_end
!= cache
+ nr
; cache_end
++) {
1260 struct cache_entry
*ce
= *cache_end
;
1261 if (strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1266 * TODO: check el, if there are no patterns that may conflict
1267 * with ret (iow, we know in advance the incl/excl
1268 * decision for the entire directory), clear flag here without
1269 * calling clear_ce_flags_1(). That function will call
1270 * the expensive is_excluded_from_list() on every entry.
1272 rc
= clear_ce_flags_1(cache
, cache_end
- cache
,
1274 select_mask
, clear_mask
,
1276 strbuf_setlen(prefix
, prefix
->len
- 1);
1281 * Traverse the index, find every entry that matches according to
1282 * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
1283 * number of traversed entries.
1285 * If select_mask is non-zero, only entries whose ce_flags has on of
1286 * those bits enabled are traversed.
1288 * cache : pointer to an index entry
1289 * prefix_len : an offset to its path
1291 * The current path ("prefix") including the trailing '/' is
1292 * cache[0]->name[0..(prefix_len-1)]
1293 * Top level path has prefix_len zero.
1295 static int clear_ce_flags_1(struct cache_entry
**cache
, int nr
,
1296 struct strbuf
*prefix
,
1297 int select_mask
, int clear_mask
,
1298 struct exclude_list
*el
, int defval
)
1300 struct cache_entry
**cache_end
= cache
+ nr
;
1303 * Process all entries that have the given prefix and meet
1304 * select_mask condition
1306 while(cache
!= cache_end
) {
1307 struct cache_entry
*ce
= *cache
;
1308 const char *name
, *slash
;
1309 int len
, dtype
, ret
;
1311 if (select_mask
&& !(ce
->ce_flags
& select_mask
)) {
1316 if (prefix
->len
&& strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1319 name
= ce
->name
+ prefix
->len
;
1320 slash
= strchr(name
, '/');
1322 /* If it's a directory, try whole directory match first */
1327 strbuf_add(prefix
, name
, len
);
1329 processed
= clear_ce_flags_dir(cache
, cache_end
- cache
,
1331 prefix
->buf
+ prefix
->len
- len
,
1332 select_mask
, clear_mask
,
1335 /* clear_c_f_dir eats a whole dir already? */
1338 strbuf_setlen(prefix
, prefix
->len
- len
);
1342 strbuf_addch(prefix
, '/');
1343 cache
+= clear_ce_flags_1(cache
, cache_end
- cache
,
1345 select_mask
, clear_mask
, el
, defval
);
1346 strbuf_setlen(prefix
, prefix
->len
- len
- 1);
1351 dtype
= ce_to_dtype(ce
);
1352 ret
= is_excluded_from_list(ce
->name
, ce_namelen(ce
),
1353 name
, &dtype
, el
, &the_index
);
1357 ce
->ce_flags
&= ~clear_mask
;
1360 return nr
- (cache_end
- cache
);
1363 static int clear_ce_flags(struct cache_entry
**cache
, int nr
,
1364 int select_mask
, int clear_mask
,
1365 struct exclude_list
*el
)
1367 static struct strbuf prefix
= STRBUF_INIT
;
1369 strbuf_reset(&prefix
);
1371 return clear_ce_flags_1(cache
, nr
,
1373 select_mask
, clear_mask
,
1378 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1380 static void mark_new_skip_worktree(struct exclude_list
*el
,
1381 struct index_state
*the_index
,
1382 int select_flag
, int skip_wt_flag
)
1387 * 1. Pretend the narrowest worktree: only unmerged entries
1390 for (i
= 0; i
< the_index
->cache_nr
; i
++) {
1391 struct cache_entry
*ce
= the_index
->cache
[i
];
1393 if (select_flag
&& !(ce
->ce_flags
& select_flag
))
1396 if (!ce_stage(ce
) && !(ce
->ce_flags
& CE_CONFLICTED
))
1397 ce
->ce_flags
|= skip_wt_flag
;
1399 ce
->ce_flags
&= ~skip_wt_flag
;
1403 * 2. Widen worktree according to sparse-checkout file.
1404 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1406 clear_ce_flags(the_index
->cache
, the_index
->cache_nr
,
1407 select_flag
, skip_wt_flag
, el
);
1410 static int verify_absent(const struct cache_entry
*,
1411 enum unpack_trees_error_types
,
1412 struct unpack_trees_options
*);
1414 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1415 * resulting index, -2 on failure to reflect the changes to the work tree.
1417 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1419 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
1422 static struct cache_entry
*dfc
;
1423 struct exclude_list el
;
1425 if (len
> MAX_UNPACK_TREES
)
1426 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
1428 trace_performance_enter();
1429 memset(&el
, 0, sizeof(el
));
1430 if (!core_apply_sparse_checkout
|| !o
->update
)
1431 o
->skip_sparse_checkout
= 1;
1432 if (!o
->skip_sparse_checkout
) {
1433 char *sparse
= git_pathdup("info/sparse-checkout");
1434 if (add_excludes_from_file_to_list(sparse
, "", 0, &el
, NULL
) < 0)
1435 o
->skip_sparse_checkout
= 1;
1441 memset(&o
->result
, 0, sizeof(o
->result
));
1442 o
->result
.initialized
= 1;
1443 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
1444 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
1445 o
->result
.version
= o
->src_index
->version
;
1446 if (!o
->src_index
->split_index
) {
1447 o
->result
.split_index
= NULL
;
1448 } else if (o
->src_index
== o
->dst_index
) {
1450 * o->dst_index (and thus o->src_index) will be discarded
1451 * and overwritten with o->result at the end of this function,
1452 * so just use src_index's split_index to avoid having to
1455 o
->result
.split_index
= o
->src_index
->split_index
;
1456 o
->result
.split_index
->refcount
++;
1458 o
->result
.split_index
= init_split_index(&o
->result
);
1460 oidcpy(&o
->result
.oid
, &o
->src_index
->oid
);
1461 o
->merge_size
= len
;
1462 mark_all_ce_unused(o
->src_index
);
1465 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1467 if (!o
->skip_sparse_checkout
)
1468 mark_new_skip_worktree(o
->el
, o
->src_index
, 0, CE_NEW_SKIP_WORKTREE
);
1471 dfc
= xcalloc(1, cache_entry_size(0));
1472 o
->df_conflict_entry
= dfc
;
1475 const char *prefix
= o
->prefix
? o
->prefix
: "";
1476 struct traverse_info info
;
1478 setup_traverse_info(&info
, prefix
);
1479 info
.fn
= unpack_callback
;
1481 info
.show_all_errors
= o
->show_all_errors
;
1482 info
.pathspec
= o
->pathspec
;
1486 * Unpack existing index entries that sort before the
1487 * prefix the tree is spliced into. Note that o->merge
1488 * is always true in this case.
1491 struct cache_entry
*ce
= next_cache_entry(o
);
1494 if (ce_in_traverse_path(ce
, &info
))
1496 if (unpack_index_entry(ce
, o
) < 0)
1501 trace_performance_enter();
1502 ret
= traverse_trees(len
, t
, &info
);
1503 trace_performance_leave("traverse_trees");
1508 /* Any left-over entries in the index? */
1511 struct cache_entry
*ce
= next_cache_entry(o
);
1514 if (unpack_index_entry(ce
, o
) < 0)
1518 mark_all_ce_unused(o
->src_index
);
1520 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
1521 ret
= unpack_failed(o
, "Merge requires file-level merging");
1525 if (!o
->skip_sparse_checkout
) {
1526 int empty_worktree
= 1;
1529 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1530 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1531 * so apply_sparse_checkout() won't attempt to remove it from worktree
1533 mark_new_skip_worktree(o
->el
, &o
->result
, CE_ADDED
, CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
1536 for (i
= 0; i
< o
->result
.cache_nr
; i
++) {
1537 struct cache_entry
*ce
= o
->result
.cache
[i
];
1540 * Entries marked with CE_ADDED in merged_entry() do not have
1541 * verify_absent() check (the check is effectively disabled
1542 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1544 * Do the real check now because we have had
1545 * correct CE_NEW_SKIP_WORKTREE
1547 if (ce
->ce_flags
& CE_ADDED
&&
1548 verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
1549 if (!o
->show_all_errors
)
1554 if (apply_sparse_checkout(&o
->result
, ce
, o
)) {
1555 if (!o
->show_all_errors
)
1559 if (!ce_skip_worktree(ce
))
1566 * Sparse checkout is meant to narrow down checkout area
1567 * but it does not make sense to narrow down to empty working
1568 * tree. This is usually a mistake in sparse checkout rules.
1569 * Do not allow users to do that.
1571 if (o
->result
.cache_nr
&& empty_worktree
) {
1572 ret
= unpack_failed(o
, "Sparse checkout leaves no entry on working directory");
1577 ret
= check_updates(o
) ? (-2) : 0;
1579 move_index_extensions(&o
->result
, o
->src_index
);
1581 if (!o
->result
.cache_tree
)
1582 o
->result
.cache_tree
= cache_tree();
1583 if (!cache_tree_fully_valid(o
->result
.cache_tree
))
1584 cache_tree_update(&o
->result
,
1588 discard_index(o
->dst_index
);
1589 *o
->dst_index
= o
->result
;
1591 discard_index(&o
->result
);
1593 o
->src_index
= NULL
;
1596 trace_performance_leave("unpack_trees");
1597 clear_exclude_list(&el
);
1601 if (o
->show_all_errors
)
1602 display_error_msgs(o
);
1603 mark_all_ce_unused(o
->src_index
);
1604 ret
= unpack_failed(o
, NULL
);
1605 if (o
->exiting_early
)
1610 /* Here come the merge functions */
1612 static int reject_merge(const struct cache_entry
*ce
,
1613 struct unpack_trees_options
*o
)
1615 return o
->gently
? -1 :
1616 add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
1619 static int same(const struct cache_entry
*a
, const struct cache_entry
*b
)
1625 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
1627 return a
->ce_mode
== b
->ce_mode
&&
1628 !oidcmp(&a
->oid
, &b
->oid
);
1633 * When a CE gets turned into an unmerged entry, we
1634 * want it to be up-to-date
1636 static int verify_uptodate_1(const struct cache_entry
*ce
,
1637 struct unpack_trees_options
*o
,
1638 enum unpack_trees_error_types error_type
)
1646 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1647 * if this entry is truly up-to-date because this file may be
1650 if ((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
))
1651 ; /* keep checking */
1652 else if (o
->reset
|| ce_uptodate(ce
))
1655 if (!lstat(ce
->name
, &st
)) {
1656 int flags
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
;
1657 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, flags
);
1659 if (submodule_from_ce(ce
)) {
1660 int r
= check_submodule_move_head(ce
,
1661 "HEAD", oid_to_hex(&ce
->oid
), o
);
1663 return o
->gently
? -1 :
1664 add_rejected_path(o
, error_type
, ce
->name
);
1671 * Historic default policy was to allow submodule to be out
1672 * of sync wrt the superproject index. If the submodule was
1673 * not considered interesting above, we don't care here.
1675 if (S_ISGITLINK(ce
->ce_mode
))
1680 if (errno
== ENOENT
)
1682 return o
->gently
? -1 :
1683 add_rejected_path(o
, error_type
, ce
->name
);
1686 int verify_uptodate(const struct cache_entry
*ce
,
1687 struct unpack_trees_options
*o
)
1689 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1691 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
1694 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
1695 struct unpack_trees_options
*o
)
1697 return verify_uptodate_1(ce
, o
, ERROR_SPARSE_NOT_UPTODATE_FILE
);
1700 static void invalidate_ce_path(const struct cache_entry
*ce
,
1701 struct unpack_trees_options
*o
)
1705 cache_tree_invalidate_path(o
->src_index
, ce
->name
);
1706 untracked_cache_invalidate_path(o
->src_index
, ce
->name
, 1);
1710 * Check that checking out ce->sha1 in subdir ce->name is not
1711 * going to overwrite any working files.
1713 * Currently, git does not checkout subprojects during a superproject
1714 * checkout, so it is not going to overwrite anything.
1716 static int verify_clean_submodule(const char *old_sha1
,
1717 const struct cache_entry
*ce
,
1718 enum unpack_trees_error_types error_type
,
1719 struct unpack_trees_options
*o
)
1721 if (!submodule_from_ce(ce
))
1724 return check_submodule_move_head(ce
, old_sha1
,
1725 oid_to_hex(&ce
->oid
), o
);
1728 static int verify_clean_subdirectory(const struct cache_entry
*ce
,
1729 enum unpack_trees_error_types error_type
,
1730 struct unpack_trees_options
*o
)
1733 * we are about to extract "ce->name"; we would not want to lose
1734 * anything in the existing directory there.
1738 struct dir_struct d
;
1742 if (S_ISGITLINK(ce
->ce_mode
)) {
1743 struct object_id oid
;
1744 int sub_head
= resolve_gitlink_ref(ce
->name
, "HEAD", &oid
);
1746 * If we are not going to update the submodule, then
1749 if (!sub_head
&& !oidcmp(&oid
, &ce
->oid
))
1751 return verify_clean_submodule(sub_head
? NULL
: oid_to_hex(&oid
),
1756 * First let's make sure we do not have a local modification
1757 * in that directory.
1759 namelen
= ce_namelen(ce
);
1760 for (i
= locate_in_src_index(ce
, o
);
1761 i
< o
->src_index
->cache_nr
;
1763 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
1764 int len
= ce_namelen(ce2
);
1765 if (len
< namelen
||
1766 strncmp(ce
->name
, ce2
->name
, namelen
) ||
1767 ce2
->name
[namelen
] != '/')
1770 * ce2->name is an entry in the subdirectory to be
1773 if (!ce_stage(ce2
)) {
1774 if (verify_uptodate(ce2
, o
))
1776 add_entry(o
, ce2
, CE_REMOVE
, 0);
1777 mark_ce_used(ce2
, o
);
1783 * Then we need to make sure that we do not lose a locally
1784 * present file that is not ignored.
1786 pathbuf
= xstrfmt("%.*s/", namelen
, ce
->name
);
1788 memset(&d
, 0, sizeof(d
));
1790 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
1791 i
= read_directory(&d
, &the_index
, pathbuf
, namelen
+1, NULL
);
1793 return o
->gently
? -1 :
1794 add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
1800 * This gets called when there was no index entry for the tree entry 'dst',
1801 * but we found a file in the working tree that 'lstat()' said was fine,
1802 * and we're on a case-insensitive filesystem.
1804 * See if we can find a case-insensitive match in the index that also
1805 * matches the stat information, and assume it's that other file!
1807 static int icase_exists(struct unpack_trees_options
*o
, const char *name
, int len
, struct stat
*st
)
1809 const struct cache_entry
*src
;
1811 src
= index_file_exists(o
->src_index
, name
, len
, 1);
1812 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
1815 static int check_ok_to_remove(const char *name
, int len
, int dtype
,
1816 const struct cache_entry
*ce
, struct stat
*st
,
1817 enum unpack_trees_error_types error_type
,
1818 struct unpack_trees_options
*o
)
1820 const struct cache_entry
*result
;
1823 * It may be that the 'lstat()' succeeded even though
1824 * target 'ce' was absent, because there is an old
1825 * entry that is different only in case..
1827 * Ignore that lstat() if it matches.
1829 if (ignore_case
&& icase_exists(o
, name
, len
, st
))
1833 is_excluded(o
->dir
, &the_index
, name
, &dtype
))
1835 * ce->name is explicitly excluded, so it is Ok to
1839 if (S_ISDIR(st
->st_mode
)) {
1841 * We are checking out path "foo" and
1842 * found "foo/." in the working tree.
1843 * This is tricky -- if we have modified
1844 * files that are in "foo/" we would lose
1847 if (verify_clean_subdirectory(ce
, error_type
, o
) < 0)
1853 * The previous round may already have decided to
1854 * delete this path, which is in a subdirectory that
1855 * is being replaced with a blob.
1857 result
= index_file_exists(&o
->result
, name
, len
, 0);
1859 if (result
->ce_flags
& CE_REMOVE
)
1863 return o
->gently
? -1 :
1864 add_rejected_path(o
, error_type
, name
);
1868 * We do not want to remove or overwrite a working tree file that
1869 * is not tracked, unless it is ignored.
1871 static int verify_absent_1(const struct cache_entry
*ce
,
1872 enum unpack_trees_error_types error_type
,
1873 struct unpack_trees_options
*o
)
1878 if (o
->index_only
|| o
->reset
|| !o
->update
)
1881 len
= check_leading_path(ce
->name
, ce_namelen(ce
));
1888 path
= xmemdupz(ce
->name
, len
);
1889 if (lstat(path
, &st
))
1890 ret
= error_errno("cannot stat '%s'", path
);
1892 if (submodule_from_ce(ce
))
1893 ret
= check_submodule_move_head(ce
,
1894 oid_to_hex(&ce
->oid
),
1897 ret
= check_ok_to_remove(path
, len
, DT_UNKNOWN
, NULL
,
1898 &st
, error_type
, o
);
1902 } else if (lstat(ce
->name
, &st
)) {
1903 if (errno
!= ENOENT
)
1904 return error_errno("cannot stat '%s'", ce
->name
);
1907 if (submodule_from_ce(ce
))
1908 return check_submodule_move_head(ce
, oid_to_hex(&ce
->oid
),
1911 return check_ok_to_remove(ce
->name
, ce_namelen(ce
),
1912 ce_to_dtype(ce
), ce
, &st
,
1917 static int verify_absent(const struct cache_entry
*ce
,
1918 enum unpack_trees_error_types error_type
,
1919 struct unpack_trees_options
*o
)
1921 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1923 return verify_absent_1(ce
, error_type
, o
);
1926 static int verify_absent_sparse(const struct cache_entry
*ce
,
1927 enum unpack_trees_error_types error_type
,
1928 struct unpack_trees_options
*o
)
1930 enum unpack_trees_error_types orphaned_error
= error_type
;
1931 if (orphaned_error
== ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
)
1932 orphaned_error
= ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
;
1934 return verify_absent_1(ce
, orphaned_error
, o
);
1937 static int merged_entry(const struct cache_entry
*ce
,
1938 const struct cache_entry
*old
,
1939 struct unpack_trees_options
*o
)
1941 int update
= CE_UPDATE
;
1942 struct cache_entry
*merge
= dup_cache_entry(ce
, &o
->result
);
1946 * New index entries. In sparse checkout, the following
1947 * verify_absent() will be delayed until after
1948 * traverse_trees() finishes in unpack_trees(), then:
1950 * - CE_NEW_SKIP_WORKTREE will be computed correctly
1951 * - verify_absent() be called again, this time with
1952 * correct CE_NEW_SKIP_WORKTREE
1954 * verify_absent() call here does nothing in sparse
1955 * checkout (i.e. o->skip_sparse_checkout == 0)
1958 merge
->ce_flags
|= CE_NEW_SKIP_WORKTREE
;
1960 if (verify_absent(merge
,
1961 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
1962 discard_cache_entry(merge
);
1965 invalidate_ce_path(merge
, o
);
1967 if (submodule_from_ce(ce
)) {
1968 int ret
= check_submodule_move_head(ce
, NULL
,
1969 oid_to_hex(&ce
->oid
),
1975 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
1977 * See if we can re-use the old CE directly?
1978 * That way we get the uptodate stat info.
1980 * This also removes the UPDATE flag on a match; otherwise
1981 * we will end up overwriting local changes in the work tree.
1983 if (same(old
, merge
)) {
1984 copy_cache_entry(merge
, old
);
1987 if (verify_uptodate(old
, o
)) {
1988 discard_cache_entry(merge
);
1991 /* Migrate old flags over */
1992 update
|= old
->ce_flags
& (CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
1993 invalidate_ce_path(old
, o
);
1996 if (submodule_from_ce(ce
)) {
1997 int ret
= check_submodule_move_head(ce
, oid_to_hex(&old
->oid
),
1998 oid_to_hex(&ce
->oid
),
2005 * Previously unmerged entry left as an existence
2006 * marker by read_index_unmerged();
2008 invalidate_ce_path(old
, o
);
2011 do_add_entry(o
, merge
, update
, CE_STAGEMASK
);
2015 static int deleted_entry(const struct cache_entry
*ce
,
2016 const struct cache_entry
*old
,
2017 struct unpack_trees_options
*o
)
2019 /* Did it exist in the index? */
2021 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2025 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
2027 add_entry(o
, ce
, CE_REMOVE
, 0);
2028 invalidate_ce_path(ce
, o
);
2032 static int keep_entry(const struct cache_entry
*ce
,
2033 struct unpack_trees_options
*o
)
2035 add_entry(o
, ce
, 0, 0);
2040 static void show_stage_entry(FILE *o
,
2041 const char *label
, const struct cache_entry
*ce
)
2044 fprintf(o
, "%s (missing)\n", label
);
2046 fprintf(o
, "%s%06o %s %d\t%s\n",
2049 oid_to_hex(&ce
->oid
),
2055 int threeway_merge(const struct cache_entry
* const *stages
,
2056 struct unpack_trees_options
*o
)
2058 const struct cache_entry
*index
;
2059 const struct cache_entry
*head
;
2060 const struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
2063 int remote_match
= 0;
2065 int df_conflict_head
= 0;
2066 int df_conflict_remote
= 0;
2068 int any_anc_missing
= 0;
2069 int no_anc_exists
= 1;
2072 for (i
= 1; i
< o
->head_idx
; i
++) {
2073 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
2074 any_anc_missing
= 1;
2080 head
= stages
[o
->head_idx
];
2082 if (head
== o
->df_conflict_entry
) {
2083 df_conflict_head
= 1;
2087 if (remote
== o
->df_conflict_entry
) {
2088 df_conflict_remote
= 1;
2093 * First, if there's a #16 situation, note that to prevent #13
2096 if (!same(remote
, head
)) {
2097 for (i
= 1; i
< o
->head_idx
; i
++) {
2098 if (same(stages
[i
], head
)) {
2101 if (same(stages
[i
], remote
)) {
2108 * We start with cases where the index is allowed to match
2109 * something other than the head: #14(ALT) and #2ALT, where it
2110 * is permitted to match the result instead.
2112 /* #14, #14ALT, #2ALT */
2113 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
2114 if (index
&& !same(index
, remote
) && !same(index
, head
))
2115 return reject_merge(index
, o
);
2116 return merged_entry(remote
, index
, o
);
2119 * If we have an entry in the index cache, then we want to
2120 * make sure that it matches head.
2122 if (index
&& !same(index
, head
))
2123 return reject_merge(index
, o
);
2127 if (same(head
, remote
))
2128 return merged_entry(head
, index
, o
);
2130 if (!df_conflict_remote
&& remote_match
&& !head_match
)
2131 return merged_entry(head
, index
, o
);
2135 if (!head
&& !remote
&& any_anc_missing
)
2139 * Under the "aggressive" rule, we resolve mostly trivial
2140 * cases that we historically had git-merge-one-file resolve.
2142 if (o
->aggressive
) {
2143 int head_deleted
= !head
;
2144 int remote_deleted
= !remote
;
2145 const struct cache_entry
*ce
= NULL
;
2154 for (i
= 1; i
< o
->head_idx
; i
++) {
2155 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2164 * Deleted in one and unchanged in the other.
2166 if ((head_deleted
&& remote_deleted
) ||
2167 (head_deleted
&& remote
&& remote_match
) ||
2168 (remote_deleted
&& head
&& head_match
)) {
2170 return deleted_entry(index
, index
, o
);
2171 if (ce
&& !head_deleted
) {
2172 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2178 * Added in both, identically.
2180 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
2181 return merged_entry(head
, index
, o
);
2185 /* Below are "no merge" cases, which require that the index be
2186 * up-to-date to avoid the files getting overwritten with
2187 * conflict resolution files.
2190 if (verify_uptodate(index
, o
))
2194 o
->nontrivial_merge
= 1;
2196 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2198 if (!head_match
|| !remote_match
) {
2199 for (i
= 1; i
< o
->head_idx
; i
++) {
2200 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2201 keep_entry(stages
[i
], o
);
2209 fprintf(stderr
, "read-tree: warning #16 detected\n");
2210 show_stage_entry(stderr
, "head ", stages
[head_match
]);
2211 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
2214 if (head
) { count
+= keep_entry(head
, o
); }
2215 if (remote
) { count
+= keep_entry(remote
, o
); }
2222 * The rule is to "carry forward" what is in the index without losing
2223 * information across a "fast-forward", favoring a successful merge
2224 * over a merge failure when it makes sense. For details of the
2225 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2228 int twoway_merge(const struct cache_entry
* const *src
,
2229 struct unpack_trees_options
*o
)
2231 const struct cache_entry
*current
= src
[0];
2232 const struct cache_entry
*oldtree
= src
[1];
2233 const struct cache_entry
*newtree
= src
[2];
2235 if (o
->merge_size
!= 2)
2236 return error("Cannot do a twoway merge of %d trees",
2239 if (oldtree
== o
->df_conflict_entry
)
2241 if (newtree
== o
->df_conflict_entry
)
2245 if (current
->ce_flags
& CE_CONFLICTED
) {
2246 if (same(oldtree
, newtree
) || o
->reset
) {
2248 return deleted_entry(current
, current
, o
);
2250 return merged_entry(newtree
, current
, o
);
2252 return reject_merge(current
, o
);
2253 } else if ((!oldtree
&& !newtree
) || /* 4 and 5 */
2254 (!oldtree
&& newtree
&&
2255 same(current
, newtree
)) || /* 6 and 7 */
2256 (oldtree
&& newtree
&&
2257 same(oldtree
, newtree
)) || /* 14 and 15 */
2258 (oldtree
&& newtree
&&
2259 !same(oldtree
, newtree
) && /* 18 and 19 */
2260 same(current
, newtree
))) {
2261 return keep_entry(current
, o
);
2262 } else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
2264 return deleted_entry(oldtree
, current
, o
);
2265 } else if (oldtree
&& newtree
&&
2266 same(current
, oldtree
) && !same(current
, newtree
)) {
2268 return merged_entry(newtree
, current
, o
);
2270 return reject_merge(current
, o
);
2273 if (oldtree
&& !o
->initial_checkout
) {
2275 * deletion of the path was staged;
2277 if (same(oldtree
, newtree
))
2279 return reject_merge(oldtree
, o
);
2281 return merged_entry(newtree
, current
, o
);
2283 return deleted_entry(oldtree
, current
, o
);
2289 * Keep the index entries at stage0, collapse stage1 but make sure
2290 * stage0 does not have anything there.
2292 int bind_merge(const struct cache_entry
* const *src
,
2293 struct unpack_trees_options
*o
)
2295 const struct cache_entry
*old
= src
[0];
2296 const struct cache_entry
*a
= src
[1];
2298 if (o
->merge_size
!= 1)
2299 return error("Cannot do a bind merge of %d trees",
2302 return o
->gently
? -1 :
2303 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
),
2304 super_prefixed(a
->name
),
2305 super_prefixed(old
->name
));
2307 return keep_entry(old
, o
);
2309 return merged_entry(a
, NULL
, o
);
2316 * - take the stat information from stage0, take the data from stage1
2318 int oneway_merge(const struct cache_entry
* const *src
,
2319 struct unpack_trees_options
*o
)
2321 const struct cache_entry
*old
= src
[0];
2322 const struct cache_entry
*a
= src
[1];
2324 if (o
->merge_size
!= 1)
2325 return error("Cannot do a oneway merge of %d trees",
2328 if (!a
|| a
== o
->df_conflict_entry
)
2329 return deleted_entry(old
, old
, o
);
2331 if (old
&& same(old
, a
)) {
2333 if (o
->reset
&& o
->update
&& !ce_uptodate(old
) && !ce_skip_worktree(old
)) {
2335 if (lstat(old
->name
, &st
) ||
2336 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
2337 update
|= CE_UPDATE
;
2339 if (o
->update
&& S_ISGITLINK(old
->ce_mode
) &&
2340 should_update_submodules() && !verify_uptodate(old
, o
))
2341 update
|= CE_UPDATE
;
2342 add_entry(o
, old
, update
, 0);
2345 return merged_entry(a
, old
, o
);