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

[PATCH 3/4] log -L: store the path instead of a diff_filespec

From
Thomas Rast <trast@inf.ethz.ch>
Date
Apr 12, 2013, 16:05 UTC
Message-ID
<c4624ce5d381c62e76939455458ae0033e6d1399.1365781999.git.trast@inf.ethz.ch>
In-Reply-To
<cover.1365781999.git.trast@inf.ethz.ch>

line_log_data has held a diff_filespec* since the very early versions of the code. However, the only place in the code where we actually need the full filespec is parse_range_arg(); in all other cases, we are only interested in the path, so there is hardly a reason to store a filespec. Even worse, it causes a lot of redundant ->spec->path pointer dereferencing.

And *even* worse, it caused the following bug. If you merge a rename with a modification to the old filename, like so:

  * Merge
  | \
  |  * Modify foo
  |  |
  *  | Rename foo->bar
  | /
  * Create foo

we internally -- in process_ranges_merge_commit() -- scan all parents. We are mainly looking for one that doesn't have any modifications, so that we can assign all the blame to it and simplify away the merge. In doing so, we run the normal machinery on all parents in a loop. For each parent, we prepare a "working set" line_log_data by making a copy with line_log_data_copy(), which does *not* make a copy of the spec.

Now suppose the rename is the first parent. The diff machinery tells us that the filepair is ('foo', 'bar'). We duly update the path we are interested in:

  rg->spec->path = xstrdup(pair->one->path);

But that 'struct spec' is shared between the output line_log_data and the original input line_log_data. So we just wrecked the state of process_ranges_merge_commit(). When we get around to the second parent, the ranges tell us we are interested in a file 'foo' while the commits touch 'bar'.

So most of this patch is just s/->spec->path/->path/ and associated management changes. This implicitly fixes the bug because we removed the shared parts between input and output of line_log_data_copy(); it is now safe to overwrite the path in the copy.

There's one only somewhat related change: the comment in process_all_files() explains the reasoning behind using 'range' there. That bit of half-correct code had me sidetracked for a while.

Signed-off-by: Thomas Rast <trast@inf.ethz.ch>
---
 line-log.c          | 45 ++++++++++++++++++++++++---------------------
 line-log.h          |  8 ++++++--
 t/t4211-line-log.sh |  2 +-
 3 files changed, 31 insertions(+), 24 deletions(-)
diff --git a/line-log.c b/line-log.c
index 85c7c24..44d1cd5 100644
--- a/line-log.c
+++ b/line-log.c
@@ -265,7 +265,7 @@ static void free_line_log_data(struct line_log_data *r)
 	if (insertion_point)
 		*insertion_point = NULL;
 	while (p) {
-		int cmp = strcmp(p->spec->path, path);
+		int cmp = strcmp(p->path, path);
 		if (!cmp)
 			return p;
 		if (insertion_point && cmp < 0)
@@ -275,22 +275,26 @@ static void free_line_log_data(struct line_log_data *r)
 	return NULL;
 }
 
+/*
+ * Note: takes ownership of 'path', which happens to be what the only
+ * caller needs.
+ */
 static void line_log_data_insert(struct line_log_data **list,
-				 struct diff_filespec *spec,
+				 char *path,
 				 long begin, long end)
 {
 	struct line_log_data *ip;
-	struct line_log_data *p = search_line_log_data(*list, spec->path, &ip);
+	struct line_log_data *p = search_line_log_data(*list, path, &ip);
 
 	if (p) {
 		range_set_append_unsafe(&p->ranges, begin, end);
 		sort_and_merge_range_set(&p->ranges);
-		free_filespec(spec);
+		free(path);
 		return;
 	}
 
 	p = xcalloc(1, sizeof(struct line_log_data));
-	p->spec = spec;
+	p->path = path;
 	range_set_append(&p->ranges, begin, end);
 	if (ip) {
 		p->next = ip->next;
@@ -354,7 +358,7 @@ static void dump_line_log_data(struct line_log_data *r)
 {
 	char buf[4096];
 	while (r) {
-		snprintf(buf, 4096, "file %s\n", r->spec->path);
+		snprintf(buf, 4096, "file %s\n", r->path);
 		dump_range_set(&r->ranges, buf);
 		r = r->next;
 	}
@@ -561,7 +565,7 @@ static const char *nth_line(void *data, long line)
 
 	for_each_string_list_item(item, args) {
 		const char *name_part, *range_part;
-		const char *full_name;
+		char *full_name;
 		struct diff_filespec *spec;
 		long begin = 0, end = 0;
 
@@ -584,7 +588,7 @@ static const char *nth_line(void *data, long line)
 
 		if (parse_range_arg(range_part, nth_line, &cb_data,
 				    lines, &begin, &end,
-				    spec->path))
+				    full_name))
 			die("malformed -L argument '%s'", range_part);
 		if (begin < 1)
 			begin = 1;
@@ -593,8 +597,9 @@ static const char *nth_line(void *data, long line)
 		begin--;
 		if (lines < end || lines < begin)
 			die("file %s has only %ld lines", name_part, lines);
-		line_log_data_insert(&ranges, spec, begin, end);
+		line_log_data_insert(&ranges, full_name, begin, end);
 
+		free_filespec(spec);
 		free(ends);
 		ends = NULL;
 	}
@@ -610,9 +615,7 @@ static struct line_log_data *line_log_data_copy_one(struct line_log_data *r)
 	line_log_data_init(ret);
 	range_set_copy(&ret->ranges, &r->ranges);
 
-	ret->spec = r->spec;
-	assert(ret->spec);
-	ret->spec->count++;
+	ret->path = xstrdup(r->path);
 
 	return ret;
 }
