ll-merge.c 10.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * Low level 3-way in-core file merge.
 *
 * Copyright (c) 2007 Junio C Hamano
 */

#include "cache.h"
#include "attr.h"
#include "xdiff-interface.h"
#include "run-command.h"
#include "ll-merge.h"

struct ll_merge_driver;

typedef int (*ll_merge_fn)(const struct ll_merge_driver *,
			   mmbuffer_t *result,
			   const char *path,
18
			   mmfile_t *orig, const char *orig_name,
19 20
			   mmfile_t *src1, const char *name1,
			   mmfile_t *src2, const char *name2,
21
			   const struct ll_merge_options *opts,
22
			   int marker_size);
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

struct ll_merge_driver {
	const char *name;
	const char *description;
	ll_merge_fn fn;
	const char *recursive;
	struct ll_merge_driver *next;
	char *cmdline;
};

/*
 * Built-in low-levels
 */
static int ll_binary_merge(const struct ll_merge_driver *drv_unused,
			   mmbuffer_t *result,
			   const char *path_unused,
39
			   mmfile_t *orig, const char *orig_name,
40 41
			   mmfile_t *src1, const char *name1,
			   mmfile_t *src2, const char *name2,
42 43
			   const struct ll_merge_options *opts,
			   int marker_size)
44
{
45 46 47
	mmfile_t *stolen;
	assert(opts);

48
	/*
49
	 * The tentative merge result is the or common ancestor for an internal merge.
50
	 */
51 52 53 54 55 56 57 58 59 60 61 62 63
	if (opts->virtual_ancestor) {
		stolen = orig;
	} else {
		switch (opts->variant) {
		default:
		case XDL_MERGE_FAVOR_OURS:
			stolen = src1;
			break;
		case XDL_MERGE_FAVOR_THEIRS:
			stolen = src2;
			break;
		}
	}
64 65 66 67

	result->ptr = stolen->ptr;
	result->size = stolen->size;
	stolen->ptr = NULL;
68 69 70 71 72 73

	/*
	 * With -Xtheirs or -Xours, we have cleanly merged;
	 * otherwise we got a conflict.
	 */
	return (opts->variant ? 0 : 1);
74 75 76 77
}

static int ll_xdl_merge(const struct ll_merge_driver *drv_unused,
			mmbuffer_t *result,
78
			const char *path,
79
			mmfile_t *orig, const char *orig_name,
80 81
			mmfile_t *src1, const char *name1,
			mmfile_t *src2, const char *name2,
82 83
			const struct ll_merge_options *opts,
			int marker_size)
84
{
85
	xmparam_t xmp;
86
	assert(opts);
87 88 89 90

	if (buffer_is_binary(orig->ptr, orig->size) ||
	    buffer_is_binary(src1->ptr, src1->size) ||
	    buffer_is_binary(src2->ptr, src2->size)) {
91 92
		warning("Cannot merge binary files: %s (%s vs. %s)\n",
			path, name1, name2);
93
		return ll_binary_merge(drv_unused, result,
94
				       path,
95 96
				       orig, orig_name,
				       src1, name1,
97
				       src2, name2,
98
				       opts, marker_size);
99 100
	}

101
	memset(&xmp, 0, sizeof(xmp));
102
	xmp.level = XDL_MERGE_ZEALOUS;
103
	xmp.favor = opts->variant;
Justin Frankel's avatar
Justin Frankel committed
104
	xmp.xpp.flags = opts->xdl_opts;
105
	if (git_xmerge_style >= 0)
106
		xmp.style = git_xmerge_style;
107 108
	if (marker_size > 0)
		xmp.marker_size = marker_size;
109
	xmp.ancestor = orig_name;
110 111 112
	xmp.file1 = name1;
	xmp.file2 = name2;
	return xdl_merge(orig, src1, src2, &xmp, result);
113 114 115 116 117
}

static int ll_union_merge(const struct ll_merge_driver *drv_unused,
			  mmbuffer_t *result,
			  const char *path_unused,
118
			  mmfile_t *orig, const char *orig_name,
119 120
			  mmfile_t *src1, const char *name1,
			  mmfile_t *src2, const char *name2,
121 122
			  const struct ll_merge_options *opts,
			  int marker_size)
123
{
124
	/* Use union favor */
125 126 127 128
	struct ll_merge_options o;
	assert(opts);
	o = *opts;
	o.variant = XDL_MERGE_FAVOR_UNION;
129
	return ll_xdl_merge(drv_unused, result, path_unused,
130
			    orig, NULL, src1, NULL, src2, NULL,
131
			    &o, marker_size);
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
}

