Update loglevel names
[lttng-ust.git] / include / lttng / tracepoint.h
index 86abd1a5b2514284957a27be0430262dca4e20f4..fa39b272d8ff19527fd065c7e393ac947b46c8b2 100644 (file)
  * modified is included with the above copyright notice.
  */
 
-#include <urcu-bp.h>
-#include <tracepoint-types.h>
+#include <lttng/tracepoint-types.h>
+#include <lttng/tracepoint-rcu.h>
 #include <urcu/compiler.h>
+#include <dlfcn.h>     /* for dlopen */
+#include <assert.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#define tracepoint(provider, name, ...)                                          \
-       do {                                                              \
-               if (caa_unlikely(__tracepoint_##provider##_##name.state)) \
-                       __tracepoint_##provider##_##name(__VA_ARGS__);    \
+#define tracepoint(provider, name, ...)                                            \
+       do {                                                                \
+               if (caa_unlikely(__tracepoint_##provider##___##name.state)) \
+                       __tracepoint_cb_##provider##___##name(__VA_ARGS__); \
        } while (0)
 
 #define TP_ARGS(...)       __VA_ARGS__
@@ -36,10 +38,20 @@ extern "C" {
  * fine too).
  * Each tuple is also separated by a comma.
  */
-#define _TP_COMBINE_TOKENS1(_tokena, _tokenb)       _tokena##_tokenb
-#define _TP_COMBINE_TOKENS(_tokena, _tokenb)        _TP_COMBINE_TOKENS1(_tokena, _tokenb)
+#define __TP_COMBINE_TOKENS(_tokena, _tokenb)                          \
+               _tokena##_tokenb
+#define _TP_COMBINE_TOKENS(_tokena, _tokenb)                           \
+               __TP_COMBINE_TOKENS(_tokena, _tokenb)
+#define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                        \
+               _tokena##_tokenb##_tokenc
+#define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                 \
+               __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
+#define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)       \
+               _tokena##_tokenb##_tokenc##_tokend
+#define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)                \
+               __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
 
-/* _TP_EXVAR* extract the vars names. */
+/* _TP_EXVAR* extract the var names. */
 #define _TP_EXVAR0()
 #define _TP_EXVAR2(a,b)                                                b
 #define _TP_EXVAR4(a,b,c,d)                                    b,d
@@ -92,46 +104,54 @@ extern "C" {
 /* Preprocessor trick to count arguments. Inspired from sdt.h. */
 #define _TP_NARGS(...)                 __TP_NARGS(__VA_ARGS__, 20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0)
 #define __TP_NARGS(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20, N, ...)  N
-#define _TP_PROTO_N(N, ...)            _TP_PARAMS(TP_COMBINE_TOKENS(_TP_SPLIT, N)(__VA_ARGS__))
-#define _TP_VARS_N(N, ...)             _TP_PARAMS(TP_COMBINE_TOKENS(_TP_EVEN, N)(__VA_ARGS__))
-#define _TP_DATA_PROTO_N(N, ...)       _TP_PARAMS(TP_COMBINE_TOKENS(_TP_SPLIT_DATA, N)(__VA_ARGS__))
-#define _TP_DATA_VARS_N(N, ...)                _TP_PARAMS(TP_COMBINE_TOKENS(_TP_EVEN_DATA, N)(__VA_ARGS__))
+#define _TP_PROTO_N(N, ...)            _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
+#define _TP_VAR_N(N, ...)              _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
+#define _TP_DATA_PROTO_N(N, ...)       _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
+#define _TP_DATA_VAR_N(N, ...)         _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
 #define _TP_ARGS_PROTO(...)            _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
-#define _TP_ARGS_VARS(...)             _TP_VARS_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
+#define _TP_ARGS_VAR(...)              _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 #define _TP_ARGS_DATA_PROTO(...)       _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
-#define _TP_ARGS_DATA_VARS(...)                _TP_DATA_VARS_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
+#define _TP_ARGS_DATA_VAR(...)         _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 #define _TP_PARAMS(...)                        __VA_ARGS__
 
 #define _DECLARE_TRACEPOINT(provider, name, ...)                                       \
-extern struct tracepoint __tracepoint_##provider##_##name;                             \
-static inline void __tracepoint_##provider##_##name(_TP_ARGS_DATA_PROTO(__VA_ARGS__))  \
+extern struct tracepoint __tracepoint_##provider##___##name;                           \
+static inline void __tracepoint_cb_##provider##___##name(_TP_ARGS_PROTO(__VA_ARGS__))  \
 {                                                                                      \
        struct tracepoint_probe *__tp_probe;                                            \
                                                                                        \
-       rcu_read_lock_bp();                                                             \
-       p = rcu_dereference(__tracepoint_##provider##_##name.probes);                   \
-       if (caa_unlikely(!p))                                                           \
+       if (!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_data = p->priv;                                              \
+               void *__tp_cb = __tp_probe->func;                                       \
+               void *__tp_data = __tp_probe->data;                                     \
                                                                                        \
-               (*p->callback)(_TP_ARGS_DATA_VARS(__VA_ARGS__));                        \
-               __tp_probe++;                                                           \
-       } while (*__tp_probe);                                                          \
+               URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb)    \
+                               (_TP_ARGS_DATA_VAR(__VA_ARGS__));                       \
+       } while ((++__tp_probe)->func);                                                 \
 end:                                                                                   \
-       rcu_read_unlock_bp();                                                           \
+       tp_rcu_read_unlock_bp();                                                        \
 }                                                                                      \
-static inline void __tracepoint_register_##provider##_##name(char *name,               \
-               void *callback, void *priv)                                             \
+static inline void __tracepoint_register_##provider##___##name(char *name,             \
+               void *func, void *data)                                                 \
 {                                                                                      \
-       __tracepoint_probe_register(name, callback, data);                              \
+       __tracepoint_probe_register(name, func, data);                                  \
 }                                                                                      \
-static inline void __tracepoint_unregister_##provider##_##name(char *name,             \
-               void *callback, void *priv)                                             \
+static inline void __tracepoint_unregister_##provider##___##name(char *name,           \
+               void *func, void *data)                                                 \
 {                                                                                      \
-       __tracepoint_probe_unregister(name, callback, data);                            \
+       __tracepoint_probe_unregister(name, func, data);                                \
 }
 
+extern int __tracepoint_probe_register(const char *name, void *func, void *data);
+extern int __tracepoint_probe_unregister(const char *name, void *func, void *data);
+
+#ifdef TRACEPOINT_DEFINE
+
 /*
  * Note: to allow PIC code, we need to allow the linker to update the pointers
  * in the __tracepoints_ptrs section.
@@ -148,11 +168,10 @@ static inline void __tracepoint_unregister_##provider##_##name(char *name,                \
                __attribute__((used, section("__tracepoints_ptrs"))) =          \
                        &__tracepoint_##provider##___##name;
 
-extern int __tracepoint_probe_register(const char *name, void *callback, void *priv);
-extern int __tracepoint_probe_unregister(const char *name, void *callback, void *priv);
-extern int tracepoint_register_lib(struct tracepoint * const *tracepoints_start,
+static int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start,
                int tracepoints_count);
-extern int tracepoint_unregister_lib(struct tracepoint * const *tracepoints_start);
+static int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start);
+static void *liblttngust_handle;
 
 /*
  * These weak symbols, the constructor, and destructor take care of
@@ -170,6 +189,32 @@ static void __attribute__((constructor)) __tracepoints__init(void)
 {
        if (__tracepoint_registered++)
                return;
+
+       liblttngust_handle = dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
+       if (!liblttngust_handle)
+               return;
+       tracepoint_register_lib =
+               URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int),
+                               dlsym(liblttngust_handle,
+                                       "tracepoint_register_lib"));
+       tracepoint_unregister_lib =
+               URCU_FORCE_CAST(int (*)(struct tracepoint * const *),
+                               dlsym(liblttngust_handle,
+                                       "tracepoint_unregister_lib"));
+#ifndef _LGPL_SOURCE
+       tp_rcu_read_lock_bp =
+               URCU_FORCE_CAST(void (*)(void),
+                               dlsym(liblttngust_handle,
+                                       "tp_rcu_read_lock_bp"));
+       tp_rcu_read_unlock_bp =
+               URCU_FORCE_CAST(void (*)(void),
+                               dlsym(liblttngust_handle,
+                                       "tp_rcu_read_unlock_bp"));
+       tp_rcu_dereference_sym_bp =
+               URCU_FORCE_CAST(void *(*)(void *p),
+                               dlsym(liblttngust_handle,
+                                       "tp_rcu_dereference_sym_bp"));
+#endif
        tracepoint_register_lib(__start___tracepoints_ptrs,
                                __stop___tracepoints_ptrs -
                                __start___tracepoints_ptrs);
@@ -177,11 +222,25 @@ static void __attribute__((constructor)) __tracepoints__init(void)
 
 static void __attribute__((destructor)) __tracepoints__destroy(void)
 {
+       int ret;
        if (--__tracepoint_registered)
                return;
-       tracepoint_unregister_lib(__start___tracepoints_ptrs);
+       if (tracepoint_unregister_lib)
+               tracepoint_unregister_lib(__start___tracepoints_ptrs);
+       if (liblttngust_handle) {
+               tracepoint_unregister_lib = NULL;
+               tracepoint_register_lib = NULL;
+               ret = dlclose(liblttngust_handle);
+               assert(!ret);
+       }
 }
 
+#else /* TRACEPOINT_DEFINE */
+
+#define _DEFINE_TRACEPOINT(provider, name)
+
+#endif /* #else TRACEPOINT_DEFINE */
+
 #ifdef __cplusplus
 }
 #endif
