REORG: include: split common/xref.h into haproxy/xref{,-t}.h

The type is the only element needed by applet.h and hlua.h, while hlua.c
needs the various functions. XREF_BUSY was placed into the types as well
since it's better to have the special values there.

diff --git a/include/haproxy/xref-t.h b/include/haproxy/xref-t.h
new file mode 100644 (file)
index 0000000..a2aed54
--- /dev/null
+++ b/include/haproxy/xref-t.h
@@ -0,0 +1,45 @@
+/*
+ * include/haproxy/xref-t.h
+ * Atomic cross-references between two elements - types
+ *
+ * Copyright (C) 2017 Thierry Fournier <thierry.fournier@ozon.io>
+ * Copyright (C) 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_XREF_T_H__
+#define __HAPROXY_XREF_T_H__
+
+/* xref is used to create relation between two elements.
+ * Once an element is released, it breaks the relation. If the
+ * relation is already broken, it frees the xref struct.
+ * The pointer between two elements is sort of a refcount with
+ * max value 1. The relation is only between two elements.
+ * The pointer and the type of elements a and b are conventional.
+ */
+
+#define XREF_BUSY ((struct xref *)1)
+
+struct xref {
+       struct xref *peer;
+};
+
+#endif /* __HAPROXY_XREF_T_H__ */

diff --git a/include/common/xref.h b/include/haproxy/xref.h
similarity index 56%
rename from include/common/xref.h
rename to include/haproxy/xref.h
index bdf292d883081f875b785b12ff4c7a75516d066c..e76638599f16a80a654432ab14a7272da1560d22 100644 (file)
--- a/include/common/xref.h
+++ b/include/haproxy/xref.h
@@ -1,7 +1,35 @@
-#ifndef __XREF_H__
-#define __XREF_H__
+/*
+ * include/haproxy/xref.h
+ * Atomic cross-references between two elements - functions
+ *
+ * Copyright (C) 2017 Thierry Fournier <thierry.fournier@ozon.io>
+ * Copyright (C) 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_XREF_H__
+#define __HAPROXY_XREF_H__
 
 #include <haproxy/atomic.h>
+#include <haproxy/xref-t.h>
 
 /* xref is used to create relation between two elements.
  * Once an element is released, it breaks the relation. If the
@@ -11,12 +39,6 @@
  * The pointer and the type of elements a and b are conventional.
  */
 
-struct xref {
-       struct xref *peer;
-};
-
-#define XREF_BUSY ((struct xref *)1)
-
 static inline void xref_create(struct xref *xref_a, struct xref *xref_b)
 {
        xref_a->peer = xref_b;
@@ -81,4 +103,4 @@ static inline void xref_disconnect(struct xref *xref, struct xref *peer)
        xref->peer = NULL;
 }
 
-#endif /* __XREF_H__ */
+#endif /* __HAPROXY_XREF_H__ */

diff --git a/include/types/applet.h b/include/types/applet.h
index 7b21f9ab39dd201f672df715327e56767fb54f26..d6b34a3737ee0d57f2fd802553fdcb959845d807 100644 (file)
--- a/include/types/applet.h
+++ b/include/types/applet.h
@@ -26,11 +26,11 @@
 #include <haproxy/buf.h>
 #include <haproxy/dynbuf-t.h>
 #include <haproxy/freq_ctr-t.h>
+#include <haproxy/xref-t.h>
 #include <types/hlua.h>
 #include <types/obj_type.h>
 #include <types/proxy.h>
 #include <types/stream.h>
-#include <common/xref.h>
 
 struct appctx;
 

diff --git a/include/types/hlua.h b/include/types/hlua.h
index 10a33036cf5632cf10fe5a1a20ce3bb3bbf43e30..990f9bc715f0b34a6c76e02f69de1c66c9745fa4 100644 (file)
--- a/include/types/hlua.h
+++ b/include/types/hlua.h
@@ -7,7 +7,7 @@
 #include <lauxlib.h>
 
 #include <haproxy/regex-t.h>
-#include <common/xref.h>
+#include <haproxy/xref-t.h>
 
 #include <types/http_ana.h>
 #include <types/proxy.h>

diff --git a/src/hlua.c b/src/hlua.c
index 5513a7dcd6c0230965e1a8fa22120b7ec3deed1f..0a3362a30ecb7c9f72b3d141348910c0e1b4d005 100644 (file)
--- a/src/hlua.c
+++ b/src/hlua.c
@@ -27,7 +27,7 @@
 #include <common/cfgparse.h>
 #include <haproxy/thread.h>
 #include <haproxy/regex.h>
-#include <common/xref.h>
+#include <haproxy/xref.h>
 #include <common/h1.h>
 #include <common/standard.h>