1 #include "git-compat-util.h"
5 #include "string-list.h"
7 #include "xdiff-interface.h"
9 #include "resolve-undo.h"
13 #include "object-store.h"
14 #include "hash-lookup.h"
19 #define THREE_STAGED 2
20 void *RERERE_RESOLVED
= &RERERE_RESOLVED
;
22 /* if rerere_enabled == -1, fall back to detection of .git/rr-cache */
23 static int rerere_enabled
= -1;
25 /* automatically update cleanly resolved paths to the index */
26 static int rerere_autoupdate
;
28 #define RR_HAS_POSTIMAGE 1
29 #define RR_HAS_PREIMAGE 2
31 int status_alloc
, status_nr
;
32 unsigned char *status
;
33 char name
[FLEX_ARRAY
];
36 static struct strmap rerere_dirs
= STRMAP_INIT
;
38 static void free_rerere_dirs(void)
40 struct hashmap_iter iter
;
41 struct strmap_entry
*ent
;
43 strmap_for_each_entry(&rerere_dirs
, &iter
, ent
) {
44 struct rerere_dir
*rr_dir
= ent
->value
;
48 strmap_clear(&rerere_dirs
, 0);
51 static void free_rerere_id(struct string_list_item
*item
)
56 static const char *rerere_id_hex(const struct rerere_id
*id
)
58 return id
->collection
->name
;
61 static void fit_variant(struct rerere_dir
*rr_dir
, int variant
)
64 ALLOC_GROW(rr_dir
->status
, variant
, rr_dir
->status_alloc
);
65 if (rr_dir
->status_nr
< variant
) {
66 memset(rr_dir
->status
+ rr_dir
->status_nr
,
67 '\0', variant
- rr_dir
->status_nr
);
68 rr_dir
->status_nr
= variant
;
72 static void assign_variant(struct rerere_id
*id
)
75 struct rerere_dir
*rr_dir
= id
->collection
;
77 variant
= id
->variant
;
79 for (variant
= 0; variant
< rr_dir
->status_nr
; variant
++)
80 if (!rr_dir
->status
[variant
])
83 fit_variant(rr_dir
, variant
);
84 id
->variant
= variant
;
87 const char *rerere_path(const struct rerere_id
*id
, const char *file
)
90 return git_path("rr-cache/%s", rerere_id_hex(id
));
93 return git_path("rr-cache/%s/%s", rerere_id_hex(id
), file
);
95 return git_path("rr-cache/%s/%s.%d",
96 rerere_id_hex(id
), file
, id
->variant
);
99 static int is_rr_file(const char *name
, const char *filename
, int *variant
)
104 if (!strcmp(name
, filename
)) {
108 if (!skip_prefix(name
, filename
, &suffix
) || *suffix
!= '.')
112 *variant
= strtol(suffix
+ 1, &ep
, 10);
118 static void scan_rerere_dir(struct rerere_dir
*rr_dir
)
121 DIR *dir
= opendir(git_path("rr-cache/%s", rr_dir
->name
));
125 while ((de
= readdir(dir
)) != NULL
) {
128 if (is_rr_file(de
->d_name
, "postimage", &variant
)) {
129 fit_variant(rr_dir
, variant
);
130 rr_dir
->status
[variant
] |= RR_HAS_POSTIMAGE
;
131 } else if (is_rr_file(de
->d_name
, "preimage", &variant
)) {
132 fit_variant(rr_dir
, variant
);
133 rr_dir
->status
[variant
] |= RR_HAS_PREIMAGE
;
139 static struct rerere_dir
*find_rerere_dir(const char *hex
)
141 struct rerere_dir
*rr_dir
;
143 rr_dir
= strmap_get(&rerere_dirs
, hex
);
145 FLEX_ALLOC_STR(rr_dir
, name
, hex
);
146 rr_dir
->status
= NULL
;
147 rr_dir
->status_nr
= 0;
148 rr_dir
->status_alloc
= 0;
149 strmap_put(&rerere_dirs
, hex
, rr_dir
);
151 scan_rerere_dir(rr_dir
);
156 static int has_rerere_resolution(const struct rerere_id
*id
)
158 const int both
= RR_HAS_POSTIMAGE
|RR_HAS_PREIMAGE
;
159 int variant
= id
->variant
;
163 return ((id
->collection
->status
[variant
] & both
) == both
);
166 static struct rerere_id
*new_rerere_id_hex(char *hex
)
168 struct rerere_id
*id
= xmalloc(sizeof(*id
));
169 id
->collection
= find_rerere_dir(hex
);
170 id
->variant
= -1; /* not known yet */
174 static struct rerere_id
*new_rerere_id(unsigned char *hash
)
176 return new_rerere_id_hex(hash_to_hex(hash
));
180 * $GIT_DIR/MERGE_RR file is a collection of records, each of which is
181 * "conflict ID", a HT and pathname, terminated with a NUL, and is
182 * used to keep track of the set of paths that "rerere" may need to
183 * work on (i.e. what is left by the previous invocation of "git
184 * rerere" during the current conflict resolution session).
186 static void read_rr(struct repository
*r
, struct string_list
*rr
)
188 struct strbuf buf
= STRBUF_INIT
;
189 FILE *in
= fopen_or_warn(git_path_merge_rr(r
), "r");
193 while (!strbuf_getwholeline(&buf
, in
, '\0')) {
195 unsigned char hash
[GIT_MAX_RAWSZ
];
196 struct rerere_id
*id
;
198 const unsigned hexsz
= the_hash_algo
->hexsz
;
200 /* There has to be the hash, tab, path and then NUL */
201 if (buf
.len
< hexsz
+ 2 || get_sha1_hex(buf
.buf
, hash
))
202 die(_("corrupt MERGE_RR"));
204 if (buf
.buf
[hexsz
] != '.') {
206 path
= buf
.buf
+ hexsz
;
209 variant
= strtol(buf
.buf
+ hexsz
+ 1, &path
, 10);
211 die(_("corrupt MERGE_RR"));
213 if (*(path
++) != '\t')
214 die(_("corrupt MERGE_RR"));
215 buf
.buf
[hexsz
] = '\0';
216 id
= new_rerere_id_hex(buf
.buf
);
217 id
->variant
= variant
;
218 string_list_insert(rr
, path
)->util
= id
;
220 strbuf_release(&buf
);
224 static struct lock_file write_lock
;
226 static int write_rr(struct string_list
*rr
, int out_fd
)
229 for (i
= 0; i
< rr
->nr
; i
++) {
230 struct strbuf buf
= STRBUF_INIT
;
231 struct rerere_id
*id
;
233 assert(rr
->items
[i
].util
!= RERERE_RESOLVED
);
235 id
= rr
->items
[i
].util
;
238 assert(id
->variant
>= 0);
240 strbuf_addf(&buf
, "%s.%d\t%s%c",
241 rerere_id_hex(id
), id
->variant
,
242 rr
->items
[i
].string
, 0);
244 strbuf_addf(&buf
, "%s\t%s%c",
246 rr
->items
[i
].string
, 0);
248 if (write_in_full(out_fd
, buf
.buf
, buf
.len
) < 0)
249 die(_("unable to write rerere record"));
251 strbuf_release(&buf
);
253 if (commit_lock_file(&write_lock
) != 0)
254 die(_("unable to write rerere record"));
259 * "rerere" interacts with conflicted file contents using this I/O
260 * abstraction. It reads a conflicted contents from one place via
261 * "getline()" method, and optionally can write it out after
262 * normalizing the conflicted hunks to the "output". Subclasses of
263 * rerere_io embed this structure at the beginning of their own
267 int (*getline
)(struct strbuf
*, struct rerere_io
*);
270 /* some more stuff */
273 static void ferr_write(const void *p
, size_t count
, FILE *fp
, int *err
)
277 if (fwrite(p
, count
, 1, fp
) != 1)
281 static inline void ferr_puts(const char *s
, FILE *fp
, int *err
)
283 ferr_write(s
, strlen(s
), fp
, err
);
286 static void rerere_io_putstr(const char *str
, struct rerere_io
*io
)
289 ferr_puts(str
, io
->output
, &io
->wrerror
);
292 static void rerere_io_putmem(const char *mem
, size_t sz
, struct rerere_io
*io
)
295 ferr_write(mem
, sz
, io
->output
, &io
->wrerror
);
299 * Subclass of rerere_io that reads from an on-disk file
301 struct rerere_io_file
{
307 * ... and its getline() method implementation
309 static int rerere_file_getline(struct strbuf
*sb
, struct rerere_io
*io_
)
311 struct rerere_io_file
*io
= (struct rerere_io_file
*)io_
;
312 return strbuf_getwholeline(sb
, io
->input
, '\n');
316 * Require the exact number of conflict marker letters, no more, no
317 * less, followed by SP or any whitespace
320 static int is_cmarker(char *buf
, int marker_char
, int marker_size
)
325 * The beginning of our version and the end of their version
326 * always are labeled like "<<<<< ours" or ">>>>> theirs",
327 * hence we set want_sp for them. Note that the version from
328 * the common ancestor in diff3-style output is not always
329 * labelled (e.g. "||||| common" is often seen but "|||||"
330 * alone is also valid), so we do not set want_sp.
332 want_sp
= (marker_char
== '<') || (marker_char
== '>');
334 while (marker_size
--)
335 if (*buf
++ != marker_char
)
337 if (want_sp
&& *buf
!= ' ')
339 return isspace(*buf
);
342 static void rerere_strbuf_putconflict(struct strbuf
*buf
, int ch
, size_t size
)
344 strbuf_addchars(buf
, ch
, size
);
345 strbuf_addch(buf
, '\n');
348 static int handle_conflict(struct strbuf
*out
, struct rerere_io
*io
,
349 int marker_size
, git_hash_ctx
*ctx
)
352 RR_SIDE_1
= 0, RR_SIDE_2
, RR_ORIGINAL
354 struct strbuf one
= STRBUF_INIT
, two
= STRBUF_INIT
;
355 struct strbuf buf
= STRBUF_INIT
, conflict
= STRBUF_INIT
;
356 int has_conflicts
= -1;
358 while (!io
->getline(&buf
, io
)) {
359 if (is_cmarker(buf
.buf
, '<', marker_size
)) {
360 if (handle_conflict(&conflict
, io
, marker_size
, NULL
) < 0)
362 if (hunk
== RR_SIDE_1
)
363 strbuf_addbuf(&one
, &conflict
);
365 strbuf_addbuf(&two
, &conflict
);
366 strbuf_release(&conflict
);
367 } else if (is_cmarker(buf
.buf
, '|', marker_size
)) {
368 if (hunk
!= RR_SIDE_1
)
371 } else if (is_cmarker(buf
.buf
, '=', marker_size
)) {
372 if (hunk
!= RR_SIDE_1
&& hunk
!= RR_ORIGINAL
)
375 } else if (is_cmarker(buf
.buf
, '>', marker_size
)) {
376 if (hunk
!= RR_SIDE_2
)
378 if (strbuf_cmp(&one
, &two
) > 0)
379 strbuf_swap(&one
, &two
);
381 rerere_strbuf_putconflict(out
, '<', marker_size
);
382 strbuf_addbuf(out
, &one
);
383 rerere_strbuf_putconflict(out
, '=', marker_size
);
384 strbuf_addbuf(out
, &two
);
385 rerere_strbuf_putconflict(out
, '>', marker_size
);
387 the_hash_algo
->update_fn(ctx
, one
.buf
?
390 the_hash_algo
->update_fn(ctx
, two
.buf
?
395 } else if (hunk
== RR_SIDE_1
)
396 strbuf_addbuf(&one
, &buf
);
397 else if (hunk
== RR_ORIGINAL
)
399 else if (hunk
== RR_SIDE_2
)
400 strbuf_addbuf(&two
, &buf
);
402 strbuf_release(&one
);
403 strbuf_release(&two
);
404 strbuf_release(&buf
);
406 return has_conflicts
;
410 * Read contents a file with conflicts, normalize the conflicts
411 * by (1) discarding the common ancestor version in diff3-style,
412 * (2) reordering our side and their side so that whichever sorts
413 * alphabetically earlier comes before the other one, while
414 * computing the "conflict ID", which is just an SHA-1 hash of
415 * one side of the conflict, NUL, the other side of the conflict,
416 * and NUL concatenated together.
418 * Return 1 if conflict hunks are found, 0 if there are no conflict
419 * hunks and -1 if an error occurred.
421 static int handle_path(unsigned char *hash
, struct rerere_io
*io
, int marker_size
)
424 struct strbuf buf
= STRBUF_INIT
, out
= STRBUF_INIT
;
425 int has_conflicts
= 0;
427 the_hash_algo
->init_fn(&ctx
);
429 while (!io
->getline(&buf
, io
)) {
430 if (is_cmarker(buf
.buf
, '<', marker_size
)) {
431 has_conflicts
= handle_conflict(&out
, io
, marker_size
,
433 if (has_conflicts
< 0)
435 rerere_io_putmem(out
.buf
, out
.len
, io
);
438 rerere_io_putstr(buf
.buf
, io
);
440 strbuf_release(&buf
);
441 strbuf_release(&out
);
444 the_hash_algo
->final_fn(hash
, &ctx
);
446 return has_conflicts
;
450 * Scan the path for conflicts, do the "handle_path()" thing above, and
451 * return the number of conflict hunks found.
453 static int handle_file(struct index_state
*istate
,
454 const char *path
, unsigned char *hash
, const char *output
)
456 int has_conflicts
= 0;
457 struct rerere_io_file io
;
458 int marker_size
= ll_merge_marker_size(istate
, path
);
460 memset(&io
, 0, sizeof(io
));
461 io
.io
.getline
= rerere_file_getline
;
462 io
.input
= fopen(path
, "r");
465 return error_errno(_("could not open '%s'"), path
);
468 io
.io
.output
= fopen(output
, "w");
470 error_errno(_("could not write '%s'"), output
);
476 has_conflicts
= handle_path(hash
, (struct rerere_io
*)&io
, marker_size
);
480 error(_("there were errors while writing '%s' (%s)"),
481 path
, strerror(io
.io
.wrerror
));
482 if (io
.io
.output
&& fclose(io
.io
.output
))
483 io
.io
.wrerror
= error_errno(_("failed to flush '%s'"), path
);
485 if (has_conflicts
< 0) {
487 unlink_or_warn(output
);
488 return error(_("could not parse conflict hunks in '%s'"), path
);
492 return has_conflicts
;
496 * Look at a cache entry at "i" and see if it is not conflicting,
497 * conflicting and we are willing to handle, or conflicting and
498 * we are unable to handle, and return the determination in *type.
499 * Return the cache index to be looked at next, by skipping the
500 * stages we have already looked at in this invocation of this
503 static int check_one_conflict(struct index_state
*istate
, int i
, int *type
)
505 const struct cache_entry
*e
= istate
->cache
[i
];
513 while (i
< istate
->cache_nr
&& ce_stage(istate
->cache
[i
]) == 1)
516 /* Only handle regular files with both stages #2 and #3 */
517 if (i
+ 1 < istate
->cache_nr
) {
518 const struct cache_entry
*e2
= istate
->cache
[i
];
519 const struct cache_entry
*e3
= istate
->cache
[i
+ 1];
520 if (ce_stage(e2
) == 2 &&
522 ce_same_name(e
, e3
) &&
523 S_ISREG(e2
->ce_mode
) &&
524 S_ISREG(e3
->ce_mode
))
525 *type
= THREE_STAGED
;
528 /* Skip the entries with the same name */
529 while (i
< istate
->cache_nr
&& ce_same_name(e
, istate
->cache
[i
]))
535 * Scan the index and find paths that have conflicts that rerere can
536 * handle, i.e. the ones that has both stages #2 and #3.
538 * NEEDSWORK: we do not record or replay a previous "resolve by
539 * deletion" for a delete-modify conflict, as that is inherently risky
540 * without knowing what modification is being discarded. The only
541 * safe case, i.e. both side doing the deletion and modification that
542 * are identical to the previous round, might want to be handled,
545 static int find_conflict(struct repository
*r
, struct string_list
*conflict
)
549 if (repo_read_index(r
) < 0)
550 return error(_("index file corrupt"));
552 for (i
= 0; i
< r
->index
->cache_nr
;) {
554 const struct cache_entry
*e
= r
->index
->cache
[i
];
555 i
= check_one_conflict(r
->index
, i
, &conflict_type
);
556 if (conflict_type
== THREE_STAGED
)
557 string_list_insert(conflict
, (const char *)e
->name
);
563 * The merge_rr list is meant to hold outstanding conflicted paths
564 * that rerere could handle. Abuse the list by adding other types of
565 * entries to allow the caller to show "rerere remaining".
567 * - Conflicted paths that rerere does not handle are added
568 * - Conflicted paths that have been resolved are marked as such
569 * by storing RERERE_RESOLVED to .util field (where conflict ID
570 * is expected to be stored).
572 * Do *not* write MERGE_RR file out after calling this function.
574 * NEEDSWORK: we may want to fix the caller that implements "rerere
575 * remaining" to do this without abusing merge_rr.
577 int rerere_remaining(struct repository
*r
, struct string_list
*merge_rr
)
581 if (setup_rerere(r
, merge_rr
, RERERE_READONLY
))
583 if (repo_read_index(r
) < 0)
584 return error(_("index file corrupt"));
586 for (i
= 0; i
< r
->index
->cache_nr
;) {
588 const struct cache_entry
*e
= r
->index
->cache
[i
];
589 i
= check_one_conflict(r
->index
, i
, &conflict_type
);
590 if (conflict_type
== PUNTED
)
591 string_list_insert(merge_rr
, (const char *)e
->name
);
592 else if (conflict_type
== RESOLVED
) {
593 struct string_list_item
*it
;
594 it
= string_list_lookup(merge_rr
, (const char *)e
->name
);
597 it
->util
= RERERE_RESOLVED
;
605 * Try using the given conflict resolution "ID" to see
606 * if that recorded conflict resolves cleanly what we
609 static int try_merge(struct index_state
*istate
,
610 const struct rerere_id
*id
, const char *path
,
611 mmfile_t
*cur
, mmbuffer_t
*result
)
613 enum ll_merge_result ret
;
614 mmfile_t base
= {NULL
, 0}, other
= {NULL
, 0};
616 if (read_mmfile(&base
, rerere_path(id
, "preimage")) ||
617 read_mmfile(&other
, rerere_path(id
, "postimage"))) {
618 ret
= LL_MERGE_CONFLICT
;
621 * A three-way merge. Note that this honors user-customizable
622 * low-level merge driver settings.
624 ret
= ll_merge(result
, path
, &base
, NULL
, cur
, "", &other
, "",
635 * Find the conflict identified by "id"; the change between its
636 * "preimage" (i.e. a previous contents with conflict markers) and its
637 * "postimage" (i.e. the corresponding contents with conflicts
638 * resolved) may apply cleanly to the contents stored in "path", i.e.
639 * the conflict this time around.
641 * Returns 0 for successful replay of recorded resolution, or non-zero
644 static int merge(struct index_state
*istate
, const struct rerere_id
*id
, const char *path
)
648 mmfile_t cur
= {NULL
, 0};
649 mmbuffer_t result
= {NULL
, 0};
652 * Normalize the conflicts in path and write it out to
653 * "thisimage" temporary file.
655 if ((handle_file(istate
, path
, NULL
, rerere_path(id
, "thisimage")) < 0) ||
656 read_mmfile(&cur
, rerere_path(id
, "thisimage"))) {
661 ret
= try_merge(istate
, id
, path
, &cur
, &result
);
666 * A successful replay of recorded resolution.
667 * Mark that "postimage" was used to help gc.
669 if (utime(rerere_path(id
, "postimage"), NULL
) < 0)
670 warning_errno(_("failed utime() on '%s'"),
671 rerere_path(id
, "postimage"));
673 /* Update "path" with the resolution */
674 f
= fopen(path
, "w");
676 return error_errno(_("could not open '%s'"), path
);
677 if (fwrite(result
.ptr
, result
.size
, 1, f
) != 1)
678 error_errno(_("could not write '%s'"), path
);
680 return error_errno(_("writing '%s' failed"), path
);
689 static void update_paths(struct repository
*r
, struct string_list
*update
)
691 struct lock_file index_lock
= LOCK_INIT
;
694 repo_hold_locked_index(r
, &index_lock
, LOCK_DIE_ON_ERROR
);
696 for (i
= 0; i
< update
->nr
; i
++) {
697 struct string_list_item
*item
= &update
->items
[i
];
698 if (add_file_to_index(r
->index
, item
->string
, 0))
700 fprintf_ln(stderr
, _("Staged '%s' using previous resolution."),
704 if (write_locked_index(r
->index
, &index_lock
,
705 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
706 die(_("unable to write new index file"));
709 static void remove_variant(struct rerere_id
*id
)
711 unlink_or_warn(rerere_path(id
, "postimage"));
712 unlink_or_warn(rerere_path(id
, "preimage"));
713 id
->collection
->status
[id
->variant
] = 0;
717 * The path indicated by rr_item may still have conflict for which we
718 * have a recorded resolution, in which case replay it and optionally
719 * update it. Or it may have been resolved by the user and we may
720 * only have the preimage for that conflict, in which case the result
721 * needs to be recorded as a resolution in a postimage file.
723 static void do_rerere_one_path(struct index_state
*istate
,
724 struct string_list_item
*rr_item
,
725 struct string_list
*update
)
727 const char *path
= rr_item
->string
;
728 struct rerere_id
*id
= rr_item
->util
;
729 struct rerere_dir
*rr_dir
= id
->collection
;
732 variant
= id
->variant
;
734 /* Has the user resolved it already? */
736 if (!handle_file(istate
, path
, NULL
, NULL
)) {
737 copy_file(rerere_path(id
, "postimage"), path
, 0666);
738 id
->collection
->status
[variant
] |= RR_HAS_POSTIMAGE
;
739 fprintf_ln(stderr
, _("Recorded resolution for '%s'."), path
);
740 free_rerere_id(rr_item
);
741 rr_item
->util
= NULL
;
745 * There may be other variants that can cleanly
746 * replay. Try them and update the variant number for
751 /* Does any existing resolution apply cleanly? */
752 for (variant
= 0; variant
< rr_dir
->status_nr
; variant
++) {
753 const int both
= RR_HAS_PREIMAGE
| RR_HAS_POSTIMAGE
;
754 struct rerere_id vid
= *id
;
756 if ((rr_dir
->status
[variant
] & both
) != both
)
759 vid
.variant
= variant
;
760 if (merge(istate
, &vid
, path
))
761 continue; /* failed to replay */
764 * If there already is a different variant that applies
765 * cleanly, there is no point maintaining our own variant.
767 if (0 <= id
->variant
&& id
->variant
!= variant
)
770 if (rerere_autoupdate
)
771 string_list_insert(update
, path
);
774 _("Resolved '%s' using previous resolution."),
776 free_rerere_id(rr_item
);
777 rr_item
->util
= NULL
;
781 /* None of the existing one applies; we need a new variant */
784 variant
= id
->variant
;
785 handle_file(istate
, path
, NULL
, rerere_path(id
, "preimage"));
786 if (id
->collection
->status
[variant
] & RR_HAS_POSTIMAGE
) {
787 const char *path
= rerere_path(id
, "postimage");
789 die_errno(_("cannot unlink stray '%s'"), path
);
790 id
->collection
->status
[variant
] &= ~RR_HAS_POSTIMAGE
;
792 id
->collection
->status
[variant
] |= RR_HAS_PREIMAGE
;
793 fprintf_ln(stderr
, _("Recorded preimage for '%s'"), path
);
796 static int do_plain_rerere(struct repository
*r
,
797 struct string_list
*rr
, int fd
)
799 struct string_list conflict
= STRING_LIST_INIT_DUP
;
800 struct string_list update
= STRING_LIST_INIT_DUP
;
803 find_conflict(r
, &conflict
);
806 * MERGE_RR records paths with conflicts immediately after
807 * merge failed. Some of the conflicted paths might have been
808 * hand resolved in the working tree since then, but the
809 * initial run would catch all and register their preimages.
811 for (i
= 0; i
< conflict
.nr
; i
++) {
812 struct rerere_id
*id
;
813 unsigned char hash
[GIT_MAX_RAWSZ
];
814 const char *path
= conflict
.items
[i
].string
;
818 * Ask handle_file() to scan and assign a
819 * conflict ID. No need to write anything out
822 ret
= handle_file(r
->index
, path
, hash
, NULL
);
823 if (ret
!= 0 && string_list_has_string(rr
, path
)) {
824 remove_variant(string_list_lookup(rr
, path
)->util
);
825 string_list_remove(rr
, path
, 1);
830 id
= new_rerere_id(hash
);
831 string_list_insert(rr
, path
)->util
= id
;
833 /* Ensure that the directory exists. */
834 mkdir_in_gitdir(rerere_path(id
, NULL
));
837 for (i
= 0; i
< rr
->nr
; i
++)
838 do_rerere_one_path(r
->index
, &rr
->items
[i
], &update
);
841 update_paths(r
, &update
);
843 return write_rr(rr
, fd
);
846 static void git_rerere_config(void)
848 git_config_get_bool("rerere.enabled", &rerere_enabled
);
849 git_config_get_bool("rerere.autoupdate", &rerere_autoupdate
);
850 git_config(git_default_config
, NULL
);
853 static GIT_PATH_FUNC(git_path_rr_cache
, "rr-cache")
855 static int is_rerere_enabled(void)
862 rr_cache_exists
= is_directory(git_path_rr_cache());
863 if (rerere_enabled
< 0)
864 return rr_cache_exists
;
866 if (!rr_cache_exists
&& mkdir_in_gitdir(git_path_rr_cache()))
867 die(_("could not create directory '%s'"), git_path_rr_cache());
871 int setup_rerere(struct repository
*r
, struct string_list
*merge_rr
, int flags
)
876 if (!is_rerere_enabled())
879 if (flags
& (RERERE_AUTOUPDATE
|RERERE_NOAUTOUPDATE
))
880 rerere_autoupdate
= !!(flags
& RERERE_AUTOUPDATE
);
881 if (flags
& RERERE_READONLY
)
884 fd
= hold_lock_file_for_update(&write_lock
,
885 git_path_merge_rr(r
),
887 read_rr(r
, merge_rr
);
892 * The main entry point that is called internally from codepaths that
893 * perform mergy operations, possibly leaving conflicted index entries
894 * and working tree files.
896 int repo_rerere(struct repository
*r
, int flags
)
898 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
901 fd
= setup_rerere(r
, &merge_rr
, flags
);
904 status
= do_plain_rerere(r
, &merge_rr
, fd
);
910 * Subclass of rerere_io that reads from an in-core buffer that is a
913 struct rerere_io_mem
{
919 * ... and its getline() method implementation
921 static int rerere_mem_getline(struct strbuf
*sb
, struct rerere_io
*io_
)
923 struct rerere_io_mem
*io
= (struct rerere_io_mem
*)io_
;
930 ep
= memchr(io
->input
.buf
, '\n', io
->input
.len
);
932 ep
= io
->input
.buf
+ io
->input
.len
;
933 else if (*ep
== '\n')
935 len
= ep
- io
->input
.buf
;
936 strbuf_add(sb
, io
->input
.buf
, len
);
937 strbuf_remove(&io
->input
, 0, len
);
941 static int handle_cache(struct index_state
*istate
,
942 const char *path
, unsigned char *hash
, const char *output
)
944 mmfile_t mmfile
[3] = {{NULL
}};
945 mmbuffer_t result
= {NULL
, 0};
946 const struct cache_entry
*ce
;
947 int pos
, len
, i
, has_conflicts
;
948 struct rerere_io_mem io
;
949 int marker_size
= ll_merge_marker_size(istate
, path
);
952 * Reproduce the conflicted merge in-core
955 pos
= index_name_pos(istate
, path
, len
);
960 while (pos
< istate
->cache_nr
) {
961 enum object_type type
;
964 ce
= istate
->cache
[pos
++];
965 if (ce_namelen(ce
) != len
|| memcmp(ce
->name
, path
, len
))
967 i
= ce_stage(ce
) - 1;
968 if (!mmfile
[i
].ptr
) {
969 mmfile
[i
].ptr
= read_object_file(&ce
->oid
, &type
,
971 mmfile
[i
].size
= size
;
974 for (i
= 0; i
< 3; i
++)
975 if (!mmfile
[i
].ptr
&& !mmfile
[i
].size
)
976 mmfile
[i
].ptr
= xstrdup("");
979 * NEEDSWORK: handle conflicts from merges with
980 * merge.renormalize set, too?
982 ll_merge(&result
, path
, &mmfile
[0], NULL
,
984 &mmfile
[2], "theirs",
986 for (i
= 0; i
< 3; i
++)
989 memset(&io
, 0, sizeof(io
));
990 io
.io
.getline
= rerere_mem_getline
;
992 io
.io
.output
= fopen(output
, "w");
995 strbuf_init(&io
.input
, 0);
996 strbuf_attach(&io
.input
, result
.ptr
, result
.size
, result
.size
);
999 * Grab the conflict ID and optionally write the original
1000 * contents with conflict markers out.
1002 has_conflicts
= handle_path(hash
, (struct rerere_io
*)&io
, marker_size
);
1003 strbuf_release(&io
.input
);
1005 fclose(io
.io
.output
);
1006 return has_conflicts
;
1009 static int rerere_forget_one_path(struct index_state
*istate
,
1011 struct string_list
*rr
)
1013 const char *filename
;
1014 struct rerere_id
*id
;
1015 unsigned char hash
[GIT_MAX_RAWSZ
];
1017 struct string_list_item
*item
;
1020 * Recreate the original conflict from the stages in the
1021 * index and compute the conflict ID
1023 ret
= handle_cache(istate
, path
, hash
, NULL
);
1025 return error(_("could not parse conflict hunks in '%s'"), path
);
1027 /* Nuke the recorded resolution for the conflict */
1028 id
= new_rerere_id(hash
);
1030 for (id
->variant
= 0;
1031 id
->variant
< id
->collection
->status_nr
;
1033 mmfile_t cur
= { NULL
, 0 };
1034 mmbuffer_t result
= {NULL
, 0};
1035 int cleanly_resolved
;
1037 if (!has_rerere_resolution(id
))
1040 handle_cache(istate
, path
, hash
, rerere_path(id
, "thisimage"));
1041 if (read_mmfile(&cur
, rerere_path(id
, "thisimage"))) {
1043 error(_("failed to update conflicted state in '%s'"), path
);
1046 cleanly_resolved
= !try_merge(istate
, id
, path
, &cur
, &result
);
1049 if (cleanly_resolved
)
1053 if (id
->collection
->status_nr
<= id
->variant
) {
1054 error(_("no remembered resolution for '%s'"), path
);
1058 filename
= rerere_path(id
, "postimage");
1059 if (unlink(filename
)) {
1060 if (errno
== ENOENT
)
1061 error(_("no remembered resolution for '%s'"), path
);
1063 error_errno(_("cannot unlink '%s'"), filename
);
1068 * Update the preimage so that the user can resolve the
1069 * conflict in the working tree, run us again to record
1072 handle_cache(istate
, path
, hash
, rerere_path(id
, "preimage"));
1073 fprintf_ln(stderr
, _("Updated preimage for '%s'"), path
);
1076 * And remember that we can record resolution for this
1077 * conflict when the user is done.
1079 item
= string_list_insert(rr
, path
);
1080 free_rerere_id(item
);
1082 fprintf(stderr
, _("Forgot resolution for '%s'\n"), path
);
1090 int rerere_forget(struct repository
*r
, struct pathspec
*pathspec
)
1093 struct string_list conflict
= STRING_LIST_INIT_DUP
;
1094 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
1096 if (repo_read_index(r
) < 0)
1097 return error(_("index file corrupt"));
1099 fd
= setup_rerere(r
, &merge_rr
, RERERE_NOAUTOUPDATE
);
1104 * The paths may have been resolved (incorrectly);
1105 * recover the original conflicted state and then
1106 * find the conflicted paths.
1108 unmerge_index(r
->index
, pathspec
);
1109 find_conflict(r
, &conflict
);
1110 for (i
= 0; i
< conflict
.nr
; i
++) {
1111 struct string_list_item
*it
= &conflict
.items
[i
];
1112 if (!match_pathspec(r
->index
, pathspec
, it
->string
,
1113 strlen(it
->string
), 0, NULL
, 0))
1115 rerere_forget_one_path(r
->index
, it
->string
, &merge_rr
);
1117 return write_rr(&merge_rr
, fd
);
1121 * Garbage collection support
1124 static timestamp_t
rerere_created_at(struct rerere_id
*id
)
1128 return stat(rerere_path(id
, "preimage"), &st
) ? (time_t) 0 : st
.st_mtime
;
1131 static timestamp_t
rerere_last_used_at(struct rerere_id
*id
)
1135 return stat(rerere_path(id
, "postimage"), &st
) ? (time_t) 0 : st
.st_mtime
;
1139 * Remove the recorded resolution for a given conflict ID
1141 static void unlink_rr_item(struct rerere_id
*id
)
1143 unlink_or_warn(rerere_path(id
, "thisimage"));
1145 id
->collection
->status
[id
->variant
] = 0;
1148 static void prune_one(struct rerere_id
*id
,
1149 timestamp_t cutoff_resolve
, timestamp_t cutoff_noresolve
)
1154 then
= rerere_last_used_at(id
);
1156 cutoff
= cutoff_resolve
;
1158 then
= rerere_created_at(id
);
1161 cutoff
= cutoff_noresolve
;
1167 /* Does the basename in "path" look plausibly like an rr-cache entry? */
1168 static int is_rr_cache_dirname(const char *path
)
1170 struct object_id oid
;
1172 return !parse_oid_hex(path
, &oid
, &end
) && !*end
;
1175 void rerere_gc(struct repository
*r
, struct string_list
*rr
)
1177 struct string_list to_remove
= STRING_LIST_INIT_DUP
;
1181 timestamp_t now
= time(NULL
);
1182 timestamp_t cutoff_noresolve
= now
- 15 * 86400;
1183 timestamp_t cutoff_resolve
= now
- 60 * 86400;
1185 if (setup_rerere(r
, rr
, 0) < 0)
1188 git_config_get_expiry_in_days("gc.rerereresolved", &cutoff_resolve
, now
);
1189 git_config_get_expiry_in_days("gc.rerereunresolved", &cutoff_noresolve
, now
);
1190 git_config(git_default_config
, NULL
);
1191 dir
= opendir(git_path("rr-cache"));
1193 die_errno(_("unable to open rr-cache directory"));
1194 /* Collect stale conflict IDs ... */
1195 while ((e
= readdir_skip_dot_and_dotdot(dir
))) {
1196 struct rerere_dir
*rr_dir
;
1197 struct rerere_id id
;
1200 if (!is_rr_cache_dirname(e
->d_name
))
1201 continue; /* or should we remove e->d_name? */
1203 rr_dir
= find_rerere_dir(e
->d_name
);
1206 for (id
.variant
= 0, id
.collection
= rr_dir
;
1207 id
.variant
< id
.collection
->status_nr
;
1209 prune_one(&id
, cutoff_resolve
, cutoff_noresolve
);
1210 if (id
.collection
->status
[id
.variant
])
1214 string_list_append(&to_remove
, e
->d_name
);
1218 /* ... and then remove the empty directories */
1219 for (i
= 0; i
< to_remove
.nr
; i
++)
1220 rmdir(git_path("rr-cache/%s", to_remove
.items
[i
].string
));
1221 string_list_clear(&to_remove
, 0);
1222 rollback_lock_file(&write_lock
);
1226 * During a conflict resolution, after "rerere" recorded the
1227 * preimages, abandon them if the user did not resolve them or
1228 * record their resolutions. And drop $GIT_DIR/MERGE_RR.
1230 * NEEDSWORK: shouldn't we be calling this from "reset --hard"?
1232 void rerere_clear(struct repository
*r
, struct string_list
*merge_rr
)
1236 if (setup_rerere(r
, merge_rr
, 0) < 0)
1239 for (i
= 0; i
< merge_rr
->nr
; i
++) {
1240 struct rerere_id
*id
= merge_rr
->items
[i
].util
;
1241 if (!has_rerere_resolution(id
)) {
1243 rmdir(rerere_path(id
, NULL
));
1246 unlink_or_warn(git_path_merge_rr(r
));
1247 rollback_lock_file(&write_lock
);