rerere.c 31.1 KB
Newer Older
1
#include "cache.h"
2
#include "config.h"
3
#include "lockfile.h"
4
#include "string-list.h"
5 6
#include "rerere.h"
#include "xdiff-interface.h"
7 8 9
#include "dir.h"
#include "resolve-undo.h"
#include "ll-merge.h"
10
#include "attr.h"
11
#include "pathspec.h"
12
#include "sha1-lookup.h"
13

Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
14 15 16 17 18
#define RESOLVED 0
#define PUNTED 1
#define THREE_STAGED 2
void *RERERE_RESOLVED = &RERERE_RESOLVED;

19 20 21 22 23 24
/* if rerere_enabled == -1, fall back to detection of .git/rr-cache */
static int rerere_enabled = -1;

/* automatically update cleanly resolved paths to the index */
static int rerere_autoupdate;

25 26 27
static int rerere_dir_nr;
static int rerere_dir_alloc;

28 29
#define RR_HAS_POSTIMAGE 1
#define RR_HAS_PREIMAGE 2
30 31
static struct rerere_dir {
	unsigned char sha1[20];
32 33
	int status_alloc, status_nr;
	unsigned char *status;
34 35 36 37 38
} **rerere_dir;

static void free_rerere_dirs(void)
{
	int i;
39 40
	for (i = 0; i < rerere_dir_nr; i++) {
		free(rerere_dir[i]->status);
41
		free(rerere_dir[i]);
42
	}
43
	FREE_AND_NULL(rerere_dir);
44 45 46
	rerere_dir_nr = rerere_dir_alloc = 0;
}

47
static void free_rerere_id(struct string_list_item *item)
48
{
49
	free(item->util);
50 51
}

52 53
static const char *rerere_id_hex(const struct rerere_id *id)
{
54
	return sha1_to_hex(id->collection->sha1);
55 56
}

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
static void fit_variant(struct rerere_dir *rr_dir, int variant)
{
	variant++;
	ALLOC_GROW(rr_dir->status, variant, rr_dir->status_alloc);
	if (rr_dir->status_nr < variant) {
		memset(rr_dir->status + rr_dir->status_nr,
		       '\0', variant - rr_dir->status_nr);
		rr_dir->status_nr = variant;
	}
}

static void assign_variant(struct rerere_id *id)
{
	int variant;
	struct rerere_dir *rr_dir = id->collection;

	variant = id->variant;
	if (variant < 0) {
75 76 77
		for (variant = 0; variant < rr_dir->status_nr; variant++)
			if (!rr_dir->status[variant])
				break;
78 79 80
	}
	fit_variant(rr_dir, variant);
	id->variant = variant;
81 82 83 84 85 86 87
}

const char *rerere_path(const struct rerere_id *id, const char *file)
{
	if (!file)
		return git_path("rr-cache/%s", rerere_id_hex(id));

88 89 90 91 92
	if (id->variant <= 0)
		return git_path("rr-cache/%s/%s", rerere_id_hex(id), file);

	return git_path("rr-cache/%s/%s.%d",
			rerere_id_hex(id), file, id->variant);
93 94
}

95
static int is_rr_file(const char *name, const char *filename, int *variant)
96
{
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
	const char *suffix;
	char *ep;

	if (!strcmp(name, filename)) {
		*variant = 0;
		return 1;
	}
	if (!skip_prefix(name, filename, &suffix) || *suffix != '.')
		return 0;

	errno = 0;
	*variant = strtol(suffix + 1, &ep, 10);
	if (errno || *ep)
		return 0;
	return 1;
112 113 114 115 116 117 118 119 120 121
}

static void scan_rerere_dir(struct rerere_dir *rr_dir)
{
	struct dirent *de;
	DIR *dir = opendir(git_path("rr-cache/%s", sha1_to_hex(rr_dir->sha1)));

	if (!dir)
		return;
	while ((de = readdir(dir)) != NULL) {
122 123 124 125 126 127 128 129 130
		int variant;

		if (is_rr_file(de->d_name, "postimage", &variant)) {
			fit_variant(rr_dir, variant);
			rr_dir->status[variant] |= RR_HAS_POSTIMAGE;
		} else if (is_rr_file(de->d_name, "preimage", &variant)) {
			fit_variant(rr_dir, variant);
			rr_dir->status[variant] |= RR_HAS_PREIMAGE;
		}
131 132 133 134
	}
	closedir(dir);
}

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
static const unsigned char *rerere_dir_sha1(size_t i, void *table)
{
	struct rerere_dir **rr_dir = table;
	return rr_dir[i]->sha1;
}

static struct rerere_dir *find_rerere_dir(const char *hex)
{
	unsigned char sha1[20];
	struct rerere_dir *rr_dir;
	int pos;

	if (get_sha1_hex(hex, sha1))
		return NULL; /* BUG */
	pos = sha1_pos(sha1, rerere_dir, rerere_dir_nr, rerere_dir_sha1);
	if (pos < 0) {
		rr_dir = xmalloc(sizeof(*rr_dir));
		hashcpy(rr_dir->sha1, sha1);
153 154 155
		rr_dir->status = NULL;
		rr_dir->status_nr = 0;
		rr_dir->status_alloc = 0;
156 157 158 159 160 161
		pos = -1 - pos;

		/* Make sure the array is big enough ... */
		ALLOC_GROW(rerere_dir, rerere_dir_nr + 1, rerere_dir_alloc);
		/* ... and add it in. */
		rerere_dir_nr++;
Gábor Szeder's avatar
Gábor Szeder committed
162 163
		MOVE_ARRAY(rerere_dir + pos + 1, rerere_dir + pos,
			   rerere_dir_nr - pos - 1);
164
		rerere_dir[pos] = rr_dir;
165
		scan_rerere_dir(rr_dir);
166 167
	}
	return rerere_dir[pos];
168 169
}

