git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 03/11] remote: fix a leak in query_matches_negative_refspec

From
Rubén Justo <rjusto@gmail.com>
Date
Jun 11, 2023, 18:49 UTC
Message-ID
<a9b27053-ff2b-7b67-f2ba-5691f4bda961@gmail.com>
In-Reply-To
<9eb931e7-dd18-8ce8-4d4a-cf3d85066189@gmail.com>

In c0192df630 (refspec: add support for negative refspecs, 2020-09-30) query_matches_negative_refspec() was introduced.

The function was implemented as a two-loop process, where the former loop accumulates and the latter evaluates. To accumulate, a string_list is used.

Within the first loop, there are three cases where a string is added to the string_list. Two of them add strings that do not need to be freed. But in the third case, the string added is returned by match_name_with_pattern(), which needs to be freed.

The string_list is initialized with STRING_LIST_INIT_NODUP, i.e. when cleared, the strings added are not freed. Therefore, the string returned by match_name_with_pattern() is not freed, so we have a leak.

   $ git remote add local .
   $ git update-ref refs/remotes/local/foo HEAD
   $ git branch --track bar local/foo
   Direct leak of 24 byte(s) in 1 object(s) allocated from:
       ... in xrealloc wrapper.c
       ... in strbuf_grow strbuf.c
       ... in strbuf_add strbuf.c
       ... in match_name_with_pattern remote.c
       ... in query_matches_negative_refspec remote.c
       ... in query_refspecs remote.c
       ... in remote_find_tracking remote.c
       ... in find_tracked_branch branch.c
       ... in for_each_remote remote.c
       ... in setup_tracking branch.c
       ... in create_branch branch.c
       ... in cmd_branch builtin/branch.c
       ... in run_builtin git.c
   Direct leak of 24 byte(s) in 1 object(s) allocated from:
       ... in xrealloc wrapper.c
       ... in strbuf_grow strbuf.c
       ... in strbuf_add strbuf.c
       ... in match_name_with_pattern remote.c
       ... in query_matches_negative_refspec remote.c
       ... in query_refspecs remote.c
       ... in remote_find_tracking remote.c
       ... in check_tracking_branch branch.c
       ... in for_each_remote remote.c
       ... in validate_remote_tracking_branch branch.c
       ... in dwim_branch_start branch.c
       ... in create_branch branch.c
       ... in cmd_branch builtin/branch.c
       ... in run_builtin git.c

An interesting point to note is that while string_list_append() is used in the first two cases described, string_list_append_nodup() is used in the third. This seems to indicate an intention to delegate the responsibility for freeing the string, to the string_list. As if the string_list had been initialized with STRING_LIST_INIT_DUP, i.e. the strings are strdup()'d when added (except if the "_nodup" API is used) and freed when cleared.

Switching to STRING_LIST_INIT_DUP fixes the leak and probably is what we wanted to do originally. Let's do it.

Signed-off-by: Rubén Justo <rjusto@gmail.com>
---
 remote.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/remote.c b/remote.c
index 0764fca0db..1bcd36e358 100644
--- a/remote.c
+++ b/remote.c
@@ -890,7 +890,7 @@ static int query_matches_negative_refspec(struct refspec *rs, struct refspec_ite
 {
 	int i, matched_negative = 0;
 	int find_src = !query->src;
-	struct string_list reversed = STRING_LIST_INIT_NODUP;
+	struct string_list reversed = STRING_LIST_INIT_DUP;
 	const char *needle = find_src ? query->dst : query->src;
 
 	/*
-- 
2.40.1
Previous: Jeff KingNext: Jeff King
Message 7 of 47 in “tests: mark as passing with SANITIZE=leak”
  1. Rubén JustoJun 11, 2023
  2. 01/11 rev-parse: fix a leak with --abbrev-refRubén Justo, Jun 11, 2023
  3. Jeff KingJun 12, 2023
  4. Rubén JustoJun 16, 2023
  5. 02/11 config: fix a leak in git_config_copy_or_rename_section_in_fileRubén Justo, Jun 11, 2023
  6. Jeff KingJun 12, 2023
  7. 03/11 remote: fix a leak in query_matches_negative_refspecRubén Justo, Jun 11, 2023
  8. Jeff KingJun 12, 2023
  9. Rubén JustoJun 16, 2023
  10. 04/11 branch: fix a leak in dwim_and_setup_trackingRubén Justo, Jun 11, 2023
  11. Jeff KingJun 12, 2023
  12. Rubén JustoJun 16, 2023
  13. 05/11 branch: fix a leak in setup_trackingRubén Justo, Jun 11, 2023
  14. Jeff KingJun 12, 2023
  15. Rubén JustoJun 16, 2023
  16. 06/11 branch: fix a leak in cmd_branchRubén Justo, Jun 11, 2023
  17. Jeff KingJun 12, 2023
  18. Rubén JustoJun 16, 2023
  19. 07/11 branch: fix a leak in inherit_trackingRubén Justo, Jun 11, 2023
  20. Jeff KingJun 12, 2023
  21. 08/11 branch: fix a leak in check_tracking_branchRubén Justo, Jun 11, 2023
  22. Jeff KingJun 12, 2023
  23. 09/11 branch: fix a leak in setup_trackingRubén Justo, Jun 11, 2023
  24. Jeff KingJun 12, 2023
  25. 10/11 config: fix a leak in git_config_copy_or_rename_section_in_fileRubén Justo, Jun 11, 2023
  26. Jeff KingJun 12, 2023
  27. Rubén JustoJun 16, 2023
  28. 11/11 tests: mark as passing with SANITIZE=leakRubén Justo, Jun 11, 2023
  29. Rubén JustoJun 11, 2023
  30. Jeff KingJun 12, 2023
  31. Rubén JustoJun 16, 2023
  32. Junio C HamanoJun 13, 2023
  33. 0/5 tests: mark as passing with SANITIZE=leakRubén Justo, Jun 16, 2023
  34. 1/5 rev-parse: fix a leak with --abbrev-refRubén Justo, Jun 16, 2023
  35. 2/5 branch: fix a leak in setup_trackingRubén Justo, Jun 16, 2023
  36. 3/5 branch: fix a leak in cmd_branchRubén Justo, Jun 16, 2023
  37. 4/5 config: fix a leak in git_config_copy_or_rename_section_in_fileRubén Justo, Jun 16, 2023
  38. 5/5 tests: mark as passing with SANITIZE=leakRubén Justo, Jun 16, 2023
  39. Junio C HamanoJun 16, 2023
  40. Jeff KingJun 17, 2023
  41. Rubén JustoJun 17, 2023
  42. 0/5 tests: mark as passing with SANITIZE=leakRubén Justo, Jun 17, 2023
  43. 1/5 rev-parse: fix a leak with --abbrev-refRubén Justo, Jun 17, 2023
  44. 2/5 branch: fix a leak in setup_trackingRubén Justo, Jun 17, 2023
  45. 3/5 branch: fix a leak in cmd_branchRubén Justo, Jun 17, 2023
  46. 4/5 config: fix a leak in git_config_copy_or_rename_section_in_fileRubén Justo, Jun 17, 2023
  47. 5/5 tests: mark as passing with SANITIZE=leakRubén Justo, Jun 17, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.