2 #include "argv-array.h"
3 #include "repository.h"
8 #include "cache-tree.h"
9 #include "unpack-trees.h"
13 #include "split-index.h"
14 #include "submodule.h"
15 #include "submodule-config.h"
16 #include "fsmonitor.h"
17 #include "object-store.h"
18 #include "promisor-remote.h"
21 * Error messages expected by scripts out of plumbing commands such as
22 * read-tree. Non-scripted Porcelain is not required to use these messages
23 * and in fact are encouraged to reword them to better suit their particular
24 * situation better. See how "git checkout" and "git merge" replaces
25 * them using setup_unpack_trees_porcelain(), for example.
27 static const char *unpack_plumbing_errors
[NB_UNPACK_TREES_ERROR_TYPES
] = {
28 /* ERROR_WOULD_OVERWRITE */
29 "Entry '%s' would be overwritten by merge. Cannot merge.",
31 /* ERROR_NOT_UPTODATE_FILE */
32 "Entry '%s' not uptodate. Cannot merge.",
34 /* ERROR_NOT_UPTODATE_DIR */
35 "Updating '%s' would lose untracked files in it",
37 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
38 "Untracked working tree file '%s' would be overwritten by merge.",
40 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
41 "Untracked working tree file '%s' would be removed by merge.",
43 /* ERROR_BIND_OVERLAP */
44 "Entry '%s' overlaps with '%s'. Cannot bind.",
46 /* ERROR_SPARSE_NOT_UPTODATE_FILE */
47 "Entry '%s' not uptodate. Cannot update sparse checkout.",
49 /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
50 "Working tree file '%s' would be overwritten by sparse checkout update.",
52 /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
53 "Working tree file '%s' would be removed by sparse checkout update.",
55 /* ERROR_WOULD_LOSE_SUBMODULE */
56 "Submodule '%s' cannot checkout new HEAD.",
59 #define ERRORMSG(o,type) \
60 ( ((o) && (o)->msgs[(type)]) \
61 ? ((o)->msgs[(type)]) \
62 : (unpack_plumbing_errors[(type)]) )
64 static const char *super_prefixed(const char *path
)
67 * It is necessary and sufficient to have two static buffers
68 * here, as the return value of this function is fed to
69 * error() using the unpack_*_errors[] templates we see above.
71 static struct strbuf buf
[2] = {STRBUF_INIT
, STRBUF_INIT
};
72 static int super_prefix_len
= -1;
73 static unsigned idx
= ARRAY_SIZE(buf
) - 1;
75 if (super_prefix_len
< 0) {
76 const char *super_prefix
= get_super_prefix();
81 for (i
= 0; i
< ARRAY_SIZE(buf
); i
++)
82 strbuf_addstr(&buf
[i
], super_prefix
);
83 super_prefix_len
= buf
[0].len
;
87 if (!super_prefix_len
)
90 if (++idx
>= ARRAY_SIZE(buf
))
93 strbuf_setlen(&buf
[idx
], super_prefix_len
);
94 strbuf_addstr(&buf
[idx
], path
);
99 void setup_unpack_trees_porcelain(struct unpack_trees_options
*opts
,
103 const char **msgs
= opts
->msgs
;
106 argv_array_init(&opts
->msgs_to_free
);
108 if (!strcmp(cmd
, "checkout"))
109 msg
= advice_commit_before_merge
110 ? _("Your local changes to the following files would be overwritten by checkout:\n%%s"
111 "Please commit your changes or stash them before you switch branches.")
112 : _("Your local changes to the following files would be overwritten by checkout:\n%%s");
113 else if (!strcmp(cmd
, "merge"))
114 msg
= advice_commit_before_merge
115 ? _("Your local changes to the following files would be overwritten by merge:\n%%s"
116 "Please commit your changes or stash them before you merge.")
117 : _("Your local changes to the following files would be overwritten by merge:\n%%s");
119 msg
= advice_commit_before_merge
120 ? _("Your local changes to the following files would be overwritten by %s:\n%%s"
121 "Please commit your changes or stash them before you %s.")
122 : _("Your local changes to the following files would be overwritten by %s:\n%%s");
123 msgs
[ERROR_WOULD_OVERWRITE
] = msgs
[ERROR_NOT_UPTODATE_FILE
] =
124 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
126 msgs
[ERROR_NOT_UPTODATE_DIR
] =
127 _("Updating the following directories would lose untracked files in them:\n%s");
129 if (!strcmp(cmd
, "checkout"))
130 msg
= advice_commit_before_merge
131 ? _("The following untracked working tree files would be removed by checkout:\n%%s"
132 "Please move or remove them before you switch branches.")
133 : _("The following untracked working tree files would be removed by checkout:\n%%s");
134 else if (!strcmp(cmd
, "merge"))
135 msg
= advice_commit_before_merge
136 ? _("The following untracked working tree files would be removed by merge:\n%%s"
137 "Please move or remove them before you merge.")
138 : _("The following untracked working tree files would be removed by merge:\n%%s");
140 msg
= advice_commit_before_merge
141 ? _("The following untracked working tree files would be removed by %s:\n%%s"
142 "Please move or remove them before you %s.")
143 : _("The following untracked working tree files would be removed by %s:\n%%s");
144 msgs
[ERROR_WOULD_LOSE_UNTRACKED_REMOVED
] =
145 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
147 if (!strcmp(cmd
, "checkout"))
148 msg
= advice_commit_before_merge
149 ? _("The following untracked working tree files would be overwritten by checkout:\n%%s"
150 "Please move or remove them before you switch branches.")
151 : _("The following untracked working tree files would be overwritten by checkout:\n%%s");
152 else if (!strcmp(cmd
, "merge"))
153 msg
= advice_commit_before_merge
154 ? _("The following untracked working tree files would be overwritten by merge:\n%%s"
155 "Please move or remove them before you merge.")
156 : _("The following untracked working tree files would be overwritten by merge:\n%%s");
158 msg
= advice_commit_before_merge
159 ? _("The following untracked working tree files would be overwritten by %s:\n%%s"
160 "Please move or remove them before you %s.")
161 : _("The following untracked working tree files would be overwritten by %s:\n%%s");
162 msgs
[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
] =
163 argv_array_pushf(&opts
->msgs_to_free
, msg
, cmd
, cmd
);
166 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
167 * cannot easily display it as a list.
169 msgs
[ERROR_BIND_OVERLAP
] = _("Entry '%s' overlaps with '%s'. Cannot bind.");
171 msgs
[ERROR_SPARSE_NOT_UPTODATE_FILE
] =
172 _("Cannot update sparse checkout: the following entries are not up to date:\n%s");
173 msgs
[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
] =
174 _("The following working tree files would be overwritten by sparse checkout update:\n%s");
175 msgs
[ERROR_WOULD_LOSE_ORPHANED_REMOVED
] =
176 _("The following working tree files would be removed by sparse checkout update:\n%s");
177 msgs
[ERROR_WOULD_LOSE_SUBMODULE
] =
178 _("Cannot update submodule:\n%s");
180 opts
->show_all_errors
= 1;
181 /* rejected paths may not have a static buffer */
182 for (i
= 0; i
< ARRAY_SIZE(opts
->unpack_rejects
); i
++)
183 opts
->unpack_rejects
[i
].strdup_strings
= 1;
186 void clear_unpack_trees_porcelain(struct unpack_trees_options
*opts
)
188 argv_array_clear(&opts
->msgs_to_free
);
189 memset(opts
->msgs
, 0, sizeof(opts
->msgs
));
192 static int do_add_entry(struct unpack_trees_options
*o
, struct cache_entry
*ce
,
193 unsigned int set
, unsigned int clear
)
200 ce
->ce_flags
= (ce
->ce_flags
& ~clear
) | set
;
201 return add_index_entry(&o
->result
, ce
,
202 ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
205 static void add_entry(struct unpack_trees_options
*o
,
206 const struct cache_entry
*ce
,
207 unsigned int set
, unsigned int clear
)
209 do_add_entry(o
, dup_cache_entry(ce
, &o
->result
), set
, clear
);
213 * add error messages on path <path>
214 * corresponding to the type <e> with the message <msg>
215 * indicating if it should be display in porcelain or not
217 static int add_rejected_path(struct unpack_trees_options
*o
,
218 enum unpack_trees_error_types e
,
224 if (!o
->show_all_errors
)
225 return error(ERRORMSG(o
, e
), super_prefixed(path
));
228 * Otherwise, insert in a list for future display by
229 * display_error_msgs()
231 string_list_append(&o
->unpack_rejects
[e
], path
);
236 * display all the error messages stored in a nice way
238 static void display_error_msgs(struct unpack_trees_options
*o
)
241 int something_displayed
= 0;
242 for (e
= 0; e
< NB_UNPACK_TREES_ERROR_TYPES
; e
++) {
243 struct string_list
*rejects
= &o
->unpack_rejects
[e
];
244 if (rejects
->nr
> 0) {
245 struct strbuf path
= STRBUF_INIT
;
246 something_displayed
= 1;
247 for (i
= 0; i
< rejects
->nr
; i
++)
248 strbuf_addf(&path
, "\t%s\n", rejects
->items
[i
].string
);
249 error(ERRORMSG(o
, e
), super_prefixed(path
.buf
));
250 strbuf_release(&path
);
252 string_list_clear(rejects
, 0);
254 if (something_displayed
)
255 fprintf(stderr
, _("Aborting\n"));
258 static int check_submodule_move_head(const struct cache_entry
*ce
,
261 struct unpack_trees_options
*o
)
263 unsigned flags
= SUBMODULE_MOVE_HEAD_DRY_RUN
;
264 const struct submodule
*sub
= submodule_from_ce(ce
);
270 flags
|= SUBMODULE_MOVE_HEAD_FORCE
;
272 if (submodule_move_head(ce
->name
, old_id
, new_id
, flags
))
273 return add_rejected_path(o
, ERROR_WOULD_LOSE_SUBMODULE
, ce
->name
);
278 * Preform the loading of the repository's gitmodules file. This function is
279 * used by 'check_update()' to perform loading of the gitmodules file in two
280 * differnt situations:
281 * (1) before removing entries from the working tree if the gitmodules file has
282 * been marked for removal. This situation is specified by 'state' == NULL.
283 * (2) before checking out entries to the working tree if the gitmodules file
284 * has been marked for update. This situation is specified by 'state' != NULL.
286 static void load_gitmodules_file(struct index_state
*index
,
287 struct checkout
*state
)
289 int pos
= index_name_pos(index
, GITMODULES_FILE
, strlen(GITMODULES_FILE
));
292 struct cache_entry
*ce
= index
->cache
[pos
];
293 if (!state
&& ce
->ce_flags
& CE_WT_REMOVE
) {
294 repo_read_gitmodules(the_repository
);
295 } else if (state
&& (ce
->ce_flags
& CE_UPDATE
)) {
296 submodule_free(the_repository
);
297 checkout_entry(ce
, state
, NULL
, NULL
);
298 repo_read_gitmodules(the_repository
);
303 static struct progress
*get_progress(struct unpack_trees_options
*o
)
305 unsigned cnt
= 0, total
= 0;
306 struct index_state
*index
= &o
->result
;
308 if (!o
->update
|| !o
->verbose_update
)
311 for (; cnt
< index
->cache_nr
; cnt
++) {
312 const struct cache_entry
*ce
= index
->cache
[cnt
];
313 if (ce
->ce_flags
& (CE_UPDATE
| CE_WT_REMOVE
))
317 return start_delayed_progress(_("Updating files"), total
);
320 static void setup_collided_checkout_detection(struct checkout
*state
,
321 struct index_state
*index
)
326 for (i
= 0; i
< index
->cache_nr
; i
++)
327 index
->cache
[i
]->ce_flags
&= ~CE_MATCHED
;
330 static void report_collided_checkout(struct index_state
*index
)
332 struct string_list list
= STRING_LIST_INIT_NODUP
;
335 for (i
= 0; i
< index
->cache_nr
; i
++) {
336 struct cache_entry
*ce
= index
->cache
[i
];
338 if (!(ce
->ce_flags
& CE_MATCHED
))
341 string_list_append(&list
, ce
->name
);
342 ce
->ce_flags
&= ~CE_MATCHED
;
345 list
.cmp
= fspathcmp
;
346 string_list_sort(&list
);
349 warning(_("the following paths have collided (e.g. case-sensitive paths\n"
350 "on a case-insensitive filesystem) and only one from the same\n"
351 "colliding group is in the working tree:\n"));
353 for (i
= 0; i
< list
.nr
; i
++)
354 fprintf(stderr
, " '%s'\n", list
.items
[i
].string
);
357 string_list_clear(&list
, 0);
360 static int check_updates(struct unpack_trees_options
*o
)
364 struct progress
*progress
;
365 struct index_state
*index
= &o
->result
;
366 struct checkout state
= CHECKOUT_INIT
;
369 trace_performance_enter();
372 state
.refresh_cache
= 1;
373 state
.istate
= index
;
376 setup_collided_checkout_detection(&state
, index
);
378 progress
= get_progress(o
);
381 git_attr_set_direction(GIT_ATTR_CHECKOUT
);
383 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
384 load_gitmodules_file(index
, NULL
);
386 for (i
= 0; i
< index
->cache_nr
; i
++) {
387 const struct cache_entry
*ce
= index
->cache
[i
];
389 if (ce
->ce_flags
& CE_WT_REMOVE
) {
390 display_progress(progress
, ++cnt
);
391 if (o
->update
&& !o
->dry_run
)
395 remove_marked_cache_entries(index
, 0);
396 remove_scheduled_dirs();
398 if (should_update_submodules() && o
->update
&& !o
->dry_run
)
399 load_gitmodules_file(index
, &state
);
401 enable_delayed_checkout(&state
);
402 if (has_promisor_remote() && o
->update
&& !o
->dry_run
) {
404 * Prefetch the objects that are to be checked out in the loop
407 struct oid_array to_fetch
= OID_ARRAY_INIT
;
408 for (i
= 0; i
< index
->cache_nr
; i
++) {
409 struct cache_entry
*ce
= index
->cache
[i
];
411 if (!(ce
->ce_flags
& CE_UPDATE
) ||
412 S_ISGITLINK(ce
->ce_mode
))
414 if (!oid_object_info_extended(the_repository
, &ce
->oid
,
416 OBJECT_INFO_FOR_PREFETCH
))
418 oid_array_append(&to_fetch
, &ce
->oid
);
421 promisor_remote_get_direct(the_repository
,
422 to_fetch
.oid
, to_fetch
.nr
);
423 oid_array_clear(&to_fetch
);
425 for (i
= 0; i
< index
->cache_nr
; i
++) {
426 struct cache_entry
*ce
= index
->cache
[i
];
428 if (ce
->ce_flags
& CE_UPDATE
) {
429 if (ce
->ce_flags
& CE_WT_REMOVE
)
430 BUG("both update and delete flags are set on %s",
432 display_progress(progress
, ++cnt
);
433 ce
->ce_flags
&= ~CE_UPDATE
;
434 if (o
->update
&& !o
->dry_run
) {
435 errs
|= checkout_entry(ce
, &state
, NULL
, NULL
);
439 stop_progress(&progress
);
440 errs
|= finish_delayed_checkout(&state
, NULL
);
442 git_attr_set_direction(GIT_ATTR_CHECKIN
);
445 report_collided_checkout(index
);
447 trace_performance_leave("check_updates");
451 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
452 struct unpack_trees_options
*o
);
453 static int verify_absent_sparse(const struct cache_entry
*ce
,
454 enum unpack_trees_error_types
,
455 struct unpack_trees_options
*o
);
457 static int apply_sparse_checkout(struct index_state
*istate
,
458 struct cache_entry
*ce
,
459 struct unpack_trees_options
*o
)
461 int was_skip_worktree
= ce_skip_worktree(ce
);
463 if (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
)
464 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
466 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
467 if (was_skip_worktree
!= ce_skip_worktree(ce
)) {
468 ce
->ce_flags
|= CE_UPDATE_IN_BASE
;
469 mark_fsmonitor_invalid(istate
, ce
);
470 istate
->cache_changed
|= CE_ENTRY_CHANGED
;
474 * if (!was_skip_worktree && !ce_skip_worktree()) {
475 * This is perfectly normal. Move on;
480 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
481 * area as a result of ce_skip_worktree() shortcuts in
482 * verify_absent() and verify_uptodate().
483 * Make sure they don't modify worktree if they are already
484 * outside checkout area
486 if (was_skip_worktree
&& ce_skip_worktree(ce
)) {
487 ce
->ce_flags
&= ~CE_UPDATE
;
490 * By default, when CE_REMOVE is on, CE_WT_REMOVE is also
491 * on to get that file removed from both index and worktree.
492 * If that file is already outside worktree area, don't
495 if (ce
->ce_flags
& CE_REMOVE
)
496 ce
->ce_flags
&= ~CE_WT_REMOVE
;
499 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
501 * If CE_UPDATE is set, verify_uptodate() must be called already
502 * also stat info may have lost after merged_entry() so calling
503 * verify_uptodate() again may fail
505 if (!(ce
->ce_flags
& CE_UPDATE
) && verify_uptodate_sparse(ce
, o
))
507 ce
->ce_flags
|= CE_WT_REMOVE
;
508 ce
->ce_flags
&= ~CE_UPDATE
;
510 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
511 if (verify_absent_sparse(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
513 ce
->ce_flags
|= CE_UPDATE
;
518 static inline int call_unpack_fn(const struct cache_entry
* const *src
,
519 struct unpack_trees_options
*o
)
521 int ret
= o
->fn(src
, o
);
527 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
529 ce
->ce_flags
|= CE_UNPACKED
;
531 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
532 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
533 int bottom
= o
->cache_bottom
;
534 while (bottom
< o
->src_index
->cache_nr
&&
535 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
537 o
->cache_bottom
= bottom
;
541 static void mark_all_ce_unused(struct index_state
*index
)
544 for (i
= 0; i
< index
->cache_nr
; i
++)
545 index
->cache
[i
]->ce_flags
&= ~(CE_UNPACKED
| CE_ADDED
| CE_NEW_SKIP_WORKTREE
);
548 static int locate_in_src_index(const struct cache_entry
*ce
,
549 struct unpack_trees_options
*o
)
551 struct index_state
*index
= o
->src_index
;
552 int len
= ce_namelen(ce
);
553 int pos
= index_name_pos(index
, ce
->name
, len
);
560 * We call unpack_index_entry() with an unmerged cache entry
561 * only in diff-index, and it wants a single callback. Skip
562 * the other unmerged entry with the same name.
564 static void mark_ce_used_same_name(struct cache_entry
*ce
,
565 struct unpack_trees_options
*o
)
567 struct index_state
*index
= o
->src_index
;
568 int len
= ce_namelen(ce
);
571 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
572 struct cache_entry
*next
= index
->cache
[pos
];
573 if (len
!= ce_namelen(next
) ||
574 memcmp(ce
->name
, next
->name
, len
))
576 mark_ce_used(next
, o
);
580 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
582 const struct index_state
*index
= o
->src_index
;
583 int pos
= o
->cache_bottom
;
585 while (pos
< index
->cache_nr
) {
586 struct cache_entry
*ce
= index
->cache
[pos
];
587 if (!(ce
->ce_flags
& CE_UNPACKED
))
594 static void add_same_unmerged(const struct cache_entry
*ce
,
595 struct unpack_trees_options
*o
)
597 struct index_state
*index
= o
->src_index
;
598 int len
= ce_namelen(ce
);
599 int pos
= index_name_pos(index
, ce
->name
, len
);
602 die("programming error in a caller of mark_ce_used_same_name");
603 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
604 struct cache_entry
*next
= index
->cache
[pos
];
605 if (len
!= ce_namelen(next
) ||
606 memcmp(ce
->name
, next
->name
, len
))
608 add_entry(o
, next
, 0, 0);
609 mark_ce_used(next
, o
);
613 static int unpack_index_entry(struct cache_entry
*ce
,
614 struct unpack_trees_options
*o
)
616 const struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
623 if (o
->skip_unmerged
) {
624 add_entry(o
, ce
, 0, 0);
628 ret
= call_unpack_fn(src
, o
);
630 mark_ce_used_same_name(ce
, o
);
634 static int find_cache_pos(struct traverse_info
*, const char *p
, size_t len
);
636 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
638 struct unpack_trees_options
*o
= info
->data
;
640 if (o
->diff_index_cached
)
642 o
->cache_bottom
= bottom
;
645 static int switch_cache_bottom(struct traverse_info
*info
)
647 struct unpack_trees_options
*o
= info
->data
;
650 if (o
->diff_index_cached
)
652 ret
= o
->cache_bottom
;
653 pos
= find_cache_pos(info
->prev
, info
->name
, info
->namelen
);
656 o
->cache_bottom
= -2 - pos
;
658 o
->cache_bottom
= o
->src_index
->cache_nr
;
662 static inline int are_same_oid(struct name_entry
*name_j
, struct name_entry
*name_k
)
664 return !is_null_oid(&name_j
->oid
) && !is_null_oid(&name_k
->oid
) && oideq(&name_j
->oid
, &name_k
->oid
);
667 static int all_trees_same_as_cache_tree(int n
, unsigned long dirmask
,
668 struct name_entry
*names
,
669 struct traverse_info
*info
)
671 struct unpack_trees_options
*o
= info
->data
;
674 if (!o
->merge
|| dirmask
!= ((1 << n
) - 1))
677 for (i
= 1; i
< n
; i
++)
678 if (!are_same_oid(names
, names
+ i
))
681 return cache_tree_matches_traversal(o
->src_index
->cache_tree
, names
, info
);
684 static int index_pos_by_traverse_info(struct name_entry
*names
,
685 struct traverse_info
*info
)
687 struct unpack_trees_options
*o
= info
->data
;
688 struct strbuf name
= STRBUF_INIT
;
691 strbuf_make_traverse_path(&name
, info
, names
->path
, names
->pathlen
);
692 strbuf_addch(&name
, '/');
693 pos
= index_name_pos(o
->src_index
, name
.buf
, 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
.buf
) ||
698 (pos
> 0 && starts_with(o
->src_index
->cache
[pos
-1]->name
, name
.buf
)))
699 BUG("pos must point at the first entry in this directory");
700 strbuf_release(&name
);
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 traverse_info
*info
)
712 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
713 struct unpack_trees_options
*o
= info
->data
;
714 struct cache_entry
*tree_ce
= NULL
;
719 BUG("We need cache-tree to do this optimization");
722 * Do what unpack_callback() and unpack_nondirectories() normally
723 * do. But we walk all paths in an iterative loop instead.
725 * D/F conflicts and higher stage entries are not a concern
726 * because cache-tree would be invalidated and we would never
727 * get here in the first place.
729 for (i
= 0; i
< nr_entries
; i
++) {
730 int new_ce_len
, len
, rc
;
732 src
[0] = o
->src_index
->cache
[pos
+ i
];
734 len
= ce_namelen(src
[0]);
735 new_ce_len
= cache_entry_size(len
);
737 if (new_ce_len
> ce_len
) {
739 tree_ce
= xrealloc(tree_ce
, new_ce_len
);
740 memset(tree_ce
, 0, new_ce_len
);
743 tree_ce
->ce_flags
= create_ce_flags(0);
745 for (d
= 1; d
<= nr_names
; d
++)
749 tree_ce
->ce_mode
= src
[0]->ce_mode
;
750 tree_ce
->ce_namelen
= len
;
751 oidcpy(&tree_ce
->oid
, &src
[0]->oid
);
752 memcpy(tree_ce
->name
, src
[0]->name
, len
+ 1);
754 rc
= call_unpack_fn((const struct cache_entry
* const *)src
, o
);
760 mark_ce_used(src
[0], o
);
764 printf("Unpacked %d entries from %s to %s using cache-tree\n",
766 o
->src_index
->cache
[pos
]->name
,
767 o
->src_index
->cache
[pos
+ nr_entries
- 1]->name
);
771 static int traverse_trees_recursive(int n
, unsigned long dirmask
,
772 unsigned long df_conflicts
,
773 struct name_entry
*names
,
774 struct traverse_info
*info
)
776 struct unpack_trees_options
*o
= info
->data
;
779 struct tree_desc t
[MAX_UNPACK_TREES
];
780 void *buf
[MAX_UNPACK_TREES
];
781 struct traverse_info newinfo
;
782 struct name_entry
*p
;
785 nr_entries
= all_trees_same_as_cache_tree(n
, dirmask
, names
, info
);
786 if (nr_entries
> 0) {
787 int pos
= index_pos_by_traverse_info(names
, info
);
789 if (!o
->merge
|| df_conflicts
)
790 BUG("Wrong condition to get here buddy");
793 * All entries up to 'pos' must have been processed
794 * (i.e. marked CE_UNPACKED) at this point. But to be safe,
795 * save and restore cache_bottom anyway to not miss
796 * unprocessed entries before 'pos'.
798 bottom
= o
->cache_bottom
;
799 ret
= traverse_by_cache_tree(pos
, nr_entries
, n
, info
);
800 o
->cache_bottom
= bottom
;
810 newinfo
.pathspec
= info
->pathspec
;
811 newinfo
.name
= p
->path
;
812 newinfo
.namelen
= p
->pathlen
;
813 newinfo
.mode
= p
->mode
;
814 newinfo
.pathlen
= st_add3(newinfo
.pathlen
, tree_entry_len(p
), 1);
815 newinfo
.df_conflicts
|= df_conflicts
;
818 * Fetch the tree from the ODB for each peer directory in the
821 * For 2- and 3-way traversals, we try to avoid hitting the
822 * ODB twice for the same OID. This should yield a nice speed
823 * up in checkouts and merges when the commits are similar.
825 * We don't bother doing the full O(n^2) search for larger n,
826 * because wider traversals don't happen that often and we
827 * avoid the search setup.
829 * When 2 peer OIDs are the same, we just copy the tree
830 * descriptor data. This implicitly borrows the buffer
831 * data from the earlier cell.
833 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
834 if (i
> 0 && are_same_oid(&names
[i
], &names
[i
- 1]))
836 else if (i
> 1 && are_same_oid(&names
[i
], &names
[i
- 2]))
839 const struct object_id
*oid
= NULL
;
842 buf
[nr_buf
++] = fill_tree_descriptor(the_repository
, t
+ i
, oid
);
846 bottom
= switch_cache_bottom(&newinfo
);
847 ret
= traverse_trees(o
->src_index
, n
, t
, &newinfo
);
848 restore_cache_bottom(&newinfo
, bottom
);
850 for (i
= 0; i
< nr_buf
; i
++)
857 * Compare the traverse-path to the cache entry without actually
858 * having to generate the textual representation of the traverse
861 * NOTE! This *only* compares up to the size of the traverse path
862 * itself - the caller needs to do the final check for the cache
863 * entry having more data at the end!
865 static int do_compare_entry_piecewise(const struct cache_entry
*ce
,
866 const struct traverse_info
*info
,
867 const char *name
, size_t namelen
,
874 int cmp
= do_compare_entry_piecewise(ce
, info
->prev
,
875 info
->name
, info
->namelen
,
880 pathlen
= info
->pathlen
;
881 ce_len
= ce_namelen(ce
);
883 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
884 if (ce_len
< pathlen
)
888 ce_name
= ce
->name
+ pathlen
;
890 return df_name_compare(ce_name
, ce_len
, S_IFREG
, name
, namelen
, mode
);
893 static int do_compare_entry(const struct cache_entry
*ce
,
894 const struct traverse_info
*info
,
895 const char *name
, size_t namelen
,
903 * If we have not precomputed the traverse path, it is quicker
904 * to avoid doing so. But if we have precomputed it,
905 * it is quicker to use the precomputed version.
907 if (!info
->traverse_path
)
908 return do_compare_entry_piecewise(ce
, info
, name
, namelen
, mode
);
910 cmp
= strncmp(ce
->name
, info
->traverse_path
, info
->pathlen
);
914 pathlen
= info
->pathlen
;
915 ce_len
= ce_namelen(ce
);
917 if (ce_len
< pathlen
)
921 ce_name
= ce
->name
+ pathlen
;
923 return df_name_compare(ce_name
, ce_len
, S_IFREG
, name
, namelen
, mode
);
926 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
928 int cmp
= do_compare_entry(ce
, info
, n
->path
, n
->pathlen
, n
->mode
);
933 * Even if the beginning compared identically, the ce should
934 * compare as bigger than a directory leading up to it!
936 return ce_namelen(ce
) > traverse_path_len(info
, tree_entry_len(n
));
939 static int ce_in_traverse_path(const struct cache_entry
*ce
,
940 const struct traverse_info
*info
)
944 if (do_compare_entry(ce
, info
->prev
,
945 info
->name
, info
->namelen
, info
->mode
))
948 * If ce (blob) is the same name as the path (which is a tree
949 * we will be descending into), it won't be inside it.
951 return (info
->pathlen
< ce_namelen(ce
));
954 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
,
955 const struct name_entry
*n
,
957 struct index_state
*istate
,
960 size_t len
= traverse_path_len(info
, tree_entry_len(n
));
961 struct cache_entry
*ce
=
963 make_empty_transient_cache_entry(len
) :
964 make_empty_cache_entry(istate
, len
);
966 ce
->ce_mode
= create_ce_mode(n
->mode
);
967 ce
->ce_flags
= create_ce_flags(stage
);
968 ce
->ce_namelen
= len
;
969 oidcpy(&ce
->oid
, &n
->oid
);
970 /* len+1 because the cache_entry allocates space for NUL */
971 make_traverse_path(ce
->name
, len
+ 1, info
, n
->path
, n
->pathlen
);
977 * Note that traverse_by_cache_tree() duplicates some logic in this function
978 * without actually calling it. If you change the logic here you may need to
979 * check and change there as well.
981 static int unpack_nondirectories(int n
, unsigned long mask
,
982 unsigned long dirmask
,
983 struct cache_entry
**src
,
984 const struct name_entry
*names
,
985 const struct traverse_info
*info
)
988 struct unpack_trees_options
*o
= info
->data
;
989 unsigned long conflicts
= info
->df_conflicts
| dirmask
;
991 /* Do we have *only* directories? Nothing to do */
992 if (mask
== dirmask
&& !src
[0])
996 * Ok, we've filled in up to any potential index entry in src[0],
999 for (i
= 0; i
< n
; i
++) {
1001 unsigned int bit
= 1ul << i
;
1002 if (conflicts
& bit
) {
1003 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
1010 else if (i
+ 1 < o
->head_idx
)
1012 else if (i
+ 1 > o
->head_idx
)
1018 * If the merge bit is set, then the cache entries are
1019 * discarded in the following block. In this case,
1020 * construct "transient" cache_entries, as they are
1021 * not stored in the index. otherwise construct the
1022 * cache entry from the index aware logic.
1024 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
, &o
->result
, o
->merge
);
1028 int rc
= call_unpack_fn((const struct cache_entry
* const *)src
,
1030 for (i
= 0; i
< n
; i
++) {
1031 struct cache_entry
*ce
= src
[i
+ o
->merge
];
1032 if (ce
!= o
->df_conflict_entry
)
1033 discard_cache_entry(ce
);
1038 for (i
= 0; i
< n
; i
++)
1039 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
1040 if (do_add_entry(o
, src
[i
], 0, 0))
1046 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
1048 discard_index(&o
->result
);
1049 if (!o
->quiet
&& !o
->exiting_early
) {
1051 return error("%s", message
);
1058 * The tree traversal is looking at name p. If we have a matching entry,
1059 * return it. If name p is a directory in the index, do not return
1060 * anything, as we will want to match it when the traversal descends into
1063 static int find_cache_pos(struct traverse_info
*info
,
1064 const char *p
, size_t p_len
)
1067 struct unpack_trees_options
*o
= info
->data
;
1068 struct index_state
*index
= o
->src_index
;
1069 int pfxlen
= info
->pathlen
;
1071 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
1072 const struct cache_entry
*ce
= index
->cache
[pos
];
1073 const char *ce_name
, *ce_slash
;
1076 if (ce
->ce_flags
& CE_UNPACKED
) {
1078 * cache_bottom entry is already unpacked, so
1079 * we can never match it; don't check it
1082 if (pos
== o
->cache_bottom
)
1086 if (!ce_in_traverse_path(ce
, info
)) {
1088 * Check if we can skip future cache checks
1089 * (because we're already past all possible
1090 * entries in the traverse path).
1092 if (info
->traverse_path
) {
1093 if (strncmp(ce
->name
, info
->traverse_path
,
1099 ce_name
= ce
->name
+ pfxlen
;
1100 ce_slash
= strchr(ce_name
, '/');
1102 ce_len
= ce_slash
- ce_name
;
1104 ce_len
= ce_namelen(ce
) - pfxlen
;
1105 cmp
= name_compare(p
, p_len
, ce_name
, ce_len
);
1107 * Exact match; if we have a directory we need to
1108 * delay returning it.
1111 return ce_slash
? -2 - pos
: pos
;
1113 continue; /* keep looking */
1115 * ce_name sorts after p->path; could it be that we
1116 * have files under p->path directory in the index?
1117 * E.g. ce_name == "t-i", and p->path == "t"; we may
1118 * have "t/a" in the index.
1120 if (p_len
< ce_len
&& !memcmp(ce_name
, p
, p_len
) &&
1121 ce_name
[p_len
] < '/')
1122 continue; /* keep looking */
1128 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
1129 const struct name_entry
*p
)
1131 int pos
= find_cache_pos(info
, p
->path
, p
->pathlen
);
1132 struct unpack_trees_options
*o
= info
->data
;
1135 return o
->src_index
->cache
[pos
];
1140 static void debug_path(struct traverse_info
*info
)
1143 debug_path(info
->prev
);
1144 if (*info
->prev
->name
)
1147 printf("%s", info
->name
);
1150 static void debug_name_entry(int i
, struct name_entry
*n
)
1152 printf("ent#%d %06o %s\n", i
,
1153 n
->path
? n
->mode
: 0,
1154 n
->path
? n
->path
: "(missing)");
1157 static void debug_unpack_callback(int n
,
1159 unsigned long dirmask
,
1160 struct name_entry
*names
,
1161 struct traverse_info
*info
)
1164 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
1168 for (i
= 0; i
< n
; i
++)
1169 debug_name_entry(i
, names
+ i
);
1173 * Note that traverse_by_cache_tree() duplicates some logic in this function
1174 * without actually calling it. If you change the logic here you may need to
1175 * check and change there as well.
1177 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
1179 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
1180 struct unpack_trees_options
*o
= info
->data
;
1181 const struct name_entry
*p
= names
;
1183 /* Find first entry with a real name (we could use "mask" too) */
1187 if (o
->debug_unpack
)
1188 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
1190 /* Are we supposed to look at the index too? */
1194 struct cache_entry
*ce
;
1196 if (o
->diff_index_cached
)
1197 ce
= next_cache_entry(o
);
1199 ce
= find_cache_entry(info
, p
);
1203 cmp
= compare_entry(ce
, info
, p
);
1205 if (unpack_index_entry(ce
, o
) < 0)
1206 return unpack_failed(o
, NULL
);
1212 * If we skip unmerged index
1213 * entries, we'll skip this
1214 * entry *and* the tree
1215 * entries associated with it!
1217 if (o
->skip_unmerged
) {
1218 add_same_unmerged(ce
, o
);
1228 if (unpack_nondirectories(n
, mask
, dirmask
, src
, names
, info
) < 0)
1231 if (o
->merge
&& src
[0]) {
1232 if (ce_stage(src
[0]))
1233 mark_ce_used_same_name(src
[0], o
);
1235 mark_ce_used(src
[0], o
);
1238 /* Now handle any directories.. */
1240 /* special case: "diff-index --cached" looking at a tree */
1241 if (o
->diff_index_cached
&&
1242 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
1244 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
1247 * Everything under the name matches; skip the
1248 * entire hierarchy. diff_index_cached codepath
1249 * special cases D/F conflicts in such a way that
1250 * it does not do any look-ahead, so this is safe.
1253 o
->cache_bottom
+= matches
;
1258 if (traverse_trees_recursive(n
, dirmask
, mask
& ~dirmask
,
1267 static int clear_ce_flags_1(struct index_state
*istate
,
1268 struct cache_entry
**cache
, int nr
,
1269 struct strbuf
*prefix
,
1270 int select_mask
, int clear_mask
,
1271 struct pattern_list
*pl
,
1272 enum pattern_match_result default_match
);
1274 /* Whole directory matching */
1275 static int clear_ce_flags_dir(struct index_state
*istate
,
1276 struct cache_entry
**cache
, int nr
,
1277 struct strbuf
*prefix
,
1279 int select_mask
, int clear_mask
,
1280 struct pattern_list
*pl
,
1281 enum pattern_match_result default_match
)
1283 struct cache_entry
**cache_end
;
1286 enum pattern_match_result ret
;
1287 ret
= path_matches_pattern_list(prefix
->buf
, prefix
->len
,
1288 basename
, &dtype
, pl
, istate
);
1290 strbuf_addch(prefix
, '/');
1292 /* If undecided, use matching result of parent dir in defval */
1293 if (ret
== UNDECIDED
)
1294 ret
= default_match
;
1296 for (cache_end
= cache
; cache_end
!= cache
+ nr
; cache_end
++) {
1297 struct cache_entry
*ce
= *cache_end
;
1298 if (strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1303 * TODO: check pl, if there are no patterns that may conflict
1304 * with ret (iow, we know in advance the incl/excl
1305 * decision for the entire directory), clear flag here without
1306 * calling clear_ce_flags_1(). That function will call
1307 * the expensive path_matches_pattern_list() on every entry.
1309 rc
= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1311 select_mask
, clear_mask
,
1313 strbuf_setlen(prefix
, prefix
->len
- 1);
1318 * Traverse the index, find every entry that matches according to
1319 * o->pl. Do "ce_flags &= ~clear_mask" on those entries. Return the
1320 * number of traversed entries.
1322 * If select_mask is non-zero, only entries whose ce_flags has on of
1323 * those bits enabled are traversed.
1325 * cache : pointer to an index entry
1326 * prefix_len : an offset to its path
1328 * The current path ("prefix") including the trailing '/' is
1329 * cache[0]->name[0..(prefix_len-1)]
1330 * Top level path has prefix_len zero.
1332 static int clear_ce_flags_1(struct index_state
*istate
,
1333 struct cache_entry
**cache
, int nr
,
1334 struct strbuf
*prefix
,
1335 int select_mask
, int clear_mask
,
1336 struct pattern_list
*pl
,
1337 enum pattern_match_result default_match
)
1339 struct cache_entry
**cache_end
= cache
+ nr
;
1342 * Process all entries that have the given prefix and meet
1343 * select_mask condition
1345 while(cache
!= cache_end
) {
1346 struct cache_entry
*ce
= *cache
;
1347 const char *name
, *slash
;
1349 enum pattern_match_result ret
;
1351 if (select_mask
&& !(ce
->ce_flags
& select_mask
)) {
1356 if (prefix
->len
&& strncmp(ce
->name
, prefix
->buf
, prefix
->len
))
1359 name
= ce
->name
+ prefix
->len
;
1360 slash
= strchr(name
, '/');
1362 /* If it's a directory, try whole directory match first */
1367 strbuf_add(prefix
, name
, len
);
1369 processed
= clear_ce_flags_dir(istate
, cache
, cache_end
- cache
,
1371 prefix
->buf
+ prefix
->len
- len
,
1372 select_mask
, clear_mask
,
1375 /* clear_c_f_dir eats a whole dir already? */
1378 strbuf_setlen(prefix
, prefix
->len
- len
);
1382 strbuf_addch(prefix
, '/');
1383 cache
+= clear_ce_flags_1(istate
, cache
, cache_end
- cache
,
1385 select_mask
, clear_mask
, pl
,
1387 strbuf_setlen(prefix
, prefix
->len
- len
- 1);
1392 dtype
= ce_to_dtype(ce
);
1393 ret
= path_matches_pattern_list(ce
->name
,
1395 name
, &dtype
, pl
, istate
);
1396 if (ret
== UNDECIDED
)
1397 ret
= default_match
;
1399 ce
->ce_flags
&= ~clear_mask
;
1402 return nr
- (cache_end
- cache
);
1405 static int clear_ce_flags(struct index_state
*istate
,
1406 int select_mask
, int clear_mask
,
1407 struct pattern_list
*pl
)
1409 static struct strbuf prefix
= STRBUF_INIT
;
1413 strbuf_reset(&prefix
);
1415 xsnprintf(label
, sizeof(label
), "clear_ce_flags(0x%08lx,0x%08lx)",
1416 (unsigned long)select_mask
, (unsigned long)clear_mask
);
1417 trace2_region_enter("unpack_trees", label
, the_repository
);
1418 rval
= clear_ce_flags_1(istate
,
1422 select_mask
, clear_mask
,
1424 trace2_region_leave("unpack_trees", label
, the_repository
);
1430 * Set/Clear CE_NEW_SKIP_WORKTREE according to $GIT_DIR/info/sparse-checkout
1432 static void mark_new_skip_worktree(struct pattern_list
*pl
,
1433 struct index_state
*istate
,
1434 int select_flag
, int skip_wt_flag
)
1439 * 1. Pretend the narrowest worktree: only unmerged entries
1442 for (i
= 0; i
< istate
->cache_nr
; i
++) {
1443 struct cache_entry
*ce
= istate
->cache
[i
];
1445 if (select_flag
&& !(ce
->ce_flags
& select_flag
))
1448 if (!ce_stage(ce
) && !(ce
->ce_flags
& CE_CONFLICTED
))
1449 ce
->ce_flags
|= skip_wt_flag
;
1451 ce
->ce_flags
&= ~skip_wt_flag
;
1455 * 2. Widen worktree according to sparse-checkout file.
1456 * Matched entries will have skip_wt_flag cleared (i.e. "in")
1458 clear_ce_flags(istate
, select_flag
, skip_wt_flag
, pl
);
1461 static int verify_absent(const struct cache_entry
*,
1462 enum unpack_trees_error_types
,
1463 struct unpack_trees_options
*);
1465 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
1466 * resulting index, -2 on failure to reflect the changes to the work tree.
1468 * CE_ADDED, CE_UNPACKED and CE_NEW_SKIP_WORKTREE are used internally
1470 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
1473 static struct cache_entry
*dfc
;
1474 struct pattern_list pl
;
1476 if (len
> MAX_UNPACK_TREES
)
1477 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
1479 trace_performance_enter();
1480 memset(&pl
, 0, sizeof(pl
));
1481 if (!core_apply_sparse_checkout
|| !o
->update
)
1482 o
->skip_sparse_checkout
= 1;
1483 if (!o
->skip_sparse_checkout
) {
1484 char *sparse
= git_pathdup("info/sparse-checkout");
1485 pl
.use_cone_patterns
= core_sparse_checkout_cone
;
1486 if (add_patterns_from_file_to_list(sparse
, "", 0, &pl
, NULL
) < 0)
1487 o
->skip_sparse_checkout
= 1;
1493 memset(&o
->result
, 0, sizeof(o
->result
));
1494 o
->result
.initialized
= 1;
1495 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
1496 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
1497 o
->result
.version
= o
->src_index
->version
;
1498 if (!o
->src_index
->split_index
) {
1499 o
->result
.split_index
= NULL
;
1500 } else if (o
->src_index
== o
->dst_index
) {
1502 * o->dst_index (and thus o->src_index) will be discarded
1503 * and overwritten with o->result at the end of this function,
1504 * so just use src_index's split_index to avoid having to
1507 o
->result
.split_index
= o
->src_index
->split_index
;
1508 o
->result
.split_index
->refcount
++;
1510 o
->result
.split_index
= init_split_index(&o
->result
);
1512 oidcpy(&o
->result
.oid
, &o
->src_index
->oid
);
1513 o
->merge_size
= len
;
1514 mark_all_ce_unused(o
->src_index
);
1517 * Sparse checkout loop #1: set NEW_SKIP_WORKTREE on existing entries
1519 if (!o
->skip_sparse_checkout
)
1520 mark_new_skip_worktree(o
->pl
, o
->src_index
, 0, CE_NEW_SKIP_WORKTREE
);
1523 dfc
= xcalloc(1, cache_entry_size(0));
1524 o
->df_conflict_entry
= dfc
;
1527 const char *prefix
= o
->prefix
? o
->prefix
: "";
1528 struct traverse_info info
;
1530 setup_traverse_info(&info
, prefix
);
1531 info
.fn
= unpack_callback
;
1533 info
.show_all_errors
= o
->show_all_errors
;
1534 info
.pathspec
= o
->pathspec
;
1538 * Unpack existing index entries that sort before the
1539 * prefix the tree is spliced into. Note that o->merge
1540 * is always true in this case.
1543 struct cache_entry
*ce
= next_cache_entry(o
);
1546 if (ce_in_traverse_path(ce
, &info
))
1548 if (unpack_index_entry(ce
, o
) < 0)
1553 trace_performance_enter();
1554 ret
= traverse_trees(o
->src_index
, len
, t
, &info
);
1555 trace_performance_leave("traverse_trees");
1560 /* Any left-over entries in the index? */
1563 struct cache_entry
*ce
= next_cache_entry(o
);
1566 if (unpack_index_entry(ce
, o
) < 0)
1570 mark_all_ce_unused(o
->src_index
);
1572 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
1573 ret
= unpack_failed(o
, "Merge requires file-level merging");
1577 if (!o
->skip_sparse_checkout
) {
1578 int empty_worktree
= 1;
1581 * Sparse checkout loop #2: set NEW_SKIP_WORKTREE on entries not in loop #1
1582 * If the will have NEW_SKIP_WORKTREE, also set CE_SKIP_WORKTREE
1583 * so apply_sparse_checkout() won't attempt to remove it from worktree
1585 mark_new_skip_worktree(o
->pl
, &o
->result
, CE_ADDED
, CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
1588 for (i
= 0; i
< o
->result
.cache_nr
; i
++) {
1589 struct cache_entry
*ce
= o
->result
.cache
[i
];
1592 * Entries marked with CE_ADDED in merged_entry() do not have
1593 * verify_absent() check (the check is effectively disabled
1594 * because CE_NEW_SKIP_WORKTREE is set unconditionally).
1596 * Do the real check now because we have had
1597 * correct CE_NEW_SKIP_WORKTREE
1599 if (ce
->ce_flags
& CE_ADDED
&&
1600 verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
1601 if (!o
->show_all_errors
)
1606 if (apply_sparse_checkout(&o
->result
, ce
, o
)) {
1607 if (!o
->show_all_errors
)
1611 if (!ce_skip_worktree(ce
))
1618 * Sparse checkout is meant to narrow down checkout area
1619 * but it does not make sense to narrow down to empty working
1620 * tree. This is usually a mistake in sparse checkout rules.
1621 * Do not allow users to do that.
1623 if (o
->result
.cache_nr
&& empty_worktree
) {
1624 ret
= unpack_failed(o
, "Sparse checkout leaves no entry on working directory");
1629 ret
= check_updates(o
) ? (-2) : 0;
1631 move_index_extensions(&o
->result
, o
->src_index
);
1633 if (git_env_bool("GIT_TEST_CHECK_CACHE_TREE", 0))
1634 cache_tree_verify(the_repository
, &o
->result
);
1635 if (!o
->result
.cache_tree
)
1636 o
->result
.cache_tree
= cache_tree();
1637 if (!cache_tree_fully_valid(o
->result
.cache_tree
))
1638 cache_tree_update(&o
->result
,
1643 o
->result
.updated_workdir
= 1;
1644 discard_index(o
->dst_index
);
1645 *o
->dst_index
= o
->result
;
1647 discard_index(&o
->result
);
1649 o
->src_index
= NULL
;
1652 trace_performance_leave("unpack_trees");
1653 clear_pattern_list(&pl
);
1657 if (o
->show_all_errors
)
1658 display_error_msgs(o
);
1659 mark_all_ce_unused(o
->src_index
);
1660 ret
= unpack_failed(o
, NULL
);
1661 if (o
->exiting_early
)
1666 /* Here come the merge functions */
1668 static int reject_merge(const struct cache_entry
*ce
,
1669 struct unpack_trees_options
*o
)
1671 return add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
1674 static int same(const struct cache_entry
*a
, const struct cache_entry
*b
)
1680 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
1682 return a
->ce_mode
== b
->ce_mode
&&
1683 oideq(&a
->oid
, &b
->oid
);
1688 * When a CE gets turned into an unmerged entry, we
1689 * want it to be up-to-date
1691 static int verify_uptodate_1(const struct cache_entry
*ce
,
1692 struct unpack_trees_options
*o
,
1693 enum unpack_trees_error_types error_type
)
1701 * CE_VALID and CE_SKIP_WORKTREE cheat, we better check again
1702 * if this entry is truly up-to-date because this file may be
1705 if ((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
))
1706 ; /* keep checking */
1707 else if (o
->reset
|| ce_uptodate(ce
))
1710 if (!lstat(ce
->name
, &st
)) {
1711 int flags
= CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
;
1712 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, flags
);
1714 if (submodule_from_ce(ce
)) {
1715 int r
= check_submodule_move_head(ce
,
1716 "HEAD", oid_to_hex(&ce
->oid
), o
);
1718 return add_rejected_path(o
, error_type
, ce
->name
);
1725 * Historic default policy was to allow submodule to be out
1726 * of sync wrt the superproject index. If the submodule was
1727 * not considered interesting above, we don't care here.
1729 if (S_ISGITLINK(ce
->ce_mode
))
1734 if (errno
== ENOENT
)
1736 return add_rejected_path(o
, error_type
, ce
->name
);
1739 int verify_uptodate(const struct cache_entry
*ce
,
1740 struct unpack_trees_options
*o
)
1742 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1744 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
1747 static int verify_uptodate_sparse(const struct cache_entry
*ce
,
1748 struct unpack_trees_options
*o
)
1750 return verify_uptodate_1(ce
, o
, ERROR_SPARSE_NOT_UPTODATE_FILE
);
1754 * TODO: We should actually invalidate o->result, not src_index [1].
1755 * But since cache tree and untracked cache both are not copied to
1756 * o->result until unpacking is complete, we invalidate them on
1757 * src_index instead with the assumption that they will be copied to
1758 * dst_index at the end.
1760 * [1] src_index->cache_tree is also used in unpack_callback() so if
1761 * we invalidate o->result, we need to update it to use
1762 * o->result.cache_tree as well.
1764 static void invalidate_ce_path(const struct cache_entry
*ce
,
1765 struct unpack_trees_options
*o
)
1769 cache_tree_invalidate_path(o
->src_index
, ce
->name
);
1770 untracked_cache_invalidate_path(o
->src_index
, ce
->name
, 1);
1774 * Check that checking out ce->sha1 in subdir ce->name is not
1775 * going to overwrite any working files.
1777 * Currently, git does not checkout subprojects during a superproject
1778 * checkout, so it is not going to overwrite anything.
1780 static int verify_clean_submodule(const char *old_sha1
,
1781 const struct cache_entry
*ce
,
1782 struct unpack_trees_options
*o
)
1784 if (!submodule_from_ce(ce
))
1787 return check_submodule_move_head(ce
, old_sha1
,
1788 oid_to_hex(&ce
->oid
), o
);
1791 static int verify_clean_subdirectory(const struct cache_entry
*ce
,
1792 struct unpack_trees_options
*o
)
1795 * we are about to extract "ce->name"; we would not want to lose
1796 * anything in the existing directory there.
1800 struct dir_struct d
;
1804 if (S_ISGITLINK(ce
->ce_mode
)) {
1805 struct object_id oid
;
1806 int sub_head
= resolve_gitlink_ref(ce
->name
, "HEAD", &oid
);
1808 * If we are not going to update the submodule, then
1811 if (!sub_head
&& oideq(&oid
, &ce
->oid
))
1813 return verify_clean_submodule(sub_head
? NULL
: oid_to_hex(&oid
),
1818 * First let's make sure we do not have a local modification
1819 * in that directory.
1821 namelen
= ce_namelen(ce
);
1822 for (i
= locate_in_src_index(ce
, o
);
1823 i
< o
->src_index
->cache_nr
;
1825 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
1826 int len
= ce_namelen(ce2
);
1827 if (len
< namelen
||
1828 strncmp(ce
->name
, ce2
->name
, namelen
) ||
1829 ce2
->name
[namelen
] != '/')
1832 * ce2->name is an entry in the subdirectory to be
1835 if (!ce_stage(ce2
)) {
1836 if (verify_uptodate(ce2
, o
))
1838 add_entry(o
, ce2
, CE_REMOVE
, 0);
1839 invalidate_ce_path(ce
, o
);
1840 mark_ce_used(ce2
, o
);
1846 * Then we need to make sure that we do not lose a locally
1847 * present file that is not ignored.
1849 pathbuf
= xstrfmt("%.*s/", namelen
, ce
->name
);
1851 memset(&d
, 0, sizeof(d
));
1853 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
1854 i
= read_directory(&d
, o
->src_index
, pathbuf
, namelen
+1, NULL
);
1856 return add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
1862 * This gets called when there was no index entry for the tree entry 'dst',
1863 * but we found a file in the working tree that 'lstat()' said was fine,
1864 * and we're on a case-insensitive filesystem.
1866 * See if we can find a case-insensitive match in the index that also
1867 * matches the stat information, and assume it's that other file!
1869 static int icase_exists(struct unpack_trees_options
*o
, const char *name
, int len
, struct stat
*st
)
1871 const struct cache_entry
*src
;
1873 src
= index_file_exists(o
->src_index
, name
, len
, 1);
1874 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
1877 static int check_ok_to_remove(const char *name
, int len
, int dtype
,
1878 const struct cache_entry
*ce
, struct stat
*st
,
1879 enum unpack_trees_error_types error_type
,
1880 struct unpack_trees_options
*o
)
1882 const struct cache_entry
*result
;
1885 * It may be that the 'lstat()' succeeded even though
1886 * target 'ce' was absent, because there is an old
1887 * entry that is different only in case..
1889 * Ignore that lstat() if it matches.
1891 if (ignore_case
&& icase_exists(o
, name
, len
, st
))
1895 is_excluded(o
->dir
, o
->src_index
, name
, &dtype
))
1897 * ce->name is explicitly excluded, so it is Ok to
1901 if (S_ISDIR(st
->st_mode
)) {
1903 * We are checking out path "foo" and
1904 * found "foo/." in the working tree.
1905 * This is tricky -- if we have modified
1906 * files that are in "foo/" we would lose
1909 if (verify_clean_subdirectory(ce
, o
) < 0)
1915 * The previous round may already have decided to
1916 * delete this path, which is in a subdirectory that
1917 * is being replaced with a blob.
1919 result
= index_file_exists(&o
->result
, name
, len
, 0);
1921 if (result
->ce_flags
& CE_REMOVE
)
1925 return add_rejected_path(o
, error_type
, name
);
1929 * We do not want to remove or overwrite a working tree file that
1930 * is not tracked, unless it is ignored.
1932 static int verify_absent_1(const struct cache_entry
*ce
,
1933 enum unpack_trees_error_types error_type
,
1934 struct unpack_trees_options
*o
)
1939 if (o
->index_only
|| o
->reset
|| !o
->update
)
1942 len
= check_leading_path(ce
->name
, ce_namelen(ce
));
1949 path
= xmemdupz(ce
->name
, len
);
1950 if (lstat(path
, &st
))
1951 ret
= error_errno("cannot stat '%s'", path
);
1953 if (submodule_from_ce(ce
))
1954 ret
= check_submodule_move_head(ce
,
1955 oid_to_hex(&ce
->oid
),
1958 ret
= check_ok_to_remove(path
, len
, DT_UNKNOWN
, NULL
,
1959 &st
, error_type
, o
);
1963 } else if (lstat(ce
->name
, &st
)) {
1964 if (errno
!= ENOENT
)
1965 return error_errno("cannot stat '%s'", ce
->name
);
1968 if (submodule_from_ce(ce
))
1969 return check_submodule_move_head(ce
, oid_to_hex(&ce
->oid
),
1972 return check_ok_to_remove(ce
->name
, ce_namelen(ce
),
1973 ce_to_dtype(ce
), ce
, &st
,
1978 static int verify_absent(const struct cache_entry
*ce
,
1979 enum unpack_trees_error_types error_type
,
1980 struct unpack_trees_options
*o
)
1982 if (!o
->skip_sparse_checkout
&& (ce
->ce_flags
& CE_NEW_SKIP_WORKTREE
))
1984 return verify_absent_1(ce
, error_type
, o
);
1987 static int verify_absent_sparse(const struct cache_entry
*ce
,
1988 enum unpack_trees_error_types error_type
,
1989 struct unpack_trees_options
*o
)
1991 enum unpack_trees_error_types orphaned_error
= error_type
;
1992 if (orphaned_error
== ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
)
1993 orphaned_error
= ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
;
1995 return verify_absent_1(ce
, orphaned_error
, o
);
1998 static int merged_entry(const struct cache_entry
*ce
,
1999 const struct cache_entry
*old
,
2000 struct unpack_trees_options
*o
)
2002 int update
= CE_UPDATE
;
2003 struct cache_entry
*merge
= dup_cache_entry(ce
, &o
->result
);
2007 * New index entries. In sparse checkout, the following
2008 * verify_absent() will be delayed until after
2009 * traverse_trees() finishes in unpack_trees(), then:
2011 * - CE_NEW_SKIP_WORKTREE will be computed correctly
2012 * - verify_absent() be called again, this time with
2013 * correct CE_NEW_SKIP_WORKTREE
2015 * verify_absent() call here does nothing in sparse
2016 * checkout (i.e. o->skip_sparse_checkout == 0)
2019 merge
->ce_flags
|= CE_NEW_SKIP_WORKTREE
;
2021 if (verify_absent(merge
,
2022 ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
)) {
2023 discard_cache_entry(merge
);
2026 invalidate_ce_path(merge
, o
);
2028 if (submodule_from_ce(ce
)) {
2029 int ret
= check_submodule_move_head(ce
, NULL
,
2030 oid_to_hex(&ce
->oid
),
2036 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
2038 * See if we can re-use the old CE directly?
2039 * That way we get the uptodate stat info.
2041 * This also removes the UPDATE flag on a match; otherwise
2042 * we will end up overwriting local changes in the work tree.
2044 if (same(old
, merge
)) {
2045 copy_cache_entry(merge
, old
);
2048 if (verify_uptodate(old
, o
)) {
2049 discard_cache_entry(merge
);
2052 /* Migrate old flags over */
2053 update
|= old
->ce_flags
& (CE_SKIP_WORKTREE
| CE_NEW_SKIP_WORKTREE
);
2054 invalidate_ce_path(old
, o
);
2057 if (submodule_from_ce(ce
)) {
2058 int ret
= check_submodule_move_head(ce
, oid_to_hex(&old
->oid
),
2059 oid_to_hex(&ce
->oid
),
2066 * Previously unmerged entry left as an existence
2067 * marker by read_index_unmerged();
2069 invalidate_ce_path(old
, o
);
2072 do_add_entry(o
, merge
, update
, CE_STAGEMASK
);
2076 static int deleted_entry(const struct cache_entry
*ce
,
2077 const struct cache_entry
*old
,
2078 struct unpack_trees_options
*o
)
2080 /* Did it exist in the index? */
2082 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2086 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
2088 add_entry(o
, ce
, CE_REMOVE
, 0);
2089 invalidate_ce_path(ce
, o
);
2093 static int keep_entry(const struct cache_entry
*ce
,
2094 struct unpack_trees_options
*o
)
2096 add_entry(o
, ce
, 0, 0);
2098 invalidate_ce_path(ce
, o
);
2103 static void show_stage_entry(FILE *o
,
2104 const char *label
, const struct cache_entry
*ce
)
2107 fprintf(o
, "%s (missing)\n", label
);
2109 fprintf(o
, "%s%06o %s %d\t%s\n",
2112 oid_to_hex(&ce
->oid
),
2118 int threeway_merge(const struct cache_entry
* const *stages
,
2119 struct unpack_trees_options
*o
)
2121 const struct cache_entry
*index
;
2122 const struct cache_entry
*head
;
2123 const struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
2126 int remote_match
= 0;
2128 int df_conflict_head
= 0;
2129 int df_conflict_remote
= 0;
2131 int any_anc_missing
= 0;
2132 int no_anc_exists
= 1;
2135 for (i
= 1; i
< o
->head_idx
; i
++) {
2136 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
2137 any_anc_missing
= 1;
2143 head
= stages
[o
->head_idx
];
2145 if (head
== o
->df_conflict_entry
) {
2146 df_conflict_head
= 1;
2150 if (remote
== o
->df_conflict_entry
) {
2151 df_conflict_remote
= 1;
2156 * First, if there's a #16 situation, note that to prevent #13
2159 if (!same(remote
, head
)) {
2160 for (i
= 1; i
< o
->head_idx
; i
++) {
2161 if (same(stages
[i
], head
)) {
2164 if (same(stages
[i
], remote
)) {
2171 * We start with cases where the index is allowed to match
2172 * something other than the head: #14(ALT) and #2ALT, where it
2173 * is permitted to match the result instead.
2175 /* #14, #14ALT, #2ALT */
2176 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
2177 if (index
&& !same(index
, remote
) && !same(index
, head
))
2178 return reject_merge(index
, o
);
2179 return merged_entry(remote
, index
, o
);
2182 * If we have an entry in the index cache, then we want to
2183 * make sure that it matches head.
2185 if (index
&& !same(index
, head
))
2186 return reject_merge(index
, o
);
2190 if (same(head
, remote
))
2191 return merged_entry(head
, index
, o
);
2193 if (!df_conflict_remote
&& remote_match
&& !head_match
)
2194 return merged_entry(head
, index
, o
);
2198 if (!head
&& !remote
&& any_anc_missing
)
2202 * Under the "aggressive" rule, we resolve mostly trivial
2203 * cases that we historically had git-merge-one-file resolve.
2205 if (o
->aggressive
) {
2206 int head_deleted
= !head
;
2207 int remote_deleted
= !remote
;
2208 const struct cache_entry
*ce
= NULL
;
2217 for (i
= 1; i
< o
->head_idx
; i
++) {
2218 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2227 * Deleted in one and unchanged in the other.
2229 if ((head_deleted
&& remote_deleted
) ||
2230 (head_deleted
&& remote
&& remote_match
) ||
2231 (remote_deleted
&& head
&& head_match
)) {
2233 return deleted_entry(index
, index
, o
);
2234 if (ce
&& !head_deleted
) {
2235 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
2241 * Added in both, identically.
2243 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
2244 return merged_entry(head
, index
, o
);
2248 /* Below are "no merge" cases, which require that the index be
2249 * up-to-date to avoid the files getting overwritten with
2250 * conflict resolution files.
2253 if (verify_uptodate(index
, o
))
2257 o
->nontrivial_merge
= 1;
2259 /* #2, #3, #4, #6, #7, #9, #10, #11. */
2261 if (!head_match
|| !remote_match
) {
2262 for (i
= 1; i
< o
->head_idx
; i
++) {
2263 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
2264 keep_entry(stages
[i
], o
);
2272 fprintf(stderr
, "read-tree: warning #16 detected\n");
2273 show_stage_entry(stderr
, "head ", stages
[head_match
]);
2274 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
2277 if (head
) { count
+= keep_entry(head
, o
); }
2278 if (remote
) { count
+= keep_entry(remote
, o
); }
2285 * The rule is to "carry forward" what is in the index without losing
2286 * information across a "fast-forward", favoring a successful merge
2287 * over a merge failure when it makes sense. For details of the
2288 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
2291 int twoway_merge(const struct cache_entry
* const *src
,
2292 struct unpack_trees_options
*o
)
2294 const struct cache_entry
*current
= src
[0];
2295 const struct cache_entry
*oldtree
= src
[1];
2296 const struct cache_entry
*newtree
= src
[2];
2298 if (o
->merge_size
!= 2)
2299 return error("Cannot do a twoway merge of %d trees",
2302 if (oldtree
== o
->df_conflict_entry
)
2304 if (newtree
== o
->df_conflict_entry
)
2308 if (current
->ce_flags
& CE_CONFLICTED
) {
2309 if (same(oldtree
, newtree
) || o
->reset
) {
2311 return deleted_entry(current
, current
, o
);
2313 return merged_entry(newtree
, current
, o
);
2315 return reject_merge(current
, o
);
2316 } else if ((!oldtree
&& !newtree
) || /* 4 and 5 */
2317 (!oldtree
&& newtree
&&
2318 same(current
, newtree
)) || /* 6 and 7 */
2319 (oldtree
&& newtree
&&
2320 same(oldtree
, newtree
)) || /* 14 and 15 */
2321 (oldtree
&& newtree
&&
2322 !same(oldtree
, newtree
) && /* 18 and 19 */
2323 same(current
, newtree
))) {
2324 return keep_entry(current
, o
);
2325 } else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
2327 return deleted_entry(oldtree
, current
, o
);
2328 } else if (oldtree
&& newtree
&&
2329 same(current
, oldtree
) && !same(current
, newtree
)) {
2331 return merged_entry(newtree
, current
, o
);
2333 return reject_merge(current
, o
);
2336 if (oldtree
&& !o
->initial_checkout
) {
2338 * deletion of the path was staged;
2340 if (same(oldtree
, newtree
))
2342 return reject_merge(oldtree
, o
);
2344 return merged_entry(newtree
, current
, o
);
2346 return deleted_entry(oldtree
, current
, o
);
2352 * Keep the index entries at stage0, collapse stage1 but make sure
2353 * stage0 does not have anything there.
2355 int bind_merge(const struct cache_entry
* const *src
,
2356 struct unpack_trees_options
*o
)
2358 const struct cache_entry
*old
= src
[0];
2359 const struct cache_entry
*a
= src
[1];
2361 if (o
->merge_size
!= 1)
2362 return error("Cannot do a bind merge of %d trees",
2365 return o
->quiet
? -1 :
2366 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
),
2367 super_prefixed(a
->name
),
2368 super_prefixed(old
->name
));
2370 return keep_entry(old
, o
);
2372 return merged_entry(a
, NULL
, o
);
2379 * - take the stat information from stage0, take the data from stage1
2381 int oneway_merge(const struct cache_entry
* const *src
,
2382 struct unpack_trees_options
*o
)
2384 const struct cache_entry
*old
= src
[0];
2385 const struct cache_entry
*a
= src
[1];
2387 if (o
->merge_size
!= 1)
2388 return error("Cannot do a oneway merge of %d trees",
2391 if (!a
|| a
== o
->df_conflict_entry
)
2392 return deleted_entry(old
, old
, o
);
2394 if (old
&& same(old
, a
)) {
2396 if (o
->reset
&& o
->update
&& !ce_uptodate(old
) && !ce_skip_worktree(old
)) {
2398 if (lstat(old
->name
, &st
) ||
2399 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
2400 update
|= CE_UPDATE
;
2402 if (o
->update
&& S_ISGITLINK(old
->ce_mode
) &&
2403 should_update_submodules() && !verify_uptodate(old
, o
))
2404 update
|= CE_UPDATE
;
2405 add_entry(o
, old
, update
, CE_STAGEMASK
);
2408 return merged_entry(a
, old
, o
);