ll-merge.c 10.1 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

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,
38
			   const char *path,
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
	if (opts->virtual_ancestor) {
		stolen = orig;
	} else {
		switch (opts->variant) {
		default:
56
			warning("Cannot merge binary files: %s (%s vs. %s)",
57 58
				path, name1, name2);
			/* fallthru */
59 60 61 62 63 64 65 66
		case XDL_MERGE_FAVOR_OURS:
			stolen = src1;
			break;
		case XDL_MERGE_FAVOR_THEIRS:
			stolen = src2;
			break;
		}
	}
67 68 69 70

	result->ptr = stolen->ptr;
	result->size = stolen->size;
	stolen->ptr = NULL;
71 72 73 74 75 76

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

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

	if (buffer_is_binary(orig->ptr, orig->size) ||
	    buffer_is_binary(src1->ptr, src1->size) ||
	    buffer_is_binary(src2->ptr, src2->size)) {
		return ll_binary_merge(drv_unused, result,
95
				       path,
96 97
				       orig, orig_name,
				       src1, name1,
98
				       src2, name2,
99
				       opts, marker_size);
100 101
	}

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

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

#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)
151
		die_errno("unable to write temp-file");
152 153 154 155 156 157 158 159 160
	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,
161
			mmfile_t *orig, const char *orig_name,
162 163
			mmfile_t *src1, const char *name1,
			mmfile_t *src2, const char *name2,
164 165
			const struct ll_merge_options *opts,
			int marker_size)
166
{
167
	char temp[4][50];
168
	struct strbuf cmd = STRBUF_INIT;
169
	struct strbuf_expand_dict_entry dict[5];
170
	const char *args[] = { NULL, NULL };
171 172
	int status, fd, i;
	struct stat st;
173
	assert(opts);
174

175 176 177 178 179 180
	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;

181 182 183 184 185 186 187 188
	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]);
189
	sprintf(temp[3], "%d", marker_size);
190

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

193 194
	args[0] = cmd.buf;
	status = run_command_v_opt(args, RUN_USING_SHELL);
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
	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++)
211
		unlink_or_warn(temp[i]);
212
	strbuf_release(&cmd);
213 214 215 216 217 218 219 220 221
	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;

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

228 229
	if (!strcmp(var, "merge.default"))
		return git_config_string(&default_ll_merge, var, value);
230 231 232 233 234 235

	/*
	 * 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".
	 */
236
	if (parse_config_key(var, "merge", &name, &namelen, &key) < 0 || !name)
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
		return 0;

	/*
	 * Find existing one as we might be processing merge.<name>.var2
	 * after seeing merge.<name>.var1.
	 */
	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);
	}

254 255
	if (!strcmp("name", key))
		return git_config_string(&fn->description, var, value);
256

257
	if (!strcmp("driver", key)) {
258 259 260 261 262 263 264 265 266 267 268 269 270
		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.
271
		 *    %L - conflict marker length
272 273 274 275 276
		 *
		 * The external merge driver should write the results in the
		 * file named by %A, and signal that it has done with zero exit
		 * status.
		 */
277
		fn->cmdline = xstrdup(value);
278 279 280
		return 0;
	}

281 282
	if (!strcmp("recursive", key))
		return git_config_string(&fn->recursive, var, value);
283 284 285 286 287 288 289 290 291

	return 0;
}

static void initialize_ll_merge(void)
{
	if (ll_user_merge_tail)
		return;
	ll_user_merge_tail = &ll_user_merge;
292
	git_config(read_merge_config, NULL);
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
}

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];
}

328
static int git_path_check_merge(const char *path, struct git_attr_check check[2])
329
{
330 331 332 333
	if (!check[0].attr) {
		check[0].attr = git_attr("merge");
		check[1].attr = git_attr("conflict-marker-size");
	}
334
	return git_check_attr(path, 2, check);
335 336
}

337 338 339 340 341 342 343 344 345 346
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);
	}
}

347 348
int ll_merge(mmbuffer_t *result_buf,
	     const char *path,
349
	     mmfile_t *ancestor, const char *ancestor_label,
350 351
	     mmfile_t *ours, const char *our_label,
	     mmfile_t *theirs, const char *their_label,
352
	     const struct ll_merge_options *opts)
353
{
354
	static struct git_attr_check check[2];
355
	static const struct ll_merge_options default_opts;
356 357
	const char *ll_driver_name = NULL;
	int marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
358 359
	const struct ll_merge_driver *driver;

360 361
	if (!opts)
		opts = &default_opts;
362 363

	if (opts->renormalize) {
364 365 366 367
		normalize_file(ancestor, path);
		normalize_file(ours, path);
		normalize_file(theirs, path);
	}
368 369 370 371 372 373 374 375
	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;
		}
	}
376
	driver = find_ll_merge_driver(ll_driver_name);
377
	if (opts->virtual_ancestor && driver->recursive)
378
		driver = find_ll_merge_driver(driver->recursive);
379
	return driver->fn(driver, result_buf, path, ancestor, ancestor_label,
380
			  ours, our_label, theirs, their_label,
381
			  opts, marker_size);
382
}
383 384 385 386 387 388 389 390

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");
391
	if (!git_check_attr(path, 1, &check) && check.value) {
392 393 394 395 396
		marker_size = atoi(check.value);
		if (marker_size <= 0)
			marker_size = DEFAULT_CONFLICT_MARKER_SIZE;
	}
	return marker_size;
397
}