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