@@ -271,70 +330,111 @@ static void __attribute__((destructor)) __tracepoints__destroy(void)
  * the provider:event identifier is limited to 127 characters.
  */
 
-
 #define TRACEPOINT_EVENT(provider, name, args, fields)                 \
-       _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))
+       _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
+       _DEFINE_TRACEPOINT(provider, name)
 
 #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
 
 #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args)     \
-       _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))
+       _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
+       _DEFINE_TRACEPOINT(provider, name)
 
 #endif /* #ifndef TRACEPOINT_EVENT */
 
 #ifndef TRACEPOINT_LOGLEVEL
 
 /*
- * Tracepoint Loglevel Declaration Facility
- *
- * This is a place-holder the tracepoint loglevel declaration,
- * overridden by the tracer implementation.
+ * Tracepoint Loglevels
  *
  * Typical use of these loglevels:
  *
- * 1) Declare the mapping between loglevel names and an integer values
- *    within TRACEPOINT_LOGLEVEL_ENUM, using TP_LOGLEVEL for each tuple.
- *    Do _NOT_ add comma (,) nor semicolon (;) between the
- *    TRACEPOINT_LOGLEVEL_ENUM entries. Do _NOT_ add comma (,) nor
- *    semicolon (;) after the TRACEPOINT_LOGLEVEL_ENUM declaration.  The
- *    name should be a proper C99 identifier.
- *
- *      TRACEPOINT_LOGLEVEL_ENUM(
- *              TP_LOGLEVEL( < loglevel_name >, < value > )
- *              TP_LOGLEVEL( < loglevel_name >, < value > )
- *              ...
- *      )
- *
- *    e.g.:
- *
- *      TRACEPOINT_LOGLEVEL_ENUM(
- *              TP_LOGLEVEL(LOG_EMERG,   0)
- *              TP_LOGLEVEL(LOG_ALERT,   1)
- *              TP_LOGLEVEL(LOG_CRIT,    2)
- *              TP_LOGLEVEL(LOG_ERR,     3)
- *              TP_LOGLEVEL(LOG_WARNING, 4)
- *              TP_LOGLEVEL(LOG_NOTICE,  5)
- *              TP_LOGLEVEL(LOG_INFO,    6)
- *              TP_LOGLEVEL(LOG_DEBUG,   7)
- *      )
- *
- * 2) Then, declare tracepoint loglevels for tracepoints. A
- *    TRACEPOINT_EVENT should be declared prior to the the
- *    TRACEPOINT_LOGLEVEL for a given tracepoint name. The first field
- *    is the name of the tracepoint, the second field is the loglevel
- *    name.
+ * The loglevels go from 0 to 15. Higher numbers imply the most
+ * verbosity (higher event throughput expected.
+ *
+ * Loglevels 0 through 6, and loglevel 15, match syslog(3) loglevels
+ * semantic. Loglevels 7 through 14 offer more fine-grained selection of
+ * traced information.
+ *
+ * TRACE_EMERG    0
+ * system is unusable
+ *
+ * TRACE_ALERT    1
+ * action must be taken immediately
+ *
+ * TRACE_CRIT     2
+ * critical conditions
+ *
+ * TRACE_ERR      3
+ * error conditions
+ *
+ * TRACE_WARNING  4
+ * warning conditions
+ *
+ * TRACE_NOTICE   5
+ * normal, but significant, condition
+ *
+ * TRACE_INFO     6
+ * informational message
+ *
+ * TRACE_SYSTEM   7
+ * information has system-level scope (set of programs)
+ *
+ * TRACE_PROGRAM  8
+ * information has program-level scope (set of processes)
+ *
+ * TRACE_PROCESS  9
+ * information has process-level scope (set of modules)
+ *
+ * TRACE_MODULE   10
+ * information has module (executable/library) scope (set of units)
+ *
+ * TRACE_UNIT     11
+ * information has compilation unit scope (set of functions)
+ *
+ * TRACE_FUNCTION 12
+ * information has function-level scope
+ *
+ * TRACE_DEFAULT  13
+ * default trace loglevel (TRACEPOINT_EVENT default)
+ *
+ * TRACE_VERBOSE  14
+ * verbose information
+ *
+ * TRACE_DEBUG    15
+ * debug-level message (trace_printf default)
+ *
+ * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
+ * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
+ * tracepoint name. The first field is the name of the tracepoint, the
+ * second field is the loglevel name.
  *
  *      TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
  *              < loglevel_name >)
  *
- * The TRACEPOINT_PROVIDER must be defined when declaring a
- * TRACEPOINT_LOGLEVEL_ENUM and TRACEPOINT_LOGLEVEL. The tracepoint
- * loglevel enumeration apply to the entire TRACEPOINT_PROVIDER. Only one
- * tracepoint loglevel enumeration should be declared per tracepoint
- * provider.
+ * The TRACEPOINT_PROVIDER must be already declared before declaring a
+ * TRACEPOINT_LOGLEVEL.
  */
 
-#define TRACEPOINT_LOGLEVEL_ENUM()
-#define TRACEPOINT_LOGLEVEL(name, loglevel)
+enum {
+       TRACE_EMERG     = 0,
+       TRACE_ALERT     = 1,
+       TRACE_CRIT      = 2,
+       TRACE_ERR       = 3,
+       TRACE_WARNING   = 4,
+       TRACE_NOTICE    = 5,
+       TRACE_INFO      = 6,
+       TRACE_SYSTEM    = 7,
+       TRACE_PROGRAM   = 8,
+       TRACE_PROCESS   = 9,
+       TRACE_MODULE    = 10,
+       TRACE_UNIT      = 11,
+       TRACE_FUNCTION  = 12,
+       TRACE_DEFAULT   = 13,
+       TRACE_VERBOSE   = 14,
+       TRACE_DEBUG     = 15,
+};
+
+#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
 
 #endif /* #ifndef TRACEPOINT_LOGLEVEL */
This page took 0.030112 seconds and 4 git commands to generate.