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

Re: [PATCH] strbuf: allocate enough space when strbuf_setlen() is called first time

From
Junio C Hamano <gitster@pobox.com>
Date
Apr 28, 2011, 16:57 UTC
Message-ID
<7vtydi48kp.fsf@alter.siamese.dyndns.org>
In-Reply-To
<4DB85162.6000204@lsrfire.ath.cx>
René Scharfe <rene.scharfe@lsrfire.ath.cx> writes:
Show 23 quoted lines
> Subject: strbuf: clarify assertion in strbuf_setlen()
>
> Commit a8f3e2219 introduced the strbuf_grow() call to strbuf_setlen() to
> make ensure that there was at least one byte available to write the
> mandatory trailing NUL, even for previously unallocated strbufs.
>
> Then b315c5c0 added strbuf_slopbuf for the same reason, only globally for
> all uses of strbufs.
>
> Thus the strbuf_grow() call can be removed now.  This avoids readers of
> strbuf.h from mistakenly thinking that strbuf_setlen() can be used to
> extend a strbuf.
>
> The following assert() needs to be changed to cope with the fact that
> sb->alloc can now be zero, which is OK as long as len is also zero.  As
> suggested by Junio, use the chance to convert it to a die() with a short
> explanatory message.  The pattern of 'die("BUG: ...")' is already used in
> strbuf.c.
>
> This was the only assert() in strbuf.[ch], so assert.h doesn't have to be
> included anymore either.
>
> Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>

Very nicely explained. I wish everybody wrote his log message as clearly as this.

Thanks, will queue.
Show 29 quoted lines
> ---
>  strbuf.h |    7 ++-----
>  1 files changed, 2 insertions(+), 5 deletions(-)
>
> diff --git a/strbuf.h b/strbuf.h
> index 07060ce..9e6d9fa 100644
> --- a/strbuf.h
> +++ b/strbuf.h
> @@ -3,8 +3,6 @@
>  
>  /* See Documentation/technical/api-strbuf.txt */
>  
> -#include <assert.h>
> -
>  extern char strbuf_slopbuf[];
>  struct strbuf {
>  	size_t alloc;
> @@ -33,9 +31,8 @@ static inline size_t strbuf_avail(const struct strbuf *sb) {
>  extern void strbuf_grow(struct strbuf *, size_t);
>  
>  static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
> -	if (!sb->alloc)
> -		strbuf_grow(sb, 0);
> -	assert(len < sb->alloc);
> +	if (len > (sb->alloc ? sb->alloc - 1 : 0))
> +		die("BUG: strbuf_setlen() beyond buffer");
>  	sb->len = len;
>  	sb->buf[len] = '\0';
>  }
Previous: René ScharfeNext: Nguyen Thai Ngoc Duy
Message 10 of 11 in “strbuf: allocate enough space when strbuf_setlen() is called first time”
  1. strbuf: allocate enough space when strbuf_setlen() is called first timeNguyễn Thái Ngọc Duy, Apr 26, 2011
  2. Nguyen Thai Ngoc DuyApr 26, 2011
  3. Junio C HamanoApr 26, 2011
  4. Nguyen Thai Ngoc DuyApr 26, 2011
  5. René ScharfeApr 26, 2011
  6. Junio C HamanoApr 26, 2011
  7. René ScharfeApr 26, 2011
  8. Junio C HamanoApr 26, 2011
  9. René ScharfeApr 27, 2011
  10. Junio C HamanoApr 28, 2011
  11. Nguyen Thai Ngoc DuyApr 27, 2011

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.