development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-11-04 16:17:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

checkout: clarify memory ownership in unique_tracking_name()

Browse source 
The function `unique_tracking_name()` returns an allocated string, but
does not clearly indicate this because its return type is `const char *`
instead of `char *`. This has led to various callsites where we never
free its returned memory at all, which causes memory leaks.

Plug those leaks and mark now-passing tests as leak free.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Patrick Steinhardt 2024-05-27 13:46:06 +02:00 committed by Junio C Hamano
parent 94e2aa555e
commit cc395d6b47
14 changed files with 34 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
builtin/checkout.c
View file

@ -1275,12 +1275,12 @@ static void setup_new_branch_info_and_source_tree(
} }
} }
static const char *parse_remote_branch(const char *arg, static char *parse_remote_branch(const char *arg,
struct object_id *rev, struct object_id *rev,
int could_be_checkout_paths) int could_be_checkout_paths)
{ {
int num_matches = 0; int num_matches = 0;
const char *remote = unique_tracking_name(arg, rev, &num_matches); char *remote = unique_tracking_name(arg, rev, &num_matches);
if (remote && could_be_checkout_paths) { if (remote && could_be_checkout_paths) {
die(_("'%s' could be both a local file and a tracking branch.\n" die(_("'%s' could be both a local file and a tracking branch.\n"
@ -1316,6 +1316,7 @@ static int parse_branchname_arg(int argc, const char **argv,
const char **new_branch = &opts->new_branch; const char **new_branch = &opts->new_branch;
int argcount = 0; int argcount = 0;
const char *arg; const char *arg;
char *remote = NULL;
int dash_dash_pos; int dash_dash_pos;
int has_dash_dash = 0; int has_dash_dash = 0;
int i; int i;
@ -1416,8 +1417,8 @@ static int parse_branchname_arg(int argc, const char **argv,
recover_with_dwim = 0; recover_with_dwim = 0;
if (recover_with_dwim) { if (recover_with_dwim) {
const char *remote = parse_remote_branch(arg, rev, remote = parse_remote_branch(arg, rev,
could_be_checkout_paths); could_be_checkout_paths);
if (remote) { if (remote) {
*new_branch = arg; *new_branch = arg;
arg = remote; arg = remote;
@ -1459,6 +1460,7 @@ static int parse_branchname_arg(int argc, const char **argv,
argc--; argc--;
} }
free(remote);
return argcount; return argcount;
} }

20
builtin/worktree.c
View file

@ -736,16 +736,14 @@ static int dwim_orphan(const struct add_opts *opts, int opt_track, int remote)
return 1; return 1;
} }
static const char *dwim_branch(const char *path, const char **new_branch) static char *dwim_branch(const char *path, char **new_branch)
{ {
int n; int n;
int branch_exists; int branch_exists;
const char *s = worktree_basename(path, &n); const char *s = worktree_basename(path, &n);
const char *branchname = xstrndup(s, n); char *branchname = xstrndup(s, n);
struct strbuf ref = STRBUF_INIT; struct strbuf ref = STRBUF_INIT;
UNLEAK(branchname);
branch_exists = !strbuf_check_branch_ref(&ref, branchname) && branch_exists = !strbuf_check_branch_ref(&ref, branchname) &&
refs_ref_exists(get_main_ref_store(the_repository), refs_ref_exists(get_main_ref_store(the_repository),
ref.buf); ref.buf);
@ -756,8 +754,7 @@ static const char *dwim_branch(const char *path, const char **new_branch)
*new_branch = branchname; *new_branch = branchname;
if (guess_remote) { if (guess_remote) {
struct object_id oid; struct object_id oid;
const char *remote = char *remote = unique_tracking_name(*new_branch, &oid, NULL);
unique_tracking_name(*new_branch, &oid, NULL);
return remote; return remote;
} }
return NULL; return NULL;
@ -769,6 +766,8 @@ static int add(int ac, const char **av, const char *prefix)
const char *new_branch_force = NULL; const char *new_branch_force = NULL;
char *path; char *path;
const char *branch; const char *branch;
char *branch_to_free = NULL;
char *new_branch_to_free = NULL;
const char *new_branch = NULL; const char *new_branch = NULL;
const char *opt_track = NULL; const char *opt_track = NULL;
const char *lock_reason = NULL; const char *lock_reason = NULL;
@ -859,16 +858,17 @@ static int add(int ac, const char **av, const char *prefix)
opts.orphan = dwim_orphan(&opts, !!opt_track, 0); opts.orphan = dwim_orphan(&opts, !!opt_track, 0);
} else if (ac < 2) { } else if (ac < 2) {
/* DWIM: Guess branch name from path. */ /* DWIM: Guess branch name from path. */
const char *s = dwim_branch(path, &new_branch); char *s = dwim_branch(path, &new_branch_to_free);
if (s) if (s)
branch = s; branch = branch_to_free = s;
new_branch = new_branch_to_free;
/* DWIM: Infer --orphan when repo has no refs. */ /* DWIM: Infer --orphan when repo has no refs. */
opts.orphan = (!s) && dwim_orphan(&opts, !!opt_track, 1); opts.orphan = (!s) && dwim_orphan(&opts, !!opt_track, 1);
} else if (ac == 2) { } else if (ac == 2) {
struct object_id oid; struct object_id oid;
struct commit *commit; struct commit *commit;
const char *remote; char *remote;
commit = lookup_commit_reference_by_name(branch); commit = lookup_commit_reference_by_name(branch);
if (!commit) { if (!commit) {
@ -923,6 +923,8 @@ static int add(int ac, const char **av, const char *prefix)
ret = add_worktree(path, branch, &opts); ret = add_worktree(path, branch, &opts);
free(path); free(path);
free(branch_to_free);
free(new_branch_to_free);
return ret; return ret;
} }

4
checkout.c
View file

@ -45,8 +45,8 @@ static int check_tracking_name(struct remote *remote, void *cb_data)
return 0; return 0;
} }
const char *unique_tracking_name(const char *name, struct object_id *oid, char *unique_tracking_name(const char *name, struct object_id *oid,
int *dwim_remotes_matched) int *dwim_remotes_matched)
{ {
struct tracking_name_data cb_data = TRACKING_NAME_DATA_INIT; struct tracking_name_data cb_data = TRACKING_NAME_DATA_INIT;
const char *default_remote = NULL; const char *default_remote = NULL;

6
checkout.h
View file

@ -8,8 +8,8 @@
* tracking branch. Return the name of the remote if such a branch * tracking branch. Return the name of the remote if such a branch
* exists, NULL otherwise. * exists, NULL otherwise.
*/ */
const char *unique_tracking_name(const char *name, char *unique_tracking_name(const char *name,
struct object_id *oid, struct object_id *oid,
int *dwim_remotes_matched); int *dwim_remotes_matched);
#endif /* CHECKOUT_H */ #endif /* CHECKOUT_H */

1
t/t2024-checkout-dwim.sh
View file

@ -4,6 +4,7 @@ test_description='checkout <branch>
Ensures that checkout on an unborn branch does what the user expects' Ensures that checkout on an unborn branch does what the user expects'
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
# Is the current branch "refs/heads/$1"? # Is the current branch "refs/heads/$1"?

1
t/t2060-switch.sh
View file

@ -5,6 +5,7 @@ test_description='switch basic functionality'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
test_expect_success 'setup' ' test_expect_success 'setup' '

1
t/t3426-rebase-submodule.sh
View file

@ -2,6 +2,7 @@
test_description='rebase can handle submodules' test_description='rebase can handle submodules'
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
. "$TEST_DIRECTORY"/lib-submodule-update.sh . "$TEST_DIRECTORY"/lib-submodule-update.sh
. "$TEST_DIRECTORY"/lib-rebase.sh . "$TEST_DIRECTORY"/lib-rebase.sh

1
t/t3512-cherry-pick-submodule.sh
View file

@ -5,6 +5,7 @@ test_description='cherry-pick can handle submodules'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
. "$TEST_DIRECTORY"/lib-submodule-update.sh . "$TEST_DIRECTORY"/lib-submodule-update.sh

1
t/t3513-revert-submodule.sh
View file

@ -2,6 +2,7 @@
test_description='revert can handle submodules' test_description='revert can handle submodules'
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
. "$TEST_DIRECTORY"/lib-submodule-update.sh . "$TEST_DIRECTORY"/lib-submodule-update.sh

1
t/t3600-rm.sh
View file

@ -8,6 +8,7 @@ test_description='Test of the various options to git rm.'
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
# Setup some files to be removed, some with funny characters # Setup some files to be removed, some with funny characters

1
t/t3906-stash-submodule.sh
View file

@ -2,6 +2,7 @@
test_description='stash can handle submodules' test_description='stash can handle submodules'
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
. "$TEST_DIRECTORY"/lib-submodule-update.sh . "$TEST_DIRECTORY"/lib-submodule-update.sh

1
t/t4137-apply-submodule.sh
View file

@ -2,6 +2,7 @@
test_description='git apply handling submodules' test_description='git apply handling submodules'
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
. "$TEST_DIRECTORY"/lib-submodule-update.sh . "$TEST_DIRECTORY"/lib-submodule-update.sh

1
t/t6041-bisect-submodule.sh
View file

@ -2,6 +2,7 @@
test_description='bisect can handle submodules' test_description='bisect can handle submodules'
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
. "$TEST_DIRECTORY"/lib-submodule-update.sh . "$TEST_DIRECTORY"/lib-submodule-update.sh

1
t/t6438-submodule-directory-file-conflicts.sh
View file

@ -2,6 +2,7 @@
test_description='merge can handle submodules' test_description='merge can handle submodules'
TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh . ./test-lib.sh
. "$TEST_DIRECTORY"/lib-submodule-update.sh . "$TEST_DIRECTORY"/lib-submodule-update.sh