#define LL_BINARY_MERGE 0
#define LL_TEXT_MERGE 1
#define LL_UNION_MERGE 2
static struct ll_merge_driver ll_merge_drv[] = {
	{ "binary", "built-in binary merge", ll_binary_merge },
	{ "text", "built-in 3-way text merge", ll_xdl_merge },
	{ "union", "built-in union merge", ll_union_merge },
};

static void create_temp(mmfile_t *src, char *path)
{
	int fd;

	strcpy(path, ".merge_file_XXXXXX");
	fd = xmkstemp(path);
	if (write_in_full(fd, src->ptr, src->size) != src->size)
150
		die_errno("unable to write temp-file");
151 152 153 154 155 156 157 158 159
	close(fd);
}

/*
 * User defined low-level merge driver support.
 */
static int ll_ext_merge(const struct ll_merge_driver *fn,
			mmbuffer_t *result,
			const char *path,
160
			mmfile_t *orig, const char *orig_name,
161 162
			mmfile_t *src1, const char *name1,
			mmfile_t *src2, const char *name2,
163 164
			const struct ll_merge_options *opts,
			int marker_size)
165
{
166
	char temp[4][50];
167
	struct strbuf cmd = STRBUF_INIT;
168
	struct strbuf_expand_dict_entry dict[5];
169
	const char *args[] = { NULL, NULL };
170 171
	int status, fd, i;
	struct stat st;
172
	assert(opts);
173

174 175 176 177 178 179
	dict[0].placeholder = "O"; dict[0].value = temp[0];
	dict[1].placeholder = "A"; dict[1].value = temp[1];
	dict[2].placeholder = "B"; dict[2].value = temp[2];
	dict[3].placeholder = "L"; dict[3].value = temp[3];
	dict[4].placeholder = NULL; dict[4].value = NULL;

180 181 182 183 184 185 186 187
	if (fn->cmdline == NULL)
		die("custom merge driver %s lacks command line.", fn->name);

	result->ptr = NULL;
	result->size = 0;
	create_temp(orig, temp[0]);
	create_temp(src1, temp[1]);
	create_temp(src2, temp[2]);
188
	sprintf(temp[3], "%d", marker_size);
189

190
	strbuf_expand(&cmd, fn->cmdline, strbuf_expand_dict_cb, &dict);
191

192 193
	args[0] = cmd.buf;
	status = run_command_v_opt(args, RUN_USING_SHELL);
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
	fd = open(temp[1], O_RDONLY);
	if (fd < 0)
		goto bad;
	if (fstat(fd, &st))
		goto close_bad;
	result->size = st.st_size;
	result->ptr = xmalloc(result->size + 1);
	if (read_in_full(fd, result->ptr, result->size) != result->size) {
		free(result->ptr);
		result->ptr = NULL;
		result->size = 0;
	}
 close_bad:
	close(fd);
 bad:
	for (i = 0; i < 3; i++)
210
		unlink_or_warn(temp[i]);
211
	strbuf_release(&cmd);
212 213 214 215 216 217 218 219 220
	return status;
}

/*
 * merge.default and merge.driver configuration items
 */
static struct ll_merge_driver *ll_user_merge, **ll_user_merge_tail;
static const char *default_ll_merge;

221
static int read_merge_config(const char *var, const char *value, void *cb)
222 223 224 225 226 227 228
{
	struct ll_merge_driver *fn;
	const char *ep, *name;
	int namelen;

	if (!strcmp(var, "merge.default")) {
		if (value)
229
			default_ll_merge = xstrdup(value);
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
		return 0;
	}

	/*
	 * We are not interested in anything but "merge.<name>.variable";
	 * especially, we do not want to look at variables such as
	 * "merge.summary", "merge.tool", and "merge.verbosity".
	 */
	if (prefixcmp(var, "merge.") || (ep = strrchr(var, '.')) == var + 5)
		return 0;

	/*
	 * Find existing one as we might be processing merge.<name>.var2
	 * after seeing merge.<name>.var1.
	 */
	name = var + 6;
	namelen = ep - name;
	for (fn = ll_user_merge; fn; fn = fn->next)
		if (!strncmp(fn->name, name, namelen) && !fn->name[namelen])
			break;
	if (!fn) {
		fn = xcalloc(1, sizeof(struct ll_merge_driver));
		fn->name = xmemdupz(name, namelen);
		fn->fn = ll_ext_merge;
		*ll_user_merge_tail = fn;
		ll_user_merge_tail = &(fn->next);
	}

	ep++;

	if (!strcmp("name", ep)) {
		if (!value)
			return error("%s: lacks value", var);
263
		fn->description = xstrdup(value);
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
		return 0;
	}

	if (!strcmp("driver", ep)) {
		if (!value)
			return error("%s: lacks value", var);
		/*
		 * merge.<name>.driver specifies the command line:
		 *
		 *	command-line
		 *
		 * The command-line will be interpolated with the following
		 * tokens and is given to the shell:
		 *
		 *    %O - temporary file name for the merge base.
		 *    %A - temporary file name for our version.
		 *    %B - temporary file name for the other branches' version.
281
		 *    %L - conflict marker length
282 283 284 285 286
		 *
		 * The external merge driver should write the results in the
		 * file named by %A, and signal that it has done with zero exit
		 * status.
		 */
287
		fn->cmdline = xstrdup(value);
288 289 290 291 292 293
		return 0;
	}

	if (!strcmp("recursive", ep)) {
		if (!value)
			return error("%s: lacks value", var);
294
		fn->recursive = xstrdup(value);
295 296 297 298 299 300 301 302 303 304 305
		return 0;
	}

	return 0;
}

