1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
6 #include "cache-tree.h"
7 #include "unpack-trees.h"
13 * Error messages expected by scripts out of plumbing commands such as
14 * read-tree. Non-scripted Porcelain is not required to use these messages
15 * and in fact are encouraged to reword them to better suit their particular
16 * situation better. See how "git checkout" and "git merge" replaces
17 * them using setup_unpack_trees_porcelain(), for example.
19 const char *unpack_plumbing_errors
[NB_UNPACK_TREES_ERROR_TYPES
] = {
20 /* ERROR_WOULD_OVERWRITE */
21 "Entry '%s' would be overwritten by merge. Cannot merge.",
23 /* ERROR_NOT_UPTODATE_FILE */
24 "Entry '%s' not uptodate. Cannot merge.",
26 /* ERROR_NOT_UPTODATE_DIR */
27 "Updating '%s' would lose untracked files in it",
29 /* ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN */
30 "Untracked working tree file '%s' would be overwritten by merge.",
32 /* ERROR_WOULD_LOSE_UNTRACKED_REMOVED */
33 "Untracked working tree file '%s' would be removed by merge.",
35 /* ERROR_BIND_OVERLAP */
36 "Entry '%s' overlaps with '%s'. Cannot bind.",
38 /* ERROR_SPARSE_NOT_UPTODATE_FILE */
39 "Entry '%s' not uptodate. Cannot update sparse checkout.",
41 /* ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN */
42 "Working tree file '%s' would be overwritten by sparse checkout update.",
44 /* ERROR_WOULD_LOSE_ORPHANED_REMOVED */
45 "Working tree file '%s' would be removed by sparse checkout update.",
48 #define ERRORMSG(o,type) \
49 ( ((o) && (o)->msgs[(type)]) \
50 ? ((o)->msgs[(type)]) \
51 : (unpack_plumbing_errors[(type)]) )
53 void setup_unpack_trees_porcelain(struct unpack_trees_options
*opts
,
56 const char **msgs
= opts
->msgs
;
59 const char *cmd2
= strcmp(cmd
, "checkout") ? cmd
: "switch branches";
60 if (advice_commit_before_merge
)
61 msg
= "Your local changes to the following files would be overwritten by %s:\n%%s"
62 "Please, commit your changes or stash them before you can %s.";
64 msg
= "Your local changes to the following files would be overwritten by %s:\n%%s";
65 tmp
= xmalloc(strlen(msg
) + strlen(cmd
) + strlen(cmd2
) - 2);
66 sprintf(tmp
, msg
, cmd
, cmd2
);
67 msgs
[ERROR_WOULD_OVERWRITE
] = tmp
;
68 msgs
[ERROR_NOT_UPTODATE_FILE
] = tmp
;
70 msgs
[ERROR_NOT_UPTODATE_DIR
] =
71 "Updating the following directories would lose untracked files in it:\n%s";
73 if (advice_commit_before_merge
)
74 msg
= "The following untracked working tree files would be %s by %s:\n%%s"
75 "Please move or remove them before you can %s.";
77 msg
= "The following untracked working tree files would be %s by %s:\n%%s";
78 tmp
= xmalloc(strlen(msg
) + strlen(cmd
) + strlen("removed") + strlen(cmd2
) - 4);
79 sprintf(tmp
, msg
, "removed", cmd
, cmd2
);
80 msgs
[ERROR_WOULD_LOSE_UNTRACKED_REMOVED
] = tmp
;
81 tmp
= xmalloc(strlen(msg
) + strlen(cmd
) + strlen("overwritten") + strlen(cmd2
) - 4);
82 sprintf(tmp
, msg
, "overwritten", cmd
, cmd2
);
83 msgs
[ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
] = tmp
;
86 * Special case: ERROR_BIND_OVERLAP refers to a pair of paths, we
87 * cannot easily display it as a list.
89 msgs
[ERROR_BIND_OVERLAP
] = "Entry '%s' overlaps with '%s'. Cannot bind.";
91 msgs
[ERROR_SPARSE_NOT_UPTODATE_FILE
] =
92 "Cannot update sparse checkout: the following entries are not up-to-date:\n%s";
93 msgs
[ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
] =
94 "The following Working tree files would be overwritten by sparse checkout update:\n%s";
95 msgs
[ERROR_WOULD_LOSE_ORPHANED_REMOVED
] =
96 "The following Working tree files would be removed by sparse checkout update:\n%s";
98 opts
->show_all_errors
= 1;
101 static void add_entry(struct unpack_trees_options
*o
, struct cache_entry
*ce
,
102 unsigned int set
, unsigned int clear
)
104 unsigned int size
= ce_size(ce
);
105 struct cache_entry
*new = xmalloc(size
);
107 clear
|= CE_HASHED
| CE_UNHASHED
;
109 memcpy(new, ce
, size
);
111 new->ce_flags
= (new->ce_flags
& ~clear
) | set
;
112 add_index_entry(&o
->result
, new, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
116 * add error messages on path <path>
117 * corresponding to the type <e> with the message <msg>
118 * indicating if it should be display in porcelain or not
120 static int add_rejected_path(struct unpack_trees_options
*o
,
121 enum unpack_trees_error_types e
,
124 struct rejected_paths_list
*newentry
;
125 if (!o
->show_all_errors
)
126 return error(ERRORMSG(o
, e
), path
);
129 * Otherwise, insert in a list for future display by
130 * display_error_msgs()
132 newentry
= xmalloc(sizeof(struct rejected_paths_list
));
133 newentry
->path
= (char *)path
;
134 newentry
->next
= o
->unpack_rejects
[e
];
135 o
->unpack_rejects
[e
] = newentry
;
140 * free all the structures allocated for the error <e>
142 static void free_rejected_paths(struct unpack_trees_options
*o
,
143 enum unpack_trees_error_types e
)
145 while (o
->unpack_rejects
[e
]) {
146 struct rejected_paths_list
*del
= o
->unpack_rejects
[e
];
147 o
->unpack_rejects
[e
] = o
->unpack_rejects
[e
]->next
;
150 free(o
->unpack_rejects
[e
]);
154 * display all the error messages stored in a nice way
156 static void display_error_msgs(struct unpack_trees_options
*o
)
159 int something_displayed
= 0;
160 for (e
= 0; e
< NB_UNPACK_TREES_ERROR_TYPES
; e
++) {
161 if (o
->unpack_rejects
[e
]) {
162 struct rejected_paths_list
*rp
;
163 struct strbuf path
= STRBUF_INIT
;
164 something_displayed
= 1;
165 for (rp
= o
->unpack_rejects
[e
]; rp
; rp
= rp
->next
)
166 strbuf_addf(&path
, "\t%s\n", rp
->path
);
167 error(ERRORMSG(o
, e
), path
.buf
);
168 strbuf_release(&path
);
169 free_rejected_paths(o
, e
);
172 if (something_displayed
)
173 printf("Aborting\n");
177 * Unlink the last component and schedule the leading directories for
178 * removal, such that empty directories get removed.
180 static void unlink_entry(struct cache_entry
*ce
)
182 if (has_symlink_or_noent_leading_path(ce
->name
, ce_namelen(ce
)))
184 if (remove_or_warn(ce
->ce_mode
, ce
->name
))
186 schedule_dir_for_removal(ce
->name
, ce_namelen(ce
));
189 static struct checkout state
;
190 static int check_updates(struct unpack_trees_options
*o
)
192 unsigned cnt
= 0, total
= 0;
193 struct progress
*progress
= NULL
;
194 struct index_state
*index
= &o
->result
;
198 if (o
->update
&& o
->verbose_update
) {
199 for (total
= cnt
= 0; cnt
< index
->cache_nr
; cnt
++) {
200 struct cache_entry
*ce
= index
->cache
[cnt
];
201 if (ce
->ce_flags
& (CE_UPDATE
| CE_REMOVE
| CE_WT_REMOVE
))
205 progress
= start_progress_delay("Checking out files",
211 git_attr_set_direction(GIT_ATTR_CHECKOUT
, &o
->result
);
212 for (i
= 0; i
< index
->cache_nr
; i
++) {
213 struct cache_entry
*ce
= index
->cache
[i
];
215 if (ce
->ce_flags
& CE_WT_REMOVE
) {
216 display_progress(progress
, ++cnt
);
222 if (ce
->ce_flags
& CE_REMOVE
) {
223 display_progress(progress
, ++cnt
);
228 remove_marked_cache_entries(&o
->result
);
229 remove_scheduled_dirs();
231 for (i
= 0; i
< index
->cache_nr
; i
++) {
232 struct cache_entry
*ce
= index
->cache
[i
];
234 if (ce
->ce_flags
& CE_UPDATE
) {
235 display_progress(progress
, ++cnt
);
236 ce
->ce_flags
&= ~CE_UPDATE
;
238 errs
|= checkout_entry(ce
, &state
, NULL
);
242 stop_progress(&progress
);
244 git_attr_set_direction(GIT_ATTR_CHECKIN
, NULL
);
248 static int verify_uptodate_sparse(struct cache_entry
*ce
, struct unpack_trees_options
*o
);
249 static int verify_absent_sparse(struct cache_entry
*ce
, enum unpack_trees_error_types
, struct unpack_trees_options
*o
);
251 static int will_have_skip_worktree(const struct cache_entry
*ce
, struct unpack_trees_options
*o
)
253 const char *basename
;
258 basename
= strrchr(ce
->name
, '/');
259 basename
= basename
? basename
+1 : ce
->name
;
260 return excluded_from_list(ce
->name
, ce_namelen(ce
), basename
, NULL
, o
->el
) <= 0;
263 static int apply_sparse_checkout(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
265 int was_skip_worktree
= ce_skip_worktree(ce
);
267 if (will_have_skip_worktree(ce
, o
))
268 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
270 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
273 * We only care about files getting into the checkout area
274 * If merge strategies want to remove some, go ahead, this
275 * flag will be removed eventually in unpack_trees() if it's
276 * outside checkout area.
278 if (ce
->ce_flags
& CE_REMOVE
)
281 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
283 * If CE_UPDATE is set, verify_uptodate() must be called already
284 * also stat info may have lost after merged_entry() so calling
285 * verify_uptodate() again may fail
287 if (!(ce
->ce_flags
& CE_UPDATE
) && verify_uptodate_sparse(ce
, o
))
289 ce
->ce_flags
|= CE_WT_REMOVE
;
291 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
292 if (verify_absent_sparse(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
294 ce
->ce_flags
|= CE_UPDATE
;
299 static inline int call_unpack_fn(struct cache_entry
**src
, struct unpack_trees_options
*o
)
301 int ret
= o
->fn(src
, o
);
307 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
309 ce
->ce_flags
|= CE_UNPACKED
;
311 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
312 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
313 int bottom
= o
->cache_bottom
;
314 while (bottom
< o
->src_index
->cache_nr
&&
315 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
317 o
->cache_bottom
= bottom
;
321 static void mark_all_ce_unused(struct index_state
*index
)
324 for (i
= 0; i
< index
->cache_nr
; i
++)
325 index
->cache
[i
]->ce_flags
&= ~CE_UNPACKED
;
328 static int locate_in_src_index(struct cache_entry
*ce
,
329 struct unpack_trees_options
*o
)
331 struct index_state
*index
= o
->src_index
;
332 int len
= ce_namelen(ce
);
333 int pos
= index_name_pos(index
, ce
->name
, len
);
340 * We call unpack_index_entry() with an unmerged cache entry
341 * only in diff-index, and it wants a single callback. Skip
342 * the other unmerged entry with the same name.
344 static void mark_ce_used_same_name(struct cache_entry
*ce
,
345 struct unpack_trees_options
*o
)
347 struct index_state
*index
= o
->src_index
;
348 int len
= ce_namelen(ce
);
351 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
352 struct cache_entry
*next
= index
->cache
[pos
];
353 if (len
!= ce_namelen(next
) ||
354 memcmp(ce
->name
, next
->name
, len
))
356 mark_ce_used(next
, o
);
360 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
362 const struct index_state
*index
= o
->src_index
;
363 int pos
= o
->cache_bottom
;
365 while (pos
< index
->cache_nr
) {
366 struct cache_entry
*ce
= index
->cache
[pos
];
367 if (!(ce
->ce_flags
& CE_UNPACKED
))
374 static void add_same_unmerged(struct cache_entry
*ce
,
375 struct unpack_trees_options
*o
)
377 struct index_state
*index
= o
->src_index
;
378 int len
= ce_namelen(ce
);
379 int pos
= index_name_pos(index
, ce
->name
, len
);
382 die("programming error in a caller of mark_ce_used_same_name");
383 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
384 struct cache_entry
*next
= index
->cache
[pos
];
385 if (len
!= ce_namelen(next
) ||
386 memcmp(ce
->name
, next
->name
, len
))
388 add_entry(o
, next
, 0, 0);
389 mark_ce_used(next
, o
);
393 static int unpack_index_entry(struct cache_entry
*ce
,
394 struct unpack_trees_options
*o
)
396 struct cache_entry
*src
[5] = { NULL
};
403 if (o
->skip_unmerged
) {
404 add_entry(o
, ce
, 0, 0);
408 ret
= call_unpack_fn(src
, o
);
410 mark_ce_used_same_name(ce
, o
);
414 static int find_cache_pos(struct traverse_info
*, const struct name_entry
*);
416 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
418 struct unpack_trees_options
*o
= info
->data
;
420 if (o
->diff_index_cached
)
422 o
->cache_bottom
= bottom
;
425 static int switch_cache_bottom(struct traverse_info
*info
)
427 struct unpack_trees_options
*o
= info
->data
;
430 if (o
->diff_index_cached
)
432 ret
= o
->cache_bottom
;
433 pos
= find_cache_pos(info
->prev
, &info
->name
);
436 o
->cache_bottom
= -2 - pos
;
438 o
->cache_bottom
= o
->src_index
->cache_nr
;
442 static int traverse_trees_recursive(int n
, unsigned long dirmask
, unsigned long df_conflicts
, struct name_entry
*names
, struct traverse_info
*info
)
445 struct tree_desc t
[MAX_UNPACK_TREES
];
446 struct traverse_info newinfo
;
447 struct name_entry
*p
;
456 newinfo
.pathlen
+= tree_entry_len(p
->path
, p
->sha1
) + 1;
457 newinfo
.conflicts
|= df_conflicts
;
459 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
460 const unsigned char *sha1
= NULL
;
462 sha1
= names
[i
].sha1
;
463 fill_tree_descriptor(t
+i
, sha1
);
466 bottom
= switch_cache_bottom(&newinfo
);
467 ret
= traverse_trees(n
, t
, &newinfo
);
468 restore_cache_bottom(&newinfo
, bottom
);
473 * Compare the traverse-path to the cache entry without actually
474 * having to generate the textual representation of the traverse
477 * NOTE! This *only* compares up to the size of the traverse path
478 * itself - the caller needs to do the final check for the cache
479 * entry having more data at the end!
481 static int do_compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
483 int len
, pathlen
, ce_len
;
487 int cmp
= do_compare_entry(ce
, info
->prev
, &info
->name
);
491 pathlen
= info
->pathlen
;
492 ce_len
= ce_namelen(ce
);
494 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
495 if (ce_len
< pathlen
)
499 ce_name
= ce
->name
+ pathlen
;
501 len
= tree_entry_len(n
->path
, n
->sha1
);
502 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
505 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
507 int cmp
= do_compare_entry(ce
, info
, n
);
512 * Even if the beginning compared identically, the ce should
513 * compare as bigger than a directory leading up to it!
515 return ce_namelen(ce
) > traverse_path_len(info
, n
);
518 static int ce_in_traverse_path(const struct cache_entry
*ce
,
519 const struct traverse_info
*info
)
523 if (do_compare_entry(ce
, info
->prev
, &info
->name
))
526 * If ce (blob) is the same name as the path (which is a tree
527 * we will be descending into), it won't be inside it.
529 return (info
->pathlen
< ce_namelen(ce
));
532 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
, const struct name_entry
*n
, int stage
)
534 int len
= traverse_path_len(info
, n
);
535 struct cache_entry
*ce
= xcalloc(1, cache_entry_size(len
));
537 ce
->ce_mode
= create_ce_mode(n
->mode
);
538 ce
->ce_flags
= create_ce_flags(len
, stage
);
539 hashcpy(ce
->sha1
, n
->sha1
);
540 make_traverse_path(ce
->name
, info
, n
);
545 static int unpack_nondirectories(int n
, unsigned long mask
,
546 unsigned long dirmask
,
547 struct cache_entry
**src
,
548 const struct name_entry
*names
,
549 const struct traverse_info
*info
)
552 struct unpack_trees_options
*o
= info
->data
;
553 unsigned long conflicts
;
555 /* Do we have *only* directories? Nothing to do */
556 if (mask
== dirmask
&& !src
[0])
559 conflicts
= info
->conflicts
;
562 conflicts
|= dirmask
;
565 * Ok, we've filled in up to any potential index entry in src[0],
568 for (i
= 0; i
< n
; i
++) {
570 unsigned int bit
= 1ul << i
;
571 if (conflicts
& bit
) {
572 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
579 else if (i
+ 1 < o
->head_idx
)
581 else if (i
+ 1 > o
->head_idx
)
585 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
);
589 return call_unpack_fn(src
, o
);
591 for (i
= 0; i
< n
; i
++)
592 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
593 add_entry(o
, src
[i
], 0, 0);
597 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
599 discard_index(&o
->result
);
602 return error("%s", message
);
608 /* NEEDSWORK: give this a better name and share with tree-walk.c */
609 static int name_compare(const char *a
, int a_len
,
610 const char *b
, int b_len
)
612 int len
= (a_len
< b_len
) ? a_len
: b_len
;
613 int cmp
= memcmp(a
, b
, len
);
616 return (a_len
- b_len
);
620 * The tree traversal is looking at name p. If we have a matching entry,
621 * return it. If name p is a directory in the index, do not return
622 * anything, as we will want to match it when the traversal descends into
625 static int find_cache_pos(struct traverse_info
*info
,
626 const struct name_entry
*p
)
629 struct unpack_trees_options
*o
= info
->data
;
630 struct index_state
*index
= o
->src_index
;
631 int pfxlen
= info
->pathlen
;
632 int p_len
= tree_entry_len(p
->path
, p
->sha1
);
634 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
635 struct cache_entry
*ce
= index
->cache
[pos
];
636 const char *ce_name
, *ce_slash
;
639 if (ce
->ce_flags
& CE_UNPACKED
) {
641 * cache_bottom entry is already unpacked, so
642 * we can never match it; don't check it
645 if (pos
== o
->cache_bottom
)
649 if (!ce_in_traverse_path(ce
, info
))
651 ce_name
= ce
->name
+ pfxlen
;
652 ce_slash
= strchr(ce_name
, '/');
654 ce_len
= ce_slash
- ce_name
;
656 ce_len
= ce_namelen(ce
) - pfxlen
;
657 cmp
= name_compare(p
->path
, p_len
, ce_name
, ce_len
);
659 * Exact match; if we have a directory we need to
660 * delay returning it.
663 return ce_slash
? -2 - pos
: pos
;
665 continue; /* keep looking */
667 * ce_name sorts after p->path; could it be that we
668 * have files under p->path directory in the index?
669 * E.g. ce_name == "t-i", and p->path == "t"; we may
670 * have "t/a" in the index.
672 if (p_len
< ce_len
&& !memcmp(ce_name
, p
->path
, p_len
) &&
673 ce_name
[p_len
] < '/')
674 continue; /* keep looking */
680 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
681 const struct name_entry
*p
)
683 int pos
= find_cache_pos(info
, p
);
684 struct unpack_trees_options
*o
= info
->data
;
687 return o
->src_index
->cache
[pos
];
692 static void debug_path(struct traverse_info
*info
)
695 debug_path(info
->prev
);
696 if (*info
->prev
->name
.path
)
699 printf("%s", info
->name
.path
);
702 static void debug_name_entry(int i
, struct name_entry
*n
)
704 printf("ent#%d %06o %s\n", i
,
705 n
->path
? n
->mode
: 0,
706 n
->path
? n
->path
: "(missing)");
709 static void debug_unpack_callback(int n
,
711 unsigned long dirmask
,
712 struct name_entry
*names
,
713 struct traverse_info
*info
)
716 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
720 for (i
= 0; i
< n
; i
++)
721 debug_name_entry(i
, names
+ i
);
724 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
726 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
727 struct unpack_trees_options
*o
= info
->data
;
728 const struct name_entry
*p
= names
;
730 /* Find first entry with a real name (we could use "mask" too) */
735 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
737 /* Are we supposed to look at the index too? */
741 struct cache_entry
*ce
;
743 if (o
->diff_index_cached
)
744 ce
= next_cache_entry(o
);
746 ce
= find_cache_entry(info
, p
);
750 cmp
= compare_entry(ce
, info
, p
);
752 if (unpack_index_entry(ce
, o
) < 0)
753 return unpack_failed(o
, NULL
);
759 * If we skip unmerged index
760 * entries, we'll skip this
761 * entry *and* the tree
762 * entries associated with it!
764 if (o
->skip_unmerged
) {
765 add_same_unmerged(ce
, o
);
775 if (unpack_nondirectories(n
, mask
, dirmask
, src
, names
, info
) < 0)
779 if (ce_stage(src
[0]))
780 mark_ce_used_same_name(src
[0], o
);
782 mark_ce_used(src
[0], o
);
785 /* Now handle any directories.. */
787 unsigned long conflicts
= mask
& ~dirmask
;
794 /* special case: "diff-index --cached" looking at a tree */
795 if (o
->diff_index_cached
&&
796 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
798 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
801 * Everything under the name matches; skip the
802 * entire hierarchy. diff_index_cached codepath
803 * special cases D/F conflicts in such a way that
804 * it does not do any look-ahead, so this is safe.
807 o
->cache_bottom
+= matches
;
812 if (traverse_trees_recursive(n
, dirmask
, conflicts
,
822 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
823 * resulting index, -2 on failure to reflect the changes to the work tree.
825 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
828 static struct cache_entry
*dfc
;
829 struct exclude_list el
;
831 if (len
> MAX_UNPACK_TREES
)
832 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
833 memset(&state
, 0, sizeof(state
));
837 state
.refresh_cache
= 1;
839 memset(&el
, 0, sizeof(el
));
840 if (!core_apply_sparse_checkout
|| !o
->update
)
841 o
->skip_sparse_checkout
= 1;
842 if (!o
->skip_sparse_checkout
) {
843 if (add_excludes_from_file_to_list(git_path("info/sparse-checkout"), "", 0, NULL
, &el
, 0) < 0)
844 o
->skip_sparse_checkout
= 1;
849 memset(&o
->result
, 0, sizeof(o
->result
));
850 o
->result
.initialized
= 1;
851 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
852 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
854 mark_all_ce_unused(o
->src_index
);
857 dfc
= xcalloc(1, cache_entry_size(0));
858 o
->df_conflict_entry
= dfc
;
861 const char *prefix
= o
->prefix
? o
->prefix
: "";
862 struct traverse_info info
;
864 setup_traverse_info(&info
, prefix
);
865 info
.fn
= unpack_callback
;
867 info
.show_all_errors
= o
->show_all_errors
;
871 * Unpack existing index entries that sort before the
872 * prefix the tree is spliced into. Note that o->merge
873 * is always true in this case.
876 struct cache_entry
*ce
= next_cache_entry(o
);
879 if (ce_in_traverse_path(ce
, &info
))
881 if (unpack_index_entry(ce
, o
) < 0)
886 if (traverse_trees(len
, t
, &info
) < 0)
890 /* Any left-over entries in the index? */
893 struct cache_entry
*ce
= next_cache_entry(o
);
896 if (unpack_index_entry(ce
, o
) < 0)
900 mark_all_ce_unused(o
->src_index
);
902 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
903 ret
= unpack_failed(o
, "Merge requires file-level merging");
907 if (!o
->skip_sparse_checkout
) {
908 int empty_worktree
= 1;
909 for (i
= 0;i
< o
->result
.cache_nr
;i
++) {
910 struct cache_entry
*ce
= o
->result
.cache
[i
];
912 if (apply_sparse_checkout(ce
, o
)) {
917 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
918 * area as a result of ce_skip_worktree() shortcuts in
919 * verify_absent() and verify_uptodate(). Clear them.
921 if (ce_skip_worktree(ce
))
922 ce
->ce_flags
&= ~(CE_UPDATE
| CE_REMOVE
);
927 if (o
->result
.cache_nr
&& empty_worktree
) {
928 ret
= unpack_failed(o
, "Sparse checkout leaves no entry on working directory");
934 ret
= check_updates(o
) ? (-2) : 0;
936 *o
->dst_index
= o
->result
;
939 for (i
= 0;i
< el
.nr
;i
++)
940 free(el
.excludes
[i
]);
947 if (o
->show_all_errors
)
948 display_error_msgs(o
);
949 mark_all_ce_unused(o
->src_index
);
950 ret
= unpack_failed(o
, NULL
);
954 /* Here come the merge functions */
956 static int reject_merge(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
958 return add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
961 static int same(struct cache_entry
*a
, struct cache_entry
*b
)
967 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
969 return a
->ce_mode
== b
->ce_mode
&&
970 !hashcmp(a
->sha1
, b
->sha1
);
975 * When a CE gets turned into an unmerged entry, we
976 * want it to be up-to-date
978 static int verify_uptodate_1(struct cache_entry
*ce
,
979 struct unpack_trees_options
*o
,
980 enum unpack_trees_error_types error_type
)
984 if (o
->index_only
|| (!((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
)) && (o
->reset
|| ce_uptodate(ce
))))
987 if (!lstat(ce
->name
, &st
)) {
988 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
992 * NEEDSWORK: the current default policy is to allow
993 * submodule to be out of sync wrt the supermodule
994 * index. This needs to be tightened later for
995 * submodules that are marked to be automatically
998 if (S_ISGITLINK(ce
->ce_mode
))
1002 if (errno
== ENOENT
)
1004 return o
->gently
? -1 :
1005 add_rejected_path(o
, error_type
, ce
->name
);
1008 static int verify_uptodate(struct cache_entry
*ce
,
1009 struct unpack_trees_options
*o
)
1011 if (!o
->skip_sparse_checkout
&& will_have_skip_worktree(ce
, o
))
1013 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
1016 static int verify_uptodate_sparse(struct cache_entry
*ce
,
1017 struct unpack_trees_options
*o
)
1019 return verify_uptodate_1(ce
, o
, ERROR_SPARSE_NOT_UPTODATE_FILE
);
1022 static void invalidate_ce_path(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
1025 cache_tree_invalidate_path(o
->src_index
->cache_tree
, ce
->name
);
1029 * Check that checking out ce->sha1 in subdir ce->name is not
1030 * going to overwrite any working files.
1032 * Currently, git does not checkout subprojects during a superproject
1033 * checkout, so it is not going to overwrite anything.
1035 static int verify_clean_submodule(struct cache_entry
*ce
,
1036 enum unpack_trees_error_types error_type
,
1037 struct unpack_trees_options
*o
)
1042 static int verify_clean_subdirectory(struct cache_entry
*ce
,
1043 enum unpack_trees_error_types error_type
,
1044 struct unpack_trees_options
*o
)
1047 * we are about to extract "ce->name"; we would not want to lose
1048 * anything in the existing directory there.
1052 struct dir_struct d
;
1055 unsigned char sha1
[20];
1057 if (S_ISGITLINK(ce
->ce_mode
) &&
1058 resolve_gitlink_ref(ce
->name
, "HEAD", sha1
) == 0) {
1059 /* If we are not going to update the submodule, then
1062 if (!hashcmp(sha1
, ce
->sha1
))
1064 return verify_clean_submodule(ce
, error_type
, o
);
1068 * First let's make sure we do not have a local modification
1069 * in that directory.
1071 namelen
= strlen(ce
->name
);
1072 for (i
= locate_in_src_index(ce
, o
);
1073 i
< o
->src_index
->cache_nr
;
1075 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
1076 int len
= ce_namelen(ce2
);
1077 if (len
< namelen
||
1078 strncmp(ce
->name
, ce2
->name
, namelen
) ||
1079 ce2
->name
[namelen
] != '/')
1082 * ce2->name is an entry in the subdirectory to be
1085 if (!ce_stage(ce2
)) {
1086 if (verify_uptodate(ce2
, o
))
1088 add_entry(o
, ce2
, CE_REMOVE
, 0);
1089 mark_ce_used(ce2
, o
);
1095 * Then we need to make sure that we do not lose a locally
1096 * present file that is not ignored.
1098 pathbuf
= xmalloc(namelen
+ 2);
1099 memcpy(pathbuf
, ce
->name
, namelen
);
1100 strcpy(pathbuf
+namelen
, "/");
1102 memset(&d
, 0, sizeof(d
));
1104 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
1105 i
= read_directory(&d
, pathbuf
, namelen
+1, NULL
);
1107 return o
->gently
? -1 :
1108 add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
1114 * This gets called when there was no index entry for the tree entry 'dst',
1115 * but we found a file in the working tree that 'lstat()' said was fine,
1116 * and we're on a case-insensitive filesystem.
1118 * See if we can find a case-insensitive match in the index that also
1119 * matches the stat information, and assume it's that other file!
1121 static int icase_exists(struct unpack_trees_options
*o
, struct cache_entry
*dst
, struct stat
*st
)
1123 struct cache_entry
*src
;
1125 src
= index_name_exists(o
->src_index
, dst
->name
, ce_namelen(dst
), 1);
1126 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
1130 * We do not want to remove or overwrite a working tree file that
1131 * is not tracked, unless it is ignored.
1133 static int verify_absent_1(struct cache_entry
*ce
,
1134 enum unpack_trees_error_types error_type
,
1135 struct unpack_trees_options
*o
)
1139 if (o
->index_only
|| o
->reset
|| !o
->update
)
1142 if (has_symlink_or_noent_leading_path(ce
->name
, ce_namelen(ce
)))
1145 if (!lstat(ce
->name
, &st
)) {
1146 int dtype
= ce_to_dtype(ce
);
1147 struct cache_entry
*result
;
1150 * It may be that the 'lstat()' succeeded even though
1151 * target 'ce' was absent, because there is an old
1152 * entry that is different only in case..
1154 * Ignore that lstat() if it matches.
1156 if (ignore_case
&& icase_exists(o
, ce
, &st
))
1159 if (o
->dir
&& excluded(o
->dir
, ce
->name
, &dtype
))
1161 * ce->name is explicitly excluded, so it is Ok to
1165 if (S_ISDIR(st
.st_mode
)) {
1167 * We are checking out path "foo" and
1168 * found "foo/." in the working tree.
1169 * This is tricky -- if we have modified
1170 * files that are in "foo/" we would lose
1173 if (verify_clean_subdirectory(ce
, error_type
, o
) < 0)
1179 * The previous round may already have decided to
1180 * delete this path, which is in a subdirectory that
1181 * is being replaced with a blob.
1183 result
= index_name_exists(&o
->result
, ce
->name
, ce_namelen(ce
), 0);
1185 if (result
->ce_flags
& CE_REMOVE
)
1189 return o
->gently
? -1 :
1190 add_rejected_path(o
, error_type
, ce
->name
);
1194 static int verify_absent(struct cache_entry
*ce
,
1195 enum unpack_trees_error_types error_type
,
1196 struct unpack_trees_options
*o
)
1198 if (!o
->skip_sparse_checkout
&& will_have_skip_worktree(ce
, o
))
1200 return verify_absent_1(ce
, error_type
, o
);
1203 static int verify_absent_sparse(struct cache_entry
*ce
,
1204 enum unpack_trees_error_types error_type
,
1205 struct unpack_trees_options
*o
)
1207 enum unpack_trees_error_types orphaned_error
= error_type
;
1208 if (orphaned_error
== ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
)
1209 orphaned_error
= ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
;
1211 return verify_absent_1(ce
, orphaned_error
, o
);
1214 static int merged_entry(struct cache_entry
*merge
, struct cache_entry
*old
,
1215 struct unpack_trees_options
*o
)
1217 int update
= CE_UPDATE
;
1220 if (verify_absent(merge
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
1222 invalidate_ce_path(merge
, o
);
1223 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
1225 * See if we can re-use the old CE directly?
1226 * That way we get the uptodate stat info.
1228 * This also removes the UPDATE flag on a match; otherwise
1229 * we will end up overwriting local changes in the work tree.
1231 if (same(old
, merge
)) {
1232 copy_cache_entry(merge
, old
);
1235 if (verify_uptodate(old
, o
))
1237 if (ce_skip_worktree(old
))
1238 update
|= CE_SKIP_WORKTREE
;
1239 invalidate_ce_path(old
, o
);
1243 * Previously unmerged entry left as an existence
1244 * marker by read_index_unmerged();
1246 invalidate_ce_path(old
, o
);
1249 add_entry(o
, merge
, update
, CE_STAGEMASK
);
1253 static int deleted_entry(struct cache_entry
*ce
, struct cache_entry
*old
,
1254 struct unpack_trees_options
*o
)
1256 /* Did it exist in the index? */
1258 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
1262 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
1264 add_entry(o
, ce
, CE_REMOVE
, 0);
1265 invalidate_ce_path(ce
, o
);
1269 static int keep_entry(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
1271 add_entry(o
, ce
, 0, 0);
1276 static void show_stage_entry(FILE *o
,
1277 const char *label
, const struct cache_entry
*ce
)
1280 fprintf(o
, "%s (missing)\n", label
);
1282 fprintf(o
, "%s%06o %s %d\t%s\n",
1285 sha1_to_hex(ce
->sha1
),
1291 int threeway_merge(struct cache_entry
**stages
, struct unpack_trees_options
*o
)
1293 struct cache_entry
*index
;
1294 struct cache_entry
*head
;
1295 struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
1298 int remote_match
= 0;
1300 int df_conflict_head
= 0;
1301 int df_conflict_remote
= 0;
1303 int any_anc_missing
= 0;
1304 int no_anc_exists
= 1;
1307 for (i
= 1; i
< o
->head_idx
; i
++) {
1308 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
1309 any_anc_missing
= 1;
1315 head
= stages
[o
->head_idx
];
1317 if (head
== o
->df_conflict_entry
) {
1318 df_conflict_head
= 1;
1322 if (remote
== o
->df_conflict_entry
) {
1323 df_conflict_remote
= 1;
1328 * First, if there's a #16 situation, note that to prevent #13
1331 if (!same(remote
, head
)) {
1332 for (i
= 1; i
< o
->head_idx
; i
++) {
1333 if (same(stages
[i
], head
)) {
1336 if (same(stages
[i
], remote
)) {
1343 * We start with cases where the index is allowed to match
1344 * something other than the head: #14(ALT) and #2ALT, where it
1345 * is permitted to match the result instead.
1347 /* #14, #14ALT, #2ALT */
1348 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
1349 if (index
&& !same(index
, remote
) && !same(index
, head
))
1350 return o
->gently
? -1 : reject_merge(index
, o
);
1351 return merged_entry(remote
, index
, o
);
1354 * If we have an entry in the index cache, then we want to
1355 * make sure that it matches head.
1357 if (index
&& !same(index
, head
))
1358 return o
->gently
? -1 : reject_merge(index
, o
);
1362 if (same(head
, remote
))
1363 return merged_entry(head
, index
, o
);
1365 if (!df_conflict_remote
&& remote_match
&& !head_match
)
1366 return merged_entry(head
, index
, o
);
1370 if (!head
&& !remote
&& any_anc_missing
)
1374 * Under the "aggressive" rule, we resolve mostly trivial
1375 * cases that we historically had git-merge-one-file resolve.
1377 if (o
->aggressive
) {
1378 int head_deleted
= !head
;
1379 int remote_deleted
= !remote
;
1380 struct cache_entry
*ce
= NULL
;
1389 for (i
= 1; i
< o
->head_idx
; i
++) {
1390 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
1399 * Deleted in one and unchanged in the other.
1401 if ((head_deleted
&& remote_deleted
) ||
1402 (head_deleted
&& remote
&& remote_match
) ||
1403 (remote_deleted
&& head
&& head_match
)) {
1405 return deleted_entry(index
, index
, o
);
1406 if (ce
&& !head_deleted
) {
1407 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
1413 * Added in both, identically.
1415 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
1416 return merged_entry(head
, index
, o
);
1420 /* Below are "no merge" cases, which require that the index be
1421 * up-to-date to avoid the files getting overwritten with
1422 * conflict resolution files.
1425 if (verify_uptodate(index
, o
))
1429 o
->nontrivial_merge
= 1;
1431 /* #2, #3, #4, #6, #7, #9, #10, #11. */
1433 if (!head_match
|| !remote_match
) {
1434 for (i
= 1; i
< o
->head_idx
; i
++) {
1435 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
1436 keep_entry(stages
[i
], o
);
1444 fprintf(stderr
, "read-tree: warning #16 detected\n");
1445 show_stage_entry(stderr
, "head ", stages
[head_match
]);
1446 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
1449 if (head
) { count
+= keep_entry(head
, o
); }
1450 if (remote
) { count
+= keep_entry(remote
, o
); }
1457 * The rule is to "carry forward" what is in the index without losing
1458 * information across a "fast-forward", favoring a successful merge
1459 * over a merge failure when it makes sense. For details of the
1460 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
1463 int twoway_merge(struct cache_entry
**src
, struct unpack_trees_options
*o
)
1465 struct cache_entry
*current
= src
[0];
1466 struct cache_entry
*oldtree
= src
[1];
1467 struct cache_entry
*newtree
= src
[2];
1469 if (o
->merge_size
!= 2)
1470 return error("Cannot do a twoway merge of %d trees",
1473 if (oldtree
== o
->df_conflict_entry
)
1475 if (newtree
== o
->df_conflict_entry
)
1479 if ((!oldtree
&& !newtree
) || /* 4 and 5 */
1480 (!oldtree
&& newtree
&&
1481 same(current
, newtree
)) || /* 6 and 7 */
1482 (oldtree
&& newtree
&&
1483 same(oldtree
, newtree
)) || /* 14 and 15 */
1484 (oldtree
&& newtree
&&
1485 !same(oldtree
, newtree
) && /* 18 and 19 */
1486 same(current
, newtree
))) {
1487 return keep_entry(current
, o
);
1489 else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
1491 return deleted_entry(oldtree
, current
, o
);
1493 else if (oldtree
&& newtree
&&
1494 same(current
, oldtree
) && !same(current
, newtree
)) {
1496 return merged_entry(newtree
, current
, o
);
1499 /* all other failures */
1501 return o
->gently
? -1 : reject_merge(oldtree
, o
);
1503 return o
->gently
? -1 : reject_merge(current
, o
);
1505 return o
->gently
? -1 : reject_merge(newtree
, o
);
1510 if (oldtree
&& !o
->initial_checkout
) {
1512 * deletion of the path was staged;
1514 if (same(oldtree
, newtree
))
1516 return reject_merge(oldtree
, o
);
1518 return merged_entry(newtree
, current
, o
);
1520 return deleted_entry(oldtree
, current
, o
);
1526 * Keep the index entries at stage0, collapse stage1 but make sure
1527 * stage0 does not have anything there.
1529 int bind_merge(struct cache_entry
**src
,
1530 struct unpack_trees_options
*o
)
1532 struct cache_entry
*old
= src
[0];
1533 struct cache_entry
*a
= src
[1];
1535 if (o
->merge_size
!= 1)
1536 return error("Cannot do a bind merge of %d trees\n",
1539 return o
->gently
? -1 :
1540 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
), a
->name
, old
->name
);
1542 return keep_entry(old
, o
);
1544 return merged_entry(a
, NULL
, o
);
1551 * - take the stat information from stage0, take the data from stage1
1553 int oneway_merge(struct cache_entry
**src
, struct unpack_trees_options
*o
)
1555 struct cache_entry
*old
= src
[0];
1556 struct cache_entry
*a
= src
[1];
1558 if (o
->merge_size
!= 1)
1559 return error("Cannot do a oneway merge of %d trees",
1562 if (!a
|| a
== o
->df_conflict_entry
)
1563 return deleted_entry(old
, old
, o
);
1565 if (old
&& same(old
, a
)) {
1567 if (o
->reset
&& !ce_uptodate(old
) && !ce_skip_worktree(old
)) {
1569 if (lstat(old
->name
, &st
) ||
1570 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
1571 update
|= CE_UPDATE
;
1573 add_entry(o
, old
, update
, 0);
1576 return merged_entry(a
, old
, o
);