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
  23 #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
  24 /*
  25  * Instead of using SDT_USE_VARIADIC from 'sys/sdt.h', use our own namespaced
  26  * macros since the instrumented application might already have included
  27  * 'sys/sdt.h' without variadic support.
  28  */
  29 #include <sys/sdt.h>
  30
  31 #define _LTTNG_SDT_NARG(...) \
  32         __LTTNG_SDT_NARG(__VA_ARGS__, 12,11,10,9,8,7,6,5,4,3,2,1,0)
  33
  34 #define __LTTNG_SDT_NARG(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12, N, ...) N
  35
  36 #define _LTTNG_SDT_PROBE_N(provider, name, N, ...) \
  37         _SDT_PROBE(provider, name, N, (__VA_ARGS__))
  38
  39 #define LTTNG_STAP_PROBEV(provider, name, ...) \
  40         _LTTNG_SDT_PROBE_N(provider, name, _LTTNG_SDT_NARG(0, ##__VA_ARGS__), ##__VA_ARGS__)
  41
  42 #else
  43 #define LTTNG_STAP_PROBEV(...)
  44 #endif
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 #define tracepoint_enabled(provider, name) \
  51         caa_unlikely(CMM_LOAD_SHARED(__tracepoint_##provider##___##name.state))
  52
  53 #define do_tracepoint(provider, name, ...) \
  54         __tracepoint_cb_##provider##___##name(__VA_ARGS__)
  55
  56 #define tracepoint(provider, name, ...)                                     \
  57         do {                                                                \
  58                 LTTNG_STAP_PROBEV(provider, name, ## __VA_ARGS__);          \
  59                 if (tracepoint_enabled(provider, name))                     \
  60                         do_tracepoint(provider, name, __VA_ARGS__);         \
  61         } while (0)
  62
  63 #define TP_ARGS(...)       __VA_ARGS__
  64
  65 /*
  66  * TP_ARGS takes tuples of type, argument separated by a comma.
  67  * It can take up to 10 tuples (which means that less than 10 tuples is
  68  * fine too).
  69  * Each tuple is also separated by a comma.
  70  */
  71 #define __TP_COMBINE_TOKENS(_tokena, _tokenb)                           \
  72                 _tokena##_tokenb
  73 #define _TP_COMBINE_TOKENS(_tokena, _tokenb)                            \
  74                 __TP_COMBINE_TOKENS(_tokena, _tokenb)
  75 #define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                 \
  76                 _tokena##_tokenb##_tokenc
  77 #define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                  \
  78                 __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
  79 #define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)        \
  80                 _tokena##_tokenb##_tokenc##_tokend
  81 #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)         \
  82                 __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
  83
  84 /*
  85  * _TP_EXVAR* extract the var names.
  86  * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
  87  */
  88 #define _TP_EXVAR0()
  89 #define _TP_EXVAR1(a)
  90 #define _TP_EXVAR2(a,b)                                         b
  91 #define _TP_EXVAR4(a,b,c,d)                                     b,d
  92 #define _TP_EXVAR6(a,b,c,d,e,f)                                 b,d,f
  93 #define _TP_EXVAR8(a,b,c,d,e,f,g,h)                             b,d,f,h
  94 #define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j)                        b,d,f,h,j
  95 #define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l)                    b,d,f,h,j,l
  96 #define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)                b,d,f,h,j,l,n
  97 #define _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
  98 #define _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
  99 #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
 100
 101 #define _TP_EXDATA_VAR0()                                               __tp_data
 102 #define _TP_EXDATA_VAR1(a)                                              __tp_data
 103 #define _TP_EXDATA_VAR2(a,b)                                            __tp_data,b
 104 #define _TP_EXDATA_VAR4(a,b,c,d)                                        __tp_data,b,d
 105 #define _TP_EXDATA_VAR6(a,b,c,d,e,f)                                    __tp_data,b,d,f
 106 #define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h)                                __tp_data,b,d,f,h
 107 #define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j)                           __tp_data,b,d,f,h,j
 108 #define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l)                       __tp_data,b,d,f,h,j,l
 109 #define _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
 110 #define _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
 111 #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
 112 #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
 113
 114 /*
 115  * _TP_EXPROTO* extract tuples of type, var.
 116  * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
 117  */
 118 #define _TP_EXPROTO0()                                          void
 119 #define _TP_EXPROTO1(a)                                         void
 120 #define _TP_EXPROTO2(a,b)                                       a b
 121 #define _TP_EXPROTO4(a,b,c,d)                                   a b,c d
 122 #define _TP_EXPROTO6(a,b,c,d,e,f)                               a b,c d,e f
 123 #define _TP_EXPROTO8(a,b,c,d,e,f,g,h)                           a b,c d,e f,g h
 124 #define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j)                      a b,c d,e f,g h,i j
 125 #define _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
 126 #define _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
 127 #define _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
 128 #define _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
 129 #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
 130
 131 #define _TP_EXDATA_PROTO0()                                             void *__tp_data
 132 #define _TP_EXDATA_PROTO1(a)                                            void *__tp_data
 133 #define _TP_EXDATA_PROTO2(a,b)                                          void *__tp_data,a b
 134 #define _TP_EXDATA_PROTO4(a,b,c,d)                                      void *__tp_data,a b,c d
 135 #define _TP_EXDATA_PROTO6(a,b,c,d,e,f)                                  void *__tp_data,a b,c d,e f
 136 #define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h)                              void *__tp_data,a b,c d,e f,g h
 137 #define _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
 138 #define _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
 139 #define _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
 140 #define _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
 141 #define _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
 142 #define _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
 143
 144 /* Preprocessor trick to count arguments. Inspired from sdt.h. */
 145 #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)
 146 #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
 147 #define _TP_PROTO_N(N, ...)             _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
 148 #define _TP_VAR_N(N, ...)               _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
 149 #define _TP_DATA_PROTO_N(N, ...)        _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
 150 #define _TP_DATA_VAR_N(N, ...)          _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
 151 #define _TP_ARGS_PROTO(...)             _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 152 #define _TP_ARGS_VAR(...)               _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 153 #define _TP_ARGS_DATA_PROTO(...)        _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 154 #define _TP_ARGS_DATA_VAR(...)          _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 155 #define _TP_PARAMS(...)                 __VA_ARGS__
 156
 157 /*
 158  * The tracepoint cb is marked always inline so we can distinguish
 159  * between caller's ip addresses within the probe using the return
 160  * address.
 161  */
 162 #define _DECLARE_TRACEPOINT(_provider, _name, ...)                                      \
 163 extern struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name;                \
 164 static inline                                                                           \
 165 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__))               \
 166         __attribute__((always_inline, unused)) lttng_ust_notrace;                       \
 167 static                                                                                  \
 168 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__))               \
 169 {                                                                                       \
 170         struct lttng_ust_tracepoint_probe *__tp_probe;                                  \
 171                                                                                         \
 172         if (caa_unlikely(!TP_RCU_LINK_TEST()))                                          \
 173                 return;                                                                 \
 174         tp_rcu_read_lock();                                                             \
 175         __tp_probe = tp_rcu_dereference(__tracepoint_##_provider##___##_name.probes);   \
 176         if (caa_unlikely(!__tp_probe))                                                  \
 177                 goto end;                                                               \
 178         do {                                                                            \
 179                 void (*__tp_cb)(void) = __tp_probe->func;                               \
 180                 void *__tp_data = __tp_probe->data;                                     \
 181                                                                                         \
 182                 URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb)    \
 183                                 (_TP_ARGS_DATA_VAR(__VA_ARGS__));                       \
 184         } while ((++__tp_probe)->func);                                                 \
 185 end:                                                                                    \
 186         tp_rcu_read_unlock();                                                           \
 187 }                                                                                       \
 188 static inline lttng_ust_notrace                                                         \
 189 void __tracepoint_register_##_provider##___##_name(char *name,                          \
 190                 void (*func)(void), void *data);                                        \
 191 static inline                                                                           \
 192 void __tracepoint_register_##_provider##___##_name(char *name,                          \
 193                 void (*func)(void), void *data)                                         \
 194 {                                                                                       \
 195         __tracepoint_probe_register(name, func, data,                                   \
 196                 __tracepoint_##_provider##___##_name.signature);                        \
 197 }                                                                                       \
 198 static inline lttng_ust_notrace                                                         \
 199 void __tracepoint_unregister_##_provider##___##_name(char *name,                        \
 200                 void (*func)(void), void *data);                                        \
 201 static inline                                                                           \
 202 void __tracepoint_unregister_##_provider##___##_name(char *name,                        \
 203                 void (*func)(void), void *data)                                         \
 204 {                                                                                       \
 205         __tracepoint_probe_unregister(name, func, data);                                \
 206 }
 207
 208 extern int __tracepoint_probe_register(const char *name, void (*func)(void),
 209                 void *data, const char *signature);
 210 extern int __tracepoint_probe_unregister(const char *name, void (*func)(void),
 211                 void *data);
 212
 213 /*
 214  * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
 215  * shared across objects in a module/main executable.
 216  *
 217  * IMPORTANT: this structure is part of the ABI between instrumented
 218  * applications and UST. Fields need to be only added at the end, never
 219  * reordered, never removed.
 220  *
 221  * The field @struct_size should be used to determine the size of the
 222  * structure. It should be queried before using additional fields added
 223  * at the end of the structure.
 224  */
 225 struct lttng_ust_tracepoint_dlopen {
 226         uint32_t struct_size;
 227
 228         void *liblttngust_handle;
 229
 230         int (*tracepoint_register_lib)(struct lttng_ust_tracepoint * const *tracepoints_start,
 231                 int tracepoints_count);
 232         int (*tracepoint_unregister_lib)(struct lttng_ust_tracepoint * const *tracepoints_start);
 233         void (*rcu_read_lock_sym)(void);
 234         void (*rcu_read_unlock_sym)(void);
 235         void *(*rcu_dereference_sym)(void *p);
 236
 237         /* End of base ABI. Fields below should be used after checking struct_size. */
 238 };
 239
 240 extern struct lttng_ust_tracepoint_dlopen tracepoint_dlopen;
 241 extern struct lttng_ust_tracepoint_dlopen *tracepoint_dlopen_ptr;
 242
 243 /*
 244  * These weak symbols, the constructor, and destructor take care of
 245  * registering only _one_ instance of the tracepoints per shared-ojbect
 246  * (or for the whole main program).
 247  */
 248 int __tracepoint_registered
 249         __attribute__((weak, visibility("hidden")));
 250 int __tracepoint_ptrs_registered
 251         __attribute__((weak, visibility("hidden")));
 252 struct lttng_ust_tracepoint_dlopen tracepoint_dlopen
 253                 __attribute__((weak, visibility("hidden"))) = {
 254         .struct_size = sizeof(struct lttng_ust_tracepoint_dlopen),
 255 };
 256 /*
 257  * Deal with gcc O1 optimisation issues with weak hidden symbols. gcc
 258  * 4.8 and prior does not have the same behavior for symbol scoping on
 259  * 32-bit powerpc depending on the object size: symbols for objects of 8
 260  * bytes or less have the same address throughout a module, whereas they
 261  * have different addresses between compile units for objects larger
 262  * than 8 bytes. Add this pointer indirection to ensure that the symbol
 263  * scoping match that of the other weak hidden symbols found in this
 264  * header.
 265  */
 266 struct lttng_ust_tracepoint_dlopen *tracepoint_dlopen_ptr
 267         __attribute__((weak, visibility("hidden")));
 268
 269 /*
 270  * Tracepoint dynamic linkage handling (callbacks). Hidden visibility: shared
 271  * across objects in a module/main executable. The callbacks are used to
 272  * control and check if the destructors should be executed.
 273  *
 274  * IMPORTANT: this structure is part of the ABI between instrumented
 275  * applications and UST. Fields need to be only added at the end, never
 276  * reordered, never removed.
 277  *
 278  * The field @struct_size should be used to determine the size of the
 279  * structure. It should be queried before using additional fields added
 280  * at the end of the structure.
 281  */
 282 struct lttng_ust_tracepoint_destructors_syms {
 283         uint32_t struct_size;
 284
 285         void (*tracepoint_disable_destructors)(void);
 286         int (*tracepoint_get_destructors_state)(void);
 287
 288         /* End of base ABI. Fields below should be used after checking struct_size. */
 289 };
 290
 291 extern struct lttng_ust_tracepoint_destructors_syms tracepoint_destructors_syms;
 292 extern struct lttng_ust_tracepoint_destructors_syms *tracepoint_destructors_syms_ptr;
 293
 294 struct lttng_ust_tracepoint_destructors_syms tracepoint_destructors_syms
 295         __attribute__((weak, visibility("hidden"))) = {
 296         .struct_size = sizeof(struct lttng_ust_tracepoint_destructors_syms),
 297 };
 298 struct lttng_ust_tracepoint_destructors_syms *tracepoint_destructors_syms_ptr
 299         __attribute__((weak, visibility("hidden")));
 300
 301 static inline void tracepoint_disable_destructors(void)
 302 {
 303         if (!tracepoint_dlopen_ptr)
 304                 tracepoint_dlopen_ptr = &tracepoint_dlopen;
 305         if (!tracepoint_destructors_syms_ptr)
 306                 tracepoint_destructors_syms_ptr = &tracepoint_destructors_syms;
 307         if (tracepoint_dlopen_ptr->liblttngust_handle
 308                         && tracepoint_destructors_syms_ptr->tracepoint_disable_destructors)
 309                 tracepoint_destructors_syms_ptr->tracepoint_disable_destructors();
 310 }
 311
 312 #ifndef _LGPL_SOURCE
 313 static inline void lttng_ust_notrace
 314 __tracepoint__init_urcu_sym(void);
 315 static inline void
 316 __tracepoint__init_urcu_sym(void)
 317 {
 318         if (!tracepoint_dlopen_ptr)
 319                 tracepoint_dlopen_ptr = &tracepoint_dlopen;
 320         /*
 321          * Symbols below are needed by tracepoint call sites and probe
 322          * providers.
 323          */
 324         if (!tracepoint_dlopen_ptr->rcu_read_lock_sym)
 325                 tracepoint_dlopen_ptr->rcu_read_lock_sym =
 326                         URCU_FORCE_CAST(void (*)(void),
 327                                 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
 328                                         "tp_rcu_read_lock"));
 329         if (!tracepoint_dlopen_ptr->rcu_read_unlock_sym)
 330                 tracepoint_dlopen_ptr->rcu_read_unlock_sym =
 331                         URCU_FORCE_CAST(void (*)(void),
 332                                 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
 333                                         "tp_rcu_read_unlock"));
 334         if (!tracepoint_dlopen_ptr->rcu_dereference_sym)
 335                 tracepoint_dlopen_ptr->rcu_dereference_sym =
 336                         URCU_FORCE_CAST(void *(*)(void *p),
 337                                 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
 338                                         "tp_rcu_dereference_sym"));
 339 }
 340 #else
 341 static inline void lttng_ust_notrace
 342 __tracepoint__init_urcu_sym(void);
 343 static inline void
 344 __tracepoint__init_urcu_sym(void)
 345 {
 346 }
 347 #endif
 348
 349 static void
 350 __tracepoints__init(void)
 351         lttng_ust_notrace __attribute__((constructor));
 352 static void
 353 __tracepoints__init(void)
 354 {
 355         if (__tracepoint_registered++) {
 356                 if (!tracepoint_dlopen_ptr->liblttngust_handle)
 357                         return;
 358                 __tracepoint__init_urcu_sym();
 359                 return;
 360         }
 361
 362         if (!tracepoint_dlopen_ptr)
 363                 tracepoint_dlopen_ptr = &tracepoint_dlopen;
 364         if (!tracepoint_dlopen_ptr->liblttngust_handle)
 365                 tracepoint_dlopen_ptr->liblttngust_handle =
 366                         dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
 367         if (!tracepoint_dlopen_ptr->liblttngust_handle)
 368                 return;
 369         __tracepoint__init_urcu_sym();
 370 }
 371
 372 static void lttng_ust_notrace __attribute__((destructor))
 373 __tracepoints__destroy(void);
 374 static void
 375 __tracepoints__destroy(void)
 376 {
 377         int ret;
 378
 379         if (--__tracepoint_registered)
 380                 return;
 381         if (!tracepoint_dlopen_ptr)
 382                 tracepoint_dlopen_ptr = &tracepoint_dlopen;
 383         if (!tracepoint_destructors_syms_ptr)
 384                 tracepoint_destructors_syms_ptr = &tracepoint_destructors_syms;
 385         if (!tracepoint_dlopen_ptr->liblttngust_handle)
 386                 return;
 387         if (__tracepoint_ptrs_registered)
 388                 return;
 389         /*
 390          * Lookup if destructors must be executed using the new method.
 391          */
 392         if (tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
 393                 && !tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()) {
 394                 /*
 395                  * The tracepoint_get_destructors_state symbol was found with
 396                  * dlsym but its returned value is 0 meaning that destructors
 397                  * must not be executed.
 398                  */
 399                 return;
 400         }
 401         ret = dlclose(tracepoint_dlopen_ptr->liblttngust_handle);
 402         if (ret) {
 403                 fprintf(stderr, "Error (%d) in dlclose\n", ret);
 404                 abort();
 405         }
 406         memset(tracepoint_dlopen_ptr, 0, sizeof(*tracepoint_dlopen_ptr));
 407 }
 408
 409 #ifdef TRACEPOINT_DEFINE
 410
 411 /*
 412  * These weak symbols, the constructor, and destructor take care of
 413  * registering only _one_ instance of the tracepoints per shared-ojbect
 414  * (or for the whole main program).
 415  */
 416 extern struct lttng_ust_tracepoint * const __start___tracepoints_ptrs[]
 417         __attribute__((weak, visibility("hidden")));
 418 extern struct lttng_ust_tracepoint * const __stop___tracepoints_ptrs[]
 419         __attribute__((weak, visibility("hidden")));
 420
 421 /*
 422  * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
 423  * unresolved symbol that requires the provider to be linked in. When
 424  * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
 425  * unresolved symbol that depends on having the provider linked in,
 426  * otherwise the linker complains. This deals with use of static
 427  * libraries, ensuring that the linker does not remove the provider
 428  * object from the executable.
 429  */
 430 #ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
 431 #define _TRACEPOINT_UNDEFINED_REF(provider)     NULL
 432 #else   /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 433 #define _TRACEPOINT_UNDEFINED_REF(provider)     &__tracepoint_provider_##provider
 434 #endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 435
 436 /*
 437  * Note: to allow PIC code, we need to allow the linker to update the pointers
 438  * in the __tracepoints_ptrs section.
 439  * Therefore, this section is _not_ const (read-only).
 440  */
 441 #define _TP_EXTRACT_STRING(...) #__VA_ARGS__
 442
 443 #define _DEFINE_TRACEPOINT(_provider, _name, _args)                             \
 444         extern int __tracepoint_provider_##_provider;                           \
 445         static const char __tp_strtab_##_provider##___##_name[]                 \
 446                 __attribute__((section("__tracepoints_strings"))) =             \
 447                         #_provider ":" #_name;                                  \
 448         struct lttng_ust_tracepoint __tracepoint_##_provider##___##_name        \
 449                 __attribute__((section("__tracepoints"))) = {                   \
 450                         sizeof(struct lttng_ust_tracepoint),                    \
 451                         __tp_strtab_##_provider##___##_name,                    \
 452                         0,                                                      \
 453                         NULL,                                                   \
 454                         _TRACEPOINT_UNDEFINED_REF(_provider),                   \
 455                         _TP_EXTRACT_STRING(_args),                              \
 456                 };                                                              \
 457         static struct lttng_ust_tracepoint *                                    \
 458                 __tracepoint_ptr_##_provider##___##_name                        \
 459                 __attribute__((section("__tracepoints_ptrs"), used))            \
 460                 __lttng_ust_variable_attribute_no_sanitize_address =            \
 461                         &__tracepoint_##_provider##___##_name;
 462
 463 static void
 464 __tracepoints__ptrs_init(void)
 465         lttng_ust_notrace __attribute__((constructor));
 466 static void
 467 __tracepoints__ptrs_init(void)
 468 {
 469         if (__tracepoint_ptrs_registered++)
 470                 return;
 471         if (!tracepoint_dlopen_ptr)
 472                 tracepoint_dlopen_ptr = &tracepoint_dlopen;
 473         if (!tracepoint_dlopen_ptr->liblttngust_handle)
 474                 tracepoint_dlopen_ptr->liblttngust_handle =
 475                         dlopen(LTTNG_UST_TRACEPOINT_LIB_SONAME, RTLD_NOW | RTLD_GLOBAL);
 476         if (!tracepoint_dlopen_ptr->liblttngust_handle)
 477                 return;
 478         if (!tracepoint_destructors_syms_ptr)
 479                 tracepoint_destructors_syms_ptr = &tracepoint_destructors_syms;
 480         tracepoint_dlopen_ptr->tracepoint_register_lib =
 481                 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *, int),
 482                                 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
 483                                         "tracepoint_register_lib"));
 484         tracepoint_dlopen_ptr->tracepoint_unregister_lib =
 485                 URCU_FORCE_CAST(int (*)(struct lttng_ust_tracepoint * const *),
 486                                 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
 487                                         "tracepoint_unregister_lib"));
 488         tracepoint_destructors_syms_ptr->tracepoint_disable_destructors =
 489                 URCU_FORCE_CAST(void (*)(void),
 490                                 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
 491                                         "tp_disable_destructors"));
 492         tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state =
 493                 URCU_FORCE_CAST(int (*)(void),
 494                                 dlsym(tracepoint_dlopen_ptr->liblttngust_handle,
 495                                         "tp_get_destructors_state"));
 496         __tracepoint__init_urcu_sym();
 497         if (tracepoint_dlopen_ptr->tracepoint_register_lib) {
 498                 tracepoint_dlopen_ptr->tracepoint_register_lib(__start___tracepoints_ptrs,
 499                                 __stop___tracepoints_ptrs -
 500                                 __start___tracepoints_ptrs);
 501         }
 502 }
 503
 504 static void lttng_ust_notrace __attribute__((destructor))
 505 __tracepoints__ptrs_destroy(void);
 506 static void
 507 __tracepoints__ptrs_destroy(void)
 508 {
 509         int ret;
 510
 511         if (--__tracepoint_ptrs_registered)
 512                 return;
 513         if (!tracepoint_dlopen_ptr)
 514                 tracepoint_dlopen_ptr = &tracepoint_dlopen;
 515         if (!tracepoint_destructors_syms_ptr)
 516                 tracepoint_destructors_syms_ptr = &tracepoint_destructors_syms;
 517         if (tracepoint_dlopen_ptr->tracepoint_unregister_lib)
 518                 tracepoint_dlopen_ptr->tracepoint_unregister_lib(__start___tracepoints_ptrs);
 519         if (tracepoint_dlopen_ptr->liblttngust_handle
 520                         && tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state
 521                         && tracepoint_destructors_syms_ptr->tracepoint_get_destructors_state()
 522                         && !__tracepoint_ptrs_registered) {
 523                 ret = dlclose(tracepoint_dlopen_ptr->liblttngust_handle);
 524                 if (ret) {
 525                         fprintf(stderr, "Error (%d) in dlclose\n", ret);
 526                         abort();
 527                 }
 528                 memset(tracepoint_dlopen_ptr, 0, sizeof(*tracepoint_dlopen_ptr));
 529         }
 530 }
 531
 532 #else /* TRACEPOINT_DEFINE */
 533
 534 #define _DEFINE_TRACEPOINT(_provider, _name, _args)
 535
 536 #endif /* #else TRACEPOINT_DEFINE */
 537
 538 #ifdef __cplusplus
 539 }
 540 #endif
 541
 542 #endif /* _LTTNG_TRACEPOINT_H */
 543
 544 /* The following declarations must be outside re-inclusion protection. */
 545
 546 #ifndef TRACEPOINT_ENUM
 547
 548 /*
 549  * Tracepoint Enumerations
 550  *
 551  * The enumeration is a mapping between an integer, or range of integers, and
 552  * a string. It can be used to have a more compact trace in cases where the
 553  * possible values for a field are limited:
 554  *
 555  * An example:
 556  *
 557  * TRACEPOINT_ENUM(someproject_component, enumname,
 558  *      TP_ENUM_VALUES(
 559  *              ctf_enum_value("even", 0)
 560  *              ctf_enum_value("uneven", 1)
 561  *              ctf_enum_range("twoto4", 2, 4)
 562  *              ctf_enum_value("five", 5)
 563  *      )
 564  * )
 565  *
 566  * Where "someproject_component" is the name of the component this enumeration
 567  * belongs to and "enumname" identifies this enumeration. Inside the
 568  * TP_ENUM_VALUES macro is the actual mapping. Each string value can map
 569  * to either a single value with ctf_enum_value or a range of values
 570  * with ctf_enum_range.
 571  *
 572  * Enumeration ranges may overlap, but the behavior is implementation-defined,
 573  * each trace reader will handle overlapping as it wishes.
 574  *
 575  * That enumeration can then be used in a field inside the TP_FIELD macro using
 576  * the following line:
 577  *
 578  * ctf_enum(someproject_component, enumname, enumtype, enumfield, enumval)
 579  *
 580  * Where "someproject_component" and "enumname" match those in the
 581  * TRACEPOINT_ENUM, "enumtype" is a signed or unsigned integer type
 582  * backing the enumeration, "enumfield" is the name of the field and
 583  * "enumval" is the value.
 584  */
 585
 586 #define TRACEPOINT_ENUM(provider, name, values)
 587
 588 #endif /* #ifndef TRACEPOINT_ENUM */
 589
 590 #ifndef TRACEPOINT_EVENT
 591
 592 /*
 593  * How to use the TRACEPOINT_EVENT macro:
 594  *
 595  * An example:
 596  *
 597  * TRACEPOINT_EVENT(someproject_component, event_name,
 598  *
 599  *     * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
 600  *
 601  *     TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
 602  *             long *, arg4, size_t, arg4_len),
 603  *
 604  *      * TP_FIELDS describes the event payload layout in the trace *
 605  *
 606  *     TP_FIELDS(
 607  *         * Integer, printed in base 10 *
 608  *         ctf_integer(int, field_a, arg0)
 609  *
 610  *         * Integer, printed with 0x base 16 *
 611  *         ctf_integer_hex(unsigned long, field_d, arg1)
 612  *
 613  *         * Enumeration *
 614  *         ctf_enum(someproject_component, enum_name, int, field_e, arg0)
 615  *
 616  *         * Array Sequence, printed as UTF8-encoded array of bytes *
 617  *         ctf_array_text(char, field_b, string, FIXED_LEN)
 618  *         ctf_sequence_text(char, field_c, string, size_t, strlen)
 619  *
 620  *         * String, printed as UTF8-encoded string *
 621  *         ctf_string(field_e, string)
 622  *
 623  *         * Array sequence of signed integer values *
 624  *         ctf_array(long, field_f, arg4, FIXED_LEN4)
 625  *         ctf_sequence(long, field_g, arg4, size_t, arg4_len)
 626  *     )
 627  * )
 628  *
 629  * More detailed explanation:
 630  *
 631  * The name of the tracepoint is expressed as a tuple with the provider
 632  * and name arguments.
 633  *
 634  * The provider and name should be a proper C99 identifier.
 635  * The "provider" and "name" MUST follow these rules to ensure no
 636  * namespace clash occurs:
 637  *
 638  * For projects (applications and libraries) for which an entity
 639  * specific to the project controls the source code and thus its
 640  * tracepoints (typically with a scope larger than a single company):
 641  *
 642  * either:
 643  *   project_component, event
 644  * or:
 645  *   project, event
 646  *
 647  * Where "project" is the name of the project,
 648  *       "component" is the name of the project component (which may
 649  *       include several levels of sub-components, e.g.
 650  *       ...component_subcomponent_...) where the tracepoint is located
 651  *       (optional),
 652  *       "event" is the name of the tracepoint event.
 653  *
 654  * For projects issued from a single company wishing to advertise that
 655  * the company controls the source code and thus the tracepoints, the
 656  * "com_" prefix should be used:
 657  *
 658  * either:
 659  *   com_company_project_component, event
 660  * or:
 661  *   com_company_project, event
 662  *
 663  * Where "company" is the name of the company,
 664  *       "project" is the name of the project,
 665  *       "component" is the name of the project component (which may
 666  *       include several levels of sub-components, e.g.
 667  *       ...component_subcomponent_...) where the tracepoint is located
 668  *       (optional),
 669  *       "event" is the name of the tracepoint event.
 670  *
 671  * the provider:event identifier is limited to 127 characters.
 672  */
 673
 674 #define TRACEPOINT_EVENT(provider, name, args, fields)                  \
 675         _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
 676         _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
 677
 678 #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
 679
 680 #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args)      \
 681         _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
 682         _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
 683
 684 #endif /* #ifndef TRACEPOINT_EVENT */
 685
 686 #ifndef TRACEPOINT_LOGLEVEL
 687
 688 /*
 689  * Tracepoint Loglevels
 690  *
 691  * Typical use of these loglevels:
 692  *
 693  * The loglevels go from 0 to 14. Higher numbers imply the most
 694  * verbosity (higher event throughput expected.
 695  *
 696  * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
 697  * semantic. Loglevels 7 through 13 offer more fine-grained selection of
 698  * debug information.
 699  *
 700  * TRACE_EMERG           0
 701  * system is unusable
 702  *
 703  * TRACE_ALERT           1
 704  * action must be taken immediately
 705  *
 706  * TRACE_CRIT            2
 707  * critical conditions
 708  *
 709  * TRACE_ERR             3
 710  * error conditions
 711  *
 712  * TRACE_WARNING         4
 713  * warning conditions
 714  *
 715  * TRACE_NOTICE          5
 716  * normal, but significant, condition
 717  *
 718  * TRACE_INFO            6
 719  * informational message
 720  *
 721  * TRACE_DEBUG_SYSTEM    7
 722  * debug information with system-level scope (set of programs)
 723  *
 724  * TRACE_DEBUG_PROGRAM   8
 725  * debug information with program-level scope (set of processes)
 726  *
 727  * TRACE_DEBUG_PROCESS   9
 728  * debug information with process-level scope (set of modules)
 729  *
 730  * TRACE_DEBUG_MODULE    10
 731  * debug information with module (executable/library) scope (set of units)
 732  *
 733  * TRACE_DEBUG_UNIT      11
 734  * debug information with compilation unit scope (set of functions)
 735  *
 736  * TRACE_DEBUG_FUNCTION  12
 737  * debug information with function-level scope
 738  *
 739  * TRACE_DEBUG_LINE      13
 740  * debug information with line-level scope (TRACEPOINT_EVENT default)
 741  *
 742  * TRACE_DEBUG           14
 743  * debug-level message
 744  *
 745  * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
 746  * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
 747  * tracepoint name. The first field is the provider name, the second
 748  * field is the name of the tracepoint, the third field is the loglevel
 749  * name.
 750  *
 751  *      TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
 752  *              < loglevel_name >)
 753  *
 754  * The TRACEPOINT_PROVIDER must be already declared before declaring a
 755  * TRACEPOINT_LOGLEVEL.
 756  */
 757
 758 enum {
 759         TRACE_EMERG             = 0,
 760         TRACE_ALERT             = 1,
 761         TRACE_CRIT              = 2,
 762         TRACE_ERR               = 3,
 763         TRACE_WARNING           = 4,
 764         TRACE_NOTICE            = 5,
 765         TRACE_INFO              = 6,
 766         TRACE_DEBUG_SYSTEM      = 7,
 767         TRACE_DEBUG_PROGRAM     = 8,
 768         TRACE_DEBUG_PROCESS     = 9,
 769         TRACE_DEBUG_MODULE      = 10,
 770         TRACE_DEBUG_UNIT        = 11,
 771         TRACE_DEBUG_FUNCTION    = 12,
 772         TRACE_DEBUG_LINE        = 13,
 773         TRACE_DEBUG             = 14,
 774 };
 775
 776 #define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
 777
 778 #endif /* #ifndef TRACEPOINT_LOGLEVEL */
 779
 780 #ifndef TRACEPOINT_MODEL_EMF_URI
 781
 782 #define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
 783
 784 #endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */