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";
99 static void add_entry(struct unpack_trees_options
*o
, struct cache_entry
*ce
,
100 unsigned int set
, unsigned int clear
)
102 unsigned int size
= ce_size(ce
);
103 struct cache_entry
*new = xmalloc(size
);
105 clear
|= CE_HASHED
| CE_UNHASHED
;
107 memcpy(new, ce
, size
);
109 new->ce_flags
= (new->ce_flags
& ~clear
) | set
;
110 add_index_entry(&o
->result
, new, ADD_CACHE_OK_TO_ADD
|ADD_CACHE_OK_TO_REPLACE
);
114 * add error messages on path <path>
115 * corresponding to the type <e> with the message <msg>
116 * indicating if it should be display in porcelain or not
118 static int add_rejected_path(struct unpack_trees_options
*o
,
119 enum unpack_trees_error_types e
,
122 struct rejected_paths_list
*newentry
;
123 int porcelain
= o
&& (o
)->msgs
[e
];
125 * simply display the given error message if in plumbing mode
128 o
->show_all_errors
= 0;
129 if (!o
->show_all_errors
)
130 return error(ERRORMSG(o
, e
), path
);
133 * Otherwise, insert in a list for future display by
134 * display_error_msgs()
136 newentry
= xmalloc(sizeof(struct rejected_paths_list
));
137 newentry
->path
= (char *)path
;
138 newentry
->next
= o
->unpack_rejects
[e
];
139 o
->unpack_rejects
[e
] = newentry
;
144 * free all the structures allocated for the error <e>
146 static void free_rejected_paths(struct unpack_trees_options
*o
,
147 enum unpack_trees_error_types e
)
149 while (o
->unpack_rejects
[e
]) {
150 struct rejected_paths_list
*del
= o
->unpack_rejects
[e
];
151 o
->unpack_rejects
[e
] = o
->unpack_rejects
[e
]->next
;
154 free(o
->unpack_rejects
[e
]);
158 * display all the error messages stored in a nice way
160 static void display_error_msgs(struct unpack_trees_options
*o
)
163 int something_displayed
= 0;
164 for (e
= 0; e
< NB_UNPACK_TREES_ERROR_TYPES
; e
++) {
165 if (o
->unpack_rejects
[e
]) {
166 struct rejected_paths_list
*rp
;
167 struct strbuf path
= STRBUF_INIT
;
168 something_displayed
= 1;
169 for (rp
= o
->unpack_rejects
[e
]; rp
; rp
= rp
->next
)
170 strbuf_addf(&path
, "\t%s\n", rp
->path
);
171 error(ERRORMSG(o
, e
), path
.buf
);
172 strbuf_release(&path
);
173 free_rejected_paths(o
, e
);
176 if (something_displayed
)
177 printf("Aborting\n");
181 * Unlink the last component and schedule the leading directories for
182 * removal, such that empty directories get removed.
184 static void unlink_entry(struct cache_entry
*ce
)
186 if (has_symlink_or_noent_leading_path(ce
->name
, ce_namelen(ce
)))
188 if (remove_or_warn(ce
->ce_mode
, ce
->name
))
190 schedule_dir_for_removal(ce
->name
, ce_namelen(ce
));
193 static struct checkout state
;
194 static int check_updates(struct unpack_trees_options
*o
)
196 unsigned cnt
= 0, total
= 0;
197 struct progress
*progress
= NULL
;
198 struct index_state
*index
= &o
->result
;
202 if (o
->update
&& o
->verbose_update
) {
203 for (total
= cnt
= 0; cnt
< index
->cache_nr
; cnt
++) {
204 struct cache_entry
*ce
= index
->cache
[cnt
];
205 if (ce
->ce_flags
& (CE_UPDATE
| CE_REMOVE
| CE_WT_REMOVE
))
209 progress
= start_progress_delay("Checking out files",
215 git_attr_set_direction(GIT_ATTR_CHECKOUT
, &o
->result
);
216 for (i
= 0; i
< index
->cache_nr
; i
++) {
217 struct cache_entry
*ce
= index
->cache
[i
];
219 if (ce
->ce_flags
& CE_WT_REMOVE
) {
220 display_progress(progress
, ++cnt
);
226 if (ce
->ce_flags
& CE_REMOVE
) {
227 display_progress(progress
, ++cnt
);
232 remove_marked_cache_entries(&o
->result
);
233 remove_scheduled_dirs();
235 for (i
= 0; i
< index
->cache_nr
; i
++) {
236 struct cache_entry
*ce
= index
->cache
[i
];
238 if (ce
->ce_flags
& CE_UPDATE
) {
239 display_progress(progress
, ++cnt
);
240 ce
->ce_flags
&= ~CE_UPDATE
;
242 errs
|= checkout_entry(ce
, &state
, NULL
);
246 stop_progress(&progress
);
248 git_attr_set_direction(GIT_ATTR_CHECKIN
, NULL
);
252 static int verify_uptodate_sparse(struct cache_entry
*ce
, struct unpack_trees_options
*o
);
253 static int verify_absent_sparse(struct cache_entry
*ce
, enum unpack_trees_error_types
, struct unpack_trees_options
*o
);
255 static int will_have_skip_worktree(const struct cache_entry
*ce
, struct unpack_trees_options
*o
)
257 const char *basename
;
262 basename
= strrchr(ce
->name
, '/');
263 basename
= basename
? basename
+1 : ce
->name
;
264 return excluded_from_list(ce
->name
, ce_namelen(ce
), basename
, NULL
, o
->el
) <= 0;
267 static int apply_sparse_checkout(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
269 int was_skip_worktree
= ce_skip_worktree(ce
);
271 if (will_have_skip_worktree(ce
, o
))
272 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
274 ce
->ce_flags
&= ~CE_SKIP_WORKTREE
;
277 * We only care about files getting into the checkout area
278 * If merge strategies want to remove some, go ahead, this
279 * flag will be removed eventually in unpack_trees() if it's
280 * outside checkout area.
282 if (ce
->ce_flags
& CE_REMOVE
)
285 if (!was_skip_worktree
&& ce_skip_worktree(ce
)) {
287 * If CE_UPDATE is set, verify_uptodate() must be called already
288 * also stat info may have lost after merged_entry() so calling
289 * verify_uptodate() again may fail
291 if (!(ce
->ce_flags
& CE_UPDATE
) && verify_uptodate_sparse(ce
, o
))
293 ce
->ce_flags
|= CE_WT_REMOVE
;
295 if (was_skip_worktree
&& !ce_skip_worktree(ce
)) {
296 if (verify_absent_sparse(ce
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
298 ce
->ce_flags
|= CE_UPDATE
;
303 static inline int call_unpack_fn(struct cache_entry
**src
, struct unpack_trees_options
*o
)
305 int ret
= o
->fn(src
, o
);
311 static void mark_ce_used(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
313 ce
->ce_flags
|= CE_UNPACKED
;
315 if (o
->cache_bottom
< o
->src_index
->cache_nr
&&
316 o
->src_index
->cache
[o
->cache_bottom
] == ce
) {
317 int bottom
= o
->cache_bottom
;
318 while (bottom
< o
->src_index
->cache_nr
&&
319 o
->src_index
->cache
[bottom
]->ce_flags
& CE_UNPACKED
)
321 o
->cache_bottom
= bottom
;
325 static void mark_all_ce_unused(struct index_state
*index
)
328 for (i
= 0; i
< index
->cache_nr
; i
++)
329 index
->cache
[i
]->ce_flags
&= ~CE_UNPACKED
;
332 static int locate_in_src_index(struct cache_entry
*ce
,
333 struct unpack_trees_options
*o
)
335 struct index_state
*index
= o
->src_index
;
336 int len
= ce_namelen(ce
);
337 int pos
= index_name_pos(index
, ce
->name
, len
);
344 * We call unpack_index_entry() with an unmerged cache entry
345 * only in diff-index, and it wants a single callback. Skip
346 * the other unmerged entry with the same name.
348 static void mark_ce_used_same_name(struct cache_entry
*ce
,
349 struct unpack_trees_options
*o
)
351 struct index_state
*index
= o
->src_index
;
352 int len
= ce_namelen(ce
);
355 for (pos
= locate_in_src_index(ce
, o
); pos
< index
->cache_nr
; pos
++) {
356 struct cache_entry
*next
= index
->cache
[pos
];
357 if (len
!= ce_namelen(next
) ||
358 memcmp(ce
->name
, next
->name
, len
))
360 mark_ce_used(next
, o
);
364 static struct cache_entry
*next_cache_entry(struct unpack_trees_options
*o
)
366 const struct index_state
*index
= o
->src_index
;
367 int pos
= o
->cache_bottom
;
369 while (pos
< index
->cache_nr
) {
370 struct cache_entry
*ce
= index
->cache
[pos
];
371 if (!(ce
->ce_flags
& CE_UNPACKED
))
378 static void add_same_unmerged(struct cache_entry
*ce
,
379 struct unpack_trees_options
*o
)
381 struct index_state
*index
= o
->src_index
;
382 int len
= ce_namelen(ce
);
383 int pos
= index_name_pos(index
, ce
->name
, len
);
386 die("programming error in a caller of mark_ce_used_same_name");
387 for (pos
= -pos
- 1; pos
< index
->cache_nr
; pos
++) {
388 struct cache_entry
*next
= index
->cache
[pos
];
389 if (len
!= ce_namelen(next
) ||
390 memcmp(ce
->name
, next
->name
, len
))
392 add_entry(o
, next
, 0, 0);
393 mark_ce_used(next
, o
);
397 static int unpack_index_entry(struct cache_entry
*ce
,
398 struct unpack_trees_options
*o
)
400 struct cache_entry
*src
[5] = { NULL
};
407 if (o
->skip_unmerged
) {
408 add_entry(o
, ce
, 0, 0);
412 ret
= call_unpack_fn(src
, o
);
414 mark_ce_used_same_name(ce
, o
);
418 static int find_cache_pos(struct traverse_info
*, const struct name_entry
*);
420 static void restore_cache_bottom(struct traverse_info
*info
, int bottom
)
422 struct unpack_trees_options
*o
= info
->data
;
424 if (o
->diff_index_cached
)
426 o
->cache_bottom
= bottom
;
429 static int switch_cache_bottom(struct traverse_info
*info
)
431 struct unpack_trees_options
*o
= info
->data
;
434 if (o
->diff_index_cached
)
436 ret
= o
->cache_bottom
;
437 pos
= find_cache_pos(info
->prev
, &info
->name
);
440 o
->cache_bottom
= -2 - pos
;
442 o
->cache_bottom
= o
->src_index
->cache_nr
;
446 static int traverse_trees_recursive(int n
, unsigned long dirmask
, unsigned long df_conflicts
, struct name_entry
*names
, struct traverse_info
*info
)
449 struct tree_desc t
[MAX_UNPACK_TREES
];
450 struct traverse_info newinfo
;
451 struct name_entry
*p
;
460 newinfo
.pathlen
+= tree_entry_len(p
->path
, p
->sha1
) + 1;
461 newinfo
.conflicts
|= df_conflicts
;
463 for (i
= 0; i
< n
; i
++, dirmask
>>= 1) {
464 const unsigned char *sha1
= NULL
;
466 sha1
= names
[i
].sha1
;
467 fill_tree_descriptor(t
+i
, sha1
);
470 bottom
= switch_cache_bottom(&newinfo
);
471 ret
= traverse_trees(n
, t
, &newinfo
);
472 restore_cache_bottom(&newinfo
, bottom
);
477 * Compare the traverse-path to the cache entry without actually
478 * having to generate the textual representation of the traverse
481 * NOTE! This *only* compares up to the size of the traverse path
482 * itself - the caller needs to do the final check for the cache
483 * entry having more data at the end!
485 static int do_compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
487 int len
, pathlen
, ce_len
;
491 int cmp
= do_compare_entry(ce
, info
->prev
, &info
->name
);
495 pathlen
= info
->pathlen
;
496 ce_len
= ce_namelen(ce
);
498 /* If ce_len < pathlen then we must have previously hit "name == directory" entry */
499 if (ce_len
< pathlen
)
503 ce_name
= ce
->name
+ pathlen
;
505 len
= tree_entry_len(n
->path
, n
->sha1
);
506 return df_name_compare(ce_name
, ce_len
, S_IFREG
, n
->path
, len
, n
->mode
);
509 static int compare_entry(const struct cache_entry
*ce
, const struct traverse_info
*info
, const struct name_entry
*n
)
511 int cmp
= do_compare_entry(ce
, info
, n
);
516 * Even if the beginning compared identically, the ce should
517 * compare as bigger than a directory leading up to it!
519 return ce_namelen(ce
) > traverse_path_len(info
, n
);
522 static int ce_in_traverse_path(const struct cache_entry
*ce
,
523 const struct traverse_info
*info
)
527 if (do_compare_entry(ce
, info
->prev
, &info
->name
))
530 * If ce (blob) is the same name as the path (which is a tree
531 * we will be descending into), it won't be inside it.
533 return (info
->pathlen
< ce_namelen(ce
));
536 static struct cache_entry
*create_ce_entry(const struct traverse_info
*info
, const struct name_entry
*n
, int stage
)
538 int len
= traverse_path_len(info
, n
);
539 struct cache_entry
*ce
= xcalloc(1, cache_entry_size(len
));
541 ce
->ce_mode
= create_ce_mode(n
->mode
);
542 ce
->ce_flags
= create_ce_flags(len
, stage
);
543 hashcpy(ce
->sha1
, n
->sha1
);
544 make_traverse_path(ce
->name
, info
, n
);
549 static int unpack_nondirectories(int n
, unsigned long mask
,
550 unsigned long dirmask
,
551 struct cache_entry
**src
,
552 const struct name_entry
*names
,
553 const struct traverse_info
*info
)
556 struct unpack_trees_options
*o
= info
->data
;
557 unsigned long conflicts
;
559 /* Do we have *only* directories? Nothing to do */
560 if (mask
== dirmask
&& !src
[0])
563 conflicts
= info
->conflicts
;
566 conflicts
|= dirmask
;
569 * Ok, we've filled in up to any potential index entry in src[0],
572 for (i
= 0; i
< n
; i
++) {
574 unsigned int bit
= 1ul << i
;
575 if (conflicts
& bit
) {
576 src
[i
+ o
->merge
] = o
->df_conflict_entry
;
583 else if (i
+ 1 < o
->head_idx
)
585 else if (i
+ 1 > o
->head_idx
)
589 src
[i
+ o
->merge
] = create_ce_entry(info
, names
+ i
, stage
);
593 return call_unpack_fn(src
, o
);
595 for (i
= 0; i
< n
; i
++)
596 if (src
[i
] && src
[i
] != o
->df_conflict_entry
)
597 add_entry(o
, src
[i
], 0, 0);
601 static int unpack_failed(struct unpack_trees_options
*o
, const char *message
)
603 discard_index(&o
->result
);
606 return error("%s", message
);
612 /* NEEDSWORK: give this a better name and share with tree-walk.c */
613 static int name_compare(const char *a
, int a_len
,
614 const char *b
, int b_len
)
616 int len
= (a_len
< b_len
) ? a_len
: b_len
;
617 int cmp
= memcmp(a
, b
, len
);
620 return (a_len
- b_len
);
624 * The tree traversal is looking at name p. If we have a matching entry,
625 * return it. If name p is a directory in the index, do not return
626 * anything, as we will want to match it when the traversal descends into
629 static int find_cache_pos(struct traverse_info
*info
,
630 const struct name_entry
*p
)
633 struct unpack_trees_options
*o
= info
->data
;
634 struct index_state
*index
= o
->src_index
;
635 int pfxlen
= info
->pathlen
;
636 int p_len
= tree_entry_len(p
->path
, p
->sha1
);
638 for (pos
= o
->cache_bottom
; pos
< index
->cache_nr
; pos
++) {
639 struct cache_entry
*ce
= index
->cache
[pos
];
640 const char *ce_name
, *ce_slash
;
643 if (ce
->ce_flags
& CE_UNPACKED
) {
645 * cache_bottom entry is already unpacked, so
646 * we can never match it; don't check it
649 if (pos
== o
->cache_bottom
)
653 if (!ce_in_traverse_path(ce
, info
))
655 ce_name
= ce
->name
+ pfxlen
;
656 ce_slash
= strchr(ce_name
, '/');
658 ce_len
= ce_slash
- ce_name
;
660 ce_len
= ce_namelen(ce
) - pfxlen
;
661 cmp
= name_compare(p
->path
, p_len
, ce_name
, ce_len
);
663 * Exact match; if we have a directory we need to
664 * delay returning it.
667 return ce_slash
? -2 - pos
: pos
;
669 continue; /* keep looking */
671 * ce_name sorts after p->path; could it be that we
672 * have files under p->path directory in the index?
673 * E.g. ce_name == "t-i", and p->path == "t"; we may
674 * have "t/a" in the index.
676 if (p_len
< ce_len
&& !memcmp(ce_name
, p
->path
, p_len
) &&
677 ce_name
[p_len
] < '/')
678 continue; /* keep looking */
684 static struct cache_entry
*find_cache_entry(struct traverse_info
*info
,
685 const struct name_entry
*p
)
687 int pos
= find_cache_pos(info
, p
);
688 struct unpack_trees_options
*o
= info
->data
;
691 return o
->src_index
->cache
[pos
];
696 static void debug_path(struct traverse_info
*info
)
699 debug_path(info
->prev
);
700 if (*info
->prev
->name
.path
)
703 printf("%s", info
->name
.path
);
706 static void debug_name_entry(int i
, struct name_entry
*n
)
708 printf("ent#%d %06o %s\n", i
,
709 n
->path
? n
->mode
: 0,
710 n
->path
? n
->path
: "(missing)");
713 static void debug_unpack_callback(int n
,
715 unsigned long dirmask
,
716 struct name_entry
*names
,
717 struct traverse_info
*info
)
720 printf("* unpack mask %lu, dirmask %lu, cnt %d ",
724 for (i
= 0; i
< n
; i
++)
725 debug_name_entry(i
, names
+ i
);
728 static int unpack_callback(int n
, unsigned long mask
, unsigned long dirmask
, struct name_entry
*names
, struct traverse_info
*info
)
730 struct cache_entry
*src
[MAX_UNPACK_TREES
+ 1] = { NULL
, };
731 struct unpack_trees_options
*o
= info
->data
;
732 const struct name_entry
*p
= names
;
734 /* Find first entry with a real name (we could use "mask" too) */
739 debug_unpack_callback(n
, mask
, dirmask
, names
, info
);
741 /* Are we supposed to look at the index too? */
745 struct cache_entry
*ce
;
747 if (o
->diff_index_cached
)
748 ce
= next_cache_entry(o
);
750 ce
= find_cache_entry(info
, p
);
754 cmp
= compare_entry(ce
, info
, p
);
756 if (unpack_index_entry(ce
, o
) < 0)
757 return unpack_failed(o
, NULL
);
763 * If we skip unmerged index
764 * entries, we'll skip this
765 * entry *and* the tree
766 * entries associated with it!
768 if (o
->skip_unmerged
) {
769 add_same_unmerged(ce
, o
);
779 if (unpack_nondirectories(n
, mask
, dirmask
, src
, names
, info
) < 0)
783 if (ce_stage(src
[0]))
784 mark_ce_used_same_name(src
[0], o
);
786 mark_ce_used(src
[0], o
);
789 /* Now handle any directories.. */
791 unsigned long conflicts
= mask
& ~dirmask
;
798 /* special case: "diff-index --cached" looking at a tree */
799 if (o
->diff_index_cached
&&
800 n
== 1 && dirmask
== 1 && S_ISDIR(names
->mode
)) {
802 matches
= cache_tree_matches_traversal(o
->src_index
->cache_tree
,
805 * Everything under the name matches; skip the
806 * entire hierarchy. diff_index_cached codepath
807 * special cases D/F conflicts in such a way that
808 * it does not do any look-ahead, so this is safe.
811 o
->cache_bottom
+= matches
;
816 if (traverse_trees_recursive(n
, dirmask
, conflicts
,
826 * N-way merge "len" trees. Returns 0 on success, -1 on failure to manipulate the
827 * resulting index, -2 on failure to reflect the changes to the work tree.
829 int unpack_trees(unsigned len
, struct tree_desc
*t
, struct unpack_trees_options
*o
)
832 static struct cache_entry
*dfc
;
833 struct exclude_list el
;
835 if (len
> MAX_UNPACK_TREES
)
836 die("unpack_trees takes at most %d trees", MAX_UNPACK_TREES
);
837 memset(&state
, 0, sizeof(state
));
841 state
.refresh_cache
= 1;
843 memset(&el
, 0, sizeof(el
));
844 if (!core_apply_sparse_checkout
|| !o
->update
)
845 o
->skip_sparse_checkout
= 1;
846 if (!o
->skip_sparse_checkout
) {
847 if (add_excludes_from_file_to_list(git_path("info/sparse-checkout"), "", 0, NULL
, &el
, 0) < 0)
848 o
->skip_sparse_checkout
= 1;
853 memset(&o
->result
, 0, sizeof(o
->result
));
854 o
->result
.initialized
= 1;
855 o
->result
.timestamp
.sec
= o
->src_index
->timestamp
.sec
;
856 o
->result
.timestamp
.nsec
= o
->src_index
->timestamp
.nsec
;
858 mark_all_ce_unused(o
->src_index
);
861 dfc
= xcalloc(1, cache_entry_size(0));
862 o
->df_conflict_entry
= dfc
;
865 const char *prefix
= o
->prefix
? o
->prefix
: "";
866 struct traverse_info info
;
868 setup_traverse_info(&info
, prefix
);
869 info
.fn
= unpack_callback
;
871 info
.show_all_errors
= o
->show_all_errors
;
875 * Unpack existing index entries that sort before the
876 * prefix the tree is spliced into. Note that o->merge
877 * is always true in this case.
880 struct cache_entry
*ce
= next_cache_entry(o
);
883 if (ce_in_traverse_path(ce
, &info
))
885 if (unpack_index_entry(ce
, o
) < 0)
890 if (traverse_trees(len
, t
, &info
) < 0)
894 /* Any left-over entries in the index? */
897 struct cache_entry
*ce
= next_cache_entry(o
);
900 if (unpack_index_entry(ce
, o
) < 0)
904 mark_all_ce_unused(o
->src_index
);
906 if (o
->trivial_merges_only
&& o
->nontrivial_merge
) {
907 ret
= unpack_failed(o
, "Merge requires file-level merging");
911 if (!o
->skip_sparse_checkout
) {
912 int empty_worktree
= 1;
913 for (i
= 0;i
< o
->result
.cache_nr
;i
++) {
914 struct cache_entry
*ce
= o
->result
.cache
[i
];
916 if (apply_sparse_checkout(ce
, o
)) {
921 * Merge strategies may set CE_UPDATE|CE_REMOVE outside checkout
922 * area as a result of ce_skip_worktree() shortcuts in
923 * verify_absent() and verify_uptodate(). Clear them.
925 if (ce_skip_worktree(ce
))
926 ce
->ce_flags
&= ~(CE_UPDATE
| CE_REMOVE
);
931 if (o
->result
.cache_nr
&& empty_worktree
) {
932 ret
= unpack_failed(o
, "Sparse checkout leaves no entry on working directory");
938 ret
= check_updates(o
) ? (-2) : 0;
940 *o
->dst_index
= o
->result
;
943 for (i
= 0;i
< el
.nr
;i
++)
944 free(el
.excludes
[i
]);
951 if (o
->show_all_errors
)
952 display_error_msgs(o
);
953 mark_all_ce_unused(o
->src_index
);
954 ret
= unpack_failed(o
, NULL
);
958 /* Here come the merge functions */
960 static int reject_merge(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
962 return add_rejected_path(o
, ERROR_WOULD_OVERWRITE
, ce
->name
);
965 static int same(struct cache_entry
*a
, struct cache_entry
*b
)
971 if ((a
->ce_flags
| b
->ce_flags
) & CE_CONFLICTED
)
973 return a
->ce_mode
== b
->ce_mode
&&
974 !hashcmp(a
->sha1
, b
->sha1
);
979 * When a CE gets turned into an unmerged entry, we
980 * want it to be up-to-date
982 static int verify_uptodate_1(struct cache_entry
*ce
,
983 struct unpack_trees_options
*o
,
984 enum unpack_trees_error_types error_type
)
988 if (o
->index_only
|| (!((ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
)) && (o
->reset
|| ce_uptodate(ce
))))
991 if (!lstat(ce
->name
, &st
)) {
992 unsigned changed
= ie_match_stat(o
->src_index
, ce
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
996 * NEEDSWORK: the current default policy is to allow
997 * submodule to be out of sync wrt the supermodule
998 * index. This needs to be tightened later for
999 * submodules that are marked to be automatically
1002 if (S_ISGITLINK(ce
->ce_mode
))
1006 if (errno
== ENOENT
)
1008 return o
->gently
? -1 :
1009 add_rejected_path(o
, error_type
, ce
->name
);
1012 static int verify_uptodate(struct cache_entry
*ce
,
1013 struct unpack_trees_options
*o
)
1015 if (!o
->skip_sparse_checkout
&& will_have_skip_worktree(ce
, o
))
1017 return verify_uptodate_1(ce
, o
, ERROR_NOT_UPTODATE_FILE
);
1020 static int verify_uptodate_sparse(struct cache_entry
*ce
,
1021 struct unpack_trees_options
*o
)
1023 return verify_uptodate_1(ce
, o
, ERROR_SPARSE_NOT_UPTODATE_FILE
);
1026 static void invalidate_ce_path(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
1029 cache_tree_invalidate_path(o
->src_index
->cache_tree
, ce
->name
);
1033 * Check that checking out ce->sha1 in subdir ce->name is not
1034 * going to overwrite any working files.
1036 * Currently, git does not checkout subprojects during a superproject
1037 * checkout, so it is not going to overwrite anything.
1039 static int verify_clean_submodule(struct cache_entry
*ce
,
1040 enum unpack_trees_error_types error_type
,
1041 struct unpack_trees_options
*o
)
1046 static int verify_clean_subdirectory(struct cache_entry
*ce
,
1047 enum unpack_trees_error_types error_type
,
1048 struct unpack_trees_options
*o
)
1051 * we are about to extract "ce->name"; we would not want to lose
1052 * anything in the existing directory there.
1056 struct dir_struct d
;
1059 unsigned char sha1
[20];
1061 if (S_ISGITLINK(ce
->ce_mode
) &&
1062 resolve_gitlink_ref(ce
->name
, "HEAD", sha1
) == 0) {
1063 /* If we are not going to update the submodule, then
1066 if (!hashcmp(sha1
, ce
->sha1
))
1068 return verify_clean_submodule(ce
, error_type
, o
);
1072 * First let's make sure we do not have a local modification
1073 * in that directory.
1075 namelen
= strlen(ce
->name
);
1076 for (i
= locate_in_src_index(ce
, o
);
1077 i
< o
->src_index
->cache_nr
;
1079 struct cache_entry
*ce2
= o
->src_index
->cache
[i
];
1080 int len
= ce_namelen(ce2
);
1081 if (len
< namelen
||
1082 strncmp(ce
->name
, ce2
->name
, namelen
) ||
1083 ce2
->name
[namelen
] != '/')
1086 * ce2->name is an entry in the subdirectory to be
1089 if (!ce_stage(ce2
)) {
1090 if (verify_uptodate(ce2
, o
))
1092 add_entry(o
, ce2
, CE_REMOVE
, 0);
1093 mark_ce_used(ce2
, o
);
1099 * Then we need to make sure that we do not lose a locally
1100 * present file that is not ignored.
1102 pathbuf
= xmalloc(namelen
+ 2);
1103 memcpy(pathbuf
, ce
->name
, namelen
);
1104 strcpy(pathbuf
+namelen
, "/");
1106 memset(&d
, 0, sizeof(d
));
1108 d
.exclude_per_dir
= o
->dir
->exclude_per_dir
;
1109 i
= read_directory(&d
, pathbuf
, namelen
+1, NULL
);
1111 return o
->gently
? -1 :
1112 add_rejected_path(o
, ERROR_NOT_UPTODATE_DIR
, ce
->name
);
1118 * This gets called when there was no index entry for the tree entry 'dst',
1119 * but we found a file in the working tree that 'lstat()' said was fine,
1120 * and we're on a case-insensitive filesystem.
1122 * See if we can find a case-insensitive match in the index that also
1123 * matches the stat information, and assume it's that other file!
1125 static int icase_exists(struct unpack_trees_options
*o
, struct cache_entry
*dst
, struct stat
*st
)
1127 struct cache_entry
*src
;
1129 src
= index_name_exists(o
->src_index
, dst
->name
, ce_namelen(dst
), 1);
1130 return src
&& !ie_match_stat(o
->src_index
, src
, st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
);
1134 * We do not want to remove or overwrite a working tree file that
1135 * is not tracked, unless it is ignored.
1137 static int verify_absent_1(struct cache_entry
*ce
,
1138 enum unpack_trees_error_types error_type
,
1139 struct unpack_trees_options
*o
)
1143 if (o
->index_only
|| o
->reset
|| !o
->update
)
1146 if (has_symlink_or_noent_leading_path(ce
->name
, ce_namelen(ce
)))
1149 if (!lstat(ce
->name
, &st
)) {
1150 int dtype
= ce_to_dtype(ce
);
1151 struct cache_entry
*result
;
1154 * It may be that the 'lstat()' succeeded even though
1155 * target 'ce' was absent, because there is an old
1156 * entry that is different only in case..
1158 * Ignore that lstat() if it matches.
1160 if (ignore_case
&& icase_exists(o
, ce
, &st
))
1163 if (o
->dir
&& excluded(o
->dir
, ce
->name
, &dtype
))
1165 * ce->name is explicitly excluded, so it is Ok to
1169 if (S_ISDIR(st
.st_mode
)) {
1171 * We are checking out path "foo" and
1172 * found "foo/." in the working tree.
1173 * This is tricky -- if we have modified
1174 * files that are in "foo/" we would lose
1177 if (verify_clean_subdirectory(ce
, error_type
, o
) < 0)
1183 * The previous round may already have decided to
1184 * delete this path, which is in a subdirectory that
1185 * is being replaced with a blob.
1187 result
= index_name_exists(&o
->result
, ce
->name
, ce_namelen(ce
), 0);
1189 if (result
->ce_flags
& CE_REMOVE
)
1193 return o
->gently
? -1 :
1194 add_rejected_path(o
, error_type
, ce
->name
);
1198 static int verify_absent(struct cache_entry
*ce
,
1199 enum unpack_trees_error_types error_type
,
1200 struct unpack_trees_options
*o
)
1202 if (!o
->skip_sparse_checkout
&& will_have_skip_worktree(ce
, o
))
1204 return verify_absent_1(ce
, error_type
, o
);
1207 static int verify_absent_sparse(struct cache_entry
*ce
,
1208 enum unpack_trees_error_types error_type
,
1209 struct unpack_trees_options
*o
)
1211 enum unpack_trees_error_types orphaned_error
= error_type
;
1212 if (orphaned_error
== ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
)
1213 orphaned_error
= ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN
;
1215 return verify_absent_1(ce
, orphaned_error
, o
);
1218 static int merged_entry(struct cache_entry
*merge
, struct cache_entry
*old
,
1219 struct unpack_trees_options
*o
)
1221 int update
= CE_UPDATE
;
1224 if (verify_absent(merge
, ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN
, o
))
1226 invalidate_ce_path(merge
, o
);
1227 } else if (!(old
->ce_flags
& CE_CONFLICTED
)) {
1229 * See if we can re-use the old CE directly?
1230 * That way we get the uptodate stat info.
1232 * This also removes the UPDATE flag on a match; otherwise
1233 * we will end up overwriting local changes in the work tree.
1235 if (same(old
, merge
)) {
1236 copy_cache_entry(merge
, old
);
1239 if (verify_uptodate(old
, o
))
1241 if (ce_skip_worktree(old
))
1242 update
|= CE_SKIP_WORKTREE
;
1243 invalidate_ce_path(old
, o
);
1247 * Previously unmerged entry left as an existence
1248 * marker by read_index_unmerged();
1250 invalidate_ce_path(old
, o
);
1253 add_entry(o
, merge
, update
, CE_STAGEMASK
);
1257 static int deleted_entry(struct cache_entry
*ce
, struct cache_entry
*old
,
1258 struct unpack_trees_options
*o
)
1260 /* Did it exist in the index? */
1262 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
1266 if (!(old
->ce_flags
& CE_CONFLICTED
) && verify_uptodate(old
, o
))
1268 add_entry(o
, ce
, CE_REMOVE
, 0);
1269 invalidate_ce_path(ce
, o
);
1273 static int keep_entry(struct cache_entry
*ce
, struct unpack_trees_options
*o
)
1275 add_entry(o
, ce
, 0, 0);
1280 static void show_stage_entry(FILE *o
,
1281 const char *label
, const struct cache_entry
*ce
)
1284 fprintf(o
, "%s (missing)\n", label
);
1286 fprintf(o
, "%s%06o %s %d\t%s\n",
1289 sha1_to_hex(ce
->sha1
),
1295 int threeway_merge(struct cache_entry
**stages
, struct unpack_trees_options
*o
)
1297 struct cache_entry
*index
;
1298 struct cache_entry
*head
;
1299 struct cache_entry
*remote
= stages
[o
->head_idx
+ 1];
1302 int remote_match
= 0;
1304 int df_conflict_head
= 0;
1305 int df_conflict_remote
= 0;
1307 int any_anc_missing
= 0;
1308 int no_anc_exists
= 1;
1311 for (i
= 1; i
< o
->head_idx
; i
++) {
1312 if (!stages
[i
] || stages
[i
] == o
->df_conflict_entry
)
1313 any_anc_missing
= 1;
1319 head
= stages
[o
->head_idx
];
1321 if (head
== o
->df_conflict_entry
) {
1322 df_conflict_head
= 1;
1326 if (remote
== o
->df_conflict_entry
) {
1327 df_conflict_remote
= 1;
1332 * First, if there's a #16 situation, note that to prevent #13
1335 if (!same(remote
, head
)) {
1336 for (i
= 1; i
< o
->head_idx
; i
++) {
1337 if (same(stages
[i
], head
)) {
1340 if (same(stages
[i
], remote
)) {
1347 * We start with cases where the index is allowed to match
1348 * something other than the head: #14(ALT) and #2ALT, where it
1349 * is permitted to match the result instead.
1351 /* #14, #14ALT, #2ALT */
1352 if (remote
&& !df_conflict_head
&& head_match
&& !remote_match
) {
1353 if (index
&& !same(index
, remote
) && !same(index
, head
))
1354 return o
->gently
? -1 : reject_merge(index
, o
);
1355 return merged_entry(remote
, index
, o
);
1358 * If we have an entry in the index cache, then we want to
1359 * make sure that it matches head.
1361 if (index
&& !same(index
, head
))
1362 return o
->gently
? -1 : reject_merge(index
, o
);
1366 if (same(head
, remote
))
1367 return merged_entry(head
, index
, o
);
1369 if (!df_conflict_remote
&& remote_match
&& !head_match
)
1370 return merged_entry(head
, index
, o
);
1374 if (!head
&& !remote
&& any_anc_missing
)
1378 * Under the "aggressive" rule, we resolve mostly trivial
1379 * cases that we historically had git-merge-one-file resolve.
1381 if (o
->aggressive
) {
1382 int head_deleted
= !head
;
1383 int remote_deleted
= !remote
;
1384 struct cache_entry
*ce
= NULL
;
1393 for (i
= 1; i
< o
->head_idx
; i
++) {
1394 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
1403 * Deleted in one and unchanged in the other.
1405 if ((head_deleted
&& remote_deleted
) ||
1406 (head_deleted
&& remote
&& remote_match
) ||
1407 (remote_deleted
&& head
&& head_match
)) {
1409 return deleted_entry(index
, index
, o
);
1410 if (ce
&& !head_deleted
) {
1411 if (verify_absent(ce
, ERROR_WOULD_LOSE_UNTRACKED_REMOVED
, o
))
1417 * Added in both, identically.
1419 if (no_anc_exists
&& head
&& remote
&& same(head
, remote
))
1420 return merged_entry(head
, index
, o
);
1424 /* Below are "no merge" cases, which require that the index be
1425 * up-to-date to avoid the files getting overwritten with
1426 * conflict resolution files.
1429 if (verify_uptodate(index
, o
))
1433 o
->nontrivial_merge
= 1;
1435 /* #2, #3, #4, #6, #7, #9, #10, #11. */
1437 if (!head_match
|| !remote_match
) {
1438 for (i
= 1; i
< o
->head_idx
; i
++) {
1439 if (stages
[i
] && stages
[i
] != o
->df_conflict_entry
) {
1440 keep_entry(stages
[i
], o
);
1448 fprintf(stderr
, "read-tree: warning #16 detected\n");
1449 show_stage_entry(stderr
, "head ", stages
[head_match
]);
1450 show_stage_entry(stderr
, "remote ", stages
[remote_match
]);
1453 if (head
) { count
+= keep_entry(head
, o
); }
1454 if (remote
) { count
+= keep_entry(remote
, o
); }
1461 * The rule is to "carry forward" what is in the index without losing
1462 * information across a "fast-forward", favoring a successful merge
1463 * over a merge failure when it makes sense. For details of the
1464 * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
1467 int twoway_merge(struct cache_entry
**src
, struct unpack_trees_options
*o
)
1469 struct cache_entry
*current
= src
[0];
1470 struct cache_entry
*oldtree
= src
[1];
1471 struct cache_entry
*newtree
= src
[2];
1473 if (o
->merge_size
!= 2)
1474 return error("Cannot do a twoway merge of %d trees",
1477 if (oldtree
== o
->df_conflict_entry
)
1479 if (newtree
== o
->df_conflict_entry
)
1483 if ((!oldtree
&& !newtree
) || /* 4 and 5 */
1484 (!oldtree
&& newtree
&&
1485 same(current
, newtree
)) || /* 6 and 7 */
1486 (oldtree
&& newtree
&&
1487 same(oldtree
, newtree
)) || /* 14 and 15 */
1488 (oldtree
&& newtree
&&
1489 !same(oldtree
, newtree
) && /* 18 and 19 */
1490 same(current
, newtree
))) {
1491 return keep_entry(current
, o
);
1493 else if (oldtree
&& !newtree
&& same(current
, oldtree
)) {
1495 return deleted_entry(oldtree
, current
, o
);
1497 else if (oldtree
&& newtree
&&
1498 same(current
, oldtree
) && !same(current
, newtree
)) {
1500 return merged_entry(newtree
, current
, o
);
1503 /* all other failures */
1505 return o
->gently
? -1 : reject_merge(oldtree
, o
);
1507 return o
->gently
? -1 : reject_merge(current
, o
);
1509 return o
->gently
? -1 : reject_merge(newtree
, o
);
1514 if (oldtree
&& !o
->initial_checkout
) {
1516 * deletion of the path was staged;
1518 if (same(oldtree
, newtree
))
1520 return reject_merge(oldtree
, o
);
1522 return merged_entry(newtree
, current
, o
);
1524 return deleted_entry(oldtree
, current
, o
);
1530 * Keep the index entries at stage0, collapse stage1 but make sure
1531 * stage0 does not have anything there.
1533 int bind_merge(struct cache_entry
**src
,
1534 struct unpack_trees_options
*o
)
1536 struct cache_entry
*old
= src
[0];
1537 struct cache_entry
*a
= src
[1];
1539 if (o
->merge_size
!= 1)
1540 return error("Cannot do a bind merge of %d trees\n",
1543 return o
->gently
? -1 :
1544 error(ERRORMSG(o
, ERROR_BIND_OVERLAP
), a
->name
, old
->name
);
1546 return keep_entry(old
, o
);
1548 return merged_entry(a
, NULL
, o
);
1555 * - take the stat information from stage0, take the data from stage1
1557 int oneway_merge(struct cache_entry
**src
, struct unpack_trees_options
*o
)
1559 struct cache_entry
*old
= src
[0];
1560 struct cache_entry
*a
= src
[1];
1562 if (o
->merge_size
!= 1)
1563 return error("Cannot do a oneway merge of %d trees",
1566 if (!a
|| a
== o
->df_conflict_entry
)
1567 return deleted_entry(old
, old
, o
);
1569 if (old
&& same(old
, a
)) {
1571 if (o
->reset
&& !ce_uptodate(old
) && !ce_skip_worktree(old
)) {
1573 if (lstat(old
->name
, &st
) ||
1574 ie_match_stat(o
->src_index
, old
, &st
, CE_MATCH_IGNORE_VALID
|CE_MATCH_IGNORE_SKIP_WORKTREE
))
1575 update
|= CE_UPDATE
;
1577 add_entry(o
, old
, update
, 0);
1580 return merged_entry(a
, old
, o
);