Revert "builtin/bundle.c: let parse-options parse subcommands"
PATCH 1/1 Revert "builtin/bundle.c: let parse-options parse subcommands"
This reverts commit aef7d75e5809eda765bbe407c7f8e0f8617f0fd0.
The change breaks git bundle command. Running any subcommand results with:
$ git bundle create Segmentation fault (core dumped)
After reverting the change, everything works correctly.
--- builtin/bundle.c | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-)
builtin/bundle.c +18 -7
@@ -206,19 +206,30 @@ static int cmd_bundle_unbundle(int argc, const char **argv, const char *prefix)int cmd_bundle (int argc,const char **argv,const char *prefix) { -parse_opt_subcommand_fn *fn =NULL ;struct option options[] = { -OPT_SUBCOMMAND ("create" , &fn, cmd_bundle_create), -OPT_SUBCOMMAND ("verify" , &fn, cmd_bundle_verify), -OPT_SUBCOMMAND ("list-heads" , &fn, cmd_bundle_list_heads), -OPT_SUBCOMMAND ("unbundle" , &fn, cmd_bundle_unbundle),OPT_END () }; +int result; argc =parse_options (argc, argv, prefix, options, builtin_bundle_usage, -0 ); +PARSE_OPT_STOP_AT_NON_OPTION );packet_trace_identity ("bundle" ); -return !!fn (argc, argv, prefix); +if (argc <2 ) +usage_with_options (builtin_bundle_usage, options); + +else if (!strcmp (argv[0 ],"create" )) + result =cmd_bundle_create (argc, argv, prefix); +else if (!strcmp (argv[0 ],"verify" )) + result =cmd_bundle_verify (argc, argv, prefix); +else if (!strcmp (argv[0 ],"list-heads" )) + result =cmd_bundle_list_heads (argc, argv, prefix); +else if (!strcmp (argv[0 ],"unbundle" )) + result =cmd_bundle_unbundle (argc, argv, prefix); +else { +error (_ ("Unknown subcommand: %s" ), argv[0 ]); +usage_with_options (builtin_bundle_usage, options); + } +return result ?1 :0 ; }
Signature · 1 line
2.38.1
Quoted 7 lines · Hubert Jasudowicz
This reverts commit
aef7d75e5809eda765bbe407c7f8e0f8617f0fd0.The change breaks git bundle command. Running any subcommand results with:
$ git bundle create Segmentation fault (core dumped)
Could you be more specific? We have tests that verify that these commands work without a segfault. There must be something different about your environment that makes the segfault occur.
One thing that I could believe is that you are running 'git bundle create' outside of a Git repository, and I doubt we have tests covering that scenario.
Before reverting this change that has been out in two releases, I recommend adding a test that demonstrates your failure and then doing a specific update to fix that scenario.
Thanks,
-Stolee
Quoted 10 lines · Derrick Stolee
Quoted 7 lines · Hubert Jasudowicz
This reverts commit
aef7d75e5809eda765bbe407c7f8e0f8617f0fd0.The change breaks git bundle command. Running any subcommand results with:
$ git bundle create Segmentation fault (core dumped)Could you be more specific?
I don't think the report can get more specific than (quoting it):
$ git bundle create Segmentation fault (core dumped)
:) Did you try running it?
Quoted 3 lines
We have tests that verify that
these commands work without a segfault. There must be something different about your environment that makes the segfault occur.
We don't have those tests, I submitted an alternate smaller fix in
https://lore.kernel.org/git/[email protected]/
that adds some.
I think what you're misrecalling here is probably that we have general tests for running "git <cmd> -h" for all built-in <cmd>, but we don't have any such tests for running sub-commands.
And even then, that wouldn't catch this, as it's a bespoke segfault in the bundle code, as it can't handle not getting at least one non-option argument.
PATCH 1/1 bundle: don't segfault on "git bundle <subcmd>"
In reply to Hubert JasudowiczSince aef7d75e580 (builtin/bundle.c: let parse-options parse subcommands, 2022-08-19) we've been segfaulting if no argument was provided.
The fix is easy, as all of the "git bundle" subcommands require a non-option argument we can check that we have arguments left after calling parse-options().
This makes use of code added in 73c3253d75e (bundle: framework for options before bundle file, 2019-11-10), before this change that code has always been unreachable. In 73c3253d75e we'd never reach it as we already checked "argc < 2" in cmd_bundle() itself.
Then when aef7d75e580 (whose segfault we're fixing here) migrated this code to the subcommand API it removed that "argc < 2" check, but we were still checking the wrong "argc" in parse_options_cmd_bundle(), we need to check the "newargc". The "argc" will always be >= 1, as it will necessarily contain at least the subcommand name itself (e.g. "create").
As an aside, this could be safely squashed into this, but let's not do that for this minimal segfault fix, as it's an unrelated refactoring:
--- a/builtin/bundle.c
+++ b/builtin/bundle.c
@@ -55,13 +55,12 @@ static int parse_options_cmd_bundle(int argc,
const char * const usagestr[],
const struct option options[],
char **bundle_file) {
- int newargc;
- newargc = parse_options(argc, argv, NULL, options, usagestr,
+ argc = parse_options(argc, argv, NULL, options, usagestr,
PARSE_OPT_STOP_AT_NON_OPTION);
- if (!newargc)
+ if (!argc)
usage_with_options(usagestr, options);
*bundle_file = prefix_filename(prefix, argv[0]);
- return newargc;
+ return argc;
}
static int cmd_bundle_create(int argc, const char **argv, const char *prefix) {---
A proposed replacement for
https://lore.kernel.org/git/[email protected]/;
let's move forward & add a test rather than reverting away from the subcommand APIe
builtin/bundle.c | 2 +- t/t6020-bundle-misc.sh | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-)
builtin/bundle.c +1 -1
@@ -58,7 +58,7 @@ static int parse_options_cmd_bundle(int argc,int newargc; newargc =parse_options (argc, argv,NULL , options, usagestr,PARSE_OPT_STOP_AT_NON_OPTION ); -if (argc <1 ) +if (!newargc)usage_with_options (usagestr, options); *bundle_file =prefix_filename (prefix, argv[0 ]);return newargc;
t/t6020-bundle-misc.sh +7 -0
@@ -11,6 +11,13 @@ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME . ./test-lib.sh . "$TEST_DIRECTORY"/lib-bundle.sh +for cmd in create verify list-heads unbundle +do + test_expect_success "usage: git bundle $cmd needs an argument" ' + test_expect_code 129 git bundle $cmd + ' +done + # Create a commit or tag and set the variable with the object ID. test_commit_setvar () { notick=
Signature · 1 line
2.39.0.1106.g08bce9674be
Re: [PATCH] bundle: don't segfault on "git bundle <subcmd>"
On 12/20/22 14:40, Ævar Arnfjörð Bjarmason wrote:> A proposed replacement for
Quoted 29 lines
https://lore.kernel.org/git/[email protected]/;
let's move forward & add a test rather than reverting away from the subcommand APIebuiltin/bundle.c | 2 +- t/t6020-bundle-misc.sh | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-)builtin/bundle.c +1
-1@@ -58,7 +58,7 @@ static int parse_options_cmd_bundle(int argc,int newargc; newargc =parse_options (argc, argv,NULL , options, usagestr,PARSE_OPT_STOP_AT_NON_OPTION ); -if (argc <1 ) +if (!newargc)usage_with_options (usagestr, options); *bundle_file =prefix_filename (prefix, argv[0 ]);return newargc;t/t6020-bundle-misc.sh +0
-0@@ -11,6 +11,13 @@ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME . ./test-lib.sh . "$TEST_DIRECTORY"/lib-bundle.sh
t/t6020-bundle-misc.sh export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME · line 23
Quoted 10 lines
t/t6020-bundle-misc.sh +7
-0+for cmd in create verify list-heads unbundle +do + test_expect_success "usage: git bundle $cmd needs an argument" ' + test_expect_code 129 git bundle $cmd + ' +done + # Create a commit or tag and set the variable with the object ID. test_commit_setvar () { notick=
Seems to work. Thanks!
Hubert Jasudowicz
Re: [PATCH] bundle: don't segfault on "git bundle <subcmd>"
Quoted 5 lines · Hubert Jasudowicz
Seems to work. Thanks!
Tested-by Hubert Jasudowicz <[email protected]>Hubert Jasudowicz
Thanks for reporting and testing.
Re: [PATCH] bundle: don't segfault on "git bundle <subcmd>"
In reply to Ævar Arnfjörð BjarmasonQuoted 12 lines · Ævar Arnfjörð Bjarmason
As an aside, this could be safely squashed into this, but let's not do that for this minimal segfault fix, as it's an unrelated refactoring:
--- a/builtin/bundle.c +++ b/builtin/bundle.c @@ -55,13 +55,12 @@ static int parse_options_cmd_bundle(int argc, const char * const usagestr[], const struct option options[], char **bundle_file) { - int newargc; - newargc = parse_options(argc, argv, NULL, options, usagestr, + argc = parse_options(argc, argv, NULL, options, usagestr,
Quoted 8 lines
PARSE_OPT_STOP_AT_NON_OPTION); - if (!newargc) + if (!argc) usage_with_options(usagestr, options); *bundle_file = prefix_filename(prefix, argv[0]); - return newargc; + return argc; }
That would actually make the intent much clearer and if the code were written to update argc instead of introducing a separate varilable, this bug would not have happened.
Thanks, will queue (without the clean-up at least for now).
cover builtin/bundle.c: segfault fix style & error reporting follow-up
Quoted 3 lines · Junio C Hamano
That would actually make the intent much clearer and if the code were written to update argc instead of introducing a separate varilable, this bug would not have happened.
Here's a couple of general improvements on top of ab/bundle-wo-args, we should also report to the user that they were missing the <file> argument, as 2/2 here fixes.
Ævar Arnfjörð Bjarmason (2):
builtin/bundle.c: remove superfluous "newargc" variable bundle <cmd>: have usage_msg_opt() note the missing "<file>"
builtin/bundle.c | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)
Signature · 1 line
2.39.0.1106.gf45ba805d1a
PATCH 1/2 builtin/bundle.c: remove superfluous "newargc" variable
As noted in 891cb09db6c (bundle: don't segfault on "git bundle <subcmd>", 2022-12-20) the "newargc" in this function is redundant to using our own "argc". Let's refactor the function to avoid needlessly introducing another variable.
--- builtin/bundle.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
builtin/bundle.c +3 -4
@@ -55,13 +55,12 @@ static int parse_options_cmd_bundle(int argc,const char *const usagestr[], const struct option options[], char **bundle_file) { - int newargc; - newargc =parse_options (argc, argv,NULL , options, usagestr, + argc =parse_options (argc, argv,NULL , options, usagestr,PARSE_OPT_STOP_AT_NON_OPTION ); -if (!newargc) +if (!argc)usage_with_options (usagestr, options); *bundle_file =prefix_filename (prefix, argv[0 ]); -return newargc; +return argc; }static int cmd_bundle_create (int argc,const char **argv,const char *prefix) {
Signature · 1 line
2.39.0.1106.gf45ba805d1a
PATCH 2/2 bundle <cmd>: have usage_msg_opt() note the missing "<file>"
In reply to Ævar Arnfjörð BjarmasonImprove the usage we emit on e.g. "git bundle create" to note why we're showing the usage, it's because the "<file>" argument is missing.
We know that'll be the case for all parse_options_cmd_bundle() users, as they're passing the "char **bundle_file" parameter, which as the context shows we're expected to populate.
--- builtin/bundle.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
builtin/bundle.c +1 -1
@@ -58,7 +58,7 @@ static int parse_options_cmd_bundle(int argc, argc =parse_options (argc, argv,NULL , options, usagestr,PARSE_OPT_STOP_AT_NON_OPTION );if (!argc) -usage_with_options (usagestr, options); +usage_msg_opt (_ ("need a <file> argument" ), usagestr, options); *bundle_file =prefix_filename (prefix, argv[0 ]);return argc; }
Signature · 1 line
2.39.0.1106.gf45ba805d1a
Re: [PATCH 0/2] builtin/bundle.c: segfault fix style & error reporting follow-up
In reply to Ævar Arnfjörð BjarmasonQuoted 10 lines · Ævar Arnfjörð Bjarmason
Here's a couple of general improvements on top of ab/bundle-wo-args, we should also report to the user that they were missing the <file> argument, as 2/2 here fixes.
Ævar Arnfjörð Bjarmason (2):
builtin/bundle.c: remove superfluous "newargc" variable bundle <cmd>: haveusage_msg_opt()note the missing "<file>"builtin/bundle.c | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)
I have no strong opinions on the second one, but the first one is a definite improvement. Will queue both. Thanks.