REORG: include: split buf.h into haproxy/buf-t.h and haproxy/buf.h

File buf.h is one common cause of pain in the dependencies. Many files in
the code need it to get the struct buffer definition, and a few also need
the inlined functions to manipulate a buffer, but the file used to depend
on a long chain only for BUG_ON() (addressed by last commit).

Now buf.h is split into buf-t.h which only contains the type definitions,
and buf.h for all inlined functions. Callers who don't care can continue
to use buf.h but files in types/ must only use buf-t.h. sys/types.h had
to be added to buf.h to get ssize_t as used by b_move(). It's worth noting
that ssize_t is only supposed to be a size_t supporting -1, so b_move()
ought to be rethought regarding this.

The files were moved to haproxy/ and all their users were updated
accordingly. A dependency issue was addressed on fcgi whose C file didn't
include buf.h.

diff --git a/include/common/buffer.h b/include/common/buffer.h
index d90b94e8be6f5a187aa9183600f6a768ad270d30..6e7adf4b9ad00d93e83eb1efb9f2f12096ba7d2b 100644 (file)
--- a/include/common/buffer.h
+++ b/include/common/buffer.h
@@ -27,7 +27,7 @@
 #include <string.h>
 
 #include <haproxy/api.h>
-#include <common/buf.h>
+#include <haproxy/buf.h>
 #include <common/chunk.h>
 #include <import/ist.h>
 #include <common/istbuf.h>

diff --git a/include/common/chunk.h b/include/common/chunk.h
index d4f9ea23a9fdef4effad75735a5c8af9f8694b40..46dfae70d0d7edd8699f703add0d421df91ae5c8 100644 (file)
--- a/include/common/chunk.h
+++ b/include/common/chunk.h
@@ -26,7 +26,7 @@
 #include <string.h>
 
 #include <haproxy/api.h>
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 #include <import/ist.h>
 #include <common/memory.h>
 

diff --git a/include/common/fcgi.h b/include/common/fcgi.h
index 6d3c6eb19b6b0a105bb1b7cff8b009e8fe627c6b..b822a2c8409d10c11bf09599e22ac8dde4f0c295 100644 (file)
--- a/include/common/fcgi.h
+++ b/include/common/fcgi.h
@@ -25,7 +25,7 @@
 #include <stdio.h>
 #include <haproxy/api.h>
 #include <common/standard.h>
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 #include <import/ist.h>
 
 /* FCGI protocol version */

diff --git a/include/common/hpack-enc.h b/include/common/hpack-enc.h
index f766063ff794ad33e5fadfab9f29da34af81b07c..7d73b35648fc3991bf5a7f07e51211d42af682c3 100644 (file)
--- a/include/common/hpack-enc.h
+++ b/include/common/hpack-enc.h
@@ -30,7 +30,7 @@
 
 #include <string.h>
 #include <haproxy/api.h>
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 #include <common/http.h>
 #include <import/ist.h>
 

diff --git a/include/common/http.h b/include/common/http.h
index 86cf01536cb48e7e800866edf3af231993841099..0173b7acb479873ea4cc324a23bdbbdc286fed5a 100644 (file)
--- a/include/common/http.h
+++ b/include/common/http.h
@@ -23,7 +23,7 @@
 #ifndef _COMMON_HTTP_H
 #define _COMMON_HTTP_H
 
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 #include <import/ist.h>
 
 /*

diff --git a/include/common/htx.h b/include/common/htx.h
index 1a87cde75bd4d19839686b34394651747f6a70b8..197ffb6e684e328f597fe0f278d1a75ecb804ad7 100644 (file)
--- a/include/common/htx.h
+++ b/include/common/htx.h
@@ -24,7 +24,7 @@
 
 #include <stdio.h>
 #include <haproxy/api.h>
-#include <common/buf.h>
+#include <haproxy/buf.h>
 #include <import/ist.h>
 #include <common/http.h>
 #include <common/http-hdr.h>

diff --git a/include/common/istbuf.h b/include/common/istbuf.h
index f9bf0b1f900654256044acdcf9c31deb8ecac6a4..074efe0dd10f069c48a18ce582bd2e85ed6c44f4 100644 (file)
--- a/include/common/istbuf.h
+++ b/include/common/istbuf.h
@@ -29,7 +29,7 @@
 #define _COMMON_ISTBUF_H
 
 #include <inttypes.h>
-#include <common/buf.h>
+#include <haproxy/buf.h>
 #include <import/ist.h>
 
 

diff --git a/include/haproxy/buf-t.h b/include/haproxy/buf-t.h
new file mode 100644 (file)
index 0000000..cb4310d
--- /dev/null
+++ b/include/haproxy/buf-t.h
@@ -0,0 +1,62 @@
+/*
+ * include/haproxy/buf-t.h
+ * Simple buffer handling - types definitions.
+ *
+ * Copyright (C) 2000-2020 Willy Tarreau - w@1wt.eu
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef _HAPROXY_BUF_T_H
+#define _HAPROXY_BUF_T_H
+
+#include <stddef.h>
+
+/* Structure defining a buffer's head */
+struct buffer {
+       size_t size;                /* buffer size in bytes */
+       char  *area;                /* points to <size> bytes */
+       size_t data;                /* amount of data after head including wrapping */
+       size_t head;                /* start offset of remaining data relative to area */
+};
+
+/* A buffer may be in 3 different states :
+ *   - unallocated : size == 0, area == 0  (b_is_null() is true)
+ *   - waiting     : size == 0, area != 0  (b_is_null() is true)
+ *   - allocated   : size  > 0, area  > 0  (b_is_null() is false)
+ */
+
+/* initializers for certain buffer states. It is important that the NULL buffer
+ * remains the one with all fields initialized to zero so that a calloc() or a
+ * memset() on a struct automatically sets a NULL buffer.
+ */
+#define BUF_NULL   ((struct buffer){ })
+#define BUF_WANTED ((struct buffer){ .area = (char *)1 })
+#define BUF_RING   ((struct buffer){ .area = (char *)2 })
+
+#endif /* _HAPROXY_BUF_T_H */
+
+/*
+ * Local variables:
+ *  c-indent-level: 8
+ *  c-basic-offset: 8
+ * End:
+ */