170
static int has_rerere_resolution(const struct rerere_id *id)
171
{
172
	const int both = RR_HAS_POSTIMAGE|RR_HAS_PREIMAGE;
173
	int variant = id->variant;
174

175 176 177
	if (variant < 0)
		return 0;
	return ((id->collection->status[variant] & both) == both);
178 179
}

180 181 182
static struct rerere_id *new_rerere_id_hex(char *hex)
{
	struct rerere_id *id = xmalloc(sizeof(*id));
183
	id->collection = find_rerere_dir(hex);
184
	id->variant = -1; /* not known yet */
185 186 187 188 189 190
	return id;
}

static struct rerere_id *new_rerere_id(unsigned char *sha1)
{
	return new_rerere_id_hex(sha1_to_hex(sha1));
191 192
}

193 194 195 196 197 198 199
/*
 * $GIT_DIR/MERGE_RR file is a collection of records, each of which is
 * "conflict ID", a HT and pathname, terminated with a NUL, and is
 * used to keep track of the set of paths that "rerere" may need to
 * work on (i.e. what is left by the previous invocation of "git
 * rerere" during the current conflict resolution session).
 */
200
static void read_rr(struct string_list *rr)
201
{
202
	struct strbuf buf = STRBUF_INIT;
203
	FILE *in = fopen_or_warn(git_path_merge_rr(), "r");
204

205 206
	if (!in)
		return;
207 208 209
	while (!strbuf_getwholeline(&buf, in, '\0')) {
		char *path;
		unsigned char sha1[20];
210
		struct rerere_id *id;
211
		int variant;
212 213 214

		/* There has to be the hash, tab, path and then NUL */
		if (buf.len < 42 || get_sha1_hex(buf.buf, sha1))
215
			die("corrupt MERGE_RR");
216

217 218 219 220 221 222 223 224 225 226
		if (buf.buf[40] != '.') {
			variant = 0;
			path = buf.buf + 40;
		} else {
			errno = 0;
			variant = strtol(buf.buf + 41, &path, 10);
			if (errno)
				die("corrupt MERGE_RR");
		}
		if (*(path++) != '\t')
227
			die("corrupt MERGE_RR");
228
		buf.buf[40] = '\0';
229
		id = new_rerere_id_hex(buf.buf);
230
		id->variant = variant;
231
		string_list_insert(rr, path)->util = id;
232
	}
233
	strbuf_release(&buf);
234 235 236 237 238
	fclose(in);
}

static struct lock_file write_lock;

239
static int write_rr(struct string_list *rr, int out_fd)
240 241 242
{
	int i;
	for (i = 0; i < rr->nr; i++) {
243
		struct strbuf buf = STRBUF_INIT;
244
		struct rerere_id *id;
245 246

		assert(rr->items[i].util != RERERE_RESOLVED);
247 248 249

		id = rr->items[i].util;
		if (!id)
250
			continue;
251 252 253 254 255 256 257 258 259 260
		assert(id->variant >= 0);
		if (0 < id->variant)
			strbuf_addf(&buf, "%s.%d\t%s%c",
				    rerere_id_hex(id), id->variant,
				    rr->items[i].string, 0);
		else
			strbuf_addf(&buf, "%s\t%s%c",
				    rerere_id_hex(id),
				    rr->items[i].string, 0);

261
		if (write_in_full(out_fd, buf.buf, buf.len) < 0)
262
			die("unable to write rerere record");
263 264

		strbuf_release(&buf);
265 266 267 268 269 270
	}
	if (commit_lock_file(&write_lock) != 0)
		die("unable to write rerere record");
	return 0;
}

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
/*
 * "rerere" interacts with conflicted file contents using this I/O
 * abstraction.  It reads a conflicted contents from one place via
 * "getline()" method, and optionally can write it out after
 * normalizing the conflicted hunks to the "output".  Subclasses of
 * rerere_io embed this structure at the beginning of their own
 * rerere_io object.
 */
struct rerere_io {
	int (*getline)(struct strbuf *, struct rerere_io *);
	FILE *output;
	int wrerror;
	/* some more stuff */
};

286 287 288 289 290 291 292 293 294 295 296 297 298
static void ferr_write(const void *p, size_t count, FILE *fp, int *err)
{
	if (!count || *err)
		return;
	if (fwrite(p, count, 1, fp) != 1)
		*err = errno;
}

static inline void ferr_puts(const char *s, FILE *fp, int *err)
{
	ferr_write(s, strlen(s), fp, err);
}

299 300 301 302 303 304
static void rerere_io_putstr(const char *str, struct rerere_io *io)
{
	if (io->output)
		ferr_puts(str, io->output, &io->wrerror);
}

305 306 307
/*
 * Write a conflict marker to io->output (if defined).
 */
308 309 310 311 312
static void rerere_io_putconflict(int ch, int size, struct rerere_io *io)
{
	char buf[64];

	while (size) {
313
		if (size <= sizeof(buf) - 2) {
314 315 316 317 318 319
			memset(buf, ch, size);
			buf[size] = '\n';
			buf[size + 1] = '\0';
			size = 0;
		} else {
			int sz = sizeof(buf) - 1;
320 321 322 323 324 325 326

			/*
			 * Make sure we will not write everything out
			 * in this round by leaving at least 1 byte
			 * for the next round, giving the next round
			 * a chance to add the terminating LF.  Yuck.
			 */
327 328 329 330 331 332 333 334 335 336
			if (size <= sz)
				sz -= (sz - size) + 1;
			memset(buf, ch, sz);
			buf[sz] = '\0';
			size -= sz;
		}
		rerere_io_putstr(buf, io);
	}
}

