include/lttng/tracepoint.h

   1 #ifndef _LTTNG_TRACEPOINT_H
   2 #define _LTTNG_TRACEPOINT_H
   3
   4 /*
   5  * Copyright 2011-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <lttng/tracepoint-types.h>
  29 #include <lttng/tracepoint-rcu.h>
  30 #include <urcu/compiler.h>
  31 #include <dlfcn.h>      /* for dlopen */
  32 #include <string.h>     /* for memset */
  33 #include <lttng/ust-config.h>   /* for sdt */
  34 #include <lttng/ust-compiler.h>
  35
  36 #ifdef LTTNG_UST_HAVE_SDT_INTEGRATION
  37 #define SDT_USE_VARIADIC
  38 #include <sys/sdt.h>
  39 #else
  40 #define STAP_PROBEV(...)
  41 #endif
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #define tracepoint(provider, name, ...)                                     \
  48         do {                                                                \
  49                 STAP_PROBEV(provider, name, ## __VA_ARGS__);                \
  50                 if (caa_unlikely(__tracepoint_##provider##___##name.state)) \
  51                         __tracepoint_cb_##provider##___##name(__VA_ARGS__); \
  52         } while (0)
  53
  54 #define TP_ARGS(...)       __VA_ARGS__
  55
  56 /*
  57  * TP_ARGS takes tuples of type, argument separated by a comma.
  58  * It can take up to 10 tuples (which means that less than 10 tuples is
  59  * fine too).
  60  * Each tuple is also separated by a comma.
  61  */
  62 #define __TP_COMBINE_TOKENS(_tokena, _tokenb)                           \
  63                 _tokena##_tokenb
  64 #define _TP_COMBINE_TOKENS(_tokena, _tokenb)                            \
  65                 __TP_COMBINE_TOKENS(_tokena, _tokenb)
  66 #define __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                 \
  67                 _tokena##_tokenb##_tokenc
  68 #define _TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)                  \
  69                 __TP_COMBINE_TOKENS3(_tokena, _tokenb, _tokenc)
  70 #define __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)        \
  71                 _tokena##_tokenb##_tokenc##_tokend
  72 #define _TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)         \
  73                 __TP_COMBINE_TOKENS4(_tokena, _tokenb, _tokenc, _tokend)
  74
  75 /*
  76  * _TP_EXVAR* extract the var names.
  77  * _TP_EXVAR1 and _TP_EXDATA_VAR1 are needed for -std=c99.
  78  */
  79 #define _TP_EXVAR0()
  80 #define _TP_EXVAR1(a)
  81 #define _TP_EXVAR2(a,b)                                         b
  82 #define _TP_EXVAR4(a,b,c,d)                                     b,d
  83 #define _TP_EXVAR6(a,b,c,d,e,f)                                 b,d,f
  84 #define _TP_EXVAR8(a,b,c,d,e,f,g,h)                             b,d,f,h
  85 #define _TP_EXVAR10(a,b,c,d,e,f,g,h,i,j)                        b,d,f,h,j
  86 #define _TP_EXVAR12(a,b,c,d,e,f,g,h,i,j,k,l)                    b,d,f,h,j,l
  87 #define _TP_EXVAR14(a,b,c,d,e,f,g,h,i,j,k,l,m,n)                b,d,f,h,j,l,n
  88 #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
  89 #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
  90 #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
  91
  92 #define _TP_EXDATA_VAR0()                                               __tp_data
  93 #define _TP_EXDATA_VAR1(a)                                              __tp_data
  94 #define _TP_EXDATA_VAR2(a,b)                                            __tp_data,b
  95 #define _TP_EXDATA_VAR4(a,b,c,d)                                        __tp_data,b,d
  96 #define _TP_EXDATA_VAR6(a,b,c,d,e,f)                                    __tp_data,b,d,f
  97 #define _TP_EXDATA_VAR8(a,b,c,d,e,f,g,h)                                __tp_data,b,d,f,h
  98 #define _TP_EXDATA_VAR10(a,b,c,d,e,f,g,h,i,j)                           __tp_data,b,d,f,h,j
  99 #define _TP_EXDATA_VAR12(a,b,c,d,e,f,g,h,i,j,k,l)                       __tp_data,b,d,f,h,j,l
 100 #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
 101 #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
 102 #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
 103 #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
 104
 105 /*
 106  * _TP_EXPROTO* extract tuples of type, var.
 107  * _TP_EXPROTO1 and _TP_EXDATA_PROTO1 are needed for -std=c99.
 108  */
 109 #define _TP_EXPROTO0()                                          void
 110 #define _TP_EXPROTO1(a)                                         void
 111 #define _TP_EXPROTO2(a,b)                                       a b
 112 #define _TP_EXPROTO4(a,b,c,d)                                   a b,c d
 113 #define _TP_EXPROTO6(a,b,c,d,e,f)                               a b,c d,e f
 114 #define _TP_EXPROTO8(a,b,c,d,e,f,g,h)                           a b,c d,e f,g h
 115 #define _TP_EXPROTO10(a,b,c,d,e,f,g,h,i,j)                      a b,c d,e f,g h,i j
 116 #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
 117 #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
 118 #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
 119 #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
 120 #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
 121
 122 #define _TP_EXDATA_PROTO0()                                             void *__tp_data
 123 #define _TP_EXDATA_PROTO1(a)                                            void *__tp_data
 124 #define _TP_EXDATA_PROTO2(a,b)                                          void *__tp_data,a b
 125 #define _TP_EXDATA_PROTO4(a,b,c,d)                                      void *__tp_data,a b,c d
 126 #define _TP_EXDATA_PROTO6(a,b,c,d,e,f)                                  void *__tp_data,a b,c d,e f
 127 #define _TP_EXDATA_PROTO8(a,b,c,d,e,f,g,h)                              void *__tp_data,a b,c d,e f,g h
 128 #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
 129 #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
 130 #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
 131 #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
 132 #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
 133 #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
 134
 135 /* Preprocessor trick to count arguments. Inspired from sdt.h. */
 136 #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)
 137 #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
 138 #define _TP_PROTO_N(N, ...)             _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXPROTO, N)(__VA_ARGS__))
 139 #define _TP_VAR_N(N, ...)               _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXVAR, N)(__VA_ARGS__))
 140 #define _TP_DATA_PROTO_N(N, ...)        _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_PROTO, N)(__VA_ARGS__))
 141 #define _TP_DATA_VAR_N(N, ...)          _TP_PARAMS(_TP_COMBINE_TOKENS(_TP_EXDATA_VAR, N)(__VA_ARGS__))
 142 #define _TP_ARGS_PROTO(...)             _TP_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 143 #define _TP_ARGS_VAR(...)               _TP_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 144 #define _TP_ARGS_DATA_PROTO(...)        _TP_DATA_PROTO_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 145 #define _TP_ARGS_DATA_VAR(...)          _TP_DATA_VAR_N(_TP_NARGS(0, ##__VA_ARGS__), ##__VA_ARGS__)
 146 #define _TP_PARAMS(...)                 __VA_ARGS__
 147
 148 /*
 149  * The tracepoint cb is marked always inline so we can distinguish
 150  * between caller's ip addresses within the probe using the return
 151  * address.
 152  */
 153 #define _DECLARE_TRACEPOINT(_provider, _name, ...)                                      \
 154 extern struct tracepoint __tracepoint_##_provider##___##_name;                          \
 155 static inline __attribute__((always_inline)) lttng_ust_notrace                          \
 156 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__));              \
 157 static                                                                                  \
 158 void __tracepoint_cb_##_provider##___##_name(_TP_ARGS_PROTO(__VA_ARGS__))               \
 159 {                                                                                       \
 160         struct tracepoint_probe *__tp_probe;                                            \
 161                                                                                         \
 162         if (caa_unlikely(!TP_RCU_LINK_TEST()))                                          \
 163                 return;                                                                 \
 164         tp_rcu_read_lock_bp();                                                          \
 165         __tp_probe = tp_rcu_dereference_bp(__tracepoint_##_provider##___##_name.probes); \
 166         if (caa_unlikely(!__tp_probe))                                                  \
 167                 goto end;                                                               \
 168         do {                                                                            \
 169                 void (*__tp_cb)(void) = __tp_probe->func;                                       \
 170                 void *__tp_data = __tp_probe->data;                                     \
 171                                                                                         \
 172                 URCU_FORCE_CAST(void (*)(_TP_ARGS_DATA_PROTO(__VA_ARGS__)), __tp_cb)    \
 173                                 (_TP_ARGS_DATA_VAR(__VA_ARGS__));                       \
 174         } while ((++__tp_probe)->func);                                                 \
 175 end:                                                                                    \
 176         tp_rcu_read_unlock_bp();                                                        \
 177 }                                                                                       \
 178 static inline lttng_ust_notrace                                                         \
 179 void __tracepoint_register_##_provider##___##_name(char *name,                          \
 180                 void (*func)(void), void *data);                                        \
 181 static inline                                                                           \
 182 void __tracepoint_register_##_provider##___##_name(char *name,                          \
 183                 void (*func)(void), void *data)                                         \
 184 {                                                                                       \
 185         __tracepoint_probe_register(name, func, data,                                   \
 186                 __tracepoint_##_provider##___##_name.signature);                        \
 187 }                                                                                       \
 188 static inline lttng_ust_notrace                                                         \
 189 void __tracepoint_unregister_##_provider##___##_name(char *name,                        \
 190                 void (*func)(void), void *data);                                        \
 191 static inline                                                                           \
 192 void __tracepoint_unregister_##_provider##___##_name(char *name,                        \
 193                 void (*func)(void), void *data)                                         \
 194 {                                                                                       \
 195         __tracepoint_probe_unregister(name, func, data);                                \
 196 }
 197
 198 extern int __tracepoint_probe_register(const char *name, void (*func)(void),
 199                 void *data, const char *signature);
 200 extern int __tracepoint_probe_unregister(const char *name, void (*func)(void),
 201                 void *data);
 202
 203 /*
 204  * tracepoint dynamic linkage handling (callbacks). Hidden visibility:
 205  * shared across objects in a module/main executable.
 206  */
 207 struct tracepoint_dlopen {
 208         void *liblttngust_handle;
 209
 210         int (*tracepoint_register_lib)(struct tracepoint * const *tracepoints_start,
 211                 int tracepoints_count);
 212         int (*tracepoint_unregister_lib)(struct tracepoint * const *tracepoints_start);
 213 #ifndef _LGPL_SOURCE
 214         void (*rcu_read_lock_sym_bp)(void);
 215         void (*rcu_read_unlock_sym_bp)(void);
 216         void *(*rcu_dereference_sym_bp)(void *p);
 217 #endif
 218 };
 219
 220 extern struct tracepoint_dlopen tracepoint_dlopen;
 221
 222 #if defined(TRACEPOINT_DEFINE) || defined(TRACEPOINT_CREATE_PROBES)
 223
 224 /*
 225  * These weak symbols, the constructor, and destructor take care of
 226  * registering only _one_ instance of the tracepoints per shared-ojbect
 227  * (or for the whole main program).
 228  */
 229 int __tracepoint_registered
 230         __attribute__((weak, visibility("hidden")));
 231 int __tracepoint_ptrs_registered
 232         __attribute__((weak, visibility("hidden")));
 233 struct tracepoint_dlopen tracepoint_dlopen
 234         __attribute__((weak, visibility("hidden")));
 235
 236 #ifndef _LGPL_SOURCE
 237 static inline void lttng_ust_notrace
 238 __tracepoint__init_urcu_sym(void);
 239 static inline void
 240 __tracepoint__init_urcu_sym(void)
 241 {
 242         /*
 243          * Symbols below are needed by tracepoint call sites and probe
 244          * providers.
 245          */
 246         if (!tracepoint_dlopen.rcu_read_lock_sym_bp)
 247                 tracepoint_dlopen.rcu_read_lock_sym_bp =
 248                         URCU_FORCE_CAST(void (*)(void),
 249                                 dlsym(tracepoint_dlopen.liblttngust_handle,
 250                                         "tp_rcu_read_lock_bp"));
 251         if (!tracepoint_dlopen.rcu_read_unlock_sym_bp)
 252                 tracepoint_dlopen.rcu_read_unlock_sym_bp =
 253                         URCU_FORCE_CAST(void (*)(void),
 254                                 dlsym(tracepoint_dlopen.liblttngust_handle,
 255                                         "tp_rcu_read_unlock_bp"));
 256         if (!tracepoint_dlopen.rcu_dereference_sym_bp)
 257                 tracepoint_dlopen.rcu_dereference_sym_bp =
 258                         URCU_FORCE_CAST(void *(*)(void *p),
 259                                 dlsym(tracepoint_dlopen.liblttngust_handle,
 260                                         "tp_rcu_dereference_sym_bp"));
 261 }
 262 #else
 263 static inline void lttng_ust_notrace
 264 __tracepoint__init_urcu_sym(void);
 265 static inline void
 266 __tracepoint__init_urcu_sym(void)
 267 {
 268 }
 269 #endif
 270
 271 static void lttng_ust_notrace __attribute__((constructor))
 272 __tracepoints__init(void);
 273 static void
 274 __tracepoints__init(void)
 275 {
 276         if (__tracepoint_registered++)
 277                 return;
 278
 279         if (!tracepoint_dlopen.liblttngust_handle)
 280                 tracepoint_dlopen.liblttngust_handle =
 281                         dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
 282         if (!tracepoint_dlopen.liblttngust_handle)
 283                 return;
 284         __tracepoint__init_urcu_sym();
 285 }
 286
 287 static void lttng_ust_notrace __attribute__((destructor))
 288 __tracepoints__destroy(void);
 289 static void
 290 __tracepoints__destroy(void)
 291 {
 292         int ret;
 293
 294         if (--__tracepoint_registered)
 295                 return;
 296         if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_ptrs_registered) {
 297                 ret = dlclose(tracepoint_dlopen.liblttngust_handle);
 298                 if (ret) {
 299                         fprintf(stderr, "Error (%d) in dlclose\n", ret);
 300                         abort();
 301                 }
 302                 memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
 303         }
 304 }
 305
 306 #endif
 307
 308 #ifdef TRACEPOINT_DEFINE
 309
 310 /*
 311  * These weak symbols, the constructor, and destructor take care of
 312  * registering only _one_ instance of the tracepoints per shared-ojbect
 313  * (or for the whole main program).
 314  */
 315 extern struct tracepoint * const __start___tracepoints_ptrs[]
 316         __attribute__((weak, visibility("hidden")));
 317 extern struct tracepoint * const __stop___tracepoints_ptrs[]
 318         __attribute__((weak, visibility("hidden")));
 319
 320 /*
 321  * When TRACEPOINT_PROBE_DYNAMIC_LINKAGE is defined, we do not emit a
 322  * unresolved symbol that requires the provider to be linked in. When
 323  * TRACEPOINT_PROBE_DYNAMIC_LINKAGE is not defined, we emit an
 324  * unresolved symbol that depends on having the provider linked in,
 325  * otherwise the linker complains. This deals with use of static
 326  * libraries, ensuring that the linker does not remove the provider
 327  * object from the executable.
 328  */
 329 #ifdef TRACEPOINT_PROBE_DYNAMIC_LINKAGE
 330 #define _TRACEPOINT_UNDEFINED_REF(provider)     NULL
 331 #else   /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 332 #define _TRACEPOINT_UNDEFINED_REF(provider)     &__tracepoint_provider_##provider
 333 #endif /* TRACEPOINT_PROBE_DYNAMIC_LINKAGE */
 334
 335 /*
 336  * Note: to allow PIC code, we need to allow the linker to update the pointers
 337  * in the __tracepoints_ptrs section.
 338  * Therefore, this section is _not_ const (read-only).
 339  */
 340 #define _TP_EXTRACT_STRING(...) #__VA_ARGS__
 341
 342 #define _DEFINE_TRACEPOINT(_provider, _name, _args)                             \
 343         extern int __tracepoint_provider_##_provider;                           \
 344         static const char __tp_strtab_##_provider##___##_name[]                 \
 345                 __attribute__((section("__tracepoints_strings"))) =             \
 346                         #_provider ":" #_name;                                  \
 347         struct tracepoint __tracepoint_##_provider##___##_name                  \
 348                 __attribute__((section("__tracepoints"))) =                     \
 349                 {                                                               \
 350                         __tp_strtab_##_provider##___##_name,                    \
 351                         0,                                                      \
 352                         NULL,                                                   \
 353                         _TRACEPOINT_UNDEFINED_REF(_provider),                   \
 354                         _TP_EXTRACT_STRING(_args),                              \
 355                 };                                                              \
 356         static struct tracepoint * __tracepoint_ptr_##_provider##___##_name     \
 357                 __attribute__((used, section("__tracepoints_ptrs"))) =          \
 358                         &__tracepoint_##_provider##___##_name;
 359
 360 static void lttng_ust_notrace __attribute__((constructor))
 361 __tracepoints__ptrs_init(void);
 362 static void
 363 __tracepoints__ptrs_init(void)
 364 {
 365         if (__tracepoint_ptrs_registered++)
 366                 return;
 367         if (!tracepoint_dlopen.liblttngust_handle)
 368                 tracepoint_dlopen.liblttngust_handle =
 369                         dlopen("liblttng-ust-tracepoint.so.0", RTLD_NOW | RTLD_GLOBAL);
 370         if (!tracepoint_dlopen.liblttngust_handle)
 371                 return;
 372         tracepoint_dlopen.tracepoint_register_lib =
 373                 URCU_FORCE_CAST(int (*)(struct tracepoint * const *, int),
 374                                 dlsym(tracepoint_dlopen.liblttngust_handle,
 375                                         "tracepoint_register_lib"));
 376         tracepoint_dlopen.tracepoint_unregister_lib =
 377                 URCU_FORCE_CAST(int (*)(struct tracepoint * const *),
 378                                 dlsym(tracepoint_dlopen.liblttngust_handle,
 379                                         "tracepoint_unregister_lib"));
 380         __tracepoint__init_urcu_sym();
 381         if (tracepoint_dlopen.tracepoint_register_lib) {
 382                 tracepoint_dlopen.tracepoint_register_lib(__start___tracepoints_ptrs,
 383                                 __stop___tracepoints_ptrs -
 384                                 __start___tracepoints_ptrs);
 385         }
 386 }
 387
 388 static void lttng_ust_notrace __attribute__((destructor))
 389 __tracepoints__ptrs_destroy(void);
 390 static void
 391 __tracepoints__ptrs_destroy(void)
 392 {
 393         int ret;
 394
 395         if (--__tracepoint_ptrs_registered)
 396                 return;
 397         if (tracepoint_dlopen.tracepoint_unregister_lib)
 398                 tracepoint_dlopen.tracepoint_unregister_lib(__start___tracepoints_ptrs);
 399         if (tracepoint_dlopen.liblttngust_handle && !__tracepoint_registered) {
 400                 ret = dlclose(tracepoint_dlopen.liblttngust_handle);
 401                 if (ret) {
 402                         fprintf(stderr, "Error (%d) in dlclose\n", ret);
 403                         abort();
 404                 }
 405                 memset(&tracepoint_dlopen, 0, sizeof(tracepoint_dlopen));
 406         }
 407 }
 408
 409 #else /* TRACEPOINT_DEFINE */
 410
 411 #define _DEFINE_TRACEPOINT(_provider, _name, _args)
 412
 413 #endif /* #else TRACEPOINT_DEFINE */
 414
 415 #ifdef __cplusplus
 416 }
 417 #endif
 418
 419 #endif /* _LTTNG_TRACEPOINT_H */
 420
 421 /* The following declarations must be outside re-inclusion protection. */
 422
 423 #ifndef TRACEPOINT_EVENT
 424
 425 /*
 426  * How to use the TRACEPOINT_EVENT macro:
 427  *
 428  * An example:
 429  *
 430  * TRACEPOINT_EVENT(someproject_component, event_name,
 431  *
 432  *     * TP_ARGS takes from 0 to 10 "type, field_name" pairs *
 433  *
 434  *     TP_ARGS(int, arg0, void *, arg1, char *, string, size_t, strlen,
 435  *             long *, arg4, size_t, arg4_len),
 436  *
 437  *      * TP_FIELDS describes the event payload layout in the trace *
 438  *
 439  *     TP_FIELDS(
 440  *         * Integer, printed in base 10 *
 441  *         ctf_integer(int, field_a, arg0)
 442  *
 443  *         * Integer, printed with 0x base 16 *
 444  *         ctf_integer_hex(unsigned long, field_d, arg1)
 445  *
 446  *         * Array Sequence, printed as UTF8-encoded array of bytes *
 447  *         ctf_array_text(char, field_b, string, FIXED_LEN)
 448  *         ctf_sequence_text(char, field_c, string, size_t, strlen)
 449  *
 450  *         * String, printed as UTF8-encoded string *
 451  *         ctf_string(field_e, string)
 452  *
 453  *         * Array sequence of signed integer values *
 454  *         ctf_array(long, field_f, arg4, FIXED_LEN4)
 455  *         ctf_sequence(long, field_g, arg4, size_t, arg4_len)
 456  *     )
 457  * )
 458  *
 459  * More detailed explanation:
 460  *
 461  * The name of the tracepoint is expressed as a tuple with the provider
 462  * and name arguments.
 463  *
 464  * The provider and name should be a proper C99 identifier.
 465  * The "provider" and "name" MUST follow these rules to ensure no
 466  * namespace clash occurs:
 467  *
 468  * For projects (applications and libraries) for which an entity
 469  * specific to the project controls the source code and thus its
 470  * tracepoints (typically with a scope larger than a single company):
 471  *
 472  * either:
 473  *   project_component, event
 474  * or:
 475  *   project, event
 476  *
 477  * Where "project" is the name of the project,
 478  *       "component" is the name of the project component (which may
 479  *       include several levels of sub-components, e.g.
 480  *       ...component_subcomponent_...) where the tracepoint is located
 481  *       (optional),
 482  *       "event" is the name of the tracepoint event.
 483  *
 484  * For projects issued from a single company wishing to advertise that
 485  * the company controls the source code and thus the tracepoints, the
 486  * "com_" prefix should be used:
 487  *
 488  * either:
 489  *   com_company_project_component, event
 490  * or:
 491  *   com_company_project, event
 492  *
 493  * Where "company" is the name of the company,
 494  *       "project" is the name of the project,
 495  *       "component" is the name of the project component (which may
 496  *       include several levels of sub-components, e.g.
 497  *       ...component_subcomponent_...) where the tracepoint is located
 498  *       (optional),
 499  *       "event" is the name of the tracepoint event.
 500  *
 501  * the provider:event identifier is limited to 127 characters.
 502  */
 503
 504 #define TRACEPOINT_EVENT(provider, name, args, fields)                  \
 505         _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
 506         _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
 507
 508 #define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
 509
 510 #define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args)      \
 511         _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
 512         _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
 513
 514 #endif /* #ifndef TRACEPOINT_EVENT */
 515
 516 #ifndef TRACEPOINT_LOGLEVEL
 517
 518 /*
 519  * Tracepoint Loglevels
 520  *
 521  * Typical use of these loglevels:
 522  *
 523  * The loglevels go from 0 to 14. Higher numbers imply the most
 524  * verbosity (higher event throughput expected.
 525  *
 526  * Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
 527  * semantic. Loglevels 7 through 13 offer more fine-grained selection of
 528  * debug information.
 529  *
 530  * TRACE_EMERG           0
 531  * system is unusable
 532  *
 533  * TRACE_ALERT           1
 534  * action must be taken immediately
 535  *
 536  * TRACE_CRIT            2
 537  * critical conditions
 538  *
 539  * TRACE_ERR             3
 540  * error conditions
 541  *
 542  * TRACE_WARNING         4
 543  * warning conditions
 544  *
 545  * TRACE_NOTICE          5
 546  * normal, but significant, condition
 547  *
 548  * TRACE_INFO            6
 549  * informational message
 550  *
 551  * TRACE_DEBUG_SYSTEM    7
 552  * debug information with system-level scope (set of programs)
 553  *
 554  * TRACE_DEBUG_PROGRAM   8
 555  * debug information with program-level scope (set of processes)
 556  *
 557  * TRACE_DEBUG_PROCESS   9
 558  * debug information with process-level scope (set of modules)
 559  *
 560  * TRACE_DEBUG_MODULE    10
 561  * debug information with module (executable/library) scope (set of units)
 562  *
 563  * TRACE_DEBUG_UNIT      11
 564  * debug information with compilation unit scope (set of functions)
 565  *
 566  * TRACE_DEBUG_FUNCTION  12
 567  * debug information with function-level scope
 568  *
 569  * TRACE_DEBUG_LINE      13
 570  * debug information with line-level scope (TRACEPOINT_EVENT default)
 571  *
 572  * TRACE_DEBUG           14
 573  * debug-level message (trace_printf default)
 574  *
 575  * Declare tracepoint loglevels for tracepoints. A TRACEPOINT_EVENT
 576  * should be declared prior to the the TRACEPOINT_LOGLEVEL for a given
 577  * tracepoint name. The first field is the provider name, the second
 578  * field is the name of the tracepoint, the third field is the loglevel
 579  * name.
 580  *
 581  *      TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >,
 582  *              < loglevel_name >)
 583  *
 584  * The TRACEPOINT_PROVIDER must be already declared before declaring a
 585  * TRACEPOINT_LOGLEVEL.
 586  */
 587
 588 enum {
 589         TRACE_EMERG             = 0,
 590         TRACE_ALERT             = 1,
 591         TRACE_CRIT              = 2,
 592         TRACE_ERR               = 3,
 593         TRACE_WARNING           = 4,
 594         TRACE_NOTICE            = 5,
 595         TRACE_INFO              = 6,
 596         TRACE_DEBUG_SYSTEM      = 7,
 597         TRACE_DEBUG_PROGRAM     = 8,
 598         TRACE_DEBUG_PROCESS     = 9,
 599         TRACE_DEBUG_MODULE      = 10,
 600         TRACE_DEBUG_UNIT        = 11,
 601         TRACE_DEBUG_FUNCTION    = 12,
 602         TRACE_DEBUG_LINE        = 13,
 603         TRACE_DEBUG             = 14,
 604 };
 605
 606 #define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
 607
 608 #endif /* #ifndef TRACEPOINT_LOGLEVEL */
 609
 610 #ifndef TRACEPOINT_MODEL_EMF_URI
 611
 612 #define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
 613
 614 #endif /* #ifndef TRACEPOINT_MODEL_EMF_URI */