diff --git a/include/common/buf.h b/include/haproxy/buf.h
similarity index 96%
rename from include/common/buf.h
rename to include/haproxy/buf.h
index 6ae9a4e676487d40a8b5bd7f3589a708187ba36b..a0e1cb8113559b9f370e153064c33e04026d18b6 100644 (file)
--- a/include/common/buf.h
+++ b/include/haproxy/buf.h
@@ -1,8 +1,8 @@
 /*
- * include/common/buf.h
- * Simple buffer handling.
+ * include/haproxy/buf.h
+ * Simple buffer handling - functions definitions.
  *
- * Copyright (C) 2000-2018 Willy Tarreau - w@1wt.eu
+ * Copyright (C) 2000-2020 Willy Tarreau - w@1wt.eu
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -25,35 +25,13 @@
  * OTHER DEALINGS IN THE SOFTWARE.
  */
 
-#ifndef _COMMON_BUF_H
-#define _COMMON_BUF_H
+#ifndef _HAPROXY_BUF_H
+#define _HAPROXY_BUF_H
 
+#include <sys/types.h>
 #include <string.h>
-#include <unistd.h>
 #include <haproxy/api.h>
-
-/* Structure defining a buffer's head */
-struct buffer {
-       size_t size;                /* buffer size in bytes */
-       char  *area;                /* points to <size> bytes */
-       size_t data;                /* amount of data after head including wrapping */
-       size_t head;                /* start offset of remaining data relative to area */
-};
-
-/* A buffer may be in 3 different states :
- *   - unallocated : size == 0, area == 0  (b_is_null() is true)
- *   - waiting     : size == 0, area != 0  (b_is_null() is true)
- *   - allocated   : size  > 0, area  > 0  (b_is_null() is false)
- */
-
-/* initializers for certain buffer states. It is important that the NULL buffer
- * remains the one with all fields initialized to zero so that a calloc() or a
- * memset() on a struct automatically sets a NULL buffer.
- */
-#define BUF_NULL   ((struct buffer){ })
-#define BUF_WANTED ((struct buffer){ .area = (char *)1 })
-#define BUF_RING   ((struct buffer){ .area = (char *)2 })
-
+#include <haproxy/buf-t.h>
 
 /***************************************************************************/
 /* Functions used to compute offsets and pointers. Most of them exist in   */
@@ -1034,7 +1012,7 @@ static inline struct buffer *br_del_head(struct buffer *r)
        return br_head(r);
 }
 