337 338 339 340 341 342
static void rerere_io_putmem(const char *mem, size_t sz, struct rerere_io *io)
{
	if (io->output)
		ferr_write(mem, sz, io->output, &io->wrerror);
}

343 344 345
/*
 * Subclass of rerere_io that reads from an on-disk file
 */
346 347 348 349 350
struct rerere_io_file {
	struct rerere_io io;
	FILE *input;
};

351 352 353
/*
 * ... and its getline() method implementation
 */
354 355 356 357 358 359
static int rerere_file_getline(struct strbuf *sb, struct rerere_io *io_)
{
	struct rerere_io_file *io = (struct rerere_io_file *)io_;
	return strbuf_getwholeline(sb, io->input, '\n');
}

360 361 362 363 364 365
/*
 * Require the exact number of conflict marker letters, no more, no
 * less, followed by SP or any whitespace
 * (including LF).
 */
static int is_cmarker(char *buf, int marker_char, int marker_size)
366
{
367 368 369 370 371 372 373 374 375 376 377 378
	int want_sp;

	/*
	 * The beginning of our version and the end of their version
	 * always are labeled like "<<<<< ours" or ">>>>> theirs",
	 * hence we set want_sp for them.  Note that the version from
	 * the common ancestor in diff3-style output is not always
	 * labelled (e.g. "||||| common" is often seen but "|||||"
	 * alone is also valid), so we do not set want_sp.
	 */
	want_sp = (marker_char == '<') || (marker_char == '>');

379 380 381 382 383 384 385 386
	while (marker_size--)
		if (*buf++ != marker_char)
			return 0;
	if (want_sp && *buf != ' ')
		return 0;
	return isspace(*buf);
}

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
/*
 * Read contents a file with conflicts, normalize the conflicts
 * by (1) discarding the common ancestor version in diff3-style,
 * (2) reordering our side and their side so that whichever sorts
 * alphabetically earlier comes before the other one, while
 * computing the "conflict ID", which is just an SHA-1 hash of
 * one side of the conflict, NUL, the other side of the conflict,
 * and NUL concatenated together.
 *
 * Return the number of conflict hunks found.
 *
 * NEEDSWORK: the logic and theory of operation behind this conflict
 * normalization may deserve to be documented somewhere, perhaps in
 * Documentation/technical/rerere.txt.
 */
402
static int handle_path(unsigned char *sha1, struct rerere_io *io, int marker_size)
403
{
404
	git_SHA_CTX ctx;
405 406
	int hunk_no = 0;
	enum {
407
		RR_CONTEXT = 0, RR_SIDE_1, RR_SIDE_2, RR_ORIGINAL
408
	} hunk = RR_CONTEXT;
409
	struct strbuf one = STRBUF_INIT, two = STRBUF_INIT;
410
	struct strbuf buf = STRBUF_INIT;
411 412

	if (sha1)
413
		git_SHA1_Init(&ctx);
414

415
	while (!io->getline(&buf, io)) {
416
		if (is_cmarker(buf.buf, '<', marker_size)) {
417
			if (hunk != RR_CONTEXT)
418
				goto bad;
419
			hunk = RR_SIDE_1;
420
		} else if (is_cmarker(buf.buf, '|', marker_size)) {
421
			if (hunk != RR_SIDE_1)
422
				goto bad;
423
			hunk = RR_ORIGINAL;
424
		} else if (is_cmarker(buf.buf, '=', marker_size)) {
425
			if (hunk != RR_SIDE_1 && hunk != RR_ORIGINAL)
426
				goto bad;
427
			hunk = RR_SIDE_2;
428
		} else if (is_cmarker(buf.buf, '>', marker_size)) {
429
			if (hunk != RR_SIDE_2)
430 431 432 433
				goto bad;
			if (strbuf_cmp(&one, &two) > 0)
				strbuf_swap(&one, &two);
			hunk_no++;
434
			hunk = RR_CONTEXT;
435
			rerere_io_putconflict('<', marker_size, io);
436
			rerere_io_putmem(one.buf, one.len, io);
437
			rerere_io_putconflict('=', marker_size, io);
438
			rerere_io_putmem(two.buf, two.len, io);
439
			rerere_io_putconflict('>', marker_size, io);
440
			if (sha1) {
441
				git_SHA1_Update(&ctx, one.buf ? one.buf : "",
442
					    one.len + 1);
443
				git_SHA1_Update(&ctx, two.buf ? two.buf : "",
444 445 446 447
					    two.len + 1);
			}
			strbuf_reset(&one);
			strbuf_reset(&two);
448
		} else if (hunk == RR_SIDE_1)
449
			strbuf_addbuf(&one, &buf);
450 451
		else if (hunk == RR_ORIGINAL)
			; /* discard */
452
		else if (hunk == RR_SIDE_2)
453
			strbuf_addbuf(&two, &buf);
454 455
		else
			rerere_io_putstr(buf.buf, io);
456 457 458 459 460 461 462
		continue;
	bad:
		hunk = 99; /* force error exit */
		break;
	}
	strbuf_release(&one);
	strbuf_release(&two);
463
	strbuf_release(&buf);
464 465

	if (sha1)
466
		git_SHA1_Final(sha1, &ctx);
467 468 469 470 471
	if (hunk != RR_CONTEXT)
		return -1;
	return hunk_no;
}

