Detect unsupported use of .so.0 and .so.1 libraries within same process

[lttng-ust.git] / src / lib / lttng-ust-tracepoint / tracepoint.c

diff --git a/src/lib/lttng-ust-tracepoint/tracepoint.c b/src/lib/lttng-ust-tracepoint/tracepoint.c
index 9767b15c5a7b6adcfa376926f6bade910f901e81..12bc561c3342693cbdafbefac0a87612b5852981 100644 (file)
--- a/src/lib/lttng-ust-tracepoint/tracepoint.c
+++ b/src/lib/lttng-ust-tracepoint/tracepoint.c
@@ -12,6 +12,7 @@
 #include <stdint.h>
 #include <stddef.h>
 #include <stdio.h>
+#include <dlfcn.h>
 
 #include <urcu/arch.h>
 #include <lttng/urcu/urcu-ust.h>
@@ -74,8 +75,8 @@ static CDS_LIST_HEAD(libs);
  * The tracepoint mutex protects the library tracepoints, the hash table, and
  * the library list.
  * All calls to the tracepoint API must be protected by the tracepoint mutex,
- * excepts calls to lttng_ust_tracepoint_register_lib and
- * lttng_ust_tracepoint_unregister_lib, which take the tracepoint mutex themselves.
+ * excepts calls to lttng_ust_tracepoint_module_register and
+ * lttng_ust_tracepoint_module_unregister, which take the tracepoint mutex themselves.
  */
 
 /*
@@ -607,6 +608,39 @@ static void tracepoint_release_queue_add_old_probes(void *old)
        }
 }
 
+/*
+ * Use a symbol of the previous ABI to detect if liblttng-ust-tracepoint.so.0
+ * is loaded in the current process.
+ */
+#define LTTNG_UST_TRACEPOINT_SONAME_0_SYM      "tracepoint_unregister_lib"
+
+static
+void lttng_ust_tracepoint_check_soname_0(void)
+{
+       if (!dlsym(RTLD_DEFAULT, LTTNG_UST_TRACEPOINT_SONAME_0_SYM))
+               return;
+
+       CRIT("Incompatible library ABIs detected within the same process. "
+               "The process is likely linked against different major soname of LTTng-UST which is unsupported. "
+               "The detection was triggered by lookup of ABI 0 symbol \"%s\" in the Global Symbol Table\n",
+               LTTNG_UST_TRACEPOINT_SONAME_0_SYM);
+}
+
+/*
+ * Expose a canary symbol of the previous ABI to ensure we catch uses of a
+ * liblttng-ust-tracepoint.so.0 dlopen'd after .so.1 has been loaded. Use a
+ * different symbol than the detection code to ensure we don't detect ourself.
+ */
+int tracepoint_register_lib(void *arg0 __attribute__((unused)), int arg1 __attribute__((unused)));
+int tracepoint_register_lib(void *arg0 __attribute__((unused)), int arg1 __attribute__((unused)))
+{
+       CRIT("Incompatible library ABIs detected within the same process. "
+               "The process is likely linked against different major soname of LTTng-UST which is unsupported. "
+               "The detection was triggered by canary symbol \"%s\"\n", __func__);
+
+       return -1;
+}
+
 /**
  * lttng_ust_tracepoint_provider_register -  Connect a probe to a tracepoint
  * @name: tracepoint provider name
@@ -623,6 +657,14 @@ int lttng_ust_tracepoint_provider_register(const char *provider_name, const char
        void *old;
        int ret = 0;
 
+       /*
+        * Check if we find a symbol of the previous ABI in the current process
+        * as different ABIs of liblttng-ust can't co-exist in a process. If we
+        * do so, emit a critical log message which will also abort if the
+        * LTTNG_UST_ABORT_ON_CRITICAL environment variable is set.
+        */
+       lttng_ust_tracepoint_check_soname_0();
+
        DBG("Registering probe to tracepoint \"%s:%s\"", provider_name, event_name);
 
        pthread_mutex_lock(&tracepoint_mutex);
@@ -877,9 +919,9 @@ static void new_tracepoints(struct lttng_ust_tracepoint * const *start,
  * against recent liblttng-ust headers require a recent liblttng-ust
  * runtime for those tracepoints to be taken into account.
  */
-int lttng_ust_tracepoint_register_lib(struct lttng_ust_tracepoint * const *tracepoints_start,
+int lttng_ust_tracepoint_module_register(struct lttng_ust_tracepoint * const *tracepoints_start,
                             int tracepoints_count);
-int lttng_ust_tracepoint_register_lib(struct lttng_ust_tracepoint * const *tracepoints_start,
+int lttng_ust_tracepoint_module_register(struct lttng_ust_tracepoint * const *tracepoints_start,
                             int tracepoints_count)
 {
        struct tracepoint_lib *pl, *iter;
@@ -932,8 +974,8 @@ lib_added:
        return 0;
 }
 
-int lttng_ust_tracepoint_unregister_lib(struct lttng_ust_tracepoint * const *tracepoints_start);
-int lttng_ust_tracepoint_unregister_lib(struct lttng_ust_tracepoint * const *tracepoints_start)
+int lttng_ust_tracepoint_module_unregister(struct lttng_ust_tracepoint * const *tracepoints_start);
+int lttng_ust_tracepoint_module_unregister(struct lttng_ust_tracepoint * const *tracepoints_start)
 {
        struct tracepoint_lib *lib;