From: Willy Tarreau <w@1wt.eu>
Date: Mon, 22 Mar 2021 15:10:22 +0000 (+0100)
Subject: MINOR: dynbuf: make b_alloc() always check if the buffer is allocated
X-Git-Tag: v2.4-dev14~67
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=766b6cf20687477e4bd4d20835b8091906149168;p=thirdparty%2Fhaproxy.git

MINOR: dynbuf: make b_alloc() always check if the buffer is allocated

Right now there is a discrepancy beteween b_alloc() and b_allow_margin():
the former forcefully overwrites the target pointer while the latter tests
it and returns it as-is if already allocated.

As a matter of fact, all callers of b_alloc() either preliminary test the
buffer, or assume it's already null.

Let's remove this pain and make the function test the buffer's allocation
before doing it again, and match call places' expectations.
---

diff --git a/doc/internals/buffer-api.txt b/doc/internals/buffer-api.txt
index d4e26dbd99..a163e387ae 100644
--- a/doc/internals/buffer-api.txt
+++ b/doc/internals/buffer-api.txt
@@ -547,13 +547,12 @@ buffer_almost_full  | const buffer *buf| returns true if the buffer is not null
                     | ret: int         | and at least 3/4 of the buffer's space
                     |                  | are used. A waiting buffer will match.
 --------------------+------------------+---------------------------------------
-b_alloc             | buffer *buf      | allocates a buffer and assigns it to
-                    | ret: buffer *    | *buf. If no memory is available, (1)
+b_alloc             | buffer *buf      | ensures that <buf> is allocated or
+                    | ret: buffer *    | allocates a buffer and assigns it to
+                    |                  | *buf. If no memory is available, (1)
                     |                  | is assigned instead with a zero size.
-                    |                  | No control is made to check if *buf
-                    |                  | already pointed to another buffer. The
-                    |                  | allocated buffer is returned, or NULL
-                    |                  | in case no memory is available
+                    |                  | The allocated buffer is returned, or
+                    |                  | NULL in case no memory is available
 --------------------+------------------+---------------------------------------
 b_alloc_fast        | buffer *buf      | allocates a buffer and assigns it to
                     | ret: buffer *    | *buf. If no memory is available, (1)
diff --git a/include/haproxy/dynbuf.h b/include/haproxy/dynbuf.h
index c31b83aaac..00e5fff508 100644
--- a/include/haproxy/dynbuf.h
+++ b/include/haproxy/dynbuf.h
@@ -56,15 +56,17 @@ static inline int buffer_almost_full(const struct buffer *buf)
 /* Functions below are used for buffer allocation */
 /**************************************************/
 
-/* Allocates a buffer and assigns it to *buf. If no memory is available,
- * ((char *)1) is assigned instead with a zero size. No control is made to
- * check if *buf already pointed to another buffer. The allocated buffer is
+/* Ensures that <buf> is allocated, or allocates it. If no memory is available,
+ * ((char *)1) is assigned instead with a zero size. The allocated buffer is
  * returned, or NULL in case no memory is available.
  */
 static inline struct buffer *b_alloc(struct buffer *buf)
 {
 	char *area;
 
+	if (buf->size)
+		return buf;
+
 	*buf = BUF_WANTED;
 	area = pool_alloc_dirty(pool_head_buffer);
 	if (unlikely(!area)) {