472 473 474 475
/*
 * Scan the path for conflicts, do the "handle_path()" thing above, and
 * return the number of conflict hunks found.
 */
476 477 478 479
static int handle_file(const char *path, unsigned char *sha1, const char *output)
{
	int hunk_no = 0;
	struct rerere_io_file io;
480
	int marker_size = ll_merge_marker_size(path);
481 482 483 484 485 486

	memset(&io, 0, sizeof(io));
	io.io.getline = rerere_file_getline;
	io.input = fopen(path, "r");
	io.io.wrerror = 0;
	if (!io.input)
487
		return error_errno("Could not open %s", path);
488 489 490 491

	if (output) {
		io.io.output = fopen(output, "w");
		if (!io.io.output) {
492
			error_errno("Could not write %s", output);
493
			fclose(io.input);
494
			return -1;
495 496 497
		}
	}

498
	hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
499 500 501 502 503 504

	fclose(io.input);
	if (io.io.wrerror)
		error("There were errors while writing %s (%s)",
		      path, strerror(io.io.wrerror));
	if (io.io.output && fclose(io.io.output))
505
		io.io.wrerror = error_errno("Failed to flush %s", path);
506 507

	if (hunk_no < 0) {
508
		if (output)
509
			unlink_or_warn(output);
510 511
		return error("Could not parse conflict hunks in %s", path);
	}
512
	if (io.io.wrerror)
513
		return -1;
514 515 516
	return hunk_no;
}

517 518 519 520 521 522 523 524
/*
 * Look at a cache entry at "i" and see if it is not conflicting,
 * conflicting and we are willing to handle, or conflicting and
 * we are unable to handle, and return the determination in *type.
 * Return the cache index to be looked at next, by skipping the
 * stages we have already looked at in this invocation of this
 * function.
 */
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
525
static int check_one_conflict(int i, int *type)
526
{
527
	const struct cache_entry *e = active_cache[i];
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
528 529 530 531 532 533 534

	if (!ce_stage(e)) {
		*type = RESOLVED;
		return i + 1;
	}

	*type = PUNTED;
535
	while (ce_stage(active_cache[i]) == 1)
536
		i++;
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
537 538 539

	/* Only handle regular files with both stages #2 and #3 */
	if (i + 1 < active_nr) {
540 541
		const struct cache_entry *e2 = active_cache[i];
		const struct cache_entry *e3 = active_cache[i + 1];
542 543
		if (ce_stage(e2) == 2 &&
		    ce_stage(e3) == 3 &&
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
544
		    ce_same_name(e, e3) &&
545
		    S_ISREG(e2->ce_mode) &&
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
546 547 548 549 550 551 552 553 554 555
		    S_ISREG(e3->ce_mode))
			*type = THREE_STAGED;
	}

	/* Skip the entries with the same name */
	while (i < active_nr && ce_same_name(e, active_cache[i]))
		i++;
	return i;
}

556 557 558 559 560 561 562 563 564 565 566
/*
 * Scan the index and find paths that have conflicts that rerere can
 * handle, i.e. the ones that has both stages #2 and #3.
 *
 * NEEDSWORK: we do not record or replay a previous "resolve by
 * deletion" for a delete-modify conflict, as that is inherently risky
 * without knowing what modification is being discarded.  The only
 * safe case, i.e. both side doing the deletion and modification that
 * are identical to the previous round, might want to be handled,
 * though.
 */
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
567 568 569 570 571 572 573 574
static int find_conflict(struct string_list *conflict)
{
	int i;
	if (read_cache() < 0)
		return error("Could not read index");

	for (i = 0; i < active_nr;) {
		int conflict_type;
575
		const struct cache_entry *e = active_cache[i];
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
576 577 578 579 580 581 582
		i = check_one_conflict(i, &conflict_type);
		if (conflict_type == THREE_STAGED)
			string_list_insert(conflict, (const char *)e->name);
	}
	return 0;
}

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
/*
 * The merge_rr list is meant to hold outstanding conflicted paths
 * that rerere could handle.  Abuse the list by adding other types of
 * entries to allow the caller to show "rerere remaining".
 *
 * - Conflicted paths that rerere does not handle are added
 * - Conflicted paths that have been resolved are marked as such
 *   by storing RERERE_RESOLVED to .util field (where conflict ID
 *   is expected to be stored).
 *
 * Do *not* write MERGE_RR file out after calling this function.
 *
 * NEEDSWORK: we may want to fix the caller that implements "rerere
 * remaining" to do this without abusing merge_rr.
 */
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
598 599 600
int rerere_remaining(struct string_list *merge_rr)
{
	int i;
601 602
	if (setup_rerere(merge_rr, RERERE_READONLY))
		return 0;
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
603 604 605 606 607
	if (read_cache() < 0)
		return error("Could not read index");

	for (i = 0; i < active_nr;) {
		int conflict_type;
608
		const struct cache_entry *e = active_cache[i];
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
609 610 611 612 613 614 615
		i = check_one_conflict(i, &conflict_type);
		if (conflict_type == PUNTED)
			string_list_insert(merge_rr, (const char *)e->name);
		else if (conflict_type == RESOLVED) {
			struct string_list_item *it;
			it = string_list_lookup(merge_rr, (const char *)e->name);
			if (it != NULL) {
616
				free_rerere_id(it);
Martin von Zweigbergk's avatar
Martin von Zweigbergk committed
617 618
				it->util = RERERE_RESOLVED;
			}
619 620 621 622 623
		}
	}
	return 0;
}

