Fix: remove references to trace_printf()
[lttng-ust.git] / include / lttng / tracepoint.h
index 4b773bbc2eead7a60e11415ead1d364e979afa6d..4b7473eee49a7c6866e33cb001464b73e2a7b181 100644 (file)
  *
  * 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.
  */
 
+#include <stdio.h>
+#include <stdlib.h>
 #include <lttng/tracepoint-types.h>
 #include <lttng/tracepoint-rcu.h>
 #include <urcu/compiler.h>
 #include <dlfcn.h>     /* for dlopen */
 #include <string.h>    /* for memset */
-#include <assert.h>
 #include <lttng/ust-config.h>  /* for sdt */
+#include <lttng/ust-compiler.h>
 
 #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
 #define SDT_USE_VARIADIC
@@ -62,8 +72,12 @@ extern "C" {
 #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)                \
                __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
 
-/* _TP_EXVAR* extract the var names. */
+/*
+ * _TP_EXVAR* extract the var names.
+ * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
+ */
 #define _TP_EXVAR0()
+#define _TP_EXVAR1(a)
 #define _TP_EXVAR2(a,b)                                                b
 #define _TP_EXVAR4(a,b,c,d)                                    b,d
 #define _TP_EXVAR6(a,b,c,d,e,f)                                        b,d,f
@@ -76,6 +90,7 @@ extern "C" {
 #define _TP_EXVAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)   b,d,f,h,j,l,n,p,r,t
 
 #define _TP_EXDATA_VAR0()                                              __tp_data
+#define _TP_EXDATA_VAR1(a)                                             __tp_data
 #define _TP_EXDATA_VAR2(a,b)                                           __tp_data,b
 #define _TP_EXDATA_VAR4(a,b,c,d)                                       __tp_data,b,d
 #define _TP_EXDATA_VAR6(a,b,c,d,e,f)                                   __tp_data,b,d,f
@@ -87,8 +102,12 @@ extern "C" {
 #define _TP_EXDATA_VAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)          __tp_data,b,d,f,h,j,l,n,p,r
 #define _TP_EXDATA_VAR20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)      __tp_data,b,d,f,h,j,l,n,p,r,t
 
-/* _TP_EXPROTO* extract tuples of type, var */
-#define _TP_EXPROTO0()
+/*
+ * _TP_EXPROTO* extract tuples of type, var.
+ * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
+ */
+#define _TP_EXPROTO0()                                         void
+#define _TP_EXPROTO1(a)                                                void
 #define _TP_EXPROTO2(a,b)                                      a b
 #define _TP_EXPROTO4(a,b,c,d)                                  a b,c d
 #define _TP_EXPROTO6(a,b,c,d,e,f)                              a b,c d,e f
@@ -101,6 +120,7 @@ extern "C" {
 #define _TP_EXPROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t) a b,c d,e f,g h,i j,k l,m n,o p,q r,s t
 
 #define _TP_EXDATA_PROTO0()                                            void *__tp_data
+#define _TP_EXDATA_PROTO1(a)                                           void *__tp_data
 #define _TP_EXDATA_PROTO2(a,b)                                         void *__tp_data,a b
 #define _TP_EXDATA_PROTO4(a,b,c,d)                                     void *__tp_data,a b,c d
 #define _TP_EXDATA_PROTO6(a,b,c,d,e,f)                                 void *__tp_data,a b,c d,e f
@@ -125,20 +145,28 @@ extern "C" {
 #define _TP_ARGS_DATA_VAR(...)         _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 #define _TP_PARAMS(...)                        __VA_ARGS__
 
+/*
+ * The tracepoint cb is marked always inline so we can distinguish
+ * between caller's ip addresses within the probe using the return
+ * address.
+ */
 #define _DECLARE_TRACEPOINT(_provider, _name, ...)                                     \
 extern struct tracepoint __tracepoint_##_provider##___##_name;                         \
-static inline void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__))        \
+static inline __attribute__((always_inline, unused)) lttng_ust_notrace                 \
+void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__));             \
+static                                                                                 \
+void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__))              \
 {                                                                                      \
        struct tracepoint_probe *__tp_probe;                                            \
                                                                                        \
-       if (!TP_RCU_LINK_TEST())                                                        \
+       if (caa_unlikely(!TP_RCU_LINK_TEST()))                                          \
                return;                                                                 \
        tp_rcu_read_lock_bp();                                                          \
        __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \
        if (caa_unlikely(!__tp_probe))                                                  \
                goto end;                                                               \
        do {                                                                            \
-               void *__tp_cb = __tp_probe->func;                                       \
+               void (*__tp_cb)(void) = __tp_probe->func;                                       \
                void *__tp_data = __tp_probe->data;                                     \
                                                                                        \
                URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb)    \
@@ -147,21 +175,30 @@ static inline void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_A
 end:                                                                                   \
        tp_rcu_read_unlock_bp();                                                        \
 }                                                                                      \