@@ -652,7 +655,7 @@ static struct line_log_data *line_log_data_merge(struct line_log_data *a,
 		else if (!b)
 			cmp = -1;
 		else
-			cmp = strcmp(a->spec->path, b->spec->path);
+			cmp = strcmp(a->path, b->path);
 		if (cmp < 0) {
 			src = a;
 			a = a->next;
@@ -667,8 +670,7 @@ static struct line_log_data *line_log_data_merge(struct line_log_data *a,
 		}
 		d = xmalloc(sizeof(struct line_log_data));
 		line_log_data_init(d);
-		d->spec = src->spec;
-		d->spec->count++;
+		d->path = xstrdup(src->path);
 		*pp = d;
 		pp = &d->next;
 		if (src2)
@@ -741,7 +743,7 @@ void line_log_init(struct rev_info *rev, const char *prefix, struct string_list
 		paths = xmalloc((count+1)*sizeof(char *));
 		r = range;
 		for (i = 0; i < count; i++) {
-			paths[i] = xstrdup(r->spec->path);
+			paths[i] = xstrdup(r->path);
 			r = r->next;
 		}
 		paths[count] = NULL;
@@ -797,7 +799,7 @@ static void filter_diffs_for_paths(struct line_log_data *range, int keep_deletio
 			continue;
 		}
 		for (rg = range; rg; rg = rg->next) {
-			if (!strcmp(rg->spec->path, p->two->path))
+			if (!strcmp(rg->path, p->two->path))
 				break;
 		}
 		if (rg)
@@ -1021,8 +1023,8 @@ static int process_diff_filepair(struct rev_info *rev,
 
 	assert(pair->two->path);
 	while (rg) {
-		assert(rg->spec->path);
-		if (!strcmp(rg->spec->path, pair->two->path))
+		assert(rg->path);
+		if (!strcmp(rg->path, pair->two->path))
 			break;
 		rg = rg->next;
 	}
@@ -1050,7 +1052,8 @@ static int process_diff_filepair(struct rev_info *rev,
 	collect_diff(&file_parent, &file_target, &diff);
 
 	/* NEEDSWORK should apply some heuristics to prevent mismatches */
-	rg->spec->path = xstrdup(pair->one->path);
+	free(rg->path);
+	rg->path = xstrdup(pair->one->path);
 
 	range_set_init(&tmp, 0);
 	range_set_map_across_diff(&tmp, &rg->ranges, &diff, diff_out);
@@ -1096,7 +1099,7 @@ static int process_all_files(struct line_log_data **range_out,
 			struct line_log_data *rg = range;
 			changed++;
 			/* NEEDSWORK tramples over data structures not owned here */
-			while (rg && strcmp(rg->spec->path, queue->queue[i]->two->path))
+			while (rg && strcmp(rg->path, queue->queue[i]->two->path))
 				rg = rg->next;
 			assert(rg);
 			rg->pair = diff_filepair_dup(queue->queue[i]);
diff --git a/line-log.h b/line-log.h
index 9acd123..8bea45f 100644
--- a/line-log.h
+++ b/line-log.h
@@ -26,10 +26,14 @@ struct diff_ranges {
 };
 
 /* Linked list of interesting files and their associated ranges.  The
- * list must be kept sorted by spec->path */
+ * list must be kept sorted by path.
+ *
+ * For simplicity, even though this is highly redundant, each
+ * line_log_data owns its 'path'.
+ */
 struct line_log_data {
 	struct line_log_data *next;
-	struct diff_filespec *spec;
+	char *path;
 	char status;
 	struct range_set ranges;
 	int arg_alloc, arg_nr;
diff --git a/t/t4211-line-log.sh b/t/t4211-line-log.sh
index bba0b09..7776f93 100755
--- a/t/t4211-line-log.sh
+++ b/t/t4211-line-log.sh
@@ -45,7 +45,7 @@ canned_test "-L '/long f/',/^}/:a.c -L /main/,/^}/:a.c simple" two-ranges
 canned_test "-L 24,+1:a.c simple" vanishes-early
 
 canned_test "-M -L '/long f/,/^}/:b.c' move-support" move-support-f
-canned_test_failure "-M -L ':f:b.c' parallel-change" parallel-change-f-to-main
+canned_test "-M -L ':f:b.c' parallel-change" parallel-change-f-to-main
 
 canned_test "-L 4,12:a.c -L :main:a.c simple" multiple
 canned_test "-L 4,18:a.c -L :main:a.c simple" multiple-overlapping
-- 
1.8.2.1.567.g8ad0f43
Previous: Thomas RastNext: Thomas Rast
Message 7 of 8 in “What's cooking in git.git (Apr 2013, #02; Fri, 5)”
  1. Junio C HamanoApr 5, 2013
  2. John KeepingApr 7, 2013
  3. Thomas RastApr 12, 2013
  4. 0/4 fix log -L -MThomas Rast, Apr 12, 2013
  5. 1/4 t4211: pass -M to 'git log -M -L...' testThomas Rast, Apr 12, 2013
  6. 2/4 log -L: test merge of parallel modify/renameThomas Rast, Apr 12, 2013
  7. 3/4 log -L: store the path instead of a diff_filespecThomas Rast, Apr 12, 2013
  8. 4/4 log -L: improve comments in process_all_files()Thomas Rast, Apr 12, 2013

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.