git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v3 09/24] merge-recursive: exit early if index != head

From
Elijah Newren <newren@gmail.com>
Date
Aug 15, 2019, 21:40 UTC
Message-ID
<20190815214053.16594-10-newren@gmail.com>
In-Reply-To
<20190815214053.16594-1-newren@gmail.com>

We had a rule to enforce that the index matches head, but it was found at the beginning of merge_trees() and would only trigger when opt->call_depth was 0. Since merge_recursive() doesn't call merge_trees() until after returning from recursing, this meant that the check wasn't triggered by merge_recursive() until it had first finished all the intermediate merges to create virtual merge bases. That is a potentially huge amount of computation (and writing of intermediate merge results into the .git/objects directory) before it errors out and says, in effect, "Sorry, I can't do any merging because you have some local changes that would be overwritten."

Further, not enforcing this requirement earlier allowed other bugs (such as an unintentional unconditional dropping and reloading of the index in merge_recursive() even when no recursion was necessary), to mask bugs in other callers (which were fixed in the commit prior to this one).

Make sure we do the index == head check at the beginning of the merge, and error out immediately if it fails. While we're at it, fix a small leak in the show-the-error codepath.

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 merge-recursive.c | 101 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 72 insertions(+), 29 deletions(-)
diff --git a/merge-recursive.c b/merge-recursive.c
index fb668fc84c..ded2e1bcfb 100644
--- a/merge-recursive.c
+++ b/merge-recursive.c
@@ -3382,23 +3382,14 @@ static int process_entry(struct merge_options *opt,
 	return clean_merge;
 }
 