624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
/*
 * Try using the given conflict resolution "ID" to see
 * if that recorded conflict resolves cleanly what we
 * got in the "cur".
 */
static int try_merge(const struct rerere_id *id, const char *path,
		     mmfile_t *cur, mmbuffer_t *result)
{
	int ret;
	mmfile_t base = {NULL, 0}, other = {NULL, 0};

	if (read_mmfile(&base, rerere_path(id, "preimage")) ||
	    read_mmfile(&other, rerere_path(id, "postimage")))
		ret = 1;
	else
		/*
		 * A three-way merge. Note that this honors user-customizable
		 * low-level merge driver settings.
		 */
		ret = ll_merge(result, path, &base, NULL, cur, "", &other, "", NULL);

	free(base.ptr);
	free(other.ptr);

	return ret;
}

651
/*
652
 * Find the conflict identified by "id"; the change between its
653 654 655 656 657 658 659 660
 * "preimage" (i.e. a previous contents with conflict markers) and its
 * "postimage" (i.e. the corresponding contents with conflicts
 * resolved) may apply cleanly to the contents stored in "path", i.e.
 * the conflict this time around.
 *
 * Returns 0 for successful replay of recorded resolution, or non-zero
 * for failure.
 */
661
static int merge(const struct rerere_id *id, const char *path)
662
{
663
	FILE *f;
664
	int ret;
665
	mmfile_t cur = {NULL, 0};
666 667
	mmbuffer_t result = {NULL, 0};

668 669 670 671
	/*
	 * Normalize the conflicts in path and write it out to
	 * "thisimage" temporary file.
	 */
672 673
	if ((handle_file(path, NULL, rerere_path(id, "thisimage")) < 0) ||
	    read_mmfile(&cur, rerere_path(id, "thisimage"))) {
674 675 676
		ret = 1;
		goto out;
	}
677

678
	ret = try_merge(id, path, &cur, &result);
679 680 681 682 683 684 685 686
	if (ret)
		goto out;

	/*
	 * A successful replay of recorded resolution.
	 * Mark that "postimage" was used to help gc.
	 */
	if (utime(rerere_path(id, "postimage"), NULL) < 0)
687 688
		warning_errno("failed utime() on %s",
			      rerere_path(id, "postimage"));
689 690 691 692

	/* Update "path" with the resolution */
	f = fopen(path, "w");
	if (!f)
693
		return error_errno("Could not open %s", path);
694
	if (fwrite(result.ptr, result.size, 1, f) != 1)
695
		error_errno("Could not write %s", path);
696
	if (fclose(f))
697
		return error_errno("Writing %s failed", path);
698

699
out:
700 701 702 703 704 705 706 707
	free(cur.ptr);
	free(result.ptr);

	return ret;
}

static struct lock_file index_lock;

708
static void update_paths(struct string_list *update)
709 710 711
{
	int i;

712
	hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
713 714

	for (i = 0; i < update->nr; i++) {
715
		struct string_list_item *item = &update->items[i];
716 717
		if (add_file_to_cache(item->string, 0))
			exit(128);
718 719
		fprintf(stderr, "Staged '%s' using previous resolution.\n",
			item->string);
720 721
	}

722
	if (active_cache_changed) {
723
		if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
724
			die("Unable to write new index file");
725
	} else
726 727 728
		rollback_lock_file(&index_lock);
}

729 730 731 732 733 734 735
static void remove_variant(struct rerere_id *id)
{
	unlink_or_warn(rerere_path(id, "postimage"));
	unlink_or_warn(rerere_path(id, "preimage"));
	id->collection->status[id->variant] = 0;
}

736 737 738 739 740 741 742 743 744 745 746
/*
 * The path indicated by rr_item may still have conflict for which we
 * have a recorded resolution, in which case replay it and optionally
 * update it.  Or it may have been resolved by the user and we may
 * only have the preimage for that conflict, in which case the result
 * needs to be recorded as a resolution in a postimage file.
 */
static void do_rerere_one_path(struct string_list_item *rr_item,
			       struct string_list *update)
{
	const char *path = rr_item->string;
747
	struct rerere_id *id = rr_item->util;
748
	struct rerere_dir *rr_dir = id->collection;
749 750 751
	int variant;

	variant = id->variant;
752

753 754 755 756 757 758 759 760 761 762
	/* Has the user resolved it already? */
	if (variant >= 0) {
		if (!handle_file(path, NULL, NULL)) {
			copy_file(rerere_path(id, "postimage"), path, 0666);
			id->collection->status[variant] |= RR_HAS_POSTIMAGE;
			fprintf(stderr, "Recorded resolution for '%s'.\n", path);
			free_rerere_id(rr_item);
			rr_item->util = NULL;
			return;
		}
763
		/*
764 765 766
		 * There may be other variants that can cleanly
		 * replay.  Try them and update the variant number for
		 * this one.
767
		 */
768 769 770 771 772 773 774 775 776
	}

