commit: discard partial cache before (re-)reading it

The read_cache() in prepare_to_commit() would end up clobbering the pointer we had for a previously populated "the_index.cache_tree" in the very common case of "git commit" stressed by e.g. the tests being changed here. We'd populate "the_index.cache_tree" by calling "update_main_cache_tree" in prepare_index(), but would not end up with a "fully prepared" index. What constitutes an existing index is clearly overly fuzzy, here we'll check "active_nr" (aka "the_index.cache_nr"), but our "the_index.cache_tree" might have been malloc()'d already. Thus the code added in 11c8a74a64a (commit: write cache-tree data when writing index anyway, 2011-12-06) would end up allocating the "cache_tree", and would interact here with code added in 7168624c353 (Do not generate full commit log message if it is not going to be used, 2007-11-28). The result was a very common memory leak. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Taylor Blau <me@ttaylorr.com>

Ævar Arnfjörð Bjarmason committed Nov 8, 2022 at 19:17 UTC 03267e8656c23cf1e2d1df8204d4cee236fb0077
19 files changed +29 -2
builtin/commit.c
+5 -2
@@ -987,8 +987,11 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
987 struct object_id oid;
988 const char *parent = "HEAD";
989
990 - if (!active_nr && read_cache() < 0)
991 - die(_("Cannot read index"));
990 + if (!active_nr) {
991 + discard_cache();
992 + if (read_cache() < 0)
993 + die(_("Cannot read index"));
994 + }
995
996 if (amend)
997 parent = "HEAD^1";
t/t0068-for-each-repo.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='git for-each-repo builtin'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success 'run based on configured value' '
t/t0070-fundamental.sh
+1
@@ -6,6 +6,7 @@ test_description='check that the most basic functions work
6 Verify wrappers and compatibility functions.
7 '
8
9 +TEST_PASSES_SANITIZE_LEAK=true
10 . ./test-lib.sh
11
12 test_expect_success 'character classes (isspace, isalpha etc.)' '
t/t1404-update-ref-errors.sh
+2
@@ -1,6 +1,8 @@
1 #!/bin/sh
2
3 test_description='Test git update-ref error handling'
4 +
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 # Create some references, perhaps run pack-refs --all, then try to
t/t1409-avoid-packing-refs.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='avoid rewriting packed-refs unnecessarily'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 # Add an identifying mark to the packed-refs file header line. This
t/t1413-reflog-detach.sh
+1
@@ -4,6 +4,7 @@ test_description='Test reflog interaction with detached HEAD'
4 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
5 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
6
7 +TEST_PASSES_SANITIZE_LEAK=true
8 . ./test-lib.sh
9
10 reset_state () {
t/t1501-work-tree.sh
+2
@@ -1,6 +1,8 @@
1 #!/bin/sh
2
3 test_description='test separate work tree'
4 +
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success 'setup' '
t/t2025-checkout-no-overlay.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='checkout --no-overlay <tree-ish> -- <pathspec>'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success 'setup' '
t/t3009-ls-files-others-nonsubmodule.sh
+1
@@ -18,6 +18,7 @@ This test runs git ls-files --others with the following working tree:
18 git repository with a commit and an untracked file
19 '
20
21 +TEST_PASSES_SANITIZE_LEAK=true
22 . ./test-lib.sh
23
24 test_expect_success 'setup: directories' '
t/t3010-ls-files-killed-modified.sh
+2
@@ -41,6 +41,8 @@ Also for modification test, the cache and working tree have:
41 We should report path0, path1, path2/file2, path3/file3, path7 and path8
42 modified without reporting path9 and path10. submod1 is also modified.
43 '
44 +
45 +TEST_PASSES_SANITIZE_LEAK=true
46 . ./test-lib.sh
47
48 test_expect_success 'git update-index --add to add various paths.' '
t/t4045-diff-relative.sh
+2
@@ -1,6 +1,8 @@
1 #!/bin/sh
2
3 test_description='diff --relative tests'
4 +
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success 'setup' '
t/t4111-apply-subdir.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='patching from inconvenient places'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success 'setup' '
t/t4135-apply-weird-filenames.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='git apply with weird postimage filenames'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success 'setup' '
t/t4213-log-tabexpand.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='log/show --expand-tabs'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 HT=" "
t/t5618-alternate-refs.sh
+2
@@ -1,6 +1,8 @@
1 #!/bin/sh
2
3 test_description='test handling of --alternate-refs traversal'
4 +
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 # Avoid test_commit because we want a specific and known set of refs:
t/t6301-for-each-ref-errors.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='for-each-ref errors for broken refs'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 ZEROS=$ZERO_OID
t/t7520-ignored-hook-warning.sh
+1
@@ -2,6 +2,7 @@
2
3 test_description='ignored hook warning'
4
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success setup '
t/t7614-merge-signoff.sh
+1
@@ -8,6 +8,7 @@ This test runs git merge --signoff and makes sure that it works.
8 GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
9 export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
10
11 +TEST_PASSES_SANITIZE_LEAK=true
12 . ./test-lib.sh
13
14 # Setup test files
t/t9003-help-autocorrect.sh
+2
@@ -1,6 +1,8 @@
1 #!/bin/sh
2
3 test_description='help.autocorrect finding a match'
4 +
5 +TEST_PASSES_SANITIZE_LEAK=true
6 . ./test-lib.sh
7
8 test_expect_success 'setup' '