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

[PATCH v2 1/1] maintenance: fix SEGFAULT when no repository

From
Rafael Silva <rafaeloliveira.cs@gmail.com>
Date
Nov 26, 2020, 20:41 UTC
Message-ID
<20201126204141.1438-2-rafaeloliveira.cs@gmail.com>
In-Reply-To
<20201126204141.1438-1-rafaeloliveira.cs@gmail.com>

The "git maintenance run" and "git maintenance start/stop" commands holds a file-based lock at the .git/maintenance.lock and .git/schedule.lock respectively. These locks are used to ensure only one maintenance process is executed at the time as both operations involves writing data into the git repository.

The path to the lock file is built using "the_repository->objects->odb->path" that results in SEGFAULT when we have no repository available as "the_repository->objects->odb" is set to NULL.

Let's teach maintenance command to use RUN_SETUP option that will provide the validation and fail when running outside of a repository. Hence fixing the SEGFAULT for all three operations and making the behaviour consistent across all subcommands.

Setting the RUN_SETUP also provides the same protection for all subcommands given that the "register" and "unregister" also requires to be executed inside a repository.

Furthermore let's remove the local validation implemented by the "register" and "unregister" as this will not be required anymore with the new option.

Signed-off-by: Rafael Silva <rafaeloliveira.cs@gmail.com>
---
 builtin/gc.c           | 7 -------
 git.c                  | 2 +-
 t/t7900-maintenance.sh | 8 ++++++++
 3 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/builtin/gc.c b/builtin/gc.c
index bc25ad52c7..ebb0158308 100644
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -1446,10 +1446,6 @@ static int maintenance_register(void)
 	struct child_process config_set = CHILD_PROCESS_INIT;
 	struct child_process config_get = CHILD_PROCESS_INIT;
 
-	/* There is no current repository, so skip registering it */
-	if (!the_repository || !the_repository->gitdir)
-		return 0;
-
 	/* Disable foreground maintenance */
 	git_config_set("maintenance.auto", "false");
 
@@ -1486,9 +1482,6 @@ static int maintenance_unregister(void)
 {
 	struct child_process config_unset = CHILD_PROCESS_INIT;
 
-	if (!the_repository || !the_repository->gitdir)
-		return error(_("no current repository to unregister"));
-
 	config_unset.git_cmd = 1;
 	strvec_pushl(&config_unset.args, "config", "--global", "--unset",
 		     "maintenance.repo",
diff --git a/git.c b/git.c
index 4b7bd77b80..a00a0a4d94 100644
--- a/git.c
+++ b/git.c
@@ -535,7 +535,7 @@ static struct cmd_struct commands[] = {
 	{ "ls-tree", cmd_ls_tree, RUN_SETUP },
 	{ "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY | NO_PARSEOPT },
 	{ "mailsplit", cmd_mailsplit, NO_PARSEOPT },
-	{ "maintenance", cmd_maintenance, RUN_SETUP_GENTLY | NO_PARSEOPT },
+	{ "maintenance", cmd_maintenance, RUN_SETUP | NO_PARSEOPT },
 	{ "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
 	{ "merge-base", cmd_merge_base, RUN_SETUP },
 	{ "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
diff --git a/t/t7900-maintenance.sh b/t/t7900-maintenance.sh
index d9e68bb2bf..ae5c29b0ff 100755
--- a/t/t7900-maintenance.sh
+++ b/t/t7900-maintenance.sh
@@ -441,4 +441,12 @@ test_expect_success 'register preserves existing strategy' '
 	test_config maintenance.strategy incremental
 '
 
+test_execpt_success 'fails when running outside of a repository' '
+	nongit test_must_fail git maintenance run &&
+	nongit test_must_fail git maintenance stop &&
+	nongit test_must_fail git maintenance start &&
+	nongit test_must_fail git maintenance register &&
+	nongit test_must_fail git maintenance unregister
+'
+
 test_done
-- 
2.29.2.367.g37477fb670
Previous: Rafael SilvaNext: Derrick Stolee
Message 15 of 22 in “maintenance: Fix a SEGFAULT when no repository when running git maintenance run/start”
  1. 0/1 maintenance: Fix a SEGFAULT when no repository when running git maintenance run/startRafael Silva, Nov 24, 2020
  2. 1/1 maintenance: fix a SEGFAULT when no repositoryRafael Silva, Nov 24, 2020
  3. Derrick StoleeNov 24, 2020
  4. Junio C HamanoNov 24, 2020
  5. Derrick StoleeNov 24, 2020
  6. Rafael SilvaNov 26, 2020
  7. Derrick StoleeNov 26, 2020
  8. Eric SunshineNov 24, 2020
  9. SZEDER GáborNov 24, 2020
  10. Eric SunshineNov 24, 2020
  11. Rafael SilvaNov 26, 2020
  12. Martin ÅgrenNov 24, 2020
  13. Rafael SilvaNov 26, 2020
  14. 0/1 maintenance: Fix SEGFAULT when running outside of a repositoryRafael Silva, Nov 26, 2020
  15. 1/1 maintenance: fix SEGFAULT when no repositoryRafael Silva, Nov 26, 2020
  16. Derrick StoleeNov 27, 2020
  17. Josh SteadmonDec 8, 2020
  18. Junio C HamanoDec 8, 2020
  19. Junio C HamanoDec 8, 2020
  20. Christian CouderDec 24, 2020
  21. Junio C HamanoDec 24, 2020
  22. Rafael SilvaDec 9, 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.