-#endif /* _COMMON_BUF_H */
+#endif /* _HAPROXY_BUF_H */
 
 /*
  * Local variables:

diff --git a/include/proto/h1_htx.h b/include/proto/h1_htx.h
index 13ba394d54fd9d9d73552427acc0a048ce490007..02b9bdca7beeb48ea064a5db330641ac645e5fbd 100644 (file)
--- a/include/proto/h1_htx.h
+++ b/include/proto/h1_htx.h
@@ -23,7 +23,7 @@
 #ifndef _PROTO_H1_HTX_H
 #define _PROTO_H1_HTX_H
 
-#include <common/buf.h>
+#include <haproxy/buf.h>
 #include <import/ist.h>
 #include <common/h1.h>
 

diff --git a/include/proto/http_htx.h b/include/proto/http_htx.h
index edbd8f1bf3aa843df74c8c829a0a41739840f37b..77e4d6753fa13424a1b71d8d4992f6b5d79fbe92 100644 (file)
--- a/include/proto/http_htx.h
+++ b/include/proto/http_htx.h
@@ -23,7 +23,7 @@
 #ifndef _PROTO_HTTP_HTX_H
 #define _PROTO_HTTP_HTX_H
 
-#include <common/buf.h>
+#include <haproxy/buf.h>
 #include <import/ist.h>
 #include <common/regex.h>
 

diff --git a/include/types/checks.h b/include/types/checks.h
index 4b8177078792901fe4cfc3a8cf5fdf102f8dd23c..6d07c9a55d271cbd8542d5240890af8834bda976 100644 (file)
--- a/include/types/checks.h
+++ b/include/types/checks.h
@@ -20,7 +20,7 @@
 #include <import/ist.h>
 #include <common/mini-clist.h>
 #include <common/regex.h>
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 
 #include <types/connection.h>
 #include <types/obj_type.h>

diff --git a/include/types/http_htx.h b/include/types/http_htx.h
index 02b6b3b4821a421f7126ac307ea8dcfe64b2e1ff..4123e7e7cbe7eab42fc1a96b371677ea826e4bb2 100644 (file)
--- a/include/types/http_htx.h
+++ b/include/types/http_htx.h
@@ -25,7 +25,7 @@
 
 #include <import/ebistree.h>
 
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 #include <common/http.h>
 #include <common/htx.h>
 #include <import/ist.h>

diff --git a/include/types/ring.h b/include/types/ring.h
index f3b3987a8398f2b23abc519027e047f633246952..f5084445a6b1b0fcf36f176b8cc6345bd1ffc488 100644 (file)
--- a/include/types/ring.h
+++ b/include/types/ring.h
@@ -23,7 +23,7 @@
 #define _TYPES_RING_H
 
 #include <haproxy/api-t.h>
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 #include <import/ist.h>
 
 /* The code below handles circular buffers with single-producer and multiple

diff --git a/include/types/sample.h b/include/types/sample.h
index 2292b3694c40d5954e0e656f8b8f351185c3ae2c..bb6b0928bca2ded2d5f5fe3cb408845fd4ec7b98 100644 (file)
--- a/include/types/sample.h
+++ b/include/types/sample.h
@@ -26,7 +26,7 @@
 #include <sys/socket.h>
 #include <netinet/in.h>
 
-#include <common/buf.h>
+#include <haproxy/buf-t.h>
 #include <common/http.h>
 #include <common/mini-clist.h>
 

diff --git a/src/debug.c b/src/debug.c
index 340add082978cc5b634a94cc7b2cb4b6c0407299..cf77c5b71b4678a84481c1a3d60697720394b6b1 100644 (file)
--- a/src/debug.c
+++ b/src/debug.c
@@ -20,7 +20,7 @@
 #include <sys/wait.h>
 
 #include <haproxy/api.h>
-#include <common/buf.h>
+#include <haproxy/buf.h>
 #include <haproxy/debug.h>
 #include <common/hathreads.h>
 #include <import/ist.h>

diff --git a/src/fcgi.c b/src/fcgi.c
index cb7b44e792d0b370c5d2ebd739cda8d2ed580a1f..b2f6e4283e6f7aba9bfda0d4be6b67834132ab68 100644 (file)
--- a/src/fcgi.c
+++ b/src/fcgi.c
@@ -25,7 +25,7 @@
  */
 
 #include <common/fcgi.h>
-
+#include <haproxy/buf.h>
 
 /* Encodes header of a FCGI record into the chunk <out>. It returns non-zero on
  * success and 0 on failure (buffer full). <out> is a chunk, so the wrapping is

diff --git a/src/ring.c b/src/ring.c
index b011f5363beadd9d99c718d25286d709aa746e14..d10ebd75fe7a52a4c1528dc8fc608349cf7ff468 100644 (file)
--- a/src/ring.c
+++ b/src/ring.c
@@ -20,7 +20,7 @@
 
 #include <stdlib.h>
 #include <haproxy/api.h>
-#include <common/buf.h>
+#include <haproxy/buf.h>
 #include <common/hathreads.h>
 #include <types/applet.h>
 #include <proto/cli.h>