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 static void rerere_io_putmem(const char *mem, size_t sz, struct rerere_io *io)
 307 {
 308         if (io->output)
 309                 ferr_write(mem, sz, io->output, &io->wrerror);
 310 }
 311
 312 /*
 313  * Subclass of rerere_io that reads from an on-disk file
 314  */
 315 struct rerere_io_file {
 316         struct rerere_io io;
 317         FILE *input;
 318 };
 319
 320 /*
 321  * ... and its getline() method implementation
 322  */
 323 static int rerere_file_getline(struct strbuf *sb, struct rerere_io *io_)
 324 {
 325         struct rerere_io_file *io = (struct rerere_io_file *)io_;
 326         return strbuf_getwholeline(sb, io->input, '\n');
 327 }
 328
 329 /*
 330  * Require the exact number of conflict marker letters, no more, no
 331  * less, followed by SP or any whitespace
 332  * (including LF).
 333  */
 334 static int is_cmarker(char *buf, int marker_char, int marker_size)
 335 {
 336         int want_sp;
 337
 338         /*
 339          * The beginning of our version and the end of their version
 340          * always are labeled like "<<<<< ours" or ">>>>> theirs",
 341          * hence we set want_sp for them.  Note that the version from
 342          * the common ancestor in diff3-style output is not always
 343          * labelled (e.g. "||||| common" is often seen but "|||||"
 344          * alone is also valid), so we do not set want_sp.
 345          */
 346         want_sp = (marker_char == '<') || (marker_char == '>');
 347
 348         while (marker_size--)
 349                 if (*buf++ != marker_char)
 350                         return 0;
 351         if (want_sp && *buf != ' ')
 352                 return 0;
 353         return isspace(*buf);
 354 }
 355
 356 static void rerere_strbuf_putconflict(struct strbuf *buf, int ch, size_t size)
 357 {
 358         strbuf_addchars(buf, ch, size);
 359         strbuf_addch(buf, '\n');
 360 }
 361
 362 static int handle_conflict(struct strbuf *out, struct rerere_io *io,
 363                            int marker_size, git_SHA_CTX *ctx)
 364 {
 365         enum {
 366                 RR_SIDE_1 = 0, RR_SIDE_2, RR_ORIGINAL
 367         } hunk = RR_SIDE_1;
 368         struct strbuf one = STRBUF_INIT, two = STRBUF_INIT;
 369         struct strbuf buf = STRBUF_INIT, conflict = STRBUF_INIT;
 370         int has_conflicts = -1;
 371
 372         while (!io->getline(&buf, io)) {
 373                 if (is_cmarker(buf.buf, '<', marker_size)) {
 374                         if (handle_conflict(&conflict, io, marker_size, NULL) < 0)
 375                                 break;
 376                         if (hunk == RR_SIDE_1)
 377                                 strbuf_addbuf(&one, &conflict);
 378                         else
 379                                 strbuf_addbuf(&two, &conflict);
 380                         strbuf_release(&conflict);
 381                 } else if (is_cmarker(buf.buf, '|', marker_size)) {
 382                         if (hunk != RR_SIDE_1)
 383                                 break;
 384                         hunk = RR_ORIGINAL;
 385                 } else if (is_cmarker(buf.buf, '=', marker_size)) {
 386                         if (hunk != RR_SIDE_1 && hunk != RR_ORIGINAL)
 387                                 break;
 388                         hunk = RR_SIDE_2;
 389                 } else if (is_cmarker(buf.buf, '>', marker_size)) {
 390                         if (hunk != RR_SIDE_2)
 391                                 break;
 392                         if (strbuf_cmp(&one, &two) > 0)
 393                                 strbuf_swap(&one, &two);
 394                         has_conflicts = 1;
 395                         rerere_strbuf_putconflict(out, '<', marker_size);
 396                         strbuf_addbuf(out, &one);
 397                         rerere_strbuf_putconflict(out, '=', marker_size);
 398                         strbuf_addbuf(out, &two);
 399                         rerere_strbuf_putconflict(out, '>', marker_size);
 400                         if (ctx) {
 401                                 git_SHA1_Update(ctx, one.buf ? one.buf : "",
 402                                             one.len + 1);
 403                                 git_SHA1_Update(ctx, two.buf ? two.buf : "",
 404                                             two.len + 1);
 405                         }
 406                         break;
 407                 } else if (hunk == RR_SIDE_1)
 408                         strbuf_addbuf(&one, &buf);
 409                 else if (hunk == RR_ORIGINAL)
 410                         ; /* discard */
 411                 else if (hunk == RR_SIDE_2)
 412                         strbuf_addbuf(&two, &buf);
 413         }
 414         strbuf_release(&one);
 415         strbuf_release(&two);
 416         strbuf_release(&buf);
 417
 418         return has_conflicts;
 419 }
 420
 421 /*
 422  * Read contents a file with conflicts, normalize the conflicts
 423  * by (1) discarding the common ancestor version in diff3-style,
 424  * (2) reordering our side and their side so that whichever sorts
 425  * alphabetically earlier comes before the other one, while
 426  * computing the "conflict ID", which is just an SHA-1 hash of
 427  * one side of the conflict, NUL, the other side of the conflict,
 428  * and NUL concatenated together.
 429  *
 430  * Return 1 if conflict hunks are found, 0 if there are no conflict
 431  * hunks and -1 if an error occured.
 432  */
 433 static int handle_path(unsigned char *sha1, struct rerere_io *io, int marker_size)
 434 {
 435         git_SHA_CTX ctx;
 436         struct strbuf buf = STRBUF_INIT, out = STRBUF_INIT;
 437         int has_conflicts = 0;
 438         if (sha1)
 439                 git_SHA1_Init(&ctx);
 440
 441         while (!io->getline(&buf, io)) {
 442                 if (is_cmarker(buf.buf, '<', marker_size)) {
 443                         has_conflicts = handle_conflict(&out, io, marker_size,
 444                                                         sha1 ? &ctx : NULL);
 445                         if (has_conflicts < 0)
 446                                 break;
 447                         rerere_io_putmem(out.buf, out.len, io);
 448                         strbuf_reset(&out);
 449                 } else
 450                         rerere_io_putstr(buf.buf, io);
 451         }
 452         strbuf_release(&buf);
 453         strbuf_release(&out);
 454
 455         if (sha1)
 456                 git_SHA1_Final(sha1, &ctx);
 457
 458         return has_conflicts;
 459 }
 460
 461 /*
 462  * Scan the path for conflicts, do the "handle_path()" thing above, and
 463  * return the number of conflict hunks found.
 464  */
 465 static int handle_file(struct index_state *istate, const char *path,
 466                        unsigned char *sha1, const char *output)
 467 {
 468         int has_conflicts = 0;
 469         struct rerere_io_file io;
 470         int marker_size = ll_merge_marker_size(istate, path);
 471
 472         memset(&io, 0, sizeof(io));
 473         io.io.getline = rerere_file_getline;
 474         io.input = fopen(path, "r");
 475         io.io.wrerror = 0;
 476         if (!io.input)
 477                 return error_errno(_("could not open '%s'"), path);
 478
 479         if (output) {
 480                 io.io.output = fopen(output, "w");
 481                 if (!io.io.output) {
 482                         error_errno(_("could not write '%s'"), output);
 483                         fclose(io.input);
 484                         return -1;
 485                 }
 486         }
 487
 488         has_conflicts = handle_path(sha1, (struct rerere_io *)&io, marker_size);
 489
 490         fclose(io.input);
 491         if (io.io.wrerror)
 492                 error(_("there were errors while writing '%s' (%s)"),
 493                       path, strerror(io.io.wrerror));
 494         if (io.io.output && fclose(io.io.output))
 495                 io.io.wrerror = error_errno(_("failed to flush '%s'"), path);
 496
 497         if (has_conflicts < 0) {
 498                 if (output)
 499                         unlink_or_warn(output);
 500                 return error(_("could not parse conflict hunks in '%s'"), path);
 501         }
 502         if (io.io.wrerror)
 503                 return -1;
 504         return has_conflicts;
 505 }
 506
 507 /*
 508  * Look at a cache entry at "i" and see if it is not conflicting,
 509  * conflicting and we are willing to handle, or conflicting and
 510  * we are unable to handle, and return the determination in *type.
 511  * Return the cache index to be looked at next, by skipping the
 512  * stages we have already looked at in this invocation of this
 513  * function.
 514  */
 515 static int check_one_conflict(struct index_state *istate, int i, int *type)
 516 {
 517         const struct cache_entry *e = istate->cache[i];
 518
 519         if (!ce_stage(e)) {
 520                 *type = RESOLVED;
 521                 return i + 1;
 522         }
 523
 524         *type = PUNTED;
 525         while (i < istate->cache_nr && ce_stage(istate->cache[i]) == 1)
 526                 i++;
 527
 528         /* Only handle regular files with both stages #2 and #3 */
 529         if (i + 1 < istate->cache_nr) {
 530                 const struct cache_entry *e2 = istate->cache[i];
 531                 const struct cache_entry *e3 = istate->cache[i + 1];
 532                 if (ce_stage(e2) == 2 &&
 533                     ce_stage(e3) == 3 &&
 534                     ce_same_name(e, e3) &&
 535                     S_ISREG(e2->ce_mode) &&
 536                     S_ISREG(e3->ce_mode))
 537                         *type = THREE_STAGED;
 538         }
 539
 540         /* Skip the entries with the same name */
 541         while (i < istate->cache_nr && ce_same_name(e, istate->cache[i]))
 542                 i++;
 543         return i;
 544 }
 545
 546 /*
 547  * Scan the index and find paths that have conflicts that rerere can
 548  * handle, i.e. the ones that has both stages #2 and #3.
 549  *
 550  * NEEDSWORK: we do not record or replay a previous "resolve by
 551  * deletion" for a delete-modify conflict, as that is inherently risky
 552  * without knowing what modification is being discarded.  The only
 553  * safe case, i.e. both side doing the deletion and modification that
 554  * are identical to the previous round, might want to be handled,
 555  * though.
 556  */
 557 static int find_conflict(struct repository *r, struct string_list *conflict)
 558 {
 559         int i;
 560
 561         if (read_index(r->index) < 0)
 562                 return error(_("index file corrupt"));
 563
 564         for (i = 0; i < r->index->cache_nr;) {
 565                 int conflict_type;
 566                 const struct cache_entry *e = r->index->cache[i];
 567                 i = check_one_conflict(r->index, i, &conflict_type);
 568                 if (conflict_type == THREE_STAGED)
 569                         string_list_insert(conflict, (const char *)e->name);
 570         }
 571         return 0;
 572 }
 573
 574 /*
 575  * The merge_rr list is meant to hold outstanding conflicted paths
 576  * that rerere could handle.  Abuse the list by adding other types of
 577  * entries to allow the caller to show "rerere remaining".
 578  *
 579  * - Conflicted paths that rerere does not handle are added
 580  * - Conflicted paths that have been resolved are marked as such
 581  *   by storing RERERE_RESOLVED to .util field (where conflict ID
 582  *   is expected to be stored).
 583  *
 584  * Do *not* write MERGE_RR file out after calling this function.
 585  *
 586  * NEEDSWORK: we may want to fix the caller that implements "rerere
 587  * remaining" to do this without abusing merge_rr.
 588  */
 589 int rerere_remaining(struct repository *r, struct string_list *merge_rr)
 590 {
 591         int i;
 592
 593         if (setup_rerere(merge_rr, RERERE_READONLY))
 594                 return 0;
 595         if (read_index(r->index) < 0)
 596                 return error(_("index file corrupt"));
 597
 598         for (i = 0; i < r->index->cache_nr;) {
 599                 int conflict_type;
 600                 const struct cache_entry *e = r->index->cache[i];
 601                 i = check_one_conflict(r->index, i, &conflict_type);
 602                 if (conflict_type == PUNTED)
 603                         string_list_insert(merge_rr, (const char *)e->name);
 604                 else if (conflict_type == RESOLVED) {
 605                         struct string_list_item *it;
 606                         it = string_list_lookup(merge_rr, (const char *)e->name);
 607                         if (it != NULL) {
 608                                 free_rerere_id(it);
 609                                 it->util = RERERE_RESOLVED;
 610                         }
 611                 }
 612         }
 613         return 0;
 614 }
 615
 616 /*
 617  * Try using the given conflict resolution "ID" to see
 618  * if that recorded conflict resolves cleanly what we
 619  * got in the "cur".
 620  */
 621 static int try_merge(struct index_state *istate,
 622                      const struct rerere_id *id, const char *path,
 623                      mmfile_t *cur, mmbuffer_t *result)
 624 {
 625         int ret;
 626         mmfile_t base = {NULL, 0}, other = {NULL, 0};
 627
 628         if (read_mmfile(&base, rerere_path(id, "preimage")) ||
 629             read_mmfile(&other, rerere_path(id, "postimage")))
 630                 ret = 1;
 631         else
 632                 /*
 633                  * A three-way merge. Note that this honors user-customizable
 634                  * low-level merge driver settings.
 635                  */
 636                 ret = ll_merge(result, path, &base, NULL, cur, "", &other, "",
 637                                istate, NULL);
 638
 639         free(base.ptr);
 640         free(other.ptr);
 641
 642         return ret;
 643 }
 644
 645 /*
 646  * Find the conflict identified by "id"; the change between its
 647  * "preimage" (i.e. a previous contents with conflict markers) and its
 648  * "postimage" (i.e. the corresponding contents with conflicts
 649  * resolved) may apply cleanly to the contents stored in "path", i.e.
 650  * the conflict this time around.
 651  *
 652  * Returns 0 for successful replay of recorded resolution, or non-zero
 653  * for failure.
 654  */
 655 static int merge(struct index_state *istate, const struct rerere_id *id, const char *path)
 656 {
 657         FILE *f;
 658         int ret;
 659         mmfile_t cur = {NULL, 0};
 660         mmbuffer_t result = {NULL, 0};
 661
 662         /*
 663          * Normalize the conflicts in path and write it out to
 664          * "thisimage" temporary file.
 665          */
 666         if ((handle_file(istate, path, NULL, rerere_path(id, "thisimage")) < 0) ||
 667             read_mmfile(&cur, rerere_path(id, "thisimage"))) {
 668                 ret = 1;
 669                 goto out;
 670         }
 671
 672         ret = try_merge(istate, id, path, &cur, &result);
 673         if (ret)
 674                 goto out;
 675
 676         /*
 677          * A successful replay of recorded resolution.
 678          * Mark that "postimage" was used to help gc.
 679          */
 680         if (utime(rerere_path(id, "postimage"), NULL) < 0)
 681                 warning_errno(_("failed utime() on '%s'"),
 682                               rerere_path(id, "postimage"));
 683
 684         /* Update "path" with the resolution */
 685         f = fopen(path, "w");
 686         if (!f)
 687                 return error_errno(_("could not open '%s'"), path);
 688         if (fwrite(result.ptr, result.size, 1, f) != 1)
 689                 error_errno(_("could not write '%s'"), path);
 690         if (fclose(f))
 691                 return error_errno(_("writing '%s' failed"), path);
 692
 693 out:
 694         free(cur.ptr);
 695         free(result.ptr);
 696
 697         return ret;
 698 }
 699
 700 static void update_paths(struct repository *r, struct string_list *update)
 701 {
 702         struct lock_file index_lock = LOCK_INIT;
 703         int i;
 704
 705         hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 706
 707         for (i = 0; i < update->nr; i++) {
 708                 struct string_list_item *item = &update->items[i];
 709                 if (add_file_to_index(r->index, item->string, 0))
 710                         exit(128);
 711                 fprintf_ln(stderr, _("Staged '%s' using previous resolution."),
 712                         item->string);
 713         }
 714
 715         if (write_locked_index(r->index, &index_lock,
 716                                COMMIT_LOCK | SKIP_IF_UNCHANGED))
 717                 die(_("unable to write new index file"));
 718 }
 719
 720 static void remove_variant(struct rerere_id *id)
 721 {
 722         unlink_or_warn(rerere_path(id, "postimage"));
 723         unlink_or_warn(rerere_path(id, "preimage"));
 724         id->collection->status[id->variant] = 0;
 725 }
 726
 727 /*
 728  * The path indicated by rr_item may still have conflict for which we
 729  * have a recorded resolution, in which case replay it and optionally
 730  * update it.  Or it may have been resolved by the user and we may
 731  * only have the preimage for that conflict, in which case the result
 732  * needs to be recorded as a resolution in a postimage file.
 733  */
 734 static void do_rerere_one_path(struct index_state *istate,
 735                                struct string_list_item *rr_item,
 736                                struct string_list *update)
 737 {
 738         const char *path = rr_item->string;
 739         struct rerere_id *id = rr_item->util;
 740         struct rerere_dir *rr_dir = id->collection;
 741         int variant;
 742
 743         variant = id->variant;
 744
 745         /* Has the user resolved it already? */
 746         if (variant >= 0) {
 747                 if (!handle_file(istate, path, NULL, NULL)) {
 748                         copy_file(rerere_path(id, "postimage"), path, 0666);
 749                         id->collection->status[variant] |= RR_HAS_POSTIMAGE;
 750                         fprintf_ln(stderr, _("Recorded resolution for '%s'."), path);
 751                         free_rerere_id(rr_item);
 752                         rr_item->util = NULL;
 753                         return;
 754                 }
 755                 /*
 756                  * There may be other variants that can cleanly
 757                  * replay.  Try them and update the variant number for
 758                  * this one.
 759                  */
 760         }
 761
 762         /* Does any existing resolution apply cleanly? */
 763         for (variant = 0; variant < rr_dir->status_nr; variant++) {
 764                 const int both = RR_HAS_PREIMAGE | RR_HAS_POSTIMAGE;
 765                 struct rerere_id vid = *id;
 766
 767                 if ((rr_dir->status[variant] & both) != both)
 768                         continue;
 769
 770                 vid.variant = variant;
 771                 if (merge(istate, &vid, path))
 772                         continue; /* failed to replay */
 773
 774                 /*
 775                  * If there already is a different variant that applies
 776                  * cleanly, there is no point maintaining our own variant.
 777                  */
 778                 if (0 <= id->variant && id->variant != variant)
 779                         remove_variant(id);
 780
 781                 if (rerere_autoupdate)
 782                         string_list_insert(update, path);
 783                 else
 784                         fprintf_ln(stderr,
 785                                    _("Resolved '%s' using previous resolution."),
 786                                    path);
 787                 free_rerere_id(rr_item);
 788                 rr_item->util = NULL;
 789                 return;
 790         }
 791
 792         /* None of the existing one applies; we need a new variant */
 793         assign_variant(id);
 794
 795         variant = id->variant;
 796         handle_file(istate, path, NULL, rerere_path(id, "preimage"));
 797         if (id->collection->status[variant] & RR_HAS_POSTIMAGE) {
 798                 const char *path = rerere_path(id, "postimage");
 799                 if (unlink(path))
 800                         die_errno(_("cannot unlink stray '%s'"), path);
 801                 id->collection->status[variant] &= ~RR_HAS_POSTIMAGE;
 802         }
 803         id->collection->status[variant] |= RR_HAS_PREIMAGE;
 804         fprintf_ln(stderr, _("Recorded preimage for '%s'"), path);
 805 }
 806
 807 static int do_plain_rerere(struct repository *r,
 808                            struct string_list *rr, int fd)
 809 {
 810         struct string_list conflict = STRING_LIST_INIT_DUP;
 811         struct string_list update = STRING_LIST_INIT_DUP;
 812         int i;
 813
 814         find_conflict(r, &conflict);
 815
 816         /*
 817          * MERGE_RR records paths with conflicts immediately after
 818          * merge failed.  Some of the conflicted paths might have been
 819          * hand resolved in the working tree since then, but the
 820          * initial run would catch all and register their preimages.
 821          */
 822         for (i = 0; i < conflict.nr; i++) {
 823                 struct rerere_id *id;
 824                 unsigned char sha1[20];
 825                 const char *path = conflict.items[i].string;
 826                 int ret;
 827
 828                 /*
 829                  * Ask handle_file() to scan and assign a
 830                  * conflict ID.  No need to write anything out
 831                  * yet.
 832                  */
 833                 ret = handle_file(r->index, path, sha1, NULL);
 834                 if (ret != 0 && string_list_has_string(rr, path)) {
 835                         remove_variant(string_list_lookup(rr, path)->util);
 836                         string_list_remove(rr, path, 1);
 837                 }
 838                 if (ret < 1)
 839                         continue;
 840
 841                 id = new_rerere_id(sha1);
 842                 string_list_insert(rr, path)->util = id;
 843
 844                 /* Ensure that the directory exists. */
 845                 mkdir_in_gitdir(rerere_path(id, NULL));
 846         }
 847
 848         for (i = 0; i < rr->nr; i++)
 849                 do_rerere_one_path(r->index, &rr->items[i], &update);
 850
 851         if (update.nr)
 852                 update_paths(r, &update);
 853
 854         return write_rr(rr, fd);
 855 }
 856
 857 static void git_rerere_config(void)
 858 {
 859         git_config_get_bool("rerere.enabled", &rerere_enabled);
 860         git_config_get_bool("rerere.autoupdate", &rerere_autoupdate);
 861         git_config(git_default_config, NULL);
 862 }
 863
 864 static GIT_PATH_FUNC(git_path_rr_cache, "rr-cache")
 865
 866 static int is_rerere_enabled(void)
 867 {
 868         int rr_cache_exists;
 869
 870         if (!rerere_enabled)
 871                 return 0;
 872
 873         rr_cache_exists = is_directory(git_path_rr_cache());
 874         if (rerere_enabled < 0)
 875                 return rr_cache_exists;
 876
 877         if (!rr_cache_exists && mkdir_in_gitdir(git_path_rr_cache()))
 878                 die(_("could not create directory '%s'"), git_path_rr_cache());
 879         return 1;
 880 }
 881
 882 int setup_rerere(struct string_list *merge_rr, int flags)
 883 {
 884         int fd;
 885
 886         git_rerere_config();
 887         if (!is_rerere_enabled())
 888                 return -1;
 889
 890         if (flags & (RERERE_AUTOUPDATE|RERERE_NOAUTOUPDATE))
 891                 rerere_autoupdate = !!(flags & RERERE_AUTOUPDATE);
 892         if (flags & RERERE_READONLY)
 893                 fd = 0;
 894         else
 895                 fd = hold_lock_file_for_update(&write_lock,
 896                                                git_path_merge_rr(the_repository),
 897                                                LOCK_DIE_ON_ERROR);
 898         read_rr(merge_rr);
 899         return fd;
 900 }
 901
 902 /*
 903  * The main entry point that is called internally from codepaths that
 904  * perform mergy operations, possibly leaving conflicted index entries
 905  * and working tree files.
 906  */
 907 int repo_rerere(struct repository *r, int flags)
 908 {
 909         struct string_list merge_rr = STRING_LIST_INIT_DUP;
 910         int fd, status;
 911
 912         fd = setup_rerere(&merge_rr, flags);
 913         if (fd < 0)
 914                 return 0;
 915         status = do_plain_rerere(r, &merge_rr, fd);
 916         free_rerere_dirs();
 917         return status;
 918 }
 919
 920 /*
 921  * Subclass of rerere_io that reads from an in-core buffer that is a
 922  * strbuf
 923  */
 924 struct rerere_io_mem {
 925         struct rerere_io io;
 926         struct strbuf input;
 927 };
 928
 929 /*
 930  * ... and its getline() method implementation
 931  */
 932 static int rerere_mem_getline(struct strbuf *sb, struct rerere_io *io_)
 933 {
 934         struct rerere_io_mem *io = (struct rerere_io_mem *)io_;
 935         char *ep;
 936         size_t len;
 937
 938         strbuf_release(sb);
 939         if (!io->input.len)
 940                 return -1;
 941         ep = memchr(io->input.buf, '\n', io->input.len);
 942         if (!ep)
 943                 ep = io->input.buf + io->input.len;
 944         else if (*ep == '\n')
 945                 ep++;
 946         len = ep - io->input.buf;
 947         strbuf_add(sb, io->input.buf, len);
 948         strbuf_remove(&io->input, 0, len);
 949         return 0;
 950 }
 951
 952 static int handle_cache(struct index_state *istate, const char *path,
 953                         unsigned char *sha1, const char *output)
 954 {
 955         mmfile_t mmfile[3] = {{NULL}};
 956         mmbuffer_t result = {NULL, 0};
 957         const struct cache_entry *ce;
 958         int pos, len, i, has_conflicts;
 959         struct rerere_io_mem io;
 960         int marker_size = ll_merge_marker_size(istate, path);
 961
 962         /*
 963          * Reproduce the conflicted merge in-core
 964          */
 965         len = strlen(path);
 966         pos = index_name_pos(istate, path, len);
 967         if (0 <= pos)
 968                 return -1;
 969         pos = -pos - 1;
 970
 971         while (pos < istate->cache_nr) {
 972                 enum object_type type;
 973                 unsigned long size;
 974
 975                 ce = istate->cache[pos++];
 976                 if (ce_namelen(ce) != len || memcmp(ce->name, path, len))
 977                         break;
 978                 i = ce_stage(ce) - 1;
 979                 if (!mmfile[i].ptr) {
 980                         mmfile[i].ptr = read_object_file(&ce->oid, &type,
 981                                                          &size);
 982                         mmfile[i].size = size;
 983                 }
 984         }
 985         for (i = 0; i < 3; i++)
 986                 if (!mmfile[i].ptr && !mmfile[i].size)
 987                         mmfile[i].ptr = xstrdup("");
 988
 989         /*
 990          * NEEDSWORK: handle conflicts from merges with
 991          * merge.renormalize set, too?
 992          */
 993         ll_merge(&result, path, &mmfile[0], NULL,
 994                  &mmfile[1], "ours",
 995                  &mmfile[2], "theirs",
 996                  istate, NULL);
 997         for (i = 0; i < 3; i++)
 998                 free(mmfile[i].ptr);
 999
1000         memset(&io, 0, sizeof(io));
1001         io.io.getline = rerere_mem_getline;
1002         if (output)
1003                 io.io.output = fopen(output, "w");
1004         else
1005                 io.io.output = NULL;
1006         strbuf_init(&io.input, 0);
1007         strbuf_attach(&io.input, result.ptr, result.size, result.size);
1008
1009         /*
1010          * Grab the conflict ID and optionally write the original
1011          * contents with conflict markers out.
1012          */
1013         has_conflicts = handle_path(sha1, (struct rerere_io *)&io, marker_size);
1014         strbuf_release(&io.input);
1015         if (io.io.output)
1016                 fclose(io.io.output);
1017         return has_conflicts;
1018 }
1019
1020 static int rerere_forget_one_path(struct index_state *istate,
1021                                   const char *path,
1022                                   struct string_list *rr)
1023 {
1024         const char *filename;
1025         struct rerere_id *id;
1026         unsigned char sha1[20];
1027         int ret;
1028         struct string_list_item *item;
1029
1030         /*
1031          * Recreate the original conflict from the stages in the
1032          * index and compute the conflict ID
1033          */
1034         ret = handle_cache(istate, path, sha1, NULL);
1035         if (ret < 1)
1036                 return error(_("could not parse conflict hunks in '%s'"), path);
1037
1038         /* Nuke the recorded resolution for the conflict */
1039         id = new_rerere_id(sha1);
1040
1041         for (id->variant = 0;
1042              id->variant < id->collection->status_nr;
1043              id->variant++) {
1044                 mmfile_t cur = { NULL, 0 };
1045                 mmbuffer_t result = {NULL, 0};
1046                 int cleanly_resolved;
1047
1048                 if (!has_rerere_resolution(id))
1049                         continue;
1050
1051                 handle_cache(istate, path, sha1, rerere_path(id, "thisimage"));
1052                 if (read_mmfile(&cur, rerere_path(id, "thisimage"))) {
1053                         free(cur.ptr);
1054                         error(_("failed to update conflicted state in '%s'"), path);
1055                         goto fail_exit;
1056                 }
1057                 cleanly_resolved = !try_merge(istate, id, path, &cur, &result);
1058                 free(result.ptr);
1059                 free(cur.ptr);
1060                 if (cleanly_resolved)
1061                         break;
1062         }
1063
1064         if (id->collection->status_nr <= id->variant) {
1065                 error(_("no remembered resolution for '%s'"), path);
1066                 goto fail_exit;
1067         }
1068
1069         filename = rerere_path(id, "postimage");
1070         if (unlink(filename)) {
1071                 if (errno == ENOENT)
1072                         error(_("no remembered resolution for '%s'"), path);
1073                 else
1074                         error_errno(_("cannot unlink '%s'"), filename);
1075                 goto fail_exit;
1076         }
1077
1078         /*
1079          * Update the preimage so that the user can resolve the
1080          * conflict in the working tree, run us again to record
1081          * the postimage.
1082          */
1083         handle_cache(istate, path, sha1, rerere_path(id, "preimage"));
1084         fprintf_ln(stderr, _("Updated preimage for '%s'"), path);
1085
1086         /*
1087          * And remember that we can record resolution for this
1088          * conflict when the user is done.
1089          */
1090         item = string_list_insert(rr, path);
1091         free_rerere_id(item);
1092         item->util = id;
1093         fprintf(stderr, _("Forgot resolution for '%s'\n"), path);
1094         return 0;
1095
1096 fail_exit:
1097         free(id);
1098         return -1;
1099 }
1100
1101 int rerere_forget(struct repository *r, struct pathspec *pathspec)
1102 {
1103         int i, fd;
1104         struct string_list conflict = STRING_LIST_INIT_DUP;
1105         struct string_list merge_rr = STRING_LIST_INIT_DUP;
1106
1107         if (read_index(r->index) < 0)
1108                 return error(_("index file corrupt"));
1109
1110         fd = setup_rerere(&merge_rr, RERERE_NOAUTOUPDATE);
1111         if (fd < 0)
1112                 return 0;
1113
1114         /*
1115          * The paths may have been resolved (incorrectly);
1116          * recover the original conflicted state and then
1117          * find the conflicted paths.
1118          */
1119         unmerge_index(r->index, pathspec);
1120         find_conflict(r, &conflict);
1121         for (i = 0; i < conflict.nr; i++) {
1122                 struct string_list_item *it = &conflict.items[i];
1123                 if (!match_pathspec(r->index, pathspec, it->string,
1124                                     strlen(it->string), 0, NULL, 0))
1125                         continue;
1126                 rerere_forget_one_path(r->index, it->string, &merge_rr);
1127         }
1128         return write_rr(&merge_rr, fd);
1129 }
1130
1131 /*
1132  * Garbage collection support
1133  */
1134
1135 static timestamp_t rerere_created_at(struct rerere_id *id)
1136 {
1137         struct stat st;
1138
1139         return stat(rerere_path(id, "preimage"), &st) ? (time_t) 0 : st.st_mtime;
1140 }
1141
1142 static timestamp_t rerere_last_used_at(struct rerere_id *id)
1143 {
1144         struct stat st;
1145
1146         return stat(rerere_path(id, "postimage"), &st) ? (time_t) 0 : st.st_mtime;
1147 }
1148
1149 /*
1150  * Remove the recorded resolution for a given conflict ID
1151  */
1152 static void unlink_rr_item(struct rerere_id *id)
1153 {
1154         unlink_or_warn(rerere_path(id, "thisimage"));
1155         remove_variant(id);
1156         id->collection->status[id->variant] = 0;
1157 }
1158
1159 static void prune_one(struct rerere_id *id,
1160                       timestamp_t cutoff_resolve, timestamp_t cutoff_noresolve)
1161 {
1162         timestamp_t then;
1163         timestamp_t cutoff;
1164
1165         then = rerere_last_used_at(id);
1166         if (then)
1167                 cutoff = cutoff_resolve;
1168         else {
1169                 then = rerere_created_at(id);
1170                 if (!then)
1171                         return;
1172                 cutoff = cutoff_noresolve;
1173         }
1174         if (then < cutoff)
1175                 unlink_rr_item(id);
1176 }
1177
1178 void rerere_gc(struct string_list *rr)
1179 {
1180         struct string_list to_remove = STRING_LIST_INIT_DUP;
1181         DIR *dir;
1182         struct dirent *e;
1183         int i;
1184         timestamp_t now = time(NULL);
1185         timestamp_t cutoff_noresolve = now - 15 * 86400;
1186         timestamp_t cutoff_resolve = now - 60 * 86400;
1187
1188         if (setup_rerere(rr, 0) < 0)
1189                 return;
1190
1191         git_config_get_expiry_in_days("gc.rerereresolved", &cutoff_resolve, now);
1192         git_config_get_expiry_in_days("gc.rerereunresolved", &cutoff_noresolve, now);
1193         git_config(git_default_config, NULL);
1194         dir = opendir(git_path("rr-cache"));
1195         if (!dir)
1196                 die_errno(_("unable to open rr-cache directory"));
1197         /* Collect stale conflict IDs ... */
1198         while ((e = readdir(dir))) {
1199                 struct rerere_dir *rr_dir;
1200                 struct rerere_id id;
1201                 int now_empty;
1202
1203                 if (is_dot_or_dotdot(e->d_name))
1204                         continue;
1205                 rr_dir = find_rerere_dir(e->d_name);
1206                 if (!rr_dir)
1207                         continue; /* or should we remove e->d_name? */
1208
1209                 now_empty = 1;
1210                 for (id.variant = 0, id.collection = rr_dir;
1211                      id.variant < id.collection->status_nr;
1212                      id.variant++) {
1213                         prune_one(&id, cutoff_resolve, cutoff_noresolve);
1214                         if (id.collection->status[id.variant])
1215                                 now_empty = 0;
1216                 }
1217                 if (now_empty)
1218                         string_list_append(&to_remove, e->d_name);
1219         }
1220         closedir(dir);
1221
1222         /* ... and then remove the empty directories */
1223         for (i = 0; i < to_remove.nr; i++)
1224                 rmdir(git_path("rr-cache/%s", to_remove.items[i].string));
1225         string_list_clear(&to_remove, 0);
1226         rollback_lock_file(&write_lock);
1227 }
1228
1229 /*
1230  * During a conflict resolution, after "rerere" recorded the
1231  * preimages, abandon them if the user did not resolve them or
1232  * record their resolutions.  And drop $GIT_DIR/MERGE_RR.
1233  *
1234  * NEEDSWORK: shouldn't we be calling this from "reset --hard"?
1235  */
1236 void rerere_clear(struct string_list *merge_rr)
1237 {
1238         int i;
1239
1240         if (setup_rerere(merge_rr, 0) < 0)
1241                 return;
1242
1243         for (i = 0; i < merge_rr->nr; i++) {
1244                 struct rerere_id *id = merge_rr->items[i].util;
1245                 if (!has_rerere_resolution(id)) {
1246                         unlink_rr_item(id);
1247                         rmdir(rerere_path(id, NULL));
1248                 }
1249         }
1250         unlink_or_warn(git_path_merge_rr(the_repository));
1251         rollback_lock_file(&write_lock);
1252 }