static void initialize_ll_merge(void)
{
	if (ll_user_merge_tail)
		return;
	ll_user_merge_tail = &ll_user_merge;
306
	git_config(read_merge_config, NULL);
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
}

static const struct ll_merge_driver *find_ll_merge_driver(const char *merge_attr)
{
	struct ll_merge_driver *fn;
	const char *name;
	int i;

	initialize_ll_merge();

	if (ATTR_TRUE(merge_attr))
		return &ll_merge_drv[LL_TEXT_MERGE];
	else if (ATTR_FALSE(merge_attr))
		return &ll_merge_drv[LL_BINARY_MERGE];
	else if (ATTR_UNSET(merge_attr)) {
		if (!default_ll_merge)
			return &ll_merge_drv[LL_TEXT_MERGE];
		else
			name = default_ll_merge;
	}
	else
		name = merge_attr;

	for (fn = ll_user_merge; fn; fn = fn->next)
		if (!strcmp(fn->name, name))
			return fn;

	for (i = 0; i < ARRAY_SIZE(ll_merge_drv); i++)
		if (!strcmp(ll_merge_drv[i].name, name))
			return &ll_merge_drv[i];

	/* default to the 3-way */
	return &ll_merge_drv[LL_TEXT_MERGE];
}

342
static int git_path_check_merge(const char *path, struct git_attr_check check[2])
343
{
344 345 346 347
	if (!check[0].attr) {
		check[0].attr = git_attr("merge");
		check[1].attr = git_attr("conflict-marker-size");
	}
348
	return git_check_attr(path, 2, check);
349 350
}

351 352 353 354 355 356 357 358 359 360
static void normalize_file(mmfile_t *mm, const char *path)
{
	struct strbuf strbuf = STRBUF_INIT;
	if (renormalize_buffer(path, mm->ptr, mm->size, &strbuf)) {
		free(mm->ptr);
		mm->size = strbuf.len;
		mm->ptr = strbuf_detach(&strbuf, NULL);
	}
}

361 362
int ll_merge(mmbuffer_t *result_buf,
	     const char *path,
363
	     mmfile_t *ancestor, const char *ancestor_label,
364 365
	     mmfile_t *ours, const char *our_label,
	     mmfile_t *theirs, const char *their_label,
366
	     const struct ll_merge_options *opts)
367
{
368
	static struct git_attr_check check[2];
369
	static const struct ll_merge_options default_opts;
370 371
	const char *ll_driver_name = NULL;
	int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
372 373
	const struct ll_merge_driver *driver;

374 375
	if (!opts)
		opts = &default_opts;
376 377

	if (opts->renormalize) {
378 379 380 381
		normalize_file(ancestor, path);
		normalize_file(ours, path);
		normalize_file(theirs, path);
	}
382 383 384 385 386 387 388 389
	if (!git_path_check_merge(path, check)) {
		ll_driver_name = check[0].value;
		if (check[1].value) {
			marker_size = atoi(check[1].value);
			if (marker_size <= 0)
				marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
		}
	}
390
	driver = find_ll_merge_driver(ll_driver_name);
391
	if (opts->virtual_ancestor && driver->recursive)
392
		driver = find_ll_merge_driver(driver->recursive);
393
	return driver->fn(driver, result_buf, path, ancestor, ancestor_label,
394
			  ours, our_label, theirs, their_label,
395
			  opts, marker_size);
396
}
397 398 399 400 401 402 403 404

int ll_merge_marker_size(const char *path)
{
	static struct git_attr_check check;
	int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;

	if (!check.attr)
		check.attr = git_attr("conflict-marker-size");
405
	if (!git_check_attr(path, 1, &check) && check.value) {
406 407 408 409 410
		marker_size = atoi(check.value);
		if (marker_size <= 0)
			marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
	}
	return marker_size;
411
}