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

[PATCH v3 17/30] pseudo-merge: implement support for selecting pseudo-merge commits

From
Taylor Blau <me@ttaylorr.com>
Date
May 21, 2024, 19:02 UTC
Message-ID
<3029473c094b3edf51828b7a1d1acfc8e959ece6.1716318089.git.me@ttaylorr.com>
In-Reply-To
<cover.1716318088.git.me@ttaylorr.com>

Teach the new pseudo-merge machinery how to select non-bitmapped commits for inclusion in different pseudo-merge group(s) based on a handful of criteria.

Note that the selected pseudo-merge commits aren't actually used or written anywhere yet. This will be done in the following commit.

Signed-off-by: Taylor Blau <me@ttaylorr.com>
---
 Documentation/config.txt                     |   2 +
 Documentation/config/bitmap-pseudo-merge.txt |  90 ++++
 Documentation/gitpacking.txt                 |  83 ++++
 pack-bitmap-write.c                          |  21 +
 pack-bitmap.h                                |   2 +
 pseudo-merge.c                               | 454 +++++++++++++++++++
 pseudo-merge.h                               |  94 ++++
 7 files changed, 746 insertions(+)
 create mode 100644 Documentation/config/bitmap-pseudo-merge.txt
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 6f649c997c0..caa34311214 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -384,6 +384,8 @@ include::config/apply.txt[]
 
 include::config/attr.txt[]
 
+include::config/bitmap-pseudo-merge.txt[]
+
 include::config/blame.txt[]
 
 include::config/branch.txt[]
diff --git a/Documentation/config/bitmap-pseudo-merge.txt b/Documentation/config/bitmap-pseudo-merge.txt
new file mode 100644
index 00000000000..d4a2023b84a
--- /dev/null
+++ b/Documentation/config/bitmap-pseudo-merge.txt
@@ -0,0 +1,90 @@
+NOTE: The configuration options in `bitmapPseudoMerge.*` are considered
+EXPERIMENTAL and may be subject to change or be removed entirely in the
+future.
+
+bitmapPseudoMerge.<name>.pattern::
+	Regular expression used to match reference names. Commits
+	pointed to by references matching this pattern (and meeting
+	the below criteria, like `bitmapPseudoMerge.<name>.sampleRate`
+	and `bitmapPseudoMerge.<name>.threshold`) will be considered
+	for inclusion in a pseudo-merge bitmap.
++
+Commits are grouped into pseudo-merge groups based on whether or not
+any reference(s) that point at a given commit match the pattern, which
+is an extended regular expression.
++
+Within a pseudo-merge group, commits may be further grouped into
+sub-groups based on the capture groups in the pattern. These
+sub-groupings are formed from the regular expressions by concatenating
+any capture groups from the regular expression, with a '-' dash in
+between.
++
+For example, if the pattern is `refs/tags/`, then all tags (provided
+they meet the below criteria) will be considered candidates for the
+same pseudo-merge group. However, if the pattern is instead
+`refs/remotes/([0-9])+/tags/`, then tags from different remotes will
+be grouped into separate pseudo-merge groups, based on the remote
+number.
+
+bitmapPseudoMerge.<name>.decay::
+	Determines the rate at which consecutive pseudo-merge bitmap
+	groups decrease in size. Must be non-negative. This parameter
+	can be thought of as `k` in the function `f(n) = C * n^-k`,
+	where `f(n)` is the size of the `n`th group.
++
+Setting the decay rate equal to `0` will cause all groups to be the
+same size. Setting the decay rate equal to `1` will cause the `n`th
+group to be `1/n` the size of the initial group.  Higher values of the
+decay rate cause consecutive groups to shrink at an increasing rate.
+The default is `1`.
++
+If all groups are the same size, it is possible that groups containing
+newer commits will be able to be used less often than earlier groups,
+since it is more likely that the references pointing at newer commits
+will be updated more often than a reference pointing at an old commit.
+
+bitmapPseudoMerge.<name>.sampleRate::
+	Determines the proportion of non-bitmapped commits (among
+	reference tips) which are selected for inclusion in an
+	unstable pseudo-merge bitmap. Must be between `0` and `1`
+	(inclusive). The default is `1`.
+
+bitmapPseudoMerge.<name>.threshold::
+	Determines the minimum age of non-bitmapped commits (among
+	reference tips, as above) which are candidates for inclusion
+	in an unstable pseudo-merge bitmap. The default is
+	`1.week.ago`.
+
+bitmapPseudoMerge.<name>.maxMerges::
+	Determines the maximum number of pseudo-merge commits among
+	which commits may be distributed.
++
+For pseudo-merge groups whose pattern does not contain any capture
+groups, this setting is applied for all commits matching the regular
+expression. For patterns that have one or more capture groups, this
+setting is applied for each distinct capture group.
++
+For example, if your capture group is `refs/tags/`, then this setting
+will distribute all tags into a maximum of `maxMerges` pseudo-merge
+commits. However, if your capture group is, say,
+`refs/remotes/([0-9]+)/tags/`, then this setting will be applied to
+each remote's set of tags individually.
++
+Must be non-negative. The default value is 64.
+
+bitmapPseudoMerge.<name>.stableThreshold::
+	Determines the minimum age of commits (among reference tips,
+	as above, however stable commits are still considered
+	candidates even when they have been covered by a bitmap) which
+	are candidates for a stable a pseudo-merge bitmap. The default
+	is `1.month.ago`.
++
+Setting this threshold to a smaller value (e.g., 1.week.ago) will cause
+more stable groups to be generated (which impose a one-time generation
+cost) but those groups will likely become stale over time. Using a
+larger value incurs the opposite penalty (fewer stable groups which are
+more useful).
+
+bitmapPseudoMerge.<name>.stableSize::
+	Determines the size (in number of commits) of a stable
+	psuedo-merge bitmap. The default is `512`.
diff --git a/Documentation/gitpacking.txt b/Documentation/gitpacking.txt
index ff18077129b..1ed645ff910 100644
--- a/Documentation/gitpacking.txt
+++ b/Documentation/gitpacking.txt
@@ -93,6 +93,89 @@ can take advantage of the fact that we only care about the union of
 objects reachable from all of those tags, and answer the query much
 faster.
 
