kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

submodule--helper: add "const" to passed "module_clone_data" 

Add "const" to the "struct module_clone_data" that we pass to
clone_submodule(), which makes the ownership clear, and stops us from
clobbering the "clone_data->path".

We still need to add to the "reference" member, which is a "struct
string_list". Let's do this by having clone_submodule() create its
own, and copy the contents over, allowing us to pass it as a
separate parameter.

This new "struct string_list" still leaks memory, just as the "struct
module_clone_data" did before. let's not fix that for now, to fix that
we'll need to add some "goto cleanup" to the relevant code. That will
eventually be done in follow-up commits, this change makes it easier
to fix the memory leak.

The scope of the new "reference" variable in add_submodule() could be
narrowed to the "else" block, but as we'll eventually free it with a
"goto cleanup" let's declare it at the start of the function.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Reviewed-by: Glen Choo <chooglen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Ævar Arnfjörð Bjarmason 2022-09-01 01:17:56 +02:00 committed by Junio C Hamano
parent 9bdf5277d5
commit 6fac5b2f35
1 changed files with 26 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
builtin/submodule--helper.c
View File

@ -1434,7 +1434,6 @@ struct module_clone_data {
const char *url; const char *url;
const char *depth; const char *depth;
struct list_objects_filter_options *filter_options; struct list_objects_filter_options *filter_options;
struct string_list reference;
unsigned int quiet: 1; unsigned int quiet: 1;
unsigned int progress: 1; unsigned int progress: 1;
unsigned int dissociate: 1; unsigned int dissociate: 1;
@ -1442,7 +1441,6 @@ struct module_clone_data {
int single_branch; int single_branch;
}; };
#define MODULE_CLONE_DATA_INIT { \ #define MODULE_CLONE_DATA_INIT { \
.reference = STRING_LIST_INIT_NODUP, \
.single_branch = -1, \ .single_branch = -1, \
} }


@ -1569,18 +1567,20 @@ static char *clone_submodule_sm_gitdir(const char *name)
return sm_gitdir; return sm_gitdir;
} }