-int merge_trees(struct merge_options *opt,
-		struct tree *head,
-		struct tree *merge,
-		struct tree *common,
-		struct tree **result)
+static int merge_trees_internal(struct merge_options *opt,
+				struct tree *head,
+				struct tree *merge,
+				struct tree *common,
+				struct tree **result)
 {
 	struct index_state *istate = opt->repo->index;
 	int code, clean;
-	struct strbuf sb = STRBUF_INIT;
-
-	assert(opt->ancestor != NULL);
-
-	if (!opt->call_depth && repo_index_has_changes(opt->repo, head, &sb)) {
-		err(opt, _("Your local changes to the following files would be overwritten by merge:\n  %s"),
-		    sb.buf);
-		return -1;
-	}
 
 	if (opt->subtree_shift) {
 		merge = shift_tree_object(opt->repo, head, merge, opt->subtree_shift);
@@ -3502,11 +3493,11 @@ static struct commit_list *reverse_commit_list(struct commit_list *list)
  * Merge the commits h1 and h2, return the resulting virtual
  * commit object and a flag indicating the cleanness of the merge.
  */
-int merge_recursive(struct merge_options *opt,
-		    struct commit *h1,
-		    struct commit *h2,
-		    struct commit_list *ca,
-		    struct commit **result)
+static int merge_recursive_internal(struct merge_options *opt,
+				    struct commit *h1,
+				    struct commit *h2,
+				    struct commit_list *ca,
+				    struct commit **result)
 {
 	struct commit_list *iter;
 	struct commit *merged_common_ancestors;
@@ -3515,9 +3506,6 @@ int merge_recursive(struct merge_options *opt,
 	int num_merge_bases;
 	struct strbuf merge_base_abbrev = STRBUF_INIT;
 
-	if (!opt->call_depth)
-		assert(opt->ancestor == NULL);
-
 	if (show(opt, 4)) {
 		output(opt, 4, _("Merging:"));
 		output_commit_title(opt, h1);
@@ -3564,7 +3552,7 @@ int merge_recursive(struct merge_options *opt,
 		saved_b2 = opt->branch2;
 		opt->branch1 = "Temporary merge branch 1";
 		opt->branch2 = "Temporary merge branch 2";
-		if (merge_recursive(opt, merged_common_ancestors, iter->item,
+		if (merge_recursive_internal(opt, merged_common_ancestors, iter->item,
 				    NULL, &merged_common_ancestors) < 0)
 			return -1;
 		opt->branch1 = saved_b1;
@@ -3592,12 +3580,12 @@ int merge_recursive(struct merge_options *opt,
 	default:
 		opt->ancestor = "merged common ancestors";
 	}
-	clean = merge_trees(opt,
-			    repo_get_commit_tree(opt->repo, h1),
-			    repo_get_commit_tree(opt->repo, h2),
-			    repo_get_commit_tree(opt->repo,
-						 merged_common_ancestors),
-			    &mrtree);
+	clean = merge_trees_internal(opt,
+				     repo_get_commit_tree(opt->repo, h1),
+				     repo_get_commit_tree(opt->repo, h2),
+				     repo_get_commit_tree(opt->repo,
+							  merged_common_ancestors),
+				     &mrtree);
 	strbuf_release(&merge_base_abbrev);
 	if (clean < 0) {
 		flush_output(opt);
@@ -3618,6 +3606,61 @@ int merge_recursive(struct merge_options *opt,
 	return clean;
 }
 
+static int merge_start(struct merge_options *opt, struct tree *head)
+{
+	struct strbuf sb = STRBUF_INIT;
+
+	if (repo_index_has_changes(opt->repo, head, &sb)) {
+		err(opt, _("Your local changes to the following files would be overwritten by merge:\n  %s"),
+		    sb.buf);
+		strbuf_release(&sb);
+		return -1;
+	}
+
+	return 0;
+}
+
+static void merge_finalize(struct merge_options *opt)
+{
+	/* Common code for wrapping up merges will be added here later */
+}
+
+int merge_trees(struct merge_options *opt,
+		struct tree *head,
+		struct tree *merge,
+		struct tree *common,
+		struct tree **result)
+{
+	int clean;
+
+	assert(opt->ancestor != NULL);
+
+	if (merge_start(opt, head))
+		return -1;
+	clean = merge_trees_internal(opt, head, merge, common, result);
+	merge_finalize(opt);
+
+	return clean;
+}
+
+int merge_recursive(struct merge_options *opt,
+		    struct commit *h1,
+		    struct commit *h2,
+		    struct commit_list *ca,
+		    struct commit **result)
+{
+	int clean;
+
+	assert(opt->ancestor == NULL);
+
+	if (merge_start(opt, repo_get_commit_tree(opt->repo, h1)))
+		return -1;
+	clean = merge_recursive_internal(opt, h1, h2, ca, result);
+	merge_finalize(opt);
+
+	return clean;
+}
+
 static struct commit *get_ref(struct repository *repo, const struct object_id *oid,
 			      const char *name)
 {
-- 
2.23.0.rc2.32.g2123e9e4e4
Previous: Elijah NewrenNext: Elijah Newren
Message 88 of 157 in “Cleanup merge API”
  1. 00/19 Cleanup merge APIElijah Newren, Jul 25, 2019
  2. 01/19 merge-recursive: fix minor memory leak in error conditionElijah Newren, Jul 25, 2019
  3. 02/19 merge-recursive: remove another implicit dependency on the_repositoryElijah Newren, Jul 25, 2019
  4. 05/19 merge-recursive: don't force external callers to do our loggingElijah Newren, Jul 25, 2019
  5. 04/19 merge-recursive: exit early if index != headElijah Newren, Jul 25, 2019
  6. Johannes SchindelinJul 25, 2019
  7. Elijah NewrenJul 25, 2019
  8. 03/19 Ensure index matches head before invoking merge machinery, round NElijah Newren, Jul 25, 2019
  9. Johannes SchindelinJul 25, 2019
  10. Elijah NewrenJul 25, 2019
  11. Johannes SchindelinJul 26, 2019
  12. 07/19 Move write_tree_from_memory() from merge-recursive to cache-treeElijah Newren, Jul 25, 2019
  13. 08/19 merge-recursive: fix some overly long linesElijah Newren, Jul 25, 2019
  14. 09/19 merge-recursive: use common name for ancestors/common/base_listElijah Newren, Jul 25, 2019
  15. 10/19 merge-recursive: rename 'mrtree' to 'result_tree', for clarityElijah Newren, Jul 25, 2019
  16. Johannes SchindelinJul 25, 2019
  17. 11/19 merge-recursive: rename merge_options argument to opt in headerElijah Newren, Jul 25, 2019
  18. 13/19 merge-recursive: consolidate unnecessary fields in merge_optionsElijah Newren, Jul 25, 2019
  19. 12/19 merge-recursive: move some definitions around to clean up the headerElijah Newren, Jul 25, 2019
  20. 15/19 merge-recursive: split internal fields into a separate structElijah Newren, Jul 25, 2019
  21. Johannes SchindelinJul 25, 2019
  22. Elijah NewrenJul 25, 2019
  23. Johannes SchindelinJul 26, 2019
  24. Elijah NewrenJul 26, 2019
  25. 17/19 merge-recursive: rename MERGE_RECURSIVE_* to MERGE_VARIANT_*Elijah Newren, Jul 25, 2019
  26. 16/19 merge-recursive: alphabetize include listElijah Newren, Jul 25, 2019
  27. 18/19 merge-recursive: be consistent with assertElijah Newren, Jul 25, 2019
  28. 19/19 merge-recursive: provide a better label for diff3 common ancestorElijah Newren, Jul 25, 2019
  29. Johannes SchindelinJul 25, 2019
  30. 06/19 Change call signature of write_tree_from_memory()Elijah Newren, Jul 25, 2019
  31. Johannes SchindelinJul 25, 2019
  32. Elijah NewrenJul 26, 2019
  33. 14/19 merge-recursive: comment and reorder the merge_options fieldsElijah Newren, Jul 25, 2019
  34. Junio C HamanoJul 25, 2019
  35. Elijah NewrenJul 25, 2019
  36. Junio C HamanoJul 25, 2019
  37. Johannes SchindelinJul 26, 2019
  38. Johannes SchindelinJul 25, 2019
  39. Elijah NewrenJul 26, 2019
  40. 00/20 Cleanup merge APIElijah Newren, Jul 26, 2019
  41. 01/20 merge-recursive: fix minor memory leak in error conditionElijah Newren, Jul 26, 2019
  42. Junio C HamanoJul 26, 2019
  43. Elijah NewrenJul 26, 2019
  44. Derrick StoleeJul 29, 2019
  45. 03/20 Ensure index matches head before invoking merge machinery, round NElijah Newren, Jul 26, 2019
  46. Junio C HamanoJul 26, 2019
  47. Elijah NewrenJul 26, 2019
  48. 02/20 merge-recursive: remove another implicit dependency on the_repositoryElijah Newren, Jul 26, 2019
  49. Junio C HamanoJul 26, 2019
  50. 04/20 merge-recursive: exit early if index != headElijah Newren, Jul 26, 2019
  51. Junio C HamanoJul 26, 2019
  52. Elijah NewrenJul 26, 2019
  53. Junio C HamanoJul 29, 2019
  54. 05/20 merge-recursive: remove useless parameter in merge_trees()Elijah Newren, Jul 26, 2019
  55. Junio C HamanoJul 26, 2019
  56. 07/20 Use write_index_as_tree() in lieu of write_tree_from_memory()Elijah Newren, Jul 26, 2019
  57. Junio C HamanoJul 26, 2019
  58. Elijah NewrenJul 26, 2019
  59. Junio C HamanoJul 29, 2019
  60. 08/20 merge-recursive: fix some overly long linesElijah Newren, Jul 26, 2019
  61. 06/20 merge-recursive: don't force external callers to do our loggingElijah Newren, Jul 26, 2019
  62. Junio C HamanoJul 26, 2019
  63. Elijah NewrenJul 26, 2019
  64. 10/20 merge-recursive: rename 'mrtree' to 'result_tree', for clarityElijah Newren, Jul 26, 2019
  65. 11/20 merge-recursive: rename merge_options argument to opt in headerElijah Newren, Jul 26, 2019
  66. 09/20 merge-recursive: use common name for ancestors/common/base_listElijah Newren, Jul 26, 2019
  67. 14/20 merge-recursive: comment and reorder the merge_options fieldsElijah Newren, Jul 26, 2019
  68. 13/20 merge-recursive: consolidate unnecessary fields in merge_optionsElijah Newren, Jul 26, 2019
  69. 15/20 merge-recursive: avoid losing output and leaking memory holding that outputElijah Newren, Jul 26, 2019
  70. 12/20 merge-recursive: move some definitions around to clean up the headerElijah Newren, Jul 26, 2019
  71. 16/20 merge-recursive: split internal fields into a separate structElijah Newren, Jul 26, 2019
  72. 17/20 merge-recursive: alphabetize include listElijah Newren, Jul 26, 2019
  73. 18/20 merge-recursive: rename MERGE_RECURSIVE_* to MERGE_VARIANT_*Elijah Newren, Jul 26, 2019
  74. 20/20 merge-recursive: provide a better label for diff3 common ancestorElijah Newren, Jul 26, 2019
  75. 19/20 merge-recursive: be consistent with assertElijah Newren, Jul 26, 2019
  76. 00/24 Clean up merge APIElijah Newren, Aug 15, 2019
  77. 01/24 merge-recursive: be consistent with assertElijah Newren, Aug 15, 2019
  78. 03/24 merge-recursive: enforce opt->ancestor != NULL when calling merge_trees()Elijah Newren, Aug 15, 2019
  79. Junio C HamanoAug 16, 2019
  80. 02/24 checkout: provide better conflict hunk description with detached HEADElijah Newren, Aug 15, 2019
  81. 04/24 merge-recursive: provide a better label for diff3 common ancestorElijah Newren, Aug 15, 2019
  82. Junio C HamanoAug 16, 2019
  83. Elijah NewrenAug 16, 2019
  84. 05/24 merge-recursive: introduce an enum for detect_directory_renames valuesElijah Newren, Aug 15, 2019
  85. 06/24 merge-recursive: future-proof update_file_flags() against memory leaksElijah Newren, Aug 15, 2019
  86. 07/24 merge-recursive: remove another implicit dependency on the_repositoryElijah Newren, Aug 15, 2019
  87. 08/24 Ensure index matches head before invoking merge machinery, round NElijah Newren, Aug 15, 2019
  88. 09/24 merge-recursive: exit early if index != headElijah Newren, Aug 15, 2019
  89. 10/24 merge-recursive: remove useless parameter in merge_trees()Elijah Newren, Aug 15, 2019
  90. 11/24 merge-recursive: don't force external callers to do our loggingElijah Newren, Aug 15, 2019
  91. 15/24 merge-recursive: rename 'mrtree' to 'result_tree', for clarityElijah Newren, Aug 15, 2019
  92. 14/24 merge-recursive: use common name for ancestors/common/base_listElijah Newren, Aug 15, 2019
  93. 13/24 merge-recursive: fix some overly long linesElijah Newren, Aug 15, 2019
  94. 12/24 cache-tree: share code between functions writing an index as a treeElijah Newren, Aug 15, 2019
  95. Junio C HamanoAug 16, 2019
  96. Elijah NewrenAug 16, 2019
  97. 16/24 merge-recursive: rename merge_options argument to opt in headerElijah Newren, Aug 15, 2019
  98. 17/24 merge-recursive: move some definitions around to clean up the headerElijah Newren, Aug 15, 2019
  99. 19/24 merge-recursive: comment and reorder the merge_options fieldsElijah Newren, Aug 15, 2019
  100. 20/24 merge-recursive: avoid losing output and leaking memory holding that outputElijah Newren, Aug 15, 2019
  101. 24/24 merge-recursive: alphabetize include listElijah Newren, Aug 15, 2019
  102. 21/24 merge-recursive: split internal fields into a separate structElijah Newren, Aug 15, 2019
  103. SZEDER GáborAug 16, 2019
  104. Elijah NewrenAug 16, 2019
  105. Junio C HamanoAug 16, 2019
  106. 18/24 merge-recursive: consolidate unnecessary fields in merge_optionsElijah Newren, Aug 15, 2019
  107. Junio C HamanoAug 16, 2019
  108. Elijah NewrenAug 16, 2019
  109. Junio C HamanoAug 16, 2019
  110. 23/24 merge-recursive: add sanity checks for relevant merge_optionsElijah Newren, Aug 15, 2019
  111. Junio C HamanoAug 16, 2019
  112. Elijah NewrenAug 16, 2019
  113. Junio C HamanoAug 16, 2019
  114. Junio C HamanoAug 16, 2019
  115. Elijah NewrenAug 16, 2019
  116. 22/24 merge-recursive: rename MERGE_RECURSIVE_* to MERGE_VARIANT_*Elijah Newren, Aug 15, 2019
  117. 00/24 Clean up merge APIElijah Newren, Aug 17, 2019
  118. 01/24 merge-recursive: be consistent with assertElijah Newren, Aug 17, 2019
  119. 02/24 checkout: provide better conflict hunk description with detached HEADElijah Newren, Aug 17, 2019
  120. 03/24 merge-recursive: enforce opt->ancestor != NULL when calling merge_trees()Elijah Newren, Aug 17, 2019
  121. 04/24 merge-recursive: provide a better label for diff3 common ancestorElijah Newren, Aug 17, 2019
  122. Jeff KingSep 30, 2019
  123. Jeff KingSep 30, 2019
  124. merge-recursive: fix the diff3 common ancestor label for virtual commitsElijah Newren, Sep 30, 2019
  125. Elijah NewrenOct 1, 2019
  126. merge-recursive: fix the diff3 common ancestor label for virtual commitsElijah Newren, Oct 1, 2019
  127. Jeff KingOct 1, 2019
  128. merge-recursive: fix the diff3 common ancestor label for virtual commitsElijah Newren, Oct 1, 2019
  129. Junio C HamanoOct 7, 2019
  130. merge-recursive: fix the fix to the diff3 common ancestor labelElijah Newren, Oct 7, 2019
  131. Junio C HamanoOct 8, 2019
  132. Junio C HamanoOct 8, 2019
  133. Elijah NewrenOct 8, 2019
  134. 05/24 merge-recursive: introduce an enum for detect_directory_renames valuesElijah Newren, Aug 17, 2019
  135. 06/24 merge-recursive: future-proof update_file_flags() against memory leaksElijah Newren, Aug 17, 2019
  136. 09/24 merge-recursive: exit early if index != headElijah Newren, Aug 17, 2019
  137. 08/24 Ensure index matches head before invoking merge machinery, round NElijah Newren, Aug 17, 2019
  138. Johannes SchindelinSep 2, 2019
  139. Johannes SchindelinSep 3, 2019
  140. Elijah NewrenSep 3, 2019
  141. 10/24 merge-recursive: remove useless parameter in merge_trees()Elijah Newren, Aug 17, 2019
  142. 11/24 merge-recursive: don't force external callers to do our loggingElijah Newren, Aug 17, 2019
  143. 13/24 merge-recursive: fix some overly long linesElijah Newren, Aug 17, 2019
  144. 12/24 cache-tree: share code between functions writing an index as a treeElijah Newren, Aug 17, 2019
  145. 14/24 merge-recursive: use common name for ancestors/common/base_listElijah Newren, Aug 17, 2019
  146. 15/24 merge-recursive: rename 'mrtree' to 'result_tree', for clarityElijah Newren, Aug 17, 2019
  147. 17/24 merge-recursive: move some definitions around to clean up the headerElijah Newren, Aug 17, 2019
  148. 07/24 merge-recursive: remove another implicit dependency on the_repositoryElijah Newren, Aug 17, 2019
  149. 16/24 merge-recursive: rename merge_options argument to opt in headerElijah Newren, Aug 17, 2019
  150. 20/24 merge-recursive: avoid losing output and leaking memory holding that outputElijah Newren, Aug 17, 2019
  151. 21/24 merge-recursive: split internal fields into a separate structElijah Newren, Aug 17, 2019
  152. Junio C HamanoAug 19, 2019
  153. 19/24 merge-recursive: comment and reorder the merge_options fieldsElijah Newren, Aug 17, 2019
  154. 18/24 merge-recursive: consolidate unnecessary fields in merge_optionsElijah Newren, Aug 17, 2019
  155. 22/24 merge-recursive: rename MERGE_RECURSIVE_* to MERGE_VARIANT_*Elijah Newren, Aug 17, 2019
  156. 24/24 merge-recursive: alphabetize include listElijah Newren, Aug 17, 2019
  157. 23/24 merge-recursive: add sanity checks for relevant merge_optionsElijah Newren, Aug 17, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.