From: Derrick Stolee <dstolee@xxxxxxxxxxxxx> One goal of background maintenance jobs is to allow a user to disable auto-gc (gc.auto=0) but keep their repository in a clean state. Without any cleanup, loose objects will clutter the object database and slow operations. In addition, the loose objects will take up extra space because they are not stored with deltas against similar objects. Create a 'loose-objects' job for the 'git run-job' command. This helps clean up loose objects without disrupting concurrent Git commands using the following sequence of events: 1. Run 'git prune-packed' to delete any loose objects that exist in a pack-file. Concurrent commands will prefer the packed version of the object to the loose version. (Of course, there are exceptions for commands that specifically care about the location of an object. These are rare for a user to run on purpose, and we hope a user that has selected background maintenance will not be trying to do foreground maintenance.) 2. Run 'git pack-objects' on a batch of loose objects. These objects are grouped by scanning the loose object directories in lexicographic order until listing all loose objects -or- reaching 50,000 objects. This is more than enough if the loose objects are created only by a user doing normal development. We noticed users with _millions_ of loose objects because VFS for Git downloads blobs on-demand when a file read operation requires populating a virtual file. This has potential of happening in partial clones if someone runs 'git grep' or otherwise evades the batch-download feature for requesting promisor objects. This step is based on a similar step in Scalar [1] and VFS for Git. [1] https://github.com/microsoft/scalar/blob/master/Scalar.Common/Maintenance/LooseObjectsStep.cs Signed-off-by: Derrick Stolee <dstolee@xxxxxxxxxxxxx> --- Documentation/git-run-job.txt | 14 ++++- builtin/run-job.c | 97 ++++++++++++++++++++++++++++++++++- t/t7900-run-job.sh | 27 ++++++++++ 3 files changed, 136 insertions(+), 2 deletions(-) diff --git a/Documentation/git-run-job.txt b/Documentation/git-run-job.txt index eb92e891915..43ca1160b5a 100644 --- a/Documentation/git-run-job.txt +++ b/Documentation/git-run-job.txt @@ -9,7 +9,7 @@ git-run-job - Run a maintenance job. Intended for background operation. SYNOPSIS -------- [verse] -'git run-job (commit-graph|fetch)' +'git run-job (commit-graph|fetch|loose-objects)' DESCRIPTION @@ -59,6 +59,18 @@ This means that foreground fetches are still required to update the remote refs, but the users is notified when the branches and tags are updated on the remote. +'loose-objects':: + +The `loose-objects` job cleans up loose objects and places them into +pack-files. In order to prevent race conditions with concurrent Git +commands, it follows a two-step process. First, it deletes any loose +objects that already exist in a pack-file; concurrent Git processes will +examine the pack-file for the object data instead of the loose object. +Second, it creates a new pack-file (starting with "loose-") containing +a batch of loose objects. The batch size is limited to 50 thousand +objects to prevent the job from taking too long on a repository with +many loose objects. + GIT --- Part of the linkgit:git[1] suite diff --git a/builtin/run-job.c b/builtin/run-job.c index e59056b2918..cecf9058c51 100644 --- a/builtin/run-job.c +++ b/builtin/run-job.c @@ -7,7 +7,7 @@ #include "run-command.h" static char const * const builtin_run_job_usage[] = { - N_("git run-job (commit-graph|fetch)"), + N_("git run-job (commit-graph|fetch|loose-objects)"), NULL }; @@ -145,6 +145,99 @@ static int run_fetch_job(void) return result; } +static int prune_packed(void) +{ + struct argv_array cmd = ARGV_ARRAY_INIT; + argv_array_pushl(&cmd, "prune-packed", NULL); + return run_command_v_opt(cmd.argv, RUN_GIT_CMD); +} + +struct write_loose_object_data { + FILE *in; + int count; + int batch_size; +}; + +static int loose_object_exists(const struct object_id *oid, + const char *path, + void *data) +{ + return 1; +} + +static int write_loose_object_to_stdin(const struct object_id *oid, + const char *path, + void *data) +{ + struct write_loose_object_data *d = (struct write_loose_object_data *)data; + + fprintf(d->in, "%s\n", oid_to_hex(oid)); + + return ++(d->count) > d->batch_size; +} + +static int pack_loose(void) +{ + int result = 0; + struct write_loose_object_data data; + struct strbuf prefix = STRBUF_INIT; + struct child_process *pack_proc; + + /* + * Do not start pack-objects process + * if there are no loose objects. + */ + if (!for_each_loose_file_in_objdir(the_repository->objects->odb->path, + loose_object_exists, + NULL, NULL, NULL)) + return 0; + + pack_proc = xmalloc(sizeof(*pack_proc)); + + child_process_init(pack_proc); + + strbuf_addstr(&prefix, the_repository->objects->odb->path); + strbuf_addstr(&prefix, "/pack/loose"); + + argv_array_pushl(&pack_proc->args, "git", "pack-objects", + "--quiet", prefix.buf, NULL); + + pack_proc->in = -1; + + if (start_command(pack_proc)) { + error(_("failed to start 'git pack-objects' process")); + result = 1; + goto cleanup; + } + + data.in = xfdopen(pack_proc->in, "w"); + data.count = 0; + data.batch_size = 50000; + + for_each_loose_file_in_objdir(the_repository->objects->odb->path, + write_loose_object_to_stdin, + NULL, + NULL, + &data); + + fclose(data.in); + + if (finish_command(pack_proc)) { + error(_("failed to finish 'git pack-objects' process")); + result = 1; + } + +cleanup: + strbuf_release(&prefix); + free(pack_proc); + return result; +} + +static int run_loose_objects_job(void) +{ + return prune_packed() || pack_loose(); +} + int cmd_run_job(int argc, const char **argv, const char *prefix) { static struct option builtin_run_job_options[] = { @@ -166,6 +259,8 @@ int cmd_run_job(int argc, const char **argv, const char *prefix) return run_commit_graph_job(); if (!strcmp(argv[0], "fetch")) return run_fetch_job(); + if (!strcmp(argv[0], "loose-objects")) + return run_loose_objects_job(); } usage_with_options(builtin_run_job_usage, diff --git a/t/t7900-run-job.sh b/t/t7900-run-job.sh index d3faeba135b..41da083257b 100755 --- a/t/t7900-run-job.sh +++ b/t/t7900-run-job.sh @@ -66,4 +66,31 @@ test_expect_success 'fetch job' ' test_line_count = 2 $chain ' +test_expect_success 'loose-objects job' ' + ls client/.git/objects >obj-dir-before && + test_file_not_empty obj-dir-before && + ls client/.git/objects/pack/*.pack >packs-before && + test_line_count = 1 packs-before && + + # The first run creates a pack-file + # but does not delete loose objects. + git -C client run-job loose-objects && + ls client/.git/objects >obj-dir-between && + test_cmp obj-dir-before obj-dir-between && + ls client/.git/objects/pack/*.pack >packs-between && + test_line_count = 2 packs-between && + + # The second run deletes loose objects + # but does not create a pack-file. + git -C client run-job loose-objects && + ls client/.git/objects >obj-dir-after && + cat >expect <<-\EOF && + info + pack + EOF + test_cmp expect obj-dir-after && + ls client/.git/objects/pack/*.pack >packs-after && + test_cmp packs-between packs-after +' + test_done -- gitgitgadget
