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

[PATCH v2 17/17] pack-objects: thread the path-based compression

From
Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com>
Date
Oct 20, 2024, 13:43 UTC
Message-ID
<fddc320eb0bc07b1f8314a07cdda1cd8fbf77e9f.1729431811.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1813.v2.git.1729431810.gitgitgadget@gmail.com>
From: Derrick Stolee <stolee@gmail.com>

Adapting the implementation of ll_find_deltas(), create a threaded version of the --path-walk compression step in 'git pack-objects'.

This involves adding a 'regions' member to the thread_params struct, allowing each thread to own a section of paths. We can simplify the way jobs are split because there is no value in extending the batch based on name-hash the way sections of the object entry array are attempted to be grouped. We re-use the 'list_size' and 'remaining' items for the purpose of borrowing work in progress from other "victim" threads when a thread has finished its batch of work more quickly.

Using the Git repository as a test repo, the p5313 performance test shows that the resulting size of the repo is the same, but the threaded implementation gives gains of varying degrees depending on the number of objects being packed. (This was tested on a 16-core machine.)

Test HEAD~1 HEAD --------------------------------------------------------------- 5313.2: thin pack 0.01 0.01 +0.0% 5313.4: thin pack with --path-walk 0.01 0.01 +0.0% 5313.6: big pack 2.54 2.60 +2.4% 5313.8: big pack with --path-walk 4.70 3.09 -34.3% 5313.10: repack 28.75 28.55 -0.7% 5313.12: repack with --path-walk 108.55 46.14 -57.5%

On the microsoft/fluentui repo, where the --path-walk feature has been shown to be more effective in space savings, we get these results:

Test HEAD~1 HEAD ---------------------------------------------------------------- 5313.2: thin pack 0.39 0.40 +2.6% 5313.4: thin pack with --path-walk 0.08 0.07 -12.5% 5313.6: big pack 4.15 4.15 +0.0% 5313.8: big pack with --path-walk 6.41 3.21 -49.9% 5313.10: repack 90.69 90.83 +0.2% 5313.12: repack with --path-walk 108.23 49.09 -54.6%

Signed-off-by: Derrick Stolee <stolee@gmail.com>
---
 builtin/pack-objects.c | 162 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 160 insertions(+), 2 deletions(-)