	/* Does any existing resolution apply cleanly? */
	for (variant = 0; variant < rr_dir->status_nr; variant++) {
		const int both = RR_HAS_PREIMAGE | RR_HAS_POSTIMAGE;
		struct rerere_id vid = *id;

		if ((rr_dir->status[variant] & both) != both)
			continue;
777

778 779 780 781 782 783 784 785 786 787
		vid.variant = variant;
		if (merge(&vid, path))
			continue; /* failed to replay */

		/*
		 * If there already is a different variant that applies
		 * cleanly, there is no point maintaining our own variant.
		 */
		if (0 <= id->variant && id->variant != variant)
			remove_variant(id);
788 789 790 791 792 793 794

		if (rerere_autoupdate)
			string_list_insert(update, path);
		else
			fprintf(stderr,
				"Resolved '%s' using previous resolution.\n",
				path);
795 796
		free_rerere_id(rr_item);
		rr_item->util = NULL;
797
		return;
798
	}
799 800 801 802 803 804 805 806 807 808 809 810 811 812

	/* None of the existing one applies; we need a new variant */
	assign_variant(id);

	variant = id->variant;
	handle_file(path, NULL, rerere_path(id, "preimage"));
	if (id->collection->status[variant] & RR_HAS_POSTIMAGE) {
		const char *path = rerere_path(id, "postimage");
		if (unlink(path))
			die_errno("cannot unlink stray '%s'", path);
		id->collection->status[variant] &= ~RR_HAS_POSTIMAGE;
	}
	id->collection->status[variant] |= RR_HAS_PREIMAGE;
	fprintf(stderr, "Recorded preimage for '%s'\n", path);
813 814
}

815
static int do_plain_rerere(struct string_list *rr, int fd)
816
{
817 818
	struct string_list conflict = STRING_LIST_INIT_DUP;
	struct string_list update = STRING_LIST_INIT_DUP;
819 820 821 822 823
	int i;

	find_conflict(&conflict);

	/*
824 825 826 827
	 * MERGE_RR records paths with conflicts immediately after
	 * merge failed.  Some of the conflicted paths might have been
	 * hand resolved in the working tree since then, but the
	 * initial run would catch all and register their preimages.
828 829
	 */
	for (i = 0; i < conflict.nr; i++) {
830
		struct rerere_id *id;
831
		unsigned char sha1[20];
832
		const char *path = conflict.items[i].string;
833
		int ret;
834

835 836
		if (string_list_has_string(rr, path))
			continue;
837

838 839 840 841 842 843 844 845
		/*
		 * Ask handle_file() to scan and assign a
		 * conflict ID.  No need to write anything out
		 * yet.
		 */
		ret = handle_file(path, sha1, NULL);
		if (ret < 1)
			continue;
846

847
		id = new_rerere_id(sha1);
848
		string_list_insert(rr, path)->util = id;
849

850 851
		/* Ensure that the directory exists. */
		mkdir_in_gitdir(rerere_path(id, NULL));
852 853
	}

854 855
	for (i = 0; i < rr->nr; i++)
		do_rerere_one_path(&rr->items[i], &update);
856 857 858 859 860 861 862

	if (update.nr)
		update_paths(&update);

	return write_rr(rr, fd);
}

863
static void git_rerere_config(void)
864
{
865 866 867
	git_config_get_bool("rerere.enabled", &rerere_enabled);
	git_config_get_bool("rerere.autoupdate", &rerere_autoupdate);
	git_config(git_default_config, NULL);
868 869
}

870 871
static GIT_PATH_FUNC(git_path_rr_cache, "rr-cache")

872 873 874 875 876 877 878
static int is_rerere_enabled(void)
{
	int rr_cache_exists;

	if (!rerere_enabled)
		return 0;

879
	rr_cache_exists = is_directory(git_path_rr_cache());
880 881 882
	if (rerere_enabled < 0)
		return rr_cache_exists;

883 884
	if (!rr_cache_exists && mkdir_in_gitdir(git_path_rr_cache()))
		die("Could not create directory %s", git_path_rr_cache());
885 886 887
	return 1;
}

888
int setup_rerere(struct string_list *merge_rr, int flags)
889 890 891
{
	int fd;

892
	git_rerere_config();
893 894 895
	if (!is_rerere_enabled())
		return -1;

896 897
	if (flags & (RERERE_AUTOUPDATE|RERERE_NOAUTOUPDATE))
		rerere_autoupdate = !!(flags & RERERE_AUTOUPDATE);
898 899 900 901 902
	if (flags & RERERE_READONLY)
		fd = 0;
	else
		fd = hold_lock_file_for_update(&write_lock, git_path_merge_rr(),
					       LOCK_DIE_ON_ERROR);
903 904 905 906
	read_rr(merge_rr);
	return fd;
}

907 908 909 910 911
/*
 * The main entry point that is called internally from codepaths that
 * perform mergy operations, possibly leaving conflicted index entries
 * and working tree files.
 */
912
int rerere(int flags)
913
{
914
	struct string_list merge_rr = STRING_LIST_INIT_DUP;
915
	int fd, status;
916

917
	fd = setup_rerere(&merge_rr, flags);
918 919
	if (fd < 0)
		return 0;
920 921 922
	status = do_plain_rerere(&merge_rr, fd);
	free_rerere_dirs();
	return status;
923
}
924

925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
/*
 * Subclass of rerere_io that reads from an in-core buffer that is a
 * strbuf
 */
struct rerere_io_mem {
	struct rerere_io io;
	struct strbuf input;
};

/*
 * ... and its getline() method implementation
 */
static int rerere_mem_getline(struct strbuf *sb, struct rerere_io *io_)
{
	struct rerere_io_mem *io = (struct rerere_io_mem *)io_;
	char *ep;
	size_t len;

	strbuf_release(sb);
	if (!io->input.len)
		return -1;
	ep = memchr(io->input.buf, '\n', io->input.len);
	if (!ep)
		ep = io->input.buf + io->input.len;
	else if (*ep == '\n')
		ep++;
	len = ep - io->input.buf;
	strbuf_add(sb, io->input.buf, len);
	strbuf_remove(&io->input, 0, len);
	return 0;
}