static int clone_submodule(struct module_clone_data *clone_data) static int clone_submodule(const struct module_clone_data *clone_data,
struct string_list *reference)
{ {
char *p; char *p;
char *sm_gitdir = clone_submodule_sm_gitdir(clone_data->name); char *sm_gitdir = clone_submodule_sm_gitdir(clone_data->name);
char *sm_alternate = NULL, *error_strategy = NULL; char *sm_alternate = NULL, *error_strategy = NULL;
struct child_process cp = CHILD_PROCESS_INIT; struct child_process cp = CHILD_PROCESS_INIT;
const char *clone_data_path;


if (!is_absolute_path(clone_data->path)) if (!is_absolute_path(clone_data->path))
clone_data->path = xstrfmt("%s/%s", get_git_work_tree(), clone_data_path = xstrfmt("%s/%s", get_git_work_tree(),
clone_data->path); clone_data->path);
else else
clone_data->path = xstrdup(clone_data->path); clone_data_path = xstrdup(clone_data->path);


if (validate_submodule_git_dir(sm_gitdir, clone_data->name) < 0) if (validate_submodule_git_dir(sm_gitdir, clone_data->name) < 0)
die(_("refusing to create/use '%s' in another submodule's " die(_("refusing to create/use '%s' in another submodule's "
@ -1590,7 +1590,7 @@ static int clone_submodule(struct module_clone_data *clone_data)
if (safe_create_leading_directories_const(sm_gitdir) < 0) if (safe_create_leading_directories_const(sm_gitdir) < 0)
die(_("could not create directory '%s'"), sm_gitdir); die(_("could not create directory '%s'"), sm_gitdir);


prepare_possible_alternates(clone_data->name, &clone_data->reference); prepare_possible_alternates(clone_data->name, reference);


strvec_push(&cp.args, "clone"); strvec_push(&cp.args, "clone");
strvec_push(&cp.args, "--no-checkout"); strvec_push(&cp.args, "--no-checkout");
@ -1600,10 +1600,10 @@ static int clone_submodule(struct module_clone_data *clone_data)
strvec_push(&cp.args, "--progress"); strvec_push(&cp.args, "--progress");
if (clone_data->depth && *(clone_data->depth)) if (clone_data->depth && *(clone_data->depth))
strvec_pushl(&cp.args, "--depth", clone_data->depth, NULL); strvec_pushl(&cp.args, "--depth", clone_data->depth, NULL);
if (clone_data->reference.nr) { if (reference->nr) {
struct string_list_item *item; struct string_list_item *item;


for_each_string_list_item(item, &clone_data->reference) for_each_string_list_item(item, reference)
strvec_pushl(&cp.args, "--reference", strvec_pushl(&cp.args, "--reference",
item->string, NULL); item->string, NULL);
} }
@ -1622,7 +1622,7 @@ static int clone_submodule(struct module_clone_data *clone_data)


strvec_push(&cp.args, "--"); strvec_push(&cp.args, "--");
strvec_push(&cp.args, clone_data->url); strvec_push(&cp.args, clone_data->url);
strvec_push(&cp.args, clone_data->path); strvec_push(&cp.args, clone_data_path);


cp.git_cmd = 1; cp.git_cmd = 1;
prepare_submodule_repo_env(&cp.env); prepare_submodule_repo_env(&cp.env);
@ -1630,25 +1630,25 @@ static int clone_submodule(struct module_clone_data *clone_data)


if(run_command(&cp)) if(run_command(&cp))
die(_("clone of '%s' into submodule path '%s' failed"), die(_("clone of '%s' into submodule path '%s' failed"),
clone_data->url, clone_data->path); clone_data->url, clone_data_path);
} else { } else {
char *path; char *path;


if (clone_data->require_init && !access(clone_data->path, X_OK) && if (clone_data->require_init && !access(clone_data_path, X_OK) &&
!is_empty_dir(clone_data->path)) !is_empty_dir(clone_data_path))
die(_("directory not empty: '%s'"), clone_data->path); die(_("directory not empty: '%s'"), clone_data_path);
if (safe_create_leading_directories_const(clone_data->path) < 0) if (safe_create_leading_directories_const(clone_data_path) < 0)
die(_("could not create directory '%s'"), clone_data->path); die(_("could not create directory '%s'"), clone_data_path);
path = xstrfmt("%s/index", sm_gitdir); path = xstrfmt("%s/index", sm_gitdir);
unlink_or_warn(path); unlink_or_warn(path);
free(path); free(path);
} }


connect_work_tree_and_git_dir(clone_data->path, sm_gitdir, 0); connect_work_tree_and_git_dir(clone_data_path, sm_gitdir, 0);


p = git_pathdup_submodule(clone_data->path, "config"); p = git_pathdup_submodule(clone_data_path, "config");
if (!p) if (!p)
die(_("could not get submodule directory for '%s'"), clone_data->path); die(_("could not get submodule directory for '%s'"), clone_data_path);


/* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */ /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
git_config_get_string("submodule.alternateLocation", &sm_alternate); git_config_get_string("submodule.alternateLocation", &sm_alternate);
@ -1673,6 +1673,7 @@ static int module_clone(int argc, const char **argv, const char *prefix)
int dissociate = 0, quiet = 0, progress = 0, require_init = 0; int dissociate = 0, quiet = 0, progress = 0, require_init = 0;
struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT; struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT;
struct list_objects_filter_options filter_options = { 0 }; struct list_objects_filter_options filter_options = { 0 };
struct string_list reference = STRING_LIST_INIT_NODUP;
struct option module_clone_options[] = { struct option module_clone_options[] = {
OPT_STRING(0, "prefix", &clone_data.prefix, OPT_STRING(0, "prefix", &clone_data.prefix,
N_("path"), N_("path"),
@ -1686,7 +1687,7 @@ static int module_clone(int argc, const char **argv, const char *prefix)
OPT_STRING(0, "url", &clone_data.url, OPT_STRING(0, "url", &clone_data.url,
N_("string"), N_("string"),
N_("url where to clone the submodule from")), N_("url where to clone the submodule from")),
OPT_STRING_LIST(0, "reference", &clone_data.reference, OPT_STRING_LIST(0, "reference", &reference,
N_("repo"), N_("repo"),
N_("reference repository")), N_("reference repository")),
OPT_BOOL(0, "dissociate", &dissociate, OPT_BOOL(0, "dissociate", &dissociate,
@ -1725,7 +1726,7 @@ static int module_clone(int argc, const char **argv, const char *prefix)
usage_with_options(git_submodule_helper_usage, usage_with_options(git_submodule_helper_usage,
module_clone_options); module_clone_options);


clone_submodule(&clone_data); clone_submodule(&clone_data, &reference);
list_objects_filter_release(&filter_options); list_objects_filter_release(&filter_options);
return 0; return 0;
} }
@ -2913,6 +2914,7 @@ static int add_submodule(const struct add_data *add_data)
{ {
char *submod_gitdir_path; char *submod_gitdir_path;
struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT; struct module_clone_data clone_data = MODULE_CLONE_DATA_INIT;
struct string_list reference = STRING_LIST_INIT_NODUP;


/* perhaps the path already exists and is already a git repo, else clone it */ /* perhaps the path already exists and is already a git repo, else clone it */
if (is_directory(add_data->sm_path)) { if (is_directory(add_data->sm_path)) {
@ -2929,6 +2931,7 @@ static int add_submodule(const struct add_data *add_data)
free(submod_gitdir_path); free(submod_gitdir_path);
} else { } else {
struct child_process cp = CHILD_PROCESS_INIT; struct child_process cp = CHILD_PROCESS_INIT;

submod_gitdir_path = xstrfmt(".git/modules/%s", add_data->sm_name); submod_gitdir_path = xstrfmt(".git/modules/%s", add_data->sm_name);


if (is_directory(submod_gitdir_path)) { if (is_directory(submod_gitdir_path)) {
@ -2968,13 +2971,13 @@ static int add_submodule(const struct add_data *add_data)
clone_data.quiet = add_data->quiet; clone_data.quiet = add_data->quiet;
clone_data.progress = add_data->progress; clone_data.progress = add_data->progress;
if (add_data->reference_path) if (add_data->reference_path)
string_list_append(&clone_data.reference, string_list_append(&reference,
xstrdup(add_data->reference_path)); xstrdup(add_data->reference_path));
clone_data.dissociate = add_data->dissociate; clone_data.dissociate = add_data->dissociate;
if (add_data->depth >= 0) if (add_data->depth >= 0)
clone_data.depth = xstrfmt("%d", add_data->depth); clone_data.depth = xstrfmt("%d", add_data->depth);


if (clone_submodule(&clone_data)) if (clone_submodule(&clone_data, &reference))
return -1; return -1;


prepare_submodule_repo_env(&cp.env); prepare_submodule_repo_env(&cp.env);