1#include "cache.h"
2#include "lockfile.h"
3#include "string-list.h"
4#include "rerere.h"
5#include "xdiff-interface.h"
6#include "dir.h"
7#include "resolve-undo.h"
8#include "ll-merge.h"
9#include "attr.h"
10#include "pathspec.h"
11
12#define RESOLVED 0
13#define PUNTED 1
14#define THREE_STAGED 2
15void *RERERE_RESOLVED = &RERERE_RESOLVED;
16
17/* if rerere_enabled == -1, fall back to detection of .git/rr-cache */
18static int rerere_enabled = -1;
19
20/* automatically update cleanly resolved paths to the index */
21static int rerere_autoupdate;
22
23static char *merge_rr_path;
24
25const char *rerere_path(const char *hex, const char *file)
26{
27 return git_path("rr-cache/%s/%s", hex, file);
28}
29
30static int has_rerere_resolution(const char *hex)
31{
32 struct stat st;
33 return !stat(rerere_path(hex, "postimage"), &st);
34}
35
36static void read_rr(struct string_list *rr)
37{
38 struct strbuf buf = STRBUF_INIT;
39 FILE *in = fopen(merge_rr_path, "r");
40
41 if (!in)
42 return;
43 while (!strbuf_getwholeline(&buf, in, '\0')) {
44 char *path;
45 unsigned char sha1[20];
46
47 /* There has to be the hash, tab, path and then NUL */
48 if (buf.len < 42 || get_sha1_hex(buf.buf, sha1))
49 die("corrupt MERGE_RR");
50
51 if (buf.buf[40] != '\t')
52 die("corrupt MERGE_RR");
53 buf.buf[40] = '\0';
54 path = buf.buf + 41;
55
56 string_list_insert(rr, path)->util = xstrdup(buf.buf);
57 }
58 strbuf_release(&buf);
59 fclose(in);
60}
61
62static struct lock_file write_lock;
63
64static int write_rr(struct string_list *rr, int out_fd)
65{
66 int i;
67 for (i = 0; i < rr->nr; i++) {
68 struct strbuf buf = STRBUF_INIT;
69
70 assert(rr->items[i].util != RERERE_RESOLVED);
71 if (!rr->items[i].util)
72 continue;
73 strbuf_addf(&buf, "%s\t%s%c",
74 (char *)rr->items[i].util,
75 rr->items[i].string, 0);
76 if (write_in_full(out_fd, buf.buf, buf.len) != buf.len)
77 die("unable to write rerere record");
78
79 strbuf_release(&buf);
80 }
81 if (commit_lock_file(&write_lock) != 0)
82 die("unable to write rerere record");
83 return 0;
84}
85
86static void ferr_write(const void *p, size_t count, FILE *fp, int *err)
87{
88 if (!count || *err)
89 return;
90 if (fwrite(p, count, 1, fp) != 1)
91 *err = errno;
92}
93
94static inline void ferr_puts(const char *s, FILE *fp, int *err)
95{
96 ferr_write(s, strlen(s), fp, err);
97}
98
99struct rerere_io {
100 int (*getline)(struct strbuf *, struct rerere_io *);
101 FILE *output;
102 int wrerror;
103 /* some more stuff */
104};
105
106static void rerere_io_putstr(const char *str, struct rerere_io *io)
107{
108 if (io->output)
109 ferr_puts(str, io->output, &io->wrerror);
110}
111
112static void rerere_io_putconflict(int ch, int size, struct rerere_io *io)
113{
114 char buf[64];
115
116 while (size) {
117 if (size < sizeof(buf) - 2) {
118 memset(buf, ch, size);
119 buf[size] = '\n';
120 buf[size + 1] = '\0';
121 size = 0;
122 } else {
123 int sz = sizeof(buf) - 1;
124 if (size <= sz)
125 sz -= (sz - size) + 1;
126 memset(buf, ch, sz);
127 buf[sz] = '\0';
128 size -= sz;
129 }
130 rerere_io_putstr(buf, io);
131 }
132}
133
134static void rerere_io_putmem(const char *mem, size_t sz, struct rerere_io *io)
135{
136 if (io->output)
137 ferr_write(mem, sz, io->output, &io->wrerror);
138}
139
140struct rerere_io_file {
141 struct rerere_io io;
142 FILE *input;
143};
144
145static int rerere_file_getline(struct strbuf *sb, struct rerere_io *io_)
146{
147 struct rerere_io_file *io = (struct rerere_io_file *)io_;
148 return strbuf_getwholeline(sb, io->input, '\n');
149}
150
151static int is_cmarker(char *buf, int marker_char, int marker_size, int want_sp)
152{
153 while (marker_size--)
154 if (*buf++ != marker_char)
155 return 0;
156 if (want_sp && *buf != ' ')
157 return 0;
158 return isspace(*buf);
159}
160
161static int handle_path(unsigned char *sha1, struct rerere_io *io, int marker_size)
162{
163 git_SHA_CTX ctx;
164 int hunk_no = 0;
165 enum {
166 RR_CONTEXT = 0, RR_SIDE_1, RR_SIDE_2, RR_ORIGINAL
167 } hunk = RR_CONTEXT;
168 struct strbuf one = STRBUF_INIT, two = STRBUF_INIT;
169 struct strbuf buf = STRBUF_INIT;
170
171 if (sha1)
172 git_SHA1_Init(&ctx);
173
174 while (!io->getline(&buf, io)) {
175 if (is_cmarker(buf.buf, '<', marker_size, 1)) {
176 if (hunk != RR_CONTEXT)
177 goto bad;
178 hunk = RR_SIDE_1;
179 } else if (is_cmarker(buf.buf, '|', marker_size, 0)) {
180 if (hunk != RR_SIDE_1)
181 goto bad;
182 hunk = RR_ORIGINAL;
183 } else if (is_cmarker(buf.buf, '=', marker_size, 0)) {
184 if (hunk != RR_SIDE_1 && hunk != RR_ORIGINAL)
185 goto bad;
186 hunk = RR_SIDE_2;
187 } else if (is_cmarker(buf.buf, '>', marker_size, 1)) {
188 if (hunk != RR_SIDE_2)
189 goto bad;
190 if (strbuf_cmp(&one, &two) > 0)
191 strbuf_swap(&one, &two);
192 hunk_no++;
193 hunk = RR_CONTEXT;
194 rerere_io_putconflict('<', marker_size, io);
195 rerere_io_putmem(one.buf, one.len, io);
196 rerere_io_putconflict('=', marker_size, io);
197 rerere_io_putmem(two.buf, two.len, io);
198 rerere_io_putconflict('>', marker_size, io);
199 if (sha1) {
200 git_SHA1_Update(&ctx, one.buf ? one.buf : "",
201 one.len + 1);
202 git_SHA1_Update(&ctx, two.buf ? two.buf : "",
203 two.len + 1);
204 }
205 strbuf_reset(&one);
206 strbuf_reset(&two);
207 } else if (hunk == RR_SIDE_1)
208 strbuf_addbuf(&one, &buf);
209 else if (hunk == RR_ORIGINAL)
210 ; /* discard */
211 else if (hunk == RR_SIDE_2)
212 strbuf_addbuf(&two, &buf);
213 else
214 rerere_io_putstr(buf.buf, io);
215 continue;
216 bad:
217 hunk = 99; /* force error exit */
218 break;
219 }
220 strbuf_release(&one);
221 strbuf_release(&two);
222 strbuf_release(&buf);
223
224 if (sha1)
225 git_SHA1_Final(sha1, &ctx);
226 if (hunk != RR_CONTEXT)
227 return -1;
228 return hunk_no;
229}
230
231static int handle_file(const char *path, unsigned char *sha1, const char *output)
232{
233 int hunk_no = 0;
234 struct rerere_io_file io;
235 int marker_size = ll_merge_marker_size(path);
236
237 memset(&io, 0, sizeof(io));
238 io.io.getline = rerere_file_getline;
239 io.input = fopen(path, "r");
240 io.io.wrerror = 0;
241 if (!io.input)
242 return error("Could not open %s", path);
243
244 if (output) {
245 io.io.output = fopen(output, "w");
246 if (!io.io.output) {
247 fclose(io.input);
248 return error("Could not write %s", output);
249 }
250 }
251
252 hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
253
254 fclose(io.input);
255 if (io.io.wrerror)
256 error("There were errors while writing %s (%s)",
257 path, strerror(io.io.wrerror));
258 if (io.io.output && fclose(io.io.output))
259 io.io.wrerror = error("Failed to flush %s: %s",
260 path, strerror(errno));
261
262 if (hunk_no < 0) {
263 if (output)
264 unlink_or_warn(output);
265 return error("Could not parse conflict hunks in %s", path);
266 }
267 if (io.io.wrerror)
268 return -1;
269 return hunk_no;
270}
271
272struct rerere_io_mem {
273 struct rerere_io io;
274 struct strbuf input;
275};
276
277static int rerere_mem_getline(struct strbuf *sb, struct rerere_io *io_)
278{
279 struct rerere_io_mem *io = (struct rerere_io_mem *)io_;
280 char *ep;
281 size_t len;
282
283 strbuf_release(sb);
284 if (!io->input.len)
285 return -1;
286 ep = memchr(io->input.buf, '\n', io->input.len);
287 if (!ep)
288 ep = io->input.buf + io->input.len;
289 else if (*ep == '\n')
290 ep++;
291 len = ep - io->input.buf;
292 strbuf_add(sb, io->input.buf, len);
293 strbuf_remove(&io->input, 0, len);
294 return 0;
295}
296
297static int handle_cache(const char *path, unsigned char *sha1, const char *output)
298{
299 mmfile_t mmfile[3] = {{NULL}};
300 mmbuffer_t result = {NULL, 0};
301 const struct cache_entry *ce;
302 int pos, len, i, hunk_no;
303 struct rerere_io_mem io;
304 int marker_size = ll_merge_marker_size(path);
305
306 /*
307 * Reproduce the conflicted merge in-core
308 */
309 len = strlen(path);
310 pos = cache_name_pos(path, len);
311 if (0 <= pos)
312 return -1;
313 pos = -pos - 1;
314
315 for (i = 0; i < 3; i++) {
316 enum object_type type;
317 unsigned long size;
318 int j;
319
320 if (active_nr <= pos)
321 break;
322 ce = active_cache[pos++];
323 if (ce_namelen(ce) != len || memcmp(ce->name, path, len))
324 continue;
325 j = ce_stage(ce) - 1;
326 mmfile[j].ptr = read_sha1_file(ce->sha1, &type, &size);
327 mmfile[j].size = size;
328 }
329 for (i = 0; i < 3; i++) {
330 if (!mmfile[i].ptr && !mmfile[i].size)
331 mmfile[i].ptr = xstrdup("");
332 }
333 /*
334 * NEEDSWORK: handle conflicts from merges with
335 * merge.renormalize set, too
336 */
337 ll_merge(&result, path, &mmfile[0], NULL,
338 &mmfile[1], "ours",
339 &mmfile[2], "theirs", NULL);
340 for (i = 0; i < 3; i++)
341 free(mmfile[i].ptr);
342
343 memset(&io, 0, sizeof(io));
344 io.io.getline = rerere_mem_getline;
345 if (output)
346 io.io.output = fopen(output, "w");
347 else
348 io.io.output = NULL;
349 strbuf_init(&io.input, 0);
350 strbuf_attach(&io.input, result.ptr, result.size, result.size);
351
352 hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
353 strbuf_release(&io.input);
354 if (io.io.output)
355 fclose(io.io.output);
356 return hunk_no;
357}
358
359static int check_one_conflict(int i, int *type)
360{
361 const struct cache_entry *e = active_cache[i];
362
363 if (!ce_stage(e)) {
364 *type = RESOLVED;
365 return i + 1;
366 }
367
368 *type = PUNTED;
369 while (ce_stage(active_cache[i]) == 1)
370 i++;
371
372 /* Only handle regular files with both stages #2 and #3 */
373 if (i + 1 < active_nr) {
374 const struct cache_entry *e2 = active_cache[i];
375 const struct cache_entry *e3 = active_cache[i + 1];
376 if (ce_stage(e2) == 2 &&
377 ce_stage(e3) == 3 &&
378 ce_same_name(e, e3) &&
379 S_ISREG(e2->ce_mode) &&
380 S_ISREG(e3->ce_mode))
381 *type = THREE_STAGED;
382 }
383
384 /* Skip the entries with the same name */
385 while (i < active_nr && ce_same_name(e, active_cache[i]))
386 i++;
387 return i;
388}
389
390static int find_conflict(struct string_list *conflict)
391{
392 int i;
393 if (read_cache() < 0)
394 return error("Could not read index");
395
396 for (i = 0; i < active_nr;) {
397 int conflict_type;
398 const struct cache_entry *e = active_cache[i];
399 i = check_one_conflict(i, &conflict_type);
400 if (conflict_type == THREE_STAGED)
401 string_list_insert(conflict, (const char *)e->name);
402 }
403 return 0;
404}
405
406int rerere_remaining(struct string_list *merge_rr)
407{
408 int i;
409 if (read_cache() < 0)
410 return error("Could not read index");
411
412 for (i = 0; i < active_nr;) {
413 int conflict_type;
414 const struct cache_entry *e = active_cache[i];
415 i = check_one_conflict(i, &conflict_type);
416 if (conflict_type == PUNTED)
417 string_list_insert(merge_rr, (const char *)e->name);
418 else if (conflict_type == RESOLVED) {
419 struct string_list_item *it;
420 it = string_list_lookup(merge_rr, (const char *)e->name);
421 if (it != NULL) {
422 free(it->util);
423 it->util = RERERE_RESOLVED;
424 }
425 }
426 }
427 return 0;
428}
429
430static int merge(const char *name, const char *path)
431{
432 int ret;
433 mmfile_t cur = {NULL, 0}, base = {NULL, 0}, other = {NULL, 0};
434 mmbuffer_t result = {NULL, 0};
435
436 if (handle_file(path, NULL, rerere_path(name, "thisimage")) < 0)
437 return 1;
438
439 if (read_mmfile(&cur, rerere_path(name, "thisimage")) ||
440 read_mmfile(&base, rerere_path(name, "preimage")) ||
441 read_mmfile(&other, rerere_path(name, "postimage"))) {
442 ret = 1;
443 goto out;
444 }
445 ret = ll_merge(&result, path, &base, NULL, &cur, "", &other, "", NULL);
446 if (!ret) {
447 FILE *f;
448
449 if (utime(rerere_path(name, "postimage"), NULL) < 0)
450 warning("failed utime() on %s: %s",
451 rerere_path(name, "postimage"),
452 strerror(errno));
453 f = fopen(path, "w");
454 if (!f)
455 return error("Could not open %s: %s", path,
456 strerror(errno));
457 if (fwrite(result.ptr, result.size, 1, f) != 1)
458 error("Could not write %s: %s", path, strerror(errno));
459 if (fclose(f))
460 return error("Writing %s failed: %s", path,
461 strerror(errno));
462 }
463
464out:
465 free(cur.ptr);
466 free(base.ptr);
467 free(other.ptr);
468 free(result.ptr);
469
470 return ret;
471}
472
473static struct lock_file index_lock;
474
475static void update_paths(struct string_list *update)
476{
477 int i;
478
479 hold_locked_index(&index_lock, 1);
480
481 for (i = 0; i < update->nr; i++) {
482 struct string_list_item *item = &update->items[i];
483 if (add_file_to_cache(item->string, 0))
484 exit(128);
485 fprintf(stderr, "Staged '%s' using previous resolution.\n",
486 item->string);
487 }
488
489 if (active_cache_changed) {
490 if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
491 die("Unable to write new index file");
492 } else
493 rollback_lock_file(&index_lock);
494}
495
496static int do_plain_rerere(struct string_list *rr, int fd)
497{
498 struct string_list conflict = STRING_LIST_INIT_DUP;
499 struct string_list update = STRING_LIST_INIT_DUP;
500 int i;
501
502 find_conflict(&conflict);
503
504 /*
505 * MERGE_RR records paths with conflicts immediately after merge
506 * failed. Some of the conflicted paths might have been hand resolved
507 * in the working tree since then, but the initial run would catch all
508 * and register their preimages.
509 */
510
511 for (i = 0; i < conflict.nr; i++) {
512 const char *path = conflict.items[i].string;
513 if (!string_list_has_string(rr, path)) {
514 unsigned char sha1[20];
515 char *hex;
516 int ret;
517 ret = handle_file(path, sha1, NULL);
518 if (ret < 1)
519 continue;
520 hex = xstrdup(sha1_to_hex(sha1));
521 string_list_insert(rr, path)->util = hex;
522 if (mkdir_in_gitdir(git_path("rr-cache/%s", hex)))
523 continue;
524 handle_file(path, NULL, rerere_path(hex, "preimage"));
525 fprintf(stderr, "Recorded preimage for '%s'\n", path);
526 }
527 }
528
529 /*
530 * Now some of the paths that had conflicts earlier might have been
531 * hand resolved. Others may be similar to a conflict already that
532 * was resolved before.
533 */
534
535 for (i = 0; i < rr->nr; i++) {
536 int ret;
537 const char *path = rr->items[i].string;
538 const char *name = (const char *)rr->items[i].util;
539
540 if (has_rerere_resolution(name)) {
541 if (merge(name, path))
542 continue;
543
544 if (rerere_autoupdate)
545 string_list_insert(&update, path);
546 else
547 fprintf(stderr,
548 "Resolved '%s' using previous resolution.\n",
549 path);
550 goto mark_resolved;
551 }
552
553 /* Let's see if we have resolved it. */
554 ret = handle_file(path, NULL, NULL);
555 if (ret)
556 continue;
557
558 fprintf(stderr, "Recorded resolution for '%s'.\n", path);
559 copy_file(rerere_path(name, "postimage"), path, 0666);
560 mark_resolved:
561 free(rr->items[i].util);
562 rr->items[i].util = NULL;
563 }
564
565 if (update.nr)
566 update_paths(&update);
567
568 return write_rr(rr, fd);
569}
570
571static void git_rerere_config(void)
572{
573 git_config_get_bool("rerere.enabled", &rerere_enabled);
574 git_config_get_bool("rerere.autoupdate", &rerere_autoupdate);
575 git_config(git_default_config, NULL);
576}
577
578static int is_rerere_enabled(void)
579{
580 const char *rr_cache;
581 int rr_cache_exists;
582
583 if (!rerere_enabled)
584 return 0;
585
586 rr_cache = git_path("rr-cache");
587 rr_cache_exists = is_directory(rr_cache);
588 if (rerere_enabled < 0)
589 return rr_cache_exists;
590
591 if (!rr_cache_exists && mkdir_in_gitdir(rr_cache))
592 die("Could not create directory %s", rr_cache);
593 return 1;
594}
595
596int setup_rerere(struct string_list *merge_rr, int flags)
597{
598 int fd;
599
600 git_rerere_config();
601 if (!is_rerere_enabled())
602 return -1;
603
604 if (flags & (RERERE_AUTOUPDATE|RERERE_NOAUTOUPDATE))
605 rerere_autoupdate = !!(flags & RERERE_AUTOUPDATE);
606 merge_rr_path = git_pathdup("MERGE_RR");
607 fd = hold_lock_file_for_update(&write_lock, merge_rr_path,
608 LOCK_DIE_ON_ERROR);
609 read_rr(merge_rr);
610 return fd;
611}
612
613int rerere(int flags)
614{
615 struct string_list merge_rr = STRING_LIST_INIT_DUP;
616 int fd;
617
618 fd = setup_rerere(&merge_rr, flags);
619 if (fd < 0)
620 return 0;
621 return do_plain_rerere(&merge_rr, fd);
622}
623
624static int rerere_forget_one_path(const char *path, struct string_list *rr)
625{
626 const char *filename;
627 char *hex;
628 unsigned char sha1[20];
629 int ret;
630 struct string_list_item *item;
631
632 ret = handle_cache(path, sha1, NULL);
633 if (ret < 1)
634 return error("Could not parse conflict hunks in '%s'", path);
635 hex = xstrdup(sha1_to_hex(sha1));
636 filename = rerere_path(hex, "postimage");
637 if (unlink(filename))
638 return (errno == ENOENT
639 ? error("no remembered resolution for %s", path)
640 : error("cannot unlink %s: %s", filename, strerror(errno)));
641
642 handle_cache(path, sha1, rerere_path(hex, "preimage"));
643 fprintf(stderr, "Updated preimage for '%s'\n", path);
644
645 item = string_list_insert(rr, path);
646 free(item->util);
647 item->util = hex;
648 fprintf(stderr, "Forgot resolution for %s\n", path);
649 return 0;
650}
651
652int rerere_forget(struct pathspec *pathspec)
653{
654 int i, fd;
655 struct string_list conflict = STRING_LIST_INIT_DUP;
656 struct string_list merge_rr = STRING_LIST_INIT_DUP;
657
658 if (read_cache() < 0)
659 return error("Could not read index");
660
661 fd = setup_rerere(&merge_rr, RERERE_NOAUTOUPDATE);
662
663 unmerge_cache(pathspec);
664 find_conflict(&conflict);
665 for (i = 0; i < conflict.nr; i++) {
666 struct string_list_item *it = &conflict.items[i];
667 if (!match_pathspec(pathspec, it->string,
668 strlen(it->string), 0, NULL, 0))
669 continue;
670 rerere_forget_one_path(it->string, &merge_rr);
671 }
672 return write_rr(&merge_rr, fd);
673}
674
675static time_t rerere_created_at(const char *name)
676{
677 struct stat st;
678 return stat(rerere_path(name, "preimage"), &st) ? (time_t) 0 : st.st_mtime;
679}
680
681static time_t rerere_last_used_at(const char *name)
682{
683 struct stat st;
684 return stat(rerere_path(name, "postimage"), &st) ? (time_t) 0 : st.st_mtime;
685}
686
687static void unlink_rr_item(const char *name)
688{
689 unlink(rerere_path(name, "thisimage"));
690 unlink(rerere_path(name, "preimage"));
691 unlink(rerere_path(name, "postimage"));
692 rmdir(git_path("rr-cache/%s", name));
693}
694
695void rerere_gc(struct string_list *rr)
696{
697 struct string_list to_remove = STRING_LIST_INIT_DUP;
698 DIR *dir;
699 struct dirent *e;
700 int i, cutoff;
701 time_t now = time(NULL), then;
702 int cutoff_noresolve = 15;
703 int cutoff_resolve = 60;
704
705 git_config_get_int("gc.rerereresolved", &cutoff_resolve);
706 git_config_get_int("gc.rerereunresolved", &cutoff_noresolve);
707 git_config(git_default_config, NULL);
708 dir = opendir(git_path("rr-cache"));
709 if (!dir)
710 die_errno("unable to open rr-cache directory");
711 while ((e = readdir(dir))) {
712 if (is_dot_or_dotdot(e->d_name))
713 continue;
714
715 then = rerere_last_used_at(e->d_name);
716 if (then) {
717 cutoff = cutoff_resolve;
718 } else {
719 then = rerere_created_at(e->d_name);
720 if (!then)
721 continue;
722 cutoff = cutoff_noresolve;
723 }
724 if (then < now - cutoff * 86400)
725 string_list_append(&to_remove, e->d_name);
726 }
727 closedir(dir);
728 for (i = 0; i < to_remove.nr; i++)
729 unlink_rr_item(to_remove.items[i].string);
730 string_list_clear(&to_remove, 0);
731}
732
733void rerere_clear(struct string_list *merge_rr)
734{
735 int i;
736
737 for (i = 0; i < merge_rr->nr; i++) {
738 const char *name = (const char *)merge_rr->items[i].util;
739 if (!has_rerere_resolution(name))
740 unlink_rr_item(name);
741 }
742 unlink_or_warn(git_path("MERGE_RR"));
743}