include/lttng/tracepoint.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (C) 2011-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   5  */
   6
   7 #ifndef _LTTNG_TRACEPOINT_H
   8 #define _LTTNG_TRACEPOINT_H
   9
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <lttng/tracepoint-types.h>
  13 #include <lttng/tracepoint-rcu.h>
  14 #include <urcu/compiler.h>
  15 #include <urcu/system.h>
  16 #include <dlfcn.h>      /* for dlopen */
  17 #include <string.h>     /* for memset */
  18
  19 #include <lttng/ust-config.h>   /* for sdt */
  20 #include <lttng/ust-compiler.h>
  21 #include <lttng/ust-tracer.h>
  22 #include <lttng/ust-api-compat.h>
  23
  24 #define LTTNG_UST_TRACEPOINT_NAME_LEN_MAX       256
  25
  26 #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
  27 /*
  28  * Instead of using SDT_USE_VARIADIC from 'sys/sdt.h', use our own namespaced
  29  * macros since the instrumented application might already have included
  30  * 'sys/sdt.h' without variadic support.
  31  */
  32 #include <sys/sdt.h>
  33
  34 #define LTTNG_UST__SDT_NARG(...) \
  35         LTTNG_UST___SDT_NARG(__VA_ARGS__, 12,11,10,9,8,7,6,5,4,3,2,1,0)
  36
  37 #define LTTNG_UST___SDT_NARG(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12, N, ...) N
  38
  39 #define LTTNG_UST__SDT_PROBE_N(provider, name, N, ...) \
  40         _SDT_PROBE(provider, name, N, (__VA_ARGS__))
  41
  42 #define LTTNG_UST_STAP_PROBEV(provider, name, ...) \
  43         LTTNG_UST__SDT_PROBE_N(provider, name, LTTNG_UST__SDT_NARG(0, ##__VA_ARGS__), ##__VA_ARGS__)
  44
  45 #else
  46 #define LTTNG_UST_STAP_PROBEV(...)
  47 #endif
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 #define lttng_ust_tracepoint_enabled(provider, name)                            \
  54         caa_unlikely(CMM_LOAD_SHARED(lttng_ust_tracepoint_##provider##___##name.state))
  55
  56 #define lttng_ust_do_tracepoint(provider, name, ...)                            \
  57         lttng_ust_tracepoint_cb_##provider##___##name(__VA_ARGS__)
  58
  59 #define lttng_ust_tracepoint(provider, name, ...)                               \
  60         do {                                                                    \
  61                 LTTNG_UST_STAP_PROBEV(provider, name, ## __VA_ARGS__);          \
  62                 if (lttng_ust_tracepoint_enabled(provider, name))               \
  63                         lttng_ust_do_tracepoint(provider, name, __VA_ARGS__);   \
  64         } while (0)
  65
  66 #define LTTNG_UST_TP_ARGS(...)       __VA_ARGS__
  67
  68 /*
  69  * LTTNG_UST_TP_ARGS takes tuples of type, argument separated by a comma.
  70  * It can take up to 10 tuples (which means that less than 10 tuples is
  71  * fine too).
  72  * Each tuple is also separated by a comma.
  73  */
  74 #define LTTNG_UST___TP_COMBINE_TOKENS(_tokena, _tokenb)                         \
  75                 _tokena##_tokenb
  76 #define LTTNG_UST__TP_COMBINE_TOKENS(_tokena, _tokenb)                          \
  77                 LTTNG_UST___TP_COMBINE_TOKENS(_tokena, _tokenb)
  78 #define LTTNG_UST___TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                       \
  79                 _tokena##_tokenb##_tokenc
  80 #define LTTNG_UST__TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                        \
  81                 LTTNG_UST___TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
  82 #define LTTNG_UST___TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)      \
  83                 _tokena##_tokenb##_tokenc##_tokend
  84 #define LTTNG_UST__TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)               \
  85                 LTTNG_UST___TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
  86
  87 /*
  88  * LTTNG_UST__TP_EXVAR* extract the var names.
  89  * LTTNG_UST__TP_EXVAR1 and LTTNG_UST__TP_EXDATA_VAR1 are needed for -std=c99.
  90  */
  91 #define LTTNG_UST__TP_EXVAR0()
  92 #define LTTNG_UST__TP_EXVAR1(a)
  93 #define LTTNG_UST__TP_EXVAR2(a,b)                                               b
  94 #define LTTNG_UST__TP_EXVAR4(a,b,c,d)                                   b,d
  95 #define LTTNG_UST__TP_EXVAR6(a,b,c,d,e,f)                                       b,d,f
  96 #define LTTNG_UST__TP_EXVAR8(a,b,c,d,e,f,g,h)                           b,d,f,h
  97 #define LTTNG_UST__TP_EXVAR10(a,b,c,d,e,f,g,h,i,j)                      b,d,f,h,j
  98 #define LTTNG_UST__TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l)                  b,d,f,h,j,l
  99 #define LTTNG_UST__TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)              b,d,f,h,j,l,n
 100 #define LTTNG_UST__TP_EXVAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)          b,d,f,h,j,l,n,p
 101 #define LTTNG_UST__TP_EXVAR18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)      b,d,f,h,j,l,n,p,r
 102 #define LTTNG_UST__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
 103
 104 #define LTTNG_UST__TP_EXDATA_VAR0()                                             __tp_data
 105 #define LTTNG_UST__TP_EXDATA_VAR1(a)                                            __tp_data
 106 #define LTTNG_UST__TP_EXDATA_VAR2(a,b)                                          __tp_data,b
 107 #define LTTNG_UST__TP_EXDATA_VAR4(a,b,c,d)                                      __tp_data,b,d
 108 #define LTTNG_UST__TP_EXDATA_VAR6(a,b,c,d,e,f)                                  __tp_data,b,d,f
 109 #define LTTNG_UST__TP_EXDATA_VAR8(a,b,c,d,e,f,g,h)                              __tp_data,b,d,f,h
 110 #define LTTNG_UST__TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j)                         __tp_data,b,d,f,h,j
 111 #define LTTNG_UST__TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l)                     __tp_data,b,d,f,h,j,l
 112 #define LTTNG_UST__TP_EXDATA_VAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)                 __tp_data,b,d,f,h,j,l,n
 113 #define LTTNG_UST__TP_EXDATA_VAR16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)             __tp_data,b,d,f,h,j,l,n,p
 114 #define LTTNG_UST__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
 115 #define LTTNG_UST__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
 116
 117 /*
 118  * LTTNG_UST__TP_EXPROTO* extract tuples of type, var.
 119  * LTTNG_UST__TP_EXPROTO1 and LTTNG_UST__TP_EXDATA_PROTO1 are needed for -std=c99.
 120  */
 121 #define LTTNG_UST__TP_EXPROTO0()                                                void
 122 #define LTTNG_UST__TP_EXPROTO1(a)                                               void
 123 #define LTTNG_UST__TP_EXPROTO2(a,b)                                     a b
 124 #define LTTNG_UST__TP_EXPROTO4(a,b,c,d)                                 a b,c d
 125 #define LTTNG_UST__TP_EXPROTO6(a,b,c,d,e,f)                             a b,c d,e f
 126 #define LTTNG_UST__TP_EXPROTO8(a,b,c,d,e,f,g,h)                         a b,c d,e f,g h
 127 #define LTTNG_UST__TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j)                    a b,c d,e f,g h,i j
 128 #define LTTNG_UST__TP_EXPROTO12(a,b,c,d,e,f,g,h,i,j,k,l)                        a b,c d,e f,g h,i j,k l
 129 #define LTTNG_UST__TP_EXPROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)            a b,c d,e f,g h,i j,k l,m n
 130 #define LTTNG_UST__TP_EXPROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)                a b,c d,e f,g h,i j,k l,m n,o p
 131 #define LTTNG_UST__TP_EXPROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)    a b,c d,e f,g h,i j,k l,m n,o p,q r
 132 #define LTTNG_UST__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
 133
 134 #define LTTNG_UST__TP_EXDATA_PROTO0()                                           void *__tp_data
 135 #define LTTNG_UST__TP_EXDATA_PROTO1(a)                                          void *__tp_data
 136 #define LTTNG_UST__TP_EXDATA_PROTO2(a,b)                                                void *__tp_data,a b
 137 #define LTTNG_UST__TP_EXDATA_PROTO4(a,b,c,d)                                    void *__tp_data,a b,c d
 138 #define LTTNG_UST__TP_EXDATA_PROTO6(a,b,c,d,e,f)                                        void *__tp_data,a b,c d,e f
 139 #define LTTNG_UST__TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h)                            void *__tp_data,a b,c d,e f,g h
 140 #define LTTNG_UST__TP_EXDATA_PROTO10(a,b,c,d,e,f,g,h,i,j)                               void *__tp_data,a b,c d,e f,g h,i j
 141 #define LTTNG_UST__TP_EXDATA_PROTO12(a,b,c,d,e,f,g,h,i,j,k,l)                   void *__tp_data,a b,c d,e f,g h,i j,k l
 142 #define LTTNG_UST__TP_EXDATA_PROTO14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)                       void *__tp_data,a b,c d,e f,g h,i j,k l,m n
 143 #define LTTNG_UST__TP_EXDATA_PROTO16(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p)           void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p
 144 #define LTTNG_UST__TP_EXDATA_PROTO18(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r)               void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r
 145 #define LTTNG_UST__TP_EXDATA_PROTO20(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t)   void *__tp_data,a b,c d,e f,g h,i j,k l,m n,o p,q r,s t
 146
 147 /* Preprocessor trick to count arguments. Inspired from sdt.h. */
 148 #define LTTNG_UST__TP_NARGS(...)                LTTNG_UST___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)
 149 #define LTTNG_UST___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
 150 #define LTTNG_UST__TP_PROTO_N(N, ...)           LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXPROTO, N)(__VA_ARGS__))
 151 #define LTTNG_UST__TP_VAR_N(N, ...)             LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXVAR, N)(__VA_ARGS__))
 152 #define LTTNG_UST__TP_DATA_PROTO_N(N, ...)      LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXDATA_PROTO, N)(__VA_ARGS__))
 153 #define LTTNG_UST__TP_DATA_VAR_N(N, ...)        LTTNG_UST__TP_PARAMS(LTTNG_UST__TP_COMBINE_TOKENS(LTTNG_UST__TP_EXDATA_VAR, N)(__VA_ARGS__))
 154 #define LTTNG_UST__TP_ARGS_PROTO(...)           LTTNG_UST__TP_PROTO_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 155 #define LTTNG_UST__TP_ARGS_VAR(...)             LTTNG_UST__TP_VAR_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 156 #define LTTNG_UST__TP_ARGS_DATA_PROTO(...)      LTTNG_UST__TP_DATA_PROTO_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 157 #define LTTNG_UST__TP_ARGS_DATA_VAR(...)        LTTNG_UST__TP_DATA_VAR_N(LTTNG_UST__TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 158 #define LTTNG_UST__TP_PARAMS(...)               __VA_ARGS__
 159
 160 /*
 161  * sizeof(#_provider) - 1 : length of the provider string (excluding \0).
 162  * sizeof(#_name) - 1     : length of the name string (excluding \0).
 163  * + 1                    : separator between provider and event name.
 164  *
 165  * Upper bound (inclusive) is LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1 to
 166  * account for \0.
 167  *
 168  * The comparison is:
 169  *   left hand side:   sizeof(#_provider) - 1 + sizeof(#_name) - 1 + 1
 170  *   right hand side:  LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1
 171  *   operator:         <=  (inclusive)
 172  * Simplified in the code below.
 173  */
 174 #define lttng_ust_tracepoint_validate_name_len(_provider, _name)                                                \
 175         lttng_ust_static_assert(sizeof(#_provider) + sizeof(#_name) <= LTTNG_UST_TRACEPOINT_NAME_LEN_MAX,       \
 176                 "Tracepoint name length is too long",                                                           \
 177                 Tracepoint_name_length_is_too_long)
 178
 179 /*
 180  * The tracepoint cb is marked always inline so we can distinguish
 181  * between caller's ip addresses within the probe using the return
 182  * address.
 183  */
 184 #define LTTNG_UST__DECLARE_TRACEPOINT(_provider, _name, ...)                                    \
 185 extern struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name;                \
 186 static inline                                                                           \
 187 void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__))             \
 188         __attribute__((always_inline, unused)) lttng_ust_notrace;                       \
 189 static                                                                                  \
 190 void lttng_ust_tracepoint_cb_##_provider##___##_name(LTTNG_UST__TP_ARGS_PROTO(__VA_ARGS__))             \
 191 {                                                                                       \
 192         struct lttng_ust_tracepoint_probe *__tp_probe;                                  \
 193                                                                                         \
 194         if (caa_unlikely(!LTTNG_UST_TP_RCU_LINK_TEST()))                                                \
 195                 return;                                                                 \
 196         lttng_ust_tp_rcu_read_lock();                                                           \
 197         __tp_probe = lttng_ust_tp_rcu_dereference(lttng_ust_tracepoint_##_provider##___##_name.probes); \
 198         if (caa_unlikely(!__tp_probe))                                                  \
 199                 goto end;                                                               \
 200         do {                                                                            \
 201                 void (*__tp_cb)(void) = __tp_probe->func;                               \
 202                 void *__tp_data = __tp_probe->data;                                     \
 203                                                                                         \
 204                 URCU_FORCE_CAST(void (*)(LTTNG_UST__TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb)  \
 205                                 (LTTNG_UST__TP_ARGS_DATA_VAR(__VA_ARGS__));                     \
 206         } while ((++__tp_probe)->func);                                                 \
 207 end:                                                                                    \
 208         lttng_ust_tp_rcu_read_unlock();                                                         \
 209 }                                                                                       \
 210 static inline                                                                           \
 211 void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \
 212                 void (*func)(void), void *data)                                         \
 213         lttng_ust_notrace;                                                              \
 214 static inline                                                                           \
 215 void lttng_ust_tracepoint_register_##_provider##___##_name(char *provider_name, char *event_name, \
 216                 void (*func)(void), void *data)                                         \
 217 {                                                                                       \
 218         lttng_ust_tracepoint_probe_register(provider_name, event_name, func, data,              \
 219                 lttng_ust_tracepoint_##_provider##___##_name.signature);                        \
 220 }                                                                                       \
 221 static inline                                                                           \
 222 void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \
 223                 void (*func)(void), void *data)                                         \
 224         lttng_ust_notrace;                                                              \
 225 static inline                                                                           \
 226 void lttng_ust_tracepoint_unregister_##_provider##___##_name(char *provider_name, char *event_name, \
 227                 void (*func)(void), void *data)                                         \
 228 {                                                                                       \
 229         lttng_ust_tracepoint_probe_unregister(provider_name, event_name, func, data);           \
 230 }
 231
 232 extern int lttng_ust_tracepoint_probe_register(const char *provider_name, const char *event_name,
 233                 void (*func)(void), void *data, const char *signature);
 234 extern int lttng_ust_tracepoint_probe_unregister(const char *provider_name, const char *event_name,
 235                 void (*func)(void), void *data);
 236
 237 /*
 238  * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
 239  * shared across objects in a module/main executable.
 240  *
 241  * IMPORTANT: this structure is part of the ABI between instrumented
 242  * applications and UST. Fields need to be only added at the end, never
 243  * reordered, never removed.
 244  *
 245  * The field @struct_size should be used to determine the size of the
 246  * structure. It should be queried before using additional fields added
 247  * at the end of the structure.
 248  */
 249 struct lttng_ust_tracepoint_dlopen {
 250         uint32_t struct_size;
 251
 252         void *liblttngust_handle;
 253
 254         int (*lttng_ust_tracepoint_register_lib)(struct lttng_ust_tracepoint * const *tracepoints_start,
 255                 int tracepoints_count);
 256         int (*lttng_ust_tracepoint_unregister_lib)(struct lttng_ust_tracepoint * const *tracepoints_start);
 257         void (*rcu_read_lock_sym)(void);
 258         void (*rcu_read_unlock_sym)(void);
 259         void *(*rcu_dereference_sym)(void *p);
 260
 261         /* End of base ABI. Fields below should be used after checking struct_size. */
 262 };
 263
 264 extern struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen;
 265 extern struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr;
 266
 267 /*
 268  * These weak symbols, the constructor, and destructor take care of
 269  * registering only _one_ instance of the tracepoints per shared-ojbect
 270  * (or for the whole main program).
 271  */
 272 int lttng_ust_tracepoint_registered
 273         __attribute__((weak, visibility("hidden")));
 274 int lttng_ust_tracepoint_ptrs_registered
 275         __attribute__((weak, visibility("hidden")));
 276 struct lttng_ust_tracepoint_dlopen lttng_ust_tracepoint_dlopen
 277                 __attribute__((weak, visibility("hidden"))) = {
 278         .struct_size = sizeof(struct lttng_ust_tracepoint_dlopen),
 279 };
 280 /*
 281  * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc
 282  * 4.8 and prior does not have the same behavior for symbol scoping on
 283  * 32-bit powerpc depending on the object size: symbols for objects of 8
 284  * bytes or less have the same address throughout a module, whereas they
 285  * have different addresses between compile units for objects larger
 286  * than 8 bytes. Add this pointer indirection to ensure that the symbol
 287  * scoping match that of the other weak hidden symbols found in this
 288  * header.
 289  */
 290 struct lttng_ust_tracepoint_dlopen *lttng_ust_tracepoint_dlopen_ptr
 291         __attribute__((weak, visibility("hidden")));
 292
 293 /*
 294  * Tracepoint dynamic linkage handling (callbacks). Hidden visibility: shared
 295  * across objects in a module/main executable. The callbacks are used to
 296  * control and check if the destructors should be executed.
 297  *
 298  * IMPORTANT: this structure is part of the ABI between instrumented
 299  * applications and UST. Fields need to be only added at the end, never
 300  * reordered, never removed.
 301  *
 302  * The field @struct_size should be used to determine the size of the
 303  * structure. It should be queried before using additional fields added
 304  * at the end of the structure.
 305  */
 306 struct lttng_ust_tracepoint_destructors_syms {
 307         uint32_t struct_size;
 308
 309         void (*tracepoint_disable_destructors)(void);
 310         int (*tracepoint_get_destructors_state)(void);
 311
 312         /* End of base ABI. Fields below should be used after checking struct_size. */
 313 };
 314
 315 extern struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms;
 316 extern struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr;
 317
 318 struct lttng_ust_tracepoint_destructors_syms lttng_ust_tracepoint_destructors_syms
 319         __attribute__((weak, visibility("hidden"))) = {
 320         .struct_size = sizeof(struct lttng_ust_tracepoint_destructors_syms),
 321 };
 322 struct lttng_ust_tracepoint_destructors_syms *lttng_ust_tracepoint_destructors_syms_ptr
 323         __attribute__((weak, visibility("hidden")));
 324
 325 static inline void tracepoint_disable_destructors(void)
 326 {
 327         if (!lttng_ust_tracepoint_dlopen_ptr)
 328                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 329         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 330                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 331         if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle
 332                         && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors)
 333                 lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors();
 334 }
 335
 336 #ifndef _LGPL_SOURCE
 337 static inline void
 338 lttng_ust_tracepoint__init_urcu_sym(void)
 339         lttng_ust_notrace;
 340 static inline void
 341 lttng_ust_tracepoint__init_urcu_sym(void)
 342 {
 343         if (!lttng_ust_tracepoint_dlopen_ptr)
 344                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 345         /*
 346          * Symbols below are needed by tracepoint call sites and probe
 347          * providers.
 348          */
 349         if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym)
 350                 lttng_ust_tracepoint_dlopen_ptr->rcu_read_lock_sym =
 351                         URCU_FORCE_CAST(void (*)(void),
 352                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 353                                         "lttng_ust_tp_rcu_read_lock"));
 354         if (!lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym)
 355                 lttng_ust_tracepoint_dlopen_ptr->rcu_read_unlock_sym =
 356                         URCU_FORCE_CAST(void (*)(void),
 357                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 358                                         "lttng_ust_tp_rcu_read_unlock"));
 359         if (!lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym)
 360                 lttng_ust_tracepoint_dlopen_ptr->rcu_dereference_sym =
 361                         URCU_FORCE_CAST(void *(*)(void *p),
 362                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 363                                         "lttng_ust_tp_rcu_dereference_sym"));
 364 }
 365 #else
 366 static inline void
 367 lttng_ust_tracepoint__init_urcu_sym(void)
 368         lttng_ust_notrace;
 369 static inline void
 370 lttng_ust_tracepoint__init_urcu_sym(void)
 371 {
 372 }
 373 #endif
 374
 375 static void
 376 lttng_ust__tracepoints__init(void)
 377         lttng_ust_notrace __attribute__((constructor));
 378 static void
 379 lttng_ust__tracepoints__init(void)
 380 {
 381         if (lttng_ust_tracepoint_registered++) {
 382                 if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 383                         return;
 384                 lttng_ust_tracepoint__init_urcu_sym();
 385                 return;
 386         }
 387
 388         if (!lttng_ust_tracepoint_dlopen_ptr)
 389                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 390         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 391                 lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle =
 392                         dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
 393         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 394                 return;
 395         lttng_ust_tracepoint__init_urcu_sym();
 396 }
 397
 398 static void
 399 lttng_ust__tracepoints__destroy(void)
 400         lttng_ust_notrace __attribute__((destructor));
 401 static void
 402 lttng_ust__tracepoints__destroy(void)
 403 {
 404         int ret;
 405
 406         if (--lttng_ust_tracepoint_registered)
 407                 return;
 408         if (!lttng_ust_tracepoint_dlopen_ptr)
 409                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 410         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 411                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 412         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 413                 return;
 414         if (lttng_ust_tracepoint_ptrs_registered)
 415                 return;
 416         /*
 417          * Lookup if destructors must be executed using the new method.
 418          */
 419         if (lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
 420                 && !lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()) {
 421                 /*
 422                  * The tracepoint_get_destructors_state symbol was found with
 423                  * dlsym but its returned value is 0 meaning that destructors
 424                  * must not be executed.
 425                  */
 426                 return;
 427         }
 428         ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle);
 429         if (ret) {
 430                 fprintf(stderr, "Error (%d) in dlclose\n", ret);
 431                 abort();
 432         }
 433         memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr));
 434 }
 435
 436 #if LTTNG_UST_COMPAT_API(0)
 437 # if defined(TRACEPOINT_DEFINE) && !defined(LTTNG_UST_TRACEPOINT_DEFINE)
 438 #  define LTTNG_UST_TRACEPOINT_DEFINE
 439 # endif
 440 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 441
 442 #ifdef LTTNG_UST_TRACEPOINT_DEFINE
 443
 444 /*
 445  * These weak symbols, the constructor, and destructor take care of
 446  * registering only _one_ instance of the tracepoints per shared-ojbect
 447  * (or for the whole main program).
 448  */
 449 extern struct lttng_ust_tracepoint * const __start_lttng_ust_tracepoints_ptrs[]
 450         __attribute__((weak, visibility("hidden")));
 451 extern struct lttng_ust_tracepoint * const __stop_lttng_ust_tracepoints_ptrs[]
 452         __attribute__((weak, visibility("hidden")));
 453
 454 /*
 455  * When LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
 456  * unresolved symbol that requires the provider to be linked in. When
 457  * LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
 458  * unresolved symbol that depends on having the provider linked in,
 459  * otherwise the linker complains. This deals with use of static
 460  * libraries, ensuring that the linker does not remove the provider
 461  * object from the executable.
 462  */
 463
 464 #if LTTNG_UST_COMPAT_API(0)
 465 # if defined(TRACEPOINT_PROBE_DYNAMIC_LINKAGE) && !defined(LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE)
 466 #  define LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
 467 # endif
 468 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 469
 470 #ifdef LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE
 471 #define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider)   NULL
 472 #else   /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 473 #define LTTNG_UST__TRACEPOINT_UNDEFINED_REF(provider)   &lttng_ust_tracepoint_provider_##provider
 474 #endif /* LTTNG_UST_TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 475
 476 /*
 477  * Note: to allow PIC code, we need to allow the linker to update the pointers
 478  * in the lttng_ust_tracepoints_ptrs section.
 479  * Therefore, this section is _not_ const (read-only).
 480  */
 481 #define LTTNG_UST__TP_EXTRACT_STRING(...)       #__VA_ARGS__
 482
 483 #define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args)                           \
 484         lttng_ust_tracepoint_validate_name_len(_provider, _name);               \
 485         extern int lttng_ust_tracepoint_provider_##_provider;                           \
 486         static const char lttng_ust_tp_provider_strtab_##_provider##___##_name[]        \
 487                 __attribute__((section("lttng_ust_tracepoints_strings"))) =             \
 488                         #_provider;                                             \
 489         static const char lttng_ust_tp_name_strtab_##_provider##___##_name[]            \
 490                 __attribute__((section("lttng_ust_tracepoints_strings"))) =             \
 491                         #_name;                                                 \
 492         struct lttng_ust_tracepoint lttng_ust_tracepoint_##_provider##___##_name        \
 493                 __attribute__((section("lttng_ust_tracepoints"))) = {                   \
 494                         sizeof(struct lttng_ust_tracepoint),                    \
 495                         lttng_ust_tp_provider_strtab_##_provider##___##_name,           \
 496                         lttng_ust_tp_name_strtab_##_provider##___##_name,               \
 497                         0,                                                      \
 498                         NULL,                                                   \
 499                         LTTNG_UST__TRACEPOINT_UNDEFINED_REF(_provider),         \
 500                         LTTNG_UST__TP_EXTRACT_STRING(_args),                    \
 501                 };                                                              \
 502         static struct lttng_ust_tracepoint *                                    \
 503                 lttng_ust_tracepoint_ptr_##_provider##___##_name                        \
 504                 __attribute__((section("lttng_ust_tracepoints_ptrs"), used))            \
 505                 __lttng_ust_variable_attribute_no_sanitize_address =            \
 506                         &lttng_ust_tracepoint_##_provider##___##_name;
 507
 508 static void
 509 lttng_ust__tracepoints__ptrs_init(void)
 510         lttng_ust_notrace __attribute__((constructor));
 511 static void
 512 lttng_ust__tracepoints__ptrs_init(void)
 513 {
 514         if (lttng_ust_tracepoint_ptrs_registered++)
 515                 return;
 516         if (!lttng_ust_tracepoint_dlopen_ptr)
 517                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 518         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 519                 lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle =
 520                         dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
 521         if (!lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle)
 522                 return;
 523         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 524                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 525         lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib =
 526                 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int),
 527                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 528                                         "lttng_ust_tracepoint_register_lib"));
 529         lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib =
 530                 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *),
 531                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 532                                         "lttng_ust_tracepoint_unregister_lib"));
 533         lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_disable_destructors =
 534                 URCU_FORCE_CAST(void (*)(void),
 535                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 536                                         "lttng_ust_tp_disable_destructors"));
 537         lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state =
 538                 URCU_FORCE_CAST(int (*)(void),
 539                                 dlsym(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle,
 540                                         "lttng_ust_tp_get_destructors_state"));
 541         lttng_ust_tracepoint__init_urcu_sym();
 542         if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib) {
 543                 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_register_lib(__start_lttng_ust_tracepoints_ptrs,
 544                                 __stop_lttng_ust_tracepoints_ptrs -
 545                                 __start_lttng_ust_tracepoints_ptrs);
 546         }
 547 }
 548
 549 static void
 550 lttng_ust__tracepoints__ptrs_destroy(void)
 551         lttng_ust_notrace __attribute__((destructor));
 552 static void
 553 lttng_ust__tracepoints__ptrs_destroy(void)
 554 {
 555         int ret;
 556
 557         if (--lttng_ust_tracepoint_ptrs_registered)
 558                 return;
 559         if (!lttng_ust_tracepoint_dlopen_ptr)
 560                 lttng_ust_tracepoint_dlopen_ptr = &lttng_ust_tracepoint_dlopen;
 561         if (!lttng_ust_tracepoint_destructors_syms_ptr)
 562                 lttng_ust_tracepoint_destructors_syms_ptr = &lttng_ust_tracepoint_destructors_syms;
 563         if (lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib)
 564                 lttng_ust_tracepoint_dlopen_ptr->lttng_ust_tracepoint_unregister_lib(__start_lttng_ust_tracepoints_ptrs);
 565         if (lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle
 566                         && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
 567                         && lttng_ust_tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()
 568                         && !lttng_ust_tracepoint_ptrs_registered) {
 569                 ret = dlclose(lttng_ust_tracepoint_dlopen_ptr->liblttngust_handle);
 570                 if (ret) {
 571                         fprintf(stderr, "Error (%d) in dlclose\n", ret);
 572                         abort();
 573                 }
 574                 memset(lttng_ust_tracepoint_dlopen_ptr, 0, sizeof(*lttng_ust_tracepoint_dlopen_ptr));
 575         }
 576 }
 577
 578 #else /* LTTNG_UST_TRACEPOINT_DEFINE */
 579
 580 #define LTTNG_UST__DEFINE_TRACEPOINT(_provider, _name, _args)
 581
 582 #endif /* #else LTTNG_UST_TRACEPOINT_DEFINE */
 583
 584 #if LTTNG_UST_COMPAT_API(0)
 585 #define tracepoint                      lttng_ust_tracepoint
 586 #define do_tracepoint                   lttng_ust_do_tracepoint
 587 #define tracepoint_enabled              lttng_ust_tracepoint_enabled
 588 #define TP_ARGS                         LTTNG_UST_TP_ARGS
 589 #define TP_FIELDS                       LTTNG_UST_TP_FIELDS
 590
 591 #define ctf_integer                     lttng_ust_field_integer
 592 #define ctf_integer_hex                 lttng_ust_field_integer_hex
 593 #define ctf_integer_network             lttng_ust_field_integer_network
 594 #define ctf_integer_network_hex         lttng_ust_field_integer_network_hex
 595 #define ctf_integer_nowrite             lttng_ust_field_integer_nowrite
 596
 597 #define ctf_float                       lttng_ust_field_float
 598 #define ctf_float_nowrite               lttng_ust_field_float_nowrite
 599
 600 #define ctf_array                       lttng_ust_field_array
 601 #define ctf_array_hex                   lttng_ust_field_array_hex
 602 #define ctf_array_network               lttng_ust_field_array_network
 603 #define ctf_array_network_hex           lttng_ust_field_array_network_hex
 604 #define ctf_array_text                  lttng_ust_field_array_text
 605 #define ctf_array_nowrite               lttng_ust_field_array_nowrite
 606 #define ctf_array_nowrite_hex           lttng_ust_field_array_nowrite_hex
 607 #define ctf_array_network_nowrite       lttng_ust_field_array_network_nowrite
 608 #define ctf_array_network_nowrite_hex   lttng_ust_field_array_network_nowrite_hex
 609 #define ctf_array_text_nowrite          lttng_ust_field_array_text_nowrite
 610
 611 #define ctf_sequence                    lttng_ust_field_sequence
 612 #define ctf_sequence_hex                lttng_ust_field_sequence_hex
 613 #define ctf_sequence_network            lttng_ust_field_sequence_network
 614 #define ctf_sequence_network_hex        lttng_ust_field_sequence_network_hex
 615 #define ctf_sequence_text               lttng_ust_field_sequence_text
 616 #define ctf_sequence_nowrite            lttng_ust_field_sequence_nowrite
 617 #define ctf_sequence_nowrite_hex        lttng_ust_field_sequence_nowrite_hex
 618 #define ctf_sequence_network_nowrite    lttng_ust_field_sequence_network_nowrite
 619 #define ctf_sequence_network_nowrite_hex lttng_ust_field_sequence_network_nowrite_hex
 620 #define ctf_sequence_text_nowrite       lttng_ust_field_sequence_text_nowrite
 621
 622 #define ctf_string                      lttng_ust_field_string
 623 #define ctf_string_nowrite              lttng_ust_field_string_nowrite
 624
 625 #define ctf_unused                      lttng_ust_field_unused
 626 #define ctf_unused_nowrite              lttng_ust_field_unused_nowrite
 627
 628 #define ctf_enum                        lttng_ust_field_enum
 629 #define ctf_enum_nowrite                lttng_ust_field_enum_nowrite
 630 #define ctf_enum_value                  lttng_ust_field_enum_value
 631 #define ctf_enum_range                  lttng_ust_field_enum_range
 632 #define ctf_enum_auto                   lttng_ust_field_enum_auto
 633 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 634
 635 #ifdef __cplusplus
 636 }
 637 #endif
 638
 639 #endif /* _LTTNG_TRACEPOINT_H */
 640
 641 /* The following declarations must be outside re-inclusion protection. */
 642
 643 #ifndef LTTNG_UST_TRACEPOINT_ENUM
 644
 645 /*
 646  * Tracepoint Enumerations
 647  *
 648  * The enumeration is a mapping between an integer, or range of integers, and
 649  * a string. It can be used to have a more compact trace in cases where the
 650  * possible values for a field are limited:
 651  *
 652  * An example:
 653  *
 654  * LTTNG_UST_TRACEPOINT_ENUM(someproject_component, enumname,
 655  *      LTTNG_UST_TP_ENUM_VALUES(
 656  *              lttng_ust_field_enum_value("even", 0)
 657  *              lttng_ust_field_enum_value("uneven", 1)
 658  *              lttng_ust_field_enum_range("twoto4", 2, 4)
 659  *              lttng_ust_field_enum_value("five", 5)
 660  *      )
 661  * )
 662  *
 663  * Where "someproject_component" is the name of the component this enumeration
 664  * belongs to and "enumname" identifies this enumeration. Inside the
 665  * LTTNG_UST_TP_ENUM_VALUES macro is the actual mapping. Each string value can map
 666  * to either a single value with lttng_ust_field_enum_value or a range of values
 667  * with lttng_ust_field_enum_range.
 668  *
 669  * Enumeration ranges may overlap, but the behavior is implementation-defined,
 670  * each trace reader will handle overlapping as it wishes.
 671  *
 672  * That enumeration can then be used in a field inside the TP_FIELD macro using
 673  * the following line:
 674  *
 675  * lttng_ust_field_enum(someproject_component, enumname, enumtype, enumfield, enumval)
 676  *
 677  * Where "someproject_component" and "enumname" match those in the
 678  * LTTNG_UST_TRACEPOINT_ENUM, "enumtype" is a signed or unsigned integer type
 679  * backing the enumeration, "enumfield" is the name of the field and
 680  * "enumval" is the value.
 681  */
 682
 683 #define LTTNG_UST_TRACEPOINT_ENUM(provider, name, values)
 684
 685 #if LTTNG_UST_COMPAT_API(0)
 686 #define TRACEPOINT_ENUM         LTTNG_UST_TRACEPOINT_ENUM
 687 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 688
 689 #endif /* #ifndef LTTNG_UST_TRACEPOINT_ENUM */
 690
 691 #ifndef LTTNG_UST_TRACEPOINT_EVENT
 692
 693 /*
 694  * How to use the LTTNG_UST_TRACEPOINT_EVENT macro:
 695  *
 696  * An example:
 697  *
 698  * LTTNG_UST_TRACEPOINT_EVENT(someproject_component, event_name,
 699  *
 700  *     * LTTNG_UST_TP_ARGS takes from 0 to 10 "type, field_name" pairs *
 701  *
 702  *     LTTNG_UST_TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
 703  *             long *, arg4, size_t, arg4_len),
 704  *
 705  *      * LTTNG_UST_TP_FIELDS describes the event payload layout in the trace *
 706  *
 707  *     LTTNG_UST_TP_FIELDS(
 708  *         * Integer, printed in base 10 *
 709  *         lttng_ust_field_integer(int, field_a, arg0)
 710  *
 711  *         * Integer, printed with 0x base 16 *
 712  *         lttng_ust_field_integer_hex(unsigned long, field_d, arg1)
 713  *
 714  *         * Enumeration *
 715  *         lttng_ust_field_enum(someproject_component, enum_name, int, field_e, arg0)
 716  *
 717  *         * Array Sequence, printed as UTF8-encoded array of bytes *
 718  *         lttng_ust_field_array_text(char, field_b, string, FIXED_LEN)
 719  *         lttng_ust_field_sequence_text(char, field_c, string, size_t, strlen)
 720  *
 721  *         * String, printed as UTF8-encoded string *
 722  *         lttng_ust_field_string(field_e, string)
 723  *
 724  *         * Array sequence of signed integer values *
 725  *         lttng_ust_field_array(long, field_f, arg4, FIXED_LEN4)
 726  *         lttng_ust_field_sequence(long, field_g, arg4, size_t, arg4_len)
 727  *     )
 728  * )
 729  *
 730  * More detailed explanation:
 731  *
 732  * The name of the tracepoint is expressed as a tuple with the provider
 733  * and name arguments.
 734  *
 735  * The provider and name should be a proper C99 identifier.
 736  * The "provider" and "name" MUST follow these rules to ensure no
 737  * namespace clash occurs:
 738  *
 739  * For projects (applications and libraries) for which an entity
 740  * specific to the project controls the source code and thus its
 741  * tracepoints (typically with a scope larger than a single company):
 742  *
 743  * either:
 744  *   project_component, event
 745  * or:
 746  *   project, event
 747  *
 748  * Where "project" is the name of the project,
 749  *       "component" is the name of the project component (which may
 750  *       include several levels of sub-components, e.g.
 751  *       ...component_subcomponent_...) where the tracepoint is located
 752  *       (optional),
 753  *       "event" is the name of the tracepoint event.
 754  *
 755  * For projects issued from a single company wishing to advertise that
 756  * the company controls the source code and thus the tracepoints, the
 757  * "com_" prefix should be used:
 758  *
 759  * either:
 760  *   com_company_project_component, event
 761  * or:
 762  *   com_company_project, event
 763  *
 764  * Where "company" is the name of the company,
 765  *       "project" is the name of the project,
 766  *       "component" is the name of the project component (which may
 767  *       include several levels of sub-components, e.g.
 768  *       ...component_subcomponent_...) where the tracepoint is located
 769  *       (optional),
 770  *       "event" is the name of the tracepoint event.
 771  *
 772  * the provider:event identifier is limited to 127 characters.
 773  */
 774
 775 #define LTTNG_UST_TRACEPOINT_EVENT(provider, name, args, fields)                        \
 776         LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))               \
 777         LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))
 778
 779 #define LTTNG_UST_TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
 780
 781 #define LTTNG_UST_TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args)    \
 782         LTTNG_UST__DECLARE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))               \
 783         LTTNG_UST__DEFINE_TRACEPOINT(provider, name, LTTNG_UST__TP_PARAMS(args))
 784
 785 #if LTTNG_UST_COMPAT_API(0)
 786 #define TRACEPOINT_EVENT                LTTNG_UST_TRACEPOINT_EVENT
 787 #define TRACEPOINT_EVENT_CLASS          LTTNG_UST_TRACEPOINT_EVENT_CLASS
 788 #define TRACEPOINT_EVENT_INSTANCE       LTTNG_UST_TRACEPOINT_EVENT_INSTANCE
 789 #endif /* #if LTTNG_UST_COMPAT_API(0) */
 790
 791 #endif /* #ifndef LTTNG_UST_TRACEPOINT_EVENT */
 792
 793 #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL
 794
 795 /*
 796  * Tracepoint Loglevels
 797  *
 798  * Typical use of these loglevels:
 799  *
 800  * The loglevels go from 0 to 14. Higher numbers imply the most
 801  * verbosity (higher event throughput expected.
 802  *
 803  * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
 804  * semantic. Loglevels 7 through 13 offer more fine-grained selection of
 805  * debug information.
 806  *
 807  * LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG           0
 808  * system is unusable
 809  *
 810  * LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT           1
 811  * action must be taken immediately
 812  *
 813  * LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT            2
 814  * critical conditions
 815  *
 816  * LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR             3
 817  * error conditions
 818  *
 819  * LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING         4
 820  * warning conditions
 821  *
 822  * LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE          5
 823  * normal, but significant, condition
 824  *
 825  * LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO            6
 826  * informational message
 827  *
 828  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM    7
 829  * debug information with system-level scope (set of programs)
 830  *
 831  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM   8
 832  * debug information with program-level scope (set of processes)
 833  *
 834  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS   9
 835  * debug information with process-level scope (set of modules)
 836  *
 837  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE    10
 838  * debug information with module (executable/library) scope (set of units)
 839  *
 840  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT      11
 841  * debug information with compilation unit scope (set of functions)
 842  *
 843  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION  12
 844  * debug information with function-level scope
 845  *
 846  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE      13
 847  * debug information with line-level scope (LTTNG_UST_TRACEPOINT_EVENT default)
 848  *
 849  * LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG           14
 850  * debug-level message
 851  *
 852  * Declare tracepoint loglevels for tracepoints. A LTTNG_UST_TRACEPOINT_EVENT
 853  * should be declared prior to the the LTTNG_UST_TRACEPOINT_LOGLEVEL for a given
 854  * tracepoint name. The first field is the provider name, the second
 855  * field is the name of the tracepoint, the third field is the loglevel
 856  * name.
 857  *
 858  *      LTTNG_UST_TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
 859  *              < loglevel_name >)
 860  *
 861  * The LTTNG_UST_TRACEPOINT_PROVIDER must be already declared before declaring a
 862  * LTTNG_UST_TRACEPOINT_LOGLEVEL.
 863  */
 864
 865 enum {
 866         LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG             = 0,
 867         LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT             = 1,
 868         LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT              = 2,
 869         LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR               = 3,
 870         LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING           = 4,
 871         LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE            = 5,
 872         LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO              = 6,
 873         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM      = 7,
 874         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM     = 8,
 875         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS     = 9,
 876         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE      = 10,
 877         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT        = 11,
 878         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION    = 12,
 879         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE        = 13,
 880         LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG             = 14,
 881 };
 882
 883 #define LTTNG_UST_TRACEPOINT_LOGLEVEL(provider, name, loglevel)
 884
 885 #if LTTNG_UST_COMPAT_API(0)
 886 #define TRACEPOINT_LOGLEVEL     LTTNG_UST_TRACEPOINT_LOGLEVEL
 887
 888 #define TRACE_EMERG             LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG
 889 #define TRACE_ALERT             LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT
 890 #define TRACE_CRIT              LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT
 891 #define TRACE_ERR               LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR
 892 #define TRACE_WARNING           LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING
 893 #define TRACE_NOTICE            LTTNG_UST_TRACEPOINT_LOGLEVEL_NOTICE
 894 #define TRACE_INFO              LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO
 895 #define TRACE_DEBUG_SYSTEM      LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_SYSTEM
 896 #define TRACE_DEBUG_PROGRAM     LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROGRAM
 897 #define TRACE_DEBUG_PROCESS     LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_PROCESS
 898 #define TRACE_DEBUG_MODULE      LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_MODULE
 899 #define TRACE_DEBUG_UNIT        LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_UNIT
 900 #define TRACE_DEBUG_FUNCTION    LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_FUNCTION
 901 #define TRACE_DEBUG_LINE        LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG_LINE
 902 #define TRACE_DEBUG             LTTNG_UST_TRACEPOINT_LOGLEVEL_DEBUG
 903 #endif
 904
 905 #endif /* #ifndef LTTNG_UST_TRACEPOINT_LOGLEVEL */
 906
 907 #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI
 908
 909 #define LTTNG_UST_TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
 910
 911 #if LTTNG_UST_COMPAT_API(0)
 912 #define TRACEPOINT_MODEL_EMF_URI LTTNG_UST_TRACEPOINT_MODEL_EMF_URI
 913 #endif
 914
 915 #endif /* #ifndef LTTNG_UST_TRACEPOINT_MODEL_EMF_URI */