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

Re: [PATCH 08/17] provide a helper to free commit buffer

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 12, 2014, 18:22 UTC
Message-ID
<xmqqzjhi56oo.fsf@gitster.dls.corp.google.com>
In-Reply-To
<20140610214005.GH19147@sigill.intra.peff.net>
Jeff King <peff@peff.net> writes:
Show 7 quoted lines
> This converts two lines into one at each caller. But more
> importantly, it abstracts the concept of freeing the buffer,
> which will make it easier to change later.
>
> Note that we also need to provide a "detach" mechanism for
> the weird case in fsck which passes the buffer back to be
> freed.
I find that last sentence a bit of white lie ;-).

The sole caller of "detach" is in index-pack, and discards the return value, which is not wrong per-se because it still has the pointer to the piece of memory it fed to parse_object_buffer(), knows and/or assumes that the return value must be the same as the one it already has, and it handles the freeing of that memory without relying on the object layer at all.

But that is an even more weird special case than the white-lie version. As an API, "detach" that returns the buffer to be freed looks much less weird than what is really going on in the current caller.

I however have to wonder if
	if (detach_commit_buffer(commit) != data)
        	die("BUG");
might want to be there.
Show 120 quoted lines
> Signed-off-by: Jeff King <peff@peff.net>
> ---
>  builtin/fsck.c       |  3 +--
>  builtin/index-pack.c |  2 +-
>  builtin/log.c        |  6 ++----
>  builtin/rev-list.c   |  3 +--
>  commit.c             | 13 +++++++++++++
>  commit.h             | 11 +++++++++++
>  6 files changed, 29 insertions(+), 9 deletions(-)
>
> diff --git a/builtin/fsck.c b/builtin/fsck.c
> index fc150c8..8aadca1 100644
> --- a/builtin/fsck.c
> +++ b/builtin/fsck.c
> @@ -310,8 +310,7 @@ static int fsck_obj(struct object *obj)
>  	if (obj->type == OBJ_COMMIT) {
>  		struct commit *commit = (struct commit *) obj;
>  
> -		free(commit->buffer);
> -		commit->buffer = NULL;
> +		free_commit_buffer(commit);
>  
>  		if (!commit->parents && show_root)
>  			printf("root %s\n", sha1_to_hex(commit->object.sha1));
> diff --git a/builtin/index-pack.c b/builtin/index-pack.c
> index 18f57de..995df39 100644
> --- a/builtin/index-pack.c
> +++ b/builtin/index-pack.c
> @@ -786,7 +786,7 @@ static void sha1_object(const void *data, struct object_entry *obj_entry,
>  			}
>  			if (obj->type == OBJ_COMMIT) {
>  				struct commit *commit = (struct commit *) obj;
> -				commit->buffer = NULL;
> +				detach_commit_buffer(commit);
>  			}
>  			obj->flags |= FLAG_CHECKED;
>  		}
> diff --git a/builtin/log.c b/builtin/log.c
> index 39e8836..226f8f2 100644
> --- a/builtin/log.c
> +++ b/builtin/log.c
> @@ -349,8 +349,7 @@ static int cmd_log_walk(struct rev_info *rev)
>  			rev->max_count++;
>  		if (!rev->reflog_info) {
>  			/* we allow cycles in reflog ancestry */
> -			free(commit->buffer);
> -			commit->buffer = NULL;
> +			free_commit_buffer(commit);
>  		}
>  		free_commit_list(commit->parents);
>  		commit->parents = NULL;
> @@ -1508,8 +1507,7 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
>  		    reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
>  			die(_("Failed to create output files"));
>  		shown = log_tree_commit(&rev, commit);
> -		free(commit->buffer);
> -		commit->buffer = NULL;
> +		free_commit_buffer(commit);
>  
>  		/* We put one extra blank line between formatted
>  		 * patches and this flag is used by log-tree code
> diff --git a/builtin/rev-list.c b/builtin/rev-list.c
> index 9f92905..e012ebe 100644
> --- a/builtin/rev-list.c
> +++ b/builtin/rev-list.c
> @@ -173,8 +173,7 @@ static void finish_commit(struct commit *commit, void *data)
>  		free_commit_list(commit->parents);
>  		commit->parents = NULL;
>  	}
> -	free(commit->buffer);
> -	commit->buffer = NULL;
> +	free_commit_buffer(commit);
>  }
>  
>  static void finish_object(struct object *obj,
> diff --git a/commit.c b/commit.c
> index fbdc480..11a05c1 100644
> --- a/commit.c
> +++ b/commit.c
> @@ -245,6 +245,19 @@ int unregister_shallow(const unsigned char *sha1)
>  	return 0;
>  }
>  
> +void free_commit_buffer(struct commit *commit)
> +{
> +	free(commit->buffer);
> +	commit->buffer = NULL;
> +}
> +
> +const void *detach_commit_buffer(struct commit *commit)
> +{
> +	void *ret = commit->buffer;
> +	commit->buffer = NULL;
> +	return ret;
> +}
> +
>  int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size)
>  {
>  	const char *tail = buffer;
> diff --git a/commit.h b/commit.h
> index 4df48cb..d72ed43 100644
> --- a/commit.h
> +++ b/commit.h
> @@ -51,6 +51,17 @@ int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long s
>  int parse_commit(struct commit *item);
>  void parse_commit_or_die(struct commit *item);
>  
> +/*
> + * Free any cached object buffer associated with the commit.
> + */
> +void free_commit_buffer(struct commit *);
> +
> +/*
> + * Disassociate any cached object buffer from the commit, but do not free it.
> + * The buffer (or NULL, if none) is returned.
> + */
> +const void *detach_commit_buffer(struct commit *);
> +
>  /* Find beginning and length of commit subject. */
>  int find_commit_subject(const char *commit_buffer, const char **subject);
Previous: Jeff KingNext: Jeff King
Message 44 of 60 in “store length of commit->buffer”
  1. 0/15 store length of commit->bufferJeff King, Jun 9, 2014
  2. 01/15 alloc: include any-object allocations in alloc_reportJeff King, Jun 9, 2014
  3. 02/15 commit: push commit_index update into alloc_commit_nodeJeff King, Jun 9, 2014
  4. Junio C HamanoJun 10, 2014
  5. 03/15 do not create "struct commit" with xcallocJeff King, Jun 9, 2014
  6. Junio C HamanoJun 10, 2014
  7. Jeff KingJun 10, 2014
  8. 04/15 logmsg_reencode: return const bufferJeff King, Jun 9, 2014
  9. Eric SunshineJun 10, 2014
  10. 05/15 sequencer: use logmsg_reencode in get_messageJeff King, Jun 9, 2014
  11. Junio C HamanoJun 10, 2014
  12. Jeff KingJun 10, 2014
  13. 06/15 provide a helper to free commit bufferJeff King, Jun 9, 2014
  14. 07/15 provide a helper to set the commit bufferJeff King, Jun 9, 2014
  15. 08/15 provide helpers to access the commit bufferJeff King, Jun 9, 2014
  16. Eric SunshineJun 10, 2014
  17. 09/15 use get_cached_commit_buffer where appropriateJeff King, Jun 9, 2014
  18. 10/15 use get_commit_buffer to avoid duplicate codeJeff King, Jun 9, 2014
  19. Eric SunshineJun 10, 2014
  20. Jeff KingJun 10, 2014
  21. 11/15 convert logmsg_reencode to get_commit_bufferJeff King, Jun 9, 2014
  22. 12/15 use get_commit_buffer everywhereJeff King, Jun 9, 2014
  23. Junio C HamanoJun 9, 2014
  24. Jeff KingJun 10, 2014
  25. Jeff KingJun 10, 2014
  26. Junio C HamanoJun 10, 2014
  27. Jeff KingJun 10, 2014
  28. 13/15 commit-slab: provide a static initializerJeff King, Jun 9, 2014
  29. 14/15 commit: convert commit->buffer to a slabJeff King, Jun 9, 2014
  30. 15/15 commit: record buffer length in cacheJeff King, Jun 9, 2014
  31. Christian CouderJun 10, 2014
  32. Jeff KingJun 10, 2014
  33. Jeff KingJun 10, 2014
  34. Christian CouderJun 10, 2014
  35. 0/17 store length of commit->bufferJeff King, Jun 10, 2014
  36. 01/17 commit_tree: take a pointer/len pair rather than a const strbufJeff King, Jun 10, 2014
  37. 02/17 replace dangerous uses of strbuf_attachJeff King, Jun 10, 2014
  38. 03/17 alloc: include any-object allocations in alloc_reportJeff King, Jun 10, 2014
  39. 04/17 commit: push commit_index update into alloc_commit_nodeJeff King, Jun 10, 2014
  40. 05/17 do not create "struct commit" with xcallocJeff King, Jun 10, 2014
  41. 06/17 logmsg_reencode: return const bufferJeff King, Jun 10, 2014
  42. 07/17 sequencer: use logmsg_reencode in get_messageJeff King, Jun 10, 2014
  43. 08/17 provide a helper to free commit bufferJeff King, Jun 10, 2014
  44. Junio C HamanoJun 12, 2014
  45. Jeff KingJun 12, 2014
  46. Jeff KingJun 12, 2014
  47. 09/17 provide a helper to set the commit bufferJeff King, Jun 10, 2014
  48. 10/17 provide helpers to access the commit bufferJeff King, Jun 10, 2014
  49. 11/17 use get_cached_commit_buffer where appropriateJeff King, Jun 10, 2014
  50. 12/17 use get_commit_buffer to avoid duplicate codeJeff King, Jun 10, 2014
  51. 13/17 convert logmsg_reencode to get_commit_bufferJeff King, Jun 10, 2014
  52. 14/17 use get_commit_buffer everywhereJeff King, Jun 10, 2014
  53. 15/17 commit-slab: provide a static initializerJeff King, Jun 10, 2014
  54. Junio C HamanoJun 12, 2014
  55. Jeff KingJun 12, 2014
  56. 16/17 commit: convert commit->buffer to a slabJeff King, Jun 10, 2014
  57. 17/17 commit: record buffer length in cacheJeff King, Jun 10, 2014
  58. Jeff KingJun 10, 2014
  59. Junio C HamanoJun 12, 2014
  60. reuse cached commit buffer when parsing signaturesJeff King, Jun 13, 2014

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.