-static inline void __tracepoint_register_##_provider##___##_name(char *name,           \
-               void *func, void *data)                                                 \
+static inline lttng_ust_notrace                                                                \
+void __tracepoint_register_##_provider##___##_name(char *name,                         \
+               void (*func)(void), void *data);                                        \
+static inline                                                                          \
+void __tracepoint_register_##_provider##___##_name(char *name,                         \
+               void (*func)(void), void *data)                                         \
 {                                                                                      \
        __tracepoint_probe_register(name, func, data,                                   \
                __tracepoint_##_provider##___##_name.signature);                        \
 }                                                                                      \
-static inline void __tracepoint_unregister_##_provider##___##_name(char *name,         \
-               void *func, void *data)                                                 \
+static inline lttng_ust_notrace                                                                \
+void __tracepoint_unregister_##_provider##___##_name(char *name,                       \
+               void (*func)(void), void *data);                                        \
+static inline                                                                          \
+void __tracepoint_unregister_##_provider##___##_name(char *name,                       \
+               void (*func)(void), void *data)                                         \
 {                                                                                      \
        __tracepoint_probe_unregister(name, func, data);                                \
 }
 
-extern int __tracepoint_probe_register(const char *name, void *func, void *data,
-               const char *signature);
-extern int __tracepoint_probe_unregister(const char *name, void *func, void *data);
+extern int __tracepoint_probe_register(const char *name, void (*func)(void),
+               void *data, const char *signature);
+extern int __tracepoint_probe_unregister(const char *name, void (*func)(void),
+               void *data);
 
 /*
  * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
@@ -182,8 +219,104 @@ struct tracepoint_dlopen {
 
 extern struct tracepoint_dlopen tracepoint_dlopen;
 
+#if defined(TRACEPOINT_DEFINE) || defined(TRACEPOINT_CREATE_PROBES)
+
+/*
+ * These weak symbols, the constructor, and destructor take care of
+ * registering only _one_ instance of the tracepoints per shared-ojbect
+ * (or for the whole main program).
+ */
+int __tracepoint_registered
+       __attribute__((weak, visibility("hidden")));
+int __tracepoint_ptrs_registered
+       __attribute__((weak, visibility("hidden")));
+struct tracepoint_dlopen tracepoint_dlopen
+       __attribute__((weak, visibility("hidden")));
+
+#ifndef _LGPL_SOURCE
+static inline void lttng_ust_notrace
+__tracepoint__init_urcu_sym(void);
+static inline void
+__tracepoint__init_urcu_sym(void)
+{
+       /*
+        * Symbols below are needed by tracepoint call sites and probe
+        * providers.
+        */
+       if (!tracepoint_dlopen.rcu_read_lock_sym_bp)
+               tracepoint_dlopen.rcu_read_lock_sym_bp =
+                       URCU_FORCE_CAST(void (*)(void),
+                               dlsym(tracepoint_dlopen.liblttngust_handle,
+                                       "tp_rcu_read_lock_bp"));
+       if (!tracepoint_dlopen.rcu_read_unlock_sym_bp)
+               tracepoint_dlopen.rcu_read_unlock_sym_bp =
+                       URCU_FORCE_CAST(void (*)(void),
+                               dlsym(tracepoint_dlopen.liblttngust_handle,
+                                       "tp_rcu_read_unlock_bp"));
+       if (!tracepoint_dlopen.rcu_dereference_sym_bp)
+               tracepoint_dlopen.rcu_dereference_sym_bp =
+                       URCU_FORCE_CAST(void *(*)(void *p),
+                               dlsym(tracepoint_dlopen.liblttngust_handle,
+                                       "tp_rcu_dereference_sym_bp"));
+}
+#else
+static inline void lttng_ust_notrace
+__tracepoint__init_urcu_sym(void);
+static inline void
+__tracepoint__init_urcu_sym(void)
+{
+}
+#endif
+
+static void lttng_ust_notrace __attribute__((constructor))
+__tracepoints__init(void);
+static void
+__tracepoints__init(void)
+{
+       if (__tracepoint_registered++)
+               return;
+
+       if (!tracepoint_dlopen.liblttngust_handle)
+               tracepoint_dlopen.liblttngust_handle =
+                       dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
+       if (!tracepoint_dlopen.liblttngust_handle)
+               return;
+       __tracepoint__init_urcu_sym();
+}
+
+static void lttng_ust_notrace __attribute__((destructor))
+__tracepoints__destroy(void);
+static void
+__tracepoints__destroy(void)
+{
+       int ret;
+
+       if (--__tracepoint_registered)
+               return;
+       if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_ptrs_registered) {
+               ret = dlclose(tracepoint_dlopen.liblttngust_handle);
+               if (ret) {
+                       fprintf(stderr, "Error (%d) in dlclose\n", ret);
+                       abort();
+               }
+               memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
+       }
+}
+
+#endif
+
 #ifdef TRACEPOINT_DEFINE
 
