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