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
);
302 static struct progress
*get_progress(struct unpack_trees_options
*o
)
304 unsigned cnt
= 0, total
= 0;
305 struct index_state
*index
= &o
->result
;
307 if (!o
->update
|| !o
->verbose_update
)
310 for (; cnt
< index
->cache_nr
; cnt
++) {
311 const struct cache_entry
*ce
= index
->cache
[cnt
];
312 if (ce
->ce_flags
& (CE_UPDATE
| CE_WT_REMOVE
))
316 return start_delayed_progress(_("Checking out files"), total
);
319 static void setup_collided_checkout_detection(struct checkout
*state
,
320 struct index_state
*index
)
325 for (i
= 0; i
< index
->cache_nr
; i
++)
326 index
->cache
[i
]->ce_flags
&= ~CE_MATCHED
;
329 static void report_collided_checkout(struct index_state
*index
)
331 struct string_list list
= STRING_LIST_INIT_NODUP
;
334 for (i
= 0; i
< index
->cache_nr
; i
++) {
335 struct cache_entry
*ce
= index
->cache
[i
];
337 if (!(ce
->ce_flags
& CE_MATCHED
))
340 string_list_append(&list
, ce
->name
);
341 ce
->ce_flags
&= ~CE_MATCHED
;
344 list
.cmp
= fspathcmp
;
345 string_list_sort(&list
);
348 warning(_("the following paths have collided (e.g. case-sensitive paths\n"
349 "on a case-insensitive filesystem) and only one from the same\n"
350 "colliding group is in the working tree:\n"));
352 for (i
= 0; i
< list
.nr
; i
++)
353 fprintf(stderr
, " '%s'\n", list
.items
[i
].string
);
356 string_list_clear(&list
, 0);
359 static int check_updates(struct unpack_trees_options
*o
)
363 struct progress
*progress
;
364 struct index_state
*index
= &o
->result
;
365 struct checkout state
= CHECKOUT_INIT
;
368 trace_performance_enter();
371 state
.refresh_cache
= 1;
372 state
.istate
= index
;
375 setup_collided_checkout_detection(&state
, index
);
377 progress
= get_progress(o
);
380 git_attr_set_direction(GIT_ATTR_CHECKOUT
);
382 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
383 load_gitmodules_file(index
, NULL
);
385 for (i
= 0; i
< index
->cache_nr
; i
++) {
386 const struct cache_entry
*ce
= index
->cache
[i
];
388 if (ce
->ce_flags
& CE_WT_REMOVE
) {
389 display_progress(progress
, ++cnt
);
390 if (o
->update
&& !o
->dry_run
)
394 remove_marked_cache_entries(index
, 0);
395 remove_scheduled_dirs();
397 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
398 load_gitmodules_file(index
, &state
);
400 enable_delayed_checkout(&state
);
401 if (repository_format_partial_clone
&& o
->update
&& !o
->dry_run
) {
403 * Prefetch the objects that are to be checked out in the loop
406 struct oid_array to_fetch
= OID_ARRAY_INIT
;
407 int fetch_if_missing_store
= fetch_if_missing
;
408 fetch_if_missing
= 0;
409 for (i
= 0; i
< index
->cache_nr
; i
++) {
410 struct cache_entry
*ce
= index
->cache
[i
];
411 if ((ce
->ce_flags
& CE_UPDATE
) &&
412 !S_ISGITLINK(ce
->ce_mode
)) {
413 if (!has_object_file(&ce
->oid
))
414 oid_array_append(&to_fetch
, &ce
->oid
);
418 fetch_objects(repository_format_partial_clone
,
419 to_fetch
.oid
, to_fetch
.nr
);
420 fetch_if_missing
= fetch_if_missing_store
;
421 oid_array_clear(&to_fetch
);
423 for (i
= 0; i
< index
->cache_nr
; i
++) {
424 struct cache_entry
*ce
= index
->cache
[i
];
426 if (ce
->ce_flags
& CE_UPDATE
) {
427 if (ce
->ce_flags
& CE_WT_REMOVE
)
428 BUG("both update and delete flags are set on %s",
430 display_progress(progress
, ++cnt
);
431 ce
->ce_flags
&= ~CE_UPDATE
;
432 if (o
->update
&& !o
->dry_run
) {
433 errs
|= checkout_entry(ce
, &state
, NULL
, NULL
);
437 stop_progress(&progress
);
438 errs
|= finish_delayed_checkout(&state
, NULL
);
440 git_attr_set_direction(GIT_ATTR_CHECKIN
);
443 report_collided_checkout(index
);
445 trace_performance_leave("check_updates");
449 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
450 struct unpack_trees_options
*o
);
451 static int verify_absent_sparse(const struct cache_entry
*ce
,
452 enum unpack_trees_error_types
,
453 struct unpack_trees_options
*o
);
455 static int apply_sparse_checkout(struct index_state
*istate
,
456 struct cache_entry
*ce
,
457 struct unpack_trees_options
*o
)
459 int was_skip_worktree
= ce_skip_worktree(ce
);
461 if (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
)
462 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
464 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
465 if (was_skip_worktree
!= ce_skip_worktree(ce
)) {
466 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
467 mark_fsmonitor_invalid(istate
, ce
);
468 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
472 * if (!was_skip_worktree && !ce_skip_worktree()) {
473 * This is perfectly normal. Move on;
478 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
479 * area as a result of ce_skip_worktree() shortcuts in
480 * verify_absent() and verify_uptodate().
481 * Make sure they don't modify worktree if they are already
482 * outside checkout area
484 if (was_skip_worktree
&& ce_skip_worktree(ce
)) {
485 ce
->ce_flags
&= ~CE_UPDATE
;
488 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
489 * on to get that file removed from both index and worktree.
490 * If that file is already outside worktree area, don't
493 if (ce
->ce_flags
& CE_REMOVE
)
494 ce
->ce_flags
&= ~CE_WT_REMOVE
;
497 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
499 * If CE_UPDATE is set, verify_uptodate() must be called already
500 * also stat info may have lost after merged_entry() so calling
501 * verify_uptodate() again may fail
503 if (!(ce
->ce_flags
& CE_UPDATE
) && verify_uptodate_sparse(ce
, o
))
505 ce
->ce_flags
|= CE_WT_REMOVE
;
506 ce
->ce_flags
&= ~CE_UPDATE
;
508 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
509 if (verify_absent_sparse(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
511 ce
->ce_flags
|= CE_UPDATE
;
516 static inline int call_unpack_fn(const struct cache_entry
* const *src
,
517 struct unpack_trees_options
*o
)
519 int ret
= o
->fn(src
, o
);
525 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
527 ce
->ce_flags
|= CE_UNPACKED
;
529 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
530 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
531 int bottom
= o
->cache_bottom
;
532 while (bottom
< o
->src_index
->cache_nr
&&
533 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
535 o
->cache_bottom
= bottom
;
539 static void mark_all_ce_unused(struct index_state
*index
)
542 for (i
= 0; i
< index
->cache_nr
; i
++)
543 index
->cache
[i
]->ce_flags
&= ~(CE_UNPACKED
| CE_ADDED
| CE_NEW_SKIP_WORKTREE
);
546 static int locate_in_src_index(const struct cache_entry
*ce
,
547 struct unpack_trees_options
*o
)
549 struct index_state
*index
= o
->src_index
;
550 int len
= ce_namelen(ce
);
551 int pos
= index_name_pos(index
, ce
->name
, len
);
558 * We call unpack_index_entry() with an unmerged cache entry
559 * only in diff-index, and it wants a single callback. Skip
560 * the other unmerged entry with the same name.
562 static void mark_ce_used_same_name(struct cache_entry
*ce
,
563 struct unpack_trees_options
*o
)
565 struct index_state
*index
= o
->src_index
;
566 int len
= ce_namelen(ce
);
569 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
570 struct cache_entry
*next
= index
->cache
[pos
];
571 if (len
!= ce_namelen(next
) ||
572 memcmp(ce
->name
, next
->name
, len
))
574 mark_ce_used(next
, o
);
578 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
580 const struct index_state
*index
= o
->src_index
;
581 int pos
= o
->cache_bottom
;
583 while (pos
< index
->cache_nr
) {
584 struct cache_entry
*ce
= index
->cache
[pos
];
585 if (!(ce
->ce_flags
& CE_UNPACKED
))
592 static void add_same_unmerged(const struct cache_entry
*ce
,
593 struct unpack_trees_options
*o
)
595 struct index_state
*index
= o
->src_index
;
596 int len
= ce_namelen(ce
);
597 int pos
= index_name_pos(index
, ce
->name
, len
);
600 die("programming error in a caller of mark_ce_used_same_name");
601 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
602 struct cache_entry
*next
= index
->cache
[pos
];
603 if (len
!= ce_namelen(next
) ||
604 memcmp(ce
->name
, next
->name
, len
))
606 add_entry(o
, next
, 0, 0);
607 mark_ce_used(next
, o
);
611 static int unpack_index_entry(struct cache_entry
*ce
,
612 struct unpack_trees_options
*o
)
614 const struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
621 if (o
->skip_unmerged
) {
622 add_entry(o
, ce
, 0, 0);
626 ret
= call_unpack_fn(src
, o
);
628 mark_ce_used_same_name(ce
, o
);
632 static int find_cache_pos(struct traverse_info
*, const struct name_entry
*);
634 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
636 struct unpack_trees_options
*o
= info
->data
;
638 if (o
->diff_index_cached
)
640 o
->cache_bottom
= bottom
;
643 static int switch_cache_bottom(struct traverse_info
*info
)
645 struct unpack_trees_options
*o
= info
->data
;
648 if (o
->diff_index_cached
)
650 ret
= o
->cache_bottom
;
651 pos
= find_cache_pos(info
->prev
, &info
->name
);
654 o
->cache_bottom
= -2 - pos
;
656 o
->cache_bottom
= o
->src_index
->cache_nr
;
660 static inline int are_same_oid(struct name_entry
*name_j
, struct name_entry
*name_k
)
662 return !is_null_oid(&name_j
->oid
) && !is_null_oid(&name_k
->oid
) && oideq(&name_j
->oid
, &name_k
->oid
);
665 static int all_trees_same_as_cache_tree(int n
, unsigned long dirmask
,
666 struct name_entry
*names
,
667 struct traverse_info
*info
)
669 struct unpack_trees_options
*o
= info
->data
;
672 if (!o
->merge
|| dirmask
!= ((1 << n
) - 1))
675 for (i
= 1; i
< n
; i
++)
676 if (!are_same_oid(names
, names
+ i
))
679 return cache_tree_matches_traversal(o
->src_index
->cache_tree
, names
, info
);
682 static int index_pos_by_traverse_info(struct name_entry
*names
,
683 struct traverse_info
*info
)
685 struct unpack_trees_options
*o
= info
->data
;
686 int len
= traverse_path_len(info
, names
);
687 char *name
= xmalloc(len
+ 1 /* slash */ + 1 /* NUL */);
690 make_traverse_path(name
, info
, names
);
693 pos
= index_name_pos(o
->src_index
, name
, len
);
695 BUG("This is a directory and should not exist in index");
697 if (!starts_with(o
->src_index
->cache
[pos
]->name
, name
) ||
698 (pos
> 0 && starts_with(o
->src_index
->cache
[pos
-1]->name
, name
)))
699 BUG("pos must point at the first entry in this directory");
705 * Fast path if we detect that all trees are the same as cache-tree at this
706 * path. We'll walk these trees in an iterative loop using cache-tree/index
707 * instead of ODB since we already know what these trees contain.
709 static int traverse_by_cache_tree(int pos
, int nr_entries
, int nr_names
,
710 struct name_entry
*names
,
711 struct traverse_info
*info
)
713 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
714 struct unpack_trees_options
*o
= info
->data
;
715 struct cache_entry
*tree_ce
= NULL
;
720 BUG("We need cache-tree to do this optimization");
723 * Do what unpack_callback() and unpack_nondirectories() normally
724 * do. But we walk all paths in an iterative loop instead.
726 * D/F conflicts and higher stage entries are not a concern
727 * because cache-tree would be invalidated and we would never
728 * get here in the first place.
730 for (i
= 0; i
< nr_entries
; i
++) {
731 int new_ce_len
, len
, rc
;
733 src
[0] = o
->src_index
->cache
[pos
+ i
];
735 len
= ce_namelen(src
[0]);
736 new_ce_len
= cache_entry_size(len
);
738 if (new_ce_len
> ce_len
) {
740 tree_ce
= xrealloc(tree_ce
, new_ce_len
);
741 memset(tree_ce
, 0, new_ce_len
);
744 tree_ce
->ce_flags
= create_ce_flags(0);
746 for (d
= 1; d
<= nr_names
; d
++)
750 tree_ce
->ce_mode
= src
[0]->ce_mode
;
751 tree_ce
->ce_namelen
= len
;
752 oidcpy(&tree_ce
->oid
, &src
[0]->oid
);
753 memcpy(tree_ce
->name
, src
[0]->name
, len
+ 1);
755 rc
= call_unpack_fn((const struct cache_entry
* const *)src
, o
);
761 mark_ce_used(src
[0], o
);
765 printf("Unpacked %d entries from %s to %s using cache-tree\n",
767 o
->src_index
->cache
[pos
]->name
,
768 o
->src_index
->cache
[pos
+ nr_entries
- 1]->name
);
772 static int traverse_trees_recursive(int n
, unsigned long dirmask
,
773 unsigned long df_conflicts
,
774 struct name_entry
*names
,
775 struct traverse_info
*info
)
777 struct unpack_trees_options
*o
= info
->data
;
780 struct tree_desc t
[MAX_UNPACK_TREES
];
781 void *buf
[MAX_UNPACK_TREES
];
782 struct traverse_info newinfo
;
783 struct name_entry
*p
;
786 nr_entries
= all_trees_same_as_cache_tree(n
, dirmask
, names
, info
);
787 if (nr_entries
> 0) {
788 int pos
= index_pos_by_traverse_info(names
, info
);
790 if (!o
->merge
|| df_conflicts
)
791 BUG("Wrong condition to get here buddy");
794 * All entries up to 'pos' must have been processed
795 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
796 * save and restore cache_bottom anyway to not miss
797 * unprocessed entries before 'pos'.
799 bottom
= o
->cache_bottom
;
800 ret
= traverse_by_cache_tree(pos
, nr_entries
, n
, names
, info
);
801 o
->cache_bottom
= bottom
;
811 newinfo
.pathspec
= info
->pathspec
;
813 newinfo
.pathlen
+= tree_entry_len(p
) + 1;
814 newinfo
.df_conflicts
|= df_conflicts
;
817 * Fetch the tree from the ODB for each peer directory in the
820 * For 2- and 3-way traversals, we try to avoid hitting the
821 * ODB twice for the same OID. This should yield a nice speed
822 * up in checkouts and merges when the commits are similar.
824 * We don't bother doing the full O(n^2) search for larger n,
825 * because wider traversals don't happen that often and we
826 * avoid the search setup.
828 * When 2 peer OIDs are the same, we just copy the tree
829 * descriptor data. This implicitly borrows the buffer
830 * data from the earlier cell.
832 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
833 if (i
> 0 && are_same_oid(&names
[i
], &names
[i
- 1]))
835 else if (i
> 1 && are_same_oid(&names
[i
], &names
[i
- 2]))
838 const struct object_id
*oid
= NULL
;
841 buf
[nr_buf
++] = fill_tree_descriptor(t
+ i
, oid
);
845 bottom
= switch_cache_bottom(&newinfo
);
846 ret
= traverse_trees(o
->src_index
, n
, t
, &newinfo
);
847 restore_cache_bottom(&newinfo
, bottom
);
849 for (i
= 0; i
< nr_buf
; i
++)
856 * Compare the traverse-path to the cache entry without actually
857 * having to generate the textual representation of the traverse
860 * NOTE! This *only* compares up to the size of the traverse path
861 * itself - the caller needs to do the final check for the cache
862 * entry having more data at the end!
864 static int do_compare_entry_piecewise(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
866 int len
, pathlen
, ce_len
;
870 int cmp
= do_compare_entry_piecewise(ce
, info
->prev
,
875 pathlen
= info
->pathlen
;
876 ce_len
= ce_namelen(ce
);
878 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
879 if (ce_len
< pathlen
)
883 ce_name
= ce
->name
+ pathlen
;
885 len
= tree_entry_len(n
);
886 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
889 static int do_compare_entry(const struct cache_entry
*ce
,
890 const struct traverse_info
*info
,
891 const struct name_entry
*n
)
893 int len
, pathlen
, ce_len
;
898 * If we have not precomputed the traverse path, it is quicker
899 * to avoid doing so. But if we have precomputed it,
900 * it is quicker to use the precomputed version.
902 if (!info
->traverse_path
)
903 return do_compare_entry_piecewise(ce
, info
, n
);
905 cmp
= strncmp(ce
->name
, info
->traverse_path
, info
->pathlen
);
909 pathlen
= info
->pathlen
;
910 ce_len
= ce_namelen(ce
);
912 if (ce_len
< pathlen
)
916 ce_name
= ce
->name
+ pathlen
;
918 len
= tree_entry_len(n
);
919 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
922 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
924 int cmp
= do_compare_entry(ce
, info
, n
);
929 * Even if the beginning compared identically, the ce should
930 * compare as bigger than a directory leading up to it!
932 return ce_namelen(ce
) > traverse_path_len(info
, n
);
935 static int ce_in_traverse_path(const struct cache_entry
*ce
,
936 const struct traverse_info
*info
)
940 if (do_compare_entry(ce
, info
->prev
, &info
->name
))
943 * If ce (blob) is the same name as the path (which is a tree
944 * we will be descending into), it won't be inside it.
946 return (info
->pathlen
< ce_namelen(ce
));
949 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
,
950 const struct name_entry
*n
,
952 struct index_state
*istate
,
955 int len
= traverse_path_len(info
, n
);
956 struct cache_entry
*ce
=
958 make_empty_transient_cache_entry(len
) :
959 make_empty_cache_entry(istate
, len
);
961 ce
->ce_mode
= create_ce_mode(n
->mode
);
962 ce
->ce_flags
= create_ce_flags(stage
);
963 ce
->ce_namelen
= len
;
964 oidcpy(&ce
->oid
, &n
->oid
);
965 make_traverse_path(ce
->name
, info
, n
);
971 * Note that traverse_by_cache_tree() duplicates some logic in this function
972 * without actually calling it. If you change the logic here you may need to
973 * check and change there as well.
975 static int unpack_nondirectories(int n
, unsigned long mask
,
976 unsigned long dirmask
,
977 struct cache_entry
**src
,
978 const struct name_entry
*names
,
979 const struct traverse_info
*info
)
982 struct unpack_trees_options
*o
= info
->data
;
983 unsigned long conflicts
= info
->df_conflicts
| dirmask
;
985 /* Do we have *only* directories? Nothing to do */
986 if (mask
== dirmask
&& !src
[0])
990 * Ok, we've filled in up to any potential index entry in src[0],
993 for (i
= 0; i
< n
; i
++) {
995 unsigned int bit
= 1ul << i
;
996 if (conflicts
& bit
) {
997 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
1004 else if (i
+ 1 < o
->head_idx
)
1006 else if (i
+ 1 > o
->head_idx
)
1012 * If the merge bit is set, then the cache entries are
1013 * discarded in the following block. In this case,
1014 * construct "transient" cache_entries, as they are
1015 * not stored in the index. otherwise construct the
1016 * cache entry from the index aware logic.
1018 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
, &o
->result
, o
->merge
);
1022 int rc
= call_unpack_fn((const struct cache_entry
* const *)src
,
1024 for (i
= 0; i
< n
; i
++) {
1025 struct cache_entry
*ce
= src
[i
+ o
->merge
];
1026 if (ce
!= o
->df_conflict_entry
)
1027 discard_cache_entry(ce
);
1032 for (i
= 0; i
< n
; i
++)
1033 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
1034 if (do_add_entry(o
, src
[i
], 0, 0))
1040 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
1042 discard_index(&o
->result
);
1043 if (!o
->gently
&& !o
->exiting_early
) {
1045 return error("%s", message
);
1052 * The tree traversal is looking at name p. If we have a matching entry,
1053 * return it. If name p is a directory in the index, do not return
1054 * anything, as we will want to match it when the traversal descends into
1057 static int find_cache_pos(struct traverse_info
*info
,
1058 const struct name_entry
*p
)
1061 struct unpack_trees_options
*o
= info
->data
;
1062 struct index_state
*index
= o
->src_index
;
1063 int pfxlen
= info
->pathlen
;
1064 int p_len
= tree_entry_len(p
);
1066 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
1067 const struct cache_entry
*ce
= index
->cache
[pos
];
1068 const char *ce_name
, *ce_slash
;
1071 if (ce
->ce_flags
& CE_UNPACKED
) {
1073 * cache_bottom entry is already unpacked, so
1074 * we can never match it; don't check it
1077 if (pos
== o
->cache_bottom
)
1081 if (!ce_in_traverse_path(ce
, info
)) {
1083 * Check if we can skip future cache checks
1084 * (because we're already past all possible
1085 * entries in the traverse path).
1087 if (info
->traverse_path
) {
1088 if (strncmp(ce
->name
, info
->traverse_path
,
1094 ce_name
= ce
->name
+ pfxlen
;
1095 ce_slash
= strchr(ce_name
, '/');
1097 ce_len
= ce_slash
- ce_name
;
1099 ce_len
= ce_namelen(ce
) - pfxlen
;
1100 cmp
= name_compare(p
->path
, p_len
, ce_name
, ce_len
);
1102 * Exact match; if we have a directory we need to
1103 * delay returning it.
1106 return ce_slash
? -2 - pos
: pos
;
1108 continue; /* keep looking */
1110 * ce_name sorts after p->path; could it be that we
1111 * have files under p->path directory in the index?
1112 * E.g. ce_name == "t-i", and p->path == "t"; we may
1113 * have "t/a" in the index.
1115 if (p_len
< ce_len
&& !memcmp(ce_name
, p
->path
, p_len
) &&
1116 ce_name
[p_len
] < '/')
1117 continue; /* keep looking */
1123 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
1124 const struct name_entry
*p
)
1126 int pos
= find_cache_pos(info
, p
);
1127 struct unpack_trees_options
*o
= info
->data
;
1130 return o
->src_index
->cache
[pos
];
1135 static void debug_path(struct traverse_info
*info
)
1138 debug_path(info
->prev
);
1139 if (*info
->prev
->name
.path
)
1142 printf("%s", info
->name
.path
);
1145 static void debug_name_entry(int i
, struct name_entry
*n
)
1147 printf("ent#%d %06o %s\n", i
,
1148 n
->path
? n
->mode
: 0,
1149 n
->path
? n
->path
: "(missing)");
1152 static void debug_unpack_callback(int n
,
1154 unsigned long dirmask
,
1155 struct name_entry
*names
,
1156 struct traverse_info
*info
)
1159 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1163 for (i
= 0; i
< n
; i
++)
1164 debug_name_entry(i
, names
+ i
);
1168 * Note that traverse_by_cache_tree() duplicates some logic in this function
1169 * without actually calling it. If you change the logic here you may need to
1170 * check and change there as well.
1172 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
1174 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
1175 struct unpack_trees_options
*o
= info
->data
;
1176 const struct name_entry
*p
= names
;
1178 /* Find first entry with a real name (we could use "mask" too) */
1182 if (o
->debug_unpack
)
1183 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
1185 /* Are we supposed to look at the index too? */
1189 struct cache_entry
*ce
;
1191 if (o
->diff_index_cached
)
1192 ce
= next_cache_entry(o
);
1194 ce
= find_cache_entry(info
, p
);
1198 cmp
= compare_entry(ce
, info
, p
);
1200 if (unpack_index_entry(ce
, o
) < 0)
1201 return unpack_failed(o
, NULL
);
1207 * If we skip unmerged index
1208 * entries, we'll skip this
1209 * entry *and* the tree
1210 * entries associated with it!
1212 if (o
->skip_unmerged
) {
1213 add_same_unmerged(ce
, o
);
1223 if (unpack_nondirectories(n
, mask
, dirmask
, src
, names
, info
) < 0)
1226 if (o
->merge
&& src
[0]) {
1227 if (ce_stage(src
[0]))
1228 mark_ce_used_same_name(src
[0], o
);
1230 mark_ce_used(src
[0], o
);
1233 /* Now handle any directories.. */
1235 /* special case: "diff-index --cached" looking at a tree */
1236 if (o
->diff_index_cached
&&
1237 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
1239 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
1242 * Everything under the name matches; skip the
1243 * entire hierarchy. diff_index_cached codepath
1244 * special cases D/F conflicts in such a way that
1245 * it does not do any look-ahead, so this is safe.
1248 o
->cache_bottom
+= matches
;
1253 if (traverse_trees_recursive(n
, dirmask
, mask
& ~dirmask
,
1262 static int clear_ce_flags_1(struct index_state
*istate
,
1263 struct cache_entry
**cache
, int nr
,
1264 struct strbuf
*prefix
,
1265 int select_mask
, int clear_mask
,
1266 struct exclude_list
*el
, int defval
);
1268 /* Whole directory matching */
1269 static int clear_ce_flags_dir(struct index_state
*istate
,
1270 struct cache_entry
**cache
, int nr
,
1271 struct strbuf
*prefix
,
1273 int select_mask
, int clear_mask
,
1274 struct exclude_list
*el
, int defval
)
1276 struct cache_entry
**cache_end
;
1278 int ret
= is_excluded_from_list(prefix
->buf
, prefix
->len
,
1279 basename
, &dtype
, el
, istate
);
1282 strbuf_addch(prefix
, '/');
1284 /* If undecided, use matching result of parent dir in defval */
1288 for (cache_end
= cache
; cache_end
!= cache
+ nr
; cache_end
++) {
1289 struct cache_entry
*ce
= *cache_end
;
1290 if (strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1295 * TODO: check el, if there are no patterns that may conflict
1296 * with ret (iow, we know in advance the incl/excl
1297 * decision for the entire directory), clear flag here without
1298 * calling clear_ce_flags_1(). That function will call
1299 * the expensive is_excluded_from_list() on every entry.
1301 rc
= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1303 select_mask
, clear_mask
,
1305 strbuf_setlen(prefix
, prefix
->len
- 1);
1310 * Traverse the index, find every entry that matches according to
1311 * o->el. Do "ce_flags &= ~clear_mask" on those entries. Return the
1312 * number of traversed entries.
1314 * If select_mask is non-zero, only entries whose ce_flags has on of
1315 * those bits enabled are traversed.
1317 * cache : pointer to an index entry
1318 * prefix_len : an offset to its path
1320 * The current path ("prefix") including the trailing '/' is
1321 * cache[0]->name[0..(prefix_len-1)]
1322 * Top level path has prefix_len zero.
1324 static int clear_ce_flags_1(struct index_state
*istate
,
1325 struct cache_entry
**cache
, int nr
,
1326 struct strbuf
*prefix
,
1327 int select_mask
, int clear_mask
,
1328 struct exclude_list
*el
, int defval
)
1330 struct cache_entry
**cache_end
= cache
+ nr
;
1333 * Process all entries that have the given prefix and meet
1334 * select_mask condition
1336 while(cache
!= cache_end
) {
1337 struct cache_entry
*ce
= *cache
;
1338 const char *name
, *slash
;
1339 int len
, dtype
, ret
;
1341 if (select_mask
&& !(ce
->ce_flags
& select_mask
)) {
1346 if (prefix
->len
&& strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1349 name
= ce
->name
+ prefix
->len
;
1350 slash
= strchr(name
, '/');
1352 /* If it's a directory, try whole directory match first */
1357 strbuf_add(prefix
, name
, len
);
1359 processed
= clear_ce_flags_dir(istate
, cache
, cache_end
- cache
,
1361 prefix
->buf
+ prefix
->len
- len
,
1362 select_mask
, clear_mask
,
1365 /* clear_c_f_dir eats a whole dir already? */
1368 strbuf_setlen(prefix
, prefix
->len
- len
);
1372 strbuf_addch(prefix
, '/');
1373 cache
+= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1375 select_mask
, clear_mask
, el
, defval
);
1376 strbuf_setlen(prefix
, prefix
->len
- len
- 1);
1381 dtype
= ce_to_dtype(ce
);
1382 ret
= is_excluded_from_list(ce
->name
, ce_namelen(ce
),
1383 name
, &dtype
, el
, istate
);
1387 ce
->ce_flags
&= ~clear_mask
;
1390 return nr
- (cache_end
- cache
);
1393 static int clear_ce_flags(struct index_state
*istate
,
1394 int select_mask
, int clear_mask
,
1395 struct exclude_list
*el
)
1397 static struct strbuf prefix
= STRBUF_INIT
;
1399 strbuf_reset(&prefix
);
1401 return clear_ce_flags_1(istate
,
1405 select_mask
, clear_mask
,
1410 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1412 static void mark_new_skip_worktree(struct exclude_list
*el
,
1413 struct index_state
*istate
,
1414 int select_flag
, int skip_wt_flag
)
1419 * 1. Pretend the narrowest worktree: only unmerged entries
1422 for (i
= 0; i
< istate
->cache_nr
; i
++) {
1423 struct cache_entry
*ce
= istate
->cache
[i
];
1425 if (select_flag
&& !(ce
->ce_flags
& select_flag
))
1428 if (!ce_stage(ce
) && !(ce
->ce_flags
& CE_CONFLICTED
))
1429 ce
->ce_flags
|= skip_wt_flag
;
1431 ce
->ce_flags
&= ~skip_wt_flag
;
1435 * 2. Widen worktree according to sparse-checkout file.
1436 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1438 clear_ce_flags(istate
, select_flag
, skip_wt_flag
, el
);
1441 static int verify_absent(const struct cache_entry
*,
1442 enum unpack_trees_error_types
,
1443 struct unpack_trees_options
*);
1445 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1446 * resulting index, -2 on failure to reflect the changes to the work tree.
1448 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1450 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
1453 static struct cache_entry
*dfc
;
1454 struct exclude_list el
;
1456 if (len
> MAX_UNPACK_TREES
)
1457 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
1459 trace_performance_enter();
1460 memset(&el
, 0, sizeof(el
));
1461 if (!core_apply_sparse_checkout
|| !o
->update
)
1462 o
->skip_sparse_checkout
= 1;
1463 if (!o
->skip_sparse_checkout
) {
1464 char *sparse
= git_pathdup("info/sparse-checkout");
1465 if (add_excludes_from_file_to_list(sparse
, "", 0, &el
, NULL
) < 0)
1466 o
->skip_sparse_checkout
= 1;
1472 memset(&o
->result
, 0, sizeof(o
->result
));
1473 o
->result
.initialized
= 1;
1474 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
1475 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
1476 o
->result
.version
= o
->src_index
->version
;
1477 if (!o
->src_index
->split_index
) {
1478 o
->result
.split_index
= NULL
;
1479 } else if (o
->src_index
== o
->dst_index
) {
1481 * o->dst_index (and thus o->src_index) will be discarded
1482 * and overwritten with o->result at the end of this function,
1483 * so just use src_index's split_index to avoid having to
1486 o
->result
.split_index
= o
->src_index
->split_index
;
1487 o
->result
.split_index
->refcount
++;
1489 o
->result
.split_index
= init_split_index(&o
->result
);
1491 oidcpy(&o
->result
.oid
, &o
->src_index
->oid
);
1492 o
->merge_size
= len
;
1493 mark_all_ce_unused(o
->src_index
);
1496 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1498 if (!o
->skip_sparse_checkout
)
1499 mark_new_skip_worktree(o
->el
, o
->src_index
, 0, CE_NEW_SKIP_WORKTREE
);
1502 dfc
= xcalloc(1, cache_entry_size(0));
1503 o
->df_conflict_entry
= dfc
;
1506 const char *prefix
= o
->prefix
? o
->prefix
: "";
1507 struct traverse_info info
;
1509 setup_traverse_info(&info
, prefix
);
1510 info
.fn
= unpack_callback
;
1512 info
.show_all_errors
= o
->show_all_errors
;
1513 info
.pathspec
= o
->pathspec
;
1517 * Unpack existing index entries that sort before the
1518 * prefix the tree is spliced into. Note that o->merge
1519 * is always true in this case.
1522 struct cache_entry
*ce
= next_cache_entry(o
);
1525 if (ce_in_traverse_path(ce
, &info
))
1527 if (unpack_index_entry(ce
, o
) < 0)
1532 trace_performance_enter();
1533 ret
= traverse_trees(o
->src_index
, len
, t
, &info
);
1534 trace_performance_leave("traverse_trees");
1539 /* Any left-over entries in the index? */
1542 struct cache_entry
*ce
= next_cache_entry(o
);
1545 if (unpack_index_entry(ce
, o
) < 0)
1549 mark_all_ce_unused(o
->src_index
);
1551 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
1552 ret
= unpack_failed(o
, "Merge requires file-level merging");
1556 if (!o
->skip_sparse_checkout
) {
1557 int empty_worktree
= 1;
1560 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1561 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1562 * so apply_sparse_checkout() won't attempt to remove it from worktree
1564 mark_new_skip_worktree(o
->el
, &o
->result
, CE_ADDED
, CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
1567 for (i
= 0; i
< o
->result
.cache_nr
; i
++) {
1568 struct cache_entry
*ce
= o
->result
.cache
[i
];
1571 * Entries marked with CE_ADDED in merged_entry() do not have
1572 * verify_absent() check (the check is effectively disabled
1573 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1575 * Do the real check now because we have had
1576 * correct CE_NEW_SKIP_WORKTREE
1578 if (ce
->ce_flags
& CE_ADDED
&&
1579 verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
1580 if (!o
->show_all_errors
)
1585 if (apply_sparse_checkout(&o
->result
, ce
, o
)) {
1586 if (!o
->show_all_errors
)
1590 if (!ce_skip_worktree(ce
))
1597 * Sparse checkout is meant to narrow down checkout area
1598 * but it does not make sense to narrow down to empty working
1599 * tree. This is usually a mistake in sparse checkout rules.
1600 * Do not allow users to do that.
1602 if (o
->result
.cache_nr
&& empty_worktree
) {
1603 ret
= unpack_failed(o
, "Sparse checkout leaves no entry on working directory");
1608 ret
= check_updates(o
) ? (-2) : 0;
1610 move_index_extensions(&o
->result
, o
->src_index
);
1612 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
1613 cache_tree_verify(the_repository
, &o
->result
);
1614 if (!o
->result
.cache_tree
)
1615 o
->result
.cache_tree
= cache_tree();
1616 if (!cache_tree_fully_valid(o
->result
.cache_tree
))
1617 cache_tree_update(&o
->result
,
1622 o
->result
.updated_workdir
= 1;
1623 discard_index(o
->dst_index
);
1624 *o
->dst_index
= o
->result
;
1626 discard_index(&o
->result
);
1628 o
->src_index
= NULL
;
1631 trace_performance_leave("unpack_trees");
1632 clear_exclude_list(&el
);
1636 if (o
->show_all_errors
)
1637 display_error_msgs(o
);
1638 mark_all_ce_unused(o
->src_index
);
1639 ret
= unpack_failed(o
, NULL
);
1640 if (o
->exiting_early
)
1645 /* Here come the merge functions */
1647 static int reject_merge(const struct cache_entry
*ce
,
1648 struct unpack_trees_options
*o
)
1650 return o
->gently
? -1 :
1651 add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
1654 static int same(const struct cache_entry
*a
, const struct cache_entry
*b
)
1660 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
1662 return a
->ce_mode
== b
->ce_mode
&&
1663 oideq(&a
->oid
, &b
->oid
);
1668 * When a CE gets turned into an unmerged entry, we
1669 * want it to be up-to-date
1671 static int verify_uptodate_1(const struct cache_entry
*ce
,
1672 struct unpack_trees_options
*o
,
1673 enum unpack_trees_error_types error_type
)
1681 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1682 * if this entry is truly up-to-date because this file may be
1685 if ((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
))
1686 ; /* keep checking */
1687 else if (o
->reset
|| ce_uptodate(ce
))
1690 if (!lstat(ce
->name
, &st
)) {
1691 int flags
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
;
1692 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, flags
);
1694 if (submodule_from_ce(ce
)) {
1695 int r
= check_submodule_move_head(ce
,
1696 "HEAD", oid_to_hex(&ce
->oid
), o
);
1698 return o
->gently
? -1 :
1699 add_rejected_path(o
, error_type
, ce
->name
);
1706 * Historic default policy was to allow submodule to be out
1707 * of sync wrt the superproject index. If the submodule was
1708 * not considered interesting above, we don't care here.
1710 if (S_ISGITLINK(ce
->ce_mode
))
1715 if (errno
== ENOENT
)
1717 return o
->gently
? -1 :
1718 add_rejected_path(o
, error_type
, ce
->name
);
1721 int verify_uptodate(const struct cache_entry
*ce
,
1722 struct unpack_trees_options
*o
)
1724 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1726 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
1729 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
1730 struct unpack_trees_options
*o
)
1732 return verify_uptodate_1(ce
, o
, ERROR_SPARSE_NOT_UPTODATE_FILE
);
1736 * TODO: We should actually invalidate o->result, not src_index [1].
1737 * But since cache tree and untracked cache both are not copied to
1738 * o->result until unpacking is complete, we invalidate them on
1739 * src_index instead with the assumption that they will be copied to
1740 * dst_index at the end.
1742 * [1] src_index->cache_tree is also used in unpack_callback() so if
1743 * we invalidate o->result, we need to update it to use
1744 * o->result.cache_tree as well.
1746 static void invalidate_ce_path(const struct cache_entry
*ce
,
1747 struct unpack_trees_options
*o
)
1751 cache_tree_invalidate_path(o
->src_index
, ce
->name
);
1752 untracked_cache_invalidate_path(o
->src_index
, ce
->name
, 1);
1756 * Check that checking out ce->sha1 in subdir ce->name is not
1757 * going to overwrite any working files.
1759 * Currently, git does not checkout subprojects during a superproject
1760 * checkout, so it is not going to overwrite anything.
1762 static int verify_clean_submodule(const char *old_sha1
,
1763 const struct cache_entry
*ce
,
1764 enum unpack_trees_error_types error_type
,
1765 struct unpack_trees_options
*o
)
1767 if (!submodule_from_ce(ce
))
1770 return check_submodule_move_head(ce
, old_sha1
,
1771 oid_to_hex(&ce
->oid
), o
);
1774 static int verify_clean_subdirectory(const struct cache_entry
*ce
,
1775 enum unpack_trees_error_types error_type
,
1776 struct unpack_trees_options
*o
)
1779 * we are about to extract "ce->name"; we would not want to lose
1780 * anything in the existing directory there.
1784 struct dir_struct d
;
1788 if (S_ISGITLINK(ce
->ce_mode
)) {
1789 struct object_id oid
;
1790 int sub_head
= resolve_gitlink_ref(ce
->name
, "HEAD", &oid
);
1792 * If we are not going to update the submodule, then
1795 if (!sub_head
&& oideq(&oid
, &ce
->oid
))
1797 return verify_clean_submodule(sub_head
? NULL
: oid_to_hex(&oid
),
1802 * First let's make sure we do not have a local modification
1803 * in that directory.
1805 namelen
= ce_namelen(ce
);
1806 for (i
= locate_in_src_index(ce
, o
);
1807 i
< o
->src_index
->cache_nr
;
1809 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
1810 int len
= ce_namelen(ce2
);
1811 if (len
< namelen
||
1812 strncmp(ce
->name
, ce2
->name
, namelen
) ||
1813 ce2
->name
[namelen
] != '/')
1816 * ce2->name is an entry in the subdirectory to be
1819 if (!ce_stage(ce2
)) {
1820 if (verify_uptodate(ce2
, o
))
1822 add_entry(o
, ce2
, CE_REMOVE
, 0);
1823 invalidate_ce_path(ce
, o
);
1824 mark_ce_used(ce2
, o
);
1830 * Then we need to make sure that we do not lose a locally
1831 * present file that is not ignored.
1833 pathbuf
= xstrfmt("%.*s/", namelen
, ce
->name
);
1835 memset(&d
, 0, sizeof(d
));
1837 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
1838 i
= read_directory(&d
, o
->src_index
, pathbuf
, namelen
+1, NULL
);
1840 return o
->gently
? -1 :
1841 add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
1847 * This gets called when there was no index entry for the tree entry 'dst',
1848 * but we found a file in the working tree that 'lstat()' said was fine,
1849 * and we're on a case-insensitive filesystem.
1851 * See if we can find a case-insensitive match in the index that also
1852 * matches the stat information, and assume it's that other file!
1854 static int icase_exists(struct unpack_trees_options
*o
, const char *name
, int len
, struct stat
*st
)
1856 const struct cache_entry
*src
;
1858 src
= index_file_exists(o
->src_index
, name
, len
, 1);
1859 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
1862 static int check_ok_to_remove(const char *name
, int len
, int dtype
,
1863 const struct cache_entry
*ce
, struct stat
*st
,
1864 enum unpack_trees_error_types error_type
,
1865 struct unpack_trees_options
*o
)
1867 const struct cache_entry
*result
;
1870 * It may be that the 'lstat()' succeeded even though
1871 * target 'ce' was absent, because there is an old
1872 * entry that is different only in case..
1874 * Ignore that lstat() if it matches.
1876 if (ignore_case
&& icase_exists(o
, name
, len
, st
))
1880 is_excluded(o
->dir
, o
->src_index
, name
, &dtype
))
1882 * ce->name is explicitly excluded, so it is Ok to
1886 if (S_ISDIR(st
->st_mode
)) {
1888 * We are checking out path "foo" and
1889 * found "foo/." in the working tree.
1890 * This is tricky -- if we have modified
1891 * files that are in "foo/" we would lose
1894 if (verify_clean_subdirectory(ce
, error_type
, o
) < 0)
1900 * The previous round may already have decided to
1901 * delete this path, which is in a subdirectory that
1902 * is being replaced with a blob.
1904 result
= index_file_exists(&o
->result
, name
, len
, 0);
1906 if (result
->ce_flags
& CE_REMOVE
)
1910 return o
->gently
? -1 :
1911 add_rejected_path(o
, error_type
, name
);
1915 * We do not want to remove or overwrite a working tree file that
1916 * is not tracked, unless it is ignored.
1918 static int verify_absent_1(const struct cache_entry
*ce
,
1919 enum unpack_trees_error_types error_type
,
1920 struct unpack_trees_options
*o
)
1925 if (o
->index_only
|| o
->reset
|| !o
->update
)
1928 len
= check_leading_path(ce
->name
, ce_namelen(ce
));
1935 path
= xmemdupz(ce
->name
, len
);
1936 if (lstat(path
, &st
))
1937 ret
= error_errno("cannot stat '%s'", path
);
1939 if (submodule_from_ce(ce
))
1940 ret
= check_submodule_move_head(ce
,
1941 oid_to_hex(&ce
->oid
),
1944 ret
= check_ok_to_remove(path
, len
, DT_UNKNOWN
, NULL
,
1945 &st
, error_type
, o
);
1949 } else if (lstat(ce
->name
, &st
)) {
1950 if (errno
!= ENOENT
)
1951 return error_errno("cannot stat '%s'", ce
->name
);
1954 if (submodule_from_ce(ce
))
1955 return check_submodule_move_head(ce
, oid_to_hex(&ce
->oid
),
1958 return check_ok_to_remove(ce
->name
, ce_namelen(ce
),
1959 ce_to_dtype(ce
), ce
, &st
,
1964 static int verify_absent(const struct cache_entry
*ce
,
1965 enum unpack_trees_error_types error_type
,
1966 struct unpack_trees_options
*o
)
1968 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1970 return verify_absent_1(ce
, error_type
, o
);
1973 static int verify_absent_sparse(const struct cache_entry
*ce
,
1974 enum unpack_trees_error_types error_type
,
1975 struct unpack_trees_options
*o
)
1977 enum unpack_trees_error_types orphaned_error
= error_type
;
1978 if (orphaned_error
== ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
)
1979 orphaned_error
= ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
;
1981 return verify_absent_1(ce
, orphaned_error
, o
);
1984 static int merged_entry(const struct cache_entry
*ce
,
1985 const struct cache_entry
*old
,
1986 struct unpack_trees_options
*o
)
1988 int update
= CE_UPDATE
;
1989 struct cache_entry
*merge
= dup_cache_entry(ce
, &o
->result
);
1993 * New index entries. In sparse checkout, the following
1994 * verify_absent() will be delayed until after
1995 * traverse_trees() finishes in unpack_trees(), then:
1997 * - CE_NEW_SKIP_WORKTREE will be computed correctly
1998 * - verify_absent() be called again, this time with
1999 * correct CE_NEW_SKIP_WORKTREE
2001 * verify_absent() call here does nothing in sparse
2002 * checkout (i.e. o->skip_sparse_checkout == 0)
2005 merge
->ce_flags
|= CE_NEW_SKIP_WORKTREE
;
2007 if (verify_absent(merge
,
2008 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
2009 discard_cache_entry(merge
);
2012 invalidate_ce_path(merge
, o
);
2014 if (submodule_from_ce(ce
)) {
2015 int ret
= check_submodule_move_head(ce
, NULL
,
2016 oid_to_hex(&ce
->oid
),
2022 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
2024 * See if we can re-use the old CE directly?
2025 * That way we get the uptodate stat info.
2027 * This also removes the UPDATE flag on a match; otherwise
2028 * we will end up overwriting local changes in the work tree.
2030 if (same(old
, merge
)) {
2031 copy_cache_entry(merge
, old
);
2034 if (verify_uptodate(old
, o
)) {
2035 discard_cache_entry(merge
);
2038 /* Migrate old flags over */
2039 update
|= old
->ce_flags
& (CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
2040 invalidate_ce_path(old
, o
);
2043 if (submodule_from_ce(ce
)) {
2044 int ret
= check_submodule_move_head(ce
, oid_to_hex(&old
->oid
),
2045 oid_to_hex(&ce
->oid
),
2052 * Previously unmerged entry left as an existence
2053 * marker by read_index_unmerged();
2055 invalidate_ce_path(old
, o
);
2058 do_add_entry(o
, merge
, update
, CE_STAGEMASK
);
2062 static int deleted_entry(const struct cache_entry
*ce
,
2063 const struct cache_entry
*old
,
2064 struct unpack_trees_options
*o
)
2066 /* Did it exist in the index? */
2068 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2072 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
2074 add_entry(o
, ce
, CE_REMOVE
, 0);
2075 invalidate_ce_path(ce
, o
);
2079 static int keep_entry(const struct cache_entry
*ce
,
2080 struct unpack_trees_options
*o
)
2082 add_entry(o
, ce
, 0, 0);
2084 invalidate_ce_path(ce
, o
);
2089 static void show_stage_entry(FILE *o
,
2090 const char *label
, const struct cache_entry
*ce
)
2093 fprintf(o
, "%s (missing)\n", label
);
2095 fprintf(o
, "%s%06o %s %d\t%s\n",
2098 oid_to_hex(&ce
->oid
),
2104 int threeway_merge(const struct cache_entry
* const *stages
,
2105 struct unpack_trees_options
*o
)
2107 const struct cache_entry
*index
;
2108 const struct cache_entry
*head
;
2109 const struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
2112 int remote_match
= 0;
2114 int df_conflict_head
= 0;
2115 int df_conflict_remote
= 0;
2117 int any_anc_missing
= 0;
2118 int no_anc_exists
= 1;
2121 for (i
= 1; i
< o
->head_idx
; i
++) {
2122 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
2123 any_anc_missing
= 1;
2129 head
= stages
[o
->head_idx
];
2131 if (head
== o
->df_conflict_entry
) {
2132 df_conflict_head
= 1;
2136 if (remote
== o
->df_conflict_entry
) {
2137 df_conflict_remote
= 1;
2142 * First, if there's a #16 situation, note that to prevent #13
2145 if (!same(remote
, head
)) {
2146 for (i
= 1; i
< o
->head_idx
; i
++) {
2147 if (same(stages
[i
], head
)) {
2150 if (same(stages
[i
], remote
)) {
2157 * We start with cases where the index is allowed to match
2158 * something other than the head: #14(ALT) and #2ALT, where it
2159 * is permitted to match the result instead.
2161 /* #14, #14ALT, #2ALT */
2162 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
2163 if (index
&& !same(index
, remote
) && !same(index
, head
))
2164 return reject_merge(index
, o
);
2165 return merged_entry(remote
, index
, o
);
2168 * If we have an entry in the index cache, then we want to
2169 * make sure that it matches head.
2171 if (index
&& !same(index
, head
))
2172 return reject_merge(index
, o
);
2176 if (same(head
, remote
))
2177 return merged_entry(head
, index
, o
);
2179 if (!df_conflict_remote
&& remote_match
&& !head_match
)
2180 return merged_entry(head
, index
, o
);
2184 if (!head
&& !remote
&& any_anc_missing
)
2188 * Under the "aggressive" rule, we resolve mostly trivial
2189 * cases that we historically had git-merge-one-file resolve.
2191 if (o
->aggressive
) {
2192 int head_deleted
= !head
;
2193 int remote_deleted
= !remote
;
2194 const struct cache_entry
*ce
= NULL
;
2203 for (i
= 1; i
< o
->head_idx
; i
++) {
2204 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2213 * Deleted in one and unchanged in the other.
2215 if ((head_deleted
&& remote_deleted
) ||
2216 (head_deleted
&& remote
&& remote_match
) ||
2217 (remote_deleted
&& head
&& head_match
)) {
2219 return deleted_entry(index
, index
, o
);
2220 if (ce
&& !head_deleted
) {
2221 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2227 * Added in both, identically.
2229 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
2230 return merged_entry(head
, index
, o
);
2234 /* Below are "no merge" cases, which require that the index be
2235 * up-to-date to avoid the files getting overwritten with
2236 * conflict resolution files.
2239 if (verify_uptodate(index
, o
))
2243 o
->nontrivial_merge
= 1;
2245 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2247 if (!head_match
|| !remote_match
) {
2248 for (i
= 1; i
< o
->head_idx
; i
++) {
2249 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2250 keep_entry(stages
[i
], o
);
2258 fprintf(stderr
, "read-tree: warning #16 detected\n");
2259 show_stage_entry(stderr
, "head ", stages
[head_match
]);
2260 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
2263 if (head
) { count
+= keep_entry(head
, o
); }
2264 if (remote
) { count
+= keep_entry(remote
, o
); }
2271 * The rule is to "carry forward" what is in the index without losing
2272 * information across a "fast-forward", favoring a successful merge
2273 * over a merge failure when it makes sense. For details of the
2274 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2277 int twoway_merge(const struct cache_entry
* const *src
,
2278 struct unpack_trees_options
*o
)
2280 const struct cache_entry
*current
= src
[0];
2281 const struct cache_entry
*oldtree
= src
[1];
2282 const struct cache_entry
*newtree
= src
[2];
2284 if (o
->merge_size
!= 2)
2285 return error("Cannot do a twoway merge of %d trees",
2288 if (oldtree
== o
->df_conflict_entry
)
2290 if (newtree
== o
->df_conflict_entry
)
2294 if (current
->ce_flags
& CE_CONFLICTED
) {
2295 if (same(oldtree
, newtree
) || o
->reset
) {
2297 return deleted_entry(current
, current
, o
);
2299 return merged_entry(newtree
, current
, o
);
2301 return reject_merge(current
, o
);
2302 } else if ((!oldtree
&& !newtree
) || /* 4 and 5 */
2303 (!oldtree
&& newtree
&&
2304 same(current
, newtree
)) || /* 6 and 7 */
2305 (oldtree
&& newtree
&&
2306 same(oldtree
, newtree
)) || /* 14 and 15 */
2307 (oldtree
&& newtree
&&
2308 !same(oldtree
, newtree
) && /* 18 and 19 */
2309 same(current
, newtree
))) {
2310 return keep_entry(current
, o
);
2311 } else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
2313 return deleted_entry(oldtree
, current
, o
);
2314 } else if (oldtree
&& newtree
&&
2315 same(current
, oldtree
) && !same(current
, newtree
)) {
2317 return merged_entry(newtree
, current
, o
);
2319 return reject_merge(current
, o
);
2322 if (oldtree
&& !o
->initial_checkout
) {
2324 * deletion of the path was staged;
2326 if (same(oldtree
, newtree
))
2328 return reject_merge(oldtree
, o
);
2330 return merged_entry(newtree
, current
, o
);
2332 return deleted_entry(oldtree
, current
, o
);
2338 * Keep the index entries at stage0, collapse stage1 but make sure
2339 * stage0 does not have anything there.
2341 int bind_merge(const struct cache_entry
* const *src
,
2342 struct unpack_trees_options
*o
)
2344 const struct cache_entry
*old
= src
[0];
2345 const struct cache_entry
*a
= src
[1];
2347 if (o
->merge_size
!= 1)
2348 return error("Cannot do a bind merge of %d trees",
2351 return o
->gently
? -1 :
2352 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
),
2353 super_prefixed(a
->name
),
2354 super_prefixed(old
->name
));
2356 return keep_entry(old
, o
);
2358 return merged_entry(a
, NULL
, o
);
2365 * - take the stat information from stage0, take the data from stage1
2367 int oneway_merge(const struct cache_entry
* const *src
,
2368 struct unpack_trees_options
*o
)
2370 const struct cache_entry
*old
= src
[0];
2371 const struct cache_entry
*a
= src
[1];
2373 if (o
->merge_size
!= 1)
2374 return error("Cannot do a oneway merge of %d trees",
2377 if (!a
|| a
== o
->df_conflict_entry
)
2378 return deleted_entry(old
, old
, o
);
2380 if (old
&& same(old
, a
)) {
2382 if (o
->reset
&& o
->update
&& !ce_uptodate(old
) && !ce_skip_worktree(old
)) {
2384 if (lstat(old
->name
, &st
) ||
2385 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
2386 update
|= CE_UPDATE
;
2388 if (o
->update
&& S_ISGITLINK(old
->ce_mode
) &&
2389 should_update_submodules() && !verify_uptodate(old
, o
))
2390 update
|= CE_UPDATE
;
2391 add_entry(o
, old
, update
, CE_STAGEMASK
);
2394 return merged_entry(a
, old
, o
);