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

Re: [PATCH v3 14/14] builtin/commit-graph.c: introduce '--max-new-filters=<n>'

From
Derrick Stolee <stolee@gmail.com>
Date
Aug 12, 2020, 12:29 UTC
Message-ID
<ee5c0db0-6582-f039-96e1-be64ee4fe7a6@gmail.com>
In-Reply-To
<09f6871f66bff838c067a3e0d23cd4622171f3bd.1597178915.git.me@ttaylorr.com>
On 8/11/2020 4:52 PM, Taylor Blau wrote:
Show 11 quoted lines
> Introduce a command-line flag and configuration variable to fill in the
> 'max_new_filters' variable introduced by the previous patch.
> 
> The command-line option '--max-new-filters' takes precedence over
> 'commitGraph.maxNewFilters', which is the default value.
> '--no-max-new-filters' can also be provided, which sets the value back
> to '-1', indicating that an unlimited number of new Bloom filters may be
> generated. (OPT_INTEGER only allows setting the '--no-' variant back to
> '0', hence a custom callback was used instead).
> 
> Signed-off-by: Taylor Blau <me@ttaylorr.com>
...
Show 23 quoted lines
> diff --git a/bloom.c b/bloom.c
> index ed54e96e57..8d07209c6b 100644
> --- a/bloom.c
> +++ b/bloom.c
> @@ -51,6 +51,21 @@ static int load_bloom_filter_from_graph(struct commit_graph *g,
>  	else
>  		start_index = 0;
>  
> +	if ((start_index == end_index) &&
> +	    (g->bloom_large && !bitmap_get(g->bloom_large, lex_pos))) {
> +		/*
> +		 * If the filter is zero-length, either (1) the filter has no
> +		 * changes, (2) the filter has too many changes, or (3) it
> +		 * wasn't computed (eg., due to '--max-new-filters').
> +		 *
> +		 * If either (1) or (2) is the case, the 'large' bit will be set
> +		 * for this Bloom filter. If it is unset, then it wasn't
> +		 * computed. In that case, return nothing, since we don't have
> +		 * that filter in the graph.
> +		 */
> +		return 0;
> +	}
> +

Here, you are creating a distinction between an "empty" filter and a "too large" filter at a place that I don't think is important.

For instance, this code will be triggered by "git log -- <path>" but you only care about the filter being too large when writing the commit-graph. I think this check for a "too large" filter should instead be inside get_or_compute_bloom_filter(). I include a patch below that applies on top of tb/bloom-improvements that gets to my point (and how minor the issue might be).

Thanks, -Stolee

--- >8 ---
From 92a7a3d0f769fad7617426730cb97584a3d07794 Mon Sep 17 00:00:00 2001
From: Derrick Stolee <dstolee@microsoft.com>
Date: Wed, 12 Aug 2020 08:20:03 -0400
Subject: [PATCH] commit-graph: lazy-load large Bloom filter bitmap

The bloom_large bitmap in struct commit_graph is currently loaded immediately upon first parse of the commit-graph file (when the chunk exists). This is needed because the current implementation of get_bloom_filter_from_graph() is special-cased to return NULL when the filter is marked as "too large".

This has a slight drawback: before we can read a single commit out of the commit-graph file, we need to load this entire chunk into memory. This happens even for commands that don't need changed-path Bloom filters, such as "git log -1".

This "too large" information is only used when writing a commit-graph file, so we can delay the check for a large filter until after we check compute_if_not_present in get_or_compute_bloom_filter(). Also, place that lazy-load directly in the get_bloom_filter_large_in_graph() method, so we ensure it is ready when needed.

This may be overkill. For a repository with one million commits, this filter size is approximately 125 *kilobytes* of data. My local measurements found that this took between 1 and 2 milliseconds to load into memory. Even for repositories with 10 million commits, this difference would not be noticeable for end-user commands.

On the other hand, these handfuls of milliseconds could add up when running a hosting service using Git, so this extra effort is probably worth it.

Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
---
 bloom.c        | 27 ++++++++-------------------
 commit-graph.c | 30 +++++++++++++++++-------------
 commit-graph.h |  8 ++++++++
 3 files changed, 33 insertions(+), 32 deletions(-)
diff --git a/bloom.c b/bloom.c
index 8d07209c6b..6d0884fa19 100644
--- a/bloom.c
+++ b/bloom.c
@@ -51,21 +51,6 @@ static int load_bloom_filter_from_graph(struct commit_graph *g,
 	else
 		start_index = 0;
 
-	if ((start_index == end_index) &&
-	    (g->bloom_large && !bitmap_get(g->bloom_large, lex_pos))) {
-		/*
-		 * If the filter is zero-length, either (1) the filter has no
-		 * changes, (2) the filter has too many changes, or (3) it
-		 * wasn't computed (eg., due to '--max-new-filters').
-		 *
-		 * If either (1) or (2) is the case, the 'large' bit will be set
-		 * for this Bloom filter. If it is unset, then it wasn't
-		 * computed. In that case, return nothing, since we don't have
-		 * that filter in the graph.
-		 */
-		return 0;
-	}
-
 	filter->len = end_index - start_index;
 	filter->data = (unsigned char *)(g->chunk_bloom_data +
 					sizeof(unsigned char) * start_index +
@@ -212,16 +197,20 @@ struct bloom_filter *get_or_compute_bloom_filter(struct repository *r,
 
 	if (!filter->data) {
 		load_commit_graph_info(r, c);
-		if (commit_graph_position(c) != COMMIT_NOT_FROM_GRAPH &&
-			load_bloom_filter_from_graph(r->objects->commit_graph, filter, c))
-				return filter;
+		if (commit_graph_position(c) != COMMIT_NOT_FROM_GRAPH)
+			load_bloom_filter_from_graph(r->objects->commit_graph, filter, c);
 	}
 
-	if (filter->data)
+	if (filter && filter->len)
 		return filter;
 	if (!compute_if_not_present)
 		return NULL;
 
+	if (filter && !filter->len &&
+	    get_bloom_filter_large_in_graph(r->objects->commit_graph, c,
+	    				    settings->max_changed_paths))
+		return filter;
+
 	repo_diff_setup(r, &diffopt);
 	diffopt.flags.recursive = 1;
 	diffopt.detect_rename = 0;
diff --git a/commit-graph.c b/commit-graph.c
index 4aae5471e3..ea89f431cc 100644
--- a/commit-graph.c
+++ b/commit-graph.c
@@ -435,17 +435,9 @@ struct commit_graph *parse_commit_graph(struct repository *r,
 			if (graph->chunk_bloom_large_filters)
 				chunk_repeated = 1;
 			else if (r->settings.commit_graph_read_changed_paths) {
-				size_t alloc = get_be64(chunk_lookup + 4) - chunk_offset - sizeof(uint32_t);
+				graph->bloom_large_alloc = get_be64(chunk_lookup + 4) - chunk_offset - sizeof(uint32_t);
 				graph->chunk_bloom_large_filters = data + chunk_offset + sizeof(uint32_t);
 				graph->bloom_filter_settings->max_changed_paths = get_be32(data + chunk_offset);
-				if (alloc) {
-					size_t j;
-					graph->bloom_large = bitmap_word_alloc(alloc);
-
-					for (j = 0; j < graph->bloom_large->word_alloc; j++)
-						graph->bloom_large->words[j] = get_be64(
-							graph->chunk_bloom_large_filters + j * sizeof(eword_t));
-				}
 			}
 			break;
 		}
@@ -953,9 +945,9 @@ struct tree *get_commit_tree_in_graph(struct repository *r, const struct commit
 	return get_commit_tree_in_graph_one(r, r->objects->commit_graph, c);
 }
 
-static int get_bloom_filter_large_in_graph(struct commit_graph *g,
-					   const struct commit *c,
-					   uint32_t max_changed_paths)
+int get_bloom_filter_large_in_graph(struct commit_graph *g,
+				    const struct commit *c,
+				    uint32_t max_changed_paths)
 {
 	uint32_t graph_pos = commit_graph_position(c);
 	if (graph_pos == COMMIT_NOT_FROM_GRAPH)
@@ -964,8 +956,20 @@ static int get_bloom_filter_large_in_graph(struct commit_graph *g,
 	while (g && graph_pos < g->num_commits_in_base)
 		g = g->base_graph;
 
-	if (!(g && g->bloom_large))
+	if (!g || !g->bloom_large_alloc)
 		return 0;
+
+	if (!g->bloom_large) {
+		size_t j;
+		g->bloom_large = bitmap_word_alloc(g->bloom_large_alloc);
+
+		for (j = 0; j < g->bloom_large->word_alloc; j++) {
+			const void *data = g->chunk_bloom_large_filters +
+					   j * sizeof(eword_t);
+			g->bloom_large->words[j] = get_be64(data);
+		}
+	}
+
 	if (g->bloom_filter_settings->max_changed_paths != max_changed_paths) {
 		/*
 		 * Force all commits which are subject to a different
diff --git a/commit-graph.h b/commit-graph.h
index 75ef83708b..126fd43380 100644
--- a/commit-graph.h
+++ b/commit-graph.h
@@ -51,6 +51,13 @@ void load_commit_graph_info(struct repository *r, struct commit *item);
 struct tree *get_commit_tree_in_graph(struct repository *r,
 				      const struct commit *c);
 
+/*
+ * Returns 1 if this commit was marked in the BFXL chunk as having more
+ * than max_changed_paths changes.
+ */
+int get_bloom_filter_large_in_graph(struct commit_graph *g,
+				    const struct commit *c,
+				    uint32_t max_changed_paths);
 struct commit_graph {
 	const unsigned char *data;
 	size_t data_len;
@@ -74,6 +81,7 @@ struct commit_graph {
 	const unsigned char *chunk_bloom_data;
 	const unsigned char *chunk_bloom_large_filters;
 
+	size_t bloom_large_alloc;
 	struct bitmap *bloom_large;
 
 	struct bloom_filter_settings *bloom_filter_settings;
-- 
2.28.0.38.gc6f546511c1
Previous: Taylor BlauNext: Taylor Blau
Message 78 of 117 in “more miscellaneous Bloom filter improvements”
  1. 00/10 more miscellaneous Bloom filter improvementsTaylor Blau, Aug 3, 2020
  2. 01/10 commit-graph: introduce 'get_bloom_filter_settings()'Taylor Blau, Aug 3, 2020
  3. Jeff KingAug 4, 2020
  4. Taylor BlauAug 4, 2020
  5. 02/10 commit-graph: pass a 'struct repository *' in more placesTaylor Blau, Aug 3, 2020
  6. 03/10 t4216: use an '&&'-chainTaylor Blau, Aug 3, 2020
  7. 04/10 t/helper/test-read-graph.c: prepare repo settingsTaylor Blau, Aug 3, 2020
  8. 05/10 commit-graph: respect 'commitgraph.readChangedPaths'Taylor Blau, Aug 3, 2020
  9. 06/10 commit-graph.c: sort index into commits listTaylor Blau, Aug 3, 2020
  10. Derrick StoleeAug 4, 2020
  11. Taylor BlauAug 4, 2020
  12. 07/10 commit-graph: add large-filters bitmap chunkTaylor Blau, Aug 3, 2020
  13. Taylor BlauAug 3, 2020
  14. Derrick StoleeAug 4, 2020
  15. 08/10 bloom: split 'get_bloom_filter()' in twoTaylor Blau, Aug 3, 2020
  16. Derrick StoleeAug 4, 2020
  17. Taylor BlauAug 4, 2020
  18. 09/10 commit-graph: rename 'split_commit_graph_opts'Taylor Blau, Aug 3, 2020
  19. 10/10 builtin/commit-graph.c: introduce '--max-new-filters=<n>'Taylor Blau, Aug 3, 2020
  20. Derrick StoleeAug 4, 2020
  21. Taylor BlauAug 4, 2020
  22. 00/14 more miscellaneous Bloom filter improvementsTaylor Blau, Aug 5, 2020
  23. 01/14 commit-graph: introduce 'get_bloom_filter_settings()'Taylor Blau, Aug 5, 2020
  24. 02/14 t4216: use an '&&'-chainTaylor Blau, Aug 5, 2020
  25. 09/14 bloom/diff: properly short-circuit on max_changesTaylor Blau, Aug 5, 2020
  26. 10/14 commit-graph.c: sort index into commits listTaylor Blau, Aug 5, 2020
  27. 08/14 bloom: use provided 'struct bloom_filter_settings'Taylor Blau, Aug 5, 2020
  28. 07/14 bloom: split 'get_bloom_filter()' in twoTaylor Blau, Aug 5, 2020
  29. 12/14 commit-graph: add large-filters bitmap chunkTaylor Blau, Aug 5, 2020
  30. Junio C HamanoAug 5, 2020
  31. Taylor BlauAug 5, 2020
  32. Junio C HamanoAug 5, 2020
  33. Taylor BlauAug 5, 2020
  34. Taylor BlauAug 11, 2020
  35. Junio C HamanoAug 11, 2020
  36. 11/14 csum-file.h: introduce 'hashwrite_be64()'Taylor Blau, Aug 5, 2020
  37. 13/14 commit-graph: rename 'split_commit_graph_opts'Taylor Blau, Aug 5, 2020
  38. 03/14 commit-graph: pass a 'struct repository *' in more placesTaylor Blau, Aug 5, 2020
  39. 06/14 commit-graph.c: store maximum changed pathsTaylor Blau, Aug 5, 2020
  40. 04/14 t/helper/test-read-graph.c: prepare repo settingsTaylor Blau, Aug 5, 2020
  41. 05/14 commit-graph: respect 'commitGraph.readChangedPaths'Taylor Blau, Aug 5, 2020
  42. 14/14 builtin/commit-graph.c: introduce '--max-new-filters=<n>'Taylor Blau, Aug 5, 2020
  43. 00/14 more miscellaneous Bloom filter improvementsTaylor Blau, Aug 11, 2020
  44. 01/14 commit-graph: introduce 'get_bloom_filter_settings()'Taylor Blau, Aug 11, 2020
  45. SZEDER GáborAug 11, 2020
  46. Taylor BlauAug 11, 2020
  47. SZEDER GáborAug 11, 2020
  48. Taylor BlauAug 11, 2020
  49. SZEDER GáborAug 11, 2020
  50. Derrick StoleeAug 12, 2020
  51. Taylor BlauAug 14, 2020
  52. 02/14 t4216: use an '&&'-chainTaylor Blau, Aug 11, 2020
  53. 03/14 commit-graph: pass a 'struct repository *' in more placesTaylor Blau, Aug 11, 2020
  54. 04/14 t/helper/test-read-graph.c: prepare repo settingsTaylor Blau, Aug 11, 2020
  55. 05/14 commit-graph: respect 'commitGraph.readChangedPaths'Taylor Blau, Aug 11, 2020
  56. 06/14 commit-graph.c: store maximum changed pathsTaylor Blau, Aug 11, 2020
  57. 07/14 bloom: split 'get_bloom_filter()' in twoTaylor Blau, Aug 11, 2020
  58. 11/14 csum-file.h: introduce 'hashwrite_be64()'Taylor Blau, Aug 11, 2020
  59. 08/14 bloom: use provided 'struct bloom_filter_settings'Taylor Blau, Aug 11, 2020
  60. 09/14 bloom/diff: properly short-circuit on max_changesTaylor Blau, Aug 11, 2020
  61. 10/14 commit-graph.c: sort index into commits listTaylor Blau, Aug 11, 2020
  62. 12/14 commit-graph: add large-filters bitmap chunkTaylor Blau, Aug 11, 2020
  63. Derrick StoleeAug 11, 2020
  64. Taylor BlauAug 11, 2020
  65. Taylor BlauAug 11, 2020
  66. SZEDER GáborAug 19, 2020
  67. Taylor BlauSep 2, 2020
  68. SZEDER GáborSep 1, 2020
  69. Taylor BlauSep 2, 2020
  70. 13/14 commit-graph: rename 'split_commit_graph_opts'Taylor Blau, Aug 11, 2020
  71. SZEDER GáborAug 19, 2020
  72. Taylor BlauSep 2, 2020
  73. 14/14 builtin/commit-graph.c: introduce '--max-new-filters=<n>'Taylor Blau, Aug 11, 2020
  74. SZEDER GáborAug 12, 2020
  75. Taylor BlauAug 14, 2020
  76. SZEDER GáborAug 17, 2020
  77. Taylor BlauSep 2, 2020
  78. Derrick StoleeAug 12, 2020
  79. Taylor BlauAug 14, 2020
  80. SZEDER GáborAug 18, 2020
  81. Taylor BlauSep 3, 2020
  82. SZEDER GáborAug 19, 2020
  83. Taylor BlauSep 3, 2020
  84. SZEDER GáborSep 4, 2020
  85. SZEDER GáborSep 1, 2020
  86. Taylor BlauSep 3, 2020
  87. Junio C HamanoSep 3, 2020
  88. Taylor BlauSep 3, 2020
  89. 00/14 more miscellaneous Bloom filter improvementsTaylor Blau, Sep 3, 2020
  90. 01/14 commit-graph: introduce 'get_bloom_filter_settings()'Taylor Blau, Sep 3, 2020
  91. 02/14 t4216: use an '&&'-chainTaylor Blau, Sep 3, 2020
  92. 04/14 t/helper/test-read-graph.c: prepare repo settingsTaylor Blau, Sep 3, 2020
  93. 03/14 commit-graph: pass a 'struct repository *' in more placesTaylor Blau, Sep 3, 2020
  94. 05/14 commit-graph: respect 'commitGraph.readChangedPaths'Taylor Blau, Sep 3, 2020
  95. 06/14 commit-graph.c: store maximum changed pathsTaylor Blau, Sep 3, 2020
  96. 07/14 bloom: split 'get_bloom_filter()' in twoTaylor Blau, Sep 3, 2020
  97. Jakub NarębskiSep 5, 2020
  98. Taylor BlauSep 5, 2020
  99. Jakub NarębskiSep 5, 2020
  100. Taylor BlauSep 5, 2020
  101. Jakub NarębskiSep 5, 2020
  102. Taylor BlauSep 5, 2020
  103. Taylor BlauSep 5, 2020
  104. SZEDER GáborSep 5, 2020
  105. Taylor BlauSep 5, 2020
  106. Junio C HamanoSep 6, 2020
  107. 08/14 bloom: use provided 'struct bloom_filter_settings'Taylor Blau, Sep 3, 2020
  108. 09/14 bloom/diff: properly short-circuit on max_changesTaylor Blau, Sep 3, 2020
  109. 10/14 commit-graph.c: sort index into commits listTaylor Blau, Sep 3, 2020
  110. 11/14 csum-file.h: introduce 'hashwrite_be64()'Taylor Blau, Sep 3, 2020
  111. René ScharfeSep 4, 2020
  112. Taylor BlauSep 4, 2020
  113. 12/14 commit-graph: add large-filters bitmap chunkTaylor Blau, Sep 3, 2020
  114. 13/14 commit-graph: rename 'split_commit_graph_opts'Taylor Blau, Sep 3, 2020
  115. Taylor BlauSep 4, 2020
  116. 14/14 builtin/commit-graph.c: introduce '--max-new-filters=<n>'Taylor Blau, Sep 3, 2020
  117. Derrick StoleeSep 4, 2020

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.