+=== Configuration
+
+Reference tips are grouped into different pseudo-merge groups according
+to two criteria. A reference name matches one or more of the defined
+pseudo-merge patterns, and optionally one or more capture groups within
+that pattern which further partition the group.
+
+Within a group, commits may be considered "stable", or "unstable"
+depending on their age. These are adjusted by setting the
+`bitmapPseudoMerge.<name>.stableThreshold` and
+`bitmapPseudoMerge.<name>.threshold` configuration values, respectively.
+
+All stable commits are grouped into pseudo-merges of equal size
+(`bitmapPseudoMerge.<name>.stableSize`). If the `stableSize`
+configuration is set to, say, 100, then the first 100 commits (ordered
+by committer date) which are older than the `stableThreshold` value will
+form one group, the next 100 commits will form another group, and so on.
+
+Among unstable commits, the pseudo-merge machinery will attempt to
+combine older commits into large groups as opposed to newer commits
+which will appear in smaller groups. This is based on the heuristic that
+references whose tip commit is older are less likely to be modified to
+point at a different commit than a reference whose tip commit is newer.
+
+The size of groups is determined by a power-law decay function, and the
+decay parameter roughly corresponds to "k" in `f(n) = C*n^(-k/100)`,
+where `f(n)` describes the size of the `n`-th pseudo-merge group. The
+sample rate controls what percentage of eligible commits are considered
+as candidates. The threshold parameter indicates the minimum age (so as
+to avoid including too-recent commits in a pseudo-merge group, making it
+less likely to be valid). The "maxMerges" parameter sets an upper-bound
+on the number of pseudo-merge commits an individual group
+
+The "stable"-related parameters control "stable" pseudo-merge groups,
+comprised of a fixed number of commits which are older than the
+configured "stable threshold" value and may be grouped together in
+chunks of "stableSize" in order of age.
+
+The exact configuration for pseudo-merges is as follows:
+
+include::config/bitmap-pseudo-merge.txt[]
+
+=== Examples
+
+Suppose that you have a repository with a large number of references,
+and you want a bare-bones configuration of pseudo-merge bitmaps that
+will enhance bitmap coverage of the `refs/` namespace. You may start
+wiht a configuration like so:
+
+    [bitmapPseudoMerge "all"]
+	pattern = "refs/"
+	threshold = now
+	stableThreshold = never
+	sampleRate = 100
+	maxMerges = 64
+
+This will create pseudo-merge bitmaps for all references, regardless of
+their age, and group them into 64 pseudo-merge commits.
+
+If you wanted to separate tags from branches when generating
+pseudo-merge commits, you would instead define the pattern with a
+capture group, like so:
+
+    [bitmapPseudoMerge "all"]
+	pattern = "refs/(heads/tags)/"
+
+Suppose instead that you are working in a fork-network repository, with
+each fork specified by some numeric ID, and whose refs reside in
+`refs/virtual/NNN/` (where `NNN` is the numeric ID corresponding to some
+fork) in the network. In this instance, you may instead write something
+like:
+
+    [bitmapPseudoMerge "all"]
+	pattern = "refs/virtual/([0-9]+)/(heads|tags)/"
+	threshold = now
+	stableThreshold = never
+	sampleRate = 100
+	maxMerges = 64
+
+Which would generate pseudo-merge group identifiers like "1234-heads",
+and "5678-tags" (for branches in fork "1234", and tags in remote "5678",
+respectively).
+
 SEE ALSO
 --------
 linkgit:git-pack-objects[1]
diff --git a/pack-bitmap-write.c b/pack-bitmap-write.c
index bc19b33ad16..d5884ea5e9c 100644
--- a/pack-bitmap-write.c
+++ b/pack-bitmap-write.c
@@ -17,6 +17,7 @@
 #include "trace2.h"
 #include "tree.h"
 #include "tree-walk.h"