static int handle_cache(const char *path, unsigned char *sha1, const char *output)
{
	mmfile_t mmfile[3] = {{NULL}};
	mmbuffer_t result = {NULL, 0};
	const struct cache_entry *ce;
	int pos, len, i, hunk_no;
	struct rerere_io_mem io;
	int marker_size = ll_merge_marker_size(path);

	/*
	 * Reproduce the conflicted merge in-core
	 */
	len = strlen(path);
	pos = cache_name_pos(path, len);
	if (0 <= pos)
		return -1;
	pos = -pos - 1;

	while (pos < active_nr) {
		enum object_type type;
		unsigned long size;

		ce = active_cache[pos++];
		if (ce_namelen(ce) != len || memcmp(ce->name, path, len))
			break;
		i = ce_stage(ce) - 1;
		if (!mmfile[i].ptr) {
984 985
			mmfile[i].ptr = read_sha1_file(ce->oid.hash, &type,
						       &size);
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
			mmfile[i].size = size;
		}
	}
	for (i = 0; i < 3; i++)
		if (!mmfile[i].ptr && !mmfile[i].size)
			mmfile[i].ptr = xstrdup("");

	/*
	 * NEEDSWORK: handle conflicts from merges with
	 * merge.renormalize set, too?
	 */
	ll_merge(&result, path, &mmfile[0], NULL,
		 &mmfile[1], "ours",
		 &mmfile[2], "theirs", NULL);
	for (i = 0; i < 3; i++)
		free(mmfile[i].ptr);

	memset(&io, 0, sizeof(io));
	io.io.getline = rerere_mem_getline;
	if (output)
		io.io.output = fopen(output, "w");
	else
		io.io.output = NULL;
	strbuf_init(&io.input, 0);
	strbuf_attach(&io.input, result.ptr, result.size, result.size);

	/*
	 * Grab the conflict ID and optionally write the original
	 * contents with conflict markers out.
	 */
	hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
	strbuf_release(&io.input);
	if (io.io.output)
		fclose(io.io.output);
	return hunk_no;
1021
}
1022 1023 1024 1025

static int rerere_forget_one_path(const char *path, struct string_list *rr)
{
	const char *filename;
1026
	struct rerere_id *id;
1027 1028
	unsigned char sha1[20];
	int ret;
1029
	struct string_list_item *item;
1030

1031 1032 1033 1034
	/*
	 * Recreate the original conflict from the stages in the
	 * index and compute the conflict ID
	 */
1035 1036 1037
	ret = handle_cache(path, sha1, NULL);
	if (ret < 1)
		return error("Could not parse conflict hunks in '%s'", path);
1038 1039

	/* Nuke the recorded resolution for the conflict */
1040
	id = new_rerere_id(sha1);
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054

	for (id->variant = 0;
	     id->variant < id->collection->status_nr;
	     id->variant++) {
		mmfile_t cur = { NULL, 0 };
		mmbuffer_t result = {NULL, 0};
		int cleanly_resolved;

		if (!has_rerere_resolution(id))
			continue;

		handle_cache(path, sha1, rerere_path(id, "thisimage"));
		if (read_mmfile(&cur, rerere_path(id, "thisimage"))) {
			free(cur.ptr);
1055 1056
			error("Failed to update conflicted state in '%s'", path);
			goto fail_exit;
1057 1058 1059 1060 1061 1062 1063 1064
		}
		cleanly_resolved = !try_merge(id, path, &cur, &result);
		free(result.ptr);
		free(cur.ptr);
		if (cleanly_resolved)
			break;
	}

1065 1066 1067 1068
	if (id->collection->status_nr <= id->variant) {
		error("no remembered resolution for '%s'", path);
		goto fail_exit;
	}
1069

1070
	filename = rerere_path(id, "postimage");
1071 1072 1073 1074
	if (unlink(filename)) {
		if (errno == ENOENT)
			error("no remembered resolution for %s", path);
		else
1075
			error_errno("cannot unlink %s", filename);
1076
		goto fail_exit;
1077
	}
1078

1079 1080 1081 1082 1083
	/*
	 * Update the preimage so that the user can resolve the
	 * conflict in the working tree, run us again to record
	 * the postimage.
	 */
1084
	handle_cache(path, sha1, rerere_path(id, "preimage"));
1085 1086
	fprintf(stderr, "Updated preimage for '%s'\n", path);

1087 1088 1089 1090
	/*
	 * And remember that we can record resolution for this
	 * conflict when the user is done.
	 */
1091
	item = string_list_insert(rr, path);
1092
	free_rerere_id(item);
1093
	item->util = id;
1094 1095
	fprintf(stderr, "Forgot resolution for %s\n", path);
	return 0;
1096 1097 1098 1099

fail_exit:
	free(id);
	return -1;
1100 1101
}

1102
int rerere_forget(struct pathspec *pathspec)
1103 1104
{
	int i, fd;
1105 1106
	struct string_list conflict = STRING_LIST_INIT_DUP;
	struct string_list merge_rr = STRING_LIST_INIT_DUP;
1107 1108 1109 1110

	if (read_cache() < 0)
		return error("Could not read index");

1111
	fd = setup_rerere(&merge_rr, RERERE_NOAUTOUPDATE);
1112 1113
	if (fd < 0)
		return 0;
1114

1115 1116 1117 1118 1119
	/*
	 * The paths may have been resolved (incorrectly);
	 * recover the original conflicted state and then
	 * find the conflicted paths.
	 */
1120 1121 1122 1123
	unmerge_cache(pathspec);
	find_conflict(&conflict);
	for (i = 0; i < conflict.nr; i++) {
		struct string_list_item *it = &conflict.items[i];
1124
		if (!match_pathspec(pathspec, it->string,
1125
				    strlen(it->string), 0, NULL, 0))
1126 1127 1128 1129 1130
			continue;
		rerere_forget_one_path(it->string, &merge_rr);
	}
	return write_rr(&merge_rr, fd);
}
1131

