git.oblomov.eu Git - git/blob - rerere.c

   1 #include "cache.h"
   2 #include "config.h"
   3 #include "lockfile.h"
   4 #include "string-list.h"
   5 #include "rerere.h"
   6 #include "xdiff-interface.h"
   7 #include "dir.h"
   8 #include "resolve-undo.h"
   9 #include "ll-merge.h"
  10 #include "attr.h"
  11 #include "pathspec.h"
  12 #include "object-store.h"
  13 #include "sha1-lookup.h"
  14
  15 #define RESOLVED 0
  16 #define PUNTED 1
  17 #define THREE_STAGED 2
  18 void *RERERE_RESOLVED = &RERERE_RESOLVED;
  19
  20 /* if rerere_enabled == -1, fall back to detection of .git/rr-cache */
  21 static int rerere_enabled = -1;
  22
  23 /* automatically update cleanly resolved paths to the index */
  24 static int rerere_autoupdate;
  25
  26 static int rerere_dir_nr;
  27 static int rerere_dir_alloc;
  28
  29 #define RR_HAS_POSTIMAGE 1
  30 #define RR_HAS_PREIMAGE 2
  31 static struct rerere_dir {
  32         unsigned char sha1[20];
  33         int status_alloc, status_nr;
  34         unsigned char *status;
  35 } **rerere_dir;
  36
  37 static void free_rerere_dirs(void)
  38 {
  39         int i;
  40         for (i = 0; i < rerere_dir_nr; i++) {
  41                 free(rerere_dir[i]->status);
  42                 free(rerere_dir[i]);
  43         }
  44         FREE_AND_NULL(rerere_dir);
  45         rerere_dir_nr = rerere_dir_alloc = 0;
  46 }
  47
  48 static void free_rerere_id(struct string_list_item *item)
  49 {
  50         free(item->util);
  51 }
  52
  53 static const char *rerere_id_hex(const struct rerere_id *id)
  54 {
  55         return sha1_to_hex(id->collection->sha1);
  56 }
  57
  58 static void fit_variant(struct rerere_dir *rr_dir, int variant)
  59 {
  60         variant++;
  61         ALLOC_GROW(rr_dir->status, variant, rr_dir->status_alloc);
  62         if (rr_dir->status_nr < variant) {
  63                 memset(rr_dir->status + rr_dir->status_nr,
  64                        '\0', variant - rr_dir->status_nr);
  65                 rr_dir->status_nr = variant;
  66         }
  67 }
  68
  69 static void assign_variant(struct rerere_id *id)
  70 {
  71         int variant;
  72         struct rerere_dir *rr_dir = id->collection;
  73
  74         variant = id->variant;
  75         if (variant < 0) {
  76                 for (variant = 0; variant < rr_dir->status_nr; variant++)
  77                         if (!rr_dir->status[variant])
  78                                 break;
  79         }
  80         fit_variant(rr_dir, variant);
  81         id->variant = variant;
  82 }
  83
  84 const char *rerere_path(const struct rerere_id *id, const char *file)
  85 {
  86         if (!file)
  87                 return git_path("rr-cache/%s", rerere_id_hex(id));
  88
  89         if (id->variant <= 0)
  90                 return git_path("rr-cache/%s/%s", rerere_id_hex(id), file);
  91
  92         return git_path("rr-cache/%s/%s.%d",
  93                         rerere_id_hex(id), file, id->variant);
  94 }
  95
  96 static int is_rr_file(const char *name, const char *filename, int *variant)
  97 {
  98         const char *suffix;
  99         char *ep;
 100
 101         if (!strcmp(name, filename)) {
 102                 *variant = 0;
 103                 return 1;
 104         }
 105         if (!skip_prefix(name, filename, &suffix) || *suffix != '.')
 106                 return 0;
 107
 108         errno = 0;
 109         *variant = strtol(suffix + 1, &ep, 10);
 110         if (errno || *ep)
 111                 return 0;
 112         return 1;
 113 }
 114
 115 static void scan_rerere_dir(struct rerere_dir *rr_dir)
 116 {
 117         struct dirent *de;
 118         DIR *dir = opendir(git_path("rr-cache/%s", sha1_to_hex(rr_dir->sha1)));
 119
 120         if (!dir)
 121                 return;
 122         while ((de = readdir(dir)) != NULL) {
 123                 int variant;
 124
 125                 if (is_rr_file(de->d_name, "postimage", &variant)) {
 126                         fit_variant(rr_dir, variant);
 127                         rr_dir->status[variant] |= RR_HAS_POSTIMAGE;
 128                 } else if (is_rr_file(de->d_name, "preimage", &variant)) {
 129                         fit_variant(rr_dir, variant);
 130                         rr_dir->status[variant] |= RR_HAS_PREIMAGE;
 131                 }
 132         }
 133         closedir(dir);
 134 }
 135
 136 static const unsigned char *rerere_dir_sha1(size_t i, void *table)
 137 {
 138         struct rerere_dir **rr_dir = table;
 139         return rr_dir[i]->sha1;
 140 }
 141
 142 static struct rerere_dir *find_rerere_dir(const char *hex)
 143 {
 144         unsigned char sha1[20];
 145         struct rerere_dir *rr_dir;
 146         int pos;
 147
 148         if (get_sha1_hex(hex, sha1))
 149                 return NULL; /* BUG */
 150         pos = sha1_pos(sha1, rerere_dir, rerere_dir_nr, rerere_dir_sha1);
 151         if (pos < 0) {
 152                 rr_dir = xmalloc(sizeof(*rr_dir));
 153                 hashcpy(rr_dir->sha1, sha1);
 154                 rr_dir->status = NULL;
 155                 rr_dir->status_nr = 0;
 156                 rr_dir->status_alloc = 0;
 157                 pos = -1 - pos;
 158
 159                 /* Make sure the array is big enough ... */
 160                 ALLOC_GROW(rerere_dir, rerere_dir_nr + 1, rerere_dir_alloc);
 161                 /* ... and add it in. */
 162                 rerere_dir_nr++;
 163                 MOVE_ARRAY(rerere_dir + pos + 1, rerere_dir + pos,
 164                            rerere_dir_nr - pos - 1);
 165                 rerere_dir[pos] = rr_dir;
 166                 scan_rerere_dir(rr_dir);
 167         }
 168         return rerere_dir[pos];
 169 }
 170
 171 static int has_rerere_resolution(const struct rerere_id *id)
 172 {
 173         const int both = RR_HAS_POSTIMAGE|RR_HAS_PREIMAGE;
 174         int variant = id->variant;
 175
 176         if (variant < 0)
 177                 return 0;
 178         return ((id->collection->status[variant] & both) == both);
 179 }
 180
 181 static struct rerere_id *new_rerere_id_hex(char *hex)
 182 {
 183         struct rerere_id *id = xmalloc(sizeof(*id));
 184         id->collection = find_rerere_dir(hex);
 185         id->variant = -1; /* not known yet */
 186         return id;
 187 }
 188
 189 static struct rerere_id *new_rerere_id(unsigned char *sha1)
 190 {
 191         return new_rerere_id_hex(sha1_to_hex(sha1));
 192 }
 193
 194 /*
 195  * $GIT_DIR/MERGE_RR file is a collection of records, each of which is
 196  * "conflict ID", a HT and pathname, terminated with a NUL, and is
 197  * used to keep track of the set of paths that "rerere" may need to
 198  * work on (i.e. what is left by the previous invocation of "git
 199  * rerere" during the current conflict resolution session).
 200  */
 201 static void read_rr(struct string_list *rr)
 202 {
 203         struct strbuf buf = STRBUF_INIT;
 204         FILE *in = fopen_or_warn(git_path_merge_rr(the_repository), "r");
 205
 206         if (!in)
 207                 return;
 208         while (!strbuf_getwholeline(&buf, in, '\0')) {
 209                 char *path;
 210                 unsigned char sha1[20];
 211                 struct rerere_id *id;
 212                 int variant;
 213
 214                 /* There has to be the hash, tab, path and then NUL */
 215                 if (buf.len < 42 || get_sha1_hex(buf.buf, sha1))
 216                         die("corrupt MERGE_RR");
 217
 218                 if (buf.buf[40] != '.') {
 219                         variant = 0;
 220                         path = buf.buf + 40;
 221                 } else {
 222                         errno = 0;
 223                         variant = strtol(buf.buf + 41, &path, 10);
 224                         if (errno)
 225                                 die("corrupt MERGE_RR");
 226                 }
 227                 if (*(path++) != '\t')
 228                         die("corrupt MERGE_RR");
 229                 buf.buf[40] = '\0';
 230                 id = new_rerere_id_hex(buf.buf);
 231                 id->variant = variant;
 232                 string_list_insert(rr, path)->util = id;
 233         }
 234         strbuf_release(&buf);
 235         fclose(in);
 236 }
 237
 238 static struct lock_file write_lock;
 239
 240 static int write_rr(struct string_list *rr, int out_fd)
 241 {
 242         int i;
 243         for (i = 0; i < rr->nr; i++) {
 244                 struct strbuf buf = STRBUF_INIT;
 245                 struct rerere_id *id;
 246
 247                 assert(rr->items[i].util != RERERE_RESOLVED);
 248
 249                 id = rr->items[i].util;
 250                 if (!id)
 251                         continue;
 252                 assert(id->variant >= 0);
 253                 if (0 < id->variant)
 254                         strbuf_addf(&buf, "%s.%d\t%s%c",
 255                                     rerere_id_hex(id), id->variant,
 256                                     rr->items[i].string, 0);
 257                 else
 258                         strbuf_addf(&buf, "%s\t%s%c",
 259                                     rerere_id_hex(id),
 260                                     rr->items[i].string, 0);
 261
 262                 if (write_in_full(out_fd, buf.buf, buf.len) < 0)
 263                         die("unable to write rerere record");
 264
 265                 strbuf_release(&buf);
 266         }
 267         if (commit_lock_file(&write_lock) != 0)
 268                 die("unable to write rerere record");
 269         return 0;
 270 }
 271
 272 /*
 273  * "rerere" interacts with conflicted file contents using this I/O
 274  * abstraction.  It reads a conflicted contents from one place via
 275  * "getline()" method, and optionally can write it out after
 276  * normalizing the conflicted hunks to the "output".  Subclasses of
 277  * rerere_io embed this structure at the beginning of their own
 278  * rerere_io object.
 279  */
 280 struct rerere_io {
 281         int (*getline)(struct strbuf *, struct rerere_io *);
 282         FILE *output;
 283         int wrerror;
 284         /* some more stuff */
 285 };
 286
 287 static void ferr_write(const void *p, size_t count, FILE *fp, int *err)
 288 {
 289         if (!count || *err)
 290                 return;
 291         if (fwrite(p, count, 1, fp) != 1)
 292                 *err = errno;
 293 }
 294
 295 static inline void ferr_puts(const char *s, FILE *fp, int *err)
 296 {
 297         ferr_write(s, strlen(s), fp, err);
 298 }
 299
 300 static void rerere_io_putstr(const char *str, struct rerere_io *io)
 301 {
 302         if (io->output)
 303                 ferr_puts(str, io->output, &io->wrerror);
 304 }
 305
 306 /*
 307  * Write a conflict marker to io->output (if defined).
 308  */
 309 static void rerere_io_putconflict(int ch, int size, struct rerere_io *io)
 310 {
 311         char buf[64];
 312
 313         while (size) {
 314                 if (size <= sizeof(buf) - 2) {
 315                         memset(buf, ch, size);
 316                         buf[size] = '\n';
 317                         buf[size + 1] = '\0';
 318                         size = 0;
 319                 } else {
 320                         int sz = sizeof(buf) - 1;
 321
 322                         /*
 323                          * Make sure we will not write everything out
 324                          * in this round by leaving at least 1 byte
 325                          * for the next round, giving the next round
 326                          * a chance to add the terminating LF.  Yuck.
 327                          */
 328                         if (size <= sz)
 329                                 sz -= (sz - size) + 1;
 330                         memset(buf, ch, sz);
 331                         buf[sz] = '\0';
 332                         size -= sz;
 333                 }
 334                 rerere_io_putstr(buf, io);
 335         }
 336 }
 337
 338 static void rerere_io_putmem(const char *mem, size_t sz, struct rerere_io *io)
 339 {
 340         if (io->output)
 341                 ferr_write(mem, sz, io->output, &io->wrerror);
 342 }
 343
 344 /*
 345  * Subclass of rerere_io that reads from an on-disk file
 346  */
 347 struct rerere_io_file {
 348         struct rerere_io io;
 349         FILE *input;
 350 };
 351
 352 /*
 353  * ... and its getline() method implementation
 354  */
 355 static int rerere_file_getline(struct strbuf *sb, struct rerere_io *io_)
 356 {
 357         struct rerere_io_file *io = (struct rerere_io_file *)io_;
 358         return strbuf_getwholeline(sb, io->input, '\n');
 359 }
 360
 361 /*
 362  * Require the exact number of conflict marker letters, no more, no
 363  * less, followed by SP or any whitespace
 364  * (including LF).
 365  */
 366 static int is_cmarker(char *buf, int marker_char, int marker_size)
 367 {
 368         int want_sp;
 369
 370         /*
 371          * The beginning of our version and the end of their version
 372          * always are labeled like "<<<<< ours" or ">>>>> theirs",
 373          * hence we set want_sp for them.  Note that the version from
 374          * the common ancestor in diff3-style output is not always
 375          * labelled (e.g. "||||| common" is often seen but "|||||"
 376          * alone is also valid), so we do not set want_sp.
 377          */
 378         want_sp = (marker_char == '<') || (marker_char == '>');
 379
 380         while (marker_size--)
 381                 if (*buf++ != marker_char)
 382                         return 0;
 383         if (want_sp && *buf != ' ')
 384                 return 0;
 385         return isspace(*buf);
 386 }
 387
 388 /*
 389  * Read contents a file with conflicts, normalize the conflicts
 390  * by (1) discarding the common ancestor version in diff3-style,
 391  * (2) reordering our side and their side so that whichever sorts
 392  * alphabetically earlier comes before the other one, while
 393  * computing the "conflict ID", which is just an SHA-1 hash of
 394  * one side of the conflict, NUL, the other side of the conflict,
 395  * and NUL concatenated together.
 396  *
 397  * Return the number of conflict hunks found.
 398  *
 399  * NEEDSWORK: the logic and theory of operation behind this conflict
 400  * normalization may deserve to be documented somewhere, perhaps in
 401  * Documentation/technical/rerere.txt.
 402  */
 403 static int handle_path(unsigned char *sha1, struct rerere_io *io, int marker_size)
 404 {
 405         git_SHA_CTX ctx;
 406         int hunk_no = 0;
 407         enum {
 408                 RR_CONTEXT = 0, RR_SIDE_1, RR_SIDE_2, RR_ORIGINAL
 409         } hunk = RR_CONTEXT;
 410         struct strbuf one = STRBUF_INIT, two = STRBUF_INIT;
 411         struct strbuf buf = STRBUF_INIT;
 412
 413         if (sha1)
 414                 git_SHA1_Init(&ctx);
 415
 416         while (!io->getline(&buf, io)) {
 417                 if (is_cmarker(buf.buf, '<', marker_size)) {
 418                         if (hunk != RR_CONTEXT)
 419                                 goto bad;
 420                         hunk = RR_SIDE_1;
 421                 } else if (is_cmarker(buf.buf, '|', marker_size)) {
 422                         if (hunk != RR_SIDE_1)
 423                                 goto bad;
 424                         hunk = RR_ORIGINAL;
 425                 } else if (is_cmarker(buf.buf, '=', marker_size)) {
 426                         if (hunk != RR_SIDE_1 && hunk != RR_ORIGINAL)
 427                                 goto bad;
 428                         hunk = RR_SIDE_2;
 429                 } else if (is_cmarker(buf.buf, '>', marker_size)) {
 430                         if (hunk != RR_SIDE_2)
 431                                 goto bad;
 432                         if (strbuf_cmp(&one, &two) > 0)
 433                                 strbuf_swap(&one, &two);
 434                         hunk_no++;
 435                         hunk = RR_CONTEXT;
 436                         rerere_io_putconflict('<', marker_size, io);
 437                         rerere_io_putmem(one.buf, one.len, io);
 438                         rerere_io_putconflict('=', marker_size, io);
 439                         rerere_io_putmem(two.buf, two.len, io);
 440                         rerere_io_putconflict('>', marker_size, io);
 441                         if (sha1) {
 442                                 git_SHA1_Update(&ctx, one.buf ? one.buf : "",
 443                                             one.len + 1);
 444                                 git_SHA1_Update(&ctx, two.buf ? two.buf : "",
 445                                             two.len + 1);
 446                         }
 447                         strbuf_reset(&one);
 448                         strbuf_reset(&two);
 449                 } else if (hunk == RR_SIDE_1)
 450                         strbuf_addbuf(&one, &buf);
 451                 else if (hunk == RR_ORIGINAL)
 452                         ; /* discard */
 453                 else if (hunk == RR_SIDE_2)
 454                         strbuf_addbuf(&two, &buf);
 455                 else
 456                         rerere_io_putstr(buf.buf, io);
 457                 continue;
 458         bad:
 459                 hunk = 99; /* force error exit */
 460                 break;
 461         }
 462         strbuf_release(&one);
 463         strbuf_release(&two);
 464         strbuf_release(&buf);
 465
 466         if (sha1)
 467                 git_SHA1_Final(sha1, &ctx);
 468         if (hunk != RR_CONTEXT)
 469                 return -1;
 470         return hunk_no;
 471 }
 472
 473 /*
 474  * Scan the path for conflicts, do the "handle_path()" thing above, and
 475  * return the number of conflict hunks found.
 476  */
 477 static int handle_file(struct index_state *istate, const char *path,
 478                        unsigned char *sha1, const char *output)
 479 {
 480         int hunk_no = 0;
 481         struct rerere_io_file io;
 482         int marker_size = ll_merge_marker_size(istate, path);
 483
 484         memset(&io, 0, sizeof(io));
 485         io.io.getline = rerere_file_getline;
 486         io.input = fopen(path, "r");
 487         io.io.wrerror = 0;
 488         if (!io.input)
 489                 return error_errno("Could not open %s", path);
 490
 491         if (output) {
 492                 io.io.output = fopen(output, "w");
 493                 if (!io.io.output) {
 494                         error_errno("Could not write %s", output);
 495                         fclose(io.input);
 496                         return -1;
 497                 }
 498         }
 499
 500         hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
 501
 502         fclose(io.input);
 503         if (io.io.wrerror)
 504                 error("There were errors while writing %s (%s)",
 505                       path, strerror(io.io.wrerror));
 506         if (io.io.output && fclose(io.io.output))
 507                 io.io.wrerror = error_errno("Failed to flush %s", path);
 508
 509         if (hunk_no < 0) {
 510                 if (output)
 511                         unlink_or_warn(output);
 512                 return error("Could not parse conflict hunks in %s", path);
 513         }
 514         if (io.io.wrerror)
 515                 return -1;
 516         return hunk_no;
 517 }
 518
 519 /*
 520  * Look at a cache entry at "i" and see if it is not conflicting,
 521  * conflicting and we are willing to handle, or conflicting and
 522  * we are unable to handle, and return the determination in *type.
 523  * Return the cache index to be looked at next, by skipping the
 524  * stages we have already looked at in this invocation of this
 525  * function.
 526  */
 527 static int check_one_conflict(struct index_state *istate, int i, int *type)
 528 {
 529         const struct cache_entry *e = istate->cache[i];
 530
 531         if (!ce_stage(e)) {
 532                 *type = RESOLVED;
 533                 return i + 1;
 534         }
 535
 536         *type = PUNTED;
 537         while (ce_stage(istate->cache[i]) == 1)
 538                 i++;
 539
 540         /* Only handle regular files with both stages #2 and #3 */
 541         if (i + 1 < istate->cache_nr) {
 542                 const struct cache_entry *e2 = istate->cache[i];
 543                 const struct cache_entry *e3 = istate->cache[i + 1];
 544                 if (ce_stage(e2) == 2 &&
 545                     ce_stage(e3) == 3 &&
 546                     ce_same_name(e, e3) &&
 547                     S_ISREG(e2->ce_mode) &&
 548                     S_ISREG(e3->ce_mode))
 549                         *type = THREE_STAGED;
 550         }
 551
 552         /* Skip the entries with the same name */
 553         while (i < istate->cache_nr && ce_same_name(e, istate->cache[i]))
 554                 i++;
 555         return i;
 556 }
 557
 558 /*
 559  * Scan the index and find paths that have conflicts that rerere can
 560  * handle, i.e. the ones that has both stages #2 and #3.
 561  *
 562  * NEEDSWORK: we do not record or replay a previous "resolve by
 563  * deletion" for a delete-modify conflict, as that is inherently risky
 564  * without knowing what modification is being discarded.  The only
 565  * safe case, i.e. both side doing the deletion and modification that
 566  * are identical to the previous round, might want to be handled,
 567  * though.
 568  */
 569 static int find_conflict(struct repository *r, struct string_list *conflict)
 570 {
 571         int i;
 572
 573         if (read_index(r->index) < 0)
 574                 return error("Could not read index");
 575
 576         for (i = 0; i < r->index->cache_nr;) {
 577                 int conflict_type;
 578                 const struct cache_entry *e = r->index->cache[i];
 579                 i = check_one_conflict(r->index, i, &conflict_type);
 580                 if (conflict_type == THREE_STAGED)
 581                         string_list_insert(conflict, (const char *)e->name);
 582         }
 583         return 0;
 584 }
 585
 586 /*
 587  * The merge_rr list is meant to hold outstanding conflicted paths
 588  * that rerere could handle.  Abuse the list by adding other types of
 589  * entries to allow the caller to show "rerere remaining".
 590  *
 591  * - Conflicted paths that rerere does not handle are added
 592  * - Conflicted paths that have been resolved are marked as such
 593  *   by storing RERERE_RESOLVED to .util field (where conflict ID
 594  *   is expected to be stored).
 595  *
 596  * Do *not* write MERGE_RR file out after calling this function.
 597  *
 598  * NEEDSWORK: we may want to fix the caller that implements "rerere
 599  * remaining" to do this without abusing merge_rr.
 600  */
 601 int rerere_remaining(struct repository *r, struct string_list *merge_rr)
 602 {
 603         int i;
 604
 605         if (setup_rerere(merge_rr, RERERE_READONLY))
 606                 return 0;
 607         if (read_index(r->index) < 0)
 608                 return error("Could not read index");
 609
 610         for (i = 0; i < r->index->cache_nr;) {
 611                 int conflict_type;
 612                 const struct cache_entry *e = r->index->cache[i];
 613                 i = check_one_conflict(r->index, i, &conflict_type);
 614                 if (conflict_type == PUNTED)
 615                         string_list_insert(merge_rr, (const char *)e->name);
 616                 else if (conflict_type == RESOLVED) {
 617                         struct string_list_item *it;
 618                         it = string_list_lookup(merge_rr, (const char *)e->name);
 619                         if (it != NULL) {
 620                                 free_rerere_id(it);
 621                                 it->util = RERERE_RESOLVED;
 622                         }
 623                 }
 624         }
 625         return 0;
 626 }
 627
 628 /*
 629  * Try using the given conflict resolution "ID" to see
 630  * if that recorded conflict resolves cleanly what we
 631  * got in the "cur".
 632  */
 633 static int try_merge(struct index_state *istate,
 634                      const struct rerere_id *id, const char *path,
 635                      mmfile_t *cur, mmbuffer_t *result)
 636 {
 637         int ret;
 638         mmfile_t base = {NULL, 0}, other = {NULL, 0};
 639
 640         if (read_mmfile(&base, rerere_path(id, "preimage")) ||
 641             read_mmfile(&other, rerere_path(id, "postimage")))
 642                 ret = 1;
 643         else
 644                 /*
 645                  * A three-way merge. Note that this honors user-customizable
 646                  * low-level merge driver settings.
 647                  */
 648                 ret = ll_merge(result, path, &base, NULL, cur, "", &other, "",
 649                                istate, NULL);
 650
 651         free(base.ptr);
 652         free(other.ptr);
 653
 654         return ret;
 655 }
 656
 657 /*
 658  * Find the conflict identified by "id"; the change between its
 659  * "preimage" (i.e. a previous contents with conflict markers) and its
 660  * "postimage" (i.e. the corresponding contents with conflicts
 661  * resolved) may apply cleanly to the contents stored in "path", i.e.
 662  * the conflict this time around.
 663  *
 664  * Returns 0 for successful replay of recorded resolution, or non-zero
 665  * for failure.
 666  */
 667 static int merge(struct index_state *istate, const struct rerere_id *id, const char *path)
 668 {
 669         FILE *f;
 670         int ret;
 671         mmfile_t cur = {NULL, 0};
 672         mmbuffer_t result = {NULL, 0};
 673
 674         /*
 675          * Normalize the conflicts in path and write it out to
 676          * "thisimage" temporary file.
 677          */
 678         if ((handle_file(istate, path, NULL, rerere_path(id, "thisimage")) < 0) ||
 679             read_mmfile(&cur, rerere_path(id, "thisimage"))) {
 680                 ret = 1;
 681                 goto out;
 682         }
 683
 684         ret = try_merge(istate, id, path, &cur, &result);
 685         if (ret)
 686                 goto out;
 687
 688         /*
 689          * A successful replay of recorded resolution.
 690          * Mark that "postimage" was used to help gc.
 691          */
 692         if (utime(rerere_path(id, "postimage"), NULL) < 0)
 693                 warning_errno("failed utime() on %s",
 694                               rerere_path(id, "postimage"));
 695
 696         /* Update "path" with the resolution */
 697         f = fopen(path, "w");
 698         if (!f)
 699                 return error_errno("Could not open %s", path);
 700         if (fwrite(result.ptr, result.size, 1, f) != 1)
 701                 error_errno("Could not write %s", path);
 702         if (fclose(f))
 703                 return error_errno("Writing %s failed", path);
 704
 705 out:
 706         free(cur.ptr);
 707         free(result.ptr);
 708
 709         return ret;
 710 }
 711
 712 static void update_paths(struct repository *r, struct string_list *update)
 713 {
 714         struct lock_file index_lock = LOCK_INIT;
 715         int i;
 716
 717         hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 718
 719         for (i = 0; i < update->nr; i++) {
 720                 struct string_list_item *item = &update->items[i];
 721                 if (add_file_to_index(r->index, item->string, 0))
 722                         exit(128);
 723                 fprintf(stderr, "Staged '%s' using previous resolution.\n",
 724                         item->string);
 725         }
 726
 727         if (write_locked_index(r->index, &index_lock,
 728                                COMMIT_LOCK | SKIP_IF_UNCHANGED))
 729                 die("Unable to write new index file");
 730 }
 731
 732 static void remove_variant(struct rerere_id *id)
 733 {
 734         unlink_or_warn(rerere_path(id, "postimage"));
 735         unlink_or_warn(rerere_path(id, "preimage"));
 736         id->collection->status[id->variant] = 0;
 737 }
 738
 739 /*
 740  * The path indicated by rr_item may still have conflict for which we
 741  * have a recorded resolution, in which case replay it and optionally
 742  * update it.  Or it may have been resolved by the user and we may
 743  * only have the preimage for that conflict, in which case the result
 744  * needs to be recorded as a resolution in a postimage file.
 745  */
 746 static void do_rerere_one_path(struct index_state *istate,
 747                                struct string_list_item *rr_item,
 748                                struct string_list *update)
 749 {
 750         const char *path = rr_item->string;
 751         struct rerere_id *id = rr_item->util;
 752         struct rerere_dir *rr_dir = id->collection;
 753         int variant;
 754
 755         variant = id->variant;
 756
 757         /* Has the user resolved it already? */
 758         if (variant >= 0) {
 759                 if (!handle_file(istate, path, NULL, NULL)) {
 760                         copy_file(rerere_path(id, "postimage"), path, 0666);
 761                         id->collection->status[variant] |= RR_HAS_POSTIMAGE;
 762                         fprintf(stderr, "Recorded resolution for '%s'.\n", path);
 763                         free_rerere_id(rr_item);
 764                         rr_item->util = NULL;
 765                         return;
 766                 }
 767                 /*
 768                  * There may be other variants that can cleanly
 769                  * replay.  Try them and update the variant number for
 770                  * this one.
 771                  */
 772         }
 773
 774         /* Does any existing resolution apply cleanly? */
 775         for (variant = 0; variant < rr_dir->status_nr; variant++) {
 776                 const int both = RR_HAS_PREIMAGE | RR_HAS_POSTIMAGE;
 777                 struct rerere_id vid = *id;
 778
 779                 if ((rr_dir->status[variant] & both) != both)
 780                         continue;
 781
 782                 vid.variant = variant;
 783                 if (merge(istate, &vid, path))
 784                         continue; /* failed to replay */
 785
 786                 /*
 787                  * If there already is a different variant that applies
 788                  * cleanly, there is no point maintaining our own variant.
 789                  */
 790                 if (0 <= id->variant && id->variant != variant)
 791                         remove_variant(id);
 792
 793                 if (rerere_autoupdate)
 794                         string_list_insert(update, path);
 795                 else
 796                         fprintf(stderr,
 797                                 "Resolved '%s' using previous resolution.\n",
 798                                 path);
 799                 free_rerere_id(rr_item);
 800                 rr_item->util = NULL;
 801                 return;
 802         }
 803
 804         /* None of the existing one applies; we need a new variant */
 805         assign_variant(id);
 806
 807         variant = id->variant;
 808         handle_file(istate, path, NULL, rerere_path(id, "preimage"));
 809         if (id->collection->status[variant] & RR_HAS_POSTIMAGE) {
 810                 const char *path = rerere_path(id, "postimage");
 811                 if (unlink(path))
 812                         die_errno("cannot unlink stray '%s'", path);
 813                 id->collection->status[variant] &= ~RR_HAS_POSTIMAGE;
 814         }
 815         id->collection->status[variant] |= RR_HAS_PREIMAGE;
 816         fprintf(stderr, "Recorded preimage for '%s'\n", path);
 817 }
 818
 819 static int do_plain_rerere(struct repository *r,
 820                            struct string_list *rr, int fd)
 821 {
 822         struct string_list conflict = STRING_LIST_INIT_DUP;
 823         struct string_list update = STRING_LIST_INIT_DUP;
 824         int i;
 825
 826         find_conflict(r, &conflict);
 827
 828         /*
 829          * MERGE_RR records paths with conflicts immediately after
 830          * merge failed.  Some of the conflicted paths might have been
 831          * hand resolved in the working tree since then, but the
 832          * initial run would catch all and register their preimages.
 833          */
 834         for (i = 0; i < conflict.nr; i++) {
 835                 struct rerere_id *id;
 836                 unsigned char sha1[20];
 837                 const char *path = conflict.items[i].string;
 838                 int ret;
 839
 840                 if (string_list_has_string(rr, path))
 841                         continue;
 842
 843                 /*
 844                  * Ask handle_file() to scan and assign a
 845                  * conflict ID.  No need to write anything out
 846                  * yet.
 847                  */
 848                 ret = handle_file(r->index, path, sha1, NULL);
 849                 if (ret < 1)
 850                         continue;
 851
 852                 id = new_rerere_id(sha1);
 853                 string_list_insert(rr, path)->util = id;
 854
 855                 /* Ensure that the directory exists. */
 856                 mkdir_in_gitdir(rerere_path(id, NULL));
 857         }
 858
 859         for (i = 0; i < rr->nr; i++)
 860                 do_rerere_one_path(r->index, &rr->items[i], &update);
 861
 862         if (update.nr)
 863                 update_paths(r, &update);
 864
 865         return write_rr(rr, fd);
 866 }
 867
 868 static void git_rerere_config(void)
 869 {
 870         git_config_get_bool("rerere.enabled", &rerere_enabled);
 871         git_config_get_bool("rerere.autoupdate", &rerere_autoupdate);
 872         git_config(git_default_config, NULL);
 873 }
 874
 875 static GIT_PATH_FUNC(git_path_rr_cache, "rr-cache")
 876
 877 static int is_rerere_enabled(void)
 878 {
 879         int rr_cache_exists;
 880
 881         if (!rerere_enabled)
 882                 return 0;
 883
 884         rr_cache_exists = is_directory(git_path_rr_cache());
 885         if (rerere_enabled < 0)
 886                 return rr_cache_exists;
 887
 888         if (!rr_cache_exists && mkdir_in_gitdir(git_path_rr_cache()))
 889                 die("Could not create directory %s", git_path_rr_cache());
 890         return 1;
 891 }
 892
 893 int setup_rerere(struct string_list *merge_rr, int flags)
 894 {
 895         int fd;
 896
 897         git_rerere_config();
 898         if (!is_rerere_enabled())
 899                 return -1;
 900
 901         if (flags & (RERERE_AUTOUPDATE|RERERE_NOAUTOUPDATE))
 902                 rerere_autoupdate = !!(flags & RERERE_AUTOUPDATE);
 903         if (flags & RERERE_READONLY)
 904                 fd = 0;
 905         else
 906                 fd = hold_lock_file_for_update(&write_lock,
 907                                                git_path_merge_rr(the_repository),
 908                                                LOCK_DIE_ON_ERROR);
 909         read_rr(merge_rr);
 910         return fd;
 911 }
 912
 913 /*
 914  * The main entry point that is called internally from codepaths that
 915  * perform mergy operations, possibly leaving conflicted index entries
 916  * and working tree files.
 917  */
 918 int repo_rerere(struct repository *r, int flags)
 919 {
 920         struct string_list merge_rr = STRING_LIST_INIT_DUP;
 921         int fd, status;
 922
 923         fd = setup_rerere(&merge_rr, flags);
 924         if (fd < 0)
 925                 return 0;
 926         status = do_plain_rerere(r, &merge_rr, fd);
 927         free_rerere_dirs();
 928         return status;
 929 }
 930
 931 /*
 932  * Subclass of rerere_io that reads from an in-core buffer that is a
 933  * strbuf
 934  */
 935 struct rerere_io_mem {
 936         struct rerere_io io;
 937         struct strbuf input;
 938 };
 939
 940 /*
 941  * ... and its getline() method implementation
 942  */
 943 static int rerere_mem_getline(struct strbuf *sb, struct rerere_io *io_)
 944 {
 945         struct rerere_io_mem *io = (struct rerere_io_mem *)io_;
 946         char *ep;
 947         size_t len;
 948
 949         strbuf_release(sb);
 950         if (!io->input.len)
 951                 return -1;
 952         ep = memchr(io->input.buf, '\n', io->input.len);
 953         if (!ep)
 954                 ep = io->input.buf + io->input.len;
 955         else if (*ep == '\n')
 956                 ep++;
 957         len = ep - io->input.buf;
 958         strbuf_add(sb, io->input.buf, len);
 959         strbuf_remove(&io->input, 0, len);
 960         return 0;
 961 }
 962
 963 static int handle_cache(struct index_state *istate, const char *path,
 964                         unsigned char *sha1, const char *output)
 965 {
 966         mmfile_t mmfile[3] = {{NULL}};
 967         mmbuffer_t result = {NULL, 0};
 968         const struct cache_entry *ce;
 969         int pos, len, i, hunk_no;
 970         struct rerere_io_mem io;
 971         int marker_size = ll_merge_marker_size(istate, path);
 972
 973         /*
 974          * Reproduce the conflicted merge in-core
 975          */
 976         len = strlen(path);
 977         pos = index_name_pos(istate, path, len);
 978         if (0 <= pos)
 979                 return -1;
 980         pos = -pos - 1;
 981
 982         while (pos < istate->cache_nr) {
 983                 enum object_type type;
 984                 unsigned long size;
 985
 986                 ce = istate->cache[pos++];
 987                 if (ce_namelen(ce) != len || memcmp(ce->name, path, len))
 988                         break;
 989                 i = ce_stage(ce) - 1;
 990                 if (!mmfile[i].ptr) {
 991                         mmfile[i].ptr = read_object_file(&ce->oid, &type,
 992                                                          &size);
 993                         mmfile[i].size = size;
 994                 }
 995         }
 996         for (i = 0; i < 3; i++)
 997                 if (!mmfile[i].ptr && !mmfile[i].size)
 998                         mmfile[i].ptr = xstrdup("");
 999
1000         /*
1001          * NEEDSWORK: handle conflicts from merges with
1002          * merge.renormalize set, too?
1003          */
1004         ll_merge(&result, path, &mmfile[0], NULL,
1005                  &mmfile[1], "ours",
1006                  &mmfile[2], "theirs",
1007                  istate, NULL);
1008         for (i = 0; i < 3; i++)
1009                 free(mmfile[i].ptr);
1010
1011         memset(&io, 0, sizeof(io));
1012         io.io.getline = rerere_mem_getline;
1013         if (output)
1014                 io.io.output = fopen(output, "w");
1015         else
1016                 io.io.output = NULL;
1017         strbuf_init(&io.input, 0);
1018         strbuf_attach(&io.input, result.ptr, result.size, result.size);
1019
1020         /*
1021          * Grab the conflict ID and optionally write the original
1022          * contents with conflict markers out.
1023          */
1024         hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
1025         strbuf_release(&io.input);
1026         if (io.io.output)
1027                 fclose(io.io.output);
1028         return hunk_no;
1029 }
1030
1031 static int rerere_forget_one_path(struct index_state *istate,
1032                                   const char *path,
1033                                   struct string_list *rr)
1034 {
1035         const char *filename;
1036         struct rerere_id *id;
1037         unsigned char sha1[20];
1038         int ret;
1039         struct string_list_item *item;
1040
1041         /*
1042          * Recreate the original conflict from the stages in the
1043          * index and compute the conflict ID
1044          */
1045         ret = handle_cache(istate, path, sha1, NULL);
1046         if (ret < 1)
1047                 return error("Could not parse conflict hunks in '%s'", path);
1048
1049         /* Nuke the recorded resolution for the conflict */
1050         id = new_rerere_id(sha1);
1051
1052         for (id->variant = 0;
1053              id->variant < id->collection->status_nr;
1054              id->variant++) {
1055                 mmfile_t cur = { NULL, 0 };
1056                 mmbuffer_t result = {NULL, 0};
1057                 int cleanly_resolved;
1058
1059                 if (!has_rerere_resolution(id))
1060                         continue;
1061
1062                 handle_cache(istate, path, sha1, rerere_path(id, "thisimage"));
1063                 if (read_mmfile(&cur, rerere_path(id, "thisimage"))) {
1064                         free(cur.ptr);
1065                         error("Failed to update conflicted state in '%s'", path);
1066                         goto fail_exit;
1067                 }
1068                 cleanly_resolved = !try_merge(istate, id, path, &cur, &result);
1069                 free(result.ptr);
1070                 free(cur.ptr);
1071                 if (cleanly_resolved)
1072                         break;
1073         }
1074
1075         if (id->collection->status_nr <= id->variant) {
1076                 error("no remembered resolution for '%s'", path);
1077                 goto fail_exit;
1078         }
1079
1080         filename = rerere_path(id, "postimage");
1081         if (unlink(filename)) {
1082                 if (errno == ENOENT)
1083                         error("no remembered resolution for %s", path);
1084                 else
1085                         error_errno("cannot unlink %s", filename);
1086                 goto fail_exit;
1087         }
1088
1089         /*
1090          * Update the preimage so that the user can resolve the
1091          * conflict in the working tree, run us again to record
1092          * the postimage.
1093          */
1094         handle_cache(istate, path, sha1, rerere_path(id, "preimage"));
1095         fprintf(stderr, "Updated preimage for '%s'\n", path);
1096
1097         /*
1098          * And remember that we can record resolution for this
1099          * conflict when the user is done.
1100          */
1101         item = string_list_insert(rr, path);
1102         free_rerere_id(item);
1103         item->util = id;
1104         fprintf(stderr, "Forgot resolution for %s\n", path);
1105         return 0;
1106
1107 fail_exit:
1108         free(id);
1109         return -1;
1110 }
1111
1112 int rerere_forget(struct repository *r, struct pathspec *pathspec)
1113 {
1114         int i, fd;
1115         struct string_list conflict = STRING_LIST_INIT_DUP;
1116         struct string_list merge_rr = STRING_LIST_INIT_DUP;
1117
1118         if (read_index(r->index) < 0)
1119                 return error("Could not read index");
1120
1121         fd = setup_rerere(&merge_rr, RERERE_NOAUTOUPDATE);
1122         if (fd < 0)
1123                 return 0;
1124
1125         /*
1126          * The paths may have been resolved (incorrectly);
1127          * recover the original conflicted state and then
1128          * find the conflicted paths.
1129          */
1130         unmerge_index(r->index, pathspec);
1131         find_conflict(r, &conflict);
1132         for (i = 0; i < conflict.nr; i++) {
1133                 struct string_list_item *it = &conflict.items[i];
1134                 if (!match_pathspec(r->index, pathspec, it->string,
1135                                     strlen(it->string), 0, NULL, 0))
1136                         continue;
1137                 rerere_forget_one_path(r->index, it->string, &merge_rr);
1138         }
1139         return write_rr(&merge_rr, fd);
1140 }
1141
1142 /*
1143  * Garbage collection support
1144  */
1145
1146 static timestamp_t rerere_created_at(struct rerere_id *id)
1147 {
1148         struct stat st;
1149
1150         return stat(rerere_path(id, "preimage"), &st) ? (time_t) 0 : st.st_mtime;
1151 }
1152
1153 static timestamp_t rerere_last_used_at(struct rerere_id *id)
1154 {
1155         struct stat st;
1156
1157         return stat(rerere_path(id, "postimage"), &st) ? (time_t) 0 : st.st_mtime;
1158 }
1159
1160 /*
1161  * Remove the recorded resolution for a given conflict ID
1162  */
1163 static void unlink_rr_item(struct rerere_id *id)
1164 {
1165         unlink_or_warn(rerere_path(id, "thisimage"));
1166         remove_variant(id);
1167         id->collection->status[id->variant] = 0;
1168 }
1169
1170 static void prune_one(struct rerere_id *id,
1171                       timestamp_t cutoff_resolve, timestamp_t cutoff_noresolve)
1172 {
1173         timestamp_t then;
1174         timestamp_t cutoff;
1175
1176         then = rerere_last_used_at(id);
1177         if (then)
1178                 cutoff = cutoff_resolve;
1179         else {
1180                 then = rerere_created_at(id);
1181                 if (!then)
1182                         return;
1183                 cutoff = cutoff_noresolve;
1184         }
1185         if (then < cutoff)
1186                 unlink_rr_item(id);
1187 }
1188
1189 void rerere_gc(struct string_list *rr)
1190 {
1191         struct string_list to_remove = STRING_LIST_INIT_DUP;
1192         DIR *dir;
1193         struct dirent *e;
1194         int i;
1195         timestamp_t now = time(NULL);
1196         timestamp_t cutoff_noresolve = now - 15 * 86400;
1197         timestamp_t cutoff_resolve = now - 60 * 86400;
1198
1199         if (setup_rerere(rr, 0) < 0)
1200                 return;
1201
1202         git_config_get_expiry_in_days("gc.rerereresolved", &cutoff_resolve, now);
1203         git_config_get_expiry_in_days("gc.rerereunresolved", &cutoff_noresolve, now);
1204         git_config(git_default_config, NULL);
1205         dir = opendir(git_path("rr-cache"));
1206         if (!dir)
1207                 die_errno("unable to open rr-cache directory");
1208         /* Collect stale conflict IDs ... */
1209         while ((e = readdir(dir))) {
1210                 struct rerere_dir *rr_dir;
1211                 struct rerere_id id;
1212                 int now_empty;
1213
1214                 if (is_dot_or_dotdot(e->d_name))
1215                         continue;
1216                 rr_dir = find_rerere_dir(e->d_name);
1217                 if (!rr_dir)
1218                         continue; /* or should we remove e->d_name? */
1219
1220                 now_empty = 1;
1221                 for (id.variant = 0, id.collection = rr_dir;
1222                      id.variant < id.collection->status_nr;
1223                      id.variant++) {
1224                         prune_one(&id, cutoff_resolve, cutoff_noresolve);
1225                         if (id.collection->status[id.variant])
1226                                 now_empty = 0;
1227                 }
1228                 if (now_empty)
1229                         string_list_append(&to_remove, e->d_name);
1230         }
1231         closedir(dir);
1232
1233         /* ... and then remove the empty directories */
1234         for (i = 0; i < to_remove.nr; i++)
1235                 rmdir(git_path("rr-cache/%s", to_remove.items[i].string));
1236         string_list_clear(&to_remove, 0);
1237         rollback_lock_file(&write_lock);
1238 }
1239
1240 /*
1241  * During a conflict resolution, after "rerere" recorded the
1242  * preimages, abandon them if the user did not resolve them or
1243  * record their resolutions.  And drop $GIT_DIR/MERGE_RR.
1244  *
1245  * NEEDSWORK: shouldn't we be calling this from "reset --hard"?
1246  */
1247 void rerere_clear(struct string_list *merge_rr)
1248 {
1249         int i;
1250
1251         if (setup_rerere(merge_rr, 0) < 0)
1252                 return;
1253
1254         for (i = 0; i < merge_rr->nr; i++) {
1255                 struct rerere_id *id = merge_rr->items[i].util;
1256                 if (!has_rerere_resolution(id)) {
1257                         unlink_rr_item(id);
1258                         rmdir(rerere_path(id, NULL));
1259                 }
1260         }
1261         unlink_or_warn(git_path_merge_rr(the_repository));
1262         rollback_lock_file(&write_lock);
1263 }