From: Michael Jeanson <mjeanson@efficios.com>
Date: Tue, 20 Apr 2021 16:13:28 +0000 (-0400)
Subject: Tracepoint API namespacing 'TRACEPOINT_PROBE_DYNAMIC_LINKAGE'
X-Git-Tag: v2.13.0-rc1~63
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=341a19e86e14b272d7de8dedc7e4597a96742a06;p=lttng-ust.git

Tracepoint API namespacing 'TRACEPOINT_PROBE_DYNAMIC_LINKAGE'

The ABI bump gives us the opportunity to namespace all public symbols
under the 'lttng_ust_' prefix. Namespace all API symbols and macros
under 'lttng_ust_' / 'LTTNG_UST_' and add compat macros to keep
compatibility with the previous API.

Change-Id: Iee16eccc8fa796c0154a879d5fc04b9d84597e14
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/README.md b/README.md
index 3c45c30c..39fa4428 100644
--- a/README.md
+++ b/README.md
@@ -124,7 +124,7 @@ This method decouples the tracepoint provider from the application,
 making it dynamically loadable.
 
   1. Into exactly one unit of your _application_, define
-     `TRACEPOINT_DEFINE` _and_ `TRACEPOINT_PROBE_DYNAMIC_LINKAGE`,
+     `TRACEPOINT_DEFINE` _and_ `LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE`,
      then include the tracepoint provider header.
   2. Include the tracepoint provider header into all C/C++ files using
      the provider and insert tracepoints using the `tracepoint()` macro.
diff --git a/doc/examples/demo/demo.c b/doc/examples/demo/demo.c
index aa54055b..96f9001b 100644
--- a/doc/examples/demo/demo.c
+++ b/doc/examples/demo/demo.c
@@ -18,7 +18,7 @@
 #include <stdlib.h>
 
 #define TRACEPOINT_DEFINE
-#define TRACEPOINT_PROBE_DYNAMIC_LINKAGE
+#define LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
 #include "ust_tests_demo.h"
 #include "ust_tests_demo2.h"
 #include "ust_tests_demo3.h"
diff --git a/include/lttng/tracepoint.h b/include/lttng/tracepoint.h
index 96f3fe3a..4223579e 100644
--- a/include/lttng/tracepoint.h
+++ b/include/lttng/tracepoint.h
@@ -446,26 +446,33 @@ extern struct lttng_ust_tracepoint * const __stop_lttng_ust_tracepoints_ptrs[]
 	__attribute__((weak, visibility("hidden")));
 
 /*
- * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
+ * When LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
  * unresolved symbol that requires the provider to be linked in. When
- * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
+ * LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
  * unresolved symbol that depends on having the provider linked in,
  * otherwise the linker complains. This deals with use of static
  * libraries, ensuring that the linker does not remove the provider
  * object from the executable.
  */
-#ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
-#define _TRACEPOINT_UNDEFINED_REF(provider)	NULL
-#else	/* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
-#define _TRACEPOINT_UNDEFINED_REF(provider)	&lttng_ust_tracepoint_provider_##provider
-#endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
+
+#if LTTNG_UST_COMPAT_API(0)
+# if defined(TRACEPOINT_PROBE_DYNAMIC_LINKAGE) && !defined(LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE)
+#  define LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
+# endif
+#endif /* #if LTTNG_UST_COMPAT_API(0) */
+
+#ifdef LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
+#define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider)	NULL
+#else	/* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
+#define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider)	&lttng_ust_tracepoint_provider_##provider
+#endif /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 
 /*
  * Note: to allow PIC code, we need to allow the linker to update the pointers
  * in the lttng_ust_tracepoints_ptrs section.
  * Therefore, this section is _not_ const (read-only).
  */
-#define _TP_EXTRACT_STRING(...)	#__VA_ARGS__
+#define LTTNG_UST__TP_EXTRACT_STRING(...)	#__VA_ARGS__
 
 #define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args)				\
 	lttng_ust_tracepoint_validate_name_len(_provider, _name);		\
@@ -483,8 +490,8 @@ extern struct lttng_ust_tracepoint * const __stop_lttng_ust_tracepoints_ptrs[]
 			__tp_name_strtab_##_provider##___##_name,		\
 			0,							\
 			NULL,							\
-			_TRACEPOINT_UNDEFINED_REF(_provider), 			\
-			_TP_EXTRACT_STRING(_args),				\
+			LTTNG_UST__TRACEPOINT_UNDEFINED_REF(_provider), 	\
+			LTTNG_UST__TP_EXTRACT_STRING(_args),			\
 		};								\
 	static struct lttng_ust_tracepoint *					\
 		lttng_ust_tracepoint_ptr_##_provider##___##_name			\