backfill: basic functionality and tests
The default behavior of 'git backfill' is to fetch all missing blobs that are reachable from HEAD. Document and test this behavior. The implementation is a very simple use of the path-walk API, initializing the revision walk at HEAD to start the path-walk from all commits reachable from HEAD. Ignore the object arrays that correspond to tree entries, assuming that they are all present already. The path-walk API provides lists of objects in batches according to a common path, but that list could be very small. We want to balance the number of requests to the server with the ability to have the process interrupted with minimal repeated work to catch up in the next run. Based on some experiments (detailed in the next change) a minimum batch size of 50,000 is selected for the default. This batch size is a _minimum_. As the path-walk API emits lists of blob IDs, they are collected into a list of objects for a request to the server. When that list is at least the minimum batch size, then the request is sent to the server for the new objects. However, the list of blob IDs from the path-walk API could be much longer than the batch size. At this moment, it is unclear if there is a benefit to split the list when there are too many objects at the same path. Signed-off-by: Derrick Stolee <stolee@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Derrick Stolee committed
Feb 3, 2025 at 17:11 UTC
1e72e889e722af06c2bd17b92becbc123c3b84c5
5 files changed
+227
-4
Documentation/git-backfill.txt
+31
@@ -14,6 +14,37 @@ git backfill [<options>]
14
DESCRIPTION
15
-----------
16
17
+Blobless partial clones are created using `git clone --filter=blob:none`
18
+and then configure the local repository such that the Git client avoids
19
+downloading blob objects unless they are required for a local operation.
20
+This initially means that the clone and later fetches download reachable
21
+commits and trees but no blobs. Later operations that change the `HEAD`
22
+pointer, such as `git checkout` or `git merge`, may need to download
23
+missing blobs in order to complete their operation.
24
+
25
+In the worst cases, commands that compute blob diffs, such as `git blame`,
26
+become very slow as they download the missing blobs in single-blob
27
+requests to satisfy the missing object as the Git command needs it. This
28
+leads to multiple download requests and no ability for the Git server to
29
+provide delta compression across those objects.
30
+
31
+The `git backfill` command provides a way for the user to request that
32
+Git downloads the missing blobs (with optional filters) such that the
33
+missing blobs representing historical versions of files can be downloaded
34
+in batches. The `backfill` command attempts to optimize the request by
35
+grouping blobs that appear at the same path, hopefully leading to good
36
+delta compression in the packfile sent by the server.
37
+
38
+In this way, `git backfill` provides a mechanism to break a large clone
39
+into smaller chunks. Starting with a blobless partial clone with `git
40
+clone --filter=blob:none` and then running `git backfill` in the local
41
+repository provides a way to download all reachable objects in several
42
+smaller network calls than downloading the entire repository at clone
43
+time.
44
+
45
+By default, `git backfill` downloads all blobs reachable from the `HEAD`
46
+commit. This set can be restricted or expanded using various options.
47
+
48
THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR MAY CHANGE IN THE FUTURE.
49
50
SEE ALSO
Documentation/technical/api-path-walk.txt
+2
-1
@@ -60,4 +60,5 @@ Examples
60
--------
61
62
See example usages in:
63
- `t/helper/test-path-walk.c`
63
+ `t/helper/test-path-walk.c`,
64
+ `builtin/backfill.c`
builtin/backfill.c
+99
-3
@@ -1,16 +1,112 @@
1
#include "builtin.h"
2
+#include "git-compat-util.h"
3
#include "config.h"
4
#include "parse-options.h"
5
#include "repository.h"
6
+#include "commit.h"
7
+#include "hex.h"
8
+#include "tree.h"
9
+#include "tree-walk.h"
10
#include "object.h"
11
+#include "object-store-ll.h"
12
+#include "oid-array.h"
13
+#include "oidset.h"
14
+#include "promisor-remote.h"
15
+#include "strmap.h"
16
+#include "string-list.h"
17
+#include "revision.h"
18
+#include "trace2.h"
19
+#include "progress.h"
20
+#include "packfile.h"
21
+#include "path-walk.h"
22
23
static const char * const builtin_backfill_usage[] = {
24
N_("git backfill [<options>]"),
25
NULL
26
};
27
28
+struct backfill_context {
29
+ struct repository *repo;
30
+ struct oid_array current_batch;
31
+ size_t min_batch_size;
32
+};
33
+
34
+static void backfill_context_clear(struct backfill_context *ctx)
35
+{
36
+ oid_array_clear(&ctx->current_batch);
37
+}
38
+
39
+static void download_batch(struct backfill_context *ctx)
40
+{
41
+ promisor_remote_get_direct(ctx->repo,
42
+ ctx->current_batch.oid,
43
+ ctx->current_batch.nr);
44
+ oid_array_clear(&ctx->current_batch);
45
+
46
+ /*
47
+ * We likely have a new packfile. Add it to the packed list to
48
+ * avoid possible duplicate downloads of the same objects.
49
+ */
50
+ reprepare_packed_git(ctx->repo);
51
+}
52
+
53
+static int fill_missing_blobs(const char *path UNUSED,
54
+ struct oid_array *list,
55
+ enum object_type type,
56
+ void *data)
57
+{
58
+ struct backfill_context *ctx = data;
59
+
60
+ if (type != OBJ_BLOB)
61
+ return 0;
62
+
63
+ for (size_t i = 0; i < list->nr; i++) {
64
+ if (!has_object(ctx->repo, &list->oid[i],
65
+ OBJECT_INFO_FOR_PREFETCH))
66
+ oid_array_append(&ctx->current_batch, &list->oid[i]);
67
+ }
68
+
69
+ if (ctx->current_batch.nr >= ctx->min_batch_size)
70
+ download_batch(ctx);
71
+
72
+ return 0;
73
+}
74
+
75
+static int do_backfill(struct backfill_context *ctx)
76
+{
77
+ struct rev_info revs;
78
+ struct path_walk_info info = PATH_WALK_INFO_INIT;
79
+ int ret;
80
+
81
+ repo_init_revisions(ctx->repo, &revs, "");
82
+ handle_revision_arg("HEAD", &revs, 0, 0);
83
+
84
+ info.blobs = 1;
85
+ info.tags = info.commits = info.trees = 0;
86
+
87
+ info.revs = &revs;
88
+ info.path_fn = fill_missing_blobs;
89
+ info.path_fn_data = ctx;
90
+
91
+ ret = walk_objects_by_path(&info);
92
+
93
+ /* Download the objects that did not fill a batch. */
94
+ if (!ret)
95
+ download_batch(ctx);
96
+
97
+ path_walk_info_clear(&info);
98
+ release_revisions(&revs);
99
+ return ret;
100
+}
101
+
102
int cmd_backfill(int argc, const char **argv, const char *prefix, struct repository *repo)
103
{
104
+ int result;
105
+ struct backfill_context ctx = {
106
+ .repo = repo,
107
+ .current_batch = OID_ARRAY_INIT,
108
+ .min_batch_size = 50000,
109
+ };
110
struct option options[] = {
111
OPT_END(),
112
};
@@ -22,7 +118,7 @@ int cmd_backfill(int argc, const char **argv, const char *prefix, struct reposit
118
119
repo_config(repo, git_default_config, NULL);
120
25
- die(_("not implemented"));
26
-
27
- return 0;
121
+ result = do_backfill(&ctx);
122
+ backfill_context_clear(&ctx);
123
+ return result;
124
}
t/meson.build
+1
@@ -721,6 +721,7 @@ integration_tests = [
721
't5617-clone-submodules-remote.sh',
722
't5618-alternate-refs.sh',
723
't5619-clone-local-ambiguous-transport.sh',
724
+ 't5620-backfill.sh',
725
't5700-protocol-v1.sh',
726
't5701-git-serve.sh',
727
't5702-protocol-v2.sh',
t/t5620-backfill.sh
new
+94
@@ -0,0 +1,94 @@
1
+#!/bin/sh
2
+
3
+test_description='git backfill on partial clones'
4
+
5
+GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
6
+export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
7
+
8
+. ./test-lib.sh
9
+
10
+# We create objects in the 'src' repo.
11
+test_expect_success 'setup repo for object creation' '
12
+ echo "{print \$1}" >print_1.awk &&
13
+ echo "{print \$2}" >print_2.awk &&
14
+
15
+ git init src &&
16
+
17
+ mkdir -p src/a/b/c &&
18
+ mkdir -p src/d/e &&
19
+
20
+ for i in 1 2
21
+ do
22
+ for n in 1 2 3 4
23
+ do
24
+ echo "Version $i of file $n" > src/file.$n.txt &&
25
+ echo "Version $i of file a/$n" > src/a/file.$n.txt &&
26
+ echo "Version $i of file a/b/$n" > src/a/b/file.$n.txt &&
27
+ echo "Version $i of file a/b/c/$n" > src/a/b/c/file.$n.txt &&
28
+ echo "Version $i of file d/$n" > src/d/file.$n.txt &&
29
+ echo "Version $i of file d/e/$n" > src/d/e/file.$n.txt &&
30
+ git -C src add . &&
31
+ git -C src commit -m "Iteration $n" || return 1
32
+ done
33
+ done
34
+'
35
+
36
+# Clone 'src' into 'srv.bare' so we have a bare repo to be our origin
37
+# server for the partial clone.
38
+test_expect_success 'setup bare clone for server' '
39
+ git clone --bare "file://$(pwd)/src" srv.bare &&
40
+ git -C srv.bare config --local uploadpack.allowfilter 1 &&
41
+ git -C srv.bare config --local uploadpack.allowanysha1inwant 1
42
+'
43
+
44
+# do basic partial clone from "srv.bare"
45
+test_expect_success 'do partial clone 1, backfill gets all objects' '
46
+ git clone --no-checkout --filter=blob:none \
47
+ --single-branch --branch=main \
48
+ "file://$(pwd)/srv.bare" backfill1 &&
49
+
50
+ # Backfill with no options gets everything reachable from HEAD.
51
+ GIT_TRACE2_EVENT="$(pwd)/backfill-file-trace" git \
52
+ -C backfill1 backfill &&
53
+
54
+ # We should have engaged the partial clone machinery
55
+ test_trace2_data promisor fetch_count 48 <backfill-file-trace &&
56
+
57
+ # No more missing objects!
58
+ git -C backfill1 rev-list --quiet --objects --missing=print HEAD >revs2 &&
59
+ test_line_count = 0 revs2
60
+'
61
+
62
+. "$TEST_DIRECTORY"/lib-httpd.sh
63
+start_httpd
64
+
65
+test_expect_success 'create a partial clone over HTTP' '
66
+ SERVER="$HTTPD_DOCUMENT_ROOT_PATH/server" &&
67
+ rm -rf "$SERVER" repo &&
68
+ git clone --bare "file://$(pwd)/src" "$SERVER" &&
69
+ test_config -C "$SERVER" uploadpack.allowfilter 1 &&
70
+ test_config -C "$SERVER" uploadpack.allowanysha1inwant 1 &&
71
+
72
+ git clone --no-checkout --filter=blob:none \
73
+ "$HTTPD_URL/smart/server" backfill-http
74
+'
75
+
76
+test_expect_success 'backfilling over HTTP succeeds' '
77
+ GIT_TRACE2_EVENT="$(pwd)/backfill-http-trace" git \
78
+ -C backfill-http backfill &&
79
+
80
+ # We should have engaged the partial clone machinery
81
+ test_trace2_data promisor fetch_count 48 <backfill-http-trace &&
82
+
83
+ # Confirm all objects are present, none missing.
84
+ git -C backfill-http rev-list --objects --all >rev-list-out &&
85
+ awk "{print \$1;}" <rev-list-out >oids &&
86
+ GIT_TRACE2_EVENT="$(pwd)/walk-trace" git -C backfill-http \
87
+ cat-file --batch-check <oids >batch-out &&
88
+ ! grep missing batch-out
89
+'
90
+
91
+# DO NOT add non-httpd-specific tests here, because the last part of this
92
+# test script is only executed when httpd is available and enabled.
93
+
94
+test_done