1132 1133 1134
/*
 * Garbage collection support
 */
1135

1136
static timestamp_t rerere_created_at(struct rerere_id *id)
1137 1138
{
	struct stat st;
1139

1140
	return stat(rerere_path(id, "preimage"), &st) ? (time_t) 0 : st.st_mtime;
1141 1142
}

1143
static timestamp_t rerere_last_used_at(struct rerere_id *id)
1144 1145
{
	struct stat st;
1146

1147
	return stat(rerere_path(id, "postimage"), &st) ? (time_t) 0 : st.st_mtime;
1148 1149
}

1150 1151 1152
/*
 * Remove the recorded resolution for a given conflict ID
 */
1153
static void unlink_rr_item(struct rerere_id *id)
1154
{
Junio C Hamano's avatar
Junio C Hamano committed
1155 1156 1157 1158 1159
	unlink_or_warn(rerere_path(id, "thisimage"));
	remove_variant(id);
	id->collection->status[id->variant] = 0;
}

1160 1161
static void prune_one(struct rerere_id *id,
		      timestamp_t cutoff_resolve, timestamp_t cutoff_noresolve)
Junio C Hamano's avatar
Junio C Hamano committed
1162
{
1163 1164
	timestamp_t then;
	timestamp_t cutoff;
Junio C Hamano's avatar
Junio C Hamano committed
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174

	then = rerere_last_used_at(id);
	if (then)
		cutoff = cutoff_resolve;
	else {
		then = rerere_created_at(id);
		if (!then)
			return;
		cutoff = cutoff_noresolve;
	}
1175
	if (then < cutoff)
Junio C Hamano's avatar
Junio C Hamano committed
1176
		unlink_rr_item(id);
1177 1178 1179 1180 1181 1182 1183
}

void rerere_gc(struct string_list *rr)
{
	struct string_list to_remove = STRING_LIST_INIT_DUP;
	DIR *dir;
	struct dirent *e;
Junio C Hamano's avatar
Junio C Hamano committed
1184
	int i;
1185 1186 1187
	timestamp_t now = time(NULL);
	timestamp_t cutoff_noresolve = now - 15 * 86400;
	timestamp_t cutoff_resolve = now - 60 * 86400;
1188

1189 1190 1191
	if (setup_rerere(rr, 0) < 0)
		return;

1192 1193
	git_config_get_expiry_in_days("gc.rerereresolved", &cutoff_resolve, now);
	git_config_get_expiry_in_days("gc.rerereunresolved", &cutoff_noresolve, now);
1194
	git_config(git_default_config, NULL);
1195 1196 1197
	dir = opendir(git_path("rr-cache"));
	if (!dir)
		die_errno("unable to open rr-cache directory");
1198
	/* Collect stale conflict IDs ... */
1199
	while ((e = readdir(dir))) {
Junio C Hamano's avatar
Junio C Hamano committed
1200 1201 1202 1203
		struct rerere_dir *rr_dir;
		struct rerere_id id;
		int now_empty;

1204 1205
		if (is_dot_or_dotdot(e->d_name))
			continue;
Junio C Hamano's avatar
Junio C Hamano committed
1206 1207 1208 1209 1210 1211 1212 1213
		rr_dir = find_rerere_dir(e->d_name);
		if (!rr_dir)
			continue; /* or should we remove e->d_name? */

		now_empty = 1;
		for (id.variant = 0, id.collection = rr_dir;
		     id.variant < id.collection->status_nr;
		     id.variant++) {
1214
			prune_one(&id, cutoff_resolve, cutoff_noresolve);
Junio C Hamano's avatar
Junio C Hamano committed
1215 1216
			if (id.collection->status[id.variant])
				now_empty = 0;
1217
		}
Junio C Hamano's avatar
Junio C Hamano committed
1218
		if (now_empty)
1219 1220
			string_list_append(&to_remove, e->d_name);
	}
1221
	closedir(dir);
Junio C Hamano's avatar
Junio C Hamano committed
1222 1223

	/* ... and then remove the empty directories */
1224
	for (i = 0; i < to_remove.nr; i++)
Junio C Hamano's avatar
Junio C Hamano committed
1225
		rmdir(git_path("rr-cache/%s", to_remove.items[i].string));
1226
	string_list_clear(&to_remove, 0);
1227
	rollback_lock_file(&write_lock);
1228 1229
}

1230 1231 1232 1233 1234 1235 1236
/*
 * During a conflict resolution, after "rerere" recorded the
 * preimages, abandon them if the user did not resolve them or
 * record their resolutions.  And drop $GIT_DIR/MERGE_RR.
 *
 * NEEDSWORK: shouldn't we be calling this from "reset --hard"?
 */
1237 1238 1239 1240
void rerere_clear(struct string_list *merge_rr)
{
	int i;

1241 1242 1243
	if (setup_rerere(merge_rr, 0) < 0)
		return;

1244
	for (i = 0; i < merge_rr->nr; i++) {
1245
		struct rerere_id *id = merge_rr->items[i].util;