merge-ll.c

   1 /*
   2  * Low level 3-way in-core file merge.
   3  *
   4  * Copyright (c) 2007 Junio C Hamano
   5  */
   6
   7 #include "git-compat-util.h"
   8 #include "config.h"
   9 #include "convert.h"
  10 #include "attr.h"
  11 #include "xdiff-interface.h"
  12 #include "run-command.h"
  13 #include "merge-ll.h"
  14 #include "quote.h"
  15 #include "strbuf.h"
  16 #include "wrapper.h"
  17
  18 struct ll_merge_driver;
  19
  20 typedef enum ll_merge_result (*ll_merge_fn)(const struct ll_merge_driver *,
  21                            mmbuffer_t *result,
  22                            const char *path,
  23                            mmfile_t *orig, const char *orig_name,
  24                            mmfile_t *src1, const char *name1,
  25                            mmfile_t *src2, const char *name2,
  26                            const struct ll_merge_options *opts,
  27                            int marker_size);
  28
  29 struct ll_merge_driver {
  30         const char *name;
  31         const char *description;
  32         ll_merge_fn fn;
  33         const char *recursive;
  34         struct ll_merge_driver *next;
  35         char *cmdline;
  36 };
  37
  38 static struct attr_check *merge_attributes;
  39 static struct attr_check *load_merge_attributes(void)
  40 {
  41         if (!merge_attributes)
  42                 merge_attributes = attr_check_initl("merge", "conflict-marker-size", NULL);
  43         return merge_attributes;
  44 }
  45
  46 void reset_merge_attributes(void)
  47 {
  48         attr_check_free(merge_attributes);
  49         merge_attributes = NULL;
  50 }
  51
  52 /*
  53  * Built-in low-levels
  54  */
  55 static enum ll_merge_result ll_binary_merge(const struct ll_merge_driver *drv UNUSED,
  56                            mmbuffer_t *result,
  57                            const char *path UNUSED,
  58                            mmfile_t *orig, const char *orig_name UNUSED,
  59                            mmfile_t *src1, const char *name1 UNUSED,
  60                            mmfile_t *src2, const char *name2 UNUSED,
  61                            const struct ll_merge_options *opts,
  62                            int marker_size UNUSED)
  63 {
  64         enum ll_merge_result ret;
  65         mmfile_t *stolen;
  66         assert(opts);
  67
  68         /*
  69          * The tentative merge result is the common ancestor for an
  70          * internal merge.  For the final merge, it is "ours" by
  71          * default but -Xours/-Xtheirs can tweak the choice.
  72          */
  73         if (opts->virtual_ancestor) {
  74                 stolen = orig;
  75                 ret = LL_MERGE_OK;
  76         } else {
  77                 switch (opts->variant) {
  78                 default:
  79                         ret = LL_MERGE_BINARY_CONFLICT;
  80                         stolen = src1;
  81                         break;
  82                 case XDL_MERGE_FAVOR_OURS:
  83                         ret = LL_MERGE_OK;
  84                         stolen = src1;
  85                         break;
  86                 case XDL_MERGE_FAVOR_THEIRS:
  87                         ret = LL_MERGE_OK;
  88                         stolen = src2;
  89                         break;
  90                 }
  91         }
  92
  93         result->ptr = stolen->ptr;
  94         result->size = stolen->size;
  95         stolen->ptr = NULL;
  96
  97         return ret;
  98 }
  99
 100 static enum ll_merge_result ll_xdl_merge(const struct ll_merge_driver *drv_unused,
 101                         mmbuffer_t *result,
 102                         const char *path,
 103                         mmfile_t *orig, const char *orig_name,
 104                         mmfile_t *src1, const char *name1,
 105                         mmfile_t *src2, const char *name2,
 106                         const struct ll_merge_options *opts,
 107                         int marker_size)
 108 {
 109         enum ll_merge_result ret;
 110         xmparam_t xmp;
 111         int status;
 112         assert(opts);
 113
 114         if (orig->size > MAX_XDIFF_SIZE ||
 115             src1->size > MAX_XDIFF_SIZE ||
 116             src2->size > MAX_XDIFF_SIZE ||
 117             buffer_is_binary(orig->ptr, orig->size) ||
 118             buffer_is_binary(src1->ptr, src1->size) ||
 119             buffer_is_binary(src2->ptr, src2->size)) {
 120                 return ll_binary_merge(drv_unused, result,
 121                                        path,
 122                                        orig, orig_name,
 123                                        src1, name1,
 124                                        src2, name2,
 125                                        opts, marker_size);
 126         }
 127
 128         memset(&xmp, 0, sizeof(xmp));
 129         xmp.level = XDL_MERGE_ZEALOUS;
 130         xmp.favor = opts->variant;
 131         xmp.xpp.flags = opts->xdl_opts;
 132         if (git_xmerge_style >= 0)
 133                 xmp.style = git_xmerge_style;
 134         if (marker_size > 0)
 135                 xmp.marker_size = marker_size;
 136         xmp.ancestor = orig_name;
 137         xmp.file1 = name1;
 138         xmp.file2 = name2;
 139         status = xdl_merge(orig, src1, src2, &xmp, result);
 140         ret = (status > 0) ? LL_MERGE_CONFLICT : status;
 141         return ret;
 142 }
 143
 144 static enum ll_merge_result ll_union_merge(const struct ll_merge_driver *drv_unused,
 145                           mmbuffer_t *result,
 146                           const char *path,
 147                           mmfile_t *orig, const char *orig_name,
 148                           mmfile_t *src1, const char *name1,
 149                           mmfile_t *src2, const char *name2,
 150                           const struct ll_merge_options *opts,
 151                           int marker_size)
 152 {
 153         /* Use union favor */
 154         struct ll_merge_options o;
 155         assert(opts);
 156         o = *opts;
 157         o.variant = XDL_MERGE_FAVOR_UNION;
 158         return ll_xdl_merge(drv_unused, result, path,
 159                             orig, orig_name, src1, name1, src2, name2,
 160                             &o, marker_size);
 161 }
 162
 163 #define LL_BINARY_MERGE 0
 164 #define LL_TEXT_MERGE 1
 165 #define LL_UNION_MERGE 2
 166 static struct ll_merge_driver ll_merge_drv[] = {
 167         { "binary", "built-in binary merge", ll_binary_merge },
 168         { "text", "built-in 3-way text merge", ll_xdl_merge },
 169         { "union", "built-in union merge", ll_union_merge },
 170 };
 171
 172 static void create_temp(mmfile_t *src, char *path, size_t len)
 173 {
 174         int fd;
 175
 176         xsnprintf(path, len, ".merge_file_XXXXXX");
 177         fd = xmkstemp(path);
 178         if (write_in_full(fd, src->ptr, src->size) < 0)
 179                 die_errno("unable to write temp-file");
 180         close(fd);
 181 }
 182
 183 /*
 184  * User defined low-level merge driver support.
 185  */
 186 static enum ll_merge_result ll_ext_merge(const struct ll_merge_driver *fn,
 187                         mmbuffer_t *result,
 188                         const char *path,
 189                         mmfile_t *orig, const char *orig_name UNUSED,
 190                         mmfile_t *src1, const char *name1 UNUSED,
 191                         mmfile_t *src2, const char *name2 UNUSED,
 192                         const struct ll_merge_options *opts,
 193                         int marker_size)
 194 {
 195         char temp[4][50];
 196         struct strbuf cmd = STRBUF_INIT;
 197         struct strbuf_expand_dict_entry dict[6];
 198         struct strbuf path_sq = STRBUF_INIT;
 199         struct child_process child = CHILD_PROCESS_INIT;
 200         int status, fd, i;
 201         struct stat st;
 202         enum ll_merge_result ret;
 203         assert(opts);
 204
 205         sq_quote_buf(&path_sq, path);
 206         dict[0].placeholder = "O"; dict[0].value = temp[0];
 207         dict[1].placeholder = "A"; dict[1].value = temp[1];
 208         dict[2].placeholder = "B"; dict[2].value = temp[2];
 209         dict[3].placeholder = "L"; dict[3].value = temp[3];
 210         dict[4].placeholder = "P"; dict[4].value = path_sq.buf;
 211         dict[5].placeholder = NULL; dict[5].value = NULL;
 212
 213         if (!fn->cmdline)
 214                 die("custom merge driver %s lacks command line.", fn->name);
 215
 216         result->ptr = NULL;
 217         result->size = 0;
 218         create_temp(orig, temp[0], sizeof(temp[0]));
 219         create_temp(src1, temp[1], sizeof(temp[1]));
 220         create_temp(src2, temp[2], sizeof(temp[2]));
 221         xsnprintf(temp[3], sizeof(temp[3]), "%d", marker_size);
 222
 223         strbuf_expand(&cmd, fn->cmdline, strbuf_expand_dict_cb, &dict);
 224
 225         child.use_shell = 1;
 226         strvec_push(&child.args, cmd.buf);
 227         status = run_command(&child);
 228         fd = open(temp[1], O_RDONLY);
 229         if (fd < 0)
 230                 goto bad;
 231         if (fstat(fd, &st))
 232                 goto close_bad;
 233         result->size = st.st_size;
 234         result->ptr = xmallocz(result->size);
 235         if (read_in_full(fd, result->ptr, result->size) != result->size) {
 236                 FREE_AND_NULL(result->ptr);
 237                 result->size = 0;
 238         }
 239  close_bad:
 240         close(fd);
 241  bad:
 242         for (i = 0; i < 3; i++)
 243                 unlink_or_warn(temp[i]);
 244         strbuf_release(&cmd);
 245         strbuf_release(&path_sq);
 246
 247         if (!status)
 248                 ret = LL_MERGE_OK;
 249         else if (status <= 128)
 250                 ret = LL_MERGE_CONFLICT;
 251         else
 252                 /* died due to a signal: WTERMSIG(status) + 128 */
 253                 ret = LL_MERGE_ERROR;
 254         return ret;
 255 }
 256
 257 /*
 258  * merge.default and merge.driver configuration items
 259  */
 260 static struct ll_merge_driver *ll_user_merge, **ll_user_merge_tail;
 261 static const char *default_ll_merge;
 262
 263 static int read_merge_config(const char *var, const char *value,
 264                              void *cb UNUSED)
 265 {
 266         struct ll_merge_driver *fn;
 267         const char *key, *name;
 268         size_t namelen;
 269
 270         if (!strcmp(var, "merge.default"))
 271                 return git_config_string(&default_ll_merge, var, value);
 272
 273         /*
 274          * We are not interested in anything but "merge.<name>.variable";
 275          * especially, we do not want to look at variables such as
 276          * "merge.summary", "merge.tool", and "merge.verbosity".
 277          */
 278         if (parse_config_key(var, "merge", &name, &namelen, &key) < 0 || !name)
 279                 return 0;
 280
 281         /*
 282          * Find existing one as we might be processing merge.<name>.var2
 283          * after seeing merge.<name>.var1.
 284          */
 285         for (fn = ll_user_merge; fn; fn = fn->next)
 286                 if (!strncmp(fn->name, name, namelen) && !fn->name[namelen])
 287                         break;
 288         if (!fn) {
 289                 CALLOC_ARRAY(fn, 1);
 290                 fn->name = xmemdupz(name, namelen);
 291                 fn->fn = ll_ext_merge;
 292                 *ll_user_merge_tail = fn;
 293                 ll_user_merge_tail = &(fn->next);
 294         }
 295
 296         if (!strcmp("name", key))
 297                 return git_config_string(&fn->description, var, value);
 298
 299         if (!strcmp("driver", key)) {
 300                 if (!value)
 301                         return error("%s: lacks value", var);
 302                 /*
 303                  * merge.<name>.driver specifies the command line:
 304                  *
 305                  *      command-line
 306                  *
 307                  * The command-line will be interpolated with the following
 308                  * tokens and is given to the shell:
 309                  *
 310                  *    %O - temporary file name for the merge base.
 311                  *    %A - temporary file name for our version.
 312                  *    %B - temporary file name for the other branches' version.
 313                  *    %L - conflict marker length
 314                  *    %P - the original path (safely quoted for the shell)
 315                  *
 316                  * The external merge driver should write the results in the
 317                  * file named by %A, and signal that it has done with zero exit
 318                  * status.
 319                  */
 320                 fn->cmdline = xstrdup(value);
 321                 return 0;
 322         }
 323
 324         if (!strcmp("recursive", key))
 325                 return git_config_string(&fn->recursive, var, value);
 326
 327         return 0;
 328 }
 329
 330 static void initialize_ll_merge(void)
 331 {
 332         if (ll_user_merge_tail)
 333                 return;
 334         ll_user_merge_tail = &ll_user_merge;
 335         git_config(read_merge_config, NULL);
 336 }
 337
 338 static const struct ll_merge_driver *find_ll_merge_driver(const char *merge_attr)
 339 {
 340         struct ll_merge_driver *fn;
 341         const char *name;
 342         int i;
 343
 344         initialize_ll_merge();
 345
 346         if (ATTR_TRUE(merge_attr))
 347                 return &ll_merge_drv[LL_TEXT_MERGE];
 348         else if (ATTR_FALSE(merge_attr))
 349                 return &ll_merge_drv[LL_BINARY_MERGE];
 350         else if (ATTR_UNSET(merge_attr)) {
 351                 if (!default_ll_merge)
 352                         return &ll_merge_drv[LL_TEXT_MERGE];
 353                 else
 354                         name = default_ll_merge;
 355         }
 356         else
 357                 name = merge_attr;
 358
 359         for (fn = ll_user_merge; fn; fn = fn->next)
 360                 if (!strcmp(fn->name, name))
 361                         return fn;
 362
 363         for (i = 0; i < ARRAY_SIZE(ll_merge_drv); i++)
 364                 if (!strcmp(ll_merge_drv[i].name, name))
 365                         return &ll_merge_drv[i];
 366
 367         /* default to the 3-way */
 368         return &ll_merge_drv[LL_TEXT_MERGE];
 369 }
 370
 371 static void normalize_file(mmfile_t *mm, const char *path, struct index_state *istate)
 372 {
 373         struct strbuf strbuf = STRBUF_INIT;
 374         if (renormalize_buffer(istate, path, mm->ptr, mm->size, &strbuf)) {
 375                 free(mm->ptr);
 376                 mm->size = strbuf.len;
 377                 mm->ptr = strbuf_detach(&strbuf, NULL);
 378         }
 379 }
 380
 381 enum ll_merge_result ll_merge(mmbuffer_t *result_buf,
 382              const char *path,
 383              mmfile_t *ancestor, const char *ancestor_label,
 384              mmfile_t *ours, const char *our_label,
 385              mmfile_t *theirs, const char *their_label,
 386              struct index_state *istate,
 387              const struct ll_merge_options *opts)
 388 {
 389         struct attr_check *check = load_merge_attributes();
 390         static const struct ll_merge_options default_opts;
 391         const char *ll_driver_name = NULL;
 392         int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
 393         const struct ll_merge_driver *driver;
 394
 395         if (!opts)
 396                 opts = &default_opts;
 397
 398         if (opts->renormalize) {
 399                 normalize_file(ancestor, path, istate);
 400                 normalize_file(ours, path, istate);
 401                 normalize_file(theirs, path, istate);
 402         }
 403
 404         git_check_attr(istate, path, check);
 405         ll_driver_name = check->items[0].value;
 406         if (check->items[1].value) {
 407                 marker_size = atoi(check->items[1].value);
 408                 if (marker_size <= 0)
 409                         marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
 410         }
 411         driver = find_ll_merge_driver(ll_driver_name);
 412
 413         if (opts->virtual_ancestor) {
 414                 if (driver->recursive)
 415                         driver = find_ll_merge_driver(driver->recursive);
 416         }
 417         if (opts->extra_marker_size) {
 418                 marker_size += opts->extra_marker_size;
 419         }
 420         return driver->fn(driver, result_buf, path, ancestor, ancestor_label,
 421                           ours, our_label, theirs, their_label,
 422                           opts, marker_size);
 423 }
 424
 425 int ll_merge_marker_size(struct index_state *istate, const char *path)
 426 {
 427         static struct attr_check *check;
 428         int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
 429
 430         if (!check)
 431                 check = attr_check_initl("conflict-marker-size", NULL);
 432         git_check_attr(istate, path, check);
 433         if (check->items[0].value) {
 434                 marker_size = atoi(check->items[0].value);
 435                 if (marker_size <= 0)
 436                         marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
 437         }
 438         return marker_size;
 439 }