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 "promisor-remote.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
,
225 if (!o
->show_all_errors
)
226 return error(ERRORMSG(o
, e
), super_prefixed(path
));
229 * Otherwise, insert in a list for future display by
230 * display_error_msgs()
232 string_list_append(&o
->unpack_rejects
[e
], path
);
237 * display all the error messages stored in a nice way
239 static void display_error_msgs(struct unpack_trees_options
*o
)
242 int something_displayed
= 0;
243 for (e
= 0; e
< NB_UNPACK_TREES_ERROR_TYPES
; e
++) {
244 struct string_list
*rejects
= &o
->unpack_rejects
[e
];
245 if (rejects
->nr
> 0) {
246 struct strbuf path
= STRBUF_INIT
;
247 something_displayed
= 1;
248 for (i
= 0; i
< rejects
->nr
; i
++)
249 strbuf_addf(&path
, "\t%s\n", rejects
->items
[i
].string
);
250 error(ERRORMSG(o
, e
), super_prefixed(path
.buf
));
251 strbuf_release(&path
);
253 string_list_clear(rejects
, 0);
255 if (something_displayed
)
256 fprintf(stderr
, _("Aborting\n"));
259 static int check_submodule_move_head(const struct cache_entry
*ce
,
262 struct unpack_trees_options
*o
)
264 unsigned flags
= SUBMODULE_MOVE_HEAD_DRY_RUN
;
265 const struct submodule
*sub
= submodule_from_ce(ce
);
271 flags
|= SUBMODULE_MOVE_HEAD_FORCE
;
273 if (submodule_move_head(ce
->name
, old_id
, new_id
, flags
))
274 return add_rejected_path(o
, ERROR_WOULD_LOSE_SUBMODULE
, ce
->name
);
279 * Preform the loading of the repository's gitmodules file. This function is
280 * used by 'check_update()' to perform loading of the gitmodules file in two
281 * differnt situations:
282 * (1) before removing entries from the working tree if the gitmodules file has
283 * been marked for removal. This situation is specified by 'state' == NULL.
284 * (2) before checking out entries to the working tree if the gitmodules file
285 * has been marked for update. This situation is specified by 'state' != NULL.
287 static void load_gitmodules_file(struct index_state
*index
,
288 struct checkout
*state
)
290 int pos
= index_name_pos(index
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
293 struct cache_entry
*ce
= index
->cache
[pos
];
294 if (!state
&& ce
->ce_flags
& CE_WT_REMOVE
) {
295 repo_read_gitmodules(the_repository
);
296 } else if (state
&& (ce
->ce_flags
& CE_UPDATE
)) {
297 submodule_free(the_repository
);
298 checkout_entry(ce
, state
, NULL
, NULL
);
299 repo_read_gitmodules(the_repository
);
304 static struct progress
*get_progress(struct unpack_trees_options
*o
)
306 unsigned cnt
= 0, total
= 0;
307 struct index_state
*index
= &o
->result
;
309 if (!o
->update
|| !o
->verbose_update
)
312 for (; cnt
< index
->cache_nr
; cnt
++) {
313 const struct cache_entry
*ce
= index
->cache
[cnt
];
314 if (ce
->ce_flags
& (CE_UPDATE
| CE_WT_REMOVE
))
318 return start_delayed_progress(_("Updating files"), total
);
321 static void setup_collided_checkout_detection(struct checkout
*state
,
322 struct index_state
*index
)
327 for (i
= 0; i
< index
->cache_nr
; i
++)
328 index
->cache
[i
]->ce_flags
&= ~CE_MATCHED
;
331 static void report_collided_checkout(struct index_state
*index
)
333 struct string_list list
= STRING_LIST_INIT_NODUP
;
336 for (i
= 0; i
< index
->cache_nr
; i
++) {
337 struct cache_entry
*ce
= index
->cache
[i
];
339 if (!(ce
->ce_flags
& CE_MATCHED
))
342 string_list_append(&list
, ce
->name
);
343 ce
->ce_flags
&= ~CE_MATCHED
;
346 list
.cmp
= fspathcmp
;
347 string_list_sort(&list
);
350 warning(_("the following paths have collided (e.g. case-sensitive paths\n"
351 "on a case-insensitive filesystem) and only one from the same\n"
352 "colliding group is in the working tree:\n"));
354 for (i
= 0; i
< list
.nr
; i
++)
355 fprintf(stderr
, " '%s'\n", list
.items
[i
].string
);
358 string_list_clear(&list
, 0);
361 static int check_updates(struct unpack_trees_options
*o
)
365 struct progress
*progress
;
366 struct index_state
*index
= &o
->result
;
367 struct checkout state
= CHECKOUT_INIT
;
370 trace_performance_enter();
373 state
.refresh_cache
= 1;
374 state
.istate
= index
;
377 setup_collided_checkout_detection(&state
, index
);
379 progress
= get_progress(o
);
382 git_attr_set_direction(GIT_ATTR_CHECKOUT
);
384 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
385 load_gitmodules_file(index
, NULL
);
387 for (i
= 0; i
< index
->cache_nr
; i
++) {
388 const struct cache_entry
*ce
= index
->cache
[i
];
390 if (ce
->ce_flags
& CE_WT_REMOVE
) {
391 display_progress(progress
, ++cnt
);
392 if (o
->update
&& !o
->dry_run
)
396 remove_marked_cache_entries(index
, 0);
397 remove_scheduled_dirs();
399 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
400 load_gitmodules_file(index
, &state
);
402 enable_delayed_checkout(&state
);
403 if (has_promisor_remote() && o
->update
&& !o
->dry_run
) {
405 * Prefetch the objects that are to be checked out in the loop
408 struct oid_array to_fetch
= OID_ARRAY_INIT
;
409 for (i
= 0; i
< index
->cache_nr
; i
++) {
410 struct cache_entry
*ce
= index
->cache
[i
];
412 if (!(ce
->ce_flags
& CE_UPDATE
) ||
413 S_ISGITLINK(ce
->ce_mode
))
415 if (!oid_object_info_extended(the_repository
, &ce
->oid
,
417 OBJECT_INFO_FOR_PREFETCH
))
419 oid_array_append(&to_fetch
, &ce
->oid
);
422 promisor_remote_get_direct(the_repository
,
423 to_fetch
.oid
, to_fetch
.nr
);
424 oid_array_clear(&to_fetch
);
426 for (i
= 0; i
< index
->cache_nr
; i
++) {
427 struct cache_entry
*ce
= index
->cache
[i
];
429 if (ce
->ce_flags
& CE_UPDATE
) {
430 if (ce
->ce_flags
& CE_WT_REMOVE
)
431 BUG("both update and delete flags are set on %s",
433 display_progress(progress
, ++cnt
);
434 ce
->ce_flags
&= ~CE_UPDATE
;
435 if (o
->update
&& !o
->dry_run
) {
436 errs
|= checkout_entry(ce
, &state
, NULL
, NULL
);
440 stop_progress(&progress
);
441 errs
|= finish_delayed_checkout(&state
, NULL
);
443 git_attr_set_direction(GIT_ATTR_CHECKIN
);
446 report_collided_checkout(index
);
448 trace_performance_leave("check_updates");
452 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
453 struct unpack_trees_options
*o
);
454 static int verify_absent_sparse(const struct cache_entry
*ce
,
455 enum unpack_trees_error_types
,
456 struct unpack_trees_options
*o
);
458 static int apply_sparse_checkout(struct index_state
*istate
,
459 struct cache_entry
*ce
,
460 struct unpack_trees_options
*o
)
462 int was_skip_worktree
= ce_skip_worktree(ce
);
464 if (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
)
465 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
467 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
468 if (was_skip_worktree
!= ce_skip_worktree(ce
)) {
469 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
470 mark_fsmonitor_invalid(istate
, ce
);
471 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
475 * if (!was_skip_worktree && !ce_skip_worktree()) {
476 * This is perfectly normal. Move on;
481 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
482 * area as a result of ce_skip_worktree() shortcuts in
483 * verify_absent() and verify_uptodate().
484 * Make sure they don't modify worktree if they are already
485 * outside checkout area
487 if (was_skip_worktree
&& ce_skip_worktree(ce
)) {
488 ce
->ce_flags
&= ~CE_UPDATE
;
491 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
492 * on to get that file removed from both index and worktree.
493 * If that file is already outside worktree area, don't
496 if (ce
->ce_flags
& CE_REMOVE
)
497 ce
->ce_flags
&= ~CE_WT_REMOVE
;
500 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
502 * If CE_UPDATE is set, verify_uptodate() must be called already
503 * also stat info may have lost after merged_entry() so calling
504 * verify_uptodate() again may fail
506 if (!(ce
->ce_flags
& CE_UPDATE
) && verify_uptodate_sparse(ce
, o
))
508 ce
->ce_flags
|= CE_WT_REMOVE
;
509 ce
->ce_flags
&= ~CE_UPDATE
;
511 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
512 if (verify_absent_sparse(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
514 ce
->ce_flags
|= CE_UPDATE
;
519 static inline int call_unpack_fn(const struct cache_entry
* const *src
,
520 struct unpack_trees_options
*o
)
522 int ret
= o
->fn(src
, o
);
528 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
530 ce
->ce_flags
|= CE_UNPACKED
;
532 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
533 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
534 int bottom
= o
->cache_bottom
;
535 while (bottom
< o
->src_index
->cache_nr
&&
536 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
538 o
->cache_bottom
= bottom
;
542 static void mark_all_ce_unused(struct index_state
*index
)
545 for (i
= 0; i
< index
->cache_nr
; i
++)
546 index
->cache
[i
]->ce_flags
&= ~(CE_UNPACKED
| CE_ADDED
| CE_NEW_SKIP_WORKTREE
);
549 static int locate_in_src_index(const struct cache_entry
*ce
,
550 struct unpack_trees_options
*o
)
552 struct index_state
*index
= o
->src_index
;
553 int len
= ce_namelen(ce
);
554 int pos
= index_name_pos(index
, ce
->name
, len
);
561 * We call unpack_index_entry() with an unmerged cache entry
562 * only in diff-index, and it wants a single callback. Skip
563 * the other unmerged entry with the same name.
565 static void mark_ce_used_same_name(struct cache_entry
*ce
,
566 struct unpack_trees_options
*o
)
568 struct index_state
*index
= o
->src_index
;
569 int len
= ce_namelen(ce
);
572 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
573 struct cache_entry
*next
= index
->cache
[pos
];
574 if (len
!= ce_namelen(next
) ||
575 memcmp(ce
->name
, next
->name
, len
))
577 mark_ce_used(next
, o
);
581 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
583 const struct index_state
*index
= o
->src_index
;
584 int pos
= o
->cache_bottom
;
586 while (pos
< index
->cache_nr
) {
587 struct cache_entry
*ce
= index
->cache
[pos
];
588 if (!(ce
->ce_flags
& CE_UNPACKED
))
595 static void add_same_unmerged(const struct cache_entry
*ce
,
596 struct unpack_trees_options
*o
)
598 struct index_state
*index
= o
->src_index
;
599 int len
= ce_namelen(ce
);
600 int pos
= index_name_pos(index
, ce
->name
, len
);
603 die("programming error in a caller of mark_ce_used_same_name");
604 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
605 struct cache_entry
*next
= index
->cache
[pos
];
606 if (len
!= ce_namelen(next
) ||
607 memcmp(ce
->name
, next
->name
, len
))
609 add_entry(o
, next
, 0, 0);
610 mark_ce_used(next
, o
);
614 static int unpack_index_entry(struct cache_entry
*ce
,
615 struct unpack_trees_options
*o
)
617 const struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
624 if (o
->skip_unmerged
) {
625 add_entry(o
, ce
, 0, 0);
629 ret
= call_unpack_fn(src
, o
);
631 mark_ce_used_same_name(ce
, o
);
635 static int find_cache_pos(struct traverse_info
*, const char *p
, size_t len
);
637 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
639 struct unpack_trees_options
*o
= info
->data
;
641 if (o
->diff_index_cached
)
643 o
->cache_bottom
= bottom
;
646 static int switch_cache_bottom(struct traverse_info
*info
)
648 struct unpack_trees_options
*o
= info
->data
;
651 if (o
->diff_index_cached
)
653 ret
= o
->cache_bottom
;
654 pos
= find_cache_pos(info
->prev
, info
->name
, info
->namelen
);
657 o
->cache_bottom
= -2 - pos
;
659 o
->cache_bottom
= o
->src_index
->cache_nr
;
663 static inline int are_same_oid(struct name_entry
*name_j
, struct name_entry
*name_k
)
665 return !is_null_oid(&name_j
->oid
) && !is_null_oid(&name_k
->oid
) && oideq(&name_j
->oid
, &name_k
->oid
);
668 static int all_trees_same_as_cache_tree(int n
, unsigned long dirmask
,
669 struct name_entry
*names
,
670 struct traverse_info
*info
)
672 struct unpack_trees_options
*o
= info
->data
;
675 if (!o
->merge
|| dirmask
!= ((1 << n
) - 1))
678 for (i
= 1; i
< n
; i
++)
679 if (!are_same_oid(names
, names
+ i
))
682 return cache_tree_matches_traversal(o
->src_index
->cache_tree
, names
, info
);
685 static int index_pos_by_traverse_info(struct name_entry
*names
,
686 struct traverse_info
*info
)
688 struct unpack_trees_options
*o
= info
->data
;
689 struct strbuf name
= STRBUF_INIT
;
692 strbuf_make_traverse_path(&name
, info
, names
->path
, names
->pathlen
);
693 strbuf_addch(&name
, '/');
694 pos
= index_name_pos(o
->src_index
, name
.buf
, name
.len
);
696 BUG("This is a directory and should not exist in index");
698 if (!starts_with(o
->src_index
->cache
[pos
]->name
, name
.buf
) ||
699 (pos
> 0 && starts_with(o
->src_index
->cache
[pos
-1]->name
, name
.buf
)))
700 BUG("pos must point at the first entry in this directory");
701 strbuf_release(&name
);
706 * Fast path if we detect that all trees are the same as cache-tree at this
707 * path. We'll walk these trees in an iterative loop using cache-tree/index
708 * instead of ODB since we already know what these trees contain.
710 static int traverse_by_cache_tree(int pos
, int nr_entries
, int nr_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
, info
);
801 o
->cache_bottom
= bottom
;
811 newinfo
.pathspec
= info
->pathspec
;
812 newinfo
.name
= p
->path
;
813 newinfo
.namelen
= p
->pathlen
;
814 newinfo
.mode
= p
->mode
;
815 newinfo
.pathlen
= st_add3(newinfo
.pathlen
, tree_entry_len(p
), 1);
816 newinfo
.df_conflicts
|= df_conflicts
;
819 * Fetch the tree from the ODB for each peer directory in the
822 * For 2- and 3-way traversals, we try to avoid hitting the
823 * ODB twice for the same OID. This should yield a nice speed
824 * up in checkouts and merges when the commits are similar.
826 * We don't bother doing the full O(n^2) search for larger n,
827 * because wider traversals don't happen that often and we
828 * avoid the search setup.
830 * When 2 peer OIDs are the same, we just copy the tree
831 * descriptor data. This implicitly borrows the buffer
832 * data from the earlier cell.
834 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
835 if (i
> 0 && are_same_oid(&names
[i
], &names
[i
- 1]))
837 else if (i
> 1 && are_same_oid(&names
[i
], &names
[i
- 2]))
840 const struct object_id
*oid
= NULL
;
843 buf
[nr_buf
++] = fill_tree_descriptor(the_repository
, t
+ i
, oid
);
847 bottom
= switch_cache_bottom(&newinfo
);
848 ret
= traverse_trees(o
->src_index
, n
, t
, &newinfo
);
849 restore_cache_bottom(&newinfo
, bottom
);
851 for (i
= 0; i
< nr_buf
; i
++)
858 * Compare the traverse-path to the cache entry without actually
859 * having to generate the textual representation of the traverse
862 * NOTE! This *only* compares up to the size of the traverse path
863 * itself - the caller needs to do the final check for the cache
864 * entry having more data at the end!
866 static int do_compare_entry_piecewise(const struct cache_entry
*ce
,
867 const struct traverse_info
*info
,
868 const char *name
, size_t namelen
,
875 int cmp
= do_compare_entry_piecewise(ce
, info
->prev
,
876 info
->name
, info
->namelen
,
881 pathlen
= info
->pathlen
;
882 ce_len
= ce_namelen(ce
);
884 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
885 if (ce_len
< pathlen
)
889 ce_name
= ce
->name
+ pathlen
;
891 return df_name_compare(ce_name
, ce_len
, S_IFREG
, name
, namelen
, mode
);
894 static int do_compare_entry(const struct cache_entry
*ce
,
895 const struct traverse_info
*info
,
896 const char *name
, size_t namelen
,
904 * If we have not precomputed the traverse path, it is quicker
905 * to avoid doing so. But if we have precomputed it,
906 * it is quicker to use the precomputed version.
908 if (!info
->traverse_path
)
909 return do_compare_entry_piecewise(ce
, info
, name
, namelen
, mode
);
911 cmp
= strncmp(ce
->name
, info
->traverse_path
, info
->pathlen
);
915 pathlen
= info
->pathlen
;
916 ce_len
= ce_namelen(ce
);
918 if (ce_len
< pathlen
)
922 ce_name
= ce
->name
+ pathlen
;
924 return df_name_compare(ce_name
, ce_len
, S_IFREG
, name
, namelen
, mode
);
927 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
929 int cmp
= do_compare_entry(ce
, info
, n
->path
, n
->pathlen
, n
->mode
);
934 * Even if the beginning compared identically, the ce should
935 * compare as bigger than a directory leading up to it!
937 return ce_namelen(ce
) > traverse_path_len(info
, tree_entry_len(n
));
940 static int ce_in_traverse_path(const struct cache_entry
*ce
,
941 const struct traverse_info
*info
)
945 if (do_compare_entry(ce
, info
->prev
,
946 info
->name
, info
->namelen
, info
->mode
))
949 * If ce (blob) is the same name as the path (which is a tree
950 * we will be descending into), it won't be inside it.
952 return (info
->pathlen
< ce_namelen(ce
));
955 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
,
956 const struct name_entry
*n
,
958 struct index_state
*istate
,
961 size_t len
= traverse_path_len(info
, tree_entry_len(n
));
962 struct cache_entry
*ce
=
964 make_empty_transient_cache_entry(len
) :
965 make_empty_cache_entry(istate
, len
);
967 ce
->ce_mode
= create_ce_mode(n
->mode
);
968 ce
->ce_flags
= create_ce_flags(stage
);
969 ce
->ce_namelen
= len
;
970 oidcpy(&ce
->oid
, &n
->oid
);
971 /* len+1 because the cache_entry allocates space for NUL */
972 make_traverse_path(ce
->name
, len
+ 1, info
, n
->path
, n
->pathlen
);
978 * Note that traverse_by_cache_tree() duplicates some logic in this function
979 * without actually calling it. If you change the logic here you may need to
980 * check and change there as well.
982 static int unpack_nondirectories(int n
, unsigned long mask
,
983 unsigned long dirmask
,
984 struct cache_entry
**src
,
985 const struct name_entry
*names
,
986 const struct traverse_info
*info
)
989 struct unpack_trees_options
*o
= info
->data
;
990 unsigned long conflicts
= info
->df_conflicts
| dirmask
;
992 /* Do we have *only* directories? Nothing to do */
993 if (mask
== dirmask
&& !src
[0])
997 * Ok, we've filled in up to any potential index entry in src[0],
1000 for (i
= 0; i
< n
; i
++) {
1002 unsigned int bit
= 1ul << i
;
1003 if (conflicts
& bit
) {
1004 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
1011 else if (i
+ 1 < o
->head_idx
)
1013 else if (i
+ 1 > o
->head_idx
)
1019 * If the merge bit is set, then the cache entries are
1020 * discarded in the following block. In this case,
1021 * construct "transient" cache_entries, as they are
1022 * not stored in the index. otherwise construct the
1023 * cache entry from the index aware logic.
1025 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
, &o
->result
, o
->merge
);
1029 int rc
= call_unpack_fn((const struct cache_entry
* const *)src
,
1031 for (i
= 0; i
< n
; i
++) {
1032 struct cache_entry
*ce
= src
[i
+ o
->merge
];
1033 if (ce
!= o
->df_conflict_entry
)
1034 discard_cache_entry(ce
);
1039 for (i
= 0; i
< n
; i
++)
1040 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
1041 if (do_add_entry(o
, src
[i
], 0, 0))
1047 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
1049 discard_index(&o
->result
);
1050 if (!o
->quiet
&& !o
->exiting_early
) {
1052 return error("%s", message
);
1059 * The tree traversal is looking at name p. If we have a matching entry,
1060 * return it. If name p is a directory in the index, do not return
1061 * anything, as we will want to match it when the traversal descends into
1064 static int find_cache_pos(struct traverse_info
*info
,
1065 const char *p
, size_t p_len
)
1068 struct unpack_trees_options
*o
= info
->data
;
1069 struct index_state
*index
= o
->src_index
;
1070 int pfxlen
= info
->pathlen
;
1072 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
1073 const struct cache_entry
*ce
= index
->cache
[pos
];
1074 const char *ce_name
, *ce_slash
;
1077 if (ce
->ce_flags
& CE_UNPACKED
) {
1079 * cache_bottom entry is already unpacked, so
1080 * we can never match it; don't check it
1083 if (pos
== o
->cache_bottom
)
1087 if (!ce_in_traverse_path(ce
, info
)) {
1089 * Check if we can skip future cache checks
1090 * (because we're already past all possible
1091 * entries in the traverse path).
1093 if (info
->traverse_path
) {
1094 if (strncmp(ce
->name
, info
->traverse_path
,
1100 ce_name
= ce
->name
+ pfxlen
;
1101 ce_slash
= strchr(ce_name
, '/');
1103 ce_len
= ce_slash
- ce_name
;
1105 ce_len
= ce_namelen(ce
) - pfxlen
;
1106 cmp
= name_compare(p
, p_len
, ce_name
, ce_len
);
1108 * Exact match; if we have a directory we need to
1109 * delay returning it.
1112 return ce_slash
? -2 - pos
: pos
;
1114 continue; /* keep looking */
1116 * ce_name sorts after p->path; could it be that we
1117 * have files under p->path directory in the index?
1118 * E.g. ce_name == "t-i", and p->path == "t"; we may
1119 * have "t/a" in the index.
1121 if (p_len
< ce_len
&& !memcmp(ce_name
, p
, p_len
) &&
1122 ce_name
[p_len
] < '/')
1123 continue; /* keep looking */
1129 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
1130 const struct name_entry
*p
)
1132 int pos
= find_cache_pos(info
, p
->path
, p
->pathlen
);
1133 struct unpack_trees_options
*o
= info
->data
;
1136 return o
->src_index
->cache
[pos
];
1141 static void debug_path(struct traverse_info
*info
)
1144 debug_path(info
->prev
);
1145 if (*info
->prev
->name
)
1148 printf("%s", info
->name
);
1151 static void debug_name_entry(int i
, struct name_entry
*n
)
1153 printf("ent#%d %06o %s\n", i
,
1154 n
->path
? n
->mode
: 0,
1155 n
->path
? n
->path
: "(missing)");
1158 static void debug_unpack_callback(int n
,
1160 unsigned long dirmask
,
1161 struct name_entry
*names
,
1162 struct traverse_info
*info
)
1165 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1169 for (i
= 0; i
< n
; i
++)
1170 debug_name_entry(i
, names
+ i
);
1174 * Note that traverse_by_cache_tree() duplicates some logic in this function
1175 * without actually calling it. If you change the logic here you may need to
1176 * check and change there as well.
1178 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
1180 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
1181 struct unpack_trees_options
*o
= info
->data
;
1182 const struct name_entry
*p
= names
;
1184 /* Find first entry with a real name (we could use "mask" too) */
1188 if (o
->debug_unpack
)
1189 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
1191 /* Are we supposed to look at the index too? */
1195 struct cache_entry
*ce
;
1197 if (o
->diff_index_cached
)
1198 ce
= next_cache_entry(o
);
1200 ce
= find_cache_entry(info
, p
);
1204 cmp
= compare_entry(ce
, info
, p
);
1206 if (unpack_index_entry(ce
, o
) < 0)
1207 return unpack_failed(o
, NULL
);
1213 * If we skip unmerged index
1214 * entries, we'll skip this
1215 * entry *and* the tree
1216 * entries associated with it!
1218 if (o
->skip_unmerged
) {
1219 add_same_unmerged(ce
, o
);
1229 if (unpack_nondirectories(n
, mask
, dirmask
, src
, names
, info
) < 0)
1232 if (o
->merge
&& src
[0]) {
1233 if (ce_stage(src
[0]))
1234 mark_ce_used_same_name(src
[0], o
);
1236 mark_ce_used(src
[0], o
);
1239 /* Now handle any directories.. */
1241 /* special case: "diff-index --cached" looking at a tree */
1242 if (o
->diff_index_cached
&&
1243 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
1245 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
1248 * Everything under the name matches; skip the
1249 * entire hierarchy. diff_index_cached codepath
1250 * special cases D/F conflicts in such a way that
1251 * it does not do any look-ahead, so this is safe.
1254 o
->cache_bottom
+= matches
;
1259 if (traverse_trees_recursive(n
, dirmask
, mask
& ~dirmask
,
1268 static int clear_ce_flags_1(struct index_state
*istate
,
1269 struct cache_entry
**cache
, int nr
,
1270 struct strbuf
*prefix
,
1271 int select_mask
, int clear_mask
,
1272 struct pattern_list
*pl
,
1273 enum pattern_match_result default_match
);
1275 /* Whole directory matching */
1276 static int clear_ce_flags_dir(struct index_state
*istate
,
1277 struct cache_entry
**cache
, int nr
,
1278 struct strbuf
*prefix
,
1280 int select_mask
, int clear_mask
,
1281 struct pattern_list
*pl
,
1282 enum pattern_match_result default_match
)
1284 struct cache_entry
**cache_end
;
1287 enum pattern_match_result ret
;
1288 ret
= path_matches_pattern_list(prefix
->buf
, prefix
->len
,
1289 basename
, &dtype
, pl
, istate
);
1291 strbuf_addch(prefix
, '/');
1293 /* If undecided, use matching result of parent dir in defval */
1294 if (ret
== UNDECIDED
)
1295 ret
= default_match
;
1297 for (cache_end
= cache
; cache_end
!= cache
+ nr
; cache_end
++) {
1298 struct cache_entry
*ce
= *cache_end
;
1299 if (strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1304 * TODO: check pl, if there are no patterns that may conflict
1305 * with ret (iow, we know in advance the incl/excl
1306 * decision for the entire directory), clear flag here without
1307 * calling clear_ce_flags_1(). That function will call
1308 * the expensive path_matches_pattern_list() on every entry.
1310 rc
= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1312 select_mask
, clear_mask
,
1314 strbuf_setlen(prefix
, prefix
->len
- 1);
1319 * Traverse the index, find every entry that matches according to
1320 * o->pl. Do "ce_flags &= ~clear_mask" on those entries. Return the
1321 * number of traversed entries.
1323 * If select_mask is non-zero, only entries whose ce_flags has on of
1324 * those bits enabled are traversed.
1326 * cache : pointer to an index entry
1327 * prefix_len : an offset to its path
1329 * The current path ("prefix") including the trailing '/' is
1330 * cache[0]->name[0..(prefix_len-1)]
1331 * Top level path has prefix_len zero.
1333 static int clear_ce_flags_1(struct index_state
*istate
,
1334 struct cache_entry
**cache
, int nr
,
1335 struct strbuf
*prefix
,
1336 int select_mask
, int clear_mask
,
1337 struct pattern_list
*pl
,
1338 enum pattern_match_result default_match
)
1340 struct cache_entry
**cache_end
= cache
+ nr
;
1343 * Process all entries that have the given prefix and meet
1344 * select_mask condition
1346 while(cache
!= cache_end
) {
1347 struct cache_entry
*ce
= *cache
;
1348 const char *name
, *slash
;
1350 enum pattern_match_result ret
;
1352 if (select_mask
&& !(ce
->ce_flags
& select_mask
)) {
1357 if (prefix
->len
&& strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1360 name
= ce
->name
+ prefix
->len
;
1361 slash
= strchr(name
, '/');
1363 /* If it's a directory, try whole directory match first */
1368 strbuf_add(prefix
, name
, len
);
1370 processed
= clear_ce_flags_dir(istate
, cache
, cache_end
- cache
,
1372 prefix
->buf
+ prefix
->len
- len
,
1373 select_mask
, clear_mask
,
1376 /* clear_c_f_dir eats a whole dir already? */
1379 strbuf_setlen(prefix
, prefix
->len
- len
);
1383 strbuf_addch(prefix
, '/');
1384 cache
+= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1386 select_mask
, clear_mask
, pl
,
1388 strbuf_setlen(prefix
, prefix
->len
- len
- 1);
1393 dtype
= ce_to_dtype(ce
);
1394 ret
= path_matches_pattern_list(ce
->name
,
1396 name
, &dtype
, pl
, istate
);
1397 if (ret
== UNDECIDED
)
1398 ret
= default_match
;
1400 ce
->ce_flags
&= ~clear_mask
;
1403 return nr
- (cache_end
- cache
);
1406 static int clear_ce_flags(struct index_state
*istate
,
1407 int select_mask
, int clear_mask
,
1408 struct pattern_list
*pl
)
1410 static struct strbuf prefix
= STRBUF_INIT
;
1412 strbuf_reset(&prefix
);
1414 return clear_ce_flags_1(istate
,
1418 select_mask
, clear_mask
,
1423 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1425 static void mark_new_skip_worktree(struct pattern_list
*pl
,
1426 struct index_state
*istate
,
1427 int select_flag
, int skip_wt_flag
)
1432 * 1. Pretend the narrowest worktree: only unmerged entries
1435 for (i
= 0; i
< istate
->cache_nr
; i
++) {
1436 struct cache_entry
*ce
= istate
->cache
[i
];
1438 if (select_flag
&& !(ce
->ce_flags
& select_flag
))
1441 if (!ce_stage(ce
) && !(ce
->ce_flags
& CE_CONFLICTED
))
1442 ce
->ce_flags
|= skip_wt_flag
;
1444 ce
->ce_flags
&= ~skip_wt_flag
;
1448 * 2. Widen worktree according to sparse-checkout file.
1449 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1451 clear_ce_flags(istate
, select_flag
, skip_wt_flag
, pl
);
1454 static int verify_absent(const struct cache_entry
*,
1455 enum unpack_trees_error_types
,
1456 struct unpack_trees_options
*);
1458 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1459 * resulting index, -2 on failure to reflect the changes to the work tree.
1461 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1463 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
1466 static struct cache_entry
*dfc
;
1467 struct pattern_list pl
;
1469 if (len
> MAX_UNPACK_TREES
)
1470 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
1472 trace_performance_enter();
1473 memset(&pl
, 0, sizeof(pl
));
1474 if (!core_apply_sparse_checkout
|| !o
->update
)
1475 o
->skip_sparse_checkout
= 1;
1476 if (!o
->skip_sparse_checkout
) {
1477 char *sparse
= git_pathdup("info/sparse-checkout");
1478 if (add_patterns_from_file_to_list(sparse
, "", 0, &pl
, NULL
) < 0)
1479 o
->skip_sparse_checkout
= 1;
1485 memset(&o
->result
, 0, sizeof(o
->result
));
1486 o
->result
.initialized
= 1;
1487 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
1488 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
1489 o
->result
.version
= o
->src_index
->version
;
1490 if (!o
->src_index
->split_index
) {
1491 o
->result
.split_index
= NULL
;
1492 } else if (o
->src_index
== o
->dst_index
) {
1494 * o->dst_index (and thus o->src_index) will be discarded
1495 * and overwritten with o->result at the end of this function,
1496 * so just use src_index's split_index to avoid having to
1499 o
->result
.split_index
= o
->src_index
->split_index
;
1500 o
->result
.split_index
->refcount
++;
1502 o
->result
.split_index
= init_split_index(&o
->result
);
1504 oidcpy(&o
->result
.oid
, &o
->src_index
->oid
);
1505 o
->merge_size
= len
;
1506 mark_all_ce_unused(o
->src_index
);
1509 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1511 if (!o
->skip_sparse_checkout
)
1512 mark_new_skip_worktree(o
->pl
, o
->src_index
, 0, CE_NEW_SKIP_WORKTREE
);
1515 dfc
= xcalloc(1, cache_entry_size(0));
1516 o
->df_conflict_entry
= dfc
;
1519 const char *prefix
= o
->prefix
? o
->prefix
: "";
1520 struct traverse_info info
;
1522 setup_traverse_info(&info
, prefix
);
1523 info
.fn
= unpack_callback
;
1525 info
.show_all_errors
= o
->show_all_errors
;
1526 info
.pathspec
= o
->pathspec
;
1530 * Unpack existing index entries that sort before the
1531 * prefix the tree is spliced into. Note that o->merge
1532 * is always true in this case.
1535 struct cache_entry
*ce
= next_cache_entry(o
);
1538 if (ce_in_traverse_path(ce
, &info
))
1540 if (unpack_index_entry(ce
, o
) < 0)
1545 trace_performance_enter();
1546 ret
= traverse_trees(o
->src_index
, len
, t
, &info
);
1547 trace_performance_leave("traverse_trees");
1552 /* Any left-over entries in the index? */
1555 struct cache_entry
*ce
= next_cache_entry(o
);
1558 if (unpack_index_entry(ce
, o
) < 0)
1562 mark_all_ce_unused(o
->src_index
);
1564 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
1565 ret
= unpack_failed(o
, "Merge requires file-level merging");
1569 if (!o
->skip_sparse_checkout
) {
1570 int empty_worktree
= 1;
1573 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1574 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1575 * so apply_sparse_checkout() won't attempt to remove it from worktree
1577 mark_new_skip_worktree(o
->pl
, &o
->result
, CE_ADDED
, CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
1580 for (i
= 0; i
< o
->result
.cache_nr
; i
++) {
1581 struct cache_entry
*ce
= o
->result
.cache
[i
];
1584 * Entries marked with CE_ADDED in merged_entry() do not have
1585 * verify_absent() check (the check is effectively disabled
1586 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1588 * Do the real check now because we have had
1589 * correct CE_NEW_SKIP_WORKTREE
1591 if (ce
->ce_flags
& CE_ADDED
&&
1592 verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
1593 if (!o
->show_all_errors
)
1598 if (apply_sparse_checkout(&o
->result
, ce
, o
)) {
1599 if (!o
->show_all_errors
)
1603 if (!ce_skip_worktree(ce
))
1610 * Sparse checkout is meant to narrow down checkout area
1611 * but it does not make sense to narrow down to empty working
1612 * tree. This is usually a mistake in sparse checkout rules.
1613 * Do not allow users to do that.
1615 if (o
->result
.cache_nr
&& empty_worktree
) {
1616 ret
= unpack_failed(o
, "Sparse checkout leaves no entry on working directory");
1621 ret
= check_updates(o
) ? (-2) : 0;
1623 move_index_extensions(&o
->result
, o
->src_index
);
1625 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
1626 cache_tree_verify(the_repository
, &o
->result
);
1627 if (!o
->result
.cache_tree
)
1628 o
->result
.cache_tree
= cache_tree();
1629 if (!cache_tree_fully_valid(o
->result
.cache_tree
))
1630 cache_tree_update(&o
->result
,
1635 o
->result
.updated_workdir
= 1;
1636 discard_index(o
->dst_index
);
1637 *o
->dst_index
= o
->result
;
1639 discard_index(&o
->result
);
1641 o
->src_index
= NULL
;
1644 trace_performance_leave("unpack_trees");
1645 clear_pattern_list(&pl
);
1649 if (o
->show_all_errors
)
1650 display_error_msgs(o
);
1651 mark_all_ce_unused(o
->src_index
);
1652 ret
= unpack_failed(o
, NULL
);
1653 if (o
->exiting_early
)
1658 /* Here come the merge functions */
1660 static int reject_merge(const struct cache_entry
*ce
,
1661 struct unpack_trees_options
*o
)
1663 return add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
1666 static int same(const struct cache_entry
*a
, const struct cache_entry
*b
)
1672 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
1674 return a
->ce_mode
== b
->ce_mode
&&
1675 oideq(&a
->oid
, &b
->oid
);
1680 * When a CE gets turned into an unmerged entry, we
1681 * want it to be up-to-date
1683 static int verify_uptodate_1(const struct cache_entry
*ce
,
1684 struct unpack_trees_options
*o
,
1685 enum unpack_trees_error_types error_type
)
1693 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1694 * if this entry is truly up-to-date because this file may be
1697 if ((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
))
1698 ; /* keep checking */
1699 else if (o
->reset
|| ce_uptodate(ce
))
1702 if (!lstat(ce
->name
, &st
)) {
1703 int flags
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
;
1704 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, flags
);
1706 if (submodule_from_ce(ce
)) {
1707 int r
= check_submodule_move_head(ce
,
1708 "HEAD", oid_to_hex(&ce
->oid
), o
);
1710 return add_rejected_path(o
, error_type
, ce
->name
);
1717 * Historic default policy was to allow submodule to be out
1718 * of sync wrt the superproject index. If the submodule was
1719 * not considered interesting above, we don't care here.
1721 if (S_ISGITLINK(ce
->ce_mode
))
1726 if (errno
== ENOENT
)
1728 return add_rejected_path(o
, error_type
, ce
->name
);
1731 int verify_uptodate(const struct cache_entry
*ce
,
1732 struct unpack_trees_options
*o
)
1734 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1736 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
1739 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
1740 struct unpack_trees_options
*o
)
1742 return verify_uptodate_1(ce
, o
, ERROR_SPARSE_NOT_UPTODATE_FILE
);
1746 * TODO: We should actually invalidate o->result, not src_index [1].
1747 * But since cache tree and untracked cache both are not copied to
1748 * o->result until unpacking is complete, we invalidate them on
1749 * src_index instead with the assumption that they will be copied to
1750 * dst_index at the end.
1752 * [1] src_index->cache_tree is also used in unpack_callback() so if
1753 * we invalidate o->result, we need to update it to use
1754 * o->result.cache_tree as well.
1756 static void invalidate_ce_path(const struct cache_entry
*ce
,
1757 struct unpack_trees_options
*o
)
1761 cache_tree_invalidate_path(o
->src_index
, ce
->name
);
1762 untracked_cache_invalidate_path(o
->src_index
, ce
->name
, 1);
1766 * Check that checking out ce->sha1 in subdir ce->name is not
1767 * going to overwrite any working files.
1769 * Currently, git does not checkout subprojects during a superproject
1770 * checkout, so it is not going to overwrite anything.
1772 static int verify_clean_submodule(const char *old_sha1
,
1773 const struct cache_entry
*ce
,
1774 struct unpack_trees_options
*o
)
1776 if (!submodule_from_ce(ce
))
1779 return check_submodule_move_head(ce
, old_sha1
,
1780 oid_to_hex(&ce
->oid
), o
);
1783 static int verify_clean_subdirectory(const struct cache_entry
*ce
,
1784 struct unpack_trees_options
*o
)
1787 * we are about to extract "ce->name"; we would not want to lose
1788 * anything in the existing directory there.
1792 struct dir_struct d
;
1796 if (S_ISGITLINK(ce
->ce_mode
)) {
1797 struct object_id oid
;
1798 int sub_head
= resolve_gitlink_ref(ce
->name
, "HEAD", &oid
);
1800 * If we are not going to update the submodule, then
1803 if (!sub_head
&& oideq(&oid
, &ce
->oid
))
1805 return verify_clean_submodule(sub_head
? NULL
: oid_to_hex(&oid
),
1810 * First let's make sure we do not have a local modification
1811 * in that directory.
1813 namelen
= ce_namelen(ce
);
1814 for (i
= locate_in_src_index(ce
, o
);
1815 i
< o
->src_index
->cache_nr
;
1817 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
1818 int len
= ce_namelen(ce2
);
1819 if (len
< namelen
||
1820 strncmp(ce
->name
, ce2
->name
, namelen
) ||
1821 ce2
->name
[namelen
] != '/')
1824 * ce2->name is an entry in the subdirectory to be
1827 if (!ce_stage(ce2
)) {
1828 if (verify_uptodate(ce2
, o
))
1830 add_entry(o
, ce2
, CE_REMOVE
, 0);
1831 invalidate_ce_path(ce
, o
);
1832 mark_ce_used(ce2
, o
);
1838 * Then we need to make sure that we do not lose a locally
1839 * present file that is not ignored.
1841 pathbuf
= xstrfmt("%.*s/", namelen
, ce
->name
);
1843 memset(&d
, 0, sizeof(d
));
1845 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
1846 i
= read_directory(&d
, o
->src_index
, pathbuf
, namelen
+1, NULL
);
1848 return add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
1854 * This gets called when there was no index entry for the tree entry 'dst',
1855 * but we found a file in the working tree that 'lstat()' said was fine,
1856 * and we're on a case-insensitive filesystem.
1858 * See if we can find a case-insensitive match in the index that also
1859 * matches the stat information, and assume it's that other file!
1861 static int icase_exists(struct unpack_trees_options
*o
, const char *name
, int len
, struct stat
*st
)
1863 const struct cache_entry
*src
;
1865 src
= index_file_exists(o
->src_index
, name
, len
, 1);
1866 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
1869 static int check_ok_to_remove(const char *name
, int len
, int dtype
,
1870 const struct cache_entry
*ce
, struct stat
*st
,
1871 enum unpack_trees_error_types error_type
,
1872 struct unpack_trees_options
*o
)
1874 const struct cache_entry
*result
;
1877 * It may be that the 'lstat()' succeeded even though
1878 * target 'ce' was absent, because there is an old
1879 * entry that is different only in case..
1881 * Ignore that lstat() if it matches.
1883 if (ignore_case
&& icase_exists(o
, name
, len
, st
))
1887 is_excluded(o
->dir
, o
->src_index
, name
, &dtype
))
1889 * ce->name is explicitly excluded, so it is Ok to
1893 if (S_ISDIR(st
->st_mode
)) {
1895 * We are checking out path "foo" and
1896 * found "foo/." in the working tree.
1897 * This is tricky -- if we have modified
1898 * files that are in "foo/" we would lose
1901 if (verify_clean_subdirectory(ce
, o
) < 0)
1907 * The previous round may already have decided to
1908 * delete this path, which is in a subdirectory that
1909 * is being replaced with a blob.
1911 result
= index_file_exists(&o
->result
, name
, len
, 0);
1913 if (result
->ce_flags
& CE_REMOVE
)
1917 return add_rejected_path(o
, error_type
, name
);
1921 * We do not want to remove or overwrite a working tree file that
1922 * is not tracked, unless it is ignored.
1924 static int verify_absent_1(const struct cache_entry
*ce
,
1925 enum unpack_trees_error_types error_type
,
1926 struct unpack_trees_options
*o
)
1931 if (o
->index_only
|| o
->reset
|| !o
->update
)
1934 len
= check_leading_path(ce
->name
, ce_namelen(ce
));
1941 path
= xmemdupz(ce
->name
, len
);
1942 if (lstat(path
, &st
))
1943 ret
= error_errno("cannot stat '%s'", path
);
1945 if (submodule_from_ce(ce
))
1946 ret
= check_submodule_move_head(ce
,
1947 oid_to_hex(&ce
->oid
),
1950 ret
= check_ok_to_remove(path
, len
, DT_UNKNOWN
, NULL
,
1951 &st
, error_type
, o
);
1955 } else if (lstat(ce
->name
, &st
)) {
1956 if (errno
!= ENOENT
)
1957 return error_errno("cannot stat '%s'", ce
->name
);
1960 if (submodule_from_ce(ce
))
1961 return check_submodule_move_head(ce
, oid_to_hex(&ce
->oid
),
1964 return check_ok_to_remove(ce
->name
, ce_namelen(ce
),
1965 ce_to_dtype(ce
), ce
, &st
,
1970 static int verify_absent(const struct cache_entry
*ce
,
1971 enum unpack_trees_error_types error_type
,
1972 struct unpack_trees_options
*o
)
1974 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1976 return verify_absent_1(ce
, error_type
, o
);
1979 static int verify_absent_sparse(const struct cache_entry
*ce
,
1980 enum unpack_trees_error_types error_type
,
1981 struct unpack_trees_options
*o
)
1983 enum unpack_trees_error_types orphaned_error
= error_type
;
1984 if (orphaned_error
== ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
)
1985 orphaned_error
= ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
;
1987 return verify_absent_1(ce
, orphaned_error
, o
);
1990 static int merged_entry(const struct cache_entry
*ce
,
1991 const struct cache_entry
*old
,
1992 struct unpack_trees_options
*o
)
1994 int update
= CE_UPDATE
;
1995 struct cache_entry
*merge
= dup_cache_entry(ce
, &o
->result
);
1999 * New index entries. In sparse checkout, the following
2000 * verify_absent() will be delayed until after
2001 * traverse_trees() finishes in unpack_trees(), then:
2003 * - CE_NEW_SKIP_WORKTREE will be computed correctly
2004 * - verify_absent() be called again, this time with
2005 * correct CE_NEW_SKIP_WORKTREE
2007 * verify_absent() call here does nothing in sparse
2008 * checkout (i.e. o->skip_sparse_checkout == 0)
2011 merge
->ce_flags
|= CE_NEW_SKIP_WORKTREE
;
2013 if (verify_absent(merge
,
2014 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
2015 discard_cache_entry(merge
);
2018 invalidate_ce_path(merge
, o
);
2020 if (submodule_from_ce(ce
)) {
2021 int ret
= check_submodule_move_head(ce
, NULL
,
2022 oid_to_hex(&ce
->oid
),
2028 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
2030 * See if we can re-use the old CE directly?
2031 * That way we get the uptodate stat info.
2033 * This also removes the UPDATE flag on a match; otherwise
2034 * we will end up overwriting local changes in the work tree.
2036 if (same(old
, merge
)) {
2037 copy_cache_entry(merge
, old
);
2040 if (verify_uptodate(old
, o
)) {
2041 discard_cache_entry(merge
);
2044 /* Migrate old flags over */
2045 update
|= old
->ce_flags
& (CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
2046 invalidate_ce_path(old
, o
);
2049 if (submodule_from_ce(ce
)) {
2050 int ret
= check_submodule_move_head(ce
, oid_to_hex(&old
->oid
),
2051 oid_to_hex(&ce
->oid
),
2058 * Previously unmerged entry left as an existence
2059 * marker by read_index_unmerged();
2061 invalidate_ce_path(old
, o
);
2064 do_add_entry(o
, merge
, update
, CE_STAGEMASK
);
2068 static int deleted_entry(const struct cache_entry
*ce
,
2069 const struct cache_entry
*old
,
2070 struct unpack_trees_options
*o
)
2072 /* Did it exist in the index? */
2074 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2078 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
2080 add_entry(o
, ce
, CE_REMOVE
, 0);
2081 invalidate_ce_path(ce
, o
);
2085 static int keep_entry(const struct cache_entry
*ce
,
2086 struct unpack_trees_options
*o
)
2088 add_entry(o
, ce
, 0, 0);
2090 invalidate_ce_path(ce
, o
);
2095 static void show_stage_entry(FILE *o
,
2096 const char *label
, const struct cache_entry
*ce
)
2099 fprintf(o
, "%s (missing)\n", label
);
2101 fprintf(o
, "%s%06o %s %d\t%s\n",
2104 oid_to_hex(&ce
->oid
),
2110 int threeway_merge(const struct cache_entry
* const *stages
,
2111 struct unpack_trees_options
*o
)
2113 const struct cache_entry
*index
;
2114 const struct cache_entry
*head
;
2115 const struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
2118 int remote_match
= 0;
2120 int df_conflict_head
= 0;
2121 int df_conflict_remote
= 0;
2123 int any_anc_missing
= 0;
2124 int no_anc_exists
= 1;
2127 for (i
= 1; i
< o
->head_idx
; i
++) {
2128 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
2129 any_anc_missing
= 1;
2135 head
= stages
[o
->head_idx
];
2137 if (head
== o
->df_conflict_entry
) {
2138 df_conflict_head
= 1;
2142 if (remote
== o
->df_conflict_entry
) {
2143 df_conflict_remote
= 1;
2148 * First, if there's a #16 situation, note that to prevent #13
2151 if (!same(remote
, head
)) {
2152 for (i
= 1; i
< o
->head_idx
; i
++) {
2153 if (same(stages
[i
], head
)) {
2156 if (same(stages
[i
], remote
)) {
2163 * We start with cases where the index is allowed to match
2164 * something other than the head: #14(ALT) and #2ALT, where it
2165 * is permitted to match the result instead.
2167 /* #14, #14ALT, #2ALT */
2168 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
2169 if (index
&& !same(index
, remote
) && !same(index
, head
))
2170 return reject_merge(index
, o
);
2171 return merged_entry(remote
, index
, o
);
2174 * If we have an entry in the index cache, then we want to
2175 * make sure that it matches head.
2177 if (index
&& !same(index
, head
))
2178 return reject_merge(index
, o
);
2182 if (same(head
, remote
))
2183 return merged_entry(head
, index
, o
);
2185 if (!df_conflict_remote
&& remote_match
&& !head_match
)
2186 return merged_entry(head
, index
, o
);
2190 if (!head
&& !remote
&& any_anc_missing
)
2194 * Under the "aggressive" rule, we resolve mostly trivial
2195 * cases that we historically had git-merge-one-file resolve.
2197 if (o
->aggressive
) {
2198 int head_deleted
= !head
;
2199 int remote_deleted
= !remote
;
2200 const struct cache_entry
*ce
= NULL
;
2209 for (i
= 1; i
< o
->head_idx
; i
++) {
2210 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2219 * Deleted in one and unchanged in the other.
2221 if ((head_deleted
&& remote_deleted
) ||
2222 (head_deleted
&& remote
&& remote_match
) ||
2223 (remote_deleted
&& head
&& head_match
)) {
2225 return deleted_entry(index
, index
, o
);
2226 if (ce
&& !head_deleted
) {
2227 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2233 * Added in both, identically.
2235 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
2236 return merged_entry(head
, index
, o
);
2240 /* Below are "no merge" cases, which require that the index be
2241 * up-to-date to avoid the files getting overwritten with
2242 * conflict resolution files.
2245 if (verify_uptodate(index
, o
))
2249 o
->nontrivial_merge
= 1;
2251 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2253 if (!head_match
|| !remote_match
) {
2254 for (i
= 1; i
< o
->head_idx
; i
++) {
2255 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2256 keep_entry(stages
[i
], o
);
2264 fprintf(stderr
, "read-tree: warning #16 detected\n");
2265 show_stage_entry(stderr
, "head ", stages
[head_match
]);
2266 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
2269 if (head
) { count
+= keep_entry(head
, o
); }
2270 if (remote
) { count
+= keep_entry(remote
, o
); }
2277 * The rule is to "carry forward" what is in the index without losing
2278 * information across a "fast-forward", favoring a successful merge
2279 * over a merge failure when it makes sense. For details of the
2280 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2283 int twoway_merge(const struct cache_entry
* const *src
,
2284 struct unpack_trees_options
*o
)
2286 const struct cache_entry
*current
= src
[0];
2287 const struct cache_entry
*oldtree
= src
[1];
2288 const struct cache_entry
*newtree
= src
[2];
2290 if (o
->merge_size
!= 2)
2291 return error("Cannot do a twoway merge of %d trees",
2294 if (oldtree
== o
->df_conflict_entry
)
2296 if (newtree
== o
->df_conflict_entry
)
2300 if (current
->ce_flags
& CE_CONFLICTED
) {
2301 if (same(oldtree
, newtree
) || o
->reset
) {
2303 return deleted_entry(current
, current
, o
);
2305 return merged_entry(newtree
, current
, o
);
2307 return reject_merge(current
, o
);
2308 } else if ((!oldtree
&& !newtree
) || /* 4 and 5 */
2309 (!oldtree
&& newtree
&&
2310 same(current
, newtree
)) || /* 6 and 7 */
2311 (oldtree
&& newtree
&&
2312 same(oldtree
, newtree
)) || /* 14 and 15 */
2313 (oldtree
&& newtree
&&
2314 !same(oldtree
, newtree
) && /* 18 and 19 */
2315 same(current
, newtree
))) {
2316 return keep_entry(current
, o
);
2317 } else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
2319 return deleted_entry(oldtree
, current
, o
);
2320 } else if (oldtree
&& newtree
&&
2321 same(current
, oldtree
) && !same(current
, newtree
)) {
2323 return merged_entry(newtree
, current
, o
);
2325 return reject_merge(current
, o
);
2328 if (oldtree
&& !o
->initial_checkout
) {
2330 * deletion of the path was staged;
2332 if (same(oldtree
, newtree
))
2334 return reject_merge(oldtree
, o
);
2336 return merged_entry(newtree
, current
, o
);
2338 return deleted_entry(oldtree
, current
, o
);
2344 * Keep the index entries at stage0, collapse stage1 but make sure
2345 * stage0 does not have anything there.
2347 int bind_merge(const struct cache_entry
* const *src
,
2348 struct unpack_trees_options
*o
)
2350 const struct cache_entry
*old
= src
[0];
2351 const struct cache_entry
*a
= src
[1];
2353 if (o
->merge_size
!= 1)
2354 return error("Cannot do a bind merge of %d trees",
2357 return o
->quiet
? -1 :
2358 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
),
2359 super_prefixed(a
->name
),
2360 super_prefixed(old
->name
));
2362 return keep_entry(old
, o
);
2364 return merged_entry(a
, NULL
, o
);
2371 * - take the stat information from stage0, take the data from stage1
2373 int oneway_merge(const struct cache_entry
* const *src
,
2374 struct unpack_trees_options
*o
)
2376 const struct cache_entry
*old
= src
[0];
2377 const struct cache_entry
*a
= src
[1];
2379 if (o
->merge_size
!= 1)
2380 return error("Cannot do a oneway merge of %d trees",
2383 if (!a
|| a
== o
->df_conflict_entry
)
2384 return deleted_entry(old
, old
, o
);
2386 if (old
&& same(old
, a
)) {
2388 if (o
->reset
&& o
->update
&& !ce_uptodate(old
) && !ce_skip_worktree(old
)) {
2390 if (lstat(old
->name
, &st
) ||
2391 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
2392 update
|= CE_UPDATE
;
2394 if (o
->update
&& S_ISGITLINK(old
->ce_mode
) &&
2395 should_update_submodules() && !verify_uptodate(old
, o
))
2396 update
|= CE_UPDATE
;
2397 add_entry(o
, old
, update
, CE_STAGEMASK
);
2400 return merged_entry(a
, old
, o
);