+/*
+ * These weak symbols, the constructor, and destructor take care of
+ * registering only _one_ instance of the tracepoints per shared-ojbect
+ * (or for the whole main program).
+ */
+extern struct tracepoint * const __start___tracepoints_ptrs[]
+       __attribute__((weak, visibility("hidden")));
+extern struct tracepoint * const __stop___tracepoints_ptrs[]
+       __attribute__((weak, visibility("hidden")));
+
 /*
  * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
  * unresolved symbol that requires the provider to be linked in. When
@@ -219,32 +352,22 @@ extern struct tracepoint_dlopen tracepoint_dlopen;
                        NULL,                                                   \
                        _TRACEPOINT_UNDEFINED_REF(_provider),                   \
                        _TP_EXTRACT_STRING(_args),                              \
+                       { },                                                    \
                };                                                              \
        static struct tracepoint * __tracepoint_ptr_##_provider##___##_name     \
                __attribute__((used, section("__tracepoints_ptrs"))) =          \
                        &__tracepoint_##_provider##___##_name;
 
-/*
- * These weak symbols, the constructor, and destructor take care of
- * registering only _one_ instance of the tracepoints per shared-ojbect
- * (or for the whole main program).
- */
-extern struct tracepoint * const __start___tracepoints_ptrs[]
-       __attribute__((weak, visibility("hidden")));
-extern struct tracepoint * const __stop___tracepoints_ptrs[]
-       __attribute__((weak, visibility("hidden")));
-int __tracepoint_registered
-       __attribute__((weak, visibility("hidden")));
-struct tracepoint_dlopen tracepoint_dlopen
-       __attribute__((weak, visibility("hidden")));
-
-static void __attribute__((constructor)) __tracepoints__init(void)
+static void lttng_ust_notrace __attribute__((constructor))
+__tracepoints__ptrs_init(void);
+static void
+__tracepoints__ptrs_init(void)
 {
-       if (__tracepoint_registered++)
+       if (__tracepoint_ptrs_registered++)
                return;
-
-       tracepoint_dlopen.liblttngust_handle =
-               dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
+       if (!tracepoint_dlopen.liblttngust_handle)
+               tracepoint_dlopen.liblttngust_handle =
+                       dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
        if (!tracepoint_dlopen.liblttngust_handle)
                return;
        tracepoint_dlopen.tracepoint_register_lib =
@@ -255,36 +378,31 @@ static void __attribute__((constructor)) __tracepoints__init(void)
                URCU_FORCE_CAST(int (*)(struct tracepoint * const *),
                                dlsym(tracepoint_dlopen.liblttngust_handle,
                                        "tracepoint_unregister_lib"));
-#ifndef _LGPL_SOURCE
-       tracepoint_dlopen.rcu_read_lock_sym_bp =
-               URCU_FORCE_CAST(void (*)(void),
-                               dlsym(tracepoint_dlopen.liblttngust_handle,
-                                       "tp_rcu_read_lock_bp"));
-       tracepoint_dlopen.rcu_read_unlock_sym_bp =
-               URCU_FORCE_CAST(void (*)(void),
-                               dlsym(tracepoint_dlopen.liblttngust_handle,
-                                       "tp_rcu_read_unlock_bp"));
-       tracepoint_dlopen.rcu_dereference_sym_bp =
-               URCU_FORCE_CAST(void *(*)(void *p),
-                               dlsym(tracepoint_dlopen.liblttngust_handle,
-                                       "tp_rcu_dereference_sym_bp"));
-#endif
-       tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs,
+       __tracepoint__init_urcu_sym();
+       if (tracepoint_dlopen.tracepoint_register_lib) {
+               tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs,
                                __stop___tracepoints_ptrs -
                                __start___tracepoints_ptrs);
+       }
 }
 
-static void __attribute__((destructor)) __tracepoints__destroy(void)
+static void lttng_ust_notrace __attribute__((destructor))
+__tracepoints__ptrs_destroy(void);
+static void
+__tracepoints__ptrs_destroy(void)
 {
        int ret;
 
-       if (--__tracepoint_registered)
+       if (--__tracepoint_ptrs_registered)
                return;
        if (tracepoint_dlopen.tracepoint_unregister_lib)
                tracepoint_dlopen.tracepoint_unregister_lib(__start___tracepoints_ptrs);
-       if (tracepoint_dlopen.liblttngust_handle) {
+       if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_registered) {
                ret = dlclose(tracepoint_dlopen.liblttngust_handle);
-               assert(!ret);
+               if (ret) {
+                       fprintf(stderr, "Error (%d) in dlclose\n", ret);
+                       abort();
+               }
                memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
        }
 }
@@ -453,7 +571,7 @@ static void __attribute__((destructor)) __tracepoints__destroy(void)
  * debug information with line-level scope (TRACEPOINT_EVENT default)
  *
  * TRACE_DEBUG           14
- * debug-level message (trace_printf default)
+ * debug-level message
  *
  * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
  * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
@@ -489,3 +607,9 @@ enum {
 #define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
 
 #endif /* #ifndef TRACEPOINT_LOGLEVEL */
+
+#ifndef TRACEPOINT_MODEL_EMF_URI
+
+#define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
+
+#endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */
This page took 0.026901 seconds and 4 git commands to generate.