+#include "pseudo-merge.h"
 
 struct bitmapped_commit {
 	struct commit *commit;
@@ -39,11 +40,25 @@ void bitmap_writer_init(struct bitmap_writer *writer, struct repository *r)
 	if (writer->bitmaps)
 		BUG("bitmap writer already initialized");
 	writer->bitmaps = kh_init_oid_map();
+	writer->pseudo_merge_commits = kh_init_oid_map();
+
+	string_list_init_dup(&writer->pseudo_merge_groups);
+
+	load_pseudo_merges_from_config(&writer->pseudo_merge_groups);
+}
+
+static void free_pseudo_merge_commit_idx(struct pseudo_merge_commit_idx *idx)
+{
+	if (!idx)
+		return;
+	free(idx->pseudo_merge);
+	free(idx);
 }
 
 void bitmap_writer_free(struct bitmap_writer *writer)
 {
 	uint32_t i;
+	struct pseudo_merge_commit_idx *idx;
 
 	if (!writer)
 		return;
@@ -55,6 +70,10 @@ void bitmap_writer_free(struct bitmap_writer *writer)
 
 	kh_destroy_oid_map(writer->bitmaps);
 
+	kh_foreach_value(writer->pseudo_merge_commits, idx,
+			 free_pseudo_merge_commit_idx(idx));
+	kh_destroy_oid_map(writer->pseudo_merge_commits);
+
 	for (i = 0; i < writer->selected_nr; i++) {
 		struct bitmapped_commit *bc = &writer->selected[i];
 		if (bc->write_as != bc->bitmap)
@@ -703,6 +722,8 @@ void bitmap_writer_select_commits(struct bitmap_writer *writer,
 	}
 
 	stop_progress(&writer->progress);
+
+	select_pseudo_merges(writer, indexed_commits, indexed_commits_nr);
 }
 
 
diff --git a/pack-bitmap.h b/pack-bitmap.h
index a7e2f56c971..1e730ea1e54 100644
--- a/pack-bitmap.h
+++ b/pack-bitmap.h
@@ -110,6 +110,8 @@ struct bitmap_writer {
 	struct bitmapped_commit *selected;
 	unsigned int selected_nr, selected_alloc;
 
+	struct string_list pseudo_merge_groups;
+	kh_oid_map_t *pseudo_merge_commits; /* oid -> pseudo merge(s) */
 	uint32_t pseudo_merges_nr;
 
 	struct progress *progress;
diff --git a/pseudo-merge.c b/pseudo-merge.c
index 37e037ba272..4be730563eb 100644
--- a/pseudo-merge.c
+++ b/pseudo-merge.c
@@ -1,2 +1,456 @@
 #include "git-compat-util.h"
 #include "pseudo-merge.h"
+#include "date.h"
+#include "oid-array.h"
+#include "strbuf.h"
+#include "config.h"
+#include "string-list.h"
+#include "refs.h"
+#include "pack-bitmap.h"
+#include "commit.h"
+#include "alloc.h"
+#include "progress.h"
+
+#define DEFAULT_PSEUDO_MERGE_DECAY 1.0f
+#define DEFAULT_PSEUDO_MERGE_MAX_MERGES 64
+#define DEFAULT_PSEUDO_MERGE_SAMPLE_RATE 1
+#define DEFAULT_PSEUDO_MERGE_THRESHOLD approxidate("1.week.ago")
+#define DEFAULT_PSEUDO_MERGE_STABLE_THRESHOLD approxidate("1.month.ago")
+#define DEFAULT_PSEUDO_MERGE_STABLE_SIZE 512
+
+static float gitexp(float base, int exp)
+{
+	float result = 1;
+	while (1) {
+		if (exp % 2)
+			result *= base;
+		exp >>= 1;
+		if (!exp)
+			break;
+		base *= base;
+	}
+	return result;
+}
+
+static uint32_t pseudo_merge_group_size(const struct pseudo_merge_group *group,
+					const struct pseudo_merge_matches *matches,
+					uint32_t i)
+{
+	float C = 0.0f;
+	uint32_t n;
+
+	/*
+	 * The size of pseudo-merge groups decays according to a power series,
+	 * which looks like:
+	 *
+	 *   f(n) = C * n^-k
+	 *
+	 * , where 'n' is the n-th pseudo-merge group, 'f(n)' is its size, 'k'
+	 * is the decay rate, and 'C' is a scaling value.
+	 *
+	 * The value of C depends on the number of groups, decay rate, and total
+	 * number of commits. It is computed such that if there are M and N
+	 * total groups and commits, respectively, that:
+	 *
+	 *   N = f(0) + f(1) + ... f(M-1)
+	 *
+	 * Rearranging to isolate C, we get:
+	 *
+	 *   N = \sum_{n=1}^M C / n^k
+	 *
+	 *   N / C = \sum_{n=1}^M n^-k
+	 *
+	 *   C = N / \sum_{n=1}^M n^-k
+	 *
+	 * For example, if we have a decay rate of 'k' being equal to 1.5, 'N'
+	 * total commits equal to 10,000, and 'M' being equal to 6 groups, then
+	 * the (rounded) group sizes are:
+	 *
+	 *   { 5469, 1934, 1053, 684, 489, 372 }
+	 *
+	 * increasing the number of total groups, say to 10, scales the group
+	 * sizes appropriately:
+	 *
+	 *   { 5012, 1772, 964, 626, 448, 341, 271, 221, 186, 158 }
+	 */
+	for (n = 0; n < group->max_merges; n++)
+		C += 1.0f / gitexp(n + 1, group->decay);
+	C = matches->unstable_nr / C;
+
+	return (uint32_t)((C / gitexp(i + 1, group->decay)) + 0.5);
+}
+
+static void pseudo_merge_group_init(struct pseudo_merge_group *group)
+{
+	memset(group, 0, sizeof(struct pseudo_merge_group));
+
+	strmap_init_with_options(&group->matches, NULL, 0);
+
+	group->decay = DEFAULT_PSEUDO_MERGE_DECAY;
+	group->max_merges = DEFAULT_PSEUDO_MERGE_MAX_MERGES;
+	group->sample_rate = DEFAULT_PSEUDO_MERGE_SAMPLE_RATE;
+	group->threshold = DEFAULT_PSEUDO_MERGE_THRESHOLD;
+	group->stable_threshold = DEFAULT_PSEUDO_MERGE_STABLE_THRESHOLD;
+	group->stable_size = DEFAULT_PSEUDO_MERGE_STABLE_SIZE;
+}
+
+static int pseudo_merge_config(const char *var, const char *value,
+			       const struct config_context *ctx,
+			       void *cb_data)
+{
+	struct string_list *list = cb_data;
+	struct string_list_item *item;
+	struct pseudo_merge_group *group;
+	struct strbuf buf = STRBUF_INIT;
+	const char *sub, *key;
+	size_t sub_len;
+	int ret = 0;
+
+	if (parse_config_key(var, "bitmappseudomerge", &sub, &sub_len, &key))
+		goto done;
+
+	if (!sub_len)
+		goto done;
+
+	strbuf_add(&buf, sub, sub_len);
+
+	item = string_list_lookup(list, buf.buf);
+	if (!item) {
+		item = string_list_insert(list, buf.buf);
+
+		item->util = xmalloc(sizeof(struct pseudo_merge_group));
+		pseudo_merge_group_init(item->util);
+	}
+
+	group = item->util;
+
+	if (!strcmp(key, "pattern")) {
+		struct strbuf re = STRBUF_INIT;
+
+		free(group->pattern);
+		if (*value != '^')
+			strbuf_addch(&re, '^');
+		strbuf_addstr(&re, value);
+
+		group->pattern = xcalloc(1, sizeof(regex_t));
+		if (regcomp(group->pattern, re.buf, REG_EXTENDED))
+			die(_("failed to load pseudo-merge regex for %s: '%s'"),
+			    sub, re.buf);
+
+		strbuf_release(&re);
+	} else if (!strcmp(key, "decay")) {
+		group->decay = git_config_float(var, value, ctx->kvi);
+		if (group->decay < 0) {
+			warning(_("%s must be non-negative, using default"), var);
+			group->decay = DEFAULT_PSEUDO_MERGE_DECAY;
+		}
+	} else if (!strcmp(key, "samplerate")) {
+		group->sample_rate = git_config_float(var, value, ctx->kvi);
+		if (!(0 <= group->sample_rate && group->sample_rate <= 1)) {
+			warning(_("%s must be between 0 and 1, using default"), var);
+			group->sample_rate = DEFAULT_PSEUDO_MERGE_SAMPLE_RATE;
+		}
+	} else if (!strcmp(key, "threshold")) {
+		if (git_config_expiry_date(&group->threshold, var, value)) {
+			ret = -1;
+			goto done;
+		}
+	} else if (!strcmp(key, "maxmerges")) {
+		group->max_merges = git_config_int(var, value, ctx->kvi);
+		if (group->max_merges < 0) {
+			warning(_("%s must be non-negative, using default"), var);
+			group->max_merges = DEFAULT_PSEUDO_MERGE_MAX_MERGES;
+		}
+	} else if (!strcmp(key, "stablethreshold")) {
+		if (git_config_expiry_date(&group->stable_threshold, var, value)) {
+			ret = -1;
+			goto done;
+		}
+	} else if (!strcmp(key, "stablesize")) {
+		group->stable_size = git_config_int(var, value, ctx->kvi);
+		if (group->stable_size <= 0) {
+			warning(_("%s must be positive, using default"), var);
+			group->stable_size = DEFAULT_PSEUDO_MERGE_STABLE_SIZE;
+		}
+	}
+
+done:
+	strbuf_release(&buf);
+
+	return ret;
+}
+
+void load_pseudo_merges_from_config(struct string_list *list)
+{
+	struct string_list_item *item;
+
+	git_config(pseudo_merge_config, list);
+
+	for_each_string_list_item(item, list) {
+		struct pseudo_merge_group *group = item->util;
+		if (!group->pattern)
+			die(_("pseudo-merge group '%s' missing required pattern"),
+			    item->string);
+		if (group->threshold < group->stable_threshold)
+			die(_("pseudo-merge group '%s' has unstable threshold "
+			      "before stable one"), item->string);
+	}
+}
+
+static int find_pseudo_merge_group_for_ref(const char *refname,
+					   const struct object_id *oid,
+					   int flags UNUSED,
+					   void *_data)
+{
+	struct bitmap_writer *writer = _data;
+	struct object_id peeled;
+	struct commit *c;
+	uint32_t i;
+	int has_bitmap;
+
+	if (!peel_iterated_oid(oid, &peeled))
+		oid = &peeled;
+
+	c = lookup_commit(the_repository, oid);
+	if (!c)
+		return 0;
+
+	has_bitmap = bitmap_writer_has_bitmapped_object_id(writer, oid);
+
+	for (i = 0; i < writer->pseudo_merge_groups.nr; i++) {
+		struct pseudo_merge_group *group;
+		struct pseudo_merge_matches *matches;
+		struct strbuf group_name = STRBUF_INIT;
+		regmatch_t captures[16];
+		size_t j;
+
+		group = writer->pseudo_merge_groups.items[i].util;
+		if (regexec(group->pattern, refname, ARRAY_SIZE(captures),
+			    captures, 0))
+			continue;
+
+		if (captures[ARRAY_SIZE(captures) - 1].rm_so != -1)
+			warning(_("pseudo-merge regex from config has too many capture "
+				  "groups (max=%"PRIuMAX")"),
+				(uintmax_t)ARRAY_SIZE(captures) - 2);
+
+		for (j = !!group->pattern->re_nsub; j < ARRAY_SIZE(captures); j++) {
+			regmatch_t *match = &captures[j];
+			if (match->rm_so == -1)
+				continue;
+
+			if (group_name.len)
+				strbuf_addch(&group_name, '-');
+
+			strbuf_add(&group_name, refname + match->rm_so,
+				   match->rm_eo - match->rm_so);
+		}
+
+		matches = strmap_get(&group->matches, group_name.buf);
+		if (!matches) {
+			matches = xcalloc(1, sizeof(*matches));
+			strmap_put(&group->matches, strbuf_detach(&group_name, NULL),
+				   matches);
+		}
+
+		if (c->date <= group->stable_threshold) {
+			ALLOC_GROW(matches->stable, matches->stable_nr + 1,
+				   matches->stable_alloc);
+			matches->stable[matches->stable_nr++] = c;
+		} else if (c->date <= group->threshold && !has_bitmap) {
+			ALLOC_GROW(matches->unstable, matches->unstable_nr + 1,
+				   matches->unstable_alloc);
+			matches->unstable[matches->unstable_nr++] = c;
+		}
+
+		strbuf_release(&group_name);
+	}
+
+	return 0;
+}
+
+static struct commit *push_pseudo_merge(struct pseudo_merge_group *group)
+{
+	struct commit *merge;
+
+	ALLOC_GROW(group->merges, group->merges_nr + 1, group->merges_alloc);
+
+	merge = alloc_commit_node(the_repository);
+	merge->object.parsed = 1;
+	merge->object.flags |= BITMAP_PSEUDO_MERGE;
+
+	group->merges[group->merges_nr++] = merge;
+
+	return merge;
+}
+
+static struct pseudo_merge_commit_idx *pseudo_merge_idx(kh_oid_map_t *pseudo_merge_commits,
+							const struct object_id *oid)
+
+{
+	struct pseudo_merge_commit_idx *pmc;
+	int hash_ret;
+	khiter_t hash_pos = kh_put_oid_map(pseudo_merge_commits, *oid,
+					   &hash_ret);
+
+	if (hash_ret) {
+		CALLOC_ARRAY(pmc, 1);
+		kh_value(pseudo_merge_commits, hash_pos) = pmc;
+	} else {
+		pmc = kh_value(pseudo_merge_commits, hash_pos);
+	}
+
+	return pmc;
+}
+
+#define MIN_PSEUDO_MERGE_SIZE 8
+
+static void select_pseudo_merges_1(struct bitmap_writer *writer,
+				   struct pseudo_merge_group *group,
+				   struct pseudo_merge_matches *matches)
+{
+	uint32_t i, j;
+	uint32_t stable_merges_nr;
+
+	if (!matches->stable_nr && !matches->unstable_nr)
+		return; /* all tips in this group already have bitmaps */
+
+	stable_merges_nr = matches->stable_nr / group->stable_size;
+	if (matches->stable_nr % group->stable_size)
+		stable_merges_nr++;
+
+	/* make stable_merges_nr pseudo merges for stable commits */
+	for (i = 0, j = 0; i < stable_merges_nr; i++) {
+		struct commit *merge;
+		struct commit_list **p;
+
+		merge = push_pseudo_merge(group);
+		p = &merge->parents;
+
+		/*
+		 * For each pseudo-merge created above, add parents to the
+		 * allocated commit node from the stable set of commits
+		 * (un-bitmapped, newer than the stable threshold).
+		 */
+		do {
+			struct commit *c;
+			struct pseudo_merge_commit_idx *pmc;
+
+			if (j >= matches->stable_nr)
+				break;
+
+			c = matches->stable[j++];
+			/*
+			 * Here and below, make sure that we keep our mapping of
+			 * commits -> pseudo-merge(s) which include the key'd
+			 * commit up-to-date.
+			 */
+			pmc = pseudo_merge_idx(writer->pseudo_merge_commits,
+					       &c->object.oid);
+
+			ALLOC_GROW(pmc->pseudo_merge, pmc->nr + 1, pmc->alloc);
+
+			pmc->pseudo_merge[pmc->nr++] = writer->pseudo_merges_nr;
+			p = commit_list_append(c, p);
+		} while (j % group->stable_size);
+
+		bitmap_writer_push_commit(writer, merge, 1);
+		writer->pseudo_merges_nr++;
+	}
+
+	/* make up to group->max_merges pseudo merges for unstable commits */
+	for (i = 0, j = 0; i < group->max_merges; i++) {
+		struct commit *merge;
+		struct commit_list **p;
+		uint32_t size, end;
+
+		merge = push_pseudo_merge(group);
+		p = &merge->parents;
+
+		size = pseudo_merge_group_size(group, matches, i);
+		end = size < MIN_PSEUDO_MERGE_SIZE ? matches->unstable_nr : j + size;
+
+		/*
+		 * For each pseudo-merge commit created above, add parents to
+		 * the allocated commit node from the unstable set of commits
+		 * (newer than the stable threshold).
+		 *
+		 * Account for the sample rate, since not every candidate from
+		 * the set of stable commits will be included as a pseudo-merge
+		 * parent.
+		 */
+		for (; j < end && j < matches->unstable_nr; j++) {
+			struct commit *c = matches->unstable[j];
+			struct pseudo_merge_commit_idx *pmc;
+
+			if (j % (uint32_t)(1.0f / group->sample_rate))
+				continue;
+
+			pmc = pseudo_merge_idx(writer->pseudo_merge_commits,
+					       &c->object.oid);
+
+			ALLOC_GROW(pmc->pseudo_merge, pmc->nr + 1, pmc->alloc);
+
+			pmc->pseudo_merge[pmc->nr++] = writer->pseudo_merges_nr;
+			p = commit_list_append(c, p);
+		}
+
+		bitmap_writer_push_commit(writer, merge, 1);
+		writer->pseudo_merges_nr++;
+		if (end >= matches->unstable_nr)
+			break;
+	}
+}
+
+static int commit_date_cmp(const void *va, const void *vb)
+{
+	timestamp_t a = (*(const struct commit **)va)->date;
+	timestamp_t b = (*(const struct commit **)vb)->date;
+
+	if (a < b)
+		return -1;
+	else if (a > b)
+		return 1;
+	return 0;
+}
+
+static void sort_pseudo_merge_matches(struct pseudo_merge_matches *matches)
+{
+	QSORT(matches->stable, matches->stable_nr, commit_date_cmp);
+	QSORT(matches->unstable, matches->unstable_nr, commit_date_cmp);
+}
+
+void select_pseudo_merges(struct bitmap_writer *writer,
+			  struct commit **commits, size_t commits_nr)
+{
+	struct progress *progress = NULL;
+	uint32_t i;
+
+	if (!writer->pseudo_merge_groups.nr)
+		return;
+
+	if (writer->show_progress)
+		progress = start_progress("Selecting pseudo-merge commits",
+					  writer->pseudo_merge_groups.nr);
+
+	for_each_ref(find_pseudo_merge_group_for_ref, writer);
+
+	for (i = 0; i < writer->pseudo_merge_groups.nr; i++) {
+		struct pseudo_merge_group *group;
+		struct hashmap_iter iter;
+		struct strmap_entry *e;
+
+		group = writer->pseudo_merge_groups.items[i].util;
+		strmap_for_each_entry(&group->matches, &iter, e) {
+			struct pseudo_merge_matches *matches = e->value;
+
+			sort_pseudo_merge_matches(matches);
+
+			select_pseudo_merges_1(writer, group, matches);
+		}
+
+		display_progress(progress, i + 1);
+	}
+
+	stop_progress(&progress);
+}
diff --git a/pseudo-merge.h b/pseudo-merge.h
index cab8ff6960a..cab54daf14b 100644
--- a/pseudo-merge.h
+++ b/pseudo-merge.h
@@ -2,5 +2,99 @@
 #define PSEUDO_MERGE_H
 
 #include "git-compat-util.h"
+#include "strmap.h"
+#include "khash.h"
+#include "ewah/ewok.h"
+
+struct commit;
+struct string_list;
+struct bitmap_index;
+struct bitmap_writer;
+
+/*
+ * A pseudo-merge group tracks the set of non-bitmapped reference tips
+ * that match the given pattern.
+ *
+ * Within those matches, they are further segmented by separating
+ * consecutive capture groups with '-' dash character capture groups
+ * with '-' dash characters.
+ *
+ * Those groups are then ordered by committer date and partitioned
+ * into individual pseudo-merge(s) according to the decay, max_merges,
+ * sample_rate, and threshold parameters.
+ */
+struct pseudo_merge_group {
+	regex_t *pattern;
+
+	/* capture group(s) -> struct pseudo_merge_matches */
+	struct strmap matches;
+
+	/*
+	 * The individual pseudo-merge(s) that are generated from the
+	 * above array of matches, partitioned according to the below
+	 * parameters.
+	 */
+	struct commit **merges;
+	size_t merges_nr;
+	size_t merges_alloc;
+
+	/*
+	 * Pseudo-merge grouping parameters. See git-config(1) for
+	 * more information.
+	 */
+	float decay;
+	int max_merges;
+	float sample_rate;
+	int stable_size;
+	timestamp_t threshold;
+	timestamp_t stable_threshold;
+};
+
+struct pseudo_merge_matches {
+	struct commit **stable;
+	struct commit **unstable;
+	size_t stable_nr, stable_alloc;
+	size_t unstable_nr, unstable_alloc;
+};
+
+/*
+ * Read the repository's configuration:
+ *
+ *   - bitmapPseudoMerge.<name>.pattern
+ *   - bitmapPseudoMerge.<name>.decay
+ *   - bitmapPseudoMerge.<name>.sampleRate
+ *   - bitmapPseudoMerge.<name>.threshold
+ *   - bitmapPseudoMerge.<name>.maxMerges
+ *   - bitmapPseudoMerge.<name>.stableThreshold
+ *   - bitmapPseudoMerge.<name>.stableSize
+ *
+ * and populates the given `list` with pseudo-merge groups. String
+ * entry keys are the pseudo-merge group names, and the values are
+ * pointers to the pseudo_merge_group structure itself.
+ */
+void load_pseudo_merges_from_config(struct string_list *list);
+
+/*
+ * A pseudo-merge commit index (pseudo_merge_commit_idx) maps a
+ * particular (non-pseudo-merge) commit to the list of pseudo-merge(s)
+ * it appears in.
+ */
+struct pseudo_merge_commit_idx {
+	uint32_t *pseudo_merge;
+	size_t nr, alloc;
+};
+
+/*
+ * Selects pseudo-merges from a list of commits, populating the given
+ * string_list of pseudo-merge groups.
+ *
+ * Populates the pseudo_merge_commits map with a commit_idx
+ * corresponding to each commit in the list. Counts the total number
+ * of pseudo-merges generated.
+ *
+ * Optionally shows a progress meter.
+ */
+void select_pseudo_merges(struct bitmap_writer *writer,
+			  struct commit **commits, size_t commits_nr);
 
 #endif
-- 
2.45.1.175.gbea44add9db
Previous: Taylor BlauNext: Jeff King
Message 100 of 157 in “pack-bitmap: pseudo-merge reachability bitmaps”
  1. 00/24 pack-bitmap: pseudo-merge reachability bitmapsTaylor Blau, Mar 20, 2024
  2. 01/24 Documentation/technical: describe pseudo-merge bitmaps formatTaylor Blau, Mar 20, 2024
  3. Junio C HamanoMar 21, 2024
  4. Taylor BlauMar 21, 2024
  5. Junio C HamanoMar 21, 2024
  6. 02/24 config: repo_config_get_expiry()Taylor Blau, Mar 20, 2024
  7. Jeff KingApr 10, 2024
  8. Taylor BlauApr 29, 2024
  9. 03/24 ewah: implement `ewah_bitmap_is_subset()`Taylor Blau, Mar 20, 2024
  10. Jeff KingApr 10, 2024
  11. Taylor BlauApr 29, 2024
  12. 04/24 pack-bitmap: drop unused `max_bitmaps` parameterTaylor Blau, Mar 20, 2024
  13. Jeff KingApr 10, 2024
  14. 05/24 pack-bitmap: move some initialization to `bitmap_writer_init()`Taylor Blau, Mar 20, 2024
  15. Jeff KingApr 10, 2024
  16. 06/24 pseudo-merge.ch: initial commitTaylor Blau, Mar 20, 2024
  17. 07/24 pack-bitmap-write: support storing pseudo-merge commitsTaylor Blau, Mar 20, 2024
  18. 08/24 pack-bitmap: implement `bitmap_writer_has_bitmapped_object_id()`Taylor Blau, Mar 20, 2024
  19. 09/24 pack-bitmap: make `bitmap_writer_push_bitmapped_commit()` publicTaylor Blau, Mar 20, 2024
  20. 10/24 pseudo-merge: implement support for selecting pseudo-merge commitsTaylor Blau, Mar 20, 2024
  21. 11/24 pack-bitmap-write.c: select pseudo-merge commitsTaylor Blau, Mar 20, 2024
  22. 12/24 pack-bitmap-write.c: write pseudo-merge tableTaylor Blau, Mar 20, 2024
  23. 13/24 pack-bitmap: extract `read_bitmap()` functionTaylor Blau, Mar 20, 2024
  24. 14/24 pseudo-merge: scaffolding for readsTaylor Blau, Mar 20, 2024
  25. 15/24 pack-bitmap.c: read pseudo-merge extensionTaylor Blau, Mar 20, 2024
  26. 16/24 pseudo-merge: implement support for reading pseudo-merge commitsTaylor Blau, Mar 20, 2024
  27. 17/24 ewah: implement `ewah_bitmap_popcount()`Taylor Blau, Mar 20, 2024
  28. 18/24 pack-bitmap: implement test helpers for pseudo-mergeTaylor Blau, Mar 20, 2024
  29. 19/24 t/test-lib-functions.sh: support `--date` in `test_commit_bulk()`Taylor Blau, Mar 20, 2024
  30. 20/24 pack-bitmap.c: use pseudo-merges during traversalTaylor Blau, Mar 20, 2024
  31. 21/24 pack-bitmap: extra trace2 informationTaylor Blau, Mar 20, 2024
  32. 22/24 ewah: `bitmap_equals_ewah()`Taylor Blau, Mar 20, 2024
  33. 23/24 pseudo-merge: implement support for finding existing mergesTaylor Blau, Mar 20, 2024
  34. 24/24 t/perf: implement performace tests for pseudo-merge bitmapsTaylor Blau, Mar 20, 2024
  35. Junio C HamanoMar 21, 2024
  36. 00/23 pack-bitmap: pseudo-merge reachability bitmapsTaylor Blau, Apr 29, 2024
  37. 01/23 Documentation/technical: describe pseudo-merge bitmaps formatTaylor Blau, Apr 29, 2024
  38. Patrick SteinhardtMay 6, 2024
  39. Taylor BlauMay 6, 2024
  40. Patrick SteinhardtMay 10, 2024
  41. Taylor BlauMay 13, 2024
  42. Patrick SteinhardtMay 14, 2024
  43. 02/23 ewah: implement `ewah_bitmap_is_subset()`Taylor Blau, Apr 29, 2024
  44. 03/23 pack-bitmap: drop unused `max_bitmaps` parameterTaylor Blau, Apr 29, 2024
  45. 04/23 pack-bitmap: move some initialization to `bitmap_writer_init()`Taylor Blau, Apr 29, 2024
  46. Patrick SteinhardtMay 6, 2024
  47. Taylor BlauMay 6, 2024
  48. 05/23 pseudo-merge.ch: initial commitTaylor Blau, Apr 29, 2024
  49. 06/23 pack-bitmap-write: support storing pseudo-merge commitsTaylor Blau, Apr 29, 2024
  50. Patrick SteinhardtMay 6, 2024
  51. Taylor BlauMay 6, 2024
  52. Patrick SteinhardtMay 10, 2024
  53. Jeff KingMay 13, 2024
  54. Taylor BlauMay 13, 2024
  55. 07/23 pack-bitmap: implement `bitmap_writer_has_bitmapped_object_id()`Taylor Blau, Apr 29, 2024
  56. 08/23 pack-bitmap: make `bitmap_writer_push_bitmapped_commit()` publicTaylor Blau, Apr 29, 2024
  57. Jeff KingMay 13, 2024
  58. Taylor BlauMay 14, 2024
  59. 09/23 pseudo-merge: implement support for selecting pseudo-merge commitsTaylor Blau, Apr 29, 2024
  60. Patrick SteinhardtMay 6, 2024
  61. Taylor BlauMay 6, 2024
  62. Jeff KingMay 13, 2024
  63. Taylor BlauMay 14, 2024
  64. Jeff KingMay 16, 2024
  65. Junio C HamanoMay 16, 2024
  66. 10/23 pack-bitmap-write.c: select pseudo-merge commitsTaylor Blau, Apr 29, 2024
  67. Patrick SteinhardtMay 6, 2024
  68. Taylor BlauMay 6, 2024
  69. Patrick SteinhardtMay 10, 2024
  70. 11/23 pack-bitmap-write.c: write pseudo-merge tableTaylor Blau, Apr 29, 2024
  71. 12/23 pack-bitmap: extract `read_bitmap()` functionTaylor Blau, Apr 29, 2024
  72. 13/23 pseudo-merge: scaffolding for readsTaylor Blau, Apr 29, 2024
  73. 14/23 pack-bitmap.c: read pseudo-merge extensionTaylor Blau, Apr 29, 2024
  74. 15/23 pseudo-merge: implement support for reading pseudo-merge commitsTaylor Blau, Apr 29, 2024
  75. 16/23 ewah: implement `ewah_bitmap_popcount()`Taylor Blau, Apr 29, 2024
  76. 17/23 pack-bitmap: implement test helpers for pseudo-mergeTaylor Blau, Apr 29, 2024
  77. 18/23 t/test-lib-functions.sh: support `--date` in `test_commit_bulk()`Taylor Blau, Apr 29, 2024
  78. 19/23 pack-bitmap.c: use pseudo-merges during traversalTaylor Blau, Apr 29, 2024
  79. 20/23 pack-bitmap: extra trace2 informationTaylor Blau, Apr 29, 2024
  80. 21/23 ewah: `bitmap_equals_ewah()`Taylor Blau, Apr 29, 2024
  81. 22/23 pseudo-merge: implement support for finding existing mergesTaylor Blau, Apr 29, 2024
  82. 23/23 t/perf: implement performace tests for pseudo-merge bitmapsTaylor Blau, Apr 29, 2024
  83. Junio C HamanoApr 30, 2024
  84. Taylor BlauMay 1, 2024
  85. 00/30 pack-bitmap: pseudo-merge reachability bitmapsTaylor Blau, May 21, 2024
  86. 01/30 object.h: add flags allocated by pack-bitmap.hTaylor Blau, May 21, 2024
  87. Taylor BlauMay 21, 2024
  88. 07/30 Documentation/gitpacking.txt: initial commitTaylor Blau, May 21, 2024
  89. 08/30 Documentation/gitpacking.txt: describe pseudo-merge bitmapsTaylor Blau, May 21, 2024
  90. 09/30 Documentation/technical: describe pseudo-merge bitmaps formatTaylor Blau, May 21, 2024
  91. 10/30 ewah: implement `ewah_bitmap_is_subset()`Taylor Blau, May 21, 2024
  92. 11/30 pack-bitmap: move some initialization to `bitmap_writer_init()`Taylor Blau, May 21, 2024
  93. 12/30 pseudo-merge.ch: initial commitTaylor Blau, May 21, 2024
  94. 13/30 pack-bitmap-write: support storing pseudo-merge commitsTaylor Blau, May 21, 2024
  95. 14/30 pack-bitmap: implement `bitmap_writer_has_bitmapped_object_id()`Taylor Blau, May 21, 2024
  96. 15/30 pack-bitmap: make `bitmap_writer_push_bitmapped_commit()` publicTaylor Blau, May 21, 2024
  97. 16/30 config: introduce git_config_float()Taylor Blau, May 21, 2024
  98. Jeff KingMay 23, 2024
  99. Taylor BlauMay 23, 2024
  100. 17/30 pseudo-merge: implement support for selecting pseudo-merge commitsTaylor Blau, May 21, 2024
  101. Jeff KingMay 23, 2024
  102. Taylor BlauMay 23, 2024
  103. 18/30 pack-bitmap-write.c: write pseudo-merge tableTaylor Blau, May 21, 2024
  104. 19/30 pack-bitmap: extract `read_bitmap()` functionTaylor Blau, May 21, 2024
  105. 20/30 pseudo-merge: scaffolding for readsTaylor Blau, May 21, 2024
  106. 21/30 pack-bitmap.c: read pseudo-merge extensionTaylor Blau, May 21, 2024
  107. 22/30 pseudo-merge: implement support for reading pseudo-merge commitsTaylor Blau, May 21, 2024
  108. Jeff KingMay 23, 2024
  109. Taylor BlauMay 23, 2024
  110. 23/30 ewah: implement `ewah_bitmap_popcount()`Taylor Blau, May 21, 2024
  111. 24/30 pack-bitmap: implement test helpers for pseudo-mergeTaylor Blau, May 21, 2024
  112. 25/30 t/test-lib-functions.sh: support `--date` in `test_commit_bulk()`Taylor Blau, May 21, 2024
  113. Jeff KingMay 23, 2024
  114. Junio C HamanoMay 23, 2024
  115. Taylor BlauMay 23, 2024
  116. 26/30 pack-bitmap.c: use pseudo-merges during traversalTaylor Blau, May 21, 2024
  117. Jeff KingMay 23, 2024
  118. Taylor BlauMay 23, 2024
  119. 27/30 pack-bitmap: extra trace2 informationTaylor Blau, May 21, 2024
  120. 28/30 ewah: `bitmap_equals_ewah()`Taylor Blau, May 21, 2024
  121. 29/30 pseudo-merge: implement support for finding existing mergesTaylor Blau, May 21, 2024
  122. 30/30 t/perf: implement performace tests for pseudo-merge bitmapsTaylor Blau, May 21, 2024
  123. Jeff KingMay 23, 2024
  124. Taylor BlauMay 23, 2024
  125. Jeff KingMay 25, 2024
  126. Jeff KingMay 23, 2024
  127. Taylor BlauMay 23, 2024
  128. Jeff KingMay 25, 2024
  129. Taylor BlauMay 23, 2024
  130. 00/24 pack-bitmap: pseudo-merge reachability bitmapsTaylor Blau, May 23, 2024
  131. 01/24 Documentation/gitpacking.txt: initial commitTaylor Blau, May 23, 2024
  132. 02/24 Documentation/gitpacking.txt: describe pseudo-merge bitmapsTaylor Blau, May 23, 2024
  133. 03/24 Documentation/technical: describe pseudo-merge bitmaps formatTaylor Blau, May 23, 2024
  134. 04/24 ewah: implement `ewah_bitmap_is_subset()`Taylor Blau, May 23, 2024
  135. 05/24 pack-bitmap: move some initialization to `bitmap_writer_init()`Taylor Blau, May 23, 2024
  136. 06/24 pseudo-merge.ch: initial commitTaylor Blau, May 23, 2024
  137. 07/24 pack-bitmap-write: support storing pseudo-merge commitsTaylor Blau, May 23, 2024
  138. 08/24 pack-bitmap: implement `bitmap_writer_has_bitmapped_object_id()`Taylor Blau, May 23, 2024
  139. 09/24 pack-bitmap: make `bitmap_writer_push_bitmapped_commit()` publicTaylor Blau, May 23, 2024
  140. 10/24 config: introduce `git_config_double()`Taylor Blau, May 23, 2024
  141. 11/24 pseudo-merge: implement support for selecting pseudo-merge commitsTaylor Blau, May 23, 2024
  142. Jeff KingMay 25, 2024
  143. 12/24 pack-bitmap-write.c: write pseudo-merge tableTaylor Blau, May 23, 2024
  144. 13/24 pack-bitmap: extract `read_bitmap()` functionTaylor Blau, May 23, 2024
  145. 14/24 pseudo-merge: scaffolding for readsTaylor Blau, May 23, 2024
  146. 15/24 pack-bitmap.c: read pseudo-merge extensionTaylor Blau, May 23, 2024
  147. 16/24 pseudo-merge: implement support for reading pseudo-merge commitsTaylor Blau, May 23, 2024
  148. 17/24 ewah: implement `ewah_bitmap_popcount()`Taylor Blau, May 23, 2024
  149. 18/24 pack-bitmap: implement test helpers for pseudo-mergeTaylor Blau, May 23, 2024
  150. 19/24 t/test-lib-functions.sh: support `--notick` in `test_commit_bulk()`Taylor Blau, May 23, 2024
  151. Jeff KingMay 25, 2024
  152. 20/24 pack-bitmap.c: use pseudo-merges during traversalTaylor Blau, May 23, 2024
  153. 21/24 pack-bitmap: extra trace2 informationTaylor Blau, May 23, 2024
  154. 22/24 ewah: `bitmap_equals_ewah()`Taylor Blau, May 23, 2024
  155. 23/24 pseudo-merge: implement support for finding existing mergesTaylor Blau, May 23, 2024
  156. 24/24 t/perf: implement performance tests for pseudo-merge bitmapsTaylor Blau, May 23, 2024
  157. Jeff KingMay 25, 2024

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.