date API: add and use a date_mode_release()

Fix a memory leak in the parse_date_format() function by providing a new date_mode_release() companion function. By using this in "t/helper/test-date.c" we can mark the "t0006-date.sh" test as passing when git is compiled with SANITIZE=leak, and whitelist it to run under "GIT_TEST_PASSING_SANITIZE_LEAK=true" by adding "TEST_PASSES_SANITIZE_LEAK=true" to the test itself. The other tests that expose this memory leak (i.e. take the "mode->type == DATE_STRFTIME" branch in parse_date_format()) are "t6300-for-each-ref.sh" and "t7004-tag.sh". The former is due to an easily fixed leak in "ref-filter.c", and brings the failures in "t6300-for-each-ref.sh" down from 51 to 48. Fixing the remaining leaks will have to wait until there's a release_revisions() in "revision.c", as they have to do with leaks via "struct rev_info". There is also a leak in "builtin/blame.c" due to its call to parse_date_format() to parse the "blame.date" configuration. However as it declares a file-level "static struct date_mode blame_date_mode" to track the data, LSAN will not report it as a leak. It's possible to get valgrind(1) to complain about it with e.g.: valgrind --leak-check=full --show-leak-kinds=all ./git -P -c blame.date=format:%Y blame README.md But let's focus on things LSAN complains about, and are thus observable with "TEST_PASSES_SANITIZE_LEAK=true". We should get to fixing memory leaks in "builtin/blame.c", but as doing so would require some re-arrangement of cmd_blame() let's leave it for some other time. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Feb 16, 2022 at 09:14 UTC 974c919d36d944e9005def346fb363d8a83399f7
5 files changed +18 -1
date.c
+5
@@ -993,6 +993,11 @@ void parse_date_format(const char *format, struct date_mode *mode)
993 die("unknown date format %s", format);
994 }
995
996 +void date_mode_release(struct date_mode *mode)
997 +{
998 + free((char *)mode->strftime_fmt);
999 +}
1000 +
1001 void datestamp(struct strbuf *out)
1002 {
1003 time_t now;
date.h
+8 -1
@@ -50,10 +50,17 @@ const char *show_date(timestamp_t time, int timezone, const struct date_mode *mo
50 *
51 * When the "date_mode_type" is DATE_STRFTIME the "strftime_fmt"
52 * member of "struct date_mode" will be a malloc()'d format string to
53 - * be used with strbuf_addftime().
53 + * be used with strbuf_addftime(), in which case you'll need to call
54 + * date_mode_release() later.
55 */
56 void parse_date_format(const char *format, struct date_mode *mode);
57
58 +/**
59 + * Release a "struct date_mode", currently only required if
60 + * parse_date_format() has parsed a "DATE_STRFTIME" format.
61 + */
62 +void date_mode_release(struct date_mode *mode);
63 +
64 void show_date_relative(timestamp_t time, struct strbuf *timebuf);
65 int parse_date(const char *date, struct strbuf *out);
66 int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
ref-filter.c
+1
@@ -1276,6 +1276,7 @@ static void grab_date(const char *buf, struct atom_value *v, const char *atomnam
1276 goto bad;
1277 v->s = xstrdup(show_date(timestamp, tz, &date_mode));
1278 v->value = timestamp;
1279 + date_mode_release(&date_mode);
1280 return;
1281 bad:
1282 v->s = xstrdup("");
t/helper/test-date.c
+2
@@ -54,6 +54,8 @@ static void show_dates(const char **argv, const char *format)
54
55 printf("%s -> %s\n", *argv, show_date(t, tz, &mode));
56 }
57 +
58 + date_mode_release(&mode);
59 }
60
61 static void parse_dates(const char **argv)
t/t0006-date.sh
+2
@@ -1,6 +1,8 @@
1 #!/bin/sh
2
3 test_description='test date parsing and printing'
4 +
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 # arbitrary reference time: 2009-08-30 19:20:00