diff --git a/builtin/pack-objects.c b/builtin/pack-objects.c
index 5c413ac07e6..443ce17063a 100644
--- a/builtin/pack-objects.c
+++ b/builtin/pack-objects.c
@@ -2935,6 +2935,7 @@ static void find_deltas(struct object_entry **list, unsigned *list_size,
 struct thread_params {
 	pthread_t thread;
 	struct object_entry **list;
+	struct packing_region *regions;
 	unsigned list_size;
 	unsigned remaining;
 	int window;
@@ -3248,6 +3249,163 @@ static void find_deltas_by_region(struct object_entry *list,
 	stop_progress(&progress_state);
 }
 
+static void *threaded_find_deltas_by_path(void *arg)
+{
+	struct thread_params *me = arg;
+
+	progress_lock();
+	while (me->remaining) {
+		while (me->remaining) {
+			progress_unlock();
+			find_deltas_for_region(to_pack.objects,
+					       me->regions,
+					       me->processed);
+			progress_lock();
+			me->remaining--;
+			me->regions++;
+		}
+
+		me->working = 0;
+		pthread_cond_signal(&progress_cond);
+		progress_unlock();
+
+		/*
+		 * We must not set ->data_ready before we wait on the
+		 * condition because the main thread may have set it to 1
+		 * before we get here. In order to be sure that new
+		 * work is available if we see 1 in ->data_ready, it
+		 * was initialized to 0 before this thread was spawned
+		 * and we reset it to 0 right away.
+		 */
+		pthread_mutex_lock(&me->mutex);
+		while (!me->data_ready)
+			pthread_cond_wait(&me->cond, &me->mutex);
+		me->data_ready = 0;
+		pthread_mutex_unlock(&me->mutex);
+
+		progress_lock();
+	}
+	progress_unlock();
+	/* leave ->working 1 so that this doesn't get more work assigned */
+	return NULL;
+}
+
+static void ll_find_deltas_by_region(struct object_entry *list,
+				     struct packing_region *regions,
+				     uint32_t start, uint32_t nr)
+{
+	struct thread_params *p;
+	int i, ret, active_threads = 0;
+	unsigned int processed = 0;
+	uint32_t progress_nr;
+	init_threaded_search();
+
+	if (!nr)
+		return;
+
+	progress_nr =  regions[nr - 1].start + regions[nr - 1].nr;
+	if (delta_search_threads <= 1) {
+		find_deltas_by_region(list, regions, start, nr);
+		cleanup_threaded_search();
+		return;
+	}
+
+	if (progress > pack_to_stdout)
+		fprintf_ln(stderr, _("Path-based delta compression using up to %d threads"),
+			   delta_search_threads);
+	CALLOC_ARRAY(p, delta_search_threads);
+
+	if (progress)
+		progress_state = start_progress(_("Compressing objects by path"),
+						progress_nr);
+	/* Partition the work amongst work threads. */
+	for (i = 0; i < delta_search_threads; i++) {
+		unsigned sub_size = nr / (delta_search_threads - i);
+
+		p[i].window = window;
+		p[i].depth = depth;
+		p[i].processed = &processed;
+		p[i].working = 1;
+		p[i].data_ready = 0;
+
+		p[i].regions = regions;
+		p[i].list_size = sub_size;
+		p[i].remaining = sub_size;
+
+		regions += sub_size;
+		nr -= sub_size;
+	}
+
+	/* Start work threads. */
+	for (i = 0; i < delta_search_threads; i++) {
+		if (!p[i].list_size)
+			continue;
+		pthread_mutex_init(&p[i].mutex, NULL);
+		pthread_cond_init(&p[i].cond, NULL);
+		ret = pthread_create(&p[i].thread, NULL,
+				     threaded_find_deltas_by_path, &p[i]);
+		if (ret)
+			die(_("unable to create thread: %s"), strerror(ret));
+		active_threads++;
+	}
+
+	/*
+	 * Now let's wait for work completion.  Each time a thread is done
+	 * with its work, we steal half of the remaining work from the
+	 * thread with the largest number of unprocessed objects and give
+	 * it to that newly idle thread.  This ensure good load balancing
+	 * until the remaining object list segments are simply too short
+	 * to be worth splitting anymore.
+	 */
+	while (active_threads) {
+		struct thread_params *target = NULL;
+		struct thread_params *victim = NULL;
+		unsigned sub_size = 0;
+
+		progress_lock();
+		for (;;) {
+			for (i = 0; !target && i < delta_search_threads; i++)
+				if (!p[i].working)
+					target = &p[i];
+			if (target)
+				break;
+			pthread_cond_wait(&progress_cond, &progress_mutex);
+		}
+
+		for (i = 0; i < delta_search_threads; i++)
+			if (p[i].remaining > 2*window &&
+			    (!victim || victim->remaining < p[i].remaining))
+				victim = &p[i];
+		if (victim) {
+			sub_size = victim->remaining / 2;
+			target->regions = victim->regions + victim->remaining - sub_size;
+			victim->list_size -= sub_size;
+			victim->remaining -= sub_size;
+		}
+		target->list_size = sub_size;
+		target->remaining = sub_size;
+		target->working = 1;
+		progress_unlock();
+
+		pthread_mutex_lock(&target->mutex);
+		target->data_ready = 1;
+		pthread_cond_signal(&target->cond);
+		pthread_mutex_unlock(&target->mutex);
+
+		if (!sub_size) {
+			pthread_join(target->thread, NULL);
+			pthread_cond_destroy(&target->cond);
+			pthread_mutex_destroy(&target->mutex);
+			active_threads--;
+		}
+	}
+	cleanup_threaded_search();
+	free(p);
+
+	display_progress(progress_state, progress_nr);
+	stop_progress(&progress_state);
+}
+
 static void prepare_pack(int window, int depth)
 {
 	struct object_entry **delta_list;
@@ -3273,8 +3431,8 @@ static void prepare_pack(int window, int depth)
 		return;
 
 	if (path_walk)
-		find_deltas_by_region(to_pack.objects, to_pack.regions,
-				      0, to_pack.nr_regions);
+		ll_find_deltas_by_region(to_pack.objects, to_pack.regions,
+					 0, to_pack.nr_regions);
 
 	ALLOC_ARRAY(delta_list, to_pack.nr_objects);
 	nr_deltas = n = 0;
-- 
gitgitgadget
Previous: Derrick Stolee via GitGitGadgetNext: Taylor Blau
Message 44 of 55 in “pack-objects: add --path-walk option for better deltas”
  1. 00/17 pack-objects: add --path-walk option for better deltasDerrick Stolee via GitGitGadget, Oct 8, 2024
  2. 01/17 path-walk: introduce an object walk by pathDerrick Stolee via GitGitGadget, Oct 8, 2024
  3. 02/17 t6601: add helper for testing path-walk APIDerrick Stolee via GitGitGadget, Oct 8, 2024
  4. 03/17 path-walk: allow consumer to specify object typesDerrick Stolee via GitGitGadget, Oct 8, 2024
  5. 04/17 path-walk: allow visiting tagsDerrick Stolee via GitGitGadget, Oct 8, 2024
  6. 05/17 revision: create mark_trees_uninteresting_dense()Derrick Stolee via GitGitGadget, Oct 8, 2024
  7. 06/17 path-walk: add prune_all_uninteresting optionDerrick Stolee via GitGitGadget, Oct 8, 2024
  8. 07/17 pack-objects: extract should_attempt_deltas()Derrick Stolee via GitGitGadget, Oct 8, 2024
  9. 08/17 pack-objects: add --path-walk optionDerrick Stolee via GitGitGadget, Oct 8, 2024
  10. Jonathan TanOct 28, 2024
  11. Taylor BlauOct 29, 2024
  12. Jonathan TanOct 29, 2024
  13. Taylor BlauOct 29, 2024
  14. Derrick StoleeOct 31, 2024
  15. Derrick StoleeOct 31, 2024
  16. Taylor BlauOct 31, 2024
  17. Derrick StoleeOct 31, 2024
  18. 09/17 pack-objects: update usage to match docsDerrick Stolee via GitGitGadget, Oct 8, 2024
  19. 10/17 p5313: add performance tests for --path-walkDerrick Stolee via GitGitGadget, Oct 8, 2024
  20. 11/17 pack-objects: introduce GIT_TEST_PACK_PATH_WALKDerrick Stolee via GitGitGadget, Oct 8, 2024
  21. 12/17 repack: add --path-walk optionDerrick Stolee via GitGitGadget, Oct 8, 2024
  22. 13/17 repack: update usage to match docsDerrick Stolee via GitGitGadget, Oct 8, 2024
  23. 14/17 pack-objects: enable --path-walk via configDerrick Stolee via GitGitGadget, Oct 8, 2024
  24. 15/17 scalar: enable path-walk during push via configDerrick Stolee via GitGitGadget, Oct 8, 2024
  25. 16/17 pack-objects: refactor path-walk delta phaseDerrick Stolee via GitGitGadget, Oct 8, 2024
  26. 17/17 pack-objects: thread the path-based compressionDerrick Stolee via GitGitGadget, Oct 8, 2024
  27. 00/17 pack-objects: add --path-walk option for better deltasDerrick Stolee via GitGitGadget, Oct 20, 2024
  28. 01/17 path-walk: introduce an object walk by pathDerrick Stolee via GitGitGadget, Oct 20, 2024
  29. 02/17 t6601: add helper for testing path-walk APIDerrick Stolee via GitGitGadget, Oct 20, 2024
  30. 03/17 path-walk: allow consumer to specify object typesDerrick Stolee via GitGitGadget, Oct 20, 2024
  31. 04/17 path-walk: allow visiting tagsDerrick Stolee via GitGitGadget, Oct 20, 2024
  32. 05/17 revision: create mark_trees_uninteresting_dense()Derrick Stolee via GitGitGadget, Oct 20, 2024
  33. 06/17 path-walk: add prune_all_uninteresting optionDerrick Stolee via GitGitGadget, Oct 20, 2024
  34. 07/17 pack-objects: extract should_attempt_deltas()Derrick Stolee via GitGitGadget, Oct 20, 2024
  35. 09/17 pack-objects: update usage to match docsDerrick Stolee via GitGitGadget, Oct 20, 2024
  36. 08/17 pack-objects: add --path-walk optionDerrick Stolee via GitGitGadget, Oct 20, 2024
  37. 10/17 p5313: add performance tests for --path-walkDerrick Stolee via GitGitGadget, Oct 20, 2024
  38. 11/17 pack-objects: introduce GIT_TEST_PACK_PATH_WALKDerrick Stolee via GitGitGadget, Oct 20, 2024
  39. 12/17 repack: add --path-walk optionDerrick Stolee via GitGitGadget, Oct 20, 2024
  40. 13/17 repack: update usage to match docsDerrick Stolee via GitGitGadget, Oct 20, 2024
  41. 14/17 pack-objects: enable --path-walk via configDerrick Stolee via GitGitGadget, Oct 20, 2024
  42. 15/17 scalar: enable path-walk during push via configDerrick Stolee via GitGitGadget, Oct 20, 2024
  43. 16/17 pack-objects: refactor path-walk delta phaseDerrick Stolee via GitGitGadget, Oct 20, 2024
  44. 17/17 pack-objects: thread the path-based compressionDerrick Stolee via GitGitGadget, Oct 20, 2024
  45. Taylor BlauOct 21, 2024
  46. Derrick StoleeOct 24, 2024
  47. Taylor BlauOct 24, 2024
  48. Patrick SteinhardtOct 28, 2024
  49. Taylor BlauOct 28, 2024
  50. Derrick StoleeOct 28, 2024
  51. Taylor BlauOct 28, 2024
  52. Derrick StoleeOct 28, 2024
  53. Taylor BlauOct 29, 2024
  54. Derrick StoleeOct 31, 2024
  55. Taylor BlauOct 31, 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.