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