@matheusbsbs / matheus-bagliano / commits / a52f07afcb

revisions API: have release_revisions() release "mailmap"

Extend the the release_revisions() function so that it frees the "mailmap" in the "struct rev_info". The log family of functions now calls the clear_mailmap() function added in fa8afd18e5a (revisions API: provide and use a release_revisions(), 2021-09-19), allowing us to whitelist some tests with "TEST_PASSES_SANITIZE_LEAK=true". Unfortunately having a pointer to a mailmap in "struct rev_info" instead of an embedded member that we "own" get a bit messy, as can be seen in the change to builtin/commit.c. When we free() this data we won't be able to tell apart a pointer to a "mailmap" on the heap from one on the stack. As seen in ea57bc0d41b (log: add --use-mailmap option, 2013-01-05) the "log" family allocates it on the heap, but in the find_author_by_nickname() code added in ea16794e430 (commit: search author pattern against mailmap, 2013-08-23) we allocated it on the stack instead. Ideally we'd simply change that member to a "struct string_list mailmap" and never free() the "mailmap" itself, but that would be a much larger change to the revisions API. We have code that needs to hand an existing "mailmap" to a "struct rev_info", while we could change all of that, let's not go there now. The complexity isn't in the ownership of the "mailmap" per-se, but that various things assume a "rev_info.mailmap == NULL" means "doesn't want mailmap", if we changed that to an init'd "struct string_list we'd need to carefully refactor things to change those assumptions. Let's instead always free() it, and simply declare that if you add such a "mailmap" it must be allocated on the heap. Any modern libc will correctly panic if we free() a stack variable, so this should be safe going forward. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Apr 13, 2022 at 22:01 UTC a52f07afcb02b2e09702d54118527fbb9d640895

7 files changed +16 -3

builtin/commit.c

+2 -3

@@ -1100,7 +1100,6 @@ static const char *find_author_by_nickname(const char *name)

1100 struct rev_info revs;

1101 struct commit *commit;

1102 struct strbuf buf = STRBUF_INIT;

1103 - struct string_list mailmap = STRING_LIST_INIT_NODUP;

1103 const char *av[20];

1104 int ac = 0;

1105

@@ -1111,7 +1110,8 @@ static const char *find_author_by_nickname(const char *name)

1110 av[++ac] = buf.buf;

1111 av[++ac] = NULL;

1112 setup_revisions(ac, av, &revs, NULL);

1114 - revs.mailmap = &mailmap;

1113 + revs.mailmap = xmalloc(sizeof(struct string_list));

1114 + string_list_init_nodup(revs.mailmap);

1115 read_mailmap(revs.mailmap);

1116

1117 if (prepare_revision_walk(&revs))

@@ -1122,7 +1122,6 @@ static const char *find_author_by_nickname(const char *name)

1122 ctx.date_mode.type = DATE_NORMAL;

1123 strbuf_release(&buf);

1124 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);

1125 - clear_mailmap(&mailmap);

1125 release_revisions(&revs);

1126 return strbuf_detach(&buf, NULL);

1127 }

revision.c

@@ -2926,10 +2926,19 @@ int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct s

2926 return left;

2927 }

2928

2929 +static void release_revisions_mailmap(struct string_list *mailmap)

2930 +{

2931 + if (!mailmap)

2932 + return;

2933 + clear_mailmap(mailmap);

2934 + free(mailmap);

2935 +}

2936 +

2937 void release_revisions(struct rev_info *revs)

2938 {

2939 free_commit_list(revs->commits);

2940 object_array_clear(&revs->pending);

2941 + release_revisions_mailmap(revs->mailmap);

2942 }

2943

2944 static void add_child(struct rev_info *revs, struct commit *parent, struct commit *child)

t/t0056-git-C.sh

@@ -2,6 +2,7 @@

3 test_description='"-C <path>" option and its effects on other path-related options'

5 +TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

8 test_expect_success '"git -C <path>" runs git from the directory <path>' '

t/t3302-notes-index-expensive.sh

@@ -8,6 +8,7 @@ test_description='Test commit notes index (expensive!)'

8 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main

9 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME

11 +TEST_PASSES_SANITIZE_LEAK=true

12 . ./test-lib.sh

14 create_repo () {

t/t4055-diff-context.sh

@@ -5,6 +5,7 @@

6 test_description='diff.context configuration'

8 +TEST_PASSES_SANITIZE_LEAK=true

9 . ./test-lib.sh

11 test_expect_success 'setup' '

t/t4066-diff-emit-delay.sh

@@ -4,6 +4,7 @@ test_description='test combined/stat/moved interaction'

4 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main

5 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME

7 +TEST_PASSES_SANITIZE_LEAK=true

8 . ./test-lib.sh

10 # This test covers a weird 3-way interaction between "--cc -p", which will run

t/t7008-filter-branch-null-sha1.sh

@@ -1,6 +1,7 @@

1 #!/bin/sh

3 test_description='filter-branch removal of trees with null sha1'

4 +

5 . ./test-lib.sh

7 test_expect_success 'setup: base commits' '